Viam SDK
    Preparing search index...

    Class GoalStatus

    GoalStatus is one goal and its lifecycle. Returned (embedded in Status) by every method that starts, suspends, resumes, or cancels motion, and embedded in Status from GetNavigationStatus. Only the latest goal is kept. SUCCEEDED, FAILED, and CANCELED are terminal.

    from message viam.service.navigation.v1.GoalStatus

    Hierarchy

    Index
    constructor
    error? finishedAt? location? mode progress? route? startedAt? state suspendReason? target? fields runtime typeName
    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString
    error?: navigationApi.NavError

    When FAILED

    from field: optional viam.service.navigation.v1.NavError error = 8;

    finishedAt?: Timestamp

    Set once terminal

    from field: optional google.protobuf.Timestamp finished_at = 10;

    location?: string

    Set when the target is a saved location

    from field: optional string location = 4;

    mode: navigationApi.NavMode

    from field: viam.service.navigation.v1.NavMode mode = 2;

    progress?: navigationApi.Progress

    While ACTIVE

    from field: optional viam.service.navigation.v1.Progress progress = 5;

    route?: navigationApi.RouteProgress

    When mode == NAV_MODE_ROUTE

    from field: optional viam.service.navigation.v1.RouteProgress route = 6;

    startedAt?: Timestamp

    from field: google.protobuf.Timestamp started_at = 9;

    state: navigationApi.GoalState

    from field: viam.service.navigation.v1.GoalState state = 1;

    suspendReason?: string

    When SUSPENDED

    from field: optional string suspend_reason = 7;

    target?: navigationApi.Position

    For a route, the current waypoint

    from field: viam.service.navigation.v1.Position target = 3;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.service.navigation.v1.GoalStatus"

    • 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.GoalStatus>

    • 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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods