SerialParameters (nifty-modbus-api 1.0.0 API)

All Known Implementing Classes:

BasicSerialParameters
```
public interface SerialParameters
```
Serial configuration parameters.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BAUD_RATE` A default baud rate.
`static int`	`DEFAULT_DATA_BITS` The default databits value.
`static SerialParity`	`DEFAULT_PARITY` The default parity value.
`static int`	`DEFAULT_READ_TIMEOUT` The default read timeout.
`static int`	`DEFAULT_RS485_AFTER_SEND_DELAY` The default RS-485 RTS before send delay.
`static int`	`DEFAULT_RS485_BEFORE_SEND_DELAY` The default RS-485 RTS before send delay.
`static boolean`	`DEFAULT_RS485_RTS_HIGH_ENABLED` The default RS-485 RTS high enabled value.
`static SerialStopBits`	`DEFAULT_STOP_BITS` The default stopbits value.
`static String`	`RS485_AFTER_SEND_DELAY_FLAG` The RS-485 after send delay flag.
`static String`	`RS485_BEFORE_SEND_DELAY_FLAG` The RS-485 before send delay flag.
`static String`	`RS485_ECHO_FLAG` The RS-485 echo flag.
`static String`	`RS485_RTS_HIGH_FLAG` The RS-485 RTS high flag.
`static String`	`RS485_TERMINATION_FLAG` The RS-485 termination flag.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default String`	`bitsShortcut()` Get a "shortcut" bits value in the form DPS for data bits, parity, and stop bits.
`default int`	`getBaudRate()` Get the baud rate.
`default int`	`getDataBits()` Get the data bits.
`default Set<SerialFlowControl>`	`getFlowControl()` Get the flow control.
`default SerialParity`	`getParity()` Get the parity.
`default int`	`getReadTimeout()` Get the read timeout.
`default int`	`getRs485AfterSendDelay()` Get a time to wait after sending data before disabling transmit mode when in RS-485 mode.
`default int`	`getRs485BeforeSendDelay()` Get a time to wait after enabling transmit mode before sending data when in RS-485 mode.
`default Boolean`	`getRs485ModeEnabled()` Get the RS-485 mode.
`default SerialStopBits`	`getStopBits()` Get the stop bits.
`default int`	`getWaitTime()` Get the wait time.
`default boolean`	`isRs485EchoEnabled()` Get the RS-485 "echo" mode.
`default boolean`	`isRs485RtsHighEnabled()` Get the RS-485 RTS "high" mode.
`default boolean`	`isRs485TerminationEnabled()` Get the RS-485 termination mode.
`default String`	`rs485Flags()` Get a comma-delimited list of the enabled RS-485 settings, using the `RS485_*_FLAG` constants.

- Field Detail
  - DEFAULT_BAUD_RATE
```
static final int DEFAULT_BAUD_RATE
```
    A default baud rate.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STOP_BITS
```
static final SerialStopBits DEFAULT_STOP_BITS
```
    The default stopbits value.
  - DEFAULT_DATA_BITS
```
static final int DEFAULT_DATA_BITS
```
    The default databits value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PARITY
```
static final SerialParity DEFAULT_PARITY
```
    The default parity value.
  - DEFAULT_READ_TIMEOUT
```
static final int DEFAULT_READ_TIMEOUT
```
    The default read timeout.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RS485_RTS_HIGH_ENABLED
```
static final boolean DEFAULT_RS485_RTS_HIGH_ENABLED
```
    The default RS-485 RTS high enabled value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RS485_BEFORE_SEND_DELAY
```
static final int DEFAULT_RS485_BEFORE_SEND_DELAY
```
    The default RS-485 RTS before send delay.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RS485_AFTER_SEND_DELAY
```
static final int DEFAULT_RS485_AFTER_SEND_DELAY
```
    The default RS-485 RTS before send delay.
    
    See Also:
    
    Constant Field Values
  - RS485_RTS_HIGH_FLAG
```
static final String RS485_RTS_HIGH_FLAG
```
    The RS-485 RTS high flag.
    
    See Also:
    
    Constant Field Values
  - RS485_TERMINATION_FLAG
```
static final String RS485_TERMINATION_FLAG
```
    The RS-485 termination flag.
    
    See Also:
    
    Constant Field Values
  - RS485_ECHO_FLAG
```
static final String RS485_ECHO_FLAG
```
    The RS-485 echo flag.
    
    See Also:
    
    Constant Field Values
  - RS485_BEFORE_SEND_DELAY_FLAG
```
static final String RS485_BEFORE_SEND_DELAY_FLAG
```
    The RS-485 before send delay flag.
    
    See Also:
    
    Constant Field Values
  - RS485_AFTER_SEND_DELAY_FLAG
