A B C D E F G I L M N O R S T U W
All Classes All Packages

A

addDataListener(SerialPortDataListener) - Method in class com.fazecast.jSerialComm.SerialPort

Adds a SerialPortDataListener to the serial port interface.

addShutdownHook(Thread) - Static method in class com.fazecast.jSerialComm.SerialPort

Registers a shutdown hook that will run just before the application fully closes, due to either exiting normally or in response to a user interrupt such as Ctrl+C.

allowElevatedPermissionsRequest() - Method in class com.fazecast.jSerialComm.SerialPort

Allows the library to request elevation of the current user's permissions for use in making certain system-specific changes regarding this serial port.

allowPortOpenForEnumeration() - Static method in class com.fazecast.jSerialComm.SerialPort

Allows the library to open a port during enumeration to retrieve additional details about its serial number, manufacturer, and description.

AndroidPort - Class in com.fazecast.jSerialComm.android

AndroidPort(UsbDevice) - Constructor for class com.fazecast.jSerialComm.android.AndroidPort

autoCleanupAtShutdown() - Static method in class com.fazecast.jSerialComm.SerialPort

Causes the library to attempt to clean up after itself upon shutdown and automatically delete all temporary files it may have created.

B

bytesAvailable() - Method in class com.fazecast.jSerialComm.android.AndroidPort

bytesAvailable() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the number of bytes available without blocking if SerialPort.readBytes(byte[], int) were to be called immediately after this method returns.

bytesAwaitingWrite() - Method in class com.fazecast.jSerialComm.android.AndroidPort

bytesAwaitingWrite() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the number of bytes still waiting to be written in the device's output queue.

C

catchException(Exception) - Method in interface com.fazecast.jSerialComm.SerialPortDataListenerWithExceptions

Must be overridden to handle any Java exceptions that occur asynchronously in this data listener.

catchException(Exception) - Method in interface com.fazecast.jSerialComm.SerialPortMessageListenerWithExceptions

Must be overridden to handle any Java exceptions that occur asynchronously in this data listener.

clearBreak() - Method in class com.fazecast.jSerialComm.android.AndroidPort

clearBreak() - Method in class com.fazecast.jSerialComm.SerialPort

Clears the BREAK signal from the serial control line.

clearDTR() - Method in class com.fazecast.jSerialComm.android.AndroidPort

clearDTR() - Method in class com.fazecast.jSerialComm.SerialPort

De-asserts DTR by clearing the line's state to 0.

clearRTS() - Method in class com.fazecast.jSerialComm.android.AndroidPort

clearRTS() - Method in class com.fazecast.jSerialComm.SerialPort

De-asserts RTS by clearing the line's state to 0.

closePort() - Method in class com.fazecast.jSerialComm.android.AndroidPort

closePort() - Method in class com.fazecast.jSerialComm.SerialPort

Closes this serial port.

closePortNative() - Method in class com.fazecast.jSerialComm.android.AndroidPort

com.fazecast.jSerialComm - package com.fazecast.jSerialComm

This package contains all of the classes and interfaces that make up the Java serial communications library.

com.fazecast.jSerialComm.android - package com.fazecast.jSerialComm.android

configPort(SerialPort) - Method in class com.fazecast.jSerialComm.android.AndroidPort

context - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

D

delimiterIndicatesEndOfMessage() - Method in interface com.fazecast.jSerialComm.SerialPortMessageListener

Must be overridden to return whether the message delimiter indicates the end or the beginning of a message.

disableExclusiveLock() - Method in class com.fazecast.jSerialComm.SerialPort

Disables the library from obtaining an exclusive lock on the serial port.

disablePortConfiguration() - Method in class com.fazecast.jSerialComm.SerialPort

Disables the library from calling any of the underlying device driver configuration methods.

E

EVEN_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

F

FLOW_CONTROL_CTS_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_DISABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_DSR_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_DTR_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_RTS_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_XONXOFF_IN_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

FLOW_CONTROL_XONXOFF_OUT_ENABLED - Static variable in class com.fazecast.jSerialComm.SerialPort

flushDataListener() - Method in class com.fazecast.jSerialComm.SerialPort

Flushes any already-received data from the registered SerialPortDataListener that has not yet triggered an event.

flushIOBuffers() - Method in class com.fazecast.jSerialComm.SerialPort

Flushes the serial port's Rx/Tx device buffers.

flushRxTxBuffers() - Method in class com.fazecast.jSerialComm.android.AndroidPort

G

get() - Static method in class com.fazecast.jSerialComm.SerialPortThreadFactory

Returns the current ThreadFactory instance associated with this library.

getBaudRate() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current baud rate of the serial port.

getCommPort(String) - Static method in class com.fazecast.jSerialComm.SerialPort

Allocates a SerialPort object corresponding to the user-specified port descriptor.

getCommPorts() - Static method in class com.fazecast.jSerialComm.SerialPort

Returns a list of all available serial ports on this machine.

getCommPortsNative() - Static method in class com.fazecast.jSerialComm.android.AndroidPort

getCTS() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getCTS() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the CTS line is currently asserted.

getDCD() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getDCD() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the DCD line is currently asserted.

getDescriptivePortName() - Method in class com.fazecast.jSerialComm.SerialPort

Gets a descriptive string representing this serial port or the device connected to it.

getDeviceReadBufferSize() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the underlying receive buffer size used by the serial port device driver.

getDeviceWriteBufferSize() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the underlying transmit buffer size used by the serial port device driver.

getDSR() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getDSR() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the DSR line is currently asserted.

getDTR() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getDTR() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the DTR line is currently asserted.

getEventType() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns the type of serial port events that caused this object to be created.

getFlowControlSettings() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the flow control settings enabled on this serial port.

getInputStream() - Method in class com.fazecast.jSerialComm.SerialPort

Returns an InputStream object associated with this serial port.

getInputStreamWithSuppressedTimeoutExceptions() - Method in class com.fazecast.jSerialComm.SerialPort

Returns an InputStream object associated with this serial port, with read timeout exceptions completely suppressed.

getLastErrorCode() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getLastErrorCode() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the error number returned by the most recent native source code line that failed execution.

getLastErrorLocation() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getLastErrorLocation() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the source code line location of the latest error encountered during execution of the native code for this port.

getListeningEvents() - Method in interface com.fazecast.jSerialComm.SerialPortDataListener

Must be overridden to return one or more desired event constants for which the SerialPortDataListener.serialEvent(SerialPortEvent) callback should be triggered.

getManufacturer() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the Manufacturer for the serial port, assuming it is USB-based.

getMessageDelimiter() - Method in interface com.fazecast.jSerialComm.SerialPortMessageListener

Must be overridden to return the expected message delimiter bytes that must be encountered before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.

getNumDataBits() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current number of data bits per word.

getNumStopBits() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current number of stop bits per word.

getOutputStream() - Method in class com.fazecast.jSerialComm.SerialPort

Returns an OutputStream object associated with this serial port.

getPacketSize() - Method in interface com.fazecast.jSerialComm.SerialPortPacketListener

Must be overridden to return the desired number of bytes that must be read before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.

getParity() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the current parity error-checking scheme.

getPortDescription() - Method in class com.fazecast.jSerialComm.SerialPort

Gets a description of the port as reported by the device itself.

getPortLocation() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the physical location of the port as a String in the form "BUS-[HUB1.HUB2.etc]PORT_NUMBER".

getProductID() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the 16-bit Product Identification number for the serial port, assuming it is USB-based.

getReadTimeout() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.readBytes(byte[],int) call.

getReceivedData() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns any raw data bytes associated with this serial port event.

getRI() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getRI() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the RI line is currently asserted.

getRTS() - Method in class com.fazecast.jSerialComm.android.AndroidPort

getRTS() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the RTS line is currently asserted.

getSerialNumber() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the Serial Number for the serial port, assuming it is USB-based.

getSerialPort() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns the SerialPort that triggered this event.

getSystemPortName() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the operating system-defined device name corresponding to this serial port.

getSystemPortPath() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the operating system-defined device path corresponding to this serial port.

getVendorID() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the 16-bit Vendor Identification number for the serial port, assuming it is USB-based.

getVersion() - Static method in class com.fazecast.jSerialComm.SerialPort

Returns the current version of the jSerialComm library.

getWriteTimeout() - Method in class com.fazecast.jSerialComm.SerialPort

Gets the number of milliseconds of inactivity to tolerate before returning from a SerialPort.writeBytes(byte[],int) call.

I

isOpen() - Method in class com.fazecast.jSerialComm.SerialPort

Returns whether the port is currently open and available for communication.

L

LISTENING_EVENT_BREAK_INTERRUPT - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_CARRIER_DETECT - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_CTS - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_DATA_AVAILABLE - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_DATA_RECEIVED - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_DATA_WRITTEN - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_DSR - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_FRAMING_ERROR - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_PARITY_ERROR - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_PORT_DISCONNECTED - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_RING_INDICATOR - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR - Static variable in class com.fazecast.jSerialComm.SerialPort

