fix(ios): comms handler not initializing (#2626)

adityastic · web-flow · commit 07a6a29c0583 · 2025-02-10T14:30:22.000Z
diff --git a/ios/Podfile.lock b/ios/Podfile.lock
@@ -1,23 +1,35 @@
 PODS:
   - Flutter (1.0.0)
+  - flutter_audio_capture (1.1.4):
+    - Flutter
   - path_provider_foundation (0.0.1):
     - Flutter
     - FlutterMacOS
+  - permission_handler_apple (9.3.0):
+    - Flutter
 
 DEPENDENCIES:
   - Flutter (from `Flutter`)
+  - flutter_audio_capture (from `.symlinks/plugins/flutter_audio_capture/ios`)
   - path_provider_foundation (from `.symlinks/plugins/path_provider_foundation/darwin`)
+  - permission_handler_apple (from `.symlinks/plugins/permission_handler_apple/ios`)
 
 EXTERNAL SOURCES:
   Flutter:
     :path: Flutter
+  flutter_audio_capture:
+    :path: ".symlinks/plugins/flutter_audio_capture/ios"
   path_provider_foundation:
     :path: ".symlinks/plugins/path_provider_foundation/darwin"
+  permission_handler_apple:
+    :path: ".symlinks/plugins/permission_handler_apple/ios"
 
 SPEC CHECKSUMS:
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
+  flutter_audio_capture: e1681f0d73912d756ef02313e9505e8d19246867
   path_provider_foundation: 080d55be775b7414fd5a5ef3ac137b97b097e564
+  permission_handler_apple: 4ed2196e43d0651e8ff7ca3483a069d469701f2d
 
-PODFILE CHECKSUM: 819463e6a0290f5a72f145ba7cde16e8b6ef0796
+PODFILE CHECKSUM: ec8b70a489dd1f81e53ef185cf7ad30fce8f8d00
 
 COCOAPODS: 1.16.2
diff --git a/ios/Runner.xcodeproj/project.pbxproj b/ios/Runner.xcodeproj/project.pbxproj
@@ -198,6 +198,7 @@
 				9705A1C41CF9048500538489 /* Embed Frameworks */,
 				3B06AD1E1E4923F5004D2608 /* Thin Binary */,
 				C8B0F9A46182CD022AB63602 /* [CP] Embed Pods Frameworks */,
+				31EA1FE1A656C4F7D7D9E007 /* [CP] Copy Pods Resources */,
 			);
 			buildRules = (
 			);
@@ -269,6 +270,23 @@
 /* End PBXResourcesBuildPhase section */
 
 /* Begin PBXShellScriptBuildPhase section */
+		31EA1FE1A656C4F7D7D9E007 /* [CP] Copy Pods Resources */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+				"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-resources-${CONFIGURATION}-input-files.xcfilelist",
+			);
+			name = "[CP] Copy Pods Resources";
+			outputFileListPaths = (
+				"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-resources-${CONFIGURATION}-output-files.xcfilelist",
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-resources.sh\"\n";
+			showEnvVarsInLog = 0;
+		};
 		3B06AD1E1E4923F5004D2608 /* Thin Binary */ = {
 			isa = PBXShellScriptBuildPhase;
 			alwaysOutOfDate = 1;
@@ -690,8 +708,8 @@
 				);
 				PRODUCT_BUNDLE_IDENTIFIER = io.pslab;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				"PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]" = "match AppStore io.pslab";
 				PROVISIONING_PROFILE_SPECIFIER = "";
+				"PROVISIONING_PROFILE_SPECIFIER[sdk=iphoneos*]" = "match AppStore io.pslab";
 				SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h";
 				SWIFT_VERSION = 5.0;
 				VERSIONING_SYSTEM = "apple-generic";
diff --git a/lib/communication/handler/android_comms_handler.dart b/lib/communication/handler/android_comms_handler.dart
@@ -1,19 +1,25 @@
 import 'dart:async';
 
 import 'package:flutter/foundation.dart';
+import 'package:pslab/communication/handler/base.dart';
 import 'package:pslab/others/logger_service.dart';
 import 'package:usb_serial/usb_serial.dart';
 
-class CommunicationHandler {
+class AndroidUSBCommunicationHandler implements CommunicationHandler {
   static const int pslabVendorIdV5 = 1240;
   static const int pslabProductIdV5 = 223;
   static const int pslabVendorIdV6 = 0x10C4;
   static const int pslabProductIdV6 = 0xEA60;
   UsbDevice? mDevice;
   UsbPort? mPort;
+
+  @override
   bool connected = false;
+
+  @override
   bool deviceFound = false;
 
+  @override
   Future<void> initialize() async {
     List<UsbDevice> devices = await UsbSerial.listDevices();
     for (UsbDevice device in devices) {
@@ -31,6 +37,7 @@ class CommunicationHandler {
     }
   }
 
+  @override
   Future<void> open() async {
     if (!deviceFound) {
       throw Exception("Device not connected");
@@ -51,16 +58,20 @@ class CommunicationHandler {
     connected = true;
   }
 
+  @override
   bool isDeviceFound() => deviceFound;
 
+  @override
   bool isConnected() => connected;
 
+  @override
   void close() {
     if (!connected || mPort == null) return;
     mPort?.close();
     connected = false;
   }
 
+  @override
   Future<int> read(Uint8List dest, int bytesToRead, int timeoutMillis) async {
     int numBytesRead = 0;
     int bytesToBeReadTemp = bytesToRead;
@@ -92,6 +103,7 @@ class CommunicationHandler {
     return numBytesRead;
   }
 
+  @override
   void write(Uint8List src, int timeoutMillis) {
     mPort?.write(src);
   }
diff --git a/lib/communication/handler/base.dart b/lib/communication/handler/base.dart
@@ -0,0 +1,34 @@
+import 'dart:typed_data';
+
+interface class CommunicationHandler {
+  bool connected = false;
+  bool deviceFound = false;
+
+  Future<void> initialize() {
+    throw UnimplementedError();
+  }
+
+  Future<void> open() async {
+    throw UnimplementedError();
+  }
+
+  bool isDeviceFound() {
+    throw UnimplementedError();
+  }
+
+  bool isConnected() {
+    throw UnimplementedError();
+  }
+
+  void close() {
+    throw UnimplementedError();
+  }
+
+  Future<int> read(Uint8List dest, int bytesToRead, int timeoutMillis) async {
+    throw UnimplementedError();
+  }
+
+  void write(Uint8List src, int timeoutMillis) {
+    throw UnimplementedError();
+  }
+}
diff --git a/lib/communication/handler/ios_comms_handler.dart b/lib/communication/handler/ios_comms_handler.dart
@@ -0,0 +1,35 @@
+import 'dart:async';
+
+import 'package:flutter/foundation.dart';
+import 'package:pslab/communication/handler/base.dart';
+
+class IosNoOpCommunicationHandler implements CommunicationHandler {
+  @override
+  bool connected = false;
+
+  @override
+  bool deviceFound = false;
+
+  @override
+  Future<void> initialize() async {}
+
+  @override
+  Future<void> open() async {}
+
+  @override
+  bool isDeviceFound() => deviceFound;
+
+  @override
+  bool isConnected() => connected;
+
+  @override
+  void close() {}
+
+  @override
+  Future<int> read(Uint8List dest, int bytesToRead, int timeoutMillis) async {
+    return -1;
+  }
+
+  @override
+  void write(Uint8List src, int timeoutMillis) {}
+}
diff --git a/lib/communication/packet_handler.dart b/lib/communication/packet_handler.dart
@@ -2,7 +2,7 @@ import 'dart:convert';
 
 import 'package:flutter/foundation.dart';
 import 'package:pslab/communication/commands_proto.dart';
-import 'package:pslab/communication/communication_handler.dart';
+import 'package:pslab/communication/handler/base.dart';
 import 'package:pslab/others/logger_service.dart';
 
 class PacketHandler {
diff --git a/lib/communication/science_lab.dart b/lib/communication/science_lab.dart
@@ -1,7 +1,7 @@
 import 'dart:math';
 import 'package:flutter/foundation.dart';
 import 'package:pslab/communication/commands_proto.dart';
-import 'package:pslab/communication/communication_handler.dart';
+import 'package:pslab/communication/handler/base.dart';
 import 'package:pslab/communication/packet_handler.dart';
 import 'package:pslab/others/logger_service.dart';
 
diff --git a/lib/others/science_lab_common.dart b/lib/others/science_lab_common.dart
@@ -1,4 +1,4 @@
-import 'package:pslab/communication/communication_handler.dart';
+import 'package:pslab/communication/handler/base.dart';
 import 'package:pslab/communication/science_lab.dart';
 import 'package:pslab/others/logger_service.dart';
 
diff --git a/lib/providers/board_state_provider.dart b/lib/providers/board_state_provider.dart
@@ -1,5 +1,6 @@
 import 'package:flutter/cupertino.dart';
-import 'package:pslab/communication/communication_handler.dart';
+import 'package:get_it/get_it.dart';
+import 'package:pslab/communication/handler/base.dart';
 import 'package:pslab/others/logger_service.dart';
 import 'package:usb_serial/usb_serial.dart';
 
@@ -15,7 +16,7 @@ class BoardStateProvider extends ChangeNotifier {
 
   Future<void> initialize() async {
     scienceLabCommon = ScienceLabCommon();
-    communicationHandler = CommunicationHandler();
+    communicationHandler = GetIt.instance.get<CommunicationHandler>();
     await communicationHandler.initialize();
     pslabIsConnected = await scienceLabCommon.openDevice(communicationHandler);
     setPSLabVersionIDs();
diff --git a/lib/providers/locator.dart b/lib/providers/locator.dart
@@ -1,8 +1,20 @@
+import 'dart:io';
+
 import 'package:get_it/get_it.dart';
+import 'package:pslab/communication/handler/android_comms_handler.dart';
+import 'package:pslab/communication/handler/base.dart';
+import 'package:pslab/communication/handler/ios_comms_handler.dart';
 import 'package:pslab/providers/board_state_provider.dart';
 
 final GetIt getIt = GetIt.instance;
 
 void setupLocator() {
+  getIt.registerLazySingleton<CommunicationHandler>(() {
+    if (Platform.isAndroid) {
+      return AndroidUSBCommunicationHandler();
+    } else {
+      return IosNoOpCommunicationHandler();
+    }
+  });
   getIt.registerLazySingleton<BoardStateProvider>(() => BoardStateProvider());
 }
diff --git a/lib/view/oscilloscope_screen.dart b/lib/view/oscilloscope_screen.dart
@@ -57,10 +57,11 @@ class _OscilloscopeScreenState extends State<OscilloscopeScreen> {
           create: (_) => OscilloscopeStateProvider(),
         ),
       ],
-      child: SafeArea(
-        child: CommonScaffold(
-          title: 'Oscilloscope',
-          body: Container(
+      child: CommonScaffold(
+        title: 'Oscilloscope',
+        body: SafeArea(
+          minimum: const EdgeInsets.only(right: 0, bottom: 0),
+          child: Container(
             margin: const EdgeInsets.only(left: 5, top: 5),
             child: Row(
               children: [
diff --git a/linux/flutter/generated_plugin_registrant.cc b/linux/flutter/generated_plugin_registrant.cc
@@ -6,6 +6,10 @@
 
 #include "generated_plugin_registrant.h"
 
+#include <flutter_audio_capture/flutter_audio_capture_plugin.h>
 
 void fl_register_plugins(FlPluginRegistry* registry) {
+  g_autoptr(FlPluginRegistrar) flutter_audio_capture_registrar =
+      fl_plugin_registry_get_registrar_for_plugin(registry, "FlutterAudioCapturePlugin");
+  flutter_audio_capture_plugin_register_with_registrar(flutter_audio_capture_registrar);
 }
diff --git a/linux/flutter/generated_plugins.cmake b/linux/flutter/generated_plugins.cmake
@@ -3,6 +3,7 @@
 #
 
 list(APPEND FLUTTER_PLUGIN_LIST
+  flutter_audio_capture
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST
diff --git a/windows/flutter/generated_plugin_registrant.cc b/windows/flutter/generated_plugin_registrant.cc
@@ -6,6 +6,9 @@
 
 #include "generated_plugin_registrant.h"
 
+#include <permission_handler_windows/permission_handler_windows_plugin.h>
 
 void RegisterPlugins(flutter::PluginRegistry* registry) {
+  PermissionHandlerWindowsPluginRegisterWithRegistrar(
+      registry->GetRegistrarForPlugin("PermissionHandlerWindowsPlugin"));
 }
diff --git a/windows/flutter/generated_plugins.cmake b/windows/flutter/generated_plugins.cmake
@@ -3,6 +3,7 @@
 #
 
 list(APPEND FLUTTER_PLUGIN_LIST
+  permission_handler_windows
 )
 
 list(APPEND FLUTTER_FFI_PLUGIN_LIST

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import 'package:pslab/communication/communication_handler.dart';`
	`1`	`+import 'package:pslab/communication/handler/base.dart';`
`2`	`2`	`import 'package:pslab/communication/science_lab.dart';`
`3`	`3`	`import 'package:pslab/others/logger_service.dart';`
`4`	`4`