This section defines the macros for the GATTS. More...

Overview

This section defines the macros for the GATTS.

This section describes the macros defined for the GATTS.

Macros
#define	BT_GATTS_REC_PERM_READ_SHIFT(mask) ((mask)<<4)
	Note, when creating a record, the application should synchronize the record's permission and characteristic properties to be read out by the client. More...

#define	BT_GATTS_REC_PERM_WRITE_SHIFT(mask) ((mask)<<0)
	Write the permission mask shift. More...

#define	BT_GATTS_REC_PERM_READ_MASK 0xf0
	Read the permission mask. More...

#define	BT_GATTS_REC_PERM_READABLE 0x80
	The record is readable without any security requirement. More...

#define	BT_GATTS_REC_PERM_READABLE_ENCRYPTION (BT_GATTS_REC_PERM_READABLE \| (BT_GATTS_REC_PERM_READ_SHIFT(BT_GAP_LE_SECURITY_ENCRYPTION_MASK)))
	The record is readable when the connection is encrypted. More...

#define	BT_GATTS_REC_PERM_READABLE_AUTHENTICATION (BT_GATTS_REC_PERM_READABLE \| (BT_GATTS_REC_PERM_READ_SHIFT(BT_GAP_LE_SECURITY_AUTHENTICATION_MASK)))
	The record is readable only for the authenticated connection. More...

#define	BT_GATTS_REC_PERM_READABLE_AUTHORIZATION (BT_GATTS_REC_PERM_READABLE \| (BT_GATTS_REC_PERM_READ_SHIFT(BT_GAP_LE_SECURITY_AUTHORIZATION_MASK)))
	The record is readable only after the application is granted a permission. More...

#define	BT_GATTS_IS_READABLE(perm) (((perm) & BT_GATTS_REC_PERM_READ_MASK)> 0)
	Checks if the record is readable. More...

#define	BT_GATTS_REC_PERM_WRITE_MASK 0x0f
	Write the permission mask. More...

#define	BT_GATTS_REC_PERM_WRITABLE 0x08
	The record is writable without any security requirement. More...

#define	BT_GATTS_REC_PERM_WRITABLE_ENCRYPTION (BT_GATTS_REC_PERM_WRITABLE \| (BT_GATTS_REC_PERM_WRITE_SHIFT(BT_GAP_LE_SECURITY_ENCRYPTION_MASK)))
	The record is writable when the connection is encrypted. More...

#define	BT_GATTS_REC_PERM_WRITABLE_AUTHENTICATION (BT_GATTS_REC_PERM_WRITABLE \| (BT_GATTS_REC_PERM_WRITE_SHIFT(BT_GAP_LE_SECURITY_AUTHENTICATION_MASK)))
	The record is writable only for the authenticated connection. More...

#define	BT_GATTS_REC_PERM_WRITABLE_AUTHORIZATION (BT_GATTS_REC_PERM_WRITABLE \| (BT_GATTS_REC_PERM_WRITE_SHIFT(BT_GAP_LE_SECURITY_AUTHORIZATION_MASK)))
	The record is writable only after the application is granted a permission. More...

#define	BT_GATTS_IS_WRITABLE(perm) (((perm) & BT_GATTS_REC_PERM_WRITE_MASK)> 0)
	Checks if the record is writable. More...

#define	BT_GATTS_CALLBACK_READ 0
	It is used in the record's callback bt_gatts_rec_callback_t() to notify a read request. More...

#define	BT_GATTS_CALLBACK_WRITE 1
	It is used in the record's callback bt_gatts_rec_callback_t() to notify a write request. More...

#define	BT_GATTS_CALLBACK_PREPARE_WRITE 2
	It is used in the record's callback bt_gatts_rec_callback_t() to notify a prepare write request. More...

#define	BT_GATTS_CALLBACK_EXECUTE_WRITE_CANCEL 3
	It is used in the record's callback bt_gatts_rec_callback_t() to notify an execute write with action cancel request. More...

#define	BT_GATTS_CALLBACK_EXECUTE_WRITE_WRITE 4
	It is used in the record's callback bt_gatts_rec_callback_t() to notify an execute write with action write request. More...

#define	BT_GATTS_EXECUTE_WRITE_RLT_SET(handle, status) (((handle)<<8)\|(status))
	It is used to create a response to the execute write operation. More...

#define	BT_GATTS_EXECUTE_WRITE_RLT_GET_HANDLE(s) (((s)>>8)&0xFFFF)
	It is used to get handle of the execute write response. More...

#define	BT_GATTS_EXECUTE_WRITE_RLT_GET_STATUS(s) ((s)&0xFF)
	It is used to get status of the execute write response. More...

#define	BT_GATTS_NEW_PRIMARY_SERVICE_16(name, uuid16_value)
	This macro creates a 16-bit primary service. More...

#define	BT_GATTS_NEW_PRIMARY_SERVICE_128(name, uuid128_value)
	This macro creates a 128-bit primary service. More...

#define	BT_GATTS_NEW_SECONDARY_SERVICE_16(name, uuid16_value)
	This macro creates a 16-bit secondary service. More...

#define	BT_GATTS_NEW_SECONDARY_SERVICE_128(name, uuid128_value)
	This macro creates a 128-bit secondary service. More...

#define	BT_GATTS_NEW_INCLUDED_SERVICE_16(name, s_handle, e_handle, uuid)
	This macro creates a 16-bit included service. More...

#define	BT_GATTS_NEW_INCLUDED_SERVICE_128(name, s_handle, e_handle)
	This macro creates a 128-bit included service. More...

#define	BT_GATTS_NEW_CHARC_16(name, prop, _handle, uuid)
	This macro creates a 16-bit readable characteristic. More...

#define	BT_GATTS_NEW_CHARC_16_WRITABLE(name, prop, _handle, uuid)
	This macro creates a 16-bit writable characteristic. More...

#define	BT_GATTS_NEW_CHARC_128(name, prop, _handle, uuid)
	This macro creates a 128-bit readable characteristic. More...

#define	BT_GATTS_NEW_CHARC_VALUE_UINT8(name, uuid, _perm, _value)
	This macro creates a const uint8 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_UINT8_WRITABLE(name, uuid, _perm, _value)
	This macro creates a uint8 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_UINT16(name, uuid, _perm, _value)
	This macro creates a const uint16 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_UINT32(name, uuid, _perm, _value)
	This macro creates a const uint32 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_UINT32_WRITABLE(name, uuid, _perm, _value)
	This macro creates a uint32 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_INT8(name, uuid, _perm, _value)
	This macro creates a const int8 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_INT16(name, uuid, _perm, _value)
	This macro creates a const int16 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_INT32(name, uuid, _perm, _value)
	This macro creates a const int32 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_CALLBACK(name, uuid, _perm, call)
	This macro creates a characteristic value with callback. More...

#define	BT_GATTS_NEW_CHARC_VALUE_CALLBACK_WRITABLE(name, uuid, _perm, call)
	This macro creates a characteristic value with callback. More...

#define	BT_GATTS_NEW_CHARC_VALUE_STR16(name, uuid, _perm, val_len, val_name)
	This macro creates a str16 characteristic value. More...

#define	BT_GATTS_NEW_CHARC_VALUE_HALFW8_WRITABLE(name, uuid, _perm, val_len, ...)
	This macro creates a half word characteristic value. More...

#define	BT_GATTS_NEW_CHARC_EXTENDED_PROPERTIES(name, ext_prop)
	This macro creates a characteristic extended properties descriptor. More...

#define	BT_GATTS_NEW_CHARC_USER_DESCRIPTION_STR16(name, _perm, val_len, val_name)
	This macro creates a characteristic str16 user description descriptor. More...

#define	BT_GATTS_NEW_CHARC_USER_DESCRIPTION(name, _perm, _callback)
	This macro creates a characteristic user description descriptor. More...

#define	BT_GATTS_NEW_CLIENT_CHARC_CONFIG(name, _perm, _callback)
	This macro creates a client characteristic configuration descriptor. More...

#define	BT_GATTS_NEW_SERVER_CHARC_CONFIG(name, _perm, _callback)
	This macro creates a server characteristic configuration descriptor. More...

#define	BT_GATTS_NEW_CHARC_FORMAT(name, _format, _exponent, _unit, _name_space, _description)
	This macro creates a characteristic presentation format descriptor. More...

#define	BT_GATTS_NEW_CHARC_AGGREGATE_FORMAT_H8(name, _perm, val_len, ...)
	This macro creates a characteristic aggregate format descriptor. More...

Macro Definition Documentation

#define BT_GATTS_CALLBACK_EXECUTE_WRITE_CANCEL 3

