Version 1.1.0 (#3)

## New feature
- Added optional setting to enable the MQTT client to Disconnect with Will Message. If enabled, a Will Message will be sent before intentionally disconnecting.

---------

Co-authored-by: Roy Gollub <roy.gollub@sick.de>

Author: novakroSICKAG

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 1.1.0
+
+### Improvements
+- Added option to send Will Message also when disconnecting normally.
+
 ## Release 1.0.0
 
 ### Improvements

CSK_Module_MQTTClient/pages/pages/CSK_Module_MQTTClient/CSK_Module_MQTTClient.html

@@ -248,6 +248,37 @@
 												</layout-row>
 												</layout-column>
 												</layout-row>
+												<layout-row id="Placeholder12"
+													class="myCustom10pxHeight_CSK_Module_MQTTClient">
+												</layout-row>
+												<layout-row id="RowLayout31">
+												<layout-column id="ColumnLayout58" style="align-items: stretch">
+												<davinci-value-display id="VD_SendWillMessageByClosing"
+													value="Disconnect with WillMessage:">
+												</davinci-value-display>
+												</layout-column>
+												<layout-column id="ColumnLayout59" style="align-items: stretch">
+												<layout-row id="RowLayout45" style="justify-content: flex-end">
+												<davinci-toggle-switch id="TS_WillMessageOnDisconnect">
+												<crown-edpws-binding property="checked"
+													name="CSK_MQTTClient/OnNewStatusDisconnectWithWillMessage"
+													update-on-resume>
+												</crown-edpws-binding>
+												<crown-set event="change"
+													crown-function="CSK_MQTTClient/setDisconnectWithWillMessage"
+													protocol="crownMSGPACK" crown-path="status">
+												</crown-set>
+												<crown-edpws-binding property="disabled"
+													name="CSK_MQTTClient/OnNewStatusWillMessageActive"
+													update-on-resume converter="function(value) {return !value;}">
+												</crown-edpws-binding>
+												</davinci-toggle-switch>
+												</layout-row>
+												</layout-column>
+												</layout-row>
+												<layout-row id="Placeholder13"
+													class="myCustom10pxHeight_CSK_Module_MQTTClient">
+												</layout-row>
 												<davinci-value-display id="VD_WillMessageConfig">
 												<crown-on property="value"
 													crown-event="CSK_MQTTClient/OnNewStatusWillMessageConfig">

CSK_Module_MQTTClient/project.mf.xml

@@ -27,7 +27,8 @@ This can be used e.g. to listen to "OtherModule.OnNewResult"-events and to forwa
 To do so make use of "addPublishEvent" (via script) or the "presetPublish"-functions (incl. "presetPublishEvent") and "addPublishEventViaUI". +
 {empty} +
 **5) WillMessage** +
-Configure a WillMessage via "setWillMessageConfig" (via script) or "setWillMessageViaUI (via UI) to use the preset values of the "presetPublish"-functions and activate it via "setWillMessageActivation". +</desc>
+Configure a WillMessage via "setWillMessageConfig" (via script) or "setWillMessageViaUI (via UI) to use the preset values of the "presetPublish"-functions and activate it via "setWillMessageActivation". +
+Additionally you can set via 'setDisconnectWithWillMessage' if the WillMessage should be sent when disconnecting from MQTT broker normally. +</desc>
             <enum name="QOS" trait="released">
                 <desc>Quality of MQTT topic service level.</desc>
                 <item desc="Quality of Service level 0." name="QOS0">QOS0</item>
@@ -216,6 +217,10 @@ Configure a WillMessage via "setWillMessageConfig" (via script) or "setWillMessa
                     <desc>Notify path to CA bundle.</desc>
                     <param desc="Path" multiplicity="1" name="path" type="string"/>
                 </event>
+                <event name="OnNewStatusDisconnectWithWillMessage">
+                    <desc>Notify status if WillMessage should be send before disconnecting.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </event>
                 <function name="setParameterName">
                     <desc>Function to set the name of the parameters if saved/loaded via the CSK_PersistentData module.</desc>
                     <param desc="Name of the parameter" multiplicity="1" name="name" type="string"/>
@@ -414,10 +419,14 @@ Configure a WillMessage via "setWillMessageConfig" (via script) or "setWillMessa
                     <desc>Function to set path to CA bundle if it is activated.</desc>
                     <param desc="Path" multiplicity="1" name="path" type="string"/>
                 </function>
+                <function name="setDisconnectWithWillMessage">
+                    <desc>Function to set if WillMessage should be sent when disconnecting from MQTT broker normally.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </function>
             </serves>
         </crown>
         <meta key="author">SICK AG</meta>
-        <meta key="version">1.0.0</meta>
+        <meta key="version">1.1.0</meta>
         <meta key="priority">low</meta>
         <meta key="copy-protected">false</meta>
         <meta key="read-protected">false</meta>

CSK_Module_MQTTClient/scripts/Communication/MQTTClient/MQTTClient_Controller.lua

@@ -62,6 +62,7 @@ Script.serveEvent('CSK_MQTTClient.OnNewStatusSubscriptionList', 'MQTTClient_OnNe
 Script.serveEvent('CSK_MQTTClient.OnNewStatusPublishEventList', 'MQTTClient_OnNewStatusPublishEventList')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusWillMessageActive', 'MQTTClient_OnNewStatusWillMessageActive')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusWillMessageConfig', 'MQTTClient_OnNewStatusWillMessageConfig')
+Script.serveEvent('CSK_MQTTClient.OnNewStatusDisconnectWithWillMessage', 'MQTTClient_OnNewStatusDisconnectWithWillMessage')
 
 Script.serveEvent("CSK_MQTTClient.OnNewStatusLoadParameterOnReboot", "MQTTClient_OnNewStatusLoadParameterOnReboot")
 Script.serveEvent("CSK_MQTTClient.OnPersistentDataModuleAvailable", "MQTTClient_OnPersistentDataModuleAvailable")
@@ -178,6 +179,7 @@ local function handleOnExpiredTmrMQTTClient()
   Script.notifyEvent("MQTTClient_OnNewStatusPublishRetain", mqttClient_Model.tempPublishRetain)
 
   Script.notifyEvent("MQTTClient_OnNewStatusWillMessageActive", mqttClient_Model.parameters.useWillMessage)
+  Script.notifyEvent("MQTTClient_OnNewStatusDisconnectWithWillMessage", mqttClient_Model.parameters.disconnectWithWillMessage)
   Script.notifyEvent("MQTTClient_OnNewStatusWillMessageConfig", "Topic = '" .. mqttClient_Model.parameters.willMessageTopic ..
                                                                 "', Data = '" .. mqttClient_Model.parameters.willMessageData ..
                                                                 "', QoS = '" .. mqttClient_Model.parameters.willMessageQOS ..
@@ -255,6 +257,9 @@ local function connectMQTT(status)
       mqttClient_Model.addMessageLog("Connection failed")
     end
   else
+    if mqttClient_Model.parameters.disconnectWithWillMessage == true and mqttClient_Model.parameters.useWillMessage == true then
+      mqttClient_Model.publish(mqttClient_Model.parameters.willMessageTopic, mqttClient_Model.parameters.willMessageData, mqttClient_Model.parameters.willMessageQOS, mqttClient_Model.parameters.willMessageRetain)
+    end
     MQTTClient.disconnect(mqttClient_Model.mqttClient)
     mqttClient_Model.reconnectionTimer:stop()
   end
@@ -615,9 +620,16 @@ Script.serveFunction('CSK_MQTTClient.selectPublishEvent', selectPublishEvent)
 local function setWillMessageActivation(status)
   _G.logger:info(nameOfModule .. ": Set WillMessage activation to " .. tostring(status))
   mqttClient_Model.parameters.useWillMessage = status
+  Script.notifyEvent("MQTTClient_OnNewStatusWillMessageActive", status)
 end
 Script.serveFunction('CSK_MQTTClient.setWillMessageActivation', setWillMessageActivation)
 
+local function setDisconnectWithWillMessage(status)
+  _G.logger:info(nameOfModule .. ": Set DisconnectWithWillMessage to " .. tostring(status))
+  mqttClient_Model.parameters.disconnectWithWillMessage = status
+end
+Script.serveFunction('CSK_MQTTClient.setDisconnectWithWillMessage', setDisconnectWithWillMessage)
+
 local function setWillMessageConfig(topic, data, qos, retain)
   _G.logger:info(nameOfModule .. ": Set WillMessage config with data '" .. data .. "' to topic '" .. topic .. "' with QoS '" .. qos .. "' and '" .. retain .. "'")
   mqttClient_Model.parameters.willMessageTopic = topic

CSK_Module_MQTTClient/scripts/Communication/MQTTClient/MQTTClient_Model.lua

@@ -95,6 +95,7 @@ mqttClient_Model.parameters.caBundleActive = false -- Enables/disables to use ce
 mqttClient_Model.parameters.caBundlePath = 'public/CA.pem' -- Path to a certificate bundle in PEM format.
 
 mqttClient_Model.parameters.useWillMessage = false -- Enables/disables to use a will message
+mqttClient_Model.parameters.disconnectWithWillMessage = false -- Enables/disables sending a will message before intentionally disconnecting
 mqttClient_Model.parameters.willMessageTopic = '' -- Topic under which to publish the will message
 mqttClient_Model.parameters.willMessageData = '' -- The message payload to publish
 mqttClient_Model.parameters.willMessageQOS = 'QOS0' -- Quality of Service level

README.md

@@ -1,7 +1,7 @@
 # CSK_Module_MQTTClient
 
 Module to provide MQTT client functionality.  
-![](https://github.com/SICKAppSpaceCodingStarterKit/CSK_Module_MQTTClient/blob/main/docu/media/UI_Screenshot.png)
+![](./docu/media/UI_Screenshot.png)
 
 ## How to Run
 
@@ -20,13 +20,15 @@ Tested on:
 |--|--|--|
 |SIM1012|V2.4.1|v1.0.0|
 |SIM1012|V2.2.0|v0.4.1|
-|SICK AppEngine|V1.5.0|v1.0.0|
+|SIM2500|V1.6.0|v1.1.0|
+|Inspector 85x|V3.6.0|v1.1.0|
+|SICK AppEngine|V1.5.0|v1.0.0, v1.1.0|
 |SICK AppEngine|V1.3.2|v0.4.1|
 |TDC-E|L4M 2023.1|v0.4.1|
 
 This module is part of the SICK AppSpace Coding Starter Kit developing approach.  
-It is programmed in an object oriented way. Some of these modules use kind of "classes" in Lua to make it possible to reuse code / classes in other projects.  
-In general it is not neccessary to code this way, but the architecture of this app can serve as a sample to be used especially for bigger projects and to make it easier to share code.  
+It is programmed in an object-oriented way. Some of these modules use kind of "classes" in Lua to make it possible to reuse code / classes in other projects.  
+In general, it is not neccessary to code this way, but the architecture of this app can serve as a sample to be used especially for bigger projects and to make it easier to share code.  
 Please check the [documentation](https://github.com/SICKAppSpaceCodingStarterKit/.github/blob/main/docu/SICKAppSpaceCodingStarterKit_Documentation.md) of CSK for further information.  
 
 ## Topics