Document metadata

Application name

CSK_Template_CameraSetupMerged

Version

1.2.0

Date

2023-06-16

Author

SICK AG

Crowns

C

CSK_CameraSetupTemplate

Short description

CSK Template to show how CSK modules can be used to provide basic features for RemoteCamera setup.
Please have a look into the documentation of the used CSK modules.
It is possible to trigger a defaul setup via a button on the UI.
It will try power S1/S2 connectors and expects the cameras configured with IP 192.168.1.100 / 192.168.2.100 connected to ETH1/ETH2.
If succesfull it will show the incoming images on the UI.

Concerning required CSK modules to run this application, please refer to the README within GIT.

Overview

Functions

CSK_CameraSetupTemplate.loadDefaultSetup()
Short description

Function to load default camera setup config:
Camera powered on S1/S2 and connected to ETH1 / ETH2 with IPs 192.168.1.100 / 192.168.2.100

Sample (auto-generated)
CSK_CameraSetupTemplate.loadDefaultSetup()
CSK_CameraSetupTemplate.loadParameters()
Short description

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

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

Send parameters to CSK_PersistentData module if possible to save them.

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

Events

CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnNewParameterName", "handleOnNewParameterName")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_CameraSetupTemplate.OnNewStatusWaitingForSetup
Short description

Notify if currently waiting for camera setup.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_CameraSetupTemplate.OnNewStatusWaitingForSetup", "handleOnNewStatusWaitingForSetup")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_CameraSetupTemplate.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_CameraSetupTemplate.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_DeviceScanner

Short description

Module to scan and configure connected devices by using the Command.Scan CROWN.
This module provides a UI for all relevant features.
Typically the feature of this module is used like this:

1) Scan for devices. If wanted only a specific interface can be preselected for the scan.
2) Select a found device.
3) Preset new values for this device.
4) Activate this new setup by sending it to the device.

Overview

Functions

CSK_DeviceScanner.getDeviceListJSON()
Short description

Get json-list of found devices.

Return values
Name Type Multiplicity Description

deviceList

STRING

1

Json list of devices
Sample (auto-generated)
deviceList = CSK_DeviceScanner.getDeviceListJSON()
CSK_DeviceScanner.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_DeviceScanner.pageCalled()
CSK_DeviceScanner.scanForDevices()
Short description

Scan for connected devices via Command.Scan API.

Sample (auto-generated)
CSK_DeviceScanner.scanForDevices()
CSK_DeviceScanner.selectDevice()
Short description

Select entry of device list (used in UI).

Parameters
Name Type Multiplicity Description

selection

STRING

1

Selected device
Sample (auto-generated)
CSK_DeviceScanner.selectDevice(selection)
CSK_DeviceScanner.selectInterface()
Short description

Select interface to search on.

Parameters
Name Type Multiplicity Description

selection

STRING

1

Interface ID
Sample (auto-generated)
CSK_DeviceScanner.selectInterface(selection)
CSK_DeviceScanner.sendNewConfig()
Short description

Try to apply new config on selected device (before this use the "set…​" functions).

Sample (auto-generated)
CSK_DeviceScanner.sendNewConfig()
CSK_DeviceScanner.setDeviceIP()
Short description

Set new IP for selected device (see "selectDevice").

Parameters
Name Type Multiplicity Description

ip

STRING

1

IP
Sample (auto-generated)
CSK_DeviceScanner.setDeviceIP(ip)
CSK_DeviceScanner.setDHCP()
Short description

Set DHCP status for selected device (see "selectDevice").

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status of DHCP
Sample (auto-generated)
CSK_DeviceScanner.setDHCP(status)
CSK_DeviceScanner.setGateway()
Short description

Set Gateways for selected device (see "selectDevice").

Parameters
Name Type Multiplicity Description

gateway

STRING

1

Gateway IP
Sample (auto-generated)
CSK_DeviceScanner.setGateway(gateway)
CSK_DeviceScanner.setSubnetMask()
Short description

Set subnetmask for selected device (see "selectDevice").

Parameters
Name Type Multiplicity Description

subnetMask

STRING

1

Subnetmask
Sample (auto-generated)
CSK_DeviceScanner.setSubnetMask(subnetMask)

Events

CSK_DeviceScanner.OnDeviceSelected
Short description

Notify if a device was selected.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status if a device is selected.
Sample (auto-generated)
function handleOnDeviceSelected(status)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnDeviceSelected", "handleOnDeviceSelected")
CSK_DeviceScanner.OnNewDeviceTable
Short description

Notify json-list of found devices.

Callback arguments
Name Type Multiplicity Description

deviceTable

STRING

1

Json list of devices
Sample (auto-generated)
function handleOnNewDeviceTable(deviceTable)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewDeviceTable", "handleOnNewDeviceTable")
CSK_DeviceScanner.OnNewDHCPStatus
Short description

Notify DHCP status.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

DHCP status
Sample (auto-generated)
function handleOnNewDHCPStatus(status)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewDHCPStatus", "handleOnNewDHCPStatus")
CSK_DeviceScanner.OnNewErrorActive
Short description

Notify if error of input parameters is active.

Callback arguments
Name Type Multiplicity Description

active

BOOL

1

Status of error.
Sample (auto-generated)
function handleOnNewErrorActive(active)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewErrorActive", "handleOnNewErrorActive")
CSK_DeviceScanner.OnNewGateway
Short description

Notify Gateway setting.

Callback arguments
Name Type Multiplicity Description

gateway

STRING

1

Gateway IP
Sample (auto-generated)
function handleOnNewGateway(gateway)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewGateway", "handleOnNewGateway")
CSK_DeviceScanner.OnNewInterfaceList
Short description

Notify available interfaces.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

list of interfaces
Sample (auto-generated)
function handleOnNewInterfaceList(list)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewInterfaceList", "handleOnNewInterfaceList")
CSK_DeviceScanner.OnNewInterfaceSelected
Short description

Notify selected interface.

Callback arguments
Name Type Multiplicity Description

selection

STRING

1

Selected interface
Sample (auto-generated)
function handleOnNewInterfaceSelected(selection)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewInterfaceSelected", "handleOnNewInterfaceSelected")
CSK_DeviceScanner.OnNewIP
Short description

Notify IP setting.

Callback arguments
Name Type Multiplicity Description

ip

STRING

1

IP
Sample (auto-generated)
function handleOnNewIP(ip)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewIP", "handleOnNewIP")
CSK_DeviceScanner.OnNewScanStatus
Short description

Notify scan / setup status.

Callback arguments
Name Type Multiplicity Description

status

STRING

1

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

Script.register("CSK_DeviceScanner.OnNewScanStatus", "handleOnNewScanStatus")
CSK_DeviceScanner.OnNewSubnetMask
Short description

Notify Subnet setting.

Callback arguments
Name Type Multiplicity Description

subnetMask

STRING

1

Subnetmask
Sample (auto-generated)
function handleOnNewSubnetMask(subnetMask)
  -- Do something
end

Script.register("CSK_DeviceScanner.OnNewSubnetMask", "handleOnNewSubnetMask")
CSK_DeviceScanner.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_DeviceScanner.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_DeviceScanner.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_DeviceScanner.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_DeviceScanner.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_DeviceScanner.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_DeviceScanner.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_DeviceScanner.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_Logger

Short description

Module to provide logger functionality to log / store messages of all others CSK modules.
Maybe the name of this module needs to be adapted to run first and also to log messages of the global scopes.
Check UI of this module for most features available by this module.
INFO: If using the "FileSink" feature, a SD card should be used to reduce write accesses on the internal flash storage of the device.

Overview

Functions

CSK_Logger.loadParameters()
Short description

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

Sample (auto-generated)
CSK_Logger.loadParameters()
CSK_Logger.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_Logger.pageCalled()
CSK_Logger.reloadLogsInUI()
Short description

Function to reload logfile to show in UI.

Sample (auto-generated)
CSK_Logger.reloadLogsInUI()
CSK_Logger.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_Logger.sendParameters()
CSK_Logger.setAttachToEngineLogger()
Short description

Set status if logger should attach to engine logger.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_Logger.setAttachToEngineLogger(status)
CSK_Logger.setCallbackSinkActive()
Short description

Function to configure if internal callback sink should be used to process incoming log messages.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Is TRUE per default to process incoming log messages.
It can make sense to set it to FALSE if e.g. "FileSink" is active as this will reduce the internal needed processing load to only focus on the FileSink, but then no log messages will be forwarded via "OnNewMessage"-event or shown in UI by this module.
Sample (auto-generated)
CSK_Logger.setCallbackSinkActive(status)
CSK_Logger.setConsoleSinkEnabled()
Short description

Set status of console sink.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_Logger.setConsoleSinkEnabled(status)
CSK_Logger.setFileName()
Short description

Set name of the logging file.

Parameters
Name Type Multiplicity Description

name

STRING

1

Filename
Sample (auto-generated)
CSK_Logger.setFileName(name)
CSK_Logger.setFilePath()
Short description

Set path of the logging file.

Parameters
Name Type Multiplicity Description

path

STRING

1

Filepath
Sample (auto-generated)
CSK_Logger.setFilePath(path)
CSK_Logger.setFileSinkActive()
Short description

Set status of file sink of the log.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_Logger.setFileSinkActive(status)
CSK_Logger.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_Logger.setLoadOnReboot(status)
CSK_Logger.setLogFileSize()
Short description

Set size of the log file in bytes before truncating.

Parameters
Name Type Multiplicity Description

size

INT

1

Size in bites. Has to be in the range [1024,104857600] bytes.
Sample (auto-generated)
CSK_Logger.setLogFileSize(size)
CSK_Logger.setLogLevel()
Short description

Set log level.

Parameters
Name Type Multiplicity Description

level

ENUM
CSK_Logger.LogLevel

1

Log level
Sample (auto-generated)
CSK_Logger.setLogLevel(level)
CSK_Logger.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_Logger.setParameterName(name)

Events

CSK_Logger.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_Logger.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_Logger.OnNewCompleteLogfile
Short description

Notify all available log messages once.

Callback arguments
Name Type Multiplicity Description

logfile

STRING

?

Full temporary / stored logfile content.
Sample (auto-generated)
function handleOnNewCompleteLogfile(logfile)
  -- Do something
end

Script.register("CSK_Logger.OnNewCompleteLogfile", "handleOnNewCompleteLogfile")
CSK_Logger.OnNewFilename
Short description

Notify file name of the logging file.

Callback arguments
Name Type Multiplicity Description

filename

STRING

1

Filename
Sample (auto-generated)
function handleOnNewFilename(filename)
  -- Do something
end

Script.register("CSK_Logger.OnNewFilename", "handleOnNewFilename")
CSK_Logger.OnNewFilepath
Short description

Notify path of the logging file.

Callback arguments
Name Type Multiplicity Description

filepath

STRING

1

Path
Sample (auto-generated)
function handleOnNewFilepath(filepath)
  -- Do something
end

Script.register("CSK_Logger.OnNewFilepath", "handleOnNewFilepath")
CSK_Logger.OnNewFullFilePath
Short description

Notify full path of the logging file (path + name).

Callback arguments
Name Type Multiplicity Description

filepath

STRING

1

Full filepath (path + name).
Sample (auto-generated)
function handleOnNewFullFilePath(filepath)
  -- Do something
end

Script.register("CSK_Logger.OnNewFullFilePath", "handleOnNewFullFilePath")
CSK_Logger.OnNewLogfileSize
Short description

Notify max size of ligfile in bytes.

Callback arguments
Name Type Multiplicity Description

size

INT

1

Size
Sample (auto-generated)
function handleOnNewLogfileSize(size)
  -- Do something
end

Script.register("CSK_Logger.OnNewLogfileSize", "handleOnNewLogfileSize")
CSK_Logger.OnNewLogLevel
Short description

Notify log level to use.

Callback arguments
Name Type Multiplicity Description

level

STRING

1

Level to log.
Sample (auto-generated)
function handleOnNewLogLevel(level)
  -- Do something
end

Script.register("CSK_Logger.OnNewLogLevel", "handleOnNewLogLevel")
CSK_Logger.OnNewMessage
Short description

Notify latest received logging message.

Callback arguments
Name Type Multiplicity Description

message

STRING

1

Logging message
Sample (auto-generated)
function handleOnNewMessage(message)
  -- Do something
end

Script.register("CSK_Logger.OnNewMessage", "handleOnNewMessage")
CSK_Logger.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_Logger.OnNewParameterName", "handleOnNewParameterName")
CSK_Logger.OnNewStatusAttachedToEngineLogger
Short description

Notify status to attach logger to engine logger.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_Logger.OnNewStatusAttachedToEngineLogger", "handleOnNewStatusAttachedToEngineLogger")
CSK_Logger.OnNewStatusCallbackSink
Short description

Notify status if the internal callbackSink for log messages is active.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_Logger.OnNewStatusCallbackSink", "handleOnNewStatusCallbackSink")
CSK_Logger.OnNewStatusConsoleSink
Short description

Notify status of console sink.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_Logger.OnNewStatusConsoleSink", "handleOnNewStatusConsoleSink")
CSK_Logger.OnNewStatusFileSinkActive
Short description

Notify status of file sink.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_Logger.OnNewStatusFileSinkActive", "handleOnNewStatusFileSinkActive")
CSK_Logger.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_Logger.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_Logger.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_Logger.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_Logger.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_Logger.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_Logger.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 of Maintenance userlevel.
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
  -- Do something
end

Script.register("CSK_Logger.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_Logger.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 of Operator userlevel.
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
  -- Do something
end

Script.register("CSK_Logger.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_Logger.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

STRING

1

Status of Service userlevel.
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
  -- Do something
end

Script.register("CSK_Logger.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_MultiRemoteCamera

Short description

Module to provide RemoteCamera configuration functionality.
Multiple instances can be created and image processing will run in multiple threads on the device.
Incoming images can be forwarded to other apps / modules (see "setProcessingMode")

Typical features to use:

1) If multiple camera instances are available, selecte a specific camera via "setSelectedCam"
2) Set camera IP via "setCameraIP"
3) Select if GigE Vision camera or not via "setGigEVision"
3) Opt. use set-Function like setResizeFactor, setShutterTime, …​
3) Set processing mode via "setProcessingMode"
4) Start camera via "connectCamera"

There is also the possibility to edit GigE Vision camera parameters (check also available UI).

Overview

Functions

CSK_MultiRemoteCamera.addGigEVisionConfig()
Short description

Add preselected value to custom GigE Vision config (see "setGigEVisionParameter…​" functions).

Sample (auto-generated)
CSK_MultiRemoteCamera.addGigEVisionConfig()
CSK_MultiRemoteCamera.addInstance()
Short description

Function to add an additional camera instance.

Sample (auto-generated)
CSK_MultiRemoteCamera.addInstance()
CSK_MultiRemoteCamera.cameraSoftwareTrigger()
Short description

Trigger SW trigger on currently selected camera instance (see "setSelectedCam").

Sample (auto-generated)
CSK_MultiRemoteCamera.cameraSoftwareTrigger()
CSK_MultiRemoteCamera.cameraSpecificSoftwareTrigger()
Short description

Trigger a camera snapshot with camera selection.

Parameters
Name Type Multiplicity Description

cameraNo

INT

1

Camera to trigger.
Sample (auto-generated)
CSK_MultiRemoteCamera.cameraSpecificSoftwareTrigger(cameraNo)
CSK_MultiRemoteCamera.connectCamera()
Short description

Connect to currently selected camera instance (see "setSelectedCam").

Sample (auto-generated)
CSK_MultiRemoteCamera.connectCamera()
CSK_MultiRemoteCamera.disconnectCamera()
Short description

Function to disconnect currently selected camera instance (see "setSelectedCam").

Sample (auto-generated)
CSK_MultiRemoteCamera.disconnectCamera()
CSK_MultiRemoteCamera.getAcquisitionMode()
Short description

Get acquisition mode of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

mode

STRING

1

Acquisition mode (e.g. 'FIXED_FREQUENCY' / 'SOFTWARE_TRIGGER' / 'HARDWARE_TRIGGER').
Sample (auto-generated)
mode = CSK_MultiRemoteCamera.getAcquisitionMode()
CSK_MultiRemoteCamera.getCameraIP()
Short description

Get IP of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

ip

STRING

1

IP
Sample (auto-generated)
ip = CSK_MultiRemoteCamera.getCameraIP()
CSK_MultiRemoteCamera.getColorMode()
Short description

Get color mode of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

mode

STRING

1

Color mode (e.g. MONO8, COLOR8, RAW8).
Sample (auto-generated)
mode = CSK_MultiRemoteCamera.getColorMode()
CSK_MultiRemoteCamera.getFOVX()
Short description

Get Field of view in x-direction in [pixel] of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

values

INT

+

Array with min/max values.
Sample (auto-generated)
values = CSK_MultiRemoteCamera.getFOVX()
CSK_MultiRemoteCamera.getFOVY()
Short description

Get Field of view in y-direction in [pixel] of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

values

INT

+

Array with min/max values.
Sample (auto-generated)
values = CSK_MultiRemoteCamera.getFOVY()
CSK_MultiRemoteCamera.getFramerate()
Short description

Get framerate (in FIXED_FREQUENCY mode) of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

framerate

INT

1

Framerate (frames per second).
Sample (auto-generated)
framerate = CSK_MultiRemoteCamera.getFramerate()
CSK_MultiRemoteCamera.getGain()
Short description

Get gain of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

gain

FLOAT

1

Gain
Sample (auto-generated)
gain = CSK_MultiRemoteCamera.getGain()
CSK_MultiRemoteCamera.getGigEVision()
Short description

Get info if currently selected camera instance is a GigEVision camera (see "setSelectedCam").

Return values
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
status = CSK_MultiRemoteCamera.getGigEVision()
CSK_MultiRemoteCamera.getHardwareTriggerDelay()
Short description

Get trigger delay (in HARDWARE_TRIGGER mode) used in cFlow of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

value

INT

1

Delay in [ms].
Sample (auto-generated)
value = CSK_MultiRemoteCamera.getHardwareTriggerDelay()
CSK_MultiRemoteCamera.getInstancesAmount()
Short description

Get amount of created remote camera instances.

Return values
Name Type Multiplicity Description

amount

INT

1

Amount
Sample (auto-generated)
amount = CSK_MultiRemoteCamera.getInstancesAmount()
CSK_MultiRemoteCamera.getProcessingMode()
Short description

Get processing mode of currently selected camera.

Return values
Name Type Multiplicity Description

mode

STRING

1

Mode (APP, SCRIPT, BOTH).
Sample (auto-generated)
mode = CSK_MultiRemoteCamera.getProcessingMode()
CSK_MultiRemoteCamera.getResizeFactor()
Short description

Get resize factor used in module internal image processing of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

factor

FLOAT

1

Factor (0.1 - 1.0).
Sample (auto-generated)
factor = CSK_MultiRemoteCamera.getResizeFactor()
CSK_MultiRemoteCamera.getSelectedCam()
Short description

Get currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

camNo

INT

1

Camera instance no.
Sample (auto-generated)
camNo = CSK_MultiRemoteCamera.getSelectedCam()
CSK_MultiRemoteCamera.getShutterTime()
Short description

Get shutter time of currently selected camera instance (see "setSelectedCam").

Return values
Name Type Multiplicity Description

shutterTime

INT

1

Shutter time in [ms].
Sample (auto-generated)
shutterTime = CSK_MultiRemoteCamera.getShutterTime()
CSK_MultiRemoteCamera.loadParameters()
Short description

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

Sample (auto-generated)
CSK_MultiRemoteCamera.loadParameters()
CSK_MultiRemoteCamera.pageCalled()
Short description

Function to register "OnResume" of the module UI (only as helper function).

Return values
Name Type Multiplicity Description

emptyString

STRING

1

Empty string (only needed to simplify binding).
Sample (auto-generated)
emptyString = CSK_MultiRemoteCamera.pageCalled()
CSK_MultiRemoteCamera.removeGigEVisionConfig()
Short description

Remove preselected value from custom GigE Vision config (see "setGigEVisionParameterName" functions).

Sample (auto-generated)
CSK_MultiRemoteCamera.removeGigEVisionConfig()
CSK_MultiRemoteCamera.resetInstances()
Short description

Function to reset instances to one single camera instance.
IMPORTANT: As instances start their own threads, the module needs to be restarted if new instances are needed…​ (see AppEngine docu for "Script.startScript").

Sample (auto-generated)
CSK_MultiRemoteCamera.resetInstances()
CSK_MultiRemoteCamera.restartAllCameras()
Short description

Function to restart all camera instances.

Sample (auto-generated)
CSK_MultiRemoteCamera.restartAllCameras()
CSK_MultiRemoteCamera.selectGigEVisionConfig()
Short description

Select config entry in table of custom GigE Vision config (see also "removeGigEVisionConfig").

Parameters
Name Type Multiplicity Description

selection

INT

1

Selected entry within config table.
Sample (auto-generated)
CSK_MultiRemoteCamera.selectGigEVisionConfig(selection)
CSK_MultiRemoteCamera.selectGigEVisionConfigViaUITable()
Short description

Select GigE Vision parameter within custom config in UI table view (see also "removeGigEVisionConfig").

Parameters
Name Type Multiplicity Description

selection

STRING

1

Selected entry within config table.
Sample (auto-generated)
CSK_MultiRemoteCamera.selectGigEVisionConfigViaUITable(selection)
CSK_MultiRemoteCamera.selectGigEVisionParameterNameViaUITable()
Short description

Select GigE Vision Parameter to edit in UI.

Parameters
Name Type Multiplicity Description

selection

STRING

1

Selected table entry.
Sample (auto-generated)
CSK_MultiRemoteCamera.selectGigEVisionParameterNameViaUITable(selection)
CSK_MultiRemoteCamera.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_MultiRemoteCamera.sendParameters()
CSK_MultiRemoteCamera.setAcquisitionMode()
Short description

Set acquisition mode of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_MultiRemoteCamera.AcquisitionMode

1

Acquisition mode
Sample (auto-generated)
CSK_MultiRemoteCamera.setAcquisitionMode(mode)
CSK_MultiRemoteCamera.setCameraIP()
Short description

Set IP of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

ip

STRING

1

IP
Sample (auto-generated)
CSK_MultiRemoteCamera.setCameraIP(ip)
CSK_MultiRemoteCamera.setCameraModel()
Short description

Connected camera-model like Midicam2 or Basler-Camera.

Parameters
Name Type Multiplicity Description

camModel

ENUM
CSK_MultiRemoteCamera.CameraModel

1

Camera model
Sample (auto-generated)
CSK_MultiRemoteCamera.setCameraModel(camModel)
CSK_MultiRemoteCamera.setCameraMonitoring()
Short description

Function to select if camera status should be monitored on CameraOverView UI.

Parameters
Name Type Multiplicity Description

state

BOOL

1

State
Sample (auto-generated)
CSK_MultiRemoteCamera.setCameraMonitoring(state)
CSK_MultiRemoteCamera.setColorMode()
Short description

Set color mode of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_MultiRemoteCamera.ColorType

1

Color mode
Sample (auto-generated)
CSK_MultiRemoteCamera.setColorMode(mode)
CSK_MultiRemoteCamera.setDigitalTriggerPause()
Short description

Use preset trigger delay (in HARDWARE_TRIGGER mode) used in cFlow of currently selected camera instance (see "setSelectedCam").

Sample (auto-generated)
CSK_MultiRemoteCamera.setDigitalTriggerPause()
CSK_MultiRemoteCamera.setFOV()
Short description

Activate preconfigured field of view of currently selected camera instance (see "setSelectedCam").

Sample (auto-generated)
CSK_MultiRemoteCamera.setFOV()
CSK_MultiRemoteCamera.setFOVX()
Short description

Set Field of view in x-direction in [pixel] of currently selected camera instance (see "setSelectedCam").
Needs to be activated via "setFOV" after this.

Parameters
Name Type Multiplicity Description

values

INT

+

Array with Min/Max value.
Sample (auto-generated)
CSK_MultiRemoteCamera.setFOVX(values)
CSK_MultiRemoteCamera.setFOVY()
Short description

Set Field of view in y-direction in [pixel] of currently selected camera instance (see "setSelectedCam").
Needs to be activated via "setFOV" after this.

Parameters
Name Type Multiplicity Description

values

INT

+

Array with Min/Max value.
Sample (auto-generated)
CSK_MultiRemoteCamera.setFOVY(values)
CSK_MultiRemoteCamera.setFramerate()
Short description

Set framerate (in FIXED_FREQUENCY mode) of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

framerate

INT

1

Framerate (frames per second).
Sample (auto-generated)
CSK_MultiRemoteCamera.setFramerate(framerate)
CSK_MultiRemoteCamera.setGain()
Short description

Set gain of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

gain

FLOAT

1

Gain
Sample (auto-generated)
CSK_MultiRemoteCamera.setGain(gain)
CSK_MultiRemoteCamera.setGigEVision()
Short description

Select if currently selected camera instance is a GigEVision camera.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteCamera.setGigEVision(status)
CSK_MultiRemoteCamera.setGigEVisionParameterName()
Short description

Set GigEVision ParameterName to add for custom GigE Vision setting (see "addGigEVisionConfig").

Parameters
Name Type Multiplicity Description

name

STRING

1

Name of GigEVision parameter.
Sample (auto-generated)
CSK_MultiRemoteCamera.setGigEVisionParameterName(name)
CSK_MultiRemoteCamera.setGigEVisionParameterValue()
Short description

Set GigEVision ParameterValue to add for custom GigE Vision setting (see "addGigEVisionConfig").

Parameters
Name Type Multiplicity Description

value

STRING

1

Value
Sample (auto-generated)
CSK_MultiRemoteCamera.setGigEVisionParameterValue(value)
CSK_MultiRemoteCamera.setHardwareTriggerDelay()
Short description

Set trigger delay (in HARDWARE_TRIGGER mode) used in cFlow of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

value

INT

1

Delay in [ms].
Sample (auto-generated)
CSK_MultiRemoteCamera.setHardwareTriggerDelay(value)
CSK_MultiRemoteCamera.setImageFilePrefix()
Short description

Set prefix for filename of saved images for currently selected camera.

Parameters
Name Type Multiplicity Description

prefix

STRING

1

Prefix (followed by internal counter).
Sample (auto-generated)
CSK_MultiRemoteCamera.setImageFilePrefix(prefix)
CSK_MultiRemoteCamera.setImageSaveFormat()
Short description

Set format to store images with.

Parameters
Name Type Multiplicity Description

format

ENUM
CSK_MultiRemoteCamera.ImageFormat

1

Image format
Sample (auto-generated)
CSK_MultiRemoteCamera.setImageSaveFormat(format)
CSK_MultiRemoteCamera.setImageSaveFormatCompression()
Short description

Set compression to save images (depends on format type).

Parameters
Name Type Multiplicity Description

comp

FLOAT

1

See AppEngine CROWN Image.save
Sample (auto-generated)
CSK_MultiRemoteCamera.setImageSaveFormatCompression(comp)
CSK_MultiRemoteCamera.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_MultiRemoteCamera.setLoadOnReboot(status)
CSK_MultiRemoteCamera.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_MultiRemoteCamera.setParameterName(name)
CSK_MultiRemoteCamera.setProcessingMode()
Short description

ProcessingMode to define processing in this app or in a other app.

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_MultiRemoteCamera.ProcessingMode

1

Mode to use.
Sample (auto-generated)
CSK_MultiRemoteCamera.setProcessingMode(mode)
CSK_MultiRemoteCamera.setResizeFactor()
Short description

Set resize factor used in module internal image processing of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

factor

FLOAT

1

Factor (0.1 - 1.0).
Sample (auto-generated)
CSK_MultiRemoteCamera.setResizeFactor(factor)
CSK_MultiRemoteCamera.setSaveAllImages()
Short description

Set if all incoming images should be saved for currently selected camera.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteCamera.setSaveAllImages(status)
CSK_MultiRemoteCamera.setSavingPath()
Short description

Set path to save images via "saveImage".

Parameters
Name Type Multiplicity Description

path

STRING

1

Path on device (e.g. "public/images").
Sample (auto-generated)
CSK_MultiRemoteCamera.setSavingPath(path)
CSK_MultiRemoteCamera.setSelectedCam()
Short description

Select single camera instance (first select a instance, after that other functions like "set"-function will use this camera instance).

Parameters
Name Type Multiplicity Description

camNo

INT

1

camera intance no. to select.
Sample (auto-generated)
CSK_MultiRemoteCamera.setSelectedCam(camNo)
CSK_MultiRemoteCamera.setShutterTime()
Short description

Set shutter time of currently selected camera instance (see "setSelectedCam").

Parameters
Name Type Multiplicity Description

shutterTime

INT

1

Shutter time in [ms].
Sample (auto-generated)
CSK_MultiRemoteCamera.setShutterTime(shutterTime)
CSK_MultiRemoteCamera.setSwitchMode()
Short description

Set Switch-Mode for using multiple cameras via switch. This parameter will influence the "DeviceLinkThroughputLimit"-Parameter.
INFO: Please make sure to restart the cameras (e.g. via "restartAllCameras()" ) after adding new camera instances, so that the "DeviceLinkThroughputLimit" can be recalculated by the total amount of used cameras.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status. 'TRUE' if switch is used.
Sample (auto-generated)
CSK_MultiRemoteCamera.setSwitchMode(status)
CSK_MultiRemoteCamera.setTempImageActive()
Short description

Set status if images should be temporarily be saved to save them later on via "saveImage".

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteCamera.setTempImageActive(status)
CSK_MultiRemoteCamera.setViewerActive()
Short description

Set status if modules UI viewer should show the images.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Set to FALSE to save processing time if visualization is not necessary in modules UI.
Sample (auto-generated)
CSK_MultiRemoteCamera.setViewerActive(status)
CSK_MultiRemoteCamera.startCamera()
Short description

Start currently selected camera (see 'setSelectedCam').

Sample (auto-generated)
CSK_MultiRemoteCamera.startCamera()
CSK_MultiRemoteCamera.stopCamera()
Short description

Stop currently selected camera (see 'setSelectedCam').

Sample (auto-generated)
CSK_MultiRemoteCamera.stopCamera()
CSK_MultiRemoteCamera.triggerImageSaving()
Short description

Notify event for selected camera to trigger the saving of the latest temporarily saved image.

Sample (auto-generated)
CSK_MultiRemoteCamera.triggerImageSaving()
CSK_MultiRemoteCamera.updateConfig()
Short description

Update camera config (e.g. to activate new custom GigE Vision config).

Sample (auto-generated)
CSK_MultiRemoteCamera.updateConfig()

Events

CSK_MultiRemoteCamera.OnCameraConnected
Short description

Notify camera connection status.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnCameraConnected", "handleOnCameraConnected")
CSK_MultiRemoteCamera.OnCurrentCameraIP
Short description

Notify IP of currently selected camera.

Callback arguments
Name Type Multiplicity Description

ip

STRING

1

