Merge commit '3b3de6e2ef84c93ab5e873926d52a576093ae07d'

CHANGELOG.md

@@ -1,3 +1,8 @@
+## v5.2.0 - 2024-04-23
+
+### Features
+- Make IsConnected an abstract member of ModbusClient (#115)
+
 ## v5.1.0 - 2024-02-21
 
 ### Features

doc/dark-mode/public/main.js

@@ -0,0 +1,3 @@
+export default {
+  defaultTheme: 'dark'
+}

doc/docfx.json

@@ -6,24 +6,26 @@
           "files": [
             "**/*.csproj"
           ],
-          "src": "./../src"
+          "src": "../src"
         }
       ],
-      "dest": "./api",
+      "dest": "api",
       "filter": "filterConfig.yml",
       "properties": {
         "TargetFramework": "netstandard2.1"
-      }
+      },
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "noRestore": false,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "EnumSortOrder": "alphabetic",
+      "allowCompilationErrors": false
     }
   ],
   "build": {
     "content": [
-      {
-        "files": [
-          "*.md",
-          "toc.yml"
-        ]
-      },
       {
         "files": [
           "api/**.yml",
@@ -33,7 +35,9 @@
       {
         "files": [
           "samples/**.md",
-          "samples/**/toc.yml"
+          "samples/**/toc.yml",
+          "toc.yml",
+          "*.md"
         ]
       }
     ],
@@ -44,15 +48,21 @@
         ]
       }
     ],
-    "dest": "_site",
+    "output": "_site",
     "globalMetadata": {
       "_appTitle": "FluentModbus",
-      "_appFooter": "Copyright © 2019 Vincent Wilms",
-      "_appFaviconPath": "images/icon.ico",
+      "_appFooter": "Copyright © 2024 Vincent Wilms",
+      "_appFaviconPath": "images/icon.png",
       "_appLogoPath": "images/logo.svg"
     },
     "fileMetadataFiles": [],
-    "template":["default","templates/material"],
-    "markdownEngineName": "markdig"
+    "template": [
+      "default",
+      "modern",
+      "dark-mode"
+    ],
+    "postProcessors": [],
+    "keepFileLink": false,
+    "disableGitFeatures": false
   }
 }

doc/samples/modbus_tcp.md

@@ -156,7 +156,7 @@ static void DoClientWork(ModbusTcpClient client, ILogger logger)
     Span<byte> data;
 
     var sleepTime = TimeSpan.FromMilliseconds(100);
-    var unitIdentifier = 0xFF;
+    var unitIdentifier = 0x00;
     var startingAddress = 0;
     var registerAddress = 0;
 

doc/toc.yml

@@ -1,5 +1,5 @@
 - name: Samples
   href: samples/
 
-- name: Api Documentation
+- name: API
   href: api/

src/FluentModbus/Client/ModbusClient.cs

@@ -10,6 +10,11 @@ public abstract partial class ModbusClient
     {
         #region Properties
 
+        /// <summary>
+        /// Gets the connection status of the underlying client.
+        /// </summary>
+        public abstract bool IsConnected { get; }
+
         protected private bool SwapBytes { get; set; }
 
         #endregion

src/FluentModbus/Client/ModbusRtuClient.cs

@@ -31,7 +31,7 @@ public ModbusRtuClient()
         /// <summary>
         /// Gets the connection status of the underlying serial port.
         /// </summary>
-        public bool IsConnected => _serialPort?.Value.IsOpen ?? false;
+        public override bool IsConnected => _serialPort?.Value.IsOpen ?? false;
 
         /// <summary>
         /// Gets or sets the serial baud rate. Default is 9600.

src/FluentModbus/Client/ModbusTcpClient.cs

@@ -35,6 +35,11 @@ public ModbusTcpClient()
 
         #region Properties
 
+        /// <summary>
+        /// Gets the connection status of the underlying TCP client.
+        /// </summary>
+        public override bool IsConnected => _tcpClient?.Value.Connected ?? false;
+
         /// <summary>
         /// Gets or sets the connect timeout in milliseconds. Default is 1000 ms.
         /// </summary>
@@ -56,11 +61,6 @@ public ModbusTcpClient()
 
         #region Methods
 
-        /// <summary>
-        /// Gets the connection status of the underlying TCP client.
-        /// </summary>
-        public bool IsConnected => _tcpClient?.Value.Connected ?? false;
-
         /// <summary>
         /// Connect to localhost at port 502 with <see cref="ModbusEndianness.LittleEndian"/> as default byte layout.
         /// </summary>

version.json

@@ -1,4 +1,4 @@
 {
-    "version": "5.1.0",
+    "version": "5.2.0",
     "suffix": ""
 }