A B C D E F G I J M O P R S T W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addEventListener(SerialPortEventListener) - Method in class jssc.SerialPort
-
Add event listener.
- addEventListener(SerialPortEventListener, int) - Method in class jssc.SerialPort
-
Add event listener.
B
- BAUDRATE_110 - Static variable in class jssc.SerialPort
-
Baud rate 110 symbols/second
- BAUDRATE_115200 - Static variable in class jssc.SerialPort
-
Baud rate 115200 symbols/second
- BAUDRATE_1200 - Static variable in class jssc.SerialPort
-
Baud rate 1200 symbols/second
- BAUDRATE_128000 - Static variable in class jssc.SerialPort
-
Baud rate 128000 symbols/second
- BAUDRATE_14400 - Static variable in class jssc.SerialPort
-
Baud rate 14400 symbols/second
- BAUDRATE_19200 - Static variable in class jssc.SerialPort
-
Baud rate 19200 symbols/second
- BAUDRATE_2400 - Static variable in class jssc.SerialPort
-
Baud rate 2400 symbols/second
- BAUDRATE_256000 - Static variable in class jssc.SerialPort
-
Baud rate 256000 symbols/second
- BAUDRATE_300 - Static variable in class jssc.SerialPort
-
Baud rate 300 symbols/second
- BAUDRATE_38400 - Static variable in class jssc.SerialPort
-
Baud rate 38400 symbols/second
- BAUDRATE_4800 - Static variable in class jssc.SerialPort
-
Baud rate 4800 symbols/second
- BAUDRATE_57600 - Static variable in class jssc.SerialPort
-
Baud rate 57600 symbols/second
- BAUDRATE_600 - Static variable in class jssc.SerialPort
-
Baud rate 600 symbols/second
- BAUDRATE_9600 - Static variable in class jssc.SerialPort
-
Baud rate 9600 symbols/second
- BREAK - Static variable in class jssc.SerialPortEvent
-
Deprecated.
C
- closePort() - Method in class jssc.SerialPort
-
Close port.
- closePort(long) - Method in class jssc.SerialNativeInterface
-
Close port
- CTS - Static variable in class jssc.SerialPortEvent
-
Deprecated.
D
- DATABITS_5 - Static variable in class jssc.SerialPort
-
Five (5) data bits per byte
- DATABITS_6 - Static variable in class jssc.SerialPort
-
Six (6) data bits per byte
- DATABITS_7 - Static variable in class jssc.SerialPort
-
Seven (7) data bits per byte
- DATABITS_8 - Static variable in class jssc.SerialPort
-
Eight (8) data bits per byte
- DefaultJniExtractorStub - Class in jssc
- DefaultJniExtractorStub(Class<?>) - Constructor for class jssc.DefaultJniExtractorStub
-
Default constructor
- DefaultJniExtractorStub(Class<?>, String) - Constructor for class jssc.DefaultJniExtractorStub
-
Force native-lib-loader to first look in the location defined as
bootPathprior to extracting a native library, useful for sandboxed environments. - DSR - Static variable in class jssc.SerialPortEvent
-
Deprecated.
E
- ERR - Static variable in class jssc.SerialPortEvent
-
Deprecated.
- ERR_INCORRECT_SERIAL_PORT - Static variable in class jssc.SerialNativeInterface
-
Serial port handle is incorrect
- ERR_PERMISSION_DENIED - Static variable in class jssc.SerialNativeInterface
-
Insufficient permissions to access port
- ERR_PORT_BUSY - Static variable in class jssc.SerialNativeInterface
-
Port is busy
- ERR_PORT_NOT_FOUND - Static variable in class jssc.SerialNativeInterface
-
Port is not found
- ERROR_FRAME - Static variable in class jssc.SerialPort
-
Indicates faulty data or frame
- ERROR_OVERRUN - Static variable in class jssc.SerialPort
-
Overrun error; receiver hardware unable to handle receive data
- ERROR_PARITY - Static variable in class jssc.SerialPort
-
Parity/check bit error
- extractJni(String, String) - Method in class jssc.DefaultJniExtractorStub
-
If a
bootPathwas provided to the constructor and exists, calculate theFilepath without any extraction logic. - extractRegistered() - Method in class jssc.DefaultJniExtractorStub
F
- FLOWCONTROL_NONE - Static variable in class jssc.SerialPort
-
Disable flow control
- FLOWCONTROL_RTSCTS_IN - Static variable in class jssc.SerialPort
-
Legacy hardware control: RTS/CTS (request to send/clear to send) flow control on input
- FLOWCONTROL_RTSCTS_OUT - Static variable in class jssc.SerialPort
-
Legacy hardware control: RTS/CTS (request to send/clear to send) flow control on output
- FLOWCONTROL_XONXOFF_IN - Static variable in class jssc.SerialPort
-
Software flow control: XON/XOFF flow control on input
- FLOWCONTROL_XONXOFF_OUT - Static variable in class jssc.SerialPort
-
Software flow control: XON/XOFF flow control on output
G
- getBuffersBytesCount(long) - Method in class jssc.SerialNativeInterface
-
Get bytes count in buffers of port
- getEventsMask() - Method in class jssc.SerialPort
-
Getting events mask for the port
- getEventsMask(long) - Method in class jssc.SerialNativeInterface
-
Get events mask
- getEventType() - Method in class jssc.SerialPortEvent
-
Getting event type
- getEventValue() - Method in class jssc.SerialPortEvent
-
Getting event value
Event values depending on their types:
RXCHAR - bytes count in input buffer
RXFLAG - bytes count in input buffer (Not supported in Linux)
TXEMPTY - bytes count in output buffer
CTS - state of CTS line (0 - OFF, 1 - ON)
DSR - state of DSR line (0 - OFF, 1 - ON)
RLSD - state of RLSD line (0 - OFF, 1 - ON)
BREAK - 0
RING - state of RING line (0 - OFF, 1 - ON)
ERR - mask of errors - getExceptionType() - Method in exception jssc.SerialPortException
-
Getting exception type
- getFlowControlMode() - Method in class jssc.SerialPort
-
Get flow control mode
- getFlowControlMode(long) - Method in class jssc.SerialNativeInterface
-
Get flow control mode
- getInputBufferBytesCount() - Method in class jssc.SerialPort
-
Get count of bytes in input buffer
- getLibraryVersion() - Static method in class jssc.SerialNativeInterface
-
Get library version
- getLinesStatus() - Method in class jssc.SerialPort
-
Getting lines status.
- getLinesStatus(long) - Method in class jssc.SerialNativeInterface
-
Getting lines states
- getMethodName() - Method in exception jssc.SerialPortException
-
Gets the method name during execution of which the exception was called
- getMethodName() - Method in exception jssc.SerialPortTimeoutException
-
Gets the method name during execution of which the exception was called
- getNativeLibraryVersion() - Static method in class jssc.SerialNativeInterface
-
Get native library version
- getOsType() - Static method in class jssc.SerialNativeInterface
-
Get OS type
- getOutputBufferBytesCount() - Method in class jssc.SerialPort
-
Get count of bytes in output buffer
- getPort() - Method in class jssc.SerialPortEvent
-
Getting the port that set off this event
- getPort() - Method in exception jssc.SerialPortException
-
Gets the
SerialPortwhich threw the exception - getPort() - Method in exception jssc.SerialPortTimeoutException
-
Gets the
SerialPortwhich threw the exception - getPortName() - Method in class jssc.SerialPort
-
Getting port name under operation
- getPortName() - Method in class jssc.SerialPortEvent
-
Deprecated.
- getPortName() - Method in exception jssc.SerialPortException
-
Deprecated.
- getPortName() - Method in exception jssc.SerialPortTimeoutException
-
Deprecated.
- getPortNames() - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system using default settings:
Search path
Windows - ""(always ignored)
Linux - "/dev/"
Solaris - "/dev/term/"
MacOSX - "/dev/"
RegExp
Windows - ""
Linux - "(ttyS|ttyUSB|ttyACM|ttyAMA|rfcomm)[0-9]{1,3}"
Solaris - "[0-9]*|[a-z]*"
MacOSX - "tty.(serial|usbserial|usbmodem).*" - getPortNames(String) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system located on searchPath
- getPortNames(String, Comparator<String>) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system located on searchPath and sorted by comparator
- getPortNames(String, Pattern) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system located on searchPath, matched pattern
- getPortNames(String, Pattern, Comparator<String>) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system located on searchPath, matched pattern and sorted by comparator
- getPortNames(Comparator<String>) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system matched pattern
- getPortNames(Pattern) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system matched pattern
- getPortNames(Pattern, Comparator<String>) - Static method in class jssc.SerialPortList
-
Get sorted array of serial ports in the system matched pattern and sorted by comparator
- getSerialPortNames() - Method in class jssc.SerialNativeInterface
-
Get serial port names like an array of String
- getTimeoutValue() - Method in exception jssc.SerialPortTimeoutException
-
Gets timeout value of which the exception was called
I
- isBREAK() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_BREAK - isCTS() - Method in class jssc.SerialPort
-
Get state of CTS line
- isCTS() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_CTS - isDSR() - Method in class jssc.SerialPort
-
Get state of DSR line
- isDSR() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_DSR - isERR() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_ERR - isOpened() - Method in class jssc.SerialPort
-
Getting port state
- isRING() - Method in class jssc.SerialPort
-
Get state of RING line
- isRING() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_RING - isRLSD() - Method in class jssc.SerialPort
-
Get state of RLSD line
- isRLSD() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_RLSD - isRXCHAR() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_RXCHAR - isRXFLAG() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_RXFLAG - isTXEMPTY() - Method in class jssc.SerialPortEvent
-
Convenience method to check if
getEventType()isSerialPort.MASK_TXEMPTY
J
- jssc - package jssc
M
- MASK_BREAK - Static variable in class jssc.SerialPort
-
Break (reset a communications line or change the operating mode) flag
- MASK_CTS - Static variable in class jssc.SerialPort
-
CTS (clear to send) mask
- MASK_DSR - Static variable in class jssc.SerialPort
-
DSR (data set to ready) flag
- MASK_ERR - Static variable in class jssc.SerialPort
-
Error flag
- MASK_RING - Static variable in class jssc.SerialPort
-
State of RING line (0 - OFF, 1 - ON)
- MASK_RLSD - Static variable in class jssc.SerialPort
-
RLSD (Receive Line Signal Detected) flag
- MASK_RXCHAR - Static variable in class jssc.SerialPort
-
Receive character flag
- MASK_RXFLAG - Static variable in class jssc.SerialPort
-
Receive flag
- MASK_TXEMPTY - Static variable in class jssc.SerialPort
-
Receive empty flag
O
- openPort() - Method in class jssc.SerialPort
-
Port opening
Note: If port busy TYPE_PORT_BUSY exception will be thrown. - openPort(String, boolean) - Method in class jssc.SerialNativeInterface
-
Open port
- OS_LINUX - Static variable in class jssc.SerialNativeInterface
-
Linux
- OS_MAC_OS_X - Static variable in class jssc.SerialNativeInterface
-
MacOS
- OS_SOLARIS - Static variable in class jssc.SerialNativeInterface
-
Solaris
- OS_UNKNOWN - Static variable in class jssc.SerialNativeInterface
-
Unknown
- OS_WINDOWS - Static variable in class jssc.SerialNativeInterface
-
Windows
P
- PARITY_EVEN - Static variable in class jssc.SerialPort
-
Use a very basic checksum: Send an additional bit to report if even number of data bits
- PARITY_MARK - Static variable in class jssc.SerialPort
-
Use a very basic checksum: Send a parity bit to indicate "mark signal" condition (rarely used)
- PARITY_NONE - Static variable in class jssc.SerialPort
-
Do not send a parity bit
- PARITY_ODD - Static variable in class jssc.SerialPort
-
Use a very basic checksum: Send an additional bit to report if odd number of data bits
- PARITY_SPACE - Static variable in class jssc.SerialPort
-
Use a very basic checksum: Send a parity bit to indicate "space signal" condition (rarely used)
- PROPERTY_JSSC_IGNPAR - Static variable in class jssc.SerialNativeInterface
-
Ignore bytes with framing error or parity error Usage:
System.setProperty("jssc_ignpar", "true"); - PROPERTY_JSSC_NO_TIOCEXCL - Static variable in class jssc.SerialNativeInterface
-
Disable exclusive lock for serial port Usage:
System.setProperty("jssc_no_tiocexcl", "true"); - PROPERTY_JSSC_PARMRK - Static variable in class jssc.SerialNativeInterface
-
Mark bytes with parity error or framing error Usage:
System.setProperty("jssc_iparmrk", "true"); - PURGE_RXABORT - Static variable in class jssc.SerialPort
-
Receive "abort" status code
- PURGE_RXCLEAR - Static variable in class jssc.SerialPort
-
Receive "clear" status code
- PURGE_TXABORT - Static variable in class jssc.SerialPort
-
Transfer "abort" status code
- PURGE_TXCLEAR - Static variable in class jssc.SerialPort
-
Transfer "clear" status code
- purgePort(int) - Method in class jssc.SerialPort
-
Purge of input and output buffer.
- purgePort(long, int) - Method in class jssc.SerialNativeInterface
-
Purge of input and output buffer
R
- readBytes() - Method in class jssc.SerialPort
-
Read all available bytes from port like a byte array
- readBytes(int) - Method in class jssc.SerialPort
-
Read byte array from port
- readBytes(int, int) - Method in class jssc.SerialPort
-
Read byte array from port
- readBytes(long, int) - Method in class jssc.SerialNativeInterface
-
Read data from port
- readHexString() - Method in class jssc.SerialPort
-
Read all available bytes from port like a Hex String
- readHexString(int) - Method in class jssc.SerialPort
-
Read Hex string from port (example: FF 0A FF).
- readHexString(int, int) - Method in class jssc.SerialPort
-
Read Hex string from port (example: FF 0A FF).
- readHexString(int, String) - Method in class jssc.SerialPort
-
Read Hex string from port with set separator (example if separator is "::": FF::0A::FF)
- readHexString(int, String, int) - Method in class jssc.SerialPort
-
Read Hex string from port with set separator (example if separator is "::": FF::0A::FF)
- readHexString(String) - Method in class jssc.SerialPort
-
Read all available bytes from port like a Hex String with set separator
- readHexStringArray() - Method in class jssc.SerialPort
-
Read all available bytes from port like a Hex String array
- readHexStringArray(int) - Method in class jssc.SerialPort
-
Read Hex String array from port
- readHexStringArray(int, int) - Method in class jssc.SerialPort
-
Read Hex String array from port
- readIntArray() - Method in class jssc.SerialPort
-
Read all available bytes from port like a int array (values in range from 0 to 255)
- readIntArray(int) - Method in class jssc.SerialPort
-
Read int array from port
- readIntArray(int, int) - Method in class jssc.SerialPort
-
Read int array from port
- readString() - Method in class jssc.SerialPort
-
Read all available bytes from port like a String
- readString(int) - Method in class jssc.SerialPort
-
Read string from port
- readString(int, int) - Method in class jssc.SerialPort
-
Read string from port
- removeEventListener() - Method in class jssc.SerialPort
-
Delete event listener.
- RING - Static variable in class jssc.SerialPortEvent
-
Deprecated.
- RLSD - Static variable in class jssc.SerialPortEvent
-
Deprecated.
- RXCHAR - Static variable in class jssc.SerialPortEvent
-
Deprecated.
- RXFLAG - Static variable in class jssc.SerialPortEvent
-
Deprecated.
S
- sendBreak(int) - Method in class jssc.SerialPort
-
Send Break singnal for set duration
- sendBreak(long, int) - Method in class jssc.SerialNativeInterface
-
Send Break signal for set duration
- serialEvent(SerialPortEvent) - Method in interface jssc.SerialPortEventListener
-
Called when an event fires
- SerialNativeInterface - Class in jssc
- SerialNativeInterface() - Constructor for class jssc.SerialNativeInterface
-
Default constructor TODO: This class is effectively static, why instantiate it?
- SerialPort - Class in jssc
- SerialPort(String) - Constructor for class jssc.SerialPort
-
Construct a serial port object with the specified
portName - SerialPortEvent - Class in jssc
- SerialPortEvent(String, int, int) - Constructor for class jssc.SerialPortEvent
-
Deprecated.
- SerialPortEvent(SerialPort, int, int) - Constructor for class jssc.SerialPortEvent
-
Constructs a SerialPortEvent representing a port, event type and event value.
- SerialPortEventListener - Interface in jssc
- SerialPortException - Exception in jssc
- SerialPortException(String, String, String) - Constructor for exception jssc.SerialPortException
-
Deprecated.
- SerialPortException(SerialPort, String, String) - Constructor for exception jssc.SerialPortException
-
Constructs a new
SerialPortException - SerialPortList - Class in jssc
- SerialPortTimeoutException - Exception in jssc
- SerialPortTimeoutException(String, String, int) - Constructor for exception jssc.SerialPortTimeoutException
-
Deprecated.
- SerialPortTimeoutException(SerialPort, String, int) - Constructor for exception jssc.SerialPortTimeoutException
-
Constructs a new
SerialPortTimeoutException - setDTR(boolean) - Method in class jssc.SerialPort
-
Change DTR line state.
- setDTR(long, boolean) - Method in class jssc.SerialNativeInterface
-
Change DTR line state
- setEventsMask(int) - Method in class jssc.SerialPort
-
Set events mask.
- setEventsMask(long, int) - Method in class jssc.SerialNativeInterface
-
Set events mask
- setFlowControlMode(int) - Method in class jssc.SerialPort
-
Set flow control mode.
- setFlowControlMode(long, int) - Method in class jssc.SerialNativeInterface
-
Set flow control mode
- setParams(int, int, int, int) - Method in class jssc.SerialPort
-
Setting the parameters of port.
- setParams(int, int, int, int, boolean, boolean) - Method in class jssc.SerialPort
-
Setting the parameters of port
- setParams(long, int, int, int, int, boolean, boolean, int) - Method in class jssc.SerialNativeInterface
-
Setting the parameters of opened port
- setRTS(boolean) - Method in class jssc.SerialPort
-
Change RTS line state.
- setRTS(long, boolean) - Method in class jssc.SerialNativeInterface
-
Change RTS line state
- STOPBITS_1 - Static variable in class jssc.SerialPort
-
One (1) stop bits per byte
- STOPBITS_1_5 - Static variable in class jssc.SerialPort
-
One and a half (1.5) stop bits per byte
- STOPBITS_2 - Static variable in class jssc.SerialPort
-
Two (2) stop bits per byte
T
- TXEMPTY - Static variable in class jssc.SerialPortEvent
-
Deprecated.
- TYPE_CANT_REMOVE_LISTENER - Static variable in exception jssc.SerialPortException
-
Can't remove event listener
- TYPE_CANT_SET_MASK - Static variable in exception jssc.SerialPortException
-
Can't set mask
- TYPE_INCORRECT_SERIAL_PORT - Static variable in exception jssc.SerialPortException
- TYPE_LISTENER_ALREADY_ADDED - Static variable in exception jssc.SerialPortException
-
Event listener already added
- TYPE_LISTENER_THREAD_INTERRUPTED - Static variable in exception jssc.SerialPortException
-
Event listener thread interrupted
- TYPE_NATIVE_EXCEPTION - Static variable in exception jssc.SerialPortException
-
Exception occurred in native code
- TYPE_NULL_NOT_PERMITTED - Static variable in exception jssc.SerialPortException
- TYPE_PARAMETER_IS_NOT_CORRECT - Static variable in exception jssc.SerialPortException
- TYPE_PERMISSION_DENIED - Static variable in exception jssc.SerialPortException
- TYPE_PORT_ALREADY_OPENED - Static variable in exception jssc.SerialPortException
-
Port already opened
- TYPE_PORT_BUSY - Static variable in exception jssc.SerialPortException
- TYPE_PORT_NOT_FOUND - Static variable in exception jssc.SerialPortException
- TYPE_PORT_NOT_OPENED - Static variable in exception jssc.SerialPortException
-
Port not opened
W
- waitEvents(long) - Method in class jssc.SerialNativeInterface
-
Wait events
- wrapNativeException(Exception, SerialPort, String) - Static method in exception jssc.SerialPortException
- writeByte(byte) - Method in class jssc.SerialPort
-
Write single byte to port
- writeBytes(byte[]) - Method in class jssc.SerialPort
-
Write byte array to port
- writeBytes(long, byte[]) - Method in class jssc.SerialNativeInterface
-
Write data to port
- writeInt(int) - Method in class jssc.SerialPort
-
Write int value (in range from 0 to 255 (0x00 - 0xFF)) to port
- writeIntArray(int[]) - Method in class jssc.SerialPort
-
Write int array (in range from 0 to 255 (0x00 - 0xFF)) to port
- writeString(String) - Method in class jssc.SerialPort
-
Write String to port
- writeString(String, String) - Method in class jssc.SerialPort
-
Write String to port
All Classes All Packages