com.ergotech.vib.servers.omron

Class HostLinkDeviceServer

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.omron.HostLinkDeviceServer

All Implemented Interfaces:

SimulationListener

public class HostLinkDeviceServer
extends PLCDeviceServer

This class provides the interface to the PLC. It uses the Omron HostLink protocol over a standard serial port.

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 byte	ACK ACK - 0x06
static int	ADDRESS_OFFSET The offset of the address in the message - always 1
static byte	CR CR - 0x0D
static int	debugLevel The debug level for this device.
static byte	ENQ ENQ - 0x05
static java.util.Vector<PLCDeviceServer>	hostLinkDeviceServer We maintain a list of all instances of HostLinkDeviceServers which can be readily accessed when creating a list for the editor.
static byte	NAK NAK - 0x15
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.

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
HostLinkDeviceServer() 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.
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.
int	getBaudRate()
static java.util.Vector<PLCDeviceServer>	getHostLinkDeviceServers()
int	getPortNumber() Returns the serial port number.
void	initializePortPool() Sets the SerialPort parameters after creating the port.
PLCDataBlock	readDevice(PLCDataBlock msgOut) Read the packet from the PLC.
void	setBaudRate(int baudRate)
void	setPortNumber(int portNumber) Sets the serial port number of the PLC.
void	setSerialPortParameters() Sets the SerialPort parameters.
void	stop() Overridden to remove the instance from the hostLinkDeviceServers Vector.
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, simulationStateChanged, start, 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

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

ACK

public static final byte ACK

ACK - 0x06

See Also:

Constant Field Values

ADDRESS_OFFSET

public static final int ADDRESS_OFFSET

The offset of the address in the message - always 1

See Also:

Constant Field Values

CR

public static final byte CR

CR - 0x0D

See Also:

Constant Field Values

debugLevel

public static int debugLevel

The debug level for this device. This is set by hostLink.debuglevel define (eg hostLink.debuglevel=100).

ENQ

public static final byte ENQ

ENQ - 0x05

See Also:

Constant Field Values

hostLinkDeviceServer

public static java.util.Vector<PLCDeviceServer> hostLinkDeviceServer

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

NAK

public static final byte NAK

NAK - 0x15

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

HostLinkDeviceServer

public HostLinkDeviceServer()

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 -

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

getBaudRate

public int getBaudRate()

Returns:

the baudRate

getHostLinkDeviceServers

public static java.util.Vector<PLCDeviceServer> getHostLinkDeviceServers()

Returns:

Returns the AS511 DeviceServers.

getPortNumber

public int getPortNumber()

Returns the serial port number.

Returns:

Returns the portNumber.

initializePortPool

public void initializePortPool()

Sets the SerialPort parameters after creating the port.

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

setBaudRate

public void setBaudRate(int baudRate)

Parameters:

baudRate - the baudRate 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.

stop

public void stop()
          throws BadParameterException

Overridden to remove the instance from the hostLinkDeviceServers Vector.

Overrides:

stop in class PLCDeviceServer

Throws:

BadParameterException

See Also:

DataSource.stop()

writeDevice

public PLCDataBlock writeDevice(PLCDataBlock msgOut)
                         throws PLCException

Writes the packet to the PLC.

Specified by:

writeDevice in class PLCDeviceServer

Throws:

PLCException