README.md
1| Supported Targets | ESP32 | ESP32-C3 |
2| ----------------- | ----- | -------- |
3
4# ESP-IDF Eddystone Example
5
6This example demonstrates Eddystone-compatible BLE scanning of eddystone frame, including UID and URL.
7
8Eddystone is an open beacon protocol specification from Google aimed at improving “proximity-based experiences”
9with support for both Android and iOS smart device platforms.
10
11Learn more on [Beacons](https://developers.google.com/nearby/notifications/get-started) and [Eddystone](https://github.com/google/eddystone).
12
13## How to Use Example
14
15Before project configuration and build, be sure to set the correct chip target using:
16
17```bash
18idf.py set-target <chip_name>
19```
20
21### Hardware Required
22
23* A development board with ESP32/ESP32-C3 SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.)
24* A USB cable for Power supply and programming
25
26See [Development Boards](https://www.espressif.com/en/products/devkits) for more information about it.
27
28### Build and Flash
29
30Run `idf.py -p PORT flash monitor` to build, flash and monitor the project.
31
32(To exit the serial monitor, type ``Ctrl-]``.)
33
34See the [Getting Started Guide](https://idf.espressif.com/) for full steps to configure and use ESP-IDF to build projects.
35
36## Example Output
37
38```
39I (0) cpu_start: Starting scheduler on APP CPU.
40I (585) BTDM_INIT: BT controller compile version [1342a48]
41I (585) system_api: Base MAC address is not set
42I (585) system_api: read default base MAC address from EFUSE
43I (595) phy_init: phy_version 4670,719f9f6,Feb 18 2021,17:07:07
44I (995) EDDYSTONE_DEMO: Register callback
45I (1005) EDDYSTONE_DEMO: Start scanning...
46I (18135) EDDYSTONE_DEMO: --------Eddystone Found----------
47I (18145) EDDYSTONE_DEMO: Device address:: 55 5d 3b ea 11 88
48I (18145) EDDYSTONE_DEMO: RSSI of packet:-46 dbm
49I (18145) EDDYSTONE_DEMO: Eddystone UID inform:
50I (18155) EDDYSTONE_DEMO: Measured power(RSSI at 0m distance):-65 dbm
51I (18155) EDDYSTONE_DEMO: EDDYSTONE_DEMO: Namespace ID:0x
52I (18165) EDDYSTONE_DEMO: 6e a8 0f c9 3b 13 8e 6d 91 78
53I (18175) EDDYSTONE_DEMO: EDDYSTONE_DEMO: Instance ID:0x
54I (18175) EDDYSTONE_DEMO: 01 01 01 00 00 00
55I (18275) EDDYSTONE_DEMO: --------Eddystone Found----------
56I (18275) EDDYSTONE_DEMO: Device address:: 55 5d 3b ea 11 88
57I (18275) EDDYSTONE_DEMO: RSSI of packet:-46 dbm
58I (18285) EDDYSTONE_DEMO: Eddystone UID inform:
59I (18285) EDDYSTONE_DEMO: Measured power(RSSI at 0m distance):-65 dbm
60I (18295) EDDYSTONE_DEMO: EDDYSTONE_DEMO: Namespace ID:0x
61I (18295) EDDYSTONE_DEMO: 6e a8 0f c9 3b 13 8e 6d 91 78
62I (18305) EDDYSTONE_DEMO: EDDYSTONE_DEMO: Instance ID:0x
63I (18315) EDDYSTONE_DEMO: 01 01 01 00 00 00
64```
65
66## Troubleshooting
67
68For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
69
