Merge pull request #1212 from PepperDash/feature-2.0.0/versiport-room-combiner

Enable using Versiports with Room Combiner

.github/workflows/docker.yml

@@ -22,7 +22,7 @@ env:
 jobs:
   Build_Project_4-Series:
     runs-on: windows-latest
-    steps:      
+    steps:
       - uses: actions/checkout@v3
       - name: Set Version Number
         id: setVersion
@@ -57,28 +57,26 @@ jobs:
               $phase = 'beta'
               $newVersionString = "{0}-{1}-{2}" -f $newVersion, $phase, $Env:GITHUB_RUN_NUMBER
             }  
-          }          
-          echo "version=$newVersionString" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append      
+          }   
+                   
+          echo "version=$newVersionString" | Out-File -FilePath $env:GITHUB_OUTPUT -Encoding utf8 -Append
       - name: Setup MS Build
         uses: microsoft/setup-msbuild@v1.1
       - name: restore Nuget Packages
         run: nuget restore .\$($Env:SOLUTION_FILE).sln
       # Build the solutions in the docker image
-      - name: Build Solution        
+      - name: Build Solution
         run: msbuild .\$($Env:SOLUTION_FILE).sln /p:Platform="Any CPU" /p:Configuration="Debug" /p:Version="${{ steps.setVersion.outputs.version }}" -m
       - name: Pack Solution
         run: dotnet pack .\$($Env:SOLUTION_FILE).sln --configuration $env:BUILD_TYPE --output ./output /p:Version="${{ steps.setVersion.outputs.version }}"
       - name: Create tag for non-rc builds
-        if: contains(steps.setVersion.outputs.version, 'alpha')
+        if: ${{ !contains(steps.setVersion.outputs.version, 'rc') }}
         run: |
           git tag ${{ steps.setVersion.outputs.version }}
           git push --tags origin
       # Create the release on the source repo
       - name: Create Release
         id: create_release
-#        if: contains(steps.setVersion.outputs.version,'-rc-') ||
-#            contains(steps.setVersion.outputs.version,'-hotfix-') ||
-#            contains(steps.setVersion.outputs.version, '-beta-')
         uses: ncipollo/release-action@v1
         with:
           artifacts: 'output\**\*.*(cpz|cplz)'
@@ -86,11 +84,11 @@ jobs:
           prerelease: ${{contains('debug', env.BUILD_TYPE)}}
           tag: ${{ steps.setVersion.outputs.version }}
       - name: Setup Nuget
-        run: | 
+        run: |
           nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username pepperdash -password ${{ secrets.GITHUB_TOKEN }}
           nuget setApiKey ${{ secrets.GITHUB_TOKEN }} -Source github          
-          nuget setApiKey ${{ secrets.NUGET_API_KEY }} -Source https://api.nuget.org/v3/index.json          
+          nuget setApiKey ${{ secrets.NUGET_API_KEY }} -Source https://api.nuget.org/v3/index.json
       - name: Publish to Nuget
         run: nuget push .\output\*.nupkg -Source https://api.nuget.org/v3/index.json
       - name: Publish to Github Nuget
-        run: nuget push .\output\*.nupkg -Source github
+        run: nuget push .\output\*.nupkg -Source github

src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportInputDevice.cs

@@ -21,7 +21,7 @@ namespace PepperDash.Essentials.Core.CrestronIO
     /// <summary>
     /// Represents a generic digital input deviced tied to a versiport
     /// </summary>
-    public class GenericVersiportDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput
+    public class GenericVersiportDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput, IPartitionStateProvider
     {
         public Versiport InputPort { get; private set; }
 
@@ -35,10 +35,15 @@ namespace PepperDash.Essentials.Core.CrestronIO
             }
         }
 
+        public BoolFeedback PartitionPresentFeedback { get; }
+
+        public bool PartitionPresent => !InputStateFeedbackFunc();
+
         public GenericVersiportDigitalInputDevice(string key, string name, Func<IOPortConfig, Versiport> postActivationFunc, IOPortConfig config) :
             base(key, name)
         {
             InputStateFeedback = new BoolFeedback(InputStateFeedbackFunc);
+            PartitionPresentFeedback = new BoolFeedback(() => !InputStateFeedbackFunc());
 
             AddPostActivationAction(() =>
             {
@@ -52,7 +57,8 @@ namespace PepperDash.Essentials.Core.CrestronIO
 
                 InputPort.VersiportChange += InputPort_VersiportChange;
 
-
+                InputStateFeedback.FireUpdate();
+                PartitionPresentFeedback.FireUpdate();
 
                 Debug.LogMessage(LogEventLevel.Debug, this, "Created GenericVersiportDigitalInputDevice on port '{0}'.  DisablePullUpResistor: '{1}'", config.PortNumber, InputPort.DisablePullUpResistor);
 
@@ -65,7 +71,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
 			Debug.LogMessage(LogEventLevel.Debug, this, "Versiport change: {0}", args.Event);
 
             if(args.Event == eVersiportEvent.DigitalInChange)
+            {
                 InputStateFeedback.FireUpdate();
+                PartitionPresentFeedback.FireUpdate();
+            }
         }
 
 

src/PepperDash.Essentials.Core/DeviceTypeInterfaces/IEmergencyOSD.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace PepperDash.Essentials.Core.DeviceTypeInterfaces
+{
+    public interface IEmergencyOSD
+    {
+        void ShowEmergencyMessage(string url);
+        void HideEmergencyMessage();
+    }
+}

src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomConfig.cs

@@ -24,6 +24,7 @@ namespace PepperDash.Essentials.Room.Config
                 //switch on emergency type here.  Right now only contact and shutdown
                 var e = new EssentialsRoomEmergencyContactClosure(room.Key + "-emergency", props.Emergency, room);
                 DeviceManager.AddDevice(e);
+                return e;
             }
             return null;
         }

src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs

@@ -16,7 +16,7 @@
     public class EssentialsRoomEmergencyTriggerConfig
     {
         /// <summary>
-        /// contact,
+        /// contact,versiport
         /// </summary>
         public string Type { get; set; }
         /// <summary>

src/PepperDash.Essentials.Core/Room/EsentialsRoomEmergencyContactClosure.cs

@@ -4,12 +4,16 @@ using PepperDash.Essentials.Room.Config;
 
 namespace PepperDash.Essentials.Core
 {
-    public class EssentialsRoomEmergencyContactClosure : EssentialsRoomEmergencyBase
+    public class EssentialsRoomEmergencyContactClosure : EssentialsRoomEmergencyBase, IEssentialsRoomEmergency
     {
+        public event EventHandler<EventArgs> EmergencyStateChange;
+
         IEssentialsRoom Room;
         string Behavior;
         bool TriggerOnClose;
 
+        public bool InEmergency { get; private set; }
+
         public EssentialsRoomEmergencyContactClosure(string key, EssentialsRoomEmergencyConfig config, IEssentialsRoom room) :
             base(key)
         {
@@ -25,14 +29,49 @@ namespace PepperDash.Essentials.Core
                     cs.DigitalInputPorts[portNum].StateChange += EsentialsRoomEmergencyContactClosure_StateChange;
                 }
             }
+            else if (config.Trigger.Type.Equals("versiport", StringComparison.OrdinalIgnoreCase))
+            {
+                var portNum = (uint)config.Trigger.Number;
+                if (portNum <= cs.NumberOfVersiPorts)
+                {
+                    cs.VersiPorts[portNum].Register();
+                    cs.VersiPorts[portNum].SetVersiportConfiguration(eVersiportConfiguration.DigitalInput);
+                    cs.VersiPorts[portNum].DisablePullUpResistor = true;
+                    cs.VersiPorts[portNum].VersiportChange += EssentialsRoomEmergencyContactClosure_VersiportChange;
+                }
+            }
             Behavior = config.Behavior;
             TriggerOnClose = config.Trigger.TriggerOnClose;
         }
 
+        private void EssentialsRoomEmergencyContactClosure_VersiportChange(Versiport port, VersiportEventArgs args)
+        {
+            if (args.Event == eVersiportEvent.DigitalInChange)
+            {
+                ContactClosure_StateChange(port.DigitalIn);
+            }
+        }
+
         void EsentialsRoomEmergencyContactClosure_StateChange(DigitalInput digitalInput, DigitalInputEventArgs args)
         {
-            if (args.State && TriggerOnClose || !args.State && !TriggerOnClose)
+            ContactClosure_StateChange(args.State);
+        }
+
+        void ContactClosure_StateChange(bool portState)
+        {
+            if (portState && TriggerOnClose || !portState && !TriggerOnClose)
+            {
+                InEmergency = true;
+                if (EmergencyStateChange != null)
+                    EmergencyStateChange(this, new EventArgs());
                 RunEmergencyBehavior();
+            }
+            else
+            {
+                InEmergency = false;
+                if (EmergencyStateChange != null)
+                    EmergencyStateChange(this, new EventArgs());
+            }
         }
 
         /// <summary>
@@ -44,4 +83,14 @@ namespace PepperDash.Essentials.Core
                 Room.Shutdown();
         }
     }
+
+    /// <summary>
+    /// Describes the functionality of a room emergency contact closure
+    /// </summary>
+    public interface IEssentialsRoomEmergency
+    {
+        event EventHandler<EventArgs> EmergencyStateChange;
+
+        bool InEmergency { get; }
+    }
 }

src/PepperDash.Essentials.Core/Routing/Extensions.cs

@@ -108,25 +108,31 @@ namespace PepperDash.Essentials.Core
 
         private static void RunRouteRequest(RouteRequest request)
         {
-            if (request.Source == null)
-                return;
-
-            var (audioOrSingleRoute, videoRoute) = request.Destination.GetRouteToSource(request.Source, request.SignalType, request.DestinationPort, request.SourcePort);
-
-            if (audioOrSingleRoute == null && videoRoute == null)
-                return;
-
-            RouteDescriptorCollection.DefaultCollection.AddRouteDescriptor(audioOrSingleRoute);
-
-            if (videoRoute != null)
+            try
             {
-                RouteDescriptorCollection.DefaultCollection.AddRouteDescriptor(videoRoute);
+                if (request.Source == null)
+                    return;
+
+                var (audioOrSingleRoute, videoRoute) = request.Destination.GetRouteToSource(request.Source, request.SignalType, request.DestinationPort, request.SourcePort);
+
+                if (audioOrSingleRoute == null && videoRoute == null)
+                    return;
+
+                RouteDescriptorCollection.DefaultCollection.AddRouteDescriptor(audioOrSingleRoute);
+
+                if (videoRoute != null)
+                {
+                    RouteDescriptorCollection.DefaultCollection.AddRouteDescriptor(videoRoute);
+                }
+
+                Debug.LogMessage(LogEventLevel.Verbose, "Executing full route", request.Destination);
+
+                audioOrSingleRoute.ExecuteRoutes();
+                videoRoute?.ExecuteRoutes();
+            } catch(Exception ex)
+            {
+                Debug.LogMessage(ex, "Exception Running Route Request {request}", null, request);
             }
-
-            Debug.LogMessage(LogEventLevel.Verbose, "Executing full route", request.Destination);
-
-            audioOrSingleRoute.ExecuteRoutes();
-            videoRoute?.ExecuteRoutes();
         }
 
         public static void ReleaseRoute(this IRoutingInputs destination)
@@ -141,23 +147,28 @@ namespace PepperDash.Essentials.Core
         /// <param name="destination"></param>       
         public static void ReleaseRoute(this IRoutingInputs destination, string inputPortKey)
         {
-
-            Debug.LogMessage(LogEventLevel.Information, "Release route for {inputPortKey}", destination, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
-
-            if (RouteRequests.TryGetValue(destination.Key, out RouteRequest existingRequest) && destination is IWarmingCooling)
+            try
             {
-                var coolingDevice = destination as IWarmingCooling;
+                Debug.LogMessage(LogEventLevel.Information, "Release route for '{destination}':'{inputPortKey}'", destination?.Key ?? null, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
 
-                coolingDevice.IsCoolingDownFeedback.OutputChange -= existingRequest.HandleCooldown;
-            }
+                if (RouteRequests.TryGetValue(destination.Key, out RouteRequest existingRequest) && destination is IWarmingCooling)
+                {
+                    var coolingDevice = destination as IWarmingCooling;
 
-            RouteRequests.Remove(destination.Key);
+                    coolingDevice.IsCoolingDownFeedback.OutputChange -= existingRequest.HandleCooldown;
+                }
 
-            var current = RouteDescriptorCollection.DefaultCollection.RemoveRouteDescriptor(destination, inputPortKey);
-            if (current != null)
+                RouteRequests.Remove(destination.Key);
+
+                var current = RouteDescriptorCollection.DefaultCollection.RemoveRouteDescriptor(destination, inputPortKey);
+                if (current != null)
+                {
+                    Debug.LogMessage(LogEventLevel.Information, "Releasing current route: {0}", destination, current.Source.Key);
+                    current.ReleaseRoutes();
+                }
+            } catch (Exception ex)
             {
-                Debug.LogMessage(LogEventLevel.Debug, "Releasing current route: {0}", destination, current.Source.Key);
-                current.ReleaseRoutes();
+                Debug.LogMessage(ex, "Exception releasing route for '{destination}':'{inputPortKey}'",null, destination?.Key ?? null, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
             }
         }
 
@@ -179,7 +190,8 @@ namespace PepperDash.Essentials.Core
                 if (!destination.GetRouteToSource(source, null, null, signalType, 0, singleTypeRouteDescriptor, destinationPort, sourcePort))
                     singleTypeRouteDescriptor = null;
 
-                foreach (var route in singleTypeRouteDescriptor.Routes)
+                var routes = singleTypeRouteDescriptor?.Routes ?? new List<RouteSwitchDescriptor>();
+                foreach (var route in routes)
                 {
                     Debug.LogMessage(LogEventLevel.Verbose, "Route for device: {route}", destination, route.ToString());
                 }

src/PepperDash.Essentials.Core/Routing/RouteDescriptor.cs

@@ -12,19 +12,19 @@ namespace PepperDash.Essentials.Core
     /// Represents an collection of individual route steps between Source and Destination
     /// </summary>
     public class RouteDescriptor
-	{
-		public IRoutingInputs Destination { get; private set; }
+    {
+        public IRoutingInputs Destination { get; private set; }
 
         public RoutingInputPort InputPort { get; private set; }
 
-		public IRoutingOutputs Source { get; private set; }
-		public eRoutingSignalType SignalType { get; private set; }
-		public List<RouteSwitchDescriptor> Routes { get; private set; }
+        public IRoutingOutputs Source { get; private set; }
+        public eRoutingSignalType SignalType { get; private set; }
+        public List<RouteSwitchDescriptor> Routes { get; private set; }
 
 
-		public RouteDescriptor(IRoutingOutputs source, IRoutingInputs destination, eRoutingSignalType signalType):this(source,destination, null, signalType)
-		{
-		}
+        public RouteDescriptor(IRoutingOutputs source, IRoutingInputs destination, eRoutingSignalType signalType) : this(source, destination, null, signalType)
+        {
+        }
 
         public RouteDescriptor(IRoutingOutputs source, IRoutingInputs destination, RoutingInputPort inputPort, eRoutingSignalType signalType)
         {
@@ -35,20 +35,20 @@ namespace PepperDash.Essentials.Core
             Routes = new List<RouteSwitchDescriptor>();
         }
 
-		/// <summary>
-		/// Executes all routes described in this collection.  Typically called via
-		/// extension method IRoutingInputs.ReleaseAndMakeRoute()
-		/// </summary>
-		public void ExecuteRoutes()
-		{
-			foreach (var route in Routes)
-			{
-				Debug.LogMessage(LogEventLevel.Verbose, "ExecuteRoutes: {0}",null, route.ToString());
+        /// <summary>
+        /// Executes all routes described in this collection.  Typically called via
+        /// extension method IRoutingInputs.ReleaseAndMakeRoute()
+        /// </summary>
+        public void ExecuteRoutes()
+        {
+            foreach (var route in Routes)
+            {
+                Debug.LogMessage(LogEventLevel.Verbose, "ExecuteRoutes: {0}", null, route.ToString());
 
                 if (route.SwitchingDevice is IRoutingSinkWithSwitching sink)
-                {                   
+                {
                     sink.ExecuteSwitch(route.InputPort.Selector);
-                    continue; 
+                    continue;
                 }
 
                 if (route.SwitchingDevice is IRouting switchingDevice)
@@ -59,15 +59,15 @@ namespace PepperDash.Essentials.Core
 
                     Debug.LogMessage(LogEventLevel.Verbose, "Output port {0} routing. Count={1}", null, route.OutputPort.Key, route.OutputPort.InUseTracker.InUseCountFeedback.UShortValue);
                 }
-			}
-		}
+            }
+        }
 
-		/// <summary>
-		/// Releases all routes in this collection. Typically called via
-		/// extension method IRoutingInputs.ReleaseAndMakeRoute()
-		/// </summary>
-		public void ReleaseRoutes()
-		{
+        /// <summary>
+        /// Releases all routes in this collection. Typically called via
+        /// extension method IRoutingInputs.ReleaseAndMakeRoute()
+        /// </summary>
+        public void ReleaseRoutes()
+        {
             foreach (var route in Routes.Where(r => r.SwitchingDevice is IRouting))
             {
                 if (route.SwitchingDevice is IRouting switchingDevice)
@@ -77,8 +77,6 @@ namespace PepperDash.Essentials.Core
                         continue;
                     }
 
-                    switchingDevice.ExecuteSwitch(null, route.OutputPort.Selector, SignalType);
-
                     if (route.OutputPort.InUseTracker != null)
                     {
                         route.OutputPort.InUseTracker.RemoveUser(Destination, "destination-" + SignalType);
@@ -92,12 +90,12 @@ namespace PepperDash.Essentials.Core
             }
         }
 
-		public override string ToString()
-		{
-			var routesText = Routes.Select(r => r.ToString()).ToArray();
-			return string.Format("Route table from {0} to {1}:\r{2}", Source.Key, Destination.Key, string.Join("\r", routesText));
-		}
-	}
+        public override string ToString()
+        {
+            var routesText = Routes.Select(r => r.ToString()).ToArray();
+            return string.Format("Route table from {0} to {1}:\r{2}", Source.Key, Destination.Key, string.Join("\r", routesText));
+        }
+    }
 
     /*/// <summary>
     /// Represents an collection of individual route steps between Source and Destination

src/PepperDash.Essentials.Core/Routing/RouteDescriptorCollection.cs

@@ -41,7 +41,7 @@ namespace PepperDash.Essentials.Core
                 && RouteDescriptors.Any(t => t.Destination == descriptor.Destination && t.InputPort != null && descriptor.InputPort != null && t.InputPort.Key == descriptor.InputPort.Key))
             {
                 Debug.LogMessage(LogEventLevel.Debug, descriptor.Destination,
-                    "Route to [{0}] already exists in global routes table", descriptor.Source.Key);
+                    "Route to [{0}] already exists in global routes table", descriptor?.Source?.Key);
                 return;
             }
             RouteDescriptors.Add(descriptor);
@@ -53,14 +53,14 @@ namespace PepperDash.Essentials.Core
         /// <returns>null if no RouteDescriptor for a destination exists</returns>
         public RouteDescriptor GetRouteDescriptorForDestination(IRoutingInputs destination)
         {
-            Debug.LogMessage(LogEventLevel.Debug, "Getting route descriptor", destination);
+            Debug.LogMessage(LogEventLevel.Information, "Getting route descriptor for '{destination}'", destination?.Key ?? null);
 
             return RouteDescriptors.FirstOrDefault(rd => rd.Destination == destination);
         }
 
         public RouteDescriptor GetRouteDescriptorForDestinationAndInputPort(IRoutingInputs destination, string inputPortKey)
         {
-            Debug.LogMessage(LogEventLevel.Debug, "Getting route descriptor for {inputPortKey}", destination, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
+            Debug.LogMessage(LogEventLevel.Information, "Getting route descriptor for '{destination}':'{inputPortKey}'", destination?.Key ?? null, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
             return RouteDescriptors.FirstOrDefault(rd => rd.Destination == destination && rd.InputPort != null && rd.InputPort.Key == inputPortKey);
         }
 
@@ -70,7 +70,7 @@ namespace PepperDash.Essentials.Core
         /// </summary>
         public RouteDescriptor RemoveRouteDescriptor(IRoutingInputs destination, string inputPortKey = "")
         {
-            Debug.LogMessage(LogEventLevel.Debug, "Removing route descriptor for {inputPortKey}", destination, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
+            Debug.LogMessage(LogEventLevel.Information, "Removing route descriptor for '{destination}':'{inputPortKey}'", destination.Key ?? null, string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
 
             var descr = string.IsNullOrEmpty(inputPortKey) 
                 ? GetRouteDescriptorForDestination(destination)
@@ -78,7 +78,7 @@ namespace PepperDash.Essentials.Core
             if (descr != null)
                 RouteDescriptors.Remove(descr);
 
-            Debug.LogMessage(LogEventLevel.Debug, "Found route descriptor {routeDescriptor}", destination, descr);
+            Debug.LogMessage(LogEventLevel.Information, "Found route descriptor {routeDescriptor}", destination, descr);
 
             return descr;
         }