Document metadata

Application name

CSK_Module_DigitalIOManager

Version

4.1.0

Date

2025-04-10

Author

SICK AG

Crowns

CSK_DigitalIOManager

Short description

Module to manage DigitalIO configurations and to provide features like signal forwarding (realized in dynamically created cFlow), signal < - > event forwarding and setting output states.
Other modules can access these features / settings. For most features it is needed to preconfigure some values and then to activate this setup.

Typically the features of this module are used like this (check also main script of this module):

1) Setup of the ports
At first, select the port you want to setup with "selectOutputInterface" or "selectInputInterface" by its ENUM, e.g. with 'CSK_DigitalIOManager.selectOutputInterface( "S1DO1" )'.
Now, you can setup the port configuration with functions like "setActivationMode" / "setActivationValue" / "setDebounceMode" / "setInputLogic" / "setOutputLogic" / "setOutputMode" / …​
IMPORTANT: To activate the predefined setup of the port, you need to call "setActiveStatusInput" / "setActiveStatusOutput", e.g. 'CSK_DigitalIOManager.setActiveStatusOutput( true )'.

2) Set digital output
Via "setOutput", you can set the status of the latest selected output port. (Same like 'Connector.DigitalOut.set( …​ )')

3) Get digital input
Via "getInputState", you can get the status of the latest selected input port. (Same like 'Connector.DigitalIn.get( …​ )')

4) Trigger digital output by event
It is possible to set a digital output signal by notifiying an event. For this, you need to use "setTriggerEvent" to predefine the event to listen to (e.g. 'CSK_DigitalIOManager.setTriggerEvent( "CrownName.OnNewResult" )'). The event needs to provide a bool value as first parameter to define the status to set.
Additionally, it is necessary to define which port should be set by the function "setOutputToTrigger", e.g. by 'CSK_DigitalIOManager.setOutputToTrigger( "S1DO1" )'.
This will become active by calling 'CSK_DigitalIOManager.addTriggerEvent()'.
If the event will raise, the digital output signal will be set by the forwarded bool value of the event. It will use the configuration of the port setup.
That means for example, if the output port is configured with OutputMode = "PUSH_PULL", Logic = "ACTIVE_HIGH", ActivationMode = "TIME_MS", ActivationValue = "100", and the event is notified with "true", the output port will be active for 100ms.
(INFO: If configured time is not "0" (keep signal), internally it will call automatically 'Connector.DigitalOut.set( status )' followed by 'Connector.DigitalOut.set( not status )', so it is not necessary to call the event twice to reset the status …​).
To remove this "Event2Trigger"-pair, you need to select this pair via "selectOutputToSetByEventPair" and then to call "removeTriggerEvent".

5) Forward digital input signals via event
It is possible to forward the status of the digital input signal to register on this by other modules (check docu of 'CSK_DigitalIOManager.OnNewInputStateENUM'-event).
For this, you need to select the specific port via "setInputToForward", e.g. 'CSK_DigitalIOManager.setInputToForward( "S2DI1" )'.
By calling then "addForwardEvent", it will forward new states of this port in the event like 'CSK_DigitalIOManager.OnNewInputStateS2DI1'.
To remove this "Input2Event"-pair, you need to select this pair via "selectForwardInputToEventPair" and then call "removeForwardEvent".

6) Link different ports
It is possible to link different ports with each other (like a wire inside of a flow). This will be handled as a cFlow.
For this, you need to configure the ports you want to link via "setInputForLink" / "setOutputForLink". Additionally, you can set a delay via "setDelayForLink".
To activate the predefined link, you need to call 'CSK_DigitalIOManager.addLink()'.
The input signal will be as well forwarded via the 'CSK_DigitalIOManager.OnNewFlowInputStateENUM'-event (e.g. to use in other scripts, see docu of this event).
To remove this link, you need to select this link via "selectLink" and then to call "removeLink".

Overview

Functions

CSK_DigitalIOManager.addForwardEvent()
Short description

Add event to forward an incoming digital input signal.

Sample (auto-generated)
CSK_DigitalIOManager.addForwardEvent()
Short description

Add link (via cFlow) from preset digital input signal to digital output signal.

Sample (auto-generated)
CSK_DigitalIOManager.addLink()
CSK_DigitalIOManager.addTriggerEvent()
Short description

Add event to listen to and to trigger a digital output signal.

Sample (auto-generated)
CSK_DigitalIOManager.addTriggerEvent()
CSK_DigitalIOManager.blockSensorPort()
Short description

Function to block a sensor port so that it can be used by other applications.

Parameters
Name Type Multiplicity Description

port

STRING

1

Port

Return values
Name Type Multiplicity Description

success

BOOL

1

Success

Sample (auto-generated)
success = CSK_DigitalIOManager.blockSensorPort(port)
CSK_DigitalIOManager.clearFlowConfigRelevantConfiguration()
Short description

Function to clear FlowConfig relevant configurations.

Sample (auto-generated)
CSK_DigitalIOManager.clearFlowConfigRelevantConfiguration()
CSK_DigitalIOManager.freeSensorPort()
Short description

Function to free a blocked sensor port to be available again for this module.

Parameters
Name Type Multiplicity Description

port

STRING

1

Port

Return values
Name Type Multiplicity Description

success

BOOL

1

Success

Sample (auto-generated)
success = CSK_DigitalIOManager.freeSensorPort(port)
CSK_DigitalIOManager.getForwardEventList()
Short description

Return lists of configured forward events and related data information texts (see "addForwardEvent").

Return values
Name Type Multiplicity Description

eventList

STRING

*

List of configured events.

infoTexts

STRING

*

List of configured DataInfo texts.

Sample (auto-generated)
eventList, infoTexts = CSK_DigitalIOManager.getForwardEventList()
CSK_DigitalIOManager.getInputState()
Short description

Get current status of preselected input interface.

Return values
Name Type Multiplicity Description

state

BOOL

?

Current status.

Sample (auto-generated)
state = CSK_DigitalIOManager.getInputState()
CSK_DigitalIOManager.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_DigitalIOManager.getParameters()
CSK_DigitalIOManager.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_DigitalIOManager.getStatusModuleActive()
CSK_DigitalIOManager.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_DigitalIOManager.loadParameters()
CSK_DigitalIOManager.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_DigitalIOManager.pageCalled()
CSK_DigitalIOManager.removeForwardEvent()
Short description

Remove event to forward an incoming digital input signal.

Parameters
Name Type Multiplicity Description

event

STRING

1

Eventname

Sample (auto-generated)
CSK_DigitalIOManager.removeForwardEvent(event)
CSK_DigitalIOManager.removeForwardEventViaUI()
Short description

Remove preselected event to not forward incoming digital input signals anymore.

Sample (auto-generated)
CSK_DigitalIOManager.removeForwardEventViaUI()
Short description

Remove preselected link (from cFlow).

Sample (auto-generated)
CSK_DigitalIOManager.removeLink()
CSK_DigitalIOManager.removeTriggerEvent()
Short description

Remove event to trigger a digital output signal.

Parameters
Name Type Multiplicity Description

event

STRING

1

Eventname

Sample (auto-generated)
CSK_DigitalIOManager.removeTriggerEvent(event)
CSK_DigitalIOManager.removeTriggerEventViaUI()
Short description

Remove preselected event to not trigger digital output anymore.

Sample (auto-generated)
CSK_DigitalIOManager.removeTriggerEventViaUI()
CSK_DigitalIOManager.resetModule()
Short description

Function to reset main configuration of module.

Sample (auto-generated)
CSK_DigitalIOManager.resetModule()
CSK_DigitalIOManager.selectForwardInputToEventPair()
Short description

Select Input2Event-pair.

Parameters
Name Type Multiplicity Description

selection

STRING

1

'Input2Event'-pair to select (via UI selection or port identifier like 'S1DI1').

Sample (auto-generated)
CSK_DigitalIOManager.selectForwardInputToEventPair(selection)
CSK_DigitalIOManager.selectInputInterface()
Short description

Select input interface to configure settings (e.g. in UI table).

Parameters
Name Type Multiplicity Description

selection

STRING

1

Input interface to select

Sample (auto-generated)
CSK_DigitalIOManager.selectInputInterface(selection)
Short description

Select link (e.g. in UI table).

Parameters
Name Type Multiplicity Description

selection

STRING

1

Selected link

Sample (auto-generated)
CSK_DigitalIOManager.selectLink(selection)
CSK_DigitalIOManager.selectOutputInterface()
Short description

Select output interface to configure settings (e.g. in UI table).

Parameters
Name Type Multiplicity Description

selection

STRING

1

Output interface to select

Sample (auto-generated)
CSK_DigitalIOManager.selectOutputInterface(selection)
CSK_DigitalIOManager.selectOutputToSetByEventPair()
Short description

Select Event2Trigger-pair.

Parameters
Name Type Multiplicity Description

selection

STRING

1

'Event2Trigger'-pair to select (via UI selection or port identifier like 'S1DO1').

Sample (auto-generated)
CSK_DigitalIOManager.selectOutputToSetByEventPair(selection)
CSK_DigitalIOManager.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_DigitalIOManager.sendParameters(noDataSave)
CSK_DigitalIOManager.setActivationMode()
Short description

Set activation mode of selected output interface.

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_DigitalIOManager.ActivationMode

1

Output activation mode to set.

Sample (auto-generated)
CSK_DigitalIOManager.setActivationMode(mode)
CSK_DigitalIOManager.setActivationValue()
Short description

Set activation value of selected output interface in milliseconds / ticks.

Parameters
Name Type Multiplicity Description

value

INT

1

Output activation value to set.

Sample (auto-generated)
CSK_DigitalIOManager.setActivationValue(value)
CSK_DigitalIOManager.setActiveStatusInput()
Short description

Set if selected input interface should be active.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Input active status to set.

Sample (auto-generated)
CSK_DigitalIOManager.setActiveStatusInput(status)
CSK_DigitalIOManager.setActiveStatusOutput()
Short description

Set if selected output interface should be active.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Output active status to set.

Sample (auto-generated)
CSK_DigitalIOManager.setActiveStatusOutput(status)
CSK_DigitalIOManager.setDebounceMode()
Short description

Set debounce mode of selected input interface.

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_DigitalIOManager.DebounceMode

1

Input debounce mode to set.

Sample (auto-generated)
CSK_DigitalIOManager.setDebounceMode(mode)
CSK_DigitalIOManager.setDebounceValue()
Short description

Set debounce value of selected input interface in milliseconds / ticks.

Parameters
Name Type Multiplicity Description

value

INT

1

Input debounce value to set.

Sample (auto-generated)
CSK_DigitalIOManager.setDebounceValue(value)
Short description

Set optional delay for link in cFlow.

Parameters
Name Type Multiplicity Description

value

INT

1

Delay time in [ms] to set.

Sample (auto-generated)
CSK_DigitalIOManager.setDelayForLink(value)
CSK_DigitalIOManager.setFlowConfigPriority()
Short description

Function to configure if FlowConfig should have priority for FlowConfig relevant configuration.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
CSK_DigitalIOManager.setFlowConfigPriority(status)
Short description

Preset input interface to use for new link (see "addLink").

Parameters
Name Type Multiplicity Description

port

STRING

1

Input interface to set.

Sample (auto-generated)
CSK_DigitalIOManager.setInputForLink(port)
CSK_DigitalIOManager.setInputLogic()
Short description

Set signal logic of selected input interface.

Parameters
Name Type Multiplicity Description

logic

ENUM
CSK_DigitalIOManager.SignalLogic

1

Input signal logic to set.

Sample (auto-generated)
CSK_DigitalIOManager.setInputLogic(logic)
CSK_DigitalIOManager.setInputToForward()
Short description

Set input interface to forward as event (see "addForwardEvent").

Parameters
Name Type Multiplicity Description

port

STRING

1

Input interface to set.

Sample (auto-generated)
CSK_DigitalIOManager.setInputToForward(port)
CSK_DigitalIOManager.setInputToForwardDataInfo()
Short description

Set data information text of selected input interface to forward "OnChange" status as event (see "addForwardEvent").

Parameters
Name Type Multiplicity Description

info

STRING

1

DataInfo text to set.

Sample (auto-generated)
CSK_DigitalIOManager.setInputToForwardDataInfo(info)
CSK_DigitalIOManager.setInputTracking()
Short description

Function to set if digital input signals should be tracked to show their states in UI.
INFO: Recommended to leave it switched off, if not essentially required!

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status to set.

Sample (auto-generated)
CSK_DigitalIOManager.setInputTracking(status)
CSK_DigitalIOManager.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 to set.

Sample (auto-generated)
CSK_DigitalIOManager.setLoadOnReboot(status)
CSK_DigitalIOManager.setOutput()
Short description

