Merge pull request #713 from PepperDash/release/1.9.0

1.9.0

.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/Room/Types/EssentialsTechRoom.cs

@@ -107,14 +107,18 @@ namespace PepperDash.Essentials
 
         private void TunerPresetsOnPresetRecalled(ISetTopBoxNumericKeypad device, string channel)
         {
+            //Debug.Console(2, this, "TunerPresetsOnPresetRecalled");
+
             if (!_currentPresets.ContainsKey(device.Key))
             {
                 return;
             }
 
+            //Debug.Console(2, this, "Tuner Key: {0} Channel: {1}", device.Key, channel);
+
             _currentPresets[device.Key] = channel;
 
-            if (!CurrentPresetsFeedbacks.ContainsKey(device.Key))
+            if (CurrentPresetsFeedbacks.ContainsKey(device.Key))
             {
                 CurrentPresetsFeedbacks[device.Key].FireUpdate();
             }

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/DeviceJsonApi.cs

@@ -20,8 +20,23 @@ namespace PepperDash.Essentials.Core
 		/// <param name="json"></param>
 		public static void DoDeviceActionWithJson(string json)
 		{
-			var action = JsonConvert.DeserializeObject<DeviceActionWrapper>(json);
-			DoDeviceAction(action);
+		    if (String.IsNullOrEmpty(json))
+		    {
+		        CrestronConsole.ConsoleCommandResponse(
+		            "Please provide a JSON object matching the format {\"deviceKey\":\"myDevice\", \"methodName\":\"someMethod\", \"params\": [\"param1\", true]}.\r\nIf the method has no parameters, the \"params\" object may be omitted.");
+		        return;
+		    }
+		    try
+		    {
+		        var action = JsonConvert.DeserializeObject<DeviceActionWrapper>(json);
+
+		        DoDeviceAction(action);
+		    }
+		    catch (Exception ex)
+		    {
+		        CrestronConsole.ConsoleCommandResponse("Incorrect format for JSON. Please check that the format matches {\"deviceKey\":\"myDevice\", \"methodName\":\"someMethod\", \"params\": [\"param1\", true]}");
+		    }
+		    
 		}
 
 
@@ -33,29 +48,47 @@ namespace PepperDash.Essentials.Core
 		{
 			var key = action.DeviceKey;
 			var obj = FindObjectOnPath(key);
-			if (obj == null)
-				return;
+		    if (obj == null)
+		    {
+		        CrestronConsole.ConsoleCommandResponse("Unable to find object at path {0}", key);
+		        return;
+		    }
 
-			CType t = obj.GetType();
-			var method = t.GetMethod(action.MethodName);
-			if (method == null)
-			{
-				Debug.Console(0, "Method '{0}' not found", action.MethodName);
-				return;
-			}
-			var mParams = method.GetParameters();
-			// Add empty params if not provided
-			if (action.Params == null) action.Params = new object[0];
-			if (mParams.Length > action.Params.Length)
-			{
-				Debug.Console(0, "Method '{0}' requires {1} params", action.MethodName, mParams.Length);
-				return;
-			}
-			object[] convertedParams = mParams
-								.Select((p, i) => Convert.ChangeType(action.Params[i], p.ParameterType,
-									System.Globalization.CultureInfo.InvariantCulture))
-								.ToArray();
-			object ret = method.Invoke(obj, convertedParams);
+		    if (action.Params == null)
+		    {
+                //no params, so setting action.Params to empty array
+		        action.Params = new object[0];
+		    }
+
+		    CType t = obj.GetType();
+		    try
+		    {
+		        var methods = t.GetMethods().Where(m => m.Name == action.MethodName).ToList();
+
+		        var method = methods.Count == 1 ? methods[0] : methods.FirstOrDefault(m => m.GetParameters().Length == action.Params.Length);
+
+		        if (method == null)
+		        {
+		            CrestronConsole.ConsoleCommandResponse(
+		                "Unable to find method with name {0} and that matches parameters {1}", action.MethodName,
+		                action.Params);
+		            return;
+		        }
+                var mParams = method.GetParameters();
+
+                var convertedParams = mParams
+                                    .Select((p, i) => Convert.ChangeType(action.Params[i], p.ParameterType,
+                                        System.Globalization.CultureInfo.InvariantCulture))
+                                    .ToArray();
+                var ret = method.Invoke(obj, convertedParams);
+
+		        CrestronConsole.ConsoleCommandResponse("Method {0} successfully called on device {1}", method.Name,
+		            action.DeviceKey);
+		    }
+		    catch (Exception ex)
+		    {
+		        CrestronConsole.ConsoleCommandResponse("Unable to call method with name {0}. {1}", action.MethodName,
+		            ex.Message);}
 		}
 
 		/// <summary>

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 DM/Essentials_DM/Chassis/DmChassisController.cs

@@ -1179,10 +1179,7 @@ namespace PepperDash.Essentials.DM
 
             var output = outputSelector as DMOutput;
 
-            var isUsbInput = (sigType & eRoutingSignalType.UsbInput) == eRoutingSignalType.UsbInput;
-            var isUsbOutput = (sigType & eRoutingSignalType.UsbOutput) == eRoutingSignalType.UsbOutput;
-
-            if (output == null && !(isUsbOutput || isUsbInput))
+            if (output == null)
             {
                 Debug.Console(0, this, Debug.ErrorLogLevel.Warning,
                     "Unable to execute switch for inputSelector {0} to outputSelector {1}", inputSelector,
@@ -1227,31 +1224,13 @@ namespace PepperDash.Essentials.DM
                 //Chassis.Outputs[output].AudioOut = inCard;
             }
 
-            if ((sigType & eRoutingSignalType.UsbOutput) != eRoutingSignalType.UsbOutput &&
-                (sigType & eRoutingSignalType.UsbInput) != eRoutingSignalType.UsbInput)
-            {
-                return;
-            }
-
-            Chassis.USBEnter.BoolValue = true;
-            if (output != null)
+            if ((sigType & eRoutingSignalType.UsbOutput) == eRoutingSignalType.UsbOutput || (sigType & eRoutingSignalType.UsbInput) == eRoutingSignalType.UsbInput)
             {
+                Chassis.USBEnter.BoolValue = true;
                 output.USBRoutedTo = input;
-                return;
-            }
-            var tempOutput = outputSelector as DMInput;
-
-            if (tempOutput == null)
-            {
-                Debug.Console(0, this, Debug.ErrorLogLevel.Warning,
-                    "Unable to execute switch for inputSelector {0} to outputSelector {1}", inputSelector,
-                    outputSelector);
-                return;
             }
 
-            tempOutput.USBRoutedTo = input;
         }
-
         #endregion
 
         #region IRoutingNumeric Members
@@ -1264,10 +1243,8 @@ namespace PepperDash.Essentials.DM
 
             DMInputOutputBase dmCard;
 
-            //Routing Input to Input or Output to Input
             if ((sigType & eRoutingSignalType.UsbInput) == eRoutingSignalType.UsbInput)
             {
-                Debug.Console(2, this, "Executing USB Input switch.\r\n in:{0} output: {1}", inputSelector, outputSelector);
                 if (outputSelector > chassisSize)
                 {
                     uint outputIndex;
@@ -1287,14 +1264,13 @@ namespace PepperDash.Essentials.DM
                     dmCard = Chassis.Inputs[inputSelector];
                 }
 
-                ExecuteSwitch(dmCard, Chassis.Inputs[outputSelector], sigType);
+                ExecuteSwitch(dmCard, Chassis.Outputs[outputSelector], sigType);
                 return;
             }
             if ((sigType & eRoutingSignalType.UsbOutput) == eRoutingSignalType.UsbOutput)
             {
                 Debug.Console(2, this, "Executing USB Output switch.\r\n in:{0} output: {1}", inputSelector, outputSelector);
 
-                //routing Output to Output or Input to Output
                 if (inputSelector > chassisSize)
                 {
                     //wanting to route an output to an output. Subtract chassis size and get output, unless it's 8x8

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)
+		{
+		}
+	}
+}