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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<!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: pdumodel::Ade 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="namespacepdumodel.html">pdumodel</a></li><li class="navelem"><a class="el" href="interfacepdumodel_1_1Ade.html">Ade</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="interfacepdumodel_1_1Ade-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pdumodel::Ade Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for ADE chips directly connected to main controller.
<a href="interfacepdumodel_1_1Ade.html#details">More...</a></p>
<p><code>import"<a class="el" href="Ade_8idl_source.html">Ade.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Ade_1_1MetaData.html">MetaData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">ADE metadata. <a href="structpdumodel_1_1Ade_1_1MetaData.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpdumodel_1_1Ade_1_1Sample.html">Sample</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Raw sample data for a single channel. <a href="structpdumodel_1_1Ade_1_1Sample.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a2e2c3e49ecd68521d565b090e2ecf74c"><td class="memItemLeft" align="right" valign="top"><a id="a2e2c3e49ecd68521d565b090e2ecf74c"></a>
typedef map< string, long > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Ade.html#a2e2c3e49ecd68521d565b090e2ecf74c">RegisterMap</a></td></tr>
<tr class="memdesc:a2e2c3e49ecd68521d565b090e2ecf74c"><td class="mdescLeft"> </td><td class="mdescRight">Map of ADE register values. <br /></td></tr>
<tr class="separator:a2e2c3e49ecd68521d565b090e2ecf74c"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a07d9a55a99efea2e620168bddda47e85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpdumodel_1_1Ade_1_1MetaData.html">MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Ade.html#a07d9a55a99efea2e620168bddda47e85">getMetaData</a> ()</td></tr>
<tr class="memdesc:a07d9a55a99efea2e620168bddda47e85"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the ADE metadata. <a href="#a07d9a55a99efea2e620168bddda47e85">More...</a><br /></td></tr>
<tr class="separator:a07d9a55a99efea2e620168bddda47e85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a612155dcb290739eacc6f50e881546e4"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structpdumodel_1_1Ade_1_1Sample.html">Sample</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Ade.html#a612155dcb290739eacc6f50e881546e4">getLatestSample</a> ()</td></tr>
<tr class="memdesc:a612155dcb290739eacc6f50e881546e4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the latest raw samples. <a href="#a612155dcb290739eacc6f50e881546e4">More...</a><br /></td></tr>
<tr class="separator:a612155dcb290739eacc6f50e881546e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d9b04c380453556b7e08f5761672cd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacepdumodel_1_1Ade.html#a2e2c3e49ecd68521d565b090e2ecf74c">RegisterMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Ade.html#a6d9b04c380453556b7e08f5761672cd9">getCalibrationData</a> ()</td></tr>
<tr class="memdesc:a6d9b04c380453556b7e08f5761672cd9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the values of all supported calibration registers. <a href="#a6d9b04c380453556b7e08f5761672cd9">More...</a><br /></td></tr>
<tr class="separator:a6d9b04c380453556b7e08f5761672cd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5836b5c9d13e26b44e77f383c0ce7903"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacepdumodel_1_1Ade.html#a5836b5c9d13e26b44e77f383c0ce7903">setCalibrationData</a> (in <a class="el" href="interfacepdumodel_1_1Ade.html#a2e2c3e49ecd68521d565b090e2ecf74c">RegisterMap</a> regs)</td></tr>
<tr class="memdesc:a5836b5c9d13e26b44e77f383c0ce7903"><td class="mdescLeft"> </td><td class="mdescRight">Set new values for some or all calibration registers. <a href="#a5836b5c9d13e26b44e77f383c0ce7903">More...</a><br /></td></tr>
<tr class="separator:a5836b5c9d13e26b44e77f383c0ce7903"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for ADE chips directly connected to main controller. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6d9b04c380453556b7e08f5761672cd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d9b04c380453556b7e08f5761672cd9">◆ </a></span>getCalibrationData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacepdumodel_1_1Ade.html#a2e2c3e49ecd68521d565b090e2ecf74c">RegisterMap</a> pdumodel::Ade::getCalibrationData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the values of all supported calibration registers. </p>
<dl class="section return"><dt>Returns</dt><dd>Map of calibration register values </dd></dl>
</div>
</div>
<a id="a612155dcb290739eacc6f50e881546e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a612155dcb290739eacc6f50e881546e4">◆ </a></span>getLatestSample()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structpdumodel_1_1Ade_1_1Sample.html">Sample</a>> pdumodel::Ade::getLatestSample </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the latest raw samples. </p>
<dl class="section return"><dt>Returns</dt><dd>Vector of samples, one for each channel </dd></dl>
</div>
</div>
<a id="a07d9a55a99efea2e620168bddda47e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07d9a55a99efea2e620168bddda47e85">◆ </a></span>getMetaData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpdumodel_1_1Ade_1_1MetaData.html">MetaData</a> pdumodel::Ade::getMetaData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the ADE metadata. </p>
<dl class="section return"><dt>Returns</dt><dd>ADE metadata </dd></dl>
</div>
</div>
<a id="a5836b5c9d13e26b44e77f383c0ce7903"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5836b5c9d13e26b44e77f383c0ce7903">◆ </a></span>setCalibrationData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pdumodel::Ade::setCalibrationData </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfacepdumodel_1_1Ade.html#a2e2c3e49ecd68521d565b090e2ecf74c">RegisterMap</a> </td>
<td class="paramname"><em>regs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set new values for some or all calibration registers. </p>
<dl class="section note"><dt>Note</dt><dd>This command is only available during manufacturing!</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">regs</td><td>Map of new calibration register values</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if any parameters are invalid </dd>
<dd>
2 if the device is not in factory configuration mode </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="Ade_8idl_source.html">Ade.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>
|
