public final class SerialPort +extends Object+
InputStream,
+OutputStream| Modifier and Type | +Field and Description | +
|---|---|
static int |
+EVEN_PARITY |
+
static int |
+FLOW_CONTROL_CTS_ENABLED |
+
static int |
+FLOW_CONTROL_DISABLED |
+
static int |
+FLOW_CONTROL_DSR_ENABLED |
+
static int |
+FLOW_CONTROL_DTR_ENABLED |
+
static int |
+FLOW_CONTROL_RTS_ENABLED |
+
static int |
+FLOW_CONTROL_XONXOFF_IN_ENABLED |
+
static int |
+FLOW_CONTROL_XONXOFF_OUT_ENABLED |
+
static int |
+LISTENING_EVENT_DATA_AVAILABLE |
+
static int |
+LISTENING_EVENT_DATA_RECEIVED |
+
static int |
+LISTENING_EVENT_DATA_WRITTEN |
+
static int |
+MARK_PARITY |
+
static int |
+NO_PARITY |
+
static int |
+ODD_PARITY |
+
static int |
+ONE_POINT_FIVE_STOP_BITS |
+
static int |
+ONE_STOP_BIT |
+
static int |
+SPACE_PARITY |
+
static int |
+TIMEOUT_NONBLOCKING |
+
static int |
+TIMEOUT_READ_BLOCKING |
+
static int |
+TIMEOUT_READ_SEMI_BLOCKING |
+
static int |
+TIMEOUT_WRITE_BLOCKING |
+
static int |
+TIMEOUT_WRITE_SEMI_BLOCKING |
+
static int |
+TWO_STOP_BITS |
+
| Constructor and Description | +
|---|
SerialPort() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+addDataListener(SerialPortDataListener listener)
+Adds a
+SerialPortDataListener to the serial port interface. |
+
int |
+bytesAvailable()
+Returns the number of bytes available without blocking if
+readBytes(byte[], long) were to be called immediately
+ after this method returns. |
+
boolean |
+closePort()
+Closes this serial port.
+ |
+
int |
+getBaudRate()
+Gets the current baud rate of the serial port.
+ |
+
static SerialPort[] |
+getCommPorts()
+Returns a list of all available serial ports on this machine.
+ |
+
String |
+getDescriptivePortName()
+Gets a descriptive string representing this serial port or the device connected to it.
+ |
+
int |
+getFlowControlSettings()
+Returns the flow control settings enabled on this serial port.
+ |
+
InputStream |
+getInputStream()
+Returns an
+InputStream object associated with this serial port. |
+
int |
+getNumDataBits()
+Gets the current number of data bits per word.
+ |
+
int |
+getNumStopBits()
+Gets the current number of stop bits per word.
+ |
+
OutputStream |
+getOutputStream()
+Returns an
+OutputStream object associated with this serial port. |
+
int |
+getParity()
+Gets the current parity error-checking scheme.
+ |
+
int |
+getReadTimeout()
+Gets the number of milliseconds of inactivity to tolerate before returning from a
+readBytes(byte[],long) call. |
+
String |
+getSystemPortName()
+Gets the operating system-defined device name corresponding to this serial port.
+ |
+
int |
+getWriteTimeout()
+Gets the number of milliseconds of inactivity to tolerate before returning from a
+writeBytes(byte[],long) call. |
+
boolean |
+openPort()
+Opens this serial port for reading and writing.
+ |
+
int |
+readBytes(byte[] buffer,
+ long bytesToRead)
+Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer.
+ |
+
void |
+removeDataListener()
+Removes the associated
+SerialPortDataListener from the serial port interface. |
+
void |
+setBaudRate(int newBaudRate)
+Sets the desired baud rate for this serial port.
+ |
+
void |
+setComPortParameters(int newBaudRate,
+ int newDataBits,
+ int newStopBits,
+ int newParity)
+Sets all serial port parameters at one time.
+ |
+
void |
+setComPortTimeouts(int newTimeoutMode,
+ int newReadTimeout,
+ int newWriteTimeout)
+Sets the serial port read and write timeout parameters.
+ |
+
void |
+setFlowControl(int newFlowControlSettings)
+Specifies what kind of flow control to enable for this serial port.
+ |
+
void |
+setNumDataBits(int newDataBits)
+Sets the desired number of data bits per word.
+ |
+
void |
+setNumStopBits(int newStopBits)
+Sets the desired number of stop bits per word.
+ |
+
void |
+setParity(int newParity)
+Sets the desired parity error-detection scheme to be used.
+ |
+
int |
+writeBytes(byte[] buffer,
+ long bytesToWrite)
+Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port.
+ |
+
public static final int NO_PARITY+
public static final int ODD_PARITY+
public static final int EVEN_PARITY+
public static final int MARK_PARITY+
public static final int SPACE_PARITY+
public static final int ONE_STOP_BIT+
public static final int ONE_POINT_FIVE_STOP_BITS+
public static final int TWO_STOP_BITS+
public static final int FLOW_CONTROL_DISABLED+
public static final int FLOW_CONTROL_RTS_ENABLED+
public static final int FLOW_CONTROL_CTS_ENABLED+
public static final int FLOW_CONTROL_DSR_ENABLED+
public static final int FLOW_CONTROL_DTR_ENABLED+
public static final int FLOW_CONTROL_XONXOFF_IN_ENABLED+
public static final int FLOW_CONTROL_XONXOFF_OUT_ENABLED+
public static final int TIMEOUT_NONBLOCKING+
public static final int TIMEOUT_READ_SEMI_BLOCKING+
public static final int TIMEOUT_WRITE_SEMI_BLOCKING+
public static final int TIMEOUT_READ_BLOCKING+
public static final int TIMEOUT_WRITE_BLOCKING+
public static final int LISTENING_EVENT_DATA_AVAILABLE+
public static final int LISTENING_EVENT_DATA_RECEIVED+
public static final int LISTENING_EVENT_DATA_WRITTEN+
public static SerialPort[] getCommPorts()+
+ The serial ports can be accessed by iterating through each of the SerialPort objects in this array. +
+ Note that the openPort() method must be called before any attempts to read from or write to the port. Likewise, closePort() should be called when you are finished accessing the port.
+
+ All serial port parameters or timeouts can be changed at any time after the port has been opened.
public final boolean openPort()+
+ All serial port parameters or timeouts can be changed at any time after the port has been opened.
public final boolean closePort()+
public final int bytesAvailable()+
readBytes(byte[], long) were to be called immediately
+ after this method returns.public final int readBytes(byte[] buffer, + long bytesToRead)+
+ The length of the byte buffer must be greater than or equal to the value passed in for bytesToRead +
+ If no timeouts were specified or the read timeout was set to 0, this call will block until bytesToRead bytes of data have been successfully read from the serial port. + Otherwise, this method will return after bytesToRead bytes of data have been read or the number of milliseconds specified by the read timeout have elapsed, + whichever comes first, regardless of the availability of more data.
buffer - The buffer into which the raw data is read.bytesToRead - The number of bytes to read from the serial port.public final int writeBytes(byte[] buffer, + long bytesToWrite)+
+ The length of the byte buffer must be greater than or equal to the value passed in for bytesToWrite +
+ If no timeouts were specified or the write timeout was set to 0, this call will block until bytesToWrite bytes of data have been successfully written the serial port. + Otherwise, this method will return after bytesToWrite bytes of data have been written or the number of milliseconds specified by the write timeout have elapsed, + whichever comes first, regardless of the availability of more data.
buffer - The buffer containing the raw data to write to the serial port.bytesToWrite - The number of bytes to write to the serial port.public final boolean addDataListener(SerialPortDataListener listener)+
SerialPortDataListener to the serial port interface.
+
+ Calling this function enables event-based serial port callbacks to be used instead of, or in addition to, direct serial port read/write calls or the InputStream/OutputStream interface.
+
+ The parameter passed into this method must be an implementation of either the SerialPortDataListener or the SerialPortPacketListener.
+ The SerialPortPacketListener interface must be used if you plan to use event-based reading of full data packets over the serial port.
+ Otherwise, the simpler SerialPortDataListener may be used.
+
+ Only one listener can be registered at a time; however, that listener can be used to detect multiple types of serial port events.
+ Refer to SerialPortDataListener and SerialPortPacketListener for more information.
listener - A SerialPortDataListener or SerialPortPacketListenerimplementation to be used for event-based serial port communications.SerialPortDataListener,
+SerialPortPacketListenerpublic final void removeDataListener()+
SerialPortDataListener from the serial port interface.public final InputStream getInputStream()+
InputStream object associated with this serial port.
+ + Allows for easier read access of the underlying data stream and abstracts away many low-level read details. +
+ Make sure to call the InputStream.close() method when you are done using this stream.
InputStream object associated with this serial port.InputStreampublic final OutputStream getOutputStream()+
OutputStream object associated with this serial port.
+ + Allows for easier write access to the underlying data stream and abstracts away many low-level writing details. +
+ Make sure to call the OutputStream.close() method when you are done using this stream.
OutputStream object associated with this serial port.OutputStreampublic final void setComPortParameters(int newBaudRate, + int newDataBits, + int newStopBits, + int newParity)+
+ Allows the user to set all port parameters with a single function call. +
+ The baud rate can be any arbitrary value specified by the user. The default value is 9600 baud. The data bits parameter + specifies how many data bits to use per word. The default is 8, but any values from 5 to 8 are acceptable. +
+ The default number of stop bits is 1, but 2 bits can also be used or even 1.5 on Windows machines. Please use the built-in
+ constants for this parameter (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS).
+
+ The parity parameter specifies how error detection is carried out. Again, the built-in constants should be used.
+ Acceptable values are NO_PARITY, EVEN_PARITY, ODD_PARITY, MARK_PARITY, and SPACE_PARITY.
newBaudRate - The desired baud rate for this serial port.newDataBits - The number of data bits to use per word.newStopBits - The number of stop bits to use.newParity - The type of parity error-checking desired.ONE_STOP_BIT,
+ONE_POINT_FIVE_STOP_BITS,
+TWO_STOP_BITS,
+NO_PARITY,
+EVEN_PARITY,
+ODD_PARITY,
+MARK_PARITY,
+SPACE_PARITYpublic final void setComPortTimeouts(int newTimeoutMode, + int newReadTimeout, + int newWriteTimeout)+
+ The built-in timeout mode constants should be used (TIMEOUT_NONBLOCKING, TIMEOUT_READ_SEMI_BLOCKING,
+ TIMEOUT_WRITE_SEMI_BLOCKING, TIMEOUT_READ_BLOCKING, TIMEOUT_WRITE_BLOCKING) to specify how
+ timeouts are to be handled.
+
+ Valid modes are: +
+ Non-blocking: TIMEOUT_NONBLOCKING
+ Read Semi-blocking: TIMEOUT_READ_SEMI_BLOCKING
+ Read/Write Semi-blocking: TIMEOUT_READ_SEMI_BLOCKING | TIMEOUT_WRITE_SEMI_BLOCKING
+ Read Semi-Blocking/Write Full-blocking: TIMEOUT_READ_SEMI_BLOCKING | TIMEOUT_WRITE_BLOCKING
+ Read Full-blocking: TIMEOUT_READ_BLOCKING
+ Read Full-blocking/Write Semi-blocking: TIMEOUT_READ_BLOCKING | TIMEOUT_WRITE_SEMI_BLOCKING
+ Read/Write Full-blocking: TIMEOUT_READ_BLOCKING | TIMEOUT_WRITE_BLOCKING
+
+ The TIMEOUT_NONBLOCKING mode specifies that the corresponding readBytes(byte[],long) or writeBytes(byte[],long) call
+ will return immediately with any available data.
+
+ The TIMEOUT_READ_SEMI_BLOCKING or TIMEOUT_WRITE_SEMI_BLOCKING modes specify that the corresponding calls will block until either
+ newReadTimeout or newWriteTimeout milliseconds of inactivity have elapsed or at least 1 byte of data can be written or read.
+
+ The TIMEOUT_READ_BLOCKING or TIMEOUT_WRITE_BLOCKING modes specify that the corresponding call will block until either
+ newReadTimeout or newWriteTimeout milliseconds have elapsed since the start of the call or the total number of requested bytes can be written or
+ returned.
+
+ A value of 0 for either newReadTimeout or newWriteTimeout indicates that a readBytes(byte[],long) or
+ writeBytes(byte[],long) call should block forever until it can return successfully (based upon the current timeout mode specified).
newTimeoutMode - The new timeout mode as specified above.newReadTimeout - The number of milliseconds of inactivity to tolerate before returning from a readBytes(byte[],long) call.newWriteTimeout - The number of milliseconds of inactivity to tolerate before returning from a writeBytes(byte[],long) call.public final void setBaudRate(int newBaudRate)+
+ The default baud rate is 9600 baud.
newBaudRate - The desired baud rate for this serial port.public final void setNumDataBits(int newDataBits)+
+ The default number of data bits per word is 8.
newDataBits - The desired number of data bits per word.public final void setNumStopBits(int newStopBits)+
+ The default number of stop bits per word is 2. Built-in stop-bit constants should be used
+ in this method (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS).
+
+ Note that ONE_POINT_FIVE_STOP_BITS stop bits may not be available on non-Windows systems.
newStopBits - The desired number of stop bits per word.ONE_STOP_BIT,
+ONE_POINT_FIVE_STOP_BITS,
+TWO_STOP_BITSpublic final void setFlowControl(int newFlowControlSettings)+
+ By default, no flow control is enabled. Built-in flow control constants should be used
+ in this method (FLOW_CONTROL_RTS_ENABLED, FLOW_CONTROL_CTS_ENABLED, FLOW_CONTROL_DTR_ENABLED,
+ FLOW_CONTROL_DSR_ENABLED, FLOW_CONTROL_XONXOFF_IN_ENABLED, FLOW_CONTROL_XONXOFF_OUT_ENABLED), and can be OR'ed together.
+
+ Valid flow control configurations are: +
+ None: FLOW_CONTROL_DISABLED
+ CTS: FLOW_CONTROL_CTS_ENABLED
+ RTS/CTS: FLOW_CONTROL_RTS_ENABLED | FLOW_CONTROL_CTS_ENABLED
+ DSR: FLOW_CONTROL_DSR_ENABLED
+ DTR/DSR: FLOW_CONTROL_DTR_ENABLED | FLOW_CONTROL_DSR_ENABLED
+ XOn/XOff: FLOW_CONTROL_XONXOFF_IN_ENABLED | FLOW_CONTROL_XONXOFF_OUT_ENABLED
+
+ Note that only one valid flow control configuration can be used at any time. For example, attempting to use both XOn/XOff + and RTS/CTS will most likely result in an unusable serial port.
newFlowControlSettings - The desired type of flow control to enable for this serial port.FLOW_CONTROL_DISABLED,
+FLOW_CONTROL_RTS_ENABLED,
+FLOW_CONTROL_CTS_ENABLED,
+FLOW_CONTROL_DTR_ENABLED,
+FLOW_CONTROL_DSR_ENABLED,
+FLOW_CONTROL_XONXOFF_IN_ENABLED,
+FLOW_CONTROL_XONXOFF_OUT_ENABLEDpublic final void setParity(int newParity)+
+ The parity parameter specifies how error detection is carried out. The built-in parity constants should be used.
+ Acceptable values are NO_PARITY, EVEN_PARITY, ODD_PARITY, MARK_PARITY, and SPACE_PARITY.
newParity - The desired parity scheme to be used.NO_PARITY,
+EVEN_PARITY,
+ODD_PARITY,
+MARK_PARITY,
+SPACE_PARITYpublic final String getDescriptivePortName()+
+ This description is generated by the operating system and may or may not be a good representation of the actual port or + device it describes.
public final String getSystemPortName()+
public final int getBaudRate()+
public final int getNumDataBits()+
public final int getNumStopBits()+
+ The return value should not be interpreted as an integer, but rather compared with the built-in stop bit constants
+ (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS).
ONE_STOP_BIT,
+ONE_POINT_FIVE_STOP_BITS,
+TWO_STOP_BITSpublic final int getParity()+
+ The return value should not be interpreted as an integer, but rather compared with the built-in parity constants
+ (NO_PARITY, EVEN_PARITY, ODD_PARITY, MARK_PARITY, and SPACE_PARITY).
NO_PARITY,
+EVEN_PARITY,
+ODD_PARITY,
+MARK_PARITY,
+SPACE_PARITYpublic final int getReadTimeout()+
readBytes(byte[],long) call.
+
+ A value of 0 indicates that a readBytes(byte[],long) call will block forever until it has successfully read
+ the indicated number of bytes from the serial port.
+
+ Any value other than 0 indicates the number of milliseconds of inactivity that will be tolerated before the readBytes(byte[],long)
+ call will return.
readBytes(byte[],long) call.public final int getWriteTimeout()+
writeBytes(byte[],long) call.
+
+ A value of 0 indicates that a writeBytes(byte[],long) call will block forever until it has successfully written
+ the indicated number of bytes to the serial port.
+
+ Any value other than 0 indicates the number of milliseconds of inactivity that will be tolerated before the writeBytes(byte[],long)
+ call will return.
writeBytes(byte[],long) call.public final int getFlowControlSettings()+
+ The integer result should be masked with the built-in flow control constants to test if the desired setting is enabled. + Valid flow control configurations are: +
+ None: FLOW_CONTROL_DISABLED
+ CTS: FLOW_CONTROL_CTS_ENABLED
+ RTS/CTS: FLOW_CONTROL_RTS_ENABLED | FLOW_CONTROL_CTS_ENABLED
+ DSR: FLOW_CONTROL_DSR_ENABLED
+ DTR/DSR: FLOW_CONTROL_DTR_ENABLED | FLOW_CONTROL_DSR_ENABLED
+ XOn/XOff: FLOW_CONTROL_XONXOFF_IN_ENABLED | FLOW_CONTROL_XONXOFF_OUT_ENABLED
FLOW_CONTROL_DISABLED,
+FLOW_CONTROL_RTS_ENABLED,
+FLOW_CONTROL_CTS_ENABLED,
+FLOW_CONTROL_DTR_ENABLED,
+FLOW_CONTROL_DSR_ENABLED,
+FLOW_CONTROL_XONXOFF_IN_ENABLED,
+FLOW_CONTROL_XONXOFF_OUT_ENABLEDpublic interface SerialPortDataListener +extends EventListener+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getListeningEvents() |
+
void |
+serialEvent(SerialPortEvent event) |
+
int getListeningEvents()+
void serialEvent(SerialPortEvent event)+
public final class SerialPortEvent +extends EventObject+
source| Constructor and Description | +
|---|
SerialPortEvent(Object source,
+ int serialEventType) |
+
SerialPortEvent(Object source,
+ int serialEventType,
+ byte[] data) |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getEventType() |
+
byte[] |
+getReceivedData() |
+
getSource, toStringpublic interface SerialPortPacketListener +extends SerialPortDataListener+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getPacketSize() |
+
getListeningEvents, serialEvent| Interface | +Description | +
|---|---|
| SerialPortDataListener | ++ |
| SerialPortPacketListener | ++ |
| Class | +Description | +
|---|---|
| SerialPort | +
+ This class provides native access to serial ports and devices without requiring external libraries or tools.
+ |
+
| SerialPortEvent | ++ |
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+EVEN_PARITY |
+2 |
+
+
+public static final int |
+FLOW_CONTROL_CTS_ENABLED |
+16 |
+
+
+public static final int |
+FLOW_CONTROL_DISABLED |
+0 |
+
+
+public static final int |
+FLOW_CONTROL_DSR_ENABLED |
+256 |
+
+
+public static final int |
+FLOW_CONTROL_DTR_ENABLED |
+4096 |
+
+
+public static final int |
+FLOW_CONTROL_RTS_ENABLED |
+1 |
+
+
+public static final int |
+FLOW_CONTROL_XONXOFF_IN_ENABLED |
+65536 |
+
+
+public static final int |
+FLOW_CONTROL_XONXOFF_OUT_ENABLED |
+1048576 |
+
+
+public static final int |
+LISTENING_EVENT_DATA_AVAILABLE |
+1 |
+
+
+public static final int |
+LISTENING_EVENT_DATA_RECEIVED |
+16 |
+
+
+public static final int |
+LISTENING_EVENT_DATA_WRITTEN |
+256 |
+
+
+public static final int |
+MARK_PARITY |
+3 |
+
+
+public static final int |
+NO_PARITY |
+0 |
+
+
+public static final int |
+ODD_PARITY |
+1 |
+
+
+public static final int |
+ONE_POINT_FIVE_STOP_BITS |
+2 |
+
+
+public static final int |
+ONE_STOP_BIT |
+1 |
+
+
+public static final int |
+SPACE_PARITY |
+4 |
+
+
+public static final int |
+TIMEOUT_NONBLOCKING |
+0 |
+
+
+public static final int |
+TIMEOUT_READ_BLOCKING |
+256 |
+
+
+public static final int |
+TIMEOUT_READ_SEMI_BLOCKING |
+1 |
+
+
+public static final int |
+TIMEOUT_WRITE_BLOCKING |
+4096 |
+
+
+public static final int |
+TIMEOUT_WRITE_SEMI_BLOCKING |
+16 |
+
+
+public static final int |
+TWO_STOP_BITS |
+3 |
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+SerialPortDataListener to the serial port interface.SerialPort.readBytes(byte[], long) were to be called immediately
+ after this method returns.InputStream object associated with this serial port.OutputStream object associated with this serial port.SerialPort.readBytes(byte[],long) call.SerialPort.writeBytes(byte[],long) call.SerialPortDataListener from the serial port interface.int eventType+
byte[] serialData+