README.rst
1.. zephyr:code-sample:: bluetooth_ibeacon
2 :name: iBeacon
3 :relevant-api: bluetooth
4
5 Advertise an Apple iBeacon using GAP Broadcaster role.
6
7Overview
8********
9
10This simple application demonstrates the GAP Broadcaster role
11functionality by advertising an Apple iBeacon. The calibrated RSSI @ 1
12meter distance can be set using an IBEACON_RSSI build variable
13(e.g. IBEACON_RSSI=0xb8 for -72 dBm RSSI @ 1 meter), or by manually
14editing the default value in the ``main.c`` file.
15
16Because of the hard-coded values of iBeacon UUID, major, and minor,
17the application is not suitable for production use, but is quite
18convenient for quick demonstrations of iBeacon functionality.
19
20Requirements
21************
22
23* A board with Bluetooth LE support, or
24* QEMU with BlueZ running on the host
25
26Building and Running
27********************
28
29This sample can be found under :zephyr_file:`samples/bluetooth/ibeacon` in the
30Zephyr tree.
31
32See :zephyr:code-sample-category:`bluetooth` samples for details on how
33to run the sample inside QEMU.
34
35For other boards, build and flash the application as follows:
36
37.. zephyr-app-commands::
38 :zephyr-app: samples/bluetooth/ibeacon
39 :board: <board>
40 :goals: flash
41 :compact:
42
43Refer to your :ref:`board's documentation <boards>` for alternative
44flash instructions if your board doesn't support the ``flash`` target.
45
