4 Service org.moblin.connman
5 Interface org.moblin.connman.Service
6 Object path [variable prefix]/{service0,service1,...}
8 Methods dict GetProperties()
10 Returns properties for the service object. See
11 the properties section for available properties.
13 Possible Errors: [service].Error.InvalidArguments
15 void SetProperty(string name, variant value)
17 Changes the value of the specified property. Only
18 properties that are listed as read-write are
19 changeable. On success a PropertyChanged signal
22 Possible Errors: [service].Error.InvalidArguments
23 [service].Error.InvalidProperty
25 void ClearProperty(string name)
27 Clears the value of the specified property.
29 Possible Errors: [service].Error.InvalidArguments
30 [service].Error.InvalidProperty
34 Connect this service. It will attempt to connect
35 WiFi, WiMAX or Bluetooth services.
37 For Ethernet devices this method can only be used
38 if it has previously been disconnected. Otherwise
39 the plugging of a cable will trigger connecting
40 automatically. If no cable is plugged in this method
43 This method call will only return in case of an
44 error or when the service is fully connected. So
45 setting a longer D-Bus timeout might be a really
48 Possible Errors: [service].Error.InvalidArguments
52 Disconnect this service. If the service is not
53 connected an error message will be generated.
55 On Ethernet devices this will disconnect the IP
56 details from the service. It will not magically
57 unplug the cable. When no cable is plugged in this
60 This method can also be used to abort a previous
61 connectiong attempt via the Connect method.
63 Possible Errors: [service].Error.InvalidArguments
67 A successfully connected service with Favorite=true
68 can be removed this way. If it is connected, it will
69 be automatically disconnected first.
71 If the service requires a passphrase it will be
72 cleared and forgotten when removing.
74 This is similar to setting the Favorite property
75 to false, but that is currently not supported.
77 In the case a connection attempt failed and the
78 service is in the State=failure, this method can
79 also be used to reset the service.
81 Calling this method on Ethernet devices will cause
82 an error message. It is not possible to remove these
85 Possible Errors: [service].Error.InvalidArguments
87 void MoveBefore(object service)
89 If a service has been used before, this allows a
90 reorder of the favorite services.
92 The target service object must be part of this
93 profile. Moving between profiles is not supported.
95 Possible Errors: [service].Error.InvalidArguments
97 void MoveAfter(object service)
99 If a service has been used before, this allows a
100 reorder of the favorite services.
102 The target service object must be part of this
103 profile. Moving between profiles is not supported.
105 Possible Errors: [service].Error.InvalidArguments
107 Signals PropertyChanged(string name, variant value)
109 This signal indicates a changed value of the given
112 Properties string State [readonly]
114 The service state information.
116 Valid states are "idle", "failure", "association",
117 "configuration" and "ready".
119 Also "login" and "online" states are used. The
120 state "online" signals that an Internet connection
121 is available and has been verified.
123 string Error [readonly]
125 The service error status details.
127 When error occur during connection or disconnection
128 the detailed information are represented in this
129 property to help the user interface to present the
130 user with alternate options.
132 This property is only valid when the service is in
133 the "failure" state. Otherwise it might be empty or
136 Current defined error code is "dhcp-failed".
138 string Name [readonly]
140 The service name (for example "Wireless" etc.)
142 This name can be used for directly displaying it in
143 the application. It has pure informational purpose.
145 For Ethernet devices and hidden WiFi networks it is
146 not guaranteed that this property is present.
148 string Type [readonly]
150 The service type (for example "ethernet", "wifi" etc.)
152 This information should only be used to determine
153 advanced properties or showing the correct icon
156 string Mode [readonly]
158 If the service type is WiFi or Cellular, then this
159 property is present and contains the mode of the
162 For WiFi services the possible values are "managed"
163 and "adhoc". For Cellular services it describes the
164 network technology. Possible values are "gprs", "edge"
167 This property might be only present for WiFi and
170 string Security [readonly]
172 If the service type is WiFi, then this property is
173 present and contains the security method or key
176 Possible values are "none", "wep", "psk" and
177 also "ieee8021x". Alternate values for "psk"
178 can also be "wpa" and "rsn".
180 This property might be only present for WiFi
183 string Passphrase [readwrite]
185 If the service type is WiFi, then this property
186 can be used to store a passphrase.
188 No PropertyChanged signals will be send for this
189 property. The PassphraseRequired property should
190 be monitored instead.
192 This property might also not always be included
193 since it is protected by a different security policy.
195 boolean PassphraseRequired [readonly]
197 If the service type is WiFi, then this property
198 indicates if a passphrase is required.
200 If a passphrase has been set already or if no
201 passphrase is needed, then this property will
204 uint8 Strength [readonly]
206 Indicates the signal strength of the service. This
207 is a normalized value between 0 and 100.
209 This property will not be present for Ethernet
212 boolean Favorite [readonly]
214 Will be true if a cable is plugged in or the user
215 selected and successfully connected to this service.
217 This value is automatically changed and to revert
218 it back to false the Remove() method needs to be
221 boolean Immutable [readonly]
223 This value will be set to true if the service is
224 configured externally via a configuration file.
226 The only valid operation are Connect() and of
227 course Disconnect(). The Remove() method will
230 boolean AutoConnect [readwrite]
232 If set to true, this service will auto-connect
233 when not other connection is available.
235 For favorite services it is possible to change
236 this value to prevent or permit automatic
239 boolean SetupRequired [readonly]
241 If the service is Cellular, then this property
242 indicates that some extra setup steps are required.
244 In most cases it is required to fill in the APN
247 string APN [readwrite]
249 If the service is Cellular, then this property
250 contains the APN details.
252 The APN is network provider specific and even
253 sometimes data plan specific. Possible examples
254 are "isp.cingular" or "internet.t-mobile".
256 string MCC [readonly]
258 If the service is Cellular, then this property
259 contains the Mobile Country Code.
261 string MNC [readonly]
263 If the service is Cellular, then this property
264 contains the Mobile Network Code.
266 boolean Roaming [readonly]
268 This property indicates if this service is roaming.
270 In the case of Cellular services this normally
271 indicates connections to a foreign provider when
274 array{string} Nameservers [readonly]
276 The list of currently active nameservers for this
277 service. If the server is not in READY, LOGIN or
278 ONLINE state than this list will be empty.
280 Global nameservers are automatically added to this
281 list. The array represents a sorted list of the
282 current nameservers. The first one has the highest
283 priority and is used by default.
285 When using DHCP this array represents the nameservers
286 provided by the network. In case of manual settings,
287 the ones from Nameservers.Configuration are used.
289 array{string} Nameservers.Configuration [readwrite]
291 The list of manually configured domain name
292 servers. Some 3G networks don't provide correct
293 name servers and this allows for an override.
295 This array is sorted by priority and the first
296 entry in the list represents the nameserver with
297 the highest priority.
299 When using manual configuration and no global
300 nameservers are configured, then it is useful
301 to configure this setting.
303 array{string} Domains [readonly]
305 The list of currently used search domains.
307 array{string} Domains.Configuration [readwrite]
309 The list of manually configured search domains.
313 string Method [readonly]
315 Possible values are "dhcp", "manual"
318 string Address [readonly]
320 The current configured IPv4 address.
322 string Netmask [readonly]
324 The current configured IPv4 netmask.
326 string Gateway [readonly]
328 The current configured IPv4 gateway.
330 dict IPv4.Configuration [readwrite]
332 Same values as IPv4 property. The IPv4 represents
333 the actual system configuration while this allows
336 dict Proxy [readonly]
338 string Method [readonly]
340 Possible values are "direct", "auto",
341 "manual" and "auto-config".
343 If the DHCP server provides an automatic
344 configuration URL, then this value is set
345 to "auto-config". The PAC file will be
346 referenced by the URL value.
348 If no automatic configuration is available,
349 then "direct" is set.
351 The values "auto" and "manual" are not yet
354 string URL [readonly]
356 Automatic proxy configuration URL.
358 dict Ethernet [readonly]
360 string Method [readonly]
362 Possible values are "auto" and "manual".
364 string Interface [readonly]
366 Interface name (for example eth0).
368 string Address [readonly]
370 Ethernet device address (MAC address).
372 uint16 MTU [readonly]
374 The Ethernet MTU (default is 1500).
376 uint16 Speed [readonly]
378 Selected speed of the line.
380 This information might not always be
383 string Duplex [readonly]
385 Selected duplex settings of the line.
387 Possible values are "half" and "full".
389 This information might not always be