Skip to content

Docs: update for RGBW neopixel #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Dec 18, 2020
Merged

Docs: update for RGBW neopixel #694

Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ee5abe4
Docs: update for RGBW neopixel
microbit-mark Dec 15, 2020
92887de
Docs: RGBW neopixels
microbit-mark Dec 15, 2020
1b927ef
Update docs/neopixel.rst
microbit-mark Dec 16, 2020
4e68ce5
Update docs/neopixel.rst
microbit-mark Dec 16, 2020
40a0c50
change to bpp
microbit-mark Dec 16, 2020
474f3cc
change to bpp
microbit-mark Dec 16, 2020
7599420
add image attribution
microbit-mark Dec 16, 2020
f90d5e2
Update docs/neopixel.rst
microbit-mark Dec 17, 2020
9641853
Add V2 methods
microbit-mark Dec 18, 2020
ba87af8
Merge branch 'neopixel-updates' of https://github.com/microbit-mark/m…
microbit-mark Dec 18, 2020
a8750bd
Docs: Update neopixel
microbit-mark Dec 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions docs/neopixel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ NeoPixel
.. py:module:: neopixel

The ``neopixel`` module lets you use NeoPixel (WS2812) individually addressable
RGB LED strips with the micro:bit. Note to use the ``neopixel`` module, you
RGB and RGBW **V2** LED strips with the micro:bit. Note to use the ``neopixel`` module, you
need to import it separately with::

import neopixel
Expand All @@ -13,9 +13,9 @@ need to import it separately with::

From our tests, the Microbit NeoPixel module can drive up to around 256
NeoPixels. Anything above that and you may experience weird bugs and
issues. As the micro:bit can only supply 90mA to external devices,
larger numbers of NeoPixels require an external power supply with common
ground.
issues. The micro:bit can only supply 90mA **V1** or 190mA **V2** to
external devices,larger numbers of NeoPixels require an external power
supply with common ground.

NeoPixels are designed to work at 5V, but luckily they still function using
the 3V supply of the BBC micro:bit. Please note that the micro:bit edge
Expand Down Expand Up @@ -51,11 +51,17 @@ Classes

.. py:class::
NeoPixel(pin, n)
NeoPixel(pin, n, 4)

Initialise a new strip of ``n`` number of neopixel LEDs controlled via pin
``pin``. Each pixel is addressed by a position (starting from 0). Neopixels
are given RGB (red, green, blue) values between 0-255 as a tuple. For
example, ``(255,255,255)`` is white.
``pin``. For **V2** micro:bit boards that support RGBW neopixels, a third
value can be passed to ``NeoPixel`` to indicate the number of bytes per
pixel is 4 rather than the default of 3.

Each pixel is addressed by a position (starting from 0). Neopixels
are given RGB (red, green, blue) / RGBW (red, green, blue, white) **V2**
values between 0-255 as a tuple. For example, in RGB, ``(255,255,255)`` is
white. In RGBW, ``(255,255,255,0)`` or ``(0,0,0,255)`` is white.

.. py:method:: clear()

Expand Down Expand Up @@ -87,10 +93,10 @@ Using Neopixels
===============

Interact with Neopixels as if they were a list of tuples. Each tuple represents
the RGB (red, green and blue) mix of colours for a specific pixel. The RGB
values can range between 0 to 255.
the RGB (red, green and blue) / RGBW (red, green,blue and white) mix of colours
for a specific pixel. The RGBW values can range between 0 to 255.

For example, initialise a strip of 8 neopixels on a strip connected to pin0
For example, initialise a strip of 8 RGB neopixels on a strip connected to pin0
like this::

import neopixel
Expand Down