feat: move PD Core into Essentials

src/PepperDash.Core/PasswordManagement/Config.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Core.PasswordManagement
+{
+	/// <summary>
+	/// JSON password configuration 
+	/// </summary>
+	public class PasswordConfig
+	{
+	    /// <summary>
+	    /// Password object configured password
+	    /// </summary>
+	    public string password { get; set; }
+	    /// <summary>
+	    /// Constructor
+	    /// </summary>
+	    public PasswordConfig()
+	    {
+	        
+	    }
+	}
+}

src/PepperDash.Core/PasswordManagement/Constants.cs

@@ -0,0 +1,57 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Core.PasswordManagement
+{
+	/// <summary>
+	/// Constants
+	/// </summary>
+	public class PasswordManagementConstants
+	{
+		/// <summary>
+		/// Generic boolean value change constant
+		/// </summary>
+		public const ushort BoolValueChange = 1;
+		/// <summary>
+		/// Evaluated boolean change constant
+		/// </summary>
+		public const ushort PasswordInitializedChange = 2;
+		/// <summary>
+		/// Update busy change const
+		/// </summary>
+		public const ushort PasswordUpdateBusyChange = 3;
+		/// <summary>
+		/// Password is valid change constant
+		/// </summary>
+		public const ushort PasswordValidationChange = 4;
+		/// <summary>
+		/// Password LED change constant
+		/// </summary>
+		public const ushort PasswordLedFeedbackChange = 5;
+
+		/// <summary>
+		/// Generic ushort value change constant
+		/// </summary>
+		public const ushort UshrtValueChange = 101;
+		/// <summary>
+		/// Password count
+		/// </summary>
+		public const ushort PasswordManagerCountChange = 102;
+		/// <summary>
+		/// Password selecte index change constant
+		/// </summary>
+		public const ushort PasswordSelectIndexChange = 103;
+		/// <summary>
+		/// Password length
+		/// </summary>
+		public const ushort PasswordLengthChange = 104;
+		
+		/// <summary>
+		/// Generic string value change constant
+		/// </summary>
+		public const ushort StringValueChange = 201;		
+	}
+}

src/PepperDash.Core/PasswordManagement/PasswordClient.cs

