Document metadata

Application name

CSK_Module_LiveConnect

Version

3.0.0

Date

2023-09-18

Author

SICK AG

Crowns

C

CSK_LiveConnect

Short description

This module provides the possibility to communicate via the SICK Industrial Cloud Connection (ICC) with a digital device (digital twin) configured in the SICK AssetHub to make local processed data securely available for cloud services.
For further information about this approach in general please check https://integrationspace.sick.com/.

Before data can be exchanged, the physical gateway device must first be paired with the digital twin in the SICK AssetHub.
After the pairing process, profiles can be made known to the gateway device itself, or an attached device (peerDevice).

There are two types of profiles that can be used:

1) MQTT profiles
- The device automatically sends data into the cloud (data push)
- Profile description "asyncAPI"

Typically this profile can be used like this (check also main script of this module regarding sample code):

1.1) Create MQTT profile via CSK_LiveConnect.MQTTProfile.create()
1.2) Set all relevant parameters of this profle (check 'set…​' functions of 'CSK_LiveConnect.MQTTProfile').
1.3) Register application profile via 'CSK_LiveConnect.addMQTTProfile'.
1.4) Push JSON payload via 'CSK_LiveConnect.publishMQTTData'.

2) HTTP profiles
- HTTP requests can be sent from the cloud side (data poll), which are answered by the device on the shop floor side.
- Profile description "openAPI"

Typically this profile can be used like this (check also main script of this module regarding sample code):

2.1.1) Create a HTTPProfile via 'CSK_LiveConnect.HTTPProfile.create' and set its parameters via its 'CSK_LiveConnect.HTTPProfile.set…​' functions.
2.1.2) Create an endpoint via 'CSK_LiveConnect.HTTPProfile.Endpoint.create' and configure its values via its 'CSK_LiveConnect.HTTPProfile.Endpoint.set…​' functions.
2.1.3) Serve an individual function to be triggered via remote with a 'CSK_LiveConnect.Request' as input parameter and a 'CSK_LiveConnect.Response' as return value. E.g. via:
'Script.serveFunction('[AppName].[UriName]', httpCallbackFunction, "object:CSK_LiveConnect.Request", "object:CSK_LiveConnect.Response")'.
2.1.4) Add the endpoints via 'CSK_LiveConnect.HTTPProfile.setEndpoints'.
2.1.5) Add the HTTP profile via 'CSK_LiveConnect.addHTTPProfile'.

2.2) To respond now on HTTP requests it can be done like this:
2.2.1) Create a response via 'CSK_LiveConnect.Response.create' and header via 'CSK_LiveConnect.Header.create'.
2.2.2) Set key and value of the header via 'CSK_LiveConnect.Header.setKey' / 'CSK_LiveConnect.Header.setValue'.
2.2.3) Set header and status code of the response via 'CSK_LiveConnect.Response.setHeaders' / 'CSK_LiveConnect.Response.setStatusCode'.
2.2.4) Set response content via ''CSK_LiveConnect.Response.setContent' and return the CSK_LiveConnect.Response object.

The payload is defined in the profile. The format is JSON.

Overview

Functions

CSK_LiveConnect.addHTTPProfile()
Short description

Add a new HTTP profile to new or an already exiting device.

Parameters
Name Type Multiplicity Description

partNumber

STRING

1

Part number of the device that should be assigned to the profile.

serialNumber

STRING

1

Serial number of the device that should be assigned to the profile.

httpProfile

OBJECT
CSK_LiveConnect.HTTPProfile

1

HTTP profile designed as a crown datatype.
Return values
Name Type Multiplicity Description

success

BOOL

1

Profile successfully added.
Sample (auto-generated)
success = CSK_LiveConnect.addHTTPProfile(partNumber, serialNumber, httpProfile)
CSK_LiveConnect.addMQTTProfile()
Short description

Add a new MQTT profile to new or an already exiting device.

Parameters
Name Type Multiplicity Description

partNumber

STRING

1

Part number of the device that should be assigned to the profile.

serialNumber

STRING

1

Serial number of the device that should be assigned to the profile.

profile

OBJECT
CSK_LiveConnect.MQTTProfile

1

MQTT profile designed as a crown datatype.
Return values
Name Type Multiplicity Description

uuid

STRING

1

UUID
Sample (auto-generated)
uuid = CSK_LiveConnect.addMQTTProfile(partNumber, serialNumber, profile)
CSK_LiveConnect.getConnectionStatus()
Short description

Get LiveConnect connection status.

Return values
Name Type Multiplicity Description

status

STRING

1

Status:
- Online
- Execute command
- Discovery
- Pairing
- Offline
Sample (auto-generated)
status = CSK_LiveConnect.getConnectionStatus()
CSK_LiveConnect.getDeviceURL()
Short description

