zephyr

History

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	sensors: Remove unnecessary Kconfig setting of sensors	2022-07-25 15:18:56 +02:00
sample.yaml	boards: Exclude boards from shield samples	2022-06-28 15:51:55 +02:00

README.rst

.. _x-nucleo-iks02a1-shub-sample:

X-NUCLEO-IKS02A1 shield: Sensorhub (Mode 2) sample
##################################################

Overview
********
This sample is provided as an example to test the X-NUCLEO-IKS02A1 shield
configured in Sensor Hub mode (Mode 2).
Please refer to :ref:`x-nucleo-iks02a1` for more info on this configuration.

This sample enables IIS2DLPC and ISM330DHCX sensors. Since all other shield
devices are connected to ISM330DHCX, the ISM330DHCX driver is configured in sensorhub
mode (CONFIG_ISM330DHCX_SENSORHUB=y) with the IIS2MDC magnetometer as external
slave.

Then sensor data are displayed periodically

- IIS2DLPC 3-Axis acceleration
- ISM330DHCX 6-Axis acceleration and angular velocity
- ISM330DHCX (from IIS2MDC) 3-Axis magnetic field intensity


Requirements
************

This sample communicates over I2C with the X-NUCLEO-IKS02A1 shield
stacked on a board with an Arduino connector. The board's I2C must be
configured for the I2C Arduino connector (both for pin muxing
and devicetree). See for example the :ref:`nucleo_f401re_board` board
source code:

- :zephyr_file:`boards/arm/nucleo_f401re/nucleo_f401re.dts`
- :zephyr_file:`boards/arm/nucleo_f401re/pinmux.c`

Please note that this sample can't be used with boards already supporting
one of the sensors available on the shield (such as disco_l475_iot1)
as sensors multiple instances are not supported.

References
**********

- X-NUCLEO-IKS02A1: http://www.st.com/en/ecosystems/x-nucleo-iks02a1.html

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

This sample runs with X-NUCLEO-IKS02A1 stacked on any board with a matching
Arduino connector. For this example, we use a :ref:`nucleo_f401re_board` board.

.. zephyr-app-commands::
   :zephyr-app: samples/shields/x_nucleo_iks02a1/sensorhub/
   :host-os: unix
   :board: nucleo_f401re
   :goals: build
   :compact:

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

 .. code-block:: console


    X-NUCLEO-IKS02A1 sensor Mode 2 dashboard

    IIS2DLPC: Accel (m.s-2): x: 0.077, y: -0.766, z: 9.878
    ISM330DHCX: Accel (m.s-2): x: 0.383, y: -0.234, z: 9.763
    ISM330DHCX: GYro (dps): x: 0.004, y: 0.003, z: -0.005
    ISM330DHCX: Magn (gauss): x: 0.171, y: 0.225, z: -0.363
    7:: iis2dlpc trig 1215
    7:: ism330dhcx acc trig 2494
    7:: ism330dhcx gyr trig 2494

    <updated endlessly every 2 seconds>