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	cmake: increase minimal required version to 3.20.0	2021-08-20 09:47:34 +02:00
prj.conf	sensors: Remove unnecessary Kconfig setting of sensors	2022-07-25 15:18:56 +02:00
README.rst	samples/shields: add samples to test x-nucleo-iks02a1 shield	2020-05-06 10:33:07 -05:00
sample.yaml	boards: Exclude boards from shield samples	2022-06-28 15:51:55 +02:00

README.rst

.. _x-nucleo-iks02a1-std-sample:

X-NUCLEO-IKS02A1 shield: Standard (Mode 1) sample
#################################################

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

This sample enables all sensors of a X-NUCLEO-IKS02A1 shield, and then
periodically reads and displays data from the shield sensors:

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

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:

- :file:`$ZEPHYR_BASE/boards/arm/nucleo_f401re/nucleo_f401re.dts`
- :file:`$ZEPHYR_BASE/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/standard/
   :host-os: unix
   :board: nucleo_f401re
   :goals: build
   :compact:

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

 .. code-block:: console

    X-NUCLEO-IKS02A1 sensor Mode 1 dashboard

    IIS2DLPC: Accel (m.s-2): x: 0.000, y: 0.000, z: 9.342
    IIS2MDC: Magn (gauss): x: -0.120, y: -0.095, z: -0.338
    IIS2MDC: Temperature: 25.1 C
    ISM330DHCX: Accel (m.s-2): x: 0.182, y: -0.306, z: 9.753
    ISM330DHCX: GYro (dps): x: 0.005, y: 0.001, z: -0.004
    5:: iis2dlpc trig 809
    5:: ism330dhcx acc trig 3332
    5:: ism330dhcx gyr trig 1666

    <updated endlessly every 2 seconds>