com.ergotech.vib.manipulators

Class SerialPortManipulator

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.manipulators.SerialPortManipulator

public class SerialPortManipulator
extends SimpleManipulator

This reads and writes a serial port. It uses a SerialPortDevice to perform the actual operations on the serial ports. This allows multiple manipulators to interact with the same serial port. If there is no timebase on this component, it will read the response from the serial port whenever a value is written to it, or whenever it is triggered. The read in this case will be synchronous, that is, the chain of logic will not continue until the read is complete, or has timed-out. If a timebase is set, it will read the value asynchronously. In this case, the chain of logic will be complete on a write, and will begin again on a read. In the case of asynchronous reads, it is usual to put a fast timebase and a long timeout. In this case, the component will be waiting for input at the port continuously, or almost so.

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

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, debugLevel, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
SerialPortManipulator()

Method Summary

Modifier and Type	Method and Description
int	available() This will return the number of bytes available.
void	close() This will close a port (including all streams).
void	configPorts() Sets the baud rate, data bits, stop bits and parity for the port.
boolean	connect() This will open the serial port and so connect to the device.
int	getBaudRate() This is the baud rate.
int	getDataBits() This is the data bits.
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.
byte	read() This will read a single byte.
int	read(byte[] b) This will read an array of bytes and place them into the given array.
int	read(byte[] b, int off, int len) This will read an array of bytes and place them into the array of bytes at a given offset (up to the length).
byte[]	readAndWait(int timeout, int interCharacterTimeout) This will wait until we have received what the port thinks is everything.
void	refreshCurrentValue() Poll the port for an unsolicited value.
void	setBaudRate(int newValue) This is the baud rate.
void	setDataBits(int newValue) This is the data bits.
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	write(byte b) This will write a single byte.
void	write(byte[] b) This will write a single byte.
void	write(byte[] b, int offset, int length) This will write an array of bytes.

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, toString, valueChanged, valueInput

Methods inherited from class com.ergotech.vib.servers.SimpleDataSource

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, start, stop, 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, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

Constructor Detail

SerialPortManipulator

public SerialPortManipulator()

Method Detail

available

public int available()
              throws java.io.IOException

This will return the number of bytes available.

Throws:

java.io.IOException

close

public void close()

This will close a port (including all streams).

configPorts

public void configPorts()

Sets the baud rate, data bits, stop bits and parity for the port.

connect

public boolean connect()

This will open the serial port and so connect to the device. This can be called multiple time. It will only connect if it is not already connected and the port number is valid (>0).

getBaudRate

public int getBaudRate()

This is the baud rate.

See Also:

setBaudRate

getDataBits

public int getDataBits()

This is the data bits.

See Also:

setDataBits

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.

getStopBits

public int getStopBits()

This is the stop bits.

See Also:

setStopBits

read

public byte read()
          throws java.io.IOException

This will read a single byte.

Throws:

java.io.IOException

read

public int read(byte[] b)
         throws java.io.IOException

This will read an array of bytes and place them into the given array.

Throws:

java.io.IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

This will read an array of bytes and place them into the array of bytes at a given offset (up to the length). It will return the number of bytes read.

Throws:

java.io.IOException

readAndWait

public byte[] readAndWait(int timeout,
                          int interCharacterTimeout)
                   throws java.io.IOException

This will wait until we have received what the port thinks is everything.

Throws:

java.io.IOException

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

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

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.

setStopBits

public void setStopBits(int newValue)

This is the stop bits.

See Also:

getStopBits

write

public void write(byte b)
           throws java.io.IOException

This will write a single byte.

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

This will write a single byte.

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int offset,
                  int length)
           throws java.io.IOException

This will write an array of bytes.

Throws:

java.io.IOException