@iotize/device-com-ble.cordova 3.3.1 → 3.4.0

package/package.json

@@ -2,7 +2,7 @@
   "author": "IoTize <contact@iotize.com>",
   "license": "MIT",
   "name": "@iotize/device-com-ble.cordova",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "cordova": {
     "id": "@iotize/device-com-ble.cordova",
     "platforms": [

package/plugin.xml

@@ -1,63 +1,68 @@
-<?xml version="1.0" encoding="utf-8"?>
-<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" id="@iotize/device-com-ble.cordova" version="2.0.0">
-
-  <name>@iotize/device-com-ble.cordova</name>
-  <description>Bluetooth Low Energy (BLE) Plugin for IoTize devices</description>
-  <license>MIT</license>
-  <keywords>bluetooth, BLE, bluetooth low energy, TapNLink, IoTize</keywords>
-
-
-  <js-module src="www/plugin.js" name="iotizeBLE">
-    <clobbers target="iotizeBLE" />
-  </js-module>
-
-  <platform name="android">
-    <config-file target="res/xml/config.xml" parent="/*">
-      <feature name="BLECom">
-        <param name="android-package" value="com.iotize.plugin.cordova.ble.BLECom"/>
-      </feature>
-    </config-file>
-    <framework src="src/android/build.gradle" custom="true" type="gradleReference" />
-    <source-file src="src/android/src/ble" target-dir="java/com/iotize/plugin/cordova"/>
-    <config-file target="AndroidManifest.xml" parent="/manifest">
-      <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
-      <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
-      <uses-permission android:name="android.permission.BLUETOOTH"/>
-      <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
-    </config-file>
-  </platform>
-
-  <platform name="windows">
-    <js-module src="src/windows/iotize-ble-com.js" name="BLECom">
-      <merges target="" />
-    </js-module>
-    <framework src="src/windows/ioTizeBLE.winmd" custom="true"/>
-    <config-file target="package.appxmanifest" parent="/Package/Capabilities">
-      <DeviceCapability Name="bluetooth"/>
-      <DeviceCapability Name="radios"/>
-    </config-file>
-  </platform>
-
-  <platform name="ios">
-    <dependency id="cordova-plugin-add-swift-support"/>
-    <config-file target="config.xml" parent="/*">
-      <feature name="BLECom">
-        <param name="ios-package" value="BLECom" />
-      </feature>
-    </config-file>
-    <source-file src="src/ios/BLECom.swift" />
-    <source-file src="src/ios/BLEManager.swift" />
-    <source-file src="src/ios/BLETapPeripheral.swift" />
-    <source-file src="src/ios/BLEGenericPeripheral.swift" />
-    <source-file src="src/ios/CBPeripheralConverter.swift" />
-    <source-file src="src/ios/Queue.swift" />
-
-    <config-file target="*-Info.plist" parent="NSBluetoothAlwaysUsageDescription">
-      <string>Communicate with IoTize BLE Devices</string>
-    </config-file>
-    <config-file target="*-Info.plist" parent="NSBluetoothPeripheralUsageDescription">
-      <string>Communicate with IoTize BLE Devices</string>
-    </config-file>
-  </platform>
-
-</plugin>
+<?xml version="1.0" encoding="utf-8"?>
+<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" id="@iotize/device-com-ble.cordova" version="2.0.0">
+
+  <name>@iotize/device-com-ble.cordova</name>
+  <description>Bluetooth Low Energy (BLE) Plugin for IoTize devices</description>
+  <license>MIT</license>
+  <keywords>bluetooth, BLE, bluetooth low energy, TapNLink, IoTize</keywords>
+
+
+  <js-module src="www/plugin.js" name="iotizeBLE">
+    <clobbers target="iotizeBLE" />
+  </js-module>
+
+  <platform name="android">
+    <config-file target="res/xml/config.xml" parent="/*">
+      <feature name="BLECom">
+        <param name="android-package" value="com.iotize.plugin.cordova.ble.BLECom"/>
+      </feature>
+    </config-file>
+    <framework src="src/android/build.gradle" custom="true" type="gradleReference" />
+    <source-file src="src/android/src/ble" target-dir="java/com/iotize/plugin/cordova"/>
+    <config-file target="AndroidManifest.xml" parent="/manifest">
+      <uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
+      <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
+      <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+      <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
+      <uses-permission android:name="android.permission.BLUETOOTH_SCAN" android:usesPermissionFlags="neverForLocation" />
+      <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+    </config-file>
+  </platform>
+
+  <platform name="windows">
+    <js-module src="src/windows/iotize-ble-com.js" name="BLECom">
+      <merges target="" />
+    </js-module>
+    <framework src="src/windows/ioTizeBLE.winmd" custom="true"/>
+    <config-file target="package.appxmanifest" parent="/Package/Capabilities">
+      <DeviceCapability Name="bluetooth"/>
+      <DeviceCapability Name="radios"/>
+    </config-file>
+  </platform>
+
+  <platform name="ios">
+    <dependency id="cordova-plugin-add-swift-support"/>
+    <config-file target="config.xml" parent="/*">
+      <feature name="BLECom">
+        <param name="ios-package" value="BLECom" />
+      </feature>
+    </config-file>
+    <source-file src="src/ios/BLECom.swift" />
+    <source-file src="src/ios/BLEManager.swift" />
+    <source-file src="src/ios/BLETapPeripheral.swift" />
+    <source-file src="src/ios/BLEGenericPeripheral.swift" />
+    <source-file src="src/ios/CBPeripheralConverter.swift" />
+    <source-file src="src/ios/Queue.swift" />
+
+    <config-file target="*-Info.plist" parent="NSBluetoothAlwaysUsageDescription">
+      <string>Communicate with IoTize BLE Devices</string>
+    </config-file>
+    <config-file target="*-Info.plist" parent="NSBluetoothPeripheralUsageDescription">
+      <string>Communicate with IoTize BLE Devices</string>
+    </config-file>
+    <config-file target="*-Info.plist" parent="NSLocationWhenInUseUsageDescription">
+      <string>Communicate with IoTize BLE Devices</string>
+    </config-file>
+  </platform>
+
+</plugin>

package/src/android/src/ble/BLECom.java

@@ -7,7 +7,10 @@
 
 package com.iotize.plugin.cordova.ble;
 
+import static android.Manifest.permission.ACCESS_COARSE_LOCATION;
 import static android.Manifest.permission.ACCESS_FINE_LOCATION;
+import static android.Manifest.permission.BLUETOOTH_CONNECT;
+import static android.Manifest.permission.BLUETOOTH_SCAN;
 
 import android.annotation.SuppressLint;
 import android.app.Activity;
@@ -20,6 +23,7 @@ import android.bluetooth.BluetoothManager;
 import android.content.Context;
 import android.content.Intent;
 import android.content.pm.PackageManager;
+import android.os.Build;
 import android.util.Log;
 
 import com.iotize.android.communication.protocol.ble.BLEProtocol;
@@ -76,14 +80,13 @@ public class BLECom extends CordovaPlugin {
 
 
     private static final int REQUEST_ENABLE_BLUETOOTH = 1;
-    private static final int REQUEST_SCAN_PERMISSIONS = 2;
+    private static final int REQUEST_BLE_PERMISSIONS = 2;
 
     private static final String TAG = "BLECom";
     private DeviceManager<BLEProtocol> peripherals;
     private BluetoothAdapter bluetoothAdapter;
     private PluginResponse enableBluetoothCallback;
     private PluginResponse pluginResponseDiscoverDevice;
-    private PluginResponse permissionCallback;
     private BLEScanner scanner;
     private IOnDeviceDiscovered<BLEScanner.BLEScanData> onDeviceDiscoveredCallback;
     @Nullable
@@ -108,7 +111,6 @@ public class BLECom extends CordovaPlugin {
 
     @SuppressLint("MissingPermission")
     public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) {
-
         PluginResponse pluginResponse = new PluginResponse(
                 action,
                 args,
@@ -162,12 +164,7 @@ public class BLECom extends CordovaPlugin {
                 boolean isConnected = peripherals.get(macAddress).isConnected();
                 pluginResponse.success(isConnected);
             } else if (action.equals(ENABLE)) {
-                if (enableBluetoothCallback != null) {
-                    Log.w(TAG, "There is already an enable request pending...");
-                }
-                enableBluetoothCallback = pluginResponse;
-                Intent intent = new Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE);
-                cordova.startActivityForResult(this, intent, REQUEST_ENABLE_BLUETOOTH);
+                this.enableBLE(pluginResponse);
             } else if (action.equals(CHARACTERISTIC_READ)) {
                 String macAddress = argsHelper.getString(0);
                 UUID serviceUUID = argsHelper.getUUID(1);
@@ -217,8 +214,40 @@ public class BLECom extends CordovaPlugin {
 
     }
 
+    private void enableBLE(PluginResponse pluginResponse) {
+        if (enableBluetoothCallback != null) {
+            Log.w(TAG, "There is already an enable request pending...");
+        }
+        enableBluetoothCallback = pluginResponse;
+        if (!this._checkPermissions()) {
+            return;
+        }
+        Intent intent = new Intent(BluetoothAdapter.ACTION_REQUEST_ENABLE);
+        cordova.startActivityForResult(this, intent, REQUEST_ENABLE_BLUETOOTH);
+    }
+
+    private boolean _checkPermissions() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+            if (!PermissionHelper.hasPermission(this, BLUETOOTH_SCAN) || !PermissionHelper.hasPermission(this, BLUETOOTH_CONNECT)) {
+                PermissionHelper.requestPermissions(this, REQUEST_BLE_PERMISSIONS, new String[]{
+                        BLUETOOTH_SCAN,
+                        BLUETOOTH_CONNECT
+                });
+                return false;
+            }
+        } else {
+            if (!PermissionHelper.hasPermission(this, ACCESS_FINE_LOCATION)) {
+                PermissionHelper.requestPermissions(this, REQUEST_BLE_PERMISSIONS, new String[]{
+                        ACCESS_COARSE_LOCATION,
+                        ACCESS_FINE_LOCATION
+                });
+                return false;
+            }
+        }
+        return true;
+    }
+
     private void discoverServices(PluginResponse pluginResponse, String macAddress) throws Exception {
-        // TODO async ? 
         BLEProtocol peripheral = peripherals.get(macAddress);
         peripheral.discoverServices();
         List<BluetoothGattService> services = peripheral.getGatt().getServices();
@@ -265,9 +294,7 @@ public class BLECom extends CordovaPlugin {
     private void startBLEScanner(@Nullable RequestDeviceOptions options, @NonNull PluginResponse pluginResponse) {
         pluginResponseDiscoverDevice = pluginResponse;
 
-        if (!PermissionHelper.hasPermission(this, ACCESS_FINE_LOCATION)) {
-            permissionCallback = pluginResponse;
-            PermissionHelper.requestPermission(this, REQUEST_SCAN_PERMISSIONS, ACCESS_FINE_LOCATION);
+        if (!this._checkPermissions()) {
             return;
         }
 
@@ -350,12 +377,15 @@ public class BLECom extends CordovaPlugin {
         });
     }
 
+    @SuppressLint("MissingPermission")
     private void close(final PluginResponse pluginResponse, String macAddress) {
         executeAsync(() -> {
             try {
                 BLEProtocol peripheral = peripherals.getIfExists(macAddress);
                 if (peripheral != null) {
-                    peripheral.getGatt().close();
+                    if (PermissionHelper.hasPermission(this, BLUETOOTH_CONNECT)) {
+                        peripheral.getGatt().close();
+                    }
                     peripherals.remove(macAddress);
                 }
                 pluginResponse.success();
@@ -494,6 +524,7 @@ public class BLECom extends CordovaPlugin {
             }
             BluetoothDevice device = bluetoothAdapter.getRemoteDevice(macAddress);
             peripheral = new BLEProtocol(cordova.getActivity(), device);
+            peripheral.setConnectionPriority(BluetoothGatt.CONNECTION_PRIORITY_BALANCED);
             peripherals.put(macAddress, peripheral);
             if (initialMTU != null) {
                 peripheral.setMTU(initialMTU);
@@ -506,19 +537,28 @@ public class BLECom extends CordovaPlugin {
     public void onRequestPermissionResult(int requestCode, String[] permissions, int[] grantResults) {
         for (int result : grantResults) {
             if (result == PackageManager.PERMISSION_DENIED) {
-                LOG.d(TAG, "User *rejected* Coarse Location Access");
-                if (permissionCallback != null) {
-                    this.permissionCallback.error("Location permission not granted.");
+                LOG.d(TAG, "User *rejected* permission ");
+                if (pluginResponseDiscoverDevice != null) {
+                    pluginResponseDiscoverDevice.error(BLEComError.missingPermissionError());
+                    pluginResponseDiscoverDevice = null;
+                }
+                if (enableBluetoothCallback != null) {
+                    enableBluetoothCallback.error(BLEComError.missingPermissionError());
+                    enableBluetoothCallback = null;
                 }
                 return;
             }
         }
 
         switch (requestCode) {
-            case REQUEST_SCAN_PERMISSIONS:
+            case REQUEST_BLE_PERMISSIONS:
                 LOG.d(TAG, "User granted scan permissions");
-                this.startScan(this.requestDeviceOptions, pluginResponseDiscoverDevice);
-                this.permissionCallback = null;
+                if (pluginResponseDiscoverDevice != null) {
+                    this.startScan(this.requestDeviceOptions, pluginResponseDiscoverDevice);
+                }
+                if (enableBluetoothCallback != null) {
+                    this.enableBLE(enableBluetoothCallback);
+                }
                 break;
         }
     }
@@ -536,7 +576,7 @@ public class BLECom extends CordovaPlugin {
             } else {
                 LOG.d(TAG, "User did *NOT* enable Bluetooth");
                 if (enableBluetoothCallback != null) {
-                    enableBluetoothCallback.error("User did not enable Bluetooth");
+                    enableBluetoothCallback.error(BLEComError.bleNotEnabled());
                 }
             }
 

package/src/android/src/ble/BLEComError.java

@@ -16,12 +16,12 @@ public class BLEComError extends Exception {
     }
 
     public BLEComError(String code, Throwable cause) {
-        super(cause.getMessage() + " (code " + code + ")");
+        super(cause.getMessage());
         this.code = code;
     }
 
     public BLEComError(String code, String message) {
-        super(message + " (code " + code + ")");
+        super(message);
         this.code = code;
     }
 
@@ -74,6 +74,20 @@ public class BLEComError extends Exception {
         );
     }
 
+    public static BLEComError bleNotEnabled() {
+        return new BLEComError(
+                Code.BLE_ADPATER_NOT_AVAILABLE,
+                "Use did not enable BLE"
+        );
+    }
+
+    public static BLEComError missingPermissionError() {
+        return new BLEComError(
+                Code.BLE_ADPATER_NOT_AVAILABLE,
+                "User has rejected BLE related permissions"
+        );
+    }
+
     public String getCode() {
         return code;
     }