zephyr/samples/sensor/fxas21002
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
README.rst
prj.conf
sample.yaml

README.rst

.. _fxas21002:

FXAS21002 Gyroscope Sensor
##########################

Overview
********

A sensor application that demonstrates how to use the fxas21002 data ready
interrupt to read gyroscope data synchronously.

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

This project outputs sensor data to the console. It requires an fxas21002
sensor, which is present on the :ref:`hexiwear_k64` board. It does not work on
QEMU.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/fxas21002
   :board: hexiwear_k64
   :goals: build
   :compact:

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

.. code-block:: console

   X=    -2.063 Y=     0.813 Z=     0.188
   X=    -1.750 Y=     1.063 Z=     0.063
   X=    -2.000 Y=     0.625 Z=     0.063
   X=    -2.188 Y=     0.625 Z=     0.188
   X=    -2.125 Y=     1.313 Z=    -0.063
   X=    -2.188 Y=     1.188 Z=     0.313

<repeats endlessly>