zephyr

History

Benjamin Cabé 5832f6ed5f doc: Use new Sphinx extension for code samples Use the new code-sample directive and roles in a few places to demonstrate how it works. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2023-09-06 12:11:28 +02:00
..
boards
src	drivers: pwm: use pwm_is_ready_dt helper function	2023-08-30 10:19:47 +02:00
CMakeLists.txt
prj.conf
README.rst	doc: Use new Sphinx extension for code samples	2023-09-06 12:11:28 +02:00
sample.yaml	tests: cleanup metadata and filtering	2023-06-13 09:38:27 -04:00

README.rst

.. _fade-led-sample:

Fade LED
########

Overview
********

This application "fades" a LED using the :ref:`PWM API <pwm_api>`.

The LED starts off increases its brightness until it is fully or nearly fully
on. The brightness then decreases until the LED is off, completing on fade
cycle. Each cycle takes 2.5 seconds, and the cycles repeat forever. The PWM
period is taken from Devicetree. It should be fast enough to be above the
flicker fusion threshold.

Requirements and Wiring
***********************

This sample has the same requirements and wiring considerations as the
:zephyr:code-sample:`pwm-blinky-sample`.

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

To build and flash this sample for the :ref:`nrf52840dk_nrf52840`:

.. zephyr-app-commands::
   :zephyr-app: samples/basic/fade_led
   :board: nrf52840dk_nrf52840
   :goals: build flash
   :compact:

Change ``nrf52840dk_nrf52840`` appropriately for other supported boards.

After flashing, the sample starts fading the LED as described above. It also
prints information to the board's console.