1 /* 2 * Copyright (C) 2024 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 Battery Service Server v1.1 40 * 41 */ 42 43 #ifndef BATTERY_SERVICE_V1_SERVER_H 44 #define BATTERY_SERVICE_V1_SERVER_H 45 46 #include <stdint.h> 47 48 #if defined __cplusplus 49 extern "C" { 50 #endif 51 52 /** 53 * @text The Battery Service allows to query your device's battery level in a standardized way. 54 * 55 * To use with your application, add `#import <battery_service.gatt>` to your .gatt file. 56 * After adding it to your .gatt file, you call *battery_service_server_init(value)* with the 57 * current value of your battery. The valid range for the battery level is 0-100. 58 * 59 * If the battery level changes, you can call *battery_service_server_set_battery_value(value)*. 60 * The service supports sending Notifications if the client enables them. 61 */ 62 struct battery_service_v1; 63 64 typedef struct { 65 hci_con_handle_t con_handle; 66 67 btstack_context_callback_registration_t scheduled_tasks_callback; 68 uint8_t scheduled_tasks; 69 70 // ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL 71 uint16_t battery_value_client_configuration; 72 struct battery_service_v1 * service; 73 } battery_service_v1_server_connection_t; 74 75 76 typedef struct battery_service_v1 { 77 btstack_linked_item_t item; 78 79 // service 80 uint16_t start_handle; 81 uint16_t end_handle; 82 uint8_t index; 83 84 att_service_handler_t service_handler; 85 86 // ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL 87 uint16_t battery_value_handle; 88 uint16_t battery_value_client_configuration_handle; 89 uint8_t battery_value; 90 91 uint8_t connections_max_num; 92 battery_service_v1_server_connection_t * connections; 93 } battery_service_v1_t; 94 95 /* API_START */ 96 97 /** 98 * @brief Init Battery Service Server with ATT DB 99 */ 100 void battery_service_v1_server_init(void); 101 102 void battery_service_v1_server_register(battery_service_v1_t *service, battery_service_v1_server_connection_t *connections, uint8_t connection_max_num); 103 104 void battery_service_v1_server_deregister(battery_service_v1_t *service); 105 /** 106 * @brief Update battery value 107 * @note triggers notifications if subscribed 108 * @param battery_value in range 0-100 109 */ 110 void battery_service_v1_server_set_battery_value(battery_service_v1_t * service, uint8_t value); 111 112 void battery_service_v1_server_deinit(void); 113 114 /* API_END */ 115 116 #if defined __cplusplus 117 } 118 #endif 119 120 #endif 121 122