com.diozero.ws281xj

Class WS281x

java.lang.Object

com.diozero.ws281xj.WS281x

All Implemented Interfaces:

Closeable, AutoCloseable

public class WS281x
extends Object
implements Closeable

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

Also see this implementation.

All colours are represented as 24bit RGB values.

Constructor Summary

Constructors

Constructor and Description
WS281x(int gpioNum, int brightness, int numPixels)
WS281x(int frequency, int dmaNum, int gpioNum, int brightness, int numPixels)

Method Summary

Modifier and Type	Method and Description
void	allOff() Turn off all pixels.
void	close()
int	getBlueComponent(int pixel) Get the 8-bit blue component value for the specified pixel.
int	getGreenComponent(int pixel) Get the 8-bit green component value for the specified pixel.
int	getNumPixels()
int	getPixelColour(int pixel) Get the current colour for the specified pixel.
int	getRedComponent(int pixel) Get the 8-bit red component value for the specified pixel.
void	render() Push any updated colours to the LED strip.
void	setBlueComponent(int pixel, int blue) Set the 8-bit blue component value for the specified pixel.
void	setGreenComponent(int pixel, int green) Set the 8-bit green component value for the specified pixel.
void	setPixelColour(int pixel, int colour) Set the colour for the specified pixel.
void	setPixelColourHSB(int pixel, float hue, float saturation, float brightness) Set the colour for the specified pixel using Hue Saturation Brightness (HSB) values.
void	setPixelColourHSL(int pixel, float hue, float saturation, float luminance) Set the colour for the specified pixel using Hue Saturation Luminance (HSL) values.
void	setPixelColourRGB(int pixel, int red, int green, int blue) Set the colour for the specified pixel using individual red / green / blue 8-bit values.
void	setRedComponent(int pixel, int red) Set the 8-bit red component value for the specified pixel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WS281x

public WS281x(int gpioNum,
              int brightness,
              int numPixels)

Parameters:

gpioNum - GPIO pin to use to drive the LEDs.

brightness - Brightness level (0..255).

numPixels - The number of pixels connected.

WS281x

public WS281x(int frequency,
              int dmaNum,
              int gpioNum,
              int brightness,
              int numPixels)

Parameters:

frequency - Communication frequency, 800,000 or 400,000.

dmaNum - DMA number.

gpioNum - GPIO pin to use to drive the LEDs.

brightness - Brightness level (0..255).

numPixels - The number of pixels connected.

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getNumPixels

public int getNumPixels()

render

public void render()

Push any updated colours to the LED strip.

allOff

public void allOff()

Turn off all pixels.

getPixelColour

public int getPixelColour(int pixel)

Get the current colour for the specified pixel.

Parameters:

pixel - Pixel number.

Returns:

24-bit RGB colour value.

setPixelColour

public void setPixelColour(int pixel,
                           int colour)

Set the colour for the specified pixel.

Parameters:

pixel - Pixel number.

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

setPixelColourRGB

public void setPixelColourRGB(int pixel,
                              int red,
                              int green,
                              int blue)

Set the colour for the specified pixel using individual red / green / blue 8-bit values.

Parameters:

pixel - Pixel number.

red - 8-bit value for the red component.

green - 8-bit value for the green component.

blue - 8-bit value for the blue component.

setPixelColourHSB

public void setPixelColourHSB(int pixel,
                              float hue,
                              float saturation,
                              float brightness)

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

Parameters:

pixel - Pixel number.

hue - Float value in the range 0..1 representing the hue.

saturation - Float value in the range 0..1 representing the colour saturation.

brightness - Float value in the range 0..1 representing the colour brightness.

setPixelColourHSL

public void setPixelColourHSL(int pixel,
                              float hue,
                              float saturation,
                              float luminance)

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

HSL colour mapping code taken from this HSL Color class by Rob Camick.

Parameters:

pixel - Pixel number.

hue - 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 - Represents the purity of the colour. Range is 0..1 with 1 fully saturated and 0 gray.

luminance - Represents the brightness of the colour. Range is 0..1 with 1 white 0 black.

getRedComponent

public int getRedComponent(int pixel)

Get the 8-bit red component value for the specified pixel.

Parameters:

pixel - Pixel number.

Returns:

8-bit red component value.

setRedComponent

public void setRedComponent(int pixel,
                            int red)

Set the 8-bit red component value for the specified pixel.

Parameters:

pixel - Pixel number.

red - 8-bit red component value.

getGreenComponent

public int getGreenComponent(int pixel)

Get the 8-bit green component value for the specified pixel.

Parameters:

pixel - Pixel number.

Returns:

8-bit green component value.

setGreenComponent

public void setGreenComponent(int pixel,
                              int green)

Set the 8-bit green component value for the specified pixel.

Parameters:

pixel - Pixel number.

green - 8-bit green component value.

getBlueComponent

public int getBlueComponent(int pixel)

Get the 8-bit blue component value for the specified pixel.

Parameters:

pixel - Pixel number.

Returns:

8-bit blue component value.

setBlueComponent

public void setBlueComponent(int pixel,
                             int blue)

Set the 8-bit blue component value for the specified pixel.

Parameters:

pixel - Pixel number.

blue - 8-bit blue component value.