Package jmri.jmrix.pi

Class RaspberryPiSensor

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSensor

jmri.jmrix.pi.RaspberryPiSensor

All Implemented Interfaces:

com.pi4j.io.gpio.event.GpioPinListener, com.pi4j.io.gpio.event.GpioPinListenerDigital, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, DigitalIO, NamedBean, Sensor

public class RaspberryPiSensor
extends AbstractSensor
implements com.pi4j.io.gpio.event.GpioPinListenerDigital

Sensor interface for RaspberryPi GPIO pins.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Nested classes/interfaces inherited from interface jmri.Sensor

Sensor.PullResistance

Field Summary

Fields inherited from class jmri.implementation.AbstractSensor

_inverted, _knownState, _rawState, r, sensorDebounceGoingActive, sensorDebounceGoingInActive, thr, useDefaultTimerSettings

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.DigitalIO

OFF, ON

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.Sensor

ACTIVE, INACTIVE, MAX_DEBOUNCE

Constructor Summary

Constructors

Constructor	Description
RaspberryPiSensor(java.lang.String systemName)
RaspberryPiSensor(java.lang.String systemName, com.pi4j.io.gpio.PinPullResistance p)
RaspberryPiSensor(java.lang.String systemName, java.lang.String userName)
RaspberryPiSensor(java.lang.String systemName, java.lang.String userName, com.pi4j.io.gpio.PinPullResistance p)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
Sensor.PullResistance	getPullResistance()	Get the pull resistance
void	handleGpioPinDigitalStateChangeEvent(com.pi4j.io.gpio.event.GpioPinDigitalStateChangeEvent event)
void	requestUpdateFromLayout()	Request an update on status by sending an Instruction to the Pi.
void	setPullResistance(Sensor.PullResistance r)	Set the pull resistance.

Methods inherited from class jmri.implementation.AbstractSensor

canInvert, describeState, getBeanType, getInverted, getKnownState, getRawState, getReporter, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, getUseDefaultTimerSettings, sensorDebounce, setInverted, setKnownState, setOwnState, setReporter, setSensorDebounceGoingActiveTimer, setSensorDebounceGoingInActiveTimer, setState, setUseDefaultTimerSettings, stateChangeCheck

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.Sensor

getCommandedState, isConsistentState, setCommandedState

Constructor Detail

RaspberryPiSensor

public RaspberryPiSensor(java.lang.String systemName,
                         java.lang.String userName)

RaspberryPiSensor

public RaspberryPiSensor(java.lang.String systemName,
                         java.lang.String userName,
                         com.pi4j.io.gpio.PinPullResistance p)

RaspberryPiSensor

public RaspberryPiSensor(java.lang.String systemName)

RaspberryPiSensor

public RaspberryPiSensor(java.lang.String systemName,
                         com.pi4j.io.gpio.PinPullResistance p)

Method Detail

requestUpdateFromLayout

public void requestUpdateFromLayout()

Request an update on status by sending an Instruction to the Pi.

Specified by:

requestUpdateFromLayout in interface DigitalIO

handleGpioPinDigitalStateChangeEvent

public void handleGpioPinDigitalStateChangeEvent(com.pi4j.io.gpio.event.GpioPinDigitalStateChangeEvent event)

Specified by:

handleGpioPinDigitalStateChangeEvent in interface com.pi4j.io.gpio.event.GpioPinListenerDigital

setPullResistance

public void setPullResistance(Sensor.PullResistance r)

Set the pull resistance.

In this default implementation, the input value is ignored.

Specified by:

setPullResistance in interface Sensor

Overrides:

setPullResistance in class AbstractSensor

Parameters:

r - PullResistance value to use.

getPullResistance

public Sensor.PullResistance getPullResistance()

Get the pull resistance

Specified by:

getPullResistance in interface Sensor

Overrides:

getPullResistance in class AbstractSensor

Returns:

the currently set PullResistance value. In this default implementation, PullResistance.PULL_OFF is always returned.

dispose

public void dispose()

Description copied from class: AbstractNamedBean

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

Specified by:

dispose in interface NamedBean

Specified by:

dispose in interface Sensor

Overrides:

dispose in class AbstractSensor