README.rst
1.. _peci-sample:
2
3PECI Interface
4####################################
5
6Overview
7********
8
9This sample demonstrates how to use the :ref:`PECI API <peci_api>`.
10Callbacks are registered that will write to the console indicating PECI events.
11These events indicate PECI host interaction.
12
13Building and Running
14********************
15
16The sample can be built and executed on boards supporting PECI.
17Please connect ensure the microcontroller used is connected to a PECI Host
18in order to execute.
19
20Sample output
21=============
22
23.. code-block:: console
24
25 PECI test
26 Note: You are expected to see several interactions including ID and
27 temperature retrieval.
28