Link Search Menu Expand Document
diozero

LED Strips

WS2811B / WS2812B / Adafruit NeoPixel {: #ws281x }

TODO Insert wiring diagram.

class com.diozero.ws281xj.rpiws281x.WS281x (frequency=800,000, dmaNum=5, gpioNum, brightness, numPixels, stripType, channel=0) source

Provides support for WS2811B / WS2812B aka Adafriut NeoPixel LEDs via a JNI wrapper around the rpi_ws281x C library.

❗ Colour Coding

All colours are represented as 24bit RGB values.

  • frequency (int) - Communication frequency, 800,000 or 400,000.

  • dmaNum (int) - DMA number.

  • gpioNum (int) - GPIO pin to use to drive the LEDs.

  • brightness (int) - Brightness level (0..255).

  • numPixels (int) - The number of pixels connected.

render ()

: Push any updated colours to the LED strip.

allOff ()

: Turn off all pixels.

int getPixelColour (pixel)

: Get the current colour for the specified pixel (int).

setPixelColour (pixel, colour)

: Set the colour for the specified pixel.

  • pixel (int) - Pixel number.

  • colour (int) - Colour represented as a 24bit RGB integer (0x0RGB).

setPixelColourRGB (pixel, red, green, blue)

: Set the colour for the specified pixel using individual red / green / blue values.

  • pixel (int) - Pixel number.

  • red (int) - 8-bit value for the red component.

  • green (int) - 8-bit value for the green component.

  • blue (int) - 8-bit value for the blue component.

setPixelColourHSB (pixel, hue, saturation, brightness)

: Set the colour for the specified pixel using Hue Saturation Brightness (HSB) values.

  • pixel (int) - Pixel number.

  • hue (float) - Float value in the range 0..1 representing the hue.

  • saturation (float) - Float value in the range 0..1 representing the colour saturation.

  • brightness (float) - Float value in the range 0..1 representing the colour brightness.

setPixelColourHSL (pixel, hue, saturation, luminance)

: Set the colour for the specified pixel using Hue Saturation Luminance (HSL) values.

Warning “In development”

I’m not convinced this is working correctly. Code for the colour mapping taken from this article written in 2009 by Rob Camick. Also not entirely sure how this is different from HSB colour mapping.

  • pixel (int) - Pixel number.

  • hue (float) - Represents the colour (think colours of the rainbow), specified in degrees from 0 - 360. Red is 0, green is 120 and blue is 240.

  • saturation (float) - Represents the purity of the colour. Range is 0..1 with 1 fully saturated and 0 gray.

  • luminance (float) - Represents the brightness of the colour. Range is 0..1 with 1 white 0 black.