Programming Manual

ifm Vision Assistant

for 3D sensor UK

O3D300
O3D302
O3D310
O3D312
07/2016
706401 / 05
ifm Vision Assistant O3D3xx 3D sensor

Contents
1 Preliminary note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1 Symbols used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Safety instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 Other documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1 Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Hardware and accessories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1 Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.2 Software (ifm Vision Assistant) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 Start screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.1 Find device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1.1 Direct search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1.2 Manual connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.1.3 Options after connection setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.2 Last used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.3 Replay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.4 Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.6 Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5 User interface layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.1 Navigation bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.2 Status bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.3 Main area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6 Setup wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.1 Live image display of the setup wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2 Completeness detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.2.1 Set up completeness application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.2.2 Activate completeness application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32
6.2.3 Send process values via EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.2.4 Sending process values via TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.3 Dimensioning of rectangular objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.3.1 Setting up dimensioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
6.3.2 Activate object dimensioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.3.3 Send process values via EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
6.3.4 Sending process values via TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
6.4 Filling level measurement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.4.1 Setting up the filling level measurement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
6.4.2 Activate the filling level measurement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.4.3 Send process values via EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
6.4.4 Send process values via TCP/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
7 Monitoring screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
7.1 Status displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
7.2 View options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
7.2.1 2D view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
7.2.2 3D view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
7.2.3 Slide control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
7.3 Record options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
7.4 Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
7.4.1 Depiction of the model results for the completeness application . . . . . . . . . . . . . . . . . . . . . 72
7.4.2 Depiction of the model results for dimensioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.3 Depiction of the model results for filling level measurement . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.4.4 Depiction of the model result in extended programming mode . . . . . . . . . . . . . . . . . . . . . . . 73
7.5 Service reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
7.6 Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.7 Exit the monitoring screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

2
 ifm Vision Assistant O3D3xx 3D sensor

8 Extended programming mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

8.1 Activating extended programming mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
8.2 Live image display in extended programming mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
8.2.1 Save image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
8.2.2 Load image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
8.2.3 Set live image view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
8.3 Image settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
8.3.1 Set trigger source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
8.3.2 Set maximum background distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
8.3.3 Setting the exposure mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
8.3.4 Setting the target frame rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
8.3.5 Apply filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 UK
8.3.6 Defining the 3D clipping box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
8.3.7 Operating multiple devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
8.4 Defining the models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
8.4.1 Defining the model type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
8.4.2 Defining a reference plane (only for model type “Filling level”) . . . . . . . . . . . . . . . . . . . . . . . 90
8.4.3 Defining and editing ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
8.4.4 Defining and editing RODs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
8.4.5 Activating position tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
8.4.6 Defining the ROI distance value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
8.4.7 Defining the setpoint values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
8.4.8 Model results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
8.5 Creating output logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
8.5.1 General setting rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
8.5.2 Placing logic modules and assigning signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
8.5.3 Description of the logic modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
8.6 Set the interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
8.7 Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
8.8 Programming an example application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
9 Application management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
9.1 Activate application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
9.2 Edit application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
9.3 Add new application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
9.4 Import application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
9.5 Export application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
9.6 Duplicate applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
9.7 Resort application list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
10 Device setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
10.1 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
10.1.1 Name and description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
10.1.2 Password protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
10.1.3 Firmware update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
10.1.4 Export settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
10.1.5 Import settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
10.1.6 Factory settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
10.1.7 Reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
10.2 Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
10.3 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
11 Device information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
12 Annex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
12.1 Network settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
12.2 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Licenses and trademarks
Microsoft®, Windows®, Windows Vista®, Windows 7®, Windows 8®, Windows 8.1® and Windows 10® are registered trademarks of the
Microsoft Corporation.
Adobe® and Acrobat® are registered trademarks of Adobe Systems Inc.
All trademarks and company names used are under copyright by the respective companies.
This device contains open source software (modified as necessary) that is subject to special licence terms.
Copyright information and licence terms can be found at: www.ifm.com/int/GNU
Source text for software that is subject to the GNU General Public License or the GNU Lesser General Public License can be
requested; only copying and shipping costs will be collected.

3
ifm Vision Assistant O3D3xx 3D sensor

1 Preliminary note
This document describes the following functions of the 3D sensor from the O3D3xx product family and
the ifm Vision Assistant software:
●● Sensor parametrisation (referred to hereafter as “device”)
●● Setting up applications with the ifm Vision Assistant
●● Monitoring applications with the ifm Vision Assistant
Once an application has been set up on the device, the device can be operated without the ifm Vision
Assistant.

1.1 Symbols used

► Instructions
> Reaction, result
[…] Name of keys and buttons
”…” Name of display text
→ Cross-reference
Important notice
Non-compliance can result in malfunctions or faults.
Information
Supplementary note

1.2 Safety instructions

Before commissioning the device, read the instruction manual. Ensure that the device is entirely suitable
for the application.
If the operating instructions or the technical data are not adhered to, personal injury and/or damage to
property can occur.

1.3 Other documents

Document Article code
Operating instructions 706398
Short instructions 80236220

The documents can be downloaded from:

www.ifm.com → Data sheet search → e.g. O3D302 → Operating instructions

4
 ifm Vision Assistant O3D3xx 3D sensor

2 System requirements
2.1 Software
Windows 7 (32/64 bit), Windows 8.1 (32/64 bit), Windows 10 (32/64 bit)

2.2 Hardware and accessories

Hardware
–– Sensor from the O3D3xx family
–– PC with x86 or x64 processor UK
–– Screen: at least 1024 x 768 pixels, 32 bit colour depth
Accessories
–– Network connection cable (Ethernet) for setting parameters, 4-pin, M12 plug/RJ45 plug, art. no.:
E11898 (2 m) or E12283 (5 m)
–– Connecting cable for power supply and process connection, M12 socket, e.g. art. no. E11950 (8-pin,
2 m, open cable end). This cable is used to connect the O3D3xx sensor to the power supply.
–– 24 V, 1.6 A power supply, peak current at least 2.4 A

Further information about available accessories can be found at www.ifm.com.

5
ifm Vision Assistant O3D3xx 3D sensor

3 Installation
3.1 Hardware

For 8-pin cable sockets, the wire colours are not standardised.
►► Observe the pin arrangement at the device and the cable socket → data sheet.
►► Connect the device to the power supply.
►► Using the network cable, connect the device to the Ethernet port on the PC.
1: 24 V power supply
2: Device
3: Ethernet cable
4: PC

1 2 3 4

Further information about the electrical connection and the exact pin configuration can be found in
the → short instructions or the operating instructions.

Measures to prevent multiple reflections

Multiple reflections can occur when measuring the following objects:
●● Very reflective surfaces
●● Interior walls of hollow items (e.g. boxes)
●● Surfaces a small distance from the device (e.g. walls)
Multiple reflections extend the time taken by the light and therefore create the illusion of a greater
distance from the device.
1: Multiple reflection at a nearby
surface
1 2 The apparent distance is shown
in blue.
2: Correct installation

►► Install the device at a sufficient distance from surfaces.

►► Do not place the device on a flat surface (e.g. a table) for a demonstration.

6
 ifm Vision Assistant O3D3xx 3D sensor

3.2 Software (ifm Vision Assistant)

►► Insert the data carrier with the ifm Vision Assistant software.
Alternatively: download ifm Vision Assistant from the ifm website:
www.ifm.com > Service > Download > Industrial Image Processing > 3D Sensors > e.g. O3D302
►► Transfer the “ifmVisionAssistant” zip file to an appropriate directory and unzip it.
►► Run the “ifmVisionAssistant” application file.

UK

>> The ifm Vision Assistant start screen opens.

►► If the start screen does not appear within 5–10 seconds, verify that the software requirements are
satisfied and that the files have been completely and correctly unzipped.

7
ifm Vision Assistant O3D3xx 3D sensor

4 Start screen
The start screen allows selection of the basic functions of the ifm Vision Assistant.

Basic functions on the start screen:

Symbol Name Function Must a device be

connected
Find device Connection with a newly connected device. Yes
Searches for connected devices and displays a selection list of
devices found (→ “4.1 Find device”).

Last used Connection with a device that has already been connected and may Yes
already be configured.
Opens a selection list of devices that have previously been connected
(→ “4.2 Last used”).
Replay Replay recorded sequences (→ “4.3 Replay”). No

Wiring Displays the wiring of the power supply. No

The display provides connection assistance during commissioning
(→ “4.4 Wiring”).

Settings Language and image mode settings of the user interface (→ “4.5 No
Settings”).

Close Closes the ifm Vision Assistant. No

8
 ifm Vision Assistant O3D3xx 3D sensor

4.1 Find device

This function searches for connected devices or establishes a manual connection to a device that has
been connected to the PC.

►► Ensure that the device and the PC are operational and that there is an Ethernet connection between
them.
>> If there is no Ethernet connection, the device functions will not be accessible.

The following ports must be open (adjust firewall settings, if necessary):

●● UDP: 3321 UK
●● TCP/HTTP: 80 and 8080
●● TCP: 50010

4.1.1 Direct search

►► Click on .
>> The ifm Vision Assistant searches for connected devices via Ethernet.
>> All devices found are displayed in a selection list.
►► Click on the button for the found device to establish a connection.

►► If the ifm Vision Assistant does not automatically find a device:

●● Check that the device is correctly connected and operational, and click on [Search completed]
to restart the search.
●● Connect the device directly to the PC, not via other network components (such as routers).
●● Click on [Manual connection] and enter the IP address (→ “4.1.1 Direct search”).

9
ifm Vision Assistant O3D3xx 3D sensor

Buttons and messages following a direct search:

Button and message Description
Starts a new search.

Allows manual input of the IP address (→ “4.1.2 Manual connection”).

Displays information e.g. IP address, name of device and the firmware version.
Connects the device and continues, depending on application data (→ “4.1.3 Options after
connection setup”).

If the IP address is automatically detected (through DHCP), it can take 1-2 minutes before
the device connection is established and ready for use.

4.1.2 Manual connection

If the ifm Vision Assistant was unable to establish a connection to the device automatically, the IP address
can be manually entered using the [Manual connection] button.

►► Click on .
►► Click on [Manual connection].
>> The “Manual connection” window appears:

►► Select “O3D3XX manual connection”.

►► Enter the IP address of the device (default: 192.168.0.69).

►► Click on [Connect].

10
 ifm Vision Assistant O3D3xx 3D sensor

●● The IP addresses of device and PC with ifm Vision Assistant must be in the same subnet.
●● If the IP address should be retained as a device address, the device must be restarted after the
setup process (→ “10.1.7 Reboot”).

4.1.3 Options after connection setup

Once a connection to the device has been successfully established, the ifm Vision Assistant continues
with one of the following options depending on the condition of the stored data:

Condition Option
No application available Edit screen opens (→ “9 Application management”). UK
Active application available Monitoring screen opens (→ “6.4 Filling level measurement”).
At least one application is available, but none is active Application management opens (→ “9 Application management”).
Error Error message is displayed.

Initial configuration – no applications available

There are no applications installed on a new device. Neither are there any applications available following
a firmware update, a reset to the factory settings, or manual deletion of all applications.
The ifm Vision Assistant automatically opens the setup wizard to generate a new application. The setup
wizard leads the user step-by-step through the entire configuration process (→ “6 Setup wizard”).
Alternatively, extended programming mode can be started (→ “8 Extended programming mode”).
►► To load an application from a file, close the setup wizard.
►► Import application (→ “9.4 Import application”).

The setup wizard also starts when a new application is added manually or an existing application is
edited.

Active application available

If an application for the device exists and is activated, the ifm Vision Assistant continues with the
monitoring screen (→ “6.4 Filling level measurement”). The application must be paused if parameters are
to be changed.

Inactive applications available

If there are applications on the device but none of them is activated, the ifm Vision Assistant continues
with application management (→ “9 Application management”). The application management screen also
opens if for instance the application last activated has since been deleted.

11
ifm Vision Assistant O3D3xx 3D sensor

4.2 Last used

This function opens a selection list containing devices that have previously been connected.

►► Click on .

►► Ensure that the desired device has an Ethernet connection to the PC or can be reached through the
network.
►► Click on the device in the selection list.
>> The ifm Vision Assistant will now establish a connection to the device (→ “4.1.3 Options after
connection setup”).

12
 ifm Vision Assistant O3D3xx 3D sensor

4.3 Replay
This function allows previously recorded data to be viewed (→ “6.4 Filling level measurement”). It is not
necessary that a device is connected.

►► Click on .
►► Select the desired file (*.dat) and click on [Open].

UK

>> The replay screen is displayed.

13
ifm Vision Assistant O3D3xx 3D sensor

Options on the replay screen:

Tab Option / button Description

Replay controls Pauses replay.
Pause
Pauses replay and displays the previous frame.
Go to previous frame
Pauses replay and displays the next frame.
Go to next frame
Continues replay.
Start
Progress bar Shows the current recording position.
Clicking on a position in the progress bar continues replay of the respective
image.
Opens a window in which other files can be selected.

View options – → “7.2 View options”

– Closes the replay screen and opens the start screen.

►► Click on [Close] to return to the start screen.

4.4 Wiring
This function allows the correct wiring of the 8-pin plug’s power supply to be displayed.

►► Click on .

►► Select product [O3D].

>> Necessary only if a device has been newly selected.

►► Select interface type [8-pin] (necessary only if a device has been newly selected).

14
 ifm Vision Assistant O3D3xx 3D sensor

UK

►► Click on the [Article no. of cable] selection field and choose the connecting cable from a selection list.
>> The wiring of the selected connecting cable’s power supply is displayed.

15
ifm Vision Assistant O3D3xx 3D sensor

4.5 Settings
This function allows changing the language and toggling between full screen and window display.

►► Click on .
>> The “Settings” window is displayed.

Options in the Settings window:

Field Option Description

Select language English Selection of the languages available.
German The default setting is “English”.
etc.
Activate full screen Toggles between full screen (“On”) and window display (“Off”).
On The default setting is full screen.

Off

The F11 key allows toggling between full screen and window display at any time.

4.6 Close

►► Click on to close the ifm Vision Assistant.

16
 ifm Vision Assistant O3D3xx 3D sensor

5 User interface layout

The ifm Vision Assistant screen has the following areas:
●● Navigation bar:
The navigation bar on the left side allows selection of desired options (→ “5.1 Navigation bar”).
●● Main area:
The main area displays the selected option or application.
●● Status bar:
The status bar at the lower edge of the screen displays device status information.
UK

1: Navigation bar
2: Main area
3: Status bar

17
ifm Vision Assistant O3D3xx 3D sensor

5.1 Navigation bar

The navigation bar on the left side of the screen contains the following options:

Button Name Description

Opens a 2D or 3D view and displays the current device data (→ “6.4 Filling
Monitor
level measurement”).

Opens an overview of the applications (→ “9 Application management”).

Application settings
Management and configuration of the applications.

Opens the configuration setup for the device (→ “10 Device setup”).
Device setup
Perform device settings irrespective of the applications.

Displays basic information e.g. hardware, firmware, and device status (→ “11
Device information
Device information”).

Settings Opens the “Settings” window (→ “4.5 Settings”).

Breaks the connection between the ifm Vision Assistant and the device.
Disconnect
The ifm Vision Assistant returns to the start screen.

5.2 Status bar

The status bar at the lower edge of the screen displays the following information:
●● Displays the name of the window that is currently being used, e. g. “Monitoring screen”
●● Temperature information on the device, e. g. “Temperature normal”
●● Name and IP address of the device, e. g. “New Sensor (192.168.0.69)”
●● Firmware version of the device, e. g. “0.06.39”
●● Name or status of the application that is currently running, e. g. “Test application” or “Stopped”
●● Frame duration of the device, e. g. “232 ms”

5.3 Main area

Whilst the device is in operation, the main area displays the monitoring screen (→ “6.4 Filling level
measurement”). Whilst the device is being set up, the main area displays the corresponding screens.

18
 ifm Vision Assistant O3D3xx 3D sensor

6 Setup wizard
The setup wizard starts up in the following cases:
●● A device without any saved application is connected.
●● A new application is added.
●● An existing application is modified.
The following pre-set applications are available:
●● Completeness detection
●● Dimensioning of rectangular objects UK
●● Filling level measurement

►► Click on the application to be set up.

>> Step-by-step configuration of the selected application begins.
Pressing the [Extended programming mode] button activates the extended programming mode.
The ifm Vision Assistant exits the setup wizard and switches to the application edit screen
(→ “8 Extended programming mode”).
Basic functions of the setup wizard:
Button Function
Start Starts the configuration of the selected application.
Continue with the next step.
Next
The button is locked if a required configuration has not yet been carried out.
Return to the previous step.
Back
From step 1, the user returns to the setup wizard start page.
Finish Completes the final step of the configuration and saves the set parameters in the device.

19
ifm Vision Assistant O3D3xx 3D sensor

6.1 Live image display of the setup wizard

The setup wizard displays live images during configuration.

The following video options can be set using the “Video capture” menu bar:
Button Video option Description

The image is continuously updated, independently of the trigger source set in the
Live image
application.

The image is updated once upon selection, independently of the trigger source
Actuate trigger
setting.

The image is updated each time a trigger signal is received from the trigger source
Respond to trigger
setting.
The image is updated the next time a trigger signal is received from the trigger
Wait for trigger
source setting.

The display options can be set using the menu bar below the image. The display options for the live
images are identical to the display options of the monitoring screen (→ “6.4 Filling level measurement”).

20
 ifm Vision Assistant O3D3xx 3D sensor

6.2 Completeness detection

This application checks the integrity of uniformly filled containers. It can detect whether objects are
missing (underfill) and/or whether too many objects are present (overfill).
The objects in the container must be arranged in a rectangular grid. The maximum number of objects per
side is 16 for a maximum of 64 objects.
An ROI (Region of Interest) is defined for each object. In each ROI a filling level is measured and
compared with limiting values.

Measured filling level in the ROIs Result

Within the determined parameters Object correct – container completely full
UK
Below the minimum limit OUT 1 switches
Over the maximum limit OUT 2 switches

The process interface outputs the measured values of the individual ROIs (overfill or underfill
“good”/”invalid”).
Object requirements for reliable recognition:
●● Minimum height of static objects (speed ≤ 0.2 m/s): 2.5 cm
●● Minimum height of moving objects (speed > 0.2 m/s): 4.5 cm
●● Diffusely reflecting surface
●● For a shiny surface: Avoid direct reflection back to the device

Where different container shapes are to be checked, a separate application must be created
for each container shape. The active application can then be switched to that appropriate to the
packing shape that is expected.

Completely transparent or reflective surfaces cannot be reliably measured.

6.2.1 Set up completeness application

►► Click on [Start] to start configuration of the application.

21
ifm Vision Assistant O3D3xx 3D sensor

Step 1: Control functionality

►► Set the button for underfill (missing objects) to “On” or “Off”, depending on the application.
►► Set the button for overfill (too many objects) to “On” or “Off”, depending on the application.
>> At least one of the two options must be activated.

Notifications of underfill are always output at OUT 1.

Notifications of underfill are always output at OUT 2.

►► Selecting the type of output logic:

Type of output logic Description

If an underfill or overfill is registered, the respective output is set to logical One (high) and remains at
Static
that value until the next measurement.
If underfill or overfill is registered, the respective output is set to logical One (high) for the set duration
Pulsed and then changes back to logical Zero (low) again. For this purpose, the pulse frequency must have
been input (range 10…2500 ms in steps of 10 ms).

►► Click on [Next].

22
 ifm Vision Assistant O3D3xx 3D sensor

Step 2: Trigger & velocity

UK

►► Select trigger source.

Selection Description
Continuous The device creates images continuously. This option is mainly used for tests.
Process interface The device is activated through the process interface of the connected controller (e. g. PLC or PC).

ON ON

Iinput

Trigger

Trigger
The device is activated by hardware using the rising edge of the input
Positive edge
signal.
OFF OFF
Iinput t

ON ON
Trigger

Trigger
The device is activated by hardware using the falling edge of the input
Negative edge
signal.
OFF OFF
t

►► Setting the [Velocity} button:

●● For measuring static objects, set the button to “Off”. The object must be stationary for at least
100 ms.
●● For measuring moving objects, set the button to “On”. In this box the switching setpoints for
underfill and overfill in the OK status are determined automatically. The switching setpoints can be
adjusted again in the last step of the Assistant (→ Step 5: Overall test).
►► Set the button for the anchor function (automatic position tracking of containers) to “On” or “Off”.

●● If the anchor function is switched off, the container must always be in the same location and
orientation for the application to function correctly.
If the anchor function is switched on, the orientation of the container is detected and the
positions of the ROIs are adapted to the position of the objects. This increases the evaluation
times. For reliable recognition of the objects, a sufficient number of contours of the container
must be recognisable.
●● The evaluation time may be increased when the anchor function is switched on.
●● The anchor function must be earnt afresh if the ROIs change.
►► Click on [Next].
>> The exposure time for the current scene is optimised automatically.

23
ifm Vision Assistant O3D3xx 3D sensor

Step 3: Region of Interest (ROI)

The “Region of Interest (ROI)” window displays live images that allow the number, shape, and size of
ROIs to be set. The exposure time can then be optimised.
►► If not selected, set the video option [Live image] (→ “6.1 Live image display of the setup wizard”).
►► Place a correctly filled container centrally under the device, and by changing the position of the
container and / or the device make sure the following conditions are satisfied:
●● The container must be completely within the image, with all four corners visible.
●● The distance from the device must be between 0.3 m and 5 m.
●● No objects in the image section (including the background) are more than 5 m from the device.
An inclined view distorts the object grid and impairs the detection of objects in the ROIs.
►► The device must be as nearly perpendicular to the container as possible.

Perpendicular Inclined (distorted)

►► If there are shiny surfaces (e. g. polished metal, foil-wrapped products):

Avoid back reflection of the light from the device by tilting the device slightly.
►► Set up the display options so that the ROIs can be properly adjusted (→ “7.2 View options”).

24
 ifm Vision Assistant O3D3xx 3D sensor

Whether it is better to display a distance image or an amplitude image (brightness) depends on the
shape and reflectivity of the container and the objects.
●● Amplitude image: Container and objects with high contrast reflectivity values in the infrared
range
●● Distance image: Distinctive object and container shapes (e.g. a box with bottles)

►► After modifying the display options, click on to optimise the view.

►► Setting the ROIs. UK
Setting the ROI Option Description
Select the number of rows in a multi-row ROI: 1…16
Rows
Maximum value of rows x columns ≤ 64
Select the number of columns in a multi-column ROI: 1…16
Columns
Maximum value of rows x columns ≤ 64
Regular
The centre points of the ROIs are directly above each other and directly alongside each
other.

In “honeycomb ...” type grids, the centre points of the ROIs in a row are above or
Honeycomb
below the gaps between the ROIs in the adjoining rows. This results in a hexagonal or
...
honeycomb structure of the ROIs with the following differences:
Short
Type of grid honeycomb The rows with even ordinal numbers (2nd row, 4th row, ...) are one ROI shorter than the
rows with odd ordinal numbers (1st row, 3rd row, ...).
When a multi-row ROI with an even number of rows is rotated 180°, a “Short
honeycomb” grid type becomes identical to a “Long honeycomb” grid type.

Long
honeycomb The rows with odd ordinal numbers (1st row, 3rd Row, ...) are one ROI shorter than the
rows with even ordinal numbers (2nd row, 4th row, ...).
When a multi-row ROI with an odd number of rows is rotated 180°, a “Long honeycomb”
grid type becomes identical to a “Short honeycomb” grid type.

Right-hand The number of ROIs in each row is now identical. The ROIs in the rows with even ordinal
honeycomb numbers (2nd row, 4th row, ...) are displaced to the right compared to the ROIs in the
rows with odd ordinal numbers (1st row, 3rd row, ...).
When a multi-row ROI with an odd number of rows is rotated 180°, a “Right-hand
honeycomb” grid type becomes identical to a “Left-hand honeycomb” grid type.

Left-hand The number of ROIs in each row is now identical. The ROIs in the rows with even ordinal
honeycomb numbers (2nd row, 4th row, ...) are displaced to the left compared to the ROIs in the
rows with odd ordinal numbers (1st row, 3rd row, ...).
When a multi-row ROI with an odd number of rows is rotated 180°, a “Left-hand
honeycomb” grid type becomes identical to a “Right-hand honeycomb” grid type.

Square

Rectangle
Select the shape that coincides best with that of the object.
Circle

Ellipse

[–] Zooms out from the ROIs

Shape size
[+] Zooms in on the ROIs

►► Adjust the number of ROIs to the number of objects in the container.

►► Adjust the size and shape of the ROIs to the objects in the container.

25
ifm Vision Assistant O3D3xx 3D sensor

►► Set up the outer frame so that the ROIs coincide well with the objects:
●● To scale the frame: Click on the outer frame and drag it with the mouse key depressed.
●● To rotate the frame: Click on the spin arrow symbol and drag it with the mouse key depressed.

A good initial value for the configuration is one that covers 80% of the objects with the ROIs. For
the measurements, only the ROIs are needed; the frame is just a positioning aid.

>> Each ROI is depicted with its own frame.

►► When the ROIs have been configured to the objects, click on [Optimise].
>> The exposure time for the objects in the ROIs is optimised automatically.
Even after the exposure time has been optimised, the background may contain invalid pixels or
significant image noise. These will not affect the measurement.
►► Click on [Next].

During the following steps in the teaching process, the objects must not move, otherwise the
application cannot function correctly. This is true even if the anchor function has been activated.
The anchor function only works when the teaching of good and bad conditions has been
completed.

Step 4: Teach an ideal condition

In this step, the device measures reference values for a correctly filled container.

►► Click on [Teach].
>> [Next] remains disabled until teaching has been successfully completed.
>> The current scene is recognised as the full status. The switching setpoints for underfill and overfill are
determined depending on the “Velocity” setting (→ Step 2: Trigger source & velocity).
>> If the automatic position tracking (anchor function) is activated, an attempt is made in an area around
the ROIs to identify contours (edges) that mark the edge of the container. Using the contours that are
found, a container model is created, and the quality of the model is then evaluated. If the quality of the
container model is insufficient to recognise reliably the container in the image, an error message is
displayed in the live image.

26
 ifm Vision Assistant O3D3xx 3D sensor

If the teaching is unsuccessful:

Cause Corrective action
►Go
► back to Step 3 and set the ROIs again.
►Avoid
► moving the objects:
–– If the anchor function is switched off:
Make sure that the objects occupy the same image
The object has moved. position in each frame. This can be achieved using the
hardware trigger.
–– If the anchor function is switched on:
Check whether the anchor function can reliably determine
the moved objects.
The anchor function is on and the properties of the container
or the object are insufficient to reliably determine position and ►Go
► back to step 2 and turn the anchor function off. UK
orientation.
►Reduce
► saturation by tilting the device slightly.
Too many pixels in the ROIs are overexposed due to direct
►Go
► back to step 3 and click on [Optimise] to set the ROIs
reflection.
again.
►Ensure
► that the exposure time was optimised in step 3.
Too many pixels in the ROIs are overexposed due to objects
►If
► optimising the exposure time brings no improvement, zoom
that are too bright.
the device out.
►Ensure
► that the exposure time was optimised in step 3.
Too many pixels in the ROIs are underexposed. ►If
► optimising the exposure time brings no improvement, zoom
the device in.

Going back to Step 3 and changing the settings (ROIs, exposure, object or sensor movement)
means the teaching must be repeated. Otherwise the application will not function correctly.

►► After the problem has been resolved, click on [Teach] again.

►► Click on [Next].

Step 4.1: Teach an underfilled condition

If the recognition of an underfill condition was not turned on in Step 1, the Assistant will skip this
step.

During the teaching process, a limiting value for underfill is determined. The limiting value for the underfill
can be adjusted again in the last step of the Assistant (→ Step 5: Overall test).

►► Remove an object from the container and click on [Teach].

27
ifm Vision Assistant O3D3xx 3D sensor

>> If no object was removed, or the difference between the full and empty conditions is too small, the
teaching will fail.
►► Click on [Next].

Step 4.2: Teach on overfilled condition

If the recognition of an overfilled condition was not turned on in step 1, the Assistant skips this step.

During the teaching process, a limiting value for overfill is determined. The limiting value for the underfill
can be adjusted again in the last step of the Assistant (→ Step 5: Overall test).

►► Add an object to a correctly filled container and click on [Teach].

>> If no object was added, or the difference between the full and empty conditions is too small, the
teaching will fail.
►► Click on [Next].

28
 ifm Vision Assistant O3D3xx 3D sensor

Step 5: Test
In the final step, the application functions are tested:
●● Device limiting value (e.g. underfill, overfill)
●● Output signal to the outputs
●● Wiring

UK

On the left side, the device image with the ROIs and their measurement results is displayed.
Colour Meaning
Green OK
Red Underfill
Violet Overfill
Olive green Invalid
Yellow Selected

The status LEDs for the outputs are shown at the top right.
●● If LED OUT 1 lights up yellow: An underfill condition has been registered and OUT 1 is active.
●● If LED OUT 2 lights up yellow: An overfill condition has been registered and OUT 2 is active.
●● When an output is active the LED remains lit. The setting in step 1 to an impulse or to [static] makes
no difference to this.

The LEDs for OUT 1 and OUT 2 displayed on the screen are identical to the LEDs on the device.

The buttons below the LEDS allow toggling between the following screens:
●● Results
●● Process interface
●● Wiring test

29
ifm Vision Assistant O3D3xx 3D sensor

Results
The “Results” window displays the measurement results in a bar graph. If one screen is insufficient to
display all results, a horizontal scroll bar appears. The numbers and colour codes of the ROIs are the
same in the image as in the bar graph. If a ROI is highlighted by clicking on it, the corresponding line
becomes dark yellow.
During active recognition of underfill or overfill, a coloured line marks the relevant limiting value:
●● Red (upper line): Overfill
●● Violet (lower line): Underfill

►► Test the application by removing or adding objects.

►► If the test is unsuccessful, optimise the settings, e. g.:
–– adapt the limiting values by shifting the coloured lines vertically.
–– Go back to Step 3, set up the ROIs again and repeat teaching in Step 4.
►► If the anchor function has been activated, test it by moving and rotating the container.

30
 ifm Vision Assistant O3D3xx 3D sensor

Process interface
The “Process interface” window displays a table with the status of the ROIs and the process values
(→ “6.2.3 Send process values via EtherNet/IP”). Below the table, the output string which the device
sends through the process interface is displayed. The output string can be copied on to the Windows
clipboard.

UK

Wiring test
The “Wiring test” window allows testing of the wiring between the device and the controller. The test runs
in real time and displays the output and input signals carried by the corresponding wires. In simulation
mode, the digital outputs can be controlled manually so that the connection to an external controller can
be tested independently of the application.

►► Click on the [Article number] selection field and input the article number choose the connecting cable
from the selection list.
>> The wiring and pinout of the selected connecting cable is displayed.
►► Click on [Start] to begin simulation mode.
►► Click on [OUT 1] to toggle between “On” and “Off” for the signal to OUT 1.
►► Click on [Ready] to toggle between “On” and “Off” for the “Ready for the next trigger” output signal.

31
ifm Vision Assistant O3D3xx 3D sensor

►► Click on [OUT 2] to toggle between “On” and “Off” for the signal to OUT 2.
►► If the inputs are used, test the input signals at Input 1 and Input 2.

The inputs can be used for instance for switching applications.

►► Click on [Stop] to end simulation mode.

6.2.2 Activate completeness application

►► After all settings have been completed, click on [Finish] to save the application.
>> The device activates and starts the application.
>> The monitoring screen is opened. A bar graph is shown under the “Results” tab there. This shows
values that allow the results of the current application to be monitored (→ “7.4.1 Depiction of the
model results for the completeness application”).

6.2.3 Send process values via EtherNet/IP

The device can send process values to a PLC via the EtherNet/IP protocol. The process values are
displayed in the ifm Vision Assistant as an output string as shown below:

The process values are delimited in the output string by a semicolon. The output string is output to the
PLC is the sequence shown.

When sending the output string to the PLC, comply with the following instructions:
●● Bytes 0 to 7 are part of the output string. They are not displayed in the ifm Vision Assistant
(see screenshot above).
●● The semicolons “;” included in the output string are not sent.
●● Before transmission, float values are converted into binary 16-bit integers.
●● Before transmission, all numeric values are converted into 16-bit integers.

The output string is formatted as follows (data type: SINT):

star;0;00;0;+0.000;01;7;-0.068;02;6;+0.013;03;0;+0.001;stop
Process
Byte no. Data Coding Unit Description Comments
value
0 2#0000_0000 Binary Duplicated Bit 1.5 shows a successful trigger
1.5
1 2#0010_0000 Binary command word command

2 2#0000_0000 Decimal Synchronous /

asynchronous
3 2#0000_0000 Decimal message identification
4 30 Decimal ●● The device has received
30 messages.
30 Message counter
5 0 Decimal ●● Increments by 1 with each action
(trigger, message sent etc.).
6 0 Decimal
Reserved
7 0 Decimal

32
 ifm Vision Assistant O3D3xx 3D sensor

Process
Byte no. Data Coding Unit Description Comments
value
8 s ASCII
9 t ASCII
star Start string
10 a ASCII
11 r ASCII
12 0 Decimal Status of all ROIs Shows states of the
0
13 0 Decimal (0 = bad, 1 = good) completeness monitoring

14 0 Decimal With activated position adjustment

bytes 14 and 15 are used by it.
0 = position is not adjusted
UK
0 ROI ID 1 = position is adjusted
15 0 Decimal
All following data is shifted by 2 bytes;
i.e. the first ROI ID starts with bytes
16 and 17.
16 0 Decimal
0 ROI status
17 0 Decimal
18 0 Decimal
0 mm ROI value
19 0 Decimal
20 1 Decimal
1 ROI ID
21 0 Decimal
22 7 Decimal
7 ROI status ROI status:
23 0 Decimal
0 = good
24 -67 Decimal
-67 mm ROI value 1 = reference level not taught
25 -1 Decimal
2 = teaching failed
26 2 Decimal 3 = reference level invalid
2 ROI ID
27 0 Decimal 4 = no valid pixels
28 6 Decimal 5 = reference level does not contain
6 ROI status any valid pixels
29 0 Decimal
6 = overfill
30 14 Decimal 7 = underfill
14 mm ROI value
31 0 Decimal
32 3 Decimal
3 ROI ID
33 0 Decimal
34 0 Decimal
0 ROI status
35 0 Decimal
36 0 Decimal
0 mm ROI value
37 0 Decimal
38 s ASCII
39 t ASCII
stop Stop string
40 o ASCII
41 p ASCII

Defective execution of a command leads to the following status:

●● Error bit = 1
●● Mirrored command word is displayed
●● Asynchronous message bit = 0
●● Asynchronous message detection = 0
●● Message counter is incremented by 1

33
ifm Vision Assistant O3D3xx 3D sensor

6.2.4 Sending process values via TCP/IP

The device can send process values to a PLC via the TCP/IP protocol. The process values are displayed
in the ifm Vision Assistant as an output string as represented below:

The process values are delimited in the output string by a semicolon. The output string is output to the
PLC is the sequence shown.

The output string is formatted as follows (data type: ASCII):

star;0;00;0;+0.000;01;7;-0.068;02;6;+0.013;03;0;+0.001;stop
Process value Unit Description
star Start string
0 Status of all ROIs (0 = bad, 1 = good)
00 ROI ID
0 ROI status
+0.000 m ROI value ROI status:
0 = good
01 ROI ID
1 = reference level not taught
7 ROI status
2 = teaching failed
-0.068 m ROI value 3 = reference level invalid
02 ROI ID 4 = no valid pixels
6 ROI status 5 = reference level does not contain any valid
pixels
+0.013 m ROI value
6 = overfill
03 ROI ID 7 = underfill
0 ROI status
+0.001 m ROI value
stop Stop string

34
 ifm Vision Assistant O3D3xx 3D sensor

6.3 Dimensioning of rectangular objects

This application measures the position, orientation, and size of rectangular, box-like objects.
Quality parameters can be used for recognition of open brackets or deviations from the box form.
Object requirements for reliable recognition:
●● The object must be stationary
●● The object must be completely within the image and away from the image edges
●● There must be no other objects in the field of vision (other boxes)
●● If there are other objects in the field of vision:
UK
●● Minimum distance between the objects must be: 3 pixels
●● Background must be visible between the objects

If more than one object is in the field of vision, the object that is nearest to the centre of the image
will be the one that is measured.

Device mounting requirements for good measurement results:

●● Mount the device as perpendicularly as possible to the measuring area, so that the object can be
measured from above.

Device inclination reduces the precision. If the inclination is more than 45° the application will not
function.
●● Select the device mounting distance so that the object to be measured is completely in the device’s
field of vision, and there is a margin on all sides.
●● Measurement distance for most applications: 1-2 meters
●● Nothing in the image, including anything in the background, must be more than 5 m away from the
device (radially).

6.3.1 Setting up dimensioning

►► Click on [Start] to start configuration of the application.

35
ifm Vision Assistant O3D3xx 3D sensor

Step 1: Trigger source

►► Select trigger source.

Selection Description
Continuous The device creates images continuously. This option is mainly used for tests.
The device is activated through the process interface of the connected controller
Process interface
(e. g. of the PLC/PC).

Iinput ON ON

Trigger

Trigger
The device is activated by hardware using the rising edge
Positive edge
of the input signal.
OFF OFF
t
Iinput

ON ON
Trigger

Trigger

The device is activated by hardware using the falling

Negative edge
edge of the input signal.
OFF OFF
t

►► Click on [Next].

36
 ifm Vision Assistant O3D3xx 3D sensor

Step 2: Reference plane

In this step, the reference plane, on which the objects to be measured are placed, is taught. This is
necessary for correct measurement results during determination of object dimensions.

UK

The window displays live images in order to allow the configuration of the reference plane.
►► If not selected, set the video option [Live image] (→ “6.1 Live image display of the setup wizard”).
►► Make sure that no objects to be measured are present in the field of view (empty scene).
►► Ensure that the reference plane is flat and reflects well.
●● If the objects are to be measured on a roller track or similar device: place a sheet of stiff paper or
thin cardboard over the measuring area in order to create a flat surface.
●● If measurements are to be made on a black background: place a sheet of white paper in the
measuring area.
►► Set the ROI frame.
●● Shift the ROI frame so that the ROI lies in a flat area of the reference plane.
●● Select an ROI that is as large as possible.
●● Leave a distance between the object and all surrounding objects (e. g. side rails).
●● In order to create additional corner points: Click on the boundary lines of the frame and drag it with
the mouse key depressed.

The ROI is only a section of the reference plane and determines the quality of teaching. The actual
measurement range always corresponds to the device’s field of vision.

►► Click on [Teach].
If the teaching was not performed successfully:
Problem Corrective action
►Place
► a sheet of stiff paper or thin cardboard on the refe-
The reference plane in the ROI is not flat.
rence plane.
►Remove
► the objects or increase the distance between the
Other objects are in or close to the ROI.
ROI and objects.
►Ensure
► that the ROI can be enlarged:
–– Remove objects near the ROI.
–– Increase the area of the reference plane using additional
The ROI is too small.
pieces of paper or similar material.
–– Shift the ROI.
–– Mount the device at a different point.

37
ifm Vision Assistant O3D3xx 3D sensor

Problem Corrective action

In the search area, there are too many saturated, overexposed,
or invalid pixels.
►Place
► a sheet of white paper on the reference plane.
In the image of the reference plane, there are too many faults
(reflection is too weak).
►Reduce
► the device inclination.
Device inclination is greater than 45°.
►Mount
► the device at a different point.
During teaching, objects have moved in the device’s field of
►Avoid
► movement in the device’s field of vision.
vision.

After successful teaching, the device’s internal coordinate system is aligned to that of the reference
plane. This causes the measurement points which lie on the reference plane to be displayed in a
matching colour.

►► After the problem has been resolved, click on [Teach] again.

►► Click on [Next].

Step 3: Direction of movement

In this step, the object side to be designated as length and the side to be designated as width are set.
The height is the distance above the reference plane of the highest point of the object.

►► Setting [Direction of movement]:

●● Direction of movement “Off” (1): Independent of object orientation, the longer side is the length and
the shorter the width.
●● Direction of movement “On” (2): The side along the direction of movement is the length. The side
perpendicular to it is the width. The direction of movement is indicated by a red arrow.
►► Rotate the red arrow to the object’s direction of movement in the image.

38
 ifm Vision Assistant O3D3xx 3D sensor

UK

►► Click on [Next].

Step 4: Output configuration

►► Select output interface.

Option Description
The measurement results for size, position, orientation, etc. are output through
Ethernet the process interface. The process interface will be set up in the next step.
The digital outputs are off.
The measurement results are compared to the reference values. The logical
Digital outputs values determined from them control the digital output signals.
No measurement results are output through the process interface.
Ethernet & digital outputs Both outputs are used at the same time.

►► If the digital outputs are on: Select the duration of the output pulse: [Static] or a value in ms (10...2,500 ms
in increments of 10 ms).
►► Click on [Next].

39
ifm Vision Assistant O3D3xx 3D sensor

Step 5: Process interface

If the digital outputs are turned on (→ step 4), the Assistant skips this step.

►► Use the buttons to select which parameters are to be output through the process interface (Ethernet).
Parameter Definition
1 = yes (object found)
Object found
0 = no (no object found)
Width Width of the object in m
Height Height of the object in m
Length Length of the object in m
Coordinates (x; y; z) Coordinates of the centre of the object in m
Rotation angle Angle in degrees between the X-axis and the side specified as the length
Quality of the values for object width, height, and length on a scale from 0 to 100
(0 = poor, 100 = good)
Quality (width; height; length)
The value for the height indicates how flat the surface is.
The values for width and length display how straight the edges are.

The definition of the parameters “Length” and “Width” depends on the movement direction settings
(→ Step 3).

Click on the next to the desired parameter in order to display the definition of the parameter.

The button on the bottom right opens a help text for the Ethernet/IP process interface.

40
 ifm Vision Assistant O3D3xx 3D sensor

Example: Definition of the “Coordinates (x; y; z)” parameter

UK

Among the parameters, the currently detected device output string is displayed as an example.
The output string can be copied on to the Windows clipboard.
►► Click on [Next].

Step 6: Output configuration of the digital outputs

If the process interface (Ethernet) is turned on (→ step 4), the Assistant skips this step.

41
ifm Vision Assistant O3D3xx 3D sensor

Configure output 1:
OUT 1 can be used as a trigger for an external controller.
►► Select the switching criterion for OUT 1.

Parameter Definition
None Output inactive
Object found 1 = yes (object found)
0 = no (no object found)
Width
Height
Length
The measured value is compared to the set limiting value.
Position X Possible conditions for the comparison:
Position Y “Less than”
“Greater than”
Position Z
Output logical value:
Rotation angle 1 = yes (condition fulfilled)
0 = no (condition not fulfilled)
Quality width
Quality height
Quality length

►► For a parameter with limiting value, set the following:

●● Adjust the condition for the comparison to “Less than” or “Greater than”.
●● Enter a limiting value.
●● Alternatively, place a reference object beneath the device and click on [Teach] to use the object’s
measured value as a limiting value.
●● Click on [Load] to save the settings.

The ifm Vision Assistant calculates the limits that are actually used as follows:
●● For “greater than”: Limit = measured value + 0.01 m
●● For “less than”: Limit = measured value - 0.01 m

Configuring output 2:
A value for testing the size of the objects can be output through OUT 2. For output values, the
measurement results for length, width, or height can be linked by logical AND or OR.
►► Set the buttons for the desired dimensions to “On”.
►► For each selected dimension, set the comparison condition to “less than” or “greater than”.
►► Enter a limiting value for each selected dimension.
►► Alternatively, place a reference object beneath the device and click on [Teach] to use the object’s
measured value as a limiting value.
►► Set whether the logical link between results should be AND or OR.
►► Click on [Next].

42
 ifm Vision Assistant O3D3xx 3D sensor

Step 7: Test
In the final step, the application functions are tested:
●● Logical output signals of the digital outputs
●● Process interface output
●● Wiring

UK

The device image and the object found are displayed on the left side.
The status LEDs for the outputs are shown at the top right.
●● When an output is active the LED remains lit. The setting in Step 4 to an impulse or to [static] makes
no difference to this.

The LEDs for OUT 1 and OUT 2 displayed on the screen are identical to the LEDs on the device.

The buttons below the LEDS allow toggling between the following screens:
●● Results
●● Process interface
●● Wiring test

Results
The “Results” window displays the output of the digital outputs and the measurement results, the
comparison logic that has been set, and the results of it.

43
ifm Vision Assistant O3D3xx 3D sensor

►► If necessary Test the results with different objects.

Process interface
The “Process interface” window shows the measurement results for the parameters that were configured
for the output in Step 5 (→ “6.3.3 Send process values via EtherNet/IP”). Below the table, the output
string which the device sends through the process interface is displayed. The output string can be copied
on to the Windows clipboard.

Wiring test
The “Wiring test” window allows testing of the wiring between the device and the controller. The test runs
in real time and displays the output and input signals carried by the corresponding wires. In simulation
mode, the digital outputs can be controlled manually so that the connection to an external controller can
be tested independently of the application.

►► Click on the [Article number] selection field and input the article number choose the connecting cable
from the selection list.
>> The wiring and pinout of the selected connecting cable is displayed.
►► Click on [Start] to begin simulation mode.
►► Click on [OUT 1] to toggle between “On” and “Off” for the signal to OUT 1.

44
 ifm Vision Assistant O3D3xx 3D sensor

►► Click on [Ready] to toggle between “On” and “Off” for the “Ready for the next trigger” output signal.
►► Click on [OUT 2] to toggle between “On” and “Off” for the signal to OUT 2.
►► If the inputs are used, test the input signals at Input 1 and Input 2.

The inputs can be used for instance for switching applications.

►► Click on [Stop] to end simulation mode.

UK
6.3.2 Activate object dimensioning
►► After all settings have been completed, click on [Finish] to save the application.
>> The device activates and starts the application.
>> The monitoring screen is opened. A table is shown under the “Results” tab there. This shows all the
values for the object that was found (→ “7.4.2 Depiction of the model results for dimensioning”).

6.3.3 Send process values via EtherNet/IP

The device can send process values to a PLC via the EtherNet/IP protocol. The process values are
displayed in the ifm Vision Assistant as an output string as shown below:

The process values are delimited in the output string by a semicolon. The output string is output to the
PLC is the sequence shown.

When sending the output string to the PLC, comply with the following instructions:
●● The output string is configurable. The ifm Vision Assistant allows configuration of which process
values are sent.
●● Bytes 0 to 7 are part of the output string. They are not displayed in the ifm Vision Assistant (see
screenshot above).
●● The semicolons “;” included in the output string are not sent.
●● Before transmission, float values are converted into binary 16-bit integers.
●● Before transmission, all numeric values are converted into 16-bit integers.

The output string is formatted as follows (data type: SINT):

star;1;0.104;0.0088;0.109;+0.021;-0.011;+0.389;158;097;094;097;stop
Process
Byte no. Data Coding Unit Description Comments
value
0 2#0000_0000 Binary Duplicated Bit 1.5 shows a successful trigger
1.5
1 2#0010_0000 Binary command word command

2 2#0000_0000 Binary Synchronous /

asynchronous
3 2#0000_0000 Binary message identification
4 2#0000_0011 Binary ●● The device has received
3 messages.
3 Message counter
5 2#0000_0000 Binary ●● Increments by 1 with each action
(trigger, message sent etc.).
6 2#0000_0000 Binary
Reserved
7 2#0000_0000 Binary

45
ifm Vision Assistant O3D3xx 3D sensor

Process
Byte no. Data Coding Unit Description Comments
value
8 s ASCII
9 t ASCII
star Start string
10 a ASCII
11 r ASCII
12 2#0000_0001 Binary 0 = no box found
1 Result bit
13 2#0000_0000 Binary 1 = box found
14 104 Decimal
104 mm Width
15 0 Decimal
16 88 Decimal
88 mm Height
17 0 Decimal
18 108 Decimal
108 mm Length
19 0 Decimal
20 21 Decimal
21 x coordinate
21 0 Decimal
22 -11 Decimal
-11 y coordinate
23 -1 Decimal
24 -124 Decimal
388 z coordinate
25 1 Decimal
26 -98 Decimal
158 Degree of rotation
27 0 Decimal
28 97 Decimal
97 Quality width
29 0 Decimal
30 93 Decimal
93 Quality height
31 0 Decimal
32 97 Decimal
97 Quality length
33 0 Decimal
34 s ASCII
35 t ASCII
stop Stop string
36 o ASCII
37 p ASCII

Defective execution of a command leads to the following status:

●● Error bit = 1
●● Mirrored command word is displayed
●● Asynchronous message bit = 0
●● Asynchronous message detection = 0
●● Message counter is incremented by 1

46
 ifm Vision Assistant O3D3xx 3D sensor

6.3.4 Sending process values via TCP/IP

The device can send process values to a PLC via the TCP/IP protocol. The ifm Vision Assistant permits
selection of which process values are to be sent. The process values are displayed in the ifm Vision
Assistant as an output string as represented below:

The process values are delimited in the output string by a semicolon. The output string is output to the
PLC is the sequence shown.
UK
When sending the output string to the PLC, comply with the following instructions:
●● The semicolons “;” included in the output string are not sent.
●● Before transmission, all numeric values are converted into 16-bit integers.

The output string is formatted as follows (data type: ASCII):

star;1;0.104;0.0088;0.109;+0.021;-0.011;+0.389;158;097;094;097;stop
Process value Unit Description
star Start string
1 Object found
0.104 m Width
0.0088 m Height
0.109 m Length
+0.021 x coordinate
-0.011 y coordinate
+0.389 z coordinate
158 Degree of rotation
097 Quality width
094 Quality height
097 Quality length
stop Stop string

47
ifm Vision Assistant O3D3xx 3D sensor

6.4 Filling level measurement

The application “Filling level measurement” parametrises the device for the measurement of filling levels
in static containers or vessels.
Requirements for reliable recognition of filling levels:
●● Diffusely reflecting surface
●● For a shiny surface: Avoid direct reflection back to the device

Completely transparent or reflective surfaces cannot be reliably measured.

Device mounting requirements for good measurement results:

●● Mount the device as perpendicularly as possible to the measuring area, so that the object can be
measured from above.

Device inclination reduces the precision. If the inclination is more than 45° the application will not
function.
●● Select the device mounting distance so that the object to be measured is completely in the device’s
field of vision, and there is a margin on all sides.
●● Measurement distance for most applications: 1-2 meters
●● Nothing in the image, including anything in the background, must be more than 5 m away from the
device (radially).

6.4.1 Setting up the filling level measurement

►► Click on [Start] to start configuration of the application.

48
 ifm Vision Assistant O3D3xx 3D sensor

Step 1: Mounting

UK

Please observe the notes on installation of the unit.

For additional installation instructions, please refer to the operating instructions.

►► Click on [Next].

Step 2: Control functionality

►► Select the type of evaluation.

Selection Description
1-point control with hysteresis The filling level is evaluated within the switching setpoints SP1 and SP2.
Two ranges are defined using the switching setpoints SP1 and SP2 (making a total
2-point control with hysteresis
of 4 switching setpoints). The filling level is evaluated within the ranges.
The switching setpoint SP1 defines the minimum filling level. As long as the measured value
lies below this value, the pump remains actuated and the filling process continues.
Pump actuation
The switching setpoint SP2 defines the maximum filling level. Once the measured value rises
above this value, the pump is switched off and the filling process ceases.
The filling level reading is output directly as a current/voltage via an analogue output.
Analogue
The switching setpoint SP1 is defined as 4 mA / 0 V and SP2 is defined as 20 mA / 10 V.

49
ifm Vision Assistant O3D3xx 3D sensor

►► Select the measurement output.

Selection Description
Mean The mean of all the measured values in the ROI is compared with the switching setpoints.
Minimum The smallest measured values in the ROI is compared with the switching setpoints.
Maximum The largest measured values in the ROI is compared with the switching setpoints.

►► Select the mode.

>> The mode can be selected only if the type of evaluation is set to “Analogue”.
Selection Description
The filling level reading is output directly as a voltage via an analogue output. The switching
Voltage
setpoints are defined as 0 V and 10 V.
The filling level reading is output directly as a current via an analogue output. The switching
Current
setpoints are defined as 4 mA and 20 mA.

►► Selecting the direction.

>> The direction can be selected only if the type of evaluation is set to “Analogue”.
Selection Description
Rising The switching setpoint SP1 is defined as 4 mA / 0 V and SP2 is defined as 20 mA / 10 V.
Falling The switching setpoint SP1 is defined as 20 mA / 10 V and SP2 is defined as 4 mA / 0 V.

►► Click on [Next].

Step 3: Output configuration

►► Invert the output function.

Selection Description
The output value corresponds to an NO contact (Normally Open). The setpoint values
Underfill OUT High
correspond to the switching values of the hysteresis.
The output value corresponds to an NC contact (Normally Closed). The setpoint values
Overfill OUT High
correspond to the switching values of the hysteresis.

50
 ifm Vision Assistant O3D3xx 3D sensor

►► Select the impulse duration.

Selection Description
If a filling level beyond the switching setpoint range is registered, the respective output is set
Pulsed to logical One (high) for the set duration and then changes to logical Zero (low) again. For this
purpose, the pulse frequency must have been input (range 10…2500 ms in steps of 10 ms).
If a filling level beyond the switching setpoint range is registered, the respective output is set to
Static
logical One (high) and remains at that value until the next measurement.

