zephyr/samples/bluetooth/bthome_sensor_template/README.rst
Benjamin Cabé 1db9b009a7 doc: samples: Adopt code-sample-category across tree
This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00

28 lines
852 B
ReStructuredText

.. 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 :zephyr:code-sample-category:`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.