USB Accessory - HelloWorld开发者社区

USB accessory模式允许用户连接特别为Android设备设计的USB host硬件。accessories必须符合在Android Accessory Development Kit文档中列出的Android accessory协议。这使得不能充当host的Android设备依然可以与USB硬件交互。当一个Android设备在USB accessory模式下时，附接的Android USB accessory扮演host的角色，提供电源给USB总线，并枚举连接的设备。Android 3.1 (API level 12)支持的USB accessory模式和feature也被移植回了 Android 2.3.4 (API level 10)，以支持更广泛的设备。

选择正确的USB Accessory APIs

尽管USB accessory API是自Android 3.1引入平台的，但通过使用Google APIs和add-on library，在Android 2.3.4中也是可用的。由于这些APIs是使用一个外部library移植回去的，则你可以导入两个包来支持USB accessory模式。依赖于你想要支持Android设备，你可能需要使用一种：

com.android.future.usb: 要在Android 2.3.4上支持USB accessory模式，Google APIs add-on library包含了移植回的USB accessory APIs，这些APIs被包含在了这个命名空间中。Android 3.1也支持导入和调用这个命名空间中的类来支持由add-on library编写的应用。这个add-on library是一个薄薄的android.hardware.usb accessory APIs的包装，它不支持USB host模式。如果你想要支持最广泛的支持了USB accessory模式的设备，则使用add-on library并导入这个包。需要了解的很重要的一点是，不是所有的Android 2.3.4 设备被要求支持USB accessory feature。每个独立的设备制造商决定是否要支持这种功能，这也是为什麽你必须在你的manifest 文件中声明它的原因。
android.hardware.usb: 这个命名空间包含了在Android 3.1中支持USB accessory模式的类。这个包作为framework APIs而被包含在了framework APIs中，因而Android 3.1可以在没有add-on library的情况下支持USB accessory模式。如果你只关心硬件上支持USB accessory 模式的Android 3.1或更新的设备的话则使用这个包，你可以在你的manifest文件中声明USB accessory模式。

安装Google APIs add-on library

如果你想要安装add-on，你可以通过安装Google APIs Android API 10包(借助于SDK Manager)来实现这一点。请参考安装Google APIs Add-on来获取更多关于安装add-on library的信息。

API总览

由于add-on library是framework APIs的包装，则支持USB accessory功能的类是相似的。你可以使用android.hardware.usb的参考文档，即使你使用的是add-on library。

注意：使用add-on library和framework APIs之间一个小小的使用上的差别是你应该有所意识。

下表描述了支持USB accessory APIs的类：

Class

Description

UsbManager

Allows you to enumerate and communicate with connected USB accessories.

UsbAccessory

Represents a USB accessory and contains methods to access its identifying information.

add-on library和platform APIs之间在用法上的不同

使用Google APIs add-on library和平台APIs时，用法上有两点不同。

如果你使用add-on library，你必须以下面的方式来获取UsbManager对象：

UsbManager manager = UsbManager.getInstance(this);

如果你没有在使用add-on library，则你必须以下面的方式获取UsbManager对象：

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

当你用一个intent filter过滤一个连接的accessory时，UsbAccessory对象包含在传给你的应用的intent内部。如果你在使用add-on library，你必须以下面的方式获取UsbAccessory对象：

UsbAccessory accessory = UsbManager.getAccessory(intent);

If you are not using the add-on library, you must obtain the UsbAccessory object in the following manner:如果你没有在使用add-on library，则你必须以如下的方式获取UsbAccessory对象：

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

对Android Manifest的要求

下面的列表描述了在使用USB accessory APIs之前，你都需要向你的应用的manifest文件中添加些什麽东西。manifest和resource示例文件展示了如何声明这些项：

由于不是所有的Android设备都保证支持USB accessory APIs，则包含一个元素来声明你的应用使用了android.hardware.usb.accessory功能。
如果你在使用add-on library，则添加元素来为library指定com.android.future.usb.accessory。
如果你在使用add-on library，就设置应用程序的最小SDK为API Level 10，如果在使用android.hardware.usb包则设置为12。
如果你想要你的应用程序在有USB accessory接上时得到通知，则在你的主activity中为android.hardware.usb.action.USB_ACCESSORY_ATTACHED intent指定一个和元素对。元素指向一个外部的XML资源文件，其声明了关于要探测的accessory的识别信息。

在XML资源文件中，为想要过滤的accessories声明了元素。每个可能具有下列的属性：
- manufacturer
- model
- version
把资源文件保存在res/xml/目录下。资源文件名(不包含.xml 扩展名)必须与你在元素中指定的相同。XML资源文件的格式也展示在了下面的示例中了。

Manifest和资源文件示例

下面的示例展示了一个示例manifest及它对应的资源文件：

<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，并指定具有对应的model，manufacturer，和version的accessory应该被过滤出来。accessory发送这些属性给Android设备：

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

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

使用Accessories

当用户连接了USB accessories到一支Android设备，Android系统会决定你的应用是否对连接的accessory感兴趣。如果感兴趣，如果需要则你可以设置与accessory的通信。要做到这一点，则你的应用需要：

通过使用一个用于过滤出accessory连接事件的intent filter来发现连接的accessories或枚举连接的accessories并发现适当的那个。
向用户请求与accessory通信的权限，如果还没有获取的话。
通过在适当的接口端点上读和写数据来与accessory通信。

发现一个accessory

你的应用可以通过使用一个在用户连接了一个accessory时被通知到的intent filter或者枚举已经连接的accessories来发现accessories。如果你想要使你的应用程序能够自动地探测到一个想要的accessory，则使用一个intent filter很有用。如果你想要获取一个所有连接的accessories的列表或你的应用不过滤一个intent，则枚举连接的accessories很有用。

使用一个intent filter

你可以指定一个intent filter来过滤android.hardware.usb.action.USB_ACCESSORY_ATTACHED intent。伴随着这个intent filter，你需要指定一个描述了USB accessory属性的资源文件，比如manufacturer，model和version。当用户连接到了与你的accessory filter匹配时，

下面的例子展示了如何声明intent filter：

<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 accessories的对应资源文件：

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

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

在你的activity中，你可以从intent中获取表示连接的accessory的UsbAccessory，像下面这样(通过add-on library)：

UsbAccessory accessory = UsbManager.getAccessory(intent);

或像这样(通过platform APIs)：

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

枚举accessories

你可以使你的应用程序在运行时枚举标识了自己的accessories。

使用getAccessoryList()方法来获取一个所有连接的USB accessories的数组：

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

注意：当前，同一时间只支持一个连接的accessory，但API被设计为在未来支持多个accessories。

获取与一个accessory通信的权限

在与USB accessory通信之前，你的应用必须从你的用户那儿获取授权。

注意：如果你的应用程序使用了一个intent filter 来在它们连接时发现accessories，如果用户允许你的应用程序处理intent的话，它将自动地接收权限。如果没有，则你必须在连接accessory之前，在你的应用程序中显式地请求权限。

在某些情况下，显式地请求权限可能是必须的，比如当你的应用程序枚举已经连接的accessories，然后想要与其中一个通信时。在尝试与之通信之前你必须检查权限来访问一个accessory。如果没有，如果用户禁止了访问accessory的权限，则你将收到一个运行时error。

要显式地获取权限，首先创建一个broadcast receiver。当你调用requestPermission()时，这个receiver监听获取广播的intent。对于requestPermission()的调用显式一个dialog来向用户请求连接accessory的权限。下面的示例代码展示了如何创建broadcast receiver：

private static final String ACTION_USB_PERMISSION =
    "com.android.example.USB_PERMISSION";
private final BroadcastReceiver mUsbReceiver = 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);
                }
            }
        }
    }
};

要注册broadcast receiver，则把这些放在你的activity的onCreate()方法中：

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

要向用户显示连接到accessory的请求授权的dialog，调用requestPermission()方法：

UsbAccessory accessory;
...
mUsbManager.requestPermission(accessory, mPermissionIntent);

当用户们回复了dialog，你的receivers将接收到包含有EXTRA_PERMISSION_GRANTED extra的intent，其是一个表示用户的回答的boolean。在连接到accessory之前，检查这个extra的value为true。

与一个accessory通信

你可以通过使用UsbManager获取一个文件描述符来与accessory通信，通过这个文件描述符你可以设置输入和输出流来读取和写入数据。这两个流表示accessory的输入和输出bulk endpoints。你应该在另一个thread中设置设备和accessory的通信，以便于你不会锁住main UI thread。下面的例子展示了如何打开一个accessory以与之通信：

UsbAccessory mAccessory;
ParcelFileDescriptor mFileDescriptor;
FileInputStream mInputStream;
FileOutputStream mOutputStream;

...

private void openAccessory() {
    Log.d(TAG, "openAccessory: " + accessory);
    mFileDescriptor = mUsbManager.openAccessory(mAccessory);
    if (mFileDescriptor != null) {
        FileDescriptor fd = mFileDescriptor.getFileDescriptor();
        mInputStream = new FileInputStream(fd);
        mOutputStream = new FileOutputStream(fd);
        Thread thread = new Thread(null, this, "AccessoryThread");
        thread.start();
    }
}

在线程的run()方法中，你可以通过使用FileInputStream和FileOutputStream对象来读取和写入accessory。当通过一个FileInputStream对象从一个accessory中读取数据时，确保你使用的buffer容纳USB packet数据是足够大的。Android accessory协议支持packets的最大值为16384 bytes，因此你可以选择把你的buffer总是显式地声明为这个最大值。

注意：在底层USB全速accessories的packets是64 bytes的，而高速USB accessories的是512 bytes的。Android accessory协议简单的把两种速度的packets绑定进一个逻辑的packet。

更多关于在Android中使用线程的信息，请参考Processes和Threads。

终止与一个accessory的通信

当你完成了与一个accessory的通信或accessory断开了，则通过调用close()来关闭你打开的文件描述符。要监听断开事件，则创建一个如下的broadcast receiver：

BroadcastReceiver mUsbReceiver = 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
            }
        }
    }
};

在应用程序中创建broadcast receiver，且不是在manifest中，允许你的应用程序只在它运行的时候处理断开事件。这种方式，断开事件只发送给当前正在运行的应用程序，而不是广播给所有的应用。

Done.

原文地址：http://developer.android.com/guide/topics/connectivity/usb/accessory.html