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
|
<!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/Firmware.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">Firmware.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 2009 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> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <UserEvent.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <Event.idl></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> <span class="comment">/**</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * %Firmware Management</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"><a class="line" href="namespacefirmware.html"> 12</a></span> module <a class="code" href="namespacefirmware.html">firmware</a> {</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"> 14</span> <span class="comment"> /**</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * %Firmware update history status</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60"> 17</a></span>  enumeration <a class="code" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60">UpdateHistoryStatus</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60af21cc0ea719057b4c766bf4cc8843e5a"> 18</a></span>  <a class="code" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60af21cc0ea719057b4c766bf4cc8843e5a">SUCCESSFUL</a>, <span class="comment">///< The update was successfully completed</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60a108af1846822fd089c3361170aefad16"> 19</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60a108af1846822fd089c3361170aefad16">FAILED</a>, <span class="comment">///< The update failed</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60a2a5252731c34e06c75a8b50e249df2b0"> 20</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60a2a5252731c34e06c75a8b50e249df2b0">INCOMPLETE</a> <span class="comment">///< The update was not completed</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"></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"> * %Firmware update history entry</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * TODO: implement CR# 45668 on next interface change </span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * add comment field based on firmware tag "char tag[64];"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * to improve firmware update history entries without rootfs images</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> */</span></div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateHistoryEntry.html"> 29</a></span>  structure <a class="code" href="structfirmware_1_1UpdateHistoryEntry.html">UpdateHistoryEntry</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateHistoryEntry.html#ace4a48b6565ab257dcd443132bf91c16"> 30</a></span>  time <a class="code" href="structfirmware_1_1UpdateHistoryEntry.html#ace4a48b6565ab257dcd443132bf91c16">timestamp</a>; <span class="comment">///< Timestamp when the update was started</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateHistoryEntry.html#a25e5b0296c75a49d29c37333f9eefd3a"> 31</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1UpdateHistoryEntry.html#a25e5b0296c75a49d29c37333f9eefd3a">oldVersion</a>; <span class="comment">///< Previous firmware version</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateHistoryEntry.html#ac151e20096a6852f51a3f126892ff831"> 32</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1UpdateHistoryEntry.html#ac151e20096a6852f51a3f126892ff831">imageVersion</a>; <span class="comment">///< Firmware version of update image</span></div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateHistoryEntry.html#a773d06b31a06f7de050c64256eb6eb70"> 33</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1UpdateHistoryEntry.html#a773d06b31a06f7de050c64256eb6eb70">imageMD5</a>; <span class="comment">///< MD5 hash of update image</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structfirmware_1_1UpdateHistoryEntry.html#aca48213ae3e950a2daae07e2202d03ea"> 34</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60">UpdateHistoryStatus</a> <a class="code" href="structfirmware_1_1UpdateHistoryEntry.html#aca48213ae3e950a2daae07e2202d03ea">status</a>; <span class="comment">///< Update status</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span> };</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /**</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * Image upload/download state</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4"> 40</a></span>  enumeration <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4">ImageState</a> {</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4aea7f972406e3c016a509ed943d235ee1"> 41</a></span>  <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4aea7f972406e3c016a509ed943d235ee1">NONE</a>, <span class="comment">///< No firmware image has been uploaded/downloaded</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4a634fa215fbf4a85f0780c1c9521129e3"> 42</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4a634fa215fbf4a85f0780c1c9521129e3">UPLOADING</a>, <span class="comment">///< A firmware image is currently being uploaded</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4aa3afe3a704fb5714dd82092447e03877"> 43</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4aa3afe3a704fb5714dd82092447e03877">UPLOAD_FAILED</a>, <span class="comment">///< There was a problem uploading an image to the device</span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4ac0ae7272f66b513cf348242b01b3203e"> 44</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4ac0ae7272f66b513cf348242b01b3203e">DOWNLOADING</a>, <span class="comment">///< The device is downloading a firmware image from a URL</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4ac47ca7fe999e010fa587a6c6af5db503"> 45</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4ac47ca7fe999e010fa587a6c6af5db503">DOWNLOAD_FAILED</a>, <span class="comment">///< There was a problem downloading the image from a URL</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4a6ef1ce4531f0f3d72db4a22b2b5293e6"> 46</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4a6ef1ce4531f0f3d72db4a22b2b5293e6">COMPLETE</a> <span class="comment">///< A complete image has been successfully uploaded/downloaded</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> };</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /**</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * Image upload/download status</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageStatus.html"> 52</a></span>  structure <a class="code" href="structfirmware_1_1ImageStatus.html">ImageStatus</a> {</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageStatus.html#a9ddd594e3abcbca26df8ae4164b68322"> 53</a></span>  <a class="code" href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4">ImageState</a> <a class="code" href="structfirmware_1_1ImageStatus.html#a9ddd594e3abcbca26df8ae4164b68322">state</a>; <span class="comment">///< Image upload/download state</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageStatus.html#a5fa1a343944043ac081b54fbd0137a08"> 54</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageStatus.html#a5fa1a343944043ac081b54fbd0137a08">error_message</a>; <span class="comment">///< Error message; empty if there was no error</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageStatus.html#a9e8be1cc2a648a1ef2d606bca9f9f333"> 55</a></span> <span class="comment"></span> time <a class="code" href="structfirmware_1_1ImageStatus.html#a9e8be1cc2a648a1ef2d606bca9f9f333">time_started</a>; <span class="comment">///< Timestamp of the last state change (if available)</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageStatus.html#aff0b4046e60990ca6b9f18b141ea8355"> 56</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfirmware_1_1ImageStatus.html#aff0b4046e60990ca6b9f18b141ea8355">size_total</a>; <span class="comment">///< Total size of the image (if available)</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageStatus.html#a088e0ac5ca358a357184e19533cecafa"> 57</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfirmware_1_1ImageStatus.html#a088e0ac5ca358a357184e19533cecafa">size_done</a>; <span class="comment">///< Progress of the running upload or download (if available)</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> };</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /**</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * %Firmware image information</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html"> 63</a></span>  structure <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html">ImageInfo_1_0_1</a> {</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#aafdb08329af3e462e432e590fe2bf3f8"> 64</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#aafdb08329af3e462e432e590fe2bf3f8">valid</a>; <span class="comment">///< The file is a valid firmware image</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a161d229059137675419588c8a2b8a25a"> 66</a></span>  <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a161d229059137675419588c8a2b8a25a">version</a>; <span class="comment">///< %Firmware image version</span></div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a26aec4885247e215e4e5ec45d807161e"> 67</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a26aec4885247e215e4e5ec45d807161e">min_required_version</a>; <span class="comment">///< Minimum running firmware version for image</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#ad1c90af03eabc6a8a8968586fd703e33"> 68</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#ad1c90af03eabc6a8a8968586fd703e33">min_downgrade_version</a>; <span class="comment">///< Minimum image version for running firmware</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a6b152656cbadc7fdff3cafeb0f66b316"> 70</a></span>  <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a6b152656cbadc7fdff3cafeb0f66b316">product</a>; <span class="comment">///< Product name</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#aaab2cdf0a38e3f3492d46053adecc874"> 71</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#aaab2cdf0a38e3f3492d46053adecc874">platform</a>; <span class="comment">///< Platform name</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#ab173bddc0bad12cd1036e9e23489832b"> 72</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#ab173bddc0bad12cd1036e9e23489832b">oem</a>; <span class="comment">///< OEM name</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a128baa48c49440d1d5d45fab28fe9cf7"> 73</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a128baa48c49440d1d5d45fab28fe9cf7">hwid_whitelist</a>; <span class="comment">///< Hardware ID whitelist</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#aacc580a002fab81a9a70b4491f59e588"> 74</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#aacc580a002fab81a9a70b4491f59e588">hwid_blacklist</a>; <span class="comment">///< Hardware ID blacklist</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a6a516aa0c773c8900776e638d66daeb8"> 76</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a6a516aa0c773c8900776e638d66daeb8">compatible</a>; <span class="comment">///< \c true if the image is compatible with this device</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a3f92e6f56a627db87ae15dff8585302c"> 78</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a3f92e6f56a627db87ae15dff8585302c">signature_present</a>; <span class="comment">///< \c true if the image is signed</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a5fae4ba282699965bca43321f63caf20"> 79</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a5fae4ba282699965bca43321f63caf20">signed_by</a>; <span class="comment">///< Signature issuer</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#ad2eb0ebb39ce9c1ec7b82da3e24249c0"> 80</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#ad2eb0ebb39ce9c1ec7b82da3e24249c0">signature_good</a>; <span class="comment">///< \c true if the signature is valid</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#a4b61d1b0f577cb1fd596c11e13499885"> 81</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#a4b61d1b0f577cb1fd596c11e13499885">certified_by</a>; <span class="comment">///< Key certificate issuer</span></div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#aeb0c9dade2639b1f26d32d530d6179f2"> 82</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#aeb0c9dade2639b1f26d32d530d6179f2">certificate_good</a>; <span class="comment">///< \c true if the key certificate is valid</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#af49c7267ff9d63b5260295662207bcc5"> 84</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#af49c7267ff9d63b5260295662207bcc5">model_list_present</a>; <span class="comment">///< \c true if the image includes a supported models list</span></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structfirmware_1_1ImageInfo__1__0__1.html#ab3906d2758f7237a68851872c4634a23"> 85</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html#ab3906d2758f7237a68851872c4634a23">model_supported</a>; <span class="comment">///< \c true if the model is found on the support list</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span> };</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /**</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * Flags for startUpdate() method</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6e"> 91</a></span>  enumeration <a class="code" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6e">UpdateFlags</a> {</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6ea31e008cef3716fa2d6b74c8c9c29d533"> 92</a></span>  <a class="code" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6ea31e008cef3716fa2d6b74c8c9c29d533">CROSS_OEM</a>, <span class="comment">///< Ignore version, product and OEM constraints</span></div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6eaaabea5ce850d0af7639bb43c5bbfa302"> 93</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6eaaabea5ce850d0af7639bb43c5bbfa302">CROSS_HW</a>, <span class="comment">///< Ignore hardware constraints</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6ea4dd347cb194b55ad4eed0414a943ba15"> 94</a></span> <span class="comment"></span> <a class="code" href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6ea4dd347cb194b55ad4eed0414a943ba15">ALLOW_UNTRUSTED</a> <span class="comment">///< Allow untrusted firmwares</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> };</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /** Event: System startup finished */</span></div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a7a703582850d33c579a159c9121cf683"> 98</a></span>  valueobject <a class="code" href="namespacefirmware.html#a7a703582850d33c579a159c9121cf683">SystemStartupEvent</a> extends <a class="code" href="namespaceidl.html">idl</a>.Event {};<span class="comment"></span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /** Event: System shutdown started */</span></div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="namespacefirmware.html#ad96da3579d71d5884f3db1f1c8716f4d"> 100</a></span>  valueobject <a class="code" href="namespacefirmware.html#ad96da3579d71d5884f3db1f1c8716f4d">SystemShutdownEvent</a> extends <span class="keyword">event</span>.UserEvent {};</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /** Event: Firmware validation failed */</span></div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a59c6107e7336cd09ab172861cbf29f61"> 103</a></span>  valueobject <a class="code" href="namespacefirmware.html#a59c6107e7336cd09ab172861cbf29f61">FirmwareValidationFailedEvent</a> extends <span class="keyword">event</span>.UserEvent {};</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /** Event: Firmware update base event */</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  valueobject FirmwareUpdateEvent extends <span class="keyword">event</span>.UserEvent {</div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="namespacefirmware.html#aedbec85a0dd31de0a18a199dba25b601"> 107</a></span>  <span class="keywordtype">string</span> oldVersion; <span class="comment">///< Firmware version the device is being upgraded from</span></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a8382659c054865f764491b39adfa4cfc"> 108</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="namespacefirmware.html#a8382659c054865f764491b39adfa4cfc">newVersion</a>; <span class="comment">///< Firmware version the device is being upgraded to</span></div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a2d0c24da25d12880d60ebd363b7f88fb"> 109</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /** Event: Firmware update started */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  valueobject FirmwareUpdateStartedEvent extends FirmwareUpdateEvent {};<span class="comment"></span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /** Event: Firmware updated successfully */</span></div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="namespacefirmware.html#ad04a30dbfc42871c5be91bb95ff68da5"> 114</a></span>  valueobject <a class="code" href="namespacefirmware.html#ad04a30dbfc42871c5be91bb95ff68da5">FirmwareUpdateCompletedEvent</a> extends <a class="code" href="namespacefirmware.html#aedbec85a0dd31de0a18a199dba25b601">FirmwareUpdateEvent</a> {};<span class="comment"></span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> /** Event: Firmware update failed */</span></div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="namespacefirmware.html#a84624d4c530edeec36d68eb7a986b2fd"> 116</a></span>  valueobject <a class="code" href="namespacefirmware.html#a84624d4c530edeec36d68eb7a986b2fd">FirmwareUpdateFailedEvent</a> extends <a class="code" href="namespacefirmware.html#aedbec85a0dd31de0a18a199dba25b601">FirmwareUpdateEvent</a> {};</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> /**</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * %Firmware management methods</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> */</span></div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="interfacefirmware_1_1Firmware__2__0__1.html"> 121</a></span>  <span class="keyword">interface </span><a class="code" href="interfacefirmware_1_1Firmware__2__0__1.html">Firmware_2_0_1</a> {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /**</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * Reboot the device.</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> *</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * This function will fail if a firmware update is in progress.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">void</span> reboot();</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /**</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * Reset the device configuration to factory defaults.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> */</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">void</span> factoryReset();</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> /**</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * Reset all device data to factory defaults. This includes energy</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * counters, firmware update history and reliability data.</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> *</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @note This command is only available during manufacturing!</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> *</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @return 1 if not in production mode</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> */</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">int</span> hardFactoryReset();</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /**</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * Returns the currently installed firmware version.</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> *</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @return %Firmware version</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> */</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordtype">string</span> getVersion();</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"></span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> /**</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * Fetch the firmware update history.</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @return Vector of firmware update history entries</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> */</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  vector<UpdateHistoryEntry> getUpdateHistory();</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"></span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> /**</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * Get the current firmware image upload/download status.</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> *</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @return Image status structure.</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> */</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <a class="code" href="structfirmware_1_1ImageStatus.html">ImageStatus</a> getImageStatus();</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"></span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> /**</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * Discard the currently uploaded firmware image, cancel the update.</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> */</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">void</span> discardImage();</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> /**</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * Return information about a currently uploaded firmware image.</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> *</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param info %Firmware image information</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> *</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @return \c true if a firmware image is uploaded, \c false otherwise.</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> */</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">boolean</span> getImageInfo(out <a class="code" href="structfirmware_1_1ImageInfo__1__0__1.html">ImageInfo_1_0_1</a> info);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"></span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> /**</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * Launch the firmware update process. The device will stop handling</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * RPC requests shortly after this method has been successfully called.</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * The client should poll the fwupdate_progress.cgi page to monitor the</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * update progress.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> *</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @param flags List of firmware update flags; may be empty</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> */</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordtype">void</span> startUpdate(in vector<UpdateFlags> flags);</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  };</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> }</div><div class="ttc" id="namespacefirmware_html_a12efcd6deb737f180d15fcf05fc3bd6ea4dd347cb194b55ad4eed0414a943ba15"><div class="ttname"><a href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6ea4dd347cb194b55ad4eed0414a943ba15">firmware::ALLOW_UNTRUSTED</a></div><div class="ttdoc">Allow untrusted firmwares. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:94</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_aaab2cdf0a38e3f3492d46053adecc874"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#aaab2cdf0a38e3f3492d46053adecc874">firmware::ImageInfo_1_0_1::platform</a></div><div class="ttdeci">string platform</div><div class="ttdoc">Platform name. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:71</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a161d229059137675419588c8a2b8a25a"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a161d229059137675419588c8a2b8a25a">firmware::ImageInfo_1_0_1::version</a></div><div class="ttdeci">string version</div><div class="ttdoc">Firmware image version </div><div class="ttdef"><b>Definition:</b> Firmware.idl:66</div></div>
<div class="ttc" id="structfirmware_1_1UpdateHistoryEntry_html_a773d06b31a06f7de050c64256eb6eb70"><div class="ttname"><a href="structfirmware_1_1UpdateHistoryEntry.html#a773d06b31a06f7de050c64256eb6eb70">firmware::UpdateHistoryEntry::imageMD5</a></div><div class="ttdeci">string imageMD5</div><div class="ttdoc">MD5 hash of update image. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:33</div></div>
<div class="ttc" id="structfirmware_1_1ImageStatus_html_a5fa1a343944043ac081b54fbd0137a08"><div class="ttname"><a href="structfirmware_1_1ImageStatus.html#a5fa1a343944043ac081b54fbd0137a08">firmware::ImageStatus::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> Firmware.idl:54</div></div>
<div class="ttc" id="namespacefirmware_html_a8382659c054865f764491b39adfa4cfc"><div class="ttname"><a href="namespacefirmware.html#a8382659c054865f764491b39adfa4cfc">firmware::newVersion</a></div><div class="ttdeci">string newVersion</div><div class="ttdoc">Firmware version the device is being upgraded to. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:108</div></div>
<div class="ttc" id="structfirmware_1_1UpdateHistoryEntry_html"><div class="ttname"><a href="structfirmware_1_1UpdateHistoryEntry.html">firmware::UpdateHistoryEntry</a></div><div class="ttdoc">Firmware update history entry TODO: implement CR# 45668 on next interface change add comment field ba...</div><div class="ttdef"><b>Definition:</b> Firmware.idl:29</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a5fae4ba282699965bca43321f63caf20"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a5fae4ba282699965bca43321f63caf20">firmware::ImageInfo_1_0_1::signed_by</a></div><div class="ttdeci">string signed_by</div><div class="ttdoc">Signature issuer. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:79</div></div>
<div class="ttc" id="structfirmware_1_1ImageStatus_html_aff0b4046e60990ca6b9f18b141ea8355"><div class="ttname"><a href="structfirmware_1_1ImageStatus.html#aff0b4046e60990ca6b9f18b141ea8355">firmware::ImageStatus::size_total</a></div><div class="ttdeci">int size_total</div><div class="ttdoc">Total size of the image (if available) </div><div class="ttdef"><b>Definition:</b> Firmware.idl:56</div></div>
<div class="ttc" id="structfirmware_1_1ImageStatus_html_a9ddd594e3abcbca26df8ae4164b68322"><div class="ttname"><a href="structfirmware_1_1ImageStatus.html#a9ddd594e3abcbca26df8ae4164b68322">firmware::ImageStatus::state</a></div><div class="ttdeci">ImageState state</div><div class="ttdoc">Image upload/download state. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:53</div></div>
<div class="ttc" id="namespacefirmware_html_a84624d4c530edeec36d68eb7a986b2fd"><div class="ttname"><a href="namespacefirmware.html#a84624d4c530edeec36d68eb7a986b2fd">firmware::FirmwareUpdateFailedEvent</a></div><div class="ttdeci">valueobject FirmwareUpdateFailedEvent</div><div class="ttdoc">Event: Firmware update failed. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:116</div></div>
<div class="ttc" id="namespacefirmware_html_a12efcd6deb737f180d15fcf05fc3bd6e"><div class="ttname"><a href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6e">firmware::UpdateFlags</a></div><div class="ttdeci">UpdateFlags</div><div class="ttdoc">Flags for startUpdate() method. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:91</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_ab173bddc0bad12cd1036e9e23489832b"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#ab173bddc0bad12cd1036e9e23489832b">firmware::ImageInfo_1_0_1::oem</a></div><div class="ttdeci">string oem</div><div class="ttdoc">OEM name. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:72</div></div>
<div class="ttc" id="structfirmware_1_1UpdateHistoryEntry_html_ac151e20096a6852f51a3f126892ff831"><div class="ttname"><a href="structfirmware_1_1UpdateHistoryEntry.html#ac151e20096a6852f51a3f126892ff831">firmware::UpdateHistoryEntry::imageVersion</a></div><div class="ttdeci">string imageVersion</div><div class="ttdoc">Firmware version of update image. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:32</div></div>
<div class="ttc" id="structfirmware_1_1ImageStatus_html"><div class="ttname"><a href="structfirmware_1_1ImageStatus.html">firmware::ImageStatus</a></div><div class="ttdoc">Image upload/download status. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:52</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_af49c7267ff9d63b5260295662207bcc5"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#af49c7267ff9d63b5260295662207bcc5">firmware::ImageInfo_1_0_1::model_list_present</a></div><div class="ttdeci">boolean model_list_present</div><div class="ttdoc">true if the image includes a supported models list </div><div class="ttdef"><b>Definition:</b> Firmware.idl:84</div></div>
<div class="ttc" id="structfirmware_1_1ImageStatus_html_a088e0ac5ca358a357184e19533cecafa"><div class="ttname"><a href="structfirmware_1_1ImageStatus.html#a088e0ac5ca358a357184e19533cecafa">firmware::ImageStatus::size_done</a></div><div class="ttdeci">int size_done</div><div class="ttdoc">Progress of the running upload or download (if available) </div><div class="ttdef"><b>Definition:</b> Firmware.idl:57</div></div>
<div class="ttc" id="namespacefirmware_html_a59c6107e7336cd09ab172861cbf29f61"><div class="ttname"><a href="namespacefirmware.html#a59c6107e7336cd09ab172861cbf29f61">firmware::FirmwareValidationFailedEvent</a></div><div class="ttdeci">valueobject FirmwareValidationFailedEvent</div><div class="ttdoc">Event: Firmware validation failed. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:103</div></div>
<div class="ttc" id="namespacefirmware_html_ac86db60b316e30e5487f06c7d9363f60a2a5252731c34e06c75a8b50e249df2b0"><div class="ttname"><a href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60a2a5252731c34e06c75a8b50e249df2b0">firmware::INCOMPLETE</a></div><div class="ttdoc">The update was not completed. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:20</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4ac0ae7272f66b513cf348242b01b3203e"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4ac0ae7272f66b513cf348242b01b3203e">firmware::DOWNLOADING</a></div><div class="ttdoc">The device is downloading a firmware image from a URL. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:44</div></div>
<div class="ttc" id="structfirmware_1_1UpdateHistoryEntry_html_aca48213ae3e950a2daae07e2202d03ea"><div class="ttname"><a href="structfirmware_1_1UpdateHistoryEntry.html#aca48213ae3e950a2daae07e2202d03ea">firmware::UpdateHistoryEntry::status</a></div><div class="ttdeci">UpdateHistoryStatus status</div><div class="ttdoc">Update status. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:34</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a3f92e6f56a627db87ae15dff8585302c"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a3f92e6f56a627db87ae15dff8585302c">firmware::ImageInfo_1_0_1::signature_present</a></div><div class="ttdeci">boolean signature_present</div><div class="ttdoc">true if the image is signed </div><div class="ttdef"><b>Definition:</b> Firmware.idl:78</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="namespaceidl_html"><div class="ttname"><a href="namespaceidl.html">idl</a></div><div class="ttdoc">Basic IDL definitions. </div><div class="ttdef"><b>Definition:</b> Event.idl:10</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4ac47ca7fe999e010fa587a6c6af5db503"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4ac47ca7fe999e010fa587a6c6af5db503">firmware::DOWNLOAD_FAILED</a></div><div class="ttdoc">There was a problem downloading the image from a URL. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:45</div></div>
<div class="ttc" id="namespacefirmware_html_a7a703582850d33c579a159c9121cf683"><div class="ttname"><a href="namespacefirmware.html#a7a703582850d33c579a159c9121cf683">firmware::SystemStartupEvent</a></div><div class="ttdeci">valueobject SystemStartupEvent</div><div class="ttdoc">Event: System startup finished. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:98</div></div>
<div class="ttc" id="namespacefirmware_html_a12efcd6deb737f180d15fcf05fc3bd6ea31e008cef3716fa2d6b74c8c9c29d533"><div class="ttname"><a href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6ea31e008cef3716fa2d6b74c8c9c29d533">firmware::CROSS_OEM</a></div><div class="ttdoc">Ignore version, product and OEM constraints. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:92</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_ad2eb0ebb39ce9c1ec7b82da3e24249c0"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#ad2eb0ebb39ce9c1ec7b82da3e24249c0">firmware::ImageInfo_1_0_1::signature_good</a></div><div class="ttdeci">boolean signature_good</div><div class="ttdoc">true if the signature is valid </div><div class="ttdef"><b>Definition:</b> Firmware.idl:80</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a4b61d1b0f577cb1fd596c11e13499885"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a4b61d1b0f577cb1fd596c11e13499885">firmware::ImageInfo_1_0_1::certified_by</a></div><div class="ttdeci">string certified_by</div><div class="ttdoc">Key certificate issuer. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:81</div></div>
<div class="ttc" id="namespacefirmware_html_aedbec85a0dd31de0a18a199dba25b601"><div class="ttname"><a href="namespacefirmware.html#aedbec85a0dd31de0a18a199dba25b601">firmware::FirmwareUpdateEvent</a></div><div class="ttdeci">valueobject FirmwareUpdateEvent</div><div class="ttdoc">Event: Firmware update base event. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:107</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a6b152656cbadc7fdff3cafeb0f66b316"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a6b152656cbadc7fdff3cafeb0f66b316">firmware::ImageInfo_1_0_1::product</a></div><div class="ttdeci">string product</div><div class="ttdoc">Product name. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:70</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_ad1c90af03eabc6a8a8968586fd703e33"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#ad1c90af03eabc6a8a8968586fd703e33">firmware::ImageInfo_1_0_1::min_downgrade_version</a></div><div class="ttdeci">string min_downgrade_version</div><div class="ttdoc">Minimum image version for running firmware. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:68</div></div>
<div class="ttc" id="namespacefirmware_html_ac86db60b316e30e5487f06c7d9363f60"><div class="ttname"><a href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60">firmware::UpdateHistoryStatus</a></div><div class="ttdeci">UpdateHistoryStatus</div><div class="ttdoc">Firmware update history status </div><div class="ttdef"><b>Definition:</b> Firmware.idl:17</div></div>
<div class="ttc" id="namespacefirmware_html_ac86db60b316e30e5487f06c7d9363f60af21cc0ea719057b4c766bf4cc8843e5a"><div class="ttname"><a href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60af21cc0ea719057b4c766bf4cc8843e5a">firmware::SUCCESSFUL</a></div><div class="ttdoc">The update was successfully completed. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:18</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a26aec4885247e215e4e5ec45d807161e"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a26aec4885247e215e4e5ec45d807161e">firmware::ImageInfo_1_0_1::min_required_version</a></div><div class="ttdeci">string min_required_version</div><div class="ttdoc">Minimum running firmware version for image. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:67</div></div>
<div class="ttc" id="namespacefirmware_html_a12efcd6deb737f180d15fcf05fc3bd6eaaabea5ce850d0af7639bb43c5bbfa302"><div class="ttname"><a href="namespacefirmware.html#a12efcd6deb737f180d15fcf05fc3bd6eaaabea5ce850d0af7639bb43c5bbfa302">firmware::CROSS_HW</a></div><div class="ttdoc">Ignore hardware constraints. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:93</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a6a516aa0c773c8900776e638d66daeb8"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a6a516aa0c773c8900776e638d66daeb8">firmware::ImageInfo_1_0_1::compatible</a></div><div class="ttdeci">boolean compatible</div><div class="ttdoc">true if the image is compatible with this device </div><div class="ttdef"><b>Definition:</b> Firmware.idl:76</div></div>
<div class="ttc" id="interfacefirmware_1_1Firmware__2__0__1_html"><div class="ttname"><a href="interfacefirmware_1_1Firmware__2__0__1.html">firmware::Firmware_2_0_1</a></div><div class="ttdoc">Firmware management methods </div><div class="ttdef"><b>Definition:</b> Firmware.idl:121</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_aeb0c9dade2639b1f26d32d530d6179f2"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#aeb0c9dade2639b1f26d32d530d6179f2">firmware::ImageInfo_1_0_1::certificate_good</a></div><div class="ttdeci">boolean certificate_good</div><div class="ttdoc">true if the key certificate is valid </div><div class="ttdef"><b>Definition:</b> Firmware.idl:82</div></div>
<div class="ttc" id="namespacefirmware_html_ad04a30dbfc42871c5be91bb95ff68da5"><div class="ttname"><a href="namespacefirmware.html#ad04a30dbfc42871c5be91bb95ff68da5">firmware::FirmwareUpdateCompletedEvent</a></div><div class="ttdeci">valueobject FirmwareUpdateCompletedEvent</div><div class="ttdoc">Event: Firmware updated successfully. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:114</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4aea7f972406e3c016a509ed943d235ee1"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4aea7f972406e3c016a509ed943d235ee1">firmware::NONE</a></div><div class="ttdoc">No firmware image has been uploaded/downloaded. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:41</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_aafdb08329af3e462e432e590fe2bf3f8"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#aafdb08329af3e462e432e590fe2bf3f8">firmware::ImageInfo_1_0_1::valid</a></div><div class="ttdeci">boolean valid</div><div class="ttdoc">The file is a valid firmware image. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:64</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_a128baa48c49440d1d5d45fab28fe9cf7"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#a128baa48c49440d1d5d45fab28fe9cf7">firmware::ImageInfo_1_0_1::hwid_whitelist</a></div><div class="ttdeci">string hwid_whitelist</div><div class="ttdoc">Hardware ID whitelist. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:73</div></div>
<div class="ttc" id="namespacefirmware_html_ad96da3579d71d5884f3db1f1c8716f4d"><div class="ttname"><a href="namespacefirmware.html#ad96da3579d71d5884f3db1f1c8716f4d">firmware::SystemShutdownEvent</a></div><div class="ttdeci">valueobject SystemShutdownEvent</div><div class="ttdoc">Event: System shutdown started. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:100</div></div>
<div class="ttc" id="structfirmware_1_1ImageStatus_html_a9e8be1cc2a648a1ef2d606bca9f9f333"><div class="ttname"><a href="structfirmware_1_1ImageStatus.html#a9e8be1cc2a648a1ef2d606bca9f9f333">firmware::ImageStatus::time_started</a></div><div class="ttdeci">time time_started</div><div class="ttdoc">Timestamp of the last state change (if available) </div><div class="ttdef"><b>Definition:</b> Firmware.idl:55</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_ab3906d2758f7237a68851872c4634a23"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#ab3906d2758f7237a68851872c4634a23">firmware::ImageInfo_1_0_1::model_supported</a></div><div class="ttdeci">boolean model_supported</div><div class="ttdoc">true if the model is found on the support list </div><div class="ttdef"><b>Definition:</b> Firmware.idl:85</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html_aacc580a002fab81a9a70b4491f59e588"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html#aacc580a002fab81a9a70b4491f59e588">firmware::ImageInfo_1_0_1::hwid_blacklist</a></div><div class="ttdeci">string hwid_blacklist</div><div class="ttdoc">Hardware ID blacklist. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:74</div></div>
<div class="ttc" id="structfirmware_1_1UpdateHistoryEntry_html_a25e5b0296c75a49d29c37333f9eefd3a"><div class="ttname"><a href="structfirmware_1_1UpdateHistoryEntry.html#a25e5b0296c75a49d29c37333f9eefd3a">firmware::UpdateHistoryEntry::oldVersion</a></div><div class="ttdeci">string oldVersion</div><div class="ttdoc">Previous firmware version. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:31</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4">firmware::ImageState</a></div><div class="ttdeci">ImageState</div><div class="ttdoc">Image upload/download state. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:40</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4aa3afe3a704fb5714dd82092447e03877"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4aa3afe3a704fb5714dd82092447e03877">firmware::UPLOAD_FAILED</a></div><div class="ttdoc">There was a problem uploading an image to the device. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:43</div></div>
<div class="ttc" id="namespacefirmware_html_ac86db60b316e30e5487f06c7d9363f60a108af1846822fd089c3361170aefad16"><div class="ttname"><a href="namespacefirmware.html#ac86db60b316e30e5487f06c7d9363f60a108af1846822fd089c3361170aefad16">firmware::FAILED</a></div><div class="ttdoc">The update failed. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:19</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4a634fa215fbf4a85f0780c1c9521129e3"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4a634fa215fbf4a85f0780c1c9521129e3">firmware::UPLOADING</a></div><div class="ttdoc">A firmware image is currently being uploaded. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:42</div></div>
<div class="ttc" id="namespacefirmware_html_afab31261b2db221602741233edaaf7e4a6ef1ce4531f0f3d72db4a22b2b5293e6"><div class="ttname"><a href="namespacefirmware.html#afab31261b2db221602741233edaaf7e4a6ef1ce4531f0f3d72db4a22b2b5293e6">firmware::COMPLETE</a></div><div class="ttdoc">A complete image has been successfully uploaded/downloaded. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:46</div></div>
<div class="ttc" id="structfirmware_1_1UpdateHistoryEntry_html_ace4a48b6565ab257dcd443132bf91c16"><div class="ttname"><a href="structfirmware_1_1UpdateHistoryEntry.html#ace4a48b6565ab257dcd443132bf91c16">firmware::UpdateHistoryEntry::timestamp</a></div><div class="ttdeci">time timestamp</div><div class="ttdoc">Timestamp when the update was started. </div><div class="ttdef"><b>Definition:</b> Firmware.idl:30</div></div>
<div class="ttc" id="structfirmware_1_1ImageInfo__1__0__1_html"><div class="ttname"><a href="structfirmware_1_1ImageInfo__1__0__1.html">firmware::ImageInfo_1_0_1</a></div><div class="ttdoc">Firmware image information </div><div class="ttdef"><b>Definition:</b> Firmware.idl:63</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>
|
