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