com.ergotech.vib.ports.serial

Class SerialPortDevice

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.ports.serial.SerialPortDevice

All Implemented Interfaces:

SimulationListener

public class SerialPortDevice
extends PortDeviceServer

This reads and writes a 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 java.lang.String	cvsRev
static int	MAX_CHAR_INPUT
static java.lang.String	PORT_FACTORY_NAME The name of the port factory.

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
SerialPortDevice() This sets the factory name.

Method Summary

Modifier and Type	Method and Description
void	asyncValueInput(ValueChangedEvent newEvent) This is the trigger routine.
java.util.LinkedHashMap	availableServers() No servers are available currently.
void	clearMessageLog() This will send an empty string as the message string and send a value of zero (NO_ERROR) to the output.
PortInterface	connect() This will checkout a port and so connect to the device.
static java.lang.String	convertEscapedCharacters(java.lang.String input) Users can enter \r,\n, etc and they will be converted to their non-escaped version.
SimpleDataSource	createServer(java.lang.String className, java.lang.String serverName) This method should never be called since "availableServers" returns null.
int	getBaudRate() This is the baud rate.
int	getDataBits() This is the data bits.
java.lang.String	getEndString()
int	getFlowControl()
int	getInterCharacterTimeout() The inter-character timeout.
int	getParity() This is the parity.
int	getPort() This is the port number.
int	getResponseTimeout() The response timeout.
int	getStopBits() This is the stop bits.
boolean	hasServers() Returns true.
void	messageLog(java.lang.String msg, int errorNumber) Logs informational/debug messages.
void	refreshCurrentValue() Poll the port for an unsolicited value.
void	releasePort() Release the port interface.
void	setBaudRate(int newValue) This is the baud rate.
void	setDataBits(int newValue) This is the data bits.
void	setEndString(java.lang.String endString)
void	setFlowControl(int flowControl)
void	setInterCharacterTimeout(int interCharacterTimeout) The inter-character timeout.
void	setParity(int newValue) This is the parity.
void	setPort(int newValue) This is the port number.
void	setResponseTimeout(int responseTimeout) The response timeout.
void	setStopBits(int newValue) This is the stop bits.
void	setTimebase(double newValue) Sets the timebase of the server in seconds.
void	stop() Release the serial port.
void	syncSendToPort(ValueChangedEvent event) Sends the string directly to the port.
void	syncSendToPort(ValueObjectInterface value)
void	valueInput(ValueChangedEvent newEvent) This is the trigger routine.

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

canConnect, configurePort, destroy, equals, getLinkTimeout, getLinkTimeoutMilliseconds, incrementErrorCount, init, initializePortPool, isSimulating, isSimulationFlag, printException, releasePortPool, resetErrorCount, setLinkTimeout, setName, setSimulationFlag, simulationStateChanged, start, toString

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

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

MAX_CHAR_INPUT

public static final int MAX_CHAR_INPUT

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

SerialPortDevice

public SerialPortDevice()

This sets the factory name.

Method Detail

asyncValueInput

public void asyncValueInput(ValueChangedEvent newEvent)
                     throws VIBUpdateFailedException

This is the trigger routine. This method will write a value to the serial port. If the value of "responseTimeout" is non-zero then after writing the method will read from the port. If responseTimeout is zero or negative then this method will not read from the port. However, if the timebase is non-zero then the "refreshCurrentValue" method will

Throws:

VIBUpdateFailedException

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.

clearMessageLog

public void clearMessageLog()

This will send an empty string as the message string and send a value of zero (NO_ERROR) to the output.

Overrides:

clearMessageLog in class PortDeviceServer

connect

public PortInterface connect()
                      throws java.io.IOException,
                             BadParameterException

This will checkout a port and so connect to the device.

Throws:

BadParameterException - thrown if "checkout" of the portPool throws

java.io.IOException - thrown if "checkout" of the portPool throws

convertEscapedCharacters

public static java.lang.String convertEscapedCharacters(java.lang.String input)

Users can enter \r,\n, etc and they will be converted to their non-escaped version.

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

getBaudRate

public int getBaudRate()

This is the baud rate.

See Also:

setBaudRate

getDataBits

public int getDataBits()

This is the data bits.

See Also:

setDataBits

getEndString

public java.lang.String getEndString()

Returns:

the endString

getFlowControl

public int getFlowControl()

Returns:

Returns the flowControl.

getInterCharacterTimeout

public int getInterCharacterTimeout()

The inter-character timeout. After receiving any character we keep reading until this timeout is exceed. This value is in milliseconds. The default is 20 ms.

getParity

public int getParity()

This is the parity.

See Also:

setParity

getPort

public int getPort()

This is the port number. If the number is 0 or above, we will try to connect.

See Also:

setPort

getResponseTimeout

public int getResponseTimeout()

The response timeout. After sending a request to the port we will wait this long for the first character to be received. Once the first character has been recieved then we will wait a maximum of "interCharacterTimeout" milliseconds for all subsequent characters. That is, after the first character is received this timeout is no longer important. This value is in milliseconds and the default is 250 ms.

Overrides:

getResponseTimeout in class PortDeviceServer

getStopBits

public int getStopBits()

This is the stop bits.

See Also:

setStopBits

hasServers

public boolean hasServers()

Returns true. This is not accurate and should be improved, but the method is used only for logging.

Specified by:

hasServers in class PortDeviceServer

messageLog

public void messageLog(java.lang.String msg,
                       int errorNumber)

Logs informational/debug messages. This will also be captured as the output for the device.

Overrides:

messageLog in class PortDeviceServer

refreshCurrentValue

public void refreshCurrentValue()

Poll the port for an unsolicited value. This is called every timebase tick.
The server should be set either to poll the port (unsolicited input) or for triggered reading, not both. Set the timebase to zero to use the server with a trigger and send value to the server that will be sent to the serial port. Set the timebase to non-zero to poll for values.

Overrides:

refreshCurrentValue in class SimpleDataSource

releasePort

public void releasePort()

Release the port interface.

setBaudRate

public void setBaudRate(int newValue)

This is the baud rate.

See Also:

getBaudRate

setDataBits

public void setDataBits(int newValue)

This is the data bits.

See Also:

getDataBits

setEndString

public void setEndString(java.lang.String endString)

Parameters:

endString - the endString to set

setFlowControl

public void setFlowControl(int flowControl)

Parameters:

flowControl - The flowControl to set.

setInterCharacterTimeout

public void setInterCharacterTimeout(int interCharacterTimeout)

The inter-character timeout. After receiving any character we keep reading until this timeout is exceed. This value is in milliseconds. The default is 20 ms.

setParity

public void setParity(int newValue)

This is the parity.

See Also:

getParity

setPort

public void setPort(int newValue)

This is the port number. If the number is 0 or above, we will try to connect.

See Also:

getPort

setResponseTimeout

public void setResponseTimeout(int responseTimeout)

The response timeout. After sending a request to the port we will wait this long for the first character to be received. Once the first character has been recieved then we will wait a maximum of "interCharacterTimeout" milliseconds for all subsequent characters. That is, after the first character is received this timeout is no longer important. This value is in milliseconds and the default is 250 ms. Setting the response timeout and the timebase to zero will disable this server from reading the port.

Overrides:

setResponseTimeout in class PortDeviceServer

setStopBits

public void setStopBits(int newValue)

This is the stop bits.

See Also:

getStopBits

setTimebase

public void setTimebase(double newValue)

Sets the timebase of the server in seconds. This will also interrupt the thread and get the current value right away. This allows a program to set the timebase to a huge number, and reset it every time you want a new value. The timebase is derived from the return from toString() value of this object which should be a valid floating point as determined by a call to Float.valueOf(). WARNING: If the server is suspended, this will NOT start the server. You will need to resume the server first. WARNING: If you call this programatically on the timebase thread and you set the new timebase to 0, it will stop the this thread. Make sure you DO NOT have any code after the setTimebase method if you allow people to set the timebase to 0.

Overrides:

setTimebase in class PortDeviceServer

Parameters:

newValue - the timebase of the server

See Also:

SimpleDataSource.getTimebase()

stop

public void stop()
          throws BadParameterException

Release the serial port.

Overrides:

stop in class PortDeviceServer

Throws:

BadParameterException

See Also:

PortDeviceServer.stop()

syncSendToPort

public void syncSendToPort(ValueChangedEvent event)
                    throws VIBUpdateFailedException

Sends the string directly to the port. This should be the normal operation except when there are serial ports with a timebase that will cause undue delays.

Throws:

VIBUpdateFailedException

syncSendToPort

public void syncSendToPort(ValueObjectInterface value)
                    throws VIBUpdateFailedException

Throws:

VIBUpdateFailedException

valueInput

public void valueInput(ValueChangedEvent newEvent)
                throws VIBUpdateFailedException

This is the trigger routine. This method will write a value to the serial port. If the value of "responseTimeout" is non-zero then after writing the method will read from the port. If responseTimeout is zero or negative then this method will not read from the port. However, if the timebase is non-zero then the "refreshCurrentValue" method will

Overrides:

valueInput in class Manipulator

Parameters:

newEvent - The ValueChangedEvent that the bean or data source has sent.

Throws:

VIBUpdateFailedException