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	boards: nrf52840_pca10056: Rename board to nrf52840dk_nrf52840	2020-03-27 09:14:08 +01:00
sample.yaml	samples: lsm6dsl: Add a harness_config	2019-12-09 12:52:35 -05:00

README.rst

.. _lsm6dsl:

LSM6DSL: IMU sensor Monitor
###########################

Overview
********
This sample sets the LSM6DSL accelerometer and gyroscope to 104Hz
and enable a trigger on data ready. It displays on the console the
values for accelerometer and gyroscope, plus optionally the values of
any magnetometer or pressure sensor attached to it (sensorhub function).


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

This sample uses the LSM6DSL sensor controlled using the I2C or SPI interface.
It has been tested on both :ref:`96b_argonkey` and disco_l475_iot1 board.

References
**********

- LSM6DSL http://www.st.com/en/mems-and-sensors/lsm6dsl.html

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

 This project outputs sensor data to the console. It requires an LSM6DSL
 sensor, which is present on both the :ref:`96b_argonkey` and disco_l475_iot1 board.

Building on ArgonKey board
==========================

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/lsm6dsl
   :host-os: unix
   :board: 96b_argonkey
   :goals: build
   :compact:

Building on disco_l475_iot1 board
=================================

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/lsm6dsl
   :host-os: unix
   :board: disco_l475_iot1
   :goals: build
   :compact:

Building on nrf52840dk_nrf52840 board with x-nucleo-iks01a2 shield
==================================================================

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/lsm6dsl
   :host-os: unix
   :board: nrf52840dk_nrf52840
   :shield: x_nucleo_iks01a2
   :goals: build
   :compact:

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

.. code-block:: console

    LSM6DSL sensor samples:

    accel (-3.184000 -0.697000 9.207000) m/s2
    gyro (0.065000 -0.029000 0.002000) dps
    magn (-0.042000 0.294000 -0.408000) gauss
    - (0) (trig_cnt: 190474)

    <repeats endlessly every 2 seconds>

.. note:: The magn row is displayed only when running sample onto 96b_argonkey board, where a magnetometer is connected to LSM6DSL.