A B C D E F G H I K L M N P R S T U W

A

addUSBListener(USBListener) - Method in interface usb.core.Host

Adds a callback for USB structure changes

addUSBListener(USBListener) - Method in class usb.remote.HostProxy

ATTR_REMOTE_WAKEUP - Static variable in class usb.core.Configuration

If this bit is set in an attribute mask, this configuration supports remote wakeup (which must be separately enabled).

ATTR_SELF_POWERED - Static variable in class usb.core.Configuration

If this bit is set in an attribute mask, this configuration provides some of its own power in addition to drawing the amount of power described by Configuration.getMaxPower().

B

Bus - interface usb.core.Bus.

A Universal Serial Bus connects a set of (USB) devices to a Host.

busAdded(Bus) - Method in class usb.core.USBListenerAdapter

busAdded(Bus) - Method in interface usb.core.USBListener

New bus added.

busAdded(Bus) - Method in class usb.remote.USBListenerProxy

busRemoved(Bus) - Method in class usb.core.USBListenerAdapter

busRemoved(Bus) - Method in interface usb.core.USBListener

Bus removed.

busRemoved(Bus) - Method in class usb.remote.USBListenerProxy

C

C_HUB_LOCAL_POWER - Static variable in class usb.core.Hub

Hub change indicator, indicating local power

C_HUB_OVER_CURRENT - Static variable in class usb.core.Hub

Hub change indicator, indicating overcurrent status (for safety).

C_PORT_CONNECTION - Static variable in class usb.core.Hub

Port feature selector, indicating a device was attached or detached.

C_PORT_ENABLE - Static variable in class usb.core.Hub

Port feature selector, indicating a port disabled due to error.

C_PORT_OVER_CURRENT - Static variable in class usb.core.Hub

Port feature selector, reporting changed per-port overcurrent status.

C_PORT_RESET - Static variable in class usb.core.Hub

Port feature selector, indicating reset processing is complete.

C_PORT_SUSPEND - Static variable in class usb.core.Hub

Port feature selector, indicating port resume is complete.

children() - Method in class usb.view.USBNode

Not implemented.

claim() - Method in class usb.core.Interface

Claims this interface if it is not claimed by some other module, and assigns the appropriate alternate setting.

claimInterface(int) - Method in interface usb.core.DeviceSPI

Claims a particular interface in the current configuration.

claimInterface(int) - Method in class usb.windows.DeviceImpl

Claims this interface, so that no other driver can.

CLASS_APP_SPECIFIC - Static variable in class usb.core.Descriptor

Identifier for application-specific interfaces.

CLASS_AUDIO - Static variable in class usb.core.Descriptor

Identifier for audio class interfaces.

CLASS_COMM - Static variable in class usb.core.Descriptor

Identifier for communications control class interfaces.

CLASS_DATA - Static variable in class usb.core.Descriptor

Identifier for communications data class interfaces.

CLASS_HID - Static variable in class usb.core.Descriptor

Identifier for Human Interaction Device (HID) class interfaces.

CLASS_HUB - Static variable in class usb.core.Descriptor

Identifier for hub class interfaces.

CLASS_MASS_STORAGE - Static variable in class usb.core.Descriptor

Identifier for mass storage class interfaces.

CLASS_PRINTER - Static variable in class usb.core.Descriptor

Identifier for printer class interfaces.

CLASS_VENDOR_SPECIFIC - Static variable in class usb.core.Descriptor

Identifier for vendor-specific interfaces.

CLEAR_FEATURE - Static variable in class usb.core.ControlMessage

Request value (1) used to clear device feature flags.

clearFeature(Device, int, int, int) - Static method in class usb.core.ControlMessage

Clears the identified feature flag to false.

clearHalt() - Method in class usb.core.Endpoint

Clears a halt status (stall) on the bulk endpoint.

clearHalt(byte) - Method in interface usb.core.DeviceSPI

Clears halt/stall status on an endpoint.

clearHalt(byte) - Method in class usb.windows.DeviceImpl

clone(Device) - Method in class usb.core.DeviceDescriptor

clone(Device) - Method in class usb.core.Configuration

close() - Method in class usb.linux.HID

Closes the underlying "event device" file handle

close() - Method in class usb.util.USBSocket

Releases the interface, so that some other software driver can use it to access this device.

close() - Method in class usb.devices.Rio500

After you close this object, other drivers can access this particular MP3 player.

close() - Method in class usb.devices.Kodak

Configuration - class usb.core.Configuration.

Provides access to a USB configuration supported by a device, and to the interfaces associated with that configuration.

Configuration(Device, byte[]) - Constructor for class usb.core.Configuration

control(ControlMessage) - Method in class usb.core.Device

Sends a control message to the device, optionally sending or receiving associated data.

ControlMessage - class usb.core.ControlMessage.

This class supports control messaging with convenience methods for common calls, and encapsulates data for all control requests.

ControlMessage() - Constructor for class usb.core.ControlMessage

Constructs an uninitialized control mesage

createHost() - Method in class usb.core.HostFactory

Not part of the API.

createHost() - Method in class usb.linux.Linux

Not part of the API; implements reference implementation SPI.

createHost() - Method in class usb.remote.RemoteHostFactory

Not part of the API.

createHost() - Method in class usb.windows.Windows

Not part of the API; implements reference implementation SPI.

cyclePort() - Method in class usb.windows.DeviceImpl

cyclePortWorks() - Method in class usb.windows.DeviceImpl

D

Descriptor - class usb.core.Descriptor.

This is a base class for entities with USB typed descriptors.

Descriptor() - Constructor for class usb.core.Descriptor

Used when deserializing.

Descriptor(byte[]) - Constructor for class usb.core.Descriptor

Creates and initializes a descriptor

dev - Variable in class usb.view.USBNode

The device node which is associated with this node, or null.

Device - class usb.core.Device.

Provides access to a USB device.

DEVICE_REMOTE_WAKEUP - Static variable in class usb.core.Device

Device status bit used to enable and disable remote wakeup; this feature may be set and cleared.

DEVICE_SELFPOWERED - Static variable in class usb.core.Device

Device status bit that reports the device is self powered.

Device() - Constructor for class usb.core.Device

Used when deserializing.

Device(DeviceSPI, Bus, int) - Constructor for class usb.core.Device

Used by implementations of Host and Bus.

deviceAdded(Device) - Method in class usb.core.USBListenerAdapter

deviceAdded(Device) - Method in interface usb.core.USBListener

New device added.

deviceAdded(Device) - Method in class usb.remote.USBListenerProxy

DeviceDescriptor - class usb.core.DeviceDescriptor.

Provides access to a USB device descriptor.

DeviceDescriptor(Device, byte[]) - Constructor for class usb.core.DeviceDescriptor

DeviceImpl - class usb.windows.DeviceImpl.

Provides access to a USB device.

deviceRemoved(Device) - Method in class usb.core.USBListenerAdapter

deviceRemoved(Device) - Method in interface usb.core.USBListener

Device removed.

deviceRemoved(Device) - Method in class usb.remote.USBListenerProxy

DeviceSPI - interface usb.core.DeviceSPI.

This is not an Application Programming Interface.

DIR_TO_DEVICE - Static variable in class usb.core.ControlMessage

Request type field indicating host-to-device data transfer phase.

DIR_TO_HOST - Static variable in class usb.core.ControlMessage

Request type field indicating device-to-host data transfer phase.

download(InputStream) - Method in class usb.util.EZ

Downloads firmware to the device, normally causing it to reset and re-enumerate under control of that firmware.

draw(JEditorPane) - Method in class usb.view.USBNode

Renders this node in an auxiliary pane.

dump() - Method in class usb.devices.Rio500.SongEntry

E

Endpoint - class usb.core.Endpoint.

Provides access to a USB endpoint descriptor, structuring device data input or output in a given device configuration.

ENDPOINT_HALT - Static variable in class usb.core.Endpoint

Endpoint feature selector that sets or clears the halt state.

existingFWDeviceRemoved(int, int, int, String) - Static method in class usb.windows.Windows

EZ - class usb.util.EZ.

This class supports downloading firmware to devices based on Cypress EZ-USB FX2 microcontrollers.

EZ(Device) - Constructor for class usb.util.EZ

Wraps the device; caller must guarantee that this device supports EZ-USB firmware download primitives.

F

finalize() - Method in class usb.remote.HostProxy

finalize() - Method in class usb.windows.DeviceImpl

Releases any unreleased system resources.

finalize() - Method in class usb.util.USBSocket

Finalization releases the interface, if it has not already been released by invoking close().

finalize() - Method in class usb.devices.Rio500

If you didn't finish and close this device, they'll be done here.

finalize() - Method in class usb.devices.Kodak

finish() - Method in class usb.devices.Rio500

When you finish with this object, it can normally be used to play back audio until you start to use it again.

Foo - class usb.view.Foo.

This is a USB tree viewer.

Foo() - Constructor for class usb.view.Foo

Applet constructor saves all work for initialization

G

GET_CONFIGURATION - Static variable in class usb.core.ControlMessage

Request value (8) for the current device configuration descriptor.

GET_DESCRIPTOR - Static variable in class usb.core.ControlMessage

Request value (6) used to get configuration, interface, endpoint, string, or other device descriptors.

GET_INTERFACE - Static variable in class usb.core.ControlMessage

Request value (10) to determine an interface alternate setting.

GET_STATUS - Static variable in class usb.core.ControlMessage

Request value (0) used to determine state.

getAddress() - Method in class usb.core.Device

Returns address assigned to this device on its USB Bus.

getAllowsChildren() - Method in class usb.view.USBNode

Reports that children are not allowed.

getAllowsChildren() - Method in class usb.view.HubNode

getAllowsChildren() - Method in class usb.view.RioNode

getAllowsChildren() - Method in class usb.view.KodakNode

getAlternateSetting() - Method in class usb.core.Interface

Used to identify alternate setting for an interface.

getAttributes() - Method in class usb.core.Configuration

Returns attributes of this configuration.

getAttributes() - Method in class usb.core.Endpoint

Returns the endpoint attributes (a bitmask describing its type).

getBatteryStatus() - Method in class usb.devices.Kodak

returns good, weak, or empty

getBCD(int) - Method in class usb.core.Descriptor

Returns the two byte BCD string at the specified offset.

getBit(int, byte[], int) - Static method in class usb.core.ControlMessage

Utility for working with control message results, returning the Nth bit (little endian) starting from the specified byte offset in the buffer.

getBit(int, int) - Method in class usb.core.ControlMessage

Returns the Nth bit (little endian) from the specified byte offset in this message's result.

getBlockCount() - Method in class usb.devices.Rio500.MemoryStatus

getBlockSize() - Method in class usb.devices.Rio500.MemoryStatus

getBuffer() - Method in class usb.core.ControlMessage

Returns the buffer used to transfer data

getBus() - Method in class usb.core.Device

Returns the bus with which the device is associated.

getBusId() - Method in interface usb.core.Bus

Returns a host-specific stable identifier for this bus.

getBusses() - Method in interface usb.core.Host

Returns an array of objects representing the USB busses currently available on this host.

getBusses() - Method in class usb.remote.HostProxy

getCameraStatus() - Method in class usb.devices.Kodak

Updates the local copy of the camera status table, and returns a copy of it.

getCameraType() - Method in class usb.devices.Kodak

returns string naming camera type, such as DC-240 or DC-280

getChild(int) - Method in class usb.core.Device

Returns the device connected to this hub's specified port (origin one), or null.

getChild(int) - Method in interface usb.core.DeviceSPI

Returns children of a hub device.

getChild(int) - Method in class usb.windows.DeviceImpl

getChildAt(int) - Method in class usb.view.USBNode

Returns null.

getChildAt(int) - Method in class usb.view.HubNode

getChildAt(int) - Method in class usb.view.RioNode

getChildAt(int) - Method in class usb.view.KodakNode

getChildCount() - Method in class usb.view.USBNode

Returns zero.

getChildCount() - Method in class usb.view.HubNode

getChildCount() - Method in class usb.view.RioNode

getChildCount() - Method in class usb.view.KodakNode

getClaimer() - Method in class usb.core.Interface

Returns a string identifying the driver which has claimed this interface, or null.

getClaimer(int) - Method in interface usb.core.DeviceSPI

Identifies the driver claiming a particular interface in the current configuration.

getClaimer(int) - Method in class usb.windows.DeviceImpl

Returns a system-specific string providing information about the driver claiming this interface, or null.

getClassDescriptor(Device, byte, byte, int, int) - Static method in class usb.core.ControlMessage

Requests a USB class descriptor from the specified device.

getClassName(int, String) - Static method in class usb.core.Descriptor

Returns the name corresponding to an interface class code.

getCode() - Method in class usb.linux.HID.Event

Returns a code associated with this event type, perhaps identifying a button, key, controller axis, or specific LED

getConfigBuf(int) - Method in interface usb.core.DeviceSPI

Returns a buffer holding the entire set of configuration descriptors for the specified configuration.

getConfigBuf(int) - Method in class usb.windows.DeviceImpl

getConfiguration() - Method in class usb.core.Interface

Returns the configuration with which the interface is associated

getConfiguration() - Method in class usb.core.Device

Returns the current device configuration's descriptor.

getConfiguration() - Method in class usb.windows.DeviceImpl

getConfiguration(int) - Method in class usb.core.Device

Returns the specified configuration descriptor.

getConfiguration(int) - Method in class usb.core.Configuration

Returns a string describing this configuration, in the specified language; or null if no such string is available.

getConfiguration(int) - Method in class usb.windows.DeviceImpl

Returns the specified configuration.

getConfigurationValue() - Method in class usb.core.Configuration

Value passed in a setConfiguration() request to select this configuration.

getDescriptorType() - Method in class usb.core.Descriptor

Returns the descriptor type.

getDescriptorTypeName() - Method in class usb.core.Descriptor

Returns a name for the type of descriptor (such as "device")

getDevice() - Method in class usb.core.Descriptor

Returns the device with which this USB object is associated.

getDevice() - Method in class usb.core.DeviceDescriptor

Returns the device the descriptor describes.

getDevice() - Method in class usb.core.Interface

getDevice() - Method in class usb.core.Hub

getDevice() - Method in class usb.core.Configuration

Returns the device with which the configuration is associated

getDevice() - Method in class usb.core.Endpoint

getDevice() - Method in class usb.util.USBSocket

Returns the device to which this socket is connected, or null if the device has been closed or removed.

getDevice(Host) - Method in class usb.core.PortIdentifier

Returns the appropriate device from this host, or null if the address describes a port connection that isn't available just now.

getDevice(int) - Method in interface usb.core.Bus

Returns an object representing the device with the specified address (1 through 127), or null if no such device exists.

getDevice(String) - Method in interface usb.core.Host

Returns the device, if any, associated with the specified PortIdentifier string.

getDevice(String) - Method in class usb.remote.HostProxy

getDeviceClass() - Method in class usb.core.DeviceDescriptor

Returns the USB class identifier for the device.

getDeviceClassName() - Method in class usb.core.DeviceDescriptor

Returns the USB class name for the device.

getDeviceDescriptor() - Method in class usb.core.Device

Returns the device descriptor.

getDeviceDescriptor() - Method in class usb.windows.DeviceImpl

getDeviceId() - Method in class usb.core.DeviceDescriptor

Returns the device release version number (such as "3.14").

getDeviceProtocol() - Method in class usb.core.DeviceDescriptor

Returns the device protocol

getDeviceSubClass() - Method in class usb.core.DeviceDescriptor

Returns the USB subclass identifier for the device.

getDriverMode() - Method in class usb.devices.Kodak

Returns a string identifying the driver mode (kernel, user).

getEndpoint() - Method in class usb.core.Endpoint

Returns an identifier composing the endpoint address and the flag controlling its input.

getEndpoint(int) - Method in class usb.core.Interface

Returns descriptor for an endpoint in this interface.

getEndpointAddress() - Method in class usb.core.Endpoint

Returns the endpoint address (a number from 0 to 15).

getFirmwareRevision() - Method in class usb.devices.Rio500

Returns the frmware revision of this MP3 player.

getFirstFreeBlock() - Method in class usb.devices.Rio500.MemoryStatus

getFirstFreeEntryOffset() - Method in class usb.devices.Rio500.FolderEntry

getFolderNumber() - Method in class usb.devices.Rio500.FolderEntry

getFolders(boolean) - Method in class usb.devices.Rio500

