pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-11 10:45:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add XML documentation to PepperDash.Core project

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:48:23 +00:00
parent eeb0e84dc7
commit 260677a37f
59 changed files with 1072 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

3
src/PepperDash.Core/JsonStandardObjects/JsonToSimplDevice.cs
View File

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

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

@@ -50,11 +50,17 @@ namespace PepperDash.Core.JsonStandardObjects
/// <summary>
/// Device communication parameter class
/// </summary>
/// <summary>
/// Represents a ComParamsConfig
/// </summary>
public class ComParamsConfig
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the baudRate
/// </summary>
public int baudRate { get; set; }
/// <summary>
///
@@ -89,10 +95,16 @@ namespace PepperDash.Core.JsonStandardObjects
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplBaudRate
/// </summary>
public ushort simplBaudRate { get { return Convert.ToUInt16(baudRate); } }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplDataBits
/// </summary>
public ushort simplDataBits { get { return Convert.ToUInt16(dataBits); } }
/// <summary>
///
@@ -146,10 +158,16 @@ namespace PepperDash.Core.JsonStandardObjects
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplPort
/// </summary>
public ushort simplPort { get { return Convert.ToUInt16(port); } }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplAutoReconnect
/// </summary>
public ushort simplAutoReconnect { get { return (ushort)(autoReconnect ? 1 : 0); } }
/// <summary>
///
@@ -195,6 +213,9 @@ namespace PepperDash.Core.JsonStandardObjects
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplControlPortNumber
/// </summary>
public ushort simplControlPortNumber { get { return Convert.ToUInt16(controlPortNumber); } }
/// <summary>
@@ -210,6 +231,9 @@ namespace PepperDash.Core.JsonStandardObjects
/// <summary>
/// Device properties class
/// </summary>
/// <summary>
/// Represents a PropertiesConfig
/// </summary>
public class PropertiesConfig
{
/// <summary>
@@ -229,10 +253,16 @@ namespace PepperDash.Core.JsonStandardObjects
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplDeviceId
/// </summary>
public ushort simplDeviceId { get { return Convert.ToUInt16(deviceId); } }
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the simplEnabled
/// </summary>
public ushort simplEnabled { get { return (ushort)(enabled ? 1 : 0); } }
/// <summary>