apache/cordova-plugin-battery-status

Apache Cordova Battery Status Plugin

title	description
Battery Status	Get events for device battery level.

cordova-plugin-battery-status

This plugin provides an implementation of an old version of the Battery Status Events API. It adds the following three events to the window object:

• batterystatus
• batterycritical
• batterylow

Applications may use window.addEventListener to attach an event listener for any of the above events after the deviceready event fires.

Installation

cordova plugin add cordova-plugin-battery-status

Status object

All events in this plugin return an object with the following properties:

• level: The battery charge percentage (0-100). (Number)
• isPlugged: A boolean that indicates whether the device is plugged in. (Boolean)

batterystatus event

Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an object containing battery status.

Example

window.addEventListener("batterystatus", onBatteryStatus, false);

function onBatteryStatus(status) {
    console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
}

Supported Platforms

• iOS
• Android
• Browser (Chrome, Firefox, Opera)

Quirks: Android

Warning: the Android implementation is greedy and prolonged use will drain the device's battery.

batterylow event

Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an object containing battery status.

Example

window.addEventListener("batterylow", onBatteryLow, false);

function onBatteryLow(status) {
    alert("Battery Level Low " + status.level + "%");
}

Supported Platforms

• iOS
• Android
• Browser (Chrome, Firefox, Opera)

batterycritical event

Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an object containing battery status.

Example

window.addEventListener("batterycritical", onBatteryCritical, false);

function onBatteryCritical(status) {
    alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
}

Supported Platforms

• iOS
• Android
• Browser (Chrome, Firefox, Opera)

cordova-plugin-battery-status's Issues

this plugin not working in ios devices. is there any alternatives?

Bug Report

this plugin not working with capacitor in ios.

Problem

its works only in android not in ios

What is expected to happen?

on plug and unplug events should trigger

What does actually happen?

Information

Command or Code

Environment, Platform, Device

Version information

Checklist

• I searched for existing GitHub issues
• I updated all Cordova tooling to most recent version
• I included all the necessary information above

Browser implementation is broken

The browser implementation of this plugin uses navigator.getBattery:

https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getBattery

Obsolete
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Current Firefox and Edge don't support it, Chrome still seems to:
https://developer.mozilla.org/en-US/docs/Web/API/Battery_Status_API#Browser_compatibility

As far as I know there is no proper replacement.

in iOs isn't working properly

Bug Report

Problem

The plugging isn't working on iOS devices, the code haven't been update after 7 years

What is expected to happen?

Its suppose to show the battery status

What does actually happen?

Doesn't show anything, no even a simple console log in the function

Information

node v12.16.1
npm 6.13.4
ionic CLI 6.0.2

Command or Code

here my simple code
this.batteryStatus.onChange().subscribe(status => {
console.log("Estado Bateria");
console.log(status.level, status.isPlugged);
this.batteryText = status.level;
this.cdr.detectChanges();
});

Environment, Platform, Device

• [X ] I searched for existing GitHub issues
• [ X] I updated all Cordova tooling to most recent version
• [ X] I included all the necessary information above

Conflicts with cordova-plugin-firebase

In our Ionic project after installing cordova-plugin-firebase the battery-status loses its functionality.
But when we remove cordova-plugin-firebase it work fine.

Will be appreciated if you can help in this regard.

more info :
cordova -v -> 8.0.0

New Maintained Repo for this plugin - please move

Instead of maintaining this plugin only for me, I published a new maintained plugin called "community-cordova-plugin-battery-status" (https://github.com/EYALIN/community-cordova-plugin-battery-status) which is maintained and will keep being.
please feel free to use it, and write me any feedback.
can be installed by using "cordova plugin add community-cordova-plugin-battery-status"
all Android and IOS recent issues are fixed there.

Android version update ERROR

We get this error below after started to use Android 7.x. We read the documentation (https://cordova.apache.org/announcements/2017/12/04/cordova-android-7.0.0.html) bu we still have no solution. Can you help us, please ?

Installing "cordova-plugin-battery-status" for android
Failed to install 'cordova-plugin-battery-status': Error: ENOENT: no such file or directory, open '/Users/apple/Desktop/simplyPOD/platforms/android/AndroidManifest.xml'

Determine which event is fired

I want to check when the device is plugged in. Is there a way to check if the fired event is because of a level change or the plugging in?

Community update available - New maintained plugin

unfortunately, this plugin creator @apache , did fantastic work, and we highly appreciate him not maintaining this plugin anymore (not responding for a while).
we moved to a maintained plugin (which forked from this one) to here:
https://github.com/EYALIN/community-cordova-plugin-battery-status

you can install it as an npm package:
cordova plugin add community-cordova-plugin-battery-status --save