com.pi4j.component.relay.impl

Class GpioRelayComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.relay.RelayBase

com.pi4j.component.relay.impl.GpioRelayComponent

All Implemented Interfaces:

Component, ObserveableComponent, Relay

public class GpioRelayComponent
extends RelayBase

Field Summary

Fields inherited from class com.pi4j.component.relay.RelayBase

DEFAULT_PULSE_MILLISECONDS

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

Constructor and Description
GpioRelayComponent(GpioPinDigitalOutput pin) default constructor; using this constructor assumes that: (1) a pin state of HIGH is RELAY CLOSED (2) a pin state of LOW is RELAY OPEN
GpioRelayComponent(GpioPinDigitalOutput pin, PinState openState, PinState closedState) using this constructor requires that the consumer define the RELAY OPEN and RELAY closed pin states

Method Summary

Methods

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

Methods inherited from class com.pi4j.component.relay.RelayBase

addListener, close, isClosed, isOpen, isState, notifyListeners, open, pulse, removeListener, toggle

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

GpioRelayComponent

public GpioRelayComponent(GpioPinDigitalOutput pin,
                  PinState openState,
                  PinState closedState)

using this constructor requires that the consumer define the RELAY OPEN and RELAY closed pin states

Parameters:

pin - GPIO digital output pin

openState - pin state to set when relay is OPEN

closedState - pin state to set when relay is CLOSED

GpioRelayComponent

public GpioRelayComponent(GpioPinDigitalOutput pin)

default constructor; using this constructor assumes that: (1) a pin state of HIGH is RELAY CLOSED (2) a pin state of LOW is RELAY OPEN

Parameters:

pin - GPIO digital output pin

Method Detail

getState

public RelayState getState()

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

Specified by:

getState in interface Relay

Specified by:

getState in class RelayBase

Returns:

PowerState

setState

public void setState(RelayState state)

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

Specified by:

setState in interface Relay

Specified by:

setState in class RelayBase

Parameters:

state - new power state to apply

pulse

public void pulse(int milliseconds)

Specified by:

pulse in interface Relay

Overrides:

pulse in class RelayBase