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
|
<!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/InternalBeeper.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">InternalBeeper.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 2014 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">#include <Event.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <UserEvent.idl></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> <span class="comment"> * Human Machine Interface</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> module <a class="code" href="namespacehmi.html">hmi</a> {</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"> /** Internal beeper interface */</span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html"> 15</a></span>  <span class="keyword">interface </span><a class="code" href="interfacehmi_1_1InternalBeeper__2__0__1.html">InternalBeeper_2_0_1</a> {<span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> /** Activation state */</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87"> 17</a></span>  enumeration <a class="code" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">State</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87ad37b7fdbc4b7a9180f3a5d46130239a9"> 18</a></span>  <a class="code" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87ad37b7fdbc4b7a9180f3a5d46130239a9">OFF</a>, <span class="comment">///< Beeper is currently off</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87a87222916ec38505e5c31ef945ba56e8f"> 19</a></span> <span class="comment"></span> <a class="code" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87a87222916ec38505e5c31ef945ba56e8f">ON_NOTIFICATION</a>, <span class="comment">///< Beeper is currently active due to an internal alarm notification</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87afca0899fdc112a585eabf74eea02e0f9"> 20</a></span> <span class="comment"></span> ON_ACTIVATION <span class="comment">///< Beeper is currently active due to an external activation</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></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"> /** Event: The beeper has been muted or unmuted */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  valueobject MuteChangedEvent extends <span class="keyword">event</span>.UserEvent {</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a7c1fadbad489106ee21e3ed7a7789661"> 25</a></span>  <span class="keywordtype">boolean</span> muted;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a80f19e586dc22a5b0417fd903d4c719c"> 26</a></span>  };</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /** Event: The beeper activation status has changed */</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  valueobject StateChangedEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  State state; <span class="comment">///< The current beeper state</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a0f50301e6bd3b17d58d7c0064ddda70d"> 31</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="interfacehmi_1_1InternalBeeper__2__0__1.html#a0f50301e6bd3b17d58d7c0064ddda70d">reason</a>; <span class="comment">///< Activation reason</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> <span class="keywordtype">boolean</span> mutedTemporarily;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  };</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /**</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * Mute beeper, turn off all internal alarm notifications.</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"> * @param mute \c true to mute beeper, \c false for normal mode</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="keywordtype">void</span> mute(in <span class="keywordtype">boolean</span> muted);</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="comment"> /**</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * Check whether beeper is currently muted</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"> * @return \c true if muted, \c false if not</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">boolean</span> isMuted();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /**</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * Activate the beeper for a given time.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> *</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * @param activate Whether to turn on or off the beeper</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @param reason Description of the reason to turn on the beeper</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * (only valid whtn turning on the beeper)</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @param timeout Activation timeout in milliseconds</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * (only valid when turning on the beeper, 0 = infinite activation)</span></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="keywordtype">void</span> activate(in <span class="keywordtype">boolean</span> on, in <span class="keywordtype">string</span> reason, in <span class="keywordtype">int</span> timeout);</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"> /**</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * Retrieve the current beeper activation state.</span></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"> * @param reason Return value for activation reason if the beeper</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * is currently active</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @param mutedTemporarily Whether the beeper is currently muted due to a call</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * to {@link muteCurrentActivation}.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @return The current beeper state</span></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>  State getState(out <span class="keywordtype">string</span> reason, out <span class="keywordtype">boolean</span> mutedTemporarily);</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"> * Mute the beeper for the current activation.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> *</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * If the beeper is currently on, it will be turned off until another call to</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * the {@link activate} method or until a new internal notification happens.</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>  <span class="keywordtype">void</span> muteCurrentActivation();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div><div class="ttc" id="interfacehmi_1_1InternalBeeper__2__0__1_html_ac34fc219cab2112e86c323ad0a407e87a87222916ec38505e5c31ef945ba56e8f"><div class="ttname"><a href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87a87222916ec38505e5c31ef945ba56e8f">hmi::InternalBeeper_2_0_1::ON_NOTIFICATION</a></div><div class="ttdoc">Beeper is currently active due to an internal alarm notification. </div><div class="ttdef"><b>Definition:</b> InternalBeeper.idl:19</div></div>
<div class="ttc" id="interfacehmi_1_1InternalBeeper__2__0__1_html_a0f50301e6bd3b17d58d7c0064ddda70d"><div class="ttname"><a href="interfacehmi_1_1InternalBeeper__2__0__1.html#a0f50301e6bd3b17d58d7c0064ddda70d">hmi::InternalBeeper_2_0_1::reason</a></div><div class="ttdeci">string reason</div><div class="ttdoc">Activation reason. </div><div class="ttdef"><b>Definition:</b> InternalBeeper.idl:31</div></div>
<div class="ttc" id="interfacehmi_1_1InternalBeeper__2__0__1_html_ac34fc219cab2112e86c323ad0a407e87ad37b7fdbc4b7a9180f3a5d46130239a9"><div class="ttname"><a href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87ad37b7fdbc4b7a9180f3a5d46130239a9">hmi::InternalBeeper_2_0_1::OFF</a></div><div class="ttdoc">Beeper is currently off. </div><div class="ttdef"><b>Definition:</b> InternalBeeper.idl:18</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="namespacehmi_html"><div class="ttname"><a href="namespacehmi.html">hmi</a></div><div class="ttdoc">Human Machine Interface. </div><div class="ttdef"><b>Definition:</b> ExternalBeeper.idl:14</div></div>
<div class="ttc" id="interfacehmi_1_1InternalBeeper__2__0__1_html_ac34fc219cab2112e86c323ad0a407e87"><div class="ttname"><a href="interfacehmi_1_1InternalBeeper__2__0__1.html#ac34fc219cab2112e86c323ad0a407e87">hmi::InternalBeeper_2_0_1::State</a></div><div class="ttdeci">State</div><div class="ttdoc">Activation state. </div><div class="ttdef"><b>Definition:</b> InternalBeeper.idl:17</div></div>
<div class="ttc" id="interfacehmi_1_1InternalBeeper__2__0__1_html"><div class="ttname"><a href="interfacehmi_1_1InternalBeeper__2__0__1.html">hmi::InternalBeeper_2_0_1</a></div><div class="ttdoc">Internal beeper interface. </div><div class="ttdef"><b>Definition:</b> InternalBeeper.idl:15</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>
|
