Added IgnoreHeartbeatOnChange configuration parameter for SHDR Adapters to toggle whether PING data is sent even if data has been received.

Author: PatrickRitchie

agent/Modules/MTConnect.NET-AgentModule-ShdrAdapter/Module.cs

@@ -106,6 +106,7 @@ private void AddAdapter(IShdrAdapterClientConfiguration configuration, IDevice d
 
                 // Create new SHDR Adapter Client to read from SHDR stream
                 var adapterClient = new ShdrAdapterClient(configuration, _mtconnectAgent, device, idSuffix);
+                adapterClient.IgnoreHeartbeatOnChange = configuration.IgnoreHeartbeatOnChange;
                 _adapters.Add(adapterClient);
 
                 adapterClient.Connected += AdapterConnected;

agent/Modules/MTConnect.NET-AgentModule-ShdrAdapter/README-Nuget.md

@@ -36,6 +36,8 @@ modules:
 
 * `outputConnectionInformation` - Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client
 
+* `ignoreHeartbeatOnChange` - Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period. Default is TRUE
+
 
 ## Contribution / Feedback
 - Please use the [Issues](https://github.com/TrakHound/MTConnect.NET/issues) tab to create issues for specific problems that you may encounter 

agent/Modules/MTConnect.NET-AgentModule-ShdrAdapter/README.md

@@ -54,6 +54,8 @@ modules:
 
 * `outputConnectionInformation` - Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client
 
+* `ignoreHeartbeatOnChange` - Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period. Default is TRUE
+
 
 ## Contribution / Feedback
 - Please use the [Issues](https://github.com/TrakHound/MTConnect.NET/issues) tab to create issues for specific problems that you may encounter 

libraries/MTConnect.NET-SHDR/Configurations/IShdrAdapterClientConfiguration.cs

@@ -33,5 +33,10 @@ public interface IShdrAdapterClientConfiguration : IShdrClientConfiguration
         /// Gets or Sets whether the Connection Information (Host / Port) is output to the Agent to be collected by a client
         /// </summary>
         bool OutputConnectionInformation { get; }
+
+        /// <summary>
+        /// Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period
+        /// </summary>
+        bool IgnoreHeartbeatOnChange { get; }
     }
 }

libraries/MTConnect.NET-SHDR/Configurations/ShdrAdapterClientConfiguration.cs

@@ -41,6 +41,12 @@ public class ShdrAdapterClientConfiguration : ShdrClientConfiguration, IShdrAdap
         [JsonPropertyName("outputConnectionInformation")]
         public bool OutputConnectionInformation { get; set; }
 
+        /// <summary>
+        /// Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period
+        /// </summary>
+        [JsonPropertyName("ignoreHeartbeatOnChange")]
+        public bool IgnoreHeartbeatOnChange { get; set; }
+
 
         public ShdrAdapterClientConfiguration()
         {
@@ -49,6 +55,7 @@ public ShdrAdapterClientConfiguration()
             ConvertUnits = true;
             IgnoreObservationCase = true;
             OutputConnectionInformation = true;
+            IgnoreHeartbeatOnChange = true;
         }
     }
 }

libraries/MTConnect.NET-SHDR/Shdr/ShdrClient.cs

@@ -64,6 +64,11 @@ public class ShdrClient
         /// </summary>
         public int ReconnectInterval { get; set; }
 
+        /// <summary>
+        /// Gets or Sets whether Heartbeat PING requests are not sent if data has been received within the Heartbeat period
+        /// </summary>
+        public bool IgnoreHeartbeatOnChange { get; set; }
+
 
         /// <summary>
         /// Raised when a client connection is established
@@ -111,6 +116,7 @@ public class ShdrClient
         public ShdrClient()
         {
             Id = StringFunctions.RandomString(10);
+            IgnoreHeartbeatOnChange = true;
         }
 
         public ShdrClient(string hostname, int port, int connectionTimeout = DefaultConnectionTimeout, int reconnectInterval = DefaultReconnectInterval)
@@ -120,6 +126,7 @@ public ShdrClient(string hostname, int port, int connectionTimeout = DefaultConn
             Port = port;
             ConnectionTimeout = connectionTimeout;
             ReconnectInterval = reconnectInterval;
+            IgnoreHeartbeatOnChange = true;
         }
 
         public ShdrClient(string hostname, int port, string deviceKey, int connectionTimeout = DefaultConnectionTimeout, int reconnectInterval = DefaultReconnectInterval)
@@ -130,11 +137,13 @@ public ShdrClient(string hostname, int port, string deviceKey, int connectionTim
             DeviceKey = deviceKey;
             ConnectionTimeout = connectionTimeout;
             ReconnectInterval = reconnectInterval;
+            IgnoreHeartbeatOnChange = true;
         }
 
         public ShdrClient(ShdrClientConfiguration configuration)
         {
             Id = StringFunctions.RandomString(10);
+            IgnoreHeartbeatOnChange = true;
 
             if (configuration != null)
             {
@@ -254,7 +263,7 @@ private async Task ListenForAdapter(CancellationToken cancel)
                                 }
 
                                 // Send PING Heartbeat if needed
-                                if (((now - lastResponse) > _heartbeat * 10000) && ((now - _lastHeartbeat) > _heartbeat * 10000))
+                                if ((!IgnoreHeartbeatOnChange || ((now - lastResponse) > _heartbeat * 10000)) && ((now - _lastHeartbeat) > _heartbeat * 10000))
                                 {
                                     messageBytes = Encoding.ASCII.GetBytes(PingMessage);
                                     stream.Write(messageBytes, 0, messageBytes.Length);