1 /* 2 * Copyright (C) 2021 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 #ifndef DEVICE_INFORMATION_SERVICE_CLIENT_H 39 #define DEVICE_INFORMATION_SERVICE_CLIENT_H 40 41 #include <stdint.h> 42 #include "btstack_defines.h" 43 #include "bluetooth.h" 44 #include "ble/gatt_client.h" 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 /** 51 * @text The Device Information Service Client retrieves the following information from a remote device: 52 * - manufacturer name 53 * - model number 54 * - serial number 55 * - hardware revision 56 * - firmware revision 57 * - software revision 58 * - system ID 59 * - IEEE regulatory certification 60 * - PNP ID 61 */ 62 63 /* API_START */ 64 65 /** 66 * @brief Initialize Device Information Service. 67 */ 68 void device_information_service_client_init(void); 69 70 /** 71 * @brief Query Device Information Service. The client will query the remote service and emit events: 72 * 73 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_MANUFACTURER_NAME 74 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_MODEL_NUMBER 75 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_SERIAL_NUMBER 76 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_HARDWARE_REVISION 77 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_FIRMWARE_REVISION 78 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_SOFTWARE_REVISION 79 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_SYSTEM_ID 80 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_IEEE_REGULATORY_CERTIFICATION 81 * - GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_PNP_ID 82 * 83 * Event GATTSERVICE_SUBEVENT_DEVICE_INFORMATION_DONE is received when all queries are done, of if service was not found. 84 * The status field of this event indicated ATT errors (see bluetooth.h). 85 * 86 * @param con_handle 87 * @param packet_handler 88 * @return status ERROR_CODE_SUCCESS on success, otherwise GATT_CLIENT_IN_WRONG_STATE if query is already in progress 89 */ 90 uint8_t device_information_service_client_query(hci_con_handle_t con_handle, btstack_packet_handler_t packet_handler); 91 92 93 /** 94 * @brief De-initialize Device Information Service. 95 */ 96 void device_information_service_client_deinit(void); 97 98 /* API_END */ 99 100 #if defined __cplusplus 101 } 102 #endif 103 104 #endif 105