O3D300 Camera Operating instructions-FR

Notice d'utilisation
Caméra 3D
O3D301
O3D303 FR
O3D311
O3D313
10/2015
706397 / 03
Caméra 3D
Inhalt
1. Remarques préliminaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1 Symboles utilisés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Avertissements utilisés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Consignes de sécurité . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1 Remarques générales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2 Cible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3 Raccordement électrique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.4 Interventions sur l'appareil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Fonctionnement et caractéristiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. Fourniture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
5. Accessoires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
6. Montage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6.1 Sélectionner le lieu de montage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6.2 Préparer l'appareil pour la mise en service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
6.2.1 Limites d'avertissement typiques pour O3D301 / O3D303 . . . . . . . . . . . . . . . . . . . . . . . . . . 7
6.2.2 Limites d'avertissement typiques pour O3D311 / O3D313 . . . . . . . . . . . . . . . . . . . . . . . . . . 8
6.2.3 Réduire la température de surface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
6.3 Monter l'appareil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
6.4 Accessoires de montage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
7. Raccordement électrique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
7.1 Schéma de branchement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
7.1.1 Bornes 1 / 3 (24 V / GND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
7.1.2 Borne 2 (entrée trigger) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
7.1.3 Bornes 4 / 5 (ready / cascading) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
7.2 Exemples de câblage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.2.1 Déclencher la capture d'images avec un détecteur de proximité . . . . . . . . . . . . . . . . . . . . 12
7.2.2 Utiliser plusieurs appareils l'un près de l'autre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
8. Eléments de visualisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
9. Mise en service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
9.1 Paramétrer l'appareil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
9.2 Détecter un objet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
10. Maintenance, réparation et élimination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.1 Nettoyage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.2 Mettre à jour le progiciel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.3 Remplacer l'appareil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
11. Homologations/normes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
12. Schémas d'encombrement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
12.1 O3D303 / O3D313 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
12.2 O3D301 / O3D311 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
13. Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
13.1 Required Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
13.2 XML-RPC Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
13.2.1 Sample XML-RPC command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
13.2.2 XML-RPC Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
13.3 Process Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
13.3.1 Sending Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
13.3.2 Receiving Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
13.3.3 Image data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
13.3.4 Additional Information for CONFIDENCE_IMAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
13.3.5 Configuration of PCIC Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
13.4 Process Interface Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
13.4.1 t Command (Asynchronous Trigger) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
13.4.2 T? Command (Synchronous Trigger) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
13.4.3 I? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
2
Caméra 3D
13.4.4 p Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
13.4.5 a Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
13.4.6 A? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
13.4.7 v Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
13.4.8 V? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
13.4.9 c Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
13.4.10 C? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
13.4.11 S? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
13.4.12 G? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
13.4.13 H? Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37
13.5 XML-RPC Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
13.5.1 Parameter API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
13.5.2 Main Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
13.5.3 Session Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
13.5.4 Edit Mode Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
13.5.5 Device Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
FR
13.5.6 Device/Network Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
13.5.7 Application Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
13.5.8 Application/Imager Config Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
13.5.9 Image Settings and Filter Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Licences et marques
Microsoft®, Windows®, Windows XP®, Windows Vista®, Windows 7®, Windows 8® et Windows 8.1® sont
des marques enregistrées de Microsoft Corporation.
Adobe® et Acrobat® sont des marques enregistrées d'Adobe Systems Inc.
Toutes les marques et raisons sociales utilisées sont soumises au copyright des sociétés respectives.
Cet appareil contient du logiciel Open Source (modifié si nécessaire) qui est sujet à des termes de licence
spécifiques.
Remarques concernant le droit d'auteur et les termes de licence sur :
www.ifm.com/int/GNU
Pour du logiciel sujet à la licence publique générale GNU ou la licence publique générale limitée GNU, le
texte source peut être demandé contre paiement des frais de copie et d'envoi.
3
Caméra 3D
1. Remarques préliminaires
Ce document s'adresse à des personnes compétentes. Ce sont des personnes qui sont capables - grâce
à leur formation et expérience – d’envisager les risques et d'éviter des dangers potentiels qui pourraient
être causés par le fonctionnement ou la maintenance de l'appareil. Ce document fournit des informations
sur l’utilisation correcte de l'appareil.
Lire ce document avant l'utilisation afin de vous familiariser avec les conditions environnantes,
l'installation et le fonctionnement. Garder ce document pendant tout le temps d'utilisation de l'appareil.
1.1 Symboles utilisés

► Action à faire
> Retour d'information, résultat
[…] Désignation d'une touche, d'un bouton ou d'un affichage
→ Référence croisée
Remarque importante
Le non-respect peut aboutir à des dysfonctionnements ou perturbations.
Information
Remarque supplémentaire
1.2 Avertissements utilisés
ATTENTION
Avertissement de dommages matériels.
2. Consignes de sécurité
2.1 Remarques générales
Cette notice fait partie de l'appareil. Elle fournit des textes et des figures pour l'utilisation correcte de
l'appareil et doit être lue avant installation ou emploi.
Respecter les indications de cette notice. Le non-respect de ces consignes, une utilisation en dehors des
conditions définies ci-dessous, une mauvaise installation ou utilisation peuvent avoir des conséquences
graves pour la sécurité des personnes et des installations.
2.2 Cible
Cette notice s'adresse à des personnes considérées comme compétentes selon les directives CEM et
basse tension. L'appareil doit être monté, raccordé et mis en service par un électricien habilité.
2.3 Raccordement électrique

Mettre l'appareil hors tension en prenant des mesures externes avant toutes manipulations.
Les bornes de raccordement ne doivent être alimentées que par les signaux indiqués dans les données
techniques et sur l'étiquette de l'appareil et seuls les accessoires homologués d'ifm doivent être
raccordés.
2.4 Interventions sur l'appareil

En cas de mauvais fonctionnement de l'appareil ou en cas de doute prendre contact avec le fabricant.
Les interventions sur l'appareil peuvent avoir des conséquences graves pour la sécurité des personnes
et des installations. Elles ne sont pas autorisées et aboutissent à une exclusion de responsabilité et de
garantie.
4
Caméra 3D
3. Fonctionnement et caractéristiques
La caméra 3D O3D3xx est une caméra optique qui mesure point par point la distance entre la caméra et
la surface la plus proche avec la technologie temps de vol. L'appareil illumine la scène avec une source
lumineuse infrarouge interne et calcule la distance à l'aide de la lumière réfléchie par la surface.
La caméra fournit des données qui décrivent la scène capturée de façon tridimensionnelle. Ces données
de distance sont fournies via Ethernet pour être évaluées par l'utilisateur. Le paramétrage de l'appareil
s’effectue également via Ethernet.
L'appareil ne doit être utilisé que dans les conditions environnantes indiquées dans la fiche technique.
La sécurité de l'équipement est conçue pour l'emploi dans les conditions environnantes suivantes :
• Utilisation à l'intérieur
• Altitudes jusqu'à 2000 m
• Humidité d'air relative jusqu'à 90% au maximum, sans condensation FR
• Degré de salissure 3
4. Fourniture
L'appareil est livré avec :
●● Caméra 3D O3D3xx
●● Clé USB avec logiciel et documentation
●● Notice brève, numéro 80227244e
La fiche technique et d'autre documentation (manuel de programmation etc.) sont disponibles sur
l'internet :
www.ifm.com → Recherche d'une fiche technique → par ex. O3D303 → Notices d'utilisation
5. Accessoires
Pour le fonctionnement de l'appareil les accessoires suivants sont nécessaires :
Numéro d'article Description
E11950 Câble d'alimentation pour caméra/capteur
E11898 Câble de raccordement M12 selon Industrial Ethernet
Le logiciel ifm Vision Assistant est disponible à titre gratuit sur :

www.ifm.com → Support → Téléchargement → Vision industrielle
5
Caméra 3D
6. Montage
Le chapitre décrit ce qu'il faut connaître avant le montage et comment l'appareil doit être installé.
①
① Appareil
② Angle d'ouverture
③ Objet
④ Champ de vue
⑤ Distance entre l'appareil et l'objet
②
⑤
④
6.1 Sélectionner le lieu de montage
Observer les instructions suivantes pour la sélection du lieu de montage :
►► L'objet ③ doit se trouver intégralement dans le champ de vue ④.
>> La taille du champ de vue dépend de la version de l'appareil et est indiquée dans la fiche technique.
La taille du champ de vue dépend aussi de la distance entre l'appareil et l'objet ⑤ : Le champ de vue
devient plus grand lorsque l’on augmente la distance.
►► Prendre en considération les tolérances pour le positionnement de l'objet.

►► Pour définir la distance entre l'appareil et l'objet ⑤, prendre en considération l'étendue de mesure de
l'appareil.
>> L'étendue de mesure est indiquée dans la fiche technique de l'appareil.
►► Choisir une distance entre l'appareil et l'objet ⑤ aussi petite que possible.
>> Avec une distance minimale, l'objet est détecté avec la résolution maximale.
►► Eviter une forte lumière ambiante et les rayons solaires sur le lieu de montage.
>> Un niveau de lumière ambiante (ayant un spectre solaire) au-dessus de 8 kilolux cause des erreurs de
mesure. En effet, uniquement la lumière infrarouge entre 800 et 900 nm est perturbante.
►► Eviter les zones pouvant créer de forts encrassements comme lieu de montage.
>> Dans des zones à forts encrassements, l'objectif est souillé malgré une orientation vers le bas ①.
►► Eviter des vitres transparentes entre l'appareil ① et l'objet ③.

>> Les vitres transparentes réfléchissent une partie de la lumière, même si un plateau de verre très
propre est utilisé.
Si les instructions ne sont pas respectées, des erreurs de mesure sont possibles.
6
Caméra 3D
6.2 Préparer l'appareil pour la mise en service

La température de surface de l'appareil dépend du mode de fonctionnement, de la sélection des
paramètres et de la connexion thermique de l'appareil avec le support de montage.
S'assurer que l'appareil satisfait aux exigences suivantes :
La température de surface, pour les surfaces facilement accessibles, peut être au maximum
supérieure de 25 °C à la température ambiante (selon IEC61010-2-201).
Les diagrammes suivants montrent les limites d'avertissement typiques auxquelles l'installateur peut se
reporter.
Les diagrammes sont valables pour les modes d’exposition suivants:
●● un temps d'exposition
●● deux temps d'exposition FR
●● trois temps d'exposition
Avec deux ou trois temps d'exposition, les limites d'avertissement typiques doivent être
déterminées en faisant la somme des temps d'exposition. Les temps d'expositions sont indiqués
dans le logiciel ifm Vision Assistant.
Respecter une des indications suivantes si les limites d'avertissement sont dépassées :
►► Réduire la température de surface (→ 6.2.3).
►► Monter une protection contre le contact sans diminuer la convection (circulation d’air).
>> La température de surface ne doit pas être augmentée une fois cette protection contre le contact installée.
Le paramètre "Max. background distance" est réglé dans ifm Vision Assistant. Les limites
d'avertissement sont indiquées dans les diagrammes comme des lignes pointillées et continues.
Si l'appareil se trouve dans une des zones pointillées, la température de surface doit être réduite
(→ 6.2.3). Si la limite d'avertissement est dépassée malgré un montage évacuant la chaleur, une
protection contre les contacts peut être montée en plus.
Si les limites d'avertissement typiques sont inférieures avec montage normal, aucune mesure n'est
nécessaire.
6.2.1 Limites d'avertissement typiques pour O3D301 / O3D303
Paramètre "Max. background distance"

y
25 Montage sur des pièces métalliques
conduisant la chaleur
avec conducteur thermique (→ 6.2.3)
20
Limite
Paramètre
d'avertissement
15
<5m
10
< 30 m
5 > 30 m
x Montage normal
0
0 2 4 6 8 10 Limite
Paramètre
d'avertissement
<5m
< 30 m
> 30 m
x = temps d'exposition [ms]

y = taux d’images [fps]
7
Caméra 3D
6.2.2 Limites d'avertissement typiques pour O3D311 / O3D313
Paramètre "Max. background distance"

y
25 Montage sur des pièces métalliques
conduisant la chaleur
avec conducteur thermique (→ 6.2.3)
20
Limite
Paramètre
d'avertissement
15
<5m
10
< 30 m
5 > 30 m
x Montage normal
0
0 2 4 6 8 10 Limite
Paramètre
d'avertissement
<5m
< 30 m
> 30 m
x = temps d'exposition [ms]

y = taux d’images [fps]
6.2.3 Réduire la température de surface

La température de surface peut être réduite par les mesures suivantes :
►► Fixer l'appareil sur des pièces métalliques conduisant la chaleur.
>> La fixation de l'appareil sur une grande surface métalliques augmente l'évacuation de la chaleur (par
ex. aluminium).
►► Utiliser un conducteur thermique relié à des pièces métalliques.

>> L'effet conducteur de chaleur est augmenté par le conducteur thermique. Le conducteur thermique est
disponible comme accessoire (→ 6.4).
►► Réduire toute entrave dans l'environnement de l'appareil et la densité d'objets.

>> Toute entrave dans l'environnement de l'appareil et une densité d'appareils augmentée peuvent avoir
des effets négatifs sur la convection (mouvement de l'air).
►► Monter un ou deux dissipateurs thermiques sur l'appareil.

>> Les dissipateurs thermiques augmentent la surface de l'appareil ce qui réduit la température de
surface. Les dissipateurs thermiques sont disponibles comme accessoires (→ 6.4).
►► Réduire le temps d'exposition, le taux d’images ou la distance maximale visible.

>> Le mode fonctionnement utilisé et les paramètres peuvent augmenter la température de surface.
8
Caméra 3D
6.3 Monter l'appareil

Respecter les instructions suivantes pour le montage de l'appareil :
►► Monter l'appareil avec 2 écrous M5 ou le kit de montage.
>> Les dimensions des perçages pour les écrous M5 sont indiquées dans la fiche technique.
>> Le kit de montage est disponible comme accessoire (→ 6.4).
►► Utiliser des protections contre la traction pour tous les câbles raccordés à l'appareil.
Respecter les remarques suivantes pour le montage d'un appareil O3D301 et O3D311 :
►► Monter l'appareil de manière à permettre le réglage de la focale à l'aide d'un tournevis.
>> La position du réglage de la focale est indiquée dans le schéma d'encombrement (→ 12). FR
Lorsque l'appareil est utilisé en zone humide, l'écrou du câble de raccordement Industrial Ethernet
M12 (par ex. E11898) peut corroder. Pour l'utilisation permanente en zone humide utiliser un câble
de raccordement avec un écrou en acier inox.
6.4 Accessoires de montage

Suivant le lieu et le type de montage, les accessoires de montage suivants peuvent être utilisés :
Numéro d'article Description
E3D301 Kit de montage Smart Camera
E3D302 Dissipateur thermique Smart Camera
E3D303 Conducteur thermique Smart Camera
E3D304 2x Dissipateur thermique Smart Camera
Informations sur les accessoires disponibles sur :

www.ifm.com → Recherche d'une fiche technique → p. ex. O3D303 → Accessoires
9
Caméra 3D
7. Raccordement électrique
Respecter les remarques suivantes avant l'installation électrique :
ATTENTION
L'appareil doit être raccordé par un électricien qualifié. Respecter les données électriques de la fiche
technique.
Appareil de la classe de protection III (CP III).
L'alimentation électrique ne doit s'effectuer que via des circuits TBTP.
L'alimentation électrique doit être conforme à UL61010-1, chap. 9.4 - Limited Energy :
Le dispositif de limitation des surtensions doit désactiver un courant de 6,6 A en 120 s. Pour le
dimensionnement du dispositif de limitation des surtensions, respecter les données techniques de
l'appareil et du câblage.
L'isolation des circuits externes doit être conforme à UL61010-2-201, fig. 102.
Pour des longueurs de câble > 30 m, utiliser une protection supplémentaire contre des tenues au choc
selon IEC6100-4-5.
Avant le raccordement électrique mettre l'installation hors tension.
7.1 Schéma de branchement
① Ethernet
Connecteur femelle M12, codage D, 4 pôles

1 TD +
2 RD +

3 TD -

4 RD -
S Shield (blindage)

② Alimentation en courant
Connecteur mâle M12, codage A, 5 pôles
2 1 1 U+
2 entrée trigger
5 3 GND
3 4 4 sortie de commutation 1 - ready
5 sortie de commutation 2 – cascading
Le comportement des entrées et sorties de commutation peut être réglé par le logiciel ifm Vision
Assistant. Le réglage commutation PNP ou NPN est toujours valable pour toutes les entrées et
sorties.
S'assurer du réglage correct pour l'installation des actionneurs et capteurs (par ex. barrages
optoélectroniques pour le déclenchement).
Les sorties de commutation peuvent aussi être utilisées comme sorties impulsionnelles qui
remettent leur signal de commutation à 0 après un temps réglable.
7.1.1 Bornes 1 / 3 (24 V / GND)

La plage de tension admissible est indiquée dans la fiche technique de l'appareil.
10
Caméra 3D
7.1.2 Borne 2 (entrée trigger)

La capture d'images de l'appareil peut être déclenchée avec un signal de commutation via l'entrée trigger.
Les fronts trigger suivants peuvent être utilisés :
●● Le front descendant déclenche la capture d'images.
●● Le front montant déclenche la capture d'images.
●● Les fronts descendant et montant déclenchent la capture d'images.
D'autres possibilités pour le déclenchement de l'appareil :
●● Commande interfaces process (→ 13.3)
●● Capture d'images continuelle avec taux d’images à fixer
L'entrée trigger a une fonction anti-rebond intégrée. Selon l’installation électrique, cette fonction de
l’entrée trigger n'est pas nécessaire.
FR
La fonction anti-rebond intégrée évite le déclenchement de plusieurs courtes impulsions.
L'impulsion doit durer au moins 2 ms pour être reconnue comme déclenchement.
Entrée trigger
Capture d'images
1 2 3 4 5 6 7 8 9 10 11
Temps [ms]
7.1.3 Bornes 4 / 5 (ready / cascading)

Les spécifications électriques des sorties de commutation 1 et 2 (ready / cascading) sont indiquées dans
la fiche technique.
Les sorties de commutation fournissent l'état de l'appareil suivant dans le préréglage :
●● Sortie de commutation 1 : "Ready for trigger"
●● Sortie de commutation 2 : "Image capture finished"
"Sortie de commutation commutée" signifie que l'état de l'appareil correspondant s'est produit.
Selon le réglage, l'état de l'appareil peut avoir une des valeurs suivantes :
●● "Ready for trigger"
L'appareil signale qu'une nouvelle image peut être capturée. Les triggers ne peuvent être traités
qu'avec cet état de l'appareil. Avec capture d'images continuelle, l'état de l'appareil "Ready for trigger"
n'est pas fourni.
●● "Image capture finished"
L'appareil signale que la capture des images est terminée. L'état de l'appareil peut être utilisé pour la
fonction cascading d'appareils.
●● "Evaluation finished"
L'appareil signale que le traitement des images est terminé. A ce moment, les sorties de commutation
sont déjà mises à jour. Les données d'image sont transmises via Ethernet.
●● "Error"
L'appareil signale qu'une erreur interne s'est produite. Des informations détaillées sur l'erreur peuvent
être demandées via Ethernet.
11
Caméra 3D
7.2 Exemples de câblage

Ci-dessous, des exemples de câblage de l'appareil sont montrés.
7.2.1 Déclencher la capture d'images avec un détecteur de proximité

L'appareil peut être déclenché de manière externe :
●● via Ethernet
●● via un détecteur de proximité, raccordé à l'entrée trigger
La figure suivante montre le câblage de l'appareil à un détecteur de proximité.
① PC portable (paramétrage)
② Détecteur de proximité
1 2
③ PC industriel (évaluation /
déclenchement)
4 3
2 1 ①
5
3 4
3 1 2 4 5
+ DC 24 V -
IN IN
② ③
12
Caméra 3D
7.2.2 Utiliser plusieurs appareils l'un près de l'autre

Des appareils montés l'un près de l'autre peuvent causés des erreurs de mesure en cas d’exposition en
même temps.
① ② ① 1er Appareil
② 2e Appareil
③ Objet
FR
③
Il y a deux manières d'éviter les erreurs de mesure :
●● Cascader les appareils via trigger matériel
Lors de cette fonction cascade, un système de commande déclenche la capture du 1er appareil.
Après la fin de la capture des images, le 1er appareil déclenche automatiquement le 2e appareil. Le 2e
appareil signale la fin de la séquence au système de commande.
① PC industriel
(évaluation /
2 1 déclenchement)
5
3 4
3 1 2 4 5 3 1 2 4 5
+ DC 24 V -
IN IN
①
●● Utiliser des canaux de fréquences différents.
Avec le logiciel ifm Vision Assistant un canal de fréquences individuel peut être affecté à chaque
appareil. Les différents canaux de fréquences réduisent la présence d'erreurs de mesure.
Le logiciel ifm Vision Assistant est disponible à titre gratuit sur :
13
Caméra 3D
8. Eléments de visualisation
L'appareil signale l'état de fonctionnement actuel via les éléments d'indication LED 1 - 4.
LED 1 LED 2
LED 4 LED 3
LED 4 LED 1 LED 2 LED 3 Description

(Ethernet) (Power) (Out 1) (Out 2)
Allumée L'appareil est opérationnel, tension d'alimentation
appliquée
Clignote à L'appareil n'est pas paramétré ou le paramétrage n'a
0,5 Hz pas été chargé sur l'appareil
On
On
Off
Off
Clignote L'appareil est en mode de paramétrage
2 x à 0,5 On
Hz On
Off
Off
Allumée La sortie de commutation 1 est commutée
Clignote à La sortie de commutation 1 a un court-circuit
8 Hz
Allumée La sortie de commutation 2 est commutée
Clignote à La sortie de commutation 2 a un court-circuit
8 Hz
Allumée Ethernet est raccordé
Clignote Ethernet transmet des données
Eteinte Ethernet n'est pas raccordé
Clignote à Clignote à L’appareil signale une erreur interne
8 Hz 8 Hz
Clignote à Clignote à L’appareil signale une erreur remédiable. Le message
2 Hz 2 Hz d'erreur peut être lu via Ethernet
Chenillard ⇒ L’appareil démarre
Chenillard ⇐
L’appareil exécute une mise à jour du progiciel
14
Caméra 3D
9. Mise en service
L'appareil est mis en service avec la mise sous tension. Après 15 secondes, l'appareil se trouve en mode
d’évaluation dans lequel les applications sauvegardées sont exécutées. Les éléments de visualisation
signalent l'état de fonctionnement actuel (→ 8).
Jusqu'à 32 applications peuvent être sauvegardées sur l'appareil. Une application inclut
typiquement les paramètres suivants :
●● Capture d'images : par ex. déclenchement de la capture d'images, temps d'exposition, filtre de
traitement d'images
●● Interface: Ethernet, sorties de commutation
L'application correspondante peut être activée avec le logiciel ifm Vision Assistant ou via des
commandes d'interface process.
FR
9.1 Paramétrer l'appareil
Il y a deux manières de paramétrer l'appareil :
●● Logiciel ifm Vision Assistant (→ voir manuel de programmation)
●● Commandes XML-RPC (→ 13.5)
L'utilisation du logiciel ifm Vision Assistant et des informations détaillées sur le principe de mesure
de l'appareil sont décrits dans le manuel de programmation.
Le manuel de programmation est disponible sur l'internet.
www.ifm.com → Recherche d'une fiche technique → par ex. O3D303 → Notices d'utilisation
9.2 Détecter un objet

Ci-dessous, les conditions qui mènent à un haut taux de détection d'objets sont décrites.
① Appareil
① ② Zone d'influence
③ Champ de vue
④ Objet
② ②
Un objet ④ est détecté de façon optimale, si les conditions suivantes sont satisfaites :
●● L'objet est positionné dans le champ de vue ③.
●● L'objet à détecter est l'objet le plus proche visible par l'appareil ①.
●● La zone d'influence ② est libre d'objets (entrave etc.).
●● La vitre avant de l'appareil est libre de salissures.
Si ces conditions ne sont pas satisfaites, des erreurs de mesure sont possibles.
15
Caméra 3D
10. Maintenance, réparation et élimination

Respecter les instructions suivantes :
►► Ne pas ouvrir l'appareil. A l'intérieur de l'appareil il n'y a pas de composants réparables par
l'utilisateur. L'appareil ne doit être réparé que par le fabricant.
►► Respecter la réglementation du pays en vigueur pour la destruction écologique de l'appareil.
10.1 Nettoyage
Observer les instructions avant le nettoyage de l'appareil :
►► Utiliser un chiffon propre et sans peluches.
►► Comme produit lessiviel, utiliser un nettoyant à vitres.
Si ces instructions ne sont pas respectées, des erreurs de mesure sur la vitre avant, causées par
des rayures, sont possibles.
10.2 Mettre à jour le progiciel

Le progiciel de l'appareil peut être actualisé avec le logiciel ifm Vision Assistant.
Les paramètres sauvegardés dans l'appareil sont perdus par l'actualisation du progiciel. Avant la
mise à jour du progiciel, faire une copie de sauvegarde des paramètres.
►► Avant la mise à jour du progiciel, exporter les paramètres.
►► Après la mise à jour du progiciel, importer les paramètres.
Les mises à jour du progiciel sont disponibles sur l'internet.

10.3 Remplacer l'appareil

Lors du remplacement d'un appareil les paramètres sont perdus. Avant le remplacement de l'appareil,
faire une copie de sauvegarde des paramètres.
►► Avant le remplacement, exporter les paramètres de l'appareil à remplacer.
►► Après le remplacement, importer les paramètres dans le nouvel appareil.
Avec l'exportation et l'importation des paramètres il est possible d'équiper plusieurs appareils
rapidement avec les mêmes paramètres.
11. Homologations/normes
La déclaration de conformité CE est disponible sur :
www.ifm.com → Fiche technique → par ex. O3M303 → Homologations
16
Original Scale Drawing (MTD)
P_MZ_200_0359
Caméra 3D
O3D302
O3D303
O3D312
O3D313
12. Schémas d'encombrement
12.1 O3D303 / O3D313
2 3
95
65 82,6
32,5 73,3
M12x1
FR
40
72
33
33
14
M12x1
5,7 71,6
1 2
① Objectif
P_MZ_200_0362
Original Scale Drawing (MTD)
O3D300 ② Unité d'éclairage

O3D301
O3D310 ③ LED 2 couleurs (jaune/verte)
O3D311
12.2 O3D301 / O3D311

EPS Source
Product Scale Drawing
95 Frame Size: 80 mm x 45 mm
3 2
82,6 67,1
73,3 65
28,7 32,5
17,1
2 3
M12x1
95
65 82,6
32,5 73,3
M12x1
40
40
72
72
33
33
14
M12x1
49
5,7 71,6
1 2
33
33
14
M12x1
71,6
4 5,7 1 2
① Objectif
② Unité d'éclairage
③ LED 2 couleurs (jaune/verte)
④ Réglage de la focaleAppendix
EPS Source 17
Product Scale Drawing
Frame Size: 80 mm x 45 mm
Caméra 3D
13. Appendix
13.1 Required Ports
The 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.
13.2 XML-RPC Interface

In 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 has to be in a special layout. In this
command, linefeeds and carriage returns are essential.
Every command which has to be 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.
13.2.1 Sample XML-RPC command

All 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>
18
Caméra 3D
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>
FR
13.2.2 XML-RPC Objects
To 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
requestSession(...)
Session
setOperatingMode(1)
EditMode
editApplication(1) DeviceConfig
NetworkConfig
ApplicationConfig
ImagerConfig
19
Caméra 3D
Main API
cancelSession(...) removes itself from RPC. Session will also

be removed, if heartbeat(...) is not called at the right time
Session
setOperatingMode(0) will remove EditMode from RPC
EditMode
stopEditApplication() will remove ApplicationConfig from RPC
ApplicationConfig
Main Object
Object-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 Object
Object 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 Object
Object 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 Object
Object-URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/
Device/NetworkConfig Object
Object 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/
20
Caméra 3D
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
FR
under5m_high
upto30m_low
upto30m_moderate
upto30m_high
morethan30m_low
morethan30m_moderate
Image Settings and Filter Parameters

There is an RPC object for spatial filter parameters in each imager configuration.
application/imager_001/spatialfilter
There is an RPC object for temporal filter parameters in each imager configuration.
application/imager_001/temporalfilter
Data of these objects is persistently saved when calling "save" on application config object.
21
Caméra 3D
13.3 Process Interface

The process interface is used during the normal operation mode to get operational data (e.g. 3D images,
process values) from the O3D3xx.
13.3.1 Sending Commands

For 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 D
LF 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 response with the same ticket.
<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.
13.3.2 Receiving Images

For receiving the image data a TCP/IP socket communication has to be 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 shall be submitted in this sequence:
Component Content
Ticket and length information (→ 13.4.2)
Ticket „0000“
Start sequence String "star" (4 bytes)
Normalised amplitude image 1 image
Output format: 16-bit unsigned integer
22
Caméra 3D
Component Content
Distance image 1 image
Output format: 16-bit integer. Unit: mm.
X image 1 image
Output format: 16-bit signed integer. Unit:
mm.
Y image 1 image
mm.
Z image 1 image
mm. FR
Confidence image 1 image
Output format: 8-bit unsigned integer
Diagnostic data
Stop sequence String "stop" (4 bytes)
Ticket signature <CR><LF>
13.3.3 Image data

For 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.
Chunk type:
Offset Name Description Size [byte]
0x0000 CHUNK_TYPE Defines the type of the chunk. For each distinct chunk 4
an own type is defined.
0x0004 CHUNK_SIZE Size of the whole image chunk in bytes. After this count 4
of bytes the next chunk starts.
0x0008 HEADER_SIZE Number of bytes starting from 0x0000 until PIXEL_ 4
DATA.
0x000C HEADER_VERSION Version number of the header 4
0x0010 IMAGE_WIDTH Image width in pixel 4
0x0014 IMAGE_HEIGTH Image height in pixel 4
0x0018 PIXEL_FORMAT Pixel format 4
0x001C TIME_STAMP Time stamp in microseconds 4
0x0020 FRAME_COUNT Frame counter 4
0x0024 PIXEL_DATA The pixel data in the given type and dimension of the 4
image. Padded to 4-byte boundary.
23
Caméra 3D
Available chunk types:

Constant Value Description
USERDATA 0 Undefined user data with arbitrary content
RADIAL_DISTANCE_ 100 Each pixel of the distance matrix denotes the ToF distance
IMAGE 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: millimetres
NORM_AMPLITUDE_ 101 Each pixel of the normalized amplitude image denotes the raw
IMAGE 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 integer
AMPLITUDE_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 integer
CARTESIAN_X_ 200 The X matrix denotes the X component of the Cartesian coordinate
COMPONENT 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: millimetres
CARTESIAN_Y_ 201 The Y matrix denotes the Y component of the Cartesian coordinate
Unit: millimetres
24
Caméra 3D

CARTESIAN_Z_ 202 The Z matrix denotes the Z component of the Cartesian coordinate
Unit: millimetres
CARTESIAN_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. FR
Data type: 32-bit floating point number (3x per pixel)
CONFIDENCE_IMAGE 300 See Additional Information for Image Data (→ 13.4.2)
DIAGNOSTIC 302 See Receiving Images (→ 13.3.2)
Pixel format:
FORMAT_8U 0 8-bit unsigned integer
FORMAT_8S 1 8-bit signed integer
FORMAT_32F 6 32-bit floating point number
FORMAT_64F 8 64-bit floating point number
Reserved 9 N/A
FORMAT_32F_3 10 Vector with 3x32-bit floating point number
25
Caméra 3D
13.3.4 Additional Information for CONFIDENCE_IMAGE

Further 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: yes
2 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.
3 1 = amplitude below Amplitude limits
minimum amplitude
The amplitude value is below minimum amplitude threshold.
threshold
4+5 Bit 5, bit 4 Exposure time indicator
0 0 = unused The two bits indicate which exposure time was used in a
multiple exposure measurement.
0 1 = shortest exposure
time (only used in 3 Contributes to pixel validity: no
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)
6 N/A Currently not used
7 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
26
Caméra 3D
13.3.5 Configuration of PCIC Output

The 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" },
FR
{ "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. Type: string
So far only “flexible” is supported
format Defines format details, the definitions in the main object are Type: object
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).
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. Type: string
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.
id Defines an identifier for this data element. Type: string
If there is no fixed value (property "value"), the data should be
retrieved via id.
value Optional property for defining a fixed output value. Type: any JSON value
format Type-depending option for fine-tuning the output format. Type: object
E.g. cut an integer to less than 4 bytes.
27
Caméra 3D
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.
int32 Data is written as integer.
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 Allowed values Default
properties
dataencoding "ascii" or "binary" can be defined in top-level-object and "ascii"
overwritten by element objects.
scale "float value with decimal separator" to scale the results for 1.0
output byte width
offset "float value with decimal separator" 0.0
Binary format properties:

Format properties Allowed values Default
order Little, big and network Little
28
Caméra 3D
ASCII format properties:

Format properties Allowed values Default
width Output width. If the resulting value exceeds the width field the 0
result will not be truncated.
fill Fill character ""
precision Precision is the number of digits behind the decimalseparator. 6
displayformat Fixed, scientific Fixed
alignment Left, right Right
decimalseparator 7-bit characters for e.g. "." "."
base Defines if the output should be: 10
●● binary (2)
FR
●● octal (8)
●● decimal (10)
●● hexadecimal (16)
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"
} ] }
29
Caméra 3D
The following element IDs are available:

ID Description Native datatype
evaltime Evaluation time for current frame in milliseconds 32-bit unsigned
integer
framerate Current frame rate in Hz Float32
temp_front1 Temperature measured in the device while capturing this Float32, unit: °C"
result.
Measured by first sensor on imager board.
temp_illu Temperature measured in the device while capturing this Float32, unit: °C
result.
Measured on the illumination board.
extrinsic_calibration Extrinsic calibration, constisting of 3 translation Float32
parameters (unit: millimeters) and 3 angles
(unit: degree): [t_x, t_y, t_z, alpha_x, alpha_y, alpha_z]
amplitude_image PMD raw amplitude image 16-bit unsigned
integer
normalized_amplitude_ Normalized amplitude image 16-bit unsigned
image integer
distance_image Radial distance image. 16-bit unsigned
integer
unit: millimetres
x_image Cartesian coordinates for each pixel. 16-bit signed
y_image integer
Each dimension is a separate image.
z_image
all_cartesian_vector_ All Cartesian images (X+Y+Z) concatenated to one 16-bit signed
matrices package integer
confidence_image Confidence image 8-bit unsigned
integer
all_unit_vector_matrices Matrix of unit vectors. Each element consists of a Float32
3 component vector [e_x, e_y, e_z]
30
Caméra 3D
13.4 Process Interface Command Reference

