Functions

Discovers information about a range of attributes on a GATT server.

Events generated

BLE_GATTC_EVT_ATTR_INFO_DISC_RSP

Generated when information about a range of attributes has been received.

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_handle_range	The range of handles to request information about.

Return values

NRF_SUCCESS	Successfully started an attribute information discovery procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid connection handle.
NRF_ERROR_INVALID_STATE	Invalid connection state
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Initiate or continue a GATT Read using Characteristic UUID procedure.

This function initiates or resumes a Read using Characteristic UUID procedure. If the last Characteristic has not been reached, this must be called again with an updated handle range to continue the discovery.

Events generated

BLE_GATTC_EVT_DESC_DISC_RSP

Relevant Message Sequence Charts

GATTC Read Characteristic Value by UUID

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_uuid	Pointer to a Characteristic value UUID to read.
[in]	p_handle_range	A pointer to the range of handles to perform this procedure on.

Return values

NRF_SUCCESS	Successfully started or resumed the Read using Characteristic UUID procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Initiate a GATT Read Multiple Characteristic Values procedure.

This function initiates a GATT Read Multiple Characteristic Values procedure.

Events generated

BLE_GATTC_EVT_CHAR_VALS_READ_RSP

Relevant Message Sequence Charts

GATTC Read Multiple Characteristic Values

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_handles	A pointer to the handle(s) of the attribute(s) to be read.
[in]	handle_count	The number of handles in p_handles.

Return values

NRF_SUCCESS	Successfully started the Read Multiple Characteristic Values procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Initiate or continue a GATT Characteristic Discovery procedure.

This function initiates or resumes a Characteristic discovery procedure. If the last Characteristic has not been reached, this must be called again with an updated handle range to continue the discovery.

Note

If any of the discovered characteristics have 128-bit UUIDs which are not present in the table provided to ble_vs_uuids_assign, a UUID structure with type BLE_UUID_TYPE_UNKNOWN will be received in the corresponding event.

Events generated

BLE_GATTC_EVT_CHAR_DISC_RSP

Relevant Message Sequence Charts

GATTC Characteristic Discovery

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_handle_range	A pointer to the range of handles of the Service to perform this procedure on.

Return values

NRF_SUCCESS	Successfully started or resumed the Characteristic Discovery procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Initiate or continue a GATT Characteristic Descriptor Discovery procedure.

This function initiates or resumes a Characteristic Descriptor discovery procedure. If the last Descriptor has not been reached, this must be called again with an updated handle range to continue the discovery.

Events generated

BLE_GATTC_EVT_DESC_DISC_RSP

Relevant Message Sequence Charts

GATTC Descriptor Discovery

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_handle_range	A pointer to the range of handles of the Characteristic to perform this procedure on.

Return values

NRF_SUCCESS	Successfully started or resumed the Descriptor Discovery procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Send a Handle Value Confirmation to the GATT Server.

Relevant Message Sequence Charts

GATTC Handle Value Indication

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	handle	The handle of the attribute in the indication.

Return values

NRF_SUCCESS	Successfully queued the Handle Value Confirmation for transmission.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State or no Indication pending to be confirmed.
BLE_ERROR_INVALID_ATTR_HANDLE	Invalid attribute handle.

Initiate or continue a GATT Primary Service Discovery procedure.

This function initiates or resumes a Primary Service discovery procedure, starting from the supplied handle. If the last service has not been reached, this function must be called again with an updated start handle value to continue the search.

Note

If any of the discovered services have 128-bit UUIDs which are not present in the table provided to ble_vs_uuids_assign, a UUID structure with type BLE_UUID_TYPE_UNKNOWN will be received in the corresponding event.

Events generated

BLE_GATTC_EVT_PRIM_SRVC_DISC_RSP

Relevant Message Sequence Charts

GATTC Primary Service Discovery

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	start_handle	Handle to start searching from.
[in]	p_srvc_uuid	Pointer to the service UUID to be found. If it is NULL, all primary services will be returned.

Return values

NRF_SUCCESS	Successfully started or resumed the Primary Service Discovery procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Initiate or continue a GATT Read (Long) Characteristic or Descriptor procedure.

This function initiates or resumes a GATT Read (Long) Characteristic or Descriptor procedure. If the Characteristic or Descriptor to be read is longer than ATT_MTU - 1, this function must be called multiple times with appropriate offset to read the complete value.

Events generated

BLE_GATTC_EVT_CHAR_VAL_BY_UUID_READ_RSP

Relevant Message Sequence Charts

GATTC Characteristic or Descriptor Value Read

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	handle	The handle of the attribute to be read.
[in]	offset	Offset into the attribute value to be read.

Return values

NRF_SUCCESS	Successfully started or resumed the Read (Long) procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_BUSY	Client procedure already in progress.

Initiate or continue a GATT Relationship Discovery procedure.

This function initiates or resumes the Find Included Services sub-procedure. If the last included service has not been reached, this must be called again with an updated handle range to continue the search.

Events generated

BLE_GATTC_EVT_REL_DISC_RSP

Relevant Message Sequence Charts

GATTC Relationship Discovery

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_handle_range	A pointer to the range of handles of the Service to perform this procedure on.

Return values

NRF_SUCCESS	Successfully started or resumed the Relationship Discovery procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
NRF_ERROR_BUSY	Client procedure already in progress.

Perform a Write (Characteristic Value or Descriptor, with or without response, signed or not, long or reliable) procedure.

This function can perform all write procedures described in GATT.

Note

It is important to note that a write without response will consume an application buffer , and will therefore generate a BLE_EVT_TX_COMPLETE event when the packet has been transmitted. A write (with response) on the other hand will use the standard client internal buffer and thus will only generate a BLE_GATTC_EVT_WRITE_RSP event as soon as the write response has been received from the peer. Please see the documentation of sd_ble_tx_packet_count_get for more details.

Events generated

BLE_GATTC_EVT_WRITE_RSP

Generated when using write request or queued writes.

Relevant Message Sequence Charts

GATTC Characteristic or Descriptor Value Write

GATTC Characteristic or Descriptor Value Long Write

GATTC Characteristic or Descriptor Value Reliable Write

App TX Packet Management

Parameters

[in]	conn_handle	The connection handle identifying the connection to perform this procedure on.
[in]	p_write_params	A pointer to a write parameters structure.

Return values

NRF_SUCCESS	Successfully started the Write procedure.
BLE_ERROR_INVALID_CONN_HANDLE	Invalid Connection Handle.
NRF_ERROR_INVALID_STATE	Invalid Connection State.
NRF_ERROR_INVALID_ADDR	Invalid pointer supplied.
NRF_ERROR_INVALID_PARAM	Invalid parameter(s) supplied.
NRF_ERROR_DATA_SIZE	Invalid data size(s) supplied.
NRF_ERROR_BUSY	Procedure already in progress.
BLE_ERROR_NO_TX_PACKETS	No available application packets for this connection.