1# **DeviceManager部件** 2 3## 简介 4 5DeviceManager组件在OpenHarmony上提供账号无关的分布式设备的认证组网能力，并为开发者提供了一套用于分布式设备间监听、发现和认证的接口。 6 7其组成及依赖如下所示： 8 9 10 11dsoftbus提供能力： 12 提供设备上下线通知及设备信息，设备认证通道和设备发现能力。 13deviceauth提供能力： 14 提供设备群组管理和群组认证能力。 15 16 17## 目录 18 19``` 20foundation/distributedhardware/distributedhardware_device_manager 21├── common # 公共能力头文件存放目录 22│ ├── include 23│ │ ├── dfx # dfx功能头文件存放目录 24│ │ └── ipc # ipc功能头文件存放目录 25│ │ ├── lite # small 26│ │ ├── model # ipc功能模块头文件存放目录 27│ │ └── standard # standard 28│ └── src 29│ ├── dfx # dfx功能实现相关代码 30│ └── ipc # ipc公共功能代码 31│ ├── lite # small 32│ └── standard # standard 33├── display # DM显示hap代码 34│ └── entry 35│ └── src 36│ └── main 37│ ├── js # DM PIN码显示ServiceExtensionAbility相关JS代码 38│ └── resources # DM PIN码显示ServiceExtensionAbility相关资源配置文件目录 39├── figures 40├── interfaces 41│ ├── inner_kits # 内部接口及实现存放目录 42│ │ └── native_cpp # 内部native接口及实现存放目录 43│ │ ├── include 44│ │ │ ├── ipc # ipc头文件存放目录 45│ │ │ │ ├── lite # small 46│ │ │ │ └── standard # standard 47│ │ │ └── notify # ipc回调通知头文件目录 48│ │ └── src 49│ │ ├── ipc # ipc功能代码 50│ │ │ ├── lite # small 51│ │ │ └── standard # standard 52│ │ └── notify # ipc回调通知功能代码 53│ └── kits # 外部接口及实现存放目录 54│ ├── js # 外部JS接口及实现存放目录 55│ │ ├── include # 外部JS接口及实现头文件存放目录 56│ │ └── src # 外部JS接口及实现代码 57| └── js4.0 # 从Openharmony 4.0.9.2版本开始新增外部JS接口及实现存放目录 58| ├── include # 新增外部JS接口及实现头文件存放目录 59| └── src # 新增外部JS接口及实现代码 60| 61├── sa_profile # SA进程配置相关文件存放目录 62├── services 63│ ├── implementation # devicemanagerservice服务实现核心代码 64│ │ ├── include 65│ │ │ ├── ability # 与PIN码显示ServiceExtensionAbility拉起管理相关头文件 66│ │ │ ├── adapter # DM适配扩展功能相关头文件 67│ │ │ ├── authentication # device_auth交互相关头文件 68│ │ │ ├── config # DM适配扩展相关配置功能头文件 69│ │ │ ├── credential # 凭据管理功能相关头文件 70│ │ │ ├── dependency # 外部依赖模块相关头文件 71│ │ │ │ ├── commonevent # 事件处理功能相关头文件 72│ │ │ │ ├── hichain # 与hichain功能交互相关头文件 73│ │ │ │ ├── mini # mini 74│ │ │ │ ├── multipleuser # 多用户功能相关头文件 75│ │ │ │ ├── softbus # 与软总线功能交互相关头文件 76│ │ │ │ └── timer # 定时器处理相关头文件 77│ │ │ ├── devicestate # 设备状态管理功能相关头文件 78│ │ │ ├── discovery # 设备发现功能相关头文件 79│ │ │ ├── dispath # L0上功能实现相关头文件 80│ │ │ └── publish # 设备主动发现功能相关头文件 81│ │ └── src 82│ │ ├── ability # 与PIN码显示ServiceExtensionAbility拉起管理相关功能代码 83│ │ ├── adapter # DM适配扩展功能代码 84│ │ ├── authentication # device_auth交互相关核心代码 85│ │ ├── config # DM适配扩展相关配置功能代码 86│ │ ├── credential # 凭据管理功能代码 87│ │ ├── dependency # 外部依赖模块功能代码 88│ │ │ ├── commonevent # 事件处理功能代码 89│ │ │ ├── hichain # 与hichain功能交互代码 90│ │ │ ├── mini # mini 91│ │ │ ├── multipleuser # 多用户功能代码 92│ │ │ ├── softbus # 与软总线功能交互代码 93│ │ │ └── timer # 定时器处理相关功能代码 94│ │ ├── devicestate # 设备状态管理功能代码 95│ │ ├── discovery # 设备发现功能代码 96│ │ ├── dispath # mini上功能实现代码 97│ │ └── publish # 设备主动发现功能 98│ └── service # devicemanagerservice服务实现核心代码 99│ ├── include 100│ │ ├── ipc # 进程间通信相关头文件 101│ │ │ ├── lite # small 102│ │ │ └── standard # standard 103│ │ └── softbus # 软总线相关头文件 104│ └── src 105│ ├── ipc # 进程间通信相关功能代码 106│ │ ├── lite # small 107│ │ └── standard # standard 108│ └── softbus # 通道建立功能核心代码 109└── utils # 公共能力头文件存放目录 110 ├── include 111 │ ├── fwkload # 拉起其他sa功能相关头文件 112 │ └── permission # 权限校验相关头文件存放目录 113 └── src 114 ├── fwkload # 拉起其他sa功能相关功能代码 115 └── permission # 权限校验相关功能代码 116``` 117 118## 约束 119 120- 开发语言：JS、C++ 121- 适用于Hi3516DV300单板等OpenHarmony设备 122 123 124## 废弃接口说明 125 126该部分接口暂时可继续使用，但是暂停维护，建议使用新接口进行开发。 127 128当前版本设备管理服务不具备权限管理的能力，接口中的system api仅供系统调用，后续版本会进行严格的权限管控。 129接口参见[**interface_sdk-js仓库的**](https://gitee.com/openharmony/interface_sdk-js/) *ohos.distributedHardware.deviceManager.d.ts* 130 131- 公共接口： 132 133 使用DeviceManager相关接口之前，需要通过createDeviceManager接口创建DeviceManager实例； 134 135 不使用DeviceManager接口的时候需要释放对应的DeviceManager实例。 136 137| 原型 | 描述 | 138| ------------------------------------------------------------ | ------------------------------- | 139| createDeviceManager(bundleName: string, callback: AsyncCallback<DeviceManager>): void; | 以异步方法获取DeviceManager实例 | 140| release(): void; | 释放DeviceManager实例 | 141 142- 系统能力接口： 143 144 提供可信设备列表获取、可信设备状态监听、周边设备发现、设备认证等相关接口，该部分作为系统能力接口，仅供系统应用调用。 145 146 开始设备发现、停止发现设备接口要配对使用，使用同一个subscribeId。 147 148| 原型 | 描述 | 149| ------------------------------------------------------------ | -------------------- | 150| getTrustedDeviceListSync(): Array<DeviceInfo>; | 获取信任设备列表 | 151| getTrustedDeviceList(callback:AsyncCallback<Array<DeviceInfo>>): void; | 获取信任设备列表 | 152| getTrustedDeviceList(): Promise<Array<DeviceInfo>>; | 获取信任设备列表 | 153| getLocalDeviceInfoSync(): DeviceInfo; | 获取本地设备信息 | 154| getLocalDeviceInfo(callback:AsyncCallback<DeviceInfo>): void; | 获取本地设备信息 | 155| getLocalDeviceInfo(): Promise<DeviceInfo>; | 获取本地设备信息 | 156| on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void; | 设备状态变更回调 | 157| off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChangeAction, device: DeviceInfo }>): void; | 取消设备状态变更回调 | 158| on(type: 'serviceDie', callback: () => void): void; | 服务错误回调 | 159| off(type: 'serviceDie', callback?: () => void): void; | 取消服务错误回调 | 160| startDeviceDiscovery(subscribeInfo: SubscribeInfo): void; | 开始设备发现 | 161| stopDeviceDiscovery(subscribeId: number): void; | 停止发现设备 | 162| authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: AsyncCallback<{deviceId: string, pinToken ?: number}>): void; | 设备认证接口 | 163| unAuthenticateDevice(deviceInfo: DeviceInfo): void; | 解除认证设备 | 164| setUserOperation(operateAction: number, params: string): void; | 设置用户ui操作行为 | 165| verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, level: number}>): void; | 设备认证信息校验 | 166| startDeviceDiscovery(subscribeInfo: SubscribeInfo, filterOptions?: string): void; | 发现周边设备 | 167| publishDeviceDiscovery(publishInfo: PublishInfo): void; | 发布设备发现 | 168| unPublishDeviceDiscovery(publishId: number): void; | 停止发布设备发现 | 169| on(type: 'deviceFound', callback: Callback<{ subscribeId: number, device: DeviceInfo }>): void; | 发现设备列表回调 | 170| off(type: 'deviceFound', callback?: Callback<{ subscribeId: number, device: DeviceInfo }>): void; | 取消发现设备列表回调 | 171| on(type: 'discoverFail', callback: Callback<{ subscribeId: number, reason: number }>): void; | 发现设备失败回调 | 172| off(type: 'discoverFail', callback?: Callback<{ subscribeId: number, reason: number }>): void; | 取消发现设备失败回调 | 173| on(type: 'publishSuccess', callback: Callback<{ publishId: number }>): void; | 发布设备成功回调 | 174| off(type: 'publishSuccess', callback?: Callback<{ publishId: number }>): void; | 取消发布设备成功回调 | 175| on(type: 'publishFail', callback: Callback<{ publishId: number, reason: number }>): void; | 发布设备失败回调 | 176| off(type: 'publishFail', callback?: Callback<{ publishId: number, reason: number }>): void; | 取消发布设备失败回调 | 177| on(type: 'uiStateChange', callback: Callback<{ param: string}>): void; | ui状态变更回调 | 178| off(type: 'uiStateChange', callback?: Callback<{ param: string}>): void; | 取消ui状态变更回调 | 179 180## 新增接口说明 181 182 从Openharmony 4.0.9.2版本开始，新增设备管理接口。 183 184接口参见[**interface_sdk-js仓库的**](https://gitee.com/openharmony/interface_sdk-js/) *ohos.distributedDeviceManager.d.ts* 185 186- 公共接口： 187 188 调用以下接口，需要申请ohos.permission.DISTRIBUTED_DATASYNC权限才能正常调用。 189 190 使用DeviceManager相关接口之前，需要通过createDeviceManager接口创建DeviceManager实例； 191 192 不使用DeviceManager接口的时候需要释放对应的DeviceManager实例。 193 194 提供可信设备列表获取、可信设备状态监听、周边设备发现、设备认证等相关接口，支持三方应用调用。 195 196| 原型 | 描述 | 197| ------------------------------------------------------------ | ------------------------------- | 198| createDeviceManager(bundleName: string): DeviceManager; | 创建一个设备管理实例。设备管理实例是分布式设备管理方法的调用入口。用于获取可信设备和本地设备的相关信息。 | 199| releaseDeviceManager(deviceManager: DeviceManager): void; | 设备管理实例不再使用后，通过该方法释放DeviceManager实例。 | 200| getAvailableDeviceListSync(): Array<DeviceBasicInfo>; | 同步获取所有可信设备列表。 | 201| getAvailableDeviceList(callback:AsyncCallback<Array<DeviceBasicInfo>>): void; | 获取所有可信设备列表。使用callback异步回调。 | 202| getAvailableDeviceList(): Promise<Array<DeviceBasicInfo>>; | 获取所有可信设备列表。使用Promise异步回调。 | 203| getLocalDeviceNetworkId(): string; | 获取本地设备网络标识。 | 204| getLocalDeviceName(): string; | 获取本地设备名称。 | 205| getLocalDeviceType(): number; | 获取本地设备类型。 | 206| getLocalDeviceId(): string; | 获取本地设备id。 | 207| getDeviceName(networkId: string): string; | 通过指定设备的网络标识获取该设备名称。 | 208| getDeviceType(networkId: string): number; | 通过指定设备的网络标识获取该设备类型。 | 209| startDiscovering(discoverParam: {[key: string]: Object} , filterOptions?: {[key: string]: Object} ): void; | 发现周边设备。发现状态持续两分钟，超过两分钟，会停止发现，最大发现数量99个。 | 210| stopDiscovering(): void; | 停止发现周边设备。 | 211| bindTarget(deviceId: string, bindParam: {[key: string]: Object} , callback: AsyncCallback<{deviceId: string}>): void; | 认证设备。 | 212| unbindTarget(deviceId: string): void; | 解除认证设备。 | 213| on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChange, device: DeviceBasicInfo }>): void; | 注册设备状态回调。 | 214| off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChange, device: DeviceBasicInfo }>): void; | 取消注册设备状态回调。 | 215| on(type: 'discoverSuccess', callback: Callback<{ device: DeviceBasicInfo }>): void; | 注册发现设备成功回调监听。 | 216| off(type: 'discoverSuccess', callback?: Callback<{ device: DeviceBasicInfo }>): void; | 取消注册设备发现成功回调。 | 217| on(type: 'deviceNameChange', callback: Callback<{ deviceName: string }>): void; | 注册设备名称变更回调监听。 | 218| off(type: 'deviceNameChange', callback?: Callback<{ deviceName: string }>): void; | 取消注册设备名称变更回调监听。 | 219| on(type: 'discoverFailure', callback: Callback<{ reason: number }>): void; | 注册设备发现失败回调监听。 | 220| off(type: 'discoverFailure', callback?: Callback<{ reason: number }>): void; | 取消注册设备发现失败回调。 | 221| on(type: 'serviceDie', callback?: Callback<{}>): void; | 注册设备管理服务死亡监听。 | 222| off(type: 'serviceDie', callback?: Callback<{}>): void; | 取消注册设备管理服务死亡监听。 | 223 224- 示例如下： 225 226```js 227try { 228 let dmClass = deviceManager.createDeviceManager("ohos.samples.jshelloworld"); 229} catch(err) { 230 console.error("createDeviceManager errCode:" + err.code + ",errMessage:" + err.message); 231} 232 233try { 234 // 注册设备管理服务死亡监听。 235 dmClass.on("serviceDie", () => { 236 console.info("serviceDie on"); 237 }); 238} catch (err) { 239 console.error("serviceDie errCode:" + err.code + ",errMessage:" + err.message); 240} 241 242try { 243 dmClass.on('deviceStateChange', (data) => { 244 console.info("deviceStateChange on:" + JSON.stringify(data)); 245 }); 246} catch (err) { 247 console.error("deviceStateChange errCode:" + err.code + ",errMessage:" + err.message); 248} 249 250// 同步获取所有可信设备列表。 251try { 252 let trustList = dmClass.getAvailableDeviceListSync(); 253 console.log("trustList:" + JSON.stringify(this.trustList)); 254} catch(err) { 255 console.log("getAvailableDeviceList failed: " + JSON.stringify(err)); 256} 257// 获取本地设备类型。 258var data = dmClass.getLocalDeviceType(); 259 260// 获取本地设备名称。 261var data = dmClass.getLocalDeviceName(); 262 263// 发现周边设备。 264try { 265 // 注册发现设备成功回调监听。 266 dmClass.on('discoverSuccess', (data) => { 267 if (data == null) { 268 console.log("discoverSuccess error data = null") 269 return; 270 } 271 console.info(TAG + "discoverSuccess:" + JSON.stringify(data)); 272 }); 273 // 注册设备发现失败回调监听。 274 dmClass.on('discoverFailure', (data) => { 275 console.info("discoverFailure on:" + JSON.stringify(data)); 276 }); 277 var discoverParam = { 278 'discoverTargetType': 1 279 }; 280 var filterOptions = { 281 'availableStatus': 1, 282 'discoverDistance': 50, 283 'authenticationStatus': 0, 284 'authorizationType': 0 285 }; 286 dmClass.startDiscovering(discoverParam, filterOptions); // 当有设备发现时，通过discoverSuccess回调通知给应用程序 287} catch (err) { 288 console.log("startDiscovering err:" + err.code + "," + err.message); 289} 290 291// 停止发现周边设备。 292try { 293 dmClass.stopDiscovering(); 294 // 取消注册设备发现成功回调。 295 dmClass.off('discoverSuccess'); 296 // 取消注册设备发现失败回调。 297 dmClass.off('discoverFailure'); 298} catch (err) { 299 console.log("err:" + err.code + "," + err.message); 300} 301 302// 设备认证 303var deviceId ="XXXXXXXX"; 304let bindParam = { 305 'bindType': 1,// 认证类型： 1 - 无帐号PIN码认证 306 'targetPkgName': 'xxxx', 307 'appName': 'xxxx', 308 'appOperation': 'xxxx', 309 'customDescription': 'xxxx' 310} 311try { 312 // 设备认证 313 dmClass.bindTarget(deviceId, bindParam, (err, data) => { 314 if (err) { 315 console.info(TAG + "bindTarget err:" + JSON.stringify(err)); 316 return; 317 } else { 318 console.info(TAG + "bindTarget result:" + JSON.stringify(data)); 319 let token = data.pinTone; 320 } 321 }); 322} catch (err) { 323 console.log("bindTarget err:" + err.code + "," + err.message); 324} 325// 设备取消认证 326try { 327 var deviceId = "xxxxxxxx"; 328 let result = dmClass.unbindTarget(deviceId); 329 console.log("unbindTarget last device: " + JSON.stringify(deviceId) + " and result = " 330 + result); 331 } catch (err) { 332 console.log("unbindTarget err:" + err.code + "," + err.message); 333} 334 335try { 336 // 取消注册设备管理服务死亡监听。 337 dmClass.off('serviceDie'); 338 // 取消注册设备状态回调。 339 dmClass.off('deviceStateChange', (data) => { 340 console.info('deviceStateChange' + JSON.stringify(data)); 341 }); 342 // 释放DeviceManager实例。 343 deviceManager.releaseDeviceManager(dmClass); 344} catch (err) { 345 console.log("err:" + err.code + "," + err.message); 346} 347``` 348 349- 系统接口： 350 351 该部分接口仅支持系统应用调用。 352 调用以下接口，需要申请ohos.permission.ACCESSS_SERVICE_DM权限才能正常调用。 353 354| 原型 | 描述 | 355| ------------------------------------------------------------ | -------------------- | 356| replyUiAction(action: number, actionResult: string): void; | 回复用户ui操作行为。此接口只能被devicemanager的PIN码hap使用。 | 357| on(type: 'replyResult', callback: Callback<{ param: string}>): void; | 回复UI操作结果回调。 | 358| off(type: 'replyResult', callback?: Callback<{ param: string}>): void; | 取消回复UI操作结果回调。 | 359 360- 示例如下： 361 362```js 363// 设置用户ui操作行为 364/* action = 0 - 允许授权 365 action = 1 - 取消授权 366 action = 2 - 授权框用户操作超时 367 action = 3 - 取消pin码框展示 368 action = 4 - 取消pin码输入框展示 369 action = 5 - pin码输入框确定操作 370*/ 371try { 372 let action = 0; 373 dmClass.replyUiAction(action, "extra") 374 dmClass.on('replyResult', (data) => { 375 console.log("replyResult executed, dialog closed" + JSON.stringify(data)) 376 var tmpStr = JSON.parse(data.param) 377 var isShow = tmpStr.verifyFailed 378 console.log("replyResult executed, dialog closed" + isShow) 379 }); 380} catch (err) { 381 console.log("err:" + err.code + "," + err.message); 382} 383 384``` 385 386详细接口说明请参考[**API文档**](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-distributedDeviceManager.md) 387 388## 系统弹框ServiceExtensionAbility 389 390当前版本只支持PIN码认证，需要提供PIN码认证的授权提示界面、PIN码显示界面、PIN码输入界面； 391 392当前，由于系统通过native层直接进行弹窗的能力尚不具备，这里使用ServiceExtensionAbility来进行对应界面的弹窗。 393 394该ServiceExtensionAbility为：DeviceManager_UI.hap，作为系统应用进行预置。 395 396- 编译运行： 397 398 将devicemanager/display工程导入DevEco Studio 2.2 Beta1，复制display目录下的@ohos.distributedHardware.deviceManager.d.ts文件到Sdk\js\2.2.0.1\api\common目录下，进行编译构建及运行调试. 399 400- 编译环境依赖：IDE 2.2 SDK6 401 402- DeviceManager_UI.hap包源码存放位置：[device_manager仓库](https://gitee.com/openharmony/distributedhardware_device_manager/tree/master/display) 403 404- UI显示： 405 406 DeviceManager作为认证被控端，授权提示界面、PIN码显示界面由DeviceManager_UI ServiceExtensionAbility默认进行显示； 407 408 DeviceManager作为认证发起端，PIN码输入界面可以选择由DeviceManager_UI ServiceExtensionAbility进行显示，还是由开发者自行显示。开发者如需自己定制PIN码输入界面，需要在authenticateDevice接口的认证参数AuthParam中，extraInfo属性里面指定displayOwner参数为1。 409 410## 相关仓 411**** 412 413[**interface_sdk-js**](https://gitee.com/openharmony/interface_sdk-js/) 414 415[**applications_hap**](https://gitee.com/openharmony/applications_hap) 416
