Release 5.1.0 (#3)

golluroSICKAG · web-flow · commit 62cfff1a522b · 2025-07-28T09:40:33.000+02:00
# Release 5.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 and FileUpload feature 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 5.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 and FileUpload feature 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 5.0.0
 
 ### New features
@@ -17,7 +30,7 @@ All notable changes to this project will be documented in this file.
 - 'loadParameters' returns its success
 - 'sendParameters' can control if sent data should be saved directly by CSK_Module_PersistentData
 - Changed log level of some messages from 'info' to 'fine'
-- Sample images converted to JPG
+- Sample images moved to CSK_Module_ImagePlayer app
 - Added UI icon and browser tab information
 
 ### Bugfix
diff --git a/CSK_Module_MultiDeepLearning/pages/pages/CSK_Module_MultiDeepLearning/CSK_Module_MultiDeepLearning.css b/CSK_Module_MultiDeepLearning/pages/pages/CSK_Module_MultiDeepLearning/CSK_Module_MultiDeepLearning.css
@@ -1,6 +1,7 @@
-.myViewer_CSK_Module_MultiDeepLearning > div > div {
-  max-height: 600px;
-  min-height: 600px;
+.myViewer_CSK_Module_MultiDeepLearning {
+  width: 98%;
+  height: 600px;
+  margin: auto;
 }
 
 .myCustomSpacerVert10_CSK_Module_MultiDeepLearning {
@@ -113,5 +114,5 @@
 
 .myCustomButton_CSK_Module_MultiDeepLearning {
   border-radius: 30px;
-  padding-right: 0px;
+  padding: 11px;
 }
diff --git a/CSK_Module_MultiDeepLearning/pages/pages/CSK_Module_MultiDeepLearning/CSK_Module_MultiDeepLearning.html b/CSK_Module_MultiDeepLearning/pages/pages/CSK_Module_MultiDeepLearning/CSK_Module_MultiDeepLearning.html
diff --git a/CSK_Module_MultiDeepLearning/pages/src/converter.ts b/CSK_Module_MultiDeepLearning/pages/src/converter.ts
@@ -12,6 +12,14 @@ export function changeID(id) {
 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_MultiDeepLearning/pages/src/index.ts b/CSK_Module_MultiDeepLearning/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_MultiDeepLearning'
   }, 500);
 })
diff --git a/CSK_Module_MultiDeepLearning/project.mf.xml b/CSK_Module_MultiDeepLearning/project.mf.xml
@@ -362,7 +362,7 @@ IMPORTANT: As instances start their own threads, the module needs to be restarte
             </crown>
         </crown>
         <meta key="author">SICK AG</meta>
-        <meta key="version">5.0.0</meta>
+        <meta key="version">5.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_MultiDeepLearning/scripts/CSK_Module_MultiDeepLearning.lua b/CSK_Module_MultiDeepLearning/scripts/CSK_Module_MultiDeepLearning.lua
@@ -52,10 +52,9 @@ local multiDeepLearning_Instances = {} -- Handle all instances
 local multiDeepLearningController = require('ImageProcessing/MultiDeepLearning/MultiDeepLearning_Controller')
 
 if _G.availableAPIs.default and _G.availableAPIs.specific then
-  local setInstanceHandle = require('ImageProcessing/MultiDeepLearning/FlowConfig/MultiDeepLearning_FlowConfig')
+  require('ImageProcessing/MultiDeepLearning/FlowConfig/MultiDeepLearning_FlowConfig')
   table.insert(multiDeepLearning_Instances, multiDeepLearning_Model.create(1)) -- create(deepLearningInstanceNo:int)
   multiDeepLearningController.setMultiDeepLearning_Instances_Handle(multiDeepLearning_Instances) -- share handle of instances
-  setInstanceHandle(multiDeepLearning_Instances)
 else
   _G.logger:warning("CSK_MultiDeepLearning: Relevant CROWN(s) not available on device. Module is not supported...")
 end
@@ -83,7 +82,7 @@ local function startProcessing()
   -- Option A --> prepare an event to trigger processing via this one
   -- Following event is already served inside of the Controler script
   -- --Script.serveEvent("CSK_MultiDeepLearning.TestImage", "TestImage") --> Create event to listen to receive a image to process
-  --CSK_MultiDeepLearning.setRegisterEvent('CSK_MultiDeepLearning.TestImage') --> Register processing to the event
+  --CSK_MultiDeepLearning.setRegisterEvent('CSK_ImagePlayer.OnNewImage') --> Register processing to the event
 
   for i = 1, 2 do
     local imgOK = Image.load('resources/CSK_Module_MultiDeepLearningSampleData/OK_' .. tostring(i) .. '.bmp')
diff --git a/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/FlowConfig/MultiDeepLearning_FlowConfig.lua b/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/FlowConfig/MultiDeepLearning_FlowConfig.lua
@@ -7,26 +7,10 @@ require('ImageProcessing.MultiDeepLearning.FlowConfig.MultiDeepLearning_ImageSou
 require('ImageProcessing.MultiDeepLearning.FlowConfig.MultiDeepLearning_OnNewResult')
 require('ImageProcessing.MultiDeepLearning.FlowConfig.MultiDeepLearning_Process')
 
--- Reference to the multiImageFilter_Instances handle
-local multiDeepLearning_Instances
-
 --- Function to react if FlowConfig was updated
 local function handleOnClearOldFlow()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
-    for i = 1, #multiDeepLearning_Instances do
-      if multiDeepLearning_Instances[i].parameters.flowConfigPriority then
-        CSK_MultiDeepLearning.clearFlowConfigRelevantConfiguration()
-        break
-      end
-    end
+    CSK_MultiDeepLearning.clearFlowConfigRelevantConfiguration()
   end
 end
 Script.register('CSK_FlowConfig.OnClearOldFlow', handleOnClearOldFlow)
-
---- Function to get access to the multiDeepLearning_Instances
----@param handle handle Handle of multiDeepLearning_Instances object
-local function setMultiDeepLearning_Instances_Handle(handle)
-  multiDeepLearning_Instances = handle
-end
-
-return setMultiDeepLearning_Instances_Handle
diff --git a/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/MultiDeepLearning_Controller.lua b/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/MultiDeepLearning_Controller.lua
@@ -375,9 +375,11 @@ Script.serveFunction('CSK_MultiDeepLearning.getStatusModuleActive', getStatusMod
 
 local function clearFlowConfigRelevantConfiguration()
   for i = 1, #multiDeepLearning_Instances do
-    multiDeepLearning_Instances[i].parameters.registeredEvent = ''
-    Script.notifyEvent('MultiDeepLearning_OnNewImageProcessingParameter', i, 'deregisterFromEvent', '')
-    Script.notifyEvent('MultiDeepLearning_OnNewStatusRegisteredEvent', '')
+    if multiDeepLearning_Instances[i].parameters.flowConfigPriority then
+      multiDeepLearning_Instances[i].parameters.registeredEvent = ''
+      Script.notifyEvent('MultiDeepLearning_OnNewImageProcessingParameter', i, 'deregisterFromEvent', '')
+      Script.notifyEvent('MultiDeepLearning_OnNewStatusRegisteredEvent', '')
+    end
   end
 end
 Script.serveFunction('CSK_MultiDeepLearning.clearFlowConfigRelevantConfiguration', clearFlowConfigRelevantConfiguration)
@@ -428,6 +430,9 @@ local function loadParameters()
     if data then
       _G.logger:info(nameOfModule .. ": Loaded parameters for deepLearningInstance " .. tostring(selectedInstance) .. " from CSK_PersistentData module.")
       multiDeepLearning_Instances[selectedInstance].parameters = helperFuncs.convertContainer2Table(data)
+
+      multiDeepLearning_Instances[selectedInstance].parameters = helperFuncs.checkParameters(multiDeepLearning_Instances[selectedInstance].parameters, helperFuncs.defaultParameters.getParameters())
+
       updateProcessingParameters()
       pageCalled()
       return true
@@ -513,7 +518,11 @@ Script.register("CSK_PersistentData.OnInitialDataLoaded", handleOnInitialDataLoa
 
 local function resetModule()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
-    clearFlowConfigRelevantConfiguration()
+    for i = 1, #multiDeepLearning_Instances do
+      multiDeepLearning_Instances[i].parameters.registeredEvent = ''
+      Script.notifyEvent('MultiDeepLearning_OnNewImageProcessingParameter', i, 'deregisterFromEvent', '')
+      Script.notifyEvent('MultiDeepLearning_OnNewStatusRegisteredEvent', '')
+    end
     pageCalled()
   end
 end
diff --git a/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/MultiDeepLearning_Model.lua b/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/MultiDeepLearning_Model.lua
@@ -60,16 +60,7 @@ function multiDeepLearning.create(deepLearningInstanceNo)
 
   -- Parameters to be saved permanently
   self.parameters = {}
-  self.parameters.flowConfigPriority = CSK_FlowConfig ~= nil or false -- Status if FlowConfig should have priority for FlowConfig relevant configurations
-  self.parameters.modelPath = '/public/CSK_DeepLearning_Models/' -- Path to search for DNN models
-  self.parameters.modelName = '-' -- Name of selected model
-  self.parameters.validScore = 80 -- Score to decide if image is from a class
-  self.parameters.showImage = false -- Show image on UI
-  self.parameters.forwardResultWithImage = false -- Forward image incl. processing result
-  self.parameters.processWithScores = false -- Return the scores for all classes in the processing result
-  self.parameters.sortResultByIndex = false -- Sort processing result by class index instead of highest score
-  self.parameters.registeredEvent = 'e.g. CSK_MultiRemoteCamera.OnNewImageCamera' .. self.deepLearningInstanceNoString -- Event to register to get images to process
-  self.parameters.processingFile = 'MultiDeepLearning_Processing' -- Script to use for processing in thread
+  self.parameters = self.helperFuncs.defaultParameters.getParameters() -- Load default parameters
 
   -- Parameters to give to the image processing
   self.multiDeepLearningProcessingParams = Container.create()
diff --git a/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/MultiDeepLearning_Parameters.lua b/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/MultiDeepLearning_Parameters.lua
@@ -0,0 +1,29 @@
+---@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 multiDeepLearningParameters = {}
+
+  multiDeepLearningParameters.flowConfigPriority = CSK_FlowConfig ~= nil or false -- Status if FlowConfig should have priority for FlowConfig relevant configurations
+  multiDeepLearningParameters.modelPath = '/public/CSK_DeepLearning_Models/' -- Path to search for DNN models
+  multiDeepLearningParameters.modelName = '-' -- Name of selected model
+  multiDeepLearningParameters.validScore = 80 -- Score to decide if image is from a class
+  multiDeepLearningParameters.showImage = false -- Show image on UI
+  multiDeepLearningParameters.forwardResultWithImage = false -- Forward image incl. processing result
+  multiDeepLearningParameters.processWithScores = false -- Return the scores for all classes in the processing result
+  multiDeepLearningParameters.sortResultByIndex = false -- Sort processing result by class index instead of highest score
+  multiDeepLearningParameters.registeredEvent = '' -- Event to register to get images to process
+  multiDeepLearningParameters.processingFile = 'MultiDeepLearning_Processing' -- Script to use for processing in thread
+
+  return multiDeepLearningParameters
+end
+functions.getParameters = getParameters
+
+return functions
diff --git a/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/helper/funcs.lua b/CSK_Module_MultiDeepLearning/scripts/ImageProcessing/MultiDeepLearning/helper/funcs.lua
@@ -7,6 +7,8 @@
 --**********************Start Global Scope *********************************
 --**************************************************************************
 
+local nameOfModule = 'CSK_MultiDeepLearning'
+
 local funcs = {}
 
 -- Get SIM type / firmware to adapt device specific parameters
@@ -28,6 +30,8 @@ end
 
 -- Providing standard JSON functions
 funcs.json = require('ImageProcessing/MultiDeepLearning/helper/Json')
+-- Default parameters for instances of module
+funcs.defaultParameters = require('ImageProcessing/MultiDeepLearning/MultiDeepLearning_Parameters')
 
 --- Function to create a list with numbers
 ---@param size number Size of the list
@@ -204,6 +208,27 @@ local function checkFirmware(checkDevice, checkMajor, checkMinor, checkPatch)
 end
 funcs.checkFirmware = checkFirmware
 
+--- 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
@@ -19,6 +19,7 @@ Tested on
 
 |Device|Firmware|Module version|
 |--|--|--|
+|SICK AppEngine|V1.7.0|V5.1.0|
 |SICK AppEngine|V1.7.0|V5.0.0|
 |SICK AppEngine|V1.5.0|V4.1.0|
 |SIM1012|V2.4.2|V5.0.0|
diff --git a/docu/CSK_Module_MultiDeepLearning.html b/docu/CSK_Module_MultiDeepLearning.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_MultiDeepLearning 5.0.0</title>
+<title>Documentation - CSK_Module_MultiDeepLearning 5.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_MultiDeepLearning 5.0.0</h1>
+<h1>Documentation - CSK_Module_MultiDeepLearning 5.1.0</h1>
 <div class="details">
 <span id="author" class="author">SICK AG</span><br>
-<span id="revnumber">version 5.0.0,</span>
+<span id="revnumber">version 5.1.0,</span>
 <span id="revdate">2024-10-11</span>
 </div>
 <div id="toc" class="toc2">
@@ -780,7 +780,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">5.0.0</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">5.1.0</p></td>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Date</p></th>
@@ -4553,7 +4553,7 @@ <h3 id="API:Enum:MultiDeepLearning_FC.ResultType"><span class="api-enum">MultiDe
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 5.0.0<br>
+Version 5.1.0<br>
 Last updated 2024-10-11 11:21:14 +0200
 </div>
 </div>
