feat: Alert when a connected device does not respond (#3588)

Author: thisisanubhav

lib/l10n/app_en.arb

@@ -565,6 +565,8 @@
     "distanceUnitLabel": "mm",
     "legacyFirmwareAlertTitle": "Legacy Firmware Detected",
     "legacyFirmwareAlertMessage": "We have detected that your PSLab device is running legacy firmware. Please note that support for this firmware has ended. For the best experience and continued support, please update your device to the latest firmware version.",
+    "unresponsiveDeviceAlertTitle": "PSLab Not Responding",
+    "unresponsiveDeviceAlertMessage": "A device was detected, but it did not respond like a PSLab. Check that it is running PSLab firmware, then reconnect it.",
     "holdPositionForPressure": "Hold position steady for stable pressure reading",
     "moveToHigherAltitude": "Move to a higher altitude or floor",
     "moveToLowerAltitude": "Move to a lower altitude or floor",

lib/providers/board_state_provider.dart

@@ -33,6 +33,8 @@ class BoardStateProvider extends ChangeNotifier {
 
   final ValueNotifier<String?> legacyFirmwareNotifier = ValueNotifier(null);
 
+  final ValueNotifier<bool> unresponsiveDeviceNotifier = ValueNotifier(false);
+
   static const EventChannel _androidUsbEventChannel =
       EventChannel('io.pslab/usb_events');
   Timer? _desktopHotplugTimer;
@@ -99,12 +101,14 @@ class BoardStateProvider extends ChangeNotifier {
     final comms =
         ScienceLabCommon.communicationHandler as PSLabCommunicationHandler;
     List<String> ports = rust_api.getAvailablePorts();
+    bool anyPortFailedHandshake = false;
 
     for (String port in ports) {
+      bool portOpened = false;
       try {
         logger.d("Testing port $port for PSLab handshake...");
         comms.targetPortName = port;
-        bool portOpened = await scienceLabCommon.openDevice();
+        portOpened = await scienceLabCommon.openDevice();
 
         if (portOpened) {
           await setPSLabVersionIDs();
@@ -119,18 +123,25 @@ class BoardStateProvider extends ChangeNotifier {
           } else {
             logger.w(
                 "Device on $port failed handshake. Closing and moving to next port...");
+            anyPortFailedHandshake = true;
             comms.close();
             _resetConnectionState();
           }
         }
       } catch (e) {
         logger.w("Exception while testing $port: $e");
+        if (portOpened && !pslabIsConnected) {
+          anyPortFailedHandshake = true;
+        }
         comms.close();
         _resetConnectionState();
       }
     }
 
     comms.targetPortName = null;
+    if (anyPortFailedHandshake) {
+      _reportUnresponsiveDevice();
+    }
     return false;
   }
 
@@ -200,12 +211,18 @@ class BoardStateProvider extends ChangeNotifier {
   }
 
   Future<void> _validateHandshake() async {
-    await setPSLabVersionIDs();
+    try {
+      await setPSLabVersionIDs();
+    } catch (e) {
+      logger.w("Version handshake threw: $e");
+      pslabVersion = 0;
+    }
 
     if (pslabVersion == 0 || pslabVersionID == 'Not Connected') {
       logger.w(
           "Port opened, but device failed the Version Handshake. Rejecting generic device.");
       _resetConnectionState();
+      _reportUnresponsiveDevice();
     } else {
       logger.i("Handshake successful: $pslabVersionID");
       pslabIsConnected = true;
@@ -214,6 +231,11 @@ class BoardStateProvider extends ChangeNotifier {
     notifyListeners();
   }
 
+  void _reportUnresponsiveDevice() {
+    unresponsiveDeviceNotifier.value = false;
+    unresponsiveDeviceNotifier.value = true;
+  }
+
   void _resetConnectionState() {
     scienceLabCommon.setConnected(false);
     pslabIsConnected = false;

lib/view/instruments_screen.dart

@@ -28,6 +28,7 @@ class _InstrumentsScreenState extends State<InstrumentsScreen> {
   String _searchQuery = '';
   AppLocalizations get appLocalizations => getIt.get<AppLocalizations>();
   late List<_InstrumentData> _instrumentDatas;
+  bool _unresponsiveAlertQueued = false;
 
   void _onItemTapped(int index) {
     _InstrumentData instrument = _instrumentDatas[index];
@@ -88,34 +89,75 @@ class _InstrumentsScreenState extends State<InstrumentsScreen> {
     _filteredIndices = indices;
   }
 
+  void _onLegacyFirmware() {
+    if (getIt.get<BoardStateProvider>().legacyFirmwareNotifier.value ==
+        "LegacyFirmwareDetected") {
+      _showWarningDialog(appLocalizations.legacyFirmwareAlertTitle,
+          appLocalizations.legacyFirmwareAlertMessage);
+    }
+  }
+
+  void _onUnresponsiveDevice() {
+    final notifier = getIt.get<BoardStateProvider>().unresponsiveDeviceNotifier;
+    if (!notifier.value || _unresponsiveAlertQueued) return;
+    _unresponsiveAlertQueued = true;
+    _showWarningDialog(appLocalizations.unresponsiveDeviceAlertTitle,
+        appLocalizations.unresponsiveDeviceAlertMessage,
+        onShown: () => notifier.value = false,
+        onDismissed: () => _unresponsiveAlertQueued = false);
+  }
+
+  void _showWarningDialog(String title, String message,
+      {VoidCallback? onShown, VoidCallback? onDismissed}) {
+    WidgetsBinding.instance.addPostFrameCallback((_) {
+      if (!mounted) return;
+      onShown?.call();
+      showDialog<void>(
+        context: context,
+        builder: (BuildContext context) {
+          return AlertDialog(
+            icon: const Icon(Icons.warning),
+            title: Text(title),
+            content: Text(message),
+            actions: <Widget>[
+              TextButton(
+                onPressed: () {
+                  Navigator.of(context).pop();
+                },
+                child: Text(appLocalizations.ok),
+              ),
+            ],
+          );
+        },
+      ).whenComplete(() => onDismissed?.call());
+    });
+  }
+
+  @override
+  void dispose() {
+    getIt
+        .get<BoardStateProvider>()
+        .legacyFirmwareNotifier
+        .removeListener(_onLegacyFirmware);
+    getIt
+        .get<BoardStateProvider>()
+        .unresponsiveDeviceNotifier
+        .removeListener(_onUnresponsiveDevice);
+    super.dispose();
+  }
+
   @override
   void initState() {
     super.initState();
-    getIt.get<BoardStateProvider>().legacyFirmwareNotifier.addListener(() {
-      if (getIt.get<BoardStateProvider>().legacyFirmwareNotifier.value ==
-          "LegacyFirmwareDetected") {
-        WidgetsBinding.instance.addPostFrameCallback((_) {
-          showDialog<void>(
-            context: context,
-            builder: (BuildContext context) {
-              return AlertDialog(
-                icon: const Icon(Icons.warning),
-                title: Text(appLocalizations.legacyFirmwareAlertTitle),
-                content: Text(appLocalizations.legacyFirmwareAlertMessage),
-                actions: <Widget>[
-                  TextButton(
-                    onPressed: () {
-                      Navigator.of(context).pop();
-                    },
-                    child: Text(appLocalizations.ok),
-                  ),
-                ],
-              );
-            },
-          );
-        });
-      }
-    });
+    getIt
+        .get<BoardStateProvider>()
+        .legacyFirmwareNotifier
+        .addListener(_onLegacyFirmware);
+    getIt
+        .get<BoardStateProvider>()
+        .unresponsiveDeviceNotifier
+        .addListener(_onUnresponsiveDevice);
+    _onUnresponsiveDevice();
 
     _instrumentDatas = [
       _InstrumentData(appLocalizations.oscilloscope,