docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions

View File

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

View File

@@ -22,9 +22,6 @@ namespace PepperDash.Core
/// </summary>
private CTimer DebugExpiryPeriod;
/// <summary>
/// The current debug setting
/// </summary>
/// <summary>
/// Gets or sets the DebugSetting
/// </summary>
@@ -44,9 +41,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Indicates that receive stream debugging is enabled
/// </summary>
/// <summary>
/// Gets or sets the RxStreamDebuggingIsEnabled
/// </summary>

View File

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

View File

@@ -29,9 +29,6 @@ namespace PepperDash.Core
/// </summary>
public class GenericSocketStatusChageEventArgs : EventArgs
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the Client
/// </summary>
@@ -62,9 +59,6 @@ namespace PepperDash.Core
/// </summary>
public class GenericTcpServerStateChangedEventArgs : EventArgs
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the State
/// </summary>
@@ -159,9 +153,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the Text
/// </summary>

View File

@@ -78,9 +78,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -151,9 +148,6 @@ namespace PepperDash.Core
/// </summary>
public string ConnectionFailure { get { return ClientStatus.ToString(); } }
/// <summary>
/// bool to track if auto reconnect should be set on the socket
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
@@ -193,9 +187,6 @@ namespace PepperDash.Core
#region GenericSecureTcpIpClient properties
/// <summary>
/// Bool to show whether the server requires a preshared key. This is used in the DynamicTCPServer class
/// </summary>
/// <summary>
/// Gets or sets the SharedKeyRequired
/// </summary>
@@ -215,9 +206,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -233,9 +221,6 @@ namespace PepperDash.Core
/// </summary>
bool IsTryingToConnect;
/// <summary>
/// Bool showing if socket is ready for communication after shared key exchange
/// </summary>
/// <summary>
/// Gets or sets the IsReadyForCommunication
/// </summary>
@@ -356,9 +341,6 @@ namespace PepperDash.Core
BufferSize = 2000;
}
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -452,9 +434,6 @@ namespace PepperDash.Core
return true;
}
/// <summary>
/// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -586,9 +565,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -612,9 +588,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Does the actual disconnect business
/// </summary>
/// <summary>
/// DisconnectClient method
/// </summary>
@@ -875,9 +848,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -907,9 +877,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>

View File

@@ -79,9 +79,6 @@ namespace PepperDash.Core
/// </summary>
public string Hostname { get; set; }
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -115,9 +112,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -128,9 +122,6 @@ namespace PepperDash.Core
/// </summary>
private bool WaitingForSharedKeyResponse { get; set; }
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -344,9 +335,6 @@ namespace PepperDash.Core
#region Methods
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -406,9 +394,6 @@ namespace PepperDash.Core
}
/// <summary>
/// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -540,9 +525,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -821,9 +803,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -853,9 +832,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>

View File

@@ -57,9 +57,6 @@ namespace PepperDash.Core
/// </summary>
public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
/// <summary>
///
/// </summary>
/// <summary>
/// Delegate for ServerHasChokedCallbackDelegate
/// </summary>
@@ -106,9 +103,6 @@ namespace PepperDash.Core
/// </summary>
int MonitorClientFailureCount;
/// <summary>
/// 3 by default
/// </summary>
/// <summary>
/// Gets or sets the MonitorClientMaxFailureCount
/// </summary>
@@ -195,9 +189,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -231,10 +222,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -259,9 +246,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatRequiredIntervalMs
/// </summary>
@@ -272,9 +256,6 @@ namespace PepperDash.Core
/// </summary>
public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } }
/// <summary>
/// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatStringToMatch
/// </summary>
@@ -293,9 +274,6 @@ namespace PepperDash.Core
/// </summary>
public List<uint> ConnectedClientsIndexes = new List<uint>();
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -360,9 +338,6 @@ namespace PepperDash.Core
#region Methods - Server Actions
/// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method
/// </summary>
public void KillServer()
@@ -421,9 +396,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary>
/// Listen method
/// </summary>
@@ -482,9 +454,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Stop Listeneing
/// </summary>
/// <summary>
/// StopListening method
/// </summary>
@@ -527,9 +496,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method
/// </summary>
public void DisconnectAllClientsForShutdown()

View File

