zephyr/boards/shields/mikroe_accel13_click/doc/index.rst
Benjamin Cabé 25fa25a5a9 doc: :zephyr-app: should point to existing in-tree folders
As there is no check (yet!) in the directive, many
.. zephyr-app-commands:: in the documentation are pointing to
non-existing sample applications, which is problematic for users who
typically expect to just copy-paste the commands and have them work.

This commit fixes all offending references to point to existing samples,
or converts them to simple ":app:" instead of ":zephyr-app:" when the
intent wasn't to refer to in-tree samples.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-09 13:53:47 -04:00

56 lines
1.4 KiB
ReStructuredText

.. _mikroe_accel13_click_shield:
MikroElektronika ACCEL 13 Click
###############################
Overview
********
The MikroElektronika ACCEL 13 Click carries the `IIS2DLPC`_ ultra-low
power triaxial accelerometer sensor in a `mikroBUS`_ |trade| form factor.
The `IIS2DLPC`_ sensor supports both SPI and I2C bus protocols. Currently
only I2C is supported for this shield.
.. figure:: accel-13-click.jpg
:align: center
:alt: MikroElektronika ACCEL 13 Click
MikroElektronika ACCEL 13 Click (Credit: MikroElektronika)
Requirements
************
This shield can only be used with a development board that provides a
configuration for mikroBUS connectors and defines a node alias for the mikroBUS
I2C interface (see :ref:`shields` for more details).
For more information about interfacing the IIS2DLPC and the ACCEL 13 Click,
see the following documentation:
- `IIS2DLPC Datasheet`_
- `ACCEL 13 Click`_
Programming
***********
Set ``--shield mikro_accel13_click`` when you invoke ``west build``. For
example:
.. zephyr-app-commands::
:zephyr-app: samples/sensor/sensor_shell
:board: lpcxpresso55s69
:shield: mikroe_accel13_click
:goals: build
.. _IIS2DLPC:
https://www.st.com/en/mems-and-sensors/iis2dlpc.html
.. _mikroBUS:
https://www.mikroe.com/mikrobus
.. _IIS2DLPC Datasheet:
https://www.st.com/resource/en/datasheet/iis2dlpc.pdf
.. _ACCEL 13 Click:
https://www.mikroe.com/accel-13-click