This section defines macros for the GATT Client. More...

Overview

This section defines macros for the GATT Client.

Macros
#define	BT_GATTC_EXCHANGE_MTU (BT_MODULE_GATT \| 0x00010000)
	This is the confirmation event, generated from bt_gattc_exchange_mtu(), with bt_gatt_exchange_mtu_rsp_t as the payload. More...

#define	BT_GATTC_DISCOVER_PRIMARY_SERVICE (BT_MODULE_GATT \| 0x00020000)
	This is the confirmation event, generated from bt_gattc_discover_primary_service(), with bt_gattc_read_by_group_type_rsp_t as the payload. More...

#define	BT_GATTC_DISCOVER_PRIMARY_SERVICE_BY_UUID (BT_MODULE_GATT \| 0x00030000)
	This is the confirmation event, generated from bt_gattc_discover_primary_service_by_uuid(), with bt_gattc_find_by_type_value_rsp_t as the payload. More...

#define	BT_GATTC_FIND_INCLUDED_SERVICES (BT_MODULE_GATT \| 0x00040000)
	This is the confirmation event, generated from bt_gattc_find_included_services(), with bt_gattc_read_by_type_rsp_t as the payload. More...

#define	BT_GATTC_DISCOVER_CHARC (BT_MODULE_GATT \| 0x00050000)
	This is the confirmation event, generated from bt_gattc_discover_charc(), with bt_gattc_read_by_type_rsp_t as the payload. More...

#define	BT_GATTC_DISCOVER_CHARC_DESCRIPTOR (BT_MODULE_GATT \| 0x00060000)
	This is the confirmation event, generated from bt_gattc_discover_charc_descriptor(), with bt_gattc_find_info_rsp_t as the payload. More...

#define	BT_GATTC_READ_CHARC (BT_MODULE_GATT \| 0x00070000)
	This is the confirmation event, generated from bt_gattc_read_charc(), with bt_gattc_read_rsp_t as the payload. More...

#define	BT_GATTC_READ_LONG_CHARC (BT_MODULE_GATT \| 0x00080000)
	This is the confirmation event, generated from bt_gattc_read_long_charc(), with bt_gattc_read_rsp_t as the payload. More...

#define	BT_GATTC_READ_USING_CHARC_UUID (BT_MODULE_GATT \| 0x00090000)
	This is the confirmation event, generated from bt_gattc_read_using_charc_uuid(), with bt_gattc_read_by_type_rsp_t as the payload. More...

#define	BT_GATTC_READ_MULTI_CHARC_VALUES (BT_MODULE_GATT \| 0x000A0000)
	This is the confirmation event, generated from bt_gattc_read_multi_charc_values(), with bt_gattc_read_multiple_rsp_t as the payload. More...

#define	BT_GATTC_WRITE_CHARC (BT_MODULE_GATT \| 0x000D0000)
	This is the confirmation event, generated from bt_gattc_write_charc(), with bt_gattc_write_rsp_t as the payload. More...

#define	BT_GATTC_WRITE_LONG_CHARC (BT_MODULE_GATT \| 0x000E0000)
	This is the confirmation event, generated from bt_gattc_prepare_write_charc() that writes long characteristic value or writes long characteristic descriptors, with bt_gattc_execute_write_rsp_t as the payload. More...

#define	BT_GATTC_RELIABLE_WRITE_CHARC (BT_MODULE_GATT \| 0x000F0000)
	This is the confirmation event, generated from bt_gattc_prepare_write_charc() as the reliable writes, with bt_gattc_execute_write_rsp_t as the payload. More...

#define	BT_GATTC_CHARC_VALUE_NOTIFICATION (BT_MODULE_GATT \| 0x00110000)
	This is the notification event with bt_gatt_handle_value_notification_t as the payload. More...

#define	BT_GATTC_CHARC_VALUE_INDICATION (BT_MODULE_GATT \| 0x00120000)
	This is the indication event with bt_gatt_handle_value_indication_t as the payload. More...

#define	BT_GATTC_CHARC_VALUE_CONFIRMATION (BT_MODULE_GATT \| 0x00130000)
	This is the confirmation event, generated from bt_gatts_send_charc_value_notification_indication(), with (uint32_t* connect_handle) as the payload. More...

#define	BT_GATTC_NEW_EXCHANGE_MTU_REQ(name, mtu)
	This macro creates an exchange MTU request. More...

#define	BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_REQ(name)
	This macro creates a discover primary service request. More...

#define	BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_BY_UUID16_REQ(name, uuid16)
	This macro creates a discover primary service by UUID16 request. More...

#define	BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_BY_UUID128_REQ(name, uuid128)
	This macro creates a discover primary service by UUID128 request. More...

#define	BT_GATTC_NEW_FIND_INCLUDED_SERVICE_REQ(name, start_handle, end_handle)
	This macro defines a find included service request. More...

#define	BT_GATTC_NEW_DISCOVER_CHARC_REQ(name, start_handle, end_handle)
	This macro creates a discover characteristic request. More...

#define	BT_GATTC_NEW_DISCOVER_CHARC_BY_UUID_REQ(name, start_handle, end_handle, uuid, len)
	This macro creates a discover characteristic by UUID request. More...

#define	BT_GATTC_NEW_DISCOVER_CHARC_DESCRIPTOR_REQ(name, start_handle, end_handle)
	This macro creates a discover characteristic descriptor request. More...

#define	BT_GATTC_NEW_READ_CHARC_REQ(name, attr_handle)
	This macro creates a read characteristic request. More...

#define	BT_GATTC_NEW_READ_LONG_CHARC_REQ(name, attr_handle, offset)
	This macro creates a read long characteristic request. More...

#define	BT_GATTC_NEW_READ_USING_CHARC_UUID_REQ(name, start_handle, end_handle, uuid, len)
	This macro creates a read using characteristic UUID request. More...

#define	BT_GATTC_NEW_WRITE_WITHOUT_RSP_REQ(name, buffer, type, attribute_handle, attribute_value, attribute_len)
	This macro creates a write command request. More...

#define	BT_GATTC_NEW_WRITE_CHARC_REQ(name, buffer, attribute_handle, attribute_value, attribute_len)
	This macro creates a write request. More...

#define	BT_GATTC_NEW_PREPARE_WRITE_REQ(name, attr_handle, offset, value, value_len)
	This macro creates a prepare write request. More...

#define	BT_GATTC_NEW_EXECUTE_WRITE_REQ(name, flag)
	This macro creates an execute write request. More...

Macro Definition Documentation

#define BT_GATTC_CHARC_VALUE_CONFIRMATION (BT_MODULE_GATT | 0x00130000)

This is the confirmation event, generated from bt_gatts_send_charc_value_notification_indication(), with (uint32_t* connect_handle) as the payload.

#define BT_GATTC_CHARC_VALUE_INDICATION (BT_MODULE_GATT | 0x00120000)

This is the indication event with bt_gatt_handle_value_indication_t as the payload.

#define BT_GATTC_CHARC_VALUE_NOTIFICATION (BT_MODULE_GATT | 0x00110000)

This is the notification event with bt_gatt_handle_value_notification_t as the payload.

#define BT_GATTC_DISCOVER_CHARC (BT_MODULE_GATT | 0x00050000)

This is the confirmation event, generated from bt_gattc_discover_charc(), with bt_gattc_read_by_type_rsp_t as the payload.

#define BT_GATTC_DISCOVER_CHARC_DESCRIPTOR (BT_MODULE_GATT | 0x00060000)

This is the confirmation event, generated from bt_gattc_discover_charc_descriptor(), with bt_gattc_find_info_rsp_t as the payload.

#define BT_GATTC_DISCOVER_PRIMARY_SERVICE (BT_MODULE_GATT | 0x00020000)

This is the confirmation event, generated from bt_gattc_discover_primary_service(), with bt_gattc_read_by_group_type_rsp_t as the payload.

#define BT_GATTC_DISCOVER_PRIMARY_SERVICE_BY_UUID (BT_MODULE_GATT | 0x00030000)

This is the confirmation event, generated from bt_gattc_discover_primary_service_by_uuid(), with bt_gattc_find_by_type_value_rsp_t as the payload.

#define BT_GATTC_EXCHANGE_MTU (BT_MODULE_GATT | 0x00010000)

This is the confirmation event, generated from bt_gattc_exchange_mtu(), with bt_gatt_exchange_mtu_rsp_t as the payload.

#define BT_GATTC_FIND_INCLUDED_SERVICES (BT_MODULE_GATT | 0x00040000)

This is the confirmation event, generated from bt_gattc_find_included_services(), with bt_gattc_read_by_type_rsp_t as the payload.

#define BT_GATTC_NEW_DISCOVER_CHARC_BY_UUID_REQ	(	name,
		start_handle,
		end_handle,
		uuid,
		len
	)

Value:

static bt_gattc_discover_charc_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;       \
    name.starting_handle = start_handle;                    \
    name.ending_handle = end_handle;                        \
    bt_uuid_load(&(name.type), (void *)uuid, len);

This macro creates a discover characteristic by UUID request.

Parameters

[in]	name	is the name of the request.
[in]	start_handle	is the starting handle to search.
[in]	end_handle	is the ending handle to search.
[in]	uuid	is the buffer to hold the UUID to discover.
[in]	len	is the buffer length to hold the UUID.

#define BT_GATTC_NEW_DISCOVER_CHARC_DESCRIPTOR_REQ	(	name,
		start_handle,
		end_handle
	)

Value:

static bt_gattc_discover_charc_descriptor_req_t name;    \
    name.opcode = BT_ATT_OPCODE_FIND_INFORMATION_REQUEST;    \
    name.starting_handle = start_handle;                     \
    name.ending_handle = end_handle;

This macro creates a discover characteristic descriptor request.

Parameters

[in]	name	is the name of the request.
[in]	start_handle	is the starting handle to search.
[in]	end_handle	is the ending handle to search.

#define BT_GATTC_NEW_DISCOVER_CHARC_REQ	(	name,
		start_handle,
		end_handle
	)

Value:

static bt_gattc_discover_charc_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;       \
    name.starting_handle = start_handle;                    \
    name.ending_handle = end_handle;                        \
    uint16_t name##uuid_16 = BT_GATT_UUID16_CHARC;          \
    bt_uuid_load(&(name.type), (void *)&(name##uuid_16), 2);

This macro creates a discover characteristic request.

Parameters

[in]	name	is the name of the request.
[in]	start_handle	is the starting handle to search.
[in]	end_handle	is the ending handle to search.

#define BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_BY_UUID128_REQ	(	name,
		uuid128
	)

Value:

static bt_gattc_discover_primary_service_by_uuid_req_t name;                \
    static uint8_t name##buf[30];                                                \
    name.attribute_value_length = 16;                                            \
    name.att_req = (bt_att_find_by_type_value_req_t *)(name##buf);              \
    name.att_req->opcode = BT_ATT_OPCODE_FIND_BY_TYPE_VALUE_REQUEST;            \
    name.att_req->starting_handle = 0x0001;                                     \
    name.att_req->ending_handle = 0xFFFF;                                       \
    name.att_req->uuid = BT_GATT_UUID16_PRIMARY_SERVICE;                        \
    memcpy(&(name.att_req->attribute_value), &uuid128, 16);

This macro creates a discover primary service by UUID128 request.

Parameters

[in]	name	is the name of the request.
[in]	uuid128	is the 128-bit UUID to discover.

#define BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_BY_UUID16_REQ	(	name,
		uuid16
	)

Value:

static bt_gattc_discover_primary_service_by_uuid_req_t name;                \
    static uint8_t name##buf[9];                                                \
    name.attribute_value_length = 2;                                            \
    name.att_req = (bt_att_find_by_type_value_req_t *)(name##buf);              \
    name.att_req->opcode = BT_ATT_OPCODE_FIND_BY_TYPE_VALUE_REQUEST;            \
    name.att_req->starting_handle = 0x0001;                                     \
    name.att_req->ending_handle = 0xFFFF;                                       \
    name.att_req->uuid = BT_GATT_UUID16_PRIMARY_SERVICE;                        \
    memcpy(&(name.att_req->attribute_value), &uuid16, 2);

This macro creates a discover primary service by UUID16 request.

Parameters

[in]	name	is the name of the request.
[in]	uuid16	is the 16-bit UUID to discover.

#define BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_REQ ( name )

Value:

static const bt_gattc_discover_primary_service_req_t name = {   \
    .opcode = BT_ATT_OPCODE_READ_BY_GROUP_TYPE_REQUEST,             \
    .starting_handle = 0x0001,                                      \
    .ending_handle = 0xFFFF,                                        \
    .type16 = BT_GATT_UUID16_PRIMARY_SERVICE                        \
    }

This macro creates a discover primary service request.

Parameters

[in] name is the name of the request.

#define BT_GATTC_NEW_EXCHANGE_MTU_REQ	(	name,
		mtu
	)

Value:

static bt_gattc_exchange_mtu_req_t name;            \
    name.opcode = BT_ATT_OPCODE_EXCHANGE_MTU_REQUEST;   \
    name.client_rx_mtu = mtu;                           \

This macro creates an exchange MTU request.

Parameters

[in]	name	is the name of the request.
[in]	mtu	is the client RX MTU to exchange.

#define BT_GATTC_NEW_EXECUTE_WRITE_REQ	(	name,
		flag
	)

