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
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-org.freedesktop.ModemManager1.Modem.ModemCdma">
<refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-ModemManager1-Modem-ModemCdma.top_of_page">org.freedesktop.ModemManager1.Modem.ModemCdma</refentrytitle>
<indexterm zone="gdbus-interface-org-freedesktop-ModemManager1-Modem-ModemCdma.top_of_page"><primary sortas="ModemCdma">org.freedesktop.ModemManager1.Modem.ModemCdma</primary></indexterm>
</refmeta> <refnamediv> <refname>org.freedesktop.ModemManager1.Modem.ModemCdma</refname> <refpurpose>The ModemManager CDMA interface.</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis">
<title role="synopsis.title">Methods</title>
<synopsis>
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-ModemCdma.Activate">Activate</link> (IN s carrier_code);
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivateManual">ActivateManual</link> (IN a{sv} properties);
</synopsis>
</refsynopsisdiv>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
<link linkend="gdbus-signal-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationStateChanged">ActivationStateChanged</link> (u activation_state,
u activation_error,
a{sv} status_changes);
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationState">ActivationState</link> readable u
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Meid">Meid</link> readable s
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Esn">Esn</link> readable s
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Sid">Sid</link> readable u
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Nid">Nid</link> readable u
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Cdma1xRegistrationState">Cdma1xRegistrationState</link> readable u
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.EvdoRegistrationState">EvdoRegistrationState</link> readable u
</synopsis>
</refsect1>
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-ModemManager1-Modem-ModemCdma">
<title role="desc.title">Description</title>
<para> This interface provides access to specific actions that may be performed
in modems with CDMA capabilities.
</para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-org.freedesktop.ModemManager1.Modem.ModemCdma">
<title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Modem-ModemCdma.Activate">
<title>The Activate() method</title>
<indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Modem-ModemCdma.Activate"><primary sortas="ModemCdma.Activate">org.freedesktop.ModemManager1.Modem.ModemCdma.Activate()</primary></indexterm>
<programlisting>
Activate (IN s carrier_code);
</programlisting>
<para> Provisions the modem for use with a given carrier using the modem's
<ulink url="http://en.wikipedia.org/wiki/Over-the-air_programming">Over-The-Air (OTA)</ulink>
activation functionality, if any.
</para><para> Some modems will reboot after this call is made.
</para>
<variablelist role="params">
<varlistentry>
<term><literal>IN s <parameter>carrier_code</parameter></literal>:</term>
<listitem><para>Name of carrier, or carrier-specific code.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivateManual">
<title>The ActivateManual() method</title>
<indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivateManual"><primary sortas="ModemCdma.ActivateManual">org.freedesktop.ModemManager1.Modem.ModemCdma.ActivateManual()</primary></indexterm>
<programlisting>
ActivateManual (IN a{sv} properties);
</programlisting>
<para> Sets the modem provisioning data directly, without contacting the
carrier over the air.
</para><para> Some modems will reboot after this call is made.
</para><para> This dictionary is composed of a string identifier key
with an associated data which contains type-specific location
information:
</para><para> <variablelist>
<varlistentry><term>"spc"</term>
<listitem>
<para>
The Service Programming Code, given as a string of exactly 6 digit characters. Mandatory parameter.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"sid"</term>
<listitem>
<para>
The System Identification Number, given as a 16-bit unsigned integer (signature <literal>"q"</literal>). Mandatory parameter.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"mdn"</term>
<listitem>
<para>
The Mobile Directory Number, given as a string of maximum 15 characters. Mandatory parameter.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"min"</term>
<listitem>
<para>
The Mobile Identification Number, given as a string of maximum 15 characters. Mandatory parameter.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"mn-ha-key"</term>
<listitem>
<para>
The MN-HA key, given as a string of maximum 16 characters.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"mn-aaa-key"</term>
<listitem>
<para>
The MN-AAA key, given as a string of maximum 16 characters.
</para>
</listitem>
</varlistentry>
<varlistentry><term>"prl"</term>
<listitem>
<para>
The Preferred Roaming List, given as an array of maximum 16384 bytes.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist role="params">
<varlistentry>
<term><literal>IN a{sv} <parameter>properties</parameter></literal>:</term>
<listitem><para>A dictionary of properties to set on the modem.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-signals-org.freedesktop.ModemManager1.Modem.ModemCdma">
<title role="details.title">Signal Details</title>
<refsect2 role="signal" id="gdbus-signal-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationStateChanged">
<title>The "ActivationStateChanged" signal</title>
<indexterm zone="gdbus-signal-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationStateChanged"><primary sortas="ModemCdma::ActivationStateChanged">org.freedesktop.ModemManager1.Modem.ModemCdma::ActivationStateChanged</primary></indexterm>
<programlisting>
ActivationStateChanged (u activation_state,
u activation_error,
a{sv} status_changes);
</programlisting>
<para> The device activation state changed.
</para>
<variablelist role="params">
<varlistentry>
<term><literal>u <parameter>activation_state</parameter></literal>:</term>
<listitem><para>Current activation state, given as a <link linkend="MMModemCdmaActivationState">MMModemCdmaActivationState</link>.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>u <parameter>activation_error</parameter></literal>:</term>
<listitem><para>Carrier-specific error code, given as a <link linkend="MMCdmaActivationError">MMCdmaActivationError</link>.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>a{sv} <parameter>status_changes</parameter></literal>:</term>
<listitem><para>Properties that have changed as a result of this activation state chage, including <literal>"mdn"</literal> and <literal>"min"</literal>. The dictionary may be empty if the changed properties are unknown.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-properties-org.freedesktop.ModemManager1.Modem.ModemCdma">
<title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationState">
<title>The "ActivationState" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.ActivationState"><primary sortas="ModemCdma:ActivationState">org.freedesktop.ModemManager1.Modem.ModemCdma:ActivationState</primary></indexterm>
<programlisting>
ActivationState readable u
</programlisting>
<para> A <link linkend="MMModemCdmaActivationState">MMModemCdmaActivationState</link>
value specifying the state of the activation in the 3GPP2 network.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Meid">
<title>The "Meid" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Meid"><primary sortas="ModemCdma:Meid">org.freedesktop.ModemManager1.Modem.ModemCdma:Meid</primary></indexterm>
<programlisting>
Meid readable s
</programlisting>
<para> The modem's <ulink url="http://en.wikipedia.org/wiki/MEID">Mobile Equipment Identifier</ulink>.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Esn">
<title>The "Esn" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Esn"><primary sortas="ModemCdma:Esn">org.freedesktop.ModemManager1.Modem.ModemCdma:Esn</primary></indexterm>
<programlisting>
Esn readable s
</programlisting>
<para> The modem's
<ulink url="http://en.wikipedia.org/wiki/Electronic_serial_number">Electronic Serial Number</ulink>
(superceded by MEID but still used by older devices).
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Sid">
<title>The "Sid" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Sid"><primary sortas="ModemCdma:Sid">org.freedesktop.ModemManager1.Modem.ModemCdma:Sid</primary></indexterm>
<programlisting>
Sid readable u
</programlisting>
<para> The
<ulink url="http://en.wikipedia.org/wiki/System_Identification_Number">System Identifier</ulink>
of the serving CDMA 1x network, if known, and
if the modem is registered with a CDMA 1x network.
</para><para> See <ulink url="http://ifast.org">ifast.org</ulink> or the mobile
broadband provider database for mappings of SIDs to network providers.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Nid">
<title>The "Nid" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Nid"><primary sortas="ModemCdma:Nid">org.freedesktop.ModemManager1.Modem.ModemCdma:Nid</primary></indexterm>
<programlisting>
Nid readable u
</programlisting>
<para> The
<ulink url="http://en.wikipedia.org/wiki/Network_Identification_Number">Network Identifier</ulink>
of the serving CDMA 1x network, if known, and
if the modem is registered with a CDMA 1x network.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Cdma1xRegistrationState">
<title>The "Cdma1xRegistrationState" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.Cdma1xRegistrationState"><primary sortas="ModemCdma:Cdma1xRegistrationState">org.freedesktop.ModemManager1.Modem.ModemCdma:Cdma1xRegistrationState</primary></indexterm>
<programlisting>
Cdma1xRegistrationState readable u
</programlisting>
<para> A <link linkend="MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</link>
value specifying the CDMA 1x registration state.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.EvdoRegistrationState">
<title>The "EvdoRegistrationState" property</title>
<indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-ModemCdma.EvdoRegistrationState"><primary sortas="ModemCdma:EvdoRegistrationState">org.freedesktop.ModemManager1.Modem.ModemCdma:EvdoRegistrationState</primary></indexterm>
<programlisting>
EvdoRegistrationState readable u
</programlisting>
<para> A <link linkend="MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</link>
value specifying the EVDO registration state.
</para>
</refsect2>
</refsect1>
</refentry>
|
