Application Settings Content Example

If you don‘t want to set the parameters each time you connect to the camera, you can set the camera to a specific configuration by specifying its name.

{
    "meta": {
        "inputFileType": "LumiScan-CtrlX-Cam-Driver",
        "inputFileVersion": "0.0.1",
        "targetMachine": "CtrlX7",
        "programName": "lumiscan-cam-driver",
        "programVersion": "0.0.1"
    },
    "configurations": [
        "camera_example.json"
    ],
    "system":{
        "debug": true,
        "logLevel": "INFO"
    }
}

Table 1. Table 5: Application Settings File: JSON Settings Description
Parameter	Description
meta	Place to set meta information: inputFileType and inputFileVersion are required.
inputFileType	IIn this case it must be: `LumiScan-CtrlX-Cam-Driver`
inputFileVersion	Currently, only version 0.0.1 is supported.
targetMachine	Optional. Enter the name of the machine in use here to indicate that the current application configuration is being used for this particular machine.
programName	Optional. This parameter indicates by which application the current file is used. In this case: `lumiscan-cam-driver`
programVersion	Optional. Currently used program version.
configurations	This is a list of camera configuration files. Camera serials should not be duplicated.
system	Setup of the configuration related to the device the Cam Driver runs on (ctrlX CORE or PC).
debug	Shows detailed message of i/o of datalayer. Possible values: `true` or `false`
logLevel	Change log level, possible values are: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF.

{
    "meta": {
        "inputFileType": "LumiScan-CtrlX-Cam-Driver",
        "inputFileVersion": "1.0.1",
        "targetMachine": "CtrlX7",
        "programName": "lumiscan-cam-driver",
        "programVersion": "1.0.1"
    },
    "configurations": [
        "camera_example.json"
    ],
    "system": {
        "debug": true,
        "logLevel": "TRACE",
        "storage": {
            "type":"Samba",
            "parameters": {
                "ip": "192.168.31.93",
                "remotePath": "temp",
                "domain": "domainname",
                "username": "username",
                "password": "password"
            }
        }
    }
}

Storage settings

The JSON settings also determine where captured images are stored. To configure these settings, add new parameters to the system section. The example below shows a configuration that stores images on Samba storage. See Saving Image Files for information on setting up such storage. The added settings are shown in red.

Use the following settings to configure a USB storage device or SD card (ctrlX OS). Note that the beginning of the path must match the one shown to you earlier when you set up the storage device, as explained in Saving Image Files.

           “storage“:{
                “type“:“Internal“,
                “parameters“: {
                    “rootPath“: “/media/sdb1/myCapturedImages“
                }
            }

The description of the storage parameters can be found in the following Table 6: Storage Parameters Description.

Table 2. Table 6: Storage Parameters Description
Parameter	Description
storage	If not specified, the save function will do nothing.
type	Type of supported external or internal storage. Possible values are Null, Internal (Internal storage; on ctrlX OS also a USB storage device or SD Card) and Samba (Windows shared folder)
rootPath	This is only used for the storage type ‚Internal‘. It specifies the location where the image files are stored. If a relative path is specified, (i.e. not starting with a /), the images will be stored in the internal directory of the LumiScan-Cam-Driver application. On ctrlX OS, if a path starting with the path of a USB storage device or SD card is specified. (e.g. `/media/sdb1/myCapturedImages`), the images will be stored on that device.
parameters	Here: Parameters for Samba type.
ip	Samba server IP
domain	Domain name of the local network. If the server is on a domain, please check with your IT department to ensure that there is no additional firewall on the domain. If there is no domain name, enter it as „“.
remotePath	The rest of the path when accessing the shared folder. (Users can access the folder directly with `//<ip>/<remotePath>`).
username	Username of Samba (Windows shared folder) Server
password	The password is stored in clear text. Therefore, it is not recommended to use a regular user to access the shared folder.

After changing the parameters, the LumiScan CamDriver application should be restarted.

Complete reference

Every setting of this file as its JSON Schema lumiscan-cam-driver.schema.json defines it, generated for version 2.2.1:

Setting Type Default Allowed values Description

