Documentation and minor refactoring

Author: jdomnitz

ZWaveDotNet/CommandClassReports/Enums/NotificationState.cs

@@ -28,6 +28,9 @@ namespace ZWaveDotNet.CommandClasses
     [CCVersion(CommandClass.BarrierOperator, 1)]
     public class BarrierOperator : CommandClassBase
     {
+        /// <summary>
+        /// Unsolicited Barrer Report
+        /// </summary>
         public event CommandClassEvent<BarrierReport>? BarrierState;
 
         enum BarrierOperatorCommand : byte

ZWaveDotNet/CommandClasses/BarrierOperator.cs

@@ -38,8 +38,7 @@ public async Task Send(ushort Manufacturer, Memory<byte> data, CancellationToken
             payload[0] = manufacturerBytes[1];
             data.CopyTo(payload.AsMemory().Slice(1));
 
-            CommandMessage msg = new CommandMessage(controller, node.ID, EndPoint, CommandClass, manufacturerBytes[0], false, payload);
-            await SendCommand(msg, cancellationToken);
+            await SendCommand(manufacturerBytes[0], cancellationToken, false, payload);
         }
 
         ///

ZWaveDotNet/CommandClasses/ManufacturerProprietary.cs

@@ -101,7 +101,7 @@ public async Task<ColorType[]> GetSupported(CancellationToken cancellationToken
         /// </summary>
         /// <param name="up"></param>
         /// <param name="component"></param>
-        /// <param name="startLevel">If < 0, start level is ignored</param>
+        /// <param name="startLevel">If &lt; 0, start level is ignored</param>
         /// <param name="duration"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>

ZWaveDotNet/CommandClasses/SwitchColor.cs

@@ -31,7 +31,7 @@ public class EndPoint
         /// </summary>
         public byte ID { get; init; }
         private readonly Node node;
-        private Dictionary<CommandClass, CommandClassBase> commandClasses = new Dictionary<CommandClass, CommandClassBase>();
+        private readonly Dictionary<CommandClass, CommandClassBase> commandClasses = new Dictionary<CommandClass, CommandClassBase>();
 
         /// <summary>
         /// The parent Node

ZWaveDotNet/Entities/EndPoint.cs

@@ -54,7 +54,10 @@ private enum InterviewState { None, Started, Complete };
         private bool failed;
         private InterviewState interviewed;
 
-        private ConcurrentDictionary<CommandClass, CommandClassBase> commandClasses = new ConcurrentDictionary<CommandClass, CommandClassBase>();
+        /// <summary>
+        /// Command Class Instances
+        /// </summary>
+        protected ConcurrentDictionary<CommandClass, CommandClassBase> commandClasses = new ConcurrentDictionary<CommandClass, CommandClassBase>();
         private List<EndPoint> endPoints = new List<EndPoint>();
 
         /// <summary>
@@ -130,7 +133,14 @@ internal Node(NodeJSON nodeJSON, Controller controller)
             nodeInfo = nodeJSON.NodeProtocolInfo;
         }
 
-        private bool AddCommandClass(CommandClass cls, bool secure = false, byte version = 1)
+        /// <summary>
+        /// Create a command class of the given type
+        /// </summary>
+        /// <param name="cls"></param>
+        /// <param name="secure"></param>
+        /// <param name="version"></param>
+        /// <returns></returns>
+        protected bool AddCommandClass(CommandClass cls, bool secure = false, byte version = 1)
         {
             return commandClasses.TryAdd(cls, CommandClassBase.Create(cls, this, 0, secure, version));
         }
@@ -197,7 +207,8 @@ internal void HandleApplicationUpdate(ApplicationUpdate update)
         internal async Task HandleApplicationCommand(ApplicationCommand cmd)
         {
             ReportMessage? msg = new ReportMessage(cmd);
-            RSSI = msg.RSSI;
+            if (msg.RSSI != ApplicationCommand.INVALID_RSSI)
+                RSSI = msg.RSSI;
 
             //Encapsulation Order (inner to outer) - MultiCommand, Supervision, Multichannel, security, transport, crc16
             if (CRC16.IsEncapsulated(msg))

ZWaveDotNet/Entities/Node.cs

@@ -325,7 +325,7 @@ public byte[] CreateS0Nonce(ushort nodeId)
             byte[] nonce = new byte[8];
             do
             {
-                new Random().NextBytes(nonce);
+                Random.Shared.NextBytes(nonce);
             } while (GetS0Nonce(nodeId, nonce[0]) != null);
             SpanRecord nr = new SpanRecord()
             {

ZWaveDotNet/Security/SecurityManager.cs

@@ -51,12 +51,6 @@ public async Task SendAcknowledged(Function function, CancellationToken cancella
             await SendAcknowledged(frame, cancellationToken).ConfigureAwait(false);
         }
 
-        public async Task SendAcknowledged(Message message, CancellationToken cancellationToken = default)
-        {
-            Frame frame = new Frame(FrameType.SOF, DataFrameType.Request, message.Function, message.GetPayload());
-            await SendAcknowledged(frame, cancellationToken).ConfigureAwait(false);
-        }
-
         public async Task SendAcknowledged(Frame frame, CancellationToken cancellationToken = default)
         {
             var reader = port.CreateReader();
@@ -75,13 +69,6 @@ public async Task<Message> SendAcknowledgedResponse(Function function, Cancellat
             return GetMessage(response);
         }
 
-        public async Task<Message> SendAcknowledgedResponse(Message message, CancellationToken cancellationToken = default)
-        {
-            Frame frame = new Frame(FrameType.SOF, DataFrameType.Request, message.Function, message.GetPayload());
-            Frame response = await SendAcknowledgedResponse(frame, cancellationToken).ConfigureAwait(false);
-            return GetMessage(response)!;
-        }
-
         public async Task<Frame> SendAcknowledgedResponse(Frame frame, CancellationToken cancellationToken = default)
         {
             var reader = port.CreateReader();

ZWaveDotNet/SerialAPI/Flow.cs

@@ -16,7 +16,7 @@
 
 namespace ZWaveDotNet.SerialAPI.Messages
 {
-    public class ApplicationCommand : Message
+    internal class ApplicationCommand : Message
     {
         public const sbyte INVALID_RSSI = 0x7D;
         public const ushort LOCAL_NODE = 0xFF;

ZWaveDotNet/SerialAPI/Messages/ApplicationCommand.cs

@@ -15,9 +15,19 @@
 
 namespace ZWaveDotNet.SerialAPI.Messages
 {
+    /// <summary>
+    /// Base class for all ZWave Messages
+    /// </summary>
     public abstract class Message
     {
+        /// <summary>
+        /// Serial API Function
+        /// </summary>
         public readonly Function Function;
+        /// <summary>
+        /// Base class for all ZWave Messages
+        /// </summary>
+        /// <param name="function"></param>
         protected Message(Function function)
         {
             this.Function = function;
@@ -28,6 +38,7 @@ internal virtual PayloadWriter GetPayload()
             return new PayloadWriter(256);
         }
 
+        /// <inheritdoc />
         public override string ToString()
         {
             return "[msg] ";