Merge pull request #1351 from PepperDash/stream-debugging

fix: centralize debug printing into extension methods

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;
@@ -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

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Text;
 using System.Threading;
 using Crestron.SimplSharp;
@@ -11,11 +12,12 @@ using Renci.SshNet.Common;
 namespace PepperDash.Core
 {
     /// <summary>
-    /// 
+    /// SSH Client
     /// </summary>
     public class GenericSshClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect
     {
         private const string SPlusKey = "Uninitialized SshClient";
+
         /// <summary>
         /// Object to enable stream debugging
         /// </summary>
@@ -36,11 +38,6 @@ namespace PepperDash.Core
         /// </summary>
         public event EventHandler<GenericSocketStatusChageEventArgs> ConnectionChange;
 
-        /// <summary>
-        ///// 
-        ///// </summary>
-        //public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
-
         /// <summary>
         /// Gets or sets the Hostname
         /// </summary>
@@ -67,7 +64,7 @@ namespace PepperDash.Core
         public bool IsConnected
         {
             // returns false if no client or not connected
-            get { return Client != null && ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; }
+            get { return client != null && ClientStatus == SocketStatus.SOCKET_STATUS_CONNECTED; }
         }
 
         /// <summary>
@@ -83,16 +80,26 @@ namespace PepperDash.Core
         /// </summary>
         public SocketStatus ClientStatus
         {
-            get { return _ClientStatus; }
+            get { lock (_stateLock) { return _ClientStatus; } }
             private set
             {
-                if (_ClientStatus == value)
+                bool shouldFireEvent = false;
-                    return;
+                lock (_stateLock)
+                {
+                    if (_ClientStatus != value)
+                    {
                         _ClientStatus = value;
+                        shouldFireEvent = true;
+                    }
+                }
+                // Fire event outside lock to avoid deadlock
+                if (shouldFireEvent)
                     OnConnectionChange();
             }
         }
-        SocketStatus _ClientStatus;
+
+        private SocketStatus _ClientStatus;
+        private bool _ConnectEnabled;
 
         /// <summary>
         /// Contains the familiar Simpl analog status values. This drives the ConnectionChange event
@@ -100,7 +107,7 @@ namespace PepperDash.Core
         /// </summary>
         public ushort UStatus
         {
-            get { return (ushort)_ClientStatus; }
+            get { lock (_stateLock) { return (ushort)_ClientStatus; } }
         }
 
         /// <summary>
@@ -111,7 +118,11 @@ namespace PepperDash.Core
         /// <summary>
         /// Will be set and unset by connect and disconnect only
         /// </summary>
-        public bool ConnectEnabled { get; private set; }
+        public bool ConnectEnabled
+        {
+            get { lock (_stateLock) { return _ConnectEnabled; } }
+            private set { lock (_stateLock) { _ConnectEnabled = value; } }
+        }
 
         /// <summary>
         /// S+ helper for AutoReconnect
@@ -127,17 +138,25 @@ namespace PepperDash.Core
         /// </summary>
         public int AutoReconnectIntervalMs { get; set; }
 
-        SshClient Client;
+        private SshClient client;
 
-        ShellStream TheStream;
+        private ShellStream shellStream;
 
-        CTimer ReconnectTimer;
+        private readonly Timer reconnectTimer;
 
         //Lock object to prevent simulatneous connect/disconnect operations
         //private CCriticalSection connectLock = new CCriticalSection();
-        private SemaphoreSlim connectLock = new SemaphoreSlim(1);
+        private readonly SemaphoreSlim connectLock = new SemaphoreSlim(1);
 
-        private bool DisconnectLogged = false;
+        // Thread-safety lock for state changes
+        private readonly object _stateLock = new object();
+
+        private bool disconnectLogged = false;
+
+        /// <summary>
+        /// When true, turns off echo for the SSH session
+        /// </summary>
+        public bool DisableEcho { get; set; }
 
         /// <summary>
         /// Typical constructor.
@@ -154,13 +173,13 @@ namespace PepperDash.Core
             Password = password;
             AutoReconnectIntervalMs = 5000;
 
-            ReconnectTimer = new CTimer(o =>
+            reconnectTimer = new Timer(o =>
                 {
-                    if (ConnectEnabled)
+                    if (ConnectEnabled) // Now thread-safe property access
                     {
                         Connect();
                     }
-                }, System.Threading.Timeout.Infinite);
+                }, null, System.Threading.Timeout.Infinite, System.Threading.Timeout.Infinite);
         }
 
         /// <summary>
@@ -172,23 +191,23 @@ namespace PepperDash.Core
             CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
             AutoReconnectIntervalMs = 5000;
 
-            ReconnectTimer = new CTimer(o =>
+            reconnectTimer = new Timer(o =>
             {
-                if (ConnectEnabled)
+                if (ConnectEnabled) // Now thread-safe property access
                 {
                     Connect();
                 }
-            }, System.Threading.Timeout.Infinite);
+            }, null, System.Threading.Timeout.Infinite, System.Threading.Timeout.Infinite);
         }
 
         /// <summary>
         /// Handles closing this up when the program shuts down
         /// </summary>
-        void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType)
+        private void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType)
         {
             if (programEventType == eProgramStatusEventType.Stopping)
             {
-                if (Client != null)
+                if (client != null)
                 {
                     this.LogDebug("Program stopping. Closing connection");
                     Disconnect();
@@ -223,10 +242,10 @@ namespace PepperDash.Core
                     this.LogDebug("Attempting connect");
 
                     // Cancel reconnect if running.
-                    ReconnectTimer?.Stop();
+                    StopReconnectTimer();
 
                     // Cleanup the old client if it already exists
-                    if (Client != null)
+                    if (client != null)
                     {
                         this.LogDebug("Cleaning up disconnected client");
                         KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY);
@@ -239,29 +258,36 @@ namespace PepperDash.Core
 
                     this.LogDebug("Creating new SshClient");
                     ConnectionInfo connectionInfo = new ConnectionInfo(Hostname, Port, Username, pauth, kauth);
-                    Client = new SshClient(connectionInfo);
+                    client = new SshClient(connectionInfo);
-                    Client.ErrorOccurred += Client_ErrorOccurred;
+                    client.ErrorOccurred += Client_ErrorOccurred;
 
                     //Attempt to connect
                     ClientStatus = SocketStatus.SOCKET_STATUS_WAITING;
                     try
                     {
-                        Client.Connect();
+                        client.Connect();
-                        TheStream = Client.CreateShellStream("PDTShell", 0, 0, 0, 0, 65534);
+
-                        if (TheStream.DataAvailable)
+                        var modes = new Dictionary<TerminalModes, uint>();
+
+                        if (DisableEcho)
+                        {
+                            modes.Add(TerminalModes.ECHO, 0);
+                        }
+
+                        shellStream = client.CreateShellStream("PDTShell", 0, 0, 0, 0, 65534, modes);
+                        if (shellStream.DataAvailable)
                         {
                             // empty the buffer if there is data
-                            string str = TheStream.Read();
+                            shellStream.Read();
                         }
-                        TheStream.DataReceived += Stream_DataReceived;
+                        shellStream.DataReceived += Stream_DataReceived;
                         this.LogInformation("Connected");
                         ClientStatus = SocketStatus.SOCKET_STATUS_CONNECTED;
-                        DisconnectLogged = false;
+                        disconnectLogged = false;
                     }
                     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)
                         {
@@ -286,37 +312,36 @@ namespace PepperDash.Core
                             this.LogVerbose(ie, "Exception details: ");
                         }
 
-                        DisconnectLogged = true;
+                        disconnectLogged = true;
                         KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
                         if (AutoReconnect)
                         {
                             this.LogDebug("Checking autoreconnect: {autoReconnect}, {autoReconnectInterval}ms", AutoReconnect, AutoReconnectIntervalMs);
-                            ReconnectTimer.Reset(AutoReconnectIntervalMs);
+                            StartReconnectTimer();
                         }
                     }
                     catch (SshOperationTimeoutException ex)
                     {
                         this.LogWarning("Connection attempt timed out: {message}", ex.Message);
 
-                        DisconnectLogged = true;
+                        disconnectLogged = true;
                         KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
                         if (AutoReconnect)
                         {
                             this.LogDebug("Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs);
-                            ReconnectTimer.Reset(AutoReconnectIntervalMs);
+                            StartReconnectTimer();
                         }
                     }
                     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;
+                        disconnectLogged = true;
                         KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
                         if (AutoReconnect)
                         {
                             this.LogDebug("Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs);
-                            ReconnectTimer.Reset(AutoReconnectIntervalMs);
+                            StartReconnectTimer();
                         }
                     }
                 }
@@ -334,11 +359,7 @@ namespace PepperDash.Core
         {
             ConnectEnabled = false;
             // Stop trying reconnects, if we are
-            if (ReconnectTimer != null)
+            StopReconnectTimer();
-            {
-                ReconnectTimer.Stop();
-                // ReconnectTimer = null;
-            }
 
             KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY);
         }
