Merge pull request #108 from PepperDash/release/1.0.48

1.0.48

Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs

@@ -379,18 +379,24 @@ namespace PepperDash.Core
 			if (bytes.Length > 0)
 			{
 				var bytesHandler = BytesReceived;
-				if (bytesHandler != null)
+			    if (bytesHandler != null)
-					bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
+			    {
+			        if (StreamDebugging.RxStreamDebuggingIsEnabled)
+			        {
+			            Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
+			        }
+                    bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
+			    }
+					
 				var textHandler = TextReceived;
 				if (textHandler != null)
 				{
 					var str = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
-					textHandler(this, new GenericCommMethodReceiveTextArgs(str));
-
                     if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                        Debug.Console(0, this, "Recevied: '{0}'", str);
+                        Debug.Console(0, this, "Received: '{0}'", ComTextHelper.GetDebugText(str));
 
-				}
+                    textHandler(this, new GenericCommMethodReceiveTextArgs(str));
+                }
 			}
 		}
 
@@ -432,7 +438,7 @@ namespace PepperDash.Core
                 if (Client != null)
                 {
                     if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                        Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+                        Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text));
 
                     TheStream.Write(text);
                     TheStream.Flush();

Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs

@@ -364,14 +364,20 @@ namespace PepperDash.Core
                     var bytes = client.IncomingDataBuffer.Take(numBytes).ToArray();
                     var bytesHandler = BytesReceived;
                     if (bytesHandler != null)
+                    {
+                        if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                        {
+                            Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
+                        }
                         bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
+                    }
                     var textHandler = TextReceived;
                     if (textHandler != null)
                     {
                         var str = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
 
                         if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                            Debug.Console(0, this, "Recevied: '{0}'", str);
+                            Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length);
 
                         textHandler(this, new GenericCommMethodReceiveTextArgs(str));
 
@@ -392,7 +398,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} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+                Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text));
             if(Client != null)
 			    Client.SendData(bytes, bytes.Length);
 

Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs

@@ -260,20 +260,20 @@ namespace PepperDash.Core
                 Debug.Console(2, this, "Bytes: {0}", bytes.ToString());
                 var bytesHandler = BytesReceived;
                 if (bytesHandler != null)
+                {
+                    if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                    {
+                        Debug.Console(0, this, "Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
+                    }
                     bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
-                else
+                }
-                    Debug.Console(2, this, "bytesHandler is null");
-
                 var textHandler = TextReceived;
                 if (textHandler != null)
                 {
                     if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                        Debug.Console(0, this, "Recevied: '{0}'", str);
+                        Debug.Console(0, this, "Received {1} characters of text: '{0}'", ComTextHelper.GetDebugText(str), str.Length);
-
                     textHandler(this, new GenericCommMethodReceiveTextArgs(str));
                 }
-                else
-                    Debug.Console(2, this, "textHandler is null");
             }
             catch (Exception ex)
             {
@@ -296,7 +296,7 @@ namespace PepperDash.Core
             if (IsConnected && Server != null)
             {
                 if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                    Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+                    Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, ComTextHelper.GetDebugText(text));
 
                 Server.SendData(bytes, bytes.Length);
             }

Pepperdash Core/Pepperdash Core/CommunicationExtras.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;
 using Crestron.SimplSharp.CrestronSockets;
-
+using System.Text.RegularExpressions;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
@@ -138,5 +138,10 @@ namespace PepperDash.Core
 			var bytes = Encoding.GetEncoding(28591).GetBytes(text);
 			return String.Concat(bytes.Select(b => string.Format(@"[{0:X2}]", (int)b)).ToArray());
 		}
+
+        public static string GetDebugText(string text)
+        {
+            return Regex.Replace(text, @"[^\u0020-\u007E]", a => GetEscapedText(a.Value));
+        }
 	}
 }

Pepperdash Core/Pepperdash Core/Device.cs

@@ -119,7 +119,14 @@ namespace PepperDash.Core
 		/// <returns></returns>
 		public virtual bool Deactivate() { return true; }
 
-		/// <summary>
+        /// <summary>
+        /// Call this method to start communications with a device. Overriding classes do not need to call base.Initialize()
+        /// </summary>
+	    public virtual void Initialize()
+	    {
+	    }
+
+	    /// <summary>
 		/// Helper method to check object for bool value false and fire an Action method
 		/// </summary>
 		/// <param name="o">Should be of type bool, others will be ignored</param>