Release 3.1.0 (#2)

golluroSICKAG · web-flow · commit 252021a8ece8 · 2025-07-28T09:39:07.000+02:00
# Release 3.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 3.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 3.0.0
 
 ### New features
diff --git a/CSK_Module_MultiColorSelection/pages/pages/CSK_Module_MultiColorSelection/CSK_Module_MultiColorSelection.css b/CSK_Module_MultiColorSelection/pages/pages/CSK_Module_MultiColorSelection/CSK_Module_MultiColorSelection.css
@@ -4,9 +4,10 @@
   max-width: none;
 }
 
-.myViewer_CSK_Module_MultiColorSelection > div > div {
-  max-height: 600px;
-  min-height: 600px;
+.myViewer_CSK_Module_MultiColorSelection {
+  width: 98%;
+  height: 600px;
+  margin: auto;
 }
 
 .myCustomPlaceholder5pxHeight_CSK_Module_MultiColorSelection {
@@ -115,5 +116,5 @@
 
 .myCustomButton_CSK_Module_MultiColorSelection {
   border-radius: 30px;
-  padding-right: 0px;
+  padding: 11px;
 }
diff --git a/CSK_Module_MultiColorSelection/pages/pages/CSK_Module_MultiColorSelection/CSK_Module_MultiColorSelection.html b/CSK_Module_MultiColorSelection/pages/pages/CSK_Module_MultiColorSelection/CSK_Module_MultiColorSelection.html
diff --git a/CSK_Module_MultiColorSelection/pages/src/converter.ts b/CSK_Module_MultiColorSelection/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_MultiColorSelection/pages/src/index.ts b/CSK_Module_MultiColorSelection/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_MultiColorSelection'
   }, 500);
 })
diff --git a/CSK_Module_MultiColorSelection/project.mf.xml b/CSK_Module_MultiColorSelection/project.mf.xml
@@ -579,7 +579,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">3.0.0</meta>
+        <meta key="version">3.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_MultiColorSelection/scripts/CSK_Module_MultiColorSelection.lua b/CSK_Module_MultiColorSelection/scripts/CSK_Module_MultiColorSelection.lua
@@ -50,10 +50,9 @@ local multiColorSelection_Instances = {} -- Handle all instances
 local multiColorSelectionController = require('ImageProcessing/MultiColorSelection/MultiColorSelection_Controller')
 
 if _G.availableAPIs.default and _G.availableAPIs.specific then
-  local setInstanceHandle = require('ImageProcessing/MultiColorSelection/FlowConfig/MultiColorSelection_FlowConfig')
+  require('ImageProcessing/MultiColorSelection/FlowConfig/MultiColorSelection_FlowConfig')
   table.insert(multiColorSelection_Instances, multiColorSelection_Model.create(1))
   multiColorSelectionController.setMultiColorSelection_Instances_Handle(multiColorSelection_Instances)
-  setInstanceHandle(multiColorSelection_Instances)
 else
   _G.logger:warning("CSK_MultiColorSelection: Relevant CROWN(s) not available on device. Module is not supported...")
 end
diff --git a/CSK_Module_MultiColorSelection/scripts/CSK_MultiColorSelection_Processing.lua b/CSK_Module_MultiColorSelection/scripts/CSK_MultiColorSelection_Processing.lua
@@ -391,9 +391,11 @@ local function handleOnNewProcessing(image, timestamp)
 
           viewer:present()
 
-          Script.notifyEvent("MultiColorSelection_OnNewValueToForward" .. multiColorSelectionInstanceNumberString, 'MultiColorSelection_OnNewFoundBlobs', tostring(#blobs))
-          Script.notifyEvent("MultiColorSelection_OnNewValueToForward" .. multiColorSelectionInstanceNumberString, 'MultiColorSelection_OnNewSizeSmallestBlob', string.format("%.1f",(blobMin)))
-          Script.notifyEvent("MultiColorSelection_OnNewValueToForward" .. multiColorSelectionInstanceNumberString, 'MultiColorSelection_OnNewSizeBiggestBlob', string.format("%.1f",(blobMax)))
+          if processingParams['activeInUI'] then
+            Script.notifyEvent("MultiColorSelection_OnNewValueToForward" .. multiColorSelectionInstanceNumberString, 'MultiColorSelection_OnNewFoundBlobs', tostring(#blobs))
+            Script.notifyEvent("MultiColorSelection_OnNewValueToForward" .. multiColorSelectionInstanceNumberString, 'MultiColorSelection_OnNewSizeSmallestBlob', string.format("%.1f",(blobMin)))
+            Script.notifyEvent("MultiColorSelection_OnNewValueToForward" .. multiColorSelectionInstanceNumberString, 'MultiColorSelection_OnNewSizeBiggestBlob', string.format("%.1f",(blobMax)))
+          end
 
           return
         end
diff --git a/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/FlowConfig/MultiColorSelection_FlowConfig.lua b/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/FlowConfig/MultiColorSelection_FlowConfig.lua
@@ -7,26 +7,10 @@ require('ImageProcessing.MultiColorSelection.FlowConfig.MultiColorSelection_Imag
 require('ImageProcessing.MultiColorSelection.FlowConfig.MultiColorSelection_OnNewResult')
 require('ImageProcessing.MultiColorSelection.FlowConfig.MultiColorSelection_Process')
 
--- Reference to the multiImageFilter_Instances handle
-local multiColorSelection_Instances
-
 --- Function to react if FlowConfig was updated
 local function handleOnClearOldFlow()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
-    for i = 1, #multiColorSelection_Instances do
-      if multiColorSelection_Instances[i].parameters.flowConfigPriority then
-        CSK_MultiColorSelection.clearFlowConfigRelevantConfiguration()
-        break
-      end
-    end
+    CSK_MultiColorSelection.clearFlowConfigRelevantConfiguration()
   end
 end
 Script.register('CSK_FlowConfig.OnClearOldFlow', handleOnClearOldFlow)
-
---- Function to get access to the multiColorSelection_Instances
----@param handle handle Handle of multiColorSelection_Instances object
-local function setMultiColorSelection_Instances_Handle(handle)
-  multiColorSelection_Instances = handle
-end
-
-return setMultiColorSelection_Instances_Handle
diff --git a/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/MultiColorSelection_Controller.lua b/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/MultiColorSelection_Controller.lua
@@ -699,9 +699,11 @@ Script.serveFunction('CSK_MultiColorSelection.getStatusModuleActive', getStatusM
 
 local function clearFlowConfigRelevantConfiguration()
   for i = 1, #multiColorSelection_Instances do
-    multiColorSelection_Instances[i].parameters.registeredEvent = ''
-    Script.notifyEvent('MultiColorSelection_OnNewProcessingParameter', i, 'deregisterFromEvent', '')
-    Script.notifyEvent('MultiColorSelection_OnNewStatusRegisteredEvent', '')
+    if multiColorSelection_Instances[i].parameters.flowConfigPriority then
+      multiColorSelection_Instances[i].parameters.registeredEvent = ''
+      Script.notifyEvent('MultiColorSelection_OnNewProcessingParameter', i, 'deregisterFromEvent', '')
+      Script.notifyEvent('MultiColorSelection_OnNewStatusRegisteredEvent', '')
+    end
   end
 end
 Script.serveFunction('CSK_MultiColorSelection.clearFlowConfigRelevantConfiguration', clearFlowConfigRelevantConfiguration)
@@ -755,6 +757,8 @@ local function loadParameters()
       _G.logger:info(nameOfModule .. ": Loaded parameters for multiColorSelectionInstance " .. tostring(selectedInstance) .. " from CSK_PersistentData module.")
       multiColorSelection_Instances[selectedInstance].parameters = helperFuncs.convertContainer2Table(data)
 
+      multiColorSelection_Instances[selectedInstance].parameters = helperFuncs.checkParameters(multiColorSelection_Instances[selectedInstance].parameters, helperFuncs.defaultParameters.getParameters())
+
       -- Send config to instances
       local colorParams = helperFuncs.convertTable2Container(multiColorSelection_Instances[selectedInstance].parameters.colorObjects)
       Container.add(data, 'colorObjects', colorParams, 'OBJECT')
@@ -844,7 +848,11 @@ Script.register("CSK_PersistentData.OnInitialDataLoaded", handleOnInitialDataLoa
 
 local function resetModule()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
-    clearFlowConfigRelevantConfiguration()
+    for i = 1, #multiColorSelection_Instances do
+      multiColorSelection_Instances[i].parameters.registeredEvent = ''
+      Script.notifyEvent('MultiColorSelection_OnNewProcessingParameter', i, 'deregisterFromEvent', '')
+      Script.notifyEvent('MultiColorSelection_OnNewStatusRegisteredEvent', '')
+    end
     pageCalled()
   end
 end
diff --git a/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/MultiColorSelection_Model.lua b/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/MultiColorSelection_Model.lua
@@ -57,75 +57,7 @@ function multiColorSelection.create(multiColorSelectionInstanceNo)
 
   -- 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.registeredEvent = '' -- Event to register to get images to process
-  self.parameters.processingFile = 'CSK_MultiColorSelection_Processing' -- Script to use for processing in thread
-
-  self.parameters.showImageChannel = 'Value' -- Image to show in UI viewer (Hue, Saturation, Value)
-  self.parameters.showAOI = false -- Show area of interest within image in UI viewer
-  self.parameters.showImage = true -- Show image in UI viewer
-  self.parameters.maxImageQueueSize = 5 -- Max size of queue. If bigger, images will not be processed
-
-  -- Type of result output
-  self.parameters.resultOutput = 'TOTAL+SUBRESULTS' -- 'TOTAL', 'TOTAL+SUBRESULTS', 'TOTAL+SUBVALUES'
-
-  self.parameters.preFilterAOIActive = false -- Prefilter area of interest active
-  self.parameters.preFilterAOIChannel = 'Saturation' -- Image channel to use for prefilter AOI
-  self.parameters.preFilterAOIMin = 60 -- Min value to consider as AOI
-  self.parameters.preFilterAOIMax = 255 -- Max value to consider as AOI
-
-  self.parameters.preFilterAONIActive = false -- Prefilter area of NON interest active
-  self.parameters.preFilterAONIChannel = 'Value' -- Image channel to use for prefilter AONI
-  self.parameters.preFilterAONIMin = 0 -- Min value to consider as AONI
-  self.parameters.preFilterAONIMax = 30 -- Max value to consider as AONI
-
-  self.parameters.colorObjects = {} -- table to hold object configuration
-
-  for i = 1, 12 do
-    local obj = {}
-
-    obj.objectName = 'Object' .. tostring(i) -- name of the object
-    obj.colorActive = false  -- is this object active
-    obj.colorMode = 'Color' -- 1 = Color, 2 = Grayvalue
-    obj.colorValue = 1 -- color-value of the object
-    obj.regionColor = 1 -- color of the ROI in result image
-    obj.colorTolerance = 0 -- tolerance of the object
-    obj.minBlobSize = 100 -- minimum blob size
-    obj.maxBlobSize = 10000 -- maximum blob size
-    obj.pixelRefactorActive = false -- Refactor px/mm active
-    obj.pixelRefactorUnit = 'px' -- 'px/mm' or 'px'
-    obj.pixelRefactor = 1.0 -- Refactor px/mm
-    obj.pixelRefactorUseable = obj.pixelRefactor*obj.pixelRefactor -- calculated pixel refactor
-    obj.minGood = 1 -- minimum accepted amount of found objects
-    obj.maxGood = 1 -- maximum accepted amount of found objects
-
-    obj.type_ROI = 'Rectangle' -- type of ROI, 'Rectangle' / 'Circle'
-    obj.centerX_ROI = 100.0 -- xPos of ROI
-    obj.centerY_ROI = 100.0 -- yPos of ROI
-    obj.radius_ROI = 100.0 -- radius of ROI if circle
-    obj.width_ROI = 100.0 -- width of ROI
-    obj.height_ROI = 100.0 -- height of ROI
-    obj.center_ROI = Point.create(obj.centerX_ROI, obj.centerY_ROI) -- centerPoint of ROI
-    obj.ROI = Shape.createRectangle(obj.center_ROI, obj.width_ROI, obj.height_ROI) -- ROI itself
-    obj.roiActive = false -- is ROI active
-
-    obj.type_maskingROI = 'Rectangle' -- type of masks, 'Rectangle' / 'Circle'
-    obj.maskingROIActive = false -- is maskingROI active
-
-    obj.maskingROIs = {} -- table of masks to not consider within image
-
-    local mask = {} -- single mask
-    local maskCP = Point.create(100.0, 100-0) -- centerPoint of maskingROI
-    mask.mask = Shape.createRectangle(maskCP, 100.0, 100.0) -- mask itself
-
-    table.insert(obj.maskingROIs, mask)
-
-    obj.maskingROIComposite = Shape.Composite.create() -- Composite of all masks together
-    Shape.Composite.addShape(obj.maskingROIComposite, mask.mask)
-
-    table.insert(self.parameters.colorObjects, obj)
-
-  end
+  self.parameters = self.helperFuncs.defaultParameters.getParameters() -- Load default parameters
 
   local colorObjectsContainer = self.helperFuncs.convertTable2Container(self.parameters.colorObjects)
 
diff --git a/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/MultiColorSelection_Parameters.lua b/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/MultiColorSelection_Parameters.lua
@@ -0,0 +1,88 @@
+---@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 multiColorSelection = {}
+
+  multiColorSelection.flowConfigPriority = CSK_FlowConfig ~= nil or false -- Status if FlowConfig should have priority for FlowConfig relevant configurations
+  multiColorSelection.registeredEvent = '' -- Event to register to get images to process
+  multiColorSelection.processingFile = 'CSK_MultiColorSelection_Processing' -- Script to use for processing in thread
+
+  multiColorSelection.showImageChannel = 'Value' -- Image to show in UI viewer (Hue, Saturation, Value)
+  multiColorSelection.showAOI = false -- Show area of interest within image in UI viewer
+  multiColorSelection.showImage = true -- Show image in UI viewer
+  multiColorSelection.maxImageQueueSize = 5 -- Max size of queue. If bigger, images will not be processed
+
+  -- Type of result output
+  multiColorSelection.resultOutput = 'TOTAL+SUBRESULTS' -- 'TOTAL', 'TOTAL+SUBRESULTS', 'TOTAL+SUBVALUES'
+
+  multiColorSelection.preFilterAOIActive = false -- Prefilter area of interest active
+  multiColorSelection.preFilterAOIChannel = 'Saturation' -- Image channel to use for prefilter AOI
+  multiColorSelection.preFilterAOIMin = 60 -- Min value to consider as AOI
+  multiColorSelection.preFilterAOIMax = 255 -- Max value to consider as AOI
+
+  multiColorSelection.preFilterAONIActive = false -- Prefilter area of NON interest active
+  multiColorSelection.preFilterAONIChannel = 'Value' -- Image channel to use for prefilter AONI
+  multiColorSelection.preFilterAONIMin = 0 -- Min value to consider as AONI
+  multiColorSelection.preFilterAONIMax = 30 -- Max value to consider as AONI
+
+  multiColorSelection.colorObjects = {} -- table to hold object configuration
+
+  for i = 1, 12 do
+    local obj = {}
+
+    obj.objectName = 'Object' .. tostring(i) -- name of the object
+    obj.colorActive = false  -- is this object active
+    obj.colorMode = 'Color' -- 1 = Color, 2 = Grayvalue
+    obj.colorValue = 1 -- color-value of the object
+    obj.regionColor = 1 -- color of the ROI in result image
+    obj.colorTolerance = 0 -- tolerance of the object
+    obj.minBlobSize = 100 -- minimum blob size
+    obj.maxBlobSize = 10000 -- maximum blob size
+    obj.pixelRefactorActive = false -- Refactor px/mm active
+    obj.pixelRefactorUnit = 'px' -- 'px/mm' or 'px'
+    obj.pixelRefactor = 1.0 -- Refactor px/mm
+    obj.pixelRefactorUseable = obj.pixelRefactor*obj.pixelRefactor -- calculated pixel refactor
+    obj.minGood = 1 -- minimum accepted amount of found objects
+    obj.maxGood = 1 -- maximum accepted amount of found objects
+
+    obj.type_ROI = 'Rectangle' -- type of ROI, 'Rectangle' / 'Circle'
+    obj.centerX_ROI = 100.0 -- xPos of ROI
+    obj.centerY_ROI = 100.0 -- yPos of ROI
+    obj.radius_ROI = 100.0 -- radius of ROI if circle
+    obj.width_ROI = 100.0 -- width of ROI
+    obj.height_ROI = 100.0 -- height of ROI
+    obj.center_ROI = Point.create(obj.centerX_ROI, obj.centerY_ROI) -- centerPoint of ROI
+    obj.ROI = Shape.createRectangle(obj.center_ROI, obj.width_ROI, obj.height_ROI) -- ROI itself
+    obj.roiActive = false -- is ROI active
+
+    obj.type_maskingROI = 'Rectangle' -- type of masks, 'Rectangle' / 'Circle'
+    obj.maskingROIActive = false -- is maskingROI active
+
+    obj.maskingROIs = {} -- table of masks to not consider within image
+
+    local mask = {} -- single mask
+    local maskCP = Point.create(100.0, 100-0) -- centerPoint of maskingROI
+    mask.mask = Shape.createRectangle(maskCP, 100.0, 100.0) -- mask itself
+
+    table.insert(obj.maskingROIs, mask)
+
+    obj.maskingROIComposite = Shape.Composite.create() -- Composite of all masks together
+    Shape.Composite.addShape(obj.maskingROIComposite, mask.mask)
+
+    table.insert(multiColorSelection.colorObjects, obj)
+
+  end
+
+  return multiColorSelection
+end
+functions.getParameters = getParameters
+
+return functions
diff --git a/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/helper/funcs.lua b/CSK_Module_MultiColorSelection/scripts/ImageProcessing/MultiColorSelection/helper/funcs.lua
@@ -7,9 +7,13 @@
 --**********************Start Global Scope *********************************
 --**************************************************************************
 
+local nameOfModule = 'CSK_MultiColorSelection'
+
 local funcs = {}
 -- Providing standard JSON functions
 funcs.json = require('ImageProcessing/MultiColorSelection/helper/Json')
+-- Default parameters for instances of module
+funcs.defaultParameters = require('ImageProcessing/MultiColorSelection/MultiColorSelection_Parameters')
 
 --**************************************************************************
 --********************** End Global Scope **********************************
@@ -120,6 +124,27 @@ local function selectRegionColor(colorValue)
 end
 funcs.selectRegionColor = selectRegionColor
 
+--- 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
@@ -15,6 +15,7 @@ Tested on
 
 |Device|Firmware version|Module version|
 |--|--|--|
+|SICK AppEngine|V1.7.0|v3.1.0|
 |SIM1012|V2.4.2|v3.0.0|
 |SIM1012|V2.2.0|<v3.0.0|
 |SIM2500|V1.3.0|<v3.0.0|
diff --git a/docu/CSK_Module_MultiColorSelection.html b/docu/CSK_Module_MultiColorSelection.html

Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,10 @@`
`4`	`4`	`max-width: none;`
`5`	`5`	`}`
`6`	`6`
`7`		`-.myViewer_CSK_Module_MultiColorSelection > div > div {`
`8`		`- max-height: 600px;`
`9`		`- min-height: 600px;`
	`7`	`+.myViewer_CSK_Module_MultiColorSelection {`
	`8`	`+ width: 98%;`
	`9`	`+ height: 600px;`
	`10`	`+ margin: auto;`
`10`	`11`	`}`
`11`	`12`
`12`	`13`	`.myCustomPlaceholder5pxHeight_CSK_Module_MultiColorSelection {`
`@@ -115,5 +116,5 @@`
`115`	`116`
`116`	`117`	`.myCustomButton_CSK_Module_MultiColorSelection {`
`117`	`118`	`border-radius: 30px;`
`118`		`- padding-right: 0px;`
	`119`	`+ padding: 11px;`
`119`	`120`	`}`