Release 2.1.0 (#5)

# Release 2.1.0

## New features
- Optionally send a BirthMessage if connected to MQTT broker
- Optionally set global prefix for all topics
- Optionally deactivate logging of communication to reduce CPU load
- Check if persistent data to load provides all relevant parameters. Otherwise add default values

## Improvements
- Check if client is connected to broker before trying to publish

## Bugfix
- Did not use topic prefix for WillMessage
- Did not update topic prefix / status if WillMessage is active within UI
- Legacy bindings of ValueDisplay elements within UI did not work if deployed with VS Code AppSpace SDK
- UI differs if deployed via Appstudio or VS Code AppSpace SDK
- Fullscreen icon of iFrame was visible

Author: golluroSICKAG

CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 2.1.0
+
+### New features
+- Optionally send a BirthMessage if connected to MQTT broker
+- Optionally set global prefix for all topics
+- Optionally deactivate logging of communication to reduce CPU load
+- Check if persistent data to load provides all relevant parameters. Otherwise add default values
+
+### Improvements
+- Check if client is connected to broker before trying to publish
+
+### Bugfix
+- Did not use topic prefix for WillMessage
+- Did not update topic prefix / status if WillMessage is active within UI
+- Legacy bindings of ValueDisplay elements within UI did not work if deployed with VS Code AppSpace SDK
+- UI differs if deployed via Appstudio or VS Code AppSpace SDK
+- Fullscreen icon of iFrame was visible
+
 ## Release 2.0.0
 
 ### New features

CSK_Module_MQTTClient/pages/pages/CSK_Module_MQTTClient/CSK_Module_MQTTClient.css

@@ -90,5 +90,5 @@
 
 .myCustomButton_CSK_Module_MQTTClient {
   border-radius: 30px;
-  padding-right: 0px;
+  padding: 11px;
 }

CSK_Module_MQTTClient/pages/pages/CSK_Module_MQTTClient/CSK_Module_MQTTClient.html

@@ -5,6 +5,14 @@ export function convertToList(value) {
 export function changeStyle(theme) {
   const style: HTMLStyleElement = document.createElement('style');
   style.id ='blub'
+
+  const toggleSW = document.querySelectorAll("davinci-toggle-switch")
+  toggleSW.forEach((userItem) => {
+    const shadowToggle = userItem.shadowRoot
+    const finalToggleSW = shadowToggle?.querySelector('div')
+    finalToggleSW?.classList.add('hasIcon')
+  });
+
   if (theme == 'CSK_Style'){
     var headerToolbar = `.sopasjs-ui-header-toolbar-wrapper { background-color: #FFFFFF; }`
     var uiHeader = `.sopasjs-ui-header>.app-logo { margin-right:0px; }`
@@ -31,6 +39,7 @@ export function changeStyle(theme) {
     style.innerHTML += toolbarButton;
 
     style.innerHTML += customBackground;
+
   }
   else if (theme == 'None'){
     var headerToolbar = `.sopasjs-ui-header-toolbar-wrapper { background-color: #007fc3; }`
@@ -45,7 +54,7 @@ export function changeStyle(theme) {
     var toolbarButton = `.sopasjs-ui-header-toolbar-button>a { color: #cce5f3; }`
 
     var customBackground =  `.CSK_Module_MQTTClient .myCustomBackground_CSK_Module_MQTTClient { background-color: #fff; }` // font-family: "sans-serif"; }`
-  
+
     style.innerHTML = headerToolbar;
     style.innerHTML += uiHeader;
     style.innerHTML += appLogo;
@@ -58,6 +67,7 @@ export function changeStyle(theme) {
     style.innerHTML += toolbarButton;
 
     style.innerHTML += customBackground;
+
   }
   document.head.append(style);
   return theme

CSK_Module_MQTTClient/pages/src/converter.ts

@@ -12,6 +12,10 @@ document.addEventListener('sopasjs-ready', () => {
   page_Setup.remove();
 
   setTimeout(() => {
+    const element = document.querySelector("div.sjs-wrapper > div > div.sjs-fullscreen-toggle")
+    if(element) {
+      element.parentElement.removeChild(element)
+    }
     document.title = 'CSK_Module_MQTTClient'
   }, 500);
 })

CSK_Module_MQTTClient/pages/src/index.ts

@@ -246,6 +246,22 @@ Additionally you can set via 'setDisconnectWithWillMessage' if the WillMessage s
                     <desc>Event notified with the connection status.</desc>
                     <param desc="Connection status message." multiplicity="1" name="status" type="string"/>
                 </event>
+                <event name="OnNewStatusTopicPrefix">
+                    <desc>Notify prefix to use for all topics.</desc>
+                    <param desc="Prefix for all topics." multiplicity="1" name="prefix" type="string"/>
+                </event>
+                <event name="OnNewStatusLogAllMessages">
+                    <desc>Notify if all messages regarding received / send data should be logged in UI.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </event>
+                <event name="OnNewStatusBirthMessageActive">
+                    <desc>Notify if BirthMessage is used.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </event>
+                <event name="OnNewStatusBirthMessageConfig">
+                    <desc>Notify BirthMessage config.</desc>
+                    <param desc="Config as text" multiplicity="1" name="config" type="string"/>
+                </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"/>
@@ -469,6 +485,21 @@ Additionally you can set via 'setDisconnectWithWillMessage' if the WillMessage s
                 <function name="resetModule">
                     <desc>Function to reset main configuration of module.</desc>
                 </function>
+                <function name="setTopicPrefix">
+                    <desc>Function to set prefix for all topics.</desc>
+                    <param desc="Prefix to use for all topics." multiplicity="1" name="prefix" type="string"/>
+                </function>
+                <function name="setLogAllMessages">
+                    <desc>Function to set if all messages regarding send/received data should be logged in UI.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </function>
+                <function name="setBirthMessageActivation">
+                    <desc>Function to set activation of BirthMessage.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </function>
+                <function name="setBirthMessageConfigViaUI">
+                    <desc>Function to set config of BirthMessage via UI with preset configuration (check "presetPublish..."-functions).</desc>
+                </function>
             </serves>
         </crown>
         <crown name="MQTTClient_FC">
@@ -528,7 +559,7 @@ Additionally you can set via 'setDisconnectWithWillMessage' if the WillMessage s
             </crown>
         </crown>
         <meta key="author">SICK AG</meta>
-        <meta key="version">2.0.0</meta>
+        <meta key="version">2.1.0</meta>
         <meta key="priority">low</meta>
         <meta key="copy-protected">false</meta>
         <meta key="read-protected">false</meta>

CSK_Module_MQTTClient/project.mf.xml

@@ -31,6 +31,8 @@ Script.serveEvent('CSK_MQTTClient.OnNewConnectionStatus', 'MQTTClient_OnNewConne
 Script.serveEvent('CSK_MQTTClient.OnNewStatusCurrentlyConnected', 'MQTTClient_OnNewStatusCurrentlyConnected')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusActivateConnection', 'MQTTClient_OnNewStatusActivateConnection')
 
+Script.serveEvent('CSK_MQTTClient.OnNewStatusLogAllMessages', 'MQTTClient_OnNewStatusLogAllMessages')
+
 Script.serveEvent('CSK_MQTTClient.OnNewMQTTPort', 'MQTTClient_OnNewMQTTPort')
 Script.serveEvent('CSK_MQTTClient.OnNewBrokerIP', 'MQTTClient_OnNewBrokerIP')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusForwardReceivedMsg', 'MQTTClient_OnNewStatusForwardReceivedMsg')
@@ -59,6 +61,8 @@ Script.serveEvent('CSK_MQTTClient.OnNewLog', 'MQTTClient_OnNewLog')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusSubscriptionTopic', 'MQTTClient_OnNewStatusSubscriptionTopic')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusSubscriptionQOS', 'MQTTClient_OnNewStatusSubscriptionQOS')
 
+Script.serveEvent('CSK_MQTTClient.OnNewStatusTopicPrefix', 'MQTTClient_OnNewStatusTopicPrefix')
+
 Script.serveEvent('CSK_MQTTClient.OnNewStatusPublishEventName', 'MQTTClient_OnNewStatusPublishEventName')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusPublishTopic', 'MQTTClient_OnNewStatusPublishTopic')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusPublishData', 'MQTTClient_OnNewStatusPublishData')
@@ -71,6 +75,9 @@ Script.serveEvent('CSK_MQTTClient.OnNewStatusWillMessageActive', 'MQTTClient_OnN
 Script.serveEvent('CSK_MQTTClient.OnNewStatusWillMessageConfig', 'MQTTClient_OnNewStatusWillMessageConfig')
 Script.serveEvent('CSK_MQTTClient.OnNewStatusDisconnectWithWillMessage', 'MQTTClient_OnNewStatusDisconnectWithWillMessage')
 
+Script.serveEvent('CSK_MQTTClient.OnNewStatusBirthMessageActive', 'MQTTClient_OnNewStatusBirthMessageActive')
+Script.serveEvent('CSK_MQTTClient.OnNewStatusBirthMessageConfig', 'MQTTClient_OnNewStatusBirthMessageConfig')
+
 Script.serveEvent('CSK_MQTTClient.OnNewStatusFlowConfigPriority', 'MQTTClient_OnNewStatusFlowConfigPriority')
 Script.serveEvent("CSK_MQTTClient.OnNewStatusLoadParameterOnReboot", "MQTTClient_OnNewStatusLoadParameterOnReboot")
 Script.serveEvent("CSK_MQTTClient.OnPersistentDataModuleAvailable", "MQTTClient_OnPersistentDataModuleAvailable")
@@ -152,6 +159,8 @@ local function handleOnExpiredTmrMQTTClient()
   Script.notifyEvent("MQTTClient_OnNewStatusCSKStyle", mqttClient_Model.styleForUI)
   Script.notifyEvent("MQTTClient_OnNewStatusModuleIsActive", _G.availableAPIs.default and _G.availableAPIs.specific)
 
+  Script.notifyEvent("MQTTClient_OnNewStatusLogAllMessages", mqttClient_Model.parameters.logAllMessages)
+
   Script.notifyEvent("MQTTClient_OnNewStatusCurrentlyConnected", mqttClient_Model.isConnected)
   Script.notifyEvent("MQTTClient_OnNewStatusActivateConnection", mqttClient_Model.parameters.connect)
 
@@ -181,6 +190,8 @@ local function handleOnExpiredTmrMQTTClient()
 
   Script.notifyEvent("MQTTClient_OnNewStatusSubscriptionTopic", mqttClient_Model.tempSubscriptionTopic)
   Script.notifyEvent("MQTTClient_OnNewStatusSubscriptionQOS", mqttClient_Model.tempSubscriptionQOS)
+  Script.notifyEvent("MQTTClient_OnNewStatusTopicPrefix", mqttClient_Model.parameters.topicPrefix)
+
   Script.notifyEvent("MQTTClient_OnNewStatusSubscriptionList", mqttClient_Model.helperFuncs.createJsonListSubscriptions(mqttClient_Model.parameters.subscriptions))
   Script.notifyEvent("MQTTClient_OnNewStatusPublishEventList", mqttClient_Model.helperFuncs.createJsonListPublishEvents(mqttClient_Model.parameters.publishEvents))
 
@@ -195,10 +206,16 @@ local function handleOnExpiredTmrMQTTClient()
   Script.notifyEvent("MQTTClient_OnNewStatusWillMessageConfig", "Topic = '" .. mqttClient_Model.parameters.willMessageTopic ..
                                                                 "', Data = '" .. mqttClient_Model.parameters.willMessageData ..
                                                                 "', QoS = '" .. mqttClient_Model.parameters.willMessageQOS ..
-                                                                "', Retain = '" .. mqttClient_Model.parameters.willMessageRetain)
+                                                                "', Retain = '" .. mqttClient_Model.parameters.willMessageRetain .. "'")
 
   mqttClient_Model.sendLog()
 
+  Script.notifyEvent("MQTTClient_OnNewStatusBirthMessageActive", mqttClient_Model.parameters.useBirthMessage)
+  Script.notifyEvent("MQTTClient_OnNewStatusBirthMessageConfig", "Topic = '" .. mqttClient_Model.parameters.birthMessageTopic ..
+                                                                "', Data = '" .. mqttClient_Model.parameters.birthMessageData ..
+                                                                "', QoS = '" .. mqttClient_Model.parameters.birthMessageQOS ..
+                                                                "', Retain = '" .. mqttClient_Model.parameters.birthMessageRetain .. "'")
+
   Script.notifyEvent("MQTTClient_OnNewStatusFlowConfigPriority", mqttClient_Model.parameters.flowConfigPriority)
   Script.notifyEvent("MQTTClient_OnNewStatusLoadParameterOnReboot", mqttClient_Model.parameterLoadOnReboot)
   Script.notifyEvent("MQTTClient_OnPersistentDataModuleAvailable", mqttClient_Model.persistentModuleAvailable)
@@ -220,6 +237,12 @@ local function getMQTTHandle()
 end
 Script.serveFunction('CSK_MQTTClient.getMQTTHandle', getMQTTHandle)
 
+local function setLogAllMessages(status)
+  _G.logger:fine(nameOfModule .. ": Set status to log all MQTT messages to " .. tostring(status))
+  mqttClient_Model.parameters.logAllMessages = status
+end
+Script.serveFunction('CSK_MQTTClient.setLogAllMessages', setLogAllMessages)
+
 local function connectMQTT(status)
   _G.logger:fine(nameOfModule .. ": Set connection status to " .. tostring(status))
 
@@ -515,6 +538,13 @@ Script.serveFunction('CSK_MQTTClient.unsubscribeViaUI', unsubscribeViaUI)
 ------------------ Publish ------------------
 ---------------------------------------------
 
+local function setTopicPrefix(prefix)
+  _G.logger:info(nameOfModule .. ": Set topic prefix to " .. tostring(prefix))
+  mqttClient_Model.parameters.topicPrefix = prefix
+  Script.notifyEvent("MQTTClient_OnNewStatusTopicPrefix", mqttClient_Model.parameters.topicPrefix)
+end
+Script.serveFunction('CSK_MQTTClient.setTopicPrefix', setTopicPrefix)
+
 local function presetPublishTopic(topic)
   mqttClient_Model.tempPublishTopic = topic
 end
@@ -633,9 +663,18 @@ Script.serveFunction('CSK_MQTTClient.selectPublishEvent', selectPublishEvent)
 local function setWillMessageActivation(status)
   _G.logger:fine(nameOfModule .. ": Set WillMessage activation to " .. tostring(status))
   mqttClient_Model.parameters.useWillMessage = status
+  Script.notifyEvent("MQTTClient_OnNewStatusWillMessageActive", mqttClient_Model.parameters.useWillMessage)
 end
 Script.serveFunction('CSK_MQTTClient.setWillMessageActivation', setWillMessageActivation)
 
+local function setBirthMessageActivation(status)
+  _G.logger:fine(nameOfModule .. ": Set BirthMessage activation to " .. tostring(status))
+  mqttClient_Model.parameters.useBirthMessage = status
+  Script.notifyEvent("MQTTClient_OnNewStatusBirthMessageActive",mqttClient_Model.parameters.useBirthMessage)
+end
+
+Script.serveFunction('CSK_MQTTClient.setBirthMessageActivation', setBirthMessageActivation)
+
 local function setDisconnectWithWillMessage(status)
   _G.logger:info(nameOfModule .. ": Set DisconnectWithWillMessage to " .. tostring(status))
   mqttClient_Model.parameters.disconnectWithWillMessage = status
@@ -644,15 +683,15 @@ Script.serveFunction('CSK_MQTTClient.setDisconnectWithWillMessage', setDisconnec
 
 local function setWillMessageConfig(topic, data, qos, retain)
   _G.logger:fine(nameOfModule .. ": Set WillMessage config with data '" .. data .. "' to topic '" .. topic .. "' with QoS '" .. qos .. "' and '" .. retain .. "'")
-  mqttClient_Model.parameters.willMessageTopic = topic
+  mqttClient_Model.parameters.willMessageTopic = mqttClient_Model.parameters.topicPrefix .. topic
   mqttClient_Model.parameters.willMessageData = data
   mqttClient_Model.parameters.willMessageQOS = qos
   mqttClient_Model.parameters.willMessageRetain = retain
 
   Script.notifyEvent("MQTTClient_OnNewStatusWillMessageConfig", "Topic = '" .. mqttClient_Model.parameters.willMessageTopic ..
                                                              "', Data = '" .. mqttClient_Model.parameters.willMessageData ..
                                                              "', QoS = '" .. mqttClient_Model.parameters.willMessageQOS ..
-                                                             "', Retain = '" .. mqttClient_Model.parameters.willMessageRetain)
+                                                             "', Retain = '" .. mqttClient_Model.parameters.willMessageRetain .. "'")
 
 end
 Script.serveFunction('CSK_MQTTClient.setWillMessageConfig', setWillMessageConfig)
@@ -662,6 +701,26 @@ local function setWillMessageConfigViaUI()
 end
 Script.serveFunction('CSK_MQTTClient.setWillMessageConfigViaUI', setWillMessageConfigViaUI)
 
+local function setBirthMessageConfig(topic, data, qos, retain)
+  _G.logger:fine(nameOfModule .. ": Set BirthMessage config with data '" .. data .. "' to topic '" .. topic .. "' with QoS '" .. qos .. "' and '" .. retain .. "'")
+  mqttClient_Model.parameters.birthMessageTopic = topic
+  mqttClient_Model.parameters.birthMessageData = data
+  mqttClient_Model.parameters.birthMessageQOS = qos
+  mqttClient_Model.parameters.birthMessageRetain = retain
+
+  Script.notifyEvent("MQTTClient_OnNewStatusBirthMessageConfig", "Topic = '" .. mqttClient_Model.parameters.birthMessageTopic ..
+                                                             "', Data = '" .. mqttClient_Model.parameters.birthMessageData ..
+                                                             "', QoS = '" .. mqttClient_Model.parameters.birthMessageQOS ..
+                                                             "', Retain = '" .. mqttClient_Model.parameters.birthMessageRetain .. "'")
+
+end
+Script.serveFunction('CSK_MQTTClient.setBirthMessageConfig', setBirthMessageConfig)
+
+local function setBirthMessageConfigViaUI()
+  setBirthMessageConfig(mqttClient_Model.tempPublishTopic, mqttClient_Model.tempPublishData, mqttClient_Model.tempPublishQOS, mqttClient_Model.tempPublishRetain)
+end
+Script.serveFunction('CSK_MQTTClient.setBirthMessageConfigViaUI', setBirthMessageConfigViaUI)
+
 local function getStatusModuleActive()
   return _G.availableAPIs.default and _G.availableAPIs.specific
 end
@@ -718,6 +777,8 @@ local function loadParameters()
       mqttClient_Model.parameters = mqttClient_Model.helperFuncs.convertContainer2Table(data)
       mqttClient_Model.publishEventsFunctions = {}
 
+      mqttClient_Model.parameters = mqttClient_Model.helperFuncs.checkParameters(mqttClient_Model.parameters, mqttClient_Model.helperFuncs.defaultParameters.getParameters())
+
       -- Configured/activated with new loaded data
       for key in pairs(mqttClient_Model.parameters.publishEvents.topic) do
         createInternalPublishFunctions(key)