Merge pull request #1038 from PepperDash/hotfix/occ-sensor-fixes

Prevent vacancy from shutting down the room when a call is active
Merge branch 'main' into hotfix/occ-sensor-fixes
2026-01-23 01:15:03 +00:00 · 2022-11-28 16:19:26 -07:00 · 2022-11-28 15:19:45 -07:00 · 2022-11-23 16:24:28 -07:00 · 2022-11-23 14:29:36 -07:00 · 2022-11-23 13:15:41 -07:00
9 changed files with 121 additions and 34 deletions
--- a/PepperDashEssentials/ControlSystem.cs
+++ b/PepperDashEssentials/ControlSystem.cs
@@ -195,6 +195,8 @@ namespace PepperDash.Essentials
                }
                else   // Handles Linux OS (Virtual Control)
                {
+                    Debug.SetDebugLevel(2);
+
                    Debug.Console(0, Debug.ErrorLogLevel.Notice, "Starting Essentials v{0} on Virtual Control Server", Global.AssemblyVersion);

                    // Set path to User/
--- a/PepperDashEssentials/Room/Types/EssentialsHuddleVtc1Room.cs
+++ b/PepperDashEssentials/Room/Types/EssentialsHuddleVtc1Room.cs
@@ -745,6 +745,28 @@ namespace PepperDash.Essentials
        {
            //Implement this
        }
+
+        protected override bool AllowVacancyTimerToStart()
+        {
+            bool allowVideo = true;
+            bool allowAudio = true;
+
+            if (VideoCodec != null)
+            {
+                Debug.Console(2,this, Debug.ErrorLogLevel.Notice, "Room {0} {1} in a video call", Key, VideoCodec.IsInCall ? "is" : "is not");
+                allowVideo = !VideoCodec.IsInCall;
+            }
+
+            if (AudioCodec != null)
+            {
+                Debug.Console(2,this, Debug.ErrorLogLevel.Notice, "Room {0} {1} in an audio call", Key, AudioCodec.IsInCall ? "is" : "is not");
+                allowAudio = !AudioCodec.IsInCall;
+            }
+
+            Debug.Console(2, this, "Room {0} allowing vacancy timer to start: {1}", Key, allowVideo && allowAudio);
+
+            return allowVideo && allowAudio;
+        }
        
        /// <summary>
        /// Does what it says
--- a/Core/PepperDashEssentialsBase/Bridges/BridgeBase.cs
+++ b/Core/PepperDashEssentialsBase/Bridges/BridgeBase.cs
@@ -394,35 +394,51 @@ namespace PepperDash.Essentials.Core.Bridges

            var controlProperties = CommFactory.GetControlPropertiesConfig(dc);

+            BasicTriList eisc;
+
            switch (dc.Type.ToLower())
            {
                case "eiscapiadv":
                case "eiscapiadvanced":
                {
-                    var eisc = new ThreeSeriesTcpIpEthernetIntersystemCommunications(controlProperties.IpIdInt,
+                    eisc = new ThreeSeriesTcpIpEthernetIntersystemCommunications(controlProperties.IpIdInt,
                        controlProperties.TcpSshProperties.Address, Global.ControlSystem);
-                    return new EiscApiAdvanced(dc, eisc);
+                    break;
                }
                case "eiscapiadvancedserver":
                {
-                    var eisc = new EISCServer(controlProperties.IpIdInt, Global.ControlSystem);
-                    return new EiscApiAdvanced(dc, eisc);
+                    eisc = new EISCServer(controlProperties.IpIdInt, Global.ControlSystem);
+                    break;
                }
                case "eiscapiadvancedclient":
                {
-                    var eisc = new EISCClient(controlProperties.IpIdInt, controlProperties.TcpSshProperties.Address, Global.ControlSystem);
-                    return new EiscApiAdvanced(dc, eisc);
+                    eisc = new EISCClient(controlProperties.IpIdInt, controlProperties.TcpSshProperties.Address, Global.ControlSystem);
+                    break;
                }
                case "vceiscapiadv":
                case "vceiscapiadvanced":
                {
-                    var eisc = new VirtualControlEISCClient(controlProperties.IpIdInt, InitialParametersClass.RoomId,
+                    if (string.IsNullOrEmpty(controlProperties.RoomId))
+                    {
+                        Debug.Console(0, Debug.ErrorLogLevel.Error, "Unable to build VC-4 EISC Client for device {0}. Room ID is missing or empty", dc.Key);
+                        eisc = null;
+                        break;
+                    }
+                    eisc = new VirtualControlEISCClient(controlProperties.IpIdInt, controlProperties.RoomId,
                        Global.ControlSystem);
-                    return new EiscApiAdvanced(dc, eisc);
+                    break;
                }
                default:
-                    return null;
+                    eisc = null;
+                    break;
            }
+
+            if (eisc == null)
+            {
+                return null;
+            }
+
+            return new EiscApiAdvanced(dc, eisc);
        }
    }

--- a/Core/PepperDashEssentialsBase/Room/EssentialsRoomBase.cs
+++ b/Core/PepperDashEssentialsBase/Room/EssentialsRoomBase.cs
@@ -343,7 +343,7 @@ namespace PepperDash.Essentials.Core

        void RoomIsOccupiedFeedback_OutputChange(object sender, EventArgs e)
        {
-            if (RoomOccupancy.RoomIsOccupiedFeedback.BoolValue == false)
+            if (RoomOccupancy.RoomIsOccupiedFeedback.BoolValue == false  && AllowVacancyTimerToStart())
            {
                Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Notice: Vacancy Detected");
                // Trigger the timer when the room is vacant
@@ -362,6 +362,15 @@ namespace PepperDash.Essentials.Core
        /// </summary>
        /// <param name="o"></param>
        public abstract void RoomVacatedForTimeoutPeriod(object o);
+
+        /// <summary>
+        /// Allow the vacancy event from an occupancy sensor to turn the room off.
+        /// </summary>
+        /// <returns>If the timer should be allowed. Defaults to true</returns>
+        protected virtual bool AllowVacancyTimerToStart()
+        {
+            return true;
+        }
    }
        
    /// <summary>
--- a/Core/PepperDashEssentialsBase/UI/TouchpanelBase.cs
+++ b/Core/PepperDashEssentialsBase/UI/TouchpanelBase.cs
@@ -31,7 +31,7 @@ namespace PepperDash.Essentials.Core.UI
            :base(key, name)
        {

-            if (Panel == null)
+            if (panel == null)
            {
                Debug.Console(0, this, "Panel is not valid. Touchpanel class WILL NOT work correctly");
                return;
@@ -71,6 +71,8 @@ namespace PepperDash.Essentials.Core.UI
                        return;
                    }
                }
+
+                Panel.LoadSmartObjects(sgdName);
            });

            AddPostActivationAction(() =>
--- a/essentials-framework/Essentials
+++ b/essentials-framework/Essentials
@@ -223,7 +223,7 @@ namespace PepperDash.Essentials.Devices.Common.Cameras

                SendCameraPresetNamesToApi(presetsCamera, joinMap, trilist);

-                for (int i = 0; i < joinMap.NumberOfPresets.JoinNumber; i++)
+                for (int i = 0; i < joinMap.NumberOfPresets.JoinSpan; i++)
                {
                    int tempNum = i;

--- a/Common/VideoCodec/VideoCodecBase.cs
+++ b/Common/VideoCodec/VideoCodecBase.cs
@@ -1393,11 +1393,11 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec
                tokenArray[digitalIndex + 1] = new XSigDigitalToken(digitalIndex + 2, call.IsOnHold);

 				//serials
-				tokenArray[arrayIndex] = new XSigSerialToken(stringIndex + 1, call.Name ?? String.Empty);
-				tokenArray[arrayIndex + 1] = new XSigSerialToken(stringIndex + 2, call.Number ?? String.Empty);
-				tokenArray[arrayIndex + 2] = new XSigSerialToken(stringIndex + 3, call.Direction.ToString());
-				tokenArray[arrayIndex + 3] = new XSigSerialToken(stringIndex + 4, call.Type.ToString());
-				tokenArray[arrayIndex + 4] = new XSigSerialToken(stringIndex + 5, call.Status.ToString());
+                tokenArray[stringIndex] = new XSigSerialToken(stringIndex + 1, call.Name ?? String.Empty);
+                tokenArray[stringIndex + 1] = new XSigSerialToken(stringIndex + 2, call.Number ?? String.Empty);
+                tokenArray[stringIndex + 2] = new XSigSerialToken(stringIndex + 3, call.Direction.ToString());
+                tokenArray[stringIndex + 3] = new XSigSerialToken(stringIndex + 4, call.Type.ToString());
+                tokenArray[stringIndex + 4] = new XSigSerialToken(stringIndex + 5, call.Status.ToString());
                if(call.Duration != null)
                {
                    // May need to verify correct string format here
@@ -1417,12 +1417,12 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec


                //serials
-				tokenArray[arrayIndex] = new XSigSerialToken(stringIndex + 1, String.Empty);
-				tokenArray[arrayIndex + 1] = new XSigSerialToken(stringIndex + 2, String.Empty);
-				tokenArray[arrayIndex + 2] = new XSigSerialToken(stringIndex + 3, String.Empty);
-				tokenArray[arrayIndex + 3] = new XSigSerialToken(stringIndex + 4, String.Empty);
-				tokenArray[arrayIndex + 4] = new XSigSerialToken(stringIndex + 5, String.Empty);
-                tokenArray[arrayIndex + 5] = new XSigSerialToken(stringIndex + 6, String.Empty);
+                tokenArray[stringIndex] = new XSigSerialToken(stringIndex + 1, String.Empty);
+                tokenArray[stringIndex + 1] = new XSigSerialToken(stringIndex + 2, String.Empty);
+                tokenArray[stringIndex + 2] = new XSigSerialToken(stringIndex + 3, String.Empty);
+                tokenArray[stringIndex + 3] = new XSigSerialToken(stringIndex + 4, String.Empty);
+                tokenArray[stringIndex + 4] = new XSigSerialToken(stringIndex + 5, String.Empty);
+                tokenArray[stringIndex + 5] = new XSigSerialToken(stringIndex + 6, String.Empty);

 				arrayIndex += offset;
 				stringIndex += maxStrings;
--- a/Common/VideoCodec/ZoomRoom/ZoomRoom.cs
+++ b/Common/VideoCodec/ZoomRoom/ZoomRoom.cs
@@ -64,9 +64,11 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 		private bool _meetingPasswordRequired;

+        private bool _waitingForUserToAcceptOrRejectIncomingCall;
+
 		public void Poll(string pollString)
 		{
-			if(_meetingPasswordRequired) return;
+			if(_meetingPasswordRequired || _waitingForUserToAcceptOrRejectIncomingCall) return;
 			
 			SendText(string.Format("{0}{1}", pollString, SendDelimiter));
 		}
@@ -968,6 +970,18 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 		public void SendText(string command)
 		{
+            if (_meetingPasswordRequired)
+            {
+                Debug.Console(2, this, "Blocking commands to ZoomRoom while waiting for user to enter meeting password");
+                return;
+            }
+
+            if (_waitingForUserToAcceptOrRejectIncomingCall)
+            {
+                Debug.Console(2, this, "Blocking commands to ZoomRoom while waiting for user to accept or reject incoming call");
+                return;
+            }
+
 			if (CommDebuggingIsOn)
 			{
 				Debug.Console(1, this, "Sending: '{0}'", command);
@@ -1592,6 +1606,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 										Id = incomingCall.callerJID
 									};

+                                    _waitingForUserToAcceptOrRejectIncomingCall = true;
+
 									ActiveCalls.Add(newCall);

 									OnCallStatusChange(newCall);
@@ -1618,6 +1634,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 										OnCallStatusChange(existingCall);
 									}

+                                    _waitingForUserToAcceptOrRejectIncomingCall = false;
+
 									UpdateCallStatus();
 								}

@@ -2000,7 +2018,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom
 		/// </summary>
 		private void GetBookings()
 		{
-			if (_meetingPasswordRequired) return;
+			if (_meetingPasswordRequired || _waitingForUserToAcceptOrRejectIncomingCall) return;

 			SendText("zCommand Bookings List");
 		}
@@ -2560,7 +2578,7 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 			PasswordRequired += (devices, args) =>
 			{
-                Debug.Console(0, this, "***********************************PaswordRequired. Message: {0} Cancelled: {1} Last Incorrect: {2} Failed: {3}", args.Message, args.LoginAttemptCancelled, args.LastAttemptWasIncorrect, args.LoginAttemptFailed);
+                Debug.Console(2, this, "***********************************PaswordRequired. Message: {0} Cancelled: {1} Last Incorrect: {2} Failed: {3}", args.Message, args.LoginAttemptCancelled, args.LastAttemptWasIncorrect, args.LoginAttemptFailed);

 				if (args.LoginAttemptCancelled)
 				{
@@ -2637,6 +2655,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 		public void AcceptCall()
 		{
+            _waitingForUserToAcceptOrRejectIncomingCall = false;
+
 			var incomingCall =
 				ActiveCalls.FirstOrDefault(
 					c => c.Status.Equals(eCodecCallStatus.Ringing) && c.Direction.Equals(eCodecCallDirection.Incoming));
@@ -2646,6 +2666,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 		public override void AcceptCall(CodecActiveCallItem call)
 		{
+            _waitingForUserToAcceptOrRejectIncomingCall = false;
+
 			SendText(string.Format("zCommand Call Accept callerJID: {0}", call.Id));

 			call.Status = eCodecCallStatus.Connected;
@@ -2657,6 +2679,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 		public void RejectCall()
 		{
+            _waitingForUserToAcceptOrRejectIncomingCall = false;
+
 			var incomingCall =
 				ActiveCalls.FirstOrDefault(
 					c => c.Status.Equals(eCodecCallStatus.Ringing) && c.Direction.Equals(eCodecCallDirection.Incoming));
@@ -2666,6 +2690,8 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

 		public override void RejectCall(CodecActiveCallItem call)
 		{
+            _waitingForUserToAcceptOrRejectIncomingCall = false;
+
 			SendText(string.Format("zCommand Call Reject callerJID: {0}", call.Id));

 			call.Status = eCodecCallStatus.Disconnected;
@@ -2792,16 +2818,25 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

        public void LeaveMeeting()
        {
-            SendText("zCommand Call Leave");
+			_meetingPasswordRequired = false;
+			_waitingForUserToAcceptOrRejectIncomingCall = false;
+
+			SendText("zCommand Call Leave");
        }

 		public override void EndCall(CodecActiveCallItem call)
 		{
+			_meetingPasswordRequired = false;
+			_waitingForUserToAcceptOrRejectIncomingCall = false;
+
 			SendText("zCommand Call Disconnect");
 		}

 		public override void EndAllCalls()
 		{
+			_meetingPasswordRequired = false;
+			_waitingForUserToAcceptOrRejectIncomingCall = false;
+
 			SendText("zCommand Call Disconnect");
 		}

@@ -3451,20 +3486,21 @@ namespace PepperDash.Essentials.Devices.Common.VideoCodec.ZoomRoom

        public void SubmitPassword(string password)
        {
+            _meetingPasswordRequired = false;
            Debug.Console(2, this, "Password Submitted: {0}", password);
            Dial(_lastDialedMeetingNumber, password);
-            //OnPasswordRequired(false, false, true, "");		
        }

        void OnPasswordRequired(bool lastAttemptIncorrect, bool loginFailed, bool loginCancelled, string message)
        {
+			_meetingPasswordRequired = !loginFailed || !loginCancelled;
+
            var handler = PasswordRequired;
            if (handler != null)
-            {
-				if(!loginFailed || !loginCancelled)
-					_meetingPasswordRequired = true;
-				
-                handler(this, new PasswordPromptEventArgs(lastAttemptIncorrect, loginFailed, loginCancelled, message));
+            {	            
+				Debug.Console(2, this, "Meeting Password Required: {0}", _meetingPasswordRequired);
+
+	            handler(this, new PasswordPromptEventArgs(lastAttemptIncorrect, loginFailed, loginCancelled, message));
            }
        }

--- a/packages.config
+++ b/packages.config
@@ -1,3 +1,3 @@
 <packages>
-  <package id="PepperDashCore" version="1.1.1" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
+  <package id="PepperDashCore" version="1.1.3" targetFramework="net35" allowedVersions="[1.0,2.0)"/>
 </packages>
Author	SHA1	Message	Date
Andrew Welker	668cbc430c	Merge pull request #1038 from PepperDash/hotfix/occ-sensor-fixes Prevent vacancy from shutting down the room when a call is active	2022-11-28 16:19:26 -07:00
Andrew Welker	e54de1f1cb	Merge branch 'main' into hotfix/occ-sensor-fixes	2022-11-28 15:19:45 -07:00
Neil Dorin	f48b1a2de3	Merge pull request #1039 from PepperDash/hotfix/touchpanelBase Fix issues with TouchpanelBase	2022-11-23 16:24:28 -07:00
Andrew Welker	8e57e7ec31	fix: add missing LoadSmartObjects call	2022-11-23 14:29:36 -07:00
Andrew Welker	1b43b44d19	fix: typo in `TouchpanelBase` constructor The constructor was checking the wrong variable, leading to it always being null and failing to build the `EssentialsTouchpanelController` class.	2022-11-23 13:15:41 -07:00
Andrew Welker	4306128474	refactor: fix abstract method	2022-11-21 10:45:25 -07:00
Andrew Welker	5263b16bb7	refactor: fix issues with log statments	2022-11-21 10:42:33 -07:00
Andrew Welker	a2b67798f3	refactor: add logging statements	2022-11-21 10:37:26 -07:00
Andrew Welker	1b43fba37e	fix: add logic to prevent vacancy from triggering room off if room is in a call	2022-11-21 10:28:08 -07:00
Andrew Welker	f262c1a3bb	Merge pull request #1036 from PepperDash/hotfix/PD-core-update-for-vc4 Updates for VC-4	2022-11-16 11:05:40 -07:00
Andrew Welker	93ee695c57	Merge branch 'main' into hotfix/PD-core-update-for-vc4	2022-11-16 10:52:15 -07:00
Andrew Welker	ba0bae3c4e	chore: update PD Core to 1.1.3	2022-11-16 10:51:48 -07:00
Trevor Payne	37a98d00af	Merge pull request #1037 from PepperDash/hotfix/VideoCodec-ActiveCall-XSig Fix error with updating call status XSigs	2022-11-14 10:25:28 -06:00
Trevor Payne	247827ac25	fix: UpdateCallStatusXsig() now properly refreshing calls	2022-11-14 10:10:22 -06:00
Andrew Welker	5e797db096	fix: add check for missing/empty roomId	2022-11-11 16:26:37 -07:00
Andrew Welker	57eeeec0fb	Merge branch 'main' into hotfix/PD-core-update-for-vc4	2022-11-11 16:23:12 -07:00
Andrew Welker	db19da124c	fix: set debug level to 2 on startup Some plugins and devices are doing their own filtering based on the debug level that's normally set using the `appdebug` console command. On VC-4, there's no way to set that value. With this change, when Essentials starts on a server, the debug level will be set to 2, so that any of the messages that might be filtered based on the debug level won't be filtered.	2022-11-11 14:37:46 -07:00
Andrew Welker	c07f52b06f	feat: update VC-4 client to use correct RoomID	2022-11-10 12:51:04 -07:00
Neil Dorin	b6675477be	Merge pull request #1029 from PepperDash/hotfix/zoom-passcode-and-incoming-call-prompt-states-on-cancel Update Zoom polling/sending blocks for more scenarios	2022-11-09 09:27:07 -07:00
Andrew Welker	fc3840173e	chore: Update PD Core version	2022-11-08 08:44:39 -07:00
Andrew Welker	ce51a62d97	chore: update PD Core version	2022-11-04 14:01:11 -06:00
Andrew Welker	2be42f88bc	chore: update PD Core version In order to fix issues with debug file location for VC-4, the PD Core version needs to be updated	2022-11-04 09:48:17 -06:00
jdevito	6f9a9ee255	fix: moved setting set in event before null check	2022-10-28 16:47:43 -05:00
jdevito	a09212417c	fix: removed property sets as recommended in discussion; removed 'if' statements before property sets in leave and end call methods	2022-10-28 16:20:49 -05:00
jdevito	4d6da37c60	fix: added additional evaluations for prompt property tracking and set/reset to handled unknown user scenarios	2022-10-28 08:38:16 -05:00
Andrew Welker	95627df1a6	Merge pull request #1026 from PepperDash/hotfix/zoomroom-block-commands-on-incoming-call fix(essentials): Block all commands to ZoomRoom on incoming call	2022-10-25 13:40:32 -06:00
Neil Dorin	bef07fe41b	fix(essentials): Block all commands to ZoomRoom on incoming call	2022-10-25 10:30:02 -06:00
Andrew Welker	83d2497264	Merge pull request #1021 from PepperDash/hotfix/848-camera-preset-bridge-issue fix: max number of presets now uses join span rather than join start.	2022-10-20 11:17:39 -06:00
Andrew Welker	50f5145a89	Merge branch 'main' into hotfix/848-camera-preset-bridge-issue	2022-10-20 10:58:10 -06:00
Neil Dorin	a734a869c1	Merge pull request #1023 from PepperDash/hotfix/zoomrooms-passcode-required-prohibits-polling fix: added bool property tracking if meeting is require, added poll m…	2022-10-20 10:30:14 -06:00
Jason Alborough	70d2633eb0	fix: max number of presets now uses join span rather than join start.	2022-10-20 09:52:58 -04:00