Removes essentials-framework as a submodule and brings the files back into the main repo

2026-02-09 17:54:59 +00:00 · 2019-07-09 17:21:53 -06:00
parent 2cd68d40dc
commit 48c6bb78bc
362 changed files with 54624 additions and 5 deletions
--- a/Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs
+++ b/Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs
@@ -0,0 +1,156 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharpPro;
+using Crestron.SimplSharpPro.DeviceSupport;
+
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+	/// <summary>
+	/// A bridge class to cover the basic features of GenericBase hardware
+	/// </summary>
+	public class CrestronGenericBaseDevice : Device, IOnline, IHasFeedback, ICommunicationMonitor, IUsageTracking
+	{
+		public virtual GenericBase Hardware { get; protected set; }
+
+        /// <summary>
+        /// Returns a list containing the Outputs that we want to expose.
+        /// </summary>
+        public FeedbackCollection<Feedback> Feedbacks { get; private set; }
+
+		public BoolFeedback IsOnline { get; private set; }
+		public BoolFeedback IsRegistered { get; private set; }
+		public StringFeedback IpConnectionsText { get; private set; }
+
+		/// <summary>
+		/// Used by implementing classes to prevent registration with Crestron TLDM. For
+		/// devices like RMCs and TXs attached to a chassis.
+		/// </summary>
+		public bool PreventRegistration { get; protected set; }
+
+		public CrestronGenericBaseDevice(string key, string name, GenericBase hardware)
+			: base(key, name)
+		{
+            Feedbacks = new FeedbackCollection<Feedback>();
+
+			Hardware = hardware;
+			IsOnline = new BoolFeedback("IsOnlineFeedback", () => Hardware.IsOnline);
+			IsRegistered = new BoolFeedback("IsRegistered", () => Hardware.Registered);
+			IpConnectionsText = new StringFeedback("IpConnectionsText", () => 
+				string.Join(",", Hardware.ConnectedIpList.Select(cip => cip.DeviceIpAddress).ToArray()));
+
+            AddToFeedbackList(IsOnline, IsRegistered, IpConnectionsText);
+
+			CommunicationMonitor = new CrestronGenericBaseCommunicationMonitor(this, hardware, 120000, 300000);
+		}
+
+		/// <summary>
+		/// Make sure that overriding classes call this!
+		/// Registers the Crestron device, connects up to the base events, starts communication monitor
+		/// </summary>
+		public override bool CustomActivate()
+		{
+            Debug.Console(0, this, "Activating");
+			if (!PreventRegistration)
+			{
+                //Debug.Console(1, this, "  Does not require registration. Skipping");
+
+				var response = Hardware.RegisterWithLogging(Key);
+				if (response != eDeviceRegistrationUnRegistrationResponse.Success)
+				{
+					//Debug.Console(0, this, "ERROR: Cannot register Crestron device: {0}", response);
+					return false;
+				}
+			}
+
+            Hardware.OnlineStatusChange += new OnlineStatusChangeEventHandler(Hardware_OnlineStatusChange);
+            CommunicationMonitor.Start();    
+
+			return true;
+		}
+
+		/// <summary>
+		/// This disconnects events and unregisters the base hardware device.
+		/// </summary>
+		/// <returns></returns>
+		public override bool Deactivate()
+		{
+			CommunicationMonitor.Stop();
+			Hardware.OnlineStatusChange -= Hardware_OnlineStatusChange;
+
+			return Hardware.UnRegister() == eDeviceRegistrationUnRegistrationResponse.Success;
+		}
+	
+        /// <summary>
+        /// Adds feedback(s) to the list
+        /// </summary>
+        /// <param name="newFbs"></param>
+        public void AddToFeedbackList(params Feedback[] newFbs)
+        {
+            foreach (var f in newFbs)
+            {
+                if (f != null)
+                {
+                    if (!Feedbacks.Contains(f))
+                    {
+                        Feedbacks.Add(f);
+                    }
+                }
+            }
+        }
+
+		void Hardware_OnlineStatusChange(GenericBase currentDevice, OnlineOfflineEventArgs args)
+		{
+            if (args.DeviceOnLine)
+            {
+                foreach (var feedback in Feedbacks)
+                {
+                    if (feedback != null)
+                        feedback.FireUpdate();
+                }
+            }
+		}
+
+		#region IStatusMonitor Members
+
+		public StatusMonitorBase CommunicationMonitor { get; private set; }
+		#endregion
+
+        #region IUsageTracking Members
+
+        public UsageTracking UsageTracker { get; set; }
+
+        #endregion
+	}
+
+	//***********************************************************************************
+	public class CrestronGenericBaseDeviceEventIds
+	{
+		public const uint IsOnline = 1;
+		public const uint IpConnectionsText =2;
+	}
+
+	/// <summary>
+	/// Adds logging to Register() failure
+	/// </summary>
+	public static class GenericBaseExtensions
+	{
+		public static eDeviceRegistrationUnRegistrationResponse RegisterWithLogging(this GenericBase device, string key)
+		{
+			var result = device.Register();
+			var level = result == eDeviceRegistrationUnRegistrationResponse.Success ?
+				Debug.ErrorLogLevel.Notice : Debug.ErrorLogLevel.Error;
+			Debug.Console(0, level, "Register device result: '{0}', type '{1}', result {2}", key, device, result);
+			//if (result != eDeviceRegistrationUnRegistrationResponse.Success)
+			//{
+			//    Debug.Console(0, Debug.ErrorLogLevel.Error, "Cannot register device '{0}': {1}", key, result);
+			//}
+			return result;
+		}
+
+	}
+}
--- a/Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs.orig
+++ b/Core/PepperDashEssentialsBase/Crestron/CrestronGenericBaseDevice.cs.orig
@@ -0,0 +1,128 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharpPro;
+using Crestron.SimplSharpPro.DeviceSupport;
+
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+	/// <summary>
+	/// A bridge class to cover the basic features of GenericBase hardware
+	/// </summary>
+	public class CrestronGenericBaseDevice : Device, IOnline, IHasFeedback, ICommunicationMonitor, IUsageTracking
+	{
+		public virtual GenericBase Hardware { get; protected set; }
+
+		public BoolFeedback IsOnline { get; private set; }
+		public BoolFeedback IsRegistered { get; private set; }
+		public StringFeedback IpConnectionsText { get; private set; }
+
+		public CrestronGenericBaseDevice(string key, string name, GenericBase hardware)
+			: base(key, name)
+		{
+			Hardware = hardware;
+			IsOnline = new BoolFeedback(CommonBoolCue.IsOnlineFeedback, () => Hardware.IsOnline);
+			IsRegistered = new BoolFeedback(new Cue("IsRegistered", 0, eCueType.Bool), () => Hardware.Registered);
+			IpConnectionsText = new StringFeedback(CommonStringCue.IpConnectionsText, () => 
+				string.Join(",", Hardware.ConnectedIpList.Select(cip => cip.DeviceIpAddress).ToArray()));
+			CommunicationMonitor = new CrestronGenericBaseCommunicationMonitor(this, hardware, 120000, 300000);
+		}
+
+		/// <summary>
+		/// Make sure that overriding classes call this!
+		/// Registers the Crestron device, connects up to the base events, starts communication monitor
+		/// </summary>
+		public override bool CustomActivate()
+		{
+            Debug.Console(0, this, "Activating");
+            var response = Hardware.RegisterWithLogging(Key);
+            if (response != eDeviceRegistrationUnRegistrationResponse.Success)
+            {
+<<<<<<< HEAD
+				Debug.Console(0, this, "ERROR: Cannot register Crestron device: {0}", response);
+				return false;
+			}
+=======
+                Debug.Console(0, this, "ERROR: Cannot register Crestron device: {0}", response);
+                return false;
+            }
+>>>>>>> origin/feature/ecs-342-neil
+            Hardware.OnlineStatusChange += new OnlineStatusChangeEventHandler(Hardware_OnlineStatusChange);
+            CommunicationMonitor.Start();    
+
+			return true;
+		}
+
+		/// <summary>
+		/// This disconnects events and unregisters the base hardware device.
+		/// </summary>
+		/// <returns></returns>
+		public override bool Deactivate()
+		{
+			CommunicationMonitor.Stop();
+			Hardware.OnlineStatusChange -= Hardware_OnlineStatusChange;
+
+			return Hardware.UnRegister() == eDeviceRegistrationUnRegistrationResponse.Success;
+		}
+
+		/// <summary>
+		/// Returns a list containing the Outputs that we want to expose.
+		/// </summary>
+		public virtual List<Feedback> Feedbacks
+		{
+			get
+			{
+				return new List<Feedback>
+				{
+					IsOnline,
+					IsRegistered,
+					IpConnectionsText
+				};
+			}
+		}
+
+		void Hardware_OnlineStatusChange(GenericBase currentDevice, OnlineOfflineEventArgs args)
+		{
+			IsOnline.FireUpdate();
+		}
+
+		#region IStatusMonitor Members
+
+		public StatusMonitorBase CommunicationMonitor { get; private set; }
+		#endregion
+
+        #region IUsageTracking Members
+
+        public UsageTracking UsageTracker { get; set; }
+
+        #endregion
+	}
+
+	//***********************************************************************************
+	public class CrestronGenericBaseDeviceEventIds
+	{
+		public const uint IsOnline = 1;
+		public const uint IpConnectionsText =2;
+	}
+
+	/// <summary>
+	/// Adds logging to Register() failure
+	/// </summary>
+	public static class GenericBaseExtensions
+	{
+		public static eDeviceRegistrationUnRegistrationResponse RegisterWithLogging(this GenericBase device, string key)
+		{
+			var result = device.Register();
+			if (result != eDeviceRegistrationUnRegistrationResponse.Success)
+			{
+				Debug.Console(0, Debug.ErrorLogLevel.Error, "Cannot register device '{0}': {1}", key, result);
+			}
+			return result;
+		}
+
+	}
+}