GATT Database#

sl_bt_gattdb_service_type_t#

sl_bt_gattdb_service_type_t

This enum defines GATT service types.

sl_bt_gattdb_value_type_t#

sl_bt_gattdb_value_type_t

This enum defines characteristic and descriptor value types.

sl_bt_gattdb_new_session#

sl_status_t sl_bt_gattdb_new_session (uint16_t *session)

Start a new GATT database update session. If the operation is successful, the Bluetooth stack returns a session ID, with which the GATT database can be updated by calling other database management APIs of this class. Changes in the database are not immediately saved. Unsaved changes are invisible to a connected remote GATT client.

After all changes were performed successfully, commit the changes using the sl_bt_gattdb_commit command. The Bluetooth stack will save the changes and handle GATT caching as needed. Unsaved database changes can also be canceled by calling the sl_bt_gattdb_abort command. In either case, after a commit or abort command is called, the current session is closed and the session ID becomes invalid.

Only one session is allowed at a time. Error SL_STATUS_ALREADY_EXISTS is returned if another session has been started already.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_add_service#

sl_status_t sl_bt_gattdb_add_service (uint16_t session, uint8_t type, uint8_t property, size_t uuid_len, const uint8_t *uuid, uint16_t *service)

Add a service into the local GATT database. When successful, the service is appended to the service list and is in stopped state. Use sl_bt_gattdb_start_service command to set it visible to remote GATT clients.

You are not allowed to add the Generic Attribute Profile service. If the application needs GATT caching, enable the feature in the configuration of this component and the GATT server will handle GATT caching according to the procedures specified by the Bluetooth core specification.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_remove_service#

sl_status_t sl_bt_gattdb_remove_service (uint16_t session, uint16_t service)

Remove a service and its characteristics from the local GATT database.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_add_included_service#

sl_status_t sl_bt_gattdb_add_included_service (uint16_t session, uint16_t service, uint16_t included_service, uint16_t *attribute)

Add an included-service attribute to a service.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_remove_included_service#

sl_status_t sl_bt_gattdb_remove_included_service (uint16_t session, uint16_t attribute)

Remove an included-service attribute from a service.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_add_uuid16_characteristic#

sl_status_t sl_bt_gattdb_add_uuid16_characteristic (uint16_t session, uint16_t service, uint16_t property, uint16_t security, uint8_t flag, sl_bt_uuid_16_t uuid, uint8_t value_type, uint16_t maxlen, size_t value_len, const uint8_t *value, uint16_t *characteristic)

Add a 16-bits UUID characteristic to a service. On success, the characteristic is appended to the characteristic list of the service and it inherits the started or stopped state of the service. In addition, it can be started and stopped separately with the sl_bt_gattdb_start_characteristic and sl_bt_gattdb_stop_characteristic commands.

If the flag parameter does not set SL_BT_GATTDB_NO_AUTO_CCCD, the stack will automatically add a Client Characteristic Configuration descriptor to this characteristic when it has the notify or indicate property. If SL_BT_GATTDB_NO_AUTO_CCCD is set, the user application should add the descriptor separately as needed.

A Characteristic Extended Properties descriptor is automatically added if the reliable write property is set.

Use the sl_bt_gattdb_add_uuid128_characteristic command to add a 128-bits UUID characteristic.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_add_uuid128_characteristic#

sl_status_t sl_bt_gattdb_add_uuid128_characteristic (uint16_t session, uint16_t service, uint16_t property, uint16_t security, uint8_t flag, uuid_128 uuid, uint8_t value_type, uint16_t maxlen, size_t value_len, const uint8_t *value, uint16_t *characteristic)

Add a 128-bits UUID characteristic to a service. When successful, the characteristic is appended to the characteristic list of the service and inherits the started or stopped state of the service. Additionally, it can be started and stopped separately with the sl_bt_gattdb_start_characteristic and sl_bt_gattdb_stop_characteristic commands.

If the flag parameter does not set SL_BT_GATTDB_NO_AUTO_CCCD, the stack will automatically add a Client Characteristic Configuration descriptor to this characteristic when it has the notify or indicate property. If SL_BT_GATTDB_NO_AUTO_CCCD is set, the user application should add the descriptor separately as needed.

A Characteristic Extended Properties descriptor is automatically added if the reliable write property is set.

Use the sl_bt_gattdb_add_uuid16_characteristic command to add a 16-bits UUID characteristic.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_remove_characteristic#

