diff --git a/README_zh.md b/README_zh.md index 5df737b4756f30bd49aa4a48ab5f54f00d7bb749..7e167b2a8faa5f81a82bcc10cf4cab67462bcb8d 100644 --- a/README_zh.md +++ b/README_zh.md @@ -85,45 +85,43 @@ foundation/distributedhardware/devicemanager - 开发语言：JS、C++ - 适用于Hi3516DV300单板等OpenHarmony设备 - ## 接口说明 当前版本设备管理服务不具备权限管理的能力，接口中的system api仅供系统调用，后续版本会进行严格的权限管控。 接口参见[**interface_sdk-js仓库的**](https://gitee.com/openharmony/interface_sdk-js/) *ohos.distributedHardware.deviceManager.d.ts* - 公共接口： - + 使用DeviceManager相关接口之前，需要通过createDeviceManager接口创建DeviceManager实例； - + 不使用DeviceManager接口的时候需要释放对应的DeviceManager实例。 -| 原型 | 描述 | -| ------------------------------------------------------------ | ------------------------------- | +| 原型 | 描述 | +| -------------------------------------------------------------------------------------- | ---------------------- | | createDeviceManager(bundleName: string, callback: AsyncCallback): void; | 以异步方法获取DeviceManager实例 | -| release(): void; | 释放DeviceManager实例 | - +| release(): void; | 释放DeviceManager实例 | - 系统能力接口： - + 提供可信设备列表获取、可信设备状态监听、周边设备发现、设备认证等相关接口，该部分作为系统能力接口，仅供系统应用调用。 - + 开始设备发现、停止发现设备接口要配对使用，使用同一个subscribeId。 -| 原型 | 描述 | -| ------------------------------------------------------------ | -------------------- | -| getTrustedDeviceListSync(): Array; | 获取信任设备列表 | -| on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void; | 设备状态变更回调 | -| off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void; | 取消设备状态变更回调 | -| on(type: 'serviceDie', callback: () => void): void; | 服务错误回调 | -| off(type: 'serviceDie', callback?: () => void): void; | 取消服务错误回调 | -| startDeviceDiscovery(subscribeInfo: SubscribeInfo): void; | 开始设备发现 | -| stopDeviceDiscovery(subscribeId: number): void; | 停止发现设备 | -| authenticateDevice(deviceInfo: DeviceInfo, authparam: AuthParam, callback: AsyncCallback<{deviceId: string, pinTone ?: number}>): void; | 设备认证接口 | -| verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void; | 设备认证信息校验 | -| on(type: 'deviceFound', callback: Callback<{ subscribeId: number, device: DeviceInfo }>): void; | 发现设备列表回调 | -| off(type: 'deviceFound', callback?: Callback<{ subscribeId: number, device: DeviceInfo }>): void; | 取消发现设备列表回调 | -| on(type: 'discoverFail', callback: Callback<{ subscribeId: number, reason: number }>): void; | 发现设备失败回调 | -| off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: number }>): void; | 取消发现设备失败回调 | +| 原型 | 描述 | +| --------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| getTrustedDeviceListSync(): Array; | 获取信任设备列表 | +| on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void; | 设备状态变更回调 | +| off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void; | 取消设备状态变更回调 | +| on(type: 'serviceDie', callback: () => void): void; | 服务错误回调 | +| off(type: 'serviceDie', callback?: () => void): void; | 取消服务错误回调 | +| startDeviceDiscovery(subscribeInfo: SubscribeInfo): void; | 开始设备发现 | +| stopDeviceDiscovery(subscribeId: number): void; | 停止发现设备 | +| authenticateDevice(deviceInfo: DeviceInfo, authparam: AuthParam, callback: AsyncCallback<{deviceId: string, pinTone ?: number}>): void; | 设备认证接口 | +| verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void; | 设备认证信息校验 | +| on(type: 'deviceFound', callback: Callback<{ subscribeId: number, device: DeviceInfo }>): void; | 发现设备列表回调 | +| off(type: 'deviceFound', callback?: Callback<{ subscribeId: number, device: DeviceInfo }>): void; | 取消发现设备列表回调 | +| on(type: 'discoverFail', callback: Callback<{ subscribeId: number, reason: number }>): void; | 发现设备失败回调 | +| off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: number }>): void; | 取消发现设备失败回调 | ## 示例如下： @@ -205,6 +203,7 @@ dmClass.authenticateDevice(this.deviceInfo, authParam, (err, data) => { // 设备取消认证 dmClass.unAuthenticateDevice(this.deviceInfo); ``` + ## 系统弹框FA 当前版本只支持PIN码认证，需要提供PIN码认证的授权提示界面、PIN码显示界面、PIN码输入界面； @@ -214,9 +213,9 @@ dmClass.unAuthenticateDevice(this.deviceInfo); 该FA为：DeviceManager_UI.hap，作为系统应用进行预置。 - 编译运行： - + 将devicemanager/display工程导入DevEco Studio 2.2 Beta1，复制display目录下的@ohos.distributedHardware.deviceManager.d.ts文件到Sdk\js\2.2.0.1\api\common目录下，进行编译构建及运行调试. - + DevEco Studio使用方法请参考[DevEco Studio使用说明](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。 - 编译环境依赖：IDE 2.2 SDK6 @@ -224,12 +223,13 @@ dmClass.unAuthenticateDevice(this.deviceInfo); - DeviceManager_UI.hap存放位置：[applications_hap仓库](https://gitee.com/openharmony/applications_hap) - UI显示： - - DeviceManager作为认证被控端，授权提示界面、PIN码显示界面由DeviceManager_UI FA默认进行显示； - + + DeviceManager作为认证被控端，授权提示界面、PIN码显示界面由DeviceManager_UI FA默认进行显示； + DeviceManager作为认证发起端，PIN码输入界面可以选择由DeviceManager_UI FA进行显示，还是由开发者自行显示。开发者如需自己定制PIN码输入界面，需要在authenticateDevice接口的认证参数AuthParam中，extraInfo属性里面指定displayOwner参数为1（DISPLAY_OWNER_OTHER）。 ### 相关仓 + **** [**interface_sdk-js**](https://gitee.com/openharmony/interface_sdk-js/)