Viam SDK
    Preparing search index...

    Class RobotPart

    from message viam.app.v1.RobotPart

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    createdOn? dnsName fqdn id lastAccess? lastUpdated? localFqdn locationId mainPart name onlineState robot robotConfig? robotConfigJson? secondsSinceOnline secret secrets userSuppliedInfo? fields runtime typeName

    Methods

    clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

    Constructors

    Properties

    createdOn?: Timestamp

    from field: google.protobuf.Timestamp created_on = 13;

    dnsName: string

    dns_name part name used for fqdn and local fqdn. Anytime the Name is updated this should be sanitized and updated as well.

    from field: string dns_name = 10;

    fqdn: string

    from field: string fqdn = 9;

    id: string

    from field: string id = 1;

    lastAccess?: Timestamp

    from field: google.protobuf.Timestamp last_access = 6;

    lastUpdated?: Timestamp

    latest timestamp when a robot part was updated

    from field: google.protobuf.Timestamp last_updated = 15;

    localFqdn: string

    from field: string local_fqdn = 11;

    locationId: string

    Store the location_id to allow for unique indexes across parts and locations. This filed MUST be updated each time the robots location changes.

    from field: string location_id = 12;

    mainPart: boolean

    from field: bool main_part = 8;

    name: string

    from field: string name = 2;

    onlineState: OnlineState

    from field: viam.app.v1.OnlineState online_state = 16;

    robot: string

    from field: string robot = 4;

    robotConfig?: Struct

    from field: google.protobuf.Struct robot_config = 5;

    robotConfigJson?: string

    robot_config_json is the raw JSON string of the robot config, preserving user-defined key order.

    from field: optional string robot_config_json = 18;

    secondsSinceOnline: bigint

    from field: int64 seconds_since_online = 17;

    secret: string

    from field: string secret = 3;

    secrets: SharedSecret[]

    List of secrets allowed for authentication.

    from field: repeated viam.app.v1.SharedSecret secrets = 14;

    userSuppliedInfo?: Struct

    from field: google.protobuf.Struct user_supplied_info = 7;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.v1.RobotPart"

    Methods

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      Parameters

      Returns boolean

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

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns RobotPart

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods