zephyr/samples/drivers/led_lp5562
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
boards
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. _lp5562:

LP5562: 4-Channel RGB
######################

Overview
********

This sample controls 4 LEDs connected to a TI LP5562 driver, using the
following pattern:

 1. turn on LEDs to be red
 2. turn on LEDs to be green
 3. turn on LEDs to be blue
 4. turn on LEDs to be white
 5. turn on LEDs to be yellow
 6. turn on LEDs to be purple
 7. turn on LEDs to be cyan
 8. turn on LEDs to be orange
 9. turn off LEDs
 10. blink the LEDs in white
 11. turn off LEDs
 12. blink the LEDs in purple
 13. turn off LEDs

Refer to the `LP5562 Manual`_ for the RGB LED connections and color channel
mappings used by this sample.

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

Build the application for the :ref:`nrf52840dk_nrf52840` board, and connect
a LP5562 LED driver on the bus I2C0 at the address 0x30.

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/led_lp5562
   :board: nrf52840dk_nrf52840
   :goals: build
   :compact:

For flashing the application, refer to the Flashing section of the
:ref:`nrf52840dk_nrf52840` board documentation.

.. _LP5562 Manual: http://www.ti.com/lit/ds/symlink/lp5562.pdf