Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 c809c2d2 编写于 作者: A aqxyjay
浏览文件
操作

doc: add battery and power api reference for api 9 

Signed-off-by: Naqxyjay <zhangchunxin@huawei.com>
上级 710a7c17
隐藏空白更改
内联 并排
Showing with 260 addition and 30 deletion
zh-cn/application-dev/reference/apis/js-apis-battery-info.md
浏览文件 @ c809c2d2
# 电量信息
该模块主要提供电池状态和充放电状态的查询接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块主要提供电池状态和充放电状态的查询接口。
## 导入模块
......@@ -12,24 +12,27 @@
import batteryInfo from '@ohos.batteryInfo';
```
## 系统能力
SystemCapability.PowerManager.BatteryManager.Core
## 属性
描述电池信息。
| 名称 | 类型 | 可读 | 可写 | 描述 |
| ----------------------------- | ---------------------------------------- | ---- | ---- | --------------------- |
| batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 |
| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 |
| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 |
| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 |
| voltage | number | 是 | 否 | 表示当前设备电池的电压，单位微伏。 |
| technology | string | 是 | 否 | 表示当前设备电池的技术型号。 |
| batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度，单位0.1摄氏度。 |
| isBatteryPresent<sup>7+</sup> | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 类型 | 可读 | 可写 | 描述 |
| ----------------------------------------- | ---------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| batterySOC | number | 是 | 否 | 表示当前设备剩余电池电量百分比。 |
| chargingStatus | [BatteryChargeState](#batterychargestate) | 是 | 否 | 表示当前设备电池的充电状态。 |
| healthStatus | [BatteryHealthState](#batteryhealthstate) | 是 | 否 | 表示当前设备电池的健康状态。 |
| pluggedType | [BatteryPluggedType](#batterypluggedtype) | 是 | 否 | 表示当前设备连接的充电器类型。 |
| voltage | number | 是 | 否 | 表示当前设备电池的电压，单位微伏。 |
| technology | string | 是 | 否 | 表示当前设备电池的技术型号。 |
| batteryTemperature | number | 是 | 否 | 表示当前设备电池的温度，单位0.1摄氏度。 |
| isBatteryPresent<sup>7+</sup> | boolean | 是 | 否 | 表示当前设备是否支持电池或者电池是否在位。 |
| batteryCapacityLevel<sup>9+</sup> | [BatteryCapacityLevel](#batterycapacitylevel9) | 是 | 否 | 表示当前设备电池电量的等级。 |
| estimatedRemainingChargeTime<sup>9+</sup> | number | 是 | 否 | 表示当前设备充满电的预估时间，单位毫秒。 |
| totalEnergy<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的总容量，单位毫安时。此接口为系统接口，三方应用不支持调用。 |
| nowCurrent<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的电流，单位毫安。此接口为系统接口，三方应用不支持调用。 |
| remainingEnergy<sup>9+</sup> | number | 是 | 否 | 表示当前设备电池的剩余容量，单位毫安时。此接口为系统接口，三方应用不支持调用。 |
- 示例：
```js
......@@ -42,6 +45,8 @@ SystemCapability.PowerManager.BatteryManager.Core
表示连接的充电器类型的枚举。
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 默认值 | 描述 |
| -------- | ---- | ----------------- |
......@@ -55,6 +60,8 @@ SystemCapability.PowerManager.BatteryManager.Core
表示电池充电状态的枚举。
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 默认值 | 描述 |
| ------- | ---- | --------------- |
......@@ -66,7 +73,9 @@ SystemCapability.PowerManager.BatteryManager.Core
## BatteryHealthState
表示电池的健康状态的枚举。
表示电池健康状态的枚举。
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 默认值 | 描述 |
......@@ -77,3 +86,41 @@ SystemCapability.PowerManager.BatteryManager.Core
| OVERVOLTAGE | 3 | 表示电池健康状态为过压。 |
| COLD | 4 | 表示电池健康状态为低温。 |
| DEAD | 5 | 表示电池健康状态为僵死状态。 |
## BatteryCapacityLevel<sup>9+</sup>
表示电池电量等级的枚举。
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 默认值 | 描述 |
| -------------- | ------ | ---------------------------- |
| LEVEL_NONE | 0 | 表示电池电量等级未知。 |
| LEVEL_FULL | 1 | 表示电池电量等级为满电量。 |
| LEVEL_HIGH | 2 | 表示电池电量等级为高电量。 |
| LEVEL_NORMAL | 3 | 表示电池电量等级为正常电量。 |
| LEVEL_LOW | 4 | 表示电池电量等级为低电量。 |
| LEVEL_CRITICAL | 5 | 表示电池电量等级为极低电量。 |
## CommonEventBatteryChangedCode<sup>9+</sup>
表示COMMON_EVENT_BATTERY_CHANGED通用事件的键代码。
**系统能力**：SystemCapability.PowerManager.BatteryManager.Core
| 名称 | 默认值 | 描述 |
| -------------------- | ------ | -------------------------------------------------- |
| EXTRA_SOC | 0 | 表示剩余电池电量百分比的键代码。 |
| EXTRA_VOLTAGE | 1 | 表示当前设备电池电压的键代码。 |
| EXTRA_TEMPERATURE | 2 | 表示当前设备电池温度的键代码。 |
| EXTRA_HEALTH_STATE | 3 | 表示当前设备电池健康状态的键代码。 |
| EXTRA_PLUGGED_TYPE | 4 | 表示当前设备连接的充电器类型的键代码。 |
| EXTRA_MAX_CURRENT | 5 | 表示当前设备电池最大电流的键代码。 |
| EXTRA_MAX_VOLTAGE | 6 | 表示当前设备电池最大电压的键代码。 |
| EXTRA_CHARGE_STATE | 7 | 表示当前设备电池充电状态的键代码。 |
| EXTRA_CHARGE_COUNTER | 8 | 表示当前设备电池充电次数的键代码。 |
| EXTRA_PRESENT | 9 | 表示当前设备是否支持电池或者电池是否在位的键代码。 |
| EXTRA_TECHNOLOGY | 10 | 表示当前设备电池技术型号的键代码。 |
zh-cn/application-dev/reference/apis/js-apis-brightness.md
浏览文件 @ c809c2d2
# 屏幕亮度
该模块提供屏幕亮度的设置接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块提供屏幕亮度的设置接口。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-power.md
浏览文件 @ c809c2d2
# 系统电源管理
该模块主要提供重启、关机、查询屏幕状态等接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块主要提供重启、关机、查询屏幕状态等接口。
## 导入模块
......@@ -12,10 +12,6 @@
import power from '@ohos.power';
```
## 系统能力
SystemCapability.PowerManager.PowerManager.Core
## power.shutdownDevice
......@@ -27,6 +23,8 @@ shutdownDevice(reason: string): void
**需要权限：** ohos.permission.REBOOT
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -47,7 +45,9 @@ rebootDevice(reason: string): void
重启设备。
**需要权限：** ohos.permission.REBOOT（重启权限）、ohos.permission.REBOOT_RECOVERY（重启并进入recovery或者updater模式的权限）
**需要权限：** ohos.permission.REBOOT
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
......@@ -69,6 +69,8 @@ isScreenOn(callback: AsyncCallback&lt;boolean&gt;): void
检测当前设备的亮灭屏状态。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -94,6 +96,8 @@ isScreenOn(): Promise&lt;boolean&gt;
检测当前设备的亮灭屏状态。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**返回值：**
| 类型 | 说明 |
| ---------------------- | --------------------------------------- |
......@@ -110,3 +114,182 @@ power.isScreenOn()
console.log('error: ' + error);
})
```
## power.wakeupDevice<sup>9+</sup>
wakeupDevice(detail: string): void
唤醒设备。
此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| detail | string | 是 | 唤醒原因。 |
**示例：**
```js
power.wakeupDevice("application");
console.info('power_wakeup_device_test success')
```
## power.suspendDevice<sup>9+</sup>
suspendDevice(): void
休眠设备。
此接口为系统接口，三方应用不支持调用。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**示例：**
```js
power.suspendDevice();
console.info('power_suspend_device_test success')
```
## power.getPowerMode<sup>9+</sup>
getPowerMode(callback: AsyncCallback&lt;DevicePowerMode&gt;): void
获取当前设备的电源模式。
**需要权限：** ohos.permission.POWER_OPTIMIZATION
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;DevicePowerMode&gt; | 是 | 指定的callback回调方法，用于获取返回值。<br/>callback返回值：[DevicePowerMode](#devicepowermode9)。 |
**示例：**
```js
power.getPowerMode((error, mode) => {
if (typeof error === "undefined") {
console.info('power mode is ' + mode);
} else {
console.log('error: ' + error);
}
})
```
## power.getPowerMode<sup>9+</sup>
getPowerMode(): Promise&lt;DevicePowerMode&gt;
获取当前设备的电源模式。
**需要权限：** ohos.permission.POWER_OPTIMIZATION
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**返回值：**
| 类型 | 说明 |
| ------------------------------ | ------------------------------------------------------------ |
| Promise&lt;DevicePowerMode&gt; | Promise实例，用于异步获取返回值，[DevicePowerMode](#devicepowermode9)。 |
**示例：**
```js
power.getPowerMode()
.then(mode => {
console.info('power mode is ' + mode);
})
.catch(error => {
console.log('error: ' + error);
})
```
## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode, callback: AsyncCallback&lt;void&gt;): void
设置当前设备的电源模式。
此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.POWER_OPTIMIZATION
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ |
| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定的callback回调方法。 |
**示例：**
```js
power.setPowerMode(DevicePowerMode.MODE_PERFORMANCE, error => {
if (typeof error === "undefined") {
console.info('set power mode to MODE_PERFORMANCE');
} else {
console.log('error: ' + error);
}
})
```
## power.setPowerMode<sup>9+</sup>
setPowerMode(mode: DevicePowerMode): Promise&lt;void&gt;
设置当前设备的电源模式。
此接口为系统接口，三方应用不支持调用。
**需要权限：** ohos.permission.POWER_OPTIMIZATION
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------------------------ | ---- | ---------- |
| mode | [DevicePowerMode](#devicepowermode9) | 是 | 电源模式。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------- |
| Promise&lt;void&gt; | Promise实例。 |
**示例：**
```js
power.setPowerMode(DevicePowerMode.MODE_PERFORMANCE)
.then(() => {
console.info('set power mode to MODE_PERFORMANCE');
})
.catch(error => {
console.log('error: ' + error);
})
```
## DevicePowerMode<sup>9+</sup>
表示电源模式的枚举值。
**系统能力：** SystemCapability.PowerManager.PowerManager.Core
| 名称 | 默认值 | 描述 |
| ----------------------- | ------ | ---------------------- |
| MODE_NORMAL | 600 | 表示标准模式，默认值。 |
| MODE_POWER_SAVE | 601 | 表示省电模式。 |
| MODE_PERFORMANCE | 602 | 表示性能模式。 |
| MODE_EXTREME_POWER_SAVE | 603 | 表示超级省电模式。 |
zh-cn/application-dev/reference/apis/js-apis-runninglock.md
浏览文件 @ c809c2d2
# Runninglock锁
该模块主要提供Runninglock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块主要提供Runninglock锁相关操作的接口，包括创建、查询、持锁、释放锁等操作。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-thermal.md
浏览文件 @ c809c2d2
# 热管理
该模块提供热管理相关的接口，包括热档位查询及注册回调等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块提供热管理相关的接口，包括热档位查询及注册回调等功能。
## 导入模块
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或