Viam SDK
    Preparing search index...

    Class MoveRequest

    Moves any component on the robot to a specified destination which can be from the reference frame of any other component on the robot.

    from message viam.service.motion.v1.MoveRequest

    Hierarchy

    Index

    Constructors

    Properties

    componentName: string

    Component on the robot to move to the specified destination

    from field: string component_name = 6;

    componentNameDeprecated?: commonApi.ResourceName

    Deprecated, use component_name field.

    from field: viam.common.v1.ResourceName component_name_deprecated = 3 [deprecated = true];

    constraints?: motionApi.Constraints

    Constrain the way the robot will move

    from field: optional viam.service.motion.v1.Constraints constraints = 5;

    destination?: commonApi.PoseInFrame

    Destination to move to, which can a pose in the reference frame of any frame in the robot's frame system

    from field: viam.common.v1.PoseInFrame destination = 2;

    extra?: Struct

    Additional arguments to the method

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

    name: string

    Name of the motion service

    from field: string name = 1;

    worldState?: commonApi.WorldState

    Avoid obstacles by specifying their geometries in the world state Augment the frame system of the robot by specifying additional transforms to add to it for the duration of the Move

    from field: optional viam.common.v1.WorldState world_state = 4;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.service.motion.v1.MoveRequest"

    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<motionApi.MoveRequest>

    • 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 motionApi.MoveRequest

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns motionApi.MoveRequest