zephyr/samples/boards/nordic/nrf_led_matrix
Benjamin Cabé aaccb6323f boards: bbc: adopt new zephyr:board directive and role
This updates the documentation of all the BBC boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
..
src
CMakeLists.txt
README.rst
prj.conf
sample.yaml

README.rst

.. zephyr:code-sample:: nrf_led_matrix
   :name: LED matrix

   Use the nRF LED matrix display driver to drive an LED matrix.

Overview
********

This is a simple application intended to present the nRF LED matrix display
driver in action and to serve as a test ensuring that this driver is buildable
for both the :zephyr:board:`bbc_microbit_v2` and :zephyr:board:`bbc_microbit` boards.

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

The sample has been tested on the bbc_microbit_v2 and bbc_microbit boards,
but it could be ported to any board with an nRF SoC and the proper number
of GPIOs available for driving an LED matrix. To do it, one needs to add an
overlay file with the corresponding ``"nordic,nrf-led-matrix"`` compatible
node.

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

The code can be found in :zephyr_file:`samples/boards/nordic/nrf_led_matrix`.

To build and flash the application:

.. zephyr-app-commands::
   :zephyr-app: samples/boards/nordic/nrf_led_matrix
   :board: bbc_microbit_v2
   :goals: build flash
   :compact: