Document metadata

Application name

CSK_Module_Dashboard

Version

1.0.0

Date

2025-10-30

Author

SICK AG

Crowns

C
D

CSK_Dashboard

Short description

Module to dynamically create a dashboard to show relevant values within its UI.
Check UI of this module for most available features.

Typically this feature is configured via the CSK FlowConfig feature to link values to show in UI.

Overview

Functions

CSK_Dashboard.clearFlowConfigRelevantConfiguration()
Short description

Function to clear FlowConfig relevant configurations.

Sample (auto-generated)
CSK_Dashboard.clearFlowConfigRelevantConfiguration()
CSK_Dashboard.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_Dashboard.getParameters()
CSK_Dashboard.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_Dashboard.getStatusModuleActive()
CSK_Dashboard.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_Dashboard.loadParameters()
CSK_Dashboard.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_Dashboard.pageCalled()
CSK_Dashboard.resetModule()
Short description

Function to reset main configuration of module.

Sample (auto-generated)
CSK_Dashboard.resetModule()
CSK_Dashboard.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_Dashboard.sendParameters(noDataSave)
CSK_Dashboard.setDataType()
Short description

Funtion to set type of data to show in dashboard.

Parameters
Name Type Multiplicity Description

dataType

STRING

+

Type of data and dataID (e.g. ['GAUGE', '1']).
Sample (auto-generated)
CSK_Dashboard.setDataType(dataType)
CSK_Dashboard.setEventToRegister()
Short description

Function to set event to receive data to show on dashboard.

Parameters
Name Type Multiplicity Description

dataID

INT

1

Data identifier to use.

event

STRING

1

Event providing data to show in UI.

parameterPos

INT

?

Optional position of parameter within event (1 per default).
Sample (auto-generated)
CSK_Dashboard.setEventToRegister(dataID, event, parameterPos)
CSK_Dashboard.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_Dashboard.setFlowConfigPriority(status)
CSK_Dashboard.setGaugeDigits()
Short description

Function to set amount of digits for gauges in UI.

Parameters
Name Type Multiplicity Description

value

INT

+

Amount of digits per gauge UI element.
Sample (auto-generated)
CSK_Dashboard.setGaugeDigits(value)
CSK_Dashboard.setGaugeMaximum()
Short description

Function to set maximum of gauge.

Parameters
Name Type Multiplicity Description

value

INT

+

Value
Sample (auto-generated)
CSK_Dashboard.setGaugeMaximum(value)
CSK_Dashboard.setGaugeMinimum()
Short description

Function to set minimum of gauge.

Parameters
Name Type Multiplicity Description

value

INT

+

Value
Sample (auto-generated)
CSK_Dashboard.setGaugeMinimum(value)
CSK_Dashboard.setLabel()
Short description

Function to set label for data to show in UI dashboard.

Parameters
Name Type Multiplicity Description

data

STRING

+

Label to show in UI and related dataID (e.g. ['LabelA', '1']).
Sample (auto-generated)
CSK_Dashboard.setLabel(data)
CSK_Dashboard.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_Dashboard.setLoadOnReboot(status)
CSK_Dashboard.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_Dashboard.setParameterName(name)
CSK_Dashboard.setSourceEvent()
Short description

Function to set source event for data slot in UI.

Parameters
Name Type Multiplicity Description

data

STRING

+

Source event of data and dataID (e.g. ['CSK_Moudle.OnNewData', '1']).
Sample (auto-generated)
CSK_Dashboard.setSourceEvent(data)
CSK_Dashboard.setSourceEventDataPosition()
Short description

Function to set data position for source events of specific data slot.

Parameters
Name Type Multiplicity Description

data

INT

+

Position of data within source event and related dataID (e.g. [1, 1]).
Sample (auto-generated)
CSK_Dashboard.setSourceEventDataPosition(data)

Events

CSK_Dashboard.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_Dashboard.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_Dashboard.OnNewData
Short description

Notify current data values.

Callback arguments
Name Type Multiplicity Description

data

STRING

+

Data
Sample (auto-generated)
function handleOnNewData(data)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewData", "handleOnNewData")
CSK_Dashboard.OnNewDataNumbers
Short description

Notify available number data.

Callback arguments
Name Type Multiplicity Description

data

FLOAT

+

Data
Sample (auto-generated)
function handleOnNewDataNumbers(data)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewDataNumbers", "handleOnNewDataNumbers")
CSK_Dashboard.OnNewDataStatus
Short description

Notify boolean status of data.

Callback arguments
Name Type Multiplicity Description

status

BOOL

+

Status
Sample (auto-generated)
function handleOnNewDataStatus(status)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewDataStatus", "handleOnNewDataStatus")
CSK_Dashboard.OnNewDataTypes
Short description

Notify types pf data to show.

Callback arguments
Name Type Multiplicity Description

dataType

STRING

+

Data types.
Sample (auto-generated)
function handleOnNewDataTypes(dataType)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewDataTypes", "handleOnNewDataTypes")
CSK_Dashboard.OnNewGaugeUnit
Short description

Notify unit of gauges.

Callback arguments
Name Type Multiplicity Description

unit

STRING

1

Unit
Sample (auto-generated)
function handleOnNewGaugeUnit(unit)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewGaugeUnit", "handleOnNewGaugeUnit")
CSK_Dashboard.OnNewLabels
Short description

Notify label names for data to show in UI dashboard.

Callback arguments
Name Type Multiplicity Description

labels

STRING

+

Labels
Sample (auto-generated)
function handleOnNewLabels(labels)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewLabels", "handleOnNewLabels")
CSK_Dashboard.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_Dashboard.OnNewParameterName", "handleOnNewParameterName")
CSK_Dashboard.OnNewResult
Short description

Notify new result…​

Callback arguments
Name Type Multiplicity Description

result

AUTO

1

Result
Sample (auto-generated)
function handleOnNewResult(result)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewResult", "handleOnNewResult")
CSK_Dashboard.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_Dashboard.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
CSK_Dashboard.OnNewStatusEventToRegister
Short description

Notify event to register to and to process data.

Callback arguments
Name Type Multiplicity Description

eventName

STRING

1

Name of event
Sample (auto-generated)
function handleOnNewStatusEventToRegister(eventName)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewStatusEventToRegister", "handleOnNewStatusEventToRegister")
CSK_Dashboard.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_Dashboard.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
CSK_Dashboard.OnNewStatusGaugeDigits
Short description

Notify amount of digits to show within gauge.

Callback arguments
Name Type Multiplicity Description

digits

INT

+

Amount of digits per gauge.
Sample (auto-generated)
function handleOnNewStatusGaugeDigits(digits)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewStatusGaugeDigits", "handleOnNewStatusGaugeDigits")
CSK_Dashboard.OnNewStatusGaugeMaximums
Short description

Notify maximum values of gauges.

Callback arguments
Name Type Multiplicity Description

values

INT

+

Values
Sample (auto-generated)
function handleOnNewStatusGaugeMaximums(values)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewStatusGaugeMaximums", "handleOnNewStatusGaugeMaximums")
CSK_Dashboard.OnNewStatusGaugeMinimums
Short description

Notify minimum values for gauges.

Callback arguments
Name Type Multiplicity Description

values

INT

+

Values
Sample (auto-generated)
function handleOnNewStatusGaugeMinimums(values)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewStatusGaugeMinimums", "handleOnNewStatusGaugeMinimums")
CSK_Dashboard.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_Dashboard.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_Dashboard.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_Dashboard.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_Dashboard.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_Dashboard.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_Dashboard.OnNewStatusSourceEvents
Short description

Notify source events of data to show in UI.

Callback arguments
Name Type Multiplicity Description

events

STRING

+

Events
Sample (auto-generated)
function handleOnNewStatusSourceEvents(events)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewStatusSourceEvents", "handleOnNewStatusSourceEvents")
CSK_Dashboard.OnNewStatusSourceEventsDataPosition
Short description

Notify parameter position within source events.

Callback arguments
Name Type Multiplicity Description

data

INT

+

Data
Sample (auto-generated)
function handleOnNewStatusSourceEventsDataPosition(data)
  -- Do something
end

Script.register("CSK_Dashboard.OnNewStatusSourceEventsDataPosition", "handleOnNewStatusSourceEventsDataPosition")
CSK_Dashboard.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_Dashboard.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_Dashboard.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_Dashboard.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_Dashboard.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_Dashboard.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_Dashboard.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_Dashboard.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_Dashboard.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_Dashboard.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_Module_Dashboard

Short description

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

Overview

Dashboard_FC

Short description

Crown to provide CSK_FlowConfig relevant features.

Overview

Dashboard_FC.UpdateValue

Short description

Set source to show and update value in dashboard.

Overview

Functions

Dashboard_FC.UpdateValue.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

Label

STRING

1

Label of data to show on dashboard.

DataID

INT

1

Data slot within dashboard to use.

ParameterPos

INT

?

Optional position of parameter.
Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = Dashboard_FC.UpdateValue.create(Label, DataID, ParameterPos)
Dashboard_FC.UpdateValue.updateValue()
Short description

Set source to show and update value in dashboard.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

source

STRING

1

Source of data to show in dashboard. Parameter: 1: Data (STRING)
Sample (auto-generated)
Dashboard_FC.UpdateValue.updateValue(handle, source)