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
|
<!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/HardwareHealth.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">HardwareHealth.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 2018 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 <Event.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> module <a class="code" href="namespacefitness.html">fitness</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="interfacefitness_1_1HardwareHealth__1__0__1.html"> 10</a></span>  <span class="keyword">interface </span><a class="code" href="interfacefitness_1_1HardwareHealth__1__0__1.html">HardwareHealth_1_0_1</a> {</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"> /** hardware failure types */</span></div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="interfacefitness_1_1HardwareHealth__1__0__1.html#a82328bae8ed45490cce14f5e8be9bfd3"> 13</a></span>  constant <span class="keywordtype">int</span> FAILURE_TYPE_NETWORK_DEVICE_NOT_DETECTED = 1;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  constant <span class="keywordtype">int</span> FAILURE_TYPE_I2C_BUS_STUCK = 2;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  constant <span class="keywordtype">int</span> FAILURE_TYPE_SLAVE_CTRL_NOT_REACHABLE = 3;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  constant <span class="keywordtype">int</span> FAILURE_TYPE_SLAVE_CTRL_MALFUNCTION = 4;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  constant <span class="keywordtype">int</span> FAILURE_TYPE_OUTLET_POWER_STATE_INCONSISTENT = 5;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /** Hardware Failure */</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html"> 20</a></span>  structure <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html">Failure</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a85acebffd79ae1116538b703722d4992"> 21</a></span>  <span class="keywordtype">int</span> <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a85acebffd79ae1116538b703722d4992">creationOrderId</a>; <span class="comment">///< failures created later have a larger id; range 1..failure-count</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ac024784c0a3c45080386f5bf1782a324"> 22</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ac024784c0a3c45080386f5bf1782a324">componentId</a>; <span class="comment">///< the ID of the affected hardware component</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a512ae4254a50041046b1183045637253"> 23</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a512ae4254a50041046b1183045637253">type</a>; <span class="comment">///< one of the hardware failure type constants</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ac7a29338c22efb25269a39cd85bb344a"> 24</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ac7a29338c22efb25269a39cd85bb344a">description</a>; <span class="comment">///< human readable string describing HW component and failure</span></div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a127feea4655043b3831bc6118c9da88a"> 25</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a127feea4655043b3831bc6118c9da88a">isAsserted</a>; <span class="comment">///< \c true when the failure is currently asserted</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a055ecad447afb69516fb45215cfb0bc7"> 26</a></span> <span class="comment"></span> time <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a055ecad447afb69516fb45215cfb0bc7">lastAssertTimeStamp</a>; <span class="comment">///< timestamp when the failure was last asserted</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a9c3fc694ea97e3c3dd32908266a36208"> 27</a></span> <span class="comment"></span> time <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a9c3fc694ea97e3c3dd32908266a36208">lastDeassertTimeStamp</a>; <span class="comment">///< timestamp when the failure was last deasserted (0 if asserted)</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ae67d59b37554fae5fa12d9eaadd64d90"> 28</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ae67d59b37554fae5fa12d9eaadd64d90">assertCount</a>; <span class="comment">///< count of assertions</span></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"> /** Event that is send when the hardware failure status changes */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  valueobject FailureStatusChangedEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="interfacefitness_1_1HardwareHealth__1__0__1.html#a24e3d7246bd35778eab24a54dc2c3df1"> 33</a></span>  <span class="keywordtype">string</span> componentId; <span class="comment">///< the ID of the affected hardware component</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="interfacefitness_1_1HardwareHealth__1__0__1.html#aa882c5da8afaec088c2416d4fd990cf6"> 34</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="interfacefitness_1_1HardwareHealth__1__0__1.html#aa882c5da8afaec088c2416d4fd990cf6">failureType</a>; <span class="comment">///< one of the hardware failure type constants</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="interfacefitness_1_1HardwareHealth__1__0__1.html#aa635194e02749ace68346e01ef15cf99"> 35</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="interfacefitness_1_1HardwareHealth__1__0__1.html#aa635194e02749ace68346e01ef15cf99">isAsserted</a>; <span class="comment">///< \c true when the failure is currently asserted</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"> /**</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * Return a vector with past and present hardware failures.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @return hardware failure vector</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> */</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  vector<Failure> getFailures();</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div><div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_a512ae4254a50041046b1183045637253"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a512ae4254a50041046b1183045637253">fitness::HardwareHealth_1_0_1::Failure::type</a></div><div class="ttdeci">int type</div><div class="ttdoc">one of the hardware failure type constants </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:23</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_ac024784c0a3c45080386f5bf1782a324"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ac024784c0a3c45080386f5bf1782a324">fitness::HardwareHealth_1_0_1::Failure::componentId</a></div><div class="ttdeci">string componentId</div><div class="ttdoc">the ID of the affected hardware component </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:22</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_ac7a29338c22efb25269a39cd85bb344a"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ac7a29338c22efb25269a39cd85bb344a">fitness::HardwareHealth_1_0_1::Failure::description</a></div><div class="ttdeci">string description</div><div class="ttdoc">human readable string describing HW component and failure </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:24</div></div>
<div class="ttc" id="interfacefitness_1_1HardwareHealth__1__0__1_html_aa635194e02749ace68346e01ef15cf99"><div class="ttname"><a href="interfacefitness_1_1HardwareHealth__1__0__1.html#aa635194e02749ace68346e01ef15cf99">fitness::HardwareHealth_1_0_1::isAsserted</a></div><div class="ttdeci">boolean isAsserted</div><div class="ttdoc">true when the failure is currently asserted </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:35</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html">fitness::HardwareHealth_1_0_1::Failure</a></div><div class="ttdoc">Hardware Failure. </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:20</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="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_a127feea4655043b3831bc6118c9da88a"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a127feea4655043b3831bc6118c9da88a">fitness::HardwareHealth_1_0_1::Failure::isAsserted</a></div><div class="ttdeci">boolean isAsserted</div><div class="ttdoc">true when the failure is currently asserted </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:25</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_a055ecad447afb69516fb45215cfb0bc7"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a055ecad447afb69516fb45215cfb0bc7">fitness::HardwareHealth_1_0_1::Failure::lastAssertTimeStamp</a></div><div class="ttdeci">time lastAssertTimeStamp</div><div class="ttdoc">timestamp when the failure was last asserted </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:26</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_a85acebffd79ae1116538b703722d4992"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a85acebffd79ae1116538b703722d4992">fitness::HardwareHealth_1_0_1::Failure::creationOrderId</a></div><div class="ttdeci">int creationOrderId</div><div class="ttdoc">failures created later have a larger id; range 1..failure-count </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:21</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_a9c3fc694ea97e3c3dd32908266a36208"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#a9c3fc694ea97e3c3dd32908266a36208">fitness::HardwareHealth_1_0_1::Failure::lastDeassertTimeStamp</a></div><div class="ttdeci">time lastDeassertTimeStamp</div><div class="ttdoc">timestamp when the failure was last deasserted (0 if asserted) </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:27</div></div>
<div class="ttc" id="structfitness_1_1HardwareHealth__1__0__1_1_1Failure_html_ae67d59b37554fae5fa12d9eaadd64d90"><div class="ttname"><a href="structfitness_1_1HardwareHealth__1__0__1_1_1Failure.html#ae67d59b37554fae5fa12d9eaadd64d90">fitness::HardwareHealth_1_0_1::Failure::assertCount</a></div><div class="ttdeci">int assertCount</div><div class="ttdoc">count of assertions </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:28</div></div>
<div class="ttc" id="interfacefitness_1_1HardwareHealth__1__0__1_html"><div class="ttname"><a href="interfacefitness_1_1HardwareHealth__1__0__1.html">fitness::HardwareHealth_1_0_1</a></div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:10</div></div>
<div class="ttc" id="namespacefitness_html"><div class="ttname"><a href="namespacefitness.html">fitness</a></div><div class="ttdoc">Fitness Daemon </div><div class="ttdef"><b>Definition:</b> Fitness.idl:7</div></div>
<div class="ttc" id="interfacefitness_1_1HardwareHealth__1__0__1_html_aa882c5da8afaec088c2416d4fd990cf6"><div class="ttname"><a href="interfacefitness_1_1HardwareHealth__1__0__1.html#aa882c5da8afaec088c2416d4fd990cf6">fitness::HardwareHealth_1_0_1::failureType</a></div><div class="ttdeci">int failureType</div><div class="ttdoc">one of the hardware failure type constants </div><div class="ttdef"><b>Definition:</b> HardwareHealth.idl:34</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>
|
