Viam SDK
    Preparing search index...

    Class MoveOnGlobeRequest

    from message viam.service.motion.v1.MoveOnGlobeRequest

    Hierarchy

    Index

    Constructors

    Properties

    boundingRegions: commonApi.GeoGeometry[]

    Set of obstacles which the robot must remain within while navigating

    from field: repeated viam.common.v1.GeoGeometry bounding_regions = 8;

    componentName: string

    Component on the robot to move to the specified destination

    from field: string component_name = 9;

    componentNameDeprecated?: commonApi.ResourceName

    Deprecated, use component_name field.

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

    destination?: commonApi.GeoPoint

    Destination, encoded as a GeoPoint

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

    extra?: Struct

    Additional arguments to the method

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

    heading?: number

    Optional compass heading to achieve at the destination, in degrees [0-360)

    from field: optional double heading = 3;

    motionConfiguration?: motionApi.MotionConfiguration

    Optional set of motion configuration options

    from field: optional viam.service.motion.v1.MotionConfiguration motion_configuration = 7;

    movementSensorName: string

    Name of the movement sensor which will be used to check robot location

    from field: string movement_sensor_name = 10;

    movementSensorNameDeprecated?: commonApi.ResourceName

    Deprecated, use movement_sensor_name field.

    from field: viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [deprecated = true];

    name: string

    Name of the motion service

    from field: string name = 1;

    obstacles: commonApi.GeoGeometry[]

    Obstacles to be considered for motion planning

    from field: repeated viam.common.v1.GeoGeometry obstacles = 6;

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

    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<MoveOnGlobeRequest>

    • 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 MoveOnGlobeRequest

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns MoveOnGlobeRequest