js-apis-usb.md 27.8 KB
Newer Older
Z
zengyawen 已提交
1 2
# USB管理

3 4
本模块主要提供管理USB设备的相关功能,包括查询USB设备列表、批量数据传输、控制命令传输、权限控制等。

G
ge-yafang 已提交
5
>  **说明:**
W
wu-chengwen 已提交
6
> 
Z
zengyawen 已提交
7 8 9 10
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

G
ge-yafang 已提交
11
```js
Z
zengyawen 已提交
12 13 14 15 16
import usb from "@ohos.usb";
```

## usb.getDevices

Y
YOUR_NAME 已提交
17
getDevices(): Array<Readonly<USBDevice>>
Z
zengyawen 已提交
18 19 20

获取USB设备列表。

G
ge-yafang 已提交
21
**系统能力:**  SystemCapability.USB.USBManager
22

G
ge-yafang 已提交
23
**返回值:**
G
ge-yafang 已提交
24

W
wu-chengwen 已提交
25 26 27
| 类型                                                   | 说明      |
| ---------------------------------------------------- | ------- |
| Array<Readonly<[USBDevice](#usbdevice)>> | 设备信息列表。 |
Z
zengyawen 已提交
28

G
ge-yafang 已提交
29
**示例:**
Z
zengyawen 已提交
30

W
wu-chengwen 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
```js
let devicesList = usb.getDevices();
console.log(`devicesList = ${JSON.stringify(devicesList)}`);
//devicesList  返回的数据结构
//此处提供一个简单的示例,如下
[
  {
    name: "1-1",
    serial: "",
    manufacturerName: "",
    productName: "",
    version: "",
    vendorId: 7531,
    productId: 2,
    clazz: 9,
    subclass: 0,
    protocol: 1,
    devAddress: 1,
    busNum: 1,
    configs: [
      {
        id: 1,
        attributes: 224,
        isRemoteWakeup: true,
        isSelfPowered: true,
        maxPower: 0,
        name: "1-1",
        interfaces: [
          {
            id: 0,
            protocol: 0,
            clazz: 9,
            subclass: 0,
            alternateSetting: 0,
            name: "1-1",
            endpoints: [
              {
                address: 129,
                attributes: 3,
                interval: 12,
                maxPacketSize: 4,
                direction: 128,
                number: 1,
                type: 3,
                interfaceId: 0,
              },
            ],
          },
        ],
      },
    ],
  },
]
```
Z
zengyawen 已提交
85 86 87

## usb.connectDevice

Y
YOUR_NAME 已提交
88
connectDevice(device: USBDevice): Readonly<USBDevicePipe>
Z
zengyawen 已提交
89 90 91

打开USB设备。

92
需要调用[usb.getDevices](#usbgetdevices)获取设备信息以及device,再调用[usb.requestRight](#usbrequestright)获取设备请求权限。
Z
zengyawen 已提交
93

G
ge-yafang 已提交
94
**系统能力:**  SystemCapability.USB.USBManager
95

G
ge-yafang 已提交
96
**参数:**
97 98 99 100

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| device | [USBDevice](#usbdevice) | 是 | USB设备信息。 |
Z
zengyawen 已提交
101

G
ge-yafang 已提交
102
**返回值:**
103 104 105 106

| 类型 | 说明 |
| -------- | -------- |
| Readonly<[USBDevicePipe](#usbdevicepipe)> | 指定的传输通道对象。 |
Z
zengyawen 已提交
107

G
ge-yafang 已提交
108
**示例:**
Z
zengyawen 已提交
109

W
wu-chengwen 已提交
110 111 112 113
```js
let devicepipe= usb.connectDevice(device);
console.log(`devicepipe = ${JSON.stringify(devicepipe)}`);
```
Z
zengyawen 已提交
114 115 116

## usb.hasRight

Y
YOUR_NAME 已提交
117
hasRight(deviceName: string): boolean
Z
zengyawen 已提交
118 119 120

判断是否有权访问该设备。

G
ge-yafang 已提交
121
**系统能力:**  SystemCapability.USB.USBManager
122

G
ge-yafang 已提交
123
**参数:**
124 125 126 127

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceName | string | 是 | 设备名称。 |
Z
zengyawen 已提交
128

G
ge-yafang 已提交
129
**返回值:**
130 131 132 133

| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示有访问设备的权限,false表示没有访问设备的权限。 |
Z
zengyawen 已提交
134

G
ge-yafang 已提交
135
**示例:**
Z
zengyawen 已提交
136

W
wu-chengwen 已提交
137 138 139 140 141
```js
let devicesName="1-1";
let bool = usb.hasRight(devicesName);
console.log(bool);
```
Z
zengyawen 已提交
142 143 144

## usb.requestRight

Y
YOUR_NAME 已提交
145
requestRight(deviceName: string): Promise<boolean>
Z
zengyawen 已提交
146

147
请求软件包的临时权限以访问设备。使用Promise异步回调。
Z
zengyawen 已提交
148

G
ge-yafang 已提交
149
**系统能力:**  SystemCapability.USB.USBManager
150

G
ge-yafang 已提交
151
**参数:**
152 153 154 155

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceName | string | 是 | 设备名称。 |
Z
zengyawen 已提交
156

G
ge-yafang 已提交
157
**返回值:**
158 159 160 161

| 类型 | 说明 |
| -------- | -------- |
| Promise<boolean> | Promise对象,返回临时权限的申请结果。返回true表示临时权限申请成功;返回false则表示临时权限申请失败。 |
Z
zengyawen 已提交
162

G
ge-yafang 已提交
163
**示例:**
W
wu-chengwen 已提交
164 165 166 167 168 169 170

```js
let devicesName="1-1";
usb.requestRight(devicesName).then((ret) => {
  console.log(`requestRight = ${JSON.stringify(ret)}`);
});
```
Z
zengyawen 已提交
171 172 173

## usb.claimInterface

Y
YOUR_NAME 已提交
174
claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number
Z
zengyawen 已提交
175 176 177 178 179

注册通信接口。

需要调用[usb.getDevices](#usbgetdevices)获取设备信息以及interfaces;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。

G
ge-yafang 已提交
180
**系统能力:**  SystemCapability.USB.USBManager
181

G
ge-yafang 已提交
182
**参数:**
183 184 185 186 187 188

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| iface | [USBInterface](#usbinterface) | 是 | 用于确定需要获取接口的索引。 |
| force | boolean | 否 | 可选参数,是否强制获取。默认值为false ,表示不强制获取。 |
Z
zengyawen 已提交
189

G
ge-yafang 已提交
190
**返回值:**
191 192 193 194

| 类型 | 说明 |
| -------- | -------- |
| number | 注册通信接口成功返回0;注册通信接口失败返回其他错误码。 |
Z
zengyawen 已提交
195

G
ge-yafang 已提交
196
**示例:**
Z
zengyawen 已提交
197

W
wu-chengwen 已提交
198 199 200 201
```js
let ret = usb.claimInterface(devicepipe, interfaces);
console.log(`claimInterface = ${ret}`);
```
Z
zengyawen 已提交
202 203 204

## usb.releaseInterface

Y
YOUR_NAME 已提交
205
releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number
Z
zengyawen 已提交
206 207 208 209 210

释放注册过的通信接口。

需要调用[usb.claimInterface](#usbclaiminterface)先获取接口,才能使用此方法释放接口。

G
ge-yafang 已提交
211
**系统能力:**  SystemCapability.USB.USBManager
212

G
ge-yafang 已提交
213
**参数:**
214 215 216 217 218

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| iface | [USBInterface](#usbinterface) | 是 | 用于确定需要释放接口的索引。 |
Z
zengyawen 已提交
219

G
ge-yafang 已提交
220
**返回值:**
221 222 223 224

| 类型 | 说明 |
| -------- | -------- |
| number | 释放接口成功返回0;释放接口失败返回其他错误码。 |
Z
zengyawen 已提交
225

G
ge-yafang 已提交
226
**示例:**
Z
zengyawen 已提交
227

W
wu-chengwen 已提交
228 229 230 231
```js
let ret = usb.releaseInterface(devicepipe, interfaces);
console.log(`releaseInterface = ${ret}`);
```
Z
zengyawen 已提交
232 233 234

## usb.setConfiguration

Y
YOUR_NAME 已提交
235
setConfiguration(pipe: USBDevicePipe, config: USBConfig): number
Z
zengyawen 已提交
236 237 238 239 240

设置设备配置。

需要调用[usb.getDevices](#usbgetdevices)获取设备信息以及config;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)得到devicepipe作为参数。

G
ge-yafang 已提交
241
**系统能力:**  SystemCapability.USB.USBManager
242

G
ge-yafang 已提交
243
**参数:**
244 245 246 247 248

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
| config | [USBConfig](#usbconfig) | 是 | 用于确定需要设置的配置。 |
Z
zengyawen 已提交
249

G
ge-yafang 已提交
250
**返回值:**
251 252 253 254

| 类型 | 说明 |
| -------- | -------- |
| number | 设置设备配置成功返回0;设置设备配置失败返回其他错误码。 |
Z
zengyawen 已提交
255

G
ge-yafang 已提交
256
**示例:**
W
wu-chengwen 已提交
257 258 259 260 261

```js
let ret = usb.setConfiguration(devicepipe, config);
console.log(`setConfiguration = ${ret}`);
```
Z
zengyawen 已提交
262 263 264

## usb.setInterface

Y
YOUR_NAME 已提交
265
setInterface(pipe: USBDevicePipe, iface: USBInterface): number
Z
zengyawen 已提交
266 267 268

设置设备接口。

269
需要调用[usb.getDevices](#usbgetdevices)获取设备列表以及interfaces;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)得到devicepipe作为参数;调用[usb.claimInterface](#usbclaiminterface)注册通信接口。
Z
zengyawen 已提交
270

G
ge-yafang 已提交
271
**系统能力:**  SystemCapability.USB.USBManager
272

G
ge-yafang 已提交
273
**参数:**
274

W
wu-chengwen 已提交
275 276 277 278
| 参数名   | 类型                              | 必填  | 说明            |
| ----- | ------------------------------- | --- | ------------- |
| pipe  | [USBDevicePipe](#usbdevicepipe) | 是   | 用于确定总线号和设备地址。 |
| iface | [USBInterface](#usbinterface)   | 是   | 用于确定需要设置的接口。  |
Z
zengyawen 已提交
279

G
ge-yafang 已提交
280
**返回值:**
281 282 283 284

| 类型 | 说明 |
| -------- | -------- |
| number | 设置设备接口成功返回0;设置设备接口失败返回其他错误码。 |
Z
zengyawen 已提交
285

G
ge-yafang 已提交
286
**示例:**
W
wu-chengwen 已提交
287 288 289 290 291

```js
let ret = usb.setInterface(devicepipe, interfaces);
console.log(`setInterface = ${ret}`);
```
Z
zengyawen 已提交
292 293 294

## usb.getRawDescriptor

Y
YOUR_NAME 已提交
295
getRawDescriptor(pipe: USBDevicePipe): Uint8Array
Z
zengyawen 已提交
296 297 298 299 300

获取原始的USB描述符。

需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。

G
ge-yafang 已提交
301
**系统能力:**  SystemCapability.USB.USBManager
302

G
ge-yafang 已提交
303
**参数:**
W
wu-chengwen 已提交
304

305 306 307
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
Z
zengyawen 已提交
308

G
ge-yafang 已提交
309
**返回值:**
310

311 312 313
| 类型 | 说明 |
| -------- | -------- |
| Uint8Array | 返回获取的原始数据;失败返回undefined。 |
Z
zengyawen 已提交
314

G
ge-yafang 已提交
315
**示例:**
Z
zengyawen 已提交
316

W
wu-chengwen 已提交
317 318 319
```js
let ret = usb.getRawDescriptor(devicepipe);
```
Z
zengyawen 已提交
320 321 322

## usb.getFileDescriptor

Y
YOUR_NAME 已提交
323
getFileDescriptor(pipe: USBDevicePipe): number
Z
zengyawen 已提交
324 325 326 327 328

获取文件描述符。

需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。

G
ge-yafang 已提交
329
**系统能力:**  SystemCapability.USB.USBManager
330

G
ge-yafang 已提交
331
**参数:**
332 333 334 335

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定总线号和设备地址。 |
Z
zengyawen 已提交
336

G
ge-yafang 已提交
337 338
**返回值:**

W
wu-chengwen 已提交
339 340
| 类型     | 说明                   |
| ------ | -------------------- |
341
| number | 返回设备对应的文件描述符;失败返回-1。 |
Z
zengyawen 已提交
342

G
ge-yafang 已提交
343
**示例:**
Z
zengyawen 已提交
344

W
wu-chengwen 已提交
345 346 347
```js
let ret = usb.getFileDescriptor(devicepipe);
```
Z
zengyawen 已提交
348 349 350

## usb.controlTransfer

Y
YOUR_NAME 已提交
351
controlTransfer(pipe: USBDevicePipe, contrlparam: USBControlParams, timeout?: number): Promise<number>
Z
zengyawen 已提交
352 353 354 355 356

控制传输。

需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)接口得到devicepipe作为参数。

G
ge-yafang 已提交
357
**系统能力:**  SystemCapability.USB.USBManager
358

G
ge-yafang 已提交
359
**参数:**
360 361 362 363 364 365

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定设备。 |
| contrlparam | [USBControlParams](#usbcontrolparams) | 是 | 控制传输参数。 |
| timeout | number | 否 | 超时时间(单位:ms),可选参数,默认为0不超时。 |
Z
zengyawen 已提交
366

G
ge-yafang 已提交
367
**返回值:**
368 369 370 371

| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | Promise对象,获取传输或接收到的数据块大小。失败返回-1。 |
Z
zengyawen 已提交
372

G
ge-yafang 已提交
373
**示例:**
Z
zengyawen 已提交
374

W
wu-chengwen 已提交
375 376 377 378 379
```js
usb.controlTransfer(devicepipe, USBControlParams).then((ret) => {
 console.log(`controlTransfer = ${JSON.stringify(ret)}`);
})
```
Z
zengyawen 已提交
380 381 382

## usb.bulkTransfer

Y
YOUR_NAME 已提交
383
bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise<number>
Z
zengyawen 已提交
384 385 386 387 388

批量传输。

需要调用[usb.getDevices](#usbgetdevices)获取设备信息列表以及endpoint;再调用[usb.requestRight](#usbrequestright)获取设备请求权限;然后调用[usb.connectDevice](#usbconnectdevice)接口得到返回数据devicepipe之后,再次获取接口[usb.claimInterface](#usbclaiminterface);再调用usb.bulkTransfer接口。

G
ge-yafang 已提交
389
**系统能力:**  SystemCapability.USB.USBManager
390

G
ge-yafang 已提交
391
**参数:**
392 393 394 395 396 397

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定设备。 |
| endpoint | [USBEndpoint](#usbendpoint) | 是 | 用于确定传输的端口。 |
| buffer | Uint8Array | 是 | 用于写入或读取的缓冲区。 |
398
| timeout | number | 否 | 超时时间(单位:ms),可选参数,默认为0不超时。|
Z
zengyawen 已提交
399

G
ge-yafang 已提交
400
**返回值:**
401 402 403 404

| 类型 | 说明 |
| -------- | -------- |
| Promise<number> | Promise对象,获取传输或接收到的数据块大小。失败返回-1。 |
Z
zengyawen 已提交
405

G
ge-yafang 已提交
406
**示例:**
Z
zengyawen 已提交
407

W
wu-chengwen 已提交
408 409 410 411 412 413 414 415
```js
//usb.getDevices 接口返回数据集合,取其中一个设备对象,并获取权限 。
//把获取到的设备对象作为参数传入usb.connectDevice;当usb.connectDevice接口成功返回之后;
//才可以调用第三个接口usb.claimInterface.当usb.claimInterface 调用成功以后,再调用该接口。
usb.bulkTransfer(devicepipe, endpoint, buffer).then((ret) => {
 console.log(`bulkTransfer = ${JSON.stringify(ret)}`);
});
```
Z
zengyawen 已提交
416 417 418

## usb.closePipe

Y
YOUR_NAME 已提交
419
closePipe(pipe: USBDevicePipe): number
Z
zengyawen 已提交
420 421 422 423 424

关闭设备消息控制通道。

需要调用[usb.getDevices](#usbgetdevices)获取设备列表;调用[usb.requestRight](#usbrequestright)获取设备请求权限;调用[usb.connectDevice](#usbconnectdevice)得到devicepipe作为参数。

G
ge-yafang 已提交
425
**系统能力:**  SystemCapability.USB.USBManager
426

G
ge-yafang 已提交
427
**参数:**
428 429 430 431

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pipe | [USBDevicePipe](#usbdevicepipe) | 是 | 用于确定USB设备消息控制通道。 |
Z
zengyawen 已提交
432

G
ge-yafang 已提交
433
**返回值:**
434 435 436 437

| 类型 | 说明 |
| -------- | -------- |
| number | 关闭设备消息控制通道成功返回0;关闭设备消息控制通道失败返回其他错误码。 |
Z
zengyawen 已提交
438

G
ge-yafang 已提交
439
**示例:**
Z
zengyawen 已提交
440

W
wu-chengwen 已提交
441 442 443 444 445 446 447 448 449
```js
let ret = usb.closePipe(devicepipe);
console.log(`closePipe = ${ret}`);
```

## usb.usbFunctionsFromString<sup>9+</sup>

usbFunctionsFromString(funcs: string): number

450
在设备模式下,将字符串形式的USB功能列表转化为数字掩码。
W
wu-chengwen 已提交
451

452
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478

**系统能力:**  SystemCapability.USB.USBManager

**参数:**

| 参数名 | 类型   | 必填 | 说明                   |
| ------ | ------ | ---- | ---------------------- |
| funcs  | string | 是   | 字符串形式的功能列表。 |

**返回值:**

| 类型   | 说明               |
| ------ | ------------------ |
| number | 转化后的数字掩码。 |

**示例:**

```js
let funcs = "acm";
let ret = usb.usbFunctionsFromString(funcs);
```

## usb.usbFunctionsToString<sup>9+</sup>

usbFunctionsToString(funcs: FunctionType): string

479
在设备模式下,将数字掩码形式的USB功能列表转化为字符串。
W
wu-chengwen 已提交
480

481
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
482 483 484 485 486 487 488

**系统能力:**  SystemCapability.USB.USBManager

**参数:**

| 参数名 | 类型                           | 必填 | 说明              |
| ------ | ------------------------------ | ---- | ----------------- |
489
| funcs  | [FunctionType](#functiontype9) | 是   | USB功能数字掩码。 |
W
wu-chengwen 已提交
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509

**返回值:**

| 类型   | 说明                           |
| ------ | ------------------------------ |
| string | 转化后的字符串形式的功能列表。 |

**示例:**

```js
let funcs = ACM | ECM;
let ret = usb.usbFunctionsToString(funcs);
```

## usb.setCurrentFunctions<sup>9+</sup>

setCurrentFunctions(funcs: FunctionType): Promise\<boolean\>

在设备模式下,设置当前的USB功能列表。

510
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
511 512 513 514 515 516 517 518 519 520 521

**系统能力:**  SystemCapability.USB.USBManager

**参数:**

| 参数名 | 类型                           | 必填 | 说明              |
| ------ | ------------------------------ | ---- | ----------------- |
| funcs  | [FunctionType](#functiontype9) | 是   | USB功能数字掩码。 |

**返回值:**

522 523 524
| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | Promise对象,返回设置成功与否的结果。true表示设置成功,false表示设置失败。 |
W
wu-chengwen 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538

**示例:**

```js
let funcs = HDC;
let ret = usb.setCurrentFunctions(funcs);
```

## usb.getCurrentFunctions<sup>9+</sup>

getCurrentFunctions(): FunctionType

在设备模式下,获取当前的USB功能列表的数字组合掩码。

539
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

**系统能力:**  SystemCapability.USB.USBManager

**返回值:**

| 类型                           | 说明                              |
| ------------------------------ | --------------------------------- |
| [FunctionType](#functiontype9) | 当前的USB功能列表的数字组合掩码。 |

**示例:**

```js
let ret = usb.getCurrentFunctions();
```

## usb.getPorts<sup>9+</sup>

getPorts(): Array\<USBPort\>

获取所有物理USB端口描述信息。

561
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

**系统能力:**  SystemCapability.USB.USBManager

**返回值:**

| 类型                          | 说明                  |
| ----------------------------- | --------------------- |
| [Array\<USBPort\>](#usbport9) | USB端口描述信息列表。 |

**示例:**

```js
let ret = usb.getPorts();
```

## usb.getSupportedModes<sup>9+</sup>

getSupportedModes(portId: number): PortModeType

获取指定的端口支持的模式列表的组合掩码。

583
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610

**系统能力:**  SystemCapability.USB.USBManager

**参数:**

| 参数名 | 类型   | 必填 | 说明     |
| ------ | ------ | ---- | -------- |
| portId | number | 是   | 端口号。 |

**返回值:**

| 类型                           | 说明                       |
| ------------------------------ | -------------------------- |
| [PortModeType](#portmodetype9) | 支持的模式列表的组合掩码。 |

**示例:**

```js
let ret = usb.getSupportedModes(0);
```

## usb.setPortRoles<sup>9+</sup>

setPortRoles(portId: number, powerRole: PowerRoleType, dataRole: DataRoleType): Promise\<boolean\>

设置指定的端口支持的角色模式,包含充电角色、数据传输角色。

611
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
612 613 614 615 616 617 618 619 620 621 622 623 624

**系统能力:**  SystemCapability.USB.USBManager

**参数:**

| 参数名    | 类型                             | 必填 | 说明             |
| --------- | -------------------------------- | ---- | ---------------- |
| portId    | number                           | 是   | 端口号。         |
| powerRole | [PowerRoleType](#powerroletype9) | 是   | 充电的角色。     |
| dataRole  | [DataRoleType](#dataroletype9)   | 是   | 数据传输的角色。 |

**返回值:**

625 626 627
| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | Promise对象,返回设置成功与否的结果。true表示设置成功,false表示设置失败。 |
W
wu-chengwen 已提交
628 629 630 631 632 633

**示例:**

```js
let ret = usb.getSupportedModes(0);
```
Z
zengyawen 已提交
634 635 636 637 638

## USBEndpoint

通过USB发送和接收数据的端口。通过[USBInterface](#usbinterface)获取。

639
**系统能力:** SystemCapability.USB.USBManager
Z
zengyawen 已提交
640

W
wu-chengwen 已提交
641 642 643 644 645 646 647 648 649 650
| 名称            | 参数类型                                        | 说明            |
| ------------- | ------------------------------------------- | ------------- |
| address       | number                                      | 端点地址。         |
| attributes    | number                                      | 端点属性。         |
| interval      | number                                      | 端点间隔。         |
| maxPacketSize | number                                      | 端点最大数据包大小。    |
| direction     | [USBRequestDirection](#usbrequestdirection) | 端点的方向。        |
| number        | number                                      | 端点号。          |
| type          | number                                      | 端点类型。         |
| interfaceId   | number                                      | 端点所属的接口的唯一标识。 |
Z
zengyawen 已提交
651 652 653 654 655

## USBInterface

一个[USBConfig](#usbconfig)中可以含有多个USBInterface,每个USBInterface提供一个功能。

656
**系统能力:** SystemCapability.USB.USBManager
Z
zengyawen 已提交
657

W
wu-chengwen 已提交
658 659 660 661 662 663 664 665 666
| 名称               | 参数类型                                     | 说明                    |
| ---------------- | ---------------------------------------- | --------------------- |
| id               | number                                   | 接口的唯一标识。              |
| protocol         | number                                   | 接口的协议。                |
| clazz            | number                                   | 设备类型。                 |
| subClass         | number                                   | 设备子类。                 |
| alternateSetting | number                                   | 在同一个接口中的多个描述符中进行切换设置。 |
| name             | string                                   | 接口名称。                 |
| endpoints        | Array&lt;[USBEndpoint](#usbendpoint)&gt; | 当前接口所包含的端点。           |
Z
zengyawen 已提交
667 668 669 670 671

## USBConfig

USB配置,一个[USBDevice](#usbdevice)中可以含有多个配置。

672
**系统能力:** SystemCapability.USB.USBManager
Z
zengyawen 已提交
673

W
wu-chengwen 已提交
674 675 676 677 678 679 680 681 682
| 名称             | 参数类型                                             | 说明              |
| -------------- | ------------------------------------------------ | --------------- |
| id             | number                                           | 配置的唯一标识。        |
| attributes     | number                                           | 配置的属性。          |
| maxPower       | number                                           | 最大功耗,以毫安为单位。    |
| name           | string                                           | 配置的名称,可以为空。     |
| isRemoteWakeup | boolean                                          | 检查当前配置是否支持远程唤醒。 |
| isSelfPowered  | boolean                                          | 检查当前配置是否支持独立电源。 |
| interfaces     | Array&nbsp;&lt;[USBInterface](#usbinterface)&gt; | 配置支持的接口属性。      |
Z
zengyawen 已提交
683 684 685 686 687

## USBDevice

USB设备信息。

688
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

| 名称               | 参数类型                                 | 说明         |
| ---------------- | ------------------------------------ | ---------- |
| busNum           | number                               | 总线地址。      |
| devAddress       | number                               | 设备地址。      |
| serial           | string                               | 序列号。       |
| name             | string                               | 设备名字。      |
| manufacturerName | string                               | 产商信息。      |
| productName      | string                               | 产品信息。      |
| version          | string                               | 版本。        |
| vendorId         | number                               | 厂商ID。      |
| productId        | number                               | 产品ID。      |
| clazz            | number                               | 设备类。       |
| subClass         | number                               | 设备子类。      |
| protocol         | number                               | 设备协议码。     |
| configs          | Array&lt;[USBConfig](#usbconfig)&gt; | 设备配置描述符信息。 |
Z
zengyawen 已提交
705 706 707 708 709

## USBDevicePipe

USB设备消息传输通道,用于确定设备。

710
**系统能力:** SystemCapability.USB.USBManager
Z
zengyawen 已提交
711

W
wu-chengwen 已提交
712 713 714 715
| 名称         | 参数类型   | 说明    |
| ---------- | ------ | ----- |
| busNum     | number | 总线地址。 |
| devAddress | number | 设备地址。 |
Z
zengyawen 已提交
716 717 718 719 720

## USBControlParams

控制传输参数。

721
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
722 723 724 725 726 727 728 729 730 731 732 733 734 735

| 名称      | 参数类型                                            | 说明               |
| ------- | ----------------------------------------------- | ---------------- |
| request | number                                          | 请求类型。            |
| target  | [USBRequestTargetType](#usbrequesttargettype)   | 请求目标类型。          |
| reqType | [USBControlRequestType](#usbcontrolrequesttype) | 请求控制类型。          |
| value   | number                                          | 请求参数。            |
| index   | number                                          | 请求参数value对应的索引值。 |
| data    | Uint8Array                                      | 用于写入或读取的缓冲区。     |

## USBPort<sup>9+</sup>

USB设备端口。

736
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
737

738
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
739 740 741 742 743 744 745 746 747 748

| 名称           | 参数类型                         | 说明                                |
| -------------- | -------------------------------- | ----------------------------------- |
| id             | number                           | USB端口唯一标识。                   |
| supportedModes | [PortModeType](#portmodetype9)   | USB端口所支持的模式的数字组合掩码。 |
| status         | [USBPortStatus](#usbportstatus9) | USB端口角色。                       |

## USBPortStatus<sup>9+</sup>

USB设备端口角色信息。
749

750
**系统接口:** 此接口为系统接口。
Z
zengyawen 已提交
751

752
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
753 754 755 756 757 758

| 名称             | 参数类型 | 说明                   |
| ---------------- | -------- | ---------------------- |
| currentMode      | number   | 当前的USB模式。        |
| currentPowerRole | number   | 当前设备充电模式。     |
| currentDataRole  | number   | 当前设备数据传输模式。 |
Z
zengyawen 已提交
759 760 761 762 763

## USBRequestTargetType

请求目标类型。

764
**系统能力:** SystemCapability.USB.USBManager
Z
zengyawen 已提交
765

W
wu-chengwen 已提交
766 767 768 769 770 771
| 名称                         | 值   | 说明   |
| ---------------------------- | ---- | ------ |
| USB_REQUEST_TARGET_DEVICE    | 0    | 设备。 |
| USB_REQUEST_TARGET_INTERFACE | 1    | 接口。 |
| USB_REQUEST_TARGET_ENDPOINT  | 2    | 端点。 |
| USB_REQUEST_TARGET_OTHER     | 3    | 其他。 |
Z
zengyawen 已提交
772 773 774 775 776

## USBControlRequestType

控制请求类型。

777
**系统能力:** SystemCapability.USB.USBManager
Z
zengyawen 已提交
778

W
wu-chengwen 已提交
779 780 781 782 783
| 名称                      | 值   | 说明   |
| ------------------------- | ---- | ------ |
| USB_REQUEST_TYPE_STANDARD | 0    | 标准。 |
| USB_REQUEST_TYPE_CLASS    | 1    | 类。   |
| USB_REQUEST_TYPE_VENDOR   | 2    | 厂商。 |
Z
zengyawen 已提交
784 785 786 787 788

## USBRequestDirection

请求方向。

789
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
790 791 792 793 794 795 796 797 798 799

| 名称                        | 值   | 说明                     |
| --------------------------- | ---- | ------------------------ |
| USB_REQUEST_DIR_TO_DEVICE   | 0    | 写数据,主设备往从设备。 |
| USB_REQUEST_DIR_FROM_DEVICE | 0x80 | 读数据,从设备往主设备。 |

## FunctionType<sup>9+</sup>

USB设备侧功能。

800
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
801

802
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
803

W
wu-chengwen 已提交
804 805 806 807 808 809 810 811 812 813 814 815
| 名称         | 值   | 说明       |
| ------------ | ---- | ---------- |
| NONE         | 0    | 没有功能。 |
| ACM          | 1    | acm功能。  |
| ECM          | 2    | ecm功能。  |
| HDC          | 4    | hdc功能。  |
| MTP          | 8    | 暂不支持。 |
| PTP          | 16   | 暂不支持。 |
| RNDIS        | 32   | 暂不支持。 |
| MIDI         | 64   | 暂不支持。 |
| AUDIO_SOURCE | 128  | 暂不支持。 |
| NCM          | 256  | 暂不支持。 |
W
wu-chengwen 已提交
816 817 818 819 820

## PortModeType<sup>9+</sup>

USB端口模式类型。

821
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
822

823
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
824 825 826 827 828 829 830 831 832 833 834 835 836

| 名称      | 值   | 说明                                                 |
| --------- | ---- | ---------------------------------------------------- |
| NONE      | 0    | 无。                                                 |
| UFP       | 1    | 数据上行,需要外部供电。                             |
| DFP       | 2    | 数据下行,对外提供电源。                             |
| DRP       | 3    | 既可以做DFP(Host),也可以做UFP(Device),当前不支持。 |
| NUM_MODES | 4    | 当前不支持。                                         |

## PowerRoleType<sup>9+</sup>

电源角色类型。

837
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
838

839
**系统能力:** SystemCapability.USB.USBManager
W
wu-chengwen 已提交
840 841 842 843 844 845 846 847 848 849 850

| 名称   | 值   | 说明       |
| ------ | ---- | ---------- |
| NONE   | 0    | 无。       |
| SOURCE | 1    | 外部供电。 |
| SINK   | 2    | 内部供电。 |

## DataRoleType<sup>9+</sup>

数据角色类型。

851
**系统接口:** 此接口为系统接口。
W
wu-chengwen 已提交
852

853
**系统能力:** SystemCapability.USB.USBManager
854

W
wu-chengwen 已提交
855 856 857 858 859
| 名称   | 值   | 说明         |
| ------ | ---- | ------------ |
| NONE   | 0    | 无。         |
| HOST   | 1    | 主设备角色。 |
| DEVICE | 2    | 从设备角色。 |
W
wu-chengwen 已提交
860