13deb3ec6SMatthias Ringwald /* 23deb3ec6SMatthias Ringwald * Copyright (C) 2014 BlueKitchen GmbH 33deb3ec6SMatthias Ringwald * 43deb3ec6SMatthias Ringwald * Redistribution and use in source and binary forms, with or without 53deb3ec6SMatthias Ringwald * modification, are permitted provided that the following conditions 63deb3ec6SMatthias Ringwald * are met: 73deb3ec6SMatthias Ringwald * 83deb3ec6SMatthias Ringwald * 1. Redistributions of source code must retain the above copyright 93deb3ec6SMatthias Ringwald * notice, this list of conditions and the following disclaimer. 103deb3ec6SMatthias Ringwald * 2. Redistributions in binary form must reproduce the above copyright 113deb3ec6SMatthias Ringwald * notice, this list of conditions and the following disclaimer in the 123deb3ec6SMatthias Ringwald * documentation and/or other materials provided with the distribution. 133deb3ec6SMatthias Ringwald * 3. Neither the name of the copyright holders nor the names of 143deb3ec6SMatthias Ringwald * contributors may be used to endorse or promote products derived 153deb3ec6SMatthias Ringwald * from this software without specific prior written permission. 163deb3ec6SMatthias Ringwald * 4. Any redistribution, use, or modification is done solely for 173deb3ec6SMatthias Ringwald * personal benefit and not for any commercial purpose or for 183deb3ec6SMatthias Ringwald * monetary gain. 193deb3ec6SMatthias Ringwald * 203deb3ec6SMatthias Ringwald * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 213deb3ec6SMatthias Ringwald * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 223deb3ec6SMatthias Ringwald * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 233deb3ec6SMatthias Ringwald * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 243deb3ec6SMatthias Ringwald * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 253deb3ec6SMatthias Ringwald * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 263deb3ec6SMatthias Ringwald * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 273deb3ec6SMatthias Ringwald * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 283deb3ec6SMatthias Ringwald * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 293deb3ec6SMatthias Ringwald * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 303deb3ec6SMatthias Ringwald * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 313deb3ec6SMatthias Ringwald * SUCH DAMAGE. 323deb3ec6SMatthias Ringwald * 333deb3ec6SMatthias Ringwald * Please inquire about commercial licensing options at 343deb3ec6SMatthias Ringwald * [email protected] 353deb3ec6SMatthias Ringwald * 363deb3ec6SMatthias Ringwald */ 373deb3ec6SMatthias Ringwald 383deb3ec6SMatthias Ringwald 393deb3ec6SMatthias Ringwald #ifndef btstack_gatt_client_h 403deb3ec6SMatthias Ringwald #define btstack_gatt_client_h 413deb3ec6SMatthias Ringwald 423deb3ec6SMatthias Ringwald #include "hci.h" 433deb3ec6SMatthias Ringwald 443deb3ec6SMatthias Ringwald #if defined __cplusplus 453deb3ec6SMatthias Ringwald extern "C" { 463deb3ec6SMatthias Ringwald #endif 473deb3ec6SMatthias Ringwald 483deb3ec6SMatthias Ringwald typedef enum { 493deb3ec6SMatthias Ringwald P_READY, 503deb3ec6SMatthias Ringwald P_W2_SEND_SERVICE_QUERY, 513deb3ec6SMatthias Ringwald P_W4_SERVICE_QUERY_RESULT, 523deb3ec6SMatthias Ringwald P_W2_SEND_SERVICE_WITH_UUID_QUERY, 533deb3ec6SMatthias Ringwald P_W4_SERVICE_WITH_UUID_RESULT, 543deb3ec6SMatthias Ringwald 553deb3ec6SMatthias Ringwald P_W2_SEND_ALL_CHARACTERISTICS_OF_SERVICE_QUERY, 563deb3ec6SMatthias Ringwald P_W4_ALL_CHARACTERISTICS_OF_SERVICE_QUERY_RESULT, 573deb3ec6SMatthias Ringwald P_W2_SEND_CHARACTERISTIC_WITH_UUID_QUERY, 583deb3ec6SMatthias Ringwald P_W4_CHARACTERISTIC_WITH_UUID_QUERY_RESULT, 593deb3ec6SMatthias Ringwald 603deb3ec6SMatthias Ringwald P_W2_SEND_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY, 613deb3ec6SMatthias Ringwald P_W4_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT, 623deb3ec6SMatthias Ringwald 633deb3ec6SMatthias Ringwald P_W2_SEND_INCLUDED_SERVICE_QUERY, 643deb3ec6SMatthias Ringwald P_W4_INCLUDED_SERVICE_QUERY_RESULT, 653deb3ec6SMatthias Ringwald P_W2_SEND_INCLUDED_SERVICE_WITH_UUID_QUERY, 663deb3ec6SMatthias Ringwald P_W4_INCLUDED_SERVICE_UUID_WITH_QUERY_RESULT, 673deb3ec6SMatthias Ringwald 683deb3ec6SMatthias Ringwald P_W2_SEND_READ_CHARACTERISTIC_VALUE_QUERY, 693deb3ec6SMatthias Ringwald P_W4_READ_CHARACTERISTIC_VALUE_RESULT, 703deb3ec6SMatthias Ringwald 713deb3ec6SMatthias Ringwald P_W2_SEND_READ_BLOB_QUERY, 723deb3ec6SMatthias Ringwald P_W4_READ_BLOB_RESULT, 733deb3ec6SMatthias Ringwald 743deb3ec6SMatthias Ringwald P_W2_SEND_READ_BY_TYPE_REQUEST, 753deb3ec6SMatthias Ringwald P_W4_READ_BY_TYPE_RESPONSE, 763deb3ec6SMatthias Ringwald 773deb3ec6SMatthias Ringwald P_W2_SEND_READ_MULTIPLE_REQUEST, 783deb3ec6SMatthias Ringwald P_W4_READ_MULTIPLE_RESPONSE, 793deb3ec6SMatthias Ringwald 803deb3ec6SMatthias Ringwald P_W2_SEND_WRITE_CHARACTERISTIC_VALUE, 813deb3ec6SMatthias Ringwald P_W4_WRITE_CHARACTERISTIC_VALUE_RESULT, 823deb3ec6SMatthias Ringwald 833deb3ec6SMatthias Ringwald P_W2_PREPARE_WRITE, 843deb3ec6SMatthias Ringwald P_W4_PREPARE_WRITE_RESULT, 853deb3ec6SMatthias Ringwald P_W2_PREPARE_RELIABLE_WRITE, 863deb3ec6SMatthias Ringwald P_W4_PREPARE_RELIABLE_WRITE_RESULT, 873deb3ec6SMatthias Ringwald 883deb3ec6SMatthias Ringwald P_W2_EXECUTE_PREPARED_WRITE, 893deb3ec6SMatthias Ringwald P_W4_EXECUTE_PREPARED_WRITE_RESULT, 903deb3ec6SMatthias Ringwald P_W2_CANCEL_PREPARED_WRITE, 913deb3ec6SMatthias Ringwald P_W4_CANCEL_PREPARED_WRITE_RESULT, 923deb3ec6SMatthias Ringwald P_W2_CANCEL_PREPARED_WRITE_DATA_MISMATCH, 933deb3ec6SMatthias Ringwald P_W4_CANCEL_PREPARED_WRITE_DATA_MISMATCH_RESULT, 943deb3ec6SMatthias Ringwald 95*abdc9fb5SMatthias Ringwald #ifdef ENABLE_GATT_FIND_INFORMATION_FOR_CCC_DISCOVERY 96*abdc9fb5SMatthias Ringwald P_W2_SEND_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 97*abdc9fb5SMatthias Ringwald P_W4_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 98*abdc9fb5SMatthias Ringwald #else 993deb3ec6SMatthias Ringwald P_W2_SEND_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 1003deb3ec6SMatthias Ringwald P_W4_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 101*abdc9fb5SMatthias Ringwald #endif 1023deb3ec6SMatthias Ringwald P_W2_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION, 1033deb3ec6SMatthias Ringwald P_W4_CLIENT_CHARACTERISTIC_CONFIGURATION_RESULT, 1043deb3ec6SMatthias Ringwald 1053deb3ec6SMatthias Ringwald P_W2_SEND_READ_CHARACTERISTIC_DESCRIPTOR_QUERY, 1063deb3ec6SMatthias Ringwald P_W4_READ_CHARACTERISTIC_DESCRIPTOR_RESULT, 1073deb3ec6SMatthias Ringwald 1083deb3ec6SMatthias Ringwald P_W2_SEND_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_QUERY, 1093deb3ec6SMatthias Ringwald P_W4_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_RESULT, 1103deb3ec6SMatthias Ringwald 1113deb3ec6SMatthias Ringwald P_W2_SEND_WRITE_CHARACTERISTIC_DESCRIPTOR, 1123deb3ec6SMatthias Ringwald P_W4_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 1133deb3ec6SMatthias Ringwald 1143deb3ec6SMatthias Ringwald // all long writes use this 1153deb3ec6SMatthias Ringwald P_W2_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR, 1163deb3ec6SMatthias Ringwald P_W4_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 1173deb3ec6SMatthias Ringwald P_W2_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR, 1183deb3ec6SMatthias Ringwald P_W4_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 1193deb3ec6SMatthias Ringwald 1203deb3ec6SMatthias Ringwald // gatt reliable write API use this (manual version of the above) 1213deb3ec6SMatthias Ringwald P_W2_PREPARE_WRITE_SINGLE, 1223deb3ec6SMatthias Ringwald P_W4_PREPARE_WRITE_SINGLE_RESULT, 1233deb3ec6SMatthias Ringwald 1243deb3ec6SMatthias Ringwald P_W4_CMAC_READY, 1253deb3ec6SMatthias Ringwald P_W4_CMAC_RESULT, 1263deb3ec6SMatthias Ringwald P_W2_SEND_SIGNED_WRITE, 1273deb3ec6SMatthias Ringwald P_W4_SEND_SINGED_WRITE_DONE, 1283deb3ec6SMatthias Ringwald } gatt_client_state_t; 1293deb3ec6SMatthias Ringwald 1303deb3ec6SMatthias Ringwald 1313deb3ec6SMatthias Ringwald typedef enum{ 1323deb3ec6SMatthias Ringwald SEND_MTU_EXCHANGE, 1333deb3ec6SMatthias Ringwald SENT_MTU_EXCHANGE, 1345cf6c434SJakob Krantz MTU_EXCHANGED, 1355cf6c434SJakob Krantz MTU_AUTO_EXCHANGE_DISABLED 1363deb3ec6SMatthias Ringwald } gatt_client_mtu_t; 1373deb3ec6SMatthias Ringwald 1383deb3ec6SMatthias Ringwald typedef struct gatt_client{ 139665d90f2SMatthias Ringwald btstack_linked_item_t item; 1403deb3ec6SMatthias Ringwald // TODO: rename gatt_client_state -> state 1413deb3ec6SMatthias Ringwald gatt_client_state_t gatt_client_state; 1423deb3ec6SMatthias Ringwald 1439c662c9bSMatthias Ringwald // user callback 1449c662c9bSMatthias Ringwald btstack_packet_handler_t callback; 1453deb3ec6SMatthias Ringwald 14647181045SMatthias Ringwald // can write without response callback 14747181045SMatthias Ringwald btstack_packet_handler_t write_without_response_callback; 14847181045SMatthias Ringwald 149fc64f94aSMatthias Ringwald hci_con_handle_t con_handle; 1503deb3ec6SMatthias Ringwald 1513deb3ec6SMatthias Ringwald uint8_t address_type; 1523deb3ec6SMatthias Ringwald bd_addr_t address; 153f4b33574SMatthias Ringwald 1543deb3ec6SMatthias Ringwald uint16_t mtu; 1553deb3ec6SMatthias Ringwald gatt_client_mtu_t mtu_state; 1563deb3ec6SMatthias Ringwald 1573deb3ec6SMatthias Ringwald uint16_t uuid16; 1583deb3ec6SMatthias Ringwald uint8_t uuid128[16]; 1593deb3ec6SMatthias Ringwald 1603deb3ec6SMatthias Ringwald uint16_t start_group_handle; 1613deb3ec6SMatthias Ringwald uint16_t end_group_handle; 1623deb3ec6SMatthias Ringwald 1633deb3ec6SMatthias Ringwald uint16_t query_start_handle; 1643deb3ec6SMatthias Ringwald uint16_t query_end_handle; 1653deb3ec6SMatthias Ringwald 1663deb3ec6SMatthias Ringwald uint8_t characteristic_properties; 1673deb3ec6SMatthias Ringwald uint16_t characteristic_start_handle; 1683deb3ec6SMatthias Ringwald 1693deb3ec6SMatthias Ringwald uint16_t attribute_handle; 1703deb3ec6SMatthias Ringwald uint16_t attribute_offset; 1713deb3ec6SMatthias Ringwald uint16_t attribute_length; 1723deb3ec6SMatthias Ringwald uint8_t* attribute_value; 1733deb3ec6SMatthias Ringwald 1743deb3ec6SMatthias Ringwald // read multiple characteristic values 1753deb3ec6SMatthias Ringwald uint16_t read_multiple_handle_count; 1763deb3ec6SMatthias Ringwald uint16_t * read_multiple_handles; 1773deb3ec6SMatthias Ringwald 1783deb3ec6SMatthias Ringwald uint16_t client_characteristic_configuration_handle; 1793deb3ec6SMatthias Ringwald uint8_t client_characteristic_configuration_value[2]; 1803deb3ec6SMatthias Ringwald 1813deb3ec6SMatthias Ringwald uint8_t filter_with_uuid; 1823deb3ec6SMatthias Ringwald uint8_t send_confirmation; 1833deb3ec6SMatthias Ringwald 1843deb3ec6SMatthias Ringwald int le_device_index; 1853deb3ec6SMatthias Ringwald uint8_t cmac[8]; 1863deb3ec6SMatthias Ringwald 187ec820d77SMatthias Ringwald btstack_timer_source_t gc_timeout; 188f4b33574SMatthias Ringwald 189f4b33574SMatthias Ringwald #ifdef ENABLE_GATT_CLIENT_PAIRING 190f4b33574SMatthias Ringwald uint8_t security_counter; 191f4b33574SMatthias Ringwald uint8_t wait_for_pairing_complete; 192f4b33574SMatthias Ringwald uint8_t pending_error_code; 193f4b33574SMatthias Ringwald #endif 194f4b33574SMatthias Ringwald 1953deb3ec6SMatthias Ringwald } gatt_client_t; 1963deb3ec6SMatthias Ringwald 1979c662c9bSMatthias Ringwald typedef struct gatt_client_notification { 198665d90f2SMatthias Ringwald btstack_linked_item_t item; 199b6e96f14SMatthias Ringwald btstack_packet_handler_t callback; 200711e6c80SMatthias Ringwald hci_con_handle_t con_handle; 2019c662c9bSMatthias Ringwald uint16_t attribute_handle; 2029c662c9bSMatthias Ringwald } gatt_client_notification_t; 2033deb3ec6SMatthias Ringwald 2043deb3ec6SMatthias Ringwald /* API_START */ 2053deb3ec6SMatthias Ringwald 206d25c33e5SMatthias Ringwald typedef struct { 2073deb3ec6SMatthias Ringwald uint16_t start_group_handle; 2083deb3ec6SMatthias Ringwald uint16_t end_group_handle; 2093deb3ec6SMatthias Ringwald uint16_t uuid16; 2103deb3ec6SMatthias Ringwald uint8_t uuid128[16]; 211d25c33e5SMatthias Ringwald } gatt_client_service_t; 2123deb3ec6SMatthias Ringwald 213d25c33e5SMatthias Ringwald typedef struct { 2143deb3ec6SMatthias Ringwald uint16_t start_handle; 2153deb3ec6SMatthias Ringwald uint16_t value_handle; 2163deb3ec6SMatthias Ringwald uint16_t end_handle; 2173deb3ec6SMatthias Ringwald uint16_t properties; 2183deb3ec6SMatthias Ringwald uint16_t uuid16; 2193deb3ec6SMatthias Ringwald uint8_t uuid128[16]; 220d25c33e5SMatthias Ringwald } gatt_client_characteristic_t; 2213deb3ec6SMatthias Ringwald 222d25c33e5SMatthias Ringwald typedef struct { 2233deb3ec6SMatthias Ringwald uint16_t handle; 2243deb3ec6SMatthias Ringwald uint16_t uuid16; 2253deb3ec6SMatthias Ringwald uint8_t uuid128[16]; 226d25c33e5SMatthias Ringwald } gatt_client_characteristic_descriptor_t; 2273deb3ec6SMatthias Ringwald 2283deb3ec6SMatthias Ringwald /** 2293deb3ec6SMatthias Ringwald * @brief Set up GATT client. 2303deb3ec6SMatthias Ringwald */ 2313deb3ec6SMatthias Ringwald void gatt_client_init(void); 2323deb3ec6SMatthias Ringwald 2333deb3ec6SMatthias Ringwald /** 234616edd56SMatthias Ringwald * @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. 2353deb3ec6SMatthias Ringwald */ 236fc64f94aSMatthias Ringwald uint8_t gatt_client_get_mtu(hci_con_handle_t con_handle, uint16_t * mtu); 2373deb3ec6SMatthias Ringwald 2383deb3ec6SMatthias Ringwald /** 239838e632cSMatthias Ringwald * @brief Sets whether a MTU Exchange Request shall be automatically send before the first attribute read request is send. Default is enable.d 2405cf6c434SJakob Krantz */ 2415cf6c434SJakob Krantz void gatt_client_mtu_enable_auto_negotiation(uint8_t enabled); 2425cf6c434SJakob Krantz 2435cf6c434SJakob Krantz /** 2445cf6c434SJakob Krantz * @brief Sends a MTU Exchange Request, this allows for the client to exchange MTU when gatt_client_mtu_enable_auto_negotiation is disabled. 2455cf6c434SJakob Krantz */ 2465cf6c434SJakob Krantz void gatt_client_send_mtu_negotiation(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 2475cf6c434SJakob Krantz 2485cf6c434SJakob Krantz /** 2493deb3ec6SMatthias Ringwald * @brief Returns if the GATT client is ready to receive a query. It is used with daemon. 2503deb3ec6SMatthias Ringwald */ 251fc64f94aSMatthias Ringwald int gatt_client_is_ready(hci_con_handle_t con_handle); 2523deb3ec6SMatthias Ringwald 2533deb3ec6SMatthias Ringwald /** 2545611a760SMatthias Ringwald * @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. 2553deb3ec6SMatthias Ringwald */ 256711e6c80SMatthias Ringwald uint8_t gatt_client_discover_primary_services(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 2573deb3ec6SMatthias Ringwald 2583deb3ec6SMatthias Ringwald /** 2595611a760SMatthias Ringwald * @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. 2603deb3ec6SMatthias Ringwald */ 261711e6c80SMatthias Ringwald uint8_t gatt_client_discover_primary_services_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t uuid16); 262711e6c80SMatthias Ringwald uint8_t gatt_client_discover_primary_services_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, const uint8_t * uuid); 2633deb3ec6SMatthias Ringwald 2643deb3ec6SMatthias Ringwald /** 2655611a760SMatthias Ringwald * @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. 2663deb3ec6SMatthias Ringwald */ 267711e6c80SMatthias Ringwald 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); 2683deb3ec6SMatthias Ringwald 2693deb3ec6SMatthias Ringwald /** 2705611a760SMatthias Ringwald * @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. 2713deb3ec6SMatthias Ringwald */ 272711e6c80SMatthias Ringwald uint8_t gatt_client_discover_characteristics_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service); 2733deb3ec6SMatthias Ringwald 2743deb3ec6SMatthias Ringwald /** 2755611a760SMatthias Ringwald * @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. 2763deb3ec6SMatthias Ringwald */ 277711e6c80SMatthias Ringwald 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); 278711e6c80SMatthias Ringwald 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 * uuid); 279711e6c80SMatthias Ringwald 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); 280711e6c80SMatthias Ringwald 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); 2813deb3ec6SMatthias Ringwald 2823deb3ec6SMatthias Ringwald /** 2835611a760SMatthias Ringwald * @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. 2843deb3ec6SMatthias Ringwald */ 285711e6c80SMatthias Ringwald uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic); 2863deb3ec6SMatthias Ringwald 2873deb3ec6SMatthias Ringwald /** 2885611a760SMatthias Ringwald * @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. 2893deb3ec6SMatthias Ringwald */ 290711e6c80SMatthias Ringwald uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic); 291711e6c80SMatthias Ringwald 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); 2923deb3ec6SMatthias Ringwald 2933deb3ec6SMatthias Ringwald /** 2945611a760SMatthias Ringwald * @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. 2953deb3ec6SMatthias Ringwald */ 296711e6c80SMatthias Ringwald 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); 297711e6c80SMatthias Ringwald 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); 2983deb3ec6SMatthias Ringwald 2993deb3ec6SMatthias Ringwald /** 3005611a760SMatthias Ringwald * @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. 3013deb3ec6SMatthias Ringwald */ 302711e6c80SMatthias Ringwald 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); 303711e6c80SMatthias Ringwald 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); 304711e6c80SMatthias Ringwald 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); 3053deb3ec6SMatthias Ringwald 3063deb3ec6SMatthias Ringwald /* 3073deb3ec6SMatthias Ringwald * @brief Read multiple characteristic values 3083deb3ec6SMatthias Ringwald * @param number handles 3093deb3ec6SMatthias Ringwald * @param list_of_handles list of handles 3103deb3ec6SMatthias Ringwald */ 311711e6c80SMatthias Ringwald 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); 3123deb3ec6SMatthias Ringwald 3133deb3ec6SMatthias Ringwald /** 3143deb3ec6SMatthias Ringwald * @brief Writes the characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed. 3153deb3ec6SMatthias Ringwald */ 316830ec672SMatthias Ringwald 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); 3173deb3ec6SMatthias Ringwald 3183deb3ec6SMatthias Ringwald /** 3193deb3ec6SMatthias Ringwald * @brief Writes the authenticated characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed. 3203deb3ec6SMatthias Ringwald */ 321711e6c80SMatthias Ringwald uint8_t gatt_client_signed_write_without_response(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t handle, uint16_t message_len, uint8_t * message); 3223deb3ec6SMatthias Ringwald 3233deb3ec6SMatthias Ringwald /** 3245611a760SMatthias Ringwald * @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 status field is set to 0. 3253deb3ec6SMatthias Ringwald */ 326711e6c80SMatthias Ringwald 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); 327711e6c80SMatthias Ringwald 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); 328711e6c80SMatthias Ringwald 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); 3293deb3ec6SMatthias Ringwald 3303deb3ec6SMatthias Ringwald /** 3315611a760SMatthias Ringwald * @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 status field is set to 0. 3323deb3ec6SMatthias Ringwald */ 333711e6c80SMatthias Ringwald 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); 3343deb3ec6SMatthias Ringwald 3353deb3ec6SMatthias Ringwald /** 3365611a760SMatthias Ringwald * @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. 3373deb3ec6SMatthias Ringwald */ 338711e6c80SMatthias Ringwald uint8_t gatt_client_read_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 339711e6c80SMatthias Ringwald 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); 3403deb3ec6SMatthias Ringwald 3413deb3ec6SMatthias Ringwald /** 3425611a760SMatthias Ringwald * @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. 3433deb3ec6SMatthias Ringwald */ 344711e6c80SMatthias Ringwald 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); 345711e6c80SMatthias Ringwald 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); 346711e6c80SMatthias Ringwald 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); 3473deb3ec6SMatthias Ringwald 3483deb3ec6SMatthias Ringwald /** 3495611a760SMatthias Ringwald * @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 status field is set to 0. 3503deb3ec6SMatthias Ringwald */ 351711e6c80SMatthias Ringwald 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); 352711e6c80SMatthias Ringwald 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); 353711e6c80SMatthias Ringwald 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); 354711e6c80SMatthias Ringwald 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); 355711e6c80SMatthias Ringwald 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); 3563deb3ec6SMatthias Ringwald 3573deb3ec6SMatthias Ringwald /** 3583deb3ec6SMatthias Ringwald * @brief Writes the client characteristic configuration of the specified characteristic. It is used to subscribe for notifications or indications of the characteristic value. For notifications or indications specify: GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION resp. GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION as configuration value. 3593deb3ec6SMatthias Ringwald */ 360711e6c80SMatthias Ringwald uint8_t gatt_client_write_client_characteristic_configuration(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic, uint16_t configuration); 3619c662c9bSMatthias Ringwald 3629c662c9bSMatthias Ringwald /** 3639c662c9bSMatthias Ringwald * @brief Register for notifications and indications of a characteristic enabled by gatt_client_write_client_characteristic_configuration 3649c662c9bSMatthias Ringwald * @param notification struct used to store registration 36586c38559SMatthias Ringwald * @param packet_handler 3669c662c9bSMatthias Ringwald * @param con_handle 3679c662c9bSMatthias Ringwald * @param characteristic 3689c662c9bSMatthias Ringwald */ 36986c38559SMatthias Ringwald void gatt_client_listen_for_characteristic_value_updates(gatt_client_notification_t * notification, btstack_packet_handler_t packet_handler, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 3703deb3ec6SMatthias Ringwald 3713deb3ec6SMatthias Ringwald /** 3721f734b5fSMatthias Ringwald * @brief Stop listening to characteristic value updates registered with gatt_client_listen_for_characteristic_value_updates 3731f734b5fSMatthias Ringwald * @param notification struct used in gatt_client_listen_for_characteristic_value_updates 3741f734b5fSMatthias Ringwald */ 3751f734b5fSMatthias Ringwald void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_notification_t * notification); 3761f734b5fSMatthias Ringwald 3771f734b5fSMatthias Ringwald /** 37847181045SMatthias Ringwald * @brief Requests GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE that guarantees a single successful gatt_client_write_value_of_characteristic_without_response 37947181045SMatthias Ringwald * @param packet_handler 38047181045SMatthias Ringwald * @param con_handle 38147181045SMatthias Ringwald * @returns status 38247181045SMatthias Ringwald */ 38347181045SMatthias Ringwald uint8_t gatt_client_request_can_write_without_response_event(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 38447181045SMatthias Ringwald 38547181045SMatthias Ringwald /** 3863deb3ec6SMatthias Ringwald * @brief -> gatt complete event 3873deb3ec6SMatthias Ringwald */ 388711e6c80SMatthias Ringwald 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); 3893deb3ec6SMatthias Ringwald 3903deb3ec6SMatthias Ringwald /** 3913deb3ec6SMatthias Ringwald * @brief -> gatt complete event 3923deb3ec6SMatthias Ringwald */ 393711e6c80SMatthias Ringwald uint8_t gatt_client_execute_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 3943deb3ec6SMatthias Ringwald 3953deb3ec6SMatthias Ringwald /** 3963deb3ec6SMatthias Ringwald * @brief -> gatt complete event 3973deb3ec6SMatthias Ringwald */ 398711e6c80SMatthias Ringwald uint8_t gatt_client_cancel_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 3993deb3ec6SMatthias Ringwald 4003deb3ec6SMatthias Ringwald /* API_END */ 4013deb3ec6SMatthias Ringwald 4026ba2ad22SMatthias Ringwald // used by generated btstack_event.c 4036ba2ad22SMatthias Ringwald 404313e337bSMatthias Ringwald void gatt_client_deserialize_service(const uint8_t *packet, int offset, gatt_client_service_t *service); 405313e337bSMatthias Ringwald void gatt_client_deserialize_characteristic(const uint8_t * packet, int offset, gatt_client_characteristic_t * characteristic); 406313e337bSMatthias Ringwald void gatt_client_deserialize_characteristic_descriptor(const uint8_t * packet, int offset, gatt_client_characteristic_descriptor_t * descriptor); 4076ba2ad22SMatthias Ringwald 4083deb3ec6SMatthias Ringwald #if defined __cplusplus 4093deb3ec6SMatthias Ringwald } 4103deb3ec6SMatthias Ringwald #endif 4113deb3ec6SMatthias Ringwald 4123deb3ec6SMatthias Ringwald #endif 413