Merge pull request #5 from golluroSICKAG/main

# Release 2.1.0

Author: teplymaSICKAG

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 2.1.0
+
+### New features
+- User can select a subindex to read (even if subindex access is not supported)
+
 ## Release 2.0.0
 Major internal code edits!
 

CSK_Module_IODDInterpreter/project.mf.xml

@@ -475,7 +475,7 @@ Module can provide chunks of IODD file in JSON format to describe some datapoint
             </serves>
         </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_IODDInterpreter/scripts/Sensors/IODDInterpreter/IODDInterpreter_Controller.lua

@@ -311,15 +311,7 @@ local function updateSelectedProcessDataTable(selectedRow, selectedProcessDataTa
     if state == false and selectedProcessDataTable["0"] == true then
       selectedProcessDataTable["0"] = false
     end
-    if selectedProcessDataTable.subindexAccessSupported == true then
-      selectedProcessDataTable[subindex] = state
-    else
-      for tempSubndex, _ in pairs(selectedProcessDataTable) do
-        if tempSubndex ~= "subindexAccessSupported" then
-          selectedProcessDataTable[tempSubndex] = state
-        end
-      end
-    end
+    selectedProcessDataTable[subindex] = state
   else
     for tempSubndex, _ in pairs(selectedProcessDataTable) do
       if tempSubndex ~= "subindexAccessSupported" then
@@ -340,15 +332,7 @@ local function updateSelectedParametersTable(selectedRow, selectedParametersTabl
     if state == false and selectedParametersTable[index]["0"] == true then
       selectedParametersTable[index]["0"] = false
     end
-    if selectedParametersTable[index].subindexAccessSupported == true then
-      selectedParametersTable[index][subindex] = state
-    else
-      for subindex1, _ in pairs(selectedParametersTable[index]) do
-        if subindex1 ~= "subindexAccessSupported" then
-          selectedParametersTable[index][subindex1] = state
-        end
-      end
-    end
+    selectedParametersTable[index][subindex] = state
   else
     for subindex1, _ in pairs(selectedParametersTable[index]) do
       if subindex1 ~= "subindexAccessSupported" then
@@ -970,7 +954,7 @@ local function loadInstancesListParameters(parameterName)
       parameterSet = nil
       data = nil
     else
-      _G.logger:warning(nameOfModule .. ' instance ' .. instanceId .. ": Loading parameters from CSK_PersistentData module did not work.")
+      _G.logger:info(nameOfModule .. ": Loading parameters from CSK_PersistentData module did not work.")
     end
   else
     _G.logger:warning(nameOfModule .. ": CSK_PersistentData Module not available.")

CSK_Module_IODDInterpreter/scripts/Sensors/IODDInterpreter/helper/IODDInterpreter.lua

@@ -47,9 +47,15 @@ end
 
 function IODDInterpreter:getSubIndexParameter(index, subindex)
   if self.ParamIndexMap[index] and self.ParamIndexSubindexMap[index][subindex] then
-    local tempTable = copy(self.Variable[self.ParamIndexMap[index]].Datatype.RecordItem[self.ParamIndexSubindexMap[index][subindex]])
-    changeTextIDtoText(tempTable, self.languages[self.currentLanguage])
-    return tempTable
+    if self.Variable[self.ParamIndexMap[index]].Datatype['xsi:type'] == "ArrayT" then
+      local tempTable = copy(self.Variable[self.ParamIndexMap[index]].Datatype.SimpleDatatype)
+      changeTextIDtoText(tempTable, self.languages[self.currentLanguage])
+      return tempTable
+    else
+      local tempTable = copy(self.Variable[self.ParamIndexMap[index]].Datatype.RecordItem[self.ParamIndexSubindexMap[index][subindex]])
+      changeTextIDtoText(tempTable, self.languages[self.currentLanguage])
+      return tempTable
+    end
   else
     return false
   end

CSK_Module_IODDInterpreter/scripts/Sensors/IODDInterpreter/helper/funcs.lua

@@ -203,7 +203,7 @@ local function getDatatypeBitlength(datatypeInfo)
   elseif datatypeInfo.type == "StringT" or datatypeInfo.type == "OctetStringT" then
     return tonumber(datatypeInfo.fixedLength)
   elseif datatypeInfo.type == "ArrayT" then
-    return tonumber(datatypeInfo.count)*getDatatypeBitlength(datatypeInfo.Datatype)
+    return tonumber(datatypeInfo.count)*getDatatypeBitlength(datatypeInfo.SimpleDatatype)
   end
 end
 
@@ -218,122 +218,121 @@ local defaultValueForSimpleType = {
 
 local function makeExpectedPayload(compiledTable)
   local expectedTable = {}
-  for _, dataPointInfo in pairs(compiledTable) do
-    dataPointInfo = renameDatatype(dataPointInfo)
-    if dataPointInfo.Datatype.type == 'ArrayT' then
-      expectedTable[dataPointInfo.Name] = {}
-      for i = 1, dataPointInfo.Datatype.count do
-        expectedTable[dataPointInfo.Name]["element_" .. tostring(i)] = {}
-        expectedTable[dataPointInfo.Name]["element_" .. tostring(i)].value = defaultValueForSimpleType[dataPointInfo.Datatype.Datatype.type]
-      end
-    elseif dataPointInfo.Datatype.type =='RecordT' then
-      expectedTable[dataPointInfo.Name] = {}
-      local repeatedNames = {}
-      for _, recordInfo in ipairs(dataPointInfo.Datatype.RecordItem) do
-        local recordName = recordInfo.Name
-        if expectedTable[dataPointInfo.Name][recordInfo.Name] then
-          table.insert(repeatedNames, recordInfo.Name)
-          expectedTable[dataPointInfo.Name][recordInfo.Name..'_1'] = copy(expectedTable[dataPointInfo.Name][recordInfo.Name])
-          local repeatedIndex = 2
-          recordName = recordInfo.Name .. '_' .. tostring(repeatedIndex)
-          while expectedTable[dataPointInfo.Name][recordName] do
-            recordName = recordInfo.Name .. '_' .. tostring(repeatedIndex)
-            repeatedIndex = repeatedIndex + 1
-          end
-        end
-        expectedTable[dataPointInfo.Name][recordName] = {}
-        expectedTable[dataPointInfo.Name][recordName].value = defaultValueForSimpleType[recordInfo.Datatype.type]
-      end
-      for i, recordName in ipairs(repeatedNames) do
-        expectedTable[dataPointInfo.Name][recordName] = nil
+  for dataPointId, dataPointInfo in pairs(compiledTable) do
+    if dataPointInfo.subindeces then
+      expectedTable[dataPointId] = {}
+      for subindexId, subindexInfo in pairs(dataPointInfo.subindeces) do
+        expectedTable[dataPointId][subindexId] = {
+          value = defaultValueForSimpleType[subindexInfo.info.type]
+        }
       end
     else
-      expectedTable[dataPointInfo.Name] = {}
-      if dataPointInfo.Datatype then
-        expectedTable[dataPointInfo.Name].value = defaultValueForSimpleType[dataPointInfo.Datatype.type]
-      elseif dataPointInfo.Datatype then
-        expectedTable[dataPointInfo.Name].value = defaultValueForSimpleType[dataPointInfo.Datatype.type]
-      end
+      expectedTable[dataPointId] = {
+        value = defaultValueForSimpleType[dataPointInfo.info.type]
+      }
     end
   end
   return expectedTable
 end
 funcs.makeExpectedPayload = makeExpectedPayload
 
-local function compileProcessDataTable(processDataInfo, selectedTable)
+local function getSingleInfoTable(rawInfoTable)
+  local info = copy(rawInfoTable)
+  if rawInfoTable.Datatype then
+    for key, value in pairs(rawInfoTable.Datatype) do
+      info[key] = value
+    end
+  end
+  if rawInfoTable.SimpleDatatype then
+    for key, value in pairs(rawInfoTable.SimpleDatatype) do
+      info[key] = value
+    end
+  end
+  info.type = info["xsi:type"]
+  info["xsi:type"] = nil
+  info.RecordItem = nil
+  info.Datatype = nil
+  info.SimpleDatatype = nil
+  return info
+end
+
+local function compileDataPointTable(dataInfo, selectedTable)
+  if not dataInfo then
+    return nil
+  end
   local compiledTable = {}
-  if selectedTable["0"] == true then
-    local singleProcessData = copy(processDataInfo)
-    singleProcessData.bitOffset = 0
-    singleProcessData.Frequency = 0
-    singleProcessData.requested = false
-    compiledTable[singleProcessData.Name] = singleProcessData
-    --table.insert(compiledTable, singleProcessData)
-  elseif selectedTable["1"] ~= nil then
+  if dataInfo.Datatype["xsi:type"] == "ArrayT" or dataInfo.Datatype["xsi:type"] == "RecordT" then
     for subindex, selected in pairs(selectedTable) do
       if selected == true and subindex ~= "0" and subindex ~= "subindexAccessSupported" then
-        if processDataInfo.Datatype["xsi:type"] == "ArrayT" then
-          local singleProcessData = copy(processDataInfo.Datatype)
-          singleProcessData.subindex = subindex
-          singleProcessData.bitOffset = tonumber(subindex) * getDatatypeBitlength(singleProcessData.SimpleDatatype)
-          singleProcessData.Frequency = 0
-          singleProcessData.requested = false
-          singleProcessData.Name = processDataInfo.Name.. '_element' .. tostring(subindex)
-          compiledTable[singleProcessData.Name] = singleProcessData
-          --table.insert(compiledTable, singleProcessData)
-        elseif processDataInfo.Datatype["xsi:type"] == "RecordT" then
+        if not compiledTable[dataInfo.Name] then
+          local info = copy(dataInfo)
+          for key, value in pairs(dataInfo.Datatype) do
+            info[key] = value
+          end
+          info.type = info["xsi:type"]
+          info["xsi:type"] = nil
+          if dataInfo.Datatype["xsi:type"] == "ArrayT" then
+            info.SimpleDatatype.type = info.SimpleDatatype["xsi:type"]
+          end
+          info.BitLength = getDatatypeBitlength(info)
+          info.RecordItem = nil
+          info.SimpleDatatype = nil
+          compiledTable[dataInfo.Name] = {
+            info = info,
+            subindeces = {}
+          }
+        end
+        if dataInfo.Datatype["xsi:type"] == "ArrayT" then
+          local singleProcessDatatype = copy(dataInfo.Datatype.SimpleDatatype)
+          singleProcessDatatype.subindex = subindex
+          singleProcessDatatype.type = singleProcessDatatype["xsi:type"]
+          singleProcessDatatype.bitOffset = (tonumber(subindex)-1) * getDatatypeBitlength(singleProcessDatatype)
+          singleProcessDatatype.Name = dataInfo.Name.. '_element' .. tostring(subindex)
+          compiledTable[dataInfo.Name].subindeces[singleProcessDatatype.Name] = {
+            info = singleProcessDatatype
+          }
+
+        elseif dataInfo.Datatype["xsi:type"] == "RecordT" then
           local subindexMap = {}
-          for i, subindexInfo in ipairs(processDataInfo.Datatype.RecordItem) do
+          for i, subindexInfo in ipairs(dataInfo.Datatype.RecordItem) do
             subindexMap[subindexInfo.subindex] = i
           end
-          local singleProcessData = copy(processDataInfo.Datatype.RecordItem[subindexMap[subindex]])
-          singleProcessData.Frequency = 0
-          singleProcessData.requested = false
-          compiledTable[singleProcessData.Name] = singleProcessData
-          --table.insert(compiledTable, singleProcessData)
+          local singleProcessDatatype = copy(dataInfo.Datatype.RecordItem[subindexMap[subindex]])
+          singleProcessDatatype.subindex = subindex
+          if not singleProcessDatatype.Name then
+            singleProcessDatatype.Name = "Null parameter"
+          end
+          compiledTable[dataInfo.Name].subindeces[singleProcessDatatype.Name] = {
+            info = getSingleInfoTable(singleProcessDatatype)
+          }
         end
       end
     end
+  elseif selectedTable["0"] == true then
+    compiledTable[dataInfo.Name] = {
+      info = getSingleInfoTable(dataInfo)
+    }
   end
   if getTableSize(compiledTable) == 0 then
     return nil
   end
   return compiledTable
 end
-funcs.compileProcessDataTable = compileProcessDataTable
+funcs.compileProcessDataTable = compileDataPointTable
 
 local function compileParametersTable(iodd, selectedTable)
   local compiledTable = {}
   for index, subindeces in pairs(selectedTable) do
-    if subindeces["0"] == true then
-      local ioddIndexdata = iodd:getParameterInfoFromIndex(index)
-      ioddIndexdata.subindex = "0"
-      ioddIndexdata.Frequency = 0
-      ioddIndexdata.requested = false
-      compiledTable[ioddIndexdata.Name] = ioddIndexdata
-      --table.insert(compiledTable, ioddIndexdata)
-    elseif subindeces["1"] ~= nil then
-      for subindex, selected in pairs(subindeces) do
-        if selected == true and subindex ~= "0" and subindex ~= "subindexAccessSupported" then
-          local ioddIndexdata = iodd:getParameterInfoFromIndex(index)
-          if ioddIndexdata.Datatype["xsi:type"] == "ArrayT" then
-            local ioddSubIndexdata = ioddIndexdata.Datatype
-            ioddSubIndexdata.index = index
-            ioddSubIndexdata.subindex = subindex
-            ioddSubIndexdata.Frequency = 0
-            ioddSubIndexdata.requested = false
-            ioddSubIndexdata.Name = ioddIndexdata.Name.. '_element' .. tostring(subindex)
-            --table.insert(compiledTable, ioddSubIndexdata)
-            compiledTable[ioddIndexdata.Name] = ioddSubIndexdata
-          elseif ioddIndexdata.Datatype["xsi:type"] == "RecordT" then
-            local ioddSubIndexdata = iodd:getSubIndexParameter(index, subindex)
-            ioddSubIndexdata.index = index
-            ioddSubIndexdata.Frequency = 0
-            ioddSubIndexdata.requested = false
-            --table.insert(compiledTable, ioddSubIndexdata)
-            compiledTable[ioddSubIndexdata.Name] = ioddSubIndexdata
+    for subindex, selected in pairs(subindeces) do
+      if selected == true then
+        local ioddIndexdata = iodd:getParameterInfoFromIndex(index)
+        local compiledDataPointTable = compileDataPointTable(ioddIndexdata, subindeces)
+        if compiledDataPointTable then
+          for key, value in pairs(compiledDataPointTable) do
+            compiledTable[key] = value
           end
         end
+        break
       end
     end
   end

README.md

@@ -43,6 +43,7 @@ Tested on
 |Device|Firmware version|Module version|
 |--|--|--|
 |SICK AppEngine|V1.7.0|V1.1.0|
+|SIM1012|V2.4.2|V2.1.0|
 |SIM1012|V2.4.2|V1.1.0|
 |SIM1012|v2.3.0|v1.0.1|
 |SIM1012|v2.3.0|v1.0.0|

docu/CSK_Module_IODDInterpreter.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_IODDInterpreter 2.0.0</title>
+<title>Documentation - CSK_Module_IODDInterpreter 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,11 +615,11 @@
 </head>
 <body class="article toc2 toc-left">
 <div id="header">
-<h1>Documentation - CSK_Module_IODDInterpreter 2.0.0</h1>
+<h1>Documentation - CSK_Module_IODDInterpreter 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="revdate">2024-10-21</span>
+<span id="revnumber">version 2.1.0,</span>
+<span id="revdate">2025-01-22</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -755,11 +755,11 @@ <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>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2024-10-21</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">2025-01-22</p></td>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Author</p></th>
@@ -5534,8 +5534,8 @@ <h4 id="_short_description_89">Short description</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 2.0.0<br>
-Last updated 2024-10-21 14:45:31 +0200
+Version 2.1.0<br>
+Last updated 2025-01-22 11:40:09 +0100
 </div>
 </div>
 <script type="text/javascript">