1# IBatteryInterface 2 3 4## **概述** 5 6获取、订阅电池信息的接口。 7 8服务获取此对象后，可以调用相关的接口获取、订阅电池信息。 9 10**Since:** 11 123.1 13 14**相关模块:** 15 16[Battery](battery.md) 17 18 19## **汇总** 20 21 22### Public 成员函数 23 24 | 名称 | 描述 | 25| -------- | -------- | 26| [Register](#register) ([in] [IBatteryCallback](interface_i_battery_callback.md) event) | 注册电池信息的回调。 | 27| [UnRegister](#unregister) () | 取消注册电池信息的回调。 | 28| [ChangePath](#changepath) ([in] String path) | 设置电池信息节点的路径。 | 29| [GetCapacity](#getcapacity) ([out] int capacity) | 获取电池的电量百分比。 | 30| [GetVoltage](#getvoltage) ([out] int voltage) | 获取电池的电压，单位微伏。 | 31| [GetTemperature](#gettemperature) ([out] int temperature) | 获取电池的充电温度，单位0.1摄氏度。 | 32| [GetHealthState](#gethealthstate) ([out] enum [BatteryHealthState](battery.md#batteryhealthstate) healthState) | 获取电池的健康状态。 | 33| [GetPluggedType](#getpluggedtype) ([out] enum [BatteryPluggedType](battery.md#batterypluggedtype) pluggedType) | 获取充电设备类型。 | 34| [GetChargeState](#getchargestate) ([out] enum [BatteryChargeState](battery.md#batterychargestate) chargeState) | 获取充电状态。 | 35| [GetPresent](#getpresent) ([out] boolean present) | 获取是否支持电池或者电池是否在位。 | 36| [GetTechnology](#gettechnology) ([out] String technology) | 获取电池的技术型号。 | 37| [GetTotalEnergy](#gettotalenergy) ([out] int totalEnergy) | 获取电池的总容量。 | 38| [GetCurrentAverage](#getcurrentaverage) ([out] int curAverage) | 获取电池的平均电流。 | 39| [GetCurrentNow](#getcurrentnow) ([out] int curNow) | 获取电池的电流。 | 40| [GetRemainEnergy](#getremainenergy) ([out] int remainEnergy) | 获取电池的剩余容量。 | 41| [GetBatteryInfo](#getbatteryinfo) ([out] struct [BatteryInfo](_battery_info.md) info) | 获取电池的全部信息。 | 42 43 44## **成员函数说明** 45 46 47### ChangePath() 48 49 50``` 51IBatteryInterface::ChangePath ([in] String path) 52``` 53 54**描述：** 55 56设置电池信息节点的路径。 57 58**参数:** 59 60 | 名称 | 描述 | 61| -------- | -------- | 62| path | 输入参数，电池信息节点的路径。 | 63 64**返回:** 65 66HDF_SUCCESS 表示路径设置成功。 67 68 69### GetBatteryInfo() 70 71 72``` 73IBatteryInterface::GetBatteryInfo ([out] struct BatteryInfo info) 74``` 75 76**描述：** 77 78获取电池的全部信息。 79 80**参数:** 81 82 | 名称 | 描述 | 83| -------- | -------- | 84| info | 电池的全部信息。 | 85 86**返回:** 87 88HDF_SUCCESS 表示获取成功。 89 90**参见:** 91 92[BatteryInfo](_battery_info.md) 93 94 95### GetCapacity() 96 97 98``` 99IBatteryInterface::GetCapacity ([out] int capacity) 100``` 101 102**描述：** 103 104获取电池的电量百分比。 105 106**参数:** 107 108 | 名称 | 描述 | 109| -------- | -------- | 110| capacity | 表示电量的百分比值。 | 111 112**返回:** 113 114HDF_SUCCESS 表示获取成功。 115 116 117### GetChargeState() 118 119 120``` 121IBatteryInterface::GetChargeState ([out] enum BatteryChargeState chargeState) 122``` 123 124**描述：** 125 126获取充电状态。 127 128**参数:** 129 130 | 名称 | 描述 | 131| -------- | -------- | 132| chargeState | 表示充电状态。 | 133 134**返回:** 135 136HDF_SUCCESS 表示获取成功。 137 138**参见:** 139 140[BatteryChargeState](battery.md#batterychargestate) 141 142 143### GetCurrentAverage() 144 145 146``` 147IBatteryInterface::GetCurrentAverage ([out] int curAverage) 148``` 149 150**描述：** 151 152获取电池的平均电流。 153 154**参数:** 155 156 | 名称 | 描述 | 157| -------- | -------- | 158| totalEnergy | 表示电池的平均电流，单位毫安。 | 159 160**返回:** 161 162HDF_SUCCESS 表示获取成功。 163 164 165### GetCurrentNow() 166 167 168``` 169IBatteryInterface::GetCurrentNow ([out] int curNow) 170``` 171 172**描述：** 173 174获取电池的电流。 175 176**参数:** 177 178 | 名称 | 描述 | 179| -------- | -------- | 180| curNow | 表示电池的实时电流，单位毫安。 | 181 182**返回:** 183 184HDF_SUCCESS 表示获取成功。 185 186 187### GetHealthState() 188 189 190``` 191IBatteryInterface::GetHealthState ([out] enum BatteryHealthState healthState) 192``` 193 194**描述：** 195 196获取电池的健康状态。 197 198**参数:** 199 200 | 名称 | 描述 | 201| -------- | -------- | 202| healthState | 表示电池健康状态。 | 203 204**返回:** 205 206HDF_SUCCESS 表示获取成功。 207 208**参见:** 209 210[BatteryHealthState](battery.md#batteryhealthstate) 211 212 213### GetPluggedType() 214 215 216``` 217IBatteryInterface::GetPluggedType ([out] enum BatteryPluggedType pluggedType) 218``` 219 220**描述：** 221 222获取充电设备类型。 223 224**参数:** 225 226 | 名称 | 描述 | 227| -------- | -------- | 228| pluggedType | 表示充电设备类型。 | 229 230**返回:** 231 232HDF_SUCCESS 表示获取成功。 233 234**参见:** 235 236[BatteryPluggedType](battery.md#batterypluggedtype) 237 238 239### GetPresent() 240 241 242``` 243IBatteryInterface::GetPresent ([out] boolean present) 244``` 245 246**描述：** 247 248获取是否支持电池或者电池是否在位。 249 250**参数:** 251 252 | 名称 | 描述 | 253| -------- | -------- | 254| present | 表示是否支持电池或者电池是否在位。true表示支持或在位，false表示不支持或不在位。 | 255 256**返回:** 257 258HDF_SUCCESS 表示获取成功。 259 260 261### GetRemainEnergy() 262 263 264``` 265IBatteryInterface::GetRemainEnergy ([out] int remainEnergy) 266``` 267 268**描述：** 269 270获取电池的剩余容量。 271 272**参数:** 273 274 | 名称 | 描述 | 275| -------- | -------- | 276| remainEnergy | 表示电池的剩余容量，单位毫安时。 | 277 278**返回:** 279 280HDF_SUCCESS 表示获取成功。 281 282 283### GetTechnology() 284 285 286``` 287IBatteryInterface::GetTechnology ([out] String technology) 288``` 289 290**描述：** 291 292获取电池的技术型号。 293 294**参数:** 295 296 | 名称 | 描述 | 297| -------- | -------- | 298| technology | 当前电池技术型号。 | 299 300**返回:** 301 302HDF_SUCCESS 表示获取成功。 303 304 305### GetTemperature() 306 307 308``` 309IBatteryInterface::GetTemperature ([out] int temperature) 310``` 311 312**描述：** 313 314获取电池的充电温度，单位0.1摄氏度。 315 316**参数:** 317 318 | 名称 | 描述 | 319| -------- | -------- | 320| temperature | 表示电池温度。 | 321 322**返回:** 323 324HDF_SUCCESS 表示获取成功。 325 326 327### GetTotalEnergy() 328 329 330``` 331IBatteryInterface::GetTotalEnergy ([out] int totalEnergy) 332``` 333 334**描述：** 335 336获取电池的总容量。 337 338**参数:** 339 340 | 名称 | 描述 | 341| -------- | -------- | 342| totalEnergy | 表示电池的总容量，单位毫安时。 | 343 344**返回:** 345 346HDF_SUCCESS 表示获取成功。 347 348 349### GetVoltage() 350 351 352``` 353IBatteryInterface::GetVoltage ([out] int voltage) 354``` 355 356**描述：** 357 358获取电池的电压，单位微伏。 359 360**参数:** 361 362 | 名称 | 描述 | 363| -------- | -------- | 364| voltage | 表示电池的电压。 | 365 366**返回:** 367 368HDF_SUCCESS 表示获取成功。 369 370 371### Register() 372 373 374``` 375IBatteryInterface::Register ([in] IBatteryCallback event) 376``` 377 378**描述：** 379 380注册电池信息的回调。 381 382**参数:** 383 384 | 名称 | 描述 | 385| -------- | -------- | 386| event | 服务注册的回调。 | 387 388**返回:** 389 390HDF_SUCCESS 表示注册成功。 391 392 393### UnRegister() 394 395 396``` 397IBatteryInterface::UnRegister () 398``` 399 400**描述：** 401 402取消注册电池信息的回调。 403 404**返回:** 405 406HDF_SUCCESS 表示取消注册成功。 407