IP
Sample (auto-generated)
function handleOnCurrentCameraIP(ip)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnCurrentCameraIP", "handleOnCurrentCameraIP")
CSK_MultiRemoteCamera.OnDeregisterCameraNUM
Short description

Example of dynamically created event to deregister camera intsance to image processing function.
NUM will be replaced by the number of instance (e.g. "OnDeregisterCamera1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

camera

HANDLE
Image.Provider.RemoteCamera

1

Camera instance to deregister.
Sample (auto-generated)
function handleOnDeregisterCameraNUM(camera)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnDeregisterCameraNUM", "handleOnDeregisterCameraNUM")
CSK_MultiRemoteCamera.OnHWTriggerActive
Short description

Notify if hardware trigger is active for currently selected camera.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnHWTriggerActive", "handleOnHWTriggerActive")
CSK_MultiRemoteCamera.OnNewAcquisitionMode
Short description

Notify acquisition mode of currently selected camera.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Acquisition mode
Sample (auto-generated)
function handleOnNewAcquisitionMode(mode)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewAcquisitionMode", "handleOnNewAcquisitionMode")
CSK_MultiRemoteCamera.OnNewCameraList
Short description

Notify list of camera instances.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List of camera instances.
Sample (auto-generated)
function handleOnNewCameraList(list)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewCameraList", "handleOnNewCameraList")
CSK_MultiRemoteCamera.OnNewCameraModel
Short description

Camera-Model which is connected. Like Midicam2 or Basler-Camera.

Callback arguments
Name Type Multiplicity Description

cameraModel

STRING

1

Model of the camera.
Sample (auto-generated)
function handleOnNewCameraModel(cameraModel)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewCameraModel", "handleOnNewCameraModel")
CSK_MultiRemoteCamera.OnNewCameraOverviewTable
Short description

Notify content for camera overview in UI.

Callback arguments
Name Type Multiplicity Description

data

STRING

1

Data content for table.
Sample (auto-generated)
function handleOnNewCameraOverviewTable(data)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewCameraOverviewTable", "handleOnNewCameraOverviewTable")
CSK_MultiRemoteCamera.OnNewColorMode
Short description

Notify color mode of currently selected camera.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Color mode
Sample (auto-generated)
function handleOnNewColorMode(mode)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewColorMode", "handleOnNewColorMode")
CSK_MultiRemoteCamera.OnNewFormatCompression
Short description

Notify value of compression for image compression.

Callback arguments
Name Type Multiplicity Description

compression

FLOAT

1

INFO: Depends on format (see AppEngine function Image.save).
Sample (auto-generated)
function handleOnNewFormatCompression(compression)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewFormatCompression", "handleOnNewFormatCompression")
CSK_MultiRemoteCamera.OnNewFOVX
Short description

Notify field of view in x-direction of currently selected camera.

Callback arguments
Name Type Multiplicity Description

range

INT

+

Min/Max
Sample (auto-generated)
function handleOnNewFOVX(range)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewFOVX", "handleOnNewFOVX")
CSK_MultiRemoteCamera.OnNewFOVY
Short description

Notify field of view in y-direction of currently selected camera.

Callback arguments
Name Type Multiplicity Description

range

INT

+

Min/Max
Sample (auto-generated)
function handleOnNewFOVY(range)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewFOVY", "handleOnNewFOVY")
CSK_MultiRemoteCamera.OnNewFPSCamera
Short description

Notify latest calculated FPS of currently selected camera.

Callback arguments
Name Type Multiplicity Description

fps

STRING

1

Frames per second.
Sample (auto-generated)
function handleOnNewFPSCamera(fps)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewFPSCamera", "handleOnNewFPSCamera")
CSK_MultiRemoteCamera.OnNewFramerate
Short description

Notify framerate of currently selected camera instance.

Callback arguments
Name Type Multiplicity Description

framerate

INT

1

Framerate
Sample (auto-generated)
function handleOnNewFramerate(framerate)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewFramerate", "handleOnNewFramerate")
CSK_MultiRemoteCamera.OnNewGain
Short description

Notify gain of currently selected camera instance.

Callback arguments
Name Type Multiplicity Description

gain

FLOAT

1

Gain
Sample (auto-generated)
function handleOnNewGain(gain)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGain", "handleOnNewGain")
CSK_MultiRemoteCamera.OnNewGigEVisionConfigTableContent
Short description

Notify list of custom GigE Vision configs (for UI table view).

Callback arguments
Name Type Multiplicity Description

content

STRING

1
Sample (auto-generated)
function handleOnNewGigEVisionConfigTableContent(content)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionConfigTableContent", "handleOnNewGigEVisionConfigTableContent")
CSK_MultiRemoteCamera.OnNewGigEVisionCurrentParameter
Short description

Notify currently selected GigEVision parameter name to edit.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Parameter name
Sample (auto-generated)
function handleOnNewGigEVisionCurrentParameter(name)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionCurrentParameter", "handleOnNewGigEVisionCurrentParameter")
CSK_MultiRemoteCamera.OnNewGigEVisionParameters
Short description

Notify available GigEVision parameter list received from connected camera.

Callback arguments
Name Type Multiplicity Description

parameters

STRING

1

Parameter list
Sample (auto-generated)
function handleOnNewGigEVisionParameters(parameters)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionParameters", "handleOnNewGigEVisionParameters")
CSK_MultiRemoteCamera.OnNewGigEVisionParameterType
Short description

Notify type of currently selected GigEVision parameter.

Callback arguments
Name Type Multiplicity Description

valueType

STRING

1

Value Type (e.g. 'String'/'Float'/'Integer').
Sample (auto-generated)
function handleOnNewGigEVisionParameterType(valueType)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionParameterType", "handleOnNewGigEVisionParameterType")
CSK_MultiRemoteCamera.OnNewGigEVisionStatus
Short description

Notify if currently selected camera is GigEVision.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionStatus", "handleOnNewGigEVisionStatus")
CSK_MultiRemoteCamera.OnNewGigEVisionTableContent
Short description

Notify list of available GigE Vision parameters (for UI table view).

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List
Sample (auto-generated)
function handleOnNewGigEVisionTableContent(list)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionTableContent", "handleOnNewGigEVisionTableContent")
CSK_MultiRemoteCamera.OnNewGigEVisionValue
Short description

Notify value of currently selected GigEVision parameter.

Callback arguments
Name Type Multiplicity Description

value

STRING

1

Value
Sample (auto-generated)
function handleOnNewGigEVisionValue(value)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewGigEVisionValue", "handleOnNewGigEVisionValue")
CSK_MultiRemoteCamera.OnNewHardwareTriggerDelay
Short description

Notify hardware trigger delay of currently selected camera instance.

Callback arguments
Name Type Multiplicity Description

value

INT

1

Delay in [ms].
Sample (auto-generated)
function handleOnNewHardwareTriggerDelay(value)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewHardwareTriggerDelay", "handleOnNewHardwareTriggerDelay")
CSK_MultiRemoteCamera.OnNewImageCameraNUM
Short description

Example of dynamically created event to transfer incoming image of camera instance.
NUM will be replaced by the number of instance (e.g. "OnNewImageCamera1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

image

OBJECT
Image

1

Image

timestamp

INT

?

Timestamp is created directly after module received new image.
Sample (auto-generated)
function handleOnNewImageCameraNUM(image, timestamp)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewImageCameraNUM", "handleOnNewImageCameraNUM")
CSK_MultiRemoteCamera.OnNewImageFilePrefix
Short description

Notify image file prefix to use.

Callback arguments
Name Type Multiplicity Description

prefix

STRING

1

Prefix (followed by internal counter)
Sample (auto-generated)
function handleOnNewImageFilePrefix(prefix)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewImageFilePrefix", "handleOnNewImageFilePrefix")
CSK_MultiRemoteCamera.OnNewImageProcessingParameter
Short description

Event to share processing parameters to the instances.

Callback arguments
Name Type Multiplicity Description

cameraNo

INT

1

Number of the instance to receive the parameter.

parameter

STRING

1

Name of the parameter.

value

AUTO

?

Value to set.
Sample (auto-generated)
function handleOnNewImageProcessingParameter(cameraNo, parameter, value)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewImageProcessingParameter", "handleOnNewImageProcessingParameter")
CSK_MultiRemoteCamera.OnNewImageQueueCamera
Short description

Notify queue size of module internal image processing function of currently selected camera.

Callback arguments
Name Type Multiplicity Description

value

STRING

1

Size
Sample (auto-generated)
function handleOnNewImageQueueCamera(value)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewImageQueueCamera", "handleOnNewImageQueueCamera")
CSK_MultiRemoteCamera.OnNewImageSaveFormat
Short description

Notify format to save images.

Callback arguments
Name Type Multiplicity Description

format

STRING

1

BMP / JPEG / PNG
Sample (auto-generated)
function handleOnNewImageSaveFormat(format)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewImageSaveFormat", "handleOnNewImageSaveFormat")
CSK_MultiRemoteCamera.OnNewImageSizeToShare
Short description

Notify if image size changed to other modules.

Callback arguments
Name Type Multiplicity Description

eventname

STRING

1

Name of event providing images.
Sample (auto-generated)
function handleOnNewImageSizeToShare(eventname)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewImageSizeToShare", "handleOnNewImageSizeToShare")
CSK_MultiRemoteCamera.OnNewIPCheck
Short description

Notify if inserted IP has correct format.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewIPCheck", "handleOnNewIPCheck")
CSK_MultiRemoteCamera.OnNewLoggingMessage
Short description

Notify latest logging message of this module.

Callback arguments
Name Type Multiplicity Description

message

STRING

1

Latest log message.
Sample (auto-generated)
function handleOnNewLoggingMessage(message)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewLoggingMessage", "handleOnNewLoggingMessage")
CSK_MultiRemoteCamera.OnNewMonitoring
Short description

Notify if currently selected camera is monitored.

Callback arguments
Name Type Multiplicity Description

state

BOOL

1

State
Sample (auto-generated)
function handleOnNewMonitoring(state)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewMonitoring", "handleOnNewMonitoring")
CSK_MultiRemoteCamera.OnNewMonitoringState
Short description

Notify if currently selected camera is available or not.

Callback arguments
Name Type Multiplicity Description

state

BOOL

1

State
Sample (auto-generated)
function handleOnNewMonitoringState(state)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewMonitoringState", "handleOnNewMonitoringState")
CSK_MultiRemoteCamera.OnNewMonitoringStateCams
Short description

Notify if the cameras is available or not.

Callback arguments
Name Type Multiplicity Description

cameraNr

INT

1

camera number

state

BOOL

1

state
Sample (auto-generated)
function handleOnNewMonitoringStateCams(cameraNr, state)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewMonitoringStateCams", "handleOnNewMonitoringStateCams")
CSK_MultiRemoteCamera.OnNewNumberOfCameras
Short description

Notify number of camera instances.

Callback arguments
Name Type Multiplicity Description

numberOfCameras

STRING

1

Number of cameras.
Sample (auto-generated)
function handleOnNewNumberOfCameras(numberOfCameras)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewNumberOfCameras", "handleOnNewNumberOfCameras")
CSK_MultiRemoteCamera.OnNewParameterName
Short description

Notify name of the parameters if saved/loaded via the CSK_PersistentData module for currently selected camera instance.

Callback arguments
Name Type Multiplicity Description

parametersName

STRING

1

Name
Sample (auto-generated)
function handleOnNewParameterName(parametersName)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewParameterName", "handleOnNewParameterName")
CSK_MultiRemoteCamera.OnNewProcessingMode
Short description

Notify processing mode of currently selected camera.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

Mode (BOTH, SCRIPT or APP).
Sample (auto-generated)
function handleOnNewProcessingMode(mode)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewProcessingMode", "handleOnNewProcessingMode")
CSK_MultiRemoteCamera.OnNewResizeFactor
Short description

Notify resize factor of internal image processing function of currently selected camera.

Callback arguments
Name Type Multiplicity Description

factor

FLOAT

1

Factor (0.1. - 1.0).
Sample (auto-generated)
function handleOnNewResizeFactor(factor)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewResizeFactor", "handleOnNewResizeFactor")
CSK_MultiRemoteCamera.OnNewSavingImagesPath
Short description

Notify path to save images of currently selected camera.

Callback arguments
Name Type Multiplicity Description

path

STRING

1

Path
Sample (auto-generated)
function handleOnNewSavingImagesPath(path)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewSavingImagesPath", "handleOnNewSavingImagesPath")
CSK_MultiRemoteCamera.OnNewSelectedCam
Short description

Notify no. of currently selected camera instance.

Callback arguments
Name Type Multiplicity Description

cameraNo

INT

1

Camera no.
Sample (auto-generated)
function handleOnNewSelectedCam(cameraNo)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewSelectedCam", "handleOnNewSelectedCam")
CSK_MultiRemoteCamera.OnNewShutterTime
Short description

Notify shutter time of currently selected camera instance.

Callback arguments
Name Type Multiplicity Description

shutterTime

INT

1

Shutter time in [ms].
Sample (auto-generated)
function handleOnNewShutterTime(shutterTime)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewShutterTime", "handleOnNewShutterTime")
CSK_MultiRemoteCamera.OnNewStatusDigitalTriggerPause
Short description

Notify if digital trigger input should be ignored for currently selected camera instance. (e.g. used to freeze/inspect latest incoming image).

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewStatusDigitalTriggerPause", "handleOnNewStatusDigitalTriggerPause")
CSK_MultiRemoteCamera.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_MultiRemoteCamera.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_MultiRemoteCamera.OnNewStatusSaveAllImagesActive
Short description

Notify if all images should be saved.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewStatusSaveAllImagesActive", "handleOnNewStatusSaveAllImagesActive")
CSK_MultiRemoteCamera.OnNewStatusTempImageActive
Short description

Notify if latest image of currently selected camera instance should be temporarily be saved to store them eventually.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewStatusTempImageActive", "handleOnNewStatusTempImageActive")
CSK_MultiRemoteCamera.OnNewStatusViewerActive
Short description

Notify if UI viewer of currently selected camera instance should show image.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewStatusViewerActive", "handleOnNewStatusViewerActive")
CSK_MultiRemoteCamera.OnNewStatusWaitingForCameraBootUp
Short description

Notify if module is curently waiting for camera boot up.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnNewStatusWaitingForCameraBootUp", "handleOnNewStatusWaitingForCameraBootUp")
CSK_MultiRemoteCamera.OnNewSwitchMode
Short description

Notify if currently selected camera is in SwitchMode.

Callback arguments
Name Type Multiplicity Description

state

BOOL

1

State
Sample (auto-generated)
function handleOnNewSwitchMode(state)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewSwitchMode", "handleOnNewSwitchMode")
CSK_MultiRemoteCamera.OnNewValueToForwardNUM
Short description

Example of dynamically created event to Forward thread internal values to e.g. be notified with single event related to UI.
NUM will be replaced by the number of instance (e.g. "OnNewValueToForward1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

event

STRING

1

Related, general event.

value

AUTO

1

Value to notify.
Sample (auto-generated)
function handleOnNewValueToForwardNUM(event, value)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
CSK_MultiRemoteCamera.OnNewViewerID
Short description

Notify currently used viewerID (e.g. to show correct viewer in UI).

Callback arguments
Name Type Multiplicity Description

viewerID

STRING

1

viewerID
Sample (auto-generated)
function handleOnNewViewerID(viewerID)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnNewViewerID", "handleOnNewViewerID")
CSK_MultiRemoteCamera.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_MultiRemoteCamera.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_MultiRemoteCamera.OnRegisterCameraNUM
Short description

Example of dynamically created event to register camera intsance to image processing function.
NUM will be replaced by the number of instance (e.g. "OnRegisterCamera1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

camera

HANDLE
Image.Provider.RemoteCamera

1

Camera instance to register.
Sample (auto-generated)
function handleOnRegisterCameraNUM(camera)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnRegisterCameraNUM", "handleOnRegisterCameraNUM")
CSK_MultiRemoteCamera.OnScanCamera
Short description

Notify if scanning for connected camera is active.

Callback arguments
Name Type Multiplicity Description

active

BOOL

1

Status
Sample (auto-generated)
function handleOnScanCamera(active)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnScanCamera", "handleOnScanCamera")
CSK_MultiRemoteCamera.OnSWTriggerActive
Short description

Notify if SOFTWARE_TRIGGER camera mode is active (e.g. to visualize relevant UI elements).

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteCamera.OnSWTriggerActive", "handleOnSWTriggerActive")
CSK_MultiRemoteCamera.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 of Admin userlevel.
Sample (auto-generated)
function handleOnUserLevelAdminActive(status)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_MultiRemoteCamera.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 of Maintenance userlevel.
Sample (auto-generated)
function handleOnUserLevelMaintenanceActive(status)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_MultiRemoteCamera.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 of Operator userlevel.
Sample (auto-generated)
function handleOnUserLevelOperatorActive(status)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_MultiRemoteCamera.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 of Service userlevel.
Sample (auto-generated)
function handleOnUserLevelServiceActive(status)
  -- Do something
end

Script.register("CSK_MultiRemoteCamera.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_PersistentData

Short description

Module to provide data storage functionality incl. complex data types like Images, EdgeMatcher etc.

Function scope :
1) Possibility to save tables into persistent data.
1.1) Main DataSet with sub parameters of each available / configured module.
1.2) Will be handled internally as Container + table content.
1.3) Saves data as a binary file.

2) This module will provide a (loaded) DataSet for other CSK modules.
2.1) This DataSet can hold multiple ParameterSets by name.
2.1.1) Internally, this is one Container with multiple Sub-Containers.
2.2) The module can provide SubContainer content to other modules, selected by its name.

3) Other modules can define inside of the parameters, if they should load their parameters on app reboot.

4) This module will notify a "CSK_PersistentData.OnInitialDataLoaded" event, so that other modules can register on that event to load their specific parameters as soon as they are available.

How to use:
Save
1) Via "addParameter" it is possible to send (multiple times) data as a Container to this module and to store it with a specific parameter name. (e.g. "cameraSetup1").
2) Via "setModuleParameterName" it can be defined, which parameter should be loaded for a specific module during app/device reboot and if this should be active.
3) Via "setPath" it can be defined, where to store the full parameter dataset (including all available module parameters).
4) Via "saveData" the module will save the parameter dataset within a file defined with "setPath".

Load
1) Try to load saved parameter dataset via "loadContent" out of file defined via "setPath".
1.1) Info: With app/device reboot, the module will try this automatically and will notify the event "OnInitialDataLoaded" if successful.
2) Other modules can now load their specific parameter via "getParameter".

Overview

Functions

CSK_PersistentData.addParameter()
Short description

Add incoming parameters (from other CSK modules) to current persistent data.

Parameters
Name Type Multiplicity Description

data

OBJECT
Container

1

Parameters to store

name

STRING

1

identification name to store the parameters.
Sample (auto-generated)
CSK_PersistentData.addParameter(data, name)
CSK_PersistentData.createNewDataSet()
Short description

Create new CSK_PersistentData dataset.

Sample (auto-generated)
CSK_PersistentData.createNewDataSet()
CSK_PersistentData.fileUploadFinished()
Short description

Check if upload transfer was succesfull.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status of file transfer
Sample (auto-generated)
CSK_PersistentData.fileUploadFinished(status)
CSK_PersistentData.getModuleParameterName()
Short description

Function to get parameter. Can be used by other modules to receive their parameters.

Parameters
Name Type Multiplicity Description

module

STRING

1

Module to get name of parameters dataset to use.

instance

STRING

?

Number of instance (for multi modules only).
Return values
Name Type Multiplicity Description

name

STRING

?

Name of the dataset to use.

loadOnReboot

BOOL

?

Status if parameter should be loaded on device / app reboot.

totalInstances

INT

?

Number of amount of available instances.
Sample (auto-generated)
name, loadOnReboot, totalInstances = CSK_PersistentData.getModuleParameterName(module, instance)
CSK_PersistentData.getParameter()
Short description

Provide parameters of current persistent data by name.

Parameters
Name Type Multiplicity Description

name

STRING

1

identification name of the parameters to provide.
Return values
Name Type Multiplicity Description

dataContent

OBJECT
Container

?

Parameters
Sample (auto-generated)
dataContent = CSK_PersistentData.getParameter(name)
CSK_PersistentData.getParameterList()
Short description

Provide list of available parameters.

Return values
Name Type Multiplicity Description

list

STRING

1

List of identification names of the available parameters.
Sample (auto-generated)
list = CSK_PersistentData.getParameterList()
CSK_PersistentData.getVersion()
Short description

Get version of module.

Return values
Name Type Multiplicity Description

version

STRING

1

Version of module.
Sample (auto-generated)
version = CSK_PersistentData.getVersion()
CSK_PersistentData.loadContent()
Short description

Load set of parameters out of path (see "setPath").

Return values
Name Type Multiplicity Description

success

BOOL

1

Success of loading parameter set.
Sample (auto-generated)
success = CSK_PersistentData.loadContent()
CSK_PersistentData.overwriteData()
Short description

Function to overwrite current parameters by uploaded parameters.

Sample (auto-generated)
CSK_PersistentData.overwriteData()
CSK_PersistentData.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_PersistentData.pageCalled()
CSK_PersistentData.removeParameter()
Short description

Delete parameter of current parameter set by identification name.

Parameters
Name Type Multiplicity Description

name

STRING

1

Identification name
Sample (auto-generated)
CSK_PersistentData.removeParameter(name)
CSK_PersistentData.removeParameterViaUI()
Short description

Remove selected parameter dataset via UI.

Sample (auto-generated)
CSK_PersistentData.removeParameterViaUI()
CSK_PersistentData.saveData()
Short description

Save current parameter set.

Return values
Name Type Multiplicity Description

success

BOOL

1

Success of saving parameters.
Sample (auto-generated)
success = CSK_PersistentData.saveData()
CSK_PersistentData.setModuleParameterName()
Short description

Set parameter name for a module.

Parameters
Name Type Multiplicity Description

module

STRING

1

Module to save the parameter name for.

name

STRING

1

Name of the parameter dataset.

loadOnReboot

BOOL

1

Status if parameter should be loaded on device / app reboot.

instance

STRING

?

Number of instance (for multi modules only).

totalInstances

INT

?

Amount of total available instances.
Sample (auto-generated)
CSK_PersistentData.setModuleParameterName(module, name, loadOnReboot, instance, totalInstances)
CSK_PersistentData.setPath()
Short description

Set the path to load/save the parameter set.

Parameters
Name Type Multiplicity Description

path

STRING

1

Path of the parameter set.
Sample (auto-generated)
CSK_PersistentData.setPath(path)
CSK_PersistentData.setSelectedParameterName()
Short description

Select dataset to list its parameters.

Parameters
Name Type Multiplicity Description

selection

STRING

?

Parameter dataset to list
Sample (auto-generated)
CSK_PersistentData.setSelectedParameterName(selection)

Events

CSK_PersistentData.OnInitialDataLoaded
Short description

Notify that inital parameter set was loaded after app/device reboot.

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

Script.register("CSK_PersistentData.OnInitialDataLoaded", "handleOnInitialDataLoaded")
CSK_PersistentData.OnInstanceAmountAvailable
Short description

