文档管理中心
您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明
开发与测试开放能力API系统基础功能Basic Services Kit(基础服务)ArkTS API已停止维护的接口@system.battery (电量信息)

@system.battery (电量信息)

Wearable18+Lite Wearable12+

该模块提供充电状态及剩余电量的查询功能。

说明
  • 模块维护策略:

    - 对于Lite Wearable设备类型,该模块长期维护,正常使用。

    - 对于支持该模块的其他设备类型,该模块从API Version 6开始不再维护,建议使用@ohos.batteryInfo替代。

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

导入模块

收起
自动换行
深色代码主题
复制
  1. import {Battery, BatteryResponse } from '@kit.BasicServicesKit';

Battery.getStatus(deprecated)

Wearable18+Lite Wearable12+

getStatus(options?: GetStatusOptions): void;

获取设备当前的充电状态及剩余电量。

系统能力: SystemCapability.PowerManager.BatteryManager.Lite

参数:

展开
参数名 类型 必填 说明
options GetStatusOptions 包含接口调用结果的对象。可选,默认为空。

示例:

ArkTS示例:

收起
自动换行
深色代码主题
复制
  1. Battery.getStatus({
  2. success: (data: BatteryResponse) => {
  3. console.info('success get battery level:' + data.level);
  4. },
  5. fail: (data: string, code: number) => {
  6. console.error('fail to get battery level code:' + code + ', data: ' + data);
  7. }
  8. });

JS示例:

收起
自动换行
深色代码主题
复制
  1. <!-- xxx.hml -->
  2. <div class="container">
  3. <input type="button" value="Get Data" style="width: 240px; height: 50px; margin: 5px;" onclick="getBatteryInfo"></input>
  4. <text class="title">level: {{ capacity }}</text>
  5. <text class="title">charging: {{ charging }}</text>
  6. </div>
收起
自动换行
深色代码主题
复制
  1. /* xxx.css */
  2. .container {
  3. width: 100%;
  4. height: 100%;
  5. justify-content: center;
  6. align-items: center;
  7. flex-direction: column;
  8. }
  9. .title {
  10. width: 200px;
  11. font-size: 30px;
  12. text-align: center;
  13. }
收起
自动换行
深色代码主题
复制
  1. // xxx.js
  2. import Battery from '@system.battery';
  3. export default {
  4. data: {
  5. capacity: '',
  6. charging: ''
  7. },
  8. getBatteryInfo() {
  9. let TAG = 'get_status_success_test';
  10. Battery.getStatus({
  11. success: (batteryResponse) => {
  12. this.capacity = batteryResponse.level;
  13. this.charging = batteryResponse.charging;
  14. console.info(`${TAG} batteryResponse.level: ${batteryResponse.level}`);
  15. console.info(`${TAG} batteryResponse.charging: ${batteryResponse.charging}`);
  16. },
  17. fail: (data, code) => {
  18. console.error(`${TAG} fail data: ${data}, code: ${code}`);
  19. },
  20. complete: () => {
  21. console.info(`${TAG} getStatus complete`);
  22. }
  23. });
  24. },
  25. }

GetStatusOptions(deprecated)

Wearable18+Lite Wearable12+

包含接口调用结果的对象。

系统能力: SystemCapability.PowerManager.BatteryManager.Lite

展开
参数名 类型 必填 说明
success (data: BatteryResponse) => void 接口调用成功的回调函数,data为BatteryResponse类型的返回值。
fail (data: string, code: number) => void 接口调用失败的回调函数。data为错误信息,code为错误码。
complete () => void 接口调用结束的回调函数。

BatteryResponse(deprecated)

包含充电状态及剩余电量的对象。

系统能力: SystemCapability.PowerManager.BatteryManager.Lite

展开
名称 类型 只读 可选 说明
charging boolean

当前电池是否在充电中。true表示在充电,false表示没有充电,默认为false。

说明: 除Lite Wearable外,从API Version 6开始不再维护,建议使用batteryInfo.chargingStatus替代。

level number

当前电池的电量百分比,取值范围:0.00~1.00

说明: 除Lite Wearable外,从API Version 6开始不再维护,建议使用batteryInfo.batterySOC替代。

在 开发与测试 开放能力API 中进行搜索
请输入您想要搜索的关键词