]>
Commit | Line | Data |
---|---|---|
612bb516 JM |
1 | /** |
2 | \page dbus %wpa_supplicant D-Bus API | |
3 | ||
4 | This section documents the %wpa_supplicant D-Bus API. Every D-Bus | |
5 | interface implemented by %wpa_supplicant is described here including | |
6 | their methods, signals, and properties with arguments, returned | |
7 | values, and possible errors. | |
8 | ||
9 | Interfaces: | |
10 | - \ref dbus_main | |
11 | - \ref dbus_interface | |
12 | - \ref dbus_wps | |
13 | - \ref dbus_bss | |
14 | - \ref dbus_network | |
15 | ||
16 | ||
17 | \section dbus_main fi.w1.wpa_supplicant1 | |
18 | ||
19 | Interface implemented by the main %wpa_supplicant D-Bus object | |
20 | registered in the bus with fi.w1.wpa_supplicant1 name. | |
21 | ||
22 | \subsection dbus_main_methods Methods | |
23 | ||
24 | <ul> | |
25 | <li> | |
26 | <h3>CreateInterface ( a{sv} : args ) --> o : interface</h3> | |
27 | <p>Registers a wireless interface in %wpa_supplicant.</p> | |
28 | <h4>Arguments</h4> | |
29 | <dl> | |
30 | <dt>a{sv} : args</dt> | |
31 | <dd> | |
32 | A dictionary with arguments used to add the interface to %wpa_supplicant. The dictionary may contain the following entries: | |
33 | <table> | |
34 | <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> | |
35 | <tr><td>Ifname</td><td>s</td><td>Name of the network interface to control, e.g., wlan0</td><td>Yes</td> | |
36 | <tr><td>Bridge_ifname</td><td>s</td><td>Name of the bridge interface to control, e.g., br0</td><td>No</td> | |
37 | <tr><td>Driver</td><td>s</td><td>Driver name which the interface uses, e.g., nl80211</td><td>No</td> | |
38 | </table> | |
39 | </dd> | |
40 | </dl> | |
41 | <h4>Returns</h4> | |
42 | <dl> | |
43 | <dt>o : interface</dt> | |
44 | <dd>A D-Bus path to object representing created interface</dd> | |
45 | </dl> | |
46 | <h4>Possible errors</h4> | |
47 | <dl> | |
48 | <dt>fi.w1.wpa_supplicant1.InterfaceExists</dt> | |
49 | <dd>%wpa_supplicant already controls this interface.</dd> | |
50 | <dt>fi.w1.wpa_supplicant1.UnknownError</dt> | |
51 | <dd>Creating interface failed for an unknown reason.</dd> | |
52 | <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> | |
53 | <dd>Invalid entries were found in the passed argument.</dd> | |
54 | </dl> | |
55 | </li> | |
56 | ||
57 | <li> | |
58 | <h3>RemoveInterface ( o : interface ) --> nothing</h3> | |
59 | <p>Deregisters a wireless interface from %wpa_supplicant.</p> | |
60 | <h4>Arguments</h4> | |
61 | <dl> | |
62 | <dt>o : interface</dt> | |
63 | <dd>A D-Bus path to an object representing an interface to remove returned by CreateInterface</dd> | |
64 | </dl> | |
65 | <h4>Possible errors</h4> | |
66 | <dl> | |
67 | <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt> | |
68 | <dd>Object pointed by the path doesn't exist or doesn't represent an interface.</dd> | |
69 | <dt>fi.w1.wpa_supplicant1.UnknownError</dt> | |
70 | <dd>Removing interface failed for an unknown reason.</dd> | |
71 | </dl> | |
72 | </li> | |
73 | ||
74 | <li> | |
75 | <h3>GetInterface ( s : ifname ) --> o : interface</h3> | |
76 | <p>Returns a D-Bus path to an object related to an interface which %wpa_supplicant already controls.</p> | |
77 | <h4>Arguments</h4> | |
78 | <dl> | |
79 | <dt>s : ifname</dt> | |
80 | <dd>Name of the network interface, e.g., wlan0</dd> | |
81 | </dl> | |
82 | <h4>Returns</h4> | |
83 | <dl> | |
84 | <dt>o : interface</dt> | |
85 | <dd>A D-Bus path to an object representing an interface</dd> | |
86 | </dl> | |
87 | <h4>Possible errors</h4> | |
88 | <dl> | |
89 | <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt> | |
90 | <dd>An interface with the passed name in not controlled by %wpa_supplicant.</dd> | |
91 | <dt>fi.w1.wpa_supplicant1.UnknownError</dt> | |
92 | <dd>Getting an interface object path failed for an unknown reason.</dd> | |
93 | </dl> | |
94 | </li> | |
95 | </ul> | |
96 | ||
97 | \subsection dbus_main_properties Properties | |
98 | ||
99 | <ul> | |
100 | <li> | |
a2753c28 | 101 | <h3>DebugLevel - s - (read/write)</h3> |
2ea856aa | 102 | <p>Global %wpa_supplicant debugging level. Possible values are |
a2753c28 MH |
103 | "msgdump" (verbose debugging), "debug" (debugging), |
104 | "info" (informative), "warning" (warnings), and "error" (errors).</p> | |
db9133ac WS |
105 | </li> |
106 | ||
107 | <li> | |
108 | <h3>DebugTimestamp - b - (read/write)</h3> | |
2ea856aa | 109 | <p>Global %wpa_supplicant debugging parameter. Determines if timestamps are shown in debug logs.</p> |
db9133ac WS |
110 | </li> |
111 | ||
112 | <li> | |
113 | <h3>DebugShowKeys - b - (read/write)</h3> | |
2ea856aa | 114 | <p>Global %wpa_supplicant debugging parameter. Determines if secrets are shown in debug logs.</p> |
612bb516 JM |
115 | </li> |
116 | ||
117 | <li> | |
118 | <h3>Interfaces - ao - (read)</h3> | |
119 | <p>An array with paths to D-Bus objects representing controlled interfaces each.</p> | |
120 | </li> | |
121 | ||
122 | <li> | |
123 | <h3>EapMethods - as - (read)</h3> | |
124 | <p>An array with supported EAP methods names.</p> | |
125 | </li> | |
126 | </ul> | |
127 | ||
128 | \subsection dbus_main_signals Signals | |
129 | ||
130 | <ul> | |
131 | <li> | |
e376f119 | 132 | <h3>InterfaceAdded ( o : interface, a{sv} : properties )</h3> |
612bb516 JM |
133 | <p>A new interface was added to %wpa_supplicant.</p> |
134 | <h4>Arguments</h4> | |
135 | <dl> | |
136 | <dt>o : interface</dt> | |
137 | <dd>A D-Bus path to an object representing the added interface</dd> | |
138 | </dl> | |
e376f119 WS |
139 | <dl> |
140 | <dt>a{sv} : properties</dt> | |
141 | <dd>A dictionary containing properties of added interface.</dd> | |
142 | </dl> | |
612bb516 JM |
143 | </li> |
144 | ||
145 | <li> | |
146 | <h3>InterfaceRemoved ( o : interface )</h3> | |
147 | <p>An interface was removed from %wpa_supplicant.</p> | |
148 | <h4>Arguments</h4> | |
149 | <dl> | |
150 | <dt>o : interface</dt> | |
151 | <dd>A D-Bus path to an object representing the removed interface</dd> | |
152 | </dl> | |
153 | </li> | |
154 | ||
155 | <li> | |
156 | <h3>PropertiesChanged ( a{sv} : properties )</h3> | |
157 | <p>Some properties have changed.</p> | |
158 | <h4>Arguments</h4> | |
159 | <dl> | |
160 | <dt>a{sv} : properties</dt> | |
161 | <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "DebugParams"</dd> | |
162 | </dl> | |
163 | </li> | |
164 | </ul> | |
165 | ||
166 | ||
167 | \section dbus_interface fi.w1.wpa_supplicant1.Interface | |
168 | ||
169 | Interface implemented by objects related to network interface added to | |
170 | %wpa_supplicant, i.e., returned by | |
171 | fi.w1.wpa_supplicant1.CreateInterface. | |
172 | ||
173 | \subsection dbus_interface_methods Methods | |
174 | ||
175 | <ul> | |
176 | <li> | |
177 | <h3>Scan ( a{sv} : args ) --> nothing</h3> | |
178 | <p>Triggers a scan.</p> | |
179 | <h4>Arguments</h4> | |
180 | <dl> | |
181 | <dt>a{sv} : args</dt> | |
182 | <dd> | |
183 | A dictionary with arguments describing scan type: | |
184 | <table> | |
185 | <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> | |
186 | <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td> | |
187 | <tr><td>SSIDs</td><td>aay</td><td>Array of SSIDs to scan for (applies only if scan type is active)</td><td>No</td> | |
188 | <tr><td>IEs</td><td>aay</td><td>Information elements to used in active scan (applies only if scan type is active)</td><td>No</td> | |
189 | <tr><td>Channels</td><td>a(uu)</td><td>Array of frequencies to scan in form of (center, width) in MHz.</td><td>No</td> | |
190 | </table> | |
191 | </dd> | |
192 | </dl> | |
193 | <h4>Possible errors</h4> | |
194 | <dl> | |
195 | <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> | |
196 | <dd>Invalid entries were found in the passed argument.</dd> | |
197 | </dl> | |
198 | </li> | |
199 | ||
200 | <li> | |
201 | <h3>Disconnect ( ) --> nothing</h3> | |
202 | <p>Disassociates the interface from current network.</p> | |
203 | <h4>Possible errors</h4> | |
204 | <dl> | |
205 | <dt>fi.w1.wpa_supplicant1.Interface.NotConnected</dt> | |
206 | <dd>Interface is not connected to any network.</dd> | |
207 | </dl> | |
208 | </li> | |
209 | ||
210 | <li> | |
211 | <h3>AddNetwork ( a{sv} : args ) --> o : network</h3> | |
212 | <p>Adds a new network to the interface.</p> | |
213 | <h4>Arguments</h4> | |
214 | <dl> | |
215 | <dt>a{sv} : args</dt> | |
216 | <dd>A dictionary with network configuration. Dictionary entries are equivalent to entries in the "network" block in %wpa_supplicant configuration file. Entry values should be appropriate type to the entry, e.g., an entry with key "frequency" should have value type int.</dd> | |
217 | </dl> | |
218 | <h4>Returns</h4> | |
219 | <dl> | |
220 | <dt>o : network</dt> | |
221 | <dd>A D-Bus path to an object representing a configured network</dd> | |
222 | </dl> | |
223 | <h4>Possible errors</h4> | |
224 | <dl> | |
225 | <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> | |
226 | <dd>Invalid entries were found in the passed argument.</dd> | |
227 | <dt>fi.w1.wpa_supplicant1.UnknownError</dt> | |
228 | <dd>Adding network failed for an unknown reason.</dd> | |
229 | </dl> | |
230 | </li> | |
231 | ||
232 | <li> | |
233 | <h3>RemoveNetwork ( o : network ) --> nothing</h3> | |
234 | <p>Removes a configured network from the interface.</p> | |
235 | <h4>Arguments</h4> | |
236 | <dl> | |
237 | <dt>o : network</dt> | |
238 | <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd> | |
239 | </dl> | |
240 | <h4>Possible errors</h4> | |
241 | <dl> | |
242 | <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt> | |
243 | <dd>A passed path doesn't point to any network object.</dd> | |
244 | <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> | |
245 | <dd>A passed path doesn't point to any network object.</dd> | |
246 | <dt>fi.w1.wpa_supplicant1.UnknownError</dt> | |
247 | <dd>Removing network failed for an unknown reason.</dd> | |
248 | </dl> | |
249 | </li> | |
250 | ||
251 | <li> | |
252 | <h3>SelectNetwork ( o : network ) --> nothing</h3> | |
253 | <p>Attempt association with a configured network.</p> | |
254 | <h4>Arguments</h4> | |
255 | <dl> | |
256 | <dt>o : network</dt> | |
257 | <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd> | |
258 | </dl> | |
259 | <h4>Possible errors</h4> | |
260 | <dl> | |
261 | <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt> | |
262 | <dd>A passed path doesn't point to any network object.</dd> | |
263 | <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> | |
264 | <dd>A passed path doesn't point to any network object.</dd> | |
265 | </dl> | |
266 | </li> | |
267 | ||
268 | <li> | |
269 | <h3>AddBlob ( s : name, ay : data ) --> nothing</h3> | |
270 | <p>Adds a blob to the interface.</p> | |
271 | <h4>Arguments</h4> | |
272 | <dl> | |
273 | <dt>s : name</dt> | |
274 | <dd>A name of a blob</dd> | |
275 | <dt>ay : data</dt> | |
276 | <dd>A blob data</dd> | |
277 | </dl> | |
278 | <h4>Possible errors</h4> | |
279 | <dl> | |
280 | <dt>fi.w1.wpa_supplicant1.Interface.BlobExists</dt> | |
281 | <dd>A blob with the specified name already exists.</dd> | |
282 | </dl> | |
283 | </li> | |
284 | ||
285 | <li> | |
286 | <h3>RemoveBlob ( s : name ) --> nothing</h3> | |
287 | <p>Removes the blob from the interface.</p> | |
288 | <h4>Arguments</h4> | |
289 | <dl> | |
290 | <dt>s : name</dt> | |
291 | <dd>A name of the blob to remove</dd> | |
292 | </dl> | |
293 | <h4>Possible errors</h4> | |
294 | <dl> | |
295 | <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt> | |
296 | <dd>A blob with the specified name doesn't exist.</dd> | |
297 | </dl> | |
298 | </li> | |
299 | ||
300 | <li> | |
301 | <h3>GetBlob ( s : name ) --> ay : data</h3> | |
302 | <p>Returns the blob data of a previously added blob.</p> | |
303 | <h4>Arguments</h4> | |
304 | <dl> | |
305 | <dt>s : name</dt> | |
306 | <dd>A name of the blob</dd> | |
307 | </dl> | |
308 | <h4>Returns</h4> | |
309 | <dl> | |
310 | <dt>ay : data</dt> | |
311 | <dd>A blob data</dd> | |
312 | </dl> | |
313 | <h4>Possible errors</h4> | |
314 | <dl> | |
315 | <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt> | |
316 | <dd>A blob with the specified name doesn't exist.</dd> | |
317 | </dl> | |
318 | </li> | |
319 | </ul> | |
320 | ||
321 | \subsection dbus_interface_properties Properties | |
322 | ||
323 | <ul> | |
324 | <li> | |
325 | <h3>Capabilities - a{sv} - (read)</h3> | |
326 | <p>Capabilities of the interface. Dictionary contains following entries:</p> | |
327 | <table> | |
328 | <tr><th>Key</th><th>Value type</th><th>Description</th> | |
329 | <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "none"</td> | |
330 | <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "wep104", "wep40"</td> | |
331 | <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-eap", "ieee8021x", "wpa-none", "wps", "none"</td> | |
332 | <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td> | |
333 | <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td> | |
334 | <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td> | |
335 | <tr><td>Modes</td><td>as</td><td>Possible array elements: "infrastructure", "ad-hoc", "ap"</td> | |
336 | </table> | |
337 | </li> | |
338 | ||
339 | <li> | |
340 | <h3>State - s - (read)</h3> | |
341 | <p>A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".</p> | |
342 | </li> | |
343 | ||
344 | <li> | |
345 | <h3>Scanning - b - (read)</h3> | |
346 | <p>Determines if the interface is already scanning or not</p> | |
347 | </li> | |
348 | ||
349 | <li> | |
350 | <h3>ApScan - u - (read/write)</h3> | |
351 | <p>Identical to ap_scan entry in %wpa_supplicant configuration file. Possible values are 0, 1 or 2.</p> | |
352 | </li> | |
353 | ||
354 | <li> | |
355 | <h3>Ifname - s - (read)</h3> | |
356 | <p>Name of network interface controlled by the interface, e.g., wlan0.</p> | |
357 | </li> | |
358 | ||
359 | <li> | |
360 | <h3>BridgeIfname - s - (read)</h3> | |
361 | <p>Name of bridge network interface controlled by the interface, e.g., br0.</p> | |
362 | </li> | |
363 | ||
364 | <li> | |
365 | <h3>Driver - s - (read)</h3> | |
366 | <p>Name of driver used by the interface, e.g., nl80211.</p> | |
367 | </li> | |
368 | ||
369 | <li> | |
370 | <h3>CurrentBSS - o - (read)</h3> | |
371 | <p>Path to D-Bus object representing BSS which %wpa_supplicant is associated with, or "/" if is not associated at all.</p> | |
372 | </li> | |
373 | ||
374 | <li> | |
375 | <h3>CurrentNetwork - o - (read)</h3> | |
376 | <p>Path to D-Bus object representing configured network which %wpa_supplicant uses at the moment, or "/" if doesn't use any.</p> | |
377 | </li> | |
378 | ||
379 | <li> | |
380 | <h3>Blobs - as - (read)</h3> | |
381 | <p>List of blobs names added to the Interface.</p> | |
382 | </li> | |
383 | ||
384 | <li> | |
385 | <h3>BSSs - ao - (read)</h3> | |
386 | <p>List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.</p> | |
387 | </li> | |
388 | ||
389 | <li> | |
390 | <h3>Networks - ao - (read)</h3> | |
391 | <p>List of D-Bus objects paths representing configured networks.</p> | |
392 | </li> | |
393 | </ul> | |
394 | ||
395 | \subsection dbus_interface_signals Signals | |
396 | ||
397 | <ul> | |
398 | <li> | |
399 | <h3>ScanDone ( b : success )</h3> | |
400 | <p>Scanning finished. </p> | |
401 | <h4>Arguments</h4> | |
402 | <dl> | |
403 | <dt>s : success</dt> | |
404 | <dd>Determines if scanning was successful. If so, results are available.</dd> | |
405 | </dl> | |
406 | </li> | |
407 | ||
408 | <li> | |
409 | <h3>StateChanged ( s : newState, s : oldState )</h3> | |
410 | <p>Interface state has changed.</p> | |
411 | <h4>Arguments</h4> | |
412 | <dl> | |
413 | <dt>s : newState</dt> | |
414 | <dd>A state which the interface goes to</dd> | |
415 | <dt>s : oldState</dt> | |
416 | <dd>A state which the interface goes from</dd> | |
417 | </dl> | |
418 | </li> | |
419 | ||
420 | <li> | |
e376f119 | 421 | <h3>BSSAdded ( o : BSS, a{sv} : properties )</h3> |
612bb516 JM |
422 | <p>Interface became aware of a new BSS.</p> |
423 | <h4>Arguments</h4> | |
424 | <dl> | |
425 | <dt>o : BSS</dt> | |
426 | <dd>A D-Bus path to an object representing the new BSS.</dd> | |
427 | </dl> | |
e376f119 WS |
428 | <dl> |
429 | <dt>a{sv} : properties</dt> | |
430 | <dd>A dictionary containing properties of added BSS.</dd> | |
431 | </dl> | |
612bb516 JM |
432 | </li> |
433 | ||
434 | <li> | |
435 | <h3>BSSRemoved ( o : BSS )</h3> | |
436 | <p>BSS disappeared.</p> | |
437 | <h4>Arguments</h4> | |
438 | <dl> | |
439 | <dt>o : BSS</dt> | |
440 | <dd>A D-Bus path to an object representing the BSS.</dd> | |
441 | </dl> | |
442 | </li> | |
443 | ||
444 | <li> | |
445 | <h3>BlobAdded ( s : blobName )</h3> | |
446 | <p>A new blob has been added to the interface.</p> | |
447 | <h4>Arguments</h4> | |
448 | <dl> | |
449 | <dt>s : blobName</dt> | |
450 | <dd>A name of the added blob.</dd> | |
451 | </dl> | |
452 | </li> | |
453 | ||
454 | <li> | |
455 | <h3>BlobRemoved ( s : blobName )</h3> | |
456 | <p>A blob has been removed from the interface.</p> | |
457 | <h4>Arguments</h4> | |
458 | <dl> | |
459 | <dt>s : blobName</dt> | |
460 | <dd>A name of the removed blob.</dd> | |
461 | </dl> | |
462 | </li> | |
463 | ||
464 | <li> | |
e376f119 | 465 | <h3>NetworkAdded ( o : network, a{sv} : properties )</h3> |
612bb516 JM |
466 | <p>A new network has been added to the interface.</p> |
467 | <h4>Arguments</h4> | |
468 | <dl> | |
469 | <dt>o : network</dt> | |
470 | <dd>A D-Bus path to an object representing the added network.</dd> | |
471 | </dl> | |
e376f119 WS |
472 | <dl> |
473 | <dt>a{sv} : properties</dt> | |
474 | <dd>A dictionary containing properties of added network.</dd> | |
475 | </dl> | |
612bb516 JM |
476 | </li> |
477 | ||
478 | <li> | |
479 | <h3>NetworkRemoved ( o : network )</h3> | |
480 | <p>The network has been removed from the interface.</p> | |
481 | <h4>Arguments</h4> | |
482 | <dl> | |
483 | <dt>o : network</dt> | |
484 | <dd>A D-Bus path to an object representing the removed network.</dd> | |
485 | </dl> | |
486 | </li> | |
487 | ||
488 | <li> | |
489 | <h3>NetworkSelected ( o : network )</h3> | |
490 | <p>The network has been selected.</p> | |
491 | <h4>Arguments</h4> | |
492 | <dl> | |
493 | <dt>o : network</dt> | |
494 | <dd>A D-Bus path to an object representing the selected network.</dd> | |
495 | </dl> | |
496 | </li> | |
497 | ||
498 | <li> | |
499 | <h3>PropertiesChanged ( a{sv} : properties )</h3> | |
500 | <p>Some properties have changed.</p> | |
501 | <h4>Arguments</h4> | |
502 | <dl> | |
503 | <dt>a{sv} : properties</dt> | |
504 | <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ApScan", "Scanning", "CurrentBSS", "CurrentNetwork"</dd> | |
505 | </dl> | |
506 | </li> | |
507 | </ul> | |
508 | ||
509 | ||
510 | \section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS | |
511 | ||
512 | Interface implemented by objects related to network interface added to | |
d89530f7 | 513 | %wpa_supplicant, i.e., returned by fi.w1.wpa_supplicant1.CreateInterface. |
612bb516 JM |
514 | |
515 | \subsection dbus_wps_methods Methods | |
516 | ||
517 | <ul> | |
518 | <li> | |
519 | <h3>Start ( a{sv} : args ) --> a{sv} : output</h3> | |
520 | <p>Starts WPS configuration.</p> | |
521 | <h4>Arguments</h4> | |
522 | <dl> | |
523 | <dt>a{sv} : args</dt> | |
524 | <dd> | |
525 | A dictionary with arguments used to start WPS configuration. The dictionary may contain the following entries: | |
526 | <table> | |
527 | <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> | |
528 | <tr><td>Role</td><td>s</td><td>The device's role. Possible values are "enrollee" and "registrar".</td><td>Yes</td> | |
529 | <tr><td>Type</td><td>s</td><td>WPS authentication type. Applies only for enrollee role. Possible values are "pin" and "pbc".</td><td>Yes, for enrollee role; otherwise no</td> | |
530 | <tr><td>Pin</td><td>s</td><td>WPS Pin.</td><td>Yes, for registrar role; otherwise optional</td> | |
531 | <tr><td>Bssid</td><td>ay</td><td></td><td>No</td> | |
532 | </table> | |
533 | </dd> | |
534 | </dl> | |
535 | <h4>Returns</h4> | |
536 | <dl> | |
537 | <dt>a{sv} : output</dt> | |
538 | <dd> | |
539 | <table> | |
540 | <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> | |
541 | <tr><td>Pin</td><td>s</td><td>Newly generated PIN, if not specified for enrollee role and pin authentication type.</td><td>No</td> | |
542 | </table> | |
543 | </dd> | |
544 | </dl> | |
545 | <h4>Possible errors</h4> | |
546 | <dl> | |
547 | <dt>fi.w1.wpa_supplicant1.UnknownError</dt> | |
548 | <dd>Starting WPS configuration failed for an unknown reason.</dd> | |
549 | <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> | |
550 | <dd>Invalid entries were found in the passed argument.</dd> | |
551 | </dl> | |
552 | </li> | |
553 | </ul> | |
554 | ||
555 | \subsection dbus_wps_properties Properties | |
556 | ||
557 | <ul> | |
558 | <li> | |
559 | <h3>ProcessCredentials - b - (read/write)</h3> | |
560 | <p>Determines if the interface will process the credentials (credentials_processed configuration file parameter).</p> | |
561 | </li> | |
562 | </ul> | |
563 | ||
564 | \subsection dbus_wps_signals Signals | |
565 | ||
566 | <ul> | |
567 | <li> | |
568 | <h3>Event ( s : name, a{sv} : args )</h3> | |
569 | <p>WPS event occurred.</p> | |
570 | <h4>Arguments</h4> | |
571 | <dl> | |
572 | <dt>s : event</dt> | |
573 | <dd>Event type. Possible values are: "success, "fail" and "m2d"</dd> | |
574 | <dt>a{sv} : args</dt> | |
575 | <dd> | |
576 | Event arguments. Empty for success event, one entry ( "msg" : i ) for fail event and following entries for m2d event: | |
577 | <table> | |
578 | <tr><th>config_methods</th><th>Value type</th> | |
579 | <tr><td>manufacturer</td><td>q</td> | |
580 | <tr><td>model_name</td><td>ay</td> | |
581 | <tr><td>model_number</td><td>ay</td> | |
582 | <tr><td>serial_number</td><td>ay</td> | |
583 | <tr><td>dev_name</td><td>ay</td> | |
584 | <tr><td>primary_dev_type</td><td>ay</td> | |
585 | <tr><td>config_error</td><td>q</td> | |
586 | <tr><td>dev_password_id</td><td>q</td> | |
587 | </table> | |
588 | </dd> | |
589 | </dl> | |
590 | </li> | |
591 | ||
592 | <li> | |
593 | <h3>Credentials ( a{sv} : credentials )</h3> | |
594 | <p>WPS credentials. Dictionary contains:</p> | |
595 | <table> | |
596 | <tr><th>Key</th><th>Value type</th><th>Description</th> | |
597 | <tr><td>BSSID</td><td>ay</td><td></td> | |
598 | <tr><td>SSID</td><td>s</td><td></td> | |
599 | <tr><td>AuthType</td><td>as</td><td>Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk"</td> | |
600 | <tr><td>EncrType</td><td>as</td><td>Possible array elements: "none", "wep", "tkip", "aes"</td> | |
601 | <tr><td>Key</td><td>ay</td><td>Key data</td> | |
602 | <tr><td>KeyIndex</td><td>u</td><td>Key index</td> | |
603 | </table> | |
604 | </li> | |
605 | ||
606 | <li> | |
607 | <h3>PropertiesChanged ( a{sv} : properties )</h3> | |
608 | <p>Some properties have changed.</p> | |
609 | <h4>Arguments</h4> | |
610 | <dl> | |
611 | <dt>a{sv} : properties</dt> | |
612 | <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ProcessCredentials"</dd> | |
613 | </dl> | |
614 | </li> | |
615 | </ul> | |
616 | ||
617 | ||
618 | \section dbus_bss fi.w1.wpa_supplicant1.Interface.BSS | |
619 | ||
620 | Interface implemented by objects representing a scanned BSSs, i.e., | |
621 | scan results. | |
622 | ||
623 | \subsection dbus_bss_properties Properties | |
624 | ||
625 | <ul> | |
626 | <li> | |
58605c6e WS |
627 | <h3>BSSID - ay - (read)</h3> |
628 | <p>BSSID of the BSS.</p> | |
629 | </li> | |
630 | <li> | |
631 | <h3>SSID - ay - (read)</h3> | |
632 | <p>SSID of the BSS.</p> | |
633 | </li> | |
634 | <li> | |
635 | <h3>WPAIE - ay - (read)</h3> | |
636 | <p>WPA information element of the BSS. The second byte contain number of bytes following it.</p> | |
637 | </li> | |
638 | <li> | |
639 | <h3>RSNIE - ay - (read)</h3> | |
640 | <p>RSN information element of the BSS. The second byte contain number of bytes following it.</p> | |
641 | </li> | |
642 | <li> | |
643 | <h3>WPSIE - ay - (read)</h3> | |
644 | <p>WPS information element of the BSS. The second byte contain number of bytes following it.</p> | |
645 | </li> | |
646 | <li> | |
647 | <h3>Privacy - b - (read)</h3> | |
648 | <p>Indicates if BSS supports privacy.</p> | |
649 | </li> | |
650 | <li> | |
651 | <h3>Mode - s - (read)</h3> | |
652 | <p>Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".</p> | |
653 | </li> | |
654 | <li> | |
655 | <h3>Frequency - q - (read)</h3> | |
656 | <p>Frequency of the BSS in MHz.</p> | |
657 | </li> | |
658 | <li> | |
659 | <h3>MaxRate - q - (read)</h3> | |
660 | <p>Maximal data rate of the BSS in bits per second.</p> | |
661 | </li> | |
662 | <li> | |
663 | <h3>Signal - n - (read)</h3> | |
664 | <p>Signal strength of the BSS.</p> | |
612bb516 JM |
665 | </li> |
666 | </ul> | |
667 | ||
668 | ||
669 | \section dbus_network fi.w1.wpa_supplicant1.Interface.Network | |
670 | ||
671 | Interface implemented by objects representing configured networks, | |
672 | i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork. | |
673 | ||
674 | \subsection dbus_network_properties Properties | |
675 | ||
676 | <ul> | |
677 | <li> | |
678 | <h3>Enabled - b - (read/write)</h3> | |
679 | <p>Determines if the configured network is enabled or not.</p> | |
680 | </li> | |
681 | ||
682 | <li> | |
683 | <h3>Properties - a{sv} - (read)</h3> | |
684 | <p>Properties of the configured network. Dictionary contains entries from "network" block of %wpa_supplicant configuration file. All values are string type, e.g., frequency is "2437", not 2437. | |
685 | </li> | |
686 | </ul> | |
687 | ||
688 | \subsection dbus_network_signals Signals | |
689 | ||
690 | <ul> | |
691 | <li> | |
692 | <h3>PropertiesChanged ( a{sv} : properties )</h3> | |
693 | <p>Some properties have changed.</p> | |
694 | <h4>Arguments</h4> | |
695 | <dl> | |
696 | <dt>a{sv} : properties</dt> | |
697 | <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "Enabled"</dd> | |
698 | </dl> | |
699 | </li> | |
700 | </ul> | |
701 | ||
702 | */ |