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
|
<!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: pdu-json-rpc-api/idl/FirmwareUpdateStatus.idl Source File</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="dir_6f2e57e4ed4c9ccdca310d1229964312.html">pdu-json-rpc-api</a></li><li class="navelem"><a class="el" href="dir_8ea0db9e05c169824aafe6441489b6ed.html">idl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">FirmwareUpdateStatus.idl</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-License-Identifier: BSD-3-Clause */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2010 Raritan Inc. All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/**</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * %Firmware Management</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> module <a class="code" href="namespacefirmware.html">firmware</a> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> /**</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * %Firmware update status</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateStatus.html"> 14</a></span>  structure <a class="code" href="structfirmware_1_1UpdateStatus.html">UpdateStatus</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateStatus.html#aad51d6b9c76ccc8ee939830696720602"> 15</a></span>  <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1UpdateStatus.html#aad51d6b9c76ccc8ee939830696720602">state</a>; <span class="comment">///< Current state of firmware update: NONE, INIT, PREP, SIMULATE, UPDATE, SUCCESS or FAIL</span></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateStatus.html#a0995ed7a547ef7fed370c03c976dc876"> 16</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfirmware_1_1UpdateStatus.html#a0995ed7a547ef7fed370c03c976dc876">elapsed</a>; <span class="comment">///< Seconds since start of update, 0 if not available</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateStatus.html#ad89417452840f7eb3d8f1642086e48cf"> 17</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfirmware_1_1UpdateStatus.html#ad89417452840f7eb3d8f1642086e48cf">estimated</a>; <span class="comment">///< Estimated total time for update, 0 if not available</span></div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateStatus.html#a60c6eceecd76c6948fd08fffe7fd1f53"> 18</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1UpdateStatus.html#a60c6eceecd76c6948fd08fffe7fd1f53">error_message</a>; <span class="comment">///< Error message; empty if there was no error</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span> };</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> /**</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * %Firmware update status interface.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Unlike all other sysrpc methods this function is implemented by a</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * CGI script which is available even during a firmware update. The</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * URL for this interface is /cgi-bin/fwupdate_progress.cgi.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="interfacefirmware_1_1FirmwareUpdateStatus.html"> 28</a></span>  <span class="keyword">interface </span><a class="code" href="interfacefirmware_1_1FirmwareUpdateStatus.html">FirmwareUpdateStatus</a> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /**</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Returns the device's firmware update status.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @return Update status structure</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="structfirmware_1_1UpdateStatus.html">UpdateStatus</a> getStatus();</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  };</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> }</div><div class="ttc" id="structfirmware_1_1UpdateStatus_html_a60c6eceecd76c6948fd08fffe7fd1f53"><div class="ttname"><a href="structfirmware_1_1UpdateStatus.html#a60c6eceecd76c6948fd08fffe7fd1f53">firmware::UpdateStatus::error_message</a></div><div class="ttdeci">string error_message</div><div class="ttdoc">Error message; empty if there was no error. </div><div class="ttdef"><b>Definition:</b> FirmwareUpdateStatus.idl:18</div></div>
<div class="ttc" id="structfirmware_1_1UpdateStatus_html_ad89417452840f7eb3d8f1642086e48cf"><div class="ttname"><a href="structfirmware_1_1UpdateStatus.html#ad89417452840f7eb3d8f1642086e48cf">firmware::UpdateStatus::estimated</a></div><div class="ttdeci">int estimated</div><div class="ttdoc">Estimated total time for update, 0 if not available. </div><div class="ttdef"><b>Definition:</b> FirmwareUpdateStatus.idl:17</div></div>
<div class="ttc" id="structfirmware_1_1UpdateStatus_html_a0995ed7a547ef7fed370c03c976dc876"><div class="ttname"><a href="structfirmware_1_1UpdateStatus.html#a0995ed7a547ef7fed370c03c976dc876">firmware::UpdateStatus::elapsed</a></div><div class="ttdeci">int elapsed</div><div class="ttdoc">Seconds since start of update, 0 if not available. </div><div class="ttdef"><b>Definition:</b> FirmwareUpdateStatus.idl:16</div></div>
<div class="ttc" id="namespacefirmware_html"><div class="ttname"><a href="namespacefirmware.html">firmware</a></div><div class="ttdoc">Firmware Management </div><div class="ttdef"><b>Definition:</b> Firmware.idl:12</div></div>
<div class="ttc" id="structfirmware_1_1UpdateStatus_html"><div class="ttname"><a href="structfirmware_1_1UpdateStatus.html">firmware::UpdateStatus</a></div><div class="ttdoc">Firmware update status </div><div class="ttdef"><b>Definition:</b> FirmwareUpdateStatus.idl:14</div></div>
<div class="ttc" id="structfirmware_1_1UpdateStatus_html_aad51d6b9c76ccc8ee939830696720602"><div class="ttname"><a href="structfirmware_1_1UpdateStatus.html#aad51d6b9c76ccc8ee939830696720602">firmware::UpdateStatus::state</a></div><div class="ttdeci">string state</div><div class="ttdoc">Current state of firmware update: NONE, INIT, PREP, SIMULATE, UPDATE, SUCCESS or FAIL. </div><div class="ttdef"><b>Definition:</b> FirmwareUpdateStatus.idl:15</div></div>
<div class="ttc" id="interfacefirmware_1_1FirmwareUpdateStatus_html"><div class="ttname"><a href="interfacefirmware_1_1FirmwareUpdateStatus.html">firmware::FirmwareUpdateStatus</a></div><div class="ttdoc">Firmware update status interface. </div><div class="ttdef"><b>Definition:</b> FirmwareUpdateStatus.idl:28</div></div>
</div><!-- fragment --></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>
|