SerialParameters (j2mod 3.3.0 API)

java.lang.Object
- com.ghgande.j2mod.modbus.util.SerialParameters

```
public class SerialParameters
extends Object
```
Helper class wrapping all serial port communication parameters. Very similar to the javax.comm demos, however, not the same.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, John Charlton, Steve O'Hara (4NG)

Constructor Summary

Constructors
Constructor and Description
`SerialParameters()` Constructs a new `SerialParameters` instance with default values.
`SerialParameters(Properties props, String prefix)` Constructs a new `SerialParameters` instance with parameters obtained from a `Properties` instance.
`SerialParameters(String portName, int baudRate, int flowControlIn, int flowControlOut, int databits, int stopbits, int parity, boolean echo)` Constructs a new `SerialParameters` instance with given parameters for a regular serial interface.
`SerialParameters(String portName, int baudRate, int flowControlIn, int flowControlOut, int databits, int stopbits, int parity, boolean echo, boolean rs485Mode, boolean rs485TxEnableActiveHigh, int rs485DelayBeforeTxMicroseconds, int rs485DelayAfterTxMicroseconds)` Constructs a new `SerialParameters` instance with given parameters for a serial interface in RS-485 mode on Linux.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disableRs485Control()` Disables RS-485 control signals management.
`int`	`getBaudRate()` Return the baud rate as `int`.
`String`	`getBaudRateString()` Returns the baud rate as a `String`.
`int`	`getDatabits()` Returns the number of data bits as `int`.
`String`	`getDatabitsString()` Returns the number of data bits as `String`.
`String`	`getEncoding()` Returns the encoding to be used.
`int`	`getFlowControlIn()` Returns the input flow control type as `int`.
`String`	`getFlowControlInString()` Returns the input flow control type as `String`.
`int`	`getFlowControlOut()` Returns the output flow control type as `int`.
`String`	`getFlowControlOutString()` Returns the output flow control type as `String`.
`int`	`getOpenDelay()` Gets the open delay used to prevent some OS from losing the comms port
`int`	`getParity()` Returns the parity schema as `int`.
`String`	`getParityString()` Returns the parity schema as `String`.
`String`	`getPortName()` Returns the port name.
`int`	`getRs485DelayAfterTxMicroseconds()` Returns the delay between the end of transmitting data and deactivating the RS-485 transmitter.
`int`	`getRs485DelayBeforeTxMicroseconds()` Returns the delay between activating the RS-485 transmitter and actually sending data.
`boolean`	`getRs485EnableTermination()` Returns whether the RS-485 interface shall enable internal bus termination.
`boolean`	`getRs485Mode()` Returns whether RS-485 half-duplex mode is enabled.
`boolean`	`getRs485RxDuringTx()` Returns whether the RS-485 interface receives data it sends.
`boolean`	`getRs485TxEnableActiveHigh()` Returns whether the RS-485 transmitter is enabled by a high or low control signal.
`int`	`getStopbits()` Returns the number of stop bits as `int`.
`String`	`getStopbitsString()` Returns the number of stop bits as `String`.
`boolean`	`isEcho()` Get the Echo value.
`boolean`	`isRs485ControlDisabled()` Returns whether RS-485 control signals management is disabled.
`void`	`setBaudRate(int rate)` Sets the baud rate.
`void`	`setBaudRate(String rate)` Sets the baud rate.
`void`	`setDatabits(int databits)` Sets the number of data bits.
`void`	`setDatabits(String databits)` Sets the number of data bits from the given `String`.
`void`	`setEcho(boolean newEcho)` Set the Echo value.
`void`	`setEncoding(String enc)` Sets the encoding to be used.
`void`	`setFlowControlIn(int flowControl)` Sets the type of flow control for the input as given by the passed in `int`.
`void`	`setFlowControlIn(String flowControl)` Sets the type of flow control for the input as given by the passed in `String`.
`void`	`setFlowControlOut(int flowControlOut)` Sets the output flow control type as given by the passed in `int`.
`void`	`setFlowControlOut(String flowControlOut)` Sets the output flow control type as given by the passed in `String`.
`void`	`setOpenDelay(int openDelay)` Sets the sleep time tat occurs just prior to opening a coms port Some OS don't like to have their comms ports opened/closed in very quick succession particularly, virtual ports.
`void`	`setOpenDelay(String openDelay)` Sets the sleep time tat occurs just prior to opening a coms port Some OS don't like to have their comms ports opened/closed in very quick succession particularly, virtual ports.
`void`	`setParity(int parity)` Sets the parity schema.
`void`	`setParity(String parity)` Sets the parity schema from the given `String`.
`void`	`setPortName(String name)` Sets the port name.
`void`	`setRs485DelayAfterTxMicroseconds(int microseconds)` Sets the delay between the end of transmitting data and deactivating the RS-485 transmitter.
`void`	`setRs485DelayAfterTxMicroseconds(String microseconds)` Sets the delay between end of transmitting data and deactivating the RS-458 transmitter.
`void`	`setRs485DelayBeforeTxMicroseconds(int microseconds)` Sets the delay between activating the RS-485 transmitter and actually sending data.
`void`	`setRs485DelayBeforeTxMicroseconds(String microseconds)` Sets the delay between activating the RS-485 transmitter and actually sending data.
`void`	`setRs485EnableTermination(boolean enable)` Sets whether the RS-485 interface shall enable internal bus termination.
`void`	`setRs485Mode(boolean enable)` Sets whether to configure the serial interface into RS-485 half-duplex mode.
`void`	`setRs485RxDuringTx(boolean enable)` Sets whether the RS-485 interface receives the data its sends.
`void`	`setRs485TxEnableActiveHigh(boolean activeHigh)` Sets whether the RS-485 transmitter is enabled by a high or low control signal.
`void`	`setStopbits(int stopbits)` Sets the number of stop bits.
`void`	`setStopbits(String stopbits)` Sets the number of stop bits from the given `String`.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SerialParameters
```
public SerialParameters()
```
    Constructs a new SerialParameters instance with default values.
  - SerialParameters
```
public SerialParameters(String portName,
                        int baudRate,
                        int flowControlIn,
                        int flowControlOut,
                        int databits,
                        int stopbits,
                        int parity,
                        boolean echo)
