Class UHIDDevice

UHID Device Class

Hierarchy

  • any
    • UHIDDevice

Constructors

Methods

  • Closes communication with the device.

    Returns 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

  • Destroy the UHID Device. Closes device if open.

    Returns 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

  • Send an input report to the device

    Parameters

    • data: Buffer

    Returns void

  • Parameters

    • event: "start"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "stop"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "open"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "output"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "getReport"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "setReport"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "start"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "stop"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "open"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "output"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "getReport"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "setReport"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "start"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "stop"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "open"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • event: "output"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "getReport"
    • listener: ((e) => void)

    Returns void

  • Parameters

    • event: "setReport"
    • listener: ((e) => void)

    Returns void

  • Opens communication with the device. This has to be run before any other commands.

    Returns void

  • Poll device for any new events.

    Returns void

  • Send a feature report to the device.

    Parameters

    • options: {
          err: number;
          id: number;
      }
      • err: number
      • id: number

    Returns void

Generated using TypeDoc