From b9725de9cf6b9161a3ec14a994955c32b2fd5a18 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=A7=9C=E9=9C=B2?= <lu_jiang@neusoft.com>
Date: Fri, 18 Feb 2022 08:07:28 +0000
Subject: [PATCH] Add API reference for battery statistics

---
 .../apis/js-apis-battery-statistics.md        | 185 ++++++++++++++++++
 1 file changed, 185 insertions(+)
 create mode 100644 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 100644
index 00000000000..6bc8125a307
--- /dev/null
+++ b/zh-cn/application-dev/reference/apis/js-apis-battery-statistics.md
@@ -0,0 +1,185 @@
+# 耗电统计
+
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+
+## 导入模块
+
+```
+import batterystats from '@ohos.batterystats';
+```
+
+## 系统能力
+
+SystemCapability.PowerMgr.BatteryStatistics
+
+## ConsumptionType
+
+耗电信息的类型。
+
+| 名称 | 默认值 | 描述 |
+| -------- | -------- | -------- |
+| CONSUMPTION_TYPE_INVALID | -17 | 无效的耗电信息。 |
+| CONSUMPTION_TYPE_APP | -16 | 应用的耗电信息。 |
+| CONSUMPTION_TYPE_BLUETOOTH  | -15 | Bluetooth的耗电信息。 |
+| 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 | WIFI的耗电信息。 |
+
+## BatteryStatsInfo
+
+耗电信息。
+
+| **参数名** | **类型** | **说明** |
+| -------- | -------- |  -------- |
+| uid | number |  当type为CONSUMPTION_TYPE_APP时, 表示应用的uid。<br>当type为CONSUMPTION_TYPE_USER时, 表示用户ID。 |
+| type | [ConsumptionType](#ConsumptionType) | 耗电信息的类型。 |
+| power | number | 耗电量(mAh)。 |
+
+## getBatteryStats
+
+getBatteryStats(): Promise&lt;Array&lt;BatteryStatsInfo&gt;&gt;
+
+查询耗电统计信息。
+
+**返回值：**
+  | **类型** | **说明** |
+  | -------- | -------- |
+  | Promise&lt;&nbsp;Array&lt;[BatteryStatsInfo](#BatteryStatsInfo)&gt;&nbsp;&gt; | Promise实例，用于异步获取返回的BatteryStatsInfo对象数组。 |
+
+**示例：**
+```
+batterystats.getBatteryStats()
+.then(batterystatsinfolist => {
+    console.info('Get BatteryStatsInfo array success');
+})
+.catch(error => {
+    console.log('Get BatteryStatsInfo array error: ' + error);
+})
+```
+
+## getBatteryStats
+
+getBatteryStats(callback: AsyncCallback&lt;BatteryStatsInfo&gt;&gt;): void
+
+查询耗电统计信息。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| callback | AsyncCallback&lt;Array&lt;[BatteryStatsInfo](#BatteryStatsInfo)&gt;&gt; | 是 | 指定的callback回调方法，用于获取返回的BatteryStatsInfo对象数组。 |
+
+**示例：**
+
+```
+batterystats.getBatteryStats()
+.then(batterystatsinfolist => {
+    console.info('Get BatteryStatsInfo array success');
+})
+.catch(error => {
+    console.log('Get BatteryStatsInfo array error: ' + error);
+})
+```
+
+## getAppPowerValue
+
+getAppPowerValue(uid: number): number
+
+获取指定应用的耗电量。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| uid | number | 是 | 应用的uid。 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| number | 应用的耗电量(mAh)。 |
+
+**示例：**
+
+```
+let uid = 111;
+let appConsumptionMah = batterystats.getAppPowerValue(uid);
+```
+
+## getAppPowerPercent
+
+getAppPowerPercent(uid: number): number
+
+获取指定应用的耗电百分比。
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| uid | number | 是 | 应用的uid。 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| number | 应用的耗电百分比。 |
+
+**示例：**
+
+```
+let uid = 111;
+let appConsumptionPercent = batterystats.getAppPowerPercent(uid);
+```
+
+## getHardwareUnitPowerValue
+
+getHardwareUnitPowerValue(type: ConsumptionType): number
+
+获取指定硬件的耗电量。
+
+**参数：**
+
+| 参数名 | 类型  | 说明 |
+| -------- | --------  | -------- |
+| type | [ConsumptionType](#ConsumptionType) | 耗电信息的类型。 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| number | 硬件的耗电量(mAh)。 |
+
+**示例：**
+
+```
+let bluetoothConsumptionMah = batterystats.getHardwareUnitPowerValue(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH);
+```
+
+## getHardwareUnitPowerPercent
+
+getHardwareUnitPowerPercent(type: ConsumptionType): number
+
+获取指定硬件的耗电百分比。
+
+**参数：**
+
+| 参数名 | 类型  | 说明 |
+| -------- | --------  | -------- |
+| type | [ConsumptionType](#ConsumptionType) | 耗电信息的类型。 |
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| number | 硬件的耗电百分比。 |
+
+**示例：**
+
+```
+let bluetoothConsumptionPercent = batterystats.getHardwareUnitPowerPercent(ConsumptionType.CONSUMPTION_TYPE_BLUETOOTH);
+```
\ No newline at end of file
-- 
Gitee