Configuration files

What is it

Zivid configuration files are a set of .yml files used to configure Zivid SDK. They are split into two files, Config.yml and Cameras.yml. The list below shows what configuration option you have for each file:

The configuration files are optional, and Zivid SDK operates without them. You only need them if you want to customize your configuration.

You will find example configuration files for both Config.yml and Cameras.yml below:

Config.yml

__version__:
    serializer: 1
    data: 19
Configuration:
    APIBreakingBugFixes:
        FileFormats:
            PCD:
                UseOrganizedFormat: yes
    Camera:
        TemperatureStabilization:
            Enabled: yes
        Power:
            Limit: unlimited
    Capture:
        Diagnostics:
            Enabled: CaptureSettingsDependent
    ComputeDevice:
        SelectionFilter: ""
        Type: GPU
        Vendor: Any
        AllowUnsupported: no
    MaintenanceServices:
        CloudIntegration:
            Enabled: yes

Cameras.yml

Sample Cameras.yml file (hostnames)

__version__: 1
Cameras:
    NetworkCameras:
        - NetworkCamera:
              Host: zivid-2152D404.local
        - NetworkCamera:
              Host: zivid-20205M19.local
        - NetworkCamera:
              Host: zivid-21389K63.local

or

Sample Cameras.yml file (IP addresses)

__version__: 1
Cameras:
    NetworkCameras:
        - NetworkCamera:
              Host: 172.28.60.5
        - NetworkCamera:
              Host: 172.28.60.6
        - NetworkCamera:
              Host: 172.28.60.7

Note

If Cameras.yml is in the Zivid configuration folder, only the IPs/hostnames listed in that file will be visible in the SDK, and auto-discovery will not be performed.

How to download and use the configuration files

In the configuration file, you may customize different options, such as turning diagnostics off or selecting which GPU to run Zivid SDK on. Both configuration files are file located in %LOCALAPPDATA%ZividAPI for Windows or "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API for Ubuntu.

Zivid SDK does not include any configuration files, and you need to download them if needed. If the file does not exist, follow these steps to download them:

Config.yml

Download the Config.yml file.
Place the downloaded Config file in the following directory.
Windows
mkdir %LOCALAPPDATA%\Zivid\API
move %HOMEPATH%\Downloads\Config.yml %LOCALAPPDATA%\Zivid\API\
Ubuntu
mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API
mv ~/Downloads/Config.yml "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API/
Caution

Any existing Config file will be overwritten.

Cameras.yml

Download the Cameras.yml file.
Place the downloaded cameras-yaml file in the following directory.
Windows
mkdir %LOCALAPPDATA%\Zivid\API
move %HOMEPATH%\Downloads\Cameras.yml %LOCALAPPDATA%\Zivid\API\
Ubuntu
mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API
mv ~/Downloads/Cameras.yml "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API/
Caution

Any existing Cameras file will be overwritten.

Caution

Zivid configuration files must use .yml file extension ( not .yaml).

Now, you can adjust the different options in the files to customize the configuration.

Version History

SDK	Changes
2.11.0	AMD is no longer recommended. Official support has been removed in SDK, see Enable Unsupported Compute Device for Zivid Software. Unsupported GPU option is added to Config.yml.
2.10.1	Projector brightness limitation is added to Config.yml.
2.9.0	Temperature stabilization is added to Config.yml.
2.8.0	Cameras.yml is added.
2.7.0	Cloud logging is added to Config.yml.
2.6.0	Diagnostics is added to Config.yml.
2.5.0	Exporting organized PCD is added to Config.yml.
2.4.0	Compute device is added to Config.yml.