Document metadata

Application name

CSK_FlowConfig_FeatureBlocks

Version

1.1.1

Date

2025-05-20

Author

SICK AG

Crowns

C
F

CSK_FlowConfig_FeatureBlocks

Short description

This is an automatically generated CROWN (description not necessary).

Overview

CSK_FlowConfigFeatureBlocks

Short description

SensorApp to provide features as blocks for the CSK FlowConfig feature.
Run this application in parallel to the CSK_Module_FlowConfig. Features provided by this SensorApp will be shown as blocks within the CSK_Module_FlowConfig UI.
Regarding further information, please read the CSK documentation provided on https://github.com/SICKAppSpaceCodingStarterKit.

Overview

Functions

CSK_FlowConfigFeatureBlocks.addDataCollectorBlock()
Short description

Function to add / extend a FlowConfig block to collect data.

Parameters
Name Type Multiplicity Description

instance

STRING

1

Identifier of instance.

source

STRING

1

Name of source events.

counter

INT

1

Maximum value of counter to collect data before forwarding them.

separator

STRING

1

Separator to separate data.

trigger

STRING

?

Optional event name to forward data collected so far.
Sample (auto-generated)
CSK_FlowConfigFeatureBlocks.addDataCollectorBlock(instance, source, counter, separator, trigger)
CSK_FlowConfigFeatureBlocks.addJSONBlock()
Short description

Function to add / extend a FlowConfig block to create JSON content out of received data.

Parameters
Name Type Multiplicity Description

instance

STRING

1

Identifier of instance.

data

STRING

+

Key values

events

STRING

+

Name of source events.

trigger

STRING

?

Optional event name to trigger creation of JSON content.
Sample (auto-generated)
CSK_FlowConfigFeatureBlocks.addJSONBlock(instance, data, events, trigger)
CSK_FlowConfigFeatureBlocks.addLogBlock()
Short description

Function to add a new logger.

Parameters
Name Type Multiplicity Description

instance

STRING

1

Instance of block.

level

STRING

1

Level to log values.

event

STRING

1

Source event providing the data.
Sample (auto-generated)
CSK_FlowConfigFeatureBlocks.addLogBlock(instance, level, event)

Events

CSK_FlowConfigFeatureBlocks.OnNewCollectedData_ID
Short description

Example of dynamically created event to notify collected data content.
ID will be replaced by an internal created identifier (e.g. "OnNewCollectedData_3").
INFO: Other modules can check via "Script.isServedAsEvent" if event exists.

Callback arguments
Name Type Multiplicity Description

data

STRING

1

Data content.
Sample (auto-generated)
function handleOnNewCollectedData_ID(data)
  -- Do something
end

Script.register("CSK_FlowConfigFeatureBlocks.OnNewCollectedData_ID", "handleOnNewCollectedData_ID")
CSK_FlowConfigFeatureBlocks.OnNewJSON_ID
Short description

Example of dynamically created event to notify created JSON content.
ID will be replaced by an internal created identifier (e.g. "OnNewJSON_3").
INFO: Other modules can check via "Script.isServedAsEvent" if event exists.

Callback arguments
Name Type Multiplicity Description

data

STRING

1

JSON content.
Sample (auto-generated)
function handleOnNewJSON_ID(data)
  -- Do something
end

Script.register("CSK_FlowConfigFeatureBlocks.OnNewJSON_ID", "handleOnNewJSON_ID")

FeatureBlocks_FC

Short description

Crown to provide CSK_FlowConfig relevant features.

Overview

FeatureBlocks_FC.CollectData

Short description

Collect data multiple times to forward it in a single event.

Overview

Functions

FeatureBlocks_FC.CollectData.collectData()
Short description

Collect data multiple times to forward it in a single event.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

trigger

STRING

?

Optional source of trigger event to forward collected data. If not used, it will push the collected data after it received data >= counter.

source

STRING

1

Source of data to collect. Parameter: 1: Data (STRING)
Return values
Name Type Multiplicity Description

OnNewCollectedData

STRING

1

'CSK_FlowConfigFeatureBlocks.OnNewResult[ID]' Parameter: 1: Data (STRING)
Sample (auto-generated)
OnNewCollectedData = FeatureBlocks_FC.CollectData.collectData(handle, trigger, source)
FeatureBlocks_FC.CollectData.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

counter

INT

1

Maximum counter value of received data before forwarding it.

separator

STRING

1

Separator for collected data.
Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = FeatureBlocks_FC.CollectData.create(counter, separator)

FeatureBlocks_FC.JSON

Short description

Set source events of incoming data to create JSON content.

Overview

Functions

FeatureBlocks_FC.JSON.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

Key1

STRING

1

Key for values of source1.

Key2

STRING

?

Key for values of source2.

Key3

STRING

?

Key for values of source3.

Key4

STRING

?

Key for values of source4.

Key5

STRING

?

Key for values of source5.

Key6

STRING

?

Key for values of source6.
Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = FeatureBlocks_FC.JSON.create(Key1, Key2, Key3, Key4, Key5, Key6)
FeatureBlocks_FC.JSON.json()
Short description

Set source events of incoming data to create JSON content.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

trigger

STRING

?

Optional source of trigger event to create JSON file. If not used, it will push JSON content with every single value update.

source1

STRING

?

Source of value1. Parameter: 1: data (AUTO)

source2

STRING

?

Source of value2. Parameter: 1: data (AUTO)

source3

STRING

?

Source of value3. Parameter: 1: data (AUTO)

source4

STRING

?

Source of value4. Parameter: 1: data (AUTO)

source5

STRING

?

Source of value5. Parameter: 1: data (AUTO)

source6

STRING

?

Source of value6. Parameter: 1: data (AUTO)
Return values
Name Type Multiplicity Description

OnNewJSON

STRING

1

'CSK_FlowConfigFeatureBlocks.OnNewJSON_[ID]' Parameter: 1: JSON (STRING)
Sample (auto-generated)
OnNewJSON = FeatureBlocks_FC.JSON.json(handle, trigger, source1, source2, source3, source4, source5, source6)

FeatureBlocks_FC.Log

Short description

Debug blog to log received content.

Overview

Functions

FeatureBlocks_FC.Log.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

Level

ENUM
FeatureBlocks_FC.LogLevel

1

Set log level to forwarded value.
Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = FeatureBlocks_FC.Log.create(Level)
FeatureBlocks_FC.Log.log()
Short description

Set source events of incoming data to create JSON content.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

source1

STRING

?

Source of value1. Parameter: 1: data (AUTO)
Sample (auto-generated)
FeatureBlocks_FC.Log.log(handle, source1)

Enumerations

F

FeatureBlocks_FC.LogLevel

Log level for FlowConfig feature.

Items
Value Name Description 
FINE

FINE

FINE

 
INFO

INFO

INFO

 
SEVERE

SEVERE

SEVERE

 
WARNING

WARNING

WARNING