Merge c5bcd89695 into a91af6bd75

Adds RFI Template

.github/ISSUE_TEMPLATE/rfi_request.md

@@ -0,0 +1,27 @@
+---
+name: Request for Information
+about: Request specific information about capabilities of the framework
+title: "[RFI]-"
+labels: RFI
+assignees: ''
+
+---
+
+**What is your request?**
+Please provide as much detail as possible.
+
+
+**What is the intended use case**
+- [ ] Essentials Standalone Application
+- [ ] Essentials + SIMPL Windows Hybrid
+
+**User Interface Requirements**
+- [ ] Not Applicable (logic only)
+- [ ] Crestron Smart Graphics Touchpanel
+- [ ] Cisco Touch10
+- [ ] Mobile Control
+- [ ] Crestron CH5 Touchpanel interface
+
+
+**Additional context**
+Add any other context or screenshots about the request here.

essentials-framework/Essentials Core/PepperDashEssentialsBase/Config/Essentials/ConfigWriter.cs

@@ -1,162 +1,162 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using Crestron.SimplSharp;
-using Crestron.SimplSharp.CrestronIO;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
-using PepperDash.Core;
-
-namespace PepperDash.Essentials.Core.Config
-{
-    /// <summary>
-    /// Responsible for updating config at runtime, and writing the updates out to a local file
-    /// </summary>
-    public class ConfigWriter
-    {
-        public const string LocalConfigFolder = "LocalConfig";
-
-        public const long WriteTimeout = 30000;
-
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.CrestronIO;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core.Config
+{
+    /// <summary>
+    /// Responsible for updating config at runtime, and writing the updates out to a local file
+    /// </summary>
+    public class ConfigWriter
+    {
+        public const string LocalConfigFolder = "LocalConfig";
+
+        public const long WriteTimeout = 30000;
+
         public static CTimer WriteTimer;
-		static CCriticalSection fileLock = new CCriticalSection();
-
-        /// <summary>
-        /// Updates the config properties of a device
-        /// </summary>
-        /// <param name="deviceKey"></param>
-        /// <param name="properties"></param>
-        /// <returns></returns>
-        public static bool UpdateDeviceProperties(string deviceKey, JToken properties)
-        {
-            bool success = false;
-
-            // Get the current device config
-            var deviceConfig = ConfigReader.ConfigObject.Devices.FirstOrDefault(d => d.Key.Equals(deviceKey));
-
-            if (deviceConfig != null)
-            {
-                // Replace the current properties JToken with the new one passed into this method
-                deviceConfig.Properties = properties;
-
-                Debug.Console(1, "Updated properties of device: '{0}'", deviceKey);
-
-                success = true;
-            }
-
-            ResetTimer();
-
-            return success;
-        }
-
-        public static bool UpdateDeviceConfig(DeviceConfig config)
-        {
-            bool success = false;
-
-            var deviceConfig = ConfigReader.ConfigObject.Devices.FirstOrDefault(d => d.Key.Equals(config.Key));
-
-            if (deviceConfig != null)
-            {
-                deviceConfig = config;
-
-                Debug.Console(1, "Updated config of device: '{0}'", config.Key);
-
-                success = true;
-            }
-
-            ResetTimer();
-
-            return success;
-        }
-
-        public static bool UpdateRoomConfig(DeviceConfig config)
-        {
-            bool success = false;
-
-            var deviceConfig = ConfigReader.ConfigObject.Rooms.FirstOrDefault(d => d.Key.Equals(config.Key));
-
-            if (deviceConfig != null)
-            {
-                deviceConfig = config;
-
-                Debug.Console(1, "Updated config of device: '{0}'", config.Key);
-
-                success = true;
-            }
-
-            ResetTimer();
-
-            return success;
-        }
-
-        /// <summary>
-        /// Resets (or starts) the write timer
-        /// </summary>
-        static void ResetTimer()
-        {
-            if (WriteTimer == null)
-                WriteTimer = new CTimer(WriteConfigFile, WriteTimeout);
-
-            WriteTimer.Reset(WriteTimeout);
-
-            Debug.Console(1, "Config File write timer has been reset.");
-        }
-
-        /// <summary>
-        /// Writes the current config to a file in the LocalConfig subfolder
-        /// </summary>
-        /// <returns></returns>
-        private static void WriteConfigFile(object o)
-        {
-            var filePath = Global.FilePathPrefix + LocalConfigFolder + Global.DirectorySeparator + "configurationFile.json";
-
-            var configData = JsonConvert.SerializeObject(ConfigReader.ConfigObject);
-
-            WriteFile(filePath, configData);
-        }
-
-        /// <summary>
-        /// Writes
-        /// </summary>
-        /// <param name="filepath"></param>
-        /// <param name="o"></param>
-        public static void WriteFile(string filePath, string configData)
-        {
-            if (WriteTimer != null)
-                WriteTimer.Stop();
-
-            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Writing Configuration to file");
-
-            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Attempting to write config file: '{0}'", filePath);
-
-            try
-            {
-                if (fileLock.TryEnter())
-                {
-                    using (StreamWriter sw = new StreamWriter(filePath))
-                    {
-                        sw.Write(configData);
-                        sw.Flush();
-                    }
-                }
-                else
-                {
-                    Debug.Console(0, Debug.ErrorLogLevel.Error, "Unable to enter FileLock");
-                }
-            }
-            catch (Exception e)
-            {
-                Debug.Console(0, Debug.ErrorLogLevel.Error, "Error: Config write failed: \r{0}", e);
-            }
-            finally
-            {
-                if (fileLock != null && !fileLock.Disposed)
-                    fileLock.Leave();
-
-            }
-        }
-
-
-    }
+		static CCriticalSection fileLock = new CCriticalSection();
+
+        /// <summary>
+        /// Updates the config properties of a device
+        /// </summary>
+        /// <param name="deviceKey"></param>
+        /// <param name="properties"></param>
+        /// <returns></returns>
+        public static bool UpdateDeviceProperties(string deviceKey, JToken properties)
+        {
+            bool success = false;
+
+            // Get the current device config
+            var deviceConfig = ConfigReader.ConfigObject.Devices.FirstOrDefault(d => d.Key.Equals(deviceKey));
+
+            if (deviceConfig != null)
+            {
+                // Replace the current properties JToken with the new one passed into this method
+                deviceConfig.Properties = properties;
+
+                Debug.Console(1, "Updated properties of device: '{0}'", deviceKey);
+
+                success = true;
+            }
+
+            ResetTimer();
+
+            return success;
+        }
+
+        public static bool UpdateDeviceConfig(DeviceConfig config)
+        {
+            bool success = false;
+
+            var deviceConfigIndex = ConfigReader.ConfigObject.Devices.FindIndex(d => d.Key.Equals(config.Key));
+
+            if (deviceConfigIndex >= 0)
+            {
+                ConfigReader.ConfigObject.Devices[deviceConfigIndex] = config;
+
+                Debug.Console(1, "Updated config of device: '{0}'", config.Key);
+
+                success = true;
+            }
+
+            ResetTimer();
+
+            return success;
+        }
+
+        public static bool UpdateRoomConfig(DeviceConfig config)
+        {
+            bool success = false;
+
+			var roomConfigIndex = ConfigReader.ConfigObject.Rooms.FindIndex(d => d.Key.Equals(config.Key));
+
+			if (roomConfigIndex >= 0)
+            {
+                ConfigReader.ConfigObject.Rooms[roomConfigIndex] = config;
+
+                Debug.Console(1, "Updated room of device: '{0}'", config.Key);
+
+                success = true;
+            }
+
+            ResetTimer();
+
+            return success;
+        }
+
+        /// <summary>
+        /// Resets (or starts) the write timer
+        /// </summary>
+        static void ResetTimer()
+        {
+            if (WriteTimer == null)
+                WriteTimer = new CTimer(WriteConfigFile, WriteTimeout);
+
+            WriteTimer.Reset(WriteTimeout);
+
+            Debug.Console(1, "Config File write timer has been reset.");
+        }
+
+        /// <summary>
+        /// Writes the current config to a file in the LocalConfig subfolder
+        /// </summary>
+        /// <returns></returns>
+        private static void WriteConfigFile(object o)
+        {
+            var filePath = Global.FilePathPrefix + LocalConfigFolder + Global.DirectorySeparator + "configurationFile.json";
+
+            var configData = JsonConvert.SerializeObject(ConfigReader.ConfigObject);
+
+            WriteFile(filePath, configData);
+        }
+
+        /// <summary>
+        /// Writes
+        /// </summary>
+        /// <param name="filepath"></param>
+        /// <param name="o"></param>
+        public static void WriteFile(string filePath, string configData)
+        {
+            if (WriteTimer != null)
+                WriteTimer.Stop();
+
+            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Writing Configuration to file");
+
+            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Attempting to write config file: '{0}'", filePath);
+
+            try
+            {
+                if (fileLock.TryEnter())
+                {
+                    using (StreamWriter sw = new StreamWriter(filePath))
+                    {
+                        sw.Write(configData);
+                        sw.Flush();
+                    }
+                }
+                else
+                {
+                    Debug.Console(0, Debug.ErrorLogLevel.Error, "Unable to enter FileLock");
+                }
+            }
+            catch (Exception e)
+            {
+                Debug.Console(0, Debug.ErrorLogLevel.Error, "Error: Config write failed: \r{0}", e);
+            }
+            finally
+            {
+                if (fileLock != null && !fileLock.Disposed)
+                    fileLock.Leave();
+
+            }
+        }
+
+
+    }
 }

essentials-framework/Essentials Core/PepperDashEssentialsBase/Devices/ReconfigurableDevice.cs

@@ -7,6 +7,8 @@ using Crestron.SimplSharpPro.DeviceSupport;
 using PepperDash.Core;
 using PepperDash.Essentials.Core.Bridges;
 using PepperDash.Essentials.Core.Config;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 
 namespace PepperDash.Essentials.Core.Devices
 {
@@ -52,6 +54,8 @@ namespace PepperDash.Essentials.Core.Devices
                 Name = config.Name;
         }
 
+
+
         /// <summary>
         /// Used by the extending class to allow for any custom actions to be taken (tell the ConfigWriter to write config, etc)
         /// </summary>

essentials-framework/Essentials Devices Common/Essentials Devices Common/Cameras/CameraBase.cs

@@ -8,6 +8,8 @@ using Crestron.SimplSharp.Reflection;
 using Crestron.SimplSharpPro.DeviceSupport;
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Devices;
+using PepperDash.Essentials.Core.Config;
 using PepperDash.Essentials.Core.Bridges;
 using PepperDash.Essentials.Core.Presets;
 using PepperDash.Essentials.Devices.Common.Codec;
@@ -25,7 +27,7 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
         Focus = 8
     }
 