```
    Constructs a new SerialParameters instance with given parameters for a regular serial interface.
    
    Parameters:
    
    portName - The name of the port.
    
    baudRate - The baud rate.
    
    flowControlIn - Type of flow control for receiving.
    
    flowControlOut - Type of flow control for sending.
    
    databits - The number of data bits.
    
    stopbits - The number of stop bits. com.fazecast.jSerialComm.SerialPort stop-bit constants should be used in this method (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS)
    
    parity - The type of parity.
    
    echo - Flag for setting the RS485 echo mode.
  - SerialParameters
```
public SerialParameters(String portName,
                        int baudRate,
                        int flowControlIn,
                        int flowControlOut,
                        int databits,
                        int stopbits,
                        int parity,
                        boolean echo,
                        boolean rs485Mode,
                        boolean rs485TxEnableActiveHigh,
                        int rs485DelayBeforeTxMicroseconds,
                        int rs485DelayAfterTxMicroseconds)
```
    Constructs a new SerialParameters instance with given parameters for a serial interface in RS-485 mode on Linux.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    There are interfaces operating in RS-485 mode by default and don't require explicitly configuring this mode.
    
    Parameters:
    
    portName - The name of the port.
    
    baudRate - The baud rate.
    
    flowControlIn - Type of flow control for receiving.
    
    flowControlOut - Type of flow control for sending.
    
    databits - The number of data bits.
    
    stopbits - The number of stop bits. com.fazecast.jSerialComm.SerialPort stop-bit constants should be used in this method (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS)
    
    parity - The type of parity.
    
    echo - Flag for setting the RS485 echo mode.
    
    rs485Mode - Whether to enable RS-485 mode (transmitter control)
    
    rs485TxEnableActiveHigh - Whether the RS-485 transmitter is enabled when the by a high or low logic level
    
    rs485DelayBeforeTxMicroseconds - The length of the delay between enabling the transmitter and the actual start of sending data
    
    rs485DelayAfterTxMicroseconds - The length of the delay between the end of a data transmission and disabling the transmitter again
  - SerialParameters
```
public SerialParameters(Properties props,
                        String prefix)
