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
221
222
223
224
225
226
227
228
229
|
<!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: datapush Module 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">datapush Module Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The datapush module contains the definition of the JSON-encoded datapush messages.
<a href="#details">More...</a></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="structdatapush_1_1AssetLogPushMessage.html">AssetLogPushMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Message for pushing one full log record for all sensors. <a href="structdatapush_1_1AssetLogPushMessage.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="structdatapush_1_1AssetStrip.html">AssetStrip</a></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="structdatapush_1_1AssetStripInfo.html">AssetStripInfo</a></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="structdatapush_1_1AssetStripsMessage.html">AssetStripsMessage</a></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="structdatapush_1_1Device.html">Device</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structdatapush_1_1Device.html" title="Device information. ">Device</a> information. <a href="structdatapush_1_1Device.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="structdatapush_1_1LogRow.html">LogRow</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">One full log row (one timestamp, mulitple sensors) <a href="structdatapush_1_1LogRow.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="structdatapush_1_1Sensor.html">Sensor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structdatapush_1_1Sensor.html" title="Sensor information. ">Sensor</a> information. <a href="structdatapush_1_1Sensor.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="structdatapush_1_1SensorLogPushMessage.html">SensorLogPushMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Message for pushing one full log record for all sensors. <a href="structdatapush_1_1SensorLogPushMessage.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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a482ffebfde069cdd5696c4a69cbe4831"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831">PowerLine</a> { <br />
  <a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831ac9de0816946bd92aee6fb5489069a42c">L1</a>,
<a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831ace25b1e7d74a2295b5fc1a607a88cf75">L2</a>,
<a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831adfa2a8587a1ee5b433c4e88d0b617c6c">L3</a>,
<a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831a384b01064b5c0a357dab1d7ce004f9a5">NEUTRAL</a>,
<br />
  <a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831a3c71a02e1241e3be67a2048c96780885">EARTH</a>
<br />
}</td></tr>
<tr class="separator:a482ffebfde069cdd5696c4a69cbe4831"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa252eaab6e6b099eae669566b9e2ec4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4">DeviceType</a> { <br />
  <a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a79895b0366dce9ffc8eff582f7af3ada">INLET</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a357c38ad2f3c88c93c5c5381db8c4d30">INLET_POLE</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a82dae3b7266ae7ea222d2a9a4032cf5f">OCP</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a2f535ee03bed6cef93c7ad6295c1643f">OCP_POLE</a>,
<br />
  <a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4aad27f7f0753f9d0de185fd1f1ee580d9">OUTLET</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a5ba465c1043ddcef8b02300709b5ad57">OUTLET_POLE</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4affd5d4ecc7bc70a0582eaeb2ae2ec037">WIRE</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a279d0f8272c3a9ba5225f8ba9214f172">WIRE_POLE</a>,
<br />
  <a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4af4017c71524c2f64f1b1dcd2637cf866">TRANSFER_SWITCH</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4ad0db831d3cba9d984e74ae6cd097b2d6">TRANSFER_SWITCH_POLE</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a1be349ed474920974bdf8ba9af455023">EXTERNAL_SENSOR</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4aa02399eee0945a0e48adb427b8c3e07d">POWER_METER</a>,
<br />
  <a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a3a0047315d35bb09f6406eb635103480">POWER_METER_POLE</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4a0bb7c041d25ae42dfd68514370712abd">PANEL_CIRCUIT</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4aa5e04334e2f86e5f611a1373d1031d6e">PANEL_CIRCUIT_POLE</a>,
<a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4ac5f5c17cf13f0210a09cbcc53a6660a4">PDU</a>,
<br />
  <a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4aa49e66409ecfd7cf91a24f8ed2d43623">OUTLET_GROUP</a>
