USB 附件概述

USB 附件模式允许用户连接专为 Android 设备设计的 USB 主机硬件。这些附件必须符合Android 附件开发套件文档中概述的 Android 附件协议。这允许无法充当 USB 主机的 Android 设备仍然可以与 USB 硬件交互。当 Android 设备处于 USB 附件模式时，连接的 Android USB 附件充当主机，为 USB 总线供电，并枚举连接的设备。Android 3.1（API 级别 12）支持 USB 附件模式，此功能也向后移植到 Android 2.3.4（API 级别 10），以支持更广泛的设备。

选择合适的 USB 附件 API

尽管 USB 附件 API 是在 Android 3.1 中引入平台的，但它们也可以使用 Google API 附加组件库在 Android 2.3.4 中使用。由于这些 API 是使用外部库向后移植的，因此您可以导入两个包以支持 USB 附件模式。根据您要支持的 Android 设备，您可能必须使用其中一个而不是另一个。

com.android.future.usb：为了在 Android 2.3.4 中支持 USB 附件模式，Google APIs 附加库包含向后移植的 USB 附件 API，它们包含在此命名空间中。Android 3.1 也支持导入和调用此命名空间内的类，以支持使用附加库编写的应用程序。此附加库是 android.hardware.usb 附件 API 的一个轻量级包装器，不支持 USB 主机模式。如果要支持最广泛的 USB 附件模式设备，请使用附加库并导入此包。需要注意的是，并非所有 Android 2.3.4 设备都需要支持 USB 附件功能。每个设备制造商都会决定是否支持此功能，这就是为什么必须在清单文件中声明它的原因。
android.hardware.usb：此命名空间包含支持 Android 3.1 中 USB 附件模式的类。此包作为框架 API 的一部分包含在内，因此 Android 3.1 无需使用附加库即可支持 USB 附件模式。如果您只关心 Android 3.1 或更高版本具有 USB 附件模式硬件支持的设备（您可以在清单文件中声明），请使用此包。

安装 Google APIs 附加库

如果要安装附加库，可以通过 SDK Manager 安装 Google APIs Android API 10 包。有关安装附加库的更多信息，请参阅安装 Google APIs 附加库。

API 概述

由于附加库是框架 API 的包装器，因此支持 USB 附件功能的类是相似的。即使使用附加库，也可以使用 android.hardware.usb 的参考文档。

注意：但是，附加库和框架 API 之间存在细微的使用差异，您应该注意这一点。

下表描述了支持 USB 附件 API 的类

类	描述
`UsbManager`	允许您枚举和与已连接的 USB 附件通信。
`UsbAccessory`	表示 USB 附件，并包含访问其识别信息的方法。

附加库和平台 API 之间的使用差异

使用 Google APIs 附加库和平台 API 之间存在两种使用差异。

如果使用附加库，则必须按以下方式获取 UsbManager 对象

Kotlin

val manager = UsbManager.getInstance(this)

Java

UsbManager manager = UsbManager.getInstance(this);

如果不使用附加库，则必须按以下方式获取 UsbManager 对象

Kotlin

val manager = getSystemService(Context.USB_SERVICE) as UsbManager

Java

UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE);

当使用 intent 过滤器筛选已连接的附件时，UsbAccessory 对象包含在传递到应用程序的 intent 中。如果使用附加库，则必须按以下方式获取 UsbAccessory 对象

Kotlin

val accessory = UsbManager.getAccessory(intent)

Java

UsbAccessory accessory = UsbManager.getAccessory(intent);

如果不使用附加库，则必须按以下方式获取 UsbAccessory 对象

Kotlin

val accessory = intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY) as UsbAccessory

Java

UsbAccessory accessory = (UsbAccessory) intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY);

Android 清单要求

以下列表描述了在使用 USB 附件 API 之前需要添加到应用程序清单文件的内容。清单和资源文件示例显示了如何声明这些项目

