Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- Acknowledge - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Server has accepted request and is processing it, but a long duration of time is required.
- 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 - Class in net.solarnetwork.io.modbus.netty.msg
-
An addressed Modbus message.
- AddressedModbusMessage - Interface in net.solarnetwork.io.modbus
-
A Modbus message related to a register address range.
- AddressedModbusMessage(int, byte, byte, int, int) - Constructor for class net.solarnetwork.io.modbus.netty.msg.AddressedModbusMessage
-
Constructor.
- AddressedModbusMessage(int, byte, int, int) - Constructor for class net.solarnetwork.io.modbus.netty.msg.AddressedModbusMessage
-
Constructor.
- AddressedModbusMessage(int, ModbusFunction, ModbusError, int, int) - Constructor for class net.solarnetwork.io.modbus.netty.msg.AddressedModbusMessage
-
Constructor.
- available() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
-
Return the number of bytes ready to read from the underlying Socket.
B
- BaseModbusMessage - Class in net.solarnetwork.io.modbus.netty.msg
-
A base implementation of
ModbusMessage. - BaseModbusMessage(int, byte) - Constructor for class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
-
Constructor.
- BaseModbusMessage(int, byte, byte) - Constructor for class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
-
Constructor.
- BaseModbusMessage(int, ModbusFunction, ModbusError) - Constructor for class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
-
Constructor.
- BasicSerialParameters - Class in net.solarnetwork.io.modbus.serial
-
Basic implementation of
SerialParameters. - BasicSerialParameters() - Constructor for class net.solarnetwork.io.modbus.serial.BasicSerialParameters
- BAUD_RATE - Static variable in class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
-
The baud rate.
- bitsForBitSet(BitSet) - Static method in interface net.solarnetwork.io.modbus.BitsModbusMessage
-
Get a BigInteger for a BitSet.
- BitsModbusMessage - Class in net.solarnetwork.io.modbus.netty.msg
-
A addressed Modbus message for bit-related blocks, like coils and discrete input registers.
- BitsModbusMessage - Interface in net.solarnetwork.io.modbus
-
A Modbus message related to a bit-based (coil/discrete) register address range.
- BitsModbusMessage(int, byte, byte, int, int, BigInteger) - Constructor for class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Constructor.
- BitsModbusMessage(int, byte, int, int, BigInteger) - Constructor for class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Constructor.
- BitsModbusMessage(int, ModbusFunction, ModbusError, int, int, BigInteger) - Constructor for class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Constructor.
- 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
- clientConfig - Variable in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
The client configuration.
- close() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort
-
Close the stream.
- Coil - Enum constant in enum net.solarnetwork.io.modbus.ModbusBlockType
-
Coil (toggle) type.
- 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.
- config() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- connect() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Establish the connection.
- 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.
D
- data() - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Get the raw data.
- DATA_BITS - Static variable in class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
-
The data bits.
- dataCopy() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- dataCopy() - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- dataCopy() - Method in interface net.solarnetwork.io.modbus.RegistersModbusMessage
-
Get a copy of the raw register data.
- dataDecode() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- dataDecode() - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- dataDecode() - Method in interface net.solarnetwork.io.modbus.RegistersModbusMessage
-
Get the register data as signed 16-bit values.
- dataDecodeUnsigned() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- dataDecodeUnsigned() - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- 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.
- decode(ChannelHandlerContext, ByteBuf, List<Object>) - Method in class net.solarnetwork.io.modbus.netty.handler.ModbusMessageDecoder
- decodeError(byte, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Decode an error code from a Modbus message payload.
- 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.
- decodeRequestPayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Decode a Modbus request message.
- decodeRequestPayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Decode a Modbus request message.
- decodeRequestPayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Decode a Modbus read/write registers request message.
- decodeRequestPayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Decode a Modbus request message.
- decodeRequestPayload(int, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Decode a full Modbus request message with specific attributes.
- decodeRequestPayload(ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Decode a full Modbus request message.
- decodeResponsePayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Decode a Modbus request message.
- decodeResponsePayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Decode a Modbus response message.
- decodeResponsePayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Decode a Modbus read/write registers request message.
- decodeResponsePayload(int, byte, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Decode a Modbus request message.
- decodeResponsePayload(int, int, int, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Decode a full Modbus response message with specific attributes.
- decodeResponsePayload(ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Decode a full Modbus response message.
- 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_PENDING_MESSAGE_TTL - Static variable in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
The
pendingMessageTtlproperty default 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_REPLY_TIMEOUT - Static variable in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
The
replyTimeoutproperty default value. - DEFAULT_STOP_BITS - Static variable in interface net.solarnetwork.io.modbus.serial.SerialParameters
-
The default stopbits value.
- DefaultSerialPortChannelConfig - Class in net.solarnetwork.io.modbus.serial
-
Default implementation of
SerialPortChannelConfig. - Diagnostic - Enum constant in enum net.solarnetwork.io.modbus.ModbusBlockType
-
Diagnostic information.
- Diagnostics - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Diagnostics info.
- DIAGNOSTICS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes
-
Diagnostics.
- discoverRequestPayloadLength(ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Determine the expected payload length for Modbus request message.
- discoverResponsePayloadLength(ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Determine the expected payload length for Modbus response message.
- Discrete - Enum constant in enum net.solarnetwork.io.modbus.ModbusBlockType
-
Discrete (input) type.
- doBeginRead() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doBind(SocketAddress) - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doClose() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doDisconnect() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doInit() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doRead() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doReadBytes(ByteBuf) - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
-
Read bytes from the underlying Socket.
- doWrite(ChannelOutboundBuffer) - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- doWriteBytes(ByteBuf) - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
-
Write the data which is hold by the
ByteBufto the underlying Socket.
E
- ENCAPSULATED_INTERFACE_TRANSPORT - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes
-
Encapsulated interface transport.
- EncapsulatedInterfaceTransport - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Encapsulated interface transport (read device identification).
- 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.
- encode(ChannelHandlerContext, ModbusMessage, List<Object>) - Method in class net.solarnetwork.io.modbus.netty.handler.ModbusMessageEncoder
- 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.
- encodeModbusPayload(ByteBuf) - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- encodeModbusPayload(ByteBuf) - Method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
- encodeModbusPayload(ByteBuf) - Method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
- encodeModbusPayload(ByteBuf) - Method in interface net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder
-
Encode a Modbus message payload to a buffer.
- encodeModbusPayload(ByteBuf) - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- encodeModbusPayload(ByteBuf) - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- encodeModbusPayload(ByteBuf) - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- encodePayload(ModbusMessage, ByteBuf) - Static method in class net.solarnetwork.io.modbus.netty.msg.ModbusMessageUtils
-
Encode a Modbus message.
- 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 function as a
ModbusFunctionCode. - errorCode() - Method in enum net.solarnetwork.io.modbus.ModbusErrorCode
- Even - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialParity
-
An even parity bit will be sent with each data character, i.e.
- 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
- filterOutboundMessage(Object) - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- forAbbreviation(String) - Static method in enum net.solarnetwork.io.modbus.serial.SerialParity
-
Get an enum instance for an abbreviation 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.ModbusBlockType
-
Get an enumeration 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.
- GatewayPathUnavailable - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Specialized for Modbus gateways.
- GatewayTimeout - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
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.
- getAddress() - Method in class net.solarnetwork.io.modbus.netty.msg.AddressedModbusMessage
- getAndMask() - Method in interface net.solarnetwork.io.modbus.MaskWriteRegisterModbusMessage
-
Get the 16-bit and mask value.
- getAndMask() - Method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
- 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. - getAutoReconnectDelaySeconds() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClientConfig
- getBaudRate() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
- getBaudRate() - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- 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.
- getBits() - Method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
- getClientConfig() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
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.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
- GetCommEventCounter - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Get the communication event counter.
- GetCommEventLog - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
The the communication event log.
- getConnectionObserver() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Get the connection observer.
- getCount() - Method in interface net.solarnetwork.io.modbus.AddressedModbusMessage
-
Get the data value count.
- getCount() - Method in class net.solarnetwork.io.modbus.netty.msg.AddressedModbusMessage
- getCreated() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage
-
Get the creation date.
- getDataBits() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
- getDataBits() - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- 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.
- getError() - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- getError() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- getFunction() - Method in interface net.solarnetwork.io.modbus.ModbusMessage
-
Get the Modbus function code.
- getFunction() - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- getFunction() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- getFuture() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage
-
Get the future awaiting the response.
- 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.
- getOption(ChannelOption<T>) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- getOptions() - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- getOrMask() - Method in interface net.solarnetwork.io.modbus.MaskWriteRegisterModbusMessage
-
Get the 16-bit org mask value.
- getOrMask() - Method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
- 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 class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- getParity() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters
-
Get the parity.
- getPendingMessageTtl() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Get the pending Modbus message time-to-live expiration time.
- getReadTimeout() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
- getReadTimeout() - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- getReadTimeout() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters
-
Get the read timeout.
- getReply() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
-
Get the original reply message.
- getReplyTimeout() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Get the Modbus message reply timeout.
- getRequest() - Method in interface net.solarnetwork.io.modbus.ModbusMessageReply
-
Get the original request message this message is a reply to.
- getRequest() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage
-
Get the request message.
- getRequest() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- 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 class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- 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.
- getUnitId() - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- getUnitId() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- getWaitTime() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
- getWaitTime() - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- getWaitTime() - Method in interface net.solarnetwork.io.modbus.serial.SerialParameters
-
Get the wait time.
- getWriteAddress() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- 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
- Holding - Enum constant in enum net.solarnetwork.io.modbus.ModbusBlockType
-
Holding (output) type.
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.
- IllegalDataAddress - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Data address of some or all the required entities are not allowed or do not exist in server.
- IllegalDataValue - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Value is not accepted by server.
- IllegalFunction - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Function code received in the query is not recognized or allowed by server.
- initChannel(Channel) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Initialize the channel.
- Input - Enum constant in enum net.solarnetwork.io.modbus.ModbusBlockType
-
Input type.
- isActive() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- isAutoReconnect() - Method in interface net.solarnetwork.io.modbus.ModbusClientConfig
-
Get the "auto reconnect" setting.
- isAutoReconnect() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClientConfig
- 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.
- isCompatible(EventLoop) - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- isConnected() - Method in interface net.solarnetwork.io.modbus.ModbusClient
-
Test if the client is started and connected to the Modbus network.
- isConnected() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- isException() - Method in interface net.solarnetwork.io.modbus.ModbusMessage
-
Test if this message is an exception (error).
- isException() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- isOpen() - Method in interface net.solarnetwork.io.modbus.serial.SerialPort
-
Test if the stream is open.
- isOpen() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- 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.
- isSameAs(ModbusMessage) - Method in interface net.solarnetwork.io.modbus.ModbusMessage
-
Compare the "sameness" of this message to another.
- isSameAs(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.msg.AddressedModbusMessage
- isSameAs(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- isSameAs(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
- isSameAs(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- isSameAs(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- isStarted() - Method in interface net.solarnetwork.io.modbus.ModbusClient
-
Test if the client has been started by a call to
ModbusClient.start()already. - isStarted() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- isWireLogging() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Get the "wire logging" setting.
L
- LAST_ENCODED_MESSAGE - Static variable in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
A channel attribute key for the last encoded message.
- localAddress() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- localAddress0() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- log - Variable in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
A class-level logger.
M
- Mark - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialParity
-
A 1 parity bit will be sent with each data character.
- 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.
- MaskWriteHoldingRegister - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Mask write a holding register.
- maskWriteHoldingRequest(int, int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Create a mask write request message.
- maskWriteHoldingResponse(int, int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Create a mask write response message.
- MaskWriteRegisterModbusMessage - Class in net.solarnetwork.io.modbus.netty.msg
-
An addressed Modbus message for holding mask write register.
- MaskWriteRegisterModbusMessage - Interface in net.solarnetwork.io.modbus
-
A Modbus message related to a holding register mask write.
- MaskWriteRegisterModbusMessage(int, byte, byte, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Constructor.
- MaskWriteRegisterModbusMessage(int, byte, int) - Constructor for class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Constructor.
- MaskWriteRegisterModbusMessage(int, byte, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Constructor.
- MaskWriteRegisterModbusMessage(int, ModbusFunction, ModbusError, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
-
Constructor.
- MAX_READ_FIFO_QUEUE_COUNT - Static variable in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
The maximum number of FIFO queue registers that can be returned at once.
- MAX_READ_REGISTERS_COUNT - Static variable in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
The maximum number of registers that can be read at once.
- MAX_WRITE_REGISTERS_COUNT - Static variable in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
The maximum number of registers that can be written at once.
- MEMORY_PARITY_ERROR - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes
-
Server detected a parity error in memory.
- MemoryParityError - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Server detected a parity error in memory.
- metadata() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- 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.
- 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.
- ModbusMessageDecoder - Class in net.solarnetwork.io.modbus.netty.handler
-
Decoder for Modbus messages.
- ModbusMessageDecoder(boolean) - Constructor for class net.solarnetwork.io.modbus.netty.handler.ModbusMessageDecoder
-
Constructor.
- ModbusMessageEncoder - Class in net.solarnetwork.io.modbus.netty.handler
-
Encoder of
ModbusMessagetoByteBuf. - ModbusMessageEncoder() - Constructor for class net.solarnetwork.io.modbus.netty.handler.ModbusMessageEncoder
- ModbusMessageReply - Interface in net.solarnetwork.io.modbus
-
A Modbus request/response pair.
- ModbusMessageUtils - Class in net.solarnetwork.io.modbus.netty.msg
-
Utilities for encoding/decoding Modbus messages.
- ModbusPayloadEncoder - Interface in net.solarnetwork.io.modbus.netty.msg
-
API for an object that can encode its own Modbus payload.
N
- name() - Method in class net.solarnetwork.io.modbus.serial.SerialAddress
-
Get the name of the serial port.
- NEGATIVE_ACKNOWLEDGE - Static variable in class net.solarnetwork.io.modbus.ModbusErrorCodes
-
Server cannot perform the programming functions.
- NegativeAcknowledge - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Server cannot perform the programming functions.
- net.solarnetwork.io.modbus - package net.solarnetwork.io.modbus
- net.solarnetwork.io.modbus.netty.handler - package net.solarnetwork.io.modbus.netty.handler
- net.solarnetwork.io.modbus.netty.msg - package net.solarnetwork.io.modbus.netty.msg
- net.solarnetwork.io.modbus.serial - package net.solarnetwork.io.modbus.serial
- NettyModbusClient<C extends ModbusClientConfig> - Class in net.solarnetwork.io.modbus.netty.handler
-
Netty implementation of
ModbusClient. - NettyModbusClient(C, ScheduledExecutorService) - Constructor for class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Constructor.
- NettyModbusClient(C, ScheduledExecutorService, ConcurrentMap<ModbusMessage, NettyModbusClient.PendingMessage>) - Constructor for class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Constructor.
- NettyModbusClient.PendingMessage - Class in net.solarnetwork.io.modbus.netty.handler
-
A request message pending a response message.
- NettyModbusClientConfig - Class in net.solarnetwork.io.modbus.netty.handler
-
Netty implementation of
ModbusClientConfig. - NettyModbusClientConfig() - Constructor for class net.solarnetwork.io.modbus.netty.handler.NettyModbusClientConfig
- newUnsafe() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- 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.
- None - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialParity
-
No parity bit will be sent with each data character at all.
O
- Odd - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialParity
-
An odd parity bit will be sent with each data character, i.e.
- 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 - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialStopBits
-
One stop bit.
- 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.
- OnePointFive - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialStopBits
-
One and a half stop bits.
- 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
- PARITY - Static variable in class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
-
The parity bit.
- payloadLength() - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- payloadLength() - Method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
- payloadLength() - Method in class net.solarnetwork.io.modbus.netty.msg.MaskWriteRegisterModbusMessage
- payloadLength() - Method in interface net.solarnetwork.io.modbus.netty.msg.ModbusPayloadEncoder
-
Get the length, in bytes, of the encoded form of this payload.
- payloadLength() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- payloadLength() - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- payloadLength() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- PendingMessage(ModbusMessage, CompletableFuture<ModbusMessage>) - Constructor for class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient.PendingMessage
-
Constructor.
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_TIMEOUT - Static variable in class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
-
The read timeout, in milliseconds.
- READ_WRITE_HOLDING_REGISTERS - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes
-
Write then read multiple holding registers.
- READ_WRITE_RESPONSE_FLAG - Static variable in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
A special value used to mark the read/write holding registers response data.
- READ_WRITE_RESPONSE_FLAG_BYTE - Static variable in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
A special value used to mark the read/write holding register response data.
- readBitsRequest(ModbusBlockType, int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a bits register request message.
- ReadCoils - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read coil.
- readCoilsRequest(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a read coils request message.
- readCoilsResponse(int, int, int, BigInteger) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a read coils response message.
- ReadDiscreteInputs - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read discreet input.
- readDiscretesRequest(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a read discrete request message.
- readDiscretesResponse(int, int, int, BigInteger) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a read discrete request message.
- ReadExceptionStatus - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read exception status.
- ReadFifoQueue - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read FIFO queue.
- readFifoQueueRequest(int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a read FIFO queue request message.
- readFifoQueueResponse(int, int, short[]) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a read FIFO queue response message.
- ReadFileRecord - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read file record.
- ReadHoldingRegisters - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read holding registers.
- readHoldingsRequest(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a read holding registers request message.
- readHoldingsResponse(int, int, short[]) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a read holding registers response message.
- ReadInputRegisters - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Read input registers.
- readInputsRequest(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a read input registers request message.
- readInputsResponse(int, int, short[]) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a read input registers response message.
- readRegistersRequest(ModbusBlockType, int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a bits register request message.
- ReadWriteHoldingRegisters - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Write then read multiple holding registers.
- readWriteHoldingsRequest(int, int, int, int, short[]) - Static method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Create a read/write holding registers request message.
- readWriteHoldingsResponse(int, int, short[]) - Static method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Create a read/write holding registers response message.
- ReadWriteRegistersModbusMessage - Class in net.solarnetwork.io.modbus.netty.msg
-
An addressed Modbus message for holding read/write registers.
- ReadWriteRegistersModbusMessage - Interface in net.solarnetwork.io.modbus
-
A Modbus message related to a holding register read/write.
- ReadWriteRegistersModbusMessage(int, byte, byte, int, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Constructor.
- ReadWriteRegistersModbusMessage(int, byte, int, int) - Constructor for class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Constructor.
- ReadWriteRegistersModbusMessage(int, byte, int, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Constructor.
- ReadWriteRegistersModbusMessage(int, ModbusFunction, ModbusError, int, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
-
Constructor.
- RegistersModbusMessage - Class in net.solarnetwork.io.modbus.netty.msg
-
A Modbus message related to a 16-bit register-based (input/holding) register address range.
- RegistersModbusMessage - Interface in net.solarnetwork.io.modbus
-
A Modbus message related to a 16-bit register-based (input/holding) register address range.
- RegistersModbusMessage(int, byte, byte, int, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Constructor.
- RegistersModbusMessage(int, byte, int, int) - Constructor for class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Constructor.
- RegistersModbusMessage(int, byte, int, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Constructor.
- RegistersModbusMessage(int, ModbusFunction, ModbusError, int, int, byte[]) - Constructor for class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Constructor.
- remoteAddress() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- remoteAddress0() - Method in class net.solarnetwork.io.modbus.serial.SerialPortChannel
- REPORT_SERVER_ID - Static variable in class net.solarnetwork.io.modbus.ModbusFunctionCodes
-
Report server ID.
- ReportServerId - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Get the report server ID.
- reverse(byte[]) - Static method in class net.solarnetwork.io.modbus.ModbusByteUtils
-
Reverse a byte array.
S
- scheduler - Variable in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
The scheduler.
- send(ModbusMessage) - Method in interface net.solarnetwork.io.modbus.ModbusClient
-
Send a request and receive a response, synchronously.
- send(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- sendAsync(ModbusMessage) - Method in interface net.solarnetwork.io.modbus.ModbusClient
-
Send a request and receive a response, asynchronously.
- sendAsync(ModbusMessage) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- SerialAddress - Class in net.solarnetwork.io.modbus.serial
-
A
SocketAddresssubclass to wrap a serial port device such as COM1 or /dev/ttyUSB0. - SerialAddress(String) - Constructor for class net.solarnetwork.io.modbus.serial.SerialAddress
-
Creates an address representing the name of a serial port.
- 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.
- SerialPortChannel - Class in net.solarnetwork.io.modbus.serial
-
Channel for a
SerialPortProvider. - SerialPortChannel(SerialPortProvider) - Constructor for class net.solarnetwork.io.modbus.serial.SerialPortChannel
-
Constructor.
- SerialPortChannelConfig - Interface in net.solarnetwork.io.modbus.serial
-
A configuration class for serial device connections.
- SerialPortChannelOption<T> - Class in net.solarnetwork.io.modbus.serial
-
Option for configuring a serial port connection.
- SerialPortChannelOption() - Constructor for class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
- SerialPortProvider - Interface in net.solarnetwork.io.modbus.serial
-
A provider of
SerialPortinstances. - 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.
- ServerDeviceBusy - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Server is engaged in processing a long-duration command.
- ServerDeviceFailure - Enum constant in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Unrecoverable error occurred while server was attempting to perform requested action.
- setAllocator(ByteBufAllocator) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setAllocator(ByteBufAllocator) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setAutoClose(boolean) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setAutoClose(boolean) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setAutoRead(boolean) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setAutoRead(boolean) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setAutoReconnect(boolean) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClientConfig
-
Set the automatic reconnection setting.
- setAutoReconnectDelaySeconds(long) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClientConfig
-
Set the automatic reconnection delay seconds.
- setBaudRate(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
-
Set the baud rate.
- setBaudRate(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setBaudRate(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Sets the baud rate (bits per second) for communication with the serial device.
- setConnectionObserver(ModbusClientConnectionObserver) - Method in interface net.solarnetwork.io.modbus.ModbusClient
-
Configure a connection observer.
- setConnectionObserver(ModbusClientConnectionObserver) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- setConnectTimeoutMillis(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setConnectTimeoutMillis(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setDataBits(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
-
Set the data bits.
- setDataBits(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setDataBits(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Sets the number of data bits to use to make up each character sent to the serial device.
- setMaxMessagesPerRead(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setMaxMessagesPerRead(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Deprecated.
- setMessageSizeEstimator(MessageSizeEstimator) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setMessageSizeEstimator(MessageSizeEstimator) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setOption(ChannelOption<T>, T) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setParity(SerialParity) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
-
Set the parity.
- setParity(SerialParity) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setParity(SerialParity) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Sets the type of parity to be used when communicating with the serial device.
- setPendingMessageTtl(long) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Set the pending Modbus message time-to-live expiration time.
- setReadTimeout(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
-
Set the read timeout.
- setReadTimeout(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setReadTimeout(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Set the maximal time to block while try to read from the serial port.
- setRecvByteBufAllocator(RecvByteBufAllocator) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setRecvByteBufAllocator(RecvByteBufAllocator) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setReplyTimeout(long) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Set the Modbus message reply timeout.
- setSerialParameters(SerialParameters) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Copy serial parameters.
- setStopBits(SerialStopBits) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
-
Set the stop bits.
- setStopBits(SerialStopBits) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setStopBits(SerialStopBits) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Sets the number of stop bits to include at the end of every character.
- setWaitTime(int) - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
-
Set the wait time.
- setWaitTime(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setWaitTime(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
-
Set the time to wait after opening the serial port and before sending it any configuration information or data.
- setWireLogging(boolean) - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
-
Set the "wire logging" setting.
- setWriteBufferHighWaterMark(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setWriteBufferHighWaterMark(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setWriteBufferLowWaterMark(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setWriteBufferLowWaterMark(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- setWriteSpinCount(int) - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- setWriteSpinCount(int) - Method in interface net.solarnetwork.io.modbus.serial.SerialPortChannelConfig
- SimpleModbusMessageReply - Class in net.solarnetwork.io.modbus.netty.msg
-
Simple implementation of
ModbusMessageReply. - SimpleModbusMessageReply(ModbusMessage, ModbusMessage) - Constructor for class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
-
Constructor.
- Space - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialParity
-
A 0 parity bit will be sent with each data character.
- 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.
- start() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- stop() - Method in interface net.solarnetwork.io.modbus.ModbusClient
-
Stop the client.
- stop() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClient
- STOP_BITS - Static variable in class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
-
The stop bits.
T
- toBitSet() - Method in interface net.solarnetwork.io.modbus.BitsModbusMessage
-
Get a
BitSetvalue 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.netty.handler.NettyModbusClient.PendingMessage
- toString() - Method in class net.solarnetwork.io.modbus.netty.handler.NettyModbusClientConfig
- toString() - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- toString() - Method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
- toString() - Method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
- toString() - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- toString() - Method in class net.solarnetwork.io.modbus.serial.BasicSerialParameters
- toString() - Method in class net.solarnetwork.io.modbus.serial.DefaultSerialPortChannelConfig
- toString() - Method in class net.solarnetwork.io.modbus.serial.SerialAddress
- toString() - Method in class net.solarnetwork.io.modbus.UserModbusFunction
- Two - Enum constant in enum net.solarnetwork.io.modbus.serial.SerialStopBits
-
Two stop bits.
- 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.
- unwrap(Class<T>) - Method in class net.solarnetwork.io.modbus.netty.msg.BaseModbusMessage
- unwrap(Class<T>) - Method in class net.solarnetwork.io.modbus.netty.msg.SimpleModbusMessageReply
- 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
- valueOf(byte) - 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.ModbusFunctionCode
-
Get a function instance for a code value.
- 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.ModbusBlockType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.solarnetwork.io.modbus.ModbusErrorCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
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.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
- WAIT_TIME - Static variable in class net.solarnetwork.io.modbus.serial.SerialPortChannelOption
-
The wait time, in milliseconds.
- 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.
- WriteCoil - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Write a coil.
- writeCoilRequest(int, int, boolean) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a write coil request message.
- writeCoilResponse(int, int, boolean) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a write coil response message.
- WriteCoils - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Write multiple coils.
- writeCoilsRequest(int, int, int, BigInteger) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a write coils request message.
- writeCoilsResponse(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.BitsModbusMessage
-
Create a write coils response message.
- writeDataDecode() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- writeDataDecode() - Method in interface net.solarnetwork.io.modbus.ReadWriteRegistersModbusMessage
-
Get the write register data as signed 16-bit values.
- writeDataDecodeUnsigned() - Method in class net.solarnetwork.io.modbus.netty.msg.ReadWriteRegistersModbusMessage
- writeDataDecodeUnsigned() - Method in interface net.solarnetwork.io.modbus.ReadWriteRegistersModbusMessage
-
Get the write register data as unsigned 16-bit values.
- WriteFileRecord - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Write file record.
- WriteHoldingRegister - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Write a holding register.
- WriteHoldingRegisters - Enum constant in enum net.solarnetwork.io.modbus.ModbusFunctionCode
-
Write multiple holding registers.
- writeHoldingRequest(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a write holding register request message.
- writeHoldingResponse(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a write holding register response message.
- writeHoldingsRequest(int, int, short[]) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a write holding registers request message.
- writeHoldingsResponse(int, int, int) - Static method in class net.solarnetwork.io.modbus.netty.msg.RegistersModbusMessage
-
Create a write holding registers response message.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form