@@ -0,0 +1,187 @@
+using System;
+
+namespace PepperDash.Core.PasswordManagement
+{
+    /// <summary>
+    /// A class to allow user interaction with the PasswordManager
+    /// </summary>
+	public class PasswordClient
+	{
+		/// <summary>
+		/// Password selected
+		/// </summary>
+		public string Password { get; set; }
+		/// <summary>
+		/// Password selected key
+		/// </summary>
+		public ushort Key { get; set; }
+		/// <summary>
+		/// Used to build the password entered by the user
+		/// </summary>
+		public string PasswordToValidate { get; set; }
+
+		/// <summary>
+		/// Boolean event 
+		/// </summary>
+		public event EventHandler<BoolChangeEventArgs> BoolChange;
+		/// <summary>
+		/// Ushort event
+		/// </summary>
+		public event EventHandler<UshrtChangeEventArgs> UshrtChange;
+		/// <summary>
+		/// String event
+		/// </summary>
+		public event EventHandler<StringChangeEventArgs> StringChange;
+
+		/// <summary>
+		/// Constructor
+		/// </summary>
+		public PasswordClient()
+		{
+			PasswordManager.PasswordChange += new EventHandler<StringChangeEventArgs>(PasswordManager_PasswordChange);
+		}		
+
+		/// <summary>
+		/// Initialize method
+		/// </summary>
+		public void Initialize()
+		{
+			OnBoolChange(false, 0, PasswordManagementConstants.PasswordInitializedChange);
+
+			Password = "";
+			PasswordToValidate = "";
+
+			OnUshrtChange((ushort)PasswordManager.Passwords.Count, 0, PasswordManagementConstants.PasswordManagerCountChange);
+			OnBoolChange(true, 0, PasswordManagementConstants.PasswordInitializedChange);
+		}
+
+		/// <summary>
+		/// Retrieve password by index
+		/// </summary>
+		/// <param name="key"></param>
+		public void GetPasswordByIndex(ushort key)
+		{
+			OnUshrtChange((ushort)PasswordManager.Passwords.Count, 0, PasswordManagementConstants.PasswordManagerCountChange);
+
+			Key = key;
+
+			var pw = PasswordManager.Passwords[Key];
+			if (pw == null)
+			{
+				OnUshrtChange(0, 0, PasswordManagementConstants.PasswordLengthChange);
+				return;
+			}
+
+			Password = pw;
+			OnUshrtChange((ushort)Password.Length, 0, PasswordManagementConstants.PasswordLengthChange);
+			OnUshrtChange(key, 0, PasswordManagementConstants.PasswordSelectIndexChange);
+		}
+
+		/// <summary>
+		/// Password validation method
+		/// </summary>
+		/// <param name="password"></param>
+		public void ValidatePassword(string password)
+		{
+			if (string.IsNullOrEmpty(password))
+				return;
+
+			if (string.Equals(Password, password))
+				OnBoolChange(true, 0, PasswordManagementConstants.PasswordValidationChange);
+			else
+				OnBoolChange(false, 0, PasswordManagementConstants.PasswordValidationChange);
+
+			ClearPassword();
+		}
+
+		/// <summary>
+		/// Builds the user entered passwrod string, will attempt to validate the user entered
+		/// password against the selected password when the length of the 2 are equal
+		/// </summary>
+		/// <param name="data"></param>
+		public void BuildPassword(string data)
+		{
+			PasswordToValidate = String.Concat(PasswordToValidate, data);
+			OnBoolChange(true, (ushort)PasswordToValidate.Length, PasswordManagementConstants.PasswordLedFeedbackChange);
+
+			if (PasswordToValidate.Length == Password.Length)
+				ValidatePassword(PasswordToValidate);
+		}
+
+		/// <summary>
+		/// Clears the user entered password and resets the LEDs
+		/// </summary>
+		public void ClearPassword()
+		{
+			PasswordToValidate = "";
+			OnBoolChange(false, (ushort)PasswordToValidate.Length, PasswordManagementConstants.PasswordLedFeedbackChange);
+		}
+
+		/// <summary>
+		/// Protected boolean change event handler
+		/// </summary>
+		/// <param name="state"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnBoolChange(bool state, ushort index, ushort type)
+		{
+			var handler = BoolChange;
+			if (handler != null)
+			{
+				var args = new BoolChangeEventArgs(state, type);
+				args.Index = index;
+				BoolChange(this, args);
+			}
+		}
+
+		/// <summary>
+		/// Protected ushort change event handler
+		/// </summary>
+		/// <param name="value"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnUshrtChange(ushort value, ushort index, ushort type)
+		{
+			var handler = UshrtChange;
+			if (handler != null)
+			{
+				var args = new UshrtChangeEventArgs(value, type);
+				args.Index = index;
+				UshrtChange(this, args);
+			}
+		}
+
+		/// <summary>
+		/// Protected string change event handler
+		/// </summary>
+		/// <param name="value"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnStringChange(string value, ushort index, ushort type)
+		{
+			var handler = StringChange;
+			if (handler != null)
+			{
+				var args = new StringChangeEventArgs(value, type);
+				args.Index = index;
+				StringChange(this, args);
+			}
+		}
+
+		/// <summary>
+		/// If password changes while selected change event will be notifed and update the client
+		/// </summary>
+		/// <param name="sender"></param>
+		/// <param name="args"></param>
+		protected void PasswordManager_PasswordChange(object sender, StringChangeEventArgs args)
+		{
+			//throw new NotImplementedException();
+			if (Key == args.Index)
+			{
+				//PasswordSelectedKey = args.Index;
+				//PasswordSelected = args.StringValue;
+				GetPasswordByIndex(args.Index);
+			}
+		}
+	}
+}

