Document metadata

Application name

CSK_Module_SensorAppOverview

Version

1.0.1

Date

2024-10-11

Author

SICK AG

Crowns

C

CSK_Module_SensorAppOverview

Short description

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

CSK_SensorAppOverview

Short description

Module to show a list of available apps in the UI and to open their related UI.
Additionally it is possible to set an app to load per default after reboot ('setMainAppName').
The name of this default MainApp is saved as AppSpace Parameter 'MainAppName'.

Overview

Functions

CSK_SensorAppOverview.clearImage()
Short description

Function to clear image of main app.

Sample (auto-generated)
CSK_SensorAppOverview.clearImage()
CSK_SensorAppOverview.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_SensorAppOverview.loadParameters()
CSK_SensorAppOverview.openUI()
Short description

Function to open UI of selected app.

Parameters
Name Type Multiplicity Description

appName

STRING

1

Name of app to show UI.
Sample (auto-generated)
CSK_SensorAppOverview.openUI(appName)
CSK_SensorAppOverview.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_SensorAppOverview.pageCalled()
CSK_SensorAppOverview.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_SensorAppOverview.sendParameters(noDataSave)
CSK_SensorAppOverview.setEditMode()
Short description

Function to set edit mode within UI to configure default app.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_SensorAppOverview.setEditMode(status)
CSK_SensorAppOverview.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_SensorAppOverview.setLoadOnReboot(status)
CSK_SensorAppOverview.setMainAppName()
Short description

Function to set MainApp name.

Parameters
Name Type Multiplicity Description

nameOfApp

STRING

1

Name of app.
Sample (auto-generated)
CSK_SensorAppOverview.setMainAppName(nameOfApp)
CSK_SensorAppOverview.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_SensorAppOverview.setParameterName(name)
CSK_SensorAppOverview.uploadImage()
Short description

Function to finalize image file upload.

Parameters
Name Type Multiplicity Description

finished

BOOL

1

Status of upload.
Sample (auto-generated)
CSK_SensorAppOverview.uploadImage(finished)

Events

CSK_SensorAppOverview.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_SensorAppOverview.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_SensorAppOverview.OnNewConfigurationMode
Short description

Notify change of configuration mode within UI.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Mode
Sample (auto-generated)
function handleOnNewConfigurationMode(mode)
  -- Do something
end

Script.register("CSK_SensorAppOverview.OnNewConfigurationMode", "handleOnNewConfigurationMode")
CSK_SensorAppOverview.OnNewImage
Short description

Notify MainApp image.

Callback arguments
Name Type Multiplicity Description

imageData

BINARY

1

Image data
Sample (auto-generated)
function handleOnNewImage(imageData)
  -- Do something
end

Script.register("CSK_SensorAppOverview.OnNewImage", "handleOnNewImage")
Short description

Notify link to MainApp.

Callback arguments
Name Type Multiplicity Description

link

STRING

1

Link
Sample (auto-generated)
function handleOnNewMainAppLink(link)
  -- Do something
end

Script.register("CSK_SensorAppOverview.OnNewMainAppLink", "handleOnNewMainAppLink")
CSK_SensorAppOverview.OnNewMainAppMode
Short description

Notify change of MainApp mode within UI.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Mode
Sample (auto-generated)
function handleOnNewMainAppMode(mode)
  -- Do something
end

Script.register("CSK_SensorAppOverview.OnNewMainAppMode", "handleOnNewMainAppMode")
CSK_SensorAppOverview.OnNewMainAppName
Short description

Notify name of MainApp.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Name of MainApp.
Sample (auto-generated)
function handleOnNewMainAppName(name)
  -- Do something
end

Script.register("CSK_SensorAppOverview.OnNewMainAppName", "handleOnNewMainAppName")
CSK_SensorAppOverview.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_SensorAppOverview.OnNewParameterName", "handleOnNewParameterName")
CSK_SensorAppOverview.OnNewSensorAppList
Short description

Notify list of available SensorApp names.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List of apps.
Sample (auto-generated)
function handleOnNewSensorAppList(list)
  -- Do something
end

Script.register("CSK_SensorAppOverview.OnNewSensorAppList", "handleOnNewSensorAppList")
CSK_SensorAppOverview.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_SensorAppOverview.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
CSK_SensorAppOverview.OnNewStatusEditMode
Short description

Notify status of edit mode.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_SensorAppOverview.OnNewStatusEditMode", "handleOnNewStatusEditMode")
CSK_SensorAppOverview.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_SensorAppOverview.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_SensorAppOverview.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_SensorAppOverview.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_SensorAppOverview.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_SensorAppOverview.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_SensorAppOverview.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_SensorAppOverview.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_SensorAppOverview.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_SensorAppOverview.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_SensorAppOverview.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_SensorAppOverview.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_SensorAppOverview.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_SensorAppOverview.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")