feat: Adds ability to read configs generated from v2 config tool that are pre-merged don't have system or template objects

Refactor config handling and improve documentation

- Updated `PortalConfigReader.cs` to use constants for configuration keys, enhancing maintainability and readability. Improved error logging with `Debug.LogError`.
- Modified `ConfigReader.cs` to handle v2 configuration format, streamlining the loading process and avoiding redundant parsing.
- Added XML documentation comments to properties in `EssentialsConfig.cs`, improving code documentation. Initialized `Rooms` property in the constructor.
- Enhanced `SystemTemplateConfigs` class with XML documentation for better clarity on its properties.

src/PepperDash.Core/Config/PortalConfigReader.cs

@@ -9,40 +9,59 @@ using Serilog.Events;
 
 namespace PepperDash.Core.Config
 {
+
+
     /// <summary>
     /// Reads a Portal formatted config file
     /// </summary>
 	public class PortalConfigReader
 	{
-		/// <summary>
-		/// Reads the config file, checks if it needs a merge, merges and saves, then returns the merged Object.
-		/// </summary>
-		/// <returns>JObject of config file</returns>
-		public static void ReadAndMergeFileIfNecessary(string filePath, string savePath)
+        const string template = "template";
+        const string system = "system";
+		const string systemUrl = "system_url";
+        const string templateUrl = "template_url";
+		const string info = "info";
+        const string devices = "devices";
+        const string rooms = "rooms";
+        const string sourceLists = "sourceLists";
+        const string destinationLists = "destinationLists";
+        const string cameraLists = "cameraLists";
+        const string audioControlPointLists = "audioControlPointLists";
+
+		const string tieLines = "tieLines";
+        const string joinMaps = "joinMaps";
+		const string global = "global";
+
+
+        /// <summary>
+        /// Reads the config file, checks if it needs a merge, merges and saves, then returns the merged Object.
+        /// </summary>
+        /// <returns>JObject of config file</returns>
+        public static void ReadAndMergeFileIfNecessary(string filePath, string savePath)
 		{
 			try
 			{
 				if (!File.Exists(filePath))
 				{
-					Debug.Console(1, Debug.ErrorLogLevel.Error,
+					Debug.LogError(
 						"ERROR: Configuration file not present. Please load file to {0} and reset program", filePath);
 				}
 
 				using (StreamReader fs = new StreamReader(filePath))
 				{
 					var jsonObj = JObject.Parse(fs.ReadToEnd());
-					if(jsonObj["template"] != null && jsonObj["system"] != null)
+					if(jsonObj[template] != null && jsonObj[system] != null)
 					{
 						// it's a double-config, merge it.
 						var merged = MergeConfigs(jsonObj);
-						if (jsonObj["system_url"] != null)
+						if (jsonObj[systemUrl] != null)
 						{
-							merged["systemUrl"] = jsonObj["system_url"].Value<string>();
+							merged[systemUrl] = jsonObj[systemUrl].Value<string>();
 						}
 
-						if (jsonObj["template_url"] != null)
+						if (jsonObj[templateUrl] != null)
 						{
-							merged["templateUrl"] = jsonObj["template_url"].Value<string>();
+							merged[templateUrl] = jsonObj[templateUrl].Value<string>();
 						}
 
 						jsonObj = merged;
@@ -77,62 +96,62 @@ namespace PepperDash.Core.Config
 			var merged = new JObject();
 
 			// Put together top-level objects
-			if (system["info"] != null)
-				merged.Add("info", Merge(template["info"], system["info"], "infO"));
+			if (system[info] != null)
+				merged.Add(info, Merge(template[info], system[info], info));
 			else
-				merged.Add("info", template["info"]);
+				merged.Add(info, template[info]);
 
-			merged.Add("devices", MergeArraysOnTopLevelProperty(template["devices"] as JArray,
-				system["devices"] as JArray, "key", "devices"));
+			merged.Add(devices, MergeArraysOnTopLevelProperty(template[devices] as JArray,
+				system[devices] as JArray, "key", devices));
 
-			if (system["rooms"] == null)
-				merged.Add("rooms", template["rooms"]);
+			if (system[rooms] == null)
+				merged.Add(rooms, template[rooms]);
 			else
-				merged.Add("rooms", MergeArraysOnTopLevelProperty(template["rooms"] as JArray,
-					system["rooms"] as JArray, "key", "rooms"));
+				merged.Add(rooms, MergeArraysOnTopLevelProperty(template[rooms] as JArray,
+					system[rooms] as JArray, "key", rooms));
 
-			if (system["sourceLists"] == null)
-				merged.Add("sourceLists", template["sourceLists"]);
+			if (system[sourceLists] == null)
+				merged.Add(sourceLists, template[sourceLists]);
 			else
-				merged.Add("sourceLists", Merge(template["sourceLists"], system["sourceLists"], "sourceLists"));
+				merged.Add(sourceLists, Merge(template[sourceLists], system[sourceLists], sourceLists));
 
-		    if (system["destinationLists"] == null)
-		        merged.Add("destinationLists", template["destinationLists"]);
+		    if (system[destinationLists] == null)
+		        merged.Add(destinationLists, template[destinationLists]);
 		    else
-		        merged.Add("destinationLists",
-		            Merge(template["destinationLists"], system["destinationLists"], "destinationLists"));
+		        merged.Add(destinationLists,
+		            Merge(template[destinationLists], system[destinationLists], destinationLists));
 
 
-            if (system["cameraLists"] == null)
-                merged.Add("cameraLists", template["cameraLists"]);
+            if (system[cameraLists] == null)
+                merged.Add(cameraLists, template[cameraLists]);
             else
-                merged.Add("cameraLists", Merge(template["cameraLists"], system["cameraLists"], "cameraLists"));
+                merged.Add(cameraLists, Merge(template[cameraLists], system[cameraLists], cameraLists));
 
-            if (system["audioControlPointLists"] == null)
-                merged.Add("audioControlPointLists", template["audioControlPointLists"]);
+            if (system[audioControlPointLists] == null)
+                merged.Add(audioControlPointLists, template[audioControlPointLists]);
             else
-                merged.Add("audioControlPointLists",
-                    Merge(template["audioControlPointLists"], system["audioControlPointLists"], "audioControlPointLists"));
+                merged.Add(audioControlPointLists,
+                    Merge(template[audioControlPointLists], system[audioControlPointLists], audioControlPointLists));
 
 
             // Template tie lines take precedence.  Config tool doesn't do them at system
             // level anyway...
-            if (template["tieLines"] != null)
-				merged.Add("tieLines", template["tieLines"]);
-			else if (system["tieLines"] != null)
-				merged.Add("tieLines", system["tieLines"]);
+            if (template[tieLines] != null)
+				merged.Add(tieLines, template[tieLines]);
+			else if (system[tieLines] != null)
+				merged.Add(tieLines, system[tieLines]);
 			else
-				merged.Add("tieLines", new JArray());
+				merged.Add(tieLines, new JArray());
 
-            if (template["joinMaps"] != null)
-                merged.Add("joinMaps", template["joinMaps"]);
+            if (template[joinMaps] != null)
+                merged.Add(joinMaps, template[joinMaps]);
             else
-                merged.Add("joinMaps", new JObject());
+                merged.Add(joinMaps, new JObject());
 
-			if (system["global"] != null)
-				merged.Add("global", Merge(template["global"], system["global"], "global"));
+			if (system[global] != null)
+				merged.Add(global, Merge(template[global], system[global], global));
 			else
-				merged.Add("global", template["global"]);
+				merged.Add(global, template[global]);
 
 			//Debug.Console(2, "MERGED CONFIG RESULT: \x0d\x0a{0}", merged);
 			return merged;
@@ -228,7 +247,7 @@ namespace PepperDash.Core.Config
 					}
 					catch (Exception e)
 					{
-						Debug.Console(1, Debug.ErrorLogLevel.Warning, "Cannot merge items at path {0}: \r{1}", propPath, e);
+						Debug.LogError("Cannot merge items at path {propPath}: \r{e}", propPath, e);
 					}
 				}
 			}

src/PepperDash.Core/Logging/Debug.cs

@@ -466,14 +466,14 @@ namespace PepperDash.Core
         /// </summary>
         public static void SetFileMinimumDebugLevel(LogEventLevel level)
         {
-            _fileLevelSwitch.MinimumLevel = level;
+            _errorLogLevelSwitch.MinimumLevel = level;
 
-            var err = CrestronDataStoreStatic.SetLocalUintValue(FileLevelStoreKey, (uint)level);
+            var err = CrestronDataStoreStatic.SetLocalUintValue(ErrorLogLevelStoreKey, (uint)level);
 
             if (err != CrestronDataStore.CDS_ERROR.CDS_SUCCESS)
                 LogMessage(LogEventLevel.Information, "Error saving File debug level setting: {error}", err);
 
-            LogMessage(LogEventLevel.Information, "File debug level set to {0}", _fileLevelSwitch.MinimumLevel);
+            LogMessage(LogEventLevel.Information, "File debug level set to {0}", _websocketLoggingLevelSwitch.MinimumLevel);
         }
 
         /// <summary>

src/PepperDash.Essentials.Core/Config/Essentials/ConfigReader.cs

@@ -124,22 +124,35 @@ namespace PepperDash.Essentials.Core.Config
                         Debug.LogMessage(LogEventLevel.Information, "Successfully Loaded Local Config");
 
                         return true;
-                    }
+                    }                   
                     else
                     {
-                        var doubleObj = JObject.Parse(fs.ReadToEnd());
-                        ConfigObject = PortalConfigReader.MergeConfigs(doubleObj).ToObject<EssentialsConfig>();
+                        var parsedConfig = JObject.Parse(fs.ReadToEnd());
 
-                        // Extract SystemUrl and TemplateUrl into final config output
-
-                        if (doubleObj["system_url"] != null)
+                        // Check if it's a v2 config (missing "system" or "template" nodes)
+                        // this means it's already merged by the Portal API
+                        // from the v2 config tool
+                        var isV2Config = parsedConfig["system"] == null || parsedConfig["template"] == null;
+                        
+                        if (isV2Config)
                         {
-                            ConfigObject.SystemUrl = doubleObj["system_url"].Value<string>();
+                            Debug.LogMessage(LogEventLevel.Information, "Config file is a v2 format, no merge necessary.");
+                            ConfigObject = parsedConfig.ToObject<EssentialsConfig>();
+                            Debug.LogMessage(LogEventLevel.Information, "Successfully Loaded v2 Config");
+                            return true;
                         }
 
-                        if (doubleObj["template_url"] != null)
+                        // Extract SystemUrl and TemplateUrl into final config output
+                        ConfigObject = PortalConfigReader.MergeConfigs(parsedConfig).ToObject<EssentialsConfig>();
+
+                        if (parsedConfig["system_url"] != null)
                         {
-                            ConfigObject.TemplateUrl = doubleObj["template_url"].Value<string>();
+                            ConfigObject.SystemUrl = parsedConfig["system_url"].Value<string>();
+                        }
+
+                        if (parsedConfig["template_url"] != null)
+                        {
+                            ConfigObject.TemplateUrl = parsedConfig["template_url"].Value<string>();
                         }
                     }
 

src/PepperDash.Essentials.Core/Config/Essentials/EssentialsConfig.cs

@@ -16,13 +16,21 @@ namespace PepperDash.Essentials.Core.Config
 	/// </summary>
 	public class EssentialsConfig : BasicConfig
 	{
-		[JsonProperty("system_url")]
+        /// <summary>
+        /// Gets or sets the SystemUrl
+        /// </summary>
+        [JsonProperty("system_url")]
         public string SystemUrl { get; set; }
 
-		[JsonProperty("template_url")]
+        /// <summary>
+        /// Gets or sets the TemplateUrl
+        /// </summary>
+        [JsonProperty("template_url")]
         public string TemplateUrl { get; set; }
 
-
+        /// <summary>
+        /// Gets the SystemUuid extracted from the SystemUrl
+        /// </summary>
 		[JsonProperty("systemUuid")]
 		public string SystemUuid
         {
@@ -45,6 +53,9 @@ namespace PepperDash.Essentials.Core.Config
             }
         }
 
+        /// <summary>
+        /// Gets the TemplateUuid extracted from the TemplateUrl
+        /// </summary>
 		[JsonProperty("templateUuid")]
 		public string TemplateUuid
         {
@@ -67,13 +78,16 @@ namespace PepperDash.Essentials.Core.Config
             }
         }
 
-		[JsonProperty("rooms")]
         /// <summary>
         /// Gets or sets the Rooms
         /// </summary>
+        [JsonProperty("rooms")]
+
         public List<DeviceConfig> Rooms { get; set; }
 
-
+        /// <summary>
+        /// Initializes a new instance of the <see cref="EssentialsConfig"/> class.
+        /// </summary>
         public EssentialsConfig()
             : base()
         {
@@ -86,11 +100,14 @@ namespace PepperDash.Essentials.Core.Config
  /// </summary>
 	public class SystemTemplateConfigs
 	{
-  /// <summary>
-  /// Gets or sets the System
-  /// </summary>
+        /// <summary>
+        /// Gets or sets the System
+        /// </summary>
 		public EssentialsConfig System { get; set; }
 
+        /// <summary>
+        /// Gets or sets the Template
+        /// </summary>
 		public EssentialsConfig Template { get; set; }
 	}
 }

src/PepperDash.Essentials.Core/Room/Combining/EssentialsRoomCombinerPropertiesConfig.cs

@@ -103,6 +103,12 @@ namespace PepperDash.Essentials.Core
         [JsonProperty("name")]
         public string Name { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether to hide this scenario in the UI.
+        /// </summary>
+        [JsonProperty("hideInUi", NullValueHandling = NullValueHandling.Ignore)]
+        public bool HideInUi { get; set; }
+
         /// <summary>
         /// Gets or sets the collection of partition states.
         /// </summary>

src/PepperDash.Essentials.Core/Room/Combining/IEssentialsRoomCombiner.cs

@@ -109,6 +109,12 @@ namespace PepperDash.Essentials.Core
         [JsonProperty("isActive")]
         bool IsActive { get; }
 
+        /// <summary>
+        /// Gets a value indicating whether this scenario should be hidden in the UI.
+        /// </summary>
+        [JsonProperty("hideInUi")]
+        bool HideInUi { get; }
+
         /// <summary>
         /// Activates this room combination scenario
         /// </summary>

src/PepperDash.Essentials.Core/Room/Combining/RoomCombinationScenario.cs

@@ -14,18 +14,40 @@ namespace PepperDash.Essentials.Core
     {
         private RoomCombinationScenarioConfig _config;
 
+        /// <summary>
+        /// Gets or sets the key associated with the object.
+        /// </summary>
         [JsonProperty("key")]
         public string Key { get; set; }
 
+        /// <summary>
+        /// Gets or sets the name associated with the object.
+        /// </summary>
         [JsonProperty("name")]
         public string Name { get; set; }
 
-        [JsonProperty("partitionStates")]
+        /// <summary>
+        /// Gets a value indicating whether to hide this scenario in the UI.
+        /// </summary>
+        ///        
+        [JsonProperty("hideInUi")]
+
+        public bool HideInUi
+        {
+            get { return _config.HideInUi; }
+        }
+
         /// <summary>
         /// Gets or sets the PartitionStates
         /// </summary>
+        ///
+        [JsonProperty("partitionStates")]
+
         public List<PartitionState> PartitionStates { get; private set; }
 
+        /// <summary>
+        /// Determines which UI devices get mapped to which room in this scenario.  The Key should be the key of the UI device and the Value should be the key of the room to map to
+        /// </summary>
         [JsonProperty("uiMap")]
         public Dictionary<string, string> UiMap { get; set; }
 

src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs

@@ -244,15 +244,13 @@ namespace PepperDash.Essentials
             CrestronEnvironment.ProgramStatusEventHandler +=
                 CrestronEnvironment_ProgramStatusEventHandler;
 
-            ApiOnlineAndAuthorized = new BoolFeedback("apiOnlineAndAuthorized", () =>
+            ApiOnlineAndAuthorized = new BoolFeedback(() =>
             {
                 if (_wsClient2 == null)
                     return false;
 
                 return _wsClient2.IsAlive && IsAuthorized;
             });
-
-            Debug.SetFileMinimumDebugLevel(Serilog.Events.LogEventLevel.Debug);
         }
 
         private void SetupDefaultRoomMessengers()
@@ -1919,8 +1917,7 @@ namespace PepperDash.Essentials
         /// <param name="e"></param>
         private void HandleError(object sender, ErrorEventArgs e)
         {
-            this.LogError("Websocket error {message}", e.Message);
-            this.LogError(e.Exception, "Websocket error");
+            this.LogError("Websocket error {0}", e.Message);
 
             IsAuthorized = false;
             StartServerReconnectTimer();
@@ -1933,7 +1930,7 @@ namespace PepperDash.Essentials
         /// <param name="e"></param>
         private void HandleClose(object sender, CloseEventArgs e)
         {
-            this.LogInformation(
+            this.LogDebug(
                 "Websocket close {code} {reason}, clean={wasClean}",
                 e.Code,
                 e.Reason,

src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelController.cs

@@ -190,25 +190,12 @@ namespace PepperDash.Essentials.Touchpanel
 
             RegisterForExtenders();
 
-            if (CrestronEnvironment.DevicePlatform != eDevicePlatform.Appliance)
-            {
-                this.LogInformation("Not running on processor. Skipping CS LAN Configuration");
-                return;
-            }
+            var csAdapterId = CrestronEthernetHelper.GetAdapterdIdForSpecifiedAdapterType(EthernetAdapterType.EthernetCSAdapter);
+            var csSubnetMask = CrestronEthernetHelper.GetEthernetParameter(CrestronEthernetHelper.ETHERNET_PARAMETER_TO_GET.GET_CURRENT_IP_MASK, csAdapterId);
+            var csIpAddress = CrestronEthernetHelper.GetEthernetParameter(CrestronEthernetHelper.ETHERNET_PARAMETER_TO_GET.GET_CURRENT_IP_ADDRESS, csAdapterId);
 
-            try
-            {
-                var csAdapterId = CrestronEthernetHelper.GetAdapterdIdForSpecifiedAdapterType(EthernetAdapterType.EthernetCSAdapter);
-                var csSubnetMask = CrestronEthernetHelper.GetEthernetParameter(CrestronEthernetHelper.ETHERNET_PARAMETER_TO_GET.GET_CURRENT_IP_MASK, csAdapterId);
-                var csIpAddress = CrestronEthernetHelper.GetEthernetParameter(CrestronEthernetHelper.ETHERNET_PARAMETER_TO_GET.GET_CURRENT_IP_ADDRESS, csAdapterId);
-
-                this.csSubnetMask = System.Net.IPAddress.Parse(csSubnetMask);
-                this.csIpAddress = System.Net.IPAddress.Parse(csIpAddress);
-            }
-            catch (ArgumentException)
-            {
-                this.LogInformation("This processor does not have a CS LAN");
-            }
+            this.csSubnetMask = System.Net.IPAddress.Parse(csSubnetMask);
+            this.csIpAddress = System.Net.IPAddress.Parse(csIpAddress);
         }
 
         /// <summary>
@@ -449,7 +436,7 @@ namespace PepperDash.Essentials.Touchpanel
 
             var processorIp = CrestronEthernetHelper.GetEthernetParameter(CrestronEthernetHelper.ETHERNET_PARAMETER_TO_GET.GET_CURRENT_IP_ADDRESS, lanAdapterId);
 
-            if (csIpAddress == null || csSubnetMask == null || url == null)
+            if(csIpAddress == null || csSubnetMask == null || url == null)
             {
                 this.LogWarning("CS IP Address Subnet Mask or url is null, cannot determine correct IP for URL");
                 return url;