All received messages which are sent because of the following commands will be sent without
“start”/”stop” at the beginning or ending of the string.
13.4.1 t Command (Asynchronous Trigger)

Command t
Description Executes trigger. The result data
is send asynchronously
Type Action
Reply * Trigger was executed, the device
captures an image and evaluates
the result. FR
! ●● Device is busy with an
evaluation
●● Device is in an invalid state
for this command, e.g.
configuration mode
●● Device is set to a different
trigger source
●● No active application
13.4.2 T? Command (Synchronous Trigger)
Command T?
Description Executes trigger. The result data
is send synchronously
Type Request
Reply Process data within the Trigger was executed, the device
configured layout captures an image, evaluates
the result and sends the process
data.
! ●● Device is busy with an
evaluation
configuration mode
●● Device is set to a different
trigger source
●● No active application
13.4.3 I? Command
Command I<image-ID>?
Description Request last image taken
Type Request
Reply <length><image data>
! ●● No image available
●● Wrong ID
? ●● Invalid command length
31
Caméra 3D
Note <image-ID> Valid image ID:

2 digits for the image type 01- amplitude image
<length> 02 - normalised amplitude image
char string with exactly 9 digits 03 - distance image
as decimal number for the image
04 – X image (distance
data size in bytes
information)
<image data>
05 – Y image (distance
image data 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
13.4.4 p Command
Command p<state>
Description Turns the PCIC output on or off
Type Action
Reply *
! <state> contains wrong value
? Invalid command length
Note <state> 1 digit On device restart the value
configured within the application
0: deactivates all asynchronous
is essential for the output of data.
output
This command can be executed
1: activates asynchronous result
in any device state.
output
2: activates asynchronous error
output
3: activates asynchronous error
and data output
32
Caméra 3D
13.4.5 a Command
Command a<application number>

Description Activates the selected
application
Type Action
Reply *
! ●● Application not available
●● <application number>
contains wrong value
●● External application switching
activated FR
configuration mode
Note <application number>
2 digits for the application
number as decimal value
13.4.6 A? Command
Command A?
Description Requests the occupancy of the
application list
Type Request
Reply <amount><t><number active
application><t>
...
<number><t><number>
! Invalid state (e.g. no application
active)
Note <amount> The active application is
repeated within the application
char string with 3 digits for the
list.
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
33
Caméra 3D
13.4.7 v Command
Command v<version>
Description Sets the current protocol version.
The device configuration is not
affected
Type Action
Reply *
! Invalid version
Note <version> (→ 13.3.1)
2 digits for the protocol version
The default protocol version is „V3“.
13.4.8 V? Command
Command V?
Description Requests current protocol
version
Type Request
Reply <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
13.4.9 c Command
Command c<length><configuration>
Description Uploads a PCIC output
configuration lasting this session
Type Action
Reply *
! ●● Error in configuration
●● Wrong data length
Note <length>
9 digits as decimal value for the
data length
<configuration>
configuration data
34
Caméra 3D
13.4.10 C? Command
Command C?
Description Retrieves the current PCIC
configuration
Type Request
Reply <length><configuration>
Note <length>
9 digits as decimal value for the
data length
<configuration>
FR
configuration data
13.4.11 S? Command
Command S?
Description Requests current decoding
statistics
Type Request
Reply <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
35
Caméra 3D
13.4.12 G? Command
Command G?
Description Requests device information
Type Request
Reply <vendor><t><article number><t>
<name><t><location><t><descri
ption><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
36
Caméra 3D
13.4.13 H? Command
Command H?
Description Returns a list with available
commands
Type Request
Reply 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 FR
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
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
37
Caméra 3D
13.5 XML-RPC Command Reference
13.5.1 Parameter API

The parameters setParameter, getParameter, getAllParameters and getAllParameterLimits are
implemented in the following RPC objects:
●● Device
●● Network
●● Application
●● ImagerConfig
●● Filter
●● Model
setParameter
Method name setParameter
Description Sets a parameter to a specific value
Input parameters 1. Name of parameter:string
2. New value: string
Output parameters Empty string (compatibility with classic XmlRPC client)
getParameter
Method name getParameter
Description Returns the current value of the parameter
Input parameters Name of parameter: string
Output parameters Value of parameter: string
getAllParameters
Method name getAllParameters
Description Returns all parameters of the object in one data structure
Input parameters None
Output parameters 1. Struct (name contains the parameter name, value contains the
stringified parameter value)
getAllParameterLimits
Method name getAllParameterLimits
Description Returns limits of all numeric parameters, that have limits defined on
the device
Input parameters None
Output 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" }}
38
Caméra 3D
Parameter string encoding

Non-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
FR
of arrays must specified on specific parameters.
13.5.2 Main Object

getParameter
Method name getParameter
Description Getter for the device-global parameters
Input parameters Name of a device parameter: string
Output parameters Value of the requested parameter: string
getAllParameters
Method 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 none
Output parameters Struct (name contains the parameter name, value contains the
stringified parameter value)
39
Caméra 3D
getSWVersion
Method name getSWVersion
Description Returns version information of all software components
Output 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"
getHWInfo
Method name getHWInfo
Description Returns hardware information of all components
Output 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"
getApplicationList
Method name getApplicationList
Description Delivers basic information of all applications stored on the device.
Output parameters Array of structs (Index: int, Id: int, Name: string, Description: string)
40
Caméra 3D
requestSession
Method 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 FR
"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
reboot
Method 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 mode
Output parameters Output: string
systemCommand
Method name systemCommand
Description Performs a generic command on the device.
Input parameters 1. Command: string
2. Parameter: string
Output parameters Output: string
41
Caméra 3D
13.5.3 Session Object

heartbeat
Method 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: int
Output parameters The used timeout interval, in seconds: int
cancelSession
Method name cancelSession
Description Explicit stop of this session
If an application is still in edit mode, it will implicitly do the same as
"stopEditingApplication".
Output parameters Empty string (compatibility with classic XmlRPC-client)
exportConfig
Method name exportConfig
Description Exports the whole configuration of the sensor device
Output parameters Configuration as a data BLOB: binary/base64
importConfig
Method name importConfig
Description Imports whole configuration with the option to skip specific parts
Input 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 configurations
exportApplication
Method name exportApplication
Description Exports one application config
Input parameters Application index
Output parameters Application config as a data BLOB: binary/base64
42
Caméra 3D
importApplication
Method 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/base64
Output parameters Index of new application
setOperatingMode
Method name setOperatingMode
Description Changes the operating mode of the device. FR
Setting this to "edit" will enable the "edit mode object” on RPC.
Input parameters Mode: integer
0: Run mode
1: Edit mode
43
Caméra 3D
13.5.4 Edit Mode Object

factoryReset
Method name factoryReset
Description Resets all configurations to factory settings
A factory reset will delete all applications which are saved on the camera.
editApplication
Method 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: int
stopEditingApplication
Method name stopEditingApplication
Description Tells the device that editing this application was finished.
Unsaved changes are discarded.
createApplication
Method name createApplication
Description Creates an "empty" application. The embedded side should initialise
all needed parameters and structures.
Output parameters Index of new application: int
44
Caméra 3D
copyApplication
Method 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: int
Output parameters Index of new application: int
deleteApplication
Method name deleteApplication
FR
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: int
moveApplications
Method 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)
13.5.5 Device Config Object

activatePassword
Method 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: string
45
Caméra 3D
disablePassword
Method name disablePassword
Description Disables the password protection.
Making this change persistently requires to call "save" on device
config.
save
Method 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 config

Methods 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 Index of active application
*has limits 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 active
PcicTcpPort Int TCP/IP port for PCIC connections.
PcicProtocolVersion Int Sub-protocol of PCIC, see specification of PCIC.
*has limits
IOLogicType Int Defines logic type of all digital pins.
*has limits Allowed values:
0: NPN
1: PNP
IODebouncing Bool Applies to all inputs
IOExternApplicationSwitch Int Allowed values:
*has limits 0: off
1: static via I/O
2: pulse driven via I/O
3: pulse driven via trigger
46
Caméra 3D

SessionTimeout Int Number of seconds which a session stays before a call
to "heartbeat" method is needed
*has limits
ServiceReportFailedBuffer Int Number of buffers reserved for failed results
*has limits
ServiceReportPassedBuffer Int Number of buffers reserved for passed results
*has limits
ExtrinsicCalibTransX Double Extrinsic calibration, transition in X direction
Unit: millimetres
ExtrinsicCalibTransY Double Extrinsic calibration, transition in Y direction
Unit: millimetres FR
ExtrinsicCalibTransZ Double Extrinsic calibration, transition in Z direction
Unit: millimetres
ExtrinsicCalibRotX Double Extrinsic calibration, rotation around X axis
Unit: degrees
ExtrinsicCalibRotY Double Extrinsic calibration, rotation around Y axis
Unit: degrees
ExtrinsicCalibRotZ Double Extrinsic calibration, rotation around Z axis
Unit: degrees
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 enabled
OperatingMode 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 number
ArticleStatus String readonly: Official two-letter status code
UpTime Double readonly: Hours since last reboot
ImageTimestampReference Int readonly: This returns the current timestamp as a
reference for the timestamps in the received images.
Unit:
microseconds
TemperatureFront1 Double readonly: Temperature measured in the device.
Unit: celsius Measured by first sensor on imager board.
47
Caméra 3D

TemperatureFront2 Double readonly: Temperature measured in the device.
Unit: celsius Measured by second sensor on imager board.
TemperatureIllu Double readonly: Temperature measured in the device.
Unit: celsius Measured on the illumination board.
*has limits: parameters with this marker are listed in the reply of getAllParameterLimits method.
Default values of device config parameters

The default values of the device configuration parameters are:
Name String (utf8) "New sensor"
Description String (utf8) ""
ActiveApplication Int 0
*has limits
PcicTcpPort Int 50010
PcicProtocolVersion Int 3
*has limits
IOLogicType Int 1
*has limits
IODebouncing Bool true
IOExternApplicationSwitch Int 0
*has limits
SessionTimeout Int 30
*has limits
ExtrinsicCalibTransX Double 0.0
Unit: millimetres
ExtrinsicCalibTransY Double 0.0
Unit: millimetres
ExtrinsicCalibTransZ Double 0.0
Unit: millimetres
ExtrinsicCalibRotX Double 0.0
Unit: degrees
ExtrinsicCalibRotY Double 0.0
Unit: degrees
ExtrinsicCalibRotZ Double 0.0
Unit: degrees
IPAddressConfig Int 0
PasswordActivated Bool false
OperatingMode Int 0
ServiceReportFailedBuffer Int 15
ServiceReportPassedBuffer 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).
48
Caméra 3D
Minimum and maximum values of device config parameters

