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