@system.battery (Battery Information)

The battery module allows you to query the charging status and remaining power of a device.

NOTE

The APIs of this module are no longer maintained since API version 6. It is recommended that you use @ohos.batteryInfo instead.

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

Modules to Import

import battery, { BatteryResponse } from '@system.battery';

battery.getStatus

getStatus(options?: GetStatusOptions): void;

Obtains the current charging state and battery level.

System capability: SystemCapability.PowerManager.BatteryManager.Lite

Parameters

Name	Type	Mandatory	Description
options	GetStatusOptions	No	Object that contains the API calling result. This parameter is optional and is left blank by default.

Example

battery.getStatus({
    success: (data: BatteryResponse) => {
        console.log('success get battery level:' + data.level);
    },
    fail: (data: string, code: number) => {
        console.error('fail to get battery level code:' + code + ', data: ' + data);
    }
});

GetStatusOptions

Object that contains the API calling result.

System capability: SystemCapability.PowerManager.BatteryManager.Lite

Name	Type	Mandatory	Description
success	(data: BatteryResponse) => void	No	Called when an API call is successful. data is a return value of the BatteryResponse type.
fail	(data: string, code: number) => void	No	Called when an API call has failed. data indicates the error information, and code indicates the error code.
complete	() => void	No	Called when an API call is complete.

BatteryResponse

Defines a response that returns the charging status and remaining power of the device.

System capability: SystemCapability.PowerManager.BatteryManager.Lite

Name	Type	Readable	Writable	Description
charging	boolean	Yes	No	Whether the battery is being charged.
level	number	Yes	No	Current battery level, which ranges from 0.00 to 1.00.