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
|
<!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/SerialPort.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">SerialPort.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 2011 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 <GsmModem.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <AnalogModem.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">/** Serial Ports */</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> module <a class="code" href="namespaceserial.html">serial</a> {</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"> /**</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Interface describing a physical serial port</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * and the devices which can be attached to it</span></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"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html"> 16</a></span>  <span class="keyword">interface </span><a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html">SerialPort_3_0_1</a> {<span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> /**</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Error codes</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#afb168ee3b3bdd4efb09f146d4395dfb2"> 20</a></span>  constant <span class="keywordtype">int</span> SUCCESS = 0; <span class="comment">///< No error</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a58d36bdbdcb1f54f2005cb0c0f728737"> 21</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_VALUE = 1; <span class="comment">///< Invalid arguments</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span><span class="comment"></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"> * Possible states the port can be in at a given time</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> */</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c"> 26</a></span>  enumeration <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c">PortState</a> {</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533ca83bbf92fa540a1bbf6c7766fd0f73dc5"> 27</a></span>  <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533ca83bbf92fa540a1bbf6c7766fd0f73dc5">CONSOLE</a>, <span class="comment">///< The console application is running on the port</span></div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caad72693f02dcbd8bf0077f7587273eca"> 28</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caad72693f02dcbd8bf0077f7587273eca">ANALOGMODEM</a>, <span class="comment">///< An analog modem is attached to the port</span></div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caf7721936c46b568e0ad3f109a4226f7d"> 29</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caf7721936c46b568e0ad3f109a4226f7d">GSMMODEM</a>, <span class="comment">///< A GSM modem is attached to the port</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533ca5ae39ef8aa023729be68c50190d7295b"> 30</a></span> <span class="comment"></span> DISCONNECTED <span class="comment">///< No device matching the configured mode is detected</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> };</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /**</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * Device type the port shall be looking for</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"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040"> 36</a></span>  enumeration <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040">DetectionType</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040ae4fb439d3d49c8239ca3184317742b7d"> 37</a></span>  <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040ae4fb439d3d49c8239ca3184317742b7d">AUTOMATIC</a>, <span class="comment">///< Try to automatically determine the connected device</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040aa9d8091b327d0d8ccda3c9b3f2dd798d"> 38</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040aa9d8091b327d0d8ccda3c9b3f2dd798d">FORCE_CONSOLE</a>, <span class="comment">///< Always assume a console (terminal) is connected</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040abda07a86416eb12b9f4bd59c0a859265"> 39</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040abda07a86416eb12b9f4bd59c0a859265">FORCE_ANALOGMODEM</a>, <span class="comment">///< Always assume an analog modem is connected</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040a4a0d3ff2ae92a7c1beca47479ffe17d3"> 40</a></span> <span class="comment"></span> FORCE_GSMMODEM <span class="comment">///< Always assume a GSM modem is connected</span></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"> /**</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * Possible baud rates</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"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1"> 46</a></span>  enumeration <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">BaudRate</a> {</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aa0f16b972a1b386477f61ea589e19978"> 47</a></span>  <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aa0f16b972a1b386477f61ea589e19978">BR1200</a>, <span class="comment">///< 1.200 kbit/s</span></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aaca524dca4b711ca56a17b960928cedb"> 48</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aaca524dca4b711ca56a17b960928cedb">BR2400</a>, <span class="comment">///< 2.400 kbit/s</span></div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a2a880a83129a4df1b39811e9937bd712"> 49</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a2a880a83129a4df1b39811e9937bd712">BR4800</a>, <span class="comment">///< 4.800 kbit/s</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1ad47deda20f8f13389647d4604b2c6303"> 50</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1ad47deda20f8f13389647d4604b2c6303">BR9600</a>, <span class="comment">///< 9.600 kbit/s</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a97126b8b819303747f08e78e18a904d0"> 51</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a97126b8b819303747f08e78e18a904d0">BR19200</a>, <span class="comment">///< 19.200 kbit/s</span></div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a72368aeb71ebbe55ed8e032824370d02"> 52</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a72368aeb71ebbe55ed8e032824370d02">BR38400</a>, <span class="comment">///< 38.400 kbit/s</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a5c8fa84f529647aae7c3fbdd5888a91d"> 53</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a5c8fa84f529647aae7c3fbdd5888a91d">BR57600</a>, <span class="comment">///< 57.600 kbit/s</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a95054b4ba19d12c7d39954667416e50e"> 54</a></span> <span class="comment"></span> BR115200 <span class="comment">///< 115.200 kbit/s</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span> };</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></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="comment"> * (Static) meta data containing port properties</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"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html"> 60</a></span>  structure <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html">MetaData</a> {</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html#aabfad13168b338b9d06c65c0a0440697"> 61</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html#aabfad13168b338b9d06c65c0a0440697">hasModemSupport</a>; <span class="comment">///< Whether or not the port can detect modems (if false,</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span><span class="comment"> ///< this port can only operate in console mode)</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span> };</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</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"> * Structure holding information about</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * the current state of the port</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"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1State.html"> 69</a></span>  structure <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1State.html">State</a> {</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1State.html#a598644000f22f30f8942466f156a79ff"> 70</a></span>  <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c">PortState</a> <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1State.html#a598644000f22f30f8942466f156a79ff">state</a>; <span class="comment">///< Current connection state</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1State.html#a6dda4948808441ef36b49651188d6896"> 71</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1State.html#a6dda4948808441ef36b49651188d6896">deviceName</a>; <span class="comment">///< Name of the device currently connected</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"></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"> * Port settings</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"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html"> 77</a></span>  structure <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">Settings</a> {</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#ab97290d507878822a70acc1d94f6cc11"> 78</a></span>  <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">BaudRate</a> <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#ab97290d507878822a70acc1d94f6cc11">consoleBaudRate</a>; <span class="comment">///< Baud rate to be used for running the console application</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#aef2409b5a32998cbf8f9c5ef053c04d2"> 79</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">BaudRate</a> <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#aef2409b5a32998cbf8f9c5ef053c04d2">modemBaudRate</a>; <span class="comment">///< Baud rate to be used for communicating with an attached modem</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#abb315145cb446fe6545b9cb88d624b50"> 80</a></span> <span class="comment"></span> <a class="code" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040">DetectionType</a> <a class="code" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#abb315145cb446fe6545b9cb88d624b50">detectType</a>; <span class="comment">///< Type of connected device to be assumed in device detection</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"></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> <span class="comment"> * Event emitted when the modem connection state changes</span></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>  valueobject ModemEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a25a8b74409081dbb340d5f17d2d28831"> 87</a></span>  Object modem; <span class="comment">///< Either a {@link AnalogModem} or a {@link GsmModem}</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#a176df73f65817129a562965471cd7b68"> 88</a></span> <span class="comment"></span> };</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></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> <span class="comment"> * Event emitted when a modem is connected</span></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>  valueobject ModemAddedEvent extends ModemEvent {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</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"> /**</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * Event emitted when a modem is disconnected</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>  valueobject ModemRemovedEvent extends ModemEvent {</div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="interfaceserial_1_1SerialPort__3__0__1.html#ab7bf27795fba66606587169bfefcb6bd"> 100</a></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="comment"> /**</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @brief Get port meta data</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> *</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @return -- Meta data</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> */</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  MetaData getMetaData();</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /**</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @brief Get current settings</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> *</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @return -- Settings</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  Settings getSettings();</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /**</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @brief Set settings</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> *</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @param settings -- new settings</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> *</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @return SUCCESS -- on success</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @return ERR_INVALID_VALUE -- if any passed value was invalid</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> */</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">int</span> setSettings(in Settings settings);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"></span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /**</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * @brief Get current port state</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> *</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @return -- Port state</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> */</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  State getState();</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"></span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> /**</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * @brief Get modem connected to port</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> *</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @return -- an instance of the connected modem (either</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * {@link AnalogModem} or {@link GsmModem})</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> */</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  Object getModem();</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  };</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> }</div><div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a0a0997dcb492c2d58ff39266c6e15040aa9d8091b327d0d8ccda3c9b3f2dd798d"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040aa9d8091b327d0d8ccda3c9b3f2dd798d">serial::SerialPort_3_0_1::FORCE_CONSOLE</a></div><div class="ttdoc">Always assume a console (terminal) is connected. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:38</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1aaca524dca4b711ca56a17b960928cedb"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aaca524dca4b711ca56a17b960928cedb">serial::SerialPort_3_0_1::BR2400</a></div><div class="ttdoc">2.400 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:48</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">serial::SerialPort_3_0_1::BaudRate</a></div><div class="ttdeci">BaudRate</div><div class="ttdoc">Possible baud rates. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:46</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1State_html"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1State.html">serial::SerialPort_3_0_1::State</a></div><div class="ttdoc">Structure holding information about the current state of the port. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:69</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1Settings_html"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">serial::SerialPort_3_0_1::Settings</a></div><div class="ttdoc">Port settings. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:77</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1a97126b8b819303747f08e78e18a904d0"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a97126b8b819303747f08e78e18a904d0">serial::SerialPort_3_0_1::BR19200</a></div><div class="ttdoc">19::200 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:51</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1MetaData_html"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html">serial::SerialPort_3_0_1::MetaData</a></div><div class="ttdoc">(Static) meta data containing port properties </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:60</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1State_html_a598644000f22f30f8942466f156a79ff"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1State.html#a598644000f22f30f8942466f156a79ff">serial::SerialPort_3_0_1::State::state</a></div><div class="ttdeci">PortState state</div><div class="ttdoc">Current connection state. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:70</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a0a0997dcb492c2d58ff39266c6e15040abda07a86416eb12b9f4bd59c0a859265"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040abda07a86416eb12b9f4bd59c0a859265">serial::SerialPort_3_0_1::FORCE_ANALOGMODEM</a></div><div class="ttdoc">Always assume an analog modem is connected. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:39</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_acffe0800621765fb4188ca84fc27533ca83bbf92fa540a1bbf6c7766fd0f73dc5"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533ca83bbf92fa540a1bbf6c7766fd0f73dc5">serial::SerialPort_3_0_1::CONSOLE</a></div><div class="ttdoc">The console application is running on the port. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:27</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a0a0997dcb492c2d58ff39266c6e15040"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040">serial::SerialPort_3_0_1::DetectionType</a></div><div class="ttdeci">DetectionType</div><div class="ttdoc">Device type the port shall be looking for. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:36</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_acffe0800621765fb4188ca84fc27533caad72693f02dcbd8bf0077f7587273eca"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caad72693f02dcbd8bf0077f7587273eca">serial::SerialPort_3_0_1::ANALOGMODEM</a></div><div class="ttdoc">An analog modem is attached to the port. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:28</div></div>
<div class="ttc" id="namespaceserial_html"><div class="ttname"><a href="namespaceserial.html">serial</a></div><div class="ttdoc">Serial Ports. </div><div class="ttdef"><b>Definition:</b> AnalogModem.idl:12</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="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1a72368aeb71ebbe55ed8e032824370d02"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a72368aeb71ebbe55ed8e032824370d02">serial::SerialPort_3_0_1::BR38400</a></div><div class="ttdoc">38::400 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:52</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_acffe0800621765fb4188ca84fc27533caf7721936c46b568e0ad3f109a4226f7d"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caf7721936c46b568e0ad3f109a4226f7d">serial::SerialPort_3_0_1::GSMMODEM</a></div><div class="ttdoc">A GSM modem is attached to the port. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:29</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1Settings_html_aef2409b5a32998cbf8f9c5ef053c04d2"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#aef2409b5a32998cbf8f9c5ef053c04d2">serial::SerialPort_3_0_1::Settings::modemBaudRate</a></div><div class="ttdeci">BaudRate modemBaudRate</div><div class="ttdoc">Baud rate to be used for communicating with an attached modem. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:79</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1MetaData_html_aabfad13168b338b9d06c65c0a0440697"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html#aabfad13168b338b9d06c65c0a0440697">serial::SerialPort_3_0_1::MetaData::hasModemSupport</a></div><div class="ttdeci">boolean hasModemSupport</div><div class="ttdoc">Whether or not the port can detect modems (if false, this port can only operate in console mode) ...</div><div class="ttdef"><b>Definition:</b> SerialPort.idl:61</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1a2a880a83129a4df1b39811e9937bd712"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a2a880a83129a4df1b39811e9937bd712">serial::SerialPort_3_0_1::BR4800</a></div><div class="ttdoc">4.800 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:49</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1State_html_a6dda4948808441ef36b49651188d6896"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1State.html#a6dda4948808441ef36b49651188d6896">serial::SerialPort_3_0_1::State::deviceName</a></div><div class="ttdeci">string deviceName</div><div class="ttdoc">Name of the device currently connected. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:71</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a0a0997dcb492c2d58ff39266c6e15040ae4fb439d3d49c8239ca3184317742b7d"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040ae4fb439d3d49c8239ca3184317742b7d">serial::SerialPort_3_0_1::AUTOMATIC</a></div><div class="ttdoc">Try to automatically determine the connected device. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:37</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html">serial::SerialPort_3_0_1</a></div><div class="ttdoc">Interface describing a physical serial port and the devices which can be attached to it...</div><div class="ttdef"><b>Definition:</b> SerialPort.idl:16</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1Settings_html_abb315145cb446fe6545b9cb88d624b50"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#abb315145cb446fe6545b9cb88d624b50">serial::SerialPort_3_0_1::Settings::detectType</a></div><div class="ttdeci">DetectionType detectType</div><div class="ttdoc">Type of connected device to be assumed in device detection. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:80</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_acffe0800621765fb4188ca84fc27533c"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c">serial::SerialPort_3_0_1::PortState</a></div><div class="ttdeci">PortState</div><div class="ttdoc">Possible states the port can be in at a given time. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:26</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1a5c8fa84f529647aae7c3fbdd5888a91d"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a5c8fa84f529647aae7c3fbdd5888a91d">serial::SerialPort_3_0_1::BR57600</a></div><div class="ttdoc">57::600 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:53</div></div>
<div class="ttc" id="structserial_1_1SerialPort__3__0__1_1_1Settings_html_ab97290d507878822a70acc1d94f6cc11"><div class="ttname"><a href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#ab97290d507878822a70acc1d94f6cc11">serial::SerialPort_3_0_1::Settings::consoleBaudRate</a></div><div class="ttdeci">BaudRate consoleBaudRate</div><div class="ttdoc">Baud rate to be used for running the console application. </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:78</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1ad47deda20f8f13389647d4604b2c6303"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1ad47deda20f8f13389647d4604b2c6303">serial::SerialPort_3_0_1::BR9600</a></div><div class="ttdoc">9.600 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:50</div></div>
<div class="ttc" id="interfaceserial_1_1SerialPort__3__0__1_html_a1ae9a9fed988ddfdfd0fa4bd59de7ed1aa0f16b972a1b386477f61ea589e19978"><div class="ttname"><a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aa0f16b972a1b386477f61ea589e19978">serial::SerialPort_3_0_1::BR1200</a></div><div class="ttdoc">1.200 kbit/s </div><div class="ttdef"><b>Definition:</b> SerialPort.idl:47</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>
|