Get device URL which refers to the digital twin on the SICK AssetHub.

Return values
Name Type Multiplicity Description

url

STRING

1

URL which refers to the digital twin on the SICK AssetHub.
Sample (auto-generated)
url = CSK_LiveConnect.getDeviceURL()
CSK_LiveConnect.getGatewayPartNumber()
Short description

Get part number of the gateway device itself.

Return values
Name Type Multiplicity Description

partNumber

STRING

1

Part number of the gateway device.
Sample (auto-generated)
partNumber = CSK_LiveConnect.getGatewayPartNumber()
CSK_LiveConnect.getGatewaySerialNumber()
Short description

Get serial number of the gateway device itself.

Return values
Name Type Multiplicity Description

serialNumber

STRING

1

Serial number of the gateway device.
Sample (auto-generated)
serialNumber = CSK_LiveConnect.getGatewaySerialNumber()
CSK_LiveConnect.getRegisteredProfiles()
Short description

Get a list of all registered devices and corresponding profiles.

Return values
Name Type Multiplicity Description

devices

OBJECT
CSK_LiveConnect.Device

+

Assigned devices and profiles to the gateway device.
Sample (auto-generated)
devices = CSK_LiveConnect.getRegisteredProfiles()
CSK_LiveConnect.getValidateTokenResult()
Short description

Get validate token result.

Return values
Name Type Multiplicity Description

status

STRING

1

Validate token result.
Sample (auto-generated)
status = CSK_LiveConnect.getValidateTokenResult()
CSK_LiveConnect.loadParameters()
Short description

Load parameters for this module from the PersistentData CSK-module if possible and use them

Sample (auto-generated)
CSK_LiveConnect.loadParameters()
CSK_LiveConnect.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_LiveConnect.pageCalled()
CSK_LiveConnect.publishMQTTData()
Short description

Publish MQTT data to the cloud using a part- and serial number of the device in the AssetHub.

Parameters
Name Type Multiplicity Description

topic

STRING

1

MQTT topic where the data should be published to.
The topics are defined in the device profile.

partNumber

STRING

1

Part number of the device in the AssetHub to which the data is to be sent.

serialNumber

STRING

1

Serial number of the device in the AssetHub to which the data is to be sent.

payload

STRING

1

JSON based payload to be published.
The payload is defined in the MQTT profile.
Sample (auto-generated)
CSK_LiveConnect.publishMQTTData(topic, partNumber, serialNumber, payload)
CSK_LiveConnect.publishMQTTDataByID()
Short description

Publish MQTT data to the cloud using the device UUID

Parameters
Name Type Multiplicity Description

topic

STRING

1

MQTT topic where the data should be published to.
The topics are defined in the device profile.

deviceUUID

STRING

1

Device UUID of the device to which the data is to be sent.
The UUID is returned by the function "addMQTTProfile".

payload

STRING

1

JSON based payload to be published.
The payload is defined in the MQTT profile.
Sample (auto-generated)
CSK_LiveConnect.publishMQTTDataByID(topic, deviceUUID, payload)
CSK_LiveConnect.removeAllProfiles()
Short description

Remove all profiles and connected devices instead of the paired gateway device.

Sample (auto-generated)
CSK_LiveConnect.removeAllProfiles()
CSK_LiveConnect.removePairing()
Short description

Remove pairing between the phsical device and the digital twin in the SICK AssetHub.

Sample (auto-generated)
CSK_LiveConnect.removePairing()
CSK_LiveConnect.removePeerDevice()
Short description

Removes a peer device.
Serial- and part number are used to identify a device.

Parameters
Name Type Multiplicity Description

partNumber

STRING

1

Part number of the peer device to be removed.

serialNumber

STRING

1

Serial number of the peer device to be removed.
Sample (auto-generated)
CSK_LiveConnect.removePeerDevice(partNumber, serialNumber)
CSK_LiveConnect.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_LiveConnect.sendParameters()
CSK_LiveConnect.setCloudSystem()
Short description

Set cloud system that should be used.
The "dev" and "int" stage are only accessible in the SICK internal network.

Parameters
Name Type Multiplicity Description

cloudSystem

STRING

1

Cloud system (prod, int, dev).
Sample (auto-generated)
CSK_LiveConnect.setCloudSystem(cloudSystem)
CSK_LiveConnect.setDeviceDiscoveryTimeout()
Short description

Device discovery timeout.

Parameters
Name Type Multiplicity Description

timeout

STRING

1

Timeout time [ms].
Sample (auto-generated)
CSK_LiveConnect.setDeviceDiscoveryTimeout(timeout)
CSK_LiveConnect.setGatewayPartNumber()
Short description

The part number is automatically read out. If this is not possible, it can be set manually.

Parameters
Name Type Multiplicity Description

partNumber

STRING

1

Part number of the gateway device.
Sample (auto-generated)
CSK_LiveConnect.setGatewayPartNumber(partNumber)
CSK_LiveConnect.setGatewaySerialNumber()
Short description

The serial number is automatically read out. If this is not possible, it can be set manually.

Parameters
Name Type Multiplicity Description

serialNumber

STRING

1

Serial number of the gateway device.
Sample (auto-generated)
CSK_LiveConnect.setGatewaySerialNumber(serialNumber)
CSK_LiveConnect.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_LiveConnect.setLoadOnReboot(status)
CSK_LiveConnect.setMQTTConnectTimeout()
Short description

MQTT connect timeout.

Parameters
Name Type Multiplicity Description

connectTimeout

STRING

1

MQTT connect timeout [ms].
Sample (auto-generated)
CSK_LiveConnect.setMQTTConnectTimeout(connectTimeout)
CSK_LiveConnect.setMQTTKeepAliveInterval()
Short description

MQTT keep alive interval.

Parameters
Name Type Multiplicity Description

keepAliveInterval

STRING

1

MQTT keep alive interval [ms].
Sample (auto-generated)
CSK_LiveConnect.setMQTTKeepAliveInterval(keepAliveInterval)
CSK_LiveConnect.setMQTTMessageInterval()
Short description

MQTT message forwarding interval.

Parameters
Name Type Multiplicity Description

messageInterval

STRING

1

MQTT message forwarding interval [ms].
Sample (auto-generated)
CSK_LiveConnect.setMQTTMessageInterval(messageInterval)
CSK_LiveConnect.setMQTTMessageQueueSize()
Short description

Function to set the size of the MQTT message queue.

Parameters
Name Type Multiplicity Description

queueSize

STRING

1

Message queue size.
Sample (auto-generated)
CSK_LiveConnect.setMQTTMessageQueueSize(queueSize)
CSK_LiveConnect.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_LiveConnect.setParameterName(name)
CSK_LiveConnect.setProcessInterval()
Short description

Reaction time to notice status changes of the LiveConnect connection.

Parameters
Name Type Multiplicity Description

interval

STRING

1

Process interval [ms].
Sample (auto-generated)
CSK_LiveConnect.setProcessInterval(interval)
CSK_LiveConnect.setToken()
Short description

Set pairing token generated from the SICK AssetHub.

Parameters
Name Type Multiplicity Description

token

STRING

1

Token
Sample (auto-generated)
CSK_LiveConnect.setToken(token)
CSK_LiveConnect.setTokenTimeout()
Short description

Timeout for the accepting of the pairing token.

Parameters
Name Type Multiplicity Description

timeout

STRING

1

Timeout time [ms].
Sample (auto-generated)
CSK_LiveConnect.setTokenTimeout(timeout)
CSK_LiveConnect.startTokenValidation()
Short description

Start token validation.

Sample (auto-generated)
CSK_LiveConnect.startTokenValidation()

Events

CSK_LiveConnect.OnClientInitialized
Short description

Event called when the LiveConnect client has been initialised.

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

Script.register("CSK_LiveConnect.OnClientInitialized", "handleOnClientInitialized")
CSK_LiveConnect.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_LiveConnect.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_LiveConnect.OnNewCloudSystem
Short description

This event is triggered as soon as the cloud system has been changed.

Callback arguments
Name Type Multiplicity Description

cloudSystem

STRING

1

Cloud system (prod, int, dev).
Sample (auto-generated)
function handleOnNewCloudSystem(cloudSystem)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewCloudSystem", "handleOnNewCloudSystem")
CSK_LiveConnect.OnNewDeviceDiscoveryTimeout
Short description

This event is triggered as soon as the device discovery timeout has been changed.

Callback arguments
Name Type Multiplicity Description

deviceDiscoveryTimeout

STRING

1

Timeout [ms]
Sample (auto-generated)
function handleOnNewDeviceDiscoveryTimeout(deviceDiscoveryTimeout)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewDeviceDiscoveryTimeout", "handleOnNewDeviceDiscoveryTimeout")
CSK_LiveConnect.OnNewGatewayPartNumber
Short description

This event is triggered as soon as the part number of the gateway device has been changed.

Callback arguments
Name Type Multiplicity Description

partNumber

STRING

1

Part number of the gateway device.
Sample (auto-generated)
function handleOnNewGatewayPartNumber(partNumber)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewGatewayPartNumber", "handleOnNewGatewayPartNumber")
CSK_LiveConnect.OnNewGatewaySerialNumber
Short description

This event is triggered as soon as the serial number of the gateway device has been changed.

Callback arguments
Name Type Multiplicity Description

serialNumber

STRING

1

Serial number of the gateway device.
Sample (auto-generated)
function handleOnNewGatewaySerialNumber(serialNumber)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewGatewaySerialNumber", "handleOnNewGatewaySerialNumber")
CSK_LiveConnect.OnNewMQTTConnectTimeout
Short description

This event is triggered as soon as the MQTT connect timeout has been changed.

Callback arguments
Name Type Multiplicity Description

timeout

STRING

1

Timeout [ms]
Sample (auto-generated)
function handleOnNewMQTTConnectTimeout(timeout)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewMQTTConnectTimeout", "handleOnNewMQTTConnectTimeout")
CSK_LiveConnect.OnNewMQTTKeepAliveInterval
Short description

This event is triggered as soon as the MQTT keep alive interval has been changed.

Callback arguments
Name Type Multiplicity Description

keepAliveInterval

STRING

1

Keep alive interval [ms]
Sample (auto-generated)
function handleOnNewMQTTKeepAliveInterval(keepAliveInterval)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewMQTTKeepAliveInterval", "handleOnNewMQTTKeepAliveInterval")
CSK_LiveConnect.OnNewMQTTMessageInterval
Short description

This event is triggered as soon as the MQTT message interval has been changed.

Callback arguments
Name Type Multiplicity Description

messageInterval

STRING

1

Message interval [ms].
Sample (auto-generated)
function handleOnNewMQTTMessageInterval(messageInterval)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewMQTTMessageInterval", "handleOnNewMQTTMessageInterval")
CSK_LiveConnect.OnNewMQTTQueueSize
Short description

If the LiveConnect connection is broken, the data is stored in the queue.
When the queue is full, the oldest data is discarded automatically.
This event is triggered as soon as the MQTT queue size has been changed.

Callback arguments
Name Type Multiplicity Description

queueSize

STRING

1

Queue size
Sample (auto-generated)
function handleOnNewMQTTQueueSize(queueSize)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewMQTTQueueSize", "handleOnNewMQTTQueueSize")
CSK_LiveConnect.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_LiveConnect.OnNewParameterName", "handleOnNewParameterName")
CSK_LiveConnect.OnNewProcessInterval
Short description

This event is triggered as soon as the Process interval has been changed.

Callback arguments
Name Type Multiplicity Description

processInterval

STRING

1

Process interval [ms].
Sample (auto-generated)
function handleOnNewProcessInterval(processInterval)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewProcessInterval", "handleOnNewProcessInterval")
CSK_LiveConnect.OnNewProfileAdded
Short description

This event is triggered as soon as a new profile was added.

Callback arguments
Name Type Multiplicity Description

name

STRING

1

Name of the profile.

profileType

STRING

1

Profile type (asyncAPI / openAPI).
Sample (auto-generated)
function handleOnNewProfileAdded(name, profileType)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewProfileAdded", "handleOnNewProfileAdded")
CSK_LiveConnect.OnNewStatusConnectionStatus
Short description

Notify LiveConnect connection status.

Callback arguments
Name Type Multiplicity Description

status

STRING

1

Connection status.
- Offline
- Online
- Execute command
- Discover devices
- Waiting for token validationtion
Sample (auto-generated)
function handleOnNewStatusConnectionStatus(status)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewStatusConnectionStatus", "handleOnNewStatusConnectionStatus")
CSK_LiveConnect.OnNewStatusDeviceURL
Short description

Notify device URL which refers to the digital twin on the SICK AssetHub.

Callback arguments
Name Type Multiplicity Description

url

STRING

1

URL which refers to the digital twin on the SICK AssetHub.
Sample (auto-generated)
function handleOnNewStatusDeviceURL(url)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewStatusDeviceURL", "handleOnNewStatusDeviceURL")
CSK_LiveConnect.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_LiveConnect.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_LiveConnect.OnNewTokenTimeout
Short description

This event is triggered as soon as the token timeout has been changed.

Callback arguments
Name Type Multiplicity Description

tokenTimeout

STRING

1

Token timeout [ms].
Sample (auto-generated)
function handleOnNewTokenTimeout(tokenTimeout)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewTokenTimeout", "handleOnNewTokenTimeout")
CSK_LiveConnect.OnNewValidateTokenResult
Short description

This event is triggered as soon as the validate token result has been changed.

Callback arguments
Name Type Multiplicity Description

status

STRING

1

Validate token result.
Sample (auto-generated)
function handleOnNewValidateTokenResult(status)
  -- Do something
