gatt-service/bas_server: multiple instances

src/ble/gatt-service/battery_service_v1.gatt

@@ -0,0 +1,19 @@
+// Specification Type org.bluetooth.service.battery_service
+// https://www.bluetooth.com/api/gatt/xmlfile?xmlFileName=org.bluetooth.service.battery_service.xml
+// Bluetooth Specification v1.1
+
+// Battery Service 180F
+PRIMARY_SERVICE, ORG_BLUETOOTH_SERVICE_BATTERY_SERVICE
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL,              DYNAMIC | READ | NOTIFY,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL_STATUS,       DYNAMIC | READ | NOTIFY | INDICATE | BROADCAST,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_ESTIMATED_SERVICE_DATE,     DYNAMIC | READ | NOTIFY | INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_CRITCAL_STATUS,     DYNAMIC | READ |          INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_ENERGY_STATUS,      DYNAMIC | READ | NOTIFY | INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_TIME_STATUS,        DYNAMIC | READ | NOTIFY | INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_HEALTH_STATUS,      DYNAMIC | READ | NOTIFY | INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_HEALTH_INFORMATION, DYNAMIC | READ |          INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_INFORMATION,        DYNAMIC | READ |          INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_MANUFACTURER_NAME_STRING,   DYNAMIC | READ |          INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_MODEL_NUMBER_STRING,        DYNAMIC | READ |          INDICATE,
+CHARACTERISTIC, ORG_BLUETOOTH_CHARACTERISTIC_SERIAL_NUMBER_STRING,       DYNAMIC | READ |          INDICATE,
+

src/ble/gatt-service/battery_service_v1_server.c

