zephyr

History

Anas Nashif a2fd7d70ec cleanup: include/: move misc/util.h to sys/util.h move misc/util.h to sys/util.h and create a shim for backward-compatibility. No functional changes to the headers. A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES. Related to #16539 Signed-off-by: Anas Nashif <anas.nashif@intel.com>		2019-06-27 22:55:49 -04:00
..
src	cleanup: include/: move misc/util.h to sys/util.h	2019-06-27 22:55:49 -04:00
CMakeLists.txt	license: cleanup: add SPDX Apache-2.0 license identifier	2019-04-07 08:45:22 -04:00
README.rst	cmake: dts: move to specifying shield on the command line	2019-01-18 13:20:59 -06:00
prj.conf	cmake: dts: move to specifying shield on the command line	2019-01-18 13:20:59 -06:00
sample.yaml	samples: add test identifier	2019-03-29 17:44:11 -04:00

README.rst

.. _x-nucleo-iks01a1-sample:

X-NUCLEO-IKS01A1: MEMS inertial and environmental multi-sensor shield
#####################################################################

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

- HTS221: Temperature and humidity
- LPS25HB: Atmospheric pressure
- LIS3MDL: 3-axis Magnetic field intensity
- LSM6DSL: 3-Axis Acceleration

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

This sample communicates over I2C with the X-NUCLEO-IKS01A1 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 device tree).
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 zephyr
does not yet support sensors multiple instances.

References
**********

-X-NUCLEO-IKS01A1: http://www.st.com/en/ecosystems/x-nucleo-iks01a1.html

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

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

.. zephyr-app-commands::
   :zephyr-app: samples/shields/x_nucleo_iks01a1
   :board: nucleo_f429zi
   :goals: build
   :compact:

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

 .. code-block:: console

    X-NUCLEO-IKS01A1 sensor dashboard

    HTS221: Temperature:29.1 C
    HTS221: Relative Humidity:46.0%
    LPS25HB: Pressure:100.0 kpa
    LIS3MDL: Magnetic field (gauss): x: 0.1, y: -0.4, z: 0.4
    LSM6DS0: Acceleration (m.s-2): x: -0.0, y: -0.1, z: 9.7


    <updated endlessly every 2 seconds>