1# OH_BatteryInfo
2
3## 概述
4
5提供BatteryInfo模块的电池相关信息的能力。
6
7**系统能力：** SystemCapability.PowerManager.BatteryManager.Core
8
9**起始版本：** 13
10
11
12## 汇总
13
14
15### 文件
16
17| 名称 | 描述 |
18| -------- | -------- |
19| [ohbattery_info.h](ohbattery__info_8h.md) | 声明电池API以获取当前电池容量和电源类型的信息，定义电池相应常见事件。<br/>**库：** libohbattery_info.so |
20
21
22### 枚举
23
24| 名称 | 描述 |
25| -------- | -------- |
26| [BatteryInfo_BatteryPluggedType](#batteryinfo_batterypluggedtype) {<br/>PLUGGED_TYPE_NONE , PLUGGED_TYPE_AC , PLUGGED_TYPE_USB , PLUGGED_TYPE_WIRELESS , PLUGGED_TYPE_BUTT } | 定义插入类型。 |
27
28
29### 函数
30
31| 名称 | 描述 |
32| -------- | -------- |
33| int32_t [OH_BatteryInfo_GetCapacity](#oh_batteryinfo_getcapacity) () | 返回当前电池容量。 |
34| [BatteryInfo_BatteryPluggedType](#batteryinfo_batterypluggedtype)[OH_BatteryInfo_GetPluggedType](#oh_batteryinfo_getpluggedtype) () | 返回当前插入的类型。 |
35
36
37### 变量
38
39| 名称 | 描述 |
40| -------- | -------- |
41| static const char\* [COMMON_EVENT_KEY_CAPACITY](#common_event_key_capacity) = "soc" | 标识电池容量变化后发送的常见事件。 |
42| static const char\* [COMMON_EVENT_KEY_CHARGE_STATE](#common_event_key_charge_state) = "chargeState" | 标识充电状态更改后发送的常见事件。 |
43| static const char\* [COMMON_EVENT_KEY_PLUGGED_TYPE](#common_event_key_plugged_type) = "pluggedType" | 标识插入类型更改后发送的常见事件。 |
44
45
46## 枚举类型说明
47
48
49### BatteryInfo_BatteryPluggedType
50
51```
52enum BatteryInfo_BatteryPluggedType
53```
54
55**描述**
56
57定义插入类型。
58
59**起始版本：** 13
60
61| 枚举值 | 描述 |
62| -------- | -------- |
63| PLUGGED_TYPE_NONE | 电源已拔下。 |
64| PLUGGED_TYPE_AC | 电源是交流充电。 |
65| PLUGGED_TYPE_USB | 电源是USB DC充电。 |
66| PLUGGED_TYPE_WIRELESS | 电源为无线充电。 |
67| PLUGGED_TYPE_BUTT | 预留枚举。 |
68
69
70## 函数说明
71
72
73### OH_BatteryInfo_GetCapacity()
74
75```
76int32_t OH_BatteryInfo_GetCapacity ()
77```
78
79**描述**
80
81返回当前电池容量。
82
83**系统能力：** SystemCapability.PowerManager.BatteryManager.Core
84
85**起始版本：** 13
86
87**返回：**
88
89返回介于0和100之间的数字。
90
91
92### OH_BatteryInfo_GetPluggedType()
93
94```
95BatteryInfo_BatteryPluggedType OH_BatteryInfo_GetPluggedType ()
96```
97
98**描述**
99
100返回当前插入的类型。
101
102**系统能力：** SystemCapability.PowerManager.BatteryManager.Core
103
104**起始版本：** 13
105
106**返回：**
107
108PLUGGED_TYPE_NONE：表示电源被拔下。
109
110PLUGGED_TYPE_AC：表示电源是AC充电。
111
112PLUGGED_TYPE_USB：表示电源是USB DC充电。
113
114PLUGGED_TYPE_WIRELESS：表示电源是无线充电。
115
116PLUGGED_TYPE_BUTT：表示类型未知。
117
118
119## 变量说明
120
121
122### COMMON_EVENT_KEY_CAPACITY
123
124```
125const char* COMMON_EVENT_KEY_CAPACITY = "soc"
126```
127
128**描述**
129
130标识电池容量变化后发送的常见事件。
131
132**起始版本：** 13
133
134
135### COMMON_EVENT_KEY_CHARGE_STATE
136
137```
138const char* COMMON_EVENT_KEY_CHARGE_STATE = "chargeState"
139```
140
141**描述**
142
143标识充电状态更改后发送的常见事件。
144
145**起始版本：** 13
146
147
148### COMMON_EVENT_KEY_PLUGGED_TYPE
149
150```
151const char* COMMON_EVENT_KEY_PLUGGED_TYPE = "pluggedType"
152```
153
154**描述**
155
156标识插入类型更改后发送的常见事件。
157
158**起始版本：** 13
159