shuttle-node
Version:
An npm module for interfacing with the Contour Shuttle devices in Node.js
15 lines • 913 B
TypeScript
import { Shuttle } from '@shuttle-lib/core';
import * as HID from 'node-hid';
import type { usb } from 'usb';
import { HID_Device } from './api.js';
/** Sets up a connection to a HID device (the Shuttle device) */
export declare function setupShuttle(): Promise<Shuttle>;
export declare function setupShuttle(HIDDevice: HID.Device): Promise<Shuttle>;
export declare function setupShuttle(HIDDevice: HID.HIDAsync): Promise<Shuttle>;
export declare function setupShuttle(devicePath: string): Promise<Shuttle>;
/** Returns a list of all connected Shuttle-HID-devices */
export declare function listAllConnectedDevices(): Promise<HID_Device[]>;
/** Returns a list of all connected Shuttle-HID-devices */
export declare function isAShuttleDevice(device: HID.Device | usb.Device): boolean;
export declare function isUSBDevice(device: HID.Device | usb.Device): device is usb.Device;
//# sourceMappingURL=methods.d.ts.map