1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * @title GATT Client 40 * 41 */ 42 43 #ifndef btstack_gatt_client_h 44 #define btstack_gatt_client_h 45 46 #include "hci.h" 47 48 // spec defines 100 ms, PTS might indicate an error if we sent after 100 ms 49 #define GATT_CLIENT_COLLISION_BACKOFF_MS 150 50 #if defined __cplusplus 51 extern "C" { 52 #endif 53 54 typedef enum { 55 P_READY, 56 P_W2_EMIT_QUERY_COMPLETE_EVENT, 57 P_W2_SEND_SERVICE_QUERY, 58 P_W4_SERVICE_QUERY_RESULT, 59 P_W2_SEND_SERVICE_WITH_UUID_QUERY, 60 P_W4_SERVICE_WITH_UUID_RESULT, 61 62 P_W2_SEND_ALL_CHARACTERISTICS_OF_SERVICE_QUERY, 63 P_W4_ALL_CHARACTERISTICS_OF_SERVICE_QUERY_RESULT, 64 P_W2_SEND_CHARACTERISTIC_WITH_UUID_QUERY, 65 P_W4_CHARACTERISTIC_WITH_UUID_QUERY_RESULT, 66 67 P_W2_SEND_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY, 68 P_W4_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT, 69 70 P_W2_SEND_INCLUDED_SERVICE_QUERY, 71 P_W4_INCLUDED_SERVICE_QUERY_RESULT, 72 P_W2_SEND_INCLUDED_SERVICE_WITH_UUID_QUERY, 73 P_W4_INCLUDED_SERVICE_UUID_WITH_QUERY_RESULT, 74 75 P_W2_SEND_READ_CHARACTERISTIC_VALUE_QUERY, 76 P_W4_READ_CHARACTERISTIC_VALUE_RESULT, 77 78 P_W2_SEND_READ_BLOB_QUERY, 79 P_W4_READ_BLOB_RESULT, 80 81 P_W2_SEND_READ_BY_TYPE_REQUEST, 82 P_W4_READ_BY_TYPE_RESPONSE, 83 84 P_W2_SEND_READ_MULTIPLE_REQUEST, 85 P_W4_READ_MULTIPLE_RESPONSE, 86 87 P_W2_SEND_READ_MULTIPLE_VARIABLE_REQUEST, 88 P_W4_READ_MULTIPLE_VARIABLE_RESPONSE, 89 90 P_W2_SEND_WRITE_CHARACTERISTIC_VALUE, 91 P_W4_WRITE_CHARACTERISTIC_VALUE_RESULT, 92 93 P_W2_PREPARE_WRITE, 94 P_W4_PREPARE_WRITE_RESULT, 95 P_W2_PREPARE_RELIABLE_WRITE, 96 P_W4_PREPARE_RELIABLE_WRITE_RESULT, 97 98 P_W2_EXECUTE_PREPARED_WRITE, 99 P_W4_EXECUTE_PREPARED_WRITE_RESULT, 100 P_W2_CANCEL_PREPARED_WRITE, 101 P_W4_CANCEL_PREPARED_WRITE_RESULT, 102 P_W2_CANCEL_PREPARED_WRITE_DATA_MISMATCH, 103 P_W4_CANCEL_PREPARED_WRITE_DATA_MISMATCH_RESULT, 104 105 #ifdef ENABLE_GATT_FIND_INFORMATION_FOR_CCC_DISCOVERY 106 P_W2_SEND_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 107 P_W4_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 108 #else 109 P_W2_SEND_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 110 P_W4_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 111 #endif 112 P_W2_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION, 113 P_W4_CLIENT_CHARACTERISTIC_CONFIGURATION_RESULT, 114 115 P_W2_SEND_READ_CHARACTERISTIC_DESCRIPTOR_QUERY, 116 P_W4_READ_CHARACTERISTIC_DESCRIPTOR_RESULT, 117 118 P_W2_SEND_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_QUERY, 119 P_W4_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_RESULT, 120 121 P_W2_SEND_WRITE_CHARACTERISTIC_DESCRIPTOR, 122 P_W4_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 123 124 // all long writes use this 125 P_W2_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR, 126 P_W4_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 127 P_W2_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR, 128 P_W4_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 129 130 // gatt reliable write API use this (manual version of the above) 131 P_W2_PREPARE_WRITE_SINGLE, 132 P_W4_PREPARE_WRITE_SINGLE_RESULT, 133 134 P_W4_IDENTITY_RESOLVING, 135 P_W4_CMAC_READY, 136 P_W4_CMAC_RESULT, 137 P_W2_SEND_SIGNED_WRITE, 138 P_W4_SEND_SIGNED_WRITE_DONE, 139 140 P_W2_SDP_QUERY, 141 P_W4_SDP_QUERY, 142 P_W2_L2CAP_CONNECT, 143 P_W4_L2CAP_CONNECTION, 144 P_W2_EMIT_CONNECTED, 145 P_L2CAP_CLOSED, 146 } gatt_client_state_t; 147 148 149 typedef enum{ 150 SEND_MTU_EXCHANGE, 151 SENT_MTU_EXCHANGE, 152 MTU_EXCHANGED, 153 MTU_AUTO_EXCHANGE_DISABLED 154 } gatt_client_mtu_t; 155 156 typedef enum { 157 GATT_CLIENT_SERVICE_DISCOVER_W2_SEND, 158 GATT_CLIENT_SERVICE_DISCOVER_W4_DONE, 159 GATT_CLIENT_SERVICE_DISCOVER_CHARACTERISTICS_W2_SEND, 160 GATT_CLIENT_SERVICE_DISCOVER_CHARACTERISTICS_W4_DONE, 161 GATT_CLIENT_SERVICE_SERVICE_CHANGED_WRITE_CCCD_W2_SEND, 162 GATT_CLIENT_SERVICE_SERVICE_CHANGED_WRITE_CCCD_W4_DONE, 163 GATT_CLIENT_SERVICE_DATABASE_HASH_READ_W2_SEND, 164 GATT_CLIENT_SERVICE_DATABASE_HASH_READ_W4_DONE, 165 GATT_CLIENT_SERVICE_DATABASE_HASH_WRITE_CCCD_W2_SEND, 166 GATT_CLIENT_SERVICE_DATABASE_HASH_WRITE_CCCD_W4_DONE, 167 GATT_CLIENT_SERVICE_DONE, 168 } gatt_client_service_state_t; 169 170 #ifdef ENABLE_GATT_OVER_EATT 171 typedef enum { 172 GATT_CLIENT_EATT_IDLE, 173 GATT_CLIENT_EATT_DISCOVER_GATT_SERVICE_W2_SEND, 174 GATT_CLIENT_EATT_DISCOVER_GATT_SERVICE_W4_DONE, 175 GATT_CLIENT_EATT_READ_SERVER_SUPPORTED_FEATURES_W2_SEND, 176 GATT_CLIENT_EATT_READ_SERVER_SUPPORTED_FEATURES_W4_DONE, 177 GATT_CLIENT_EATT_FIND_CLIENT_SUPPORTED_FEATURES_W2_SEND, 178 GATT_CLIENT_EATT_FIND_CLIENT_SUPPORTED_FEATURES_W4_DONE, 179 GATT_CLIENT_EATT_WRITE_ClIENT_SUPPORTED_FEATURES_W2_SEND, 180 GATT_CLIENT_EATT_WRITE_ClIENT_SUPPORTED_FEATURES_W4_DONE, 181 GATT_CLIENT_EATT_L2CAP_SETUP, 182 GATT_CLIENT_EATT_READY, 183 } gatt_client_eatt_state_t; 184 #endif 185 186 typedef struct gatt_client{ 187 btstack_linked_item_t item; 188 189 gatt_client_state_t state; 190 191 // user callback 192 btstack_packet_handler_t callback; 193 194 // can write without response callback 195 btstack_packet_handler_t write_without_response_callback; 196 197 // can write without response requests 198 btstack_linked_list_t write_without_response_requests; 199 200 // regular gatt query requests 201 btstack_linked_list_t query_requests; 202 203 hci_con_handle_t con_handle; 204 205 att_bearer_type_t bearer_type; 206 207 #if defined(ENABLE_GATT_OVER_CLASSIC) || defined(ENABLE_GATT_OVER_EATT) 208 uint16_t l2cap_cid; 209 bd_addr_t addr; 210 bd_addr_type_t addr_type; 211 #endif 212 213 #ifdef ENABLE_GATT_OVER_CLASSIC 214 uint16_t l2cap_psm; 215 btstack_context_callback_registration_t callback_request; 216 #endif 217 218 #ifdef ENABLE_GATT_OVER_EATT 219 gatt_client_eatt_state_t eatt_state; 220 btstack_linked_list_t eatt_clients; 221 uint8_t * eatt_storage_buffer; 222 uint16_t eatt_storage_size; 223 uint8_t eatt_num_clients; 224 uint8_t gatt_server_supported_features; 225 uint16_t gatt_client_supported_features_handle; 226 #endif 227 228 uint16_t mtu; 229 gatt_client_mtu_t mtu_state; 230 231 uint16_t uuid16; 232 uint8_t uuid128[16]; 233 234 uint16_t start_group_handle; 235 uint16_t end_group_handle; 236 237 uint16_t query_start_handle; 238 uint16_t query_end_handle; 239 240 uint8_t characteristic_properties; 241 uint16_t characteristic_start_handle; 242 243 uint16_t attribute_handle; 244 uint16_t attribute_offset; 245 uint16_t attribute_length; 246 uint8_t* attribute_value; 247 248 // read multiple characteristic values 249 uint16_t read_multiple_handle_count; 250 uint16_t * read_multiple_handles; 251 252 uint16_t client_characteristic_configuration_handle; 253 uint8_t client_characteristic_configuration_value[2]; 254 255 bool filter_with_uuid; 256 bool send_confirmation; 257 258 int le_device_index; 259 uint8_t cmac[8]; 260 261 btstack_timer_source_t gc_timeout; 262 263 uint8_t security_counter; 264 bool wait_for_authentication_complete; 265 uint8_t pending_error_code; 266 267 bool reencryption_active; 268 uint8_t reencryption_result; 269 270 gap_security_level_t security_level; 271 272 // Context 273 uint16_t service_id; 274 uint16_t connection_id; 275 276 // GATT Service Changes 277 gatt_client_service_state_t gatt_service_state; 278 uint16_t gatt_service_start_group_handle; 279 uint16_t gatt_service_end_group_handle; 280 // - Service Changed 281 uint16_t gatt_service_changed_value_handle; 282 uint16_t gatt_service_changed_cccd_handle; 283 uint16_t gatt_service_changed_end_handle; 284 // - Database Hash 285 uint16_t gatt_service_database_hash_value_handle; 286 uint16_t gatt_service_database_hash_cccd_handle; 287 uint16_t gatt_service_database_hash_end_handle; 288 289 } gatt_client_t; 290 291 typedef struct gatt_client_notification { 292 btstack_linked_item_t item; 293 btstack_packet_handler_t callback; 294 hci_con_handle_t con_handle; 295 uint16_t attribute_handle; 296 } gatt_client_notification_t; 297 298 /* API_START */ 299 300 typedef struct { 301 uint16_t start_group_handle; 302 uint16_t end_group_handle; 303 uint16_t uuid16; 304 uint8_t uuid128[16]; 305 } gatt_client_service_t; 306 307 typedef struct { 308 uint16_t start_handle; 309 uint16_t value_handle; 310 uint16_t end_handle; 311 uint16_t properties; 312 uint16_t uuid16; 313 uint8_t uuid128[16]; 314 } gatt_client_characteristic_t; 315 316 typedef struct { 317 uint16_t handle; 318 uint16_t uuid16; 319 uint8_t uuid128[16]; 320 } gatt_client_characteristic_descriptor_t; 321 322 /** 323 * @brief Set up GATT client. 324 */ 325 void gatt_client_init(void); 326 327 /** 328 * @brief Set minimum required security level for GATT Client 329 * @note The Bluetooth specification makes the GATT Server responsible to check for security. 330 * This allows an attacker to spoof an existing device with a GATT Servers, but skip the authentication part. 331 * If your application is exchanging sensitive data with a remote device, you would need to manually check 332 * the security level before sending/receive such data. 333 * With level > 0, the GATT Client triggers authentication for all GATT Requests and defers any exchange 334 * until the required security level is established. 335 * gatt_client_request_can_write_without_response_event does not trigger authentication 336 * gatt_client_request_to_write_without_response does not trigger authentication 337 * @pram level, default LEVEL_0 (no encryption required) 338 */ 339 void gatt_client_set_required_security_level(gap_security_level_t level); 340 341 /** 342 * @brief Connect to remote GATT Server over Classic (BR/EDR) Connection 343 * GATT_EVENT_CONNECTED with status and con_handle for other API functions 344 * is emitted on connection complete. 345 * @note requires ENABLE_GATT_OVER_CLASSIC. 346 * @param addr 347 * @return status 348 */ 349 uint8_t gatt_client_classic_connect(btstack_packet_handler_t callback, bd_addr_t addr); 350 351 /** 352 * @brief Disconnect o Classic (BR/EDR) connection to a remote GATT Server 353 * @note requires ENABLE_GATT_OVER_CLASSIC 354 * @param con_handle 355 * @return status 356 */ 357 uint8_t gatt_client_classic_disconnect(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 358 359 /** 360 * @brief Setup Enhanced LE Bearer with up to 5 channels on existing LE connection 361 * @param callback for GATT_EVENT_CONNECTED and GATT_EVENT_DISCONNECTED events 362 * @param con_handle 363 * @param num_channels 364 * @param storage_buffer for L2CAP connection 365 * @param storage_size - each channel requires (2 * ATT MTU) + 10 bytes 366 * @return 367 */ 368 uint8_t gatt_client_le_enhanced_connect(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint8_t num_channels, uint8_t * storage_buffer, uint16_t storage_size); 369 370 /** 371 * @brief MTU is available after the first query has completed. If status is equal to ERROR_CODE_SUCCESS, it returns the real value, 372 * otherwise the default value ATT_DEFAULT_MTU (see bluetooth.h). 373 * @param con_handle 374 * @param mtu 375 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 376 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 377 * GATT_CLIENT_IN_WRONG_STATE if MTU is not exchanged and MTU auto-exchange is disabled 378 * ERROR_CODE_SUCCESS if query is successfully registered 379 */ 380 uint8_t gatt_client_get_mtu(hci_con_handle_t con_handle, uint16_t * mtu); 381 382 /** 383 * @brief Sets whether a MTU Exchange Request shall be automatically send before the 384 * first attribute read request is send. Default is enabled. 385 * @param enabled 386 */ 387 void gatt_client_mtu_enable_auto_negotiation(uint8_t enabled); 388 389 /** 390 * @brief Sends a MTU Exchange Request, this allows for the client to exchange MTU 391 * when gatt_client_mtu_enable_auto_negotiation is disabled. 392 * @param callback 393 * @param con_handle 394 */ 395 void gatt_client_send_mtu_negotiation(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 396 397 /** 398 * @brief Returns 1 if the GATT client is ready to receive a query. It is used with daemon. 399 * @param con_handle 400 * @return is_ready_status 0 - if no GATT client for con_handle is found, or is not ready, otherwise 1 401 */ 402 int gatt_client_is_ready(hci_con_handle_t con_handle); 403 404 /** 405 * @brief Discovers all primary services. 406 * For each found service a GATT_EVENT_SERVICE_QUERY_RESULT event will be emitted. 407 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 408 * @param callback 409 * @param con_handle 410 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 411 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 412 * ERROR_CODE_SUCCESS , if query is successfully registered 413 */ 414 uint8_t gatt_client_discover_primary_services(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 415 416 /** 417 * @brief Discovers all secondary services. 418 * For each found service a GATT_EVENT_SERVICE_QUERY_RESULT event will be emitted. 419 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 420 * @param callback 421 * @param con_handle 422 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 423 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 424 * ERROR_CODE_SUCCESS , if query is successfully registered 425 */ 426 uint8_t gatt_client_discover_secondary_services(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 427 428 /** 429 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. 430 * For each found service a GATT_EVENT_SERVICE_QUERY_RESULT event will be emitted. 431 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 432 * @param callback 433 * @param con_handle 434 * @param uuid16 435 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 436 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 437 * ERROR_CODE_SUCCESS , if query is successfully registered 438 */ 439 uint8_t gatt_client_discover_primary_services_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t uuid16); 440 441 /** 442 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. 443 * For each found service a GATT_EVENT_SERVICE_QUERY_RESULT event will be emitted. 444 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 445 * @param callback 446 * @param con_handle 447 * @param uuid128 448 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 449 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 450 * ERROR_CODE_SUCCESS , if query is successfully registered 451 */ 452 uint8_t gatt_client_discover_primary_services_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, const uint8_t * uuid128); 453 454 /** 455 * @brief Finds included services within the specified service. 456 * For each found included service a GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT event will be emitted. 457 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 458 * Information about included service type (primary/secondary) can be retrieved either by sending 459 * an ATT find information request for the returned start group handle 460 * (returning the handle and the UUID for primary or secondary service) or by comparing the service 461 * to the list of all primary services. 462 * @param callback 463 * @param con_handle 464 * @param service 465 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 466 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 467 * ERROR_CODE_SUCCESS , if query is successfully registered 468 */ 469 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); 470 471 /** 472 * @brief Discovers all characteristics within the specified service. 473 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will be emited. 474 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 475 * @param callback 476 * @param con_handle 477 * @param service 478 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 479 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 480 * ERROR_CODE_SUCCESS , if query is successfully registered 481 */ 482 uint8_t gatt_client_discover_characteristics_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t * service); 483 484 /** 485 * @brief The following four functions are used to discover all characteristics within 486 * the specified service or handle range, and return those that match the given UUID. 487 * 488 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 489 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 490 * @param callback 491 * @param con_handle 492 * @param start_handle 493 * @param end_handle 494 * @param uuid16 495 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 496 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 497 * ERROR_CODE_SUCCESS , if query is successfully registered 498 */ 499 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); 500 501 /** 502 * @brief The following four functions are used to discover all characteristics within the 503 * specified service or handle range, and return those that match the given UUID. 504 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 505 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 506 * @param callback 507 * @param con_handle 508 * @param start_handle 509 * @param end_handle 510 * @param uuid128 511 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 512 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 513 * ERROR_CODE_SUCCESS , if query is successfully registered 514 */ 515 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, const uint8_t * uuid128); 516 517 /** 518 * @brief The following four functions are used to discover all characteristics within the 519 * specified service or handle range, and return those that match the given UUID. 520 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 521 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 522 * @param callback 523 * @param con_handle 524 * @param service 525 * @param uuid16 526 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 527 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 528 * ERROR_CODE_SUCCESS , if query is successfully registered 529 */ 530 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); 531 532 /** 533 * @brief The following four functions are used to discover all characteristics within the 534 * specified service or handle range, and return those that match the given UUID. 535 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 536 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 537 * @param callback 538 * @param con_handle 539 * @param service 540 * @param uuid128 541 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 542 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 543 * ERROR_CODE_SUCCESS , if query is successfully registered 544 */ 545 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, const uint8_t * uuid128); 546 547 /** 548 * @brief Discovers attribute handle and UUID of a characteristic descriptor within the specified characteristic. 549 * For each found descriptor a GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT event will be emitted. 550 * 551 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 552 * @param callback 553 * @param con_handle 554 * @param characteristic 555 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 556 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 557 * ERROR_CODE_SUCCESS , if query is successfully registered 558 */ 559 uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 560 561 /** 562 * @brief Reads the characteristic value using the characteristic's value handle. 563 * If the characteristic value is found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 564 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 565 * @param callback 566 * @param con_handle 567 * @param characteristic 568 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 569 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 570 * ERROR_CODE_SUCCESS , if query is successfully registered 571 */ 572 uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 573 574 /** 575 * @brief Reads the characteristic value using the characteristic's value handle. 576 * If the characteristic value is found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 577 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 578 * @param callback 579 * @param con_handle 580 * @param value_handle 581 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 582 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 583 * ERROR_CODE_SUCCESS , if query is successfully registered 584 */ 585 uint8_t gatt_client_read_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle); 586 587 /** 588 * @brief Reads the characteric value of all characteristics with the uuid. 589 * For each characteristic value found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 590 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 591 * @param callback 592 * @param con_handle 593 * @param start_handle 594 * @param end_handle 595 * @param uuid16 596 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 597 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 598 * ERROR_CODE_SUCCESS , if query is successfully registered 599 */ 600 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); 601 602 /** 603 * @brief Reads the characteric value of all characteristics with the uuid. 604 * For each characteristic value found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 605 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 606 * @param callback 607 * @param con_handle 608 * @param start_handle 609 * @param end_handle 610 * @param uuid128 611 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 612 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 613 * ERROR_CODE_SUCCESS , if query is successfully registered 614 */ 615 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, const uint8_t * uuid128); 616 617 /** 618 * @brief Reads the long characteristic value using the characteristic's value handle. 619 * The value will be returned in several blobs. 620 * For each blob, a GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT event with updated value offset will be emitted. 621 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 622 * @param callback 623 * @param con_handle 624 * @param characteristic 625 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 626 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 627 * ERROR_CODE_SUCCESS , if query is successfully registered 628 */ 629 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); 630 631 /** 632 * @brief Reads the long characteristic value using the characteristic's value handle. 633 * The value will be returned in several blobs. 634 * For each blob, a GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT event with updated value offset will be emitted. 635 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 636 * @param callback 637 * @param con_handle 638 * @param value_handle 639 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 640 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 641 * ERROR_CODE_SUCCESS , if query is successfully registered 642 */ 643 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 value_handle); 644 645 /** 646 * @brief Reads the long characteristic value using the characteristic's value handle. 647 * The value will be returned in several blobs. 648 * For each blob, a GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT event with updated value offset will be emitted. 649 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 650 * @param callback 651 * @param con_handle 652 * @param value_handle 653 * @param offset 654 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 655 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 656 * ERROR_CODE_SUCCESS , if query is successfully registered 657 */ 658 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 value_handle, uint16_t offset); 659 660 /* 661 * @brief Read multiple characteristic values. 662 * The all results are emitted via single GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event, 663 * followed by the GATT_EVENT_QUERY_COMPLETE event, which marks the end of read. 664 * @param callback 665 * @param con_handle 666 * @param num_value_handles 667 * @param value_handles list of handles 668 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 669 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 670 * ERROR_CODE_SUCCESS , if query is successfully registered 671 */ 672 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); 673 674 /* 675 * @brief Read multiple varaible characteristic values. Only supported over LE Enhanced Bearer 676 * The all results are emitted via single GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event, 677 * followed by the GATT_EVENT_QUERY_COMPLETE event, which marks the end of read. 678 * @param callback 679 * @param con_handle 680 * @param num_value_handles 681 * @param value_handles list of handles 682 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 683 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 684 * ERROR_CODE_SUCCESS , if query is successfully registered 685 */ 686 uint8_t gatt_client_read_multiple_variable_characteristic_values(btstack_packet_handler_t callback, hci_con_handle_t con_handle, int num_value_handles, uint16_t * value_handles); 687 688 /** 689 * @brief Writes the characteristic value using the characteristic's value handle without 690 * an acknowledgment that the write was successfully performed. 691 * @param con_handle 692 * @param value_handle 693 * @param value_length 694 * @param value is copied on success and does not need to be retained 695 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 696 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 697 * BTSTACK_ACL_BUFFERS_FULL , if L2CAP cannot send, there are no free ACL slots 698 * ERROR_CODE_SUCCESS , if query is successfully registered 699 */ 700 uint8_t gatt_client_write_value_of_characteristic_without_response(hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 701 702 /** 703 * @brief Writes the authenticated characteristic value using the characteristic's value handle 704 * without an acknowledgment that the write was successfully performed. 705 * @note GATT_EVENT_QUERY_COMPLETE is emitted with ATT_ERROR_SUCCESS for success, 706 * or ATT_ERROR_BONDING_INFORMATION_MISSING if there is no bonding information stored. 707 * @param callback 708 * @param con_handle 709 * @param value_handle 710 * @param message_len 711 * @param message is not copied, make sure memory is accessible until write is done 712 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 713 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 714 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 715 * ERROR_CODE_SUCCESS if query is successfully registered 716 */ 717 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); 718 719 /** 720 * @brief Writes the characteristic value using the characteristic's value handle. 721 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 722 * The write is successfully performed, if the event's att_status field is set to 723 * ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 724 * @param callback 725 * @param con_handle 726 * @param value_handle 727 * @param value_length 728 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 729 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 730 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 731 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 732 * ERROR_CODE_SUCCESS if query is successfully registered 733 */ 734 uint8_t gatt_client_write_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 735 736 /** 737 * @brief Writes the characteristic value using the characteristic's value handle. 738 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 739 * 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). 740 * @param callback 741 * @param con_handle 742 * @param value_handle 743 * @param value_length 744 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 745 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 746 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 747 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 748 * ERROR_CODE_SUCCESS if query is successfully registered 749 */ 750 uint8_t gatt_client_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 751 752 /** 753 * @brief Writes the characteristic value using the characteristic's value handle. 754 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 755 * 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). 756 * @param callback 757 * @param con_handle 758 * @param value_handle 759 * @param offset of value 760 * @param value_length 761 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 762 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 763 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 764 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 765 * ERROR_CODE_SUCCESS if query is successfully registered 766 */ 767 uint8_t gatt_client_write_long_value_of_characteristic_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t offset, uint16_t value_length, uint8_t * value); 768 769 /** 770 * @brief Writes of the long characteristic value using the characteristic's value handle. 771 * It uses server response to validate that the write was correctly received. 772 * The GATT_EVENT_QUERY_COMPLETE EVENT marks the end of write. 773 * 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). 774 * @param callback 775 * @param con_handle 776 * @param value_handle 777 * @param value_length 778 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 779 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 780 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 781 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 782 * ERROR_CODE_SUCCESS if query is successfully registered 783 */ 784 uint8_t gatt_client_reliable_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle, uint16_t value_length, uint8_t * value); 785 786 /** 787 * @brief Reads the characteristic descriptor using its handle. 788 * If the characteristic descriptor is found, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 789 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 790 * @param callback 791 * @param con_handle 792 * @param descriptor 793 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 794 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 795 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 796 * ERROR_CODE_SUCCESS if query is successfully registered 797 */ 798 uint8_t gatt_client_read_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 799 800 /** 801 * @brief Reads the characteristic descriptor using its handle. 802 * If the characteristic descriptor is found, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 803 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 804 * @param callback 805 * @param con_handle 806 * @param descriptor 807 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 808 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 809 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 810 * ERROR_CODE_SUCCESS if query is successfully registered 811 */ 812 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); 813 814 /** 815 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. 816 * For each blob, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 817 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 818 * @param callback 819 * @param con_handle 820 * @param descriptor 821 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 822 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 823 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 824 * ERROR_CODE_SUCCESS if query is successfully registered 825 */ 826 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); 827 828 /** 829 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. 830 * For each blob, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 831 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 832 * @param callback 833 * @param con_handle 834 * @param descriptor_handle 835 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 836 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 837 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 838 * ERROR_CODE_SUCCESS if query is successfully registered 839 */ 840 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); 841 842 /** 843 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. 844 * For each blob, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 845 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 846 * @param callback 847 * @param con_handle 848 * @param descriptor_handle 849 * @param offset 850 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 851 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 852 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 853 * ERROR_CODE_SUCCESS if query is successfully registered 854 */ 855 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); 856 857 /** 858 * @brief Writes the characteristic descriptor using its handle. 859 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 860 * 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). 861 * @param callback 862 * @param con_handle 863 * @param descriptor 864 * @param value_length 865 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 866 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 867 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 868 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 869 * ERROR_CODE_SUCCESS if query is successfully registered 870 */ 871 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 value_length, uint8_t * value); 872 873 /** 874 * @brief Writes the characteristic descriptor using its handle. 875 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 876 * 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). 877 * @param callback 878 * @param con_handle 879 * @param descriptor_handle 880 * @param value_length 881 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 882 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 883 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 884 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 885 * ERROR_CODE_SUCCESS if query is successfully registered 886 */ 887 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 value_length, uint8_t * value); 888 889 /** 890 * @brief Writes the characteristic descriptor using its handle. 891 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 892 * 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). 893 * @param callback 894 * @param con_handle 895 * @param descriptor 896 * @param value_length 897 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 898 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 899 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 900 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 901 * ERROR_CODE_SUCCESS if query is successfully registered 902 */ 903 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 value_length, uint8_t * value); 904 905 /** 906 * @brief Writes the characteristic descriptor using its handle. 907 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 908 * 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). 909 * @param callback 910 * @param con_handle 911 * @param descriptor_handle 912 * @param value_length 913 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 914 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 915 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 916 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 917 * ERROR_CODE_SUCCESS if query is successfully registered 918 */ 919 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 value_length, uint8_t * value); 920 921 /** 922 * @brief Writes the characteristic descriptor using its handle. 923 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 924 * 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). 925 * @param callback 926 * @param con_handle 927 * @param descriptor_handle 928 * @param offset of value 929 * @param value_length 930 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 931 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 932 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 933 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 934 * ERROR_CODE_SUCCESS if query is successfully registered 935 */ 936 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 value_length, uint8_t * value); 937 938 /** 939 * @brief Writes the client characteristic configuration of the specified characteristic. 940 * It is used to subscribe for notifications or indications of the characteristic value. 941 * For notifications or indications specify: GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION 942 * resp. GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION as configuration value. 943 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 944 * 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). 945 * @param callback 946 * @param con_handle 947 * @param characteristic 948 * @param configuration GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION, GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 949 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 950 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 951 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 952 * GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED if configuring notification, but characteristic has no notification property set 953 * GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED if configuring indication, but characteristic has no indication property set 954 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if configuration is invalid 955 * ERROR_CODE_SUCCESS if query is successfully registered 956 */ 957 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); 958 959 /** 960 * @brief Register for changes to the Service Changed and Database Hash Characteristics of the remote GATT Service 961 * * 962 * When configured, GATT_EVENT_QUERY_COMPLETE event is emitted 963 * If supported, the Database Hash is read as well 964 * 965 * Requires ENABLE_GATT_CLIENT_SERVICE_CHANGED 966 * 967 * @param callback 968 */ 969 void gatt_client_add_service_changed_handler(btstack_packet_callback_registration_t * callback); 970 971 /** 972 * @brief Remove callback for service changes 973 * 974 * Requires ENABLE_GATT_CLIENT_SERVICE_CHANGED 975 * 976 * @param callback 977 */ 978 void gatt_client_remove_service_changed_handler(btstack_packet_callback_registration_t * callback); 979 980 /** 981 * @brief Register for notifications and indications of a characteristic enabled by 982 * the gatt_client_write_client_characteristic_configuration function. 983 * @param notification struct used to store registration 984 * @param callback 985 * @param con_handle or GATT_CLIENT_ANY_CONNECTION to receive updates from all connected devices 986 * @param characteristic or NULL to receive updates for all characteristics 987 */ 988 void gatt_client_listen_for_characteristic_value_updates(gatt_client_notification_t * notification, btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 989 990 /** 991 * @brief Stop listening to characteristic value updates registered with 992 * the gatt_client_listen_for_characteristic_value_updates function. 993 * @param notification struct used in gatt_client_listen_for_characteristic_value_updates 994 */ 995 void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_notification_t * notification); 996 997 /** 998 * @brief Transactional write. It can be called as many times as it is needed to write the characteristics within the same transaction. 999 * Call the gatt_client_execute_write function to commit the transaction. 1000 * @param callback 1001 * @param con_handle 1002 * @param attribute_handle 1003 * @param offset of value 1004 * @param value_length 1005 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 1006 */ 1007 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 value_length, uint8_t * value); 1008 1009 /** 1010 * @brief Commit transactional write. GATT_EVENT_QUERY_COMPLETE is received. 1011 * @param callback 1012 * @param con_handle 1013 * @return status 1014 */ 1015 uint8_t gatt_client_execute_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 1016 1017 /** 1018 * @brief Abort transactional write. GATT_EVENT_QUERY_COMPLETE is received. 1019 * @param callback 1020 * @param con_handle 1021 * @return status 1022 */ 1023 uint8_t gatt_client_cancel_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 1024 1025 /** 1026 * @brief Request callback when regular gatt query can be sent 1027 * @note callback might happen during call to this function 1028 * @param callback_registration to point to callback function and context information 1029 * @param con_handle 1030 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 1031 */ 1032 uint8_t gatt_client_request_to_send_gatt_query(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 1033 1034 /** 1035 * @brief Remove queued callback for regular gatt queries, to be used on disconnect for example 1036 * @param callback_registration 1037 * @param con_handle 1038 * @return ERROR_CODE_SUCCESS if ok 1039 */ 1040 uint8_t gatt_client_remove_gatt_query(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 1041 1042 /** 1043 * @brief Request callback when writing characteristic value without response is possible 1044 * @note callback might happen during call to this function 1045 * @param callback_registration to point to callback function and context information 1046 * @param con_handle 1047 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 1048 */ 1049 uint8_t gatt_client_request_to_write_without_response(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 1050 1051 1052 // the following functions are marked as deprecated and will be removed eventually 1053 /** 1054 * @brief Requests GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE that guarantees 1055 * a single successful gatt_client_write_value_of_characteristic_without_response call. 1056 * @deprecated please use gatt_client_request_to_write_without_response instead 1057 * @param callback 1058 * @param con_handle 1059 * @return status 1060 */ 1061 uint8_t gatt_client_request_can_write_without_response_event(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 1062 1063 1064 /* API_END */ 1065 1066 // used by generated btstack_event.c 1067 1068 void gatt_client_deserialize_service(const uint8_t *packet, int offset, gatt_client_service_t * service); 1069 void gatt_client_deserialize_characteristic(const uint8_t * packet, int offset, gatt_client_characteristic_t * characteristic); 1070 void gatt_client_deserialize_characteristic_descriptor(const uint8_t * packet, int offset, gatt_client_characteristic_descriptor_t * descriptor); 1071 1072 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION 1073 void gatt_client_att_packet_handler_fuzz(uint8_t packet_type, uint16_t handle, uint8_t *packet, uint16_t size); 1074 uint8_t gatt_client_get_client(hci_con_handle_t con_handle, gatt_client_t ** gatt_client); 1075 #endif 1076 1077 #if defined __cplusplus 1078 } 1079 #endif 1080 1081 #endif 1082