Merge pull request #1280 from PepperDash/device-info-messenger

In some cases, multiple device info update events are triggering,
causing the queue to be flooded with multiple unneccessary messages containing the same info.
This clogs the queue and makes it harder for UIs to come online when Essentials restarts,
especially in systems with a lot of NVX devices.

The events are now debounced. If there are no new messages for 1 second, then the MC message
is sent out.

src/PepperDash.Core/Device.cs

@@ -11,35 +11,35 @@ namespace PepperDash.Core
 	public class Device : IKeyName
 	{
 
-        /// <summary>
-        /// Unique Key
-        /// </summary>
+		/// <summary>
+		/// Unique Key
+		/// </summary>
 		public string Key { get; protected set; }
 		/// <summary>
 		/// Name of the devie
 		/// </summary>
-        public string Name { get; protected set; }
-        /// <summary>
-        /// 
-        /// </summary>
+		public string Name { get; protected set; }
+		/// <summary>
+		/// 
+		/// </summary>
 		public bool Enabled { get; protected set; }
 
-        ///// <summary>
-        ///// A place to store reference to the original config object, if any. These values should 
-        ///// NOT be used as properties on the device as they are all publicly-settable values.
-        ///// </summary>
-        //public DeviceConfig Config { get; private set; }
-        ///// <summary>
-        ///// Helper method to check if Config exists
-        ///// </summary>
-        //public bool HasConfig { get { return Config != null; } }
+		///// <summary>
+		///// A place to store reference to the original config object, if any. These values should 
+		///// NOT be used as properties on the device as they are all publicly-settable values.
+		///// </summary>
+		//public DeviceConfig Config { get; private set; }
+		///// <summary>
+		///// Helper method to check if Config exists
+		///// </summary>
+		//public bool HasConfig { get { return Config != null; } }
 
 		List<Action> _PreActivationActions;
 		List<Action> _PostActivationActions;
 
-        /// <summary>
-        /// 
-        /// </summary>
+		/// <summary>
+		/// 
+		/// </summary>
 		public static Device DefaultDevice { get { return _DefaultDevice; } }
 		static Device _DefaultDevice = new Device("Default", "Default");
 
@@ -54,27 +54,27 @@ namespace PepperDash.Core
 			Name = "";
 		}
 
-        /// <summary>
-        /// Constructor with key and name
-        /// </summary>
-        /// <param name="key"></param>
-        /// <param name="name"></param>
+		/// <summary>
+		/// Constructor with key and name
+		/// </summary>
+		/// <param name="key"></param>
+		/// <param name="name"></param>
 		public Device(string key, string name) : this(key)
 		{
 			Name = name;
 
 		}
 
-        //public Device(DeviceConfig config)
-        //    : this(config.Key, config.Name)
-        //{
-        //    Config = config;
-        //}
+		//public Device(DeviceConfig config)
+		//    : this(config.Key, config.Name)
+		//{
+		//    Config = config;
+		//}
 
-        /// <summary>
-        /// Adds a pre activation action
-        /// </summary>
-        /// <param name="act"></param>
+		/// <summary>
+		/// Adds a pre activation action
+		/// </summary>
+		/// <param name="act"></param>
 		public void AddPreActivationAction(Action act)
 		{
 			if (_PreActivationActions == null)
@@ -82,10 +82,10 @@ namespace PepperDash.Core
 			_PreActivationActions.Add(act);
 		}
 
-        /// <summary>
-        /// Adds a post activation action
-        /// </summary>
-        /// <param name="act"></param>
+		/// <summary>
+		/// Adds a post activation action
+		/// </summary>
+		/// <param name="act"></param>
 		public void AddPostActivationAction(Action act)
 		{
 			if (_PostActivationActions == null)
@@ -93,55 +93,58 @@ namespace PepperDash.Core
 			_PostActivationActions.Add(act);
 		}
 
