spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
29 lines • 1.75 kB
TypeScript
import { DockingCommandResponse, DockingCommandFeedbackResponse, GetDockingConfigResponse, GetDockingStateResponse, DockingCommandRequest, DockingCommandFeedbackRequest, GetDockingConfigRequest, GetDockingStateRequest } from "./docking";
export declare const protobufPackage = "bosdyn.api.docking";
/**
* The DockingService provides an interface to dock and undock the robot from Spot Docks,
* as well as get feedback on command status, and get the current docked status of the robot.
*/
export interface DockingService {
/** Starts a docking command on the robot. */
DockingCommand(request: DockingCommandRequest): Promise<DockingCommandResponse>;
/** Check the status of a docking command. */
DockingCommandFeedback(request: DockingCommandFeedbackRequest): Promise<DockingCommandFeedbackResponse>;
/** Get the configured dock ID ranges. */
GetDockingConfig(request: GetDockingConfigRequest): Promise<GetDockingConfigResponse>;
/** Get the robot's docking state */
GetDockingState(request: GetDockingStateRequest): Promise<GetDockingStateResponse>;
}
export declare class DockingServiceClientImpl implements DockingService {
private readonly rpc;
constructor(rpc: Rpc);
DockingCommand(request: DockingCommandRequest): Promise<DockingCommandResponse>;
DockingCommandFeedback(request: DockingCommandFeedbackRequest): Promise<DockingCommandFeedbackResponse>;
GetDockingConfig(request: GetDockingConfigRequest): Promise<GetDockingConfigResponse>;
GetDockingState(request: GetDockingStateRequest): Promise<GetDockingStateResponse>;
}
interface Rpc {
request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
}
export {};
//# sourceMappingURL=docking_service.d.ts.map