v1.0.0

Initial version

---------

Co-authored-by: Roy Gollub <roy.gollub@sick.de>

Author: teplymaSICKAG

CHANGELOG.md

@@ -1,14 +1,5 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## Release 0.1.0
+## Release 1.0.0
 - Initial commit
-
-### New features
-- ...
-
-### Improvements
-- ...
-
-### Bugfix
-- ...

CSK_Module_MultiIOLinkSMI/pages/pages/CSK_Module_MultiIOLinkSMI/CSK_Module_MultiIOLinkSMI.css

@@ -4,6 +4,8 @@
   border-color: grey;
   margin: 6px;
 }
-
+.marginTop {
+  margin-top: 1.5rem
+}
 .myCustomCssClass_CSK_Module_MultiIOLinkSMI {
 }

CSK_Module_MultiIOLinkSMI/pages/pages/CSK_Module_MultiIOLinkSMI/CSK_Module_MultiIOLinkSMI.html

@@ -1,3 +1,27 @@
 export function convertToList(value) {
   return JSON.parse(value)
-}
+}
+
+export function extractFilenames(files: FileList): Array<string> {
+  if(files === null || files == undefined) {
+    return []
+  }
+  const fileNames = [];
+  for (const file of files) {
+    fileNames.push(file.name);
+  }
+  return fileNames;
+}
+
+export function bool2str(newbool){
+  var myString: string = String(newbool);
+  return myString
+}
+
+export function num2str(newnum){
+  return String(newnum)
+}
+
+export function str2num(newstr){
+  return Number(newstr)
+}

CSK_Module_MultiIOLinkSMI/pages/src/converter.ts

@@ -20,24 +20,21 @@
 --OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 --SOFTWARE.
 
----@diagnostic disable: undefined-global, redundant-parameter, missing-parameter
+-- luacheck: no max line length
 
--- 
--- CreationTemplateVersion: 3.6.0
 --**************************************************************************
 --**********************Start Global Scope *********************************
 --**************************************************************************
-
--- If app property "LuaLoadAllEngineAPI" is FALSE, use this to load and check for required APIs
+-- If App property "LuaLoadAllEngineAPI" is FALSE, use this to load and check for required APIs
 -- This can improve performance of garbage collection
+_G.availableAPIs = require('Communication/MultiIOLinkSMI/helper/checkAPIs') -- can be used to adjust function scope of the module related on available APIs of the device
 
--- _G.availableAPIs = require('Communication/MultiIOLinkSMI/helper/checkAPIs') -- can be used to adjust function scope of the module related on available APIs of the device
 -----------------------------------------------------------
 -- Logger
 _G.logger = Log.SharedLogger.create('ModuleLogger')
 _G.logHandle = Log.Handler.create()
 _G.logHandle:attachToSharedLogger('ModuleLogger')
-_G.logHandle:setConsoleSinkEnabled(false) --> Set to TRUE if CSK_Logger is not used
+_G.logHandle:setConsoleSinkEnabled(false) --> Set to TRUE if LoggingModule is not used
 _G.logHandle:setLevel("ALL")
 _G.logHandle:applyConfig()
 -----------------------------------------------------------
@@ -47,64 +44,81 @@ _G.logHandle:applyConfig()
 local multiIOLinkSMI_Model = require('Communication/MultiIOLinkSMI/MultiIOLinkSMI_Model')
 
 local multiIOLinkSMI_Instances = {} -- Handle all instances
-table.insert(multiIOLinkSMI_Instances, multiIOLinkSMI_Model.create(1)) -- Create at least 1 instance
 
 -- Load script to communicate with the MultiIOLinkSMI_Model UI
 -- Check / edit this script to see/edit functions which communicate with the UI
 local multiIOLinkSMIController = require('Communication/MultiIOLinkSMI/MultiIOLinkSMI_Controller')
-multiIOLinkSMIController.setMultiIOLinkSMI_Instances_Handle(multiIOLinkSMI_Instances) -- share handle of instances
+
+if _G.availableAPIs.ioLinkSmi and Engine.getEnumValues('IOLinkMasterPorts') ~= nil then
+  _G.logger:info("IOLinkSMI API Support = true")
+  table.insert(multiIOLinkSMI_Instances, multiIOLinkSMI_Model.create(1))
+  multiIOLinkSMIController.setMultiIOLinkSMI_Instances_Handle(multiIOLinkSMI_Instances) -- share handle of instances
+else
+  _G.logger:warning("CSK_MultiIOLinkSMI: Features of this module are not supported on this device. Missing APIs.")
+end
 
 --**************************************************************************
 --**********************End Global Scope ***********************************
 --**************************************************************************
 --**********************Start Function Scope *******************************
 --**************************************************************************
 
---[[
---- Function to show how this module could be used
-local function startProcessing()
-
-  CSK_MultiIOLinkSMI.setSelectedInstance(1) --> select instance of module
-  CSK_MultiIOLinkSMI.doSomething() --> preparation
-
-  -- Option A --> prepare an event to trigger processing via this one
-  --Script.serveEvent("CSK_MultiIOLinkSMI.OnNewTestEvent", "MultiIOLinkSMI_OnNewTestEvent") --> Create event to listen to and process forwarded object
-  --CSK_MultiIOLinkSMI.setRegisterEvent('CSK_MultiIOLinkSMI.OnNewTestEvent') --> Register processing to the event
-
-  --Script.notifyEvent('OnNewTestEvent', data)
-
-    -- Option B --> trigger processing via function call
-    local result = CSK_MultiIOLinkSMI.processSomething(data)
-
-  end
-end
-
--- Call processing function after persistent data was loaded
---Script.register("CSK_MultiIOLinkSMI.OnDataLoadedOnReboot", startProcessing)
-]]
-
---OR
-
---- Function to react on startup event of the app
 local function main()
 
-  multiIOLinkSMIController.setMultiIOLinkSMI_Model_Handle(multiIOLinkSMI_Model) -- share handle of Model
-
-  ----------------------------------------------------------------------------------------
+  if _G.availableAPIs.ioLinkSmi then
+    multiIOLinkSMIController.setMultiIOLinkSMI_Model_Handle(multiIOLinkSMI_Model) -- share handle of model
+    CSK_MultiIOLinkSMI.setSelectedInstance(1)
+    CSK_MultiIOLinkSMI.pageCalled()
+  end
+    ----------------------------------------------------------------------------------------
   -- INFO: Please check if module will eventually load inital configuration triggered via
   --       event CSK_PersistentData.OnInitialDataLoaded
-  --       (see internal variable _G.multiIOLinkSMI_Model.parameterLoadOnReboot)
+  --       (see internal variable _G.deepLearningObjects.parameterLoadOnReboot)
   --       If so, the app will trigger the "OnDataLoadedOnReboot" event if ready after loading parameters
   --
   -- Can be used e.g. like this
+  --
+  --[[
+  CSK_MultiIOLinkSMI.setSelectedInstance(1)
+  CSK_MultiIOLinkSMI.setPort('S1')
+  CSK_MultiIOLinkSMI.activateInstance(true)
+  -- Optionally register to 'OnNewPortEvent'-event
+
+  local deviceIdentification = CSK_MultiIOLinkSMI.getDeviceIdentification('S1')
+  CSK_MultiIOLinkSMI.applyNewDeviceIdentification(deviceIdentification)
+  -- Optionally register to 'CSK_MultiIOLinkSMI.OnNewDeviceIdentificationApplied'-event
+
+  -- Read message handling
+  CSK_MultiIOLinkSMI.createIODDReadMessage()
+  CSK_MultiIOLinkSMI.setIODDReadMessageName('readMessageTitle')
+  CSK_MultiIOLinkSMI.setSelectedIODDReadMessage('readMessageTitle')
+  -- Register to "CSK_MultiIOLinkSMI.readMessage[port][readMessageTitle]"-event
+
+  -- Write message handling
+  CSK_MultiIOLinkSMI.createIODDWriteMessage()
+  CSK_MultiIOLinkSMI.setIODDWriteMessageName('writeMessageTitle')
+  CSK_MultiIOLinkSMI.setSelectedIODDWriteMessage('writeMessageTitle')
+  -- Register to "CSK_MultiIOLinkSMI.writeMessage[port][writeMessageName]"-event
+
+  -- Direct data reading
+  local readProcessDataSuccess, readProcessDataResult = CSK_MultiIOLinkSMI.readProcessData()
+  local readParameterSuccess, readParameterResult = CSK_MultiIOLinkSMI.readParameter(index, subindex)
+  local resultProcessByteArray = CSK_MultiIOLinkSMI.readProcessDataByteArray()
+  local resultParameterByteArray = CSK_MultiIOLinkSMI.readParameterByteArray(index, subindex)
+  local success1, jsonReceivedData = CSK_MultiIOLinkSMI.readIODDMessage('messageName') -- after defining a read message in UI or IODD module
+
+  -- Direct data writing
+  local writeSuccess = CSK_MultiIOLinkSMI.writeProcessData(jsonDataToWrite)
+  local success2, errorDescription1 = CSK_MultiIOLinkSMI.writeParameter(index, subindex, byteArrayToWrite)
+  local success3, errorDescription2 = CSK_MultiIOLinkSMI.writeProcessDataByteArray(byteArrayToWrite)
+  local success4, errorDescription3 = CSK_MultiIOLinkSMI.writeParameterByteArray(index, subindey, byteArrayToWrite)
+  local success5 = CSK_MultiIOLinkSMI.writeIODDMessage(messageName, jsonDataToWrite) -- after defining a write message in UI or IODD module
+  ]]
   ----------------------------------------------------------------------------------------
 
-  --startProcessing() --> see above
-  CSK_MultiIOLinkSMI.pageCalled() -- Update UI
-
 end
 Script.register("Engine.OnStarted", main)
 
 --**************************************************************************
 --**********************End Function Scope *********************************
---**************************************************************************
+--**************************************************************************