Asynchronous Client#

rsi_ble_indicate_value_sync#

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

Indicate the local value to the remote device. This is a blocking API.

        This will not send any confirmation event to the application instead 

        send the status as success on receiving confirmation from remote side.

• 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

  • 0x4D05 - BLE socket not available

  • 0x4E60 - Invalid Handle Range

Note

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

rsi_ble_indicate_confirm#

int32_t rsi_ble_indicate_confirm (const uint8_t * dev_addr)

Send indicate confirmation to the remote device. This is a blocking 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

  • 0x4D05 - BLE socket not available

Note

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

• API is required to be called from the application when the "RSI_BLE_INDICATE_CONFIRMATION_FROM_HOST" is enabled in the opermode configurations.

rsi_ble_get_profiles_async#

int32_t rsi_ble_get_profiles_async (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 asynchronously through callback functions:

• rsi_ble_on_event_profiles_list_t - Invoked upon successful retrieval of the profile list.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received. Note

  • Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

  Note

  • The p_prof_list structure should be set to NULL for asynchronous APIs.

  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_async#

int32_t rsi_ble_get_profile_async (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 asynchronously through callback functions:

• rsi_ble_on_event_profile_by_uuid_t - Invoked upon successful retrieval of the specified profile/service.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received. Note

  • Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

  • Pre-conditions:

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

Note

• p_profile structure should be set to NULL for Asynchronous APIs.

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_async#

int32_t rsi_ble_get_char_services_async (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 asynchronously through callback functions:

• rsi_ble_on_event_read_by_inc_services_t - Invoked upon successful retrieval of the service characteristics.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received. Note

  • Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

  • Pre-conditions:

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

Note

• p_char_serv_list structure should be set to NULL for Asynchronous APIs.

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_async#

int32_t rsi_ble_get_inc_services_async (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 asynchronously through callback functions:

• rsi_ble_on_event_read_att_value_t - Invoked upon successful retrieval of the supported include services.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Note

• p_inc_serv_list structure should be set to NULL for Asynchronous APIs.

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_async#

int32_t rsi_ble_get_char_value_by_uuid_async (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 asynchronously through callback functions:

• rsi_ble_on_event_read_att_value_t - Invoked upon successful retrieval of a characteristic value from a specified characteristic service.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

• Pre-conditions:

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

Note

• The p_char_val structure should be set to NULL for Asynchronous APIs.

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_att_descriptors_async#

int32_t rsi_ble_get_att_descriptors_async (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 asynchronously through callback functions:

• rsi_ble_on_gatt_desc_val_event_t - Invoked upon successful retrieval of the characteristic descriptors list.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Note

• The p_att_desc structure should be set to NULL for Asynchronous APIs.

Returns

• The following values are returned:

  • 0 - Success

  • Non-Zero Value - Failure

  • 0x4E60 - Invalid Handle
    

  • 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_att_value_async#

int32_t rsi_ble_get_att_value_async (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 asynchronously through callback functions:

• rsi_ble_on_event_read_resp_t - Invoked upon successful retrieval of the attribute for the specified handle.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Note

• The p_att_val structure should be set to NULL for Asynchronous APIs.

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_multiple_att_values_async#

int32_t rsi_ble_get_multiple_att_values_async (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 asynchronously through callback functions:

• rsi_ble_on_event_read_resp_t - Invoked upon successful retrieval of the multiple attribute values for the specified multiple handles.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Note

• The p_att_vals structure should be set to NULL for asynchronous APIs.

Returns

• The following values are returned:

  • 0 - Success

  • 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_long_att_value_async#

int32_t rsi_ble_get_long_att_value_async (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 asynchronously through callback functions:

• rsi_ble_on_event_read_resp_t – Invoked upon successful retrieval of the long attribute value.

• rsi_ble_on_gatt_error_resp_t – Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Note

• The p_att_vals structure should be set to NULL for asynchronous APIs.

Returns

• Possible return values:

  • 0 Success

  • Non-Zero 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_set_att_value_async#

int32_t rsi_ble_set_att_value_async (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 asynchronously through callback functions:

• rsi_ble_on_event_write_resp_t – Invoked upon the attribute write action is completed.

• rsi_ble_on_gatt_error_resp_t – Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Returns

• Possible return values:

  • 0 Success

  • Non-Zero 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_prepare_write_async#

int32_t rsi_ble_prepare_write_async (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 asynchronously through callback functions:

• rsi_ble_on_event_prepare_write_resp_t - Invoked upon successful prepare write operation.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

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

Returns

• The following values are returned:

  • 0 - Success

  • 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_execute_write_async#

int32_t rsi_ble_execute_write_async (uint8_t * dev_addr, uint8_t exe_flag)

This API initiates a command to execute the prepared attribute values. The discovery results are provided asynchronously through callback functions:

• rsi_ble_on_event_write_resp_t - Invoked upon successful execute write operation.

• rsi_ble_on_gatt_error_resp_t - Invoked when an error response is received.

Note

• Although the results are delivered asynchronously via callbacks, this API is blocking. It waits for the command response before returning control to the application.

• 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

  • 0x4D05 - BLE Socket not available

Note

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