SerialPort (JanosRuntime JavaDOC)

java.lang.Object
- com.integpg.comm.SerialPort

Direct Known Subclasses:

AUXSerialPort, COMSerialPort
```
public class SerialPort
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DATABITS_7` DATABITS_7
`static int`	`DATABITS_8` DATABITS_8
`static int`	`FLOWCONTROL_NONE` FLOWCONTROL_NONE
`static int`	`FLOWCONTROL_RTSCTS_IN` FLOWCONTROL_RTSCTS_IN
`static int`	`FLOWCONTROL_RTSCTS_OUT` FLOWCONTROL_RTSCTS_OUT
`static int`	`FLOWCONTROL_XONXOFF_IN` FLOWCONTROL_XONXOFF_IN
`static int`	`FLOWCONTROL_XONXOFF_OUT` FLOWCONTROL_XONXOFF_OUT
`static int`	`PARITY_EVEN` PARITY_EVEN
`static int`	`PARITY_NONE` PARITY_NONE
`static int`	`PARITY_ODD` PARITY_ODD
`static int`	`SPEED_110` SPEED_110
`static int`	`SPEED_115200` SPEED_115200
`static int`	`SPEED_1200` SPEED_1200
`static int`	`SPEED_128000` SPEED_128000
`static int`	`SPEED_14400` SPEED_14400
`static int`	`SPEED_150` SPEED_150
`static int`	`SPEED_19200` SPEED_19200
`static int`	`SPEED_2400` SPEED_2400
`static int`	`SPEED_250000` SPEED_250000
`static int`	`SPEED_28800` SPEED_28800
`static int`	`SPEED_300` SPEED_300
`static int`	`SPEED_31250` SPEED_31250
`static int`	`SPEED_38400` SPEED_38400
`static int`	`SPEED_4800` SPEED_4800
`static int`	`SPEED_56000` SPEED_56000
`static int`	`SPEED_57600` SPEED_57600
`static int`	`SPEED_600` SPEED_600
`static int`	`SPEED_9600` SPEED_9600
`static int`	`STDAUX` STDAUX
`static int`	`STDCOM` STDCOM
`static int`	`STOPBITS_1` STOPBITS_1
`static int`	`STOPBITS_2` STOPBITS_2

Constructor Summary

Constructors
Modifier Constructor and Description

protected SerialPort(int port)
Initializer used only when instantiating AUXSerialPort.class and COMSerialPort.class.

Constructors
Modifier	Constructor and Description
`protected`	`SerialPort(int port)` Initializer used only when instantiating AUXSerialPort.class and COMSerialPort.class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventListener(SerialPortEventListener eventListener)` Adds an event listener for the port.
`void`	`close()` Closes the serial port and associated streams.
`void`	`disableReceiveFraming()` Disables the ports receive framing.
`void`	`disableReceiveThreshold()` Disables the ports receive threshold.
`void`	`disableReceiveTimeout()` Disables the ports receive timeout.
`void`	`enableReceiveFraming(int framingByte)`
`void`	`enableReceiveThreshold(int thresh)` Enables the ports receive threshold.
`void`	`enableReceiveTimeout(int rcvTimeout)` Enables the ports receive timeout.
`int`	`getBaudRate()` Returns the ports current baud rate in bits per second.
`int`	`getDataBits()` Returns the ports current the data bit (word size) setting.
`int`	`getFlowControlMode()` Returns the ports current flow control mode.
`int`	`getInputBufferSize()` Returns the ports input buffer size.
`SerialInputStream`	`getInputStream()` Returns the InputStream associated with this port.
`int`	`getOutputBufferSize()` Returns the ports current output buffer size.
`SerialOutputStream`	`getOutputStream()` Returns the OutputStream associated with this port.
`int`	`getParity()` Returns the ports current parity setting.
`int`	`getReceiveFramingByte()` Returns the ports receive framing byte.
`int`	`getReceiveThreshold()` Returns the ports threshold enable state.
`int`	`getReceiveTimeout()` Returns the ports current receive timeout.
`int`	`getStopBits()` Returns the ports current stop bits setting.
`boolean`	`isReceiveFramingEnabled()` Returns the ports receive framing enable state.
`boolean`	`isReceiveThresholdEnabled()` Returns the ports threshold enable state.
`boolean`	`isReceiveTimeoutEnabled()` Returns the ports receive timeout enable state.
`void`	`notifyOnBreakInterrupt(boolean enable)` Requests notification when break interrupt occurs.
`void`	`notifyOnCTS(boolean enable)` Requests notification when CTS changes state.
`void`	`notifyOnDataAvailable(boolean enable)` Requests notification when data is available to read.
`void`	`notifyOnFramingError(boolean enable)` Requests notification when framing error occurs.
`void`	`notifyOnOutputEmpty(boolean enable)` Requests notification when output buffer is empty.
`void`	`notifyOnOverrunError(boolean enable)` Requests notification when overrun error occurs.
`void`	`notifyOnParityError(boolean enable)` Requests notification when parity error occurs.
`void`	`open()` A serial port must be opened in order to gain access to its streams.
`void`	`removeEventListener()` Removes an event listener.
`void`	`sendBreak(int millis)` Creates a serial Break condition for the defined period in milliseconds.
`void`	`setBitParameters(int dataBits, int stopBits, int parity)`
`void`	`setFlowControlMode(int flow)` Sets the ports flow control mode.
`void`	`setInputBufferSize(int size)` Sets the ports input buffer size.
`void`	`setOutputBufferSize(int size)` Sets the ports output buffer size.
`void`	`setSerialPortParams(int baudRate, int dataBits, int stopBits, int parity)`

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

- Field Detail
  - STDCOM
```
public static final int STDCOM
```
    STDCOM
    
    See Also:
    
    Constant Field Values
  - STDAUX
```
public static final int STDAUX
```
    STDAUX
    
    See Also:
    
    Constant Field Values
  - SPEED_110
```
public static final int SPEED_110
```
    SPEED_110
    
    See Also:
    
    Constant Field Values
  - SPEED_150
```
public static final int SPEED_150
```
    SPEED_150
    
    See Also:
    
    Constant Field Values
  - SPEED_300
```
public static final int SPEED_300
```
    SPEED_300
    
    See Also:
    
    Constant Field Values
  - SPEED_600
```
public static final int SPEED_600
```
    SPEED_600
    
    See Also:
    
    Constant Field Values
  - SPEED_1200
```
public static final int SPEED_1200
```
    SPEED_1200
    
    See Also:
    
    Constant Field Values
  - SPEED_2400
```
public static final int SPEED_2400
```
    SPEED_2400
    
    See Also:
    
    Constant Field Values
  - SPEED_4800
```
public static final int SPEED_4800
```
    SPEED_4800
    
    See Also:
    
    Constant Field Values
  - SPEED_9600
```
public static final int SPEED_9600
```
    SPEED_9600
    
    See Also:
    
    Constant Field Values
  - SPEED_14400
```
public static final int SPEED_14400
```
    SPEED_14400
    
    See Also:
    
    Constant Field Values
  - SPEED_19200
```
public static final int SPEED_19200
```
    SPEED_19200
    
    See Also:
    
    Constant Field Values
  - SPEED_28800
```
public static final int SPEED_28800
```
    SPEED_28800
    
    See Also:
    
    Constant Field Values
  - SPEED_31250
```
public static final int SPEED_31250
```
    SPEED_31250
    
    See Also:
    
    Constant Field Values
  - SPEED_38400
```
public static final int SPEED_38400
```
    SPEED_38400
    
    See Also:
    
    Constant Field Values
  - SPEED_56000
```
public static final int SPEED_56000
```
    SPEED_56000
    
    See Also:
    
    Constant Field Values
  - SPEED_57600
```
public static final int SPEED_57600
```
    SPEED_57600
    
    See Also:
    
    Constant Field Values
  - SPEED_115200
```
public static final int SPEED_115200
```
    SPEED_115200
    
    See Also:
    
    Constant Field Values
  - SPEED_128000
```
public static final int SPEED_128000
```
    SPEED_128000
    
    See Also:
    
    Constant Field Values
  - SPEED_250000
```
public static final int SPEED_250000
```
    SPEED_250000
    
    See Also:
    
    Constant Field Values
  - DATABITS_7
```
public static final int DATABITS_7
```
    DATABITS_7
    
    See Also:
    
    Constant Field Values
  - DATABITS_8
```
public static final int DATABITS_8
```
    DATABITS_8
    
    See Also:
    
    Constant Field Values
  - STOPBITS_1
```
public static final int STOPBITS_1
```
    STOPBITS_1
    
    See Also:
    
    Constant Field Values
  - STOPBITS_2
```
public static final int STOPBITS_2
```
    STOPBITS_2
    
    See Also:
    
    Constant Field Values
  - PARITY_NONE
```
public static final int PARITY_NONE
```
    PARITY_NONE
    
    See Also:
    
    Constant Field Values
  - PARITY_ODD
```
public static final int PARITY_ODD
```
    PARITY_ODD
    
    See Also:
    
    Constant Field Values
  - PARITY_EVEN
```
public static final int PARITY_EVEN
```
    PARITY_EVEN
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_NONE
```
public static final int FLOWCONTROL_NONE
```
    FLOWCONTROL_NONE
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_RTSCTS_IN
```
public static final int FLOWCONTROL_RTSCTS_IN
```
    FLOWCONTROL_RTSCTS_IN
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_RTSCTS_OUT
```
public static final int FLOWCONTROL_RTSCTS_OUT
```
    FLOWCONTROL_RTSCTS_OUT
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_XONXOFF_IN
```
public static final int FLOWCONTROL_XONXOFF_IN
```
    FLOWCONTROL_XONXOFF_IN
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_XONXOFF_OUT
```
public static final int FLOWCONTROL_XONXOFF_OUT
```
    FLOWCONTROL_XONXOFF_OUT
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SerialPort
```
protected SerialPort(int port)
```
    Initializer used only when instantiating AUXSerialPort.class and COMSerialPort.class.
    
    Parameters:
    
    port - Defines serial port (COM = 4, AUX = 6).
    
    Throws:
    
    IllegalArgumentException - when the parameter is not recognized.
- Method Detail
  - open
```
public void open()
          throws PortInUseException,
                 IOException
```
    A serial port must be opened in order to gain access to its streams. This allows the process to take ownership of the port and this instance of the port class to take control.
    
    Throws:
    
    PortInUseException - when this or another process already has control of this resource
    
    IOException - if a stream cannot be created
  - close
```
public void close()
```
    Closes the serial port and associated streams.
  - setSerialPortParams
```
public void setSerialPortParams(int baudRate,
                                int dataBits,
                                int stopBits,
                                int parity)
                         throws UnsupportedCommOperationException
```
    Parameters:
    
    baudRate - ?
    
    dataBits - ?
    
    stopBits - ?
    
    parity - ?
    
    Throws:
    
    UnsupportedCommOperationException - ?
  - getBaudRate
```
public int getBaudRate()
```
    Returns the ports current baud rate in bits per second.
    
    Returns:
    
    the current baud rate
  - setBitParameters
```
public void setBitParameters(int dataBits,
                             int stopBits,
                             int parity)
                      throws UnsupportedCommOperationException
```
    Parameters:
    
    dataBits - ?
    
    stopBits - ?
    
    parity - ?
    
    Throws:
    
    UnsupportedCommOperationException - ?
  - getDataBits
```
public int getDataBits()
```
    Returns the ports current the data bit (word size) setting.
    
    Returns:
    
    the current word size
  - getStopBits
```
public int getStopBits()
```
    Returns the ports current stop bits setting.
    
    Returns:
    
    the current stop bits
  - getParity
```
public int getParity()
```
    Returns the ports current parity setting.
    
    Returns:
    
    the current parity
  - getInputStream
```
public SerialInputStream getInputStream()
                                 throws IOException
```
    Returns the InputStream associated with this port.
    
    Returns:
    
    the InputStream associated with this port
    
    Throws:
    
    IOException - if the stream is not available
    
    IllegalStateException - if the port is not open
  - getOutputStream
```
public SerialOutputStream getOutputStream()
                                   throws IOException
```
    Returns the OutputStream associated with this port.
    
    Returns:
    
    the OutputStream associated with this port
    
    Throws:
    
    IOException - if the stream is not available
    
    IllegalStateException - if the port is not open
  - setFlowControlMode
```
public void setFlowControlMode(int flow)
                        throws UnsupportedCommOperationException
```
    Sets the ports flow control mode.
    
    Parameters:
    
    flow - ?
    
    Throws:
    
    UnsupportedCommOperationException - ?
    
    IllegalStateException - if the port is not open
  - getFlowControlMode
```
public int getFlowControlMode()
```
    Returns the ports current flow control mode.
    
    Returns:
    
    the current flow control mode
    
    See Also:
    
    setFlowControlMode(int flow)
  - sendBreak
```
public void sendBreak(int millis)
```
    Creates a serial Break condition for the defined period in milliseconds. As of v1.6.2 this no longer sleeps for the duration of the break.
    
    Parameters:
    
    millis - desired duration of the break in milliseconds
    
    Throws:
    
    IllegalStateException - if the port is not open
  - addEventListener
```
public void addEventListener(SerialPortEventListener eventListener)
                      throws TooManyListenersException
```
    Adds an event listener for the port. A new Thread will be created to manage events as soon as one of the notifyOn methods are called.
    
    Parameters:
    
    eventListener - listener class to be installed
    
    Throws:
    
    IllegalStateException - if the port is not open
    
    TooManyListenersException - if the maximum number of listeners has been installed
  - removeEventListener
```
public void removeEventListener()
```
    Removes an event listener. This method removes all threads associated with event listeners when the last listener is removed.
  - notifyOnDataAvailable
```
public void notifyOnDataAvailable(boolean enable)
```
    Requests notification when data is available to read. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - notifyOnOutputEmpty
```
public void notifyOnOutputEmpty(boolean enable)
```
    Requests notification when output buffer is empty. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - notifyOnCTS
```
public void notifyOnCTS(boolean enable)
```
    Requests notification when CTS changes state. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - notifyOnOverrunError
```
public void notifyOnOverrunError(boolean enable)
```
    Requests notification when overrun error occurs. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - notifyOnParityError
```
public void notifyOnParityError(boolean enable)
```
    Requests notification when parity error occurs. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - notifyOnFramingError
```
public void notifyOnFramingError(boolean enable)
```
    Requests notification when framing error occurs. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - notifyOnBreakInterrupt
```
public void notifyOnBreakInterrupt(boolean enable)
```
    Requests notification when break interrupt occurs. This method will create a new Thread to manage events if one has not already been created.
    
    Parameters:
    
    enable - set to true to enable
  - enableReceiveThreshold
```
public void enableReceiveThreshold(int thresh)
                            throws UnsupportedCommOperationException
```
    Enables the ports receive threshold.
    
    Parameters:
    
    thresh - - Desired read threshold
    
    Throws:
    
    UnsupportedCommOperationException - if thresh < 0
    
    IllegalStateException - if the InputStream is not accessable
  - disableReceiveThreshold
```
public void disableReceiveThreshold()
```
    Disables the ports receive threshold.
  - isReceiveThresholdEnabled
```
public boolean isReceiveThresholdEnabled()
```
    Returns the ports threshold enable state. Used by javax.comm.SerialPort.
    
    Returns:
    
    true if receive threshold is enabled
  - getReceiveThreshold
```
public int getReceiveThreshold()
```
    Returns the ports threshold enable state.
    
    Returns:
    
    true if receive threshold is enabled
  - enableReceiveTimeout
```
public void enableReceiveTimeout(int rcvTimeout)
                          throws UnsupportedCommOperationException
```
    Enables the ports receive timeout.
    
    Parameters:
    
    rcvTimeout - timeout in milliseconds
    
    Throws:
    
    UnsupportedCommOperationException - if rcvTimeout < 0
    
    IllegalStateException - if the port is closed
  - disableReceiveTimeout
```
public void disableReceiveTimeout()
```
    Disables the ports receive timeout.
    
    Throws:
    
    IllegalStateException - if the port is closed
  - isReceiveTimeoutEnabled
```
public boolean isReceiveTimeoutEnabled()
```
    Returns the ports receive timeout enable state.
    
    Returns:
    
    true if receive timeout is enabled
  - getReceiveTimeout
```
public int getReceiveTimeout()
```
    Returns the ports current receive timeout.
    
    Returns:
    
    the current timeout value
  - enableReceiveFraming
```
public void enableReceiveFraming(int framingByte)
                          throws UnsupportedCommOperationException
```
    Parameters:
    
    framingByte - ?
    
    Throws:
    
    UnsupportedCommOperationException - ?
  - disableReceiveFraming
```
public void disableReceiveFraming()
```
    Disables the ports receive framing.
  - isReceiveFramingEnabled
```
public boolean isReceiveFramingEnabled()
```
    Returns the ports receive framing enable state.
    
    Returns:
    
    false always
  - getReceiveFramingByte
```
public int getReceiveFramingByte()
```
    Returns the ports receive framing byte.
    
    Returns:
    
    -1 always
  - setInputBufferSize
```
public void setInputBufferSize(int size)
```
    Sets the ports input buffer size.
    
    Parameters:
    
    size - number of bytes to use for the input receive buffer
  - getInputBufferSize
```
public int getInputBufferSize()
```
    Returns the ports input buffer size.
    
    Returns:
    
    the current input buffer size
  - setOutputBufferSize
```
public void setOutputBufferSize(int size)
```
    Sets the ports output buffer size.
    
    Parameters:
    
    size - number of bytes to use for the output transmit buffer
  - getOutputBufferSize
```
public int getOutputBufferSize()
```
    Returns the ports current output buffer size.
    
    Returns:
    
    the current output buffer size

Class SerialPort

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STDCOM

STDAUX

SPEED_110

SPEED_150

SPEED_300

SPEED_600

SPEED_1200

SPEED_2400

SPEED_4800

SPEED_9600

SPEED_14400

SPEED_19200

SPEED_28800

SPEED_31250

SPEED_38400

SPEED_56000

SPEED_57600

SPEED_115200

SPEED_128000

SPEED_250000

DATABITS_7

DATABITS_8

STOPBITS_1

STOPBITS_2

PARITY_NONE

PARITY_ODD

PARITY_EVEN

FLOWCONTROL_NONE

FLOWCONTROL_RTSCTS_IN

FLOWCONTROL_RTSCTS_OUT

FLOWCONTROL_XONXOFF_IN

FLOWCONTROL_XONXOFF_OUT

Constructor Detail

SerialPort

Method Detail

open

close

setSerialPortParams

getBaudRate

setBitParameters

getDataBits

getStopBits

getParity

getInputStream

getOutputStream

setFlowControlMode

getFlowControlMode

sendBreak

addEventListener

removeEventListener

notifyOnDataAvailable

notifyOnOutputEmpty

notifyOnCTS

notifyOnOverrunError

notifyOnParityError

notifyOnFramingError

notifyOnBreakInterrupt

enableReceiveThreshold

disableReceiveThreshold

isReceiveThresholdEnabled

getReceiveThreshold

enableReceiveTimeout

disableReceiveTimeout

isReceiveTimeoutEnabled

getReceiveTimeout

enableReceiveFraming

disableReceiveFraming

isReceiveFramingEnabled

getReceiveFramingByte

setInputBufferSize

getInputBufferSize

setOutputBufferSize

getOutputBufferSize