LISTENING_EVENT_TIMED_OUT - Static variable in class com.fazecast.jSerialComm.SerialPort

M

makeVidPid(int, int) - Static method in class com.fazecast.jSerialComm.android.AndroidPort

MARK_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

N

NO_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

O

ODD_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

ONE_POINT_FIVE_STOP_BITS - Static variable in class com.fazecast.jSerialComm.SerialPort

ONE_STOP_BIT - Static variable in class com.fazecast.jSerialComm.SerialPort

openPort() - Method in class com.fazecast.jSerialComm.android.AndroidPort

openPort() - Method in class com.fazecast.jSerialComm.SerialPort

Opens this serial port for reading and writing.

openPort(int) - Method in class com.fazecast.jSerialComm.SerialPort

Opens this serial port for reading and writing with an optional delay time.

openPort(int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Opens this serial port for reading and writing with an optional delay time and user-specified device buffer size.

openPortNative(SerialPort) - Method in class com.fazecast.jSerialComm.android.AndroidPort

R

readBuffer - Variable in class com.fazecast.jSerialComm.android.AndroidPort

readBufferIndex - Variable in class com.fazecast.jSerialComm.android.AndroidPort

readBufferLength - Variable in class com.fazecast.jSerialComm.android.AndroidPort

readBufferOffset - Variable in class com.fazecast.jSerialComm.android.AndroidPort

readBytes(byte[], int) - Method in class com.fazecast.jSerialComm.SerialPort

Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer.

readBytes(byte[], int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Reads up to bytesToRead raw data bytes from the serial port and stores them in the buffer starting at the indicated offset.

readBytes(byte[], long, long, int, int) - Method in class com.fazecast.jSerialComm.android.AndroidPort

removeDataListener() - Method in class com.fazecast.jSerialComm.SerialPort

Removes the associated SerialPortDataListener from the serial port interface.

S

serialEvent(SerialPortEvent) - Method in interface com.fazecast.jSerialComm.SerialPortDataListener

Called whenever one or more of the serial port events specified by the SerialPortDataListener.getListeningEvents() method occurs.

SerialPort - Class in com.fazecast.jSerialComm

This class provides native access to serial ports and devices without requiring external libraries or tools.

SerialPortDataListener - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable simple event-based serial port I/O.

SerialPortDataListenerWithExceptions - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable simple event-based serial port I/O with a custom Exception callback.

SerialPortEvent - Class in com.fazecast.jSerialComm

This class describes an asynchronous serial port event.

SerialPortEvent(SerialPort, int) - Constructor for class com.fazecast.jSerialComm.SerialPortEvent

Constructs a SerialPortEvent object corresponding to the specified serial event type.

SerialPortEvent(SerialPort, int, byte[]) - Constructor for class com.fazecast.jSerialComm.SerialPortEvent

Constructs a SerialPortEvent object corresponding to the specified serial event type and containing the passed-in data bytes.

SerialPortInvalidPortException - Exception in com.fazecast.jSerialComm

This class describes a serial port invalid port exception.

SerialPortInvalidPortException(String, Throwable) - Constructor for exception com.fazecast.jSerialComm.SerialPortInvalidPortException

Constructs a SerialPortInvalidPortException with the specified detail message and cause.

SerialPortIOException - Exception in com.fazecast.jSerialComm

This class describes a serial port IO exception.

SerialPortIOException(String) - Constructor for exception com.fazecast.jSerialComm.SerialPortIOException

Constructs a SerialPortIOException with the specified detail message.

SerialPortMessageListener - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable delimited message reads using event-based serial port I/O.

SerialPortMessageListenerWithExceptions - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable delimited message reads using event-based serial port I/O with a custom Exception callback.

SerialPortPacketListener - Interface in com.fazecast.jSerialComm

This interface must be implemented to enable full packet reads using event-based serial port I/O.

SerialPortThreadFactory - Class in com.fazecast.jSerialComm

This class is used to create internal jSerialComm threads.

SerialPortThreadFactory() - Constructor for class com.fazecast.jSerialComm.SerialPortThreadFactory

SerialPortTimeoutException - Exception in com.fazecast.jSerialComm

This class describes a serial port timeout exception.

SerialPortTimeoutException(String) - Constructor for exception com.fazecast.jSerialComm.SerialPortTimeoutException

Constructs a SerialPortTimeoutException with the specified detail message.

set(ThreadFactory) - Static method in class com.fazecast.jSerialComm.SerialPortThreadFactory

Allows a user to define a custom thread factory to be used by this library for creating new threads.

setAndroidContext(Object) - Static method in class com.fazecast.jSerialComm.android.AndroidPort

setAndroidContext(Object) - Static method in class com.fazecast.jSerialComm.SerialPort

Registers an application context to be used by the library when running on an Android device.

setBaudRate(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired baud rate for this serial port.

setBreak() - Method in class com.fazecast.jSerialComm.android.AndroidPort

setBreak() - Method in class com.fazecast.jSerialComm.SerialPort

Sets the BREAK signal on the serial control line.

setComPortParameters(int, int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets all serial port parameters at one time.

setComPortParameters(int, int, int, int, boolean) - Method in class com.fazecast.jSerialComm.SerialPort

Sets all serial port parameters at one time.

setComPortTimeouts(int, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the serial port read and write timeout parameters.

setDTR() - Method in class com.fazecast.jSerialComm.android.AndroidPort

setDTR() - Method in class com.fazecast.jSerialComm.SerialPort

Asserts DTR by setting the line's state to 1.

setEventListeningStatus(boolean) - Method in class com.fazecast.jSerialComm.android.AndroidPort

setFlowControl(int) - Method in class com.fazecast.jSerialComm.SerialPort

Specifies what kind of flow control to enable for this serial port.

setNumDataBits(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired number of data bits per word.

setNumStopBits(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired number of stop bits per word.

setParity(int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets the desired parity error-detection scheme to be used.

setRs485ModeParameters(boolean, boolean, boolean, boolean, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets RS-485 mode and its parameters for the device.

setRs485ModeParameters(boolean, boolean, int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Sets RS-485 mode and its parameters for the device.

setRTS() - Method in class com.fazecast.jSerialComm.android.AndroidPort

setRTS() - Method in class com.fazecast.jSerialComm.SerialPort

Asserts RTS by setting the line's state to 1.

setXonXoffCharacters(byte, byte) - Method in class com.fazecast.jSerialComm.SerialPort

Sets custom XON/XOFF flow control characters for the device.

SPACE_PARITY - Static variable in class com.fazecast.jSerialComm.SerialPort

T

TIMEOUT_NONBLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_READ_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_READ_SEMI_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_SCANNER - Static variable in class com.fazecast.jSerialComm.SerialPort

TIMEOUT_WRITE_BLOCKING - Static variable in class com.fazecast.jSerialComm.SerialPort

toString() - Method in class com.fazecast.jSerialComm.SerialPort

Returns the same output as calling SerialPort.getPortDescription().

toString() - Method in class com.fazecast.jSerialComm.SerialPortEvent

Returns a string representation of the type of event represented by this object.

TWO_STOP_BITS - Static variable in class com.fazecast.jSerialComm.SerialPort

U

USB_ENDPOINT_IN - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_ENDPOINT_OUT - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_RECIPIENT_DEVICE - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_RECIPIENT_ENDPOINT - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_RECIPIENT_INTERFACE - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_RECIPIENT_OTHER - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_REQUEST_TYPE_CLASS - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_REQUEST_TYPE_RESERVED - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_REQUEST_TYPE_STANDARD - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

USB_REQUEST_TYPE_VENDOR - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

usbConnection - Variable in class com.fazecast.jSerialComm.android.AndroidPort

usbDevice - Variable in class com.fazecast.jSerialComm.android.AndroidPort

usbDeviceIn - Variable in class com.fazecast.jSerialComm.android.AndroidPort

usbDeviceOut - Variable in class com.fazecast.jSerialComm.android.AndroidPort

usbInterface - Variable in class com.fazecast.jSerialComm.android.AndroidPort

usbManager - Static variable in class com.fazecast.jSerialComm.android.AndroidPort

W

waitForEvent() - Method in class com.fazecast.jSerialComm.android.AndroidPort

writeBuffer - Variable in class com.fazecast.jSerialComm.android.AndroidPort

writeBufferIndex - Variable in class com.fazecast.jSerialComm.android.AndroidPort

writeBufferLength - Variable in class com.fazecast.jSerialComm.android.AndroidPort

writeBytes(byte[], int) - Method in class com.fazecast.jSerialComm.SerialPort

Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port.

writeBytes(byte[], int, int) - Method in class com.fazecast.jSerialComm.SerialPort

Writes up to bytesToWrite raw data bytes from the buffer parameter to the serial port starting at the indicated offset.

writeBytes(byte[], long, long, int) - Method in class com.fazecast.jSerialComm.android.AndroidPort

A B C D E F G I L M N O R S T U W
All Classes All Packages