src/PepperDash.Core/PasswordManagement/PasswordManager.cs

@@ -0,0 +1,241 @@
+using System;
+using System.Collections.Generic;
+using Crestron.SimplSharp;
+
+namespace PepperDash.Core.PasswordManagement
+{
+    /// <summary>
+    /// Allows passwords to be stored and managed
+    /// </summary>
+	public class PasswordManager
+	{
+		/// <summary>
+		/// Public dictionary of known passwords
+		/// </summary>
+		public static Dictionary<uint, string> Passwords = new Dictionary<uint, string>();
+		/// <summary>
+		/// Private dictionary, used when passwords are updated
+		/// </summary>
+		private Dictionary<uint, string> _passwords = new Dictionary<uint, string>();
+
+		/// <summary>
+		/// Timer used to wait until password changes have stopped before updating the dictionary
+		/// </summary>
+		CTimer PasswordTimer;
+		/// <summary>
+		/// Timer length
+		/// </summary>
+		public long PasswordTimerElapsedMs = 5000;
+
+		/// <summary>
+		/// Boolean event 
+		/// </summary>
+		public event EventHandler<BoolChangeEventArgs> BoolChange;
+		/// <summary>
+		/// Ushort event
+		/// </summary>
+		public event EventHandler<UshrtChangeEventArgs> UshrtChange;
+		/// <summary>
+		/// String event
+		/// </summary>
+		public event EventHandler<StringChangeEventArgs> StringChange;
+		/// <summary>
+		/// Event to notify clients of an updated password at the specified index (uint)
+		/// </summary>
+		public static event EventHandler<StringChangeEventArgs> PasswordChange;
+
+		/// <summary>
+		/// Constructor
+		/// </summary>
+		public PasswordManager()
+		{
+
+		}
+
+		/// <summary>
+		/// Initialize password manager
+		/// </summary>
+		public void Initialize()
+		{
+			if (Passwords == null)
+				Passwords = new Dictionary<uint, string>();
+
+			if (_passwords == null)
+				_passwords = new Dictionary<uint, string>();
+
+			OnBoolChange(true, 0, PasswordManagementConstants.PasswordInitializedChange);
+		}
+
+		/// <summary>
+		/// Updates password stored in the dictonary
+		/// </summary>
+		/// <param name="key"></param>
+		/// <param name="password"></param>
+		public void UpdatePassword(ushort key, string password)
+		{
+			// validate the parameters
+			if (key > 0 && string.IsNullOrEmpty(password))
+			{
+				Debug.Console(1, string.Format("PasswordManager.UpdatePassword: key [{0}] or password are not valid", key, password));
+				return;
+			}
+
+			try
+			{
+				// if key exists, update the value
+				if(_passwords.ContainsKey(key))
+					_passwords[key] = password;
+				// else add the key & value
+				else
+					_passwords.Add(key, password);
+				
+				Debug.Console(1, string.Format("PasswordManager.UpdatePassword: _password[{0}] = {1}", key, _passwords[key]));
+
+				if (PasswordTimer == null)
+				{
+					PasswordTimer = new CTimer((o) => PasswordTimerElapsed(), PasswordTimerElapsedMs);
+					Debug.Console(1, string.Format("PasswordManager.UpdatePassword: CTimer Started"));
+					OnBoolChange(true, 0, PasswordManagementConstants.PasswordUpdateBusyChange);
+				}
+				else
+				{
+					PasswordTimer.Reset(PasswordTimerElapsedMs);
+					Debug.Console(1, string.Format("PasswordManager.UpdatePassword: CTimer Reset"));
+				}
+			}
+			catch (Exception e)
+			{
+				var msg = string.Format("PasswordManager.UpdatePassword key-value[{0}, {1}] failed:\r{2}", key, password, e);
+				Debug.Console(1, msg);
+			}
+		}
+
+		/// <summary>
+		/// CTimer callback function
+		/// </summary>
+		private void PasswordTimerElapsed()
+		{
+			try
+			{
+				PasswordTimer.Stop();
+				Debug.Console(1, string.Format("PasswordManager.PasswordTimerElapsed: CTimer Stopped"));
+				OnBoolChange(false, 0, PasswordManagementConstants.PasswordUpdateBusyChange);
+				foreach (var pw in _passwords)
+				{
+					// if key exists, continue
+					if (Passwords.ContainsKey(pw.Key))
+					{
+						Debug.Console(1, string.Format("PasswordManager.PasswordTimerElapsed: pw.key[{0}] = {1}", pw.Key, pw.Value));
+						if (Passwords[pw.Key] != _passwords[pw.Key])
+						{
+							Passwords[pw.Key] = _passwords[pw.Key];
+							Debug.Console(1, string.Format("PasswordManager.PasswordTimerElapsed: Updated Password[{0} = {1}", pw.Key, Passwords[pw.Key]));
+							OnPasswordChange(Passwords[pw.Key], (ushort)pw.Key, PasswordManagementConstants.StringValueChange);
+						}
+					}
+					// else add the key & value
+					else
+					{
+						Passwords.Add(pw.Key, pw.Value);
+					}
+				}
+				OnUshrtChange((ushort)Passwords.Count, 0, PasswordManagementConstants.PasswordManagerCountChange);
+			}
+			catch (Exception e)
+			{
+				var msg = string.Format("PasswordManager.PasswordTimerElapsed failed:\r{0}", e);
+				Debug.Console(1, msg);
+			}
+		}
+
+		/// <summary>
+		/// Method to change the default timer value, (default 5000ms/5s)
+		/// </summary>
+		/// <param name="time"></param>
+		public void PasswordTimerMs(ushort time)
+		{
+			PasswordTimerElapsedMs = Convert.ToInt64(time);
+		}
+
+		/// <summary>
+		/// Helper method for debugging to see what passwords are in the lists
+		/// </summary>
+		public void ListPasswords()
+		{
+			Debug.Console(0, "PasswordManager.ListPasswords:\r");
+			foreach (var pw in Passwords)
+				Debug.Console(0, "Passwords[{0}]: {1}\r", pw.Key, pw.Value);
+			Debug.Console(0, "\n");
+			foreach (var pw in _passwords)
+				Debug.Console(0, "_passwords[{0}]: {1}\r", pw.Key, pw.Value);
+		}
+
+		/// <summary>
+		/// Protected boolean change event handler
+		/// </summary>
+		/// <param name="state"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnBoolChange(bool state, ushort index, ushort type)
+		{
+			var handler = BoolChange;
+			if (handler != null)
+			{
+				var args = new BoolChangeEventArgs(state, type);
+				args.Index = index;
+				BoolChange(this, args);
+			}
+		}
+
+		/// <summary>
+		/// Protected ushort change event handler
+		/// </summary>
+        /// <param name="value"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnUshrtChange(ushort value, ushort index, ushort type)
+		{
+			var handler = UshrtChange;
+			if (handler != null)
+			{
+				var args = new UshrtChangeEventArgs(value, type);
+				args.Index = index;
+				UshrtChange(this, args);
+			}
+		}
+
+		/// <summary>
+		/// Protected string change event handler
+		/// </summary>
+		/// <param name="value"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnStringChange(string value, ushort index, ushort type)
+		{
+			var handler = StringChange;
+			if (handler != null)
+			{
+				var args = new StringChangeEventArgs(value, type);
+				args.Index = index;
+				StringChange(this, args);
+			}
+		}
+
+		/// <summary>
+		/// Protected password change event handler
+		/// </summary>
+		/// <param name="value"></param>
+		/// <param name="index"></param>
+		/// <param name="type"></param>
+		protected void OnPasswordChange(string value, ushort index, ushort type)
+		{
+			var handler = PasswordChange;
+			if (handler != null)
+			{
+				var args = new StringChangeEventArgs(value, type);
+				args.Index = index;
+				PasswordChange(this, args);
+			}
+		}
+	}
+}