Instrucciones de uso Cámara 3D - ifm · Cámara 3D 8 6. Montaje Este capítulo describe qué se...

Instrucciones de uso Cámara 3D

O3D301 O3D303 O3D311 O3D313

7063

97 /

07

12 /

2018

ES

Cámara 3D

2

Índice de contenidos1. Advertencia preliminar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

1.1 Símbolos utilizados. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41.2 Indicaciones de advertencia utilizadas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41.3 Open source information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

2. Indicaciones de seguridad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.1 Generalidades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.2 Grupo destinatario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.3 Conexión eléctrica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.4 Manipulaciones en el equipo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

3. Uso previsto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

4. Componentes incluidos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

5. Accesorios . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

6. Montaje . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86.1 Elegir el lugar de montaje . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86.2 Preparar el equipo para la puesta en marcha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

6.2.1 Límites típicos de aviso para los O3D301 / O3D303 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96.2.2 Límites típicos de aviso para los O3D311 / O3D313 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106.2.3 Reducción de la temperatura superficial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

6.3 Montar el equipo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116.4 Accesorios de montaje . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

7. Conexión eléctrica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127.1 Conexionado. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

7.1.1 Pin 1 / 3 (24 V / GND). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137.1.2 Pin 2 (entrada trigger). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137.1.3 Pin 4 / 5 (Ready / conexión en cascada) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

7.2 Ejemplos de cableado . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147.2.1 Activar la captura de imagen con un detector de proximidad. . . . . . . . . . . . . . . . . . . . . . . .147.2.2 Utilizar varios equipos contiguos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

8. Elementos de visualización . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

9. Puesta en marcha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179.1 Parametrización del equipo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179.2 Detectar el objeto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

10. Ejemplo de programación . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1810.1 ifm3Dlib. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

11. Mantenimiento, reparaciones, eliminación. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1911.1 Limpieza . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1911.2 Actualizar el firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1911.3 Sustituir el equipo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

12. Homologaciones/normas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

13. Dibujos a escala. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2013.1 O3D303 / O3D313 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2013.2 O3D301 / O3D311 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

14. Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2114.1 Required Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2114.2 XML-RPC Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

14.2.1 Sample XML-RPC command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2114.2.2 XML-RPC Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

14.3 Process Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2514.3.1 Sending Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2514.3.2 Receiving Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2614.3.3 Image data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2614.3.4 Additional Information for CONFIDENCE_IMAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

3

Cámara 3D

ES

14.3.5 Configuration of PCIC Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3114.4 Process Interface Command Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

14.4.1 a Command (activate application) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3614.4.2 A? Command (occupancy of application list) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3614.4.3 c Command (upload PCIC output configuration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3714.4.4 C? Command (retrieve current PCIC configuration). . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3714.4.5 E? Command (request current error state). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3714.4.6 G? Command (request device information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3814.4.7 H? Command (return a list of available commands). . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3914.4.8 I? Command (request last image taken). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4014.4.9 o Command (set logic state of a ID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4014.4.10 O? Command (request state of a ID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4114.4.11 p Command (turn PCIC output on or off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4114.4.12 S? Command (request current decoding statistics) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4214.4.13 t Command (execute asynchronous trigger). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4214.4.14 T? Command (execute synchronous trigger) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4314.4.15 v Command (set current protocol version) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4314.4.16 V? Command (request current protocol version) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

14.5 Error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4414.6 XML-RPC Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45

14.6.1 Parameter API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4514.6.2 Main Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4614.6.3 Session Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4914.6.4 Edit Mode Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5114.6.5 Device Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5214.6.6 Device/Network Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5614.6.7 Application Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5614.6.8 Application/Imager Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5814.6.9 Image Settings and Filter Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

CopyrightMicrosoft®, Windows®, Windows Vista®, Windows 7®, Windows 8®, Windows 8.1® y Windows 10® son marcas registradas de Microsoft Corporation.Adobe® y Acrobat® son marcas registradas de Adobe Systems Inc.Todas las marcas registradas y los nombres de empresas utilizados están sujetos a los derechos de autor de las respectivas empresas.

Cámara 3D

4

1. Advertencia preliminarEste documento está dirigido a personal técnico. En este caso son personas que, debido a una formación pertinente y a su experiencia, están capacitadas para reconocer riesgos y evitar posibles peligros que puedan ocurrir durante la utilización o la puesta en marcha de este equipo. Este documento contiene indicaciones para el correcto uso de este equipo.

Lea este documento antes de utilizar el equipo para que pueda familiarizarse con las condiciones de utilización, la instalación y el funcionamiento. Conserve este documento todo el tiempo que siga utilizando este equipo.

1.1 Símbolos utilizados► Operación requerida> Reacción, resultado[…] Referencia a teclas, botones o indicadores→ Referencia cruzada

Nota importante El incumplimiento de estas indicaciones puede acarrear funcionamientos erróneos o averías.Información Indicaciones complementarias

1.2 Indicaciones de advertencia utilizadas

ATENCIÓN Advertencia de daños materiales.

5

Cámara 3D

ES

1.3 Open source informationThis product can contain Free Software or Open Source Software from various software developers which is subject to the following licenses: General Public License version 1, version 2 and version 3 (General Public License version 3 in conjunction with the GNU Compiler Collection Runtime Library Exception version 3.1), Lesser General Public License version 2.1, Lesser General Public License version 3, Berkeley Software Distribution ("This product includes software developed by the University of California, Berkeley and its contributors"), The Academic Free License version 2.1. For the components subject to the General Public License in their respective versions the following applies:

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. If version 1 applies to the software: either version 1 of the License or (at your option) any later version; if version 2 (or 2.1) applies to the software: either version 2 (or 2.1) of the License or (at your option) any later version; if version 3 applies to the software: either version 3 of the License or (at your option) any later version. The following disclaimer of the software developers applies to the software components that are subject to the General Public License or the Lesser General Public License in their respective versions: The Free Software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU Lesser General Public License for more details.

The responsibility of ifm electronic gmbh for ifm products, in the case of product-specific software, remains unaffected by the above disclaimer. Please note that the firmware for the ifm products is in some cases provided free of charge. The price of the ifm products has then to be paid for the respective device itself (hardware) and not for the firmware. For the latest information on the license agreement for your product please visit www.ifm.com

For binaries that are licensed under any version of the GNU General Public License (GPL) or the GNU LGPL you may obtain the complete corresponding source code of the GPL software from us by sending a written request to: [email protected] or to ifm electronic gmbh Friedrichstraße 1, 45128 Essen, Germany.

We charge €30 for each request. Please write “source for product Y” in the memo line of your payment. Your request should include (i) the name of the covered binary, (ii) the name and the version number of the ifm product, (iii) your name and (iv) your return address.

This offer is valid to anyone in receipt of this information.

This offer is valid for at least three years (from the date you received the GLP/LGPL covered code).

Cámara 3D

6

2. Indicaciones de seguridad 2.1 GeneralidadesEsta descripción es parte integrante del equipo. Contiene textos e ilustraciones para el correcto manejo del equipo y debe ser leída antes de su uso o instalación.

Respete las indicaciones de estas instrucciones. El incumplimiento de las indicaciones, el funcionamiento no conforme al uso previsto especificado posteriormente, así como la instalación o manejo incorrectos pueden poner en grave peligro la seguridad de las personas y de las instalaciones.

2.2 Grupo destinatarioEl manual está dirigido a todo el personal técnico en conformidad con las directivas CEM y de Baja Tensión. El equipo solo puede ser instalado, conectado y puesto en marcha por técnicos electricistas.

2.3 Conexión eléctricaDesconecte la tensión externa del equipo antes de realizar cualquier operación.

Los pines de conexión solamente pueden ser alimentados mediante las señales indicadas en los datos técnicos o en la etiqueta del equipo, y solo podrán conectarse los accesorios homologados de ifm.

2.4 Manipulaciones en el equipoEn caso de funcionamiento erróneo del equipo o si tiene alguna duda, póngase en contacto con el fabricante. La manipulación del equipo puede poner en grave peligro la seguridad de las personas y de las instalaciones. Dichas manipulaciones no están permitidas y tienen como consecuencia la exclusión de la responsabilidad y garantía.

7

Cámara 3D

ES

3. Uso previstoLa cámara 3D O3D3xx es una cámara óptica que mide punto por punto la distancia entre la cámara y la superficie más próxima mediante la medición del tiempo de vuelo. La cámara 3D O3D3xx ilumina la escena con una fuente de iluminación infrarroja interna y calcula la distancia a partir de la luz reflejada por la superficie.

La cámara 3D O3D3xx proporciona datos que describen la escena capturada en tres dimensiones. Estos datos de distancia pueden ser emitidos a través de Ethernet y ser evaluados por el usuario. El ajuste de parámetros de la cámara 3D O3D3xx también se efectúa a través de Ethernet.

La cámara 3D O3D3xx solamente se puede utilizar bajo las condiciones ambientales indicadas en la ficha técnica.

La seguridad del equipo está concebida para una utilización bajo las siguientes condiciones ambientales:

• Utilización en espacios interiores

• Alturas hasta 2000 m

• Humedad relativa del aire hasta un máximo del 90%, sin condensación

• Grado de contaminación 3

Debido a los requisitos para emisiones de interferencias electromagnéticas, el equipo está destinado a la utilización en aplicaciones industriales. El equipo no es apto para un uso en el ámbito doméstico.

El equipo solo se puede utilizar en las condiciones ambientales indicadas en la ficha técnica.

4. Componentes incluidos ● Cámara 3D O3D3xx

● Guía breve

La ficha técnica y más documentación (manual del software, etc.) están disponibles en Internet: www.ifm.com

5. AccesoriosPara el funcionamiento del equipo se requieren los siguientes accesorios:

Número de artículo Descripción

E11950 Cable de suministro de corriente para la cámara / el sensorE11898 Prolongador M12 industrial Ethernet

El software ifm Vision Assistant está disponible en Internet de forma gratuita: www.ifm.com

Cámara 3D

8

6. MontajeEste capítulo describe qué se debe tener en cuenta antes del montaje y cómo se debe montar el equipo.

②

①

③

④

⑤

① Equipo

② Ángulo de apertura

③ Objeto

④ Campo de visión

⑤ Distancia entre el equipo y el objeto

6.1 Elegir el lugar de montajeSiga las siguientes instrucciones para elegir el lugar de montaje:

► El objeto ③ debe estar situado complemente dentro del campo de visión ④ . > El tamaño del campo de visión depende del tipo de equipo y está indicado en la ficha técnica. El

tamaño del campo de visión también depende de la distancia entre el equipo y el objeto ⑤ : cuando aumenta la distancia, el campo de visión es más grande.

► Tener en cuenta las tolerancias al colocar el objeto.

► Tener en cuenta el rango de medición del equipo al establecer la distancia entre el equipo y el objeto ⑤ . > El rango de medición está indicado en la ficha técnica del equipo.

► Elegir una distancia entre equipo y objeto ⑤ lo más pequeña posible.

> Con la distancia más pequeña posible se detecta el objeto con la resolución máxima.

► Evitar la luz ambiental intensa y la radiación solar en el lugar de montaje.

> Un nivel de luz externa superior a 8 klx causa errores de medición (con el espectro solar establecido). En realidad solo interfiere una proporción de luz infrarroja entre 800 y 900 nm.

► Evitar zonas con extrema suciedad para el lugar de montaje.

> En zonas con gran suciedad el objetivo se ensucia aunque esté orientado hacia abajo ①.

► Evitar los cristales transparentes entre el equipo ① y el objeto ③ . > Los cristales transparentes reflejan una parte de la luz, incluso aunque se utilice una placa de vidrio

muy limpia.

En caso de no respetarse estas instrucciones, pueden producirse errores de medición.

9

Cámara 3D

ES

6.2 Preparar el equipo para la puesta en marchaLa temperatura superficial del equipo depende del modo de funcionamiento, de los parámetros elegidos y de la conexión térmica del equipo con el entorno.

Asegúrese de que el equipo cumple con el siguiente requisito:

La temperatura de las superficies de fácil acceso debe ser como máximo 25°C superior a la temperatura ambiente (según IEC61010-2-201).

Los siguientes diagramas contienen límites típicos de aviso que deben servir de guía para el instalador.

Los diagramas se aplican para los siguientes modos de exposición:

● un tiempo de exposición

● dos tiempos de exposición

● tres tiempos de exposición

Con dos y tres tiempos de exposición, los límites de aviso típicos deben calcularse mediante la suma de los tiempos de exposición. Los tiempos de exposición se indican en el software ifm Vision Assistant.

Siga una de las indicaciones en caso de que se superen los límites de aviso:

► Reducir la temperatura superficial (→ 6.2.3).

► Montar una protección contra el contacto sin limitar la convección (circulación de aire).

> La temperatura superficial no aumentará una vez se haya montado esta protección contra el contacto.

El parámetro "Distancia visible máxima" se ajusta en el software ifm Vision Assistant. En los diagramas se indican los límites de aviso del parámetro con líneas continuas o de puntos.

Si el equipo se encuentra en una de las zonas con línea de puntos, es necesario reducir la temperatura superficial (→ 6.2.3). Si, a pesar de realizar un montaje con disipación del calor, se supera el límite de aviso, se puede montar adicionalmente una protección contra el contacto.

Si con el montaje normal se alcanzan valores por debajo de los límites típicos de aviso, no es necesario tomar medidas.

6.2.1 Límites típicos de aviso para los O3D301 / O3D303

0

5

10

15

0 2 4 6 8 10

x

y

20

25

Parámetro "Distancia visible máxima"

Montaje en piezas de metal conductoras de calor

con placa conductora de calor (→ 6.2.3)

Límite de aviso Parámetro

< 5 m

< 30 m

> 30 m

Montaje normal


< 5 m

< 30 m

> 30 m

x = tiempo de exposición [ms] y = frecuencia de imagen [fps]

Cámara 3D

10

6.2.2 Límites típicos de aviso para los O3D311 / O3D313

0

5

10

15

0 2 4 6 8 10

x

y

20

25

Parámetro "Distancia visible máxima"

Montaje en piezas de metal conductoras de calor

con placa conductora de calor (→ 6.2.3)


< 5 m

< 30 m

> 30 m

Montaje normal


< 5 m

< 30 m

> 30 m

x = tiempo de exposición [ms] y = frecuencia de imagen [fps]

6.2.3 Reducción de la temperatura superficialCon las siguientes medidas se puede reducir la temperatura superficial:

► Montar el equipo en piezas de metal conductoras de calor.

> Un contacto más amplio del equipo con piezas de metal aumenta la disipación de calor (p. ej. aluminio).

► Utilizar una placa conductora de calor en caso de montaje en piezas de metal.

> El efecto conductor del calor aumenta gracias a la placa conductora. La placa conductora de calor está disponible como accesorio (→ 6.4).

► Reducir los objetos obstaculizadores en el entorno del equipo y la densidad de construcción de los objetos.

> La presencia de objetos obstaculizadores en el entorno del equipo y una densidad de construcción elevada pueden afectar negativamente a la convección (movimiento del aire).

► Montar uno o dos disipadores de calor en el equipo.

> Los disipadores de calor aumentan la superficie del equipo, con lo que la temperatura superficial se ve reducida. Los disipadores de calor están disponibles como accesorios (→ 6.4).

► Reducir el tiempo de exposición, la frecuencia de imagen o la distancia visible máxima.

> El modo de funcionamiento utilizado y los parámetros pueden aumentar la temperatura superficial.

11

Cámara 3D

ES

6.3 Montar el equipoSiga las siguientes instrucciones para el montaje del equipo:

► Montar el equipo con 2 tornillos M5 o con el set de montaje.

> Las dimensiones de los taladros para los tornillos M5 están indicadas en la ficha técnica.

> El set de montaje está disponible como accesorio (→ 6.4).

► Utilizar protectores contra tirones en todos los cables conectados al equipo.

Tenga en cuenta las siguientes instrucciones durante el montaje de los O3D301 y O3D311:

► Montar el equipo de tal manera que el ajuste del enfoque sea accesible con un destornillador.

> La posición del ajuste del enfoque está indicada en el dibujo a escala (→ 13).

En caso de un uso continuo del equipo en zonas húmedas, la tuerca del prolongador M12 Industrial Ethernet (p. ej. E11898) puede corroerse. Para el uso permanente en zonas húmedas utilice un prolongador con una tuerca de acero inoxidable AISI 316.

6.4 Accesorios de montajeEn función del lugar y tipo de montaje se pueden utilizar los siguientes accesorios:

Número de artículo Descripción

E3D301 Set de montaje para la cámara inteligenteE3D302 Disipador de calor para la cámara inteligenteE3D303 Placa conductora de calor para la cámara inteligenteE3D304 2 disipadores de calor para la cámara inteligente

Para más información relativa a los accesorios: www.ifm.com

Cámara 3D

12

7. Conexión eléctricaTenga en cuenta las siguientes instrucciones antes de realizar la instalación eléctrica.

ATENCIÓN El equipo solo puede ser instalado por técnicos electricistas. Observar los datos eléctricos de la ficha técnica.

Equipo de la clase de protección III

El suministro eléctrico solamente puede realizarse a través de circuitos de corriente MBTP.

El suministro eléctrico debe cumplir con la UL61010-1, Cap. 9.4 - Limited Energy:

El dispositivo de protección contra sobrecorriente debe desactivar una corriente de 6,6 A en 120 s. En lo que respecta al dimensionamiento del dispositivo contra sobrecorriente, tenga en cuenta los datos técnicos del equipo y del cableado.

El aislamiento de circuitos de corriente externos debe cumplir con la norma UL61010-2-201, fig. 102.

Con longitudes de cable > 30 m, utilizar una protección adicional contra tensiones pico según IEC6100-4-5.

Desconectar la tensión de alimentación antes de realizar la conexión eléctrica.

Para el ámbito de validez cULus: Resistencia de temperatura mínima del cable para la conexión de bornes de campo: 70 °C.

7.1 Conexionado

① EthernetConector M12, codificación D, 4 polos

��

�

� �

��

��

��

�

� �

�

�

1 TD + 2 RD + 3 TD - 4 RD - S Shield

② Suministro de corrienteConector M12, codificación A, 5 polos

4

2 1

35

1 U+ 2 Entrada trigger 3 GND 4 Salida de conmutación 1 - Ready 5 Salida de conmutación 2 - Conexión en cascada

Cerrar la conexión Ethernet no utilizada con un tapón de protección (E73004). Par de apriete 0,6...0,8 Nm.

El comportamiento de las entradas y salidas de conmutación se puede configurar con el software ifm Vision Assistant. La configuración de conmutación PNP o NPN se aplica siempre para todas las entradas y salidas de conmutación.

Asegúrese de realizar una correcta configuración durante la instalación de sensores y actuadores (p. ej. fotocélulas para el trigger).

Las salidas de conmutación también se pueden utilizar como salidas por impulsos que restablecen su señal de conmutación tras un tiempo configurado.

13

Cámara 3D

ES

7.1.1 Pin 1 / 3 (24 V / GND)El rango de tensión permitido está indicado en la ficha técnica del equipo.

7.1.2 Pin 2 (entrada trigger)La captura de imagen del equipo se puede activar con una señal de conmutación a través de la entrada trigger.

Se pueden utilizar los siguientes flancos de trigger:

● El flanco descendente activa la captura de imagen

● El flanco ascendente activa la captura de imagen

● Los flancos ascendente y descendente activan la captura de imagen

Más posibilidades de activación del equipo:

● Comando de interfaces de proceso (→ 14.3)

● Captura continua de imagen con frecuencia de imagen fija configurable

La entrada trigger tiene una supresión interna de rebotes. Dependiendo de la instalación eléctrica, se puede prescindir de la supresión de rebotes del cable trigger.

La supresión interna de rebotes evita que varios impulsos cortos provoquen una activación. El impulso debe tener como mínimo una duración de 2 ms para que sea detectado como activación trigger.

7.1.3 Pin 4 / 5 (Ready / conexión en cascada)Las especificaciones eléctricas de las salidas de conmutación 1 y 2 (Ready / conexión en cascada) están indicadas en la ficha técnica.

Con los valores por defecto, las salidas de conmutación emiten el siguiente estado del equipo:

● Salida de conmutación 1: "Listo para trigger"

● Salida de conmutación 2: "Captura de imagen finalizada"

"Salida de conmutación conmutada" significa que se ha producido el correspondiente estado del equipo.

El estado del equipo puede adoptar uno de los siguientes valores dependiendo de la configuración:

● "Listo para trigger" El equipo avisa de que se puede realizar una nueva captura de imagen. Este es el único estado del equipo en el que se procesan las activaciones. En la captura continua de imagen no se emite el estado del equipo "Listo para trigger".

● "Captura de imagen finalizada" El equipo avisa de que la captura de imagen ha sido finalizada. El estado del equipo puede utilizarse para la conexión en cascada de equipos.

● "Evaluación finalizada" El equipo avisa de la finalización del procesamiento de la imagen. En ese momento las salidas de conmutación ya han sido actualizadas. Los datos de imagen se transmiten a través de Ethernet.

● "Error" El equipo avisa cuando se produce un error interno. La información detallada sobre el error se puede consultar a través de Ethernet.

Captura de imagen

Entrada trigger

Tiempo [ms]1 2 3 4 5 6 7 8 9 10 11

Cámara 3D

14

7.2 Ejemplos de cableadoA continuación se muestran ejemplos de cableado del equipo.

7.2.1 Activar la captura de imagen con un detector de proximidadEl equipo puede ser activado de forma externa:

● A través de Ethernet

● A través de un detector de proximidad, conectado con la entrada trigger

El siguiente dibujo muestra el cableado del equipo con un detector de proximidad.

3 1 2 4 5

1 2

34

4

2 1

35

DC 24 V+ -

IN IN

①

② ③

①: Portátil (parametrización)

②: Detector de proximidad

③: PC industrial (evaluación / trigger)

15

Cámara 3D

ES

7.2.2 Utilizar varios equipos contiguosLos equipos montados uno al lado del otro pueden causar errores de medición debido a la exposición simultánea.

① ②

③

① Equipo

② Equipo

③ Objeto

Los errores de medición se pueden evitar de dos maneras:

● Conexión en cascada de los equipos a través de un trigger por hardware Con la conexión en cascada el controlador activa la captura de imagen del equipo 1. Una vez concluida la captura de imagen, el equipo 1 activa automáticamente el equipo 2. El equipo 2 señaliza la finalización de la secuencia al controlador industrial.

3 1 2 4 5

4

2 1

35

DC 24 V+ -

IN IN

3 1 2 4 5

①

①: PC industrial (evaluación / trigger)

● Utilizar diferentes canales de frecuencia Con el software ifm Vision Assistant se puede asignar a cada equipo un canal de frecuencia propio. Los diferentes canales de frecuencia reducen la aparición de errores de medición.

El software ifm Vision Assistant está disponible en Internet de forma gratuita: www.ifm.com

Cámara 3D

16

8. Elementos de visualizaciónEl equipo señaliza el estado actual de funcionamiento a través de los indicadores LED 1 - 4.

LED 4 LED 3LED 1 LED 2

LED 4 (Ethernet)

LED 1 (Power)

LED 2 (Out 1)

LED 3 (Out 2)

Descripción

encendido El equipo está operativo, la tensión de alimentación está aplicada

parpadea con 0,5 Hz

Los parámetros del equipo no han sido ajustados o la parametrización no se ha cargado en el equipo

On

On

Off

Off

parpadea 2 veces con 0,5 Hz

El equipo está en el modo de parametrización

On

On

Off

Offencendido La salida de conmutación 1 está conmutadaparpadea con 8 Hz

La salida de conmutación 1 tiene un cortocircuito

encendido La salida de conmutación 2 está conmutadaparpadea con 8 Hz

La salida de conmutación 2 tiene un cortocircuito

encendido Ethernet está conectadoparpadea Ethernet transmite datosapagado Ethernet no está conectado

parpadea con 8 Hz

parpadea con 8 Hz

El equipo indica error interno

parpadea con 2 Hz

parpadea con 2 Hz

El equipo indica error reparable. El mensaje de error se puede leer a través de Ethernet

Luz en movimiento ⇒ El equipo arranca

Luz en movimiento ⇐ El equipo ejecuta una actualización del firmware

17

Cámara 3D

ES

9. Puesta en marchaAl aplicar la tensión de alimentación, el equipo se pone en marcha. Tras 15 segundos, el equipo se encuentra en el modo de evaluación, en el cual se ejecutan las aplicaciones almacenadas. Los elementos de visualización indican el estado actual de funcionamiento (→ 8).

En el equipo se pueden almacenar hasta 32 aplicaciones. Normalmente, una aplicación contiene los siguientes parámetros:

● Captura de imagen: p. ej. activación de la captura de imagen, tiempo de exposición, filtro de procesamiento de imagen

● Interfaz: Ethernet, salidas de conmutación

Cada una de las aplicaciones se puede activar en el software ifm Vision Assistant o a través de los comandos de las interfaces de proceso.

9.1 Parametrización del equipoEl equipo se puede parametrizar de varias formas:

● Software ifm Vision Assistant (→ véase el manual del software)

● ifm3Dlib (third party product, → https://github.com/ifm/ifm3d) ejemplo de programación para ifm3Dlib: (→ 10)

● ROS (third party product, → https://github.com/ifm/ifm3d-ros)

● Comandos XML-RPC (→ 14.6)

En el manual del software se describen el manejo del software ifm Vision Assistant y la información detallada sobre el principio de medición del equipo y sus efectos.

El manual del software está disponible en Internet: www.ifm.com

La biblioteca ifm3Dlib y el wrapper ROS son programados por encargo de ifm electronic. Ambos paquetes están disponibles para Linux en la licencia de Apache versión 2.0.

9.2 Detectar el objetoA continuación se describen qué condiciones provocan una elevada tasa de detección:

③

②

④

②

①① Equipo

② Zona de influencia

③ Campo de visión

④ Objeto

El objeto ④ es detectado de forma óptima si se cumplen las siguientes condiciones:

● El objeto está situado en el campo de visión ③

● El objeto es el siguiente elemento visible por el equipo ① ● La zona de influencia ② está libre de objetos (elementos obstaculizadores, etc.)

● El cristal frontal del equipo debe estar libre de suciedad.

En caso de que no se cumplan estas condiciones, pueden producirse errores de medición.

https://github.com/lovepark/ifm3d

https://github.com/lovepark/ifm3d-ros

Cámara 3D

18

10. Ejemplo de programaciónUtilice preferiblemente la biblioteca ifm3Dlib para el acceso al equipo en Linux. La biblioteca ha sido probada y es la implementación de referencia para C++.

La biblioteca es admitida por ifm electronic y la empresa Lovepark Robotics. La licencia Apache 2 permite el uso comercial.

10.1 ifm3DlibA continuación se muestra un breve ejemplo de C++ con el cual ifm3Dlib accede al equipo.

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());

En el ejemplo se retira un conjunto de datos del equipo. La imagen de amplitud y la distancia radial del conjunto de datos se guardan como archivo PNG. Las coordenadas cartesianas se guardan como archivo PCL.

19

Cámara 3D

ES

11. Mantenimiento, reparaciones, eliminaciónTenga en cuenta las siguientes instrucciones:

► No abrir el equipo. Dentro del equipo no se encuentran piezas que deban ser sometidas a mantenimiento por parte del usuario. Las reparaciones en el equipo solamente pueden ser efectuadas por el fabricante.

► Eliminar el equipo según las normas nacionales sobre medio ambiente.

11.1 LimpiezaTenga en cuenta las siguientes instrucciones antes de limpiar el equipo:

► Utilizar un paño limpio y que no suelte pelusa.

► Utilizar limpiacristales como producto de limpieza.

Si no se respetan estas instrucciones, se pueden producir errores de medición a causa de arañazos en el cristal frontal.

11.2 Actualizar el firmwareEl firmware del equipo se puede actualizar con el software ifm Vision Assistant.

Los parámetros almacenados en el equipo se pierden al actualizarse el firmware. Realice una copia de seguridad de los parámetros antes de actualizar el firmware:

► Exportar los parámetros antes de actualizar el firmware.

► Importar los parámetros después de actualizar el firmware.

Las actualizaciones de firmware están disponibles en Internet: www.ifm.com

11.3 Sustituir el equipoAl sustituir un equipo se pierden los parámetros. Realice una copia de seguridad de los parámetros antes de sustituir el equipo:

► Exportar los parámetros del equipo antiguo antes del cambio.

► Importar los parámetros en el nuevo equipo después del cambio.

Con la importación y exportación de parámetros se pueden cargar rápidamente los mismos parámetros en varios equipos.

12. Homologaciones/normasLa declaración de conformidad UE está disponible en la web: www.ifm.com

Cámara 3D

20

13. Dibujos a escala13.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

①: Objetivo

②: Fuente de iluminación

③: LED de 2 colores (amarillo/verde)

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

①: Objetivo

②: Fuente de iluminación

③: LED de 2 colores (amarillo/verde)

④: Ajuste del enfoque

21

Cámara 3D

ES

14. Appendix14.1 Required PortsThe following ports are required for the camera configuration using XML-RPC and for receiving data on the process interface. They must not be blocked by a firewall or router.

● TCP/HTTP: 80

● TCP: 50010

If the ifm Vision Assistant is used, the following additional ports must also be available:

● UDP: 3321

● TCP/HTTP: 8080

It is possible to configure another port than 50010 for the process interface. If a different port is used, it must not be blocked either.

14.2 XML-RPC InterfaceIn case the O3D3xx camera should not be configured by the “ifmVisionAssistant”, the XML-RPC interface can be used instead.

General information about XML-RPC is found on the website http://xmlrpc.scripting.com/spec

To send a command via the XML-RPC interface the command is in a special layout. In this command, linefeeds and carriage returns are essential.

Every command which is sent via the XML-RPC interface must end with carriage return <CR> and linefeed <LF>.

Several commands will use different URLs in the XML-RPC header.

14.2.1 Sample XML-RPC commandAll following XML-RPC commands will have this type of layout:

POST /RPC3 HTTP/1.0<CR><LF>

User-Agent: Frontier/5.1.2 (WinNT)<CR><LF>

Host: betty.userland.com<CR><LF>

Content-Type: text/xml<CR><LF>

Content-length: 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>

Cámara 3D

22

The following example contains one O3D3xx command:

POST /api/rpc/v1/com.ifm.efector/ HTTP/1.1 <CR><LF>

User-Agent: Frontier/5.1.2 (WinNT)<CR><LF>

Host: 192.168.0.69<CR><LF>

Content-Type: text/xml<CR><LF>

Content-length: 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 ObjectsTo communicate and to configure the device via XML-RPC the XML-RPC commands have to use different XML-RPC objects. Different commands need different XML-RPC objects (see XML-RPC command references).

The interface of O3D3xx is structured in an object-oriented way. Some of the objects are available all the time, others are only available after bringing the device into a special mode by calling a method on an already available object. This mechanism is used to create system requirements (e.g. password protection).

It could be necessary to send heartbeats so that there will be no session timeout.

The following diagram should give an overview how objects are related to each other and which methods must be called to make others available:

Main API

Session

EditMode

ApplicationConfig

requestSession(...)

setOperatingMode(1)

editApplication(1) DeviceConfig

NetworkConfig

ImagerConfig

23

Cámara 3D

ESMain ObjectObject-URI: /api/rpc/v1/com.ifm.efector/

This is the main object of RPC. It contains methods to open a session. The session contains methods for activating the edit mode. Most of its methods are only getters, because it should be possible to protect editing with a password.

Session ObjectObject URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/

The URL part “d21c80db5bc1069932fbb9a3bd841d0b” is the session ID. It is returned by the command "requestSession" of the main object. If the command "requestSession" is called without a user-defined session ID, which can be passed as a parameter, a random session ID is generated automatically.

EditMode ObjectObject URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/

This object is only available if the device is in the edit operating mode. The index of applications must be between 1 and 32. The device must only support 32 applications and the indexes must start at 1.

DeviceConfig ObjectObject-URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/

Device/NetworkConfig ObjectObject URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/network/

Application Config Object (editable application)Object URI e.g.: /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

Cámara 3D

24

Application/Imager Config Object (O3D3xx)Object URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/imager_001/

As there is only one imager config on O3D3xx, the ID must be fixed to "001". Data of this object is persistently saved when calling "save" on the application config object. The imager config RPC object has multiple sub-types. Only parameters relevant for a specific type are available while it is active. They are based on frequency (extending the distance) and integration intervals (extending the measurement details).

Type names, based on GUI draft (under 5 metres -> single frequency, up to 30 metres -> double frequency, more than 30 metres -> triple frequency.):

under5m_low

under5m_moderate

under5m_high

upto30m_low

upto30m_moderate

upto30m_high

morethan30m_low

morethan30m_moderate

Image Settings and Filter ParametersThere is an RPC object for spatial filter parameters in each imager configuration.

Object URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/imager_001/spatialfilter

There is an RPC object for temporal filter parameters in each imager configuration.

Object URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/imager_001/temporalfilter

Data of these objects is persistently saved when calling "save" on application config object.

25

Cámara 3D

ES

14.3 Process InterfaceThe process interface is used during the normal operation mode to get operational data (e.g. 3D images, process values) from the O3D3xx.

14.3.1 Sending CommandsFor sending commands via the process interface the commands have to be sent with a special protocol and as ASCII character strings. This protocol conforms to the version 3 of the O2V/O2D products.

Structure of the protocol:

<Ticket><length>CR LF <Ticket><content>CR LF

Abbreviation Description ASCII code (dec) ASCII code (hex)

CR Carriage Return 13 DLF Linefeed 10 A< > Marking of a placeholder

(e.g. <code> is a placeholder for code)[ ] Optional argument

(possible but not required)

Command Description

<content> It is the command to the device (e.g. trigger the unit).<ticket> It is a character string of 4 digits between 0-9. If a message with a specific ticket is sent

to the device, it will reply with the same ticket. A ticket number must be > 0999. Use a ticket number from the range 1000 - 9999.

<length> It is a character string beginning with the letter 'L' followed by 9 digits. It indicates the length of the following data (<ticket><content>CR LF) in bytes.

They are different protocol versions available:

Version Input format Output format

V1 <Content>CR LF as input V2 <Ticket><Content>CR LF as input V3 <Ticket><Length>CR LF<Ticket><Content>CR LF as input V4 <Content>CR LF <length>CR LF<Content>CR LF

The default protocol version is "V3". It is recommended to use protocol version 3 for machine to machine communication. This is due to the fact that only version 3 supports asynchronous messages and provides length information.

Ticket numbers for asynchronous messages:

Ticket number Description

0000 Asynchronous results0001 Asynchronous error messages / codes0010 Asynchronous notifications / message codes

Cámara 3D

26

14.3.2 Receiving ImagesFor receiving the image data a TCP/IP socket communication is established. The default port number is 50010. The port number may differ based on the configuration. After opening the socket communication, the O3D3XX device will automatically (if the device is in free run mode) send the data through this socket to the TCP/IP client (PC).

PCIC output per frame. The following data is submitted in this sequence:

Component Content

Ticket and length information (→ 14.4.14)Ticket „0000“Start sequence String "star" (4 bytes)Normalised amplitude image

Output format: 16-bit unsigned integer

1 image

Distance image

Output format: 16-bit integer. Unit: mm.

1 image

X image

Output format: 16-bit signed integer. Unit: mm.

1 image

Y image


1 image

Z image


1 image

Confidence image

Output format: 8-bit unsigned integer

1 image

Diagnostic dataStop sequence String "stop" (4 bytes)Ticket signature <CR><LF>

14.3.3 Image dataFor every image there will be a separate chunk. The chunk is part of the response frame data of the process interface.

The header of each chunk contains different kinds of information. This information is separated into bytes. The information contains e.g. the kind of image which will be in the “PIXEL_DATA” and the size of the chunk.

Offset Name Description Size [byte]

0x0000 CHUNK_TYPE Defines the type of the chunk. For each distinct chunk an own type is defined.

4

0x0004 CHUNK_SIZE Size of the whole image chunk in bytes. After this count of bytes the next chunk starts.

4

0x0008 HEADER_SIZE Number of bytes starting from 0x0000 until PIXEL_DATA.

4

0x000C HEADER_VERSION Version number of the header 40x0010 IMAGE_WIDTH Image width in pixel 40x0014 IMAGE_HEIGTH Image height in pixel 40x0018 PIXEL_FORMAT Pixel format 4

27

Cámara 3D

ES

Offset Name Description Size [byte]

0x001C TIME_STAMP Time stamp in microseconds (deprecated) 40x0020 FRAME_COUNT Frame counter 40x0024 STATUS_CODE Errors of the device 40x0028 TIME_STAMP_SEC Time stamp in seconds 40x002C TIME_STAMP_NSEC Time stamp in nanoseconds 40x0030 PIXEL_DATA The pixel data in the given type and dimension of the

image. Padded to 4-byte boundary.4

Available chunk types:

Constant Value Description

RADIAL_DISTANCE_IMAGE

100 Each pixel of the distance matrix denotes the ToF distance measured by the corresponding pixel or group of pixels of the imager. The distance value is corrected by the camera's calibration, excluding effects caused by multipath and multiple objects contributions (e.g. "flying pixels"). Reference point is the optical centre of the camera inside the camera housing.

Invalid PMD pixels (e.g. due to saturation) have a value of zero.

Data type: 16-bit unsigned integer (little endian)

Unit: millimetresNORM_AMPLITUDE_IMAGE

101 Each pixel of the normalized amplitude image denotes the raw amplitude (see amplitude image below for further explanation), normalized to exposure time. Furthermore, vignetting effects are compensated, ie the darkening of pixels at the image border is corrected. The visual impression of this grayscale image is comparable to that of a common 2D camera.

Invalid PMD pixels (e.g. due to saturation) have an amplitude value of 0.

Data type: 16-bit unsigned integerAMPLITUDE_IMAGE 103 Each pixel of the amplitude matrix denotes the amount of

modulated light (i.e. the light from the camera's active illumination) which is reflected by the appropriate object. Higher values indicate higher PMD signal strengths and thus a lower amount of noise on the corresponding distance measurements. The amplitude value is directly derived from the PMD phase measurements without normalisation to exposure time. In multiple exposure mode, the lack of normalisation may lead (depending on the chosen exposure times) to inhomogeneous amplitude image impression, if a certain pixel is taken from the short exposure time and some of its neighbours are not.

Invalid PMD pixels (e.g. due to saturation) have an amplitude value of 0.

Data type: 16-bit unsigned integerGRAYSCALE_IMAGE 104 Each pixel of the amplitude matrix denotes the amount of

modulated light which is reflected by the appropriate object (i.e. the light from the camera's active illumination). Higher values indicate higher PMD signal strengths and thus a lower amount of noise on the corresponding distance measurements. The amplitude value is directly derived from the PMD phase measurements without normalisation to exposure time.

Cámara 3D

28


CARTESIAN_X_COMPONENT

200 The X matrix denotes the X component of the Cartesian coordinate of a PMD 3D measurement. The origin of the camera's coordinate system is in the middle of the lens' front glass, if the extrinsic parameters are all set to 0.

Data type: 16-bit signed integer

Unit: millimetresCARTESIAN_Y_COMPONENT

201 The Y matrix denotes the Y component of the Cartesian coordinate of a PMD 3D measurement. The origin of the camera's coordinate system is in the middle of the lens' front glass, if the extrinsic parameters are all set to 0.


Unit: millimetresCARTESIAN_Z_COMPONENT

202 The Z matrix denotes the Z component of the Cartesian coordinate of a PMD 3D measurement. The origin of the camera's coordinate system is in the middle of the lens' front glass, if the extrinsic parameters are all set to 0.


Unit: millimetresCARTESIAN_ALL 203 CARTESIAN_X_COMPONENT,

CARTESIAN_Y_COMPONENT, CARTESIAN_Z_COMPONENT

UNIT_VECTOR_ALL 223 The unit vector matrix contains 3 values [ex, ey, ez] for each PMD pixel, i.e. the data layout is [ex_1,ey_1,ez_1, ... ex_N, ey_N, ez_N], where N is the number of PMD pixels.

Data type: 32-bit floating point number (3x per pixel)CONFIDENCE_IMAGE 300 See Additional Information for Image Data (→ 14.3.4)DIAGNOSTIC 302 See Receiving Images (→ 14.3.2)JSON_DIAGNOSTIC 305 Items with JSON formatted diagnostic data is formated like this:

{

"AcquisitionDuration": 20.391,

"EvaluationDuration": 37.728,

"FrameDuration": 37.728,

"FrameRate": 15.202,

"TemperatureIllu": 52.9

}

Unit for durations: millimetres

Unit for framerates: Hz

Unit for temperature: °C

29

Cámara 3D

ES


EXTRINSIC_CALIB 400 The transformation from one cartesian coordinate system to another is defined by a 6 degrees of freedom vector (DOF): [trans_x, trans_y, trans_z, rot_x, rot_y, rot_z]. Let R be the product of the common "clockwise" 3D-rotation matrices: R = Rx*Ry*Rz

The transformation of a point P is specified by P_t = R*P + [trans_x, trans_y, trans_z]'.

The device extrinisic calibration can be set by the user, but it may be changed by an automatic calibration feature of the device.

Data type: 32-bit floating point number (little endian)

Unit for trans_x, trans_y, trans_z: millimetres

Unit for rot_x, rot_y, rot_z: °JSON_MODEL 500 Model data in JSONMODEL_ROIMASK 501 ROI mask for internal debugging purposesSNAPSHOT_IMAGE 600 Snapshot image

Pixel format:


FORMAT_8U 0 8-bit unsigned integerFORMAT_8S 1 8-bit signed integerFORMAT_16U 2 16-bit unsigned integerFORMAT_16S 3 16-bit signed integerFORMAT_32U 4 32-bit unsigned integerFORMAT_32S 5 32-bit signed integerFORMAT_32F 6 32-bit floating point numberFORMAT_64U 7 64-bit unsigned integerFORMAT_64F 8 64-bit floating point numberReserved 9 N/AFORMAT_32F_3 10 Vector with 3x32-bit floating point number

Cámara 3D

30

14.3.4 Additional Information for CONFIDENCE_IMAGEFurther information for the confidence image:

Bit Value Description

0 1 = pixel invalid Pixel invalid

The pixel is invalid. To determine whether a pixel is valid or not only this bit needs to be checked. The reason why the bit is invalid is recorded in the other confidence bits.

1 1 = pixel saturated Pixel is saturated

Contributes to pixel validity: yes2 1 = bad A-B symmetry A-B pixel symmetry

The A-B symmetry value of the four phase measurements is above threshold.

Remark: This symmetry value is used to detect motion artefacts. Noise (e.g. due to strong ambient light or very short integration times) or PMD interference may also contribute.

Contributes to pixel validity: yes3 1 = amplitude below

minimum amplitude threshold

Amplitude limits

The amplitude value is below minimum amplitude threshold.

Contributes to pixel validity: yes4+5 Bit 5, bit 4

0 0 = unused

0 1 = shortest exposure time (only used in 3 exposure mode)

1 0 = middle exposure time in 3 exposure mode, short exposure in double exposure mode

1 1 = longest exposure time (always 1 in single exposure mode)

Exposure time indicator

The two bits indicate which exposure time was used in a multiple exposure measurement.

Contributes to pixel validity: no

6 1 = pixel is clipped Clipping box on 3D data

If clipping is active this bit indicates that the pixel coordinates are outside the defined volume.

Contributes to pixel validity: yes7 1 = suspect/defective pixel Suspect pixel

This pixel has been marked as "suspect" or "defective" and values have been replaced by interpolated values from the surroundings.

Contributes to pixel validity: no

31

Cámara 3D

ES

14.3.5 Configuration of PCIC OutputThe user has the possibility to define his own PCIC output. This configuration is only valid for the current PCIC connection. It does not affect any other connection and will get lost after disconnecting.

For configuring the PCIC output a “flexible” layouter concept is used, represented by a JSON string. The format of the default configuration is as follows:

{

"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" }

]

}

This string can be retrieved by the C? command, altered and sent back using the c command.

The layout software has the following main object properties:

Name Description Details

layouter Defines the basic data output format.

So far only “flexible” is supported

Type: string

format Defines format details, the definitions in the main object are the defaults for any of the following data elements (e.g. if it says dataencoding=binary, all data elements should be binary encoded instead of ASCII).

Type: object

elements List of data elements which must be written. Type: array of objects

The actual data is defined within the “elements” properties and may consist of these settings:

Name Description Details

type Defines the type of data which must be written.

The data might be stored in a different type (e.g. stored as integer but should be output as Float32)

The type "records" will need some special handling.

Type: string

id Defines an identifier for this data element.

If there is no fixed value (property "value"), the data should be retrieved via id.

Type: string

value Optional property for defining a fixed output value. Type: any JSON valueformat Type-depending option for fine-tuning the output format.

E.g. cut an integer to less than 4 bytes.

Type: object

Cámara 3D

32

Available values for the type property:

Type Description

records Defines that this element represents a list of records.

If type is set to "records", there must be an "elements" property.

The "elements" property defines which data should be written per record.string Data is written as string.

Most of the time this will be used with "value" property to write fixed start, end or delimiter text.

Text encoding should be UTF8 if there is nothing else specified in format properties.float32 Data is written as floating point number.

This has a lot of formatting options (at least with "flexible" layout software)

See following section about format properties.uint32 Data is written as integer.


See following section about format properties.int32 Data is written as integer.


See following section about format properties.uint16 Limits the output to two bytes in binary encoding, besides the binary limitation it acts like

uint32.int16 Limits the output to two bytes in binary encoding, besides the binary limitation it acts like

int32.uint8 Limits the output to one byte in binary encoding, besides the binary limitation it acts like

uint32.int8 Limits the output to one byte in binary encoding, besides the binary limitation it acts like

int32.blob Data is written as a BLOB (byte by byte as if it came from the data provider).

(Binary Large Object)

Depending on the desired data format the user may tune his output data with further “format” properties.

Common format properties:

Format properties

Allowed values Default

dataencoding "ascii" or "binary" can be defined in top-level-object and overwritten by element objects.

"ascii"

scale "float value with decimal separator" to scale the results for output byte width

1.0

offset "float value with decimal separator" 0.0

Binary format properties:

Format properties Allowed values Default

order Little, big and network Little

33

Cámara 3D

ES

ASCII format properties:

Format properties Allowed values Default

width Output width. If the resulting value exceeds the width field the result will not be truncated.

0

fill Fill character " "precision Precision is the number of digits behind the decimalseparator. 6 displayformat Fixed, scientific Fixedalignment Left, right Rightdecimalseparator 7-bit characters for e.g. "." "."base Defines if the output should be:

● binary (2)

● octal (8)

● decimal (10)

● hexadecimal (16)

10

Example of a format configuration of the temperature (id: temp_illu) element.

1. Illumination temperature like this "33,5___":

c000000226{ "layouter": "flexible", "format": { "dataencoding": "ascii" }, "elements": [ { "type": "float32", "id": "temp_illu", "format": { "width": 7, "precision": 1, "fill": "_", "alignment": "left", "decimalseparator": "," } } ] }

2. Illumination temperature as binary (16-bit integer, 1/10 °C):

c000000194{ "layouter": "flexible", "format": { "dataencoding": "ascii" }, "elements": [ { "type": "int16", "id": "temp_illu", "format": { "dataencoding": "binary", "order": "network", "scale": 10 } } ] }

3. Illumination temperature in °F (e.g. "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" } ] }

Cámara 3D

34

The following element IDs are available:

ID Description Native data type

activeapp_id Active application, shows which of the 32 application-configurations is currently active

32-bit unsigned integer

all_cartesian_vector_matrices

All Cartesian images (X+Y+Z) concatenated to one package

16-bit signed integer

all_unit_vector_matrices Matrix of unit vectors. Each element consists of a 3 component vector [e_x, e_y, e_z]

Float32

amplitude_image PMD raw amplitude image 16-bit unsigned integer

confidence_image Confidence image 8-bit unsigned integer

distance_image Radial distance image 16-bit unsigned integer unit: millimetres

evaltime Evaluation time for current frame in milliseconds 32-bit unsigned integer

extrinsic_calibration Extrinsic calibration, constisting of 3 translation parameters (unit: millimeters) and 3 angles (unit: degree): [t_x, t_y, t_z, alpha_x, alpha_y, alpha_z]

Float32

framerate Current frame rate in Hz Float32normalized_amplitude_image

Normalized amplitude image 16-bit unsigned integer

temp_front1 Invalid temperature, the output is 3276.7 Float32, unit: °Ctemp_illu Temperature measured in the device while capturing this

result

Measured on the illumination board

Float32, unit: °C

x_image y_image z_image

Cartesian coordinates for each pixel Each dimension is a separate image

16-bit signed integer

35

Cámara 3D

ES

For the main object on devices with statistics feature the following IDs are available:

ID Description Native data type

statistics_overall_count Allows the user to output the statistics value with the result of the frame, maps to ModelResults:

adv_statistics.number_of_frames

uint32

statistics_passed_count Allows the user to output the statistics value with the result of the frame, maps to ModelResults:

adv_statistics.number_of_passed_frames

uint32

statistics_failed_count Allows the user to output the statistics value with the result of the frame, maps to ModelResults:

adv_statistics.number_of_failed_frames

uint32

statistics_aborted_count Allows the user to output the statistics value with the result of the frame, maps to ModelResults:

adv_statistics.number_of_aborted_frames

uint32

statistics_acquisition_time_min Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_acquisition.min

float32

statistics_acquisition_time_mean Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_acquisition.mean

float32

statistics_acquisition_time_max Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_acquisition.max

float32

statistics_evaluation_time_min Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_evaluation.min

float32

statistics_evaluation_time_mean Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_evaluation.mean

float32

statistics_evaluation_time_max Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_evaluation.max

float32

statistics_frame_duration_min Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_duration.min

float32

statistics_frame_duration_mean Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_duration.mean

float32

statistics_frame_duration_max Allows the user to output the statistics value with the result of the frame,maps to ModelResults:

adv_statistics.frame_duration.max

float32

Cámara 3D

36

14.4 Process Interface Command ReferenceAll received messages which are sent because of the following commands will be sent without “start”/”stop” at the beginning or ending of the string.

14.4.1 a Command (activate application)

Command a<application number>

Description Activates the selected application

Type ActionReply *

! ● Application not available

● <application number> contains wrong value

● External application switching activated

● Device is in an invalid state for this command, e.g. configuration mode

? Invalid command lengthNote <application number>

2 digits for the application number as decimal value

14.4.2 A? Command (occupancy of application list)Command A?

Description Requests the occupancy of the application list

Type RequestReply <amount><t><number active

application><t>

...

<number><t><number>? Invalid command length! Invalid state (e.g. no application

active)Note <amount>

char string with 3 digits for the amount of applications saved on the device as decimal number

<t>

tabulator (0x09)

<number active application>

2 digits for the active application

<number>

2 digits for the application number

The active application is repeated within the application list.

37

Cámara 3D

ES

14.4.3 c Command (upload PCIC output configuration)

Command c<length><configuration>

Description Uploads a PCIC output configuration lasting this session

Type ActionReply *

! ● Error in configuration

● Wrong data length? Invalid command length

Note <length>

9 digits as decimal value for the data length

<configuration>

configuration data

14.4.4 C? Command (retrieve current PCIC configuration)Command C?

Description Retrieves the current PCIC configuration

Type RequestReply <length><configuration>

? Invalid command lengthNote <length>

9 digits as decimal value for the data length

<configuration>

configuration data

14.4.5 E? Command (request current error state)Command E?

Description Requests the current error stateType RequestReply <code>

! Invalid state (e.g. configuration mode)? Invalid command length

Note ● <code> Error code with 8 digits as a decimal value. It contains leading zeros.

Cámara 3D

38

14.4.6 G? Command (request device information)Command G?

Description Requests device informationType RequestReply <vendor><t><article number><t>

<name><t><location><t><description><t><ip>

<subnet mask><t><gateway><t><MAC><t><DHCP><t><port number>

Note ● <vendor> IFM ELECTRONIC

● <t> Tabulator (0x09)

● <article number> e.g. O3D300

● <name> UTF8 Unicode string

● <location> UTF8 Unicode string

● <description> UTF8 Unicode string

● <ip> IP address of the device as ASCII character sting e.g. 192.168.0.96

● <port number> port number of the XML-RPC

● <subnet mask> subnet mask of the device as ASCII e.g. 192.168.0.96

● <gateway> gateway of the device as ASCII e.g 192.168.0.96

● <MAC> MAC adress of the device as ASCII e.g. AA:AA:AA:AA:AA:AA

● <DHCP> ASCII string "0" for off and "1" for on

39

Cámara 3D

ES

14.4.7 H? Command (return a list of available commands)

Command H?

Description Returns a list of available commands

Type RequestReply H? - show this list

t - execute Trigger

T? - execute Trigger and wait for data

o<io-id><io-state> - sets IO state

O<io-id>? - get IO state

I<image-id>? - get last image of defined type

A? - get application list

p<state> - activate / deactivate data output

a<application number> - set active application

E? - get last error

V? - get current protocol version

v<version> - sets protocol version

c<length of configuration file><configuration file> - configures process date formatting

C? - show current configuration

G? - show device information

S? - show statistics

L? - retrieves the connection ID

f<id><reserved><value> - set parameter value

Cámara 3D

40

14.4.8 I? Command (request last image taken)Command I<image-ID>?

Description Request last image takenType RequestReply <length><image data>

! ● No image available

● Wrong ID? ● Invalid command length

Note <image-ID>

2 digits for the image type

<length>

char string with exactly 9 digits as decimal number for the image data size in bytes

<image data>

image data

Valid image ID:

01 - amplitude image

02 - normalised amplitude image

03 - distance image

04 - X image (distance information)

05 - Y image (distance information)

06 - Z image (distance information)

07 - confidence image (status information)

08 - extrinsic calibration

09 - unit_vector_matrix_ex, ey,ez

10 - last result output as formatted for this connection

11 - all distance images: X, Y, and Z

14.4.9 o Command (set logic state of a ID)Command o<IO-ID><IO-state>

Description Sets the logic state of a specific IDType ActionReply *

! Invalid state (e.g. configuration mode)? Invalid command length

Note ● <IO-ID> 2 digits for digital output: "01" for IO1 "02" for IO2 "03" for IO3

● <IO-state> 1 digit for the state: "0" for logic state low "1" for logic state high

41

Cámara 3D

ES

14.4.10 O? Command (request state of a ID)Command O<IO-ID>?

Description Requests the state of a specific IDType RequestReply <IO-ID><IO-state>

! ● Invalid state (e.g. configuration mode)

● Wrong ID? Invalid command length

Note ● <IO-ID> 2 digits for digital output: "01" for IO1 "02" for IO2 "03" for IO3

● <IO-state> 1 digit for the state: "0" for logic state low "1" for logic state high

The camera supports ID 1 and ID 2.

The sensor supports ID 1, ID 2 and ID 3.

14.4.11 p Command (turn PCIC output on or off)Command p<state>

Description Turns the PCIC output on or offType ActionReply *

! <state> contains wrong value? Invalid command length

Note <state> 1 digit

0: deactivates all asynchronous output

1: activates asynchronous result output

2: activates asynchronous error output

3: activates asynchronous error and data output

4: activates asynchronous notifications

5: activates asynchronous notifications and asynchronous result

6: activates asynchronous notifications and asynchronous error output

7: activates all outputs

On device restart the value configured within the application is essential for the output of data.

This command can be executed in any device state.

By default the error codes will not be provided by the device.

Cámara 3D

42

14.4.12 S? Command (request current decoding statistics)

Command S?

Description Requests current decoding statistics

Type RequestReply <number of

results><t><number of positive decodings><t><number of false decodings>! No application active

Note <t>

tabulator (0x09)

<number of results>

Images taken since application start. 10 digits decimal value with leading 0s

<number of positive decodings>

Number of decodings leading to a positive result. 10 digits decimal value with leading 0s

<number of false decodings>

Number of decodings leading to a negative result. 10 digits decimal value with leading 0s

14.4.13 t Command (execute asynchronous trigger)Command t

Description Executes trigger. The result data is send asynchronously

Type ActionReply * Trigger was executed, the device

captures an image and evaluates the result.

! ● Device is busy with an evaluation


● Device is set to a different trigger source

● No active application

43

Cámara 3D

ES

14.4.14 T? Command (execute synchronous trigger)

Command T?

Description Executes trigger. The result data is send synchronously

Type RequestReply Process data within the

configured layoutTrigger was executed, the device captures an image, evaluates the result and sends the process data.

! ● Device is busy with an evaluation


● Device is set to a different trigger source

● No active application

14.4.15 v Command (set current protocol version)

Command v<version>

Description Sets the current protocol version. The device configuration is not affected

Type ActionReply *

! Invalid version? Invalid command length

Note <version>

2 digits for the protocol version

(→ 14.3.1)

The default protocol version is „V3“.

14.4.16 V? Command (request current protocol version)Command V?

Description Requests current protocol version

Type RequestReply <current version><empty><min

version><empty><max version>Note <current version>

2 digits for the currently set version

<empty>

space sign: 0x20

<min/max version>

2 digits for the available min and max version that can be set

Cámara 3D

44

14.5 Error codesBy default the error codes will not be provided by the device. The p command can activate their provision (→ 14.4.11).

Error code ID Description

100000001 Maximum number of connections exceeded 110001001 Boot timeout110001002 Fatal software error110001003 Unknown hardware110001006 Trigger overrun110002000 Short circuit on Ready for Trigger110002001 Short circuit on OUT1110002002 Short circuit on OUT2110002003 Reverse feeding110003000 Vled overvoltage110003001 Vled undervoltage110003002 Vmod overvoltage110003003 Vmod undervoltage110003004 Mainboard overvoltage110003005 Mainboard undervoltage110003006 Supply overvoltage110003007 Supply undervoltage110003008 VFEMon alarm110003009 PMIC supply alarm110004000 Illumination overtemperature

45

Cámara 3D

ES

14.6 XML-RPC Command Reference

14.6.1 Parameter APIThe parameters setParameter, getParameter, getAllParameters and getAllParameterLimits are implemented in the following RPC objects:

● Device

● Network

● Application

● ImagerConfig

● Filter

● Model

setParameterMethod name setParameter

Description Sets a parameter to a specific valueInput parameters 1. Name of parameter:string

2. New value: stringOutput parameters Empty string (compatibility with classic XmlRPC client)

getParameterMethod name getParameter

Description Returns the current value of the parameterInput parameters Name of parameter: stringOutput parameters Value of parameter: string

getAllParametersMethod name getAllParameters

Description Returns all parameters of the object in one data structureInput parameters NoneOutput parameters 1. Struct (name contains the parameter name, value contains the

stringified parameter value)

getAllParameterLimitsMethod name getAllParameterLimits

Description Returns limits of all numeric parameters, that have limits defined on the device

Input parameters NoneOutput parameters 1. Struct of Structs (name in first struct is the parameter name,

substructs contains: min :string, max :string)

E.g.

{"ExposureTime1": { "min": "123", "max": "432" }, "ExposureTime2": { "min": "123", "max": "432" }}

Cámara 3D

46

Parameter string encodingNon-string parameters must be encoded in the following format.

Type Stringified

bool "true" / "false"

setParameter method also accepts "1"/"0", getter methods must always return "true"/"false"

int decimal ( e.g "-1234" / "1234" )

Values should be in the range of int32 (-2^31 .. 2^31)double English floating point notation (optional with exponent)

E.g. "1.2", ".3", "4.5e6", "-7E-8", "-inf", "nan"

Structured types (array or structs) can't be put into parameter storage in an general way. Encoding of arrays must specified on specific parameters.

14.6.2 Main Object

getParameterMethod name getParameter

Description Getter for the device-global parametersInput parameters Name of a device parameter: stringOutput parameters Value of the requested parameter: string

getAllParametersMethod name getAllParameters

Description Getter for the parameters described here.

This is an additional getter outside of edit sessions, so it is possible to read device information without login.

Input parameters noneOutput parameters Struct (name contains the parameter name, value contains the

stringified parameter value)

47

Cámara 3D

ES

getSWVersionMethod name getSWVersion

Description Returns version information of all software componentsInput parameters noneOutput parameters Struct of strings (e.g. { "IFM_Software": "0.01.07", "Frontend":

"01.05.02", ... } )

*mandatory keys:

"IFM_Software"

"Linux"

"Main_Application"

"Diagnostic_Controller"

"Algorithm_Version"

"Calibration_Version"

"Calibration_Device"

getHWInfoMethod name getHWInfo

Description Returns hardware information of all componentsInput parameters noneOutput parameters Struct of strings ( e.g. { "MACAddress": "00:02:01:40:06:C9",

"Frontend": "#!01_F340_001_...", ... } )

*mandatory keys:

"MACAddress"

"Connector"

"Diagnose"

"Frontend"

"Illumination"

"Mainboard"

getApplicationListMethod name getApplicationList

Description Delivers basic information of all applications stored on the device.Input parameters noneOutput parameters Array of structs (Index: int, Id: int, Name: string, Description: string)

Cámara 3D

48

requestSessionMethod name requestSession

Description Requests a session object for access to the configuration and for changing the device operating mode.

This blocks parallel editing and allows protection of editing with a password.

The ID could optionally be defined by the external system but it must be the defined format (32char "hex").

If it is called with only one parameter, the device will generate a session ID.

The session will start with a default timeout ("SessionTimeout" device parameter), the timeout can be extended by calling "heartbeat".

The device will stay in RUN mode.

If password is disabled on the device, the value given as password parameter is ignored.

Input parameters 1. Password: string

2. Session ID: string (optional)Output parameters Session ID: string

rebootMethod name reboot

Description Reboot system, parameter defines which mode/system will be booted

Input parameters Type of system that should be booted after shutdown: int

0: Productive mode

1: Recovery modeOutput parameters Output: string

systemCommandMethod name systemCommand

Description Performs a generic command on the device.Input parameters 1. Command: string

2. Parameter: stringOutput parameters Output: string

49

Cámara 3D

ES

14.6.3 Session Object

heartbeatMethod name heartbeat

Description Extends the life time of the edit session.

If the given value is outside the range of "SessionTimeout", the saved default timeout will be used.

Input parameters Requested timeout interval till next heartbeat, in seconds: intOutput parameters The used timeout interval, in seconds: int

cancelSessionMethod name cancelSession

Description Explicit stop of this session

If an application is still in edit mode, it will implicitly do the same as "stopEditingApplication".

Input parameters noneOutput parameters Empty string (compatibility with classic XmlRPC client)

exportConfigMethod name exportConfig

Description Exports the whole configuration of the sensor deviceInput parameters noneOutput parameters Configuration as a data BLOB: binary/base64

importConfigMethod name importConfig

Description Imports whole configuration with the option to skip specific partsInput parameters 1. Configuration as a data BLOB: binary/base64

2. Flags describing which parts should be loaded:

0x0001: Includes configuration (Name, Description, Location, ...)

0x0002: Includes network configuration (IP, DHCP, ...)

0x0010: Includes all application configurationsOutput parameters Empty string (compatibility with classic XmlRPC client)

exportApplicationMethod name exportApplication

Description Exports one application configInput parameters Application indexOutput parameters Application config as a data BLOB: binary/base64

Cámara 3D

50

importApplicationMethod name importApplication

Description Imports an application config and creates a new application with it.

The device will put the new application on the first free index.Input parameters Application config as one data BLOB: binary/base64Output parameters Index of new application

setOperatingModeMethod name setOperatingMode

Description Changes the operating mode of the device.

Setting this to "edit" will enable the "edit mode object” on RPC.Input parameters Mode: integer

0: Run mode

1: Edit modeOutput parameters Empty string (compatibility with classic XmlRPC client)

setTemporaryApplicationParametersMethod name setTemporaryApplicationParameters

Description Set application parameters in run mode.

The parameter names follow a prefix scheme similarly to the object hierarchy within the XMLRPC interface. For example

● parameters of the application object have no prefix,

● parameters of the imager configuration object have the prefix "imager_001/",

● parameters of the model with ID 2 have the prefix "model_002/"

The parameters "imager_001/ExposureTime", "imager_001/ExposureTimeRatio" and "imager_001/Channel" of the imager configuration are supported. All additional parameters are ignored.

If a parameter appears more than once in the parameter list, the behavior is undefined which value is chosen for the parameter. Exposure times are clamped to their allowed range, depending on the exposure mode.

The complete set of parameters depending on the exposure mode must be provided. For example

● "ExposureTime" only for single exposure modes,

● "ExposureTime" and "ExposureTimeRatio" for double exposure modes.

Otherwise the behavior is undefined. "Channel" parameter values outside of the allowed range of the used exposure mode are ignored, and for non-numeric values the behavior is undefined.

Example: setTemporaryApplicationParameters [{"imager_001/ExposureTime":"100"}]

Input parameters Parameter list (struct containing key value pairs, consisting of keys: parameter names and values: new parameter values)

Output parameters Empty string (compatibility with classic XmlRPC client)

The changes are not persistent and are lost when entering edit mode or turning the device off.

51

Cámara 3D

ES

14.6.4 Edit Mode Object

factoryResetMethod name factoryReset

Description Resets all configurations to factory settingsInput parameters noneOutput parameters Empty string (compatibility with classic XmlRPC client)

A factory reset will delete all applications which are saved on the camera.

editApplicationMethod name editApplication

Description Puts a specified application into the edit status.

This will attach an application object to the RPC interface.

The name of the object will be application independent.

This does not change the "ActiveApplication" parameter.Input parameters Application index: intOutput parameters Empty string (compatibility with classic XmlRPC client)

stopEditingApplicationMethod name stopEditingApplication

Description Tells the device that editing this application was finished.

Unsaved changes are discarded.Input parameters noneOutput parameters Empty string (compatibility with classic XmlRPC client)

createApplicationMethod name createApplication

Description Creates an "empty" application. The embedded side should initialise all needed parameters and structures.

Input parameters noneOutput parameters Index of new application: int

Cámara 3D

52

copyApplicationMethod name copyApplication

Description Creates a new application by copying the configuration of another application.

The device will generate an ID for the new application and put it on a free index.

Input parameters Index of the application which should be copied: intOutput parameters Index of new application: int

deleteApplicationMethod name deleteApplication

Description Deletes the application from sensor

If the deleted application was the active one, the sensor will have no active application anymore until the user picks one.

Input parameters Index of application: intOutput parameters Empty string (compatibility with classic XmlRPC client)

moveApplicationsMethod name moveApplications

Description Moves applications to other index.

There must be all applications in the new list, none of them duplicated and no index used twice.

The ID is a fixed value that stays the same as long as the application stays on the sensor.

The index could be changed and is used to address the application via PCIC, XML-RPC and digital IO.

Input parameters Array of structs (Id: int, Index: int)Output parameters Empty string (compatibility with classic XmlRPC client)

14.6.5 Device Config Object

activatePasswordMethod name activatePassword

Description Sets a password and activates it for the next edit session.

Making this change persistently requires to call "save" on device config.

Input parameters Password: stringOutput parameters Empty string (compatibility with classic XmlRPC client)

53

Cámara 3D

ES

disablePasswordMethod name disablePassword

Description Disables the password protection.

Making this change persistently requires to call "save" on device config.


saveMethod name save

Description Stores current configuration in persistent memory.

If this is not called after changing device parameters (via setParameter), changes will get lost on reboot.


Parameters of device configMethods for parameter access are defined here:

Parameter name Data type Description

Name String (utf8) User-defined name of the device (max. 64 characters).Description String (utf8) User-defined description of the device

(max. 500 characters).ActiveApplication Int

*has limits

Index of active application

This applies only to RUN mode:

* defines the application active on startup (if static-application switching is disabled)

* contains the current active application (could also be changed via PCIC command)

* 0 means no application is activePcicTcpPort Int TCP/IP port for PCIC connections.PcicProtocolVersion Int

*has limits

Sub-protocol of PCIC, see specification of PCIC.

IOLogicType Int

*has limits

Defines logic type of all digital pins.

Allowed values:

0: NPN

1: PNPIODebouncing Bool Applies to all inputsIOExternApplicationSwitch Int

*has limits

Allowed values:

0: off

1: static via I/O

2: pulse driven via I/O

3: pulse driven via trigger

Cámara 3D

54


SessionTimeout Int

*has limits

Number of seconds which a session stays before a call to "heartbeat" method is needed

ServiceReportFailedBuffer Int

*has limits

Number of buffers reserved for failed results

ServiceReportPassedBuffer Int

*has limits

Number of buffers reserved for passed results

ExtrinsicCalibTransX Double

Unit: millimetres

Extrinsic calibration, transition in X direction

ExtrinsicCalibTransY Double

Unit: millimetres

Extrinsic calibration, transition in Y direction

ExtrinsicCalibTransZ Double

Unit: millimetres

Extrinsic calibration, transition in Z direction

ExtrinsicCalibRotX Double

Unit: degrees

Extrinsic calibration, rotation around X axis

ExtrinsicCalibRotY Double

Unit: degrees

Extrinsic calibration, rotation around Y axis

ExtrinsicCalibRotZ Double

Unit: degrees

Extrinsic calibration, rotation around Z axis

IPAddressConfig Int readonly: The GUI requires to know if the device is on a discovery IP address for multiple-use cases. This information was extended to reflect all kinds of IP-address situations.

Allowed values:

0: Static (IP address explicitly defined inside the device)

1: DHCP (using a DHCP server in the network)

2: LinkLocal (configured to DHCP, but no server which provided an address)

3: Discovery (changed by IP4Discovery mechanism)PasswordActivated Bool readonly: Is true if the password protection is enabledOperatingMode Int readonly: Mode of device (RUN, EDIT)

see "setOperatingMode" (the setter is outside the edit mode but inside session)

DeviceType String readonly: Delivers a type description, unique by imager, evaluation logic and device interface.

ArticleNumber String readonly: Official catalogue numberArticleStatus String readonly: Official two-letter status codeUpTime Double readonly: Hours since last rebootImageTimestampReference Int

Unit: microseconds

readonly: This returns the current timestamp as a reference for the timestamps in the received images.

TemperatureFront1 Double

Unit: celsius

Invalid temperature, the output is 3276.7

55

Cámara 3D

ES


TemperatureFront2 Double

Unit: celsius

Invalid temperature, the output is 3276.7

TemperatureIllu Double

Unit: celsius

readonly: Temperature measured in the device.

Measured on the illumination board.

*has limits: parameters with this marker are listed in the reply of getAllParameterLimits method.

Default values of device config parametersThe default values of the device configuration parameters are:


Name String (utf8) "New sensor"Description String (utf8) ""ActiveApplication Int

*has limits

0

PcicTcpPort Int 50010PcicProtocolVersion Int

*has limits

3

IOLogicType Int

*has limits

1

IODebouncing Bool trueIOExternApplicationSwitch Int

*has limits

0

SessionTimeout Int

*has limits

30

ExtrinsicCalibTransX Double

Unit: millimetres

0.0

ExtrinsicCalibTransY Double

Unit: millimetres

0.0

ExtrinsicCalibTransZ Double

Unit: millimetres

0.0

ExtrinsicCalibRotX Double

Unit: degrees

0.0

ExtrinsicCalibRotY Double

Unit: degrees

0.0

ExtrinsicCalibRotZ Double

Unit: degrees

0.0

IPAddressConfig Int 0PasswordActivated Bool falseOperatingMode Int 0ServiceReportFailedBuffer Int 15ServiceReportPassedBuffer Int 15

For all other device config parameters there are no defined default values because they are either device-dependent (DeviceType, ArticleNumber, ArticleStatus) or volatile (UpTime, ImageTimestampReference).

Cámara 3D

56

Minimum and maximum values of device config parametersThe minimum and maximum values of the device configuration parameters are:

Parameter name Minimum value Maximum value

ActiveApplication 0 32PcicProtocolVersion 1 4IOLogicType 0 1IOExternApplicationSwitch 0 3SessionTimeout 5 300

14.6.6 Device/Network Config Object

saveAndActivateConfigMethod name saveAndActivateConfig

Description Reinitialise the network interface so that it uses the configuration which was set by the other RPC methods.

There will be no XMLRPC reply because the network interface is instantly reset.


14.6.7 Application Config Object

saveMethod name save

Description Stores current configuration in persistent memory.

This is also be possible if the application is not yet in an "activatable" status.


forceTriggerMethod name forceTrigger

Description Executes a software trigger of currently active application.Input parameters noneOutput parameters Empty string (compatibility with classic XmlRPC client)

ValidateMethod name validate

Description Validates the application. This means it checks if the application can be activated.

Input parameters noneOutput parameters Array of fault structs (Id: int, Text: string)Fault scenarios none

57

Cámara 3D

ES

Parameters of applicationMethods for parameter access are defined here:


Name String (utf8) User-defined name of the application (max. 64 characters).

Description String (utf8) User-defined description of the application (max. 500 characters).

TriggerMode Int

*has limits

Allowed values:

1: free run

2: process interface

3: positive edge

4: negative edge

5: positive and negative edgePcicTcpResultSchema String It defines which images and result data will be sent.

It will also define the order of data elements and additional separators.

Contains single-enabling/disabling of AmplitudeImage, IntensityImage, DistanceImage, XImage, YImage, ZImage, ConfidenceImage, DiagnosticData (→ 14.3.5)

LogicGraph String JSON string describing a flow graph which allows to program the logic between model results and output pins.

Type String Internal useTemplateInfo String A generic JSON storage, where the GUI could store

additional data about the used template GUI (versions and additional parameter decisions).

This data should not be used by the device, it should only be stored on the device.

*has limits: parameters with this marker are listed in the reply of getAllParameterLimits method

Default values of application parametersThe default values of application parameters are:


Name String (utf8) "new application"Description String (utf8) ""TriggerMode Int

*has limits

1

PcicTcpResultSchema String ""LogicGraph String ""Type String "Camera"TemplateInfo String ""

Cámara 3D

58

Minimum and maximum values of application parametersThe minimum and maximum values of application parameters are:


TriggerMode 1 5

14.6.8 Application/Imager Config Object

changeTypeMethod name changeType

Description Changes the type of imager configuration.

This changes setting of available parameters and might also change available RPC methods.

Input parameters Type: stringOutput parameters Empty string (compatibility with classic XmlRPC client)

availableTypesMethod name availableTypes

Description Lists all available imager configuration types.Input parameters noneOutput parameters Array of strings

Parameters of all types of application imager configMethods for parameter access are defined here:


Type String readonly: Type of imager configuration, see Change Type Method

FrameRate Double

*has limits

Target frame rate in frames per second for free run mode.

ClippingLeft Double

*has limits

Lower value of clipping area in width

ClippingTop Double

*has limits

Lower value of clipping area in height

ClippingRight Double

*has limits

Upper value of clipping area in width

ClippingBottom Double

*has limits

Upper value of clipping area in height

ContinuousAutoExposure Bool Enables the continuous adaptation of the integration time during decoding

59

Cámara 3D

ES


SpatialFilterType Int

*has limits

Allowed values:

0: off

1: median filter

2: mean filter

3: bilateral filterTemporalFilterType Int

*has limits

Allowed values:

0: off

1: temporal mean filter

2: adaptive exponential filterEnableFilterDistanceImage Bool Activates the filter for the distance imageEnableFilterAmplitudeImage Bool Activates the filter for the amplitude imageSymmetryThreshold Double

*has limitsMinimumAmplitude Double

*has limits

Defines the minimum amplitude used for the validity of a pixel.

TwoFreqMaxLineDistPercentage Double

*has limitsThreeFreqMax2FLineDistPercentage Double

*has limitsThreeFreqMax3FLineDistPercentage Double

*has limitsEnableAmplitudeCorrection Bool Enables the correction of the amplitude valuesEnableRectificationDistanceImage Bool Enables the rectification of the distance imageEnableRectificationAmplitudeImage Bool Enables the rectification of the normalized

amplitude imageExposureTimeList String readonly: A list of all current exposure times

separated by ";"

It should contain 3 values in "*_high" types, 2 values in "*_moderate" types and 1 value in "*_low" types. The list is sorted in ascending order.

MaxAllowedLEDFrameRate Double

readonly

Maximum allowed frame rate for current settings, which complies with the LED duty cycle

Resolution Int

*has limits

Resolution of output image:

0: 176 x 132 (2x2 binning)

1: 352 x 264 (no binning), only available for 100k camera

EnableFastFrequency Bool Enables rolling evaluation in multi-frequency modes (parameter will be ignored in single-frequency modes)

ClippingCuboid JSON Object describing the clipping cuboid

Cámara 3D

60


AutoExposureReferenceType Int

*has limits

Select part of the image to be used for continuous autoexposure:

0: whole image

1: ROIs (→ AutoExposureReferenceROI)

2: Reference Point (→ AutoExposureReferencePointX and AutoExposureReferencePointY)

AutoExposureReferenceROI String ROI definition for AutoExposureReferenceType "1"AutoExposureReferencePointX Int

*has limits

X coordinate of reference point used for AutoExposureReferenceType "2"

AutoExposureReferencePointY Int

*has limits

Y coordinate of reference point used for AutoExposureReferenceType "2"

AutoExposureMaxExposureTime Int

*has limits

Maximum exposure time that should be used when continuous autoexposure is activated (→ AutoExposureReferenceType)

*has limits: parameters with this marker are listed in the reply of getAllParameterLimits method

Default values of common imager config parametersThe default values of the common imager configuration parameters are:


Type String "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 falseResolution Int 0EnableFastFrequency Bool falseClippingCuboid String '{"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 String '{"ROIs":[{"id":0,"group":0, "type":"Rect",

"width":130, "height":100, "angle":0, "center_x":88, "center_y":66}]}'

AutoExposureReferencePointX Int 88AutoExposureReferencePointY Int 66

61

Cámara 3D

ES


AutoExposureMaxExposureTime Int 10000

Minimum and maximum values of common imager config parametersThe minimum and maximum values of the common imager configuration parameters are:


FrameRate 0.0167 30.0SpatialFilterType 0 3TemporalFilterType 0 2SymmetryThreshold 0MinimumAmplitude 0TwoFreqMaxLineDistPercentage 0 100ThreeFreqMax2FLineDistPercentage 0 100ThreeFreqMax3FLineDistPercentage 0 100Resolution 0 1AutoExposureReferenceType 0 2AutoExposureReferencePointX 1 352AutoExposureReferencePointY 1 264AutoExposureMaxExposureTime 10 10000

Parameters only in "under5m_low"-type of application imager configParameter name Data type Description

ExposureTime Int

*has limits

Time for the exposure

The 2nd exposure time will be calculated based on the first one.

ExposureTimeRatio Int

*has limits

Ratio of long exposure time to short exposure time.

Channel Int

*has limits

Allowed values:

0: non-group use (like channel1 but additional GUI option)

1: channel1

2: channel2

3: channel3

Default values of the "under5m_low" mode parametersParameter name Data type Default value

ExposureTime Int 1000Channel Int 0

Cámara 3D

62

Minimum and maximum values of the "under5m_low" mode parametersParameter name Minimum value Maximum value

ExposureTime 1 10000Channel 0 3

Parameters only in "under5m_moderate"-type of application imager configParameter name Data type Description

ExposureTime Int

*has limits

Time for the long exposure


Channel Int

*has limits

Allowed values:

0: non-group use (like channel1)

1: channel1

2: channel2

3: channel3

Default values of the "under5m_moderate" mode parametersParameter name Data type Default value

ExposureTime Int 1000ExposureTimeRatio Int 40Channel Int 0

Minimum and maximum values of the "under5m_moderate" mode parametersParameter name Minimum value Maximum value

ExposureTime 1 10000ExposureTimeRatio 2 50Channel 0 3

Parameters only in "under5m_high"-type of application imager configParameter name Data type Description

Channel Int

*has limits

Allowed values:


1: channel1

2: channel2

3: channel3

Default values of the "under5m_high" mode parametersParameter name Data type Default value

Channel Int 0

63

Cámara 3D

ES

Minimum and maximum values of the "under5m_high" mode parametersParameter name Minimum value Maximum value

Channel 0 3

Parameters only in "upto30m_low"-type of application imager configParameter name Data type Description

ExposureTime Int

*has limits


Channel Int

*has limits

Allowed values:

0: non-group use (like channel1)

1: channel1

2: channel2

3: channel3

Default values of the "upto30m_low" mode parametersParameter name Data type Default value

ExposureTime Int 1000Channel Int 0

Minimum and maximum values of the "upto30m_low" mode parametersParameter name Minimum value Maximum value

ExposureTime 1 10000Channel 0 3

Parameters only in "upto30m_moderate"-type of application imager configParameter name Data type Description

ExposureTime Int

*has limits



ExposureTimeRatio Int

*has limits

Ratio of long exposure time to short exposure time

Channel Int

*has limits

Allowed values:


1: channel1

2: channel2

3: channel3

Cámara 3D

64

Default values of the "upto30m_moderate" mode parametersParameter name Data type Default value

ExposureTime Int 1000ExposureTimeRatio Int 40Channel Int 0

Minimum and maximum values of the "upto30m_moderate" mode parametersParameter name Minimum value Maximum value

ExposureTime 1 10000ExposureTimeRatio 2 50Channel 0 3

Parameters only in "upto30m_high"-type of application imager configParameter name Data type Description

Channel Int

*has limits

Allowed values:


1: channel1

2: channel2

3: channel3

Default values of the "upto30m_high" mode parametersParameter name Data type Default value

Channel Int 0

Minimum and maximum values of the "upto30m_high" mode parametersParameter name Minimum value Maximum value

Channel 0 3

65

Cámara 3D

ES

14.6.9 Image Settings and Filter ParametersTo set the spatial or temporal filter use the general “setter” method.

Parameters of spatial median, spatial mean and spatial bilateral filterParameter name Data type Description

MaskSize Int Allowed values:

0: 3x3

1: 5x5

Parameters of temporal mean filterParameter name Data type Description

NumberOfImages Int Limit: 2..25

Instrucciones de uso Cámara 3D - ifm · Cámara 3D 8 6. Montaje Este capítulo describe qué se...

Documents

Transcript of Instrucciones de uso Cámara 3D - ifm · Cámara 3D 8 6. Montaje Este capítulo describe qué se...