com.pi4j.component.button.impl

Class GpioButtonComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.button.ButtonBase

com.pi4j.component.button.impl.GpioButtonComponent

All Implemented Interfaces:

Button, Component, ObserveableComponent

public class GpioButtonComponent
extends ButtonBase

Field Summary

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

Constructor and Description
GpioButtonComponent(GpioPinDigitalInput pin) default constructor; using this constructor assumes that: (1) a pin state of HIGH is BUTTON PRESSED (2) a pin state of LOW is BUTTON RELEASED
GpioButtonComponent(GpioPinDigitalInput pin, PinState releasedState, PinState pressedState) using this constructor requires that the consumer define the BUTTON PRESSED/RELEASED pin states

Method Summary

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

Methods inherited from class com.pi4j.component.button.ButtonBase

addListener, addListener, addListener, addListener, isPressed, isReleased, isState, notifyListeners, removeListener, removeListener, removeListener, 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

GpioButtonComponent

public GpioButtonComponent(GpioPinDigitalInput pin,
                           PinState releasedState,
                           PinState pressedState)

using this constructor requires that the consumer define the BUTTON PRESSED/RELEASED pin states

Parameters:

pin - GPIO digital input pin

releasedState - pin state to set when BUTTON is RELEASED

pressedState - pin state to set when BUTTON is PRESSED

GpioButtonComponent

public GpioButtonComponent(GpioPinDigitalInput pin)

default constructor; using this constructor assumes that: (1) a pin state of HIGH is BUTTON PRESSED (2) a pin state of LOW is BUTTON RELEASED

Parameters:

pin - GPIO digital input pin

Method Detail

getState

public ButtonState getState()

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

Specified by:

getState in interface Button

Specified by:

getState in class ButtonBase

Returns:

ButtonState