ModbusClient class abstract

Modbus client interface providing all standard Modbus functions.

This interface defines the high-level API for Modbus communication, supporting both bit access (coils, discrete inputs) and 16-bit register access (input registers, holding registers).

Example:

final provider = TCPClientProvider('192.168.1.100:502');
final client = ModbusClientImpl(provider);

await client.connect();
final registers = await client.readHoldingRegisters(1, 0, 10);
await client.close();
Implementers

Constructors

ModbusClient()

Properties

hashCode int
The hash code for this object.
no setterinherited
isConnected bool
Check if client is currently connected to the server.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() Future<void>
Close connection to the remote server.
connect() Future<void>
Connect to the remote Modbus server.
maskWriteRegister(int slaveId, int address, int andMask, int orMask) Future<void>
Mask write register (FC 22).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
readCoils(int slaveId, int address, int quantity) Future<Uint8List>
Read coil status (FC 01).
readDiscreteInputs(int slaveId, int address, int quantity) Future<Uint8List>
Read discrete input status (FC 02).
readFIFOQueue(int slaveId, int address) Future<Uint8List>
Read FIFO queue (FC 24).
readHoldingRegisters(int slaveId, int address, int quantity) Future<Uint16List>
Read holding registers as 16-bit values (FC 03).
readHoldingRegistersBytes(int slaveId, int address, int quantity) Future<Uint8List>
Read holding registers as bytes (FC 03).
readInputRegisters(int slaveId, int address, int quantity) Future<Uint16List>
Read input registers as 16-bit values (FC 04).
readInputRegistersBytes(int slaveId, int address, int quantity) Future<Uint8List>
Read input registers as bytes (FC 04).
readWriteMultipleRegisters(int slaveId, int readAddress, int readQuantity, int writeAddress, int writeQuantity, Uint8List value) Future<Uint16List>
Read and write multiple registers, returning 16-bit values (FC 23).
readWriteMultipleRegistersBytes(int slaveId, int readAddress, int readQuantity, int writeAddress, int writeQuantity, Uint8List value) Future<Uint8List>
Read and write multiple registers, returning bytes (FC 23).
send(int slaveId, ProtocolDataUnit request) Future<ProtocolDataUnit>
Send a custom Modbus request.
sendPdu(int slaveId, Uint8List pduRequest) Future<Uint8List>
Send a custom PDU request.
sendRawFrame(Uint8List aduRequest) Future<Uint8List>
Send a raw ADU frame.
toString() String
A string representation of this object.
inherited
writeMultipleCoils(int slaveId, int address, int quantity, Uint8List value) Future<void>
Write multiple coils (FC 15).
writeMultipleRegisters(int slaveId, int address, int quantity, Uint16List value) Future<void>
Write multiple registers from 16-bit values (FC 16).
writeMultipleRegistersBytes(int slaveId, int address, int quantity, Uint8List value) Future<void>
Write multiple registers from bytes (FC 16).
writeSingleCoil(int slaveId, int address, bool isOn) Future<void>
Write single coil (FC 05).
writeSingleRegister(int slaveId, int address, int value) Future<void>
Write single register (FC 06).

Operators

operator ==(Object other) bool
The equality operator.
inherited