Compare commits

...

24 Commits
dev ... master

Author SHA1 Message Date
9bfaf229e2 Pull bugfix from https://github.com/Sitronik/cordova-plugin-powermanagement2 2023-06-29 02:46:09 -06:00
16d2a37237 Bump version 2023-06-29 02:17:57 -06:00
6118ea1c13 Update plugin.xml 2023-06-29 02:17:18 -06:00
2c6d9227c5 Update version 2023-06-21 22:00:13 -06:00
ca5b6f01ef Update package.json 2023-06-21 21:59:18 -06:00
Denis
f989948aac .. 2021-08-29 17:32:09 +03:00
Denis
ffd2783187
fix No visible @interface 2021-08-29 17:25:19 +03:00
Denis
dc8a177e15
update readme 2021-08-27 22:10:56 +03:00
Denis
71695ca851 fix 2021-08-27 22:01:37 +03:00
1cca6de3d8 Update plugin ID 2019-09-11 23:11:09 -06:00
7b669bd0d4 Update plugin ID 2019-09-11 23:10:29 -06:00
boltex
dd5b6d7dcc Added support for android 6+ (sdk 23 +) by setting visibility every 10 seconds to support GPS while in background and preventing idle mode. 2018-09-13 09:30:43 -04:00
Felix
94cade84fa Create package.json 2017-06-16 14:14:08 -04:00
Felix
32abd15d9a Update README.md 2015-06-05 14:54:32 -04:00
Felix
5972eacb6d changed SCREEN_DIM_WAKE_LOCK to PARTIAL_WAKE_LOCK 2015-06-05 14:53:15 -04:00
Viras-
021369bc18 Merge pull request #7 from Menardi/master
Fixed #6, added ability to disable release on pause
2015-05-23 11:37:15 +02:00
Gearóid Moroney
5b32ddf7cd Added ability to disable release on pause (Android), and added usage to readme
I've added a function for Android to allow the disabling of wakelock release
on pause. This is for my use case where the screen will be off most of the
time the wakelock is enabled. I added usage for it to the readme, along with
the existing functions.
2015-04-06 11:24:07 +01:00
Gearóid Moroney
317a3ccbf3 Fixed #6 Underlocking causing crashes on Android
I fixed this as per the solution in the issue, by surrounding the release
with a try / catch block
2015-04-06 11:22:05 +01:00
Viras-
2b6c92b0c4 Merge pull request #5 from kubkov/patch-1
Update plugin.xml
2014-02-25 14:20:59 +01:00
kubkov
ffc4de1b88 Update plugin.xml 2014-01-21 15:04:17 +01:00
Viras-
5e17fa1dc3 Finish Release-1 2014-01-19 20:04:13 +01:00
Viras-
8b0c68770f updating plugin configuration for Android 2014-01-19 20:04:00 +01:00
Viras-
84e0cfe9b3 Release v1.0.0 2013-11-25 18:19:46 +01:00
Viras-
19af5c6361 Release v1.0.0 2013-11-25 18:05:52 +01:00
7 changed files with 219 additions and 81 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.idea

View File

