com.ergotech.vib.servers.ab

Class DF1DeviceServer

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.DF1DeviceServer

All Implemented Interfaces:

SimulationListener

public class DF1DeviceServer
extends PLCDeviceServer

This class provides the interface to the PLC. It uses theAB DF1 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 java.lang.String	cvsRev
static byte	DATA_REQUEST_MSG_LENGTH The length of an outgoing data request message - 18
static int	debugLevel The debug level.
static java.util.Vector	df1DeviceServers We maintain a list of all instances of DF1DeviceServers which can be readily accessed when creating a list for the editor.
static byte	DLE DLE - 0x06
static byte	ENQ ENQ - 0x05
static byte	EOT EOT - 0x04
static byte	ETX ETX - 0x03
static byte	NAK NAK - 0xF
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.
static byte	SOH SOH - 0x00
static byte	STX STX - 0x02

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

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
DF1DeviceServer() 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.
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	getACK(PortInterface port) Return on valid ACK or return an error code on NAK or other error.
int	getBaudRate()
static java.util.Vector	getDF1DeviceServers()
int	getFlowControl()
int	getParity()
int	getPCAddress() Returns the PC Address.
int	getPortNumber() Returns the serial port number.
int	getStopBits()
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	setFlowControl(int flowControl)
void	setParity(int parity)
void	setPCAddres(int pcAddress) Set the PC Address.
void	setPortNumber(int portNumber) Sets the serial port number of the PLC.
void	setSerialPortParameters() Sets the SerialPort parameters.
void	setStopBits(int stopBits)
void	stop() Overridden to remove the instance from the df1DeviceServers 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

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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

DATA_REQUEST_MSG_LENGTH

public static final byte DATA_REQUEST_MSG_LENGTH

The length of an outgoing data request message - 18

See Also:

Constant Field Values

debugLevel

public static int debugLevel

The debug level.

df1DeviceServers

public static java.util.Vector df1DeviceServers

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

DLE

public static final byte DLE

DLE - 0x06

See Also:

Constant Field Values

ENQ

public static final byte ENQ

ENQ - 0x05

See Also:

Constant Field Values

EOT

public static final byte EOT

EOT - 0x04

See Also:

Constant Field Values

ETX

public static final byte ETX

ETX - 0x03

See Also:

Constant Field Values

NAK

public static final byte NAK

NAK - 0xF

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

SOH

public static final byte SOH

SOH - 0x00

See Also:

Constant Field Values

STX

public static final byte STX

STX - 0x02

See Also:

Constant Field Values

Constructor Detail

DF1DeviceServer

public DF1DeviceServer()

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

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

getACK

public int getACK(PortInterface port)
           throws PLCException,
                  java.io.IOException

Return on valid ACK or return an error code on NAK or other error. This reads the DLE ACK response from the plc.

Throws:

PLCException

java.io.IOException

getBaudRate

public int getBaudRate()

Returns:

Returns the baudRate.

getDF1DeviceServers

public static java.util.Vector getDF1DeviceServers()

Returns:

Returns the DF1 DeviceServers.

getFlowControl

public int getFlowControl()

Returns:

Returns the flowControl.

getParity

public int getParity()

Returns:

Returns the parity.

getPCAddress

public int getPCAddress()

Returns the PC Address.

getPortNumber

public int getPortNumber()

Returns the serial port number.

Returns:

Returns the portNumber.

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

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.

setFlowControl

public void setFlowControl(int flowControl)

Parameters:

flowControl - The flowControl to set.

setParity

public void setParity(int parity)

Parameters:

parity - The parity to set.

setPCAddres

public void setPCAddres(int pcAddress)

Set the PC Address.

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.

stop

public void stop()
          throws BadParameterException

Overridden to remove the instance from the df1DeviceServers 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