xref: /btstack/example/gatt_battery_query.c (revision 80e33422a96c028b3a9c308fc4b9b874712dafb4)
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 #define __BTSTACK_FILE__ "gatt_battery_query.c"
39 
40 // *****************************************************************************
41 //
42 // BLE Client
43 //
44 // *****************************************************************************
45 
46 #include <stdint.h>
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 
51 #include "btstack.h"
52 
53 // gatt_battery_query.gatt contains the declaration of the provided GATT Services + Characteristics
54 // gatt_battery_query.h    contains the binary representation of gatt_battery_query.gatt
55 // it is generated by the build system by calling: $BTSTACK_ROOT/tool/compile_gatt.py gatt_battery_query.gatt gatt_battery_query.h
56 // it needs to be regenerated when the GATT Database declared in gatt_battery_query.gatt file is modified
57 #include "gatt_battery_query.h"
58 
59 typedef struct advertising_report {
60     uint8_t   type;
61     uint8_t   event_type;
62     uint8_t   address_type;
63     bd_addr_t address;
64     uint8_t   rssi;
65     uint8_t   length;
66     const uint8_t * data;
67 } advertising_report_t;
68 
69 
70 typedef enum {
71     TC_IDLE,
72     TC_W4_SCAN_RESULT,
73     TC_W4_CONNECT,
74     TC_W4_SERVICE_RESULT,
75     TC_W4_CHARACTERISTIC_RESULT,
76     TC_W4_BATTERY_DATA
77 } gc_state_t;
78 
79 static int blacklist_index = 0;
80 static bd_addr_t blacklist[20];
81 static advertising_report_t report;
82 
83 static void handle_gatt_client_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
84 
85 static bd_addr_t cmdline_addr;
86 static int cmdline_addr_found = 0;
87 
88 static hci_con_handle_t connection_handle;
89 static uint16_t battery_service_uuid = 0x180F;
90 static uint16_t battery_level_characteristic_uuid = 0x2a19;
91 static gatt_client_service_t battery_service;
92 static gatt_client_characteristic_t config_characteristic;
93 
94 static gc_state_t state = TC_IDLE;
95 static btstack_packet_callback_registration_t hci_event_callback_registration;
96 
97 static void printUUID(uint8_t * uuid128, uint16_t uuid16){
98     if (uuid16){
99         printf("%04x",uuid16);
100     } else {
101         printf("%s", uuid128_to_str(uuid128));
102     }
103 }
104 
105 static int blacklist_size(void){
106     return sizeof(blacklist) / sizeof(bd_addr_t);
107 }
108 
109 static int blacklist_contains(bd_addr_t addr){
110     int i;
111     for (i=0; i<blacklist_size(); i++){
112         if (bd_addr_cmp(addr, blacklist[i]) == 0) return 1;
113     }
114     return 0;
115 }
116 
117 static void add_to_blacklist(bd_addr_t addr){
118     printf("%s added to blacklist (no battery service found\n", bd_addr_to_str(addr));
119     bd_addr_copy(blacklist[blacklist_index], addr);
120     blacklist_index = (blacklist_index + 1) % blacklist_size();
121 }
122 
123 static void dump_advertising_report(advertising_report_t * e){
124     printf("    * adv. event: evt-type %u, addr-type %u, addr %s, rssi %u, length adv %u, data: ", e->event_type,
125            e->address_type, bd_addr_to_str(e->address), e->rssi, e->length);
126     printf_hexdump(e->data, e->length);
127 
128 }
129 
130 static void dump_characteristic_value(uint8_t * blob, uint16_t blob_length){
131     printf("    * characteristic value of length %d *** ", blob_length );
132     printf_hexdump(blob , blob_length);
133     printf("\n");
134 }
135 
136 static void dump_characteristic(gatt_client_characteristic_t * characteristic){
137     printf("    * characteristic: [0x%04x-0x%04x-0x%04x], properties 0x%02x, uuid ",
138                             characteristic->start_handle, characteristic->value_handle, characteristic->end_handle, characteristic->properties);
139     printUUID(characteristic->uuid128, characteristic->uuid16);
140     printf("\n");
141 }
142 
143 static void dump_service(gatt_client_service_t * service){
144     printf("    * service: [0x%04x-0x%04x], uuid ", service->start_group_handle, service->end_group_handle);
145     printUUID(service->uuid128, service->uuid16);
146     printf("\n");
147 }
148 
149 
150 static void handle_gatt_client_event(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
151     UNUSED(packet_type);
152     UNUSED(channel);
153     UNUSED(size);
154 
155     int status;
156     uint8_t battery_level;
157 
158     switch(state){
159         case TC_W4_SERVICE_RESULT:
160             switch(hci_event_packet_get_type(packet)){
161                 case GATT_EVENT_SERVICE_QUERY_RESULT:
162                     gatt_event_service_query_result_get_service(packet, &battery_service);
163                     dump_service(&battery_service);
164                     break;
165                 case GATT_EVENT_QUERY_COMPLETE:
166                     if (packet[4] != 0){
167                         printf("SERVICE_QUERY_RESULT - Error status %x.\n", packet[4]);
168                         add_to_blacklist(report.address);
169                         gap_disconnect(connection_handle);
170                         break;
171                     }
172                     state = TC_W4_CHARACTERISTIC_RESULT;
173                     printf("\nSearch for battery level characteristic.\n");
174                     gatt_client_discover_characteristics_for_service_by_uuid16(handle_gatt_client_event, connection_handle, &battery_service, battery_level_characteristic_uuid);
175                     break;
176                 default:
177                     break;
178             }
179             break;
180 
181         case TC_W4_CHARACTERISTIC_RESULT:
182             switch(hci_event_packet_get_type(packet)){
183                 case GATT_EVENT_CHARACTERISTIC_QUERY_RESULT:
184                     gatt_event_characteristic_query_result_get_characteristic(packet, &config_characteristic);
185                     dump_characteristic(&config_characteristic);
186                     break;
187                 case GATT_EVENT_QUERY_COMPLETE:
188                     if (packet[4] != 0){
189                         printf("CHARACTERISTIC_QUERY_RESULT - Error status %x.\n", packet[4]);
190                         add_to_blacklist(report.address);
191                         gap_disconnect(connection_handle);
192                         break;
193                     }
194                     state = TC_W4_BATTERY_DATA;
195                     printf("\nConfigure battery level characteristic for notify.\n");
196                     status = gatt_client_write_client_characteristic_configuration(handle_gatt_client_event, connection_handle, &config_characteristic, GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION);
197                     if (status != 0){
198                         printf("\nNotification not supported. Query value of characteristic.\n");
199                         gatt_client_read_value_of_characteristic(handle_gatt_client_event, connection_handle, &config_characteristic);
200                     }
201 
202                     break;
203                 default:
204                     break;
205             }
206             break;
207         case TC_W4_BATTERY_DATA:
208             switch(hci_event_packet_get_type(packet)){
209                 case GATT_EVENT_NOTIFICATION:
210                     printf("\nBattery Data:\n");
211                     dump_characteristic_value(&packet[8], little_endian_read_16(packet, 6));
212                     break;
213                 case GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT:
214 
215                         if (gatt_event_characteristic_value_query_result_get_value_length(packet) < 1) break;
216                         battery_level = gatt_event_characteristic_value_query_result_get_value(packet)[0];
217                         printf("Battery level %d \n", battery_level);
218                     break;
219 
220                 case GATT_EVENT_QUERY_COMPLETE:
221                     if (packet[4] != 0){
222                         printf("CHARACTERISTIC_VALUE_QUERY_RESULT - Error status %x.\n", packet[4]);
223                         break;
224                     }
225                     break;
226                 default:
227                     printf("Unknown packet type %x\n", hci_event_packet_get_type(packet));
228                     break;
229             }
230             break;
231 
232         default:
233             printf("error\n");
234             break;
235     }
236 
237 }
238 
239 static void fill_advertising_report_from_packet(advertising_report_t * adv_report, uint8_t *packet){
240     gap_event_advertising_report_get_address(packet, adv_report->address);
241     adv_report->event_type = gap_event_advertising_report_get_advertising_event_type(packet);
242     adv_report->address_type = gap_event_advertising_report_get_address_type(packet);
243     adv_report->rssi = gap_event_advertising_report_get_rssi(packet);
244     adv_report->length = gap_event_advertising_report_get_data_length(packet);
245     adv_report->data = gap_event_advertising_report_get_data(packet);
246 }
247 
248 static void hci_event_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
249     UNUSED(channel);
250     UNUSED(size);
251 
252     if (packet_type != HCI_EVENT_PACKET) return;
253 
254     uint8_t event = hci_event_packet_get_type(packet);
255     switch (event) {
256         case BTSTACK_EVENT_STATE:
257             // BTstack activated, get started
258             if (btstack_event_state_get_state(packet) != HCI_STATE_WORKING) break;
259             if (cmdline_addr_found){
260                 printf("Connect to %s\n", bd_addr_to_str(cmdline_addr));
261                 state = TC_W4_CONNECT;
262                 gap_connect(cmdline_addr, 0);
263                 break;
264             }
265             printf("Start scanning!\n");
266             state = TC_W4_SCAN_RESULT;
267             gap_set_scan_parameters(0,0x0030, 0x0030);
268             gap_start_scan();
269             break;
270         case GAP_EVENT_ADVERTISING_REPORT:
271             if (state != TC_W4_SCAN_RESULT) return;
272             fill_advertising_report_from_packet(&report, packet);
273 
274             if (blacklist_contains(report.address)) {
275                 break;
276             }
277             dump_advertising_report(&report);
278             // stop scanning, and connect to the device
279             state = TC_W4_CONNECT;
280             gap_stop_scan();
281             printf("Stop scan. Connect to device with addr %s.\n", bd_addr_to_str(report.address));
282             gap_connect(report.address,report.address_type);
283 
284             break;
285         case HCI_EVENT_LE_META:
286             // wait for connection complete
287             if (hci_event_le_meta_get_subevent_code(packet) !=  HCI_SUBEVENT_LE_CONNECTION_COMPLETE) break;
288             if (state != TC_W4_CONNECT) return;
289             connection_handle = hci_subevent_le_connection_complete_get_connection_handle(packet);
290             // initialize gatt client context with handle, and add it to the list of active clients
291             // query primary services
292             printf("\nSearch for battery service.\n");
293             state = TC_W4_SERVICE_RESULT;
294             gatt_client_discover_primary_services_by_uuid16(handle_gatt_client_event, connection_handle, battery_service_uuid);
295             break;
296         case HCI_EVENT_DISCONNECTION_COMPLETE:
297 
298             if (cmdline_addr_found){
299                 printf("\nDisconnected %s\n", bd_addr_to_str(cmdline_addr));
300                 return;
301             }
302 
303             printf("\nDisconnected %s\n", bd_addr_to_str(report.address));
304             printf("Restart scan.\n");
305             state = TC_W4_SCAN_RESULT;
306             gap_start_scan();
307             break;
308         default:
309             break;
310     }
311 }
312 
313 #ifdef HAVE_BTSTACK_STDIN
314 static void usage(const char *name){
315     fprintf(stderr, "\nUsage: %s [-a|--address aa:bb:cc:dd:ee:ff]\n", name);
316     fprintf(stderr, "If no argument is provided, GATT browser will start scanning and connect to the first found device.\nTo connect to a specific device use argument [-a].\n\n");
317 }
318 #endif
319 
320 int btstack_main(int argc, const char * argv[]);
321 int btstack_main(int argc, const char * argv[]){
322 
323 #ifdef HAVE_BTSTACK_STDIN
324     int arg = 1;
325     cmdline_addr_found = 0;
326 
327     while (arg < argc) {
328         if(!strcmp(argv[arg], "-a") || !strcmp(argv[arg], "--address")){
329             arg++;
330             cmdline_addr_found = sscanf_bd_addr(argv[arg], cmdline_addr);
331             arg++;
332             if (!cmdline_addr_found) exit(1);
333             continue;
334         }
335         usage(argv[0]);
336         return 0;
337     }
338 #else
339     (void)argc;
340     (void)argv;
341 #endif
342     l2cap_init();
343 
344     // setup ATT server - only needed if LE Peripheral does ATT queries on its own, e.g. Android phones
345     att_server_init(profile_data, NULL, NULL);
346 
347     // GATT Client setup
348     gatt_client_init();
349 
350     sm_init();
351     sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT);
352 
353     hci_event_callback_registration.callback = &hci_event_handler;
354     hci_add_event_handler(&hci_event_callback_registration);
355 
356 
357     // turn on!
358     hci_power_control(HCI_POWER_ON);
359 
360     return 0;
361 }
362 
363 
364 
365 
366