This group includes all GATT Client APIs; Discover, Read, Write, ...
Functions | |
| at_ble_status_t | at_ble_characteristic_discover_all (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle) |
| Discover all Characteristics declared in a connected device. More... | |
| at_ble_status_t | at_ble_characteristic_discover_by_uuid (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle, at_ble_uuid_t *uuid) |
| Discover all Characteristics of a given UUID declared in a connected device. More... | |
| at_ble_status_t | at_ble_characteristic_read (at_ble_handle_t conn_handle, at_ble_handle_t char_handle, uint16_t offset, uint16_t length) |
| Read a characteristic given its handle. More... | |
| at_ble_status_t | at_ble_characteristic_read_by_uuid (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle, at_ble_uuid_t *uuid) |
| Read a characteristic given its UUID. More... | |
| at_ble_status_t | at_ble_characteristic_read_long (at_ble_handle_t conn_handle, at_ble_handle_t char_handle, uint16_t offset, uint16_t length) |
| Long read a characteristic given its handle. More... | |
| at_ble_status_t | at_ble_characteristic_read_multiple (at_ble_handle_t conn_handle, at_ble_char_list *char_handle_list, uint8_t char_handle_count) |
| Read a list of characteristics given their handles. More... | |
| at_ble_status_t | at_ble_characteristic_reliable_write_cancel (at_ble_handle_t conn_handle) |
| Cancels a pending prepared reliable write operation. More... | |
| at_ble_status_t | at_ble_characteristic_reliable_write_execute (at_ble_handle_t conn_handle) |
| Executes a pending prepared write operation. More... | |
| at_ble_status_t | at_ble_characteristic_reliable_write_prepare (at_ble_handle_t conn_handle, at_ble_handle_t char_handle, uint16_t offset, uint16_t length, uint8_t *data) |
| add a new prepared write request More... | |
| at_ble_status_t | at_ble_characteristic_write (at_ble_handle_t conn_handle, at_ble_handle_t char_handle, uint16_t offset, uint16_t length, uint8_t *data, bool signed_write, bool with_response) |
| Write a characteristic value in peer device and write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP event after firmware handling. More... | |
| at_ble_status_t | at_ble_descriptor_discover_all (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle) |
| Discover all Descriptors declared in a connected device. More... | |
| at_ble_status_t | at_ble_exchange_mtu (at_ble_handle_t conn_handle) |
| send the MTU exchange command to peer device More... | |
| at_ble_status_t | at_ble_included_service_discover_all (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle) |
| Discover all included services declared in a connected device. More... | |
| at_ble_status_t | at_ble_primary_service_discover_all (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle) |
| Discover all Primary services in a peer device. More... | |
| at_ble_status_t | at_ble_primary_service_discover_by_uuid (at_ble_handle_t conn_handle, at_ble_handle_t start_handle, at_ble_handle_t end_handle, at_ble_uuid_t *uuid) |
| Discover Primary service of a given UUID declared and located in a peer device. More... | |
| at_ble_status_t at_ble_characteristic_discover_all | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle | ||
| ) |
Discover all Characteristics declared in a connected device.
Search will go from start_handle to end_handle, whenever a characteristic is found AT_BLE_CHARACTERISTIC_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | handle of the connection |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
Search will go from start_handle to end_handle, whenever a characteristic is found AT_BLE_CHARACTERISTIC_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
References AT_BLE_INVALID_PARAM, GATTC_DISC_ALL_CHAR, gattc_disc_cmd_handler(), and NULL.
| at_ble_status_t at_ble_characteristic_discover_by_uuid | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle, | ||
| at_ble_uuid_t * | uuid | ||
| ) |
Discover all Characteristics of a given UUID declared in a connected device.
search will go from start_handle to end_handle, whenever a characteristic of matching UUID is found AT_BLE_CHARACTERISTIC_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | handle of the connection |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
| [in] | uuid | UUID of the characteristic to be found, with LSB byte First in UUID value member |
Search will go from start_handle to end_handle, whenever a characteristic of matching UUID is found AT_BLE_CHARACTERISTIC_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
| [in] | uuid | UUID of the characteristic to be found, with LSB byte First in UUID value member |
References AT_BLE_INVALID_PARAM, at_ble_uuid_type2len(), GATTC_DISC_BY_UUID_CHAR, gattc_disc_cmd_handler(), at_ble_uuid_t::type, and at_ble_uuid_t::uuid.
| at_ble_status_t at_ble_characteristic_read | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | char_handle, | ||
| uint16_t | offset, | ||
| uint16_t | length | ||
| ) |
Read a characteristic given its handle.
Read value will be reported via AT_BLE_CHARACTERISTIC_READ_RESPONSE event
| [in] | conn_handle | handle of the connection |
| [in] | char_handle | handle of the characteristic |
| [in] | offset | offset at where to start reading |
| [in] | length | = 0 then the response will retrieve the full length of the characteristic (read all) > 0 && < full length then the passed length will be red by == full length || > full length full length will be retrieved |
Read value will be reported via AT_BLE_CHARACTERISTIC_READ_RESPONSE event.
| [in] | conn_handle | Handle of the connection |
| [in] | char_handle | Handle of the characteristic |
| [in] | offset | Offset at where to start reading |
| [in] | length | Maximum length of data to read |
References gattc_read_cmd_handler_simple_read().
| at_ble_status_t at_ble_characteristic_read_by_uuid | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle, | ||
| at_ble_uuid_t * | uuid | ||
| ) |
Read a characteristic given its UUID.
search will go from start_handle to end_handle, whenever a descriptor with given UUID is found its value will be read and reported via AT_BLE_CHARACTERISTIC_READ_BY_UUID_RESPONSE event
| [in] | conn_handle | handle of the connection |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
| [in] | uuid | UUID of the read characteristic, with LSB byte First in UUID value member |
Search will go from start_handle to end_handle, whenever a descriptor with given UUID is found its value will be read and reported via AT_BLE_CHARACTERISTIC_READ_RESPONSE event.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
| [in] | uuid | UUID of the read characteristic, with LSB byte First in UUID value member |
References AT_BLE_INVALID_PARAM, at_ble_uuid_type2len(), gattc_read_cmd_handler_by_uuid(), at_ble_uuid_t::type, and at_ble_uuid_t::uuid.
| at_ble_status_t at_ble_characteristic_read_long | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | char_handle, | ||
| uint16_t | offset, | ||
| uint16_t | length | ||
| ) |
Long read a characteristic given its handle.
read value will be reported via AT_BLE_CHARACTERISTIC_READ_RESPONSE event
| [in] | conn_handle | handle of the connection |
| [in] | char_handle | handle of the characteristic |
| [in] | offset | offset at where to start reading |
| [in] | length | * |
| [in] | length | = 0 then the response will retrieve the full length of the characteristic (read all) > 0 && < full length then the passed length will be red by == full length || > full length full length will be retrieved (read all) |
| at_ble_status_t at_ble_characteristic_read_multiple | ( | at_ble_handle_t | conn_handle, |
| at_ble_char_list * | char_handle_list, | ||
| uint8_t | char_handle_count | ||
| ) |
Read a list of characteristics given their handles.
read values will be reported via AT_BLE_CHARACTERISTIC_READ_RESPONSE event after delivering all requested value the the user will receive AT_BLE_CHARACTERISTIC_READ_MULTIBLE_RESPONSE to indicate end of procedure
| [in] | conn_handle | handle of the connection |
| [in] | char_handle_list | list of structures of characteristic handles and their lengths |
| [in] | char_handle_count | number of characteristic handles fro more info, refer to at_ble_char_list |
| at_ble_status_t at_ble_characteristic_reliable_write_cancel | ( | at_ble_handle_t | conn_handle | ) |
Cancels a pending prepared reliable write operation.
Cancels a pending prepared reliable write operation
| [in] | conn_handle | handle of the connection |
Cancels a pending prepared reliable write operation.
Cancels a pending prepared write operation.
| [in] | conn_handle | Handle of the connection |
References gattc_execute_write_cmd_handler().
| at_ble_status_t at_ble_characteristic_reliable_write_execute | ( | at_ble_handle_t | conn_handle | ) |
Executes a pending prepared write operation.
send write Execute to peer device to Execute pending prepared write operation, write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP event.
| [in] | conn_handle | handle of the connection |
Executes a pending prepared write operation. Write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_RESPONSE event.
| [in] | conn_handle | Handle of the connection |
References gattc_execute_write_cmd_handler().
| at_ble_status_t at_ble_characteristic_reliable_write_prepare | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | char_handle, | ||
| uint16_t | offset, | ||
| uint16_t | length, | ||
| uint8_t * | data | ||
| ) |
add a new prepared write request
Adds a new request to a pending prepared write operation, or starts a new prepared write operation if none was started before
| [in] | conn_handle | handle of the connection |
| [in] | char_handle | handle of the characteristic |
| [in] | offset | offset at where to start write |
| [in] | length | length of data to write |
| [in] | data | a buffer where write data is stored |
add a new prepared write request
Adds a new request to a pending prepared write operation, or starts a new prepared write operation if none was started before.
| [in] | conn_handle | Handle of the connection |
| [in] | char_handle | Handle of the characteristic |
| [in] | offset | Offset at where to start write |
| [in] | length | Length of data to write |
| [in] | data | A buffer where write data is stored |
References GATTC_WRITE, and gattc_write_cmd_handler().
| at_ble_status_t at_ble_characteristic_write | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | char_handle, | ||
| uint16_t | offset, | ||
| uint16_t | length, | ||
| uint8_t * | data, | ||
| bool | signed_write, | ||
| bool | with_response | ||
| ) |
Write a characteristic value in peer device and write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP event after firmware handling.
In case of signed write and write without response AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP is triggered as soon as packet has been sent over the air. In case of write with response AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP is triggered if error happened or when response is received from peer device.
| [in] | conn_handle | handle of the connection |
| [in] | char_handle | handle of the characteristic |
| [in] | offset | offset at where to start write |
| [in] | length | length of data to write |
| [in] | data | a buffer where write data is stored |
| [in] | signed_write | if true, perform a signed write |
| [in] | with_response | if true, perform a write with response procedure, otherwise perform write with no response procedure |
Write a characteristic value in peer device and write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_CMD_CMP event after firmware handling.
If with_response is True, write completion will be reported via AT_BLE_CHARACTERISTIC_WRITE_RESPONSE event.
| [in] | conn_handle | Handle of the connection |
| [in] | char_handle | Handle of the characteristic |
| [in] | offset | Offset at where to start write |
| [in] | length | Length of data to write |
| [in] | data | A buffer where write data is stored |
| [in] | signed_write | If true, perform a signed write |
| [in] | with_response | If true, perform a write with response procedure, otherwise perform write with no response procedure |
References GATTC_WRITE, gattc_write_cmd_handler(), GATTC_WRITE_NO_RESPONSE, and GATTC_WRITE_SIGNED.
| at_ble_status_t at_ble_descriptor_discover_all | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle | ||
| ) |
Discover all Descriptors declared in a connected device.
Search will go from start_handle to end_handle, whenever a descriptor is found AT_BLE_DESCRIPTOR_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | handle of the connection |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
Search will go from start_handle to end_handle, whenever a descriptor is found AT_BLE_DESCRIPTOR_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
References AT_BLE_INVALID_PARAM, gattc_disc_cmd_handler(), GATTC_DISC_DESC_CHAR, and NULL.
| at_ble_status_t at_ble_exchange_mtu | ( | at_ble_handle_t | conn_handle | ) |
send the MTU exchange command to peer device
Sends the MTU Exchange command to peer device to start exchanging the MTu maximum allowed length (Octet). if the peer device changes his MTU value according to the sender's MTU. the sender will receive the indication AT_BLE_MTU_CHANGED_INDICATION with the exchanged MTU value then receive AT_BLE_MTU_CHANGED_CMD_COMPLETE . if the peer device didn't accept the MTU value AT_BLE_MTU_CHANGED_CMD_COMPLETE will be sent.
| [in] | conn_handle | handle of the connection |
send the MTU exchange command to peer device
| [in] | conn_handle | Handle of the connection |
References gattc_mtu_cmd_handler().
| at_ble_status_t at_ble_included_service_discover_all | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle | ||
| ) |
Discover all included services declared in a connected device.
Search will go from start_handle to end_handle, whenever a service is found AT_BLE_INCLUDED_SERVICE_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | handle of the connection |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
Search will go from start_handle to end_handle, whenever a service is found AT_BLE_INCLUDED_SERVICE_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
References AT_BLE_INVALID_PARAM, gattc_disc_cmd_handler(), GATTC_DISC_INCLUDED_SVC, and NULL.
| at_ble_status_t at_ble_primary_service_discover_all | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle | ||
| ) |
Discover all Primary services in a peer device.
Discover all Primary services in a peer device from a specified start_handle to a specified end_handle, whenever a service is found AT_BLE_PRIMARY_SERVICE_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at the end of discover operation.
| [in] | conn_handle | handle of the connected peer |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
Discover all Primary services in a peer device.
Search will go from start_handle to end_handle, whenever a service is found AT_BLE_PRIMARY_SERVICE_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
References AT_BLE_INVALID_PARAM, GATTC_DISC_ALL_SVC, gattc_disc_cmd_handler(), and NULL.
| at_ble_status_t at_ble_primary_service_discover_by_uuid | ( | at_ble_handle_t | conn_handle, |
| at_ble_handle_t | start_handle, | ||
| at_ble_handle_t | end_handle, | ||
| at_ble_uuid_t * | uuid | ||
| ) |
Discover Primary service of a given UUID declared and located in a peer device.
Search will go from start_handle to end_handle, whenever a service of matching UUID is found AT_BLE_PRIMARY_SERVICE_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | handle of the connected peer |
| [in] | start_handle | start of the searched range |
| [in] | end_handle | end of the searched range |
| [in] | uuid | UUID of the service to be found, with LSB byte First in UUID value member |
Discover Primary service of a given UUID declared and located in a peer device.
Search will go from start_handle to end_handle, whenever a service of matching UUID is found AT_BLE_PRIMARY_SERVICE_FOUND event is sent and AT_BLE_DISCOVERY_COMPLETE is sent at end of discover operation.
| [in] | conn_handle | Handle of the connection |
| [in] | start_handle | Start of the searched range |
| [in] | end_handle | End of the searched range |
| [in] | uuid | UUID of the service to be found, with LSB byte First in UUID value member |
References AT_BLE_INVALID_PARAM, at_ble_uuid_type2len(), GATTC_DISC_BY_UUID_SVC, gattc_disc_cmd_handler(), at_ble_uuid_t::type, and at_ble_uuid_t::uuid.
1.8.5