Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 1.99 KB

neopixel.rst

File metadata and controls

75 lines (49 loc) · 1.99 KB
Raw

:mod:`neopixel` --- control of WS2812 / NeoPixel LEDs

.. module:: neopixel
   :synopsis: control of WS2812 / NeoPixel LEDs

This module provides a driver for WS2818 / NeoPixel LEDs.

Note

This module is only included by default on the ESP8266, ESP32 and RP2 ports. On STM32 / Pyboard and others, you can either install the neopixel package using :term:`mip`, or you can download the module directly from <https://raw.githubusercontent.com/micropython/micropython-lib/master/micropython/drivers/led/neopixel/neopixel.py>`_ and copy it to the filesystem.

class NeoPixel

This class stores pixel data for a WS2812 LED strip connected to a pin. The application should set pixel data and then call :meth:`NeoPixel.write` when it is ready to update the strip.

For example:

import neopixel

# 32 LED strip connected to X8.
p = machine.Pin.board.X8
n = neopixel.NeoPixel(p, 32)

# Draw a red gradient.
for i in range(32):
    n[i] = (i * 8, 0, 0)

# Update the strip.
n.write()

Constructors

Pixel access methods

.. method:: NeoPixel.fill(pixel)

    Sets the value of all pixels to the specified *pixel* value (i.e. an
    RGB/RGBW tuple).


.. method:: NeoPixel.__len__()

    Returns the number of LEDs in the strip.


.. method:: NeoPixel.__setitem__(index, val)

    Set the pixel at *index* to the value, which is an RGB/RGBW tuple.


.. method:: NeoPixel.__getitem__(index)

    Returns the pixel at *index* as an RGB/RGBW tuple.

Output methods

.. method:: NeoPixel.write()

    Writes the current pixel data to the strip.