@@ -41,9 +41,6 @@ namespace PepperDash.Core
///// </summary>
//public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
/// <summary>
/// Address of server
/// </summary>
/// <summary>
/// Gets or sets the Hostname
/// </summary>
@@ -54,17 +51,11 @@ namespace PepperDash.Core
/// </summary>
public int Port { get; set; }
/// <summary>
/// Username for server
/// </summary>
/// <summary>
/// Gets or sets the Username
/// </summary>
public string Username { get; set; }
/// <summary>
/// And... Password for server. That was worth documenting!
/// </summary>
/// <summary>
/// Gets or sets the Password
/// </summary>
@@ -131,10 +122,6 @@ namespace PepperDash.Core
set { AutoReconnect = value == 1; }
}
/// <summary>
/// Millisecond value, determines the timeout period in between reconnect attempts.
/// Set to 5000 by default
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnectIntervalMs
/// </summary>
@@ -209,9 +196,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Connect to the server, using the provided properties.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -339,9 +323,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Disconnect the clients and put away it's resources.
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -573,9 +554,6 @@ namespace PepperDash.Core
//*****************************************************************************************************
//*****************************************************************************************************
/// <summary>
/// Fired when connection changes
/// </summary>
/// <summary>
/// Represents a SshConnectionChangeEventArgs
/// </summary>
public class SshConnectionChangeEventArgs : EventArgs
@@ -585,25 +563,16 @@ public class SshConnectionChangeEventArgs : EventArgs
/// </summary>
public bool IsConnected { get; private set; }
/// <summary>
/// Connection Status represented as a ushort
/// </summary>
/// <summary>
/// Gets or sets the UIsConnected
/// </summary>
public ushort UIsConnected { get { return (ushort)(Client.IsConnected ? 1 : 0); } }
/// <summary>
/// The client
/// </summary>
/// <summary>
/// Gets or sets the Client
/// </summary>
public GenericSshClient Client { get; private set; }
/// <summary>
/// Socket Status as represented by
/// </summary>
/// <summary>
/// Gets or sets the Status
/// </summary>

View File

@@ -58,9 +58,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -138,9 +135,6 @@ namespace PepperDash.Core
/// </summary>
public string ConnectionFailure { get { return ClientStatus.ToString(); } }
/// <summary>
/// bool to track if auto reconnect should be set on the socket
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
@@ -237,9 +231,6 @@ namespace PepperDash.Core
}, Timeout.Infinite);
}
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -279,9 +270,6 @@ namespace PepperDash.Core
return true;
}
/// <summary>
/// Attempts to connect to the server
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -349,9 +337,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Attempts to disconnect the client
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -372,9 +357,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Does the actual disconnect business
/// </summary>
/// <summary>
/// DisconnectClient method
/// </summary>
@@ -467,9 +449,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -483,9 +462,6 @@ namespace PepperDash.Core
_client.SendData(bytes, bytes.Length);
}
/// <summary>
/// This is useful from console and...?
/// </summary>
/// <summary>
/// SendEscapedText method
/// </summary>
@@ -538,9 +514,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Configuration properties for TCP/SSH Connections
/// </summary>
/// <summary>
/// Represents a TcpSshPropertiesConfig
/// </summary>
@@ -562,9 +535,6 @@ namespace PepperDash.Core
/// Username credential
/// </summary>
public string Username { get; set; }
/// <summary>
/// Passord credential
/// </summary>
/// <summary>
/// Gets or sets the Password
/// </summary>
@@ -575,17 +545,11 @@ namespace PepperDash.Core
/// </summary>
public int BufferSize { get; set; }
/// <summary>
/// Defaults to true
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
public bool AutoReconnect { get; set; }
/// <summary>
/// Defaults to 5000ms
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnectIntervalMs
/// </summary>

View File

@@ -68,9 +68,6 @@ namespace PepperDash.Core
/// </summary>
public string Hostname { get; set; }
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -104,9 +101,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -117,9 +111,6 @@ namespace PepperDash.Core
/// </summary>
private bool WaitingForSharedKeyResponse { get; set; }
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -297,9 +288,6 @@ namespace PepperDash.Core
#region Methods
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -322,9 +310,6 @@ namespace PepperDash.Core
}
/// <summary>
/// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -456,9 +441,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -686,9 +668,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -718,9 +697,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>

View File

