com.ergotech.vib.servers.modbus

Class ModbusRTUDeviceServer

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.vib.servers.DeviceManagerManipulator

com.ergotech.vib.ports.PortDeviceServer

com.ergotech.vib.servers.plc.PLCDeviceServer

com.ergotech.vib.servers.modbus.ModbusDeviceServerBase

com.ergotech.vib.servers.modbus.ModbusRTUDeviceServerBase

com.ergotech.vib.servers.modbus.ModbusRTUDeviceServer

All Implemented Interfaces:

SimulationListener

Direct Known Subclasses:

ModbusASCIIDeviceServer

public class ModbusRTUDeviceServer
extends ModbusRTUDeviceServerBase

This component extends the ModbusRTUDeviceServerBase to add a Serial port to the object. This component must be placed in a design and can be configured either with the properties, or dynamically (connections). There one properties added, the serial port number. Whenever this is valid, an attempt is made to create a port for the device server.

Nested Class Summary

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

ModbusDeviceServerBase.TimingMetrics

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
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.

Fields inherited from class com.ergotech.vib.servers.modbus.ModbusDeviceServerBase

metricPrintFrequency, modbusDeviceServers

Fields inherited from class com.ergotech.vib.servers.plc.PLCDeviceServer

sharedPLCSimulation

Fields inherited from class com.ergotech.vib.ports.PortDeviceServer

CANNOT_OPEN_PORT, currentErrorCount, debugLevel, DEFAULT_NAME, globalDebugLevel, globalSimulation, MISSING_PARAMETER, NO_ERROR, NO_PORT, NO_RESOURCES, PORT_ERROR, READ_ERROR, TOO_MANY_ERRORS_STRING, UNKNOWN_ERROR, WRITE_ERROR

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, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
ModbusRTUDeviceServer() This sets the factory name.

Method Summary

Modifier and Type	Method and Description
void	_initializePortPool() If the port and host are set, this creates the factory for this object.
int	getBaudRate()
int	getFlowControl()
int	getParity()
int	getPortNumber() Returns the serial port number.
int	getStaticLocationFor(java.lang.String method) This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object.
int	getStopBits()
void	initializePortPool() Sets the SerialPort parameters after creating the port.
void	setBaudRate(int baudRate)
void	setFlowControl(int flowControl)
void	setParity(int parity)
void	setPortNumber(int portNumber) Sets the serial port number of the PLC.
void	setSerialPortParameters() Sets the SerialPort parameters.
void	setStopBits(int stopBits)
void	valueChanged(int loc, ValueChangedEvent e) This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object.

Methods inherited from class com.ergotech.vib.servers.modbus.ModbusRTUDeviceServerBase

start, toString

Methods inherited from class com.ergotech.vib.servers.modbus.ModbusDeviceServerBase

availableServers, deviceType, forceLoad, getModbusDeviceServers, isBlockReads, readDevice, setBlockReads, setName, setTimebase, stop, writeDevice

Methods inherited from class com.ergotech.vib.servers.plc.PLCDeviceServer

addServer, aggregateBlocks, destroy, getBlocksForType, getMaximumBlockOffset, getRegisterBlock, getRegisterBlockLocal, getRegisterBlockShared, hasServers, printException, readAllLongTimebaseServers, removeServer, setMaximumBlockOffset, simulatedWrite, simulatedWrite, simulateRead, simulationStateChanged

Methods inherited from class com.ergotech.vib.ports.PortDeviceServer

canConnect, clearMessageLog, configurePort, equals, getLinkTimeout, getLinkTimeoutMilliseconds, getResponseTimeout, incrementErrorCount, init, isSimulating, isSimulationFlag, messageLog, releasePortPool, resetErrorCount, setLinkTimeout, setResponseTimeout, setSimulationFlag

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

clientRequest, createServer, deleteDevice, deleteServer, earlyStart, getEditableServers, getPersistentServers, getServerContainer, getServers, getServersInternal, getViewServers, preparingServer, setContainer, setServers

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

getDefaultQualityForLocation

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

getInPortNames, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueInput

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientResponse, 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, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, 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, 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

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

PORT_FACTORY_NAME

public static final java.lang.String PORT_FACTORY_NAME

The name of the port factory. This is "SerialPortFactory".

See Also:

Constant Field Values

Constructor Detail

ModbusRTUDeviceServer

public ModbusRTUDeviceServer()

This sets the factory name.

Method Detail

_initializePortPool

public void _initializePortPool()

If the port and host are set, this creates the factory for this object. This will do nothing if the factory name has not been set, or the port name is not set.

Overrides:

_initializePortPool in class ModbusDeviceServerBase

Parameters:

factoryName -

getBaudRate

public int getBaudRate()

Returns:

Returns the baudRate.

getFlowControl

public int getFlowControl()

Returns:

Returns the flowControl.

getParity

public int getParity()

Returns:

Returns the parity.

getPortNumber

public int getPortNumber()

Returns the serial port number.

Returns:

Returns the portNumber.

getStaticLocationFor

public int getStaticLocationFor(java.lang.String method)
                         throws BadParameterException

This is the default getStaticLocationFor with a location used by the staticmethodevent to find a specific entry value object. This will return 0 every time.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

getStopBits

public int getStopBits()

Returns:

Returns the stopBits.

initializePortPool

public void initializePortPool()

Sets the SerialPort parameters after creating the port.

Overrides:

initializePortPool in class PortDeviceServer

See Also:

PortDeviceServer.initializePortPool()

setBaudRate

public void setBaudRate(int baudRate)

Parameters:

baudRate - The baudRate to set.

setFlowControl

public void setFlowControl(int flowControl)

Parameters:

flowControl - The flowControl to set.

setParity

public void setParity(int parity)

Parameters:

parity - The parity to set.

setPortNumber

public void setPortNumber(int portNumber)

Sets the serial port number of the PLC.

Parameters:

portNumber - The portNumber to set.

setSerialPortParameters

public void setSerialPortParameters()

Sets the SerialPort parameters.

setStopBits

public void setStopBits(int stopBits)

Parameters:

stopBits - The stopBits to set.

valueChanged

public void valueChanged(int loc,
                         ValueChangedEvent e)
                  throws VIBUpdateFailedException,
                         BadParameterException

This is the default valuechanged with a location used by the staticmethodevent to find a specific entry value object. This will call valuechanged every time.

Overrides:

valueChanged in class Manipulator

Throws:

VIBUpdateFailedException

BadParameterException