zephyr/samples/sensor/ams_iAQcore/README.rst
David B. Kinder 82d6347355 doc: fix broken file and zephyr-app refs
found some references to files (via :zephyr_file: and :zephyr-app:) that
were moved, so the links were broken

Fixes: #19660

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-10-08 15:42:32 -05:00

37 lines
974 B
ReStructuredText

.. _ams_iaqcore:
ams iAQcore Indoor air quality sensor
#####################################
Overview
********
This sample application demonstrates how to use the ams iAQcore sensor to
measure CO2 equivalent and VOC. The CO2 value is a predicted value derived from
VOC. The values are fetched and printed every second.
Building and Running
********************
This sample application uses the sensor connected to the i2c stated in the
iaq_core.overlay file.
Flash the binary to a board of choice with a sensor connected.
This sample can run on every board with i2c.
For example build for a nucleo_f446re board:
.. zephyr-app-commands::
:zephyr-app: samples/sensor/ams_iAQcore
:board: nucleo_f446re
:goals: build flash
:compact:
Sample Output
=============
.. code-block:: console
device is 0x20001a08, name is IAQ_CORE
Co2: 882.000000ppm; VOC: 244.000000ppb
Co2: 863.000000ppm; VOC: 239.000000ppb
Co2: 836.000000ppm; VOC: 232.000000ppb