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
|
<!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/Controller.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">Controller.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 2010 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">#ifndef __PDUMODEL_CONTROLLER_IDL__</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define __PDUMODEL_CONTROLLER_IDL__</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <Event.idl></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></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"> * PDU Model</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> module <a class="code" href="namespacepdumodel.html">pdumodel</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> /** Slave controller statistics */</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structpdumodel_1_1CtrlStatistic.html"> 17</a></span>  structure <a class="code" href="structpdumodel_1_1CtrlStatistic.html">CtrlStatistic</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structpdumodel_1_1CtrlStatistic.html#a3e6346400b0e8baa54fd861c1aa8093e"> 18</a></span>  <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1CtrlStatistic.html#a3e6346400b0e8baa54fd861c1aa8093e">masterCSumErrCnt</a>; <span class="comment">///< Master CRC error counter</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structpdumodel_1_1CtrlStatistic.html#ab9ebaa31468ae634b992e1b93fa7712b"> 19</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1CtrlStatistic.html#ab9ebaa31468ae634b992e1b93fa7712b">slaveCSumErrCnt</a>; <span class="comment">///< Slave CRC error counter</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structpdumodel_1_1CtrlStatistic.html#a65200fd7aae77e42a569a6d30a06a882"> 20</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1CtrlStatistic.html#a65200fd7aae77e42a569a6d30a06a882">timeoutCnt</a>; <span class="comment">///< Master timeout counter</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structpdumodel_1_1CtrlStatistic.html#a4bee3f420adbc1991eb6475b5ae29641"> 21</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1CtrlStatistic.html#a4bee3f420adbc1991eb6475b5ae29641">resetCnt</a>; <span class="comment">///< Controller reset counter</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structpdumodel_1_1CtrlStatistic.html#afe694840c51ab4ed28f29028175bee75"> 22</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1CtrlStatistic.html#afe694840c51ab4ed28f29028175bee75">emResetCnt</a>; <span class="comment">///< Energy meter reset counter</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span> };</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /** Slave controller interface */</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html"> 26</a></span>  <span class="keyword">interface </span><a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html">Controller_4_0_1</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#af24302d0ce0fede096617466159ac98d"> 27</a></span>  constant <span class="keywordtype">int</span> ERR_NOT_SUPPORTED = 1; <span class="comment">///< Operation not supported</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /** Communication status */</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75b"> 30</a></span>  enumeration <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75b">Status</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75ba4b7e5cd68582a54c35bc782b93ae393b"> 31</a></span>  <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75ba4b7e5cd68582a54c35bc782b93ae393b">OK</a>, <span class="comment">///< Communication with controller is known to be working</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bad364ae7e2128a491934aa3d5b899fa82"> 32</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bad364ae7e2128a491934aa3d5b899fa82">COMMUNICATION_UNSTABLE</a>, <span class="comment">///< Controller can be communicated with sporadically</span></div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bab1440efa7452acf6ea4f1ec1945cb681"> 33</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bab1440efa7452acf6ea4f1ec1945cb681">COMMUNICATION_FAILURE</a>, <span class="comment">///< Controller can't be communicated with</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75baf34245916ff2648dc600cac77fadf01d"> 34</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75baf34245916ff2648dc600cac77fadf01d">UNKNOWN</a>, <span class="comment">///< Communication status is unknown, e.g. after startup</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75ba2b69c70d8137060bb5101d12f2a6917e"> 35</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75ba2b69c70d8137060bb5101d12f2a6917e">INCOMPATIBLE</a>, <span class="comment">///< The characteristics of the controller don't meet the expectations</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bac99c9259138c31c114816b42301e9459"> 36</a></span> <span class="comment"></span> FIRMWARE_UPDATE <span class="comment">///< A controller firmware update is in progress</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"> /** Slave controller type */</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364"> 40</a></span>  enumeration <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364">Type</a> {</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364adcb5b43a1ac7fa01439cc165d4b3b791"> 41</a></span>  <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364adcb5b43a1ac7fa01439cc165d4b3b791">OUTLET_CTRL</a>, <span class="comment">///< %Outlet controller</span></div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364a5d8bb878d1fdaa1a39a24e8849855477"> 42</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364a5d8bb878d1fdaa1a39a24e8849855477">INLET_CTRL</a>, <span class="comment">///< %Inlet controller</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364a17ac800e28f7037fb5018d7b686c4530"> 43</a></span> <span class="comment"></span> METER_CTRL <span class="comment">///< %General metering controller</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"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /** Slave controller metadata */</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html"> 47</a></span>  structure <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html">MetaData</a> {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a48bfc1f2c99cbb13b6ef750bf2d5c306"> 48</a></span>  <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364">Type</a> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a48bfc1f2c99cbb13b6ef750bf2d5c306">type</a>; <span class="comment">///< %Controller type</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#abd1e12b5fa77512600bbd98db9247297"> 49</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#abd1e12b5fa77512600bbd98db9247297">address</a>; <span class="comment">///< Slave address</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a056a87590d8a2aafdd9201cebdddab16"> 50</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a056a87590d8a2aafdd9201cebdddab16">magic</a>; <span class="comment">///< Magic code</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a54437108b1d448c89e99f8f61ed7a4df"> 51</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a54437108b1d448c89e99f8f61ed7a4df">versionAvailable</a>; <span class="comment">///< \c true if version information and serial number is available</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#ac7b99095e7afc9aaa54423be5aaa44f8"> 52</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#ac7b99095e7afc9aaa54423be5aaa44f8">fwAppVersion</a>; <span class="comment">///< Firmware application version; 0 if unavailable</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a6f11a6fca1b16df5d6a6bf9dccaf578b"> 53</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a6f11a6fca1b16df5d6a6bf9dccaf578b">fwBootVersion</a>; <span class="comment">///< Firmware bootloader version; 0 if unavailable</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a93dd92f9687f6dd5b6fb59bd02120bbe"> 54</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a93dd92f9687f6dd5b6fb59bd02120bbe">hwVersion</a>; <span class="comment">///< Hardware version; 0 if unavailable</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a0507920c924b6b736a68d1d2a7512417"> 55</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a0507920c924b6b736a68d1d2a7512417">serial</a>; <span class="comment">///< Serial number; empty if unavailable</span></div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#aa224e8de1d0a002b4142b5144499b8d8"> 56</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#aa224e8de1d0a002b4142b5144499b8d8">haveResetCnt</a>; <span class="comment">///< \c true if controller reset counter is available</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a8f388f0b5a034172f8f62eabd9003379"> 57</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a8f388f0b5a034172f8f62eabd9003379">haveEmResetCnt</a>; <span class="comment">///< \c true if energy meter reset counter is available</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"></span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /** Event: Controller communication status has changed */</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  valueobject StatusChangedEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#ad8c548fd793b322451b00dad85fba274"> 62</a></span>  <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75b">Status</a> oldStatus; <span class="comment">///< Status before change</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#a9e5e08b1df41e0e325c7250d907f51f0"> 63</a></span> <span class="comment"></span> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75b">Status</a> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#a9e5e08b1df41e0e325c7250d907f51f0">newStatus</a>; <span class="comment">///< Status after change</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#aa27ccf5237b3808e1d061e668dffaa1c"> 64</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /** Event: Controller metadata has changed */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  valueobject MetaDataChangedEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  MetaData oldMetaData; <span class="comment">///< Metadata before change</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="interfacepdumodel_1_1Controller__4__0__1.html#af815c7a370b7d0d904c258fb06f80052"> 69</a></span> <span class="comment"></span> <a class="code" href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html">MetaData</a> <a class="code" href="interfacepdumodel_1_1Controller__4__0__1.html#af815c7a370b7d0d904c258fb06f80052">newMetaData</a>; <span class="comment">///< Metadata after change</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"></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> <span class="comment"> * Retrieve the current status of communication with controller</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> *</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @return communication status</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> */</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  Status getCommunicationStatus();</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"> /**</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Retrieve statistics</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> *</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @return statistics of %Controller</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="structpdumodel_1_1CtrlStatistic.html">CtrlStatistic</a> getStatistics();</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /**</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * Retrieve the slave controller metadata.</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> *</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @return %Controller metadata</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>  MetaData getMetaData();</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"> /**</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * Reset this slave controller.</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="comment"> * Note: Depending on the hardware setup of the specific device, calling</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * this method may also cause other slave controllers to be reset.</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"> * @return 0 on success</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * ERR_NOT_SUPPORTED if the hardware setup doesn't allow resetting the controller</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> */</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">int</span> reset();</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structpdumodel_1_1CtrlStatistic_html_ab9ebaa31468ae634b992e1b93fa7712b"><div class="ttname"><a href="structpdumodel_1_1CtrlStatistic.html#ab9ebaa31468ae634b992e1b93fa7712b">pdumodel::CtrlStatistic::slaveCSumErrCnt</a></div><div class="ttdeci">int slaveCSumErrCnt</div><div class="ttdoc">Slave CRC error counter. </div><div class="ttdef"><b>Definition:</b> Controller.idl:19</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_ac7b99095e7afc9aaa54423be5aaa44f8"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#ac7b99095e7afc9aaa54423be5aaa44f8">pdumodel::Controller_4_0_1::MetaData::fwAppVersion</a></div><div class="ttdeci">int fwAppVersion</div><div class="ttdoc">Firmware application version; 0 if unavailable. </div><div class="ttdef"><b>Definition:</b> Controller.idl:52</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a93dd92f9687f6dd5b6fb59bd02120bbe"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a93dd92f9687f6dd5b6fb59bd02120bbe">pdumodel::Controller_4_0_1::MetaData::hwVersion</a></div><div class="ttdeci">int hwVersion</div><div class="ttdoc">Hardware version; 0 if unavailable. </div><div class="ttdef"><b>Definition:</b> Controller.idl:54</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html">pdumodel::Controller_4_0_1::MetaData</a></div><div class="ttdoc">Slave controller metadata. </div><div class="ttdef"><b>Definition:</b> Controller.idl:47</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_a8aa8521e3287f0288c7ac543cbb1d364adcb5b43a1ac7fa01439cc165d4b3b791"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364adcb5b43a1ac7fa01439cc165d4b3b791">pdumodel::Controller_4_0_1::OUTLET_CTRL</a></div><div class="ttdoc">Outlet controller </div><div class="ttdef"><b>Definition:</b> Controller.idl:41</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_aa86cdb2df83907eee7a241b92fbee75ba2b69c70d8137060bb5101d12f2a6917e"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75ba2b69c70d8137060bb5101d12f2a6917e">pdumodel::Controller_4_0_1::INCOMPATIBLE</a></div><div class="ttdoc">The characteristics of the controller don&#39;t meet the expectations. </div><div class="ttdef"><b>Definition:</b> Controller.idl:35</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_aa224e8de1d0a002b4142b5144499b8d8"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#aa224e8de1d0a002b4142b5144499b8d8">pdumodel::Controller_4_0_1::MetaData::haveResetCnt</a></div><div class="ttdeci">boolean haveResetCnt</div><div class="ttdoc">true if controller reset counter is available </div><div class="ttdef"><b>Definition:</b> Controller.idl:56</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_a9e5e08b1df41e0e325c7250d907f51f0"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#a9e5e08b1df41e0e325c7250d907f51f0">pdumodel::Controller_4_0_1::newStatus</a></div><div class="ttdeci">Status newStatus</div><div class="ttdoc">Status after change. </div><div class="ttdef"><b>Definition:</b> Controller.idl:63</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_abd1e12b5fa77512600bbd98db9247297"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#abd1e12b5fa77512600bbd98db9247297">pdumodel::Controller_4_0_1::MetaData::address</a></div><div class="ttdeci">string address</div><div class="ttdoc">Slave address. </div><div class="ttdef"><b>Definition:</b> Controller.idl:49</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a6f11a6fca1b16df5d6a6bf9dccaf578b"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a6f11a6fca1b16df5d6a6bf9dccaf578b">pdumodel::Controller_4_0_1::MetaData::fwBootVersion</a></div><div class="ttdeci">int fwBootVersion</div><div class="ttdoc">Firmware bootloader version; 0 if unavailable. </div><div class="ttdef"><b>Definition:</b> Controller.idl:53</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_aa86cdb2df83907eee7a241b92fbee75baf34245916ff2648dc600cac77fadf01d"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75baf34245916ff2648dc600cac77fadf01d">pdumodel::Controller_4_0_1::UNKNOWN</a></div><div class="ttdoc">Communication status is unknown, e.g. after startup. </div><div class="ttdef"><b>Definition:</b> Controller.idl:34</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a056a87590d8a2aafdd9201cebdddab16"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a056a87590d8a2aafdd9201cebdddab16">pdumodel::Controller_4_0_1::MetaData::magic</a></div><div class="ttdeci">int magic</div><div class="ttdoc">Magic code. </div><div class="ttdef"><b>Definition:</b> Controller.idl:50</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="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a48bfc1f2c99cbb13b6ef750bf2d5c306"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a48bfc1f2c99cbb13b6ef750bf2d5c306">pdumodel::Controller_4_0_1::MetaData::type</a></div><div class="ttdeci">Type type</div><div class="ttdoc">Controller type </div><div class="ttdef"><b>Definition:</b> Controller.idl:48</div></div>
<div class="ttc" id="structpdumodel_1_1CtrlStatistic_html_a3e6346400b0e8baa54fd861c1aa8093e"><div class="ttname"><a href="structpdumodel_1_1CtrlStatistic.html#a3e6346400b0e8baa54fd861c1aa8093e">pdumodel::CtrlStatistic::masterCSumErrCnt</a></div><div class="ttdeci">int masterCSumErrCnt</div><div class="ttdoc">Master CRC error counter. </div><div class="ttdef"><b>Definition:</b> Controller.idl:18</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_a8aa8521e3287f0288c7ac543cbb1d364"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364">pdumodel::Controller_4_0_1::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">Slave controller type. </div><div class="ttdef"><b>Definition:</b> Controller.idl:40</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html">pdumodel::Controller_4_0_1</a></div><div class="ttdoc">Slave controller interface. </div><div class="ttdef"><b>Definition:</b> Controller.idl:26</div></div>
<div class="ttc" id="namespacepdumodel_html"><div class="ttname"><a href="namespacepdumodel.html">pdumodel</a></div><div class="ttdoc">PDU Model. </div><div class="ttdef"><b>Definition:</b> Ade.idl:12</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a54437108b1d448c89e99f8f61ed7a4df"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a54437108b1d448c89e99f8f61ed7a4df">pdumodel::Controller_4_0_1::MetaData::versionAvailable</a></div><div class="ttdeci">boolean versionAvailable</div><div class="ttdoc">true if version information and serial number is available </div><div class="ttdef"><b>Definition:</b> Controller.idl:51</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_aa86cdb2df83907eee7a241b92fbee75b"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75b">pdumodel::Controller_4_0_1::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Communication status. </div><div class="ttdef"><b>Definition:</b> Controller.idl:30</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_aa86cdb2df83907eee7a241b92fbee75bab1440efa7452acf6ea4f1ec1945cb681"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bab1440efa7452acf6ea4f1ec1945cb681">pdumodel::Controller_4_0_1::COMMUNICATION_FAILURE</a></div><div class="ttdoc">Controller can&#39;t be communicated with. </div><div class="ttdef"><b>Definition:</b> Controller.idl:33</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a8f388f0b5a034172f8f62eabd9003379"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a8f388f0b5a034172f8f62eabd9003379">pdumodel::Controller_4_0_1::MetaData::haveEmResetCnt</a></div><div class="ttdeci">boolean haveEmResetCnt</div><div class="ttdoc">true if energy meter reset counter is available </div><div class="ttdef"><b>Definition:</b> Controller.idl:57</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_a8aa8521e3287f0288c7ac543cbb1d364a5d8bb878d1fdaa1a39a24e8849855477"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#a8aa8521e3287f0288c7ac543cbb1d364a5d8bb878d1fdaa1a39a24e8849855477">pdumodel::Controller_4_0_1::INLET_CTRL</a></div><div class="ttdoc">Inlet controller </div><div class="ttdef"><b>Definition:</b> Controller.idl:42</div></div>
<div class="ttc" id="structpdumodel_1_1CtrlStatistic_html_a4bee3f420adbc1991eb6475b5ae29641"><div class="ttname"><a href="structpdumodel_1_1CtrlStatistic.html#a4bee3f420adbc1991eb6475b5ae29641">pdumodel::CtrlStatistic::resetCnt</a></div><div class="ttdeci">int resetCnt</div><div class="ttdoc">Controller reset counter. </div><div class="ttdef"><b>Definition:</b> Controller.idl:21</div></div>
<div class="ttc" id="structpdumodel_1_1CtrlStatistic_html_afe694840c51ab4ed28f29028175bee75"><div class="ttname"><a href="structpdumodel_1_1CtrlStatistic.html#afe694840c51ab4ed28f29028175bee75">pdumodel::CtrlStatistic::emResetCnt</a></div><div class="ttdeci">int emResetCnt</div><div class="ttdoc">Energy meter reset counter. </div><div class="ttdef"><b>Definition:</b> Controller.idl:22</div></div>
<div class="ttc" id="structpdumodel_1_1CtrlStatistic_html_a65200fd7aae77e42a569a6d30a06a882"><div class="ttname"><a href="structpdumodel_1_1CtrlStatistic.html#a65200fd7aae77e42a569a6d30a06a882">pdumodel::CtrlStatistic::timeoutCnt</a></div><div class="ttdeci">int timeoutCnt</div><div class="ttdoc">Master timeout counter. </div><div class="ttdef"><b>Definition:</b> Controller.idl:20</div></div>
<div class="ttc" id="structpdumodel_1_1CtrlStatistic_html"><div class="ttname"><a href="structpdumodel_1_1CtrlStatistic.html">pdumodel::CtrlStatistic</a></div><div class="ttdoc">Slave controller statistics. </div><div class="ttdef"><b>Definition:</b> Controller.idl:17</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_aa86cdb2df83907eee7a241b92fbee75bad364ae7e2128a491934aa3d5b899fa82"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75bad364ae7e2128a491934aa3d5b899fa82">pdumodel::Controller_4_0_1::COMMUNICATION_UNSTABLE</a></div><div class="ttdoc">Controller can be communicated with sporadically. </div><div class="ttdef"><b>Definition:</b> Controller.idl:32</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_aa86cdb2df83907eee7a241b92fbee75ba4b7e5cd68582a54c35bc782b93ae393b"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#aa86cdb2df83907eee7a241b92fbee75ba4b7e5cd68582a54c35bc782b93ae393b">pdumodel::Controller_4_0_1::OK</a></div><div class="ttdoc">Communication with controller is known to be working. </div><div class="ttdef"><b>Definition:</b> Controller.idl:31</div></div>
<div class="ttc" id="structpdumodel_1_1Controller__4__0__1_1_1MetaData_html_a0507920c924b6b736a68d1d2a7512417"><div class="ttname"><a href="structpdumodel_1_1Controller__4__0__1_1_1MetaData.html#a0507920c924b6b736a68d1d2a7512417">pdumodel::Controller_4_0_1::MetaData::serial</a></div><div class="ttdeci">string serial</div><div class="ttdoc">Serial number; empty if unavailable. </div><div class="ttdef"><b>Definition:</b> Controller.idl:55</div></div>
<div class="ttc" id="interfacepdumodel_1_1Controller__4__0__1_html_af815c7a370b7d0d904c258fb06f80052"><div class="ttname"><a href="interfacepdumodel_1_1Controller__4__0__1.html#af815c7a370b7d0d904c258fb06f80052">pdumodel::Controller_4_0_1::newMetaData</a></div><div class="ttdeci">MetaData newMetaData</div><div class="ttdoc">Metadata after change. </div><div class="ttdef"><b>Definition:</b> Controller.idl:69</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>
|
