Merge pull request #1354 from PepperDash/comport-controller-updates

fix: improve logging for COM port registration and configuration

src/PepperDash.Core/ComTextHelper.cs

@@ -0,0 +1,43 @@
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+
+namespace PepperDash.Core
+{
+  /// <summary>
+  /// Helper class for formatting communication text and byte data for debugging purposes.
+  /// </summary>
+  public class ComTextHelper
+  {
+    /// <summary>
+    /// Gets escaped text for a byte array
+    /// </summary>
+    /// <param name="bytes"></param>
+    /// <returns>string with all bytes escaped</returns>
+    public static string GetEscapedText(byte[] bytes)
+    {
+      return string.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
+    }
+
+    /// <summary>
+    /// Gets escaped text for a string
+    /// </summary>
+    /// <param name="text"></param>
+    /// <returns>string with all bytes escaped</returns>
+    public static string GetEscapedText(string text)
+    {
+      var bytes = Encoding.GetEncoding(28591).GetBytes(text);
+      return string.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
+    }
+
+    /// <summary>
+    /// Gets debug text for a string
+    /// </summary>
+    /// <param name="text"></param>
+    /// <returns>string with all non-printable characters escaped</returns>
+    public static string GetDebugText(string text)
+    {
+      return Regex.Replace(text, @"[^\u0020-\u007E]", a => GetEscapedText(a.Value));
+    }
+  }
+}

src/PepperDash.Core/Comm/CommunicationStreamDebugging.cs

@@ -1,5 +1,4 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;
@@ -37,14 +36,14 @@ namespace PepperDash.Core
         {
             get
             {
-                return _DebugTimeoutInMs/60000;
+                return _DebugTimeoutInMs / 60000;
             }
         }
 
         /// <summary>
         /// Gets or sets the RxStreamDebuggingIsEnabled
         /// </summary>
-        public bool RxStreamDebuggingIsEnabled{ get; private set; }
+        public bool RxStreamDebuggingIsEnabled { get; private set; }
 
         /// <summary>
         /// Indicates that transmit stream debugging is enabled
@@ -108,7 +107,7 @@ namespace PepperDash.Core
                 TxStreamDebuggingIsEnabled = true;
 
             Debug.SetDeviceDebugSettings(ParentDeviceKey, setting);
-        
+
         }
 
         /// <summary>
@@ -136,51 +135,4 @@ namespace PepperDash.Core
             DebugExpiryPeriod = null;
         }
     }
-
-    /// <summary>
-    /// The available settings for stream debugging
-    /// </summary>
-    [Flags]
-    /// <summary>
-    /// Enumeration of eStreamDebuggingSetting values
-    /// </summary>
-    public enum eStreamDebuggingSetting
-    {
-        /// <summary>
-        /// Debug off
-        /// </summary>
-        Off = 0,
-        /// <summary>
-        /// Debug received data
-        /// </summary>
-        Rx = 1, 
-        /// <summary>
-        /// Debug transmitted data
-        /// </summary>
-        Tx = 2,
-        /// <summary>
-        /// Debug both received and transmitted data
-        /// </summary>
-        Both = Rx | Tx
-    }
-
-    /// <summary>
-    /// The available settings for stream debugging response types
-    /// </summary>
-    [Flags]
-    public enum eStreamDebuggingDataTypeSettings
-    {
-        /// <summary>
-        /// Debug data in byte format
-        /// </summary>
-        Bytes = 0,
-        /// <summary>
-        /// Debug data in text format
-        /// </summary>
-        Text = 1,
-        /// <summary>
-        /// Debug data in both byte and text formats
-        /// </summary>
-        Both = Bytes | Text,
-    }
 }

src/PepperDash.Core/Comm/GenericSshClient.cs

@@ -278,7 +278,7 @@ namespace PepperDash.Core
                         if (shellStream.DataAvailable)
                         {
                             // empty the buffer if there is data
-                            string str = shellStream.Read();
+                            shellStream.Read();
                         }
                         shellStream.DataReceived += Stream_DataReceived;
                         this.LogInformation("Connected");
