zephyr

History

Reto Schneider 7eabab2f5d samples, tests: Use semi-accurate project names When using an IDE (e.g. Eclipse, Qt Creator), the project name gets displayed. This greatly simplifies the navigation between projects when having many of them open at the same time. Naming every project "NONE" defeats this functionality. This patch tries to use sensible project names while not duplicating too much of what is already represented in the path. This is done by using the name of the directory the relevant CMakeLists.txt file is stored in. To ensure unique project names in the samples (and again, in the tests folder) folder, small manual adjustments have been done. Signed-off-by: Reto Schneider <code@reto-schneider.ch>		2018-10-27 21:31:25 -04:00
..
src	…
CMakeLists.txt	samples, tests: Use semi-accurate project names	2018-10-27 21:31:25 -04:00
README.rst	…
prj.conf	…
sample.yaml	…

README.rst

.. _bluetooth-ibeacon-sample:

Bluetooth: iBeacon
##################

Overview
********

This simple application demonstrates the BLE Broadcaster role
functionality by advertising an Apple iBeacon. The calibrated RSSI @ 1
meter distance can be set using an IBEACON_RSSI build variable
(e.g. IBEACON_RSSI=0xb8 for -72 dBm RSSI @ 1 meter), or by manually
editing the default value in the ``main.c`` file.

Because of the hard-coded values of iBeacon UUID, major, and minor,
the application is not suitable for production use, but is quite
convenient for quick demonstrations of iBeacon functionality.

Requirements
************

* A board with Bluetooth LE support, or
* QEMU with BlueZ running on the host

Building and Running
********************

This sample can be found under :file:`samples/bluetooth/ibeacon` in the
Zephyr tree.

See :ref:`bluetooth setup section <bluetooth_setup>` for details on how
to run the sample inside QEMU.

For other boards, build and flash the application as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/bluetooth/ibeacon
   :board: <board>
   :goals: flash
   :compact:

Refer to your :ref:`board's documentation <boards>` for alternative
flash instructions if your board doesn't support the ``flash`` target.