USB管理

本模塊主要提供管理USB設備的相關功能，包括查詢USB設備列表、批量數據傳輸、控制命令傳輸、權限控制等。

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import usb from "@ohos.usb";

usb.getDevices

getDevices(): Array>

獲取USB設備列表。

系統能力： SystemCapability.USB.USBManager

返回值：

示例：

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,
              },
            ],
          },
        ],
      },
    ],
  },
]

usb.connectDevice

connectDevice(device: USBDevice): Readonly

打開USB設備。

需要調用[usb.getDevices]獲取設備信息以及device；再調用[usb.requestRight]獲取設備請求權限。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let devicepipe= usb.connectDevice(device);
console.log(`devicepipe = ${JSON.stringify(devicepipe)}`);

usb.hasRight

hasRight(deviceName: string): boolean

判斷是否有權訪問該設備。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let devicesName="1-1";
let bool = usb.hasRight(devicesName);
console.log(bool);

usb.requestRight

requestRight(deviceName: string): Promise

請求軟件包的臨時權限以訪問設備。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let devicesName="1-1";
usb.requestRight(devicesName).then((ret) = > {
  console.log(`requestRight = ${JSON.stringify(ret)}`);
});

usb.claimInterface

claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number

注冊通信接口。

需要調用[usb.getDevices]獲取設備信息以及interfaces；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]接口得到devicepipe作為參數。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.claimInterface(devicepipe, interfaces);
console.log(`claimInterface = ${ret}`);

usb.releaseInterface

releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number

釋放注冊過的通信接口。

需要調用[usb.claimInterface]先獲取接口，才能使用此方法釋放接口。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.releaseInterface(devicepipe, interfaces);
console.log(`releaseInterface = ${ret}`);

usb.setConfiguration

setConfiguration(pipe: USBDevicePipe, config: USBConfig): number

設置設備配置。

需要調用[usb.getDevices]獲取設備信息以及config；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]得到devicepipe作為參數。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.setConfiguration(devicepipe, config);
console.log(`setConfiguration = ${ret}`);

usb.setInterface

setInterface(pipe: USBDevicePipe, iface: USBInterface): number

設置設備接口。

需要調用[usb.getDevices]獲取設備列表以及interfaces；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]得到devicepipe作為參數；調用[usb.claimInterface]注冊通信接口。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.setInterface(devicepipe, interfaces);
console.log(`setInterface = ${ret}`);

usb.getRawDescriptor

getRawDescriptor(pipe: USBDevicePipe): Uint8Array

獲取原始的USB描述符。

需要調用[usb.getDevices]獲取設備列表；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]接口得到devicepipe作為參數。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.getRawDescriptor(devicepipe);

usb.getFileDescriptor

getFileDescriptor(pipe: USBDevicePipe): number

獲取文件描述符。

需要調用[usb.getDevices]獲取設備列表；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]接口得到devicepipe作為參數。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.getFileDescriptor(devicepipe);

usb.controlTransfer

controlTransfer(pipe: USBDevicePipe, contrlparam: USBControlParams, timeout?: number): Promise

控制傳輸。

需要調用[usb.getDevices]獲取設備列表；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]接口得到devicepipe作為參數。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

usb.controlTransfer(devicepipe, USBControlParams).then((ret) = > {
 console.log(`controlTransfer = ${JSON.stringify(ret)}`);
})

usb.bulkTransfer

bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise

批量傳輸。

需要調用[usb.getDevices]獲取設備信息列表以及endpoint；再調用[usb.requestRight]獲取設備請求權限；然后調用[usb.connectDevice]接口得到返回數據devicepipe之后，再次獲取接口[usb.claimInterface]；再調用usb.bulkTransfer接口。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

//usb.getDevices 接口返回數據集合，取其中一個設備對象，并獲取權限 。
//把獲取到的設備對象作為參數傳入usb.connectDevice;當usb.connectDevice接口成功返回之后；
//才可以調用第三個接口usb.claimInterface.當usb.claimInterface 調用成功以后,再調用該接口。
usb.bulkTransfer(devicepipe, endpoint, buffer).then((ret) = > {
 console.log(`bulkTransfer = ${JSON.stringify(ret)}`);
});

usb.closePipe

closePipe(pipe: USBDevicePipe): number

關閉設備消息控制通道。

需要調用[usb.getDevices]獲取設備列表；調用[usb.requestRight]獲取設備請求權限；調用[usb.connectDevice]得到devicepipe作為參數。

系統能力： SystemCapability.USB.USBManager

參數：

返回值：

示例：

let ret = usb.closePipe(devicepipe);
console.log(`closePipe = ${ret}`);

USBEndpoint

通過USB發送和接收數據的端口。通過[USBInterface]獲取。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBInterface

一個[USBConfig]中可以含有多個USBInterface，每個USBInterface提供一個功能。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBConfig

USB配置，一個[USBDevice]中可以含有多個配置。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBDevice

USB設備信息。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBDevicePipe

USB設備消息傳輸通道，用于確定設備。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBControlParams

控制傳輸參數。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBRequestTargetType

請求目標類型。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBControlRequestType

控制請求類型。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

USBRequestDirection

請求方向。

系統能力 ：以下各項對應的系統能力均為 SystemCapability.USB.USBManager。

審核編輯 黃宇