@ohos.batteryInfo (Battery Information)

The batteryInfo module provides APIs for querying the charger type, battery health status, and battery charging status.

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import batteryInfo from '@ohos.batteryInfo';

Attributes

Describes battery information.

System capability: SystemCapability.PowerManager.BatteryManager.Core

Name	Type	Readable	Writable	Description
batterySOC	number	Yes	No	Battery state of charge (SoC) of the device, in unit of percentage.
chargingStatus	BatteryChargeState	Yes	No	Battery charging status of the device.
healthStatus	BatteryHealthState	Yes	No	Battery health status of the device.
pluggedType	BatteryPluggedType	Yes	No	Charger type of the device.
voltage	number	Yes	No	Battery voltage of the device, in unit of microvolt.
technology	string	Yes	No	Battery technology of the device.
batteryTemperature	number	Yes	No	Battery temperature of the device, in unit of 0.1°C.
isBatteryPresent⁷⁺	boolean	Yes	No	Whether the battery is supported or present.
batteryCapacityLevel⁹⁺	BatteryCapacityLevel	Yes	No	Battery level of the device.
estimatedRemainingChargeTime⁹⁺	number	Yes	No	Estimated time for fully charging the current device, in unit of milliseconds. This is a system API.
totalEnergy⁹⁺	number	Yes	No	Total battery capacity of the device, in unit of mAh. This is a system API.
nowCurrent⁹⁺	number	Yes	No	Battery current of the device, in unit of mA. This is a system API.
remainingEnergy⁹⁺	number	Yes	No	Remaining battery capacity of the device, in unit of mAh. This is a system API.

BatteryPluggedType

Enumerates charger types.

System capability: SystemCapability.PowerManager.BatteryManager.Core

Name	Value	Description
NONE	0	Unknown charger type.
AC	1	AC charger.
USB	2	USB charger.
WIRELESS	3	Wireless charger.

BatteryChargeState

Enumerates charging states.

System capability: SystemCapability.PowerManager.BatteryManager.Core

Name	Value	Description
NONE	0	Unknown state.
ENABLE	1	The battery is being charged.
DISABLE	2	The battery is not being charged.
FULL	3	The battery is fully charged.

BatteryHealthState

Enumerates battery health states.

System capability: SystemCapability.PowerManager.BatteryManager.Core

Name	Value	Description
UNKNOWN	0	Unknown state.
GOOD	1	The battery is in the healthy state.
OVERHEAT	2	The battery is overheated.
OVERVOLTAGE	3	The battery voltage is over high.
COLD	4	The battery temperature is low.
DEAD	5	The battery is dead.

BatteryCapacityLevel⁹⁺

Enumerates battery levels.

System capability: SystemCapability.PowerManager.BatteryManager.Core

Name	Value	Description
LEVEL_FULL	1	Full battery level.
LEVEL_HIGH	2	High battery level.
LEVEL_NORMAL	3	Normal battery level.
LEVEL_LOW	4	Low battery level.
LEVEL_WARNING	5	Alarm battery level.
LEVEL_CRITICAL	6	Ultra-low battery level.
LEVEL_SHUTDOWN	7	Power-down battery level.

CommonEventBatteryChangedKey⁹⁺

Enumerates keys for querying the additional information about the COMMON_EVENT_BATTERY_CHANGED event.

System capability: SystemCapability.PowerManager.BatteryManager.Core

Name	Value	Description
EXTRA_SOC	"soc"	Remaining battery level in percentage.
EXTRA_CHARGE_STATE	"chargeState"	Battery charging status of the device.
EXTRA_HEALTH_STATE	"healthState"	Battery health status of the device.
EXTRA_PLUGGED_TYPE	"pluggedType"	Type of the charger connected to the device.
EXTRA_VOLTAGE	"voltage"	Battery voltage of the device.
EXTRA_TECHNOLOGY	"technology"	Battery technology of the device.
EXTRA_TEMPERATURE	"temperature"	Battery temperature of the device.
EXTRA_PRESENT	"present"	Whether the battery is supported by the device or installed.
EXTRA_CAPACITY_LEVEL	"capacityLevel"	Battery level of the device.