Merge pull request #1 in PEC/pepperdash-simplsharp-core from feature/changeSaveMethod to master

* commit '4e9f7474a1c5bcbc11a93100f96711af2f04743f':
  Changed debug class to write to file rather than use datastore

Pepperdash Core/Pepperdash Core/Debug.cs

@@ -1,150 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-using Crestron.SimplSharp.CrestronDataStore;
-
-
-namespace PepperDash.Core
-{
-	public static class Debug
-	{
-
-
-		public static uint Level { get; private set; }
-
-		/// <summary>
-		/// This should called from the ControlSystem Initiailize method. It is only valid
-		/// in #pro environments because of direct console access and CrestronDataStoreStatic
-		/// </summary>
-		public static void Initialize()
-		{
-			if (CrestronEnvironment.RuntimeEnvironment == eRuntimeEnvironment.SimplSharpPro)
-			{
-				// Add command to console
-				CrestronConsole.AddNewConsoleCommand(SetDebugFromConsole, "appdebug",
-					"appdebug:P [0-2]: Sets the application's console debug message level",
-					ConsoleAccessLevelEnum.AccessOperator);
-
-				uint level = 0;
-				var err = CrestronDataStoreStatic.GetGlobalUintValue("DebugLevel", out level);
-				if (err == CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
-					SetDebugLevel(level);
-				else if (err == CrestronDataStore.CDS_ERROR.CDS_RECORD_NOT_FOUND)
-					CrestronDataStoreStatic.SetGlobalUintValue("DebugLevel", 0);
-				else
-					CrestronConsole.PrintLine("Error restoring console debug level setting: {0}", err);
-			}
-		}
-
-		/// <summary>
-		/// Callback for console command
-		/// </summary>
-		/// <param name="levelString"></param>
-		public static void SetDebugFromConsole(string levelString)
-		{
-			try
-			{
-				if (string.IsNullOrEmpty(levelString.Trim()))
-				{
-					CrestronConsole.PrintLine("AppDebug level = {0}", Level);
-					return;
-				}
-
-				SetDebugLevel(Convert.ToUInt32(levelString));
-			}
-			catch
-			{
-				CrestronConsole.PrintLine("Usage: appdebug:P [0-2]");
-			}
-		}
-
-		/// <summary>
-		/// Sets the debug level
-		/// </summary>
-		/// <param name="level"> Valid values 0 (no debug), 1 (critical), 2 (all messages)</param>
-		public static void SetDebugLevel(uint level)
-		{
-			if (level <= 2)
-			{
-				Level = level;
-				CrestronConsole.PrintLine("[Application {0}], Debug level set to {1}", 
-					InitialParametersClass.ApplicationNumber, Level);
-				if (CrestronEnvironment.RuntimeEnvironment == eRuntimeEnvironment.SimplSharpPro)
-				{
-					var err = CrestronDataStoreStatic.SetGlobalUintValue("DebugLevel", level);
-					if (err != CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
-						CrestronConsole.PrintLine("Error saving console debug level setting: {0}", err);
-				}
-			}
-		}
-
-		/// <summary>
-		/// Prints message to console if current debug level is equal to or higher than the level of this message.
-		/// Uses CrestronConsole.PrintLine.
-		/// </summary>
-		/// <param name="level"></param>
-		/// <param name="format">Console format string</param>
-		/// <param name="items">Object parameters</param>
-		public static void Console(uint level, string format, params object[] items)
-		{
-			if (Level >= level)
-				CrestronConsole.PrintLine("App {0}:{1}", InitialParametersClass.ApplicationNumber,
-					string.Format(format, items));
-		}
-
-		/// <summary>
-		/// Appends a device Key to the beginning of a message
-		/// </summary>
-		public static void Console(uint level, IKeyed dev, string format, params object[] items)
-		{
-			if (Level >= level)
-				Console(level, "[{0}] {1}", dev.Key, string.Format(format, items));
-		}
-
-		public static void Console(uint level, IKeyed dev, ErrorLogLevel errorLogLevel, 
-			string format, params object[] items)
-		{
-			if (Level >= level)
-			{
-				var str = string.Format("[{0}] {1}", dev.Key, string.Format(format, items));
-				Console(level, str);
-				LogError(errorLogLevel, str);
-			}
-		}
-
-		public static void Console(uint level, ErrorLogLevel errorLogLevel,
-			string format, params object[] items)
-		{
-			if (Level >= level)
-			{
-				var str = string.Format(format, items);
-				Console(level, str);
-				LogError(errorLogLevel, str);
-			}
-		}
-
-		public static void LogError(ErrorLogLevel errorLogLevel, string str)
-		{
-			string msg = string.Format("App {0}:{1}", InitialParametersClass.ApplicationNumber, str);
-			switch (errorLogLevel)
-			{
-				case ErrorLogLevel.Error:
-					ErrorLog.Error(msg);
-					break;
-				case ErrorLogLevel.Warning:
-					ErrorLog.Warn(msg);
-					break;
-				case ErrorLogLevel.Notice:
-					ErrorLog.Notice(msg);
-					break;
-			}
-		}
-
-		public enum ErrorLogLevel
-		{
-			Error, Warning, Notice, None
-		}
-	}
-}

Pepperdash Core/Pepperdash Core/Debug/Debug.cs

@@ -0,0 +1,239 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.CrestronDataStore;
+using Crestron.SimplSharp.CrestronIO;
+using Newtonsoft.Json;
+using PepperDash.Core.DebugThings;
+
+
+namespace PepperDash.Core
+{
+	public static class Debug
+	{
+		/// <summary>
+		/// Describes the folder location where a given program stores it's debug level memory. By default, the
+		/// file written will be named appNdebug where N is 1-10.
+		/// </summary>
+		public static string FilePathPrefix = @"\nvram\debug\";
+
+		/// <summary>
+		/// The name of the file containing the current debug settings.
+		/// </summary>
+		public static string FileName = string.Format(@"app{0}Debug.json", InitialParametersClass.ApplicationNumber);
+
+		public static int Level { get; private set; }
+
+		static DebugContextCollection Contexts;
+
+		static int SaveTimeoutMs = 30000;
+
+		static CTimer SaveTimer;
+
+		/// <summary>
+		/// This should called from the ControlSystem Initiailize method. Will attempt to call
+		/// CrestronDataStoreStatic.InitCrestronDataStore which may have been called elsewhere.
+		/// </summary>
+		public static void Initialize()
+		{
+			CrestronDataStoreStatic.InitCrestronDataStore();
+			if (CrestronEnvironment.RuntimeEnvironment == eRuntimeEnvironment.SimplSharpPro)
+			{
+				// Add command to console
+				CrestronConsole.AddNewConsoleCommand(SetDebugFromConsole, "appdebug",
+					"appdebug:P [0-2]: Sets the application's console debug message level",
+					ConsoleAccessLevelEnum.AccessOperator);
+			}
+
+			CrestronEnvironment.ProgramStatusEventHandler += CrestronEnvironment_ProgramStatusEventHandler;
+
+			LoadMemory();
+			Level = Contexts.GetOrCreateItem("DEFAULT").Level;
+		}
+
+		/// <summary>
+		/// Used to save memory when shutting down
+		/// </summary>
+		/// <param name="programEventType"></param>
+		static void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType)
+		{
+			if (programEventType == eProgramStatusEventType.Stopping)
+			{
+				if (SaveTimer != null)
+				{
+					SaveTimer.Stop();
+					SaveTimer = null;
+				}
+				Console(0, "Saving debug settings");
+				SaveMemory();
+			}
+		}
+
+		/// <summary>
+		/// Callback for console command
+		/// </summary>
+		/// <param name="levelString"></param>
+		public static void SetDebugFromConsole(string levelString)
+		{
+			try
+			{
+				if (string.IsNullOrEmpty(levelString.Trim()))
+				{
+					CrestronConsole.PrintLine("AppDebug level = {0}", Level);
+					return;
+				}
+
+				SetDebugLevel(Convert.ToInt32(levelString));
+			}
+			catch
+			{
+				CrestronConsole.PrintLine("Usage: appdebug:P [0-2]");
+			}
+		}
+
+		/// <summary>
+		/// Sets the debug level
+		/// </summary>
+		/// <param name="level"> Valid values 0 (no debug), 1 (critical), 2 (all messages)</param>
+		public static void SetDebugLevel(int level)
+		{
+			if (level <= 2)
+			{
+				Level = level;
+				Contexts.GetOrCreateItem("DEFAULT").Level = level;
+				SaveMemoryOnTimeout();
+
+				CrestronConsole.PrintLine("[Application {0}], Debug level set to {1}", 
+					InitialParametersClass.ApplicationNumber, Level);
+
+				//var err = CrestronDataStoreStatic.SetLocalUintValue("DebugLevel", level);
+				//if (err != CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
+				//    CrestronConsole.PrintLine("Error saving console debug level setting: {0}", err);
+			}
+		}
+
+		/// <summary>
+		/// Prints message to console if current debug level is equal to or higher than the level of this message.
+		/// Uses CrestronConsole.PrintLine.
+		/// </summary>
+		/// <param name="level"></param>
+		/// <param name="format">Console format string</param>
+		/// <param name="items">Object parameters</param>
+		public static void Console(uint level, string format, params object[] items)
+		{
+			if (Level >= level)
+				CrestronConsole.PrintLine("App {0}:{1}", InitialParametersClass.ApplicationNumber,
+					string.Format(format, items));
+		}
+
+		/// <summary>
+		/// Appends a device Key to the beginning of a message
+		/// </summary>
+		public static void Console(uint level, IKeyed dev, string format, params object[] items)
+		{
+			if (Level >= level)
+				Console(level, "[{0}] {1}", dev.Key, string.Format(format, items));
+		}
+
+		public static void Console(uint level, IKeyed dev, ErrorLogLevel errorLogLevel, 
+			string format, params object[] items)
+		{
+			if (Level >= level)
+			{
+				var str = string.Format("[{0}] {1}", dev.Key, string.Format(format, items));
+				Console(level, str);
+				LogError(errorLogLevel, str);
+			}
+		}
+
+		public static void Console(uint level, ErrorLogLevel errorLogLevel,
+			string format, params object[] items)
+		{
+			if (Level >= level)
+			{
+				var str = string.Format(format, items);
+				Console(level, str);
+				LogError(errorLogLevel, str);
+			}
+		}
+
+		public static void LogError(ErrorLogLevel errorLogLevel, string str)
+		{
+			string msg = string.Format("App {0}:{1}", InitialParametersClass.ApplicationNumber, str);
+			switch (errorLogLevel)
+			{
+				case ErrorLogLevel.Error:
+					ErrorLog.Error(msg);
+					break;
+				case ErrorLogLevel.Warning:
+					ErrorLog.Warn(msg);
+					break;
+				case ErrorLogLevel.Notice:
+					ErrorLog.Notice(msg);
+					break;
+			}
+		}
+
+		public enum ErrorLogLevel
+		{
+			Error, Warning, Notice, None
+		}
+
+
+		/// <summary>
+		/// Writes the memory object after timeout
+		/// </summary>
+		static void SaveMemoryOnTimeout()
+		{
+			if (SaveTimer == null)
+				SaveTimer = new CTimer(o => 
+				{
+					SaveTimer = null;
+					SaveMemory();
+				}, SaveTimeoutMs);
+			else
+				SaveTimer.Reset(SaveTimeoutMs);
+		}
+
+		/// <summary>
+		/// Writes the memory - use SaveMemoryOnTimeout
+		/// </summary>
+		static void SaveMemory()
+		{
+			//var dir = @"\NVRAM\debug";
+			//if (!Directory.Exists(dir))
+			//    Directory.Create(dir);
+
+			using (StreamWriter sw = new StreamWriter(GetMemoryFileName()))
+			{
+				var json = JsonConvert.SerializeObject(Contexts);
+				sw.Write(json);
+				sw.Flush();
+			}
+		}
+
+		static void LoadMemory()
+		{
+			if (File.Exists(GetMemoryFileName()))
+			{
+				using (StreamReader sr = new StreamReader(GetMemoryFileName()))
+				{
+					var json = sr.ReadToEnd();
+					Contexts = JsonConvert.DeserializeObject<DebugContextCollection>(json);
+				}
+			}
+			else
+				Contexts = new DebugContextCollection();
+		}
+
+		/// <summary>
+		/// Helper to get the file path for this app's debug memory
+		/// </summary>
+		static string GetMemoryFileName()
+		{
+			return string.Format(@"\NVRAM\debugSettings\program{0}", InitialParametersClass.ApplicationNumber);
+		}
+	}
+}

Pepperdash Core/Pepperdash Core/Debug/DebugContext.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+namespace PepperDash_Core.Debug
+{
+	public class DebugContext
+	{
+		public string Name { get; private set; }
+
+		public int Level { get; private set; }
+
+		public List<string> Keys { get; private set; }
+
+
+
+		public DebugContext(string name)
+		{
+
+		}
+
+
+	}
+}

Pepperdash Core/Pepperdash Core/Debug/DebugMemory.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+using Newtonsoft.Json;
+
+namespace PepperDash.Core.DebugThings
+{
+	public class DebugContextCollection
+	{
+		[JsonProperty("items")]
+		Dictionary<string, DebugContextItem> Items;
+
+		public DebugContextCollection()
+		{
+			Items = new Dictionary<string, DebugContextItem>();
+		}
+
+		/// <summary>
+		/// Sets the level of a given context item, and adds that item if it does not 
+		/// exist
+		/// </summary>
+		/// <param name="contextKey"></param>
+		/// <param name="level"></param>
+		/// <returns>True if the 0 <= level <= 2 and the conte </returns>
+		public void SetLevel(string contextKey, int level)
+		{
+			if (level < 0 || level > 2)
+				return;
+			GetOrCreateItem(contextKey).Level = level;
+		}
+
+		/// <summary>
+		/// Gets a level or creates it if not existing
+		/// </summary>
+		/// <param name="contextKey"></param>
+		/// <returns></returns>
+		public DebugContextItem GetOrCreateItem(string contextKey)
+		{
+			if (!Items.ContainsKey(contextKey))
+				Items[contextKey] = new DebugContextItem() { Level = 0 };
+			return Items[contextKey];
+		}
+	}
+
+	public class DebugContextItem
+	{
+		[JsonProperty("level")]
+		public int Level { get; set; }
+	}
+}

Pepperdash Core/Pepperdash Core/PepperDash_Core.csproj

@@ -67,7 +67,9 @@
     <Compile Include="Comm\GenericSocketStatusChangeEventArgs.cs" />
     <Compile Include="Comm\GenericSshClient.cs" />
     <Compile Include="CoreInterfaces.cs" />
-    <Compile Include="Debug.cs" />
+    <Compile Include="Debug\Debug.cs" />
+    <Compile Include="Debug\DebugContext.cs" />
+    <Compile Include="Debug\DebugMemory.cs" />
     <Compile Include="Device.cs" />
     <Compile Include="EthernetHelper.cs" />
     <Compile Include="Comm\GenericTcpIpClient.cs" />

Pepperdash Core/Pepperdash Core/bin/PepperDash_Core.config

@@ -10,8 +10,8 @@
     <ArchiveName />
   </RequiredInfo>
   <OptionalInfo>
-    <CompiledOn>11/15/2016 12:55:16 PM</CompiledOn>
+    <CompiledOn>11/28/2016 1:59:52 PM</CompiledOn>
-    <CompilerRev>1.0.0.23257</CompilerRev>
+    <CompilerRev>1.0.0.25195</CompilerRev>
   </OptionalInfo>
   <Plugin>
     <Version>Crestron.SIMPLSharp, Version=2.0.48.0, Culture=neutral, PublicKeyToken=812d080f93e2de10</Version>

Pepperdash Core/Pepperdash Core/bin/manifest.info

@@ -1,4 +1,4 @@
-MainAssembly=PepperDash_Core.dll:2eb6c529d49d8d4a7e636f33e87b1b6c
+MainAssembly=PepperDash_Core.dll:91882e81937f6bb6c3592368dedeea09
 MainAssemblyMinFirmwareVersion=1.007.0017
 MainAssemblyResource=SimplSharpData.dat:315526abf906cded47fb0c7510266a7e
 ü