feat: add Bluetooth Low Energy plugin (#802)

* feat: add Bluetooth Low Energy plugin

* wip

* wip

android/app/capacitor.build.gradle

@@ -20,6 +20,7 @@ dependencies {
     implementation project(':capacitor-share')
     implementation project(':capawesome-team-capacitor-android-battery-optimization')
     implementation project(':capawesome-team-capacitor-android-foreground-service')
+    implementation project(':capawesome-team-capacitor-bluetooth-low-energy')
     implementation project(':capawesome-team-capacitor-datetime-picker')
     implementation project(':capawesome-team-capacitor-file-compressor')
     implementation project(':capawesome-team-capacitor-file-opener')

android/app/src/main/AndroidManifest.xml

@@ -52,6 +52,8 @@
 
         <receiver android:name="io.capawesome.capacitorjs.plugins.foregroundservice.NotificationActionBroadcastReceiver" />
         <service android:name="io.capawesome.capacitorjs.plugins.foregroundservice.AndroidForegroundService" />
+
+        <service android:name="io.capawesome.capacitorjs.plugins.bluetoothle.BluetoothLowEnergyService" android:foregroundServiceType="connectedDevice" />
     </application>
 
     <uses-feature android:name="android.hardware.camera" android:required="false" />
@@ -79,7 +81,12 @@
     <!-- Battery Optimization -->
     <uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS" />
     <!-- Foreground Service -->
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
-    <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
+    <!-- Foreground Service + Bluetooth Low Energy -->
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+    <!-- Bluetooth Low Energy  -->
+    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
+    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE" />
 </manifest>

android/app/src/main/assets/capacitor.plugins.json

@@ -43,6 +43,10 @@
 		"pkg": "@capawesome-team/capacitor-android-foreground-service",
 		"classpath": "io.capawesome.capacitorjs.plugins.foregroundservice.ForegroundServicePlugin"
 	},
+	{
+		"pkg": "@capawesome-team/capacitor-bluetooth-low-energy",
+		"classpath": "io.capawesome.capacitorjs.plugins.bluetoothle.BluetoothLowEnergyPlugin"
+	},
 	{
 		"pkg": "@capawesome-team/capacitor-datetime-picker",
 		"classpath": "io.capawesome.capacitorjs.plugins.datetimepicker.DatetimePickerPlugin"

android/app/src/main/java/dev/robingenz/capacitor/plugindemo/BluetoothLowEnergyHeadlessTask.java

@@ -0,0 +1,14 @@
+package dev.robingenz.capacitor.plugindemo;
+
+import android.bluetooth.BluetoothGatt;
+import android.bluetooth.BluetoothGattCharacteristic;
+
+import androidx.annotation.NonNull;
+
+import com.getcapacitor.Logger;
+
+public class BluetoothLowEnergyHeadlessTask {
+  public void onCharacteristicChanged(@NonNull BluetoothGatt gatt, @NonNull BluetoothGattCharacteristic characteristic, @NonNull byte[] value) {
+    Logger.debug("BluetoothLowEnergyHeadlessTask", "Characteristic changed: " + characteristic.getUuid().toString() + " Value: " + value);
+  }
+}

android/capacitor.settings.gradle

@@ -35,6 +35,9 @@ project(':capawesome-team-capacitor-android-battery-optimization').projectDir =
 include ':capawesome-team-capacitor-android-foreground-service'
 project(':capawesome-team-capacitor-android-foreground-service').projectDir = new File('../node_modules/@capawesome-team/capacitor-android-foreground-service/android')
 
+include ':capawesome-team-capacitor-bluetooth-low-energy'
+project(':capawesome-team-capacitor-bluetooth-low-energy').projectDir = new File('../node_modules/@capawesome-team/capacitor-bluetooth-low-energy/android')
+
 include ':capawesome-team-capacitor-datetime-picker'
 project(':capawesome-team-capacitor-datetime-picker').projectDir = new File('../node_modules/@capawesome-team/capacitor-datetime-picker/android')
 

ios/App/App/Info.plist

@@ -43,6 +43,8 @@
 	<string>Store camera photos to camera</string>
 	<key>NSPhotoLibraryUsageDescription</key>
 	<string>To Pick Photos from Library</string>
+  <key>NSBluetoothAlwaysUsageDescription</key>
+  <string>The app needs access to Bluetooth peripherals to communicate with Bluetooth devices.</string>
 	<key>UILaunchStoryboardName</key>
 	<string>LaunchScreen</string>
 	<key>UIMainStoryboardFile</key>

ios/App/App/capacitor.config.json

@@ -38,6 +38,8 @@
 		"HapticsPlugin",
 		"KeyboardPlugin",
 		"SharePlugin",
+		"BluetoothLowEnergyPlugin",
+		"BluetoothLowEnergyPlugin",
 		"DatetimePickerPlugin",
 		"DatetimePickerPlugin",
 		"FileCompressorPlugin",

ios/App/Podfile

@@ -20,6 +20,7 @@ def capacitor_pods
   pod 'CapacitorHaptics', :path => '../../node_modules/@capacitor/haptics'
   pod 'CapacitorKeyboard', :path => '../../node_modules/@capacitor/keyboard'
   pod 'CapacitorShare', :path => '../../node_modules/@capacitor/share'
+  pod 'CapawesomeTeamCapacitorBluetoothLowEnergy', :path => '../../node_modules/@capawesome-team/capacitor-bluetooth-low-energy'
   pod 'CapawesomeTeamCapacitorDatetimePicker', :path => '../../node_modules/@capawesome-team/capacitor-datetime-picker'
   pod 'CapawesomeTeamCapacitorFileCompressor', :path => '../../node_modules/@capawesome-team/capacitor-file-compressor'
   pod 'CapawesomeTeamCapacitorFileOpener', :path => '../../node_modules/@capawesome-team/capacitor-file-opener'

ios/App/Podfile.lock

@@ -42,6 +42,8 @@ PODS:
     - Capacitor
   - CapawesomeCapacitorScreenOrientation (6.0.0):
     - Capacitor
+  - CapawesomeTeamCapacitorBluetoothLowEnergy (6.0.0):
+    - Capacitor
   - CapawesomeTeamCapacitorDatetimePicker (6.0.0):
     - Capacitor
   - CapawesomeTeamCapacitorFileCompressor (6.0.0):
@@ -79,6 +81,7 @@ DEPENDENCIES:
   - "CapawesomeCapacitorManagedConfigurations (from `../../node_modules/@capawesome/capacitor-managed-configurations`)"
   - "CapawesomeCapacitorPhotoEditor (from `../../node_modules/@capawesome/capacitor-photo-editor`)"
   - "CapawesomeCapacitorScreenOrientation (from `../../node_modules/@capawesome/capacitor-screen-orientation`)"
+  - "CapawesomeTeamCapacitorBluetoothLowEnergy (from `../../node_modules/@capawesome-team/capacitor-bluetooth-low-energy`)"
   - "CapawesomeTeamCapacitorDatetimePicker (from `../../node_modules/@capawesome-team/capacitor-datetime-picker`)"
   - "CapawesomeTeamCapacitorFileCompressor (from `../../node_modules/@capawesome-team/capacitor-file-compressor`)"
   - "CapawesomeTeamCapacitorFileOpener (from `../../node_modules/@capawesome-team/capacitor-file-opener`)"
@@ -132,6 +135,8 @@ EXTERNAL SOURCES:
     :path: "../../node_modules/@capawesome/capacitor-photo-editor"
   CapawesomeCapacitorScreenOrientation:
     :path: "../../node_modules/@capawesome/capacitor-screen-orientation"
+  CapawesomeTeamCapacitorBluetoothLowEnergy:
+    :path: "../../node_modules/@capawesome-team/capacitor-bluetooth-low-energy"
   CapawesomeTeamCapacitorDatetimePicker:
     :path: "../../node_modules/@capawesome-team/capacitor-datetime-picker"
   CapawesomeTeamCapacitorFileCompressor:
@@ -165,6 +170,7 @@ SPEC CHECKSUMS:
   CapawesomeCapacitorManagedConfigurations: e6dbcbcf45d7b1f7acfa9b54a02e15201604a803
   CapawesomeCapacitorPhotoEditor: 231e03215f026e0c2eeb6de0910e095e4aa0c823
   CapawesomeCapacitorScreenOrientation: 82675c41cb616a64630c834b06344515a2849ff3
+  CapawesomeTeamCapacitorBluetoothLowEnergy: 8a79dcc9f2edde2cf8304b4f628fa3260e12a5d4
   CapawesomeTeamCapacitorDatetimePicker: 6dd2e7ae30c4b55afd48f19bfeb4578dcaa9263e
   CapawesomeTeamCapacitorFileCompressor: be4a55e6476c4084ef370e84c224fc63db27f7a5
   CapawesomeTeamCapacitorFileOpener: b406c1a389cbb4b1a3e9d686c34c9a357abb5902
@@ -173,6 +179,6 @@ SPEC CHECKSUMS:
   Cloudinary: 1e8ed5ce1418ba50df625c1fec80ebec746141b6
   SSZipArchive: fe6a26b2a54d5a0890f2567b5cc6de5caa600aef
 
-PODFILE CHECKSUM: 4ca49903ac471928dcd577796e3d0c22498439f5
+PODFILE CHECKSUM: f974117138a426727b8e09e678d6f634d232fac0
 
 COCOAPODS: 1.15.2

package.json

@@ -36,6 +36,7 @@
     "@capacitor/share": "6.0.0",
     "@capawesome-team/capacitor-android-battery-optimization": "6.0.0",
     "@capawesome-team/capacitor-android-foreground-service": "6.0.0",
+    "@capawesome-team/capacitor-bluetooth-low-energy": "6.0.0",
     "@capawesome-team/capacitor-datetime-picker": "6.0.0",
     "@capawesome-team/capacitor-file-compressor": "6.0.0",
     "@capawesome-team/capacitor-file-opener": "6.0.0",

src/app/app-routing.module.ts

@@ -40,6 +40,13 @@ const routes: Routes = [
     loadChildren: () =>
       import('./modules/badge/badge.module').then(m => m.BadgePageModule),
   },
+  {
+    path: 'bluetooth-low-energy',
+    loadChildren: () =>
+      import('./modules/bluetooth-low-energy/bluetooth-low-energy.module').then(
+        m => m.BluetoothLowEnergyPageModule,
+      ),
+  },
   {
     path: 'cloudinary',
     loadChildren: () =>

src/app/core/services/dialog/dialog.service.ts

@@ -23,6 +23,14 @@ export class DialogService {
     private popoverCtrl: PopoverController,
   ) {}
 
+  public async dismissModal(
+    data?: any,
+    role?: string,
+    id?: string,
+  ): Promise<boolean> {
+    return this.modalCtrl.dismiss(data, role, id);
+  }
+
   public async showAlert(opts?: AlertOptions): Promise<HTMLIonAlertElement> {
     const alert = await this.alertCtrl.create(opts);
     await alert.present();

src/app/modules/android-foreground-service/android-foreground-service.page.ts

@@ -1,4 +1,4 @@
-import { Component, OnInit } from '@angular/core';
+import { Component, NgZone, OnInit } from '@angular/core';
 import { ForegroundService } from '@capawesome-team/capacitor-android-foreground-service';
 
 @Component({
@@ -12,15 +12,10 @@ export class AndroidForegroundServicePage implements OnInit {
   private readonly GH_URL =
     'https://github.com/capawesome-team/capacitor-plugins';
 
-  constructor() {}
+  constructor(private readonly ngZone: NgZone) {}
 
   public ngOnInit(): void {
-    ForegroundService.removeAllListeners().then(() => {
-      ForegroundService.addListener('buttonClicked', event => {
-        ForegroundService.stopForegroundService();
-        ForegroundService.moveToForeground();
-      });
-    });
+    this.addListeners();
   }
 
   public async requestPermissions(): Promise<void> {
@@ -53,4 +48,15 @@ export class AndroidForegroundServicePage implements OnInit {
   public openOnGithub(): void {
     window.open(this.GH_URL, '_blank');
   }
+
+  private addListeners(): void {
+    ForegroundService.removeAllListeners().then(() => {
+      ForegroundService.addListener('buttonClicked', event => {
+        this.ngZone.run(() => {
+          ForegroundService.stopForegroundService();
+          ForegroundService.moveToForeground();
+        });
+      });
+    });
+  }
 }

src/app/modules/background-task/background-task.page.ts

@@ -1,4 +1,4 @@
-import { Component, OnDestroy, OnInit } from '@angular/core';
+import { Component, NgZone, OnDestroy, OnInit } from '@angular/core';
 import { App } from '@capacitor/app';
 import { PluginListenerHandle } from '@capacitor/core';
 import { BackgroundTask } from '@capawesome/capacitor-background-task';
@@ -13,21 +13,10 @@ export class BackgroundTaskPage implements OnInit, OnDestroy {
     'https://github.com/capawesome-team/capacitor-plugins';
   private appStateChangeListener: Promise<PluginListenerHandle> | undefined;
 
-  constructor() {}
+  constructor(private readonly ngZone: NgZone) {}
 
   public ngOnInit() {
-    this.appStateChangeListener = App.addListener(
-      'appStateChange',
-      async ({ isActive }) => {
-        if (isActive) {
-          return;
-        }
-        const taskId = await BackgroundTask.beforeExit(async () => {
-          await this.runTask();
-          BackgroundTask.finish({ taskId });
-        });
-      },
-    );
+    this.addListeners();
   }
 
   public ngOnDestroy() {
@@ -38,6 +27,23 @@ export class BackgroundTaskPage implements OnInit, OnDestroy {
     window.open(this.GH_URL, '_blank');
   }
 
+  private addListeners(): void {
+    this.appStateChangeListener = App.addListener(
+      'appStateChange',
+      ({ isActive }) => {
+        this.ngZone.run(async () => {
+          if (isActive) {
+            return;
+          }
+          const taskId = await BackgroundTask.beforeExit(async () => {
+            await this.runTask();
+            BackgroundTask.finish({ taskId });
+          });
+        });
+      },
+    );
+  }
+
   private async runTask(): Promise<void> {
     const taskDurationMs = 120000;
     const end = new Date().getTime() + taskDurationMs;

src/app/modules/bluetooth-low-energy/bluetooth-low-energy-device/bluetooth-low-energy-device.component.html

@@ -0,0 +1,47 @@
+<ion-header>
+  <ion-toolbar>
+    <ion-title>Device</ion-title>
+    <ion-buttons slot="end">
+      <ion-button (click)="closeModal()">
+        <ion-icon name="close"></ion-icon>
+      </ion-button>
+    </ion-buttons>
+  </ion-toolbar>
+</ion-header>
+
+<ion-content>
+  <ion-card>
+    <ion-card-header>
+      <ion-card-title>{{ device?.name || device?.id }}</ion-card-title>
+    </ion-card-header>
+    <ion-card-content>
+      <ion-button expand="block" (click)="connect()">Connect</ion-button>
+      <ion-button expand="block" (click)="createBond()">Create Bond</ion-button>
+      <ion-button expand="block" (click)="disconnect()">Disconnect</ion-button>
+      <ion-button expand="block" (click)="discoverServices()"
+        >Discover Service</ion-button
+      >
+      <ion-button expand="block" (click)="getServices()"
+        >Get Services</ion-button
+      >
+      <ion-button expand="block" (click)="isBonded()">Is Bonded</ion-button>
+      <ion-button expand="block" (click)="readCharacteristic()"
+        >Read Characteristic</ion-button
+      >
+      <ion-button expand="block" (click)="readRssi()">Read Rssi</ion-button>
+      <ion-button expand="block" (click)="requestConnectionPriority()"
+        >Request Connection Priority</ion-button
+      >
+      <ion-button expand="block" (click)="requestMtu()">Request Mtu</ion-button>
+      <ion-button expand="block" (click)="startCharacteristicNotifications()"
+        >Start Characteristic Notifications</ion-button
+      >
+      <ion-button expand="block" (click)="stopCharacteristicNotifications()"
+        >Stop Characteristic Notifications</ion-button
+      >
+      <ion-button expand="block" (click)="writeCharacteristic()"
+        >Write Characteristic</ion-button
+      >
+    </ion-card-content>
+  </ion-card>
+</ion-content>