com.pi4j.component.power.impl

Class GpioPowerComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.power.PowerBase

com.pi4j.component.power.impl.GpioPowerComponent

All Implemented Interfaces:

Component, ObserveableComponent, Power

public class GpioPowerComponent
extends PowerBase

Field Summary

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
PowerState	getState() Return the current power state based on the GPIO digital output pin state.
void	setState(PowerState state) Set the current GPIO digital output pin state based on the supplied power state

Methods inherited from class com.pi4j.component.power.PowerBase

addListener, isOff, isOn, notifyListeners, off, on, 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

GpioPowerComponent

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

using this constructor requires that the consumer define the POWER ON and POWER 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

GpioPowerComponent

public GpioPowerComponent(GpioPinDigitalOutput pin)

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

Parameters:

pin - GPIO digital output pin

Method Detail

getState

public PowerState getState()

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

Specified by:

getState in interface Power

Specified by:

getState in class PowerBase

Returns:

PowerState

setState

public void setState(PowerState state)

Set the current GPIO digital output pin state based on the supplied power state

Specified by:

setState in interface Power

Specified by:

setState in class PowerBase

Parameters:

state - new power state to apply