►► Click on [Next].

Step 4: Regions UK

The “Regions” window displays live images that allow the number, shape, and size of the ROI (Region of
Interest) and RODs (Regions of Disinterest) to be set.
►► If not selected, set the video option [Live image] (→ “6.1 Live image display of the setup wizard”).
►► Place a container centrally under the device, and by changing the position of the container and / or the
device make sure the following conditions are satisfied:
●● The container must be completely within the image, with all four corners visible.
●● The distance from the device must be between 0.3 m and 5 m.
●● No objects in the image section (including the background) may be more than 5 m from the device.
An inclined view distorts the object grid and impairs the detection of objects in the ROI.
►► The device must be as nearly perpendicular to the container as possible.
►► If there are shiny surfaces (e. g. polished metal, foil-wrapped products):
Avoid back reflection of the light from the device by tilting the device slightly.
►► Set up the display options so that the ROI can be properly set up (→ “7.2 View options”).

Whether it is better to display a distance image or an amplitude image (brightness) depends on the
shape and reflectivity of the container and the objects.
●● Amplitude image: Container and objects with high contrast reflectivity values in the infrared
range
●● Distance image: Distinctive object and container shapes (e.g. a box with bottles)

►► After modifying the display options, click on to optimise the view.

►► Select the ROI form that best suits the application.

51
ifm Vision Assistant O3D3xx 3D sensor

►► Create the ROI over the container to be measured.

>> The ROI should not be larger than the size of the container.

If necessary RODs (Regions of Disinterest) should be used to define regions that are not to be evaluated.
►► Select the ROD form that best suits the region that is not to be evaluated.
►► Change the position and size of the ROD so that the desired region is covered.
►► Click on [Next].

Step 5: Define background

The “Define background” window determines start level or zero level for measuring the filling level. This
can either be taught (using an mean value of 20 measurements of an empty container) or input manually.
Teaching the background
►► Select “Teach plane” from the selection menu.
►► Click on the [Teach] button.
>> Successful teaching of the background is shown with a green tick.
Inputting the background manually
►► Select “Manual input” from the selection menu.
►► Input the height of the background in metres.

►► Click on [Next].

52
 ifm Vision Assistant O3D3xx 3D sensor

Step 6: Define setpoints

UK

The outputs are switched according to the definition of the setpoints. Each setpoint can either be input
manually or taught using a suitable quantity of product in the container.
Inputting the setpoints manually
►► Input into the fields the values for the respective setpoint.

Teaching the setpoints

►► Fill the container to the respective setpoint.
►► Click on the [Teach] button for the respective setpoint.

►► Click on [Next].

53
ifm Vision Assistant O3D3xx 3D sensor

Step 7: Test

In the final step, the application functions are tested:

●● Device limiting value (e.g. underfill, overfill)

●● Output signal to the outputs
●● Wiring
On the left side, the device image with the ROI and the measurement results is displayed.
Colour Meaning
Green OK
Red Overfill
Violet Underfill
Olive green Invalid
Yellow Selected

The status LEDs for the outputs are shown at the top right.
●● If LED OUT 1 lights up yellow: An underfill condition has been registered and OUT 1 is active. LED
OUT1 switches off as soon as an overfill is registered.
●● If LED OUT 2 lights up yellow: An underfilled condition has been registered at the 2-point control with
hysteresis, and OUT 2 is active. LED OUT2 switches off as soon as an overfill is registered.
●● When an output is active the LED remains lit. The setting in step 1 to an impulse or to [static] makes
no difference to this.

The LEDs for OUT 1 and OUT 2 displayed on the screen are identical to the LEDs on the device.

The buttons below the LEDS allow toggling between the following screens:
●● Results
●● Process interface
●● Wiring test

Results
The “Results” window offers a further opportunity to check the correctness of the setpoints.

54
 ifm Vision Assistant O3D3xx 3D sensor

►► Test the application by increasing or decreasing the filling level.

►► If the test is unsuccessful, optimise the settings, e. g.:
–– Go back to Step 6 to adjust the setpoints.
–– Go back to Step 4, set up the ROI and the RODs again and define background in Step 5.
►► If the anchor function has been activated, test it by moving and rotating the container.

Process interface
The “Process interface” window displays a table with the status of the ROIs, the ROD and the process
values. Below the table, the output string which the device sends through the process interface is
UK
displayed. The output string can be copied on to the Windows clipboard.

Wiring test
The “Wiring test” window allows testing of the wiring between the device and the controller. The test runs
in real time and displays the output and input signals carried by the corresponding wires. In simulation
mode, the digital outputs can be controlled manually so that the connection to an external controller can
be tested independently of the application.

►► Click on the [Article number of cable] selection field and input the article number choose the
connecting cable from the selection list.
>> The wiring and pinout of the selected connecting cable is displayed.
►► Click on [Start] to begin simulation mode.
►► Click on [OUT 1] to toggle between “On” and “Off” for the signal to OUT 1.
►► Click on [OUT 3] to toggle between “On” and “Off” for the signal to OUT 3.
►► Click on [OUT 2] to toggle between “On” and “Off” for the signal to OUT 2.
►► If the inputs are used, test the input signals at Input 1 and Input 2.

The inputs can be used for instance for switching applications.

►► Click on [Stop] to end simulation mode.

55
ifm Vision Assistant O3D3xx 3D sensor

6.4.2 Activate the filling level measurement

►► After all settings have been completed, click on [Ready] to save the application.
>> The device activates and starts the application.
>> The monitoring screen is opened. A bar graph is shown under the “Results” tab there. This shows
values that allow the results of the current application to be monitored
(→ “7.4.1 Depiction of the model results for the completeness application”).

6.4.3 Send process values via EtherNet/IP

The device can transmit the process values to a PLC via the EtherNet/IP protocol. The process values
are displayed in the ifm Vision Assistant as output string as below:

The output string is transferred to a PLC in the displayed sequence.

Observe the following remarks for the transmission of the output string to a PLC:
●● Bytes 0 to 7 are part of the output string. They are not displayed in the ifm Vision Assistant
(see screenshot above).
●● Semicolons ";" in the output string are not transferred.
●● Float values are converted into binary 16-bit integers before the transmission.
●● All numerical values are converted into binary 16-bit integers before the transmission.

The output string is composed of the following (data type: ASCII):

0070
Byte no. Data Coding Process value Unit Description Comments
0 2#0000_0000 Binary Duplicated Bit 1.5 shows a successful
1.5
1 2#0010_0000 Binary command word trigger command

2 2#0000_0000 Decimal Synchronous /

asynchronous
message
3 2#0000_0000 Decimal
identification

4 30 Decimal ●● The device has received

30 messages.
30 Message counter ●● Increments by 1 with each
5 0 Decimal action (trigger, message
sent etc.).
6 0 Decimal
Reserved
7 0 Decimal
8 0 ASCII Status of all ROIs Shows states of the
0
9 0 ASCII (0 = bad, 1 = good) level monitoring

10 0 ASCII
0 ROI ID
11 0 ASCII ROI Status:
12 0 ASCII 0 = good
7 ROI Status
13 0 ASCII 6 = overfill
14 0 ASCII 7 = underfill
0 mm ROI Value
15 0 ASCII

56
 ifm Vision Assistant O3D3xx 3D sensor

Faulty execution of a command leads to the following status:

●● Error bit = 1
●● Duplicated command word is displayed
●● Asynchronous message bit = 0
●● Asynchronous message identification = 0
●● Message counter increments by 1

6.4.4 Send process values via TCP/IP

The device can transmit the process values to a PLC via the TCP/IP protocol. The process values are
UK
displayed in the ifm Vision Assistant as output string as below:

In the output string the process values are separated by a semicolon. The output string is transferred to a
PLC in the displayed sequence.

Observe the following remarks for the transmission of the output string to a PLC:
●● Semicolons ";" in the output string are not transferred.
●● All numerical values are converted into binary 16-bit integers before the transmission.

The output string is composed of the following (data type: ASCII):

star;0;00;7;+0.000;stop
Process value Unit Description
star Start string
0 Status of all ROIs (0 = bad, 1 = good)
00 ROI ID ROI Status:
0 = good
7 ROI Status
6 = overfill
+0.000 m ROI Value 7 = underfill
stop Stop string

57
ifm Vision Assistant O3D3xx 3D sensor

7 Monitoring screen
If a connection to the device is established and an application is active, the software continues with
the monitoring screen. The device is now running in operating mode. From the monitoring screen,
the application that is running can be monitored, but not interrupted or modified.

►► Click on .

The following tabs can be found below the live image from the device:
●● [View options] (→ “7.2 View options”)
●● [Record options] (→ “7.3 Record options”)
●● [Results] (→ “7.4 Results”)
●● [Service reports] (→ “7.5 Service reports”)

7.1 Status displays

The digital outputs and the statistics for the active application are displayed on the left side of the
monitoring window:
●● Monitoring: The active application is displayed.
●● Hardware: The status LED (OUT1, OUT2) light up yellow when a signal is present at the respective
digital output.
●● Current status: The current status of the device is displayed.
●● Overall statistics
●● The statistically compiled values of all models of the active application are displayed. A counter
counts the values “OK / passed (green)” and “Over SP2 / overfilled (red)”. The ratio of the two
values to each other is displayed as a percentage and highlighted in colour.
●● The evaluation time is shown as the mean, max and min time for the measurements.
●● Pressing the “Reset all statistics” button resets all the statistics.
Depending on the application, the logic diagram requires an additional logic module “Status
definition: Pass/Fail”, which is used to count the value “OK / passed (green)” in the overall
statistics (→ “8.5 Creating output logic”).

58
 ifm Vision Assistant O3D3xx 3D sensor

7.2 View options

►► Click on or to select the desired view.

Button Name Description

2D view The central view displays the device data as a 2D visualisation (→ “7.2.1 2D view”).

3D view The central view displays the device data as a 3D visualisation (→ “7.2.2 3D view”).

UK
The figures in the following sections are examples. Depending on the objects and the individual
settings, the representation can deviate greatly.

7.2.1 2D view
►► Click on to display the 2D view.
►► Set 2D view.
The following settings are available in the “View options” tab:
Button Name Description

Distance Image Represents the pixel in a colour corresponding to the distance values in the 2D view.

Represents the pixel in grey tones (brightness) corresponding to the amplitude values in
Amplitude Image
the 2D view.

Represents the amplitude values of the 2D view in logarithmic grey tones (only available
Logarithmic
for amplitude image).
Represents the amplitude values of the 2D view in linear grey tones (only available for
Linear amplitude image).
The “Linear” view is particularly useful when setting up the image.

Reduce Reduces the 2D view.

Magnification 1:1 Sets the image magnification to the default view.

Enlarge Enlarges the 2D view.

Pixel properties Displays the window for pixel properties.

Automatically sets the coloured area to a suitable range. The settings on the slide control
Rescale
are discarded.

The settings for the view (e. g. [logarithmic] or [linear]) change only the calculation and type of
visual depiction. The application itself is not affected.

59
ifm Vision Assistant O3D3xx 3D sensor

Distance image

►► Click on to display the distance image.

Amplitude image

►► Click on to display the amplitude image.

►► Use [Logarithmic] or [Linear] to select the desired view.

60
 ifm Vision Assistant O3D3xx 3D sensor

”Logarithmic” view:

UK

”Linear” view:

61
ifm Vision Assistant O3D3xx 3D sensor

Pixel properties
This function displays the following information about a selected pixel in the 2D view:

Field Description

Column | Row Indicates the column and row number of a given pixel.

x x-coordinate of the selected pixel: current measured value, mean value, and deviation in metres.
y y-coordinate of the selected pixel: current measured value, mean value, and deviation in metres.
z z-coordinate of the selected pixel: current measured value, mean value, and deviation in metres.
Amplitude Amplitude of the selected pixel.
White: saturated pixel.
Distance image colour
Black: low amplitude.
legend
Violet: invalid pixel.
Red: saturated pixel.
Amplitude image colour
Blue: low amplitude.
legend
Violet: invalid pixel.

►► Click on to open the “Pixel properties” window.

►► Click on the pixel in the 2D view.

>> The position and z-coordinate of the pixel are displayed in metres.
►► Click on to open detailed information.
►► Click on to close detailed information.

62
 ifm Vision Assistant O3D3xx 3D sensor

7.2.2 3D view

UK

►► Click on to display the 3D view.

►► Set 3D view.
The following settings are available in the “View options” tab:
Button Name Description

Represents the pixel in a colour corresponding to the distance values in the

Distance Image
3D view.

Represents the pixel in grey tones (brightness) corresponding to the amplitude

Amplitude Image
values in the 3D view.

Represents the amplitude values of the 3D view in logarithmic grey tones

Logarithmic
(only available for amplitude image).

Represents the amplitude values of the 3D view in linear grey tones

Linear
(only available for amplitude image).

Device position Shows / hides device position and viewing angle in the 3D view.

Grid Shows / hides the plane grid (X/Z plane) in the 3D view.

Background grid Shows / hides the spatial grid (X/Y plane and Y/Z plane) in the 3D view.

Origin Shows / hides the origin of the coordinate system angle in the 3D view.

Points Displays the data as a point cloud.

Mesh Displays the data as a mesh.

Surface model Displays the slope as a colour gradient.

Rear view Rotates the 3D view on the X/Y plane.

63
ifm Vision Assistant O3D3xx 3D sensor

Button Name Description

Top view Rotates the 3D view on the X/Z plane.

Side view Rotates the 3D view on the Y/Z plane.

Reduce Reduces the 3D view.

Magnification 1:1 Sets the image magnification to the default view.

Enlarge Enlarges the 3D view.

The view settings (e.g. [Logarithmic] or [Linear]) change only the calculation and the manner of the
visual representation. The application itself is not affected.

Distance image

►► Click on to display the distance image.

Representation as a 3D image Description

Pixel position Point spatial coordinates (X, Y, and Z coordinates).
Distance (z coordinates).
Pixel colour The colouring follows the measured point distance and the colour scale settings (→ “7.2.3
Slide control”).
Red Z-coordinate value ≤ minimum of colour scale settings.
Blue Z-coordinate value ≥ maximum of colour scale settings.

64
 ifm Vision Assistant O3D3xx 3D sensor

Amplitude image

►► Click on to display the amplitude image.

UK

►► Use [Logarithmic] or [Linear] to select the desired view.

Representation as a 3D image Description

Pixel position Point spatial coordinates (X, Y, and Z coordinates).
Amplitude value.
Pixel colour (greyscale) The brightness is either linear or logarithmic depending on the measured amplitude and the
greyscale settings (→ “7.2.3 Slide control”).
Black Amplitude value ≤ minimum of scale settings.
White Amplitude value ≥ maximum of scale settings.

65
ifm Vision Assistant O3D3xx 3D sensor

Coordinate system perspectives

The 3D view allows rotation of a pre-set perspective in the coordinate system.

►► Click on to display the rear view.

>> The object is represented on the X/Y plane.

►► Click on to display the top view.

>> The object is represented on the X/Z plane.

►► Click on to display the side view.

>> The object is represented on the Y/Z plane.

66
 ifm Vision Assistant O3D3xx 3D sensor

UK

Representation pattern

►► Click on to display the 3D view as a point cloud.

67
ifm Vision Assistant O3D3xx 3D sensor

►► Click on to display the 3D view as a mesh.

►► Click on to display the rises in the 3D view as a surface model.

68
 ifm Vision Assistant O3D3xx 3D sensor

7.2.3 Slide control

The slide control allows the display’s colour range to be set manually. This does not change the results of
the application.
●● Distance image: Measurement range in metres (from-to)
●● Amplitude image: Measuring range in amplitudes (from-to)

Setting the colour range

Control Description UK
Automatic
The button automatically sets the colour range to a suitable range. The settings on the slide
range
control are discarded.
selection

Upper slide
The upper slide control roughly sets the colour range for the distance image or amplitude image.
control

Lower slide
The lower slide control is used for fine adjustment of the colour range.
control

The colour range setting can be shifted using the left mouse button without changing the size of
the range.
Colour range
The vertical white lines within the colour range identify the colour range fine adjustment
performed using the lower slide control.

►► Set the upper slide control to the desired colour range.

►► Set the lower slide control for fine adjustment of the colour range.

>> The scale of the lower slide control corresponds to the colour range shown above.

69
ifm Vision Assistant O3D3xx 3D sensor

7.3 Record options

This function allows generation of device image recordings of up to 8 minutes.

►► In the “Record options” tab, select the duration of the recording (1, 2, 4, or 8 minutes; memory
requirements: about 250 MB per minute).
►► Click on to start a recording.
>> The “Save as” window opens with a default folder path and default file name:
●● Default folder path: “…\ifm electronic\ifmVisionAssistant\capture” (the exact complete path depends
on Windows version and settings)
●● Default file name: “O3D3XX_yyyy-mm-dd_hhmmss.dat”

The file name consists of the string “O3D3XX” to which the date and time stamp is added.
Example: The file “O3D3XX_2015-04-15_144726.dat” was recorded on 15 April 2015 at 14:47:26.

>> All measurement and process data are recorded (e. g. detected objects and application results).

►► Click on [Save].

70
 ifm Vision Assistant O3D3xx 3D sensor

>> The recording begins and the recording time is displayed next to the button.
Example: 1 minute and 5 seconds of a set duration of 2 minutes is displayed as 01:05/02:00.
>> The recording stops automatically when the pre-set recording duration has been reached.

UK

►► Click on to end the recording manually before the end of the pre-set recording duration.
>> The sequence is saved and can be played back using the [Replay] option on the start screen.

71
ifm Vision Assistant O3D3xx 3D sensor

7.4 Results
In the results, a summary of the features is displayed. The display the results depends on the type of
application.

7.4.1 Depiction of the model results for the completeness application

In the following cases, the monitoring window is opened and bar graph is shown under the “Results” tab:
●● An application for the completeness application has been completed.
●● An application for the completeness application has been activated and the monitoring window has
been selected.