Value:

static bt_gattc_execute_write_req_t name;           \
    name.opcode = BT_ATT_OPCODE_EXECUTE_WRITE_REQUEST;  \
    name.flags = flag;

This macro creates an execute write request.

Parameters

[in]	name	is the name of the request.
[in]	flag	is the flag to determine whether to write or cancel all the prepared values.

#define BT_GATTC_NEW_FIND_INCLUDED_SERVICE_REQ	(	name,
		start_handle,
		end_handle
	)

Value:

static bt_gattc_find_included_services_req_t name;          \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;           \
    name.type16 = BT_GATT_UUID16_INCLUDE;                       \
    name.starting_handle = start_handle;                        \
    name.ending_handle = end_handle;

This macro defines a find included service request.

Parameters

[in]	name	is the name of the request.
[in]	start_handle	is the starting handle to search.
[in]	end_handle	is the ending handle to search.

#define BT_GATTC_NEW_PREPARE_WRITE_REQ	(	name,
		attr_handle,
		offset,
		value,
		value_len
	)

Value:

static bt_gattc_prepare_write_charc_req_t name;                 \
    static bt_att_prepare_write_req_t name##att_req;                \
    (name##att_req).opcode = BT_ATT_OPCODE_PREPARE_WRITE_REQUEST;   \
    (name##att_req).attribute_handle = attr_handle;            \
    (name##att_req).value_offset = offset;                          \
    (name##att_req).part_attribute_value = value;                   \
    name.attribute_value_length = value_len;                        \
    name.att_req = &(name##att_req);

This macro creates a prepare write request.

Parameters

[in]	name	is the name of the request.
[in]	attr_handle	is the handle of the attribute to write.
[in]	offset	is the offset to begin writing.
[in]	value	is the value to write.
[in]	value_len	is the length of the value to write.

#define BT_GATTC_NEW_READ_CHARC_REQ	(	name,
		attr_handle
	)

Value:

static bt_gattc_read_charc_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_REQUEST;           \
    name.attribute_handle = attr_handle;

This macro creates a read characteristic request.

Parameters

[in]	name	is the name of the request.
[in]	attr_handle	is the attribute handle to read.

#define BT_GATTC_NEW_READ_LONG_CHARC_REQ	(	name,
		attr_handle,
		offset
	)

Value:

static bt_gattc_read_long_charc_value_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_BLOB_REQUEST;          \
    name.attribute_handle = attr_handle;                    \
    name.value_offset = offset;

This macro creates a read long characteristic request.

Parameters

[in]	name	is the name of the request.
[in]	attr_handle	is the attribute handle to read.
[in]	offset	is the offset to start reading.

#define BT_GATTC_NEW_READ_USING_CHARC_UUID_REQ	(	name,
		start_handle,
		end_handle,
		uuid,
		len
	)

Value:

static bt_gattc_read_using_charc_uuid_req_t name;       \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;       \
    name.starting_handle = start_handle;                    \
    name.ending_handle = end_handle;                        \
    bt_uuid_load(&name.type, (void *)uuid, len);

This macro creates a read using characteristic UUID request.

Parameters

[in]	name	is the name of the request.
[in]	start_handle	is the starting handle to search.
[in]	end_handle	is the ending handle to search.
[in]	uuid	is the buffer to hold the UUID to read.
[in]	len	is the buffer length to hold the UUID.

#define BT_GATTC_NEW_WRITE_CHARC_REQ	(	name,
		buffer,
		attribute_handle,
		attribute_value,
		attribute_len
	)

Value:

static bt_gattc_write_charc_req_t name;                 \
    name.attribute_value_length = attribute_len;            \
    name.att_req = (bt_att_write_req_t *)(buffer);          \
    name.att_req->opcode = BT_ATT_OPCODE_WRITE_REQUEST;     \
    name.att_req->attribute_handle = attribute_handle;          \
    memcpy(name.att_req->attribute_value, attribute_value, attribute_len);

This macro creates a write request.

Parameters

[in]	name	is the name of the request.
[in]	buffer	is the buffer to hold the content of the bt_gattc_write_charc_req_t.
[in]	attribute_handle	is the handle of the attribute to write.
[in]	attribute_value	is the value to write.
[in]	attribute_len	is the length of the value to write.

#define BT_GATTC_NEW_WRITE_WITHOUT_RSP_REQ	(	name,
		buffer,
		type,
		attribute_handle,
		attribute_value,
		attribute_len
	)

