modbus_typed_client library

Classes

BooleanTypeConverter
CallbackDiscreteTypeConverter<T>
CallbackRegisterTypeConverter<T>
DiscreteTypeConverter<T>
Type converter that only supports reading / writing to Modbus registers with 1-bit discrete sizes, namely coils and discrete input.
EitherTypeConverter<T>
IntTypeConverter
ModbusClient
MODBUS client
ModbusConnector
MODBUS Connector.
ModbusExceptionCodes
ModbusFunctions
ModbusTypedClient
Type-safe Modbus client for creating easy-to-use Modbus calls.
RegisterTypeConverter<T>
Type converter that only supports reading / writing to Modbus registers with 16-bit sizes, namely input registers and holding registers.
TcpConnector
MODBUS TCP Connector Simple protocol details: https://ipc2u.ru/articles/prostye-resheniya/modbus-tcp/
TypeConverter<T>
Converts between a specific type T and modbus register data.

Enums

ModbusMode
Register
Modbus object types / registers

Constants

defaultModbusUpdateInterval → const Duration

Functions

createClient(TcpConnector connector, {int unitId = 1}) ModbusClient
createTcpClient(dynamic address, {int port = 502, ModbusMode mode = ModbusMode.rtu, int unitId = 1, Duration? timeout}) ModbusClient

Typedefs

AreEqual<T> = bool Function(T a, T b)
CloseCallback = void Function()
ErrorCallback = void Function(dynamic error, dynamic stackTrace)
FunctionCallback = void Function(int function, Uint8List data)
ModbusClientReader<T> = Stream<T> Function({AreEqual<T>? areEqual, bool distinct, Duration updateInterval})
ModbusClientWriter<T> = Future<void> Function(T value)
RawReadCallback<R> = Future<R> Function(int amount)
RawWriteCallback<R> = Future<void> Function(R value)
ReadCallback<T, R> = Future<T> Function(RawReadCallback<R> rawRead)
ReadRegister<R> = Future<R> Function(int address, int amount)
WriteCallback<T, R, RR> = Future<void> Function(T value, RawWriteCallback<R> writeSingle, RawWriteCallback<RR> writeMultiple)

Exceptions / Errors

ModbusAcknowledgeException
Acknowledge Throw when modbus server return error response function 0x05
ModbusAmountException
Amount Exception Throw when the address or amount input is mismatching.
ModbusBufferException
Buffer Exception Throw when buffer is too small for the data to be stored.
ModbusConnectException
Connection Issue Throw when a connection issues happens between modbus client and server
ModbusException
MODBUS Exception Super Class Throw when a exception or errors happens in modbus protocol
ModbusGatewayProblemException
Gateway Problem Throw when modbus server return error response function 0x0A and 0x0B
ModbusIllegalAddressException
Illegal Address Throw when modbus server return error response function 0x02
ModbusIllegalDataValueException
Illegal Data Value Throw when modbus server return error response function 0x03
ModbusIllegalFunctionException
Illegal Function Throw when modbus server return error response function 0x01
ModbusServerBusyException
Server Busy Throw when modbus server return error response function 0x06
ModbusServerFailureException
Server Failure Throw when modbus server return error response function 0x04