Index (nifty-modbus-api 0.19.0 API)

A B C D E F G H I M N O P R S T U V W X

A

ACKNOWLEDGE - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Server has accepted request and is processing it, but a long duration of time is required.
AddressedModbusMessage - Interface in net.solarnetwork.io.modbus: A Modbus message related to a register address range.

B

BasicSerialParameters - Class in net.solarnetwork.io.modbus.serial: Basic implementation of SerialParameters.
BasicSerialParameters() - Constructor for class net.solarnetwork.io.modbus.serial.BasicSerialParameters
bitsForBitSet(BitSet) - Static method in interface net.solarnetwork.io.modbus.BitsModbusMessage: Get a BigInteger for a BitSet.
BitsModbusMessage - Interface in net.solarnetwork.io.modbus: A Modbus message related to a bit-based (coil/discrete) register address range.
bitsShortcut() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get a "shortcut" bits value in the form DPS for data bits, parity, and stop bits.
blockType() - Method in interface net.solarnetwork.io.modbus.ModbusFunction: Get the register block type related to this function.
blockType() - Method in enum net.solarnetwork.io.modbus.ModbusFunctionCode
blockType() - Method in class net.solarnetwork.io.modbus.UserModbusFunction

C

close() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort: Close the stream.
computeCrc(byte[], int, int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Compute a 16-bit cyclic redundancy check (CRC) value from a range of bytes.
connectionClosed(ModbusClient, ModbusClientConfig, Throwable, boolean) - Method in interface net.solarnetwork.io.modbus.ModbusClientConnectionObserver: A connection has been closed.
connectionOpened(ModbusClient, ModbusClientConfig) - Method in interface net.solarnetwork.io.modbus.ModbusClientConnectionObserver: A connection has been established.
CTS_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for CTS flow control.
CTS_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for CTS flow control.

D

dataCopy() - Method in interface net.solarnetwork.io.modbus.RegistersModbusMessage: Get a copy of the raw register data.
dataDecode() - Method in interface net.solarnetwork.io.modbus.RegistersModbusMessage: Get the register data as signed 16-bit values.
dataDecodeUnsigned() - Method in interface net.solarnetwork.io.modbus.RegistersModbusMessage: Get the register data as unsigned 16-bit values.
decode(byte[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data as signed 16-bit values.
decode(byte[], int, int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data as signed 16-bit values.
decodeHexPadStart(char[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Convert a hex-encoded string to a byte array.
decodeHexString(String) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Convert a hex-encoded string to a byte array.
decodeUnsigned(byte[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data as unsigned 16-bit values.
decodeUnsigned(byte[], int, int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data as unsigned 16-bit values.
DEFAULT_AUTO_RECONNECT - Static variable in interface net.solarnetwork.io.modbus.ModbusClientConfig: The default automatic reconnection setting.
DEFAULT_BAUD_RATE - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: A default baud rate.
DEFAULT_DATA_BITS - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default databits value.
DEFAULT_PARITY - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default parity value.
DEFAULT_READ_TIMEOUT - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default read timeout.
DEFAULT_RECONNECT_DELAY_SECS - Static variable in interface net.solarnetwork.io.modbus.ModbusClientConfig: The default reconnection delay seconds.
DEFAULT_RS485_AFTER_SEND_DELAY - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default RS-485 RTS before send delay.
DEFAULT_RS485_BEFORE_SEND_DELAY - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default RS-485 RTS before send delay.
DEFAULT_RS485_RTS_HIGH_ENABLED - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default RS-485 RTS high enabled value.
DEFAULT_STOP_BITS - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The default stopbits value.
DIAGNOSTICS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Diagnostics.
DSR_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for DSR flow control.
DSR_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for DSR flow control.
DTR_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for DTR flow control.
DTR_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for DTR flow control.

E

ENCAPSULATED_INTERFACE_TRANSPORT - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Encapsulated interface transport.
encode(short[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data from unsigned 16-bit values.
encode(short[], byte[], int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data from unsigned 16-bit values.
encode16(byte[], int, int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Encode a 16-bit value into a byte array.
encodeChar(byte, char[], char[], int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Encode a single byte as a character.
encodeHexString(byte[], int, int) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Encode a byte array into a hex-encoded upper-case string without spaces.
encodeHexString(byte[], int, int, boolean) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Encode a byte array into a hex-encoded upper-case string.
encodeHexString(byte[], int, int, boolean, boolean) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Encode a byte array into a hex-encoded string.
encodeUnsigned(int[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Get raw data from unsigned 16-bit values.
equals(Object) - Method in interface net.solarnetwork.io.modbus.ModbusError
equals(Object) - Method in interface net.solarnetwork.io.modbus.ModbusFunction
equals(Object) - Method in interface net.solarnetwork.io.modbus.ModbusMessage
equals(Object) - Method in class net.solarnetwork.io.modbus.UserModbusError
equals(Object) - Method in class net.solarnetwork.io.modbus.UserModbusFunction
ERROR_OFFSET - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: The error function code offset.
errorCode() - Method in interface net.solarnetwork.io.modbus.ModbusError: Get this error as a ModbusErrorCode.
errorCode() - Method in enum net.solarnetwork.io.modbus.ModbusErrorCode
EVEN_PARITY - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Code value for even parity.
EVEN_PARITY_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Abbreviation value for even parity.

F

forAbbreviation(String) - Static method in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Get an enumeration set for an abbreviation value.
forAbbreviation(String) - Static method in enum net.solarnetwork.io.modbus.serial.SerialParity: Get an enum instance for an abbreviation value.
forCode(int) - Static method in enum net.solarnetwork.io.modbus.ModbusBlockType: Get an enumeration instance for a code value.
forCode(byte) - Static method in enum net.solarnetwork.io.modbus.ModbusErrorCode: Get an enum instance for a code value.
forCode(byte) - Static method in enum net.solarnetwork.io.modbus.ModbusFunctionCode: Get an enum instance for a code value.
forCode(int) - Static method in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Get an enum instance for a code value.
forCode(int) - Static method in enum net.solarnetwork.io.modbus.serial.SerialParity: Get an enum instance for a code value.
forCode(int) - Static method in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Get an enum instance for a code value.
functionCode() - Method in interface net.solarnetwork.io.modbus.ModbusFunction: Get this function as a ModbusFunctionCode.
functionCode() - Method in enum net.solarnetwork.io.modbus.ModbusFunctionCode

G

GATEWAY_PATH_UNAVAILABLE - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Specialized for Modbus gateways.
GATEWAY_TIMEOUT - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Specialized for Modbus gateways.
GET_COMM_EVENT_COUNTER - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Get the communication event counter.
GET_COMM_EVENT_LOG - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Get the communication event log.
getAbbreviation() - Method in enum net.solarnetwork.io.modbus.serial.SerialParity: Get an abbreviation for this parity.
getAddress() - Method in interface net.solarnetwork.io.modbus.AddressedModbusMessage: Get the starting address.
getAndMask() - Method in interface net.solarnetwork.io.modbus.MaskWriteRegisterModbusMessage: Get the 16-bit logical and mask value.
getAutoReconnectDelaySeconds() - Method in interface net.solarnetwork.io.modbus.ModbusClientConfig: Get the number of seconds to delay attempting to automatically reestablish a connection when the ModbusClientConfig.isAutoReconnect() setting is enabled.
getBaudRate() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getBaudRate() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the baud rate.
getBitCount() - Method in enum net.solarnetwork.io.modbus.ModbusBlockType: Get the number of bits registers of this type use.
getBits() - Method in interface net.solarnetwork.io.modbus.BitsModbusMessage: Get the bits.
getClientConfig() - Method in interface net.solarnetwork.io.modbus.ModbusClient: Get the client configuration.
getCode() - Method in enum net.solarnetwork.io.modbus.ModbusBlockType: Get the function code.
getCode() - Method in interface net.solarnetwork.io.modbus.ModbusError: Get the error code value.
getCode() - Method in enum net.solarnetwork.io.modbus.ModbusErrorCode
getCode() - Method in interface net.solarnetwork.io.modbus.ModbusFunction: Get the function code.
getCode() - Method in enum net.solarnetwork.io.modbus.ModbusFunctionCode
getCode() - Method in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Get the code value.
getCode() - Method in enum net.solarnetwork.io.modbus.serial.SerialParity: Get the code value.
getCode() - Method in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Get the code value.
getCode() - Method in class net.solarnetwork.io.modbus.UserModbusError
getCode() - Method in class net.solarnetwork.io.modbus.UserModbusFunction
getCount() - Method in interface net.solarnetwork.io.modbus.AddressedModbusMessage: Get the data value count.
getDataBits() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getDataBits() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the data bits.
getDescription() - Method in interface net.solarnetwork.io.modbus.ModbusClientConfig: Get a description of this Modbus client configuration.
getError() - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Get the Modbus error code.
getFlowControl() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getFlowControl() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the flow control.
getFunction() - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Get the Modbus function code.
getInputStream() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort: Get the serial input stream.
getName() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort: Get the name of the serial port, such as /dev/ttyUSB0 or COM1.
getOrMask() - Method in interface net.solarnetwork.io.modbus.MaskWriteRegisterModbusMessage: Get the 16-bit logical or mask value.
getOutputStream() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort: Get the serial output stream.
getParity() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getParity() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the parity.
getReadTimeout() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getReadTimeout() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the read timeout.
getRequest() - Method in interface net.solarnetwork.io.modbus.ModbusMessageReply: Get the original request message this message is a reply to.
getRs485AfterSendDelay() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getRs485AfterSendDelay() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get a time to wait after sending data before disabling transmit mode when in RS-485 mode.
getRs485BeforeSendDelay() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getRs485BeforeSendDelay() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get a time to wait after enabling transmit mode before sending data when in RS-485 mode.
getRs485ModeEnabled() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getRs485ModeEnabled() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the RS-485 mode.
getSendMinimumDelayMs() - Method in interface net.solarnetwork.io.modbus.ModbusClientConfig: Get a minimum delay between sending messages, in milliseconds.
getSerialPort(String) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortProvider: Get a serial port.
getStopBits() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getStopBits() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the stop bits.
getUnitId() - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Get the device unit ID.
getWaitTime() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
getWaitTime() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the wait time.
getWriteAddress() - Method in interface net.solarnetwork.io.modbus.ReadWriteRegistersModbusMessage: Get the write starting address.

H

hashCode() - Method in interface net.solarnetwork.io.modbus.ModbusError
hashCode() - Method in interface net.solarnetwork.io.modbus.ModbusFunction
hashCode() - Method in interface net.solarnetwork.io.modbus.ModbusMessage
hashCode() - Method in class net.solarnetwork.io.modbus.UserModbusError
hashCode() - Method in class net.solarnetwork.io.modbus.UserModbusFunction

I

ILLEGAL_DATA_ADDRESS - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Data address of some or all the required entities are not allowed or do not exist in server.
ILLEGAL_DATA_VALUE - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Value is not accepted by server.
ILLEGAL_FUNCTION - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Function code received in the query is not recognized or allowed by server.
isAutoReconnect() - Method in interface net.solarnetwork.io.modbus.ModbusClientConfig: Get the "auto reconnect" setting.
isBitEnabled(int) - Method in interface net.solarnetwork.io.modbus.BitsModbusMessage: Test if a specific bit is enabled.
isBitType() - Method in enum net.solarnetwork.io.modbus.ModbusBlockType: Get the "bit type-ness" of this register block type.
isConnected() - Method in interface net.solarnetwork.io.modbus.ModbusClient: Test if the client is started and connected to the Modbus network.
isException() - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Test if this message is an exception (error).
isOpen() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort: Test if the stream is open.
isReadFunction() - Method in interface net.solarnetwork.io.modbus.ModbusFunction: Return true if this function represents a read operation.
isReadFunction() - Method in enum net.solarnetwork.io.modbus.ModbusFunctionCode
isReadFunction() - Method in class net.solarnetwork.io.modbus.UserModbusFunction
isReadOnly() - Method in enum net.solarnetwork.io.modbus.ModbusBlockType: Get the read-only flag.
isRs485EchoEnabled() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
isRs485EchoEnabled() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the RS-485 "echo" mode.
isRs485RtsHighEnabled() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
isRs485RtsHighEnabled() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the RS-485 RTS "high" mode.
isRs485TerminationEnabled() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
isRs485TerminationEnabled() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get the RS-485 termination mode.
isSameAs(ModbusMessage) - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Compare the "sameness" of this message to another.
isStarted() - Method in interface net.solarnetwork.io.modbus.ModbusClient: Test if the client has been started by a call to ModbusClient.start() already.

M

MARK_PARITY - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Code value for mark parity.
MARK_PARITY_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Abbreviation value for mark parity.
MASK_WRITE_HOLDING_REGISTER - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Mask write holding register.
MaskWriteRegisterModbusMessage - Interface in net.solarnetwork.io.modbus: A Modbus message related to a holding register mask write.
MEMORY_PARITY_ERROR - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Server detected a parity error in memory.
ModbusBlockType - Enum in net.solarnetwork.io.modbus: Modbus register block types.
ModbusByteUtils - Class in net.solarnetwork.io.modbus: Utilities for Modbus byte manipulation.
ModbusClient - Interface in net.solarnetwork.io.modbus: API for a Modbus client application.
ModbusClientConfig - Interface in net.solarnetwork.io.modbus: API for Modbus client configuration.
ModbusClientConnectionObserver - Interface in net.solarnetwork.io.modbus: API for an observer of ModbusClient connection state.
ModbusError - Interface in net.solarnetwork.io.modbus: API for a Modbus exception code.
ModbusErrorCode - Enum in net.solarnetwork.io.modbus: Modbus error codes.
ModbusErrorCodes - Class in net.solarnetwork.io.modbus: Modbus error codes utilities and constants.
ModbusException - Exception in net.solarnetwork.io.modbus: A general Modbus exception.
ModbusException() - Constructor for exception net.solarnetwork.io.modbus.ModbusException: Constructor.
ModbusException(String) - Constructor for exception net.solarnetwork.io.modbus.ModbusException: Constructor.
ModbusException(Throwable) - Constructor for exception net.solarnetwork.io.modbus.ModbusException: Constructor.
ModbusException(String, Throwable) - Constructor for exception net.solarnetwork.io.modbus.ModbusException: Constructor.
ModbusFunction - Interface in net.solarnetwork.io.modbus: API for a Modbus function.
ModbusFunctionCode - Enum in net.solarnetwork.io.modbus: Modbus function codes.
ModbusFunctionCodes - Class in net.solarnetwork.io.modbus: Function code utilities and constants.
ModbusMessage - Interface in net.solarnetwork.io.modbus: API for a Modbus message.
ModbusMessageReply - Interface in net.solarnetwork.io.modbus: A Modbus request/response pair.
ModbusTimeoutException - Exception in net.solarnetwork.io.modbus: A Modbus timeout exception.
ModbusTimeoutException() - Constructor for exception net.solarnetwork.io.modbus.ModbusTimeoutException: Constructor.
ModbusTimeoutException(String) - Constructor for exception net.solarnetwork.io.modbus.ModbusTimeoutException: Constructor.
ModbusTimeoutException(Throwable) - Constructor for exception net.solarnetwork.io.modbus.ModbusTimeoutException: Constructor.
ModbusTimeoutException(String, Throwable) - Constructor for exception net.solarnetwork.io.modbus.ModbusTimeoutException: Constructor.
ModbusValidationException - Exception in net.solarnetwork.io.modbus: An exception thrown when a Modbus validation fails.
ModbusValidationException(String) - Constructor for exception net.solarnetwork.io.modbus.ModbusValidationException: Constructor.
ModbusValidationException(Throwable) - Constructor for exception net.solarnetwork.io.modbus.ModbusValidationException: Constructor.
ModbusValidationException(String, Throwable) - Constructor for exception net.solarnetwork.io.modbus.ModbusValidationException: Constructor.

N

NEGATIVE_ACKNOWLEDGE - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Server cannot perform the programming functions.
net.solarnetwork.io.modbus - package net.solarnetwork.io.modbus
net.solarnetwork.io.modbus.serial - package net.solarnetwork.io.modbus.serial
NO_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for no flow control.
NO_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for no flow control.
NO_PARITY - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Code value for no parity.
NO_PARITY_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Abbreviation value for no parity.

O

ODD_PARITY - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Code value for odd parity.
ODD_PARITY_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Abbreviation value for odd parity.
ONE_POINT_FIVE_STOP_BITS - Static variable in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Code value for 1.5 stop bits.
ONE_STOP_BIT - Static variable in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Code value for one stop bit.
open(SerialParameters) - Method in interface net.solarnetwork.io.modbus.serial.SerialPort: Open the stream.
oppositeFunction() - Method in interface net.solarnetwork.io.modbus.ModbusFunction: Get an "opposite" function from this function.
oppositeFunction() - Method in enum net.solarnetwork.io.modbus.ModbusFunctionCode
oppositeFunction() - Method in class net.solarnetwork.io.modbus.UserModbusFunction
OPPOSITES - Static variable in enum net.solarnetwork.io.modbus.ModbusFunctionCode: A mapping of function read-write opposites.

P

populateRs485Flags(String) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Parse a comma-delimited list of RS-485 flags and configure the associated settings on this instance.

R

READ_COILS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read coils.
READ_DISCRETE_INPUTS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read discrete inputs.
READ_EXCEPTION_STATUS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read exception status.
READ_FIFO_QUEUE - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read FIFO queue.
READ_FILE_RECORD - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read file record.
READ_HOLDING_REGISTERS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read holding registers.
READ_INPUT_REGISTERS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Read input registers.
READ_WRITE_HOLDING_REGISTERS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Write then read multiple holding registers.
ReadWriteRegistersModbusMessage - Interface in net.solarnetwork.io.modbus: A Modbus message related to a holding register read/write.
RegistersModbusMessage - Interface in net.solarnetwork.io.modbus: A Modbus message related to a 16-bit register-based (input/holding) register address range.
REPORT_SERVER_ID - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Report server ID.
reverse(byte[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils: Reverse a byte array.
RS485_AFTER_SEND_DELAY_FLAG - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The RS-485 after send delay flag.
RS485_BEFORE_SEND_DELAY_FLAG - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The RS-485 before send delay flag.
RS485_ECHO_FLAG - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The RS-485 echo flag.
RS485_RTS_HIGH_FLAG - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The RS-485 RTS high flag.
RS485_TERMINATION_FLAG - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters: The RS-485 termination flag.
rs485Flags() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters: Get a comma-delimited list of the enabled RS-485 settings, using the RS485_*_FLAG constants.
RTS_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for RTS flow control.
RTS_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for RTS flow control.

S

send(ModbusMessage) - Method in interface net.solarnetwork.io.modbus.ModbusClient: Send a request and receive a response, synchronously.
sendAsync(ModbusMessage) - Method in interface net.solarnetwork.io.modbus.ModbusClient: Send a request and receive a response, asynchronously.
SerialFlowControl - Enum in net.solarnetwork.io.modbus.serial: Enumeration of serial flow control settings.
SerialParameters - Interface in net.solarnetwork.io.modbus.serial: Serial configuration parameters.
SerialParity - Enum in net.solarnetwork.io.modbus.serial: Enumeration of serial parity settings.
SerialPort - Interface in net.solarnetwork.io.modbus.serial: API for a serial port.
SerialPortProvider - Interface in net.solarnetwork.io.modbus.serial: A provider of SerialPort instances.
SerialStopBits - Enum in net.solarnetwork.io.modbus.serial: Enumeration of serial "stopbit" settings.
SERVER_DEVICE_BUSY - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Server is engaged in processing a long-duration command.
SERVER_DEVICE_FAILURE - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes: Unrecoverable error occurred while server was attempting to perform requested action.
setBaudRate(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the baud rate.
setConnectionObserver(ModbusClientConnectionObserver) - Method in interface net.solarnetwork.io.modbus.ModbusClient: Configure a connection observer.
setDataBits(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the data bits.
setFlowControl(Set<SerialFlowControl>) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the flow control.
setParity(SerialParity) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the parity.
setReadTimeout(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the read timeout.
setRs485AfterSendDelay(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set a time to wait after sending data before disabling transmit mode when in RS-485 mode
setRs485BeforeSendDelay(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set a time to wait after enabling transmit mode before sending data when in RS-485 mode.
setRs485EchoEnabled(boolean) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the RS-485 "echo" mode.
setRs485ModeEnabled(Boolean) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the RS-485 mode.
setRs485RtsHighEnabled(boolean) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the RS-485 RTS "high" mode.
setRs485TerminationEnabled(boolean) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the RS-485 termination mode.
setStopBits(SerialStopBits) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the stop bits.
setWaitTime(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters: Set the wait time.
SPACE_PARITY - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Code value for space parity.
SPACE_PARITY_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialParity: Abbreviation value for space parity.
start() - Method in interface net.solarnetwork.io.modbus.ModbusClient: Start the client.
stop() - Method in interface net.solarnetwork.io.modbus.ModbusClient: Stop the client.

T

toBitSet() - Method in interface net.solarnetwork.io.modbus.BitsModbusMessage: Get a BitSet value for the bits data.
toDisplayString() - Method in interface net.solarnetwork.io.modbus.ModbusFunction: Get a friendly display string for this function.
toDisplayString() - Method in enum net.solarnetwork.io.modbus.ModbusFunctionCode
toDisplayString() - Method in class net.solarnetwork.io.modbus.UserModbusFunction
toString() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
toString() - Method in class net.solarnetwork.io.modbus.UserModbusError
toString() - Method in class net.solarnetwork.io.modbus.UserModbusFunction
TWO_STOP_BITS - Static variable in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Code value for two stop bits.

U

unwrap(Class<T>) - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Unwrap this message as a specific message type, if possible.
UserModbusError - Class in net.solarnetwork.io.modbus: A user-defined or otherwise unknown error code.
UserModbusError(byte) - Constructor for class net.solarnetwork.io.modbus.UserModbusError: Constructor.
UserModbusFunction - Class in net.solarnetwork.io.modbus: A user-defined Modbus function.
UserModbusFunction(byte) - Constructor for class net.solarnetwork.io.modbus.UserModbusFunction: Constructor.
UserModbusFunction(String, byte) - Constructor for class net.solarnetwork.io.modbus.UserModbusFunction: Constructor.
UserModbusFunction(String, byte, ModbusBlockType, boolean, ModbusFunction) - Constructor for class net.solarnetwork.io.modbus.UserModbusFunction: Constructor.

V

validate() - Method in interface net.solarnetwork.io.modbus.ModbusMessage: Validate this message in some way.
valueOf(String) - Static method in enum net.solarnetwork.io.modbus.ModbusBlockType: Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum net.solarnetwork.io.modbus.ModbusBlockType: Get an enumeration instance for a code value.
valueOf(String) - Static method in enum net.solarnetwork.io.modbus.ModbusErrorCode: Returns the enum constant of this type with the specified name.
valueOf(byte) - Static method in enum net.solarnetwork.io.modbus.ModbusErrorCode
valueOf(String) - Static method in enum net.solarnetwork.io.modbus.ModbusFunctionCode: Returns the enum constant of this type with the specified name.
valueOf(byte) - Static method in enum net.solarnetwork.io.modbus.ModbusFunctionCode: Get a function instance for a code value.
valueOf(String) - Static method in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.solarnetwork.io.modbus.serial.SerialParity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.solarnetwork.io.modbus.ModbusBlockType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.solarnetwork.io.modbus.ModbusErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.solarnetwork.io.modbus.ModbusFunctionCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.solarnetwork.io.modbus.serial.SerialParity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.solarnetwork.io.modbus.serial.SerialStopBits: Returns an array containing the constants of this enum type, in the order they are declared.

W

WRITE_COIL - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Write coil.
WRITE_COILS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Write coils.
WRITE_FILE_RECORD - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Write file record.
WRITE_HOLDING_REGISTER - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Write holding register.
WRITE_HOLDING_REGISTERS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes: Write holding registers.
writeDataDecode() - Method in interface net.solarnetwork.io.modbus.ReadWriteRegistersModbusMessage: Get the write register data as signed 16-bit values.
writeDataDecodeUnsigned() - Method in interface net.solarnetwork.io.modbus.ReadWriteRegistersModbusMessage: Get the write register data as unsigned 16-bit values.

X

XONXOFF_IN_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for Xon Xoff in flow control.
XONXOFF_IN_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for Xon Xoff in flow control.
XONXOFF_OUT_FLOW_CONTROL - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Code value for Xon Xoff out flow control.
XONXOFF_OUT_FLOW_CONTROL_ABBREVIATION - Static variable in enum net.solarnetwork.io.modbus.serial.SerialFlowControl: Abbreviation value for Xon Xoff out flow control.

A B C D E F G H I M N O P R S T U V W X