# UsbDevice Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Inherited Constants](https://developer.android.com/reference/android/hardware/usb/UsbDevice#inhconstants)\|[Fields](https://developer.android.com/reference/android/hardware/usb/UsbDevice#lfields)\|[Methods](https://developer.android.com/reference/android/hardware/usb/UsbDevice#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/hardware/usb/UsbDevice#inhmethods) # UsbDevice *** ** * ** *** [Kotlin](https://developer.android.com/reference/kotlin/android/hardware/usb/UsbDevice "View this page in Kotlin")\|Java ` public class UsbDevice ` ` extends `[Object](https://developer.android.com/reference/java/lang/Object)` `` implements `[Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |---|--------------------------------| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | android.hardware.usb.UsbDevice |
*** ** * ** *** 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[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface)s, each of which contains a number of[UsbEndpoint](https://developer.android.com/reference/android/hardware/usb/UsbEndpoint)s (the channels via which data is transmitted over USB). This class contains information (along with[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface)and[UsbEndpoint](https://developer.android.com/reference/android/hardware/usb/UsbEndpoint)) that describes the capabilities of the USB device. To communicate with the device, you open a[UsbDeviceConnection](https://developer.android.com/reference/android/hardware/usb/UsbDeviceConnection)for the device and use[UsbRequest](https://developer.android.com/reference/android/hardware/usb/UsbRequest)to send and receive data on an endpoint.[UsbDeviceConnection.controlTransfer](https://developer.android.com/reference/android/hardware/usb/UsbDeviceConnection#controlTransfer(int,%20int,%20int,%20int,%20byte[],%20int,%20int))is used for control requests on endpoint zero. ### Developer Guides For more information about communicating with USB hardware, read the[USB](https://developer.android.com/guide/topics/connectivity/usb)developer guide.
## Summary | ### Inherited constants | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | | | ### Fields || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| | ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[UsbDevice](https://developer.android.com/reference/android/hardware/usb/UsbDevice)`>` | [CREATOR](https://developer.android.com/reference/android/hardware/usb/UsbDevice#CREATOR)
| | ### Public methods || |------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` int` | ` `[describeContents](https://developer.android.com/reference/android/hardware/usb/UsbDevice#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` boolean` | ` `[equals](https://developer.android.com/reference/android/hardware/usb/UsbDevice#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. | | ` `[UsbConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration) | ` `[getConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getConfiguration(int))`(int index) ` Returns the[UsbConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration)at the given index. | | ` int` | ` `[getConfigurationCount](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getConfigurationCount())`() ` Returns the number of[UsbConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration)s this device contains. | | ` int` | ` `[getDeviceClass](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceClass())`() ` Returns the devices's class field. | | ` int` | ` `[getDeviceId](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceId())`() ` Returns a unique integer ID for the device. | | ` static int` | ` `[getDeviceId](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceId(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` name) ` | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getDeviceName](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceName())`() ` Returns the name of the device. | | ` static `[String](https://developer.android.com/reference/java/lang/String) | ` `[getDeviceName](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceName(int))`(int id) ` | | ` int` | ` `[getDeviceProtocol](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceProtocol())`() ` Returns the device's protocol field. | | ` int` | ` `[getDeviceSubclass](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getDeviceSubclass())`() ` Returns the device's subclass field. | | ` `[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface) | ` `[getInterface](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getInterface(int))`(int index) ` Returns the[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface)at the given index. | | ` int` | ` `[getInterfaceCount](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getInterfaceCount())`() ` Returns the number of[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface)s this device contains. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getManufacturerName](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getManufacturerName())`() ` Returns the manufacturer name of the device. | | ` int` | ` `[getProductId](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getProductId())`() ` Returns a product ID for the device. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getProductName](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getProductName())`() ` Returns the product name of the device. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getSerialNumber](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getSerialNumber())`() ` Returns the serial number of the device. | | ` int` | ` `[getVendorId](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getVendorId())`() ` Returns a vendor ID for the device. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getVersion](https://developer.android.com/reference/android/hardware/usb/UsbDevice#getVersion())`() ` Returns the version number of the device. | | ` int` | ` `[hashCode](https://developer.android.com/reference/android/hardware/usb/UsbDevice#hashCode())`() ` Returns a hash code value for the object. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/hardware/usb/UsbDevice#toString())`() ` Returns a string representation of the object. | | ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/hardware/usb/UsbDevice#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` parcel, int flags) ` Flatten this object in to a Parcel. | | ### Inherited methods | |-----------------------|---| | From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | || | From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | || ## Fields ### CREATOR Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final Creator CREATOR ```

## Public methods ### describeContents Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int describeContents () ``` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.
| Returns || |-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
| ### equals Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean equals (Object o) ``` Indicates whether some other object is "equal to" this one. The`equals`method implements an equivalence relation on non-null object references: - It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`. - It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`. - It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`. - It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified. - For any non-null reference value`x`,`x.equals(null)`should return`false`. An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters || |-----|-------------------------------------------| | `o` | `Object`: This value may be`null`.
| | Returns || |-----------|-------------------------------------------------------------------------------| | `boolean` | `true`if this object is the same as the obj argument;`false`otherwise.
| ### getConfiguration Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public UsbConfiguration getConfiguration (int index) ``` Returns the[UsbConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration)at the given index.
| Parameters || |---------|--------------| | `index` | `int`
| | Returns || |---------------------------------------------------------------------------------------------------|------------------------------------------------------| | [UsbConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration) | the configuration This value cannot be`null`.
| ### getConfigurationCount Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getConfigurationCount () ``` Returns the number of[UsbConfiguration](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration)s this device contains.
| Returns || |-------|-------------------------------------| | `int` | the number of configurations
| ### getDeviceClass Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getDeviceClass () ``` Returns the devices's class field. Some useful constants for USB device classes can be found in[UsbConstants](https://developer.android.com/reference/android/hardware/usb/UsbConstants).
| Returns || |-------|----------------------------| | `int` | the devices's class
| ### getDeviceId Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getDeviceId () ``` 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
| ### getDeviceId Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static int getDeviceId (String name) ```

| Parameters || |--------|-----------------| | `name` | `String`
| | Returns || |-------|--------| | `int` |
| ### getDeviceName Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getDeviceName () ``` 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](https://developer.android.com/reference/java/lang/String) | the device name This value cannot be`null`.
| ### getDeviceName Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static String getDeviceName (int id) ```

| Parameters || |------|--------------| | `id` | `int`
| | Returns || |--------------------------------------------------------------------|--------| | [String](https://developer.android.com/reference/java/lang/String) |
| ### getDeviceProtocol Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getDeviceProtocol () ``` Returns the device's protocol field.
| Returns || |-------|------------------------------| | `int` | the device's protocol
| ### getDeviceSubclass Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getDeviceSubclass () ``` Returns the device's subclass field.
| Returns || |-------|------------------------------| | `int` | the device's subclass
| ### getInterface Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public UsbInterface getInterface (int index) ``` Returns the[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface)at the given index. For devices with multiple configurations, you will probably want to use[UsbConfiguration.getInterface](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration#getInterface(int))instead.
| Parameters || |---------|--------------| | `index` | `int`
| | Returns || |-------------------------------------------------------------------------------------------|--------------------------------------------------| | [UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface) | the interface This value cannot be`null`.
| ### getInterfaceCount Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getInterfaceCount () ``` Returns the number of[UsbInterface](https://developer.android.com/reference/android/hardware/usb/UsbInterface)s this device contains. For devices with multiple configurations, you will probably want to use[UsbConfiguration.getInterfaceCount](https://developer.android.com/reference/android/hardware/usb/UsbConfiguration#getInterfaceCount())instead.
| Returns || |-------|---------------------------------| | `int` | the number of interfaces
| ### getManufacturerName Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getManufacturerName () ``` Returns the manufacturer name of the device.
| Returns || |--------------------------------------------------------------------|-------------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | the manufacturer name, or`null`if the property could not be read
| ### getProductId Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getProductId () ``` Returns a product ID for the device.
| Returns || |-------|------------------------------| | `int` | the device product ID
| ### getProductName Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getProductName () ``` Returns the product name of the device.
| Returns || |--------------------------------------------------------------------|--------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | the product name, or`null`if the property could not be read
| ### getSerialNumber Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getSerialNumber () ``` Returns the serial number of the device.
| Returns || |--------------------------------------------------------------------|--------------------------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | the serial number name, or`null`if the property could not be read
| | Throws || |------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SecurityException](https://developer.android.com/reference/java/lang/SecurityException) | if the app targets SDK \>=[android.os.Build.VERSION_CODES.Q](https://developer.android.com/reference/android/os/Build.VERSION_CODES#Q)and the app does not have permission to read from the device. | ### getVendorId Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getVendorId () ``` Returns a vendor ID for the device.
| Returns || |-------|-----------------------------| | `int` | the device vendor ID
| ### getVersion Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String getVersion () ``` Returns the version number of the device.
| Returns || |--------------------------------------------------------------------|-------------------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | the device version This value cannot be`null`.
| ### hashCode Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int hashCode () ``` Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap). The general contract of`hashCode`is: - Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce the same integer result. - It is*not* required that if two objects are unequal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

| Returns || |-------|-------------------------------------------| | `int` | a hash code value for this object.
| ### toString Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String toString () ``` Returns a string representation of the object.
| Returns || |--------------------------------------------------------------------|-----------------------------------------------| | [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
| ### writeToParcel Added in[API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public void writeToParcel (Parcel parcel, int flags) ``` Flatten this object in to a Parcel.
| Parameters || |----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `parcel` | `Parcel`: The Parcel in which the object should be written. This value cannot be`null`.
| | `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|