@ -2,6 +2,9 @@ PowerManagement
=============== ===============
Plugin for Cordova (3.0+) Plugin for Cordova (3.0+)
changed SCREEN_DIM_WAKE_LOCK to PARTIAL_WAKE_LOCK
=================================================
The PowerManagement plugin offers access to the devices power-management functionality. The PowerManagement plugin offers access to the devices power-management functionality.
It should be used for applications which keep running for a long time without any user interaction. It should be used for applications which keep running for a long time without any user interaction.
@ -15,7 +18,53 @@ Installation
--------- ---------
Install the plugin using the cordova command line utility: 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/boltex/cordova-plugin-powermanagement.git`
OR
---
`npm i cordova-plugin-powermanagement2`
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
======= =======

24
package.json Normal file
View File

@ -0,0 +1,24 @@
{
"name": "@netsyms/cordova-plugin-powermanagement",
"version": "1.1.3",
"description": "Plugin for managing the power state (i.e. idle switching) for cordova",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://source.netsyms.com/Netsyms/cordova-plugin-powermanagement.git"
},
"contributors": ["Netsyms Technologies", "Viras-", "Sitronik"],
"license": "Apache-2.0",
"bugs": {
"url": "https://source.netsyms.com/Netsyms/cordova-plugin-powermanagement/issues"
},
"homepage": "https://source.netsyms.com/Netsyms/cordova-plugin-powermanagement#readme",
"keywords": [
"ecosystem:cordova",
"cordova-android",
"cordova-ios"
],
"main": "index.js"
}

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="@netsyms/cordova-plugin-powermanagement"
version="1.0.0"> version="1.1.3">
<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>
@ -49,7 +49,7 @@
<platform name="android"> <platform name="android">
<config-file target="res/xml/config.xml" parent="/*"> <config-file target="res/xml/config.xml" parent="/*">
<feature name="PowerManagement" > <feature name="PowerManagement" >
<param name="android-package" value="org.apache.cordova.plugin.PowerManagement"/> <param name="android-package" value="org.apache.cordova.powermanagement.PowerManagement"/>
</feature> </feature>
</config-file> </config-file>
@ -57,6 +57,6 @@
<uses-permission android:name="android.permission.WAKE_LOCK" /> <uses-permission android:name="android.permission.WAKE_LOCK" />
</config-file> </config-file>
<source-file src="src/android/PowerManagement.java" target-dir="src/at/gofg/sportscomputer/" /> <source-file src="src/android/PowerManagement.java" target-dir="src/org/apache/cordova/powermanagement" />
</platform> </platform>
</plugin> </plugin>

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2013 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.
@ -18,13 +18,20 @@
* Cordova (Android) plugin for accessing the power-management functions of the device * Cordova (Android) plugin for accessing the power-management functions of the device
* @author Wolfgang Koller <viras@users.sourceforge.net> * @author Wolfgang Koller <viras@users.sourceforge.net>
*/ */
package at.gofg.sportscomputer; package org.apache.cordova.powermanagement;
import org.json.JSONArray; import org.json.JSONArray;
import org.json.JSONException; import org.json.JSONException;
import android.content.Context; import android.content.Context;
import android.os.PowerManager; import android.os.PowerManager;
import android.os.Build;
import android.os.Handler;
import android.app.PendingIntent;
import android.content.Intent;
import java.lang.Runnable;
import android.view.View;
import android.util.Log; import android.util.Log;
import org.apache.cordova.CordovaWebView; import org.apache.cordova.CordovaWebView;
@ -41,15 +48,67 @@ 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;
private Handler handler;
private PendingIntent wakeupIntent;
private CordovaWebView webView;
private final Runnable heartbeat = new Runnable() {
public void run() {
try {
//Log.d("PowerManagementPlugin", "About to declare ourselves VISIBLE");
webView.getView().dispatchWindowVisibilityChanged(View.VISIBLE);
// if sdk is 23 (android 6) or greater
if(android.os.Build.VERSION.SDK_INT > 22){
if (wakeLock != null && powerManager != null && powerManager.isDeviceIdleMode()) {
//Log.d("PowerManagementPlugin", "Poking location service");
try {
wakeupIntent.send();
} catch (SecurityException e) {
Log.d("PowerManagementPlugin", "SecurityException : Heartbeat location manager keep-alive failed");
} catch (PendingIntent.CanceledException e) {
Log.d("PowerManagementPlugin", "PendingIntent.CanceledException : Heartbeat location manager keep-alive failed");
}
}
}
} finally {
if (handler != null) {
handler.postDelayed(this, 10000);
}
}
}
};
/** /**
* Fetch a reference to the power-service when the plugin is initialized * Fetch a reference to the power-service when the plugin is initialized
*/ */
@Override @Override
public void initialize(CordovaInterface cordova, CordovaWebView webView) { public void initialize(CordovaInterface cordova, CordovaWebView webViewPara) {
super.initialize(cordova, webView);
Context context = cordova.getActivity().getApplicationContext();
this.webView = webViewPara;
super.initialize(cordova, webViewPara);
this.powerManager = (PowerManager) cordova.getActivity().getSystemService(Context.POWER_SERVICE); this.powerManager = (PowerManager) cordova.getActivity().getSystemService(Context.POWER_SERVICE);
handler = new Handler();
wakeupIntent = PendingIntent.getBroadcast( context , 0,
new Intent("com.android.internal.location.ALARM_WAKEUP"), 0);
}
public PluginResult partialWakeLock() {
Log.d("PowerManagementPlugin", "Partial wake lock" );
PluginResult result = this.acquire( PowerManager.PARTIAL_WAKE_LOCK );
handler.postDelayed(heartbeat, 10000);
return result;
} }
@Override @Override
@ -63,15 +122,19 @@ public class PowerManagement extends CordovaPlugin {
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" ); result = partialWakeLock();
result = this.acquire( PowerManager.SCREEN_DIM_WAKE_LOCK ); } else {
result = partialWakeLock();
} }
else { } else if( action.equals("release") ) {
result = this.acquire( PowerManager.FULL_WAKE_LOCK );
}
}
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 ) {
@ -116,11 +179,16 @@ public class PowerManagement extends CordovaPlugin {
PluginResult result = null; PluginResult result = null;
if( this.wakeLock != null ) { if( this.wakeLock != null ) {
try {
this.wakeLock.release(); this.wakeLock.release();
this.wakeLock = null;
result = new PluginResult(PluginResult.Status.OK, "OK"); result = new PluginResult(PluginResult.Status.OK, "OK");
} }
catch (Exception e) {
result = new PluginResult(PluginResult.Status.ILLEGAL_ACCESS_EXCEPTION, "WakeLock already released");
}
this.wakeLock = null;
}
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");
} }
@ -133,7 +201,9 @@ public class PowerManagement extends CordovaPlugin {
*/ */
@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);
} }
@ -143,7 +213,9 @@ public class PowerManagement extends CordovaPlugin {
*/ */
@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);
} }

View File

@ -25,48 +25,29 @@
@implementation PowerManagement @implementation PowerManagement
- (void) acquire:(CDVInvokedUrlCommand*)command - (void) acquire:(CDVInvokedUrlCommand*)command
{ {
CDVPluginResult* result = nil;
NSString* jsString = nil;
NSString* callbackId = command.callbackId;
// Acquire a reference to the local UIApplication singleton // Acquire a reference to the local UIApplication singleton
UIApplication* app = [UIApplication sharedApplication]; UIApplication* app = [UIApplication sharedApplication];
CDVPluginResult *pluginResult = nil;
if( ![app isIdleTimerDisabled] ) { if( ![app isIdleTimerDisabled] ) {
[app setIdleTimerDisabled:true]; [app setIdleTimerDisabled:true];
result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
jsString = [result toSuccessCallbackString:callbackId];
} }
else { pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ILLEGAL_ACCESS_EXCEPTION messageAsString:@"IdleTimer already disabled"]; [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
jsString = [result toErrorCallbackString:callbackId];
}
[self writeJavascript:jsString];
} }
- (void) release:(CDVInvokedUrlCommand*)command - (void) release:(CDVInvokedUrlCommand*)command
{ {
CDVPluginResult* result = nil;
NSString* jsString = nil;
NSString* callbackId = command.callbackId;
// Acquire a reference to the local UIApplication singleton // Acquire a reference to the local UIApplication singleton
UIApplication* app = [UIApplication sharedApplication]; UIApplication* app = [UIApplication sharedApplication];
CDVPluginResult *pluginResult = nil;
if( [app isIdleTimerDisabled] ) { if( [app isIdleTimerDisabled] ) {
[app setIdleTimerDisabled:false]; [app setIdleTimerDisabled:false];
result = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
jsString = [result toSuccessCallbackString:callbackId];
} }
else { pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK];
result = [CDVPluginResult resultWithStatus:CDVCommandStatus_ILLEGAL_ACCESS_EXCEPTION messageAsString:@"IdleTimer not disabled"]; [self.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
jsString = [result toErrorCallbackString:callbackId];
}
[self writeJavascript:jsString];
} }
@end @end

View File

@ -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
* *