cn - ifm7 3d 摄像头 cn 3. 功能和特性 o3d3xx 3d...
TRANSCRIPT
操作说明 3D 摄像头
O3D301 O3D303 O3D311 O3D313
7063
97 /
07
12 /
2018
CN
3D 摄像头
2
目录1. 初步说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
1.1 使用的符号 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41.2 使用的警告 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41.3 开源信息 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
2. 安全说明 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.1 概要 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.2 目标群体 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.3 电气连接 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.4 擅自改装装置 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
3. 功能和特性 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74. 所供配件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75. 附件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76. 安装 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
6.1 选择安装位置 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86.2 其他摄像头安装指南 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
6.2.1 O3D301 / O3D303 的一般警告限制 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96.2.2 O3D311/O3D313 的一般警告限制 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106.2.3 降低表面温度 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
6.3 安装摄像头 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116.4 安装附件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
7. 电气连接 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127.1 配线 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
7.1.1 插脚 1/3 (24 V/GND). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137.1.2 插脚 2（触发输入） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137.1.3 插脚 4/5（就绪/级联） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
7.2 配线示例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147.2.1 使用接近传感器触发图像拍摄 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147.2.2 彼此相邻地安装多个摄像头 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
8. 指示器 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169. 设定 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
9.1 设定装置的参数. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179.2 检测物体 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
10. 编程示例 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1810.1 ifm3Dlib. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
11. 维护、修理及处理 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1911.1 清洁 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1911.2 更新固件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1911.3 更换摄像头 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
12. 认证/标准 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1913. 比例图 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
13.1 O3D303/O3D313 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2013.2 O3D301/O3D311 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
14. 附录 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2114.1 需要的端口 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2114.2 XML-RPC 接口 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
14.2.1 XML-RPC 命令样本 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2114.2.2 XML-RPC 对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
14.3 过程接口 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2514.3.1 发送命令 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2514.3.2 接收图像 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2614.3.3 图像数据 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2614.3.4 CONFIDENCE_IMAGE 的其他信息 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
3
3D 摄像头
CN
14.3.5 PCIC 输出的配置 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3014.4 过程接口命令参考 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
14.4.1 命令（启用应用程序） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3514.4.2 A? 命令（应用程序列表占用） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3514.4.3 c 命令（上传 PCIC 输出配置） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3614.4.4 C? 命令（检索当前 PCIC 配置） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3614.4.5 E? 命令（请求当前错误状态） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3614.4.6 G? 命令（请求装置信息） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3714.4.7 H? 命令（返回可用命令列表） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3814.4.8 I? 命令（请求上一张拍摄的图像） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3914.4.9 o 命令（设置 ID 的逻辑状态） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3914.4.10 O? 命令（请求 ID 的状态） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4014.4.11 p 命令（开启或关闭 PCIC 输出）. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4014.4.12 S? 命令（请求当前解码状态） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4114.4.13 t 命令（执行异步触发） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4114.4.14 T? 命令（执行同步触发）. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4214.4.15 v 命令（设置当前协议版本） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4214.4.16 V? 命令（请求当前协议版本） . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
14.5 错误代码 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4314.6 XML-RPC 命令参考 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
14.6.1 参数 API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4414.6.2 主对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4514.6.3 会话对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4814.6.4 编辑模式对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5014.6.5 装置配置对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5114.6.6 装置/网络配置对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5514.6.7 应用程序配置对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5514.6.8 应用程序/成像器配置对象 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5714.6.9 图像设置和滤波器参数 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
版权Microsoft®、Windows®、Windows Vista®、Windows 7®、Windows 8®、Windows 8.1® 和 Windows 10® 为 Microsoft Corporation 的注册商标。Adobe® 和 Acrobat® 为 Adobe Systems Inc. 的注册商标。所有使用的商标和公司名称均受相应公司的版权保护。
3D 摄像头
4
1. 初步说明此文档供专业人士使用。 此类专业人士是指经过适当培训有丰富的实践经验，能够预见和避免在操作和维护装置期间的风险及危险的人士。 本文档包含正确操作装置的相关信息。使用产品前请阅读本文档，以了解操作条件、安装和操作。 使用装置期间，请始终妥善保管本文档。
1.1 使用的符号► 说明> 反应，结果[…] 按键、按钮或指示标记→ 交叉引用
重要说明 如不遵守，可能导致故障或干扰。信息 补充说明
1.2 使用的警告
注意 财产损失警告。
5
3D 摄像头
CN
1.3 开源信息本产品可能包含来自各个软件开发商的自由软件或开源软件，且需获得以下许可证：通用公共许可证第 1 版、第 2 版和第 3 版（通用公共许可证第 3 版结合 GNU 编译器套件运行时库例外 (GNU Compiler Collection Runtime Library Exception) 第 3.1 版）、次要通用公共许可证第 2.1 版、次要通用公共许可证第 3 版、伯克利软件发行许可证 (Berkeley Software Distribution)（“本产品包含加州大学伯克利分校及其贡献者开发的软件”）、学术免费许可证第 2.1 版。 就需获得相应版本一般公共许可证的组件而言，以下规则适用：本程序是自由软件：您可按照自由软件基金会 (Free Software Foundation) 发布的 GNU 通用公共许可证条款再次分发和/或加以修改。 如果第 1 版适用于软件：许可证第 1 版或任何之后的版本（由您选择）； 如果第 2 版（或第 2.1 版）适用于软件：许可证第 2 版（或第 2.1 版）或任何之后的版本（由您选择）； 如果第 3 版适用于软件：许可证第 3 版或任何之后的版本（由您选择）。 以下软件开发商免责声明适用于需获得相应版本通用公共许可证或次要通用公共许可证的软件组件：分发自由软件的目的是为了让其发挥作用，但不提供任何保修； 甚至没有对于特定用途适销性或适用性的暗示担保。 请参阅 GNU 通用公共许可证和 GNU 次要通用公共许可证，以了解详情。 就产品相关软件而言，ifm electronic gmbh 对于 IFM 产品的责任不受上述免责声明的影响。 请注意，在某些情况下，IFM 产品硬件免费提供。 之后，需针对相应的装置本身（硬件）支付 IFM 产品的价格，而不是固件。 如需了解您的产品许可证协议的最新消息，请访问 www.ifm.com关于根据任何版本 GNU 通用公共许可证 (GPL) 或 GNU LGPL 许可的二进制文件，您可向我们索取相应的完整 GPL 软件源代码，发送书面请求至以下地址即可：[email protected] 或 ifm electronic gmbh Friedrichstraße 1, 45128 Essen, Germany。 我们针对每次请求收取 €30。 请在付款备注栏写明“产品 Y 源代码”。 您的请求应包含 (i) 相关二进制文件的名称，(ii) IFM 产品的名称和版本号，(iii) 您的姓名，以及 (iv) 您的返回地址。 该优惠适用于收到该信息的任何人。 该优惠有效期至少三年（从您收到 GLP/LGPL 相关代码之日起）。
3D 摄像头
6
2. 安全说明 2.1 概要此类说明是装置不可或缺的一部分。 其中包含文字与图解，用于描述装置的正确操作方法，务请在安装或使用前阅读本说明。请遵守操作说明。 未遵守说明、未按以下规定的使用方法操作，安装不当或操作不正确可能会严重影响操作者和机器的安全。
2.2 目标群体此类说明适用于根据 EMC 和低电压指令的已获授权人员。 必须由具备资质的电工来安装和连接装置，以及将其投入使用。
2.3 电气连接操作装置前，请断开装置的外部连接。 仅可为连接插脚提供技术资料中以及装置标签上所示的信号，且仅可连接经认可的 IFM 附件。
2.4 擅自改装装置若发生故障或有相关疑问，请与制造商联系。 任何擅自改装装置的操作均可能严重影响操作员和机械的安全。 请勿擅自改装装置，我们拒绝因此引发的任何责任和保修索赔。
7
3D 摄像头
CN
3. 功能和特性O3D3xx 3D 摄像头是利用时间间隔原理，逐点测量摄像头与最近表面之间距离的光学摄像头。 O3D3xx 3D 摄像头通过内部红外光源来照亮场景，并通过从表面反射的光来计算距离。O3D3xx 3D 摄像头提供描述以三维方式拍摄的场景之数据。 此距离数据可通过以太网来输出并通过用户来评估。 O3D3xx 3D 摄像头的参数设定还可通过以太网来执行。O3D3xx 3D 摄像头可用于技术资料中指定的操作条件下。 就装置安全性而言，额定可用于以下操作条件：• 室内使用• 高达 2000 m 的高度• 最高达 90 % 的相对空气湿度，无冷凝• 3 级污染程度鉴于电磁干扰排放的要求，该装置适合用于工业环境。 该装置并非为用于居住区内而设计的。
该装置可用于技术资料中指定的操作条件下。
4. 所供配件 ● O3D3xx 3D 摄像头 ● 简要说明
我们的网站提供技术资料和其他文档 （软件手册等）： www.ifm.com
5. 附件摄像头的操作需要以下附件：
产品编号 说明
E11950 摄像头/传感器的供电电缆E11898 M12 工业以太网连接电缆
我们的网站上免费提供 ifm Vision Assistant 软件： www.ifm.com
3D 摄像头
8
6. 安装该章节描述安装前必须遵守的要求以及摄像头的安装方式。
②
①
③
④
⑤
① 摄像头
② 孔径角
③ 物体
④ 视场
⑤ 摄像头和物体之间的距离
6.1 选择安装位置遵守关于安装位置选择的以下说明：
► 物体 ③ 必须完全处于视场 ④ 内。 > 视场的大小取决于摄像头类型且技术资料有所讲述。 视场的大小还取决于摄像头与物体 ⑤ 的距离：距
离增大时，视场将变得更大。
► 定位物体时，请考虑公差。 ► 确定摄像头与物体 ⑤ 之间的距离时，请考虑摄像头的测量范围。 > 测量范围将在摄像头的技术资料中指示。
► 选择尽可能小的摄像头与物体 ⑤ 之间的距离。 > 如果距离尽可能小，则将以最大分辨率检测物体。
► 避免安装位置的任何强烈环境光和日光。 > 超过 8 klx（对应太阳光谱）的外来光强度将导致测量错误。 实际上，仅关系到 800 与 900 nm 之间的
红外组件。
► 避免安装于污染严重的环境中。 > 在污染严重的环境中，尽管方向朝下①，摄像头镜头仍会变脏。
► 避免摄像头 ① 与物体 ③ 之间有透明面板。 > 即使使用十分洁净的玻璃面板，透明面板也会反射部分光。
如果未遵守说明，则可能会发生测量错误。
9
3D 摄像头
CN
6.2 其他摄像头安装指南摄像头的表面温度取决于工作模式、参数选择和摄像头受到的环境热暴露情况。
确保摄像头符合以下要求： 对于易于触及的表面，其温度可以为比环境温度高最多 25 °C（按照 IEC 61010-2-201）。
下图包含可作为安装人员参考的一般警告限制。在以下工作模式下，该图表有效：
● 低 [1 曝光] ● 中等 [2 曝光] ● 高 [3 曝光]
在中等和高曝光情况下，必须通过曝光时间总和来确定一般警告限制。 曝光时间将在 ifm Vision Assistant 软件中指示。
如果超过警告限制，请遵循其中一项说明： ► 降低表面温度 (→ 6.2.3)。 ► 将摄像头安装于既可提供防热源保护，而又能在摄像头周围保持空气流通的位置或外壳中。 > 应避免摄像头表面温度的上升。
参数“最大背景距离”在 ifm Vision Assistant 中设定。 在图表中，参数的警告限制以虚线和实线显示。 如果摄像头位于其中一个带点区域，则必须降低表面温度(→ 6.2.3)。 尽管有散热装置，如果超过警告限制，仍可额外安装接触防护装置。
如果您在正常安装时，保持在一般警告限制以下，则无需采取措施。
6.2.1 O3D301 / O3D303 的一般警告限制
0
5
10
15
0 2 4 6 8 10
x
y
20
25
参数“最大背景距离”
安装于带有热导体的导热金属部件上 (→ 6.2.3)
警告限制 参数
< 5 m
< 30 m
> 30 m
正常安装
警告限制 参数
< 5 m
< 30 m
> 30 m
x = 曝光时间 [ms] y = 帧速率 [fps]
3D 摄像头
10
6.2.2 O3D311/O3D313 的一般警告限制
0
5
10
15
0 2 4 6 8 10
x
y
20
25
参数“最大背景距离”
安装于带有热导体的导热金属部件上 (→ 6.2.3)
警告限制 参数
< 5 m
< 30 m
> 30 m
正常安装
警告限制 参数
< 5 m
< 30 m
> 30 m
x = 曝光时间 [ms] y = 帧速率 [fps]
6.2.3 降低表面温度使用以下措施，可降低表面温度：
► 将摄像头安装于导热金属部件上。 > 摄像头与金属部件的较大表面接触可增加散热（例如，铝）。
► 将摄像头安装于金属部件上时，使用热导体。 > 导热效果通过热导体来增加。 热导体可作为附件提供(→ 6.4)。
► 减少摄像头周围的障碍物。 降低靠近摄像头的物体密度。 > 摄像头周围的障碍物以及较高的安装密度可能会对对流（空气流动）产生不良影响。
► 在摄像头上安装一个或两个散热器。 > 散热器可增大摄像头的表面，降低表面温度。 散热器可作为附件提供(→ 6.4)。
► 减少曝光时间、帧速率或最大背景距离。 > 使用的工作模式和参数可能会提高表面温度。
11
3D 摄像头
CN
6.3 安装摄像头安装摄像头时，遵守以下说明：
► 使用 2 个 M5 螺丝或安装组件来安装摄像头。 > M5 螺丝的孔眼尺寸将在技术资料中指示。
> 安装组件可作为附件提供(→ 6.4)。
► 为连接至摄像头的所有电缆使用应变释放装置。安装 O3D301 和 O3D311 时，遵守以下说明：
► 以可为对焦调整螺丝使用螺丝刀的方式安装摄像头。 > 比例图显示对焦调整螺丝的位置(→ 13)。
如果装置将永久用于潮湿区域，则 M12 工业以太网电缆（例如 E11898）的螺母可能会腐蚀。 使用带有高级不锈钢螺母的电缆以永久用于潮湿区域。
6.4 安装附件视安装位置和类型而定，您可使用以下安装附件：
产品编号 说明
E3D301 智能摄像头安装组件E3D302 智能摄像头冷却元件E3D303 智能摄像头热导体E3D304 2x 智能摄像头冷却元件
您可在以下位置找到有关附件的更多信息： www.ifm.com
3D 摄像头
12
7. 电气连接执行电气安装前，遵守以下说明。
注意 务必由具备资质的电工连接摄像头。 遵守技术资料中的电气数据要求。防护等级为 III (PC III) 的摄像头。电力供应仅可通过 PELV 电路来实现。电力供应必须符合 UL61010-1，第 9.4 节 - 限制能源的要求： 过电流保护装置必须能在 120 秒内关闭 6.6 A 的电流。 如需了解过电流保护装置的正确额定值，请考虑摄像头和配线的技术数据。外部电路的分离必须符合 UL61010-2-201，图 102 的 要求。对于电缆长度 > 30 m 的情况，请按照 IEC 6100-4-5 要求，使用额外的保护装置来防止浪涌电压。连接摄像头前，请切断电源。
有关 cULus 的有效范围：连接至现场接线端子的缆线的最低额定温度：70 °C。
7.1 配线
① 以太网M12 插座，编码为 D，4 针
����������������
�
� �
��
��� ��
��������
�
� �
�
�
1 TD + 2 RD + 3 TD - 4 RD - S 屏蔽
② 电源供应器M12 连接器，编码为 A，5 针
4
2 1
35
1 U+ 2 触发输入 3 GND 4 开关输出 1 - 准备就绪 5 开关输出 2 - 级联
用保护盖 (E73004) 覆盖未使用的以太网连接。拧紧扭矩 0.6...0.8 Nm。
开关输入和输出的运行状况可通过 ifm Vision Assistant 软件来设定。 设定 PNP 或 NPN 始终适用于所有开关输入和输出。安装执行器和传感器时，确保设定是正确的（例如，用于触发的光电传感器）。开关输出也可作为脉冲输出操作，它们会在可调时间后复位其开关信号。
13
3D 摄像头
CN
7.1.1 插脚 1/3 (24 V/GND)允许的电压范围将在摄像头的技术资料中指示。
7.1.2 插脚 2（触发输入）摄像头的图像拍摄可经由触发输入通过开关信号来触发。可使用以下触发边沿：
● 下降沿触发图像拍摄 ● 上升沿触发图像拍摄 ● 下降和上升沿好触发图像拍摄
触发摄像头的其他可能性： ● 处理接口命令 (→ 14.3) ● 使用固定帧速率的连续图像拍摄
在内部为触发输入去抖动。 视电气装置而定，不一定需要触发线的去抖动功能。 内部去抖动可防止多个短脉冲触发。 脉冲必须至少长达 2 ms，方可被视为触发。
7.1.3 插脚 4/5（就绪/级联）开关输出 1 和 2（就绪/级联）的电气数据将在技术资料中指示。开关输出默认提供以下摄像头状态设定：
● 开关输出 1：“触发准备就绪” ● 开关输出 2：“已完成图像拍摄”
“已开启开关输出”意味着已出现相应的摄像头状态。
视设定而定，摄像头状态可能拥有任一以下值： ● “触发准备就绪”
摄像头发出信号指示可拍摄新图像。 仅在此摄像头状态下，可处理触发操作。 对于连续图像拍摄，传感器状态“触发准备就绪”未输出。
● “已完成图像拍摄” 摄像头发出信号指示已完成图像拍摄。 摄像头状态可用于摄像头级联。
● “已完成评估” 摄像头发出信号指示已完成图像处理。 此时，已更新开关输出。 图像数据通过以太网传送。
● “错误” 摄像头发出信号指示内部错误。 可通过以太网请求提供有关错误的详细信息。
图像捕获
触发输入信号
时间 [ms]1 2 3 4 5 6 7 8 9 10 11
3D 摄像头
14
7.2 配线示例以下提供摄像头的配线示例。
7.2.1 使用接近传感器触发图像拍摄可在外部触发摄像头：
● 通过以太网 ● 通过连接至触发输入的接近传感器
下图显示使用接近传感器的摄像头配线方式。
3 1 2 4 5
1 2
34
4
2 1
35
DC 24 V+ -
IN IN
①
② ③
①：笔记本（参数设定）
②：接近传感器
③：工业电脑（评估/触发）
15
3D 摄像头
CN
7.2.2 彼此相邻地安装多个摄像头 彼此相邻地安装的摄像头可能会因同时曝光而导致测量错误。
① ②
③
① 摄像头
② 摄像头
③ 物体
可通过两种方式来避免测量错误： ● 级联摄像头通过硬件触发
级联期间，控制器触发第 1 个摄像头的图像拍摄。 完成图像拍摄后，第 1 个摄像头自动触发第 2 个摄像头。 第 2 个摄像头发出信号以向控制器指示序列末尾。
3 1 2 4 5
4
2 1
35
DC 24 V+ -
IN IN
3 1 2 4 5
①
①：工业 PC （评估/ 出发）
● 使用不同的频率通道 使用 ifm Vision Assistant 软件，可为每个摄像头指定其自己的频率通道。 不同的频率通道可减少测量错误的出现几率。
我们的网站上免费提供 ifm Vision Assistant 软件： www.ifm.com
3D 摄像头
16
8. 指示器通过 LED 指示器 1 - 4，摄像头可发出信号指示当前工作状态。
LED 4 LED 3LED 1 LED 2
LED 4 （以太网）
LED 1 （电源）
LED 2 （输出 1）
LED 3 （输出 2）
说明
亮起 摄像头工作准备就绪，已提供电源电压以 0.5 Hz 的频率闪烁
未设定任何参数或参数设定未加载至摄像头On
On
Off
Off
以 0.5 Hz 的频率闪烁 2 次
摄像头处于参数设定模式
On
On
Off
Off亮起 开关输出 1 已开启以 8 Hz 的频率闪烁
开关输出 1 短路
亮起 开关输出 2 已开启以 8 Hz 的频率闪烁
开关输出 2 短路
亮起 以太网已连接闪烁 以太网正在传送数据熄灭 以太网未连接
以 8 Hz 的频率闪烁
以 8 Hz 的频率闪烁
摄像头发出信号指示内部错误
以 2 Hz 的频率闪烁
以 2 Hz 的频率闪烁
摄像头发出信号指示可修正错误。 错误信息可通过以太网读取
运行灯 ⇒ 摄像头正在启动
运行灯 ⇒ 摄像头正在执行固件更新
17
3D 摄像头
CN
9. 设定通电后启用摄像头。 15 秒后，摄像头将处于评估模式，在此模式下将执行保存的应用程序。 指示器发出信号指示当前工作状态(→ 8)。
摄像头上可保持多达 32 个应用程序。 通常，应用程序包含以下参数： ● 图像拍摄：例如，图像拍摄的触发、曝光时间、图像处理滤波器 ● 接口：以太网，开关输出
相关应用程序可通过 ifm Vision Assistant 软件或处理接口命令来激活。
9.1 设定装置的参数可通过两种方式来设定装置参数：
● ifm Vision Assistant 软件（→ 请参阅软件手册） ● ifm3Dlib（第三方产品→ https://github.com/ifm/ifm3d）
ifm3Dlib 编程示例：(→ 10) ● ROS（第三方产品→ https://github.com/ifm/ifm3d-ros） ● XML-RPC 命令 (→ 14.6)
Ifm Vision Assistant 软件以及有关装置测量原理及其影响的详细信息将在软件手册中说明。我们的网站上提供软件手册： www.ifm.com
库 ifm3Dlib 和包装器 ROS 由 ifm electronic 编程。 根据 Apache 许可证第 2.0 版，两个数据包均可用于 Linux。
9.2 检测物体以下说明可促成较高物体检测率的条件。
③
②
④
②
①① 摄像头
② 影响区域
③ 视场
④ 物体
如果符合以下条件，则可达到物体 ④ 的最佳检测效果：
● 物体位于视场 ③
● 物体是最靠近摄像头 ① ● 影响区域 ② 中没有物体（障碍物等） ● 摄像头的镜头窗口无污染。
如果未符合条件，则可能会发生测量错误。
3D 摄像头
18
10. 编程示例在 Linux 下，建议使用 ifm3Dlib 访问装置。 该库已经过测试，是 C++ 的参考实现。ifm electronic 和公司 Lovepark Robotics 支持该库。 Apache-2 许可证不允许商业用途。
10.1 ifm3Dlib以下为如何利用 imf3Dlib 对装置进行寻址的 C++ 简例。
auto cam = ifm3d::Camera::MakeShared();auto fg = std::make_shared<ifm3d::FrameGrabber> ↲ (cam,(ifm3d::IMG_AMP|ifm3d::IMG_RDIS|ifm3d::IMG_CART));auto img = std::make_shared<ifm3d::ImageBuffer>();if (! fg->WaitForFrame(img.get(), 1000)){ std::cerr << "Timeout waiting for camera!"<< std::endl; return -1;}pcl::io::savePCDFileASCII("point_cloud.pcd", *(img->Cloud()));imwrite("amplitude.png", img->AmplitudeImage());imwrite("radial_distance.png", img->DistanceImage());
在示例中，装置传输数据集。 数据集中的幅度图像和径向距离保存为 PNG 文件。 笛卡尔坐标保存为 PCL 文件。
19
3D 摄像头
CN
11. 维护、修理及处理请遵守以下说明：
► 请勿打开装置，因为装置不含可由用户维护的任何组件。 仅可由制造商修理装置。 ► 按照国家环保法规处理设备。
11.1 清洁清洁摄像头前，遵守以下说明：
► 使用洁净的无绒布。 ► 使用玻璃清净剂作为清洁剂。
如果未遵守说明，则透镜上的刮痕可能会导致测量错误。
11.2 更新固件通过 ifm Vision Assistant 软件可更新摄像头的固件。
固件更新会使摄像头中保存的参数丢失。 更新固件前，创建参数的备份副本： ► 更新固件前，导出参数。 ► 更新固件后，导入参数。
我们的网站上提供固件更新： www.ifm.com
11.3 更换摄像头更换装置后，参数会丢失。 更换装置之前创建参数的备份副本：
► 更换之前先导出旧装置的参数。 ► 更换之后将参数导入新的装置。
通过参数的导出和导入，可为多个摄像头快速提供相同的参数。
12. 认证/标准EC 符合性声明可在以下位置找到： www.ifm.com
3D 摄像头
20
13. 比例图13.1 O3D303/O3D313
Original Scale Drawing (MTD)
EPS SourceProduct Scale DrawingFrame Size: 80 mm x 45 mm
P_MZ_200_0359
O3D302O3D303O3D312O3D313
33
3
5,7
M12
x140
14
9582,6
73,3
71,6
72
6532,5
21
33
2
M12x133
3
5,7
M12
x140
14
9582,6
73,3
71,6
72
6532,5
21
33
2
M12x1
①：透镜
②：照明设备
③：双色 LED（黄色/绿色）
13.2 O3D301/O3D311
Original Scale Drawing (MTD)
EPS SourceProduct Scale DrawingFrame Size: 80 mm x 45 mm
P_MZ_200_0362
O3D300O3D301O3D310O3D311
33
3
5,7
M12
x140
14
9582,6
73,3
71,6
49
17,1
28,7
4
M12x1
72
6532,5
2
21
33
67,1
33
3
5,7
M12
x140
14
9582,6
73,3
71,6
49
17,1
28,7
4
M12x1
72
6532,5
2
21
33
67,1
①：透镜
②：照明设备
③：双色 LED（黄色/绿色）
④：焦点设定器
21
3D 摄像头
CN
14. 附录14.1 需要的端口利用 XML-RPC 配置摄像头以及接收过程接口数据需要以下端口： 不得通过防火墙或路由器阻止该等端口。
● TCP/HTTP：80 ● TCP：50010
若使用 ifm Vision Assistant，则以下额外端口亦必须可用。 ● UDP：3321 ● TCP/HTTP：8080
可针对过程接口配置除 50010 之外的其他端口。 若使用其他端口，则亦不得阻止。
14.2 XML-RPC 接口如果 “ifmVisionAssistant” 无法配置 O3D3xx 摄像头，则可使用 XML-RPC 接口。
关于 XML-RPC 的一般信息位于网站：http://xmlrpc.scripting.com/spec
若要通过 XML-RPC 接口发送命令，则命令需特别布局。 在该命令中，换行和回车至关重要。
通过 XML-RPC 接口传送的每个命令必须以回车<CR>和换行<LF>结束。
多个命令将在 XML-RPC 标头中使用不同的 URL。
14.2.1 XML-RPC 命令样本所有以下 XML-RPC 命令将具有此类布局：POST /RPC3 HTTP/1.0<CR><LF>用户代理：Frontier/5.1.2 (WinNT)<CR><LF>主机：betty.userland.com<CR><LF>内容类型：text/xml<CR><LF>内容长度：181<CR><LF><CR><LF><?xml version="1.0"?><CR><LF><methodCall><CR><LF><methodName>examples.getStateName</methodName><CR><LF><params><CR><LF><param><CR><LF><value><i4>41</i4></value><CR><LF></param><CR><LF></params><CR><LF></methodCall><CR><LF>
3D 摄像头
22
以下示例包含一个 O3D3xx 命令。POST /api/rpc/v1/com.ifm.efector/ HTTP/1.1 <CR><LF>用户代理：Frontier/5.1.2 (WinNT)<CR><LF>主机：192.168.0.69<CR><LF>内容类型：text/xml<CR><LF>内容长度：94<CR><LF><CR><LF><?xml version="1.0"?><CR><LF><methodCall><CR><LF><methodName>getParameter</methodName><CR><LF></methodCall><CR><LF>
14.2.2 XML-RPC 对象若要通讯并通过 XML-RPC 配置装置，则 XML-RPC 命令需使用不同的 XML-RPC 对象。 不同命令需不同的 XML-RPC 对象（请参阅 XML-RPC 命令参考）。O3D3xx 接口按照面向对象的方式构成。 有些对象始终可用，而其他对象则仅在将装置设为特殊模式（针对已可用对象调用方法）后可用。 该机制用于创建系统要求（例如密码保护）。
有必要发送检测信号，以避免出现会话超时。
下图可供大致了解对象如何彼此相关联，以及应调用哪些方法以让其他对象可用。
Main API
Session
EditMode
ApplicationConfig
requestSession(...)
setOperatingMode(1)
editApplication(1) DeviceConfig
NetworkConfig
ImagerConfig
23
3D 摄像头
CN
主对象对象 URI：/api/rpc/v1/com.ifm.efector/这是 RPC 的主对象。 它包含打开会话的方法。 会话包含启用编辑模式的方法。 其大部分方法仅为 Getter，因为应当可通过密码保护编辑。
会话对象对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/URL 部分 “d21c80db5bc1069932fbb9a3bd841d0b” 为会话 ID。 它可通过主对象的命令 “requestSession” 返回。 如果在没有用户定义会话 ID 的情况下调用 “requestSession”命令（可作为参数传递），则自动生成随机会话 ID。
EditMode 对象对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/该对象仅在装置处于编辑工作模式下可用。 应用程序索引必须在 1 和 32 之间。 装置必须仅支持 32 个应用程序，索引必须从 1 开始。
DeviceConfig 对象对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/
Device/NetworkConfig Object对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/network/
应用程序配置对象（可编辑应用程序）对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/
Main API
Session
EditMode
ApplicationConfig
cancelSession(...) removes itself from RPC. Session will also be removed, if heartbeat(...) is not called at the right time
setOperatingMode(0) will remove EditMode from RPC
stopEditApplication() will remove ApplicationConfig from RPC
3D 摄像头
24
Application/Imager Config Object (O3D3xx)对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/imager_001/因为 O3D3xx 上仅有一个成像器配置，ID 需固定设为 “001”。 针对应用程序配置对象调用“保存”时，将持续保存该对象的数据。 成像器配置 RPC 对象有多个子类型。 与特定类型相关参数仅在其启用时可用。 它们以频率（扩大距离）和集成间隔（扩大测量详情）为基础。基于 GUI 草案的类型名称（短于 5 米 -> 单频率，长达 30 米 -> 双频率，长于 30 米 -> 三频率。）：under5m_lowunder5m_moderateunder5m_highupto30m_lowupto30m_moderateupto30m_highmorethan30m_lowmorethan30m_moderate
图像设置和滤波器参数在每个成像器配置中，有针对空间滤波器参数的 RPC 对象。对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/imager_001/spatialfilter在每个成像器配置中，有针对暂时滤波器参数的 RPC 对象。对象 URI 示例：/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/imager_001/temporalfilter针对应用程序配置对象调用“保存”时，将持续保存该等对象的数据。
25
3D 摄像头
CN
14.3 过程接口过程接口用于在正常工作模式期间从 O3D3xx 获取运行数据（如 3D 图像、过程值）。
14.3.1 发送命令如需通过过程接口发送命令，则需按照特殊协议作为 ASCII 字符串发送命令。 该协议遵照 O2V/O2D 产品第 3 版。协议的结构：<Ticket><length>CR LF <Ticket><content>CR LF
缩略语 说明 ASCII 代码（十进制） ASCII 代码（十六进制）
CR 回车 13 DLF 换行 10 A< > 占位符标记（例如：<code> 为代码的占位符）[ ] 可选参数（可能但非必要）
命令 说明
<content> 它是装置的命令（如触发设备）。<ticket> 它是 0-9 之间的 4 位字符串。 如果向装置发送具有特定票据的消息，则回应将包含相同票
据。 票据编号必须 > 0999。使用范围在 1000 - 9999 之间的票据。<length> 它是以字母 “L” 开头，后跟 9 位数的字符串。 它以字节表示下列数据
(<ticket><contents>CR LF) 的长度。
它们是不同的可用协议版本。
版本 输入格式 输出格式
V1 <Content>CR LF 作为输入V2 <Ticket><Content>CR LF 作为输入V3 <Ticket><Length>CR LF<Ticket><Content>CR LF 作为输入V4 <Content>CR LF <length>CR LF<Content>CR LF
默认协议版本为 “V3”。 建议针对机器使用第 3 版协议以便机器通信。 这是因为仅第 3 版支持异步消息并提供长度信息。
异步消息的票据编号：
票据编号 说明
0000 异步结果0001 异步错误消息/代码0010 异步通知/消息代码
3D 摄像头
26
14.3.2 接收图像若要接收图像数据，则需建立 TCP/IP 插口通信。 默认端口号为 50010。 端口号可能会不同，具体视配置而定。 打开插口通信后，O3D3XX 装置将通过该插口自动（如果装置处于自由运行模式）将数据发送至 TCP/IP 客户端 (PC)。PCIC 输出/每帧。 以下数据按该顺序提交：
组件 内容
票据和长度信息 (→ 14.4.14)票据 „0000“开始序列 字符串 “star”（4 字节）正常化幅度图像输出格式：16 位无符号整数
1 图像
距离图像输出格式：16 位整数。 单位：mm。
1 图像
X 图像输出格式：16 位带符号整数。 单位：mm。
1 图像
Y 图像输出格式：16 位带符号整数。 单位：mm。
1 图像
Z 图像输出格式：16 位带符号整数。 单位：mm。
1 图像
置信度图像输出格式：8 位无符号整数
1 图像
诊断数据停止序列 字符串 “stop”（4 字节）票据签名 <CR><LF>
14.3.3 图像数据就每个图形而言，将有一个单独的数据块。 数据块是过程接口响应帧数据的一部分。每个数据块的标头均包含不同类型的数据。 该信息拆分为字节。 信息包含图像类型（将为“PIXEL_DATA”）以及数据块的大小等。
偏移 名称 说明 大小 [byte]
0x0000 CHUNK_TYPE 定义数据块的类型。 就每个不同的数据块而言，定义其自身的类型。
4
0x0004 CHUNK_SIZE 整个图像数据块的大小（以字节为单位）。 该等字节结束后，下一个数据块开始。
4
0x0008 HEADER_SIZE 从 0x0000 到 PIXEL_DATA 的字节数。 40x000C HEADER_VERSION 标头版本号 40x0010 IMAGE_WIDTH 图像宽度（以像素为单位） 40x0014 IMAGE_HEIGTH 图像高度（以像素为单位） 40x0018 PIXEL_FORMAT 像素格式 40x001C TIME_STAMP 时间戳（以 ms 为单位）（已弃用） 40x0020 FRAME_COUNT 帧计数 40x0024 STATUS_CODE 装置的错误 40x0028 TIME_STAMP_SEC 时间戳（以 s 为单位） 40x002C TIME_STAMP_NSEC 时间戳（以 ns 为单位） 40x0030 PIXEL_DATA 给定图像类型和尺寸的像素数据。 填充至 4 字节边界。 4
27
3D 摄像头
CN
可用数据块类型：
常数 值 说明
RADIAL_DISTANCE_IMAGE
100 距离矩阵的每个像素指的是成像器相应像素或像素组测量的 ToF 距离。 该距离值通过摄像头校准纠正，但不包括多路径和多对象因素造成的影响（例如“飞行像素”）。 参考点是摄像头外壳内的摄像头光学中心。 无效的 PMD 像素（例如因为饱和）的值为零。数据类型：16 位无符号整数 (Little Endian)单位：mm
NORM_AMPLITUDE_IMAGE
101 正常化幅度图像的每个像素指的是正常化为曝光时间的原始幅度（请参阅下方幅度图像以了解进一步解释）。 另外，将补偿渐晕效应，即图像边界的像素暗化将予以修正。 该灰阶图像的视觉效果相当于普通 2D 摄像头的效果。无效的 PMD 像素（例如因为饱和）的幅度值为 0。数据类型：16 位无符号整数
AMPLITUDE_IMAGE 103 幅度矩阵的每个像素指的是相应物体反射的调制光数量（即摄像头有效照明设备的光）。 更高的值表示更高的 PMD 信号强度，因此也意味着相应距离测量更低的噪声量。 幅度值直接来源于未正常化为曝光时间的 PMD 相位测量值。 在多曝光模式中，如果从短曝光时间采用特定的像素而未采用其邻近的部分，则没有进行正常化会导致迥异的幅度图像效果（取决于所选的曝光时间）。无效的 PMD 像素（例如因为饱和）的幅度值为 0。数据类型：16 位无符号整数
GRAYSCALE_IMAGE 104 幅度矩阵的每个像素指的是相应物体反射的调制光数量（即摄像头有效照明设备的光）。 更高的值表示更高的 PMD 信号强度，因此也意味着相应距离测量更低的噪声量。 幅度值直接来源于未正常化为曝光时间的 PMD 相位测量值。
CARTESIAN_X_COMPONENT
200 X 矩阵指的是 PMD 3D 测量笛卡尔坐标的 X 组件。 如果外部参数均设为 0，则摄像头坐标系统的原点位于镜头前玻璃中间。数据类型：16 位带符号整数单位：mm
CARTESIAN_Y_COMPONENT
201 Y 矩阵指的是 PMD 3D 测量笛卡尔坐标的 Y 组件。 如果外部参数均设为 0，则摄像头坐标系统的原点位于镜头前玻璃中间。数据类型：16 位带符号整数单位：mm
CARTESIAN_Z_COMPONENT
202 Z 矩阵指的是 PMD 3D 测量笛卡尔坐标的 Z 组件。 如果外部参数均设为 0，则摄像头坐标系统的原点位于镜头前玻璃中间。数据类型：16 位带符号整数单位：mm
CARTESIAN_ALL 203 CARTESIAN_X_COMPONENT、 CARTESIAN_Y_COMPONENT、 CARTESIAN_Z_COMPONENT
UNIT_VECTOR_ALL 223 单位矢量矩阵包含每个 PMD 像素的 3 个值 [ex、ey、ez]，即数据布局为 [ex_1,ey_1,ez_1, ... ex_N, ey_N, ez_N]，其中 N 为 PMD 像素数。 数据类型：32 位浮点编号（3x/每像素）
CONFIDENCE_IMAGE 300 请参阅图像数据的额外信息(→ 14.3.4)DIAGNOSTIC 302 请参阅接收图像 (→ 14.3.2)
3D 摄像头
28
常数 值 说明
JSON_DIAGNOSTIC 305 包含 JSON 格式诊断数据的项目的格式为：{
"AcquisitionDuration":20.391,
"EvaluationDuration":37.728,
"FrameDuration":37.728,
"FrameRate":15.202,
"TemperatureIllu":52.9
}
持续时间单位：mm帧速单位：Hz温度单位：°C
EXTRINSIC_CALIB 400 从一个笛卡尔坐标系统到另一个笛卡尔坐标系统的转换由 6 自由度 (DOF) 矢量定义。[trans_x、trans_y、trans_z、rot_x、rot_y、rot_z]。 设 R 为常见“顺时针”3D 旋转矩阵的结果：R = Rx*Ry*RzP_t = R*P + [trans_x, trans_y, trans_z]’ 可得出点 P 的转换。用户可设置装置外部校准，但装置的自动校准功能可更改。数据类型：32 位浮点编号 (Little Endian)Trans_x、trans_y、trans_z 的单位：mmRot_x、rot_y、rot_z 的单位：°
JSON_MODEL 500 JSON 模型数据MODEL_ROIMASK 501 针对内部调试目的的 ROI 掩码SNAPSHOT_IMAGE 600 截屏图像
像素格式：
常数 值 说明
FORMAT_8U 0 8 位无符号整数FORMAT_8S 1 8 位带符号整数FORMAT_16U 2 16 位无符号整数FORMAT_16S 3 16 位带符号整数FORMAT_32U 4 32 位无符号整数FORMAT_32S 5 32 位带符号整数FORMAT_32F 6 32 位浮点编号FORMAT_64U 7 64 位无符号整数FORMAT_64F 8 64 位浮点编号已保留 9FORMAT_32F_3 10 包含 3x32 位浮点编号的矢量
29
3D 摄像头
CN
14.3.4 CONFIDENCE_IMAGE 的其他信息置信度图像的其他信息：
位 值 说明
0 1 = 像素无效 像素无效像素是无效。 若要确定像素是否有效，仅需核实此位。 此位无效的原因记录在其他置信度位中。
1 1 = 像素饱和 像素饱和了影响像素有效性：是
2 1 = 糟糕的 A-B 对称性 A-B 像素对称性四相测量值的 A-B 对称值高于阈值。备注：该对称值用于检测运动假象。 噪声（如因为强烈的背景光线或非常短的集成时间）或 PMD 干扰也可能会影响。影响像素有效性：是
3 1 = 最小幅度阈值以下的幅度
幅度限值幅度值低于最小幅度阈值。影响像素有效性：是
4+5 第 5 位、第 4 位0 0 = 未使用0 1 = 最短曝光时间（仅用于三曝光模式）1 0 = 三曝光模式中的中等曝光时间、双曝光模式中的短曝光1 1 = 最长曝光时间（单曝光模式中始终为 1）
曝光时间指示器这两位表示在多曝光测量中使用哪个曝光时间。影响像素有效性：否
6 1 = 像素已剪辑 3D 数据剪辑盒如果剪辑有效，则此位表示像素坐标在定义值的范围之外。影响像素有效性：是
7 1 = 可疑/有缺陷像素 可疑像素该像素已标记为“可疑”或“有缺陷”，且值已替换为环境的内插值。影响像素有效性：否
3D 摄像头
30
14.3.5 PCIC 输出的配置用户可定义自身的 PCIC 输出。 该配置仅适用于当前的 PCIC 连接。 它不会影响任何其他连接，且在断开连接后会丢失。若要配置 PCIC 输出，则使用“灵活”布局工具概念（通过 JSON 字符串表示。 默认配置的格式如下：{
"layouter":"flexible",
"format":{ "dataencoding":"ascii" },
"elements":[
{ "type":"string", "value":"star", "id":"start_string" },
{ "type":"blob", "id":"normalized_amplitude_image" },
{ "type":"blob", "id":"x_image" },
{ "type":"blob", "id":"y_image" },
{ "type":"blob", "id":"z_image" },
{ "type":"blob", "id":"confidence_image" },
{ "type":"blob", "id":"diagnostic_data" },
{ "type":"string", "value":"stop", "id":"end_string" }
]
}
该字符串可通过 C? 命令检索，并使用 c 命令修改和发回。布局软件有以下主对象属性：
名称 说明 详细信息
布局工具 定义基本数据输出格式。 目前为止，仅支持“灵活”
类型：字符串
格式 定义格式详细信息，对于以下任何数据元素而言，主对象中的定义为默认（例如，如果显示 dataencoding=binary，则所有数据元素应为二进制编码，而非 ASCII）。
类型：对象
元素 必须写入的数据元素列表。 类型：对象数组
实际数据在“元素”属性内定义，且包含以下设置：
名称 说明 详细信息
类型 定义必须写入的数据类型。数据可按不同类型存储（如可存储为整数，但应输出为 Float32）类型“记录”需要一些特殊处理。
类型：字符串
ID 定义该数据元素的 ID。如果没有固定值（属性“值”），应通过 ID 检索数据。
类型：字符串
值 定义固定输出值的可选属性。 类型：任何 JSON 值格式 微调输出格式的类型依赖型选项。
例如，将整数缩减为 4 字节以内。类型：对象
31
3D 摄像头
CN
类型属性的可用值：
类型 说明
记录 定义该元素代表一些记录。如果类型设为“记录”，则必须有“元素”属性。“元素”属性定义每次记录应写入哪些数据。
字符串 数据写入为字符串。大多数情况下，它将跟“值”属性一起使用，以写入固定开始、结束或分隔符文本。若格式属性没有任何其他说明，则文本编码应为 UTF8。
float32 数据写入为浮点编号。它有很多格式选项（至少通过“灵活”布局软件）请参阅后续章节，了解格式属性。
uint32 数据写入为整数。它有很多格式选项（至少通过“灵活”布局软件）请参阅后续章节，了解格式属性。
int32 数据写入为整数。它有很多格式选项（至少通过“灵活”布局软件）请参阅后续章节，了解格式属性。
uint16 在二进制编码中将输出限制在 2 个字节，除了二进制限制之外，其作用跟 uint32 相同。int16 在二进制编码中将输出限制在 2 个字节，除了二进制限制之外，其作用跟 int32 相同。uint8 在二进制编码中将输出限制在 1 个字节，除了二进制限制之外，其作用跟 uint32 相同。int8 在二进制编码中将输出限制在 1 个字节，除了二进制限制之外，其作用跟 int32 相同。blob 数据写入为 BLOB（按字节，跟来自数据提供商一样）
（二进制大对象）
根据所需的数据格式，用户可通过进一步的“格式”属性调整期输出数据。
常见格式属性：
格式属性 允许值 默认
数据编码 “Ascii” 或 “binary” 可按照顶级对象定义，并由元素对象覆盖。 “ascii"标定 “包含十进制分隔符的浮动值”，标定输出字节宽度的结果 1.0偏移 “包含十进制分隔符的浮动值” 0.0
二进制格式属性：
格式属性 允许值 默认
顺序 小、大和网络 小
3D 摄像头
32
ASCII 格式属性：
格式属性 允许值 默认
宽度 输出宽度。 如果结果值超过宽度字段，则结果将不会缩短。 0填充 填充字符 " "精度 精度为十进制分隔符之后的位数。 6显示格式 固定，科学 固定调整 左，右 右侧十进制分隔符 “.” 等的 7 位字符 "."基础 定义输出应为：
● 二进制 (2) ● 八进制 (8) ● 十进制 (10) ● 十六进制 (16)
10
温度 (id: temp_illu) 元素格式配置示例。1. 格式类似于 “33,5___” 的照明设备温度：c000000226{ "layouter":"flexible", "format":{ "dataencoding":"ascii" }, "elements":[ { "type":"float32", "id":"temp_illu", "format":{ "width":7, "precision":1, "fill":"_", "alignment":"left", "decimalseparator":"," } } ] }
2. 二进制照明设备温度（16 位整数，1/10 °C）：c000000194{ "layouter":"flexible", "format":{ "dataencoding":"ascii" }, "elements":[ { "type":"int16", "id":"temp_illu", "format":{ "dataencoding":"binary", "order":"network", "scale":10 } } ] }
3. 以 °F 为单位的照明设备温度（例如 “92.3 Fahrenheit”）：c000000227{ "layouter":"flexible", "format":{ "dataencoding":"ascii" }, "elements":[ { "type":"float32", "id":"temp_illu", "format":{ "precision":1, "scale":1.8, "offset":32 } }, { "type":“string", "value":“ Fahrenheit" } ] }
33
3D 摄像头
CN
以下元素 ID 可用：
ID 说明 原生数据类型
activeapp_id 有效应用程序，显示 32 个应用程序配置中有哪些配置当前有效
32 位无符号整数
all_cartesian_vector_matrices
所有笛卡尔 (X+Y+Z) 并置到一个数据包 16 位带符号整数
all_unit_vector_matrices 单位矢量矩阵。 每个元素均包含 3 分量矢量 [e_x, e_y, e_z]
Float32
amplitude_image PMD 原始幅度图像 16 位无符号整数confidence_image 置信度图像 8 位无符号整数distance_image 径向距离图像 16 位无符号整数
单位：mmevaltime 当前帧的评估时间，以 mm 为单位 32 位无符号整数extrinsic_calibration 外部校准，包含 3 个转化参数（单位：mm）和 3 个角度
（单位：°）：[t_x、t_y、t_z、alpha_x、alpha_y、alpha_z]
Float32
framerate 当前帧速，以 Hz 为单位 Float32normalized_amplitude_image
正常化幅度图像 16 位无符号整数
temp_front1 无效温度，输出为 3276.7 Float32，单位：°C
temp_illu 捕捉该结果时装置测量的温度照明板上测量
Float32，单位：°C
x_image y_image z_image
每个像素的笛卡尔坐标 每个尺寸均是单独的图像
16 位带符号整数
3D 摄像头
34
就具有统计功能的装置的主对象而言，以下 ID 可用：
ID 说明 原生数据类型
statistics_overall_count 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.number_of_frames
uint32
statistics_passed_count 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.number_of_passed_frames
uint32
statistics_failed_count 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.number_of_failed_frames
uint32
statistics_aborted_count 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.number_of_aborted_frames
uint32
statistics_acquisition_time_min 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_acquisition.min
float32
statistics_acquisition_time_mean 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_acquisition.mean
float32
statistics_acquisition_time_max 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_acquisition.max
float32
statistics_evaluation_time_min 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_evaluation.min
float32
statistics_evaluation_time_mean 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_evaluation.mean
float32
statistics_evaluation_time_max 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_evaluation.max
float32
statistics_frame_duration_min 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_duration.min
float32
statistics_frame_duration_mean 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_duration.mean
float32
statistics_frame_duration_max 允许用户利用帧的结果输出统计值，映射到 ModelResults：adv_statistics.frame_duration.max
float32
35
3D 摄像头
CN
14.4 过程接口命令参考
因为以下命令而发送的所有已接收消息在发送时，字符串的开始或结尾均不含 “start”/”stop”。
14.4.1 命令（启用应用程序）
命令 <application number>
说明 启用所选应用程序类型 操作回应 *
! ● 应用程序不可用 ● <application number> 包含错
误值 ● 外部应用程序开关已启用 ● 就该命令而言，装置处于无效
状态，如配置模式? 无效的命令长度
备注 <application number>应用程序编号为 2 位，以十进制值表示
14.4.2 A? 命令（应用程序列表占用）
命令 A?
说明 请求应用程序列表占用类型 请求回应 <amount><t><number active
application><t>...<number><t><number>? 无效的命令长度! 无效的状态（如没有启用的应用
程序）备注 <amount>
3 位字符串，针对保存在装置上的应用程序的数量，以十进制数表示。<t>制表符 (0x09)<number active application>启用的应用程序为 2 位<number>应用程序编号为 2 位
启用的应用程序在应用程序列表内重复。
3D 摄像头
36
14.4.3 c 命令（上传 PCIC 输出配置）
命令 c<length><configuration>
说明 上传 PCIC 输出配置，继续该会话
类型 操作回应 *
! ● 配置错误 ● 错误的数据长度
? 无效的命令长度备注 <length>
9 位数据长度，以十进制值表示<configuration>配置数据
14.4.4 C? 命令（检索当前 PCIC 配置）
命令 C?
说明 检索当前 PCIC 配置类型 请求回应 <length><configuration>
? 无效的命令长度备注 <length>
9 位数据长度，以十进制值表示<configuration>配置数据
14.4.5 E? 命令（请求当前错误状态）
命令 E?
说明 请求当前错误状态类型 请求回应 <code>
! 无效的状态（如配置模式）? 无效的命令长度
备注 ● <Code> 8 8 位错误代码，以十进制值表示。 它包含前导零。
37
3D 摄像头
CN
14.4.6 G? 命令（请求装置信息）
命令 G?
说明 请求装置信息类型 请求回应 <vendor><t><article number><t>
<name><t><location><t><description><t><ip><subnet mask><t><gateway><t><MAC><t><DHCP><t><port number>
备注 ● <vendor> IFM ELECTRONIC
● <t> 制表符 (0x09)
● <article number> 例如 O3D300
● <name> UTF8 Unicode 字符串
● <location> UTF8 Unicode 字符串
● <description> UTF8 Unicode 字符串
● <Ip> 装置 IP 地址，以 ASCII 字符串表示 例如 192.168.0.96
● <port number> XML-RPC 端口号
● <subnet mask> 装置子网掩码，以 ASCII 表示 例如 192.168.0.96
● <gateway> 装置网关，以 ASCII 表示 例如 192.168.0.96
● <MAC> 装置 MAC 地址，以 ASCII 表示 例如 AA:AA:AA:AA:AA:AA
● <DHCP> ASCII 字符串 “0”为关闭，”1”为开启
3D 摄像头
38
14.4.7 H? 命令（返回可用命令列表）
命令 H?
说明 返回可用命令列表类型 请求回应 H? - 显示该列表
t - 执行“触发”T? - 执行触发并等待数据o<io-id><io-state> - 设置 IO 状态O<io-id>? - 获取 IO 状态 I<image-id>? - 获取已定义类型的上一张图像 A? - 获取应用程序列表p<state> - 启用/禁用数据输出a<application number> - 设置启用的应用程序E? - 获取上一个错误V? - 获取当前协议版本v<version> - 设置协议版本c<length of configuration file><configuration file> - 配置过程日期格式C? - 显示当前配置G? - 显示装置信息S? - 显示统计数据L? - 检索连接 IDf<id><reserved><value> - 设置参数值
39
3D 摄像头
CN
14.4.8 I? 命令（请求上一张拍摄的图像）
命令 I<image-ID>?
说明 请求上一张拍摄的图像类型 请求回应 <length><image data>
! ● 无可用图像 ● 错误 ID
? ● 无效的命令长度备注 <image-ID>
图像类型为 2 位<length>9 位字符串，针对图像数据大小（以比特为单位），以十进制数表示<image data>图像数据
有效图像 ID：01 - 幅度图像02 - 正常化幅度图像03 - 距离图像04 - X 图像（距离信息） 05 - Y 图像（距离信息） 06 - Z 图像（距离信息） 07 - 置信度图像（状态信息）08 - 外部校准09 - unit_vector_matrix_ex、ey、ez 10 - 上一次结果输出，针对该连接规定格式11 - 所有距离图像：X、Y 和 Z
14.4.9 o 命令（设置 ID 的逻辑状态）
命令 o<IO-ID><IO-state>
说明 设置特定 ID 的逻辑状态类型 操作回应 *
! 无效的状态（如配置模式）? 无效的命令长度
备注 ● <IO-ID> 数字输出为 2 位：“01” 表示 IO1 ”02” 表示 IO2 ”03” 表示 IO3
● <Io-state> 状态为 1 位：“0” 表示逻辑状态低 ”1” 表示逻辑状态高
3D 摄像头
40
14.4.10 O? 命令（请求 ID 的状态）
命令 O<IO-ID>?
说明 设置特定 ID 的状态类型 请求回应 <IO-ID><IO-state>
! ● 无效的状态（如配置模式） ● 错误 ID
? 无效的命令长度备注 ● <IO-ID>
数字输出为 2 位：“01” 表示 IO1 ”02” 表示 IO2 ”03” 表示 IO3
● <Io-state> 状态为 1 位：“0” 表示逻辑状态低 ”1” 表示逻辑状态高
摄像头支持 ID 1 和 ID 2。传感器支持 ID 1、ID 2 和 ID 3。
14.4.11 p 命令（开启或关闭 PCIC 输出）
命令 p<state>
说明 开启或关闭 PCIC 输出类型 操作回应 *
! <state> 包含错误值? 无效的命令长度
备注 <state> 1 位0：禁用所有异步输出1：启用异步结果输出2：启用异步错误输出3：启用异步错误和数据输出4：启用异步通知5：启用异步通知和异步结果6：启用异步通知和异步错误输出7：启用所有输出
装置重启后，在应用程序内配置的值对数据输出而言至关重要。该命令可在任何装置状态下执行。默认情况下，装置将不会提供错误代码。
41
3D 摄像头
CN
14.4.12 S? 命令（请求当前解码状态）
命令 S?
说明 请求当前解码状态类型 请求回应 <number of
results><t><number of positive decodings><t><number of false decodings>! 无应用程序启用
备注 <t>制表符 (0x09)<number of results>自应用程序启动起拍摄的图像。 10 位十进制值，含前导 0s<number of positive decodings>导致正面结果的解码数。 10 位十进制值，含前导 0s<number of false decodings> 导致负面结果的解码数。 10 位十进制值，含前导 0s
14.4.13 t 命令（执行异步触发）
命令 t
说明 执行“触发”。 结果数据异步发送类型 操作回应 * 触发已执行，装置捕捉图像并评
估结果。! ● 装置忙于评估
● 就该命令而言，装置处于无效状态，如配置模式
● 装置设为不同的触发源 ● 无启用的应用程序
3D 摄像头
42
14.4.14 T? 命令（执行同步触发）
命令 T?
说明 执行“触发”。 结果数据同步发送类型 请求回应 配置布局内的过程数据 触发已执行，装置捕捉图像，评
估结果并发送过程数据。! ● 装置忙于评估
● 就该命令而言，装置处于无效状态，如配置模式
● 装置设为不同的触发源 ● 无启用的应用程序
14.4.15 v 命令（设置当前协议版本）
命令 v<version>
说明 设置当前协议版本。 装置配置不受影响
类型 操作回应 *
! 无效的版本? 无效的命令长度
备注 <version>协议版本为 2 位
(→ 14.3.1)
默认协议版本为 “V3”。
14.4.16 V? 命令（请求当前协议版本）
命令 V?
说明 请求当前协议版本类型 请求回应 <current version><empty><min
version><empty><max version>备注 <current version>
当前设置的版本为 2 位<empty>空格符号：0x20<min/max version>可设置的最低和最高版本为 2 位
43
3D 摄像头
CN
14.5 错误代码默认情况下，装置将不会提供错误代码。 P 命令可启用该操作 (→ 14.4.11)。
错误代码 ID 说明
100000001 超过了最大连接数量 110001001 启动超时110001002 致命软件错误110001003 未知的硬件110001006 触发溢出110002000 触发准备就绪短路110002001 OUT1 短路110002002 OUT2 短路110002003 反向输送110003000 Vled 过电压110003001 Vled 电压过低110003002 Vmod 过电压110003003 Vmod 电压过低110003004 主板过电压110003005 主板电压过低110003006 电源过电压110003007 电源电压过低110003008 VFEMon 警报110003009 PMIC 供给警报110004000 照明设备温度过高
3D 摄像头
44
14.6 XML-RPC 命令参考
14.6.1 参数 API参数 setParameter、getParameter、getAllParameters 和 getAllParameterLimits 在以下 RPC 对象中实现：
● 装置 ● 网络 ● 应用程序 ● ImagerConfig ● 筛选器 ● 型号
setParameter
方法名称 setParameter
说明 将参数设为特定值输入参数 1. 参数名称：字符串
2. 新值：字符串输出参数 空字符串（兼容经典 XmlRPC 客户端）
getParameter
方法名称 getParameter
说明 返回参数的当前值输入参数 参数名称：字符串输出参数 参数值：字符串
getAllParameters
方法名称 getAllParameters
说明 返回一个数据结构中的对象的所有参数输入参数 无输出参数 1. 结构（名称包含参数名称，值包含进行了字符串处理的参数值）
getAllParameterLimits
方法名称 getAllParameterLimits
说明 返回在装置上定义了限值的所有数值参数的限值。输入参数 无输出参数 1. 结构中的结构（第二个结构中的名称为参数名称，子结构包含 min
:string、max :string）例如：{"ExposureTime1":{ "min":"123", "max":"432" }, "ExposureTime2":{ "min":"123", "max":"432" }}
45
3D 摄像头
CN
参数字符串编码非字符串参数必须按照以下格式进行编码。
类型 字符串处理
BOOL "true" / "false"setParameter 方法还接受 “1”/”0”，Getter 方法必须始终返回 "true"/"false"
int 十进制（例如 “-1234” / “1234”）值必须在 int32 范围内 (-2^31 .. 2^31)
double 英文浮点表示法（通过指数可选）例如： “1.2”、”.3”、”4.5e6”、”-7E-8”、”-inf”、"nan"
结构化类型（数组或结构）无法通过一般方式放入参数存储中。 特定参数必须指定数组编码。
14.6.2 主对象
getParameter
方法名称 getParameter
说明 装置全局参数 Getter输入参数 装置参数名称：字符串输出参数 请求的参数的值：字符串
getAllParameters
方法名称 getAllParameters
说明 此处所述参数的 Getter。 这是编辑会话范围之外的额外 Getter，因此可在未登录的情况下读取装置信息。
输入参数 无输出参数 结构（名称包含参数名称，值包含进行了字符串处理的参数值）
3D 摄像头
46
getSWVersion
方法名称 getSWVersion
说明 返回所有软件组件的版本信息输入参数 无输出参数 字符串结构（例如 { “IFM_Software”：“0.01.07",
"Frontend":“01.05.02", ... } )*强制性密钥：“IFM_Software"“Linux"“Main_Application"“Diagnostic_Controller"“Algorithm_Version"“Calibration_Version"“Calibration_Device"
getHWInfo
方法名称 getHWInfo
说明 返回所有组件的硬件信息输入参数 无输出参数 字符串结构（例如 { “MACAddress”:“00:02:01:40:06:C9",
"Frontend":“#!01_F340_001_...", ... } )*强制性密钥：“MACAddress"“Connector"“Diagnose"“Frontend"“Illumination"“Mainboard"
getApplicationList
方法名称 getApplicationList
说明 提供存储在装置上的所有应用程序的基本信息。输入参数 无输出参数 结构数组（索引：int，Id：int，名称：字符串，描述：字符串）
47
3D 摄像头
CN
requestSession
方法名称 requestSession
说明 请求会话对象以访问配置和更改装置工作模式。这样可阻止平行编辑并有助于通过密码保护编辑。ID 可选择由外部系统定义，但必须为定义的格式 (32char “hex”)。如果仅通过一个参数调用，则装置将生成会话 ID。会话将以默认超时开始（”SessionTimeout” 装置参数），通过调用“检测信号”可延长超时。装置将保持运行模式。如果装置禁用密码，则忽略指定为密码参数的值。
输入参数 1. 密码：字符串2. 会话 ID：字符串（可选）
输出参数 会话 ID：字符串
reboot
方法名称 reboot
说明 重启系统，参数定义将启动哪个模式/系统输入参数 关闭后应启动的系统的类型：int
0：生产模式1：恢复模式
输出参数 输出：字符串
systemCommand
方法名称 systemCommand
说明 在装置上执行一般命令输入参数 1. 命令：字符串
2. 参数：字符串输出参数 输出：字符串
3D 摄像头
48
14.6.3 会话对象
heartbeat
方法名称 heartbeat
说明 延长编辑会话的寿命。如果给定值在 “SessionTimeout” 范围之外，则将使用保存的默认超时值。
输入参数 请求的与下一次检测信号之间的超时间隔（以 s 为单位）：int输出参数 使用的超时间隔（以 s 为单位）：int
cancelSession
方法名称 cancelSession
说明 明确停止该会话如果应用程序仍处于编辑模式，则跟 “stopEditingApplication” 的功能差不多。
输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
exportConfig
方法名称 exportConfig
说明 导出传感器装置的全部配置输入参数 无输出参数 配置为数据 BLOB：binary/base64
importConfig
方法名称 importConfig
说明 导入全部配置，可选择跳过特定部分输入参数 1. 配置为数据 BLOB：binary/base64
2. 描述应加载哪些部分的标记：0x0001：包括配置（名称、描述、位置 ...）0x0002：包含网络配置（IP、DHCP ...）0x0010：包含所有应用程序配置
输出参数 空字符串（兼容经典 XmlRPC 客户端）
exportApplication
方法名称 exportApplication
说明 导出一个应用程序配置输入参数 应用程序索引输出参数 应用程序配置为数据 BLOB：binary/base64
49
3D 摄像头
CN
importApplication
方法名称 importApplication
说明 导出应用程序配置并通过它创建新的应用程序。装置会将新的应用程序置于第一个自由索引。
输入参数 应用程序配置为一个数据 BLOB：binary/base64输出参数 新应用程序的索引
setOperatingMode
方法名称 setOperatingMode
说明 更改装置的工作模式。将其设置为“编辑”，即会在 RPC 上启用“编辑模式对象”。
输入参数 模式：整数0：运行模式1：编辑模式
输出参数 空字符串（兼容经典 XmlRPC 客户端）
setTemporaryApplicationParameters
方法名称 setTemporaryApplicationParameters
说明 在运行模式中设置应用程序参数。参数名称在前缀方案之后，类似于 XMLRPC 界面中的对象层级。 例如：
● 应用程序对象的参数没有前缀， ● 成像器对象的参数有前缀 “imager_001/”， ● 包含 ID 2 的模式的参数有前缀 “model_002/”，
成像配置的参数 “imager_001/ExposureTime”、“imager_001/ExposureTimeRatio” 和 “imager_001/Channel”均受支持。 可忽略所有其他参数。 如果参数在参数列表中显示一次以上，则参数选择哪个值是未确定的。 曝光时间缩至允许的范围内，具体视曝光模式而定。 必须提供取决于曝光模式的整套参数。 例如：
● “ExposureTime” 仅针对单曝光模式， ● “ExposureTime” 和 “ExposureTimeRatio”针对双曝光模式。
否则，状况不确定。 可忽略已使用曝光模式允许范围之外的“Channel”参数值，就非数字的值而言，状况不确定。示例：setTemporaryApplicationParameters [{"imager_001/ExposureTime":"100"}]
输入参数 参数列表（包含按键值对的结构，包括按键：参数名称，以及值：新参数值）输出参数 空字符串（兼容经典 XmlRPC 客户端）
更改不持续，且在进入编辑模式或关闭装置时丢失。
3D 摄像头
50
14.6.4 编辑模式对象
factoryReset
方法名称 factoryReset
说明 将所有配置复位为出厂设定输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
出厂设定将删除保存在摄像头上的所有应用程序。
editApplication
方法名称 editApplication
说明 将特定应用程序调整为编辑状态。这样会将应用程序对象附加至 RPC 接口。对象名称将与应用程序无关。这样不会更改 “ActiveApplication” 参数。
输入参数 应用程序索引：int输出参数 空字符串（兼容经典 XmlRPC 客户端）
stopEditingApplication
方法名称 stopEditingApplication
说明 通知装置已完成该应用程序的编辑。未保存的更改将丢弃。
输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
createApplication
方法名称 createApplication
说明 创建“空的”应用程序。 嵌入侧应初始化所有需要的参数和结构。输入参数 无输出参数 新应用程序的索引：int
51
3D 摄像头
CN
copyApplication
方法名称 copyApplication
说明 通过复制其他应用程序的配置来创建新应用程序。装置将针对新应用程序生成 ID，并将其置于自由索引。
输入参数 应复制的应用程序的索引：int输出参数 新应用程序的索引：int
deleteApplication
方法名称 deleteApplication
说明 从传感器删除应用程序如果删除的应用程序为启用中的应用程序，则传感器将不再拥有启用的应用程序，直至用户选择一个。
输入参数 应用程序的索引：int输出参数 空字符串（兼容经典 XmlRPC 客户端）
moveApplications
方法名称 moveApplications
说明 将应用程序移至其他索引。所有应用程序必须均在新列表中，不可复制，索引不得使用两次。ID 为固定值，只要应用程序留在传感器中，即保持不变。索引可更改，用于通过 PCIC、XML-RPC 和数字 IO 对应用程序进行寻址。
输入参数 结构数组（Id：int，索引：int）输出参数 空字符串（兼容经典 XmlRPC 客户端）
14.6.5 装置配置对象
activatePassword
方法名称 activatePassword
说明 设置密码并在下次编辑会话中启用。持续作出该更改需针对装置对象调用“保存”。
输入参数 密码：字符串输出参数 空字符串（兼容经典 XmlRPC 客户端）
3D 摄像头
52
disablePassword
方法名称 disablePassword
说明 禁用密码保护。持续作出该更改需针对装置对象调用“保存”。
输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
save
方法名称 save
说明 将当前配置存储在持续存储器中。如果在更改装置参数（通过 setParameter）后未加以调用，则重启后更改会丢失。
输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
装置配置参数此处定义了参数访问的方法：
参数名称 数据类型 说明
名称 字符串 (utf8) 装置的用户定义名称（最多 64 个字符）。说明 字符串 (utf8) 装置的用户定义描述（最多 500 个字符）。ActiveApplication Int
*有限制活动应用程序的索引仅适用于运行模式：* 定义启动时启用的应用程序（如果静态应用程序开关禁用）* 包含当前启用的应用程序（还可通过 PCIC 命令更改）* 0 表示没有应用程序处于启用状态
PcicTcpPort Int PCIC 连接 TCP/IP 端口。PcicProtocolVersion Int
*有限制PCIC 子协议，参阅 PCIC 规范。
IOLogicType Int*有限制
定义所有数字插脚的逻辑类型。允许值：0：NPN1：PNP
IODebouncing Bool 适用于所有输入IOExternApplicationSwitch Int
*有限制允许值：0：关闭1：静态，通过 I/O2：脉冲驱动，通过 I/O3：脉冲驱动，通过触发
会话超时 Int*有限制
需要调用“检测信号”方法之前会话持续的秒数
53
3D 摄像头
CN
参数名称 数据类型 说明
ServiceReportFailedBuffer Int*有限制
预留给失败结果的缓冲数
ServiceReportPassedBuffer Int*有限制
预留给成功结果的缓冲数
ExtrinsicCalibTransX Double单位：mm
外部校准，X 方向转换
ExtrinsicCalibTransY Double单位：mm
外部校准，Y 方向转换
ExtrinsicCalibTransZ Double单位：mm
外部校准，Z 方向转换
ExtrinsicCalibRotX Double单位：°
外部校准，围绕 X 轴旋转
ExtrinsicCalibRotY Double单位：°
外部校准，围绕 Y 轴旋转
ExtrinsicCalibRotZ Double单位：°
外部校准，围绕 Z 轴旋转
IPAddressConfig Int 只读：GUI 需要了解在多用途情况下装置是否位于发现 IP 地址。 延伸该信息是为了反映所有类型的 IP 地址状况。允许值：0：静态（IP 地址在装置内明确定义）1：DHCP（使用网络中的 DHCP 服务器）2：LinkLocal（配置为 DHCP，但没有提供了地址的服务器）3：发现（可通过 IP4Discovery 机制更改）
PasswordActivated Bool 只读：密码保护启用时为真OperatingMode Int 只读：装置模式（运行、编辑）
请参阅 “setOperatingMode”（Setter 在编辑模式范围之外，但在会话范围内）
DeviceType 字符串 只读：提供类型描述、独特成像器、评估逻辑和装置接口。
ArticleNumber 字符串 只读：官方目录编号ArticleStatus 字符串 只读：官网两字母状态代码UpTime Double 只读：自上次重启以来的小时数ImageTimestampReference Int
单位：ms只读：它将返回当前时间戳，作为已接收图像时间戳的参考。
TemperatureFront1 Double单位：摄氏度
无效温度，输出为 3276.7
TemperatureFront2 Double单位：摄氏度
无效温度，输出为 3276.7
TemperatureIllu Double单位：摄氏度
只读：装置中测量的温度。照明板上测量。
*有限制：包含该标记的参数列于 getAllParameterLimits 方法回应中。
3D 摄像头
54
装置配置参数默认值装置配置参数默认值为：
参数名称 数据类型 说明
名称 字符串 (utf8) “新传感器”说明 字符串 (utf8) ""ActiveApplication Int
*有限制0
PcicTcpPort Int 50010PcicProtocolVersion Int
*有限制3
IOLogicType Int*有限制
1
IODebouncing Bool trueIOExternApplicationSwitch Int
*有限制0
会话超时 Int*有限制
30
ExtrinsicCalibTransX Double单位：mm
0.0
ExtrinsicCalibTransY Double单位：mm
0.0
ExtrinsicCalibTransZ Double单位：mm
0.0
ExtrinsicCalibRotX Double单位：°
0.0
ExtrinsicCalibRotY Double单位：°
0.0
ExtrinsicCalibRotZ Double单位：°
0.0
IPAddressConfig Int 0PasswordActivated Bool FALSEOperatingMode Int 0ServiceReportFailedBuffer Int 15ServiceReportPassedBuffer Int 15
就所有其他装置配置参数而言，没有确定的默认值，因为与装置相关（DeviceType、ArticleNumber、ArticleStatus）或不稳定（UpTime、ImageTimestampReference）。
55
3D 摄像头
CN
装置配置参数最小值和最大值装置配置参数最小值和最大值为：
参数名称 最小值 最大值
ActiveApplication 0 32PcicProtocolVersion 1 4IOLogicType 0 1IOExternApplicationSwitch 0 3会话超时 5 300
14.6.6 装置/网络配置对象
saveAndActivateConfig
方法名称 saveAndActivateConfig
说明 重新初始化网络接口以便其能够使用其他 RPC 方法设置的配置。将没有 XMLRPC 回应，因为网络接口会即刻重置。
输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
14.6.7 应用程序配置对象
save
方法名称 save
说明 将当前配置存储在持续存储器中。如果应用装置还未处于“可启用”状态，亦可如此。
输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
forceTrigger
方法名称 forceTrigger
说明 执行当前启用中的应用程序的软件触发。输入参数 无输出参数 空字符串（兼容经典 XmlRPC 客户端）
Validate
方法名称 validate
说明 验证应用程序 也就是说，它将检查应用程序是否可启用。输入参数 无输出参数 错误结构数组（Id：int，文本：字符串）错误场景 无
3D 摄像头
56
应用程序参数此处定义了参数访问的方法：
参数名称 数据类型 说明
名称 字符串 (utf8)
应用程序的用户定义名称（最多 64 个字符）。
说明 字符串 (utf8)
应用程序的用户定义描述（最多 500 个字符）。
TriggerMode Int*有限制
允许值：1：自由运行2：过程接口3：上升沿4：下降沿5：上升和下降沿
PcicTcpResultSchema 字符串 它定义将发送哪些图像和结果数据。它还可定义数据元素和其他分隔符的顺序。包含 AmplitudeImage、IntensityImage、DistanceImage、XImage、YImage、ZImage、ConfidenceImage、DiagnosticData 的单次启用/禁用 (→ 14.3.5)
LogicGraph 字符串 讲述有助于对模型结果和输出插脚之间的逻辑进行编程的流程图的 JSON 字符串。
类型 字符串 内部用途TemplateInfo 字符串 一般 JSON 存储器，GUI 可存储关于已使用模板 GUI 的
其他数据（版本和其他参数决定）装置不可使用该数据，其应仅存储在装置上。
*有限制：包含该标记的参数列于 getAllParameterLimits 方法回应中
应用程序参数默认值应用程序参数默认值为：
参数名称 数据类型 说明
名称 字符串 (utf8)
“新应用程序”
说明 字符串 (utf8)
""
TriggerMode Int*有限制
1
PcicTcpResultSchema 字符串 ""LogicGraph 字符串 ""类型 字符串 “摄像头”TemplateInfo 字符串 ""
57
3D 摄像头
CN
应用程序参数最小值和最大值应用程序参数最小值和最大值为：
参数名称 最小值 最大值
TriggerMode 1 5
14.6.8 应用程序/成像器配置对象
changeType
方法名称 changeType
说明 更改成像器配置的类型。这样会更改可用参数的设置，亦可能更改可用 RPC 方法。
输入参数 类型：字符串输出参数 空字符串（兼容经典 XmlRPC 客户端）
availableTypes
方法名称 availableTypes
说明 列出所有可用成像器配置类型。输入参数 无输出参数 字符串数组
所有类型应用程序成像器配置的参数此处定义了参数访问的方法：
参数名称 数据类型 说明
类型 字符串 只读：成像器配置类型，请参阅“更改类型方法”FrameRate Double
*有限制自由运行模式目标帧速（帧/每秒）。
ClippingLeft Double*有限制
宽度剪裁区域下限值
ClippingTop Double*有限制
高度剪裁区域下限值
ClippingRight Double*有限制
宽度剪裁区域上限值
ClippingBottom Double*有限制
高度剪裁区域上限值
ContinuousAutoExposure Bool 启用编码期间连续调整集成时间SpatialFilterType Int
*有限制允许值：0：关闭1：中值滤波器2：平均滤波器3：双边滤波器
3D 摄像头
58
参数名称 数据类型 说明
TemporalFilterType Int*有限制
允许值：0：关闭1：临时平均滤波器2：自适应指数滤波器
EnableFilterDistanceImage Bool 针对距离图像启用滤波器EnableFilterAmplitudeImage Bool 针对幅度图像启用滤波器SymmetryThreshold Double
*有限制MinimumAmplitude Double
*有限制定义用于像素有效性的最小幅度。
TwoFreqMaxLineDistPercentage Double*有限制
ThreeFreqMax2FLineDistPercentage Double*有限制
ThreeFreqMax3FLineDistPercentage Double*有限制
EnableAmplitudeCorrection Bool 启用幅度值的修正EnableRectificationDistanceImage Bool 启用距离图像的纠正EnableRectificationAmplitudeImage Bool 启用正常化幅度图像的纠正ExposureTimeList 字符串 只读：所有当前曝光时间的列表，由 “;” 隔开
应包含 3 个 “*_high” 类型的值，2 个 “*_moderate” 类型的值，以及 1 个 ”*_low” 类型的值。 列表按递增的顺序分类。
MaxAllowedLEDFrameRate Double只读
当前设置的最大允许帧速（符合 LED 忙闲度）
分辨率 Int*有限制
输出图像的分辨率：0：176 x 132（2x2 装箱）1：352 x 264（无装箱），仅适用于 100k 摄像头
EnableFastFrequency Bool 在多频率模式下启用滚动评估（单频率模式下将忽略参数）
ClippingCuboid JSON 描述剪裁长方体的对象AutoExposureReferenceType Int
*有限制选择图像的一部分以用于连续自动曝光：0：整个图像1：ROI (→ AutoExposureReferenceROI)2：参考点 (→ AutoExposureReferencePointX and AutoExposureReferencePointY)
AutoExposureReferenceROI 字符串 AutoExposureReferenceType “1” 的 ROI 定义AutoExposureReferencePointX Int
*有限制参考点 X 坐标，用于 AutoExposureReferenceType "2"
AutoExposureReferencePointY Int*有限制
参考点 Y 坐标，用于 AutoExposureReferenceType “2”
AutoExposureMaxExposureTime Int*有限制
应在启用连续自动曝光时使用的最长曝光时间 (→ AutoExposureReferenceType)
*有限制：包含该标记的参数列于 getAllParameterLimits 方法回应中
59
3D 摄像头
CN
常见成像器配置参数默认值常见成像器配置参数默认值为：
参数名称 数据类型 说明
类型 字符串 "under5m_low"FrameRate Double 5.0ContinuousAutoExposure Bool FALSESpatialFilterType Int 0TemporalFilterType Int 0EnableFilterDistanceImage Bool trueEnableFilterAmplitudeImage Bool trueSymmetryThreshold Double 0.4MinimumAmplitude Double 42TwoFreqMaxLineDistPercentage Double 80ThreeFreqMax2FLineDistPercentage Double 80ThreeFreqMax3FLineDistPercentage Double 80EnableAmplitudeCorrection Bool trueEnableRectificationDistanceImage Bool FALSEEnableRectificationAmplitudeImage Bool FALSE分辨率 Int 0EnableFastFrequency Bool FALSEClippingCuboid 字符串 ‘{"XMin":-3.402823e+38, "XMax":3.402823e+38,
"YMin":-3.402823e+38, "YMax":3.402823e+38, "ZMin":-3.402823e+38, "ZMax":3.402823e+38}'
AutoExposureReferenceType Int 0AutoExposureReferenceROI 字符串 ‘{"ROIs":[{"id":0,"group":0, "type":"Rect",
"width":130, "height":100, "angle":0, "center_x":88, "center_y":66}]}'
AutoExposureReferencePointX Int 88AutoExposureReferencePointY Int 66AutoExposureMaxExposureTime Int 10000
常见成像器配置参数最小值和最大值见成像器配置参数最小值和最大值为：
参数名称 最小值 最大值
FrameRate 0.0167 30.0SpatialFilterType 0 3TemporalFilterType 0 2SymmetryThreshold 0MinimumAmplitude 0TwoFreqMaxLineDistPercentage 0 100ThreeFreqMax2FLineDistPercentage 0 100ThreeFreqMax3FLineDistPercentage 0 100分辨率 0 1AutoExposureReferenceType 0 2AutoExposureReferencePointX 1 352
3D 摄像头
60
参数名称 最小值 最大值
AutoExposureReferencePointY 1 264AutoExposureMaxExposureTime 10 10000
仅 “under5m_low” 类型应用程序成像器配置的参数参数名称 数据类型 说明
ExposureTime Int*有限制
曝光时间第二次曝光时间将根据第一次进行计算。
ExposureTimeRatio Int*有限制
长曝光时间/短曝光时间比率。
通道 Int*有限制
允许值：0：非群组用途（如 channel1，但有额外 GUI 选项）1：channel12：channel23：channel3
“Under5m_low” 模式参数默认值参数名称 数据类型 默认值
ExposureTime Int 1000通道 Int 0
“Under5m_low” 模式参数最小值和最大值参数名称 最小值 最大值
ExposureTime 1 10000通道 0 3
仅 “under5m_moderate” 类型应用程序成像器配置的参数参数名称 数据类型 说明
ExposureTime Int*有限制
长曝光时间第二次曝光时间将根据第一次进行计算。
通道 Int*有限制
允许值：0：非群组用途（如 channel1）1：channel12：channel23：channel3
“under5m_moderate” 模式参数默认值参数名称 数据类型 默认值
ExposureTime Int 1000ExposureTimeRatio Int 40
61
3D 摄像头
CN
参数名称 数据类型 默认值
通道 Int 0
“Under5m_moderate” 模式参数最小值和最大值参数名称 最小值 最大值
ExposureTime 1 10000ExposureTimeRatio 2 50通道 0 3
仅 “under5m_high” 类型应用程序成像器配置的参数参数名称 数据类型 说明
通道 Int*有限制
允许值：0：非群组用途（如 channel1，但有额外 GUI 选项）1：channel12：channel23：channel3
“under5m_high” 模式参数默认值参数名称 数据类型 默认值
通道 Int 0
“under5m_high” 模式参数最小值和最大值参数名称 最小值 最大值
通道 0 3
仅 “upto30m_low” 类型应用程序成像器配置的参数参数名称 数据类型 说明
ExposureTime Int*有限制
长曝光时间
通道 Int*有限制
允许值：0：非群组用途（如 channel1）1：channel12：channel23：channel3
“upto30m_low” 模式参数默认值参数名称 数据类型 默认值
ExposureTime Int 1000通道 Int 0
3D 摄像头
62
“upto30m_low” 模式参数最小值和最大值参数名称 最小值 最大值
ExposureTime 1 10000通道 0 3
仅 “upto30m_moderate” 类型应用程序成像器配置的参数参数名称 数据类型 说明
ExposureTime Int*有限制
长曝光时间第二次曝光时间将根据第一次进行计算。
ExposureTimeRatio Int*有限制
长曝光时间/短曝光时间比率
通道 Int*有限制
允许值：0：非群组用途（如 channel1，但有额外 GUI 选项）1：channel12：channel23：channel3
“upto30m_moderate” 模式参数默认值参数名称 数据类型 默认值
ExposureTime Int 1000ExposureTimeRatio Int 40通道 Int 0
“upto30m_moderate” 模式参数最小值和最大值参数名称 最小值 最大值
ExposureTime 1 10000ExposureTimeRatio 2 50通道 0 3
仅 “upto30m_high” 类型应用程序成像器配置的参数参数名称 数据类型 说明
通道 Int*有限制
允许值：0：非群组用途（如 channel1，但有额外 GUI 选项）1：channel12：channel23：channel3
“upto30m_high” 模式参数默认值参数名称 数据类型 默认值
通道 Int 0
63
3D 摄像头
CN
“upto30m_high” 模式参数最小值和最大值参数名称 最小值 最大值
通道 0 3
14.6.9 图像设置和滤波器参数若要设置空间或临时滤波器，则使用一般 “setter” 方法。
空间中值、空间平均以及空间双边滤波器的参数参数名称 数据类型 说明
MaskSize Int 允许值：0：3x31：5x5
临时平均滤波器参数参数名称 数据类型 说明
NumberOfImages Int 限值：2..25