The process values for the individual ROIs are shown as vertical lines in the bar graph. The colour of the
lines show the status of the ROIs. The switching setpoints are shown as horizontal lines.
●● Magenta: Switching setpoint SP1
●● Red: Switching setpoint SP2

The icons and allow toggling between the bar graph and a tabular presentation of the results.

For each ROI, the features “Process value”, “Quality” and “Status” are displayed in a line. The table lines
can be arranged in ascending order of value by clicking on the respective header in the table title line.

72
 ifm Vision Assistant O3D3xx 3D sensor

7.4.2 Depiction of the model results for dimensioning

In the following cases, the monitoring window is opened and a table with the features of the objects found
is shown under the “Results” tab:
●● An application for dimensioning has been completed.
●● An application for dimensioning has been activated and the monitoring window has been selected.

UK

7.4.3 Depiction of the model results for filling level measurement

In the following cases, the monitoring window is opened and a table with the features of the objects found
is shown under the “Results” tab:
●● An application for filling level measurement has been completed.
●● An application for filling level measurement has been activated and the monitoring window has been
selected.

7.4.4 Depiction of the model result in extended programming mode

As for the completeness application, in extended programming mode the model results can be selected
using the respective icons for display either as a bar graph or in a table (→ “7.4.1 Depiction of the model
results for the completeness application”).
When the monitoring window is selected, the table is displayed first.

7.5 Service reports

This function allows a service report with software and hardware information to be generated and saved.
The service report can for instance be used as a simple means of passing on the required information in
the event of a support request.

Download service report

►► Click on [Download Service Report].
>> The service report is saved in text format (*.txt) on the PC.

73
ifm Vision Assistant O3D3xx 3D sensor

Show device details

►► Click on [Show Device Details].
>> The “Device Details” window is displayed.

►► Click on [Save] to save the device details.

►► Click on [X] to close the service report.

74
 ifm Vision Assistant O3D3xx 3D sensor

7.6 Statistics
Statistically recorded values for each ROI are displayed under “Statistics”. The statistics are grouped
according to the models that are applied.
The ROIs are sorted according to the respective model. Pressing the [All] button shows the statistics for
all ROIs at the same time. If the “Distance” model is applied, the respective ROIs are displayed via the
[Distance] button. The same applies to the models “Filling level” and “Volume”.

The following values are recorded as statistics for each ROI: UK

●● OK / passed (green)
●● Below SP1 / underfilled (magenta)
●● Above SP2 / overfilled (red)
●● Invalid / error (yellow)

The values are displayed as a counter and shown graphically using a ring diagram. Within the ring
diagram the statistically recorded values are shown as a percentage of the whole.

For the completeness application, a value of “OK / passed (green)” is recorded in the statistics of
one of the respective ROIs reports “OK / passed (green)”.

This applies to all values. For instance a value of “Over SP2 / overfilled (red)” is recorded in the
statistics of one of the respective ROIs reports “Over SP2 / overfilled (red)”.

75
ifm Vision Assistant O3D3xx 3D sensor

7.7 Exit the monitoring screen

The monitoring screen can be exited using one of the following ways:
●● Change to another option: Switches to the selected option, e. g., to administer or modify device
settings and applications. This stops any active, running application. This change can be password
protected (→ “10.1.2 Password protection”).
●● Break the connection to the device: The ifm Vision Assistant is disconnected from the device. The
active running application is not interrupted and continues to run.

Change to another option

►► Click on the button for the desired option.
>> The “Stopping Run Mode” window is displayed.

►► Click on [OK].
>> If password protection has been activated, the ifm Vision Assistant requests the password.

If the device is password protected, this condition is indicated by the icon next to the , ,

and buttons.

►► Enter the password and click on [Unlock].

>> The ifm Vision Assistant stops the currently running application and switches to the previously selected
option.
>> If an incorrect password is entered, an error message is displayed, and the ifm Vision Assistant returns
to the monitoring screen.

Break the connection to the device

►► Click on .
>> The connection to the device is broken.
>> The ifm Vision Assistant returns to the start screen.

76
 ifm Vision Assistant O3D3xx 3D sensor

8 Extended programming mode

In extended programming mode, models can be defined for filling level monitoring and distance
monitoring. The output of the measurement results can be assigned to user-specific interfaces.

UK

1: Live image display

2: Settings
3: Menu for extended programming mode

8.1 Activating extended programming mode

Extended programming mode is activated in the following ways:
Pre-requirement Action
The setup wizard automatically starts when the device is first connected (→ “6 Setup
wizard”).
A device without any saved
application is connected. ►Click
► on [Extended programming mode] on the start page of the setup wizard.
>> A new application is created with the name “Filling level/distance application” and the
application editing window is opened.
►In
► Application management, add a new application (→ “9 Application management”).
>> The setup wizard starts (→ “6 Setup wizard”).
A new application is added. ►Click
► on [Extended programming mode] on the start page of the setup wizard.
>> A new application is created with the name “Filling level/distance application” and the
application editing window is opened.
An application that was created in ►Select
► the application in the application management, and start editing (→ “9 Application
the extended programming mode management”).
is being edited. ►The
► application editing window is opened in extended programming mode.

77
ifm Vision Assistant O3D3xx 3D sensor

8.2 Live image display in extended programming mode

The application editing window displays live images during the editing operation.

The following video options can be set using the “Video capture” menu bar:
Button Video option Description

Live image The image is continuously updated, irrespective of the trigger source setting.

The image is updated once upon selection, independently of the trigger source
Actuate trigger
setting.

The image is updated each time a trigger signal is received from the trigger source
Respond to trigger
setting.
The image is updated the next time a trigger signal is received from the trigger
Wait for trigger
source setting.

8.2.1 Save image

►► Click on .
>> The “Save as” window for saving the image is displayed.
►► Enter the desired file name.
►► Click on [Save].
>> The saved data file has the ending “*.o3d3xximg”.

8.2.2 Load image

►► Click on .
>> The “Save as” window for loading the image is displayed.
►► Select the file to be loaded (*.o3d3xximg) and click on [Open].
>> When the loading process is complete, the loaded image is displayed instead of the live image.
>> The [Live image] video option in the “Video capture” menu bar allows toggling between the live image.

If the file format of the image that was loaded does not correspond to the designated format
(*.o3d3xximg), an error message is displayed.

78
 ifm Vision Assistant O3D3xx 3D sensor

8.2.3 Set live image view

The display options can be set using the menu bar below the image. The display options for the live
images are identical to the display options of the monitoring screen (→ “7.2 View options”).

8.3 Image settings

►► Click on .
>> The “Image settings” window is displayed.
UK

Most screens lack the capability to display all image settings. Further image settings are accessible using
the scrollbars to the right of the “Image settings” window.

79
ifm Vision Assistant O3D3xx 3D sensor

8.3.1 Set trigger source

Option Description
The device creates images continuously. This option is mainly used for tests.
Continuous When this option is selected, the current frame rate in fps (frames per second) will be displayed in
the “Image settings” window. The frame rate can be changed in the “Target frame rate” input field.
The maximum achievable frame rate depends on the exposure mode and the exposure time.
Process interface The device is activated through the process interface (e. g. by a PLC).

ON ON

Iinput

Trigger

Trigger
The device is activated by hardware using the rising edge of
Positive edge
the input signal.
OFF OFF
t
Iinput

ON ON
Trigger

Trigger
The device is activated by hardware using the falling edge of
Negative edge
the input signal.
OFF OFF
t
Iinput

ON ON
Trigger

Trigger

Trigger

The device is controlled by hardware using the rising edge

Positive and negative edge
and the falling edge of the input signal.
OFF OFF
t

80
 ifm Vision Assistant O3D3xx 3D sensor

8.3.2 Set maximum background distance

UK
Option Description
The measurement of objects with a maximum distance of approximately 5 m is unambiguous. Other distant
Less than 5m
objects with incorrect size and wrong shape are shown as if they were at a distance up to 5 m (see explanation
[1 frequency]
below).
The measurement of objects up to approx. 30 m is possible. By measuring with an additional low frequency, the
Up to 30 m freedom from ambiguity range can be extended (see explanation below).
[2 frequencies] With increasing frequency, the noise increases and the repeatability decreases. Therefore, multiple
measurements and longer measurement times are necessary.
Objects with a distance up to approx. 30 m are measured with 2 frequencies. An image is generated from this
measurement. The third frequency detects measurable points between approx. 30 and 200 m (e.g. background
reflections). To suppress the ambiguity, these points are deleted from the generated image and marked as
invalid points.
More than 30m
[3 frequencies] The result of the measurement is an image of objects up to approx. 30 m with enhanced clarity.
With increasing frequency, the noise increases and the repeatability decreases. Therefore, multiple
measurements and longer measurement times are necessary.
Because of the limited illumination intensity of the device, only objects up to approx. 30 m can be measured.

Frame rate optimised mode

The “Frame rate optimised mode” can be activated from a distance of 30 m [2 frequencies]. The mode
controls the image capture and processing. Parallel processing speeds up the processing of the frames.

”Frame rate optimised mode” is available only when a continuous trigger source is provided.

81
ifm Vision Assistant O3D3xx 3D sensor

Declaration of the freedom from ambiguity of the measurement range

For the measurement of objects, the device emits a modulated light signal and detects the light (that is)
reflected by the objects. The distance of the objects is determined from the operating time of the emitted
and reflected light.
While the modulation frequency is not changed by the reflection, the phases of the emitted and detected
light are shifted from each other independently from the distance of the reflecting point. Phase shifts
which are a multiple of the wavelength are thus not distinguishable. Therefore distances which are greater
than half of the wavelength cannot be measured without ambiguity. At a modulation frequency of 30 MHz,
the half wavelength is 5 m.

∆φ

∆φ

0 1 2 3 4 5 6 7 D/m

0 33 66 99 t/ns

Example
The following figure shows two images of the same scene with different distance settings.

1: Maximum background distance less than 5 m [1 frequency]: Colours are repeated for distance objects
2: Maximum background distance up to 30 m [2 frequencies]: Colours can be clearly identified with different distances

82
 ifm Vision Assistant O3D3xx 3D sensor

8.3.3 Setting the exposure mode

In the 3D view, the scene dynamic for a single exposure can be too high. This applies in particular to the
following areas:
●● Areas with very different reflectivity (e. g. black, white, shiny)
●● Areas with very different distances from the device
In these cases, the image quality can be increased by two or three exposures with different exposure
times. The evaluation time and the sensitivity to movements in the scene also increase.

UK

Option Description Display/Settings

Automatic exposure time when recording the image.
In between the frames, the device calculates the exposure
time. Automatic exposure is available only when a continuous
Automatic exposure
trigger source is provided.
Once automatic exposure is activated, the exposure time
settings are hidden.

Exposure mode for scenes with low dynamics.

The exposure time is displayed in µs. The value can be
changed using the slider or can be entered in the display
one exposure window.
After the [Optimise] button has been clicked, the device
records several images and calculates the optimum exposure
time for the current scene.

Exposure mode for scenes with moderate dynamics.

The exposure times are displayed in µs.
●● The value of the longer exposure time can be changed
using the slider or can be entered in the display window.
two exposures ●● The value of the shorter exposure time is set as a ratio of
the longer exposure time. The ratio can be changed using
the slider or can be entered in the display window.
After the [Optimise] button has been clicked, the device
records several images and calculates the optimum exposure
times for the current scene.

Exposure mode for scenes with high dynamics.

The exposure times are displayed in µs. A manual or
automatic change of the default values is not possible.
three exposures
This exposure mode cannot be used in conjunction with the
distance option “More than 30 m” (→ “8.3.2 Set maximum
background distance”).

Automatic optimisation sets the exposure times for the current scene (overall device image less its
frame). The scene must not be disturbed during the optimisation process. This process avoids saturation
and minimises measurement noise. This improves the robustness of the application against interference.

83
ifm Vision Assistant O3D3xx 3D sensor

Even after the exposure time has been optimised, invalid pixels or significant image noise may occur. This
may have the following causes:
●● The pixels may lie outside the optimisation area (e. g. within the frame of the device image).
●● The pixels must represent shiny objects.
●● The pixels must represent dark objects whose difference from the brightest objects is too great. In this
box an increase in the number of illumination points may lead to an improvement.
Example
The following figure shows the 2D and 3D images of a chess board section in 60 cm distance with
different exposure modes.

1: An exposure time of 500 µs, white surfaces nearly saturated, black surfaces noisy
2: Two exposure times of 500 µs and 3500 µs, white and black surfaces less noisy

8.3.4 Setting the target frame rate

The device can be given a target frame rate which it should endeavour to reach.
Setting the target frame rate
►► Setting the target frame rate in the field.

>> The current frame rate is displayed above the target frame rate.
Depending on which settings are activated, the device may fail to achieve the target frame rate.
The following settings have an effect on the target frame rate:
●● Maximum visible distance (→ “8.3.2 Set maximum background distance”)
●● Exposure mode, exposure time, automatic exposure (→ “8.3.3 Setting the exposure mode”)
●● Frame rate optimised mode (→ “8.3.2 Set maximum background distance”)
●● Filter (→ “8.3.5 Apply filter”)
●● Image processing

84
 ifm Vision Assistant O3D3xx 3D sensor

If the following notice is displayed, refer to the instructions regarding cooling the device:

8.3.5 Apply filter

Filters can be applied to optimise repeatability.
►► Select the image type which the filter should be applied to from the “Apply filter” selection list:

UK

Option Description
All Images The filters are applied to the distance image and the amplitude image.
Amplitude Image The filters are applied only to the amplitude image.
Distance Image The filters are applied only to the distance image.

►► Select spatial filter:

Option Description Properties

●● Good edge preservation
Median filter Each point is replaced by the median of the adjacent points.
●● Moderate evaluation time
Each signal value is replaced by the mean value that is calculated ●● Poor edge preservation
Mean filter
via the signal values of the adjacent points. ●● Short evaluation time
The intensity of a point is replaced by the weighted mean of the ●● Very good edge preservation
Bilateral filter
intensities of adjacent points. ●● Very long evaluation time

►► Select matrix size.

>> The matrix size determines the window for the point to be calculated. The points in this window are
used for the calculation.
►► Select time filter:

Option Description
The mean value of consecutive images is calculated. The number of images that will be averaged can
be set. The recording of images is started by a trigger event. All images have the same weight in the
Mean filter averaging process.
This filter cannot be applied to the “Continuous” trigger source and is only suitable for static applications.
A weighted mean value over successive images is calculated. In the averaging process, more recent
Exponential filter images are assigned greater weight than older images.
This filter can only be applied to the “Continuous” trigger source.

85
ifm Vision Assistant O3D3xx 3D sensor

8.3.6 Defining the 3D clipping box

The 3D clipping box allows the data to be used in the further calculation to be limited. Once the
3D clipping box has been defined, only the data within the min/max values are used for the further
calculation. Data outside the min/max values are discarded.
If the “Definition of the 3D clipping box” button is active, a min/max value can be defined for each of the
three coordinate axes.
Defining the 3D clipping box
►► Set the “Definition of the 3D clipping box” button to “On”.
>> The fields for the 3D clipping box will be displayed.

►► Enter the min/max values for the three coordinate axes.

The defined clipping box is shown differently in the views:

●● In the 3D view the data within the 3D clipping box are hidden.
●● In the 2D view the data within the 3D clipping box are displayed in magenta.

XML-RPC allows transformation of a coordinate system. The 3D clipping box is used for the
transformation.

86
 ifm Vision Assistant O3D3xx 3D sensor

8.3.7 Operating multiple devices

If devices are not fully visually separated they can interfere with each other.

f1 f1 f1 f1 f1 f2

UK

1 2 3

1: Mutual interference of the devices during simultaneous operation with a frequency f1

2: Interference prevention during operation with a frequency f1 by cascading the trigger signals
3: Interference prevention by operating with different frequencies f1 and f2

Interference can be prevented by taking the following measures:

Measure Description
The trigger signals are set in such a way that the devices are activated at different times
Cascading the trigger
(→ “Creating output logic” and Operating instructions).
signals
This is the preferred measure.
The devices are controlled using different frequency channels. There are 3 frequency channels to
choose from.
Operation via different This measure cannot be performed for the “More than 30 m” option, since this option already
frequency channels occupies 3 frequency channels.
For the option “Up to 30 m”, 2 of the 3 frequency channels are occupied. Therefore the devices must
share a frequency channel.

Setting up operation of multiple devices

►► Set the “operation of multiple devices” button to “On”.
>> The “Frequency channel” selection list appears.

►► Select the frequency channel for the device.

87
ifm Vision Assistant O3D3xx 3D sensor

8.4 Defining the models

The models define the features that are used to determine the filling height of objects (such as the height
of bulk material). A model consists of the following features:

Feature Description
Model type The model type determines the technique that is used for measuring the filling height.
ROI At least one ROI indicates the area to which the measurement relates.
The process value specifies the value (maximum, minimum, mean) of the measured data to be used for
Process value
comparison with the switching setpoints.
The switching setpoints specify values for evaluating the measurement results (e.g. switching a filling
Switching setpoints
system that has a controller connected to it).

The model features can be output to a connected controller via the interfaces of the device.
Changes to a model may necessitate changes in the output logic and/or in the interface definitions.
►► After any change to a model, check whether the output logic and/or in the interface definitions
must be modified to suit (→ “8.5 Creating output logic” and “8.6 Set the interface”).

►► Click on .
>> The model list and the model results will be displayed in addition to the live image:

88
 ifm Vision Assistant O3D3xx 3D sensor

8.4.1 Defining the model type

►► Click on [Add] in the model list.
►► Selecting the model type:

Model type Description

Filling level Measurement of the distance of the face of an object from a reference plane
Distance Measurement of the distance of the face of an object from the device
Volume Measurement of the volume of the face of an object from a reference plane

UK
1: Distance between the face of an
object and the reference plane in
the model types “Filling level” and
“Volume”
2: Distance between the face of
an object and the device in the
model type “Distance”
2

>> A window for the selection of the level model opens:

►► Selecting the level model.
>> Depending on the model type selected, the level models have the following meanings.

