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)

This API initiates a command to discover the GATT profiles or services supported by a remote BLE device.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_profiles_list_resp_t    - Invoked upon successful retrieval of the profile list.
          - \ref rsi_ble_on_gatt_error_resp_t       - Invoked when an error response is received.

Note

• This is a non-blocking API, still you 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.

Note

• p_prof_list structure should be set to NULL.

Returns

• The following values are returned:

  • Zero Value - Success

  • Non-Zero Value - Failure

  • 0x4E62 - Invalid Parameters

  • 0x4D04 - BLE not connected

  • 0x4D05 - BLE Socket not available

Note

• Refer to the Status Codes section for the above error codes at wiseconnect-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)

This API initiates a command to discover the specific GATT profile/service of the connected remote BLE device.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_profile_resp_t    - Invoked upon successful retrieval of the specified profile/service.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API, still you 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.

Note

• p_profile structure should be set to NULL.

Returns

• The following values are returned:

  • Zero - Success

  • Non-Zero Value - Failure

  • 0x4E62 - Invalid Parameters

  • 0x4D04 - BLE not connected

  • 0x4D05 - BLE Socket not available

Note

• Refer to the Status Codes section for the above error codes at wiseconnect-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)

This API initiates a command to get the service characteristics of the connected remote BLE device.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_char_services_resp_t    - Invoked upon successful retrieval of the service characteristics.
          - \ref rsi_ble_on_gatt_error_resp_t       - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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.

Note

• p_char_serv_list structure should be set to NULL.

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

Note

• Refer to the Status Codes section for the above error codes at wiseconnect-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)

This API initiates a command to get the supported include services of the connected remote device.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_inc_services_resp_t    - Invoked upon successful retrieval of the supported include services.
          - \ref rsi_ble_on_gatt_error_resp_t      - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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.

Note

• p_inc_serv_list structure should be set to NULL.

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

Note

• Refer to the Status Codes section for the above error codes at wiseconnect-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)

This API initiates a command to get the characteristic value by UUID (char_uuid).

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_read_resp_t       - Invoked upon successful retrieval of a characteristic value from a specified characteristic service.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you need to wait until the callback rsi_ble_on_read_resp_t is received to initiate further attribute related transactions such as read operation on the remote device address.

• Pre-conditions:

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

Note

• p_char_val structure should be set to NULL.

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 wiseconnect-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)

This API initiates a command to get the characteristic descriptors list from the remote device.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_att_desc_resp_t   - Invoked upon successful retrieval of the characteristic descriptors list.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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.

Note

• p_att_desc structure should be set to NULL.

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 wiseconnect-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)

This API initiates a command to get the attribute for a specific handle.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_read_resp_t       - Invoked upon successful retrieval of the attribute for the specified handle.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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.

Note

• p_att_val structure should be set to NULL.

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 wiseconnect-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)

This API initiates a command to get the multiple attribute values by using multiple handles.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_read_resp_t       - Invoked upon successful retrieval of the multiple attribute values for the specified multiple handles.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API, Still you 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.

Note

• p_att_vals structure should be set to NULL.

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 wiseconnect-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)

Initiates a command to get the long attribute value using handle and offset.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_read_resp_t         – Invoked upon successful retrieval of the long attribute value.
          - \ref rsi_ble_on_gatt_error_resp_t   – Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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.

• rsi_ble_connect() API must be called before this API.

Note

• p_att_vals structure should be set to NULL.

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 wiseconnect-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)

Initiates a command to set the attribute value of the remote device.

        The result is provided through callback functions:
          - \ref rsi_ble_on_write_resp_t      – Invoked upon the attribute write action is completed.
          - \ref rsi_ble_on_gatt_error_resp_t – Invoked when an error response is received.

Note

• This is a non-blocking API. However, you need to wait until the rsi_ble_on_write_resp_t callback is received from the device to initiate further attribute-related transactions on this remote device address.

• rsi_ble_connect() API must 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 wiseconnect-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)

This API initiates a command to set the attribute value without waiting for an ACK from the remote device. This is a non-blocking API.

        If the API returns RSI_ERROR_BLE_DEV_BUF_FULL (-31) error then wait until the \ref 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 wiseconnect-status-codes.

rsi_ble_set_att_cmd_async#

int32_t rsi_ble_set_att_cmd_async (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 an RSI_ERROR_BLE_DEV_BUF_FULL (-31) error, wait until the rsi_ble_on_le_more_data_req_t event is 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 wiseconnect-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)

This API initiates a command to set the long attribute value of the remote device.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_write_resp_t      - Invoked upon the attribute write action is completed
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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 wiseconnect-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)

This API initiates a command to prepare the attribute value.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_write_resp_t      - Invoked upon successful prepare write operation.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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 wiseconnect-status-codes.

rsi_ble_execute_write#

int32_t rsi_ble_execute_write (uint8_t * dev_addr, uint8_t exe_flag)

This API initiates a command to execute the prepared attribute values.

        The discovery results are provided through callback functions:
          - \ref rsi_ble_on_write_resp_t     - Invoked upon successful execute write operation.
          - \ref rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• This is a non-blocking API. Still you 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 wiseconnect-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 wiseconnect-status-codes