1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
<!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: serial::SerialPort_3_0_1 Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceserial.html">serial</a></li><li class="navelem"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html">SerialPort_3_0_1</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfaceserial_1_1SerialPort__3__0__1-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">serial::SerialPort_3_0_1 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface describing a physical serial port and the devices which can be attached to it.
<a href="interfaceserial_1_1SerialPort__3__0__1.html#details">More...</a></p>
<p><code>import"<a class="el" href="SerialPort_8idl_source.html">SerialPort.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html">MetaData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">(Static) meta data containing port properties <a href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Port settings. <a href="structserial_1_1SerialPort__3__0__1_1_1Settings.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1State.html">State</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure holding information about the current state of the port. <a href="structserial_1_1SerialPort__3__0__1_1_1State.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:acffe0800621765fb4188ca84fc27533c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c">PortState</a> { <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533ca83bbf92fa540a1bbf6c7766fd0f73dc5">CONSOLE</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caad72693f02dcbd8bf0077f7587273eca">ANALOGMODEM</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533caf7721936c46b568e0ad3f109a4226f7d">GSMMODEM</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533ca5ae39ef8aa023729be68c50190d7295b">DISCONNECTED</a>
}</td></tr>
<tr class="memdesc:acffe0800621765fb4188ca84fc27533c"><td class="mdescLeft"> </td><td class="mdescRight">Possible states the port can be in at a given time. <a href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c">More...</a><br /></td></tr>
<tr class="separator:acffe0800621765fb4188ca84fc27533c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a0997dcb492c2d58ff39266c6e15040"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040">DetectionType</a> { <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040ae4fb439d3d49c8239ca3184317742b7d">AUTOMATIC</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040aa9d8091b327d0d8ccda3c9b3f2dd798d">FORCE_CONSOLE</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040abda07a86416eb12b9f4bd59c0a859265">FORCE_ANALOGMODEM</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040a4a0d3ff2ae92a7c1beca47479ffe17d3">FORCE_GSMMODEM</a>
}</td></tr>
<tr class="memdesc:a0a0997dcb492c2d58ff39266c6e15040"><td class="mdescLeft"> </td><td class="mdescRight">Device type the port shall be looking for. <a href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040">More...</a><br /></td></tr>
<tr class="separator:a0a0997dcb492c2d58ff39266c6e15040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ae9a9fed988ddfdfd0fa4bd59de7ed1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">BaudRate</a> { <br />
  <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aa0f16b972a1b386477f61ea589e19978">BR1200</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1aaca524dca4b711ca56a17b960928cedb">BR2400</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a2a880a83129a4df1b39811e9937bd712">BR4800</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1ad47deda20f8f13389647d4604b2c6303">BR9600</a>,
<br />
  <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a97126b8b819303747f08e78e18a904d0">BR19200</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a72368aeb71ebbe55ed8e032824370d02">BR38400</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a5c8fa84f529647aae7c3fbdd5888a91d">BR57600</a>,
<a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1a95054b4ba19d12c7d39954667416e50e">BR115200</a>
<br />
}</td></tr>
<tr class="memdesc:a1ae9a9fed988ddfdfd0fa4bd59de7ed1"><td class="mdescLeft"> </td><td class="mdescRight">Possible baud rates. <a href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">More...</a><br /></td></tr>
<tr class="separator:a1ae9a9fed988ddfdfd0fa4bd59de7ed1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a73185e20a08b1f41d90e62f49eb4fdb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html">MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a73185e20a08b1f41d90e62f49eb4fdb8">getMetaData</a> ()</td></tr>
<tr class="memdesc:a73185e20a08b1f41d90e62f49eb4fdb8"><td class="mdescLeft"> </td><td class="mdescRight">Get port meta data. <a href="#a73185e20a08b1f41d90e62f49eb4fdb8">More...</a><br /></td></tr>
<tr class="separator:a73185e20a08b1f41d90e62f49eb4fdb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c736253f28bc46913ef6171892ea9a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1c736253f28bc46913ef6171892ea9a6">getSettings</a> ()</td></tr>
<tr class="memdesc:a1c736253f28bc46913ef6171892ea9a6"><td class="mdescLeft"> </td><td class="mdescRight">Get current settings. <a href="#a1c736253f28bc46913ef6171892ea9a6">More...</a><br /></td></tr>
<tr class="separator:a1c736253f28bc46913ef6171892ea9a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addf728b4b4294444b2a2bde22a763b1b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#addf728b4b4294444b2a2bde22a763b1b">setSettings</a> (in <a class="el" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:addf728b4b4294444b2a2bde22a763b1b"><td class="mdescLeft"> </td><td class="mdescRight">Set settings. <a href="#addf728b4b4294444b2a2bde22a763b1b">More...</a><br /></td></tr>
<tr class="separator:addf728b4b4294444b2a2bde22a763b1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecee627cb3e4f50e5b0430a9371870da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1State.html">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#aecee627cb3e4f50e5b0430a9371870da">getState</a> ()</td></tr>
<tr class="memdesc:aecee627cb3e4f50e5b0430a9371870da"><td class="mdescLeft"> </td><td class="mdescRight">Get current port state. <a href="#aecee627cb3e4f50e5b0430a9371870da">More...</a><br /></td></tr>
<tr class="separator:aecee627cb3e4f50e5b0430a9371870da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f66da9794bbec732cffbff586392fd7"><td class="memItemLeft" align="right" valign="top">Object </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a4f66da9794bbec732cffbff586392fd7">getModem</a> ()</td></tr>
<tr class="memdesc:a4f66da9794bbec732cffbff586392fd7"><td class="mdescLeft"> </td><td class="mdescRight">Get modem connected to port. <a href="#a4f66da9794bbec732cffbff586392fd7">More...</a><br /></td></tr>
<tr class="separator:a4f66da9794bbec732cffbff586392fd7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afb168ee3b3bdd4efb09f146d4395dfb2"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#afb168ee3b3bdd4efb09f146d4395dfb2">SUCCESS</a> = 0</td></tr>
<tr class="memdesc:afb168ee3b3bdd4efb09f146d4395dfb2"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="#afb168ee3b3bdd4efb09f146d4395dfb2">More...</a><br /></td></tr>
<tr class="separator:afb168ee3b3bdd4efb09f146d4395dfb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58d36bdbdcb1f54f2005cb0c0f728737"><td class="memItemLeft" align="right" valign="top"><a id="a58d36bdbdcb1f54f2005cb0c0f728737"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a58d36bdbdcb1f54f2005cb0c0f728737">ERR_INVALID_VALUE</a> = 1</td></tr>
<tr class="memdesc:a58d36bdbdcb1f54f2005cb0c0f728737"><td class="mdescLeft"> </td><td class="mdescRight">Invalid arguments. <br /></td></tr>
<tr class="separator:a58d36bdbdcb1f54f2005cb0c0f728737"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25a8b74409081dbb340d5f17d2d28831"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a25a8b74409081dbb340d5f17d2d28831">ModemEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { Object modem</td></tr>
<tr class="memdesc:a25a8b74409081dbb340d5f17d2d28831"><td class="mdescLeft"> </td><td class="mdescRight">Event emitted when the modem connection state changes. <a href="#a25a8b74409081dbb340d5f17d2d28831">More...</a><br /></td></tr>
<tr class="separator:a25a8b74409081dbb340d5f17d2d28831"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a176df73f65817129a562965471cd7b68"><td class="memItemLeft" align="right" valign="top"><a id="a176df73f65817129a562965471cd7b68"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a176df73f65817129a562965471cd7b68">ModemAddedEvent</a>: <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a25a8b74409081dbb340d5f17d2d28831">ModemEvent</a> { }</td></tr>
<tr class="memdesc:a176df73f65817129a562965471cd7b68"><td class="mdescLeft"> </td><td class="mdescRight">Event emitted when a modem is connected. <br /></td></tr>
<tr class="separator:a176df73f65817129a562965471cd7b68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7bf27795fba66606587169bfefcb6bd"><td class="memItemLeft" align="right" valign="top"><a id="ab7bf27795fba66606587169bfefcb6bd"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#ab7bf27795fba66606587169bfefcb6bd">ModemRemovedEvent</a>: <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a25a8b74409081dbb340d5f17d2d28831">ModemEvent</a> { }</td></tr>
<tr class="memdesc:ab7bf27795fba66606587169bfefcb6bd"><td class="mdescLeft"> </td><td class="mdescRight">Event emitted when a modem is disconnected. <br /></td></tr>
<tr class="separator:ab7bf27795fba66606587169bfefcb6bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface describing a physical serial port and the devices which can be attached to it. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">◆ </a></span>BaudRate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a1ae9a9fed988ddfdfd0fa4bd59de7ed1">serial::SerialPort_3_0_1::BaudRate</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible baud rates. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1aa0f16b972a1b386477f61ea589e19978"></a>BR1200 </td><td class="fielddoc"><p>1.200 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1aaca524dca4b711ca56a17b960928cedb"></a>BR2400 </td><td class="fielddoc"><p>2.400 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1a2a880a83129a4df1b39811e9937bd712"></a>BR4800 </td><td class="fielddoc"><p>4.800 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1ad47deda20f8f13389647d4604b2c6303"></a>BR9600 </td><td class="fielddoc"><p>9.600 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1a97126b8b819303747f08e78e18a904d0"></a>BR19200 </td><td class="fielddoc"><p>19::200 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1a72368aeb71ebbe55ed8e032824370d02"></a>BR38400 </td><td class="fielddoc"><p>38::400 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1a5c8fa84f529647aae7c3fbdd5888a91d"></a>BR57600 </td><td class="fielddoc"><p>57::600 kbit/s </p>
</td></tr>
<tr><td class="fieldname"><a id="a1ae9a9fed988ddfdfd0fa4bd59de7ed1a95054b4ba19d12c7d39954667416e50e"></a>BR115200 </td><td class="fielddoc"><p>115::200 kbit/s </p>
</td></tr>
</table>
</div>
</div>
<a id="a0a0997dcb492c2d58ff39266c6e15040"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a0997dcb492c2d58ff39266c6e15040">◆ </a></span>DetectionType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#a0a0997dcb492c2d58ff39266c6e15040">serial::SerialPort_3_0_1::DetectionType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Device type the port shall be looking for. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0a0997dcb492c2d58ff39266c6e15040ae4fb439d3d49c8239ca3184317742b7d"></a>AUTOMATIC </td><td class="fielddoc"><p>Try to automatically determine the connected device. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0a0997dcb492c2d58ff39266c6e15040aa9d8091b327d0d8ccda3c9b3f2dd798d"></a>FORCE_CONSOLE </td><td class="fielddoc"><p>Always assume a console (terminal) is connected. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0a0997dcb492c2d58ff39266c6e15040abda07a86416eb12b9f4bd59c0a859265"></a>FORCE_ANALOGMODEM </td><td class="fielddoc"><p>Always assume an analog modem is connected. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0a0997dcb492c2d58ff39266c6e15040a4a0d3ff2ae92a7c1beca47479ffe17d3"></a>FORCE_GSMMODEM </td><td class="fielddoc"><p>Always assume a GSM modem is connected. </p>
</td></tr>
</table>
</div>
</div>
<a id="acffe0800621765fb4188ca84fc27533c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acffe0800621765fb4188ca84fc27533c">◆ </a></span>PortState</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceserial_1_1SerialPort__3__0__1.html#acffe0800621765fb4188ca84fc27533c">serial::SerialPort_3_0_1::PortState</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible states the port can be in at a given time. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acffe0800621765fb4188ca84fc27533ca83bbf92fa540a1bbf6c7766fd0f73dc5"></a>CONSOLE </td><td class="fielddoc"><p>The console application is running on the port. </p>
</td></tr>
<tr><td class="fieldname"><a id="acffe0800621765fb4188ca84fc27533caad72693f02dcbd8bf0077f7587273eca"></a>ANALOGMODEM </td><td class="fielddoc"><p>An analog modem is attached to the port. </p>
</td></tr>
<tr><td class="fieldname"><a id="acffe0800621765fb4188ca84fc27533caf7721936c46b568e0ad3f109a4226f7d"></a>GSMMODEM </td><td class="fielddoc"><p>A GSM modem is attached to the port. </p>
</td></tr>
<tr><td class="fieldname"><a id="acffe0800621765fb4188ca84fc27533ca5ae39ef8aa023729be68c50190d7295b"></a>DISCONNECTED </td><td class="fielddoc"><p>No device matching the configured mode is detected. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a73185e20a08b1f41d90e62f49eb4fdb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73185e20a08b1f41d90e62f49eb4fdb8">◆ </a></span>getMetaData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1MetaData.html">MetaData</a> serial::SerialPort_3_0_1::getMetaData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get port meta data. </p>
<dl class="section return"><dt>Returns</dt><dd>– Meta data </dd></dl>
</div>
</div>
<a id="a4f66da9794bbec732cffbff586392fd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f66da9794bbec732cffbff586392fd7">◆ </a></span>getModem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Object serial::SerialPort_3_0_1::getModem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get modem connected to port. </p>
<dl class="section return"><dt>Returns</dt><dd>– an instance of the connected modem (either <a class="el" href="interfaceserial_1_1AnalogModem.html">AnalogModem</a> or <a class="el" href="">GsmModem</a>) </dd></dl>
</div>
</div>
<a id="a1c736253f28bc46913ef6171892ea9a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c736253f28bc46913ef6171892ea9a6">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">Settings</a> serial::SerialPort_3_0_1::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current settings. </p>
<dl class="section return"><dt>Returns</dt><dd>– <a class="el" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html" title="Port settings. ">Settings</a> </dd></dl>
</div>
</div>
<a id="aecee627cb3e4f50e5b0430a9371870da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecee627cb3e4f50e5b0430a9371870da">◆ </a></span>getState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structserial_1_1SerialPort__3__0__1_1_1State.html">State</a> serial::SerialPort_3_0_1::getState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current port state. </p>
<dl class="section return"><dt>Returns</dt><dd>– Port state </dd></dl>
</div>
</div>
<a id="addf728b4b4294444b2a2bde22a763b1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addf728b4b4294444b2a2bde22a763b1b">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::SerialPort_3_0_1::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structserial_1_1SerialPort__3__0__1_1_1Settings.html">Settings</a> </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>– new settings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_INVALID_VALUE – if any passed value was invalid </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a25a8b74409081dbb340d5f17d2d28831"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25a8b74409081dbb340d5f17d2d28831">◆ </a></span>ModemEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject serial::SerialPort_3_0_1::ModemEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event emitted when the modem connection state changes. </p>
<p>Either a <a class="el" href="interfaceserial_1_1AnalogModem.html">AnalogModem</a> or a <a class="el" href="">GsmModem</a> </p>
</div>
</div>
<a id="afb168ee3b3bdd4efb09f146d4395dfb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb168ee3b3bdd4efb09f146d4395dfb2">◆ </a></span>SUCCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int serial::SerialPort_3_0_1::SUCCESS = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>No error </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="SerialPort_8idl_source.html">SerialPort.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
