feat: complete XML documentation in Devices.Common

src/PepperDash.Essentials.Core/CrestronIO/GenericDigitalInputDevice.cs

@@ -21,7 +21,6 @@ namespace PepperDash.Essentials.Core.CrestronIO
     public class GenericDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput, IHasFeedback
     {
         private DigitalInput inputPort;
-        private bool invertState;
 
         /// <summary>
         /// Gets or sets the InputStateFeedback
@@ -42,10 +41,7 @@ namespace PepperDash.Essentials.Core.CrestronIO
             IOPortConfig config)
             : base(key, name)
         {
-            invertState = !string.IsNullOrEmpty(config.CircuitType) && 
-                         config.CircuitType.Equals("NC", StringComparison.OrdinalIgnoreCase);
-            
-            InputStateFeedback = new BoolFeedback("inputState", () => invertState ? !inputPort.State : inputPort.State);
+            InputStateFeedback = new BoolFeedback("inputState", () => inputPort.State);
 
             AddPostActivationAction(() =>
             {

src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportInputDevice.cs

@@ -18,7 +18,6 @@ namespace PepperDash.Essentials.Core.CrestronIO
     public class GenericVersiportDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput, IPartitionStateProvider, IHasFeedback
     {
         private Versiport inputPort;
-        private bool invertState;
 
         /// <summary>
         /// Gets or sets the InputStateFeedback
@@ -48,10 +47,7 @@ namespace PepperDash.Essentials.Core.CrestronIO
         public GenericVersiportDigitalInputDevice(string key, string name, Func<IOPortConfig, Versiport> postActivationFunc, IOPortConfig config) :
             base(key, name)
         {
-            invertState = !string.IsNullOrEmpty(config.CircuitType) && 
-                         config.CircuitType.Equals("NC", StringComparison.OrdinalIgnoreCase);
-            
-            InputStateFeedback = new BoolFeedback("inputState", () => invertState ? !inputPort.DigitalIn : inputPort.DigitalIn);
+            InputStateFeedback = new BoolFeedback("inputState", () => inputPort.DigitalIn);
             PartitionPresentFeedback = new BoolFeedback("partitionPresent", () => !inputPort.DigitalIn);
 
             AddPostActivationAction(() =>

src/PepperDash.Essentials.Core/CrestronIO/IOPortConfig.cs

@@ -37,12 +37,5 @@ namespace PepperDash.Essentials.Core.CrestronIO
         /// </summary>
         [JsonProperty("minimumChange")]
         public int MinimumChange { get; set; }
-
-        /// <summary>
-        /// Gets or sets the circuit type: "NO" (Normally Open) or "NC" (Normally Closed)
-        /// If set to "NC", the input state will be inverted. Defaults to "NO" if not specified.
-        /// </summary>
-        [JsonProperty("circuitType")]
-        public string CircuitType { get; set; } = "NO";
     }
 }

src/PepperDash.Essentials.Core/Monitoring/StatusMonitorCollection.cs

@@ -14,7 +14,7 @@ using PepperDash.Core;
 namespace PepperDash.Essentials.Core
 {
 	/// <summary>
-	///
+	/// 
 	/// </summary>
 	public class StatusMonitorCollection : IStatusMonitor
 	{
@@ -59,61 +59,51 @@ namespace PepperDash.Essentials.Core
 
 		void ProcessStatuses()
 		{
-			var InError = Monitors.Where(m => m.Status == MonitorStatus.InError).ToList();
-			var InWarning = Monitors.Where(m => m.Status == MonitorStatus.InWarning).ToList();
-			var IsOk = Monitors.Where(m => m.Status == MonitorStatus.IsOk).ToList();
+			var InError = Monitors.Where(m => m.Status == MonitorStatus.InError);
+			var InWarning = Monitors.Where(m => m.Status == MonitorStatus.InWarning);
+			var IsOk = Monitors.Where(m => m.Status == MonitorStatus.IsOk);
 
 
 			MonitorStatus initialStatus;
 			string prefix = "0:";
-			if (InError.Any())
+			if (InError.Count() > 0)
 			{
 				initialStatus = MonitorStatus.InError;
 				prefix = "3:";
 			}
-			else if (InWarning.Any())
+			else if (InWarning.Count() > 0)
 			{
 				initialStatus = MonitorStatus.InWarning;
 				prefix = "2:";
 			}
-			else if (IsOk.Any())
+			else if (IsOk.Count() > 0)
 				initialStatus = MonitorStatus.IsOk;
 			else
 				initialStatus = MonitorStatus.StatusUnknown;
 
 			// Build the error message string
-			if (InError.Any() || InWarning.Any())
-			{
-				var errorNames = InError
-					.Select(mon => mon.Parent is IKeyName keyName ? keyName.Name : mon.Parent.Key)
-					.ToList();
-				var warningNames = InWarning
-					.Select(mon => mon.Parent is IKeyName keyName ? keyName.Name : mon.Parent.Key)
-					.ToList();
-
-				var sb = new StringBuilder(prefix);
-
-				if (errorNames.Count > 0)
-				{
-					sb.Append($"{errorNames.Count} Error{(errorNames.Count > 1 ? "s" : "")}: ");
-					sb.Append(string.Join(", ", errorNames));
-				}
-				if (warningNames.Count > 0)
-				{
-					if (errorNames.Count > 0)
-						sb.Append("; ");
-
-					sb.Append($"{warningNames.Count} Warning{(warningNames.Count > 1 ? "s" : "")}: ");
-					sb.Append(string.Join(", ", warningNames));
-				}
-
-                sb.Append(" Offline");
-				Message = sb.ToString();
-			}
-			else
-			{
-				Message = "Room Ok.";
-			}
+            if (InError.Count() > 0 || InWarning.Count() > 0)
+            {
+                StringBuilder sb = new StringBuilder(prefix);
+                if (InError.Count() > 0)
+                {
+                    // Do string splits and joins 
+                    sb.Append(string.Format("{0} Errors:", InError.Count()));
+                    foreach (var mon in InError)
+                        sb.Append(string.Format("{0}, ", mon.Parent.Key));
+                }
+                if (InWarning.Count() > 0)
+                {
+                    sb.Append(string.Format("{0} Warnings:", InWarning.Count()));
+                    foreach (var mon in InWarning)
+                        sb.Append(string.Format("{0}, ", mon.Parent.Key));
+                }
+                Message = sb.ToString();
+            }
+            else
+            {
+                Message = "Room Ok.";
+            }
 
 			// Want to fire even if status doesn't change because the message may.
 			Status = initialStatus;

src/PepperDash.Essentials.Devices.Common/Cameras/Interfaces/CameraSelectedEventArgs.cs

@@ -12,6 +12,7 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
     [Obsolete("Use CameraSelectedEventArgs<T> instead. This class will be removed in a future version")]
     public class CameraSelectedEventArgs : EventArgs
     {
+        /// <summary>
         /// Gets or sets the SelectedCamera
         /// </summary>
         public CameraBase SelectedCamera { get; private set; }

src/PepperDash.Essentials.Devices.Common/Displays/ScreenLiftController.cs

@@ -19,7 +19,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
     {
         None,
         Raise,
-        Lower,
+        Lower
     }
 
     /// <summary>
@@ -50,8 +50,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             get { return _isInUpPosition; }
             set
             {
-                if (value == _isInUpPosition)
-                    return;
+                if (value == _isInUpPosition) return;
                 _isInUpPosition = value;
                 IsInUpPosition.FireUpdate();
                 PositionChanged?.Invoke(this, new EventArgs());
@@ -88,11 +87,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
         /// <summary>
         /// Constructor for ScreenLiftController
         /// </summary>
-        public ScreenLiftController(
-            string key,
-            string name,
-            ScreenLiftControllerConfigProperties config
-        )
+        public ScreenLiftController(string key, string name, ScreenLiftControllerConfigProperties config)
             : base(key, name)
         {
             Config = config;
@@ -110,60 +105,27 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             switch (Mode)
             {
                 case eScreenLiftControlMode.momentary:
-                {
-                    RaiseRelayConfig = Config.Relays["raise"];
-                    LowerRelayConfig = Config.Relays["lower"];
-                    break;
-                }
+                    {
+                        RaiseRelayConfig = Config.Relays["raise"];
+                        LowerRelayConfig = Config.Relays["lower"];
+                        break;
+                    }
                 case eScreenLiftControlMode.latched:
-                {
-                    LatchedRelayConfig = Config.Relays["latched"];
-                    break;
-                }
+                    {
+                        LatchedRelayConfig = Config.Relays["latched"];
+                        break;
+                    }
             }
-
-            IsInUpPosition.OutputChange += (sender, args) =>
-            {
-                this.LogDebug(
-                    "ScreenLiftController '{name}' IsInUpPosition changed to {position}",
-                    Name,
-                    IsInUpPosition.BoolValue ? "Up" : "Down"
-                );
-
-                if (!Config.MuteOnScreenUp)
-                {
-                    return;
-                }
-
-                if (args.BoolValue)
-                {
-                    return;
-                }
-
-                if (DisplayDevice is IBasicVideoMuteWithFeedback videoMute)
-                {
-                    this.LogInformation("Unmuting video because screen is down");
-                    videoMute.VideoMuteOff();
-                }
-            };
-
-            IsInUpPosition.FireUpdate();
         }
 
         private void IsCoolingDownFeedback_OutputChange(object sender, FeedbackEventArgs e)
         {
-            if (
-                !DisplayDevice.IsCoolingDownFeedback.BoolValue
-                && Type == eScreenLiftControlType.lift
-            )
+            if (!DisplayDevice.IsCoolingDownFeedback.BoolValue && Type == eScreenLiftControlType.lift)
             {
                 Raise();
                 return;
             }
-            if (
-                DisplayDevice.IsCoolingDownFeedback.BoolValue
-                && Type == eScreenLiftControlType.screen
-            )
+            if (DisplayDevice.IsCoolingDownFeedback.BoolValue && Type == eScreenLiftControlType.screen)
             {
                 Raise();
                 return;
@@ -188,18 +150,18 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             switch (Mode)
             {
                 case eScreenLiftControlMode.momentary:
-                {
-                    this.LogDebug("Getting relays for {mode}", Mode);
-                    RaiseRelay = GetSwitchedOutputFromDevice(RaiseRelayConfig.DeviceKey);
-                    LowerRelay = GetSwitchedOutputFromDevice(LowerRelayConfig.DeviceKey);
-                    break;
-                }
+                    {
+                        this.LogDebug("Getting relays for {mode}", Mode);
+                        RaiseRelay = GetSwitchedOutputFromDevice(RaiseRelayConfig.DeviceKey);
+                        LowerRelay = GetSwitchedOutputFromDevice(LowerRelayConfig.DeviceKey);
+                        break;
+                    }
                 case eScreenLiftControlMode.latched:
-                {
-                    this.LogDebug("Getting relays for {mode}", Mode);
-                    LatchedRelay = GetSwitchedOutputFromDevice(LatchedRelayConfig.DeviceKey);
-                    break;
-                }
+                    {
+                        this.LogDebug("Getting relays for {mode}", Mode);
+                        LatchedRelay = GetSwitchedOutputFromDevice(LatchedRelayConfig.DeviceKey);
+                        break;
+                    }
             }
 
             this.LogDebug("Getting display with key {displayKey}", DisplayDeviceKey);
@@ -210,8 +172,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
                 this.LogDebug("Subscribing to {displayKey} feedbacks", DisplayDeviceKey);
 
                 DisplayDevice.IsWarmingUpFeedback.OutputChange += IsWarmingUpFeedback_OutputChange;
-                DisplayDevice.IsCoolingDownFeedback.OutputChange +=
-                    IsCoolingDownFeedback_OutputChange;
+                DisplayDevice.IsCoolingDownFeedback.OutputChange += IsCoolingDownFeedback_OutputChange;
             }
 
             return base.CustomActivate();
@@ -222,17 +183,10 @@ namespace PepperDash.Essentials.Devices.Common.Shades
         /// </summary>
         public void Raise()
         {
-            if (RaiseRelay == null && LatchedRelay == null)
-                return;
+            if (RaiseRelay == null && LatchedRelay == null) return;
 
             this.LogDebug("Raise called for {type}", Type);
 
-            if (Config.MuteOnScreenUp && DisplayDevice is IBasicVideoMuteWithFeedback videoMute)
-            {
-                this.LogInformation("Muting video because screen is going up");
-                videoMute.VideoMuteOn();
-            }
-
             // If device is moving, bank the command
             if (_isMoving)
             {
@@ -246,33 +200,33 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             switch (Mode)
             {
                 case eScreenLiftControlMode.momentary:
-                {
-                    PulseOutput(RaiseRelay, RaiseRelayConfig.PulseTimeInMs);
+                    {
+                        PulseOutput(RaiseRelay, RaiseRelayConfig.PulseTimeInMs);
 
-                    // Set moving flag and start timer if movement time is configured
-                    if (RaiseRelayConfig.MoveTimeInMs > 0)
-                    {
-                        _isMoving = true;
-                        _currentMovement = RequestedState.Raise;
-                        if (_movementTimer.Enabled)
+                        // Set moving flag and start timer if movement time is configured
+                        if (RaiseRelayConfig.MoveTimeInMs > 0)
                         {
-                            _movementTimer.Stop();
+                            _isMoving = true;
+                            _currentMovement = RequestedState.Raise;
+                            if (_movementTimer.Enabled)
+                            {
+                                _movementTimer.Stop();
+                            }
+                            _movementTimer.Interval = RaiseRelayConfig.MoveTimeInMs;
+                            _movementTimer.Start();
                         }
-                        _movementTimer.Interval = RaiseRelayConfig.MoveTimeInMs;
-                        _movementTimer.Start();
+                        else
+                        {
+                            InUpPosition = true;
+                        }
+                        break;
                     }
-                    else
-                    {
-                        InUpPosition = true;
-                    }
-                    break;
-                }
                 case eScreenLiftControlMode.latched:
-                {
-                    LatchedRelay.Off();
-                    InUpPosition = true;
-                    break;
-                }
+                    {
+                        LatchedRelay.Off();
+                        InUpPosition = true;
+                        break;
+                    }
             }
         }
 
@@ -281,8 +235,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
         /// </summary>
         public void Lower()
         {
-            if (LowerRelay == null && LatchedRelay == null)
-                return;
+            if (LowerRelay == null && LatchedRelay == null) return;
 
             this.LogDebug("Lower called for {type}", Type);
 
@@ -299,33 +252,33 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             switch (Mode)
             {
                 case eScreenLiftControlMode.momentary:
-                {
-                    PulseOutput(LowerRelay, LowerRelayConfig.PulseTimeInMs);
+                    {
+                        PulseOutput(LowerRelay, LowerRelayConfig.PulseTimeInMs);
 
-                    // Set moving flag and start timer if movement time is configured
-                    if (LowerRelayConfig.MoveTimeInMs > 0)
-                    {
-                        _isMoving = true;
-                        _currentMovement = RequestedState.Lower;
-                        if (_movementTimer.Enabled)
+                        // Set moving flag and start timer if movement time is configured
+                        if (LowerRelayConfig.MoveTimeInMs > 0)
                         {
-                            _movementTimer.Stop();
+                            _isMoving = true;
+                            _currentMovement = RequestedState.Lower;
+                            if (_movementTimer.Enabled)
+                            {
+                                _movementTimer.Stop();
+                            }
+                            _movementTimer.Interval = LowerRelayConfig.MoveTimeInMs;
+                            _movementTimer.Start();
                         }
-                        _movementTimer.Interval = LowerRelayConfig.MoveTimeInMs;
-                        _movementTimer.Start();
+                        else
+                        {
+                            InUpPosition = false;
+                        }
+                        break;
                     }
-                    else
-                    {
-                        InUpPosition = false;
-                    }
-                    break;
-                }
                 case eScreenLiftControlMode.latched:
-                {
-                    LatchedRelay.On();
-                    InUpPosition = false;
-                    break;
-                }
+                    {
+                        LatchedRelay.On();
+                        InUpPosition = false;
+                        break;
+                    }
             }
         }
 
@@ -386,13 +339,16 @@ namespace PepperDash.Essentials.Devices.Common.Shades
         {
             output.On();
 
-            var timer = new Timer(pulseTime) { AutoReset = false };
+            var timer = new Timer(pulseTime)
+            {
+                AutoReset = false
+            };
 
             timer.Elapsed += (sender, e) =>
-            {
-                output.Off();
-                timer.Dispose();
-            };
+                  {
+                      output.Off();
+                      timer.Dispose();
+                  };
             timer.Start();
         }
 
@@ -405,10 +361,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             }
             else
             {
-                this.LogWarning(
-                    "Error: Unable to get relay device with key '{relayKey}'",
-                    relayKey
-                );
+                this.LogWarning("Error: Unable to get relay device with key '{relayKey}'", relayKey);
                 return null;
             }
         }
@@ -422,13 +375,11 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             }
             else
             {
-                this.LogWarning(
-                    "Error: Unable to get display device with key '{displayKey}'",
-                    displayKey
-                );
+                this.LogWarning("Error: Unable to get display device with key '{displayKey}'", displayKey);
                 return null;
             }
         }
+
     }
 
     /// <summary>
@@ -436,7 +387,7 @@ namespace PepperDash.Essentials.Devices.Common.Shades
     /// </summary>
     public class ScreenLiftControllerFactory : EssentialsDeviceFactory<RelayControlledShade>
     {
-        /// <summary>
+        /// <summary> 
         /// Constructor for ScreenLiftControllerFactory
         /// </summary>
         public ScreenLiftControllerFactory()
@@ -453,4 +404,4 @@ namespace PepperDash.Essentials.Devices.Common.Shades
             return new ScreenLiftController(dc.Key, dc.Name, props);
         }
     }
-}
+}

src/PepperDash.Essentials.Devices.Common/Displays/ScreenLiftControllerConfigProperties.cs

@@ -5,41 +5,37 @@ using PepperDash.Essentials.Core.DeviceTypeInterfaces;
 
 namespace PepperDash.Essentials.Devices.Common.Shades
 {
+  /// <summary>
+  /// Represents a ScreenLiftControllerConfigProperties
+  /// </summary>
+  public class ScreenLiftControllerConfigProperties
+  {
+
     /// <summary>
-    /// Represents a ScreenLiftControllerConfigProperties
+    /// Gets or sets the DisplayDeviceKey
     /// </summary>
-    public class ScreenLiftControllerConfigProperties
-    {
-        /// <summary>
-        /// Gets or sets the DisplayDeviceKey
-        /// </summary>
-        [JsonProperty("displayDeviceKey")]
-        public string DisplayDeviceKey { get; set; }
+    [JsonProperty("displayDeviceKey")]
+    public string DisplayDeviceKey { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Type
-        /// </summary>
-        [JsonProperty("type")]
-        [JsonConverter(typeof(StringEnumConverter))]
-        public eScreenLiftControlType Type { get; set; }
+    /// <summary>
+    /// Gets or sets the Type
+    /// </summary>
+    [JsonProperty("type")]
+    [JsonConverter(typeof(StringEnumConverter))]
+    public eScreenLiftControlType Type { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Mode
-        /// </summary>
-        [JsonProperty("mode")]
-        [JsonConverter(typeof(StringEnumConverter))]
-        public eScreenLiftControlMode Mode { get; set; }
+    /// <summary>
+    /// Gets or sets the Mode
+    /// </summary>
+    [JsonProperty("mode")]
+    [JsonConverter(typeof(StringEnumConverter))]
+    public eScreenLiftControlMode Mode { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Relays
-        /// </summary>
-        [JsonProperty("relays")]
-        public Dictionary<string, ScreenLiftRelaysConfig> Relays { get; set; }
+    /// <summary>
+    /// Gets or sets the Relays
+    /// </summary>
+    [JsonProperty("relays")]
+    public Dictionary<string, ScreenLiftRelaysConfig> Relays { get; set; }
 
-        /// <summary>
-        /// Mutes the display when the screen is in the up position
-        /// </summary>
-        [JsonProperty("muteOnScreenUp")]
-        public bool MuteOnScreenUp { get; set; }
-    }
-}
+  }
+}