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