Essentials/Essentials Core/PepperDashEssentialsBase/Devices/IrOutputPortController.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Crestron.SimplSharp;
using Crestron.SimplSharpPro;
using Crestron.SimplSharpPro.DeviceSupport;

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

		/// <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>
		///// When fed a dictionary of uint, string, will return UOs for each item, 
		///// attached to this IrOutputPort
		///// </summary>
		///// <param name="numStringDict"></param>
		///// <returns></returns>
		//public List<CueActionPair> GetUOsForIrCommands(Dictionary<Cue, string> numStringDict)
		//{
		//    var funcs = new List<CueActionPair>(numStringDict.Count);
		//    foreach (var kvp in numStringDict)
		//    {
		//        // Have to assign these locally because of kvp's scope
		//        var cue = kvp.Key;
		//        var command = kvp.Value;
		//        funcs.Add(new BoolCueActionPair(cue, b => this.PressRelease(command, b)));
		//    }
		//    return funcs;
		//}


	}
}