#742 Updates to room combination interfaces and EssentialsRoomCombiner and EssentialsPartitionController

essentials-framework/Essentials Core/PepperDashEssentialsBase/PartitionSensor/EssentialsPartitionController.cs

@@ -0,0 +1,149 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Represents an abstract controller device for a partition dividing rooms that are combinable
+    /// 
+    /// In Auto mode, it can use a partition sensor to automatically determine whether the partition is present.
+    /// 
+    /// In Manual mode it accepts user input to tell it whether the partition is present.
+    /// </summary>
+    public class EssentialsPartitionController : IPartitionController
+    {
+        private IPartitionStateProvider _partitionSensor;
+
+        private bool isInAutoMode;
+
+        private bool partitionPresent;
+
+        public EssentialsPartitionController(string key, string name, IPartitionStateProvider sensor, bool defaultToManualMode, List<string> adjacentRoomKeys)
+        {
+            Key = key;
+
+            Name = name;
+
+            AdjacentRoomKeys = adjacentRoomKeys;
+
+            if (sensor != null)
+            {
+                _partitionSensor = sensor;
+
+                if (!defaultToManualMode)
+                {
+                    SetAutoMode();
+                }
+                else
+                {
+                    SetManualMode();
+                }
+            }
+            else
+            {
+                SetManualMode();
+            }
+
+            PartitionPresentFeedback.FireUpdate();
+        }
+
+        void PartitionPresentFeedback_OutputChange(object sender, FeedbackEventArgs e)
+        {
+            if (isInAutoMode)
+            {
+                PartitionPresentFeedback.FireUpdate();
+            }
+        }
+
+        #region IPartitionController Members
+
+        public List<string> AdjacentRoomKeys { get; private set; }
+
+        public void SetAutoMode()
+        {
+            isInAutoMode = true;
+            if (PartitionPresentFeedback != null)
+            {
+                PartitionPresentFeedback.SetValueFunc(() => _partitionSensor.PartitionPresentFeedback.BoolValue);
+            }
+            else
+            {
+                PartitionPresentFeedback = new BoolFeedback(() => _partitionSensor.PartitionPresentFeedback.BoolValue);
+            }
+
+            if (_partitionSensor != null)
+            {
+                _partitionSensor.PartitionPresentFeedback.OutputChange += PartitionPresentFeedback_OutputChange;
+            }
+        }
+
+        public void SetManualMode()
+        {
+            isInAutoMode = false;
+            if (PartitionPresentFeedback != null)
+            {
+                PartitionPresentFeedback.SetValueFunc(() => partitionPresent);
+            }
+            else
+            {
+                PartitionPresentFeedback = new BoolFeedback(() => partitionPresent);
+            }
+
+            if (_partitionSensor != null)
+            {
+                _partitionSensor.PartitionPresentFeedback.OutputChange -= PartitionPresentFeedback_OutputChange;
+            }
+        }
+
+
+        public void SetPartitionStatePresent()
+        {
+            if (!isInAutoMode)
+            {
+                partitionPresent = true;
+                PartitionPresentFeedback.FireUpdate();
+            }
+        }
+
+        public void SetPartitionStateNotPresent()
+        {
+            if (!isInAutoMode)
+            {
+                partitionPresent = false;
+                PartitionPresentFeedback.FireUpdate();
+            }
+        }
+
+        public void ToggglePartitionState()
+        {
+            if (!isInAutoMode)
+            {
+                partitionPresent = !partitionPresent;
+                PartitionPresentFeedback.FireUpdate();
+            }
+        }
+
+        #endregion
+
+        #region IPartitionStateProvider Members
+
+        public BoolFeedback PartitionPresentFeedback { get; private set; }
+
+        #endregion
+
+        #region IKeyName Members
+
+        public string Name { get; private set; }
+
+        #endregion
+
+        #region IKeyed Members
+
+        public string Key { get; private set; }
+
+        #endregion
+    }
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/PartitionSensor/GlsPartitionSensorController.cs

@@ -19,7 +19,7 @@ namespace PepperDash.Essentials.Core
 
 		public StringFeedback NameFeedback { get; private set; }
 		public BoolFeedback EnableFeedback { get; private set; }
-		public BoolFeedback PartitionSensedFeedback { get; private set; }
+		public BoolFeedback PartitionPresentFeedback { get; private set; }
 		public BoolFeedback PartitionNotSensedFeedback { get; private set; }
 		public IntFeedback SensitivityFeedback { get; private set; }
 
@@ -40,7 +40,7 @@ namespace PepperDash.Essentials.Core
 
                 NameFeedback = new StringFeedback(() => Name);
                 EnableFeedback = new BoolFeedback(() => _partitionSensor.EnableFeedback.BoolValue);
-                PartitionSensedFeedback = new BoolFeedback(() => _partitionSensor.PartitionSensedFeedback.BoolValue);
+                PartitionPresentFeedback = new BoolFeedback(() => _partitionSensor.PartitionSensedFeedback.BoolValue);
                 PartitionNotSensedFeedback = new BoolFeedback(() => _partitionSensor.PartitionNotSensedFeedback.BoolValue);
                 SensitivityFeedback = new IntFeedback(() => _partitionSensor.SensitivityFeedback.UShortValue);
 
@@ -61,7 +61,7 @@ namespace PepperDash.Essentials.Core
 					}
 				case (GlsPartCn.PartitionSensedFeedbackEventId):
 					{
-						PartitionSensedFeedback.FireUpdate();
+						PartitionPresentFeedback.FireUpdate();
 						break;
 					}
 				case (GlsPartCn.PartitionNotSensedFeedbackEventId):
@@ -186,7 +186,7 @@ namespace PepperDash.Essentials.Core
 			// link output to simpl
 			IsOnline.LinkInputSig(trilist.BooleanInput[joinMap.IsOnline.JoinNumber]);
 			EnableFeedback.LinkInputSig(trilist.BooleanInput[joinMap.Enable.JoinNumber]);
-			PartitionSensedFeedback.LinkInputSig(trilist.BooleanInput[joinMap.PartitionSensed.JoinNumber]);
+			PartitionPresentFeedback.LinkInputSig(trilist.BooleanInput[joinMap.PartitionSensed.JoinNumber]);
 			PartitionNotSensedFeedback.LinkInputSig(trilist.BooleanInput[joinMap.PartitionNotSensed.JoinNumber]);
 			SensitivityFeedback.LinkInputSig(trilist.UShortInput[joinMap.Sensitivity.JoinNumber]);
 
@@ -216,7 +216,7 @@ namespace PepperDash.Essentials.Core
 			IsOnline.FireUpdate();
 			NameFeedback.FireUpdate();
 			EnableFeedback.FireUpdate();
-			PartitionSensedFeedback.FireUpdate();
+			PartitionPresentFeedback.FireUpdate();
 			PartitionNotSensedFeedback.FireUpdate();
 			SensitivityFeedback.FireUpdate();
 		}

essentials-framework/Essentials Core/PepperDashEssentialsBase/PartitionSensor/IPartitionStateProvider.cs

@@ -13,15 +13,24 @@ namespace PepperDash.Essentials.Core
     /// </summary>
     public interface IPartitionStateProvider : IKeyName
     {
-        BoolFeedback PartitionSensedFeedback { get; }
+        BoolFeedback PartitionPresentFeedback { get; }
     }
 
-    public interface IManualPartitionSensor : IPartitionStateProvider
+    /// <summary>
+    /// Describes the functionality of a device that can provide partition state either manually via user input or optionally via a sensor state
+    /// </summary>
+    public interface IPartitionController : IPartitionStateProvider
     {
+        List<string> AdjacentRoomKeys { get; set; }
+
         void SetPartitionStatePresent();
 
         void SetPartitionStateNotPresent();
 
         void ToggglePartitionState();
+
+        void SetManualMode();
+
+        void SetAutoMode();
     }
 }