Merge pull request #3 from golluroSICKAG/main

# Release 2.1.0

Author: teplymaSICKAG

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 2.1.0
+
+### New features
+Now it is possible to read subindexes (even if the subindex access is not supported). Requires IODD interpreter v2.1.0 or more
+
+### Improvements
+- Speeding up of data parsing when reading from IO-Link device
+
 ## Release 2.0.0
 
 ### New features

CSK_Module_MultiIOLinkSMI/project.mf.xml

@@ -1056,7 +1056,7 @@ Provide IOLink data via event.</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_MultiIOLinkSMI/scripts/CSK_MultiIOLinkSMI_Processing.lua

@@ -359,6 +359,61 @@ Script.serveFunction('CSK_MultiIOLinkSMI.writeParameterByteArray_' .. multiIOLin
 -- Read Messages --------------------------------------------------------------------
 -------------------------------------------------------------------------------------
 
+
+local ioddReadMessagesFunctions = {}
+
+local function updateFunctions()
+  ioddReadMessagesFunctions = {}
+  for messageName, messageInfo in pairs(ioddReadMessages) do
+    ioddReadMessagesFunctions[messageName] = {}
+    if not messageInfo.dataInfo then
+      goto nextMessage
+    end
+    local includeDataMode = (messageInfo.dataInfo.ProcessData and messageInfo.dataInfo.Parameters)
+    if includeDataMode then
+      ioddReadMessagesFunctions[messageName] = {
+        ProcessData = {},
+        Parameters = {}
+      }
+      for dataMode, dataModeInfo in pairs(messageInfo.dataInfo) do
+        if dataMode == "ProcessData" then
+          for dataPointID, dataPointInfo in pairs(dataModeInfo) do
+            ioddReadMessagesFunctions[messageName][dataMode][dataPointID] = {
+              getDataFunction = readBinaryProcessData,
+              processFunctions = converter.getParameterReadFunctions(dataPointInfo)
+            }
+          end
+        elseif dataMode == "Parameters" then
+          for dataPointID, dataPointInfo in pairs(dataModeInfo) do
+            ioddReadMessagesFunctions[messageName][dataMode][dataPointID] = {
+              getDataFunction = function() return readBinaryServiceData(tonumber(dataPointInfo.info.index), 0) end,
+              processFunctions = converter.getParameterReadFunctions(dataPointInfo)
+            }
+          end
+        end
+      end
+    else
+      if messageInfo.dataInfo.ProcessData then
+        for dataPointID, dataPointInfo in pairs(messageInfo.dataInfo.ProcessData) do
+          ioddReadMessagesFunctions[messageName][dataPointID] = {
+            getDataFunction = readBinaryProcessData,
+            processFunctions = converter.getParameterReadFunctions(dataPointInfo)
+          }
+        end
+      elseif messageInfo.dataInfo.Parameters then
+        for dataPointID, dataPointInfo in pairs(messageInfo.dataInfo.Parameters) do
+          ioddReadMessagesFunctions[messageName][dataPointID] = {
+            getDataFunction = function() return readBinaryServiceData(tonumber(dataPointInfo.info.index), 0) end,
+            processFunctions = converter.getParameterReadFunctions(dataPointInfo)
+          }
+        end
+      end
+    end
+    ::nextMessage::
+  end
+end
+
+
 -- Read preconfigured message
 ---@param messageName string Name of the message to read.
 ---@return bool success Success of reading.
@@ -367,42 +422,65 @@ local function readIODDMessage(messageName)
   if not ioddReadMessages[messageName] or not ioddReadMessages[messageName].dataInfo then
     return false, "No data selected for read"
   end
+  local message = {}
+  local ts1 = DateTime.getTimestamp()
   local success = true
-  local messageContent = {}
-  local includeDataMode = (ioddReadMessages[messageName].dataInfo.ProcessData and ioddReadMessages[messageName].dataInfo.Parameters)
-  if ioddReadMessages[messageName].dataInfo.ProcessData then
-    local readSuccess, receivedData = readProcessData(ioddReadMessages[messageName].dataInfo.ProcessData)
-    if not readSuccess then
-      success = false
-    end
-    if includeDataMode then
-      messageContent.ProcessData = receivedData
-    else
-      messageContent = receivedData
-    end
-  end
-  if ioddReadMessages[messageName].dataInfo.Parameters then
-    if includeDataMode then
-      messageContent.Parameters = {}
+  if ioddReadMessagesFunctions[messageName].ProcessData and ioddReadMessagesFunctions[messageName].Parameters then
+    message = {
+      ProcessData = {},
+      Parameters = {}
+    }
+    for dataMode, dataModeInfo in pairs(ioddReadMessagesFunctions[messageName]) do
+      for datapointId, datapointInfo in pairs(dataModeInfo) do
+        message[dataMode][datapointId] = {}
+        local binData = datapointInfo.getDataFunction()
+        if not binData then
+          success = false
+          for k, v in pairs(datapointInfo.processFunctions) do
+            if type(v) == "function" then
+              message[dataMode][datapointId][k] = "null"
+            else
+              message[dataMode][datapointId][k] = {value = "null"}
+            end
+          end
+        else
+          for k, v in pairs(datapointInfo.processFunctions) do
+            if type(v) == "function" then
+              message[dataMode][datapointId][k] = v(binData)
+            else
+              message[dataMode][datapointId][k] = {value = v.value(binData)}
+            end
+          end
+        end
+      end
     end
-    for dataPointID, dataPointInfo in pairs(ioddReadMessages[messageName].dataInfo.Parameters) do
-      local readSuccess, receivedData = readParameter(dataPointInfo)
-      if not readSuccess then
+  else
+    for datapointId, datapointInfo in pairs(ioddReadMessagesFunctions[messageName]) do
+      message[datapointId] = {}
+      local binData = datapointInfo.getDataFunction()
+      if not binData then
         success = false
-      end
-      if includeDataMode then
-        messageContent.Parameters[dataPointID] = receivedData
+        for k, v in pairs(datapointInfo.processFunctions) do
+          if type(v) == "function" then
+            message[datapointId][k] = "null"
+          else
+            message[datapointId][k] = {value = "null"}
+          end
+        end
       else
-        messageContent[dataPointID] = receivedData
+        for k, v in pairs(datapointInfo.processFunctions) do
+          if type(v) == "function" then
+            message[datapointId][k] = v(binData)
+          else
+            message[datapointId][k] = {value = v.value(binData)}
+          end
+        end
       end
     end
   end
-  local jsonMessageContent = json.encode(messageContent)
-  ioddReadMessagesResults[messageName] = success
-  ioddLatestReadMessages[messageName] = jsonMessageContent
-  return success, jsonMessageContent
+  return success, json.encode(message)
 end
-Script.serveFunction('CSK_MultiIOLinkSMI.readIODDMessage' .. multiIOLinkSMIInstanceNumberString, readIODDMessage, 'string:1:', 'bool:1:,string:?:')
+Script.serveFunction('CSK_MultiIOLinkSMI.readIODDMessage' .. multiIOLinkSMIInstanceNumberString, readIODDMessage, 'string:1:', 'bool:1,string:?:')
 
 --- Update configuration of read messages
 local function updateIODDReadMessages()
@@ -419,19 +497,7 @@ local function updateIODDReadMessages()
   end
   ioddReadMessagesTimers = {}
   ioddReadMessagesRegistrations = {}
-  for messageName, messageInfo in pairs(ioddReadMessages) do
-    if helperFuncs.getTableSize(messageInfo.dataInfo) == 0 then
-      goto nextMessage
-    end
-    for dataMode, dataModeInfo in pairs(messageInfo.dataInfo) do
-      if dataMode == "ProcessData" or dataMode == "Parameters" then
-        for dataPointID, dataPointInfo in pairs(dataModeInfo) do
-          ioddReadMessages[messageName].dataInfo[dataMode][dataPointID] = converter.renameDatatype(dataPointInfo)
-        end
-      end
-    end
-    ::nextMessage::
-  end
+  updateFunctions()
   local queueFunctions = {}
   for messageName, messageInfo in pairs(ioddReadMessages) do
     if helperFuncs.getTableSize(messageInfo.dataInfo) == 0 then
@@ -447,6 +513,8 @@ local function updateIODDReadMessages()
       end
       local timestamp1 = DateTime.getTimestamp()
       local success, jsonMessageContent = readIODDMessage(messageName)
+      ioddReadMessagesResults[messageName] = success
+      ioddLatestReadMessages[messageName] = jsonMessageContent
       local errorMessage = ''
       local queueSize = ioddReadMessagesQueue:getSize()
       if not success then

CSK_Module_MultiIOLinkSMI/scripts/Communication/MultiIOLinkSMI/helper/DataConverter.lua

@@ -126,21 +126,10 @@ local function toBinaryString(data, byteLength)
 end
 converter.toBinaryString = toBinaryString
 
--------------------------------------------------------------------------------------
--- Reverse the byteorder
-local function reverseBinaryString(binString)
-  local l_result = ""
-  for l_index = #binString, 1, -1 do
-    l_result = l_result .. string.sub(binString, l_index, l_index)
-  end
-
-  return l_result
-end
-converter.reverseBinaryString = reverseBinaryString
-
 -------------------------------------------------------------------------------------
 -- Disassemble data
 
+-- Gets necessary bits out of the bytes
 local function extract(n, field, width)
     -- Shift right by 'field' to get the bits starting at 'field' in the least significant bits
     local shifted = n >> field
@@ -150,18 +139,100 @@ local function extract(n, field, width)
     return shifted & mask
 end
 
-local function disassembleData(data, startBit, bitLength)
-  local l_startByte = math.floor(startBit / 8) + 1
-  local l_startBitInByte = startBit % 8
+-- Bitwise processing of the incoming binary string
+local function disassembleData(data, bitOffset, bitLength)
+  local byteLength = string.len(data)
+  local l_startBit = byteLength*8 - bitLength - bitOffset + 1
+  local l_startByte = math.ceil(l_startBit / 8)
+  local l_startBitInByte = l_startBit % 8 - 1
   local l_byteLengthItem = math.ceil(bitLength / 8)
-  local l_revRawData = reverseBinaryString(data)
-  local l_dataAsNumber = string.unpack("<I" .. tostring(l_byteLengthItem), l_revRawData, l_startByte)
+  local l_dataAsNumber = string.unpack(">I" .. tostring(l_byteLengthItem), data, l_startByte)
   local l_extractedValue = extract(l_dataAsNumber, l_startBitInByte, bitLength)
   local l_asBinaryString = toBinaryString(l_extractedValue, l_byteLengthItem)
   return l_asBinaryString
 end
 converter.disassembleData = disassembleData
 
+-- Read functions for each simple use case
+local readConverters = {
+  BooleanT = function(data)
+    if string.unpack("B", data) == 0 then
+      return false
+    else
+      return true
+    end
+  end,
+  IntegerT = function(data)
+    return string.unpack(">i" .. #data, data)
+  end,
+  UIntegerT = function(data)
+    return string.unpack(">I" .. #data, data)
+  end,
+  Float32T = function(data)
+    return string.unpack(">f", data)
+  end,
+  StringT = function(data)
+    local l_zeroTermination = string.find(data, utf8.char(0))
+    if l_zeroTermination then
+      return string.sub(data, 1, l_zeroTermination - 1)
+    else
+      return data
+    end
+  end,
+  OctetStringT = function(data)
+    local l_zeroTermination = string.find(data, utf8.char(0))
+    if l_zeroTermination then
+      return string.sub(data, 1, l_zeroTermination - 1)
+    else
+      return data
+    end
+  end
+}
+
+-- Function for reading a subindex
+local function getSimpleSubindexReadFunction(dataPointInfo, bitLength)
+  local functionToReturn
+  if tonumber(dataPointInfo.bitOffset) % 8 == 0 and getDatatypeBitlength(dataPointInfo) % 8 == 0 and bitLength % 8 == 0 then
+    local startByteNew = bitLength / 8 - dataPointInfo.bitOffset/8 - getDatatypeBitlength(dataPointInfo)/8 + 1
+    local endByteNew = bitLength / 8 - dataPointInfo.bitOffset/8
+    functionToReturn = function(binData)
+      return readConverters[dataPointInfo.type](string.sub(binData, startByteNew, endByteNew))
+    end
+  else
+    local bitOffset = tonumber(dataPointInfo.bitOffset)
+    local bitLength = getDatatypeBitlength(dataPointInfo)
+    functionToReturn = function(binData)
+      return readConverters[dataPointInfo.type](disassembleData(binData, bitOffset, bitLength))
+    end
+  end
+  return functionToReturn
+end
+
+-- Function with no bitwise operations in case the type is simple
+local function getSimpleIndexReadFunction(dataPointInfo)
+  local functionToReturn = function(binData)
+    return readConverters[dataPointInfo.type](binData)
+  end
+  return functionToReturn
+end
+
+-- Gets the fastest and simpliest function for each selected parameter
+local function getParameterReadFunctions(parameterInfo)
+  local parameterReadFunctions = {}
+  if parameterInfo.info.type == 'ArrayT' or parameterInfo.info.type == 'RecordT' then
+    for subindexId, subindexinfo in pairs(parameterInfo.subindeces) do
+      parameterReadFunctions[subindexId] = {
+        value = getSimpleSubindexReadFunction(subindexinfo.info, parameterInfo.info.BitLength)
+      }
+    end
+  else
+    parameterReadFunctions.value = getSimpleIndexReadFunction(parameterInfo.info)
+  end
+  return parameterReadFunctions
+end
+converter.getParameterReadFunctions = getParameterReadFunctions
+
+
 -------------------------------------------------------------------------------------
 -- Convert a raw binary data from IO-Link device to a meaningful Lua table
 local function getReadServiceDataResult(binData, parameterInfo)
@@ -179,6 +250,7 @@ local function getReadServiceDataResult(binData, parameterInfo)
   elseif parameterInfo.Datatype.type == 'RecordT' then
     for _, SingleItem in ipairs(parameterInfo.Datatype.RecordItem) do
       local binaryData = disassembleData(binData, tonumber(SingleItem.bitOffset), getDatatypeBitlength(SingleItem.Datatype))
+
       Result[SingleItem.Name] = {
         value = toDataType(binaryData, SingleItem.Datatype.type)
       }
@@ -206,7 +278,6 @@ local function getReadProcessDataResult(binData, processDataInfo)
 end
 converter.getReadProcessDataResult = getReadProcessDataResult
 
-
 --Return a JSON payload of expacted format filled with null values in case reading of a Parameter has failed 
 local function getFailedReadServiceDataResult(parameterInfo)
   local Result = {}
@@ -316,7 +387,7 @@ local function getComplexServiceDataToWrite(parameterInfo, data)
     local byteLength = math.ceil(getDatatypeBitlength(parameterInfo.Datatype) / 8)
     if parameterInfo.Datatype.type == 'ArrayT' then
       bitArray = makeEmptyBitArray(getDatatypeBitlength(parameterInfo.Datatype))
-      
+
       local simpleDataBitLength = getDatatypeBitlength(parameterInfo.Datatype.Datatype)
       local bitIndexer = 0
       for i = 1, tonumber(parameterInfo.Datatype.count) do
@@ -340,7 +411,7 @@ local function getComplexServiceDataToWrite(parameterInfo, data)
           getDatatypeBitlength(SingleItem.Datatype)
         )
       end
-      local json = require('Communication/MultiIOLinkSMI/helper/Json')
+
     end
     local bin = ''
     for i = 1, byteLength do

README.md

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