end

Script.register("CSK_LiveConnect.OnNewValidateTokenResult", "handleOnNewValidateTokenResult")
CSK_LiveConnect.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_LiveConnect.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_LiveConnect.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_LiveConnect.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_LiveConnect.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_LiveConnect.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_LiveConnect.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_LiveConnect.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_LiveConnect.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_LiveConnect.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

CSK_LiveConnect.Device

Short description

Assignment of profiles to a device.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.Device.create()
Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.Device.create()
CSK_LiveConnect.Device.getDeviceType()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance
Return values
Name Type Multiplicity Description

DeviceType

STRING

1

Type of the device (PEER_DEVICE, GATEWAY_DEVICE).
Sample (auto-generated)
DeviceType = CSK_LiveConnect.Device.getDeviceType(obj)
CSK_LiveConnect.Device.getDeviceUUID()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance
Return values
Name Type Multiplicity Description

N

STRING

1

Device UUID (see asset URL of the digital twin).
Sample (auto-generated)
N = CSK_LiveConnect.Device.getDeviceUUID(obj)
CSK_LiveConnect.Device.getPartNumber()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance
Return values
Name Type Multiplicity Description

PartNumber

STRING

1

Part number of the device.
Sample (auto-generated)
PartNumber = CSK_LiveConnect.Device.getPartNumber(obj)
CSK_LiveConnect.Device.getProfile()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance
Return values
Name Type Multiplicity Description

Profile

OBJECT

+

Attached profiles to the device.
Sample (auto-generated)
Profile = CSK_LiveConnect.Device.getProfile(obj)
CSK_LiveConnect.Device.getSerialNumber()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance
Return values
Name Type Multiplicity Description

SerialNumber

STRING

1

Serial number of the device.
Sample (auto-generated)
SerialNumber = CSK_LiveConnect.Device.getSerialNumber(obj)
CSK_LiveConnect.Device.setDeviceType()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance

DeviceType

STRING

1

Type of the device (PEER_DEVICE, GATEWAY_DEVICE).
Sample (auto-generated)
CSK_LiveConnect.Device.setDeviceType(obj, DeviceType)
CSK_LiveConnect.Device.setDeviceUUID()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance

N

STRING

1

Device UUID (see asset URL of the digital twin).
Sample (auto-generated)
CSK_LiveConnect.Device.setDeviceUUID(obj, N)
CSK_LiveConnect.Device.setPartNumber()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance

PartNumber

STRING

1

Part number of the device.
Sample (auto-generated)
CSK_LiveConnect.Device.setPartNumber(obj, PartNumber)
CSK_LiveConnect.Device.setProfile()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance

Profile

OBJECT

+

Attached profiles to the device.
Sample (auto-generated)
CSK_LiveConnect.Device.setProfile(obj, Profile)
CSK_LiveConnect.Device.setSerialNumber()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Device

1

The instance

SerialNumber

STRING

1

Serial number of the device.
Sample (auto-generated)
CSK_LiveConnect.Device.setSerialNumber(obj, SerialNumber)

CSK_LiveConnect.Header

Short description

Header information of a HTTP request / response.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.Header.create()
Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Header

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.Header.create()
CSK_LiveConnect.Header.getKey()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Header

1

The instance
Return values
Name Type Multiplicity Description

Key

STRING

1

Key of the header entry.
Sample (auto-generated)
Key = CSK_LiveConnect.Header.getKey(obj)
CSK_LiveConnect.Header.getValue()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Header

1

The instance
Return values
Name Type Multiplicity Description

Value

AUTO

1

Value of the header entry.
Sample (auto-generated)
Value = CSK_LiveConnect.Header.getValue(obj)
CSK_LiveConnect.Header.setKey()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Header

1

The instance

Key

STRING

1

Key of the header entry.
Sample (auto-generated)
CSK_LiveConnect.Header.setKey(obj, Key)
CSK_LiveConnect.Header.setValue()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Header

1

The instance

Value

AUTO

1

Value of the header entry.
Sample (auto-generated)
CSK_LiveConnect.Header.setValue(obj, Value)

CSK_LiveConnect.HTTPProfile

Short description

HTTP profile definition.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.HTTPProfile.create()
Short description

Creates an object

Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.HTTPProfile.create()
CSK_LiveConnect.HTTPProfile.getDescription()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

HTTP profile description.
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getDescription(obj)
CSK_LiveConnect.HTTPProfile.getEndpoints()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

+

HTTP endpoints provided by the profile.
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getEndpoints(obj)
CSK_LiveConnect.HTTPProfile.getName()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

HTTP profile name.
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getName(obj)
CSK_LiveConnect.HTTPProfile.getOpenAPISpecification()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

Content of the openAPI specification file.
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getOpenAPISpecification(obj)
CSK_LiveConnect.HTTPProfile.getServiceLocation()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

HTTP profile service location without a leading or an ending "/".
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getServiceLocation(obj)
CSK_LiveConnect.HTTPProfile.getUUID()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

HTTP profile UUID with identifies the profile.
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getUUID(obj)
CSK_LiveConnect.HTTPProfile.getVersion()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

HTTP profile version in the format [X.X.X].
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.getVersion(obj)
CSK_LiveConnect.HTTPProfile.setDescription()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

STRING

1

HTTP profile description.
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setDescription(obj, arg)
CSK_LiveConnect.HTTPProfile.setEndpoints()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

+

HTTP endpoints provided by the profile.
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setEndpoints(obj, arg)
CSK_LiveConnect.HTTPProfile.setName()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

STRING

1

HTTP profile name.
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setName(obj, arg)
CSK_LiveConnect.HTTPProfile.setOpenAPISpecification()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

STRING

1

Content of the openAPI specification file.
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setOpenAPISpecification(obj, arg)
CSK_LiveConnect.HTTPProfile.setServiceLocation()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

STRING

1

HTTP profile service location without a leading or an ending "/".
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setServiceLocation(obj, arg)
CSK_LiveConnect.HTTPProfile.setUUID()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

STRING

1

HTTP profile UUID with identifies the profile.
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setUUID(obj, arg)
CSK_LiveConnect.HTTPProfile.setVersion()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile

1

The instance

arg

STRING

1

HTTP profile version in the format [X.X.X].
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.setVersion(obj, arg)

CSK_LiveConnect.HTTPProfile.Endpoint

Short description

HTTP endpoint that is offered by the HTTP profile.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.HTTPProfile.Endpoint.create()
Short description

Creates an object

Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.HTTPProfile.Endpoint.create()
CSK_LiveConnect.HTTPProfile.Endpoint.getHandlerFunction()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

CROWN name of a function with parameter type is request and return value type is response.
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.Endpoint.getHandlerFunction(obj)
CSK_LiveConnect.HTTPProfile.Endpoint.getMethod()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

HTTP method that is allowed on this endpoint (GET, POST).
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.Endpoint.getMethod(obj)
CSK_LiveConnect.HTTPProfile.Endpoint.getURI()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

Relative URI of the HTTP endpoint without a leading "/".
Sample (auto-generated)
arg = CSK_LiveConnect.HTTPProfile.Endpoint.getURI(obj)
CSK_LiveConnect.HTTPProfile.Endpoint.setHandlerFunction()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance

arg

STRING

1

CROWN name of a function with parameter type is request and return value type is response.
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.Endpoint.setHandlerFunction(obj, arg)
CSK_LiveConnect.HTTPProfile.Endpoint.setMethod()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance

arg

STRING

1

HTTP method that is allowed on this endpoint (GET, POST).
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.Endpoint.setMethod(obj, arg)
CSK_LiveConnect.HTTPProfile.Endpoint.setURI()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.HTTPProfile.Endpoint

1

The instance

arg

STRING

1

Relative URI of the HTTP endpoint without a leading "/".
Sample (auto-generated)
CSK_LiveConnect.HTTPProfile.Endpoint.setURI(obj, arg)

CSK_LiveConnect.MQTTProfile

Short description

MQTT profile definition.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.MQTTProfile.create()
Short description

Creates an object

Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.MQTTProfile.create()
CSK_LiveConnect.MQTTProfile.getAsyncAPISpecification()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Return values
Name Type Multiplicity Description

AsyncAPISpecification

STRING

1

Content of the asyncAPI specification file.
Sample (auto-generated)
AsyncAPISpecification = CSK_LiveConnect.MQTTProfile.getAsyncAPISpecification(obj)
CSK_LiveConnect.MQTTProfile.getBaseTopic()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

Must be unique if multiple profile instances are used per device.
Sample (auto-generated)
arg = CSK_LiveConnect.MQTTProfile.getBaseTopic(obj)
CSK_LiveConnect.MQTTProfile.getDescription()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

MQTT profile description.
Sample (auto-generated)
arg = CSK_LiveConnect.MQTTProfile.getDescription(obj)
CSK_LiveConnect.MQTTProfile.getName()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

MQTT profile name.
Sample (auto-generated)
arg = CSK_LiveConnect.MQTTProfile.getName(obj)
CSK_LiveConnect.MQTTProfile.getUUID()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

