com.pi4j.component.light.impl

Class GpioLightComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.light.LightBase

com.pi4j.component.light.impl.GpioLightComponent

All Implemented Interfaces:

Component, Light, ObserveableComponent

public class GpioLightComponent
extends LightBase

Field Summary

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

Constructor and Description
GpioLightComponent(GpioPinDigitalOutput pin) default constructor; using this constructor assumes that: (1) a pin state of HIGH is LIGHT ON (2) a pin state of LOW is LIGHT OFF
GpioLightComponent(GpioPinDigitalOutput pin, PinState onState, PinState offState) using this constructor requires that the consumer define the LIGHT ON and LIGHT OFF pin states

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isOn() Return the current power state based on the GPIO digital output pin state.
void	off() Set the current GPIO digital output pin state based for LIGHT OFF
void	on() Set the current GPIO digital output pin state based for LIGHT ON

Methods inherited from class com.pi4j.component.light.LightBase

addListener, isOff, notifyListeners, removeListener

Methods inherited from class com.pi4j.component.ObserveableComponentBase

addListener, removeAllListeners, removeListener

Methods inherited from class com.pi4j.component.ComponentBase

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.component.ObserveableComponent

removeAllListeners

Methods inherited from interface com.pi4j.component.Component

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Constructor Detail

GpioLightComponent

public GpioLightComponent(GpioPinDigitalOutput pin,
                  PinState onState,
                  PinState offState)

using this constructor requires that the consumer define the LIGHT ON and LIGHT OFF pin states

Parameters:

pin - GPIO digital output pin

onState - pin state to set when power is ON

offState - pin state to set when power is OFF

GpioLightComponent

public GpioLightComponent(GpioPinDigitalOutput pin)

default constructor; using this constructor assumes that: (1) a pin state of HIGH is LIGHT ON (2) a pin state of LOW is LIGHT OFF

Parameters:

pin - GPIO digital output pin

Method Detail

on

public void on()

Set the current GPIO digital output pin state based for LIGHT ON

Specified by:

on in interface Light

Specified by:

on in class LightBase

off

public void off()

Set the current GPIO digital output pin state based for LIGHT OFF

Specified by:

off in interface Light

Specified by:

off in class LightBase

isOn

public boolean isOn()

Return the current power state based on the GPIO digital output pin state.

Specified by:

isOn in interface Light

Specified by:

isOn in class LightBase

Returns:

boolean is light on