SerialWrapper (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.ports.Port
- - com.ergotech.vib.ports.SerialWrapper

All Implemented Interfaces:

PortInterface
```
public class SerialWrapper
extends Port
```
This will wrap a serial port and allow us to read and write to it as a port interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`haveShownNoPortsWarning` This will be set to true once the message about no enumerated ports is shown.
`static java.lang.String`	`SERIAL` The string used to identify a port.
`static java.lang.String`	`serialMappingFileName` The name of the mapping file.

Fields inherited from class com.ergotech.vib.ports.Port
cvsRev

Constructor Summary

Constructors
Constructor and Description
`SerialWrapper()` Create the wrapper without setting the port (used by BlueTooth).
`SerialWrapper(java.lang.String description)` The port name for a serial port consists of the string "SERIAL" followed by the port number, for example "SERIAL0", "SERIAL1", etc.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` This method will set all the current parameters (baud rate, data bits, stop bits and parity) to the port.
`boolean`	`connect()` This method will open the port and configure the streams.
`int`	`getBaudRate()` This is the baud rate.
`int`	`getDataBits()` This is the data bits.
`java.lang.String`	`getEndString()`
`int`	`getFlowControl()` The flow control for both input and output.
`int`	`getParity()` This is the parity.
`int`	`getPort()` This is the port number.
`int`	`getStopBits()` This is the stop bits.
`static void`	`loadMappingFile()`
`int`	`read()` Read a single character without a timeout
`int`	`read(byte[] b)` Fill the given byte array b with data from the buffer, without applying a timeout.
`int`	`read(byte[] b, int off, int len)` Reads len bytes into the array b starting at the offset off, without applying a timeout.
`byte[]`	`readAndWait(int length, int timeout, int interCharacterTimeout)` This will wait until we have received data until either the `timeout` or the `interCharacterTimeout` expire or `length` characters are read.
`byte[]`	`readCurrent()` Read the current buffer contents without waiting
`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)` The flow control for both input and output.
`void`	`setParity(int newValue)` This is the parity.
`void`	`setPortPool(PortPoolInterface portPool)` Opens and closes the port based on the value passed.
`void`	`setStopBits(int newValue)` This is the stop bits.
`java.lang.String`	`toString()`

Methods inherited from class com.ergotech.vib.ports.Port
getInputStream, getName, getOutputStream, getPortPool, hasError, setError, setInputStream, setOutputStream, setThread, write, write, write

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - haveShownNoPortsWarning
```
public static boolean haveShownNoPortsWarning
```
    This will be set to true once the message about no enumerated ports is shown.
  - SERIAL
```
public static java.lang.String SERIAL
```
    The string used to identify a port. This is the string "SERIAL".
  - serialMappingFileName
```
public static java.lang.String serialMappingFileName
```
    The name of the mapping file.
- Constructor Detail
  - SerialWrapper
```
public SerialWrapper()
```
    Create the wrapper without setting the port (used by BlueTooth).
  - SerialWrapper
```
public SerialWrapper(java.lang.String description)
              throws BadParameterException,
                     java.io.IOException
```
    The port name for a serial port consists of the string "SERIAL" followed by the port number, for example "SERIAL0", "SERIAL1", etc.
    
    Parameters:
    
    portName -
    
    Throws:
    
    BadParameterException
    
    java.io.IOException
- Method Detail
  - available
```
public int available()
              throws java.io.IOException
```
    This will return the number of bytes available.
    
    Specified by:
    
    available in interface PortInterface
    
    Overrides:
    
    available in class Port
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
```
    This will close a port (including all streams).
  - configPorts
```
public void configPorts()
```
    This method will set all the current parameters (baud rate, data bits, stop bits and parity) to the port.
  - connect
```
public boolean connect()
```
    This method will open the port and configure the streams.
  - 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()
```
    The flow control for both input and output.
    
    Returns:
    
    Returns the flowControl.
  - 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.
    
    Overrides:
    
    getPort in class Port
    
    See Also:
    
    setPort
  - getStopBits
```
public int getStopBits()
```
    This is the stop bits.
    
    See Also:
    
    setStopBits
  - loadMappingFile
```
public static void loadMappingFile()
                            throws BadParameterException
```
    Throws:
    
    BadParameterException
  - read
```
public int read()
         throws java.io.IOException
```
    Read a single character without a timeout
    
    Specified by:
    
    read in interface PortInterface
    
    Overrides:
    
    read in class Port
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] b)
         throws java.io.IOException
```
    Fill the given byte array b with data from the buffer, without applying a timeout.
    
    Specified by:
    
    read in interface PortInterface
    
    Overrides:
    
    read in class Port
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException
```
    Reads len bytes into the array b starting at the offset off, without applying a timeout.
    
    Specified by:
    
    read in interface PortInterface
    
    Overrides:
    
    read in class Port
    
    Throws:
    
    java.io.IOException
  - readAndWait
```
public byte[] readAndWait(int length,
                          int timeout,
                          int interCharacterTimeout)
                   throws java.io.IOException
```
    Description copied from class: Port
    
    This will wait until we have received data until either the timeout or the interCharacterTimeout expire or length characters are read. The timeout values are in milliseconds. The call will wait for up to timeout for a character to be available. If no characters are available then the method will return with a null value. If character are available, then the method will read characters until either length characters have been read or no characters have been available for interCharacterTimeout milliseconds. If the interCharacterTimeout expires then the returned array may have less than length characters available.
    
    Specified by:
    
    readAndWait in interface PortInterface
    
    Overrides:
    
    readAndWait in class Port
    
    Parameters:
    
    length - the maximum number of characters to read
    
    timeout - the maximum time to wait for the first character to be available at the port
    
    interCharacterTimeout - the maximum time to wait for subsequent characters to be available at the port
    
    Returns:
    
    an array of bytes read from the port. This may be less than length if the interCharacterTimeout expired. It will be null if the timeout expired.
    
    Throws:
    
    java.io.IOException - thrown by the underlying port
  - readCurrent
```
public byte[] readCurrent()
                   throws java.io.IOException
```
    Read the current buffer contents without waiting
    
    Overrides:
    
    readCurrent in class Port
    
    Throws:
    
    java.io.IOException
  - 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)
```
    The flow control for both input and output.
  - setParity
```
public void setParity(int newValue)
```
    This is the parity.
    
    See Also:
    
    getParity
  - setPortPool
```
public void setPortPool(PortPoolInterface portPool)
```
    Opens and closes the port based on the value passed. A null will close the port, non-null will cause a connect().
    
    Specified by:
    
    setPortPool in interface PortInterface
    
    Overrides:
    
    setPortPool in class Port
    
    See Also:
    
    Port.setPortPool(com.ergotech.vib.ports.PortPoolInterface)
  - setStopBits
```
public void setStopBits(int newValue)
```
    This is the stop bits.
    
    See Also:
    
    getStopBits
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SerialWrapper

Field Summary

Fields inherited from class com.ergotech.vib.ports.Port

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

haveShownNoPortsWarning

SERIAL

serialMappingFileName

Constructor Detail

SerialWrapper

SerialWrapper

Method Detail

available

close

configPorts

connect

getBaudRate

getDataBits

getEndString

getFlowControl

getParity

getPort

getStopBits

loadMappingFile

read

read

read

readAndWait

readCurrent

setBaudRate

setDataBits

setEndString

setFlowControl

setParity

setPortPool

setStopBits

toString