com.ergotech.vib.servers.ppi

Class CP243SlaveDeviceServer

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.ppi.CP243SlaveDeviceServer

All Implemented Interfaces:

SimulationListener, java.lang.Runnable

public class CP243SlaveDeviceServer
extends PLCDeviceServer
implements java.lang.Runnable

This server listens for incoming message from a Siemens PLC. It will receive messages from any number of IP addresses. The PLC must be correctly configured to send these messages. This means that, for example, in MicroWin the Internet or Ethernet Wizard must be used to create TSAP "Client" connection. This connection can have read and/or write data transfers. From the PLC perspective a read transfer reads data from the remote, that is, from this component. This means that from the persective of this component, this is a write. The Write transfer is then the way to transfer data from the PLC to the Computer.

There are a number of outputs from this component:

New Target DataSource: This outputs the ip address of any PLC that has not previously been seen.

Last Written DataSource: This outputs the ArrayValueObject of the last data received from a PLC. The ArrayValueObject contains the IP address of the PLC as the zero'th element.

Selected Output DataSource: This outputs the last values read from the PLC that is selected by the currentKeyInput input. This output will be updated whenever the key is changed or when new values are received.

Watchdog DataSource: This output will output the hostname/ip address of a PLC if the time since it was last accessed is greater than the timeout. The output will repeat every timeout unless a message is received.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CP243SlaveDeviceServer.PPITarget

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.util.Vector	fetchWriteDeviceServers We maintain a list of all instances of ModbusDeviceServers which can be readily accessed when creating a list for the editor.
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.

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
CP243SlaveDeviceServer() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	_initializePortPool() If the port and host are set, this creates the factory for this object.
java.util.LinkedHashMap	availableServers() No servers are available currently.
SimpleDataSource	createServer(java.lang.String className, java.lang.String serverName) This method should never be called since "availableServers" returns null.
void	currentKeyInput(ValueChangedEvent e) Changes the value of the key that is currently being sent to the selected output data source.
void	forceDependency() Force a dependency on the com.ergotech.vib.ports.TCPPassivePortFactory.
static java.util.Vector	getFetchWriteDeviceServers()
int	getPortNumber() Returns the PLC 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.
CP243SlaveDeviceServer.PPITarget	getTarget(java.lang.String sourceAddress) Returns a valid target for the given source address creating one if necessary.
int	getTimeout()
void	listenForMessages(TCPPassiveSocket socket) Listens on the socket and handles incoming messages.
PLCDataBlock	readDevice(PLCDataBlock msgOut) A PLC transaction.
void	run() Listens on the port.
void	setPortNumber(int portNumber) Sets the port number of the PLC.
void	setTimeout(int timeout)
void	simulationStateChanged(SimulationChangedEvent simulationChangedEvent) Starts the listening thread when moving out of simulation mode.
void	start() initialize the port pool once the container has been set.
java.lang.String	toString() Return the string representation of this object.
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.
void	valueInput(ValueChangedEvent newEvent) This method accepts data that is to be sent to the PLC.
void	VIBEvent(VIBEvent vibEvent) Resets "applethost".
PLCDataBlock	writeDevice(PLCDataBlock msgOut) Writes the packet to the PLC.

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, stop

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

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

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

clientRequest, 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

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

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

fetchWriteDeviceServers

public static java.util.Vector fetchWriteDeviceServers

We maintain a list of all instances of ModbusDeviceServers which can be readily accessed when creating a list for the editor.

PORT_FACTORY_NAME

public static final java.lang.String PORT_FACTORY_NAME

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

See Also:

Constant Field Values

Constructor Detail

CP243SlaveDeviceServer

public CP243SlaveDeviceServer()

The default constructor.

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.

Parameters:

factoryName -

availableServers

public java.util.LinkedHashMap availableServers()

No servers are available currently.

Overrides:

availableServers in class DeviceManagerManipulator

Returns:

a hash of server name vs server class for the demo servers.

createServer

public SimpleDataSource createServer(java.lang.String className,
                                     java.lang.String serverName)
                              throws BadParameterException

This method should never be called since "availableServers" returns null.

Overrides:

createServer in class DeviceManagerManipulator

Throws:

BadParameterException

See Also:

availableServers()

currentKeyInput

public void currentKeyInput(ValueChangedEvent e)
                     throws VIBUpdateFailedException

Changes the value of the key that is currently being sent to the selected output data source.

Throws:

VIBUpdateFailedException

forceDependency

public void forceDependency()

Force a dependency on the com.ergotech.vib.ports.TCPPassivePortFactory. This method should never be called.

getFetchWriteDeviceServers

public static java.util.Vector getFetchWriteDeviceServers()

Returns:

Returns the PPI DeviceServers.

getPortNumber

public int getPortNumber()

Returns the PLC port number. This is almost always 502.

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

getTarget

public CP243SlaveDeviceServer.PPITarget getTarget(java.lang.String sourceAddress)

Returns a valid target for the given source address creating one if necessary.

Parameters:

sourceAddress -

Returns:

getTimeout

public int getTimeout()

Returns:

Returns the timeout.

listenForMessages

public void listenForMessages(TCPPassiveSocket socket)

Listens on the socket and handles incoming messages. This method will exit on any port error.

See Also:

Runnable.run()

readDevice

public PLCDataBlock readDevice(PLCDataBlock msgOut)
                        throws PLCException

Description copied from class: PLCDeviceServer

A PLC transaction. Send out the message, get the reply and return it.

Specified by:

readDevice in class PLCDeviceServer

Parameters:

msgOut - the message to send

Throws:

PLCException

run

public void run()

Listens on the port.

Specified by:

run in interface java.lang.Runnable

See Also:

Runnable.run()

setPortNumber

public void setPortNumber(int portNumber)

Sets the port number of the PLC. This should normally be left as 502.

Parameters:

portNumber - The portNumber to set.

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - The timeout to set.

simulationStateChanged

public void simulationStateChanged(SimulationChangedEvent simulationChangedEvent)
                            throws java.lang.Exception

Starts the listening thread when moving out of simulation mode.

Specified by:

simulationStateChanged in interface SimulationListener

Overrides:

simulationStateChanged in class PLCDeviceServer

Throws:

java.lang.Exception - TODO

See Also:

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

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

initialize the port pool once the container has been set.

Overrides:

start in class PLCDeviceServer

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

PLCDeviceServer.start()

toString

public java.lang.String toString()

Return the string representation of this object.

Overrides:

toString in class PLCDeviceServer

Returns:

the assigned name of this device

See Also:

PortDeviceServer.setName(java.lang.String)

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

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This method accepts data that is to be sent to the PLC. The format of the data is VERY particular. The input MUST be an ArrayValueObject. The first element of the array MUST be the IP/Hostname of the target. The subsequent elements must be integers that will be set to returned packet.

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)

VIBEvent

public void VIBEvent(VIBEvent vibEvent)
              throws BadParameterException

Resets "applethost".

Overrides:

VIBEvent in class SimpleDataSource

Throws:

BadParameterException

See Also:

com.ergotech.vib.servers.SimpleDataSource#VIBEvent(com.ergotech.vib.utils.VIBEvent)

writeDevice

public PLCDataBlock writeDevice(PLCDataBlock msgOut)
                         throws PLCException

Description copied from class: PLCDeviceServer

Writes the packet to the PLC.

Specified by:

writeDevice in class PLCDeviceServer

Throws:

PLCException