Returns an array of the folders in internal or external memory.

getFreeMemory(boolean) - Method in class usb.devices.Rio500

Returns the number of bytes of free memory in the player's internal or external memory.

getHost() - Method in interface usb.core.Bus

Returns the USB host to which this bus is connected.

getHost() - Static method in class usb.core.HostFactory

Returns a USB Host according to an environment-specific policy.

getHost() - Static method in class usb.linux.Linux

Provides access to the singleton USB Host.

getHost() - Static method in class usb.remote.RemoteHostFactory

Returns a client side proxy for a USB Host.

getHost() - Static method in class usb.windows.Windows

Provides access to the singleton USB Host.

getHost(USBListener) - Static method in class usb.windows.Windows

getHub() - Method in class usb.core.Device

Returns the hub to which this device is connected, or null if this device is disconnected or is the root hub for its bus.

getHub() - Method in class usb.windows.DeviceImpl

getHubCharacteristics() - Method in class usb.core.Hub

Returns the hub characteristics bitmap.

getHubCurrent() - Method in class usb.core.Hub

Returns the maximum current requirement of the hub electronics, in mA units.

getHubPortNum() - Method in class usb.core.Device

Returns the number of the hub port to which this device is connected.

getHubPortNum() - Method in class usb.windows.DeviceImpl

getIndex() - Method in class usb.core.ControlMessage

Returns the "index" field of the message.

getIndex(TreeNode) - Method in class usb.view.USBNode

Not implemented.

getIndex(TreeNode) - Method in class usb.view.HubNode

getIndex(TreeNode) - Method in class usb.view.RioNode

getInputStream() - Method in class usb.core.Endpoint

Returns an input stream used to read from this bulk input stream.

getInputStream() - Method in class usb.util.USBSocket

Returns an input stream used to perform bulk reads from the interface, or null.

getInterface() - Method in class usb.core.Endpoint

Returns the interface with which the endpoint is associated

getInterface(int) - Method in class usb.core.Interface

Returns a string describing this interface in the specified language, or null if no such string is available.

getInterface(int, int) - Method in class usb.core.Configuration

Returns the specified interface from this configuration, or null if the device won't provide it.

getInterfaceClass() - Method in class usb.core.Interface

Returns the interface class

getInterfaceClassName() - Method in class usb.core.Interface

Returns the name of interface class

getInterfaceProtocol() - Method in class usb.core.Interface

Returns the interface protocol

getInterfaceStringId() - Method in class usb.core.Interface

Returns the identifier of the string describing this interface, or zero.

getInterfaceSubClass() - Method in class usb.core.Interface

Returns the interface subclass

getInterval() - Method in class usb.core.Endpoint

Returns interrupt polling interval (in microseconds).

getLanguages() - Method in class usb.windows.DeviceImpl

getLanguages(Device) - Static method in class usb.core.ControlMessage

Returns an array of languages supported by this device for its string descriptors, or null if no string descriptors are provided.

getLength() - Method in class usb.core.ControlMessage

Returns the size of the IO buffer (unsigned 16 bits)

getLength() - Method in class usb.core.Descriptor

Returns the length of the descriptor.

getLength() - Method in class usb.devices.Rio500.SongEntry

getLocale(int) - Static method in class usb.util.LangCode

Utility method returning a locale appropriate to the USB language code passed, or null if the code is not recognized.

getManufacturer(int) - Method in class usb.core.DeviceDescriptor

Returns any string describing the product's manufacturer, or null.

getManufacturerStringId() - Method in class usb.core.DeviceDescriptor

Returns the manufacturer string ID, or zero.

getMaxPacketSize() - Method in class usb.core.Endpoint

Maximum packet size this endpoint can send or receive.

getMaxPacketSize0() - Method in class usb.core.DeviceDescriptor

Returns the maximum packet size understood by endpoint zero.

getMaxPower() - Method in class usb.core.Configuration

Returns the maximum amount of power used in this configuration, in units of 2mA.

getMemoryStatus(boolean) - Method in class usb.devices.Rio500

Returns information about the internal or external memory.

getMP3Sig() - Method in class usb.devices.Rio500.SongEntry

getName1() - Method in class usb.devices.Rio500.FolderEntry

getName1() - Method in class usb.devices.Rio500.SongEntry

getName2() - Method in class usb.devices.Rio500.FolderEntry

getName2() - Method in class usb.devices.Rio500.SongEntry

getNumber() - Method in class usb.core.Interface

Returns the interface number.

getNumConfigurations() - Method in class usb.core.DeviceDescriptor

Returns the number of configurations this device supports.

getNumEndpoints() - Method in class usb.core.Interface

Returns the number of endpoints in this interface.

getNumInterfaces() - Method in class usb.core.Configuration

Returns the number of interfaces exposed in this configuration.

getNumPicturesInCard() - Method in class usb.devices.Kodak

getNumPorts() - Method in class usb.core.Device

Returns the number of ports in this hub; or zero.

getNumPorts() - Method in class usb.core.Hub

Returns the number of ports on this hub.

getNumPorts() - Method in class usb.windows.DeviceImpl

getNumUnusedBlocks() - Method in class usb.devices.Rio500.MemoryStatus

getOffset() - Method in class usb.devices.Rio500.FolderEntry

getOffset() - Method in class usb.devices.Rio500.SongEntry

getOutputStream() - Method in class usb.core.Endpoint

Returns the output stream used to write to this bulk output stream.

getOutputStream() - Method in class usb.util.USBSocket

Returns an output stream used to perform bulk writes to the interface, or null.

getOverCurrentMode() - Method in class usb.core.Hub