-    public abstract class CameraBase : EssentialsDevice, IRoutingOutputs
+    public abstract class CameraBase : ReconfigurableDevice, IRoutingOutputs
 	{
         public eCameraControlMode ControlMode { get; protected set; }
 
@@ -70,12 +72,18 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
         // A bitmasked value to indicate the movement capabilites of this camera
         protected eCameraCapabilities Capabilities { get; set; }
 
-        protected CameraBase(string key, string name) :
-			base(key, name) 
-        {
-            OutputPorts = new RoutingPortCollection<RoutingOutputPort>();
+		protected CameraBase(DeviceConfig config) : base(config)
+		{
+			OutputPorts = new RoutingPortCollection<RoutingOutputPort>();
 
-            ControlMode = eCameraControlMode.Manual;
+			ControlMode = eCameraControlMode.Manual;
+
+		}
+
+        protected CameraBase(string key, string name) : 
+			this (new DeviceConfig{Name = name, Key = key})
+        {
+				
         }
 
         protected void LinkCameraToApi(CameraBase cameraDevice, BasicTriList trilist, uint joinStart, string joinMapKey,

essentials-framework/Essentials Devices Common/Essentials Devices Common/VideoCodec/Interfaces/IHasCodecLayouts.cs

@@ -27,8 +27,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
     {
         event EventHandler<LayoutInfoChangedEventArgs> AvailableLayoutsChanged;
 
-        BoolFeedback LayoutViewIsOnFirstPageFeedback { get; }  // TODO: #697 [ ] Consider modifying to report button visibility in func
-        BoolFeedback LayoutViewIsOnLastPageFeedback { get; } // TODO: #697 [ ] Consider modifying to report button visibility in func 
+        BoolFeedback LayoutViewIsOnFirstPageFeedback { get; }  // TODO: #697 [*] Consider modifying to report button visibility in func
+        BoolFeedback LayoutViewIsOnLastPageFeedback { get; } // TODO: #697 [*] Consider modifying to report button visibility in func 
         BoolFeedback CanSwapContentWithThumbnailFeedback { get; }
         BoolFeedback ContentSwappedWithThumbnailFeedback { get; }
 

essentials-framework/Essentials Devices Common/Essentials Devices Common/VideoCodec/VideoCodecBase.cs

@@ -673,7 +673,6 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 			trilist.SetBoolSigAction(joinMap.SourceShareAutoStart.JoinNumber, (b) => AutoShareContentWhileInCall = b);
 		}
 
-		// TODO [ ] 2021-01-06, jkd: Added to debug OBTP dialing issues
 		private List<Meeting> _currentMeetings = new List<Meeting>();
 
 		private void LinkVideoCodecScheduleToApi(IHasScheduleAwareness codec, BasicTriList trilist, VideoCodecControllerJoinMap joinMap)
@@ -685,7 +684,6 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 				codec.CodecSchedule.MeetingWarningMinutes = i;
 			});
 
-			// TODO [ ] 2021-01-06, jkd: Added to debug OBTP dialing issues
 			trilist.SetSigFalseAction(joinMap.DialMeeting1.JoinNumber, () =>
 			{
 				var mtg = 1;
@@ -695,7 +693,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 				if (_currentMeetings[index] != null)
 					Dial(_currentMeetings[index]);
 			});
-			// TODO [ ] 2021-01-06, jkd: Added to debug OBTP dialing issues				
+			
 			trilist.SetSigFalseAction(joinMap.DialMeeting2.JoinNumber, () =>
 			{
 				var mtg = 2;
@@ -705,7 +703,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 				if (_currentMeetings[index] != null)
 					Dial(_currentMeetings[index]);
 			});
-			// TODO [ ] 2021-01-06, jkd: Added to debug OBTP dialing issues
+			
 			trilist.SetSigFalseAction(joinMap.DialMeeting3.JoinNumber, () =>
 			{
 				var mtg = 3;
@@ -730,14 +728,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 		{
 			var currentTime = DateTime.Now;
 
-			// TODO [ ] 2021-01-06, jkd: Added to debug OBTP dialing issues				
-			// - changed var currentMeetings >> field _currentMeetings
-			//_currentMeetings.Clear();
 			_currentMeetings = codec.CodecSchedule.Meetings.Where(m => m.StartTime >= currentTime || m.EndTime >= currentTime).ToList();
 
-			// TODO [ ] 2021-01-06, jkd: Added to debug OBTP dialing issues				
-			// - moved the trilist.SetSigFlaseAction(joinMap.DialMeeting1..3.JoinNumber) lambda's to LinkVideoCodecScheduleToApi
-
 			var meetingsData = UpdateMeetingsListXSig(_currentMeetings);
 			trilist.SetString(joinMap.Schedule.JoinNumber, meetingsData);
 			trilist.SetUshort(joinMap.MeetingCount.JoinNumber, (ushort)_currentMeetings.Count);

essentials-framework/Essentials Devices Common/Essentials Devices Common/VideoCodec/ZoomRoom/ZoomRoom.cs

@@ -870,7 +870,6 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 				_jsonCurlyBraceCounter--;
 			}
 
-			// TODO [X] 2021-05-12, jkd: turned off to reduce console traffic
 			//Debug.Console(2, this, "JSON Curly Brace Count: {0}", _jsonCurlyBraceCounter);
 
 			if (!_jsonFeedbackMessageIsIncoming && message.Trim('\x20') == "{" + Delimiter)
@@ -2242,7 +2241,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 		private void ComputeAvailableLayouts()
 		{
 			zConfiguration.eLayoutStyle availableLayouts = zConfiguration.eLayoutStyle.None;
-			// TODO: #697 [ ] Compute the avaialble layouts and set the value of AvailableLayouts
+			// TODO: #697 [X] Compute the avaialble layouts and set the value of AvailableLayouts
 			// Will need to test and confirm that this logic evaluates correctly
 			if (Status.Layout.can_Switch_Wall_View)
 			{
@@ -2291,7 +2290,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 			if (CanSwapContentWithThumbnailFeedback.BoolValue)
 			{
 				var oppositeValue = ContentSwappedWithThumbnailFeedback.BoolValue ? "on" : "off"; // Get the value based on the opposite of the current state
-				// TODO: #697 [ ] Need to verify the ternary above and make sure that the correct on/off value is being send based on the true/false value of the feedback
+				// TODO: #697 [*] Need to verify the ternary above and make sure that the correct on/off value is being send based on the true/false value of the feedback
 				// to toggle the state
 				SendText(String.Format("zConfiguration Call Layout ShareThumb: {0}", oppositeValue));
 			}