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

docs: XML comments for Devices.Common

Browse Source
This commit is contained in:
Andrew Welker
2025-10-09 13:18:36 -05:00
parent a5d409e93a
commit f9d9df9d5c
115 changed files with 5772 additions and 4292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/PepperDash.Essentials.Devices.Common/Shades/RelayControlledShade.cs
View File

@@ -27,6 +27,12 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// </summary>
public string StopOrPresetButtonLabel { get; set; }
/// <summary>
/// Initializes a new instance of the RelayControlledShade class
/// </summary>
/// <param name="key">The device key</param>
/// <param name="name">The device name</param>
/// <param name="config">The relay controlled shade configuration</param>
public RelayControlledShade(string key, string name, RelayControlledShadeConfigProperties config)
: base(key, name)
{
@@ -157,6 +163,9 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// </summary>
public class RelayControlledShadeFactory : EssentialsDeviceFactory<RelayControlledShade>
{
/// <summary>
/// Initializes a new instance of the RelayControlledShadeFactory class
/// </summary>
public RelayControlledShadeFactory()
{
TypeNames = new List<string>() { "relaycontrolledshade" };

21
src/PepperDash.Essentials.Devices.Common/Shades/ShadeBase.cs
View File

@@ -1,10 +1,18 @@
using PepperDash.Essentials.Core.Shades;
using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core;
using PepperDash.Essentials.Core.Shades;
namespace PepperDash.Essentials.Devices.Common.Shades
{
/// <summary>
/// Base class for shade devices
/// </summary>
public abstract class ShadeBase : EssentialsDevice, IShadesOpenCloseStop
{
/// <summary>
/// Initializes a new instance of the ShadeBase class
/// </summary>
/// <param name="key">The device key</param>
/// <param name="name">The device name</param>
public ShadeBase(string key, string name)
: base(key, name)
{
@@ -13,8 +21,17 @@ namespace PepperDash.Essentials.Devices.Common.Shades
#region iShadesOpenClose Members
/// <summary>
/// Opens the shade
/// </summary>
public abstract void Open();
/// <summary>
/// Stops the shade
/// </summary>
public abstract void Stop();
/// <summary>
/// Closes the shade
/// </summary>
public abstract void Close();
#endregion

12
src/PepperDash.Essentials.Devices.Common/Shades/ShadeController.cs
View File

@@ -14,8 +14,17 @@ namespace PepperDash.Essentials.Devices.Common.Shades
{
ShadeControllerConfigProperties Config;
/// <summary>
/// Gets the collection of shades controlled by this controller
/// </summary>
public List<IShadesOpenCloseStop> Shades { get; private set; }
/// <summary>
/// Initializes a new instance of the ShadeController class
/// </summary>
/// <param name="key">The device key</param>
/// <param name="name">The device name</param>
/// <param name="config">The shade controller configuration</param>
public ShadeController(string key, string name, ShadeControllerConfigProperties config)
: base(key, name)
{
@@ -76,6 +85,9 @@ namespace PepperDash.Essentials.Devices.Common.Shades
/// </summary>
public class ShadeControllerFactory : EssentialsDeviceFactory<ShadeController>
{
/// <summary>
/// Initializes a new instance of the ShadeControllerFactory class
/// </summary>
public ShadeControllerFactory()
{
TypeNames = new List<string>() { "shadecontroller" };