com.ergotech.vib.servers.ppi

Class PPIDeviceServer

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

com.ergotech.vib.servers.ppi.PPIDeviceServer

All Implemented Interfaces:

SimulationListener, java.lang.Runnable

public class PPIDeviceServer
extends PPIDeviceServerBase
implements java.lang.Runnable

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.lang.String	cvsRev
static byte	END Header for an SC PDU.
static byte	FCB1 Frame Control Bit.
static byte	FCB2 Frame Control Bit.
static byte	FDL_STATUS Frame Control Bit.
int	guf The Gap Update Factor.
byte	hsa The highest station address.
int[]	las The array of active addresses.
static byte	MASTER_STATION_AREADY_IN_RING Frame Control Bit.
static byte	MASTER_STATION_NOT_READY Frame Control Bit.
static byte	MASTER_STATION_READY Frame Control Bit.
static byte	NAK_RR Frame Control Bit.
static byte	NAK_RS Frame Control Bit.
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.
static byte	SC Header for an SC PDU.
static byte	SD1 Header for an SD1 PDU.
static byte	SD2 Header for an SD2 PDU.
static byte	SD4 Header for an SD4 PDU.
static byte	SLAVE_STATION Frame Control Bit.

Fields inherited from class com.ergotech.vib.servers.ppi.PPIDeviceServerBase

ppiDeviceServers

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
PPIDeviceServer() 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.
int	getBaudRate()
int	getFlowControl()
int	getGUF() The gap update factor.
byte	getHighestStationAddress() The highest station address.
int	getParity()
int	getPortNumber() Returns the serial port number.
int	getStopBits()
void	incrementErrorCount() This routine will limit retry attempts.
void	initializePortPool() Sets the SerialPort parameters after creating the port.
PLCDataBlock	readDevice(PLCDataBlock msgOut) Read from the device.
void	run() Watch the serial port for incoming packets.
void	setBaudRate(int baudRate)
void	setFlowControl(int flowControl)
void	setGUF(int guf) The gap update factor.
void	setHighestStationAddress(byte hsa) The address of this node.
void	setNodeAddress(byte nodeAddress) The address of this node.
void	setParity(int parity)
void	setPortNumber(int portNumber) Sets the serial port number of the PLC.
void	setSerialPortParameters() Sets the SerialPort parameters.
void	setStopBits(int stopBits)
PLCDataBlock	writeDevice(PLCDataBlock msgOut) Write to the device.

Methods inherited from class com.ergotech.vib.servers.ppi.PPIDeviceServerBase

availableServers, forceLoad, getNodeAddress, getPPIDeviceServers, getRetryCount, printArray, setRetryCount, setTimebase, start, stop

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, init, isSimulating, isSimulationFlag, messageLog, releasePortPool, resetErrorCount, setLinkTimeout, setName, setResponseTimeout, setSimulationFlag

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

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

END

public static final byte END

Header for an SC PDU.

See Also:

Constant Field Values

FCB1

public static final byte FCB1

Frame Control Bit. The Frame Control Bit should alternate between FCB1 (0x5C) and FCB2 (0x7C).

See Also:

Constant Field Values

FCB2

public static final byte FCB2

Frame Control Bit. The Frame Control Bit should alternate between FCB1 (0x5C) and FCB2 (0x7C).

See Also:

Constant Field Values

FDL_STATUS

public static final byte FDL_STATUS

Frame Control Bit. The FLD_STATUS Frame Control Byte (0x49)

See Also:

Constant Field Values

guf

public int guf

The Gap Update Factor. Setting this to zero will disable multi-master support. Any other value will be treated as the Gap Update Factor as defined in the spec.

hsa

public byte hsa

The highest station address.

las

public int[] las

The array of active addresses. If HSA is changed, this must be reset.

MASTER_STATION_AREADY_IN_RING

public static final byte MASTER_STATION_AREADY_IN_RING

Frame Control Bit. The "Master Station AlReady In Ring" Frame Control Byte (0x30) response to the FLD_STATUS request.

See Also:

Constant Field Values

MASTER_STATION_NOT_READY

public static final byte MASTER_STATION_NOT_READY

Frame Control Bit. The "Master Station Not Ready" Frame Control Byte (0x10) response to the FLD_STATUS request.

See Also:

Constant Field Values

MASTER_STATION_READY

public static final byte MASTER_STATION_READY

Frame Control Bit. The "Master Station Ready" Frame Control Byte (0x20) response to the FLD_STATUS request.

See Also:

Constant Field Values

NAK_RR

public static final byte NAK_RR

Frame Control Bit. The NAK-RR Frame Control Byte (0x02) - no resource

See Also:

Constant Field Values

NAK_RS

public static final byte NAK_RS

Frame Control Bit. The NAK-RS Frame Control Byte (0x03) - no interest

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

SC

public static final byte SC

Header for an SC PDU.

See Also:

Constant Field Values

SD1

public static final byte SD1

Header for an SD1 PDU.

See Also:

Constant Field Values

SD2

public static final byte SD2

Header for an SD2 PDU.

See Also:

Constant Field Values

SD4

public static final byte SD4

Header for an SD4 PDU.

See Also:

Constant Field Values

SLAVE_STATION

public static final byte SLAVE_STATION

Frame Control Bit. The "Slave Station" Frame Control Byte (0x0) response to the FLD_STATUS request.

See Also:

Constant Field Values

Constructor Detail

PPIDeviceServer

public PPIDeviceServer()

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 -

getBaudRate

public int getBaudRate()

Returns:

Returns the baudRate.

getFlowControl

public int getFlowControl()

Returns:

Returns the flowControl.

getGUF

public int getGUF()

The gap update factor.

getHighestStationAddress

public byte getHighestStationAddress()

The highest station address.

getParity

public int getParity()

Returns:

Returns the parity.

getPortNumber

public int getPortNumber()

Returns the serial port number.

Returns:

Returns the portNumber.

getStopBits

public int getStopBits()

Returns:

Returns the stopBits.

incrementErrorCount

public void incrementErrorCount()

This routine will limit retry attempts.

Overrides:

incrementErrorCount in class PortDeviceServer

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 from the device. This will package the msg into a PPI. The msgIn and msgOut are Protocol Data Units (or PDU's). The outgoing message (msgOut) will be packaged into a SD2 message and sent. The ultimate response will be a SD2 also and so will be decomposed to get the response data (PDU) The response is returned in the msgIn.

Specified by:

readDevice in class PLCDeviceServer

Parameters:

msgOut - the PDU to send

msgIn - the response PDU

Returns:

the length of the PDU

Throws:

PLCException

run

public void run()

Watch the serial port for incoming packets. Handle the packets we need to handle, and notify any responses.

Specified by:

run in interface java.lang.Runnable

setBaudRate

public void setBaudRate(int baudRate)

Parameters:

baudRate - The baudRate to set.

setFlowControl

public void setFlowControl(int flowControl)

Parameters:

flowControl - The flowControl to set.

setGUF

public void setGUF(int guf)

The gap update factor.

setHighestStationAddress

public void setHighestStationAddress(byte hsa)

The address of this node.

setNodeAddress

public void setNodeAddress(byte nodeAddress)

The address of this node.

Overrides:

setNodeAddress in class PPIDeviceServerBase

setParity

public void setParity(int parity)

Parameters:

parity - The parity 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.

setStopBits

public void setStopBits(int stopBits)

Parameters:

stopBits - The stopBits to set.

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