mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-02-11 18:54:52 +00:00
docs: update XML comments for Essentials Core
This commit is contained in:
@@ -21,11 +21,22 @@ namespace PepperDash.Essentials.Core.CrestronIO
|
||||
[Description("Wrapper class for a Relay")]
|
||||
public class GenericRelayDevice : EssentialsBridgeableDevice, ISwitchedOutput
|
||||
{
|
||||
/// <summary>
|
||||
/// The RelayOutput controlled by this device
|
||||
/// </summary>
|
||||
public Relay RelayOutput { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Feedback to indicate whether the output is on
|
||||
/// </summary>
|
||||
public BoolFeedback OutputIsOnFeedback { get; private set; }
|
||||
|
||||
//Maintained for compatibility with PepperDash.Essentials.Core.Devices.CrestronProcessor
|
||||
/// <summary>
|
||||
/// Constructor for GenericRelayDevice
|
||||
/// </summary>
|
||||
/// <param name="key">key of the device</param>
|
||||
/// <param name="relay">Relay output controlled by this device</param>
|
||||
public GenericRelayDevice(string key, Relay relay) :
|
||||
base(key)
|
||||
{
|
||||
@@ -37,6 +48,13 @@ namespace PepperDash.Essentials.Core.CrestronIO
|
||||
RelayOutput.StateChange += RelayOutput_StateChange;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constructor for GenericRelayDevice
|
||||
/// </summary>
|
||||
/// <param name="key">key of the device</param>
|
||||
/// <param name="name">name of the device</param>
|
||||
/// <param name="postActivationFunc">function to get the relay output</param>
|
||||
/// <param name="config">IO port configuration</param>
|
||||
public GenericRelayDevice(string key, string name, Func<IOPortConfig, Relay> postActivationFunc,
|
||||
IOPortConfig config)
|
||||
: base(key, name)
|
||||
@@ -212,6 +230,9 @@ namespace PepperDash.Essentials.Core.CrestronIO
|
||||
/// </summary>
|
||||
public class GenericRelayDeviceFactory : EssentialsDeviceFactory<GenericRelayDevice>
|
||||
{
|
||||
/// <summary>
|
||||
/// Constructor for GenericRelayDeviceFactory
|
||||
/// </summary>
|
||||
public GenericRelayDeviceFactory()
|
||||
{
|
||||
TypeNames = new List<string>() { "relayoutput" };
|
||||
|
||||
Reference in New Issue
Block a user