Updated EssentialsRoomBase and both extented types to use ReconfigurableDevice. Tested Fusion Custom Properties successfully updating room name and help message.

2026-02-09 09:45:06 +00:00 · 2018-09-14 21:26:25 -06:00
parent 8dabe732ec
commit 182326b3c5
11 changed files with 1517 additions and 1522 deletions
--- a/PepperDashEssentials/OTHER/Fusion/FusionCustomPropertiesBridge.cs
+++ b/PepperDashEssentials/OTHER/Fusion/FusionCustomPropertiesBridge.cs
@@ -37,6 +37,8 @@ namespace PepperDash.Essentials.Fusion

                    if (device is RoomOnToDefaultSourceWhenOccupied)
                    {
+                        Debug.Console(1, "Mapping Room on via Occupancy values from Fusion");
+
                        var devProps = JsonConvert.DeserializeObject<RoomOnToDefaultSourceWhenOccupiedConfig>(deviceConfig.Properties.ToString());

                        var enableFeature = roomInfo.FusionCustomProperties.FirstOrDefault(p => p.ID.Equals("EnRoomOnWhenOccupied"));
@@ -84,13 +86,19 @@ namespace PepperDash.Essentials.Fusion
                    else if (device is EssentialsRoomBase)
                    {
                        // Set the room name
-                        deviceConfig.Name = roomInfo.Name;
+                        if (!string.IsNullOrEmpty(roomInfo.Name))
+                        {
+                            Debug.Console(1, "Current Room Name: {0}. New Room Name: {1}", deviceConfig.Name, roomInfo.Name);
+                            deviceConfig.Name = roomInfo.Name;
+                            Debug.Console(1, "Room Name Successfully Changed.");
+                        }

                        // Set the help message
                        var helpMessage = roomInfo.FusionCustomProperties.FirstOrDefault(p => p.ID.Equals("RoomHelpMessage"));
                        if (helpMessage != null)
                        {
-                            deviceConfig.Properties["Help"]["Message"].Value<string>(helpMessage.CustomFieldValue);
+                            //Debug.Console(1, "Current Help Message: {0}. New Help Message: {1}", deviceConfig.Properties["help"]["message"].Value<string>(ToString()), helpMessage.CustomFieldValue);
+                            deviceConfig.Properties["helpMessage"] = (string)helpMessage.CustomFieldValue;
                        }
                    }

--- a/PepperDashEssentials/Properties/AssemblyInfo.cs
+++ b/PepperDashEssentials/Properties/AssemblyInfo.cs
@@ -4,5 +4,5 @@
 [assembly: AssemblyCompany("PepperDash Technology Corp")]
 [assembly: AssemblyProduct("PepperDashEssentials")]
 [assembly: AssemblyCopyright("Copyright © PepperDash Technology Corp 2018")]
-[assembly: AssemblyVersion("1.2.6.*")]
+[assembly: AssemblyVersion("1.3.0.*")]

--- a/PepperDashEssentials/Room/Behaviours/RoomOnToDefaultSourceWhenOccupied.cs
+++ b/PepperDashEssentials/Room/Behaviours/RoomOnToDefaultSourceWhenOccupied.cs
@@ -146,7 +146,7 @@ namespace PepperDash.Essentials.Room.Behaviours
            var newPropertiesConfig = JsonConvert.DeserializeObject<RoomOnToDefaultSourceWhenOccupiedConfig>(config.Properties.ToString());

            if(newPropertiesConfig != null)
-            PropertiesConfig = newPropertiesConfig;
+                PropertiesConfig = newPropertiesConfig;

            ConfigWriter.UpdateDeviceConfig(config);

--- a/PepperDashEssentials/Room/Config/EssentialsRoomConfig.cs
+++ b/PepperDashEssentials/Room/Config/EssentialsRoomConfig.cs
@@ -24,64 +24,14 @@ namespace PepperDash.Essentials.Room.Config
 			var typeName = roomConfig.Type.ToLower();
 			if (typeName == "huddle")
 			{
-                var props = JsonConvert.DeserializeObject<EssentialsHuddleRoomPropertiesConfig>
-                    (roomConfig.Properties.ToString());
-				var disp = DeviceManager.GetDeviceForKey(props.DefaultDisplayKey) as IRoutingSinkWithSwitching;
-				var audio = DeviceManager.GetDeviceForKey(props.DefaultAudioKey) as IRoutingSinkNoSwitching;
-                var huddle = new EssentialsHuddleSpaceRoom(roomConfig.Key, roomConfig.Name, disp, audio, props);
+                var huddle = new EssentialsHuddleSpaceRoom(roomConfig);

-                if (props.Occupancy != null)
-                    huddle.SetRoomOccupancy(DeviceManager.GetDeviceForKey(props.Occupancy.DeviceKey) as
-                        PepperDash.Essentials.Devices.Common.Occupancy.IOccupancyStatusProvider, props.Occupancy.TimoutMinutes);
-                huddle.LogoUrl = props.Logo.GetUrl();
-                huddle.SourceListKey = props.SourceListKey;
-                huddle.DefaultSourceItem = props.DefaultSourceItem;
-                huddle.DefaultVolume = (ushort)(props.Volumes.Master.Level * 65535 / 100);
                return huddle;
 			}
-			//else if (typeName == "presentation")
-			//{
-			//    var props = JsonConvert.DeserializeObject<EssentialsPresentationRoomPropertiesConfig>
-			//        (this.Properties.ToString());
-			//    var displaysDict = new Dictionary<uint, IRoutingSinkNoSwitching>();
-			//    uint i = 1;
-			//    foreach (var dispKey in props.DisplayKeys) // read in the ordered displays list
-			//    {
-			//        var disp = DeviceManager.GetDeviceForKey(dispKey) as IRoutingSinkWithSwitching;
-			//        displaysDict.Add(i++, disp);
-			//    }
-
-			//    // Get the master volume control
-			//    IBasicVolumeWithFeedback masterVolumeControlDev = props.Volumes.Master.GetDevice();
-
-                
-			//    var presRoom = new EssentialsPresentationRoom(Key, Name, displaysDict, masterVolumeControlDev, props);
-			//    return presRoom;
-			//}
            else if (typeName == "huddlevtc1")
            {
-                var props = JsonConvert.DeserializeObject<EssentialsHuddleVtc1PropertiesConfig>
-                    (roomConfig.Properties.ToString());
-                var disp = DeviceManager.GetDeviceForKey(props.DefaultDisplayKey) as IRoutingSinkWithSwitching;
-
-                var codec = DeviceManager.GetDeviceForKey(props.VideoCodecKey) as
-                    PepperDash.Essentials.Devices.Common.VideoCodec.VideoCodecBase;
-
-                var rm = new EssentialsHuddleVtc1Room(roomConfig.Key, roomConfig.Name, disp, codec, codec, props);
-                // Add Occupancy object from config
-
-                if (props.Occupancy != null)
-                    rm.SetRoomOccupancy(DeviceManager.GetDeviceForKey(props.Occupancy.DeviceKey) as
-                        PepperDash.Essentials.Devices.Common.Occupancy.IOccupancyStatusProvider, props.Occupancy.TimoutMinutes);
-                rm.LogoUrl = props.Logo.GetUrl();
-                rm.SourceListKey = props.SourceListKey;
-                rm.DefaultSourceItem = props.DefaultSourceItem;
-                rm.DefaultVolume = (ushort)(props.Volumes.Master.Level * 65535 / 100);
-
-                rm.MicrophonePrivacy = GetMicrophonePrivacy(props, rm); // Get Microphone Privacy object, if any
-
-                rm.Emergency = GetEmergency(props, rm); // Get emergency object, if any
-
+                var rm = new EssentialsHuddleVtc1Room(roomConfig);
+                
                return rm;
            }
 			else if (typeName == "ddvc01Bridge")
@@ -96,7 +46,7 @@ namespace PepperDash.Essentials.Room.Config
        /// Gets and operating, standalone emergegncy object that can be plugged into a room.
        /// Returns null if there is no emergency defined
        /// </summary>
-        static EssentialsRoomEmergencyBase GetEmergency(EssentialsRoomPropertiesConfig props, EssentialsRoomBase room)
+        public static EssentialsRoomEmergencyBase GetEmergency(EssentialsRoomPropertiesConfig props, EssentialsRoomBase room)
        {
            // This emergency 
            var emergency = props.Emergency;
@@ -115,7 +65,7 @@ namespace PepperDash.Essentials.Room.Config
 		/// <param name="props"></param>
 		/// <param name="room"></param>
 		/// <returns></returns>
-		static PepperDash.Essentials.Devices.Common.Microphones.MicrophonePrivacyController GetMicrophonePrivacy(
+		public static PepperDash.Essentials.Devices.Common.Microphones.MicrophonePrivacyController GetMicrophonePrivacy(
 			EssentialsRoomPropertiesConfig props, EssentialsHuddleVtc1Room room)
 		{
 			var microphonePrivacy = props.MicrophonePrivacy;
--- a/PepperDashEssentials/Room/Types/EssentialsHuddleSpaceRoom.cs
+++ b/PepperDashEssentials/Room/Types/EssentialsHuddleSpaceRoom.cs
@@ -4,6 +4,8 @@ using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;

+using Newtonsoft.Json;
+
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Config;
@@ -66,7 +68,7 @@ namespace PepperDash.Essentials
            }
        }

-		public EssentialsRoomPropertiesConfig PropertiesConfig { get; private set; }
+		public EssentialsHuddleRoomPropertiesConfig PropertiesConfig { get; private set; }

 		public IRoutingSinkWithSwitching DefaultDisplay { get; private set; }
 		public IRoutingSinkNoSwitching DefaultAudioDevice { get; private set; }
@@ -147,22 +149,32 @@ namespace PepperDash.Essentials

        public string CurrentSourceInfoKey { get; private set; }

-		/// <summary>
-		/// 
-		/// </summary>
-		/// <param name="key"></param>
-		/// <param name="name"></param>
-		public EssentialsHuddleSpaceRoom(string key, string name, IRoutingSinkWithSwitching defaultDisplay, 
-			IRoutingSinkNoSwitching defaultAudio, EssentialsRoomPropertiesConfig config)
-			: base(key, name)
+        public EssentialsHuddleSpaceRoom(DeviceConfig config)
+            : base(config)
+        {
+            try
+            {
+                PropertiesConfig = JsonConvert.DeserializeObject<EssentialsHuddleRoomPropertiesConfig>
+                    (config.Properties.ToString());
+                DefaultDisplay = DeviceManager.GetDeviceForKey(PropertiesConfig.DefaultDisplayKey) as IRoutingSinkWithSwitching;
+
+
+                DefaultAudioDevice = DeviceManager.GetDeviceForKey(PropertiesConfig.DefaultAudioKey) as IRoutingSinkWithSwitching;
+
+                Initialize();
+            }
+            catch (Exception e)
+            {
+                Debug.Console(1, this, "Error building room: \n{0}", e);
+            }
+        }
+
+		void Initialize()
 		{
-			PropertiesConfig = config;
-			DefaultDisplay = defaultDisplay;
-			DefaultAudioDevice = defaultAudio;
-			if (defaultAudio is IBasicVolumeControls)
-				DefaultVolumeControls = defaultAudio as IBasicVolumeControls;
-			else if (defaultAudio is IHasVolumeDevice)
-				DefaultVolumeControls = (defaultAudio as IHasVolumeDevice).VolumeDevice;
+            if (DefaultAudioDevice is IBasicVolumeControls)
+                DefaultVolumeControls = DefaultAudioDevice as IBasicVolumeControls;
+            else if (DefaultAudioDevice is IHasVolumeDevice)
+                DefaultVolumeControls = (DefaultAudioDevice as IHasVolumeDevice).VolumeDevice;
            CurrentVolumeControls = DefaultVolumeControls;

            var disp = DefaultDisplay as DisplayBase;
@@ -195,6 +207,15 @@ namespace PepperDash.Essentials
 			EnablePowerOnToLastSource = true;
   		}

+        protected override void CustomSetConfig(DeviceConfig config)
+        {
+            var newPropertiesConfig = JsonConvert.DeserializeObject<EssentialsHuddleRoomPropertiesConfig>(config.Properties.ToString());
+
+            if (newPropertiesConfig != null)
+                PropertiesConfig = newPropertiesConfig;
+
+            ConfigWriter.UpdateRoomConfig(config);
+        }

        /// <summary>
        /// 
@@ -225,6 +246,21 @@ namespace PepperDash.Essentials
 			return true;
        }

+        public override bool CustomActivate()
+        {
+            // Add Occupancy object from config
+            if (PropertiesConfig.Occupancy != null)
+                this.SetRoomOccupancy(DeviceManager.GetDeviceForKey(PropertiesConfig.Occupancy.DeviceKey) as
+                    PepperDash.Essentials.Devices.Common.Occupancy.IOccupancyStatusProvider, PropertiesConfig.Occupancy.TimoutMinutes);
+
+            this.LogoUrl = PropertiesConfig.Logo.GetUrl();
+            this.SourceListKey = PropertiesConfig.SourceListKey;
+            this.DefaultSourceItem = PropertiesConfig.DefaultSourceItem;
+            this.DefaultVolume = (ushort)(PropertiesConfig.Volumes.Master.Level * 65535 / 100);
+
+            return base.CustomActivate();
+        }
+
        /// <summary>
        /// 
        /// </summary>
--- a/PepperDashEssentials/Room/Types/EssentialsHuddleVtc1Room.cs
+++ b/PepperDashEssentials/Room/Types/EssentialsHuddleVtc1Room.cs
@@ -4,6 +4,8 @@ using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;

+using Newtonsoft.Json;
+
 using PepperDash.Core;
 using PepperDash.Essentials.Core;
 using PepperDash.Essentials.Core.Config;
@@ -195,26 +197,37 @@ namespace PepperDash.Essentials

 		CCriticalSection SourceSelectLock = new CCriticalSection();

-		/// <summary>
-		/// 
-		/// </summary>
-		/// <param name="key"></param>
-		/// <param name="name"></param>
-        public EssentialsHuddleVtc1Room(string key, string name, IRoutingSinkWithSwitching defaultDisplay, 
-			IBasicVolumeControls defaultAudio, VideoCodecBase codec, EssentialsHuddleVtc1PropertiesConfig config)
-			: base(key, name)
-		{
-            if (codec == null)
-                throw new ArgumentNullException("codec cannot be null");
-			PropertiesConfig = config;
-			DefaultDisplay = defaultDisplay;
-            VideoCodec = codec;
-			DefaultAudioDevice = defaultAudio;

-			if (defaultAudio is IBasicVolumeControls)
-				DefaultVolumeControls = defaultAudio as IBasicVolumeControls;
-			else if (defaultAudio is IHasVolumeDevice)
-				DefaultVolumeControls = (defaultAudio as IHasVolumeDevice).VolumeDevice;
+        public EssentialsHuddleVtc1Room(DeviceConfig config)
+            : base(config)
+        {
+            try
+            {
+                PropertiesConfig = JsonConvert.DeserializeObject<EssentialsHuddleVtc1PropertiesConfig>
+                    (config.Properties.ToString());
+                DefaultDisplay = DeviceManager.GetDeviceForKey(PropertiesConfig.DefaultDisplayKey) as IRoutingSinkWithSwitching;
+
+                VideoCodec = DeviceManager.GetDeviceForKey(PropertiesConfig.VideoCodecKey) as
+                    PepperDash.Essentials.Devices.Common.VideoCodec.VideoCodecBase;
+                if (VideoCodec == null)
+                    throw new ArgumentNullException("codec cannot be null");
+
+                DefaultAudioDevice = DeviceManager.GetDeviceForKey(PropertiesConfig.DefaultAudioKey) as IBasicVolumeControls;
+
+                Initialize();
+            }
+            catch (Exception e)
+            {
+                Debug.Console(1, this, "Error building room: \n{0}", e);
+            }
+        }
+
+        void Initialize()
+		{
+            if (DefaultAudioDevice is IBasicVolumeControls)
+                DefaultVolumeControls = DefaultAudioDevice as IBasicVolumeControls;
+            else if (DefaultAudioDevice is IHasVolumeDevice)
+                DefaultVolumeControls = (DefaultAudioDevice as IHasVolumeDevice).VolumeDevice;
            CurrentVolumeControls = DefaultVolumeControls;
 			

@@ -264,6 +277,37 @@ namespace PepperDash.Essentials
 			EnablePowerOnToLastSource = true;
   		}

+        protected override void CustomSetConfig(DeviceConfig config)
+        {
+            var newPropertiesConfig = JsonConvert.DeserializeObject<EssentialsHuddleVtc1PropertiesConfig>(config.Properties.ToString());
+
+            if (newPropertiesConfig != null)
+                PropertiesConfig = newPropertiesConfig;
+
+            ConfigWriter.UpdateRoomConfig(config);
+        }
+
+        public override bool CustomActivate()
+        {
+            // Add Occupancy object from config
+            if (PropertiesConfig.Occupancy != null)
+                this.SetRoomOccupancy(DeviceManager.GetDeviceForKey(PropertiesConfig.Occupancy.DeviceKey) as
+                    PepperDash.Essentials.Devices.Common.Occupancy.IOccupancyStatusProvider, PropertiesConfig.Occupancy.TimoutMinutes);
+
+            this.LogoUrl = PropertiesConfig.Logo.GetUrl();
+            this.SourceListKey = PropertiesConfig.SourceListKey;
+            this.DefaultSourceItem = PropertiesConfig.DefaultSourceItem;
+            this.DefaultVolume = (ushort)(PropertiesConfig.Volumes.Master.Level * 65535 / 100);
+
+            // Get Microphone Privacy object, if any
+            this.MicrophonePrivacy = EssentialsRoomConfigHelper.GetMicrophonePrivacy(PropertiesConfig, this);
+
+            // Get emergency object, if any
+            this.Emergency = EssentialsRoomConfigHelper.GetEmergency(PropertiesConfig, this);
+
+            return base.CustomActivate();
+        }
+

        /// <summary>
        /// 
--- a/PepperDashEssentials/Room/Types/EssentialsRoomBase.cs
+++ b/PepperDashEssentials/Room/Types/EssentialsRoomBase.cs
@@ -7,6 +7,7 @@ using Crestron.SimplSharp.Scheduler;

 using PepperDash.Core;
 using PepperDash.Essentials.Core;
+using PepperDash.Essentials.Core.Config;
 using PepperDash.Essentials.Core.Devices;
 using PepperDash.Essentials.Devices.Common.Occupancy;

@@ -122,50 +123,6 @@ namespace PepperDash.Essentials
            });
        }

-        ///// <summary>
-        ///// 
-        ///// </summary>
-        ///// <param name="key"></param>
-        ///// <param name="name"></param>
-        //public EssentialsRoomBase(string key, string name) : base(key, name)
-        //{
-        //    // Setup the ShutdownPromptTimer
-        //    ShutdownPromptTimer = new SecondsCountdownTimer(Key + "-offTimer");
-        //    ShutdownPromptTimer.IsRunningFeedback.OutputChange += (o, a) =>
-        //    {
-        //        if (!ShutdownPromptTimer.IsRunningFeedback.BoolValue)
-        //            ShutdownType = eShutdownType.None;
-        //    };
-        //    ShutdownPromptTimer.HasFinished += (o, a) => Shutdown(); // Shutdown is triggered 
-
-        //    ShutdownPromptSeconds = 60;
-        //    ShutdownVacancySeconds = 120;
-        //    ShutdownType = eShutdownType.None;
-
-        //    RoomVacancyShutdownTimer = new SecondsCountdownTimer(Key + "-vacancyOffTimer");
-        //    //RoomVacancyShutdownTimer.IsRunningFeedback.OutputChange += (o, a) =>
-        //    //{
-        //    //    if (!RoomVacancyShutdownTimer.IsRunningFeedback.BoolValue)
-        //    //        ShutdownType = ShutdownType.Vacancy;
-        //    //};
-        //    RoomVacancyShutdownTimer.HasFinished += new EventHandler<EventArgs>(RoomVacancyShutdownPromptTimer_HasFinished); // Shutdown is triggered
-
-        //    RoomVacancyShutdownPromptSeconds = 1500;    //  25 min to prompt warning
-        //    RoomVacancyShutdownSeconds = 240;           //  4 min after prompt will trigger shutdown prompt
-        //    VacancyMode = eVacancyMode.None;
-
-        //    OnFeedback = new BoolFeedback(OnFeedbackFunc);
-
-        //    IsWarmingUpFeedback = new BoolFeedback(IsWarmingFeedbackFunc);
-        //    IsCoolingDownFeedback = new BoolFeedback(IsCoolingFeedbackFunc);
-
-        //    AddPostActivationAction(() =>
-        //    {
-        //        if (RoomOccupancy != null)
-        //            OnRoomOccupancyIsSet();
-        //    });
-        //}
-
        void RoomVacancyShutdownPromptTimer_HasFinished(object sender, EventArgs e)
        {
            switch (VacancyMode)
@@ -241,7 +198,7 @@ namespace PepperDash.Essentials
        /// </summary>
        /// <param name="statusProvider"></param>
        public void SetRoomOccupancy(IOccupancyStatusProvider statusProvider, int timeoutMinutes)
-        {
+        { 
 			if (statusProvider == null)
 			{
 				Debug.Console(0, this, "ERROR: Occupancy sensor device is null");
--- a/PepperDashEssentials/UIDrivers/EssentialsHuddleVTC/EssentialsHuddleVtc1PanelAvFunctionsDriver.cs
+++ b/PepperDashEssentials/UIDrivers/EssentialsHuddleVTC/EssentialsHuddleVtc1PanelAvFunctionsDriver.cs
--- a/Package/PepperDashEssentials.cpz
+++ b/Package/PepperDashEssentials.cpz
--- a/Package/PepperDashEssentials.dll
+++ b/Package/PepperDashEssentials.dll
--- a/2
+++ b/2