pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-04-12 12:06:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: complete XML documentation for all projects with inheritdoc tags

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

4
src/PepperDash.Core/Comm/CommunicationGather.cs
View file

@ -84,10 +84,6 @@ namespace PepperDash.Core
port.TextReceived += Port_TextReceivedStringDelimiter; 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> /// <summary>
/// Stop method /// Stop method
/// </summary> /// </summary>

6
src/PepperDash.Core/Comm/CommunicationStreamDebugging.cs
View file

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

3
src/PepperDash.Core/Comm/ControlPropertiesConfig.cs
View file

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

9
src/PepperDash.Core/Comm/EventArgs.cs
View file

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

33
src/PepperDash.Core/Comm/GenericSecureTcpIpClient.cs
View file

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

24
src/PepperDash.Core/Comm/GenericSecureTcpIpClient_ForServer.cs
View file

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

34
src/PepperDash.Core/Comm/GenericSecureTcpIpServer.cs
View file

@ -57,9 +57,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; } public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
/// <summary>
///
/// </summary>
/// <summary> /// <summary>
/// Delegate for ServerHasChokedCallbackDelegate /// Delegate for ServerHasChokedCallbackDelegate
/// </summary> /// </summary>
@ -106,9 +103,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
int MonitorClientFailureCount; int MonitorClientFailureCount;
/// <summary>
/// 3 by default
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the MonitorClientMaxFailureCount /// Gets or sets the MonitorClientMaxFailureCount
/// </summary> /// </summary>
@ -195,9 +189,6 @@ namespace PepperDash.Core
} }
} }
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the Port /// Gets or sets the Port
/// </summary> /// </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> /// <summary>
/// Gets or sets the SharedKey /// Gets or sets the SharedKey
/// </summary> /// </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> /// <summary>
/// Gets or sets the HeartbeatRequiredIntervalMs /// Gets or sets the HeartbeatRequiredIntervalMs
/// </summary> /// </summary>
@ -272,9 +256,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } } 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> /// <summary>
/// Gets or sets the HeartbeatStringToMatch /// Gets or sets the HeartbeatStringToMatch
/// </summary> /// </summary>
@ -293,9 +274,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public List<uint> ConnectedClientsIndexes = new List<uint>(); public List<uint> ConnectedClientsIndexes = new List<uint>();
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the BufferSize /// Gets or sets the BufferSize
/// </summary> /// </summary>
@ -360,9 +338,6 @@ namespace PepperDash.Core
#region Methods - Server Actions #region Methods - Server Actions
/// <summary> /// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method /// KillServer method
/// </summary> /// </summary>
public void KillServer() public void KillServer()
@ -421,9 +396,6 @@ namespace PepperDash.Core
} }
} }
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary> /// <summary>
/// Listen method /// Listen method
/// </summary> /// </summary>
@ -482,9 +454,6 @@ namespace PepperDash.Core
} }
} }
/// <summary>
/// Stop Listeneing
/// </summary>
/// <summary> /// <summary>
/// StopListening method /// StopListening method
/// </summary> /// </summary>
@ -527,9 +496,6 @@ namespace PepperDash.Core
} }
} }
/// <summary> /// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method /// DisconnectAllClientsForShutdown method
/// </summary> /// </summary>
public void DisconnectAllClientsForShutdown() public void DisconnectAllClientsForShutdown()

31
src/PepperDash.Core/Comm/GenericSshClient.cs
View file

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

36
src/PepperDash.Core/Comm/GenericTcpIpClient.cs
View file

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

24
src/PepperDash.Core/Comm/GenericTcpIpClient_ForServer.cs
View file

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

34
src/PepperDash.Core/Comm/GenericTcpIpServer.cs
View file

@ -51,9 +51,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; } public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
/// <summary>
///
/// </summary>
/// <summary> /// <summary>
/// Delegate for ServerHasChokedCallbackDelegate /// Delegate for ServerHasChokedCallbackDelegate
/// </summary> /// </summary>
@ -84,9 +81,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
int MonitorClientFailureCount; int MonitorClientFailureCount;
/// <summary>
/// 3 by default
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the MonitorClientMaxFailureCount /// Gets or sets the MonitorClientMaxFailureCount
/// </summary> /// </summary>
@ -176,9 +170,6 @@ namespace PepperDash.Core
} }
} }
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the Port /// Gets or sets the Port
/// </summary> /// </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> /// <summary>
/// Gets or sets the SharedKey /// Gets or sets the SharedKey
/// </summary> /// </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> /// <summary>
/// Gets or sets the HeartbeatRequiredIntervalMs /// Gets or sets the HeartbeatRequiredIntervalMs
/// </summary> /// </summary>
@ -253,9 +237,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } } 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> /// <summary>
/// Gets or sets the HeartbeatStringToMatch /// Gets or sets the HeartbeatStringToMatch
/// </summary> /// </summary>
@ -274,9 +255,6 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public List<uint> ConnectedClientsIndexes = new List<uint>(); public List<uint> ConnectedClientsIndexes = new List<uint>();
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the BufferSize /// Gets or sets the BufferSize
/// </summary> /// </summary>
@ -341,9 +319,6 @@ namespace PepperDash.Core
#region Methods - Server Actions #region Methods - Server Actions
/// <summary> /// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method /// KillServer method
/// </summary> /// </summary>
public void KillServer() public void KillServer()
@ -401,9 +376,6 @@ namespace PepperDash.Core
} }
} }
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary> /// <summary>
/// Listen method /// Listen method
/// </summary> /// </summary>
@ -461,9 +433,6 @@ namespace PepperDash.Core
} }
} }
/// <summary>
/// Stop Listening
/// </summary>
/// <summary> /// <summary>
/// StopListening method /// StopListening method
/// </summary> /// </summary>
@ -506,9 +475,6 @@ namespace PepperDash.Core
} }
} }
/// <summary> /// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method /// DisconnectAllClientsForShutdown method
/// </summary> /// </summary>
public void DisconnectAllClientsForShutdown() public void DisconnectAllClientsForShutdown()

9
src/PepperDash.Core/Comm/GenericUdpServer.cs
View file

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

3
src/PepperDash.Core/Comm/TcpClientConfigObject.cs
View file

@ -2,9 +2,6 @@
namespace PepperDash.Core 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> /// <summary>
/// Represents a TcpClientConfigObject /// Represents a TcpClientConfigObject
/// </summary> /// </summary>

6
src/PepperDash.Core/CommunicationExtras.cs
View file

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

17
src/PepperDash.Core/Device.cs
View file

@ -5,9 +5,6 @@ using Serilog.Events;
namespace PepperDash.Core namespace PepperDash.Core
{ {
//********************************************************************************************************* //*********************************************************************************************************
/// <summary>
/// The core event and status-bearing class that most if not all device and connectors can derive from.
/// </summary>
/// <summary> /// <summary>
/// Represents a Device /// Represents a Device
/// </summary> /// </summary>
@ -18,9 +15,6 @@ namespace PepperDash.Core
/// Unique Key /// Unique Key
/// </summary> /// </summary>
public string Key { get; protected set; } public string Key { get; protected set; }
/// <summary>
/// Name of the devie
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the Name /// Gets or sets the Name
/// </summary> /// </summary>
@ -102,9 +96,6 @@ namespace PepperDash.Core
_PostActivationActions.Add(act); _PostActivationActions.Add(act);
} }
/// <summary>
/// Executes the preactivation actions
/// </summary>
/// <summary> /// <summary>
/// PreActivate method /// PreActivate method
/// </summary> /// </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> /// <summary>
/// Activate method /// Activate method
/// </summary> /// </summary>
@ -142,9 +128,6 @@ namespace PepperDash.Core
return result; return result;
} }
/// <summary>
/// Executes the postactivation actions
/// </summary>
/// <summary> /// <summary>
/// PostActivate method /// PostActivate method
/// </summary> /// </summary>

6
src/PepperDash.Core/EthernetHelper.cs
View file

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

27
src/PepperDash.Core/EventArgs.cs
View file

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

6
src/PepperDash.Core/JsonStandardObjects/EventArgs and Constants.cs
View file

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

30
src/PepperDash.Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs
View file

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

6
src/PepperDash.Core/JsonToSimpl/Constants.cs
View file

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

3
src/PepperDash.Core/JsonToSimpl/Global.cs
View file

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

7
src/PepperDash.Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs
View file

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

20
src/PepperDash.Core/JsonToSimpl/JsonToSimplChildObjectBase.cs
View file

@ -28,17 +28,11 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary> /// </summary>
public SPlusValuesDelegate GetAllValuesDelegate { get; set; } public SPlusValuesDelegate GetAllValuesDelegate { get; set; }
/// <summary>
/// Use a callback to reduce task switch/threading
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the SetAllPathsDelegate /// Gets or sets the SetAllPathsDelegate
/// </summary> /// </summary>
public SPlusValuesDelegate SetAllPathsDelegate { get; set; } public SPlusValuesDelegate SetAllPathsDelegate { get; set; }
/// <summary>
/// Unique identifier for instance
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the Key /// Gets or sets the Key
/// </summary> /// </summary>
@ -55,9 +49,6 @@ namespace PepperDash.Core.JsonToSimpl
/// </summary> /// </summary>
public string PathSuffix { get; protected set; } public string PathSuffix { get; protected set; }
/// <summary>
/// Indicates if the instance is linked to an object
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the LinkedToObject /// Gets or sets the LinkedToObject
/// </summary> /// </summary>
@ -122,9 +113,6 @@ namespace PepperDash.Core.JsonToSimpl
BoolPaths[index] = path; BoolPaths[index] = path;
} }
/// <summary>
/// Set the JPath for a ushort out index.
/// </summary>
/// <summary> /// <summary>
/// SetUshortPath method /// SetUshortPath method
/// </summary> /// </summary>
@ -135,9 +123,6 @@ namespace PepperDash.Core.JsonToSimpl
UshortPaths[index] = path; UshortPaths[index] = path;
} }
/// <summary>
/// Set the JPath for a string output index.
/// </summary>
/// <summary> /// <summary>
/// SetStringPath method /// SetStringPath method
/// </summary> /// </summary>
@ -148,13 +133,10 @@ namespace PepperDash.Core.JsonToSimpl
StringPaths[index] = path; 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> /// <summary>
/// ProcessAll method /// ProcessAll method
/// </summary> /// </summary>
/// <inheritdoc />
public virtual void ProcessAll() public virtual void ProcessAll()
{ {
if (!LinkedToObject) if (!LinkedToObject)

6
src/PepperDash.Core/JsonToSimpl/JsonToSimplFileMaster.cs
View file

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

3
src/PepperDash.Core/JsonToSimpl/JsonToSimplFixedPathObject.cs
View file

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

10
src/PepperDash.Core/JsonToSimpl/JsonToSimplGenericMaster.cs
View file

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

13
src/PepperDash.Core/JsonToSimpl/JsonToSimplMaster.cs
View file

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

3
src/PepperDash.Core/JsonToSimpl/JsonToSimplPortalFileMaster.cs
View file

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

15
src/PepperDash.Core/Logging/Debug.cs
View file

@ -77,17 +77,11 @@ namespace PepperDash.Core
/// </summary> /// </summary>
public static string FileName = string.Format(@"app{0}Debug.json", InitialParametersClass.ApplicationNumber); public static string FileName = string.Format(@"app{0}Debug.json", InitialParametersClass.ApplicationNumber);
/// <summary>
/// Debug level to set for a given program.
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the Level /// Gets or sets the Level
/// </summary> /// </summary>
public static int Level { get; private set; } 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> /// <summary>
/// Gets or sets the DoNotLoadConfigOnNextBoot /// Gets or sets the DoNotLoadConfigOnNextBoot
/// </summary> /// </summary>
@ -99,9 +93,6 @@ namespace PepperDash.Core
public static bool IsRunningOnAppliance = CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance; public static bool IsRunningOnAppliance = CrestronEnvironment.DevicePlatform == eDevicePlatform.Appliance;
/// <summary>
/// Version for the currently loaded PepperDashCore dll
/// </summary>
/// <summary> /// <summary>
/// Gets or sets the PepperDashCoreVersion /// Gets or sets the PepperDashCoreVersion
/// </summary> /// </summary>
@ -620,9 +611,6 @@ namespace PepperDash.Core
InitialParametersClass.ApplicationNumber, DoNotLoadConfigOnNextBoot); InitialParametersClass.ApplicationNumber, DoNotLoadConfigOnNextBoot);
} }
/// <summary>
///
/// </summary>
/// <summary> /// <summary>
/// ShowDebugLog method /// ShowDebugLog method
/// </summary> /// </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); 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> /// <summary>
/// Enumeration of ErrorLogLevel values /// Enumeration of ErrorLogLevel values
/// </summary> /// </summary>

3
src/PepperDash.Core/Logging/DebugContext.cs
View file

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

3
src/PepperDash.Core/Logging/DebugMemory.cs
View file

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

6
src/PepperDash.Core/PasswordManagement/PasswordClient.cs
View file

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

3
src/PepperDash.Core/PasswordManagement/PasswordManager.cs
View file

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

12
src/PepperDash.Core/SystemInfo/EventArgs and Constants.cs
View file

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

9
src/PepperDash.Core/SystemInfo/SystemInfoToSimpl.cs
View file

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

3
src/PepperDash.Core/Web/RequestHandlers/DefaultRequestHandler.cs
View file

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

21
src/PepperDash.Core/Web/WebApiServer.cs
View file

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

27
src/PepperDash.Core/WebApi/Presets/Preset.cs
View file

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

24
src/PepperDash.Core/WebApi/Presets/User.cs
View file

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

3
src/PepperDash.Core/WebApi/Presets/WebApiPasscodeClient.cs
View file

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

1
src/PepperDash.Core/XSigUtility/Tokens/XSigAnalogToken.cs
View file

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

1
src/PepperDash.Core/XSigUtility/Tokens/XSigDigitalToken.cs
View file

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

1
src/PepperDash.Core/XSigUtility/Tokens/XSigSerialToken.cs
View file

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

3
src/PepperDash.Core/XSigUtility/XSigTokenStreamWriter.cs
View file

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

76
src/PepperDash.Essentials.Core/Bridges/BridgeBase.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/BridgeHelper.cs
View file

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

2
src/PepperDash.Essentials.Core/Bridges/IBridge.cs
View file

@ -3,7 +3,7 @@
namespace PepperDash.Essentials.Core.Bridges namespace PepperDash.Essentials.Core.Bridges
{ {
/// <summary> /// <summary>
/// Defines a device that uses JoinMapBaseAdvanced for its join map /// Defines the contract for IBridgeAdvanced
/// </summary> /// </summary>
public interface IBridgeAdvanced public interface IBridgeAdvanced
{ {

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/AirMediaControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/AppleTvJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/C2nRthsControllerJoinMap.cs
View file

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

2
src/PepperDash.Essentials.Core/Bridges/JoinMaps/CameraControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/CenOdtOccupancySensorBaseJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DisplayControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmBladeChassisControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmChassisControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmRmcControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmTxControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmpsAudioOutputControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmpsMicrophoneControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/DmpsRoutingControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/GenericLightingJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/GenericRelayControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/GlsOccupancySensorBaseJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/GlsPartitionSensorJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/HdMdNxM4kEControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/HdMdxxxCEControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/HdPsXxxControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/Hrxxx0WirelessRemoteControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/IAnalogInputJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/IBasicCommunicationJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/IDigitalInputJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/IDigitalOutputJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/PduJoinMapBase.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/SetTopBoxControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/StatusSignControllerJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/SystemMonitorJoinMap.cs
View file

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

3
src/PepperDash.Essentials.Core/Bridges/JoinMaps/VideoCodecControllerJoinMap.cs
View file

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

24
src/PepperDash.Essentials.Core/Comm and IR/CecPortController.cs
View file

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

28
src/PepperDash.Essentials.Core/Comm and IR/ComPortController.cs
View file

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

26
src/PepperDash.Essentials.Core/Comm and IR/ComSpecJsonConverter.cs
View file

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

29
src/PepperDash.Essentials.Core/Comm and IR/CommFactory.cs
View file

@ -38,6 +38,9 @@ namespace PepperDash.Essentials.Core
/// Returns a comm method of either com port, TCP, SSH, and puts this into the DeviceManager /// Returns a comm method of either com port, TCP, SSH, and puts this into the DeviceManager
/// </summary> /// </summary>
/// <param name="deviceConfig">The Device config object</param> /// <param name="deviceConfig">The Device config object</param>
/// <summary>
/// CreateCommForDevice method
/// </summary>
public static IBasicCommunication CreateCommForDevice(DeviceConfig deviceConfig) public static IBasicCommunication CreateCommForDevice(DeviceConfig deviceConfig)
{ {
EssentialsControlPropertiesConfig controlConfig = GetControlPropertiesConfig(deviceConfig); EssentialsControlPropertiesConfig controlConfig = GetControlPropertiesConfig(deviceConfig);
@ -110,6 +113,9 @@ namespace PepperDash.Essentials.Core
return comm; return comm;
} }
/// <summary>
/// GetComPort method
/// </summary>
public static ComPort GetComPort(EssentialsControlPropertiesConfig config) public static ComPort GetComPort(EssentialsControlPropertiesConfig config)
{ {
var comPar = config.ComParams; var comPar = config.ComParams;
@ -125,6 +131,9 @@ namespace PepperDash.Essentials.Core
/// </summary> /// </summary>
/// <param name="config"></param> /// <param name="config"></param>
/// <returns></returns> /// <returns></returns>
/// <summary>
/// GetCecPort method
/// </summary>
public static ICec GetCecPort(ControlPropertiesConfig config) public static ICec GetCecPort(ControlPropertiesConfig config)
{ {
try try
@ -182,6 +191,9 @@ namespace PepperDash.Essentials.Core
/// return the ControlSystem object from the Global class. /// return the ControlSystem object from the Global class.
/// </summary> /// </summary>
/// <returns>IComPorts device or null if the device is not found or does not implement IComPorts</returns> /// <returns>IComPorts device or null if the device is not found or does not implement IComPorts</returns>
/// <summary>
/// GetIComPortsDeviceFromManagedDevice method
/// </summary>
public static IComPorts GetIComPortsDeviceFromManagedDevice(string ComPortDevKey) public static IComPorts GetIComPortsDeviceFromManagedDevice(string ComPortDevKey)
{ {
if ((ComPortDevKey.Equals("controlSystem", System.StringComparison.OrdinalIgnoreCase) if ((ComPortDevKey.Equals("controlSystem", System.StringComparison.OrdinalIgnoreCase)
@ -199,7 +211,7 @@ namespace PepperDash.Essentials.Core
} }
/// <summary> /// <summary>
/// /// Represents a EssentialsControlPropertiesConfig
/// </summary> /// </summary>
public class EssentialsControlPropertiesConfig : public class EssentialsControlPropertiesConfig :
ControlPropertiesConfig ControlPropertiesConfig
@ -232,6 +244,9 @@ namespace PepperDash.Essentials.Core
} }
[JsonProperty("infinetId", NullValueHandling = NullValueHandling.Ignore)] [JsonProperty("infinetId", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the InfinetId
/// </summary>
public string InfinetId { get; set; } public string InfinetId { get; set; }
/// <summary> /// <summary>
@ -254,10 +269,22 @@ namespace PepperDash.Essentials.Core
} }
} }
/// <summary>
/// Represents a IrControlSpec
/// </summary>
public class IrControlSpec public class IrControlSpec
{ {
/// <summary>
/// Gets or sets the PortDeviceKey
/// </summary>
public string PortDeviceKey { get; set; } public string PortDeviceKey { get; set; }
/// <summary>
/// Gets or sets the PortNumber
/// </summary>
public uint PortNumber { get; set; } public uint PortNumber { get; set; }
/// <summary>
/// Gets or sets the File
/// </summary>
public string File { get; set; } public string File { get; set; }
} }
} }

44
src/PepperDash.Essentials.Core/Comm and IR/ConsoleCommMockDevice.cs
View file

@ -11,20 +11,32 @@ using Serilog.Events;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
/// <summary>
/// Represents a ConsoleCommMockDevice
/// </summary>
public class ConsoleCommMockDevice : EssentialsDevice, ICommunicationMonitor public class ConsoleCommMockDevice : EssentialsDevice, ICommunicationMonitor
{ {
/// <summary>
/// Gets or sets the Communication
/// </summary>
public IBasicCommunication Communication { get; private set; } public IBasicCommunication Communication { get; private set; }
/// <summary>
/// Gets or sets the PortGather
/// </summary>
public CommunicationGather PortGather { get; private set; } public CommunicationGather PortGather { get; private set; }
/// <summary>
/// Gets or sets the CommunicationMonitor
/// </summary>
public StatusMonitorBase CommunicationMonitor { get; private set; } public StatusMonitorBase CommunicationMonitor { get; private set; }
/// <summary> /// <summary>
/// Defaults to \x0a /// Gets or sets the LineEnding
/// </summary> /// </summary>
public string LineEnding { get; set; } public string LineEnding { get; set; }
/// <summary> /// <summary>
/// Set to true to show responses in full hex /// Gets or sets the ShowHexResponse
/// </summary> /// </summary>
public bool ShowHexResponse { get; set; } public bool ShowHexResponse { get; set; }
public ConsoleCommMockDevice(string key, string name, ConsoleCommMockDevicePropertiesConfig props, IBasicCommunication comm) public ConsoleCommMockDevice(string key, string name, ConsoleCommMockDevicePropertiesConfig props, IBasicCommunication comm)
@ -37,6 +49,10 @@ namespace PepperDash.Essentials.Core
LineEnding = props.LineEnding; LineEnding = props.LineEnding;
} }
/// <summary>
/// CustomActivate method
/// </summary>
/// <inheritdoc />
public override bool CustomActivate() public override bool CustomActivate()
{ {
Communication.Connect(); Communication.Connect();
@ -56,9 +72,18 @@ namespace PepperDash.Essentials.Core
} }
} }
/// <summary>
/// Represents a ConsoleCommMockDevicePropertiesConfig
/// </summary>
public class ConsoleCommMockDevicePropertiesConfig public class ConsoleCommMockDevicePropertiesConfig
{ {
/// <summary>
/// Gets or sets the LineEnding
/// </summary>
public string LineEnding { get; set; } public string LineEnding { get; set; }
/// <summary>
/// Gets or sets the CommunicationMonitorProperties
/// </summary>
public CommunicationMonitorConfig CommunicationMonitorProperties { get; set; } public CommunicationMonitorConfig CommunicationMonitorProperties { get; set; }
public ConsoleCommMockDevicePropertiesConfig() public ConsoleCommMockDevicePropertiesConfig()
@ -67,6 +92,9 @@ namespace PepperDash.Essentials.Core
} }
} }
/// <summary>
/// Represents a ConsoleCommMockDeviceFactory
/// </summary>
public class ConsoleCommMockDeviceFactory : EssentialsDeviceFactory<ConsoleCommMockDevice> public class ConsoleCommMockDeviceFactory : EssentialsDeviceFactory<ConsoleCommMockDevice>
{ {
public ConsoleCommMockDeviceFactory() public ConsoleCommMockDeviceFactory()
@ -74,6 +102,10 @@ namespace PepperDash.Essentials.Core
TypeNames = new List<string>() { "commmock" }; TypeNames = new List<string>() { "commmock" };
} }
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc) public override EssentialsDevice BuildDevice(DeviceConfig dc)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Comm Mock Device"); Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Comm Mock Device");

17
src/PepperDash.Essentials.Core/Comm and IR/GenericComm.cs
View file

@ -44,12 +44,18 @@ namespace PepperDash.Essentials.Core
} }
/// <summary>
/// BuildDevice method
/// </summary>
public static IKeyed BuildDevice(DeviceConfig dc) public static IKeyed BuildDevice(DeviceConfig dc)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Comm Device"); Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Comm Device");
return new GenericComm(dc); return new GenericComm(dc);
} }
/// <summary>
/// SetPortConfig method
/// </summary>
public void SetPortConfig(string portConfig) public void SetPortConfig(string portConfig)
{ {
// TODO: Deserialize new EssentialsControlPropertiesConfig and handle as necessary // TODO: Deserialize new EssentialsControlPropertiesConfig and handle as necessary
@ -71,6 +77,10 @@ namespace PepperDash.Essentials.Core
ConfigWriter.UpdateDeviceConfig(config); ConfigWriter.UpdateDeviceConfig(config);
} }
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{ {
var joinMap = new IBasicCommunicationJoinMap(joinStart); var joinMap = new IBasicCommunicationJoinMap(joinStart);
@ -129,6 +139,9 @@ namespace PepperDash.Essentials.Core
} }
} }
/// <summary>
/// Represents a GenericCommFactory
/// </summary>
public class GenericCommFactory : EssentialsDeviceFactory<GenericComm> public class GenericCommFactory : EssentialsDeviceFactory<GenericComm>
{ {
public GenericCommFactory() public GenericCommFactory()
@ -136,6 +149,10 @@ namespace PepperDash.Essentials.Core
TypeNames = new List<string>() { "genericComm" }; TypeNames = new List<string>() { "genericComm" };
} }
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc) public override EssentialsDevice BuildDevice(DeviceConfig dc)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Comm Device"); Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Comm Device");

30
src/PepperDash.Essentials.Core/Comm and IR/GenericHttpClient.cs
View file

@ -5,6 +5,9 @@ using System;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
[Obsolete("Please use the builtin HttpClient class instead: https://learn.microsoft.com/en-us/dotnet/fundamentals/networking/http/httpclient-guidelines")] [Obsolete("Please use the builtin HttpClient class instead: https://learn.microsoft.com/en-us/dotnet/fundamentals/networking/http/httpclient-guidelines")]
/// <summary>
/// Represents a GenericHttpClient
/// </summary>
public class GenericHttpClient : Device, IBasicCommunication public class GenericHttpClient : Device, IBasicCommunication
{ {
private readonly HttpClient Client; private readonly HttpClient Client;
@ -25,6 +28,9 @@ namespace PepperDash.Essentials.Core
/// ///
/// </summary> /// </summary>
/// <param name="path"></param> /// <param name="path"></param>
/// <summary>
/// SendText method
/// </summary>
public void SendText(string path) public void SendText(string path)
{ {
HttpClientRequest request = new HttpClientRequest(); HttpClientRequest request = new HttpClientRequest();
@ -40,6 +46,9 @@ namespace PepperDash.Essentials.Core
HttpClient.DISPATCHASYNC_ERROR error = Client.DispatchAsyncEx(request, Response, request); HttpClient.DISPATCHASYNC_ERROR error = Client.DispatchAsyncEx(request, Response, request);
} }
/// <summary>
/// SendTextNoResponse method
/// </summary>
public void SendTextNoResponse(string format, params object[] items) public void SendTextNoResponse(string format, params object[] items)
{ {
HttpClientRequest request = new HttpClientRequest(); HttpClientRequest request = new HttpClientRequest();
@ -65,6 +74,9 @@ namespace PepperDash.Essentials.Core
#region IBasicCommunication Members #region IBasicCommunication Members
/// <summary>
/// SendBytes method
/// </summary>
public void SendBytes(byte[] bytes) public void SendBytes(byte[] bytes)
{ {
throw new NotImplementedException(); throw new NotImplementedException();
@ -78,11 +90,17 @@ namespace PepperDash.Essentials.Core
public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived; public event EventHandler<GenericCommMethodReceiveBytesArgs> BytesReceived;
/// <summary>
/// Connect method
/// </summary>
public void Connect() public void Connect()
{ {
throw new NotImplementedException(); throw new NotImplementedException();
} }
/// <summary>
/// Disconnect method
/// </summary>
public void Disconnect() public void Disconnect()
{ {
throw new NotImplementedException(); throw new NotImplementedException();
@ -97,10 +115,22 @@ namespace PepperDash.Essentials.Core
#endregion #endregion
} }
/// <summary>
/// Represents a GenericHttpClientEventArgs
/// </summary>
public class GenericHttpClientEventArgs : EventArgs public class GenericHttpClientEventArgs : EventArgs
{ {
/// <summary>
/// Gets or sets the ResponseText
/// </summary>
public string ResponseText { get; private set; } public string ResponseText { get; private set; }
/// <summary>
/// Gets or sets the RequestPath
/// </summary>
public string RequestPath { get; private set; } public string RequestPath { get; private set; }
/// <summary>
/// Gets or sets the Error
/// </summary>
public HTTP_CALLBACK_ERROR Error { get; set; } public HTTP_CALLBACK_ERROR Error { get; set; }
public GenericHttpClientEventArgs(string response, string request, HTTP_CALLBACK_ERROR error) public GenericHttpClientEventArgs(string response, string request, HTTP_CALLBACK_ERROR error)
{ {

19
src/PepperDash.Essentials.Core/Comm and IR/IRPortHelper.cs
View file

@ -83,6 +83,9 @@ namespace PepperDash.Essentials.Core
} }
} }
/// <summary>
/// GetIrOutputPort method
/// </summary>
public static IROutputPort GetIrOutputPort(DeviceConfig dc) public static IROutputPort GetIrOutputPort(DeviceConfig dc)
{ {
var irControllerKey = dc.Key + "-ir"; var irControllerKey = dc.Key + "-ir";
@ -142,6 +145,9 @@ namespace PepperDash.Essentials.Core
return port; return port;
} }
/// <summary>
/// GetIrOutputPortController method
/// </summary>
public static IrOutputPortController GetIrOutputPortController(DeviceConfig config) public static IrOutputPortController GetIrOutputPortController(DeviceConfig config)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Attempting to create new Ir Port Controller"); Debug.LogMessage(LogEventLevel.Debug, "Attempting to create new Ir Port Controller");
@ -159,8 +165,8 @@ namespace PepperDash.Essentials.Core
/* /*
/// <summary> /// <summary>
/// Returns a ready-to-go IrOutputPortController from a DeviceConfig object. /// GetIrOutputPortController method
/// </summary> /// </summary>
public static IrOutputPortController GetIrOutputPortController(DeviceConfig devConf) public static IrOutputPortController GetIrOutputPortController(DeviceConfig devConf)
{ {
var irControllerKey = devConf.Key + "-ir"; var irControllerKey = devConf.Key + "-ir";
@ -222,12 +228,15 @@ namespace PepperDash.Essentials.Core
}*/ }*/
} }
/// <summary> /// <summary>
/// Wrapper to help in IR port creation /// Represents a IrOutPortConfig
/// </summary> /// </summary>
public class IrOutPortConfig public class IrOutPortConfig
{ {
[JsonProperty("port")] [JsonProperty("port")]
/// <summary>
/// Gets or sets the Port
/// </summary>
public IROutputPort Port { get; set; } public IROutputPort Port { get; set; }
[JsonProperty("fileName")] [JsonProperty("fileName")]

3
src/PepperDash.Essentials.Core/Config/AudioControlPointListItem.cs
View file

@ -8,6 +8,9 @@ using System.Threading.Tasks;
namespace PepperDash.Essentials.Core.Config namespace PepperDash.Essentials.Core.Config
{ {
/// <summary>
/// Represents a AudioControlPointListItem
/// </summary>
public class AudioControlPointListItem public class AudioControlPointListItem
{ {
[JsonProperty("levelControls")] [JsonProperty("levelControls")]

9
src/PepperDash.Essentials.Core/Config/BasicConfig.cs
View file

@ -33,6 +33,9 @@ namespace PepperDash.Essentials.Core.Config
public Dictionary<string, Dictionary<string, CameraListItem>> CameraLists { get; set; } public Dictionary<string, Dictionary<string, CameraListItem>> CameraLists { get; set; }
[JsonProperty("tieLines")] [JsonProperty("tieLines")]
/// <summary>
/// Gets or sets the TieLines
/// </summary>
public List<TieLineConfig> TieLines { get; set; } public List<TieLineConfig> TieLines { get; set; }
[JsonProperty("joinMaps")] [JsonProperty("joinMaps")]
@ -81,6 +84,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary> /// </summary>
/// <param name="key">key of the list to retrieve</param> /// <param name="key">key of the list to retrieve</param>
/// <returns>AudioControlPointList if the key exists, null otherwise</returns> /// <returns>AudioControlPointList if the key exists, null otherwise</returns>
/// <summary>
/// GetAudioControlPointListForKey method
/// </summary>
public AudioControlPointListItem GetAudioControlPointListForKey(string key) public AudioControlPointListItem GetAudioControlPointListForKey(string key)
{ {
if (AudioControlPointLists == null || string.IsNullOrEmpty(key) || !AudioControlPointLists.ContainsKey(key)) if (AudioControlPointLists == null || string.IsNullOrEmpty(key) || !AudioControlPointLists.ContainsKey(key))
@ -105,6 +111,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary> /// </summary>
/// <param name="key">Key of desired device</param> /// <param name="key">Key of desired device</param>
/// <returns></returns> /// <returns></returns>
/// <summary>
/// GetDeviceForKey method
/// </summary>
public DeviceConfig GetDeviceForKey(string key) public DeviceConfig GetDeviceForKey(string key)
{ {
if (string.IsNullOrEmpty(key)) if (string.IsNullOrEmpty(key))

5
src/PepperDash.Essentials.Core/Config/ConfigPropertiesHelpers.cs
View file

@ -11,10 +11,13 @@ using Newtonsoft.Json.Linq;
namespace PepperDash.Essentials.Core.Config namespace PepperDash.Essentials.Core.Config
{ {
/// <summary>
/// Represents a ConfigPropertiesHelpers
/// </summary>
public class ConfigPropertiesHelpers public class ConfigPropertiesHelpers
{ {
/// <summary> /// <summary>
/// Returns the value of properties.hasAudio, or false if not defined /// GetHasAudio method
/// </summary> /// </summary>
public static bool GetHasAudio(DeviceConfig deviceConfig) public static bool GetHasAudio(DeviceConfig deviceConfig)
{ {

31
src/PepperDash.Essentials.Core/Config/DeviceConfig.cs
View file

@ -13,25 +13,46 @@ using PepperDash.Essentials.Core;
namespace PepperDash.Essentials.Core.Config namespace PepperDash.Essentials.Core.Config
{ {
/// <summary>
/// Represents a DeviceConfig
/// </summary>
public class DeviceConfig public class DeviceConfig
{ {
[JsonProperty("key")] [JsonProperty("key")]
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; set; } public string Key { get; set; }
[JsonProperty("uid")] [JsonProperty("uid")]
/// <summary>
/// Gets or sets the Uid
/// </summary>
public int Uid { get; set; } public int Uid { get; set; }
[JsonProperty("name")] [JsonProperty("name")]
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; } public string Name { get; set; }
[JsonProperty("group")] [JsonProperty("group")]
/// <summary>
/// Gets or sets the Group
/// </summary>
public string Group { get; set; } public string Group { get; set; }
[JsonProperty("type")] [JsonProperty("type")]
/// <summary>
/// Gets or sets the Type
/// </summary>
public string Type { get; set; } public string Type { get; set; }
[JsonProperty("properties")] [JsonProperty("properties")]
[JsonConverter(typeof(DevicePropertiesConverter))] [JsonConverter(typeof(DevicePropertiesConverter))]
/// <summary>
/// Gets or sets the Properties
/// </summary>
public JToken Properties { get; set; } public JToken Properties { get; set; }
public DeviceConfig(DeviceConfig dc) public DeviceConfig(DeviceConfig dc)
@ -51,11 +72,14 @@ namespace PepperDash.Essentials.Core.Config
} }
/// <summary> /// <summary>
/// /// Represents a DevicePropertiesConverter
/// </summary> /// </summary>
public class DevicePropertiesConverter : JsonConverter public class DevicePropertiesConverter : JsonConverter
{ {
/// <summary>
/// CanConvert method
/// </summary>
public override bool CanConvert(Type objectType) public override bool CanConvert(Type objectType)
{ {
return objectType == typeof(JToken); return objectType == typeof(JToken);
@ -66,6 +90,7 @@ namespace PepperDash.Essentials.Core.Config
return JToken.ReadFrom(reader); return JToken.ReadFrom(reader);
} }
/// <inheritdoc />
public override bool CanWrite public override bool CanWrite
{ {
get get
@ -74,6 +99,10 @@ namespace PepperDash.Essentials.Core.Config
} }
} }
/// <summary>
/// WriteJson method
/// </summary>
/// <inheritdoc />
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{ {
throw new NotImplementedException("SOD OFF HOSER"); throw new NotImplementedException("SOD OFF HOSER");

9
src/PepperDash.Essentials.Core/Config/Essentials/ConfigReader.cs
View file

@ -26,6 +26,9 @@ namespace PepperDash.Essentials.Core.Config
public static EssentialsConfig ConfigObject { get; private set; } public static EssentialsConfig ConfigObject { get; private set; }
/// <summary>
/// LoadConfig2 method
/// </summary>
public static bool LoadConfig2() public static bool LoadConfig2()
{ {
Debug.LogMessage(LogEventLevel.Information, "Loading unmerged system/template portal configuration file."); Debug.LogMessage(LogEventLevel.Information, "Loading unmerged system/template portal configuration file.");
@ -157,6 +160,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary> /// </summary>
/// <param name="filePath"></param> /// <param name="filePath"></param>
/// <returns></returns> /// <returns></returns>
/// <summary>
/// GetConfigFiles method
/// </summary>
public static FileInfo[] GetConfigFiles(string filePath) public static FileInfo[] GetConfigFiles(string filePath)
{ {
// Get the directory // Get the directory
@ -189,6 +195,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary> /// </summary>
/// <param name="key"></param> /// <param name="key"></param>
/// <returns></returns> /// <returns></returns>
/// <summary>
/// GetGroupForDeviceKey method
/// </summary>
public static string GetGroupForDeviceKey(string key) public static string GetGroupForDeviceKey(string key)
{ {
var dev = ConfigObject.Devices.FirstOrDefault(d => d.Key.Equals(key, StringComparison.OrdinalIgnoreCase)); var dev = ConfigObject.Devices.FirstOrDefault(d => d.Key.Equals(key, StringComparison.OrdinalIgnoreCase));

12
src/PepperDash.Essentials.Core/Config/Essentials/ConfigUpdater.cs
View file

@ -20,6 +20,9 @@ namespace PepperDash.Essentials.Core.Config
{ {
public static event EventHandler<ConfigStatusEventArgs> ConfigStatusChanged; public static event EventHandler<ConfigStatusEventArgs> ConfigStatusChanged;
/// <summary>
/// GetConfigFromServer method
/// </summary>
public static void GetConfigFromServer(string url) public static void GetConfigFromServer(string url)
{ {
Debug.LogMessage(LogEventLevel.Information, "Attempting to get new config from '{0}'", url); Debug.LogMessage(LogEventLevel.Information, "Attempting to get new config from '{0}'", url);
@ -202,6 +205,9 @@ namespace PepperDash.Essentials.Core.Config
} }
/// <summary>
/// Enumeration of eUpdateStatus values
/// </summary>
public enum eUpdateStatus public enum eUpdateStatus
{ {
UpdateStarted, UpdateStarted,
@ -214,8 +220,14 @@ namespace PepperDash.Essentials.Core.Config
UpdateFailed UpdateFailed
} }
/// <summary>
/// Represents a ConfigStatusEventArgs
/// </summary>
public class ConfigStatusEventArgs : EventArgs public class ConfigStatusEventArgs : EventArgs
{ {
/// <summary>
/// Gets or sets the UpdateStatus
/// </summary>
public eUpdateStatus UpdateStatus { get; private set; } public eUpdateStatus UpdateStatus { get; private set; }
public ConfigStatusEventArgs(eUpdateStatus status) public ConfigStatusEventArgs(eUpdateStatus status)

12
src/PepperDash.Essentials.Core/Config/Essentials/ConfigWriter.cs
View file

@ -31,6 +31,9 @@ namespace PepperDash.Essentials.Core.Config
/// <param name="deviceKey"></param> /// <param name="deviceKey"></param>
/// <param name="properties"></param> /// <param name="properties"></param>
/// <returns></returns> /// <returns></returns>
/// <summary>
/// UpdateDeviceProperties method
/// </summary>
public static bool UpdateDeviceProperties(string deviceKey, JToken properties) public static bool UpdateDeviceProperties(string deviceKey, JToken properties)
{ {
bool success = false; bool success = false;
@ -53,6 +56,9 @@ namespace PepperDash.Essentials.Core.Config
return success; return success;
} }
/// <summary>
/// UpdateDeviceConfig method
/// </summary>
public static bool UpdateDeviceConfig(DeviceConfig config) public static bool UpdateDeviceConfig(DeviceConfig config)
{ {
bool success = false; bool success = false;
@ -73,6 +79,9 @@ namespace PepperDash.Essentials.Core.Config
return success; return success;
} }
/// <summary>
/// UpdateRoomConfig method
/// </summary>
public static bool UpdateRoomConfig(DeviceConfig config) public static bool UpdateRoomConfig(DeviceConfig config)
{ {
bool success = false; bool success = false;
@ -124,6 +133,9 @@ namespace PepperDash.Essentials.Core.Config
/// </summary> /// </summary>
/// <param name="filepath"></param> /// <param name="filepath"></param>
/// <param name="o"></param> /// <param name="o"></param>
/// <summary>
/// WriteFile method
/// </summary>
public static void WriteFile(string filePath, string configData) public static void WriteFile(string filePath, string configData)
{ {
if (WriteTimer != null) if (WriteTimer != null)

12
src/PepperDash.Essentials.Core/Config/Essentials/EssentialsConfig.cs
View file

@ -68,6 +68,9 @@ namespace PepperDash.Essentials.Core.Config
} }
[JsonProperty("rooms")] [JsonProperty("rooms")]
/// <summary>
/// Gets or sets the Rooms
/// </summary>
public List<DeviceConfig> Rooms { get; set; } public List<DeviceConfig> Rooms { get; set; }
@ -78,11 +81,14 @@ namespace PepperDash.Essentials.Core.Config
} }
} }
/// <summary> /// <summary>
/// /// Represents a SystemTemplateConfigs
/// </summary> /// </summary>
public class SystemTemplateConfigs public class SystemTemplateConfigs
{ {
/// <summary>
/// Gets or sets the System
/// </summary>
public EssentialsConfig System { get; set; } public EssentialsConfig System { get; set; }
public EssentialsConfig Template { get; set; } public EssentialsConfig Template { get; set; }

3
src/PepperDash.Essentials.Core/Config/ILoadConfig.cs
View file

@ -6,6 +6,9 @@ using System.Threading.Tasks;
namespace PepperDash.Essentials.Core namespace PepperDash.Essentials.Core
{ {
/// <summary>
/// Defines the contract for ILoadConfig
/// </summary>
public interface ILoadConfig public interface ILoadConfig
{ {
void GoWithLoad(); void GoWithLoad();

17
src/PepperDash.Essentials.Core/Config/InfoConfig.cs
View file

@ -22,18 +22,33 @@ namespace PepperDash.Essentials.Core.Config
public string Type { get; set; } public string Type { get; set; }
[JsonProperty("version")] [JsonProperty("version")]
/// <summary>
/// Gets or sets the Version
/// </summary>
public string Version { get; set; } public string Version { get; set; }
[JsonProperty("runtimeInfo")] [JsonProperty("runtimeInfo")]
/// <summary>
/// Gets or sets the RuntimeInfo
/// </summary>
public RuntimeInfo RuntimeInfo { get; set; } public RuntimeInfo RuntimeInfo { get; set; }
[JsonProperty("comment")] [JsonProperty("comment")]
/// <summary>
/// Gets or sets the Comment
/// </summary>
public string Comment { get; set; } public string Comment { get; set; }
[JsonProperty("hostname")] [JsonProperty("hostname")]
/// <summary>
/// Gets or sets the HostName
/// </summary>
public string HostName { get; set; } public string HostName { get; set; }
[JsonProperty("appNumber")] [JsonProperty("appNumber")]
/// <summary>
/// Gets or sets the AppNumber
/// </summary>
public uint AppNumber { get; set; } public uint AppNumber { get; set; }
public InfoConfig() public InfoConfig()
@ -52,7 +67,7 @@ namespace PepperDash.Essentials.Core.Config
/// <summary> /// <summary>
/// Represents runtime information about the program/processor /// Represents a RuntimeInfo
/// </summary> /// </summary>
public class RuntimeInfo public class RuntimeInfo
{ {

6
src/PepperDash.Essentials.Core/Config/SourceDevicePropertiesConfigBase.cs
View file

@ -6,8 +6,14 @@ using Crestron.SimplSharp;
namespace PepperDash.Essentials.Core.Config namespace PepperDash.Essentials.Core.Config
{ {
/// <summary>
/// Represents a SourceDevicePropertiesConfigBase
/// </summary>
public class SourceDevicePropertiesConfigBase public class SourceDevicePropertiesConfigBase
{ {
/// <summary>
/// Gets or sets the DisableSharing
/// </summary>
public bool DisableSharing { get; set; } public bool DisableSharing { get; set; }
} }
} }

45
src/PepperDash.Essentials.Core/Crestron/CrestronGenericBaseDevice.cs
View file

@ -14,18 +14,26 @@ namespace PepperDash.Essentials.Core
protected GenericBase Hardware; protected GenericBase Hardware;
/// <summary> /// <summary>
/// Returns a list containing the Outputs that we want to expose. /// Gets or sets the Feedbacks
/// </summary> /// </summary>
public FeedbackCollection<Feedback> Feedbacks { get; private set; } public FeedbackCollection<Feedback> Feedbacks { get; private set; }
/// <summary>
/// Gets or sets the IsOnline
/// </summary>
public BoolFeedback IsOnline { get; private set; } public BoolFeedback IsOnline { get; private set; }
/// <summary>
/// Gets or sets the IsRegistered
/// </summary>
public BoolFeedback IsRegistered { get; private set; } public BoolFeedback IsRegistered { get; private set; }
/// <summary>
/// Gets or sets the IpConnectionsText
/// </summary>
public StringFeedback IpConnectionsText { get; private set; } public StringFeedback IpConnectionsText { get; private set; }
/// <summary> /// <summary>
/// Used by implementing classes to prevent registration with Crestron TLDM. For /// Gets or sets the PreventRegistration
/// devices like RMCs and TXs attached to a chassis. /// </summary>
/// </summary>
public bool PreventRegistration { get; protected set; } public bool PreventRegistration { get; protected set; }
protected CrestronGenericBaseDevice(string key, string name, GenericBase hardware) protected CrestronGenericBaseDevice(string key, string name, GenericBase hardware)
@ -60,10 +68,10 @@ namespace PepperDash.Essentials.Core
CommunicationMonitor = new CrestronGenericBaseCommunicationMonitor(this, hardware, 120000, 300000); CommunicationMonitor = new CrestronGenericBaseCommunicationMonitor(this, hardware, 120000, 300000);
} }
/// <summary> /// <summary>
/// Make sure that overriding classes call this! /// CustomActivate method
/// Registers the Crestron device, connects up to the base events, starts communication monitor /// </summary>
/// </summary> /// <inheritdoc />
public override bool CustomActivate() public override bool CustomActivate()
{ {
Debug.LogMessage(LogEventLevel.Information, this, "Activating"); Debug.LogMessage(LogEventLevel.Information, this, "Activating");
@ -111,6 +119,10 @@ namespace PepperDash.Essentials.Core
/// This disconnects events and unregisters the base hardware device. /// This disconnects events and unregisters the base hardware device.
/// </summary> /// </summary>
/// <returns></returns> /// <returns></returns>
/// <summary>
/// Deactivate method
/// </summary>
/// <inheritdoc />
public override bool Deactivate() public override bool Deactivate()
{ {
CommunicationMonitor.Stop(); CommunicationMonitor.Stop();
@ -127,6 +139,9 @@ namespace PepperDash.Essentials.Core
/// Adds feedback(s) to the list /// Adds feedback(s) to the list
/// </summary> /// </summary>
/// <param name="newFbs"></param> /// <param name="newFbs"></param>
/// <summary>
/// AddToFeedbackList method
/// </summary>
public void AddToFeedbackList(params Feedback[] newFbs) public void AddToFeedbackList(params Feedback[] newFbs)
{ {
foreach (var f in newFbs) foreach (var f in newFbs)
@ -158,11 +173,17 @@ namespace PepperDash.Essentials.Core
#region IStatusMonitor Members #region IStatusMonitor Members
/// <summary>
/// Gets or sets the CommunicationMonitor
/// </summary>
public StatusMonitorBase CommunicationMonitor { get; private set; } public StatusMonitorBase CommunicationMonitor { get; private set; }
#endregion #endregion
#region IUsageTracking Members #region IUsageTracking Members
/// <summary>
/// Gets or sets the UsageTracker
/// </summary>
public UsageTracking UsageTracker { get; set; } public UsageTracking UsageTracker { get; set; }
#endregion #endregion
@ -185,6 +206,9 @@ namespace PepperDash.Essentials.Core
//*********************************************************************************** //***********************************************************************************
/// <summary>
/// Represents a CrestronGenericBaseDeviceEventIds
/// </summary>
public class CrestronGenericBaseDeviceEventIds public class CrestronGenericBaseDeviceEventIds
{ {
public const uint IsOnline = 1; public const uint IsOnline = 1;
@ -196,6 +220,9 @@ namespace PepperDash.Essentials.Core
/// </summary> /// </summary>
public static class GenericBaseExtensions public static class GenericBaseExtensions
{ {
/// <summary>
/// RegisterWithLogging method
/// </summary>
public static eDeviceRegistrationUnRegistrationResponse RegisterWithLogging(this GenericBase device, string key) public static eDeviceRegistrationUnRegistrationResponse RegisterWithLogging(this GenericBase device, string key)
{ {
var result = device.Register(); var result = device.Register();

20
src/PepperDash.Essentials.Core/CrestronIO/GenericDigitalInputDevice.cs
View file

@ -17,10 +17,19 @@ using Serilog.Events;
namespace PepperDash.Essentials.Core.CrestronIO namespace PepperDash.Essentials.Core.CrestronIO
{ {
[Description("Wrapper class for Digital Input")] [Description("Wrapper class for Digital Input")]
/// <summary>
/// Represents a GenericDigitalInputDevice
/// </summary>
public class GenericDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput public class GenericDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput
{ {
/// <summary>
/// Gets or sets the InputPort
/// </summary>
public DigitalInput InputPort { get; private set; } public DigitalInput InputPort { get; private set; }
/// <summary>
/// Gets or sets the InputStateFeedback
/// </summary>
public BoolFeedback InputStateFeedback { get; private set; } public BoolFeedback InputStateFeedback { get; private set; }
Func<bool> InputStateFeedbackFunc Func<bool> InputStateFeedbackFunc
@ -103,6 +112,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking #region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{ {
var joinMap = new IDigitalInputJoinMap(joinStart); var joinMap = new IDigitalInputJoinMap(joinStart);
@ -139,6 +152,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Factory #region Factory
/// <summary>
/// Represents a GenericDigitalInputDeviceFactory
/// </summary>
public class GenericDigitalInputDeviceFactory : EssentialsDeviceFactory<GenericDigitalInputDevice> public class GenericDigitalInputDeviceFactory : EssentialsDeviceFactory<GenericDigitalInputDevice>
{ {
public GenericDigitalInputDeviceFactory() public GenericDigitalInputDeviceFactory()
@ -146,6 +162,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "digitalinput" }; TypeNames = new List<string>() { "digitalinput" };
} }
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc) public override EssentialsDevice BuildDevice(DeviceConfig dc)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Digital Input Device"); Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Digital Input Device");

20
src/PepperDash.Essentials.Core/CrestronIO/GenericRelayDevice.cs
View file

@ -115,16 +115,25 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Methods #region Methods
/// <summary>
/// OpenRelay method
/// </summary>
public void OpenRelay() public void OpenRelay()
{ {
RelayOutput.State = false; RelayOutput.State = false;
} }
/// <summary>
/// CloseRelay method
/// </summary>
public void CloseRelay() public void CloseRelay()
{ {
RelayOutput.State = true; RelayOutput.State = true;
} }
/// <summary>
/// ToggleRelayState method
/// </summary>
public void ToggleRelayState() public void ToggleRelayState()
{ {
if (RelayOutput.State == true) if (RelayOutput.State == true)
@ -151,6 +160,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking #region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{ {
var joinMap = new GenericRelayControllerJoinMap(joinStart); var joinMap = new GenericRelayControllerJoinMap(joinStart);
@ -194,6 +207,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Factory #region Factory
/// <summary>
/// Represents a GenericRelayDeviceFactory
/// </summary>
public class GenericRelayDeviceFactory : EssentialsDeviceFactory<GenericRelayDevice> public class GenericRelayDeviceFactory : EssentialsDeviceFactory<GenericRelayDevice>
{ {
public GenericRelayDeviceFactory() public GenericRelayDeviceFactory()
@ -201,6 +217,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "relayoutput" }; TypeNames = new List<string>() { "relayoutput" };
} }
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc) public override EssentialsDevice BuildDevice(DeviceConfig dc)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Relay Device"); Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Relay Device");

17
src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportAnalogInputDevice.cs
View file

@ -70,6 +70,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
/// Set minimum voltage change for device to update voltage changed method /// Set minimum voltage change for device to update voltage changed method
/// </summary> /// </summary>
/// <param name="value">valid values range from 0 - 65535, representing the full 100% range of the processor voltage source. Check processor documentation for details</param> /// <param name="value">valid values range from 0 - 65535, representing the full 100% range of the processor voltage source. Check processor documentation for details</param>
/// <summary>
/// SetMinimumChange method
/// </summary>
public void SetMinimumChange(ushort value) public void SetMinimumChange(ushort value)
{ {
InputPort.AnalogMinChange = value; InputPort.AnalogMinChange = value;
@ -88,6 +91,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking #region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{ {
var joinMap = new IAnalogInputJoinMap(joinStart); var joinMap = new IAnalogInputJoinMap(joinStart);
@ -139,6 +146,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#endregion #endregion
/// <summary>
/// GetVersiportDigitalInput method
/// </summary>
public static Versiport GetVersiportDigitalInput(IOPortConfig dc) public static Versiport GetVersiportDigitalInput(IOPortConfig dc)
{ {
@ -188,6 +198,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
} }
/// <summary>
/// Represents a GenericVersiportAbalogInputDeviceFactory
/// </summary>
public class GenericVersiportAbalogInputDeviceFactory : EssentialsDeviceFactory<GenericVersiportAnalogInputDevice> public class GenericVersiportAbalogInputDeviceFactory : EssentialsDeviceFactory<GenericVersiportAnalogInputDevice>
{ {
public GenericVersiportAbalogInputDeviceFactory() public GenericVersiportAbalogInputDeviceFactory()
@ -195,6 +208,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "versiportanaloginput" }; TypeNames = new List<string>() { "versiportanaloginput" };
} }
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc) public override EssentialsDevice BuildDevice(DeviceConfig dc)
{ {
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Versiport Device"); Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Versiport Device");

Some files were not shown because too many files have changed in this diff Show more