This is the documentation for the latest development branch of MicroPython and may refer to features that are not available in released versions.

If you are looking for the documentation for a specific release, use the drop-down menu on the left and select the desired version.

neopixel – Control of WS2812 / NeoPixel LEDs.

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 mip, or you can download the module directly from micropython-lib and copy it to the filesystem.

Classes

NeoPixel

Construct an NeoPixel object. The parameters are:

Module Contents

class neopixel.NeoPixel(pin, n, *, bpp=3, timing=1)

Construct an NeoPixel object. The parameters are:

  • pin is a machine.Pin instance.

  • n is the number of LEDs in the strip.

  • bpp is 3 for RGB LEDs, and 4 for RGBW LEDs.

  • timing is 0 for 400KHz, and 1 for 800kHz LEDs (most are 800kHz).

__getitem__(index) → Tuple

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

__len__() → int

Returns the number of LEDs in the strip.

__setitem__(index, val) → None

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

fill(pixel) → None

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

write() → None

Writes the current pixel data to the strip.