Essentials/Essentials Core/PepperDashEssentialsBase/Comm and IR/IRPortHelper.cs

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;
			}
		}

		/// <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 = "";
		}
	}
}