Merge commit '314570d6c3d78c7a92a362f3ec3a4a06bdbebd28' into stream-debugging

Stream debugging now uses CrestronConsole instead of debug methods, so that the debug statements will be printed regardless of console debug level. This also means that comm debug statements will NOT be in the Crestron Error log or in the files created by the logging system

src/PepperDash.Core/ComTextHelper.cs

@@ -0,0 +1,43 @@
+using System.Linq;
+using System.Text;
+using System.Text.RegularExpressions;
+
+namespace PepperDash.Core
+{
+  /// <summary>
+  /// 
+  /// </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

@@ -439,18 +439,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 +503,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();
@@ -544,8 +536,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();

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);
         }

src/PepperDash.Core/Comm/GenericUdpServer.cs

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

src/PepperDash.Core/Comm/StreamDebuggingExtensionMethods.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 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/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)
-					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);
+                this.PrintReceivedText(s);
                 textHandler(this, new GenericCommMethodReceiveTextArgs(s));
             }
         }
@@ -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,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)
-					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 +199,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 +211,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);
 		}