com.ergotech.vib.servers.modbus.slave

Class ModbusSlaveBase

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.servers.modbus.slave.ModbusSlaveBase

All Implemented Interfaces:

SimulationListener

Direct Known Subclasses:

ModbusRTUSlave, ModbusSlave

public abstract class ModbusSlaveBase
extends Manipulator
implements SimulationListener

This beans implements the slave side of a Modbus connection. That is, it simulates registers in the 4X/3x address space (eg 40001, 30001) and in the coil/input address space. The 4x/3x and the 0x/1x address space overlap that is, setting a 4x register will cause the corresponding 3x register to update and setting a 0x will cause the correspond 1x register to update. The number of registers/coils simulated is set by the maximum address. The slave can be a slave for multiple unit (station) ids. The unit ids always start at zero and increase from there. The slave provides notification of changes to the internal block. The only output is an array value object that has the whole of the address block (process image). The areas of the process image that will cause a change notification can be set. The slave can also be triggered to cause the whole of the image to be sent to the output. The trigger must be the unit ID that is required at the output.

Nested Class Summary

Nested classes/interfaces inherited from class com.ergotech.vib.servers.SimpleDataSource

SimpleDataSource.NameEditorData

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

Fields inherited from class com.ergotech.vib.servers.SimpleDataSource

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
ModbusSlaveBase()

Method Summary

Modifier and Type	Method and Description
abstract void	createListener()
void	createProcessImage() Create the process image..
int	getCoilNotifyMax()
int	getCoilNotifyMin()
int	getMaximumCoilAddress() Returns the maximum coil address.
int	getMaximumRegisterAddress() Returns the maximum register address.
int	getMaxUnitId()
int	getPort() Returns the current port.
int	getRegNotifyMax()
int	getRegNotifyMin()
int	getValueAt(int offset) Returns the value at a particular register offset.
boolean	isListening() This method will return true if the server is running.
boolean	isSimulating()
void	modifiedCoils(BlockProcessImage image)
void	modifiedRegisters(BlockProcessImage image)
void	setCoilNotifyMax(int coilNotifyMax)
void	setCoilNotifyMin(int coilNotifyMin)
void	setMaximumCoilAddress(int maximumCoilAddress) Sets the maximum coil address that this simulator will respond to.
void	setMaximumRegisterAddress(int maximumRegisterAddress) Sets the maximum register address that this simulator will respond to.
void	setMaxUnitId(int maxUnitId)
void	setPort(int port) Sets the port to listen on.
void	setRegNotifyMax(int regNotifyMax)
void	setRegNotifyMin(int regNotifyMin)
void	setSimulationFlag(boolean simulationFlag) Force the listener to understand this method.
void	setValueAt(int offset, int value) Sets the value at a particular offset into the block.
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) Sets/resets the global simulation flag.
void	start() Create the listener.
void	stop() Stop the server permanently.
void	stopThread() Requests the that listening thread be stopped.
void	valueInput(ValueChangedEvent newEvent) The trigger input.

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getDefaultQualityForLocation, getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, tick, VIBEvent

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

ModbusSlaveBase

public ModbusSlaveBase()

Method Detail

createListener

public abstract void createListener()

createProcessImage

public void createProcessImage()

Create the process image..

getCoilNotifyMax

public int getCoilNotifyMax()

Returns:

Returns the coilNotifyMax.

getCoilNotifyMin

public int getCoilNotifyMin()

Returns:

Returns the coilNotifyMin.

getMaximumCoilAddress

public int getMaximumCoilAddress()

Returns the maximum coil address.

getMaximumRegisterAddress

public int getMaximumRegisterAddress()

Returns the maximum register address.

getMaxUnitId

public int getMaxUnitId()

Returns:

Returns the maxUnitId.

getPort

public int getPort()

Returns the current port.

getRegNotifyMax

public int getRegNotifyMax()

Returns:

Returns the regNotifyMax.

getRegNotifyMin

public int getRegNotifyMin()

Returns:

Returns the regNotifyMin.

getValueAt

public int getValueAt(int offset)

Returns the value at a particular register offset. This is used for unit testing.

