-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathindex.html
More file actions
381 lines (341 loc) · 19.5 KB
/
index.html
File metadata and controls
381 lines (341 loc) · 19.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to the O3R documentation! — O3R documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=5800d392" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=d9f55abb"></script>
<script src="_static/js/versionwarning.js?v=d4224a34"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Getting started with the O3R" href="GettingStarted/index_getting_started.html" />
<!-- Google tag (gtag.js) -->
<!-- <script async src="https://www.googletagmanager.com/gtag/js?id=G-ZZ08KXKV1G"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-ZZ08KXKV1G');
</script> -->
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
O3R
</a>
<div class="version">
v1.21.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="GettingStarted/index_getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="Firmware/index.html">Firmware</a></li>
<li class="toctree-l1"><a class="reference internal" href="CompatibilityMatrix/compatibility_matrix.html">Compatibility Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="Technology/index_technology.html">Technology</a></li>
<li class="toctree-l1"><a class="reference internal" href="index_software_interfaces.html">Software Interfaces</a></li>
<li class="toctree-l1"><a class="reference internal" href="CalibrationRoutines/index_calibrations.html">Calibration Routines</a></li>
<li class="toctree-l1"><a class="reference internal" href="ODS/index_ods.html">ODS</a></li>
<li class="toctree-l1"><a class="reference internal" href="PDS/index_pds.html">PDS</a></li>
<li class="toctree-l1"><a class="reference internal" href="PLC/index_plc.html">PLC</a></li>
<li class="toctree-l1"><a class="reference internal" href="FAQ/FAQ.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="downloadable/index.html">History</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">O3R</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to the O3R documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-the-o3r-documentation">
<h1>Welcome to the O3R documentation!<a class="headerlink" href="#welcome-to-the-o3r-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
</div>
<p>This website contains all the documentation for the O3R platform. Find the datasheets and use case descriptions on <a class="reference external" href="https://www.ifm.com/us/en/us/robotics/cameras/o3r/o3r">ifm.com</a>.</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-1 sd-row-cols-lg-1 docutils">
<div class="sd-col sd-d-flex-column homepage-icons docutils">
<p><img alt="News icon" src="_images/ifm3d_landing_news.svg" />
A new firmware version is available for the O3R platform.
Find it here: <a class="reference external" href="https://www.ifm.com/de/en/product/OVP810#documents">FW 1.21.6</a></p>
</div>
</div>
</div>
<!-- ------------------------------------------------- -->
<!-- This is a title, but we put it as raw html as
a hack to avoid having it display in the left bar nav. -->
<h2> First time? </h2><p>Explore our unboxing and getting started guides to quickly get you up an running, and ready to develop your application.</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-row homepage-icons docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="Unboxing icon" class="sd-card-img-top" src="_images/ifm3d_landing_unboxing.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
O3R Unboxing</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Learn how to wire the O3R platform</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="GettingStarted/Unboxing/hw_unboxing.html"><span class="doc">Link to the hardware unboxing section</span></a></div>
</div>
<div class="sd-col sd-d-flex-row homepage-icons docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_ods.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Getting started with ODS</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Learn how to quickly setup the Obstacle Detection Solution</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="ODS/getting_started.html"><span class="doc">Link to the ODS getting started documentation</span></a></div>
</div>
</div>
</div>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-row homepage-icons docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_point-cloud.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Getting started with the O3R point cloud</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Learn about the point cloud</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="SoftwareInterfaces/iVA/first_steps_ifmVA.html"><span class="doc">Link to the first steps with the Vision Assistant</span></a></div>
</div>
<div class="sd-col sd-d-flex-row homepage-icons docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_pds.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Getting started with PDS</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Discover the Pick and Drop System (PDS)</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="PDS/index_pds.html"><span class="doc">Link to the PDS getting started documentation</span></a></div>
</div>
</div>
</div>
<!-- ------------------------------------------------- -->
<!-- This is a title, but we put it as raw html as
a hack to avoid having it display in the left bar nav. -->
<h2> Jump to: </h2><div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-1 sd-row-cols-lg-1 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-col sd-d-flex-row homepage-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_mounting.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Mounting</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Install the O3R platform on your machine</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="Technology/Hardware/Mounting/index_mounting.html"><span class="doc">Link to the mounting instructions</span></a></div>
</div>
<div class="sd-col sd-d-flex-row homepage-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_calibration.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Calibration</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Calibrate the position of the camera, with convenient methods in the field or in production</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="CalibrationRoutines/index_calibrations.html"><span class="doc">Link to the calibration instructions</span></a></div>
</div>
<div class="sd-col sd-d-flex-row homepage-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_power-requirements.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Power requirements</div>
</div>
<div class="sd-card-footer docutils">
<p class="sd-card-text">Properly power the system to ensure optimal performance</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="Technology/Hardware/Mounting/heat_dissipation_guidelines.html"><span class="doc">Link to the power requirements</span></a></div>
</div>
</div>
</div>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-1 sd-row-cols-lg-1 docutils">
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
<div class="sd-col sd-d-flex-row programming-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_python.svg" /><div class="sd-card-body docutils">
<p class="sd-card-text">Check out the ifm3dpy API and Python examples</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="https://api.ifm3d.com/stable/"><span>Link to the API documentation</span></a></div>
</div>
<div class="sd-col sd-d-flex-row programming-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_cpp.svg" /><div class="sd-card-body docutils">
<p class="sd-card-text">Check out the ifm3d API and C++ examples</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="https://api.ifm3d.com/stable/"><span>Link to the API documentation</span></a></div>
</div>
</div>
</div>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-row programming-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_ros.svg" /><div class="sd-card-body docutils">
<p class="sd-card-text"><code class="docutils literal notranslate"><span class="pre">ifm3d-ros</span></code> is a wrapper for using ifm’s 3D cameras with ROS</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="https://ros.ifm3d.com/"><span>Link to the ROS documentation</span></a></div>
</div>
<div class="sd-col sd-d-flex-row programming-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_ros2.svg" /><div class="sd-card-body docutils">
<p class="sd-card-text"><code class="docutils literal notranslate"><span class="pre">ifm3d-ros2</span></code> is a wrapper for using ifm’s 3D cameras with ROS2</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference external" href="https://ros2.ifm3d.com/"><span>Link to the ROS2 documentation</span></a></div>
</div>
</div>
</div>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-row programming-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/iVA-logo.svg" /><div class="sd-card-body docutils">
<p class="sd-card-text">Use the Vision Assistant for easy visualization and configuration of ifm’s 3D cameras!</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="SoftwareInterfaces/iVA/index_iVA.html"><span class="doc">Link to the ifmVisionAssistant documentation</span></a></div>
</div>
<div class="sd-col sd-d-flex-row programming-icons jump-to-cards docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_docker.svg" /><div class="sd-card-body docutils">
<p class="sd-card-text">Take advantage of Docker to deploy your applications on board the VPU.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="SoftwareInterfaces/Docker/index_docker.html"><span class="doc">Link to the Docker documentation</span></a></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- ------------------------------------------------- -->
<!-- This is a title, but we put it as raw html as
a hack to avoid having it display in the left bar nav. -->
<h2> Troubleshooting? </h2><p>Sometimes, things go wrong.
Explore our software troubleshooting guide, where you will find how to deal with specific diagnostic messages, or look through the point cloud artifacts to understand how to get the best 3D data for your application.</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-row homepage-icons docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_diagnostics.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Software diagnostic guide</div>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="SoftwareInterfaces/ifmDiagnostic/index_diagnostic.html"><span class="doc">Link to the software diagnostic documentation</span></a></div>
</div>
<div class="sd-col sd-d-flex-row homepage-icons docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
<img alt="" class="sd-card-img-top" src="_images/ifm3d_landing_point-cloud-analysis.svg" /><div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
Common point cloud artifacts</div>
<p class="sd-card-text">Coming soon…</p>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
</div>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="keywords" content="footer, address, phone, icons" />
<title>Footer With Address And Phones</title>
</head>
<body>
<footer class="footer-distributed">
<div class="footer-left">
<p class="footer-links">
<a href="index.html">Home</a>
·
<a href="http://www.o3r.ifm" target="_blank">Learn more</a>
·
<a href="/latest/_static/privacy-policy.html" target="_blank">Privacy Policy</a>
</p>
<p class="footer-company-name">ifm robotics © 2023</p>
</div>
<div class="footer-center">
<div>
<i class="fa fa-envelope"></i>
<p><a href="mailto:support.efector.object-ident@ifm.com">support.efector.object-ident@ifm.com</a></p>
</div>
</div>
<div class="footer-right">
<div class="footer-icons">
<a href="https://www.facebook.com/ifmefector" target="_blank"><i class="fa fa-facebook"></i></a>
<a href="https://twitter.com/ifm_USA" target="_blank"><i class="fa fa-twitter"></i></a>
<a href="https://www.linkedin.com/showcase/ifm-efector" target="_blank"><i class="fa fa-linkedin"></i></a>
<a href="https://github.com/ifm" target="_blank"><i class="fa fa-github"></i></a>
</div>
</div>
</footer>
</body>
</html>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>