nRF5 SDK v13.0.0
Functions
GATTC Application command request encoders and command response decoders

GATTC Application command request encoders and command response decoders. More...

Functions

uint32_t ble_gattc_primary_services_discover_req_enc (uint16_t conn_handle, uint16_t start_handle, ble_uuid_t const *const p_srvc_uuid, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_primary_services_discover command request. More...
 
uint32_t ble_gattc_primary_services_discover_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_primary_services_discover command. More...
 
uint32_t ble_gattc_descriptors_discover_req_enc (uint16_t conn_handle, ble_gattc_handle_range_t const *const p_handle_range, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_descriptors_discover command request. More...
 
uint32_t ble_gattc_descriptors_discover_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_descriptors_discover command. More...
 
uint32_t ble_gattc_relationships_discover_req_enc (uint16_t conn_handle, ble_gattc_handle_range_t const *const p_handle_range, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_relationships_discover command request. More...
 
uint32_t ble_gattc_relationships_discover_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_relationships_discover command. More...
 
uint32_t ble_gattc_characteristics_discover_req_enc (uint16_t conn_handle, ble_gattc_handle_range_t const *const p_handle_range, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_characteristics_discover command request. More...
 
uint32_t ble_gattc_characteristics_discover_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_characteristics_discover command. More...
 
uint32_t ble_gattc_read_req_enc (uint16_t conn_handle, uint16_t handle, uint16_t offset, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_read command request. More...
 
uint32_t ble_gattc_read_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_read command. More...
 
uint32_t ble_gattc_char_values_read_req_enc (uint16_t conn_handle, uint16_t const *const p_handles, uint16_t handle_count, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_char_values_read command request. More...
 
uint32_t ble_gattc_char_values_read_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_char_values_read command. More...
 
uint32_t ble_gattc_write_req_enc (uint16_t conn_handle, ble_gattc_write_params_t const *const p_write_params, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_write command request. More...
 
uint32_t ble_gattc_write_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_write command. More...
 
uint32_t ble_gattc_hv_confirm_req_enc (uint16_t conn_handle, uint16_t handle, uint8_t *const p_buf, uint32_t *const p_buf_len)
 Encodes sd_ble_gattc_hv_confirm command request. More...
 
uint32_t ble_gattc_hv_confirm_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_hv_confirm command. More...
 
uint32_t ble_gattc_char_value_by_uuid_read_req_enc (uint16_t conn_handle, ble_uuid_t const *const p_uuid, ble_gattc_handle_range_t const *const p_handle_range, uint8_t *const p_buf, uint32_t *const p_buf_len)
 Encodes sd_ble_gattc_char_value_by_uuid_read command request. More...
 
uint32_t ble_gattc_char_value_by_uuid_read_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_char_value_by_uuid_read command. More...
 
uint32_t ble_gattc_attr_info_discover_req_enc (uint16_t conn_handle, ble_gattc_handle_range_t const *const p_handle_range, uint8_t *const p_buf, uint32_t *p_buf_len)
 Encodes sd_ble_gattc_attr_info_discover command request. More...
 
uint32_t ble_gattc_attr_info_discover_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_attr_info_discover command. More...
 
uint32_t ble_gattc_exchange_mtu_request_req_enc (uint16_t conn_handle, uint16_t client_rx_mtu, uint8_t *const p_buf, uint32_t *const p_buf_len)
 Encodes sd_ble_gattc_exchange_mtu_request command request. More...
 
uint32_t ble_gattc_exchange_mtu_request_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
 Decodes response to sd_ble_gattc_exchange_mtu_request command. More...
 

Detailed Description

GATTC Application command request encoders and command response decoders.

Function Documentation

uint32_t ble_gattc_attr_info_discover_req_enc ( uint16_t  conn_handle,
ble_gattc_handle_range_t const *const  p_handle_range,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_attr_info_discover command request.

See Also
ble_gattc_attr_info_discover_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_handle_rangePointer to the range of handles
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_attr_info_discover_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_attr_info_discover command.

See Also
ble_gattc_attr_info_discover_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codePointer to command response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_char_value_by_uuid_read_req_enc ( uint16_t  conn_handle,
ble_uuid_t const *const  p_uuid,
ble_gattc_handle_range_t const *const  p_handle_range,
uint8_t *const  p_buf,
uint32_t *const  p_buf_len 
)

Encodes sd_ble_gattc_char_value_by_uuid_read command request.

See Also
ble_gattc_char_value_by_uuid_read_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_uuidPointer to a characteristic value UUID to read.
[in]p_handle_rangePointer to the range of handles to perform this procedure on.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_char_value_by_uuid_read_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_char_value_by_uuid_read command.

See Also
ble_gattc_char_value_by_uuid_read_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codePointer to command response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_char_values_read_req_enc ( uint16_t  conn_handle,
uint16_t const *const  p_handles,
uint16_t  handle_count,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_char_values_read command request.

See Also
ble_gattc_char_values_read_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_handlesA pointer to the handle(s) of the attribute(s) to be read.
[in]handle_countThe number of handles in p_handles.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_char_values_read_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_char_values_read command.

See Also
ble_gattc_char_values_read_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_characteristics_discover_req_enc ( uint16_t  conn_handle,
ble_gattc_handle_range_t const *const  p_handle_range,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_characteristics_discover command request.

See Also
ble_gattc_characteristics_discover_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_handle_rangeA pointer to the range of handles of the Service to perform this procedure on.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_characteristics_discover_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_characteristics_discover command.

See Also
ble_gattc_primary_services_discover_rsp_dec for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_descriptors_discover_req_enc ( uint16_t  conn_handle,
ble_gattc_handle_range_t const *const  p_handle_range,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_descriptors_discover command request.

See Also
ble_gattc_descriptors_discover_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_handle_rangeA pointer to the range of handles of the Service to perform this procedure on.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_descriptors_discover_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_descriptors_discover command.

See Also
ble_gattc_primary_services_discover_rsp_dec for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_exchange_mtu_request_req_enc ( uint16_t  conn_handle,
uint16_t  client_rx_mtu,
uint8_t *const  p_buf,
uint32_t *const  p_buf_len 
)

Encodes sd_ble_gattc_exchange_mtu_request command request.

See Also
ble_gattc_exchange_mtu_request_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]client_rx_mtuClient MTU Size.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_exchange_mtu_request_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_exchange_mtu_request command.

See Also
ble_gattc_exchange_mtu_request_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codePointer to command response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_hv_confirm_req_enc ( uint16_t  conn_handle,
uint16_t  handle,
uint8_t *const  p_buf,
uint32_t *const  p_buf_len 
)

Encodes sd_ble_gattc_hv_confirm command request.

See Also
ble_gattc_hv_confirm_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]handleHandle of the attribute in the indication.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_hv_confirm_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_hv_confirm command.

See Also
ble_gattc_hv_confirm_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codePointer to command response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_primary_services_discover_req_enc ( uint16_t  conn_handle,
uint16_t  start_handle,
ble_uuid_t const *const  p_srvc_uuid,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_primary_services_discover command request.

See Also
ble_gattc_primary_services_discover_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]start_handleHandle to start searching from.
[in]p_srvc_uuidPointer to a ble_uuid_t which indicates the service UUID to be found. If it is NULL, all primary services will be returned.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_primary_services_discover_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_primary_services_discover command.

See Also
ble_gattc_primary_services_discover_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_read_req_enc ( uint16_t  conn_handle,
uint16_t  handle,
uint16_t  offset,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_read command request.

See Also
ble_gattc_read_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]handleThe handle of the attribute to be read.
[in]offsetOffset into the attribute value to be read.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_read_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_read command.

See Also
ble_gattc_read_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_relationships_discover_req_enc ( uint16_t  conn_handle,
ble_gattc_handle_range_t const *const  p_handle_range,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_relationships_discover command request.

See Also
ble_gattc_relationships_discover_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_handle_rangeA pointer to the range of handles of the Service to perform this procedure on.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_relationships_discover_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_relationships_discover command.

See Also
ble_gattc_relationships_discover_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.
uint32_t ble_gattc_write_req_enc ( uint16_t  conn_handle,
ble_gattc_write_params_t const *const  p_write_params,
uint8_t *const  p_buf,
uint32_t *  p_buf_len 
)

Encodes sd_ble_gattc_write command request.

See Also
ble_gattc_write_rsp_dec for command response decoder.
Parameters
[in]conn_handleConnection handle of the connection.
[in]p_write_paramsPointer to sd_ble_gattc_write params.
[in]p_bufPointer to buffer where encoded data command will be returned.
[in,out]p_buf_lenin: size of p_buf buffer. out: Length of encoded command packet.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
uint32_t ble_gattc_write_rsp_dec ( uint8_t const *const  p_buf,
uint32_t  packet_len,
uint32_t *const  p_result_code 
)

Decodes response to sd_ble_gattc_write command.

See Also
ble_gattc_write_req_enc for command request encoder.
Parameters
[in]p_bufPointer to beginning of command response packet.
[in]packet_lenLength (in bytes) of response packet.
[out]p_result_codeCommand response result code.
Return values
NRF_SUCCESSDecoding success.
NRF_ERROR_NULLDecoding failure. NULL pointer supplied.
NRF_ERROR_DATA_SIZEDecoding failure. Incorrect buffer length.
NRF_ERROR_INVALID_DATADecoding failure. Decoded operation code does not match expected operation code.

Documentation feedback | Developer Zone | Subscribe | Updated