MQTT profile UUID with identifies the profile.
Sample (auto-generated)
arg = CSK_LiveConnect.MQTTProfile.getUUID(obj)
CSK_LiveConnect.MQTTProfile.getVersion()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance
Return values
Name Type Multiplicity Description

Version

STRING

1

MQTT profile version in the format [X.X.X].
Sample (auto-generated)
Version = CSK_LiveConnect.MQTTProfile.getVersion(obj)
CSK_LiveConnect.MQTTProfile.setAsyncAPISpecification()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance

AsyncAPISpecification

STRING

1

Content of the asyncAPI specification file.
Sample (auto-generated)
CSK_LiveConnect.MQTTProfile.setAsyncAPISpecification(obj, AsyncAPISpecification)
CSK_LiveConnect.MQTTProfile.setBaseTopic()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance

arg

STRING

1

Must be unique if multiple profile instances are used per device.
Sample (auto-generated)
CSK_LiveConnect.MQTTProfile.setBaseTopic(obj, arg)
CSK_LiveConnect.MQTTProfile.setDescription()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance

arg

STRING

1

MQTT profile description.
Sample (auto-generated)
CSK_LiveConnect.MQTTProfile.setDescription(obj, arg)
CSK_LiveConnect.MQTTProfile.setName()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance

arg

STRING

1

MQTT profile name.
Sample (auto-generated)
CSK_LiveConnect.MQTTProfile.setName(obj, arg)
CSK_LiveConnect.MQTTProfile.setUUID()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance

arg

STRING

1

MQTT profile UUID with identifies the profile.
Sample (auto-generated)
CSK_LiveConnect.MQTTProfile.setUUID(obj, arg)
CSK_LiveConnect.MQTTProfile.setVersion()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.MQTTProfile

1

The instance

Version

STRING

1

MQTT profile version in the format [X.X.X].
Sample (auto-generated)
CSK_LiveConnect.MQTTProfile.setVersion(obj, Version)

CSK_LiveConnect.Request

Short description

HTTP request that was received by the LiveConnect server.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.Request.create()
Short description

Creates an object

Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.Request.create()
CSK_LiveConnect.Request.getContent()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance
Return values
Name Type Multiplicity Description

arg

BINARY

1

REST payload (body).
Sample (auto-generated)
arg = CSK_LiveConnect.Request.getContent(obj)
CSK_LiveConnect.Request.getHeaders()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance
Return values
Name Type Multiplicity Description

key

OBJECT
CSK_LiveConnect.Header

+

HTTP header information.
Sample (auto-generated)
key = CSK_LiveConnect.Request.getHeaders(obj)
CSK_LiveConnect.Request.getHost()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance
Return values
Name Type Multiplicity Description

Host

STRING

1

Host URL.
Sample (auto-generated)
Host = CSK_LiveConnect.Request.getHost(obj)
CSK_LiveConnect.Request.getMethod()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance
Return values
Name Type Multiplicity Description

arg

STRING

1

REST method (GET,POST, ..).
Sample (auto-generated)
arg = CSK_LiveConnect.Request.getMethod(obj)
CSK_LiveConnect.Request.getURL()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance
Return values
Name Type Multiplicity Description

u

STRING

1

URL from the sender. Depending on the application, the URL contains REST parameter information.
Sample (auto-generated)
u = CSK_LiveConnect.Request.getURL(obj)
CSK_LiveConnect.Request.setContent()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance

arg

BINARY

1

REST payload (body).
Sample (auto-generated)
CSK_LiveConnect.Request.setContent(obj, arg)
CSK_LiveConnect.Request.setHeaders()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance

key

OBJECT
CSK_LiveConnect.Header

+

HTTP header information.
Sample (auto-generated)
CSK_LiveConnect.Request.setHeaders(obj, key)
CSK_LiveConnect.Request.setHost()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance

Host

STRING

1

Host URL.
Sample (auto-generated)
CSK_LiveConnect.Request.setHost(obj, Host)
CSK_LiveConnect.Request.setMethod()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance

arg

STRING

1

REST method (GET,POST, ..).
Sample (auto-generated)
CSK_LiveConnect.Request.setMethod(obj, arg)
CSK_LiveConnect.Request.setURL()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Request

1

The instance

u

STRING

1

URL from the sender. Depending on the application, the URL contains REST parameter information.
Sample (auto-generated)
CSK_LiveConnect.Request.setURL(obj, u)

CSK_LiveConnect.Response

Short description

HTTP response that should be sent to the LiveConnect server.
Listed 'get'/'set' functions in API documentation relate to CROWN properties.

Overview

Functions

CSK_LiveConnect.Response.create()
Short description

Creates an object

