Package jmri.jmrix.ieee802154.xbee

Class XBeeSensorManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Sensor>

jmri.managers.AbstractSensorManager

jmri.jmrix.ieee802154.xbee.XBeeSensorManager

All Implemented Interfaces:

com.digi.xbee.api.listeners.IIOSampleReceiveListener, PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Sensor>, ProvidingManager<Sensor>, SensorManager

public class XBeeSensorManager
extends AbstractSensorManager
implements com.digi.xbee.api.listeners.IIOSampleReceiveListener

Manage the XBee specific Sensor implementation. System names are formatted as one of:

• "ZSnnn", where nnn is the sensor number without padding
• "ZSstring:pin", where string is a node address and pin is the io pin used.

Z is the user-configurable system prefix.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager

Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity

Field Summary

Fields

Modifier and Type	Field	Description
protected XBeeTrafficController	tc

Fields inherited from class jmri.managers.AbstractSensorManager

sensorDebounceGoingActive, sensorDebounceGoingInActive

Fields inherited from class jmri.managers.AbstractManager

_beans, _tsys, _tuser, memo, silenceableProperties, silencedProperties

Fields inherited from class jmri.beans.VetoableChangeSupport

vetoableChangeSupport

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Fields inherited from interface jmri.Manager

ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

Constructors

Constructor	Description
XBeeSensorManager(XBeeConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(String systemName)	Determines if it is possible to add a range of sensors in numerical order.
protected Sensor	createNewSensor(String systemName, String userName)	Internal method to invoke the factory and create a new Sensor.
String	createSystemName(String curAddress, String prefix)	Default Sensor ensures a numeric only system name.
void	deregister(Sensor s)	Forget a NamedBean Object created outside the manager.
void	dispose()	Free resources when no longer used.
String	getEntryToolTip()	Provide a manager-specific tooltip for the Add new item beantable pane.
XBeeConnectionMemo	getMemo()	Get the system connection for this manager.
void	ioSampleReceived(com.digi.xbee.api.RemoteXBeeDevice remoteDevice, com.digi.xbee.api.io.IOSample ioSample)
boolean	isPullResistanceConfigurable()	Do the sensor objects provided by this manager support configuring an internal pullup or pull down resistor?
String	validateSystemNameFormat(String name, Locale locale)	Validate the format of name, returning it unchanged if valid.
Manager.NameValidity	validSystemNameFormat(String systemName)	Test if parameter is a properly formatted system name.

Methods inherited from class jmri.managers.AbstractSensorManager

getBeanTypeHandled, getBySystemName, getDefaultSensorDebounceGoingActive, getDefaultSensorDebounceGoingInActive, getNamedBeanClass, getSensor, getXMLOrder, newSensor, provideSensor, setDefaultSensorDebounceGoingActive, setDefaultSensorDebounceGoingInActive, typeLetter, updateAll

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, deleteBean, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getNextValidAddress, getObjectCount, getSystemNameList, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, vetoableChange

Methods inherited from class jmri.beans.VetoableChangeSupport

addVetoableChangeListener, addVetoableChangeListener, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.SensorManager

getByUserName, getNextValidAddress, getNextValidAddress, provide

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Details

tc

protected XBeeTrafficController tc

Constructor Details

XBeeSensorManager

public XBeeSensorManager(XBeeConnectionMemo memo)

Method Details

getMemo

@Nonnull public XBeeConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Sensor>

Overrides:

getMemo in class AbstractManager<Sensor>

Returns:

the system connection for this manager

dispose

public void dispose()

Description copied from class: AbstractManager

Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.

Specified by:

dispose in interface Manager<Sensor>

Specified by:

dispose in interface SensorManager

Overrides:

dispose in class AbstractManager<Sensor>

createNewSensor

@Nonnull protected Sensor createNewSensor(@Nonnull String systemName, String userName) throws IllegalArgumentException

Internal method to invoke the factory and create a new Sensor. Called after all the logic for returning an existing Sensor has been invoked. An existing SystemName is not found, existing UserName not found. Implementing classes should base Sensor on the system name, then add user name.

System name is normalized to ensure uniqueness.

Specified by:

createNewSensor in class AbstractSensorManager

Parameters:

systemName - the system name to use for the new Sensor

userName - the optional user name to use for the new Sensor

Returns:

the new Sensor

Throws:

IllegalArgumentException - when SystemName can't be converted

validateSystemNameFormat

@Nonnull public String validateSystemNameFormat(@Nonnull String name, @Nonnull Locale locale)

Validate the format of name, returning it unchanged if valid.

Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.

Overriding implementations may rely on Manager.validSystemNameFormat(java.lang.String), however they must provide an actionable message in the thrown exception if that method does not return Manager.NameValidity.VALID. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.

Specified by:

validateSystemNameFormat in interface Manager<Sensor>

Parameters:

name - the system name to validate

locale - the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales

Returns:

the unchanged value of the name parameter

validSystemNameFormat

public Manager.NameValidity validSystemNameFormat(@Nonnull String systemName)

Test if parameter is a properly formatted system name. Implementations of this method must not throw an exception, log an error, or otherwise disrupt the user.

Specified by:

validSystemNameFormat in interface Manager<Sensor>

Overrides:

validSystemNameFormat in class AbstractManager<Sensor>

Parameters:

systemName - the system name

Returns:

Manager.NameValidity.INVALID if system name does not start with Manager.getSystemNamePrefix(); Manager.NameValidity.VALID_AS_PREFIX_ONLY if system name equals Manager.getSystemNamePrefix(); otherwise Manager.NameValidity.VALID to allow Managers that do not perform more specific validation to be considered valid.

ioSampleReceived

public void ioSampleReceived(com.digi.xbee.api.RemoteXBeeDevice remoteDevice, com.digi.xbee.api.io.IOSample ioSample)

Specified by:

ioSampleReceived in interface com.digi.xbee.api.listeners.IIOSampleReceiveListener

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull String systemName)

Description copied from class: AbstractSensorManager

Determines if it is possible to add a range of sensors in numerical order.

Specified by:

allowMultipleAdditions in interface SensorManager

Overrides:

allowMultipleAdditions in class AbstractSensorManager

Parameters:

systemName - the system name to check against; appears to be ignored in all implementations

Returns:

true if possible; false otherwise

createSystemName

@Nonnull public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException

Description copied from class: AbstractSensorManager

Default Sensor ensures a numeric only system name. Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation.

Specified by:

createSystemName in interface SensorManager

Overrides:

createSystemName in class AbstractSensorManager

Parameters:

curAddress - hardware address, no system prefix or type letter.

prefix - - just system prefix, not including Type Letter.

Returns:

full system name with system prefix, type letter and hardware address.

Throws:

JmriException - if unable to create a system name.

deregister

public void deregister(@Nonnull Sensor s)

Description copied from class: AbstractManager

Forget a NamedBean Object created outside the manager.

The non-system-specific RouteManager uses this method.

Specified by:

deregister in interface Manager<Sensor>

Overrides:

deregister in class AbstractManager<Sensor>

Parameters:

s - the bean

isPullResistanceConfigurable

public boolean isPullResistanceConfigurable()

Do the sensor objects provided by this manager support configuring an internal pullup or pull down resistor?

For Raspberry Pi systems, it is possible to set the pullup or pulldown resistor, so return true.

Specified by:

isPullResistanceConfigurable in interface SensorManager

Overrides:

isPullResistanceConfigurable in class AbstractSensorManager

Returns:

true if pull up/pull down configuration is supported.

getEntryToolTip

public String getEntryToolTip()

Provide a manager-specific tooltip for the Add new item beantable pane.

Specified by:

getEntryToolTip in interface Manager<Sensor>

Specified by:

getEntryToolTip in interface SensorManager

Overrides:

getEntryToolTip in class AbstractSensorManager

Returns:

the tool tip or null to disable the tool tip