Package jmri.jmrix.mqtt

Class MqttLight

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractLight

jmri.implementation.AbstractVariableLight

jmri.jmrix.mqtt.MqttLight

All Implemented Interfaces:

Comparable<NamedBean>, EventListener, AnalogIO, PropertyChangeProvider, DigitalIO, MqttEventListener, Light, NamedBean, VariableLight

public class MqttLight
extends AbstractVariableLight
implements MqttEventListener

MQTT implementation of the Light interface.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.AnalogIO

AnalogIO.AbsoluteOrRelative

Nested classes/interfaces inherited from interface jmri.NamedBean

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	intensityText
(package private) MqttContentParser<Light>	parser

Fields inherited from class jmri.implementation.AbstractVariableLight

alarmSyncUpdate, internalClock, minuteChangeListener, mLastTransitionDate, mNextTransitionTs, mTransitionDuration, mTransitionTargetIntensity

Fields inherited from class jmri.implementation.AbstractLight

lightControlList, mActive, mCurrentIntensity, mEnabled, mMaxIntensity, mMinIntensity, mState

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.DigitalIO

OFF, ON

Fields inherited from interface jmri.Light

FAST_CLOCK_CONTROL, INTERMEDIATE, NO_CONTROL, PROPERTY_TARGET_INTENSITY, SENSOR_CONTROL, TIMED_ON_CONTROL, TRANSITIONING, TRANSITIONINGHIGHER, TRANSITIONINGLOWER, TRANSITIONINGTOFULLOFF, TRANSITIONINGTOFULLON, TURNOUT_STATUS_CONTROL, TWO_SENSOR_CONTROL

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.VariableLight

PROPERTY_CURRENT_INTENSITY, PROPERTY_MAX_INTENSITY, PROPERTY_MIN_INTENSITY

Constructor Summary

Constructors

Constructor	Description
MqttLight(MqttAdapter ma, String systemName, String userName, String sendTopic, String rcvTopic)

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.
protected void	doNewState(int oldState, int newState)	Implement the specific change of state needed by hardware.
protected int	getNumberOfSteps()	Provide the number of steps available between min and max intensity
void	notifyMqttMessage(String receivedTopic, String message)
void	requestUpdateFromLayout()	Request an update from the layout soft/hardware.
protected void	sendIntensity(double intensity)	Send a Dim/Bright commands to the hardware to reach a specific intensity.
protected void	sendOnOffCommand(int newState)	Send a On/Off Command to the hardware
void	setParser(MqttContentParser<Light> parser)
void	setState(int newState)	Handle a request for a state change.

Methods inherited from class jmri.implementation.AbstractVariableLight

describeState, getAbsoluteOrRelative, getCommandedAnalogValue, getCurrentIntensity, getMax, getMaxIntensity, getMin, getMinIntensity, getResolution, getState, getTargetIntensity, getTransitionTime, isTransitionAvailable, isTransitioning, newInternalMinute, notifyTargetIntensityChange, setCommandedAnalogValue, setMaxIntensity, setMinIntensity, setObservedAnalogValue, setState, setTargetIntensity, setTransitionTime, startTransition

Methods inherited from class jmri.implementation.AbstractLight

activateLight, addLightControl, clearLightControls, deactivateLight, getBeanType, getEnabled, getLightControlList, getState, getUsageReport, notifyStateChange, setEnabled

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.AnalogIO

getKnownAnalogValue

Methods inherited from interface jmri.Light

activateLight, addLightControl, clearLightControls, deactivateLight, getCommandedState, getEnabled, getKnownState, getLightControlList, getState, setCommandedState, setEnabled

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, getBeanType, 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.VariableLight

isConsistentState, isConsistentValue

Field Details

intensityText

public static String intensityText

parser

MqttContentParser<Light> parser

Constructor Details

MqttLight

public MqttLight(MqttAdapter ma,
 String systemName,
 String userName,
 String sendTopic,
 String rcvTopic)

Method Details

setParser

public void setParser(MqttContentParser<Light> parser)

getNumberOfSteps

protected int getNumberOfSteps()

Description copied from class: AbstractVariableLight

Provide the number of steps available between min and max intensity

Specified by:

getNumberOfSteps in class AbstractVariableLight

Returns:

number of steps

sendIntensity

protected void sendIntensity(double intensity)

Description copied from class: AbstractVariableLight

Send a Dim/Bright commands to the hardware to reach a specific intensity.

Specified by:

sendIntensity in class AbstractVariableLight

Parameters:

intensity - new intensity

sendOnOffCommand

protected void sendOnOffCommand(int newState)

Description copied from class: AbstractVariableLight

Send a On/Off Command to the hardware

Specified by:

sendOnOffCommand in class AbstractVariableLight

Parameters:

newState - new state

doNewState

protected void doNewState(int oldState,
 int newState)

Description copied from class: AbstractLight

Implement the specific change of state needed by hardware.

Overrides:

doNewState in class AbstractLight

Parameters:

oldState - old state

newState - new state

setState

public void setState(int newState)

Description copied from class: AbstractVariableLight

Handle a request for a state change. ON and OFF go to the MaxIntensity and MinIntensity, specifically, and all others are not permitted

ON and OFF avoid use of variable intensity if MaxIntensity = 1.0 or MinIntensity = 0.0, and no transition is being used.

Specified by:

setState in interface Light

Specified by:

setState in interface NamedBean

Overrides:

setState in class AbstractVariableLight

Parameters:

newState - new state

requestUpdateFromLayout

public void requestUpdateFromLayout()

Description copied from interface: VariableLight

Request an update from the layout soft/hardware. May not even happen, and if it does it will happen later; listen for the result.

Specified by:

requestUpdateFromLayout in interface AnalogIO

Specified by:

requestUpdateFromLayout in interface DigitalIO

Specified by:

requestUpdateFromLayout in interface Light

Specified by:

requestUpdateFromLayout in interface VariableLight

notifyMqttMessage

public void notifyMqttMessage(String receivedTopic,
 String message)

Specified by:

notifyMqttMessage in interface MqttEventListener

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

Overrides:

dispose in class AbstractNamedBean