Return values
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance
Sample (auto-generated)
obj = CSK_LiveConnect.Response.create()
CSK_LiveConnect.Response.getContent()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance
Return values
Name Type Multiplicity Description

arg

BINARY

1

REST payload (body).
Sample (auto-generated)
arg = CSK_LiveConnect.Response.getContent(obj)
CSK_LiveConnect.Response.getHeaders()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance
Return values
Name Type Multiplicity Description

Headers

OBJECT
CSK_LiveConnect.Header

+

HTTP header information.
Sample (auto-generated)
Headers = CSK_LiveConnect.Response.getHeaders(obj)
CSK_LiveConnect.Response.getStatusCode()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance
Return values
Name Type Multiplicity Description

arg

INT

1

HTTP REST status code.
Sample (auto-generated)
arg = CSK_LiveConnect.Response.getStatusCode(obj)
CSK_LiveConnect.Response.setContent()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance

arg

BINARY

1

REST payload (body).
Sample (auto-generated)
CSK_LiveConnect.Response.setContent(obj, arg)
CSK_LiveConnect.Response.setHeaders()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance

Headers

OBJECT
CSK_LiveConnect.Header

+

HTTP header information.
Sample (auto-generated)
CSK_LiveConnect.Response.setHeaders(obj, Headers)
CSK_LiveConnect.Response.setStatusCode()
Parameters
Name Type Multiplicity Description

obj

OBJECT
CSK_LiveConnect.Response

1

The instance

arg

INT

1

HTTP REST status code.
Sample (auto-generated)
CSK_LiveConnect.Response.setStatusCode(obj, arg)

CSK_LiveConnect.UI

Short description

Functionalities especially for the UI.

Overview

Functions

CSK_LiveConnect.UI.getCurrentView()
Short description

Provides information about the information to be displayed on the UI page (UI only).

Return values
Name Type Multiplicity Description

value

STRING

1

0 = Show pairing code and pair button.
1 = Show device url and unpair button.
Sample (auto-generated)
value = CSK_LiveConnect.UI.getCurrentView()
CSK_LiveConnect.UI.getSystemClockStatus()
Short description

Get the status of the system clock (UI only).

Return values
Name Type Multiplicity Description

status

STRING

1

Status (configured / not configured) and date / time in format [yyyy-mm-dd hh:mm:ss] UTC).
Sample (auto-generated)
status = CSK_LiveConnect.UI.getSystemClockStatus()
CSK_LiveConnect.UI.isSystemClockConfigured()
Short description

Indicates if the system clock is configured.

Return values
Name Type Multiplicity Description

value

BOOL

1

true = not configured
false= configured
Sample (auto-generated)
value = CSK_LiveConnect.UI.isSystemClockConfigured()

Events

CSK_LiveConnect.UI.OnNewStatusCurrentView
Short description

Notify information about the information to be displayed on the UI page (UI only).

Callback arguments
Name Type Multiplicity Description

value

STRING

1

0 = Show pairing code and pair button.
1 = Show device url and unpair button.
Sample (auto-generated)
function handleOnNewStatusCurrentView(value)
  -- Do something
end

Script.register("CSK_LiveConnect.UI.OnNewStatusCurrentView", "handleOnNewStatusCurrentView")
CSK_LiveConnect.UI.OnNewStatusSystemClock
Short description

Notify system clock status.

Callback arguments
Name Type Multiplicity Description

status

STRING

1

Status (configured / not configured) and date / time in format [yyyy-mm-dd hh:mm:ss] UTC).
Sample (auto-generated)
function handleOnNewStatusSystemClock(status)
  -- Do something
end

Script.register("CSK_LiveConnect.UI.OnNewStatusSystemClock", "handleOnNewStatusSystemClock")
CSK_LiveConnect.UI.OnNewStatusSystemClockConfigured
Short description

Notify if system clock was configured.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_LiveConnect.UI.OnNewStatusSystemClockConfigured", "handleOnNewStatusSystemClockConfigured")

CSK_Module_LiveConnect

Short description

Auto generated Crown (not needed)

Overview

Enumerations

C

CSK_LiveConnect.ConnectionStatus

Connection status enum.

Items
Value Name Description 
CHECK_PAIRING

CHECK_PAIRING

Check pairing information.

 
DISCONNECTED

DISCONNECTED

Disconnected from LiveConnect backend.

 
ERROR

ERROR

Error occured.

 
DISCOVERY_RESPONSE_RECEIVED

DISCOVERY_RESPONSE_RECEIVED

Discovery response received.

 
STATE_CONNECTED

STATE_CONNECTED

Connected to LiveConnect backend.

 
EXECUTING_COMMAND

EXECUTING_COMMAND

Executing command.