```
static final String RS485_AFTER_SEND_DELAY_FLAG
```
    The RS-485 after send delay flag.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getBaudRate
```
default int getBaudRate()
```
    Get the baud rate.
    
    Returns:
    
    the baud rate; defaults to DEFAULT_BAUD_RATE
  - getDataBits
```
default int getDataBits()
```
    Get the data bits.
    
    Returns:
    
    the data bits; defaults to DEFAULT_DATA_BITS
  - getStopBits
```
default SerialStopBits getStopBits()
```
    Get the stop bits.
    
    Returns:
    
    the stop bits; defaults to DEFAULT_STOP_BITS
  - getParity
```
default SerialParity getParity()
```
    Get the parity.
    
    Returns:
    
    the parity; defaults to DEFAULT_PARITY
  - getFlowControl
```
default Set<SerialFlowControl> getFlowControl()
```
    Get the flow control.
    
    Returns:
    
    the flow control set, or null for no flow control
  - getWaitTime
```
default int getWaitTime()
```
    Get the wait time.
    
    Returns:
    
    the amount of time to wait between opening the serial port and configuring its settings, in milliseconds; defaults to 0
  - getReadTimeout
```
default int getReadTimeout()
```
    Get the read timeout.
    
    Returns:
    
    the maximum amount of time to wait for data, in milliseconds; defaults to DEFAULT_READ_TIMEOUT
  - bitsShortcut
```
default String bitsShortcut()
```
    Get a "shortcut" bits value in the form DPS for data bits, parity, and stop bits.
    
    Returns:
    
    the shortcut
  - getRs485ModeEnabled
```
default Boolean getRs485ModeEnabled()
```
    Get the RS-485 mode.
    When this is set to true then the other getRs485* settings are used. This is only needed for some RS-485 hardware, and the other getRs485* settings may not be supported across all platforms.
    
    Returns:
    
    true to enable RS-485 mode
  - isRs485RtsHighEnabled
```
default boolean isRs485RtsHighEnabled()
```
    Get the RS-485 RTS "high" mode.
    This setting is only applicable when getRs485ModeEnabled() is true.
    
    Returns:
    
    true to set the RTS line high (to 1) when transmitting; defaults to DEFAULT_RS485_RTS_HIGH_ENABLED
  - isRs485TerminationEnabled
```
default boolean isRs485TerminationEnabled()
```
    Get the RS-485 termination mode.
    This setting is only applicable when getRs485ModeEnabled() is true.
    
    Returns:
    
    true to enable RS-485 bus termination; defaults to false
  - isRs485EchoEnabled
```
default boolean isRs485EchoEnabled()
```
    Get the RS-485 "echo" mode.
    This setting is only applicable when getRs485ModeEnabled() is true.
    
    Returns:
    
    true to enable receive during transmit; defaults to false
  - getRs485BeforeSendDelay
```
default int getRs485BeforeSendDelay()
```
    Get a time to wait after enabling transmit mode before sending data when in RS-485 mode.
    This setting is only applicable when getRs485ModeEnabled() is true.
    
    Returns:
    
    the delay, in microseconds; defaults to DEFAULT_RS485_BEFORE_SEND_DELAY
  - getRs485AfterSendDelay
```
default int getRs485AfterSendDelay()
```
    Get a time to wait after sending data before disabling transmit mode when in RS-485 mode.
    This setting is only applicable when getRs485ModeEnabled() is true.
    
    Returns:
    
    the delay, in microseconds; defaults to DEFAULT_RS485_AFTER_SEND_DELAY
  - rs485Flags
```
default String rs485Flags()
```
    Get a comma-delimited list of the enabled RS-485 settings, using the RS485_*_FLAG constants.
    
    Returns:
    
    the delimited list, or null if no settings are enabled

Interface SerialParameters

Field Summary

Method Summary

Field Detail

DEFAULT_BAUD_RATE

DEFAULT_STOP_BITS

DEFAULT_DATA_BITS

DEFAULT_PARITY

DEFAULT_READ_TIMEOUT

DEFAULT_RS485_RTS_HIGH_ENABLED

DEFAULT_RS485_BEFORE_SEND_DELAY

DEFAULT_RS485_AFTER_SEND_DELAY

RS485_RTS_HIGH_FLAG

RS485_TERMINATION_FLAG

RS485_ECHO_FLAG

RS485_BEFORE_SEND_DELAY_FLAG

RS485_AFTER_SEND_DELAY_FLAG

Method Detail

getBaudRate

getDataBits

getStopBits

getParity

getFlowControl

getWaitTime

getReadTimeout

bitsShortcut

getRs485ModeEnabled

isRs485RtsHighEnabled

isRs485TerminationEnabled

isRs485EchoEnabled

getRs485BeforeSendDelay

getRs485AfterSendDelay

rs485Flags