- New ISerialPort and IComTransport interfaces introduced

- SystemSerialPort and ComTransport added as implementations
- SerialPortConfig record created for port configuration
- FakeSerialPort implemented for unit tests
- New test project CommunicationTests created with MSTest
- Network and COM port tests moved from CommonLibraryTests
- INetCom interface moved to Communication.Interfaces
- System.IO.Ports referenced as NuGet package
- NodeComparer extracted and moved from Pathfinding
- File comments and paths updated
- CoreLibrary.sln and README.md expanded and adapted accordingly

Author: Wayfarer

CommonLibraryTests/CommonLibraryTests.csproj

@@ -86,7 +86,6 @@
   <ItemGroup>
     <ProjectReference Include="..\CommonControls\CommonControls.csproj" />
     <ProjectReference Include="..\CommonFilter\CommonFilter.csproj" />
-    <ProjectReference Include="..\Communication\Communication.csproj" />
     <ProjectReference Include="..\CoreMemoryLog\CoreMemoryLog.csproj" />
     <ProjectReference Include="..\ExtendedSystemObjects\ExtendedSystemObjects.csproj" />
     <ProjectReference Include="..\FileHandler\FileHandler.csproj" />

CommonLibraryTests/Communication.cs

@@ -0,0 +1,105 @@
+/*
+ * COPYRIGHT:   See COPYING in the top level directory
+ * PROJECT:     Communication
+ * FILE:        ComTransport.cs
+ * PURPOSE:     Wrapper around a serial port implementing IComTransport, with async read support.
+ * PROGRAMMER:  Peter Geinitz (Wayfarer)
+ */
+
+using System;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Communication.Interfaces;
+
+namespace Communication
+{
+    /// <inheritdoc />
+    /// <summary>
+    /// Wrapper around a serial port implementing IComTransport
+    /// </summary>
+    /// <seealso cref="Communication.Interfaces.IComTransport" />
+    public sealed class ComTransport : IComTransport
+    {
+        /// <summary>
+        /// The port
+        /// </summary>
+        private readonly ISerialPort _port;
+
+        /// <summary>
+        /// The buffer
+        /// </summary>
+        private readonly byte[] _buffer = new byte[4096];
+
+        /// <summary>
+        /// The encoding
+        /// </summary>
+        private readonly Encoding _encoding = Encoding.ASCII;
+
+        /// <inheritdoc />
+        public event Action<string>? DataReceived;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ComTransport"/> class.
+        /// </summary>
+        /// <param name="port">The port.</param>
+        public ComTransport(ISerialPort port)
+        {
+            _port = port;
+            _port.DataReceived += OnPortData;
+        }
+
+        /// <summary>
+        /// Called when [port data].
+        /// </summary>
+        /// <param name="sender">The sender.</param>
+        /// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>
+        private void OnPortData(object? sender, EventArgs e)
+        {
+            int bytes = _port.Read(_buffer, 0, _buffer.Length);
+            if (bytes <= 0)
+                return;
+
+            string text = _encoding.GetString(_buffer, 0, bytes);
+            DataReceived?.Invoke(text);
+        }
+
+        /// <inheritdoc />
+        public void Write(string text)
+        {
+            if (string.IsNullOrEmpty(text))
+                return;
+
+            _port.Write(text);
+        }
+
+        /// <summary>
+        /// Reads the once asynchronous.
+        /// </summary>
+        /// <param name="timeout">The timeout.</param>
+        /// <returns>Message from Port.</returns>
+        public Task<string> ReadOnceAsync(TimeSpan timeout)
+        {
+            var tcs = new TaskCompletionSource<string>(
+                TaskCreationOptions.RunContinuationsAsynchronously);
+
+            void Handler(string data)
+                => tcs.TrySetResult(data);
+
+            DataReceived += Handler;
+
+            var timer = new Timer(_ =>
+                tcs.TrySetException(new TimeoutException()),
+                null,
+                timeout,
+                Timeout.InfiniteTimeSpan);
+
+            return tcs.Task.ContinueWith(t =>
+            {
+                DataReceived -= Handler;
+                timer.Dispose();
+                return t.Result;
+            });
+        }
+    }
+}

Communication/ComTransport.cs

@@ -17,4 +17,8 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="System.IO.Ports" Version="10.0.1" />
+  </ItemGroup>
+
 </Project>

Communication/Communication.csproj

@@ -1,7 +1,7 @@
 /*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     Communication
- * FILE:        Communication/FileTransfer.cs
+ * FILE:        FileTransfer.cs
  * PURPOSE:     Does the heavy lifting for File Transfers
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */

Communication/FileTransfer.cs

@@ -1,7 +1,7 @@
 /*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     Communication
- * FILE:        Communication/HttpClientManager.cs
+ * FILE:        HttpClientManager.cs
  * PURPOSE:     Handle Http Requests
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */

Communication/HttpClientManager.cs

@@ -0,0 +1,31 @@
+/*
+ * COPYRIGHT:   See COPYING in the top level directory
+ * PROJECT:     Communication.Interfaces
+ * FILE:        IComTransport.cs
+ * PURPOSE:     Com Port Interface, wraps around my ISerialPort.
+ *              After that the Protocol layer can be implemented on top.
+ * PROGRAMMER:  Peter Geinitz (Wayfarer)
+ */
+
+using System;
+
+namespace Communication.Interfaces
+{
+    /// <summary>
+    /// Minimal implementation of a COM transport interface.
+    /// </summary>
+    public interface IComTransport
+    {
+        /// <summary>
+        /// Writes the specified text.
+        /// </summary>
+        /// <param name="text">The text.</param>
+        void Write(string text);
+
+        /// <summary>
+        /// Occurs when [data received].
+        /// </summary>
+        event Action<string> DataReceived;
+    }
+
+}

Communication/Interfaces/IComTransport.cs

@@ -1,7 +1,7 @@
 /*
  * COPYRIGHT:   See COPYING in the top level directory
- * PROJECT:     Communication
- * FILE:        Communication/INetCom.cs
+ * PROJECT:     Communication.Interfaces;
+ * FILE:        INetCom.cs
  * PURPOSE:     Entry Point for File Downloads, defined as Interface
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
@@ -15,7 +15,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 
-namespace Communication;
+namespace Communication.Interfaces;
 
 /// <summary>
 ///     The ICom interface.

Communication/INetCom.cs Communication/Interfaces/INetCom.csCommunication/INetCom.cs renamed to Communication/Interfaces/INetCom.cs

@@ -0,0 +1,74 @@
+/*
+ * COPYRIGHT:   See COPYING in the top level directory
+ * PROJECT:     Communication.Interfaces
+ * FILE:        ISerialPort.cs
+ * PURPOSE:     Basic serial port interface
+ * PROGRAMMER:  Peter Geinitz (Wayfarer)
+ */
+
+using System;
+
+namespace Communication.Interfaces
+{
+    /// <summary>
+    /// The ISerialPort interface.
+    /// </summary>
+    public interface ISerialPort
+    {
+        /// <summary>
+        /// Gets a value indicating whether this instance is open.
+        /// </summary>
+        /// <value>
+        ///   <c>true</c> if this instance is open; otherwise, <c>false</c>.
+        /// </value>
+        bool IsOpen { get; }
+
+        /// <summary>
+        /// Opens this instance.
+        /// </summary>
+        void Open();
+
+        /// <summary>
+        /// Closes this instance.
+        /// </summary>
+        void Close();
+
+        /// <summary>
+        /// Reads the specified buffer.
+        /// </summary>
+        /// <param name="buffer">The buffer.</param>
+        /// <param name="offset">The offset.</param>
+        /// <param name="count">The count.</param>
+        /// <returns>Actual count of bytes, the actual value is in the buffer</returns>
+        int Read(byte[] buffer, int offset, int count);
+
+        /// <summary>
+        /// Reads the specified buffer.
+        /// </summary>
+        /// <param name="buffer">The buffer.</param>
+        /// <param name="offset">The offset.</param>
+        /// <param name="count">The count.</param>
+        /// <returns>Actual count of bytes, the actual value is in the buffer</returns>
+        int Read(char[] buffer, int offset, int count);
+
+        /// <summary>
+        /// Writes the specified data.
+        /// </summary>
+        /// <param name="data">The data.</param>
+        void Write(string data);
+
+
+        /// <summary>
+        /// Writes the specified buffer.
+        /// </summary>
+        /// <param name="buffer">The buffer.</param>
+        /// <param name="offset">The offset.</param>
+        /// <param name="count">The count.</param>
+        void Write(byte[] buffer, int offset, int count);
+
+        /// <summary>
+        /// Occurs when [data received].
+        /// </summary>
+        event EventHandler DataReceived;
+    }
+}

Communication/Interfaces/ISerialPort.cs

@@ -12,6 +12,7 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
+using Communication.Interfaces;
 
 namespace Communication;