com.ergotech.vib.servers.ab

Class ControlLogixEthernetDeviceServer

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.ab.ControlLogixEthernetDeviceServer

All Implemented Interfaces:

SimulationListener

public class ControlLogixEthernetDeviceServer
extends PLCDeviceServer

This class provides the interface to the PLC.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlLogixEthernetDeviceServer.EIPPort This wraps the EtherNetIP instances.
static class	ControlLogixEthernetDeviceServer.EIPPortFactory EIP implementation of a port factory.

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 byte	BIT_ARRAY
static byte	BOOL
static int	debugLevel The debug level.
static byte	DINT
static byte	INT
static byte	LINT
static java.util.Vector<ControlLogixEthernetDeviceServer>	logixDeviceServers We maintain a list of all instances of Device Servers which can be readily accessed when creating a list for the editor.
static byte	LREAL
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.
static byte	REAL
static byte	SINT
static byte	STRUCT
static byte	STRUCT_COUNTER
static byte	STRUCT_STRING
static byte	UDINT
static byte	UINT
static byte	ULINT
static byte	USINT

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, 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
ControlLogixEthernetDeviceServer() 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.
java.util.LinkedHashMap<java.lang.String,java.lang.String>	availableServers() No servers are available currently.
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.
static java.util.Vector<ControlLogixEthernetDeviceServer>	getControlLogixEthernetDeviceServers()
java.lang.String	getHostname() Returns the hostname/ip address of the PLC.
int	getMaximumSocketConnections()
java.lang.String	getPLCPrivateAddress() The PLC private IP address or hostname.
int	getPortNumber() Returns the PLC port number.
int	getStaticLocationFor(java.lang.String method) Returns 3 for hostname and 4 for portnumber.
static long	getTransactionNumber() Returns a unique transaction number.
void	initializePortPool() Overridden to set the maximum number of connections.
PLCDataBlock	readDevice(PLCDataBlock msgOut) Read the packet from the PLC.
void	setHostname(java.lang.String hostname) Sets the hostname/ip address of the PLC.
void	setMaximumSocketConnections(int maximumSocketConnection)
void	setPLCPrivateAddress(java.lang.String plcPrivateAddress) The PLC private IP address or hostname.
void	setPortNumber(int portNumber) Sets the port number of the PLC.
void	start() initialize the port pool once the container has been set.
void	stop() Overridden to remove the instance from the DeviceServers Vector.
static void	toByteArray(long value, byte[] buffer, int offset, int length) Returns the variable as a byte[].
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	VIBEvent(VIBEvent vibEvent) Resets "applethost".
PLCDataBlock	writeDevice(PLCDataBlock msgOut) Writes the packet to the PLC.
PLCDataBlock	writeDeviceInternal(ControlLogixDataBlock controlLogixDataBlock) Read the packet from 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, simulationStateChanged, toString

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

canConnect, clearMessageLog, configurePort, equals, getLinkTimeout, getLinkTimeoutMilliseconds, getResponseTimeout, incrementErrorCount, init, 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, 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

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

BIT_ARRAY

public static final byte BIT_ARRAY

See Also:

Constant Field Values

BOOL

public static final byte BOOL

See Also:

Constant Field Values

debugLevel

public static int debugLevel

The debug level.

DINT

public static final byte DINT

See Also:

Constant Field Values

INT

public static final byte INT

See Also:

Constant Field Values

LINT

public static final byte LINT

See Also:

Constant Field Values

logixDeviceServers

public static java.util.Vector<ControlLogixEthernetDeviceServer> logixDeviceServers

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

LREAL

public static final byte LREAL

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 "EIPPortFactory". This returns an EtherNetIP instance connected to the PLC.

See Also:

Constant Field Values

REAL

public static final byte REAL

See Also:

Constant Field Values

SINT

public static final byte SINT

See Also:

Constant Field Values

STRUCT

public static final byte STRUCT

See Also:

Constant Field Values

STRUCT_COUNTER

public static final byte STRUCT_COUNTER

See Also:

Constant Field Values

STRUCT_STRING

public static final byte STRUCT_STRING

See Also:

Constant Field Values

UDINT

public static final byte UDINT

See Also:

Constant Field Values

UINT

public static final byte UINT

See Also:

Constant Field Values

ULINT

public static final byte ULINT

See Also:

Constant Field Values

USINT

public static final byte USINT

See Also:

Constant Field Values

Constructor Detail

ControlLogixEthernetDeviceServer

public ControlLogixEthernetDeviceServer()

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.

Parameters:

factoryName -

availableServers

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

No servers are available currently.

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(xxxxxDeviceServer.forceLoad("testName"));

getControlLogixEthernetDeviceServers

public static java.util.Vector<ControlLogixEthernetDeviceServer> getControlLogixEthernetDeviceServers()

Returns:

Returns the logixDeviceServers.

getHostname

public java.lang.String getHostname()

Returns the hostname/ip address of the PLC.

Returns:

Returns the hostname.

getMaximumSocketConnections

public int getMaximumSocketConnections()

Returns:

Returns the maximumSocketConnection.

getPLCPrivateAddress

public java.lang.String getPLCPrivateAddress()

The PLC private IP address or hostname. May be null.

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

Returns 3 for hostname and 4 for portnumber.

Overrides:

getStaticLocationFor in class Manipulator

Throws:

BadParameterException

getTransactionNumber

public static long getTransactionNumber()

Returns a unique transaction number.

initializePortPool

public void initializePortPool()

Overridden to set the maximum number of connections.

Overrides:

initializePortPool in class PortDeviceServer

See Also:

PortDeviceServer.initializePortPool()

readDevice

public PLCDataBlock readDevice(PLCDataBlock msgOut)
                        throws PLCException

Read the packet from the PLC.

Specified by:

readDevice in class PLCDeviceServer

Parameters:

msgOut - the message to send

Throws:

PLCException

setHostname

public void setHostname(java.lang.String hostname)

Sets the hostname/ip address of the PLC.

Parameters:

hostname - The hostname to set.

setMaximumSocketConnections

public void setMaximumSocketConnections(int maximumSocketConnection)

Parameters:

maximumSocketConnection - The maximumSocketConnection to set.

setPLCPrivateAddress

public void setPLCPrivateAddress(java.lang.String plcPrivateAddress)

The PLC private IP address or hostname. May be null.

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.

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()

stop

public void stop()
          throws BadParameterException

Overridden to remove the instance from the DeviceServers Vector.

Overrides:

stop in class PLCDeviceServer

Throws:

BadParameterException

See Also:

DataSource.stop()

toByteArray

public static void toByteArray(long value,
                               byte[] buffer,
                               int offset,
                               int length)

Returns the variable as a byte[].

Parameters:

value - the value to add to the byte array - low bytes first

the - buffer to which to write the value

offset - the starting point in the buffer to add the bytes

length - the number of bytes to add.

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

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

Writes the packet to the PLC.

Specified by:

writeDevice in class PLCDeviceServer

Throws:

PLCException

writeDeviceInternal

public PLCDataBlock writeDeviceInternal(ControlLogixDataBlock controlLogixDataBlock)
                                 throws PLCException

Read the packet from the PLC.

Throws:

PLCException