Document metadata
Application name |
CSK_Module_FlowConfig |
|---|---|
Version |
2.0.0 |
Date |
2025-12-12 |
Author |
SICK AG |
Crowns
- C
- F
CSK_FlowConfig
Short description
Module to link features of CSK modules supporting the 'CSK FlowConfig'.
It makes use of a BlocksEditor within the UI to take care of the configuration.
Check the UI of this CSK module to configure the system.
Overview
Functions
addLogicBlock()
Short description
Function to internally add logic blocks.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
instance |
STRING |
1 |
Internally set instance identifier. |
logic |
1 |
Logic to use. |
|
source1 |
STRING |
1 |
Source for value1. |
source2 |
STRING |
? |
Optional source for value2. |
criteriaA |
STRING |
? |
Optional criteriaA, used by some operators (see info for logic). |
valueB |
STRING |
? |
Optional valueB, used by some operators (see info for logic). |
Sample (auto-generated)
CSK_FlowConfig.addLogicBlock(instance, logic, source1, source2, criteriaA, valueB)
addTimer()
Short description
Function to add a cyclic timer to trigger events.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
value |
STRING |
1 |
Value to send via event. For 'BOOL' values use "true" or "false" |
valueType |
STRING |
1 |
Type of value to send. |
cycleTime |
INT |
1 |
Cycle time in ms ('0' for single trigger) |
Sample (auto-generated)
CSK_FlowConfig.addTimer(value, valueType, cycleTime)
getFlow()
Short description
Function to process the provided flow received by the UI BlocksEditor.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
flow |
STRING |
1 |
Flow configuration as string. |
Sample (auto-generated)
CSK_FlowConfig.getFlow(flow)
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_FlowConfig.getParameters()
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_FlowConfig.getStatusModuleActive()
loadDemoFlow()
Short description
Function to load demo flow.
Sample (auto-generated)
CSK_FlowConfig.loadDemoFlow()
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_FlowConfig.loadParameters()
openUI()
Short description
Function to get the trigger to open block UI.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
nameOfBlock |
STRING |
1 |
Name of block related CROWN |
Sample (auto-generated)
CSK_FlowConfig.openUI(nameOfBlock)
pageCalled()
Short description
Function to register "OnResume" 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_FlowConfig.pageCalled()
reloadApps()
Short description
Function to reload all apps.
Sample (auto-generated)
CSK_FlowConfig.reloadApps()
resetModule()
Short description
Function to reset main configuration of module.
Sample (auto-generated)
CSK_FlowConfig.resetModule()
saveAllModuleConfigs()
Short description
Function to trigger all CSK modules to save their configuration via CSK_PersistentData module and additionally activate their "Load config on app start" flag.
Sample (auto-generated)
CSK_FlowConfig.saveAllModuleConfigs()
saveConfigViaUI()
Short description
Function to save configuration. Method base on set save mode (see 'setSaveMode').
Sample (auto-generated)
CSK_FlowConfig.saveConfigViaUI()
saveFlowRelevantModuleConfigs()
Short description
Function to trigger CSK modules used within the flow to save their configuration via CSK_PersistentData module and additionally activate their "Load config on app start" flag.
Sample (auto-generated)
CSK_FlowConfig.saveFlowRelevantModuleConfigs()
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_FlowConfig.sendParameters(noDataSave)
setActiveFeature()
Short description
Function to set features to be available for the FlowConfig.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
featureList |
STRING |
+ |
List of features. |
Sample (auto-generated)
CSK_FlowConfig.setActiveFeature(featureList)
setDemoFlow()
Short description
Function to selecte demo flow to load.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
flowName |
STRING |
1 |
Name of flow. |
Sample (auto-generated)
CSK_FlowConfig.setDemoFlow(flowName)
setInfoToggle()
Short description
Function to set toggle status to show info in UI.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_FlowConfig.setInfoToggle(status)
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_FlowConfig.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_FlowConfig.setParameterName(name)
setSaveMode()
Short description
Function to set save mode for configurations.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
mode |
1 |
Mode of saving method. |
Sample (auto-generated)
CSK_FlowConfig.setSaveMode(mode)
setShowImportantInformation()
Short description
Function to set if important information regarding the FlowConfig should be shown within the UI at page reload.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
CSK_FlowConfig.setShowImportantInformation(status)
stopFlowProviders()
Short description
Function to trigger event to stop FlowConfig relevant providers.
Sample (auto-generated)
CSK_FlowConfig.stopFlowProviders()
stopTriggerTimer()
Short description
Function to stop the timer of the 'OnNewValue' event.
Sample (auto-generated)
CSK_FlowConfig.stopTriggerTimer()
Events
OnClearOldFlow
Short description
Notify to clear all old flow config.
Sample (auto-generated)
function handleOnClearOldFlow()
-- Do something
end
Script.register("CSK_FlowConfig.OnClearOldFlow", "handleOnClearOldFlow")
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_FlowConfig.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
OnExpired_TYPE_TIME_VALUE
Short description
Example of dynamically served event to periodically notify a value to trigger other features.
TYPE, TIME and VALUE will be replaced by the name of the added expression (e.g. "CSK_FlowConfig.OnExpired_BOOL_100_TRUE").
INFO: Other modules can check via "Script.isServedAsFunction" if event exists.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
value |
AUTO |
1 |
Value |
timestamp |
INT |
1 |
Timestamp |
Sample (auto-generated)
function handleOnExpired_TYPE_TIME_VALUE(value, timestamp)
-- Do something
end
Script.register("CSK_FlowConfig.OnExpired_TYPE_TIME_VALUE", "handleOnExpired_TYPE_TIME_VALUE")
OnNewFlow
Short description
Notify currently active flow.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
flow |
STRING |
1 |
Flow configuration. |
Sample (auto-generated)
function handleOnNewFlow(flow)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewFlow", "handleOnNewFlow")
OnNewFlowConfig
Short description
Notify that new FlowConfig is available so that related modules can use it.
Sample (auto-generated)
function handleOnNewFlowConfig()
-- Do something
end
Script.register("CSK_FlowConfig.OnNewFlowConfig", "handleOnNewFlowConfig")
OnNewLogicResult_ID
Short description
Example of dynamically served event to notify result of logic operation.
ID will be replaced by internal set identifier of logic block (e.g. "CSK_FlowConfig.OnNewLogicResult_2").
INFO: Other modules can check via "Script.isServedAsFunction" if event exists.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
value |
AUTO |
1 |
Value |
timestamp |
INT |
1 |
Timestamp |
Sample (auto-generated)
function handleOnNewLogicResult_ID(value, timestamp)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewLogicResult_ID", "handleOnNewLogicResult_ID")
OnNewManifest
Short description
Notify available manifest for BlocksEditor.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
manifest |
STRING |
1 |
Manifest |
Sample (auto-generated)
function handleOnNewManifest(manifest)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewManifest", "handleOnNewManifest")
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_FlowConfig.OnNewParameterName", "handleOnNewParameterName")
OnNewStatusCSKStyle
Short description
Notify status to use custom UI style.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
style |
STRING |
1 |
Style |
Sample (auto-generated)
function handleOnNewStatusCSKStyle(style)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
OnNewStatusDemoFlow
Short description
Notify selected demo flow.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
name |
STRING |
1 |
Name of flow. |
Sample (auto-generated)
function handleOnNewStatusDemoFlow(name)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusDemoFlow", "handleOnNewStatusDemoFlow")
OnNewStatusFlowActiveUIInfo
Short description
Notify message on UI if saved flow was sucessfully loaded.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
STRING |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusFlowActiveUIInfo(status)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusFlowActiveUIInfo", "handleOnNewStatusFlowActiveUIInfo")
OnNewStatusFlowConfigReady
Short description
Notify that FlowConfig module is ready.
Sample (auto-generated)
function handleOnNewStatusFlowConfigReady()
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusFlowConfigReady", "handleOnNewStatusFlowConfigReady")
OnNewStatusInfoToggle
Short description
Notfiy status to show info in UI.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusInfoToggle(status)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusInfoToggle", "handleOnNewStatusInfoToggle")
OnNewStatusListOfActiveFeatures
Short description
Notify list of currently active FlowConfig featuers.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
activeFeatures |
STRING |
1 |
List of currently active features. |
Sample (auto-generated)
function handleOnNewStatusListOfActiveFeatures(activeFeatures)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusListOfActiveFeatures", "handleOnNewStatusListOfActiveFeatures")
OnNewStatusListOfAvailableFeatures
Short description
Notify available features to use in FlowConfig.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
availableFeatures |
STRING |
1 |
Available features. |
Sample (auto-generated)
function handleOnNewStatusListOfAvailableFeatures(availableFeatures)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusListOfAvailableFeatures", "handleOnNewStatusListOfAvailableFeatures")
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_FlowConfig.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_FlowConfig.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_FlowConfig.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
OnNewStatusSaveAllModulesAvailable
Short description
Notfiy if CSK_PersistentData module provides the feature to save all configs.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusSaveAllModulesAvailable(status)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusSaveAllModulesAvailable", "handleOnNewStatusSaveAllModulesAvailable")
OnNewStatusSaveMode
Short description
Notify mode to save configurations.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
mode |
STRING |
1 |
Mode |
Sample (auto-generated)
function handleOnNewStatusSaveMode(mode)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusSaveMode", "handleOnNewStatusSaveMode")
OnNewStatusShowInfoOnPageReload
Short description
Notify if information of FlowConfig should be shown on UI page reload.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
status |
BOOL |
1 |
Status |
Sample (auto-generated)
function handleOnNewStatusShowInfoOnPageReload(status)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewStatusShowInfoOnPageReload", "handleOnNewStatusShowInfoOnPageReload")
OnNewValueToForward_ID
Short description
Example of dynamically served event to notify the checked value of a logic operation if its result was successfull.
ID will be replaced by internal set identifier of logic block (e.g. "CSK_FlowConfig.OnNewValueToForward_2").
INFO: Other modules can check via "Script.isServedAsFunction" if event exists.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
value |
AUTO |
1 |
Value |
timestamp |
INT |
1 |
Timestamp |
Sample (auto-generated)
function handleOnNewValueToForward_ID(value, timestamp)
-- Do something
end
Script.register("CSK_FlowConfig.OnNewValueToForward_ID", "handleOnNewValueToForward_ID")
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_FlowConfig.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
OnStopFlowConfigProviders
Short description
Notify event to stop FlowConfig relevant providers.
Sample (auto-generated)
function handleOnStopFlowConfigProviders()
-- Do something
end
Script.register("CSK_FlowConfig.OnStopFlowConfigProviders", "handleOnStopFlowConfigProviders")
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_FlowConfig.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_FlowConfig.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_FlowConfig.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_FlowConfig.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")
CSK_Module_FlowConfig
Short description
This is an automatically generated CROWN (description not necessary).
FlowConfig_FC
Short description
Crown to provide CSK_FlowConfig relevant features.
Overview
FlowConfig_FC.NotifyEvent
Short description
Create a custom event to forward incoming data.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
EventName |
STRING |
1 |
Name of event (full name will be 'CSK_FlowConfig.[EventName]'). |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = FlowConfig_FC.NotifyEvent.create(EventName)
notifyEvent()
Short description
Create a custom event to forward incoming data.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
source |
STRING |
1 |
Source of data to forward its data via 'CSK_FlowConfig.[EventName]' Parameter: 1: (optional) AUTO 2: (optional) AUTO 3: (optional) AUTO 4: (optional) AUTO |
Sample (auto-generated)
FlowConfig_FC.NotifyEvent.notifyEvent(handle, source)
FlowConfig_FC.OnEvent
Short description
Set existing event to use as trigger for further processing.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
Event |
STRING |
1 |
Name of existing event to use as trigger. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = FlowConfig_FC.OnEvent.create(Event)
register()
Short description
Internally used CSK_FlowConfig register function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
eventname |
STRING |
1 |
Internal parameter (not used). |
callback |
STRING |
1 |
Internally used callback function. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
success |
BOOL |
1 |
Success of register process. |
Sample (auto-generated)
success = FlowConfig_FC.OnEvent.register(handle, eventname, callback)
Events
OnEvent
Short description
Set existing event to use as trigger for further processing.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
OnExpired |
STRING |
1 |
Parameter: 1: CUSTOM (see docu of set event) … |
Sample (auto-generated)
function handleOnEvent(handle, OnExpired)
-- Do something
end
Script.register("FlowConfig_FC.OnEvent.OnEvent", "handleOnEvent")
FlowConfig_FC.OnExpired
Short description
Periodically notify values. Especially helpful for testing purposes. Will send current timestamp as 2nd parameter.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
CycleTime |
INT |
1 |
Cycle time in ms ('0' for single trigger) |
ValueType |
1 |
Type of value to send. |
|
Value |
STRING |
1 |
Value to send via event. For 'BOOL' values use "true", "false" or "toggle". |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = FlowConfig_FC.OnExpired.create(CycleTime, ValueType, Value)
register()
Short description
Internally used CSK_FlowConfig register function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
eventname |
STRING |
1 |
Internal parameter (not used). |
callback |
STRING |
1 |
Internally used callback function. |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
success |
BOOL |
1 |
Success of register process. |
Sample (auto-generated)
success = FlowConfig_FC.OnExpired.register(handle, eventname, callback)
Events
OnExpired
Short description
Periodically notify values. Especially helpful for testing purposes. Will send current timestamp as 2nd parameter.
Callback arguments
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
OnExpired |
STRING |
1 |
'CSK_FlowConfig.OnExpired_[TYPE][TIME][VALUE]' Parameter: 1: Value (STRING or NUMBER or BOOL) 2: Timestamp (INT) |
Sample (auto-generated)
function handleOnExpired(handle, OnExpired)
-- Do something
end
Script.register("FlowConfig_FC.OnExpired.OnExpired", "handleOnExpired")
FlowConfig_FC.ProcessLogic
Short description
Check incoming value(s) with a logical operator. Return result and optionally forward processed value if succesfull.
Overview
Functions
create()
Short description
Internally used CSK_FlowConfig create function.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
Logic |
1 |
Type of logic operator. AND valueA AND valueB AND_PREV valueA AND valueB (keep previous status) CHANGED valueA =! previous valueA EQUAL valueA == critieraA GREATER valueA > criteriaA GREATER_EQUAL valueA >= criteriaA INVERT not valueA LESS valueA < criteriaA LESS_EQUAL valueA ⇐ criteriaA OR valueA OR valueB OR_PREV valueA OR valueB (keep previous status) OUT_OF_RANGE valueA < critieriaA OR valueA > critieriaB RISING_EDGE valueA == TRUE (was FALSE before) WITHIN_RANGE criteriaA >= valueA ⇐ critieriaB |
|
criteriaA |
STRING |
? |
Optional criteriaA (see info of logic). |
criteriaB |
STRING |
? |
Optional criteriaB (see info of logic). |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
Sample (auto-generated)
handle = FlowConfig_FC.ProcessLogic.create(Logic, criteriaA, criteriaB)
processLogic()
Short description
Check incoming value(s) with a logical operator. Return result and optionally forward processed value if succesfull.
Parameters
| Name | Type | Multiplicity | Description |
|---|---|---|---|
handle |
HANDLE |
1 |
Handle to internally used FlowConfig instance. |
sourceA |
STRING |
? |
Set source of valueA. Parameter: 1: value (AUTO) |
sourceB |
STRING |
? |
Set source of valueB. Parameter: 1: value (AUTO) |
Return values
| Name | Type | Multiplicity | Description |
|---|---|---|---|
OnNewLogicResult |
STRING |
1 |
'CSK_FlowConfig.OnNewLogicResult_[NUM]' (NUM is set internally) Parameter: 1: (optional) Result (BOOL) |
OnNewValueToForward |
STRING |
1 |
Forward checked value (ONLY if operation was successfull). 'CSK_FlowConfig.OnNewValueToForward_[NUM]' (NUM is set internally) Parameter: 1: (optional) Result (AUTO) |
Sample (auto-generated)
OnNewLogicResult, OnNewValueToForward = FlowConfig_FC.ProcessLogic.processLogic(handle, sourceA, sourceB)
Enumerations
CSK_FlowConfig.LogicOperator
Logical operators
| Value | Name | Description |
|---|---|---|
AND |
AND |
AND operation (will be evaluated when both states have changed) |
OR |
OR |
OR operation (will be evaluated when both states have changed) |
INVERT |
INVERT |
Invert incoming boolean value. |
GREATER |
GREATER |
Check if value is greater than definition of criteriaA. |
GREATER_EQUAL |
GREATER_EQUAL |
Check if value is greater or equal as definition of criteriaA. |
LESS |
LESS |
Check if value is less than definition of criteriaA. |
LESS_EQUAL |
LESS_EQUAL |
Check if value is less or equal as definition of criteriaA. |
WITHIN_RANGE |
WITHIN_RANGE |
Check if value is greater/equal as critieriaA and smaller/equal as critieriaB. |
OUT_OF_RANGE |
OUT_OF_RANGE |
Check if value is smaller/equal as critieriaA and bigger/equal as critieriaB. |
EQUAL |
EQUAL |
Check if value is equal to criteriaA. |
CHANGED |
CHANGED |
Check if value changed. |
AND_PREV |
AND_PREV |
Continuous AND operation (keeps previous received status and directly compares with this) |
OR_PREV |
OR_PREV |
Continuous OR operation (keeps previous received status and directly compares with this) |
RISING_EDGE |
RISING_EDGE |
Check if value changed from FALSE to TRUE. |
TO_NUMBER |
TO_NUMBER |
Convert string value to number. |
TO_STRING |
TO_STRING |
Convert data to STRING. |
MULTIPLY |
MULTIPLY |
Multiply value of sourceA with sourceB or criteriaA. |
FLOOR |
FLOOR |
Round value of sourceA down to the nearest integer. |
ADD |
ADD |
Add value of sourceA to sourceB or criteriaA. |
SUBTRACT |
SUBTRACT |
Subtract sourceB or criteriaA. from sourceA. |
DIVIDE |
DIVIDE |
Divide sourceA by sourceB or criteriaA. |
FALLING_EDGE |
FALLING_EDGE |
Check if value changed from TRUE to FALSE. |
CSK_FlowConfig.SaveMode
Mode of saving configuration
| Value | Name | Description |
|---|---|---|
ALL |
ALL |
This will save the configuration of the flow and additionally triggers all CSK modules available on the device to save their current configuration in PersistentData |
FLOW |
FLOW |
This will save the configuration of the flow and additionally triggers all CSK modules used within the flow to save their current configuration in PersistentData |
MODULE |
MODULE |
This will only save the configuration of the flow in PersistentData. Configurations done in other CSK modules need to be saved additionally |
FlowConfig_FC.ValueType
Types of value to use.
| Value | Name | Description |
|---|---|---|
STRING |
STRING |
String |
NUMBER |
NUMBER |
Number |
BOOL |
BOOL |
Bool |