It is used in the record's callback bt_gatts_rec_callback_t() to notify an execute write with action cancel request.

#define BT_GATTS_CALLBACK_EXECUTE_WRITE_WRITE 4

It is used in the record's callback bt_gatts_rec_callback_t() to notify an execute write with action write request.

#define BT_GATTS_CALLBACK_PREPARE_WRITE 2

It is used in the record's callback bt_gatts_rec_callback_t() to notify a prepare write request.

#define BT_GATTS_CALLBACK_READ 0

It is used in the record's callback bt_gatts_rec_callback_t() to notify a read request.

#define BT_GATTS_CALLBACK_WRITE 1

It is used in the record's callback bt_gatts_rec_callback_t() to notify a write request.

#define BT_GATTS_EXECUTE_WRITE_RLT_GET_HANDLE ( s ) (((s)>>8)&0xFFFF)

It is used to get handle of the execute write response.

#define BT_GATTS_EXECUTE_WRITE_RLT_GET_STATUS ( s ) ((s)&0xFF)

It is used to get status of the execute write response.

#define BT_GATTS_EXECUTE_WRITE_RLT_SET	(	handle,
		status
	)	(((handle)<<8)\|(status))

It is used to create a response to the execute write operation.

#define BT_GATTS_IS_READABLE ( perm ) (((perm) & BT_GATTS_REC_PERM_READ_MASK)> 0)

Checks if the record is readable.

#define BT_GATTS_IS_WRITABLE ( perm ) (((perm) & BT_GATTS_REC_PERM_WRITE_MASK)> 0)

Checks if the record is writable.

#define BT_GATTS_NEW_CHARC_128	(	name,
		prop,
		_handle,
		uuid
	)

Value:

static const bt_gatts_characteristic_128_t name = {     \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC,       \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,      \
    .rec_hdr.value_len = 19,                                \
    .value.properties = prop,                               \
    .value.handle = _handle,                                 \
    .value.uuid128 = uuid                                   \
    }

This macro creates a 128-bit readable characteristic.

Parameters

[in]	name	is the name of the record.
[in]	prop	specifies the properties of the characteristic.
[in]	_handle	is the handle of the characteristic value.
[in]	uuid	is the 128-bit characteristic UUID.

#define BT_GATTS_NEW_CHARC_16	(	name,
		prop,
		_handle,
		uuid
	)

Value:

static const bt_gatts_characteristic_16_t name = {       \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC,                 \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,              \
    .rec_hdr.value_len = 5,                                  \
    .value.properties = prop,                                \
    .value.handle = _handle,                                 \
    .value.uuid16 = uuid                                     \
    }

This macro creates a 16-bit readable characteristic.

Parameters

[in]	name	is the name of the record.
[in]	prop	specifies the properties of the characteristic.
[in]	_handle	is the handle of the characteristic value.
[in]	uuid	is the 16-bit characteristic UUID.

#define BT_GATTS_NEW_CHARC_16_WRITABLE	(	name,
		prop,
		_handle,
		uuid
	)

Value:

static bt_gatts_characteristic_16_t name = {            \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC,                \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,             \
    .rec_hdr.value_len = 5,                                 \
    .value.properties = prop,                               \
    .value.handle = _handle,                                \
    .value.uuid16 = uuid                                    \
    }

This macro creates a 16-bit writable characteristic.

Parameters

[in]	name	is the name of the record.
[in]	prop	specifies the properties of the characteristic.
[in]	_handle	is the handle of the characteristic value.
[in]	uuid	is the 16-bit characteristic UUID.

#define BT_GATTS_NEW_CHARC_AGGREGATE_FORMAT_H8	(	name,
		_perm,
		val_len,
		...
	)

Value:

static const bt_gatts_characteristic_aggregate_format_t name = {                 \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC_AGGREGATE_FORMAT,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = val_len,                                        \
    .handle_list = {__VA_ARGS__}                                                     \
    }

This macro creates a characteristic aggregate format descriptor.

IMPORTANT: The length(val_len) is the number of bytes, and the maximum number of handles is 8.

Parameters

[in]	name	is the name of the record.
[in]	_perm	is the permission of the record.
[in]	val_len	is the length of the handle list in bytes.

#define BT_GATTS_NEW_CHARC_EXTENDED_PROPERTIES	(	name,
		ext_prop
	)

Value:

