Add plc series types to support FP7 and EcoLogiX

- add new checksum calculation for Mewtocol 7

DocBuilder/Docs/reverse_engineering_data.md

@@ -3,7 +3,7 @@
 - What is the HW information byte for?
 - What are the last bytes of the EXRT message for?
 
-# Actual Readouts
+# Mewtocol Init
 
 | PLC TYPE     | CPU Code | Machine Code | HW Information|
 |--------------|--------------|--------------|---------------|
@@ -94,4 +94,44 @@ FP-XH 16k C14R
 | 81 | Op mode |
 | 00 | Link unit |
 | 60 | Error flag |
-| 0000 | Self diag error |
+| 0000 | Self diag error |
+
+# Mewtocol-7 Com
+
+## Getting the status of the plc
+
+`%EE#RT`
+
+Normal plc would return the default, see above.
+
+The FP7 series returns:
+
+`%EE$RT0000000100000000`
+
+> This indicates that the device uses the Mewtocol 7 format
+
+When trying to use EXRT the FP7 returns not supported
+
+[R] `%EE#EX00RT00`
+
+[S] `%EE!42`
+
+Then request the status from the PLC using Mewtocol 7
+
+[R] `>@EEE00#30STRD00`
+
+[O] `>@EEE00$30STRD`
+
+|Reponse Byte|Description|
+|-------------|-----------|
+| 00 | Read status (always 0) |
+| 07 | series code: 7 = FP7 |
+| 10 | model code: 3 = CPS41E, 4 = CPS31E, 5 = CPS31, 6 = CPS41ES, 7 = CPS31ES, 8 = CPS31S, 9 = CPS21, 10 = ElC500 |
+| 0000 | user special order code (Not important) |
+| 0453 | latest cpu version = 4.53 |
+| 0453 | communication cpu version = 4.53 |
+| 0453 | operation cpu version = 4.53 |
+| 01 | op mode = 4.53 |
+| 00 |  error flag |
+| 0000 | self diag error |
+| 00 | sd card information |

MewtocolNet/Helpers/CRCCalculator.cs

@@ -0,0 +1,88 @@
+using System;
+using System.Text;
+
+namespace MewtocolNet {
+    
+    internal static class CRCCalculator {
+
+        private static readonly ushort[] crcTable_CRC16_MCRF4XX = {
+           0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf,
+           0x8c48, 0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7,
+           0x1081, 0x0108, 0x3393, 0x221a, 0x56a5, 0x472c, 0x75b7, 0x643e,
+           0x9cc9, 0x8d40, 0xbfdb, 0xae52, 0xdaed, 0xcb64, 0xf9ff, 0xe876,
+           0x2102, 0x308b, 0x0210, 0x1399, 0x6726, 0x76af, 0x4434, 0x55bd,
+           0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e, 0xfae7, 0xc87c, 0xd9f5,
+           0x3183, 0x200a, 0x1291, 0x0318, 0x77a7, 0x662e, 0x54b5, 0x453c,
+           0xbdcb, 0xac42, 0x9ed9, 0x8f50, 0xfbef, 0xea66, 0xd8fd, 0xc974,
+           0x4204, 0x538d, 0x6116, 0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb,
+           0xce4c, 0xdfc5, 0xed5e, 0xfcd7, 0x8868, 0x99e1, 0xab7a, 0xbaf3,
+           0x5285, 0x430c, 0x7197, 0x601e, 0x14a1, 0x0528, 0x37b3, 0x263a,
+           0xdecd, 0xcf44, 0xfddf, 0xec56, 0x98e9, 0x8960, 0xbbfb, 0xaa72,
+           0x6306, 0x728f, 0x4014, 0x519d, 0x2522, 0x34ab, 0x0630, 0x17b9,
+           0xef4e, 0xfec7, 0xcc5c, 0xddd5, 0xa96a, 0xb8e3, 0x8a78, 0x9bf1,
+           0x7387, 0x620e, 0x5095, 0x411c, 0x35a3, 0x242a, 0x16b1, 0x0738,
+           0xffcf, 0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862, 0x9af9, 0x8b70,
+           0x8408, 0x9581, 0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e, 0xf0b7,
+           0x0840, 0x19c9, 0x2b52, 0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff,
+           0x9489, 0x8500, 0xb79b, 0xa612, 0xd2ad, 0xc324, 0xf1bf, 0xe036,
+           0x18c1, 0x0948, 0x3bd3, 0x2a5a, 0x5ee5, 0x4f6c, 0x7df7, 0x6c7e,
+           0xa50a, 0xb483, 0x8618, 0x9791, 0xe32e, 0xf2a7, 0xc03c, 0xd1b5,
+           0x2942, 0x38cb, 0x0a50, 0x1bd9, 0x6f66, 0x7eef, 0x4c74, 0x5dfd,
+           0xb58b, 0xa402, 0x9699, 0x8710, 0xf3af, 0xe226, 0xd0bd, 0xc134,
+           0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7, 0x6e6e, 0x5cf5, 0x4d7c,
+           0xc60c, 0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1, 0xa33a, 0xb2b3,
+           0x4a44, 0x5bcd, 0x6956, 0x78df, 0x0c60, 0x1de9, 0x2f72, 0x3efb,
+           0xd68d, 0xc704, 0xf59f, 0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232,
+           0x5ac5, 0x4b4c, 0x79d7, 0x685e, 0x1ce1, 0x0d68, 0x3ff3, 0x2e7a,
+           0xe70e, 0xf687, 0xc41c, 0xd595, 0xa12a, 0xb0a3, 0x8238, 0x93b1,
+           0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9,
+           0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
+           0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78,
+        };
+
+        internal static string BCC_Mew (this string msg) {
+
+            byte[] bytes = Encoding.ASCII.GetBytes(msg);
+            byte crc = CRC8(bytes);
+
+            return msg.Insert(msg.Length, crc.ToString("X2"));
+
+        }
+
+        internal static string BCC_Mew7 (this string msg) {
+
+            byte[] bytes = Encoding.ASCII.GetBytes(msg);
+            ushort crc = CRC16_MCRF4XX(bytes);
+
+            return msg.Insert(msg.Length, crc.ToString("X4"));
+
+        }
+
+        private static ushort CRC16_MCRF4XX (byte[] bytes) {
+
+            int icrc = 0xFFFF;
+            
+            for (int i = 0; i < bytes.Length; i++) {
+                icrc = (icrc >> 8) ^ crcTable_CRC16_MCRF4XX[(icrc ^ bytes[i]) & 0xff];
+            }
+
+            byte[] ret = BitConverter.GetBytes(icrc);
+
+            return BitConverter.ToUInt16(ret, 0);
+
+        }
+
+        private static byte CRC8 (byte[] bytes) {
+
+            byte xorTotalByte = 0;
+
+            for (int i = 0; i < bytes.Length; i++)
+                xorTotalByte ^= bytes[i];
+
+            return xorTotalByte;
+
+        }
+
+    }
+
+}