sl_status_t sl_bt_gattdb_remove_characteristic (uint16_t session, uint16_t characteristic)

Remove a characteristic and its descriptors from a service.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_add_uuid16_descriptor#

sl_status_t sl_bt_gattdb_add_uuid16_descriptor (uint16_t session, uint16_t characteristic, uint16_t property, uint16_t security, sl_bt_uuid_16_t uuid, uint8_t value_type, uint16_t maxlen, size_t value_len, const uint8_t *value, uint16_t *descriptor)

Add a 16-bits UUID descriptor to a characteristic. When successful, the descriptor is appended to the descriptor list of the characteristic and inherits the started or stopped state of the characteristic.

This command does not support adding Characteristic Extended Properties descriptors. This descriptor is automatically added if the characteristic value has the reliable-write property or when a Characteristic User Description descriptor is added and the user description has the write property.

Use the sl_bt_gattdb_add_uuid128_descriptor command to add a 128-bits UUID descriptor.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_add_uuid128_descriptor#

sl_status_t sl_bt_gattdb_add_uuid128_descriptor (uint16_t session, uint16_t characteristic, uint16_t property, uint16_t security, uuid_128 uuid, uint8_t value_type, uint16_t maxlen, size_t value_len, const uint8_t *value, uint16_t *descriptor)

Add a 128-bits UUID descriptor to a characteristic. When successful, the descriptor is appended to the descriptor list of the characteristic and inherits the started or stopped state of the characteristic.

This command does not support adding Characteristic Extended Properties descriptors. This descriptor is automatically added if the characteristic value has the reliable-write property or when a Characteristic User Description descriptor is added and the user description has the write property.

Use the sl_bt_gattdb_add_uuid16_descriptor command to add a 16-bits UUID descriptor.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_remove_descriptor#

sl_status_t sl_bt_gattdb_remove_descriptor (uint16_t session, uint16_t descriptor)

Remove a descriptor from a characteristic.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_start_service#

sl_status_t sl_bt_gattdb_start_service (uint16_t session, uint16_t service)

Start a service, so that the service and its attributes including characteristics and descriptors become visible to remote GATT clients after this change has been committed.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_stop_service#

sl_status_t sl_bt_gattdb_stop_service (uint16_t session, uint16_t service)

Stop a service, so that the service and its attributes including characteristics and descriptors become invisible to remote GATT clients after this change has been committed.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_start_characteristic#

sl_status_t sl_bt_gattdb_start_characteristic (uint16_t session, uint16_t characteristic)

Start a characteristic, so that the characteristic and its attributes become visible to remote GATT clients after this change has been committed. SL_STATUS_INVALID_STATE error is returned if the parent service is not started.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_stop_characteristic#

sl_status_t sl_bt_gattdb_stop_characteristic (uint16_t session, uint16_t characteristic)

Stop a characteristic, so that the characteristic and its attributes become invisible to remote GATT clients after this change has been committed.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_commit#

sl_status_t sl_bt_gattdb_commit (uint16_t session)

Save all changes performed in the current session and close the session. The stack will assign final handles to new and affected attributes and handle GATT caching as needed. The stack removes the client characteristic configurations of non-connected GATT clients except the service-changed configuration. For connected GATT clients during this database change, the stack removes the configurations to the removed characteristics. The session ID, temporary attribute handles returned during this session, and other existing attribute handles that are after newly added or removed attributes are invalidated.

Some attribute handles returned in this session may become invalid if attributes are not created in the order they present in the database. In this case, attribute handle cache of the database in the user application must be refreshed to avoid accidentally using an invalidated handle in subsequent operations.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gattdb_abort#

sl_status_t sl_bt_gattdb_abort (uint16_t session)

Cancel all changes performed in the current session and close the session. The database remains in the same state it was in just before the session was started. The session ID and all temporary attribute handles returned during this session are invalidated.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_cmd_gattdb_new_session_id#

#define sl_bt_cmd_gattdb_new_session_id

0x00460020

sl_bt_cmd_gattdb_add_service_id#

#define sl_bt_cmd_gattdb_add_service_id

0x01460020

sl_bt_cmd_gattdb_remove_service_id#

#define sl_bt_cmd_gattdb_remove_service_id

0x02460020

sl_bt_cmd_gattdb_add_included_service_id#

#define sl_bt_cmd_gattdb_add_included_service_id

0x03460020

