Increment assembly version to 3.9.3125.3.

TBF/Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@ using System.Runtime.InteropServices;
 //      Build Number
 //      Revision
 //
-[assembly: AssemblyVersion("3.9.3124.3")]
-[assembly: AssemblyFileVersion("3.9.3124.3")]
+[assembly: AssemblyVersion("3.9.3125.3")]
+[assembly: AssemblyFileVersion("3.9.3125.3")]

packages/Common/Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.xml

@@ -198,6 +198,16 @@
             Acknowledge feedback from meter after communication
             </summary>
         </member>
+        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.RequestAcknowledgeState.CommandNotAssigned">
+            <summary>
+            Acknowledge code for unassigned command
+            </summary>
+        </member>
+        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.RequestAcknowledgeState.Unsent">
+            <summary>
+            Will be used initially as the record is not sent
+            </summary>
+        </member>
         <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.RequestAcknowledgeState.NoResponse">
             <summary>
             Response missing
@@ -224,6 +234,11 @@
             The response record couldn't be decoded
             </summary>
         </member>
+        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.RequestAcknowledgeState.WakeupMessage">
+            <summary>
+            The meter sent a wakeup message instead of the required data
+            </summary>
+        </member>
         <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.RequestAcknowledgeState.Ok">
             <summary>
             Valid meter response record
@@ -282,11 +297,6 @@
                 Holds request commands with detail parameters to see processing state
             </summary>
         </member>
-        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestRecord.Command">
-            <summary>
-                Indicates the base command <see cref="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.Commands" />
-            </summary>
-        </member>
         <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestRecord.ResponseCommand">
             <summary>
                 Indicates the base command <see cref="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.Consts.Commands" />
@@ -485,6 +495,15 @@
             <remarks date="2021-Feb-02" author="T.Wiedebusch">
             - Avoid enqueue of _recordInProcess if retry counter is 0.
             </remarks>
+            <remarks date="2022-Nov-04" author="T.Wiedebusch">
+            - Additional DEBUG information included about FIFO and loops.
+            </remarks>
+            <remarks date="2022-Nov-07" author="T.Wiedebusch">
+            - Command not assigned response for recordInProcess == null.
+            </remarks>
+            <remarks date="2024-Apr-22" author="T.Wiedebusch">
+            - Initial request acknowledge state changed from NotDecoded to NoResponse.
+            </remarks>
         </member>
         <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestProtocol.AddRecordToSendFifo(System.Byte,System.Byte[],Xylem.Common.Hardware.WaterMeter.Genesis.Registers.RegisterDefinition,System.Boolean,System.UInt16)">
             <summary>
@@ -518,6 +537,23 @@
             <remarks date="2020-Jan-18" author="T.Wiedebusch">
             - Initial skip retry error code set to 0x0004 (e.g FW not installed 0x0004).
             </remarks>
+            <remarks date="2023-Mai-16" author="T.Wiedebusch">
+            - Hide data in log forwarded to DecodeDateForPhysicalLayer to hide passwords in log files.
+            </remarks>
+        </member>
+        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestProtocol.AddRecordToSendFifoUI1236(System.String,System.Byte[],Xylem.Common.Hardware.WaterMeter.Genesis.Registers.RegisterDefinition,System.Boolean,System.UInt16)">
+            <summary>
+                Record dispatcher to send FIFO of UI1236 command
+            </summary>
+            <remarks date="2022-Aug-24" author="R.Drabesch">
+            - Initial
+            </remarks>
+            <param name="ident">string for logging of slot</param>
+            <param name="payload">Data package with all details like CRC, etc</param>
+            <param name="register"><see cref="T:Xylem.Common.Hardware.WaterMeter.Genesis.Registers.RegisterDefinition" /> which is intend</param>
+            <param name="hideDataInLog">hiding data in log file to avoid spying of passwords</param>
+            <param name="skipRetryErrorCode">error mask to skip retries</param>
+            <returns>the assembled record for the send FIFO</returns>
         </member>
         <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestProtocol.DecodeRecord(Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs)">
             <summary>
@@ -549,6 +585,30 @@
             <remarks date="2019-Jan-22" author="T.Wiedebusch">
             - Avoid activation of wakeup retry if record is meanwhile acknowledged.
             </remarks>
+            <remarks date="2022-Jul-19" author="T.Wiedebusch">
+            - Wakeup message handling changed,
+            - Multiple replies on wakeup message allowed.
+            </remarks>
+            <remarks date="2022-Oct-02" author="T.Wiedebusch">
+            - On wakeup message 5 retires are allowed to avoid an infinite loop.
+            </remarks>
+            <remarks date="2022-Oct-04" author="T.Wiedebusch">
+            - On wakeup message exit this routine.
+            </remarks>
+            <remarks date="2023-Feb-13" author="T.Wiedebusch">
+            - Early exit on _recordInProcess == null,
+            - Wakeup message retries from 5 to 2,
+            - Removed error base from error code decision as error base is only the AppId
+            </remarks>
+            <remarks date="2023-Sep-01" author="T.Wiedebusch">
+            - HideDataInLog.
+            </remarks>
+            <remarks date="2024-Jan-24" author="T.Wiedebusch">
+            - Ignore wakeup if message already acknowledged (avoid to set
+             "_recordInProcess.Acknowledge = RequestAcknowledgeState.NotDecoded"),
+            - Avoid to overwrite "_recordInProcess.Acknowledge = RequestAcknowledgeState.Acknowledge" with
+              "RequestAcknowledgeState.WakeupMessage".
+            </remarks>
         </member>
         <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestProtocol.CommandToMeter(System.Byte,Xylem.Common.Hardware.WaterMeter.Genesis.Registers.RegisterDefinition,System.Byte[],System.Nullable{System.Int32},System.Boolean,System.UInt16)">
             <summary>
@@ -595,6 +655,25 @@
             <remarks date="2019-Jan-18" author="T.Wiedebusch">
             - Default <see cref="F:Xylem.Common.Hardware.WaterMeter.Genesis.GenesisConfig.CommunicationConfig.SkipRetryErrorCode"/> set.
             </remarks>
+            <remarks date="2023-Sep-06" author="T.Wiedebusch">
+            - MultipleReadData based on data size.
+            </remarks>
+            <remarks date="2023-Nov-24" author="T.Wiedebusch">
+            - Exit multiple read date if retries exceeded.
+            </remarks>
+            <remarks date="2024-Apr-11" author="T.Wiedebusch">
+            - Exit multiple read date if retries exceeded increased to <see cref="F:Xylem.Common.Hardware.WaterMeter.Genesis.GenesisConfig.CommunicationConfig.MaxRequestRetries"/>.
+            </remarks>
+            <remarks date="2024-Apr-11 Version 2" author="T.Wiedebusch">
+            - Rewound to version from 06.09.2023 14:44:33 before Commit 8c9d7704.
+            </remarks>
+            <remarks date="2024-Apr-15" author="T.Wiedebusch">
+            - Removed useless too short comments as every string is going to be delimited by a 0 and usually won't match
+              to a 4 byte chunk.
+            </remarks>
+            <remarks date="2026-Jan-06" author="T.Wiedebusch">
+            - Removed redundant 'return cRecord'.
+            </remarks>
         </member>
         <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.RequestProtocol.RequestProtocol.CheckErrorCode">
             <summary>