net.solarnetwork.io.modbus.serial

Class BasicSerialParameters

java.lang.Object

net.solarnetwork.io.modbus.serial.BasicSerialParameters

All Implemented Interfaces:

SerialParameters

public class BasicSerialParameters
extends Object
implements SerialParameters

Basic implementation of SerialParameters.

Field Summary

Fields inherited from interface net.solarnetwork.io.modbus.serial.SerialParameters

DEFAULT_BAUD_RATE, DEFAULT_DATA_BITS, DEFAULT_PARITY, DEFAULT_READ_TIMEOUT, DEFAULT_RS485_AFTER_SEND_DELAY, DEFAULT_RS485_BEFORE_SEND_DELAY, DEFAULT_RS485_RTS_HIGH_ENABLED, DEFAULT_STOP_BITS, RS485_AFTER_SEND_DELAY_FLAG, RS485_BEFORE_SEND_DELAY_FLAG, RS485_ECHO_FLAG, RS485_RTS_HIGH_FLAG, RS485_TERMINATION_FLAG

Constructor Summary

Constructors

Constructor	Description
BasicSerialParameters()

Method Summary

Modifier and Type	Method	Description
int	getBaudRate()	Get the baud rate.
int	getDataBits()	Get the data bits.
Set<SerialFlowControl>	getFlowControl()	Get the flow control.
SerialParity	getParity()	Get the parity.
int	getReadTimeout()	Get the read timeout.
int	getRs485AfterSendDelay()	Get a time to wait after sending data before disabling transmit mode when in RS-485 mode.
int	getRs485BeforeSendDelay()	Get a time to wait after enabling transmit mode before sending data when in RS-485 mode.
Boolean	getRs485ModeEnabled()	Get the RS-485 mode.
SerialStopBits	getStopBits()	Get the stop bits.
int	getWaitTime()	Get the wait time.
boolean	isRs485EchoEnabled()	Get the RS-485 "echo" mode.
boolean	isRs485RtsHighEnabled()	Get the RS-485 RTS "high" mode.
boolean	isRs485TerminationEnabled()	Get the RS-485 termination mode.
void	populateRs485Flags(String flags)	Parse a comma-delimited list of RS-485 flags and configure the associated settings on this instance.
void	setBaudRate(int baudRate)	Set the baud rate.
void	setDataBits(int dataBits)	Set the data bits.
void	setFlowControl(Set<SerialFlowControl> flowControl)	Set the flow control.
void	setParity(SerialParity parity)	Set the parity.
void	setReadTimeout(int readTimeout)	Set the read timeout.
void	setRs485AfterSendDelay(int rs485AfterSendDelay)	Set a time to wait after sending data before disabling transmit mode when in RS-485 mode
void	setRs485BeforeSendDelay(int rs485BeforeSendDelay)	Set a time to wait after enabling transmit mode before sending data when in RS-485 mode.
void	setRs485EchoEnabled(boolean rs485EchoEnabled)	Set the RS-485 "echo" mode.
void	setRs485ModeEnabled(Boolean rs485ModeEnabled)	Set the RS-485 mode.
void	setRs485RtsHighEnabled(boolean rs485RtsHighEnabled)	Set the RS-485 RTS "high" mode.
void	setRs485TerminationEnabled(boolean rs485TerminationEnabled)	Set the RS-485 termination mode.
void	setStopBits(SerialStopBits stopBits)	Set the stop bits.
void	setWaitTime(int waitTime)	Set the wait time.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.solarnetwork.io.modbus.serial.SerialParameters

bitsShortcut, rs485Flags

Constructor Detail

BasicSerialParameters

public BasicSerialParameters()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

populateRs485Flags

public void populateRs485Flags(String flags)

Parse a comma-delimited list of RS-485 flags and configure the associated settings on this instance.

Each boolean-style flag can be prefixed with ! to disable the associated setting, for example "!RtsHigh" would disable the RTS High setting.

Parameters:

flags - an RS-485 flags string as returned from SerialParameters.rs485Flags()

getBaudRate

public int getBaudRate()

Description copied from interface: SerialParameters

Get the baud rate.

Specified by:

getBaudRate in interface SerialParameters

Returns:

the baud rate; defaults to SerialParameters.DEFAULT_BAUD_RATE

setBaudRate

public void setBaudRate(int baudRate)

Set the baud rate.

Parameters:

baudRate - the baud rate to set

getDataBits

public int getDataBits()

Description copied from interface: SerialParameters

Get the data bits.

Specified by:

getDataBits in interface SerialParameters

Returns:

the data bits; defaults to SerialParameters.DEFAULT_DATA_BITS

setDataBits

public void setDataBits(int dataBits)

Set the data bits.

Parameters:

dataBits - the data bits to set

getStopBits

public SerialStopBits getStopBits()

Description copied from interface: SerialParameters

Get the stop bits.

Specified by:

getStopBits in interface SerialParameters

Returns:

the stop bits; defaults to SerialParameters.DEFAULT_STOP_BITS

setStopBits

public void setStopBits(SerialStopBits stopBits)

Set the stop bits.

Parameters:

stopBits - the stop bits to set

getParity

public SerialParity getParity()

Description copied from interface: SerialParameters

Get the parity.

Specified by:

getParity in interface SerialParameters

Returns:

the parity; defaults to SerialParameters.DEFAULT_PARITY

setParity

public void setParity(SerialParity parity)

Set the parity.

Parameters:

parity - the parity to set

getFlowControl

public Set<SerialFlowControl> getFlowControl()

Description copied from interface: SerialParameters

Get the flow control.

Specified by:

getFlowControl in interface SerialParameters

Returns:

the flow control set, or null for no flow control

setFlowControl

public void setFlowControl(Set<SerialFlowControl> flowControl)

Set the flow control.

Parameters:

flowControl - the flow control, or null for none

getWaitTime

public int getWaitTime()

Description copied from interface: SerialParameters

Get the wait time.

Specified by:

getWaitTime in interface SerialParameters

Returns:

the amount of time to wait between opening the serial port and configuring its settings, in milliseconds; defaults to 0

setWaitTime

public void setWaitTime(int waitTime)

Set the wait time.

Parameters:

waitTime - the wait time to set, in milliseconds

getReadTimeout

public int getReadTimeout()

Description copied from interface: SerialParameters

Get the read timeout.

Specified by:

getReadTimeout in interface SerialParameters

Returns:

the maximum amount of time to wait for data, in milliseconds; defaults to SerialParameters.DEFAULT_READ_TIMEOUT

setReadTimeout

public void setReadTimeout(int readTimeout)

Set the read timeout.

Parameters:

readTimeout - the read timeout to set, in milliseconds

getRs485ModeEnabled

public Boolean getRs485ModeEnabled()

Description copied from interface: SerialParameters

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.

Specified by:

getRs485ModeEnabled in interface SerialParameters

Returns:

true to enable RS-485 mode

setRs485ModeEnabled

public void setRs485ModeEnabled(Boolean rs485ModeEnabled)

Set the RS-485 mode.

When this is set to true then the other getRs485* settings are used.

Parameters:

rs485ModeEnabled - true to enable RS-485 mode

isRs485RtsHighEnabled

public boolean isRs485RtsHighEnabled()

Description copied from interface: SerialParameters

Get the RS-485 RTS "high" mode.

This setting is only applicable when SerialParameters.getRs485ModeEnabled() is true.

Specified by:

isRs485RtsHighEnabled in interface SerialParameters

Returns:

true to set the RTS line high (to 1) when transmitting; defaults to SerialParameters.DEFAULT_RS485_RTS_HIGH_ENABLED

setRs485RtsHighEnabled

public void setRs485RtsHighEnabled(boolean rs485RtsHighEnabled)

Set the RS-485 RTS "high" mode.

Parameters:

rs485RtsHighEnabled - true to set the RTS line high (to 1) when transmitting

isRs485TerminationEnabled

public boolean isRs485TerminationEnabled()

Description copied from interface: SerialParameters

Get the RS-485 termination mode.

This setting is only applicable when SerialParameters.getRs485ModeEnabled() is true.

Specified by:

isRs485TerminationEnabled in interface SerialParameters

Returns:

true to enable RS-485 bus termination; defaults to false

setRs485TerminationEnabled

public void setRs485TerminationEnabled(boolean rs485TerminationEnabled)

Set the RS-485 termination mode.

Parameters:

rs485TerminationEnabled - true to enable RS-485 bus termination

isRs485EchoEnabled

public boolean isRs485EchoEnabled()

Description copied from interface: SerialParameters

Get the RS-485 "echo" mode.

This setting is only applicable when SerialParameters.getRs485ModeEnabled() is true.

Specified by:

isRs485EchoEnabled in interface SerialParameters

Returns:

true to enable receive during transmit; defaults to false

setRs485EchoEnabled

public void setRs485EchoEnabled(boolean rs485EchoEnabled)

Set the RS-485 "echo" mode.

Parameters:

rs485EchoEnabled - true to enable receive during transmit

getRs485BeforeSendDelay

public int getRs485BeforeSendDelay()

Description copied from interface: SerialParameters

Get a time to wait after enabling transmit mode before sending data when in RS-485 mode.

This setting is only applicable when SerialParameters.getRs485ModeEnabled() is true.

Specified by:

getRs485BeforeSendDelay in interface SerialParameters

Returns:

the delay, in microseconds; defaults to SerialParameters.DEFAULT_RS485_BEFORE_SEND_DELAY

setRs485BeforeSendDelay

public void setRs485BeforeSendDelay(int rs485BeforeSendDelay)

Set a time to wait after enabling transmit mode before sending data when in RS-485 mode.

Parameters:

rs485BeforeSendDelay - the delay, in microseconds

getRs485AfterSendDelay

public int getRs485AfterSendDelay()

Description copied from interface: SerialParameters

Get a time to wait after sending data before disabling transmit mode when in RS-485 mode.

This setting is only applicable when SerialParameters.getRs485ModeEnabled() is true.

Specified by:

getRs485AfterSendDelay in interface SerialParameters

Returns:

the delay, in microseconds; defaults to SerialParameters.DEFAULT_RS485_AFTER_SEND_DELAY

setRs485AfterSendDelay

public void setRs485AfterSendDelay(int rs485AfterSendDelay)

Set a time to wait after sending data before disabling transmit mode when in RS-485 mode

Parameters:

rs485AfterSendDelay - the delay, in microseconds