因为并非所有 Android 设备都保证支持 USB 附件 API，所以包含一个 <uses-feature> 元素，该元素声明您的应用程序使用 android.hardware.usb.accessory 功能。
如果使用附加库，请添加 <uses-library> 元素，为库指定 com.android.future.usb.accessory。
如果使用附加库，则将应用程序的最小 SDK 设置为 API 级别 10；如果使用 android.hardware.usb 包，则设置为 12。
如果希望应用程序收到已连接 USB 附件的通知，请在主活动中为 android.hardware.usb.action.USB_ACCESSORY_ATTACHED intent 指定一个 <intent-filter> 和 <meta-data> 元素对。<meta-data> 元素指向一个外部 XML 资源文件，该文件声明要检测的附件的识别信息。

在 XML 资源文件中，为要过滤的附件声明 <usb-accessory> 元素。每个 <usb-accessory> 可以具有以下属性
- 制造商
- 型号
- 版本
不建议根据 version 进行过滤。附件或设备可能并不总是指定版本字符串（有意或无意）。当您的应用声明一个版本属性进行过滤，而附件或设备没有指定版本字符串时，这会在早期版本的 Android 上导致 NullPointerException。此问题已在 Android 12 中修复。

将资源文件保存在 res/xml/ 目录中。资源文件名（不包含 .xml 扩展名）必须与在 <meta-data> 元素中指定的名称相同。XML 资源文件的格式也在下面的示例中显示。

清单和资源文件示例

以下示例显示了一个示例清单及其对应的资源文件

<manifest ...>
    <uses-feature android:name="android.hardware.usb.accessory" />
    
    <uses-sdk android:minSdkVersion="<version>" />
    ...
    <application>
      <uses-library android:name="com.android.future.usb.accessory" />
        <activity ...>
            ...
            <intent-filter>
                <action android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED" />
            </intent-filter>

            <meta-data android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED"
                android:resource="@xml/accessory_filter" />
        </activity>
    </application>
</manifest>

在这种情况下，以下资源文件应保存在 res/xml/accessory_filter.xml 中，并指定应过滤任何具有相应型号、制造商和版本的附件。附件将这些属性发送到 Android 设备

<?xml version="1.0" encoding="utf-8"?>

<resources>
    <usb-accessory model="DemoKit" manufacturer="Google" version="1.0"/>
</resources>

使用附件

当用户将 USB 附件连接到 Android 设备时，Android 系统可以确定您的应用程序是否对此附件感兴趣。如果是，则可以根据需要设置与附件的通信。为此，您的应用程序必须

使用筛选附件连接事件的 intent 过滤器来发现已连接的附件，或者通过枚举已连接的附件并找到合适的附件。
如果尚未获得，请向用户请求与附件通信的权限。
通过在相应的接口端点上读取和写入数据来与附件通信。

发现附件

您的应用程序可以通过使用 intent 过滤器在用户连接附件时收到通知，或者通过枚举已连接的附件来发现附件。如果您希望应用程序能够自动检测所需的附件，则使用 intent 过滤器非常有用。如果您想要获取所有已连接附件的列表，或者您的应用程序没有筛选 intent，则枚举已连接附件非常有用。

使用 intent 过滤器

为了让您的应用程序发现特定的 USB 附件，您可以指定一个 intent 过滤器来筛选 android.hardware.usb.action.USB_ACCESSORY_ATTACHED intent。除了此 intent 过滤器之外，您还需要指定一个资源文件，该文件指定 USB 附件的属性，例如制造商、型号和版本。

以下示例显示了如何声明 intent 过滤器

<activity ...>
    ...
    <intent-filter>
        <action android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED" />
    </intent-filter>

    <meta-data android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED"
        android:resource="@xml/accessory_filter" />
</activity>

以下示例显示了如何声明相应的资源文件，该文件指定您感兴趣的 USB 附件

<?xml version="1.0" encoding="utf-8"?>

<resources>
    <usb-accessory manufacturer="Google, Inc." model="DemoKit" version="1.0" />
</resources>

