USB管理

導(dǎo)入模塊

```ts
import usb from "@ohos.usbManager";

usb.getDevices

getDevices(): Array<Readonly<USBDevice>>

獲取接入主設(shè)備的USB設(shè)備列表。如果沒有設(shè)備接入，那么將會(huì)返回一個(gè)空的列表。

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

返回值：

示例：

```ts 
let devicesList: Array<usb.USBDevice> = usb.getDevices();
console.log(`devicesList = ${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<USBDevicePipe>

根據(jù)getDevices()返回的設(shè)備信息打開USB設(shè)備。

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

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

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹參見USB錯(cuò)誤碼。

示例：

```ts 
let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}
let device: USBDevice = devicesList[0];
usb.requestRight(device.name);
let devicepipe: USBDevicePipe = usb.connectDevice(device);
console.log(`devicepipe = ${devicepipe}`);

usb.hasRight

hasRight(deviceName: string): boolean

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

如果“使用者”（如各種App或系統(tǒng)）有權(quán)訪問設(shè)備則返回true；無權(quán)訪問設(shè)備則返回false。

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

參數(shù)：

返回值：

示例：

let devicesName="1-1";
let bool = usb.hasRight(devicesName);
console.log(`${bool}`);

usb.requestRight

requestRight(deviceName: string): Promise<boolean>

請(qǐng)求軟件包的臨時(shí)權(quán)限以訪問設(shè)備。使用Promise異步回調(diào)。

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

參數(shù)：

返回值：

示例：

```ts 
let devicesName: string = "1-1"; 
usb.requestRight(devicesName:).then((ret: number) => {
  console.log(`requestRight = ${ret}`);
});

usb.removeRight

removeRight(deviceName: string): boolean

移除軟件包訪問設(shè)備的權(quán)限。

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

參數(shù)：

返回值：

示例：

let devicesName="1-1";
if (usb.removeRight(devicesName)) {
  console.log(`Succeed in removing right`);
}

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è)過的通信接口。

需要調(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: USBConfiguration): 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, controlparam: USBControlParams, timeout ?: number): Promise<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 param = {
  request: 0,
  reqType: 0,
  target:0,
  value: 0,
  index: 0,
  data: null
};
usb.controlTransfer(devicepipe, param).then((ret) => {
 console.log(`controlTransfer = ${ret}`);
})

usb.bulkTransfer

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

批量傳輸。

需要調(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 = ${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

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

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

USBInterface

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

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

USBConfiguration

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

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

USBDevice

USB設(shè)備信息。

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

USBDevicePipe

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

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

USBControlParams

控制傳輸參數(shù)。

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

USBRequestTargetType

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

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

USBControlRequestType

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

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

USBRequestDirection

請(qǐng)求方向。

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