23 - Refactored serial reading

- made SerialMonitor disposable
- introduced -w command arg flag
- creating optional telegramexporter for storing telegrams

Author: stprograms

.gitignore

@@ -452,3 +452,8 @@ $RECYCLE.BIN/
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+
+
+# My own files to ignore
+*.ssm
+*.bin

.vscode/launch.json

@@ -8,7 +8,7 @@
             "preLaunchTask": "build",
             // If you have changed target frameworks, make sure to update the program path.
             "program": "${workspaceFolder}/RS485 Monitor/bin/Debug/net8.0/RS485 Monitor.dll",
-            "args": [""],
+            "args": ["-w"],
             "cwd": "${workspaceFolder}",
             // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
             "console": "internalConsole",

RS485 Monitor/src/CmdOptions.cs

@@ -6,11 +6,14 @@
 public class CmdOptions
 {
     [Value(0, MetaName = "InputFile", HelpText = "File to parse")]
-    public String? InputFile { get; set; }
+    public string? InputFile { get; set; }
 
     [Option('r', "replay", HelpText = "Replay data on serial port", Default = false)]
-    public bool replayOnSerial { get; set; }
+    public bool ReplayOnSerial { get; set; }
 
     [Option('g', "group", HelpText = "Group telegrams in output", Default = false)]
-    public bool groupOutput { get; set; }
-}
+    public bool GroupOutput { get; set; }
+
+    [Option('w', "write-to-file", HelpText = "Write telegrams including timestamp to a file", Default = false)]
+    public bool WriteToFile { get; set; }
+}

RS485 Monitor/src/Program.cs

@@ -2,6 +2,10 @@
 using NLog.Extensions.Logging;
 using Microsoft.Extensions.Configuration;
 using CommandLine;
+using RS485_Monitor.Utils.Storage;
+using System.Runtime.CompilerServices;
+
+const string FILE_EXTENSION = ".ssm";
 
 // Configuration
 var config = new ConfigurationBuilder()
@@ -10,25 +14,26 @@
 
 var sec = config.GetSection("NLog");
 LogManager.Configuration = new NLogLoggingConfiguration(sec);
-NLog.Logger log = LogManager.GetCurrentClassLogger();
+Logger log = LogManager.GetCurrentClassLogger();
 
 Configuration cfg = new(config.GetSection("Monitor"));
 
-// Commandline parser
-String? parseFile = null;
+// command line parser
+string? parseFile = null;
 bool replayToSerial = false;
 bool groupOutput = false;
-
+bool writeToFile = false;
 
 var result = Parser.Default.ParseArguments<CmdOptions>(args)
-    .WithParsed<CmdOptions>(o =>
+    .WithParsed(o =>
     {
         if (o.InputFile != null)
         {
             parseFile = o.InputFile;
         }
-        replayToSerial = o.replayOnSerial;
-        groupOutput = o.groupOutput;
+        replayToSerial = o.ReplayOnSerial;
+        groupOutput = o.GroupOutput;
+        writeToFile = o.WriteToFile;
     }
     );
 
@@ -40,15 +45,7 @@
 }
 
 // Configure output
-IUserVisualizable printer;
-if (groupOutput)
-{
-    printer = new ConsolePrinter();
-}
-else
-{
-    printer = new LogPrinter();
-}
+IUserVisualizable printer = groupOutput ? new ConsolePrinter() : new LogPrinter();
 
 // Select execution
 if (parseFile != null)
@@ -63,6 +60,83 @@
     StartMonitor(cfg);
 }
 
+/// <summary>
+/// Start the serial monitor
+/// </summary>
+void StartMonitor(Configuration cfg)
+{
+    // Semaphore for ending the monitor
+    Semaphore endMonitor = new(0, 1);
+
+    // Register CTRL+C
+    Console.CancelKeyPress += new ConsoleCancelEventHandler((sender, args) =>
+    {
+        log.Info("Exiting ...");
+
+        // Set cancel to true to prevent default CTRL+C behaviour
+        args.Cancel = true;
+
+        // release semaphore
+        endMonitor.Release();
+    });
+
+    log.Info($"Starting Serial Monitor on port {cfg.ComPort}");
+
+    // create telegram exporter
+    TelegramExporter? exporter = null;
+    if (writeToFile)
+    {
+        FileInfo? outputFile = null;
+        string filename = DateTime.Now.ToString("yyyyMMdd_HHmmss") + "_telegram" + FILE_EXTENSION;
+
+        // Determine full output file path
+        if (cfg.OutputDir != null)
+        {
+            outputFile = new(cfg.OutputDir + "/" + filename);
+        }
+        else
+        {
+            outputFile = new(filename);
+        }
+
+        // create exporter
+        exporter = new(outputFile.OpenWrite());
+    }
+
+    // Start serial monitor on the given port
+    using (SerialMonitor monitor = new(cfg.ComPort, cfg.WriteRawData))
+    {
+        if (cfg.OutputDir != null)
+        {
+            monitor.OutputDir = cfg.OutputDir;
+        }
+        monitor.TelegramReceived += (o, e) =>
+        {
+            // Print the received telegram
+            printer.PrintTelegram(e.Telegram);
+            exporter?.PushTelegram(e.Telegram);
+        };
+
+        // Start reading monitor
+        try
+        {
+            monitor.Start();
+        }
+        catch (IOException ex)
+        {
+            log.Fatal(ex, "Could not start monitor");
+            return;
+        }
+
+        // Wait for CTRL+C
+        endMonitor.WaitOne();
+    }
+    log.Info("Monitor stopped");
+
+    // close exporter
+    exporter?.Dispose();
+}
+
 
 /// <summary>
 /// Read a local file and parse it
@@ -72,7 +146,7 @@ async Task ReadLocalFile(String file)
     TelegramParser parser = new();
     TelegramPlayer player = new(cfg.ReplayCycle);
 
-    // Register new telegram handler 
+    // Register new telegram handler
     parser.NewTelegram += (sender, evt) =>
     {
         BaseTelegram telegram = ((TelegramParser.TelegramArgs)evt).Telegram;
@@ -105,49 +179,6 @@ async Task ReadLocalFile(String file)
 }
 
 
-/// <summary>
-/// Start the serial monitor
-/// </summary>
-void StartMonitor(Configuration cfg)
-{
-    log.Info($"Starting Serial Monitor on port {cfg.ComPort}");
-
-    SerialMonitor monitor = new(cfg.ComPort, cfg.WriteRawData);
-    if (cfg.OutputDir != null)
-    {
-        monitor.OutputDir = cfg.OutputDir;
-    }
-    monitor.TelegramReceived += (o, e) =>
-    {
-        // Print the received telegram
-        printer.PrintTelegram(e.Telegram);
-    };
-
-    // Register CTRL+C
-    Console.CancelKeyPress += delegate
-    {
-        log.Info("Exiting ...");
-        monitor.Stop();
-    };
-
-    // Start reading monitor
-    try
-    {
-        monitor.Start();
-    }
-    catch (System.IO.IOException ex)
-    {
-        log.Fatal(ex, "Could not start monitor");
-        return;
-    }
-
-    // Endless loop
-    while (monitor.Running)
-    {
-        Thread.Sleep(10);
-    }
-}
-
 
 /// <summary>
 /// Read a local file and parse it

RS485 Monitor/src/SerialMonitor.cs

@@ -2,13 +2,11 @@
 
 using System.IO.Ports;
 using NLog;
-using System.Diagnostics;
-using System.Text;
 
 /// <summary>
 /// Class reading data from the serial interface and parsing using the TelegramParser.
 /// </summary>
-public class SerialMonitor
+public class SerialMonitor : IDisposable
 {
     #region Private Members
     /// <summary>
@@ -56,7 +54,7 @@ public class SerialMonitor
     /// </summary>
     private const int BAUDRATE = 9600;
     /// <summary>
-    /// Maximum size of the buffer / chunks 
+    /// Maximum size of the buffer / chunks
     /// </summary>
     private const int BUFFER_SIZE = 256;
     #endregion
@@ -85,11 +83,12 @@ public SerialMonitor(string comPort, bool writeRawData = false)
         parser = new();
         parser.NewTelegram += (o, t) =>
         {
-            BaseTelegram? tel = (t as TelegramParser.TelegramArgs)?.Telegram;
+            var args = t as TelegramParser.TelegramArgs;
 
-            if (tel != null && TelegramReceived != null)
+            if (args !=null)
             {
-                TelegramReceived.Invoke(this, new TelegramParser.TelegramArgs(tel));
+                // Forward the telegram
+                TelegramReceived?.Invoke(this, args);
             }
         };
     }
@@ -111,7 +110,7 @@ private void DataReceivedHandler(object sender, SerialDataReceivedEventArgs args
             }
             buffer = new byte[bytesToRead];
 
-            // Read data 
+            // Read data
             int readBytes = port.Read(buffer, 0, bytesToRead);
 
             if (readBytes != bytesToRead)
@@ -163,4 +162,9 @@ public void Stop()
 
         Running = false;
     }
-}
+
+    public void Dispose()
+    {
+        Stop();
+    }
+}