com.pi4j.component.switches.impl

Class GpioSwitchComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.switches.SwitchBase

com.pi4j.component.switches.impl.GpioSwitchComponent

All Implemented Interfaces:

Component, ObserveableComponent, Switch

public class GpioSwitchComponent
extends SwitchBase

Field Summary

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

Constructor and Description
GpioSwitchComponent(GpioPinDigitalInput pin) default constructor; using this constructor assumes that: (1) a pin state of HIGH is SWITCH CLOSED/ON (2) a pin state of LOW is SWITCH OPEN/OFF
GpioSwitchComponent(GpioPinDigitalInput pin, PinState offState, PinState onState) using this constructor requires that the consumer define the SWITCH OPEN/OFF and SWITCH CLOSED/ON pin states

Method Summary

Methods

Modifier and Type	Method and Description
SwitchState	getState() Return the current switch state based on the GPIO digital output pin state.

Methods inherited from class com.pi4j.component.switches.SwitchBase

addListener, isOff, isOn, isState, 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

GpioSwitchComponent

public GpioSwitchComponent(GpioPinDigitalInput pin,
                   PinState offState,
                   PinState onState)

using this constructor requires that the consumer define the SWITCH OPEN/OFF and SWITCH CLOSED/ON pin states

Parameters:

pin - GPIO digital input pin

offState - pin state to set when SWITCH is OPEN/OFF

onState - pin state to set when SWITCH is CLOSED/ON

GpioSwitchComponent

public GpioSwitchComponent(GpioPinDigitalInput pin)

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

Parameters:

pin - GPIO digital input pin

Method Detail

getState

public SwitchState getState()

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

Specified by:

getState in interface Switch

Specified by:

getState in class SwitchBase

Returns:

SwitchState