1# 开发带UI界面基础驱动 2<!--Kit: Driver Development Kit--> 3<!--Subsystem: Driver--> 4<!--Owner: @lixinsheng2--> 5<!--Designer: @w00373942--> 6<!--Tester: @dong-dongzhen--> 7<!--Adviser: @w_Machine_cc--> 8 9## 场景介绍 10 11开发者开发带UI界面的基础驱动，适用于各种复合设备，需要通过UI界面设置对应的独特驱动能力或者通过UI界面展示从设备侧获取的信息，例如带有侧键的鼠标，手写板，身份证读卡器等设备。 12 13## 环境搭建 14 15请参考[环境准备](environmental-preparation.md)完成开发前的准备工作。 16 17## 接口说明 18 19扩展外设管理基本能力如下，更多详情请查阅[API参考文档](../../reference/apis-driverdevelopment-kit/js-apis-driver-deviceManager.md)。 20 21**表1** 扩展外设管理基本能力接口 22 23| 接口名 | 描述 | 24| ------------------------------------------------------------ | ------------------------------------------------------------ | 25| queryDevices(busType?: number): Array<Readonly<Device>> | 查询扩展外设列表。 | 26| bindDriverWithDeviceId(deviceId: number, onDisconnect: AsyncCallback<number>): Promise<RemoteDeviceDriver>; | 绑定设备的Promise形式，API18开始支持。 | 27| unbindDriverWithDeviceId(deviceId: number): Promise<number> | 解绑设备的Promise形式，API18开始支持。 | 28 29<!--Del--> 30扩展外设管理系统接口如下，具体请查阅[API参考文档](../../reference/apis-driverdevelopment-kit/js-apis-driver-deviceManager-sys.md)。 31 32**表2** 扩展外设管理系统接口 33 34| 接口名 | 描述 | 35|------------------------------------------------------------------------------|-----------------| 36| queryDeviceInfo(deviceId?: number): Array<Readonly<DeviceInfo>> | 查询扩展外设详细信息列表。 | 37| queryDriverInfo(driverUid?: string): Array<Readonly<DriverInfo>> | 查询扩展外设驱动详细信息列表。 | 38<!--DelEnd--> 39 40## 开发步骤 41 42应用可通过查询绑定扩展外设，从而使用扩展外设的定制驱动能力。 43 44开发示例如下（仅供参考）：为开发者提供的示例代码为同时开发客户端和服务端的Demo，并实现IPC通信。 45 461. 创建新工程，请参考[创建一个新的工程](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-create-new-project)，创建一个OpenHarmony工程。 47 48 **注意：** 49 50 > 开发驱动客户端，请选择Empty Ability模板。 51 > 52 > 开发驱动服务端，请选择Native C++模板。 53 > 54 >同时开发驱动客户端和服务端，请选择Native C++模板。 55 56 572. 在文件中导入相关Kit，并声明想要绑定的USB设备的productId、vendorId以及与驱动通信的Code。 58 59 **说明：** 60 61 > 以下示例代码均写在entry/src/main/ets/pages/Index.ets文件中。 62 63 ```ts 64 import { hilog } from '@kit.PerformanceAnalysisKit'; 65 import { deviceManager } from '@kit.DriverDevelopmentKit'; 66 import { BusinessError } from '@kit.BasicServicesKit'; 67 import { rpc } from '@kit.IPCKit'; 68 69 const REQUEST_CODE: number = 99; // 自定义通信Code，此处仅供参考 70 const productId: number = 4258; // 请声明连接的USB设备的productId 71 const vendorId: number = 4817; // 请声明连接的USB设备的vendorId 72 ``` 73 743. 定义message变量和远程对象变量，后续与驱动通信使用。 75 76 **说明：** 77 78 > 第3步开始，以下接口均在struct Index{}中定义。 79 80 ```ts 81 @State message: string = 'Hello'; 82 private remote: rpc.IRemoteObject | null = null; 83 ``` 84 854. 定义查询设备接口，通过queryDevices获取目标设备ID。 86 87 ```ts 88 private async queryTargetDeviceId(): Promise<number> { 89 try { 90 const devices: Array<deviceManager.Device> = deviceManager.queryDevices(deviceManager.BusType.USB); 91 const index = devices.findIndex((item: deviceManager.Device) => { 92 let usbDevice = item as deviceManager.USBDevice; 93 // 如果不知道设备productId和vendorId，可以通过该日志查看连接的usb设备的相关信息 94 hilog.info(0, 'testTag', `usbDevice.productId = ${usbDevice.productId}, usbDevice.vendorId = ${usbDevice.vendorId}`); 95 return usbDevice.productId === productId && usbDevice.vendorId === vendorId; 96 }); 97 if (index < 0) { 98 hilog.error(0, 'testTag', 'can not find device'); 99 return -1; 100 } 101 return devices[index].deviceId; 102 } catch (error) { 103 hilog.error(0, 'testTag', `queryDevice failed, err: ${JSON.stringify(error)}`); 104 } 105 return -1; 106 } 107 ``` 108 1095. 定义获取对应驱动远程对象的接口，通过bindDriverWithDeviceId获取远程对象。 110 111 ```ts 112 private async getDriverRemote(deviceId: number): Promise<rpc.IRemoteObject | null> { 113 try { 114 let remoteDeviceDriver: deviceManager.RemoteDeviceDriver = await deviceManager.bindDriverWithDeviceId(deviceId, 115 (err: BusinessError, id: number) => { 116 hilog.info(0, 'testTag', `device[${id}] id disconnect, err: ${JSON.stringify(err)}`); 117 }); 118 return remoteDeviceDriver.remote; 119 } catch (error) { 120 hilog.error(0, 'testTag', `bindDriverWithDeviceId failed, err: ${JSON.stringify(error)}`); 121 } 122 return null; 123 } 124 ``` 125 1266. 定义与远程对象通信接口，通过sendMessageRequest与远程对象进行IPC通信。 127 128 ```ts 129 private async communicateWithRemote(): Promise<void> { 130 const deviceId: number = await this.queryTargetDeviceId(); 131 if (deviceId < 0) { 132 hilog.error(0, 'testTag', 'can not find target device'); 133 return; 134 } 135 this.remote = await this.getDriverRemote(deviceId); 136 if (this.remote === null) { 137 hilog.error(0, 'testTag', `getDriverRemote failed`); 138 return; 139 } 140 141 let option = new rpc.MessageOption(); 142 let data = new rpc.MessageSequence(); 143 let reply = new rpc.MessageSequence(); 144 145 // 向驱动发送信息"Hello" 146 data.writeString(this.message); 147 148 try { 149 await this.remote.sendMessageRequest(REQUEST_CODE, data, reply, option); 150 // 获取驱动返回信息"Hello world" 151 this.message = reply.readString(); 152 hilog.info(0, 'testTag', `sendMessageRequest, message: ${this.message}`); 153 } catch (error) { 154 hilog.error(0, 'testTag', `sendMessageRequest failed, err: ${JSON.stringify(error)}`); 155 } 156 } 157 ``` 158 1597. 渲染UI界面，更多UI界面开发请参考[UI开发](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/arkts-ui-development)。 160 161 ```ts 162 build() { 163 Row() { 164 Column() { 165 Text(this.message) // 显示"Hello" 166 .fontSize(60) 167 .fontWeight(FontWeight.Bold) 168 .onClick(() => { // 点击"Hello"，与远程对象通信，显示"Hello World" 169 this.communicateWithRemote(); 170 }) 171 } 172 .width('100%') 173 } 174 .height('100%') 175 } 176 ``` 177 1788. 接下来请参考[开发无UI界面基础驱动](driverextensionability.md)，进行对应驱动的示例代码开发。 179 180<!--Del--> 181系统应用可通过查询外设详细信息和驱动详细信息，从而管理外设和驱动。开发示例如下： 182 1831. 导入相关Kit。 184 185 ```ts 186 import { deviceManager } from '@kit.DriverDevelopmentKit'; 187 import { BusinessError } from '@kit.BasicServicesKit'; 188 ``` 189 1902. 查询扩展外设详细信息列表。 191 192 ```ts 193 try { 194 // 12345678为示例deviceId，应用开发时可通过queryDevices查询到相应设备的deviceId作为入参 195 let deviceInfos : Array<deviceManager.DeviceInfo> = deviceManager.queryDeviceInfo(12345678); 196 for (let item of deviceInfos) { 197 console.info(`Device id is ${item.deviceId}`) 198 } 199 } catch (error) { 200 let err: BusinessError = error as BusinessError; 201 console.error(`Failed to query device info. Code is ${err.code}, message is ${err.message}`); 202 } 203 ``` 204 2053. 查询扩展外设驱动详细信息列表。 206 207 ```ts 208 try { 209 // driver-12345为示例driverUid，应用开发时可通过queryDeviceInfo查询到相应设备匹配到的驱动的driverUid作为入参 210 let driverInfos : Array<deviceManager.DriverInfo> = deviceManager.queryDriverInfo("driver-12345"); 211 for (let item of driverInfos) { 212 console.info(`driver name is ${item.driverName}`) 213 } 214 } catch (error) { 215 let err: BusinessError = error as BusinessError; 216 console.error(`Failed to query driver info. Code is ${err.code}, message is ${err.message}`); 217 } 218 ``` 219<!--DelEnd--> 220<!--RP1--> 221## 应用签名 222 223**注意：** 先配置权限，再自动签名。 224 225应用需要配置签名文件才能在设备上运行，并且扩展外设管理客户端开发，需要配置扩展外设的权限：ohos.permission.ACCESS_EXTENSIONAL_DEVICE_DRIVER及ohos.permission.ACCESS_DDK_DRIVERS。 226- ohos.permission.ACCESS_EXTENSIONAL_DEVICE_DRIVER（API version 10及以上版本，需要申请此权限。） 227 228 在module.json5配置文件的requestPermissions标签中[声明权限](../../security/AccessToken/declare-permissions.md)后，即可获得授权。 229 230- ohos.permission.ACCESS_DDK_DRIVERS（API version 18及以上版本，需要申请此权限。） 231 232 1. 在module.json5配置文件的requestPermissions标签中[声明权限](../../security/AccessToken/declare-permissions.md)。 233 2. HarmonyAppProvision配置文件中，修改acls字段，跨级别申请权限，可参考[申请使用受限权限](../../security/AccessToken/declare-permissions-in-acl.md)。 234 3. 在HarmonyAppProvision配置文件（即SDK目录下的“Sdk/openharmony/_{Version} _/toolchains /lib/UnsgnedReleasedProfileTemplate.json”文件）中，配置当前客户需要连接的驱动服务端的bundleName，如果存在多个服务端，多个服务端的bundleName以逗号分隔。 235 236 具体配置方法如下： 237 238 在文件的根节点加上app-services-capabilities节点，并采用以下格式进行配置。 239 ```json 240 "app-services-capabilities": { 241 "ohos.permission.ACCESS_DDK_DRIVERS": {"bundleNames": "bundleName0,bundleName1,bundleName2"} 242 } 243 ``` 244 245自动签名方法： 请参考[自动签名](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-signing#section18815157237)。 246<!--RP1End-->