fix: add ClearRoute method

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

@@ -38,16 +38,49 @@ namespace PepperDash.Essentials.Core
 
             ReleaseAndMakeRoute(destination, source, signalType, inputPort, outputPort);
         }
+
+        /// <summary>
+        /// Will release the existing route to the destination, if a route is found. This does not CLEAR the route, only stop counting usage time on any output ports that have a usage tracker set
+        /// </summary>
+        /// <param name="destination">destination to clear</param>
         public static void ReleaseRoute(this IRoutingInputs destination)
         {
-            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination, string.Empty));
+            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination, string.Empty, false));
         }
 
+        /// <summary>
+        /// Will release the existing route to the destination, if a route is found. This does not CLEAR the route, only stop counting usage time on any output ports that have a usage tracker set
+        /// </summary>
+        /// <param name="destination">destination to clear</param>
+        /// <param name="inputPortKey">Input to use to find existing route</param>
         public static void ReleaseRoute(this IRoutingInputs destination, string inputPortKey)
         {
-            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination, inputPortKey));
+            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination, inputPortKey, false));
         }
 
+        /// <summary>
+        /// Clears the route on the destination.  This will remove any routes that are currently in use
+        /// </summary>
+        /// <param name="destination">Destination</param>
+        public static void ClearRoute(this IRoutingInputs destination)
+        {
+            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination, string.Empty, true));
+        }
+
+        /// <summary>
+        /// Clears the route on the destination.  This will remove any routes that are currently in use
+        /// </summary>
+        /// <param name="destination">destination</param>
+        /// <param name="inputPortKey">input to use to find existing route</param>
+        public static void ClearRoute(this IRoutingInputs destination, string inputPortKey)
+        {
+            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination, inputPortKey, true));
+        }
+
+        /// <summary>
+        /// Removes the route request for the destination.  This will remove any routes that are currently in use
+        /// </summary>
+        /// <param name="destinationKey">destination device key</param>
         public static void RemoveRouteRequestForDestination(string destinationKey)
         {
             Debug.LogMessage(LogEventLevel.Information, "Removing route request for {destination}", null, destinationKey);
@@ -184,7 +217,7 @@ namespace PepperDash.Essentials.Core
                 Debug.LogMessage(LogEventLevel.Information, "Device: {destination} is NOT cooling down.  Removing stored route request and routing to source key: {sourceKey}", null, destination.Key, routeRequest.Source.Key);
             }
 
-            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination,destinationPort?.Key ?? string.Empty));
+            routeRequestQueue.Enqueue(new ReleaseRouteQueueItem(ReleaseRouteInternal, destination,destinationPort?.Key ?? string.Empty, false));
 
             routeRequestQueue.Enqueue(new RouteRequestQueueItem(RunRouteRequest, routeRequest));            
         }
@@ -216,14 +249,15 @@ namespace PepperDash.Essentials.Core
             {
                 Debug.LogMessage(ex, "Exception Running Route Request {request}", null, request);
             }
-        }        
+        }
 
         /// <summary>
-        /// Will release the existing route on the destination, if it is found in 
+        /// Will release the existing route on the destination, if it is found in RouteDescriptorCollection.DefaultCollection
-        /// RouteDescriptorCollection.DefaultCollection
         /// </summary>
-        /// <param name="destination"></param>       
+        /// <param name="destination"></param>     
-        private static void ReleaseRouteInternal(IRoutingInputs destination, string inputPortKey)
+        /// <param name="inputPortKey"> The input port key to use to find the route.  If empty, will use the first available input port</param>
+        /// <param name="clearRoute"> If true, will clear the route on the destination.  This will remove any routes that are currently in use</param>
+        private static void ReleaseRouteInternal(IRoutingInputs destination, string inputPortKey, bool clearRoute)
         {
             try
             {
@@ -242,7 +276,7 @@ namespace PepperDash.Essentials.Core
                 if (current != null)
                 {
                     Debug.LogMessage(LogEventLevel.Information, "Releasing current route: {0}", destination, current.Source.Key);
-                    current.ReleaseRoutes();
+                    current.ReleaseRoutes(clearRoute);
                 }
             } catch (Exception ex)
             {

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

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using Crestron.SimplSharpPro;
 
@@ -66,12 +67,25 @@ namespace PepperDash.Essentials.Core
         /// Releases all routes in this collection. Typically called via
         /// extension method IRoutingInputs.ReleaseAndMakeRoute()
         /// </summary>
-        public void ReleaseRoutes()
+        /// <param name="clearRoute">True to clear the route. Clearing sends `null` as the input selector to the ExecuteSwitch method</param>
+        public void ReleaseRoutes(bool clearRoute = false)
         {
             foreach (var route in Routes.Where(r => r.SwitchingDevice is IRouting))
             {
                 if (route.SwitchingDevice is IRouting switchingDevice)
                 {
+                    if(clearRoute)
+                    {
+                        try
+                        {
+                            switchingDevice.ExecuteSwitch(null, route.OutputPort.Selector, SignalType);
+                        }
+                        catch (Exception e)
+                        {
+                            Debug.LogError("Error executing switch: {exception}", e.Message);
+                        }
+                    }
+
                     if (route.OutputPort == null)
                     {
                         continue;

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

@@ -25,21 +25,23 @@ namespace PepperDash.Essentials.Core.Routing
 
     public class ReleaseRouteQueueItem : IQueueMessage
     {
-        private readonly Action<IRoutingInputs, string> action;
+        private readonly Action<IRoutingInputs, string, bool> action;
         private readonly IRoutingInputs destination;
         private readonly string inputPortKey;
+        private readonly bool clearRoute;
 
-        public ReleaseRouteQueueItem(Action<IRoutingInputs, string> action, IRoutingInputs destination, string inputPortKey)
+        public ReleaseRouteQueueItem(Action<IRoutingInputs, string, bool> action, IRoutingInputs destination, string inputPortKey, bool clearRoute)
         {
             this.action = action;
             this.destination = destination;
             this.inputPortKey = inputPortKey;
+            this.clearRoute = clearRoute;
         }
 
         public void Dispatch()
         {
             Debug.LogMessage(LogEventLevel.Information, "Dispatching release route request for {destination}:{inputPortKey}", null, destination?.Key ?? "no destination", string.IsNullOrEmpty(inputPortKey) ? "auto" : inputPortKey);
-            action(destination, inputPortKey);
+            action(destination, inputPortKey, clearRoute);
         }
     }
 }