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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
|
<!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::GsmModem_1_0_2 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_1GsmModem__1__0__2.html">GsmModem_1_0_2</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_1GsmModem__1__0__2-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">serial::GsmModem_1_0_2 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for communication with a GSM modem attached to a serial port.
<a href="interfaceserial_1_1GsmModem__1__0__2.html#details">More...</a></p>
<p><code>import"<a class="el" href="GsmModem_8idl_source.html">GsmModem.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_1GsmModem__1__0__2_1_1Information.html">Information</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure holding information about the modem and the SIM card. <a href="structserial_1_1GsmModem__1__0__2_1_1Information.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_1GsmModem__1__0__2_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure for holding settings of the GSM modem and its SIM card. <a href="structserial_1_1GsmModem__1__0__2_1_1Settings.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:a8c907c4d3fe7aaf27be0957346eae8a6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6">SimSecurityStatus</a> { <a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6ac75f5683af84df5df057945a3accfaa9">UNLOCKED</a>,
<a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6a47e11d6a07c7bbd237cc259aaf394eb2">WAITFORPIN</a>,
<a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6a0764cf192eddf34266db878d06f26f02">WAITFORPUK</a>,
<a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6a2ae17edc71906ec8599f28aa55aa5e43">UNKNOWN</a>
}</td></tr>
<tr class="memdesc:a8c907c4d3fe7aaf27be0957346eae8a6"><td class="mdescLeft"> </td><td class="mdescRight">Possible security states the sim card can be in at a given time. <a href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6">More...</a><br /></td></tr>
<tr class="separator:a8c907c4d3fe7aaf27be0957346eae8a6"><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:a987d48ef0093707a3c7569c4c5fabfe8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a987d48ef0093707a3c7569c4c5fabfe8">getSettings</a> ()</td></tr>
<tr class="memdesc:a987d48ef0093707a3c7569c4c5fabfe8"><td class="mdescLeft"> </td><td class="mdescRight">Get modem settings. <a href="#a987d48ef0093707a3c7569c4c5fabfe8">More...</a><br /></td></tr>
<tr class="separator:a987d48ef0093707a3c7569c4c5fabfe8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7e0dd8868b87058fd94279347cef4fe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#ab7e0dd8868b87058fd94279347cef4fe">setSettings</a> (in <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:ab7e0dd8868b87058fd94279347cef4fe"><td class="mdescLeft"> </td><td class="mdescRight">Set modem settings. <a href="#ab7e0dd8868b87058fd94279347cef4fe">More...</a><br /></td></tr>
<tr class="separator:ab7e0dd8868b87058fd94279347cef4fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95f9cec644177015efea557c23050e9c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a95f9cec644177015efea557c23050e9c">sendSms</a> (in string recipient, in string text)</td></tr>
<tr class="memdesc:a95f9cec644177015efea557c23050e9c"><td class="mdescLeft"> </td><td class="mdescRight">Send out a SMS message. <a href="#a95f9cec644177015efea557c23050e9c">More...</a><br /></td></tr>
<tr class="separator:a95f9cec644177015efea557c23050e9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0e631fe42cf97c2bbdb51afa16d6436"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#ab0e631fe42cf97c2bbdb51afa16d6436">sendTestSms</a> (in string recipient, in <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Settings.html">Settings</a> testSettings)</td></tr>
<tr class="memdesc:ab0e631fe42cf97c2bbdb51afa16d6436"><td class="mdescLeft"> </td><td class="mdescRight">Send out a test SMS message. <a href="#ab0e631fe42cf97c2bbdb51afa16d6436">More...</a><br /></td></tr>
<tr class="separator:ab0e631fe42cf97c2bbdb51afa16d6436"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55c204eb714f5fa163586a1fdd23b634"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a55c204eb714f5fa163586a1fdd23b634">getInformation</a> (out <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Information.html">Information</a> info)</td></tr>
<tr class="memdesc:a55c204eb714f5fa163586a1fdd23b634"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve low-level information about the modem and the SIM card. <a href="#a55c204eb714f5fa163586a1fdd23b634">More...</a><br /></td></tr>
<tr class="separator:a55c204eb714f5fa163586a1fdd23b634"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0849c5a22a1c5ae58672be053fbe927f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a0849c5a22a1c5ae58672be053fbe927f">getInformationWithPin</a> (in string pin, out <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Information.html">Information</a> info)</td></tr>
<tr class="memdesc:a0849c5a22a1c5ae58672be053fbe927f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve low-level information about the modem and the SIM card. <a href="#a0849c5a22a1c5ae58672be053fbe927f">More...</a><br /></td></tr>
<tr class="separator:a0849c5a22a1c5ae58672be053fbe927f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5dfe9074a2413af6eb9832fb3aefd19"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#ae5dfe9074a2413af6eb9832fb3aefd19">getSimSecurityStatus</a> (out <a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6">SimSecurityStatus</a> simStatus)</td></tr>
<tr class="memdesc:ae5dfe9074a2413af6eb9832fb3aefd19"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve security status of the SIM card. <a href="#ae5dfe9074a2413af6eb9832fb3aefd19">More...</a><br /></td></tr>
<tr class="separator:ae5dfe9074a2413af6eb9832fb3aefd19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe9578a114062c61daf46a2955b9ef39"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#abe9578a114062c61daf46a2955b9ef39">unlockSimCard</a> (in string puk, in string newPin)</td></tr>
<tr class="memdesc:abe9578a114062c61daf46a2955b9ef39"><td class="mdescLeft"> </td><td class="mdescRight">Unlock SIM card with PUK and set new PIN if the SIM card is in security status WAITFORPUK. <a href="#abe9578a114062c61daf46a2955b9ef39">More...</a><br /></td></tr>
<tr class="separator:abe9578a114062c61daf46a2955b9ef39"><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:a60574753f0b54487c5173b162e570453"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a60574753f0b54487c5173b162e570453">SUCCESS</a> = 0</td></tr>
<tr class="memdesc:a60574753f0b54487c5173b162e570453"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="#a60574753f0b54487c5173b162e570453">More...</a><br /></td></tr>
<tr class="separator:a60574753f0b54487c5173b162e570453"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8983a9e82c63737ae85b374f21a1682d"><td class="memItemLeft" align="right" valign="top"><a id="a8983a9e82c63737ae85b374f21a1682d"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8983a9e82c63737ae85b374f21a1682d">ERR_INVALID_VALUE</a> = 1</td></tr>
<tr class="memdesc:a8983a9e82c63737ae85b374f21a1682d"><td class="mdescLeft"> </td><td class="mdescRight">Invalid argument. <br /></td></tr>
<tr class="separator:a8983a9e82c63737ae85b374f21a1682d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62909ac8f6f890a34747803c10a0a46c"><td class="memItemLeft" align="right" valign="top"><a id="a62909ac8f6f890a34747803c10a0a46c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a62909ac8f6f890a34747803c10a0a46c">ERR_WRONG_PIN</a> = 2</td></tr>
<tr class="memdesc:a62909ac8f6f890a34747803c10a0a46c"><td class="mdescLeft"> </td><td class="mdescRight">The PIN is incorrect or missing. <br /></td></tr>
<tr class="separator:a62909ac8f6f890a34747803c10a0a46c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae57aff92cda855ad1f0aba8dda87fb0d"><td class="memItemLeft" align="right" valign="top"><a id="ae57aff92cda855ad1f0aba8dda87fb0d"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#ae57aff92cda855ad1f0aba8dda87fb0d">ERR_SMS_SEND_FAILED</a> = 3</td></tr>
<tr class="memdesc:ae57aff92cda855ad1f0aba8dda87fb0d"><td class="mdescLeft"> </td><td class="mdescRight">SMS delivery failed. <br /></td></tr>
<tr class="separator:ae57aff92cda855ad1f0aba8dda87fb0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f638996a55a06d6b54cc25d92d61f18"><td class="memItemLeft" align="right" valign="top"><a id="a7f638996a55a06d6b54cc25d92d61f18"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a7f638996a55a06d6b54cc25d92d61f18">ERR_COMMUNICATION_FAILURE</a> = 4</td></tr>
<tr class="memdesc:a7f638996a55a06d6b54cc25d92d61f18"><td class="mdescLeft"> </td><td class="mdescRight">Communication with the modem failed. <br /></td></tr>
<tr class="separator:a7f638996a55a06d6b54cc25d92d61f18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ec1235786e96fe3d12758ec551aee26"><td class="memItemLeft" align="right" valign="top"><a id="a7ec1235786e96fe3d12758ec551aee26"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a7ec1235786e96fe3d12758ec551aee26">ERR_SIM_LOCKED</a> = 5</td></tr>
<tr class="memdesc:a7ec1235786e96fe3d12758ec551aee26"><td class="mdescLeft"> </td><td class="mdescRight">The SIM card is locked and waits for the PUK. <br /></td></tr>
<tr class="separator:a7ec1235786e96fe3d12758ec551aee26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae07e2206d81d00aedd7cd171b2f7cf20"><td class="memItemLeft" align="right" valign="top"><a id="ae07e2206d81d00aedd7cd171b2f7cf20"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#ae07e2206d81d00aedd7cd171b2f7cf20">ERR_WRONG_SIM_STATUS</a> = 6</td></tr>
<tr class="memdesc:ae07e2206d81d00aedd7cd171b2f7cf20"><td class="mdescLeft"> </td><td class="mdescRight">The SIM card doesn't wait for the PUK. <br /></td></tr>
<tr class="separator:ae07e2206d81d00aedd7cd171b2f7cf20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ffb6ce4f1217da40a89d043c00f9467"><td class="memItemLeft" align="right" valign="top"><a id="a6ffb6ce4f1217da40a89d043c00f9467"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a6ffb6ce4f1217da40a89d043c00f9467">ERR_WRONG_PUK</a> = 7</td></tr>
<tr class="memdesc:a6ffb6ce4f1217da40a89d043c00f9467"><td class="mdescLeft"> </td><td class="mdescRight">The PUK is incorrect or missing. <br /></td></tr>
<tr class="separator:a6ffb6ce4f1217da40a89d043c00f9467"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb7cea05e86b094c7de37375c1e100ba"><td class="memItemLeft" align="right" valign="top"><a id="aeb7cea05e86b094c7de37375c1e100ba"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#aeb7cea05e86b094c7de37375c1e100ba">ERR_SIM_PROBLEM</a> = 8</td></tr>
<tr class="memdesc:aeb7cea05e86b094c7de37375c1e100ba"><td class="mdescLeft"> </td><td class="mdescRight">There is a problem with the SIM or service subscription. <br /></td></tr>
<tr class="separator:aeb7cea05e86b094c7de37375c1e100ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c8c0d410fc96fad1d573fc5b56367e7"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a3c8c0d410fc96fad1d573fc5b56367e7">SimSecurityStatusChangedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { <a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6">SimSecurityStatus</a> newSimStatus</td></tr>
<tr class="memdesc:a3c8c0d410fc96fad1d573fc5b56367e7"><td class="mdescLeft"> </td><td class="mdescRight">Sim card security status changed event. <a href="#a3c8c0d410fc96fad1d573fc5b56367e7">More...</a><br /></td></tr>
<tr class="separator:a3c8c0d410fc96fad1d573fc5b56367e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f9f07d54e6bcafc6e904d2ddafa06d8"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a7f9f07d54e6bcafc6e904d2ddafa06d8">SimPinUpdatedEvent</a>: <a class="el" href="namespaceidl.html#accbdf35b0c02d64ce223e912fc2b246f">idl::Event</a> { string newPin</td></tr>
<tr class="memdesc:a7f9f07d54e6bcafc6e904d2ddafa06d8"><td class="mdescLeft"> </td><td class="mdescRight">Sim pin updated event. <a href="#a7f9f07d54e6bcafc6e904d2ddafa06d8">More...</a><br /></td></tr>
<tr class="separator:a7f9f07d54e6bcafc6e904d2ddafa06d8"><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 for communication with a GSM modem attached to a serial port. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a8c907c4d3fe7aaf27be0957346eae8a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c907c4d3fe7aaf27be0957346eae8a6">◆ </a></span>SimSecurityStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6">serial::GsmModem_1_0_2::SimSecurityStatus</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible security states the sim card can be in at a given time. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8c907c4d3fe7aaf27be0957346eae8a6ac75f5683af84df5df057945a3accfaa9"></a>UNLOCKED </td><td class="fielddoc"><p>SIM card is unlocked. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8c907c4d3fe7aaf27be0957346eae8a6a47e11d6a07c7bbd237cc259aaf394eb2"></a>WAITFORPIN </td><td class="fielddoc"><p>PIN must be entered to unlock the SIM card. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8c907c4d3fe7aaf27be0957346eae8a6a0764cf192eddf34266db878d06f26f02"></a>WAITFORPUK </td><td class="fielddoc"><p>PUK and new PIN must be entered to unlock the SIM card. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8c907c4d3fe7aaf27be0957346eae8a6a2ae17edc71906ec8599f28aa55aa5e43"></a>UNKNOWN </td><td class="fielddoc"><p>Unkown security status. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a55c204eb714f5fa163586a1fdd23b634"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55c204eb714f5fa163586a1fdd23b634">◆ </a></span>getInformation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::getInformation </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Information.html">Information</a> </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve low-level information about the modem and the SIM card. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>– structure holding the returned information</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_WRONG_PIN – if the used PIN is incorrect or missing </dd>
<dd>
ERR_SIM_LOCKED – if the SIM card is locked and waits for the PUK </dd>
<dd>
ERR_COMMUNICATION_FAILURE – if communication with the modem failed </dd></dl>
</div>
</div>
<a id="a0849c5a22a1c5ae58672be053fbe927f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0849c5a22a1c5ae58672be053fbe927f">◆ </a></span>getInformationWithPin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::getInformationWithPin </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>pin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Information.html">Information</a> </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve low-level information about the modem and the SIM card. </p>
<p>Like <a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a55c204eb714f5fa163586a1fdd23b634" title="Retrieve low-level information about the modem and the SIM card. ">getInformation</a>, but allows providing a PIN not stored in the settings</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pin</td><td>– PIN to use for authentication </td></tr>
<tr><td class="paramname">info</td><td>– structure holding the returned information</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_WRONG_PIN – if the used PIN is incorrect or missing </dd>
<dd>
ERR_SIM_LOCKED – if the SIM card is locked and waits for the PUK </dd>
<dd>
ERR_COMMUNICATION_FAILURE – if communication with the modem failed </dd></dl>
</div>
</div>
<a id="a987d48ef0093707a3c7569c4c5fabfe8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a987d48ef0093707a3c7569c4c5fabfe8">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Settings.html">Settings</a> serial::GsmModem_1_0_2::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get modem settings. </p>
<dl class="section return"><dt>Returns</dt><dd>– Current modem settings </dd></dl>
</div>
</div>
<a id="ae5dfe9074a2413af6eb9832fb3aefd19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5dfe9074a2413af6eb9832fb3aefd19">◆ </a></span>getSimSecurityStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::getSimSecurityStatus </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="interfaceserial_1_1GsmModem__1__0__2.html#a8c907c4d3fe7aaf27be0957346eae8a6">SimSecurityStatus</a> </td>
<td class="paramname"><em>simStatus</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve security status of the SIM card. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">simStatus</td><td>– SIM card security status</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_COMMUNICATION_FAILURE – if communication with the modem failed </dd></dl>
</div>
</div>
<a id="a95f9cec644177015efea557c23050e9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95f9cec644177015efea557c23050e9c">◆ </a></span>sendSms()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::sendSms </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>recipient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send out a SMS message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">recipient</td><td>– Phone number of the message recipient in ITU-T E.164 format </td></tr>
<tr><td class="paramname">text</td><td>– Message text (will be sent in multiple messages if longer than 160 characters)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_WRONG_PIN – if the PIN currently stored in the settings is incorrect or missing </dd>
<dd>
ERR_SMS_SEND_FAILED – if the delivery of the SMS to the network failed </dd>
<dd>
ERR_SIM_LOCKED – if the SIM card is locked and waits for the PUK </dd>
<dd>
ERR_COMMUNICATION_FAILURE – if communication with the modem failed </dd></dl>
</div>
</div>
<a id="ab0e631fe42cf97c2bbdb51afa16d6436"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0e631fe42cf97c2bbdb51afa16d6436">◆ </a></span>sendTestSms()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::sendTestSms </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>recipient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structserial_1_1GsmModem__1__0__2_1_1Settings.html">Settings</a> </td>
<td class="paramname"><em>testSettings</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send out a test SMS message. </p>
<p>The message will be sent to the selected recipient with the text 'SMS Test'.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">recipient</td><td>– Phone number of the message recipient in ITU-T E.164 format </td></tr>
<tr><td class="paramname">testSettings</td><td>– Modem settings to be used temporarily during testing</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_WRONG_PIN – if the PIN currently stored in the settings is incorrect or missing </dd>
<dd>
ERR_SMS_SEND_FAILED – if the delivery of the SMS to the network failed </dd>
<dd>
ERR_SIM_LOCKED – if the SIM card is locked and waits for the PUK </dd>
<dd>
ERR_COMMUNICATION_FAILURE – if communication with the modem failed </dd></dl>
</div>
</div>
<a id="ab7e0dd8868b87058fd94279347cef4fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7e0dd8868b87058fd94279347cef4fe">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structserial_1_1GsmModem__1__0__2_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 modem 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>
<a id="abe9578a114062c61daf46a2955b9ef39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe9578a114062c61daf46a2955b9ef39">◆ </a></span>unlockSimCard()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int serial::GsmModem_1_0_2::unlockSimCard </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>puk</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>newPin</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlock SIM card with PUK and set new PIN if the SIM card is in security status WAITFORPUK. </p>
<p>The new PIN is automatically saved in the settings.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">puk</td><td>– PUK to use for authentication </td></tr>
<tr><td class="paramname">newPin</td><td>– new PIN to use for future authentication</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS – on success </dd>
<dd>
ERR_WRONG_SIM_STATUS – if the SIM card doesn't wait for the PUK </dd>
<dd>
ERR_WRONG_PUK – if the used PUK is incorrect or missing </dd>
<dd>
ERR_COMMUNICATION_FAILURE – if communication with the modem failed </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7f9f07d54e6bcafc6e904d2ddafa06d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f9f07d54e6bcafc6e904d2ddafa06d8">◆ </a></span>SimPinUpdatedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject serial::GsmModem_1_0_2::SimPinUpdatedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sim pin updated event. </p>
<p>new PIN for SIM card after Unlock </p>
</div>
</div>
<a id="a3c8c0d410fc96fad1d573fc5b56367e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c8c0d410fc96fad1d573fc5b56367e7">◆ </a></span>SimSecurityStatusChangedEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject serial::GsmModem_1_0_2::SimSecurityStatusChangedEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sim card security status changed event. </p>
<p>new SIM card security status </p>
</div>
</div>
<a id="a60574753f0b54487c5173b162e570453"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60574753f0b54487c5173b162e570453">◆ </a></span>SUCCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int serial::GsmModem_1_0_2::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="GsmModem_8idl_source.html">GsmModem.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>
|
