Class UHIDDevice

UHID Device Class

Hierarchy

any
- UHIDDevice

Index

Constructors

constructor

Methods

close create destroy getReportReply input off on once open poll setReportReply

Constructors

constructor

new UHIDDevice(): UHIDDevice
Returns UHIDDevice
Overrides uhid.UHIDDevice.constructor
- Defined in UHIDDevice.ts:80

Methods

close

close(): void
Closes communication with the device.

Returns void
- Defined in UHIDDevice.ts:182

create

create(options): void
Create a new UHID Device, with given parameters.
Parameters
- options: {
      bus: UHIDBusType;
      country: number;
      data: Buffer;
      name: string;
      product: number;
      vendor: number;
      version: number;
  }
  - bus: UHIDBusType
  - country: number
  - data: Buffer
  - name: string
  - product: number
  - vendor: number
  - version: number
Returns void
- Defined in UHIDDevice.ts:124

destroy

destroy(): void
Destroy the UHID Device. Closes device if open.

Returns void
- Defined in UHIDDevice.ts:139

getReportReply

getReportReply(options): void
Send a feature request report to the device.
Parameters
- options: {
      data: Buffer;
      err: number;
      id: number;
  }
  - data: Buffer
  - err: number
  - id: number
Returns void
- Defined in UHIDDevice.ts:153

input

input(data): void
Send an input report to the device
Parameters
- data: Buffer
Returns void
- Defined in UHIDDevice.ts:146

off

off(event, listener): void
Parameters
- event: "start"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDStartEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:109
off(event, listener): void
Parameters
- event: "stop"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:110
off(event, listener): void
Parameters
- event: "open"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:111
off(event, listener): void
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:112
off(event, listener): void
Parameters
- event: "output"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDOutputEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:113
off(event, listener): void
Parameters
- event: "getReport"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDGetReportEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:114
off(event, listener): void
Parameters
- event: "setReport"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDSetReportEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:115

on

on(event, listener): void
Parameters
- event: "start"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDStartEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:85
on(event, listener): void
Parameters
- event: "stop"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:86
on(event, listener): void
Parameters
- event: "open"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:87
on(event, listener): void
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:88
on(event, listener): void
Parameters
- event: "output"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDOutputEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:89
on(event, listener): void
Parameters
- event: "getReport"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDGetReportEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:90
on(event, listener): void
Parameters
- event: "setReport"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDSetReportEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:91

once

once(event, listener): void
Parameters
- event: "start"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDStartEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:97
once(event, listener): void
Parameters
- event: "stop"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:98
once(event, listener): void
Parameters
- event: "open"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:99
once(event, listener): void
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in UHIDDevice.ts:100
once(event, listener): void
Parameters
- event: "output"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDOutputEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:101
once(event, listener): void
Parameters
- event: "getReport"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDGetReportEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:102
once(event, listener): void
Parameters
- event: "setReport"
- listener: ((e) => void)
  - - (e): void
    - Parameters
      
      e: UHIDSetReportEvent
      
      Returns void
Returns void
- Defined in UHIDDevice.ts:103

open

open(): void
Opens communication with the device. This has to be run before any other commands.

Returns void
- Defined in UHIDDevice.ts:175

poll

poll(): void
Poll device for any new events.

Returns void
- Defined in UHIDDevice.ts:167

setReportReply

setReportReply(options): void
Send a feature report to the device.
Parameters
- options: {
  err: number;
  id: number;
  }
  - err: number
  - id: number
Returns void
- Defined in UHIDDevice.ts:160

Class UHIDDevice

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns UHIDDevice

Methods

close

Returns void

create

Parameters

options: { bus: UHIDBusType; country: number; data: Buffer; name: string; product: number; vendor: number; version: number; }

bus: UHIDBusType

country: number

data: Buffer

name: string

product: number

vendor: number

version: number

Returns void

destroy

Returns void

getReportReply

Parameters

options: { data: Buffer; err: number; id: number; }

data: Buffer

err: number

id: number

Returns void

input

Parameters

data: Buffer

Returns void

off

Parameters

event: "start"

listener: ((e) => void)

Parameters

e: UHIDStartEvent

Returns void

Returns void

Parameters

event: "stop"

listener: (() => void)

Returns void

Returns void

Parameters

event: "open"

listener: (() => void)

Returns void

Returns void

Parameters

event: "close"

listener: (() => void)

Returns void

Returns void

Parameters

event: "output"

listener: ((e) => void)

Parameters

e: UHIDOutputEvent

Returns void

Returns void

Parameters

event: "getReport"

listener: ((e) => void)

Parameters

e: UHIDGetReportEvent

Returns void

Returns void

Parameters

event: "setReport"

listener: ((e) => void)

Parameters

e: UHIDSetReportEvent

Returns void

Returns void

on

options: {
bus: UHIDBusType;
country: number;
data: Buffer;
name: string;
product: number;
vendor: number;
version: number;
}

options: {
data: Buffer;
err: number;
id: number;
}