zephyr/samples/sensor/hts221/README.rst
Benjamin Cabé ee77704715 samples: sensor: use zephyr:code-sample directive
Describe the samples using code-sample directive in preparation for
upcoming changes to the Zephyr documentation that will be leveraging
the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-04 21:26:50 +02:00

50 lines
1.1 KiB
ReStructuredText

.. zephyr:code-sample:: hts221
:name: HTS221 Temperature and Humidity Monitor
:relevant-api: sensor_interface
Get temperature and humidity data from an HTS221 sensor (polling & trigger mode).
Overview
********
This sample periodically reads temperature and humidity from the HTS221
Temperature & Humidity Sensor and displays it on the console
Requirements
************
This sample uses the HTS221 sensor controlled using the I2C interface.
References
**********
- HTS211: https://www.st.com/en/mems-and-sensors/hts221.html
Building and Running
********************
This project outputs sensor data to the console. It requires an HTS221
sensor, which is present on the disco_l475_iot1 board.
.. zephyr-app-commands::
:zephyr-app: samples/sensor/hts221
:board: disco_l475_iot1
:goals: build
:compact:
Sample Output
=============
.. code-block:: console
Temperature:25.3 C
Relative Humidity:40%
Temperature:25.3 C
Relative Humidity:40%
Temperature:25.3 C
Relative Humidity:40%
Temperature:25.3 C
Relative Humidity:40%
<repeats endlessly every 2 seconds>