MewtocolNet/Helpers/MewtocolHelpers.cs

@@ -94,22 +94,6 @@ namespace MewtocolNet {
 
         }
 
-        /// <summary>
-        /// Builds the BCC / Checksum for the mewtocol command
-        /// </summary>
-        /// <param name="asciiArr">The mewtocol command (%01#RCS0001)</param>
-        /// <returns>The mewtocol command with the appended checksum</returns>
-        public static string BuildBCCFrame(this string asciiArr) {
-
-            Encoding ae = Encoding.ASCII;
-            byte[] b = ae.GetBytes(asciiArr);
-            byte xorTotalByte = 0;
-            for (int i = 0; i < b.Length; i++)
-                xorTotalByte ^= b[i];
-            return asciiArr.Insert(asciiArr.Length, xorTotalByte.ToString("X2"));
-
-        }
-
         /// <summary>
         /// Parses the byte string from a incoming RD message
         /// </summary>

MewtocolNet/MewtocolInterface.cs

@@ -39,6 +39,8 @@ namespace MewtocolNet {
         private protected Stopwatch speedStopwatchDownstr;
         private protected Task firstPollTask = new Task(() => { });
 
+        private protected MewtocolVersion mewtocolVersion;
+
         #endregion
 
         #region Internal fields 
@@ -115,6 +117,15 @@ namespace MewtocolNet {
             }
         }
 
+        /// <inheritdoc/>
+        public MewtocolVersion MewtocolVersion {
+            get => mewtocolVersion;
+            private protected set {
+                mewtocolVersion = value;
+                OnPropChange();
+            }
+        }
+
         /// <inheritdoc/>
         public string ConnectionInfo => GetConnectionInfo();
 
@@ -213,7 +224,7 @@ namespace MewtocolNet {
                 if (stream == null) return MewtocolFrameResponse.NotIntialized;
 
                 if (useBcc)
-                    frame = $"{frame.BuildBCCFrame()}";
+                    frame = $"{frame.BCC_Mew()}";
 
                 if (useCr)
                     frame = $"{frame}\r";

MewtocolNet/PublicEnums/MewtocolVersion.cs

@@ -0,0 +1,24 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace MewtocolNet {
+    
+    public enum MewtocolVersion {
+
+        /// <summary>
+        /// Unable to specify the version
+        /// </summary>
+        Unknown = 0,    
+        /// <summary>
+        /// Uses the standard mewtocol lib
+        /// </summary>
+        Mewtocol = 1,
+        /// <summary>
+        /// Uses the extended mewtocol7 lib
+        /// </summary>
+        Mewtocol7 = 2,
+
+    }
+
+}

MewtocolNet/PublicEnums/PlcSeriesType.cs

@@ -0,0 +1,43 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+namespace MewtocolNet {
+
+    public enum PlcSeriesType {
+
+        /// <summary>
+        /// FP7 CPS41E (Series code 7)
+        /// </summary>
+        FP7_CPS41E = 0x03,
+        /// <summary>
+        /// FP7 CPS31E (Series code 7)
+        /// </summary>
+        FP7_CPS31E = 0x04,
+        /// <summary>
+        /// FP7 CPS31 (Series code 7)
+        /// </summary>
+        FP7_CPS31 = 0x05,
+        /// <summary>
+        /// FP7 CPS41ES (Series code 7)
+        /// </summary>
+        FP7_CPS41ES = 0x06,
+        /// <summary>
+        /// FP7 CPS31ES (Series code 7)
+        /// </summary>
+        FP7_CPS31ES = 0x07,
+        /// <summary>
+        /// FP7 CPS31S (Series code 7)
+        /// </summary>
+        FP7_CPS31S = 0x08,
+        /// <summary>
+        /// FP7 CPS21 (Series code 7)
+        /// </summary>
+        FP7_CPS21 = 0x09,
+        /// <summary>
+        /// EcoLogiX (Series code 7)
+        /// </summary>
+        EcoLogiX_ELC500 = 0x10,
+
+    }
+
+}

MewtocolNet/PublicEnums/PlcType.cs

@@ -8,7 +8,7 @@ namespace MewtocolNet {
     //MISSING! FP7 and EcoLogix
 
     /// <summary>
-    /// The type of the PLC
+    /// The type of the PLC, only appliable for non Mewtocol7-Com PLCs
     /// </summary>
     public enum PlcType {
 

MewtocolTests/BCCBuilderChecks.cs

@@ -0,0 +1,40 @@
+using MewtocolNet;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace MewtocolTests;
+
+public class BCCBuilderChecks {
+
+    private readonly ITestOutputHelper output;
+
+    public BCCBuilderChecks (ITestOutputHelper output) {
+        this.output = output;
+    }
+
+    [Fact(DisplayName = "Test CRC Generation (CRC-8)")]
+    public void BuildBCCFrameGeneration() {
+
+        string test = "%01#RCSX0000";
+        string expect = "%01#RCSX00001D";
+
+        Assert.Equal(expect, test.BCC_Mew());
+
+    }
+
+    [Fact(DisplayName = "Test CRC Generation (CRC-16/MCRF4XX)")]
+    public void BuildBCC7FrameGeneration() {
+
+        string test = ">@EEE00$30STRD00070300000453045304530100000000660100";
+        string expect = ">@EEE00$30STRD00070300000453045304530100000000660100A7A5";
+
+        Assert.Equal(expect, test.BCC_Mew7());
+
+    }
+
+}

MewtocolTests/TestHelperExtensions.cs

@@ -66,16 +66,6 @@ namespace MewtocolTests {
 
         }
 
-        [Fact(DisplayName = nameof(MewtocolHelpers.BuildBCCFrame))]
-        public void BuildBCCFrameGeneration() {
-
-            string test = "%01#RCSX0000";
-            string expect = "%01#RCSX00001D";
-
-            Assert.Equal(expect, test.BuildBCCFrame());
-
-        }
-
         [Fact(DisplayName = nameof(MewtocolHelpers.ParseDTByteString))]
         public void ParseDTByteStringGeneration() {
 
@@ -87,7 +77,7 @@ namespace MewtocolTests {
 
             foreach (var item in testList) {
 
-                Assert.Equal(item, $"%01$RD{item}".BuildBCCFrame().ParseDTByteString());
+                Assert.Equal(item, $"%01$RD{item}".BCC_Mew().ParseDTByteString());
 
             }
 
@@ -96,8 +86,8 @@ namespace MewtocolTests {
         [Fact(DisplayName = nameof(MewtocolHelpers.ParseRCSingleBit))]
         public void ParseRCSingleBitGeneration() {
 
-            Assert.True($"%01$RC1".BuildBCCFrame().ParseRCSingleBit());
+            Assert.True($"%01$RC1".BCC_Mew().ParseRCSingleBit());
-            Assert.False($"%01$RC0".BuildBCCFrame().ParseRCSingleBit());
+            Assert.False($"%01$RC0".BCC_Mew().ParseRCSingleBit());
 
         }