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

    Interface BatchingCoilClient

    Batched coil operations for one unit.

    The coil batch is separate from the holding-register batch. Each uses the write and read windows of the client.

    interface BatchingCoilClient {
        cache: CoilCache | undefined;
        flush: Effect<void>;
        read(address: number): Effect<boolean, ModbusError>;
        readAll(
            addresses: readonly number[],
        ): Effect<readonly boolean[], ModbusError>;
        readAllNow(
            addresses: readonly number[],
        ): Effect<readonly boolean[], ModbusError>;
        readNow(address: number): Effect<boolean, ModbusError>;
        write(
            write: CoilWrite,
            attributes?: ModbusSpanAttributes,
            options?: WriteOptions,
        ): Effect<void, ModbusError>;
        writeAll(
            writes: readonly CoilWrite[],
            attributes?: ModbusSpanAttributes,
            options?: WriteOptions,
        ): Effect<void, ModbusError>;
        writeAllNow(
            writes: readonly CoilWrite[],
            attributes?: ModbusSpanAttributes,
            options?: WriteOptions,
        ): Effect<void, ModbusError>;
        writeNow(
            write: CoilWrite,
            attributes?: ModbusSpanAttributes,
            options?: WriteOptions,
        ): Effect<void, ModbusError>;
    }
    Index
    cache flush
    read readAll readAllNow readNow write writeAll writeAllNow writeNow
    cache: CoilCache | undefined

    The coil cache this client filters against, or undefined when disabled.

    flush: Effect<void>

    Issues pending coil writes, then collected coil reads. Never fails.

    • Collects a coil address for the read window, then returns its state (FC01).

      Parameters

      • address: number

      Returns Effect<boolean, ModbusError>

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

      Parameters

      • addresses: readonly number[]

      Returns Effect<readonly boolean[], ModbusError>

    • Adds a group and flushes collected coil reads immediately.

      Parameters

      • addresses: readonly number[]

      Returns Effect<readonly boolean[], ModbusError>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods