docs: XML comments for Devices.Common

src/PepperDash.Essentials.Devices.Common/Cameras/CameraBase.cs

@@ -3,20 +3,14 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Text.RegularExpressions;
-using Crestron.SimplSharp;
-using System.Reflection;
 using Crestron.SimplSharpPro.DeviceSupport;
+using Newtonsoft.Json;
 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.Config;
+using PepperDash.Essentials.Core.Devices;
 using PepperDash.Essentials.Core.Presets;
-using PepperDash.Essentials.Devices.Common.Codec;
-
-using Newtonsoft.Json;
 using Serilog.Events;
 
 namespace PepperDash.Essentials.Devices.Common.Cameras
@@ -26,31 +20,52 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
     /// </summary>
     public enum eCameraCapabilities
     {
+        /// <summary>
+        /// No camera capabilities
+        /// </summary>
         None = 0,
+        /// <summary>
+        /// Camera supports pan movement
+        /// </summary>
         Pan = 1,
-        Tilt = 2, 
+        /// <summary>
+        /// Camera supports tilt movement
+        /// </summary>
+        Tilt = 2,
+        /// <summary>
+        /// Camera supports zoom functionality
+        /// </summary>
         Zoom = 4,
+        /// <summary>
+        /// Camera supports focus adjustment
+        /// </summary>
         Focus = 8
     }
 
+    /// <summary>
+    /// Abstract base class for camera devices that provides common camera functionality and capabilities
+    /// </summary>
     public abstract class CameraBase : ReconfigurableDevice, IRoutingOutputs
-	{
-        [JsonProperty("controlMode", NullValueHandling = NullValueHandling.Ignore)]
+    {
         /// <summary>
         /// Gets or sets the ControlMode
         /// </summary>
+        [JsonProperty("controlMode", NullValueHandling = NullValueHandling.Ignore)]
         public eCameraControlMode ControlMode { get; protected set; }
 
         #region IRoutingOutputs Members
 
-        [JsonIgnore]
         /// <summary>
         /// Gets or sets the OutputPorts
         /// </summary>
+        [JsonIgnore]
         public RoutingPortCollection<RoutingOutputPort> OutputPorts { get; protected set; }
 
         #endregion
 
+        /// <summary>
+        /// Gets a value indicating whether this camera supports pan movement
+        /// </summary>
         [JsonProperty("canPan", NullValueHandling = NullValueHandling.Ignore)]
         public bool CanPan
         {
@@ -59,6 +74,10 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
                 return (Capabilities & eCameraCapabilities.Pan) == eCameraCapabilities.Pan;
             }
         }
+
+        /// <summary>
+        /// Gets a value indicating whether this camera supports tilt movement
+        /// </summary>
         [JsonProperty("canTilt", NullValueHandling = NullValueHandling.Ignore)]
         public bool CanTilt
         {
@@ -67,6 +86,10 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
                 return (Capabilities & eCameraCapabilities.Tilt) == eCameraCapabilities.Tilt;
             }
         }
+
+        /// <summary>
+        /// Gets a value indicating whether this camera supports zoom functionality
+        /// </summary>
         [JsonProperty("canZoom", NullValueHandling = NullValueHandling.Ignore)]
         public bool CanZoom
         {
@@ -75,6 +98,10 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
                 return (Capabilities & eCameraCapabilities.Zoom) == eCameraCapabilities.Zoom;
             }
         }
+
+        /// <summary>
+        /// Gets a value indicating whether this camera supports focus adjustment
+        /// </summary>
         [JsonProperty("canFocus", NullValueHandling = NullValueHandling.Ignore)]
         public bool CanFocus
         {
@@ -84,23 +111,42 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
             }
         }
 
-        // A bitmasked value to indicate the movement capabilites of this camera
+        /// <summary>
+        /// Gets or sets a bitmasked value to indicate the movement capabilities of this camera
+        /// </summary>
         protected eCameraCapabilities Capabilities { get; set; }
 
-		protected CameraBase(DeviceConfig config) : base(config)
-		{
-			OutputPorts = new RoutingPortCollection<RoutingOutputPort>();
-
-			ControlMode = eCameraControlMode.Manual;
-
-		}
-
-        protected CameraBase(string key, string name) : 
-			this (new DeviceConfig{Name = name, Key = key})
+        /// <summary>
+        /// Initializes a new instance of the CameraBase class with the specified device configuration
+        /// </summary>
+        /// <param name="config">The device configuration</param>
+        protected CameraBase(DeviceConfig config) : base(config)
         {
-				
+            OutputPorts = new RoutingPortCollection<RoutingOutputPort>();
+
+            ControlMode = eCameraControlMode.Manual;
+
         }
 
+        /// <summary>
+        /// Initializes a new instance of the CameraBase class with the specified key and name
+        /// </summary>
+        /// <param name="key">The unique key for this camera device</param>
+        /// <param name="name">The friendly name for this camera device</param>
+        protected CameraBase(string key, string name) :
+            this(new DeviceConfig { Name = name, Key = key })
+        {
+
+        }
+
+        /// <summary>
+        /// Links the camera device to the API bridge for control and feedback
+        /// </summary>
+        /// <param name="cameraDevice">The camera device to link</param>
+        /// <param name="trilist">The trilist for communication</param>
+        /// <param name="joinStart">The starting join number for the camera controls</param>
+        /// <param name="joinMapKey">The join map key for custom join mappings</param>
+        /// <param name="bridge">The EiscApiAdvanced bridge for advanced join mapping</param>
         protected void LinkCameraToApi(CameraBase cameraDevice, BasicTriList trilist, uint joinStart, string joinMapKey,
             EiscApiAdvanced bridge)
         {
@@ -240,13 +286,13 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
                 {
                     int tempNum = i;
 
-                    trilist.SetSigTrueAction((ushort) (joinMap.PresetRecallStart.JoinNumber + tempNum), () =>
+                    trilist.SetSigTrueAction((ushort)(joinMap.PresetRecallStart.JoinNumber + tempNum), () =>
                     {
                         presetsCamera.PresetSelect(tempNum);
                     });
-                    trilist.SetSigTrueAction((ushort) (joinMap.PresetSaveStart.JoinNumber + tempNum), () =>
+                    trilist.SetSigTrueAction((ushort)(joinMap.PresetSaveStart.JoinNumber + tempNum), () =>
                     {
-                        var label = trilist.GetString((ushort) (joinMap.PresetLabelStart.JoinNumber + tempNum));
+                        var label = trilist.GetString((ushort)(joinMap.PresetLabelStart.JoinNumber + tempNum));
 
                         presetsCamera.PresetStore(tempNum, label);
                     });
@@ -277,7 +323,7 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
                 trilist.SetString((ushort)(joinMap.PresetLabelStart.JoinNumber + tempNum), label);
             }
         }
-	}
+    }
 
 
     /// <summary>
@@ -285,6 +331,13 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
     /// </summary>
     public class CameraPreset : PresetBase
     {
+        /// <summary>
+        /// Initializes a new instance of the CameraPreset class
+        /// </summary>
+        /// <param name="id">The preset ID</param>
+        /// <param name="description">The preset description</param>
+        /// <param name="isDefined">Whether the preset is defined</param>
+        /// <param name="isDefinable">Whether the preset can be defined</param>
         public CameraPreset(int id, string description, bool isDefined, bool isDefinable)
             : base(id, description, isDefined, isDefinable)
         {
@@ -293,37 +346,37 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
     }
 
 
- /// <summary>
- /// Represents a CameraPropertiesConfig
- /// </summary>
-	public class CameraPropertiesConfig
-	{
-  /// <summary>
-  /// Gets or sets the CommunicationMonitorProperties
-  /// </summary>
-		public CommunicationMonitorConfig CommunicationMonitorProperties { get; set; }
+    /// <summary>
+    /// Represents a CameraPropertiesConfig
+    /// </summary>
+    public class CameraPropertiesConfig
+    {
+        /// <summary>
+        /// Gets or sets the CommunicationMonitorProperties
+        /// </summary>
+        public CommunicationMonitorConfig CommunicationMonitorProperties { get; set; }
 
-  /// <summary>
-  /// Gets or sets the Control
-  /// </summary>
-		public ControlPropertiesConfig Control { get; set; }
+        /// <summary>
+        /// Gets or sets the Control
+        /// </summary>
+        public ControlPropertiesConfig Control { get; set; }
 
-        [JsonProperty("supportsAutoMode")]
         /// <summary>
         /// Gets or sets the SupportsAutoMode
         /// </summary>
+        [JsonProperty("supportsAutoMode")]
         public bool SupportsAutoMode { get; set; }
 
-        [JsonProperty("supportsOffMode")]
         /// <summary>
         /// Gets or sets the SupportsOffMode
         /// </summary>
+        [JsonProperty("supportsOffMode")]
         public bool SupportsOffMode { get; set; }
 
-        [JsonProperty("presets")]
         /// <summary>
         /// Gets or sets the Presets
         /// </summary>
+        [JsonProperty("presets")]
         public List<CameraPreset> Presets { get; set; }
-	}
+    }
 }