com.pi4j.component.sensor.impl

Class GpioSensorComponent

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.ObserveableComponentBase

com.pi4j.component.sensor.SensorBase

com.pi4j.component.sensor.impl.GpioSensorComponent

All Implemented Interfaces:

Component, ObserveableComponent, Sensor

public class GpioSensorComponent
extends SensorBase

Field Summary

Fields inherited from class com.pi4j.component.ObserveableComponentBase

listeners

Constructor Summary

Constructors

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

Method Summary

Methods

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

Methods inherited from class com.pi4j.component.sensor.SensorBase

addListener, isClosed, isOpen, 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

GpioSensorComponent

public GpioSensorComponent(GpioPinDigitalInput pin,
                   PinState openState,
                   PinState closedState)

using this constructor requires that the consumer define the SENSOR OPEN and SENSOR CLOSED pin states

Parameters:

pin - GPIO digital input pin

openState - pin state to set when SENSOR is OPEN

closedState - pin state to set when SENSOR is CLOSED

GpioSensorComponent

public GpioSensorComponent(GpioPinDigitalInput pin)

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

Parameters:

pin - GPIO digital input pin

Method Detail

getState

public SensorState getState()

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

Specified by:

getState in interface Sensor

Specified by:

getState in class SensorBase

Returns:

PowerState