README.rst
1.. _x-nucleo-iks4a1-shub2-sample:
2
3X-NUCLEO-IKS4A1: shield SHUB2 (Mode 2) sample
4#############################################
5
6Overview
7********
8This sample is provided as an example to test the X-NUCLEO-IKS4A1 shield
9configured in Sensor Hub mode (Mode 2).
10Please refer to :ref:`x-nucleo-iks4a1-mode-2` for more info on this configuration.
11
12This sample enables LSM6DSO16IS IMU in sensorhub mode with LIS2MDL magnetometer and
13LPS22DF pressure and temperature sensor.
14
15Then sensor data are displayed periodically
16
17- LSM6DSO16IS 6-Axis acceleration and angular velocity
18- LSM6DSO16IS (from LIS2MDL) 3-Axis magnetic field intensity
19- LSM6DSO16IS (from LPS22DF) ambient temperature and atmospheric pressure
20
21Requirements
22************
23
24This sample communicates over I2C with the X-NUCLEO-IKS4A1 shield
25stacked on a board with an Arduino connector, e.g. the
26:zephyr:board:`nucleo_f411re` board.
27
28Building and Running
29********************
30
31This sample runs with X-NUCLEO-IKS4A1 stacked on any board with a matching
32Arduino connector. For this example, we use a :zephyr:board:`nucleo_f411re` board.
33
34.. zephyr-app-commands::
35 :zephyr-app: samples/shields/x_nucleo_iks4a1/sensorhub2/
36 :host-os: unix
37 :board: nucleo_f411re
38 :goals: build flash
39 :compact:
40
41Sample Output
42=============
43
44 .. code-block:: console
45
46 X-NUCLEO-IKS01A4 sensor dashboard
47
48 LSM6DSO16IS: Accel (m.s-2): x: 0.081, y: -0.177, z: 9.945
49 LSM6DSO16IS: GYro (dps): x: 0.001, y: -0.000, z: 0.004
50 LSM6DSO16IS: Magn (gauss): x: 0.217, y: 0.015, z: -0.415
51 LSM6DSO16IS: Temperature: 20.8 C
52 LSM6DSO16IS: Pressure:99.756 kpa
53 736:: lsm6dso16is acc trig 314944
54
55 <updated endlessly every 2 seconds>
56
57References
58**********
59
60:ref:`x-nucleo-iks4a1`
61
