Viam SDK
    Preparing search index...

    Class Status

    Status is the robot navigation state returned by GetNavigationStatus and by methods that start, suspend, or resume motion. The robot is idle when goal is unset or goal.state is terminal. It is moving when goal.state == GOAL_STATE_ACTIVE. Methods that start motion fail while localized is false.

    from message viam.service.navigation.v1.Status

    Hierarchy

    Index
    extra?: Struct

    Backend-specific diagnostics

    from field: google.protobuf.Struct extra = 99;

    Latest goal; unset until the first one

    from field: optional viam.service.navigation.v1.GoalStatus goal = 4;

    localized: boolean

    Pose is trusted; false blocks new goals

    from field: bool localized = 2;

    Same as GetPosition

    from field: viam.service.navigation.v1.Position position = 1;

    updatedAt?: Timestamp

    from field: google.protobuf.Timestamp updated_at = 5;

    Current body-frame velocity; zero when stopped

    from field: viam.service.navigation.v1.Velocity velocity = 3;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.service.navigation.v1.Status"
    • 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<navigationApi.Status>

    • 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 navigationApi.Status

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns navigationApi.Status