zephyr

History

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
..
src	…
CMakeLists.txt	…
README.rst	samples: sensor: use zephyr:code-sample directive	2024-09-04 21:26:50 +02:00
prj.conf	…
sample.yaml	…

README.rst

.. zephyr:code-sample:: apds9960
   :name: APDS9960 RGB, ambient light, and gesture sensor
   :relevant-api: sensor_interface

   Get ambient light, RGB, and proximity/gesture data from an APDS9960 sensor.

Overview
********

This sample application demonstrates how to use the APDS9960 sensor to get
ambient light, RGB, and proximity (or gesture) data.  This sample checks the
sensor in polling mode (without an interrupt trigger).

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

This sample application uses an APDS9960 sensor connected to a board
(for example as shown in this
`Sparkfun APDS9960 tutorial`_).

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/apds9960
   :board: reel_board
   :goals: flash
   :compact:

Sample Output
=============

.. code-block:: console

        ambient light intensity without trigger is 387
        proxy without trigger is 115
        ambient light intensity without trigger is 386
        proxy without trigger is 112
        ambient light intensity without trigger is 386

.. _Sparkfun APDS9960 tutorial: https://www.sparkfun.com/products/12787