nodehid.d.ts

// Type definitions for node-hid 1.3
// Project: https://github.com/node-hid/node-hid#readme
// Definitions by: Mohamed Hegazy <https://github.com/mhegazy>
//                 Robert Kiss <https://github.com/ert78gb>
//                 Rob Moran <https://github.com/thegecko>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import { EventEmitter } from 'events'

export interface Device {
    vendorId: number
    productId: number
    path?: string | undefined
    serialNumber?: string | undefined
    manufacturer?: string | undefined
    product?: string | undefined
    release: number
    interface: number
    usagePage?: number | undefined
    usage?: number | undefined
}

export class HID extends EventEmitter {
    constructor(path: string)
    constructor(vid: number, pid: number)
    close(): void
    pause(): void
    read(callback: (err: any, data: number[]) => void): void
    readSync(): number[]
    readTimeout(time_out: number): number[]
    sendFeatureReport(data: number[] | Buffer): number
    getFeatureReport(report_id: number, report_length: number): number[]
    resume(): void
    write(values: number[] | Buffer): number
    setNonBlocking(no_block: boolean): void
    generateDeviceInfo(): Device
}
export function devices(vid: number, pid: number): Device[]
export function devices(): Device[]

export function devicesAsync(vid: number, pid: number): Promise<Device[]>
export function devicesAsync(): Promise<Device[]>

export class HIDAsync extends EventEmitter {
    private constructor()

    static open(path: string): Promise<HIDAsync>
    static open(vid: number, pid: number): Promise<HIDAsync>

    close(): Promise<void>
    pause(): void
    read(time_out?: number | undefined): Promise<Buffer | undefined>
    sendFeatureReport(data: number[] | Buffer): Promise<number>
    getFeatureReport(report_id: number, report_length: number): Promise<Buffer>
    resume(): void
    write(values: number[] | Buffer): Promise<number>
    setNonBlocking(no_block: boolean): Promise<void>
    generateDeviceInfo(): Promise<Device>
}

export function setDriverType(type: 'hidraw' | 'libusb'): void