Fix a possible crash when disposing ADS1115 device (#2345)

* Fix a possible crash when disposing ADS1115 device * Add extra sleep before retry
dotnet · Aug 23, 2024 · 3f2c387 · 3f2c387
1 parent 376398a
commit 3f2c387
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 14 deletions.
diff --git a/src/devices/Ads1115/Ads1115.cs b/src/devices/Ads1115/Ads1115.cs
@@ -7,6 +7,7 @@
 using System.Device;
 using System.Device.I2c;
 using System.Device.Gpio;
+using System.IO;
 using UnitsNet;
 using UnitsNet.Units;
 
@@ -261,19 +262,38 @@ private void SetConfig()
         /// </summary>
         private void DisableAlertReadyPin()
         {
-            _comparatorQueue = ComparatorQueue.Disable;
-            SetConfig();
-            // Reset to defaults
-            Span<byte> writeBuff = stackalloc byte[3]
-            {
-                (byte)Register.ADC_CONFIG_REG_LO_THRESH, 0x80, 0
-            };
-            _i2cDevice.Write(writeBuff);
-            writeBuff = stackalloc byte[3]
-            {
-                (byte)Register.ADC_CONFIG_REG_HI_THRESH, 0x7F, 0xFF
-            };
-            _i2cDevice.Write(writeBuff);
+            bool success = false;
+            int retries = 3;
+            Span<byte> writeBuff = stackalloc byte[3];
+            while (!success)
+            {
+                // Retry this a few times, otherwise Dispose() may throw an exception, which is ugly.
+                try
+                {
+                    _comparatorQueue = ComparatorQueue.Disable;
+                    SetConfig();
+                    // Reset to defaults
+                    writeBuff[0] = (byte)Register.ADC_CONFIG_REG_LO_THRESH;
+                    writeBuff[1] = 0x80;
+                    writeBuff[2] = 0;
+                    _i2cDevice.Write(writeBuff);
+                    writeBuff[0] = (byte)Register.ADC_CONFIG_REG_HI_THRESH;
+                    writeBuff[1] = 0x7F;
+                    writeBuff[2] = 0xFF;
+                    _i2cDevice.Write(writeBuff);
+                    success = true;
+                }
+                catch (IOException)
+                {
+                    if (retries-- < 0)
+                    {
+                        throw;
+                    }
+
+                    Thread.Sleep(100);
+                }
+            }
+
             if (_gpioController is object)
             {
                 _gpioController.UnregisterCallbackForPinValueChangedEvent(_gpioInterruptPin, ConversionReadyCallback);

diff --git a/src/devices/Common/Iot/Device/Common/AngleExtensions.cs b/src/devices/Common/Iot/Device/Common/AngleExtensions.cs
@@ -71,7 +71,7 @@ public static Angle Normalize(this Angle self, bool toFullCircle)
         /// <param name="currentTrack">First angle, actual direction</param>
         /// <param name="destinationTrack">Second angle, desired direction</param>
         /// <returns>The normalized result of <paramref name="currentTrack"/>-<paramref name="destinationTrack"/>. The value is negative if
-        /// the current track is to port (left) of the the desired track and positive otherwise</returns>
+        /// the current track is to port (left) of the desired track and positive otherwise</returns>
         public static Angle Difference(Angle currentTrack, Angle destinationTrack)
         {
             double val = currentTrack.Radians - destinationTrack.Radians;