Describe the samples using code-sample directive in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
54 lines
1.4 KiB
ReStructuredText
54 lines
1.4 KiB
ReStructuredText
.. zephyr:code-sample:: lsmd303dlhc
|
|
:name: LSM303DLHC Magnetometer and Accelerometer sensor
|
|
:relevant-api: sensor_interface
|
|
|
|
Get magnetometer and accelerometer data from an LSM303DLHC sensor (polling
|
|
mode).
|
|
|
|
Overview
|
|
********
|
|
This sample application periodically reads magnetometer and accelerometer data
|
|
from the LSM303DLHC eCompass module's sensors, and displays the sensor data
|
|
on the console.
|
|
|
|
Requirements
|
|
************
|
|
|
|
This sample uses the LSM303DLHC, ST MEMS system-in-package featuring a
|
|
3D digital linear acceleration sensor and a 3D digital magnetic sensor,
|
|
controlled using the I2C interface.
|
|
|
|
References
|
|
**********
|
|
|
|
For more information about the LSM303DLHC eCompass module, see
|
|
https://www.st.com/en/mems-and-sensors/lsm303dlhc.html
|
|
|
|
Building and Running
|
|
********************
|
|
|
|
This project outputs sensor data to the console. It requires a LSM303DLHC
|
|
system-in-package, which is present on the stm32f3_disco board
|
|
|
|
.. zephyr-app-commands::
|
|
:zephyr-app: samples/sensor/lsm303dlhc
|
|
:board: stm32f3_disco
|
|
:goals: build
|
|
:compact:
|
|
|
|
Sample Output
|
|
=============
|
|
|
|
.. code-block:: console
|
|
|
|
Magnetometer data:
|
|
( x y z ) = ( 0.531818 -0.435454 -0.089090 )
|
|
Accelerometer data:
|
|
( x y z ) = ( -0.078127 -0.347666 1.105502 )
|
|
Magnetometer data:
|
|
( x y z ) = ( -0.003636 0.297272 -0.255454 )
|
|
Accelerometer data:
|
|
( x y z ) = ( 0.074221 -0.304696 0.972685 )
|
|
|
|
<repeats endlessly every 2 seconds>
|