Document metadata

Application name

CSK_Module_MultiTCPIPServer

Version

2.0.0

Date

2024-08-14

Author

SICK AG

Crowns

CSK_Module_MultiTCPIPServer

Short description

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

Overview

CSK_MultiTCPIPServer

Short description

This CSK module provides an easy access to TCP/IP Server functionality and provides a UI for all relevant features.
The main externally useful features are following:

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

1. Setup the TCP/IP server configuration
- Select the server via 'setSelectedInstance'. If needed, add a new instance via 'addInstance'.
- Setup the interface, port, framing, etc. via its related 'set…​' function.
- Start / stop to wait for clients via 'setListenState'.

NOTE! Server must be restarted with "setListenState(false)" - "setListenState(true)" to apply new settings.

3. Receive data
It is possible to receive data via dynamically created "CSK_MultiTCPIPServer.OnReceivedDataNUM" events or "client whitelists" (see chapter 5).

4. Data transmission
It is possible to transmit data via dynamically created "CSK_MultiTCPIPServer.sendDataNUM" functions or "client broadcasts" (see chapter 6).

5. Client whitelists
Whitelists can be used to filter for data of specific data sources. It is possible to set an IP filter for each created whitelist.
- Set name of a whitelist to be created via 'setClientWhitelistName'.
- Create a new whitelist via 'createClientWhitelist'.
- Select the whitelist via 'setSelectedClientWhitelist' and delete it with 'deleteClientWhitelist'.
- Now you can add IP addresses to this whitelist via 'setIPAddressToAddToClientWhitelist'.
Incoming data will be provided via event 'CSK_MultiTCPIPServer.OnReceivedDataNUM_WHITELISTNAME' ('NUM' and 'WHITELISTNAME' will be replaced by instance number and name of whitelist).

6. Client broadcasts
Broadcasts can be used to send data only to specific clients. It is possible to set individual IP filter for each created broadcast.
- Set name of a broadcast to be created via 'setClientBroadcastName'.
- Create a new broadcast via 'createClientBroadcast'.
- Select the broadcast via 'setSelectedClientBroadcast' and delete it with 'deleteClientBroadcast'.
- Now you can add IP addresses to this broadcast via 'setIPAddressToAddToClientBroadcast'.
A created broadcast can be used by calling the dynamically created 'CSK_MultiTCPIPServer.sendDataNUM_BROADCASTNAME' functions ('NUM' and 'BROADCASTNAME' will be replaced by instance number and name of the broadcast).

Overview

Functions

CSK_MultiTCPIPServer.addEventToForward()
Short description

Add an event to register to and to forward the content of its first parameter (as string) to all connected TCP/IP clients.

Parameters
Name Type Multiplicity Description

event

STRING

1

Name of event to register to.

Sample (auto-generated)
CSK_MultiTCPIPServer.addEventToForward(event)
CSK_MultiTCPIPServer.addEventToForwardViaUI()
Short description

Add event to register to and forward content (first event parameter as string) to all connected TCPI/IP cleints via UI (event needs to be prefilled on UI / via "setEventToForward").

Sample (auto-generated)
CSK_MultiTCPIPServer.addEventToForwardViaUI()
CSK_MultiTCPIPServer.addInstance()
Short description

Function to add an additional instance.

Sample (auto-generated)
CSK_MultiTCPIPServer.addInstance()
CSK_MultiTCPIPServer.clearFlowConfigRelevantConfiguration()
Short description

Function to clear FlowConfig relevant configurations.

Sample (auto-generated)
CSK_MultiTCPIPServer.clearFlowConfigRelevantConfiguration()
CSK_MultiTCPIPServer.createClientBroadcast()
Short description

Create a new client broadcast with preset name (see 'setClientBroadcastName').

Sample (auto-generated)
CSK_MultiTCPIPServer.createClientBroadcast()
CSK_MultiTCPIPServer.createClientWhitelist()
Short description

Create a new client whitelist with default name.

Sample (auto-generated)
CSK_MultiTCPIPServer.createClientWhitelist()
CSK_MultiTCPIPServer.deleteClientBroadcast()
Short description

Delete the selected client broadcast.

Sample (auto-generated)
CSK_MultiTCPIPServer.deleteClientBroadcast()
CSK_MultiTCPIPServer.deleteClientBroadcastFilterIPAddress()
Short description

Delete the selected IP address from the list of the selected client broadcast.

Parameters
Name Type Multiplicity Description

jsonRowToDelete

STRING

1

JSON content of the selected row of the dynamic with IP Address to delete.

Sample (auto-generated)
CSK_MultiTCPIPServer.deleteClientBroadcastFilterIPAddress(jsonRowToDelete)
CSK_MultiTCPIPServer.deleteClientWhitelist()
Short description

Delete the selected client whitelist.

Sample (auto-generated)
CSK_MultiTCPIPServer.deleteClientWhitelist()
CSK_MultiTCPIPServer.deleteClientWhitelistIPAddress()
Short description

Delete the selected IP address from the list of the selected client whitelist.

Parameters
Name Type Multiplicity Description

jsonRowToDelete

STRING

1

JSON content of the selected row of the dynamic with IP Address to delete.

Sample (auto-generated)
CSK_MultiTCPIPServer.deleteClientWhitelistIPAddress(jsonRowToDelete)
CSK_MultiTCPIPServer.deleteEventToForward()
Short description

Remove event to forward content.

Parameters
Name Type Multiplicity Description

event

STRING

1

Eventname

Sample (auto-generated)
CSK_MultiTCPIPServer.deleteEventToForward(event)
CSK_MultiTCPIPServer.deleteEventToForwardViaUI()
Short description

Remove event preselected via UI.

Sample (auto-generated)
CSK_MultiTCPIPServer.deleteEventToForwardViaUI()
CSK_MultiTCPIPServer.getConnectedClientsIPsNUM()
Short description

Function to get list of IP addresses of the connected clients.
NUM will be replaced by the number of instance (e.g. "getConnectedClientsIPs1").

Return values
Name Type Multiplicity Description

connectedClientsIPs

STRING

*

Array with IP addresses of the connected clients.

Sample (auto-generated)
connectedClientsIPs = CSK_MultiTCPIPServer.getConnectedClientsIPsNUM()
CSK_MultiTCPIPServer.getInstancesAmount()
Short description

Get the amount of created instances of this module.

Return values
Name Type Multiplicity Description

amount

INT

1

Amount of created instances.

Sample (auto-generated)
amount = CSK_MultiTCPIPServer.getInstancesAmount()
CSK_MultiTCPIPServer.getInterfaceIP()
Short description

Get the IP address of the selected server.

Return values
Name Type Multiplicity Description

selectedInterfaceIp

STRING

1

IP

Sample (auto-generated)
selectedInterfaceIp = CSK_MultiTCPIPServer.getInterfaceIP()
CSK_MultiTCPIPServer.getParameters()
Short description

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

Parameters
Name Type Multiplicity Description

instanceNo

INT

1

Number of instance to get parameters from.

Return values
Name Type Multiplicity Description

jsonParameters

STRING

1

JSON string with all parameters.

Sample (auto-generated)
jsonParameters = CSK_MultiTCPIPServer.getParameters(instanceNo)
CSK_MultiTCPIPServer.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_MultiTCPIPServer.getStatusModuleActive()
CSK_MultiTCPIPServer.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_MultiTCPIPServer.loadParameters()
CSK_MultiTCPIPServer.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_MultiTCPIPServer.pageCalled()
CSK_MultiTCPIPServer.resetInstances()
Short description

Function to reset instances to one single 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_MultiTCPIPServer.resetInstances()
CSK_MultiTCPIPServer.resetModule()
Short description

Function to reset main configuration of module.

Sample (auto-generated)
CSK_MultiTCPIPServer.resetModule()
CSK_MultiTCPIPServer.selectConnectedClient()
Short description

Select row in the connected clients dynamic table. Used to copy the IP Address of the selected client into client whitelist / broadcast filter list.

Parameters
Name Type Multiplicity Description

selectedRow

STRING

1

Selected row from the connected clients table in JSON format.

Sample (auto-generated)
CSK_MultiTCPIPServer.selectConnectedClient(selectedRow)
CSK_MultiTCPIPServer.selectEventToForwardViaUI()
Short description

Select an event to forward the content of its first parameter to all TCP/IP clients via UI.

Parameters
Name Type Multiplicity Description

selection

STRING

1

Selected event.

Sample (auto-generated)
CSK_MultiTCPIPServer.selectEventToForwardViaUI(selection)
CSK_MultiTCPIPServer.sendClientBroadcastTestData()
Short description

Function to send the pre-defined test data (see 'setClientBroadcastTestDataToSend') as the selected client broadcast.

Sample (auto-generated)
CSK_MultiTCPIPServer.sendClientBroadcastTestData()
CSK_MultiTCPIPServer.sendDataNUM()
Short description

Example of dynamically served function to send data on instance to clients.
NUM will be replaced by the number of instance (e.g. "sendData1").
INFO: Other modules can check via "Script.isServedAsFunction" if function of sepecific instance exists.
Needs then to be called via "Script.callFunction".

Parameters
Name Type Multiplicity Description

data

STRING

1

Data to send.

ipList

STRING

*

Optional list of IP addresses of the clients to send the data to.

Return values
Name Type Multiplicity Description

success

BOOL

1

Success of sending the data.

details

STRING

?

Details if sending failed.

Sample (auto-generated)
success, details = CSK_MultiTCPIPServer.sendDataNUM(data, ipList)
CSK_MultiTCPIPServer.sendDataNUM_BROADCASTNAME()
Short description

Example of dynamically served function to send data on instance via client broadcast.
'NUM' and 'BROADCASTNAME' will be replaced by the numeric identifier of the instance and name of client broadcast(e.g. "sendData1_broadcast1").
INFO: Other modules can check via "Script.isServedAsFunction" if function of sepecific instance exists.
Needs then to be called via "Script.callFunction".

Parameters
Name Type Multiplicity Description

data

AUTO

1

Data to write.

Return values
Name Type Multiplicity Description

success

BOOL

1

Success of sending the data.

neededTime

INT

1

Needed time.

error

STRING

?

Optional error message.

Sample (auto-generated)
success, neededTime, error = CSK_MultiTCPIPServer.sendDataNUM_BROADCASTNAME(data)
CSK_MultiTCPIPServer.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_MultiTCPIPServer.sendParameters(noDataSave)
CSK_MultiTCPIPServer.sendTestData()
Short description

