modbus_client library

Classes

FunctionCode
ModbusAppLogger
A simple application logger.
ModbusBitElement
A Modbus bit value element. This is the base class of ModbusDiscreteInput and ModbusCoil elements.
ModbusBitMask
A Modbus bit mask type used by ModbusBitMaskRegister. If the specified register bit number (0 based index) is 1 then isActive is set to true and the bit mask value returns the activeValue else the inactiveValue.
ModbusBitMaskRegister
This Uint16 register type sets the value of a list of ModbusBitMask objects.
ModbusBytesRegister
This register type reads and writes byte array.
ModbusClient
The Modbus client definition.
ModbusCoil
A Modbus ModbusElementType.coil value element.
ModbusDiscreteInput
A Modbus ModbusElementType.discreteInput value element.
ModbusDoubleRegister
A 64 bit Double register
ModbusElement<T>
The base element class
ModbusElementRequest
A request for a modbus element.
ModbusElementsGroup
An element group which is guarantied to be a valid list of Modbus elements:
ModbusElementType
The Modbus element types.
ModbusEnumRegister<T extends ModbusIntEnum>
An enumeration register. The Uin16 register value is converted into a user defined enumeration. Example: enum BatteryStatus implements ModbusIntEnum { offline(0), standby(1), running(2), fault(3), sleepMode(4);
ModbusEpochRegister
This Uint32 register type converts the device epoch value into a DateTime.
ModbusFileDoubleRecord
A Double file record type
ModbusFileFloatRecord
A Float file record type
ModbusFileInt16Record
An Int6 file record type
ModbusFileInt32Record
An Int32 file record type
ModbusFileMultipleRecord
Modbus multiple file record types
ModbusFileRecord
A file record element
ModbusFileRecordsReadRequest
The read table records request. Max length of records in bytes should not exceed 72 bytes.
ModbusFileRecordsWriteRequest
The write table records request. Max length of records in bytes should not exceed 72 bytes.
ModbusFileUint16Record
A UInt6 file record type
ModbusFileUint32Record
A UIn32 file record type
ModbusFloatRegister
A 32 bit Float register
ModbusFunctionCode
The Modbus standard function codes.
ModbusInt16Register
A signed 16 bit register
ModbusInt32Register
A signed 32 bit register
ModbusInt64Register
A signed 64 bit register
ModbusIntEnum
A Modbus enumeration type used by ModbusEnumRegister
ModbusNumRegister<T extends num>
A numeric register where type can be ModbusElementType.inputRegister or ModbusElementType.inputRegister. The returned device value (i.e. raw value) can be of type Int16, Uint16, Int32 or Uint32.
ModbusReadGroupRequest
A read request of an elements group.
ModbusReadRequest
A read request of a single element.
ModbusRequest
The base Modbus request
ModbusStatus
A Modbus status type used by ModbusStatusRegister
ModbusStatusRegister
This register type converts an Uint16 device value into a ModbusStatus.
ModbusUint16Register
An unsigned 16 bit register
ModbusUint32Register
An unsigned 32 bit register
ModbusUint64Register
An unsigned 64 bit register
ModbusWriteRequest
A write request of a single element.

Enums

FunctionType
ModbusConnectionMode
The connection mode used when sending a request.
ModbusEndianness
The type of endianness applied to number conversions
ModbusEpochType
The Modbus epoch type used by ModbusEpochRegister.
ModbusRecordType
Record type used in multiple file records
ModbusResponseCode
The Modbus response codes.

Functions

hi(int value) int
lo(int value) int

Exceptions / Errors

ModbusException
The modbus_client package base Exception class.