Document metadata

Application name

CSK_Module_OPCUAServer

Version

0.1.0

Date

2025-02-20

Author

SICK AG

Crowns

C
O

CSK_Module_OPCUAServer

Short description

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

Overview

CSK_OPCUAServer

Short description

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

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

2) Something else…​

Overview

Functions

CSK_OPCUAServer.clearFlowConfigRelevantConfiguration()
Short description

Function to clear FlowConfig relevant configurations.

Sample (auto-generated)
CSK_OPCUAServer.clearFlowConfigRelevantConfiguration()
CSK_OPCUAServer.getParameters()
Short description

Function to get all parameters of the client in JSON format.

Return values
Name Type Multiplicity Description

jsonParameters

STRING

1

JSON string with all parameters.
Sample (auto-generated)
jsonParameters = CSK_OPCUAServer.getParameters()
CSK_OPCUAServer.getStatusModuleActive()
Short description

Function to get status if module is active.

Return values
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
status = CSK_OPCUAServer.getStatusModuleActive()
CSK_OPCUAServer.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_OPCUAServer.loadParameters()
CSK_OPCUAServer.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_OPCUAServer.pageCalled()
CSK_OPCUAServer.resetModule()
Short description

Function to reset main configuration of module.

Sample (auto-generated)
CSK_OPCUAServer.resetModule()
CSK_OPCUAServer.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_OPCUAServer.sendParameters(noDataSave)
CSK_OPCUAServer.setEventToRegister()
Short description

Function to set event to receive data.

Parameters
Name Type Multiplicity Description

event

STRING

1

Name of event.
Sample (auto-generated)
CSK_OPCUAServer.setEventToRegister(event)
CSK_OPCUAServer.setFlowConfigPriority()
Short description

Function to configure if FlowConfig should have priority for FlowConfig relevant configuration.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_OPCUAServer.setFlowConfigPriority(status)
CSK_OPCUAServer.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_OPCUAServer.setLoadOnReboot(status)
CSK_OPCUAServer.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_OPCUAServer.setParameterName(name)

Events

CSK_OPCUAServer.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_OPCUAServer.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_OPCUAServer.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_OPCUAServer.OnNewParameterName", "handleOnNewParameterName")
CSK_OPCUAServer.OnNewResult
Short description

Notify new result…​

Callback arguments
Name Type Multiplicity Description

result

AUTO

1

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

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

Notify event to register to and to process data.

Callback arguments
Name Type Multiplicity Description

eventName

STRING

1

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

Script.register("CSK_OPCUAServer.OnNewStatusEventToRegister", "handleOnNewStatusEventToRegister")
CSK_OPCUAServer.OnNewStatusFlowConfigPriority
Short description

Notify if FlowConfig should have priority for FlowConfig relevant configurations.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_OPCUAServer.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
CSK_OPCUAServer.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_OPCUAServer.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_OPCUAServer.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_OPCUAServer.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_OPCUAServer.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_OPCUAServer.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_OPCUAServer.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_OPCUAServer.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_OPCUAServer.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_OPCUAServer.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_OPCUAServer.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_OPCUAServer.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_OPCUAServer.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_OPCUAServer.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_OPCUAServer.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_OPCUAServer.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

OPCUAServer_FC

Short description

Crown to provide CSK_FlowConfig relevant features.

Overview

OPCUAServer_FC.Consumer

Short description

Set something e.g. to process.

Overview

Functions

OPCUAServer_FC.Consumer.consume()
Short description

E.g. set source event of incoming data to process.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

source

STRING

1

E.g. event to set to get data to process. Parameter: (e.g. like) 1: Data (STRING or IMAGE) 2: Optional name to store data (STRING)
Sample (auto-generated)
OPCUAServer_FC.Consumer.consume(handle, source)
OPCUAServer_FC.Consumer.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

mode

ENUM
ModuleName_FC.ModeType

1

Optional parameter if needed…​
Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = OPCUAServer_FC.Consumer.create(mode)

OPCUAServer_FC.Process

Short description

Set source event of incoming data and provide result event.

Overview

Functions

OPCUAServer_FC.Process.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

Mode

ENUM
ModuleName_FC.ModeType

1

Optional mode if needed…​.
Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = OPCUAServer_FC.Process.create(Mode)
OPCUAServer_FC.Process.process()
Short description

Set source event of incoming data and provide result event.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

source

STRING

1

E.g. event to set to get data to process. Parameter: (e.g. like) 1: Data (STRING or IMAGE) 2: Optional name to store data (STRING)
Return values
Name Type Multiplicity Description

OnNewResult

STRING

1

'CSK_OPCUAServer.OnNewResult[InstanceName]' Parameter: (e.g. like:) 1: Data (STRING) 2: Timestamp (INT)
Sample (auto-generated)
OnNewResult = OPCUAServer_FC.Process.process(handle, source)

OPCUAServer_FC.Provider

Short description

Provide e.g. result via an event like 'CSK_OPCUAServer.OnNewResult[InstanceNUM]'.

Overview

Functions

OPCUAServer_FC.Provider.create()
Short description

Internally used CSK_FlowConfig create function.

Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.
Sample (auto-generated)
handle = OPCUAServer_FC.Provider.create()
OPCUAServer_FC.Provider.register()
Short description

Internally used CSK_FlowConfig register function.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

eventname

STRING

1

Internal parameter (not used).

callback

STRING

1

Internally used callback function.
Return values
Name Type Multiplicity Description

success

BOOL

1

Success of register process.
Sample (auto-generated)
success = OPCUAServer_FC.Provider.register(handle, eventname, callback)

Events

OPCUAServer_FC.Provider.OnNewResult
Short description

Provide result via 'CSK_OPCUAServer.OnNewResult[InstanceName]' event.

Callback arguments
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

OnNewResult

STRING

1

'CSK_OPCUAServer.OnNewResult[InstanceName]' Parameter: (e.g. like:) 1: Data (STRING) 2: Timestamp (INT)
Sample (auto-generated)
function handleOnNewResult(handle, OnNewResult)
  -- Do something
end

Script.register("OPCUAServer_FC.Provider.OnNewResult", "handleOnNewResult")

Enumerations

O

OPCUAServer_FC.ModeType

Type of optional mode…​

Items
Value Name Description 
TOTAL_SUBRESULTS

TOTAL_SUBRESULTS

TotalResult

 
TOTAL_RESULT

TOTAL_RESULT

TotalResult