pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-10 18:24:50 +00:00
Code Issues Packages Projects Releases 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

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

@@ -17,10 +17,19 @@ using Serilog.Events;
namespace PepperDash.Essentials.Core.CrestronIO
{
[Description("Wrapper class for Digital Input")]
/// <summary>
/// Represents a GenericDigitalInputDevice
/// </summary>
public class GenericDigitalInputDevice : EssentialsBridgeableDevice, IDigitalInput
{
/// <summary>
/// Gets or sets the InputPort
/// </summary>
public DigitalInput InputPort { get; private set; }
/// <summary>
/// Gets or sets the InputStateFeedback
/// </summary>
public BoolFeedback InputStateFeedback { get; private set; }
Func<bool> InputStateFeedbackFunc
@@ -103,6 +112,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{
var joinMap = new IDigitalInputJoinMap(joinStart);
@@ -139,6 +152,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Factory
/// <summary>
/// Represents a GenericDigitalInputDeviceFactory
/// </summary>
public class GenericDigitalInputDeviceFactory : EssentialsDeviceFactory<GenericDigitalInputDevice>
{
public GenericDigitalInputDeviceFactory()
@@ -146,6 +162,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "digitalinput" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
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
/// <summary>
/// OpenRelay method
/// </summary>
public void OpenRelay()
{
RelayOutput.State = false;
}
/// <summary>
/// CloseRelay method
/// </summary>
public void CloseRelay()
{
RelayOutput.State = true;
}
/// <summary>
/// ToggleRelayState method
/// </summary>
public void ToggleRelayState()
{
if (RelayOutput.State == true)
@@ -151,6 +160,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{
var joinMap = new GenericRelayControllerJoinMap(joinStart);
@@ -194,6 +207,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Factory
/// <summary>
/// Represents a GenericRelayDeviceFactory
/// </summary>
public class GenericRelayDeviceFactory : EssentialsDeviceFactory<GenericRelayDevice>
{
public GenericRelayDeviceFactory()
@@ -201,6 +217,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "relayoutput" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
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
/// </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>
/// <summary>
/// SetMinimumChange method
/// </summary>
public void SetMinimumChange(ushort value)
{
InputPort.AnalogMinChange = value;
@@ -88,6 +91,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{
var joinMap = new IAnalogInputJoinMap(joinStart);
@@ -139,6 +146,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#endregion
/// <summary>
/// GetVersiportDigitalInput method
/// </summary>
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 GenericVersiportAbalogInputDeviceFactory()
@@ -195,6 +208,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "versiportanaloginput" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Versiport Device");

17
src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportInputDevice.cs
View File

@@ -35,6 +35,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
}
}
/// <summary>
/// Gets or sets the PartitionPresentFeedback
/// </summary>
public BoolFeedback PartitionPresentFeedback { get; }
public bool PartitionPresent => !InputStateFeedbackFunc();
@@ -80,6 +83,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{
var joinMap = new IDigitalInputJoinMap(joinStart);
@@ -115,6 +122,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#endregion
/// <summary>
/// GetVersiportDigitalInput method
/// </summary>
public static Versiport GetVersiportDigitalInput(IOPortConfig dc)
{
@@ -157,6 +167,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
}
/// <summary>
/// Represents a GenericVersiportDigitalInputDeviceFactory
/// </summary>
public class GenericVersiportDigitalInputDeviceFactory : EssentialsDeviceFactory<GenericVersiportDigitalInputDevice>
{
public GenericVersiportDigitalInputDeviceFactory()
@@ -164,6 +177,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "versiportinput" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Versiport Device");

17
src/PepperDash.Essentials.Core/CrestronIO/GenericVersiportOutputDevice.cs
View File

@@ -74,6 +74,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
/// Set value of the versiport digital output
/// </summary>
/// <param name="state">value to set the output to</param>
/// <summary>
/// SetOutput method
/// </summary>
public void SetOutput(bool state)
{
if (OutputPort.SupportsDigitalOutput)
@@ -92,6 +95,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
#region Bridge Linking
/// <summary>
/// LinkToApi method
/// </summary>
/// <inheritdoc />
public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge)
{
var joinMap = new IDigitalOutputJoinMap(joinStart);
@@ -128,6 +135,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
#endregion
/// <summary>
/// GetVersiportDigitalOutput method
/// </summary>
public static Versiport GetVersiportDigitalOutput(IOPortConfig dc)
{
@@ -169,6 +179,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
}
/// <summary>
/// Represents a GenericVersiportDigitalOutputDeviceFactory
/// </summary>
public class GenericVersiportDigitalOutputDeviceFactory : EssentialsDeviceFactory<GenericVersiportDigitalInputDevice>
{
public GenericVersiportDigitalOutputDeviceFactory()
@@ -176,6 +189,10 @@ namespace PepperDash.Essentials.Core.CrestronIO
TypeNames = new List<string>() { "versiportoutput" };
}
/// <summary>
/// BuildDevice method
/// </summary>
/// <inheritdoc />
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Generic Versiport Device");

3
src/PepperDash.Essentials.Core/CrestronIO/IAnalogInput.cs
View File

@@ -7,6 +7,9 @@ using PepperDash.Essentials.Core;
namespace PepperDash.Essentials.Core.CrestronIO
{
/// <summary>
/// Defines the contract for IAnalogInput
/// </summary>
public interface IAnalogInput
{
IntFeedback InputValueFeedback { get; }

3
src/PepperDash.Essentials.Core/CrestronIO/IHasCresnetBranches.cs
View File

@@ -8,6 +8,9 @@ using Crestron.SimplSharpPro.DeviceSupport;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Defines the contract for IHasCresnetBranches
/// </summary>
public interface IHasCresnetBranches
{
CrestronCollection<CresnetBranch> CresnetBranches { get; }

15
src/PepperDash.Essentials.Core/CrestronIO/IOPortConfig.cs
View File

@@ -9,15 +9,30 @@ using Newtonsoft.Json;
namespace PepperDash.Essentials.Core.CrestronIO
{
/// <summary>
/// Represents a IOPortConfig
/// </summary>
public class IOPortConfig
{
[JsonProperty("portDeviceKey")]
/// <summary>
/// Gets or sets the PortDeviceKey
/// </summary>
public string PortDeviceKey { get; set; }
[JsonProperty("portNumber")]
/// <summary>
/// Gets or sets the PortNumber
/// </summary>
public uint PortNumber { get; set; }
[JsonProperty("disablePullUpResistor")]
/// <summary>
/// Gets or sets the DisablePullUpResistor
/// </summary>
public bool DisablePullUpResistor { get; set; }
[JsonProperty("minimumChange")]
/// <summary>
/// Gets or sets the MinimumChange
/// </summary>
public int MinimumChange { get; set; }
}
}