Home  Contents

rawio:usbInfo

Rawio Core4 Lua Event System

SYNOPSIS

  1. table = handle:usbInfo()
  2. handle:usbInfo(table)

DESCRIPTION

The command is used to set and query the configuration of a USB connection. The first form sets, the second form queries the current configuration.

For client devices connected to a USB host port, it is only possible to query for information.

The USB device port of the controller can be configured as a HID device. For that port it is possible to both set and query the information. Please see the introduction to USB HID support
for detailed information.

Description of the table contents.

vid The USB vendor ID. This is a publicly registered identification number of the manufacturer of the device. The official USB homepage should have a list.
pid The USB product ID. This number is allocated by the manufacturer and identifies the device type.
vendor The name of the device vendor, as reported by the device.
product The name of the product, as reported by the device.
serial The serial number of the device. Not all USB devices do have a serial number, so this field might be empty.
locid (Host ports only) The USB location ID of the device.

RETURN VALUE

On succes, the query form returns a table, the set form returns true. On error, returns nil. In case of an error, the error can be retrieved using rawio:lastError().

NOTES

Client device info is currently only available for USB printer devices.

An USB location ID consists of one or more digits. Each digit numbers the port at the USB hub where the device is connected.

A device connected directly to the controller has a location ID consisting of a single digit, .e.g '1'. When using one hub, the location ID has two digits, .e.g '14': First port on controller, fourth port on hub.

SEE ALSO