Class Device

interfaces

allConfigDescriptors

• get allConfigDescriptors(): ConfigDescriptor[]

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

  Returns ConfigDescriptor[]

configDescriptor

• get configDescriptor(): ConfigDescriptor | undefined

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

  Returns ConfigDescriptor | undefined

parent

• get parent(): usb.Device

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

  Returns usb.Device

timeout

• get timeout(): number

  Timeout in milliseconds to use for control transfers.

  Returns number

• set timeout(value: number): void

  Parameters

  • value: number

  Returns void

close

• close(this: usb.Device): void

  Close the device.

  The device must be open to use this method.

  Parameters

  • this: usb.Device

  Returns void

controlTransfer

• controlTransfer(
      this: usb.Device,
      bmRequestType: number,
      bRequest: number,
      wValue: number,
      wIndex: number,
      data_or_length: number | Buffer<ArrayBufferLike>,
      callback?: (
          error: usb.LibUSBException | undefined,
          buffer: number | Buffer<ArrayBufferLike> | undefined,
      ) => void,
  ): usb.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: usb.Device
  • bmRequestType: number
  • bRequest: number
  • wValue: number
  • wIndex: number
  • data_or_length: number | Buffer<ArrayBufferLike>
  • Optionalcallback: (
        error: usb.LibUSBException | undefined,
        buffer: number | Buffer<ArrayBufferLike> | undefined,
    ) => void

  Returns usb.Device

getBosDescriptor

• getBosDescriptor(
      this: usb.Device,
      callback: (error?: usb.LibUSBException, descriptor?: BosDescriptor) => void,
  ): 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: usb.Device
  • callback: (error?: usb.LibUSBException, descriptor?: BosDescriptor) => void

  Returns void

getCapabilities

• getCapabilities(
      this: usb.Device,
      callback: (
          error: usb.LibUSBException | undefined,
          capabilities?: Capability[],
      ) => void,
  ): 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: usb.Device
  • callback: (error: usb.LibUSBException | undefined, capabilities?: Capability[]) => void

  Returns void

getStringDescriptor

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

  Perform a control transfer to retrieve a string descriptor

  The device must be open to use this method.

  Parameters

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

  Returns void

interface

• interface(this: usb.Device, addr: number): Interface

  Return the interface with the specified interface number.

  The device must be open to use this method.

  Parameters

  • this: usb.Device
  • addr: number

  Returns Interface

open

• open(this: usb.Device, defaultConfig?: boolean): void

  Open the device.

  Parameters

  • this: usb.Device
  • defaultConfig: boolean = true

  Returns void

setAutoDetachKernelDriver

• setAutoDetachKernelDriver(enable: boolean): void

  Enable/disable libusb's automatic kernel driver detachment When this is enabled libusb will automatically detach the kernel driver on an interface when claiming the interface, and attach it when releasing the interface

  The device must be open to use this method.

  Parameters

  • enable: boolean

  Returns void

setConfiguration

• setConfiguration(
      this: usb.Device,
      desired: number,
      callback?: (error: usb.LibUSBException | undefined) => void,
  ): 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: usb.Device
  • desired: number
  • Optionalcallback: (error: usb.LibUSBException | undefined) => void

  Returns void