Viam SDK
    Preparing search index...

    Class ModuleStatus

    from message viam.robot.v1.ModuleStatus

    Hierarchy

    Index

    Constructors

    Properties

    consecutiveFailures: number

    number of times this module has entered the unhealthy state since the last time this module was in the ready state this will increment if the module is in a restart loop (state transitioning between pending and starting repeatedly) Resets to zero when the module enters the ready state or is reconfigured. Useful for detecting modules stuck in a restart loop (like a python module with a syntax error)

    from field: uint32 consecutive_failures = 5;

    error: string

    when a module transitions to unhealthy, this field is populated with the error that caused the transition. the error persists until the module reenters the Ready state, guaranteed to be nil in the Ready state

    from field: string error = 4;

    lastUpdated?: Timestamp

    updated on every state transition

    from field: google.protobuf.Timestamp last_updated = 3;

    moduleName: string

    from field: string module_name = 1;

    from field: viam.robot.v1.ModuleStatus.State state = 2;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.robot.v1.ModuleStatus"

    Methods

    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<robotApi.ModuleStatus>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns robotApi.ModuleStatus

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns robotApi.ModuleStatus