@flux-control/effect-modbus-rs
    Preparing search index...

    Interface BatchingRegisterReader

    Reads over one register space.

    interface BatchingRegisterReader {
        read(address: number): Effect<number, ModbusError>;
        readAll(
            addresses: readonly number[],
        ): Effect<readonly number[], ModbusError>;
        readAllNow(
            addresses: readonly number[],
        ): Effect<readonly number[], ModbusError>;
        readNow(address: number): Effect<number, ModbusError>;
    }

    Hierarchy (View Summary)

    Index
    read readAll readAllNow readNow

    • Collects an address for the read window, then returns its value.

      Parameters

      • address: number

        Register address.

      Returns Effect<number, ModbusError>

      The register value, or a Modbus error.

    • Collects a group as one reader and returns values in the requested order.

      Parameters

      • addresses: readonly number[]

        Register addresses, in result order.

      Returns Effect<readonly number[], ModbusError>

      Register values in the requested order, or a Modbus error.

    • Adds a group and flushes collected reads immediately.

      Parameters

      • addresses: readonly number[]

        Register addresses, in result order.

      Returns Effect<readonly number[], ModbusError>

      Register values in the requested order, or a Modbus error.

    • Adds an address and flushes collected reads immediately.

      Parameters

      • address: number

        Register address.

      Returns Effect<number, ModbusError>

      The register value, or a Modbus error.

    Settings
    Member Visibility

    On This Page
    Methods