Package jmri.jmrix.powerline.insteon2412s

Class SpecificInsteonLight

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractLight

jmri.implementation.AbstractVariableLight

jmri.jmrix.powerline.SerialLight

jmri.jmrix.powerline.insteon2412s.SpecificInsteonLight

All Implemented Interfaces:

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

public class SpecificInsteonLight
extends SerialLight

Implementation of the Light Object for Insteon receivers on Insteon 2412S interfaces.

Uses X10 dimming commands to set intensity unless the value is 0.0 or 1.0, in which case it uses on/off commands only.

Since the dim/bright step of the hardware is unknown then the Light object is first created, the first time the intensity (not state) is set to other than 0.0 or 1.0, the output is run to it's maximum dim or bright step so that we know the count is right.

Keeps track of the controller's "dim count", and if not certain forces it to zero to be sure.

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
(package private) int	lastOutputStep	Current output step 0 to maxDimStep.
(package private) int	maxDimStep	Largest Insteon dim step number available.
(package private) int	maxHops	Value for retransmission
(package private) SerialTrafficController	tc

Fields inherited from class jmri.jmrix.powerline.SerialLight

devicecode, housecode, idhighbyte, idlowbyte, idmiddlebyte, unitid

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
SpecificInsteonLight(String systemName, SerialTrafficController tc)	Create a Light object, with only system name.
SpecificInsteonLight(String systemName, SerialTrafficController tc, String userName)	Create a Light object, with both system and user names.

Method Summary

Modifier and Type	Method	Description
int	getMaxHops()
protected int	getNumberOfSteps()	Number of steps from dim to bright is maintained in specific SerialTrafficController implementation
protected void	initIntensity(double intensity)	Invoked the first time intensity is set.
protected void	sendIntensity(double intensity)	Send a Dim/Bright command to the Insteon hardware to reach a specific intensity.
protected void	sendOnOffCommand(int newState)	Send a On/Off Command to the hardware
void	setMaxHops(int maxHops)

Methods inherited from class jmri.jmrix.powerline.SerialLight

initializeLight

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, setState, setTargetIntensity, setTransitionTime, startTransition

Methods inherited from class jmri.implementation.AbstractLight

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

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, dispose, 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, dispose, 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, requestUpdateFromLayout

Field Details

lastOutputStep

int lastOutputStep

Current output step 0 to maxDimStep.

-1 means unknown

maxDimStep

int maxDimStep

Largest Insteon dim step number available.

maxHops

int maxHops

Value for retransmission

tc

SerialTrafficController tc

Constructor Details

SpecificInsteonLight

public SpecificInsteonLight(String systemName,
 SerialTrafficController tc)

Create a Light object, with only system name.

'systemName' was previously validated in SerialLightManager

Parameters:

systemName - text for systemName of light

tc - tc for connection

SpecificInsteonLight

public SpecificInsteonLight(String systemName,
 SerialTrafficController tc,
 String userName)

Create a Light object, with both system and user names.

'systemName' was previously validated in SerialLightManager

Parameters:

systemName - text for systemName of light

tc - tc for connection

userName - text for userName of light

Method Details

getMaxHops

public int getMaxHops()

setMaxHops

public void setMaxHops(int maxHops)

initIntensity

protected void initIntensity(double intensity)

Invoked the first time intensity is set.

Overrides:

initIntensity in class SerialLight

Parameters:

intensity - The next intensity value that will be set

sendIntensity

protected void sendIntensity(double intensity)

Send a Dim/Bright command to the Insteon hardware to reach a specific intensity. Acts immediately, and changes no general state.

This sends "Dim" commands.

Specified by:

sendIntensity in class AbstractVariableLight

Parameters:

intensity - new intensity

getNumberOfSteps

protected int getNumberOfSteps()

Number of steps from dim to bright is maintained in specific SerialTrafficController implementation

Specified by:

getNumberOfSteps in class AbstractVariableLight

Returns:

number of steps

sendOnOffCommand

protected void sendOnOffCommand(int newState)

Send a On/Off Command to the hardware

Overrides:

sendOnOffCommand in class SerialLight

Parameters:

newState - new state