From 6d223f7be156b8fa278998511250865c221fadd8 Mon Sep 17 00:00:00 2001 From: q00569459 Date: Sun, 20 Feb 2022 23:59:37 +0800 Subject: [PATCH 1/4] upload thermal api doc Signed-off-by: q00569459 --- .../reference/apis/js-apis-thermal.md | 89 +++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-thermal.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md new file mode 100644 index 00000000000..39ef91fb5f1 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -0,0 +1,89 @@ +# 热管理 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + +``` +import thermal from '@ohos.thermal'; +``` + + +## 系统能力 + +SystemCapability.PowerManager.ThermalManager + + +## ThermalLevel + +热档位信息。 + +| 名称 | 默认值 | 描述 | +| -------- | -------- | -------- | +| COOL | 0 | 表明设备处于凉爽的状态，业务执行不受限制。 | +| NORMAL | 1 | 表明设备处于普通工作状态，但并不凉爽，需要注意临近发热状态。 | +| WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 | +| HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 | +| OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 | +| WARNING | 5 | 表明设备已经发热严重并且即将进入紧急状态，无感知业务应全面停止，主要业务应降低至最低规格。 | +| EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 | + + +## subscribeThermalLevel + +subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void + +订阅热档位变化时的回调提醒。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<ThermalLevel> | 是 | 指定的callback回调方法，用于获取返回值。
callback返回值：热档位信息。 | + +**示例：** + +``` +thermal.subscribeThermalLevel((lev) => { + console.info("Thermal level is: " + lev); +}) +``` + +## unsubscribeThermalLevel + +unsubscribeThermalLevel(callback?: AsyncCallback): void + +订阅热档位变化时的回调提醒。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<void> | 是 | 指定的callback回调方法，无返回值。 | + +**示例：** + +``` +thermal.unsubscribeThermalLevel(); +``` + +## unsubscribeThermalLevel + +getThermalLevel(): ThermalLevel + +订阅热档位变化时的回调提醒。 + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| ThermalLevel | 热档位信息。 | + +**示例：** + +``` +var lev = thermal.getThermalLevel(); +console.info("Thermal level is: " + lev); +``` -- Gitee From c4b5a6265baae06a25aec6c2dcffd14878289074 Mon Sep 17 00:00:00 2001 From: q00569459 Date: Tue, 22 Feb 2022 12:32:58 +0800 Subject: [PATCH 2/4] Fix review issue Signed-off-by: q00569459 --- .../reference/apis/js-apis-thermal.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 39ef91fb5f1..46cf5b78d79 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -22,8 +22,8 @@ SystemCapability.PowerManager.ThermalManager | 名称 | 默认值 | 描述 | | -------- | -------- | -------- | -| COOL | 0 | 表明设备处于凉爽的状态，业务执行不受限制。 | -| NORMAL | 1 | 表明设备处于普通工作状态，但并不凉爽，需要注意临近发热状态。 | +| COOL | 0 | 表明设备处于低温的状态，业务执行不受热控的限制。 | +| NORMAL | 1 | 表明设备处于正常工作状态，但温度不低，需要注意是否临近发热状态。 | | WARM | 2 | 表明设备已经进入温热状态，部分无感知业务需要考虑停止或延迟执行。 | | HOT | 3 | 表明设备已经明显发热，无感知业务应全面停止，其他业务应考虑降规格及负载。 | | OVERHEATED | 4 | 表明设备已经发热严重，无感知业务应全面停止，主要业务需降低规格及负载。 | @@ -31,7 +31,7 @@ SystemCapability.PowerManager.ThermalManager | EMERGENCY | 6 | 表明设备已经进入紧急状态，所有业务应当全面停止工作，可保留部分紧急求助功能。 | -## subscribeThermalLevel +## thermal.subscribeThermalLevel subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void @@ -51,7 +51,7 @@ thermal.subscribeThermalLevel((lev) => { }) ``` -## unsubscribeThermalLevel +## thermal.unsubscribeThermalLevel unsubscribeThermalLevel(callback?: AsyncCallback): void @@ -61,19 +61,21 @@ unsubscribeThermalLevel(callback?: AsyncCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<void> | 是 | 指定的callback回调方法，无返回值。 | +| callback | AsyncCallback<void> | 可选 | 指定的callback回调方法，无返回值。 | **示例：** ``` -thermal.unsubscribeThermalLevel(); +thermal.unsubscribeThermalLevel(() => { + console.info("Unsubscribe completed."); +}); ``` -## unsubscribeThermalLevel +## thermal.getThermalLevel getThermalLevel(): ThermalLevel -订阅热档位变化时的回调提醒。 +获取当前热档位信息。 **返回值：** -- Gitee From 2871c9abb8c0c4a93407d798bfb0b4cc22ccbfdf Mon Sep 17 00:00:00 2001 From: q00569459 Date: Tue, 22 Feb 2022 14:36:57 +0800 Subject: [PATCH 3/4] Fix review Signed-off-by: q00569459 --- .../reference/apis/js-apis-thermal.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 46cf5b78d79..31ccdec9de6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -11,11 +11,6 @@ import thermal from '@ohos.thermal'; ``` -## 系统能力 - -SystemCapability.PowerManager.ThermalManager - - ## ThermalLevel 热档位信息。 @@ -37,6 +32,10 @@ subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void 订阅热档位变化时的回调提醒。 +## 系统能力： + +SystemCapability.PowerManager.ThermalManager + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -57,6 +56,10 @@ unsubscribeThermalLevel(callback?: AsyncCallback): void 订阅热档位变化时的回调提醒。 +## 系统能力： + +SystemCapability.PowerManager.ThermalManager + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -77,6 +80,10 @@ getThermalLevel(): ThermalLevel 获取当前热档位信息。 +## 系统能力： + +SystemCapability.PowerManager.ThermalManager + **返回值：** | 类型 | 说明 | -- Gitee From 8467739e707108875a7dfd08f7a454908ac27675 Mon Sep 17 00:00:00 2001 From: q00569459 Date: Tue, 22 Feb 2022 15:00:23 +0800 Subject: [PATCH 4/4] Fix reviewer Signed-off-by: q00569459 --- zh-cn/application-dev/reference/apis/js-apis-thermal.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-thermal.md b/zh-cn/application-dev/reference/apis/js-apis-thermal.md index 31ccdec9de6..5154348d097 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-thermal.md +++ b/zh-cn/application-dev/reference/apis/js-apis-thermal.md @@ -32,7 +32,7 @@ subscribeThermalLevel(callback: AsyncCallback<ThermalLevel>): void 订阅热档位变化时的回调提醒。 -## 系统能力： +**系统能力：** SystemCapability.PowerManager.ThermalManager @@ -54,9 +54,9 @@ thermal.subscribeThermalLevel((lev) => { unsubscribeThermalLevel(callback?: AsyncCallback): void -订阅热档位变化时的回调提醒。 +取消订阅热档位变化时的回调提醒。 -## 系统能力： +**系统能力：** SystemCapability.PowerManager.ThermalManager @@ -80,7 +80,7 @@ getThermalLevel(): ThermalLevel 获取当前热档位信息。 -## 系统能力： +**系统能力：** SystemCapability.PowerManager.ThermalManager -- Gitee