-        /// <summary>
-        /// Executes the preactivation actions
-        /// </summary>
-        public void PreActivate()
-        {
-            if (_PreActivationActions != null)
-                _PreActivationActions.ForEach(a => {
+		/// <summary>
+		/// Executes the preactivation actions
+		/// </summary>
+		public void PreActivate()
+		{
+			if (_PreActivationActions != null)
+				_PreActivationActions.ForEach(a =>
+				{
 					try
 					{
 						a.Invoke();
-					} catch (Exception e)
-					{ 
+					}
+					catch (Exception e)
+					{
 						Debug.LogMessage(e, "Error in PreActivationAction: " + e.Message, this);
 					}
-            });
-        }
+				});
+		}
 
 		/// <summary>
 		/// Gets this device ready to be used in the system. Runs any added pre-activation items, and
 		/// all post-activation at end. Classes needing additional logic to 
 		/// run should override CustomActivate()
 		/// </summary>
-		public bool Activate() 
+		public bool Activate()
 		{
-            //if (_PreActivationActions != null)
-            //    _PreActivationActions.ForEach(a => a.Invoke());
+			//if (_PreActivationActions != null)
+			//    _PreActivationActions.ForEach(a => a.Invoke());
 			var result = CustomActivate();
-            //if(result && _PostActivationActions != null)
-            //    _PostActivationActions.ForEach(a => a.Invoke());
-			return result; 	
+			//if(result && _PostActivationActions != null)
+			//    _PostActivationActions.ForEach(a => a.Invoke());
+			return result;
 		}
 
-        /// <summary>
-        /// Executes the postactivation actions
-        /// </summary>
-        public void PostActivate()
-        {
-            if (_PostActivationActions != null)
-                _PostActivationActions.ForEach(a => {
-                    try
-                    {
-                        a.Invoke();
-                    }
-                    catch (Exception e)
-                    {
-                        Debug.LogMessage(e, "Error in PostActivationAction: " + e.Message, this);
-                    }
-                });
-        }
+		/// <summary>
+		/// Executes the postactivation actions
+		/// </summary>
+		public void PostActivate()
+		{
+			if (_PostActivationActions != null)
+				_PostActivationActions.ForEach(a =>
+				{
+					try
+					{
+						a.Invoke();
+					}
+					catch (Exception e)
+					{
+						Debug.LogMessage(e, "Error in PostActivationAction: " + e.Message, this);
+					}
+				});
+		}
 
 		/// <summary>
 		/// Called in between Pre and PostActivationActions when Activate() is called. 
@@ -158,14 +161,14 @@ namespace PepperDash.Core
 		/// <returns></returns>
 		public virtual bool Deactivate() { return true; }
 
-        /// <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>
+		/// Call this method to start communications with a device. Overriding classes do not need to call base.Initialize()
+		/// </summary>
+		public virtual void Initialize()
+		{
+		}
 
-	    /// <summary>
+		/// <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>
@@ -175,5 +178,15 @@ namespace PepperDash.Core
 			if (o is bool && !(bool)o) a();
 		}
 
+        /// <summary>
+        /// Returns a string representation of the object, including its key and name.
+        /// </summary>
+        /// <remarks>The returned string is formatted as "{Key} - {Name}". If the <c>Name</c> property is
+        /// null or empty,  "---" is used in place of the name.</remarks>
+        /// <returns>A string that represents the object, containing the key and name in the format "{Key} - {Name}".</returns>
+		public override string ToString()
+		{
+			return string.Format("{0} - {1}", Key, string.IsNullOrEmpty(Name) ? "---" : Name);
+		}
 	}
 }

src/PepperDash.Essentials.Core/Devices/DeviceManager.cs

@@ -248,7 +248,7 @@ namespace PepperDash.Essentials.Core
 
             foreach (var dev in Devices.Values.OfType<ICommunicationMonitor>())
             {
-                CrestronConsole.ConsoleCommandResponse($"{dev}: {dev.CommunicationMonitor.Status}{Environment.NewLine}");
+                CrestronConsole.ConsoleCommandResponse($"{dev}: {dev.CommunicationMonitor.Status}\r\n");
             }
         }
 

src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs

@@ -20,19 +20,20 @@ namespace PepperDash.Essentials.Core
         public event EventHandler Initialized;
 
         private bool _isInitialized;
-        public bool IsInitialized { 
+        public bool IsInitialized
+        {
             get { return _isInitialized; }
-            private set 
-            { 
+            private set
+            {
                 if (_isInitialized == value) return;
-                
+
                 _isInitialized = value;
 
                 if (_isInitialized)
                 {
                     Initialized?.Invoke(this, new EventArgs());
                 }
-            } 
+            }
         }
 
         protected EssentialsDevice(string key)
@@ -80,8 +81,9 @@ namespace PepperDash.Essentials.Core
         /// <summary>
         /// Override this method to build and create custom Mobile Control Messengers during the Activation phase
         /// </summary>
-        protected virtual void CreateMobileControlMessengers() {
-           
+        protected virtual void CreateMobileControlMessengers()
+        {
+
         }
     }
 

src/PepperDash.Essentials.MobileControl.Messengers/Messengers/DeviceInfoMessenger.cs

@@ -2,27 +2,69 @@
 using Newtonsoft.Json.Linq;
 using PepperDash.Core;
 using PepperDash.Essentials.Core.DeviceInfo;
+using System.Timers;
 
 namespace PepperDash.Essentials.AppServer.Messengers
 {
+    /// <summary>
+    /// Facilitates communication of device information by providing mechanisms for status updates and  device
+    /// information reporting.
+    /// </summary>
+    /// <remarks>The <see cref="DeviceInfoMessenger"/> class integrates with an <see
+    /// cref="IDeviceInfoProvider"/> to  manage device-specific information. It uses a debounce timer to limit the
+    /// frequency of updates,  ensuring efficient communication. The timer is initialized with a 1-second interval and
+    /// is disabled  by default. This class also subscribes to device information change events and provides actions for
+    /// reporting full device status and triggering updates.</remarks>
     public class DeviceInfoMessenger : MessengerBase
     {
         private readonly IDeviceInfoProvider _deviceInfoProvider;
+
+        private readonly Timer debounceTimer;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DeviceInfoMessenger"/> class, which facilitates communication
+        /// of device information.
+        /// </summary>
+        /// <remarks>The messenger uses a debounce timer to limit the frequency of certain operations. The
+        /// timer is initialized with a 1-second interval and is disabled by default.</remarks>
+        /// <param name="key">A unique identifier for the messenger instance.</param>
+        /// <param name="messagePath">The path used for sending and receiving messages.</param>
+        /// <param name="device">An implementation of <see cref="IDeviceInfoProvider"/> that provides device-specific information.</param>
         public DeviceInfoMessenger(string key, string messagePath, IDeviceInfoProvider device) : base(key, messagePath, device as Device)
         {
             _deviceInfoProvider = device;
-        }
 
+            debounceTimer = new Timer(1000)
+            {
+                Enabled = false,
+                AutoReset = false
+            };
+
+            debounceTimer.Elapsed += DebounceTimer_Elapsed;
+        }
+
+        private void DebounceTimer_Elapsed(object sender, ElapsedEventArgs e)
+        {
+            PostStatusMessage(JToken.FromObject(new
+            {
+                deviceInfo = _deviceInfoProvider.DeviceInfo
+            }));
+        }
+
+        /// <summary>
+        /// Registers actions and event handlers for device information updates and status reporting.
+        /// </summary>
+        /// <remarks>This method sets up actions for handling device status updates and reporting full
+        /// device status. It also subscribes to the <see cref="IDeviceInfoProvider.DeviceInfoChanged"/> event to
+        /// trigger debounced updates when the device information changes.</remarks>
         protected override void RegisterActions()
         {
             base.RegisterActions();
 
             _deviceInfoProvider.DeviceInfoChanged += (o, a) =>
             {
-                PostStatusMessage(JToken.FromObject(new
-                {
-                    deviceInfo = a.DeviceInfo
-                }));
+                debounceTimer.Stop();
+                debounceTimer.Start();
             };
 
             AddAction("/fullStatus", (id, context) => PostStatusMessage(new DeviceInfoStateMessage
@@ -34,6 +76,12 @@ namespace PepperDash.Essentials.AppServer.Messengers
         }
     }
 
+    /// <summary>
+    /// Represents a message containing the state information of a device, including detailed device information.
+    /// </summary>
+    /// <remarks>This class is used to encapsulate the state of a device along with its associated
+    /// information. It extends <see cref="DeviceStateMessageBase"/> to provide additional details about the
+    /// device.</remarks>
     public class DeviceInfoStateMessage : DeviceStateMessageBase
     {
         [JsonProperty("deviceInfo")]