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

    Class ModbusClientError

    Thrown when a Modbus transaction fails. kind says why: Request for a request one frame cannot carry, BroadcastRead for a read sent to unit 0, Port for a port failure, Timeout for a device that did not answer in time, Frame for a reply that fails its CRC or its shape, WrongUnit and WrongFunction for a reply to someone else's request, Mismatch for a reply that does not answer this one, and Exception for a device that refused.

    try {
      await client.readHoldingRegisters(17, 120, 3)
    } catch (error) {
      if (error instanceof ModbusClientError && error.exception === ExceptionCode.IllegalDataAddress) {
        console.log('the meter has no register there')
      }
    }

    Hierarchy

    • Error
      • ModbusClientError
    Index
    constructor
    exception found functionCode kind message name received stack? unit stackTraceLimit
    captureStackTrace prepareStackTrace
    exception: ExceptionCode | null

    For Exception, why the device refused; otherwise null.

    found: number | null

    For WrongUnit, the unit that answered, and for WrongFunction, the function the reply named; otherwise null.

    functionCode: number | null

    For Exception and WrongFunction, the function asked; otherwise null.

    kind: ModbusClientErrorKind

    Why the transaction failed.

    message: string
    name: string
    received: number | null

    For Timeout, how many bytes of a reply had arrived; otherwise null.

    stack?: string
    unit: number

    The unit the transaction asked.

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods