GATT Server APIs

This group includes all GATT Server APIs; Set value, Get value, Notify, Indicate, ...

Functions
at_ble_status_t	at_ble_characteristic_value_get (at_ble_handle_t handle, uint8_t *value, uint16_t *len)
	Reads A characteristic value. More...
at_ble_status_t	at_ble_characteristic_value_set (at_ble_handle_t handle, uint8_t *value, uint16_t len)
	Sets A characteristic value. More...
at_ble_status_t	at_ble_indication_send (at_ble_handle_t conn_handle, at_ble_handle_t attr_handle)
	Sends an Indication AT_BLE_INDICATION_CONFIRMED is received when indication has been correctly received by peer device. More...
at_ble_status_t	at_ble_notification_send (at_ble_handle_t conn_handle, at_ble_handle_t attr_handle)
	Sends a Notification AT_BLE_NOTIFICATION_CONFIRMED is received as soon as notification PDU has been sent over the air. More...
at_ble_status_t	at_ble_primary_service_define (at_ble_uuid_t *uuid, at_ble_handle_t *service_handle, at_ble_included_service_t *included_service_list, uint16_t included_service_count, at_ble_characteristic_t *charactristic_list, uint16_t charactristic_count)
	Defines a new Primary service along with its included services and characteristics. More...
at_ble_status_t	at_ble_read_authorize_reply (at_ble_handle_t conn_handle, at_ble_handle_t attr_handle, bool grant_authorization)
	Replies to a read authorization request requested by by AT_BLE_READ_AUTHORIZE_REQUEST event. More...
at_ble_status_t	at_ble_secondary_service_define (at_ble_uuid_t *uuid, at_ble_handle_t *service_handle, at_ble_included_service_t *included_service_list, uint16_t included_service_count, at_ble_characteristic_t *charactristic_list, uint16_t charactristic_count)
	Defines a new Secondary service along with its included services and characteristics. More...
at_ble_status_t	at_ble_send_service_changed_indication (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle)
	Sends a Service changed Indication. More...
at_ble_status_t	at_ble_service_define (at_ble_service_t *svc)
	Defines a new service along with its included services and characteristics. More...
at_ble_status_t	at_ble_write_authorize_reply (at_ble_characteristic_write_request_t *param, at_ble_status_t status)
	Replies to a write authorization request requested by by AT_BLE_WRITE_AUTHORIZE_REQUEST event. More...

at_ble_status_t at_ble_characteristic_value_get	(	at_ble_handle_t	handle,
		uint8_t *	value,
		uint16_t *	len
	)

Reads A characteristic value.

Parameters

[in]	handle	Characteristic value handle
[out]	value	read value will be returned here
[out]	len	desired read length, in bytes

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Reads A characteristic value.

Parameters

[in]	handle	Characteristic value handle
[out]	value	Read value will be returned here
[in]	actual_read_len	Actual read length, in bytes

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INVALID_HANDLE Invalid handle

AT_BLE_FAILURE Generic error

References at_ble_att_error(), and gattm_att_get_value_req_handler().

at_ble_status_t at_ble_characteristic_value_set	(	at_ble_handle_t	handle,
		uint8_t *	value,
		uint16_t	len
	)

Sets A characteristic value.

Parameters

[in]	handle	Characteristic value handle
[in]	value	new value
[in]	len	Value length, in bytes

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Sets A characteristic value.

Parameters

[in]	handle	Characteristic value handle
[in]	value	New value
[in]	len	Value length, in bytes

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INVALID_HANDLE Invalid handle

AT_BLE_FAILURE Generic error

References at_ble_att_error(), and gattm_att_set_value_req_handler().

at_ble_status_t at_ble_indication_send	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	attr_handle
	)

Sends an Indication AT_BLE_INDICATION_CONFIRMED is received when indication has been correctly received by peer device.

Parameters

[in]	conn_handle	handle of the connection to be notified
[in]	attr_handle	handle of the attribute originating the indication

Precondition

If the value has been updated, it is required to use at_ble_characteristic_value_set first

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Sends an Indication AT_BLE_INDICATION_CONFIRMED is received when indication has been correctly received by peer device.

Parameters

[in]	conn_handle	Handle of the connection to be notified
[in]	attr_handle	Handle of the attribute originating the indication

Precondition

If the value has been updated, it is required to use at_ble_characteristic_value_set first

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INVALID_HANDLE Invalid handle

AT_BLE_FAILURE Generic error

References GATTC_INDICATE, and gattc_send_evt_cmd_handler().

at_ble_status_t at_ble_notification_send	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	attr_handle
	)

Sends a Notification AT_BLE_NOTIFICATION_CONFIRMED is received as soon as notification PDU has been sent over the air.

Parameters

[in]	conn_handle	handle of the connection to be notified
[in]	attr_handle	handle of the attribute originating the notification

Precondition

