From 1faeaa816867907d5e1c89934c696e41deeacb4e Mon Sep 17 00:00:00 2001 From: Lu Jiang Date: Mon, 21 Feb 2022 18:02:40 +0800 Subject: [PATCH 1/3] Add API reference for battery statistics Signed-off-by: Lu Jiang --- .../apis/js-apis-battery-statistics.md | 193 ++++++++++++++++++ 1 file changed, 193 insertions(+) create mode 100755 zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md new file mode 100755 index 00000000000..fcf4d67b346 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md @@ -0,0 +1,193 @@ +# 耗电统计 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + +``` +import batterystatistics from '@ohos.batterystatistics'; +``` + +## ConsumptionType + +耗电信息的类型。 + +| 名称 | 值 | 说明 | +| -------- | -------- | -------- | +| CONSUMPTION_TYPE_INVALID | -17 | 无效的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_APP | -16 | 应用的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_BLUETOOTH | -15 | 蓝牙的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_IDLE | -14 | CPU空闲的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_PHONE | -13 | 通话的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_RADIO | -12 | 移动无线的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_SCREEN | -11 | 屏幕的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_USER | -10 | 用户的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| CONSUMPTION_TYPE_WIFI | -9 | WIFI的耗电信息。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | + +## BatteryStatsInfo + +耗电信息。 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| uid | number | 是|否|当type为CONSUMPTION_TYPE_APP时, 表示应用的uid。
当type为CONSUMPTION_TYPE_USER时, 表示用户ID。
其他情况下, uid为无效值-1。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| type | 是|否|[ConsumptionType](#ConsumptionType) | 耗电信息的类型。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | +| power | number |是|否| 耗电量(mAh)。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | + +## batterystatistics.getBatteryStats + +getBatteryStats(): Promise<Array<BatteryStatsInfo>> + +查询耗电统计信息, 通过Promise返回结果。 + +**系统能力**: SystemCapability.PowerManager.BatteryStatistics + +**返回值：** + | 类型 | 说明 | + | -------- | -------- | + | Promise< Array<[BatteryStatsInfo](#BatteryStatsInfo)> > | Promise实例，用于异步获取返回的BatteryStatsInfo对象数组。 | + +**示例：** +``` +batterystatistics.getBatteryStats() +.then(batterystatsinfolist => { + console.info('Get BatteryStatsInfo array success'); +}) +.catch(error => { + console.log('Get BatteryStatsInfo array error: ' + error); +}) +``` + +## batterystatistics.getBatteryStats + +getBatteryStats(callback: AsyncCallback<Array<[BatteryStatsInfo](#BatteryStatsInfo)>>): void + +查询耗电统计信息, 通过指定的callback回调方法返回结果。 + +**系统能力**: SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<Array<[BatteryStatsInfo](#BatteryStatsInfo)>> | 是 | 指定的callback回调方法，用于获取返回的BatteryStatsInfo对象数组。 | + +**示例：** + +``` +batterystatistics.getBatteryStats() +.then(batterystatsinfolist => { + console.info('Get BatteryStatsInfo array success'); +}) +.catch(error => { + console.log('Get BatteryStatsInfo array error: ' + error); +}) +``` + +## batterystatistics.getAppPowerValue + +getAppPowerValue(uid: number): number + +获取指定应用的耗电量。 + +**系统能力**: SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| uid | number | 是 | 应用的uid。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 应用的耗电量(mAh)。 | + +**示例：** + +``` +let uid = 111; +let appConsumptionMah = batterystatistics.getAppPowerValue(uid); +``` + +## batterystatistics.getAppPowerPercent + +getAppPowerPercent(uid: number): number + +获取指定应用的耗电百分比。 + +**系统能力**: SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| uid | number | 是 | 应用的uid。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 应用的耗电百分比。(例如: 0.4) | + +**示例：** + +``` +let uid = 111; +let appConsumptionPercent = batterystatistics.getAppPowerPercent(uid); +``` + +## batterystatistics.getHardwareUnitPowerValue + +getHardwareUnitPowerValue(type: ConsumptionType): number + +获取指定硬件的耗电量。 + +**系统能力**: SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 说明 | +| -------- | -------- | -------- | +| type | [ConsumptionType](#ConsumptionType) | 耗电信息的类型。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 硬件的耗电量(mAh)。 | + +**示例：** + +``` +let bluetoothConsumptionMah = batterystatistics.getHardwareUnitPowerValue(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH); +``` + +## batterystatistics.getHardwareUnitPowerPercent + +getHardwareUnitPowerPercent(type: ConsumptionType): number + +获取指定硬件的耗电百分比。 + +**系统能力**: SystemCapability.PowerManager.BatteryStatistics + +**参数：** + +| 参数名 | 类型 | 说明 | +| -------- | -------- | -------- | +| type | [ConsumptionType](#ConsumptionType) | 耗电信息的类型。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 硬件的耗电百分比。(例如: 0.4) | + +**示例：** + +``` +let bluetoothConsumptionPercent = batterystatistics.getHardwareUnitPowerPercent(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH); +``` \ No newline at end of file -- Gitee From 3d26e8b510926867f633f71de38582c681503c63 Mon Sep 17 00:00:00 2001 From: Lu Jiang Date: Tue, 22 Feb 2022 18:01:08 +0800 Subject: [PATCH 2/3] Fix for module name spelling Signed-off-by: Lu Jiang --- .../reference/apis/js-apis-battery-statistics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md index fcf4d67b346..3faaafc4b37 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md @@ -7,7 +7,7 @@ ## 导入模块 ``` -import batterystatistics from '@ohos.batterystatistics'; +import batteryStats from '@ohos.batterystatistics'; ``` ## ConsumptionType -- Gitee From f28820dcb9e084b94755f25dc7e029c088e23d39 Mon Sep 17 00:00:00 2001 From: Lu Jiang Date: Wed, 23 Feb 2022 14:42:35 +0800 Subject: [PATCH 3/3] Rename battery statistics interface file Signed-off-by: Lu Jiang --- .../apis/js-apis-battery-statistics.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md index 3faaafc4b37..2649e794296 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md @@ -7,7 +7,7 @@ ## 导入模块 ``` -import batteryStats from '@ohos.batterystatistics'; +import batteryStats from '@ohos.batteryStatistics'; ``` ## ConsumptionType @@ -36,7 +36,7 @@ import batteryStats from '@ohos.batterystatistics'; | type | 是|否|[ConsumptionType](#ConsumptionType) | 耗电信息的类型。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | | power | number |是|否| 耗电量(mAh)。
**系统能力**: SystemCapability.PowerManager.BatteryStatistics | -## batterystatistics.getBatteryStats +## batteryStats.getBatteryStats getBatteryStats(): Promise<Array<BatteryStatsInfo>> @@ -51,7 +51,7 @@ getBatteryStats(): Promise<Array<BatteryStatsInfo>> **示例：** ``` -batterystatistics.getBatteryStats() +batteryStats.getBatteryStats() .then(batterystatsinfolist => { console.info('Get BatteryStatsInfo array success'); }) @@ -60,7 +60,7 @@ batterystatistics.getBatteryStats() }) ``` -## batterystatistics.getBatteryStats +## batteryStats.getBatteryStats getBatteryStats(callback: AsyncCallback<Array<[BatteryStatsInfo](#BatteryStatsInfo)>>): void @@ -77,7 +77,7 @@ getBatteryStats(callback: AsyncCallback<Array<[BatteryStatsInfo](#BatteryS **示例：** ``` -batterystatistics.getBatteryStats() +batteryStats.getBatteryStats() .then(batterystatsinfolist => { console.info('Get BatteryStatsInfo array success'); }) @@ -86,7 +86,7 @@ batterystatistics.getBatteryStats() }) ``` -## batterystatistics.getAppPowerValue +## batteryStats.getAppPowerValue getAppPowerValue(uid: number): number @@ -110,10 +110,10 @@ getAppPowerValue(uid: number): number ``` let uid = 111; -let appConsumptionMah = batterystatistics.getAppPowerValue(uid); +let appConsumptionMah = batteryStats.getAppPowerValue(uid); ``` -## batterystatistics.getAppPowerPercent +## batteryStats.getAppPowerPercent getAppPowerPercent(uid: number): number @@ -137,10 +137,10 @@ getAppPowerPercent(uid: number): number ``` let uid = 111; -let appConsumptionPercent = batterystatistics.getAppPowerPercent(uid); +let appConsumptionPercent = batteryStats.getAppPowerPercent(uid); ``` -## batterystatistics.getHardwareUnitPowerValue +## batteryStats.getHardwareUnitPowerValue getHardwareUnitPowerValue(type: ConsumptionType): number @@ -163,10 +163,10 @@ getHardwareUnitPowerValue(type: ConsumptionType): number **示例：** ``` -let bluetoothConsumptionMah = batterystatistics.getHardwareUnitPowerValue(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH); +let bluetoothConsumptionMah = batteryStats.getHardwareUnitPowerValue(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH); ``` -## batterystatistics.getHardwareUnitPowerPercent +## batteryStats.getHardwareUnitPowerPercent getHardwareUnitPowerPercent(type: ConsumptionType): number @@ -189,5 +189,5 @@ getHardwareUnitPowerPercent(type: ConsumptionType): number **示例：** ``` -let bluetoothConsumptionPercent = batterystatistics.getHardwareUnitPowerPercent(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH); +let bluetoothConsumptionPercent = batteryStats.getHardwareUnitPowerPercent(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH); ``` \ No newline at end of file -- Gitee