static const bt_gatts_characteristic_extended_properties_t name = { \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC_EXTENDED_PROPERTIES,          \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,                  \
    .rec_hdr.value_len = 2,                                             \
    .extended_properties = ext_prop                                     \
    }

This macro creates a characteristic extended properties descriptor.

Parameters

[in]	name	is the name of the record.
[in]	ext_prop	specifies the characteristic extended properties.

#define BT_GATTS_NEW_CHARC_FORMAT	(	name,
		_format,
		_exponent,
		_unit,
		_name_space,
		_description
	)

Value:

static const bt_gatts_characteristic_format_t name = {                                  \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC_FORMAT,                                \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,                                      \
    .rec_hdr.value_len = 7,                                                                 \
    .value.format = _format,                                                                 \
    .value.exponent = _exponent,                                                             \
    .value.unit = _unit,                                                                     \
    .value.name_space = _name_space,                                                         \
    .value.description = _description                                                        \
    }

This macro creates a characteristic presentation format descriptor.

Parameters

[in]	name	is the name of the record.
[in]	_format	is the format of the value of this characteristic.
[in]	_exponent	is the exponent field to determine how the value is further formatted.
[in]	_unit	is the unit of the characteristic.
[in]	_name_space	is the namespace of the characteristic.
[in]	_description	is the description of the characteristic.

#define BT_GATTS_NEW_CHARC_USER_DESCRIPTION	(	name,
		_perm,
		_callback
	)

Value:

static const bt_gatts_characteristic_user_description_t name = {       \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC_USER_DESCRIPTION,     \
    .rec_hdr.perm = _perm,                                               \
    .rec_hdr.value_len = 0,                                             \
    .callback = _callback                                                \
    }

This macro creates a characteristic user description descriptor.

Parameters

[in]	name	is the name of the record.
[in]	_perm	is the permission of the record.
[in]	_callback	is the callback to handle the record read and write request.

#define BT_GATTS_NEW_CHARC_USER_DESCRIPTION_STR16	(	name,
		_perm,
		val_len,
		val_name
	)

Value:

static const bt_gatts_characteristic_user_description_str16_t name = {                 \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CHARC_USER_DESCRIPTION,   \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = val_len,                                        \
    .str = val_name                                                     \
    }

This macro creates a characteristic str16 user description descriptor.

IMPORTANT: The length(val_len) of val_name should be less than or equal to 16.

Parameters

[in]	name	is the name of the record.
[in]	_perm	is the permission of the record.
[in]	val_len	is the length of the record.
[in]	val_name	is the name of the buffer to hold the record value.

#define BT_GATTS_NEW_CHARC_VALUE_CALLBACK	(	name,
		uuid,
		_perm,
		call
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 0,                                         \
    .value.callback = call                                          \
    }

This macro creates a characteristic value with callback.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	call	is the callback to handle the characteristic value read and write request.

#define BT_GATTS_NEW_CHARC_VALUE_CALLBACK_WRITABLE	(	name,
		uuid,
		_perm,
		call
	)

Value:

static bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 0,                                         \
    .value.callback = call                                          \
    }

This macro creates a characteristic value with callback.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	call	is the callback to handle the characteristic value read and write request.

#define BT_GATTS_NEW_CHARC_VALUE_HALFW8_WRITABLE	(	name,
		uuid,
		_perm,
		val_len,
		...
	)

Value:

static bt_gatts_characteristic_halfw8_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = val_len,                                        \
    .halfw =  {__VA_ARGS__}                                                     \
    }

This macro creates a half word characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	val_len	is the length of the characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_INT16	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 2,                                         \
    .value.value_int_16 = _value                                     \
    }

This macro creates a const int16 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is int16 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_INT32	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 4,                                         \
    .value.value_int_32 = _value                                     \
    }

This macro creates a const int32 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is int32 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_INT8	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 1,                                         \
    .value.value_int_8 = _value                                      \
    }

This macro creates a const int8 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is int8 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_STR16	(	name,
		uuid,
		_perm,
		val_len,
		val_name
	)

Value:

static const bt_gatts_characteristic_str16_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = val_len,                                        \
    .str = val_name                                                     \
    }

This macro creates a str16 characteristic value.

IMPORTANT: The length(val_len) of val_name should be less than or equal to 16.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	val_len	is the length of the characteristic value.
[in]	val_name	is the name of the buffer to hold the characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_UINT16	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 2,                                         \
    .value.value_uint_16 = _value                                    \
    }

