Viam SDK
    Preparing search index...

    Class RemoteConfig

    A RemoteConfig describes a remote robot that should be integrated. The Frame field defines how the "world" node of the remote robot should be reconciled with the "world" node of the the current robot. All components of the remote robot who have Parent as "world" will be attached to the parent defined in Frame, and with the given offset as well.

    from message viam.app.v1.RemoteConfig

    Hierarchy

    Index

    Constructors

    Properties

    address: string

    from field: string address = 2;

    auth?: RemoteAuth

    from field: viam.app.v1.RemoteAuth auth = 4;

    connectionCheckInterval?: Duration

    from field: google.protobuf.Duration connection_check_interval = 7;

    frame?: Frame

    from field: viam.app.v1.Frame frame = 3;

    insecure: boolean

    from field: bool insecure = 6;

    managedBy: string

    from field: string managed_by = 5;

    name: string

    from field: string name = 1;

    prefix: string

    A string with which to prefix all resource names fetched from this remote.

    from field: string prefix = 11;

    reconnectInterval?: Duration

    from field: google.protobuf.Duration reconnect_interval = 8;

    secret: string

    Secret is a helper for a robot location secret.

    from field: string secret = 10;

    serviceConfigs: ResourceLevelServiceConfig[]

    from field: repeated viam.app.v1.ResourceLevelServiceConfig service_configs = 9;

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

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

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns RemoteConfig