Package jmri.jmrix.ieee802154.xbee
Class XBeeSensor
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.implementation.AbstractSensor
-
- jmri.jmrix.ieee802154.xbee.XBeeSensor
-
- All Implemented Interfaces:
com.digi.xbee.api.listeners.IIOSampleReceiveListener
,java.lang.Comparable<NamedBean>
,PropertyChangeProvider
,DigitalIO
,NamedBean
,Sensor
public class XBeeSensor extends AbstractSensor implements com.digi.xbee.api.listeners.IIOSampleReceiveListener
Extend jmri.AbstractSensor for XBee connections.
-
-
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 Modifier and Type Field Description protected XBeeTrafficController
tc
-
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.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 XBeeSensor(java.lang.String systemName, java.lang.String userName, XBeeTrafficController controller)
XBeeSensor(java.lang.String systemName, XBeeTrafficController controller)
-
Method Summary
All Methods Instance Methods Concrete Methods 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
ioSampleReceived(com.digi.xbee.api.RemoteXBeeDevice remoteDevice, com.digi.xbee.api.io.IOSample ioSample)
void
requestUpdateFromLayout()
Request an update on status by sending an XBee message.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, 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
-
-
-
-
Field Detail
-
tc
protected XBeeTrafficController tc
-
-
Constructor Detail
-
XBeeSensor
public XBeeSensor(java.lang.String systemName, java.lang.String userName, XBeeTrafficController controller)
-
XBeeSensor
public XBeeSensor(java.lang.String systemName, XBeeTrafficController controller)
-
-
Method Detail
-
requestUpdateFromLayout
public void requestUpdateFromLayout()
Request an update on status by sending an XBee message.- Specified by:
requestUpdateFromLayout
in interfaceDigitalIO
-
ioSampleReceived
public void ioSampleReceived(com.digi.xbee.api.RemoteXBeeDevice remoteDevice, com.digi.xbee.api.io.IOSample ioSample)
- Specified by:
ioSampleReceived
in interfacecom.digi.xbee.api.listeners.IIOSampleReceiveListener
-
setPullResistance
public void setPullResistance(Sensor.PullResistance r)
Set the pull resistance.In this default implementation, the input value is ignored.
- Specified by:
setPullResistance
in interfaceSensor
- Overrides:
setPullResistance
in classAbstractSensor
- Parameters:
r
- PullResistance value to use
-
getPullResistance
public Sensor.PullResistance getPullResistance()
Get the pull resistance.- Specified by:
getPullResistance
in interfaceSensor
- Overrides:
getPullResistance
in classAbstractSensor
- Returns:
- the currently set PullResistance value
-
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.
-
-