zephyr

History

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
..
boards
src
CMakeLists.txt
prj.conf
README.rst
sample.yaml

README.rst

.. zephyr:code-sample:: i2c-custom-target
   :name: I2C Custom Target
   :relevant-api: i2c_interface

   Setup a custom I2C target on the I2C interface.

Overview
********

This sample demonstrates how to setup an I2C custom target on the I2C interface
using the :ref:`i2c-target-api`.

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

This sample requires an I2C peripheral which is capable of acting as a target.

This sample has been tested on :ref:`lpcxpresso55s69`.

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

The code for this sample can be found in :zephyr_file:`samples/drivers/i2c/custom_target`.

To build and flash the application:

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/i2c/custom_target
   :board: lpcxpresso55s69/lpc55s69/cpu0
   :goals: flash
   :compact: