zephyr/samples/sensor/adc_cmp_npcx
Benjamin Cabé a17d854004 boards: nuvoton: adopt new zephyr:board directive and role
This updates the documentation of all the Nuvoton 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:: adc_cmp_npcx
   :name: NPCX ADC Comparator
   :relevant-api: sensor_interface

   Detect upper/lower voltage limits using NPCX ADC Comparator driver.

Overview
********

This sample show how to use the NPCX ADC Comparator driver. The
sample supports the :zephyr:board:`npcx9m6f_evb`.

This application is a voltage comparator with hysteresis, upper limit is
set at 1 V while lower limit is 250 mV. Initially configured to detect
upper limit.

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

Build the application for the :zephyr:board:`npcx9m6f_evb` board, and provide voltage
to ADC channel 8, when voltages cross upper/lower limits, detection messages
will be printed.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/adc_cmp_npcx
   :board: npcx9m6f_evb
   :goals: flash
   :compact: