refactor: remove completed request from dictionary

In some cases, a route can be requested while a sink is cooling down.
In those cases, the routing logic should keep track of requests for a
destination and wait until cooling is complete to request the new
route.

PepperDashEssentials/Room/Types/Interfaces/IEssentialsHuddleSpaceRoom.cs

@@ -7,7 +7,7 @@ using PepperDash.Essentials.Room.Config;
 
 namespace PepperDash.Essentials
 {
-    public interface IEssentialsHuddleSpaceRoom : IEssentialsRoom, IHasCurrentSourceInfoChange, IRunRouteAction, IRunDefaultPresentRoute, IHasDefaultDisplay
+    public interface IEssentialsHuddleSpaceRoom : IEssentialsRoom, IHasCurrentSourceInfoChange, IRunRouteAction, IRunDefaultPresentRoute, IHasDefaultDisplay, IHasCurrentVolumeControls
     {
         bool ExcludeFromGlobalFunctions { get; }
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron IO/DinCenCn/DinCenCnController.cs

@@ -34,7 +34,7 @@ namespace PepperDash.Essentials.Core
 
             public override EssentialsDevice BuildDevice(DeviceConfig dc)
             {
-                Debug.Console(1, "Factory Attempting to create new C2N-RTHS Device");
+                Debug.Console(1, "Factory Attempting to create new DIN-CEN-CN2 Device");
 
                 var control = CommFactory.GetControlPropertiesConfig(dc);
                 var ipid = control.IpIdInt;

essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron IO/Inputs/CenIoDigIn104Controller.cs

@@ -16,7 +16,7 @@ namespace PepperDash.Essentials.Core
     /// Wrapper class for CEN-IO-DIGIN-104 digital input module
     /// </summary>
     [Description("Wrapper class for the CEN-IO-DIGIN-104 diginal input module")]
-    public class CenIoDigIn104Controller : EssentialsDevice, IDigitalInputPorts
+    public class CenIoDigIn104Controller : CrestronGenericBaseDevice, IDigitalInputPorts
     {
         public CenIoDi104 Di104 { get; private set; }
 
@@ -52,10 +52,17 @@ namespace PepperDash.Essentials.Core
         {
             Debug.Console(1, "Factory Attempting to create new CEN-DIGIN-104 Device");
 
-            var control = CommFactory.GetControlPropertiesConfig(dc);
-            var ipid = control.IpIdInt;
-
-            return new CenIoDigIn104Controller(dc.Key, dc.Name, new Crestron.SimplSharpPro.GeneralIO.CenIoDi104(ipid, Global.ControlSystem));
+            var control = CommFactory.GetControlPropertiesConfig(dc);
+	        if (control == null)
+	        {
+				Debug.Console(1, "Factory failed to create a new CEN-DIGIN-104 Device, control properties not found");
+				return null;
+	        }
+            var ipid = control.IpIdInt;
+			if (ipid != 0) return new CenIoDigIn104Controller(dc.Key, dc.Name, new CenIoDi104(ipid, Global.ControlSystem));
+
+			Debug.Console(1, "Factory failed to create a new CEN-IO-IR-104 Device using IP-ID-{0}", ipid);
+			return null;
         }
     }
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron IO/Ir/CenIoIr104Controller.cs

@@ -0,0 +1,93 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharpPro;
+using Crestron.SimplSharpPro.GeneralIO;
+using PepperDash.Essentials.Core.Config;
+
+
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Wrapper class for CEN-IO-IR-104 module
+    /// </summary>
+    [Description("Wrapper class for the CEN-IO-IR-104 module")]
+    public class CenIoIr104Controller : CrestronGenericBaseDevice, IIROutputPorts
+    {
+	    private readonly CenIoIr104 _ir104;
+
+		/// <summary>
+		/// Constructor
+		/// </summary>
+		/// <param name="key"></param>
+		/// <param name="name"></param>
+		/// <param name="ir104"></param>
+        public CenIoIr104Controller(string key, string name, CenIoIr104 ir104)
+            : base(key, name, ir104)
+        {
+            _ir104 = ir104;
+        }
+
+        #region IDigitalInputPorts Members
+
+		/// <summary>
+		/// IR port collection
+		/// </summary>
+		public CrestronCollection<IROutputPort> IROutputPorts
+        {
+            get { return _ir104.IROutputPorts; }
+        }
+
+		/// <summary>
+		/// Number of relay ports property
+		/// </summary>
+		public int NumberOfIROutputPorts
+        {
+            get { return _ir104.NumberOfIROutputPorts; }
+        }
+
+        #endregion
+    }
+
+	/// <summary>
+	/// CEN-IO-IR-104 controller fatory
+	/// </summary>
+    public class CenIoIr104ControllerFactory : EssentialsDeviceFactory<CenIoIr104Controller>
+    {
+		/// <summary>
+		/// Constructor
+		/// </summary>
+        public CenIoIr104ControllerFactory()
+        {
+            TypeNames = new List<string>() { "cenioir104" };
+        }
+
+		/// <summary>
+		/// Build device CEN-IO-IR-104
+		/// </summary>
+		/// <param name="dc"></param>
+		/// <returns></returns>
+        public override EssentialsDevice BuildDevice(DeviceConfig dc)
+        {
+            Debug.Console(1, "Factory Attempting to create new CEN-IO-IR-104 Device");
+
+            var control = CommFactory.GetControlPropertiesConfig(dc);
+			if (control == null)
+			{
+				Debug.Console(1, "Factory failed to create a new CEN-IO-IR-104 Device, control properties not found");
+				return null;
+			}
+
+            var ipid = control.IpIdInt;
+			if(ipid != 0) return new CenIoIr104Controller(dc.Key, dc.Name, new CenIoIr104(ipid, Global.ControlSystem));
+
+			Debug.Console(1, "Factory failed to create a new CEN-IO-IR-104 Device using IP-ID-{0}", ipid);
+			return null;
+        }
+    }
+
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Crestron IO/Relay/CenIoRy104Controller.cs

@@ -10,7 +10,7 @@ namespace PepperDash.Essentials.Core
     /// Wrapper class for CEN-IO-RY-104 relay module
     /// </summary>
     [Description("Wrapper class for the CEN-IO-RY-104 relay module")]
-    public class CenIoRy104Controller : EssentialsDevice, IRelayPorts
+    public class CenIoRy104Controller : CrestronGenericBaseDevice, IRelayPorts
     {
         private readonly CenIoRy104 _ry104;
 
@@ -21,7 +21,7 @@ namespace PepperDash.Essentials.Core
         /// <param name="name"></param>
         /// <param name="ry104"></param>
         public CenIoRy104Controller(string key, string name, CenIoRy104 ry104)
-            : base(key, name)
+            : base(key, name, ry104)
         {
             _ry104 = ry104;
         }
@@ -62,8 +62,8 @@ namespace PepperDash.Essentials.Core
 
             var controlPropertiesConfig = CommFactory.GetControlPropertiesConfig(dc);
             if (controlPropertiesConfig == null)
-            {
-                Debug.Console(1, "Factory failed to create a new CEN-IO-RY-104 Device");
+            {
+				Debug.Console(1, "Factory failed to create a new CEN-IO-RY-104 Device, control properties not found");
                 return null;
             }
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj

@@ -183,6 +183,7 @@
     <Compile Include="Crestron IO\Inputs\GenericVersiportInputDevice.cs" />
     <Compile Include="Crestron IO\Inputs\IDigitalInput.cs" />
     <Compile Include="Crestron IO\IOPortConfig.cs" />
+    <Compile Include="Crestron IO\Ir\CenIoIr104Controller.cs" />
     <Compile Include="Crestron IO\Relay\CenIoRy104Controller.cs" />
     <Compile Include="Crestron IO\Relay\GenericRelayDevice.cs" />
     <Compile Include="Crestron IO\Relay\ISwitchedOutput.cs" />

essentials-framework/Essentials Core/PepperDashEssentialsBase/Routing/IRoutingInputsExtensions.cs

@@ -11,12 +11,34 @@ using PepperDash.Core;
 
 namespace PepperDash.Essentials.Core
 {
+    public class RouteRequest
+    {
+        public IRoutingSink Destination {get; set;}
+        public IRoutingOutputs Source {get; set;}
+        public eRoutingSignalType SignalType {get; set;}
+
+        public void HandleCooldown(object sender, FeedbackEventArgs args)
+        {
+            var coolingDevice = sender as IWarmingCooling;
+            
+            if(args.BoolValue == false)
+            {
+                Destination.ReleaseAndMakeRoute(Source, SignalType);
+                
+                if(sender == null) return;
+
+                coolingDevice.IsCoolingDownFeedback.OutputChange -= HandleCooldown;
+            }
+        }
+    }
+
 	/// <summary>
 	/// Extensions added to any IRoutingInputs classes to provide discovery-based routing
 	/// on those destinations.
 	/// </summary>
 	public static class IRoutingInputsExtensions
 	{
+        private static Dictionary<string, RouteRequest> RouteRequests = new Dictionary<string, RouteRequest>();
 		/// <summary>
 		/// Gets any existing RouteDescriptor for a destination, clears it using ReleaseRoute
 		/// and then attempts a new Route and if sucessful, stores that RouteDescriptor
@@ -24,16 +46,58 @@ namespace PepperDash.Essentials.Core
 		/// </summary>
 		public static void ReleaseAndMakeRoute(this IRoutingSink destination, IRoutingOutputs source, eRoutingSignalType signalType)
 		{
-			destination.ReleaseRoute();
+            var routeRequest = new RouteRequest { 
+                        Destination = destination,
+                        Source = source,
+                        SignalType = signalType
+                    };
 
-			if (source == null) return;
-			var newRoute = destination.GetRouteToSource(source, signalType);
-			if (newRoute == null) return;
-			RouteDescriptorCollection.DefaultCollection.AddRouteDescriptor(newRoute);
-			Debug.Console(2, destination, "Executing full route");
-			newRoute.ExecuteRoutes();
+            var coolingDevice = destination as IWarmingCooling;
+
+            RouteRequest existingRouteRequest;
+
+            //We already have a route request for this device, and it's a cooling device and is cooling
+            if (RouteRequests.TryGetValue(destination.Key, out existingRouteRequest) && coolingDevice != null && coolingDevice.IsCoolingDownFeedback.BoolValue == true)
+            {                   
+                coolingDevice.IsCoolingDownFeedback.OutputChange -= existingRouteRequest.HandleCooldown;
+
+                coolingDevice.IsCoolingDownFeedback.OutputChange += routeRequest.HandleCooldown;
+
+                RouteRequests[destination.Key] = routeRequest;
+                return;
+            }            
+            
+            //New Request
+            if (coolingDevice != null && coolingDevice.IsCoolingDownFeedback.BoolValue == true)
+            {
+                coolingDevice.IsCoolingDownFeedback.OutputChange -= routeRequest.HandleCooldown;
+
+                coolingDevice.IsCoolingDownFeedback.OutputChange += routeRequest.HandleCooldown;
+
+                RouteRequests.Add(destination.Key, routeRequest);
+                return;
+            }
+
+            if (RouteRequests.ContainsKey(destination.Key) && coolingDevice != null && coolingDevice.IsCoolingDownFeedback.BoolValue == false)
+            {
+                RouteRequests.Remove(destination.Key);
+            }
+
+            destination.ReleaseRoute();
+
+			RunRouteRequest(routeRequest);
 		}
 
+        public static void RunRouteRequest(RouteRequest request)
+        {
+            if (request.Source == null) return;
+            var newRoute = request.Destination.GetRouteToSource(request.Source, request.SignalType);
+            if (newRoute == null) return;
+            RouteDescriptorCollection.DefaultCollection.AddRouteDescriptor(newRoute);
+            Debug.Console(2, request.Destination, "Executing full route");
+            newRoute.ExecuteRoutes();
+        }
+
 		/// <summary>
 		/// Will release the existing route on the destination, if it is found in 
 		/// RouteDescriptorCollection.DefaultCollection

essentials-framework/Essentials Devices Common/Essentials Devices Common/VideoCodec/VideoCodecBase.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using Crestron.SimplSharp.CrestronIO;
+using Crestron.SimplSharp.Reflection;
 using Crestron.SimplSharp.Ssh;
 using Crestron.SimplSharpPro.DeviceSupport;
 using Crestron.SimplSharp;
@@ -1010,7 +1011,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 
                 trilist.SetString(joinMap.DirectoryEntries.JoinNumber,
                     Encoding.GetEncoding(XSigEncoding).GetString(clearBytes, 0, clearBytes.Length));
-                var directoryXSig = UpdateDirectoryXSig(codec.DirectoryRoot, !codec.CurrentDirectoryResultIsNotDirectoryRoot.BoolValue);
+                var directoryXSig = UpdateDirectoryXSig(codec.DirectoryRoot, codec.CurrentDirectoryResultIsNotDirectoryRoot.BoolValue == false);
 
                 Debug.Console(2, this, "Directory XSig Length: {0}", directoryXSig.Length);
 
@@ -1025,7 +1026,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 
 				trilist.SetString(joinMap.DirectoryEntries.JoinNumber,
 					Encoding.GetEncoding(XSigEncoding).GetString(clearBytes, 0, clearBytes.Length));
-				var directoryXSig = UpdateDirectoryXSig(args.Directory, !codec.CurrentDirectoryResultIsNotDirectoryRoot.BoolValue);
+				var directoryXSig = UpdateDirectoryXSig(args.Directory, codec.CurrentDirectoryResultIsNotDirectoryRoot.BoolValue == false);
 
                 Debug.Console(2, this, "Directory XSig Length: {0}", directoryXSig.Length);
 
@@ -1036,10 +1037,9 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
             {
                 if (!args.DeviceOnLine) return;
 
-                // TODO [ ] Issue #868
                 trilist.SetString(joinMap.DirectoryEntries.JoinNumber, "\xFC");
                 UpdateDirectoryXSig(codec.CurrentDirectoryResult,
-                    !codec.CurrentDirectoryResultIsNotDirectoryRoot.BoolValue);
+                    codec.CurrentDirectoryResultIsNotDirectoryRoot.BoolValue == false);
             };
 		}
 
@@ -1180,31 +1180,44 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 
 		private string UpdateDirectoryXSig(CodecDirectory directory, bool isRoot)
 		{
-			var contactIndex = 1;
-			var tokenArray = new XSigToken[directory.CurrentDirectoryResults.Count];
+			var xSigMaxIndex = 1023;
+			var tokenArray = new XSigToken[directory.CurrentDirectoryResults.Count > xSigMaxIndex
+				? xSigMaxIndex 
+				: directory.CurrentDirectoryResults.Count];
 
-            Debug.Console(2, this, "Is root {0} Directory Count: {1}", isRoot, directory.CurrentDirectoryResults.Count);
+            Debug.Console(2, this, "IsRoot: {0}, Directory Count: {1}, TokenArray.Length: {2}", isRoot, directory.CurrentDirectoryResults.Count, tokenArray.Length);
 
-			foreach (var entry in directory.CurrentDirectoryResults)
+			var contacts = directory.CurrentDirectoryResults.Count > xSigMaxIndex
+				? directory.CurrentDirectoryResults.Take(xSigMaxIndex)
+				: directory.CurrentDirectoryResults;
+			
+			var contactsToDisplay = isRoot
+				? contacts.Where(c => c.ParentFolderId == "root")
+				: contacts.Where(c => c.ParentFolderId != "root");
+
+			var counterIndex = 1;
+			foreach (var entry in contactsToDisplay)
 			{
-				var arrayIndex = contactIndex - 1;
+				var arrayIndex = counterIndex - 1;
+				var entryIndex = counterIndex;
 
-                Debug.Console(2, this, "Entry Name: {0}, Folder ID: {1}", entry.Name, entry.FolderId);
+                Debug.Console(2, this, "Entry{2:0000} Name: {0}, Folder ID: {1}, Type: {3}, ParentFolderId: {4}", 
+					entry.Name, entry.FolderId, entryIndex, entry.GetType().GetCType().FullName, entry.ParentFolderId);
 
-				if (entry is DirectoryFolder && entry.ParentFolderId == "root")
+				if (entry is DirectoryFolder)
 				{
-					tokenArray[arrayIndex] = new XSigSerialToken(contactIndex, String.Format("[+] {0}", entry.Name));
+					tokenArray[arrayIndex] = new XSigSerialToken(entryIndex, String.Format("[+] {0}", entry.Name));
 
-					contactIndex++;
+					counterIndex++;
 
 					continue;
 				}
 
-				tokenArray[arrayIndex] = new XSigSerialToken(contactIndex, entry.Name);
+				tokenArray[arrayIndex] = new XSigSerialToken(entryIndex, entry.Name);
 
-				contactIndex++;
+				counterIndex++;
 			}
-
+			
 			return GetXSigString(tokenArray);
 		}
 

essentials-framework/Essentials Devices Common/Essentials Devices Common/VideoCodec/ZoomRoom/ZoomRoom.cs

@@ -2729,7 +2729,10 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 			{
 				Debug.Console(2, this, "OnDirectoryResultReturned.  Result has {0} contacts", result.Contacts.Count);
 
+				CurrentDirectoryResultIsNotDirectoryRoot.FireUpdate();
+
                 var directoryResult = result;
+				var directoryIsRoot = CurrentDirectoryResultIsNotDirectoryRoot.BoolValue == false;
 
 				// If result is Root, create a copy and filter out contacts whose parent folder is not root
                 //if (!CurrentDirectoryResultIsNotDirectoryRoot.BoolValue)
@@ -2747,7 +2750,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
                 //}
 
 				Debug.Console(2, this, "Updating directoryResult. IsOnRoot: {0} Contact Count: {1}",
-					!CurrentDirectoryResultIsNotDirectoryRoot.BoolValue, directoryResult.Contacts.Count);
+					directoryIsRoot, directoryResult.Contacts.Count);
 
 				// This will return the latest results to all UIs.  Multiple indendent UI Directory browsing will require a different methodology
 				var handler = DirectoryResultReturned;
@@ -2756,11 +2759,11 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 					handler(this, new DirectoryEventArgs
 					{
 						Directory = directoryResult,
-						DirectoryIsOnRoot = !CurrentDirectoryResultIsNotDirectoryRoot.BoolValue
+						DirectoryIsOnRoot = directoryIsRoot
 					});
 				}
 
-                CurrentDirectoryResultIsNotDirectoryRoot.FireUpdate();
+                
 			}
 			catch (Exception e)
 			{