com.diozero.ws281xj.rpiws281x.WS281x Maven / Gradle / Ivy
package com.diozero.ws281xj.rpiws281x;
/*-
* #%L
* Organisation: diozero
* Project: Device I/O Zero - WS281x Java Wrapper
* Filename: WS281x.java
*
* This file is part of the diozero project. More information about this project
* can be found at http://www.diozero.com/
* %%
* Copyright (C) 2016 - 2021 diozero
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import com.diozero.ws281xj.LedDriverInterface;
import com.diozero.ws281xj.StripType;
/**
*
* 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.
*
*
* Valid GPIO numbers:
*
*
* - 12 / 18 (PWM)
* - 21 / 31 (PCM)
* - 10 (SPI)
*
*/
public class WS281x implements LedDriverInterface {
private static final int SIZE_OF_INT = 4;
private static final int DEFAULT_FREQUENCY = 800_000; // Or 400_000
// TODO Find out what options there are here... What do pigpio & wiringPi use?
private static final int DEFAULT_DMA_NUM = 5;
private static final StripType DEFAULT_STRIP_TYPE = StripType.WS2812;
private static final int DEFAULT_CHANNEL = 0;
private static final String LIB_NAME = "ws281xj";
private static Boolean loaded = Boolean.FALSE;
// 4 color R, G, B and W ordering
private static final int SK6812_STRIP_RGBW = 0x18100800;
private static final int SK6812_STRIP_RBGW = 0x18100008;
private static final int SK6812_STRIP_GRBW = 0x18081000;
private static final int SK6812_STRIP_GBRW = 0x18080010;
private static final int SK6812_STRIP_BRGW = 0x18001008;
private static final int SK6812_STRIP_BGRW = 0x18000810;
private static final int SK6812_SHIFT_WMASK = 0xf0000000;
// 3 color R, G and B ordering
private static final int WS2811_STRIP_RGB = 0x00100800;
private static final int WS2811_STRIP_RBG = 0x00100008;
private static final int WS2811_STRIP_GRB = 0x00081000;
private static final int WS2811_STRIP_GBR = 0x00080010;
private static final int WS2811_STRIP_BRG = 0x00001008;
private static final int WS2811_STRIP_BGR = 0x00000810;
// predefined fixed LED types
private static final int WS2812_STRIP = WS2811_STRIP_GRB;
private static final int SK6812_STRIP = WS2811_STRIP_GRB;
private static final int SK6812W_STRIP = SK6812_STRIP_GRBW;
private static void init() {
synchronized (loaded) {
if (!loaded.booleanValue()) {
try (InputStream is = WS281x.class.getResourceAsStream("/lib/lib" + LIB_NAME + ".so")) {
Path path = Files.createTempFile("lib" + LIB_NAME, ".so");
path.toFile().deleteOnExit();
Files.copy(is, path, StandardCopyOption.REPLACE_EXISTING);
System.load(path.toString());
System.out.println("Loaded library '" + LIB_NAME + "' from classpath");
loaded = Boolean.TRUE;
} catch (Throwable t) {
System.out.println("Error loading library from classpath, trying from system library path");
// Try load the usual way...
try {
System.loadLibrary(LIB_NAME);
System.out.println("Loaded library '" + LIB_NAME + "' from system library path");
loaded = Boolean.TRUE;
} catch (Throwable t2) {
System.err.println("Error loading library '" + LIB_NAME + "'");
}
}
Runtime.getRuntime().addShutdownHook(new Thread(WS281xNative::terminate, "WS281x Shutdown Handler"));
}
}
}
private ByteBuffer ch0LedBuffer;
private int numPixels;
/**
* @param gpioNum GPIO pin to use to drive the LEDs.
* @param brightness Brightness level (0..255).
* @param numPixels The number of pixels connected.
*/
public WS281x(int gpioNum, int brightness, int numPixels) {
this(DEFAULT_FREQUENCY, DEFAULT_DMA_NUM, gpioNum, brightness, numPixels, DEFAULT_STRIP_TYPE, DEFAULT_CHANNEL);
}
/**
* @param frequency Communication frequency, 800,000 or 400,000.
* @param dmaNum DMA number.
* @param gpioNum GPIO pin to use to drive the LEDs.
* @param brightness Brightness level (0..255).
* @param numPixels The number of pixels connected.
* @param stripType Strip type
*/
public WS281x(int frequency, int dmaNum, int gpioNum, int brightness, int numPixels, StripType stripType) {
this(DEFAULT_FREQUENCY, DEFAULT_DMA_NUM, gpioNum, brightness, numPixels, stripType, DEFAULT_CHANNEL);
}
/**
* @param frequency Communication frequency, 800,000 or 400,000.
* @param dmaNum DMA number.
* @param gpioNum GPIO pin to use to drive the LEDs.
* @param brightness Brightness level (0..255).
* @param numPixels The number of pixels connected.
* @param stripType Strip type
* @param channel PWM channel
*/
public WS281x(int frequency, int dmaNum, int gpioNum, int brightness, int numPixels, StripType stripType,
int channel) {
init();
this.numPixels = numPixels;
ch0LedBuffer = WS281xNative.initialise(frequency, dmaNum, gpioNum, brightness, numPixels,
getRpiStripType(stripType), channel);
if (ch0LedBuffer == null) {
throw new RuntimeException("Error initialising the WS281x strip");
}
System.out.println("order=" + ch0LedBuffer.order());
ch0LedBuffer.order(ByteOrder.LITTLE_ENDIAN);
}
@Override
public void close() {
System.out.println("close()");
if (ch0LedBuffer != null) {
allOff();
ch0LedBuffer = null;
}
WS281xNative.terminate();
}
@Override
public int getNumPixels() {
return numPixels;
}
@Override
public void render() {
int rc = WS281xNative.render();
if (rc != 0) {
throw new RuntimeException("Error in render() - " + rc);
}
}
private void validatePixel(int pixel) {
if (pixel < 0 || pixel >= numPixels) {
throw new IllegalArgumentException("pixel must be 0.." + (numPixels - 1));
}
}
@Override
public void allOff() {
for (int i = 0; i < numPixels; i++) {
setPixelColour(i, 0);
}
render();
}
@Override
public int getPixelColour(int pixel) {
validatePixel(pixel);
return ch0LedBuffer.getInt(pixel * SIZE_OF_INT);
}
@Override
public void setPixelColour(int pixel, int colour) {
validatePixel(pixel);
ch0LedBuffer.putInt(pixel * SIZE_OF_INT, colour);
}
private static int getRpiStripType(StripType stripType) {
switch (stripType) {
case SK6812_RGBW:
return SK6812_STRIP_RGBW;
case SK6812_RBGW:
return SK6812_STRIP_RBGW;
case SK6812_GRBW:
return SK6812_STRIP_GRBW;
case SK6812_GBRW:
return SK6812_STRIP_GBRW;
case SK6812_BRGW:
return SK6812_STRIP_BRGW;
case SK6812_BGRW:
return SK6812_STRIP_BGRW;
case WS2811_RGB:
return WS2811_STRIP_RGB;
case WS2811_RBG:
return WS2811_STRIP_RBG;
case WS2811_GRB:
return WS2811_STRIP_GRB;
case WS2811_GBR:
return WS2811_STRIP_GBR;
case WS2811_BRG:
return WS2811_STRIP_BRG;
case WS2811_BGR:
return WS2811_STRIP_BGR;
default:
return WS2812_STRIP;
}
}
}