UNPKG

spot-sdk-ts

Version:

TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics

665 lines 30.5 kB
import { RequestHeader, ResponseHeader } from "../header"; import { SystemFault } from "../robot_state"; import { DataChunk } from "../data_chunk"; import _m0 from "protobufjs/minimal"; export declare const protobufPackage = "bosdyn.api.spot_cam"; /** The temperature of a particular component. */ export interface Temperature { /** Identifier of the hardware measured. */ channelName: string; /** Temperature is expressed in millidegrees C. */ temperature: number; } /** Clear Built-in Test events. */ export interface ClearBITEventsRequest { /** Common request header. */ header: RequestHeader | undefined; } /** Response to clearing built-in test events. */ export interface ClearBITEventsResponse { /** Common response header. */ header: ResponseHeader | undefined; } /** Request the status of all built-in tests. */ export interface GetBITStatusRequest { /** Common request header. */ header: RequestHeader | undefined; } /** Data on the current status of built-in tests. */ export interface GetBITStatusResponse { /** Common response header. */ header: ResponseHeader | undefined; /** Fault events that have been reported. */ events: SystemFault[]; /** List of system states that may effect performance. */ degradations: GetBITStatusResponse_Degradation[]; } /** * Degredations are not necessesarily faults; a unit * with no installed mechanical PTZ will behave differently, * but nothing's actually wrong. */ export interface GetBITStatusResponse_Degradation { /** System affected. */ type: GetBITStatusResponse_Degradation_DegradationType; /** Description of the kind of degradation being experienced. */ description: string; } /** Systems that can experience performance degredations. */ export declare enum GetBITStatusResponse_Degradation_DegradationType { STORAGE = 0, PTZ = 1, LED = 2, UNRECOGNIZED = -1 } export declare function getBITStatusResponse_Degradation_DegradationTypeFromJSON(object: any): GetBITStatusResponse_Degradation_DegradationType; export declare function getBITStatusResponse_Degradation_DegradationTypeToJSON(object: GetBITStatusResponse_Degradation_DegradationType): string; export interface GetTemperatureRequest { /** Common request header. */ header: RequestHeader | undefined; } export interface GetTemperatureResponse { /** Common response header. */ header: ResponseHeader | undefined; /** List of all temperatures measured. */ temps: Temperature[]; } export interface GetSystemLogRequest { header: RequestHeader | undefined; } export interface GetSystemLogResponse { header: ResponseHeader | undefined; data: DataChunk | undefined; } export declare const Temperature: { encode(message: Temperature, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): Temperature; fromJSON(object: any): Temperature; toJSON(message: Temperature): unknown; fromPartial<I extends { channelName?: string | undefined; temperature?: number | undefined; } & { channelName?: string | undefined; temperature?: number | undefined; } & { [K in Exclude<keyof I, keyof Temperature>]: never; }>(object: I): Temperature; }; export declare const ClearBITEventsRequest: { encode(message: ClearBITEventsRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): ClearBITEventsRequest; fromJSON(object: any): ClearBITEventsRequest; toJSON(message: ClearBITEventsRequest): unknown; fromPartial<I extends { header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; } & { header?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined; } & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): ClearBITEventsRequest; }; export declare const ClearBITEventsResponse: { encode(message: ClearBITEventsResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): ClearBITEventsResponse; fromJSON(object: any): ClearBITEventsResponse; toJSON(message: ClearBITEventsResponse): unknown; fromPartial<I extends { header?: { requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; } & { header?: ({ requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { requestHeader?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: ({ code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined; request?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; } & { [K_5 in Exclude<keyof I, "header">]: never; }>(object: I): ClearBITEventsResponse; }; export declare const GetBITStatusRequest: { encode(message: GetBITStatusRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetBITStatusRequest; fromJSON(object: any): GetBITStatusRequest; toJSON(message: GetBITStatusRequest): unknown; fromPartial<I extends { header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; } & { header?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined; } & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): GetBITStatusRequest; }; export declare const GetBITStatusResponse: { encode(message: GetBITStatusResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetBITStatusResponse; fromJSON(object: any): GetBITStatusResponse; toJSON(message: GetBITStatusResponse): unknown; fromPartial<I extends { header?: { requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; events?: { name?: string | undefined; onsetTimestamp?: Date | undefined; duration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; code?: number | undefined; uid?: number | undefined; errorMessage?: string | undefined; attributes?: string[] | undefined; severity?: import("../robot_state").SystemFault_Severity | undefined; }[] | undefined; degradations?: { type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; }[] | undefined; } & { header?: ({ requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { requestHeader?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: ({ code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined; request?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; events?: ({ name?: string | undefined; onsetTimestamp?: Date | undefined; duration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; code?: number | undefined; uid?: number | undefined; errorMessage?: string | undefined; attributes?: string[] | undefined; severity?: import("../robot_state").SystemFault_Severity | undefined; }[] & ({ name?: string | undefined; onsetTimestamp?: Date | undefined; duration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; code?: number | undefined; uid?: number | undefined; errorMessage?: string | undefined; attributes?: string[] | undefined; severity?: import("../robot_state").SystemFault_Severity | undefined; } & { name?: string | undefined; onsetTimestamp?: Date | undefined; duration?: ({ seconds?: number | undefined; nanos?: number | undefined; } & { seconds?: number | undefined; nanos?: number | undefined; } & { [K_5 in Exclude<keyof I["events"][number]["duration"], keyof import("../../../google/protobuf/duration").Duration>]: never; }) | undefined; code?: number | undefined; uid?: number | undefined; errorMessage?: string | undefined; attributes?: (string[] & string[] & { [K_6 in Exclude<keyof I["events"][number]["attributes"], keyof string[]>]: never; }) | undefined; severity?: import("../robot_state").SystemFault_Severity | undefined; } & { [K_7 in Exclude<keyof I["events"][number], keyof SystemFault>]: never; })[] & { [K_8 in Exclude<keyof I["events"], keyof { name?: string | undefined; onsetTimestamp?: Date | undefined; duration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; code?: number | undefined; uid?: number | undefined; errorMessage?: string | undefined; attributes?: string[] | undefined; severity?: import("../robot_state").SystemFault_Severity | undefined; }[]>]: never; }) | undefined; degradations?: ({ type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; }[] & ({ type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; } & { type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; } & { [K_9 in Exclude<keyof I["degradations"][number], keyof GetBITStatusResponse_Degradation>]: never; })[] & { [K_10 in Exclude<keyof I["degradations"], keyof { type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; }[]>]: never; }) | undefined; } & { [K_11 in Exclude<keyof I, keyof GetBITStatusResponse>]: never; }>(object: I): GetBITStatusResponse; }; export declare const GetBITStatusResponse_Degradation: { encode(message: GetBITStatusResponse_Degradation, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetBITStatusResponse_Degradation; fromJSON(object: any): GetBITStatusResponse_Degradation; toJSON(message: GetBITStatusResponse_Degradation): unknown; fromPartial<I extends { type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; } & { type?: GetBITStatusResponse_Degradation_DegradationType | undefined; description?: string | undefined; } & { [K in Exclude<keyof I, keyof GetBITStatusResponse_Degradation>]: never; }>(object: I): GetBITStatusResponse_Degradation; }; export declare const GetTemperatureRequest: { encode(message: GetTemperatureRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetTemperatureRequest; fromJSON(object: any): GetTemperatureRequest; toJSON(message: GetTemperatureRequest): unknown; fromPartial<I extends { header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; } & { header?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined; } & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): GetTemperatureRequest; }; export declare const GetTemperatureResponse: { encode(message: GetTemperatureResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetTemperatureResponse; fromJSON(object: any): GetTemperatureResponse; toJSON(message: GetTemperatureResponse): unknown; fromPartial<I extends { header?: { requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; temps?: { channelName?: string | undefined; temperature?: number | undefined; }[] | undefined; } & { header?: ({ requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { requestHeader?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: ({ code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined; request?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; temps?: ({ channelName?: string | undefined; temperature?: number | undefined; }[] & ({ channelName?: string | undefined; temperature?: number | undefined; } & { channelName?: string | undefined; temperature?: number | undefined; } & { [K_5 in Exclude<keyof I["temps"][number], keyof Temperature>]: never; })[] & { [K_6 in Exclude<keyof I["temps"], keyof { channelName?: string | undefined; temperature?: number | undefined; }[]>]: never; }) | undefined; } & { [K_7 in Exclude<keyof I, keyof GetTemperatureResponse>]: never; }>(object: I): GetTemperatureResponse; }; export declare const GetSystemLogRequest: { encode(message: GetSystemLogRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetSystemLogRequest; fromJSON(object: any): GetSystemLogRequest; toJSON(message: GetSystemLogRequest): unknown; fromPartial<I extends { header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; } & { header?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined; } & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): GetSystemLogRequest; }; export declare const GetSystemLogResponse: { encode(message: GetSystemLogResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetSystemLogResponse; fromJSON(object: any): GetSystemLogResponse; toJSON(message: GetSystemLogResponse): unknown; fromPartial<I extends { header?: { requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; data?: { totalSize?: number | undefined; data?: Uint8Array | undefined; } | undefined; } & { header?: ({ requestHeader?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } | undefined; request?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { requestHeader?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined; requestReceivedTimestamp?: Date | undefined; responseTimestamp?: Date | undefined; error?: ({ code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; } & { code?: import("../header").CommonError_Code | undefined; message?: string | undefined; data?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined; request?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; data?: ({ totalSize?: number | undefined; data?: Uint8Array | undefined; } & { totalSize?: number | undefined; data?: Uint8Array | undefined; } & { [K_5 in Exclude<keyof I["data"], keyof DataChunk>]: never; }) | undefined; } & { [K_6 in Exclude<keyof I, keyof GetSystemLogResponse>]: never; }>(object: I): GetSystemLogResponse; }; declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined; export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]>; } : Partial<T>; declare type KeysOfUnion<T> = T extends T ? keyof T : never; export declare type Exact<P, I extends P> = P extends Builtin ? P : P & { [K in keyof P]: Exact<P[K], I[K]>; } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never; }; export {}; //# sourceMappingURL=health.d.ts.map