Skip to content

Commit

Permalink
Update neopixel docs.
Browse files Browse the repository at this point in the history 
When we synced with the readthedocs content V1 didn't have support for
RGBW pixels. This has since been addressed.

Closes #81
  • Loading branch information
@microbit-matt-hillsdon
microbit-matt-hillsdon committed Oct 20, 2022
1 parent 0396c0b commit 1b1569a
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 9 deletions.
11 changes: 9 additions & 2 deletions lang/en/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,20 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
:param pin: The pin controlling the neopixel strip.
:param n: The number of neopixels in the strip.
:param bpp: Bytes per pixel. For micro:bit V2 RGBW neopixel support, pass 4 rather than the default of 3 for RGB and GRB.
:param bpp: Bytes per pixel. For RGBW neopixel support, pass 4 rather than the default of 3 for RGB and GRB.
"""
...
def clear(self) -> None:
Expand Down
9 changes: 8 additions & 1 deletion lang/es-es/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down
9 changes: 8 additions & 1 deletion lang/fr/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down
9 changes: 8 additions & 1 deletion lang/ja/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down
9 changes: 8 additions & 1 deletion lang/ko/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down
9 changes: 8 additions & 1 deletion lang/nl/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down
9 changes: 8 additions & 1 deletion lang/zh-cn/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down
9 changes: 8 additions & 1 deletion lang/zh-tw/typeshed/stdlib/neopixel.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ class NeoPixel:
Example: ``np = neopixel.NeoPixel(pin0, 8)``
RGBW neopixels are only supported by micro:bit V2.
To support RGBW neopixels, a third argument can be passed to
``NeoPixel`` to indicate the number of bytes per pixel (``bpp``).
For RGBW, this is is 4 rather than the default of 3 for RGB and GRB.
Each pixel is addressed by a position (starting from 0). Neopixels are
given RGB (red, green, blue) / RGBW (red, green, blue, white) 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.
See `the online docs <https://microbit-micropython.readthedocs.io/en/v2-docs/neopixel.html>`_ for warnings and other advice.
Expand Down

0 comments on commit 1b1569a

Please sign in to comment.