Apache Cordova Plugin battery-status

Clone this repo:
  1. 0c84220 ci(appveyor): remove node 6, add node 12 by Jan Piotrowski · 5 months ago master
  2. 5a73933 ci(travis): upgrade to node 8 by Jan Piotrowski · 5 months ago
  3. 66f0a73 chore(release): 2.0.4-dev by Jan Piotrowski · 6 months ago
  4. 93d27ca chore(release): 2.0.3 (version string) by Jan Piotrowski · 6 months ago 2.0.3 rel/2.0.3
  5. 68bbd22 chore(release): release notes for 2.0.3 by Jan Piotrowski · 6 months ago

title: Battery Status description: Get events for device battery level.

|AppVeyor|Travis CI| |:-:|:-:| |Build status|Build Status|

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
  • Windows
  • 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
  • Windows
  • 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
  • Windows
  • Browser (Chrome, Firefox, Opera)