SerialPort

java.lang.Object
- com.digi.android.serial.SerialPort

```
public class SerialPort
extends java.lang.Object
```
Represents a serial port to communicate with.
To obtain an instance of the serial port and open it you have to use one of the following methods: SerialPortManager.openSerialPort(String), SerialPortManager.openSerialPort(String, int, int, int, int, int, int), or SerialPortManager.openSerialPort(String, SerialPortParameters).

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DATABITS_5`	5 data bits: .
`static int`	`DATABITS_6`	6 data bits: .
`static int`	`DATABITS_7`	7 data bits: .
`static int`	`DATABITS_8`	8 data bits: .
`static int`	`DEFAULT_READ_TIMEOUT`	Default read timeout: milliseconds.
`static int`	`FLOWCONTROL_NONE`	No flow control: .
`static int`	`FLOWCONTROL_RTSCTS_IN`	Hardware flow control (input): .
`static int`	`FLOWCONTROL_RTSCTS_OUT`	Hardware flow control (output): .
`static int`	`FLOWCONTROL_XONXOFF_IN`	Xon/Xoff flow control (input): .
`static int`	`FLOWCONTROL_XONXOFF_OUT`	Xon/Xoff flow control (output): .
`static int`	`PARITY_EVEN`	Parity even: .
`static int`	`PARITY_MARK`	Parity mark: .
`static int`	`PARITY_NONE`	Parity none: .
`static int`	`PARITY_ODD`	Parity odd: .
`static int`	`PARITY_SPACE`	Parity space: .
`static int`	`STOPBITS_1`	1 stop bit: .
`static int`	`STOPBITS_1_5`	1.5 stop bits: .
`static int`	`STOPBITS_2`	2 stop bits: .

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Closes the communications port.
`void`	`disableReceiveThreshold()`	Disables receive threshold.
`void`	`disableReceiveTimeout()`	Disables receive timeout.
`void`	`enableReceiveThreshold(int thresh)`	Enables receive threshold, if this feature is supported by the driver.
`void`	`enableReceiveTimeout(int time)`	Enables receive timeout, if this feature is supported by the driver.
`int`	`getBaudBase()`	Returns the baud base value.
`int`	`getBaudRate()`	Returns the configured baud rate.
`int`	`getDataBits()`	Returns the configured data bits.
`int`	`getDivisor()`	Returns the divisor value.
`byte`	`getEndOfInputChar()`	Returns the end of input character.
`int`	`getFlowControl()`	Returns the configured flow control.
`int`	`getInputBufferSize()`	Returns the input buffer size.
`java.io.InputStream`	`getInputStream()`	Returns the connection interface input stream to read data from.
`java.lang.String`	`getName()`	Returns the serial port name.
`int`	`getOutputBufferSize()`	Returns the output buffer size.
`java.io.OutputStream`	`getOutputStream()`	Returns the connection interface output stream to write data to.
`int`	`getParity()`	Returns the configured parity.
`byte`	`getParityErrorChar()`	Returns the parity error character.
`int`	`getReceiveThreshold()`	Returns the integer value of the receive threshold.
`int`	`getReceiveTimeout()`	Returns the integer value of the receive timeout.
`int`	`getStopBits()`	Returns the configured stop bits.
`boolean`	`isCD()`	Returns the state of the CD line.
`boolean`	`isCTS()`	Returns the state of the CTS line.
`boolean`	`isDSR()`	Returns the state of the DSR line.
`boolean`	`isDTR()`	Returns the state of the DTR line.
`boolean`	`isReceiveThresholdEnabled()`	Checks if receive threshold is enabled.
`boolean`	`isReceiveTimeoutEnabled()`	Checks if receive timeout is enabled.
`boolean`	`isRI()`	Returns the state of the RI line.
`boolean`	`isRTS()`	Returns the state of the RTS line.
`void`	`notifyOnBreakInterrupt(boolean enable)`	Sets whether the listener should be notified on break interrupt.
`void`	`notifyOnCarrierDetect(boolean enable)`	Sets whether the listener should be notified on carrier detect.
`void`	`notifyOnCTS(boolean enable)`	Sets whether the listener should be notified on CTS.
`void`	`notifyOnDataAvailable(boolean enable)`	Sets whether the listener should be notified on data available.
`void`	`notifyOnDSR(boolean enable)`	Sets whether the listener should be notified on DSR.
`void`	`notifyOnFramingError(boolean enable)`	Sets whether the listener should be notified on framing error.
`void`	`notifyOnOutputEmpty(boolean enable)`	Sets whether the listener should be notified on output empty.
`void`	`notifyOnOverrunError(boolean enable)`	Sets whether the listener should be notified on overrun error.
`void`	`notifyOnParityError(boolean enable)`	Sets whether the listener should be notified on parity error.
`void`	`notifyOnRingIndicator(boolean enable)`	Sets whether the listener should be notified on ring indicator.
`int`	`readData(byte[] buffer, int numBytes)`	Attempts to read the given amount of bytes from the serial port.
`void`	`registerEventListener(ISerialPortEventListener listener)`	Registers the given listener to be notified when a serial port event occurs.
`void`	`sendBreak(int duration)`	Sends a break signal to the serial port with the given duration (in milliseconds).
`boolean`	`setBaudBase(int baudBase)`	Sets the baud base value.
`boolean`	`setDivisor(int divisor)`	Sets the divisor value.
`void`	`setDTR(boolean state)`	Sets the state of the DTR.
`boolean`	`setEndOfInputChar(byte b)`	Sets the end of input character.
`void`	`setInputBufferSize(int size)`	Sets the input buffer size.
`void`	`setOutputBufferSize(int size)`	Sets the output buffer size.
`boolean`	`setParityErrorChar(byte b)`	Sets the parity error character.
`void`	`setPortParameters(int baudRate, int dataBits, int stopBits, int parity, int flowControl)`	Sets the new parameters of the serial port.
`void`	`setRTS(boolean state)`	Sets the state of the RTS line.
`java.lang.String`	`toString()`
`void`	`unregisterEventListener()`	Unregisters the configured serial port event listener.
`void`	`writeData(byte[] data, int numBytes)`	Attempts to write the given amount of bytes to the serial port.

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

- Field Detail
  - DATABITS_5
```
public static final int DATABITS_5
```
    5 data bits: .
    
    See Also:
    
    Constant Field Values
  - DATABITS_6
```
public static final int DATABITS_6
```
    6 data bits: .
    
    See Also:
    
    Constant Field Values
  - DATABITS_7
```
public static final int DATABITS_7
```
    7 data bits: .
    
    See Also:
    
    Constant Field Values
  - DATABITS_8
```
public static final int DATABITS_8
```
    8 data bits: .
    
    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
  - PARITY_MARK
```
public static final int PARITY_MARK
```
    Parity mark: .
    
    See Also:
    
    Constant Field Values
  - PARITY_SPACE
```
public static final int PARITY_SPACE
```
    Parity space: .
    
    See Also:
    
    Constant Field Values
  - STOPBITS_1
```
public static final int STOPBITS_1
```
    1 stop bit: .
    
    See Also:
    
    Constant Field Values
  - STOPBITS_2
```
public static final int STOPBITS_2
```
    2 stop bits: .
    
    See Also:
    
    Constant Field Values
  - STOPBITS_1_5
```
public static final int STOPBITS_1_5
```
    1.5 stop bits: .
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_NONE
```
public static final int FLOWCONTROL_NONE
```
    No flow control: .
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_RTSCTS_IN
```
public static final int FLOWCONTROL_RTSCTS_IN
```
    Hardware flow control (input): .
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_RTSCTS_OUT
```
public static final int FLOWCONTROL_RTSCTS_OUT
```
    Hardware flow control (output): .
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_XONXOFF_IN
```
public static final int FLOWCONTROL_XONXOFF_IN
```
    Xon/Xoff flow control (input): .
    
    See Also:
    
    Constant Field Values
  - FLOWCONTROL_XONXOFF_OUT
```
public static final int FLOWCONTROL_XONXOFF_OUT
```
    Xon/Xoff flow control (output): .
    
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_TIMEOUT
```
public static final int DEFAULT_READ_TIMEOUT
```
    Default read timeout: milliseconds.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - registerEventListener
```
public void registerEventListener(ISerialPortEventListener listener)
                           throws java.util.TooManyListenersException
