zephyr/samples/sensor/max30101
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
..
boards
src
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. zephyr:code-sample:: max30101
   :name: MAX30101 Heart Rate Sensor
   :relevant-api: sensor_interface

   Get heart rate data from a MAX30101 sensor (polling mode).

Overview
********

A sensor application that demonstrates how to poll data from the max30101 heart
rate sensor.

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

This project configures the max30101 sensor on the :ref:`hexiwear` board to
enable the green LED and measure the reflected light with a photodiode. The raw
ADC data prints to the console. Further processing (not included in this
sample) is required to extract a heart rate signal from the light measurement.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/max30101
   :board: hexiwear/mk64f12
   :goals: build
   :compact:

Sample Output
=============

.. code-block:: console

   GREEN=5731
   GREEN=5750
   GREEN=5748
   GREEN=5741
   GREEN=5735
   GREEN=5737
   GREEN=5736
   GREEN=5748

<repeats endlessly>