1.. _adafruit_neopixel_grid_bff:
2
3Adafruit 5x5 NeoPixel Grid BFF
4##############################
5
6Overview
7********
8
9The `Adafruit 5x5 NeoPixel Grid BFF`_ is a 5x5 grid of WS2812B RGB LEDs,
10which Adafruit refers to as "neopixels". The BFF series of shields are
11designed to be compatible with any Adafruit Qt Py or Seeed Studio Xiao
12board.
13
14.. figure:: adafruit_neopixel_grid_bff.jpg
15   :align: center
16   :alt: Adafruit 5x5 NeoPixel Grid BFF
17
18   Adafruit 5x5 NeoPixel Grid BFF (Credit: Adafruit)
19
20Pin Assignments
21===============
22
23+-----------------------+---------------------------------------------+
24| Shield Connector Pin  | Function                                    |
25+=======================+=============================================+
26| A3                    | WS2812B driver pin [1]_                     |
27+-----------------------+---------------------------------------------+
28
29.. [1] This is the default pin when the board is delivered as is by Adafruit.
30       It can be changed away from the default using the onboard solder jumpers,
31       but this shield will no longer work without a matching device tree update.
32
33Programming
34***********
35
36LED Strip Example
37=================
38
39Set ``--shield adafruit_neopixel_grid_bff`` when you invoke ``west build``. For example:
40
41.. zephyr-app-commands::
42   :zephyr-app: samples/drivers/led/led_strip
43   :board: adafruit_qt_py_rp2040
44   :shield: adafruit_neopixel_grid_bff
45   :goals: build
46
47LED Display Matrix Example
48==========================
49
50.. warning::
51
52    When using this example, all of the LEDs will be set to their maximum
53    brightness. Having all of the LEDs on at once can cause the PCB to overheat
54    or draw too much current from any on-board voltage regulators.
55    Adafruit does provide solder pads for your own power supply on the
56    underside of the BFF for this reason. It is not required, but is strongly
57    recommended if all of the LEDs are fully on for any significant amount of
58    time.
59
60Set ``--shield adafruit_neopixel_grid_bff_display`` when you invoke ``west build``. For example:
61
62.. zephyr-app-commands::
63   :zephyr-app: samples/drivers/display
64   :board: adafruit_qt_py_rp2040
65   :shield: adafruit_neopixel_grid_bff_display
66   :goals: build
67
68.. _Adafruit 5x5 NeoPixel Grid BFF:
69   https://learn.adafruit.com/adafruit-5x5-neopixel-grid-bff/
70