This macro creates a const uint16 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is uint16 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_UINT32	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 4,                                         \
    .value.value_uint_32 = _value                                    \
    }

This macro creates a const uint32 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is uint32 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_UINT32_WRITABLE	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 4,                                         \
    .value.value_uint_32 = _value                                    \
    }

This macro creates a uint32 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is uint32 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_UINT8	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static const bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 1,                                         \
    .value.value_uint_8 = _value                                     \
    }

This macro creates a const uint8 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is uint8 characteristic value.

#define BT_GATTS_NEW_CHARC_VALUE_UINT8_WRITABLE	(	name,
		uuid,
		_perm,
		_value
	)

Value:

static bt_gatts_characteristic_t name = {                 \
    .rec_hdr.uuid_ptr = &uuid,                                      \
    .rec_hdr.perm = _perm,                                           \
    .rec_hdr.value_len = 1,                                         \
    .value.value_uint_8 = _value                                     \
    }

This macro creates a uint8 characteristic value.

Parameters

[in]	name	is the name of the record.
[in]	uuid	is the UUID of the characteristic value.
[in]	_perm	is the permission of the characteristic value.
[in]	_value	is uint8 characteristic value.

#define BT_GATTS_NEW_CLIENT_CHARC_CONFIG	(	name,
		_perm,
		_callback
	)

Value:

static const bt_gatts_client_characteristic_config_t name = {       \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_CLIENT_CHARC_CONFIG,     \
    .rec_hdr.perm = _perm,                                               \
    .rec_hdr.value_len = 0,                                             \
    .callback = _callback                                                \
    }

This macro creates a client characteristic configuration descriptor.

Parameters

[in]	name	is the name of the record.
[in]	_perm	is the permission of the record.
[in]	_callback	is the callback to handle the record read and write request.

#define BT_GATTS_NEW_INCLUDED_SERVICE_128	(	name,
		s_handle,
		e_handle
	)

Value:

static const bt_gatts_included_service_t name = {                \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_INCLUDED_SERVICE,     \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,             \
    .rec_hdr.value_len = 4,                                 \
    .value.service_handle = s_handle,                       \
    .value.end_group_handle = e_handle,                     \
    .value.uuid16 =0x0000                                   \
    }

This macro creates a 128-bit included service.

Parameters

[in]	name	is the name of the record.
[in]	s_handle	is the starting handle of the included service.
[in]	e_handle	is the ending handle of the included service.

#define BT_GATTS_NEW_INCLUDED_SERVICE_16	(	name,
		s_handle,
		e_handle,
		uuid
	)

Value:

static const bt_gatts_included_service_t name = {                \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_INCLUDED_SERVICE,     \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,             \
    .rec_hdr.value_len = 6,                                 \
    .value.service_handle = s_handle,                       \
    .value.end_group_handle = e_handle,                     \
    .value.uuid16 = uuid                                    \
    }

This macro creates a 16-bit included service.

Parameters

[in]	name	is the name of the record.
[in]	s_handle	is the starting handle of the included service.
[in]	e_handle	is the ending handle of the included service.
[in]	uuid	is the 16-bit included service UUID.

#define BT_GATTS_NEW_PRIMARY_SERVICE_128	(	name,
		uuid128_value
	)

Value:

static const bt_gatts_primary_service_128_t name = {     \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_PRIMARY_SERVICE,      \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,      \
    .rec_hdr.value_len = 16,                                \
    .uuid128 = uuid128_value                                 \
    }

This macro creates a 128-bit primary service.

Parameters

[in]	name	is the name of the record.
[in]	uuid128_value	is the 128-bit primary service UUID.

#define BT_GATTS_NEW_PRIMARY_SERVICE_16	(	name,
		uuid16_value
	)

Value:

static const bt_gatts_primary_service_16_t name = {     \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_PRIMARY_SERVICE,      \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,              \
    .rec_hdr.value_len = 2,                                 \
    .uuid16 = uuid16_value                                   \
    }

This macro creates a 16-bit primary service.

Parameters

[in]	name	is the name of the record.
[in]	uuid16_value	is the 16-bit primary service UUID.

#define BT_GATTS_NEW_SECONDARY_SERVICE_128	(	name,
		uuid128_value
	)

Value:

static const bt_gatts_secondary_service_128_t name = {   \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_SECONDARY_SERVICE,    \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,      \
    .rec_hdr.value_len = 16,                                \
    .uuid128 = uuid128_value                                \
    }

This macro creates a 128-bit secondary service.

Parameters

[in]	name	is the name of the record.
[in]	uuid128_value	is the 128-bit secondary service UUID.

#define BT_GATTS_NEW_SECONDARY_SERVICE_16	(	name,
		uuid16_value
	)

Value:

static const bt_gatts_secondary_service_16_t name = {   \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_SECONDARY_SERVICE,    \
    .rec_hdr.perm = BT_GATTS_REC_PERM_READABLE,      \
    .rec_hdr.value_len = 2,                                 \
    .uuid16 = uuid16_value                                   \
    }

This macro creates a 16-bit secondary service.

Parameters

[in]	name	is the name of the record.
[in]	uuid16_value	is the 16-bit secondary service UUID.

#define BT_GATTS_NEW_SERVER_CHARC_CONFIG	(	name,
		_perm,
		_callback
	)

Value:

static const bt_gatts_server_characteristic_config_t name = {       \
    .rec_hdr.uuid_ptr = &BT_GATT_UUID_SERVER_CHARC_CONFIG,     \
    .rec_hdr.perm = _perm,                                               \
    .rec_hdr.value_len = 0,                                             \
    .callback = _callback                                                \
    }

This macro creates a server characteristic configuration descriptor.

Parameters

[in]	name	is the name of the record.
[in]	_perm	is the permission of the record.
[in]	_callback	is the callback to handle the record read and write request.

#define BT_GATTS_REC_PERM_READ_MASK 0xf0

Read the permission mask.

#define BT_GATTS_REC_PERM_READ_SHIFT ( mask ) ((mask)<<4)

Note, when creating a record, the application should synchronize the record's permission and characteristic properties to be read out by the client.

When the client requests to read or write the record, the Bluetooth stack checks this permission.Read the permission mask shift.

#define BT_GATTS_REC_PERM_READABLE 0x80

The record is readable without any security requirement.

#define BT_GATTS_REC_PERM_READABLE_AUTHENTICATION (BT_GATTS_REC_PERM_READABLE | (BT_GATTS_REC_PERM_READ_SHIFT(BT_GAP_LE_SECURITY_AUTHENTICATION_MASK)))

The record is readable only for the authenticated connection.

#define BT_GATTS_REC_PERM_READABLE_AUTHORIZATION (BT_GATTS_REC_PERM_READABLE | (BT_GATTS_REC_PERM_READ_SHIFT(BT_GAP_LE_SECURITY_AUTHORIZATION_MASK)))

The record is readable only after the application is granted a permission.

#define BT_GATTS_REC_PERM_READABLE_ENCRYPTION (BT_GATTS_REC_PERM_READABLE | (BT_GATTS_REC_PERM_READ_SHIFT(BT_GAP_LE_SECURITY_ENCRYPTION_MASK)))

The record is readable when the connection is encrypted.

#define BT_GATTS_REC_PERM_WRITABLE 0x08

The record is writable without any security requirement.

#define BT_GATTS_REC_PERM_WRITABLE_AUTHENTICATION (BT_GATTS_REC_PERM_WRITABLE | (BT_GATTS_REC_PERM_WRITE_SHIFT(BT_GAP_LE_SECURITY_AUTHENTICATION_MASK)))

The record is writable only for the authenticated connection.

#define BT_GATTS_REC_PERM_WRITABLE_AUTHORIZATION (BT_GATTS_REC_PERM_WRITABLE | (BT_GATTS_REC_PERM_WRITE_SHIFT(BT_GAP_LE_SECURITY_AUTHORIZATION_MASK)))

The record is writable only after the application is granted a permission.

#define BT_GATTS_REC_PERM_WRITABLE_ENCRYPTION (BT_GATTS_REC_PERM_WRITABLE | (BT_GATTS_REC_PERM_WRITE_SHIFT(BT_GAP_LE_SECURITY_ENCRYPTION_MASK)))

The record is writable when the connection is encrypted.

#define BT_GATTS_REC_PERM_WRITE_MASK 0x0f

Write the permission mask.

#define BT_GATTS_REC_PERM_WRITE_SHIFT ( mask ) ((mask)<<0)

Write the permission mask shift.

Overview

Macros

Macro Definition Documentation