zephyr/samples/sensor/adc_cmp_npcx
Benjamin Cabé ee77704715 samples: sensor: use zephyr:code-sample directive
Describe the samples using code-sample directive in preparation for
upcoming changes to the Zephyr documentation that will be leveraging
the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-04 21:26:50 +02:00
..
boards
src samples: sensors: rename shadow variables 2023-08-22 11:39:58 +02:00
CMakeLists.txt
prj.conf sensors: Remove unnecessary Kconfig setting of sensors 2022-07-25 15:18:56 +02:00
README.rst samples: sensor: use zephyr:code-sample directive 2024-09-04 21:26:50 +02:00
sample.yaml samples, tests: convert string-based twister lists to YAML lists 2023-05-10 09:52:37 +02:00

.. 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 :ref:`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 :ref:`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: