Configuration files

Zivid configuration files are a set of files used to configure Zivid software. The configuration files are optional, and Zivid software can operate without them. The files are stored in %LOCALAPPDATA%\Zivid\ on Windows and $HOME/.config/Zivid/ on Ubuntu.

Below you will find information about each configuration file.

Config.yml

This file is used as the main configuration file for Zivid SDK, where you can among others:

• Enable or disable diagnostics

• Enable or disable cloud logging

• Specify the Point Cloud Data (PCD) output format

• Set the projector Brightness limitation

• Select a specific or unsupported GPU for Zivid SDK

• Enable ordered disable thermal stabilization

For example, with all of the above enabled, the file contents will look like this:

__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

If the file does not exist, follow these steps to download and install it:

1. Download the Config.yml file.

2. Modify the file with your desired configuration.

3. 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/
   

조심

Any existing Config file will be overwritten.

Cameras.yml

This file is used to restrict the valid camera IP addresses or hostnames that are visible in the SDK. You can read more in Restrict valid camera IP addresses.

Below are examples with IP addresses and hostnames.

Sample Cameras.yml file (hostnames)

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

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

참고

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.

If the file does not exist, follow these steps to download and install it:

1. Download the Cameras.yml file.

2. Modify the file with the IP addresses or hostnames you want to restrict.

3. Place the downloaded Cameras 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/
   

조심

Any existing Cameras file will be overwritten.

Preferences.ini

This file is used to configure and persist Zivid Studio preferences, and can be interfaced through Zivid Studio. It will automatically get created once you modify the default preferences in Zivid Studio, which are:

[SoftwareUpdate]
NotificationEnabled=true

[View]
Reset3DViewWhenOpeningFiles=true
Synchronize3DViewBetweenProcesses=false

These are the current Zivid Studio preferences:

• NotificationEnabled: Disable to avoid software update notifications in Zivid Studio when new versions are available.

• Reset3DViewWhenOpenFiles: Disable to keep the 3D view as it is when opening new files in Zivid Studio.

• Synchronize3DViewBetweenProcesses: Enable to synchronize the 3D view between different Zivid Studio instances.

You can preemptively download and install the file with your desired preferences with these steps:

1. Download the Preferences.ini file.

2. Modify the file with your desired preferences.

3. Place the downloaded Preferences file in the following directory.

   Windows

   mkdir %LOCALAPPDATA%\Zivid\Studio
   move %HOMEPATH%\Downloads\Preferences.ini %LOCALAPPDATA%\Zivid\Studio\
   

   Ubuntu

   mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/Studio
   mv ~/Downloads/Preferences.ini "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/Studio/
   

조심

Any existing Preferences file will be overwritten.

Version History

SDK	Changes
2.15.0	Preferences.ini is added.
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.