Merge pull request #26 from PepperDash/feature/IBasicCommunication-Stream-Debugging

Add IStreamDebugging and associated logic

Pepperdash Core/Pepperdash Core/Comm/CommunicationStreamDebugging.cs

@@ -0,0 +1,121 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using PepperDash.Core;
+
+namespace PepperDash.Core
+{
+    /// <summary>
+    /// Controls the ability to disable/enable debugging of TX/RX data sent to/from a device with a built in timer to disable
+    /// </summary>
+    public class CommunicationStreamDebugging
+    {
+        /// <summary>
+        /// Device Key that this instance configures
+        /// </summary>
+        public string ParentDeviceKey { get; private set; }
+
+        /// <summary>
+        /// Timer to disable automatically if not manually disabled
+        /// </summary>
+        private CTimer DebugExpiryPeriod;
+
+        public eStreamDebuggingSetting DebugSetting { get; private set; }
+
+        private uint _DebugTimeoutInMs;
+        private const uint _DefaultDebugTimeoutMin = 30;
+
+        /// <summary>
+        /// Timeout in Minutes
+        /// </summary>
+        public uint DebugTimeoutMinutes
+        {
+            get
+            {
+                return _DebugTimeoutInMs/60000;
+            }
+        }
+
+        public bool RxStreamDebuggingIsEnabled{ get; private set; }
+
+        public bool TxStreamDebuggingIsEnabled { get; private set; }
+
+
+        public CommunicationStreamDebugging(string parentDeviceKey)
+        {
+            ParentDeviceKey = parentDeviceKey;
+        }
+
+
+        /// <summary>
+        /// Sets the debugging setting and if not setting to off, assumes the default of 30 mintues
+        /// </summary>
+        /// <param name="setting"></param>
+        public void SetDebuggingWithDefaultTimeout(eStreamDebuggingSetting setting)
+        {
+            if (setting == eStreamDebuggingSetting.Off)
+            {
+                DisableDebugging();
+            }
+            else
+            {
+                SetDebuggingWithSpecificTimeout(setting, _DefaultDebugTimeoutMin);
+            }    
+        }
+
+        /// <summary>
+        /// Sets the debugging setting for the specified number of minutes
+        /// </summary>
+        /// <param name="setting"></param>
+        /// <param name="minutes"></param>
+        public void SetDebuggingWithSpecificTimeout(eStreamDebuggingSetting setting, uint minutes)
+        {
+            _DebugTimeoutInMs = minutes * 60000;
+
+            if (DebugExpiryPeriod != null)
+            {
+                DisableDebugging();
+            }
+
+            DebugExpiryPeriod = new CTimer((o) => DisableDebugging(), _DebugTimeoutInMs);
+
+            if ((setting & eStreamDebuggingSetting.Rx) == eStreamDebuggingSetting.Rx)
+                RxStreamDebuggingIsEnabled = true;
+
+            if ((setting & eStreamDebuggingSetting.Tx) == eStreamDebuggingSetting.Tx)
+                TxStreamDebuggingIsEnabled = true;
+
+            Debug.SetDeviceDebugSettings(ParentDeviceKey, setting);
+        
+        }
+
+        /// <summary>
+        /// Disabled debugging
+        /// </summary>
+        public void DisableDebugging()
+        {
+            DebugExpiryPeriod.Stop();
+            DebugExpiryPeriod.Dispose();
+            DebugExpiryPeriod = null;
+
+            RxStreamDebuggingIsEnabled = false;
+            TxStreamDebuggingIsEnabled = false;
+
+            Debug.SetDeviceDebugSettings(ParentDeviceKey, eStreamDebuggingSetting.Off);
+        }
+    }
+
+    /// <summary>
+    /// The available settings for stream debugging
+    /// </summary>
+    [Flags]
+    public enum eStreamDebuggingSetting
+    {
+        Off = 0,
+        Rx = 1, 
+        Tx = 2,
+        Both = Rx | Tx
+    }
+}

Pepperdash Core/Pepperdash Core/Comm/GenericSshClient.cs

@@ -11,8 +11,10 @@ namespace PepperDash.Core
 	/// <summary>
 	/// 
 	/// </summary>
-	public class GenericSshClient : Device, ISocketStatus, IAutoReconnect
+    public class GenericSshClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect
 	{
+        public CommunicationStreamDebugging StreamDebugging { get; private set; }
+
 		/// <summary>
 		/// Event that fires when data is received.  Delivers args with byte array
 		/// </summary>
@@ -139,6 +141,7 @@ namespace PepperDash.Core
 		public GenericSshClient(string key, string hostname, int port, string username, string password) :
 			base(key)
 		{
+            StreamDebugging = new CommunicationStreamDebugging(key);
 			CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
 			Key = key;
 			Hostname = hostname;
@@ -240,7 +243,7 @@ namespace PepperDash.Core
             try
             {
                 Client.Connect();
-                TheStream = Client.CreateShellStream("PDTShell", 100, 80, 100, 200, 65534);
+                TheStream = Client.CreateShellStream("PDTShell", 100, 80, 100, 200, 100000);
                 TheStream.DataReceived += Stream_DataReceived;
                 //TheStream.ErrorOccurred += TheStream_ErrorOccurred;
                 Debug.Console(1, this, "Connected");
@@ -381,6 +384,10 @@ namespace PepperDash.Core
 				{
 					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);
+
 				}
 			}
 		}
@@ -422,8 +429,12 @@ namespace PepperDash.Core
 			{
                 if (Client != null)
                 {
+                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                        Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+
                     TheStream.Write(text);
                     TheStream.Flush();
+
                 }
 			}
 			catch
@@ -444,6 +455,9 @@ namespace PepperDash.Core
 			{
                 if (Client != null)
                 {
+                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                        Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+
                     TheStream.Write(bytes, 0, bytes.Length);
                     TheStream.Flush();
                 }

Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs

@@ -14,8 +14,10 @@ namespace PepperDash.Core
     /// <summary>
     /// A class to handle basic TCP/IP communications with a server
     /// </summary>
-	public class GenericTcpIpClient : Device, ISocketStatus, IAutoReconnect
+	public class GenericTcpIpClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect
 	{
+        public CommunicationStreamDebugging StreamDebugging { get; private set; }
+
 		/// <summary>
 		/// Fires when data is received from the server and returns it as a Byte array
 		/// </summary>
@@ -176,7 +178,7 @@ namespace PepperDash.Core
 		public GenericTcpIpClient(string key, string address, int port, int bufferSize)
 			: base(key)
 		{
-
+            StreamDebugging = new CommunicationStreamDebugging(key);
             Hostname = address;
             Port = port;
             BufferSize = bufferSize;
@@ -192,6 +194,7 @@ namespace PepperDash.Core
         public GenericTcpIpClient(string key)
             : base(key)
         {
+            StreamDebugging = new CommunicationStreamDebugging(key);
             CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
             AutoReconnectIntervalMs = 5000;
             BufferSize = 2000;
@@ -348,8 +351,15 @@ namespace PepperDash.Core
                     if (textHandler != null)
                     {
                         var str = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
+
+                        if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                            Debug.Console(0, this, "Recevied: '{0}'", str);
+
                         textHandler(this, new GenericCommMethodReceiveTextArgs(str));
+
                     }
+
+                    
                 }
 
                 client.ReceiveDataAsync(Receive);
@@ -363,10 +373,12 @@ namespace PepperDash.Core
 		{
 			var bytes = Encoding.GetEncoding(28591).GetBytes(text);
 			// Check debug level before processing byte array
-			//if (Debug.Level == 2)
+            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-			//    Debug.Console(2, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
             if(Client != null)
 			    Client.SendData(bytes, bytes.Length);
+
+
 		}
 
 		/// <summary>
@@ -388,8 +400,8 @@ namespace PepperDash.Core
         /// <param name="bytes"></param>
 		public void SendBytes(byte[] bytes)
 		{
-			//if (Debug.Level == 2)
+            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-			//    Debug.Console(2, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
             if(Client != null)
 			    Client.SendData(bytes, bytes.Length);
 		}

Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs

@@ -15,8 +15,9 @@ using Newtonsoft.Json.Linq;
 
 namespace PepperDash.Core
 {
-    public class GenericUdpServer : Device, IBasicCommunication, ISocketStatus
+    public class GenericUdpServer : Device, ISocketStatusWithStreamDebugging
     {
+        public CommunicationStreamDebugging StreamDebugging { get; private set; }
         /// <summary>
         /// 
         /// </summary>
@@ -138,6 +139,7 @@ namespace PepperDash.Core
         public GenericUdpServer(string key, string address, int port, int buffefSize)
             : base(key)
         {
+            StreamDebugging = new CommunicationStreamDebugging(key); 
             Hostname = address;
             Port = port;
             BufferSize = buffefSize;
@@ -268,8 +270,9 @@ namespace PepperDash.Core
                 var textHandler = TextReceived;
                 if (textHandler != null)
                 {
-                   
+                    if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                    Debug.Console(2, this, "RX: {0}", str);
+                        Debug.Console(0, this, "Recevied: '{0}'", str);
+                    
                     textHandler(this, new GenericCommMethodReceiveTextArgs(str));
                 }
                 else
@@ -323,7 +326,9 @@ namespace PepperDash.Core
 
             if (IsConnected && Server != null)
             {
-                Debug.Console(2, this, "TX: {0}", text);
+                if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                    Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+
                 Server.SendData(bytes, bytes.Length);
             }
         }
@@ -334,8 +339,9 @@ namespace PepperDash.Core
         /// <param name="bytes"></param>
         public void SendBytes(byte[] bytes)
         {
-            //if (Debug.Level == 2)
+            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-            //    Debug.Console(2, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+
             if (IsConnected && Server != null)
                 Server.SendData(bytes, bytes.Length);
         }

Pepperdash Core/Pepperdash Core/CommunicationExtras.cs

@@ -32,6 +32,22 @@ namespace PepperDash.Core
 		void SendBytes(byte[] bytes);
 	}
 
+    /// <summary>
+    /// Represents a device that implements IBasicCommunication and IStreamDebugging
+    /// </summary>
+    public interface IBasicCommunicationWithStreamDebugging : IBasicCommunication, IStreamDebugging
+    {
+
+    }
+
+    /// <summary>
+    /// Represents a device with stream debugging capablities
+    /// </summary>
+    public interface IStreamDebugging
+    {
+        CommunicationStreamDebugging StreamDebugging { get; }
+    }
+
 	/// <summary>
 	/// For IBasicCommunication classes that have SocketStatus. GenericSshClient,
 	/// GenericTcpIpClient
@@ -42,6 +58,13 @@ namespace PepperDash.Core
 		SocketStatus ClientStatus { get; }
 	}
 
+    /// <summary>
+    /// Represents a device that implements ISocketStatus and IStreamDebugging
+    /// </summary>
+    public interface ISocketStatusWithStreamDebugging : ISocketStatus, IStreamDebugging
+    {
+
+    }
 
 	public interface IAutoReconnect
 	{

Pepperdash Core/Pepperdash Core/Logging/Debug.cs

@@ -274,6 +274,28 @@ namespace PepperDash.Core
             }
         }
 
+        /// <summary>
+        /// sets the settings for a device or creates a new entry
+        /// </summary>
+        /// <param name="deviceKey"></param>
+        /// <param name="settings"></param>
+        /// <returns></returns>
+        public static void SetDeviceDebugSettings(string deviceKey, object settings)
+        {
+            Contexts.SetDebugSettingsForKey(deviceKey, settings);
+            SaveMemoryOnTimeout();
+        }
+
+        /// <summary>
+        /// Gets the device settings for a device by key or returns null
+        /// </summary>
+        /// <param name="deviceKey"></param>
+        /// <returns></returns>
+        public static object GetDeviceDebugSettingsForKey(string deviceKey)
+        {
+            return Contexts.GetDebugSettingsForKey(deviceKey);
+        }  
+
         /// <summary>
         /// Sets the flag to prevent application starting on next boot
         /// </summary>

Pepperdash Core/Pepperdash Core/Logging/DebugMemory.cs

@@ -5,16 +5,31 @@ using System.Text;
 using Crestron.SimplSharp;
 
 using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 
 namespace PepperDash.Core.DebugThings
 {
 	public class DebugContextCollection
 	{
+        /// <summary>
+        /// To prevent threading issues with the DeviceDebugSettings collection
+        /// </summary>
+        private CCriticalSection DeviceDebugSettingsLock;
+
 		[JsonProperty("items")]
 		Dictionary<string, DebugContextItem> Items;
 
+        /// <summary>
+        /// Collection of the debug settings for each device where the dictionary key is the device key
+        /// </summary>
+        [JsonProperty("deviceDebugSettings")]
+        private Dictionary<string, object> DeviceDebugSettings { get; set; }
+
+
 		public DebugContextCollection()
 		{
+            DeviceDebugSettingsLock = new CCriticalSection();
+            DeviceDebugSettings = new Dictionary<string, object>();
 			Items = new Dictionary<string, DebugContextItem>();
 		}
 
@@ -43,6 +58,35 @@ namespace PepperDash.Core.DebugThings
 				Items[contextKey] = new DebugContextItem(this) { Level = 0 };
 			return Items[contextKey];
 		}
+
+
+        /// <summary>
+        /// sets the settings for a device or creates a new entry
+        /// </summary>
+        /// <param name="deviceKey"></param>
+        /// <param name="settings"></param>
+        /// <returns></returns>
+        public void SetDebugSettingsForKey(string deviceKey, object settings)
+        {
+            var existingSettings = DeviceDebugSettings[deviceKey];
+
+            if (existingSettings != null)
+            {
+                existingSettings = settings;
+            }
+            else
+                DeviceDebugSettings.Add(deviceKey, settings);
+        }
+
+        /// <summary>
+        /// Gets the device settings for a device by key or returns null
+        /// </summary>
+        /// <param name="deviceKey"></param>
+        /// <returns></returns>
+        public object GetDebugSettingsForKey(string deviceKey)
+        {
+            return DeviceDebugSettings[deviceKey];
+        }
 	}
 
 	public class DebugContextItem
@@ -59,7 +103,6 @@ namespace PepperDash.Core.DebugThings
         [JsonProperty("doNotLoadOnNextBoot")]
         public bool DoNotLoadOnNextBoot { get; set; }
 
-
 		public DebugContextItem(DebugContextCollection parent)
 		{
 

Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj

@@ -69,6 +69,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="CommunicationExtras.cs" />
+    <Compile Include="Comm\CommunicationStreamDebugging.cs" />
     <Compile Include="Comm\ControlPropertiesConfig.cs" />
     <Compile Include="Comm\GenericTcpIpClient_ForServer.cs" />
     <Compile Include="Comm\GenericHttpSseClient.cs" />