sl_bt_cmd_gattdb_remove_included_service_id#

#define sl_bt_cmd_gattdb_remove_included_service_id

0x04460020

sl_bt_cmd_gattdb_add_uuid16_characteristic_id#

#define sl_bt_cmd_gattdb_add_uuid16_characteristic_id

0x05460020

sl_bt_cmd_gattdb_add_uuid128_characteristic_id#

#define sl_bt_cmd_gattdb_add_uuid128_characteristic_id

0x06460020

sl_bt_cmd_gattdb_remove_characteristic_id#

#define sl_bt_cmd_gattdb_remove_characteristic_id

0x07460020

sl_bt_cmd_gattdb_add_uuid16_descriptor_id#

#define sl_bt_cmd_gattdb_add_uuid16_descriptor_id

0x08460020

sl_bt_cmd_gattdb_add_uuid128_descriptor_id#

#define sl_bt_cmd_gattdb_add_uuid128_descriptor_id

0x09460020

sl_bt_cmd_gattdb_remove_descriptor_id#

#define sl_bt_cmd_gattdb_remove_descriptor_id

0x0a460020

sl_bt_cmd_gattdb_start_service_id#

#define sl_bt_cmd_gattdb_start_service_id

0x0b460020

sl_bt_cmd_gattdb_stop_service_id#

#define sl_bt_cmd_gattdb_stop_service_id

0x0c460020

sl_bt_cmd_gattdb_start_characteristic_id#

#define sl_bt_cmd_gattdb_start_characteristic_id

0x0d460020

sl_bt_cmd_gattdb_stop_characteristic_id#

#define sl_bt_cmd_gattdb_stop_characteristic_id

0x0e460020

sl_bt_cmd_gattdb_commit_id#

#define sl_bt_cmd_gattdb_commit_id

0x0f460020

sl_bt_cmd_gattdb_abort_id#

#define sl_bt_cmd_gattdb_abort_id

0x10460020

sl_bt_rsp_gattdb_new_session_id#

#define sl_bt_rsp_gattdb_new_session_id

0x00460020

sl_bt_rsp_gattdb_add_service_id#

#define sl_bt_rsp_gattdb_add_service_id

0x01460020

sl_bt_rsp_gattdb_remove_service_id#

#define sl_bt_rsp_gattdb_remove_service_id

0x02460020

sl_bt_rsp_gattdb_add_included_service_id#

#define sl_bt_rsp_gattdb_add_included_service_id

0x03460020

sl_bt_rsp_gattdb_remove_included_service_id#

#define sl_bt_rsp_gattdb_remove_included_service_id

0x04460020

sl_bt_rsp_gattdb_add_uuid16_characteristic_id#

#define sl_bt_rsp_gattdb_add_uuid16_characteristic_id

0x05460020

sl_bt_rsp_gattdb_add_uuid128_characteristic_id#

#define sl_bt_rsp_gattdb_add_uuid128_characteristic_id

0x06460020

sl_bt_rsp_gattdb_remove_characteristic_id#

#define sl_bt_rsp_gattdb_remove_characteristic_id

0x07460020

sl_bt_rsp_gattdb_add_uuid16_descriptor_id#

#define sl_bt_rsp_gattdb_add_uuid16_descriptor_id

0x08460020

sl_bt_rsp_gattdb_add_uuid128_descriptor_id#

#define sl_bt_rsp_gattdb_add_uuid128_descriptor_id

0x09460020

sl_bt_rsp_gattdb_remove_descriptor_id#

#define sl_bt_rsp_gattdb_remove_descriptor_id

0x0a460020

sl_bt_rsp_gattdb_start_service_id#

#define sl_bt_rsp_gattdb_start_service_id

0x0b460020

sl_bt_rsp_gattdb_stop_service_id#

#define sl_bt_rsp_gattdb_stop_service_id

0x0c460020

sl_bt_rsp_gattdb_start_characteristic_id#

#define sl_bt_rsp_gattdb_start_characteristic_id

0x0d460020

sl_bt_rsp_gattdb_stop_characteristic_id#

#define sl_bt_rsp_gattdb_stop_characteristic_id

0x0e460020

sl_bt_rsp_gattdb_commit_id#

#define sl_bt_rsp_gattdb_commit_id

0x0f460020

sl_bt_rsp_gattdb_abort_id#

#define sl_bt_rsp_gattdb_abort_id

0x10460020