feat: Add Support for Renaming (Alias) BLE Devices in App

fix: fixed the issues according to review

fix: format code to match Dart standards

fix: added check for duplicate checking

fix: show succesfully connected as alias name

Author: samruddhi-Rahegaonkar

lib/bademagic_module/bluetooth/connect_state.dart

@@ -1,13 +1,20 @@
 import 'package:badgemagic/bademagic_module/bluetooth/datagenerator.dart';
 import 'package:badgemagic/bademagic_module/bluetooth/write_state.dart';
 import 'package:flutter_blue_plus/flutter_blue_plus.dart';
+import 'package:badgemagic/providers/BadgeAliasProvider.dart';
+import 'package:get_it/get_it.dart';
 import 'base_ble_state.dart';
 
 class ConnectState extends RetryBleState {
   final ScanResult scanResult;
   final DataTransferManager manager;
+  final String displayName;
 
-  ConnectState({required this.manager, required this.scanResult});
+  ConnectState({
+    required this.manager,
+    required this.scanResult,
+    required this.displayName,
+  });
 
   @override
   Future<BleState?> processState() async {
@@ -21,15 +28,35 @@ class ConnectState extends RetryBleState {
       if (connectionState == BluetoothConnectionState.connected) {
         connected = true;
 
-        logger.d("Device connected");
-        toast.showToast('Device connected successfully.');
+        String alias = displayName;
+        final aliasProvider = GetIt.I<BadgeAliasProvider>();
+        final maybeAlias = aliasProvider.getAlias(displayName);
+        if (maybeAlias != null && maybeAlias.trim().isNotEmpty) {
+          alias = maybeAlias;
+        }
 
-        return WriteState(device: scanResult.device, manager: manager);
+        logger.d("Device '$displayName' connected");
+        toast.showToast('Connected successfully to "$alias".');
+
+        final writeState =
+            WriteState(device: scanResult.device, manager: manager);
+        final result = await writeState.process();
+
+        try {
+          await scanResult.device.disconnect();
+          logger.d("Device disconnected after transfer");
+          await Future.delayed(const Duration(seconds: 1));
+          logger.d("Waited 1s after disconnect");
+        } catch (e) {
+          logger.e("Error during disconnect after transfer: $e");
+        }
+
+        return result;
       } else {
         throw Exception("Failed to connect to the device");
       }
     } catch (e) {
-      toast.showErrorToast('Failed to connect retrying...');
+      toast.showErrorToast('Failed to connect to "$displayName", retrying...');
       rethrow;
     } finally {
       if (!connected) {

lib/bademagic_module/bluetooth/scan_state.dart

@@ -2,19 +2,21 @@ import 'dart:async';
 import 'package:badgemagic/bademagic_module/bluetooth/connect_state.dart';
 import 'package:badgemagic/bademagic_module/bluetooth/datagenerator.dart';
 import 'package:badgemagic/providers/BadgeScanProvider.dart';
+import 'package:badgemagic/providers/BadgeAliasProvider.dart';
 import 'package:flutter_blue_plus/flutter_blue_plus.dart';
-
 import 'base_ble_state.dart';
 
 class ScanState extends NormalBleState {
   final DataTransferManager manager;
   final BadgeScanMode mode;
   final List<String> allowedNames;
+  final BadgeAliasProvider aliasProvider;
 
   ScanState({
     required this.manager,
     required this.mode,
     required this.allowedNames,
+    required this.aliasProvider,
   });
 
   @override
@@ -24,6 +26,14 @@ class ScanState extends NormalBleState {
 
     final Completer<BleState?> nextStateCompleter = Completer();
     bool isCompleted = false;
+    bool stopScanCalled = false;
+
+    void stopScanSafely() {
+      if (!stopScanCalled) {
+        stopScanCalled = true;
+        FlutterBluePlus.stopScan();
+      }
+    }
 
     try {
       subscription = FlutterBluePlus.scanResults.listen(
@@ -42,21 +52,44 @@ class ScanState extends NormalBleState {
                     .contains(Guid("0000fee0-0000-1000-8000-00805f9b34fb"));
 
                 final deviceName = result.device.name.trim().toLowerCase();
-                final matchesName = mode == BadgeScanMode.any ||
+
+                final matchesDirectName = mode == BadgeScanMode.any ||
                     normalizedAllowedNames.contains(deviceName);
 
-                return matchesUuid && matchesName;
+                final aliasMatch = normalizedAllowedNames.any((realName) {
+                  final alias =
+                      aliasProvider.getAlias(realName)?.trim().toLowerCase();
+                  return alias == deviceName;
+                });
+
+                return matchesUuid && (matchesDirectName || aliasMatch);
               },
               orElse: () => throw Exception("Matching device not found."),
             );
 
             isCompleted = true;
-            FlutterBluePlus.stopScan();
+            stopScanSafely();
+
             toast.showToast('Device found. Connecting...');
 
+            final foundName = foundDevice.device.name.trim();
+            String? resolvedAlias;
+
+            for (final real in allowedNames) {
+              final alias = aliasProvider.getAlias(real)?.trim();
+              if (alias != null &&
+                  alias.toLowerCase() == foundName.toLowerCase()) {
+                resolvedAlias = alias;
+                break;
+              }
+            }
+
+            final displayName = resolvedAlias ?? foundName;
+
             nextStateCompleter.complete(ConnectState(
               scanResult: foundDevice,
               manager: manager,
+              displayName: displayName,
             ));
           } catch (e) {
             logger.w("No matching device found in this batch: $e");
@@ -65,6 +98,7 @@ class ScanState extends NormalBleState {
         onError: (e) async {
           if (!isCompleted) {
             isCompleted = true;
+            stopScanSafely(); // ✅ Guarded again
             logger.e("Scan error: $e");
             toast.showErrorToast('Scan error occurred.');
             nextStateCompleter.completeError(Exception("Scan error: $e"));
@@ -76,23 +110,25 @@ class ScanState extends NormalBleState {
         withServices: [Guid("0000fee0-0000-1000-8000-00805f9b34fb")],
         removeIfGone: Duration(seconds: 5),
         continuousUpdates: true,
-        timeout: const Duration(seconds: 15), // Reduced scan timeout
+        timeout: const Duration(seconds: 15),
       );
 
       await Future.delayed(const Duration(seconds: 1));
 
-      // If no device is found after the scan timeout, complete with an error.
       if (!isCompleted) {
+        isCompleted = true;
+        stopScanSafely();
         toast.showToast('Device not found.');
         nextStateCompleter.completeError(Exception('Device not found.'));
       }
 
       return await nextStateCompleter.future;
     } catch (e) {
       logger.e("Exception during scanning: $e");
-      throw Exception("please check the device is turned on and retry.");
+      throw Exception("Please check if the device is turned on and retry.");
     } finally {
       await subscription?.cancel();
+      stopScanSafely();
     }
   }
 }

lib/main.dart

@@ -1,3 +1,4 @@
+import 'package:badgemagic/providers/BadgeAliasProvider.dart';
 import 'package:badgemagic/providers/BadgeScanProvider.dart';
 import 'package:badgemagic/providers/getitlocator.dart';
 import 'package:badgemagic/providers/imageprovider.dart';
@@ -25,6 +26,7 @@ void main() {
       ChangeNotifierProvider<InlineImageProvider>(
           create: (context) => getIt<InlineImageProvider>()),
       ChangeNotifierProvider(create: (_) => BadgeScanProvider()),
+      ChangeNotifierProvider(create: (_) => BadgeAliasProvider()),
     ],
     child: const MyApp(),
   ));

lib/providers/BadgeAliasProvider.dart

@@ -0,0 +1,24 @@
+import 'package:flutter/material.dart';
+
+class BadgeAliasProvider with ChangeNotifier {
+  final Map<String, String> _aliases = {};
+
+  String? getAlias(String deviceId) => _aliases[deviceId];
+
+  void setAlias(String deviceId, String alias) {
+    _aliases[deviceId] = alias;
+    notifyListeners();
+  }
+
+  void removeAlias(String deviceId) {
+    _aliases.remove(deviceId);
+    notifyListeners();
+  }
+
+  void clearAll() {
+    _aliases.clear();
+    notifyListeners();
+  }
+
+  Map<String, String> get allAliases => Map.unmodifiable(_aliases);
+}

lib/providers/badge_message_provider.dart

@@ -9,6 +9,7 @@ import 'package:badgemagic/bademagic_module/models/speed.dart';
 import 'package:badgemagic/bademagic_module/utils/converters.dart';
 import 'package:badgemagic/bademagic_module/utils/file_helper.dart';
 import 'package:badgemagic/bademagic_module/utils/toast_utils.dart';
+import 'package:badgemagic/providers/BadgeAliasProvider.dart';
 import 'package:badgemagic/providers/BadgeScanProvider.dart';
 import 'package:badgemagic/providers/imageprovider.dart';
 import 'package:flutter/widgets.dart';
@@ -100,10 +101,11 @@ class BadgeMessageProvider {
   ) async {
     final scanProvider = Provider.of<BadgeScanProvider>(context, listen: false);
 
-    final BleState? initialState = ScanState(
+    final BleState initialState = ScanState(
       manager: manager,
       mode: scanProvider.mode,
       allowedNames: scanProvider.badgeNames,
+      aliasProvider: context.read<BadgeAliasProvider>(),
     );
 
     BleState? state = initialState;