Release 2.1.0 (#3)

# Release 2.1.0

## New features
- Optionally limit entries of CSV file
- Check if persistent data to load provides all relevant parameters. Otherwise add default values

## Improvements
- FlowConfig handling

## 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

Author: golluroSICKAG

CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 2.1.0
+
+### New features
+- Optionally limit entries of CSV file
+- Check if persistent data to load provides all relevant parameters. Otherwise add default values
+
+### Improvements
+- FlowConfig handling
+
+### 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

CSK_Module_MultiDataLogger/pages/pages/CSK_Module_MultiDataLogger/CSK_Module_MultiDataLogger.css

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

CSK_Module_MultiDataLogger/pages/pages/CSK_Module_MultiDataLogger/CSK_Module_MultiDataLogger.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; }`

CSK_Module_MultiDataLogger/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_MultiDataLogger'
   }, 500);
 })

CSK_Module_MultiDataLogger/pages/src/index.ts

@@ -159,6 +159,14 @@ NUM will be replaced by the number of instance (e.g. "OnNewValueToForward1"). +<
                     <desc>Notify version of module.</desc>
                     <param desc="Version" multiplicity="1" name="version" type="string"/>
                 </event>
+                <event name="OnNewStatusLimitCSVEntries">
+                    <desc>Notify status if CSV entries are limited.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </event>
+                <event name="OnNewStatusCSVLimitAmount">
+                    <desc>Notify limit of entries in CSV file.</desc>
+                    <param desc="Limit of CSV entries." multiplicity="1" name="limit" type="int"/>
+                </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"/>
@@ -259,6 +267,14 @@ If FALSE it is needed to call 'saveLog' manually to store log data.</desc>
                 <function name="resetModule">
                     <desc>Function to reset main configuration of module.</desc>
                 </function>
+                <function name="setCSVLimit">
+                    <desc>Function to set status if CSV entries should be limited.</desc>
+                    <param desc="Status" multiplicity="1" name="status" type="bool"/>
+                </function>
+                <function name="setCSVLimitAmount">
+                    <desc>Function to set maximum amount of CSV entries if it is limited.</desc>
+                    <param desc="Amount of maximum CSV entries." multiplicity="1" name="amount" type="int"/>
+                </function>
             </serves>
         </crown>
         <crown name="MultiDataLogger_FC">
@@ -283,7 +299,7 @@ If FALSE it is needed to call 'saveLog' manually to store log data.</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>

CSK_Module_MultiDataLogger/project.mf.xml

@@ -53,10 +53,9 @@ local multiDataLogger_Instances = {} -- Handle all instances
 local multiDataLoggerController = require('Data/MultiDataLogger/MultiDataLogger_Controller')
 
 if _G.availableAPIs.default then
-  local setInstanceHandle = require('Data/MultiDataLogger/FlowConfig/MultiDataLogger_FlowConfig')
+  require('Data/MultiDataLogger/FlowConfig/MultiDataLogger_FlowConfig')
   table.insert(multiDataLogger_Instances, multiDataLogger_Model.create(1))
   multiDataLoggerController.setMultiDataLogger_Instances_Handle(multiDataLogger_Instances) -- share handle of instances
-  setInstanceHandle(multiDataLogger_Instances)
 else
   _G.logger:warning("CSK_MultiDataLogger: Relevant CROWN(s) not available on device. Module is not supported...")
 end

CSK_Module_MultiDataLogger/scripts/CSK_Module_MultiDataLogger.lua

@@ -29,32 +29,21 @@ processingParams.dataMode = scriptParams:get('dataMode') -- Mode to log data
 processingParams.dataType = scriptParams:get('dataType') -- Type of data to log
 processingParams.csvFilename = scriptParams:get('csvFilename') -- CSV filename
 processingParams.csvLabels = scriptParams:get('csvLabels') -- CSV labels
+processingParams.csvLimit = scriptParams:get('csvLimit') -- CSV entries limited
+processingParams.csvLimitAmount = scriptParams:get('csvLimitAmount') -- Maximum amount of CSV entries if limited
 processingParams.saveOnlyChanges = scriptParams:get('saveOnlyChanges') -- Only save changes within CSV file
 processingParams.saveDataDirectly = scriptParams:get('saveDataDirectly') -- Save CSV data automatically
 processingParams.imageType = scriptParams:get('imageType') -- Mode to log data
 processingParams.imageCompressionValue = scriptParams:get('imageCompressionValue') -- Mode to log data
 
-local latestValue = ''
-local dataArray = {}
+local latestValue = '' -- Latest received data to log
+local dataArray = {} -- Table to store logging data
 
 --- Function to save temp log to file
 local function saveCSVLog()
 
-  local success
   local completeFilepath = processingParams.path .. processingParams.csvFilename .. '.csv'
 
-  if not File.exists(completeFilepath) then
-    local data = processingParams.csvLabels .. "\n"
-    local newFile = File.open(completeFilepath, "wb")
-
-    if (newFile ~= nil) then
-      success = File.write(newFile, data)
-      File.close(newFile)
-    else
-      _G.logger:warning(nameOfModule .. ": Did not work to create data file.")
-    end
-  end
-
   local data = ''
   for i = 1, #dataArray do
     for k, v in pairs(dataArray[i]) do
@@ -64,11 +53,39 @@ local function saveCSVLog()
     end
   end
 
-  local file = File.open(completeFilepath, "ab")
-  if (file ~= nil) then
-    success = File.write(file, data)
-    File.close(file)
-    dataArray = {}
+  if processingParams.csvLimit then
+    local fullData = processingParams.csvLabels .. "\n" .. data
+    local limitedFile = File.open(completeFilepath, "wb")
+    if (limitedFile ~= nil) then
+      local success = File.write(limitedFile, fullData)
+      File.close(limitedFile)
+      if not success then
+        _G.logger:warning(nameOfModule .. ": Did not work to write data to file.")
+      end
+    end
+
+  else
+    if not File.exists(completeFilepath) then
+      local labelData = processingParams.csvLabels .. "\n"
+      local newFile = File.open(completeFilepath, "wb")
+
+      if (newFile ~= nil) then
+        File.write(newFile, labelData)
+        File.close(newFile)
+      else
+        _G.logger:warning(nameOfModule .. ": Did not work to create data file.")
+      end
+    end
+
+    local file = File.open(completeFilepath, "ab")
+    if (file ~= nil) then
+      local success = File.write(file, data)
+      File.close(file)
+      if not success then
+        _G.logger:warning(nameOfModule .. ": Did not work to write data to file.")
+      end
+      dataArray = {}
+    end
   end
 end
 
@@ -91,6 +108,11 @@ local function handleOnNewProcessing(dataContent, filename)
         logKeyPair[formDateTime] = dataAsString
 
         --Save with indeces
+        if processingParams.csvLimit then
+          while #dataArray >= processingParams.csvLimitAmount do
+            table.remove(dataArray, 1)
+          end
+        end
         dataArray[(#dataArray+1)] = logKeyPair
         latestValue = dataAsString
 
@@ -165,6 +187,12 @@ local function handleOnNewProcessingParameter(multiDataLoggerNo, parameter, valu
     elseif parameter == 'saveCSVFile' then
       saveCSVLog()
 
+    elseif parameter == 'csvLimit' then
+      if processingParams['csvLimit'] == true and value == false then
+        dataArray = {}
+      end
+      processingParams[parameter] = value
+
     else
       processingParams[parameter] = value
     end

CSK_Module_MultiDataLogger/scripts/CSK_MultiDataLogger_Processing.lua

@@ -5,26 +5,10 @@
 
 require('Data.MultiDataLogger.FlowConfig.MultiDataLogger_DataSource')
 
--- Reference to the multiImageFilter_Instances handle
-local multiDataLogger_Instances
-
 --- Function to react if FlowConfig was updated
 local function handleOnClearOldFlow()
   if _G.availableAPIs.default then
-    for i = 1, #multiDataLogger_Instances do
-      if multiDataLogger_Instances[i].parameters.flowConfigPriority then
-        CSK_MultiDataLogger.clearFlowConfigRelevantConfiguration()
-        break
-      end
-    end
+    CSK_MultiDataLogger.clearFlowConfigRelevantConfiguration()
   end
 end
 Script.register('CSK_FlowConfig.OnClearOldFlow', handleOnClearOldFlow)
-
---- Function to get access to the multiDataLogger_Instances
----@param handle handle Handle of multiDataLogger_Instances object
-local function setMultiDataLogger_Instances_Handle(handle)
-  multiDataLogger_Instances = handle
-end
-
-return setMultiDataLogger_Instances_Handle

CSK_Module_MultiDataLogger/scripts/Data/MultiDataLogger/FlowConfig/MultiDataLogger_FlowConfig.lua

@@ -45,8 +45,11 @@ Script.serveEvent('CSK_MultiDataLogger.OnNewStatusDataMode', 'MultiDataLogger_On
 Script.serveEvent('CSK_MultiDataLogger.OnNewStatusDataType', 'MultiDataLogger_OnNewStatusDataType')
 
 Script.serveEvent('CSK_MultiDataLogger.OnNewStatusCSVFilename', 'MultiDataLogger_OnNewStatusCSVFilename')
-
 Script.serveEvent('CSK_MultiDataLogger.OnNewStatusCSVLables', 'MultiDataLogger_OnNewStatusCSVLables')
+
+Script.serveEvent('CSK_MultiDataLogger.OnNewStatusLimitCSVEntries', 'MultiDataLogger_OnNewStatusLimitCSVEntries')
+Script.serveEvent('CSK_MultiDataLogger.OnNewStatusCSVLimitAmount', 'MultiDataLogger_OnNewStatusCSVLimitAmount')
+
 Script.serveEvent("CSK_MultiDataLogger.OnNewStatusSaveDataDirectly", "MultiDataLogger_OnNewStatusSaveDataDirectly")
 Script.serveEvent("CSK_MultiDataLogger.OnNewStatusSaveOnlyChanges", "MultiDataLogger_OnNewStatusSaveOnlyChanges")
 
@@ -194,6 +197,10 @@ local function handleOnExpiredTmrMultiDataLogger()
 
     Script.notifyEvent("MultiDataLogger_OnNewStatusCSVFilename", multiDataLogger_Instances[selectedInstance].parameters.csvFilename)
     Script.notifyEvent("MultiDataLogger_OnNewStatusCSVLables", multiDataLogger_Instances[selectedInstance].parameters.csvLabels)
+
+    Script.notifyEvent("MultiDataLogger_OnNewStatusLimitCSVEntries", multiDataLogger_Instances[selectedInstance].parameters.csvLimit)
+    Script.notifyEvent("MultiDataLogger_OnNewStatusCSVLimitAmount", multiDataLogger_Instances[selectedInstance].parameters.csvLimitAmount)
+
     Script.notifyEvent("MultiDataLogger_OnNewStatusSaveDataDirectly", multiDataLogger_Instances[selectedInstance].parameters.saveDataDirectly)
     Script.notifyEvent("MultiDataLogger_OnNewStatusSaveOnlyChanges", multiDataLogger_Instances[selectedInstance].parameters.saveOnlyChanges)
 
@@ -281,6 +288,9 @@ local function updateProcessingParameters()
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'dataType', multiDataLogger_Instances[selectedInstance].parameters.dataType)
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvFilename', multiDataLogger_Instances[selectedInstance].parameters.csvFilename)
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvLabels', multiDataLogger_Instances[selectedInstance].parameters.csvLabels)
+  Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvLimit', multiDataLogger_Instances[selectedInstance].parameters.csvLimit)
+  Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvLimitAmount', multiDataLogger_Instances[selectedInstance].parameters.csvLimitAmount)
+
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'imageType', multiDataLogger_Instances[selectedInstance].parameters.imageType)
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'imageCompressionValue', multiDataLogger_Instances[selectedInstance].parameters.selectedInstance)
 
@@ -338,19 +348,34 @@ end
 Script.serveFunction('CSK_MultiDataLogger.setDataType', setDataType)
 
 local function setCSVFilename(name)
-  _G.logger:fine(nameOfModule .. ": Set csv filename to " .. tostring(name))
+  _G.logger:fine(nameOfModule .. ": Set CSV filename to " .. tostring(name))
   multiDataLogger_Instances[selectedInstance].parameters.csvFilename = name
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvFilename', name)
 end
 Script.serveFunction('CSK_MultiDataLogger.setCSVFilename', setCSVFilename)
 
 local function setCSVLabels(labels)
-  _G.logger:fine(nameOfModule .. ": Set csv labels to " .. labels)
+  _G.logger:fine(nameOfModule .. ": Set CSV labels to " .. labels)
   multiDataLogger_Instances[selectedInstance].parameters.csvLabels = labels
   Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvLabels', labels)
 end
 Script.serveFunction('CSK_MultiDataLogger.setCSVLabels', setCSVLabels)
 
+local function setCSVLimit(status)
+  _G.logger:fine(nameOfModule .. ": Set CSV limit to " .. tostring(status))
+  multiDataLogger_Instances[selectedInstance].parameters.csvLimit = status
+  Script.notifyEvent("MultiDataLogger_OnNewStatusLimitCSVEntries", status)
+  Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvLimit', status)
+end
+Script.serveFunction('CSK_MultiDataLogger.setCSVLimit', setCSVLimit)
+
+local function setCSVLimitAmount(amount)
+  _G.logger:fine(nameOfModule .. ": Set CSV limit amount to " .. tostring(amount))
+  multiDataLogger_Instances[selectedInstance].parameters.csvLimitAmount = amount
+  Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', selectedInstance, 'csvLimitAmount', amount)
+end
+Script.serveFunction('CSK_MultiDataLogger.setCSVLimitAmount', setCSVLimitAmount)
+
 local function setSaveOnlyChanges(status)
   multiDataLogger_Instances[selectedInstance].parameters.saveOnlyChanges = status
   _G.logger:fine(nameOfModule .. ': Set CSV "save changes only" mode to = ' .. tostring(status))
@@ -393,9 +418,11 @@ Script.serveFunction('CSK_MultiDataLogger.getStatusModuleActive', getStatusModul
 
 local function clearFlowConfigRelevantConfiguration()
   for i = 1, #multiDataLogger_Instances do
-    Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', i, 'deregisterEvent', true)
-    multiDataLogger_Instances[i].parameters.registeredEvent = ''
-    Script.notifyEvent("MultiDataLogger_OnNewStatusRegisteredEvent", '')
+    if multiDataLogger_Instances[i].parameters.flowConfigPriority then
+      Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', i, 'deregisterEvent', true)
+      multiDataLogger_Instances[i].parameters.registeredEvent = ''
+      Script.notifyEvent("MultiDataLogger_OnNewStatusRegisteredEvent", '')
+    end
   end
 end
 Script.serveFunction('CSK_MultiDataLogger.clearFlowConfigRelevantConfiguration', clearFlowConfigRelevantConfiguration)
@@ -446,6 +473,8 @@ local function loadParameters()
       _G.logger:info(nameOfModule .. ": Loaded parameters for multiDataLoggerObject " .. tostring(selectedInstance) .. " from CSK_PersistentData module.")
       multiDataLogger_Instances[selectedInstance].parameters = helperFuncs.convertContainer2Table(data)
 
+      multiDataLogger_Instances[selectedInstance].parameters = helperFuncs.checkParameters(multiDataLogger_Instances[selectedInstance].parameters, helperFuncs.defaultParameters.getParameters())
+
       -- If something needs to be configured/activated with new loaded data
       updateProcessingParameters()
       tmrMultiDataLogger:start()
@@ -535,7 +564,11 @@ Script.register("CSK_PersistentData.OnInitialDataLoaded", handleOnInitialDataLoa
 
 local function resetModule()
   if _G.availableAPIs.default then
-    clearFlowConfigRelevantConfiguration()
+    for i = 1, #multiDataLogger_Instances do
+      Script.notifyEvent('MultiDataLogger_OnNewProcessingParameter', i, 'deregisterEvent', true)
+      multiDataLogger_Instances[i].parameters.registeredEvent = ''
+      Script.notifyEvent("MultiDataLogger_OnNewStatusRegisteredEvent", '')
+    end
     pageCalled()
   end
 end