README.rst
1.. zephyr:code-sample:: x-nucleo-iks01a1
2 :name: X-NUCLEO-IKS01A1 shield
3 :relevant-api: sensor_interface
4
5 Interact with all the sensors of an X-NUCLEO-IKS01A1 shield.
6
7Overview
8********
9This sample enables all sensors of a X-NUCLEO-IKS01A1 shield, and then
10periodically reads and displays data from the shield sensors:
11
12- HTS221: Temperature and humidity
13- LPS25HB: Atmospheric pressure
14- LIS3MDL: 3-axis Magnetic field intensity
15- LSM6DSL: 3-Axis Acceleration
16
17Requirements
18************
19
20This sample communicates over I2C with the X-NUCLEO-IKS01A1 shield
21stacked on a board with an Arduino connector. The board's I2C must be
22configured for the I2C Arduino connector (both for pin muxing
23and devicetree).
24Please note that this sample can't be used with boards already supporting
25one of the sensors available on the shield (such as disco_l475_iot1) as zephyr
26does not yet support sensors multiple instances.
27
28References
29**********
30
31-X-NUCLEO-IKS01A1: https://www.st.com/en/ecosystems/x-nucleo-iks01a1.html
32
33Building and Running
34********************
35
36This sample runs with X-NUCLEO-IKS01A1 stacked on any board with a matching
37Arduino connector. For this example, we use a :ref:`nucleo_f429zi_board` board.
38
39.. zephyr-app-commands::
40 :zephyr-app: samples/shields/x_nucleo_iks01a1
41 :board: nucleo_f429zi
42 :goals: build
43 :compact:
44
45Sample Output
46=============
47
48 .. code-block:: console
49
50 X-NUCLEO-IKS01A1 sensor dashboard
51
52 HTS221: Temperature:29.1 C
53 HTS221: Relative Humidity:46.0%
54 LPS25HB: Pressure:100.0 kpa
55 LIS3MDL: Magnetic field (gauss): x: 0.1, y: -0.4, z: 0.4
56 LSM6DS0: Acceleration (m.s-2): x: -0.0, y: -0.1, z: 9.7
57
58
59 <updated endlessly every 2 seconds>
60
