Merge pull request #1362 from PepperDash/feature/add-IHasFeedback-to-IEssentialsRoomFusionController

fix: ensure proper disposal of help request timeout timer and improve…

src/PepperDash.Essentials.Core/Fusion/IEssentialsRoomFusionController.cs

@@ -14,13 +14,14 @@ using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Timers;
 
 namespace PepperDash.Essentials.Core.Fusion
 {
     /// <summary>
     /// Represents a EssentialsHuddleSpaceFusionSystemControllerBase
     /// </summary>
-    public class IEssentialsRoomFusionController : EssentialsDevice, IOccupancyStatusProvider, IFusionHelpRequest
+    public class IEssentialsRoomFusionController : EssentialsDevice, IOccupancyStatusProvider, IFusionHelpRequest, IHasFeedback
     {
         private IEssentialsRoomFusionControllerPropertiesConfig _config;
 
@@ -87,15 +88,17 @@ namespace PepperDash.Essentials.Core.Fusion
         /// <inheritdoc />
         public StringFeedback HelpRequestStatusFeedback { get; private set; }
 
+        private Timer _helpRequestTimeoutTimer;
 
-        #region System Info Sigs
+        /// <summary>
+        /// Gets the DefaultHelpRequestTimeoutMs
+        /// </summary>
+        public int HelpRequestTimeoutMs => _config.HelpRequestTimeoutMs;
 
-        //StringSigData SystemName;
-        //StringSigData Model;
-        //StringSigData SerialNumber;
-        //StringSigData Uptime;
-
-        #endregion
+        /// <summary>
+        /// Gets whether to use a timer for help requests
+        /// </summary>
+        public bool UseHelpRequestTimer => _config.UseTimeoutForHelpRequests;
 
         #region Processor Info Sigs
 
@@ -240,6 +243,19 @@ namespace PepperDash.Essentials.Core.Fusion
 
                 this.LogDebug("Occupancy setup complete");
 
+                HelpRequestResponseFeedback = new StringFeedback("HelpRequestResponse", () => FusionRoom.Help.OutputSig.StringValue);
+
+                HelpRequestSentFeedback = new BoolFeedback("HelpRequestSent", () => _helpRequestSent);
+                HelpRequestStatusFeedback = new StringFeedback("HelpRequestStatus", () => _helpRequestStatus.ToString());
+
+                Feedbacks.Add(HelpRequestResponseFeedback);
+                Feedbacks.Add(HelpRequestSentFeedback);
+                Feedbacks.Add(HelpRequestStatusFeedback);
+                if (RoomOccupancyRemoteStringFeedback != null)
+                    Feedbacks.Add(RoomOccupancyRemoteStringFeedback);
+                if (RoomIsOccupiedFeedback != null)
+                    Feedbacks.Add(RoomIsOccupiedFeedback);
+
             }
             catch (Exception e)
             {
@@ -303,10 +319,6 @@ namespace PepperDash.Essentials.Core.Fusion
 
             FusionRVI.GenerateFileForAllFusionDevices();
 
-            HelpRequestResponseFeedback = new StringFeedback("HelpRequestResponse", () => FusionRoom.Help.OutputSig.StringValue);
-
-            HelpRequestSentFeedback = new BoolFeedback("HelpRequestSent", () => _helpRequestSent);
-            HelpRequestStatusFeedback = new StringFeedback("HelpRequestStatus", () => _helpRequestStatus.ToString());
         }
 
         /// <summary>
@@ -339,6 +351,11 @@ namespace PepperDash.Essentials.Core.Fusion
 
         #endregion
 
+
+        /// <inheritdoc />
+        public FeedbackCollection<Feedback> Feedbacks { get; private set; } = new FeedbackCollection<Feedback>();
+
+
         /// <summary>
         /// ScheduleChange event
         /// </summary>
@@ -1772,7 +1789,7 @@ namespace PepperDash.Essentials.Core.Fusion
         {
             if (args.EventId == FusionEventIds.HelpMessageReceivedEventId)
             {
-                this.LogInformation( "Help message received from Fusion for room '{0}'",
+                this.LogInformation("Help message received from Fusion for room '{0}'",
              Room.Name);
 
                 this.LogDebug("Help message content: {0}", FusionRoom.Help.OutputSig.StringValue);
@@ -1791,7 +1808,7 @@ namespace PepperDash.Essentials.Core.Fusion
                             break;
                         case "Please call the helpdesk.":
                             // this.LogInformation("Please call the helpdesk.");
-                            // _helpRequestStatus = eFusionHelpResponse.CallHelpDesk;
+                            _helpRequestStatus = eFusionHelpResponse.CallHelpDesk;
                             break;
                         case "Please wait, I will reschedule your meeting to a different room.":
                             // this.LogInformation("Please wait, I will reschedule your meeting to a different room.",
@@ -1818,13 +1835,21 @@ namespace PepperDash.Essentials.Core.Fusion
                     _helpRequestStatus = eFusionHelpResponse.None;
                 }
 
-                if(_helpRequestStatus == eFusionHelpResponse.None)
+                if (_helpRequestStatus == eFusionHelpResponse.None)
                 {
                     _helpRequestSent = false;
                     HelpRequestSentFeedback.FireUpdate();
                 }
-                
+
                 HelpRequestStatusFeedback.FireUpdate();
+
+                if (_helpRequestTimeoutTimer != null)
+                {
+                    _helpRequestTimeoutTimer.Stop();
+                    _helpRequestTimeoutTimer.Elapsed -= OnTimedEvent;
+                    _helpRequestTimeoutTimer.Dispose();
+                    _helpRequestTimeoutTimer = null;
+                }
             }
 
 
@@ -1895,10 +1920,34 @@ namespace PepperDash.Essentials.Core.Fusion
             _helpRequestSent = true;
             HelpRequestSentFeedback.FireUpdate();
 
+            if (UseHelpRequestTimer)
+            {
+                if (_helpRequestTimeoutTimer == null)
+                {
+                    _helpRequestTimeoutTimer = new Timer(HelpRequestTimeoutMs);
+                    _helpRequestTimeoutTimer.AutoReset = false;
+                    _helpRequestTimeoutTimer.Enabled = true;
+
+                    _helpRequestTimeoutTimer.Elapsed += OnTimedEvent;
+                }
+
+                _helpRequestTimeoutTimer.Interval = HelpRequestTimeoutMs;
+                _helpRequestTimeoutTimer.Start();
+
+                this.LogDebug("Help request timeout timer started for room '{0}' with timeout of {1} ms.",
+    Room.Name, HelpRequestTimeoutMs);
+            }
+
             _helpRequestStatus = eFusionHelpResponse.HelpRequested;
             HelpRequestStatusFeedback.FireUpdate();
         }
 
+        private void OnTimedEvent(object source, ElapsedEventArgs e)
+        {
+            this.LogInformation("Help request timeout reached for room '{0}'. Cancelling help request.", Room.Name);
+            CancelHelpRequest();
+        }
+
         /// <inheritdoc />
         public void CancelHelpRequest()
         {
@@ -1909,7 +1958,16 @@ namespace PepperDash.Essentials.Core.Fusion
                 HelpRequestSentFeedback.FireUpdate();
                 _helpRequestStatus = eFusionHelpResponse.None;
                 HelpRequestStatusFeedback.FireUpdate();
-                Debug.LogMessage(LogEventLevel.Information, this, "Help request cancelled in Fusion for room '{0}'", Room.Name);
+                Debug.LogMessage(LogEventLevel.Information, this, "Help request cancelled for room '{0}'", Room.Name);
+            }
+
+            if (_helpRequestTimeoutTimer != null)
+            {
+                _helpRequestTimeoutTimer.Stop();
+                _helpRequestTimeoutTimer.Elapsed -= OnTimedEvent;
+                _helpRequestTimeoutTimer.Dispose();
+                _helpRequestTimeoutTimer = null;
+                this.LogDebug("Help request timeout timer stopped for room '{0}'.", Room.Name);
             }
         }
 

src/PepperDash.Essentials.Core/Fusion/IEssentialsRoomFusionControllerPropertiesConfig.cs

@@ -56,4 +56,16 @@ public class IEssentialsRoomFusionControllerPropertiesConfig
     /// </summary>
     [JsonProperty("use24HourTimeFormat")]
     public bool Use24HourTimeFormat { get; set; } = false;
+
+    /// <summary>
+    /// Gets or sets whether to use a timeout for help requests
+    /// </summary>
+    [JsonProperty("useTimeoutForHelpRequests")]
+    public bool UseTimeoutForHelpRequests { get; set; } = false;
+
+    /// <summary>
+    /// Gets or sets the timeout duration for help requests in milliseconds
+    /// </summary>
+    [JsonProperty("helpRequestTimeoutMs")]
+    public int HelpRequestTimeoutMs { get; set; } = 30000;
 }

src/PepperDash.Essentials.Devices.Common/Generic/GenericSink.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using PepperDash.Core;
+using PepperDash.Core.Logging;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Config;
 using Serilog.Events;
@@ -73,7 +74,7 @@ namespace PepperDash.Essentials.Devices.Common.Generic
         /// <inheritdoc />
         public void ExecuteSwitch(object inputSelector)
         {
-            throw new System.NotImplementedException();
+            this.LogDebug("GenericSink Executing Switch to: {inputSelector}", inputSelector);
         }
     }