[FEAT] Scan & Connect: Handle new permission system on Android 12 (#12)

* [FEAT] overall : handle new permission system on Android 12

* [FEAT] MainActivity : ask permission separately

� Conflicts:
�	dev-app/src/main/java/com/vincentmasselis/devapp/MainActivity.kt

* Added comment

* gradle cleanup

* Updated permission management

* Updated readme

* Updated readme

* Updated gradle version and doc

* Updated maven release developer list

* Updated javadoc of `rxScan`

Co-authored-by: Guillaume Hugot <guillaume@equisense.fr>
Co-authored-by: Vincent Masselis <vincent.masselis@gmail.com>

Author: 3 people

README.md

@@ -10,23 +10,21 @@ Made with love at the [Equisense](http://equisense.com) HQ. This library is used
 
 Looking for BLE with Coroutines instead of RxJava ? Take a look at the [LouisCAD's implementation](https://github.com/Beepiz/BleGattCoroutines).
 
-## ⚠️ Android 10 permissions changes ⚠️
-Starting from Android API 29, the coarse location permission is not required anymore, instead of this, you have to use the FINE permission location to scan over the bluetooth low energy. Before upgrading `targetSdkVersion` to 29 in your app, check your `requestPermission` calls according to this new permission.
+## ⚠️ Android 12 permissions changes ⚠️
+Starting from Android API 31, the fine location permission is not required anymore, instead of this, you have to use the BLUETOOTH_CONNECT and BLUETOOTH_SCAN permissions when dealing the bluetooth low energy framework. Before upgrading `targetSdkVersion` to 31 in your app, check your `requestPermission` calls according to this new permission.
 
-Because of this change, RxBluetoothKotlin was updated to fire the `NeedLocationPermission` exception at the right moment when the fine location permission is missing starting from the release `1.2.2`.
-If you're targeting Android API 28 and less, the last supported release is 1.2.1, if you're targeting API 29 or more, you should use the last version of RxBluetoothKotlin.
+Because of this change, RxBluetoothKotlin was updated to fire the `NeedBluetoothScanPermission` and `NeedBluetoothConnectPermission` exceptions at the right moment if they're missing at the runtime. Theses exceptions are fired since the release `3.2.0`.
+
+[Learn more](https://developer.android.com/guide/topics/connectivity/bluetooth/permissions)
 
 ## ⚠️ Important notice about Maven Central release ⚠️
 **RxBluetoothKotlin is released on Maven Central** since the version `3.1.0` you don't have to worry about this library when jCenter will shutdown ! Unfortunately, according to the Maven Central policies, I must update my package to match with the host domain I own. I only own `masselis.com`, so the package name RxBluetothKotlin were renamed from `com.vincentmasselis.rxbluetoothkotlin` to `com.masselis.rxbluetoothkotlin`, as consequence, <ins>you have to renamed EVERY import from rxbluetoothkotlin to the new package name</ins>.
 
 ## TL/DR
 
 ```groovy
+// Check the github release section to find the latest available version
 implementation 'com.masselis.rxbluetoothkotlin:rxbluetoothkotlin-core:<<latest_version>>'
-// Add this to use the scanner
-implementation 'no.nordicsemi.android.support.v18:scanner:1.4.3'
-// RxBluetoothKotlin doesn't provides the RxJava dependecy, you have to add it yourself:
-implementation 'io.reactivex.rxjava3:rxjava:3.0.6'
 ```
 
 ### Scan
@@ -69,15 +67,20 @@ rxBluetoothGatt.disconnect().subscribe()
 
 ## Requirements
 * Min target API 18
-* A manifest with `<uses-feature android:name="android.hardware.bluetooth_le" android:required="true" />` and `<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />`
-* The user permission to access to the fine Location `requestPermissions(arrayOf(Manifest.permission.ACCESS_FINE_LOCATION), PERMISSION_CODE_FINE_LOCATION)`
+* When <ins>scanning</ins> with RxBluetoothKotlin, you have to grant theses runtime permissions:
+    - From Android 6 to 9 inclusive: `ACCESS_COARSE_LOCATION`
+    - From Android 10 to 11 inclusive: `ACCESS_FINE_LOCATION`
+    - From Android 12: `BLUETOOTH_SCAN`
+* When <ins>connecting</ins> with RxBluetoothKotlin, you have to grant this runtime permission:
+    - From Android 12: `BLUETOOTH_CONNECT`
 * A turned on bluetooth chip `(context.getSystemService(Context.BLUETOOTH_SERVICE) as BluetoothManager).adapter.isEnabled`
+* You can add to your manifest `<uses-feature android:name="android.hardware.bluetooth_le" android:required="true" />`
 
 ## Logging
-When scanning with `rxScan()` or connecting with `connectRxGatt()`, you can set the `logger` parameter. By setting it, RxBluetoothKotlin will produce a log for every bluetooth input, output, starting scan, error thrown, etc.. I recommend to set it for debugging purproses and/or if you're not familiar with the Android BLE API. It could helps you a lot to understand what's going on between your app and the Bluetooth Low Energy device.
+When scanning with `rxScan()` or connecting with `connectRxGatt()`, you can set the `logger` parameter. By setting it, RxBluetoothKotlin will produce a log for every bluetooth input, output, starting scan, error thrown, etc.. I recommend to set it for debugging purposes and/or if you're not familiar with the Android BLE API. It could helps you a lot to understand what's going on between your app and the Bluetooth Low Energy device.
 
 ## Error management
-Interact with Bluetooth Low Energy devices on Android is **hard**. The BLE specs uses unfamiliars concepts, the BLE API from Android could fails at any moment and some exceptions are silent. Because of this, a basic method like `write(BluetoothGattCharacteristic)` could fails for 5 differents reasons. It becomes harder if you are chaining this call with other calls, this sum up to a thrown exception when it's impossible to known which call fails and why.
+Interact with Bluetooth Low Energy devices on Android is **hard**. The BLE specs uses unfamiliar concepts, the BLE API from Android could fails at any moment and some exceptions are silent. Because of this, a basic method like `write(BluetoothGattCharacteristic)` could fails for 5 different reasons. It becomes harder if you are chaining this call with other calls, this sum up to a thrown exception when it's impossible to known which call fails and why.
 
 For this reason, every public method from this library is documented with every exceptions which could be fired and most of the exception are unique. For example: `write(BluetoothGattCharacteristic)` could fire:
 * Unique `CharacteristicWriteDeviceDisconnected` if the device disconnects while writing

build.gradle

@@ -2,10 +2,12 @@
 
 buildscript {
     ext.kotlin_version = '1.5.31'
+    ext.compile_sdk_version = 31
+    ext.target_sdk_version = 31
+    ext.build_tool_version = "31.0.0"
     repositories {
         google()
         mavenCentral()
-        jcenter()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:7.0.3'

demo-app/build.gradle

@@ -2,11 +2,14 @@ apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion 31
+    compileSdkVersion compile_sdk_version
+    buildToolsVersion build_tool_version
+
     defaultConfig {
         applicationId "com.masselis.demoapp"
         minSdkVersion 18
-        targetSdkVersion 31
+        targetSdkVersion target_sdk_version
+
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -31,13 +34,10 @@ android {
 
 dependencies {
     implementation 'androidx.appcompat:appcompat:1.3.1'
-    implementation 'androidx.core:core-ktx:1.6.0'
+    implementation 'androidx.core:core-ktx:1.7.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.1'
 
-    implementation 'com.vincentmasselis.rxbluetoothkotlin:rxbluetoothkotlin-core:3.0.0'
-    implementation 'io.reactivex.rxjava3:rxjava:3.1.2'
-    implementation 'no.nordicsemi.android.support.v18:scanner:1.4.3'
-    implementation 'io.reactivex.rxjava3:rxandroid:3.0.0'
+    implementation project(":rxbluetoothkotlin-core")
 
     // Helpers
     implementation 'androidx.recyclerview:recyclerview:1.2.1'

demo-app/src/main/java/com/vincentmasselis/demoapp/DeviceActivity.kt

@@ -1,17 +1,21 @@
 package com.vincentmasselis.demoapp
 
+import android.Manifest.permission.BLUETOOTH_CONNECT
 import android.annotation.SuppressLint
 import android.bluetooth.BluetoothDevice
 import android.content.Context
 import android.content.Intent
+import android.os.Build
 import android.os.Bundle
 import android.view.View
 import android.widget.Toast
+import androidx.activity.result.contract.ActivityResultContracts
+import androidx.annotation.RequiresApi
 import androidx.appcompat.app.AlertDialog
 import androidx.appcompat.app.AppCompatActivity
 import com.jakewharton.rxbinding4.view.clicks
+import com.masselis.rxbluetoothkotlin.*
 import com.vincentmasselis.demoapp.databinding.ActivityDeviceBinding
-import com.vincentmasselis.rxbluetoothkotlin.*
 import com.vincentmasselis.rxuikotlin.disposeOnState
 import com.vincentmasselis.rxuikotlin.utils.ActivityState
 import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
@@ -24,9 +28,15 @@ class DeviceActivity : AppCompatActivity() {
 
     private val device by lazy { intent.getParcelableExtra<BluetoothDevice>(DEVICE_EXTRA)!! }
 
+    private val permissionLauncher =
+        registerForActivityResult(ActivityResultContracts.RequestPermission()) { isGranted ->
+            if (isGranted) states.onNext(States.Connecting)
+            else finish()
+        }
     private val states = BehaviorSubject.createDefault<States>(States.Connecting)
     private lateinit var binding: ActivityDeviceBinding
 
+    @RequiresApi(Build.VERSION_CODES.S)
     @SuppressLint("SetTextI18n")
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -53,10 +63,17 @@ class DeviceActivity : AppCompatActivity() {
         states
             .filter { it is States.Connecting }
             .switchMapSingle { device.connectRxGatt() }
+            .onErrorComplete {
+                if (it is NeedBluetoothConnectPermission) {
+                    permissionLauncher.launch(BLUETOOTH_CONNECT)
+                    true
+                } else
+                    false
+            }
             .switchMapMaybe { gatt -> gatt.whenConnectionIsReady().map { gatt } }
+            .observeOn(AndroidSchedulers.mainThread())
             .doOnSubscribe { binding.connectingGroup.visibility = View.VISIBLE }
             .doFinally { binding.connectingGroup.visibility = View.INVISIBLE }
-            .observeOn(AndroidSchedulers.mainThread())
             .subscribe(
                 {
                     Toast.makeText(this, "Connected !", Toast.LENGTH_SHORT).show()

demo-app/src/main/java/com/vincentmasselis/demoapp/ScanActivity.kt

@@ -1,20 +1,22 @@
 package com.vincentmasselis.demoapp
 
-import android.Manifest
+import android.Manifest.permission.*
 import android.app.Activity
 import android.bluetooth.BluetoothManager
 import android.content.Intent
-import android.content.pm.PackageManager
+import android.content.pm.PackageManager.PERMISSION_GRANTED
 import android.os.Build
 import android.os.Bundle
 import android.provider.Settings
 import android.view.View
+import androidx.activity.result.contract.ActivityResultContracts
 import androidx.appcompat.app.AlertDialog
 import androidx.appcompat.app.AppCompatActivity
+import androidx.core.content.ContextCompat
 import androidx.recyclerview.widget.LinearLayoutManager
 import com.jakewharton.rxbinding4.view.clicks
+import com.masselis.rxbluetoothkotlin.*
 import com.vincentmasselis.demoapp.databinding.ActivityScanBinding
-import com.vincentmasselis.rxbluetoothkotlin.*
 import com.vincentmasselis.rxuikotlin.disposeOnState
 import com.vincentmasselis.rxuikotlin.utils.ActivityState
 import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
@@ -26,10 +28,25 @@ class ScanActivity : AppCompatActivity() {
 
     private var currentState = BehaviorSubject.createDefault<States>(States.NotScanning)
     private lateinit var binding: ActivityScanBinding
+    private val permissionLauncher =
+        registerForActivityResult(ActivityResultContracts.RequestPermission()) { isGranted ->
+            if (isGranted) startScan()
+        }
+
+    private val forResultLauncher =
+        registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
+            if (result.resultCode == Activity.RESULT_OK) startScan()
+        }
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        setContentView(R.layout.activity_scan)
+        binding = ActivityScanBinding.inflate(layoutInflater)
+        setContentView(binding.root)
+
+        // To display the bluetooth device name I need this permission
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S &&
+            ContextCompat.checkSelfPermission(this, BLUETOOTH_CONNECT) != PERMISSION_GRANTED
+        ) permissionLauncher.launch(BLUETOOTH_CONNECT)
 
         currentState
             .distinctUntilChanged()
@@ -76,25 +93,6 @@ class ScanActivity : AppCompatActivity() {
         super.onDestroy()
     }
 
-
-    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
-        super.onActivityResult(requestCode, resultCode, data)
-        when (requestCode) {
-            REQUEST_CODE_ENABLE_LOCATION -> if (resultCode == Activity.RESULT_OK) startScan()
-        }
-    }
-
-    override fun onRequestPermissionsResult(
-        requestCode: Int,
-        permissions: Array<out String>,
-        grantResults: IntArray
-    ) {
-        super.onRequestPermissionsResult(requestCode, permissions, grantResults)
-        when (requestCode) {
-            PERMISSION_CODE_FINE_LOCATION -> if (grantResults[0] == PackageManager.PERMISSION_GRANTED) startScan()
-        }
-    }
-
     private var scanDisp: Disposable? = null
     private fun startScan() {
         currentState.onNext(States.StartingScan)
@@ -107,19 +105,18 @@ class ScanActivity : AppCompatActivity() {
             }, {
                 currentState.onNext(States.NotScanning)
                 when (it) {
-                    is DeviceDoesNotSupportBluetooth -> AlertDialog.Builder(this)
-                        .setMessage("The current device doesn't support bluetooth le").show()
+                    is DeviceDoesNotSupportBluetooth -> AlertDialog
+                        .Builder(this)
+                        .setMessage("The current device doesn't support bluetooth le")
+                        .show()
+                    is BluetoothIsTurnedOff ->
+                        AlertDialog.Builder(this).setMessage("Bluetooth is turned off").show()
                     is NeedLocationPermission -> if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M)
-                        requestPermissions(
-                            arrayOf(Manifest.permission.ACCESS_FINE_LOCATION),
-                            PERMISSION_CODE_FINE_LOCATION
-                        )
-                    is BluetoothIsTurnedOff -> AlertDialog.Builder(this)
-                        .setMessage("Bluetooth is turned off").show()
-                    is LocationServiceDisabled -> startActivityForResult(
-                        Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS),
-                        REQUEST_CODE_ENABLE_LOCATION
-                    )
+                        permissionLauncher.launch(ACCESS_FINE_LOCATION)
+                    is NeedBluetoothScanPermission -> if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S)
+                        permissionLauncher.launch(BLUETOOTH_SCAN)
+                    is LocationServiceDisabled ->
+                        forResultLauncher.launch(Intent(Settings.ACTION_LOCATION_SOURCE_SETTINGS))
                     else -> AlertDialog.Builder(this).setMessage("Error occurred: $it").show()
                 }
             })
@@ -131,9 +128,4 @@ class ScanActivity : AppCompatActivity() {
         object StartingScan : States()
         object Scanning : States()
     }
-
-    companion object {
-        private const val PERMISSION_CODE_FINE_LOCATION = 1
-        private const val REQUEST_CODE_ENABLE_LOCATION = 2
-    }
 }

dev-app/build.gradle

@@ -5,12 +5,12 @@ plugins {
 }
 
 android {
-    compileSdkVersion 30
-    buildToolsVersion "30.0.3"
+    compileSdkVersion compile_sdk_version
+    buildToolsVersion build_tool_version
 
     defaultConfig {
         minSdkVersion 18
-        targetSdkVersion 30
+        targetSdkVersion target_sdk_version
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -33,11 +33,11 @@ android {
 }
 
 dependencies {
-    api 'androidx.core:core-ktx:1.6.0'
-    api 'androidx.annotation:annotation:1.3.0'
+    implementation 'androidx.core:core-ktx:1.7.0'
+    implementation 'androidx.annotation:annotation:1.3.0'
     api 'io.reactivex.rxjava3:rxjava:3.1.2'
     api 'io.reactivex.rxjava3:rxandroid:3.0.0'
-    api 'no.nordicsemi.android.support.v18:scanner:1.4.3'
+    api 'no.nordicsemi.android.support.v18:scanner:1.6.0'
 
     androidTestImplementation 'androidx.test.ext:junit:1.1.3'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
@@ -55,7 +55,7 @@ dokkaHtml.configure {
 
 ext {
     PUBLISH_GROUP_ID = 'com.masselis.rxbluetoothkotlin'
-    PUBLISH_VERSION = '3.1.0'
+    PUBLISH_VERSION = '3.2.0'
     PUBLISH_ARTIFACT_ID = 'rxbluetoothkotlin-core'
 }
 

dev-app/src/main/AndroidManifest.xml

@@ -1,12 +1,12 @@
 package com.masselis.rxbluetoothkotlin
 
-import android.Manifest.permission.ACCESS_BACKGROUND_LOCATION
-import android.Manifest.permission.ACCESS_FINE_LOCATION
+import android.Manifest.permission.*
 import android.bluetooth.BluetoothAdapter
 import android.bluetooth.BluetoothManager
 import android.content.Context
 import android.content.IntentFilter
 import android.os.Build
+import android.os.Build.VERSION.SDK_INT
 import android.util.Log
 import com.masselis.rxbluetoothkotlin.internal.appContext
 import com.masselis.rxbluetoothkotlin.internal.observe
@@ -99,6 +99,14 @@ internal val NOTIFY_CHAR: UUID = UUID
 internal val READ_CHAR: UUID = UUID
     .fromString("00002A2B-0000-1000-8000-00805F9B34FB")
 
-internal val PERMISSIONS = mutableListOf(ACCESS_FINE_LOCATION)
-    .apply { if (Build.VERSION.SDK_INT >= 29) add(ACCESS_BACKGROUND_LOCATION) }
-    .toTypedArray()
+internal val PERMISSIONS =
+    when (SDK_INT) {
+        in Build.VERSION_CODES.M until Build.VERSION_CODES.Q ->
+            arrayOf(ACCESS_COARSE_LOCATION)
+        in Build.VERSION_CODES.Q until Build.VERSION_CODES.S ->
+            arrayOf(ACCESS_FINE_LOCATION, ACCESS_BACKGROUND_LOCATION)
+        in Build.VERSION_CODES.S..Int.MAX_VALUE ->
+            arrayOf(BLUETOOTH_SCAN)
+        else ->
+            emptyArray()
+    }