<br />
}</td></tr>
<tr class="memdesc:aaa252eaab6e6b099eae669566b9e2ec4"><td class="mdescLeft"> </td><td class="mdescRight">Device type. <a href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4">More...</a><br /></td></tr>
<tr class="separator:aaa252eaab6e6b099eae669566b9e2ec4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The datapush module contains the definition of the JSON-encoded datapush messages. </p>
<p>The standard rules for enconding apply.</p>
<p><a class="el" href="datapush_example.html">Example of JSON-encoded Datapush message</a> </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="aaa252eaab6e6b099eae669566b9e2ec4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa252eaab6e6b099eae669566b9e2ec4">◆ </a></span>DeviceType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacedatapush.html#aaa252eaab6e6b099eae669566b9e2ec4">datapush::DeviceType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structdatapush_1_1Device.html" title="Device information. ">Device</a> type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a79895b0366dce9ffc8eff582f7af3ada"></a>INLET </td><td class="fielddoc"><p>Inlet. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a357c38ad2f3c88c93c5c5381db8c4d30"></a>INLET_POLE </td><td class="fielddoc"><p>Inlet Pole. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a82dae3b7266ae7ea222d2a9a4032cf5f"></a>OCP </td><td class="fielddoc"><p>Overcurrent Protector. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a2f535ee03bed6cef93c7ad6295c1643f"></a>OCP_POLE </td><td class="fielddoc"><p>Overcurrent Protector Pole. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4aad27f7f0753f9d0de185fd1f1ee580d9"></a>OUTLET </td><td class="fielddoc"><p>Outlet. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a5ba465c1043ddcef8b02300709b5ad57"></a>OUTLET_POLE </td><td class="fielddoc"><p>Outlet Pole. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4affd5d4ecc7bc70a0582eaeb2ae2ec037"></a>WIRE </td><td class="fielddoc"><p>Wire. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a279d0f8272c3a9ba5225f8ba9214f172"></a>WIRE_POLE </td><td class="fielddoc"><p>Wire Pole. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4af4017c71524c2f64f1b1dcd2637cf866"></a>TRANSFER_SWITCH </td><td class="fielddoc"><p>Transfer Switch. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4ad0db831d3cba9d984e74ae6cd097b2d6"></a>TRANSFER_SWITCH_POLE </td><td class="fielddoc"><p>Transfer Switch Pole. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a1be349ed474920974bdf8ba9af455023"></a>EXTERNAL_SENSOR </td><td class="fielddoc"><p>External <a class="el" href="structdatapush_1_1Sensor.html" title="Sensor information. ">Sensor</a>. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4aa02399eee0945a0e48adb427b8c3e07d"></a>POWER_METER </td><td class="fielddoc"><p>Power Meter. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a3a0047315d35bb09f6406eb635103480"></a>POWER_METER_POLE </td><td class="fielddoc"><p>Power Meter Pole. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4a0bb7c041d25ae42dfd68514370712abd"></a>PANEL_CIRCUIT </td><td class="fielddoc"><p>Circuit in a PMC Panel. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4aa5e04334e2f86e5f611a1373d1031d6e"></a>PANEL_CIRCUIT_POLE </td><td class="fielddoc"><p>Circuit Pole in a PMC Panel. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4ac5f5c17cf13f0210a09cbcc53a6660a4"></a>PDU </td><td class="fielddoc"><p>PDU global. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa252eaab6e6b099eae669566b9e2ec4aa49e66409ecfd7cf91a24f8ed2d43623"></a>OUTLET_GROUP </td><td class="fielddoc"><p>Outlet group. </p>
</td></tr>
</table>
</div>
</div>
<a id="a482ffebfde069cdd5696c4a69cbe4831"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a482ffebfde069cdd5696c4a69cbe4831">◆ </a></span>PowerLine</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacedatapush.html#a482ffebfde069cdd5696c4a69cbe4831">datapush::PowerLine</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a482ffebfde069cdd5696c4a69cbe4831ac9de0816946bd92aee6fb5489069a42c"></a>L1 </td><td class="fielddoc"><p>Line 1. </p>
</td></tr>
<tr><td class="fieldname"><a id="a482ffebfde069cdd5696c4a69cbe4831ace25b1e7d74a2295b5fc1a607a88cf75"></a>L2 </td><td class="fielddoc"><p>Line 2. </p>
</td></tr>
<tr><td class="fieldname"><a id="a482ffebfde069cdd5696c4a69cbe4831adfa2a8587a1ee5b433c4e88d0b617c6c"></a>L3 </td><td class="fielddoc"><p>Line 3. </p>
</td></tr>
<tr><td class="fieldname"><a id="a482ffebfde069cdd5696c4a69cbe4831a384b01064b5c0a357dab1d7ce004f9a5"></a>NEUTRAL </td><td class="fielddoc"><p>Neutral. </p>
</td></tr>
<tr><td class="fieldname"><a id="a482ffebfde069cdd5696c4a69cbe4831a3c71a02e1241e3be67a2048c96780885"></a>EARTH </td><td class="fielddoc"><p>Earth. </p>
</td></tr>
</table>
</div>
</div>
</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>
|
