@ohos.usbManager (USB管理)(系统接口)

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

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.usbManager (USB管理)。

导入模块

import usb from "@ohos.usbManager";

usb.addRight

addRight(bundleName: string, deviceName: string): boolean

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

usb.requestRight (#usbrequestright)会触发弹框请求用户授权；addRight不会触发弹框，而是直接添加软件包访问设备的权限。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let devicesName: string = "1-1";
let bundleName: string = "com.example.hello";
if (usb.addRight(bundleName, devicesName)) {
  console.log(`Succeed in adding right`);
}

usb.usbFunctionsFromString

usbFunctionsFromString(funcs: string): number

在设备模式下，将字符串形式的USB功能列表转化为数字掩码。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let funcs: string = "acm";
let ret: number = usb.usbFunctionsFromString(funcs);

usb.usbFunctionsToString

usbFunctionsToString(funcs: FunctionType): string

在设备模式下，将数字掩码形式的USB功能列表转化为字符串。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let funcs: number = usb.FunctionType.ACM | usb.FunctionType.ECM;
let ret: string = usb.usbFunctionsToString(funcs);

usb.setCurrentFunctions

setCurrentFunctions(funcs: FunctionType): Promise<void>

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

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

参数：

错误码：

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

返回值：

示例：

import {BusinessError} from '@ohos.base';
let funcs: number = usb.FunctionType.HDC;
usb.setCurrentFunctions(funcs).then(() => {
    console.info('usb setCurrentFunctions successfully.');
}).catch((err: BusinessError) => {
    console.error('usb setCurrentFunctions failed: ' + err.code + ' message: ' + err.message);
});

usb.getCurrentFunctions

getCurrentFunctions(): FunctionType

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

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

返回值：

示例：

let ret: number = usb.getCurrentFunctions();

usb.getPorts

getPorts(): Array<USBPort>

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

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

返回值：

示例：

let ret: Array<usb.USBPort> = usb.getPorts();

usb.getSupportedModes

getSupportedModes(portId: number): PortModeType

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

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

let ret: number = usb.getSupportedModes(0);

usb.setPortRoles

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

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

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

参数：

返回值：

示例：

import {BusinessError} from '@ohos.base';
let portId: number = 1;
usb.setPortRoles(portId, usb.PowerRoleType.SOURCE, usb.DataRoleType.HOST).then(() => {
    console.info('usb setPortRoles successfully.');
}).catch((err: BusinessError) => {
    console.error('usb setPortRoles failed: ' + err.code + ' message: ' + err.message);
});

USBPort

USB设备端口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

USBPortStatus

USB设备端口角色信息。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

FunctionType

USB设备侧功能。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

PortModeType

USB端口模式类型。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

PowerRoleType

电源角色类型。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager

DataRoleType

数据角色类型。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.USB.USBManager