@@ -352,12 +373,12 @@ namespace PepperDash.Core
 
             try
             {
-                if (Client != null)
+                if (client != null)
                 {
-                    Client.ErrorOccurred -= Client_ErrorOccurred;
+                    client.ErrorOccurred -= Client_ErrorOccurred;
-                    Client.Disconnect();
+                    client.Disconnect();
-                    Client.Dispose();
+                    client.Dispose();
-                    Client = null;
+                    client = null;
                     ClientStatus = status;
                     this.LogDebug("Disconnected");
                 }
@@ -371,16 +392,16 @@ namespace PepperDash.Core
         /// <summary>
         /// Kills the stream
         /// </summary>
-		void KillStream()
+        private void KillStream()
         {
             try
             {
-                if (TheStream != null)
+                if (shellStream != null)
                 {
-                    TheStream.DataReceived -= Stream_DataReceived;
+                    shellStream.DataReceived -= Stream_DataReceived;
-                    TheStream.Close();
+                    shellStream.Close();
-                    TheStream.Dispose();
+                    shellStream.Dispose();
-                    TheStream = null;
+                    shellStream = null;
                     this.LogDebug("Disconnected stream");
                 }
             }
@@ -393,7 +414,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Handles the keyboard interactive authentication, should it be required.
         /// </summary>
-        void kauth_AuthenticationPrompt(object sender, AuthenticationPromptEventArgs e)
+        private void kauth_AuthenticationPrompt(object sender, AuthenticationPromptEventArgs e)
         {
             foreach (AuthenticationPrompt prompt in e.Prompts)
                 if (prompt.Request.IndexOf("Password:", StringComparison.InvariantCultureIgnoreCase) != -1)
@@ -403,7 +424,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Handler for data receive on ShellStream.  Passes data across to queue for line parsing.
         /// </summary>
-        void Stream_DataReceived(object sender, ShellDataEventArgs e)
+        private void Stream_DataReceived(object sender, ShellDataEventArgs e)
         {
             if (((ShellStream)sender).Length <= 0L)
             {
@@ -416,18 +437,14 @@ namespace PepperDash.Core
             if (bytesHandler != null)
             {
                 var bytes = Encoding.UTF8.GetBytes(response);
-                if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                this.PrintReceivedBytes(bytes);
-                {
-                    this.LogInformation("Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                }
                 bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
             }
 
             var textHandler = TextReceived;
             if (textHandler != null)
             {
-                if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                this.PrintReceivedText(response);
-                    this.LogInformation("Received: '{0}'", ComTextHelper.GetDebugText(response));
 
                 textHandler(this, new GenericCommMethodReceiveTextArgs(response));
             }
@@ -439,7 +456,7 @@ namespace PepperDash.Core
         /// Error event handler for client events - disconnect, etc.  Will forward those events via ConnectionChange
         /// event
         /// </summary>
-        void Client_ErrorOccurred(object sender, ExceptionEventArgs e)
+        private void Client_ErrorOccurred(object sender, ExceptionEventArgs e)
         {
             CrestronInvoke.BeginInvoke(o =>
             {
@@ -459,7 +476,7 @@ namespace PepperDash.Core
                 if (AutoReconnect && ConnectEnabled)
                 {
                     this.LogDebug("Checking autoreconnect: {0}, {1}ms", AutoReconnect, AutoReconnectIntervalMs);
-                    ReconnectTimer.Reset(AutoReconnectIntervalMs);
+                    StartReconnectTimer();
                 }
             });
         }
@@ -467,7 +484,7 @@ namespace PepperDash.Core
         /// <summary>
         /// Helper for ConnectionChange event
         /// </summary>
-        void OnConnectionChange()
+        private void OnConnectionChange()
         {
             ConnectionChange?.Invoke(this, new GenericSocketStatusChageEventArgs(this));
         }
@@ -482,16 +499,12 @@ namespace PepperDash.Core
         {
             try
             {
-                if (Client != null && TheStream != null && IsConnected)
+                if (client != null && shellStream != null && IsConnected)
                 {
-                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                    this.PrintSentText(text);
-                        this.LogInformation(
-                                      "Sending {length} characters of text: '{text}'",
-                                      text.Length,
-                                      ComTextHelper.GetDebugText(text));
 
-                    TheStream.Write(text);
+                    shellStream.Write(text);
-                    TheStream.Flush();
+                    shellStream.Flush();
                 }
                 else
                 {
@@ -503,7 +516,7 @@ namespace PepperDash.Core
                 this.LogError("ObjectDisposedException sending '{message}'. Restarting connection...", text.Trim());
 
                 KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
-                ReconnectTimer.Reset();
+                StartReconnectTimer();
             }
             catch (Exception ex)
             {
@@ -519,13 +532,12 @@ namespace PepperDash.Core
         {
             try
             {
-                if (Client != null && TheStream != null && IsConnected)
+                if (client != null && shellStream != null && IsConnected)
                 {
-                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                    this.PrintSentBytes(bytes);
-                        this.LogInformation("Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
 
-                    TheStream.Write(bytes, 0, bytes.Length);
+                    shellStream.Write(bytes, 0, bytes.Length);
-                    TheStream.Flush();
+                    shellStream.Flush();
                 }
                 else
                 {
@@ -537,7 +549,7 @@ namespace PepperDash.Core
                 this.LogException(ex, "ObjectDisposedException sending {message}", ComTextHelper.GetEscapedText(bytes));
 
                 KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
-                ReconnectTimer.Reset();
+                StartReconnectTimer();
             }
             catch (Exception ex)
             {
@@ -546,6 +558,83 @@ namespace PepperDash.Core
         }
         #endregion
 
+        /// <summary>
+        /// Safely starts the reconnect timer with exception handling
+        /// </summary>
+        private void StartReconnectTimer()
+        {
+            try
+            {
+                reconnectTimer?.Change(AutoReconnectIntervalMs, System.Threading.Timeout.Infinite);
+            }
+            catch (ObjectDisposedException)
+            {
+                // Timer was disposed, ignore
+                this.LogDebug("Attempted to start timer but it was already disposed");
+            }
+        }
+
+        /// <summary>
+        /// Safely stops the reconnect timer with exception handling
+        /// </summary>
+        private void StopReconnectTimer()
+        {
+            try
+            {
+                reconnectTimer?.Change(System.Threading.Timeout.Infinite, System.Threading.Timeout.Infinite);
+            }
+            catch (ObjectDisposedException)
+            {
+                // Timer was disposed, ignore
+                this.LogDebug("Attempted to stop timer but it was already disposed");
+            }
+        }
+
+        /// <summary>
+        /// Deactivate method - properly dispose of resources
+        /// </summary>
+        public override bool Deactivate()
+        {
+            try
+            {
+                this.LogDebug("Deactivating SSH client - disposing resources");
+
+                // Stop trying reconnects
+                ConnectEnabled = false;
+                StopReconnectTimer();
+
+                // Disconnect and cleanup client
+                KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY);
+
+                // Dispose timer
+                try
+                {
+                    reconnectTimer?.Dispose();
+                }
+                catch (ObjectDisposedException)
+                {
+                    // Already disposed, ignore
+                }
+
+                // Dispose semaphore
+                try
+                {
+                    connectLock?.Dispose();
+                }
+                catch (ObjectDisposedException)
+                {
+                    // Already disposed, ignore
+                }
+
+                return base.Deactivate();
+            }
+            catch (Exception ex)
+            {
+                this.LogException(ex, "Error during SSH client deactivation");
+                return false;
+            }
+        }
+
     }
 
     //*****************************************************************************************************

src/PepperDash.Core/Comm/GenericTcpIpClient.cs

@@ -426,10 +426,7 @@ namespace PepperDash.Core
                     var bytesHandler = BytesReceived;
                     if (bytesHandler != null)
                     {
-                        if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                        this.PrintReceivedBytes(bytes);
-                        {
-                            Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                        }
                         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)
+                        this.PrintReceivedText(str);
-                        {
-                            Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length);
-                        }
 
                         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)
+            this.PrintSentText(text);
-                Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(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)
+            this.PrintSentBytes(bytes);
-                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
             if (_client != null)
                 _client.SendData(bytes, bytes.Length);
         }
@@ -555,6 +547,12 @@ namespace PepperDash.Core
         /// </summary>
         public int AutoReconnectIntervalMs { get; set; }
 
+        /// <summary>
+        /// When true, turns off echo for the SSH session
+        /// </summary>
+        [JsonProperty("disableSshEcho")]
+        public bool DisableSshEcho { get; set; }
+
         /// <summary>
         /// Default constructor
         /// </summary>
@@ -565,8 +563,7 @@ namespace PepperDash.Core
             AutoReconnectIntervalMs = 5000;
             Username = "";
             Password = "";
+            DisableSshEcho = false;
         }
-
     }
-
 }

src/PepperDash.Core/Comm/GenericUdpServer.cs

@@ -281,17 +281,13 @@ namespace PepperDash.Core
                 var bytesHandler = BytesReceived;
                 if (bytesHandler != null)
                 {
-                    if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                    this.PrintReceivedBytes(bytes);
-                    {
-                        Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                    }
                     bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
                 }
                 var textHandler = TextReceived;
                 if (textHandler != null)
                 {
-                    if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                    this.PrintReceivedText(str);
-                        Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length);
                     textHandler(this, new GenericCommMethodReceiveTextArgs(str));
                 }
             }
@@ -318,8 +314,7 @@ namespace PepperDash.Core
 
             if (IsConnected && Server != null)
             {
-                if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                this.PrintSentText(text);
-                    Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text));
 
                 Server.SendData(bytes, bytes.Length);
             }
@@ -334,8 +329,7 @@ namespace PepperDash.Core
         /// </summary>
         public void SendBytes(byte[] bytes)
         {
-            if (StreamDebugging.TxStreamDebuggingIsEnabled)
+            this.PrintSentBytes(bytes);
-                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
 
             if (IsConnected && Server != null)
                 Server.SendData(bytes, bytes.Length);

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
@@ -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
@@ -205,49 +202,4 @@ namespace PepperDash.Core
         /// </summary>
         public GenericCommMethodReceiveTextArgs() { }
     }
-
-
-
-	/// <summary>
-	/// 
-	/// </summary>
-	public class ComTextHelper
-	{
-        /// <summary>
-        /// Gets escaped text for a byte array
-        /// </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));
-        }
-	}
 }

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

@@ -68,15 +68,13 @@ namespace PepperDash.Essentials.Core
             if (bytesHandler != null)
             {
                 var bytes = Encoding.GetEncoding(28591).GetBytes(s);
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                this.PrintReceivedBytes(bytes);
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", ComTextHelper.GetEscapedText(bytes));
                 bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
             }
             var textHandler = TextReceived;
             if (textHandler != null)
             {
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                this.PrintReceivedText(s);
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", s);
                 textHandler(this, new GenericCommMethodReceiveTextArgs(s));
             }
         }
@@ -90,8 +88,7 @@ namespace PepperDash.Essentials.Core
         {
             if (Port == null)
                 return;
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
+            this.PrintSentText(text);
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} characters of text: '{1}'", text.Length, text);
             Port.StreamCec.Send.StringValue = text;
         }
 
@@ -103,7 +100,7 @@ namespace PepperDash.Essentials.Core
             if (Port == null)
                 return;
             var text = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
+            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

@@ -165,16 +165,14 @@ namespace PepperDash.Essentials.Core
 			if (bytesHandler != null)
 			{
 				var bytes = Encoding.GetEncoding(28591).GetBytes(s);
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
+				this.PrintReceivedBytes(bytes);
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", ComTextHelper.GetEscapedText(bytes));
 				bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
 				eventSubscribed = true;
 			}
 			var textHandler = TextReceived;
 			if (textHandler != null)
 			{
-				if (StreamDebugging.RxStreamDebuggingIsEnabled)
+				this.PrintReceivedText(s);
-					Debug.LogMessage(LogEventLevel.Information, this, "Received: '{0}'", s);
 				textHandler(this, new GenericCommMethodReceiveTextArgs(s));
 				eventSubscribed = true;
 			}
@@ -201,8 +199,7 @@ namespace PepperDash.Essentials.Core
 			if (Port == null)
 				return;
 
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
+			this.PrintSentText(text);
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} characters of text: '{1}'", text.Length, text);
 			Port.Send(text);
 		}
 
@@ -214,8 +211,7 @@ namespace PepperDash.Essentials.Core
 			if (Port == null)
 				return;
 			var text = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
-			if (StreamDebugging.TxStreamDebuggingIsEnabled)
+			this.PrintSentBytes(bytes);
-				Debug.LogMessage(LogEventLevel.Information, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
 
 			Port.Send(text);
 		}

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

@@ -64,8 +64,11 @@ namespace PepperDash.Essentials.Core
 						break;
 					case eControlMethod.Ssh:
 						{
-							var ssh = new GenericSshClient(deviceConfig.Key + "-ssh", c.Address, c.Port, c.Username, c.Password);
+							var ssh = new GenericSshClient(deviceConfig.Key + "-ssh", c.Address, c.Port, c.Username, c.Password)
-							ssh.AutoReconnect = c.AutoReconnect;
+							{
+								AutoReconnect = c.AutoReconnect,
+								DisableEcho = c.DisableSshEcho
+							};
 							if (ssh.AutoReconnect)
 								ssh.AutoReconnectIntervalMs = c.AutoReconnectIntervalMs;
 							comm = ssh;
@@ -73,8 +76,10 @@ namespace PepperDash.Essentials.Core
 						}
 					case eControlMethod.Tcpip:
 						{
-							var tcp = new GenericTcpIpClient(deviceConfig.Key + "-tcp", c.Address, c.Port, c.BufferSize);
+							var tcp = new GenericTcpIpClient(deviceConfig.Key + "-tcp", c.Address, c.Port, c.BufferSize)
-							tcp.AutoReconnect = c.AutoReconnect;
+							{
+								AutoReconnect = c.AutoReconnect
+							};
 							if (tcp.AutoReconnect)
 								tcp.AutoReconnectIntervalMs = c.AutoReconnectIntervalMs;
 							comm = tcp;
@@ -90,8 +95,10 @@ namespace PepperDash.Essentials.Core
 						break;
 					case eControlMethod.SecureTcpIp:
 						{
-							var secureTcp = new GenericSecureTcpIpClient(deviceConfig.Key + "-secureTcp", c.Address, c.Port, c.BufferSize);
+							var secureTcp = new GenericSecureTcpIpClient(deviceConfig.Key + "-secureTcp", c.Address, c.Port, c.BufferSize)
-							secureTcp.AutoReconnect = c.AutoReconnect;
+							{
+								AutoReconnect = c.AutoReconnect
+							};
 							if (secureTcp.AutoReconnect)
 								secureTcp.AutoReconnectIntervalMs = c.AutoReconnectIntervalMs;
 							comm = secureTcp;