If the value has been updated, it is required to use at_ble_characteristic_value_set first

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Sends a Notification AT_BLE_NOTIFICATION_CONFIRMED is received as soon as notification PDU has been sent over the air.

Parameters

[in]	conn_handle	Handle of the connection to be notified
[in]	attr_handle	Handle of the attribute originating the notification

Precondition

If the value has been updated, it is required to use at_ble_characteristic_value_set first

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INVALID_HANDLE Invalid handle

AT_BLE_FAILURE Generic error

References GATTC_NOTIFY, and gattc_send_evt_cmd_handler().

at_ble_status_t at_ble_primary_service_define	(	at_ble_uuid_t *	uuid,
		at_ble_handle_t *	service_handle,
		at_ble_included_service_t *	included_service_list,
		uint16_t	included_service_count,
		at_ble_characteristic_t *	charactristic_list,
		uint16_t	charactristic_count
	)

Defines a new Primary service along with its included services and characteristics.

Parameters

[in]	uuid	The primary service UUID
[out]	service_handle	the Service handle will be returned here
[in]	included_service_list	an array of included service references
[in]	included_service_count	number of elements in included_service_list
[in,out]	charactristic_list	an array of characteristics included in the service, this array is update with respective characteristics handles.
[in]	charactristic_count	number of elements in charactristic_list

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Parameters

[in]	uuid	The primary service UUID
[out]	service_handle	The Service handle will be returned here
[in]	included_service_list	An array of included service references
[in]	included_service_count	Number of elements in included_service_list
[in,out]	characteristic_list	An array of characteristics included in the service, this array is update with respective characteristics handles.
[in]	characteristic_count	Number of elements in charactristic_list

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INSUFF_RESOURCE Not enough memory to complete operation

AT_BLE_FAILURE Generic error

References at_ble_service_define().

at_ble_status_t at_ble_read_authorize_reply	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	attr_handle,
		bool	grant_authorization
	)

Replies to a read authorization request requested by by AT_BLE_READ_AUTHORIZE_REQUEST event.

Parameters

[in]	conn_handle	handle of the connection
[in]	attr_handle	handle of the attribute to read
[in]	grant_authorization	if True, Authorization is granted

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

at_ble_status_t at_ble_secondary_service_define	(	at_ble_uuid_t *	uuid,
		at_ble_handle_t *	service_handle,
		at_ble_included_service_t *	included_service_list,
		uint16_t	included_service_count,
		at_ble_characteristic_t *	charactristic_list,
		uint16_t	charactristic_count
	)

Defines a new Secondary service along with its included services and characteristics.

Parameters

[in]	uuid	The secondary service UUID
[out]	service_handle	the Service handle will be returned here
[in]	included_service_list	an array of included service references
[in]	included_service_count	number of elements in included_service_list
[in,out]	charactristic_list	an array of characteristics included in the service, this array is update with respective characteristics handles.
[in]	charactristic_count	number of elements in charactristic_list

Note

• Secondary Services are only relevant in the context of the entity that references them, It is therefore forbidden to add a secondary service declaration that is not referenced by another service later in the ATT table

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Parameters

[in]	uuid	The secondary service UUID
[out]	service_handle	The Service handle will be returned here
[in]	included_service_list	An array of included service references
[in]	included_service_count	Number of elements in included_service_list
[in,out]	characteristic_list	An array of characteristics included in the service, this array is update with respective characteristics handles.
[in]	characteristic_count	Number of elements in charactristic_list

Note

• Secondary Services are only relevant in the context of the entity that references them, It is therefore forbidden to add a secondary service declaration that is not referenced by another service later in the ATT table

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INSUFF_RESOURCE not enough memory to complete operation

AT_BLE_FAILURE Generic error

References at_ble_service_define().

at_ble_status_t at_ble_send_service_changed_indication	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	start_handle,
		at_ble_handle_t	end_handle
	)

Sends a Service changed Indication.

AT_BLE_SERVICE_CHANGED_INDICATION_SENT should be received indicating status of sending the indication

Parameters

[in]	conn_handle	handle of the connection to which the indication will be sent
[in]	start_handle	start of affected handle range
[in]	end_handle	end of affected handle range

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

at_ble_status_t at_ble_service_define

(

at_ble_service_t *

svc

)

Defines a new service along with its included services and characteristics.

Parameters

[in]

svc

The primary service complete description

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Referenced by hid_service_dbreg().

at_ble_status_t at_ble_write_authorize_reply	(	at_ble_characteristic_write_request_t *	param,
		at_ble_status_t	status
	)

Replies to a write authorization request requested by by AT_BLE_WRITE_AUTHORIZE_REQUEST event.

Parameters

[in]	param	handle at_ble_characteristic_write_request_t struct
[in]	status	AT_BLE_SUCCESS to grant write, Otherwise at_ble_status_t

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t