1
<?xml version="1.0" encoding="UTF-8" ?>
3
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
5
<interface name="org.freedesktop.ModemManager.Modem">
8
Enable the device. Initializes the modem.
10
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
11
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_enable"/>
12
<arg name="enable" type="b" direction="in">
14
True to enable the device, False to disable.
19
<method name="Connect">
23
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
24
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_connect"/>
25
<arg name="number" type="s" direction="in">
27
The number to use for dialing.
32
<method name="Disconnect">
36
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
37
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_disconnect"/>
40
<method name="GetIP4Config">
42
Request the IP4 configuration from the device.
43
Note that it'll only be supported for IPMethod MM_MODEM_IP_METHOD_STATIC.
45
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
46
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_ip4_config"/>
47
<arg name="address" type="(uuuu)" direction="out">
48
Structure containing IP4 address, DNS1, DNS2, DNS3.
49
The DNS list is padded with 0's if there's less than 3 DNS servers.
53
<method name="GetInfo">
55
Get the card information (manufacturer, modem, version).
57
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
58
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_info"/>
59
<arg name="info" type="(sss)" direction="out">
61
Structure containing manufacturer, model, and version (revision) of the card.
68
Clear non-persistent configuration and state, and return the device to
69
a newly-powered-on state. This command may power-cycle the device.
71
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
72
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_reset"/>
75
<method name="FactoryReset">
77
Clear the modem's configuration (including persistent configuration and
78
state), and return the device to a factory-default state. This command
79
may or may not power-cycle the device.
81
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
82
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_factory_reset"/>
83
<arg name="code" type="s" direction="in">
84
Carrier-supplied code required to reset the modem. Ignored if not required.
88
<signal name="StateChanged">
90
The modem's state (see the State property) changed.
92
<arg name="old" type="u">
97
<arg name="new" type="u">
102
<arg name="reason" type="u" tp:type="MM_MODEM_STATE_CHANGED_REASON">
104
Reason for this state change.
109
<property name="Device" type="s" access="read">
111
The modem port to use for IP configuration and traffic.
115
<property name="DeviceIdentifier" type="s" access="read">
117
A best-effort device identifier based on various device information like
118
model name, firmware revision, USB/PCI/PCMCIA IDs, and other properties.
119
This ID is not guaranteed to be unique and may be shared between
120
identical devices with the same firmware, but is intended to be
121
"unique enough" for use as a casual device identifier for various
122
user experience operations. This is not the device's IMEI or ESN since
123
those may not be available before unlocking the device via a PIN.
127
<property name="MasterDevice" type="s" access="read">
129
The physical modem device reference (ie, USB, PCI, PCMCIA device), which
130
may be dependent upon the operating system. In Linux for example, this
131
points to a sysfs path of the usb_device object.
135
<property name="Driver" type="s" access="read">
137
The driver handling the device.
141
<property name="Type" type="u" access="read" tp:type="MM_MODEM_TYPE">
147
<property name="Enabled" type="b" access="read">
149
TRUE if the modem is enabled (ie, powered and usable), FALSE if it is disabled.
153
<property name="EquipmentIdentifier" type="s" access="read">
155
The identity of the device. This will be the IMEI number for
156
GSM devices and the hex-format ESN/MEID for CDMA devices.
160
<property name="UnlockRequired" type="s" access="read">
162
Empty if the device is usable without an unlock code or has already
163
been unlocked. If the device needs to be unlocked before becoming usable this
164
property contains the specific unlock code required. Valid unlock code values
165
are "" (blank), "sim-pin", "sim-puk", "ph-sim-pin", "ph-fsim-pin",
166
"ph-fsim-puk", "sim-pin2", "sim-puk2", "ph-net-pin", "ph-net-puk",
167
"ph-netsub-pin", "ph-netsub-puk", "ph-sp-pin", "ph-sp-puk", "ph-corp-pin", and
172
<property name="UnlockRetries" type="u" access="read">
174
The number of unlock retries remaining for the unlock code given by the property UnlockRequired, or 999 if
175
the device does not support reporting unlock retries.
179
<property name="IpMethod" type="u" access="read" tp:type="MM_MODEM_IP_METHOD">
181
The IP configuration method.
185
<!-- This ought to be of tp:type="MM_MODEM_STATE" but there are a couple
186
more wrinkles to be sorted out before we can export that here.
187
Also, Enabled should be folded into this. -->
188
<property name="State" type="u" access="read">
194
<tp:enum name="MM_MODEM_TYPE" type="u">
195
<tp:enumvalue suffix="GSM" value="1">
200
<tp:enumvalue suffix="CDMA" value="2">
207
<tp:enum name="MM_MODEM_IP_METHOD" type="u">
208
<tp:enumvalue suffix="PPP" value="0">
210
Use PPP to get the address.
213
<tp:enumvalue suffix="STATIC" value="1">
215
Static configuration, the modem will provide IP information.
218
<tp:enumvalue suffix="DHCP" value="2">
225
<tp:enum name="MM_MODEM_STATE_CHANGED_REASON" type="u">
226
<tp:enumvalue suffix="UNKNOWN" value="0">
228
Reason unknown or not reportable.
231
<tp:enumvalue suffix="USER_REQUESTED" value="1">
233
State change was requested by an interface user.
236
<tp:enumvalue suffix="SUSPEND" value="2">
238
State change was caused by a system suspend.