@ohos.usbManager (USB管理)

本模块主要提供管理USB设备的相关功能，包括主设备上查询USB设备列表、批量数据传输、控制命令传输、权限控制等；从设备上端口管理、功能切换及查询等。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import usb from "@ohos.usbManager";

usb.getDevices

getDevices(): Array<Readonly<USBDevice>>

获取接入主设备的USB设备列表。如果没有设备接入，那么将会返回一个空的列表。

系统能力： SystemCapability.USB.USBManager

返回值：

示例：

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

根据getDevices()返回的设备信息打开USB设备。

需要调用usb.getDevices获取设备信息以及device，再调用usb.requestRight请求使用该设备的权限。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

错误码：

以下错误码的详细介绍参见USB服务错误码。

示例：

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

let device: usb.USBDevice = devicesList[0];
usb.requestRight(device.name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(device);
console.log(`devicepipe = ${devicepipe}`);

usb.hasRight

hasRight(deviceName: string): boolean

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

如果“使用者”（如各种App或系统）有权访问设备则返回true；无权访问设备则返回false。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesName: string = "1-1";
let right: boolean = usb.hasRight(devicesName);
console.log(`${right}`);

usb.requestRight

requestRight(deviceName: string): Promise<boolean>

请求软件包的临时权限以访问设备。使用Promise异步回调。系统应用默认拥有访问设备权限，无需调用此接口申请。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

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

usb.removeRight

removeRight(deviceName: string): boolean

移除软件包访问设备的权限。系统应用默认拥有访问设备权限，调用此接口不会产生影响。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

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

usb.claimInterface

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

注册通信接口。

需要调用usb.getDevices获取设备信息以及interfaces；调用usb.requestRight获取设备请求权限；调用usb.connectDevice接口得到devicepipe作为参数。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

let device: usb.USBDevice = devicesList[0];
usb.requestRight(device.name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(device);
let interfaces: usb.USBInterface = device.configs[0].interfaces[0];
let ret: number= usb.claimInterface(devicepipe, interfaces);
console.log(`claimInterface = ${ret}`);

usb.releaseInterface

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

释放注册过的通信接口。

需要调用usb.claimInterface先获取接口，才能使用此方法释放接口。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

let device: usb.USBDevice = devicesList[0];
usb.requestRight(device.name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(device);
let interfaces: usb.USBInterface = device.configs[0].interfaces[0];
let ret: number = usb.claimInterface(devicepipe, interfaces);
ret = usb.releaseInterface(devicepipe, interfaces);
console.log(`releaseInterface = ${ret}`);

usb.setConfiguration

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

设置设备配置。

需要调用usb.getDevices获取设备信息以及config；调用usb.requestRight获取设备请求权限；调用usb.connectDevice得到devicepipe作为参数。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

let device: usb.USBDevice = devicesList[0];
usb.requestRight(device.name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(device);
let config: usb.USBConfiguration = device.configs[0];
let ret: number= 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 devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

let device: usb.USBDevice = devicesList[0];
usb.requestRight(device.name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(device);
let interfaces: usb.USBInterface = device.configs[0].interfaces[0];
let ret: number = usb.claimInterface(devicepipe, interfaces);
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 devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

usb.requestRight(devicesList[0].name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(devicesList[0]);
let ret: Uint8Array = usb.getRawDescriptor(devicepipe);

usb.getFileDescriptor

getFileDescriptor(pipe: USBDevicePipe): number

获取文件描述符。

需要调用usb.getDevices获取设备列表；调用usb.requestRight获取设备请求权限；调用usb.connectDevice接口得到devicepipe作为参数。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

usb.requestRight(devicesList[0].name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(devicesList[0]);
let ret: number = usb.getFileDescriptor(devicepipe);

usb.controlTransfer

controlTransfer(pipe: USBDevicePipe, controlparam: USBControlParams, timeout ?: number): Promise<number>

控制传输。

需要调用usb.getDevices获取设备列表；调用usb.requestRight获取设备请求权限；调用usb.connectDevice接口得到devicepipe作为参数。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

class PARA {
  request: number = 0
  reqType: usb.USBControlRequestType = 0
  target: usb.USBRequestTargetType = 0
  value: number = 0
  index: number = 0
  data: Uint8Array = new Uint8Array()
}

let param: PARA = {
  request: 0,
  reqType: 0,
  target:0,
  value: 0,
  index: 0,
  data: new Uint8Array()
};

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

usb.requestRight(devicesList[0].name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(devicesList[0]);
usb.controlTransfer(devicepipe, param).then((ret: number) => {
 console.log(`controlTransfer = ${ret}`);
})

usb.bulkTransfer

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

批量传输。

需要调用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 调用成功以后,再调用该接口。
let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

let device: usb.USBDevice = devicesList[0];
usb.requestRight(device.name);

let devicepipe: usb.USBDevicePipe = usb.connectDevice(device);
let interfaces: usb.USBInterface = device.configs[0].interfaces[0];
let endpoint: usb.USBEndpoint = device.configs[0].interfaces[0].endpoints[0];
let ret: number = usb.claimInterface(devicepipe, interfaces);
let buffer =  new Uint8Array(128);
usb.bulkTransfer(devicepipe, endpoint, buffer).then((ret: number) => {
  console.log(`bulkTransfer = ${ret}`);
});

usb.closePipe

closePipe(pipe: USBDevicePipe): number

关闭设备消息控制通道。

需要调用usb.getDevices获取设备列表；调用usb.requestRight获取设备请求权限；调用usb.connectDevice得到devicepipe作为参数。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesList: Array<usb.USBDevice> = usb.getDevices();
if (devicesList.length == 0) {
  console.log(`device list is empty`);
}

usb.requestRight(devicesList[0].name);
let devicepipe: usb.USBDevicePipe = usb.connectDevice(devicesList[0]);
let ret: number = usb.closePipe(devicepipe);
console.log(`closePipe = ${ret}`);

USBEndpoint

通过USB发送和接收数据的端口。通过USBInterface获取。

系统能力： SystemCapability.USB.USBManager

USBInterface

一个USBConfiguration中可以含有多个USBInterface，每个USBInterface提供一个功能。

系统能力： SystemCapability.USB.USBManager

USBConfiguration

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