Set status of currently selected output port.

Parameters
Name Type Multiplicity Description

newState

BOOL

1

Status to set.

Sample (auto-generated)
CSK_DigitalIOManager.setOutput(newState)
Short description

Set output interface to forward as event (see "addForwardEvent").

Parameters
Name Type Multiplicity Description

port

STRING

1

Output interface to set.

Sample (auto-generated)
CSK_DigitalIOManager.setOutputForLink(port)
CSK_DigitalIOManager.setOutputLogic()
Short description

Set signal logic of selected output interface.

Parameters
Name Type Multiplicity Description

logic

ENUM
CSK_DigitalIOManager.SignalLogic

1

Output signal logic to set.

Sample (auto-generated)
CSK_DigitalIOManager.setOutputLogic(logic)
CSK_DigitalIOManager.setOutputMode()
Short description

Set output mode of selected output interface.

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_DigitalIOManager.PortOutputMode

1

Output mode to set.

Sample (auto-generated)
CSK_DigitalIOManager.setOutputMode(mode)
CSK_DigitalIOManager.setOutputToTrigger()
Short description

Preset output interface to set if registered triggerEvent (see "addTriggerEvent").

Parameters
Name Type Multiplicity Description

port

STRING

1

Output interface to set.

Sample (auto-generated)
CSK_DigitalIOManager.setOutputToTrigger(port)
CSK_DigitalIOManager.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_DigitalIOManager.setParameterName(name)
CSK_DigitalIOManager.setTriggerEvent()
Short description

Preset event name to listen to (see "addTriggerEvent").

Parameters
Name Type Multiplicity Description

event

STRING

1

Trigger event name to set.

Sample (auto-generated)
CSK_DigitalIOManager.setTriggerEvent(event)

Events

CSK_DigitalIOManager.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_DigitalIOManager.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_DigitalIOManager.OnNewActivationMode
Short description

Notify activation mode of currently selected output port.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Activation mode

Sample (auto-generated)
function handleOnNewActivationMode(mode)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewActivationMode", "handleOnNewActivationMode")
CSK_DigitalIOManager.OnNewActivationValue
Short description

Notify activation value of currently selected output port in milliseconds / ticks.

Callback arguments
Name Type Multiplicity Description

value

INT

1

Activation value

Sample (auto-generated)
function handleOnNewActivationValue(value)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewActivationValue", "handleOnNewActivationValue")
CSK_DigitalIOManager.OnNewActiveStatusInput
Short description

Notify activation status of currently selected input port.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewActiveStatusInput(status)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewActiveStatusInput", "handleOnNewActiveStatusInput")
CSK_DigitalIOManager.OnNewActiveStatusOutput
Short description

Notify activation status of currently selected output port.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewActiveStatusOutput(status)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewActiveStatusOutput", "handleOnNewActiveStatusOutput")
CSK_DigitalIOManager.OnNewDebounceMode
Short description

Notify debounce mode of currently selected input port.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Debounce mode

Sample (auto-generated)
function handleOnNewDebounceMode(mode)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewDebounceMode", "handleOnNewDebounceMode")
CSK_DigitalIOManager.OnNewDebounceValue
Short description

Notify debounce value of currently selected input port in milliseconds / ticks.

Callback arguments
Name Type Multiplicity Description

value

INT

1

Debounce value

Sample (auto-generated)
function handleOnNewDebounceValue(value)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewDebounceValue", "handleOnNewDebounceValue")
CSK_DigitalIOManager.OnNewEventList
Short description

Notify lists of configured forward events and related data information texts (see "addForwardEvent").

Callback arguments
Name Type Multiplicity Description

events

STRING

*

List of configured events

infoTexts

STRING

*

List of configured dataInfo texts.

Sample (auto-generated)
function handleOnNewEventList(events, infoTexts)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewEventList", "handleOnNewEventList")
CSK_DigitalIOManager.OnNewFlowInputStateENUM
Short description

Example for dynamically created event to forward an incoming digital input signal if used within a link (see "addLink").
"ENUM" is replaced by DigitalInPort ENUM (e.g. 'CSK_DigitalIOManager.OnNewFlowInputStateS1DI1').
This event will be created during runtime if a signal link is used. So for users of this event, it is necessary to check first if this event is already available to be able to register to it.
INFO: As this event will be created dynamically, there is no auto completion within SICK AppStudio available for such an event.

Sample (auto-generated)
function handleOnNewFlowInputStateENUM()
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewFlowInputStateENUM", "handleOnNewFlowInputStateENUM")
CSK_DigitalIOManager.OnNewForwardEvent
Short description

Notify current event name to use for forwarding a digital input signal (currently not used, default eventnames are used like 'CSK_DigitalIOManager.OnNewInputState[portName]').

Callback arguments
Name Type Multiplicity Description

parametername

STRING

1

Event name

Sample (auto-generated)
function handleOnNewForwardEvent(parametername)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewForwardEvent", "handleOnNewForwardEvent")
CSK_DigitalIOManager.OnNewForwardTriggerList
Short description

Notify list of configured input interfaces and their related events to call.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewForwardTriggerList(list)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewForwardTriggerList", "handleOnNewForwardTriggerList")
CSK_DigitalIOManager.OnNewInputForLinkSelected
Short description

Notify currently selected input interface to use for new links (see "addLink").

Callback arguments
Name Type Multiplicity Description

selection

STRING

1

Name of selected input interface.

Sample (auto-generated)
function handleOnNewInputForLinkSelected(selection)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputForLinkSelected", "handleOnNewInputForLinkSelected")
CSK_DigitalIOManager.OnNewInputLogic
Short description

Notify signal logic of currently selected input port.

Callback arguments
Name Type Multiplicity Description

logic

STRING

1

Signal logic

Sample (auto-generated)
function handleOnNewInputLogic(logic)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputLogic", "handleOnNewInputLogic")
CSK_DigitalIOManager.OnNewInputPortList
Short description

Notify list of available input interfaces.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewInputPortList(list)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputPortList", "handleOnNewInputPortList")
CSK_DigitalIOManager.OnNewInputPortTable
Short description

Notify list of available input interfaces and the according settings (used for the UI table).

Callback arguments
Name Type Multiplicity Description

inputList

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewInputPortTable(inputList)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputPortTable", "handleOnNewInputPortTable")
CSK_DigitalIOManager.OnNewInputSelection
Short description

Notify currently selected input interface.

Callback arguments
Name Type Multiplicity Description

selection

STRING

1

Currently selected input interface.

Sample (auto-generated)
function handleOnNewInputSelection(selection)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputSelection", "handleOnNewInputSelection")
CSK_DigitalIOManager.OnNewInputStateENUM
Short description

Example for dynamically created event to forward an incoming digital input signal if configured (see "addForwardEvent").
"ENUM" is replaced by DigitalInPort ENUM (e.g. 'CSK_DigitalIOManager.OnNewInputStateS1DI1').
INFO: As this event will be created dynamically, there is no auto completion within SICK AppStudio available for such an event.

Callback arguments
Name Type Multiplicity Description

newState

BOOL

1

New state of input signal.

Sample (auto-generated)
function handleOnNewInputStateENUM(newState)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputStateENUM", "handleOnNewInputStateENUM")
CSK_DigitalIOManager.OnNewInputToForward
Short description

Notify selected input port to forward "OnChange" status via event.

Callback arguments
Name Type Multiplicity Description

port

STRING

1

Port of signal to forward

Sample (auto-generated)
function handleOnNewInputToForward(port)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputToForward", "handleOnNewInputToForward")
CSK_DigitalIOManager.OnNewInputToForwardDataInfo
Short description

Notify data information text of selected input port to forward "OnChange" status via event.

Callback arguments
Name Type Multiplicity Description

info

STRING

1

DataInfo text

Sample (auto-generated)
function handleOnNewInputToForwardDataInfo(info)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInputToForwardDataInfo", "handleOnNewInputToForwardDataInfo")
CSK_DigitalIOManager.OnNewInternalMessage
Short description

Notify internal messages.

Callback arguments
Name Type Multiplicity Description

message

STRING

1

Message

Sample (auto-generated)
function handleOnNewInternalMessage(message)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewInternalMessage", "handleOnNewInternalMessage")
CSK_DigitalIOManager.OnNewLinkDelay
Short description

Notify delay time of currently selected link in milliseconds.

Callback arguments
Name Type Multiplicity Description

delay

INT

1

Delay time in [ms].

Sample (auto-generated)
function handleOnNewLinkDelay(delay)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewLinkDelay", "handleOnNewLinkDelay")
Short description

Notify list of currently active links (cFlow) (e.g. for UI table).

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewLinkList(list)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewLinkList", "handleOnNewLinkList")
CSK_DigitalIOManager.OnNewLinkSelected
Short description

Notify selected link in UI table list.

Callback arguments
Name Type Multiplicity Description

selection

STRING

1

Selected link

Sample (auto-generated)
function handleOnNewLinkSelected(selection)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewLinkSelected", "handleOnNewLinkSelected")
CSK_DigitalIOManager.OnNewMessageType
Short description

Notify current message type of UI callout.

Callback arguments
Name Type Multiplicity Description

type

STRING

1

Message type (like 'info', 'warning')

Sample (auto-generated)
function handleOnNewMessageType(type)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewMessageType", "handleOnNewMessageType")
CSK_DigitalIOManager.OnNewOutputForLinkSelected
Short description

Notify currently selected output interface to use for new links (see "addLink").

Callback arguments
Name Type Multiplicity Description

selection

STRING

1

Name of selected output interface.

Sample (auto-generated)
function handleOnNewOutputForLinkSelected(selection)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputForLinkSelected", "handleOnNewOutputForLinkSelected")
CSK_DigitalIOManager.OnNewOutputLogic
Short description

Notify signal logic of currently selected output port.

Callback arguments
Name Type Multiplicity Description

logic

STRING

1

Signal logic

Sample (auto-generated)
function handleOnNewOutputLogic(logic)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputLogic", "handleOnNewOutputLogic")
CSK_DigitalIOManager.OnNewOutputMode
Short description

Notify output mode of currently selected output port.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Output mode

Sample (auto-generated)
function handleOnNewOutputMode(mode)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputMode", "handleOnNewOutputMode")
CSK_DigitalIOManager.OnNewOutputPortList
Short description

Notify list of available output interfaces.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewOutputPortList(list)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputPortList", "handleOnNewOutputPortList")
CSK_DigitalIOManager.OnNewOutputPortTable
Short description

Notify list of available output interfaces and the according settings (used for the UI table).

Callback arguments
Name Type Multiplicity Description

jsonList

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewOutputPortTable(jsonList)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputPortTable", "handleOnNewOutputPortTable")
CSK_DigitalIOManager.OnNewOutputSelection
Short description

Notify currently selected output interface.

Callback arguments
Name Type Multiplicity Description

selection

STRING

1

Currently selected output interface.

Sample (auto-generated)
function handleOnNewOutputSelection(selection)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputSelection", "handleOnNewOutputSelection")
CSK_DigitalIOManager.OnNewOutputToTrigger
Short description

Notify currently preselected output interface to use (set) for a trigger event (see "addTriggerEvent").

Callback arguments
Name Type Multiplicity Description

port

STRING

1

Interface

Sample (auto-generated)
function handleOnNewOutputToTrigger(port)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewOutputToTrigger", "handleOnNewOutputToTrigger")
CSK_DigitalIOManager.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_DigitalIOManager.OnNewParameterName", "handleOnNewParameterName")
CSK_DigitalIOManager.OnNewSetOutputByEventList
Short description

Notify list of triggerEvents (triggerEvent names + related digital output signals to be set), e.g. for table in UI.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List (JSON)

Sample (auto-generated)
function handleOnNewSetOutputByEventList(list)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewSetOutputByEventList", "handleOnNewSetOutputByEventList")
CSK_DigitalIOManager.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_DigitalIOManager.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
CSK_DigitalIOManager.OnNewStatusFlowConfigPriority
Short description

Notify if FlowConfig should have priority for FlowConfig relevant configurations.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusFlowConfigPriority(status)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
CSK_DigitalIOManager.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_DigitalIOManager.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_DigitalIOManager.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_DigitalIOManager.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_DigitalIOManager.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_DigitalIOManager.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_DigitalIOManager.OnNewStatusSignalLinksSupport
Short description

Notify status if signal link feature is supported on device.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusSignalLinksSupport(status)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewStatusSignalLinksSupport", "handleOnNewStatusSignalLinksSupport")
CSK_DigitalIOManager.OnNewStatusTrackInputSignalStatus
Short description

Notify if status of digital input signals should be tracked for UI.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusTrackInputSignalStatus(status)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewStatusTrackInputSignalStatus", "handleOnNewStatusTrackInputSignalStatus")
CSK_DigitalIOManager.OnNewTriggerEvent
Short description

Notify current eventname to be set for listening to set related output interface (see "addTriggerEvent").

Callback arguments
Name Type Multiplicity Description

event

STRING

1

Event name to wait for as trigger

Sample (auto-generated)
function handleOnNewTriggerEvent(event)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnNewTriggerEvent", "handleOnNewTriggerEvent")
CSK_DigitalIOManager.OnPersistentDataModuleAvailable
Short description

Notify status if features of CSK_PersistentData 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_DigitalIOManager.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_DigitalIOManager.OnShowInternalMessages
Short description

Notify if internal message should be shown.

Callback arguments
Name Type Multiplicity Description

status

STRING

1

Status

Sample (auto-generated)
function handleOnShowInternalMessages(status)
  -- Do something
end

Script.register("CSK_DigitalIOManager.OnShowInternalMessages", "handleOnShowInternalMessages")
CSK_DigitalIOManager.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_DigitalIOManager.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_DigitalIOManager.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_DigitalIOManager.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_DigitalIOManager.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_DigitalIOManager.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_DigitalIOManager.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_DigitalIOManager.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_Module_DigitalIOManager

Short description

This is an automatically generated CROWN (description not necessary)

DigitalIOManager_FC

Short description

Crown to provide CSK_FlowConfig relevant features.

Overview

DigitalIOManager_FC.OnNewInputState

Short description

Provide digital input states.

Functions

DigitalIOManager_FC.OnNewInputState.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

DigitalInPorts

ENUM
DigitalIOManager_FC.DigitalInPorts

1

Port to use.

Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

Sample (auto-generated)
handle = DigitalIOManager_FC.OnNewInputState.create(DigitalInPorts)
DigitalIOManager_FC.OnNewInputState.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 = DigitalIOManager_FC.OnNewInputState.register(handle, eventname, callback)

Events

DigitalIOManager_FC.OnNewInputState.OnNewInputState
Short description

Provide digital input states.

Callback arguments
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

OnNewInputState

STRING

1

'CSK_DigitalIOManager.OnNewInputState[PORT]' Parameter: 1: State of the input signal (BOOL)

Sample (auto-generated)
function handleOnNewInputState(handle, OnNewInputState)
  -- Do something
end

Script.register("DigitalIOManager_FC.OnNewInputState.OnNewInputState", "handleOnNewInputState")

DigitalIOManager_FC.Set

Short description

Set source to set state of digital output.

Overview

Functions

DigitalIOManager_FC.Set.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

DigitalOutPorts

ENUM
DigitalIOManager_FC.DigitalOutPorts

1

Port to use.

Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

Sample (auto-generated)
handle = DigitalIOManager_FC.Set.create(DigitalOutPorts)
DigitalIOManager_FC.Set.set()
Short description

Set source to set state of digital output.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

source

STRING

1

Source to set state (BOOL).

Sample (auto-generated)
DigitalIOManager_FC.Set.set(handle, source)

Enumerations

CSK_DigitalIOManager.ActivationMode

Digital output activation mode.

Items
Value Name Description
TIME_MS

TIME_MS

The activation value will be based on time in milliseconds.

INCREMENT_TICK

INCREMENT_TICK

The activation value will be based on increments in ticks.

CSK_DigitalIOManager.DebounceMode

Digital input debounce mode.

Items
Value Name Description
TIME_MS

TIME_MS

The debounce value will be based on time in milliseconds.

INCREMENT_TICK

INCREMENT_TICK

The debounce value will be based on increments in ticks.

CSK_DigitalIOManager.PortOutputMode

Digital output mode.

Items
Value Name Description
HIGH_SIDE

HIGH_SIDE

Digital port works as high-side (PNP) output.

LOW_SIDE

LOW_SIDE

Digital port works as low-side (NPN) output.

PUSH_PULL

PUSH_PULL

Digital port works as push-pull output.

CSK_DigitalIOManager.SignalLogic

Signal logic of digital input / output signal.

Items
Value Name Description
ACTIVE_HIGH

ACTIVE_HIGH

Active high signal logic is used.

ACTIVE_LOW

ACTIVE_LOW

Active low signal logic is used.