Merge d2d99d4bfa into 4bd71b04bf

Feature/add zoomroom participant actions

.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.

PepperDashEssentials/ControlSystem.cs

@@ -36,6 +36,7 @@ namespace PepperDash.Essentials
             Thread.MaxNumberOfUserThreads = 400;
             Global.ControlSystem = this;
             DeviceManager.Initialize(this);
+            SecretsManager.Initialize();
             SystemMonitor.ProgramInitialization.ProgramInitializationUnderUserControl = true;
         }
 

essentials-framework/Essentials Core/PepperDashEssentialsBase/Comm and IR/GenericComm.cs

@@ -25,6 +25,7 @@ namespace PepperDash.Essentials.Core
         public GenericComm(DeviceConfig config)
             : base(config)
         {
+
             PropertiesConfig = CommFactory.GetControlPropertiesConfig(config);
 
             var commPort = CommFactory.CreateCommForDevice(config);

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

@@ -30,7 +30,19 @@ namespace PepperDash.Essentials.Core.Config
 
         [JsonProperty("properties")]
         [JsonConverter(typeof(DevicePropertiesConverter))]
-        public JToken Properties { get; set; }
+        public JToken Properties { get; set; }
+
+        public DeviceConfig(DeviceConfig dc)
+        {
+            Key = dc.Key;
+            Uid = dc.Uid;
+            Name = dc.Name;
+            Group = dc.Group;
+            Type = dc.Type;
+            Properties = JToken.FromObject(dc.Properties);
+        }
+
+        public DeviceConfig() {}
     }
 
     /// <summary>

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 Core/PepperDashEssentialsBase/Extensions/JsonExtensions.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace PepperDash.Essentials.Core
+{
+    public static class JsonExtensions
+    {
+        public static List<JToken> FindTokens(this JToken containerToken, string name)
+        {
+            List<JToken> matches = new List<JToken>();
+            FindTokens(containerToken, name, matches);
+            return matches;
+        }
+
+        private static void FindTokens(JToken containerToken, string name, List<JToken> matches)
+        {
+            if (containerToken.Type == JTokenType.Object)
+            {
+                foreach (JProperty child in containerToken.Children<JProperty>())
+                {
+                    if (child.Name == name)
+                    {
+                        matches.Add(child.Value);
+                    }
+                    FindTokens(child.Value, name, matches);
+                }
+            }
+            else if (containerToken.Type == JTokenType.Array)
+            {
+                foreach (JToken child in containerToken.Children())
+                {
+                    FindTokens(child, name, matches);
+                }
+            }
+        }
+    }
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Factory/DeviceFactory.cs

@@ -7,6 +7,8 @@ using Crestron.SimplSharpPro;
 using Crestron.SimplSharpPro.GeneralIO;
 using Crestron.SimplSharp.Reflection;
 using PepperDash.Core;
+using Newtonsoft.Json.Linq;
+using Newtonsoft.Json;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Config;
 using PepperDash.Essentials.Core.CrestronIO;
@@ -83,33 +85,81 @@ namespace PepperDash.Essentials.Core
 
             var wrapper = new DeviceFactoryWrapper() { CType = cType, Description = description, FactoryMethod = method };
             DeviceFactory.FactoryMethods.Add(typeName, wrapper);
-        }
-
-		/// <summary>
-		/// The factory method for Core "things". Also iterates the Factory methods that have
-		/// been loaded from plugins
-		/// </summary>
-		/// <param name="dc"></param>
-		/// <returns></returns>
-        public static IKeyed GetDevice(DeviceConfig dc)
-        {
-            var key = dc.Key;
-            var name = dc.Name;
-            var type = dc.Type;
-            var properties = dc.Properties;	
-
-            var typeName = dc.Type.ToLower();
-
-            // Check for types that have been added by plugin dlls. 
-            if (FactoryMethods.ContainsKey(typeName))
-            {
-                Debug.Console(0, Debug.ErrorLogLevel.Notice, "Loading '{0}' from Essentials Core", dc.Type);
-                return FactoryMethods[typeName].FactoryMethod(dc);
-            }
-
-            return null;
-        }
-
+        }
+
+        private static void CheckForSecrets(IEnumerable<JProperty> obj)
+        {
+            foreach (var prop in obj.Where(prop => prop.Value as JObject != null))
+            {
+                if (prop.Name.ToLower() == "secret")
+                {
+                    var secret = GetSecret(prop.Children().First().ToObject<SecretsPropertiesConfig>());
+                    //var secret = GetSecret(JsonConvert.DeserializeObject<SecretsPropertiesConfig>(prop.Children().First().ToString()));
+                    prop.Parent.Replace(secret);
+                }
+                var recurseProp = prop.Value as JObject;
+                if (recurseProp == null) return;
+                CheckForSecrets(recurseProp.Properties());
+            }
+        }
+
+        private static string GetSecret(SecretsPropertiesConfig data)
+        {
+            var secretProvider = SecretsManager.GetSecretProviderByKey(data.Provider);
+            if (secretProvider == null) return null;
+            var secret = secretProvider.GetSecret(data.Key);
+            if (secret != null) return (string) secret.Value;
+            Debug.Console(1,
+                "Unable to retrieve secret {0}{1} - Make sure you've added it to the secrets provider",
+                data.Provider, data.Key);
+            return String.Empty;
+        }
+
+
+        /// <summary>
+        /// The factory method for Core "things". Also iterates the Factory methods that have
+        /// been loaded from plugins
+        /// </summary>
+        /// <param name="dc"></param>
+        /// <returns></returns>
+        public static IKeyed GetDevice(DeviceConfig dc)
+        {
+            try
+            {
+                Debug.Console(0, Debug.ErrorLogLevel.Notice, "Loading '{0}' from Essentials Core", dc.Type);
+
+                var localDc = new DeviceConfig(dc);
+
+                var key = localDc.Key;
+                var name = localDc.Name;
+                var type = localDc.Type;
+                var properties = localDc.Properties;
+                //var propRecurse = properties;
+
+                var typeName = localDc.Type.ToLower();
+
+
+                var jObject = properties as JObject;
+                if (jObject != null)
+                {
+                    var jProp = jObject.Properties();
+
+                    CheckForSecrets(jProp);
+                }
+
+                Debug.Console(2, "typeName = {0}", typeName);
+                // Check for types that have been added by plugin dlls. 
+                return !FactoryMethods.ContainsKey(typeName) ? null : FactoryMethods[typeName].FactoryMethod(localDc);
+            }
+            catch (Exception ex)
+            {
+                Debug.Console(0, Debug.ErrorLogLevel.Error, "Exception occurred while creating device {0}: {1}", dc.Key, ex.Message);
+
+                Debug.Console(2, "{0}", ex.StackTrace);
+                return null;
+            }
+        }
+
         /// <summary>
         /// Prints the type names and associated metadata from the FactoryMethods collection.
         /// </summary>

essentials-framework/Essentials Core/PepperDashEssentialsBase/PepperDash_Essentials_Core.csproj

@@ -209,6 +209,7 @@
     <Compile Include="DeviceTypeInterfaces\IHasFarEndContentStatus.cs" />
     <Compile Include="DeviceTypeInterfaces\IHasPhoneDialing.cs" />
     <Compile Include="DeviceTypeInterfaces\IMobileControl.cs" />
+    <Compile Include="Extensions\JsonExtensions.cs" />
     <Compile Include="Factory\DeviceFactory.cs" />
     <Compile Include="Factory\IDeviceFactory.cs" />
     <Compile Include="Factory\ReadyEventArgs.cs" />
@@ -320,6 +321,10 @@
     <Compile Include="Feedbacks\BoolFeedbackPulseExtender.cs" />
     <Compile Include="Routing\RoutingPortNames.cs" />
     <Compile Include="Routing\TieLineConfig.cs" />
+    <Compile Include="Secrets\CrestronSecretsProvider.cs" />
+    <Compile Include="Secrets\Interfaces.cs" />
+    <Compile Include="Secrets\SecretsManager.cs" />
+    <Compile Include="Secrets\SecretsPropertiesConfig.cs" />
     <Compile Include="Shades\Shade Interfaces.cs" />
     <Compile Include="Shades\ShadeBase.cs" />
     <Compile Include="Shades\ShadeController.cs" />

essentials-framework/Essentials Core/PepperDashEssentialsBase/Routing/IRoutingInputsExtensions.cs

@@ -123,25 +123,34 @@ namespace PepperDash.Essentials.Core
 				// No direct tie? Run back out on the inputs' attached devices... 
 				// Only the ones that are routing devices
 				var attachedMidpoints = destDevInputTies.Where(t => t.SourcePort.ParentDevice is IRoutingInputsOutputs);
+
+                //Create a list for tracking already checked devices to avoid loops, if it doesn't already exist from previous iteration
+                if (alreadyCheckedDevices == null)
+                    alreadyCheckedDevices = new List<IRoutingInputsOutputs>();
+                alreadyCheckedDevices.Add(destination as IRoutingInputsOutputs);
+
 				foreach (var inputTieToTry in attachedMidpoints)
 				{
-					Debug.Console(2, destination, "Trying to find route on {0}", inputTieToTry.SourcePort.ParentDevice.Key);
 					var upstreamDeviceOutputPort = inputTieToTry.SourcePort;
 					var upstreamRoutingDevice = upstreamDeviceOutputPort.ParentDevice as IRoutingInputsOutputs;
+                    Debug.Console(2, destination, "Trying to find route on {0}", upstreamRoutingDevice.Key);
+
 					// Check if this previous device has already been walked
-					if (!(alreadyCheckedDevices != null && alreadyCheckedDevices.Contains(upstreamRoutingDevice)))
-					{
-						// haven't seen this device yet.  Do it.  Pass the output port to the next
-						// level to enable switching on success
-						var upstreamRoutingSuccess = upstreamRoutingDevice.GetRouteToSource(source, upstreamDeviceOutputPort, 
-							alreadyCheckedDevices, signalType, cycle, routeTable);
-						if (upstreamRoutingSuccess)
-						{
-							Debug.Console(2, destination, "Upstream device route found");
-							goodInputPort = inputTieToTry.DestinationPort;
-							break; // Stop looping the inputs in this cycle
-						}
-					}
+                    if (alreadyCheckedDevices.Contains(upstreamRoutingDevice))
+                    {
+                        Debug.Console(2, destination, "Skipping input {0} on {1}, this was already checked", upstreamRoutingDevice.Key, destination.Key);
+                        continue;
+                    }
+                    // haven't seen this device yet.  Do it.  Pass the output port to the next
+                    // level to enable switching on success
+                    var upstreamRoutingSuccess = upstreamRoutingDevice.GetRouteToSource(source, upstreamDeviceOutputPort,
+                        alreadyCheckedDevices, signalType, cycle, routeTable);
+                    if (upstreamRoutingSuccess)
+                    {
+                        Debug.Console(2, destination, "Upstream device route found");
+                        goodInputPort = inputTieToTry.DestinationPort;
+                        break; // Stop looping the inputs in this cycle
+                    }
 				}
 			}
 
@@ -163,10 +172,6 @@ namespace PepperDash.Essentials.Core
                 //Debug.Console(2, destination, "Exiting cycle {0}", cycle);
 				return true;
 			}
-	
-			if(alreadyCheckedDevices == null)
-				alreadyCheckedDevices = new List<IRoutingInputsOutputs>();
-			alreadyCheckedDevices.Add(destination as IRoutingInputsOutputs);
 
 			Debug.Console(2, destination, "No route found to {0}", source.Key);
 			return false;

essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/CrestronSecretsProvider.cs

@@ -0,0 +1,97 @@
+using System;
+using Crestron.SimplSharp;
+using Crestron.SimplSharp.CrestronDataStore;
+using PepperDash.Core;
+
+
+namespace PepperDash.Essentials.Core
+{
+    public class CrestronSecretsProvider : ISecretProvider
+    {
+        public string Key { get; set; }
+        //Added for reference
+        private static readonly bool SecureSupported;
+        public CrestronSecretsProvider(string key)
+        {
+            Key = key;
+        }
+
+        static CrestronSecretsProvider()
+        {
+            //Added for future encrypted reference
+            SecureSupported = CrestronSecureStorage.Supported;
+
+            CrestronDataStoreStatic.InitCrestronDataStore();
+            if (SecureSupported)
+            {
+                //doThingsFuture
+            }
+        }
+
+        /// <summary>
+        /// Set secret for item in the CrestronSecretsProvider
+        /// </summary>
+        /// <param name="key">Secret Key</param>
+        /// <param name="value">Secret Value</param>
+        public bool SetSecret(string key, object value)
+        {
+            var secret = value as string;
+            if (String.IsNullOrEmpty(secret))
+            {
+                Debug.Console(2, this, "Unable to set secret for {0}:{1} - value is empty.", Key, key);
+                return false;
+            }
+            var setErrorCode = CrestronDataStoreStatic.SetLocalStringValue(key, secret);
+            switch (setErrorCode)
+            {
+                case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
+                    Debug.Console(1, this,"Secret Successfully Set for {0}:{1}", Key, key);
+                    return true;
+                default:
+                    Debug.Console(2, this, Debug.ErrorLogLevel.Notice, "Unable to set secret for {0}:{1} - {2}", Key, key, setErrorCode.ToString());
+                    return false;
+            }
+        }
+
+        /// <summary>
+        /// Retrieve secret for item in the CrestronSecretsProvider
+        /// </summary>
+        /// <param name="key">Secret Key</param>
+        /// <returns>ISecret Object containing key, provider, and value</returns>
+        public ISecret GetSecret(string key)
+        {
+            string mySecret;
+            var getErrorCode = CrestronDataStoreStatic.GetLocalStringValue(key, out mySecret);
+
+            switch (getErrorCode)
+            {
+                case CrestronDataStore.CDS_ERROR.CDS_SUCCESS:
+                    Debug.Console(2, this, "Secret Successfully retrieved for {0}:{1}", Key, key);
+                    return new CrestronSecret(key, mySecret, this);
+                default:
+                    Debug.Console(0, this, Debug.ErrorLogLevel.Notice, "Unable to retrieve secret for {0}:{1} - {2}",
+                        Key, key, getErrorCode.ToString());
+                    return null;
+            }
+        }
+    }
+
+    /// <summary>
+    /// Special container class for CrestronSecret provider
+    /// </summary>
+    public class CrestronSecret : ISecret
+    {
+        public ISecretProvider Provider { get; private set; }
+        public string Key { get; private set; }
+
+        public object Value { get; private set; }
+
+        public CrestronSecret(string key, string value, ISecretProvider provider)
+        {
+            Key = key;
+            Value = value;
+            Provider = provider;
+        }
+
+    }
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/Interfaces.cs

@@ -0,0 +1,24 @@
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// All ISecrecretProvider classes must implement this interface.
+    /// </summary>
+    public interface ISecretProvider : IKeyed
+    {
+        bool SetSecret(string key, object value);
+
+        ISecret GetSecret(string key);
+    }
+
+    /// <summary>
+    /// interface for delivering secrets in Essentials.
+    /// </summary>
+    public interface ISecret
+    {
+        ISecretProvider Provider { get; }
+        string Key { get; }
+        object Value { get; }
+    }
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/SecretsManager.cs

@@ -0,0 +1,281 @@
+using System;
+using System.Collections.Generic;
+using Crestron.SimplSharp;
+using PepperDash.Core;
+
+
+namespace PepperDash.Essentials.Core
+{
+    public static class SecretsManager
+    {
+        public static Dictionary<string, ISecretProvider> Secrets { get; private set; }
+
+        /// <summary>
+        /// Initialize the SecretsManager
+        /// </summary>
+        public static void Initialize()
+        {
+
+            AddSecretProvider("default", new CrestronSecretsProvider("default"));
+
+            CrestronConsole.AddNewConsoleCommand(SetSecretProcess, "setsecret",
+                "Adds secrets to secret provider",
+                ConsoleAccessLevelEnum.AccessOperator);
+
+            CrestronConsole.AddNewConsoleCommand(UpdateSecretProcess, "updatesecret",
+                "Updates secrets in secret provider",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+
+            CrestronConsole.AddNewConsoleCommand(DeleteSecretProcess, "deletesecret",
+                "Deletes secrets in secret provider",
+                ConsoleAccessLevelEnum.AccessAdministrator);
+        }
+
+        static SecretsManager()
+        {
+            Secrets = new Dictionary<string, ISecretProvider>();
+        }
+
+        /// <summary>
+        /// Get Secret Provider from dictionary by key
+        /// </summary>
+        /// <param name="key">Dictionary Key for provider</param>
+        /// <returns>ISecretProvider</returns>
+        public static ISecretProvider GetSecretProviderByKey(string key)
+        {
+            ISecretProvider secret;
+
+            Secrets.TryGetValue(key, out secret);
+
+            if (secret == null)
+            {
+                Debug.Console(1, "SecretsManager unable to retrieve SecretProvider with the key '{0}'", key);
+            }
+            return secret;
+        }
+
+        /// <summary>
+        /// Add secret provider to secrets dictionary
+        /// </summary>
+        /// <param name="key">Key of new entry</param>
+        /// <param name="provider">New Provider Entry</param>
+        public static void AddSecretProvider(string key, ISecretProvider provider)
+        {
+            if (!Secrets.ContainsKey(key))
+            {
+                Secrets.Add(key, provider);
+                Debug.Console(1, "Secrets provider '{0}' added to SecretsManager", key);
+            }
+            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Unable to add Provider '{0}' to Secrets.  Provider with that key already exists", key );
+        }
+
+        /// <summary>
+        /// Add secret provider to secrets dictionary, with optional overwrite parameter
+        /// </summary>
+        /// <param name="key">Key of new entry</param>
+        /// <param name="provider">New provider entry</param>
+        /// <param name="overwrite">true to overwrite any existing providers in the dictionary</param>
+        public static void AddSecretProvider(string key, ISecretProvider provider, bool overwrite)
+        {
+            if (!Secrets.ContainsKey(key))
+            {
+                Secrets.Add(key, provider);
+                Debug.Console(1, "Secrets provider '{0}' added to SecretsManager", key);
+
+            }
+            if (overwrite)
+            {
+                Secrets.Add(key, provider);
+                Debug.Console(1, Debug.ErrorLogLevel.Notice, "Provider with the key '{0}' already exists in secrets.  Overwriting with new secrets provider.", key);
+
+            }
+            Debug.Console(0, Debug.ErrorLogLevel.Notice, "Unable to add Provider '{0}' to Secrets.  Provider with that key already exists", key);
+        }
+
+        private static void SetSecretProcess(string cmd)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (args.Length == 0)
+            {
+                //some Instructional Text
+                response = "Adds secrets to secret provider. Format 'setsecret <provider> <secretKey> <secret>";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Adds secrets to secret provider. Format 'setsecret <provider> <secretKey> <secret>";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            if (args.Length < 3)
+            {
+                response =  "Improper number of arguments";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var provider = GetSecretProviderByKey(args[0]);
+
+            if (provider == null)
+            {
+                //someFail
+                response =  "Provider key invalid";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var key = args[1];
+            var secret = args[2];
+
+            if (provider.GetSecret(key) == null)
+            {
+
+                response = provider.SetSecret(key, secret)
+                    ? String.Format(
+                        "Secret successfully set for {0}:{1}",
+                        provider.Key, key)
+                    : String.Format(
+                        "Unable to set secret for {0}:{1}",
+                        provider.Key, key);                    
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+            response =
+                String.Format(
+                    "Unable to set secret for {0}:{1} - Please use the 'UpdateSecret' command to modify it");
+            CrestronConsole.ConsoleCommandResponse(response);
+        }
+
+        private static void UpdateSecretProcess(string cmd)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (args.Length == 0)
+            {
+                //some Instructional Text
+                response = "Updates secrets in secret provider. Format 'updatesecret <provider> <secretKey> <secret>";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Updates secrets in secret provider. Format 'updatesecret <provider> <secretKey> <secret>";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+
+            if (args.Length < 3)
+            {
+                //someFail
+                response = "Improper number of arguments";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var provider = GetSecretProviderByKey(args[0]);
+
+            if (provider == null)
+            {
+                //someFail
+                response = "Provider key invalid";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var key = args[1];
+            var secret = args[2];
+
+            if (provider.GetSecret(key) != null)
+            {
+                response = provider.SetSecret(key, secret)
+                    ? String.Format(
+                        "Secret successfully set for {0}:{1}",
+                        provider.Key, key)
+                    : String.Format(
+                        "Unable to set secret for {0}:{1}",
+                        provider.Key, key);
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+            response =
+                String.Format(
+                    "Unable to update secret for {0}:{1} - Please use the 'SetSecret' command to create a new secret");
+            CrestronConsole.ConsoleCommandResponse(response);
+        }
+
+        private static void DeleteSecretProcess(string cmd)
+        {
+            string response;
+            var args = cmd.Split(' ');
+
+            if (args.Length == 0)
+            {
+                //some Instructional Text
+                response = "Deletes secrets in secret provider. Format 'deletesecret <provider> <secretKey>";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+            if (args.Length == 1 && args[0] == "?")
+            {
+                response = "Deletes secrets in secret provider. Format 'deletesecret <provider> <secretKey>";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+            }
+
+
+
+            if (args.Length < 2)
+            {
+                //someFail
+                response =  "Improper number of arguments";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var provider = GetSecretProviderByKey(args[0]);
+
+            if (provider == null)
+            {
+                //someFail
+                response =  "Provider key invalid";
+                CrestronConsole.ConsoleCommandResponse(response);
+                return;
+
+            }
+
+            var key = args[1];
+
+
+            provider.SetSecret(key, "");
+            response = provider.SetSecret(key, "")
+                ? String.Format(
+                    "Secret successfully deleted for {0}:{1}",
+                    provider.Key, key)
+                : String.Format(
+                    "Unable to delete secret for {0}:{1}",
+                    provider.Key, key);
+            CrestronConsole.ConsoleCommandResponse(response);
+            return;
+
+
+        }
+    }
+
+
+}

essentials-framework/Essentials Core/PepperDashEssentialsBase/Secrets/SecretsPropertiesConfig.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+using Newtonsoft.Json;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Provide a way to easily deserialize into a secret object from config
+    /// </summary>
+    public class SecretsPropertiesConfig
+    {
+        [JsonProperty("provider")]
+        public string Provider { get; set; }
+        [JsonProperty("key")]
+        public string Key { get; set; }
+    }
+}

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/Essentials Devices Common.csproj

@@ -176,6 +176,7 @@
     <Compile Include="VideoCodec\ZoomRoom\ResponseObjects.cs" />
     <Compile Include="VideoCodec\ZoomRoom\ZoomRoom.cs" />
     <Compile Include="VideoCodec\ZoomRoom\ZoomRoomCamera.cs" />
+    <Compile Include="VideoCodec\ZoomRoom\ZoomRoomJoinMap.cs" />
     <Compile Include="VideoCodec\ZoomRoom\ZoomRoomPropertiesConfig.cs" />
     <None Include="Properties\ControlSystem.cfg" />
   </ItemGroup>

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

@@ -19,4 +19,32 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 		void LocalLayoutToggleSingleProminent();
 		void MinMaxLayoutToggle();
     }
+
+    /// <summary>
+    /// Defines the requirements for Zoom Room layout control
+    /// </summary>
+    public interface IHasZoomRoomLayouts : IHasCodecLayouts
+    {
+        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 CanSwapContentWithThumbnailFeedback { get; }
+        BoolFeedback ContentSwappedWithThumbnailFeedback { get; }
+
+        ZoomRoom.zConfiguration.eLayoutStyle LastSelectedLayout { get; }
+        ZoomRoom.zConfiguration.eLayoutStyle AvailableLayouts { get; }
+
+        void GetAvailableLayouts(); // Mot sure this is necessary if we're already subscribed to zStatus Call Layout
+        void SetLayout(ZoomRoom.zConfiguration.eLayoutStyle layoutStyle);
+        void SwapContentWithThumbnail();
+
+        void LayoutTurnNextPage();
+        void LayoutTurnPreviousPage();
+    }
+
+    public class LayoutInfoChangedEventArgs : EventArgs
+    {
+        public ZoomRoom.zConfiguration.eLayoutStyle AvailableLayouts { get; set; }
+    }
 }

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

@@ -1,13 +1,20 @@
 using System;
 using System.Collections.Generic;
+using PepperDash.Essentials.Core;
 
 namespace PepperDash.Essentials.Devices.Common.VideoCodec.Interfaces
 {
+    /// <summary>
+    /// Describes a device that has call participants
+    /// </summary>
     public interface IHasParticipants
     {
         CodecParticipants Participants { get; }
     }
 
+    /// <summary>
+    /// Describes the ability to mute and unmute a participant's video in a meeting
+    /// </summary>
     public interface IHasParticipantVideoMute:IHasParticipants
     {
         void MuteVideoForParticipant(int userId);
@@ -15,13 +22,29 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.Interfaces
         void ToggleVideoForParticipant(int userId);
     }
 
-    public interface IHasParticipantAudioMute:IHasParticipantVideoMute
+    /// <summary>
+    /// Describes the ability to mute and unmute a participant's audio in a meeting
+    /// </summary>
+    public interface IHasParticipantAudioMute : IHasParticipantVideoMute
     {
         void MuteAudioForParticipant(int userId);
         void UnmuteAudioForParticipant(int userId);
         void ToggleAudioForParticipant(int userId);
     }
 
+    /// <summary>
+    /// Describes the ability to pin and unpin a participant in a meeting
+    /// </summary>
+    public interface IHasParticipantPinUnpin : IHasParticipants
+    {
+        IntFeedback NumberOfScreensFeedback { get; }
+        int ScreenIndexToPinUserTo { get; }
+
+        void PinParticipant(int userId, int screenIndex);
+        void UnPinParticipant(int userId);
+        void ToggleParticipantPinState(int userId, int screenIndex);
+    }
+
     public class CodecParticipants
     {
         private List<Participant> _currentParticipants;
@@ -31,11 +54,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.Interfaces
             set
             {
                 _currentParticipants = value;
-                var handler = ParticipantsListHasChanged;
-
-                if(handler == null) return;
-
-                handler(this, new EventArgs());
+                OnParticipantsChanged();
             }
         }
 
@@ -45,15 +64,31 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.Interfaces
         {
             _currentParticipants = new List<Participant>();
         }
+
+        public void OnParticipantsChanged()
+        {
+            var handler = ParticipantsListHasChanged;
+
+            if (handler == null) return;
+
+            handler(this, new EventArgs());
+        }
     }
 
+    /// <summary>
+    /// Represents a call participant
+    /// </summary>
     public class Participant
     {
+        public int UserId { get; set; }
         public bool IsHost { get; set; }
         public string Name { get; set; }
         public bool CanMuteVideo { get; set; }       
         public bool CanUnmuteVideo { get; set; }
         public bool VideoMuteFb { get; set; }
         public bool AudioMuteFb { get; set; }
+        public bool HandIsRaisedFb { get; set; }
+        public bool IsPinnedFb { get; set; }
+        public int ScreenIndexIsPinnedToFb { get; set; }
     }
 }

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

@@ -28,6 +28,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 		IUsageTracking, IHasDialer, IHasContentSharing, ICodecAudio, iVideoCodecInfo, IBridgeAdvanced
 	{
 		private const int XSigEncoding = 28591;
+        protected const int MaxParticipants = 50;
 		private readonly byte[] _clearBytes = XSigHelpers.ClearOutputs();
 		protected VideoCodecBase(DeviceConfig config)
 			: base(config)
@@ -271,6 +272,14 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 
 		public abstract void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge);
 
+		/// <summary>
+		/// Use this method when using a plain VideoCodecControllerJoinMap
+		/// </summary>
+		/// <param name="codec"></param>
+		/// <param name="trilist"></param>
+		/// <param name="joinStart"></param>
+		/// <param name="joinMapKey"></param>
+		/// <param name="bridge"></param>
 		protected void LinkVideoCodecToApi(VideoCodecBase codec, BasicTriList trilist, uint joinStart, string joinMapKey,
 			EiscApiAdvanced bridge)
 		{
@@ -288,10 +297,19 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 				bridge.AddJoinMap(Key, joinMap);
 			}
 
+			LinkVideoCodecToApi(codec, trilist, joinMap);
+		}
+
+		/// <summary>
+		/// Use this method when you need to pass in a join map that extends VideoCodecControllerJoinMap
+		/// </summary>
+		/// <param name="codec"></param>
+		/// <param name="trilist"></param>
+		/// <param name="joinMap"></param>
+		protected void LinkVideoCodecToApi(VideoCodecBase codec, BasicTriList trilist, VideoCodecControllerJoinMap joinMap)
+		{
 			Debug.Console(1, this, "Linking to Trilist {0}", trilist.ID.ToString("X"));
 
-
-
 			LinkVideoCodecDtmfToApi(trilist, joinMap);
 
 			LinkVideoCodecCallControlsToApi(trilist, joinMap);
@@ -524,6 +542,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 					return;
 				}
 
+                SetParticipantActions(trilist, joinMap, codec.Participants.CurrentParticipants);
+
 				participantsXSig = UpdateParticipantsXSig(codec.Participants.CurrentParticipants);
 
 				trilist.SetString(joinMap.CurrentParticipants.JoinNumber, participantsXSig);
@@ -532,14 +552,59 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 			};
 		}
 
+        /// <summary>
+        /// Sets the actions for each participant in the list
+        /// </summary>
+        private void SetParticipantActions(BasicTriList trilist, VideoCodecControllerJoinMap joinMap, List<Participant> currentParticipants)
+        {
+            uint index = 0; // track the index of the participant in the 
+
+            foreach (var participant in currentParticipants)
+            {
+                var p = participant;
+                if (index > MaxParticipants) break;
+
+                var audioMuteCodec = this as IHasParticipantAudioMute;
+                if (audioMuteCodec != null)
+                {
+                    trilist.SetSigFalseAction(joinMap.ParticipantAudioMuteToggleStart.JoinNumber + index,
+                        () => audioMuteCodec.ToggleAudioForParticipant(p.UserId));
+
+                    trilist.SetSigFalseAction(joinMap.ParticipantVideoMuteToggleStart.JoinNumber + index,
+                        () => audioMuteCodec.ToggleVideoForParticipant(p.UserId));
+                }
+
+                var pinCodec = this as IHasParticipantPinUnpin;
+                if (pinCodec != null)
+                {
+                    trilist.SetSigFalseAction(joinMap.ParticipantPinToggleStart.JoinNumber + index,
+                        () => pinCodec.ToggleParticipantPinState(p.UserId, pinCodec.ScreenIndexToPinUserTo));
+                }
+
+                index++;
+            }
+
+            // Clear out any previously set actions
+            while (index < MaxParticipants)
+            {
+                trilist.ClearBoolSigAction(joinMap.ParticipantAudioMuteToggleStart.JoinNumber + index);
+                trilist.ClearBoolSigAction(joinMap.ParticipantVideoMuteToggleStart.JoinNumber + index);
+                trilist.ClearBoolSigAction(joinMap.ParticipantPinToggleStart.JoinNumber + index);
+
+                index++;
+            }
+        }
+
 		private string UpdateParticipantsXSig(List<Participant> currentParticipants)
 		{
-			const int maxParticipants = 50;
-			const int maxDigitals = 5;
+			const int maxParticipants = MaxParticipants;
+			const int maxDigitals = 7;
 			const int maxStrings = 1;
-			const int offset = maxDigitals + maxStrings;
-			var digitalIndex = maxStrings * maxParticipants; //15
+			const int maxAnalogs = 1;
+			const int offset = maxDigitals + maxStrings + maxAnalogs; // 9
+			var digitalIndex = (maxStrings + maxAnalogs) * maxParticipants; // 100
 			var stringIndex = 0;
+			var analogIndex = stringIndex + maxParticipants;
 			var meetingIndex = 0;
 
 			var tokenArray = new XSigToken[maxParticipants * offset];
@@ -554,29 +619,42 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 				tokenArray[digitalIndex + 2] = new XSigDigitalToken(digitalIndex + 3, participant.CanMuteVideo);
 				tokenArray[digitalIndex + 3] = new XSigDigitalToken(digitalIndex + 4, participant.CanUnmuteVideo);
 				tokenArray[digitalIndex + 4] = new XSigDigitalToken(digitalIndex + 5, participant.IsHost);
+                tokenArray[digitalIndex + 5] = new XSigDigitalToken(digitalIndex + 6, participant.HandIsRaisedFb);
+                tokenArray[digitalIndex + 6] = new XSigDigitalToken(digitalIndex + 7, participant.IsPinnedFb);
 
 				//serials
 				tokenArray[stringIndex] = new XSigSerialToken(stringIndex + 1, participant.Name);
 
+				//analogs
+				tokenArray[analogIndex] = new XSigAnalogToken(analogIndex + 1, (ushort)participant.ScreenIndexIsPinnedToFb);
+
 				digitalIndex += maxDigitals;
 				meetingIndex += offset;
 				stringIndex += maxStrings;
+				analogIndex += maxAnalogs;
 			}
 
 			while (meetingIndex < maxParticipants * offset)
 			{
+				//digitals
 				tokenArray[digitalIndex] = new XSigDigitalToken(digitalIndex + 1, false);
 				tokenArray[digitalIndex + 1] = new XSigDigitalToken(digitalIndex + 2, false);
 				tokenArray[digitalIndex + 2] = new XSigDigitalToken(digitalIndex + 3, false);
 				tokenArray[digitalIndex + 3] = new XSigDigitalToken(digitalIndex + 4, false);
 				tokenArray[digitalIndex + 4] = new XSigDigitalToken(digitalIndex + 5, false);
+				tokenArray[digitalIndex + 5] = new XSigDigitalToken(digitalIndex + 6, false);
+				tokenArray[digitalIndex + 6] = new XSigDigitalToken(digitalIndex + 7, false);
 
 				//serials
 				tokenArray[stringIndex] = new XSigSerialToken(stringIndex + 1, String.Empty);
 
+				//analogs
+				tokenArray[analogIndex] = new XSigAnalogToken(analogIndex + 1, 0);
+
 				digitalIndex += maxDigitals;
 				meetingIndex += offset;
 				stringIndex += maxStrings;
+				analogIndex += maxAnalogs;
 			}
 
 			return GetXSigString(tokenArray);
@@ -595,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)
@@ -607,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;
@@ -617,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;
@@ -627,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;
@@ -652,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);
@@ -847,7 +917,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
 
 				Debug.Console(1, this, "Call Direction: {0}", args.CallItem.Direction);
 				Debug.Console(1, this, "Call is incoming: {0}", args.CallItem.Direction == eCodecCallDirection.Incoming);
-				trilist.SetBool(joinMap.IncomingCall.JoinNumber, args.CallItem.Direction == eCodecCallDirection.Incoming && args.CallItem.Status == eCodecCallStatus.Ringing);				
+				trilist.SetBool(joinMap.IncomingCall.JoinNumber, args.CallItem.Direction == eCodecCallDirection.Incoming && args.CallItem.Status == eCodecCallStatus.Ringing);
 
 				if (args.CallItem.Direction == eCodecCallDirection.Incoming)
 				{

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

@@ -0,0 +1,273 @@
+using System;
+using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Bridges.JoinMaps;
+
+namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
+{
+	public class ZoomRoomJoinMap : VideoCodecControllerJoinMap
+	{
+		// TODO: #697 [X] Set join numbers
+
+		#region Digital
+
+		[JoinName("CanSwapContentWithThumbnail")]
+		public JoinDataComplete CanSwapContentWithThumbnail = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 206,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "FB Indicates if content can be swapped with thumbnail",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("SwapContentWithThumbnail")]
+		public JoinDataComplete SwapContentWithThumbnail = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 206,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Pulse to swap content with thumbnail.  FB reports current state",
+				JoinCapabilities = eJoinCapabilities.ToFromSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("GetAvailableLayouts")]
+		public JoinDataComplete GetAvailableLayouts = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 215,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Gets the available layouts.  Will update the LayoutXXXXXIsAvailbale signals.",
+				JoinCapabilities = eJoinCapabilities.FromSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("LayoutIsOnFirstPage")]
+		public JoinDataComplete LayoutIsOnFirstPage = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 216,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Indicates if layout is on first page",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("LayoutIsOnLastPage")]
+		public JoinDataComplete LayoutIsOnLastPage = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 217,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Indicates if layout is on first page",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("LayoutTurnToNextPage")]
+		public JoinDataComplete LayoutTurnToNextPage = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 216,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Turns layout view to next page",
+				JoinCapabilities = eJoinCapabilities.FromSIMPL,
+				JoinType = eJoinType.Digital
+			});
+
+		[JoinName("LayoutTurnToPreviousPage")]
+		public JoinDataComplete LayoutTurnToPreviousPage = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 217,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Turns layout view to previous page",
+				JoinCapabilities = eJoinCapabilities.FromSIMPL,
+				JoinType = eJoinType.Digital
+			});	
+
+		[JoinName("LayoutGalleryIsAvailable")]
+		public JoinDataComplete LayoutGalleryIsAvailable = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 221,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "FB Indicates if layout 'Gallery' is available",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.DigitalSerial
+			});
+
+		[JoinName("LayoutSpeakerIsAvailable")]
+		public JoinDataComplete LayoutSpeakerIsAvailable = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 222,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "FB Indicates if layout 'Speaker' is available",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.DigitalSerial
+			});
+
+		[JoinName("LayoutStripIsAvailable")]
+		public JoinDataComplete LayoutStripIsAvailable = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 223,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "FB Indicates if layout 'Strip' is available",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.DigitalSerial
+			});
+
+		[JoinName("LayoutShareAllIsAvailable")]
+		public JoinDataComplete LayoutShareAllIsAvailable = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 224,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "FB Indicates if layout 'ShareAll' is available",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.DigitalSerial
+			});
+
+        //[JoinName("ParticipantAudioMuteToggleStart")]
+        //public JoinDataComplete ParticipantAudioMuteToggleStart = new JoinDataComplete(
+        //    new JoinData
+        //    {
+        //        JoinNumber = 500,
+        //        JoinSpan = 100
+        //    },
+        //    new JoinMetadata
+        //    {
+        //        Description = "Toggles the participant's audio mute status",
+        //        JoinCapabilities = eJoinCapabilities.ToSIMPL,
+        //        JoinType = eJoinType.Digital
+        //    });
+
+        //[JoinName("ParticipantVideoMuteToggleStart")]
+        //public JoinDataComplete ParticipantVideoMuteToggleStart = new JoinDataComplete(
+        //    new JoinData
+        //    {
+        //        JoinNumber = 800,
+        //        JoinSpan = 100
+        //    },
+        //    new JoinMetadata
+        //    {
+        //        Description = "Toggles the participant's video mute status",
+        //        JoinCapabilities = eJoinCapabilities.ToSIMPL,
+        //        JoinType = eJoinType.Digital
+        //    });
+
+        //[JoinName("ParticipantPinToggleStart")]
+        //public JoinDataComplete ParticipantPinToggleStart = new JoinDataComplete(
+        //    new JoinData
+        //    {
+        //        JoinNumber = 1100,
+        //        JoinSpan = 100
+        //    },
+        //    new JoinMetadata
+        //    {
+        //        Description = "Toggles the participant's pin status",
+        //        JoinCapabilities = eJoinCapabilities.ToSIMPL,
+        //        JoinType = eJoinType.Digital
+        //    });
+
+		#endregion
+
+
+		#region Analog
+
+		[JoinName("NumberOfScreens")]
+		public JoinDataComplete NumberOfScreens = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 11,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Reports the number of screens connected",
+				JoinCapabilities = eJoinCapabilities.ToSIMPL,
+				JoinType = eJoinType.Analog
+			});
+
+		[JoinName("ScreenIndexToPinUserTo")]
+		public JoinDataComplete ScreenIndexToPinUserTo = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 11,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Specifies the screen index a participant should be pinned to",
+				JoinCapabilities = eJoinCapabilities.FromSIMPL,
+				JoinType = eJoinType.Analog
+			});
+
+		#endregion
+
+
+		#region Serials
+
+		[JoinName("GetSetCurrentLayout")]
+		public JoinDataComplete GetSetCurrentLayout = new JoinDataComplete(
+			new JoinData
+			{
+				JoinNumber = 215,
+				JoinSpan = 1
+			},
+			new JoinMetadata
+			{
+				Description = "Sets and reports the current layout.  Use the LayoutXXXXIsAvailable signals to determine valid layouts",
+				JoinCapabilities = eJoinCapabilities.ToFromSIMPL,
+				JoinType = eJoinType.Serial
+			});		
+
+		#endregion
+
+		public ZoomRoomJoinMap(uint joinStart)
+			: base(joinStart, typeof(ZoomRoomJoinMap))
+		{
+		}
+
+		public ZoomRoomJoinMap(uint joinStart, Type type)
+			: base(joinStart, type)
+		{
+		}
+	}
+}