Viam SDK
    Preparing search index...

    Class RobotConfig

    from message viam.app.v1.RobotConfig

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    auth? cloud? components debug? disableLogDeduplication disablePartialStart? enableWebProfile jobs log maintenance? modules network? overwriteFragmentStatus packages processes remotes revision services tracing? fields runtime typeName

    Methods

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

    Constructors

    Properties

    auth?: AuthConfig

    from field: optional viam.app.v1.AuthConfig auth = 7;

    cloud?: appRobotApi.CloudConfig

    from field: viam.app.v1.CloudConfig cloud = 1;

    components: ComponentConfig[]

    from field: repeated viam.app.v1.ComponentConfig components = 3;

    debug?: boolean

    Turns on debug mode for robot, adding an echo server and more logging and tracing. Only works after restart

    from field: optional bool debug = 8;

    disableLogDeduplication: boolean

    Disables the robot's log deduplication (identical, noisy logs will still be output individually instead of aggregated.)

    from field: bool disable_log_deduplication = 17;

    disablePartialStart?: boolean

    from field: optional bool disable_partial_start = 10;

    enableWebProfile: boolean

    Turns on pprof http server on localhost. By default false.

    from field: bool enable_web_profile = 13;

    jobs: JobConfig[]

    from field: repeated viam.app.v1.JobConfig jobs = 18;

    log: LogPatternConfig[]

    from field: repeated viam.app.v1.LogPatternConfig log = 14;

    maintenance?: MaintenanceConfig

    from field: optional viam.app.v1.MaintenanceConfig maintenance = 16;

    modules: ModuleConfig[]

    from field: repeated viam.app.v1.ModuleConfig modules = 9;

    network?: NetworkConfig

    from field: optional viam.app.v1.NetworkConfig network = 6;

    overwriteFragmentStatus: AppValidationStatus[]

    from field: repeated viam.app.v1.AppValidationStatus overwrite_fragment_status = 12;

    packages: PackageConfig[]

    from field: repeated viam.app.v1.PackageConfig packages = 11;

    processes: ProcessConfig[]

    from field: repeated viam.app.v1.ProcessConfig processes = 4;

    remotes: RemoteConfig[]

    from field: repeated viam.app.v1.RemoteConfig remotes = 2;

    revision: string

    Attributes a particular revision to the config.

    from field: string revision = 15;

    services: ServiceConfig[]

    from field: repeated viam.app.v1.ServiceConfig services = 5;

    tracing?: TracingConfig

    from field: optional viam.app.v1.TracingConfig tracing = 19;

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

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

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

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns RobotConfig

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods