• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# USB服务开发指导
2
3
4
5## 场景介绍
6
7Host模式下，可以获取到已经连接的设备列表，并根据需要打开和关闭设备、控制设备权限、进行数据传输等。
8
9
10## 接口说明
11
12USB服务主要提供的功能有：查询USB设备列表、批量数据传输、控制命令传输、权限控制等。
13
14USB类开放能力如下，具体请查阅[API参考文档](../reference/apis/js-apis-usb.md)。
15
16**表1** USB类的开放能力接口
17
18| 接口名 | 描述 |
19| -------- | -------- |
20| hasRight(deviceName: string): boolean | 如果“使用者”（如各种App或系统）有权访问设备则返回true；无权访问设备则返回false。 |
21| requestRight(deviceName: string): Promise<boolean> | 请求给定软件包的临时权限以访问设备。 |
22| connectDevice(device: USBDevice): Readonly<USBDevicePipe> | 根据`getDevices()`返回的设备信息打开USB设备。 |
23| getDevices(): Array<Readonly<USBDevice>> | 返回USB设备列表。 |
24| setConfiguration(pipe: USBDevicePipe, config: USBConfig): number | 设置设备的配置。 |
25| setInterface(pipe: USBDevicePipe, iface: USBInterface): number | 设置设备的接口。 |
26| claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number | 获取接口。 |
27|bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise<number> | 批量传输。 |
28| closePipe(pipe: USBDevicePipe): number | 关闭设备消息控制通道。 |
29| releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number | 释放接口。 |
30| getFileDescriptor(pipe: USBDevicePipe): number | 获取文件描述符。 |
31| getRawDescriptor(pipe: USBDevicePipe): Uint8Array | 获取原始的USB描述符。 |
32| controlTransfer(pipe: USBDevicePipe, contrlparam: USBControlParams, timeout?: number): Promise<number> | 控制传输。 |
33
34
35## 开发步骤
36
37USB设备可作为Host设备连接Device设备进行数据传输。开发示例如下：
38
39
401. 获取设备列表。
41   ```js
42   // 导入USB接口api包。
43   import usb from '@ohos.usb';
44   // 获取设备列表。
45   var deviceList = usb.getDevices();
46   /*
47   deviceList结构示例
48   [
49     {
50       name: "1-1",
51       serial: "",
52       manufacturerName: "",
53       productName: "",
54       version: "",
55       vendorId: 7531,
56       productId: 2,
57       clazz: 9,
58       subclass: 0,
59       protocol: 1,
60       devAddress: 1,
61       busNum: 1,
62       configs: [
63         {
64           id: 1,
65           attributes: 224,
66           isRemoteWakeup: true,
67           isSelfPowered: true,
68           maxPower: 0,
69           name: "1-1",
70           interfaces: [
71             {
72               id: 0,
73               protocol: 0,
74               clazz: 9,
75               subclass: 0,
76               alternateSetting: 0,
77               name: "1-1",
78               endpoints: [
79                 {
80                   address: 129,
81                   attributes: 3,
82                   interval: 12,
83                   maxPacketSize: 4,
84                   direction: 128,
85                   number: 1,
86                   type: 3,
87                   interfaceId: 0,
88                 },
89               ],
90             },
91           ],
92         },
93       ],
94     },
95   ],
96   */
97   ```
98
992. 获取设备操作权限。
100   ```js
101   var deviceName = deviceList[0].name;
102   // 申请操作指定的device的操作权限。
103   usb.requestRight(deviceName).then(hasRight => {
104     console.info("usb device request right result: " + hasRight);
105   }).catch(error => {
106     console.info("usb device request right failed : " + error);
107   });
108   ```
109
1103. 打开Device设备。
111   ```js
112   // 打开设备，获取数据传输通道。
113   var pipe = usb.connectDevice(deviceList[0]);
114   /*
115    打开对应接口，在设备信息（deviceList）中选取对应的interface。
116   interface1为设备配置中的一个接口。
117   */
118   usb.claimInterface(pipe, interface1, true);
119   ```
120
1214. 数据传输。
122   ```js
123   /*
124    读取数据，在device信息中选取对应数据接收的endpoint来做数据传输
125   （endpoint.direction == 0x80）；dataUint8Array是要读取的数据，类型为Uint8Array。
126   */
127
128   usb.bulkTransfer(pipe, inEndpoint, dataUint8Array, 15000).then(dataLength => {
129   if (dataLength >= 0) {
130     console.info("usb readData result Length : " + dataLength);
131     var resultStr = this.ab2str(dataUint8Array); // uint8数据转string。
132     console.info("usb readData buffer : " + resultStr);
133   } else {
134     console.info("usb readData failed : " + dataLength);
135   }
136   }).catch(error => {
137   console.info("usb readData error : " + JSON.stringify(error));
138   });
139   // 发送数据，在device信息中选取对应数据发送的endpoint来做数据传输。（endpoint.direction == 0）
140   usb.bulkTransfer(pipe, endpoint, dataUint8Array, 15000).then(dataLength => {
141     if (dataLength >= 0) {
142       console.info("usb writeData result write length : " + dataLength);
143     } else {
144       console.info("writeData failed");
145     }
146   }).catch(error => {
147     console.info("usb writeData error : " + JSON.stringify(error));
148   });
149   ```
150
1515. 释放接口，关闭设备。
152   ```js
153   usb.releaseInterface(pipe, interface1);
154   usb.closePipe(pipe);
155   ```
156## 相关实例
157针对USB管理开发，有以下相关实例可供参考：
158- [`USBManager`：USB管理（eTS）（API8）](https://gitee.com/openharmony/applications_app_samples/tree/samples_monthly_0730/device/USBManager)