Class Device

constructor

• new Device(): Device

• Returns Device

Optional_bosDescriptor

busNumber

deviceAddress

deviceDescriptor

interfaces

portNumbers

allConfigDescriptors

• get allConfigDescriptors(): ConfigDescriptor[]

• Contains all config descriptors of the device (same structure as .configDescriptor above)

  Returns ConfigDescriptor[]

configDescriptor

• get configDescriptor(): undefined | ConfigDescriptor

• Object with properties for the fields of the active configuration descriptor.

  Returns undefined | ConfigDescriptor

parent

• get parent(): Device

• Contains the parent of the device, such as a hub. If there is no parent this property is set to null.

  Returns Device

timeout

• get timeout(): number

• Timeout in milliseconds to use for control transfers.

  Returns number
• set timeout(value): void

• Parameters

  • value: number

  Returns void

__attachKernelDriver

• __attachKernelDriver(addr): void

• Parameters

  • addr: number

  Returns void

__claimInterface

• __claimInterface(addr): void

• Parameters

  • addr: number

  Returns void

__clearHalt

• __clearHalt(addr, callback): void

• Parameters

  • addr: number
  • callback: ((error?: LibUSBException) => void)
    • • (error?): void

      • Parameters

        • Optionalerror: LibUSBException

        Returns void

  Returns void

__close

• __close(): void

• Returns void

__detachKernelDriver

• __detachKernelDriver(addr): void

• Parameters

  • addr: number

  Returns void

__getAllConfigDescriptors

• __getAllConfigDescriptors(): ConfigDescriptor[]

• Returns ConfigDescriptor[]

__getConfigDescriptor

• __getConfigDescriptor(): ConfigDescriptor

• Returns ConfigDescriptor

__getParent

• __getParent(): Device

• Returns Device

__isKernelDriverActive

• __isKernelDriverActive(addr): boolean

• Parameters

  • addr: number

  Returns boolean

__open

• __open(): void

• Returns void

__releaseInterface

• __releaseInterface(addr, callback): void

• Parameters

  • addr: number
  • callback: ((error?: LibUSBException) => void)
    • • (error?): void

      • Parameters

        • Optionalerror: LibUSBException

        Returns void

  Returns void

__setConfiguration

• __setConfiguration(desired, callback): void

• Parameters

  • desired: number
  • callback: ((error?: LibUSBException) => void)
    • • (error?): void

      • Parameters

        • Optionalerror: LibUSBException

        Returns void

  Returns void

__setInterface

• __setInterface(addr, altSetting, callback): void

• Parameters

  • addr: number
  • altSetting: number
  • callback: ((error?: LibUSBException) => void)
    • • (error?): void

      • Parameters

        • Optionalerror: LibUSBException

        Returns void

  Returns void

close

• close(this): void

• Close the device.

  The device must be open to use this method.

  Parameters

  • this: Device

  Returns void

controlTransfer

• controlTransfer(this, bmRequestType, bRequest, wValue, wIndex, data_or_length, callback?): Device

• Perform a control transfer with libusb_control_transfer.

  Parameter data_or_length can be an integer length for an IN transfer, or a Buffer for an OUT transfer. The type must match the direction specified in the MSB of bmRequestType.

  The data parameter of the callback is actual transferred for OUT transfers, or will be passed a Buffer for IN transfers.

  The device must be open to use this method.

  Parameters

  • this: Device
  • bmRequestType: number
  • bRequest: number
  • wValue: number
  • wIndex: number
  • data_or_length: number | Buffer
  • Optionalcallback: ((error: undefined | LibUSBException, buffer: undefined | number | Buffer) => void)
    • • (error, buffer): void

      • Parameters

        • error: undefined | LibUSBException
        • buffer: undefined | number | Buffer

        Returns void

  Returns Device

getBosDescriptor

• getBosDescriptor(this, callback): void

• Perform a control transfer to retrieve an object with properties for the fields of the Binary Object Store descriptor.

  The device must be open to use this method.

  Parameters

  • this: Device
  • callback: ((error?: LibUSBException, descriptor?: BosDescriptor) => void)
    • • (error?, descriptor?): void

      • Parameters

        • Optionalerror: LibUSBException
        • Optionaldescriptor: BosDescriptor

        Returns void

  Returns void

getCapabilities

• getCapabilities(this, callback): void

• Retrieve a list of Capability objects for the Binary Object Store capabilities of the device.

  The device must be open to use this method.

  Parameters

  • this: Device
  • callback: ((error: undefined | LibUSBException, capabilities?: Capability[]) => void)
    • • (error, capabilities?): void

      • Parameters

        • error: undefined | LibUSBException
        • Optionalcapabilities: Capability[]

        Returns void

  Returns void

getStringDescriptor

• getStringDescriptor(this, desc_index, callback): void

• Perform a control transfer to retrieve a string descriptor

  The device must be open to use this method.

  Parameters

  • this: Device
  • desc_index: number
  • callback: ((error?: LibUSBException, value?: string) => void)
    • • (error?, value?): void

      • Parameters

        • Optionalerror: LibUSBException
        • Optionalvalue: string

        Returns void

  Returns void

interface

• interface(this, addr): Interface

• Return the interface with the specified interface number.

  The device must be open to use this method.

  Parameters

  • this: Device
  • addr: number

  Returns Interface

open

• open(this, defaultConfig?): void

• Open the device.

  Parameters

  • this: Device
  • defaultConfig: boolean = true

  Returns void

reset

• reset(callback): void

• Performs a reset of the device. Callback is called when complete.

  The device must be open to use this method.

  Parameters

  • callback: ((error?: LibUSBException) => void)
    • • (error?): void

      • Parameters

        • Optionalerror: LibUSBException

        Returns void

  Returns void

setConfiguration

• setConfiguration(this, desired, callback?): void

• Set the device configuration to something other than the default (0). To use this, first call .open(false) (which tells it not to auto configure), then before claiming an interface, call this method.

  The device must be open to use this method.

  Parameters

  • this: Device
  • desired: number
  • Optionalcallback: ((error: undefined | LibUSBException) => void)
    • • (error): void

      • Parameters

        • error: undefined | LibUSBException

        Returns void

  Returns void