UNPKG

thehandy

Version:

A TypeScript wrapper around the public REST API for The Handy

29 lines 1.86 kB
import { CommandResponse, CsvUploadResponse, HandyMode, ModeResponse, SetSpeedResponse, SetStrokeResponse, SettingsResponse, StatusResponse, SyncOffsetResponse, SyncPlayResponse, SyncPrepareResponse, VersionResponse } from "./typesLegacy"; /** Class to connect to and control a Handy using the HandyFeeling API V1 for devices with firmware v2.x. Will probably stop working eventually. And is no longer being suppoorted */ declare class Handy { _connectionKey: string; serverTimeOffset: number; constructor(connectionKey?: string); get connectionKey(): string; set connectionKey(connectionKey: string); setMode(mode: HandyMode): Promise<ModeResponse>; toggleMode(mode: HandyMode): Promise<ModeResponse>; setSpeed(speed: number, absolute?: boolean): Promise<SetSpeedResponse>; setStroke(speed: number, absolute?: boolean): Promise<SetStrokeResponse>; setStrokeZone(min: number, max: number): Promise<CommandResponse>; stepSpeed(directionUp: boolean): Promise<SetSpeedResponse>; stepStroke(directionUp: boolean): Promise<SetStrokeResponse>; getVersion(): Promise<VersionResponse>; getSettings(): Promise<SettingsResponse>; getStatus(): Promise<StatusResponse>; getServerTimeOffset(trips?: number, onProgress?: (progress: number) => void): Promise<number>; syncPrepare(scriptUrl: string, name?: string, size?: number): Promise<SyncPrepareResponse>; syncPlay(play?: boolean, time?: number): Promise<SyncPlayResponse>; syncOffset(offset: number): Promise<SyncOffsetResponse>; syncAdjustTimestamp(videoTimeSeconds: number, filter?: number): Promise<boolean>; uploadCsv(csv: File, filename?: string): Promise<CsvUploadResponse>; enforceConnectionKey(): void; getUrl(cmd: string): string; } export default Handy; //# sourceMappingURL=HandyLegacy.d.ts.map