Documentation

Author: jdomnitz

README.md

@@ -16,11 +16,11 @@ An implementation of ZWave Plus using the 2024a public specification.
 #### Getting Started:
 * See our [Examples Page](Examples.md)
 
-#### Work in progress:
+#### Not Supported:
 * Multicast is not fully implemented (including secure multicast)
 
 #### Other Projects
-* Check out my other projects for [HomeKit](https://github.com/SmartHomeOS/HomeKitDotNet)
+* Check out my other projects for [HomeKit](https://github.com/SmartHomeOS/HomeKitDotNet) and [Matter](https://github.com/SmartHomeOS/MatterDotNet).
 
 Support is always appreciated:<br/><a href="https://www.buymeacoffee.com/jdomnitz" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Pizza" style="height: 60px !important;width: 217px !important;" ></a>
 

ZWaveDotNet/CommandClasses/Enums/FanMode.cs

@@ -12,19 +12,59 @@
 
 namespace ZWaveDotNet.CommandClasses.Enums
 {
+    /// <summary>
+    /// Current mode of an HVAC fan
+    /// </summary>
     public enum FanMode
     {
+        /// <summary>
+        /// <b>Version 1</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “auto low” algorithms.
+        /// </summary>
         AUTO_LOW = 0x0,
+        /// <summary>
+        /// <b>Version 1</b>: Will turn the manual fan operation on. Low speed is selected.
+        /// </summary>
         LOW = 0x1,
+        /// <summary>
+        /// <b>Version 1</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “auto high” algorithms.
+        /// </summary>
         AUTO_HIGH = 0x2,
+        /// <summary>
+        /// <b>Version 1</b>: Will turn the manual fan operation on. High speed is selected.
+        /// </summary>
         HIGH = 0x3,
+        /// <summary>
+        /// <b>Version 2</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “auto medium” algorithms.
+        /// </summary>
         AUTO_MEDIUM = 0x4,
+        /// <summary>
+        /// <b>Version 2</b>: Will turn the manual fan operation on. Medium speed is selected.
+        /// </summary>
         MEDIUM = 0x5,
+        /// <summary>
+        /// <b>Version 3</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific circumlation algorithms.
+        /// </summary>
         CIRCULATION = 0x6,
+        /// <summary>
+        /// <b>Version 3</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “humidity circulation” algorithms.
+        /// </summary>
         HUMIDITY_CIRCULATION = 0x7,
+        /// <summary>
+        /// <b>Version 4</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “left &amp; right” circulation algorithms.
+        /// </summary>
         LEFT_RIGHT = 0x8,
+        /// <summary>
+        /// <b>Version 4</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “up &amp; down” circulation algorithms.
+        /// </summary>
         UP_DOWN = 0x9,
+        /// <summary>
+        /// <b>Version 4</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific “quiet” algorithms.
+        /// </summary>
         QUIET = 0xA,
+        /// <summary>
+        /// <b>Version 5</b>: Will turn the manual fan operation off unless turned on by the manufacturer specific circulation algorithms.
+        /// This mode will circulate fresh air from the outside.
+        /// </summary>
         EXTERNAL_CIRCULATION = 0xB
     }
 }

ZWaveDotNet/CommandClasses/Proprietary.cs

@@ -15,9 +15,14 @@
 using ZWaveDotNet.Entities;
 using ZWaveDotNet.Enums;
 using ZWaveDotNet.SerialAPI;
+using static System.Runtime.InteropServices.JavaScript.JSType;
 
 namespace ZWaveDotNet.CommandClasses
 {
+    /// <summary>
+    /// The Proprietary Command Class is used to transfer data between devices. 
+    /// The data content MUST be vendor specific and commands MUST NOT provide any value-add with respect to the Home Automation application in general.
+    /// </summary>
     [CCVersion(CommandClass.Proprietary)]
     public class Proprietary : CommandClassBase
     {
@@ -35,6 +40,12 @@ enum ProprietaryCommand : byte
 
         internal Proprietary(Node node, byte endpoint) : base(node, endpoint, CommandClass.Proprietary) { }
 
+        /// <summary>
+        /// This command is used to request data from a device.
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        /// <exception cref="MethodAccessException"></exception>
         public async Task<ProprietaryReport> Get(CancellationToken cancellationToken = default)
         {
             if (node.ID == Node.BROADCAST_ID)
@@ -43,6 +54,12 @@ public async Task<ProprietaryReport> Get(CancellationToken cancellationToken = d
             return new ProprietaryReport(response.Payload);
         }
 
+        /// <summary>
+        /// This command is used to transfer data to a device.
+        /// </summary>
+        /// <param name="payload"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task Set(byte[] payload, CancellationToken cancellationToken = default)
         {
             await SendCommand(ProprietaryCommand.Set, cancellationToken, payload);

ZWaveDotNet/CommandClasses/ThermostatFanMode.cs

@@ -20,6 +20,10 @@
 
 namespace ZWaveDotNet.CommandClasses
 {
+    /// <summary>
+    /// The Thermostat Fan Mode Command Class is an extension to support control and status monitoring functions of air-conditioning devices 
+    /// in order to achieve a global framework that covers the majority of generic functions implemented by world-wide air-conditioning manufacturer.
+    /// </summary>
     [CCVersion(CommandClass.ThermostatFanMode, 5)]
     public class ThermostatFanMode : CommandClassBase
     {
@@ -39,12 +43,24 @@ enum ThermostatFanModeCommand
 
         internal ThermostatFanMode(Node node, byte endpoint) : base(node, endpoint, CommandClass.ThermostatFanMode) { }
 
+        /// <summary>
+        /// <b>Version 1</b>: This command is used to request the fan mode in the device.
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<ThermostatFanModeReport> Get(CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatFanModeCommand.Get, ThermostatFanModeCommand.Report, cancellationToken);
             return new ThermostatFanModeReport(response.Payload.Span);
         }
 
+        /// <summary>
+        /// <b>Version 1</b>: This command is used to set the fan mode in the device.
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="off"><b>Version 2</b>: Switch the fan off in any mode</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task Set(FanMode value, bool off, CancellationToken cancellationToken = default)
         {
             byte cmd = (byte)value;
@@ -53,6 +69,11 @@ public async Task Set(FanMode value, bool off, CancellationToken cancellationTok
             await SendCommand(ThermostatFanModeCommand.Set, cancellationToken, cmd);
         }
 
+        /// <summary>
+        /// <b>Version 1</b>: This command is used to request the supported fan modes from the device.
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
         public async Task<FanMode[]> GetSupportedModes(CancellationToken cancellationToken = default)
         {
             ReportMessage response = await SendReceive(ThermostatFanModeCommand.SupportedGet, ThermostatFanModeCommand.SupportedReport, cancellationToken);