在您的活动中，您可以从 intent 中获取表示已连接附件的 UsbAccessory，如下所示（使用附加库）

Kotlin

val accessory = UsbManager.getAccessory(intent)

Java

UsbAccessory accessory = UsbManager.getAccessory(intent);

或者这样（使用平台 API）

Kotlin

val accessory = intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY) as UsbAccessory

Java

UsbAccessory accessory = (UsbAccessory)intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY);

枚举附件

您的应用程序可以在应用程序运行时枚举已识别的附件。

使用 getAccessoryList() 方法获取已连接的所有 USB 附件的数组

Kotlin

val manager = getSystemService(Context.USB_SERVICE) as UsbManager
val accessoryList: Array<out UsbAccessory> = manager.accessoryList

Java

UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE);
UsbAccessory[] accessoryList = manager.getAccessoryList();

注意：一次只支持一个已连接的附件。

获得与附件通信的权限

在与 USB 附件通信之前，您的应用程序必须获得用户的权限。

注意：如果您的应用程序使用 intent 过滤器来发现连接的附件，则如果用户允许您的应用程序处理 intent，它会自动获得权限。否则，您必须在连接到附件之前在应用程序中显式请求权限。

在某些情况下，例如当您的应用程序枚举已连接的附件并想要与其中一个附件通信时，可能需要显式请求权限。您必须在尝试与附件通信之前检查访问附件的权限。否则，如果用户拒绝访问附件的权限，您将收到运行时错误。

要显式获得权限，首先创建一个广播接收器。此接收器侦听在调用 requestPermission() 时广播的 intent。requestPermission() 的调用会向用户显示一个对话框，询问是否允许连接到附件。以下示例代码显示了如何创建广播接收器

Kotlin

private const val ACTION_USB_PERMISSION = "com.android.example.USB_PERMISSION"

private val usbReceiver = object : BroadcastReceiver() {

    override fun onReceive(context: Context, intent: Intent) {
        if (ACTION_USB_PERMISSION == intent.action) {
            synchronized(this) {
                val accessory: UsbAccessory? = intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY)

                if (intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
                    accessory?.apply {
                        // call method to set up accessory communication
                    }
                } else {
                    Log.d(TAG, "permission denied for accessory $accessory")
                }
            }
        }
    }
}

Java

private static final String ACTION_USB_PERMISSION =
    "com.android.example.USB_PERMISSION";
private final BroadcastReceiver usbReceiver = new BroadcastReceiver() {

    public void onReceive(Context context, Intent intent) {
        String action = intent.getAction();
        if (ACTION_USB_PERMISSION.equals(action)) {
            synchronized (this) {
                UsbAccessory accessory = (UsbAccessory) intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY);

                if (intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
                    if(accessory != null){
                        // call method to set up accessory communication
                    }
                }
                else {
                    Log.d(TAG, "permission denied for accessory " + accessory);
                }
            }
        }
    }
};

要注册广播接收器，请将其放在活动的 onCreate() 方法中

Kotlin

private const val ACTION_USB_PERMISSION = "com.android.example.USB_PERMISSION"
...
val manager = getSystemService(Context.USB_SERVICE) as UsbManager
...
permissionIntent = PendingIntent.getBroadcast(this, 0, Intent(ACTION_USB_PERMISSION), 0)
val filter = IntentFilter(ACTION_USB_PERMISSION)
registerReceiver(usbReceiver, filter)

Java

UsbManager usbManager = (UsbManager) getSystemService(Context.USB_SERVICE);
private static final String ACTION_USB_PERMISSION =
    "com.android.example.USB_PERMISSION";
...
permissionIntent = PendingIntent.getBroadcast(this, 0, new Intent(ACTION_USB_PERMISSION), 0);
IntentFilter filter = new IntentFilter(ACTION_USB_PERMISSION);
registerReceiver(usbReceiver, filter);

要显示请求用户允许连接到附件的对话框，请调用 requestPermission() 方法

Kotlin

