Setup FilterWheel hardware to use logging

Author: DanielVanNoord

FilterWheelSimulator/FilterWheel.cs

@@ -47,6 +47,7 @@ public class FilterWheel : IFilterWheelV2, IAlpacaDevice, ISimulation // Early-b
         public FilterWheel(int deviceNumber, ILogger logger, IProfile profile)
         {
             logger.LogInformation($"FilterWheel {deviceNumber} - Starting initialization");
+            FilterWheelHardware.Logger = logger;
             DeviceNumber = deviceNumber;
 
             FilterWheelHardware.g_Profile = profile;

FilterWheelSimulator/FilterWheelHardware.cs

@@ -1,4 +1,5 @@
-using ASCOM.Common.Interfaces;
+using ASCOM.Common;
+using ASCOM.Common.Interfaces;
 using System;
 using System.Diagnostics;
 using System.Drawing;
@@ -39,22 +40,25 @@ public class FilterWheelHardware
 
         private const string m_sRegVer = "1";             // Used to track id registry entries exist or need updating
 
+        internal static ILogger Logger
+        {
+            get;
+            set;
+        }
+
 
         //
         // Create some 'realistic' defaults
         //
         private static Color[] DefaultColors = new Color[8] {Color.Red, Color.Green, Color.Blue, Color.Gray,
                                                 Color.DarkRed, Color.Teal, Color.Violet, Color.Black};
 
-        public static bool m_bLogTraffic;                 // Do we log traffic?
-
         //
         // Sync object
         //
         private static object s_objSync = new object();	// Better than lock(this) - Jeffrey Richter, MSDN Jan 2003
 
         public const string g_csDriverID = "ASCOM.Simulator.FilterWheel";
-        private const string g_csDriverDescription = "FilterWheelSimulator FilterWheel";
         public static IProfile g_Profile;
 
         // Exception codes/messages
@@ -129,21 +133,21 @@ public static bool Connected
             {
                 lock (s_objSync)
                 {
-                    LogTraffic("Get Connected = " + m_bConnected);
+                    Logger.LogVerbose("FilterWheel - Get Connected = " + m_bConnected);
                     return m_bConnected;
                 }
             }
             set
             {
                 lock (s_objSync)
                 {
-                    LogTraffic("Set Connected = " + m_bConnected + " -> " + value);
+                    Logger.LogInformation("FilterWheel - Set Connected = " + m_bConnected + " -> " + value);
 
                     // We are always connected to the hardware in the simulator
                     // So just keep a record of the state change
                     m_bConnected = value;
 
-                    LogTraffic("  (set connected, done)");
+                    Logger.LogVerbose("FilterWheel -   (set connected, done)");
                 }
             }
         }
@@ -163,7 +167,7 @@ public static short Position
                     else
                         ret = m_sPosition;      // Otherwise return position
 
-                    LogTraffic("Get Position = " + ret.ToString());
+                    Logger.LogVerbose("FilterWheel - Get Position = " + ret.ToString());
 
                     return ret;
                 }
@@ -174,12 +178,12 @@ public static short Position
                 {
                     int Jumps;      // number of slot positions we have to move
 
-                    LogTraffic("Set Position = " + value + " ...");
+                    Logger.LogInformation("FilterWheel - Set Position = " + value + " ...");
 
                     // position range check
                     if (value >= m_iSlots || value < 0)
                     {
-                        LogTraffic("  (set postion failed, out of range)");
+                        Logger.LogError("FilterWheel -   (set position failed, out of range)");
 
                         throw new DriverException("Position: " + MSG_VAL_OUTOFRANGE, SCODE_VAL_OUTOFRANGE);
                     }
@@ -189,7 +193,7 @@ public static short Position
                     // check if we are already there!
                     if (value == m_sPosition)
                     {
-                        LogTraffic("  (set position, no move required)");
+                        Logger.LogInformation("FilterWheel -   (set position, no move required)");
                         return;
                     }
 
@@ -200,7 +204,7 @@ public static short Position
                             AbortMove();   // Stop the motor
                         else
                         {
-                            LogTraffic("  (set position failed, already moving)");
+                            Logger.LogInformation("FilterWheel -   (set position failed, already moving)");
 
                             throw new DriverException("Position: " + MSG_MOVING, SCODE_MOVING);
                         }
@@ -214,7 +218,7 @@ public static short Position
                     m_bMoving = true;
 
                     // log action
-                    LogTraffic(" (set position in progress)...");
+                    Logger.LogVerbose("FilterWheel -  (set position in progress)...");
                 }
             }
         }
@@ -223,14 +227,12 @@ public static string[] FilterNames
         {
             get
             {
-                LogTraffic("Get FilterNames...");
+                Logger.LogVerbose("FilterWheel - Get FilterNames...");
 
                 string[] temp = m_asFilterNames;
                 Array.Resize(ref temp, m_iSlots);
-                if (m_bLogTraffic)
                     for (int i = 0; i < m_iSlots; i++)
-                        LogTraffic(" Filter " + i.ToString() + " = " + temp[i].ToString());
-                LogTraffic("  (filternames done)");
+                        Logger.LogVerbose("FilterWheel -  Filter " + i.ToString() + " = " + temp[i].ToString());
                 return temp;
             }
         }
@@ -239,13 +241,11 @@ public static int[] FocusOffsets
         {
             get
             {
-                LogTraffic("Get FocusOffsets..." + Environment.NewLine);
+                Logger.LogVerbose("FilterWheel - Get FocusOffsets..." + Environment.NewLine);
                 int[] temp = m_aiFocusOffsets;
                 Array.Resize(ref temp, m_iSlots);
-                if (m_bLogTraffic)
                     for (int i = 0; i < m_iSlots; i++)
-                        LogTraffic(" Offset " + i.ToString() + " = " + temp[i].ToString() + Environment.NewLine);
-                LogTraffic(" (focusoffsets done)" + Environment.NewLine);
+                        Logger.LogVerbose("FilterWheel -  Offset " + i.ToString() + " = " + temp[i].ToString() + Environment.NewLine);
                 return temp;
             }
         }
@@ -304,14 +304,14 @@ public static int TimerTickInverval
 
         public static void AbortMove()
         {
-            LogTraffic("Abort move");
+            Logger.LogInformation("FilterWheel - Abort move");
             // Clear the elapsed time
             m_iTimeElapsed = 0;
             // Stop moving
             m_bMoving = false;
             // Set the postion intermediate between start and end
             m_sPosition = (short)Math.Floor(Math.Abs(m_sTargetPosition - m_sPosition) / 2.0);
-            LogTraffic("  (abort done)");
+            Logger.LogInformation("FilterWheel - Abort done");
         }
 
         public static void UpdateState()
@@ -332,8 +332,6 @@ public static void UpdateState()
                         m_bMoving = false;
                         // Set the new position
                         m_sPosition = m_sTargetPosition;
-                        // log action
-                        LogTraffic("  (position done)");
                     }
                 }
             }
@@ -373,7 +371,7 @@ private static void LoadSettings()
             }
             catch(Exception ex)
             {
-                LogTraffic(ex.Message);
+                Logger.LogError($"FilterWheel - {ex.Message}");
                 SetDefaultSettings();
             }
         }
@@ -438,12 +436,6 @@ private static void CheckConnected()
             if (!m_bConnected) throw new ASCOM.DriverException(MSG_NOT_CONNECTED, SCODE_NOT_CONNECTED);
         }
 
-        private static void LogTraffic(string Text)
-        {
-            if (m_bLogTraffic)
-                Trace.WriteLine(Text);
-        }
-
         #endregion private utilities
     }
 }