zephyr/samples/drivers/i2c/custom_target
Benjamin Cabé d885957fe8 boards: nxp: adopt new zephyr:board directive and role
This updates the documentation of all the NXP boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
..
boards
src
CMakeLists.txt
README.rst
prj.conf
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 :zephyr:board:`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: