Merge remote-tracking branch 'origin/com102-comspec' into mc-touchpanel-key

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

@@ -1,12 +1,9 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
-using Crestron.SimplSharp;
 using Crestron.SimplSharpPro;
-
 using PepperDash.Core;
+using PepperDash.Core.Logging;
 using Serilog.Events;
 
 
@@ -22,7 +19,14 @@ namespace PepperDash.Essentials.Core
 		/// </summary>
 		public CommunicationStreamDebugging StreamDebugging { get; private set; }
 
+		/// <summary>
+		/// Event fired when bytes are received
+		/// </summary>
 		public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
+		
+		/// <summary>
+        /// Event fired when text is received
+        /// </summary>
 		public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
 
 		/// <summary>
@@ -33,6 +37,13 @@ namespace PepperDash.Essentials.Core
 		ComPort Port;
 		ComPort.ComPortSpec Spec;
 
+		/// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="key"></param>
+        /// <param name="postActivationFunc"></param>
+        /// <param name="spec"></param>
+        /// <param name="config"></param>
 		public ComPortController(string key, Func<EssentialsControlPropertiesConfig, ComPort> postActivationFunc,
 			ComPort.ComPortSpec spec, EssentialsControlPropertiesConfig config) : base(key)
 		{
@@ -48,6 +59,12 @@ namespace PepperDash.Essentials.Core
 			});
 		}
 
+		/// <summary>
+		/// Constructor
+		/// </summary>
+		/// <param name="key">Device key</param>
+		/// <param name="port">COM port instance</param>
+		/// <param name="spec">COM port specification</param>
 		public ComPortController(string key, ComPort port, ComPort.ComPortSpec spec)
 			: base(key)
 		{
@@ -71,12 +88,15 @@ namespace PepperDash.Essentials.Core
 				Debug.LogMessage(LogEventLevel.Information, this, "Configured com Port for this device does not exist.");
 				return;
 			}
-            if (Port.Parent is CrestronControlSystem)
+			// TODO [ ] - Remove commented out code once verified working
+			//if (Port.Parent is CrestronControlSystem || Port.Parent is CenIoCom102)
+			if (Port.Parent is GenericBase genericDevice && genericDevice.Registerable)
 			{
-                var result = Port.Register();
+				//this.LogInformation($"INFO: Attempting to register {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID}");
+				var result = genericDevice.Register();
 				if (result != eDeviceRegistrationUnRegistrationResponse.Success)
 				{
-                    Debug.LogMessage(LogEventLevel.Information, this, "ERROR: Cannot register Com port: {0}", result);
+					this.LogError($"ERROR: Cannot register {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {result})");
 					return; // false
 				}
 			}
@@ -84,12 +104,49 @@ namespace PepperDash.Essentials.Core
 			var specResult = Port.SetComPortSpec(Spec);
 			if (specResult != 0)
 			{
-	            Debug.LogMessage(LogEventLevel.Information, this, "WARNING: Cannot set comspec");
+				this.LogError($"ERROR: Cannot set comspec for {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {specResult})");
 				return;
 			}
+			//this.LogInformation($"INFO: Successfully set comspec for {Key} using {Port.Parent.GetType().Name}-comport-{Port.ID} (result == {specResult})");
+
+
+			// TODO [ ] - Remove debug logging once verified working
+			// if (Port.Parent is CenIoCom102)
+			// {				
+			// 	Port.PropertyChanged += (s, e) =>
+			// 	{					
+			// 		this.LogInformation($@"RegisterAndConfigureComPort: PropertyChanged Fired >> 
+			// 			comPort-'{Port.ID}', 
+			// 			Property Changed-'{e.Property}', 
+			// 			Value Changed-'{e.Value}',
+			// 			deviceName-'{Port.DeviceName}', 
+			// 			parentDevice-'{Port.ParentDevice}', 
+			// 			parent-`{Port.Parent}`, 
+			// 			online-`{Port.IsOnline}`, 
+			// 			present-`{Port.Present}`, 
+			// 			supportedBaudRates-'{Port.SupportedBaudRates}'");
+			// 	};
+			// 	Port.ExtendedInformationChanged += (s, e) =>
+			// 	{
+
+			// 		this.LogInformation($@"RegisterAndConfigureComPort: ExtendedInformationChanged Fired >> 
+			// 			comPort-'{Port.ID}', 
+			// 			{e.Protocol},
+			// 			{e.BaudRate},
+			// 			{e.Parity},
+			// 			{e.DataBits},
+			// 			{e.StopBits}, 
+			// 			HW Handshake-'{e.HardwareHandshakeSetting}', 
+			// 			SW Handshake-'{e.SoftwareHandshakeSetting}'");
+			// 	};
+			// }
+
 			Port.SerialDataReceived += Port_SerialDataReceived;
 		}
 
+		/// <summary>
+		/// Destructor
+		/// </summary>
 		~ComPortController()
 		{
 			Port.SerialDataReceived -= Port_SerialDataReceived;