Add parameter to GetDeviceDetails (#155)

nanoframework · Aug 22, 2022 · cdb3b27 · cdb3b27
1 parent 8d13653
commit cdb3b27
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/nanoFirmwareFlasher.Library/NanoDeviceOperations.cs b/nanoFirmwareFlasher.Library/NanoDeviceOperations.cs
@@ -48,7 +48,8 @@ public ObservableCollection<NanoDeviceBase> ListDevices()
         /// Gets device details of the requested .NET nanoFramework device.
         /// </summary>
         /// <param name="serialPort">Serial port name where the device is connected to.</param>
-        /// <returns>The <see cref="NanoDeviceBase"/> object for the requested device. <see langword="null"/> if there is no .NET nanoFramework device in the specified <paramref name="serialPort"/>.</returns>
+        /// <param name="nanoDevice"><see cref="NanoDeviceBase"/> object for the requested device.</param>
+        /// <returns>The <see cref="ExitCodes"/> with the operation result.</returns>
         /// <exception cref="CantConnectToNanoDeviceException">
         /// <para>
         /// Couldn't connect to specified nano device.
@@ -60,10 +61,9 @@ public ObservableCollection<NanoDeviceBase> ListDevices()
         /// Couldn't retrieve device details from the nano device.
         /// </para>
         /// </exception>
-        public ExitCodes GetDeviceDetails(string serialPort)
+        public ExitCodes GetDeviceDetails(string serialPort,
+            ref NanoDeviceBase nanoDevice)
         {
-            NanoDeviceBase nanoDevice = null;
-
             if (ReadDetailsFromDevice(serialPort, ref nanoDevice))
             {
                 // check that we are in CLR
@@ -115,6 +115,11 @@ public ExitCodes GetDeviceDetails(string serialPort)
                 throw new CantConnectToNanoDeviceException("Couldn't connect to specified nano device.");
             }
 
+            if (nanoDevice is null)
+            {
+                throw new ArgumentNullException(nameof(nanoDevice));
+            }
+
             return ExitCodes.E2000;
         }
 
@@ -527,8 +532,14 @@ public void Dispose()
             GC.SuppressFinalize(this);
         }
 
-        private bool ReadDetailsFromDevice(string serialPort, ref NanoDeviceBase nanoDevice)
+        private bool ReadDetailsFromDevice(string serialPort,
+            ref NanoDeviceBase nanoDevice)
         {
+            if (serialPort is null)
+            {
+                throw new ArgumentNullException(nameof(serialPort));
+            }
+
             while (!_serialDebuggerPort.IsDevicesEnumerationComplete)
             {
                 Thread.Sleep(100);

diff --git a/nanoFirmwareFlasher.Tool/Program.cs b/nanoFirmwareFlasher.Tool/Program.cs
@@ -356,7 +356,10 @@ static async Task RunOptionsAndReturnExitCodeAsync(Options o)
                 {
                     try
                     {
-                        _exitCode = _nanoDeviceOperations.GetDeviceDetails(o.SerialPort);
+                        NanoDeviceBase nanoDevice = null;
+                        _exitCode = _nanoDeviceOperations.GetDeviceDetails(
+                            o.SerialPort,
+                            ref nanoDevice);
 
                         // done here
                         return;