配置文件

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.

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

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. 下载 Config.yml 文件。

  2. Modify the file with your desired configuration.

  3. 将下载的Config文件放在以下目录中。

    mkdir %LOCALAPPDATA%\Zivid\API
move %HOMEPATH%\Downloads\Config.yml %LOCALAPPDATA%\Zivid\API\

    mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API
mv ~/Downloads/Config.yml "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API/

小心

任何现有的配置文件都将被覆盖。

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.

Cameras.yml (主机名) 示例文件
__version__: 1
Cameras:
    NetworkCameras:
        - NetworkCamera:
              Host: zivid-2152D404.local
        - NetworkCamera:
              Host: zivid-20205M19.local
        - NetworkCamera:
              Host: zivid-21389K63.local
Cameras.yml (IP地址) 示例文件
__version__: 1
Cameras:
    NetworkCameras:
        - NetworkCamera:
              Host: 172.28.60.5
        - NetworkCamera:
              Host: 172.28.60.6
        - NetworkCamera:
              Host: 172.28.60.7

备注

如果 Cameras.yml 位于 Zivid 配置文件夹中，则只有该文件中列出的 IP/主机名才会在 SDK 中可见，并且不会执行自动发现。

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

  1. 下载 Cameras.yml 文件。

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

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

    mkdir %LOCALAPPDATA%\Zivid\API
move %HOMEPATH%\Downloads\Cameras.yml %LOCALAPPDATA%\Zivid\API\

    mkdir --parents "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API
mv ~/Downloads/Cameras.yml "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API/

小心

任何现有的相机文件都将被覆盖。

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.

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

    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.

版本历史

SDK

变更

2.15.0

Preferences.ini is added.

2.11.0

不再推荐AMD。 SDK 中已移除相关的官方支持，请参阅 为 Zivid 软件启用不支持的计算设备 。不支持的 GPU 选项已添加到 Config.yml 中。

2.10.1

投影仪亮度限制已添加到 Config.yml 中。

2.9.0

Config.yml 中添加了热稳定功能。

2.8.0

添加了 Cameras.yml。

2.7.0

云日志记录已添加到 Config.yml 中。

2.6.0

诊断功能已添加到 Config.yml 中。

2.5.0

导出有序的 PCD 文件的功能已添加到 Config.yml 中。

2.4.0

计算设备已添加到Config.yml中。