com.ergotech.vib.servers.melsec

Class MelsecDeviceServer

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.melsec.MelsecDeviceServer

All Implemented Interfaces:

SimulationListener

public class MelsecDeviceServer
extends PLCDeviceServer

The device server for the Mitsubishi Q-Series (and A series?) PLC over Ethernet. This protocol uses UDP on the default port of 5000 to communicate with an Ethernet module (QJ71E71 series) or with an Ethernet-enabled CPU.

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.util.Vector<MelsecDeviceServer>	melsecDeviceServers We maintain a list of all instances of melsecDeviceServers which can be readily accessed when creating a list for the editor.

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

cvsRev, 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
MelsecDeviceServer() 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.
static void	_main(java.lang.String[] args)
PLCDataBlock	_readDevice(PLCDataBlock msgOut) Read from the device.
java.util.LinkedHashMap<java.lang.String,java.lang.String>	availableServers() The list of possible sub-servers of this device.
static java.lang.String	forceLoad(java.lang.String value) This is generated by the property editor to force a reference to the DeviceServer for genjar.
java.lang.String	getHostname() Returns the hostname/ip address of the PLC.
static java.util.Vector<MelsecDeviceServer>	getMelsecDeviceServers()
byte	getNetworkNumber()
byte	getPcNumber()
int	getPortNumber() Returns the PLC port number.
int	getRetryCount()
PLCDataBlock	readDevice(PLCDataBlock msgOut) Read from the device.
void	setHostname(java.lang.String hostname) Sets the hostname/ip address of the PLC.
void	setNetworkNumber(byte networkNumber) Set the network number.
void	setPcNumber(byte pcNumber) The pc number.
void	setPortNumber(int portNumber) Sets the port number of the PLC.
void	setRetryCount(int retryCount)
void	start() This method controls communication to the device.
void	stop() Overridden to remove the instance from the modbusDeviceServers Vector.
PLCDataBlock	writeDevice(PLCDataBlock msgOut) Write to the device.

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

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, 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, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, valueChanged, 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

melsecDeviceServers

public static java.util.Vector<MelsecDeviceServer> melsecDeviceServers

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

Constructor Detail

MelsecDeviceServer

public MelsecDeviceServer()

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.

_main

public static void _main(java.lang.String[] args)

_readDevice

public PLCDataBlock _readDevice(PLCDataBlock msgOut)
                         throws PLCException

Read from the device. This will package the msg into a melsec packet. The msgIn and msgOut The response is returned in the msgIn.

Parameters:

msgOut - the msg to send

Returns:

the response msg

Throws:

PLCException

availableServers

public java.util.LinkedHashMap<java.lang.String,java.lang.String> availableServers()

The list of possible sub-servers of this device.

Overrides:

availableServers in class DeviceManagerManipulator

Returns:

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

forceLoad

public static java.lang.String forceLoad(java.lang.String value)

This is generated by the property editor to force a reference to the DeviceServer for genjar. should look similar to this setDeviceName(MelsecDeviceServer.forceLoad("testName"));

getHostname

public java.lang.String getHostname()

Returns the hostname/ip address of the PLC.

Returns:

Returns the hostname.

getMelsecDeviceServers

public static java.util.Vector<MelsecDeviceServer> getMelsecDeviceServers()

Returns:

Returns the MelsecDeviceServers.

getNetworkNumber

public byte getNetworkNumber()

Returns:

the networkNumber

getPcNumber

public byte getPcNumber()

Returns:

the pcNumber

getPortNumber

public int getPortNumber()

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

Returns:

Returns the portNumber.

getRetryCount

public int getRetryCount()

Returns:

Returns the retryCount.

readDevice

public PLCDataBlock readDevice(PLCDataBlock msgOut)
                        throws PLCException

Read from the device. This will package the msg into a melsec packet. The msgIn and msgOut The response is returned in the msgIn.

Specified by:

readDevice in class PLCDeviceServer

Parameters:

msgOut - the msg to send

Returns:

the response msg

Throws:

PLCException

setHostname

public void setHostname(java.lang.String hostname)

Sets the hostname/ip address of the PLC.

Parameters:

hostname - The hostname to set.

setNetworkNumber

public void setNetworkNumber(byte networkNumber)

Set the network number.

Parameters:

networkNumber - the network number. Zero for the local network, 2 or more if the PLC is on the other side of another PLC/gateway.

setPcNumber

public void setPcNumber(byte pcNumber)

The pc number. This is 0xFF for a PLC connected to the local network. It is the station number for PLCs connected through a PLC/gateway.

Parameters:

pcNumber - 0xFF for a PLC connected to the local network. The station number for PLCs connected through a PLC/gateway.

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.

setRetryCount

public void setRetryCount(int retryCount)

Parameters:

retryCount - The retryCount to set.

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

Description copied from class: PLCDeviceServer

This method controls communication to the device. Until this method is called, there will be no communication to the device (port is closed).

Overrides:

start in class PLCDeviceServer

Throws:

BadParameterException

VIBUpdateFailedException

See Also:

PLCDeviceServer.start()

stop

public void stop()
          throws BadParameterException

Overridden to remove the instance from the modbusDeviceServers Vector.

Overrides:

stop in class PLCDeviceServer

Throws:

BadParameterException

See Also:

DataSource.stop()

writeDevice

public PLCDataBlock writeDevice(PLCDataBlock msgOut)
                         throws PLCException

Write to the device. The response is returned in the msgIn.

Specified by:

writeDevice in class PLCDeviceServer

Parameters:

msgOut - the PDU to send

msgIn - the response PDU

Returns:

the length of the response message

Throws:

PLCException