1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<!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: test::AuxSerial Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacetest.html">test</a></li><li class="navelem"><a class="el" href="interfacetest_1_1AuxSerial.html">AuxSerial</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacetest_1_1AuxSerial-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">test::AuxSerial Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>test routines for Raritan Aux Serial interface (RS485 on pins 3 and 6 of RJ45) Require TestMode to be ON.
<a href="interfacetest_1_1AuxSerial.html#details">More...</a></p>
<p><code>import"<a class="el" href="testrpc_8idl_source.html">testrpc.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a530b026bdf90499163eccf686c2d2d59"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1AuxSerial.html#a530b026bdf90499163eccf686c2d2d59">getNumberOfPorts</a> (out int numPorts)</td></tr>
<tr class="memdesc:a530b026bdf90499163eccf686c2d2d59"><td class="mdescLeft"> </td><td class="mdescRight">returns number of ports <a href="#a530b026bdf90499163eccf686c2d2d59">More...</a><br /></td></tr>
<tr class="separator:a530b026bdf90499163eccf686c2d2d59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec31517ab65cbfcabd1df469708c707d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1AuxSerial.html#aec31517ab65cbfcabd1df469708c707d">testLoop</a> (in int portNum, out string errstr)</td></tr>
<tr class="memdesc:aec31517ab65cbfcabd1df469708c707d"><td class="mdescLeft"> </td><td class="mdescRight">Performs a loop test with special test adapter. <a href="#aec31517ab65cbfcabd1df469708c707d">More...</a><br /></td></tr>
<tr class="separator:aec31517ab65cbfcabd1df469708c707d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad64e54e2c33cced5d9f9d5b6785835b6"><td class="memItemLeft" align="right" valign="top"><a id="ad64e54e2c33cced5d9f9d5b6785835b6"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1AuxSerial.html#ad64e54e2c33cced5d9f9d5b6785835b6">OK</a> = 0</td></tr>
<tr class="memdesc:ad64e54e2c33cced5d9f9d5b6785835b6"><td class="mdescLeft"> </td><td class="mdescRight">No error. <br /></td></tr>
<tr class="separator:ad64e54e2c33cced5d9f9d5b6785835b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99528618cf9b9426c7b5da463c62bb89"><td class="memItemLeft" align="right" valign="top"><a id="a99528618cf9b9426c7b5da463c62bb89"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1AuxSerial.html#a99528618cf9b9426c7b5da463c62bb89">ERR_NO_TEST_MODE</a> = 1</td></tr>
<tr class="memdesc:a99528618cf9b9426c7b5da463c62bb89"><td class="mdescLeft"> </td><td class="mdescRight">Not in test mode. <br /></td></tr>
<tr class="separator:a99528618cf9b9426c7b5da463c62bb89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c4f2c7a2a26b44024c9b26d26254edb"><td class="memItemLeft" align="right" valign="top"><a id="a1c4f2c7a2a26b44024c9b26d26254edb"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1AuxSerial.html#a1c4f2c7a2a26b44024c9b26d26254edb">ERR_INVAL_PORT_NUM</a> = 2</td></tr>
<tr class="memdesc:a1c4f2c7a2a26b44024c9b26d26254edb"><td class="mdescLeft"> </td><td class="mdescRight">Invalid port number. <br /></td></tr>
<tr class="separator:a1c4f2c7a2a26b44024c9b26d26254edb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b529f556ddfd06539dceb5e3889405a"><td class="memItemLeft" align="right" valign="top"><a id="a5b529f556ddfd06539dceb5e3889405a"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacetest_1_1AuxSerial.html#a5b529f556ddfd06539dceb5e3889405a">ERR_TEST_FAILED</a> = 3</td></tr>
<tr class="memdesc:a5b529f556ddfd06539dceb5e3889405a"><td class="mdescLeft"> </td><td class="mdescRight">Test failed. <br /></td></tr>
<tr class="separator:a5b529f556ddfd06539dceb5e3889405a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>test routines for Raritan Aux Serial interface (RS485 on pins 3 and 6 of RJ45) Require TestMode to be ON. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a530b026bdf90499163eccf686c2d2d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a530b026bdf90499163eccf686c2d2d59">◆ </a></span>getNumberOfPorts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int test::AuxSerial::getNumberOfPorts </td>
<td>(</td>
<td class="paramtype">out int </td>
<td class="paramname"><em>numPorts</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns number of ports </p>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if not in test mode </dd></dl>
</div>
</div>
<a id="aec31517ab65cbfcabd1df469708c707d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec31517ab65cbfcabd1df469708c707d">◆ </a></span>testLoop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int test::AuxSerial::testLoop </td>
<td>(</td>
<td class="paramtype">in int </td>
<td class="paramname"><em>portNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>errstr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a loop test with special test adapter. </p>
<dl class="section return"><dt>Returns</dt><dd>OK if OK </dd>
<dd>
ERR_NO_TEST_MODE if not in test mode </dd>
<dd>
ERR_INVAL_PORT_NUM if invalid port number </dd>
<dd>
ERR_TEST_FAILED if test failed, errstr may be set </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="testrpc_8idl_source.html">testrpc.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
