Viam SDK
    Preparing search index...

    Class Properties

    Properties are returned by GetProperties and do not change while the service is running.

    from message viam.service.navigation.v1.Properties

    Hierarchy

    Index
    constructor
    costmapSupported footprintLengthM footprintWidthM mapType planningSupported robotRadiusM routesSupported zonesSupported fields runtime typeName
    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString
    costmapSupported: boolean

    GetCostmap

    from field: bool costmap_supported = 6;

    footprintLengthM: number

    from field: double footprint_length_m = 2;

    footprintWidthM: number

    from field: double footprint_width_m = 3;

    mapType: navigationApi.MapType

    from field: viam.service.navigation.v1.MapType map_type = 1;

    planningSupported: boolean

    PlanTo*, ExecutePlan, NavigateTo*

    from field: bool planning_supported = 5;

    robotRadiusM: number

    from field: double robot_radius_m = 4;

    routesSupported: boolean

    Route store + NavigateRoute

    from field: bool routes_supported = 8;

    zonesSupported: boolean

    Keep-out / speed-limit zones

    from field: bool zones_supported = 7;

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

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

    • 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