Merge pull request #9 from holzgeist/feat-add-proximity-screen-off

Feat add proximity screen off

Author: jeremyko

README.md

@@ -34,5 +34,8 @@ Regarding permissions, you may need the following settings in your `AndroidManif
     <uses-permission android:name="android.hardware.sensor.proximity"/>
     <uses-permission android:name="android.permission.BODY_SENSORS_BACKGROUND"/>
     <uses-permission android:name="android.permission.ACTIVITY_RECOGNITION"/>
+    <uses-permission android:name="android.permission.WAKE_LOCK"/>
+
+NB: the WAKE_LOCK permission is only needed if you run `setProximityScreenOff(true)` before listening to events
 
 **Some recent devices use virtual proximity sensors. There are no physical sensors. I found it hard to trust the sensor information in this case.**

android/src/main/AndroidManifest.xml

@@ -3,4 +3,5 @@
    <uses-permission android:name="android.hardware.sensor.proximity"/>
    <uses-permission android:name="android.permission.BODY_SENSORS_BACKGROUND"/>
    <uses-permission android:name="android.permission.ACTIVITY_RECOGNITION"/>
+   <uses-permission android:name="android.permission.WAKE_LOCK"/>
 </manifest>

android/src/main/kotlin/dev/jeremyko/proximity_sensor/ProximitySensorPlugin.kt

@@ -1,24 +1,42 @@
 
 package dev.jeremyko.proximity_sensor
 
-import androidx.annotation.NonNull
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.plugin.common.EventChannel
+import io.flutter.plugin.common.MethodCall
+import io.flutter.plugin.common.MethodChannel
+import io.flutter.plugin.common.MethodChannel.MethodCallHandler
+import io.flutter.plugin.common.MethodChannel.Result
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
-class ProximitySensorPlugin: FlutterPlugin  {
-  private lateinit var channel : EventChannel
+class ProximitySensorPlugin: FlutterPlugin, MethodCallHandler  {
+  private lateinit var methodChannel: MethodChannel
+  private lateinit var eventChannel : EventChannel
   private lateinit var streamHandler : ProximityStreamHandler
 
-  override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
-    channel = EventChannel(flutterPluginBinding.binaryMessenger, "proximity_sensor")
-    streamHandler = ProximityStreamHandler( flutterPluginBinding.applicationContext,
-                                            flutterPluginBinding.binaryMessenger)
-    channel.setStreamHandler(streamHandler)
+  override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
+    methodChannel = MethodChannel(flutterPluginBinding.binaryMessenger, "proximity_sensor_enable")
+    methodChannel.setMethodCallHandler(this)
+
+    eventChannel = EventChannel(flutterPluginBinding.binaryMessenger, "proximity_sensor")
+    streamHandler = ProximityStreamHandler( flutterPluginBinding.applicationContext)
+    eventChannel.setStreamHandler(streamHandler)
   }
 
   override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding) {
-    channel.setStreamHandler(null)
+    eventChannel.setStreamHandler(null)
+  }
+
+  override fun onMethodCall(call: MethodCall, result: Result) {
+    if (call.method == "enableProximityScreenOff") {
+      val enabled: Boolean? = call.argument("enabled")
+      if (enabled == null) {
+        result.error("INVALID_ARGUMENTS", "'enabled' cannot be null", null)
+      } else {
+        streamHandler.setScreenOffEnabled(enabled)
+        result.success(null);
+      }
+    }
   }
 }
 

android/src/main/kotlin/dev/jeremyko/proximity_sensor/ProximityStreamHandler.kt

@@ -1,36 +1,55 @@
 package dev.jeremyko.proximity_sensor
 
+import android.annotation.SuppressLint
 import android.content.Context
 import android.hardware.Sensor
 import android.hardware.SensorEvent
 import android.hardware.SensorEventListener
 import android.hardware.SensorManager
-import io.flutter.plugin.common.BinaryMessenger
+import android.os.Build
+import android.os.PowerManager
 import io.flutter.plugin.common.EventChannel
-import java.io.IOException
 import java.lang.UnsupportedOperationException
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 class ProximityStreamHandler(
         private val applicationContext: Context,
-        private val messenger: BinaryMessenger
 ): EventChannel.StreamHandler, SensorEventListener {
 
     private var eventSink: EventChannel.EventSink? = null
     private lateinit var sensorManager: SensorManager
     private var proximitySensor: Sensor? = null
 
+    private lateinit var powerManager: PowerManager
+    private var wakeLock: PowerManager.WakeLock? = null;
+    private var enableScreenOff: Boolean = false;
+
+    @SuppressLint("WakelockTimeout")
     override fun onListen(arguments: Any?, events: EventChannel.EventSink?) {
         eventSink = events
         sensorManager =  applicationContext.getSystemService(Context.SENSOR_SERVICE) as SensorManager
         proximitySensor = sensorManager.getDefaultSensor(Sensor.TYPE_PROXIMITY) ?:
             throw UnsupportedOperationException("proximity sensor unavailable")
 
         sensorManager.registerListener(this, proximitySensor, SensorManager.SENSOR_DELAY_NORMAL)
+        powerManager = applicationContext.getSystemService(Context.POWER_SERVICE) as
+            PowerManager
+
+        if (enableScreenOff && Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
+            if (wakeLock == null) {
+                wakeLock = powerManager.newWakeLock(PowerManager.PROXIMITY_SCREEN_OFF_WAKE_LOCK, "dev.jeremyko.proximity_sensor:lock")
+            }
+            if (!wakeLock!!.isHeld) {
+                wakeLock!!.acquire()
+            }
+        }
     }
 
     override fun onCancel(arguments: Any?) {
         sensorManager.unregisterListener(this, proximitySensor)
+        if (wakeLock != null && wakeLock!!.isHeld) {
+            wakeLock!!.release()
+        }
     }
 
     override fun onSensorChanged(event: SensorEvent?) {
@@ -49,4 +68,11 @@ class ProximityStreamHandler(
     override fun onAccuracyChanged(sensor: Sensor?, accuracy: Int) {
         //do nothing
     }
+
+    fun setScreenOffEnabled(enabled: Boolean) {
+        enableScreenOff = enabled;
+        if (!enabled && wakeLock != null && wakeLock!!.isHeld) {
+            wakeLock!!.release()
+        }
+    }
 }

example/android/app/src/main/AndroidManifest.xml

@@ -3,6 +3,7 @@
    <uses-permission android:name="android.hardware.sensor.proximity"/>
    <uses-permission android:name="android.permission.BODY_SENSORS_BACKGROUND"/>
    <uses-permission android:name="android.permission.ACTIVITY_RECOGNITION"/>
+   <uses-permission android:name="android.permission.WAKE_LOCK"/>
    <application
         android:label="proximity_sensor_example"
         android:icon="@mipmap/ic_launcher">

example/lib/main.dart

@@ -37,6 +37,10 @@ class _MyAppState extends State<MyApp> {
         FlutterError.dumpErrorToConsole(details);
       }
     };
+    await ProximitySensor.setProximityScreenOff(true).onError((error, stackTrace) {
+      print("could not enable screen off functionality");
+      return null;
+    });
     _streamSubscription = ProximitySensor.events.listen((int event) {
       setState(() {
         _isNear = (event > 0) ? true : false;

example/pubspec.lock

@@ -5,49 +5,56 @@ packages:
     dependency: transitive
     description:
       name: async
-      url: "https://pub.dartlang.org"
+      sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
+      url: "https://pub.dev"
     source: hosted
-    version: "2.9.0"
+    version: "2.11.0"
   boolean_selector:
     dependency: transitive
     description:
       name: boolean_selector
-      url: "https://pub.dartlang.org"
+      sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
+      url: "https://pub.dev"
     source: hosted
-    version: "2.1.0"
+    version: "2.1.1"
   characters:
     dependency: transitive
     description:
       name: characters
-      url: "https://pub.dartlang.org"
+      sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
+      url: "https://pub.dev"
     source: hosted
-    version: "1.2.1"
+    version: "1.3.0"
   clock:
     dependency: transitive
     description:
       name: clock
-      url: "https://pub.dartlang.org"
+      sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
+      url: "https://pub.dev"
     source: hosted
     version: "1.1.1"
   collection:
     dependency: transitive
     description:
       name: collection
-      url: "https://pub.dartlang.org"
+      sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
+      url: "https://pub.dev"
     source: hosted
-    version: "1.16.0"
+    version: "1.18.0"
   cupertino_icons:
     dependency: "direct main"
     description:
       name: cupertino_icons
-      url: "https://pub.dartlang.org"
+      sha256: caac504f942f41dfadcf45229ce8c47065b93919a12739f20d6173a883c5ec73
+      url: "https://pub.dev"
     source: hosted
     version: "1.0.2"
   fake_async:
     dependency: transitive
     description:
       name: fake_async
-      url: "https://pub.dartlang.org"
+      sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
+      url: "https://pub.dev"
     source: hosted
     version: "1.3.1"
   flutter:
@@ -60,41 +67,69 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
+  leak_tracker:
+    dependency: transitive
+    description:
+      name: leak_tracker
+      sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa"
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.0.0"
+  leak_tracker_flutter_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_flutter_testing
+      sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
+  leak_tracker_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_testing
+      sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
   matcher:
     dependency: transitive
     description:
       name: matcher
-      url: "https://pub.dartlang.org"
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
+      url: "https://pub.dev"
     source: hosted
-    version: "0.12.12"
+    version: "0.12.16+1"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      url: "https://pub.dartlang.org"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
+      url: "https://pub.dev"
     source: hosted
-    version: "0.1.5"
+    version: "0.8.0"
   meta:
     dependency: transitive
     description:
       name: meta
-      url: "https://pub.dartlang.org"
+      sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
+      url: "https://pub.dev"
     source: hosted
-    version: "1.8.0"
+    version: "1.11.0"
   path:
     dependency: transitive
     description:
       name: path
-      url: "https://pub.dartlang.org"
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
+      url: "https://pub.dev"
     source: hosted
-    version: "1.8.2"
+    version: "1.9.0"
   proximity_sensor:
     dependency: "direct main"
     description:
       path: ".."
       relative: true
     source: path
-    version: "1.0.4"
+    version: "1.2.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -104,51 +139,66 @@ packages:
     dependency: transitive
     description:
       name: source_span
-      url: "https://pub.dartlang.org"
+      sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
+      url: "https://pub.dev"
     source: hosted
-    version: "1.9.0"
+    version: "1.10.0"
   stack_trace:
     dependency: transitive
     description:
       name: stack_trace
-      url: "https://pub.dartlang.org"
+      sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
+      url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.11.1"
   stream_channel:
     dependency: transitive
     description:
       name: stream_channel
-      url: "https://pub.dartlang.org"
+      sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
+      url: "https://pub.dev"
     source: hosted
-    version: "2.1.0"
+    version: "2.1.2"
   string_scanner:
     dependency: transitive
     description:
       name: string_scanner
-      url: "https://pub.dartlang.org"
+      sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
+      url: "https://pub.dev"
     source: hosted
-    version: "1.1.1"
+    version: "1.2.0"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
-      url: "https://pub.dartlang.org"
+      sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
+      url: "https://pub.dev"
     source: hosted
     version: "1.2.1"
   test_api:
     dependency: transitive
     description:
       name: test_api
-      url: "https://pub.dartlang.org"
+      sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
+      url: "https://pub.dev"
     source: hosted
-    version: "0.4.12"
+    version: "0.6.1"
   vector_math:
     dependency: transitive
     description:
       name: vector_math
-      url: "https://pub.dartlang.org"
+      sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803"
+      url: "https://pub.dev"
     source: hosted
-    version: "2.1.2"
+    version: "2.1.4"
+  vm_service:
+    dependency: transitive
+    description:
+      name: vm_service
+      sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957
+      url: "https://pub.dev"
+    source: hosted
+    version: "13.0.0"
 sdks:
-  dart: ">=2.17.0-0 <3.0.0"
+  dart: ">=3.2.0-0 <4.0.0"
   flutter: ">=1.20.0"