zephyr/samples/sensor/mcux_acmp
Benjamin Cabé d885957fe8 boards: nxp: adopt new zephyr:board directive and role
This updates the documentation of all the NXP 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 boards: nxp: adopt new zephyr:board directive and role 2024-10-24 17:51:15 +02:00
prj.conf sensor: mcux_acmp: namespace driver and kconfigs 2024-10-10 20:24:52 -04:00
sample.yaml sensor: mcux_acmp: namespace driver and kconfigs 2024-10-10 20:24:52 -04:00

README.rst

.. zephyr:code-sample:: mcux_acmp
   :name: NXP MCUX Analog Comparator (ACMP)
   :relevant-api: sensor_interface

   Get analog comparator data from an NXP MCUX Analog Comparator (ACMP).

Overview
********

This sample show how to use the NXP MCUX Analog Comparator (ACMP) driver. The
sample supports the :zephyr:board:`twr_ke18f`, :zephyr:board:`mimxrt1170_evk`, :zephyr:board:`frdm_ke17z`
, :zephyr:board:`frdm_ke17z512` and :zephyr:board:`mimxrt1180_evk`.

The input voltage for the negative input of the analog comparator is
provided by the ACMP Digital-to-Analog Converter (DAC). The input voltage for
the positive input can be adjusted by turning the on-board potentiometer for
:zephyr:board:`twr_ke18f` board, for :zephyr:board:`mimxrt1170_evk` the voltage signal is
captured on J25-13, the :zephyr:board:`frdm_ke17z` and :zephyr:board:`frdm_ke17z512` boards are
captured in J2-3, the :zephyr:board:`mimxrt1180_evk` board are captured in J45-13, need
change the external voltage signal to check the output.

The output value of the analog comparator is reported on the console.

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

Building and Running for TWR-KE18F
==================================
Build the application for the :zephyr:board:`twr_ke18f` board, and adjust the
ACMP input voltage by turning the on-board potentiometer.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/mcux_acmp
   :board: twr_ke18f
   :goals: flash
   :compact:

Building and Running for MIMXRT1170-EVK
=======================================
Build the application for the MIMXRT1170-EVK board, and adjust the
ACMP input voltage by changing the voltage input to J25-13.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/mcux_acmp
   :board: mimxrt1170_evk_cm7
   :goals: flash
   :compact:

Building and Running for FRDM-KE17Z
===================================
Build the application for the FRDM-KE17Z board, and adjust the
ACMP input voltage by changing the voltage input to J2-3.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/mcux_acmp
   :board: frdm_ke17z
   :goals: flash
   :compact:

Building and Running for FRDM-KE17Z512
======================================
Build the application for the FRDM-KE17Z512 board, and adjust the
ACMP input voltage by changing the voltage input to J2-3.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/mcux_acmp
   :board: frdm_ke17z512
   :goals: flash
   :compact:

Building and Running for MIMXRT1180-EVK
=======================================
Build the application for the MIMXRT1180-EVK board, and adjust the
ACMP input voltage by changing the voltage input to J45-13.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/mcux_acmp
   :board: mimxrt1180_evk/mimxrt1189/cm33
   :goals: flash
   :compact:

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/mcux_acmp
   :board: mimxrt1180_evk/mimxrt1189/cm7
   :goals: flash
   :compact: