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/testrpc.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">testrpc.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 2012 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"> * system test interfaces</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> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> module <a class="code" href="namespacetest.html">test</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></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"> 14</span> <span class="comment"> * Convenience structure to return test or operation results.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * - There is a result code</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Typically 0 means OK</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 1 means Test Error</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * 2 means Invalid Parameter</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * However indivdual test may redefine or extend this definition</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * - There is a descriptive error string,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * which is empty in case test went OK</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"> * This structure is not neccessarily used for all operations</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * but only for those where it comes in handy</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> */</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structtest_1_1Result.html"> 26</a></span>  structure <a class="code" href="structtest_1_1Result.html">Result</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structtest_1_1Result.html#ab7f7a8309418e1ee760061e8e54d6e9a"> 27</a></span>  <span class="keywordtype">int</span> <a class="code" href="structtest_1_1Result.html#ab7f7a8309418e1ee760061e8e54d6e9a">code</a>; <span class="comment">///< Result code</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structtest_1_1Result.html#a15c30ff9c613d9f8649c11c1e7ba316a"> 28</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structtest_1_1Result.html#a15c30ff9c613d9f8649c11c1e7ba316a">errtext</a>; <span class="comment">///< Descriptive error string</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"> /**</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Interface to enter and exit special test modes.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * Some of the port tests require the unit to be set in </span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * dedicated test modes because special equipment is plugged into the</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * ports which would confuse ordinary services observing those ports.</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"><a class="line" href="interfacetest_1_1Control.html"> 37</a></span>  <span class="keyword">interface </span><a class="code" href="interfacetest_1_1Control.html">Control</a> {</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"> /**</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * returns actual state of test mode</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">boolean</span> isTestMode();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment"></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /**</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * sets the unit in test mode which pulls away services</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * dealing with feature ports, aux ports, 1wire ports</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="keywordtype">void</span> setTestMode(in <span class="keywordtype">boolean</span> isTestModeOn);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  };</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /**</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * Test routines for full RS232 Serial Interface</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> */</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="interfacetest_1_1RS232Serial.html"> 56</a></span>  <span class="keyword">interface </span><a class="code" href="interfacetest_1_1RS232Serial.html">RS232Serial</a> {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></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"> * returns list of valid device files for the test</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>  vector<string> getDeviceFiles();</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"> 63</span> <span class="comment"> /**</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * loop test with adapter 1</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * DTR->DSR, RTS->CTS</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="structtest_1_1Result.html">Result</a> testLoop1(in <span class="keywordtype">string</span> devfile);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></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"> 70</span> <span class="comment"> * loop test with adapter 2</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * DTR->DCD, RTS->RI</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> */</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="structtest_1_1Result.html">Result</a> testLoop2(in <span class="keywordtype">string</span> devfile);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  };</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</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"> 78</span> <span class="comment"> /**</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * test routines for Raritan Feature Serial interface</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * (RS232 with some control lines and switched power)</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * Require TestMode to be ON.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="interfacetest_1_1FeatSerial.html"> 83</a></span>  <span class="keyword">interface </span><a class="code" href="interfacetest_1_1FeatSerial.html">FeatSerial</a> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="interfacetest_1_1FeatSerial.html#a6098ed9bb4f2daca59c0d526dd5c0589"> 85</a></span>  constant <span class="keywordtype">int</span> OK = 0; <span class="comment">///< No error</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="interfacetest_1_1FeatSerial.html#abeab4e70cbf6feff973e30328d3eac4b"> 86</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_NO_TEST_MODE = 1; <span class="comment">///< Not in test mode</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="interfacetest_1_1FeatSerial.html#a3c8f53789c3962c4f08722e17c303459"> 87</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVAL_PORT_NUM = 2; <span class="comment">///< Invalid port number</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="interfacetest_1_1FeatSerial.html#a5debf8c427d0ed9922901fd71ac93215"> 88</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_TEST_FAILED = 3; <span class="comment">///< Test failed</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> <span class="comment"></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"> 91</span> <span class="comment"> * returns number of ports</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> *</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @return 1 if not in test mode</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="keywordtype">int</span> getNumberOfPorts(out <span class="keywordtype">int</span> numPorts);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /**</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * Switches Power supplied to the port</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * Observable with special test adapter</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * Power->LED</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> *</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @return OK if OK</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @return ERR_NO_TEST_MODE if not in test mode</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @return ERR_INVAL_PORT_NUM if invalid port number</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> */</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">int</span> setPower(in <span class="keywordtype">int</span> portNum, in <span class="keywordtype">boolean</span> hasPower);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /**</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * Performs a loop test with special test adapter</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * TX->RX</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> *</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @return OK if OK</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @return ERR_NO_TEST_MODE if not in test mode</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * @return ERR_INVAL_PORT_NUM if invalid port number</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @return ERR_TEST_FAILED if test failed, errstr may be set</span></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="keywordtype">int</span> testLoopTxRx(in <span class="keywordtype">int</span> portNum, out <span class="keywordtype">string</span> errstr);</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"></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"> 121</span> <span class="comment"> * Performs a loop test with special test adapter</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * DTR->DCD</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"> * @return OK if OK</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @return ERR_NO_TEST_MODE if not in test mode</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @return ERR_INVAL_PORT_NUM if invalid port number</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @return ERR_TEST_FAILED if test failed, errstr may be set</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> */</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">int</span> testLoopDtrDcd(in <span class="keywordtype">int</span> portNum, out <span class="keywordtype">string</span> errstr);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span></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"> * test routines for Raritan Aux Serial interface</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * (RS485 on pins 3 and 6 of RJ45)</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * Require TestMode to be ON.</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"><a class="line" href="interfacetest_1_1AuxSerial.html"> 139</a></span>  <span class="keyword">interface </span><a class="code" href="interfacetest_1_1AuxSerial.html">AuxSerial</a> {</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="interfacetest_1_1AuxSerial.html#ad64e54e2c33cced5d9f9d5b6785835b6"> 141</a></span>  constant <span class="keywordtype">int</span> OK = 0; <span class="comment">///< No error</span></div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="interfacetest_1_1AuxSerial.html#a99528618cf9b9426c7b5da463c62bb89"> 142</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_NO_TEST_MODE = 1; <span class="comment">///< Not in test mode</span></div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="interfacetest_1_1AuxSerial.html#a1c4f2c7a2a26b44024c9b26d26254edb"> 143</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVAL_PORT_NUM = 2; <span class="comment">///< Invalid port number</span></div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="interfacetest_1_1AuxSerial.html#a5b529f556ddfd06539dceb5e3889405a"> 144</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_TEST_FAILED = 3; <span class="comment">///< Test failed</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></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 number of ports</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 0 if OK</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @return 1 if not in test mode</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> */</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordtype">int</span> getNumberOfPorts(out <span class="keywordtype">int</span> numPorts);</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"> /**</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * Performs a loop test with special test adapter</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> *</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @return OK if OK</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @return ERR_NO_TEST_MODE if not in test mode</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @return ERR_INVAL_PORT_NUM if invalid port number</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @return ERR_TEST_FAILED if test failed, errstr may be set</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> */</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">int</span> testLoop(in <span class="keywordtype">int</span> portNum, out <span class="keywordtype">string</span> errstr);</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  };</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span></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"> * test routines for RJ45 Ethernet port</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * This is low level interface using ethtool</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * that does not persist any of the settings made</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * (TODO: this interface may be combined with a 'decent'</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * network interface. Currently the network interface is</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * dedicated to special use cases)</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div><div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html"> 174</a></span>  <span class="keyword">interface </span><a class="code" href="interfacetest_1_1Ethernet.html">Ethernet</a> {</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></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"> * returns a a list of valid network interface devices</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>  vector<string> getDevices();</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"> /** Ethernet Speed */</span></div><div class="line"><a name="l00182"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7"> 182</a></span>  enumeration <a class="code" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">Speed</a> {</div><div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a0b0effddf634c8fc1f4dc3ab4c4526a5"> 183</a></span>  <a class="code" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a0b0effddf634c8fc1f4dc3ab4c4526a5">SPD_10</a>, <span class="comment">///< 10 Mbit/s</span></div><div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a2eee97cd117ac0635c4ea8a15a8716c3"> 184</a></span> <span class="comment"></span> <a class="code" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a2eee97cd117ac0635c4ea8a15a8716c3">SPD_100</a>, <span class="comment">///< 100 Mbit/s</span></div><div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a6cb2bff22a262ceee314aba0361bd696"> 185</a></span> <span class="comment"></span> SPD_1000 <span class="comment">///< 1 Gbit/s</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"></span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> /** Ethernet Duplex Mode */</span></div><div class="line"><a name="l00189"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292"> 189</a></span>  enumeration <a class="code" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">Duplex</a> {</div><div class="line"><a name="l00190"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292a8fae1d3bdaa768f075e516ae7eeff454"> 190</a></span>  <a class="code" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292a8fae1d3bdaa768f075e516ae7eeff454">DPX_HALF</a>, <span class="comment">///< Half Duplex</span></div><div class="line"><a name="l00191"></a><span class="lineno"><a class="line" href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292a9f328663b012e5ee2aa348c198b914e8"> 191</a></span> <span class="comment"></span> DPX_FULL <span class="comment">///< Full Duplex</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span> };</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> /**</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * transiently sets the interface to the desired parameters</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @return 1 if invalid param</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @return 2 if system error executing operation</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> */</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">int</span> setParameters(in <span class="keywordtype">string</span> device, in Speed speed, in Duplex duplex,</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  in <span class="keywordtype">boolean</span> isAutoNeg);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  };</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div><div class="ttc" id="structtest_1_1Result_html_a15c30ff9c613d9f8649c11c1e7ba316a"><div class="ttname"><a href="structtest_1_1Result.html#a15c30ff9c613d9f8649c11c1e7ba316a">test::Result::errtext</a></div><div class="ttdeci">string errtext</div><div class="ttdoc">Descriptive error string. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:28</div></div>
<div class="ttc" id="interfacetest_1_1Ethernet_html_a98b12f5c2d49d98357afcfd444a4a292"><div class="ttname"><a href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292">test::Ethernet::Duplex</a></div><div class="ttdeci">Duplex</div><div class="ttdoc">Ethernet Duplex Mode. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:189</div></div>
<div class="ttc" id="interfacetest_1_1Control_html"><div class="ttname"><a href="interfacetest_1_1Control.html">test::Control</a></div><div class="ttdoc">Interface to enter and exit special test modes. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:37</div></div>
<div class="ttc" id="namespacetest_html"><div class="ttname"><a href="namespacetest.html">test</a></div><div class="ttdoc">Test Interfaces. </div><div class="ttdef"><b>Definition:</b> TestDisplay.idl:12</div></div>
<div class="ttc" id="interfacetest_1_1AuxSerial_html"><div class="ttname"><a href="interfacetest_1_1AuxSerial.html">test::AuxSerial</a></div><div class="ttdoc">test routines for Raritan Aux Serial interface (RS485 on pins 3 and 6 of RJ45) Require TestMode to be...</div><div class="ttdef"><b>Definition:</b> testrpc.idl:139</div></div>
<div class="ttc" id="interfacetest_1_1Ethernet_html_a98b12f5c2d49d98357afcfd444a4a292a8fae1d3bdaa768f075e516ae7eeff454"><div class="ttname"><a href="interfacetest_1_1Ethernet.html#a98b12f5c2d49d98357afcfd444a4a292a8fae1d3bdaa768f075e516ae7eeff454">test::Ethernet::DPX_HALF</a></div><div class="ttdoc">Half Duplex. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:190</div></div>
<div class="ttc" id="interfacetest_1_1Ethernet_html_a7068d47affdfd12830387cffcb2565e7a0b0effddf634c8fc1f4dc3ab4c4526a5"><div class="ttname"><a href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a0b0effddf634c8fc1f4dc3ab4c4526a5">test::Ethernet::SPD_10</a></div><div class="ttdoc">10 Mbit/s </div><div class="ttdef"><b>Definition:</b> testrpc.idl:183</div></div>
<div class="ttc" id="interfacetest_1_1Ethernet_html"><div class="ttname"><a href="interfacetest_1_1Ethernet.html">test::Ethernet</a></div><div class="ttdoc">test routines for RJ45 Ethernet port This is low level interface using ethtool that does not persist ...</div><div class="ttdef"><b>Definition:</b> testrpc.idl:174</div></div>
<div class="ttc" id="structtest_1_1Result_html"><div class="ttname"><a href="structtest_1_1Result.html">test::Result</a></div><div class="ttdoc">Convenience structure to return test or operation results. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:26</div></div>
<div class="ttc" id="interfacetest_1_1FeatSerial_html"><div class="ttname"><a href="interfacetest_1_1FeatSerial.html">test::FeatSerial</a></div><div class="ttdoc">test routines for Raritan Feature Serial interface (RS232 with some control lines and switched power)...</div><div class="ttdef"><b>Definition:</b> testrpc.idl:83</div></div>
<div class="ttc" id="structtest_1_1Result_html_ab7f7a8309418e1ee760061e8e54d6e9a"><div class="ttname"><a href="structtest_1_1Result.html#ab7f7a8309418e1ee760061e8e54d6e9a">test::Result::code</a></div><div class="ttdeci">int code</div><div class="ttdoc">Result code. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:27</div></div>
<div class="ttc" id="interfacetest_1_1Ethernet_html_a7068d47affdfd12830387cffcb2565e7a2eee97cd117ac0635c4ea8a15a8716c3"><div class="ttname"><a href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7a2eee97cd117ac0635c4ea8a15a8716c3">test::Ethernet::SPD_100</a></div><div class="ttdoc">100 Mbit/s </div><div class="ttdef"><b>Definition:</b> testrpc.idl:184</div></div>
<div class="ttc" id="interfacetest_1_1Ethernet_html_a7068d47affdfd12830387cffcb2565e7"><div class="ttname"><a href="interfacetest_1_1Ethernet.html#a7068d47affdfd12830387cffcb2565e7">test::Ethernet::Speed</a></div><div class="ttdeci">Speed</div><div class="ttdoc">Ethernet Speed. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:182</div></div>
<div class="ttc" id="interfacetest_1_1RS232Serial_html"><div class="ttname"><a href="interfacetest_1_1RS232Serial.html">test::RS232Serial</a></div><div class="ttdoc">Test routines for full RS232 Serial Interface. </div><div class="ttdef"><b>Definition:</b> testrpc.idl:56</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>
|
