1# ohbattery_info.h 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声明电池API以获取当前电池容量和电源类型的信息，定义电池相应常见事件。 13 14**库：** libohbattery_info.so 15 16**系统能力：** SystemCapability.PowerManager.BatteryManager.Core 17 18**起始版本：** 13 19 20**相关模块：** [OH_BatteryInfo](capi-oh-batteryinfo.md) 21 22## 汇总 23 24### 枚举 25 26| 名称 | typedef关键字 | 描述 | 27| -- | -- | -- | 28| [BatteryInfo_BatteryPluggedType](#batteryinfo_batterypluggedtype) | BatteryInfo_BatteryPluggedType | 定义插入类型。 | 29 30### 函数 31 32| 名称 | 描述 | 33| -- | -- | 34| [int32_t OH_BatteryInfo_GetCapacity()](#oh_batteryinfo_getcapacity) | 返回当前电池容量。 | 35| [BatteryInfo_BatteryPluggedType OH_BatteryInfo_GetPluggedType()](#oh_batteryinfo_getpluggedtype) | 返回当前插入的类型。 | 36 37### 变量 38 39| 名称 | 描述 | 40| -- | -- | 41| static const char * COMMON_EVENT_KEY_CAPACITY = "soc" | 标识电池容量变化后发送的常见事件。<br>**起始版本：** 13<br>**系统能力：** SystemCapability.PowerManager.BatteryManager.Core | 42| static const char * COMMON_EVENT_KEY_CHARGE_STATE = "chargeState" | 标识充电状态更改后发送的常见事件。<br>**起始版本：** 13 | 43| static const char * COMMON_EVENT_KEY_PLUGGED_TYPE = "pluggedType" | 标识插入类型更改后发送的常见事件。<br>**起始版本：** 13 | 44 45## 枚举类型说明 46 47### BatteryInfo_BatteryPluggedType 48 49``` 50enum BatteryInfo_BatteryPluggedType 51``` 52 53**描述** 54 55定义插入类型。 56 57**起始版本：** 13 58 59| 枚举项 | 描述 | 60| -- | -- | 61| PLUGGED_TYPE_NONE | 电源已拔下。 | 62| PLUGGED_TYPE_AC | 电源是交流充电。 | 63| PLUGGED_TYPE_USB | 电源是USB DC充电。 | 64| PLUGGED_TYPE_WIRELESS | 电源为无线充电。 | 65| PLUGGED_TYPE_BUTT | 预留枚举 | 66 67 68## 函数说明 69 70### OH_BatteryInfo_GetCapacity() 71 72``` 73int32_t OH_BatteryInfo_GetCapacity() 74``` 75 76**描述** 77 78返回当前电池容量。 79 80**系统能力：** SystemCapability.PowerManager.BatteryManager.Core 81 82**起始版本：** 13 83 84**返回：** 85 86| 类型 | 说明 | 87| -- | -- | 88| int32_t | 返回介于0和100之间的数字。 | 89 90### OH_BatteryInfo_GetPluggedType() 91 92``` 93BatteryInfo_BatteryPluggedType OH_BatteryInfo_GetPluggedType() 94``` 95 96**描述** 97 98返回当前插入的类型。 99 100**系统能力：** SystemCapability.PowerManager.BatteryManager.Core 101 102**起始版本：** 13 103 104**返回：** 105 106| 类型 | 说明 | 107| -- | -- | 108| [BatteryInfo_BatteryPluggedType](#batteryinfo_batterypluggedtype) | {@link BatteryInfo_BatteryPluggedType#PLUGGED_TYPE_NONE} 如果电源被拔下。<br> [PLUGGED_TYPE_AC](capi-ohbattery-info-h.md#batteryinfo_batterypluggedtype) 如果电源是AC充电。<br> [PLUGGED_TYPE_USB](capi-ohbattery-info-h.md#batteryinfo_batterypluggedtype) 如果电源是USB DC充电。<br> [PLUGGED_TYPE_WIRELESS](capi-ohbattery-info-h.md#batteryinfo_batterypluggedtype) 如果电源是无线充电。<br> [PLUGGED_TYPE_BUTT](capi-ohbattery-info-h.md#batteryinfo_batterypluggedtype) 如果类型未知。 | 109 110 111