Function to send the pre-defined test data (see setTestDataToSend).

Sample (auto-generated)
CSK_MultiTCPIPServer.sendTestData()
CSK_MultiTCPIPServer.setACKTimeout()
Short description

Sets from UI the maximum time interval, in milliseconds, that a transmitted packet may stay unacknowledged before the connection is terminated.

Parameters
Name Type Multiplicity Description

newACKTimeout

INT

1

Timeout for packet ACKs, in milliseconds.

Sample (auto-generated)
CSK_MultiTCPIPServer.setACKTimeout(newACKTimeout)
CSK_MultiTCPIPServer.setAddIPViaList()
Short description

Function to activate to select IP via UI list for filter.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
CSK_MultiTCPIPServer.setAddIPViaList(status)
CSK_MultiTCPIPServer.setClientBroadcastName()
Short description

Set a name to create a new client broadcast via 'createClientBroadcast'.

Parameters
Name Type Multiplicity Description

newName

STRING

1

New name of the message.

Sample (auto-generated)
CSK_MultiTCPIPServer.setClientBroadcastName(newName)
CSK_MultiTCPIPServer.setClientBroadcastTestDataToSend()
Short description

Set data to be sent to clients filtered in the selected broadcast for testing purposes.

Parameters
Name Type Multiplicity Description

newTestDataToSend

STRING

1

Data to be sent.

Sample (auto-generated)
CSK_MultiTCPIPServer.setClientBroadcastTestDataToSend(newTestDataToSend)
CSK_MultiTCPIPServer.setClientWhitelistName()
Short description

Set a new name of a whitelist to be created.

Parameters
Name Type Multiplicity Description

newName

STRING

1

New name of the whitelist.

Sample (auto-generated)
CSK_MultiTCPIPServer.setClientWhitelistName(newName)
CSK_MultiTCPIPServer.setEventToForward()
Short description

Preset event to register to and forward content to all connected TCP/IP clients via UI.

Parameters
Name Type Multiplicity Description

value

STRING

1

Event to register to.

Sample (auto-generated)
CSK_MultiTCPIPServer.setEventToForward(value)
CSK_MultiTCPIPServer.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_MultiTCPIPServer.setFlowConfigPriority(status)
CSK_MultiTCPIPServer.setForwardBroadcastEvent()
Short description

Function to set if adding/deleting forwarding events in UI is for broadcasts.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
CSK_MultiTCPIPServer.setForwardBroadcastEvent(status)
CSK_MultiTCPIPServer.setInterface()
Short description

Sets device’s interface from UI, server must be restarted to apply the settings (see 'setListenState').

Parameters
Name Type Multiplicity Description

newInterface

STRING

1

New interface to listen to.

Sample (auto-generated)
CSK_MultiTCPIPServer.setInterface(newInterface)
CSK_MultiTCPIPServer.setIPAddressToAddToClientBroadcast()
Short description

Set IP address to be added to list of clients to which the server send the message.

Parameters
Name Type Multiplicity Description

ipAddress

STRING

1

IP address.

Sample (auto-generated)
CSK_MultiTCPIPServer.setIPAddressToAddToClientBroadcast(ipAddress)
CSK_MultiTCPIPServer.setIPAddressToAddToClientWhitelist()
Short description

Set IP address to be added to list of clients from which server will wait for a message.

Parameters
Name Type Multiplicity Description

ipAddress

STRING

1

IP address.

Sample (auto-generated)
CSK_MultiTCPIPServer.setIPAddressToAddToClientWhitelist(ipAddress)
CSK_MultiTCPIPServer.setListenState()
Short description

Function to turn server on or off.

Parameters
Name Type Multiplicity Description

newState

BOOL

1

New listen state, true if active.

Sample (auto-generated)
CSK_MultiTCPIPServer.setListenState(newState)
CSK_MultiTCPIPServer.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_MultiTCPIPServer.setLoadOnReboot(status)
CSK_MultiTCPIPServer.setMaxConnections()
Short description

Set limit of connections, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newMaxConnections

INT

1

Maximum number of connected clients for server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setMaxConnections(newMaxConnections)
CSK_MultiTCPIPServer.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_MultiTCPIPServer.setParameterName(name)
CSK_MultiTCPIPServer.setPort()
Short description

Function to set port, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newPort

INT

1

New port to listen to

Sample (auto-generated)
CSK_MultiTCPIPServer.setPort(newPort)
CSK_MultiTCPIPServer.setRxBuffer()
Short description

Sets the Rx size of the internal framing parser buffer from UI. Server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newRxBuffer

INT

1

Framing buffer size for receiving data.

Sample (auto-generated)
CSK_MultiTCPIPServer.setRxBuffer(newRxBuffer)
CSK_MultiTCPIPServer.setRxFraming()
Short description

Set Rx Framing type, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newRxFraming

ENUM
CSK_MultiTCPIPServer.FramingType

1

Framing type of recived data to be used by server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setRxFraming(newRxFraming)
CSK_MultiTCPIPServer.setRxStart()
Short description

Set RxStart frame from UI, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newRxStart

STRING

1

Hex symbol of a start frame of recived data to be used by server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setRxStart(newRxStart)
CSK_MultiTCPIPServer.setRxStop()
Short description

Set RxStop frame from UI, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newRxStop

