Documentation

Author: jdomnitz

ZWaveDotNet/CommandClasses/Enums/ThermostatModeType.cs

@@ -10,29 +10,85 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+using System;
+using System.Text;
+
 namespace ZWaveDotNet.CommandClasses.Enums
 {
+    /// <summary>
+    /// Thermostat Mode
+    /// </summary>
     public enum ThermostatModeType
     {
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to switch off the thermostat.
+        /// </summary>
         OFF = 0x0,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to use activate heating when the temperature is below the Heating setpoint.
+        /// </summary>
         HEAT = 0x01,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to use activate cooling when the temperature is above the Cooling setpoint.
+        /// </summary>
         COOL = 0x02,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to regulate the temperature using heating and cooling
+        /// when the temperature is outside the range defined by the Heating and Cooling setpoints.
+        /// </summary>
         AUTO = 0x03,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to activate heating when the temperature is below the Heating setpoint, but using an auxiliary or emergency heat source.
+        /// </summary>
         AUXILIARY = 0x04,
         /// <summary>
-        /// This mode is used to resume the last activate mode (different than OFF 0x00).
+        /// <b>Version 1</b>: This mode is used to resume the last activate mode (different than OFF).
         /// </summary>
         RESUME = 0x05,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to activate fans only and circulate air.
+        /// </summary>
         FAN = 0x06,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to activate fans to circulate air and heating or cooling 
+        /// will be activated to regulate the temperature at the Furnace setpoint.
+        /// </summary>
         FURNACE = 0x07,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to dehumidify and remove moisture.
+        /// </summary>
         DRY = 0x08,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to humidify and add moisture.
+        /// </summary>
         MOIST = 0x09,
+        /// <summary>
+        /// <b>Version 1</b>: This mode is used to regulate the temperature at the Auto Changeover setpoint using heating and cooling.
+        /// </summary>
         AUTO_CHANGEOVER = 0x0A,
+        /// <summary>
+        /// <b>Version 2</b>: This mode is used to activate heating when the temperature is below the Energy Save Heating setpoint.
+        /// </summary>
         ENERGY_HEAT = 0x0B,
+        /// <summary>
+        /// <b>Version 2</b>: This mode is used to activate cooling when the temperature is below the Energy Save Cooling setpoint.
+        /// </summary>
         ENERGY_COOL = 0x0C,
+        /// <summary>
+        /// <b>Version 2</b>: This mode is used to regulate the temperature using heating and cooling when the temperature is outside the range defined by the Away Heating and Away Cooling setpoints.
+        /// </summary>
         AWAY_HEATING_OR_BOTH = 0x0D,
+        /// <summary>
+        /// <b>Version 3</b>: Away cooling setpoint
+        /// </summary>
         AWAY_COOLING = 0x0E,
+        /// <summary>
+        /// <b>Version 3</b>: This mode is used to regulate the temperature at the Full Power setpoint using heating and cooling.
+        /// </summary>
         FULL_POWER = 0x0F,
+        /// <summary>
+        /// <b>Version 3</b>: Reserved for vendor specific thermostat mode.
+        /// </summary>
         MANUFACTURER_SPECIFIC = 0x1F
     }
 }

ZWaveDotNet/CommandClasses/ThermostatMode.cs

@@ -20,6 +20,9 @@
 
 namespace ZWaveDotNet.CommandClasses
 {
+    /// <summary>
+    /// Control which mode a thermostat operates
+    /// </summary>
     [CCVersion(CommandClass.ThermostatMode, 3)]
     public class ThermostatMode : CommandClassBase
     {
@@ -39,12 +42,25 @@ enum ThermostatModeCommand
 
         internal ThermostatMode(Node node, byte endpoint) : base(node, endpoint, CommandClass.ThermostatMode) { }
 
+        /// <summary>
+        /// <b>Version 1</b>: Request the current mode set at the receiving node
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<ThermostatModeReport> Get(CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatModeCommand.Get, ThermostatModeCommand.Report, cancellationToken);
             return new ThermostatModeReport(response.Payload.Span);
         }
 
+        /// <summary>
+        /// <b>Version 1</b>: Set the thermostat mode at the receiving node
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="manufacturerData"><b>Version 3</b>: This field is used to provide a configuration for the MANUFACTURER SPECIFIC mode</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentException"></exception>
         public async Task Set(ThermostatModeType value, byte[]? manufacturerData = null, CancellationToken cancellationToken = default)
         {
             byte[] cmd = new byte[(manufacturerData?.Length ?? 0) + 1];
@@ -61,6 +77,11 @@ public async Task Set(ThermostatModeType value, byte[]? manufacturerData = null,
             await SendCommand(ThermostatModeCommand.Set, cancellationToken, cmd);
         }
 
+        /// <summary>
+        /// <b>Version 1</b>: Request the supported modes of a node
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<ThermostatModeType[]> GetSupportedModes(CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatModeCommand.SupportedGet, ThermostatModeCommand.SupportedReport, cancellationToken);

ZWaveDotNet/CommandClasses/ThermostatSetpoint.cs

@@ -11,6 +11,7 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 using System.Collections;
+using System.Xml.Linq;
 using ZWaveDotNet.CommandClasses.Enums;
 using ZWaveDotNet.CommandClassReports;
 using ZWaveDotNet.CommandClassReports.Enums;
@@ -21,6 +22,9 @@
 
 namespace ZWaveDotNet.CommandClasses
 {
+    /// <summary>
+    /// The Thermostat Setpoint Command Class is used to configure setpoints for the modes supported by a thermostat.
+    /// </summary>
     [CCVersion(CommandClass.ThermostatSetpoint, 3)]
     public class ThermostatSetpoint : CommandClassBase
     {
@@ -42,18 +46,39 @@ enum ThermostatSetpointCommand
 
         internal ThermostatSetpoint(Node node, byte endpoint) : base(node, endpoint, CommandClass.ThermostatSetpoint) { }
 
+        /// <summary>
+        /// <b>Version 1</b>: Request the target value for a given setpoint type that is currently configured at a supporting node.
+        /// </summary>
+        /// <param name="type"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<ThermostatSetpointReport> Get(ThermostatModeType type, CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatSetpointCommand.Get, ThermostatSetpointCommand.Report, cancellationToken, (byte)type);
             return new ThermostatSetpointReport(response.Payload.Span);
         }
 
+        /// <summary>
+        /// <b>Version 3</b>: Request the supported setpoint value range for an actual Setpoint Type
+        /// </summary>
+        /// <param name="type"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<ThermostatSetpointCapabilitiesReport> GetCapabilities(ThermostatModeType type, CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatSetpointCommand.CapabilitiesGet, ThermostatSetpointCommand.CapabilitiesReport, cancellationToken, (byte)type);
             return new ThermostatSetpointCapabilitiesReport(response.Payload.Span);
         }
 
+        /// <summary>
+        /// <b>Version 1</b>: Specify the target value for the specified Setpoint Type at a supporting node.
+        /// </summary>
+        /// <param name="type"></param>
+        /// <param name="value"></param>
+        /// <param name="unit"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentException"></exception>
         public async Task Set(ThermostatModeType type, float value, Units unit, CancellationToken cancellationToken = default)
         {
             ArraySegment<byte> cmd = new byte[6];
@@ -68,6 +93,11 @@ public async Task Set(ThermostatModeType type, float value, Units unit, Cancella
             await SendCommand(ThermostatSetpointCommand.Set, cancellationToken, cmd.Array!);
         }
 
+        /// <summary>
+        /// <b>Version 1</b>: Query the supported setpoint types.
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<ThermostatModeType[]> GetSupportedModes(CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatSetpointCommand.SupportedGet, ThermostatSetpointCommand.SupportedReport, cancellationToken);