Model type “Filling level” Model type “Distance” Model type “Volume”
The minimum vertical distance of the The maximum vertical distance of the face
face of an object from a reference plane of an object from the device is defined by
is defined by the switching setpoint the switching setpoint SP1. If the measured
SP1. If the measured value is less than value is less than this distance, the object is
this distance, the object is classed as classed as underfilled.
underfilled.
●● The minimum vertical distance of the ●● The minimum vertical distance of the ●● The minimum volume of the face
face of an object from a reference face of an object from the device is of an object from a reference plane
plane is defined by the switching defined by the switching setpoint SP1. is defined by the switching setpoint
setpoint SP1. If the measured value If the measured value is less than this SP1. If the measured value is less
is less than this height, the object is height, the object is classed as overfilled. than this volume, the object is
classed as underfilled. ●● The maximum vertical distance of the classed as underfilled.
●● The maximum vertical distance of the face of an object from the device is ●● For maximum volume of the face of
face of an object from a reference defined by the switching setpoint SP2. an object from a reference plane is
plane is defined by the switching If the measured value is greater than defined is defined by the switching
setpoint SP2. If the measured value is this distance, the object is classed as setpoint SP2. If the measured value
greater than this distance, the object is underfilled. is greater than this volume, the
classed as overfilled. object is classed as overfilled.

89
ifm Vision Assistant O3D3xx 3D sensor

Model type “Filling level” Model type “Distance” Model type “Volume”
●● The minimum vertical distance of the ●● The minimum vertical distance of the
face of an object from a reference face of an object from the device is
plane is defined by the switching defined by the switching setpoint SP1.
setpoint SP1. As long as the measured Once the measured value falls below this
value lies below this value, the pump value, the pump is switched off and the
remains actuated and the filling process filling process ceases.
continues. ●● The maximum vertical distance of the
●● The maximum vertical distance of the face of an object from the device is
face of an object from a reference defined by the switching setpoint SP2. As
plane is defined by the switching long as the measured value lies above
setpoint SP2. Once the measured this value, the pump remains actuated
value rises above this value, the pump and the filling process continues.
is switched off and the filling process
ceases.
An optimum vertical distance from a An optimum vertical distance from the
reference plane is defined by the target device is defined by the target value
value SPM. The maximum vertical SPM. The maximum vertical upwards and
upwards and downwards variance downwards variance from this target value
from this target value is defined by the is defined by the hysteresis. From this the
hysteresis. From this the switching switching setpoints SP1 (upper maximum
setpoints SP1 (lower maximum variance variance from the target value) and SP2
from the target value) and SP2 (upper (lower maximum variance from the target
maximum variance from the target value) value) are calculated.
are calculated.

>> Once the level model has been selected, the respective model features and their default values are
displayed.
►► An appropriate model name should be entered into the field “Name”.
The model is displayed under this name in the output logic (→ “8.5 Creating output logic”).
►► Input switch value(s) in metres for the selected model type and the selected level model.

8.4.2 Defining a reference plane (only for model type “Filling level”)
The reference plane must be specified for the model type “Filling level”. The filling height at any point is
determined by the difference between the measured distance value at that point and the reference value.
The reference plane can be input manually or generated automatically:

Method Procedure
►Select
► the entry “Input” in the “Reference plane” drop-down menu.
►Input
► the distance in metres between the device and reference plane.
Manually
●● Advantage: If during operation small changes in the level occur, these are “averaged out”.
●● Disadvantage: Asymmetrical irregularities and oblique faces in particular can lead to measurement errors.
►Make
► sure there are no objects present in the desired area and depicted in the live image.
►Select
► the entry “Measure” in the “Reference plane” drop-down menu.
>> The device will measure the distance at every point, and determine the reference plane from these
measured values.
>> Successful determination of the reference plane will be indicated by a green tick.
Automatically
If changes occur, the reference plane can be determined afresh by selecting [Teach].

●● Advantage: Uneven or oblique planes can be used as the reference plane.

●● Disadvantage: Changes in the unevenness or inclination, or rotation of oblique planes, can lead to
measurement errors.

90
 ifm Vision Assistant O3D3xx 3D sensor

8.4.3 Defining and editing ROIs

When a level model is selected (→ “8.4.1 Defining the model type”) a rectangular ROI is automatically
displayed in the live image.
Up to 64 ROIs can be defined for a model.
►► Selecting the shape of the ROI in the “ROIs” window:

Shape Name Description

Rectangle Rectangular area with variable length and width.

Ellipse Elliptical area with variable length and width.

UK
Polygon with vertices that can be freely positioned. The last vertex must coincide with the first vertex,
Polygon so that an enclosed area is created. If any connecting lines cross, the separate area thus created is
excluded from the ROI.
Rectangular ROI matrix with variable length and width. The RO matrix contain individual ROIs all of
Multi-ROI
the same shape and size.

●● With the exception of polygons the ROIs are inserted into the live image by clicking and dragging
with the mouse button depressed.
●● The vertices of the polygon are positioned by clicking in the live image.
►► Matching the shape of the ROI to the object to be measured:

Matching Procedure
Changing the size and ►Click
► on the ROI.
shape ►Click
► on the edge marks and with the mouse button depressed, drag it to the desired position.
►Click
► on the ROI.
Shift the ROI
►With
► the mouse button depressed, drag the ROI to the desired position.
►Click
► on the ROI.
Rotate the ROI ►Click
► the rotation symbol (curved arrow) and drag it in the desired direction.
>> The ROI will rotate about its centre of area.
Adapt a multi-ROI
►Click
► on the ROI.
►Click
► with the pen symbol on the bottom edge of the ROI matrix.
>> A window for adjusting the multi-ROI will open.
–– Shape: Specifies the shape of the individual ROIs. The ROIs of a multi-ROI all have the same
shape.
–– Grid type: Specifies the geometrical arrangement of the ROIs within the multi-ROI
(→ “Step 3: Region of Interest (ROI)” on page 24).
–– Number of columns/rows: Specifies the number of individual ROIs in the multi-ROI. The number of
ROIs in a multi-ROI is limited to 64.
–– Shape size: The individual ROIs in the multi-ROI are scaled using [+] and [–]. The pre-set scaling
factor operates the same on all ROIs and in both spatial directions. The upper limit of the scaling
is set by the size of the ROI matrix.
►To
► change the ROI dimensions in various directors:
Click on the edge mark of the ROI matrix and with the mouse button depressed drag into position in
which the ROIs with the scaling are displayed.

91
ifm Vision Assistant O3D3xx 3D sensor

8.4.4 Defining and editing RODs

Up to 64 RODs (Region of Desinterest) can be defined for a model.
►► Selecting the shape of the ROD in the “ROIs” window:
Shape Name Description

Rectangle Rectangular area with variable length and width.

Ellipse Elliptical area with variable length and width.

Polygon with vertices that can be freely positioned. The last vertex must coincide with the first vertex,
Polygon so that an enclosed area is created. If any connecting lines cross, the separate area thus created is
excluded from the ROI.

●● With the exception of polygons the RODs are inserted into the live image by clicking and dragging
with the mouse button depressed.
●● The vertices of the polygon are positioned by clicking in the live image.
►► Matching the shape of the ROD to the object to be measured:
Matching Procedure
Changing the size and ►Click
► on the ROD.
shape ►Click
► on the edge marks and with the mouse button depressed, drag it to the desired position.
►Click
► on the ROD.
Shift the ROD
►With
► the mouse button depressed, drag the ROD to the desired position.
►Click
► on the ROD.
Rotate the ROD ►Click
► the rotation symbol (curved arrow) and drag it in the desired direction.
>> The ROD will rotate about its centre of area.

8.4.5 Activating position tracking

Position tracking allows recording of objects whose position and rotation may vary. This option is
activated optionally when a model is created.

Position tracking operates reliably only when there is sufficient depth contrast in the areas around
the ROIs. The is typically the case in crates of drinks or similar containers.
Activating position tracking
►► Set the “Position tracking” button to “On”.
>> The position tracking must be taught. Position tracking is taught automatically at switching on.

>> Successful teaching is shown with a green tick. Position tracking can be taught again by pressing the
“Teach” button.

If the ROIs are changed, position tracking must be taught again.

If the teaching fails, the following actions may lead to success:

●● Changing the installed position and orientation of the device. Ideally the device has a vertical view
down on to the object.
●● Set the exposure time so that the areas around the ROIs deliver valid measured values.

Depending on the number and size of the objects, the evaluation time may increase when position
tracking is activated.

92
 ifm Vision Assistant O3D3xx 3D sensor

8.4.6 Defining the ROI distance value

The ROI distance value is the process value, to which the switching setpoints are compared. There are
3 methods available for the calculation of process values from the measured data:

Method Process value calculation

Minimum Smallest measured value in the ROI
Maximum Largest measured value in the ROI
Mean Mean of all measured values in the ROI

UK
1: ROI
1 2: Maximum
3: Mean
4: Minimum
2

3
4

8.4.7 Defining the setpoint values

Depending on the selected model type and the selected level model (→ “8.4.1 Defining the model type”)
the input window and a graphical representation of the setpoint values are displayed in the model list.

Setpoint value Description

For both model types, this setpoint value is the smaller value. For the model type “Filling level” it defines the
SP1
lower setpoint. For the model type “Distance” it defines the upper setpoint.
For both model types, this setpoint value is the larger value. For the model type “Filling level” it defines the
SP2 upper setpoint. For the model type “Distance” it defines the lower setpoint.
This setpoint value does not exist for the level model “Underfill”.
This mean setpoint value must be defined for the level model “Setpoint value switch”. In addition the setpoint
value distance d must be specified. The setpoint values are calculated as follows:
SPM
●● SP1 = SPM – d
●● SP2 = SPM + d

8.4.8 Model results

The model results can be displayed in a window under the live image.
The status of the ROIs (OK, underfilled, overfilled, invalid) is displayed in coloured fields. The number of
ROIs that satisfy the properties can be read there.

The icons and allow toggling between a numeric display and a graphical presentation (→ “7.4
Results”).

93
ifm Vision Assistant O3D3xx 3D sensor

8.5 Creating output logic

Model results and pin events for the existing device outputs are assigned on the “Logic” screen in order to
make the data available to a connected controller (PLC / PC).

8.5.1 General setting rules

Creation of the output logic is based on the following rules:
●● Pin events are output as binary numbers (1 = true, 0 = false) and can be assigned only to digital
outputs.
●● Model results are numeric values and can be processed as follows:
–– Direct output via an analogue output
–– Use of arithmetic operators followed by output via an analogue output
–– Digitalising by comparison with other results or values
–– Further processing of digitalised values by use of arithmetic operators and/or logical functions
–– Output of a binary value via a digital output or a virtual pin
The following diagram shows an overview of the configuration options for the output logic. Because of the
large number of combination options, the logic circuits are divided into modules. The same numbers show
the connections between the modules.

1
Pin-Ereignis DIGITAL_OUT Digitalisierung DIGITAL_OUT
Virtual pin

3
Logische
ANALOG_OUT Funktionen

Modellergebnis 2

ANALOG_OUT Arithmetik
Arithmetik

1 Statistik
Digitalisierung

2 3
DIGITAL_OUT Logische DIGITAL_OUT
Arithmetik
Virtual pin Funktionen Virtual pin
3 1
Logische
Funktionen Digitalisierung

2
Statistik
Arithmetik

1
Digitalisierung
Statistik

94
 ifm Vision Assistant O3D3xx 3D sensor

8.5.2 Placing logic modules and assigning signals

►► Click on .
>> The “Logic” screen is displayed.

UK

1: Main area
2: Selection area
3: Overview area

Window area Description

In the main area, the assignment of the pin events to the outputs is visualised. The pin events and outputs
are shown as boxes with a different font colour. Lines between these boxes represent the assignment.
Main area
If the elements in the main area are distributed beyond the visible area, the visible area can be displaced
using the scroll bars at the edge of the main area.
Selection area In the selection area, all pin events and outputs are listed.
At the bottom of the selection area, a smaller version of the main area is displayed for a better overview.
Overview area If the elements in the main area are distributed beyond the visible area, the visible area can be moved by
dragging the red box with the mouse.

The following functions can be executed in the “Logic” screen:

Generate Example
This function is intended as an aid for the user who has little experience or no experience at all of creating
output logic.
►► Click on [Generate Example].
>> An output logic suitable for the defined models is generated as an example.

Place new box in main area

►► Click on the entry in the selection field and keep the mouse button pressed.
►► Drag the entry to the main area, keeping hold of the mouse button and release the mouse button when
in the desired position (drag and drop).

95
ifm Vision Assistant O3D3xx 3D sensor

>> The corresponding box is displayed in the target position.

>> At the edge of the box at least one pin is shown, which is used for the allocation.
>> A box can be moved to any position in the main area by drag-and-drop.

The device has a limited number of outputs. If an attempt is made to place more boxes than there
are available outputs, an error message is displayed.

Delete box
►► Click on the box.
>> A recycle bin is displayed at the bottom right corner of the box.

►► Click on the recycle bin.

>> The box and, if necessary, the connection to another box are deleted.

Setting a logic module

A pencil is shown at the bottom right corner of the marked box for logic modules for which there are
settings.
►► Click on the box.

►► Click on the pencil.

>> A window with the settings is displayed (→ “8.5.3 Description of the logic modules”).

96
 ifm Vision Assistant O3D3xx 3D sensor

Assigning signals
►► Place the mouse pointer on the output pin at the right hand edge of the box.
►► While keeping the mouse button pressed, drag the mouse cursor from the output pin.
>> Free input pins which can be assigned to signal present at the output pin are displayed in green.
–– Each input pin can be assigned only one signal.
–– An output signal can be assigned to multiple input pins.

The ifm Vision Assistant tests the compatibility of the signal types. For instance numeric and
binary values cannot be directly compared with each other. No check of units of measure is made.
For instance it would be possible to add together the numeric values “Process value” (unit: m) and
UK
“Quality” (unit: %).

►► When assigning signals, pay regard to the units of measure.

>> A red connecting line appears between the pin event box and the cursor.

►► Move the cursor to the green pin of the desired box.

►► When the connecting line between the output signal box and input signal box turns green, release the
mouse button.
>> The successful assignment is represented by a purple connecting line.

>> When moving the boxes in the main area, the connecting lines are carried over.

Deleting an assignment
►► Click on the connecting line assignment to be deleted.
>> A recycle bin is displayed.

►► Click on the recycle bin.

97
ifm Vision Assistant O3D3xx 3D sensor

8.5.3 Description of the logic modules

Model results
The models that were defined on the “Models” screen are available for selection on the “Logic” screen.
When a logic module is placed on the “Logic” screen, the following window is displayed:

Option Output signals Code Description

All Regions of ●● 1: The quality of the measured values in all the ROIs is “OK”.
binary
Interest (ROIs) OK ●● 0: The quality of the measured values in at least one ROI is not “OK”
Number of the ROIs in which the process value is less (filling level
Number of
numeric measurement) or greater (distance measurement) than the lower
underfills
setpoint value.
Number of the ROIs in which the process value is greater (filling
Number of overfills numeric level measurement) or less (distance measurement) than the higher
Completeness model
setpoint value.
Number of OK
Regions of Interest numeric Number of the ROIs with measured values of the quality “OK”.
(ROIs)
Number of invalid
Regions of Interest numeric Number of the ROIs with measured values of the quality “invalid”.
(ROIs)
Process value numeric → “8.4.6 Defining the ROI distance value”.
●● Filling level measurement: Lower setpoint value in metres
SP1 numeric
●● Distance measurement: Upper setpoint value in metres
Result of an ROI ●● Filling level measurement: Upper setpoint value in metres
SP2 numeric
●● Distance measurement: Lower setpoint value in metres
Quality of the measured values in the ROI on a scale of 0 % (poor) to
Quality numeric
100 % (good).

For both options, the value can be altered using the pencil symbol on the model. In addition, for the option
“Result of an ROI” the value can be switched to another ROI (if available).

Arithmetic
The following arithmetic functions can be applied to the values:

Code at Code at the

Function Description
the input output
Subtracts the signals that are present at the two inputs. When the output is
DIFF numeric numeric
selected, the positive/negative sign can be specified.
ADD numeric numeric Add the signals that are present at the two inputs.
Add the signals that are present at the inputs. During addition the binary values 1
COUNT binary numeric
and 0 are treated as numeric values.
Permits the input of a floating point number which can be used for the arithmetic
Fixed – numeric
functions “DIFF” and “ADD” (e. g. for setting an offset).

98
 ifm Vision Assistant O3D3xx 3D sensor

Digitalisation
The digitalisation functions allow the incoming numeric values to be compared to each other. The output
value is binary.

Function Description Output value

The input value (value) is compared with 2 threshold values (THR1,
THR2). The output value corresponds to an NC contact (Normally 1
FNC window Closed):
function ●● Output value = 0 if value < THR1 0
●● Output value = 0 if value > THR2
THR1 THR2
UK
●● Output value = 1 if value ≥ THR1 AND value ≤ THR2

The input value (value) is compared with 2 threshold values (THR1,

THR2). The output value corresponds to an NO contact (Normally 1
FNO window Open):
function ●● Output value = 0 if value < THR1 0
●● Output value = 0 if value > THR2
●● Output value = 1 if value ≥ THR1 AND value ≤ THR2 THR1 THR2

