Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 5.83 KB

README.md

File metadata and controls

139 lines (93 loc) · 5.83 KB
Raw

NPM version

This is a fork of the original plugin cordova-plugin-battery-status

cordova-plugin-battery-status

I dedicate a considerable amount of my free time to developing and maintaining many cordova plugins for the community (See the list with all my maintained plugins). To help ensure this plugin is kept updated, new features are added and bugfixes are implemented quickly, please donate a couple of dollars (or a little more if you can stretch) as this will help me to afford to dedicate time to its maintenance. Please consider donating if you're using this plugin in an app that makes you money, or if you're asking for new features or priority bug fixes. Thank you!

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

Android Testsuite Chrome Testsuite iOS Testsuite Lint Test

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 community-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) from version 2.1.0 (for Android only for now) we added the following:
    • chargeType: A string that indicates charging type. (string)
    • temperature: A number that indicates the battery temperature. (number)
    • technology: A string that indicates the battery technology. (string)
    • present: The scale of the battery (number)
    • voltageLevel: containing the current battery voltage level. (number)
    • currentBatteryHealth: a string indicates Health level. (string)

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)