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 MATTHIAS 24 * RINGWALD 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 #ifndef btstack_gatt_client_h 40 #define btstack_gatt_client_h 41 42 #include "hci.h" 43 44 #if defined __cplusplus 45 extern "C" { 46 #endif 47 48 typedef enum { 49 P_READY, 50 P_W2_SEND_SERVICE_QUERY, 51 P_W4_SERVICE_QUERY_RESULT, 52 P_W2_SEND_SERVICE_WITH_UUID_QUERY, 53 P_W4_SERVICE_WITH_UUID_RESULT, 54 55 P_W2_SEND_ALL_CHARACTERISTICS_OF_SERVICE_QUERY, 56 P_W4_ALL_CHARACTERISTICS_OF_SERVICE_QUERY_RESULT, 57 P_W2_SEND_CHARACTERISTIC_WITH_UUID_QUERY, 58 P_W4_CHARACTERISTIC_WITH_UUID_QUERY_RESULT, 59 60 P_W2_SEND_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY, 61 P_W4_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT, 62 63 P_W2_SEND_INCLUDED_SERVICE_QUERY, 64 P_W4_INCLUDED_SERVICE_QUERY_RESULT, 65 P_W2_SEND_INCLUDED_SERVICE_WITH_UUID_QUERY, 66 P_W4_INCLUDED_SERVICE_UUID_WITH_QUERY_RESULT, 67 68 P_W2_SEND_READ_CHARACTERISTIC_VALUE_QUERY, 69 P_W4_READ_CHARACTERISTIC_VALUE_RESULT, 70 71 P_W2_SEND_READ_BLOB_QUERY, 72 P_W4_READ_BLOB_RESULT, 73 74 P_W2_SEND_READ_BY_TYPE_REQUEST, 75 P_W4_READ_BY_TYPE_RESPONSE, 76 77 P_W2_SEND_READ_MULTIPLE_REQUEST, 78 P_W4_READ_MULTIPLE_RESPONSE, 79 80 P_W2_SEND_WRITE_CHARACTERISTIC_VALUE, 81 P_W4_WRITE_CHARACTERISTIC_VALUE_RESULT, 82 83 P_W2_PREPARE_WRITE, 84 P_W4_PREPARE_WRITE_RESULT, 85 P_W2_PREPARE_RELIABLE_WRITE, 86 P_W4_PREPARE_RELIABLE_WRITE_RESULT, 87 88 P_W2_EXECUTE_PREPARED_WRITE, 89 P_W4_EXECUTE_PREPARED_WRITE_RESULT, 90 P_W2_CANCEL_PREPARED_WRITE, 91 P_W4_CANCEL_PREPARED_WRITE_RESULT, 92 P_W2_CANCEL_PREPARED_WRITE_DATA_MISMATCH, 93 P_W4_CANCEL_PREPARED_WRITE_DATA_MISMATCH_RESULT, 94 95 #ifdef ENABLE_GATT_FIND_INFORMATION_FOR_CCC_DISCOVERY 96 P_W2_SEND_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 97 P_W4_FIND_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 98 #else 99 P_W2_SEND_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY, 100 P_W4_READ_CLIENT_CHARACTERISTIC_CONFIGURATION_QUERY_RESULT, 101 #endif 102 P_W2_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION, 103 P_W4_CLIENT_CHARACTERISTIC_CONFIGURATION_RESULT, 104 105 P_W2_SEND_READ_CHARACTERISTIC_DESCRIPTOR_QUERY, 106 P_W4_READ_CHARACTERISTIC_DESCRIPTOR_RESULT, 107 108 P_W2_SEND_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_QUERY, 109 P_W4_READ_BLOB_CHARACTERISTIC_DESCRIPTOR_RESULT, 110 111 P_W2_SEND_WRITE_CHARACTERISTIC_DESCRIPTOR, 112 P_W4_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 113 114 // all long writes use this 115 P_W2_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR, 116 P_W4_PREPARE_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 117 P_W2_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR, 118 P_W4_EXECUTE_PREPARED_WRITE_CHARACTERISTIC_DESCRIPTOR_RESULT, 119 120 // gatt reliable write API use this (manual version of the above) 121 P_W2_PREPARE_WRITE_SINGLE, 122 P_W4_PREPARE_WRITE_SINGLE_RESULT, 123 124 P_W4_IDENTITY_RESOLVING, 125 P_W4_CMAC_READY, 126 P_W4_CMAC_RESULT, 127 P_W2_SEND_SIGNED_WRITE, 128 P_W4_SEND_SINGED_WRITE_DONE, 129 } gatt_client_state_t; 130 131 132 typedef enum{ 133 SEND_MTU_EXCHANGE, 134 SENT_MTU_EXCHANGE, 135 MTU_EXCHANGED, 136 MTU_AUTO_EXCHANGE_DISABLED 137 } gatt_client_mtu_t; 138 139 typedef struct gatt_client{ 140 btstack_linked_item_t item; 141 // TODO: rename gatt_client_state -> state 142 gatt_client_state_t gatt_client_state; 143 144 // user callback 145 btstack_packet_handler_t callback; 146 147 // can write without response callback 148 btstack_packet_handler_t write_without_response_callback; 149 150 hci_con_handle_t con_handle; 151 152 uint8_t address_type; 153 bd_addr_t address; 154 155 uint16_t mtu; 156 gatt_client_mtu_t mtu_state; 157 158 uint16_t uuid16; 159 uint8_t uuid128[16]; 160 161 uint16_t start_group_handle; 162 uint16_t end_group_handle; 163 164 uint16_t query_start_handle; 165 uint16_t query_end_handle; 166 167 uint8_t characteristic_properties; 168 uint16_t characteristic_start_handle; 169 170 uint16_t attribute_handle; 171 uint16_t attribute_offset; 172 uint16_t attribute_length; 173 uint8_t* attribute_value; 174 175 // read multiple characteristic values 176 uint16_t read_multiple_handle_count; 177 uint16_t * read_multiple_handles; 178 179 uint16_t client_characteristic_configuration_handle; 180 uint8_t client_characteristic_configuration_value[2]; 181 182 uint8_t filter_with_uuid; 183 uint8_t send_confirmation; 184 185 int le_device_index; 186 uint8_t cmac[8]; 187 188 btstack_timer_source_t gc_timeout; 189 190 #ifdef ENABLE_GATT_CLIENT_PAIRING 191 uint8_t security_counter; 192 uint8_t wait_for_pairing_complete; 193 uint8_t pending_error_code; 194 #endif 195 196 } gatt_client_t; 197 198 typedef struct gatt_client_notification { 199 btstack_linked_item_t item; 200 btstack_packet_handler_t callback; 201 hci_con_handle_t con_handle; 202 uint16_t attribute_handle; 203 } gatt_client_notification_t; 204 205 /* API_START */ 206 207 typedef struct { 208 uint16_t start_group_handle; 209 uint16_t end_group_handle; 210 uint16_t uuid16; 211 uint8_t uuid128[16]; 212 } gatt_client_service_t; 213 214 typedef struct { 215 uint16_t start_handle; 216 uint16_t value_handle; 217 uint16_t end_handle; 218 uint16_t properties; 219 uint16_t uuid16; 220 uint8_t uuid128[16]; 221 } gatt_client_characteristic_t; 222 223 typedef struct { 224 uint16_t handle; 225 uint16_t uuid16; 226 uint8_t uuid128[16]; 227 } gatt_client_characteristic_descriptor_t; 228 229 /** 230 * @brief Set up GATT client. 231 */ 232 void gatt_client_init(void); 233 234 /** 235 * @brief MTU is available after the first query has completed. If status is equal to ERROR_CODE_SUCCESS, it returns the real value, otherwise the default value ATT_DEFAULT_MTU (see bluetooth.h). 236 * @param con_handle 237 * @param mtu 238 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 239 * GATT_CLIENT_IN_WRONG_STATE if MTU is not exchanged and MTU auto-exchange is disabled 240 * ERROR_CODE_SUCCESS if query is successfully registered 241 */ 242 uint8_t gatt_client_get_mtu(hci_con_handle_t con_handle, uint16_t * mtu); 243 244 /** 245 * @brief Sets whether a MTU Exchange Request shall be automatically send before the first attribute read request is send. Default is enabled. 246 * @param enabled 247 */ 248 void gatt_client_mtu_enable_auto_negotiation(uint8_t enabled); 249 250 /** 251 * @brief Sends a MTU Exchange Request, this allows for the client to exchange MTU when gatt_client_mtu_enable_auto_negotiation is disabled. 252 * @param callback 253 * @param con_handle 254 */ 255 void gatt_client_send_mtu_negotiation(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 256 257 /** 258 * @brief Returns if the GATT client is ready to receive a query. It is used with daemon. 259 * @param con_handle 260 * @return is_ready_status 0 - if no GATT client for con_handle is found, or is not ready, otherwise 1 261 */ 262 int gatt_client_is_ready(hci_con_handle_t con_handle); 263 264 /** 265 * @brief Discovers all primary services. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 266 * @param callback 267 * @param con_handle 268 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 269 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 270 * ERROR_CODE_SUCCESS , if query is successfully registered 271 */ 272 uint8_t gatt_client_discover_primary_services(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 273 274 /** 275 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 276 * @param callback 277 * @param con_handle 278 * @param uuid16 279 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 280 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 281 * ERROR_CODE_SUCCESS , if query is successfully registered 282 */ 283 uint8_t gatt_client_discover_primary_services_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t uuid16); 284 285 /** 286 * @brief Discovers a specific primary service given its UUID. This service may exist multiple times. For each found service, an le_service_event_t with type set to GATT_EVENT_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t, with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 287 * @param callback 288 * @param con_handle 289 * @param uuid128 290 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 291 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 292 * ERROR_CODE_SUCCESS , if query is successfully registered 293 */ 294 uint8_t gatt_client_discover_primary_services_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, const uint8_t * uuid128); 295 296 /** 297 * @brief Finds included services within the specified service. For each found included service, an le_service_event_t with type set to GATT_EVENT_INCLUDED_SERVICE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. Information about included service type (primary/secondary) can be retrieved either by sending an ATT find information request for the returned start group handle (returning the handle and the UUID for primary or secondary service) or by comparing the service to the list of all primary services. 298 * @param callback 299 * @param con_handle 300 * @param service 301 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 302 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 303 * ERROR_CODE_SUCCESS , if query is successfully registered 304 */ 305 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); 306 307 /** 308 * @brief Discovers all characteristics within the specified service. For each found characteristic, an le_characteristics_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 309 * @param callback 310 * @param con_handle 311 * @param service 312 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 313 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 314 * ERROR_CODE_SUCCESS , if query is successfully registered 315 */ 316 uint8_t gatt_client_discover_characteristics_for_service(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service); 317 318 /** 319 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 320 * @param callback 321 * @param con_handle 322 * @param start_handle 323 * @param end_handle 324 * @param uuid16 325 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 326 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 327 * ERROR_CODE_SUCCESS , if query is successfully registered 328 */ 329 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); 330 331 /** 332 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 333 * @param callback 334 * @param con_handle 335 * @param start_handle 336 * @param end_handle 337 * @param uuid128 338 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 339 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 340 * ERROR_CODE_SUCCESS , if query is successfully registered 341 */ 342 uint8_t gatt_client_discover_characteristics_for_handle_range_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint8_t * uuid128); 343 344 /** 345 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 346 * @param callback 347 * @param con_handle 348 * @param service 349 * @param uuid16 350 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 351 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 352 * ERROR_CODE_SUCCESS , if query is successfully registered 353 */ 354 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); 355 356 /** 357 * @brief The following four functions are used to discover all characteristics within the specified service or handle range, and return those that match the given UUID. For each found characteristic, an le_characteristic_event_t with type set to GATT_EVENT_CHARACTERISTIC_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 358 * @param callback 359 * @param con_handle 360 * @param service 361 * @param uuid128 362 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 363 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 364 * ERROR_CODE_SUCCESS , if query is successfully registered 365 */ 366 uint8_t gatt_client_discover_characteristics_for_service_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_service_t *service, uint8_t * uuid128); 367 368 /** 369 * @brief Discovers attribute handle and UUID of a characteristic descriptor within the specified characteristic. For each found descriptor, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of discovery. 370 * @param callback 371 * @param con_handle 372 * @param characteristic 373 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 374 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 375 * ERROR_CODE_SUCCESS , if query is successfully registered 376 */ 377 uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic); 378 379 /** 380 * @brief Reads the characteristic value using the characteristic's value handle. If the characteristic value is found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 381 * @param callback 382 * @param con_handle 383 * @param characteristic 384 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 385 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 386 * ERROR_CODE_SUCCESS , if query is successfully registered 387 */ 388 uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t *characteristic); 389 390 /** 391 * @brief Reads the characteristic value using the characteristic's value handle. If the characteristic value is found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 392 * @param callback 393 * @param con_handle 394 * @param characteristic_value_handle 395 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 396 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 397 * ERROR_CODE_SUCCESS , if query is successfully registered 398 */ 399 uint8_t gatt_client_read_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle); 400 401 /** 402 * @brief Reads the characteric value of all characteristics with the uuid. For each found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 403 * @param callback 404 * @param con_handle 405 * @param start_handle 406 * @param end_handle 407 * @param uuid16 408 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 409 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 410 * ERROR_CODE_SUCCESS , if query is successfully registered 411 */ 412 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); 413 414 /** 415 * @brief Reads the characteric value of all characteristics with the uuid. For each found, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 416 * @param callback 417 * @param con_handle 418 * @param start_handle 419 * @param end_handle 420 * @param uuid128 421 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 422 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 423 * ERROR_CODE_SUCCESS , if query is successfully registered 424 */ 425 uint8_t gatt_client_read_value_of_characteristics_by_uuid128(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint8_t * uuid128); 426 427 /** 428 * @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read. 429 * @param callback 430 * @param con_handle 431 * @param characteristic 432 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 433 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 434 * ERROR_CODE_SUCCESS , if query is successfully registered 435 */ 436 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); 437 438 /** 439 * @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read. 440 * @param callback 441 * @param con_handle 442 * @param characteristic_value_handle 443 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 444 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 445 * ERROR_CODE_SUCCESS , if query is successfully registered 446 */ 447 uint8_t gatt_client_read_long_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle); 448 449 /** 450 * @brief Reads the long characteristic value using the characteristic's value handle. The value will be returned in several blobs. For each blob, an le_characteristic_value_event_t with type set to GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT and updated value offset will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, mark the end of read. 451 * @param callback 452 * @param con_handle 453 * @param characteristic_value_handle 454 * @param offset 455 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 456 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 457 * ERROR_CODE_SUCCESS , if query is successfully registered 458 */ 459 uint8_t gatt_client_read_long_value_of_characteristic_using_value_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t offset); 460 461 /* 462 * @brief Read multiple characteristic values 463 * @param callback 464 * @param con_handle 465 * @param num_value_handles 466 * @param value_handles list of handles 467 */ 468 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); 469 470 /** 471 * @brief Writes the characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed. 472 * @param con_handle 473 * @param characteristic_value_handle 474 * @param length of data 475 * @param data is not copied, make sure memory is accessible until write is done 476 * @return status BTSTACK_MEMORY_ALLOC_FAILED, if no GATT client for con_handle is found 477 * GATT_CLIENT_IN_WRONG_STATE , if GATT client is not ready 478 * BTSTACK_ACL_BUFFERS_FULL , if L2CAP cannot send, there are no free ACL slots 479 * ERROR_CODE_SUCCESS , if query is successfully registered 480 */ 481 uint8_t gatt_client_write_value_of_characteristic_without_response(hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data); 482 483 /** 484 * @brief Writes the authenticated characteristic value using the characteristic's value handle without an acknowledgment that the write was successfully performed. 485 * @note GATT_EVENT_QUERY_COMPLETE is emitted with 0 for success or ATT_ERROR_BONDING_INFORMATION_MISSING if there is no bonding information stored 486 * @param callback 487 * @param con_handle 488 * @param value_handle 489 * @param message_len 490 * @param message is not copied, make sure memory is accessible until write is done 491 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 492 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 493 * ERROR_CODE_SUCCESS if query is successfully registered 494 */ 495 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); 496 497 /** 498 * @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 499 * @param callback 500 * @param con_handle 501 * @param characteristic_value_handle 502 * @param length of data 503 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 504 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 505 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 506 * ERROR_CODE_SUCCESS if query is successfully registered 507 */ 508 uint8_t gatt_client_write_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data); 509 510 /** 511 * @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 512 * @param callback 513 * @param con_handle 514 * @param characteristic_value_handle 515 * @param length of data 516 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 517 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 518 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 519 * ERROR_CODE_SUCCESS if query is successfully registered 520 */ 521 uint8_t gatt_client_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data); 522 523 /** 524 * @brief Writes the characteristic value using the characteristic's value handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 525 * @param callback 526 * @param con_handle 527 * @param characteristic_value_handle 528 * @param offset of value 529 * @param length of data 530 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 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_write_long_value_of_characteristic_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t offset, uint16_t length, uint8_t * data); 536 537 /** 538 * @brief Writes of the long characteristic value using the characteristic's value handle. It uses server response to validate that the write was correctly received. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 539 * @param callback 540 * @param con_handle 541 * @param characteristic_value_handle 542 * @param length of data 543 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 544 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 545 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 546 * ERROR_CODE_SUCCESS if query is successfully registered 547 */ 548 uint8_t gatt_client_reliable_write_long_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t characteristic_value_handle, uint16_t length, uint8_t * data); 549 550 /** 551 * @brief Reads the characteristic descriptor using its handle. If the characteristic descriptor is found, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 552 * @param callback 553 * @param con_handle 554 * @param descriptor 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_read_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 560 561 /** 562 * @brief Reads the characteristic descriptor using its handle. If the characteristic descriptor is found, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 563 * @param callback 564 * @param con_handle 565 * @param descriptor 566 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 567 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 568 * ERROR_CODE_SUCCESS if query is successfully registered 569 */ 570 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); 571 572 /** 573 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 574 * @param callback 575 * @param con_handle 576 * @param descriptor_handle 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_read_long_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor); 582 583 /** 584 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 585 * @param callback 586 * @param con_handle 587 * @param descriptor_handle 588 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 589 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 590 * ERROR_CODE_SUCCESS if query is successfully registered 591 */ 592 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); 593 594 /** 595 * @brief Reads the long characteristic descriptor using its handle. It will be returned in several blobs. For each blob, an le_characteristic_descriptor_event_t with type set to GATT_EVENT_CHARACTERISTIC_DESCRIPTOR_QUERY_RESULT will be generated and passed to the registered callback. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of read. 596 * @param callback 597 * @param con_handle 598 * @param descriptor_handle 599 * @param offset 600 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 601 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 602 * ERROR_CODE_SUCCESS if query is successfully registered 603 */ 604 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); 605 606 /** 607 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 608 * @param callback 609 * @param con_handle 610 * @param descriptor 611 * @param length of data 612 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 613 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 614 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 615 * ERROR_CODE_SUCCESS if query is successfully registered 616 */ 617 uint8_t gatt_client_write_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor, uint16_t length, uint8_t * data); 618 619 /** 620 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 621 * @param callback 622 * @param con_handle 623 * @param descriptor_handle 624 * @param length of data 625 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 626 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 627 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 628 * ERROR_CODE_SUCCESS if query is successfully registered 629 */ 630 uint8_t gatt_client_write_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t length, uint8_t * data); 631 632 /** 633 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 634 * @param callback 635 * @param con_handle 636 * @param descriptor 637 * @param length of data 638 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 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_write_long_characteristic_descriptor(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_descriptor_t * descriptor, uint16_t length, uint8_t * data); 644 645 /** 646 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 647 * @param callback 648 * @param con_handle 649 * @param descriptor_handle 650 * @param length of data 651 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 652 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 653 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 654 * ERROR_CODE_SUCCESS if query is successfully registered 655 */ 656 uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t length, uint8_t * data); 657 658 /** 659 * @brief Writes the characteristic descriptor using its handle. The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS (see bluetooth.h for ATT_ERROR codes). 660 * @param callback 661 * @param con_handle 662 * @param descriptor_handle 663 * @param offset of value 664 * @param length of data 665 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 666 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 667 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 668 * ERROR_CODE_SUCCESS if query is successfully registered 669 */ 670 uint8_t gatt_client_write_long_characteristic_descriptor_using_descriptor_handle_with_offset(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t descriptor_handle, uint16_t offset, uint16_t length, uint8_t * data); 671 672 /** 673 * @brief Writes the client characteristic configuration of the specified characteristic. It is used to subscribe for notifications or indications of the characteristic value. 674 * For notifications or indications specify: GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION resp. GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION as configuration value. 675 * The gatt_complete_event_t with type set to GATT_EVENT_QUERY_COMPLETE, marks the end of write. The write is successfully performed, if the event's att_status field is set to ATT_ERROR_SUCCESS 676 * (see bluetooth.h for ATT_ERROR codes). 677 * @param callback 678 * @param con_handle 679 * @param characteristic 680 * @param configuration GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION, GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_INDICATION 681 * @return status BTSTACK_MEMORY_ALLOC_FAILED if no GATT client for con_handle is found 682 * GATT_CLIENT_IN_WRONG_STATE if GATT client is not ready 683 * GATT_CLIENT_CHARACTERISTIC_NOTIFICATION_NOT_SUPPORTED if configuring notification, but characteristic has no notification property set 684 * GATT_CLIENT_CHARACTERISTIC_INDICATION_NOT_SUPPORTED if configuring indication, but characteristic has no indication property set 685 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if configuration is invalid 686 * ERROR_CODE_SUCCESS if query is successfully registered 687 */ 688 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); 689 690 /** 691 * @brief Register for notifications and indications of a characteristic enabled by gatt_client_write_client_characteristic_configuration 692 * @param notification struct used to store registration 693 * @param callback 694 * @param con_handle or GATT_CLIENT_ANY_CONNECTION to receive updates from all connected devices 695 * @param characteristic or NULL to receive updates for all characteristics 696 */ 697 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); 698 699 /** 700 * @brief Stop listening to characteristic value updates registered with gatt_client_listen_for_characteristic_value_updates 701 * @param notification struct used in gatt_client_listen_for_characteristic_value_updates 702 */ 703 void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_notification_t * notification); 704 705 /** 706 * @brief Requests GATT_EVENT_CAN_WRITE_WITHOUT_RESPONSE that guarantees a single successful gatt_client_write_value_of_characteristic_without_response 707 * @param callback 708 * @param con_handle 709 * @returns status 710 */ 711 uint8_t gatt_client_request_can_write_without_response_event(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 712 713 /** 714 * @brief Transactional write. It can be called as many times as it is needed to write the characteristics within the same transaction. Call gatt_client_execute_write to commit the transaction. 715 * @param callback 716 * @param con_handle 717 * @param attribute_handle 718 * @param offset of value 719 * @param length of data 720 * @param data is not copied, make sure memory is accessible until write is done, i.e. GATT_EVENT_QUERY_COMPLETE is received 721 */ 722 uint8_t gatt_client_prepare_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t offset, uint16_t length, uint8_t * data); 723 724 /** 725 * @brief Commit transactional write. GATT_EVENT_QUERY_COMPLETE is received. 726 * @param callback 727 * @param con_handle 728 */ 729 uint8_t gatt_client_execute_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 730 731 /** 732 * @brief Abort transactional write. GATT_EVENT_QUERY_COMPLETE is received. 733 * @param callback 734 * @param con_handle 735 */ 736 uint8_t gatt_client_cancel_write(btstack_packet_handler_t callback, hci_con_handle_t con_handle); 737 738 /* API_END */ 739 740 // used by generated btstack_event.c 741 742 void gatt_client_deserialize_service(const uint8_t *packet, int offset, gatt_client_service_t *service); 743 void gatt_client_deserialize_characteristic(const uint8_t * packet, int offset, gatt_client_characteristic_t * characteristic); 744 void gatt_client_deserialize_characteristic_descriptor(const uint8_t * packet, int offset, gatt_client_characteristic_descriptor_t * descriptor); 745 746 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION 747 void gatt_client_att_packet_handler_fuzz(uint8_t packet_type, uint16_t handle, uint8_t *packet, uint16_t size); 748 #endif 749 750 #if defined __cplusplus 751 } 752 #endif 753 754 #endif 755