Returns the overcurrent protection mode, "global", "per-port"; or only for USB 1.0 hubs, "none".

getParent() - Method in class usb.view.USBNode

Returns the parent provided to the constructcor.

getPath() - Method in class usb.windows.DeviceImpl

Returns the filesystem name for this file.

getPortIdentifier() - Method in class usb.core.Device

Returns port identifier associated with this device.

getPOTPGT() - Method in class usb.core.Hub

Returns the power-on to power-good time, in units of 2ms.

getPowerSwitchingMode() - Method in class usb.core.Hub

Returns the power logical power switching mode, "ganged", "switched", or otherwise indicating an old USB 1.0 hub.

getProduct(int) - Method in class usb.core.DeviceDescriptor

Returns any string describing the product, or null.

getProductId() - Method in class usb.core.DeviceDescriptor

Returns the vendor's product identifier code.

getProductStringId() - Method in class usb.core.DeviceDescriptor

Returns the product string ID, or zero

getRequest() - Method in class usb.core.ControlMessage

Returns the request (GET_STATUS, etc)

getRequestType() - Method in class usb.core.ControlMessage

Returns the request type, which masks a DIR, TYPE, and RECIPIENT.

getRootHub() - Method in interface usb.core.Bus

Returns the root hub of the bus, if it is known yet.

getSerial(int) - Method in class usb.core.DeviceDescriptor

Returns any string describing the product's serial number, or null.

getSerialStringId() - Method in class usb.core.DeviceDescriptor

Returns the serial string ID, or zero.

getSongCount() - Method in class usb.devices.Rio500.FolderEntry

getSongs() - Method in class usb.devices.Rio500.FolderEntry

getSpeed() - Method in class usb.core.Device

Returns the speed of the connection the device is using.

getSpeed() - Method in class usb.windows.DeviceImpl

getSPI() - Method in class usb.core.Device

getStandardDescriptor(Device, byte, byte, int, int) - Static method in class usb.core.ControlMessage

Requests a USB standard descriptor from the specified device.

getStatus(Device, int, int, int, int) - Static method in class usb.core.ControlMessage

Returns the specified type of status.

getString(Device, byte, int) - Static method in class usb.core.ControlMessage

Gets the specified string descriptor from the device.

getString(int) - Method in class usb.windows.DeviceImpl

Returns the string indexed with the specified ID in the default language, or null if there is no such string.

getString(int, int) - Method in class usb.core.Device

Returns the string index with the specified ID and language, or null if there is no such string.

getString(int, int) - Method in class usb.windows.DeviceImpl

Implementation of Device.getString which can cache strings in the device's default language.

getTime() - Method in class usb.linux.HID.Event

Returns the event's timestamp

getTime() - Method in class usb.devices.Rio500.FolderEntry

getTime() - Method in class usb.devices.Rio500.SongEntry

getTotalLength() - Method in class usb.core.Configuration

Returns the total length of the descriptor for this configuration, including descriptors for interfaces, their endpoints, and other associated elements.

getType() - Method in class usb.core.Endpoint

