Mirrors
/
boltex_cordova-plugin-powermanagement
mirror of https://github.com/boltex/cordova-plugin-powermanagement.git
2
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #7 from Menardi/master

Browse Source 
Fixed #6, added ability to disable release on pause
pull/1/merge
Viras- 9 years ago
parent 2b6c92b0c4 5b32ddf7cd
commit 021369bc18
4 changed files with 108 additions and 40 deletions
Show Stats Download Patch File Download Diff File

41
README.md
Unescape Escape View File

@ -17,6 +17,47 @@ Install the plugin using the cordova command line utility:
`$ cordova plugin add https://github.com/Viras-/cordova-plugin-powermanagement.git` `$ cordova plugin add https://github.com/Viras-/cordova-plugin-powermanagement.git`
Usage
-----
### window.powerManagement.acquire(successCallback, failureCallback)
Acquire a wakelock by calling this.
window.powerManagement.acquire(function() {
console.log('Wakelock acquired');
}, function() {
console.log('Failed to acquire wakelock');
});
### window.powerManagement.dim(successCallback, failureCallback)
This acquires a partial wakelock, allowing the screen to be dimmed.
window.powerManagement.dim(function() {
console.log('Wakelock acquired');
}, function() {
console.log('Failed to acquire wakelock');
});
### window.powerManagement.release(successCallback, failureCallback)
Release the wakelock. It's important to do this when you're finished with the wakelock, to avoid unnecessary battery drain.
window.powerManagement.release(function() {
console.log('Wakelock released');
}, function() {
console.log('Failed to release wakelock');
});
### [Android Only] window.powerManagement.setReleaseOnPause(enabled, successCallback, failureCallback)
By default, the plugin will automatically release a wakelock when your app is paused (e.g. when the screen is turned off, or the user switches to another app). It will reacquire the wakelock upon app resume. If you would prefer to disable this behaviour, you can use this function.
window.powerManagement.setReleaseOnPause(false, function() {
console.log('Set successfully');
}, function() {
console.log('Failed to set');
});
Note that in all the above examples, all callbacks are optional.
License License
======= =======
Copyright 2013 Wolfgang Koller Copyright 2013 Wolfgang Koller

12
plugin.xml
Unescape Escape View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://cordova.apache.org/ns/plugins/1.0" <plugin xmlns="http://cordova.apache.org/ns/plugins/1.0"
id="at.gofg.sportscomputer.powermanagement" id="at.gofg.sportscomputer.powermanagement"
version="1.0.0"> version="1.1.0">
<name>PowerManagement</name> <name>PowerManagement</name>
<description>PowerManagement plugin for Cordova</description> <description>PowerManagement plugin for Cordova</description>
<license>Apache 2.0</license> <license>Apache 2.0</license>
@ -34,17 +34,17 @@
</platform> </platform>
<!-- ios --> <!-- ios -->
<platform name="ios"> <platform name="ios">
<config-file target="config.xml" parent="/widget"> <config-file target="config.xml" parent="/widget">
<feature name="PowerManagement"> <feature name="PowerManagement">
<param name="ios-package" value="PowerManagement" /> <param name="ios-package" value="PowerManagement" />
</feature> </feature>
</config-file> </config-file>
<header-file src="src/ios/PowerManagement.h" /> <header-file src="src/ios/PowerManagement.h" />
<source-file src="src/ios/PowerManagement.m" /> <source-file src="src/ios/PowerManagement.m" />
</platform> </platform>
<!-- android --> <!-- android -->
<platform name="android"> <platform name="android">
<config-file target="res/xml/config.xml" parent="/*"> <config-file target="res/xml/config.xml" parent="/*">

74
src/android/PowerManagement.java
Unescape Escape View File