isListening

public boolean isListening()

This method will return true if the server is running.

isSimulating

public boolean isSimulating()

Returns:

Returns the simulation.

modifiedCoils

public void modifiedCoils(BlockProcessImage image)
                   throws VIBUpdateFailedException

Parameters:

image -

Throws:

VIBUpdateFailedException

modifiedRegisters

public void modifiedRegisters(BlockProcessImage image)
                       throws VIBUpdateFailedException

Parameters:

image -

Throws:

VIBUpdateFailedException

setCoilNotifyMax

public void setCoilNotifyMax(int coilNotifyMax)

Parameters:

coilNotifyMax - The coilNotifyMax to set.

setCoilNotifyMin

public void setCoilNotifyMin(int coilNotifyMin)

Parameters:

coilNotifyMin - The coilNotifyMin to set.

setMaximumCoilAddress

public void setMaximumCoilAddress(int maximumCoilAddress)

Sets the maximum coil address that this simulator will respond to. This also starts the listening thread. Modifying this value after the listening thread has been started will have the effect of stopping and restarting the listening thread. Any data written that had been written to the server prior to this call will be lost. This includes both coil and register data.

setMaximumRegisterAddress

public void setMaximumRegisterAddress(int maximumRegisterAddress)

Sets the maximum register address that this simulator will respond to. This also starts the listening thread. Modifying this value after the listening thread has been started will have the effect of stopping and restarting the listening thread. Any data written that had been written to the server prior to this call will be lost. This includes both coil and register data.

setMaxUnitId

public void setMaxUnitId(int maxUnitId)

Parameters:

maxUnitId - The maxUnitId to set.

setPort

public void setPort(int port)

Sets the port to listen on. This should be left as 502 unless there is some valid reason to listen on a different port.

setRegNotifyMax

public void setRegNotifyMax(int regNotifyMax)

Parameters:

regNotifyMax - The regNotifyMax to set.

setRegNotifyMin

public void setRegNotifyMin(int regNotifyMin)

Parameters:

regNotifyMin - The regNotifyMin to set.

setSimulationFlag

public void setSimulationFlag(boolean simulationFlag)

Description copied from interface: SimulationListener

Force the listener to understand this method. This method will be generated in the source code for any SimulationListener with a value of "false". This forces all systems to be live when deployed (unless the global simulation -D option is set.) This simulation flag may, or may not be controlled by the simulationChangedEvent above. For example, in the PLCs the simulationChangedEvent causes the global simulation flag to be set or reset, whereas the setSimulationFlag causes a local simulation flag to change. Again in the case of PLCs both flags must be false for the system to connect to the real device.

Specified by:

setSimulationFlag in interface SimulationListener

Parameters:

simulationFlag - will be written as "false" when code is generated.

setValueAt

public void setValueAt(int offset,
                       int value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at a particular offset into the block. This is used for unit testing. This uses the Modicon style addressing, that it, it is "one" based so to write to the zero'th element of the address block, perhaps known as 40001 send a "1" as the offset. This means that it matches the "normal" addressing scheme for the modbus servers, that is, setting value 4 here can be read in an ModbusServer by setting the register to "4".

Throws:

java.lang.ArrayIndexOutOfBoundsException

simulationStateChanged

public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)

Sets/resets the global simulation flag.

Specified by:

simulationStateChanged in interface SimulationListener

See Also:

SimulationListener.simulationStateChanged(com.ergotech.util.SimulationChangedEvent)

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Create the listener.

Overrides:

start in class SimpleDataSource

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

SimpleDataSource.start()

stop

public void stop()
          throws BadParameterException

Stop the server permanently. This calls stopThread and then the superclass method.

Overrides:

stop in class SimpleDataSource

Throws:

BadParameterException

See Also:

vib.servers.DataSourceInterface#stop()

stopThread

public void stopThread()

Requests the that listening thread be stopped.

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

The trigger input. Sending an integer value to this method will cause the process images for the corresponding unit (station) ids to appear at the outputs.

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException

See Also:

Manipulator.valueInput(com.ergotech.vib.valueobjects.ValueChangedEvent)