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__ "gap_le_advertisements.c" 39 40 41 // ***************************************************************************** 42 /* EXAMPLE_START(gap_le_advertisements): GAP LE Advertisements Dumper 43 * 44 * @text This example shows how to scan and parse advertisements. 45 * 46 */ 47 // ***************************************************************************** 48 49 50 #include <stdint.h> 51 #include <inttypes.h> 52 #include <stdio.h> 53 #include <stdlib.h> 54 #include <string.h> 55 56 #include "btstack.h" 57 58 static btstack_packet_callback_registration_t hci_event_callback_registration; 59 60 /* @section GAP LE setup for receiving advertisements 61 * 62 * @text GAP LE advertisements are received as custom HCI events of the 63 * GAP_EVENT_ADVERTISING_REPORT type. To receive them, you'll need to register 64 * the HCI packet handler, as shown in Listing GAPLEAdvSetup. 65 */ 66 67 /* LISTING_START(GAPLEAdvSetup): Setting up GAP LE client for receiving advertisements */ 68 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 69 70 static void gap_le_advertisements_setup(void){ 71 hci_event_callback_registration.callback = &packet_handler; 72 hci_add_event_handler(&hci_event_callback_registration); 73 // Active scanning, 100% (scan interval = scan window) 74 gap_set_scan_parameters(1,48,48); 75 gap_start_scan(); 76 } 77 78 /* LISTING_END */ 79 80 /* @section GAP LE Advertising Data Dumper 81 * 82 * @text Here, we use the definition of advertising data types and flags as specified in 83 * [Assigned Numbers GAP](https://www.bluetooth.org/en-us/specification/assigned-numbers/generic-access-profile) 84 * and [Supplement to the Bluetooth Core Specification, v4](https://www.bluetooth.org/DocMan/handlers/DownloadDoc.ashx?doc_id=282152). 85 */ 86 87 /* LISTING_START(GAPLEAdvDataTypesAndFlags): Advertising data types and flags */ 88 static char * ad_types[] = { 89 "", 90 "Flags", 91 "Incomplete List of 16-bit Service Class UUIDs", 92 "Complete List of 16-bit Service Class UUIDs", 93 "Incomplete List of 32-bit Service Class UUIDs", 94 "Complete List of 32-bit Service Class UUIDs", 95 "Incomplete List of 128-bit Service Class UUIDs", 96 "Complete List of 128-bit Service Class UUIDs", 97 "Shortened Local Name", 98 "Complete Local Name", 99 "Tx Power Level", 100 "", 101 "", 102 "Class of Device", 103 "Simple Pairing Hash C", 104 "Simple Pairing Randomizer R", 105 "Device ID", 106 "Security Manager TK Value", 107 "Slave Connection Interval Range", 108 "", 109 "List of 16-bit Service Solicitation UUIDs", 110 "List of 128-bit Service Solicitation UUIDs", 111 "Service Data", 112 "Public Target Address", 113 "Random Target Address", 114 "Appearance", 115 "Advertising Interval" 116 }; 117 118 static char * flags[] = { 119 "LE Limited Discoverable Mode", 120 "LE General Discoverable Mode", 121 "BR/EDR Not Supported", 122 "Simultaneous LE and BR/EDR to Same Device Capable (Controller)", 123 "Simultaneous LE and BR/EDR to Same Device Capable (Host)", 124 "Reserved", 125 "Reserved", 126 "Reserved" 127 }; 128 /* LISTING_END */ 129 130 /* @text BTstack offers an iterator for parsing sequence of advertising data (AD) structures, 131 * see [BLE advertisements parser API](../appendix/apis/#ble-advertisements-parser-api). 132 * After initializing the iterator, each AD structure is dumped according to its type. 133 */ 134 135 /* LISTING_START(GAPLEAdvDataParsing): Parsing advertising data */ 136 static void dump_advertisement_data(const uint8_t * adv_data, uint8_t adv_size){ 137 ad_context_t context; 138 bd_addr_t address; 139 uint8_t uuid_128[16]; 140 for (ad_iterator_init(&context, adv_size, (uint8_t *)adv_data) ; ad_iterator_has_more(&context) ; ad_iterator_next(&context)){ 141 uint8_t data_type = ad_iterator_get_data_type(&context); 142 uint8_t size = ad_iterator_get_data_len(&context); 143 const uint8_t * data = ad_iterator_get_data(&context); 144 145 if (data_type > 0 && data_type < 0x1B){ 146 printf(" %s: ", ad_types[data_type]); 147 } 148 int i; 149 // Assigned Numbers GAP 150 151 switch (data_type){ 152 case BLUETOOTH_DATA_TYPE_FLAGS: 153 // show only first octet, ignore rest 154 for (i=0; i<8;i++){ 155 if (data[0] & (1<<i)){ 156 printf("%s; ", flags[i]); 157 } 158 159 } 160 break; 161 case BLUETOOTH_DATA_TYPE_INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS: 162 case BLUETOOTH_DATA_TYPE_COMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS: 163 case BLUETOOTH_DATA_TYPE_LIST_OF_16_BIT_SERVICE_SOLICITATION_UUIDS: 164 for (i=0; i<size;i+=2){ 165 printf("%02X ", little_endian_read_16(data, i)); 166 } 167 break; 168 case BLUETOOTH_DATA_TYPE_INCOMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS: 169 case BLUETOOTH_DATA_TYPE_COMPLETE_LIST_OF_32_BIT_SERVICE_CLASS_UUIDS: 170 case BLUETOOTH_DATA_TYPE_LIST_OF_32_BIT_SERVICE_SOLICITATION_UUIDS: 171 for (i=0; i<size;i+=4){ 172 printf("%04"PRIX32, little_endian_read_32(data, i)); 173 } 174 break; 175 case BLUETOOTH_DATA_TYPE_INCOMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS: 176 case BLUETOOTH_DATA_TYPE_COMPLETE_LIST_OF_128_BIT_SERVICE_CLASS_UUIDS: 177 case BLUETOOTH_DATA_TYPE_LIST_OF_128_BIT_SERVICE_SOLICITATION_UUIDS: 178 reverse_128(data, uuid_128); 179 printf("%s", uuid128_to_str(uuid_128)); 180 break; 181 case BLUETOOTH_DATA_TYPE_SHORTENED_LOCAL_NAME: 182 case BLUETOOTH_DATA_TYPE_COMPLETE_LOCAL_NAME: 183 for (i=0; i<size;i++){ 184 printf("%c", (char)(data[i])); 185 } 186 break; 187 case BLUETOOTH_DATA_TYPE_TX_POWER_LEVEL: 188 printf("%d dBm", *(int8_t*)data); 189 break; 190 case BLUETOOTH_DATA_TYPE_SLAVE_CONNECTION_INTERVAL_RANGE: 191 printf("Connection Interval Min = %u ms, Max = %u ms", little_endian_read_16(data, 0) * 5/4, little_endian_read_16(data, 2) * 5/4); 192 break; 193 case BLUETOOTH_DATA_TYPE_SERVICE_DATA: 194 printf_hexdump(data, size); 195 break; 196 case BLUETOOTH_DATA_TYPE_PUBLIC_TARGET_ADDRESS: 197 case BLUETOOTH_DATA_TYPE_RANDOM_TARGET_ADDRESS: 198 reverse_bd_addr(data, address); 199 printf("%s", bd_addr_to_str(address)); 200 break; 201 case BLUETOOTH_DATA_TYPE_APPEARANCE: 202 // https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.gap.appearance.xml 203 printf("%02X", little_endian_read_16(data, 0) ); 204 break; 205 case BLUETOOTH_DATA_TYPE_ADVERTISING_INTERVAL: 206 printf("%u ms", little_endian_read_16(data, 0) * 5/8 ); 207 break; 208 case BLUETOOTH_DATA_TYPE_3D_INFORMATION_DATA: 209 printf_hexdump(data, size); 210 break; 211 case BLUETOOTH_DATA_TYPE_MANUFACTURER_SPECIFIC_DATA: // Manufacturer Specific Data 212 break; 213 case BLUETOOTH_DATA_TYPE_CLASS_OF_DEVICE: 214 case BLUETOOTH_DATA_TYPE_SIMPLE_PAIRING_HASH_C: 215 case BLUETOOTH_DATA_TYPE_SIMPLE_PAIRING_RANDOMIZER_R: 216 case BLUETOOTH_DATA_TYPE_DEVICE_ID: 217 case BLUETOOTH_DATA_TYPE_SECURITY_MANAGER_OUT_OF_BAND_FLAGS: 218 default: 219 printf("Advertising Data Type 0x%2x not handled yet", data_type); 220 break; 221 } 222 printf("\n"); 223 } 224 printf("\n"); 225 } 226 /* LISTING_END */ 227 228 /* @section HCI packet handler 229 * 230 * @text The HCI packet handler has to start the scanning, 231 * and to handle received advertisements. Advertisements are received 232 * as HCI event packets of the GAP_EVENT_ADVERTISING_REPORT type, 233 * see Listing GAPLEAdvPacketHandler. 234 */ 235 236 /* LISTING_START(GAPLEAdvPacketHandler): Scanning and receiving advertisements */ 237 238 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 239 UNUSED(channel); 240 UNUSED(size); 241 242 if (packet_type != HCI_EVENT_PACKET) return; 243 244 switch (hci_event_packet_get_type(packet)) { 245 case GAP_EVENT_ADVERTISING_REPORT:{ 246 bd_addr_t address; 247 gap_event_advertising_report_get_address(packet, address); 248 uint8_t event_type = gap_event_advertising_report_get_advertising_event_type(packet); 249 uint8_t address_type = gap_event_advertising_report_get_address_type(packet); 250 int8_t rssi = gap_event_advertising_report_get_rssi(packet); 251 uint8_t length = gap_event_advertising_report_get_data_length(packet); 252 const uint8_t * data = gap_event_advertising_report_get_data(packet); 253 254 printf("Advertisement event: evt-type %u, addr-type %u, addr %s, rssi %d, data[%u] ", event_type, 255 address_type, bd_addr_to_str(address), rssi, length); 256 printf_hexdump(data, length); 257 dump_advertisement_data(data, length); 258 break; 259 } 260 default: 261 break; 262 } 263 } 264 /* LISTING_END */ 265 266 int btstack_main(void); 267 int btstack_main(void) 268 { 269 gap_le_advertisements_setup(); 270 271 // turn on! 272 hci_power_control(HCI_POWER_ON); 273 274 return 0; 275 } 276 277 /* EXAMPLE_END */ 278