Package com.diozero.devices

Class RgbPwmLed

java.lang.Object

com.diozero.devices.RgbPwmLed

All Implemented Interfaces:

Closeable, AutoCloseable

public class RgbPwmLed
extends Object
implements Closeable

Three pin controlled RGB LED.

Constructor Summary

Constructors

Constructor	Description
RgbPwmLed(int redPin, int greenPin, int bluePin)
RgbPwmLed(PwmOutputDeviceFactoryInterface deviceFactory, int redPin, int greenPin, int bluePin)

Method Summary

Modifier and Type	Method	Description
void	close()
float[]	getValues()	Get the value of all LEDs.
void	off()	Turn all LEDs off.
void	on()	Turn all LEDs on.
void	setValues(float red, float green, float blue)	Set the value of all LEDs.
void	toggle()	Toggle the state of all LEDs.

Methods inherited from class java.lang.Object

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

Constructor Details

RgbPwmLed

public RgbPwmLed(int redPin,
int greenPin,
int bluePin)
          throws RuntimeIOException

Parameters:

redPin - GPIO for the red LED.

greenPin - GPIO for the green LED.

bluePin - GPIO for the blue LED.

Throws:

RuntimeIOException - If an I/O error occurred.

RgbPwmLed

public RgbPwmLed(PwmOutputDeviceFactoryInterface deviceFactory,
int redPin,
int greenPin,
int bluePin)
          throws RuntimeIOException

Parameters:

deviceFactory - Device factory to use to provision this device.

redPin - GPIO for the red LED.

greenPin - GPIO for the green LED.

bluePin - GPIO for the blue LED.

Throws:

RuntimeIOException - If an I/O error occurred.

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getValues

public float[] getValues()
                  throws RuntimeIOException

Get the value of all LEDs.

Returns:

Boolean array (red, green, blue).

Throws:

RuntimeIOException - If an I/O error occurred.

setValues

public void setValues(float red,
float green,
float blue)
               throws RuntimeIOException

Set the value of all LEDs.

Parameters:

red - Red LED value (0..1).

green - Green LED value (0..1).

blue - Blue LED value (0..1).

Throws:

RuntimeIOException - If an I/O error occurred.

on

public void on()
        throws RuntimeIOException

Turn all LEDs on.

Throws:

RuntimeIOException - If an I/O error occurred.

off

public void off()
         throws RuntimeIOException

Turn all LEDs off.

Throws:

RuntimeIOException - If an I/O error occurred.

toggle

public void toggle()
            throws RuntimeIOException

Toggle the state of all LEDs.

Throws:

RuntimeIOException - If an I/O error occurred.