Value:

static bt_gattc_write_without_rsp_req_t name;               \
    name.attribute_value_length = attribute_len;                \
    name.att_req = (bt_att_write_command_t *)(buffer);          \
    name.att_req->opcode = (type == 0 ? BT_ATT_OPCODE_WRITE_COMMAND : BT_ATT_OPCODE_SIGNED_WRITE_COMMAND);  \
    name.att_req->attribute_handle = attribute_handle;          \
    memcpy(name.att_req->attribute_value, attribute_value, attribute_len);

This macro creates a write command request.

Parameters

[in]	name	is the name of the request.
[in]	buffer	is the buffer to hold the content of the bt_att_write_command_t.
[in]	type	is the type of the write command, 0-WRITE_COMMAND, 1-SIGNED_WRITE_COMMAND.
[in]	attribute_handle	is the handle of the attribute to write.
[in]	attribute_value	is the value to write.
[in]	attribute_len	is the length of the value to write.

#define BT_GATTC_READ_CHARC (BT_MODULE_GATT | 0x00070000)

This is the confirmation event, generated from bt_gattc_read_charc(), with bt_gattc_read_rsp_t as the payload.

#define BT_GATTC_READ_LONG_CHARC (BT_MODULE_GATT | 0x00080000)

This is the confirmation event, generated from bt_gattc_read_long_charc(), with bt_gattc_read_rsp_t as the payload.

#define BT_GATTC_READ_MULTI_CHARC_VALUES (BT_MODULE_GATT | 0x000A0000)

This is the confirmation event, generated from bt_gattc_read_multi_charc_values(), with bt_gattc_read_multiple_rsp_t as the payload.

#define BT_GATTC_READ_USING_CHARC_UUID (BT_MODULE_GATT | 0x00090000)

This is the confirmation event, generated from bt_gattc_read_using_charc_uuid(), with bt_gattc_read_by_type_rsp_t as the payload.

#define BT_GATTC_RELIABLE_WRITE_CHARC (BT_MODULE_GATT | 0x000F0000)

This is the confirmation event, generated from bt_gattc_prepare_write_charc() as the reliable writes, with bt_gattc_execute_write_rsp_t as the payload.

#define BT_GATTC_WRITE_CHARC (BT_MODULE_GATT | 0x000D0000)

This is the confirmation event, generated from bt_gattc_write_charc(), with bt_gattc_write_rsp_t as the payload.

#define BT_GATTC_WRITE_LONG_CHARC (BT_MODULE_GATT | 0x000E0000)

This is the confirmation event, generated from bt_gattc_prepare_write_charc() that writes long characteristic value or writes long characteristic descriptors, with bt_gattc_execute_write_rsp_t as the payload.

Overview

Macros

Macro Definition Documentation