Notify if amount of instances are available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_PersistentData.OnInstanceAmountAvailable", "handleOnInstanceAmountAvailable")
CSK_PersistentData.OnNewContent
Short description

Notify new content in parameter set.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List of content.
Sample (auto-generated)
function handleOnNewContent(list)
  -- Do something
end

Script.register("CSK_PersistentData.OnNewContent", "handleOnNewContent")
CSK_PersistentData.OnNewDataPath
Short description

Notify path of parameter set.

Callback arguments
Name Type Multiplicity Description

parameterPath

STRING

1

Path of the parameters.
Sample (auto-generated)
function handleOnNewDataPath(parameterPath)
  -- Do something
end

Script.register("CSK_PersistentData.OnNewDataPath", "handleOnNewDataPath")
CSK_PersistentData.OnNewDatasetList
Short description

Notify list of dataset entries.

Callback arguments
Name Type Multiplicity Description

list

STRING

?

List of entries.
Sample (auto-generated)
function handleOnNewDatasetList(list)
  -- Do something
end

Script.register("CSK_PersistentData.OnNewDatasetList", "handleOnNewDatasetList")
CSK_PersistentData.OnNewFeedbackStatus
Short description

Notify current module status.

Callback arguments
Name Type Multiplicity Description

status

STRING

1

Status of the module.
Sample (auto-generated)
function handleOnNewFeedbackStatus(status)
  -- Do something
end

Script.register("CSK_PersistentData.OnNewFeedbackStatus", "handleOnNewFeedbackStatus")
CSK_PersistentData.OnNewParameterSelection
Short description

Notify current parameter dataset selection. E.g. used within the UI to select what content to show.

Callback arguments
Name Type Multiplicity Description

parameterName

STRING

1

Name of the parameter dataset.
Sample (auto-generated)
function handleOnNewParameterSelection(parameterName)
  -- Do something
end

Script.register("CSK_PersistentData.OnNewParameterSelection", "handleOnNewParameterSelection")
CSK_PersistentData.OnNewParameterTableInfo
Short description

Notify table info of parameters. Used within the UI to show content.

Callback arguments
Name Type Multiplicity Description

content

STRING

1

Data content of selected dataset.
Sample (auto-generated)
function handleOnNewParameterTableInfo(content)
  -- Do something
end

Script.register("CSK_PersistentData.OnNewParameterTableInfo", "handleOnNewParameterTableInfo")
CSK_PersistentData.OnNewStatusTempFileAvailable
Short description

Notify if temporary uploaded parameter file is available.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_PersistentData.OnNewStatusTempFileAvailable", "handleOnNewStatusTempFileAvailable")
CSK_PersistentData.OnNewUserManagementTrigger
Short description

Notify trigger to update UserManagement status.

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

Script.register("CSK_PersistentData.OnNewUserManagementTrigger", "handleOnNewUserManagementTrigger")
CSK_PersistentData.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_PersistentData.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_PersistentData.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_PersistentData.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_PersistentData.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_PersistentData.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_PersistentData.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_PersistentData.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_PowerManager

Short description

Module to manage PowerPort configurations.
This module provides a UI for all relevant features.

Typically the feature of this module is used like this:

1) If needed, check for current status of interface, e.g. via getCurrentPortStatus('S2').

2) If status needs to be changed, change it e.g. via changeStatusOfPort('S2').

3) Optionally do this for other interfaces.

4) Activate all configs by calling once setAllStatus().

Overview

Functions

CSK_PowerManager.changeStatusOfPort()
Short description

Set power status pre-configuration of a specific port (see also "setAllStatus").

Parameters
Name Type Multiplicity Description

portName

STRING

1

Name of port.
Sample (auto-generated)
CSK_PowerManager.changeStatusOfPort(portName)
CSK_PowerManager.getCurrentPortStatus()
Short description

Get current status of a specific port.

Parameters
Name Type Multiplicity Description

port

STRING

1

Name of port.
Return values
Name Type Multiplicity Description

status

BOOL

?

Current power status.
Sample (auto-generated)
status = CSK_PowerManager.getCurrentPortStatus(port)
CSK_PowerManager.loadParameters()
Short description

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

Sample (auto-generated)
CSK_PowerManager.loadParameters()
CSK_PowerManager.pageCalled()
Short description

Function to register "OnResume" of the module UI (only as helper function).

Return values
Name Type Multiplicity Description

emptyString

STRING

1

Empty string (only needed to simplify binding).
Sample (auto-generated)
emptyString = CSK_PowerManager.pageCalled()
CSK_PowerManager.selectInterface()
Short description

Select interface (via table in UI) to configure.

Parameters
Name Type Multiplicity Description

selection

STRING

1

Interface to select.
Sample (auto-generated)
CSK_PowerManager.selectInterface(selection)
CSK_PowerManager.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_PowerManager.sendParameters()
CSK_PowerManager.setAllStatus()
Short description

Set all ports by preconfigured setting (see also "changeStatusOfPort").

Sample (auto-generated)
CSK_PowerManager.setAllStatus()
CSK_PowerManager.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_PowerManager.setLoadOnReboot(status)
CSK_PowerManager.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_PowerManager.setParameterName(name)

Events

CSK_PowerManager.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_PowerManager.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_PowerManager.OnNewInterfaceList
Short description

Notify list of available interfaces.

Callback arguments
Name Type Multiplicity Description

interfaceList

STRING

1

List of interfaces.
Sample (auto-generated)
function handleOnNewInterfaceList(interfaceList)
  -- Do something
end

Script.register("CSK_PowerManager.OnNewInterfaceList", "handleOnNewInterfaceList")
CSK_PowerManager.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_PowerManager.OnNewParameterName", "handleOnNewParameterName")
CSK_PowerManager.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_PowerManager.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_PowerManager.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_PowerManager.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_PowerManager.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_PowerManager.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_PowerManager.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_PowerManager.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_PowerManager.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_PowerManager.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_PowerManager.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_PowerManager.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_PowerManager.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_PowerManager.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_Template_CameraSetupMerged

Short description

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

Enumerations

C

CSK_Logger.LogLevel

Level of messages to log.

Items
Value Name Description 
ALL

ALL

Log all messages.

 
OFF

OFF

Log nothing.

 
INFO

INFO

Log infos, warnings and severe errors.

 
SEVERE

SEVERE

Log only severe errors.

 
WARNING

WARNING

Log warnings and severe errors.

CSK_MultiRemoteCamera.AcquisitionMode

Acquisition / trigger mode of the camera.

Items
Value Name Description 
SOFTWARE_TRIGGER

SOFTWARE_TRIGGER

Software trigger (e.g. via UI button or incoming command like TCPIP command).

 
HARDWARE_TRIGGER

HARDWARE_TRIGGER

Trigger via digital input.

 
FIXED_FREQUENCY

FIXED_FREQUENCY

Continuous image acquisition with fixed framerate.

CSK_MultiRemoteCamera.CameraModel

Camera type.

Items
Value Name Description 
SICK Pico/MidiCam2

SICK_Gen2

SICK Pico/MidiCam2

 
Basler a2A1920-51gc

Basler

Basler a2A1920-51gc

CSK_MultiRemoteCamera.ColorType

Camera color type.

Items
Value Name Description 
MONO8

MONO8

Gray values

 
RAW8

RAW8

Raw data (Bayer pattern).

 
COLOR8

COLOR8

Color

CSK_MultiRemoteCamera.ImageFormat

Format to save images.

Items
Value Name Description 
bmp

bmp

BMP

 
jpg

jpg

JPG

 
png

png

PNG

CSK_MultiRemoteCamera.ProcessingMode

Processing in same module or in another app.

Items
Value Name Description 
BOTH

BOTH

'SCRIPT'+'APP' (e.g. you want to process the image within the internal script but would like to show the image also in another app).

 
SCRIPT

SCRIPT

Handle image only in this module.

 
APP

APP

Forward incoming images as event, so that other apps/modules can handle them.