USB管理

本模塊主要提供管理USB設(shè)備的相關(guān)功能，包括查詢USB設(shè)備列表、批量數(shù)據(jù)傳輸、控制命令傳輸、權(quán)限控制等。

說(shuō)明：
開(kāi)發(fā)前請(qǐng)熟悉鴻蒙開(kāi)發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模塊首批接口從API version 8開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

import usb from "@ohos.usb";

usb.getDevices

getDevices(): Array>

獲取USB設(shè)備列表。

系統(tǒng)能力： SystemCapability.USB.USBManager

返回值：

示例：

let devicesList = usb.getDevices();
console.log(`devicesList = ${JSON.stringify(devicesList)}`);
//devicesList  返回的數(shù)據(jù)結(jié)構(gòu)
//此處提供一個(gè)簡(jiǎn)單的示例，如下
[
  {
    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

打開(kāi)USB設(shè)備。

需要調(diào)用[usb.getDevices]獲取設(shè)備信息以及device；再調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.hasRight

hasRight(deviceName: string): boolean

判斷是否有權(quán)訪問(wèn)該設(shè)備。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.requestRight

requestRight(deviceName: string): Promise

請(qǐng)求軟件包的臨時(shí)權(quán)限以訪問(wèn)設(shè)備。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

注冊(cè)通信接口。

需要調(diào)用[usb.getDevices]獲取設(shè)備信息以及interfaces；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]接口得到devicepipe作為參數(shù)。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.releaseInterface

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

釋放注冊(cè)過(guò)的通信接口。

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

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.setConfiguration

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

設(shè)置設(shè)備配置。

需要調(diào)用[usb.getDevices]獲取設(shè)備信息以及config；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]得到devicepipe作為參數(shù)。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.setInterface

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

設(shè)置設(shè)備接口。

需要調(diào)用[usb.getDevices]獲取設(shè)備列表以及interfaces；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]得到devicepipe作為參數(shù)；調(diào)用[usb.claimInterface]注冊(cè)通信接口。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.getRawDescriptor

getRawDescriptor(pipe: USBDevicePipe): Uint8Array

獲取原始的USB描述符。

需要調(diào)用[usb.getDevices]獲取設(shè)備列表；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]接口得到devicepipe作為參數(shù)。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

let ret = usb.getRawDescriptor(devicepipe);

usb.getFileDescriptor

getFileDescriptor(pipe: USBDevicePipe): number

獲取文件描述符。

需要調(diào)用[usb.getDevices]獲取設(shè)備列表；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]接口得到devicepipe作為參數(shù)。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

let ret = usb.getFileDescriptor(devicepipe);

usb.controlTransfer

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

控制傳輸。

需要調(diào)用[usb.getDevices]獲取設(shè)備列表；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]接口得到devicepipe作為參數(shù)。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

usb.bulkTransfer

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

批量傳輸。

需要調(diào)用[usb.getDevices]獲取設(shè)備信息列表以及endpoint；再調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；然后調(diào)用[usb.connectDevice]接口得到返回?cái)?shù)據(jù)devicepipe之后，再次獲取接口[usb.claimInterface]；再調(diào)用usb.bulkTransfer接口。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

//usb.getDevices 接口返回?cái)?shù)據(jù)集合，取其中一個(gè)設(shè)備對(duì)象，并獲取權(quán)限 。
//把獲取到的設(shè)備對(duì)象作為參數(shù)傳入usb.connectDevice;當(dāng)usb.connectDevice接口成功返回之后；
//才可以調(diào)用第三個(gè)接口usb.claimInterface.當(dāng)usb.claimInterface 調(diào)用成功以后,再調(diào)用該接口。
usb.bulkTransfer(devicepipe, endpoint, buffer).then((ret) = > {
 console.log(`bulkTransfer = ${JSON.stringify(ret)}`);
});

usb.closePipe

closePipe(pipe: USBDevicePipe): number

關(guān)閉設(shè)備消息控制通道。

需要調(diào)用[usb.getDevices]獲取設(shè)備列表；調(diào)用[usb.requestRight]獲取設(shè)備請(qǐng)求權(quán)限；調(diào)用[usb.connectDevice]得到devicepipe作為參數(shù)。

系統(tǒng)能力： SystemCapability.USB.USBManager

參數(shù)：

返回值：

示例：

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

USBEndpoint

通過(guò)USB發(fā)送和接收數(shù)據(jù)的端口。通過(guò)[USBInterface]獲取。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBInterface

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

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBConfig

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

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBDevice

USB設(shè)備信息。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBDevicePipe

USB設(shè)備消息傳輸通道，用于確定設(shè)備。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBControlParams

控制傳輸參數(shù)。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBRequestTargetType

請(qǐng)求目標(biāo)類型。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBControlRequestType

控制請(qǐng)求類型。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

USBRequestDirection

請(qǐng)求方向。

系統(tǒng)能力 ：以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為 SystemCapability.USB.USBManager。

審核編輯 黃宇