Merge pull request #248 from PepperDash/feature/implement-IStreamDebugging-on-ComPortController

Add IStreamDebugging interface to ComPortController

essentials-framework/Essentials Core/PepperDashEssentialsBase/Comm and IR/ComPortController.cs

@@ -11,8 +11,10 @@ using PepperDash.Core;
 
 namespace PepperDash.Essentials.Core
 {
-	public class ComPortController : Device, IBasicCommunication
+	public class ComPortController : Device, IBasicCommunicationWithStreamDebugging
 	{
+        public CommunicationStreamDebugging StreamDebugging { get; private set; }
+
 		public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
 		public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
 
@@ -24,6 +26,8 @@ namespace PepperDash.Essentials.Core
 	    public ComPortController(string key, Func<EssentialsControlPropertiesConfig, ComPort> postActivationFunc,
 	        ComPort.ComPortSpec spec, EssentialsControlPropertiesConfig config) : base(key)
 	    {
+            StreamDebugging = new CommunicationStreamDebugging(key);
+
 	        Spec = spec;
 
             AddPostActivationAction(() =>
@@ -91,7 +95,12 @@ namespace PepperDash.Essentials.Core
             }
             var textHandler = TextReceived;
             if (textHandler != null)
+            {
+                if (StreamDebugging.RxStreamDebuggingIsEnabled)
+                    Debug.Console(0, this, "Recevied: '{0}'", s);
+
                 textHandler(this, new GenericCommMethodReceiveTextArgs(s));
+            }
         }
 
 		public override bool Deactivate()
@@ -105,7 +114,10 @@ namespace PepperDash.Essentials.Core
 		{
 			if (Port == null)
 				return;
-			Port.Send(text);
+
+            if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                Debug.Console(0, this, "Sending {0} characters of text: '{1}'", text.Length, text);
+            Port.Send(text);
 		}
 
 		public void SendBytes(byte[] bytes)
@@ -113,6 +125,9 @@ namespace PepperDash.Essentials.Core
 			if (Port == null)
 				return;
 			var text = Encoding.GetEncoding(28591).GetString(bytes, 0, bytes.Length);
+            if (StreamDebugging.TxStreamDebuggingIsEnabled)
+                Debug.Console(0, this, "Sending {0} bytes: '{1}'", bytes.Length, ComTextHelper.GetEscapedText(bytes));
+
 			Port.Send(text);
 		}
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/DeviceManager.cs

@@ -43,7 +43,10 @@ namespace PepperDash.Essentials.Core
 			CrestronConsole.AddNewConsoleCommand(s => CrestronConsole.ConsoleCommandResponse(DeviceJsonApi.GetApiMethods(s)), "apimethods", "", ConsoleAccessLevelEnum.AccessOperator);
             CrestronConsole.AddNewConsoleCommand(SimulateComReceiveOnDevice, "devsimreceive",
                 "Simulates incoming data on a com device", ConsoleAccessLevelEnum.AccessOperator);
-		}
+
+            CrestronConsole.AddNewConsoleCommand(s => SetDeviceStreamDebugging(s), "setdevicestreamdebug", "set comm debug [deviceKey] [off/rx/tx/both] ([minutes])", ConsoleAccessLevelEnum.AccessOperator);
+            CrestronConsole.AddNewConsoleCommand(s => DisableAllDeviceStreamDebugging(), "disableallstreamdebug", "disables stream debugging on all devices", ConsoleAccessLevelEnum.AccessOperator);
+        }
 
 		/// <summary>
 		/// Calls activate steps on all Device class items
@@ -299,5 +302,79 @@ namespace PepperDash.Essentials.Core
             }
             com.SimulateReceive(match.Groups[2].Value);
         }
+
+        /// <summary>
+        /// Attempts to set the debug level of a device
+        /// </summary>
+        /// <param name="s"></param>
+        public static void SetDeviceStreamDebugging(string s)
+        {
+            var args = s.Split(' ');
+
+            var deviceKey = args[0];
+            var setting = args[1];
+            var timeout = args[2];
+
+            var device = GetDeviceForKey(deviceKey) as IStreamDebugging;
+
+            if (device == null)
+            {
+                Debug.Console(0, "Unable to get device with key: {0}", deviceKey);
+                return;
+            }
+            else
+            {
+                eStreamDebuggingSetting debugSetting = eStreamDebuggingSetting.Off;
+
+                try
+                {
+                    debugSetting = (eStreamDebuggingSetting)Enum.Parse(typeof(eStreamDebuggingSetting), setting, true);
+                }
+                catch
+                {
+                    Debug.Console(0, "Unable to convert setting value.  Please use off/rx/tx/both");
+                    return;
+                }
+
+                if (!string.IsNullOrEmpty(timeout))
+                {
+                    try
+                    {
+                        var min = Convert.ToUInt32(timeout);
+
+                        device.StreamDebugging.SetDebuggingWithSpecificTimeout(debugSetting, min);
+                        Debug.Console(0, "Device: '{0}' debug level set to {1) for {2} minutes", deviceKey, debugSetting, min);
+
+                    }
+                    catch (Exception e)
+                    {
+                        Debug.Console(0, "Unable to convert minutes or settings value.  Please use an integer value for minutes. Errro: {0}", e);
+                        return;
+                    }
+                }
+                else
+                {
+                    device.StreamDebugging.SetDebuggingWithDefaultTimeout(debugSetting);
+                    Debug.Console(0, "Device: '{0}' debug level set to {1) for default time (30 minutes)", deviceKey, debugSetting);
+                }
+                
+            }
+        }
+
+        /// <summary>
+        /// Sets stream debugging settings to off for all devices
+        /// </summary>
+        public static void DisableAllDeviceStreamDebugging()
+        {
+            foreach (var device in AllDevices)
+            {
+                var streamDevice = device as IStreamDebugging;
+
+                if (streamDevice != null)
+                {
+                    streamDevice.StreamDebugging.SetDebuggingWithDefaultTimeout(eStreamDebuggingSetting.Off);
+                }
+            }
+        }
 	}
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj

@@ -64,7 +64,7 @@
     </Reference>
     <Reference Include="Crestron.SimplSharpPro.Gateways, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.Gateways.dll</HintPath>
+      <HintPath>..\..\..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.Gateways.dll</HintPath>
     </Reference>
     <Reference Include="Crestron.SimplSharpPro.GeneralIO, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1099c178b3b54c3b, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>

essentials-framework/pepperdashcore-builds

@@ -1 +1 @@
-Subproject commit 15206840b3e6338f695e4ffba634a72e51ea1be5
+Subproject commit 974d2f473c06b2c90b18c06e0f758ca47d466be8