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