@ohos.batteryStatistics (耗电统计)


@ohos.batteryStatistics (耗电统计)

该模块提供软硬件耗电统计信息的查询接口。

说明:

  • 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

  • 本模块接口为系统接口。

导入模块

import batteryStats from '@ohos.batteryStatistics';
1

batteryStats.getBatteryStats

getBatteryStats(): Promise<Array<BatteryStatsInfo>>

获取耗电信息列表。使用Promise异步回调。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

返回值:

类型 说明
Promise<Array<BatteryStatsInfo>> Promise对象,返回耗电信息列表。

错误码:

以下错误码的详细介绍请参见耗电统计错误码

错误码ID 错误信息
4600101 连接服务失败。

示例:

batteryStats.getBatteryStats()
.then(data => {
    console.info('battery statistics info: ' + data);
})
.catch(err => {
    console.error('get battery statisitics failed, err: ' + err);
});
1
2
3
4
5
6
7

batteryStats.getBatteryStats

getBatteryStats(callback: AsyncCallback<Array<BatteryStatsInfo>>): void

获取耗电信息列表。使用callback异步回调。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<BatteryStatsInfo>> 回调函数。当获取耗电信息列表成功,err为undefined,data为获取到的Array<BatteryStatsInfo>>;否则为错误对象。

错误码:

以下错误码的详细介绍请参见耗电统计错误码

错误码ID 错误信息
4600101 连接服务失败。

示例:

batteryStats.getBatteryStats((err, data) => {
    if (typeof err === 'undefined') {
        console.info('battery statistics info: ' + data);
    } else {
        console.error('get battery statisitics failed, err: ' + err);
    }
});
1
2
3
4
5
6
7

batteryStats.getAppPowerValue

getAppPowerValue(uid: number): number

获取应用的耗电量。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

参数:

参数名 类型 必填 说明
uid number 应用的UID。

返回值:

类型 说明
number UID对应应用的耗电量,单位毫安时。

错误码:

以下错误码的详细介绍请参见耗电统计错误码

错误码ID 错误信息
4600101 连接服务失败。

示例:

try {
    var value = batteryStats.getAppPowerValue(10021);
    console.info('battery statistics value of app is: ' + value);
} catch(err) {
    console.error('get battery statisitics value of app failed, err: ' + err);
}
1
2
3
4
5
6

batteryStats.getAppPowerPercent

getAppPowerPercent(uid: number): number

获取应用的耗电百分比。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

参数:

参数名 类型 必填 说明
uid number 应用的UID。

返回值:

类型 说明
number UID对应应用的耗电百分比。

错误码:

以下错误码的详细介绍请参见耗电统计错误码

错误码ID 错误信息
4600101 连接服务失败。

示例:

try {
    var percent = batteryStats.getAppPowerPercent(10021);
    console.info('battery statistics percent of app is: ' + percent);
} catch(err) {
    console.error('get battery statisitics percent of app failed, err: ' + err);
}
1
2
3
4
5
6

batteryStats.getHardwareUnitPowerValue

getHardwareUnitPowerValue(type: ConsumptionType): number

根据耗电类型获取硬件单元的耗电量。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

参数:

参数名 类型 必填 说明
type ConsumptionType 电量消耗类型。

返回值:

类型 说明
number 电量消耗类型对应硬件的耗电量,单位毫安时。

错误码:

以下错误码的详细介绍请参见耗电统计错误码

错误码ID 错误信息
4600101 连接服务失败。

示例:

try {
    var value = batteryStats.getHardwareUnitPowerValue(ConsumptionType.CONSUMPTION_TYPE_SCREEN);
    console.info('battery statistics percent of hardware is: ' + percent);
} catch(err) {
    console.error('get battery statisitics percent of hardware failed, err: ' + err);
}
1
2
3
4
5
6

batteryStats.getHardwareUnitPowerPercent

getHardwareUnitPowerPercent(type: ConsumptionType): number

根据耗电类型获取硬件单元的耗电百分比。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

参数:

参数名 类型 必填 说明
type ConsumptionType 电量消耗类型。

返回值:

类型 说明
number 电量消耗类型对应硬件的耗电百分比。

错误码:

以下错误码的详细介绍请参见耗电统计错误码

错误码ID 错误信息
4600101 连接服务失败。

示例:

try {
    var value = batteryStats.getHardwareUnitPowerPercent(ConsumptionType.CONSUMPTION_TYPE_SCREEN);
    console.info('battery statistics percent of hardware is: ' + percent);
} catch(err) {
    console.error('get battery statisitics percent of hardware failed, err: ' + err);
}
1
2
3
4
5
6

BatteryStatsInfo

设备的耗电信息。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

属性

名称 类型 可读 可写 说明
uid number 耗电信息相关的UID。
type ConsumptionType 耗电信息相关的类型。
power number 耗电的值,单位毫安时。

ConsumptionType

表示电量消耗类型的枚举值。

系统接口: 此接口为系统接口。

系统能力: SystemCapability.PowerManager.BatteryStatistics

名称 说明
CONSUMPTION_TYPE_INVALID -17 表示电量消耗类型未知。
CONSUMPTION_TYPE_APP -16 表示应用消耗的电量类型。
CONSUMPTION_TYPE_BLUETOOTH -15 表示蓝牙消耗的电量类型。
CONSUMPTION_TYPE_IDLE -14 表示CPU空闲时消耗的电量类型。
CONSUMPTION_TYPE_PHONE -13 表示通话来电消耗的电量类型。
CONSUMPTION_TYPE_RADIO -12 表示无线通讯消耗的电量类型。
CONSUMPTION_TYPE_SCREEN -11 表示屏幕消耗的电量类型。
CONSUMPTION_TYPE_USER -10 表示用户消耗的电量类型。
CONSUMPTION_TYPE_WIFI -9 表示无线网消耗的电量类型。