@@ -0,0 +1,291 @@
+/*
+ * Copyright (C) 2014 BlueKitchen GmbH
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the copyright holders nor the names of
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ * 4. Any redistribution, use, or modification is done solely for
+ *    personal benefit and not for any commercial purpose or for
+ *    monetary gain.
+ *
+ * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
+ * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * Please inquire about commercial licensing options at 
+ * contact@bluekitchen-gmbh.com
+ *
+ */
+
+#define BTSTACK_FILE__ "battery_service_v1_server.c"
+
+/**
+ * Implementation of the GATT Battery Service Server 
+ * To use with your application, add `#import <battery_service.gatt>` to your .gatt file
+ */
+
+#include "btstack_defines.h"
+#include "ble/att_db.h"
+#include "ble/att_server.h"
+#include "btstack_util.h"
+#include "bluetooth_gatt.h"
+#include "btstack_debug.h"
+
+#define BS_CONNECTIONS_MAX_NUM 10
+#include "ble/gatt-service/battery_service_v1_server.h"
+
+#define BATTERY_SERVICE_TASK_BATTERY_VALUE_CHANGED                          0x0001
+
+static btstack_linked_list_t battery_services;
+
+
+static battery_service_v1_server_connection_t * battery_service_server_connection_for_con_handle(battery_service_v1_t * service, hci_con_handle_t con_handle){
+    if (service == NULL){
+        return NULL;
+    }
+
+    uint8_t i;
+    for (i = 0; i < service->connections_max_num; i++){
+        if (service->connections[i].con_handle == con_handle){
+            return &service->connections[i];
+        }
+    }
+    return NULL;
+}
+
+static battery_service_v1_server_connection_t * battery_service_server_add_connection_for_con_handle(battery_service_v1_t * service, hci_con_handle_t con_handle){
+    if (service == NULL){
+        return NULL;
+    }
+
+    uint8_t i;
+    for (i = 0; i < service->connections_max_num; i++){
+        if (service->connections[i].con_handle == HCI_CON_HANDLE_INVALID){
+            service->connections[i].con_handle = con_handle;
+            service->connections[i].service = service;
+            return &service->connections[i];
+        }
+    }
+    return NULL;
+}
+
+
+static battery_service_v1_t * battery_service_service_for_attribute_handle(uint16_t attribute_handle){
+    btstack_linked_list_iterator_t it;    
+    btstack_linked_list_iterator_init(&it, &battery_services);
+    while (btstack_linked_list_iterator_has_next(&it)){
+        battery_service_v1_t * item = (battery_service_v1_t*) btstack_linked_list_iterator_next(&it);
+        if (attribute_handle < item->start_handle) continue;
+        if (attribute_handle > item->end_handle)   continue;
+        return item;
+    }
+    return NULL;
+}
+
+
+static battery_service_v1_t * battery_service_service_for_con_handle(hci_con_handle_t con_handle){
+    btstack_linked_list_iterator_t it;    
+    btstack_linked_list_iterator_init(&it, &battery_services);
+    while (btstack_linked_list_iterator_has_next(&it)){
+        battery_service_v1_t * service = (battery_service_v1_t*) btstack_linked_list_iterator_next(&it);
+        uint8_t i;
+        for (i = 0; i < service->connections_max_num; i++){
+            if (service->connections[i].con_handle == con_handle){
+                return service;
+            }
+        }
+    }
+    return NULL;
+}
+
+
+static uint16_t battery_service_read_callback(hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t offset, uint8_t * buffer, uint16_t buffer_size){
+    UNUSED(con_handle);
+
+    battery_service_v1_t * service = battery_service_service_for_attribute_handle(attribute_handle);
+    if (service == NULL){
+        return 0;
+    }
+
+    battery_service_v1_server_connection_t * connection = battery_service_server_connection_for_con_handle(service, con_handle);
+    if (connection == NULL){
+        connection = battery_service_server_add_connection_for_con_handle(service, con_handle);
+        if (connection == NULL){
+            return 0;
+        }
+    }
+
+    if (attribute_handle == service->battery_value_handle){
+        return att_read_callback_handle_byte(service->battery_value, offset, buffer, buffer_size);
+    }
+    if (attribute_handle == service->battery_value_client_configuration_handle){
+        return att_read_callback_handle_little_endian_16(connection->battery_value_client_configuration, offset, buffer, buffer_size);
+    }
+    return 0;
+}
+
+static int battery_service_write_callback(hci_con_handle_t con_handle, uint16_t attribute_handle, uint16_t transaction_mode, uint16_t offset, uint8_t *buffer, uint16_t buffer_size){
+    UNUSED(offset);
+    UNUSED(buffer_size);
+
+    if (transaction_mode != ATT_TRANSACTION_MODE_NONE){
+        return 0;
+    }
+
+    battery_service_v1_t * service = battery_service_service_for_attribute_handle(attribute_handle);
+    if (service == NULL){
+        return 0;
+    }
+
+    battery_service_v1_server_connection_t * connection = battery_service_server_connection_for_con_handle(service, con_handle);
+    if (connection == NULL){
+        connection = battery_service_server_add_connection_for_con_handle(service, con_handle);
+        if (connection == NULL){
+            return 0;
+        }
+    }
+
+    if (attribute_handle == service->battery_value_client_configuration_handle){
+        connection->battery_value_client_configuration = little_endian_read_16(buffer, 0);
+    }
+    return 0;
+}
+
+static void battery_service_can_send_now(void * context){
+    battery_service_v1_server_connection_t * connection = (battery_service_v1_server_connection_t *) context;
+    if (connection == NULL){
+        return;
+    }
+    battery_service_v1_t * service = connection->service;
+    if (service == NULL){
+        return;
+    }
+
+    if ( (connection->scheduled_tasks & BATTERY_SERVICE_TASK_BATTERY_VALUE_CHANGED) > 0u){
+        connection->scheduled_tasks &= ~BATTERY_SERVICE_TASK_BATTERY_VALUE_CHANGED;
+        att_server_notify(connection->con_handle, service->battery_value_handle, &service->battery_value, 1);
+    }
+
+    if (connection->scheduled_tasks > 0u){
+        att_server_register_can_send_now_callback(&connection->scheduled_tasks_callback, connection->con_handle);
+    }
+}
+
+void battery_service_v1_server_init(void){
+
+}
+
+void battery_service_v1_server_register(battery_service_v1_t *service, battery_service_v1_server_connection_t *connections, uint8_t connection_max_num){
+    btstack_assert(service != NULL);
+    btstack_assert(connections != NULL);
+    btstack_assert(connection_max_num > 0u);
+
+    // get service handle range
+    uint16_t end_handle   = 0xffff;
+    uint16_t start_handle = 0;
+
+    btstack_linked_list_iterator_t it;    
+    btstack_linked_list_iterator_init(&it, &battery_services);
+    while (btstack_linked_list_iterator_has_next(&it)){
+        battery_service_v1_t * service = (battery_service_v1_t*) btstack_linked_list_iterator_next(&it);
+        if (service->end_handle > start_handle){
+            start_handle = service->end_handle + 1;
+        }
+    }
+
+    int service_found = gatt_server_get_handle_range_for_service_with_uuid16(ORG_BLUETOOTH_SERVICE_BATTERY_SERVICE, &start_handle, &end_handle);
+    btstack_assert(service_found != 0);
+    UNUSED(service_found);
+
+    service->start_handle = start_handle;
+    service->end_handle   = end_handle;
+
+    // get characteristic value handle and client configuration handle
+    service->battery_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL);
+    service->battery_value_client_configuration_handle = gatt_server_get_client_configuration_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL);
+
+    memset(connections, 0, sizeof(battery_service_v1_server_connection_t) * connection_max_num);
+    uint8_t i;
+    for (i = 0; i < connection_max_num; i++){
+        connections[i].con_handle = HCI_CON_HANDLE_INVALID;
+    }
+    service->connections_max_num = connection_max_num;
+    service->connections = connections;
+    
+
+    service->service_handler.read_callback  = &battery_service_read_callback;
+    service->service_handler.write_callback = &battery_service_write_callback;
+    att_server_register_service_handler(&service->service_handler);
+
+    log_info("Found Battery Service 0x%02x-0x%02x", start_handle, end_handle);
+
+    btstack_linked_list_add(&battery_services, (btstack_linked_item_t *) service);
+}
+
+
+static void battery_service_set_callback(battery_service_v1_server_connection_t * connection, uint8_t task){
+    if (connection->con_handle == HCI_CON_HANDLE_INVALID){
+        connection->scheduled_tasks = 0;
+        return;
+    }
+
+    uint8_t scheduled_tasks = connection->scheduled_tasks;
+    connection->scheduled_tasks |= task;
+    if (scheduled_tasks == 0){
+        connection->scheduled_tasks_callback.callback = &battery_service_can_send_now;
+        connection->scheduled_tasks_callback.context  = (void*) connection;
+        att_server_register_can_send_now_callback(&connection->scheduled_tasks_callback, connection->con_handle);
+    }
+}
+
+
+void battery_service_v1_server_set_battery_value(battery_service_v1_t * service, uint8_t value){
+    btstack_assert(service != NULL);
+    if (service->battery_value == value){
+        return;
+    }
+
+    service->battery_value = value;
+
+    uint8_t i;
+    for (i = 0; i < service->connections_max_num; i++){
+        battery_service_v1_server_connection_t * connection = &service->connections[i];
+        if (connection->battery_value_client_configuration != 0){
+            battery_service_set_callback(connection, BATTERY_SERVICE_TASK_BATTERY_VALUE_CHANGED);
+        }
+    }
+}
+
+void battery_service_v1_server_deregister(battery_service_v1_t *service){
+    btstack_linked_list_iterator_remove((btstack_linked_item_t * )service);
+    // TODO cansel can send now 
+}
+
+void battery_service_v1_server_deinit(void){
+    // deregister listeners
+    // empty list
+    btstack_linked_list_iterator_t it;    
+    btstack_linked_list_iterator_init(&it, &battery_services);
+    while (btstack_linked_list_iterator_has_next(&it)){
+        battery_service_v1_t * service = (battery_service_v1_t*) btstack_linked_list_iterator_next(&it);
+        battery_service_v1_server_deregister(service);       
+    }
+}

