pamoja for TypeScript - v0.2.0
    Preparing search index...

    Class ModbusClient

    A Modbus RTU client on a serial line: the gateway that sends each request and waits for its reply, holding each transaction to the Modbus over Serial Line specification.

    Index
    • get responseTimeoutMs(): number

      How long the client waits for a whole reply, in milliseconds.

      Returns number

    • get turnaroundMs(): number

      How long the client leaves the line quiet after a broadcast, in milliseconds.

      Returns number

    • Reads coils, function 0x01.

      Parameters

      • unit: number
      • start: number
      • quantity: number

      Returns Promise<ModbusOutcome>

    • Reads discrete inputs, function 0x02.

      Parameters

      • unit: number
      • start: number
      • quantity: number

      Returns Promise<ModbusOutcome>

    • Reads holding registers, function 0x03.

      Parameters

      • unit: number
      • start: number
      • quantity: number

      Returns Promise<ModbusOutcome>

    • Reads input registers, function 0x04.

      Parameters

      • unit: number
      • start: number
      • quantity: number

      Returns Promise<ModbusOutcome>

    • Sets how long the client waits for a whole reply, in milliseconds.

      Parameters

      • ms: number

      Returns void

    • Sets how long the client leaves the line quiet after a broadcast, in milliseconds.

      Parameters

      • ms: number

      Returns void

    • Writes a run of coils, function 0x0F; unit 0 broadcasts them to every device.

      Parameters

      • unit: number
      • start: number
      • values: boolean[]

      Returns Promise<ModbusOutcome>

    • Writes a run of holding registers, function 0x10; unit 0 broadcasts them to every device.

      Parameters

      • unit: number
      • start: number
      • values: number[]

      Returns Promise<ModbusOutcome>

    • Writes one coil, function 0x05; unit 0 broadcasts it to every device.

      Parameters

      • unit: number
      • address: number
      • on: boolean

      Returns Promise<ModbusOutcome>

    • Writes one holding register, function 0x06; unit 0 broadcasts it to every device.

      Parameters

      • unit: number
      • address: number
      • value: number

      Returns Promise<ModbusOutcome>

    • The silence that separates two frames, in nanoseconds: 3.5 characters at the line's speed and format, and a fixed 1750 microseconds above 19200 baud.

      Parameters

      Returns number