Package com.diozero.devices

Class RgbLed

java.lang.Object

com.diozero.devices.RgbLed

All Implemented Interfaces:

DeviceInterface, AutoCloseable

public class RgbLed
extends Object
implements DeviceInterface

Three pin controlled RGB LED. 4 3 2 1 1 Red 2 Ground 3 Green 4 Blue

Constructor Summary

Constructors

Constructor	Description
RgbLed(int redPin, int greenPin, int bluePin)
RgbLed(GpioDeviceFactoryInterface deviceFactory, int redPin, int greenPin, int bluePin)

Method Summary

Modifier and Type	Method	Description
void	close()	Close this device
boolean[]	getValues()	Get the state of all LEDs.
void	off()	Turn all LEDs off.
void	on()	Turn all LEDs on.
void	setValues(boolean red, boolean green, boolean blue)	Set the state 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 Detail

RgbLed

public RgbLed(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.

RgbLed

public RgbLed(GpioDeviceFactoryInterface 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 Detail

close

public void close()

Description copied from interface: DeviceInterface

Close this device

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DeviceInterface

getValues

public boolean[] getValues()
                    throws RuntimeIOException

Get the state of all LEDs.

Returns:

Boolean array (red, green, blue).

Throws:

RuntimeIOException - If an I/O error occurred.

setValues

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

Set the state of all LEDs.

Parameters:

red - Red LED state.

green - Green LED state.

blue - Blue LED state.

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.