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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: firmware::Firmware_2_0_1 Interface 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="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" />
</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">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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');
/* @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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefirmware.html">firmware</a></li><li class="navelem"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html">Firmware_2_0_1</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="interfacefirmware_1_1Firmware__2__0__1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">firmware::Firmware_2_0_1 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Firmware management methods
<a href="interfacefirmware_1_1Firmware__2__0__1.html#details">More...</a></p>
<p><code>import"<a class="el" href="Firmware_8idl_source.html">Firmware.idl</a>";</code></p>
<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:a5849681e604f196dd36faca4d6d843d1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#a5849681e604f196dd36faca4d6d843d1">reboot</a> ()</td></tr>
<tr class="memdesc:a5849681e604f196dd36faca4d6d843d1"><td class="mdescLeft"> </td><td class="mdescRight">Reboot the device. <a href="#a5849681e604f196dd36faca4d6d843d1">More...</a><br /></td></tr>
<tr class="separator:a5849681e604f196dd36faca4d6d843d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefcf984f7189ece2e5de81e1b8f3bd23"><td class="memItemLeft" align="right" valign="top"><a id="aefcf984f7189ece2e5de81e1b8f3bd23"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#aefcf984f7189ece2e5de81e1b8f3bd23">factoryReset</a> ()</td></tr>
<tr class="memdesc:aefcf984f7189ece2e5de81e1b8f3bd23"><td class="mdescLeft"> </td><td class="mdescRight">Reset the device configuration to factory defaults. <br /></td></tr>
<tr class="separator:aefcf984f7189ece2e5de81e1b8f3bd23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6745704adc1634227deaa7bae4e252bc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#a6745704adc1634227deaa7bae4e252bc">hardFactoryReset</a> ()</td></tr>
<tr class="memdesc:a6745704adc1634227deaa7bae4e252bc"><td class="mdescLeft"> </td><td class="mdescRight">Reset all device data to factory defaults. <a href="#a6745704adc1634227deaa7bae4e252bc">More...</a><br /></td></tr>
<tr class="separator:a6745704adc1634227deaa7bae4e252bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39a14ae66e4da01619eded63e365760c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#a39a14ae66e4da01619eded63e365760c">getVersion</a> ()</td></tr>
<tr class="memdesc:a39a14ae66e4da01619eded63e365760c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the currently installed firmware version. <a href="#a39a14ae66e4da01619eded63e365760c">More...</a><br /></td></tr>
<tr class="separator:a39a14ae66e4da01619eded63e365760c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a317c8643a16fbaa7f16119919b5ff744"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structfirmware_1_1UpdateHistoryEntry.html">UpdateHistoryEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#a317c8643a16fbaa7f16119919b5ff744">getUpdateHistory</a> ()</td></tr>
<tr class="memdesc:a317c8643a16fbaa7f16119919b5ff744"><td class="mdescLeft"> </td><td class="mdescRight">Fetch the firmware update history. <a href="#a317c8643a16fbaa7f16119919b5ff744">More...</a><br /></td></tr>
<tr class="separator:a317c8643a16fbaa7f16119919b5ff744"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac2a7770a40aac98ea81b57829b31303"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfirmware_1_1ImageStatus.html">ImageStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#aac2a7770a40aac98ea81b57829b31303">getImageStatus</a> ()</td></tr>
<tr class="memdesc:aac2a7770a40aac98ea81b57829b31303"><td class="mdescLeft"> </td><td class="mdescRight">Get the current firmware image upload/download status. <a href="#aac2a7770a40aac98ea81b57829b31303">More...</a><br /></td></tr>
<tr class="separator:aac2a7770a40aac98ea81b57829b31303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ed304fa8f88da74c54ab0453481aa56"><td class="memItemLeft" align="right" valign="top"><a id="a0ed304fa8f88da74c54ab0453481aa56"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#a0ed304fa8f88da74c54ab0453481aa56">discardImage</a> ()</td></tr>
<tr class="memdesc:a0ed304fa8f88da74c54ab0453481aa56"><td class="mdescLeft"> </td><td class="mdescRight">Discard the currently uploaded firmware image, cancel the update. <br /></td></tr>
<tr class="separator:a0ed304fa8f88da74c54ab0453481aa56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5a834bc4141d4db60a8ed734a24b14f"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#ae5a834bc4141d4db60a8ed734a24b14f">getImageInfo</a> (out <a class="el" href="structfirmware_1_1ImageInfo__1__0__1.html">ImageInfo_1_0_1</a> info)</td></tr>
<tr class="memdesc:ae5a834bc4141d4db60a8ed734a24b14f"><td class="mdescLeft"> </td><td class="mdescRight">Return information about a currently uploaded firmware image. <a href="#ae5a834bc4141d4db60a8ed734a24b14f">More...</a><br /></td></tr>
<tr class="separator:ae5a834bc4141d4db60a8ed734a24b14f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9be096b97f5d743c87e705ed3ed31a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacefirmware_1_1Firmware__2__0__1.html#ad9be096b97f5d743c87e705ed3ed31a3">startUpdate</a> (in vector< <a class="el" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6e">UpdateFlags</a> > flags)</td></tr>
<tr class="memdesc:ad9be096b97f5d743c87e705ed3ed31a3"><td class="mdescLeft"> </td><td class="mdescRight">Launch the firmware update process. <a href="#ad9be096b97f5d743c87e705ed3ed31a3">More...</a><br /></td></tr>
<tr class="separator:ad9be096b97f5d743c87e705ed3ed31a3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Firmware management methods </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae5a834bc4141d4db60a8ed734a24b14f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5a834bc4141d4db60a8ed734a24b14f">◆ </a></span>getImageInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean firmware::Firmware_2_0_1::getImageInfo </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="structfirmware_1_1ImageInfo__1__0__1.html">ImageInfo_1_0_1</a> </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return information about a currently uploaded firmware image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>Firmware image information</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a firmware image is uploaded, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a id="aac2a7770a40aac98ea81b57829b31303"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac2a7770a40aac98ea81b57829b31303">◆ </a></span>getImageStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structfirmware_1_1ImageStatus.html">ImageStatus</a> firmware::Firmware_2_0_1::getImageStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current firmware image upload/download status. </p>
<dl class="section return"><dt>Returns</dt><dd>Image status structure. </dd></dl>
</div>
</div>
<a id="a317c8643a16fbaa7f16119919b5ff744"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a317c8643a16fbaa7f16119919b5ff744">◆ </a></span>getUpdateHistory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structfirmware_1_1UpdateHistoryEntry.html">UpdateHistoryEntry</a>> firmware::Firmware_2_0_1::getUpdateHistory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fetch the firmware update history. </p>
<dl class="section return"><dt>Returns</dt><dd>Vector of firmware update history entries </dd></dl>
</div>
</div>
<a id="a39a14ae66e4da01619eded63e365760c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39a14ae66e4da01619eded63e365760c">◆ </a></span>getVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string firmware::Firmware_2_0_1::getVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the currently installed firmware version. </p>
<dl class="section return"><dt>Returns</dt><dd>Firmware version </dd></dl>
</div>
</div>
<a id="a6745704adc1634227deaa7bae4e252bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6745704adc1634227deaa7bae4e252bc">◆ </a></span>hardFactoryReset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int firmware::Firmware_2_0_1::hardFactoryReset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset all device data to factory defaults. </p>
<p>This includes energy counters, firmware update history and reliability data.</p>
<dl class="section note"><dt>Note</dt><dd>This command is only available during manufacturing!</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if not in production mode </dd></dl>
</div>
</div>
<a id="a5849681e604f196dd36faca4d6d843d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5849681e604f196dd36faca4d6d843d1">◆ </a></span>reboot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void firmware::Firmware_2_0_1::reboot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reboot the device. </p>
<p>This function will fail if a firmware update is in progress. </p>
</div>
</div>
<a id="ad9be096b97f5d743c87e705ed3ed31a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9be096b97f5d743c87e705ed3ed31a3">◆ </a></span>startUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void firmware::Firmware_2_0_1::startUpdate </td>
<td>(</td>
<td class="paramtype">in vector< <a class="el" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6e">UpdateFlags</a> > </td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Launch the firmware update process. </p>
<p>The device will stop handling RPC requests shortly after this method has been successfully called. The client should poll the fwupdate_progress.cgi page to monitor the update progress.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>List of firmware update flags; may be empty </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="Firmware_8idl_source.html">Firmware.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