@@ -51,9 +51,6 @@ namespace PepperDash.Core
/// </summary>
public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
/// <summary>
///
/// </summary>
/// <summary>
/// Delegate for ServerHasChokedCallbackDelegate
/// </summary>
@@ -84,9 +81,6 @@ namespace PepperDash.Core
/// </summary>
int MonitorClientFailureCount;
/// <summary>
/// 3 by default
/// </summary>
/// <summary>
/// Gets or sets the MonitorClientMaxFailureCount
/// </summary>
@@ -176,9 +170,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -212,10 +203,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -240,9 +227,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatRequiredIntervalMs
/// </summary>
@@ -253,9 +237,6 @@ namespace PepperDash.Core
/// </summary>
public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } }
/// <summary>
/// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatStringToMatch
/// </summary>
@@ -274,9 +255,6 @@ namespace PepperDash.Core
/// </summary>
public List<uint> ConnectedClientsIndexes = new List<uint>();
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -341,9 +319,6 @@ namespace PepperDash.Core
#region Methods - Server Actions
/// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method
/// </summary>
public void KillServer()
@@ -401,9 +376,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary>
/// Listen method
/// </summary>
@@ -461,9 +433,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Stop Listening
/// </summary>
/// <summary>
/// StopListening method
/// </summary>
@@ -506,9 +475,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method
/// </summary>
public void DisconnectAllClientsForShutdown()

View File

@@ -187,9 +187,6 @@ namespace PepperDash.Core
Disconnect();
}
/// <summary>
/// Enables the UDP Server
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -227,9 +224,6 @@ namespace PepperDash.Core
Server.ReceiveDataAsync(Receive);
}
/// <summary>
/// Disabled the UDP Server
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -335,9 +329,6 @@ namespace PepperDash.Core
}
/// <summary>
///
/// </summary>
/// <summary>
/// Represents a GenericUdpReceiveTextExtraArgs
/// </summary>

View File

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

View File

@@ -38,9 +38,6 @@ namespace PepperDash.Core
void Disconnect();
}
/// <summary>
/// Represents a device that uses basic connection
/// </summary>
/// <summary>
/// Defines the contract for IBasicCommunication
/// </summary>
@@ -150,9 +147,6 @@ namespace PepperDash.Core
/// </summary>
public class GenericCommMethodReceiveBytesArgs : EventArgs
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the Bytes
/// </summary>

View File

@@ -5,9 +5,6 @@ using Serilog.Events;
namespace PepperDash.Core
{
//*********************************************************************************************************
/// <summary>
/// The core event and status-bearing class that most if not all device and connectors can derive from.
/// </summary>
/// <summary>
/// Represents a Device
/// </summary>
@@ -18,9 +15,6 @@ namespace PepperDash.Core
/// Unique Key
/// </summary>
public string Key { get; protected set; }
/// <summary>
/// Name of the devie
/// </summary>
/// <summary>
/// Gets or sets the Name
/// </summary>
@@ -102,9 +96,6 @@ namespace PepperDash.Core
_PostActivationActions.Add(act);
}
/// <summary>
/// Executes the preactivation actions
/// </summary>
/// <summary>
/// PreActivate method
/// </summary>
@@ -124,11 +115,6 @@ namespace PepperDash.Core
});
}
/// <summary>
/// Gets this device ready to be used in the system. Runs any added pre-activation items, and
/// all post-activation at end. Classes needing additional logic to
/// run should override CustomActivate()
/// </summary>
/// <summary>
/// Activate method
/// </summary>
@@ -142,9 +128,6 @@ namespace PepperDash.Core
return result;
}
/// <summary>
/// Executes the postactivation actions
/// </summary>
/// <summary>
/// PostActivate method
/// </summary>

View File

@@ -4,9 +4,6 @@ using Serilog.Events;
namespace PepperDash.Core
{
/// <summary>
/// Class to help with accessing values from the CrestronEthernetHelper class
/// </summary>
/// <summary>
/// Represents a EthernetHelper
/// </summary>
@@ -27,9 +24,6 @@ namespace PepperDash.Core
// ADD OTHER HELPERS HERE
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the PortNumber
/// </summary>

View File

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

View File

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

View File

@@ -47,17 +47,11 @@ namespace PepperDash.Core.JsonStandardObjects
]
}
*/
/// <summary>
/// Device communication parameter class
/// </summary>
/// <summary>
/// Represents a ComParamsConfig
/// </summary>
public class ComParamsConfig
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the baudRate
/// </summary>
@@ -92,16 +86,10 @@ namespace PepperDash.Core.JsonStandardObjects
public int pacing { get; set; }
// convert properties for simpl
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplBaudRate
/// </summary>
public ushort simplBaudRate { get { return Convert.ToUInt16(baudRate); } }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplDataBits
/// </summary>
@@ -155,16 +143,10 @@ namespace PepperDash.Core.JsonStandardObjects
public int autoReconnectIntervalMs { get; set; }
// convert properties for simpl
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplPort
/// </summary>
public ushort simplPort { get { return Convert.ToUInt16(port); } }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplAutoReconnect
/// </summary>
@@ -210,9 +192,6 @@ namespace PepperDash.Core.JsonStandardObjects
public TcpSshPropertiesConfig tcpSshProperties { get; set; }
// convert properties for simpl
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplControlPortNumber
/// </summary>
@@ -228,9 +207,6 @@ namespace PepperDash.Core.JsonStandardObjects
}
}
/// <summary>
/// Device properties class
/// </summary>
/// <summary>
/// Represents a PropertiesConfig
/// </summary>
@@ -250,16 +226,10 @@ namespace PepperDash.Core.JsonStandardObjects
public ControlConfig control { get; set; }
// convert properties for simpl
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplDeviceId
/// </summary>
public ushort simplDeviceId { get { return Convert.ToUInt16(deviceId); } }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplEnabled
/// </summary>

View File

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

View File

@@ -52,9 +52,6 @@ namespace PepperDash.Core.JsonToSimpl
}
}
/// <summary>
/// Gets a master by its key. Case-insensitive
/// </summary>
/// <summary>
/// GetMasterByFile method
/// </summary>

View File

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

View File

@@ -28,17 +28,11 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary>
public SPlusValuesDelegate GetAllValuesDelegate { get; set; }
/// <summary>
/// Use a callback to reduce task switch/threading
/// </summary>
/// <summary>
/// Gets or sets the SetAllPathsDelegate
/// </summary>
public SPlusValuesDelegate SetAllPathsDelegate { get; set; }
/// <summary>
/// Unique identifier for instance
/// </summary>
/// <summary>
/// Gets or sets the Key
/// </summary>
@@ -55,9 +49,6 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary>
public string PathSuffix { get; protected set; }
/// <summary>
/// Indicates if the instance is linked to an object
/// </summary>
/// <summary>
/// Gets or sets the LinkedToObject
/// </summary>
@@ -122,9 +113,6 @@ namespace PepperDash.Core.JsonToSimpl
BoolPaths[index] = path;
}
/// <summary>
/// Set the JPath for a ushort out index.
/// </summary>
/// <summary>
/// SetUshortPath method
/// </summary>
@@ -135,9 +123,6 @@ namespace PepperDash.Core.JsonToSimpl
UshortPaths[index] = path;
}
/// <summary>
/// Set the JPath for a string output index.
/// </summary>
/// <summary>
/// SetStringPath method
/// </summary>
@@ -148,13 +133,10 @@ namespace PepperDash.Core.JsonToSimpl
StringPaths[index] = path;
}
/// <summary>
/// Evalutates all outputs with defined paths. called by S+ when paths are ready to process
/// and by Master when file is read.
/// </summary>
/// <summary>
/// ProcessAll method
/// </summary>
/// <inheritdoc />
public virtual void ProcessAll()
{
if (!LinkedToObject)

View File

@@ -19,17 +19,11 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary>
public string Filepath { get; private set; }
/// <summary>
/// Filepath to the actual file that will be read (Portal or local)
/// </summary>
/// <summary>
/// Gets or sets the ActualFilePath
/// </summary>
public string ActualFilePath { get; private set; }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the Filename
/// </summary>

View File

@@ -2,9 +2,6 @@
namespace PepperDash.Core.JsonToSimpl
{
/// <summary>
///
/// </summary>
/// <summary>
/// Represents a JsonToSimplFixedPathObject
/// </summary>

View File

@@ -5,9 +5,6 @@ using Newtonsoft.Json.Linq;
namespace PepperDash.Core.JsonToSimpl
{
/// <summary>
/// Generic Master
/// </summary>
/// <summary>
/// Represents a JsonToSimplGenericMaster
/// </summary>
@@ -23,9 +20,6 @@ namespace PepperDash.Core.JsonToSimpl
// To prevent multiple same-file access
static object WriteLock = new object();
/// <summary>
/// Callback action for saving
/// </summary>
/// <summary>
/// Gets or sets the SaveCallback
/// </summary>
@@ -81,12 +75,10 @@ namespace PepperDash.Core.JsonToSimpl
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Save method
/// </summary>
/// <inheritdoc />
public override void Save()
{
// this code is duplicated in the other masters!!!!!!!!!!!!!

View File

@@ -38,9 +38,6 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary>
public string Key { get { return UniqueID; } }
/// <summary>
/// A unique ID
/// </summary>
/// <summary>
/// Gets or sets the UniqueID
/// </summary>
@@ -56,10 +53,6 @@ namespace PepperDash.Core.JsonToSimpl
}
string _DebugName = "";
/// <summary>
/// This will be prepended to all paths to allow path swapping or for more organized
/// sub-paths
/// </summary>
/// <summary>
/// Gets or sets the PathPrefix
/// </summary>
@@ -89,9 +82,6 @@ namespace PepperDash.Core.JsonToSimpl
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the JsonObject
/// </summary>
@@ -140,9 +130,6 @@ namespace PepperDash.Core.JsonToSimpl
}
}
/// <summary>
/// Called from the child to add changed or new values for saving
/// </summary>
/// <summary>
/// AddUnsavedValue method
/// </summary>

View File

@@ -18,9 +18,6 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary>
public string PortalFilepath { get; private set; }
/// <summary>
/// File path of the actual file being read (Portal or local)
/// </summary>
/// <summary>
/// Gets or sets the ActualFilePath
/// </summary>

View File

@@ -77,17 +77,11 @@ namespace PepperDash.Core
/// </summary>
public static string FileName = string.Format(@"app{0}Debug.json", InitialParametersClass.ApplicationNumber);
/// <summary>
/// Debug level to set for a given program.
/// </summary>
/// <summary>
/// Gets or sets the Level
/// </summary>
public static int Level { get; private set; }
/// <summary>
/// When this is true, the configuration file will NOT be loaded until triggered by either a console command or a signal
/// </summary>
/// <summary>
/// Gets or sets the DoNotLoadConfigOnNextBoot
/// </summary>
@@ -99,9 +93,6 @@ namespace PepperDash.Core
public static bool IsRunningOnAppliance = CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance;
/// <summary>
/// Version for the currently loaded PepperDashCore dll
/// </summary>
/// <summary>
/// Gets or sets the PepperDashCoreVersion
/// </summary>
@@ -620,9 +611,6 @@ namespace PepperDash.Core
InitialParametersClass.ApplicationNumber, DoNotLoadConfigOnNextBoot);
}
/// <summary>
///
/// </summary>
/// <summary>
/// ShowDebugLog method
/// </summary>
@@ -1137,9 +1125,6 @@ namespace PepperDash.Core
return string.Format("{0}{1}user{1}debugSettings{1}{2}.json",Directory.GetApplicationRootDirectory(), Path.DirectorySeparatorChar, InitialParametersClass.RoomId);
}
/// <summary>
/// Error level to for message to be logged at
/// </summary>
/// <summary>
/// Enumeration of ErrorLogLevel values
/// </summary>

View File

@@ -149,9 +149,6 @@ namespace PepperDash.Core
string.Format(format, items));
}
/// <summary>
/// Appends a device Key to the beginning of a message
/// </summary>
/// <summary>
/// Console method
/// </summary>

View File

@@ -4,9 +4,6 @@ using Newtonsoft.Json;
namespace PepperDash.Core.Logging
{
/// <summary>
/// Class to persist current Debug settings across program restarts
/// </summary>
/// <summary>
/// Represents a DebugContextCollection
/// </summary>

View File

@@ -2,9 +2,6 @@
namespace PepperDash.Core.PasswordManagement
{
/// <summary>
/// A class to allow user interaction with the PasswordManager
/// </summary>
/// <summary>
/// Represents a PasswordClient
/// </summary>
@@ -120,9 +117,6 @@ namespace PepperDash.Core.PasswordManagement
ValidatePassword(PasswordToValidate);
}
/// <summary>
/// Clears the user entered password and resets the LEDs
/// </summary>
/// <summary>
/// ClearPassword method
/// </summary>

View File

@@ -4,9 +4,6 @@ using Crestron.SimplSharp;
namespace PepperDash.Core.PasswordManagement
{
/// <summary>
/// Allows passwords to be stored and managed
/// </summary>
/// <summary>
/// Represents a PasswordManager
/// </summary>

View File

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

View File

@@ -100,9 +100,6 @@ namespace PepperDash.Core.SystemInfo
OnBoolChange(false, 0, SystemInfoConstants.BusyBoolChange);
}
/// <summary>
/// Gets the current ethernet info
/// </summary>
/// <summary>
/// GetEthernetInfo method
/// </summary>
@@ -164,9 +161,6 @@ namespace PepperDash.Core.SystemInfo
OnBoolChange(false, 0, SystemInfoConstants.BusyBoolChange);
}
/// <summary>
/// Gets the current control subnet info
/// </summary>
/// <summary>
/// GetControlSubnetInfo method
/// </summary>
@@ -272,9 +266,6 @@ namespace PepperDash.Core.SystemInfo
OnBoolChange(false, 0, SystemInfoConstants.BusyBoolChange);
}
/// <summary>
/// Gets the processor uptime and passes it to S+
/// </summary>
/// <summary>
/// RefreshProcessorUptime method
/// </summary>

View File

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

View File

@@ -25,33 +25,21 @@ namespace PepperDash.Core.Web
private readonly CCriticalSection _serverLock = new CCriticalSection();
private HttpCwsServer _server;
/// <summary>
/// Web API server key
/// </summary>
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; private set; }
/// <summary>
/// Web API server name
/// </summary>
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; private set; }
/// <summary>
/// CWS base path, will default to "/api" if not set via initialize method
/// </summary>
/// <summary>
/// Gets or sets the BasePath
/// </summary>
public string BasePath { get; private set; }
/// <summary>
/// Indicates CWS is registered with base path
/// </summary>
/// <summary>
/// Gets or sets the IsRegistered
/// </summary>
@@ -149,9 +137,6 @@ namespace PepperDash.Core.Web
Start();
}
/// <summary>
/// Initializes CWS class
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -194,9 +179,6 @@ namespace PepperDash.Core.Web
_server.Routes.Remove(route);
}
/// <summary>
/// Returns a list of the current routes
/// </summary>
/// <summary>
/// GetRouteCollection method
/// </summary>
@@ -243,9 +225,6 @@ namespace PepperDash.Core.Web
}
}
/// <summary>
/// Stop CWS instance
/// </summary>
/// <summary>
/// Stop method
/// </summary>

View File

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

View File

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

View File

@@ -25,9 +25,6 @@ namespace PepperDash.Core.WebApi.Presets
/// </summary>
public event EventHandler<PresetReceivedEventArgs> PresetReceived;
/// <summary>
/// Unique identifier for this instance
/// </summary>
/// <summary>
/// Gets or sets the Key
/// </summary>

View File

@@ -75,6 +75,7 @@ namespace PepperDash.Core.Intersystem.Tokens
/// <summary>
/// ToString method
/// </summary>
/// <inheritdoc />
public override string ToString()
{
return Index + " = 0x" + Value.ToString("X4");

View File

@@ -73,6 +73,7 @@ namespace PepperDash.Core.Intersystem.Tokens
/// <summary>
/// ToString method
/// </summary>
/// <inheritdoc />
public override string ToString()
{
return Index + " = " + (Value ? "High" : "Low");

View File

@@ -79,6 +79,7 @@ namespace PepperDash.Core.Intersystem.Tokens
/// <summary>
/// ToString method
/// </summary>
/// <inheritdoc />
public override string ToString()
{
return Index + " = \"" + Value + "\"";

View File

@@ -139,9 +139,6 @@ namespace PepperDash.Core.Intersystem
}
}
/// <summary>
/// Disposes of the internal stream if specified to not leave open.
/// </summary>
/// <summary>
/// Dispose method
/// </summary>