mirror of
https://github.com/bluekitchen/btstack.git
synced 2025-03-16 16:20:50 +00:00
gatt_client: update API docu
This commit is contained in:
Milanka Ringwald
parent
25b7c058c6
commit
692bf1adaa
@ -232,11 +232,13 @@ typedef struct {
|
||||
void gatt_client_init(void);
|
||||
|
||||
/**
|
||||
* @brief MTU is available after the first query has completed. If status is equal to 0, it returns the real value, otherwise the default value of 23.
|
||||
* @param con_handle
|
||||
* @param mtu
|
||||
* @brief MTU is available after the first query has completed. If status is equal to ERROR_CODE_SUCCESS, it returns the real value, otherwise the default value ATT_DEFAULT_MTU (see bluetooth.h).
|
||||
* @param con_handle
|
||||
* @param mtu
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if MTU is not exchanged and MTU auto-exchange is disabled
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
|
||||
uint8_t gatt_client_get_mtu(hci_con_handle_t con_handle, uint16_t * mtu);
|
||||
|
||||
/**
|
||||
@ -247,21 +249,25 @@ void gatt_client_mtu_enable_auto_negotiation(uint8_t enabled);
|
||||
|
||||
/**
|
||||
* @brief Sends a MTU Exchange Request, this allows for the client to exchange MTU when gatt_client_mtu_enable_auto_negotiation is disabled.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
*/
|
||||
void gatt_client_send_mtu_negotiation(btstack_packet_handler_t callback, hci_con_handle_t con_handle);
|
||||
|
||||
/**
|
||||
* @brief Returns if the GATT client is ready to receive a query. It is used with daemon.
|
||||
* @param con_handle
|
||||
* @param con_handle
|
||||
* @return is_ready_status 0 - if no GATT client for con_handle is found, or is not ready, otherwise 1
|
||||
*/
|
||||
int gatt_client_is_ready(hci_con_handle_t con_handle);
|
||||
|
||||
/**
|
||||
* @brief Discovers all primary services. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_primary_services(btstack_packet_handler_t callback, hci_con_handle_t con_handle);
|
||||
|
||||
@ -270,299 +276,396 @@ uint8_t gatt_client_discover_primary_services(btstack_packet_handler_t callback,
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param uuid16
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_primary_services_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t uuid16);
|
||||
|
||||
/**
|
||||
* @brief Discovers a specific primary service given its UUID. This service may exist multiple times. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param uuid128
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param uuid128
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_primary_services_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, const uint8_t * uuid128);
|
||||
|
||||
/**
|
||||
* @brief Finds included services within the specified service. For each found included service, an le_service_event_t with type set to GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. Information about included service type (primary/secondary) can be retrieved either by sending an ATT find information request for the returned start group handle (returning the handle and the UUID for primary or secondary service) or by comparing the service to the list of all primary services.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_find_included_services_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service);
|
||||
|
||||
/**
|
||||
* @brief Discovers all characteristics within the specified service. For each found characteristic, an le_characteristics_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_characteristics_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service);
|
||||
|
||||
/**
|
||||
* @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid16
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid16
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_characteristics_for_handle_range_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint16_t uuid16);
|
||||
|
||||
/**
|
||||
* @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid128
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid128
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_characteristics_for_handle_range_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint8_t * uuid128);
|
||||
|
||||
/**
|
||||
* @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @param uuid16
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @param uuid16
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_characteristics_for_service_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service, uint16_t uuid16);
|
||||
|
||||
/**
|
||||
* @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @param uuid128
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param service
|
||||
* @param uuid128
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_characteristics_for_service_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service, uint8_t * uuid128);
|
||||
|
||||
/**
|
||||
* @brief Discovers attribute handle and UUID of a characteristic descriptor within the specified characteristic. For each found descriptor, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic);
|
||||
|
||||
/**
|
||||
* @brief Reads the characteristic value using the characteristic's value handle. If the characteristic value is found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic);
|
||||
|
||||
/**
|
||||
* @brief Reads the characteristic value using the characteristic's value handle. If the characteristic value is found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle);
|
||||
|
||||
/**
|
||||
* @brief Reads the characteric value of all characteristics with the uuid. For each found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid16
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid16
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_value_of_characteristics_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint16_t uuid16);
|
||||
|
||||
/**
|
||||
* @brief Reads the characteric value of all characteristics with the uuid. For each found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid128
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param start_handle
|
||||
* @param end_handle
|
||||
* @param uuid128
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_value_of_characteristics_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint8_t * uuid128);
|
||||
|
||||
/**
|
||||
* @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic);
|
||||
|
||||
/**
|
||||
* @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_long_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle);
|
||||
|
||||
/**
|
||||
* @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param offset
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param offset
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_long_value_of_characteristic_using_value_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t offset);
|
||||
|
||||
/*
|
||||
* @brief Read multiple characteristic values
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param num_value_handles
|
||||
* @param value_handles list of handles
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param num_value_handles
|
||||
* @param value_handles list of handles
|
||||
*/
|
||||
uint8_t gatt_client_read_multiple_characteristic_values(btstack_packet_handler_t callback, hci_con_handle_t con_handle, int num_value_handles, uint16_t * value_handles);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed.
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready
|
||||
* BTSTACK_ACL_BUFFERS_FULL , if L2CAP cannot send, there are no free ACL slots
|
||||
* ERROR_CODE_SUCCESS , if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_value_of_characteristic_without_response(hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the authenticated characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed.
|
||||
* @note GATT_EVENT_QUERY_COMPLETE is emitted with 0 for success or ATT_ERROR_BONDING_INFORMATION_MISSING if there is no bonding information stored
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param value_handle
|
||||
* @param message_len
|
||||
* @param message is not copied, make sure memory is accessible until write is done
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param value_handle
|
||||
* @param message_len
|
||||
* @param message is not copied, make sure memory is accessible until write is done
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_signed_write_without_response(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t message_len, uint8_t * message);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param offset of value
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param offset of value
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_long_value_of_characteristic_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t offset, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes of the long characteristic value using the characteristic's value handle. It uses server response to validate that the write was correctly received. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param characteristic_value_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_reliable_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Reads the characteristic descriptor using its handle. If the characteristic descriptor is found, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor);
|
||||
|
||||
/**
|
||||
* @brief Reads the characteristic descriptor using its handle. If the characteristic descriptor is found, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle);
|
||||
|
||||
/**
|
||||
* @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_long_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor);
|
||||
|
||||
/**
|
||||
* @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_long_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle);
|
||||
|
||||
/**
|
||||
* @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param offset
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param offset
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_read_long_characteristic_descriptor_using_descriptor_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t offset);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_long_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes).
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param offset of value
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param descriptor_handle
|
||||
* @param offset of value
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
*/
|
||||
uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t offset, uint16_t length, uint8_t * data);
|
||||
|
||||
@ -576,7 +679,7 @@ uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle
|
||||
* @param characteristic
|
||||
* @param configuration GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION, GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION
|
||||
* @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found
|
||||
* GATT_CLIENT_IN_WRONG_STATE if peripheral is not ready
|
||||
* GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready
|
||||
* GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED if configuring notification, but characteristic has no notification property set
|
||||
* GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED if configuring indication, but characteristic has no indication property set
|
||||
* ERROR_CODE_SUCCESS if query is successfully registered
|
||||
@ -600,34 +703,34 @@ void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_not
|
||||
|
||||
/**
|
||||
* @brief Requests GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE that guarantees a single successful gatt_client_write_value_of_characteristic_without_response
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @returns status
|
||||
*/
|
||||
uint8_t gatt_client_request_can_write_without_response_event(btstack_packet_handler_t callback, hci_con_handle_t con_handle);
|
||||
|
||||
/**
|
||||
* @brief Transactional write. It can be called as many times as it is needed to write the characteristics within the same transaction. Call gatt_client_execute_write to commit the transaction.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param attribute_handle
|
||||
* @param offset of value
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param attribute_handle
|
||||
* @param offset of value
|
||||
* @param length of data
|
||||
* @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received
|
||||
*/
|
||||
uint8_t gatt_client_prepare_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t offset, uint16_t length, uint8_t * data);
|
||||
|
||||
/**
|
||||
* @brief Commit transactional write. GATT_EVENT_QUERY_COMPLETE is received.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
*/
|
||||
uint8_t gatt_client_execute_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle);
|
||||
|
||||
/**
|
||||
* @brief Abort transactional write. GATT_EVENT_QUERY_COMPLETE is received.
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
* @param callback
|
||||
* @param con_handle
|
||||
*/
|
||||
uint8_t gatt_client_cancel_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle);
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user