Document metadata

Application name

CSK_Module_MultiRemoteLiDAR

Version

0.4.0

Date

2023-06-15

Author

SICK AG

Crowns

C

CSK_Module_MultiRemoteLiDAR

Short description

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

CSK_MultiRemoteLiDAR

Short description

Module to provide RemoteScan configuration functionality.
Multiple instances can be created and scan processing will run in multiple threads on the device.
Incoming scans can be used / processed in other apps / modules.
Typically the features of this module are used like this (check also main script of this module):

1) Setup
1) If multiple scanner instances are available, selecte a specific sensor via "setSelectedInstance"
2) Set interface type to connect to sensor via "setInterface"
3) Optionally set sensor IP via "setIP" if interface is "ETHERNET"
4) Start sensor camera via "startSensor"
5) Other modules can register on the "OnNewScan"-event by getting the Scan provider handle via "getLiDARHandle" (before they can check the instance amount via "getInstancesAmount")

2) Access from other applications
You can process incoming scans in other modules by getting the Scan handle via 'getLiDARHandle' and registering to its "OnNewScan"-event to get them directly wihtin your app.

3) Merge with encoder data
It is possible to merge incoming scan data with the data of a connected encoder. It is needed to run the CSK_Module_Encoder in parallel.
Activate it via "setEncoderMode". It is possible to configure the duration of the measurement via "setEncoderDurationMode(Value)".
Additionally you can trigger this measurement via a predefined event from another app (see "setEncoderTriggerEvent").
After the measurement was finished, it will provide the result as a PointCloud within the "OnNewEncoderScan[NUM]" event.

Overview

Functions

CSK_MultiRemoteLiDAR.addInstance()
Short description

Function to add an additional instance.

Sample (auto-generated)
CSK_MultiRemoteLiDAR.addInstance()
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.getInstancesAmount()
CSK_MultiRemoteLiDAR.getLiDARHandle()
Short description

Function to return LiDAR scanner handle (to make use of it in other modules).

Parameters
Name Type Multiplicity Description

instanceNo

INT

1

Instance no of LiDAR sensor.
Return values
Name Type Multiplicity Description

lidarProvider

HANDLE
Scan.Provider.RemoteScanner

?

Handle of scan provider.
Sample (auto-generated)
lidarProvider = CSK_MultiRemoteLiDAR.getLiDARHandle(instanceNo)
CSK_MultiRemoteLiDAR.loadParameters()
Short description

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

Sample (auto-generated)
CSK_MultiRemoteLiDAR.loadParameters()
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.pageCalled()
CSK_MultiRemoteLiDAR.processInstanceNUM()
Short description

Example of dynamically served function to process internally coded function.
NUM will be replaced by the number of instance (e.g. "processInstance1").
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

object

OBJECT
Alias

?

Transferred object (optional).
Return values
Name Type Multiplicity Description

result

BOOL

?

Processing result (optional).
Sample (auto-generated)
result = CSK_MultiRemoteLiDAR.processInstanceNUM(object)
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.resetInstances()
CSK_MultiRemoteLiDAR.sendParameters()
Short description

Send parameters to CSK_PersistentData module if possible to save them.

Sample (auto-generated)
CSK_MultiRemoteLiDAR.sendParameters()
CSK_MultiRemoteLiDAR.setEncoderDurationMode()
Short description

Function to set encoder duration mode.

Parameters
Name Type Multiplicity Description

mode

ENUM
CSK_MultiRemoteLiDAR.EncoderDurationMode

1

Mode
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setEncoderDurationMode(mode)
CSK_MultiRemoteLiDAR.setEncoderDurationModeValue()
Short description

Function to configure encoder duration mode value.

Parameters
Name Type Multiplicity Description

value

INT

1

Value (related to configured encoderDurationMode).
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setEncoderDurationModeValue(value)
CSK_MultiRemoteLiDAR.setEncoderMode()
Short description

Function to activate encoder mode.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setEncoderMode(status)
CSK_MultiRemoteLiDAR.setEncoderModeLoop()
Short description

Function to set if it automatically should retrigger an encoder measurement.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setEncoderModeLoop(status)
CSK_MultiRemoteLiDAR.setEncoderTriggerEvent()
Short description

Function to set event to start encoder measurement if notified.

Parameters
Name Type Multiplicity Description

event

STRING

1

Name of event
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setEncoderTriggerEvent(event)
CSK_MultiRemoteLiDAR.setInterface()
Short description

Function to set interface to LiDAR sensor.

Parameters
Name Type Multiplicity Description

interface

ENUM
CSK_MultiRemoteLiDAR.Interface

1

Interface
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setInterface(interface)
CSK_MultiRemoteLiDAR.setInternalProcessing()
Short description

Function to configure if incomings scans should be processed in this module or just to provide them for other modules.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setInternalProcessing(status)
CSK_MultiRemoteLiDAR.setIP()
Short description

Function to set IP of LiDAR sensor.

Parameters
Name Type Multiplicity Description

ip

STRING

1

IP
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setIP(ip)
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.setLoadOnReboot(status)
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.setParameterName(name)
CSK_MultiRemoteLiDAR.setSelectedInstance()
Short description

Select one of the multiple instances.

Parameters
Name Type Multiplicity Description

instance

INT

1

Instance to select.
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setSelectedInstance(instance)
CSK_MultiRemoteLiDAR.setSensorType()
Short description

Function to set type of LiDAR sensor.

Parameters
Name Type Multiplicity Description

sensorType

ENUM
CSK_MultiRemoteLiDAR.SensorType

1

Type of sensor
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setSensorType(sensorType)
CSK_MultiRemoteLiDAR.setViewerActive()
Short description

Function to set if scan should be shown in viewer.

Parameters
Name Type Multiplicity Description

status

BOOL

1

Status
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setViewerActive(status)
CSK_MultiRemoteLiDAR.setViewerType()
Short description

Function to set what kind of viewer to use.

Parameters
Name Type Multiplicity Description

viewerType

STRING

1

Type of viewer.
Sample (auto-generated)
CSK_MultiRemoteLiDAR.setViewerType(viewerType)
CSK_MultiRemoteLiDAR.startLiDARSensor()
Short description

Function to start currently selected LiDAR sensor instance.

Sample (auto-generated)
CSK_MultiRemoteLiDAR.startLiDARSensor()
CSK_MultiRemoteLiDAR.stopLiDARSensor()
Short description

Function to stop currently selected LiDAR sensor.

Sample (auto-generated)
CSK_MultiRemoteLiDAR.stopLiDARSensor()
CSK_MultiRemoteLiDAR.triggerEncoderMeasurement()
Short description

Function to trigger new encoder measurement.

Sample (auto-generated)
CSK_MultiRemoteLiDAR.triggerEncoderMeasurement()

Events

CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")
CSK_MultiRemoteLiDAR.OnDeregisterLiDARSensorNUM
Short description

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

Callback arguments
Name Type Multiplicity Description

lidarSensor

HANDLE
Scan.Provider.RemoteScanner

1

LiDAR sensor instance to deregister.
Sample (auto-generated)
function handleOnDeregisterLiDARSensorNUM(lidarSensor)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnDeregisterLiDARSensorNUM", "handleOnDeregisterLiDARSensorNUM")
CSK_MultiRemoteLiDAR.OnNewEncoderScanNUM
Short description

Notify scan data merged with encoder data Example of dynamically created event to provide scan data merged with encoder info if encoderMode is active.
NUM will be replaced by the number of instance (e.g. "OnNewEncoderScan1").
INFO: Other modules can check via "Script.isServedAsEvent" if event of sepecific instance exists.

Callback arguments
Name Type Multiplicity Description

mergedScan

OBJECT
PointCloud

1

PointCloud
Sample (auto-generated)
function handleOnNewEncoderScanNUM(mergedScan)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnNewEncoderScanNUM", "handleOnNewEncoderScanNUM")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnNewInstanceList", "handleOnNewInstanceList")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnNewParameterName", "handleOnNewParameterName")
CSK_MultiRemoteLiDAR.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

1

value of the parameter.

internalObjectNo

INT

?

If parameter is for specifici internal used object, its nnumber.
Sample (auto-generated)
function handleOnNewProcessingParameter(objectNo, parameter, value, internalObjectNo)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnNewProcessingParameter", "handleOnNewProcessingParameter")
CSK_MultiRemoteLiDAR.OnNewResult
Short description

Generic event to notify results. E.g. to forward results from single instances.

Callback arguments
Name Type Multiplicity Description

result

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewResult", "handleOnNewResult")
CSK_MultiRemoteLiDAR.OnNewResultNUM
Short description

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

Callback arguments
Name Type Multiplicity Description

result

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewResultNUM", "handleOnNewResultNUM")
CSK_MultiRemoteLiDAR.OnNewScanViewerID
Short description

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

Callback arguments
Name Type Multiplicity Description

viewerID

STRING

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewScanViewerID", "handleOnNewScanViewerID")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnNewSelectedInstance", "handleOnNewSelectedInstance")
CSK_MultiRemoteLiDAR.OnNewStatusEncoderDurationMode
Short description

Notify encoder duration mode.

Callback arguments
Name Type Multiplicity Description

mode

STRING

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusEncoderDurationMode", "handleOnNewStatusEncoderDurationMode")
CSK_MultiRemoteLiDAR.OnNewStatusEncoderDurationModeValue
Short description

Notify related value for encoderDurationMode.

Callback arguments
Name Type Multiplicity Description

value

INT

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusEncoderDurationModeValue", "handleOnNewStatusEncoderDurationModeValue")
CSK_MultiRemoteLiDAR.OnNewStatusEncoderMode
Short description

Notify if sensor data shoud be combined with encoder data.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusEncoderMode", "handleOnNewStatusEncoderMode")
CSK_MultiRemoteLiDAR.OnNewStatusEncoderModeLoop
Short description

Notify if the module should automatically retrigger encoder measurements.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusEncoderModeLoop", "handleOnNewStatusEncoderModeLoop")
CSK_MultiRemoteLiDAR.OnNewStatusEncoderTriggerEvent
Short description

Notify event to start encoder scan measurement if notified.

Callback arguments
Name Type Multiplicity Description

event

STRING

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusEncoderTriggerEvent", "handleOnNewStatusEncoderTriggerEvent")
CSK_MultiRemoteLiDAR.OnNewStatusInstanceAmount
Short description

Notify amount of instances.

Callback arguments
Name Type Multiplicity Description

amoun

INT

1

Amount of instances.
Sample (auto-generated)
function handleOnNewStatusInstanceAmount(amoun)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusInstanceAmount", "handleOnNewStatusInstanceAmount")
CSK_MultiRemoteLiDAR.OnNewStatusInterface
Short description

Notify interface of currently selected sensor.

Callback arguments
Name Type Multiplicity Description

interface

STRING

1

Interface
Sample (auto-generated)
function handleOnNewStatusInterface(interface)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusInterface", "handleOnNewStatusInterface")
CSK_MultiRemoteLiDAR.OnNewStatusInternalProcessing
Short description

Notify if incoming scans are processed in this module.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusInternalProcessing", "handleOnNewStatusInternalProcessing")
CSK_MultiRemoteLiDAR.OnNewStatusIPError
Short description

Notify if configured IP is faulty.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusIPError", "handleOnNewStatusIPError")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")
CSK_MultiRemoteLiDAR.OnNewStatusSensorIP
Short description

Notify IP of currently selected sensor.

Callback arguments
Name Type Multiplicity Description

ip

STRING

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusSensorIP", "handleOnNewStatusSensorIP")
CSK_MultiRemoteLiDAR.OnNewStatusSensorType
Short description

Notify type of sensor.

Callback arguments
Name Type Multiplicity Description

sensorType

STRING

1

Sensor type
Sample (auto-generated)
function handleOnNewStatusSensorType(sensorType)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusSensorType", "handleOnNewStatusSensorType")
CSK_MultiRemoteLiDAR.OnNewStatusViewerActive
Short description

Notify if scan should be shown in viewer.

Callback arguments
Name Type Multiplicity Description

status

BOOL

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusViewerActive", "handleOnNewStatusViewerActive")
CSK_MultiRemoteLiDAR.OnNewStatusViewerType
Short description

Notify type of currently active viewer.

Callback arguments
Name Type Multiplicity Description

type

STRING

1

Type of viewer.
Sample (auto-generated)
function handleOnNewStatusViewerType(type)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnNewStatusViewerType", "handleOnNewStatusViewerType")
CSK_MultiRemoteLiDAR.OnNewValueToForwardNUM
Short description

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

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_MultiRemoteLiDAR.OnNewValueToForwardNUM", "handleOnNewValueToForwardNUM")
CSK_MultiRemoteLiDAR.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. "OnNewResult1").

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_MultiRemoteLiDAR.OnNewValueUpdateNUM", "handleOnNewValueUpdateNUM")
CSK_MultiRemoteLiDAR.OnNewViewerID
Short description

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

Callback arguments
Name Type Multiplicity Description

viewerID

STRING

1

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

Script.register("CSK_MultiRemoteLiDAR.OnNewViewerID", "handleOnNewViewerID")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")
CSK_MultiRemoteLiDAR.OnRegisterLiDARSensorNUM
Short description

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

Callback arguments
Name Type Multiplicity Description

lidarSensor

HANDLE
Scan.Provider.RemoteScanner

1

LiDAR sensor instance to register.
Sample (auto-generated)
function handleOnRegisterLiDARSensorNUM(lidarSensor)
  -- Do something
end

Script.register("CSK_MultiRemoteLiDAR.OnRegisterLiDARSensorNUM", "handleOnRegisterLiDARSensorNUM")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")
CSK_MultiRemoteLiDAR.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_MultiRemoteLiDAR.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

Enumerations

C

CSK_MultiRemoteLiDAR.EncoderDurationMode

Duration mode for encoder measurement.

Items
Value Name Description 
TICKS

TICKS

Encoder ticks

CSK_MultiRemoteLiDAR.Interface

Interface used to connect to the LiDAR sensor.

Items
Value Name Description 
ETHERNET

ETHERNET

Ethernet

 
SERIAL

SERIAL

Serial

CSK_MultiRemoteLiDAR.SensorType

Type of the LiDAR sensor.

Items
Value Name Description 
LMSX00

LMSX00

Default standard LMS type for LMS100,LMS500,TIM.

 
LD_MRS

LD_MRS

Special type for LD-MRS.

 
S300

S300

Special type for S300 and S3000.

 
MICRO_SCAN

MICRO_SCAN

Special type for MicroScan.

 
NO_SENSOR

NO_SENSOR

Type to disable this provider.

 
LMS4XXX

LMS4XXX

Special type for LMS4000 scanner.

 
MRS1000

MRS1000

Will use default standard LMS type but with special processing.