-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassifm3d_1_1SWUpdater.html
368 lines (352 loc) · 19.8 KB
/
classifm3d_1_1SWUpdater.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ifm3d: ifm3d::SWUpdater Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ifm3d
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classifm3d_1_1SWUpdater.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classifm3d_1_1SWUpdater-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ifm3d::SWUpdater Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a156fa7c35d6b264efecb017c495f4110"><td class="memItemLeft" align="right" valign="top"><a id="a156fa7c35d6b264efecb017c495f4110"></a>
using </td><td class="memItemRight" valign="bottom"><b>Ptr</b> = std::shared_ptr< <a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> ></td></tr>
<tr class="separator:a156fa7c35d6b264efecb017c495f4110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab90463e11ba0306bc62e087ed00260b1"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#ab90463e11ba0306bc62e087ed00260b1">FlashStatusCb</a> = std::function< void(float, const std::string &)></td></tr>
<tr class="separator:ab90463e11ba0306bc62e087ed00260b1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a930023e5e858f0680888d2b20f267330"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#a930023e5e858f0680888d2b20f267330">SWUpdater</a> (ifm3d::Device::Ptr cam, const <a class="el" href="classifm3d_1_1SWUpdater.html#ab90463e11ba0306bc62e087ed00260b1">ifm3d::SWUpdater::FlashStatusCb</a> &cb={}, const std::uint16_t swupdate_recovery_port=ifm3d::SWUPDATER_RECOVERY_PORT)</td></tr>
<tr class="separator:a930023e5e858f0680888d2b20f267330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad894014e430bed353d30d8e9310ca050"><td class="memItemLeft" align="right" valign="top"><a id="ad894014e430bed353d30d8e9310ca050"></a>
 </td><td class="memItemRight" valign="bottom"><b>SWUpdater</b> (<a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> &&)=delete</td></tr>
<tr class="separator:ad894014e430bed353d30d8e9310ca050"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82a7f2eef394a54bcb397577b0605f8a"><td class="memItemLeft" align="right" valign="top"><a id="a82a7f2eef394a54bcb397577b0605f8a"></a>
<a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> &&)=delete</td></tr>
<tr class="separator:a82a7f2eef394a54bcb397577b0605f8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6dc84dea1396c291aaa8132ec111903"><td class="memItemLeft" align="right" valign="top"><a id="ab6dc84dea1396c291aaa8132ec111903"></a>
 </td><td class="memItemRight" valign="bottom"><b>SWUpdater</b> (<a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> &)=delete</td></tr>
<tr class="separator:ab6dc84dea1396c291aaa8132ec111903"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab78c2c926b27d73cc93536907cbdafb1"><td class="memItemLeft" align="right" valign="top"><a id="ab78c2c926b27d73cc93536907cbdafb1"></a>
<a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a> &)=delete</td></tr>
<tr class="separator:ab78c2c926b27d73cc93536907cbdafb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f56ac0283802c2c1ec9c94fa39d3437"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#a1f56ac0283802c2c1ec9c94fa39d3437">RebootToRecovery</a> ()</td></tr>
<tr class="separator:a1f56ac0283802c2c1ec9c94fa39d3437"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15b7cd28dd1fe49fb1f830862e1a555c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#a15b7cd28dd1fe49fb1f830862e1a555c">WaitForRecovery</a> (long timeout_millis=0)</td></tr>
<tr class="separator:a15b7cd28dd1fe49fb1f830862e1a555c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ed7d927b9ff35a6808394345bdced8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#a5ed7d927b9ff35a6808394345bdced8e">RebootToProductive</a> ()</td></tr>
<tr class="separator:a5ed7d927b9ff35a6808394345bdced8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17e1b150eac6b995787420ed7efe9f4a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#a17e1b150eac6b995787420ed7efe9f4a">WaitForProductive</a> (long timeout_millis=0)</td></tr>
<tr class="separator:a17e1b150eac6b995787420ed7efe9f4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e61c6b57890bfc62720e4176eef6eba"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classifm3d_1_1SWUpdater.html#a5e61c6b57890bfc62720e4176eef6eba">FlashFirmware</a> (const std::string &swu_file, long timeout_millis=0)</td></tr>
<tr class="separator:a5e61c6b57890bfc62720e4176eef6eba"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab3db14bb5fb1ea2d54b98f46072be670"><td class="memItemLeft" align="right" valign="top"><a id="ab3db14bb5fb1ea2d54b98f46072be670"></a>
class IFM3D_SWUPDATER_LOCAL </td><td class="memItemRight" valign="bottom"><b>Impl</b></td></tr>
<tr class="separator:ab3db14bb5fb1ea2d54b98f46072be670"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab90463e11ba0306bc62e087ed00260b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab90463e11ba0306bc62e087ed00260b1">◆ </a></span>FlashStatusCb</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classifm3d_1_1SWUpdater.html#ab90463e11ba0306bc62e087ed00260b1">ifm3d::SWUpdater::FlashStatusCb</a> = std::function<void(float, const std::string&)></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for user callback to receive status information about firmware flashing.</p>
<p>The first parameter is a percentage (0.0-1.0) indicating the status of uploading the file to the device.</p>
<p>The second parameter is a status message from the device during install. </p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a930023e5e858f0680888d2b20f267330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a930023e5e858f0680888d2b20f267330">◆ </a></span>SWUpdater()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ifm3d::SWUpdater::SWUpdater </td>
<td>(</td>
<td class="paramtype">ifm3d::Device::Ptr </td>
<td class="paramname"><em>cam</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classifm3d_1_1SWUpdater.html#ab90463e11ba0306bc62e087ed00260b1">ifm3d::SWUpdater::FlashStatusCb</a> & </td>
<td class="paramname"><em>cb</em> = <code>{}</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::uint16_t </td>
<td class="paramname"><em>swupdate_recovery_port</em> = <code>ifm3d::SWUPDATER_RECOVERY_PORT</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ctor</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cam</td><td><a class="el" href="classifm3d_1_1Device.html">Device</a> object to manipulate</td></tr>
<tr><td class="paramname">cb</td><td>Optional user-defined callback to handle status updates</td></tr>
<tr><td class="paramname">swupdate_recovery_port</td><td>swupate recovery port for the device </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5e61c6b57890bfc62720e4176eef6eba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e61c6b57890bfc62720e4176eef6eba">◆ </a></span>FlashFirmware()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ifm3d::SWUpdater::FlashFirmware </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>swu_file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeout_millis</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uploads a firmware image to the device's recovery system. Assumes device has already been rebooted to recovery mode.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">swu_file</td><td>The firmware image file to flash to the device.</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">timeout_millis</td><td>Timeout in millis to wait for the firmware upload to complete. If <code>timeout_millis</code> is set to 0, this function will block indefinitely.</td></tr>
</table>
</dd>
</dl>
<p>NOTE: Firmware uploading and flashing typically takes several minutes. The blocking version of the API (timeout_millis = 0) is recommended in most cases. If a timeout is truly required, it is recommended to use a value of at least 300000 (5 minutes).</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ifm3d::error_t</td><td>on error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5ed7d927b9ff35a6808394345bdced8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ed7d927b9ff35a6808394345bdced8e">◆ </a></span>RebootToProductive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ifm3d::SWUpdater::RebootToProductive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reboots the device from recovery to productive. The function returns immediately, but the reboot process takes some time. The function <code>WaitForProductive</code> may be used to poll for completion.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ifm3d::error_t</td><td>on error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1f56ac0283802c2c1ec9c94fa39d3437"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f56ac0283802c2c1ec9c94fa39d3437">◆ </a></span>RebootToRecovery()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ifm3d::SWUpdater::RebootToRecovery </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reboots the device from productive to recovery. The function returns immediately, but the reboot process takes some time. The function <code>WaitForRecovery</code> may be used to poll for completion.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ifm3d::error_t</td><td>on error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17e1b150eac6b995787420ed7efe9f4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e1b150eac6b995787420ed7efe9f4a">◆ </a></span>WaitForProductive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ifm3d::SWUpdater::WaitForProductive </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeout_millis</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Polls on status of the device, waiting for it to present in productive mode. Should be used following a call to <a class="el" href="classifm3d_1_1SWUpdater.html#a5ed7d927b9ff35a6808394345bdced8e">RebootToProductive()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeout_millis</td><td>Timeout in millis to wait for the device to become available. If <code>timeout_millis</code> is set to 0, this function will block indefinitely. If <code>timeout_millis</code> is set to -1, this function will check once and return immediately.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the device became available w/in <code>timeout_millis</code>, false otherwise.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ifm3d::error_t</td><td>on error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a15b7cd28dd1fe49fb1f830862e1a555c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15b7cd28dd1fe49fb1f830862e1a555c">◆ </a></span>WaitForRecovery()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ifm3d::SWUpdater::WaitForRecovery </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>timeout_millis</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Polls on status of the device, waiting for it to present in recovery mode. Should be used following a call to <a class="el" href="classifm3d_1_1SWUpdater.html#a1f56ac0283802c2c1ec9c94fa39d3437">RebootToRecovery()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeout_millis</td><td>Timeout in millis to wait for the recovery system to become available. If <code>timeout_millis</code> is set to 0, this function will block indefinitely. If <code>timeout_millis</code> is set to -1, this function will check once and return immediately.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the recovery system became available w/in <code>timeout_millis</code>, false otherwise.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ifm3d::error_t</td><td>on error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/host/dev/ifm3d/modules/swupdater/include/ifm3d/swupdater/<a class="el" href="swupdater_2swupdater_8h_source.html">swupdater.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>ifm3d</b></li><li class="navelem"><a class="el" href="classifm3d_1_1SWUpdater.html">SWUpdater</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>