UNPKG

spot-sdk-ts

Version:

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

682 lines 30.5 kB
import { Any } from "../../../google/protobuf/any"; import { Duration } from "../../../google/protobuf/duration"; import { RequestHeader, ResponseHeader } from "../header"; import { Lease } from "../lease"; import _m0 from "protobufjs/minimal"; export declare const protobufPackage = "bosdyn.api.auto_return"; /** Parameters to AutoReturn actions. */ export interface Params { /** * Robot-specific mobility parameters to use. * For example, see bosdyn.api.spot.MobilityParams. */ mobilityParams: Any | undefined; /** * Allow AutoReturn to move the robot this far in the XY plane from the location where * AutoReturn started. Travel along the Z axis (which is gravity-aligned) does not count. * Must be > 0. */ maxDisplacement: number; /** * Optionally specify the maximum amount of time AutoReturn can take. * If this duration is exceeded, AutoReturn will stop trying to move the robot. * Omit to try indefinitely. Robot may become stuck and never take other comms loss actions! */ maxDuration: Duration | undefined; } /** Configure the AutoReturn system. */ export interface ConfigureRequest { /** Common request header. */ header: RequestHeader | undefined; /** * Leases that AutoReturn may use to accomplish its goals when AutoReturn automatically * triggers. If left empty, AutoReturn will not automatically trigger. */ leases: Lease[]; /** Parameters to use when AutoReturn automatically triggers. */ params: Params | undefined; /** * Forget any buffered locations the robot may be remembering. Defaults to false. * Set to true if the robot has just crossed an area it should not traverse in AutoReturn. */ clearBuffer: boolean; } /** Response to a configuration request. */ export interface ConfigureResponse { /** Common response header. */ header: ResponseHeader | undefined; /** Return status for the request. */ status: ConfigureResponse_Status; /** If status is STATUS_INVALID_PARAMS, this contains the settings that were invalid. */ invalidParams: Params | undefined; } export declare enum ConfigureResponse_Status { STATUS_UNKNOWN = 0, STATUS_OK = 1, STATUS_INVALID_PARAMS = 2, UNRECOGNIZED = -1 } export declare function configureResponse_StatusFromJSON(object: any): ConfigureResponse_Status; export declare function configureResponse_StatusToJSON(object: ConfigureResponse_Status): string; /** Ask for the current configuration. */ export interface GetConfigurationRequest { /** Common request header. */ header: RequestHeader | undefined; } /** Response to a "get configuration" request. */ export interface GetConfigurationResponse { /** Common response header. */ header: ResponseHeader | undefined; /** A simple yes/no, will AutoReturn automatically trigger. */ enabled: boolean; /** * The most recent successful ConfigureRequest. * Will be empty if service has not successfully been configured. */ request: ConfigureRequest | undefined; } /** Start AutoReturn behavior now. */ export interface StartRequest { /** Common request header. */ header: RequestHeader | undefined; } export interface StartResponse { /** Common response header. */ header: ResponseHeader | undefined; } export declare const Params: { encode(message: Params, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): Params; fromJSON(object: any): Params; toJSON(message: Params): unknown; fromPartial<I extends { mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } & { mobilityParams?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K in Exclude<keyof I["mobilityParams"], keyof Any>]: never; }) | undefined; maxDisplacement?: number | undefined; maxDuration?: ({ seconds?: number | undefined; nanos?: number | undefined; } & { seconds?: number | undefined; nanos?: number | undefined; } & { [K_1 in Exclude<keyof I["maxDuration"], keyof Duration>]: never; }) | undefined; } & { [K_2 in Exclude<keyof I, keyof Params>]: never; }>(object: I): Params; }; export declare const ConfigureRequest: { encode(message: ConfigureRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): ConfigureRequest; fromJSON(object: any): ConfigureRequest; toJSON(message: ConfigureRequest): unknown; fromPartial<I extends { header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; leases?: { resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[] | undefined; params?: { mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } | undefined; clearBuffer?: boolean | 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; leases?: ({ resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[] & ({ resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; } & { resource?: string | undefined; epoch?: string | undefined; sequence?: (number[] & number[] & { [K_1 in Exclude<keyof I["leases"][number]["sequence"], keyof number[]>]: never; }) | undefined; clientNames?: (string[] & string[] & { [K_2 in Exclude<keyof I["leases"][number]["clientNames"], keyof string[]>]: never; }) | undefined; } & { [K_3 in Exclude<keyof I["leases"][number], keyof Lease>]: never; })[] & { [K_4 in Exclude<keyof I["leases"], keyof { resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[]>]: never; }) | undefined; params?: ({ mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } & { mobilityParams?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_5 in Exclude<keyof I["params"]["mobilityParams"], keyof Any>]: never; }) | undefined; maxDisplacement?: number | undefined; maxDuration?: ({ seconds?: number | undefined; nanos?: number | undefined; } & { seconds?: number | undefined; nanos?: number | undefined; } & { [K_6 in Exclude<keyof I["params"]["maxDuration"], keyof Duration>]: never; }) | undefined; } & { [K_7 in Exclude<keyof I["params"], keyof Params>]: never; }) | undefined; clearBuffer?: boolean | undefined; } & { [K_8 in Exclude<keyof I, keyof ConfigureRequest>]: never; }>(object: I): ConfigureRequest; }; export declare const ConfigureResponse: { encode(message: ConfigureResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): ConfigureResponse; fromJSON(object: any): ConfigureResponse; toJSON(message: ConfigureResponse): 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; status?: ConfigureResponse_Status | undefined; invalidParams?: { mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | 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 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 Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; status?: ConfigureResponse_Status | undefined; invalidParams?: ({ mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } & { mobilityParams?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_5 in Exclude<keyof I["invalidParams"]["mobilityParams"], keyof Any>]: never; }) | undefined; maxDisplacement?: number | undefined; maxDuration?: ({ seconds?: number | undefined; nanos?: number | undefined; } & { seconds?: number | undefined; nanos?: number | undefined; } & { [K_6 in Exclude<keyof I["invalidParams"]["maxDuration"], keyof Duration>]: never; }) | undefined; } & { [K_7 in Exclude<keyof I["invalidParams"], keyof Params>]: never; }) | undefined; } & { [K_8 in Exclude<keyof I, keyof ConfigureResponse>]: never; }>(object: I): ConfigureResponse; }; export declare const GetConfigurationRequest: { encode(message: GetConfigurationRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetConfigurationRequest; fromJSON(object: any): GetConfigurationRequest; toJSON(message: GetConfigurationRequest): 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): GetConfigurationRequest; }; export declare const GetConfigurationResponse: { encode(message: GetConfigurationResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetConfigurationResponse; fromJSON(object: any): GetConfigurationResponse; toJSON(message: GetConfigurationResponse): 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; enabled?: boolean | undefined; request?: { header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; leases?: { resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[] | undefined; params?: { mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } | undefined; clearBuffer?: boolean | 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 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 Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; enabled?: boolean | undefined; request?: ({ header?: { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } | undefined; leases?: { resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[] | undefined; params?: { mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } | undefined; clearBuffer?: boolean | undefined; } & { header?: ({ requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { requestTimestamp?: Date | undefined; clientName?: string | undefined; disableRpcLogging?: boolean | undefined; } & { [K_5 in Exclude<keyof I["request"]["header"], keyof RequestHeader>]: never; }) | undefined; leases?: ({ resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[] & ({ resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; } & { resource?: string | undefined; epoch?: string | undefined; sequence?: (number[] & number[] & { [K_6 in Exclude<keyof I["request"]["leases"][number]["sequence"], keyof number[]>]: never; }) | undefined; clientNames?: (string[] & string[] & { [K_7 in Exclude<keyof I["request"]["leases"][number]["clientNames"], keyof string[]>]: never; }) | undefined; } & { [K_8 in Exclude<keyof I["request"]["leases"][number], keyof Lease>]: never; })[] & { [K_9 in Exclude<keyof I["request"]["leases"], keyof { resource?: string | undefined; epoch?: string | undefined; sequence?: number[] | undefined; clientNames?: string[] | undefined; }[]>]: never; }) | undefined; params?: ({ mobilityParams?: { typeUrl?: string | undefined; value?: Uint8Array | undefined; } | undefined; maxDisplacement?: number | undefined; maxDuration?: { seconds?: number | undefined; nanos?: number | undefined; } | undefined; } & { mobilityParams?: ({ typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { typeUrl?: string | undefined; value?: Uint8Array | undefined; } & { [K_10 in Exclude<keyof I["request"]["params"]["mobilityParams"], keyof Any>]: never; }) | undefined; maxDisplacement?: number | undefined; maxDuration?: ({ seconds?: number | undefined; nanos?: number | undefined; } & { seconds?: number | undefined; nanos?: number | undefined; } & { [K_11 in Exclude<keyof I["request"]["params"]["maxDuration"], keyof Duration>]: never; }) | undefined; } & { [K_12 in Exclude<keyof I["request"]["params"], keyof Params>]: never; }) | undefined; clearBuffer?: boolean | undefined; } & { [K_13 in Exclude<keyof I["request"], keyof ConfigureRequest>]: never; }) | undefined; } & { [K_14 in Exclude<keyof I, keyof GetConfigurationResponse>]: never; }>(object: I): GetConfigurationResponse; }; export declare const StartRequest: { encode(message: StartRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): StartRequest; fromJSON(object: any): StartRequest; toJSON(message: StartRequest): 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): StartRequest; }; export declare const StartResponse: { encode(message: StartResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): StartResponse; fromJSON(object: any): StartResponse; toJSON(message: StartResponse): 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 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 Any>]: never; }) | undefined; } & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined; } & { [K_5 in Exclude<keyof I, "header">]: never; }>(object: I): StartResponse; }; 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=auto_return.d.ts.map