Document metadata
Application name |
CSK_Module_IODDInterpreter |
---|---|
Version |
2.1.2 |
Date |
2025-01-22 |
Author |
SICK AG |
Crowns
CSK_IODDInterpreter
Short description
Module to interpret IODD files for further use by CSK_Module_MultiIOLinkSMI, CSK_Module_MultiIOLinkRestMaster and for your customized app.
The main externally useful features are following:
1. IODD Files upload and interpretation
Use "addIODDFile" function to interpret the IODD XML file.
Or use "Upload IODD XML" button in UI and select XML file to upload.
IODD Files (.xml) and their interpretations (.json) are stored in public/IODDFiles.
To delete IODD file from internal memory, use "setSelectedIODDToHandle" and "deleteIODD"
2. IODD File - device match check
Use "findIODDMatchingProductName" and "findIODDMatchingVendorIdDeviceIdVersion" to check if there is a loaded IODD file that matches your device already.
3. Multiple instances handling
Instance ID is a string name to make it easier for external use since this module might be used by several other modules / applications.
Assign IODD file to be used by the instance via "setSelectedIODD". Use "addInstance", "setInstanceName" and "deleteInstance" to create, rename and delete the instance.
4. Dynamic tables representing process data and parameters
All parameters and process data are devided in two sets:
a) Read Data - consists of Process Data In table and Parameters (read only + read/write) table
b) Write Data - consists of Process Data Out table and Parameters (write only + read/write) table
The rows of the tables can be selected to form a set of data (message) to be read or written from/to the device.
When a row of the table is selected, the following events are triggered to provide new set of data externally:
a) Read Data - "OnNewReadDataJsonTemplateAndInfo"
b) Write Data - "OnNewWriteDataJsonTemplateAndInfo"
5. Process data structure selection
Process data structure of IO-Link device might be variable. The structure depends on a value of some parameter. In case process data is variable, use following:
- "getProcessDataConditionList" - to get list of possible options
- "changeProcessDataStructureOptionName" or "changeProcessDataStructureOptionValue" to change structure with string name or parameter’s value
When the process data structure is changed, the respective process data tables are updated and selected process data in the existing messages is reset.
6. Data point information
Module can provide chunks of IODD file in JSON format to describe some datapoints you need. Use the following functions to get information about datapoints:
- "getProcessDataInInfo" - process data in (with current process data structure option)
- "getProcessDataOutInfo" - process data out (with current process data structure option)
- "getParameterDataPointInfo" - any parameter with specified index and subindex
- "getProcessDataConditionInfo" - parameter responsible for changing the process data structure (if it is variable)
Overview
Functions
addInstance()
Short description
Create a new IODD instance with default instance ID (string name).
Sample (auto-generated)
CSK_IODDInterpreter.addInstance()
addIODDFile()
Short description
Add a new IODD file to be interpreted. Returns success of interpretation and new internal name of IODD file created according to IODD file name standard.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
path |
STRING |
1 |
Path to a temporary IODD file. The file will be deleted after interpretation attempt. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Interpretation success. |
result |
STRING |
1 |
If interpretation is successful, returns a standartized IODD file name that is used for the uploaded IODD file. Else returns a reason of interpretation failure. |
Sample (auto-generated)
success, result = CSK_IODDInterpreter.addIODDFile(path)
changeProcessDataStructureOptionName()
Short description
Change process data structure of IODD instance to start using new process data desciption internally.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
newPDStructureOptionName |
STRING |
1 |
String process data structure name option from IODD file. |
Sample (auto-generated)
CSK_IODDInterpreter.changeProcessDataStructureOptionName(newPDStructureOptionName)
changeProcessDataStructureOptionValue()
Short description
Change process data structure of IODD instance to start using new process data desciption internally.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
newPDStructureOptionValue |
AUTO |
1 |
Process data structure value option from IODD file. |
Sample (auto-generated)
CSK_IODDInterpreter.changeProcessDataStructureOptionValue(newPDStructureOptionValue)
copyInstanceSelectedTable()
Short description
Function to copy the selected tables content from one instance to another. Can be used to speed up integration.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
fromInstanceId |
STRING |
1 |
|
toInstanceId |
STRING |
1 |
Sample (auto-generated)
CSK_IODDInterpreter.copyInstanceSelectedTable(fromInstanceId, toInstanceId)
copyReadDataMessage()
Short description
Function to copy the selected tables content of read data (both process data in and read parameters) of the selected instance. Can be used to speed up integration. The "pasteReadDataMessage" function must be used afterwards.
Sample (auto-generated)
CSK_IODDInterpreter.copyReadDataMessage()
copyWriteDataMessage()
Short description
Function to copy the selected tables content of write data (both process data out and write parameters) of the selected instance. Can be used to speed up integration. The "pasteWriteDataMessage" function must be used afterwards.
Sample (auto-generated)
CSK_IODDInterpreter.copyWriteDataMessage()
deleteInstance()
Short description
Delete the selected IODD instance.
Sample (auto-generated)
CSK_IODDInterpreter.deleteInstance()
deleteIODD()
Short description
Delete IODD file from internal memory. Deletes all IODD instances that use this file as well.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Success of deleting. |
result |
STRING |
1 |
Reason if deleting failed. |
Sample (auto-generated)
success, result = CSK_IODDInterpreter.deleteIODD()
findIODDMatchingProductName()
Short description
Checks if there is a loaded IODD file for the device with matching product name.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
productName |
STRING |
1 |
Product name of the device. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
True if the matching file is found. |
result |
STRING |
1 |
Name of IODD file if match is found. |
Sample (auto-generated)
success, result = CSK_IODDInterpreter.findIODDMatchingProductName(productName)
findIODDMatchingVendorIdDeviceIdVersion()
Short description
Checks if there is a loaded IODD file for the device with matching vendor ID, device ID and (optional) IODD version.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
vendorId |
AUTO |
1 |
Vendor ID. |
deviceId |
AUTO |
1 |
Device ID. |
version |
AUTO |
? |
Optional IODD version. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
True if matching IODD file is found. |
result |
STRING |
1 |
IODD file name if match is found. |
Sample (auto-generated)
success, result = CSK_IODDInterpreter.findIODDMatchingVendorIdDeviceIdVersion(vendorId, deviceId, version)
getIODDList()
Short description
Get list of loaded IODD files.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
ioddList |
STRING |
* |
String array with names of loaded IODD files. |
Sample (auto-generated)
ioddList = CSK_IODDInterpreter.getIODDList()
getIsProcessDataVariable()
Short description
Check if process data structure of the selected IODD file is variable or not.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
isVariable |
BOOL |
1 |
True if process data structure is variable. |
Sample (auto-generated)
isVariable = CSK_IODDInterpreter.getIsProcessDataVariable()
getParameterDataPointInfo()
Short description
Get IODD description of a single parameter.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
instanceId |
STRING |
1 |
Instance name. |
index |
INT |
1 |
Index of the parameter. |
subindex |
INT |
1 |
Subindex of the parameter. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonDataPointInfo |
STRING |
? |
JSON object with description of index or subindex of the parameter. Nil if the parameter does not exist. |
Sample (auto-generated)
jsonDataPointInfo = CSK_IODDInterpreter.getParameterDataPointInfo(instanceId, index, subindex)
getParameters()
Short description
Function to get all parameters of the client in JSON format.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonParameters |
STRING |
1 |
JSON string with all parameters. |
Sample (auto-generated)
jsonParameters = CSK_IODDInterpreter.getParameters()
getProcessDataConditionInfo()
Short description
Get IODD description of a parameter resposible for changing of process data structure if it is variable.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonProcessDataConditionInfo |
STRING |
1 |
JSON object with description of index or subindex of the parameter. |
Sample (auto-generated)
jsonProcessDataConditionInfo = CSK_IODDInterpreter.getProcessDataConditionInfo()
getProcessDataConditionList()
Short description
Get list of process data structure options.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonProcessDataConditionList |
STRING |
1 |
JSON list of options. |
Sample (auto-generated)
jsonProcessDataConditionList = CSK_IODDInterpreter.getProcessDataConditionList()
getProcessDataConditionNameFromValue()
Short description
Get process data struccture option name matching the value of the parameter responsible for changing the structure.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
conditionValue |
STRING |
1 |
Value of the parameter. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
conditionName |
STRING |
1 |
Name of the process data structure option. |
Sample (auto-generated)
conditionName = CSK_IODDInterpreter.getProcessDataConditionNameFromValue(conditionValue)
getProcessDataConditionValueFromName()
Short description
Get value of the parameter responsible for changing the structure matching the process data struccture option name.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
conditionName |
STRING |
1 |
Name of the process data structure option. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
conditionValue |
STRING |
1 |
Value of the parameter. |
Sample (auto-generated)
conditionValue = CSK_IODDInterpreter.getProcessDataConditionValueFromName(conditionName)
getProcessDataInInfo()
Short description
Get IODD description of process data in (for reading from device).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonProcessDataInInfo |
STRING |
1 |
JSON object with description of process data in. |
Sample (auto-generated)
jsonProcessDataInInfo = CSK_IODDInterpreter.getProcessDataInInfo()
getProcessDataOutInfo()
Short description
JSON object with description of process data out (for writing to device).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonProcessDataOutInfo |
STRING |
1 |
JSON object with description of process data out. |
Sample (auto-generated)
jsonProcessDataOutInfo = CSK_IODDInterpreter.getProcessDataOutInfo()
getReadDataTableContents()
Short description
Function to get content information of the selected read data.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
prefix |
STRING |
? |
Optional prefix to be removed from column names. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
processDataTableContent |
STRING |
1 |
JSON content of process data in table. |
parameterTableContent |
STRING |
1 |
JSON content of read parameters table. |
Sample (auto-generated)
processDataTableContent, parameterTableContent = CSK_IODDInterpreter.getReadDataTableContents(prefix)
getSelectedProcessDataIn()
Short description
Get table with selected datapoints of process data in.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedProcessDataIn |
STRING |
? |
JSON object with information about selected datapoints. |
Sample (auto-generated)
jsonSelectedProcessDataIn = CSK_IODDInterpreter.getSelectedProcessDataIn()
getSelectedProcessDataOut()
Short description
Get table with selected datapoints of process data out.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedProcessDataOut |
STRING |
? |
JSON object with information about selected datapoints. |
Sample (auto-generated)
jsonSelectedProcessDataOut = CSK_IODDInterpreter.getSelectedProcessDataOut()
getSelectedReadParameters()
Short description
Get table with selected parameters datapoints for reading.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedReadParameters |
STRING |
? |
JSON object with information about selected datapoints. |
Sample (auto-generated)
jsonSelectedReadParameters = CSK_IODDInterpreter.getSelectedReadParameters()
getSelectedWriteParameters()
Short description
Get table with selected parameters datapoints for writing.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedWriteParameters |
STRING |
? |
JSON object with information about selected datapoints. |
Sample (auto-generated)
jsonSelectedWriteParameters = CSK_IODDInterpreter.getSelectedWriteParameters()
getStatusModuleActive()
Short description
Function to get status if module is active.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
status = CSK_IODDInterpreter.getStatusModuleActive()
getWriteDataTableContents()
Short description
Function to get content information of the selected write data.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
prefix |
STRING |
? |
Optional prefix to be removed from column names. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
processDataTableContent |
STRING |
1 |
JSON content of process data out table. |
parameterTableContent |
STRING |
1 |
JSON content of write parameters table. |
Sample (auto-generated)
processDataTableContent, parameterTableContent = CSK_IODDInterpreter.getWriteDataTableContents(prefix)
loadInstancesListParameters()
Short description
Function to load only instances that belong to some sensor that is being loaded in external app.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
parameterName |
STRING |
1 |
Name of the saved parameters |
Sample (auto-generated)
CSK_IODDInterpreter.loadInstancesListParameters(parameterName)
loadParameters()
Short description
Load parameters for this module from the CSK_PersistentData module if possible and use them.
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Success to load parameters. |
Sample (auto-generated)
success = CSK_IODDInterpreter.loadParameters()
pageCalledInstances()
Short description
Function to register "On Resume" of the ModuleName_Model UI ( (only helper function).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
empty |
STRING |
1 |
Empty string. |
Sample (auto-generated)
empty = CSK_IODDInterpreter.pageCalledInstances()
pageCalledReadData()
Short description
Function to register "On Resume" of the module UI (only as helper function).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
empty |
STRING |
1 |
Empty string (only needed to simplify binding). |
Sample (auto-generated)
empty = CSK_IODDInterpreter.pageCalledReadData()
pageCalledWriteData()
Short description
Function to register "On Resume" of the ModuleName_Model UI ( (only helper function).
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
empty |
STRING |
1 |
Empty string. |
Sample (auto-generated)
empty = CSK_IODDInterpreter.pageCalledWriteData()
pasteReadDataMessage()
Short description
Function to paste the copied tables content of read data (both process data in and read parameters) to the selected instance. Can be used to speed up integration. The "copyReadDataMessage" function must be used before.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
CSK_IODDInterpreter.pasteReadDataMessage(jsonTemplate, jsonDataInfo)
pasteWriteDataMessage()
Short description
Function to paste the copied tables content of write data (both process data out and write parameters) to the selected instance. Can be used to speed up integration. The "copyWriteDataMessage" function must be used before.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
CSK_IODDInterpreter.pasteWriteDataMessage(jsonTemplate, jsonDataInfo)
processDataInRowSelected()
Short description
Function to process the selected row in process data in dynamic table that was selected in another CSK module.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
prefix |
STRING |
? |
Optional prefix to be removed from column names. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
jsonTemplate, jsonDataInfo = CSK_IODDInterpreter.processDataInRowSelected(jsonSelectedRow, prefix)
processDataInRowSelectedUI()
Short description
Function to process the selected row of process data in dynamic table in UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
Sample (auto-generated)
CSK_IODDInterpreter.processDataInRowSelectedUI(jsonSelectedRow)
processDataOutRowSelected()
Short description
Function to process the selected row in process data out dynamic table in UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
prefix |
STRING |
? |
Optional prefix to be reemoved from column names. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
jsonTemplate, jsonDataInfo = CSK_IODDInterpreter.processDataOutRowSelected(jsonSelectedRow, prefix)
processDataOutRowSelectedUI()
Short description
Function to process the selected row of process data out dynamic table in UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
Sample (auto-generated)
CSK_IODDInterpreter.processDataOutRowSelectedUI(jsonSelectedRow)
readParameterRowSelected()
Short description
Function to process the selected row of read parameters dynamic table in UI of external app.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
prefix |
STRING |
? |
Optional prefix to be removed from column names. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
jsonTemplate, jsonDataInfo = CSK_IODDInterpreter.readParameterRowSelected(jsonSelectedRow, prefix)
readParameterRowSelectedUI()
Short description
Function to process the selected row of read parameters dynamic table in UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
Sample (auto-generated)
CSK_IODDInterpreter.readParameterRowSelectedUI(jsonSelectedRow)
selectAllProcessDataIn()
Short description
Function to select or deselect all availalbe process data in datapoints the sensor.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True for selecting, false for deselecting. |
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
CSK_IODDInterpreter.selectAllProcessDataIn(state, jsonTemplate, jsonDataInfo)
selectAllProcessDataOut()
Short description
Function to select or deselect all availalbe process data out datapoints the sensor.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True for selecting, false for deselecting. |
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
CSK_IODDInterpreter.selectAllProcessDataOut(state, jsonTemplate, jsonDataInfo)
selectAllReadParameters()
Short description
Function to select or deselect all availalbe read parameters of the sensor.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True for selecting, false for deselecting. |
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
CSK_IODDInterpreter.selectAllReadParameters(state, jsonTemplate, jsonDataInfo)
selectAllWriteParameters()
Short description
Function to select or deselect all availalbe write parameters of the sensor.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
state |
BOOL |
1 |
True for selecting, false for deselecting. |
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
CSK_IODDInterpreter.selectAllWriteParameters(state, jsonTemplate, jsonDataInfo)
sendInstancesListParameters()
Short description
Function to save only instances that belong to some sensor that is being saved in external app.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
parameterName |
STRING |
1 |
Name of the saved parameters |
instancesList |
STRING |
* |
List of the instances that belong to the sensor |
Sample (auto-generated)
CSK_IODDInterpreter.sendInstancesListParameters(parameterName, instancesList)
sendParameters()
Short description
Send parameters to CSK_PersistentData module if possible to save them.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
noDataSave |
BOOL |
? |
[Optional] Set to TRUE if the data should NOT be saved immediately after sending. |
Sample (auto-generated)
CSK_IODDInterpreter.sendParameters(noDataSave)
setInstanceName()
Short description
Function to change the instance id (name).
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
newInstanceName |
STRING |
1 |
New unique name of the selected instance. |
Sample (auto-generated)
CSK_IODDInterpreter.setInstanceName(newInstanceName)
setLoadOnReboot()
Short description
Configure if this module should load its saved parameters at app/device boot up.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_IODDInterpreter.setLoadOnReboot(status)
setParameterName()
Short description
Function to set the name of the parameters if saved/loaded via the CSK_PersistentData module.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Name of the parameter. |
Sample (auto-generated)
CSK_IODDInterpreter.setParameterName(name)
setReadSelectedData()
Short description
Set selected read data datapoints externally both for process data in and parameters.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonReadDataInfo |
STRING |
1 |
JSON object with selected data points for process data (ProcessData) and for parameters (Parameters). |
Sample (auto-generated)
CSK_IODDInterpreter.setReadSelectedData(jsonReadDataInfo)
setSelectedInstance()
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
newSelectedInstance |
STRING |
1 |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
success |
BOOL |
1 |
Sample (auto-generated)
success = CSK_IODDInterpreter.setSelectedInstance(newSelectedInstance)
setSelectedIODD()
Short description
Set IODD file used in the selected instance.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
ioddName |
STRING |
1 |
Standartised IODD name. |
Sample (auto-generated)
CSK_IODDInterpreter.setSelectedIODD(ioddName)
setSelectedIODDToHandle()
Short description
Set IODD to edit (delete).
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
newSelectedIODDToHandle |
STRING |
1 |
IODD name. |
Sample (auto-generated)
CSK_IODDInterpreter.setSelectedIODDToHandle(newSelectedIODDToHandle)
setWriteSelectedData()
Short description
Set selected read data datapoints externally both for process data out and parameters.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonWriteDataInfo |
STRING |
1 |
JSON object with selected data points for process data (ProcessData) and for parameters (Parameters). |
Sample (auto-generated)
CSK_IODDInterpreter.setWriteSelectedData(jsonWriteDataInfo)
uploadFinished()
Short description
Function called when IODD file upload is finished in UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
uploadSuccess |
BOOL |
1 |
Upload success. |
Sample (auto-generated)
CSK_IODDInterpreter.uploadFinished(uploadSuccess)
writeParameterRowSelected()
Short description
Function to process the selected row of write parameters dynamic table in UI of external app.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
prefix |
STRING |
? |
Optional prefix to be removed from column names. |
Return values
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonTemplate |
STRING |
1 |
JSON template of new combined message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
jsonTemplate, jsonDataInfo = CSK_IODDInterpreter.writeParameterRowSelected(jsonSelectedRow, prefix)
writeParameterRowSelectedUI()
Short description
Function to process the selected row in write parameters dynamic table in UI.
Parameters
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonSelectedRow |
STRING |
1 |
JSON row data. |
Sample (auto-generated)
CSK_IODDInterpreter.writeParameterRowSelectedUI(jsonSelectedRow)
Events
isInstanceSelected
Short description
Event to notify if any instance is selected to show additional settings in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
isSelected |
BOOL |
1 |
True if instance is selected. |
Sample (auto-generated)
function handleisInstanceSelected(isSelected)
-- Do something
end
Script.register("CSK_IODDInterpreter.isInstanceSelected", "handleisInstanceSelected")
isProcessDataStructureVariable
Short description
Event to notify if process data is variable to show additional settings in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
IsProcessDataStructureVariable |
BOOL |
1 |
True if process data is variable. |
Sample (auto-generated)
function handleisProcessDataStructureVariable(IsProcessDataStructureVariable)
-- Do something
end
Script.register("CSK_IODDInterpreter.isProcessDataStructureVariable", "handleisProcessDataStructureVariable")
OnDataLoadedOnReboot
Short description
Event to call if module tried to load parameters and should be ready.
Sample (auto-generated)
function handleOnDataLoadedOnReboot()
-- Do something
end
Script.register("CSK_IODDInterpreter.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
OnIODDListChanged
Short description
Event to notify if IODD file was deleted or a new IODD file was successfully uploaded.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
listIODD |
STRING |
* |
New list with standartised names of available IODDs. |
Sample (auto-generated)
function handleOnIODDListChanged(listIODD)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnIODDListChanged", "handleOnIODDListChanged")
OnNewCalloutType
Short description
Event to notify a type of callout in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
Type |
STRING |
1 |
Callout type, |
Sample (auto-generated)
function handleOnNewCalloutType(Type)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewCalloutType", "handleOnNewCalloutType")
OnNewCalloutValue
Short description
Event to notify a value of callout in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
Value |
STRING |
1 |
Callout value. |
Sample (auto-generated)
function handleOnNewCalloutValue(Value)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewCalloutValue", "handleOnNewCalloutValue")
OnNewInstanceName
Short description
Event to show the name of selected instance in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
instanceName |
STRING |
1 |
Name of the instance. |
Sample (auto-generated)
function handleOnNewInstanceName(instanceName)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewInstanceName", "handleOnNewInstanceName")
OnNewListIntances
Short description
Event to share the list of all instances names.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonIntancesList |
STRING |
1 |
List of all names in JSON format. |
Sample (auto-generated)
function handleOnNewListIntances(jsonIntancesList)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewListIntances", "handleOnNewListIntances")
OnNewListIODD
Short description
Event to share list of all loaded IODD files.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
jsonIODDList |
STRING |
1 |
List of all names in JSON format. |
Sample (auto-generated)
function handleOnNewListIODD(jsonIODDList)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewListIODD", "handleOnNewListIODD")
OnNewParameterName
Short description
Notify name of persistent data parameter.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
name |
STRING |
1 |
Parameter name |
Sample (auto-generated)
function handleOnNewParameterName(name)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewParameterName", "handleOnNewParameterName")
OnNewProcessDataInTableContent
Short description
Event to fill the process data in dynamic table in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProcessDataInTableContent |
STRING |
1 |
JSON object with table content. |
Sample (auto-generated)
function handleOnNewProcessDataInTableContent(ProcessDataInTableContent)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewProcessDataInTableContent", "handleOnNewProcessDataInTableContent")
OnNewProcessDataOutTableContent
Short description
Event to fill the process data out dynamic table in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProcessDataOutTableContent |
STRING |
1 |
JSON object with table content. |
Sample (auto-generated)
function handleOnNewProcessDataOutTableContent(ProcessDataOutTableContent)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewProcessDataOutTableContent", "handleOnNewProcessDataOutTableContent")
OnNewProcessDataStructureOptionsDropdownContent
Short description
Event to share list of process data structure options if process data is variable.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
ProcessDataStructureOptionsDropdownContent |
STRING |
1 |
JSON object with list of process data structure options. |
Sample (auto-generated)
function handleOnNewProcessDataStructureOptionsDropdownContent(ProcessDataStructureOptionsDropdownContent)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewProcessDataStructureOptionsDropdownContent", "handleOnNewProcessDataStructureOptionsDropdownContent")
OnNewReadDataJsonTemplateAndInfo
Short description
Event to notify when selected read datapoints (process data in and parameters) has changed. Might be useful externally.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
instanceId |
STRING |
1 |
Instance name. |
jsonTemplate |
STRING |
1 |
JSON template of new combined read message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
function handleOnNewReadDataJsonTemplateAndInfo(instanceId, jsonTemplate, jsonDataInfo)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewReadDataJsonTemplateAndInfo", "handleOnNewReadDataJsonTemplateAndInfo")
OnNewReadParametersTableContent
Short description
Event to fill the read parameters dynamic table in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
TableContent |
STRING |
1 |
JSON object with table content. |
Sample (auto-generated)
function handleOnNewReadParametersTableContent(TableContent)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewReadParametersTableContent", "handleOnNewReadParametersTableContent")
OnNewSelectedInstance
Short description
Event to notify the selected instance name.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
selectedInstance |
STRING |
1 |
Instance name. |
Sample (auto-generated)
function handleOnNewSelectedInstance(selectedInstance)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewSelectedInstance", "handleOnNewSelectedInstance")
OnNewSelectedIODD
Short description
Event to notify the IODD name used by selected instance.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
selectedIODD |
STRING |
1 |
Name of the IODD file. |
Sample (auto-generated)
function handleOnNewSelectedIODD(selectedIODD)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewSelectedIODD", "handleOnNewSelectedIODD")
OnNewSelectedIODDToHandle
Short description
Event to notify the selected IODD name of a file to be edited (deleted).
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
selectedIODDToHandle |
STRING |
1 |
Name of the IODD file. |
Sample (auto-generated)
function handleOnNewSelectedIODDToHandle(selectedIODDToHandle)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewSelectedIODDToHandle", "handleOnNewSelectedIODDToHandle")
OnNewSelectedProcessDataStructureOption
Short description
Event to notify the selected process data structure option if it is variable.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
SelectedProcessDataStructureOption |
STRING |
1 |
Name of the option. |
Sample (auto-generated)
function handleOnNewSelectedProcessDataStructureOption(SelectedProcessDataStructureOption)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewSelectedProcessDataStructureOption", "handleOnNewSelectedProcessDataStructureOption")
OnNewStatusCSKStyle
Short description
Notify UI style to use for CSK modules.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
theme |
STRING |
1 |
UI style |
Sample (auto-generated)
function handleOnNewStatusCSKStyle(theme)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
OnNewStatusLoadParameterOnReboot
Short description
Notify status if parameters should be loaded on app/device boot up.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusLoadParameterOnReboot(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
OnNewStatusModuleIsActive
Short description
Notify if module can be used on device.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusModuleIsActive(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
OnNewStatusModuleVersion
Short description
Notify version of module.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
version |
STRING |
1 |
Version |
Sample (auto-generated)
function handleOnNewStatusModuleVersion(version)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
OnNewWriteDataJsonTemplateAndInfo
Short description
Event to notify when selected write datapoints (process data out and parameters) has changed. Might be useful externally.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
instanceId |
STRING |
1 |
Instance name. |
jsonTemplate |
STRING |
1 |
JSON template of new combined write message. |
jsonDataInfo |
STRING |
1 |
JSON object with datapoints infos. |
Sample (auto-generated)
function handleOnNewWriteDataJsonTemplateAndInfo(instanceId, jsonTemplate, jsonDataInfo)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewWriteDataJsonTemplateAndInfo", "handleOnNewWriteDataJsonTemplateAndInfo")
OnNewWriteParametersTableContent
Short description
Event to fill the write parameters dynamic table in UI.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
WriteParametersTableContent |
STRING |
1 |
JSON object with table content. |
Sample (auto-generated)
function handleOnNewWriteParametersTableContent(WriteParametersTableContent)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnNewWriteParametersTableContent", "handleOnNewWriteParametersTableContent")
OnPersistentDataModuleAvailable
Short description
Notify status if features of CSK_PersistendData module are available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnPersistentDataModuleAvailable(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
OnUserLevelAdminActive
Short description
Status of Admin userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
OnUserLevelMaintenanceActive
Short description
Status of Maintenance userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
OnUserLevelOperatorActive
Short description
Status of Operator userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
OnUserLevelServiceActive
Short description
Status of Service userlevel. Used internally in combination with the CSK_UserManagement module if available.
Callback arguments
Name | Type | Multiplicity | Description |
---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
-- Do something
end
Script.register("CSK_IODDInterpreter.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")
CSK_Module_IODDInterpreter
Short description
This is an automatically generated CROWN (description not necessary).