GATT server API

Functions
at_ble_status_t	at_ble_characteristic_value_get (at_ble_handle_t handle, uint8_t *value, uint16_t *actual_read_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. More...
at_ble_status_t	at_ble_notification_send (at_ble_handle_t conn_handle, at_ble_handle_t attr_handle)
	Sends a Notification. 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 *characteristic_list, uint16_t characteristic_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, bool update_value, uint8_t *value, uint16_t offset, uint16_t len)
	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 *characteristic_list, uint16_t characteristic_count)
	Defines a new Secondary service along with its included services and characteristics. More...
at_ble_status_t	at_ble_service_changed_notification_send (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle)
	Sends a Service changed Notification. More...
at_ble_status_t	at_ble_write_authorize_reply (at_ble_handle_t conn_handle, at_ble_handle_t attr_handle, bool grant_authorization)
	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 *	actual_read_len
	)

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

Referenced by csc_serv_send_data(), fmp_target_connected_state_handler(), hid_boot_keyboardreport_update(), hid_boot_mousereport_update(), pxp_reporter_connected_state_handler(), trans_update_ctrl_char_value(), and wifiscan_print_char().

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

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_INVALID_HANDLE Invalid handle

AT_BLE_FAILURE Generic error

Referenced by bat_update_char_value(), blp_sensor_send_indication(), blp_sensor_send_notification(), csc_serv_send_data(), dis_info_update(), eddystone_set_beacon_interval(), eddystone_set_encoded_url(), eddystone_set_power_mode(), esurl_conf_chars_reset(), esurl_write_authorize_event(), heart_rate_update_char_value(), hid_boot_keyboardreport_update(), hid_boot_mousereport_update(), hid_serv_report_update(), hr_sensor_send_notification(), sps_scan_refresh_char_update(), trans_update_ctrl_char_value(), trans_update_tx_char_value(), wifi_provision_svc_changed_handler(), wificon_char_change_apparam(), wificon_char_change_state_client_cfg(), wificon_connect_noti(), wifiscan_char_change_scanmode(), wifiscan_scanlist_receive(), and wifiscan_update_scanmode_char_value().

at_ble_status_t at_ble_indication_send	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	attr_handle
	)

Sends an Indication.

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

Referenced by blp_sensor_send_indication().

at_ble_status_t at_ble_notification_send	(	at_ble_handle_t	conn_handle,
		at_ble_handle_t	attr_handle
	)

Sends a Notification.

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

Referenced by bat_update_char_value(), ble_trans_char_changed_event(), blp_sensor_send_notification(), csc_serv_send_data(), heart_rate_update_char_value(), hid_boot_keyboardreport_update(), hid_boot_mousereport_update(), hid_serv_report_update(), hr_sensor_send_notification(), sps_scan_refresh_char_update(), trans_update_ctrl_char_value(), trans_update_tx_char_value(), wificon_connect_noti(), wifiscan_scanlist_receive(), and wifiscan_update_scanmode_char_value().

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 *	characteristic_list,
		uint16_t	characteristic_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]	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

Referenced by bat_primary_service_define(), blp_primary_service_define(), csc_serv_init(), dis_primary_service_define(), esurl_conf_service_init(), heart_rate_primary_service_define(), hr_primary_service_define(), ias_primary_service_define(), lls_primary_service_define(), sps_primary_service_define(), trans_service_primary_service_define(), txps_primary_service_define(), wificon_primary_service_define(), and wifiscan_primary_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,
		bool	update_value,
		uint8_t *	value,
		uint16_t	offset,
		uint16_t	len
	)

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
[in]	update_value	If True, the value, offset, length of parameters will be used to update this attribute value
[in]	value	New value
[in]	offset	Where the writing starts
[in]	len	Value length, in bytes

Warning

Not Supported

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

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 *	characteristic_list,
		uint16_t	characteristic_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]	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

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

Sends a Service changed Notification.

Parameters

[in]	conn_handle	Handle of the connection to which the notification will be sent
[in]	start_handle	Start of affected handle range
[in]	end_handle	End of affected handle range

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

References AT_BLE_INVALID_PARAM, and gattc_svc_changed_notification_cmd_handler().

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

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

Parameters

[in]	conn_handle	Handle of the connection
[in]	attr_handle	Handle of the attribute to write
[in]	grant_authorization	If True, Authorization is granted

Warning

Not Supported

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

Referenced by esurl_write_authorize_event(), and hr_sensor_char_write_request().