Merge pull request #528 from WildernessLabs/better_dfu

Better dfu flashing behavior
WildernessLabs · Mar 15, 2024 · 27509e9 · 27509e9
2 parents 7657c90 + 50c8040
commit 27509e9
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 34 deletions.
diff --git a/Source/v2/Meadow.Cli/Commands/Current/Config/ConfigCommand.cs b/Source/v2/Meadow.Cli/Commands/Current/Config/ConfigCommand.cs
@@ -40,6 +40,7 @@ protected override ValueTask ExecuteCommand()
         {
             switch (Settings?.Length)
             {
+                case null:
                 case 0:
                     // not valid
                     throw new CommandException($"No setting provided");

diff --git a/Source/v2/Meadow.Cli/Commands/Current/Firmware/FirmwareWriteCommand.cs b/Source/v2/Meadow.Cli/Commands/Current/Firmware/FirmwareWriteCommand.cs
@@ -4,6 +4,7 @@
 using Meadow.LibUsb;
 using Meadow.Software;
 using Microsoft.Extensions.Logging;
+using System.Runtime.InteropServices;
 
 namespace Meadow.CLI.Commands.DeviceManagement;
 
@@ -169,7 +170,9 @@ protected override async ValueTask ExecuteCommand()
             }
 
             // do we have a dfu device attached, or is DFU specified?
-            var dfuDevice = GetLibUsbDeviceForCurrentEnvironment();
+            var provider = new LibUsbProvider();
+            var dfuDevice = GetLibUsbDeviceForCurrentEnvironment(provider);
+            bool ignoreSerial = IgnoreSerialNumberForDfu(provider);
 
             if (dfuDevice != null)
             {
@@ -195,7 +198,7 @@ protected override async ValueTask ExecuteCommand()
 
                 try
                 {
-                    await WriteOsWithDfu(dfuDevice, osFileWithBootloader!);
+                    await WriteOsWithDfu(dfuDevice!, osFileWithBootloader!, ignoreSerial);
                 }
                 finally
                 {
@@ -337,13 +340,7 @@ private async Task<IMeadowConnection> FindMeadowConnection(IList<string> portsTo
 
             if (connection == null)
             {
-                var newPort = await WaitForNewSerialPort(initialPorts);
-
-                if (newPort == null)
-                {
-                    throw CommandException.MeadowDeviceNotFound;
-                }
-
+                var newPort = await WaitForNewSerialPort(initialPorts) ?? throw CommandException.MeadowDeviceNotFound;
                 connection = await GetCurrentConnection(true);
 
                 Logger?.LogInformation($"{Strings.MeadowFoundAt} {newPort}");
@@ -401,9 +398,9 @@ private async Task WriteEspFiles(IMeadowConnection? connection, DeviceInfo? devi
         }
     }
 
-    private ILibUsbDevice? GetLibUsbDeviceForCurrentEnvironment()
+    private ILibUsbDevice? GetLibUsbDeviceForCurrentEnvironment(LibUsbProvider? provider)
     {
-        var provider = new LibUsbProvider();
+        provider ??= new LibUsbProvider();
 
         var devices = provider.GetDevicesInBootloaderMode();
 
@@ -414,8 +411,8 @@ private async Task WriteEspFiles(IMeadowConnection? connection, DeviceInfo? devi
             return null;
         }
 
-        if (meadowsInDFU.Count == 1)
-        {
+        if (meadowsInDFU.Count == 1 || IgnoreSerialNumberForDfu(provider))
+        {   //IgnoreSerialNumberForDfu is a macOS-specific hack for Mark's machine 
             return meadowsInDFU.FirstOrDefault();
         }
 
@@ -451,22 +448,13 @@ private async Task WriteEspFiles(IMeadowConnection? connection, DeviceInfo? devi
         return package;
     }
 
-    private async Task WriteOsWithDfu(ILibUsbDevice? libUsbDevice, string osFile)
+    private async Task WriteOsWithDfu(ILibUsbDevice libUsbDevice, string osFile, bool ignoreSerialNumber = false)
     {
-        // get the device's serial number via DFU - we'll need it to find the device after it resets
-        if (libUsbDevice == null)
-        {
-            libUsbDevice = GetLibUsbDeviceForCurrentEnvironment();
-
-            if (libUsbDevice == null)
-            {
-                throw new CommandException(Strings.NoDfuDeviceDetected);
-            }
-        }
+        string serialNumber;
 
         try
         {   //validate device
-            var serialNumber = libUsbDevice.GetDeviceSerialNumber();
+            serialNumber = libUsbDevice.GetDeviceSerialNumber();
         }
         catch
         {
@@ -475,9 +463,14 @@ private async Task WriteOsWithDfu(ILibUsbDevice? libUsbDevice, string osFile)
 
         try
         {
+            if (ignoreSerialNumber)
+            {
+                serialNumber = string.Empty;
+            }
+
             await DfuUtils.FlashFile(
                 osFile,
-                string.Empty, //serial number isn't needed to flash the OS and may cause issues on MacOS
+                serialNumber,
                 logger: Logger,
                 format: DfuUtils.DfuFlashFormat.ConsoleOut);
         }
@@ -526,4 +519,22 @@ private async Task<IList<string>> WaitForNewSerialPorts(IList<string>? ignorePor
 
         return ports.FirstOrDefault();
     }
+
+    private bool IgnoreSerialNumberForDfu(LibUsbProvider provider)
+    {   //hack check for Mark's Mac
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+        {
+            var devices = provider.GetDevicesInBootloaderMode();
+
+            if (devices.Count == 2)
+            {
+                if (devices[0].GetDeviceSerialNumber().Length > 12 || devices[1].GetDeviceSerialNumber().Length > 12)
+                {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/Source/v2/Meadow.Cli/Meadow.CLI.csproj b/Source/v2/Meadow.Cli/Meadow.CLI.csproj
@@ -10,7 +10,7 @@
 	  <Authors>Wilderness Labs, Inc</Authors>
 	  <Company>Wilderness Labs, Inc</Company>
 	  <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-	  <PackageVersion>2.0.25.0</PackageVersion>
+	  <PackageVersion>2.0.27.0</PackageVersion>
 	  <Platforms>AnyCPU</Platforms>
 	  <PackageProjectUrl>http://developer.wildernesslabs.co/Meadow/Meadow.CLI/</PackageProjectUrl>
 	  <RepositoryUrl>https://github.com/WildernessLabs/Meadow.CLI</RepositoryUrl>

diff --git a/Source/v2/Meadow.Cli/Properties/AssemblyInfo.cs b/Source/v2/Meadow.Cli/Properties/AssemblyInfo.cs
@@ -2,10 +2,9 @@
 [assembly: System.Reflection.AssemblyVersion(Meadow.CLI.Constants.CLI_VERSION)]
 [assembly: System.Reflection.AssemblyInformationalVersion(Meadow.CLI.Constants.CLI_VERSION)]
 
-namespace Meadow.CLI
+namespace Meadow.CLI;
+
+public static class Constants
 {
-    public static class Constants
-    {
-        public const string CLI_VERSION = "2.0.25.0";
-    }
+    public const string CLI_VERSION = "2.0.27.0";
 }
diff --git a/Source/v2/Meadow.UsbLib/LibUsbDevice.cs b/Source/v2/Meadow.UsbLib/LibUsbDevice.cs
@@ -24,8 +24,6 @@ public List<ILibUsbDevice> GetDevicesInBootloaderMode()
            .Select(d => new LibUsbDevice(d))
            .ToList<ILibUsbDevice>();
 
-        UsbDevice device;
-
         return _devices;
     }