zephyr/samples/bluetooth/bthome_sensor_template
Benjamin Cabé d1858d2074 samples: bluetooth: Use "Bluetooth LE" terminology
Replace occurrences of "BLE" by the recommended "Bluetooth LE" term.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-05 16:58:32 -04:00
..
src
CMakeLists.txt
README.rst
prj.conf

README.rst

.. zephyr:code-sample:: bluetooth_bthome_sensor_template
   :name: BTHome sensor template
   :relevant-api: bluetooth

   Implement a BTHome sensor.

Overview
********

This code sample provides a template for implementing a `BTHome <https://bthome.io/>`_ sensor.

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

* A board with Bluetooth LE support
* A BTHome compatible listener, for example `Home Assistant <https://www.home-assistant.io/>`_ with the BTHome integration running.

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

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

See :ref:`bluetooth samples section <bluetooth-samples>` for details.

When the sample is running, navigate to Devices & Services under settings in Home
Assistant. There you will be asked to configure the BTHome sensor if everything
went well.