zephyr/samples/shields/x_nucleo_iks02a1/standard
Benjamin Cabé 14c92da96d doc: stm32: Update all st.com links to use HTTPS
While recent browsers seem to transparently try to use https for
http://www.st.com/... URLs, they are effectively not working anymore, so use
https://www.st.com/... URLs instead.

curl http://www.st.com/en/evaluation-tools/nucleo-g070rb.html -m 5 -v
*   Trying 104.89.117.48:80...
* Connected to www.st.com (104.89.117.48) port 80 (#0)
> GET /en/evaluation-tools/nucleo-g070rb.html HTTP/1.1
> Host: www.st.com
> User-Agent: curl/8.1.2
> Accept: */*
>
* Operation timed out after 5002 milliseconds with 0 bytes received
* Closing connection 0
curl: (28) Operation timed out after 5002 milliseconds with 0 bytes
received

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-26 16:55:08 +02:00
..
src samples, tests, boards: Switch main return type from void to int 2023-04-14 07:49:41 +09: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 doc: stm32: Update all st.com links to use HTTPS 2023-09-26 16:55:08 +02:00
sample.yaml samples, tests: convert string-based twister lists to YAML lists 2023-05-10 09:52:37 +02:00

.. zephyr:code-sample:: x-nucleo-iks02a1-std
   :name: X-NUCLEO-IKS02A1 shield - Standard (Mode 1)
   :relevant-api: sensor_interface

   Interact with all the sensors of an X-NUCLEO-IKS02A1 shield using Standard mode.

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: https://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>