@@ -288,7 +288,6 @@ namespace PepperDash.Core
                     catch (SshConnectionException e)
                     {
                         var ie = e.InnerException; // The details are inside!!
-                        var errorLogLevel = disconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error;
 
                         if (ie is SocketException)
                         {
@@ -335,7 +334,6 @@ namespace PepperDash.Core
                     }
                     catch (Exception e)
                     {
-                        var errorLogLevel = disconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error;
                         this.LogError("Unhandled exception on connect: {error}", e.Message);
                         this.LogVerbose(e, "Exception details: ");
                         disconnectLogged = true;
@@ -439,18 +437,14 @@ namespace PepperDash.Core
             if (bytesHandler != null)
             {
                 var bytes = Encoding.UTF8.GetBytes(response);
-                if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                {
-                    this.LogInformation("Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                }
+                this.PrintReceivedBytes(bytes);
                 bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
             }
 
             var textHandler = TextReceived;
             if (textHandler != null)
             {
-                if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                    this.LogInformation("Received: '{0}'", ComTextHelper.GetDebugText(response));
+                this.PrintReceivedText(response);
 
                 textHandler(this, new GenericCommMethodReceiveTextArgs(response));
             }
@@ -507,11 +501,7 @@ namespace PepperDash.Core
             {
                 if (client != null && shellStream != null && IsConnected)
                 {
-                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                        this.LogInformation(
-                                      "Sending {length} characters of text: '{text}'",
-                                      text.Length,
-                                      ComTextHelper.GetDebugText(text));
+                    this.PrintSentText(text);
 
                     shellStream.Write(text);
                     shellStream.Flush();
@@ -526,7 +516,7 @@ namespace PepperDash.Core
                 this.LogError("ObjectDisposedException sending '{message}'. Restarting connection...", text.Trim());
 
                 KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
-                StopReconnectTimer();
+                StartReconnectTimer();
             }
             catch (Exception ex)
             {
@@ -544,8 +534,7 @@ namespace PepperDash.Core
             {
                 if (client != null && shellStream != null && IsConnected)
                 {
-                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                        this.LogInformation("Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+                    this.PrintSentBytes(bytes);
 
                     shellStream.Write(bytes, 0, bytes.Length);
                     shellStream.Flush();
@@ -560,7 +549,7 @@ namespace PepperDash.Core
                 this.LogException(ex, "ObjectDisposedException sending {message}", ComTextHelper.GetEscapedText(bytes));
 
                 KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
-                StopReconnectTimer();
+                StartReconnectTimer();
             }
             catch (Exception ex)
             {

src/PepperDash.Core/Comm/GenericTcpIpClient.cs

@@ -426,10 +426,7 @@ namespace PepperDash.Core
                     var bytesHandler = BytesReceived;
                     if (bytesHandler != null)
                     {
-                        if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                        {
-                            Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                        }
+                        this.PrintReceivedBytes(bytes);
                         bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
                     }
                     var textHandler = TextReceived;
@@ -437,10 +434,7 @@ namespace PepperDash.Core
                     {
                         var str = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
 
-                        if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                        {
-                            Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length);
-                        }
+                        this.PrintReceivedText(str);
 
                         textHandler(this, new GenericCommMethodReceiveTextArgs(str));
                     }
@@ -456,8 +450,7 @@ namespace PepperDash.Core
         {
             var bytes = Encoding.GetEncoding(28591).GetBytes(text);
             // Check debug level before processing byte array
-            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text));
+            this.PrintSentText(text);
             if (_client != null)
                 _client.SendData(bytes, bytes.Length);
         }
@@ -484,8 +477,7 @@ namespace PepperDash.Core
         /// </summary>
         public void SendBytes(byte[] bytes)
         {
-            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+            this.PrintSentBytes(bytes);
             if (_client != null)
                 _client.SendData(bytes, bytes.Length);
         }

src/PepperDash.Core/Comm/GenericUdpServer.cs

@@ -124,7 +124,7 @@ namespace PepperDash.Core
             CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
             CrestronEnvironment.EthernetEventHandler += new EthernetEventHandler(CrestronEnvironment_EthernetEventHandler);
         }
-       
+
         /// <summary>
         /// 
         /// </summary>
@@ -135,7 +135,7 @@ namespace PepperDash.Core
         public GenericUdpServer(string key, string address, int port, int bufferSize)
             : base(key)
         {
-            StreamDebugging = new CommunicationStreamDebugging(key); 
+            StreamDebugging = new CommunicationStreamDebugging(key);
             Hostname = address;
             Port = port;
             BufferSize = bufferSize;
@@ -180,7 +180,7 @@ namespace PepperDash.Core
         /// <param name="programEventType"></param>
         void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType)
         {
-            if (programEventType != eProgramStatusEventType.Stopping) 
+            if (programEventType != eProgramStatusEventType.Stopping)
                 return;
 
             Debug.Console(1, this, "Program stopping. Disabling Server");
@@ -243,7 +243,7 @@ namespace PepperDash.Core
         /// </summary>
         public void Disconnect()
         {
-            if(Server != null)
+            if (Server != null)
                 Server.DisableUDPServer();
 
             IsConnected = false;
@@ -265,7 +265,7 @@ namespace PepperDash.Core
 
             try
             {
-                if (numBytes <= 0) 
+                if (numBytes <= 0)
                     return;
 
                 var sourceIp = Server.IPAddressLastMessageReceivedFrom;
@@ -281,17 +281,13 @@ namespace PepperDash.Core
                 var bytesHandler = BytesReceived;
                 if (bytesHandler != null)
                 {
-                    if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                    {
-                        Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                    }
+                    this.PrintReceivedBytes(bytes);
                     bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
                 }
                 var textHandler = TextReceived;
                 if (textHandler != null)
                 {
-                    if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                        Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length);
+                    this.PrintReceivedText(str);
                     textHandler(this, new GenericCommMethodReceiveTextArgs(str));
                 }
             }
@@ -318,8 +314,7 @@ namespace PepperDash.Core
 
             if (IsConnected && Server != null)
             {
-                if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                    Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text));
+                this.PrintSentText(text);
 
                 Server.SendData(bytes, bytes.Length);
             }
@@ -334,8 +329,7 @@ namespace PepperDash.Core
         /// </summary>
         public void SendBytes(byte[] bytes)
         {
-            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+            this.PrintSentBytes(bytes);
 
             if (IsConnected && Server != null)
                 Server.SendData(bytes, bytes.Length);
@@ -343,11 +337,11 @@ namespace PepperDash.Core
 
     }
 
- /// <summary>
- /// Represents a GenericUdpReceiveTextExtraArgs
- /// </summary>
-	public class GenericUdpReceiveTextExtraArgs : EventArgs
-	{
+    /// <summary>
+    /// Represents a GenericUdpReceiveTextExtraArgs
+    /// </summary>
+    public class GenericUdpReceiveTextExtraArgs : EventArgs
+    {
         /// <summary>
         /// 
         /// </summary>
@@ -359,7 +353,7 @@ namespace PepperDash.Core
         /// <summary>
         /// 
         /// </summary>
-		public int	Port { get; private set; }
+		public int Port { get; private set; }
         /// <summary>
         /// 
         /// </summary>
@@ -373,18 +367,18 @@ namespace PepperDash.Core
         /// <param name="port"></param>
         /// <param name="bytes"></param>
 		public GenericUdpReceiveTextExtraArgs(string text, string ipAddress, int port, byte[] bytes)
-		{
-			Text = text;
-			IpAddress = ipAddress;
-			Port = port;
-			Bytes = bytes;
-		}
+        {
+            Text = text;
+            IpAddress = ipAddress;
+            Port = port;
+            Bytes = bytes;
+        }
 
-		/// <summary>
-		/// Stupid S+ Constructor
-		/// </summary>
-		public GenericUdpReceiveTextExtraArgs() { }
-	}
+        /// <summary>
+        /// Stupid S+ Constructor
+        /// </summary>
+        public GenericUdpReceiveTextExtraArgs() { }
+    }
 
     /// <summary>
     /// 

src/PepperDash.Core/Comm/StreamDebuggingExtensions.cs

@@ -0,0 +1,69 @@
+using System;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Core
+{
+  /// <summary>
+  /// Extension methods for stream debugging
+  /// </summary>
+  public static class StreamDebuggingExtensions
+  {
+    private static readonly string app = CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance ? $"App {InitialParametersClass.ApplicationNumber}" : $"{InitialParametersClass.RoomId}";
+
+    /// <summary>
+    /// Print the sent bytes to the console
+    /// </summary>
+    /// <param name="comms">comms device</param>
+    /// <param name="bytes">bytes to print</param>
+    public static void PrintSentBytes(this IStreamDebugging comms, byte[] bytes)
+    {
+      if (!comms.StreamDebugging.TxStreamDebuggingIsEnabled) return;
+
+      var timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
+
+      CrestronConsole.PrintLine($"[{timestamp}][{app}][{comms.Key}] Sending {bytes.Length} bytes: '{ComTextHelper.GetEscapedText(bytes)}'");
+    }
+
+    /// <summary>
+    /// Print the received bytes to the console
+    /// </summary>
+    /// <param name="comms">comms device</param>
+    /// <param name="bytes">bytes to print</param>
+    public static void PrintReceivedBytes(this IStreamDebugging comms, byte[] bytes)
+    {
+      if (!comms.StreamDebugging.RxStreamDebuggingIsEnabled) return;
+
+      var timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
+
+      CrestronConsole.PrintLine($"[{timestamp}][{app}][{comms.Key}] Received {bytes.Length} bytes: '{ComTextHelper.GetEscapedText(bytes)}'");
+    }
+
+    /// <summary>
+    /// Print the sent text to the console
+    /// </summary>
+    /// <param name="comms">comms device</param>
+    /// <param name="text">text to print</param>
+    public static void PrintSentText(this IStreamDebugging comms, string text)
+    {
+      if (!comms.StreamDebugging.TxStreamDebuggingIsEnabled) return;
+
+      var timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
+
+      CrestronConsole.PrintLine($"[{timestamp}][{app}][{comms.Key}] Sending Text: '{ComTextHelper.GetDebugText(text)}'");
+    }
+
+    /// <summary>
+    /// Print the received text to the console
+    /// </summary>
+    /// <param name="comms">comms device</param>
+    /// <param name="text">text to print</param>
+    public static void PrintReceivedText(this IStreamDebugging comms, string text)
+    {
+      if (!comms.StreamDebugging.RxStreamDebuggingIsEnabled) return;
+
+      var timestamp = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
+
+      CrestronConsole.PrintLine($"[{timestamp}][{app}][{comms.Key}] Received Text: '{ComTextHelper.GetDebugText(text)}'");
+    }
+  }
+}

src/PepperDash.Core/Comm/eStreamDebuggingDataTypeSettings.cs

@@ -0,0 +1,24 @@
+using System;
+
+namespace PepperDash.Core
+{
+  /// <summary>
+  /// The available settings for stream debugging data format types
+  /// </summary>
+  [Flags]
+  public enum eStreamDebuggingDataTypeSettings
+  {
+    /// <summary>
+    /// Debug data in byte format
+    /// </summary>
+    Bytes = 0,
+    /// <summary>
+    /// Debug data in text format
+    /// </summary>
+    Text = 1,
+    /// <summary>
+    /// Debug data in both byte and text formats
+    /// </summary>
+    Both = Bytes | Text
+  }
+}

src/PepperDash.Core/Comm/eStreamDebuggingSetting.cs

@@ -0,0 +1,28 @@
+using System;
+
+namespace PepperDash.Core
+{
+  /// <summary>
+  /// The available settings for stream debugging
+  /// </summary>
+  [Flags]
+  public enum eStreamDebuggingSetting
+  {
+    /// <summary>
+    /// Debug off
+    /// </summary>
+    Off = 0,
+    /// <summary>
+    /// Debug received data
+    /// </summary>
+    Rx = 1,
+    /// <summary>
+    /// Debug transmitted data
+    /// </summary>
+    Tx = 2,
+    /// <summary>
+    /// Debug both received and transmitted data
+    /// </summary>
+    Both = Rx | Tx
+  }
+}

src/PepperDash.Core/CommunicationExtras.cs

@@ -1,10 +1,7 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using Crestron.SimplSharp;
 using Crestron.SimplSharp.CrestronSockets;
-using System.Text.RegularExpressions;
 using Newtonsoft.Json;
 
 namespace PepperDash.Core
@@ -42,7 +39,7 @@ namespace PepperDash.Core
     /// Defines the contract for IBasicCommunication
     /// </summary>
     public interface IBasicCommunication : ICommunicationReceiver
-	{
+    {
         /// <summary>
         /// Send text to the device
         /// </summary>
@@ -54,7 +51,7 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="bytes"></param>
 		void SendBytes(byte[] bytes);
-	}
+    }
 
     /// <summary>
     /// Represents a device that implements IBasicCommunication and IStreamDebugging
@@ -67,7 +64,7 @@ namespace PepperDash.Core
     /// <summary>
     /// Represents a device with stream debugging capablities
     /// </summary>
-    public interface IStreamDebugging
+    public interface IStreamDebugging : IKeyed
     {
         /// <summary>
         /// Object to enable stream debugging
@@ -76,12 +73,12 @@ namespace PepperDash.Core
         CommunicationStreamDebugging StreamDebugging { get; }
     }
 
-	/// <summary>
-	/// For IBasicCommunication classes that have SocketStatus. GenericSshClient,
-	/// GenericTcpIpClient
-	/// </summary>
-	public interface ISocketStatus : IBasicCommunication
-	{
+    /// <summary>
+    /// For IBasicCommunication classes that have SocketStatus. GenericSshClient,
+    /// GenericTcpIpClient
+    /// </summary>
+    public interface ISocketStatus : IBasicCommunication
+    {
         /// <summary>
         /// Notifies of socket status changes
         /// </summary>
@@ -93,7 +90,7 @@ namespace PepperDash.Core
         [JsonProperty("clientStatus")]
         [JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
         SocketStatus ClientStatus { get; }
-	}
+    }
 
     /// <summary>
     /// Describes a device that implements ISocketStatus and IStreamDebugging
@@ -107,24 +104,24 @@ namespace PepperDash.Core
     /// Describes a device that can automatically attempt to reconnect
     /// </summary>
 	public interface IAutoReconnect
-	{
+    {
         /// <summary>
         /// Enable automatic recconnect
         /// </summary>
         [JsonProperty("autoReconnect")]
-		bool AutoReconnect { get; set; }
+        bool AutoReconnect { get; set; }
         /// <summary>
         /// Interval in ms to attempt automatic recconnections
         /// </summary>
         [JsonProperty("autoReconnectIntervalMs")]
-		int AutoReconnectIntervalMs { get; set; }
-	}
+        int AutoReconnectIntervalMs { get; set; }
+    }
 
-	/// <summary>
-	/// 
-	/// </summary>
-	public enum eGenericCommMethodStatusChangeType
-	{
+    /// <summary>
+    /// 
+    /// </summary>
+    public enum eGenericCommMethodStatusChangeType
+    {
         /// <summary>
         /// Connected
         /// </summary>
@@ -133,45 +130,45 @@ namespace PepperDash.Core
         /// Disconnected
         /// </summary>
         Disconnected
-	}
+    }
 
-	/// <summary>
-	/// This delegate defines handler for IBasicCommunication status changes
-	/// </summary>
-	/// <param name="comm">Device firing the status change</param>
-	/// <param name="status"></param>
-	public delegate void GenericCommMethodStatusHandler(IBasicCommunication comm, eGenericCommMethodStatusChangeType status);
+    /// <summary>
+    /// This delegate defines handler for IBasicCommunication status changes
+    /// </summary>
+    /// <param name="comm">Device firing the status change</param>
+    /// <param name="status"></param>
+    public delegate void GenericCommMethodStatusHandler(IBasicCommunication comm, eGenericCommMethodStatusChangeType status);
 
-	/// <summary>
-	/// 
-	/// </summary>
-	public class GenericCommMethodReceiveBytesArgs : EventArgs
-	{
-  /// <summary>
-  /// Gets or sets the Bytes
-  /// </summary>
-		public byte[] Bytes { get; private set; }
+    /// <summary>
+    /// 
+    /// </summary>
+    public class GenericCommMethodReceiveBytesArgs : EventArgs
+    {
+        /// <summary>
+        /// Gets or sets the Bytes
+        /// </summary>
+        public byte[] Bytes { get; private set; }
 
         /// <summary>
         /// 
         /// </summary>
         /// <param name="bytes"></param>
 		public GenericCommMethodReceiveBytesArgs(byte[] bytes)
-		{
-			Bytes = bytes;
-		}
+        {
+            Bytes = bytes;
+        }
 
-		/// <summary>
-		/// S+ Constructor
-		/// </summary>
-		public GenericCommMethodReceiveBytesArgs() { }
-	}
+        /// <summary>
+        /// S+ Constructor
+        /// </summary>
+        public GenericCommMethodReceiveBytesArgs() { }
+    }
 
-	/// <summary>
-	/// 
-	/// </summary>
-	public class GenericCommMethodReceiveTextArgs : EventArgs
-	{
+    /// <summary>
+    /// 
+    /// </summary>
+    public class GenericCommMethodReceiveTextArgs : EventArgs
+    {
         /// <summary>
         /// 
         /// </summary>
@@ -185,9 +182,9 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="text"></param>
 		public GenericCommMethodReceiveTextArgs(string text)
-		{
-			Text = text;
-		}
+        {
+            Text = text;
+        }
 
         /// <summary>
         /// 
@@ -195,59 +192,14 @@ namespace PepperDash.Core
         /// <param name="text"></param>
         /// <param name="delimiter"></param>
         public GenericCommMethodReceiveTextArgs(string text, string delimiter)
-            :this(text)
+            : this(text)
         {
             Delimiter = delimiter;
         }
 
-		/// <summary>
-		/// S+ Constructor
-		/// </summary>
-		public GenericCommMethodReceiveTextArgs() { }
-	}
-
-
-
-	/// <summary>
-	/// 
-	/// </summary>
-	public class ComTextHelper
-	{
         /// <summary>
-        /// Gets escaped text for a byte array
+        /// S+ Constructor
         /// </summary>
-        /// <param name="bytes"></param>
-        /// <returns></returns>
-		public static string GetEscapedText(byte[] bytes)
-		{
-			return String.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
-		}
-
-        /// <summary>
-        /// Gets escaped text for a string
-        /// </summary>
-        /// <param name="text"></param>
-        /// <returns></returns>
-  /// <summary>
-  /// GetEscapedText method
-  /// </summary>
-		public static string GetEscapedText(string text)
-		{
-			var bytes = Encoding.GetEncoding(28591).GetBytes(text);
-			return String.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
-		}
-
-        /// <summary>
-        /// Gets debug text for a string
-        /// </summary>
-        /// <param name="text"></param>
-        /// <returns></returns>
-        /// <summary>
-        /// GetDebugText method
-        /// </summary>
-        public static string GetDebugText(string text)
-        {
-            return Regex.Replace(text, @"[^\u0020-\u007E]", a => GetEscapedText(a.Value));
-        }
-	}
+        public GenericCommMethodReceiveTextArgs() { }
+    }
 }

src/PepperDash.Core/Logging/Debug.cs

@@ -168,7 +168,7 @@ namespace PepperDash.Core
                 .WriteTo.File(new RenderedCompactJsonFormatter(), logFilePath,
                     rollingInterval: RollingInterval.Day,
                     restrictedToMinimumLevel: LogEventLevel.Debug,
-                    retainedFileCountLimit: CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance ? 30 : 60,
+                    retainedFileCountLimit: CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance ? 7 : 14,
                     levelSwitch: _fileLogLevelSwitch
                 );
 
@@ -1081,9 +1081,6 @@ namespace PepperDash.Core
         /// Logs to Console when at-level, and all messages to error log
         /// </summary>
         [Obsolete("Use LogMessage methods, Will be removed in 2.2.0 and later versions")]
-        /// <summary>
-        /// Console method
-        /// </summary>
         public static void Console(uint level, ErrorLogLevel errorLogLevel,
             string format, params object[] items)
         {
@@ -1096,9 +1093,6 @@ namespace PepperDash.Core
         /// it will only be written to the log.
         /// </summary>
         [Obsolete("Use LogMessage methods, Will be removed in 2.2.0 and later versions")]
-        /// <summary>
-        /// ConsoleWithLog method
-        /// </summary>
         public static void ConsoleWithLog(uint level, string format, params object[] items)
         {
             LogMessage(level, format, items);

src/PepperDash.Essentials.Core/Comm and IR/CecPortController.cs

@@ -12,15 +12,15 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core
 {
- /// <summary>
- /// Represents a CecPortController
- /// </summary>
-	public class CecPortController : Device, IBasicCommunicationWithStreamDebugging
+    /// <summary>
+    /// Represents a CecPortController
+    /// </summary>
+    public class CecPortController : Device, IBasicCommunicationWithStreamDebugging
     {
-  /// <summary>
-  /// Gets or sets the StreamDebugging
-  /// </summary>
-		public CommunicationStreamDebugging StreamDebugging { get; private set; }
+        /// <summary>
+        /// Gets or sets the StreamDebugging
+        /// </summary>
+        public CommunicationStreamDebugging StreamDebugging { get; private set; }
 
         public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
         public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
@@ -33,16 +33,16 @@ namespace PepperDash.Essentials.Core
         ICec Port;
 
         public CecPortController(string key, Func<EssentialsControlPropertiesConfig, ICec> postActivationFunc,
-            EssentialsControlPropertiesConfig config):base(key)
+            EssentialsControlPropertiesConfig config) : base(key)
         {
-			StreamDebugging = new CommunicationStreamDebugging(key);
+            StreamDebugging = new CommunicationStreamDebugging(key);
 
             AddPostActivationAction(() =>
             {
                 Port = postActivationFunc(config);
 
                 Port.StreamCec.CecChange += StreamCec_CecChange;
-            });            
+            });
         }
 
         public CecPortController(string key, ICec port)
@@ -58,27 +58,25 @@ namespace PepperDash.Essentials.Core
             if (args.EventId == CecEventIds.CecMessageReceivedEventId)
                 OnDataReceived(cecDevice.Received.StringValue);
             else if (args.EventId == CecEventIds.ErrorFeedbackEventId)
-                if(cecDevice.ErrorFeedback.BoolValue)
+                if (cecDevice.ErrorFeedback.BoolValue)
                     Debug.LogMessage(LogEventLevel.Verbose, this, "CEC NAK Error");
         }
 
         void OnDataReceived(string s)
         {
-			var bytesHandler = BytesReceived;
+            var bytesHandler = BytesReceived;
             if (bytesHandler != null)
             {
                 var bytes = Encoding.GetEncoding(28591).GetBytes(s);
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", ComTextHelper.GetEscapedText(bytes));
+                this.PrintReceivedBytes(bytes);
                 bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
             }
             var textHandler = TextReceived;
-			if (textHandler != null)
-			{
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", s);
-				textHandler(this, new GenericCommMethodReceiveTextArgs(s));
-			}
+            if (textHandler != null)
+            {
+                this.PrintReceivedText(s);
+                textHandler(this, new GenericCommMethodReceiveTextArgs(s));
+            }
         }
 
         #region IBasicCommunication Members
@@ -90,8 +88,7 @@ namespace PepperDash.Essentials.Core
         {
             if (Port == null)
                 return;
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+            this.PrintSentText(text);
             Port.StreamCec.Send.StringValue = text;
         }
 
@@ -103,8 +100,8 @@ namespace PepperDash.Essentials.Core
             if (Port == null)
                 return;
             var text = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+            this.PrintSentBytes(bytes);
+            Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
             Port.StreamCec.Send.StringValue = text;
         }
 

src/PepperDash.Essentials.Core/Comm and IR/ComPortController.cs

@@ -1,7 +1,9 @@
 using System;
 using System.Text;
 using System.Text.RegularExpressions;
+using Crestron.SimplSharp;
 using Crestron.SimplSharpPro;
+using Crestron.SimplSharpPro.GeneralIO;
 using PepperDash.Core;
 using PepperDash.Core.Logging;
 using Serilog.Events;
@@ -23,10 +25,10 @@ namespace PepperDash.Essentials.Core
 		/// Event fired when bytes are received
 		/// </summary>
 		public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
-		
+
 		/// <summary>
-        /// Event fired when text is received
-        /// </summary>
+		/// Event fired when text is received
+		/// </summary>
 		public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
 
 		/// <summary>
@@ -38,12 +40,12 @@ namespace PepperDash.Essentials.Core
 		ComPort.ComPortSpec Spec;
 
 		/// <summary>
-        /// Constructor
-        /// </summary>
-        /// <param name="key"></param>
-        /// <param name="postActivationFunc"></param>
-        /// <param name="spec"></param>
-        /// <param name="config"></param>
+		/// Constructor
+		/// </summary>
+		/// <param name="key"></param>
+		/// <param name="postActivationFunc"></param>
+		/// <param name="spec"></param>
+		/// <param name="config"></param>
 		public ComPortController(string key, Func<EssentialsControlPropertiesConfig, ComPort> postActivationFunc,
 			ComPort.ComPortSpec spec, EssentialsControlPropertiesConfig config) : base(key)
 		{
@@ -85,36 +87,32 @@ namespace PepperDash.Essentials.Core
 		{
 			if (Port == null)
 			{
-				Debug.LogMessage(LogEventLevel.Information, this, "Configured com Port for this device does not exist.");
+				this.LogInformation($"Configured {Port.Parent.GetType().Name}-comport-{Port.ID} for {Key} does not exist.");
 				return;
 			}
-			// TODO [ ] - Remove commented out code once verified working
-			//if (Port.Parent is CrestronControlSystem || Port.Parent is CenIoCom102)
-			if (Port.Parent is GenericBase genericDevice && genericDevice.Registerable)
+
+			var result = Port.Register();
+			if (result != eDeviceRegistrationUnRegistrationResponse.Success)
 			{
-				//this.LogInformation($"INFO: Attempting to register {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID}");
-				var result = genericDevice.Register();
-				if (result != eDeviceRegistrationUnRegistrationResponse.Success)
-				{
-					this.LogError($"ERROR: Cannot register {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {result})");
-					return; // false
-				}
+				this.LogError($"Cannot register {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {result})");
+				return;
 			}
-			
+			this.LogInformation($"Successfully registered {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {result})");
+
 			var specResult = Port.SetComPortSpec(Spec);
 			if (specResult != 0)
 			{
-				this.LogError($"ERROR: Cannot set comspec for {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {specResult})");
+				this.LogError($"Cannot set comspec for {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {specResult})");
 				return;
 			}
-			//this.LogInformation($"INFO: Successfully set comspec for {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {specResult})");
+			this.LogInformation($"Successfully set comspec for {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {specResult})");
 
 
 			// TODO [ ] - Remove debug logging once verified working
 			// if (Port.Parent is CenIoCom102)
-			// {				
+			// {
 			// 	Port.PropertyChanged += (s, e) =>
-			// 	{					
+			// 	{
 			// 		this.LogInformation($@"RegisterAndConfigureComPort: PropertyChanged Fired >> 
 			// 			comPort-'{Port.ID}', 
 			// 			Property Changed-'{e.Property}', 
@@ -165,16 +163,14 @@ namespace PepperDash.Essentials.Core
 			if (bytesHandler != null)
 			{
 				var bytes = Encoding.GetEncoding(28591).GetBytes(s);
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", ComTextHelper.GetEscapedText(bytes));
+				this.PrintReceivedBytes(bytes);
 				bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
 				eventSubscribed = true;
 			}
 			var textHandler = TextReceived;
 			if (textHandler != null)
 			{
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", s);
+				this.PrintReceivedText(s);
 				textHandler(this, new GenericCommMethodReceiveTextArgs(s));
 				eventSubscribed = true;
 			}
@@ -201,8 +197,7 @@ namespace PepperDash.Essentials.Core
 			if (Port == null)
 				return;
 
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+			this.PrintSentText(text);
 			Port.Send(text);
 		}
 
@@ -214,8 +209,7 @@ namespace PepperDash.Essentials.Core
 			if (Port == null)
 				return;
 			var text = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+			this.PrintSentBytes(bytes);
 
 			Port.Send(text);
 		}

src/PepperDash.Essentials.Core/Web/RequestHandlers/SetDeviceStreamDebugRequestHandler.cs

@@ -6,9 +6,9 @@ using PepperDash.Core.Web.RequestHandlers;
 
 namespace PepperDash.Essentials.Core.Web.RequestHandlers
 {
- /// <summary>
- /// Represents a SetDeviceStreamDebugRequestHandler
- /// </summary>
+	/// <summary>
+	/// Represents a SetDeviceStreamDebugRequestHandler
+	/// </summary>
 	public class SetDeviceStreamDebugRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>
@@ -122,23 +122,23 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 				return;
 			}
 
-            if (!(DeviceManager.GetDeviceForKey(body.DeviceKey) is IStreamDebugging device))
-            {
-                context.Response.StatusCode = 404;
-                context.Response.StatusDescription = "Not Found";
-                context.Response.End();
+			if (!(DeviceManager.GetDeviceForKey(body.DeviceKey) is IStreamDebugging device))
+			{
+				context.Response.StatusCode = 404;
+				context.Response.StatusDescription = "Not Found";
+				context.Response.End();
 
-                return;
-            }
+				return;
+			}
 
-            eStreamDebuggingSetting debugSetting;
+			eStreamDebuggingSetting debugSetting;
 			try
 			{
-				debugSetting = (eStreamDebuggingSetting) Enum.Parse(typeof (eStreamDebuggingSetting), body.Setting, true);				
+				debugSetting = (eStreamDebuggingSetting)Enum.Parse(typeof(eStreamDebuggingSetting), body.Setting, true);
 			}
 			catch (Exception ex)
 			{
-                Debug.LogMessage(ex, "Exception handling set debug request");
+				Debug.LogMessage(ex, "Exception handling set debug request");
 				context.Response.StatusCode = 500;
 				context.Response.StatusDescription = "Internal Server Error";
 				context.Response.End();
@@ -164,7 +164,7 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 			}
 			catch (Exception ex)
 			{
-                Debug.LogMessage(ex, "Exception handling set debug request");
+				Debug.LogMessage(ex, "Exception handling set debug request");
 				context.Response.StatusCode = 500;
 				context.Response.StatusDescription = "Internal Server Error";
 				context.Response.End();
@@ -198,21 +198,21 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers
 	public class SetDeviceStreamDebugConfig
 	{
 		[JsonProperty("deviceKey", NullValueHandling = NullValueHandling.Include)]
-  /// <summary>
-  /// Gets or sets the DeviceKey
-  /// </summary>
+		/// <summary>
+		/// Gets or sets the DeviceKey
+		/// </summary>
 		public string DeviceKey { get; set; }
 
 		[JsonProperty("setting", NullValueHandling = NullValueHandling.Include)]
-  /// <summary>
-  /// Gets or sets the Setting
-  /// </summary>
+		/// <summary>
+		/// Gets or sets the Setting
+		/// </summary>
 		public string Setting { get; set; }
 
 		[JsonProperty("timeout")]
-  /// <summary>
-  /// Gets or sets the Timeout
-  /// </summary>
+		/// <summary>
+		/// Gets or sets the Timeout
+		/// </summary>
 		public int Timeout { get; set; }
 
 		public SetDeviceStreamDebugConfig()

src/PepperDash.Essentials.MobileControl.Messengers/Messengers/MessengerBase.cs

@@ -31,7 +31,12 @@ namespace PepperDash.Essentials.AppServer.Messengers
         /// <remarks>
         /// Unsoliciited feedback from a device in a messenger will ONLY be sent to devices in this subscription list. When a client disconnects, it's ID will be removed from the collection.
         /// </remarks>
-        protected HashSet<string> SubscriberIds = new HashSet<string>();
+        private readonly HashSet<string> subscriberIds = new HashSet<string>();
+
+        /// <summary>
+        /// Lock object for thread-safe access to SubscriberIds
+        /// </summary>
+        private readonly object _subscriberLock = new object();
 
         private readonly List<string> _deviceInterfaces;
 
@@ -193,14 +198,15 @@ namespace PepperDash.Essentials.AppServer.Messengers
                 return;
             }
 
-            if (SubscriberIds.Any(id => id == clientId))
+            lock (_subscriberLock)
             {
-                this.LogVerbose("Client {clientId} already subscribed", clientId);
-                return;
+                if (!subscriberIds.Add(clientId))
+                {
+                    this.LogVerbose("Client {clientId} already subscribed", clientId);
+                    return;
+                }
             }
 
-            SubscriberIds.Add(clientId);
-
             this.LogDebug("Client {clientId} subscribed", clientId);
         }
 
@@ -216,14 +222,22 @@ namespace PepperDash.Essentials.AppServer.Messengers
                 return;
             }
 
-            if (!SubscriberIds.Any(i => i == clientId))
+            bool wasSubscribed;
+            lock (_subscriberLock)
+            {
+                wasSubscribed = subscriberIds.Contains(clientId);
+                if (wasSubscribed)
+                {
+                    subscriberIds.Remove(clientId);
+                }
+            }
+
+            if (!wasSubscribed)
             {
                 this.LogVerbose("Client with ID {clientId} is not subscribed", clientId);
                 return;
             }
 
-            SubscriberIds.RemoveWhere((i) => i == clientId);
-
             this.LogInformation("Client with ID {clientId} unsubscribed", clientId);
         }
 
@@ -312,7 +326,14 @@ namespace PepperDash.Essentials.AppServer.Messengers
                 // If client is null or empty, this message is unsolicited feedback. Iterate through the subscriber list and send to all interested parties
                 if (string.IsNullOrEmpty(clientId))
                 {
-                    foreach (var client in SubscriberIds)
+                    // Create a snapshot of subscribers to avoid collection modification during iteration
+                    List<string> subscriberSnapshot;
+                    lock (_subscriberLock)
+                    {
+                        subscriberSnapshot = new List<string>(subscriberIds);
+                    }
+
+                    foreach (var client in subscriberSnapshot)
                     {
                         AppServerController?.SendMessageObject(new MobileControlMessage { Type = !string.IsNullOrEmpty(type) ? type : MessagePath, ClientId = client, Content = content });
                     }

src/PepperDash.Essentials.MobileControl/Touchpanel/ThemeMessenger.cs

@@ -40,7 +40,7 @@ namespace PepperDash.Essentials.Touchpanel
                 this.LogInformation("Setting theme to {theme}", theme.Value);
                 _tpDevice.UpdateTheme(theme.Value);
 
-                PostStatusMessage(JToken.FromObject(new { theme = theme.Value }), id);
+                PostStatusMessage(JToken.FromObject(new { theme = theme.Value }), clientId: id);
             });
         }
     }