https://github.com/davepartner/battery
Monitors phone battery
https://github.com/davepartner/battery
Last synced: over 1 year ago
JSON representation
Monitors phone battery
- Host: GitHub
- URL: https://github.com/davepartner/battery
- Owner: davepartner
- License: apache-2.0
- Created: 2016-03-07T14:13:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-31T19:48:34.000Z (about 10 years ago)
- Last Synced: 2025-01-08T16:22:53.677Z (over 1 year ago)
- Language: JavaScript
- Size: 12.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/apache/cordova-plugin-battery-status)
# cordova-plugin-battery-status
This plugin provides an implementation of an old version of the [Battery Status Events API][w3c_spec]. 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][status_object] containing battery status.
### Example
window.addEventListener("batterystatus", onBatteryStatus, false);
function onBatteryStatus(status) {
console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
}
### Supported Platforms
- Amazon Fire OS
- iOS
- Android
- BlackBerry 10
- Windows Phone 7 and 8
- Windows (Windows Phone 8.1 only)
- Firefox OS
- Browser (Chrome, Firefox, Opera)
### Quirks: Android & Amazon Fire OS
**Warning**: the Android and Fire OS implementations are greedy and prolonged use will drain the device's battery.
### Quirks: Windows Phone 7 & Windows Phone 8
The `level` property is _not_ supported on Windows Phone 7 because the OS does not provide native APIs to determine battery level. The `isPlugged` parameter _is_ supported.
### Quirks: Windows Phone 8.1
The `isPlugged` parameter is _not_ supported on Windows Phone 8.1. The `level` parameter _is_ supported.
## batterylow event
Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
### Example
window.addEventListener("batterylow", onBatteryLow, false);
function onBatteryLow(status) {
alert("Battery Level Low " + status.level + "%");
}
### Supported Platforms
- Amazon Fire OS
- iOS
- Android
- BlackBerry 10
- Firefox OS
- Windows (Windows Phone 8.1 only)
- Browser (Chrome, Firefox, Opera)
### Quirks: Windows Phone 8.1
The `batterylow` event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
## batterycritical event
Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.
### Example
window.addEventListener("batterycritical", onBatteryCritical, false);
function onBatteryCritical(status) {
alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
}
### Supported Platforms
- Amazon Fire OS
- iOS
- Android
- BlackBerry 10
- Firefox OS
- Windows (Windows Phone 8.1 only)
- Browser (Chrome, Firefox, Opera)
### Quirks: Windows Phone 8.1
The `batterycritical` event fires on Windows Phone 8.1 irrespective of whether the device is plugged in or not. This happens because the OS does not provide an API to detect whether the device is plugged in.
[w3c_spec]: http://www.w3.org/TR/2011/WD-battery-status-20110915/
[status_object]: #status-object