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

samruddhi-Rahegaonkar · samruddhi-Rahegaonkar · commit 5bc8ff4f7443 · 2025-07-07T19:16:45.000+05:30
fix: fixed the issues according to review

fix: format code to match Dart standards
diff --git a/lib/bademagic_module/bluetooth/connect_state.dart b/lib/bademagic_module/bluetooth/connect_state.dart
@@ -6,8 +6,13 @@ 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 +26,15 @@ class ConnectState extends RetryBleState {
       if (connectionState == BluetoothConnectionState.connected) {
         connected = true;
 
-        logger.d("Device connected");
-        toast.showToast('Device connected successfully.');
+        logger.d("Device '$displayName' connected");
+        toast.showToast('Device "$displayName" connected successfully.');
 
         return WriteState(device: scanResult.device, manager: manager);
       } 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) {
diff --git a/lib/bademagic_module/bluetooth/scan_state.dart b/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();
     }
   }
 }
diff --git a/lib/main.dart b/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(),
   ));
diff --git a/lib/providers/BadgeAliasProvider.dart b/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);
+}
diff --git a/lib/providers/badge_message_provider.dart b/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';
@@ -104,6 +105,7 @@ class BadgeMessageProvider {
       manager: manager,
       mode: scanProvider.mode,
       allowedNames: scanProvider.badgeNames,
+      aliasProvider: context.read<BadgeAliasProvider>(),
     );
 
     BleState? state = initialState;
diff --git a/lib/view/badgeScanSettingsWidget.dart b/lib/view/badgeScanSettingsWidget.dart
@@ -1,3 +1,4 @@
+import 'package:badgemagic/providers/BadgeAliasProvider.dart';
 import 'package:badgemagic/providers/BadgeScanProvider.dart';
 import 'package:flutter/material.dart';
 import 'package:provider/provider.dart';
@@ -14,39 +15,63 @@ class BadgeScanSettingsWidget extends StatefulWidget {
 
 class _BadgeScanSettingsWidgetState extends State<BadgeScanSettingsWidget> {
   late BadgeScanMode _mode;
-  final List<TextEditingController> _controllers = [];
+  final List<TextEditingController> _nameControllers = [];
+  final List<TextEditingController> _aliasControllers = [];
 
   @override
   void initState() {
     super.initState();
-    final provider = Provider.of<BadgeScanProvider>(context, listen: false);
-    _mode = provider.mode;
-    for (var name in provider.badgeNames) {
-      _controllers.add(TextEditingController(text: name));
+    final scanProvider = Provider.of<BadgeScanProvider>(context, listen: false);
+    final aliasProvider =
+        Provider.of<BadgeAliasProvider>(context, listen: false);
+
+    _mode = scanProvider.mode;
+    for (var name in scanProvider.badgeNames) {
+      _nameControllers.add(TextEditingController(text: name));
+      final alias = aliasProvider.getAlias(name) ?? "";
+      _aliasControllers.add(TextEditingController(text: alias));
     }
   }
 
   void _addBadgeName() {
     setState(() {
-      _controllers.add(TextEditingController());
+      _nameControllers.add(TextEditingController());
+      _aliasControllers.add(TextEditingController());
     });
   }
 
   void _removeBadgeName(int index) {
     setState(() {
-      _controllers.removeAt(index).dispose();
+      _nameControllers.removeAt(index).dispose();
+      _aliasControllers.removeAt(index).dispose();
     });
   }
 
   void _onSave() {
-    final updatedNames = _controllers
-        .map((c) => c.text.trim())
-        .where((name) => name.isNotEmpty)
-        .toList();
+    final updatedNames = <String>[];
+    final Map<String, String> aliases = {};
+
+    for (int i = 0; i < _nameControllers.length; i++) {
+      final name = _nameControllers[i].text.trim();
+      final alias = _aliasControllers[i].text.trim();
+      if (name.isNotEmpty) {
+        updatedNames.add(name);
+        if (alias.isNotEmpty) {
+          aliases[name] = alias;
+        }
+      }
+    }
 
-    final provider = Provider.of<BadgeScanProvider>(context, listen: false);
-    provider.setMode(_mode);
-    provider.setBadgeNames(updatedNames);
+    // Save mode and names
+    final scanProvider = Provider.of<BadgeScanProvider>(context, listen: false);
+    scanProvider.setMode(_mode);
+    scanProvider.setBadgeNames(updatedNames);
+
+    // Save aliases
+    final aliasProvider =
+        Provider.of<BadgeAliasProvider>(context, listen: false);
+    aliasProvider.clearAll(); // optional: reset aliases
+    aliases.forEach((name, alias) => aliasProvider.setAlias(name, alias));
 
     ScaffoldMessenger.of(context).showSnackBar(
       const SnackBar(content: Text('Scan settings saved successfully')),
@@ -58,8 +83,11 @@ class _BadgeScanSettingsWidgetState extends State<BadgeScanSettingsWidget> {
 
   @override
   void dispose() {
-    for (var c in _controllers) {
-      c.dispose();
+    for (var controller in _nameControllers) {
+      controller.dispose();
+    }
+    for (var controller in _aliasControllers) {
+      controller.dispose();
     }
     super.dispose();
   }
@@ -93,25 +121,40 @@ class _BadgeScanSettingsWidgetState extends State<BadgeScanSettingsWidget> {
           if (_mode == BadgeScanMode.specific)
             Expanded(
               child: ListView.builder(
-                itemCount: _controllers.length,
+                itemCount: _nameControllers.length,
                 itemBuilder: (context, index) {
-                  return Row(
+                  return Column(
                     children: [
-                      Expanded(
-                        child: Padding(
-                          padding: const EdgeInsets.symmetric(horizontal: 12.0),
-                          child: TextField(
-                            controller: _controllers[index],
-                            decoration: const InputDecoration(
-                              labelText: 'Badge Name',
+                      Row(
+                        children: [
+                          Expanded(
+                            child: Padding(
+                              padding: const EdgeInsets.symmetric(
+                                  horizontal: 12.0, vertical: 4),
+                              child: TextField(
+                                controller: _nameControllers[index],
+                                decoration: const InputDecoration(
+                                  labelText: 'Real Badge Name',
+                                ),
+                              ),
                             ),
                           ),
-                        ),
+                          IconButton(
+                            icon: const Icon(Icons.remove_circle_outline),
+                            onPressed: () => _removeBadgeName(index),
+                          ),
+                        ],
                       ),
-                      IconButton(
-                        icon: const Icon(Icons.remove_circle_outline),
-                        onPressed: () => _removeBadgeName(index),
+                      Padding(
+                        padding: const EdgeInsets.symmetric(horizontal: 12.0),
+                        child: TextField(
+                          controller: _aliasControllers[index],
+                          decoration: const InputDecoration(
+                            labelText: 'Alias (Optional)',
+                          ),
+                        ),
                       ),
+                      const Divider(),
                     ],
                   );
                 },
diff --git a/lib/view/homescreen.dart b/lib/view/homescreen.dart
@@ -312,7 +312,7 @@ class _HomeScreenState extends State<HomeScreen>
                                   animationProvider.getAnimationIndex()],
                               null,
                               false,
-                              context, // <== This is needed and now passed
+                              context,
                             );
                           },
                           child: Container(
diff --git a/lib/view/settings_screen.dart b/lib/view/settings_screen.dart
