Update README.md

README.md

@@ -1,39 +1,137 @@
 # MewtocolNet
 A Mewtocol protocol library to interface with Panasonic PLCs over TCP/Serial.
 
+# Support
+
+> This library was only tested with a few PLCs, other types that support the Panasonic Mewtocol protocol might work. 
+> Use at your own risk, others might follow with community feedback
+
+|PLC Type|Supported|Tested|
+|--------|---------|------|
+FPX C14  |✔        |✔   |
+FPX C30  |✔        |✔   |
+FPX-H C14|✔        |✔   |
+FPX-H C30|✔        |✔   |
+FP Sigma |✔        |❌  |
+
+Where is the RS232/Serial support
+
+> Support for the serial protocol will be added soon, feel free to contribute
+
+
 # Usage
 
-1. Connecting to a PLC 
+## Connecting to a PLC 
+
+Connecting to a PLC is as simple as 
 
 ```C#
-//Create a new interface class with your PLCs IP address and port
+ //attaching a logger
-MewtocolInterface interf = new MewtocolInterface("127.0.0.1", 9094);
+Logger.LogLevel = LogLevel.Verbose;
+Logger.OnNewLogMessage((date, msg) => {
+    Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
+});
 
-//Setup the dataregisters of the PLC you want to read
+//setting up a new PLC interface
-interf.AddRegister<short>("Test Integer",1204);
+MewtocolInterface interf = new MewtocolInterface("10.237.191.3");
-interf.AddRegister<string>(1101, 4);
 
-//attaches an auto reader that polls the registers
+await interf.ConnectAsync();
-interf.WithPoller();
+```
 
-//triggers when a dataregister changes its value
+You can also use the callbacks of the `ConnectAsync()` method to do something after the initial connection establishment.
-interf.RegisterChanged += (o) => {
-    Console.WriteLine($"DT{o.MemoryAdress} {(o.Name != null ? $"({o.Name}) " : "")}changed to {o.GetValueString()}");
-};
 
-//Connects to the PLC asynchronous and invokes connected or failed
+```C#
 await interf.ConnectAsync(
-    (plcinf) => {
+    //PLC connected
-    
+    (plc) => {
-        Console.WriteLine("Connected to PLC:\n" + plcinf.ToString());
+        if(plcinf.OperationMode.RunMode)
-
+            Console.WriteLine("PLC is in RUN");
-        //read back a register value
-        var statusNum = (NRegister<short>)interf.Registers[1204];
-        Console.WriteLine($"Status num is: {statusNum.Value}");
-        
     },
+    //Connection failed
     () => {
-        Console.WriteLine("Failed connection");
+        Console.WriteLine("PLC failed to connect");
     }
 );
 ```
+## Reading data registers / contacts
+
+- Create a new class that inherits from `RegisterCollectionBase`
+
+```C#
+public class TestRegisters : RegisterCollectionBase {
+
+    //corresponds to a R100 boolean register in the PLC
+    [Register(100, RegisterType.R)]
+    public bool TestBool1 { get; private set; }
+
+    //corresponds to a XD input of the PLC
+    [Register(RegisterType.X, SpecialAddress.D)]
+    public bool TestBoolInputXD { get; private set; } 
+
+    //corresponds to a DT7012 - DT7013 as a 32bit time value that gets parsed as a timespan (TIME)
+    //the smallest value to communicate to the PLC is 10ms
+    [Register(7012)]
+    public TimeSpan TestTime { get; private set; }  
+    
+    //corresponds to a DT1101 - DT1104 string register in the PLC with (STRING[4])
+    [Register(1101, 4)]
+    public string TestString1 { get; private set; }
+
+}
+```
+
+- Connect to the PLC and attach the register collection and logger
+- attach an automatic poller by chaining `.WithPoller()` after the register attachment
+
+```C#
+//attaching a logger
+Logger.LogLevel = LogLevel.Verbose;
+Logger.OnNewLogMessage((date, msg) => {
+    Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
+});
+
+//setting up a new PLC interface and register collection
+MewtocolInterface interf = new MewtocolInterface("192.168.115.3");
+TestRegisters registers = new TestRegisters();
+
+//attaching the register collection and an automatic poller
+interf.WithRegisterCollection(registers).WithPoller();
+
+await interf.ConnectAsync(
+    (plcinf) => {
+        //reading a value from the register collection
+        Console.WriteLine($"Time Value is: {registers.TestTime}");
+    }
+);
+```
+- Your properties are getting automatically updated after the initial connection
+
+> Note! this is not your only option to read registers, see here
+
+## Writing data registers / contacts
+
+### Synchronous
+
+Sets the register without feedback if it was set
+
+```C#
+//inverts the boolean register
+interf.SetRegister(nameof(registers.TestBool1), !registers.TestBool1);
+
+//set the current second to the PLCs TIME register
+interf.SetRegister(nameof(registers.TestTime), TimeSpan.FromSeconds(DateTime.Now.Second));
+
+ //writes 'Test' to the PLCs string register
+interf.SetRegister(nameof(registers.TestString1), "Test");
+```
+
+You can also set a register by calling its name directly (Must be either in an attached register collection or added to the list manually)
+
+### Asynchronous
+
+Sets the register waiting for the PLC to confirm it was set
+
+```C#
+//inverts the boolean register
+interf.SetRegisterAsync(nameof(registers.TestBool1), !registers.TestBool1);
+```