zephyr/samples/drivers/peci/README.rst
Peter Bigot 75f82dc09a samples: fix reStructuredText target directives
Without the leading underscore these are comments.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-08-28 12:54:40 +02:00

28 lines
652 B
ReStructuredText

.. _peci-sample:
PECI Interface
####################################
Overview
********
This sample demonstrates how to use the :ref:`PECI API <peci_api>`.
Callbacks are registered that will write to the console indicating PECI events.
These events indicate PECI host interaction.
Building and Running
********************
The sample can be built and executed on boards supporting PECI.
Please connect ensure the microcontroller used is connected to a PECI Host
in order to execute.
Sample output
=============
.. code-block:: console
PECI test
Note: You are expected to see several interactions including ID and
temperature retrieval.