Document metadata

Application name

CSK_Module_ModuleName

Version

3.6.0

Date

2023-06-29

Author

SICK AG

Crowns

C

CSK_Module_ModuleName

Short description

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

CSK_ModuleName

Short description

Please fill in information regarding: What is the idea of this module and its features?
How to use this module in general…​. like:

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

2) Something else…​

Overview

Functions

CSK_ModuleName.loadParameters()
Short description

Load parameters for this module from the CSK_PersistentData module if possible and use them.

Sample (auto-generated)
CSK_ModuleName.loadParameters()
CSK_ModuleName.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_ModuleName.pageCalled()
CSK_ModuleName.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_ModuleName.sendParameters()
CSK_ModuleName.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_ModuleName.setLoadOnReboot(status)
CSK_ModuleName.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_ModuleName.setParameterName(name)

Events

CSK_ModuleName.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_ModuleName.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_ModuleName.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_ModuleName.OnNewParameterName", "handleOnNewParameterName")
CSK_ModuleName.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_ModuleName.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_ModuleName.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_ModuleName.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_ModuleName.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_ModuleName.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_ModuleName.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_ModuleName.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_ModuleName.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_ModuleName.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_ModuleName.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_ModuleName.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")