Release 2.1.0 (#4)

golluroSICKAG · web-flow · commit b18a24e1f92c · 2025-07-28T09:47:10.000+02:00
# Release 2.1.0

## New features
- Check if persistent data to load provides all relevant parameters. Otherwise add default values

## Improvements
- Better instance handling regarding FlowConfig

## Bugfix
- 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
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 2.1.0
+
+### New features
+- Check if persistent data to load provides all relevant parameters. Otherwise add default values
+
+### Improvements
+- Better instance handling regarding FlowConfig
+
+### Bugfix
+- 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
diff --git a/CSK_Module_MultiTCPIPServer/pages/pages/CSK_Module_MultiTCPIPServer/CSK_Module_MultiTCPIPServer.css b/CSK_Module_MultiTCPIPServer/pages/pages/CSK_Module_MultiTCPIPServer/CSK_Module_MultiTCPIPServer.css
@@ -116,5 +116,5 @@
 
 .myCustomButton_CSK_Module_MultiTCPIPServer {
   border-radius: 30px;
-  padding-right: 0px;
+  padding: 11px;
 }
diff --git a/CSK_Module_MultiTCPIPServer/pages/pages/CSK_Module_MultiTCPIPServer/CSK_Module_MultiTCPIPServer.html b/CSK_Module_MultiTCPIPServer/pages/pages/CSK_Module_MultiTCPIPServer/CSK_Module_MultiTCPIPServer.html
diff --git a/CSK_Module_MultiTCPIPServer/pages/src/converter.ts b/CSK_Module_MultiTCPIPServer/pages/src/converter.ts
@@ -18,6 +18,14 @@ export function str2num(newstr){
 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; }`
diff --git a/CSK_Module_MultiTCPIPServer/pages/src/index.ts b/CSK_Module_MultiTCPIPServer/pages/src/index.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_MultiTCPIPServer'
   }, 500);
 })
diff --git a/CSK_Module_MultiTCPIPServer/project.mf.xml b/CSK_Module_MultiTCPIPServer/project.mf.xml
@@ -645,7 +645,7 @@ Needs then to be called via "Script.callFunction".</desc>
             </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>
diff --git a/CSK_Module_MultiTCPIPServer/scripts/CSK_Module_MultiTCPIPServer.lua b/CSK_Module_MultiTCPIPServer/scripts/CSK_Module_MultiTCPIPServer.lua
@@ -51,10 +51,9 @@ local multiTCPIPServer_Instances = {} -- Handle all instances
 local multiTCPIPServerController = require('Communication/MultiTCPIPServer/MultiTCPIPServer_Controller')
 
 if _G.availableAPIs.default and _G.availableAPIs.specific then
-  local setInstanceHandle = require('Communication/MultiTCPIPServer/FlowConfig/MultiTCPIPServer_FlowConfig')
+  require('Communication/MultiTCPIPServer/FlowConfig/MultiTCPIPServer_FlowConfig')
   table.insert(multiTCPIPServer_Instances, multiTCPIPServer_Model.create(1)) -- Create at least 1 instance
   multiTCPIPServerController.setMultiTCPIPServer_Instances_Handle(multiTCPIPServer_Instances) -- share handle of instances
-  setInstanceHandle(multiTCPIPServer_Instances)
 else
   _G.logger:warning("CSK_MultiTCPIPServer: Relevant CROWN(s) not available on device. Module is not supported...")
 end
diff --git a/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/FlowConfig/MultiTCPIPServer_FlowConfig.lua b/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/FlowConfig/MultiTCPIPServer_FlowConfig.lua
@@ -12,20 +12,7 @@ local multiTCPIPServer_Instances
 --- Function to react if FlowConfig was updated
 local function handleOnClearOldFlow()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
-    for i = 1, #multiTCPIPServer_Instances do
-      if multiTCPIPServer_Instances[i].parameters.flowConfigPriority then
-        CSK_MultiTCPIPServer.clearFlowConfigRelevantConfiguration()
-        break
-      end
-    end
+    CSK_MultiTCPIPServer.clearFlowConfigRelevantConfiguration()
   end
 end
 Script.register('CSK_FlowConfig.OnClearOldFlow', handleOnClearOldFlow)
-
---- Function to get access to the multiTCPIPServer_Instances
----@param handle handle Handle of multiTCPIPServer_Instances object
-local function setMultiTCPIPServer_Instances_Handle(handle)
-  multiTCPIPServer_Instances = handle
-end
-
-return setMultiTCPIPServer_Instances_Handle
diff --git a/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/FlowConfig/MultiTCPIPServer_Transmit.lua b/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/FlowConfig/MultiTCPIPServer_Transmit.lua
@@ -65,7 +65,7 @@ local function create(instance, broadcast)
     local handle = Container.create()
     instanceTable[fullInstanceName] = fullInstanceName
     Container.add(handle, 'Instance', instance)
-    Container.add(handle, 'Broadcast', broadcast)
+    Container.add(handle, 'Broadcast', broadcast or '')
     return handle
   end
 end
diff --git a/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/MultiTCPIPServer_Controller.lua b/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/MultiTCPIPServer_Controller.lua
@@ -905,9 +905,11 @@ Script.serveFunction('CSK_MultiTCPIPServer.getStatusModuleActive', getStatusModu
 
 local function clearFlowConfigRelevantConfiguration()
   for i = 1, #multiTCPIPServer_Instances do
-    Script.notifyEvent('MultiTCPIPServer_OnNewProcessingParameter', selectedInstance, 'clearAll')
-    multiTCPIPServer_Instances[selectedInstance].parameters.clientBroadcasts.forwardEvents = {}
-    multiTCPIPServer_Instances[selectedInstance].parameters.forwardEvents = {}
+    if multiTCPIPServer_Instances[i].parameters.flowConfigPriority then
+      Script.notifyEvent('MultiTCPIPServer_OnNewProcessingParameter', selectedInstance, 'clearAll')
+      multiTCPIPServer_Instances[selectedInstance].parameters.clientBroadcasts.forwardEvents = {}
+      multiTCPIPServer_Instances[selectedInstance].parameters.forwardEvents = {}
+    end
   end
 end
 Script.serveFunction('CSK_MultiTCPIPServer.clearFlowConfigRelevantConfiguration', clearFlowConfigRelevantConfiguration)
@@ -976,6 +978,8 @@ local function loadParameters()
       _G.logger:info(nameOfModule .. ": Loaded parameters for multiTCPIPServerObject " .. tostring(selectedInstance) .. " from CSK_PersistentData module.")
       multiTCPIPServer_Instances[selectedInstance].parameters = helperFuncs.convertContainer2Table(data)
 
+      multiTCPIPServer_Instances[selectedInstance].parameters = helperFuncs.checkParameters(multiTCPIPServer_Instances[selectedInstance].parameters, helperFuncs.defaultParameters.getParameters())
+
       -- If something needs to be configured/activated with new loaded data
       updateProcessingParameters()
 
@@ -1070,8 +1074,10 @@ Script.register("CSK_PersistentData.OnInitialDataLoaded", handleOnInitialDataLoa
 
 local function resetModule()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
-    clearFlowConfigRelevantConfiguration()
     for i = 1, #multiTCPIPServer_Instances do
+      Script.notifyEvent('MultiTCPIPServer_OnNewProcessingParameter', selectedInstance, 'clearAll')
+      multiTCPIPServer_Instances[selectedInstance].parameters.clientBroadcasts.forwardEvents = {}
+      multiTCPIPServer_Instances[selectedInstance].parameters.forwardEvents = {}
       setListenState(false)
     end
     pageCalled()
diff --git a/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/MultiTCPIPServer_Model.lua b/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/MultiTCPIPServer_Model.lua
@@ -62,9 +62,9 @@ function multiTCPIPServer.create(multiTCPIPServerInstanceNo)
 
   -- Parameters to be saved permanently if wanted
   self.parameters = {}
-  self.parameters.flowConfigPriority = CSK_FlowConfig ~= nil or false -- Status if FlowConfig should have priority for FlowConfig relevant configurations
-  self.parameters.listenState = false -- Status if server should be active to listen for clients
-  self.parameters.processingFile = 'CSK_MultiTCPIPServer_Processing' -- which file to use for processing (will be started in own thread)
+  self.parameters = self.helperFuncs.defaultParameters.getParameters() -- Load default parameters
+
+  -- Instance specific parameters
   self.currentDevice = Engine.getTypeName() -- device type running the app
   if self.currentDevice == 'Webdisplay' then
     self.parameters.interface = 'ETH1' -- ethernet interface to listen to
@@ -74,22 +74,8 @@ function multiTCPIPServer.create(multiTCPIPServerInstanceNo)
     local interfaceList = Ethernet.Interface.getInterfaces()
     self.parameters.interface = interfaceList[1]
   end
-  self.parameters.port = 1234 -- port number to listen to
-  self.parameters.RxFrameMode = 'Empty' -- type of framing for received data
-  self.parameters.TxFrameMode = 'Empty' -- type of framing for transmitted data
-  self.parameters.framing = {'','','',''} -- array with start/end framing of received and transmitted data
-  self.parameters.framingBufferSize = {10240, 10240} -- array with size of the internal framing parser buffer for received and transmitted data in bytes
-  self.parameters.maxConnections = 10 -- limit of connections
-  self.parameters.transmitAckTimeout = 15000 -- data transmittion acknowledgement timeout in millliseconds
-  self.parameters.transmitBufferSize = 0 --  size of the socket’s send buffer
-  self.parameters.transmitTimeout = 15000 -- timeout for transmits, in milliseconds
-  self.parameters.forwardEvents = {} -- List of events to register to and forward content to TCP/IP server
-  self.parameters.clientWhitelists = {} -- info about configured client whitelists
-  self.parameters.clientBroadcasts = {} -- info about configured client broadcasts
-  self.parameters.clientBroadcasts.names = {} -- Names of configured client broadcasts
-  self.parameters.clientBroadcasts.forwardEvents = {} -- List of events to register to and forward content to TCP/IP server limited to client broadcast
-  self.parameters.onReceivedDataEventName = 'CSK_MultiTCPIPServer.OnReceivedData' .. self.multiTCPIPServerInstanceNoString -- event name to register to get any received data
-  self.parameters.sendDataFunctionName = 'CSK_MultiTCPIPServer.sendData' .. self.multiTCPIPServerInstanceNoString -- function name to call to send data to all clients
+  self.parameters.onReceivedDataEventName = 'CSK_MultiTCPIPServer.OnReceivedData' .. self.multiTCPIPServerInstanceNoString
+  self.parameters.sendDataFunctionName = 'CSK_MultiTCPIPServer.sendData' .. self.multiTCPIPServerInstanceNoString
 
   -- Parameters to give to the processing script
   self.multiTCPIPServerProcessingParams = Container.create()
diff --git a/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/MultiTCPIPServer_Parameters.lua b/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/MultiTCPIPServer_Parameters.lua
@@ -0,0 +1,40 @@
+---@diagnostic disable: redundant-parameter, undefined-global
+
+--***************************************************************
+-- Inside of this script, you will find the relevant parameters
+-- for this module and its default values
+--***************************************************************
+
+local functions = {}
+
+local function getParameters()
+
+  local multiTCPIPServerParameters = {}
+  multiTCPIPServerParameters.flowConfigPriority = CSK_FlowConfig ~= nil or false -- Status if FlowConfig should have priority for FlowConfig relevant configurations
+  multiTCPIPServerParameters.listenState = false -- Status if server should be active to listen for clients
+  multiTCPIPServerParameters.processingFile = 'CSK_MultiTCPIPServer_Processing' -- which file to use for processing (will be started in own thread)
+
+  multiTCPIPServerParameters.interface = '' -- Interface to use (must be set individually)
+
+  multiTCPIPServerParameters.port = 1234 -- port number to listen to
+  multiTCPIPServerParameters.RxFrameMode = 'Empty' -- type of framing for received data
+  multiTCPIPServerParameters.TxFrameMode = 'Empty' -- type of framing for transmitted data
+  multiTCPIPServerParameters.framing = {'','','',''} -- array with start/end framing of received and transmitted data
+  multiTCPIPServerParameters.framingBufferSize = {10240, 10240} -- array with size of the internal framing parser buffer for received and transmitted data in bytes
+  multiTCPIPServerParameters.maxConnections = 10 -- limit of connections
+  multiTCPIPServerParameters.transmitAckTimeout = 15000 -- data transmittion acknowledgement timeout in millliseconds
+  multiTCPIPServerParameters.transmitBufferSize = 0 --  size of the socket’s send buffer
+  multiTCPIPServerParameters.transmitTimeout = 15000 -- timeout for transmits, in milliseconds
+  multiTCPIPServerParameters.forwardEvents = {} -- List of events to register to and forward content to TCP/IP server
+  multiTCPIPServerParameters.clientWhitelists = {} -- info about configured client whitelists
+  multiTCPIPServerParameters.clientBroadcasts = {} -- info about configured client broadcasts
+  multiTCPIPServerParameters.clientBroadcasts.names = {} -- Names of configured client broadcasts
+  multiTCPIPServerParameters.clientBroadcasts.forwardEvents = {} -- List of events to register to and forward content to TCP/IP server limited to client broadcast
+  multiTCPIPServerParameters.onReceivedDataEventName = 'CSK_MultiTCPIPServer.OnReceivedDataNUM' -- event name to register to get any received data (must be set individually)
+  multiTCPIPServerParameters.sendDataFunctionName = 'CSK_MultiTCPIPServer.sendDataNUM' -- function name to call to send data to all clients (must be set individually)
+
+  return multiTCPIPServerParameters
+end
+functions.getParameters = getParameters
+
+return functions
diff --git a/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/helper/funcs.lua b/CSK_Module_MultiTCPIPServer/scripts/Communication/MultiTCPIPServer/helper/funcs.lua
@@ -7,9 +7,13 @@
 --**********************Start Global Scope *********************************
 --**************************************************************************
 
+local nameOfModule = 'CSK_MultiTCPIPServer'
+
 local funcs = {}
 -- Providing standard JSON functions
 funcs.json = require('Communication/MultiTCPIPServer/helper/Json')
+-- Default parameters for instances of module
+funcs.defaultParameters = require('Communication/MultiTCPIPServer/MultiTCPIPServer_Parameters')
 
 --**************************************************************************
 --********************** End Global Scope **********************************
@@ -246,6 +250,27 @@ local function createSpecificJsonList(list, content)
 end
 funcs.createSpecificJsonList = createSpecificJsonList
 
+--- Function to compare table content. Optionally will fill missing values within content table with values of defaultTable
+---@param content auto Data to check
+---@param defaultTable auto Reference data
+---@return auto[] content Update of data
+local function checkParameters(content, defaultTable)
+  for key, value in pairs(defaultTable) do
+    if type(value) == 'table' then
+      if content[key] == nil then
+        _G.logger:info(nameOfModule .. ": Created missing parameters table '" .. tostring(key) .. "'")
+        content[key] = {}
+      end
+      content[key] = checkParameters(content[key], defaultTable[key])
+    elseif content[key] == nil then
+      _G.logger:info(nameOfModule .. ": Missing parameter '" .. tostring(key) .. "'. Adding default value '" .. tostring(defaultTable[key]) .. "'")
+      content[key] = defaultTable[key]
+    end
+  end
+  return content
+end
+funcs.checkParameters = checkParameters
+
 return funcs
 
 --**************************************************************************
diff --git a/README.md b/README.md
@@ -56,6 +56,7 @@ Tested on
 
 |Device|Firmware version|Module version|
 |--|--|--|
+|SICK AppEngine|V1.7.0|v2.1.0|
 |SIM1012|V2.4.2|v2.0.0|
 |SIM1012|V2.4.1|v1.0.0|
 |SIM1012|V2.3.0|v1.0.0|
diff --git a/docu/CSK_Module_MultiTCPIPServer.html b/docu/CSK_Module_MultiTCPIPServer.html
@@ -6,7 +6,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.12">
 <meta name="author" content="SICK AG">
-<title>Documentation - CSK_Module_MultiTCPIPServer 2.0.0</title>
+<title>Documentation - CSK_Module_MultiTCPIPServer 2.1.0</title>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
 <style>
 /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
@@ -615,10 +615,10 @@
 </head>
 <body class="article toc2 toc-left">
 <div id="header">
-<h1>Documentation - CSK_Module_MultiTCPIPServer 2.0.0</h1>
+<h1>Documentation - CSK_Module_MultiTCPIPServer 2.1.0</h1>
 <div class="details">
 <span id="author" class="author">SICK AG</span><br>
-<span id="revnumber">version 2.0.0,</span>
+<span id="revnumber">version 2.1.0,</span>
 <span id="revdate">2024-08-14</span>
 </div>
 <div id="toc" class="toc2">
@@ -830,7 +830,7 @@ <h2 id="_document_metadata">Document metadata</h2>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Version</p></th>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2.0.0</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">2.1.0</p></td>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Date</p></th>
@@ -7323,7 +7323,7 @@ <h3 id="API:Enum:CSK_MultiTCPIPServer.FramingType"><span class="api-enum">CSK_Mu
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 2.0.0<br>
+Version 2.1.0<br>
 Last updated 2024-08-14 16:33:24 +0200
 </div>
 </div>

Original file line number	Diff line number	Diff line change
`@@ -116,5 +116,5 @@`
`116`	`116`
`117`	`117`	`.myCustomButton_CSK_Module_MultiTCPIPServer {`
`118`	`118`	`border-radius: 30px;`
`119`		`- padding-right: 0px;`
	`119`	`+ padding: 11px;`
`120`	`120`	`}`