The minimum and maximum values of the device configuration parameters are:
Parameter name Minimum value Maximum value
ActiveApplication 0 32
PcicProtocolVersion 1 4
IOLogicType 0 1
IOExternApplicationSwitch 0 3
SessionTimeout 5 300
13.5.6 Device/Network Config Object

FR
saveAndActivateConfig
Method 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.
13.5.7 Application Config Object

save
Method name save
Description Stores current configuration in persistent memory.
This is also be possible if the application is not yet in an "activatable"
status.
forceTrigger
Method name forceTrigger
Description Executes a software trigger of currently active application.
Validate
Method name validate
Description Validates the application. This means it checks if the application can
be activated.
Output parameters Array of fault structs (Id: int, Text: string)
Fault scenarios none
49
Caméra 3D
Parameters of application
Name String (utf8) User-defined name of the application
Description String (utf8) User-defined description of the application
TriggerMode Int Allowed values:
*has limits 1: free run
2: process interface
3: positive edge
4: negative edge
5: positive and negative edge
PcicTcpResultOutputEnabled Bool Allows to disable the automatic output of results via
PCIC.
If it is false, PCIC commands could be used to access
the data again.
PcicTcpResultSchema 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 (→ 13.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 use
TemplateInfo 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 parameters

The default values of application parameters are:
Name String (utf8) "new application"
Description String (utf8) ""
TriggerMode Int 1
*has limits
PcicTcpResultOutputEnabled Bool true
PcicTcpResultSchema String ""
LogicGraph String ""
Type String "Camera"
TemplateInfo String ""
50
Caméra 3D
Minimum and maximum values of application parameters

The minimum and maximum values of application parameters are:
TriggerMode 1 5
13.5.8 Application/Imager Config Object

changeType
Method name changeType
Description Changes the type of imager configuration.
This changes setting of available parameters and might also change
FR
available RPC methods.
Input parameters Type: string
availableTypes
Method name availableTypes
Description Lists all available imager configuration types.
Output parameters Array of strings
Parameters of all types of application imager config

Type String readonly: Type of imager configuration, see Change
Type Method
FrameRate Double Target frame rate in frames per second for free run
mode.
*has limits
ClippingLeft Double Lower value of clipping area in width
*has limits
ClippingTop Double Lower value of clipping area in height
*has limits
ClippingRight Double Upper value of clipping area in width
*has limits
ClippingBottom Double Upper value of clipping area in height
*has limits
ContinuousAutoExposure Bool Enables the continuous adaptation of the
integration time during decoding
51
Caméra 3D

SpatialFilterType Int Allowed values:
*has limits 0: off
1: median filter
2: mean filter
3: bilateral filter
TemporalFilterType Int Allowed values:
*has limits 0: off
1: temporal mean filter
2: adaptive exponential filter
EnableFilterDistanceImage Bool Activates the filter for the distance image
EnableFilterAmplitudeImage Bool Activates the filter for the amplitude image
EnableAmplitudeCorrection Bool Enables the correction of the amplitude values
EnableRectificationDistanceImage Bool Enables the rectification of the distance image
EnableRectificationAmplitudeImage Bool Enables the rectification of the normalized
amplitude image
ExposureTimeList 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.
*has limits: parameters with this marker are listed in the reply of getAllParameterLimits method
Default values of common imager config parameters

The default values of the common imager configuration parameters are:
Type String "under5m_low"
FrameRate Double 5.0
ContinuousAutoExposure Bool false
SpatialFilterType Int 0
TemporalFilterType Int 0
EnableFilterDistanceImage Bool true
EnableFilterAmplitudeImage Bool true
EnableAmplitudeCorrection Bool true
EnableRectificationDistanceImage Bool false
EnableRectificationAmplitudeImage Bool false
Minimum and maximum values of common imager config parameters

The minimum and maximum values of the common imager configuration parameters are:
FrameRate 0.0167 30.0
SpatialFilterType 0 3
AverageFilterNumPictures 1 25
TemporalFilterType 0 2
52
Caméra 3D
Parameters only in "under5m_low"-type of application imager config

ExposureTime Int Time for the exposure
*has limits The 2nd exposure time will be calculated based on the
first one.
ExposureTimeRatio Int Ratio of long exposure time to short exposure time.
*has limits
Channel Int Allowed values:
*has limits 0: non-group use (like channel1 but additional GUI
option)
1: channel1 FR
2: channel2
3: channel3
Default values of the "under5m_low" mode parameters

Parameter name Data type Default value
ExposureTime Int 1000
Channel Int 0
Minimum and maximum values of the "under5m_low" mode parameters

ExposureTime 0 10000
Channel 0 3
Parameters only in "under5m_moderate"-type of application imager config

ExposureTime Int Time for the long exposure
*has limits The 2nd exposure time will be calculated based on the first
one.
*has limits 0: non-group use (like channel1)
1: channel1
2: channel2
3: channel3
53
Caméra 3D
Default values of the "under5m_moderate" mode parameters

ExposureTimeRatio Int 40
Channel Int 0
Minimum and maximum values of the "under5m_moderate" mode parameters

ExposureTimeRatio 2 50
Channel 0 3
Parameters only in "under5m_high"-type of application imager config

*has limits 0: non-group use (like channel1 but additional GUI option)
1: channel1
2: channel2
3: channel3
Default values of the "under5m_high" mode parameters

Channel Int 0
Minimum and maximum values of the "under5m_high" mode parameters

Channel 0 3
Parameters only in "upto30m_low"-type of application imager config

*has limits
*has limits 0: non-group use (like channel1)
1: channel1
2: channel2
3: channel3
54
Caméra 3D
Default values of the "upto30m_low" mode parameters

Channel Int 0
Minimum and maximum values of the "upto30m_low" mode parameters

Channel 0 3
FR
Parameters only in "upto30m_moderate"-type of application imager config
*has limits The 2nd exposure time will be calculated based on the first
one.
ExposureTimeRatio Int Ratio of long exposure time to short exposure time
*has limits
1: channel1
2: channel2
3: channel3
Default values of the "upto30m_moderate" mode parameters

ExposureTimeRatio Int 40
Channel Int 0
Minimum and maximum values of the "upto30m_moderate" mode parameters

ExposureTimeRatio 2 50
Channel 0 3
55
Caméra 3D
Parameters only in "upto30m_high"-type of application imager config

1: channel1
2: channel2
3: channel3
Default values of the "upto30m_high" mode parameters

Channel Int 0
Minimum and maximum values of the "upto30m_high" mode parameters

Channel 0 3
13.5.9 Image Settings and Filter Parameters

To set the spatial or temporal filter use the general “setter” method.
Parameters of spatial median, spatial mean and spatial bilateral filter

MaskSize Int Allowed values:
0: 3x3
1: 5x5
Parameters of temporal mean filter

NumberOfImages Int Limit: 2..25
56

O3D300 Camera Operating instructions-FR

Transféré par

Droits d'auteur :

Formats disponibles

O3D300 Camera Operating instructions-FR

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

O3D300 Camera Operating instructions-FR

Transféré par

Droits d'auteur :

Formats disponibles

Notice d'utilisation

1.1 Symboles utilisés

1.2 Avertissements utilisés

2.3 Raccordement électrique

2.4 Interventions sur l'appareil

Le logiciel ifm Vision Assistant est disponible à titre gratuit sur :

►► Prendre en considération les tolérances pour le positionnement de l'objet.

►► Eviter des vitres transparentes entre l'appareil ① et l'objet ③.

6.2 Préparer l'appareil pour la mise en service

6.2.1 Limites d'avertissement typiques pour O3D301 / O3D303

Paramètre "Max. background distance"

x = temps d'exposition [ms]

6.2.2 Limites d'avertissement typiques pour O3D311 / O3D313

Paramètre "Max. background distance"

x = temps d'exposition [ms]

6.2.3 Réduire la température de surface

►► Utiliser un conducteur thermique relié à des pièces métalliques.

►► Réduire toute entrave dans l'environnement de l'appareil et la densité d'objets.

►► Monter un ou deux dissipateurs thermiques sur l'appareil.

►► Réduire le temps d'exposition, le taux d’images ou la distance maximale visible.

6.3 Monter l'appareil

>> Le kit de montage est disponible comme accessoire (→ 6.4).

6.4 Accessoires de montage

Informations sur les accessoires disponibles sur :

7.1 Schéma de branchement

7.1.1 Bornes 1 / 3 (24 V / GND)

7.1.2 Borne 2 (entrée trigger)

7.1.3 Bornes 4 / 5 (ready / cascading)

7.2 Exemples de câblage

7.2.1 Déclencher la capture d'images avec un détecteur de proximité

La figure suivante montre le câblage de l'appareil à un détecteur de proximité.

7.2.2 Utiliser plusieurs appareils l'un près de l'autre

LED 4 LED 1 LED 2 LED 3 Description

Chenillard ⇒ L’appareil démarre

9.2 Détecter un objet

10. Maintenance, réparation et élimination

10.2 Mettre à jour le progiciel

Les mises à jour du progiciel sont disponibles sur l'internet.

10.3 Remplacer l'appareil

O3D300 ② Unité d'éclairage

12.2 O3D301 / O3D311

13.2 XML-RPC Interface

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

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

13.2.1 Sample XML-RPC command

The following example contains one O3D3xx command:

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

cancelSession(...) removes itself from RPC. Session will also

setOperatingMode(0) will remove EditMode from RPC

stopEditApplication() will remove ApplicationConfig from RPC

Application Config Object (editable application)

Application/Imager Config Object (O3D3xx)

Image Settings and Filter Parameters

13.3 Process Interface

13.3.1 Sending Commands

They are different protocol versions available:

13.3.2 Receiving Images

13.3.3 Image data

Available chunk types: