diff --git a/Pepperdash Core/Pepperdash Core/Comm/CommunicationGather.cs b/Pepperdash Core/Pepperdash Core/Comm/CommunicationGather.cs index 5c4ed71..f71a496 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/CommunicationGather.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/CommunicationGather.cs @@ -51,7 +51,7 @@ namespace PepperDash.Core string[] StringDelimiters; /// - /// Fires up a gather, given a IBasicCommunicaion port and char for de + /// Constructor for using a char delimiter /// /// /// @@ -63,7 +63,7 @@ namespace PepperDash.Core } /// - /// + /// Constructor for using a single string delimiter /// /// /// @@ -72,6 +72,11 @@ namespace PepperDash.Core { } + /// + /// Constructor for using an array of string delimiters + /// + /// + /// public CommunicationGather(ICommunicationReceiver port, string[] delimiters) { Port = port; diff --git a/Pepperdash Core/Pepperdash Core/Comm/CommunicationStreamDebugging.cs b/Pepperdash Core/Pepperdash Core/Comm/CommunicationStreamDebugging.cs index 60ed238..0a38d82 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/CommunicationStreamDebugging.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/CommunicationStreamDebugging.cs @@ -137,9 +137,21 @@ namespace PepperDash.Core [Flags] public enum eStreamDebuggingSetting { + /// + /// Debug off + /// Off = 0, + /// + /// Debug received data + /// Rx = 1, + /// + /// Debug transmitted data + /// Tx = 2, + /// + /// Debug both received and transmitted data + /// Both = Rx | Tx } @@ -149,8 +161,17 @@ namespace PepperDash.Core [Flags] public enum eStreamDebuggingDataTypeSettings { + /// + /// Debug data in byte format + /// Bytes = 0, + /// + /// Debug data in text format + /// Text = 1, + /// + /// Debug data in both byte and text formats + /// Both = Bytes | Text, } } diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericHttpSseClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericHttpSseClient.cs index d871841..3b941c9 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericHttpSseClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericHttpSseClient.cs @@ -159,7 +159,7 @@ namespace PepperDash.Core /// /// /// - /// + /// /// /// private void GetResponseStreamCallback(HttpClientRequest request, HTTP_CALLBACK_ERROR error, object status) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient.cs index fcc59b9..ec166f3 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient.cs @@ -416,6 +416,10 @@ namespace PepperDash.Core } + /// + /// Deactivate the client + /// + /// public override bool Deactivate() { if (_client != null) @@ -604,30 +608,6 @@ namespace PepperDash.Core ConnectFailTimer.Dispose(); ConnectFailTimer = null; } - - /// - /// Internal call to close up client. ALWAYS use this when disconnecting. - /// - //void Cleanup() - //{ - // IsTryingToConnect = false; - - // if (_client != null) - // { - // //SecureClient.DisconnectFromServer(); - // Debug.Console(2, this, "Disconnecting _client {0}", DisconnectCalledByUser ? ", Called by user" : ""); - // _client.SocketStatusChange -= Client_SocketStatusChange; - // _client.Dispose(); - // _client = null; - // } - // if (ConnectFailTimer != null) - // { - // ConnectFailTimer.Stop(); - // ConnectFailTimer.Dispose(); - // ConnectFailTimer = null; - // } - //} - #region Methods diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient_ForServer.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient_ForServer.cs index 1f108c1..143b3cc 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient_ForServer.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpClient_ForServer.cs @@ -223,13 +223,22 @@ namespace PepperDash.Core CTimer RetryTimer; + /// + /// + /// public bool HeartbeatEnabled { get; set; } + /// + /// + /// public ushort UHeartbeatEnabled { get { return (ushort)(HeartbeatEnabled ? 1 : 0); } set { HeartbeatEnabled = value == 1; } } + /// + /// + /// public string HeartbeatString { get; set; } //public int HeartbeatInterval = 50000; @@ -280,7 +289,13 @@ namespace PepperDash.Core #region Constructors - //Base class constructor + /// + /// Constructor + /// + /// + /// + /// + /// public GenericSecureTcpIpClient_ForServer(string key, string address, int port, int bufferSize) : base(key) { @@ -292,7 +307,9 @@ namespace PepperDash.Core } - //base class constructor + /// + /// Constructor for S+ + /// public GenericSecureTcpIpClient_ForServer() : base("Uninitialized Secure Tcp Client For Server") { @@ -304,7 +321,8 @@ namespace PepperDash.Core /// /// Contstructor that sets all properties by calling the initialize method with a config object. /// - /// + /// + /// public GenericSecureTcpIpClient_ForServer(string key, TcpClientConfigObject clientConfigObject) : base(key) { diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpServer.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpServer.cs index c28360c..d53a801 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpServer.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericSecureTcpIpServer.cs @@ -271,7 +271,9 @@ namespace PepperDash.Core List ClientReadyAfterKeyExchange = new List(); - //Store the connected client indexes + /// + /// The connected client indexes + /// public List ConnectedClientsIndexes = new List(); /// @@ -360,6 +362,10 @@ namespace PepperDash.Core Key = key; } + /// + /// Initialze the server + /// + /// public void Initialize(TcpServerConfigObject serverConfigObject) { try @@ -624,6 +630,11 @@ namespace PepperDash.Core return received; } + /// + /// Get the IP Address for the client at the specifed index + /// + /// + /// public string GetClientIPAddress(uint clientIndex) { Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "GetClientIPAddress Index: {0}", clientIndex); @@ -681,7 +692,7 @@ namespace PepperDash.Core /// /// Secure Server Socket Status Changed Callback /// - /// + /// /// /// void SecureServer_SocketStatusChange(SecureTCPServer server, uint clientIndex, SocketStatus serverSocketStatus) @@ -729,7 +740,7 @@ namespace PepperDash.Core /// /// Secure TCP Client Connected to Secure Server Callback /// - /// + /// /// void SecureConnectCallback(SecureTCPServer server, uint clientIndex) { diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs index 0befe71..16013a3 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient.cs @@ -128,10 +128,10 @@ namespace PepperDash.Core /// public string ClientStatusText { get { return ClientStatus.ToString(); } } - [Obsolete] /// /// Ushort representation of client status /// + [Obsolete] public ushort UClientStatus { get { return (ushort)ClientStatus; } } /// @@ -505,6 +505,9 @@ namespace PepperDash.Core /// public int AutoReconnectIntervalMs { get; set; } + /// + /// Default constructor + /// public TcpSshPropertiesConfig() { BufferSize = 32768; diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient_ForServer.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient_ForServer.cs index 0e6e046..1e31c6f 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient_ForServer.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpClient_ForServer.cs @@ -212,14 +212,30 @@ namespace PepperDash.Core CTimer RetryTimer; + /// + /// + /// public bool HeartbeatEnabled { get; set; } + + /// + /// + /// public ushort UHeartbeatEnabled { get { return (ushort)(HeartbeatEnabled ? 1 : 0); } set { HeartbeatEnabled = value == 1; } } + + /// + /// + /// public string HeartbeatString = "heartbeat"; + + /// + /// + /// public int HeartbeatInterval = 50000; + CTimer HeartbeatSendTimer; CTimer HeartbeatAckTimer; /// @@ -239,7 +255,13 @@ namespace PepperDash.Core #region Constructors - //Base class constructor + /// + /// Constructor + /// + /// + /// + /// + /// public GenericTcpIpClient_ForServer(string key, string address, int port, int bufferSize) : base(key) { @@ -251,7 +273,9 @@ namespace PepperDash.Core } - //base class constructor + /// + /// Constructor for S+ + /// public GenericTcpIpClient_ForServer() : base("Uninitialized DynamicTcpClient") { diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpServer.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpServer.cs index 832c474..e3a00f2 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpServer.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericTcpIpServer.cs @@ -152,7 +152,12 @@ namespace PepperDash.Core get { return (ushort)(IsListening ? 1 : 0); } } - public ushort MaxClients { get; set; } // should be set by parameter in SIMPL+ in the MAIN method, Should not ever need to be configurable + /// + /// The maximum number of clients. + /// Should be set by parameter in SIMPL+ in the MAIN method, Should not ever need to be configurable + /// + public ushort MaxClients { get; set; } + /// /// Number of clients currently connected. /// @@ -247,7 +252,9 @@ namespace PepperDash.Core List ClientReadyAfterKeyExchange = new List(); - //Store the connected client indexes + /// + /// The connected client indexes + /// public List ConnectedClientsIndexes = new List(); /// @@ -664,7 +671,7 @@ namespace PepperDash.Core /// /// Secure Server Socket Status Changed Callback /// - /// + /// /// /// void TcpServer_SocketStatusChange(TCPServer server, uint clientIndex, SocketStatus serverSocketStatus) @@ -702,7 +709,7 @@ namespace PepperDash.Core /// /// Secure TCP Client Connected to Secure Server Callback /// - /// + /// /// void TcpConnectCallback(TCPServer server, uint clientIndex) { @@ -777,7 +784,7 @@ namespace PepperDash.Core /// /// Secure Received Data Async Callback /// - /// + /// /// /// void TcpServerReceivedDataAsyncCallback(TCPServer myTCPServer, uint clientIndex, int numberOfBytesReceived) diff --git a/Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs b/Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs index aaa33a0..5bd85b0 100644 --- a/Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs +++ b/Pepperdash Core/Pepperdash Core/Comm/GenericUdpServer.cs @@ -74,10 +74,6 @@ namespace PepperDash.Core /// public string Hostname { get; set; } - /// - /// IP Address of the sender of the last recieved message - /// - /// /// Port on server @@ -103,6 +99,9 @@ namespace PepperDash.Core private set; } + /// + /// Numeric value indicating + /// public ushort UIsConnected { get { return IsConnected ? (ushort)1 : (ushort)0; } @@ -113,6 +112,9 @@ namespace PepperDash.Core /// public int BufferSize { get; set; } + /// + /// The server + /// public UDPServer Server { get; private set; } /// diff --git a/Pepperdash Core/Pepperdash Core/Config/PortalConfigReader.cs b/Pepperdash Core/Pepperdash Core/Config/PortalConfigReader.cs index 34203f2..f2ad746 100644 --- a/Pepperdash Core/Pepperdash Core/Config/PortalConfigReader.cs +++ b/Pepperdash Core/Pepperdash Core/Config/PortalConfigReader.cs @@ -173,8 +173,9 @@ namespace PepperDash.Core.Config /// /// Merge o2 onto o1 /// - /// - /// + /// + /// + /// static JObject Merge(JObject o1, JObject o2, string path) { foreach (var o2Prop in o2) diff --git a/Pepperdash Core/Pepperdash Core/GenericRESTfulCommunications/GenericRESTfulClient.cs b/Pepperdash Core/Pepperdash Core/GenericRESTfulCommunications/GenericRESTfulClient.cs index ca1b9a6..c1db1aa 100644 --- a/Pepperdash Core/Pepperdash Core/GenericRESTfulCommunications/GenericRESTfulClient.cs +++ b/Pepperdash Core/Pepperdash Core/GenericRESTfulCommunications/GenericRESTfulClient.cs @@ -65,6 +65,7 @@ namespace PepperDash.Core.GenericRESTfulCommunications /// /// /// + /// /// /// private void SubmitRequestHttp(string url, ushort port, ushort requestType, string contentType, string username, string password) @@ -122,6 +123,7 @@ namespace PepperDash.Core.GenericRESTfulCommunications /// /// /// + /// /// /// private void SubmitRequestHttps(string url, ushort port, ushort requestType, string contentType, string username, string password) diff --git a/Pepperdash Core/Pepperdash Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs b/Pepperdash Core/Pepperdash Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs index d42cc8e..114609e 100644 --- a/Pepperdash Core/Pepperdash Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs +++ b/Pepperdash Core/Pepperdash Core/JsonStandardObjects/JsonToSimplDeviceConfig.cs @@ -141,7 +141,6 @@ namespace PepperDash.Core.JsonStandardObjects /// /// public int autoReconnectIntervalMs { get; set; } - /// // convert properties for simpl /// @@ -250,6 +249,9 @@ namespace PepperDash.Core.JsonStandardObjects /// public class RootObject { + /// + /// The collection of devices + /// public List devices { get; set; } } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/JsonToSimpl/Constants.cs b/Pepperdash Core/Pepperdash Core/JsonToSimpl/Constants.cs index 3f31a72..e04bc93 100644 --- a/Pepperdash Core/Pepperdash Core/JsonToSimpl/Constants.cs +++ b/Pepperdash Core/Pepperdash Core/JsonToSimpl/Constants.cs @@ -97,6 +97,17 @@ namespace PepperDash.Core.JsonToSimpl /// public enum SPlusType { - Digital, Analog, String + /// + /// Digital + /// + Digital, + /// + /// Analog + /// + Analog, + /// + /// String + /// + String } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs b/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs index 8812f97..6535308 100644 --- a/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs +++ b/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplArrayLookupChild.cs @@ -79,6 +79,9 @@ namespace PepperDash.Core.JsonToSimpl PathSuffix == null ? "" : PathSuffix); } + /// + /// Process all values + /// public override void ProcessAll() { if (FindInArray()) diff --git a/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplChildObjectBase.cs b/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplChildObjectBase.cs index b025318..e507105 100644 --- a/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplChildObjectBase.cs +++ b/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplChildObjectBase.cs @@ -62,9 +62,17 @@ namespace PepperDash.Core.JsonToSimpl /// protected JsonToSimplMaster Master; - // The sent-in JPaths for the various types - protected Dictionary BoolPaths = new Dictionary(); + /// + /// Paths to boolean values in JSON structure + /// + protected Dictionary BoolPaths = new Dictionary(); + /// + /// Paths to numeric values in JSON structure + /// protected Dictionary UshortPaths = new Dictionary(); + /// + /// Paths to string values in JSON structure + /// protected Dictionary StringPaths = new Dictionary(); /// diff --git a/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplFileMaster.cs b/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplFileMaster.cs index 6361662..4f03e45 100644 --- a/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplFileMaster.cs +++ b/Pepperdash Core/Pepperdash Core/JsonToSimpl/JsonToSimplFileMaster.cs @@ -113,11 +113,20 @@ namespace PepperDash.Core.JsonToSimpl return; } } + + + /// + /// Sets the debug level + /// + /// public void setDebugLevel(int level) { Debug.SetDebugLevel(level); } + /// + /// Saves the values to the file + /// public override void Save() { // this code is duplicated in the other masters!!!!!!!!!!!!! diff --git a/Pepperdash Core/Pepperdash Core/Logging/Debug.cs b/Pepperdash Core/Pepperdash Core/Logging/Debug.cs index a0e7ed8..fdb3cb4 100644 --- a/Pepperdash Core/Pepperdash Core/Logging/Debug.cs +++ b/Pepperdash Core/Pepperdash Core/Logging/Debug.cs @@ -561,9 +561,27 @@ namespace PepperDash.Core Directory.Delete(@"\nvram\debugSettings"); } + /// + /// Error level to for message to be logged at + /// public enum ErrorLogLevel { - Error, Warning, Notice, None + /// + /// Error + /// + Error, + /// + /// Warning + /// + Warning, + /// + /// Notice + /// + Notice, + /// + /// None + /// + None, } } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/Logging/DebugContext.cs b/Pepperdash Core/Pepperdash Core/Logging/DebugContext.cs index 4cc8143..39c47c3 100644 --- a/Pepperdash Core/Pepperdash Core/Logging/DebugContext.cs +++ b/Pepperdash Core/Pepperdash Core/Logging/DebugContext.cs @@ -271,8 +271,14 @@ namespace PepperDash.Core } } + /// + /// + /// public class DebugContextSaveData { + /// + /// + /// public int Level { get; set; } } } \ No newline at end of file diff --git a/Pepperdash Core/Pepperdash Core/PasswordManagement/PasswordManager.cs b/Pepperdash Core/Pepperdash Core/PasswordManagement/PasswordManager.cs index a34fe0e..c9bc06b 100644 --- a/Pepperdash Core/Pepperdash Core/PasswordManagement/PasswordManager.cs +++ b/Pepperdash Core/Pepperdash Core/PasswordManagement/PasswordManager.cs @@ -196,7 +196,7 @@ namespace PepperDash.Core.PasswordManagement /// /// Protected ushort change event handler /// - /// + /// /// /// protected void OnUshrtChange(ushort value, ushort index, ushort type) diff --git a/Pepperdash Core/Pepperdash Core/SystemInfo/EventArgs and Constants.cs b/Pepperdash Core/Pepperdash Core/SystemInfo/EventArgs and Constants.cs index 367db3e..25f8099 100644 --- a/Pepperdash Core/Pepperdash Core/SystemInfo/EventArgs and Constants.cs +++ b/Pepperdash Core/Pepperdash Core/SystemInfo/EventArgs and Constants.cs @@ -143,7 +143,7 @@ namespace PepperDash.Core.SystemInfo /// /// Constructor overload /// - /// + /// /// public EthernetChangeEventArgs(EthernetInfo ethernet, ushort type) { @@ -154,8 +154,9 @@ namespace PepperDash.Core.SystemInfo /// /// Constructor overload /// - /// + /// /// + /// public EthernetChangeEventArgs(EthernetInfo ethernet, ushort type, ushort index) { Adapter = ethernet; @@ -239,7 +240,7 @@ namespace PepperDash.Core.SystemInfo /// /// Constructor overload /// - /// + /// /// public ProgramChangeEventArgs(ProgramInfo program, ushort type) { @@ -250,8 +251,9 @@ namespace PepperDash.Core.SystemInfo /// /// Constructor overload /// - /// + /// /// + /// public ProgramChangeEventArgs(ProgramInfo program, ushort type, ushort index) { Program = program; diff --git a/Pepperdash Core/Pepperdash Core/SystemInfo/SystemInfoToSimpl.cs b/Pepperdash Core/Pepperdash Core/SystemInfo/SystemInfoToSimpl.cs index 3946382..d4fe40a 100644 --- a/Pepperdash Core/Pepperdash Core/SystemInfo/SystemInfoToSimpl.cs +++ b/Pepperdash Core/Pepperdash Core/SystemInfo/SystemInfoToSimpl.cs @@ -327,10 +327,10 @@ namespace PepperDash.Core.SystemInfo /// /// private method to parse console messages /// - /// + /// /// - /// - /// + /// + /// /// private string ParseConsoleResponse(string data, string line, string dataStart, string dataEnd) { diff --git a/Pepperdash Core/Pepperdash Core/WebApi/Presets/Preset.cs b/Pepperdash Core/Pepperdash Core/WebApi/Presets/Preset.cs index 488929f..804156f 100644 --- a/Pepperdash Core/Pepperdash Core/WebApi/Presets/Preset.cs +++ b/Pepperdash Core/Pepperdash Core/WebApi/Presets/Preset.cs @@ -66,10 +66,13 @@ namespace PepperDash.Core.WebApi.Presets public bool LookupSuccess { get; private set; } /// - /// S+ helper for stupid S+ + /// S+ helper /// public ushort ULookupSuccess { get { return (ushort)(LookupSuccess ? 1 : 0); } } + /// + /// The preset + /// public Preset Preset { get; private set; } ///