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 be duplicated.
system	Setup ctrlX releated configuration.
debug	Shows detailed message of i/o of datalayer. Possible values: `true` or `false`
logLevel	Change log level, possible values are: INFO, DEBUG, WARN, 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. 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, 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. 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.