zephyr/samples/sensor/accel_polling
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
..
src
CMakeLists.txt
README.rst samples: sensor: use zephyr:code-sample directive 2024-09-04 21:26:50 +02:00
prj.conf
sample.yaml

README.rst

.. zephyr:code-sample:: accel_polling
   :name: Generic 3-Axis accelerometer polling
   :relevant-api: sensor_interface

   Get 3-Axis accelerometer data from a sensor (polling mode).

Overview
********

This sample application demonstrates how to use 3-Axis accelerometers.

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

This sample supports up to 10 3-Axis accelerometers. Each accelerometer needs
to be aliased as ``accelN`` where ``N`` goes from ``0`` to ``9``. For example:

.. code-block:: devicetree

  / {
  	aliases {
  			accel0 = &lis2dh;
  		};
  	};

Make sure the aliases are in devicetree, then build and run with:

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/accel_polling
   :board: <board to use>
   :goals: build flash
   :compact:

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

.. code-block:: console

       lis2dh@19 [m/s^2]:    (  -6.013728,   -3.064320,    7.277760)
       lis2dh@19 [m/s^2]:    (  -6.128640,   -3.026016,    7.201152)
       lis2dh@19 [m/s^2]:    (  -6.090336,   -3.064320,    7.162848)
       lis2dh@19 [m/s^2]:    (  -6.128640,   -3.026016,    7.354368)
       lis2dh@19 [m/s^2]:    (  -6.166944,   -3.102624,    7.277760)
       lis2dh@19 [m/s^2]:    (  -6.128640,   -2.987712,    7.277760)
       lis2dh@19 [m/s^2]:    (  -6.052032,   -2.987712,    7.277760)
       lis2dh@19 [m/s^2]:    (  -6.166944,   -2.987712,    7.239456)
       lis2dh@19 [m/s^2]:    (  -6.090336,   -3.026016,    7.201152)