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 uuid16 448 * @param service_id - context provided to callback in events 449 * @param connection_id - contest provided to callback in events 450 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 451 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 452 * ERROR_CODE_SUCCESS , if query is successfully registered 453 */ 454 uint8_t gatt_client_discover_primary_services_by_uuid16_with_context(btstack_packet_handler_t callback, hci_con_handle_t con_handle, 455 uint16_t uuid16, uint16_t service_id, uint16_t connection_id); 456 457 /** 458 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. 459 * For each found service a GATT_EVENT_SERVICE_QUERY_RESULT event will be emitted. 460 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 461 * @param callback 462 * @param con_handle 463 * @param uuid128 464 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 465 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 466 * ERROR_CODE_SUCCESS , if query is successfully registered 467 */ 468 uint8_t gatt_client_discover_primary_services_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, const uint8_t * uuid128); 469 470 /** 471 * @brief Finds included services within the specified service. 472 * For each found included service a GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT event will be emitted. 473 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 474 * Information about included service type (primary/secondary) can be retrieved either by sending 475 * an ATT find information request for the returned start group handle 476 * (returning the handle and the UUID for primary or secondary service) or by comparing the service 477 * to the list of all primary services. 478 * @param callback 479 * @param con_handle 480 * @param service 481 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 482 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 483 * ERROR_CODE_SUCCESS , if query is successfully registered 484 */ 485 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); 486 487 /** 488 * @brief Finds included services within the specified service. 489 * For each found included service a GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT event will be emitted. 490 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 491 * Information about included service type (primary/secondary) can be retrieved either by sending 492 * an ATT find information request for the returned start group handle 493 * (returning the handle and the UUID for primary or secondary service) or by comparing the service 494 * to the list of all primary services. 495 * @param callback 496 * @param con_handle 497 * @param service_id - context provided to callback in events 498 * @param connection_id - contest provided to callback in events 499 * @param service_id 500 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 501 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 502 * ERROR_CODE_SUCCESS , if query is successfully registered 503 */ 504 uint8_t gatt_client_find_included_services_for_service_with_context(btstack_packet_handler_t callback, hci_con_handle_t con_handle, 505 gatt_client_service_t * service, uint16_t service_id, uint16_t connection_id); 506 507 /** 508 * @brief Discovers all characteristics within the specified service. 509 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will be emited. 510 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 511 * @param callback 512 * @param con_handle 513 * @param service 514 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 515 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 516 * ERROR_CODE_SUCCESS , if query is successfully registered 517 */ 518 uint8_t gatt_client_discover_characteristics_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t * service); 519 520 /** 521 * @brief The following four functions are used to discover all characteristics within 522 * the specified service or handle range, and return those that match the given UUID. 523 * 524 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 525 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 526 * @param callback 527 * @param con_handle 528 * @param start_handle 529 * @param end_handle 530 * @param uuid16 531 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 532 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 533 * ERROR_CODE_SUCCESS , if query is successfully registered 534 */ 535 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); 536 537 /** 538 * @brief The following four functions are used to discover all characteristics within the 539 * specified service or handle range, and return those that match the given UUID. 540 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 541 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 542 * @param callback 543 * @param con_handle 544 * @param start_handle 545 * @param end_handle 546 * @param uuid128 547 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 548 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 549 * ERROR_CODE_SUCCESS , if query is successfully registered 550 */ 551 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); 552 553 /** 554 * @brief The following four functions are used to discover all characteristics within the 555 * specified service or handle range, and return those that match the given UUID. 556 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 557 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 558 * @param callback 559 * @param con_handle 560 * @param service 561 * @param uuid16 562 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 563 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 564 * ERROR_CODE_SUCCESS , if query is successfully registered 565 */ 566 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); 567 568 /** 569 * @brief The following four functions are used to discover all characteristics within the 570 * specified service or handle range, and return those that match the given UUID. 571 * For each found characteristic a GATT_EVENT_CHARACTERISTIC_QUERY_RESULT event will emitted. 572 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 573 * @param callback 574 * @param con_handle 575 * @param service 576 * @param uuid128 577 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 578 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 579 * ERROR_CODE_SUCCESS , if query is successfully registered 580 */ 581 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); 582 583 /** 584 * @brief Discovers attribute handle and UUID of a characteristic descriptor within the specified characteristic. 585 * For each found descriptor a GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT event will be emitted. 586 * 587 * The GATT_EVENT_QUERY_COMPLETE event marks the end of discovery. 588 * @param callback 589 * @param con_handle 590 * @param characteristic 591 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 592 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 593 * ERROR_CODE_SUCCESS , if query is successfully registered 594 */ 595 uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 596 597 /** 598 * @brief Reads the characteristic value using the characteristic's value handle. 599 * If the characteristic value is found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 600 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 601 * @param callback 602 * @param con_handle 603 * @param characteristic 604 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 605 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 606 * ERROR_CODE_SUCCESS , if query is successfully registered 607 */ 608 uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic); 609 610 /** 611 * @brief Reads the characteristic value using the characteristic's value handle. 612 * If the characteristic value is found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 613 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 614 * @param callback 615 * @param con_handle 616 * @param value_handle 617 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 618 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 619 * ERROR_CODE_SUCCESS , if query is successfully registered 620 */ 621 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); 622 623 /** 624 * @brief Reads the characteric value of all characteristics with the uuid. 625 * For each characteristic value found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 626 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 627 * @param callback 628 * @param con_handle 629 * @param start_handle 630 * @param end_handle 631 * @param uuid16 632 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 633 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 634 * ERROR_CODE_SUCCESS , if query is successfully registered 635 */ 636 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); 637 638 /** 639 * @brief Reads the characteric value of all characteristics with the uuid. 640 * For each characteristic value found a GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event will be emitted. 641 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 642 * @param callback 643 * @param con_handle 644 * @param start_handle 645 * @param end_handle 646 * @param uuid128 647 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 648 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 649 * ERROR_CODE_SUCCESS , if query is successfully registered 650 */ 651 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); 652 653 /** 654 * @brief Reads the long characteristic value using the characteristic's value handle. 655 * The value will be returned in several blobs. 656 * For each blob, a GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT event with updated value offset will be emitted. 657 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 658 * @param callback 659 * @param con_handle 660 * @param characteristic 661 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 662 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 663 * ERROR_CODE_SUCCESS , if query is successfully registered 664 */ 665 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); 666 667 /** 668 * @brief Reads the long characteristic value using the characteristic's value handle. 669 * The value will be returned in several blobs. 670 * For each blob, a GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT event with updated value offset will be emitted. 671 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 672 * @param callback 673 * @param con_handle 674 * @param value_handle 675 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 676 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 677 * ERROR_CODE_SUCCESS , if query is successfully registered 678 */ 679 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); 680 681 /** 682 * @brief Reads the long characteristic value using the characteristic's value handle. 683 * The value will be returned in several blobs. 684 * For each blob, a GATT_EVENT_LONG_CHARACTERISTIC_VALUE_QUERY_RESULT event with updated value offset will be emitted. 685 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 686 * @param callback 687 * @param con_handle 688 * @param value_handle 689 * @param offset 690 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 691 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 692 * ERROR_CODE_SUCCESS , if query is successfully registered 693 */ 694 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); 695 696 /* 697 * @brief Read multiple characteristic values. 698 * The all results are emitted via single GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event, 699 * followed by the GATT_EVENT_QUERY_COMPLETE event, which marks the end of read. 700 * @param callback 701 * @param con_handle 702 * @param num_value_handles 703 * @param value_handles list of handles 704 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 705 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 706 * ERROR_CODE_SUCCESS , if query is successfully registered 707 */ 708 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); 709 710 /* 711 * @brief Read multiple varaible characteristic values. Only supported over LE Enhanced Bearer 712 * The all results are emitted via single GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT event, 713 * followed by the GATT_EVENT_QUERY_COMPLETE event, which marks the end of read. 714 * @param callback 715 * @param con_handle 716 * @param num_value_handles 717 * @param value_handles list of handles 718 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 719 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 720 * ERROR_CODE_SUCCESS , if query is successfully registered 721 */ 722 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); 723 724 /** 725 * @brief Writes the characteristic value using the characteristic's value handle without 726 * an acknowledgment that the write was successfully performed. 727 * @param con_handle 728 * @param value_handle 729 * @param value_length 730 * @param value is copied on success and does not need to be retained 731 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 732 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 733 * BTSTACK_ACL_BUFFERS_FULL , if L2CAP cannot send, there are no free ACL slots 734 * ERROR_CODE_SUCCESS , if query is successfully registered 735 */ 736 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); 737 738 /** 739 * @brief Writes the authenticated characteristic value using the characteristic's value handle 740 * without an acknowledgment that the write was successfully performed. 741 * @note GATT_EVENT_QUERY_COMPLETE is emitted with ATT_ERROR_SUCCESS for success, 742 * or ATT_ERROR_BONDING_INFORMATION_MISSING if there is no bonding information stored. 743 * @param callback 744 * @param con_handle 745 * @param value_handle 746 * @param message_len 747 * @param message is not copied, make sure memory is accessible until write is done 748 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 749 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 750 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 751 * ERROR_CODE_SUCCESS if query is successfully registered 752 */ 753 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); 754 755 /** 756 * @brief Writes the characteristic value using the characteristic's value handle. 757 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 758 * The write is successfully performed, if the event's att_status field is set to 759 * ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 760 * @param callback 761 * @param con_handle 762 * @param value_handle 763 * @param value_length 764 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 765 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 766 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 767 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 768 * ERROR_CODE_SUCCESS if query is successfully registered 769 */ 770 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); 771 772 /** 773 * @brief Writes the characteristic value using the characteristic's value handle. 774 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 775 * 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). 776 * @param callback 777 * @param con_handle 778 * @param value_handle 779 * @param value_length 780 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 781 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 782 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 783 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 784 * ERROR_CODE_SUCCESS if query is successfully registered 785 */ 786 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); 787 788 /** 789 * @brief Writes the characteristic value using the characteristic's value handle. 790 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 791 * 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). 792 * @param callback 793 * @param con_handle 794 * @param value_handle 795 * @param offset of value 796 * @param value_length 797 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 798 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 799 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 800 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 801 * ERROR_CODE_SUCCESS if query is successfully registered 802 */ 803 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); 804 805 /** 806 * @brief Writes of the long characteristic value using the characteristic's value handle. 807 * It uses server response to validate that the write was correctly received. 808 * The GATT_EVENT_QUERY_COMPLETE EVENT marks the end of write. 809 * 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). 810 * @param callback 811 * @param con_handle 812 * @param value_handle 813 * @param value_length 814 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 815 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 816 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 817 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 818 * ERROR_CODE_SUCCESS if query is successfully registered 819 */ 820 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); 821 822 /** 823 * @brief Reads the characteristic descriptor using its handle. 824 * If the characteristic descriptor is found, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 825 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 826 * @param callback 827 * @param con_handle 828 * @param descriptor 829 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 830 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 831 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 832 * ERROR_CODE_SUCCESS if query is successfully registered 833 */ 834 uint8_t gatt_client_read_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 835 836 /** 837 * @brief Reads the characteristic descriptor using its handle. 838 * If the characteristic descriptor is found, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 839 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 840 * @param callback 841 * @param con_handle 842 * @param descriptor 843 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 844 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 845 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 846 * ERROR_CODE_SUCCESS if query is successfully registered 847 */ 848 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); 849 850 /** 851 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. 852 * For each blob, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 853 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 854 * @param callback 855 * @param con_handle 856 * @param descriptor 857 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 858 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 859 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 860 * ERROR_CODE_SUCCESS if query is successfully registered 861 */ 862 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); 863 864 /** 865 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. 866 * For each blob, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 867 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 868 * @param callback 869 * @param con_handle 870 * @param descriptor_handle 871 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 872 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 873 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 874 * ERROR_CODE_SUCCESS if query is successfully registered 875 */ 876 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); 877 878 /** 879 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. 880 * For each blob, a GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT event will be emitted. 881 * The GATT_EVENT_QUERY_COMPLETE event marks the end of read. 882 * @param callback 883 * @param con_handle 884 * @param descriptor_handle 885 * @param offset 886 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 887 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 888 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 889 * ERROR_CODE_SUCCESS if query is successfully registered 890 */ 891 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); 892 893 /** 894 * @brief Writes the characteristic descriptor using its handle. 895 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 896 * 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). 897 * @param callback 898 * @param con_handle 899 * @param descriptor 900 * @param value_length 901 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 902 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 903 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 904 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 905 * ERROR_CODE_SUCCESS if query is successfully registered 906 */ 907 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); 908 909 /** 910 * @brief Writes the characteristic descriptor using its handle. 911 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 912 * 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). 913 * @param callback 914 * @param con_handle 915 * @param descriptor_handle 916 * @param value_length 917 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 918 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 919 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 920 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 921 * ERROR_CODE_SUCCESS if query is successfully registered 922 */ 923 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); 924 925 /** 926 * @brief Writes the characteristic descriptor using its handle. 927 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 928 * 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). 929 * @param callback 930 * @param con_handle 931 * @param descriptor 932 * @param value_length 933 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 934 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 935 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 936 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 937 * ERROR_CODE_SUCCESS if query is successfully registered 938 */ 939 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); 940 941 /** 942 * @brief Writes the characteristic descriptor using its handle. 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 descriptor_handle 948 * @param value_length 949 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 950 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 951 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 952 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 953 * ERROR_CODE_SUCCESS if query is successfully registered 954 */ 955 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); 956 957 /** 958 * @brief Writes the characteristic descriptor using its handle. 959 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 960 * 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). 961 * @param callback 962 * @param con_handle 963 * @param descriptor_handle 964 * @param offset of value 965 * @param value_length 966 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 967 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 968 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 969 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 970 * ERROR_CODE_SUCCESS if query is successfully registered 971 */ 972 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); 973 974 /** 975 * @brief Writes the client characteristic configuration of the specified characteristic. 976 * It is used to subscribe for notifications or indications of the characteristic value. 977 * For notifications or indications specify: GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION 978 * resp. GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION as configuration value. 979 * The GATT_EVENT_QUERY_COMPLETE event marks the end of write. 980 * 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). 981 * @param callback 982 * @param con_handle 983 * @param characteristic 984 * @param configuration GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION, GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 985 * @return status ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if no HCI connection for con_handle is found 986 * BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle could be allocated 987 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 988 * GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED if configuring notification, but characteristic has no notification property set 989 * GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED if configuring indication, but characteristic has no indication property set 990 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if configuration is invalid 991 * ERROR_CODE_SUCCESS if query is successfully registered 992 */ 993 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); 994 995 /** 996 * @brief Register for changes to the Service Changed and Database Hash Characteristics of the remote GATT Service 997 * * 998 * When configured, GATT_EVENT_QUERY_COMPLETE event is emitted 999 * If supported, the Database Hash is read as well 1000 * 1001 * Requires ENABLE_GATT_CLIENT_SERVICE_CHANGED 1002 * 1003 * @param callback 1004 */ 1005 void gatt_client_add_service_changed_handler(btstack_packet_callback_registration_t * callback); 1006 1007 /** 1008 * @brief Remove callback for service changes 1009 * 1010 * Requires ENABLE_GATT_CLIENT_SERVICE_CHANGED 1011 * 1012 * @param callback 1013 */ 1014 void gatt_client_remove_service_changed_handler(btstack_packet_callback_registration_t * callback); 1015 1016 /** 1017 * @brief Register for notifications and indications of a characteristic enabled by 1018 * the gatt_client_write_client_characteristic_configuration function. 1019 * @param notification struct used to store registration 1020 * @param callback 1021 * @param con_handle or GATT_CLIENT_ANY_CONNECTION to receive updates from all connected devices 1022 * @param characteristic or NULL to receive updates for all characteristics 1023 */ 1024 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); 1025 1026 /** 1027 * @brief Stop listening to characteristic value updates registered with 1028 * the gatt_client_listen_for_characteristic_value_updates function. 1029 * @param notification struct used in gatt_client_listen_for_characteristic_value_updates 1030 */ 1031 void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_notification_t * notification); 1032 1033 /** 1034 * @brief Transactional write. It can be called as many times as it is needed to write the characteristics within the same transaction. 1035 * Call the gatt_client_execute_write function to commit the transaction. 1036 * @param callback 1037 * @param con_handle 1038 * @param attribute_handle 1039 * @param offset of value 1040 * @param value_length 1041 * @param value is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 1042 */ 1043 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); 1044 1045 /** 1046 * @brief Commit transactional write. GATT_EVENT_QUERY_COMPLETE is received. 1047 * @param callback 1048 * @param con_handle 1049 * @return status 1050 */ 1051 uint8_t gatt_client_execute_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 1052 1053 /** 1054 * @brief Abort transactional write. GATT_EVENT_QUERY_COMPLETE is received. 1055 * @param callback 1056 * @param con_handle 1057 * @return status 1058 */ 1059 uint8_t gatt_client_cancel_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 1060 1061 /** 1062 * @brief Request callback when regular gatt query can be sent 1063 * @note callback might happen during call to this function 1064 * @param callback_registration to point to callback function and context information 1065 * @param con_handle 1066 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 1067 */ 1068 uint8_t gatt_client_request_to_send_gatt_query(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 1069 1070 /** 1071 * @brief Remove queued callback for regular gatt queries, to be used on disconnect for example 1072 * @param callback_registration 1073 * @param con_handle 1074 * @return ERROR_CODE_SUCCESS if ok 1075 */ 1076 uint8_t gatt_client_remove_gatt_query(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 1077 1078 /** 1079 * @brief Request callback when writing characteristic value without response is possible 1080 * @note callback might happen during call to this function 1081 * @param callback_registration to point to callback function and context information 1082 * @param con_handle 1083 * @return ERROR_CODE_SUCCESS if ok, ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER if handle unknown, and ERROR_CODE_COMMAND_DISALLOWED if callback already registered 1084 */ 1085 uint8_t gatt_client_request_to_write_without_response(btstack_context_callback_registration_t * callback_registration, hci_con_handle_t con_handle); 1086 1087 1088 // the following functions are marked as deprecated and will be removed eventually 1089 /** 1090 * @brief Requests GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE that guarantees 1091 * a single successful gatt_client_write_value_of_characteristic_without_response call. 1092 * @deprecated please use gatt_client_request_to_write_without_response instead 1093 * @param callback 1094 * @param con_handle 1095 * @return status 1096 */ 1097 uint8_t gatt_client_request_can_write_without_response_event(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 1098 1099 1100 /* API_END */ 1101 1102 // used by generated btstack_event.c 1103 1104 void gatt_client_deserialize_service(const uint8_t *packet, int offset, gatt_client_service_t * service); 1105 void gatt_client_deserialize_characteristic(const uint8_t * packet, int offset, gatt_client_characteristic_t * characteristic); 1106 void gatt_client_deserialize_characteristic_descriptor(const uint8_t * packet, int offset, gatt_client_characteristic_descriptor_t * descriptor); 1107 1108 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION 1109 void gatt_client_att_packet_handler_fuzz(uint8_t packet_type, uint16_t handle, uint8_t *packet, uint16_t size); 1110 uint8_t gatt_client_get_client(hci_con_handle_t con_handle, gatt_client_t ** gatt_client); 1111 #endif 1112 1113 #if defined __cplusplus 1114 } 1115 #endif 1116 1117 #endif 1118