Setting	Type	Default	Allowed values	Description
`meta`	object			Required. Meta information about the application and current setting. This is mainly for information purpose and not used by the application itself
`meta/inputFileType`	string		not empty	Required.
`meta/inputFileVersion`	string		not empty	Required.
`meta/targetMachine`	string		not empty	Required.
`meta/programName`	string		not empty	Required.
`meta/programVersion`	string		not empty	Required.
`modules`	string[]		at least 1 entry	Required. List of module setting files that will be loaded by the application. One camera per entry; each file is resolved next to this settings file.
`cameraDrivers`	object[]			GenTL producers (camera drivers) available to camera modules. Each camera references one of these by its 'driverId'.
`cameraDrivers[]/id`	string	`default`	not empty	Required. Unique id referenced by a camera module's 'driverId'.
`cameraDrivers[]/gentlPath`	string		not empty	Required. Path to the GenTL producer (.cti). Relative paths resolve from SNAP_COMMON; absolute paths are used as-is. For SIMULATION mode this should be a directory path.
`cameraDrivers[]/genTLConsumer`	string	`DEFAULT`	`DEFAULT`, `SIMULATION`, `BASLER`, `BALLUFF`, `LUCID`, `PEPPER_FUCHS`	Type of GenTL consumer. DEFAULT uses Baumer. SIMULATION loads images from directory specified in gentlPath.
`system`	object
`system/debug`	boolean	`false`		Enable debug mode for the application.
`system/logLevel`	string	`INFO`	`TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`	Log level for the application.
`system/storage`	object			Configuration for storage. The storage is used to store the images when save function is called.
`system/storage/type`	string		`Samba`	Required. The storage is a Samba storage.
`system/storage/parameters`	object			Parameters for the storage. The parameters are different for each storage type.
`system/storage/parameters/ip`	string		not empty	Required. The IP address of the Samba server.
`system/storage/parameters/remotePath`	string		not empty	Required. Share name and path on the Samba server, without the leading host part.
`system/storage/parameters/domain`	string		not empty	Required. Windows/Samba domain or workgroup the user belongs to.
`system/storage/parameters/username`	string		not empty	Required.
`system/storage/parameters/password`	string		not empty	Required.
`system/unifiedStorage`	boolean	`false`		If true, all cameras will share the same storage folder. If false, each camera will have its own storage folder.

meta

object

Required. Meta information about the application and current setting. This is mainly for information purpose and not used by the application itself

meta/inputFileType

string

not empty

Required.

meta/inputFileVersion

string

not empty

Required.

meta/targetMachine

string

not empty

Required.

meta/programName

string

not empty

Required.

meta/programVersion

string

not empty

Required.

modules

string[]

at least 1 entry

Required. List of module setting files that will be loaded by the application. One camera per entry; each file is resolved next to this settings file.

cameraDrivers

object[]

GenTL producers (camera drivers) available to camera modules. Each camera references one of these by its 'driverId'.

cameraDrivers[]/id

string

default

not empty

Required. Unique id referenced by a camera module's 'driverId'.

cameraDrivers[]/gentlPath

string

not empty

Required. Path to the GenTL producer (.cti). Relative paths resolve from SNAP_COMMON; absolute paths are used as-is. For SIMULATION mode this should be a directory path.

cameraDrivers[]/genTLConsumer

string

DEFAULT

DEFAULT, SIMULATION, BASLER, BALLUFF, LUCID, PEPPER_FUCHS

Type of GenTL consumer. DEFAULT uses Baumer. SIMULATION loads images from directory specified in gentlPath.

system

object

system/debug

boolean

false

Enable debug mode for the application.

system/logLevel

string

INFO

TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Log level for the application.

system/storage

object

Configuration for storage. The storage is used to store the images when save function is called.

system/storage/type

string

Samba

Required. The storage is a Samba storage.

system/storage/parameters

object

Parameters for the storage. The parameters are different for each storage type.

system/storage/parameters/ip

string

not empty

Required. The IP address of the Samba server.

system/storage/parameters/remotePath

string

not empty

Required. Share name and path on the Samba server, without the leading host part.

system/storage/parameters/domain

string

not empty

Required. Windows/Samba domain or workgroup the user belongs to.

system/storage/parameters/username

string

not empty

Required.

system/storage/parameters/password

string

not empty

Required.

system/unifiedStorage

boolean

false

If true, all cameras will share the same storage folder. If false, each camera will have its own storage folder.