The input value (value) is compared with 2 threshold values (THR1,

THR2). The output value corresponds to an NC contact (Normally
Closed). The switching at the setpoint values is delayed (switching
hysteresis):
1
FNCh window ●● Output value = 0 if value < (THR1 – 0.5 • hysteresis)
function ●● Output value = 0 if value > (THR2 + 0.5 • hysteresis)
●● Output value = 1 if value ≥ (THR1 + 0.5 • hysteresis) AND value ≤ 0
(THR2 – 0.5 • hysteresis) THR1 THR2
●● The output values remain unchanged in the hysteresis ranges.
●● Hysteresis = 0.05 • (THR2 – THR1)
●● Hysteresis = 2 mm, if 0.05 • (THR2 – THR1) ≤ 2 mm
The input value (value) is compared with 2 threshold values (THR1,
THR2). The output value corresponds to an NO contact (Normally
Open). The switching at the setpoint values is delayed (switching
hysteresis):
1
FNOh window ●● Output value = 1 if value < (THR1 – 0.5 • hysteresis)
function ●● Output value = 1 if value > (THR2 + 0.5 • hysteresis)
●● Output value = 0 if value ≥ (THR1 + 0.5 • hysteresis) AND value ≤ 0
(THR2 – 0.5 • hysteresis) THR1 THR2
●● The output values remain unchanged in the hysteresis ranges.
●● Hysteresis = 0.05 • (THR2 – THR1)
●● Hysteresis = 2 mm, if 0.05 • (THR2 – THR1) ≤ 2 mm
The input value (value) is compared with 2 threshold values (THR1,
THR2). The output value corresponds to an NC contact (Normally
Closed). The setpoint values correspond to the switching values of 1
the hysteresis:
HNC hysteresis
●● Output value = 0 if value < THR1 0
●● Output value = 1 if value > THR2
●● In the hysteresis range (THR1 ≤ value ≤ THR2) the output value THR1 THR2
remains unchanged.
The input value (value) is compared with 2 threshold values (THR1,
THR2). The output value corresponds to an NO contact (Normally
Open). The setpoint values correspond to the switching values of the 1
hysteresis:
HNO hysteresis
●● Output value = 1 if value < THR1 0
●● Output value = 0 if value > THR2
●● In the hysteresis range (THR1 ≤ value ≤ THR2) the output value THR1 THR2
remains unchanged.

Two input values (A, B) are compared with each other.

Comparators ●● Output value = 1 if the relationship shown at the output is applicable
●● Output value = 0 if the relationship shown at the output is not
applicable

99
ifm Vision Assistant O3D3xx 3D sensor

Logical functions
The logical functions can be applied exclusively to binary values.

Function Description
●● Output value = 1 if all input values = 1
AND
●● Output value = 0 if at least one input value = 0
●● Output value = 1 if at least one input value = 1
OR
●● Output value = 0 if all input values = 0
The output value is the inverted input value:
NOT ●● Output value = 1 if input value = 0
●● Output value = 0 if input value = 1

Each logical link can have a maximum of 64 inputs. Results of a logical link cannot be assigned to the
input of a previous link level.
Pin events

Pin event Description

Ready for trigger (Ready) The device is ready to be triggered and to capture a new image.
The device has finished the image capture and the calculation of the image data. The image data is
Evaluation finished
ready to be transferred via Ethernet.
Image capture finished The device has finished the image capture. This signal can be used for cascading the trigger signals
(Cascading) when operating several devices (→ “8.3.7 Operating multiple devices”).
The status of the digital output can be switched to "high" or "low" using the "o" command via the
PCIC O-command
process interface.

Output
The output values can be assigned to various outputs depending on their coding (binary, numeric).

Code at
Output Settings Description
the input
Static The output is switched on without time limit (recommended setting).
DIGITAL_OUT1/2/3 binary The output is switched on with a limited pulse duration. The signal duration can
Pulsed
be set in ms. The minimum value is 10 ms.
The output value can be output as a current signal (I) between 4 and 20 mA or
Mode
as a voltage signal (U) between 0 and 10 V.
The output signal increases as the output value increases (Increasing, ↑) or
Direction
decreases as the output value increases (Decreasing, ↓).
Depending on the direction selected, this is the smallest or the largest output
value:
Start point ●● Increasing direction: The start point output value corresponds to 0 V or 0 mA
ANALOG_OUT ●● Decreasing direction: The start point output value corresponds to 24 V or 100 mA
numeric
ANALOG_OUT_DYN If the output is via ANALOG_OUT_DYN, a dynamic start point can be assigned
to the respective input.
Depending on the direction selected, this is the smallest or the largest output
value:
End point ●● Increasing direction: The end point output value corresponds to 24 V or 100 mA
●● Decreasing direction: The end point output value corresponds to 0 V or 0 mA
If the output is via ANALOG_OUT_DYN, a dynamic end point can be assigned
to the respective input.
A virtual pin can be output as part of a datagram via TCP/IP or EtherNet/IP
(→ “8.6 Set the interface”). The virtual pin consists of an 8-bit sequence. In the
Virtual pins byte 1–8 binary – datagram the 8 virtual pins are arranged in sequence. Virtual pins can thus
output a maximal of 64 binary values via the Ethernet interface. For the inputs, a
binary 0 is output for the virtual pins that are not assigned.

100
 ifm Vision Assistant O3D3xx 3D sensor

Statistic (Pass/Fail)
A binary value can be defined as a decision criterion which is evaluated as a success event (1) or failure
event (0).
The results are written to the Service Report and can be accessed from there for statistical calculations
(→ “7.5 Service reports”).

8.6 Set the interface

The data packets which are sent via the Ethernet interface can be defined in the “Interface” screen.

UK
►► Click on .
>> The “Interface” screen is displayed.

1: Main area
2: Adjustment area
3: Overview area
4: Output string

Window area Description

In the main area, the data blocks of a data packet are displayed in the form of boxes. The data is sent in
the order of the data blocks from left to right.
Main area
If the elements in the main area are distributed beyond the visible area,, the visible area can be displaced
using the scroll bars at the edge of the main area.
The adjustment area comprises the following sub-areas:
●● Interfaces: The interfaces can be configured for either the EtherNet/IP or TCP/IP network protocol.
All settings are applicable to the selected network protocol.
●● Pre-set data packets: The ifm Vision Assistant contains pre-set data packets that can be loaded or
Adjustment area used as templates for user-defined settings. When a pre-set data packet is changed, it becomes a
user-defined data packet. The pre-set data packet is retained in its original state. The last modified data
packet can be downloaded as a user-defined data packet.
●● General output format: The general output format relates to all the data packets that are generated
(see the following section).
In the bottom right corner of the main area, a smaller version of the main area is displayed for a better
Overview area overview. If the elements in the main area are distributed beyond the visible area, the visible area can be
moved by dragging the red box with the mouse.
●● The output string shows the character string that is incorporated in the datagram. Depending on the
overall “data coding” setting in the setting area, the output string is displayed either in ASCII code or
Output string
binary code.
●● With the [Clipboard] button, the output string can be copied to the clipboard.

101
ifm Vision Assistant O3D3xx 3D sensor

Setting the general output format

The general output format of the numerical values can be set using the overall settings. The diagnostic
data can be assigned to individual output formats which can deviate from the general output format
(→ “Changing the data block settings”).
►► Click on [Overall Settings] in the adjustment range.

Setting Description
Data coding Format for the data coding: ASCII or binary.
Precision Number of decimal places.
●● Fixed: Fixed point number
Display format
●● Scientific: Exponential representation
Decimal separator 7-bit character (e.g. “.”) as the separator within decimal numbers.
Output format:
●● 2: Binary
Base ●● 8: Octal
●● 10: Decimal
●● 16: Hexadecimal
Width Minimum overall length of the value. If the value exceeds this width, it will not be shortened.
●● On: Every bit position unoccupied by the value is filled with a binary 0 and positive values will be
Numeric fill preceded by a plus sign.
●● Off: Bit positions unoccupied by the value remain empty.
Fill Fill character
Alignment Right or left alignment of the value within the defined bit width.
●● Little endian: The least significant value byte of a binary value stored first or at the lowest storage
address.
Byte order ●● Big endian: The most significant value byte of a binary value stored first or at the lowest storage
address.
●● Network byte order: Byte order which is determined by the network protocol.

Each setting can be reset to its default value using the [Reset] button.

For further information about the settings → Operating instructions.

Insert data block

A data block can be inserted at the beginning or at the end of an existing data block.
►► Click on the plus sign where the data block should be inserted.

>> A selection list is displayed in which the data blocks are organised into the following groups:

Group Date block Description

Start character Indicates the beginning of the data packet.
End character Indicates the end of the data packet.
Free text Allows the insertion of free text in the data packet.
General
Unit vector matrix e1/ Inserts a unit vector matrix for projecting a radial distance to the corresponding axis in
e2/e3 the Cartesian coordinate system (X, Y, Z).
Conversion into the
Conversion of the current coordinates to the world coordinate system.
world coordinate system

102
 ifm Vision Assistant O3D3xx 3D sensor

Group Date block Description

X/Y/Z image Cartesian X, Y, Z coordinates of the pixels.
Image of the normalised Image of the amplitude values of the light reflected by the object. The amplitude
amplitude values are normalised to the exposure time.
Images
Radial distance image Image of the distance value, determined by the duration.
Pixel status indicator Indication of the state (e.g. invalid, saturated) for each pixel.
Amplitude Image Image of the measured amplitude values of the light reflected by the object.
The data of all models defined for the application are listed in succession. The data
block is displayed in the form of a program loop. The contents of the program loop
consist themselves of data blocks, which can be selected separately:
●● ID: The ID consists of a consecutive number (0–999) in the sequence in which UK
the models were defined. After the ID number 999 has been allocated within an
application, the IDs of deleted models will be reused.
●● Regions of Interest: The data of all ROI defined for the model are listed in
succession. The data block is displayed in the form of a program loop. The contents
of the program loop consist themselves of data blocks, which can be selected
separately:
Models –– ID: The ID consists of a consecutive number (0–999) in the sequence in which
the ROIs were defined. After the ID number 999 has been allocated within a
model, the IDs of deleted ROIs will be reused.
Application –– quality: quality of the measured values in the ROI in %.
results –– process value: process value the ROI (→ “8.4.6 Defining the ROI distance
value”).
–– Status: Status of the ROI as a character string.
–– Free text: Allows the insertion of free text in the data packet.
–– Delimiter: Delimiter for separating data blocks.
●● Number of Regions of Interest (ROIs) in the model
●● Free text: Allows the insertion of free text in the data packet.
●● Delimiter: Delimiter for separating data blocks.
Number of models Number of models defined for the application
Digital output Bit sequence with the values present at the digital outputs.
8-bit sequence with the values present at the inputs of the virtual pins (→ “8.5.3
Virtual output
Description of the logic modules”).
Temperature of the
Temperature of the image converter circuit board.
front end
Temperature of the
Temperature of the device illumination.
lighting
Diagnostic
Evaluation time Time for calculating the image data.
Frame rate Actual frame rate.
Diagnostic data → Operating instructions.
Delimiter – Delimiter for separating data blocks.

Data packets that are complicated in structure require more effort during parser configuration and
are also prone to error.
►► Therefore, data packets should be kept as simple and short as possible.

103
ifm Vision Assistant O3D3xx 3D sensor

Showing and hiding loops

The data blocks “Models” and “Regions of Interest:” are assembled for individual data blocks into data
block sequences. If more than one model and/or more than one ROI are defined for the application, these
data block sequences are output successively.
These data blocks are displayed in the form of a program loop on the “Interfaces” screen. The following
diagram provides an example.

The program loop can be shown or hidden by clicking on the data block.

Delete data block

►► Click on the box.
>> A recycle bin is displayed at the bottom right corner of the box.

►► Click on the recycle bin.

>> The data block is deleted.

Changing the data block settings

►► Click on the box.
>> If the settings of the data block can be changed, a pencil is displayed at the bottom right corner of the
box.

►► Click on the pencil.

>> The settings of the data block are displayed in a selection list:

Group Modifiable data blocks Options

Start character Input of a string that marks the start of the data packet.
General End character Input of a string that marks the end of the data packet.
Free text Input of a string for application-specific purposes.

104
 ifm Vision Assistant O3D3xx 3D sensor

Group Modifiable data blocks Options

Models:
●● ID
●● Regions of Interest:
Application –– ID
results –– Status The following output formats can be individually set for each data block of
–– Quality this group:
●● Number of Regions of Interest ●● Data type: Signed integer (integer), unsigned integer (unsigned integer)
or floating point number (float) of different bit sizes.
Number of models
●● Data coding: Format for the data coding (ASCII or binary).
Temperature of the front end ●● Scale: Factor by which the measured value is scaled.
●● Offset: Amount to be added to the measured value.
Temperature of the lighting
Evaluation time
●● Precision: Number of decimal places (only for floating point numbers).
●● Display format: Fixed point number (fixed) or exponential (scientific). UK
●● Decimal delimiter: 7-bit characters (e.g. “.”) as a separator of decimal
numbers (only for floating point numbers).
●● Base: Binary, octal, decimal or hexadecimal output format (only
integers).
●● Width: If the value exceeds this width, it will not be shortened.
Diagnostic
●● Numeric fill: Each unoccupied bit position from the value is filled with a
binary 0 (on) or remains empty (off).
Frame rate ●● Fill: Fill character.
●● Alignment: Right or left alignment of the value within the defined bit
width.

Delimiter – Delimiter for separating data blocks.

105
ifm Vision Assistant O3D3xx 3D sensor

8.7 Test
The application can be tested on the “Overall test” screen.
Start test

►► Click on .

>> The live image view can be set up under the “Display options” tab (→ “7.2 View options”).
►► Click on [Start test] in the “Test Operations” field.
>> The device will start in accordance with the settings for the trigger source for the image capture.
>> If the device is not set up for continuous image capture, capture of a test image can be triggered using
[Manual trigger].
>> Miniature views of the last 10 test images are shown in the bar under the live image, in order of
capture from left (earliest) to right (latest).
>> Each test image has stored with it the values of the status LEDs (OUT1, OUT2) and the model
statistics.
>> The output string can be displayed in ASCII format under the tab “PCIC output”. The output string can
be copied on to the Windows clipboard.

View test images

►► Click on [Stop test].
►► Click on the desired test image in the bar.
>> The miniature view of the selected test images is displayed with a frame.
>> The following test results are displayed or can be shown:
●● The selected test image is displayed instead of the live image.
●● The associated statuses (status LEDs, model statistics) are displayed (→ “7.1 Status displays”).
●● The model results for the selected test image can be displayed under the “results” tab (→ “7.4
Results”).
>> Clicking multiple times on the test image toggles between the test image and the most recently
captured test image.

106
 ifm Vision Assistant O3D3xx 3D sensor

8.8 Programming an example application

The following example is intended to make clear the necessary steps when creating a typical application
in extended programming mode.
Description of the example application
A box (e. g. on a conveyor belt) is filled with objects. The application should perform the following
functions:
●● Output the actual mean filling height at the analogue output. A controller that responds to changes in
the filling height.
●● A digital output that switches if the mean filling height lies between two defined switching setpoints. UK
●● A second digital output that switches if the maximum filling height is exceeded.
Pre-requirements
●● The device must be correctly installed (→ “3 Installation”).
●● The connection to the device must be established (→ “4.1 Find device”).
Creating the application
►► Start extended programming mode (→ “8 Extended programming mode”).
►► Create new application (→ “9.3 Add new application”).
>> Configuration of the new application is started (→ “9.2 Edit application”).
Setting up the image
►► Place an empty box under the device.

►► Select image settings (→ “8.3 Image settings”):

–– Trigger source: Continuous
–– Maximum visible distance: Less than 5 m [1 frequency]
–– Exposure modes: Two exposures
–– Filter: No filter

►► Click on “image capture” in the menu bar, to activate the continuous live image display.
►► If necessary Modify the display options to suit the actual scene (→ “7.2 View options”).
►► Click on [Optimise] to optimise the exposure time.

107
ifm Vision Assistant O3D3xx 3D sensor

Creating the model “Box level”

►► Click on .
►► Click on [Add] in the model list, and select “Filling level”.

►► Select the level model “Underfill & Overfill”.

>> The new model is set up with an automatically placed ROI (ROI 0).

108
 ifm Vision Assistant O3D3xx 3D sensor

►► Set the shape of ROI 0 so that it covers the base of the box.

UK

►► In the “Reference plane” field, select the “Teach plane” option.

►► Click on [Teach].
>> The are within ROI 0 is taught as the reference plane.

►► In the “ROI distance value” field, select the “Mean” option.

►► If the live mode is no longer active:

Click on “image capture” in the menu bar, to activate the continuous live image display.

109
ifm Vision Assistant O3D3xx 3D sensor

►► Place the first object in the box.

►► If this causes a reduction in quality: Optimise the exposure time once again.
►► Read the process value in the model results.

>> The process value in the example is 0.087 m.

►► Subtract a tolerance from the process value and input the calculated value as the switching
setpoint SP1.
>> The switching setpoint in the example is 0.080 m. The switching setpoint SP2 is set automatically,
based on the value of SP1, since this value must be at least as large.
►► If the live mode is no longer active:

Click on “image capture” in the menu bar, to activate the continuous live image display.
►► Place a second object in the box.
►► If this causes a reduction in quality: Optimise the exposure time once again.
►► Read the process value in the model results.

110
 ifm Vision Assistant O3D3xx 3D sensor

UK

>> The process value in the example is 0.139 m.

►► Subtract a tolerance from the process value and input the calculated value as the switching
setpoint SP2.
>> The switching setpoint in the example is 0.135 m.
►► Input the model name “Box level”

111
ifm Vision Assistant O3D3xx 3D sensor

Creating the model “Maximum value in box”

►► Remove all objects from the box.
►► Click on [Add] in the model list, and select “Filling level”.
►► Select the level model “Underfill”.
>> The new model is set up with an automatically placed ROI (ROI 0).
►► Set the shape of ROI 0 so that it covers the base of the box.
►► In the “Reference plane” field, select the “Teach plane” option.
►► Click on [Teach].
>> The are within ROI 0 is taught as the reference plane.
►► In the “ROI distance value” field, select the “Maximum” option.
►► Input the model name “Maximum value in Box”

For this example application the switching setpoint value has no relevance and can be left as the
default value.

112
 ifm Vision Assistant O3D3xx 3D sensor

Preparing the working area for output logic

►► Click on .
>> The “Logic” screen is displayed.
►► Delete all the boxes displayed in the working areas (→ “8.5.2 Placing logic modules and assigning
signals”).

UK

Outputting the process value “Box level” at the analogue output

