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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.ModemManager1.Modem.Simple</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="ModemManager Reference Manual">
<link rel="up" href="ref-dbus-object-modem.html" title="The /org/freedesktop/ModemManager/Modems objects">
<link rel="prev" href="gdbus-org.freedesktop.ModemManager1.Modem.html" title="org.freedesktop.ModemManager1.Modem">
<link rel="next" href="gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html" title="org.freedesktop.ModemManager1.Modem.Modem3gpp">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gdbus-org.freedesktop.ModemManager1.Modem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-dbus-object-modem.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ModemManager Reference Manual</th>
<td><a accesskey="n" href="gdbus-org.freedesktop.ModemManager1.Modem.Modem3gpp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gdbus-org.freedesktop.ModemManager1.Modem.Simple.synopsis" class="shortcut">Top</a>
|
<a href="#gdbus-org.freedesktop.ModemManager1.Modem.Simple.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gdbus-org.freedesktop.ModemManager1.Modem.Simple"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-ModemManager1-Modem-Simple.top_of_page"></a>org.freedesktop.ModemManager1.Modem.Simple</span></h2>
<p>org.freedesktop.ModemManager1.Modem.Simple — The ModemManager Simple interface.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect" title="The Connect() method">Connect</a> (IN a{sv} properties,
OUT o bearer);
<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Disconnect" title="The Disconnect() method">Disconnect</a> (IN o bearer);
<a class="link" href="gdbus-org.freedesktop.ModemManager1.Modem.Simple.html#gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.GetStatus" title="The GetStatus() method">GetStatus</a> (OUT a{sv} properties);
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-ModemManager1-Modem-Simple"></a><h2>Description</h2>
<p> The Simple interface allows controlling and querying the status of Modems.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.ModemManager1.Modem.Simple"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Connect"></a><h3>The Connect() method</h3>
<pre class="programlisting">
Connect (IN a{sv} properties,
OUT o bearer);
</pre>
<p> Do everything needed to connect the modem using the given properties.
</p>
<p> This method will attempt to find a matching packet data bearer and
activate it if necessary, returning the bearer's IP details. If no
matching bearer is found, a new bearer will be created and activated,
but this operation may fail if no resources are available to complete
this connection attempt (ie, if a conflicting bearer is already active).
</p>
<p> This call may make a large number of changes to modem configuration
based on properties passed in. For example, given a PIN-locked, disabled
GSM/UMTS modem, this call may unlock the SIM PIN, alter the access
technology preference, wait for network registration (or force
registration to a specific provider), create a new packet data bearer
using the given "apn", and connect that bearer.
</p>
<p> Allowed key/value pairs in <em class="parameter"><code>properties</code></em> are:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">"pin"</code></span></p></td>
<td>
SIM-PIN unlock code, given as a string value (signature <code class="literal">"s"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"operator-id"</code></span></p></td>
<td>
ETSI MCC-MNC of a network to force registration with,
given as a string value (signature <code class="literal">"s"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"apn"</code></span></p></td>
<td>
For GSM/UMTS and LTE devices the APN to use,
given as a string value (signature <code class="literal">"s"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"ip-type"</code></span></p></td>
<td>
For GSM/UMTS and LTE devices the IP addressing type to use,
given as a <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMBearerIpFamily" title="enum MMBearerIpFamily">MMBearerIpFamily</a>
value (signature <code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"allowed-auth"</code></span></p></td>
<td>
The authentication method to use, given as a
<a class="link" href="ModemManager-Flags-and-Enumerations.html#MMBearerAllowedAuth" title="enum MMBearerAllowedAuth">MMBearerAllowedAuth</a>
value (signature <code class="literal">"u"</code>). Optional in 3GPP.
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"user"</code></span></p></td>
<td>
User name (if any) required by the network, given as a string
value (signature <code class="literal">"s"</code>). Optional in 3GPP.
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"password"</code></span></p></td>
<td>
Password (if any) required by the network, given as a string value
(signature <code class="literal">"s"</code>). Optional in 3GPP.
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"number"</code></span></p></td>
<td>
For POTS devices the number to dial,,
given as a string value (signature <code class="literal">"s"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"allow-roaming"</code></span></p></td>
<td>
<code class="constant">FALSE</code> to allow only connections to home networks,
given as a boolean value (signature <code class="literal">"b"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"rm-protocol"</code></span></p></td>
<td>
For CDMA devices, the protocol of the Rm interface, given as a
<a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemCdmaRmProtocol" title="enum MMModemCdmaRmProtocol">MMModemCdmaRmProtocol</a>
value (signature <code class="literal">"u"</code>).
</td>
</tr>
</tbody>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>properties</code></em></code>:</span></p></td>
<td><p>Dictionary of properties needed to get the modem connected.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>bearer</code></em></code>:</span></p></td>
<td><p>On successful connect, returns the object path of the connected packet data bearer used for the connection attempt.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.Disconnect"></a><h3>The Disconnect() method</h3>
<pre class="programlisting">
Disconnect (IN o bearer);
</pre>
<p> data bearer, while if "/" (ie, no object given) this method will
disconnect all active packet data bearers.
</p>
<p> Disconnect an active packet data connection.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN o <em class="parameter"><code>bearer</code></em></code>:</span></p></td>
<td><p>If given this method will disconnect the referenced packet</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-ModemManager1-Modem-Simple.GetStatus"></a><h3>The GetStatus() method</h3>
<pre class="programlisting">
GetStatus (OUT a{sv} properties);
</pre>
<p> Get the general modem status.
</p>
<p> The predefined common properties returned are:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">"state"</code></span></p></td>
<td>
A <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemState" title="enum MMModemState">MMModemState</a> value
specifying the overall state of the modem, given as an
unsigned integer value (signature <code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"signal-quality"</code></span></p></td>
<td>
Signal quality value, given only when registered,
as an unsigned integer value
(signature <code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"current-bands"</code></span></p></td>
<td>
List of <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemBand" title="enum MMModemBand">MMModemBand</a> values,
given only when registered, as a list of
unsigned integer values (signature <code class="literal">"au"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"access-technology"</code></span></p></td>
<td>
A <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemAccessTechnology" title="enum MMModemAccessTechnology">MMModemAccessTechnology</a> value,
given only when registered, as an unsigned integer value
(signature <code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"m3gpp-registration-state"</code></span></p></td>
<td>
A <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModem3gppRegistrationState" title="enum MMModem3gppRegistrationState">MMModem3gppRegistrationState</a> value
specifying the state of the registration, given only when registered
in a 3GPP network, as an unsigned integer value (signature
<code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"m3gpp-operator-code"</code></span></p></td>
<td>
Operator <code class="literal">MCC-MNC</code>, given only when registered
in a 3GPP network, as a string value (signature <code class="literal">"s"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"m3gpp-operator-name"</code></span></p></td>
<td>
Operator name, given only when registered in a 3GPP network,
as a string value (signature <code class="literal">"s"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"cdma-cdma1x-registration-state"</code></span></p></td>
<td>
A <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemCdmaRegistrationState" title="enum MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</a> value
specifying the state of the registration, given only when registered
in a CDMA1x network, as an unsigned integer value (signature
<code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"cdma-evdo-registration-state"</code></span></p></td>
<td>
A <a class="link" href="ModemManager-Flags-and-Enumerations.html#MMModemCdmaRegistrationState" title="enum MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</a> value
specifying the state of the registration, given only when registered
in a EV-DO network, as an unsigned integer value (signature
<code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"cdma-sid"</code></span></p></td>
<td>
The System Identifier of the serving network, if registered in a CDMA1x network and if known.
Given as an unsigned integer value (signature <code class="literal">"u"</code>).
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">"cdma-nid"</code></span></p></td>
<td>
The Network Identifier of the serving network, if registered in a CDMA1x network and if known.
Given as an unsigned integer value (signature <code class="literal">"u"</code>).
</td>
</tr>
</tbody>
</table></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">OUT a{sv} <em class="parameter"><code>properties</code></em></code>:</span></p></td>
<td><p>Dictionary of properties.</p></td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
