build(force-patch): add props to package with Essentials version

.gitignore

@@ -393,6 +393,4 @@ essentials-framework/Essentials Interfaces/PepperDash_Essentials_Interfaces/Pepp
 /._PepperDash.Essentials.sln
 .vscode/settings.json
 _site/
-api/
+api/
-*.DS_Store
-/._PepperDash.Essentials.4Series.sln

.vscode/extensions.json

@@ -1,9 +0,0 @@
-{
-  "recommendations": [
-    "ms-dotnettools.vscode-dotnet-runtime",
-    "ms-dotnettools.csharp",
-    "ms-dotnettools.csdevkit",
-    "vivaxy.vscode-conventional-commits",
-    "mhutchie.git-graph"
-  ]
-}

Crestron-Library-Usage-Analysis.md

@@ -1,282 +0,0 @@
-# Crestron Library Usage Analysis - PepperDash Essentials
-
-This document provides a comprehensive analysis of Crestron classes and interfaces used throughout the PepperDash Essentials framework, organized by namespace and library component.
-
-## Executive Summary
-
-The PepperDash Essentials framework extensively leverages Crestron SDK components across 100+ files, providing abstractions for:
-- Control system hardware (processors, touchpanels, IO devices)
-- Communication interfaces (Serial, TCP/IP, SSH, CEC, IR)
-- Device management and routing
-- User interface components and smart objects
-- System monitoring and diagnostics
-
-## 1. Core Crestron Libraries
-
-### 1.1 Crestron.SimplSharp
-
-**Primary Usage**: Foundational framework components, collections, and basic types.
-
-**Key Files**:
-- Multiple files across all projects use `Crestron.SimplSharp` namespaces
-- Provides basic C# runtime support for Crestron processors
-
-### 1.2 Crestron.SimplSharpPro
-
-**Primary Usage**: Main hardware abstraction layer for Crestron devices.
-
-**Key Classes Used**:
-
-#### CrestronControlSystem
-- **File**: `/src/PepperDash.Essentials/ControlSystem.cs`
-- **Usage**: Base class for the main control system implementation
-- **Implementation**: `public class ControlSystem : CrestronControlSystem, ILoadConfig`
-
-#### Device (Base Class)
-- **Files**: 50+ files inherit from or use this class
-- **Key Implementations**:
-  - `/src/PepperDash.Core/Device.cs` - Core device abstraction
-  - `/src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs` - Extended device base
-  - `/src/PepperDash.Essentials.Core/Room/Room.cs` - Room device implementation
-  - `/src/PepperDash.Essentials.Core/Devices/CrestronProcessor.cs` - Processor device wrapper
-
-#### BasicTriList
-- **Files**: 30+ files use this class extensively
-- **Primary Usage**: Touchpanel communication and SIMPL bridging
-- **Key Files**:
-  - `/src/PepperDash.Essentials.Core/Touchpanels/TriListExtensions.cs` - Extension methods for signal handling
-  - `/src/PepperDash.Essentials.Core/Devices/EssentialsBridgeableDevice.cs` - Bridge interface
-  - `/src/PepperDash.Essentials.Core/Touchpanels/ModalDialog.cs` - UI dialog implementation
-
-#### BasicTriListWithSmartObject
-- **Files**: Multiple touchpanel and UI files
-- **Usage**: Enhanced touchpanel support with smart object integration
-- **Key Files**:
-  - `/src/PepperDash.Essentials.Core/Touchpanels/Interfaces.cs` - Interface definitions
-  - `/src/PepperDash.Essentials.Core/SmartObjects/SubpageReferenceList/SubpageReferenceList.cs`
-
-## 2. Communication Hardware
-
-### 2.1 Serial Communication (ComPort)
-
-**Primary Class**: `ComPort`
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/Comm and IR/ComPortController.cs`
-- `/src/PepperDash.Essentials.Core/Comm and IR/CommFactory.cs`
-
-**Usage Pattern**:
-```csharp
-public class ComPortController : Device, IBasicCommunicationWithStreamDebugging
-public static ComPort GetComPort(EssentialsControlPropertiesConfig config)
-```
-
-**Interface Support**: `IComPorts` - Used for devices that provide multiple COM ports
-
-### 2.2 IR Communication (IROutputPort)
-
-**Primary Class**: `IROutputPort`
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/Devices/IrOutputPortController.cs`
-- `/src/PepperDash.Essentials.Core/Devices/GenericIRController.cs`
-- `/src/PepperDash.Essentials.Core/Comm and IR/IRPortHelper.cs`
-
-**Usage Pattern**:
-```csharp
-public class IrOutputPortController : Device
-IROutputPort IrPort;
-public IrOutputPortController(string key, IROutputPort port, string irDriverFilepath)
-```
-
-### 2.3 CEC Communication (ICec)
-
-**Primary Interface**: `ICec`
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/Comm and IR/CecPortController.cs`
-- `/src/PepperDash.Essentials.Core/Comm and IR/CommFactory.cs`
-
-**Usage Pattern**:
-```csharp
-public class CecPortController : Device, IBasicCommunicationWithStreamDebugging
-public static ICec GetCecPort(ControlPropertiesConfig config)
-```
-
-## 3. Input/Output Hardware
-
-### 3.1 Digital Input
-
-**Primary Interface**: `IDigitalInput`
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/CrestronIO/GenericDigitalInputDevice.cs`
-- `/src/PepperDash.Essentials.Core/Microphone Privacy/MicrophonePrivacyController.cs`
-
-**Usage Pattern**:
-```csharp
-public List<IDigitalInput> Inputs { get; private set; }
-void AddInput(IDigitalInput input)
-```
-
-### 3.2 Versiport Support
-
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportInputDevice.cs`
-- `/src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportAnalogInputDevice.cs`
-- `/src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportOutputDevice.cs`
-
-**Usage**: Provides flexible I/O port configuration for various signal types
-
-## 4. Touchpanel Hardware
-
-### 4.1 MPC3 Touchpanel
-
-**Primary Class**: `MPC3Basic`
-**Key File**: `/src/PepperDash.Essentials.Core/Touchpanels/Mpc3Touchpanel.cs`
-
-**Usage Pattern**:
-```csharp
-public class Mpc3TouchpanelController : Device
-readonly MPC3Basic _touchpanel;
-_touchpanel = processor.ControllerTouchScreenSlotDevice as MPC3Basic;
-```
-
-### 4.2 TSW Series Support
-
-**Evidence**: References found in messenger files and mobile control components
-**Usage**: Integrated through mobile control messaging system for TSW touchpanel features
-
-## 5. Timer and Threading
-
-### 5.1 CTimer
-
-**Primary Class**: `CTimer`
-**Key File**: `/src/PepperDash.Core/PasswordManagement/PasswordManager.cs`
-
-**Usage Pattern**:
-```csharp
-Debug.Console(1, string.Format("PasswordManager.UpdatePassword: CTimer Started"));
-Debug.Console(1, string.Format("PasswordManager.UpdatePassword: CTimer Reset"));
-```
-
-## 6. Networking and Communication
-
-### 6.1 Ethernet Communication
-
-**Libraries Used**:
-- `Crestron.SimplSharpPro.EthernetCommunication`
-- `Crestron.SimplSharp.Net.Utilities.EthernetHelper`
-
-**Key Files**:
-- `/src/PepperDash.Core/Comm/GenericTcpIpClient.cs`
-- `/src/PepperDash.Core/Comm/GenericTcpIpServer.cs`
-- `/src/PepperDash.Core/Comm/GenericSecureTcpIpClient.cs`
-- `/src/PepperDash.Core/Comm/GenericSshClient.cs`
-- `/src/PepperDash.Core/Comm/GenericUdpServer.cs`
-
-**Usage Pattern**:
-```csharp
-public class GenericTcpIpClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect
-public class GenericSecureTcpIpClient : Device, ISocketStatusWithStreamDebugging, IAutoReconnect
-```
-
-## 7. Device Management Libraries
-
-### 7.1 DeviceSupport
-
-**Library**: `Crestron.SimplSharpPro.DeviceSupport`
-**Usage**: Core device support infrastructure used throughout the framework
-
-### 7.2 DM (DigitalMedia)
-
-**Library**: `Crestron.SimplSharpPro.DM`
-**Usage**: Digital media routing and switching support
-**Evidence**: Found in routing configuration and DM output card references
-
-## 8. User Interface Libraries
-
-### 8.1 UI Components
-
-**Library**: `Crestron.SimplSharpPro.UI`
-**Usage**: User interface elements and touchpanel controls
-
-### 8.2 Smart Objects
-
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/SmartObjects/SmartObjectDynamicList.cs`
-- `/src/PepperDash.Essentials.Core/SmartObjects/SubpageReferenceList/SubpageReferenceList.cs`
-
-**Usage**: Advanced UI components with dynamic content
-
-## 9. System Monitoring and Diagnostics
-
-### 9.1 Diagnostics
-
-**Library**: `Crestron.SimplSharpPro.Diagnostics`
-**Usage**: System health monitoring and performance tracking
-
-### 9.2 System Information
-
-**Key Files**:
-- `/src/PepperDash.Essentials.Core/Monitoring/SystemMonitorController.cs`
-
-**Usage**: Provides system status, Ethernet information, and program details
-
-## 10. Integration Patterns
-
-### 10.1 SIMPL Bridging
-
-**Pattern**: Extensive use of `BasicTriList` for SIMPL integration
-**Files**: Bridge classes throughout the framework implement `LinkToApi` methods:
-```csharp
-public abstract void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge);
-```
-
-### 10.2 Device Factory Pattern
-
-**Implementation**: Factory classes create hardware-specific implementations
-**Example**: `CommFactory.cs` provides communication device creation
-
-### 10.3 Extension Methods
-
-**Pattern**: Extensive use of extension methods for Crestron classes
-**Example**: `TriListExtensions.cs` adds 30+ extension methods to `BasicTriList`
-
-## 11. Signal Processing
-
-### 11.1 Signal Types
-
-**Bool Signals**: Digital control and feedback
-**UShort Signals**: Analog values and numeric data
-**String Signals**: Text and configuration data
-
-**Implementation**: Comprehensive signal handling in `TriListExtensions.cs`
-
-## 12. Error Handling and Logging
-
-**Pattern**: Consistent use of Crestron's Debug logging throughout
-**Examples**:
-```csharp
-Debug.LogMessage(LogEventLevel.Information, "Device {0} is not a valid device", dc.PortDeviceKey);
-Debug.LogMessage(LogEventLevel.Debug, "Error Waking Panel. Maybe testing with Xpanel?");
-```
-
-## 13. Threading and Synchronization
-
-**Components**:
-- CTimer for time-based operations
-- Thread-safe collections and patterns
-- Event-driven programming models
-
-## Conclusion
-
-The PepperDash Essentials framework demonstrates sophisticated integration with the Crestron ecosystem, leveraging:
-
-- **Core Infrastructure**: CrestronControlSystem, Device base classes
-- **Communication**: COM, IR, CEC, TCP/IP, SSH protocols
-- **Hardware Abstraction**: Touchpanels, I/O devices, processors
-- **User Interface**: Smart objects, signal processing, SIMPL bridging
-- **System Services**: Monitoring, diagnostics, device management
-
-This analysis shows that Essentials serves as a comprehensive middleware layer, abstracting Crestron hardware complexities while providing modern software development patterns and practices.
-
----
-*Generated: [Current Date]*
-*Framework Version: PepperDash Essentials (Based on codebase analysis)*

src/Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <Version>2.15.1-local</Version>
+    <Version>2.4.0-local</Version>    
     <InformationalVersion>$(Version)</InformationalVersion>
     <Authors>PepperDash Technology</Authors>
     <Company>PepperDash Technology</Company>
@@ -19,5 +19,6 @@
   <ItemGroup>
     <None Include="..\..\LICENSE.md" Pack="true" PackagePath=""/>
     <None Include="..\..\README.md" Pack="true" PackagePath=""/>
+    <None Include=".\build\**" Pack="true" PackagePath="build"/>
   </ItemGroup>
 </Project>

src/Directory.Build.targets

@@ -23,32 +23,23 @@
     <FileName>$(TargetDir)$(TargetName).$(Version).$(TargetFramework).cpz</FileName>
   </PropertyGroup>
 
-  <Target Name="DeleteCLZ" BeforeTargets="CoreBuild" Condition="$(ProjectType) == 'Library' And $(TargetDir) != ''">
+  <Target Name="DeleteCLZ" BeforeTargets="PreBuildEvent" Condition="$(ProjectType) == 'Library' And $(TargetDir) != '' And Exists($(FileName))">
-    <ItemGroup>
+    <Delete Files="$(TargetDir)$(TargetName).$(Version).$(TargetFramework).clz">
-      <OldCLZFiles Include="$(TargetDir)$(TargetName).*.$(TargetFramework).clz" />
-    </ItemGroup>
-    <Delete Files="@(OldCLZFiles)" Condition="@(OldCLZFiles) != ''">
       <Output TaskParameter="DeletedFiles" ItemName="DeletedList"/>
     </Delete>
-    <Message Text="Deleted old CLZ files: '@(DeletedList)'" Condition="@(DeletedList) != ''" />
+    <Message Text="Deleted files: '@(DeletedList)'" />
   </Target>
-  <Target Name="DeleteCPZ" BeforeTargets="CoreBuild" Condition="$(ProjectType) == 'Program' And $(TargetDir) != ''">
+  <Target Name="DeleteCPZ" BeforeTargets="PreBuildEvent" Condition="$(ProjectType) == 'Program' And $(TargetDir) != '' And Exists($(FileName))">
-    <ItemGroup>
+    <Delete Files="$(TargetDir)$(TargetName).$(Version).$(TargetFramework).cpz">
-      <OldCPZFiles Include="$(TargetDir)$(TargetName).*.$(TargetFramework).cpz" />
-    </ItemGroup>
-    <Delete Files="@(OldCPZFiles)" Condition="@(OldCPZFiles) != ''">
       <Output TaskParameter="DeletedFiles" ItemName="DeletedList"/>
     </Delete>
-    <Message Text="Deleted old CPZ files: '@(DeletedList)'" Condition="@(DeletedList) != ''" />
+    <Message Text="Deleted files: '@(DeletedList)'" />
   </Target>
-  <Target Name="DeleteCPLZ" BeforeTargets="CoreBuild" Condition="$(ProjectType) == 'ProgramLibrary' And $(TargetDir) != ''">
+  <Target Name="DeleteCPLZ" BeforeTargets="PreBuildEvent" Condition="$(ProjectType) == 'ProgramLibrary' And $(TargetDir) != '' And Exists($(FileName))">
-    <ItemGroup>
+    <Delete Files="$(TargetDir)$(TargetName).$(Version).$(TargetFramework).cplz">
-      <OldCPLZFiles Include="$(TargetDir)$(TargetName).*.$(TargetFramework).cplz" />
-    </ItemGroup>
-    <Delete Files="@(OldCPLZFiles)" Condition="@(OldCPLZFiles) != ''">
       <Output TaskParameter="DeletedFiles" ItemName="DeletedList"/>
     </Delete>
-    <Message Text="Deleted old CPLZ files: '@(DeletedList)'" Condition="@(DeletedList) != ''" />
+    <Message Text="Deleted files: '@(DeletedList)'" />
   </Target>
   
   <Target Name="CreateCPLZ" AfterTargets="Build" Condition="$(ProjectType) == 'ProgramLibrary' And $(TargetDir) != ''" DependsOnTargets="DeleteCPLZ">

src/PepperDash.Core/Comm/CommunicationGather.cs

@@ -84,9 +84,10 @@ namespace PepperDash.Core
             port.TextReceived += Port_TextReceivedStringDelimiter;
         }
 
-  /// <summary>
+		/// <summary>
-  /// Stop method
+		/// Disconnects this gather from the Port's TextReceived event. This will not fire LineReceived
-  /// </summary>
+		/// after the this call.
+		/// </summary>
 		public void Stop()
 		{
 			Port.TextReceived -= Port_TextReceived;

src/PepperDash.Core/Comm/CommunicationStreamDebugging.cs

@@ -23,7 +23,7 @@ namespace PepperDash.Core
         private CTimer DebugExpiryPeriod;
 
         /// <summary>
-        /// Gets or sets the DebugSetting
+        /// The current debug setting
         /// </summary>
         public eStreamDebuggingSetting DebugSetting { get; private set; }
 
@@ -42,7 +42,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the RxStreamDebuggingIsEnabled
+        /// Indicates that receive stream debugging is enabled
         /// </summary>
         public bool RxStreamDebuggingIsEnabled{ get; private set; }
 
@@ -65,9 +65,6 @@ namespace PepperDash.Core
         /// Sets the debugging setting and if not setting to off, assumes the default of 30 mintues
         /// </summary>
         /// <param name="setting"></param>
-        /// <summary>
-        /// SetDebuggingWithDefaultTimeout method
-        /// </summary>
         public void SetDebuggingWithDefaultTimeout(eStreamDebuggingSetting setting)
         {
             if (setting == eStreamDebuggingSetting.Off)
@@ -84,9 +81,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="setting"></param>
         /// <param name="minutes"></param>
-        /// <summary>
-        /// SetDebuggingWithSpecificTimeout method
-        /// </summary>
         public void SetDebuggingWithSpecificTimeout(eStreamDebuggingSetting setting, uint minutes)
         {
             if (setting == eStreamDebuggingSetting.Off)
@@ -141,9 +135,6 @@ namespace PepperDash.Core
     /// The available settings for stream debugging
     /// </summary>
     [Flags]
-    /// <summary>
-    /// Enumeration of eStreamDebuggingSetting values
-    /// </summary>
     public enum eStreamDebuggingSetting
     {
         /// <summary>

src/PepperDash.Core/Comm/ControlPropertiesConfig.cs

@@ -6,7 +6,7 @@ using Newtonsoft.Json.Converters;
 namespace PepperDash.Core
 {
     /// <summary>
-    /// Represents a ControlPropertiesConfig
+    /// Config properties that indicate how to communicate with a device for control
     /// </summary>
     public class ControlPropertiesConfig
     {

src/PepperDash.Core/Comm/EventArgs.cs

@@ -29,9 +29,9 @@ namespace PepperDash.Core
     /// </summary>
 	public class GenericSocketStatusChageEventArgs : EventArgs
 	{
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the Client
+        /// 
-  /// </summary>
+        /// </summary>
 		public ISocketStatus Client { get; private set; }
 
         /// <summary>
@@ -60,7 +60,7 @@ namespace PepperDash.Core
     public class GenericTcpServerStateChangedEventArgs : EventArgs
     {
         /// <summary>
-        /// Gets or sets the State
+        /// 
         /// </summary>
         public ServerState State { get; private set; }
 
@@ -154,7 +154,7 @@ namespace PepperDash.Core
 		}
 
         /// <summary>
-        /// Gets or sets the Text
+        /// 
         /// </summary>
         public string Text { get; private set; }
 

src/PepperDash.Core/Comm/GenericSecureTcpIpClient.cs

@@ -79,7 +79,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the Port
+        /// Port on server
         /// </summary>
         public int Port { get; set; }
 
@@ -149,7 +149,7 @@ namespace PepperDash.Core
         public string ConnectionFailure { get { return ClientStatus.ToString(); } }
 
         /// <summary>
-        /// Gets or sets the AutoReconnect
+        /// bool to track if auto reconnect should be set on the socket
         /// </summary>
         public bool AutoReconnect { get; set; }
 
@@ -188,7 +188,7 @@ namespace PepperDash.Core
         #region GenericSecureTcpIpClient properties
 
         /// <summary>
-        /// Gets or sets the SharedKeyRequired
+        /// Bool to show whether the server requires a preshared key. This is used in the DynamicTCPServer class
         /// </summary>
         public bool SharedKeyRequired { get; set; }
 
@@ -207,7 +207,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the SharedKey
+        /// SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module
         /// </summary>
         public string SharedKey { get; set; }
 
@@ -222,7 +222,7 @@ namespace PepperDash.Core
         bool IsTryingToConnect;
 
         /// <summary>
-        /// Gets or sets the IsReadyForCommunication
+        /// Bool showing if socket is ready for communication after shared key exchange
         /// </summary>
         public bool IsReadyForCommunication { get; set; }
 
@@ -342,7 +342,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Initialize method
+        /// Just to help S+ set the key
         /// </summary>
         public void Initialize(string key)
         {
@@ -421,9 +421,6 @@ namespace PepperDash.Core
         /// Deactivate the client
         /// </summary>
         /// <returns></returns>
-        /// <summary>
-        /// Deactivate method
-        /// </summary>
         public override bool Deactivate()
         {
             if (_client != null)
@@ -435,7 +432,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Connect method
+        /// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
         /// </summary>
         public void Connect()
         {
@@ -566,7 +563,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Disconnect method
+        /// 
         /// </summary>
         public void Disconnect()
         {
@@ -589,7 +586,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// DisconnectClient method
+        /// Does the actual disconnect business
         /// </summary>
         public void DisconnectClient()
         {
@@ -849,7 +846,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// SendText method
+        /// General send method
         /// </summary>
         public void SendText(string text)
         {
@@ -878,7 +875,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// SendBytes method
+        /// 
         /// </summary>
         public void SendBytes(byte[] bytes)
         {

src/PepperDash.Core/Comm/GenericSecureTcpIpClient_ForServer.cs

@@ -80,7 +80,7 @@ namespace PepperDash.Core
         public string Hostname { get; set; }
 
         /// <summary>
-        /// Gets or sets the Port
+        /// Port on server
         /// </summary>
         public int Port { get; set; }
 
@@ -113,7 +113,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the SharedKey
+        /// SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module
         /// </summary>
         public string SharedKey { get; set; }
 
@@ -123,7 +123,7 @@ namespace PepperDash.Core
         private bool WaitingForSharedKeyResponse { get; set; }
 
         /// <summary>
-        /// Gets or sets the BufferSize
+        /// Defaults to 2000
         /// </summary>
         public int BufferSize { get; set; }
 
@@ -336,7 +336,7 @@ namespace PepperDash.Core
         #region Methods
 
         /// <summary>
-        /// Initialize method
+        /// Just to help S+ set the key
         /// </summary>
         public void Initialize(string key)
         {
@@ -395,7 +395,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Connect method
+        /// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
         /// </summary>
         public void Connect()
         {
@@ -526,7 +526,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Disconnect method
+        /// 
         /// </summary>
         public void Disconnect()
         {
@@ -804,7 +804,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// SendText method
+        /// General send method
         /// </summary>
         public void SendText(string text)
         {
@@ -833,7 +833,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// SendBytes method
+        /// 
         /// </summary>
         public void SendBytes(byte[] bytes)
         {

src/PepperDash.Core/Comm/GenericSecureTcpIpServer.cs

@@ -58,7 +58,7 @@ namespace PepperDash.Core
         public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
 
         /// <summary>
-        /// Delegate for ServerHasChokedCallbackDelegate
+        /// 
         /// </summary>
         public delegate void ServerHasChokedCallbackDelegate();
 
@@ -104,7 +104,7 @@ namespace PepperDash.Core
         int MonitorClientFailureCount;
 
         /// <summary>
-        /// Gets or sets the MonitorClientMaxFailureCount
+        /// 3 by default
         /// </summary>
         public int MonitorClientMaxFailureCount { get; set; }
 
@@ -190,7 +190,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the Port
+        /// Port Server should listen on
         /// </summary>
         public int Port { get; set; }
 
@@ -223,7 +223,8 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the SharedKey
+        /// SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module. 
+        /// If SharedKey changes while server is listening or clients are connected, disconnect and stop listening will be called
         /// </summary>
         public string SharedKey { get; set; }
 
@@ -247,7 +248,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the HeartbeatRequiredIntervalMs
+        /// Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
         /// </summary>
         public int HeartbeatRequiredIntervalMs { get; set; }
 
@@ -257,7 +258,7 @@ namespace PepperDash.Core
         public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } }
 
         /// <summary>
-        /// Gets or sets the HeartbeatStringToMatch
+        /// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
         /// </summary>
         public string HeartbeatStringToMatch { get; set; }
 
@@ -275,7 +276,7 @@ namespace PepperDash.Core
         public List<uint> ConnectedClientsIndexes = new List<uint>();
 
         /// <summary>
-        /// Gets or sets the BufferSize
+        /// Defaults to 2000
         /// </summary>
         public int BufferSize { get; set; }
 
@@ -338,7 +339,7 @@ namespace PepperDash.Core
 
         #region Methods - Server Actions
         /// <summary>
-        /// KillServer method
+        /// Disconnects all clients and stops the server
         /// </summary>
         public void KillServer()
         {
@@ -355,9 +356,6 @@ namespace PepperDash.Core
         /// Initialize Key for device using client name from SIMPL+. Called on Listen from SIMPL+
         /// </summary>
         /// <param name="key"></param>
-        /// <summary>
-        /// Initialize method
-        /// </summary>
         public void Initialize(string key)
         {
             Key = key;
@@ -397,7 +395,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Listen method
+        /// Start listening on the specified port
         /// </summary>
         public void Listen()
         {
@@ -455,7 +453,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// StopListening method
+        /// Stop Listeneing
         /// </summary>
         public void StopListening()
         {
@@ -480,9 +478,6 @@ namespace PepperDash.Core
         /// Disconnects Client
         /// </summary>
         /// <param name="client"></param>
-        /// <summary>
-        /// DisconnectClient method
-        /// </summary>
         public void DisconnectClient(uint client)
         {
             try
@@ -496,7 +491,7 @@ namespace PepperDash.Core
             }
         }
         /// <summary>
-        /// DisconnectAllClientsForShutdown method
+        /// Disconnect All Clients
         /// </summary>
         public void DisconnectAllClientsForShutdown()
         {
@@ -538,9 +533,6 @@ namespace PepperDash.Core
         /// Broadcast text from server to all connected clients
         /// </summary>
         /// <param name="text"></param>
-        /// <summary>
-        /// BroadcastText method
-        /// </summary>
         public void BroadcastText(string text)
         {
             CCriticalSection CCBroadcast = new CCriticalSection();
@@ -574,9 +566,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="text"></param>
         /// <param name="clientIndex"></param>
-        /// <summary>
-        /// SendTextToClient method
-        /// </summary>
         public void SendTextToClient(string text, uint clientIndex)
         {
             try
@@ -645,9 +634,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="clientIndex"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetClientIPAddress method
-        /// </summary>
         public string GetClientIPAddress(uint clientIndex)
         {
             Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "GetClientIPAddress Index: {0}", clientIndex);

src/PepperDash.Core/Comm/GenericSshClient.cs

@@ -36,13 +36,13 @@ namespace PepperDash.Core
         /// </summary>
         public event EventHandler<GenericSocketStatusChageEventArgs> ConnectionChange;
 
-        /// <summary>
+        ///// <summary>
         ///// 
         ///// </summary>
         //public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
 
         /// <summary>
-        /// Gets or sets the Hostname
+        /// Address of server
         /// </summary>
         public string Hostname { get; set; }
 
@@ -52,12 +52,12 @@ namespace PepperDash.Core
         public int Port { get; set; }
 
         /// <summary>
-        /// Gets or sets the Username
+        /// Username for server
         /// </summary>
         public string Username { get; set; }
 
         /// <summary>
-        /// Gets or sets the Password
+        /// And... Password for server.  That was worth documenting!
         /// </summary>
         public string Password { get; set; }
 
@@ -79,7 +79,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Socket status change event
+        /// 
         /// </summary>
         public SocketStatus ClientStatus
         {
@@ -123,7 +123,8 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the AutoReconnectIntervalMs
+        /// Millisecond value, determines the timeout period in between reconnect attempts.
+        /// Set to 5000 by default
         /// </summary>
         public int AutoReconnectIntervalMs { get; set; }
 
@@ -146,31 +147,31 @@ namespace PepperDash.Core
             base(key)
         {
             StreamDebugging = new CommunicationStreamDebugging(key);
-            CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
+			CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
-            Key = key;
+			Key = key;
-            Hostname = hostname;
+			Hostname = hostname;
-            Port = port;
+			Port = port;
-            Username = username;
+			Username = username;
-            Password = password;
+			Password = password; 
-            AutoReconnectIntervalMs = 5000;
+			AutoReconnectIntervalMs = 5000;
 
             ReconnectTimer = new CTimer(o =>
-                {
+	            {
                     if (ConnectEnabled)
                     {
                         Connect();
                     }
-                }, System.Threading.Timeout.Infinite);
+	            }, System.Threading.Timeout.Infinite);
-        }
+		}
 
-        /// <summary>
+		/// <summary>
-        /// S+ Constructor - Must set all properties before calling Connect
+		/// S+ Constructor - Must set all properties before calling Connect
-        /// </summary>
+		/// </summary>
-        public GenericSshClient()
+		public GenericSshClient()
-            : base(SPlusKey)
+			: base(SPlusKey)
-        {
+		{
-            CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
+			CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
-            AutoReconnectIntervalMs = 5000;
+			AutoReconnectIntervalMs = 5000;
 
             ReconnectTimer = new CTimer(o =>
             {
@@ -179,25 +180,25 @@ namespace PepperDash.Core
                     Connect();
                 }
             }, System.Threading.Timeout.Infinite);
-        }
+		}
 
-        /// <summary>
+		/// <summary>
-        /// Handles closing this up when the program shuts down
+		/// Handles closing this up when the program shuts down
-        /// </summary>
+		/// </summary>
-        void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType)
+		void CrestronEnvironment_ProgramStatusEventHandler(eProgramStatusEventType programEventType)
-        {
+		{
-            if (programEventType == eProgramStatusEventType.Stopping)
+			if (programEventType == eProgramStatusEventType.Stopping)
-            {
+			{
-                if (Client != null)
+				if (Client != null)
-                {
+				{
-                    this.LogDebug("Program stopping. Closing connection");
+					this.LogDebug("Program stopping. Closing connection");
                     Disconnect();
                 }
             }
         }
 
         /// <summary>
-        /// Connect method
+        /// Connect to the server, using the provided properties.
         /// </summary>
         public void Connect()
         {
@@ -223,7 +224,10 @@ namespace PepperDash.Core
                     this.LogDebug("Attempting connect");
 
                     // Cancel reconnect if running.
-                    ReconnectTimer?.Stop();
+					if (ReconnectTimer != null)
+					{
+						ReconnectTimer.Stop();
+					}
 
                     // Cleanup the old client if it already exists
                     if (Client != null)
@@ -265,26 +269,20 @@ namespace PepperDash.Core
 
                         if (ie is SocketException)
                         {
-                            this.LogError("CONNECTION failure: Cannot reach host");
+                            this.LogException(ie, "CONNECTION failure: Cannot reach host");                            
-                            this.LogVerbose(ie, "Exception details: ");
                         }
 
                         if (ie is System.Net.Sockets.SocketException socketException)
                         {
-                            this.LogError("Connection failure: Cannot reach {host} on {port}",
+                            this.LogException(ie, "Connection failure: Cannot reach {host} on {port}",
                                 Hostname, Port);
-                            this.LogVerbose(socketException, "SocketException details: ");
                         }
                         if (ie is SshAuthenticationException)
                         {
-                            this.LogError("Authentication failure for username {userName}", Username);
+                            this.LogException(ie, "Authentication failure for username {userName}", Username);
-                            this.LogVerbose(ie, "AuthenticationException details: ");
                         }
                         else
-                        {
+                            this.LogException(ie, "Error on connect");
-                            this.LogError("Error on connect: {error}", ie.Message);
-                            this.LogVerbose(ie, "Exception details: ");
-                        }
 
                         DisconnectLogged = true;
                         KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
@@ -294,7 +292,7 @@ namespace PepperDash.Core
                             ReconnectTimer.Reset(AutoReconnectIntervalMs);
                         }
                     }
-                    catch (SshOperationTimeoutException ex)
+                    catch(SshOperationTimeoutException ex)
                     {
                         this.LogWarning("Connection attempt timed out: {message}", ex.Message);
 
@@ -309,8 +307,7 @@ namespace PepperDash.Core
                     catch (Exception e)
                     {
                         var errorLogLevel = DisconnectLogged == true ? Debug.ErrorLogLevel.None : Debug.ErrorLogLevel.Error;
-                        this.LogError("Unhandled exception on connect: {error}", e.Message);
+                        this.LogException(e, "Unhandled exception on connect");
-                        this.LogVerbose(e, "Exception details: ");
                         DisconnectLogged = true;
                         KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
                         if (AutoReconnect)
@@ -327,18 +324,18 @@ namespace PepperDash.Core
             }
         }
 
-        /// <summary>
+		/// <summary>
-        /// Disconnect method
+		/// Disconnect the clients and put away it's resources.
-        /// </summary>
+		/// </summary>
-        public void Disconnect()
+		public void Disconnect()
-        {
+		{
-            ConnectEnabled = false;
+			ConnectEnabled = false;
-            // Stop trying reconnects, if we are
+			// Stop trying reconnects, if we are
-            if (ReconnectTimer != null)
+			if (ReconnectTimer != null)
-            {
+			{
-                ReconnectTimer.Stop();
+				ReconnectTimer.Stop();
-                // ReconnectTimer = null;
+				// ReconnectTimer = null;
-            }
+			}
 
             KillClient(SocketStatus.SOCKET_STATUS_BROKEN_LOCALLY);
         }
@@ -364,7 +361,7 @@ namespace PepperDash.Core
             }
             catch (Exception ex)
             {
-                this.LogException(ex, "Exception in Kill Client");
+               this.LogException(ex,"Exception in Kill Client");
             }
         }
 
@@ -372,7 +369,7 @@ namespace PepperDash.Core
         /// Kills the stream
         /// </summary>
 		void KillStream()
-        {
+		{
             try
             {
                 if (TheStream != null)
@@ -388,59 +385,59 @@ namespace PepperDash.Core
             {
                 this.LogException(ex, "Exception in Kill Stream:{0}");
             }
-        }
+		}
 
-        /// <summary>
+		/// <summary>
-        /// Handles the keyboard interactive authentication, should it be required.
+		/// Handles the keyboard interactive authentication, should it be required.
-        /// </summary>
+		/// </summary>
-        void kauth_AuthenticationPrompt(object sender, AuthenticationPromptEventArgs e)
+		void kauth_AuthenticationPrompt(object sender, AuthenticationPromptEventArgs e)
-        {
+		{
-            foreach (AuthenticationPrompt prompt in e.Prompts)
+			foreach (AuthenticationPrompt prompt in e.Prompts)
-                if (prompt.Request.IndexOf("Password:", StringComparison.InvariantCultureIgnoreCase) != -1)
+				if (prompt.Request.IndexOf("Password:", StringComparison.InvariantCultureIgnoreCase) != -1)
-                    prompt.Response = Password;
+					prompt.Response = Password;
-        }
+		}
-
+	
-        /// <summary>
+		/// <summary>
-        /// Handler for data receive on ShellStream.  Passes data across to queue for line parsing.
+		/// Handler for data receive on ShellStream.  Passes data across to queue for line parsing.
-        /// </summary>
+		/// </summary>
-        void Stream_DataReceived(object sender, ShellDataEventArgs e)
+		void Stream_DataReceived(object sender, ShellDataEventArgs e)
-        {
+		{
             if (((ShellStream)sender).Length <= 0L)
             {
                 return;
             }
-            var response = ((ShellStream)sender).Read();
+            var response = ((ShellStream)sender).Read(); 
-
+ 
-            var bytesHandler = BytesReceived;
+			var bytesHandler = BytesReceived;
-
+            
-            if (bytesHandler != null)
+		    if (bytesHandler != null)
-            {
+		    {
                 var bytes = Encoding.UTF8.GetBytes(response);
-                if (StreamDebugging.RxStreamDebuggingIsEnabled)
+		        if (StreamDebugging.RxStreamDebuggingIsEnabled)
-                {
+		        {
-                    this.LogInformation("Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
+		            this.LogInformation("Received {1} bytes: '{0}'", ComTextHelper.GetEscapedText(bytes), bytes.Length);
-                }
+		        }
                 bytesHandler(this, new GenericCommMethodReceiveBytesArgs(bytes));
-            }
+		    }
-
+				
-            var textHandler = TextReceived;
+			var textHandler = TextReceived;
-            if (textHandler != null)
+			if (textHandler != null)
-            {
+			{
                 if (StreamDebugging.RxStreamDebuggingIsEnabled)
                     this.LogInformation("Received: '{0}'", ComTextHelper.GetDebugText(response));
 
                 textHandler(this, new GenericCommMethodReceiveTextArgs(response));
             }
-
+			
-        }
+		}
 
 
-        /// <summary>
+		/// <summary>
-        /// Error event handler for client events - disconnect, etc.  Will forward those events via ConnectionChange
+		/// Error event handler for client events - disconnect, etc.  Will forward those events via ConnectionChange
-        /// event
+		/// event
-        /// </summary>
+		/// </summary>
-        void Client_ErrorOccurred(object sender, ExceptionEventArgs e)
+		void Client_ErrorOccurred(object sender, ExceptionEventArgs e)
-        {
+		{
             CrestronInvoke.BeginInvoke(o =>
             {
                 if (e.Exception is SshConnectionException || e.Exception is System.Net.Sockets.SocketException)
@@ -469,54 +466,55 @@ namespace PepperDash.Core
         /// </summary>
         void OnConnectionChange()
         {
-            ConnectionChange?.Invoke(this, new GenericSocketStatusChageEventArgs(this));
+            if (ConnectionChange != null)
+                ConnectionChange(this, new GenericSocketStatusChageEventArgs(this));
         }
 
         #region IBasicCommunication Members
 
-        /// <summary>
+		/// <summary>
-        /// Sends text to the server
+		/// Sends text to the server
-        /// </summary>
+		/// </summary>
-        /// <param name="text">The text to send</param>
+		/// <param name="text"></param>
-        public void SendText(string text)
+		public void SendText(string text)
-        {
+		{
-            try
+		    try
-            {
+		    {
-                if (Client != null && TheStream != null && IsConnected)
+		        if (Client != null && TheStream != null && IsConnected)
-                {
+		        {
-                    if (StreamDebugging.TxStreamDebuggingIsEnabled)
+		            if (StreamDebugging.TxStreamDebuggingIsEnabled)
-                        this.LogInformation(
+		                this.LogInformation(
-                                      "Sending {length} characters of text: '{text}'",
+		                              "Sending {length} characters of text: '{text}'",
-                                      text.Length,
+		                              text.Length,
-                                      ComTextHelper.GetDebugText(text));
+		                              ComTextHelper.GetDebugText(text));
 
-                    TheStream.Write(text);
+		            TheStream.Write(text);
-                    TheStream.Flush();
+		            TheStream.Flush();
-                }
+		        }
-                else
+		        else
-                {
+		        {
-                    this.LogDebug("Client is null or disconnected.  Cannot Send Text");
+		            this.LogDebug("Client is null or disconnected.  Cannot Send Text");
-                }
+		        }
-            }
+		    }
-            catch (ObjectDisposedException)
+		    catch (ObjectDisposedException)
             {
-                this.LogError("ObjectDisposedException sending '{message}'. Restarting connection...", text.Trim());
+                this.LogError("ObjectDisposedException sending '{message}'. Restarting connection...", text.Trim());                
 
                 KillClient(SocketStatus.SOCKET_STATUS_CONNECT_FAILED);
                 ReconnectTimer.Reset();
-            }
+		    }
-            catch (Exception ex)
+			catch (Exception ex)
-            {
+			{
                 this.LogException(ex, "Exception sending text: '{message}'", text);
-            }
+			}
-        }
+		}
 
         /// <summary>
         /// Sends Bytes to the server
         /// </summary>
-        /// <param name="bytes">The bytes to send</param>
+        /// <param name="bytes"></param>
-        public void SendBytes(byte[] bytes)
+		public void SendBytes(byte[] bytes)
-        {
+		{
             try
             {
                 if (Client != null && TheStream != null && IsConnected)
@@ -542,38 +540,38 @@ namespace PepperDash.Core
             catch (Exception ex)
             {
                 this.LogException(ex, "Exception sending {message}", ComTextHelper.GetEscapedText(bytes));
-            }
+            }           
-        }
+		}
-        #endregion
+    #endregion
 
-    }
+}
 
-    //*****************************************************************************************************
+//*****************************************************************************************************
-    //*****************************************************************************************************
+//*****************************************************************************************************
-    /// <summary>
+/// <summary>
-    /// Represents a SshConnectionChangeEventArgs
+/// Fired when connection changes
-    /// </summary>
+/// </summary>
-    public class SshConnectionChangeEventArgs : EventArgs
+public class SshConnectionChangeEventArgs : EventArgs
-    {
+	{
         /// <summary>
         /// Connection State
         /// </summary>
 		public bool IsConnected { get; private set; }
 
         /// <summary>
-        /// Gets or sets the UIsConnected
+        /// Connection Status represented as a ushort
         /// </summary>
-        public ushort UIsConnected { get { return (ushort)(Client.IsConnected ? 1 : 0); } }
+		public ushort UIsConnected { get { return (ushort)(Client.IsConnected ? 1 : 0); } }
 
         /// <summary>
-        /// Gets or sets the Client
+        /// The client
         /// </summary>
-        public GenericSshClient Client { get; private set; }
+		public GenericSshClient Client { get; private set; }
 
         /// <summary>
-        /// Gets or sets the Status
+        /// Socket Status as represented by
         /// </summary>
-        public ushort Status { get { return Client.UStatus; } }
+		public ushort Status { get { return Client.UStatus; } }
 
         /// <summary>
         ///  S+ Constructor

src/PepperDash.Core/Comm/GenericTcpIpClient.cs

@@ -59,7 +59,7 @@ namespace PepperDash.Core
 		}
 
         /// <summary>
-        /// Gets or sets the Port
+        /// Port on server
         /// </summary>
         public int Port { get; set; }
 
@@ -135,9 +135,9 @@ namespace PepperDash.Core
 		/// </summary>
 		public string ConnectionFailure { get { return ClientStatus.ToString(); } }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the AutoReconnect
+		/// bool to track if auto reconnect should be set on the socket
-  /// </summary>
+		/// </summary>
 		public bool AutoReconnect { get; set; }
 
         /// <summary>
@@ -232,7 +232,7 @@ namespace PepperDash.Core
 		}
 
         /// <summary>
-        /// Initialize method
+        /// Just to help S+ set the key
         /// </summary>
         public void Initialize(string key)
         {
@@ -255,9 +255,6 @@ namespace PepperDash.Core
         /// 
         /// </summary>
         /// <returns></returns>
-  /// <summary>
-  /// Deactivate method
-  /// </summary>
 		public override bool Deactivate()
 		{
             RetryTimer.Stop();
@@ -270,9 +267,9 @@ namespace PepperDash.Core
 			return true;
 		}
 
-  /// <summary>
+        /// <summary>
-  /// Connect method
+        /// Attempts to connect to the server
-  /// </summary>
+        /// </summary>
 		public void Connect()
 		{
             if (string.IsNullOrEmpty(Hostname))
@@ -337,9 +334,9 @@ namespace PepperDash.Core
             }
         }
 
-  /// <summary>
+        /// <summary>
-  /// Disconnect method
+        /// Attempts to disconnect the client
-  /// </summary>
+        /// </summary>
 		public void Disconnect()
 		{
             try
@@ -358,7 +355,7 @@ namespace PepperDash.Core
 		}
 
         /// <summary>
-        /// DisconnectClient method
+        /// Does the actual disconnect business
         /// </summary>
         public void DisconnectClient()
         {
@@ -449,9 +446,9 @@ namespace PepperDash.Core
             }
 		}
 
-  /// <summary>
+		/// <summary>
-  /// SendText method
+		/// General send method
-  /// </summary>
+		/// </summary>
 		public void SendText(string text)
 		{
 			var bytes = Encoding.GetEncoding(28591).GetBytes(text);
@@ -462,9 +459,9 @@ namespace PepperDash.Core
 			    _client.SendData(bytes, bytes.Length);
 		}
 
-  /// <summary>
+		/// <summary>
-  /// SendEscapedText method
+		/// This is useful from console and...?
-  /// </summary>
+		/// </summary>
 		public void SendEscapedText(string text)
 		{
 			var unescapedText = Regex.Replace(text, @"\\x([0-9a-fA-F][0-9a-fA-F])", s =>
@@ -479,9 +476,6 @@ namespace PepperDash.Core
         /// Sends Bytes to the server
         /// </summary>
         /// <param name="bytes"></param>
-  /// <summary>
-  /// SendBytes method
-  /// </summary>
 		public void SendBytes(byte[] bytes)
 		{
             if (StreamDebugging.TxStreamDebuggingIsEnabled)
@@ -514,9 +508,9 @@ namespace PepperDash.Core
 		}
 	}
 
- /// <summary>
+    /// <summary>
- /// Represents a TcpSshPropertiesConfig
+    /// Configuration properties for TCP/SSH Connections
- /// </summary>
+    /// </summary>
 	public class TcpSshPropertiesConfig
 	{
         /// <summary>
@@ -535,9 +529,9 @@ namespace PepperDash.Core
         /// Username credential
         /// </summary>
 		public string Username { get; set; }
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the Password
+        /// Passord credential
-  /// </summary>
+        /// </summary>
 		public string Password { get; set; }
 
 		/// <summary>
@@ -545,14 +539,14 @@ namespace PepperDash.Core
 		/// </summary>
 		public int BufferSize { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the AutoReconnect
+		/// Defaults to true
-  /// </summary>
+		/// </summary>
 		public bool AutoReconnect { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the AutoReconnectIntervalMs
+		/// Defaults to 5000ms
-  /// </summary>
+		/// </summary>
 		public int AutoReconnectIntervalMs { get; set; }
 
         /// <summary>

src/PepperDash.Core/Comm/GenericTcpIpClient_ForServer.cs

@@ -69,7 +69,7 @@ namespace PepperDash.Core
         public string Hostname { get; set; }
 
         /// <summary>
-        /// Gets or sets the Port
+        /// Port on server
         /// </summary>
         public int Port { get; set; }
 
@@ -102,7 +102,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the SharedKey
+        /// SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module
         /// </summary>
         public string SharedKey { get; set; }
 
@@ -112,7 +112,7 @@ namespace PepperDash.Core
         private bool WaitingForSharedKeyResponse { get; set; }
 
         /// <summary>
-        /// Gets or sets the BufferSize
+        /// Defaults to 2000
         /// </summary>
         public int BufferSize { get; set; }
 
@@ -289,7 +289,7 @@ namespace PepperDash.Core
         #region Methods
 
         /// <summary>
-        /// Initialize method
+        /// Just to help S+ set the key
         /// </summary>
         public void Initialize(string key)
         {
@@ -311,7 +311,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Connect method
+        /// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
         /// </summary>
         public void Connect()
         {
@@ -442,7 +442,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Disconnect method
+        /// 
         /// </summary>
         public void Disconnect()
         {
@@ -669,7 +669,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// SendText method
+        /// General send method
         /// </summary>
         public void SendText(string text)
         {
@@ -698,7 +698,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// SendBytes method
+        /// 
         /// </summary>
         public void SendBytes(byte[] bytes)
         {

src/PepperDash.Core/Comm/GenericTcpIpServer.cs

@@ -52,7 +52,7 @@ namespace PepperDash.Core
         public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
 
         /// <summary>
-        /// Delegate for ServerHasChokedCallbackDelegate
+        /// 
         /// </summary>
         public delegate void ServerHasChokedCallbackDelegate();
 
@@ -82,7 +82,7 @@ namespace PepperDash.Core
         int MonitorClientFailureCount;
 
         /// <summary>
-        /// Gets or sets the MonitorClientMaxFailureCount
+        /// 3 by default
         /// </summary>
         public int MonitorClientMaxFailureCount { get; set; }
 
@@ -171,7 +171,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the Port
+        /// Port Server should listen on
         /// </summary>
         public int Port { get; set; }
 
@@ -204,7 +204,8 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the SharedKey
+        /// SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module. 
+        /// If SharedKey changes while server is listening or clients are connected, disconnect and stop listening will be called
         /// </summary>
         public string SharedKey { get; set; }
 
@@ -228,7 +229,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Gets or sets the HeartbeatRequiredIntervalMs
+        /// Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
         /// </summary>
         public int HeartbeatRequiredIntervalMs { get; set; }
 
@@ -238,7 +239,7 @@ namespace PepperDash.Core
         public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } }
 
         /// <summary>
-        /// Gets or sets the HeartbeatStringToMatch
+        /// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
         /// </summary>
         public string HeartbeatStringToMatch { get; set; }
 
@@ -256,7 +257,7 @@ namespace PepperDash.Core
         public List<uint> ConnectedClientsIndexes = new List<uint>();
 
         /// <summary>
-        /// Gets or sets the BufferSize
+        /// Defaults to 2000
         /// </summary>
         public int BufferSize { get; set; }
 
@@ -319,7 +320,7 @@ namespace PepperDash.Core
 
         #region Methods - Server Actions
         /// <summary>
-        /// KillServer method
+        /// Disconnects all clients and stops the server
         /// </summary>
         public void KillServer()
         {
@@ -336,9 +337,6 @@ namespace PepperDash.Core
         /// Initialize Key for device using client name from SIMPL+. Called on Listen from SIMPL+
         /// </summary>
         /// <param name="key"></param>
-        /// <summary>
-        /// Initialize method
-        /// </summary>
         public void Initialize(string key)
         {
             Key = key;
@@ -377,7 +375,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Listen method
+        /// Start listening on the specified port
         /// </summary>
         public void Listen()
         {
@@ -434,7 +432,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// StopListening method
+        /// Stop Listening
         /// </summary>
         public void StopListening()
         {
@@ -459,9 +457,6 @@ namespace PepperDash.Core
         /// Disconnects Client
         /// </summary>
         /// <param name="client"></param>
-        /// <summary>
-        /// DisconnectClient method
-        /// </summary>
         public void DisconnectClient(uint client)
         {
             try
@@ -475,7 +470,7 @@ namespace PepperDash.Core
             }
         }
         /// <summary>
-        /// DisconnectAllClientsForShutdown method
+        /// Disconnect All Clients
         /// </summary>
         public void DisconnectAllClientsForShutdown()
         {
@@ -517,9 +512,6 @@ namespace PepperDash.Core
         /// Broadcast text from server to all connected clients
         /// </summary>
         /// <param name="text"></param>
-        /// <summary>
-        /// BroadcastText method
-        /// </summary>
         public void BroadcastText(string text)
         {
             CCriticalSection CCBroadcast = new CCriticalSection();
@@ -553,9 +545,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="text"></param>
         /// <param name="clientIndex"></param>
-        /// <summary>
-        /// SendTextToClient method
-        /// </summary>
         public void SendTextToClient(string text, uint clientIndex)
         {
             try
@@ -624,9 +613,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="clientIndex"></param>
         /// <returns>IP address of the client</returns>
-        /// <summary>
-        /// GetClientIPAddress method
-        /// </summary>
         public string GetClientIPAddress(uint clientIndex)
         {
             Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "GetClientIPAddress Index: {0}", clientIndex);

src/PepperDash.Core/Comm/GenericUdpServer.cs

@@ -131,14 +131,14 @@ namespace PepperDash.Core
         /// <param name="key"></param>
         /// <param name="address"></param>
         /// <param name="port"></param>
-        /// <param name="bufferSize"></param>
+        /// <param name="buffefSize"></param>
-        public GenericUdpServer(string key, string address, int port, int bufferSize)
+        public GenericUdpServer(string key, string address, int port, int buffefSize)
             : base(key)
         {
             StreamDebugging = new CommunicationStreamDebugging(key); 
             Hostname = address;
             Port = port;
-            BufferSize = bufferSize;
+            BufferSize = buffefSize;
 
             CrestronEnvironment.ProgramStatusEventHandler += new ProgramStatusEventHandler(CrestronEnvironment_ProgramStatusEventHandler);
             CrestronEnvironment.EthernetEventHandler += new EthernetEventHandler(CrestronEnvironment_EthernetEventHandler);
@@ -150,9 +150,6 @@ namespace PepperDash.Core
         /// <param name="key"></param>
         /// <param name="address"></param>
         /// <param name="port"></param>
-        /// <summary>
-        /// Initialize method
-        /// </summary>
         public void Initialize(string key, string address, ushort port)
         {
             Key = key;
@@ -188,27 +185,13 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Connect method
+        /// Enables the UDP Server
         /// </summary>
         public void Connect()
         {
             if (Server == null)
             {
-                try
+                Server = new UDPServer();
-                {
-                    var address = IPAddress.Parse(Hostname);
-
-                    Server = new UDPServer(address, Port, BufferSize);
-
-                }
-                catch (Exception ex)
-                {
-                    this.LogError("Error parsing IP Address '{ipAddress}': message: {message}", Hostname, ex.Message);
-                    this.LogInformation("Creating UDPServer with default buffersize");
-
-                    Server = new UDPServer();
-                }
-
             }
 
             if (string.IsNullOrEmpty(Hostname))
@@ -239,7 +222,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Disconnect method
+        /// Disabled the UDP Server
         /// </summary>
         public void Disconnect()
         {
@@ -309,9 +292,6 @@ namespace PepperDash.Core
         /// General send method
         /// </summary>
         /// <param name="text"></param>
-        /// <summary>
-        /// SendText method
-        /// </summary>
         public void SendText(string text)
         {
             var bytes = Encoding.GetEncoding(28591).GetBytes(text);
@@ -329,9 +309,6 @@ namespace PepperDash.Core
         /// 
         /// </summary>
         /// <param name="bytes"></param>
-        /// <summary>
-        /// SendBytes method
-        /// </summary>
         public void SendBytes(byte[] bytes)
         {
             if (StreamDebugging.TxStreamDebuggingIsEnabled)
@@ -343,9 +320,9 @@ namespace PepperDash.Core
 
     }
 
- /// <summary>
+    /// <summary>
- /// Represents a GenericUdpReceiveTextExtraArgs
+    /// 
- /// </summary>
+    /// </summary>
 	public class GenericUdpReceiveTextExtraArgs : EventArgs
 	{
         /// <summary>

src/PepperDash.Core/Comm/TcpClientConfigObject.cs

@@ -3,7 +3,7 @@
 namespace PepperDash.Core
 {
     /// <summary>
-    /// Represents a TcpClientConfigObject
+    /// Client config object for TCP client with server that inherits from TcpSshPropertiesConfig and adds properties for shared key and heartbeat
     /// </summary>
     public class TcpClientConfigObject
     {

src/PepperDash.Core/Comm/eControlMethods.cs

@@ -74,10 +74,6 @@ namespace PepperDash.Core
         /// <summary>
         /// Secure TCP/IP
         /// </summary>
-        SecureTcpIp,
+        SecureTcpIp
-        /// <summary>
-        /// Used when comms needs to be handled in SIMPL and bridged opposite the normal direction
-        /// </summary>
-        ComBridge
     }
 }

src/PepperDash.Core/CommunicationExtras.cs

@@ -38,9 +38,9 @@ namespace PepperDash.Core
         void Disconnect();
     }
 
-    /// <summary>
+	/// <summary>
-    /// Defines the contract for IBasicCommunication
+	/// Represents a device that uses basic connection
-    /// </summary>
+	/// </summary>
     public interface IBasicCommunication : ICommunicationReceiver
 	{
         /// <summary>
@@ -147,9 +147,9 @@ namespace PepperDash.Core
 	/// </summary>
 	public class GenericCommMethodReceiveBytesArgs : EventArgs
 	{
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the Bytes
+        /// 
-  /// </summary>
+        /// </summary>
 		public byte[] Bytes { get; private set; }
 
         /// <summary>
@@ -228,9 +228,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="text"></param>
         /// <returns></returns>
-  /// <summary>
-  /// GetEscapedText method
-  /// </summary>
 		public static string GetEscapedText(string text)
 		{
 			var bytes = Encoding.GetEncoding(28591).GetBytes(text);
@@ -242,9 +239,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="text"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetDebugText method
-        /// </summary>
         public static string GetDebugText(string text)
         {
             return Regex.Replace(text, @"[^\u0020-\u007E]", a => GetEscapedText(a.Value));

src/PepperDash.Core/Config/PortalConfigReader.cs

@@ -67,9 +67,6 @@ namespace PepperDash.Core.Config
 		/// </summary>
 		/// <param name="doubleConfig"></param>
 		/// <returns></returns>
-  /// <summary>
-  /// MergeConfigs method
-  /// </summary>
 		public static JObject MergeConfigs(JObject doubleConfig)
 		{
 			var system = JObject.FromObject(doubleConfig["system"]);

src/PepperDash.Core/Conversion/Convert.cs

@@ -6,22 +6,13 @@ using Crestron.SimplSharp;
 
 namespace PepperDash.Core
 {
-    /// <summary>
-    /// Represents a EncodingHelper
-    /// </summary>
     public class EncodingHelper
     {
-        /// <summary>
-        /// ConvertUtf8ToAscii method
-        /// </summary>
         public static string ConvertUtf8ToAscii(string utf8String)
         {
             return Encoding.ASCII.GetString(Encoding.UTF8.GetBytes(utf8String), 0, utf8String.Length);
         }
 
-        /// <summary>
-        /// ConvertUtf8ToUtf16 method
-        /// </summary>
         public static string ConvertUtf8ToUtf16(string utf8String)
         {
             return Encoding.Unicode.GetString(Encoding.UTF8.GetBytes(utf8String), 0, utf8String.Length);

src/PepperDash.Core/Device.cs

@@ -5,41 +5,41 @@ using Serilog.Events;
 namespace PepperDash.Core
 {
 	//*********************************************************************************************************
- /// <summary>
+	/// <summary>
- /// Represents a Device
+	/// The core event and status-bearing class that most if not all device and connectors can derive from.
- /// </summary>
+	/// </summary>
 	public class Device : IKeyName
 	{
 
-		/// <summary>
+        /// <summary>
-		/// Unique Key
+        /// Unique Key
-		/// </summary>
+        /// </summary>
 		public string Key { get; protected set; }
-  /// <summary>
-  /// Gets or sets the Name
-  /// </summary>
-		public string Name { get; protected set; }
 		/// <summary>
-		/// 
+		/// Name of the devie
 		/// </summary>
+        public string Name { get; protected set; }
+        /// <summary>
+        /// 
+        /// </summary>
 		public bool Enabled { get; protected set; }
 
-		/// <summary>
+        ///// <summary>
-		/// A place to store reference to the original config object, if any. These values should 
+        ///// A place to store reference to the original config object, if any. These values should 
-		/// NOT be used as properties on the device as they are all publicly-settable values.
+        ///// NOT be used as properties on the device as they are all publicly-settable values.
-		/// </summary>
+        ///// </summary>
-		//public DeviceConfig Config { get; private set; }
+        //public DeviceConfig Config { get; private set; }
-		/// <summary>
+        ///// <summary>
-		/// Helper method to check if Config exists
+        ///// Helper method to check if Config exists
-		/// </summary>
+        ///// </summary>
-		//public bool HasConfig { get { return Config != null; } }
+        //public bool HasConfig { get { return Config != null; } }
 
 		List<Action> _PreActivationActions;
 		List<Action> _PostActivationActions;
 
-		/// <summary>
+        /// <summary>
-		/// 
+        /// 
-		/// </summary>
+        /// </summary>
 		public static Device DefaultDevice { get { return _DefaultDevice; } }
 		static Device _DefaultDevice = new Device("Default", "Default");
 
@@ -54,27 +54,27 @@ namespace PepperDash.Core
 			Name = "";
 		}
 
-		/// <summary>
+        /// <summary>
-		/// Constructor with key and name
+        /// Constructor with key and name
-		/// </summary>
+        /// </summary>
-		/// <param name="key"></param>
+        /// <param name="key"></param>
-		/// <param name="name"></param>
+        /// <param name="name"></param>
 		public Device(string key, string name) : this(key)
 		{
 			Name = name;
 
 		}
 
-		//public Device(DeviceConfig config)
+        //public Device(DeviceConfig config)
-		//    : this(config.Key, config.Name)
+        //    : this(config.Key, config.Name)
-		//{
+        //{
-		//    Config = config;
+        //    Config = config;
-		//}
+        //}
 
-		/// <summary>
+        /// <summary>
-		/// Adds a pre activation action
+        /// Adds a pre activation action
-		/// </summary>
+        /// </summary>
-		/// <param name="act"></param>
+        /// <param name="act"></param>
 		public void AddPreActivationAction(Action act)
 		{
 			if (_PreActivationActions == null)
@@ -82,13 +82,10 @@ namespace PepperDash.Core
 			_PreActivationActions.Add(act);
 		}
 
-		/// <summary>
+        /// <summary>
-		/// Adds a post activation action
+        /// Adds a post activation action
-		/// </summary>
+        /// </summary>
-		/// <param name="act"></param>
+        /// <param name="act"></param>
-  /// <summary>
-  /// AddPostActivationAction method
-  /// </summary>
 		public void AddPostActivationAction(Action act)
 		{
 			if (_PostActivationActions == null)
@@ -96,56 +93,55 @@ namespace PepperDash.Core
 			_PostActivationActions.Add(act);
 		}
 
-  /// <summary>
+        /// <summary>
-  /// PreActivate method
+        /// Executes the preactivation actions
-  /// </summary>
+        /// </summary>
-		public void PreActivate()
+        public void PreActivate()
-		{
+        {
-			if (_PreActivationActions != null)
+            if (_PreActivationActions != null)
-				_PreActivationActions.ForEach(a =>
+                _PreActivationActions.ForEach(a => {
-				{
 					try
 					{
 						a.Invoke();
-					}
+					} catch (Exception e)
-					catch (Exception e)
+					{ 
-					{
 						Debug.LogMessage(e, "Error in PreActivationAction: " + e.Message, this);
 					}
-				});
+            });
-		}
+        }
 
-  /// <summary>
+		/// <summary>
-  /// Activate method
+		/// Gets this device ready to be used in the system. Runs any added pre-activation items, and
-  /// </summary>
+		/// all post-activation at end. Classes needing additional logic to 
-		public bool Activate()
+		/// run should override CustomActivate()
+		/// </summary>
+		public bool Activate() 
 		{
-			//if (_PreActivationActions != null)
+            //if (_PreActivationActions != null)
-			//    _PreActivationActions.ForEach(a => a.Invoke());
+            //    _PreActivationActions.ForEach(a => a.Invoke());
 			var result = CustomActivate();
-			//if(result && _PostActivationActions != null)
+            //if(result && _PostActivationActions != null)
-			//    _PostActivationActions.ForEach(a => a.Invoke());
+            //    _PostActivationActions.ForEach(a => a.Invoke());
-			return result;
+			return result; 	
 		}
 
-  /// <summary>
+        /// <summary>
-  /// PostActivate method
+        /// Executes the postactivation actions
-  /// </summary>
+        /// </summary>
-		public void PostActivate()
+        public void PostActivate()
-		{
+        {
-			if (_PostActivationActions != null)
+            if (_PostActivationActions != null)
-				_PostActivationActions.ForEach(a =>
+                _PostActivationActions.ForEach(a => {
-				{
+                    try
-					try
+                    {
-					{
+                        a.Invoke();
-						a.Invoke();
+                    }
-					}
+                    catch (Exception e)
-					catch (Exception e)
+                    {
-					{
+                        Debug.LogMessage(e, "Error in PostActivationAction: " + e.Message, this);
-						Debug.LogMessage(e, "Error in PostActivationAction: " + e.Message, this);
+                    }
-					}
+                });
-				});
+        }
-		}
 
 		/// <summary>
 		/// Called in between Pre and PostActivationActions when Activate() is called. 
@@ -153,9 +149,6 @@ namespace PepperDash.Core
 		/// do not need to call base.CustomActivate()
 		/// </summary>
 		/// <returns>true if device activated successfully.</returns>
-  /// <summary>
-  /// CustomActivate method
-  /// </summary>
 		public virtual bool CustomActivate() { return true; }
 
 		/// <summary>
@@ -165,14 +158,14 @@ namespace PepperDash.Core
 		/// <returns></returns>
 		public virtual bool Deactivate() { return true; }
 
-		/// <summary>
+        /// <summary>
-		/// Call this method to start communications with a device. Overriding classes do not need to call base.Initialize()
+        /// Call this method to start communications with a device. Overriding classes do not need to call base.Initialize()
-		/// </summary>
+        /// </summary>
-		public virtual void Initialize()
+	    public virtual void Initialize()
-		{
+	    {
-		}
+	    }
 
-		/// <summary>
+	    /// <summary>
 		/// Helper method to check object for bool value false and fire an Action method
 		/// </summary>
 		/// <param name="o">Should be of type bool, others will be ignored</param>
@@ -182,18 +175,5 @@ namespace PepperDash.Core
 			if (o is bool && !(bool)o) a();
 		}
 
-        /// <summary>
-        /// Returns a string representation of the object, including its key and name.
-        /// </summary>
-        /// <remarks>The returned string is formatted as "{Key} - {Name}". If the <c>Name</c> property is
-        /// null or empty,  "---" is used in place of the name.</remarks>
-        /// <returns>A string that represents the object, containing the key and name in the format "{Key} - {Name}".</returns>
-  /// <summary>
-  /// ToString method
-  /// </summary>
-		public override string ToString()
-		{
-			return string.Format("{0} - {1}", Key, string.IsNullOrEmpty(Name) ? "---" : Name);
-		}
 	}
 }

src/PepperDash.Core/EthernetHelper.cs

@@ -4,9 +4,9 @@ using Serilog.Events;
 
 namespace PepperDash.Core
 {
- /// <summary>
+    /// <summary>
- /// Represents a EthernetHelper
+    /// Class to help with accessing values from the CrestronEthernetHelper class 
- /// </summary>
+    /// </summary>
 	public class EthernetHelper
 	{
 		/// <summary>
@@ -24,9 +24,9 @@ namespace PepperDash.Core
 
 		// ADD OTHER HELPERS HERE
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the PortNumber
+		/// 
-  /// </summary>
+		/// </summary>
 		public int PortNumber { get; private set; }
 
 		private EthernetHelper(int portNumber)

src/PepperDash.Core/EventArgs.cs

@@ -16,19 +16,19 @@ namespace PepperDash.Core
 		/// </summary>
 		public bool State { get; set; }
 		
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the IntValue
+		/// Boolean ushort value property
-  /// </summary>
+		/// </summary>
 		public ushort IntValue { get { return (ushort)(State ? 1 : 0); } }
 		
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Type
+		/// Boolean change event args type
-  /// </summary>
+		/// </summary>
 		public ushort Type { get; set; }
 		
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Index
+		/// Boolean change event args index
-  /// </summary>
+		/// </summary>
 		public ushort Index { get; set; }
 		
 		/// <summary>
@@ -64,9 +64,9 @@ namespace PepperDash.Core
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a UshrtChangeEventArgs
+	/// Ushort change event args
- /// </summary>
+	/// </summary>
 	public class UshrtChangeEventArgs : EventArgs
 	{
 		/// <summary>
@@ -74,14 +74,14 @@ namespace PepperDash.Core
 		/// </summary>
 		public ushort IntValue { get; set; }
 		
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Type
+		/// Ushort change event args type
-  /// </summary>
+		/// </summary>
 		public ushort Type { get; set; }
 		
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Index
+		/// Ushort change event args index
-  /// </summary>
+		/// </summary>
 		public ushort Index { get; set; }
 		
 		/// <summary>
@@ -117,9 +117,9 @@ namespace PepperDash.Core
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a StringChangeEventArgs
+	/// String change event args
- /// </summary>
+	/// </summary>
 	public class StringChangeEventArgs : EventArgs
 	{
 		/// <summary>
@@ -127,14 +127,14 @@ namespace PepperDash.Core
 		/// </summary>
 		public string StringValue { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Type
+		/// String change event args type
-  /// </summary>
+		/// </summary>
 		public ushort Type { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Index
+		/// string change event args index
-  /// </summary>
+		/// </summary>
 		public ushort Index { get; set; }
 
 		/// <summary>

src/PepperDash.Core/JsonStandardObjects/EventArgs and Constants.cs

@@ -32,14 +32,14 @@ namespace PepperDash.Core.JsonStandardObjects
 		/// </summary>
 		public DeviceConfig Device { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Type
+		/// Device change event args type
-  /// </summary>
+		/// </summary>
 		public ushort Type { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Index
+		/// Device change event args index
-  /// </summary>
+		/// </summary>
 		public ushort Index { get; set; }
 
 		/// <summary>

src/PepperDash.Core/JsonStandardObjects/JsonToSimplDevice.cs

@@ -58,9 +58,6 @@ namespace PepperDash.Core.JsonStandardObjects
 		/// </summary>
 		/// <param name="uniqueID"></param>
 		/// <param name="deviceKey"></param>
-  /// <summary>
-  /// Initialize method
-  /// </summary>
 		public void Initialize(string uniqueID, string deviceKey)
 		{
 			// S+ set EvaluateFb low

src/PepperDash.Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs

@@ -47,14 +47,14 @@ namespace PepperDash.Core.JsonStandardObjects
 		]
 	}
 	*/
- /// <summary>
+	/// <summary>
- /// Represents a ComParamsConfig
+	/// Device communication parameter class
- /// </summary>
+	/// </summary>
 	public class ComParamsConfig
 	{
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the baudRate
+        /// 
-  /// </summary>
+        /// </summary>
 		public int baudRate { get; set; }
         /// <summary>
         /// 
@@ -86,13 +86,13 @@ namespace PepperDash.Core.JsonStandardObjects
 		public int pacing { get; set; }
 
 		// convert properties for simpl
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplBaudRate
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplBaudRate { get { return Convert.ToUInt16(baudRate); } }
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplDataBits
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplDataBits { get { return Convert.ToUInt16(dataBits); } }
         /// <summary>
         /// 
@@ -143,13 +143,13 @@ namespace PepperDash.Core.JsonStandardObjects
 		public int autoReconnectIntervalMs { get; set; }
 
 		// convert properties for simpl
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplPort
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplPort { get { return Convert.ToUInt16(port); } }
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplAutoReconnect
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplAutoReconnect { get { return (ushort)(autoReconnect ? 1 : 0); } }
         /// <summary>
         /// 
@@ -192,9 +192,9 @@ namespace PepperDash.Core.JsonStandardObjects
 		public TcpSshPropertiesConfig tcpSshProperties { get; set; }
 
 		// convert properties for simpl
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplControlPortNumber
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplControlPortNumber { get { return Convert.ToUInt16(controlPortNumber); } }
 
 		/// <summary>
@@ -207,9 +207,9 @@ namespace PepperDash.Core.JsonStandardObjects
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a PropertiesConfig
+	/// Device properties class
- /// </summary>
+	/// </summary>
 	public class PropertiesConfig
 	{
         /// <summary>
@@ -226,13 +226,13 @@ namespace PepperDash.Core.JsonStandardObjects
 		public ControlConfig control { get; set; }
 
 		// convert properties for simpl
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplDeviceId
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplDeviceId { get { return Convert.ToUInt16(deviceId); } }
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the simplEnabled
+        /// 
-  /// </summary>
+        /// </summary>
 		public ushort simplEnabled { get { return (ushort)(enabled ? 1 : 0); } }
 
 		/// <summary>

src/PepperDash.Core/JsonToSimpl/Constants.cs

@@ -88,9 +88,9 @@ namespace PepperDash.Core.JsonToSimpl
 	/// </summary>
 	public class SPlusValueWrapper
 	{
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the ValueType
+        /// 
-  /// </summary>
+        /// </summary>
 		public SPlusType ValueType { get; private set; }
         /// <summary>
         /// 
@@ -122,9 +122,9 @@ namespace PepperDash.Core.JsonToSimpl
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Enumeration of SPlusType values
+	/// S+ types enum
- /// </summary>
+	/// </summary>
 	public enum SPlusType
 	{
         /// <summary>

src/PepperDash.Core/JsonToSimpl/Global.cs

@@ -23,9 +23,6 @@ namespace PepperDash.Core.JsonToSimpl
 		/// </summary>
 		/// <param name="master">New master to add</param>
         /// 
-  /// <summary>
-  /// AddMaster method
-  /// </summary>
 		public static void AddMaster(JsonToSimplMaster master)
 		{
 			if (master == null)
@@ -52,9 +49,9 @@ namespace PepperDash.Core.JsonToSimpl
 			}
 		}
 
-  /// <summary>
+		/// <summary>
-  /// GetMasterByFile method
+		/// Gets a master by its key.  Case-insensitive
-  /// </summary>
+		/// </summary>
 		public static JsonToSimplMaster GetMasterByFile(string file)
 		{
 			return Masters.FirstOrDefault(m => m.UniqueID.Equals(file, StringComparison.OrdinalIgnoreCase));

src/PepperDash.Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs

@@ -5,9 +5,9 @@ using Serilog.Events;
 
 namespace PepperDash.Core.JsonToSimpl
 {
- /// <summary>
+    /// <summary>
- /// Represents a JsonToSimplArrayLookupChild
+    /// Used to interact with an array of values with the S+ modules
- /// </summary>
+    /// </summary>
 	public class JsonToSimplArrayLookupChild : JsonToSimplChildObjectBase
 	{
         /// <summary>
@@ -76,10 +76,9 @@ namespace PepperDash.Core.JsonToSimpl
 				PathSuffix == null ? "" : PathSuffix);
 		}
 
-  /// <summary>
+        /// <summary>
-  /// ProcessAll method
+        /// Process all values
-  /// </summary>
+        /// </summary>
-  /// <inheritdoc />
 		public override void ProcessAll()
 		{
 			if (FindInArray())

src/PepperDash.Core/JsonToSimpl/JsonToSimplChildObjectBase.cs

@@ -28,14 +28,14 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
 		public SPlusValuesDelegate GetAllValuesDelegate { get; set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the SetAllPathsDelegate
+		/// Use a callback to reduce task switch/threading
-  /// </summary>
+		/// </summary>
 		public SPlusValuesDelegate SetAllPathsDelegate { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the Key
+        /// Unique identifier for instance
-  /// </summary>
+        /// </summary>
 		public string Key { get; protected set; }
 
 		/// <summary>
@@ -49,9 +49,9 @@ namespace PepperDash.Core.JsonToSimpl
 		/// </summary>
 		public string PathSuffix { get; protected set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the LinkedToObject
+        /// Indicates if the instance is linked to an object
-  /// </summary>
+        /// </summary>
 		public bool LinkedToObject { get; protected set; }
 
         /// <summary>
@@ -96,9 +96,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// Sets the path prefix for the object
         /// </summary>
         /// <param name="pathPrefix"></param>
-  /// <summary>
-  /// SetPathPrefix method
-  /// </summary>
 		public void SetPathPrefix(string pathPrefix)
 		{
 			PathPrefix = pathPrefix;
@@ -113,9 +110,9 @@ namespace PepperDash.Core.JsonToSimpl
 			BoolPaths[index] = path;
 		}
 
-  /// <summary>
+		/// <summary>
-  /// SetUshortPath method
+		/// Set the JPath for a ushort out index.
-  /// </summary>
+		/// </summary>
 		public void SetUshortPath(ushort index, string path)
 		{
 			Debug.Console(1, "JSON Child[{0}] SetUshortPath {1}={2}", Key, index, path);
@@ -123,9 +120,9 @@ namespace PepperDash.Core.JsonToSimpl
 			UshortPaths[index] = path;
 		}
 
-  /// <summary>
+		/// <summary>
-  /// SetStringPath method
+		/// Set the JPath for a string output index. 
-  /// </summary>
+		/// </summary>
 		public void SetStringPath(ushort index, string path)
 		{
 			Debug.Console(1, "JSON Child[{0}] SetStringPath {1}={2}", Key, index, path);
@@ -133,10 +130,10 @@ namespace PepperDash.Core.JsonToSimpl
 			StringPaths[index] = path;
 		}
 
-  /// <summary>
+		/// <summary>
-  /// ProcessAll method
+		/// Evalutates all outputs with defined paths. called by S+ when paths are ready to process
-  /// </summary>
+		/// and by Master when file is read.
-  /// <inheritdoc />
+		/// </summary>
 		public virtual void ProcessAll()
 		{
 			if (!LinkedToObject)
@@ -280,9 +277,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
         /// <param name="key"></param>
         /// <param name="theValue"></param>
-  /// <summary>
-  /// USetBoolValue method
-  /// </summary>
 		public void USetBoolValue(ushort key, ushort theValue)
 		{
 			SetBoolValue(key, theValue == 1);
@@ -293,9 +287,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
         /// <param name="key"></param>
         /// <param name="theValue"></param>
-  /// <summary>
-  /// SetBoolValue method
-  /// </summary>
 		public void SetBoolValue(ushort key, bool theValue)
 		{
 			if (BoolPaths.ContainsKey(key))
@@ -307,9 +298,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
         /// <param name="key"></param>
         /// <param name="theValue"></param>
-  /// <summary>
-  /// SetUShortValue method
-  /// </summary>
 		public void SetUShortValue(ushort key, ushort theValue)
 		{
 			if (UshortPaths.ContainsKey(key))
@@ -321,9 +309,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
         /// <param name="key"></param>
         /// <param name="theValue"></param>
-  /// <summary>
-  /// SetStringValue method
-  /// </summary>
 		public void SetStringValue(ushort key, string theValue)
 		{
 			if (StringPaths.ContainsKey(key))
@@ -335,9 +320,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// </summary>
         /// <param name="keyPath"></param>
         /// <param name="valueToSave"></param>
-  /// <summary>
-  /// SetValueOnMaster method
-  /// </summary>
 		public void SetValueOnMaster(string keyPath, JValue valueToSave)
 		{
 			var path = GetFullPath(keyPath);

src/PepperDash.Core/JsonToSimpl/JsonToSimplFileMaster.cs

@@ -20,12 +20,12 @@ namespace PepperDash.Core.JsonToSimpl
         public string Filepath { get; private set; }
 
         /// <summary>
-        /// Gets or sets the ActualFilePath
+        /// Filepath to the actual file that will be read (Portal or local)
         /// </summary>
         public string ActualFilePath { get; private set; }
 
         /// <summary>
-        /// Gets or sets the Filename
+        /// 
         /// </summary>
         public string Filename { get; private set; }
         /// <summary>
@@ -194,9 +194,6 @@ namespace PepperDash.Core.JsonToSimpl
         /// Sets the debug level
         /// </summary>
         /// <param name="level"></param>
-        /// <summary>
-        /// setDebugLevel method
-        /// </summary>
         public void setDebugLevel(uint level)
         {
             Debug.SetDebugLevel(level);

src/PepperDash.Core/JsonToSimpl/JsonToSimplFixedPathObject.cs

@@ -2,9 +2,9 @@
 
 namespace PepperDash.Core.JsonToSimpl
 {
- /// <summary>
+    /// <summary>
- /// Represents a JsonToSimplFixedPathObject
+    /// 
- /// </summary>
+    /// </summary>
 	public class JsonToSimplFixedPathObject : JsonToSimplChildObjectBase
 	{
         /// <summary>

src/PepperDash.Core/JsonToSimpl/JsonToSimplGenericMaster.cs

@@ -5,9 +5,9 @@ using Newtonsoft.Json.Linq;
 
 namespace PepperDash.Core.JsonToSimpl
 {
- /// <summary>
+    /// <summary>
- /// Represents a JsonToSimplGenericMaster
+    /// Generic Master
- /// </summary>
+    /// </summary>
 	public class JsonToSimplGenericMaster : JsonToSimplMaster
     {
 		/*****************************************************************************************/
@@ -20,9 +20,9 @@ namespace PepperDash.Core.JsonToSimpl
 		// To prevent multiple same-file access
 		static object WriteLock = new object();
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the SaveCallback
+        /// Callback action for saving
-  /// </summary>
+        /// </summary>
 		public Action<string> SaveCallback { get; set; }
 
 		/*****************************************************************************************/
@@ -60,9 +60,6 @@ namespace PepperDash.Core.JsonToSimpl
 		/// Loads JSON into JsonObject, but does not trigger evaluation by children
 		/// </summary>
 		/// <param name="json"></param>
-  /// <summary>
-  /// SetJsonWithoutEvaluating method
-  /// </summary>
 		public void SetJsonWithoutEvaluating(string json)
 		{
 			try
@@ -75,10 +72,9 @@ namespace PepperDash.Core.JsonToSimpl
 			}
 		}
 
-  /// <summary>
+		/// <summary>
-  /// Save method
+		/// 
-  /// </summary>
+		/// </summary>
-  /// <inheritdoc />
 		public override void Save()
 		{
 			// this code is duplicated in the other masters!!!!!!!!!!!!!

src/PepperDash.Core/JsonToSimpl/JsonToSimplMaster.cs

@@ -38,9 +38,9 @@ namespace PepperDash.Core.JsonToSimpl
 		/// </summary>
 		public string Key { get { return UniqueID; } }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the UniqueID
+        /// A unique ID
-  /// </summary>
+        /// </summary>
 		public string UniqueID { get; protected set; }
 
 		/// <summary>
@@ -53,9 +53,10 @@ namespace PepperDash.Core.JsonToSimpl
 		}
 		string _DebugName = "";
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the PathPrefix
+		/// This will be prepended to all paths to allow path swapping or for more organized
-  /// </summary>
+		/// sub-paths
+		/// </summary>
 		public string PathPrefix { get; set; }
 
 		/// <summary>
@@ -82,9 +83,9 @@ namespace PepperDash.Core.JsonToSimpl
 			}
 		}
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the JsonObject
+        /// 
-  /// </summary>
+        /// </summary>
 		public JObject JsonObject { get; protected set; }
 
 		/*****************************************************************************************/
@@ -119,9 +120,6 @@ namespace PepperDash.Core.JsonToSimpl
 		/// Adds a child "module" to this master
 		/// </summary>
 		/// <param name="child"></param>
-  /// <summary>
-  /// AddChild method
-  /// </summary>
 		public void AddChild(JsonToSimplChildObjectBase child)
 		{
 			if (!Children.Contains(child))
@@ -130,9 +128,9 @@ namespace PepperDash.Core.JsonToSimpl
 			}
 		}
 
-  /// <summary>
+		/// <summary>
-  /// AddUnsavedValue method
+		/// Called from the child to add changed or new values for saving
-  /// </summary>
+		/// </summary>
 		public void AddUnsavedValue(string path, JValue value)
 		{
 			if (UnsavedValues.ContainsKey(path))
@@ -181,9 +179,6 @@ namespace PepperDash.Core.JsonToSimpl
             /// </summary>
             /// <param name="json"></param>
             /// <returns></returns>
-   /// <summary>
-   /// ParseArray method
-   /// </summary>
 			public static JArray ParseArray(string json)
 			{
 				#if NET6_0

src/PepperDash.Core/JsonToSimpl/JsonToSimplPortalFileMaster.cs

@@ -19,7 +19,7 @@ namespace PepperDash.Core.JsonToSimpl
 		public string PortalFilepath { get; private set; }
 
         /// <summary>
-        /// Gets or sets the ActualFilePath
+        /// File path of the actual file being read (Portal or local)
         /// </summary>
         public string ActualFilePath { get; private set; }
 
@@ -128,9 +128,6 @@ namespace PepperDash.Core.JsonToSimpl
 		/// 
 		/// </summary>
 		/// <param name="level"></param>
-  /// <summary>
-  /// setDebugLevel method
-  /// </summary>
 		public void setDebugLevel(uint level)
 		{
 			Debug.SetDebugLevel(level);

src/PepperDash.Core/Logging/CrestronEnricher.cs

@@ -9,9 +9,6 @@ using System.Threading.Tasks;
 
 namespace PepperDash.Core.Logging
 {
-    /// <summary>
-    /// Represents a CrestronEnricher
-    /// </summary>
     public class CrestronEnricher : ILogEventEnricher
     {
         static readonly string _appName;
@@ -30,9 +27,6 @@ namespace PepperDash.Core.Logging
         }
             
 
-        /// <summary>
-        /// Enrich method
-        /// </summary>
         public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
         {
             var property = propertyFactory.CreateProperty("App", _appName);

src/PepperDash.Core/Logging/DebugConsoleSink.cs

@@ -11,16 +11,10 @@ using System.Text;
 
 namespace PepperDash.Core
 {
-    /// <summary>
-    /// Represents a DebugConsoleSink
-    /// </summary>
     public class DebugConsoleSink : ILogEventSink
     {
         private readonly ITextFormatter _textFormatter;
 
-        /// <summary>
-        /// Emit method
-        /// </summary>
         public void Emit(LogEvent logEvent)
         {
             if (!Debug.IsRunningOnAppliance) return;            
@@ -50,9 +44,6 @@ namespace PepperDash.Core
 
     public static class DebugConsoleSinkExtensions
     {
-        /// <summary>
-        /// DebugConsoleSink method
-        /// </summary>
         public static LoggerConfiguration DebugConsoleSink(
                              this LoggerSinkConfiguration loggerConfiguration,
                                               ITextFormatter formatProvider = null)

src/PepperDash.Core/Logging/DebugContext.cs

@@ -19,9 +19,9 @@ namespace PepperDash.Core
         /// </summary>
         public string Key { get; private set; }
 
-        /// <summary>
+        ///// <summary>
-        /// The name of the file containing the current debug settings.
+        ///// The name of the file containing the current debug settings.
-        /// </summary>
+        ///// </summary>
         //string FileName = string.Format(@"\nvram\debug\app{0}Debug.json", InitialParametersClass.ApplicationNumber);
 
         DebugContextSaveData SaveData;
@@ -38,9 +38,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="key"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetDebugContext method
-        /// </summary>
         public static DebugContext GetDebugContext(string key)
         {
             var context = Contexts.FirstOrDefault(c => c.Key.Equals(key, StringComparison.OrdinalIgnoreCase));
@@ -95,9 +92,6 @@ namespace PepperDash.Core
         /// Callback for console command
         /// </summary>
         /// <param name="levelString"></param>
-        /// <summary>
-        /// SetDebugFromConsole method
-        /// </summary>
         public void SetDebugFromConsole(string levelString)
         {
             try
@@ -120,9 +114,6 @@ namespace PepperDash.Core
         /// Sets the debug level
         /// </summary>
         /// <param name="level"> Valid values 0 (no debug), 1 (critical), 2 (all messages)</param>
-        /// <summary>
-        /// SetDebugLevel method
-        /// </summary>
         public void SetDebugLevel(int level)
         {
             if (level <= 2)
@@ -150,7 +141,7 @@ namespace PepperDash.Core
         }
 
         /// <summary>
-        /// Console method
+        /// Appends a device Key to the beginning of a message
         /// </summary>
         public void Console(uint level, IKeyed dev, string format, params object[] items)
         {
@@ -200,9 +191,6 @@ namespace PepperDash.Core
         /// </summary>
         /// <param name="errorLogLevel"></param>
         /// <param name="str"></param>
-        /// <summary>
-        /// LogError method
-        /// </summary>
         public void LogError(Debug.ErrorLogLevel errorLogLevel, string str)
         {
             string msg = string.Format("App {0}:{1}", InitialParametersClass.ApplicationNumber, str);

src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs

@@ -5,14 +5,8 @@ using Serilog.Events;
 
 namespace PepperDash.Core.Logging
 {
-    /// <summary>
-    /// Represents a DebugCrestronLoggerSink
-    /// </summary>
     public class DebugCrestronLoggerSink : ILogEventSink
     {
-        /// <summary>
-        /// Emit method
-        /// </summary>
         public void Emit(LogEvent logEvent)
         {
             if (!Debug.IsRunningOnAppliance) return;

src/PepperDash.Core/Logging/DebugErrorLogSink.cs

@@ -11,9 +11,6 @@ using System.Threading.Tasks;
 
 namespace PepperDash.Core.Logging
 {
-    /// <summary>
-    /// Represents a DebugErrorLogSink
-    /// </summary>
     public class DebugErrorLogSink : ILogEventSink
     {
         private ITextFormatter _formatter;
@@ -27,9 +24,6 @@ namespace PepperDash.Core.Logging
             {LogEventLevel.Error, (msg) => ErrorLog.Error(msg) },
             {LogEventLevel.Fatal, (msg) => ErrorLog.Error(msg) }
         };
-        /// <summary>
-        /// Emit method
-        /// </summary>
         public void Emit(LogEvent logEvent)
         {
             string message;

src/PepperDash.Core/Logging/DebugExtensions.cs

@@ -1,113 +1,74 @@
-using System;
+using Serilog.Events;
-using Serilog.Events;
+using System;
 using Log = PepperDash.Core.Debug;
 
 namespace PepperDash.Core.Logging
 {
     public static class DebugExtensions
     {
-        /// <summary>
-        /// LogException method
-        /// </summary>
         public static void LogException(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogMessage(ex, message, device: device, args);
+            Log.LogMessage(ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogVerbose method
-        /// </summary>
         public static void LogVerbose(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogVerbose(ex, device, message, args);
+            Log.LogMessage(LogEventLevel.Verbose, ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogVerbose method
-        /// </summary>
         public static void LogVerbose(this IKeyed device, string message, params object[] args)
         {
-            Log.LogVerbose(device, message, args);
+            Log.LogMessage(LogEventLevel.Verbose, device, message, args);
         }
 
-        /// <summary>
-        /// LogDebug method
-        /// </summary>
         public static void LogDebug(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogDebug(ex, device, message, args);
+            Log.LogMessage(LogEventLevel.Debug, ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogDebug method
-        /// </summary>
         public static void LogDebug(this IKeyed device, string message, params object[] args)
         {
-            Log.LogDebug(device, message, args);
+            Log.LogMessage(LogEventLevel.Debug, device, message, args);
         }
 
-        /// <summary>
-        /// LogInformation method
-        /// </summary>
         public static void LogInformation(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogInformation(ex, device, message, args);
+            Log.LogMessage(LogEventLevel.Information, ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogInformation method
-        /// </summary>
         public static void LogInformation(this IKeyed device, string message, params object[] args)
         {
-            Log.LogInformation(device, message, args);
+            Log.LogMessage(LogEventLevel.Information, device, message, args);
         }
 
-        /// <summary>
-        /// LogWarning method
-        /// </summary>
         public static void LogWarning(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogWarning(ex, device, message, args);
+            Log.LogMessage(LogEventLevel.Warning, ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogWarning method
-        /// </summary>
         public static void LogWarning(this IKeyed device, string message, params object[] args)
         {
-            Log.LogWarning(device, message, args);
+            Log.LogMessage(LogEventLevel.Warning, device, message, args);
         }
 
-        /// <summary>
-        /// LogError method
-        /// </summary>
         public static void LogError(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogError(ex, device, message, args);
+            Log.LogMessage(LogEventLevel.Error, ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogError method
-        /// </summary>
         public static void LogError(this IKeyed device, string message, params object[] args)
         {
-            Log.LogError(device, message, args);
+            Log.LogMessage(LogEventLevel.Error, device, message, args);
         }
 
-        /// <summary>
-        /// LogFatal method
-        /// </summary>
         public static void LogFatal(this IKeyed device, Exception ex, string message, params object[] args)
         {
-            Log.LogFatal(ex, device, message, args);
+            Log.LogMessage(LogEventLevel.Fatal, ex, message, device, args);
         }
 
-        /// <summary>
-        /// LogFatal method
-        /// </summary>
         public static void LogFatal(this IKeyed device, string message, params object[] args)
         {
-            Log.LogFatal(device, message, args);
+            Log.LogMessage(LogEventLevel.Fatal, device, message, args);
         }
     }
 }

src/PepperDash.Core/Logging/DebugMemory.cs

@@ -4,9 +4,9 @@ using Newtonsoft.Json;
 
 namespace PepperDash.Core.Logging
 {
- /// <summary>
+    /// <summary>
- /// Represents a DebugContextCollection
+    /// Class to persist current Debug settings across program restarts
- /// </summary>
+    /// </summary>
 	public class DebugContextCollection
 	{
         /// <summary>
@@ -39,9 +39,6 @@ namespace PepperDash.Core.Logging
 		/// </summary>
 		/// <param name="contextKey"></param>
 		/// <param name="level"></param>
-  /// <summary>
-  /// SetLevel method
-  /// </summary>
 		public void SetLevel(string contextKey, int level)
 		{
 			if (level < 0 || level > 2)
@@ -54,9 +51,6 @@ namespace PepperDash.Core.Logging
 		/// </summary>
 		/// <param name="contextKey"></param>
 		/// <returns></returns>
-  /// <summary>
-  /// GetOrCreateItem method
-  /// </summary>
 		public DebugContextItem GetOrCreateItem(string contextKey)
 		{
 			if (!_items.ContainsKey(contextKey))
@@ -71,9 +65,6 @@ namespace PepperDash.Core.Logging
         /// <param name="deviceKey"></param>
         /// <param name="settings"></param>
         /// <returns></returns>
-        /// <summary>
-        /// SetDebugSettingsForKey method
-        /// </summary>
         public void SetDebugSettingsForKey(string deviceKey, object settings)
         {
             try
@@ -98,9 +89,6 @@ namespace PepperDash.Core.Logging
         /// </summary>
         /// <param name="deviceKey"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetDebugSettingsForKey method
-        /// </summary>
         public object GetDebugSettingsForKey(string deviceKey)
         {
             return DeviceDebugSettings[deviceKey];

src/PepperDash.Core/Logging/DebugWebsocketSink.cs

@@ -21,9 +21,6 @@ using Serilog.Formatting.Json;
 
 namespace PepperDash.Core
 {
-    /// <summary>
-    /// Represents a DebugWebsocketSink
-    /// </summary>
     public class DebugWebsocketSink : ILogEventSink
     {
         private HttpServer _httpsServer;
@@ -50,9 +47,6 @@ namespace PepperDash.Core
             }
         }
 
-        /// <summary>
-        /// Gets or sets the IsRunning
-        /// </summary>
         public bool IsRunning { get => _httpsServer?.IsListening ?? false; }
         
 
@@ -111,9 +105,6 @@ namespace PepperDash.Core
             }
         }
 
-        /// <summary>
-        /// Emit method
-        /// </summary>
         public void Emit(LogEvent logEvent)
         {
             if (_httpsServer == null || !_httpsServer.IsListening) return;
@@ -125,9 +116,6 @@ namespace PepperDash.Core
 
         }
 
-        /// <summary>
-        /// StartServerAndSetPort method
-        /// </summary>
         public void StartServerAndSetPort(int port)
         {
             Debug.Console(0, "Starting Websocket Server on port: {0}", port);
@@ -205,9 +193,6 @@ namespace PepperDash.Core
             }
         }
 
-        /// <summary>
-        /// StopServer method
-        /// </summary>
         public void StopServer()
         {
             Debug.Console(0, "Stopping Websocket Server");
@@ -219,9 +204,6 @@ namespace PepperDash.Core
 
     public static class DebugWebsocketSinkExtensions
     {
-        /// <summary>
-        /// DebugWebsocketSink method
-        /// </summary>
         public static LoggerConfiguration DebugWebsocketSink(
                              this LoggerSinkConfiguration loggerConfiguration,
                                               ITextFormatter formatProvider = null)
@@ -230,9 +212,6 @@ namespace PepperDash.Core
         }
     }
 
-    /// <summary>
-    /// Represents a DebugClient
-    /// </summary>
     public class DebugClient : WebSocketBehavior
     {
         private DateTime _connectionTime;

src/PepperDash.Core/PasswordManagement/PasswordClient.cs

@@ -2,9 +2,9 @@
 
 namespace PepperDash.Core.PasswordManagement
 {
- /// <summary>
+    /// <summary>
- /// Represents a PasswordClient
+    /// A class to allow user interaction with the PasswordManager
- /// </summary>
+    /// </summary>
 	public class PasswordClient
 	{
 		/// <summary>
@@ -59,9 +59,6 @@ namespace PepperDash.Core.PasswordManagement
 		/// Retrieve password by index
 		/// </summary>
 		/// <param name="key"></param>
-  /// <summary>
-  /// GetPasswordByIndex method
-  /// </summary>
 		public void GetPasswordByIndex(ushort key)
 		{
 			OnUshrtChange((ushort)PasswordManager.Passwords.Count, 0, PasswordManagementConstants.PasswordManagerCountChange);
@@ -84,9 +81,6 @@ namespace PepperDash.Core.PasswordManagement
 		/// Password validation method
 		/// </summary>
 		/// <param name="password"></param>
-  /// <summary>
-  /// ValidatePassword method
-  /// </summary>
 		public void ValidatePassword(string password)
 		{
 			if (string.IsNullOrEmpty(password))
@@ -105,9 +99,6 @@ namespace PepperDash.Core.PasswordManagement
 		/// password against the selected password when the length of the 2 are equal
 		/// </summary>
 		/// <param name="data"></param>
-  /// <summary>
-  /// BuildPassword method
-  /// </summary>
 		public void BuildPassword(string data)
 		{
 			PasswordToValidate = String.Concat(PasswordToValidate, data);
@@ -117,9 +108,9 @@ namespace PepperDash.Core.PasswordManagement
 				ValidatePassword(PasswordToValidate);
 		}
 
-  /// <summary>
+		/// <summary>
-  /// ClearPassword method
+		/// Clears the user entered password and resets the LEDs
-  /// </summary>
+		/// </summary>
 		public void ClearPassword()
 		{
 			PasswordToValidate = "";

src/PepperDash.Core/PasswordManagement/PasswordManager.cs

@@ -4,9 +4,9 @@ using Crestron.SimplSharp;
 
 namespace PepperDash.Core.PasswordManagement
 {
- /// <summary>
+    /// <summary>
- /// Represents a PasswordManager
+    /// Allows passwords to be stored and managed
- /// </summary>
+    /// </summary>
 	public class PasswordManager
 	{
 		/// <summary>
@@ -71,9 +71,6 @@ namespace PepperDash.Core.PasswordManagement
 		/// </summary>
 		/// <param name="key"></param>
 		/// <param name="password"></param>
-  /// <summary>
-  /// UpdatePassword method
-  /// </summary>
 		public void UpdatePassword(ushort key, string password)
 		{
 			// validate the parameters
@@ -155,9 +152,6 @@ namespace PepperDash.Core.PasswordManagement
 		/// Method to change the default timer value, (default 5000ms/5s)
 		/// </summary>
 		/// <param name="time"></param>
-  /// <summary>
-  /// PasswordTimerMs method
-  /// </summary>
 		public void PasswordTimerMs(ushort time)
 		{
 			PasswordTimerElapsedMs = Convert.ToInt64(time);

src/PepperDash.Core/SystemInfo/EventArgs and Constants.cs

@@ -68,9 +68,9 @@ namespace PepperDash.Core.SystemInfo
         public const ushort ProgramConfigChange = 305;
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a ProcessorChangeEventArgs
+	/// Processor Change Event Args Class
- /// </summary>
+	/// </summary>
 	public class ProcessorChangeEventArgs : EventArgs
 	{
         /// <summary>
@@ -114,9 +114,9 @@ namespace PepperDash.Core.SystemInfo
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a EthernetChangeEventArgs
+	/// Ethernet Change Event Args Class
- /// </summary>
+	/// </summary>
 	public class EthernetChangeEventArgs : EventArgs
 	{
         /// <summary>
@@ -165,9 +165,9 @@ namespace PepperDash.Core.SystemInfo
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a ControlSubnetChangeEventArgs
+	/// Control Subnet Chage Event Args Class
- /// </summary>
+	/// </summary>
 	public class ControlSubnetChangeEventArgs : EventArgs
 	{
         /// <summary>
@@ -211,9 +211,9 @@ namespace PepperDash.Core.SystemInfo
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a ProgramChangeEventArgs
+	/// Program Change Event Args Class
- /// </summary>
+	/// </summary>
 	public class ProgramChangeEventArgs : EventArgs
 	{
         /// <summary>

src/PepperDash.Core/SystemInfo/SystemInfoToSimpl.cs

@@ -100,9 +100,9 @@ namespace PepperDash.Core.SystemInfo
 			OnBoolChange(false, 0, SystemInfoConstants.BusyBoolChange);
 		}
 
-  /// <summary>
+		/// <summary>
-  /// GetEthernetInfo method
+		/// Gets the current ethernet info
-  /// </summary>
+		/// </summary>
 		public void GetEthernetInfo()
 		{
 			OnBoolChange(true, 0, SystemInfoConstants.BusyBoolChange);
@@ -161,9 +161,9 @@ namespace PepperDash.Core.SystemInfo
 			OnBoolChange(false, 0, SystemInfoConstants.BusyBoolChange);
 		}
 
-  /// <summary>
+		/// <summary>
-  /// GetControlSubnetInfo method
+		/// Gets the current control subnet info
-  /// </summary>
+		/// </summary>
 		public void GetControlSubnetInfo()
 		{
 			OnBoolChange(true, 0, SystemInfoConstants.BusyBoolChange);
@@ -206,9 +206,6 @@ namespace PepperDash.Core.SystemInfo
 		/// Gets the program info by index
 		/// </summary>
 		/// <param name="index"></param>
-  /// <summary>
-  /// GetProgramInfoByIndex method
-  /// </summary>
 		public void GetProgramInfoByIndex(ushort index)
 		{
 			if (index < 1 || index > 10)
@@ -266,9 +263,9 @@ namespace PepperDash.Core.SystemInfo
 			OnBoolChange(false, 0, SystemInfoConstants.BusyBoolChange);
 		}
 
-  /// <summary>
+		/// <summary>
-  /// RefreshProcessorUptime method
+		/// Gets the processor uptime and passes it to S+
-  /// </summary>
+		/// </summary>
 		public void RefreshProcessorUptime()
 		{
 			try
@@ -290,9 +287,6 @@ namespace PepperDash.Core.SystemInfo
 		/// Gets the program uptime, by index, and passes it to S+
 		/// </summary>
 		/// <param name="index"></param>
-  /// <summary>
-  /// RefreshProgramUptimeByIndex method
-  /// </summary>
 		public void RefreshProgramUptimeByIndex(int index)
 		{
 			try
@@ -314,9 +308,6 @@ namespace PepperDash.Core.SystemInfo
 		/// Sends command to console, passes response back using string change event
 		/// </summary>
 		/// <param name="cmd"></param>
-  /// <summary>
-  /// SendConsoleCommand method
-  /// </summary>
 		public void SendConsoleCommand(string cmd)
 		{
 			if (string.IsNullOrEmpty(cmd))

src/PepperDash.Core/Web/BouncyCertificate.cs

@@ -35,9 +35,6 @@ namespace PepperDash.Core
             return issuerCertificate;
         }
 
-        /// <summary>
-        /// IssueCertificate method
-        /// </summary>
         public X509Certificate2 IssueCertificate(string subjectName, X509Certificate2 issuerCertificate, string[] subjectAlternativeNames, KeyPurposeID[] usages)
         {
             // It's self-signed, so these are the same.
@@ -59,9 +56,6 @@ namespace PepperDash.Core
             return ConvertCertificate(certificate, subjectKeyPair, random);
         }
 
-        /// <summary>
-        /// CreateCertificateAuthorityCertificate method
-        /// </summary>
         public X509Certificate2 CreateCertificateAuthorityCertificate(string subjectName, string[] subjectAlternativeNames, KeyPurposeID[] usages)
         {
             // It's self-signed, so these are the same.
@@ -84,9 +78,6 @@ namespace PepperDash.Core
             return ConvertCertificate(certificate, subjectKeyPair, random);
         }
 
-        /// <summary>
-        /// CreateSelfSignedCertificate method
-        /// </summary>
         public X509Certificate2 CreateSelfSignedCertificate(string subjectName, string[] subjectAlternativeNames, KeyPurposeID[] usages)
         {
             // It's self-signed, so these are the same.
@@ -314,9 +305,6 @@ namespace PepperDash.Core
             return convertedCertificate;
         }
 
-        /// <summary>
-        /// WriteCertificate method
-        /// </summary>
         public void WriteCertificate(X509Certificate2 certificate, string outputDirectory, string certName)
         {
             // This password is the one attached to the PFX file. Use 'null' for no password.
@@ -344,9 +332,6 @@ namespace PepperDash.Core
                 }
             }
         }
-        /// <summary>
-        /// AddCertToStore method
-        /// </summary>
         public bool AddCertToStore(X509Certificate2 cert, System.Security.Cryptography.X509Certificates.StoreName st, System.Security.Cryptography.X509Certificates.StoreLocation sl)
         {
             bool bRet = false;

src/PepperDash.Core/Web/RequestHandlers/DefaultRequestHandler.cs

@@ -2,9 +2,9 @@
 
 namespace PepperDash.Core.Web.RequestHandlers
 {
- /// <summary>
+	/// <summary>
- /// Represents a DefaultRequestHandler
+	/// Web API default request handler
- /// </summary>
+	/// </summary>
 	public class DefaultRequestHandler : WebApiBaseRequestHandler
 	{
 		/// <summary>

src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs

@@ -142,9 +142,6 @@ namespace PepperDash.Core.Web.RequestHandlers
         /// Process request
         /// </summary>
         /// <param name="context"></param>
-        /// <summary>
-        /// ProcessRequest method
-        /// </summary>
         public void ProcessRequest(HttpCwsContext context)
         {
             if (!_handlers.TryGetValue(context.Request.HttpMethod, out Func<HttpCwsContext, Task> handler))

src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs

@@ -144,9 +144,6 @@ namespace PepperDash.Core.Web.RequestHandlers
 		/// Process request
 		/// </summary>
 		/// <param name="context"></param>
-  /// <summary>
-  /// ProcessRequest method
-  /// </summary>
 		public void ProcessRequest(HttpCwsContext context)
 		{
 			Action<HttpCwsContext> handler;

src/PepperDash.Core/Web/WebApiServer.cs

@@ -25,24 +25,24 @@ namespace PepperDash.Core.Web
 		private readonly CCriticalSection _serverLock = new CCriticalSection();
 		private HttpCwsServer _server;
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Key
+		/// Web API server key
-  /// </summary>
+		/// </summary>
 		public string Key { get; private set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the Name
+		/// Web API server name
-  /// </summary>
+		/// </summary>
 		public string Name { get; private set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the BasePath
+		/// CWS base path, will default to "/api" if not set via initialize method
-  /// </summary>
+		/// </summary>
 		public string BasePath { get; private set; }
 
-  /// <summary>
+		/// <summary>
-  /// Gets or sets the IsRegistered
+		/// Indicates CWS is registered with base path
-  /// </summary>
+		/// </summary>
 		public bool IsRegistered { get; private set; }
 
 		/// <summary>
@@ -137,9 +137,9 @@ namespace PepperDash.Core.Web
 			Start();
 		}
 
-  /// <summary>
+		/// <summary>
-  /// Initialize method
+		/// Initializes CWS class
-  /// </summary>
+		/// </summary>
 		public void Initialize(string key, string basePath)
 		{
 			Key = key;
@@ -165,9 +165,6 @@ namespace PepperDash.Core.Web
 		/// Removes a route from CWS
 		/// </summary>
 		/// <param name="route"></param>
-  /// <summary>
-  /// RemoveRoute method
-  /// </summary>
 		public void RemoveRoute(HttpCwsRoute route)
 		{
 			if (route == null)
@@ -179,9 +176,9 @@ namespace PepperDash.Core.Web
 			_server.Routes.Remove(route);
 		}
 
-  /// <summary>
+		/// <summary>
-  /// GetRouteCollection method
+		/// Returns a list of the current routes
-  /// </summary>
+		/// </summary>
 		public HttpCwsRouteCollection GetRouteCollection()
 		{
 			return _server.Routes;
@@ -225,9 +222,9 @@ namespace PepperDash.Core.Web
 			}
 		}
 
-  /// <summary>
+		/// <summary>
-  /// Stop method
+		/// Stop CWS instance
-  /// </summary>
+		/// </summary>
 		public void Stop()
 		{
 			try

src/PepperDash.Core/WebApi/Presets/Preset.cs

@@ -2,9 +2,9 @@
 
 namespace PepperDash.Core.WebApi.Presets
 {
- /// <summary>
+    /// <summary>
- /// Represents a Preset
+    /// Represents a preset
- /// </summary>
+    /// </summary>
 	public class Preset
 	{
         /// <summary>
@@ -12,29 +12,29 @@ namespace PepperDash.Core.WebApi.Presets
         /// </summary>
 		public int Id { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the UserId
+        /// User ID
-  /// </summary>
+        /// </summary>
 		public int UserId { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the RoomTypeId
+        /// Room Type ID
-  /// </summary>
+        /// </summary>
 		public int RoomTypeId { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the PresetName
+        /// Preset Name
-  /// </summary>
+        /// </summary>
 		public string PresetName { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the PresetNumber
+        /// Preset Number
-  /// </summary>
+        /// </summary>
 		public int PresetNumber { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the Data
+        /// Preset Data
-  /// </summary>
+        /// </summary>
 		public string Data { get; set; }
 
         /// <summary>
@@ -48,9 +48,9 @@ namespace PepperDash.Core.WebApi.Presets
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a PresetReceivedEventArgs
+	/// 
- /// </summary>
+	/// </summary>
 	public class PresetReceivedEventArgs : EventArgs
 	{
         /// <summary>
@@ -59,12 +59,12 @@ namespace PepperDash.Core.WebApi.Presets
         public bool LookupSuccess { get; private set; }
         
         /// <summary>
-        /// Gets or sets the ULookupSuccess
+        /// S+ helper
         /// </summary>
         public ushort ULookupSuccess { get { return (ushort)(LookupSuccess ? 1 : 0); } }
 
         /// <summary>
-        /// Gets or sets the Preset
+        /// The preset
         /// </summary>
         public Preset Preset { get; private set; }
 

src/PepperDash.Core/WebApi/Presets/User.cs

@@ -16,19 +16,19 @@ namespace PepperDash.Core.WebApi.Presets
         /// </summary>
 		public int Id { get; set; }
 		
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the ExternalId
+        /// 
-  /// </summary>
+        /// </summary>
 		public string ExternalId { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the FirstName
+        /// 
-  /// </summary>
+        /// </summary>
 		public string FirstName { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the LastName
+        /// 
-  /// </summary>
+        /// </summary>
 		public string LastName { get; set; }
 	}
 
@@ -44,13 +44,13 @@ namespace PepperDash.Core.WebApi.Presets
         public bool LookupSuccess { get; private set; }
 
         /// <summary>
-        /// Gets or sets the ULookupSuccess
+        /// For stupid S+
         /// </summary>
         public ushort ULookupSuccess { get { return (ushort)(LookupSuccess ? 1 : 0); } }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the User
+        /// 
-  /// </summary>
+        /// </summary>
 		public User User { get; private set; }
 
 		/// <summary>
@@ -70,9 +70,9 @@ namespace PepperDash.Core.WebApi.Presets
 		}
 	}
 
- /// <summary>
+	/// <summary>
- /// Represents a UserAndRoomMessage
+	/// 
- /// </summary>
+	/// </summary>
 	public class UserAndRoomMessage
 	{
         /// <summary>
@@ -80,14 +80,14 @@ namespace PepperDash.Core.WebApi.Presets
         /// </summary>
 		public int UserId { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the RoomTypeId
+        /// 
-  /// </summary>
+        /// </summary>
 		public int RoomTypeId { get; set; }
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the PresetNumber
+        /// 
-  /// </summary>
+        /// </summary>
 		public int PresetNumber { get; set; }
 	}
 }

src/PepperDash.Core/WebApi/Presets/WebApiPasscodeClient.cs

@@ -25,9 +25,9 @@ namespace PepperDash.Core.WebApi.Presets
         /// </summary>
 		public event EventHandler<PresetReceivedEventArgs> PresetReceived;
 
-  /// <summary>
+        /// <summary>
-  /// Gets or sets the Key
+        /// Unique identifier for this instance
-  /// </summary>
+        /// </summary>
 		public string Key { get; private set; }
 
 		//string JsonMasterKey;
@@ -77,9 +77,6 @@ namespace PepperDash.Core.WebApi.Presets
         /// Gets the user for a passcode
         /// </summary>
         /// <param name="passcode"></param>
-  /// <summary>
-  /// GetUserForPasscode method
-  /// </summary>
 		public void GetUserForPasscode(string passcode)
 		{
             // Bullshit duplicate code here... These two cases should be the same 
@@ -118,9 +115,6 @@ namespace PepperDash.Core.WebApi.Presets
 		/// </summary>
 		/// <param name="roomTypeId"></param>
 		/// <param name="presetNumber"></param>
-  /// <summary>
-  /// GetPresetForThisUser method
-  /// </summary>
 		public void GetPresetForThisUser(int roomTypeId, int presetNumber)
 		{
 			if (CurrentUser == null)
@@ -218,9 +212,6 @@ namespace PepperDash.Core.WebApi.Presets
 		/// </summary>
 		/// <param name="roomTypeId"></param>
 		/// <param name="presetNumber"></param>
-  /// <summary>
-  /// SavePresetForThisUser method
-  /// </summary>
 		public void SavePresetForThisUser(int roomTypeId, int presetNumber)
 		{
 			if (CurrentPreset == null)

src/PepperDash.Core/XSigUtility/Tokens/XSigAnalogToken.cs

@@ -59,9 +59,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// </summary>
         /// <param name="offset"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetTokenWithOffset method
-        /// </summary>
         public override XSigToken GetTokenWithOffset(int offset)
         {
             if (offset == 0) return this;
@@ -72,10 +69,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// 
         /// </summary>
         /// <returns></returns>
-        /// <summary>
-        /// ToString method
-        /// </summary>
-        /// <inheritdoc />
         public override string ToString()
         {
             return Index + " = 0x" + Value.ToString("X4");
@@ -87,9 +80,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// <param name="format"></param>
         /// <param name="formatProvider"></param>
         /// <returns></returns>
-        /// <summary>
-        /// ToString method
-        /// </summary>
         public string ToString(string format, IFormatProvider formatProvider)
         {
             return Value.ToString(format, formatProvider);

src/PepperDash.Core/XSigUtility/Tokens/XSigDigitalToken.cs

@@ -57,9 +57,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// </summary>
         /// <param name="offset"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetTokenWithOffset method
-        /// </summary>
         public override XSigToken GetTokenWithOffset(int offset)
         {
             if (offset == 0) return this;
@@ -70,10 +67,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// 
         /// </summary>
         /// <returns></returns>
-        /// <summary>
-        /// ToString method
-        /// </summary>
-        /// <inheritdoc />
         public override string ToString()
         {
             return Index + " = " + (Value ? "High" : "Low");
@@ -84,9 +77,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// </summary>
         /// <param name="formatProvider"></param>
         /// <returns></returns>
-        /// <summary>
-        /// ToString method
-        /// </summary>
         public string ToString(IFormatProvider formatProvider)
         {
             return Value.ToString(formatProvider);

src/PepperDash.Core/XSigUtility/Tokens/XSigSerialToken.cs

@@ -63,9 +63,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// </summary>
         /// <param name="offset"></param>
         /// <returns></returns>
-        /// <summary>
-        /// GetTokenWithOffset method
-        /// </summary>
         public override XSigToken GetTokenWithOffset(int offset)
         {
             if (offset == 0) return this;
@@ -76,10 +73,6 @@ namespace PepperDash.Core.Intersystem.Tokens
         /// 
         /// </summary>
         /// <returns></returns>
-        /// <summary>
-        /// ToString method
-        /// </summary>
-        /// <inheritdoc />
         public override string ToString()
         {
             return Index + " = \"" + Value + "\"";

src/PepperDash.Core/XSigUtility/XSigHelpers.cs

@@ -52,9 +52,6 @@ namespace PepperDash.Core.Intersystem
         /// </summary>
         /// <param name="xSigSerialization">XSig state resolver.</param>
         /// <returns>Bytes in XSig format for each token within the state representation.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(IXSigSerialization xSigSerialization)
         {
             return GetBytes(xSigSerialization, 0);
@@ -66,9 +63,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="xSigSerialization">XSig state resolver.</param>
         /// <param name="offset">Offset to which the data will be aligned.</param>
         /// <returns>Bytes in XSig format for each token within the state representation.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(IXSigSerialization xSigSerialization, int offset)
         {
             var tokens = xSigSerialization.Serialize();
@@ -88,9 +82,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="index">1-based digital index</param>
         /// <param name="value">Digital data to be encoded</param>
         /// <returns>Bytes in XSig format for digtial information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int index, bool value)
         {
             return GetBytes(index, 0, value);
@@ -103,9 +94,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="offset">Index offset.</param>
         /// <param name="value">Digital data to be encoded</param>
         /// <returns>Bytes in XSig format for digtial information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int index, int offset, bool value)
         {
             return new XSigDigitalToken(index + offset, value).GetBytes();
@@ -117,9 +105,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="startIndex">Starting index of the sequence.</param>
         /// <param name="values">Digital signal value array.</param>
         /// <returns>Byte sequence in XSig format for digital signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int startIndex, bool[] values)
         {
             return GetBytes(startIndex, 0, values);
@@ -132,9 +117,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="offset">Index offset.</param>
         /// <param name="values">Digital signal value array.</param>
         /// <returns>Byte sequence in XSig format for digital signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int startIndex, int offset, bool[] values)
         {
             // Digital XSig data is 2 bytes per value
@@ -152,9 +134,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="index">1-based analog index</param>
         /// <param name="value">Analog data to be encoded</param>
         /// <returns>Bytes in XSig format for analog signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int index, ushort value)
         {
             return GetBytes(index, 0, value);
@@ -167,9 +146,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="offset">Index offset.</param>
         /// <param name="value">Analog data to be encoded</param>
         /// <returns>Bytes in XSig format for analog signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int index, int offset, ushort value)
         {
             return new XSigAnalogToken(index + offset, value).GetBytes();
@@ -181,9 +157,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="startIndex">Starting index of the sequence.</param>
         /// <param name="values">Analog signal value array.</param>
         /// <returns>Byte sequence in XSig format for analog signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int startIndex, ushort[] values)
         {
             return GetBytes(startIndex, 0, values);
@@ -196,9 +169,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="offset">Index offset.</param>
         /// <param name="values">Analog signal value array.</param>
         /// <returns>Byte sequence in XSig format for analog signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int startIndex, int offset, ushort[] values)
         {
             // Analog XSig data is 4 bytes per value
@@ -216,9 +186,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="index">1-based serial index</param>
         /// <param name="value">Serial data to be encoded</param>
         /// <returns>Bytes in XSig format for serial signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int index, string value)
         {
             return GetBytes(index, 0, value);
@@ -231,9 +198,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="offset">Index offset.</param>
         /// <param name="value">Serial data to be encoded</param>
         /// <returns>Bytes in XSig format for serial signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int index, int offset, string value)
         {
             return new XSigSerialToken(index + offset, value).GetBytes();
@@ -245,9 +209,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="startIndex">Starting index of the sequence.</param>
         /// <param name="values">Serial signal value array.</param>
         /// <returns>Byte sequence in XSig format for serial signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int startIndex, string[] values)
         {
             return GetBytes(startIndex, 0, values);
@@ -260,9 +221,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="offset">Index offset.</param>
         /// <param name="values">Serial signal value array.</param>
         /// <returns>Byte sequence in XSig format for serial signal information.</returns>
-        /// <summary>
-        /// GetBytes method
-        /// </summary>
         public static byte[] GetBytes(int startIndex, int offset, string[] values)
         {
             // Serial XSig data is not fixed-length like the other formats

src/PepperDash.Core/XSigUtility/XSigTokenStreamReader.cs

@@ -48,9 +48,6 @@ namespace PepperDash.Core.Intersystem
         /// <param name="stream">Input stream</param>
         /// <param name="value">Result</param>
         /// <returns>True if successful, otherwise false.</returns>
-        /// <summary>
-        /// TryReadUInt16BE method
-        /// </summary>
         public static bool TryReadUInt16BE(Stream stream, out ushort value)
         {
             value = 0;
@@ -68,9 +65,6 @@ namespace PepperDash.Core.Intersystem
         /// </summary>
         /// <returns>XSigToken</returns>
         /// <exception cref="ArgumentOutOfRangeException">Offset is less than 0.</exception>
-        /// <summary>
-        /// ReadXSigToken method
-        /// </summary>
         public XSigToken ReadXSigToken()
         {
             ushort prefix;
@@ -120,9 +114,6 @@ namespace PepperDash.Core.Intersystem
         /// Reads all available XSig tokens from the stream.
         /// </summary>
         /// <returns>XSigToken collection.</returns>
-        /// <summary>
-        /// ReadAllXSigTokens method
-        /// </summary>
         public IEnumerable<XSigToken> ReadAllXSigTokens()
         {
             var tokens = new List<XSigToken>();

src/PepperDash.Core/XSigUtility/XSigTokenStreamWriter.cs

@@ -47,9 +47,6 @@ namespace PepperDash.Core.Intersystem
         /// Write XSig data gathered from an IXSigStateResolver to the stream.
         /// </summary>
         /// <param name="xSigSerialization">IXSigStateResolver object.</param>
-        /// <summary>
-        /// WriteXSigData method
-        /// </summary>
         public void WriteXSigData(IXSigSerialization xSigSerialization)
         {
             WriteXSigData(xSigSerialization, 0);
@@ -60,9 +57,6 @@ namespace PepperDash.Core.Intersystem
         /// </summary>
         /// <param name="xSigSerialization">IXSigStateResolver object.</param>
         /// <param name="offset">Index offset for each XSigToken.</param>
-        /// <summary>
-        /// WriteXSigData method
-        /// </summary>
         public void WriteXSigData(IXSigSerialization xSigSerialization, int offset)
         {
             if (xSigSerialization == null)
@@ -76,9 +70,6 @@ namespace PepperDash.Core.Intersystem
         /// Write XSigToken to the stream.
         /// </summary>
         /// <param name="token">XSigToken object.</param>
-        /// <summary>
-        /// WriteXSigData method
-        /// </summary>
         public void WriteXSigData(XSigToken token)
         {
             WriteXSigData(token, 0);
@@ -89,9 +80,6 @@ namespace PepperDash.Core.Intersystem
         /// </summary>
         /// <param name="token">XSigToken object.</param>
         /// <param name="offset">Index offset for each XSigToken.</param>
-        /// <summary>
-        /// WriteXSigData method
-        /// </summary>
         public void WriteXSigData(XSigToken token, int offset)
         {
             WriteXSigData(new[] { token }, offset);
@@ -120,9 +108,6 @@ namespace PepperDash.Core.Intersystem
         /// </summary>
         /// <param name="tokens">XSigToken objects.</param>
         /// <param name="offset">Index offset for each XSigToken.</param>
-        /// <summary>
-        /// WriteXSigData method
-        /// </summary>
         public void WriteXSigData(IEnumerable<XSigToken> tokens, int offset)
         {
             if (offset < 0)
@@ -140,7 +125,7 @@ namespace PepperDash.Core.Intersystem
         }
 
         /// <summary>
-        /// Dispose method
+        /// Disposes of the internal stream if specified to not leave open.
         /// </summary>
         public void Dispose()
         {

src/PepperDash.Essentials.Core/Bridges/BridgeBase.cs

@@ -2,12 +2,14 @@
 
 using System;
 using System.Collections.Generic;
-using System.Reflection;
 using Crestron.SimplSharp;
+using System.Reflection;
 using Crestron.SimplSharpPro;
 using Crestron.SimplSharpPro.DeviceSupport;
 using Crestron.SimplSharpPro.EthernetCommunication;
+
 using Newtonsoft.Json;
+
 using PepperDash.Core;
 using PepperDash.Essentials.Core.Config;
 using Serilog.Events;
@@ -29,7 +31,7 @@ namespace PepperDash.Essentials.Core.Bridges
     }
 
     /// <summary>
-    /// Represents a EiscApiAdvanced
+    /// Bridge API using EISC
     /// </summary>
     public class EiscApiAdvanced : BridgeApi, ICommunicationMonitor
     {
@@ -58,19 +60,12 @@ namespace PepperDash.Essentials.Core.Bridges
             AddPostActivationAction(RegisterEisc);
         }
 
-        /// <summary>
-        /// CustomActivate method
-        /// </summary>
-        /// <inheritdoc />
         public override bool CustomActivate()
         {
             CommunicationMonitor.Start();
             return base.CustomActivate();
         }
 
-        /// <summary>
-        /// Deactivate method
-        /// </summary>
         public override bool Deactivate()
         {
             CommunicationMonitor.Stop();
@@ -128,9 +123,6 @@ namespace PepperDash.Essentials.Core.Bridges
             Debug.LogMessage(LogEventLevel.Debug, this, "EISC registration successful");
         }
 
-        /// <summary>
-        /// LinkRooms method
-        /// </summary>
         public void LinkRooms()
         {
             Debug.LogMessage(LogEventLevel.Debug, this, "Linking Rooms...");
@@ -161,9 +153,6 @@ namespace PepperDash.Essentials.Core.Bridges
         /// </summary>
         /// <param name="deviceKey"></param>
         /// <param name="joinMap"></param>
-        /// <summary>
-        /// AddJoinMap method
-        /// </summary>
         public void AddJoinMap(string deviceKey, JoinMapBaseAdvanced joinMap)
         {
             if (!JoinMaps.ContainsKey(deviceKey))
@@ -177,9 +166,8 @@ namespace PepperDash.Essentials.Core.Bridges
         }
 
         /// <summary>
-        /// PrintJoinMaps method
+        /// Prints all the join maps on this bridge
         /// </summary>
-        /// <inheritdoc />
         public virtual void PrintJoinMaps()
         {
             CrestronConsole.ConsoleCommandResponse("Join Maps for EISC IPID: {0}\r\n", Eisc.ID.ToString("X"));
@@ -191,9 +179,8 @@ namespace PepperDash.Essentials.Core.Bridges
             }
         }
         /// <summary>
-        /// MarkdownForBridge method
+        /// Generates markdown for all join maps on this bridge
         /// </summary>
-        /// <inheritdoc />
         public virtual void MarkdownForBridge(string bridgeKey)
         {
             Debug.LogMessage(LogEventLevel.Information, this, "Writing Joinmaps to files for EISC IPID: {0}", Eisc.ID.ToString("X"));
@@ -209,9 +196,6 @@ namespace PepperDash.Essentials.Core.Bridges
         /// Prints the join map for a device by key
         /// </summary>
         /// <param name="deviceKey"></param>
-        /// <summary>
-        /// PrintJoinMapForDevice method
-        /// </summary>
         public void PrintJoinMapForDevice(string deviceKey)
         {
             var joinMap = JoinMaps[deviceKey];
@@ -229,9 +213,6 @@ namespace PepperDash.Essentials.Core.Bridges
         /// Prints the join map for a device by key
         /// </summary>
         /// <param name="deviceKey"></param>
-        /// <summary>
-        /// MarkdownJoinMapForDevice method
-        /// </summary>
         public void MarkdownJoinMapForDevice(string deviceKey, string bridgeKey)
         {
             var joinMap = JoinMaps[deviceKey];
@@ -252,9 +233,6 @@ namespace PepperDash.Essentials.Core.Bridges
         /// <param name="join"></param>
         /// <param name="type"></param>
         /// <param name="state"></param>
-        /// <summary>
-        /// ExecuteJoinAction method
-        /// </summary>
         public void ExecuteJoinAction(uint join, string type, object state)
         {
             try
@@ -340,91 +318,49 @@ namespace PepperDash.Essentials.Core.Bridges
 
         #region Implementation of ICommunicationMonitor
 
-        /// <summary>
-        /// Gets or sets the CommunicationMonitor
-        /// </summary>
         public StatusMonitorBase CommunicationMonitor { get; private set; }
 
         #endregion
     }
 
-    /// <summary>
-    /// Represents a EiscApiPropertiesConfig
-    /// </summary>
     public class EiscApiPropertiesConfig
     {
-        /// <summary>
-        /// Gets or sets the Control
-        /// </summary>
         [JsonProperty("control")]
         public EssentialsControlPropertiesConfig Control { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Devices
-        /// </summary>
         [JsonProperty("devices")]
         public List<ApiDevicePropertiesConfig> Devices { get; set; }
 
-        /// <summary>
-        /// Gets or sets the Rooms
-        /// </summary>
         [JsonProperty("rooms")]
         public List<ApiRoomPropertiesConfig> Rooms { get; set; }
 
 
-        /// <summary>
-        /// Represents a ApiDevicePropertiesConfig
-        /// </summary>
         public class ApiDevicePropertiesConfig
         {
-            /// <summary>
-            /// Gets or sets the DeviceKey
-            /// </summary>
             [JsonProperty("deviceKey")]
             public string DeviceKey { get; set; }
 
-            /// <summary>
-            /// Gets or sets the JoinStart
-            /// </summary>
             [JsonProperty("joinStart")]
             public uint JoinStart { get; set; }
 
-            /// <summary>
-            /// Gets or sets the JoinMapKey
-            /// </summary>
             [JsonProperty("joinMapKey")]
             public string JoinMapKey { get; set; }
         }
 
-        /// <summary>
-        /// Represents a ApiRoomPropertiesConfig
-        /// </summary>
         public class ApiRoomPropertiesConfig
         {
-            /// <summary>
-            /// Gets or sets the RoomKey
-            /// </summary>
             [JsonProperty("roomKey")]
             public string RoomKey { get; set; }
 
-            /// <summary>
-            /// Gets or sets the JoinStart
-            /// </summary>
             [JsonProperty("joinStart")]
             public uint JoinStart { get; set; }
 
-            /// <summary>
-            /// Gets or sets the JoinMapKey
-            /// </summary>
             [JsonProperty("joinMapKey")]
             public string JoinMapKey { get; set; }
         }
 
     }
 
-    /// <summary>
-    /// Represents a EiscApiAdvancedFactory
-    /// </summary>
     public class EiscApiAdvancedFactory : EssentialsDeviceFactory<EiscApiAdvanced>
     {
         public EiscApiAdvancedFactory()
@@ -432,10 +368,6 @@ namespace PepperDash.Essentials.Core.Bridges
             TypeNames = new List<string> { "eiscapiadv", "eiscapiadvanced", "eiscapiadvancedserver", "eiscapiadvancedclient", "vceiscapiadv", "vceiscapiadvanced" };
         }
 
-        /// <summary>
-        /// BuildDevice method
-        /// </summary>
-        /// <inheritdoc />
         public override EssentialsDevice BuildDevice(DeviceConfig dc)
         {
             Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new EiscApiAdvanced Device");

src/PepperDash.Essentials.Core/Bridges/BridgeHelper.cs

@@ -34,9 +34,6 @@ namespace PepperDash.Essentials.Core.Bridges
                 bridge.PrintJoinMaps();
             }
         }
-        /// <summary>
-        /// JoinmapMarkdown method
-        /// </summary>
         public static void JoinmapMarkdown(string command)
         {
             var targets = command.Split(' ');

src/PepperDash.Essentials.Core/Bridges/IBridge.cs

@@ -3,17 +3,10 @@
 namespace PepperDash.Essentials.Core.Bridges
 {
     /// <summary>
-    /// Defines the contract for IBridgeAdvanced
+    /// Defines a device that uses JoinMapBaseAdvanced for its join map
     /// </summary>
     public interface IBridgeAdvanced
     {
-        /// <summary>
-        /// Links the bridge to the API using the provided trilist, join start, join map key, and bridge.
-        /// </summary>
-        /// <param name="trilist">The trilist to link to.</param>
-        /// <param name="joinStart">The starting join number.</param>
-        /// <param name="joinMapKey">The key for the join map.</param>
-        /// <param name="bridge">The EISC API bridge.</param>
         void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge);
     }
 }

src/PepperDash.Essentials.Core/Bridges/JoinMaps/AirMediaControllerJoinMap.cs

@@ -2,9 +2,6 @@ using System;
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a AirMediaControllerJoinMap
-    /// </summary>
     public class AirMediaControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/AppleTvJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a AppleTvJoinMap
-    /// </summary>
     public class AppleTvJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("UpArrow")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/C2nRthsControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a C2nRthsControllerJoinMap
-    /// </summary>
     public class C2nRthsControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/CameraControllerJoinMap.cs

@@ -3,7 +3,7 @@
 namespace PepperDash.Essentials.Core.Bridges
 {
     /// <summary>
-    /// Represents a CameraControllerJoinMap
+    /// Join map for CameraBase devices
     /// </summary>
     public class CameraControllerJoinMap : JoinMapBaseAdvanced
     {

src/PepperDash.Essentials.Core/Bridges/JoinMaps/CenOdtOccupancySensorBaseJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a CenOdtOccupancySensorBaseJoinMap
-    /// </summary>
     public class CenOdtOccupancySensorBaseJoinMap : JoinMapBaseAdvanced
     {
         #region Digitals

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DisplayControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DisplayControllerJoinMap
-    /// </summary>
     public class DisplayControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("Name")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmBladeChassisControllerJoinMap.cs

@@ -1,9 +1,6 @@
 using System;
 
 namespace PepperDash.Essentials.Core.Bridges {
-    /// <summary>
-    /// Represents a DmBladeChassisControllerJoinMap
-    /// </summary>
     public class DmBladeChassisControllerJoinMap : JoinMapBaseAdvanced {
 
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmChassisControllerJoinMap.cs

@@ -2,9 +2,6 @@ using System;
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DmChassisControllerJoinMap
-    /// </summary>
     public class DmChassisControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("EnableAudioBreakaway")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmRmcControllerJoinMap.cs

@@ -2,9 +2,6 @@ using System;
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DmRmcControllerJoinMap
-    /// </summary>
     public class DmRmcControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmTxControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DmTxControllerJoinMap
-    /// </summary>
     public class DmTxControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmpsAudioOutputControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DmpsAudioOutputControllerJoinMap
-    /// </summary>
     public class DmpsAudioOutputControllerJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmpsMicrophoneControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DmpsMicrophoneControllerJoinMap
-    /// </summary>
     public class DmpsMicrophoneControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("MicGain")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmpsRoutingControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a DmpsRoutingControllerJoinMap
-    /// </summary>
     public class DmpsRoutingControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("EnableRouting")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/GenericLightingJoinMap.cs

@@ -3,9 +3,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a GenericLightingJoinMap
-    /// </summary>
     public class GenericLightingJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/GenericRelayControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a GenericRelayControllerJoinMap
-    /// </summary>
     public class GenericRelayControllerJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/GlsOccupancySensorBaseJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a GlsOccupancySensorBaseJoinMap
-    /// </summary>
     public class GlsOccupancySensorBaseJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/GlsPartitionSensorJoinMap.cs

@@ -3,9 +3,6 @@ using PepperDash.Essentials.Core;
 
 namespace PepperDash.Essentials.Core.Bridges.JoinMaps
 {
-    /// <summary>
-    /// Represents a GlsPartitionSensorJoinMap
-    /// </summary>
     public class GlsPartitionSensorJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/HdMdNxM4kEControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a HdMdNxM4kEControllerJoinMap
-    /// </summary>
     public class HdMdNxM4kEControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("Name")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/HdMdxxxCEControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a HdMdxxxCEControllerJoinMap
-    /// </summary>
     public class HdMdxxxCEControllerJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/HdPsXxxControllerJoinMap.cs

@@ -3,9 +3,6 @@ using PepperDash.Essentials.Core;
 
 namespace PepperDash.Essentials.Core.Bridges
 {
- /// <summary>
- /// Represents a HdPsXxxControllerJoinMap
- /// </summary>
 	public class HdPsXxxControllerJoinMap : JoinMapBaseAdvanced
 	{
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/Hrxxx0WirelessRemoteControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a Hrxxx0WirelessRemoteControllerJoinMap
-    /// </summary>
     public class Hrxxx0WirelessRemoteControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("Power")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/IAnalogInputJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a IAnalogInputJoinMap
-    /// </summary>
     public class IAnalogInputJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/IBasicCommunicationJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a IBasicCommunicationJoinMap
-    /// </summary>
     public class IBasicCommunicationJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("TextReceived")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/IDigitalInputJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a IDigitalInputJoinMap
-    /// </summary>
     public class IDigitalInputJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/IDigitalOutputJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a IDigitalOutputJoinMap
-    /// </summary>
     public class IDigitalOutputJoinMap : JoinMapBaseAdvanced
     {
 

src/PepperDash.Essentials.Core/Bridges/JoinMaps/PduJoinMapBase.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a PduJoinMapBase
-    /// </summary>
     public class PduJoinMapBase : JoinMapBaseAdvanced
     {
         [JoinName("Name")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/SetTopBoxControllerJoinMap.cs

@@ -3,9 +3,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a SetTopBoxControllerJoinMap
-    /// </summary>
     public class SetTopBoxControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("PowerOn")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/StatusSignControllerJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a StatusSignControllerJoinMap
-    /// </summary>
     public class StatusSignControllerJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("IsOnline")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/SystemMonitorJoinMap.cs

@@ -2,9 +2,6 @@
 
 namespace PepperDash.Essentials.Core.Bridges
 {
-    /// <summary>
-    /// Represents a SystemMonitorJoinMap
-    /// </summary>
     public class SystemMonitorJoinMap : JoinMapBaseAdvanced
     {
         [JoinName("TimeZone")]

src/PepperDash.Essentials.Core/Bridges/JoinMaps/VideoCodecControllerJoinMap.cs

@@ -2,9 +2,6 @@ using System;
 using PepperDash.Essentials.Core;
 namespace PepperDash.Essentials.Core.Bridges.JoinMaps
 {
- /// <summary>
- /// Represents a VideoCodecControllerJoinMap
- /// </summary>
 	public class VideoCodecControllerJoinMap : JoinMapBaseAdvanced
 	{
 		#region Digital

src/PepperDash.Essentials.Core/Comm and IR/CecPortController.cs

@@ -12,22 +12,13 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core
 {
- /// <summary>
- /// Represents a CecPortController
- /// </summary>
 	public class CecPortController : Device, IBasicCommunicationWithStreamDebugging
     {
-  /// <summary>
-  /// Gets or sets the StreamDebugging
-  /// </summary>
 		public CommunicationStreamDebugging StreamDebugging { get; private set; }
 
         public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
         public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
 
-        /// <summary>
-        /// Gets or sets the IsConnected
-        /// </summary>
         public bool IsConnected { get { return true; } }
 
         ICec Port;
@@ -83,9 +74,6 @@ namespace PepperDash.Essentials.Core
 
         #region IBasicCommunication Members
 
-        /// <summary>
-        /// SendText method
-        /// </summary>
         public void SendText(string text)
         {
             if (Port == null)
@@ -95,9 +83,6 @@ namespace PepperDash.Essentials.Core
             Port.StreamCec.Send.StringValue = text;
         }
 
-        /// <summary>
-        /// SendBytes method
-        /// </summary>
         public void SendBytes(byte[] bytes)
         {
             if (Port == null)
@@ -108,16 +93,10 @@ namespace PepperDash.Essentials.Core
             Port.StreamCec.Send.StringValue = text;
         }
 
-        /// <summary>
-        /// Connect method
-        /// </summary>
         public void Connect()
         {
         }
 
-        /// <summary>
-        /// Disconnect method
-        /// </summary>
         public void Disconnect()
         {
         }
@@ -128,9 +107,6 @@ namespace PepperDash.Essentials.Core
         /// 
         /// </summary>
         /// <param name="s"></param>
-        /// <summary>
-        /// SimulateReceive method
-        /// </summary>
         public void SimulateReceive(string s)
         {
             // split out hex chars and build string

src/PepperDash.Essentials.Core/Comm and IR/ComPortController.cs

@@ -12,22 +12,13 @@ using Serilog.Events;
 
 namespace PepperDash.Essentials.Core
 {
- /// <summary>
- /// Represents a ComPortController
- /// </summary>
 	public class ComPortController : Device, IBasicCommunicationWithStreamDebugging
 	{
-        /// <summary>
-        /// Gets or sets the StreamDebugging
-        /// </summary>
         public CommunicationStreamDebugging StreamDebugging { get; private set; }
 
 		public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
 		public event EventHandler<GenericCommMethodReceiveTextArgs> TextReceived;
 
-  /// <summary>
-  /// Gets or sets the IsConnected
-  /// </summary>
 		public bool IsConnected { get { return true; } }
 
 		ComPort Port;
@@ -125,10 +116,6 @@ namespace PepperDash.Essentials.Core
 			if(!eventSubscribed) Debug.LogMessage(LogEventLevel.Warning, this, "Received data but no handler is registered");
         }
 
-  /// <summary>
-  /// Deactivate method
-  /// </summary>
-  /// <inheritdoc />
 		public override bool Deactivate()
 		{
 			return Port.UnRegister() == eDeviceRegistrationUnRegistrationResponse.Success;
@@ -136,9 +123,6 @@ namespace PepperDash.Essentials.Core
 
 		#region IBasicCommunication Members
 
-  /// <summary>
-  /// SendText method
-  /// </summary>
 		public void SendText(string text)
 		{
 			if (Port == null)
@@ -149,9 +133,6 @@ namespace PepperDash.Essentials.Core
             Port.Send(text);
 		}
 
-  /// <summary>
-  /// SendBytes method
-  /// </summary>
 		public void SendBytes(byte[] bytes)
 		{
 			if (Port == null)
@@ -163,16 +144,10 @@ namespace PepperDash.Essentials.Core
 			Port.Send(text);
 		}
 
-  /// <summary>
-  /// Connect method
-  /// </summary>
 		public void Connect()
 		{		
 		}
 
-  /// <summary>
-  /// Disconnect method
-  /// </summary>
 		public void Disconnect()
 		{
 		}
@@ -183,9 +158,6 @@ namespace PepperDash.Essentials.Core
         /// 
         /// </summary>
         /// <param name="s"></param>
-        /// <summary>
-        /// SimulateReceive method
-        /// </summary>
         public void SimulateReceive(string s)
         {
             // split out hex chars and build string

src/PepperDash.Essentials.Core/Comm and IR/ComSpecJsonConverter.cs

@@ -34,9 +34,8 @@ namespace PepperDash.Essentials.Core
         }
 
         /// <summary>
-        /// CanConvert method
+        /// 
         /// </summary>
-        /// <inheritdoc />
         public override bool CanConvert(Type objectType)
         {
             return objectType == typeof(ComPort.ComPortSpec?);
@@ -45,15 +44,10 @@ namespace PepperDash.Essentials.Core
         public override bool CanRead { get { return true; } }
 
         /// <summary>
-        /// Gets or sets the CanWrite
+        /// This converter will not be used for writing
         /// </summary>
-        /// <inheritdoc />
         public override bool CanWrite { get { return false; } }
 
-        /// <summary>
-        /// WriteJson method
-        /// </summary>
-        /// <inheritdoc />
         public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
         {
             throw new NotImplementedException();
@@ -61,11 +55,12 @@ namespace PepperDash.Essentials.Core
     }
 
     /// <summary>
-    /// Represents a ComSpecPropsJsonConverter
+    /// The gist of this converter: The comspec JSON comes in with normal values that need to be converted
+    /// into enum names.  This converter takes the value and applies the appropriate enum's name prefix to the value
+    /// and then returns the enum value using Enum.Parse. NOTE: Does not write
     /// </summary>
     public class ComSpecPropsJsonConverter : JsonConverter
     {
-        /// <inheritdoc />
         public override bool CanConvert(Type objectType)
         {
             return objectType == typeof(ComPort.eComBaudRates)
@@ -77,15 +72,8 @@ namespace PepperDash.Essentials.Core
                 || objectType == typeof(ComPort.eComStopBits);
         }
 
-        /// <summary>
-        /// Gets or sets the CanRead
-        /// </summary>
-        /// <inheritdoc />
         public override bool CanRead { get { return true; } }
 
-        /// <summary>
-        /// ReadJson method
-        /// </summary>
         public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
         {
             //Debug.LogMessage(LogEventLevel.Verbose, "ReadJson type: " + objectType.Name);
@@ -106,10 +94,6 @@ namespace PepperDash.Essentials.Core
             return null;
         }
 
-        /// <summary>
-        /// WriteJson method
-        /// </summary>
-        /// <inheritdoc />
         public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
         {
             throw new NotImplementedException();