Interface ModbusOperations

The Modbus function-code surface, before any resilience is layered on.

Each method delegates to the equivalent method on the underlying native or WASM client, converting the Promise-based API into an Effect.Effect with typed ModbusError failures.

Thrown errors are classified using toModbusError, mapping modbus-rs error codes (timeout, transport, exception, etc.) into the corresponding Data.TaggedError variant for use with Effect.catchTags.

See

AsyncSerialModbusClient — Upstream modbus-rs serial client API.
AsyncTcpModbusClient — Upstream modbus-rs TCP client API.

interface ModbusOperations {
    diagnostics(
        opts: DiagnosticsOptions,
    ): Effect<DiagnosticsResponse, ModbusError>;
    readCoils(opts: ReadBitsOptions): Effect<CoilState[], ModbusError>;
    readDeviceIdentification(
        opts: ReadDeviceIdentificationOptions,
    ): Effect<DeviceIdentificationResponse, ModbusError>;
    readDiscreteInputs(opts: ReadBitsOptions): Effect<CoilState[], ModbusError>;
    readExceptionStatus(): Effect<number, ModbusError>;
    readFifoQueue(
        opts: ReadFifoQueueOptions,
    ): Effect<FifoQueueResponse, ModbusError>;
    readFileRecord(
        opts: ReadFileRecordOptions,
    ): Effect<Uint16Array<ArrayBufferLike>[], ModbusError>;
    readHoldingRegisters(
        opts: ReadRegistersOptions,
    ): Effect<Uint16Array<ArrayBufferLike>, ModbusError>;
    readInputRegisters(
        opts: ReadRegistersOptions,
    ): Effect<Uint16Array<ArrayBufferLike>, ModbusError>;
    readWriteMultipleRegisters(
        opts: ReadWriteMultipleRegistersOptions,
    ): Effect<Uint16Array<ArrayBufferLike>, ModbusError>;
    writeFileRecord(opts: WriteFileRecordOptions): Effect<void, ModbusError>;
    writeMultipleCoils(
        opts: WriteMultipleCoilsOptions,
    ): Effect<void, ModbusError>;
    writeMultipleRegisters(
        opts: WriteMultipleRegistersOptions,
    ): Effect<void, ModbusError>;
    writeSingleCoil(opts: WriteSingleCoilOptions): Effect<void, ModbusError>;
    writeSingleRegister(
        opts: WriteSingleRegisterOptions,
    ): Effect<void, ModbusError>;
}

Hierarchy (View Summary)

ModbusOperations
- EffectModbusClient

Index

Methods

diagnostics readCoils readDeviceIdentification readDiscreteInputs readExceptionStatus readFifoQueue readFileRecord readHoldingRegisters readInputRegisters readWriteMultipleRegisters writeFileRecord writeMultipleCoils writeMultipleRegisters writeSingleCoil writeSingleRegister

Methods

diagnostics

diagnostics(opts: DiagnosticsOptions): Effect<DiagnosticsResponse, ModbusError>
Sends a diagnostics request to the Modbus device (FC08).
Parameters
- opts: DiagnosticsOptions
  Diagnostic sub-function code and data words.
Returns Effect<DiagnosticsResponse, ModbusError>
An Effect resolving to a DiagnosticsResponse containing the echo sub-function and data.
See
- DiagnosticsOptions — Options shape from modbus-rs.
- DiagnosticsResponse — Response type from modbus-rs.
- Defined in src/modbus-client.ts:204

readCoils

readCoils(opts: ReadBitsOptions): Effect<CoilState[], ModbusError>
Reads coils (digital outputs) from the Modbus device (FC01).
Parameters
- opts: ReadBitsOptions
  Starting address, quantity, and optional AbortSignal.
Returns Effect<CoilState[], ModbusError>
An Effect resolving to an array of boolean coil states.

See
ReadBitsOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:123

readDeviceIdentification

