spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
411 lines • 18.2 kB
TypeScript
import { Duration } from "../../google/protobuf/duration";
import { RequestHeader, ResponseHeader } from "./header";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api";
/**
* Timestamp information from a full GRPC call round-trip.
* These are used to estimate the round-trip communication time and difference between
* client and server clocks.
*/
export interface TimeSyncRoundTrip {
/** Client system time when the message was sent, if not zero. */
clientTx: Date | undefined;
/** Server system time when the message was received, if not zero. */
serverRx: Date | undefined;
/** Server system time when the response was sent, if not zero. */
serverTx: Date | undefined;
/** Client time when the response was received, if not zero. */
clientRx: Date | undefined;
}
/**
* Estimate of network speed and clock skew. Both for the last
* complete sample and a recent average. Populated by the server.
*/
export interface TimeSyncEstimate {
/**
* Observed network delay (excludes processing between server_rx and server_tx).
* If zero, this estimate is unpopulated.
*/
roundTripTime: Duration | undefined;
/** Add the skew to the client system clock to get the server clock. */
clockSkew: Duration | undefined;
}
/** Current best estimate status of time sync. */
export interface TimeSyncState {
/** Best clock synchronization estimate currently available, if any. */
bestEstimate: TimeSyncEstimate | undefined;
/** STATUS_OK once time sync is established. */
status: TimeSyncState_Status;
/** Time of best estimate, in server time. */
measurementTime: Date | undefined;
}
export declare enum TimeSyncState_Status {
/** STATUS_UNKNOWN - Invalid, do not use. */
STATUS_UNKNOWN = 0,
/** STATUS_OK - Clock skew is available. */
STATUS_OK = 1,
/** STATUS_MORE_SAMPLES_NEEDED - More updates are required to establish a synchronization estimate. */
STATUS_MORE_SAMPLES_NEEDED = 2,
/** STATUS_SERVICE_NOT_READY - Server still establishing time sync internally. */
STATUS_SERVICE_NOT_READY = 3,
UNRECOGNIZED = -1
}
export declare function timeSyncState_StatusFromJSON(object: any): TimeSyncState_Status;
export declare function timeSyncState_StatusToJSON(object: TimeSyncState_Status): string;
/** Request message for a time-sync Update RPC. */
export interface TimeSyncUpdateRequest {
/** Common request header. */
header: RequestHeader | undefined;
/** Round-trip timing information from the previous Update request. */
previousRoundTrip: TimeSyncRoundTrip | undefined;
/**
* Identifier to verify time sync between robot and client. If unset, server will assign
* one to client.
*/
clockIdentifier: string;
}
/** Request message for a time-sync Update RPC. */
export interface TimeSyncUpdateResponse {
/** Common response header. */
header: ResponseHeader | undefined;
/** Clock synchronization estimate from the previous RPC round-trip, if available. */
previousEstimate: TimeSyncEstimate | undefined;
/** Current best clock synchronization estimate according to server. */
state: TimeSyncState | undefined;
/**
* Identifier to verify time sync between robot and client. Assigned upon first Request and
* echoed with each subsequent request.
*/
clockIdentifier: string;
}
export declare const TimeSyncRoundTrip: {
encode(message: TimeSyncRoundTrip, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TimeSyncRoundTrip;
fromJSON(object: any): TimeSyncRoundTrip;
toJSON(message: TimeSyncRoundTrip): unknown;
fromPartial<I extends {
clientTx?: Date | undefined;
serverRx?: Date | undefined;
serverTx?: Date | undefined;
clientRx?: Date | undefined;
} & {
clientTx?: Date | undefined;
serverRx?: Date | undefined;
serverTx?: Date | undefined;
clientRx?: Date | undefined;
} & { [K in Exclude<keyof I, keyof TimeSyncRoundTrip>]: never; }>(object: I): TimeSyncRoundTrip;
};
export declare const TimeSyncEstimate: {
encode(message: TimeSyncEstimate, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TimeSyncEstimate;
fromJSON(object: any): TimeSyncEstimate;
toJSON(message: TimeSyncEstimate): unknown;
fromPartial<I extends {
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
roundTripTime?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K in Exclude<keyof I["roundTripTime"], keyof Duration>]: never; }) | undefined;
clockSkew?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K_1 in Exclude<keyof I["clockSkew"], keyof Duration>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I, keyof TimeSyncEstimate>]: never; }>(object: I): TimeSyncEstimate;
};
export declare const TimeSyncState: {
encode(message: TimeSyncState, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TimeSyncState;
fromJSON(object: any): TimeSyncState;
toJSON(message: TimeSyncState): unknown;
fromPartial<I extends {
bestEstimate?: {
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} | undefined;
status?: TimeSyncState_Status | undefined;
measurementTime?: Date | undefined;
} & {
bestEstimate?: ({
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
roundTripTime?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K in Exclude<keyof I["bestEstimate"]["roundTripTime"], keyof Duration>]: never; }) | undefined;
clockSkew?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K_1 in Exclude<keyof I["bestEstimate"]["clockSkew"], keyof Duration>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["bestEstimate"], keyof TimeSyncEstimate>]: never; }) | undefined;
status?: TimeSyncState_Status | undefined;
measurementTime?: Date | undefined;
} & { [K_3 in Exclude<keyof I, keyof TimeSyncState>]: never; }>(object: I): TimeSyncState;
};
export declare const TimeSyncUpdateRequest: {
encode(message: TimeSyncUpdateRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TimeSyncUpdateRequest;
fromJSON(object: any): TimeSyncUpdateRequest;
toJSON(message: TimeSyncUpdateRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
previousRoundTrip?: {
clientTx?: Date | undefined;
serverRx?: Date | undefined;
serverTx?: Date | undefined;
clientRx?: Date | undefined;
} | undefined;
clockIdentifier?: string | 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;
previousRoundTrip?: ({
clientTx?: Date | undefined;
serverRx?: Date | undefined;
serverTx?: Date | undefined;
clientRx?: Date | undefined;
} & {
clientTx?: Date | undefined;
serverRx?: Date | undefined;
serverTx?: Date | undefined;
clientRx?: Date | undefined;
} & { [K_1 in Exclude<keyof I["previousRoundTrip"], keyof TimeSyncRoundTrip>]: never; }) | undefined;
clockIdentifier?: string | undefined;
} & { [K_2 in Exclude<keyof I, keyof TimeSyncUpdateRequest>]: never; }>(object: I): TimeSyncUpdateRequest;
};
export declare const TimeSyncUpdateResponse: {
encode(message: TimeSyncUpdateResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): TimeSyncUpdateResponse;
fromJSON(object: any): TimeSyncUpdateResponse;
toJSON(message: TimeSyncUpdateResponse): 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;
previousEstimate?: {
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} | undefined;
state?: {
bestEstimate?: {
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} | undefined;
status?: TimeSyncState_Status | undefined;
measurementTime?: Date | undefined;
} | undefined;
clockIdentifier?: string | 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;
previousEstimate?: ({
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
roundTripTime?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K_5 in Exclude<keyof I["previousEstimate"]["roundTripTime"], keyof Duration>]: never; }) | undefined;
clockSkew?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K_6 in Exclude<keyof I["previousEstimate"]["clockSkew"], keyof Duration>]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I["previousEstimate"], keyof TimeSyncEstimate>]: never; }) | undefined;
state?: ({
bestEstimate?: {
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} | undefined;
status?: TimeSyncState_Status | undefined;
measurementTime?: Date | undefined;
} & {
bestEstimate?: ({
roundTripTime?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
clockSkew?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
roundTripTime?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K_8 in Exclude<keyof I["state"]["bestEstimate"]["roundTripTime"], keyof Duration>]: never; }) | undefined;
clockSkew?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & { [K_9 in Exclude<keyof I["state"]["bestEstimate"]["clockSkew"], keyof Duration>]: never; }) | undefined;
} & { [K_10 in Exclude<keyof I["state"]["bestEstimate"], keyof TimeSyncEstimate>]: never; }) | undefined;
status?: TimeSyncState_Status | undefined;
measurementTime?: Date | undefined;
} & { [K_11 in Exclude<keyof I["state"], keyof TimeSyncState>]: never; }) | undefined;
clockIdentifier?: string | undefined;
} & { [K_12 in Exclude<keyof I, keyof TimeSyncUpdateResponse>]: never; }>(object: I): TimeSyncUpdateResponse;
};
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=time_sync.d.ts.map