zephyr/samples/drivers/led_lp3943
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
prj.conf drivers: led: Remove unnecessary Kconfig settings 2022-08-11 17:46:43 +02:00
README.rst
sample.yaml

.. _lp3943:

LP3943: 16-Channel RGB, White-LED Driver
########################################

Overview
********

This sample controls 16 LEDs connected to an LP3943 driver, in
a continuous pattern of turning them on one at a time (at a one
second interval) until they're all on, and then turning them off in
reverse order.

Requirements
************

The :ref:`96b_neonkey` board has an LP3943 driver and 16 LEDs on board,
so we'll use this board for our example.

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

Build the application for the :ref:`96b_neonkey` board, which has an
LP3943 driver included.

.. zephyr-app-commands::
   :zephyr-app: samples/drivers/led_lp3943
   :board: 96b_neonkey
   :goals: build
   :compact:

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

When you connect to the board's serial console, you should see the
following output in addition to the LED pattern:

.. code-block:: none

   ***** BOOTING ZEPHYR OS v1.11.99 *****
   [general] [INF] main: Found LED device LP3943
   [general] [INF] main: Displaying the pattern

References
**********

- LP3943: http://www.ti.com/lit/ds/snvs256d/snvs256d.pdf