Index

A B C D E F G H I M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AUTO - Enum constant in enum class org.refcodes.serial.alt.tty.Handshake

The underlying system's implementation or other implementation specific handshaking is used.

AUTO - Enum constant in enum class org.refcodes.serial.alt.tty.Parity

The underlying system's implementation or other implementation specific parity is used.

AUTO - Enum constant in enum class org.refcodes.serial.alt.tty.StopBits

The underlying system's implementation or other implementation specific stop bit settings are used.

available() - Method in class org.refcodes.serial.alt.tty.TtyPort

B

baudRate - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

BaudRate - Enum Class in org.refcodes.serial.alt.tty

Defines some commonly used bits/second rates (BPS !

BPS_1000000_FTDI - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_110 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_115200 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_1200 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_1200000_FTDI - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_128000 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_14400 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_150 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_1500000_FTDI - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_1800 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_19200 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_2000000_FTDI - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_2400 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_256000 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_300 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_3000000_FTDI - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_38400 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_4800 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_56000 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_57600 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_600 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_7200 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_75 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_9600 - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

BPS_960000_FTDI - Enum constant in enum class org.refcodes.serial.alt.tty.BaudRate

build() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

Builds the according TtyPortMetrics from this TtyPortMetrics.Builder.

builder() - Static method in class org.refcodes.serial.alt.tty.TtyPortMetrics

Creates builder to build TtyPortMetrics.

C

close() - Method in class org.refcodes.serial.alt.tty.TtyPort

close() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

D

dataBits - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

DEFAULT_DATA_BITS - Static variable in class org.refcodes.serial.alt.tty.TtyPortMetrics

DEFAULT_PARITY - Static variable in class org.refcodes.serial.alt.tty.TtyPort

DEFAULT_STOP_BITS - Static variable in class org.refcodes.serial.alt.tty.TtyPort

DTR - Enum constant in enum class org.refcodes.serial.alt.tty.Handshake

"Hardware handshaking is done with extra signals, often the RS-232 RTS/CTS or DTR/DSR signal circuits."

E

EVEN - Enum constant in enum class org.refcodes.serial.alt.tty.Parity

"Even (E) means that parity bit is set so that the number of "logical ones" must be even."

F

flush() - Method in class org.refcodes.serial.alt.tty.TtyPort

G

getAlias() - Method in class org.refcodes.serial.alt.tty.TtyPort

Returns the unambiguous technical name of the TTY-/COM-Port.

getBaudRate() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The baud rate of the port.

getBitsPerSecond() - Method in enum class org.refcodes.serial.alt.tty.BaudRate

Retrieves the bits per second.

getDataBits() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The number of data bits used by the port.

getDescription() - Method in class org.refcodes.serial.alt.tty.TtyPort

getFlowControlType() - Method in enum class org.refcodes.serial.alt.tty.Handshake

Retrieves the FlowControlType.

getHandshake() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The kind of Handshake used by the port.

getInputStream() - Method in class org.refcodes.serial.alt.tty.TtyPort

getInputStream(long) - Method in class org.refcodes.serial.alt.tty.TtyPort

getInstance() - Static method in class org.refcodes.serial.alt.tty.TtyPortHubSingleton

Returns the singleton's instance as fabricated by this TtyPortHubSingleton.

getName() - Method in class org.refcodes.serial.alt.tty.TtyPort

Returns the a more (not necessarily technical or unambiguous) name of the TTY-/COM-Port.

getOutputStream() - Method in class org.refcodes.serial.alt.tty.TtyPort

getParity() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The Parity of the port.

getPortMetrics() - Method in class org.refcodes.serial.alt.tty.TtyPort

getReadBufferSize() - Method in class org.refcodes.serial.alt.tty.TtyPort

Determines the size of the read buffer for this TtyPort.

getReadTimeoutMillis() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The read timeout in milliseconds.

getReceiverPort() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

getStopBits() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The number of stop bits used by the port.

getTransmitterPort() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

getWriteBufferSize() - Method in class org.refcodes.serial.alt.tty.TtyPort

Determines the size of the write buffer for this TtyPort.

getWriteTimeoutMillis() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

The write timeout in milliseconds.

H

handshake - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

Handshake - Enum Class in org.refcodes.serial.alt.tty

The Handshake as of "https://en.wikipedia.org/wiki/Serial_port#Flow_control"

hasPorts() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

I

isHardwareFlowControl() - Method in enum class org.refcodes.serial.alt.tty.Handshake

Determines whether the Handshake represents a hardware flow control.

isOpenable() - Method in class org.refcodes.serial.alt.tty.TtyPort

isOpened() - Method in class org.refcodes.serial.alt.tty.TtyPort

isSoftwareFlowControl() - Method in enum class org.refcodes.serial.alt.tty.Handshake

Determines whether the Handshake represents a software flow control.

M

MARK - Enum constant in enum class org.refcodes.serial.alt.tty.Parity

"Mark (M) parity means that the parity bit is always set to the mark signal condition (logical 1)."

N

NONE - Enum constant in enum class org.refcodes.serial.alt.tty.Handshake

"If no handshaking is employed, an overrun receiver might simply fail to receive data from the transmitter."

NONE - Enum constant in enum class org.refcodes.serial.alt.tty.Parity

"None (N) means that no parity bit is sent at all."

O

ODD - Enum constant in enum class org.refcodes.serial.alt.tty.Parity

"Odd (O) means that parity bit is set so that the number of "logical ones" must be odd."

ONE - Enum constant in enum class org.refcodes.serial.alt.tty.StopBits

One stop bit is used.

ONE_POINT_FIVE - Enum constant in enum class org.refcodes.serial.alt.tty.StopBits

One and a half stop bits are used.

open() - Method in class org.refcodes.serial.alt.tty.TtyPort

open() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

open(int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(int, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(int, int, StopBits, Parity) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(int, int, StopBits, Parity, Handshake) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(int, int, StopBits, Parity, Handshake, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(BaudRate) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(BaudRate, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(BaudRate, int, StopBits, Parity) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(BaudRate, int, StopBits, Parity, Handshake) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(BaudRate, int, StopBits, Parity, Handshake, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Opens the TtyPort instance.

open(TtyPortMetrics) - Method in class org.refcodes.serial.alt.tty.TtyPort

org.refcodes.serial.alt.tty - module org.refcodes.serial.alt.tty

org.refcodes.serial.alt.tty - package org.refcodes.serial.alt.tty

This artifact extends the refcodes-serial artifact with serial (TTY, COM) port access for Linux X64 (PC, Workstation, Laptop) and ARM (Raspberry Pi and Android) platforms as well for Windows machines by integrating with jSerialComm.

P

parity - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

Parity - Enum Class in org.refcodes.serial.alt.tty

The Parity as of "https://en.wikipedia.org/wiki/Serial_port#Parity"

ports() - Method in class org.refcodes.serial.alt.tty.TtyPortHub

R

readTimeoutInMs - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

receiveBytes(byte[], int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

RTS - Enum constant in enum class org.refcodes.serial.alt.tty.Handshake

"Hardware handshaking is done with extra signals, often the RS-232 RTS/CTS or DTR/DSR signal circuits."

S

SOFTWARE - Enum constant in enum class org.refcodes.serial.alt.tty.Handshake

"Software handshaking is done for example with ASCII control characters XON/XOFF to control the flow of data."

SPACE - Enum constant in enum class org.refcodes.serial.alt.tty.Parity

"Space (S) parity always sends the parity bit in the space signal condition (logical 0)."

stopBits - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

StopBits - Enum Class in org.refcodes.serial.alt.tty

Defines the number of valid TTY stop bits.

T

toPort(String, TtyPortMetrics) - Method in class org.refcodes.serial.alt.tty.TtyPortHub

toString() - Method in class org.refcodes.serial.alt.tty.TtyPort

toString() - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics

transmitSequence(Sequence) - Method in class org.refcodes.serial.alt.tty.TtyPort

TtyPort - Class in org.refcodes.serial.alt.tty

A TtyPort is a Port implementation harnessing the serial (COM) port.

TtyPort(String, TtyPortMetrics, String, String, SerialPort) - Constructor for class org.refcodes.serial.alt.tty.TtyPort

Constructs a Port with the given properties.

TtyPort(String, TtyPortMetrics, String, String, SerialPort, ExecutorService) - Constructor for class org.refcodes.serial.alt.tty.TtyPort

Constructs a Port with the given properties and the given ExecutorService to be used by asynchronous functionality.

TtyPortHub - Class in org.refcodes.serial.alt.tty

The TtyPortHub implements the PortHub for TTY-/COM-Port hardware.

TtyPortHub() - Constructor for class org.refcodes.serial.alt.tty.TtyPortHub

Creates a TtyPortHub.

TtyPortHub(ExecutorService) - Constructor for class org.refcodes.serial.alt.tty.TtyPortHub

Creates a TtyPortHub with the given ExecutorService to be used by asynchronous functionality.

TtyPortHubSingleton - Class in org.refcodes.serial.alt.tty

The singleton of the TtyPortHub for system wide COM port management.

TtyPortHubSingleton() - Constructor for class org.refcodes.serial.alt.tty.TtyPortHubSingleton

Instantiates a new port manager singleton.

TtyPortMetrics - Class in org.refcodes.serial.alt.tty

The TtyPortMetrics describe a COM or TTY serial Port on your computer.

TtyPortMetrics() - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(int) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(int, int, StopBits, Parity) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(int, int, StopBits, Parity, Handshake) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(int, int, StopBits, Parity, Handshake, long, long) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(int, long, long) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(long, long) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(BaudRate) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(BaudRate, int, StopBits, Parity) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(BaudRate, int, StopBits, Parity, Handshake) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(BaudRate, int, StopBits, Parity, Handshake, long, long) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics(BaudRate, long, long) - Constructor for class org.refcodes.serial.alt.tty.TtyPortMetrics

Constructs the PortMetrics instance.

TtyPortMetrics.Builder - Class in org.refcodes.serial.alt.tty

Builder to build TtyPortMetrics instances.

TtyPortTestBench - Class in org.refcodes.serial.alt.tty

The TtyPortTestBench implements the PortTestBench for the LoopbackPort type.

TtyPortTestBench() - Constructor for class org.refcodes.serial.alt.tty.TtyPortTestBench

Constructs the according TtyPortTestBench instance.

TtyPortTestBench(String...) - Constructor for class org.refcodes.serial.alt.tty.TtyPortTestBench

Constructs the according TtyPortTestBench instance.

TtyPortTestBench(TtyPortMetrics) - Constructor for class org.refcodes.serial.alt.tty.TtyPortTestBench

Constructs the according TtyPortTestBench instance.

TtyPortTestBench(TtyPortMetrics, String...) - Constructor for class org.refcodes.serial.alt.tty.TtyPortTestBench

Constructs the according TtyPortTestBench instance.

TWO - Enum constant in enum class org.refcodes.serial.alt.tty.StopBits

Two stop bits are used.

V

valueOf(String) - Static method in enum class org.refcodes.serial.alt.tty.BaudRate

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.refcodes.serial.alt.tty.Handshake

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.refcodes.serial.alt.tty.Parity

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.refcodes.serial.alt.tty.StopBits

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.refcodes.serial.alt.tty.BaudRate

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.refcodes.serial.alt.tty.Handshake

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.refcodes.serial.alt.tty.Parity

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.refcodes.serial.alt.tty.StopBits

Returns an array containing the constants of this enum class, in the order they are declared.

W

waitForPortCatchUp() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

waitForPortCatchUp(long) - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

waitLongestForPortCatchUp() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

waitLongForPortCatchUp() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

waitShortestForPortCatchUp() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

waitShortForPortCatchUp() - Method in class org.refcodes.serial.alt.tty.TtyPortTestBench

withBaudRate(int) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

The baud rate of the port.

withBaudRate(BaudRate) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

The baud rate of the port.

withDataBits(int) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

The number of data bits used by the port.

withHandshake(Handshake) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

The kind of Handshake used by the port.

withOpen() - Method in class org.refcodes.serial.alt.tty.TtyPort

withOpen(int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(int, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(int, int, StopBits, Parity) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(int, int, StopBits, Parity, Handshake) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(int, int, StopBits, Parity, Handshake, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(BaudRate) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(BaudRate, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(BaudRate, int, StopBits, Parity) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(BaudRate, int, StopBits, Parity, Handshake) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(BaudRate, int, StopBits, Parity, Handshake, int, int) - Method in class org.refcodes.serial.alt.tty.TtyPort

Builder method for opening a TtyPort instance.

withOpen(TtyPortMetrics) - Method in class org.refcodes.serial.alt.tty.TtyPort

withOpenUnchecked() - Method in class org.refcodes.serial.alt.tty.TtyPort

withOpenUnchecked(TtyPortMetrics) - Method in class org.refcodes.serial.alt.tty.TtyPort

withParity(Parity) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

The Parity of the port.

withReadTimeoutMillis(long) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

withStopBits(StopBits) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

The number of stop bits used by the port.

withWriteTimeoutMillis(long) - Method in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

writeTimeoutInMs - Variable in class org.refcodes.serial.alt.tty.TtyPortMetrics.Builder

A B C D E F G H I M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values