aboutsummaryrefslogtreecommitdiff
path: root/introspection/mm-modem.xml
blob: 7d54dd30e67576f6aca6f26c4aab8a7d9b8c0122 (plain)
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
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">

  <interface name="org.freedesktop.DBus.Properties">
    <signal name="MmPropertiesChanged">
      <tp:docstring>
	One or more properties' values changed.
      </tp:docstring>
      <arg name="interface" type="s">
	<tp:docstring>
	  The D-Bus interface of the changed properties.
	</tp:docstring>
      </arg>
      <arg name="properties" type="a{sv}">
	<tp:docstring>
	  The changed property names and their new values.
	</tp:docstring>
      </arg>
    </signal>
  </interface>

  <interface name="org.freedesktop.ModemManager.Modem">
    <method name="Enable">
      <tp:docstring>
	Enable the device. Initializes the modem.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_enable"/>
      <arg name="enable" type="b" direction="in">
	<tp:docstring>
	  True to enable the device, False to disable.
	</tp:docstring>
      </arg>
    </method>

    <method name="Connect">
      <tp:docstring>
	Dial in.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_connect"/>
      <arg name="number" type="s" direction="in">
	<tp:docstring>
	  The number to use for dialing.
      </tp:docstring>
      </arg>
    </method>

    <method name="Disconnect">
      <tp:docstring>
	Disconnect modem.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_disconnect"/>
    </method>

    <method name="GetIP4Config">
      <tp:docstring>
	Request the IP4 configuration from the device.
	Note that it'll only be supported for IPMethod MM_MODEM_IP_METHOD_STATIC.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_ip4_config"/>
      <arg name="address" type="(uuuu)" direction="out">
	Structure containing IP4 address, DNS1, DNS2, DNS3.
	The DNS list is padded with 0's if there's less than 3 DNS servers.
      </arg>
    </method>

    <method name="GetInfo">
      <tp:docstring>
        Get the card information (manufacturer, modem, version).
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_info"/>
      <arg name="info" type="(sss)" direction="out">
        <tp:docstring>
          Structure containing manufacturer, model, and version (revision) of the card.
        </tp:docstring>
      </arg>
    </method>

    <method name="FactoryReset">
      <tp:docstring>
        Reset the modem to as close to factory state as possible.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_factory_reset"/>
      <arg name="code" type="s" direction="in">
        Carrier-supplied code required to reset the modem.  Ignored if not required.
      </arg>
    </method>

    <property name="Device" type="s" access="read">
      <tp:docstring>
	The modem port to use for IP configuration and traffic.
      </tp:docstring>
    </property>

    <property name="MasterDevice" type="s" access="read">
      <tp:docstring>
	The physical modem device reference (ie, USB, PCI, PCMCIA device), which
	may be dependent upon the operating system.  In Linux for example, this
	points to a sysfs path of the usb_device object.
      </tp:docstring>
    </property>

    <property name="Driver" type="s" access="read">
      <tp:docstring>
        The driver handling the device.
      </tp:docstring>
    </property>

    <property name="Type" type="u" access="read" tp:type="MM_MODEM_TYPE">
      <tp:docstring>
        The modem type.
      </tp:docstring>
    </property>

    <property name="Enabled" type="b" access="read">
      <tp:docstring>
        TRUE if the modem is enabled (ie, powered and usable), FALSE if it is disabled.
      </tp:docstring>
    </property>

    <property name="EquipmentIdentifier" type="s" access="read">
      <tp:docstring>
        The identity of the device. This will be the IMEI number for
        GSM devices and the hex-format ESN/MEID for CDMA devices.
      </tp:docstring>
    </property>

    <property name="UnlockRequired" type="s" access="read">
      <tp:docstring>
        Empty if the device is usable without an unlock code or has already
        been unlocked. If the device needs to be unlocked before becoming usable this
        property contains the specific unlock code required.  Valid unlock code values
        are "" (blank), "sim-pin", "sim-puk", "ph-sim-pin", "ph-fsim-pin",
        "ph-fsim-puk", "sim-pin2", "sim-puk2", "ph-net-pin", "ph-net-puk",
        "ph-netsub-pin", "ph-netsub-puk", "ph-sp-pin", "ph-sp-puk", "ph-corp-pin", and
        "ph-corp-puk".
      </tp:docstring>
    </property>

    <property name="UnlockRetries" type="u" access="read">
      <tp:docstring>
        The number of unlock retries remaining for the unlock code given by the property UnlockRequired, or 999 if
        the device does not support reporting unlock retries.
      </tp:docstring>
    </property>

    <property name="IpMethod" type="u" access="read" tp:type="MM_MODEM_IP_METHOD">
      <tp:docstring>
        The IP configuration method.
      </tp:docstring>
    </property>

    <tp:enum name="MM_MODEM_TYPE" type="u">
      <tp:enumvalue suffix="GSM" value="1">
	<tp:docstring>
	  A GSM device.
	</tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="CDMA" value="2">
	<tp:docstring>
	  A CDMA device.
	</tp:docstring>
      </tp:enumvalue>
    </tp:enum>

    <tp:enum name="MM_MODEM_IP_METHOD" type="u">
      <tp:enumvalue suffix="PPP" value="0">
	<tp:docstring>
	  Use PPP to get the address.
	</tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="STATIC" value="1">
	<tp:docstring>
	  Static configuration, the modem will provide IP information.
	</tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="DHCP" value="2">
	<tp:docstring>
	  Use DHCP
	</tp:docstring>
      </tp:enumvalue>
    </tp:enum>

  </interface>
</node>