►► In the “Model results” field, click on the “Box level” model and drag it into the working area, keeping the
mouse button depressed.
>> After the mouse button is released, the following window is displayed:

►► In the window shown select the option [ROI 0].

>>
>> The following window is displayed:

►► In the open window select [Insert logic Blocks].

>> The “Box level” model box is displayed.

113
ifm Vision Assistant O3D3xx 3D sensor

►► In the “Output” field, click on the “ANALOG_OUT” analogue output and drag it into the working area,
keeping the mouse button depressed.
►► Modifying the settings of the analogue output to suit.

>> In the example the voltage is set to the range 0.09–0.14. As the input value increases, the output
current increases.
►► Assign the process value of the model box “Box level” to the input value of the analogue output
“ANALOG_OUT” (→ “8.5.2 Placing logic modules and assigning signals”).

114
 ifm Vision Assistant O3D3xx 3D sensor

If the process value “Box level” lies between the switching setpoints SP1 and SP2, switch digital
output 1
►► Place the digital output “DIGITAL_OUT2”, two “comparators” and the logical function “AND” on the
working area.
►► Assign the process value of the model box “Box level” to input A the of each of the two “comparators”.
►► Assign the switching setpoint SP1 of the model box “Box level” to input B of the first “comparator”.
►► Assign the switching setpoint SP2 of the model box “Box level” to input B of the second “comparator”.
►► Link output “A>B” of the first “comparator” to one input of the logical function “AND”.
►► Link output “A<B” of the second “comparator” to one input of the logical function “AND”. UK
►► Link the output of the logical function “AND” to the input of the digital output “DIGITAL_OUT2”.
►► Place a status definition on the working area.
►► Link the logical function “AND” to the input of the status definition.

The logic diagram requires an additional logic module “Status definition: Pass/Fail”, which is used
to count the value “OK / passed (green)” in the overall statistics (→ “8.5 Creating output logic”).

>> What this logic does is test whether the process value is greater than the lower switching setpoint SP1
and less than the upper switching setpoint SP2. If both conditions are satisfied at the same time, the
digital output is switched.

115
ifm Vision Assistant O3D3xx 3D sensor

If the process value “Maximum value in box” exceeds the maximum filling height (e.g. the edge of
the box), switch digital output 2
►► Place the model “Maximum value in box” (result of a Region of Interest (ROI)), digital output
“DIGITAL_OUT3”, a “comparator” and the arithmetic function “Fixed value” on the working area.
►► Set the arithmetic function “Fixed value” to the maximum filling height.

►► Assign the process value of the model box “Maximum value in box” to input A of the “comparator”.
►► Assign the fixed value to input B of the “comparator”.
►► Link the output “A>B” of the “comparator” to the input of the digital output “DIGITAL_OUT3”.

>> What this logic does is test whether the process value is greater than the fixed value. If this condition
is satisfied, the digital output is switched.

116
 ifm Vision Assistant O3D3xx 3D sensor

Configuring the interface

►► Loading the defaults of the interface configuration (→ “8.6 Set the interface”).

UK

Performing the overall test

►► Click on .

►► Make sure that with an empty box the following conditions are satisfied:
–– Both status LEDs (OUT1, OUT2) must be off.
–– The displayed switching setpoint values must match the settings for both models.
–– ”Underfilled” must be displayed for both models.

117
ifm Vision Assistant O3D3xx 3D sensor

►► Place the first object in the box.

►► Make sure that the following conditions are satisfied:

–– The status LED “OUT2” is lit.
–– The quality “OK” is displayed for the “Box level” model, since the filling height lies between the
switching setpoints SP1 and SP2.
–– “Underfill” is displayed for the “Maximum level in the box” model, since the filling height does not
exceed the maximum filling level.
–– Current is output at the analogue output (this is not displayed by the ifm Vision Assistant).

►► Place a second object in the box.

►► Make sure that the following conditions are satisfied:

–– The status LED “OUT2” is not lit.
–– “Overfill” is displayed for the “Box level” model, since the filling height lies above the switching
setpoint SP2.
–– “Underfill” is displayed for the “Maximum level in the box” model, since the filling height does not
exceed the maximum filling level.

118
 ifm Vision Assistant O3D3xx 3D sensor

UK

►► Place a further object in the box. This should be an object whose highest point does exceed the
maximum filling level.

►► Make sure that the digital output 3 is outputting the binary value “1” (24 V) (this is not displayed by the
ifm Vision Assistant).

Correcting the settings and saving the application

►► If any one of the conditions for passing the overall test is not satisfied, change the above settings and
repeat the test.
►► Once all the conditions for passing the overall test are satisfied, save the application.
►► In the application management, enter an appropriate name and if necessary a brief description of the
application.

119
ifm Vision Assistant O3D3xx 3D sensor

9 Application management
In application management, the connected device’s applications are displayed and managed.

►► Click on to open application management.

When switching from the monitoring screen to application management, the user must confirm that
the device evaluation (of the operation mode) is to be stopped.

Operating functions:
Button Name Description

Import application Opens a window for importing an application from a file.

Add new application Opens a window for generating and adding a new application.

Export Opens a window for exporting the application.

Duplicate Generates a copy of the application.

Delete Deletes the application.

Save Saves the modifications in the application.

Cancel Discards the modifications.

A maximum of 32 applications can be saved.

120
 ifm Vision Assistant O3D3xx 3D sensor

9.1 Activate application

►► Click on the arrow next to the desired application to activate it.
>> The arrow turns green.
If the activated application is deleted, no other application is automatically activated.

9.2 Edit application

The name and description of the application can be freely edited at a later time without changing
the application parameters and settings. UK
►► Click on the application.
>> The selected application is shown in light grey.

►► If desired, make modifications in the “Name” and “Description” input fields.

►► Click on to save the modifications.
►► Click on [Edit application].
>> The result depends on how the application was created:
–– If the application was created using the setup wizard:
The setup wizard opens (→ “6 Setup wizard”).
The type of application (Completeness detection or Dimensioning of rectangular objects) cannot be
changed. To change the type of application, the application must be deleted and regenerated.
If an application is edited, the values from the previously saved and taught settings continue to be
used. Individual steps can be skipped if necessary.
–– If the application was created in the extended programming mode:
The application editing window opens (→ “8 Extended programming mode”).

121
ifm Vision Assistant O3D3xx 3D sensor

9.3 Add new application

►► Click on to add a new application.
>> A new application is created with the name “Application”.
►► Make the desired modifications in the “Name” and “Description” input fields.
►► Click on [Edit application].
>> The setup wizard opens (→ “6 Setup wizard”).
When a new application is created the standard parameters are used.
>> If the extended programming mode is active, the application can be created in the application edit
window (→ “8 Extended programming mode”).

9.4 Import application

►► Click on .
>> The “Open” window for the application import is displayed.

►► Select the file to be imported (*.o3d3xxapp) and click on [Open].

>> As soon as the import is completed, the application is displayed in the application list.

If the file format of the imported application does not correspond to the designated format
(*.o3d3xxapp), an error message is displayed.

9.5 Export application

►► Click on the application to be exported.
>> The selected application is shown in light grey.
►► Click on .
>> The “Save as” window for the application export is displayed.

122
 ifm Vision Assistant O3D3xx 3D sensor

UK

►► Select the desired folder and name the file.

►► Click on [Save].
>> The saved application file has the ending “*.o3d3xxapp”.

9.6 Duplicate applications

Applications can be duplicated, in order to generate an application in which only the parameters need to
be changed, for example.
►► Click on the application to be duplicated.
>> The selected application is shown in light grey.

►► Click on .
>> A copy of the application is added to the end of the application list.

9.7 Resort application list

The order of applications in the application list can be changed by means of drag-and-drop.
►► Click on the application and hold the mouse button.
>> The application is marked coloured.
►► Drag the application to the new position.
►► Release the mouse button.
>> The applications are numbered in their new order.

By sorting the application list new IDs are assigned to the applications. The IDs are used for the
external control via the process interface.
►► Adapt external control to the new IDs.

123
ifm Vision Assistant O3D3xx 3D sensor

10 Device setup
Device setup offers the following settings:
●● General:
●● Enter the name and description of the device
●● Password protection On/Off
●● Import and export settings
●● Perform firmware update
●● Reset to the factory settings
●● Network:
●● Configure network protocol and network address
●● Interfaces:
●● Configure process interface

►► Click on .
>> The “Device configuration” screen is displayed.

124
 ifm Vision Assistant O3D3xx 3D sensor

10.1 General
In the “General” window, the basic functions and options for device settings are available.
►► Click on [General] to switch to the “General” window.
Operating functions
Field Button Description
Name – Editable field for entering a device name
Description – Editable field for additional device information

On
UK
Switches password protection “On” or “Off”.
Password protection
Off
Input field Editable field for entering a password
[Export] Generates a copy of the settings and applications on the PC.
Settings Takes a copy of the settings and applications on the PC and saves it to the
[Import]
device.
Installs a firmware update.
Firmware update [Update]
The current firmware version is displayed next to the button.
Restores the default factory settings and deletes all current settings and
Factory settings [Reset]
applications.
Reboot [Reboot] Restarts the device.

Save Saves the modifications on the device.

Cancel Discards the modifications.

10.1.1 Name and description

The name and description of the device can be freely edited.
►► Click on the input field.
►► Enter the desired text.
►► Click on to save the modifications.

125
ifm Vision Assistant O3D3xx 3D sensor

10.1.2 Password protection

When password protection is active, the “Applications”, “Device setup”, and “Device information” screens
are locked and can only be reached when the password is entered. Only the monitoring window can be
opened without entering a password.
►► Switch on password protection.

►► Enter the password in the input field.

►► Click on to save the modifications.

>> The modifications are saved on the device.

10.1.3 Firmware update

The current firmware is on the data carrier provided, or can if necessary be downloaded from the internet:
www.ifm.com → Service → Download → Industrial imaging → 3D sensors → e.g. O3D302

All settings and applications are deleted when a firmware update is conducted.
►► If necessary, export the existing settings beforehand.

►► Click on [Update] to perform a firmware update.

>> A confirmation prompt is displayed.

►► Click on [OK].
>> The “Open” window is displayed.

126
 ifm Vision Assistant O3D3xx 3D sensor

►► Select the desired firmware file (*.swu).

►► Click on [Open].
>> A message appears when the firmware update has been completed successfully.

>> The ifm Vision Assistant establishes a new connection to the device.
UK
After the update, there is no standard application on the device. With this application, the ifm Vision
Assistant switches to the monitoring screen.

Unsuccessful firmware update

Problem Corrective action

Error message:

►Change
► the device network settings to a static IP address.
>> After saving the settings, the ifm Vision Assistant will
automatically try to establish the connection.

The device is set to a temporary address or to DHCP.

Error message:

►► Click on the start screen and reconnect the device.

►Click
► on the message.
>> The following messages are displayed:

-or-

-or-

►Click
► on the “Install another firmware” message.
►Install
► other firmware.

127
ifm Vision Assistant O3D3xx 3D sensor

10.1.4 Export settings

The “Export” function allows all settings and applications to be exported from the device to the PC.
►► Click on [Export] to begin exporting the settings.
>> The “Save as” window is displayed.

►► Enter name and click on [Save].

>> The settings are saved in a file with the ending “.o3d3xxcfg”.

10.1.5 Import settings

During “Import”, the settings and applications can be imported together or separately. The following
options are available:
●● Global settings (name, description, etc.)
●● Network settings
●● Application settings

Existing settings and applications are overwritten during import.

►► If necessary, export the existing settings beforehand.

►► Click on [Import] to begin importing the settings.

128
 ifm Vision Assistant O3D3xx 3D sensor

>> The “Open” window is displayed.

UK

►► Select the desired file with the ending “.o3d3xxcfg” and click on [Open].
>> The “Import Selection” window is displayed.

►► Set the button for the settings to be imported to “On” (Global Settings, Network and/or Application
Settings).
►► Click on [OK].
>> The selected settings are imported.

129
ifm Vision Assistant O3D3xx 3D sensor

10.1.6 Factory settings

To delete all data (configurations, applications, etc.) on the device, the device can be reset to the factory
settings. The firmware version is not reset during this process.

Existing settings and applications are overwritten when a reset to factory settings is performed.
►► If necessary, export the existing settings beforehand.

►► Click on [Reset].
>> A confirmation prompt is displayed.

►► Click on [OK].
>> All settings are reset.
>> The device configuration is closed and the start screen is displayed.

130
 ifm Vision Assistant O3D3xx 3D sensor

10.1.7 Reboot
After an IP address change, the device must be rebooted in order to use the Ethernet/IP interface. There
is no need to reboot the device in order to use TCP/IP.
►► Click on [Reboot].
>> A confirmation prompt is displayed.

UK

►► Click on [OK].
>> A reboot is performed.

>> The ifm Vision Assistant establishes a new connection to the device.

>> If an application is activated, the ifm Vision Assistant continues with the monitoring screen. If no
application is activated, the ifm Vision Assistant switches to the edit screen.

►► If the connection to the device is unsuccessful, search for the device using on the start screen, or
connect it manually.

131
ifm Vision Assistant O3D3xx 3D sensor

10.2 Network
If necessary, the device’s network settings can be modified. If a new device is connected and the ifm
Vision Assistant automatically locates it, the standard network data have already been entered.
►► Click on [Network].
>> The network settings are displayed in the “Network” window.

►► Set the DHCP button to “On” in order to enable DHCP (default: “Off”).
►► Enter the network settings in the input fields.
Default settings:
●● IP address: 192.168.0.69
●● Subnet mask: 255.255.255.0
●● Gateway: 192.168.0.201
►► Click on to save the modifications.
>> The modifications are saved on the device.
>> The ifm Vision Assistant establishes a new connection to the device.

>> If an application is activated, the ifm Vision Assistant continues with the monitoring screen. If no
application is activated, the ifm Vision Assistant switches to the edit screen.

►► If the connection to the device is unsuccessful, search for the device using on the start screen,
or connect it manually.

132
 ifm Vision Assistant O3D3xx 3D sensor

10.3 Interfaces
If necessary, the process interface settings can be configured.
►► Click on [Interfaces].
>> The process interface settings are displayed in the “Interfaces” window:

UK

Depending on the interface, not all options may be available.

Options that are not available are greyed out.

►► Perform the desired settings.

Field Button Description
Process interface
Version X Version of the process interface protocol.
version
Editable field for the TCP/IP port in which the process interface data
TCP/IP port –
are available with a socket connection.
The hardware logic for the signals from the device’s digital outputs:
[PNP]
Output logic ●● PNP: switches positive potential to the output
[NPN]
●● NPN: switches earth to the output
[deactivated]
[static]
Application switching
[pulsed] Configures external application toggling through the digital inputs.
via inputs
[pulsed via trigger]
[pulsed via input 1]

External application switching is described in the Operating instructions.

►► Click on to save the modifications.

>> The modifications are saved on the device.

133
ifm Vision Assistant O3D3xx 3D sensor

Process interface wiring test

The pin assignment of the various plugs is not standardised. The wiring test allows the correct wiring of
the 8-pin plug to be displayed and tested.
►► Click on [Start] to begin simulation mode.
►► Click on [OUT 1] to toggle between “On” and “Off” for the signal to OUT 1.
►► Click on [Ready] to toggle between “On” and “Off” for the “Ready for the next trigger” output signal.
►► Click on [OUT 2] to toggle between “On” and “Off” for the signal to OUT 2.
►► If the inputs are used, test the input signals at Input 1 and Input 2.
►► Click on [Stop] to end simulation mode.
>> The outputs are controlled by the application again.

134
 ifm Vision Assistant O3D3xx 3D sensor

11 Device information

►► Click on .
>> An image of the device and its basic information is displayed.

UK

Field Description
Name of the device; for instance: “New sensor”.
Name
The name of the device can be edited (→ “10.1.1 Name and description”).
Hardware & firmware Hardware and firmware version of the device.
Status Current status of the device.
Uninterrupted device operating time.
Uptime
Time format: ##d (days) ##h (hours) ##min (minutes).
Device Details Displays detailed information about the device.

135
ifm Vision Assistant O3D3xx 3D sensor

12 Annex
12.1 Network settings

The details of the network settings in this document describe the procedure for PCs with the
Windows 7 operating system.
Changing the network settings on the PC requires administrator privileges.
The following ports must be open (adjust firewall settings, if necessary):
●● UDP: 3321
●● TCP/HTTP: 80 and 8080
●● TCP: 50010

►► Open [Network and Sharing Centre].

►► Click on the name of the local network under [Connections].

>> The “Local Area Connection Status” window for the local network opens.

136
 ifm Vision Assistant O3D3xx 3D sensor

UK

►► Click on [Properties].
>> The “Local Area Connection Properties” window for the local network opens.

►► Select [Internet Protocol Version 4 (TCP/IPv4)].

►► Click on [Properties].
>> The “Internet Protocol Version 4 (TCP/IPv4) Properties” window opens.

137
ifm Vision Assistant O3D3xx 3D sensor

►► Select the [Use the following IP address:] option.

►► Set the following default values:
●● IP address: 192.168.0.1
●● Subnet mask: 255.255.255.0
●● Standard gateway: 192.168.0.201
►► Click on [OK].

138
 ifm Vision Assistant O3D3xx 3D sensor

12.2 Glossary
Active applications
The application set to “active” on the device: This application runs when the device is operational.

Amplitude
Refers to the reflectivity of the object in the infrared range: The device represents the measurement result
in greyscale – the stronger the reflection, the lighter the shade of grey.

UK
Anchor function
The anchor function allows recognition of the position and alignment of the objects, for instance in the
completeness application. This can compensate for an object rotation of up to 40°.

Application switching
Application switching can be triggered through the process interface or the digital inputs.

Operating mode
Standard mode that is active when there is an active application on the device. The active application is
executed.

Parametrisation mode
Mode for configuring and setting the device and the applications: No application is executed.

Pixel
Individual data point in a 2D/3D image.

Process interface
Interface to external hardware: Data can be output or received through the process interface (e. g. from a
PLC).

139