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

    Interface BatchingDebounceOptions

    How long operations are collected before they reach the bus.

    interface BatchingDebounceOptions {
        reads?: { window: Input };
        writes?: { flushFullRuns?: boolean; maxHold?: Input; window: Input };
    }
    Index
    reads?: { window: Input }

    The window for reads.

    Omitted, reads are not debounced. readAll still plans the addresses it is given, so a caller that reads a group in one call needs no window.

    A useful window is on the order of one transaction. Measure a transaction on the bus in question before choosing one.

    writes?: { flushFullRuns?: boolean; maxHold?: Input; window: Input }

    The window for writes, and the ceiling on the total hold.

    Omitted, writes are not debounced: each one reaches the bus on its own. The package holds nothing back by default, so a caller that has not asked for a window pays no latency for one.

    Type Declaration

    • Optional ReadonlyflushFullRuns?: boolean

      Flushes a run of contiguous held addresses early when it has plan.writes.maxRegistersPerWrite addresses.

      The count uses held addresses before the cache filter. Thus the early flush can send a shorter transaction, or FC06 writes when minRunLength is more than the limit. Other held writes stay for the window. Use this for a unit that writes a wide block once and also repeats writes to a few registers.

      false
      
    • Optional ReadonlymaxHold?: Input
    • Readonlywindow: Input