add static class for IR Command values and use them

PepperDashEssentials/Room/Types/EssentialsHuddleVtc1Room.cs

@@ -409,10 +409,14 @@ namespace PepperDash.Essentials
         {
             if (string.IsNullOrEmpty(sourceListKey))
             {
+                Debug.Console(1, this, "No sourceListKey present.  RunRouteAction assumes default source list.");
                 RunRouteAction(routeKey, new Action(() => { }));
             }
             else
+            {
+                Debug.Console(1, this, "sourceListKey present but not yet implemented");
                 throw new NotImplementedException();
+            }
         }
 
         /// <summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/Comm and IR/IRPortHelper.cs

@@ -1,83 +1,83 @@
-using System;
-using System.Collections.Generic;
-using Crestron.SimplSharp;
-using Crestron.SimplSharp.CrestronIO;
-using Crestron.SimplSharpPro;
-
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
-using PepperDash.Core;
-using PepperDash.Essentials.Core.Config;
-
-namespace PepperDash.Essentials.Core
-{
-	/// <summary>
-	/// 
-	/// </summary>
-	public static class IRPortHelper
-	{
-		public static string IrDriverPathPrefix
-		{
-			get
-			{
-				return Global.FilePathPrefix + "IR" + Global.DirectorySeparator;
-			}
-		}
-
-		/// <summary>
-		/// Finds either the ControlSystem or a device controller that contains IR ports and
-		/// returns a port from the hardware device
-		/// </summary>
-		/// <param name="propsToken"></param>
-		/// <returns>IrPortConfig object.  The port and or filename will be empty/null 
-		/// if valid values don't exist on config</returns>
-		public static IrOutPortConfig GetIrPort(JToken propsToken)
-		{
-			var control = propsToken["control"];
-			if (control == null)
-				return null;
-			if (control["method"].Value<string>() != "ir")
-			{
-				Debug.Console(0, "IRPortHelper called with non-IR properties");
-				return null;
-			}
-
-			var port = new IrOutPortConfig();
-
-			var portDevKey = control.Value<string>("controlPortDevKey");
-			var portNum = control.Value<uint>("controlPortNumber");
-			if (portDevKey == null || portNum == 0)
-			{
-				Debug.Console(1, "WARNING: Properties is missing port device or port number");
-				return port;
-			}
-
-			IIROutputPorts irDev = null;
-			if (portDevKey.Equals("controlSystem", StringComparison.OrdinalIgnoreCase)
-				|| portDevKey.Equals("processor", StringComparison.OrdinalIgnoreCase))
-				irDev = Global.ControlSystem;
-			else
-				irDev = DeviceManager.GetDeviceForKey(portDevKey) as IIROutputPorts;
-
-			if (irDev == null)
-			{
-				Debug.Console(1, "[Config] Error, device with IR ports '{0}' not found", portDevKey);
-				return port;
-			}
-
-			if (portNum <= irDev.NumberOfIROutputPorts) // success!
-			{
-				var file = IrDriverPathPrefix + control["irFile"].Value<string>();
-				port.Port = irDev.IROutputPorts[portNum];
-				port.FileName = file;
-				return port; // new IrOutPortConfig { Port = irDev.IROutputPorts[portNum], FileName = file };
-			}
-			else
-			{
-				Debug.Console(1, "[Config] Error, device '{0}' IR port {1} out of range",
-					portDevKey, portNum);
-				return port;
-			}
+using System;
+using System.Collections.Generic;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.CrestronIO;
+using Crestron.SimplSharpPro;
+
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using PepperDash.Core;
+using PepperDash.Essentials.Core.Config;
+
+namespace PepperDash.Essentials.Core
+{
+	/// <summary>
+	/// 
+	/// </summary>
+	public static class IRPortHelper
+	{
+		public static string IrDriverPathPrefix
+		{
+			get
+			{
+				return Global.FilePathPrefix + "IR" + Global.DirectorySeparator;
+			}
+		}
+
+		/// <summary>
+		/// Finds either the ControlSystem or a device controller that contains IR ports and
+		/// returns a port from the hardware device
+		/// </summary>
+		/// <param name="propsToken"></param>
+		/// <returns>IrPortConfig object.  The port and or filename will be empty/null 
+		/// if valid values don't exist on config</returns>
+		public static IrOutPortConfig GetIrPort(JToken propsToken)
+		{
+			var control = propsToken["control"];
+			if (control == null)
+				return null;
+			if (control["method"].Value<string>() != "ir")
+			{
+				Debug.Console(0, "IRPortHelper called with non-IR properties");
+				return null;
+			}
+
+			var port = new IrOutPortConfig();
+
+			var portDevKey = control.Value<string>("controlPortDevKey");
+			var portNum = control.Value<uint>("controlPortNumber");
+			if (portDevKey == null || portNum == 0)
+			{
+				Debug.Console(1, "WARNING: Properties is missing port device or port number");
+				return port;
+			}
+
+			IIROutputPorts irDev = null;
+			if (portDevKey.Equals("controlSystem", StringComparison.OrdinalIgnoreCase)
+				|| portDevKey.Equals("processor", StringComparison.OrdinalIgnoreCase))
+				irDev = Global.ControlSystem;
+			else
+				irDev = DeviceManager.GetDeviceForKey(portDevKey) as IIROutputPorts;
+
+			if (irDev == null)
+			{
+				Debug.Console(1, "[Config] Error, device with IR ports '{0}' not found", portDevKey);
+				return port;
+			}
+
+			if (portNum <= irDev.NumberOfIROutputPorts) // success!
+			{
+				var file = IrDriverPathPrefix + control["irFile"].Value<string>();
+				port.Port = irDev.IROutputPorts[portNum];
+				port.FileName = file;
+				return port; // new IrOutPortConfig { Port = irDev.IROutputPorts[portNum], FileName = file };
+			}
+			else
+			{
+				Debug.Console(1, "[Config] Error, device '{0}' IR port {1} out of range",
+					portDevKey, portNum);
+				return port;
+			}
 		}
 
 	    public static IROutputPort GetIrOutputPort(DeviceConfig dc)
@@ -124,7 +124,7 @@ namespace PepperDash.Essentials.Core
 	            Debug.Console(0, "WARNING: device with IR ports '{0}' not found", portDevKey);
 	            return null;
 	        }
-	        if (portNum >= irDev.NumberOfIROutputPorts)
+	        if (portNum > irDev.NumberOfIROutputPorts)
 	        {
 	            Debug.Console(0, "WARNING: device '{0}' IR port {1} out of range",
 	                portDevKey, portNum);
@@ -134,7 +134,9 @@ namespace PepperDash.Essentials.Core
 
 	        var port = irDev.IROutputPorts[portNum];
 
-	        port.LoadIRDriver(Global.FilePathPrefix + "IR" + Global.DirectorySeparator + control["irFile"].Value<string>());
+            var filePath = Global.FilePathPrefix + "ir" + Global.DirectorySeparator + control["irFile"].Value<string>();
+            Debug.Console(1, "*************Attemting to load IR file: {0}***************", filePath);
+	        port.LoadIRDriver(filePath);
 
 	        return port;
 
@@ -149,87 +151,88 @@ namespace PepperDash.Essentials.Core
 	            return null;
 	        }
 
-	        var irDevice = new IrOutputPortController(config.Key, GetIrOutputPort, config);
+            var postActivationFunc = new Func<DeviceConfig,IROutputPort> (GetIrOutputPort);
+	        var irDevice = new IrOutputPortController(config.Key + "-ir", postActivationFunc, config);
 
 	        return irDevice;
 	    }
 
-	    /*
-        /// <summary>
-        /// Returns a ready-to-go IrOutputPortController from a DeviceConfig object.
-        /// </summary>	
-        public static IrOutputPortController GetIrOutputPortController(DeviceConfig devConf)
-        {
-            var irControllerKey = devConf.Key + "-ir";
-            if (devConf.Properties == null)
-            {
-                Debug.Console(0, "[{0}] WARNING: Device config does not include properties.  IR will not function.", devConf.Key);
-                return new IrOutputPortController(irControllerKey, null, "");
-            }
-
-            var control = devConf.Properties["control"];
-            if (control == null)
-            {
-                var c = new IrOutputPortController(irControllerKey, null, "");
-                Debug.Console(0, c, "WARNING: Device config does not include control properties.  IR will not function");
-                return c;
-            }
-
-            var portDevKey = control.Value<string>("controlPortDevKey");
-            var portNum = control.Value<uint>("controlPortNumber");
-            IIROutputPorts irDev = null;
-
-            if (portDevKey == null)
-            {
-                var c = new IrOutputPortController(irControllerKey, null, "");
-                Debug.Console(0, c, "WARNING: control properties is missing ir device");
-                return c;
-            }
-
-            if (portNum == 0)
-            {
-                var c = new IrOutputPortController(irControllerKey, null, "");
-                Debug.Console(0, c, "WARNING: control properties is missing ir port number");
-                return c;
-            } 
-
-            if (portDevKey.Equals("controlSystem", StringComparison.OrdinalIgnoreCase)
-                || portDevKey.Equals("processor", StringComparison.OrdinalIgnoreCase))
-                irDev = Global.ControlSystem;
-            else
-                irDev = DeviceManager.GetDeviceForKey(portDevKey) as IIROutputPorts;
-
-            if (irDev == null)
-            {
-                var c = new IrOutputPortController(irControllerKey, null, "");
-                Debug.Console(0, c, "WARNING: device with IR ports '{0}' not found", portDevKey);
-                return c;
-            }
-
-            if (portNum <= irDev.NumberOfIROutputPorts) // success!
-                return new IrOutputPortController(irControllerKey, irDev.IROutputPorts[portNum],
-                    IrDriverPathPrefix + control["irFile"].Value<string>());
-            else
-            {
-                var c = new IrOutputPortController(irControllerKey, null, "");
-                Debug.Console(0, c, "WARNING: device '{0}' IR port {1} out of range",
-                    portDevKey, portNum);
-                return c;
-            }
+	    /*
+        /// <summary>
+        /// Returns a ready-to-go IrOutputPortController from a DeviceConfig object.
+        /// </summary>	
+        public static IrOutputPortController GetIrOutputPortController(DeviceConfig devConf)
+        {
+            var irControllerKey = devConf.Key + "-ir";
+            if (devConf.Properties == null)
+            {
+                Debug.Console(0, "[{0}] WARNING: Device config does not include properties.  IR will not function.", devConf.Key);
+                return new IrOutputPortController(irControllerKey, null, "");
+            }
+
+            var control = devConf.Properties["control"];
+            if (control == null)
+            {
+                var c = new IrOutputPortController(irControllerKey, null, "");
+                Debug.Console(0, c, "WARNING: Device config does not include control properties.  IR will not function");
+                return c;
+            }
+
+            var portDevKey = control.Value<string>("controlPortDevKey");
+            var portNum = control.Value<uint>("controlPortNumber");
+            IIROutputPorts irDev = null;
+
+            if (portDevKey == null)
+            {
+                var c = new IrOutputPortController(irControllerKey, null, "");
+                Debug.Console(0, c, "WARNING: control properties is missing ir device");
+                return c;
+            }
+
+            if (portNum == 0)
+            {
+                var c = new IrOutputPortController(irControllerKey, null, "");
+                Debug.Console(0, c, "WARNING: control properties is missing ir port number");
+                return c;
+            } 
+
+            if (portDevKey.Equals("controlSystem", StringComparison.OrdinalIgnoreCase)
+                || portDevKey.Equals("processor", StringComparison.OrdinalIgnoreCase))
+                irDev = Global.ControlSystem;
+            else
+                irDev = DeviceManager.GetDeviceForKey(portDevKey) as IIROutputPorts;
+
+            if (irDev == null)
+            {
+                var c = new IrOutputPortController(irControllerKey, null, "");
+                Debug.Console(0, c, "WARNING: device with IR ports '{0}' not found", portDevKey);
+                return c;
+            }
+
+            if (portNum <= irDev.NumberOfIROutputPorts) // success!
+                return new IrOutputPortController(irControllerKey, irDev.IROutputPorts[portNum],
+                    IrDriverPathPrefix + control["irFile"].Value<string>());
+            else
+            {
+                var c = new IrOutputPortController(irControllerKey, null, "");
+                Debug.Console(0, c, "WARNING: device '{0}' IR port {1} out of range",
+                    portDevKey, portNum);
+                return c;
+            }
         }*/
-	}
-
-	/// <summary>
-	/// Wrapper to help in IR port creation
-	/// </summary>
-	public class IrOutPortConfig
-	{
-		public IROutputPort Port { get; set; }
-		public string FileName { get; set; }
-
-		public IrOutPortConfig()
-		{
-			FileName = "";
-		}
-	}
+	}
+
+	/// <summary>
+	/// Wrapper to help in IR port creation
+	/// </summary>
+	public class IrOutPortConfig
+	{
+		public IROutputPort Port { get; set; }
+		public string FileName { get; set; }
+
+		public IrOutPortConfig()
+		{
+			FileName = "";
+		}
+	}
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/IrOutputPortController.cs

@@ -1,45 +1,45 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using Crestron.SimplSharp;
-using Crestron.SimplSharpPro;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Crestron.SimplSharp;
+using Crestron.SimplSharpPro;
 using Crestron.SimplSharpPro.DeviceSupport;
 using Newtonsoft.Json.Linq;
-using PepperDash.Essentials.Core.Config;
-
-
-using PepperDash.Core;
-
-namespace PepperDash.Essentials.Core
-{
-
-	/// <summary>
-	/// IR port wrapper. May act standalone
-	/// </summary>
-	public class IrOutputPortController : Device
-	{	
-		uint IrPortUid;
-		IROutputPort IrPort;
-
-		public ushort StandardIrPulseTime { get; set; }
-		public string DriverFilepath { get; private set; }
-		public bool DriverIsLoaded { get; private set; }
-
-		/// <summary>
-		/// Constructor for IrDevice base class.  If a null port is provided, this class will 
-		/// still function without trying to talk to a port.
-		/// </summary>
-		public IrOutputPortController(string key, IROutputPort port, string irDriverFilepath)
-			: base(key)
-		{
-			//if (port == null) throw new ArgumentNullException("port");
-			IrPort = port;
-			if (port == null)
-			{
-				Debug.Console(0, this, "WARNING No valid IR Port assigned to controller. IR will not function");
-				return;
-			}
-			LoadDriver(irDriverFilepath);
+using PepperDash.Essentials.Core.Config;
+
+
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+
+	/// <summary>
+	/// IR port wrapper. May act standalone
+	/// </summary>
+	public class IrOutputPortController : Device
+	{	
+		uint IrPortUid;
+		IROutputPort IrPort;
+
+		public ushort StandardIrPulseTime { get; set; }
+		public string DriverFilepath { get; private set; }
+		public bool DriverIsLoaded { get; private set; }
+
+		/// <summary>
+		/// Constructor for IrDevice base class.  If a null port is provided, this class will 
+		/// still function without trying to talk to a port.
+		/// </summary>
+		public IrOutputPortController(string key, IROutputPort port, string irDriverFilepath)
+			: base(key)
+		{
+			//if (port == null) throw new ArgumentNullException("port");
+			IrPort = port;
+			if (port == null)
+			{
+				Debug.Console(0, this, "WARNING No valid IR Port assigned to controller. IR will not function");
+				return;
+			}
+			LoadDriver(irDriverFilepath);
 		}
 
 	    public IrOutputPortController(string key, Func<DeviceConfig, IROutputPort> postActivationFunc,
@@ -49,90 +49,94 @@ namespace PepperDash.Essentials.Core
             AddPostActivationAction(() =>
             {
                 IrPort = postActivationFunc(config);
+                if (IrPort != null)
+                {
+                    DriverIsLoaded = true;
+                }
             });
 	    }
 
 	    
 
-	    /// <summary>
-		/// Loads the IR driver at path
-		/// </summary>
-		/// <param name="path"></param>
-		public void LoadDriver(string path)
-		{
-			if (string.IsNullOrEmpty(path)) path = DriverFilepath;
-			try
-			{
-				IrPortUid = IrPort.LoadIRDriver(path);
-				DriverFilepath = path;
-				StandardIrPulseTime = 200;
-				DriverIsLoaded = true;
-			}
-			catch
-			{
-				DriverIsLoaded = false;
-				var message = string.Format("WARNING IR Driver '{0}' failed to load", path);
-				Debug.Console(0, this, message);
-				ErrorLog.Error(message);
-			}
-		}
-
-
-		/// <summary>
-		/// Starts and stops IR command on driver. Safe for missing commands
-		/// </summary>
-		public virtual void PressRelease(string command, bool state)
-		{
-			Debug.Console(2, this, "IR:'{0}'={1}", command, state);
-			if (IrPort == null)
-			{
-				Debug.Console(2, this, "WARNING No IR Port assigned to controller");
-				return;
-			} 
-			if (!DriverIsLoaded)
-			{
-				Debug.Console(2, this, "WARNING IR driver is not loaded");
-				return;
-			}
-			if (state)
-			{
-				if (IrPort.IsIRCommandAvailable(IrPortUid, command))
-					IrPort.Press(IrPortUid, command);
-				else
-					NoIrCommandError(command);
-			}
-			else
-				IrPort.Release();
-		}
-
-		/// <summary>
-		/// Pulses a command on driver. Safe for missing commands
-		/// </summary>
-		public virtual void Pulse(string command, ushort time)
-		{
-			if (IrPort == null)
-			{
-				Debug.Console(2, this, "WARNING No IR Port assigned to controller");
-				return;
-			} 
-			if (!DriverIsLoaded)
-			{
-				Debug.Console(2, this, "WARNING IR driver is not loaded");
-				return;
-			}
-			if (IrPort.IsIRCommandAvailable(IrPortUid, command))
-				IrPort.PressAndRelease(IrPortUid, command, time);
-			else
-				NoIrCommandError(command);
-		}
-
-		/// <summary>
-		/// Notifies the console when a bad command is used.
-		/// </summary>
-		protected void NoIrCommandError(string command)
-		{
-			Debug.Console(2, this, "Device {0}: IR Driver {1} does not contain command {2}",
-				Key, IrPort.IRDriverFileNameByIRDriverId(IrPortUid), command);
+	    /// <summary>
+		/// Loads the IR driver at path
+		/// </summary>
+		/// <param name="path"></param>
+		public void LoadDriver(string path)
+		{
+			if (string.IsNullOrEmpty(path)) path = DriverFilepath;
+			try
+			{
+				IrPortUid = IrPort.LoadIRDriver(path);
+				DriverFilepath = path;
+				StandardIrPulseTime = 200;
+				DriverIsLoaded = true;
+			}
+			catch
+			{
+				DriverIsLoaded = false;
+				var message = string.Format("WARNING IR Driver '{0}' failed to load", path);
+				Debug.Console(0, this, message);
+				ErrorLog.Error(message);
+			}
 		}
-	}
+
+
+		/// <summary>
+		/// Starts and stops IR command on driver. Safe for missing commands
+		/// </summary>
+		public virtual void PressRelease(string command, bool state)
+		{
+			Debug.Console(2, this, "IR:'{0}'={1}", command, state);
+			if (IrPort == null)
+			{
+				Debug.Console(2, this, "WARNING No IR Port assigned to controller");
+				return;
+			} 
+			if (!DriverIsLoaded)
+			{
+				Debug.Console(2, this, "WARNING IR driver is not loaded");
+				return;
+			}
+			if (state)
+			{
+				if (IrPort.IsIRCommandAvailable(IrPortUid, command))
+					IrPort.Press(IrPortUid, command);
+				else
+					NoIrCommandError(command);
+			}
+			else
+				IrPort.Release();
+		}
+
+		/// <summary>
+		/// Pulses a command on driver. Safe for missing commands
+		/// </summary>
+		public virtual void Pulse(string command, ushort time)
+		{
+			if (IrPort == null)
+			{
+				Debug.Console(2, this, "WARNING No IR Port assigned to controller");
+				return;
+			} 
+			if (!DriverIsLoaded)
+			{
+				Debug.Console(2, this, "WARNING IR driver is not loaded");
+				return;
+			}
+			if (IrPort.IsIRCommandAvailable(IrPortUid, command))
+				IrPort.PressAndRelease(IrPortUid, command, time);
+			else
+				NoIrCommandError(command);
+		}
+
+		/// <summary>
+		/// Notifies the console when a bad command is used.
+		/// </summary>
+		protected void NoIrCommandError(string command)
+		{
+			Debug.Console(2, this, "Device {0}: IR Driver {1} does not contain command {2}",
+				Key, IrPort.IRDriverFileNameByIRDriverId(IrPortUid), command);
+		}
+	}
 }

essentials-framework/Essentials Devices Common/Essentials Devices Common/Streaming/AppleTV.cs

@@ -39,32 +39,32 @@ namespace PepperDash.Essentials.Devices.Common
 
 		public void Up(bool pressRelease)
 		{
-			IrPort.PressRelease("+", pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.Up, pressRelease);
 		}
 
 		public void Down(bool pressRelease)
 		{
-			IrPort.PressRelease("-", pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.Down, pressRelease);
 		}
 
 		public void Left(bool pressRelease)
 		{
-			IrPort.PressRelease(IROutputStandardCommands.IROut_TRACK_MINUS, pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.Left, pressRelease);
 		}
 
 		public void Right(bool pressRelease)
 		{
-			IrPort.PressRelease(IROutputStandardCommands.IROut_TRACK_PLUS, pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.Right, pressRelease);
 		}
 
 		public void Select(bool pressRelease)
 		{
-			IrPort.PressRelease(IROutputStandardCommands.IROut_ENTER, pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.Enter, pressRelease);
 		}
 
 		public void Menu(bool pressRelease)
 		{
-			IrPort.PressRelease("Menu", pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.Menu, pressRelease);
 		}
 
 		public void Exit(bool pressRelease)
@@ -78,12 +78,12 @@ namespace PepperDash.Essentials.Devices.Common
 
 		public void Play(bool pressRelease)
 		{
-			IrPort.PressRelease("PLAY/PAUSE", pressRelease);
+			IrPort.PressRelease(AppleTvIrCommands.PlayPause, pressRelease);
 		}
 
 		public void Pause(bool pressRelease)
 		{
-			IrPort.PressRelease("PLAY/PAUSE", pressRelease);
+            IrPort.PressRelease(AppleTvIrCommands.PlayPause, pressRelease);
 		}
 
 		/// <summary>
@@ -190,4 +190,16 @@ namespace PepperDash.Essentials.Devices.Common
         }
     }
 
+    public static class AppleTvIrCommands
+    {
+        public const string Up = "UP_ARROW";
+        public const string Down = "DOWN_ARROW";
+        public const string Left = "LEFT_ARROW";
+        public const string Right = "RIGHT_ARROW";
+        public const string Enter = "SELECT";
+        public const string PlayPause = "PLAY_PAUSE";
+        public const string Rewind = "REWIND";
+        public const string Menu = "MENU";
+        public const string FastForward = "FASTFORWARD";
+    }
 }