zephyr/samples/sensor/sht3xd/README.rst

53 lines
1.5 KiB
ReStructuredText

.. zephyr:code-sample:: sht3xd
:name: SHT3XD humidity sensor
:relevant-api: sensor_interface
Get temperature and humidity from a SHT3XD sensor (polling & trigger mode).
Description
***********
This sample application periodically (2 Hz) measures the ambient
temperature and humidity. The result is written to the console.
Optionally, it also shows how to use the upper threshold triggers.
References
**********
- `SHT3X-DIS sensor <https://www.sensirion.com/en/environmental-sensors/humidity-sensors/digital-humidity-sensors-for-various-applications/>`_
Wiring
*******
This sample uses the SHT3X_DIS sensor controlled using the I2C interface.
Connect Supply: **VDD**, **GND** and Interface: **SDA**, **SCL**
and optionally connect the **ALERT** to a interrupt capable GPIO.
The supply voltage can be in the 2.15V to 5.5V range.
Depending on the baseboard used, the **SDA** and **SCL** lines require Pull-Up
resistors.
Building and Running
********************
This project outputs sensor data to the console. It requires a SHT3XD
sensor. It should work with any platform featuring a I2C peripheral
interface. It does not work on QEMU. In this example below the
:zephyr:board:`nrf51_ble400` board is used.
.. zephyr-app-commands::
:zephyr-app: samples/sensor/sht3xd
:board: nrf51_ble400
:goals: build flash
Sample Output
=============
.. code-block:: console
SHT3XD: 19.64 Cel ; 41.96 %RH
SHT3XD: 19.74 Cel ; 42.06 %RH
SHT3XD: 19.75 Cel ; 42.08 %RH
<repeats endlessly>