readDeviceIdentification(
opts: ReadDeviceIdentificationOptions,
): Effect<DeviceIdentificationResponse, ModbusError>
Reads device identification from the Modbus device (FC43 / MEI type 14).
Parameters
- opts: ReadDeviceIdentificationOptions
  Read device ID code, starting object ID, and optional AbortSignal.
Returns Effect<DeviceIdentificationResponse, ModbusError>
An Effect resolving to a DeviceIdentificationResponse with conformity level and objects.
See
- ReadDeviceIdentificationOptions — Options shape from modbus-rs.
- DeviceIdentificationResponse — Response type from modbus-rs.
- Defined in src/modbus-client.ts:215

readDiscreteInputs

readDiscreteInputs(opts: ReadBitsOptions): Effect<CoilState[], ModbusError>
Reads discrete inputs (digital inputs) from the Modbus device (FC02).
Parameters
- opts: ReadBitsOptions
  Starting address, quantity, and optional AbortSignal.
Returns Effect<CoilState[], ModbusError>
An Effect resolving to an array of boolean input states.

See
ReadBitsOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:153

readExceptionStatus

readExceptionStatus(): Effect<number, ModbusError>
Reads the Modbus exception status (FC07).

Returns the contents of eight exception-status coils as a single byte.

Returns Effect<number, ModbusError>
An Effect resolving to the exception status byte value.
- Defined in src/modbus-client.ts:193

readFifoQueue

readFifoQueue(
opts: ReadFifoQueueOptions,
): Effect<FifoQueueResponse, ModbusError>
Reads the FIFO queue from the Modbus device (FC24).
Parameters
- opts: ReadFifoQueueOptions
  FIFO pointer address and optional AbortSignal.
Returns Effect<FifoQueueResponse, ModbusError>
An Effect resolving to a FifoQueueResponse containing the queue values.
See
- ReadFifoQueueOptions — Options shape from modbus-rs.
- FifoQueueResponse — Response type from modbus-rs.
- Defined in src/modbus-client.ts:164

readFileRecord

readFileRecord(
opts: ReadFileRecordOptions,
): Effect<Uint16Array<ArrayBufferLike>[], ModbusError>
Reads file records from the Modbus device (FC20).
Parameters
- opts: ReadFileRecordOptions
  Array of file/sub-record read requests and optional AbortSignal.
Returns Effect<Uint16Array<ArrayBufferLike>[], ModbusError>
An Effect resolving to an array of record data arrays.

See
ReadFileRecordOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:174

readHoldingRegisters

readHoldingRegisters(
opts: ReadRegistersOptions,
): Effect<Uint16Array<ArrayBufferLike>, ModbusError>
Reads holding registers from the Modbus device (FC03).
Parameters
- opts: ReadRegistersOptions
  Register address, quantity, and optional AbortSignal.
Returns Effect<Uint16Array<ArrayBufferLike>, ModbusError>
An Effect resolving to an array of 16-bit register values.
See
- ReadRegistersOptions — Options shape from modbus-rs.
- AsyncSerialModbusClient.readHoldingRegisters — Upstream implementation.
- Defined in src/modbus-client.ts:67

readInputRegisters

readInputRegisters(
opts: ReadRegistersOptions,
): Effect<Uint16Array<ArrayBufferLike>, ModbusError>
Reads input registers from the Modbus device (FC04).
Parameters
- opts: ReadRegistersOptions
  Register address, quantity, and optional AbortSignal.
Returns Effect<Uint16Array<ArrayBufferLike>, ModbusError>
An Effect resolving to an array of 16-bit input register values.
See
- ReadRegistersOptions — Options shape from modbus-rs.
- AsyncSerialModbusClient.readInputRegisters — Upstream implementation.
- Defined in src/modbus-client.ts:78

readWriteMultipleRegisters

readWriteMultipleRegisters(
opts: ReadWriteMultipleRegistersOptions,
): Effect<Uint16Array<ArrayBufferLike>, ModbusError>
Atomic read-write of multiple registers (FC23).

