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