```
    Registers the given listener to be notified when a serial port event occurs.
    Note that you can only register one listener.
    
    Parameters:
    
    listener - Serial port event listener.
    
    Throws:
    
    java.util.TooManyListenersException - If you register more than one listener.
    
    See Also:
    
    unregisterEventListener(), ISerialPortEventListener
  - unregisterEventListener
```
public void unregisterEventListener()
```
    Unregisters the configured serial port event listener.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener)
  - setPortParameters
```
public void setPortParameters(int baudRate,
                              int dataBits,
                              int stopBits,
                              int parity,
                              int flowControl)
                       throws UnsupportedCommOperationException
```
    Sets the new parameters of the serial port.
    
    Parameters:
    
    baudRate - Baud rate.
    
    dataBits - Data bits, one of DATABITS_5, DATABITS_6, DATABITS_7, and DATABITS_8.
    
    stopBits - Stop bits, one of STOPBITS_1, STOPBITS_2, and STOPBITS_1_5.
    
    parity - Parity, one of PARITY_NONE, PARITY_ODD, PARITY_EVEN, PARITY_MARK, and PARITY_SPACE.
    
    flowControl - Flow control, one of FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN, and FLOWCONTROL_XONXOFF_OUT. Use an "|" to combine them, e.g. FLOWCONTROL_RTSCTS_IN | FLOWCONTROL_RTSCTS_OUT.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    DATABITS_5, DATABITS_6, DATABITS_7, DATABITS_8, FLOWCONTROL_NONE, FLOWCONTROL_RTSCTS_IN, FLOWCONTROL_RTSCTS_OUT, FLOWCONTROL_XONXOFF_IN, FLOWCONTROL_XONXOFF_OUT, PARITY_EVEN, PARITY_MARK, PARITY_NONE, PARITY_ODD, PARITY_SPACE, STOPBITS_1, STOPBITS_1_5, STOPBITS_2, getBaudRate(), getDataBits(), getFlowControl(), getParity(), getStopBits()
  - getBaudRate
```
public int getBaudRate()
```
    Returns the configured baud rate.
    
    Returns:
    
    Baud rate.
    
    See Also:
    
    setPortParameters(int, int, int, int, int)
  - getDataBits
```
public int getDataBits()
```
    Returns the configured data bits.
    
    Returns:
    
    Data bits.
    
    See Also:
    
    setPortParameters(int, int, int, int, int)
  - getStopBits
```
public int getStopBits()
```
    Returns the configured stop bits.
    
    Returns:
    
    Stop bits.
    
    See Also:
    
    setPortParameters(int, int, int, int, int)
  - getParity
```
public int getParity()
```
    Returns the configured parity.
    
    Returns:
    
    Parity.
    
    See Also:
    
    setPortParameters(int, int, int, int, int)
  - getFlowControl
```
public int getFlowControl()
```
    Returns the configured flow control.
    
    Returns:
    
    Flow control.
    
    See Also:
    
    setPortParameters(int, int, int, int, int)
  - isDTR
```
public boolean isDTR()
```
    Returns the state of the DTR line.
    
    Returns:
    
    true if the line is high, false otherwise.
    
    See Also:
    
    isCD(), isCTS(), isDSR(), isRI(), isRTS(), setDTR(boolean), setRTS(boolean)
  - setDTR
```
public void setDTR(boolean state)
```
    Sets the state of the DTR.
    
    Parameters:
    
    state - true to set the line status high, false to set it low.
    
    See Also:
    
    isCD(), isCTS(), isDSR(), isDTR(), isRI(), isRTS(), setRTS(boolean)
  - isRTS
```
public boolean isRTS()
```
    Returns the state of the RTS line.
    
    Returns:
    
    true if the line is high, false otherwise.
    
    See Also:
    
    isCD(), isCTS(), isDSR(), isDTR(), isRI(), setDTR(boolean), setRTS(boolean)
  - setRTS
```
public void setRTS(boolean state)
```
    Sets the state of the RTS line.
    
    Parameters:
    
    state - true to set the line status high, false to set it low.
    
    See Also:
    
    isCD(), isCTS(), isDSR(), isDTR(), isRI(), isRTS(), setDTR(boolean)
  - isCTS
```
public boolean isCTS()
```
    Returns the state of the CTS line.
    
    Returns:
    
    true if the line is high, false otherwise.
    
    See Also:
    
    isCD(), isDSR(), isDTR(), isRI(), isRTS(), setDTR(boolean), setRTS(boolean)
  - isDSR
```
public boolean isDSR()
```
    Returns the state of the DSR line.
    
    Returns:
    
    true if the line is high, false otherwise.
    
    See Also:
    
    isCD(), isCTS(), isDTR(), isRI(), isRTS(), setDTR(boolean), setRTS(boolean)
  - isCD
```
public boolean isCD()
```
    Returns the state of the CD line.
    
    Returns:
    
    true if the line is high, false otherwise.
    
    See Also:
    
    isCTS(), isDSR(), isDTR(), isRI(), isRTS(), setDTR(boolean), setRTS(boolean)
  - isRI
```
public boolean isRI()
```
    Returns the state of the RI line.
    
    Returns:
    
    true if the line is high, false otherwise.
    
    See Also:
    
    isCD(), isCTS(), isDSR(), isDTR(), isRTS(), setDTR(boolean), setRTS(boolean)
  - sendBreak
```
public void sendBreak(int duration)
```
    Sends a break signal to the serial port with the given duration (in milliseconds).
    
    Parameters:
    
    duration - Duration of the break signal in milliseconds.
  - notifyOnDataAvailable
```
public void notifyOnDataAvailable(boolean enable)
```
    Sets whether the listener should be notified on data available.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnOutputEmpty
```
public void notifyOnOutputEmpty(boolean enable)
```
    Sets whether the listener should be notified on output empty.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnCTS
```
public void notifyOnCTS(boolean enable)
```
    Sets whether the listener should be notified on CTS.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnDSR
```
public void notifyOnDSR(boolean enable)
```
    Sets whether the listener should be notified on DSR.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnRingIndicator
```
public void notifyOnRingIndicator(boolean enable)
```
    Sets whether the listener should be notified on ring indicator.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnCarrierDetect
```
public void notifyOnCarrierDetect(boolean enable)
```
    Sets whether the listener should be notified on carrier detect.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnOverrunError
```
public void notifyOnOverrunError(boolean enable)
```
    Sets whether the listener should be notified on overrun error.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnParityError
```
public void notifyOnParityError(boolean enable)
```
    Sets whether the listener should be notified on parity error.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnFramingError
```
public void notifyOnFramingError(boolean enable)
```
    Sets whether the listener should be notified on framing error.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - notifyOnBreakInterrupt
```
public void notifyOnBreakInterrupt(boolean enable)
```
    Sets whether the listener should be notified on break interrupt.
    
    Parameters:
    
    enable - true to notify.
    
    See Also:
    
    registerEventListener(ISerialPortEventListener), ISerialPortEventListener, SerialPortEvent
  - getParityErrorChar
```
public byte getParityErrorChar()
                        throws UnsupportedCommOperationException
```
    Returns the parity error character.
    
    Returns:
    
    The Parity Error Character.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    setParityErrorChar(byte)
  - setParityErrorChar
```
public boolean setParityErrorChar(byte b)
                           throws UnsupportedCommOperationException
```
    Sets the parity error character.
    
    Parameters:
    
    b - Parity Error Character.
    
    Returns:
    
    true on success.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    getParityErrorChar()
  - getEndOfInputChar
```
public byte getEndOfInputChar()
                       throws UnsupportedCommOperationException
```
    Returns the end of input character.
    
    Returns:
    
    The End of Input Character.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    setEndOfInputChar(byte)
  - setEndOfInputChar
```
public boolean setEndOfInputChar(byte b)
                          throws UnsupportedCommOperationException
```
    Sets the end of input character.
    
    Parameters:
    
    b - End Of Input Character.
    
    Returns:
    
    true on success.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    getEndOfInputChar()
  - setBaudBase
```
public boolean setBaudBase(int baudBase)
                    throws UnsupportedCommOperationException,
                           java.io.IOException
```
    Sets the baud base value.
    
    Parameters:
    
    baudBase - The clock frequency divided by 16. Default BaudBase is 115200.
    
    Returns:
    
    true on success.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    getBaudBase()
  - getBaudBase
```
public int getBaudBase()
                throws UnsupportedCommOperationException,
                       java.io.IOException
```
    Returns the baud base value.
    
    Returns:
    
    Baud base.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    setBaudBase(int)
  - setDivisor
```
public boolean setDivisor(int divisor)
                   throws UnsupportedCommOperationException,
                          java.io.IOException
```
    Sets the divisor value.
    
    Parameters:
    
    divisor - Divisor.
    
    Returns:
    
    true on success.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    getDivisor()
  - getDivisor
```
public int getDivisor()
               throws UnsupportedCommOperationException,
                      java.io.IOException
```
    Returns the divisor value.
    
    Returns:
    
    Divisor.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    setDivisor(int)
  - disableReceiveTimeout
```
public void disableReceiveTimeout()
```
    Disables receive timeout.
    
    See Also:
    
    enableReceiveTimeout(int), getReceiveTimeout(), isReceiveTimeoutEnabled()
  - enableReceiveTimeout
```
public void enableReceiveTimeout(int time)
                          throws UnsupportedCommOperationException
```
    Enables receive timeout, if this feature is supported by the driver. When the receive timeout condition becomes true, a read from the input stream for this port will return immediately.
    This is an advisory method which the driver may not implement. By default, receive timeout is not enabled.
    
    An application can determine whether the driver supports this feature by first calling the enableReceiveTimeout(int) method and then calling the isReceiveTimeoutEnabled() method. If it returns false, then receive timeout is not supported by the driver.
    
    Parameters:
    
    time - When this many milliseconds have elapsed, return immediately from read, regardless of bytes in input buffer.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    disableReceiveTimeout(), getReceiveTimeout(), isReceiveTimeoutEnabled()
  - isReceiveTimeoutEnabled
```
public boolean isReceiveTimeoutEnabled()
```
    Checks if receive timeout is enabled.
    An application can determine whether the driver supports this feature by first calling the enableReceiveTimeout(int) method and then calling the isReceiveTimeoutEnabled() method. If it returns false, then receive timeout is not supported by the driver.
    
    Returns:
    
    true if the receive timeout is enabled, false otherwise.
    
    See Also:
    
    disableReceiveTimeout(), enableReceiveTimeout(int), getReceiveTimeout()
  - getReceiveTimeout
```
public int getReceiveTimeout()
```
    Returns the integer value of the receive timeout.
    
    Returns:
    
    Number of milliseconds in receive timeout.
    
    See Also:
    
    disableReceiveTimeout(), enableReceiveTimeout(int), isReceiveTimeoutEnabled()
  - enableReceiveThreshold
```
public void enableReceiveThreshold(int thresh)
                            throws UnsupportedCommOperationException
```
    Enables receive threshold, if this feature is supported by the driver. When the receive threshold condition becomes true, a read from the input stream for this port will return immediately.
    This is an advisory method which the driver may not implement. By default, receive threshold is not enabled.
    
    An application can determine whether the driver supports this feature by first calling the enableReceiveThreshold(int) method and then calling the isReceiveThresholdEnabled() method. If it returns false, then receive threshold is not supported by the driver.
    
    Parameters:
    
    thresh - When this many bytes are in the input buffer, return immediately from read.
    
    Throws:
    
    UnsupportedCommOperationException - If the operation is not supported by the driver.
    
    See Also:
    
    disableReceiveThreshold(), getReceiveThreshold(), isReceiveThresholdEnabled()
  - disableReceiveThreshold
```
public void disableReceiveThreshold()
```
    Disables receive threshold.
    
    See Also:
    
    enableReceiveThreshold(int), getReceiveThreshold(), isReceiveThresholdEnabled()
  - getReceiveThreshold
```
public int getReceiveThreshold()
```
    Returns the integer value of the receive threshold.
    
    Returns:
    
    Number of bytes for receive threshold.
    
    See Also:
    
    disableReceiveThreshold(), enableReceiveThreshold(int), isReceiveThresholdEnabled()
  - isReceiveThresholdEnabled
```
public boolean isReceiveThresholdEnabled()
```
    Checks if receive threshold is enabled.
    An application can determine whether the driver supports this feature by first calling the enableReceiveThreshold(int) method and then calling the isReceiveThresholdEnabled() method. If it returns false, then receive threshold is not supported by the driver.
    
    Returns:
    
    true if the receive threshold is enabled, false otherwise.
    
    See Also:
    
    disableReceiveThreshold(), enableReceiveThreshold(int), getReceiveThreshold()
  - setInputBufferSize
```
public void setInputBufferSize(int size)
```
    Sets the input buffer size.
    
    Parameters:
    
    size - Size of the input buffer in bytes.
    
    See Also:
    
    getInputBufferSize()
  - getInputBufferSize
```
public int getInputBufferSize()
```
    Returns the input buffer size.
    
    Returns:
    
    Input buffer size currently in use in bytes.
    
    See Also:
    
    setInputBufferSize(int)
  - setOutputBufferSize
```
public void setOutputBufferSize(int size)
```
    Sets the output buffer size.
    
    Parameters:
    
    size - Size of the output buffer in bytes.
    
    See Also:
    
    getOutputBufferSize()
  - getOutputBufferSize
```
public int getOutputBufferSize()
```
    Returns the output buffer size.
    
    Returns:
    
    Output buffer size currently in use in bytes.
    
    See Also:
    
    setOutputBufferSize(int)
  - close
```
public void close()
```
    Closes the communications port.
    The application must call this method when it is done with the port.
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Returns the connection interface input stream to read data from.
    
    Returns:
    
    The connection interface input stream to read data from.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
    
    See Also:
    
    getOutputStream(), InputStream
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Returns the connection interface output stream to write data to.
    
    Returns:
    
    The connection interface output stream to write data to.
    
    Throws:
    
    java.io.IOException - If an I/O error occurs.
    
    See Also:
    
    getInputStream(), OutputStream
  - getName
```
public java.lang.String getName()
```
    Returns the serial port name.
    
    Returns:
    
    The serial port name.
  - readData
```
public int readData(byte[] buffer,
                    int numBytes)
             throws java.io.IOException
```
    Attempts to read the given amount of bytes from the serial port.
    
    Parameters:
    
    buffer - Byte array to store read data.
    
    numBytes - Number of bytes to read.
    
    Returns:
    
    The number of read bytes.
    
    Throws:
    
    java.lang.IllegalArgumentException - If numBytes < 1 or if numBytes > buffer.length.
    
    java.io.IOException - If an I/O error occurs.
    
    See Also:
    
    writeData(byte[], int)
  - writeData
```
public void writeData(byte[] data,
                      int numBytes)
               throws java.io.IOException
```
    Attempts to write the given amount of bytes to the serial port.
    
    Parameters:
    
    data - Data to write.
    
    numBytes - Number of bytes to write.
    
    Throws:
    
    java.lang.IllegalArgumentException - If numBytes < 1 or if numBytes > data.length.
    
    java.io.IOException - If an I/O error occurs.
    
    See Also:
    
    readData(byte[], int)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SerialPort

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATABITS_5

DATABITS_6

DATABITS_7

DATABITS_8

PARITY_NONE

PARITY_ODD

PARITY_EVEN

PARITY_MARK

PARITY_SPACE

STOPBITS_1

STOPBITS_2

STOPBITS_1_5

FLOWCONTROL_NONE

FLOWCONTROL_RTSCTS_IN

FLOWCONTROL_RTSCTS_OUT

FLOWCONTROL_XONXOFF_IN

FLOWCONTROL_XONXOFF_OUT

DEFAULT_READ_TIMEOUT

Method Detail

registerEventListener

unregisterEventListener

setPortParameters

getBaudRate

getDataBits

getStopBits

getParity

getFlowControl

isDTR

setDTR

isRTS

setRTS

isCTS

isDSR

isCD

isRI

sendBreak

notifyOnDataAvailable

notifyOnOutputEmpty

notifyOnCTS

notifyOnDSR

notifyOnRingIndicator

notifyOnCarrierDetect

notifyOnOverrunError

notifyOnParityError

notifyOnFramingError

notifyOnBreakInterrupt

getParityErrorChar

setParityErrorChar

getEndOfInputChar

setEndOfInputChar

setBaudBase

getBaudBase

setDivisor

getDivisor

disableReceiveTimeout

enableReceiveTimeout

isReceiveTimeoutEnabled

getReceiveTimeout

enableReceiveThreshold

disableReceiveThreshold

getReceiveThreshold

isReceiveThresholdEnabled

setInputBufferSize

getInputBufferSize

setOutputBufferSize

getOutputBufferSize

close

getInputStream

getOutputStream

getName

readData

writeData

toString