配置文件

它是什么

Zivid 配置文件是一组用于配置 Zivid SDK 的 .yml 文件。它们分为两个文件 Config.ymlCameras.yml 。下面的列表显示了每个文件的配置选项:

配置文件是可选的,Zivid SDK 无需它们也可以运行。仅当您想自定义配置时才需要它们。

您将在下面找到 Config.ymlCameras.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 (主机名) 示例文件
__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 中可见,并且不会执行自动发现。

如何下载和使用配置文件

在配置文件中,您可以自定义不同的选项,例如关闭诊断或选择运行 Zivid SDK 的 GPU。这两个配置文件均位于 %LOCALAPPDATA%ZividAPI (Windows)或 "${XDG_CONFIG_HOME-$HOME/.config}"/Zivid/API (Ubuntu)。

Zivid SDK不包含任何配置文件,如需使用则需要下载。如果该文件不存在,请按照以下步骤下载:

  1. 下载 :download:` Config.yml </../files/full_config_yml/Config.yml>` 文件。

  2. 将下载的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/
    

    小心

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

  1. 下载 :download:` Cameras.yml </../files/cameras_yml_ip_addresses/Cameras.yml>` 文件。

  2. 将下载的cameras-yaml文件放在以下目录中。

    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/
    

    小心

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

小心

Zivid 配置文件必须使用 .yml 文件扩展名(而不是 .yaml)。

现在,您可以调整文件中的不同选项来自定义配置。

版本历史

SDK

变更

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中。