Returns the type of endpoint ("bulk", "iso", or "interrupt"; "control" won't normally be seen).

getType() - Method in class usb.linux.HID.Event

getTypeName() - Method in class usb.linux.HID.Event

Returns a symbolic name identifying the event type

getU16(int) - Method in class usb.core.Descriptor

Returns a sixteen bit unsigned integer value, as encoded in the descriptor at the specified byte offset.

getU32(int) - Method in class usb.core.Descriptor

Returns a thirty-two bit integer value, as encoded in the descriptor at the specified byte offset.

getU8(int) - Method in class usb.core.Descriptor

Returns an eight bit unsigned integer value, as encoded in the descriptor at the specified byte offset.

getUSBVersion() - Method in class usb.core.DeviceDescriptor

Returns the version of the USB specification to which this device and its descriptors conform.

getValue() - Method in class usb.core.ControlMessage

Returns the "value" field of the message

getValue() - Method in class usb.linux.HID.Event

Returns a value associated with this event type, perhaps LED settings or a relative or absolute value.

getVendorDescriptor(Device, byte, byte, int, int) - Static method in class usb.core.ControlMessage

Requests a USB vendor descriptor from the specified device.

getVendorId() - Method in class usb.core.DeviceDescriptor

Returns the vendor of the USB device.

H

hasExternalMemory() - Method in class usb.devices.Rio500

Returns true if a removable SmartMedia memory card is available for song storage.

HID - class usb.linux.HID.

Simple Linux-specific HID access, using the kernel hid and evdev driver modules.

HID.Event - class usb.linux.HID.Event.

Encapsulates HID i/o event reports.

HID(Device) - Constructor for class usb.linux.HID

Constructs a HID object associated with the device's single HID interface.

HID(Interface) - Constructor for class usb.linux.HID

Constructs a HID object associated with a given interface.

Host - interface usb.core.Host.

Represents a host with one or more Universal Serial Busses.

HostFactory - class usb.core.HostFactory.

Bootstrapping methods.

HostFactory() - Constructor for class usb.core.HostFactory

Not part of the API.

HostProxy - class usb.remote.HostProxy.

RMI proxy for a local Host implementation.

HostProxy(Host) - Constructor for class usb.remote.HostProxy

Constructs a proxy for the specified Host.

Hub - class usb.core.Hub.

Bundles access to a USB Hub descriptor and some hub operations.

Hub(Device) - Constructor for class usb.core.Hub

Constructs a hub object wrapping the specified USB hub device.

HubNode - class usb.view.HubNode.

Instance of this class represent USB Hub nodes.

I

init() - Method in class usb.view.Foo

Applet initialization; expect a security exception unless you've granted this code appropriate privileges.

Interface - class usb.core.Interface.

USB interfaces describe sets of endpoints, and are associated with a particular device configuration.

Interface(Configuration, byte[]) - Constructor for class usb.core.Interface

isCompound() - Method in class usb.core.Hub

Returns true if this hub is part of a compound device.

isExternal() - Method in class usb.devices.Rio500.FolderEntry

Returns true if the folder is on a removable memory card

isIndicator() - Method in class usb.core.Hub

Returns true iff the hub supports status indicators.

isInput() - Method in class usb.core.Endpoint

Returns true if this is an input endpoint (data flows to host), false if it is instead an output endpoint (data flows to device).

isLeaf() - Method in class usb.view.USBNode

Returns true for nodes that don't allow children.

isPowerConnected() - Method in class usb.devices.Kodak

isRemovable(int) - Method in class usb.core.Hub

Returns true if the specified port (one-based) is removable.

isRootHub() - Method in class usb.core.Hub

Returns true if this is the root hub.

isStalled() - Method in class usb.core.USBException

Returns true iff the exception indicates a (bulk) endpoint has stalled; these are used as error indicators in device protocols.

K

Kodak - class usb.devices.Kodak.

Simple wrapper for Kodak DC 240, 280, 3400, DC-5000 cameras.

Kodak(Device) - Constructor for class usb.devices.Kodak

Wraps access to the specified camera.

KodakNode - class usb.view.KodakNode.

Represent Kodak DC-240 and DC-280 cameras.

KodakNode(Device, TreeNode) - Constructor for class usb.view.KodakNode

This is the standard constructor that viewer nodes need to support.

L

LangCode - class usb.util.LangCode.

I18N support.

Linux - class usb.linux.Linux.

Provides access to native USB host object for this process.

Linux() - Constructor for class usb.linux.Linux

Not part of the API; implements reference implementation SPI.

lookup(Host, Dictionary, String) - Static method in class usb.core.PortIdentifier

This maps names to devices, using a dictionary to associate user-meaningful names like ReceiptPrinter or RedCable with port identifier strings like usb-00:0b.0-1.3.

M

main(String[]) - Static method in class usb.linux.HID

main(String[]) - Static method in class usb.remote.USBD

Arguments are "start" or "stop", but "stop' is currently a NOP.

main(String[]) - Static method in class usb.util.ShowTree

main(String[]) - Static method in class usb.util.EZ

Downloads firmware to devices.

main(String[]) - Static method in class usb.view.Foo

For invoking from the command line; no arguments.

N

newFWDeviceAvailable(int, int, int, String) - Static method in class usb.windows.Windows

nextDescriptor() - Method in class usb.core.Descriptor

Provides successive access to all the descriptors in a block such a complete configuration descriptor.

P

parent - Variable in class usb.view.USBNode

Swing's tree model requires nodes to know their parents.

PORT_CONNECTION - Static variable in class usb.core.Hub

Port feature selector, indicating whether a device is connected.

PORT_ENABLE - Static variable in class usb.core.Hub

Port feature selector, controlling whether the port is enabled.

PORT_HIGH_SPEED - Static variable in class usb.core.Hub

Port feature selector, indicates if an enabled port runs at low/full speed or at high speed.

PORT_INDICATOR - Static variable in class usb.core.Hub

Port feature selector, indicates if enabled port has an indicator.

PORT_LOW_SPEED - Static variable in class usb.core.Hub

Port feature selector, indicates if an enabled port is low speed USB.

PORT_OVER_CURRENT - Static variable in class usb.core.Hub

Port feature selector, indicating an overcurrent state for the port.

PORT_POWER - Static variable in class usb.core.Hub

Port feature selector, controlling power availability to this port (subject to gang power switching rules).

PORT_RESET - Static variable in class usb.core.Hub

Port feature selector, set to initiate a port reset.

PORT_SUSPEND - Static variable in class usb.core.Hub

Port feature selector, controlling "suspend" state for the port.

PORT_TEST - Static variable in class usb.core.Hub

Port feature selector, indicates if an enabled port is test mode.

PortIdentifier - class usb.core.PortIdentifier.

This class provides "stable" string identifiers for USB devices, appropriate for use in operations and troubleshooting.

PortIdentifier(Device) - Constructor for class usb.core.PortIdentifier

Constructs an identifier for the physical location of this device, scoped to the associated host.

PortIdentifier(String) - Constructor for class usb.core.PortIdentifier

Constructs a port identifier using its string form.

printSomeStatus(int) - Method in class usb.devices.Kodak

R

readBulk(int, byte[], int, int) - Method in class usb.windows.DeviceImpl

readBulk(int, int) - Method in interface usb.core.DeviceSPI

Reads a specified number of bytes from a BULK IN endpoint.

readBulk(int, int) - Method in class usb.windows.DeviceImpl

Assigns the specified configuration as current.

readControl(byte, byte, short, short, short) - Method in interface usb.core.DeviceSPI

Issues a control IN request with an optional data READ phase.

readControl(byte, byte, short, short, short) - Method in class usb.windows.DeviceImpl

readEvent() - Method in class usb.linux.HID

Blocks until an input event is reported.

readIntr(int, int) - Method in interface usb.core.DeviceSPI

Reads a specified number of bytes from a INTERRUPT IN endpoint.

readIntr(int, int) - Method in class usb.windows.DeviceImpl

RECIPIENT_DEVICE - Static variable in class usb.core.ControlMessage

Request type field for device recipient

RECIPIENT_ENDPOINT - Static variable in class usb.core.ControlMessage

Request type field for endpoint recipient

RECIPIENT_INTERFACE - Static variable in class usb.core.ControlMessage

Request type field for interface recipient

RECIPIENT_OTHER - Static variable in class usb.core.ControlMessage

Request type field for other recipient

recvInterrupt() - Method in class usb.core.Endpoint

Blocks until an interrupt message is sent from device to host, and then returns that message.

release() - Method in class usb.core.Interface

Releases a previous claim on this interface.

releaseInterface(int) - Method in interface usb.core.DeviceSPI

Releases a claim on a given interface, so that another driver can safely claim it.

releaseInterface(int) - Method in class usb.windows.DeviceImpl

Releases an interface claim.

RemoteBus - interface usb.remote.RemoteBus.

Remotable Bus

RemoteDeviceSPI - interface usb.remote.RemoteDeviceSPI.

Remotable usb.core.DeviceSPI interface.

RemoteHost - interface usb.remote.RemoteHost.

Remotable usb.core.Host interface.

RemoteHostFactory - class usb.remote.RemoteHostFactory.

Bootstrapping methods.

RemoteHostFactory() - Constructor for class usb.remote.RemoteHostFactory

Not part of the API.

RemoteUSBListener - interface usb.remote.RemoteUSBListener.

Remotable usb.core.USBListener interface.

removeUSBListener(USBListener) - Method in interface usb.core.Host

Removes a callback for USB structure changes

removeUSBListener(USBListener) - Method in class usb.remote.HostProxy

reset(int) - Method in class usb.core.Hub

Resets the port (and the device connected to it).

resume(int) - Method in class usb.core.Hub

Resumes the port.

Rio500 - class usb.devices.Rio500.

This provides access Rio500 status, and potentially to the full range of functionality supported by this device.

Rio500.Data - class usb.devices.Rio500.Data.

This class is a base class that wraps a data buffer; subclasses expose the fields in that data.

Rio500.FolderEntry - class usb.devices.Rio500.FolderEntry.

Exposes the fields desribing a folder.

Rio500.MemoryStatus - class usb.devices.Rio500.MemoryStatus.

Exposes the fields of a memory status record.

Rio500.SongEntry - class usb.devices.Rio500.SongEntry.

Represents the information known about each song.

Rio500(Device) - Constructor for class usb.devices.Rio500

Initializes to talk to the specified device.

RioNode - class usb.view.RioNode.

Represent Rio500 MP3 players.

RioNode(Device, TreeNode) - Constructor for class usb.view.RioNode

rmiName - Static variable in class usb.remote.USBD

This holds the name under which this class registers a proxy in the RMI naming context.

S

scanForFWDevices() - Static method in class usb.windows.Windows

sendEvent(HID.Event) - Method in class usb.linux.HID

Sends an event (not repeated).

sendInterrupt(byte[]) - Method in class usb.core.Endpoint

Sends interrupt message from host to device.

SET_ADDRESS - Static variable in class usb.core.ControlMessage

Request value (5) used by the host controller driver to assign device numbers during device enumeration.

SET_CONFIGURATION - Static variable in class usb.core.ControlMessage

Request value (9) to choose the device configuration.

SET_DESCRIPTOR - Static variable in class usb.core.ControlMessage

Request value (7) to assign a descriptor

SET_FEATURE - Static variable in class usb.core.ControlMessage

Request value (3) to set device feature flags.

SET_INTERFACE - Static variable in class usb.core.ControlMessage

Request value (11) to select an interface alternate setting.

setBuffer(byte[]) - Method in class usb.core.ControlMessage

Assigns the buffer used in any data transfer stage of this control operation; used before sending data.

setConfiguration(int) - Method in class usb.windows.DeviceImpl

Deprecated. Consider this dangerous.

setDescriptor(Device, byte, byte, byte, int, byte[]) - Static method in class usb.core.ControlMessage

Sets a descriptor on the specified device.

setFeature(Device, int, int, int) - Static method in class usb.core.ControlMessage

Sets the identified feature flag to true.

setIndex(short) - Method in class usb.core.ControlMessage

Assigns the "index" field of the message.

setInterface(int, int) - Method in interface usb.core.DeviceSPI

Assigns a particular alternate setting to a given interface.

setInterface(int, int) - Method in class usb.windows.DeviceImpl

Assigns an interface to an alternate setting.

setLength(int) - Method in class usb.core.ControlMessage

Sets an amount of data to be read (max 64K)

setRequest(byte) - Method in class usb.core.ControlMessage

Assigns the request (GET_STATUS, etc)

setRequestType(byte) - Method in class usb.core.ControlMessage

Assigns bits in the request type.

setTime(long) - Method in class usb.devices.Kodak

Set's the camera's clock to match the local time.

setValue(short) - Method in class usb.core.ControlMessage

Assigns the "value" field of the message

showClassInfo(StringBuffer) - Method in class usb.view.USBNode

This method is a hook to provide class-specific data (in HTML) when this node is selected.

showClassInfo(StringBuffer) - Method in class usb.view.HubNode

Displays hub class information, including current port status.

showClassInfo(StringBuffer) - Method in class usb.view.RioNode

This is currently a placeholder.

showClassInfo(StringBuffer) - Method in class usb.view.KodakNode

This currently just shows a few fields of the camera status table.

ShowTree - class usb.util.ShowTree.

Displays the host's Universal Serial Bus (USB) in XML on standard output.

start() - Method in class usb.devices.Rio500

You must say you are going to start talking to the player, since it can't be used while your thread is doing so.

startDeviceWatch(boolean) - Static method in class usb.windows.Windows

suspend(int) - Method in class usb.core.Hub

Suspends the port.

SYNCH_FRAME - Static variable in class usb.core.ControlMessage

Request value (12) for synchronizing isochronous behaviors.

T

toString() - Method in class usb.core.PortIdentifier

Provides a printable (and restorable) form of this path, for example usb-00:0b.0-3 identifying the device on the third port on the root hub of the USB controller on PCI slot 0:0b.0.

toString() - Method in class usb.linux.HID

toString() - Method in class usb.linux.HID.Event

Returns a simple string representation

toString() - Method in class usb.windows.DeviceImpl

toString() - Method in class usb.view.USBNode

Returns the label to be used displaying this tree node.

TYPE_CLASS - Static variable in class usb.core.ControlMessage

Request type field for class-specific requests

TYPE_CONFIGURATION - Static variable in class usb.core.Descriptor

Indicates a configuration descriptor

TYPE_DEVICE - Static variable in class usb.core.Descriptor

Indicates a device descriptor

TYPE_DEVICE_QUALIFIER - Static variable in class usb.core.Descriptor

Indicates a USB 2.0 "device qualifier"

TYPE_ENDPOINT - Static variable in class usb.core.Descriptor

Indicates an endpoint descriptor

TYPE_HID - Static variable in class usb.core.Descriptor

Indicates a hid class descriptor

TYPE_HUB - Static variable in class usb.core.Descriptor

Indicates a hub class descriptor

TYPE_INTERFACE - Static variable in class usb.core.Descriptor

Indicates an interface descriptor

TYPE_INTERFACE_POWER - Static variable in class usb.core.Descriptor

Indicates interface power consumption

TYPE_OTHER_SPEED - Static variable in class usb.core.Descriptor

Indicates a USB 2.0 "other speed configuration"

TYPE_PHYSICAL - Static variable in class usb.core.Descriptor

TYPE_REPORT - Static variable in class usb.core.Descriptor

TYPE_STANDARD - Static variable in class usb.core.ControlMessage

Request type field for standard requests

TYPE_STRING - Static variable in class usb.core.Descriptor

Indicates a string descriptor

TYPE_VENDOR - Static variable in class usb.core.ControlMessage

Request type field for vendor-specific requests

U

usb.core - package usb.core

This package provides a USB Host Driver Interface, letting Java programs access USB Devices from USB Hosts.

usb.devices - package usb.devices

This package collects Java-only code to access devices.

usb.linux - package usb.linux

This package has a Linux implementation of a usb.core.Host object, bootstrapping support, and other classes leveraging Linux USB support.

usb.remote - package usb.remote

This holds remoted versions of the usb.core APIs, including an RMI proxy and a basic daemon.

usb.util - package usb.util

This holds a tool to dump USB contents in XML, and utility classes.

usb.view - package usb.view

This holds a simple Swing-based USB tree browser; an example program.

usb.windows - package usb.windows

This package has a partial Windows implementation of a usb.core.Host object, bootstrapping support, and other classes leveraging Windows USB support.

USBD - class usb.remote.USBD.

This starts an RMI HostProxy for this USB Host, exporting it through RMI naming.

USBException - exception usb.core.USBException.

USBException objects indicate USB errors.

USBException(String) - Constructor for class usb.core.USBException

Constructs an exception object representing a USB exception.

USBListener - interface usb.core.USBListener.

Interface implemented by objects that want to monitor USB structure.

USBListenerAdapter - class usb.core.USBListenerAdapter.

Subclassable USBListener adapter, which ignores all calls.

USBListenerAdapter() - Constructor for class usb.core.USBListenerAdapter

Default constructor does nothing.

USBListenerProxy - class usb.remote.USBListenerProxy.

RMI proxy for a USBListener.

USBListenerProxy(USBListener) - Constructor for class usb.remote.USBListenerProxy

Constructs a remotable proxy for the specified listener

USBNode - class usb.view.USBNode.

Models entities, in particular devices, that are displayed using this package's USB tree viewer.

USBNode(Device, TreeNode) - Constructor for class usb.view.USBNode

Constructs a tree node model.

USBSocket - class usb.util.USBSocket.

This provides basic access to USB interfaces which use only bulk I/O, and for devices which only offer such interfaces.

USBSocket(Device) - Constructor for class usb.util.USBSocket

Initializes the socket using a bulk-only device.

USBSocket(Interface) - Constructor for class usb.util.USBSocket

Initializes the socket using a bulk-only interface on a device which may have additional interfaces.

W

Windows - class usb.windows.Windows.

Provides access to native USB host object for this process.

Windows() - Constructor for class usb.windows.Windows

Not part of the API; implements reference implementation SPI.

writeBulk(int, byte[]) - Method in interface usb.core.DeviceSPI

Writes a specified number of bytes to a BULK OUT endpoint.

writeBulk(int, byte[]) - Method in class usb.windows.DeviceImpl

writeBulk(int, byte[], int, int) - Method in class usb.windows.DeviceImpl

writeControl(byte, byte, short, short, byte[]) - Method in interface usb.core.DeviceSPI

Issues a control OUT request with an optional data WRITE phase.

writeControl(byte, byte, short, short, byte[]) - Method in class usb.windows.DeviceImpl

writeIntr(int, byte[]) - Method in interface usb.core.DeviceSPI

Writes a specified number of bytes to a INTERRUPT OUT endpoint.

writeIntr(int, byte[]) - Method in class usb.windows.DeviceImpl

A B C D E F G H I K L M N P R S T U W