```
    Constructs a new SerialParameters instance with parameters obtained from a Properties instance.
    
    Parameters:
    
    props - a Properties instance.
    
    prefix - a prefix for the properties keys if embedded into other properties.
- Method Detail
  - getPortName
```
public String getPortName()
```
    Returns the port name.
    
    Returns:
    
    the port name.
  - setPortName
```
public void setPortName(String name)
```
    Sets the port name.
    
    Parameters:
    
    name - the new port name.
  - setBaudRate
```
public void setBaudRate(int rate)
```
    Sets the baud rate.
    
    Parameters:
    
    rate - the new baud rate.
  - getBaudRate
```
public int getBaudRate()
```
    Return the baud rate as int.
    
    Returns:
    
    the baud rate as int.
  - setBaudRate
```
public void setBaudRate(String rate)
```
    Sets the baud rate.
    
    Parameters:
    
    rate - the new baud rate.
  - getBaudRateString
```
public String getBaudRateString()
```
    Returns the baud rate as a String.
    
    Returns:
    
    the baud rate as String.
  - setFlowControlIn
```
public void setFlowControlIn(int flowControl)
```
    Sets the type of flow control for the input as given by the passed in int.
    
    Parameters:
    
    flowControl - the new flow control type.
    
    Throws:
    
    IllegalArgumentException - on invalid flowControl
  - getFlowControlIn
```
public int getFlowControlIn()
```
    Returns the input flow control type as int.
    
    Returns:
    
    the input flow control type as int.
  - setFlowControlIn
```
public void setFlowControlIn(String flowControl)
```
    Sets the type of flow control for the input as given by the passed in String.
    
    Parameters:
    
    flowControl - the flow control for reading type.
    
    Throws:
    
    IllegalArgumentException - on invalid flowControl
  - getFlowControlInString
```
public String getFlowControlInString()
```
    Returns the input flow control type as String.
    
    Returns:
    
    the input flow control type as String.
  - setFlowControlOut
```
public void setFlowControlOut(int flowControlOut)
```
    Sets the output flow control type as given by the passed in int.
    
    Parameters:
    
    flowControlOut - new output flow control type as int.
  - getFlowControlOut
```
public int getFlowControlOut()
```
    Returns the output flow control type as int.
    
    Returns:
    
    the output flow control type as int.
  - setFlowControlOut
```
public void setFlowControlOut(String flowControlOut)
```
    Sets the output flow control type as given by the passed in String.
    
    Parameters:
    
    flowControlOut - the new output flow control type as String.
  - getFlowControlOutString
```
public String getFlowControlOutString()
```
    Returns the output flow control type as String.
    
    Returns:
    
    the output flow control type as String.
  - setDatabits
```
public void setDatabits(int databits)
```
    Sets the number of data bits.
    
    Parameters:
    
    databits - the new number of data bits.
  - getDatabits
```
public int getDatabits()
```
    Returns the number of data bits as int.
    
    Returns:
    
    the number of data bits as int.
  - setDatabits
```
public void setDatabits(String databits)
```
    Sets the number of data bits from the given String.
    
    Parameters:
    
    databits - the new number of data bits as String.
  - getDatabitsString
```
public String getDatabitsString()
```
    Returns the number of data bits as String.
    
    Returns:
    
    the number of data bits as String.
  - setStopbits
```
public void setStopbits(int stopbits)
```
    Sets the number of stop bits. com.fazecast.jSerialComm.SerialPort stop-bit constants should be used in this method (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS)
    
    Parameters:
    
    stopbits - the new number of stop bits setting.
  - getStopbits
```
public int getStopbits()
```
    Returns the number of stop bits as int. com.fazecast.jSerialComm.SerialPort stop-bit constants are used in this method (ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS)
    
    Returns:
    
    the number of stop bits as int.
  - setStopbits
```
public void setStopbits(String stopbits)
```
    Sets the number of stop bits from the given String.
    
    Parameters:
    
    stopbits - the number of stop bits as String.
  - getStopbitsString
```
public String getStopbitsString()
```
    Returns the number of stop bits as String.
    
    Returns:
    
    the number of stop bits as String.
  - setParity
```
public void setParity(int parity)
```
    Sets the parity schema.
    
    Parameters:
    
    parity - the new parity schema as int.
  - getParity
```
public int getParity()
```
    Returns the parity schema as int.
    
    Returns:
    
    the parity schema as int.
  - setParity
```
public void setParity(String parity)
```
    Sets the parity schema from the given String.
    
    Parameters:
    
    parity - the new parity schema as String.
    
    Throws:
    
    IllegalArgumentException - on invalid parity
  - getParityString
```
public String getParityString()
```
    Returns the parity schema as String.
    
    Returns:
    
    the parity schema as String.
  - getEncoding
```
public String getEncoding()
```
    Returns the encoding to be used.
    
    Returns:
    
    the encoding as string.
    
    See Also:
    
    Modbus.SERIAL_ENCODING_ASCII, Modbus.SERIAL_ENCODING_RTU
  - setEncoding
```
public void setEncoding(String enc)
```
    Sets the encoding to be used.
    
    Parameters:
    
    enc - the encoding as string.
    
    Throws:
    
    IllegalArgumentException - on invalid parity
    
    See Also:
    
    Modbus.SERIAL_ENCODING_ASCII, Modbus.SERIAL_ENCODING_RTU
  - isEcho
```
public boolean isEcho()
```
    Get the Echo value.
    
    Returns:
    
    the Echo value.
  - setEcho
```
public void setEcho(boolean newEcho)
```
    Set the Echo value.
    
    Parameters:
    
    newEcho - The new Echo value.
  - getOpenDelay
```
public int getOpenDelay()
```
    Gets the open delay used to prevent some OS from losing the comms port
    
    Returns:
    
    Sleep before an open is attempted on a comms port
  - setOpenDelay
```
public void setOpenDelay(int openDelay)
```
    Sets the sleep time tat occurs just prior to opening a coms port Some OS don't like to have their comms ports opened/closed in very quick succession particularly, virtual ports. This delay is a rather crude way of stopping the problem that a comms port doesn't re-appear immediately after a close
    
    Parameters:
    
    openDelay - Sleep time in millieseconds
  - setOpenDelay
```
public void setOpenDelay(String openDelay)
```
    Sets the sleep time tat occurs just prior to opening a coms port Some OS don't like to have their comms ports opened/closed in very quick succession particularly, virtual ports. This delay is a rather crude way of stopping the problem that a comms port doesn't re-appear immediately after a close
    
    Parameters:
    
    openDelay - Sleep time in millieseconds
  - getRs485Mode
```
public boolean getRs485Mode()
```
    Returns whether RS-485 half-duplex mode is enabled.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Returns:
    
    Whether RS-485 mode is enabled
  - setRs485Mode
```
public void setRs485Mode(boolean enable)
```
    Sets whether to configure the serial interface into RS-485 half-duplex mode.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Parameters:
    
    enable - Whether to enable RS-485 half-duplex mode
  - getRs485TxEnableActiveHigh
```
public boolean getRs485TxEnableActiveHigh()
```
    Returns whether the RS-485 transmitter is enabled by a high or low control signal.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Returns:
    
    Wether the RS-485 transmitter is enabled by a high control signal level. Otherwise it returns false.
  - setRs485TxEnableActiveHigh
```
public void setRs485TxEnableActiveHigh(boolean activeHigh)
```
    Sets whether the RS-485 transmitter is enabled by a high or low control signal.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Parameters:
    
    activeHigh - If true, the transmitter is activated by a high control signal level. Otherwise, it is activated by a low level.
  - getRs485EnableTermination
```
public boolean getRs485EnableTermination()
```
    Returns whether the RS-485 interface shall enable internal bus termination.
    This configuration option is only available under Linux and only if device driver and hardware support it.
    
    Returns:
    
    Whether the serial interface shall enable internal bus termination.
  - setRs485EnableTermination
```
public void setRs485EnableTermination(boolean enable)
```
    Sets whether the RS-485 interface shall enable internal bus termination.
    This configuration option is only available under Linux and only if device driver and hardware support it.
    
    Parameters:
    
    enable - If true, the serial interface shall enable its internal bus termination.
  - getRs485RxDuringTx
```
public boolean getRs485RxDuringTx()
```
    Returns whether the RS-485 interface receives data it sends.
    This configuration option is only available under Linux and only if device driver and hardware support it.
    See setRs485RxDuringTx(boolean) for more details.
    
    Returns:
    
    Whether the serial interface shall receive the data it transmits too.
  - setRs485RxDuringTx
```
public void setRs485RxDuringTx(boolean enable)
```
    Sets whether the RS-485 interface receives the data its sends.
    This configuration option is only available under Linux and only if device driver and hardware support it.
    BEWARE: For normal operation, j2mod expects this feature do be disable. This method is provided only for fixing the behaviour with certain device drivers which require this feature to be enabled for normal operation.
    
    Parameters:
    
    enable - If true, the serial interface is expected to receive the data it transmits itself too.
  - getRs485DelayBeforeTxMicroseconds
```
public int getRs485DelayBeforeTxMicroseconds()
```
    Returns the delay between activating the RS-485 transmitter and actually sending data. There are devices in the field requiring such a delay for start bit detection.
    Please note that the actual interface might not support a resolution down to microseconds and might require appropriately large values for actually generating a delay.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Returns:
    
    The configured delay in microseconds
  - setRs485DelayBeforeTxMicroseconds
```
public void setRs485DelayBeforeTxMicroseconds(int microseconds)
```
    Sets the delay between activating the RS-485 transmitter and actually sending data. There are devices in the field requiring such a delay for start bit detection.
    Please note that the actual interface might not support a resolution down to microseconds and might require appropriately large values for actually generating a delay.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Parameters:
    
    microseconds - The delay in microseconds
    
    Throws:
    
    IllegalArgumentException - on strictly negative input
  - setRs485DelayBeforeTxMicroseconds
```
public void setRs485DelayBeforeTxMicroseconds(String microseconds)
```
    Sets the delay between activating the RS-485 transmitter and actually sending data. There are devices in the field requiring such a delay for start bit detection.
    This is a convenience wrapper around setRs485DelayBeforeTxMicroseconds(int) which parses the delay from the supplied string. See the documentation of this method for more details.
    
    Parameters:
    
    microseconds - The string to parse the delay value from
  - getRs485DelayAfterTxMicroseconds
```
public int getRs485DelayAfterTxMicroseconds()
```
    Returns the delay between the end of transmitting data and deactivating the RS-485 transmitter.
    Please note that the actual interface might not support a resolution down to microseconds and might require appropriately large values for actually generating a delay.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Returns:
    
    The configured delay in microseconds
  - setRs485DelayAfterTxMicroseconds
```
public void setRs485DelayAfterTxMicroseconds(int microseconds)
```
    Sets the delay between the end of transmitting data and deactivating the RS-485 transmitter.
    Please note that the actual interface might not support a resolution down to microseconds and might require appropriately large values for actually generating a delay.
    RS-485 half-duplex mode is only available on Linux and only if the device driver supports it. Its configuration parameters have no effect on other platforms.
    
    Parameters:
    
    microseconds - The delay in microseconds
  - setRs485DelayAfterTxMicroseconds
```
public void setRs485DelayAfterTxMicroseconds(String microseconds)
```
    Sets the delay between end of transmitting data and deactivating the RS-458 transmitter.
    This is a convenience wrapper around setRs485DelayAfterTxMicroseconds(int) which parses the delay from the supplied string. See the documentation of this method for more details.
    
    Parameters:
    
    microseconds - The string to parse the delay value from
  - disableRs485Control
```
public void disableRs485Control()
```
    Disables RS-485 control signals management.
    Please note that this is only effective on Linux.
    This function forces RS-485 mode to stay untouched, regardless of the current setting of RS-485 mode.
    This function is necessary for Linux drivers that don't handle TIOCGRS485 properly.
  - isRs485ControlDisabled
```
public boolean isRs485ControlDisabled()
```
    Returns whether RS-485 control signals management is disabled.
    
    Returns:
    
    true if RS-485 control signals management is disabled.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SerialParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SerialParameters

SerialParameters

SerialParameters

SerialParameters

Method Detail

getPortName

setPortName

setBaudRate

getBaudRate

setBaudRate

getBaudRateString

setFlowControlIn

getFlowControlIn

setFlowControlIn

getFlowControlInString

setFlowControlOut

getFlowControlOut

setFlowControlOut

getFlowControlOutString

setDatabits

getDatabits

setDatabits

getDatabitsString

setStopbits

getStopbits

setStopbits

getStopbitsString

setParity

getParity

setParity

getParityString

getEncoding

setEncoding

isEcho

setEcho

getOpenDelay

setOpenDelay

setOpenDelay

getRs485Mode

setRs485Mode

getRs485TxEnableActiveHigh

setRs485TxEnableActiveHigh

getRs485EnableTermination

setRs485EnableTermination

getRs485RxDuringTx

setRs485RxDuringTx

getRs485DelayBeforeTxMicroseconds

setRs485DelayBeforeTxMicroseconds

setRs485DelayBeforeTxMicroseconds

getRs485DelayAfterTxMicroseconds

setRs485DelayAfterTxMicroseconds

setRs485DelayAfterTxMicroseconds

disableRs485Control

isRs485ControlDisabled

toString