Performs a write operation and a read operation atomically within a single Modbus transaction.
Parameters
- opts: ReadWriteMultipleRegistersOptions
  Separate read and write addresses/quantities/values.
Returns Effect<Uint16Array<ArrayBufferLike>, ModbusError>
An Effect resolving to the read register values.

See
ReadWriteMultipleRegistersOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:111

writeFileRecord

writeFileRecord(opts: WriteFileRecordOptions): Effect<void, ModbusError>
Writes file records to the Modbus device (FC21).
Parameters
- opts: WriteFileRecordOptions
  Array of file/sub-record write requests and optional AbortSignal.
Returns Effect<void, ModbusError>
An Effect that completes when the write is acknowledged.

See
WriteFileRecordOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:184

writeMultipleCoils

writeMultipleCoils(opts: WriteMultipleCoilsOptions): Effect<void, ModbusError>
Writes multiple consecutive coils (FC15).
Parameters
- opts: WriteMultipleCoilsOptions
  Starting address, array of boolean values, and optional AbortSignal.
Returns Effect<void, ModbusError>
An Effect that completes when the write is acknowledged.

See
WriteMultipleCoilsOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:143

writeMultipleRegisters

writeMultipleRegisters(
opts: WriteMultipleRegistersOptions,
): Effect<void, ModbusError>
Writes multiple consecutive holding registers (FC16).
Parameters
- opts: WriteMultipleRegistersOptions
  Starting address, array of values, and optional AbortSignal.
Returns Effect<void, ModbusError>
An Effect that completes when the write is acknowledged.

See
WriteMultipleRegistersOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:98

writeSingleCoil

writeSingleCoil(opts: WriteSingleCoilOptions): Effect<void, ModbusError>
Writes a single coil (digital output) (FC05).
Parameters
- opts: WriteSingleCoilOptions
  Coil address, boolean value, and optional AbortSignal.
Returns Effect<void, ModbusError>
An Effect that completes when the write is acknowledged.

See
WriteSingleCoilOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:133

writeSingleRegister

writeSingleRegister(opts: WriteSingleRegisterOptions): Effect<void, ModbusError>
Writes a single holding register (FC06).
Parameters
- opts: WriteSingleRegisterOptions
  Register address, value, and optional AbortSignal.
Returns Effect<void, ModbusError>
An Effect that completes when the write is acknowledged.

See
WriteSingleRegisterOptions — Options shape from modbus-rs.
- Defined in src/modbus-client.ts:88

Interface ModbusOperations

See

Hierarchy (View Summary)

Index

Methods

Methods

diagnostics

Parameters

Returns Effect<DiagnosticsResponse, ModbusError>

See

readCoils

Parameters

Returns Effect<CoilState[], ModbusError>

See

readDeviceIdentification

Parameters

Returns Effect<DeviceIdentificationResponse, ModbusError>

See

readDiscreteInputs

Parameters

Returns Effect<CoilState[], ModbusError>

See

readExceptionStatus

Returns Effect<number, ModbusError>

readFifoQueue

Parameters

Returns Effect<FifoQueueResponse, ModbusError>

See

readFileRecord

Parameters

Returns Effect<Uint16Array<ArrayBufferLike>[], ModbusError>

See

readHoldingRegisters

Parameters

Returns Effect<Uint16Array<ArrayBufferLike>, ModbusError>

See

readInputRegisters

Parameters

Returns Effect<Uint16Array<ArrayBufferLike>, ModbusError>

See

readWriteMultipleRegisters

Parameters

Returns Effect<Uint16Array<ArrayBufferLike>, ModbusError>

See

writeFileRecord

Parameters

Returns Effect<void, ModbusError>

See

writeMultipleCoils

Parameters

Returns Effect<void, ModbusError>

See

writeMultipleRegisters

Parameters

Returns Effect<void, ModbusError>

See

writeSingleCoil

Parameters

Returns Effect<void, ModbusError>

See

writeSingleRegister

Parameters

Returns Effect<void, ModbusError>

See

Settings

On This Page