lateinit var accessory: UsbAccessory
...
usbManager.requestPermission(accessory, permissionIntent)

Java

UsbAccessory accessory;
...
usbManager.requestPermission(accessory, permissionIntent);

当用户回复对话框时，您的广播接收器会收到包含 EXTRA_PERMISSION_GRANTED 额外信息的 Intent，这是一个表示答案的布尔值。在连接到配件之前，请检查此额外信息的值是否为 true。

与配件通信

您可以使用 UsbManager 获取文件描述符来与配件通信，您可以设置输入和输出流来读取和写入数据到描述符。这些流代表配件的输入和输出批量端点。您应该在另一个线程中设置设备和配件之间的通信，这样就不会阻塞主 UI 线程。以下示例显示了如何打开配件进行通信

Kotlin

private lateinit var accessory: UsbAccessory
private var fileDescriptor: ParcelFileDescriptor? = null
private var inputStream: FileInputStream? = null
private var outputStream: FileOutputStream? = null
...

private fun openAccessory() {
    Log.d(TAG, "openAccessory: $mAccessory")
    fileDescriptor = usbManager.openAccessory(accessory)
    fileDescriptor?.fileDescriptor?.also { fd ->
        inputStream = FileInputStream(fd)
        outputStream = FileOutputStream(fd)
        val thread = Thread(null, this, "AccessoryThread")
        thread.start()
    }
}

Java

UsbAccessory accessory;
ParcelFileDescriptor fileDescriptor;
FileInputStream inputStream;
FileOutputStream outputStream;
...

private void openAccessory() {
    Log.d(TAG, "openAccessory: " + accessory);
    fileDescriptor = usbManager.openAccessory(accessory);
    if (fileDescriptor != null) {
        FileDescriptor fd = fileDescriptor.getFileDescriptor();
        inputStream = new FileInputStream(fd);
        outputStream = new FileOutputStream(fd);
        Thread thread = new Thread(null, this, "AccessoryThread");
        thread.start();
    }
}

在线程的 run() 方法中，您可以使用 FileInputStream 或 FileOutputStream 对象读取和写入配件。当使用 FileInputStream 对象从配件读取数据时，请确保您使用的缓冲区足够大，可以存储 USB 数据包数据。Android 配件协议支持最大 16384 字节的数据包缓冲区，因此为简便起见，您可以选择始终将缓冲区声明为此大小。

注意：在更底层的级别，对于 USB 全速配件，数据包大小为 64 字节；对于 USB 高速配件，数据包大小为 512 字节。为简化起见，Android 配件协议将这两种速度的数据包捆绑在一起，形成一个逻辑数据包。

有关在 Android 中使用线程的更多信息，请参见进程和线程。

终止与配件的通信

完成与配件的通信或配件已断开连接时，请通过调用 close() 关闭您打开的文件描述符。要侦听断开连接事件，请创建如下所示的广播接收器

Kotlin

var usbReceiver: BroadcastReceiver = object : BroadcastReceiver() {
    override fun onReceive(context: Context, intent: Intent) {

        if (UsbManager.ACTION_USB_ACCESSORY_DETACHED == intent.action) {
            val accessory: UsbAccessory? = intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY)
            accessory?.apply {
                // call your method that cleans up and closes communication with the accessory
            }
        }
    }
}

Java

BroadcastReceiver usbReceiver = new BroadcastReceiver() {
    public void onReceive(Context context, Intent intent) {
        String action = intent.getAction();

        if (UsbManager.ACTION_USB_ACCESSORY_DETACHED.equals(action)) {
            UsbAccessory accessory = (UsbAccessory)intent.getParcelableExtra(UsbManager.EXTRA_ACCESSORY);
            if (accessory != null) {
                // call your method that cleans up and closes communication with the accessory
            }
        }
    }
};

在应用程序（而不是清单）中创建广播接收器，可以让您的应用程序只在运行时处理断开连接事件。这样，断开连接事件只会发送到当前正在运行的应用程序，而不会广播到所有应用程序。