zephyr/samples/sensor/accel_polling
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
prj.conf
README.rst
sample.yaml

.. _accel_polling:

Generic 3-Axis accelerometer polling sample
###########################################

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)