STRING

1

Hex symbol of a stop frame of recived data to be used by server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setRxStop(newRxStop)
CSK_MultiTCPIPServer.setSelectedClientBroadcast()
Short description

Select client broadcast to edit.

Parameters
Name Type Multiplicity Description

clientBroadcastName

STRING

1

Name of the client broadcast.

Return values
Name Type Multiplicity Description

success

BOOL

1

Success

Sample (auto-generated)
success = CSK_MultiTCPIPServer.setSelectedClientBroadcast(clientBroadcastName)
CSK_MultiTCPIPServer.setSelectedClientWhitelist()
Short description

Select client whitelist to edit.

Parameters
Name Type Multiplicity Description

clientWhitelistName

STRING

1

Name of the client whitelist.

Return values
Name Type Multiplicity Description

success

BOOL

1

Success

Sample (auto-generated)
success = CSK_MultiTCPIPServer.setSelectedClientWhitelist(clientWhitelistName)
CSK_MultiTCPIPServer.setSelectedInstance()
Short description

Select one of the multiple instances.

Parameters
Name Type Multiplicity Description

instance

INT

1

Instance to select.

Sample (auto-generated)
CSK_MultiTCPIPServer.setSelectedInstance(instance)
CSK_MultiTCPIPServer.setSelectedTab()
Short description

Set selcetd settings tab in UI.

Parameters
Name Type Multiplicity Description

newSelectedTab

INT

1

Tab ID.

Sample (auto-generated)
CSK_MultiTCPIPServer.setSelectedTab(newSelectedTab)
CSK_MultiTCPIPServer.setTestDataToSend()
Short description

Set data to be sent to clients for testing purposes.

Parameters
Name Type Multiplicity Description

newTestDataToSend

STRING

1

Data to be sent.

Sample (auto-generated)
CSK_MultiTCPIPServer.setTestDataToSend(newTestDataToSend)
CSK_MultiTCPIPServer.setTransmitionBuffer()
Short description

Sets the size of the socket send buffer. Server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newTransmitionBuffer

INT

1

Size of the buffer, in bytes

Sample (auto-generated)
CSK_MultiTCPIPServer.setTransmitionBuffer(newTransmitionBuffer)
CSK_MultiTCPIPServer.setTransmitionTimeout()
Short description

Set data transmition timeout, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newTransmitionTimeout

INT

1

Timeout for transmits, in milliseconds.

Sample (auto-generated)
CSK_MultiTCPIPServer.setTransmitionTimeout(newTransmitionTimeout)
CSK_MultiTCPIPServer.setTxBuffer()
Short description

Sets the Tx size of the internal framing parser buffer. Server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newTxBuffer

INT

1

Framing buffer size for transmitting.

Sample (auto-generated)
CSK_MultiTCPIPServer.setTxBuffer(newTxBuffer)
CSK_MultiTCPIPServer.setTxFraming()
Short description

Set Tx framing type, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newTxFraming

ENUM
null

1

Framing of transmitted data to be used by server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setTxFraming(newTxFraming)
CSK_MultiTCPIPServer.setTxStart()
Short description

Set TxStart frame, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newTxStart

STRING

1

Hex symbol of a start frame of transmitted data to be used by server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setTxStart(newTxStart)
CSK_MultiTCPIPServer.setTxStop()
Short description

Set TxStop frame, server must be restarted to apply the settings.

Parameters
Name Type Multiplicity Description

newTxStop

STRING

1

Hex symbol of a stop frame of transmitted data to be used by server.

Sample (auto-generated)
CSK_MultiTCPIPServer.setTxStop(newTxStop)

Events

CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_MultiTCPIPServer.OnNewACKTimeout
Short description

Event to provide the current acknowledgement timeout value.

Callback arguments
Name Type Multiplicity Description

newTransmitAckTimeout

STRING

1

ACK timeout.

Sample (auto-generated)
function handleOnNewACKTimeout(newTransmitAckTimeout)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewACKTimeout", "handleOnNewACKTimeout")
CSK_MultiTCPIPServer.OnNewClientBroadcastFunctionName
Short description

Event to provide the function name of the selected client broadcast.

Callback arguments
Name Type Multiplicity Description

eventName

STRING

1

Event name.

Sample (auto-generated)
function handleOnNewClientBroadcastFunctionName(eventName)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientBroadcastFunctionName", "handleOnNewClientBroadcastFunctionName")
CSK_MultiTCPIPServer.OnNewClientBroadcastName
Short description

Notify name of broadcast to create.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Name

Sample (auto-generated)
function handleOnNewClientBroadcastName(name)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientBroadcastName", "handleOnNewClientBroadcastName")
CSK_MultiTCPIPServer.OnNewClientBroadcastTableContent
Short description

Event to provide IP filter table of the selected client broadcast.

Callback arguments
Name Type Multiplicity Description

jsonTableContent

STRING

1

Table content in JSON format.

Sample (auto-generated)
function handleOnNewClientBroadcastTableContent(jsonTableContent)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientBroadcastTableContent", "handleOnNewClientBroadcastTableContent")
CSK_MultiTCPIPServer.OnNewClientBroadcastTestDataToSend
Short description

Event to provide the data to be sent for testing purposes as the selected client broadcast.

Callback arguments
Name Type Multiplicity Description

testDataToSend

STRING

1

Data to be sent.

Sample (auto-generated)
function handleOnNewClientBroadcastTestDataToSend(testDataToSend)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientBroadcastTestDataToSend", "handleOnNewClientBroadcastTestDataToSend")
CSK_MultiTCPIPServer.OnNewClientWhitelistEventName
Short description

Event to provide the event name of the selected client whitelist.

Callback arguments
Name Type Multiplicity Description

eventName

STRING

1

Event name.

Sample (auto-generated)
function handleOnNewClientWhitelistEventName(eventName)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientWhitelistEventName", "handleOnNewClientWhitelistEventName")
CSK_MultiTCPIPServer.OnNewClientWhitelistName
Short description

Notify name of whitelist to create.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Name

Sample (auto-generated)
function handleOnNewClientWhitelistName(name)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientWhitelistName", "handleOnNewClientWhitelistName")
CSK_MultiTCPIPServer.OnNewClientWhitelistTableContent
Short description

Event to provide IP filter table of the selected client whitelist.

Callback arguments
Name Type Multiplicity Description

jsonTableContent

STRING

1

Table content in JSON format.

Sample (auto-generated)
function handleOnNewClientWhitelistTableContent(jsonTableContent)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewClientWhitelistTableContent", "handleOnNewClientWhitelistTableContent")
CSK_MultiTCPIPServer.OnNewConnectedClientsNumber
Short description

Event to provide the connected clients number.

Callback arguments
Name Type Multiplicity Description

clientsNum

INT

1

New number of connected clients.

Sample (auto-generated)
function handleOnNewConnectedClientsNumber(clientsNum)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewConnectedClientsNumber", "handleOnNewConnectedClientsNumber")
CSK_MultiTCPIPServer.OnNewConnectedClientsTable
Short description

Event to provide dynamic table content with connected clients.

Callback arguments
Name Type Multiplicity Description

newData

STRING

1

Connected clients table in JSON format.

Sample (auto-generated)
function handleOnNewConnectedClientsTable(newData)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewConnectedClientsTable", "handleOnNewConnectedClientsTable")
CSK_MultiTCPIPServer.OnNewEventToForwardList
Short description

Notify list of events to register to and to forward its content to all connected TCP/IP clients.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List

Sample (auto-generated)
function handleOnNewEventToForwardList(list)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewEventToForwardList", "handleOnNewEventToForwardList")
CSK_MultiTCPIPServer.OnNewGenericReceivedDataEventName
Short description

Event to provide the name of event notified when server receives any data from any client.

Callback arguments
Name Type Multiplicity Description

eventName

STRING

1

Event name.

Sample (auto-generated)
function handleOnNewGenericReceivedDataEventName(eventName)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewGenericReceivedDataEventName", "handleOnNewGenericReceivedDataEventName")
CSK_MultiTCPIPServer.OnNewGenericSendDataFunctionName
Short description

Event to provide the name of function to be called to send any data to all clients.

Callback arguments
Name Type Multiplicity Description

functionName

STRING

1

Function name.

Sample (auto-generated)
function handleOnNewGenericSendDataFunctionName(functionName)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewGenericSendDataFunctionName", "handleOnNewGenericSendDataFunctionName")
CSK_MultiTCPIPServer.OnNewInstanceList
Short description

Event to provide list of created instances.

Callback arguments
Name Type Multiplicity Description

list

STRING

1

List of created instances.

Sample (auto-generated)
function handleOnNewInstanceList(list)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewInstanceList", "handleOnNewInstanceList")
CSK_MultiTCPIPServer.OnNewInterface
Short description

Event to provide the selected Interface for active server.

Callback arguments
Name Type Multiplicity Description

Interface

STRING

1

The interface TCP/IP server listens to.

Sample (auto-generated)
function handleOnNewInterface(Interface)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewInterface", "handleOnNewInterface")
CSK_MultiTCPIPServer.OnNewInterfaceList
Short description

Event to provide the list of available ethernet interfaces.

Callback arguments
Name Type Multiplicity Description

interfaceList

STRING

1

List of interfaces in JSON format.

Sample (auto-generated)
function handleOnNewInterfaceList(interfaceList)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewInterfaceList", "handleOnNewInterfaceList")
CSK_MultiTCPIPServer.OnNewListClientBroadcast
Short description

Event to provide the list of all created client broadcasts.

Callback arguments
Name Type Multiplicity Description

jsonBroadcastList

STRING

1

List of client broadcasts in JSON format.

Sample (auto-generated)
function handleOnNewListClientBroadcast(jsonBroadcastList)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewListClientBroadcast", "handleOnNewListClientBroadcast")
CSK_MultiTCPIPServer.OnNewListClientWhitelist
Short description

Event to provide the list of all created client whitelists.

Callback arguments
Name Type Multiplicity Description

jsonClientWhitelistsList

STRING

1

List of client whitelists in JSON format.

Sample (auto-generated)
function handleOnNewListClientWhitelist(jsonClientWhitelistsList)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewListClientWhitelist", "handleOnNewListClientWhitelist")
CSK_MultiTCPIPServer.OnNewListenState
Short description

Event to provide the active state of server.

Callback arguments
Name Type Multiplicity Description

newState

BOOL

1

Active state to show in UI.

Sample (auto-generated)
function handleOnNewListenState(newState)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewListenState", "handleOnNewListenState")
CSK_MultiTCPIPServer.OnNewLog
Short description

Notfiy latest log.

Callback arguments
Name Type Multiplicity Description

log

STRING

1

Log entries.

Sample (auto-generated)
function handleOnNewLog(log)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewLog", "handleOnNewLog")
CSK_MultiTCPIPServer.OnNewMaxConnections
Short description

Event to provide the max connections value.

Callback arguments
Name Type Multiplicity Description

newMaxConnections

STRING

1

Max connections value.

Sample (auto-generated)
function handleOnNewMaxConnections(newMaxConnections)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewMaxConnections", "handleOnNewMaxConnections")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnNewParameterName", "handleOnNewParameterName")
CSK_MultiTCPIPServer.OnNewPort
Short description

Event to provide port number.

Callback arguments
Name Type Multiplicity Description

Port

INT

1

Port number value.

Sample (auto-generated)
function handleOnNewPort(Port)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewPort", "handleOnNewPort")
CSK_MultiTCPIPServer.OnNewProcessingParameter
Short description

Event to share processing parameters to the instances.

Callback arguments
Name Type Multiplicity Description

objectNo

INT

1

Number of the instance to receive the parameter.

parameter

STRING

1

Name of the parameter.

value

AUTO

?

Value of the parameter.

internalValue

AUTO

?

Optional custom value.

Sample (auto-generated)
function handleOnNewProcessingParameter(objectNo, parameter, value, internalValue)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewProcessingParameter", "handleOnNewProcessingParameter")
CSK_MultiTCPIPServer.OnNewRxFraming
Short description

Event to provide the selected Rx framing type.

Callback arguments
Name Type Multiplicity Description

newRxFraming

STRING

1

Rx framing type.

Sample (auto-generated)
function handleOnNewRxFraming(newRxFraming)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewRxFraming", "handleOnNewRxFraming")
CSK_MultiTCPIPServer.OnNewRxFramingBufferSize
Short description

Event to provide the Rx buffer size.

Callback arguments
Name Type Multiplicity Description

newRxFramingBufferSize

STRING

1

Rx buffer size in bytes.

Sample (auto-generated)
function handleOnNewRxFramingBufferSize(newRxFramingBufferSize)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewRxFramingBufferSize", "handleOnNewRxFramingBufferSize")
CSK_MultiTCPIPServer.OnNewRxFramingList
Short description

Event to provide the list of available Rx framing types.

Callback arguments
Name Type Multiplicity Description

RxFramingList

STRING

1

List of framings in JSON format.

Sample (auto-generated)
function handleOnNewRxFramingList(RxFramingList)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewRxFramingList", "handleOnNewRxFramingList")
CSK_MultiTCPIPServer.OnNewRxStart
Short description

Event to provide the Rx Start hex symbol.

Callback arguments
Name Type Multiplicity Description

newRxStart

STRING

?

Rx start symbol.

Sample (auto-generated)
function handleOnNewRxStart(newRxStart)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewRxStart", "handleOnNewRxStart")
CSK_MultiTCPIPServer.OnNewRxStop
Short description

Event to provide the Rx stop hex symbol.

Callback arguments
Name Type Multiplicity Description

newRxStop

STRING

?

Rx stop symbol.

Sample (auto-generated)
function handleOnNewRxStop(newRxStop)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewRxStop", "handleOnNewRxStop")
CSK_MultiTCPIPServer.OnNewSelectedClientBroadcast
Short description

Event to provide the name of the selected client broadcast.

Callback arguments
Name Type Multiplicity Description

clientBroadcastName

STRING

1

Name of the selected client broadcast.

Sample (auto-generated)
function handleOnNewSelectedClientBroadcast(clientBroadcastName)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewSelectedClientBroadcast", "handleOnNewSelectedClientBroadcast")
CSK_MultiTCPIPServer.OnNewSelectedClientWhitelist
Short description

Event to provide the name of the selected client whitelist.

Callback arguments
Name Type Multiplicity Description

clientWhitelistName

STRING

1

Name of the selected client whitelist.

Sample (auto-generated)
function handleOnNewSelectedClientWhitelist(clientWhitelistName)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewSelectedClientWhitelist", "handleOnNewSelectedClientWhitelist")
CSK_MultiTCPIPServer.OnNewSelectedInstance
Short description

Notify if new instance is selected.

Callback arguments
Name Type Multiplicity Description

selectedObject

INT

1

Selected instance.

Sample (auto-generated)
function handleOnNewSelectedInstance(selectedObject)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewSelectedInstance", "handleOnNewSelectedInstance")
CSK_MultiTCPIPServer.OnNewSelectedTab
Short description

Event to provide the current selected tab ID.

Callback arguments
Name Type Multiplicity Description

newSelectedTab

INT

1

Tab ID.

Sample (auto-generated)
function handleOnNewSelectedTab(newSelectedTab)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewSelectedTab", "handleOnNewSelectedTab")
CSK_MultiTCPIPServer.OnNewServerIP
Short description

Event to provide the server IP address.

Callback arguments
Name Type Multiplicity Description

newIPAddress

STRING

1

Server IP address.

Sample (auto-generated)
function handleOnNewServerIP(newIPAddress)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewServerIP", "handleOnNewServerIP")
CSK_MultiTCPIPServer.OnNewStatusAddIPViaList
Short description

Notify status if IP for filter should be added via list selection in UI.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusAddIPViaList(status)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewStatusAddIPViaList", "handleOnNewStatusAddIPViaList")
CSK_MultiTCPIPServer.OnNewStatusClientBroadcastSelected
Short description

Event to provide the status if any client broadcast is selected.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

True if selected.

Sample (auto-generated)
function handleOnNewStatusClientBroadcastSelected(status)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewStatusClientBroadcastSelected", "handleOnNewStatusClientBroadcastSelected")
CSK_MultiTCPIPServer.OnNewStatusClientWhitelistSelected
Short description

Event to provide status if any client whitelist is selected.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

True if selected.

Sample (auto-generated)
function handleOnNewStatusClientWhitelistSelected(status)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewStatusClientWhitelistSelected", "handleOnNewStatusClientWhitelistSelected")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")
CSK_MultiTCPIPServer.OnNewStatusForwardEventForBroadcasts
Short description

Notify if config of forward events in UI is for broadcasts.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

Status

Sample (auto-generated)
function handleOnNewStatusForwardEventForBroadcasts(status)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewStatusForwardEventForBroadcasts", "handleOnNewStatusForwardEventForBroadcasts")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")
CSK_MultiTCPIPServer.OnNewTestDataToSend
Short description

Event to provide the data to be sent for testing purposes.

Callback arguments
Name Type Multiplicity Description

testDataToSend

STRING

1

Data to be sent.

Sample (auto-generated)
function handleOnNewTestDataToSend(testDataToSend)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTestDataToSend", "handleOnNewTestDataToSend")
CSK_MultiTCPIPServer.OnNewTransmitBuffer
Short description

Event to provide the transmittion buffer value.

Callback arguments
Name Type Multiplicity Description

newTransmitBuffer

STRING

1

Transmittion buffer in bytes.

Sample (auto-generated)
function handleOnNewTransmitBuffer(newTransmitBuffer)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTransmitBuffer", "handleOnNewTransmitBuffer")
CSK_MultiTCPIPServer.OnNewTransmitTimeout
Short description

Event to provide the transmittion timeout value.

Callback arguments
Name Type Multiplicity Description

newTransmitTimeout

STRING

1

Transmittion timeout in ms.

Sample (auto-generated)
function handleOnNewTransmitTimeout(newTransmitTimeout)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTransmitTimeout", "handleOnNewTransmitTimeout")
CSK_MultiTCPIPServer.OnNewTxFraming
Short description

Event to provide the selected Tx framing type.

Callback arguments
Name Type Multiplicity Description

newTxFraming

STRING

1

Tx framing type.

Sample (auto-generated)
function handleOnNewTxFraming(newTxFraming)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTxFraming", "handleOnNewTxFraming")
CSK_MultiTCPIPServer.OnNewTxFramingBufferSize
Short description

Event to provide the Tx buffer size.

Callback arguments
Name Type Multiplicity Description

newTxFramingBufferSize

STRING

1

Tx buffer size in bytes.

Sample (auto-generated)
function handleOnNewTxFramingBufferSize(newTxFramingBufferSize)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTxFramingBufferSize", "handleOnNewTxFramingBufferSize")
CSK_MultiTCPIPServer.OnNewTxFramingList
Short description

Event to provide the list of available Tx framing types.

Callback arguments
Name Type Multiplicity Description

TxFramingList

STRING

1

List of framings in JSON format.

Sample (auto-generated)
function handleOnNewTxFramingList(TxFramingList)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTxFramingList", "handleOnNewTxFramingList")
CSK_MultiTCPIPServer.OnNewTxStart
Short description

Event to provide the Tx Start hex symbol.

Callback arguments
Name Type Multiplicity Description

newTxStart

STRING

?

Tx start symbol.

Sample (auto-generated)
function handleOnNewTxStart(newTxStart)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTxStart", "handleOnNewTxStart")
CSK_MultiTCPIPServer.OnNewTxStop
Short description

Event to provide the Tx Stop hex symbol.

Callback arguments
Name Type Multiplicity Description

newTxStop

STRING

?

Tx stop symbol.

Sample (auto-generated)
function handleOnNewTxStop(newTxStop)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewTxStop", "handleOnNewTxStop")
CSK_MultiTCPIPServer.OnNewValueToForwardNUM
Short description

Example of dynamically created event to forward data from instance thread to Controller part of module, e.g. to forward values to UI.
NUM will be replaced by the number of instance (e.g. "OnNewValueToForward1").

Callback arguments
Name Type Multiplicity Description

eventname

STRING

1

Eventname to use to forward value.

value

AUTO

1

Value to forward.

Sample (auto-generated)
function handleOnNewValueToForwardNUM(eventname, value)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
CSK_MultiTCPIPServer.OnNewValueUpdateNUM
Short description

Example of dynamically created event to sync paramters between instance threads and Controller part of module.
NUM will be replaced by the number of instance (e.g. "OnNewValueToUpdate1").

Callback arguments
Name Type Multiplicity Description

instance

INT

1

Instance new value is coming from.

parameter

STRING

1

Name of the paramter to update/sync.

value

AUTO

1

Value to update.

selectedObject

INT

?

Optionally if internal parameter should be used for internal objects.

Sample (auto-generated)
function handleOnNewValueUpdateNUM(instance, parameter, value, selectedObject)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_MultiTCPIPServer.OnReceivedDataNUM
Short description

Example of dynamically created event to provide received data of instance.
NUM will be replaced by the number of instance (e.g. "OnReceivedData1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

data

STRING

1

Received data.

ipAddress

STRING

1

IP address of source.

time

INT

1

Needed time.

Sample (auto-generated)
function handleOnReceivedDataNUM(data, ipAddress, time)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnReceivedDataNUM", "handleOnReceivedDataNUM")
CSK_MultiTCPIPServer.OnReceivedDataNUM_WHITELISTNAME
Short description

Example of dynamically created event to provide received data of client whitelist of instance.
'NUM' and 'WHITELISTNAME' will be replaced by the number of instance and name of client whitelist (e.g. "OnReceivedData1_whitelist1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

data

STRING

1

Received data.

ipAddress

STRING

1

IP address of source.

time

INT

1

Needed time.

Sample (auto-generated)
function handleOnReceivedDataNUM_WHITELISTNAME(data, ipAddress, time)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnReceivedDataNUM_WHITELISTNAME", "handleOnReceivedDataNUM_WHITELISTNAME")
CSK_MultiTCPIPServer.OnRxFramingDisabled
Short description

Event to disable/enable editing Rx Framing field in UI.

Callback arguments
Name Type Multiplicity Description

isDisabled

BOOL

1

true if disabled

Sample (auto-generated)
function handleOnRxFramingDisabled(isDisabled)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnRxFramingDisabled", "handleOnRxFramingDisabled")
CSK_MultiTCPIPServer.OnTxFramingDisabled
Short description

Event to disable/enable editing Tx Framing field in UI.

Callback arguments
Name Type Multiplicity Description

isDisabled

BOOL

1

true if disabled

Sample (auto-generated)
function handleOnTxFramingDisabled(isDisabled)
  -- Do something
end

Script.register("CSK_MultiTCPIPServer.OnTxFramingDisabled", "handleOnTxFramingDisabled")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_MultiTCPIPServer.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_MultiTCPIPServer.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

MultiTCPIPServer_FC

Short description

Crown to provide CSK_FlowConfig relevant features.

Overview

MultiTCPIPServer_FC.OnReceive

Short description

Provide incoming TCP/IP data.

Functions

MultiTCPIPServer_FC.OnReceive.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

Instance

INT

1

Numeric identifier of processing instance (must be >=1).

ClientWhitelist

STRING

?

Optionally client whitelist to use (will filter for messages of defined clients by defined IPs).

Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

Sample (auto-generated)
handle = MultiTCPIPServer_FC.OnReceive.create(Instance, ClientWhitelist)
MultiTCPIPServer_FC.OnReceive.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 = MultiTCPIPServer_FC.OnReceive.register(handle, eventname, callback)

Events

MultiTCPIPServer_FC.OnReceive.OnNewData
Short description

Provide incoming TCP/IP data.

Callback arguments
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

OnNewData

STRING

1

'CSK_MultiTCPIPServer.OnReceived[InstanceNUM]' or 'CSK_MultiTCPIPServer.OnReceived[InstanceNUM][ClientWhitelistName]' Parameter: 1: Data content (STRING)

Sample (auto-generated)
function handleOnNewData(handle, OnNewData)
  -- Do something
end

Script.register("MultiTCPIPServer_FC.OnReceive.OnNewData", "handleOnNewData")

MultiTCPIPServer_FC.Transmit

Short description

Forward data via TCP/IP communication.

Overview

Functions

MultiTCPIPServer_FC.Transmit.create()
Short description

Internally used CSK_FlowConfig create function.

Parameters
Name Type Multiplicity Description

Instance

INT

1

Numeric identifier of processing instance (must be >=1).

ClientBroadcast

STRING

?

Optional client boradcast to use (will transmit data only to defined clients).

Return values
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

Sample (auto-generated)
handle = MultiTCPIPServer_FC.Transmit.create(Instance, ClientBroadcast)
MultiTCPIPServer_FC.Transmit.transmit()
Short description

Set source of incoming data to forward via TCP/IP.

Parameters
Name Type Multiplicity Description

handle

HANDLE

1

Handle to internally used FlowConfig instance.

source1

STRING

?

Source1 of data to forward via TCP/IP. Parameter: 1: Data content (STRING)

source2

STRING

?

Source2 of data to forward via TCP/IP. Parameter: 1: Data content (STRING)

source3

STRING

?

Source3 of data to forward via TCP/IP. Parameter: 1: Data content (STRING)

source4

STRING

?

Source4 of data to forward via TCP/IP. Parameter: 1: Data content (STRING)

Sample (auto-generated)
MultiTCPIPServer_FC.Transmit.transmit(handle, source1, source2, source3, source4)

Enumerations

CSK_MultiTCPIPServer.FramingType

Framing type of TCPIP server for Rx or Tx data.

Items
Value Name Description
STX-ETX

STX_ETX

Start framing is STX, end framing is ETX.

Empty

Empty

Empty framing.

Custom

Custom

Custom type where user can set ant start / end symbols.