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