• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.batteryInfo (电量信息)
2
3该模块主要提供电池状态和充放电状态的查询接口。
4
5> **说明:**
6>
7> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9
10## 导入模块
11
12```js
13import batteryInfo from '@ohos.batteryInfo';
14```
15
16## 属性
17
18描述电池信息。
19
20**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
21
22| 名称      | 类型        | 可读 | 可写 |  说明     |
23| --------------- | ------------------- | ---- | ---- | ---------------------|
24| batterySOC                                | number                                         | 是   | 否   | 表示当前设备剩余电池电量百分比。                           |
25| chargingStatus                            | [BatteryChargeState](#batterychargestate)      | 是   | 否   | 表示当前设备电池的充电状态。                               |
26| healthStatus                              | [BatteryHealthState](#batteryhealthstate)      | 是   | 否   | 表示当前设备电池的健康状态。                               |
27| pluggedType                               | [BatteryPluggedType](#batterypluggedtype)      | 是   | 否   | 表示当前设备连接的充电器类型。                             |
28| voltage                                   | number                                         | 是   | 否   | 表示当前设备电池的电压,单位微伏。                         |
29| technology                                | string                                         | 是   | 否   | 表示当前设备电池的技术型号。                               |
30| batteryTemperature                        | number                                         | 是   | 否   | 表示当前设备电池的温度,单位0.1摄氏度。                    |
31| isBatteryPresent<sup>7+</sup>             | boolean                                        | 是   | 否   | 表示当前设备是否支持电池或者电池是否在位。                 |
32| batteryCapacityLevel<sup>9+</sup>         | [BatteryCapacityLevel](#batterycapacitylevel9) | 是   | 否   | 表示当前设备电池电量的等级。                               |
33
34## BatteryPluggedType
35
36表示连接的充电器类型的枚举。
37
38**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
39
40| 名称       | 值  | 说明              |
41| -------- | ---- | ----------------- |
42| NONE     | 0    | 表示未获取到连接充电器类型。      |
43| AC       | 1    | 表示连接的充电器类型为交流充电器。 |
44| USB      | 2    | 表示连接的充电器类型为USB。   |
45| WIRELESS | 3    | 表示连接的充电器类型为无线充电器。 |
46
47## BatteryChargeState
48
49表示电池充电状态的枚举。
50
51**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
52
53| 名称      | 值  | 说明            |
54| ------- | ---- | --------------- |
55| NONE    | 0    | 表示电池充电状态未知。     |
56| ENABLE  | 1    | 表示电池充电状态为使能状态。  |
57| DISABLE | 2    | 表示电池充电状态为停止状态。  |
58| FULL    | 3    | 表示电池充电状态为已充满状态。 |
59
60## BatteryHealthState
61
62表示电池健康状态的枚举。
63
64**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
65
66| 名称          | 值  | 说明           |
67| ----------- | ---- | -------------- |
68| UNKNOWN     | 0    | 表示电池健康状态未知。    |
69| GOOD        | 1    | 表示电池健康状态为正常。   |
70| OVERHEAT    | 2    | 表示电池健康状态为过热。   |
71| OVERVOLTAGE | 3    | 表示电池健康状态为过压。   |
72| COLD        | 4    | 表示电池健康状态为低温。   |
73| DEAD        | 5    | 表示电池健康状态为僵死状态。 |
74
75## BatteryCapacityLevel<sup>9+</sup>
76
77表示电池电量等级的枚举。
78
79**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
80
81| 名称           | 值 | 说明                       |
82| -------------- | ------ | ---------------------------- |
83| LEVEL_FULL     | 1      | 表示电池电量等级为满电量。   |
84| LEVEL_HIGH     | 2      | 表示电池电量等级为高电量。   |
85| LEVEL_NORMAL   | 3      | 表示电池电量等级为正常电量。 |
86| LEVEL_LOW      | 4      | 表示电池电量等级为低电量。   |
87| LEVEL_WARNING  | 5      | 表示电池电量等级为告警电量。 |
88| LEVEL_CRITICAL | 6      | 表示电池电量等级为极低电量。 |
89| LEVEL_SHUTDOWN | 7      | 表示电池电量等级为关机电量。 |
90
91## CommonEventBatteryChangedKey<sup>9+</sup>
92
93表示COMMON_EVENT_BATTERY_CHANGED通用事件附加信息的查询键。
94
95**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
96
97| 名称                 | 值 | 说明                                             |
98| -------------------- | ------ | -------------------------------------------------- |
99| EXTRA_SOC            | "soc" | 表示剩余电池电量百分比的查询键。                   |
100| EXTRA_CHARGE_STATE   | "chargeState" | 表示当前设备电池充电状态的查询键。                 |
101| EXTRA_HEALTH_STATE   | "healthState" | 表示当前设备电池健康状态的查询键。                 |
102| EXTRA_PLUGGED_TYPE   | "pluggedType" | 表示当前设备连接的充电器类型的查询键。             |
103| EXTRA_VOLTAGE        | "voltage" | 表示当前设备电池电压的查询键。                     |
104| EXTRA_TECHNOLOGY     | "technology" | 表示当前设备电池技术型号的查询键。                 |
105| EXTRA_TEMPERATURE    | "temperature" | 表示当前设备电池温度的查询键。                     |
106| EXTRA_PRESENT        | "present" | 表示当前设备是否支持电池或者电池是否在位的查询键。 |
107| EXTRA_CAPACITY_LEVEL | "capacityLevel" | 表示当前设备电池电量等级的查询键。                 |
108