zephyr/samples/drivers/peci/README.rst
Carles Cufi 8beda01c0f doc: reference: Update overview for 2.3
Update the API overview page by looking at the changes in include/ since
the last release.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-06-05 20:36:16 +02:00

28 lines
651 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.