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