@ -1,12 +1,12 @@
/* /*
* Copyright 2013-2014 Wolfgang Koller * Copyright 2013-2014 Wolfgang Koller
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -41,6 +41,7 @@ public class PowerManagement extends CordovaPlugin {
// As we only allow one wake-lock, we keep a reference to it here // As we only allow one wake-lock, we keep a reference to it here
private PowerManager.WakeLock wakeLock = null; private PowerManager.WakeLock wakeLock = null;
private PowerManager powerManager = null; private PowerManager powerManager = null;
private boolean releaseOnPause = true;
/** /**
* Fetch a reference to the power-service when the plugin is initialized * Fetch a reference to the power-service when the plugin is initialized
@ -48,10 +49,10 @@ public class PowerManagement extends CordovaPlugin {
@Override @Override
public void initialize(CordovaInterface cordova, CordovaWebView webView) { public void initialize(CordovaInterface cordova, CordovaWebView webView) {
super.initialize(cordova, webView); super.initialize(cordova, webView);
this.powerManager = (PowerManager) cordova.getActivity().getSystemService(Context.POWER_SERVICE); this.powerManager = (PowerManager) cordova.getActivity().getSystemService(Context.POWER_SERVICE);
} }
@Override @Override
public boolean execute(String action, JSONArray args, public boolean execute(String action, JSONArray args,
CallbackContext callbackContext) throws JSONException { CallbackContext callbackContext) throws JSONException {
@ -59,29 +60,35 @@ public class PowerManagement extends CordovaPlugin {
PluginResult result = null; PluginResult result = null;
Log.d("PowerManagementPlugin", "Plugin execute called - " + this.toString() ); Log.d("PowerManagementPlugin", "Plugin execute called - " + this.toString() );
Log.d("PowerManagementPlugin", "Action is " + action ); Log.d("PowerManagementPlugin", "Action is " + action );
try { try {
if( action.equals("acquire") ) { if( action.equals("acquire") ) {
if( args.length() > 0 && args.getBoolean(0) ) { if( args.length() > 0 && args.getBoolean(0) ) {
Log.d("PowerManagementPlugin", "Only dim lock" ); Log.d("PowerManagementPlugin", "Only dim lock" );
result = this.acquire( PowerManager.SCREEN_DIM_WAKE_LOCK ); result = this.acquire( PowerManager.SCREEN_DIM_WAKE_LOCK );
} }
else { else {
result = this.acquire( PowerManager.FULL_WAKE_LOCK ); result = this.acquire( PowerManager.FULL_WAKE_LOCK );
} }
} } else if( action.equals("release") ) {
else if( action.equals("release") ) {
result = this.release(); result = this.release();
} else if( action.equals("setReleaseOnPause") ) {
try {
this.releaseOnPause = args.getBoolean(0);
result = new PluginResult(PluginResult.Status.OK);
} catch (Exception e) {
result = new PluginResult(PluginResult.Status.ERROR, "Could not set releaseOnPause");
}
} }
} }
catch( JSONException e ) { catch( JSONException e ) {
result = new PluginResult(Status.JSON_EXCEPTION, e.getMessage()); result = new PluginResult(Status.JSON_EXCEPTION, e.getMessage());
} }
callbackContext.sendPluginResult(result); callbackContext.sendPluginResult(result);
return true; return true;
} }
/** /**
* Acquire a wake-lock * Acquire a wake-lock
* @param p_flags Type of wake-lock to acquire * @param p_flags Type of wake-lock to acquire
@ -89,7 +96,7 @@ public class PowerManagement extends CordovaPlugin {
*/ */
private PluginResult acquire( int p_flags ) { private PluginResult acquire( int p_flags ) {
PluginResult result = null; PluginResult result = null;
if (this.wakeLock == null) { if (this.wakeLock == null) {
this.wakeLock = this.powerManager.newWakeLock(p_flags, "PowerManagementPlugin"); this.wakeLock = this.powerManager.newWakeLock(p_flags, "PowerManagementPlugin");
try { try {
@ -104,46 +111,55 @@ public class PowerManagement extends CordovaPlugin {
else { else {
result = new PluginResult(PluginResult.Status.ILLEGAL_ACCESS_EXCEPTION,"WakeLock already active - release first"); result = new PluginResult(PluginResult.Status.ILLEGAL_ACCESS_EXCEPTION,"WakeLock already active - release first");
} }
return result; return result;
} }
/** /**
* Release an active wake-lock * Release an active wake-lock
* @return PluginResult containing the status of the release process * @return PluginResult containing the status of the release process
*/ */
private PluginResult release() { private PluginResult release() {
PluginResult result = null; PluginResult result = null;
if( this.wakeLock != null ) { if( this.wakeLock != null ) {
this.wakeLock.release(); try {
this.wakeLock.release();
result = new PluginResult(PluginResult.Status.OK, "OK");
}
catch (Exception e) {
result = new PluginResult(PluginResult.Status.ILLEGAL_ACCESS_EXCEPTION, "WakeLock already released");
}
this.wakeLock = null; this.wakeLock = null;
result = new PluginResult(PluginResult.Status.OK, "OK");
} }
else { else {
result = new PluginResult(PluginResult.Status.ILLEGAL_ACCESS_EXCEPTION, "No WakeLock active - acquire first"); result = new PluginResult(PluginResult.Status.ILLEGAL_ACCESS_EXCEPTION, "No WakeLock active - acquire first");
} }
return result; return result;
} }
/** /**
* Make sure any wakelock is released if the app goes into pause * Make sure any wakelock is released if the app goes into pause
*/ */
@Override @Override
public void onPause(boolean multitasking) { public void onPause(boolean multitasking) {
if( this.wakeLock != null ) this.wakeLock.release(); if( this.releaseOnPause && this.wakeLock != null ) {
this.wakeLock.release();
}
super.onPause(multitasking); super.onPause(multitasking);
} }
/** /**
* Make sure any wakelock is acquired again once we resume * Make sure any wakelock is acquired again once we resume
*/ */
@Override @Override
public void onResume(boolean multitasking) { public void onResume(boolean multitasking) {
if( this.wakeLock != null ) this.wakeLock.acquire(); if( this.releaseOnPause && this.wakeLock != null ) {
this.wakeLock.acquire();
}
super.onResume(multitasking); super.onResume(multitasking);
} }

21
www/powermanagement.js
Unescape Escape View File

@ -1,12 +1,12 @@
/* /*
* Copyright 2013 Wolfgang Koller * Copyright 2013 Wolfgang Koller
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -17,7 +17,7 @@ var PowerManagement = function() {};
/** /**
* Acquire a new wake-lock (keep device awake) * Acquire a new wake-lock (keep device awake)
* *
* @param successCallback function to be called when the wake-lock was acquired successfully * @param successCallback function to be called when the wake-lock was acquired successfully
* @param errorCallback function to be called when there was a problem with acquiring the wake-lock * @param errorCallback function to be called when there was a problem with acquiring the wake-lock
*/ */
@ -29,7 +29,7 @@ PowerManagement.prototype.acquire = function(successCallback,failureCallback, ru
/** /**
* Release the wake-lock * Release the wake-lock
* *
* @param successCallback function to be called when the wake-lock was released successfully * @param successCallback function to be called when the wake-lock was released successfully
* @param errorCallback function to be called when there was a problem while releasing the wake-lock * @param errorCallback function to be called when there was a problem while releasing the wake-lock
*/ */
@ -37,6 +37,17 @@ PowerManagement.prototype.release = function(successCallback,failureCallback) {
cordova.exec(successCallback, failureCallback, 'PowerManagement', 'release', []); cordova.exec(successCallback, failureCallback, 'PowerManagement', 'release', []);
} }
/**
* Enable or disable releasing of the wakelock on pause
*
* @param enabled boolean - true to enable releasing of wakelock on pause, or false to disable
* @param successCallback
* @param errorCallback
*/
PowerManagement.prototype.setReleaseOnPause = function(enabled, successCallback, failureCallback) {
cordova.exec(successCallback, failureCallback, 'PowerManagement', 'setReleaseOnPause', [enabled]);
}
/** /**
* Acquire a partial wake-lock, allowing the device to dim the screen * Acquire a partial wake-lock, allowing the device to dim the screen
* *

Write Preview
Loading…
Cancel
Save