src/ble/gatt-service/battery_service_v1_server.h

@@ -0,0 +1,121 @@
+/*
+ * Copyright (C) 2024 BlueKitchen GmbH
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the copyright holders nor the names of
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ * 4. Any redistribution, use, or modification is done solely for
+ *    personal benefit and not for any commercial purpose or for
+ *    monetary gain.
+ *
+ * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
+ * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+ * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ * Please inquire about commercial licensing options at 
+ * contact@bluekitchen-gmbh.com
+ *
+ */
+
+/**
+ * @title Battery Service Server v1.1
+ * 
+ */
+
+#ifndef BATTERY_SERVICE_V1_SERVER_H
+#define BATTERY_SERVICE_V1_SERVER_H
+
+#include <stdint.h>
+
+#if defined __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @text The Battery Service allows to query your device's battery level in a standardized way.
+ * 
+ * To use with your application, add `#import <battery_service.gatt>` to your .gatt file. 
+ * After adding it to your .gatt file, you call *battery_service_server_init(value)* with the
+ * current value of your battery. The valid range for the battery level is 0-100.
+ *
+ * If the battery level changes, you can call *battery_service_server_set_battery_value(value)*. 
+ * The service supports sending Notifications if the client enables them.
+ */
+struct battery_service_v1;
+
+typedef struct {
+    hci_con_handle_t con_handle;
+
+    btstack_context_callback_registration_t  scheduled_tasks_callback;
+    uint8_t scheduled_tasks;
+
+    // ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL
+    uint16_t battery_value_client_configuration;
+    struct battery_service_v1 * service;
+} battery_service_v1_server_connection_t;
+
+
+typedef struct battery_service_v1 {
+    btstack_linked_item_t item;
+
+    // service
+    uint16_t start_handle;
+    uint16_t end_handle;
+    uint8_t index;
+
+    att_service_handler_t    service_handler;
+
+    // ORG_BLUETOOTH_CHARACTERISTIC_BATTERY_LEVEL
+    uint16_t battery_value_handle;
+    uint16_t battery_value_client_configuration_handle;
+    uint8_t  battery_value;
+
+    uint8_t connections_max_num;
+    battery_service_v1_server_connection_t * connections;
+} battery_service_v1_t;
+
+/* API_START */
+
+/**
+ * @brief Init Battery Service Server with ATT DB
+ */
+void battery_service_v1_server_init(void);
+
+void battery_service_v1_server_register(battery_service_v1_t *service, battery_service_v1_server_connection_t *connections, uint8_t connection_max_num);
+
+void battery_service_v1_server_deregister(battery_service_v1_t *service);
+/**
+ * @brief Update battery value
+ * @note triggers notifications if subscribed
+ * @param battery_value in range 0-100
+ */
+void battery_service_v1_server_set_battery_value(battery_service_v1_t * service, uint8_t value);
+
+void battery_service_v1_server_deinit(void);
+
+/* API_END */
+
+#if defined __cplusplus
+}
+#endif
+
+#endif
+