1# @ohos.batteryInfo (电量信息)
2
3该模块主要提供电池状态和充放电状态的查询接口。
4
5> **说明:**
6>
7> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9
10## 导入模块
11
12```js
13import {batteryInfo} from '@kit.BasicServicesKit';
14```
15
16## 属性
17
18描述电池信息。
19
20**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
21
22| 名称      | 类型        | 可读 | 可写 |  说明     |
23| --------------- | ------------------- | ---- | ---- | ---------------------|
24| batterySOC                                | number                                         | 是   | 否   | 表示当前设备剩余电池电量百分比。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。                           |
25| chargingStatus                            | [BatteryChargeState](#batterychargestate)      | 是   | 否   | 表示当前设备电池的充电状态。<br>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。                               |
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| nowCurrent<sup>12+</sup>                  | number                                         | 是   | 否   | 表示当前设备电池的电流,单位毫安。                        |
34
35**示例**:
36
37  ```ts
38  import {batteryInfo} from '@kit.BasicServicesKit';
39
40  let batterySOCInfo: number = batteryInfo.batterySOC;
41  console.info("The batterySOCInfo is: " + batterySOCInfo);
42
43  let chargingStatusInfo = batteryInfo.chargingStatus;
44  console.info("The chargingStatusInfo is: " + chargingStatusInfo);
45
46  let healthStatusInfo = batteryInfo.healthStatus;
47  console.info("The healthStatusInfo is: " + healthStatusInfo);
48
49  let pluggedTypeInfo = batteryInfo.pluggedType;
50  console.info("The pluggedTypeInfo is: " + pluggedTypeInfo);
51
52  let voltageInfo: number = batteryInfo.voltage;
53  console.info("The voltageInfo is: " + voltageInfo);
54
55  let technologyInfo: string = batteryInfo.technology;
56  console.info("The technologyInfo is: " + technologyInfo);
57
58  let batteryTemperatureInfo: number = batteryInfo.batteryTemperature;
59  console.info("The batteryTemperatureInfo is: " + batteryTemperatureInfo);
60
61  let isBatteryPresentInfo: boolean = batteryInfo.isBatteryPresent;
62  console.info("The isBatteryPresentInfo is: " + isBatteryPresentInfo);
63
64  let batteryCapacityLevelInfo = batteryInfo.batteryCapacityLevel;
65  console.info("The batteryCapacityLevelInfo is: " + batteryCapacityLevelInfo);
66
67  let nowCurrentInfo: number = batteryInfo.nowCurrent;
68  console.info("The nowCurrentInfo is: " + nowCurrentInfo);
69  ```
70
71## BatteryPluggedType
72
73表示连接的充电器类型的枚举。
74
75**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
76
77| 名称       | 值  | 说明              |
78| -------- | ---- | ----------------- |
79| NONE     | 0    | 表示未获取到连接充电器类型。      |
80| AC       | 1    | 表示连接的充电器类型为交流充电器。 |
81| USB      | 2    | 表示连接的充电器类型为USB。   |
82| WIRELESS | 3    | 表示连接的充电器类型为无线充电器。 |
83
84## BatteryChargeState
85
86表示电池充电状态的枚举。
87
88**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
89
90**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
91
92| 名称      | 值  | 说明            |
93| ------- | ---- | --------------- |
94| NONE    | 0    | 表示电池充电状态未知。     |
95| ENABLE  | 1    | 表示电池充电状态为使能状态。  |
96| DISABLE | 2    | 表示电池充电状态为停止状态。  |
97| FULL    | 3    | 表示电池充电状态为已充满状态。 |
98
99## BatteryHealthState
100
101表示电池健康状态的枚举。
102
103**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
104
105| 名称          | 值  | 说明           |
106| ----------- | ---- | -------------- |
107| UNKNOWN     | 0    | 表示电池健康状态未知。    |
108| GOOD        | 1    | 表示电池健康状态为正常。   |
109| OVERHEAT    | 2    | 表示电池健康状态为过热。   |
110| OVERVOLTAGE | 3    | 表示电池健康状态为过压。   |
111| COLD        | 4    | 表示电池健康状态为低温。   |
112| DEAD        | 5    | 表示电池健康状态为僵死状态。 |
113
114## BatteryCapacityLevel<sup>9+</sup>
115
116表示电池电量等级的枚举。
117
118**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
119
120| 名称           | 值 | 说明                       |
121| -------------- | ------ | ---------------------------- |
122| LEVEL_FULL     | 1      | 表示电池电量等级为满电量。   |
123| LEVEL_HIGH     | 2      | 表示电池电量等级为高电量。   |
124| LEVEL_NORMAL   | 3      | 表示电池电量等级为正常电量。 |
125| LEVEL_LOW      | 4      | 表示电池电量等级为低电量。   |
126| LEVEL_WARNING  | 5      | 表示电池电量等级为告警电量。 |
127| LEVEL_CRITICAL | 6      | 表示电池电量等级为极低电量。 |
128| LEVEL_SHUTDOWN | 7      | 表示电池电量等级为关机电量。 |
129
130## CommonEventBatteryChangedKey<sup>9+</sup>
131
132表示COMMON_EVENT_BATTERY_CHANGED通用事件附加信息的查询键。
133
134**系统能力**:SystemCapability.PowerManager.BatteryManager.Core
135
136| 名称                 | 值 | 说明                                             |
137| -------------------- | ------ | -------------------------------------------------- |
138| EXTRA_SOC            | "soc" | 表示剩余电池电量百分比的查询键。                   |
139| EXTRA_CHARGE_STATE   | "chargeState" | 表示当前设备电池充电状态的查询键。                 |
140| EXTRA_HEALTH_STATE   | "healthState" | 表示当前设备电池健康状态的查询键。                 |
141| EXTRA_PLUGGED_TYPE   | "pluggedType" | 表示当前设备连接的充电器类型的查询键。             |
142| EXTRA_VOLTAGE        | "voltage" | 表示当前设备电池电压的查询键。                     |
143| EXTRA_TECHNOLOGY     | "technology" | 表示当前设备电池技术型号的查询键。                 |
144| EXTRA_TEMPERATURE    | "temperature" | 表示当前设备电池温度的查询键。                     |
145| EXTRA_PRESENT        | "present" | 表示当前设备是否支持电池或者电池是否在位的查询键。 |
146| EXTRA_CAPACITY_LEVEL | "capacityLevel" | 表示当前设备电池电量等级的查询键。                 |
147