Synchronous Client#

rsi_ble_get_profiles#

int32_t rsi_ble_get_profiles (uint8_t * dev_addr, uint16_t start_handle, uint16_t end_handle, rsi_ble_resp_profiles_list_t * p_prof_list)

Get the supported profiles / services of the connected remote device.

The rsi_ble_on_profiles_list_resp_t callback function will be called after the profiles list response is received. This is a non-blocking API, Still user need to wait until the callback rsi_ble_on_profiles_list_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_profile#

int32_t rsi_ble_get_profile (uint8_t * dev_addr, uuid_t profile_uuid, profile_descriptors_t * p_profile)

Get the specific profile / service of the connected remote device.

The rsi_ble_on_profile_resp_t callback function is called after the service characteristics response is received. This is a non-blocking API, Still user need to wait until the callback rsi_ble_on_profile_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_char_services#

int32_t rsi_ble_get_char_services (uint8_t * dev_addr, uint16_t start_handle, uint16_t end_handle, rsi_ble_resp_char_services_t * p_char_serv_list)

Get the service characteristic services of the connected / remote device, rsi_ble_on_char_services_resp_t callback function is called after the characteristic service response is received, this is a non-blocking API, Still user need to wait until the callback rsi_ble_on_char_services_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_inc_services#

int32_t rsi_ble_get_inc_services (uint8_t * dev_addr, uint16_t start_handle, uint16_t end_handle, rsi_ble_resp_inc_services_t * p_inc_serv_list)

Get the supported include services of the connected / remote device.

The rsi_ble_on_inc_services_resp_t callback function is called after the include service response is received. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_inc_services_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_char_value_by_uuid#

int32_t rsi_ble_get_char_value_by_uuid (uint8_t * dev_addr, uint16_t start_handle, uint16_t end_handle, uuid_t char_uuid, rsi_ble_resp_att_value_t * p_char_val)

Get the characteristic value by UUID (char_uuid).

The rsi_ble_on_read_resp_t callback function is called after the attribute value is received. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_read_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

  • If the return value is less than 0

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_att_descriptors#

int32_t rsi_ble_get_att_descriptors (uint8_t * dev_addr, uint16_t start_handle, uint16_t end_handle, rsi_ble_resp_att_descs_t * p_att_desc)

Get the characteristic descriptors list from the remote device.

The rsi_ble_on_att_desc_resp_t callback function is called after the attribute descriptors response is received. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_att_desc_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_att_value#

int32_t rsi_ble_get_att_value (uint8_t * dev_addr, uint16_t handle, rsi_ble_resp_att_value_t * p_att_val)

Get the attribute by handle.

The rsi_ble_on_read_resp_t callback function is called upon receiving the attribute value. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_read_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_multiple_att_values#

int32_t rsi_ble_get_multiple_att_values (uint8_t * dev_addr, uint8_t num_of_handlers, const uint16_t * handles, rsi_ble_resp_att_value_t * p_att_vals)

Get the multiple attribute values by using multiple handles.

The rsi_ble_on_read_resp_t callback function is called after the attribute value is received. This is a non-blocking API, Still user need to wait until the callback rsi_ble_on_read_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_get_long_att_value#

int32_t rsi_ble_get_long_att_value (uint8_t * dev_addr, uint16_t handle, uint16_t offset, rsi_ble_resp_att_value_t * p_att_vals)

Get the long attribute value by using handle and offset.

The rsi_ble_on_read_resp_t callback function is called after the attribute value is received. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_read_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_set_att_value#

int32_t rsi_ble_set_att_value (uint8_t * dev_addr, uint16_t handle, uint8_t data_len, const uint8_t * p_data)

Set the attribute value of the remote device, rsi_ble_on_write_resp_t callback function is called if the attribute set action is completed, this is a non-blocking API, Still user need to wait until the callback rsi_ble_on_write_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_set_att_cmd#

int32_t rsi_ble_set_att_cmd (uint8_t * dev_addr, uint16_t handle, uint8_t data_len, const uint8_t * p_data)

Set the attribute value without waiting for an ACK from the remote device.

This is a blocking API. If the API returns RSI_ERROR_BLE_DEV_BUF_FULL (-31) error then wait until the rsi_ble_on_le_more_data_req_t event gets received from the module.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

  • 0x4E60 - Invalid Handle range

  • 0x4E62 - Invalid Parameters

  • 0x4D04 - BLE not connected

  • 0x4D05 - BLE Socket not available

  • 0x4E65 - Invalid Attribute Length When Small Buffer Mode is Configured

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_set_long_att_value#

int32_t rsi_ble_set_long_att_value (uint8_t * dev_addr, uint16_t handle, uint16_t offset, uint8_t data_len, const uint8_t * p_data)

Set the long attribute value of the remote device.

The rsi_ble_on_write_resp_t callback function is called after the attribute set action is completed. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_write_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_prepare_write#

int32_t rsi_ble_prepare_write (uint8_t * dev_addr, uint16_t handle, uint16_t offset, uint8_t data_len, const uint8_t * p_data)

Prepare the attribute value.

The rsi_ble_on_write_resp_t callback function is called after the prepare attribute write action is completed. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_write_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_execute_write#

int32_t rsi_ble_execute_write (uint8_t * dev_addr, uint8_t exe_flag)

Execute the prepared attribute values.

The rsi_ble_on_write_resp_t callback function is called after the execute attribute write action is completed. This is a non-blocking API. Still user need to wait until the callback rsi_ble_on_write_resp_t is received from the device, to initiate further attribute related transactions on this remote device address.

• Pre-conditions: rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes .

rsi_ble_mtu_exchange_event#

int32_t rsi_ble_mtu_exchange_event (uint8_t * dev_addr, uint8_t mtu_size)

Initiates the MTU exchange request with the remote device.

This is a blocking API and will receive a callback event rsi_ble_on_mtu_event_t as the response for this API.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

  • 0x4D04 - BLE not Connected
    

  • 0x4E62 - Invalid Parameters

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes

rsi_ble_mtu_exchange_resp#

int32_t rsi_ble_mtu_exchange_resp (uint8_t * dev_addr, uint8_t mtu_size)

This function (Exchange MTU Response) is sent in reply to a received Exchange MTU Request.

• Pre-conditions:

  • rsi_ble_connect() API needs to be called before this API.

Returns

• The following values are returned:

  • 0 - Success

  • 0x4D0C - When RSI_BLE_MTU_EXCHANGE_FROM_HOST BIT is not SET.

  • 0x4D05 - BLE Socket Not Available.

  • Non-Zero Value - Failure

Note

• Refer to the Status Codes section for the above error codes at additional-status-codes