Android APIs
public class

UsbDevice

extends Object
implements Parcelable
java.lang.Object
   ↳ android.hardware.usb.UsbDevice

Class Overview

This class represents a USB device attached to the android device with the android device acting as the USB host. Each device contains one or more UsbInterfaces, each of which contains a number of UsbEndpoints (the channels via which data is transmitted over USB).

This class contains information (along with UsbInterface and UsbEndpoint) that describes the capabilities of the USB device. To communicate with the device, you open a UsbDeviceConnection for the device and use UsbRequest to send and receive data on an endpoint. controlTransfer(int, int, int, int, byte[], int, int) is used for control requests on endpoint zero.

Developer Guides

For more information about communicating with USB hardware, read the USB developer guide.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<UsbDevice> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
UsbConfiguration getConfiguration(int index)
Returns the UsbConfiguration at the given index.
int getConfigurationCount()
Returns the number of UsbConfigurations this device contains.
int getDeviceClass()
Returns the devices's class field.
static int getDeviceId(String name)
int getDeviceId()
Returns a unique integer ID for the device.
String getDeviceName()
Returns the name of the device.
static String getDeviceName(int id)
int getDeviceProtocol()
Returns the device's protocol field.
int getDeviceSubclass()
Returns the device's subclass field.
UsbInterface getInterface(int index)
Returns the UsbInterface at the given index.
int getInterfaceCount()
Returns the number of UsbInterfaces this device contains.
String getManufacturerName()
Returns the manufacturer name of the device.
int getProductId()
Returns a product ID for the device.
String getProductName()
Returns the product name of the device.
String getSerialNumber()
Returns the serial number of the device.
int getVendorId()
Returns a vendor ID for the device.
String getVersion()
Returns the version number of the device.
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<UsbDevice> CREATOR

Added in API level 12

Public Methods

public int describeContents ()

Added in API level 12

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object o)

Added in API level 12

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

public UsbConfiguration getConfiguration (int index)

Added in API level 21

Returns the UsbConfiguration at the given index.

Parameters
index int
Returns
UsbConfiguration the configuration

public int getConfigurationCount ()

Added in API level 21

Returns the number of UsbConfigurations this device contains.

Returns
int the number of configurations

public int getDeviceClass ()

Added in API level 12

Returns the devices's class field. Some useful constants for USB device classes can be found in UsbConstants.

Returns
int the devices's class

public static int getDeviceId (String name)

Added in API level 12

Parameters
name String
Returns
int

public int getDeviceId ()

Added in API level 12

Returns a unique integer ID for the device. This is a convenience for clients that want to use an integer to represent the device, rather than the device name. IDs are not persistent across USB disconnects.

Returns
int the device ID

public String getDeviceName ()

Added in API level 12

Returns the name of the device. In the standard implementation, this is the path of the device file for the device in the usbfs file system.

Returns
String the device name

public static String getDeviceName (int id)

Added in API level 12

Parameters
id int
Returns
String

public int getDeviceProtocol ()

Added in API level 12

Returns the device's protocol field.

Returns
int the device's protocol

public int getDeviceSubclass ()

Added in API level 12

Returns the device's subclass field.

Returns
int the device's subclass

public UsbInterface getInterface (int index)

Added in API level 12

Returns the UsbInterface at the given index. For devices with multiple configurations, you will probably want to use getInterface(int) instead.

Parameters
index int
Returns
UsbInterface the interface

public int getInterfaceCount ()

Added in API level 12

Returns the number of UsbInterfaces this device contains. For devices with multiple configurations, you will probably want to use getInterfaceCount() instead.

Returns
int the number of interfaces

public String getManufacturerName ()

Added in API level 21

Returns the manufacturer name of the device.

Returns
String the manufacturer name

public int getProductId ()

Added in API level 12

Returns a product ID for the device.

Returns
int the device product ID

public String getProductName ()

Added in API level 21

Returns the product name of the device.

Returns
String the product name

public String getSerialNumber ()

Added in API level 21

Returns the serial number of the device.

Returns
String the serial number name

public int getVendorId ()

Added in API level 12

Returns a vendor ID for the device.

Returns
int the device vendor ID

public String getVersion ()

Added in API level 23

Returns the version number of the device.

Returns
String the device version

public int hashCode ()

Added in API level 12

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public String toString ()

Added in API level 12

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public void writeToParcel (Parcel parcel, int flags)

Added in API level 12

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.