Added auto register reset to default typed value on disconnect

- version count up

.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+name: publish to nuget
+on:
+  push:
+    branches:
+      - master # Default release branch, may also be named 'master' or 'develop'
+jobs:
+  publish:
+    name: build, pack & publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      # - name: Setup dotnet
+      #   uses: actions/setup-dotnet@v1
+      #   with:
+      #     dotnet-version: 3.1.200
+
+      # Publish
+      - name: publish on version change
+        id: publish_nuget
+        uses: brandedoutcast/publish-nuget@v2
+        with:
+          # Filepath of the project to be packaged, relative to root of repository
+          PROJECT_FILE_PATH: MewtocolNet/MewtocolNet.csproj
+          
+          # Configuration to build and package
+          # BUILD_CONFIGURATION: Release
+          
+          # Platform target to compile (default is empty/AnyCPU)
+          # BUILD_PLATFORM: x64          
+          
+          # NuGet package id, used for version detection & defaults to project name
+          PACKAGE_NAME: Mewtocol.NET
+          
+          # Filepath with version info, relative to root of repository & defaults to PROJECT_FILE_PATH
+          # VERSION_FILE_PATH: Directory.Build.props
+
+          # Regex pattern to extract version info in a capturing group
+          # VERSION_REGEX: ^\s*<Version>(.*)<\/Version>\s*$
+          
+          # Useful with external providers like Nerdbank.GitVersioning, ignores VERSION_FILE_PATH & VERSION_REGEX
+          # VERSION_STATIC: 1.0.0
+
+          # Flag to toggle git tagging, enabled by default
+          # TAG_COMMIT: true
+
+          # Format of the git tag, [*] gets replaced with actual version
+          # TAG_FORMAT: v*
+
+          # API key to authenticate with NuGet server
+          NUGET_KEY: ${{secrets.NUGET_KEY}}
+
+          # NuGet server uri hosting the packages, defaults to https://api.nuget.org
+          # NUGET_SOURCE: https://api.nuget.org
+
+          # Flag to toggle pushing symbols along with nuget package to the server, disabled by default
+          # INCLUDE_SYMBOLS: false

Examples/Program.cs

@@ -27,6 +27,8 @@ class Program {
         Console.ReadLine();
     }
 
+    private static bool isProgressReadout = false;
+
     static void Scenario1 () {
 
         Task.Factory.StartNew(async () => {
@@ -44,20 +46,85 @@ class Program {
             //attaching the register collection and an automatic poller
             interf.WithRegisterCollection(registers).WithPoller();
 
-            await interf.ConnectAsync(
-                (plcinf) => {
+            _ = Task.Factory.StartNew(async () => {
+                while (true) {
+                    if (isProgressReadout) continue;
+                    Console.Title = $"Polling Paused: {interf.PollingPaused}, " +
+                    $"Poller active: {interf.PollerActive}, " +
+                    $"Speed UP: {interf.BytesPerSecondUpstream} B/s, " +
+                    $"Speed DOWN: {interf.BytesPerSecondDownstream} B/s, " +
+                    $"Poll delay: {interf.PollerDelayMs} ms, " +
+                    $"Queued MSGs: {interf.QueuedMessages}";
+                    await Task.Delay(1000);
+                }
+            });
+
+            //await interf.ConnectAsync((plcinf) => AfterConnect(interf, registers));
+
+            bool flip = false;
+            while(true) {
+
+                if(!flip) {
+                    await interf.ConnectAsync();
+                } else {
+                    interf.Disconnect();
+                }
+
+                flip = !flip;
+                await Task.Delay(5000);
+
+            }
+
+        });
+
+    }
+
+    static void AfterConnect (MewtocolInterface interf, TestRegisters registers) {
 
         //reading a value from the register collection
         Console.WriteLine($"BitValue is: {registers.BitValue}");
         Console.WriteLine($"TestEnum is: {registers.TestEnum}");
 
+        _ = Task.Factory.StartNew(async () => {
+
+            while(true) {
+
+                isProgressReadout = true;
+
+                await interf.ReadByteRange(1000, 2000, (p) => {
+
+                    var totSteps = 10;
+                    var cSteps = totSteps * p;
+
+                    string progBar = "";
+                    for (int i = 0; i < totSteps; i++) {
+
+                        if(i < (int)cSteps) {
+                            progBar += "⬛";
+                        } else {
+                            progBar += "⬜";
+                        }
+                        
+                    }
+
+                    Console.Title = $"Prog read range: {(p * 100).ToString("N1")}% {progBar} Queued MSGs: {interf.QueuedMessages}";
+
+                });
+
+                isProgressReadout = false;
+
+                await Task.Delay(3000);
+
+            }
+
+        });
+
         //writing a value to the registers
-                    Task.Factory.StartNew(async () => {
+        _ = Task.Factory.StartNew(async () => {
 
             //set plc to run mode if not already
             await interf.SetOperationMode(OPMode.Run);
 
-
             int startAdress = 10000;
             int entryByteSize = 20 * 20;
 
@@ -79,10 +146,28 @@ class Program {
             //set the current second to the PLCs TIME register
             interf.SetRegister(nameof(registers.TestTime), TimeSpan.FromSeconds(DateTime.Now.Second));
 
-                    });
+            //test pausing poller
+
+            bool pollerPaused = false;
+
+            while (true) {
+
+                await Task.Delay(5000);
+
+                pollerPaused = !pollerPaused;
+
+                if (pollerPaused) {
+                    Console.WriteLine("Pausing poller");
+                    await interf.PausePollingAsync();
+                    //interf.PollerDelayMs += 10;
+                    Console.WriteLine("Paused poller");
+                } else {
+                    interf.ResumePolling();
+                    Console.WriteLine("Resumed poller");
+                }
 
             }
-            );
+
 
         });
 

MewtocolNet/Mewtocol/DynamicInterface.cs

@@ -14,15 +14,69 @@ namespace MewtocolNet {
     /// </summary>
     public partial class MewtocolInterface {
 
+        /// <summary>
+        /// True if the auto poller is currently paused
+        /// </summary>
+        public bool PollingPaused => pollerIsPaused;
+
+        /// <summary>
+        /// True if the poller is actvice (can be paused)
+        /// </summary>
+        public bool PollerActive => !pollerTaskStopped;
+
         internal event Action PolledCycle;
-        internal bool ContinousReaderRunning;
+        
+        internal volatile bool pollerTaskRunning;
+        internal volatile bool pollerTaskStopped;
+        internal volatile bool pollerIsPaused;
+        internal volatile bool pollerFirstCycle = false;
+
         internal bool usePoller = false;
 
         #region Register Polling
 
+        /// <summary>
+        /// Kills the poller completely
+        /// </summary>
         internal void KillPoller () {
 
-            ContinousReaderRunning = false;
+            pollerTaskRunning = false;
+            pollerTaskStopped = true;
+
+            ClearRegisterVals();
+
+        }
+
+        /// <summary>
+        /// Pauses the polling and waits for the last message to be sent
+        /// </summary>
+        /// <returns></returns>
+        public async Task PausePollingAsync () {
+
+            if (!pollerTaskRunning)
+                return;
+
+            pollerTaskRunning = false;
+
+            while (!pollerIsPaused) {
+
+                if (pollerIsPaused)
+                    break;
+                
+                await Task.Delay(10);
+            
+            }
+
+            pollerTaskRunning = false;
+
+        }
+
+        /// <summary>
+        /// Resumes the polling
+        /// </summary>
+        public void ResumePolling () {
+
+            pollerTaskRunning = true;
 
         }
 
@@ -31,32 +85,39 @@ namespace MewtocolNet {
         /// </summary>
         internal void AttachPoller () {
 
-            if (ContinousReaderRunning)
+            if (pollerTaskRunning)
                 return;
 
+            pollerFirstCycle = true;
+
             Task.Factory.StartNew(async () => {
 
                 Logger.Log("Poller is attaching", LogLevel.Info, this);
 
-                int it = 0;
-                ContinousReaderRunning = true;
+                int iteration = 0;
 
-                while (ContinousReaderRunning) {
+                pollerTaskStopped = false;
+                pollerTaskRunning = true;
+                pollerIsPaused = false;
 
-                    if (it >= Registers.Count + 1) {
-                        it = 0;
+                while (!pollerTaskStopped) {
+
+                    while (pollerTaskRunning) {
+
+                        if (iteration >= Registers.Count + 1) {
+                            iteration = 0;
                             //invoke cycle polled event
                             InvokePolledCycleDone();
                             continue;
                         }
 
-                    if (it >= Registers.Count) {
+                        if (iteration >= Registers.Count) {
                             await GetPLCInfoAsync();
-                        it++;
+                            iteration++;
                             continue;
                         }
 
-                    var reg = Registers[it];
+                        var reg = Registers[iteration];
 
                         if (reg is NRegister<short> shortReg) {
                             var lastVal = shortReg.Value;
@@ -115,10 +176,19 @@ namespace MewtocolNet {
                             }
                         }
 
-                    it++;
+                        iteration++;
+                        pollerFirstCycle = false;
+
+                        await Task.Delay(pollerDelayMs);
 
                     }
 
+                    pollerIsPaused = !pollerTaskRunning;
+
+                }
+
+                pollerIsPaused = false;
+
             });
 
         }

MewtocolNet/Mewtocol/MewtocolInterface.cs

@@ -52,6 +52,26 @@ namespace MewtocolNet {
             set { connectTimeout = value; }
         }
 
+        private volatile int pollerDelayMs = 0;
+        /// <summary>
+        /// Delay for each poller cycle in milliseconds, default = 0
+        /// </summary>
+        public int PollerDelayMs {
+            get => pollerDelayMs;
+            set { 
+                pollerDelayMs = value;
+                PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(PollerDelayMs)));
+            }
+        }
+
+        private volatile int queuedMessages;
+        /// <summary>
+        /// Currently queued Messages
+        /// </summary>
+        public int QueuedMessages {
+            get => queuedMessages;
+        }
+
         /// <summary>
         /// The host ip endpoint, leave it null to use an automatic interface
         /// </summary>
@@ -101,6 +121,9 @@ namespace MewtocolNet {
         private int stationNumber;
         private int cycleTimeMs = 25;
 
+        private int bytesTotalCountedUpstream = 0;
+        private int bytesTotalCountedDownstream = 0;
+
         /// <summary>
         /// The current IP of the PLC connection
         /// </summary>
@@ -125,6 +148,30 @@ namespace MewtocolNet {
             }
         }
 
+        private int bytesPerSecondUpstream = 0;
+        /// <summary>
+        /// The current transmission speed in bytes per second
+        /// </summary>
+        public int BytesPerSecondUpstream {
+            get { return bytesPerSecondUpstream; }  
+            private set {
+                bytesPerSecondUpstream = value;
+                PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(BytesPerSecondUpstream)));
+            }
+        }
+
+        private int bytesPerSecondDownstream = 0;
+        /// <summary>
+        /// The current transmission speed in bytes per second
+        /// </summary>
+        public int BytesPerSecondDownstream {
+            get { return bytesPerSecondDownstream; }
+            private set {
+                bytesPerSecondDownstream = value;
+                PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(BytesPerSecondDownstream)));
+            }
+        }
+
         internal NetworkStream stream;
         internal TcpClient client;
         internal readonly SerialQueue queue = new SerialQueue();
@@ -132,6 +179,9 @@ namespace MewtocolNet {
         internal int SendExceptionsInRow = 0;
         internal bool ImportantTaskRunning = false;
 
+        private Stopwatch speedStopwatchUpstr;
+        private Stopwatch speedStopwatchDownstr;
+
         #region Initialization
 
         /// <summary>
@@ -345,6 +395,17 @@ namespace MewtocolNet {
 
         }
 
+        private void ClearRegisterVals () {
+
+            for (int i = 0; i < Registers.Count; i++) {
+
+                var reg = Registers[i];
+                reg.ClearValue();
+
+            }
+
+        }
+
         #endregion
 
         #region Register Collection
@@ -682,8 +743,13 @@ namespace MewtocolNet {
             //send request
             try {
 
+                queuedMessages++;
+                
                 var response = await queue.Enqueue(() => SendSingleBlock(_msg));
 
+                if (queuedMessages > 0) 
+                    queuedMessages--;
+
                 if (response == null) {
                     return new CommandResult {
                         Success = false,
@@ -736,6 +802,16 @@ namespace MewtocolNet {
 
             var message = _blockString.ToHexASCIIBytes();
 
+            //time measuring
+            if(speedStopwatchUpstr == null) {
+                speedStopwatchUpstr = Stopwatch.StartNew();
+            }
+
+            if(speedStopwatchUpstr.Elapsed.TotalSeconds >= 1) {
+                speedStopwatchUpstr.Restart();
+                bytesTotalCountedUpstream = 0;
+            }
+
             //send request
             using (var sendStream = new MemoryStream(message)) {
                 await sendStream.CopyToAsync(stream);
@@ -743,6 +819,13 @@ namespace MewtocolNet {
                 Logger.Log($"--> OUT MSG: {_blockString}", LogLevel.Critical, this);
             }
 
+            //calc upstream speed
+            bytesTotalCountedUpstream += message.Length;
+
+            var perSecUpstream = (double)((bytesTotalCountedUpstream / speedStopwatchUpstr.Elapsed.TotalMilliseconds) * 1000);
+            if (perSecUpstream <= 10000)
+                BytesPerSecondUpstream = (int)Math.Round(perSecUpstream, MidpointRounding.AwayFromZero);
+
             //await result
             StringBuilder response = new StringBuilder();
             try {
@@ -755,6 +838,17 @@ namespace MewtocolNet {
                 while (!endLineCode && !startMsgCode) {
 
                     do {
+
+                        //time measuring
+                        if (speedStopwatchDownstr == null) {
+                            speedStopwatchDownstr = Stopwatch.StartNew();
+                        }
+
+                        if (speedStopwatchDownstr.Elapsed.TotalSeconds >= 1) {
+                            speedStopwatchDownstr.Restart();
+                            bytesTotalCountedDownstream = 0;
+                        }
+
                         int bytes = await stream.ReadAsync(responseBuffer, 0, responseBuffer.Length);
 
                         endLineCode = responseBuffer.Any(x => x == 0x0D);
@@ -777,8 +871,18 @@ namespace MewtocolNet {
             }
 
             if(!string.IsNullOrEmpty(response.ToString())) {
+                
                 Logger.Log($"<-- IN MSG: {response}", LogLevel.Critical, this);
+
+                bytesTotalCountedDownstream += Encoding.ASCII.GetByteCount(response.ToString());
+
+                var perSecDownstream = (double)((bytesTotalCountedDownstream / speedStopwatchDownstr.Elapsed.TotalMilliseconds) * 1000);
+
+                if(perSecUpstream <= 10000) 
+                    BytesPerSecondDownstream = (int)Math.Round(perSecUpstream, MidpointRounding.AwayFromZero);
+
                 return response.ToString();
+
             } else {
                 return null;
             }

MewtocolNet/Mewtocol/MewtocolInterfaceRequests.cs

@@ -112,8 +112,9 @@ namespace MewtocolNet {
         /// </summary>
         /// <param name="start">Start adress</param>
         /// <param name="count">Number of bytes to get</param>
+        /// <param name="onProgress">Gets invoked when the progress changes, contains the progress as a double</param>
         /// <returns>A byte array or null of there was an error</returns>
-        public async Task<byte[]> ReadByteRange (int start, int count) {
+        public async Task<byte[]> ReadByteRange (int start, int count, Action<double> onProgress = null) {
 
             var byteList = new List<byte>();
             
@@ -146,6 +147,9 @@ namespace MewtocolNet {
 
                 }
 
+                if(onProgress != null)  
+                    onProgress((double)i / wordLength);
+
             }
 
             return byteList.ToArray();  

MewtocolNet/Mewtocol/Subregisters/Register.cs

@@ -94,6 +94,38 @@ namespace MewtocolNet.Registers {
             PropertyChanged?.Invoke(this, new PropertyChangedEventArgs("Value"));
         }
 
+        internal void ClearValue () {
+
+            if (enumType != null && this is NRegister<int> intEnumReg) {
+                intEnumReg.SetValueFromPLC((int)0);
+            }
+            if (this is NRegister<short> shortReg) {
+                shortReg.SetValueFromPLC((short)0);
+            }
+            if (this is NRegister<ushort> ushortReg) {
+                ushortReg.SetValueFromPLC((ushort)0);
+            }
+            if (this is NRegister<int> intReg) {
+                intReg.SetValueFromPLC((int)0);
+            }
+            if (this is NRegister<uint> uintReg) {
+                uintReg.SetValueFromPLC((uint)0);
+            }
+            if (this is NRegister<float> floatReg) {
+                floatReg.SetValueFromPLC((float)0);
+            }
+            if (this is NRegister<TimeSpan> tsReg) {
+                tsReg.SetValueFromPLC(TimeSpan.Zero);
+            }
+            if (this is BRegister boolReg) {
+                boolReg.SetValueFromPLC(false);
+            }
+            if (this is SRegister stringReg) {
+                stringReg.SetValueFromPLC(null);
+            }
+
+        }
+
         /// <summary>
         /// Gets the starting memory are either numeric or A,B,C,D etc for special areas like inputs
         /// </summary>

MewtocolNet/MewtocolNet.csproj

@@ -1,8 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <PackageId>MewtocolNet</PackageId>
-    <Version>0.5.2</Version>
+    <PackageId>Mewtocol.NET</PackageId>
+    <Version>0.6.2</Version>
     <Authors>Felix Weiss</Authors>
     <Company>Womed</Company>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>

MewtocolNet/Queue/SerialQueue.cs

@@ -8,47 +8,6 @@ namespace MewtocolNet.Queue {
         readonly object _locker = new object();
         readonly WeakReference<Task> _lastTask = new WeakReference<Task>(null);
 
-        internal Task Enqueue (Action action) {
-            return Enqueue<bool>(() => {
-                action();
-                return true;
-            });
-        }
-
-        internal Task<T> Enqueue<T> (Func<T> function) {
-            lock (_locker) {
-                Task lastTask;
-                Task<T> resultTask;
-
-                if (_lastTask.TryGetTarget(out lastTask)) {
-                    resultTask = lastTask.ContinueWith(_ => function(), TaskContinuationOptions.ExecuteSynchronously);
-                } else {
-                    resultTask = Task.Run(function);
-                }
-
-                _lastTask.SetTarget(resultTask);
-
-                return resultTask;
-            }
-        }
-
-        internal Task Enqueue (Func<Task> asyncAction) {
-            lock (_locker) {
-                Task lastTask;
-                Task resultTask;
-
-                if (_lastTask.TryGetTarget(out lastTask)) {
-                    resultTask = lastTask.ContinueWith(_ => asyncAction(), TaskContinuationOptions.ExecuteSynchronously).Unwrap();
-                } else {
-                    resultTask = Task.Run(asyncAction);
-                }
-
-                _lastTask.SetTarget(resultTask);
-
-                return resultTask;
-            }
-        }
-
         internal Task<T> Enqueue<T> (Func<Task<T>> asyncFunction) {
             lock (_locker) {
                 Task lastTask;

README.md

@@ -1,7 +1,6 @@
-[![.NET Windows](https://github.com/WOmed/MewtocolNet/actions/workflows/dotnet-windows.yml/badge.svg)](https://github.com/WOmed/MewtocolNet/actions/workflows/dotnet-windows.yml)
-![Nuget](https://img.shields.io/nuget/v/MewtocolNet)
+[![Publish to Nuget](https://github.com/WOmed/MewtocolNet/actions/workflows/publish.yml/badge.svg)](https://github.com/WOmed/MewtocolNet/actions/workflows/publish.yml)
+[![Nuget](https://img.shields.io/nuget/v/Mewtocol.NET)](https://www.nuget.org/packages/Mewtocol.NET)
 ![Lines of code](https://img.shields.io/tokei/lines/github/WOmed/MewtocolNet)
-![Nuget](https://img.shields.io/nuget/dt/MewtocolNet)
 ![GitHub](https://img.shields.io/github/license/WOmed/MewtocolNet)
 ![Status](https://img.shields.io/badge/Status-In%20dev-orange)
 
@@ -51,14 +50,14 @@ Where is the RS232/Serial support?
 
 # Installing
 
-Install this package by using [Nuget](https://www.nuget.org/packages/MewtocolNet/) or reference 
+Install this package by using [Nuget](https://www.nuget.org/packages/Mewtocol.NET) or reference 
 ```XML
-<PackageReference Include="MewtocolNet" Version="0.5.0" />
+<PackageReference Include="Mewtocol.NET" Version="0.6.1"/>
 ```
 in your dependencies.
 Alternatively use the dotnet CLI and run 
 ```Shell
-dotnet add package MewtocolNet
+dotnet add package Mewtocol.NET
 ```
 
 # Protocol description