GATT Server#

sl_bt_gatt_server_client_configuration_t#

sl_bt_gatt_server_client_configuration_t

These values define whether the server is to sent notifications or indications to a remote GATT server.

sl_bt_gatt_server_characteristic_status_flag_t#

sl_bt_gatt_server_characteristic_status_flag_t

These values describe whether the characteristic client configuration was changed or whether a characteristic confirmation was received.

sl_bt_gatt_server_set_max_mtu#

sl_status_t sl_bt_gatt_server_set_max_mtu (uint16_t max_mtu, uint16_t * max_mtu_out)

Set the maximum size of ATT Message Transfer Units (MTU) in the host stack. The functionality is the same as sl_bt_gatt_set_max_mtu and the setting applies to both GATT client and server.

The value will be used as maximum receive MTU size of the GATT server in ATT_EXCHANGE_MTU_RSP. If the GATT client component presents in the application, the value will also be used as the maximum receive MTU size in ATT_EXCHANGE_MTU_REQ. The ATT_MTU on a connection is 23 when the connection is opened. Note that only the GATT Client role can initiate an ATT MTU Exchange request.

If the given value is too large according to the maximum BGAPI payload size, the host stack will select the maximum possible value.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_get_mtu#

sl_status_t sl_bt_gatt_server_get_mtu (uint8_t connection, uint16_t * mtu)

Get the size of ATT Message Transfer Units (MTU) for a connection.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_find_attribute#

sl_status_t sl_bt_gatt_server_find_attribute (uint16_t start, size_t type_len, const uint8_t * type, uint16_t * attribute)

Find attributes of a certain type from a local GATT database. The type is usually given as a 16-bit or 128-bit UUID in little endian format.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_find_primary_service#

sl_status_t sl_bt_gatt_server_find_primary_service (uint16_t start, size_t uuid_len, const uint8_t * uuid, uint16_t * start_out, uint16_t * end_out)

Find a primary service from local GATT database.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_read_attribute_value#

sl_status_t sl_bt_gatt_server_read_attribute_value (uint16_t attribute, uint16_t offset, size_t max_value_size, size_t * value_len, uint8_t * value)

Read the value of an attribute from a local GATT database. Only (maximum BGAPI payload size - 3) amount of data can be read at once. The application can continue reading with increased offset value if it receives (maximum BGAPI payload size - 3) number of bytes.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_read_attribute_type#

sl_status_t sl_bt_gatt_server_read_attribute_type (uint16_t attribute, size_t max_type_size, size_t * type_len, uint8_t * type)

Read the type of an attribute from a local GATT database. The type is a UUID, usually 16 or 128 bits long in little endian format.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_read_attribute_properties#

sl_status_t sl_bt_gatt_server_read_attribute_properties (uint16_t attribute, uint8_t * category, uint16_t * security, uint16_t * properties, uint8_t * value_type, uint16_t * len, uint16_t * max_writable_len)

Read the properties of an attribute from the local GATT database.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_write_attribute_value#

sl_status_t sl_bt_gatt_server_write_attribute_value (uint16_t attribute, uint16_t offset, size_t value_len, const uint8_t * value)

Write the value of an attribute in the local GATT database. Writing the value of a characteristic of the local GATT database will not trigger notifications or indications to the remote GATT client if the characteristic has a property to indicate or notify and the client has enabled notification or indication. Notifications and indications are sent to the remote GATT client using sl_bt_gatt_server_send_notification or sl_bt_gatt_server_send_indication commands.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_send_user_read_response#

sl_status_t sl_bt_gatt_server_send_user_read_response (uint8_t connection, uint16_t characteristic, uint8_t att_errorcode, size_t value_len, const uint8_t * value, uint16_t * sent_len)

Send a response to a sl_bt_evt_gatt_server_user_read_request event. The response needs to be sent within 30 seconds, otherwise no more GATT transactions are allowed by the remote side. If attr_errorcode is set to 0, the characteristic value is sent to the remote GATT client in the standard way. Other attr_errorcode values will cause the local GATT server to send an attribute protocol error response instead of the actual data. Maximum number of bytes this command can send depends on the value of parameter att_opcode in sl_bt_evt_gatt_server_user_read_request event:

• ATT_MTU - 1 if the opcode is sl_bt_gatt_read_request or sl_bt_gatt_read_blob_request

• ATT_MTU - 4 if the opcode is sl_bt_gatt_read_by_type_request

If the data length in value exceeds the limit, the first maximum number of bytes will be sent and rest data is ignored. The actual number of bytes that was sent is retruned in the response of this command.

The client will continue reading by sending a new read blob request with an increased offset value if it receives the maximum amount of attribute data the read respond packet can contain.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_send_user_write_response#

sl_status_t sl_bt_gatt_server_send_user_write_response (uint8_t connection, uint16_t characteristic, uint8_t att_errorcode)

Send a response to a sl_bt_evt_gatt_server_user_write_request event when parameter att_opcode in the event is sl_bt_gatt_write_request or sl_bt_gatt_execute_write_request (see sl_bt_gatt_att_opcode_t). The response needs to be sent within 30 seconds, otherwise no more GATT transactions are allowed by the remote side. When responding to sl_bt_gatt_execute_write_request, the value of parameter characteristic is ignored. If attr_errorcode is set to 0, the ATT protocol's write response is sent to indicate to the remote GATT client that the write operation was processed successfully. Other values will cause the local GATT server to send an ATT protocol error response.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_send_notification#

sl_status_t sl_bt_gatt_server_send_notification (uint8_t connection, uint16_t characteristic, size_t value_len, const uint8_t * value)

Send a notification to a remote GATT client. At most, ATT_MTU - 3 number of bytes can be sent in a notification. An error SL_STATUS_COMMAND_TOO_LONG is returned if the value length exceeds ATT_MTU - 3.

A notification is sent only if the client has enabled it by setting the corresponding flag to the Client Characteristic Configuration descriptor. The error SL_STATUS_INVALID_PARAMETER is returned if the characteristic does not have the notification property. The error SL_STATUS_INVALID_STATE is returned if the client has not enabled the notification.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_send_indication#

sl_status_t sl_bt_gatt_server_send_indication (uint8_t connection, uint16_t characteristic, size_t value_len, const uint8_t * value)

Send an indication to a remote GATT client. At most, ATT_MTU - 3 number of bytes can be sent in an indication. An error SL_STATUS_COMMAND_TOO_LONG is returned if the value length exceeds ATT_MTU - 3.

An indication is sent only if the client has enabled it by setting the corresponding flag to the Client Characteristic Configuration descriptor. The error SL_STATUS_INVALID_PARAMETER is returned if the characteristic does not have the indication property. The error SL_STATUS_INVALID_STATE is returned if the client has not enabled the indication.

A new indication to a GATT client can't be sent until an outstanding indication procedure with the same client has completed. The procedure is completed when a confirmation from the client is received. The confirmation is indicated by sl_bt_evt_gatt_server_characteristic_status.

The error SL_STATUS_IN_PROGRESS is returned if an indication procedure with the same client is outstanding. Always wait for confirmation for previous indication before sending a new indication.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

Events

• sl_bt_evt_gatt_server_characteristic_status - This event is triggered after the confirmation from the client is received.

• sl_bt_evt_gatt_server_indication_timeout - This event indicates confirmation from the remote GATT client has not been received within 30 seconds after an indication was sent. Further GATT transactions over this connection are not allowed by the stack.

sl_bt_gatt_server_notify_all#

sl_status_t sl_bt_gatt_server_notify_all (uint16_t characteristic, size_t value_len, const uint8_t * value)

Send notifications or indications to all connected remote GATT clients. At most, ATT_MTU - 3 number of bytes can be sent in a notification or indication. If the value length exceeds the limit on a connection, the first ATT_MTU - 3 bytes will be sent and rest of data is ignored.

A notification or indication is sent only if the client has enabled it by setting the corresponding flag to the Client Characteristic Configuration descriptor. If the Client Characteristic Configuration descriptor supports both notifications and indications, the stack will always send a notification even when the client has enabled both. This command will not return an error if some clients fail to be notified. Iterate sl_bt_gatt_server_send_notification or sl_bt_gatt_server_send_indication on each connection if the application needs to check that the notification or indication was sent to each client.

A new indication to a GATT client can't be sent until an outstanding indication procedure with the same client has completed, and the operation will continue for the next client. The procedure is completed when a confirmation from the client is received. The confirmation is indicated by sl_bt_evt_gatt_server_characteristic_status.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_read_client_configuration#

sl_status_t sl_bt_gatt_server_read_client_configuration (uint8_t connection, uint16_t characteristic, uint16_t * client_config_flags)

Read client characteristic configuration of a remote GATT client.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_send_user_prepare_write_response#

sl_status_t sl_bt_gatt_server_send_user_prepare_write_response (uint8_t connection, uint16_t characteristic, uint8_t att_errorcode, uint16_t offset, size_t value_len, const uint8_t * value)

Send a response to a sl_bt_evt_gatt_server_user_write_request event when parameter att_opcode in the event is sl_bt_gatt_prepare_write_request (see sl_bt_gatt_att_opcode_t). The response needs to be sent within 30 seconds, otherwise no more GATT transactions are allowed by the remote side. If att_errorcode is set to 0, the ATT protocol's prepare write response is sent to indicate to the remote GATT client that the write operation was processed successfully. Other values will cause the local GATT server to send an ATT protocol error response. The application should set values of parameters offset and value to identical values from the sl_bt_evt_gatt_server_user_write_request event. The values will be verified on the client side in case the request is a reliable write (by Bluetooth Core Specification Volume 3, Part G, 4.9.5).

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_set_capabilities#

sl_status_t sl_bt_gatt_server_set_capabilities (uint32_t caps, uint32_t reserved)

Reset capabilities that should be enabled by the GATT database. A service is visible to remote GATT clients if at least one of its capabilities is enabled. The same applies to a characteristic and its attributes. Capability identifiers and their corresponding bit flag values are in the auto-generated database header file. See UG118: Blue Gecko Bluetooth Profile Toolkit Developer's Guide for how to declare capabilities in the GATT database.

Changing the capabilities of a database effectively causes a database change (attributes being added or removed) from a remote GATT client point of view. If the database has a Generic Attribute service and Service Changed characteristic, the stack will monitor the local database change status and manage service changed indications for a GATT client that has enabled the indication configuration of the Service Changed characteristic.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_enable_capabilities#

sl_status_t sl_bt_gatt_server_enable_capabilities (uint32_t caps)

Enable additional capabilities in the local GATT database. Already enabled capabilities keep unchanged after this command. See sl_bt_gatt_server_set_capabilities for more information.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_disable_capabilities#

sl_status_t sl_bt_gatt_server_disable_capabilities (uint32_t caps)

Disable the given capabilities in the local GATT database. See sl_bt_gatt_server_set_capabilities for more information.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_get_enabled_capabilities#

sl_status_t sl_bt_gatt_server_get_enabled_capabilities (uint32_t * caps)

Get capabilities currently enabled in the local GATT database.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_gatt_server_read_client_supported_features#

sl_status_t sl_bt_gatt_server_read_client_supported_features (uint8_t connection, uint8_t * client_features)

Read client supported features of a remote GATT client.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_bt_cmd_gatt_server_set_max_mtu_id#

#define sl_bt_cmd_gatt_server_set_max_mtu_id

0x0a0a0020

sl_bt_cmd_gatt_server_get_mtu_id#

#define sl_bt_cmd_gatt_server_get_mtu_id

0x0b0a0020

sl_bt_cmd_gatt_server_find_attribute_id#

#define sl_bt_cmd_gatt_server_find_attribute_id

0x060a0020

sl_bt_cmd_gatt_server_find_primary_service_id#

#define sl_bt_cmd_gatt_server_find_primary_service_id

0x090a0020

sl_bt_cmd_gatt_server_read_attribute_value_id#

#define sl_bt_cmd_gatt_server_read_attribute_value_id

0x000a0020

sl_bt_cmd_gatt_server_read_attribute_type_id#

#define sl_bt_cmd_gatt_server_read_attribute_type_id

0x010a0020

sl_bt_cmd_gatt_server_read_attribute_properties_id#

#define sl_bt_cmd_gatt_server_read_attribute_properties_id

0x050a0020

sl_bt_cmd_gatt_server_write_attribute_value_id#

#define sl_bt_cmd_gatt_server_write_attribute_value_id

0x020a0020

sl_bt_cmd_gatt_server_send_user_read_response_id#

#define sl_bt_cmd_gatt_server_send_user_read_response_id

0x030a0020

sl_bt_cmd_gatt_server_send_user_write_response_id#

#define sl_bt_cmd_gatt_server_send_user_write_response_id

0x040a0020

sl_bt_cmd_gatt_server_send_notification_id#

#define sl_bt_cmd_gatt_server_send_notification_id

0x0f0a0020

sl_bt_cmd_gatt_server_send_indication_id#

#define sl_bt_cmd_gatt_server_send_indication_id

0x100a0020

sl_bt_cmd_gatt_server_notify_all_id#

#define sl_bt_cmd_gatt_server_notify_all_id

0x110a0020

sl_bt_cmd_gatt_server_read_client_configuration_id#

#define sl_bt_cmd_gatt_server_read_client_configuration_id

0x120a0020

sl_bt_cmd_gatt_server_send_user_prepare_write_response_id#

#define sl_bt_cmd_gatt_server_send_user_prepare_write_response_id

0x140a0020

sl_bt_cmd_gatt_server_set_capabilities_id#

#define sl_bt_cmd_gatt_server_set_capabilities_id

0x080a0020

sl_bt_cmd_gatt_server_enable_capabilities_id#

#define sl_bt_cmd_gatt_server_enable_capabilities_id

0x0c0a0020

sl_bt_cmd_gatt_server_disable_capabilities_id#

#define sl_bt_cmd_gatt_server_disable_capabilities_id

0x0d0a0020

sl_bt_cmd_gatt_server_get_enabled_capabilities_id#

#define sl_bt_cmd_gatt_server_get_enabled_capabilities_id

0x0e0a0020

sl_bt_cmd_gatt_server_read_client_supported_features_id#

#define sl_bt_cmd_gatt_server_read_client_supported_features_id

0x150a0020

sl_bt_rsp_gatt_server_set_max_mtu_id#

#define sl_bt_rsp_gatt_server_set_max_mtu_id

0x0a0a0020

sl_bt_rsp_gatt_server_get_mtu_id#

#define sl_bt_rsp_gatt_server_get_mtu_id

0x0b0a0020

sl_bt_rsp_gatt_server_find_attribute_id#

#define sl_bt_rsp_gatt_server_find_attribute_id

0x060a0020

sl_bt_rsp_gatt_server_find_primary_service_id#

#define sl_bt_rsp_gatt_server_find_primary_service_id

0x090a0020

sl_bt_rsp_gatt_server_read_attribute_value_id#

#define sl_bt_rsp_gatt_server_read_attribute_value_id

0x000a0020

sl_bt_rsp_gatt_server_read_attribute_type_id#

#define sl_bt_rsp_gatt_server_read_attribute_type_id

0x010a0020

sl_bt_rsp_gatt_server_read_attribute_properties_id#

#define sl_bt_rsp_gatt_server_read_attribute_properties_id

0x050a0020

sl_bt_rsp_gatt_server_write_attribute_value_id#

#define sl_bt_rsp_gatt_server_write_attribute_value_id

0x020a0020

sl_bt_rsp_gatt_server_send_user_read_response_id#

#define sl_bt_rsp_gatt_server_send_user_read_response_id

0x030a0020

sl_bt_rsp_gatt_server_send_user_write_response_id#

#define sl_bt_rsp_gatt_server_send_user_write_response_id

0x040a0020

sl_bt_rsp_gatt_server_send_notification_id#

#define sl_bt_rsp_gatt_server_send_notification_id

0x0f0a0020

sl_bt_rsp_gatt_server_send_indication_id#

#define sl_bt_rsp_gatt_server_send_indication_id

0x100a0020

sl_bt_rsp_gatt_server_notify_all_id#

#define sl_bt_rsp_gatt_server_notify_all_id

0x110a0020

sl_bt_rsp_gatt_server_read_client_configuration_id#

#define sl_bt_rsp_gatt_server_read_client_configuration_id

0x120a0020

sl_bt_rsp_gatt_server_send_user_prepare_write_response_id#

#define sl_bt_rsp_gatt_server_send_user_prepare_write_response_id

0x140a0020

sl_bt_rsp_gatt_server_set_capabilities_id#

#define sl_bt_rsp_gatt_server_set_capabilities_id

0x080a0020

sl_bt_rsp_gatt_server_enable_capabilities_id#

#define sl_bt_rsp_gatt_server_enable_capabilities_id

0x0c0a0020

sl_bt_rsp_gatt_server_disable_capabilities_id#

#define sl_bt_rsp_gatt_server_disable_capabilities_id

0x0d0a0020

sl_bt_rsp_gatt_server_get_enabled_capabilities_id#

#define sl_bt_rsp_gatt_server_get_enabled_capabilities_id

0x0e0a0020

sl_bt_rsp_gatt_server_read_client_supported_features_id#

#define sl_bt_rsp_gatt_server_read_client_supported_features_id

0x150a0020