]> git.ipfire.org Git - thirdparty/hostap.git/blob - doc/dbus.doxygen
tests: Additional osu_nai2 parsing coverage
[thirdparty/hostap.git] / doc / dbus.doxygen
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_p2pdevice
14 - \ref dbus_bss
15 - \ref dbus_network
16 - \ref dbus_peer
17 - \ref dbus_group
18 - \ref dbus_persistent_group
19 - \ref dbus_mesh
20
21
22 \section dbus_main fi.w1.wpa_supplicant1
23
24 Interface implemented by the main wpa_supplicant D-Bus object
25 registered in the bus with fi.w1.wpa_supplicant1 name.
26
27 \subsection dbus_main_methods Methods
28
29 <ul>
30 <li>
31 <h3>CreateInterface ( a{sv} : args ) --> o : interface</h3>
32 <p>Registers a wireless interface in wpa_supplicant.</p>
33 <h4>Arguments</h4>
34 <dl>
35 <dt>a{sv} : args</dt>
36 <dd>
37 A dictionary with arguments used to add the interface to wpa_supplicant. The dictionary may contain the following entries:
38 <table>
39 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
40 <tr><td>Ifname</td><td>s</td><td>Name of the network interface to control, e.g., wlan0</td><td>Yes</td>
41 <tr><td>BridgeIfname</td><td>s</td><td>Name of the bridge interface to control, e.g., br0</td><td>No</td>
42 <tr><td>Driver</td><td>s</td><td>Driver name which the interface uses, e.g., nl80211</td><td>No</td>
43 <tr><td>ConfigFile</td><td>s</td><td>Configuration file path</td><td>No</td>
44 </table>
45 </dd>
46 </dl>
47 <h4>Returns</h4>
48 <dl>
49 <dt>o : interface</dt>
50 <dd>A D-Bus path to object representing created interface</dd>
51 </dl>
52 <h4>Possible errors</h4>
53 <dl>
54 <dt>fi.w1.wpa_supplicant1.InterfaceExists</dt>
55 <dd>wpa_supplicant already controls this interface.</dd>
56 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
57 <dd>Creating interface failed for an unknown reason.</dd>
58 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
59 <dd>Invalid entries were found in the passed argument.</dd>
60 </dl>
61 </li>
62
63 <li>
64 <h3>RemoveInterface ( o : interface ) --> nothing</h3>
65 <p>Deregisters a wireless interface from wpa_supplicant.</p>
66 <h4>Arguments</h4>
67 <dl>
68 <dt>o : interface</dt>
69 <dd>A D-Bus path to an object representing an interface to remove returned by CreateInterface</dd>
70 </dl>
71 <h4>Possible errors</h4>
72 <dl>
73 <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt>
74 <dd>Object pointed by the path doesn't exist or doesn't represent an interface.</dd>
75 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
76 <dd>Removing interface failed for an unknown reason.</dd>
77 </dl>
78 </li>
79
80 <li>
81 <h3>GetInterface ( s : ifname ) --> o : interface</h3>
82 <p>Returns a D-Bus path to an object related to an interface which wpa_supplicant already controls.</p>
83 <h4>Arguments</h4>
84 <dl>
85 <dt>s : ifname</dt>
86 <dd>Name of the network interface, e.g., wlan0</dd>
87 </dl>
88 <h4>Returns</h4>
89 <dl>
90 <dt>o : interface</dt>
91 <dd>A D-Bus path to an object representing an interface</dd>
92 </dl>
93 <h4>Possible errors</h4>
94 <dl>
95 <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt>
96 <dd>An interface with the passed name in not controlled by wpa_supplicant.</dd>
97 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
98 <dd>Getting an interface object path failed for an unknown reason.</dd>
99 </dl>
100 </li>
101
102 <li>
103 <h3>ExpectDisconnect ( ) --> nothing</h3>
104 <p>Notify wpa_supplicant of an externally triggered disconnection, e.g., due to system suspend.</p>
105 </li>
106 </ul>
107
108 \subsection dbus_main_properties Properties
109
110 <ul>
111 <li>
112 <h3>DebugLevel - s - (read/write)</h3>
113 <p>Global wpa_supplicant debugging level. Possible values are
114 "msgdump" (verbose debugging), "debug" (debugging),
115 "info" (informative), "warning" (warnings), and "error" (errors).</p>
116 </li>
117
118 <li>
119 <h3>DebugTimestamp - b - (read/write)</h3>
120 <p>Global wpa_supplicant debugging parameter. Determines if timestamps are shown in debug logs.</p>
121 </li>
122
123 <li>
124 <h3>DebugShowKeys - b - (read/write)</h3>
125 <p>Global wpa_supplicant debugging parameter. Determines if secrets are shown in debug logs.</p>
126 </li>
127
128 <li>
129 <h3>Interfaces - ao - (read)</h3>
130 <p>An array with paths to D-Bus objects representing controlled interfaces each.</p>
131 </li>
132
133 <li>
134 <h3>EapMethods - as - (read)</h3>
135 <p>An array with supported EAP methods names.</p>
136 </li>
137
138 <li>
139 <h3>Capabilities - as - (read)</h3>
140 <p>An array with supported capabilities (e.g., "ap", "ibss-rsn", "p2p", "interworking").</p>
141 </li>
142
143 <li>
144 <h3>WFDIEs - ay - (read/write)</h3>
145 <p>Wi-Fi Display subelements.</p>
146 </li>
147 </ul>
148
149 \subsection dbus_main_signals Signals
150
151 <ul>
152 <li>
153 <h3>InterfaceAdded ( o : interface, a{sv} : properties )</h3>
154 <p>A new interface was added to wpa_supplicant.</p>
155 <h4>Arguments</h4>
156 <dl>
157 <dt>o : interface</dt>
158 <dd>A D-Bus path to an object representing the added interface</dd>
159 </dl>
160 <dl>
161 <dt>a{sv} : properties</dt>
162 <dd>A dictionary containing properties of added interface.</dd>
163 </dl>
164 </li>
165
166 <li>
167 <h3>InterfaceRemoved ( o : interface )</h3>
168 <p>An interface was removed from wpa_supplicant.</p>
169 <h4>Arguments</h4>
170 <dl>
171 <dt>o : interface</dt>
172 <dd>A D-Bus path to an object representing the removed interface</dd>
173 </dl>
174 </li>
175
176 <li>
177 <h3>PropertiesChanged ( a{sv} : properties )</h3>
178 <p>Some properties have changed.</p>
179 <h4>Arguments</h4>
180 <dl>
181 <dt>a{sv} : properties</dt>
182 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "DebugParams"</dd>
183 </dl>
184 </li>
185 </ul>
186
187
188 \section dbus_interface fi.w1.wpa_supplicant1.Interface
189
190 Interface implemented by objects related to network interface added to
191 wpa_supplicant, i.e., returned by
192 fi.w1.wpa_supplicant1.CreateInterface.
193
194 \subsection dbus_interface_methods Methods
195
196 <ul>
197 <li>
198 <h3>Scan ( a{sv} : args ) --> nothing</h3>
199 <p>Triggers a scan.</p>
200 <h4>Arguments</h4>
201 <dl>
202 <dt>a{sv} : args</dt>
203 <dd>
204 A dictionary with arguments describing scan type:
205 <table>
206 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
207 <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td>
208 <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>
209 <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>
210 <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>
211 <tr><td>AllowRoam</td><td>b</td><td>TRUE (or absent) to allow a roaming decision based on the results of this scan, FALSE to prevent a roaming decision.</td><td>No</td>
212 </table>
213 </dd>
214 </dl>
215 <h4>Possible errors</h4>
216 <dl>
217 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
218 <dd>Invalid entries were found in the passed argument.</dd>
219 </dl>
220 </li>
221
222 <li>
223 <h3>Disconnect ( ) --> nothing</h3>
224 <p>Disassociates the interface from current network.</p>
225 <h4>Possible errors</h4>
226 <dl>
227 <dt>fi.w1.wpa_supplicant1.NotConnected</dt>
228 <dd>Interface is not connected to any network.</dd>
229 </dl>
230 </li>
231
232 <li>
233 <h3>AddNetwork ( a{sv} : args ) --> o : network</h3>
234 <p>Adds a new network to the interface.</p>
235 <h4>Arguments</h4>
236 <dl>
237 <dt>a{sv} : args</dt>
238 <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>
239 </dl>
240 <h4>Returns</h4>
241 <dl>
242 <dt>o : network</dt>
243 <dd>A D-Bus path to an object representing a configured network</dd>
244 </dl>
245 <h4>Possible errors</h4>
246 <dl>
247 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
248 <dd>Invalid entries were found in the passed argument.</dd>
249 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
250 <dd>Adding network failed for an unknown reason.</dd>
251 </dl>
252 </li>
253
254 <li>
255 <h3>RemoveNetwork ( o : network ) --> nothing</h3>
256 <p>Removes a configured network from the interface.</p>
257 <h4>Arguments</h4>
258 <dl>
259 <dt>o : network</dt>
260 <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
261 </dl>
262 <h4>Possible errors</h4>
263 <dl>
264 <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
265 <dd>A passed path doesn't point to any network object.</dd>
266 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
267 <dd>A passed path doesn't point to any network object.</dd>
268 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
269 <dd>Removing network failed for an unknown reason.</dd>
270 </dl>
271 </li>
272
273 <li>
274 <h3>RemoveAllNetworks ( ) --> nothing</h3>
275 <p>Remove all configured networks from the interface.</p>
276 </li>
277
278 <li>
279 <h3>SelectNetwork ( o : network ) --> nothing</h3>
280 <p>Attempt association with a configured network.</p>
281 <h4>Arguments</h4>
282 <dl>
283 <dt>o : network</dt>
284 <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
285 </dl>
286 <h4>Possible errors</h4>
287 <dl>
288 <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
289 <dd>A passed path doesn't point to any network object.</dd>
290 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
291 <dd>A passed path doesn't point to any network object.</dd>
292 </dl>
293 </li>
294
295 <li>
296 <h3>Reassociate ( ) --> nothing</h3>
297 <p>Attempt reassociation.</p>
298 <h4>Possible errors</h4>
299 <dl>
300 <dt>fi.w1.wpa_supplicant1.InterfaceDisabled</dt>
301 <dd>The interface is disabled.</dd>
302 </dl>
303 </li>
304
305 <li>
306 <h3>Reattach ( ) --> nothing</h3>
307 <p>Attempt reassociation back to the current BSS.</p>
308 <h4>Possible errors</h4>
309 <dl>
310 <dt>fi.w1.wpa_supplicant1.NotConnected</dt>
311 <dd>Interface is not connected to any network.</dd>
312 </dl>
313 </li>
314
315 <li>
316 <h3>Reconnect ( ) --> nothing</h3>
317 <p>Attempt reconnection and connect if in disconnected state.</p>
318 <h4>Possible errors</h4>
319 <dl>
320 <dt>fi.w1.wpa_supplicant1.InterfaceDisabled</dt>
321 <dd>The interface is disabled.</dd>
322 </dl>
323 </li>
324
325 <li>
326 <h3>AddBlob ( s : name, ay : data ) --> nothing</h3>
327 <p>Adds a blob to the interface.</p>
328 <h4>Arguments</h4>
329 <dl>
330 <dt>s : name</dt>
331 <dd>A name of a blob</dd>
332 <dt>ay : data</dt>
333 <dd>A blob data</dd>
334 </dl>
335 <h4>Possible errors</h4>
336 <dl>
337 <dt>fi.w1.wpa_supplicant1.BlobExists</dt>
338 <dd>A blob with the specified name already exists.</dd>
339 </dl>
340 </li>
341
342 <li>
343 <h3>RemoveBlob ( s : name ) --> nothing</h3>
344 <p>Removes the blob from the interface.</p>
345 <h4>Arguments</h4>
346 <dl>
347 <dt>s : name</dt>
348 <dd>A name of the blob to remove</dd>
349 </dl>
350 <h4>Possible errors</h4>
351 <dl>
352 <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt>
353 <dd>A blob with the specified name doesn't exist.</dd>
354 </dl>
355 </li>
356
357 <li>
358 <h3>GetBlob ( s : name ) --> ay : data</h3>
359 <p>Returns the blob data of a previously added blob.</p>
360 <h4>Arguments</h4>
361 <dl>
362 <dt>s : name</dt>
363 <dd>A name of the blob</dd>
364 </dl>
365 <h4>Returns</h4>
366 <dl>
367 <dt>ay : data</dt>
368 <dd>A blob data</dd>
369 </dl>
370 <h4>Possible errors</h4>
371 <dl>
372 <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt>
373 <dd>A blob with the specified name doesn't exist.</dd>
374 </dl>
375 </li>
376 <li>
377 <h3>AutoScan ( s : arg ) --> nothing</h3>
378 <p>Set autoscan parameters for the interface.</p>
379 <h4>Arguments</h4>
380 <dl>
381 <dt>s : arg</dt>
382 <dd>Autoscan parameter line or empty to unset autoscan.</dd>
383 </dl>
384 <h4>Possible errors</h4>
385 <dl>
386 <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
387 <dd>Needed memory was not possible to get allocated.</dd>
388 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
389 <dd>Invalid entries were found in the passed argument.</dd>
390 </dl>
391 </li>
392 <li>
393 <h3>TDLSDiscover ( s : peer_address ) --> nothing</h3>
394 <p>Initiate a TDLS discovery for a peer.</p>
395 <h4>Arguments</h4>
396 <dl>
397 <dt>s : peer_address</dt>
398 <dd>MAC address for the peer to perform TDLS discovery.</dd>
399 </dl>
400 <h4>Possible errors</h4>
401 <dl>
402 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
403 <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
404 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
405 <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
406 </dl>
407 </li>
408 <li>
409 <h3>TDLSSetup ( s : peer_address ) --> nothing</h3>
410 <p>Setup a TDLS session for a peer.</p>
411 <h4>Arguments</h4>
412 <dl>
413 <dt>s : peer_address</dt>
414 <dd>MAC address for the peer to perform TDLS setup.</dd>
415 </dl>
416 <h4>Possible errors</h4>
417 <dl>
418 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
419 <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
420 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
421 <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
422 </dl>
423 </li>
424 <li>
425 <h3>TDLSStatus ( s : peer_address ) --> s</h3>
426 <p>Return TDLS status with respect to a peer.</p>
427 <h4>Arguments</h4>
428 <dl>
429 <dt>s : peer_address</dt>
430 <dd>MAC address for the peer for which status is requested.</dd>
431 </dl>
432 <h4>Returns</h4>
433 <dl>
434 <dt>s : status</dt>
435 <dd>Current status of the TDLS link with the selected peer.</dd>
436 </dl>
437 <h4>Possible errors</h4>
438 <dl>
439 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
440 <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
441 </dl>
442 </li>
443 <li>
444 <h3>TDLSTeardown ( s : peer_address ) --> nothing</h3>
445 <p>Tear down a TDLS session with a peer.</p>
446 <h4>Arguments</h4>
447 <dl>
448 <dt>s : peer_address</dt>
449 <dd>MAC address for the peer to tear down TDLS connectivity with.</dd>
450 </dl>
451 <h4>Possible errors</h4>
452 <dl>
453 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
454 <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
455 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
456 <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
457 </dl>
458 </li>
459 <li>
460 <h3>TDLSChannelSwitch ( a{sv} : args ) --> nothing</h3>
461 <p>Configure TDLS channel switching behavior with a peer.</p>
462 <h4>Arguments</h4>
463 <dl>
464 <dt>a{sv} : args</dt>
465 <dd>A dictionary with arguments identifying the peer and channel switching behavior.</dd>
466 </dl>
467 </li>
468 <li>
469 <h3>TDLSCancelChannelSwitch ( s : peer_address ) --> nothing</h3>
470 <p>Disable channel switching for a TDLS session with a peer.</p>
471 <h4>Arguments</h4>
472 <dl>
473 <dt>s : peer_address</dt>
474 <dd>MAC address for the peer.</dd>
475 </dl>
476 </li>
477 <li>
478 <h3>VendorElemAdd ( i: frame_id, ay: ielems ) --> nothing</h3>
479 <p>Add Vendor Elements to corresponding frame ID.</p>
480 <h4>Arguments</h4>
481 <dl>
482 <dt>i : frame_id</dt>
483 <dd>Frame ID for which Vendor specific IE is to be added.</dd>
484 <dt>ay : ielems</dt>
485 <dd>Information Element(s).</dd>
486 </dl>
487 <h4>Possible errors</h4>
488 <dl>
489 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
490 <dd>The "ielems" argument is not a properly formatted or size mismatch.</dd>
491 <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
492 <dd>Needed memory was not possible to get allocated.</dd>
493 </dl>
494 </li>
495 <li>
496 <h3>VendorElemGet ( i: frame_id ) --> ay: ielems</h3>
497 <p>Get Vendor Elements of corresponding frame ID.</p>
498 <h4>Arguments</h4>
499 <dl>
500 <dt>i : frame_id</dt>
501 <dd>Frame ID for which Vendor specific IE is being queried.</dd>
502 <dt>ay : ielems</dt>
503 <dd>Information Element(s).</dd>
504 </dl>
505 <h4>Possible errors</h4>
506 <dl>
507 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
508 <dd>The "frame_id" argument is not valid.</dd>
509 </dl>
510 </li>
511 <li>
512 <h3>VendorElemRem ( i: frame_id, ay: ielems ) --> nothing</h3>
513 <p>Remove Vendor Elements of corresponding frame ID.</p>
514 <h4>Arguments</h4>
515 <dl>
516 <dt>i : frame_id</dt>
517 <dd>Frame ID for which Vendor specific IE is to be removed.</dd>
518 <dt>ay : ielems</dt>
519 <dd>Information Element(s) OR * to remove all.</dd>
520 </dl>
521 <h4>Possible errors</h4>
522 <dl>
523 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
524 <dd>The "ielems" argument is not a properly formatted or size mismatch.</dd>
525 <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
526 <dd>Needed memory was not possible to get allocated.</dd>
527 </dl>
528 </li>
529 <li>
530 <h3>SaveConfig ( ) --> nothing</h3>
531 <p>Save configuration to the configuration file.</p>
532 </li>
533 <li>
534 <h3>AbortScan ( ) --> nothing</h3>
535 <p>Abort ongoing scan operation.</p>
536 </li>
537 <li>
538 <h3>EAPLogoff ( ) --> nothing</h3>
539 <p>IEEE 802.1X EAPOL state machine logoff.</p>
540 </li>
541 <li>
542 <h3>EAPLogon ( ) --> nothing</h3>
543 <p>IEEE 802.1X EAPOL state machine logon.</p>
544 </li>
545
546 <li>
547 <h3>NetworkReply ( o : network, s : field, s : value ) --> nothing</h3>
548 <p>Provide parameter requested by NetworkRequest().</p>
549 <h4>Arguments</h4>
550 <dl>
551 <dt>o : network</dt>
552 <dd>A D-Bus path to an object representing the network (copied from NetworkRequest()).</dd>
553 <dt>s : field</dt>
554 <dd>Requested information (copied from NetworkRequest()).</dd>
555 <dt>s : value</dt>
556 <dd>The requested information (e.g., password for EAP authentication).</dd>
557 </dl>
558 <h4>Possible errors</h4>
559 <dl>
560 <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt>
561 <dd>A passed path doesn't point to any network object.</dd>
562 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
563 <dd>A passed path doesn't point to any network object.</dd>
564 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
565 <dd>IEEE 802.1X support was not included in the build.</dd>
566 </dl>
567 </li>
568
569 <li>
570 <h3>SetPKCS11EngineAndModulePath ( s : pkcs11_engine_path, s : pkcs11_module_path ) --> nothing</h3>
571 <p>Set PKCS #11 engine and module path.</p>
572 <h4>Arguments</h4>
573 <dl>
574 <dt>s : pkcs11_engine_path</dt>
575 <dd>PKCS #11 engine path.</dd>
576 <dt>s : pkcs11_module_path</dt>
577 <dd>PKCS #11 module path.</dd>
578 </dl>
579 <h4>Possible errors</h4>
580 <dl>
581 <dt>org.freedesktop.DBus.Error.Failed.InvalidArgs</dt>
582 <dd>Invalid PKCS #11 engine or module path.</dd>
583 <dt>org.freedesktop.DBus.Error.Failed</dt>
584 <dd>Reinit of the EAPOL state machine with the new PKCS #11 engine and module path failed.</dd>
585 </dl>
586 </li>
587 <li>
588 <h3>SignalPoll ( ) --> a{sv} : properties</h3>
589 <p>Fetch signal properties for the current connection.</p>
590 <h4>Returns</h4>
591 <dl>
592 <dt>a{sv} : properties</dt>
593 <dd>
594 <table>
595 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
596 <tr><td>linkspeed</td><td>i</td><td>Link speed (Mbps)</td><td>No</td>
597 <tr><td>noise</td><td>i</td><td>Noise (dBm)</td><td>No</td>
598 <tr><td>width</td><td>s</td><td>Channel width</td><td>No</td>
599 <tr><td>frequency</td><td>u</td><td>Frequency (MHz)</td><td>No</td>
600 <tr><td>rssi</td><td>i</td><td>RSSI (dBm)</td><td>No</td>
601 <tr><td>avg-rssi</td><td>i</td><td>Average RSSI (dBm)</td><td>No</td>
602 <tr><td>center-frq1</td><td>i</td><td>VHT segment 1 frequency (MHz)</td><td>No</td>
603 <tr><td>center-frq2</td><td>i</td><td>VHT segment 2 frequency (MHz)</td><td>No</td>
604 </table>
605 </dd>
606 </dl>
607 </li>
608 <li>
609 <h3>FlushBSS ( u : age ) --> nothing</h3>
610 <p>Flush BSS entries from the cache.</p>
611 <h4>Arguments</h4>
612 <dl>
613 <dt>u : age</dt>
614 <dd>Maximum age in seconds for BSS entries to keep in cache (0 = remove all entries).</dd>
615 </dl>
616 </li>
617
618 <li>
619 <h3>SubscribeProbeReq ( ) --> nothing</h3>
620 <p>Subscribe to receive Probe Request events. This is needed in addition to registering a signal handler for the ProbeRequest signal to avoid flooding D-Bus with all Probe Request indications when no application is interested in them.</p>
621 <h4>Possible errors</h4>
622 <dl>
623 <dt>fi.w1.wpa_supplicant1.SubscriptionInUse</dt>
624 <dd>Another application is already subscribed.</dd>
625 <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
626 <dd>Needed memory was not possible to get allocated.</dd>
627 </dl>
628 </li>
629
630 <li>
631 <h3>UnsubscribeProbeReq ( ) --> nothing</h3>
632 <p>Unsubscribe from receiving Probe Request events.</p>
633 <h4>Possible errors</h4>
634 <dl>
635 <dt>fi.w1.wpa_supplicant1.NoSubscription</dt>
636 <dd>No subscription in place.</dd>
637 <dt>fi.w1.wpa_supplicant1.SubscriptionNotYou</dt>
638 <dd>Subscription in place, but for another process.</dd>
639 </dl>
640 </li>
641 </ul>
642
643 \subsection dbus_interface_properties Properties
644
645 <ul>
646 <li>
647 <h3>Capabilities - a{sv} - (read)</h3>
648 <p>Capabilities of the interface. Dictionary contains following entries:</p>
649 <table>
650 <tr><th>Key</th><th>Value type</th><th>Description</th>
651 <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp-256", "gcmp-256", "ccmp", "gcmp", "tkip", "none"</td>
652 <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp-256", "gcmp-256", "ccmp", "gcmp", "tkip", "wep104", "wep40"</td>
653 <tr><td>GroupMgmt</td><td>as</td><td>Possible array elements: "aes-128-cmac", "bip-gmac-128", "bip-gmac-256", "bip-cmac-256"</td>
654 <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "ieee8021x", "wpa-none", "wps", "none"</td>
655 <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td>
656 <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td>
657 <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td>
658 <tr><td>Modes</td><td>as</td><td>Possible array elements: "infrastructure", "ad-hoc", "ap"</td>
659 </table>
660 </li>
661
662 <li>
663 <h3>State - s - (read)</h3>
664 <p>A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".</p>
665 </li>
666
667 <li>
668 <h3>Scanning - b - (read)</h3>
669 <p>Determines if the interface is already scanning or not</p>
670 </li>
671
672 <li>
673 <h3>ApScan - u - (read/write)</h3>
674 <p>Identical to ap_scan entry in wpa_supplicant configuration file. Possible values are 0, 1 or 2.</p>
675 </li>
676
677 <li>
678 <h3>BSSExpireAge - u - (read/write)</h3>
679 <p>Identical to bss_expiration_age entry in wpa_supplicant configuration file.</p>
680 </li>
681
682 <li>
683 <h3>BSSExpireCount - u - (read/write)</h3>
684 <p>Identical to bss_expiration_scan_count entry in wpa_supplicant configuration file.</p>
685 </li>
686
687 <li>
688 <h3>Country - s - (read/write)</h3>
689 <p>Identical to country entry in wpa_supplicant configuration file.</p>
690 </li>
691
692 <li>
693 <h3>Ifname - s - (read)</h3>
694 <p>Name of network interface controlled by the interface, e.g., wlan0.</p>
695 </li>
696
697 <li>
698 <h3>BridgeIfname - s - (read)</h3>
699 <p>Name of bridge network interface controlled by the interface, e.g., br0.</p>
700 </li>
701
702 <li>
703 <h3>Driver - s - (read)</h3>
704 <p>Name of driver used by the interface, e.g., nl80211.</p>
705 </li>
706
707 <li>
708 <h3>ConfigFile - s - (read)</h3>
709 <p>Configuration file path. Returns an empty string if no configuration file is in use.</p>
710 </li>
711
712 <li>
713 <h3>CurrentBSS - o - (read)</h3>
714 <p>Path to D-Bus object representing BSS which wpa_supplicant is associated with, or "/" if is not associated at all.</p>
715 </li>
716
717 <li>
718 <h3>CurrentNetwork - o - (read)</h3>
719 <p>Path to D-Bus object representing configured network which wpa_supplicant uses at the moment, or "/" if doesn't use any.</p>
720 </li>
721
722 <li>
723 <h3>CurrentAuthMode - s - (read)</h3>
724 <p>Current authentication type.</p>
725 </li>
726
727 <li>
728 <h3>Blobs - as - (read)</h3>
729 <p>List of blobs names added to the Interface.</p>
730 </li>
731
732 <li>
733 <h3>BSSs - ao - (read)</h3>
734 <p>List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.</p>
735 </li>
736
737 <li>
738 <h3>Stations - ao - (read)</h3>
739 <p>List of D-Bus objects paths representing connected stations in AP mode.</p>
740 </li>
741
742 <li>
743 <h3>Networks - ao - (read)</h3>
744 <p>List of D-Bus objects paths representing configured networks.</p>
745 </li>
746
747 <li>
748 <h3>FastReauth - b - (read/write)</h3>
749 <p>Identical to fast_reauth entry in wpa_supplicant configuration file.</p>
750 </li>
751
752 <li>
753 <h3>ScanInterval - i - (read/write)</h3>
754 <p>Time (in seconds) between scans for a suitable AP. Must be >= 0.</p>
755 </li>
756
757 <li>
758 <h3>PKCS11EnginePath - s - (read)</h3>
759 <p>PKCS #11 engine path.</p>
760 </li>
761
762 <li>
763 <h3>PKCS11ModulePath - s - (read)</h3>
764 <p>PKCS #11 module path.</p>
765 </li>
766
767 <li>
768 <h3>DisconnectReason - i - (read)</h3>
769 <p>The most recent IEEE 802.11 reason code for disconnect. Negative value indicates locally generated disconnection.</p>
770 </li>
771
772 <li>
773 <h3>AuthStatusCode - i - (read)</h3>
774 <p>The most recent IEEE 802.11 status code for authentication.</p>
775 </li>
776
777 <li>
778 <h3>AssocStatusCode - i - (read)</h3>
779 <p>The most recent IEEE 802.11 status code for association rejection.</p>
780 </li>
781
782 <li>
783 <h3>RoamTime - u - (read)</h3>
784 <p>The most recent roam time in milliseconds.</p>
785 </li>
786
787 <li>
788 <h3>RoamComplete - b - (read)</h3>
789 <p>The most recent roam success or failure.</p>
790 </li>
791
792 <li>
793 <h3>SessionLength - u - (read)</h3>
794 <p>The most recent BSS session length in milliseconds.</p>
795 </li>
796
797 <li>
798 <h3>BSSTMStatus - u - (read)</h3>
799 <p>The most recent BSS Transition Management status code.</p>
800 </li>
801
802 <li>
803 <h3>EapolVersion - s - (read/write)</h3>
804 <p>IEEE 802.1X/EAPOL version number</p>
805 </li>
806
807 <li>
808 <h3>Bgscan - s - (read/write)</h3>
809 <p>Background scan and roaming parameters or an empty string if none</p>
810 </li>
811
812 <li>
813 <h3>DisableScanOffload - s - (read/write)</h3>
814 <p>Disable automatic offloading of scan requests</p>
815 </li>
816
817 <li>
818 <h3>OpenscEnginePath - s - (read/write)</h3>
819 <p>Path to the OpenSSL engine for opensc</p>
820 </li>
821
822 <li>
823 <h3>OpensslCiphers - s - (read/write)</h3>
824 <p>OpenSSL cipher string</p>
825 </li>
826
827 <li>
828 <h3>PcscReader - s - (read/write)</h3>
829 <p>PC/SC reader name prefix</p>
830 </li>
831
832 <li>
833 <h3>PcscPin - s - (read/write)</h3>
834 <p>PIN for USIM, GSM SIM, and smartcards</p>
835 </li>
836
837 <li>
838 <h3>ExternalSim - s - (read/write)</h3>
839 <p>Use external processing for SIM/USIM operations</p>
840 </li>
841
842 <li>
843 <h3>DriverParam - s - (read/write)</h3>
844 <p>Driver interface parameters</p>
845 </li>
846
847 <li>
848 <h3>Dot11RSNAConfigPMKLifetime - s - (read/write)</h3>
849 <p>Maximum lifetime of a PMK</p>
850 </li>
851
852 <li>
853 <h3>Dot11RSNAConfigPMKReauthThreshold - s - (read/write)</h3>
854 <p>PMK re-authentication threshold</p>
855 </li>
856
857 <li>
858 <h3>Dot11RSNAConfigSATimeout - s - (read/write)</h3>
859 <p>Security association timeout</p>
860 </li>
861
862 <li>
863 <h3>BssMaxCount - s - (read/write)</h3>
864 <p>Maximum number of BSS entries to keep in memory</p>
865 </li>
866
867 <li>
868 <h3>FilterSsids - s - (read/write)</h3>
869 <p>SSID-based scan result filtering</p>
870 </li>
871
872 <li>
873 <h3>FilterRssi - s - (read/write)</h3>
874 <p>RSSI-based scan result filtering</p>
875 </li>
876
877 <li>
878 <h3>MaxNumSta - s - (read/write)</h3>
879 <p>Maximum number of STAs in an AP/P2P GO</p>
880 </li>
881
882 <li>
883 <h3>DisassocLowAck - s - (read/write)</h3>
884 <p>Disassocicate stations with massive packet loss</p>
885 </li>
886
887 <li>
888 <h3>Interworking - s - (read/write)</h3>
889 <p>Whether Interworking (IEEE 802.11u) is enabled</p>
890 </li>
891
892 <li>
893 <h3>Hessid - s - (read/write)</h3>
894 <p>Homogenous ESS identifier</p>
895 </li>
896
897 <li>
898 <h3>AccessNetworkType - s - (read/write)</h3>
899 <p>Access Network Type</p>
900 </li>
901
902 <li>
903 <h3>PbcInM1 - s - (read/write)</h3>
904 <p>AP mode WPS probing workaround for PBC with Windows 7</p>
905 </li>
906
907 <li>
908 <h3>Autoscan - s - (read/write)</h3>
909 <p>Automatic scan parameters or an empty string if none</p>
910 </li>
911
912 <li>
913 <h3>WpsNfcDevPwId - s - (read/write)</h3>
914 <p>NFC Device Password ID for password token</p>
915 </li>
916
917 <li>
918 <h3>WpsNfcDhPubkey - s - (read/write)</h3>
919 <p>NFC DH Public Key for password token</p>
920 </li>
921
922 <li>
923 <h3>WpsNfcDhPrivkey - s - (read/write)</h3>
924 <p>NFC DH Private Key for password token</p>
925 </li>
926
927 <li>
928 <h3>WpsNfcDevPw - s - (read/write)</h3>
929 <p>NFC Device Password for password token</p>
930 </li>
931
932 <li>
933 <h3>ExtPasswordBackend - s - (read/write)</h3>
934 <p>External password backend or an empty string if none</p>
935 </li>
936
937 <li>
938 <h3>P2pGoMaxInactivity - s - (read/write)</h3>
939 <p>Timeout in seconds to detect STA inactivity</p>
940 </li>
941
942 <li>
943 <h3>AutoInterworking - s - (read/write)</h3>
944 <p>Whether to use network selection automatically</p>
945 </li>
946
947 <li>
948 <h3>Okc - s - (read/write)</h3>
949 <p>Whether to enable opportunistic key caching by default</p>
950 </li>
951
952 <li>
953 <h3>Pmf - s - (read/write)</h3>
954 <p>Whether to enable/require PMF by default</p>
955 </li>
956
957 <li>
958 <h3>SaeGroups - s - (read/write)</h3>
959 <p>Preference list of enabled groups for SAE</p>
960 </li>
961
962 <li>
963 <h3>DtimPeriod - s - (read/write)</h3>
964 <p>Default DTIM period in Beacon intervals</p>
965 </li>
966
967 <li>
968 <h3>BeaconInt - s - (read/write)</h3>
969 <p>Default Beacon interval in TU</p>
970 </li>
971
972 <li>
973 <h3>IgnoreOldScanRes - s - (read/write)</h3>
974 <p>Ignore scan results older than request</p>
975 </li>
976
977 <li>
978 <h3>FreqList - s - (read/write)</h3>
979 <p>Array of allowed scan frequencies or an empty string for all</p>
980 </li>
981
982 <li>
983 <h3>ScanCurFreq - s - (read/write)</h3>
984 <p>Whether to scan only the current channel</p>
985 </li>
986
987 <li>
988 <h3>SchedScanInterval - s - (read/write)</h3>
989 <p>schedule scan interval</p>
990 </li>
991
992 <li>
993 <h3>TdlsExternalControl - s - (read/write)</h3>
994 <p>External control for TDLS setup requests</p>
995 </li>
996
997 <li>
998 <h3>OsuDir - s - (read/write)</h3>
999 <p>OSU provider information directory</p>
1000 </li>
1001
1002 <li>
1003 <h3>WowlanTriggers - s - (read/write)</h3>
1004 <p>Wake-on-WLAN triggers</p>
1005 </li>
1006
1007 <li>
1008 <h3>P2pSearchDelay - s - (read/write)</h3>
1009 <p>Extra delay between concurrent search iterations</p>
1010 </li>
1011
1012 <li>
1013 <h3>MacAddr - s - (read/write)</h3>
1014 <p>MAC address policy default</p>
1015 </li>
1016
1017 <li>
1018 <h3>RandAddrLifetime - s - (read/write)</h3>
1019 <p>Lifetime of random MAC address in seconds</p>
1020 </li>
1021
1022 <li>
1023 <h3>PreassocMacAddr - s - (read/write)</h3>
1024 <p>Pre-association MAC address policy</p>
1025 </li>
1026
1027 <li>
1028 <h3>KeyMgmtOffload - s - (read/write)</h3>
1029 <p>Use key management offload</p>
1030 </li>
1031
1032 <li>
1033 <h3>PassiveScan - s - (read/write)</h3>
1034 <p>Whether to force passive scan for network connection</p>
1035 </li>
1036
1037 <li>
1038 <h3>ReassocSameBssOptim - s - (read/write)</h3>
1039 <p>Whether to optimize reassoc-to-same-BSS</p>
1040 </li>
1041
1042 <li>
1043 <h3>WpsPriority - s - (read/write)</h3>
1044 <p>Priority for the networks added through WPS</p>
1045 </li>
1046 </ul>
1047
1048 \subsection dbus_interface_signals Signals
1049
1050 <ul>
1051 <li>
1052 <h3>ScanDone ( b : success )</h3>
1053 <p>Scanning finished. </p>
1054 <h4>Arguments</h4>
1055 <dl>
1056 <dt>s : success</dt>
1057 <dd>Determines if scanning was successful. If so, results are available.</dd>
1058 </dl>
1059 </li>
1060
1061 <li>
1062 <h3>BSSAdded ( o : BSS, a{sv} : properties )</h3>
1063 <p>Interface became aware of a new BSS.</p>
1064 <h4>Arguments</h4>
1065 <dl>
1066 <dt>o : BSS</dt>
1067 <dd>A D-Bus path to an object representing the new BSS.</dd>
1068 </dl>
1069 <dl>
1070 <dt>a{sv} : properties</dt>
1071 <dd>A dictionary containing properties of added BSS.</dd>
1072 </dl>
1073 </li>
1074
1075 <li>
1076 <h3>BSSRemoved ( o : BSS )</h3>
1077 <p>BSS disappeared.</p>
1078 <h4>Arguments</h4>
1079 <dl>
1080 <dt>o : BSS</dt>
1081 <dd>A D-Bus path to an object representing the BSS.</dd>
1082 </dl>
1083 </li>
1084
1085 <li>
1086 <h3>BlobAdded ( s : blobName )</h3>
1087 <p>A new blob has been added to the interface.</p>
1088 <h4>Arguments</h4>
1089 <dl>
1090 <dt>s : blobName</dt>
1091 <dd>A name of the added blob.</dd>
1092 </dl>
1093 </li>
1094
1095 <li>
1096 <h3>BlobRemoved ( s : blobName )</h3>
1097 <p>A blob has been removed from the interface.</p>
1098 <h4>Arguments</h4>
1099 <dl>
1100 <dt>s : blobName</dt>
1101 <dd>A name of the removed blob.</dd>
1102 </dl>
1103 </li>
1104
1105 <li>
1106 <h3>NetworkAdded ( o : network, a{sv} : properties )</h3>
1107 <p>A new network has been added to the interface.</p>
1108 <h4>Arguments</h4>
1109 <dl>
1110 <dt>o : network</dt>
1111 <dd>A D-Bus path to an object representing the added network.</dd>
1112 </dl>
1113 <dl>
1114 <dt>a{sv} : properties</dt>
1115 <dd>A dictionary containing properties of added network.</dd>
1116 </dl>
1117 </li>
1118
1119 <li>
1120 <h3>NetworkRemoved ( o : network )</h3>
1121 <p>The network has been removed from the interface.</p>
1122 <h4>Arguments</h4>
1123 <dl>
1124 <dt>o : network</dt>
1125 <dd>A D-Bus path to an object representing the removed network.</dd>
1126 </dl>
1127 </li>
1128
1129 <li>
1130 <h3>NetworkSelected ( o : network )</h3>
1131 <p>The network has been selected.</p>
1132 <h4>Arguments</h4>
1133 <dl>
1134 <dt>o : network</dt>
1135 <dd>A D-Bus path to an object representing the selected network.</dd>
1136 </dl>
1137 </li>
1138
1139 <li>
1140 <h3>StaAuthorized ( s : mac )</h3>
1141 <p>A new station has been authorized to the interface.</p>
1142 <h4>Arguments</h4>
1143 <dl>
1144 <dt>s : mac</dt>
1145 <dd>A mac address which has been authorized.</dd>
1146 </dl>
1147 </li>
1148
1149 <li>
1150 <h3>StaDeauthorized ( s : mac )</h3>
1151 <p>A station has been deauthorized to the interface.</p>
1152 <h4>Arguments</h4>
1153 <dl>
1154 <dt>s : mac</dt>
1155 <dd>A mac address which has been deauthorized.</dd>
1156 </dl>
1157 </li>
1158
1159 <li>
1160 <h3>StationAdded ( o : Station, a{sv} : properties )</h3>
1161 <p>A new station has been added to the interface.</p>
1162 <p>This signal complements StaAuthorized, passing the Station object and its properties.</p>
1163 <h4>Arguments</h4>
1164 <dl>
1165 <dt>o : Station</dt>
1166 <dd>A D-Bus path to an object representing the new Station.</dd>
1167 </dl>
1168 <dl>
1169 <dt>a{sv} : properties</dt>
1170 <dd>A dictionary containing properties of added Station.</dd>
1171 </dl>
1172 </li>
1173
1174 <li>
1175 <h3>StationRemoved ( o : Station )</h3>
1176 <p>The station has been removed from the interface.</p>
1177 <p>This signal complements StaDeauthorized, passing the Station object.</p>
1178 <h4>Arguments</h4>
1179 <dl>
1180 <dt>o : Station</dt>
1181 <dd>A D-Bus path to an object representing the Station.</dd>
1182 </dl>
1183 </li>
1184
1185 <li>
1186 <h3>PropertiesChanged ( a{sv} : properties )</h3>
1187 <p>Some properties have changed.</p>
1188 <h4>Arguments</h4>
1189 <dl>
1190 <dt>a{sv} : properties</dt>
1191 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ApScan", "Scanning", "State", "CurrentBSS", "CurrentNetwork"</dd>
1192 </dl>
1193 </li>
1194
1195 <li>
1196 <h3>Certification ( a{sv} : parameters )</h3>
1197 <p>Information about server TLS certificates.</p>
1198 <h4>Arguments</h4>
1199 <dl>
1200 <dt>a{sv} : parameters</dt>
1201 <dd>A dictionary with pairs of field names and their values. Possible dictionary keys are: "depth", "subject", "altsubject", "cert_hash", "cert".</dd>
1202 </dl>
1203 </li>
1204
1205 <li>
1206 <h3>EAP ( s : status, s : parameter )</h3>
1207 <p>Information about EAP peer status.</p>
1208 <h4>Arguments</h4>
1209 <dl>
1210 <dt>s : status</dt>
1211 <dd>Operation, e.g., "started", "accept proposed method", "remote certificate verification", "eap parameter needed", "completion".</dd>
1212 <dt>s : parameter</dt>
1213 <dd>Information about the operation, e.g., EAP method name, "success".</dd>
1214 </dl>
1215 </li>
1216
1217 <li>
1218 <h3>NetworkRequest ( o : network, s : field, s : txt )</h3>
1219 <p>Request for network parameter. NetworkResponse() is used to provide the requested parameter.</p>
1220 <h4>Arguments</h4>
1221 <dl>
1222 <dt>o : network</dt>
1223 <dd>D-Bus path to an object representing the network.</dd>
1224 <dt>s : field</dt>
1225 <dd>Requested information, e.g., "PASSWORD".</dd>
1226 <dt>txt : field</dt>
1227 <dd>Human readable information about the requested information.</dd>
1228 </dl>
1229 </li>
1230
1231 <li>
1232 <h3>ProbeRequest ( a{sv} : args )</h3>
1233 <p>Information about a received Probe Request frame. This signal is delivered only to a single application that has subscribed to received the events with SubscribeProbeReq().</p>
1234 <h4>Arguments</h4>
1235 <dl>
1236 <dt>a{sv} : args</dt>
1237 <dd>A dictionary with pairs of field names and their values. Possible dictionary keys are: "addr", "dst", "bssid", "ies", "signal".</dd>
1238 </dl>
1239 </li>
1240 </ul>
1241
1242
1243 \section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS
1244
1245 Interface for performing WPS (Wi-Fi Simple Config) operations.
1246
1247 \subsection dbus_wps_methods Methods
1248
1249 <ul>
1250 <li>
1251 <h3>Start ( a{sv} : args ) --> a{sv} : output</h3>
1252 <p>Starts WPS configuration. Note: When used with P2P groups, this needs to be issued on the GO group interface.</p>
1253 <h4>Arguments</h4>
1254 <dl>
1255 <dt>a{sv} : args</dt>
1256 <dd>
1257 A dictionary with arguments used to start WPS configuration. The dictionary may contain the following entries:
1258 <table>
1259 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
1260 <tr><td>Role</td><td>s</td><td>The device's role. Possible values are "enrollee" and "registrar".</td><td>Yes</td>
1261 <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>
1262 <tr><td>Pin</td><td>s</td><td>WPS Pin.</td><td>Yes, for registrar role; otherwise optional</td>
1263 <tr><td>Bssid</td><td>ay</td><td>Note: This is used to specify the peer MAC address when authorizing WPS connection in AP or P2P GO role.</td><td>No</td>
1264 <tr><td>P2PDeviceAddress</td><td>ay</td><td>P2P Device Address of a peer to authorize for PBC connection. Used only in P2P GO role.</td><td>No</td>
1265 </table>
1266 </dd>
1267 </dl>
1268 <h4>Returns</h4>
1269 <dl>
1270 <dt>a{sv} : output</dt>
1271 <dd>
1272 <table>
1273 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
1274 <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>
1275 </table>
1276 </dd>
1277 </dl>
1278 <h4>Possible errors</h4>
1279 <dl>
1280 <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
1281 <dd>Starting WPS configuration failed for an unknown reason.</dd>
1282 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
1283 <dd>Invalid entries were found in the passed argument.</dd>
1284 </dl>
1285 </li>
1286 <li>
1287 <h3>Cancel ( nothing ) --> nothing</h3>
1288 <p>Cancel ongoing WPS operation.</p>
1289 </li>
1290 </ul>
1291
1292 \subsection dbus_wps_properties Properties
1293
1294 <ul>
1295 <li>
1296 <h3>ProcessCredentials - b - (read/write)</h3>
1297 <p>Determines if the interface will process the credentials (credentials_processed configuration file parameter).</p>
1298 </li>
1299 <li>
1300 <h3>ConfigMethods - s - (read/write)</h3>
1301 <p>The currently advertised WPS configuration methods. Available methods: usba ethernet label display ext_nfc_token int_nfc_token nfc_interface push_button keypad virtual_display physical_display virtual_push_button physical_push_button.</p>
1302 </li>
1303 <li>
1304 <h3>DeviceName - s - (read/write)</h3>
1305 <p>User-friendly description of device; up to 32 octets encoded in UTF-8.</p>
1306 </li>
1307 <li>
1308 <h3>Manufacturer - s - (read/write)</h3>
1309 <p>The manufacturer of the device (up to 64 ASCII characters).</p>
1310 </li>
1311 <li>
1312 <h3>ModelName - s - (read/write)</h3>
1313 <p>Model of the device (up to 32 ASCII characters).</p>
1314 </li>
1315 <li>
1316 <h3>ModelNumber - s - (read/write)</h3>
1317 <p>Additional device description (up to 32 ASCII characters).</p>
1318 </li>
1319 <li>
1320 <h3>SerialNumber - s - (read/write)</h3>
1321 <p>Serial number of the device (up to 32 characters).</p>
1322 </li>
1323 <li>
1324 <h3>DeviceType - ay - (read/write)</h3>
1325 <p>Device Type (8 octet value with 2 octet category, 4 octet OUI, 2 octet subcategory.</p>
1326 </li>
1327 </ul>
1328
1329 \subsection dbus_wps_signals Signals
1330
1331 <ul>
1332 <li>
1333 <h3>Event ( s : name, a{sv} : args )</h3>
1334 <p>WPS event occurred.</p>
1335 <h4>Arguments</h4>
1336 <dl>
1337 <dt>s : event</dt>
1338 <dd>Event type. Possible values are: "success, "fail", "m2d", and
1339 "pbc-overlap".</dd>
1340 <dt>a{sv} : args</dt>
1341 <dd>
1342 Event arguments. Empty for success and pbc-overlap events, error information ( "msg" : i, "config_error" : i, "error_indication" : i ) for fail event and following entries for m2d event:
1343 <table>
1344 <tr><th>config_methods</th><th>Value type</th>
1345 <tr><td>manufacturer</td><td>q</td>
1346 <tr><td>model_name</td><td>ay</td>
1347 <tr><td>model_number</td><td>ay</td>
1348 <tr><td>serial_number</td><td>ay</td>
1349 <tr><td>dev_name</td><td>ay</td>
1350 <tr><td>primary_dev_type</td><td>ay</td>
1351 <tr><td>config_error</td><td>q</td>
1352 <tr><td>dev_password_id</td><td>q</td>
1353 </table>
1354 </dd>
1355 </dl>
1356 </li>
1357
1358 <li>
1359 <h3>Credentials ( a{sv} : credentials )</h3>
1360 <p>WPS credentials. Dictionary contains:</p>
1361 <table>
1362 <tr><th>Key</th><th>Value type</th><th>Description</th>
1363 <tr><td>BSSID</td><td>ay</td><td></td>
1364 <tr><td>SSID</td><td>s</td><td></td>
1365 <tr><td>AuthType</td><td>as</td><td>Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk"</td>
1366 <tr><td>EncrType</td><td>as</td><td>Possible array elements: "none", "wep", "tkip", "aes"</td>
1367 <tr><td>Key</td><td>ay</td><td>Key data</td>
1368 <tr><td>KeyIndex</td><td>u</td><td>Key index</td>
1369 </table>
1370 </li>
1371
1372 <li>
1373 <h3>PropertiesChanged ( a{sv} : properties )</h3>
1374 <p>Some properties have changed.</p>
1375 <h4>Arguments</h4>
1376 <dl>
1377 <dt>a{sv} : properties</dt>
1378 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ProcessCredentials"</dd>
1379 </dl>
1380 </li>
1381 </ul>
1382
1383
1384 \section dbus_p2pdevice fi.w1.wpa_supplicant1.Interface.P2PDevice
1385
1386 Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations.
1387
1388 \subsection dbus_p2pdevice_methods Methods
1389
1390 <ul>
1391 <li>
1392 <h3>Find ( a{sv} : args ) --> nothing</h3>
1393 <p>Start P2P find operation (i.e., alternating P2P Search and Listen states to discover peers and be discoverable).</p>
1394 <h4>Arguments</h4>
1395 <dl>
1396 <dt>a{sv} : args</dt>
1397 <dd>
1398 A dictionary with parameters for the P2P find operation:
1399 <table>
1400 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1401 <tr><td>Timeout</td><td>i</td><td>Timeout for operating in seconds</td><td>no</td></tr>
1402 <tr><td>RequestedDeviceTypes</td><td>aay</td><td>WPS Device Types to search for</td><td>no</td></tr>
1403 <tr><td>DiscoveryType</td><td>s</td><td>"start_with_full" (default, if not specified), "social", "progressive"</td><td>no</td></tr>
1404 <tr><td>freq</td><td>i</td><td>Initial scan channel (frequency in MHz) for the start_with_full case to limit the initial scan to the specified channel</td><td>no</td></tr>
1405 </table>
1406 </dd>
1407 </dl>
1408 </li>
1409
1410 <li>
1411 <h3>StopFind ( nothing ) --> nothing</h3>
1412 <p>Stop P2P find operation.</p>
1413 </li>
1414
1415 <li>
1416 <h3>Listen ( i : timeout ) --> nothing</h3>
1417 <p>Start P2P listen operation (i.e., be discoverable).</p>
1418 <h4>Arguments</h4>
1419 <dl>
1420 <dt>i : timeout</dt>
1421 <dd>Timeout in seconds for stopping the listen operation.</dd>
1422 </dl>
1423 </li>
1424
1425 <li>
1426 <h3>ExtendedListen ( a{sv} : args ) --> nothing</h3>
1427 <p>Configure Extended Listen Timing. If the parameters are omitted, this feature is disabled. If the parameters are included, Listen State will be entered every interval msec for at least period msec. Both values have acceptable range of 1-65535 (with interval obviously having to be larger than or equal to duration). If the P2P module is not idle at the time the Extended Listen Timing timeout occurs, the Listen State operation will be skipped.</p>
1428 <h4>Arguments</h4>
1429 <dl>
1430 <dt>a{sv} : args</dt>
1431 <dd>
1432 A dictionary with parameters for extended listen. Leave out all items to disable extended listen.
1433 <table>
1434 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1435 <tr><td>period</td><td>i</td><td>Extended listen period in milliseconds; 1-65535.</td><td>no</td></tr>
1436 <tr><td>interval</td><td>i</td><td>Extended listen interval in milliseconds; 1-65535.</td><td>no</td></tr>
1437 </table>
1438 </dd>
1439 </dl>
1440 </li>
1441
1442 <li>
1443 <h3>PresenceRequest ( a{sv} : args ) --> nothing</h3>
1444 <p>Request a specific GO presence in a P2P group where the local device is a P2P Client. Send a P2P Presence Request to the GO (this is only available when acting as a P2P client). If no duration/interval pairs are given, the request indicates that this client has no special needs for GO presence. The first parameter pair gives the preferred duration and interval values in microseconds. If the second pair is included, that indicates which value would be acceptable.
1445 \note This needs to be issued on a P2P group interface if separate group interfaces are used.
1446 \bug It would be cleaner to not require .P2PDevice methods to be issued on a group interface. In other words, args['group_object'] could be used to specify the group or this method could be moved to be a .Group PresenceRequest() method.</p>
1447 <h4>Arguments</h4>
1448 <dl>
1449 <dt>a{sv} : args</dt>
1450 <dd>
1451 A dictionary with parameters for the presence request.
1452 <table>
1453 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1454 <tr><td>duration1</td><td>i</td><td>Duration in microseconds.</td><td>no</td></tr>
1455 <tr><td>interval1</td><td>i</td><td>Interval in microseconds.</td><td>no</td></tr>
1456 <tr><td>duration2</td><td>i</td><td>Duration in microseconds.</td><td>no</td></tr>
1457 <tr><td>interval2</td><td>i</td><td>Interval in microseconds.</td><td>no</td></tr>
1458 </table>
1459 </dd>
1460 </dl>
1461 </li>
1462
1463 <li>
1464 <h3>ProvisionDiscoveryRequest ( o : peer, s : config_method ) --> nothing</h3>
1465 </li>
1466
1467 <li>
1468 <h3>Connect ( a{sv} : args ) --> s : generated_pin</h3>
1469 <p>Request a P2P group to be started through GO Negotiation or by joining an already operating group.</p>
1470 <h4>Arguments</h4>
1471 <dl>
1472 <dt>a{sv} : args</dt>
1473 <dd>
1474 A dictionary with parameters for the requested connection:
1475 <table>
1476 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1477 <tr><td>peer</td><td>o</td><td></td><td>yes</td></tr>
1478 <tr><td>persistent</td><td>b</td><td>Whether to form a persistent group.</td><td>no</td></tr>
1479 <tr><td>join</td><td>b</td><td>Whether to join an already operating group instead of forming a new group.</td><td>no</td></tr>
1480 <tr><td>authorize_only</td><td>b</td><td>Whether to authorize a peer to initiate GO Negotiation instead of initiating immediately.</td><td>no</td></tr>
1481 <tr><td>frequency</td><td>i</td><td>Operating frequency in MHz</td><td>no</td></tr>
1482 <tr><td>go_intent</td><td>i</td><td>GO intent 0-15</td><td>no</td></tr>
1483 <tr><td>wps_method</td><td>s</td><td>"pbc", "display", "keypad", "pin" (alias for "display")</td><td>yes</td></tr>
1484 <tr><td>pin</td><td>s</td><td></td><td>no</td></tr>
1485 </table>
1486 </dd>
1487 </dl>
1488 </li>
1489
1490 <li>
1491 <h3>GroupAdd ( a{sv} : args ) --> nothing</h3>
1492 <p>Request a P2P group to be started without GO Negotiation.</p>
1493 <h4>Arguments</h4>
1494 <dl>
1495 <dt>a{sv} : args</dt>
1496 <dd>
1497 A dictionary with parameters for the requested group:
1498 <table>
1499 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1500 <tr><td>persistent</td><td>b</td><td>Whether to form a persistent group.</td><td>no</td></tr>
1501 <tr><td>persistent_group_object</td><td>o</td><td></td><td>no</td></tr>
1502 <tr><td>frequency</td><td>i</td><td>Operating frequency in MHz</td><td>no</td></tr>
1503 </table>
1504 </dd>
1505 </dl>
1506 </li>
1507
1508 <li>
1509 <h3>Cancel ( nothing ) --> nothing</h3>
1510 <p>Stop ongoing P2P group formation operation.</p>
1511 </li>
1512
1513 <li>
1514 <h3>Invite ( a{sv} : args ) --> nothing</h3>
1515 <p>Invite a peer to join an already operating group or to re-invoke a persistent group.</p>
1516 <h4>Arguments</h4>
1517 <dl>
1518 <dt>a{sv} : args</dt>
1519 <dd>
1520 A dictionary with parameters for the invitation:
1521 <table>
1522 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1523 <tr><td>peer</td><td>o</td><td></td><td>yes</td></tr>
1524 <tr><td>persistent_group_object</td><td>o</td><td></td><td>no</td></tr>
1525 </table>
1526 </dd>
1527 </dl>
1528 </li>
1529
1530 <li>
1531 <h3>Disconnect ( nothing ) --> nothing</h3>
1532 <p>Terminate a P2P group.
1533 \note This needs to be issued on a P2P group interface if separate group interfaces are used.
1534 \bug It would be cleaner to not require .P2PDevice methods to be issued on a group interface. In other words, this would either need to be Disconnect(group_object) or moved to be a .Group Disconnect() method.</p>
1535 </li>
1536
1537 <li>
1538 <h3>RejectPeer ( o : peer ) --> nothing</h3>
1539 <p>Reject connection attempt from a peer (specified with a device address). This is a mechanism to reject a pending GO Negotiation with a peer and request to automatically block any further connection or discovery of the peer.</p>
1540 </li>
1541
1542 <li>
1543 <h3>RemoveClient ( a{sv} : args ) --> nothing</h3>
1544 <p>Remove the client from all groups (operating and persistent) from the local GO.</p>
1545 <h4>Arguments</h4>
1546 <dl>
1547 <dt>a{sv} : args</dt>
1548 <dd>
1549 A dictionary with parameters for removing a client:
1550 <table>
1551 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1552 <tr><td>peer</td><td>o</td><td>Object path for peer's P2P Device Address</td><td>yes</td></tr>
1553 <tr><td>iface</td><td>s</td><td>Interface address[MAC Address format] of the peer to be disconnected. Required if object path is not provided.</td><td>no</td></tr>
1554 </table>
1555 </dd>
1556 </dl>
1557 </li>
1558
1559 <li>
1560 <h3>Flush ( nothing ) --> nothing</h3>
1561 <p>Flush P2P peer table and state.</p>
1562 </li>
1563
1564 <li>
1565 <h3>AddService ( a{sv} : args ) --> nothing</h3>
1566 <p></p>
1567 <h4>Arguments</h4>
1568 <dl>
1569 <dt>a{sv} : args</dt>
1570 <dd>
1571 A dictionary with parameters for the service:
1572 <table>
1573 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1574 <tr><td>service_type</td><td>s</td><td>"upnp", "bonjour"</td><td>yes</td></tr>
1575 <tr><td>version</td><td>u</td><td>Required for UPnP services.</td><td>no</td></tr>
1576 <tr><td>service</td><td>s</td><td></td><td></td></tr>
1577 <tr><td>query</td><td>ay</td><td></td><td></td></tr>
1578 <tr><td>response</td><td>ay</td><td></td><td></td></tr>
1579 </table>
1580 </dd>
1581 </dl>
1582 </li>
1583
1584 <li>
1585 <h3>DeleteService ( a{sv} : args ) --> nothing</h3>
1586 <p></p>
1587 <h4>Arguments</h4>
1588 <dl>
1589 <dt>a{sv} : args</dt>
1590 <dd>
1591 A dictionary with parameters for the service:
1592 <table>
1593 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1594 <tr><td>service_type</td><td>s</td><td>"upnp", "bonjour"</td><td>yes</td></tr>
1595 <tr><td>version</td><td>u</td><td>Required for UPnP services.</td><td>no</td></tr>
1596 <tr><td>service</td><td>s</td><td></td><td></td></tr>
1597 <tr><td>query</td><td>ay</td><td></td><td></td></tr>
1598 </table>
1599 </dd>
1600 </dl>
1601 </li>
1602
1603 <li>
1604 <h3>FlushService ( nothing ) --> nothing</h3>
1605 </li>
1606
1607 <li>
1608 <h3>ServiceDiscoveryRequest ( a{sv} : args ) --> t : ref</h3>
1609 <p></p>
1610 <h4>Arguments</h4>
1611 <dl>
1612 <dt>a{sv} : args</dt>
1613 <dd>
1614 A dictionary with following parameters:
1615 <table>
1616 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1617 <tr><td>peer_object</td><td>o</td><td></td><td>no</td></tr>
1618 <tr><td>service_type</td><td>s</td><td>"upnp"</td><td>no</td></tr>
1619 <tr><td>version</td><td>u</td><td>Required for UPnP services.</td><td>no</td></tr>
1620 <tr><td>service</td><td>s</td><td></td><td></td></tr>
1621 <tr><td>tlv</td><td>ay</td><td></td><td></td></tr>
1622 </table>
1623 </dd>
1624 </dl>
1625 </li>
1626
1627 <li>
1628 <h3>ServiceDiscoveryResponse ( a{sv} : args ) --> nothing : ref</h3>
1629 <p></p>
1630 <h4>Arguments</h4>
1631 <dl>
1632 <dt>a{sv} : args</dt>
1633 <dd>
1634 A dictionary with following parameters:
1635 <table>
1636 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1637 <tr><td>peer_object</td><td>o</td><td></td><td>yes</td></tr>
1638 <tr><td>frequency</td><td>i</td><td></td><td>yes</td></tr>
1639 <tr><td>dialog_token</td><td>i</td><td></td><td>yes</td></tr>
1640 <tr><td>tlvs</td><td>ay</td><td></td><td>yes</td></tr>
1641 </table>
1642 </dd>
1643 </dl>
1644 </li>
1645
1646 <li>
1647 <h3>ServiceDiscoveryCancelRequest ( t : args ) --> nothing : ref</h3>
1648 </li>
1649
1650 <li>
1651 <h3>ServiceUpdate ( nothing ) --> nothing</h3>
1652 </li>
1653
1654 <li>
1655 <h3>ServiceDiscoveryExternal ( i : arg ) --> nothing</h3>
1656 </li>
1657
1658 <li>
1659 <h3>AddPersistentGroup ( a{sv} : args ) --> o : path</h3>
1660 <p></p>
1661 <h4>Arguments</h4>
1662 <dl>
1663 <dt>a{sv} : args</dt>
1664 <dd>
1665 A dictionary with following parameters:
1666 <table>
1667 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
1668 <tr><td>bssid</td><td>s</td><td>P2P Device Address of the GO in the persistent group.</td><td>yes</td></tr>
1669 <tr><td>ssid</td><td>s</td><td>SSID of the group</td><td>yes</td></tr>
1670 <tr><td>psk</td><td>s</td><td>Passphrase (on the GO and optionally on P2P Client) or PSK (on P2P Client if passphrase ise not known)</td><td>yes</td></tr>
1671 <tr><td>mode</td><td>s</td><td>"3" on GO or "0" on P2P Client</td><td>yes</td></tr>
1672 </table>
1673 </dd>
1674 </dl>
1675 </li>
1676
1677 <li>
1678 <h3>RemovePersistentGroup ( o : path ) --> nothing</h3>
1679 </li>
1680
1681 <li>
1682 <h3>RemoveAllPersistentGroups ( nothing ) --> nothing</h3>
1683 </li>
1684 </ul>
1685
1686 \subsection dbus_p2pdevice_properties Properties
1687
1688 <ul>
1689 <li>
1690 <h3>P2PDeviceConfig - a{sv} - (read/write)</h3>
1691 <p>Dictionary with following entries. On write, only the included values are changed.</p>
1692 <table>
1693 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1694 <tr><td>DeviceName</td><td>s</td><td></td></tr>
1695 <tr><td>PrimaryDeviceType</td><td>ay</td><td></td></tr>
1696 <tr><td>SecondaryDeviceTypes</td><td>aay</td><td></td></tr>
1697 <tr><td>VendorExtension</td><td>aay</td><td></td></tr>
1698 <tr><td>GOIntent</td><td>u</td><td></td></tr>
1699 <tr><td>PersistentReconnect</td><td>b</td><td></td></tr>
1700 <tr><td>ListenRegClass</td><td>u</td><td></td></tr>
1701 <tr><td>ListenChannel</td><td>u</td><td></td></tr>
1702 <tr><td>OperRegClass</td><td>u</td><td></td></tr>
1703 <tr><td>OperChannel</td><td>u</td><td></td></tr>
1704 <tr><td>SsidPostfix</td><td>s</td><td></td></tr>
1705 <tr><td>IntraBss</td><td>b</td><td></td></tr>
1706 <tr><td>GroupIdle</td><td>u</td><td></td></tr>
1707 <tr><td>disassoc_low_ack</td><td>u</td><td></td></tr>
1708 <tr><td>NoGroupIface</td><td>b</td><td></td></tr>
1709 <tr><td>p2p_search_delay</td><td>u</td><td></td></tr>
1710 </table>
1711 </li>
1712
1713 <li>
1714 <h3>Peers - ao - (read)</h3>
1715 </li>
1716
1717 <li>
1718 <h3>Role - s - (read)</h3>
1719 <p>\bug What is this trying to indicate? It does not make much sense to have a P2PDevice property role since there can be multiple concurrent groups and the P2P Device role is always active anyway.</p>
1720 </li>
1721
1722 <li>
1723 <h3>Group - o - (read)</h3>
1724 <p>\bug What is this trying to indicate? It does not make much sense to have a P2PDevice property Group since there can be multiple concurrent groups.</p>
1725 </li>
1726
1727 <li>
1728 <h3>PeerGO - o - (read)</h3>
1729 <p>\bug What is this trying to indicate? It does not make much sense to have a P2PDevice property PeerGO since there can be multiple concurrent groups.</p>
1730 </li>
1731
1732 <li>
1733 <h3>PersistentGroups - ao - (read)</h3>
1734 </li>
1735 </ul>
1736
1737 \subsection dbus_p2pdevice_signals Signals
1738
1739 <ul>
1740 <li>
1741 <h3>DeviceFound ( o : path )</h3>
1742 </li>
1743
1744 <li>
1745 <h3>DeviceFoundProperties ( o : path, a{sv} : properties )</h3>
1746 <p>A new peer device has been found.</p>
1747 <h4>Arguments</h4>
1748 <dl>
1749 <dt>o : path</dt>
1750 <dd>A D-Bus path to an object representing the found peer device.</dd>
1751 </dl>
1752 <dl>
1753 <dt>a{sv} : properties</dt>
1754 <dd>A dictionary containing properties of the found peer device.</dd>
1755 </dl>
1756 </li>
1757
1758 <li>
1759 <h3>DeviceLost ( o : path )</h3>
1760 </li>
1761
1762 <li>
1763 <h3>FindStopped ( )</h3>
1764 </li>
1765
1766 <li>
1767 <h3>ProvisionDiscoveryRequestDisplayPin ( o : peer_object, s : pin )</h3>
1768 </li>
1769
1770 <li>
1771 <h3>ProvisionDiscoveryResponseDisplayPin ( o : peer_object, s : pin )</h3>
1772 </li>
1773
1774 <li>
1775 <h3>ProvisionDiscoveryRequestEnterPin ( o : peer_object )</h3>
1776 </li>
1777
1778 <li>
1779 <h3>ProvisionDiscoveryResponseEnterPin ( o : peer_object )</h3>
1780 </li>
1781
1782 <li>
1783 <h3>ProvisionDiscoveryPBCRequest ( o : peer_object )</h3>
1784 </li>
1785
1786 <li>
1787 <h3>ProvisionDiscoveryPBCResponse ( o : peer_object )</h3>
1788 </li>
1789
1790 <li>
1791 <h3>ProvisionDiscoveryFailure ( o : peer_object, i : status )</h3>
1792 </li>
1793
1794 <li>
1795 <h3>GroupStarted ( a{sv} : properties )</h3>
1796 <p>A new P2P group was started or joined.</p>
1797 <h4>Arguments</h4>
1798 <dl>
1799 <dt>a{sv} : properties</dt>
1800 <dd>A dictionary with following information on the added group:
1801 <table>
1802 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1803 <tr><td>interface_object</td><td>o</td><td>D-Bus path of the interface on which this group is operating on. See \ref dbus_interface.</td></tr>
1804 <tr><td>role</td><td>s</td><td>The role of the local device in the group: "GO" or "client".</td></tr>
1805 <tr><td>group_object</td><td>o</td><td>D-Bus path of the group. See \ref dbus_group.</td></tr>
1806 </table>
1807 </dd>
1808 </dl>
1809 </li>
1810
1811 <li>
1812 <h3>GONegotiationSuccess ( a{sv} : properties )</h3>
1813 <p></p>
1814 <h4>Arguments</h4>
1815 <dl>
1816 <dt>a{sv} : properties</dt>
1817 <dd>A dictionary with following information:
1818 <table>
1819 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1820 <tr><td>peer_object</td><td>o</td><td>D-Bus path of the peer. See \ref dbus_peer.</td></tr>
1821 <tr><td>status</td><td>i</td><td></td></tr>
1822 <tr><td>passphrase</td><td>s</td><td>Passphrase for the group. Included only if this device becomes the GO of the group.</td></tr>
1823 <tr><td>role_go</td><td>s</td><td>The role of the local device in the group: "GO" or "client".</td></tr>
1824 <tr><td>ssid</td><td>ay</td><td></td></tr>
1825 <tr><td>peer_device_addr</td><td>ay</td><td></td></tr>
1826 <tr><td>peer_interface_addr</td><td>ay</td><td></td></tr>
1827 <tr><td>wps_method</td><td>s</td><td></td></tr>
1828 <tr><td>frequency_list</td><td>ai</td><td></td></tr>
1829 <tr><td>persistent_group</td><td>i</td><td></td></tr>
1830 <tr><td>peer_config_timeout</td><td>u</td><td></td></tr>
1831 </table>
1832 </dd>
1833 </dl>
1834 </li>
1835
1836 <li>
1837 <h3>GONegotiationFailure ( a{sv} : properties )</h3>
1838 <p></p>
1839 <h4>Arguments</h4>
1840 <dl>
1841 <dt>a{sv} : properties</dt>
1842 <dd>A dictionary with following information:
1843 <table>
1844 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1845 <tr><td>peer_object</td><td>o</td><td>D-Bus path of the peer. See \ref dbus_peer.</td></tr>
1846 <tr><td>status</td><td>i</td><td></td></tr>
1847 </table>
1848 </dd>
1849 </dl>
1850 </li>
1851
1852 <li>
1853 <h3>GONegotiationRequest ( o : path, q : dev_passwd_id, y : device_go_intent )</h3>
1854 </li>
1855
1856 <li>
1857 <h3>InvitationResult ( a{sv} : invite_result )</h3>
1858 <p></p>
1859 <h4>Arguments</h4>
1860 <dl>
1861 <dt>a{sv} : invite_result</dt>
1862 <dd>A dictionary with following information:
1863 <table>
1864 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1865 <tr><td>status</td><td>i</td><td></td></tr>
1866 <tr><td>BSSID</td><td>ay</td><td>Optionally present</td></tr>
1867 </table>
1868 </dd>
1869 </dl>
1870 </li>
1871
1872 <li>
1873 <h3>GroupFinished ( a{sv} : properties )</h3>
1874 <p>A P2P group was removed.</p>
1875 <h4>Arguments</h4>
1876 <dl>
1877 <dt>a{sv} : properties</dt>
1878 <dd>A dictionary with following information of the removed group:
1879 <table>
1880 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1881 <tr><td>interface_object</td><td>o</td><td>D-Bus path of the interface on which this group is operating on. See \ref dbus_interface.</td></tr>
1882 <tr><td>role</td><td>s</td><td>The role of the local device in the group: "GO" or "client".</td></tr>
1883 <tr><td>group_object</td><td>o</td><td>D-Bus path of the group. See \ref dbus_group.</td></tr>
1884 </table>
1885 </dd>
1886 </dl>
1887 </li>
1888
1889 <li>
1890 <h3>ServiceDiscoveryRequest ( a{sv} : sd_request )</h3>
1891 <p></p>
1892 <h4>Arguments</h4>
1893 <dl>
1894 <dt>a{sv} : sd_request</dt>
1895 <dd>A dictionary with following information:
1896 <table>
1897 <tr><td>peer_object</td><td>o</td><td></td></tr>
1898 <tr><td>frequency</td><td>i</td><td></td></tr>
1899 <tr><td>dialog_token</td><td>i</td><td></td></tr>
1900 <tr><td>update_indicator</td><td>q</td><td></td></tr>
1901 <tr><td>tlvs</td><td>ay</td><td></td></tr>
1902 </table>
1903 </dd>
1904 </dl>
1905 </li>
1906
1907 <li>
1908 <h3>ServiceDiscoveryResponse ( a{sv} : sd_response )</h3>
1909 <p></p>
1910 <h4>Arguments</h4>
1911 <dl>
1912 <dt>a{sv} : sd_response</dt>
1913 <dd>A dictionary with following information:
1914 <table>
1915 <tr><td>peer_object</td><td>o</td><td></td></tr>
1916 <tr><td>update_indicator</td><td>q</td><td></td></tr>
1917 <tr><td>tlvs</td><td>ay</td><td></td></tr>
1918 </table>
1919 </dd>
1920 </dl>
1921 </li>
1922
1923 <li>
1924 <h3>PersistentGroupAdded ( o : path, a{sv} : properties )</h3>
1925 <p></p>
1926 <h4>Arguments</h4>
1927 <dl>
1928 <dt>o : path</dt>
1929 <dd>D-Bus object path for the persistent group. See \ref dbus_persistent_group.</dd>
1930 <dt>a{sv} : properties</dt>
1931 <dd>A dictionary with following information:
1932 <table>
1933 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1934 <tr><td>bssid</td><td>s</td><td>P2P Device Address of the GO in the persistent group.</td></tr>
1935 <tr><td>ssid</td><td>s</td><td>SSID of the group</td></tr>
1936 <tr><td>psk</td><td>s</td><td>Passphrase (on the GO and optionally on P2P Client) or PSK (on P2P Client if passphrase ise not known)</td></tr>
1937 <tr><td>disabled</td><td>s</td><td>Set to "2" to indicate special network block use as a P2P persistent group information</td></tr>
1938 <tr><td>mode</td><td>s</td><td>"3" on GO or "0" on P2P Client</td></tr>
1939 </table>
1940 </dd>
1941 </dl>
1942 </li>
1943
1944 <li>
1945 <h3>PersistentGroupRemoved ( o : path )</h3>
1946 <p></p>
1947 <h4>Arguments</h4>
1948 <dl>
1949 <dt>o : path</dt>
1950 <dd>D-Bus object path for the persistent group. See \ref dbus_persistent_group.</dd>
1951 </dl>
1952 </li>
1953
1954 <li>
1955 <h3>WpsFailed ( s : name, a{sv} : args )</h3>
1956 <p></p>
1957 <h4>Arguments</h4>
1958 <dl>
1959 <dt>s : name</dt>
1960 <dd>"fail"</dd>
1961 <dt>a{sv} : args</dt>
1962 <dd>A dictionary with following information:
1963 <table>
1964 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1965 <tr><td>msg</td><td>i</td><td></td></tr>
1966 <tr><td>config_error</td><td>n</td><td></td></tr>
1967 </table>
1968 </dd>
1969 </dl>
1970 </li>
1971
1972 <li>
1973 <h3>InvitationReceived ( a{sv} : properties )</h3>
1974 <p></p>
1975 <h4>Arguments</h4>
1976 <dl>
1977 <dt>a{sv} : properties</dt>
1978 <dd>A dictionary with following information:
1979 <table>
1980 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
1981 <tr><td>sa</td><td>ay</td><td>Optionally present</td></tr>
1982 <tr><td>go_dev_addr</td><td>ay</td><td>Optionally present</td></tr>
1983 <tr><td>bssid</td><td>ay</td><td>Optionally present</td></tr>
1984 <tr><td>persistent_id</td><td>i</td><td>Optionally present</td></tr>
1985 <tr><td>op_freq</td><td>i</td><td></td></tr>
1986 </table>
1987 </dd>
1988 </dl>
1989 </li>
1990
1991 <li>
1992 <h3>GroupFormationFailure ( s : reason )</h3>
1993 <p></p>
1994 <h4>Arguments</h4>
1995 <dl>
1996 <dt>s : reason</dt>
1997 <dd>Reason for failure or empty string if not known.</dd>
1998 </dl>
1999 </li>
2000 </ul>
2001
2002 \section dbus_bss fi.w1.wpa_supplicant1.BSS
2003
2004 Interface implemented by objects representing a scanned BSSs, i.e.,
2005 scan results.
2006
2007 \subsection dbus_bss_properties Properties
2008
2009 <ul>
2010 <li>
2011 <h3>BSSID - ay - (read)</h3>
2012 <p>BSSID of the BSS.</p>
2013 </li>
2014 <li>
2015 <h3>SSID - ay - (read)</h3>
2016 <p>SSID of the BSS.</p>
2017 </li>
2018 <li>
2019 <h3>WPA - a{sv} - (read)</h3>
2020 <p>WPA information of the BSS. Empty dictionary indicates no WPA support. Dictionary entries are:</p>
2021 <table>
2022 <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-none"</td>
2023 <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
2024 <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
2025 </table>
2026 </li>
2027 <li>
2028 <h3>RSN - a{sv} - (read)</h3>
2029 <p>RSN information of the BSS. Empty dictionary indicates no RSN support. Dictionary entries are:</p>
2030 <table>
2031 <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "wpa-eap-suite-b", "wpa-eap-suite-b-192", "wpa-fils-sha256", "wpa-fils-sha384", "wpa-ft-fils-sha256", "wpa-ft-fils-sha384", "sae", "ft-sae", "wpa-none"</td>
2032 <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
2033 <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
2034 <tr><td>MgmtGroup</td><td>s</td><td>Mangement frames cipher suite. Possible values are: "aes128cmac"</td>
2035 </table>
2036 </li>
2037 <li>
2038 <h3>WPS - a{sv} - (read)</h3>
2039 <p>WPS information of the BSS. Empty dictionary indicates no WPS support. Dictionary entries are:</p>
2040 <table>
2041 <tr><td>Type</td><td>s</td><td>"pbc", "pin", ""</td>
2042 </table>
2043 </li>
2044 <li>
2045 <h3>IEs - ay - (read)</h3>
2046 <p>All IEs of the BSS as a chain of TLVs</p>
2047 </li>
2048 <li>
2049 <h3>Privacy - b - (read)</h3>
2050 <p>Indicates if BSS supports privacy.</p>
2051 </li>
2052 <li>
2053 <h3>Mode - s - (read)</h3>
2054 <p>Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".</p>
2055 </li>
2056 <li>
2057 <h3>Frequency - q - (read)</h3>
2058 <p>Frequency of the BSS in MHz.</p>
2059 </li>
2060 <li>
2061 <h3>Rates - au - (read)</h3>
2062 <p>Descending ordered array of rates supported by the BSS in bits per second.</p>
2063 </li>
2064 <li>
2065 <h3>Signal - n - (read)</h3>
2066 <p>Signal strength of the BSS.</p>
2067 </li>
2068 <li>
2069 <h3>Age - u - (read)</h3>
2070 <p>Number of seconds since the BSS was last seen.</p>
2071 </li>
2072 </ul>
2073
2074 \subsection dbus_bss_signals Signals
2075
2076 <ul>
2077 <li>
2078 <h3>PropertiesChanged ( a{sv} : properties )</h3>
2079 <p>Some properties have changed.</p>
2080 <h4>Arguments</h4>
2081 <dl>
2082 <dt>a{sv} : properties</dt>
2083 <dd>A dictionary with pairs of properties names which have changed and theirs new values.</dd>
2084 </dl>
2085 </li>
2086 </ul>
2087
2088
2089 \section dbus_network fi.w1.wpa_supplicant1.Network
2090
2091 Interface implemented by objects representing configured networks,
2092 i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork.
2093
2094 \subsection dbus_network_properties Properties
2095
2096 <ul>
2097 <li>
2098 <h3>Enabled - b - (read/write)</h3>
2099 <p>Determines if the configured network is enabled or not.</p>
2100 </li>
2101
2102 <li>
2103 <h3>Properties - a{sv} - (read/write)</h3>
2104 <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.
2105 </li>
2106 </ul>
2107
2108 \subsection dbus_network_signals Signals
2109
2110 <ul>
2111 <li>
2112 <h3>PropertiesChanged ( a{sv} : properties )</h3>
2113 <p>Some properties have changed.</p>
2114 <h4>Arguments</h4>
2115 <dl>
2116 <dt>a{sv} : properties</dt>
2117 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "Enabled"</dd>
2118 </dl>
2119 </li>
2120 </ul>
2121
2122 \section dbus_peer fi.w1.wpa_supplicant1.Peer
2123
2124 Interface implemented by objects representing P2P peer devices.
2125
2126 \subsection dbus_peer_properties Properties
2127
2128 <ul>
2129 <li>
2130 <h3>DeviceName - s - (read)</h3>
2131 </li>
2132
2133 <li>
2134 <h3>Manufacturer - s - (read)</h3>
2135 </li>
2136
2137 <li>
2138 <h3>ModelName - s - (read)</h3>
2139 </li>
2140
2141 <li>
2142 <h3>ModelNumber - s - (read)</h3>
2143 </li>
2144
2145 <li>
2146 <h3>SerialNumber - s - (read)</h3>
2147 </li>
2148
2149 <li>
2150 <h3>PrimaryDeviceType - ay - (read)</h3>
2151 </li>
2152
2153 <li>
2154 <h3>config_method - q - (read)</h3>
2155 </li>
2156
2157 <li>
2158 <h3>level - i - (read)</h3>
2159 </li>
2160
2161 <li>
2162 <h3>devicecapability - y - (read)</h3>
2163 </li>
2164
2165 <li>
2166 <h3>groupcapability - y - (read)</h3>
2167 <p>Group Capability field from the last frame from which this peer information was updated.
2168 \note This field is only for debugging purposes and must not be used to determine whether the peer happens to be operating a group as a GO at the moment.
2169 </p>
2170 </li>
2171
2172 <li>
2173 <h3>SecondaryDeviceTypes - aay - (read)</h3>
2174 </li>
2175
2176 <li>
2177 <h3>VendorExtension - aay - (read)</h3>
2178 </li>
2179
2180 <li>
2181 <h3>IEs - ay - (read)</h3>
2182 <p>This is a confusingly named property that includes Wi-Fi Display subelements from the peer.
2183 \bug This should really be renamed since "IEs" means something completely different..
2184 </p>
2185 </li>
2186
2187 <li>
2188 <h3>DeviceAddress - ay - (read)</h3>
2189 <p>The P2P Device Address of the peer.</p>
2190 </li>
2191
2192 <li>
2193 <h3>Groups - ao - (read)</h3>
2194 <p>The current groups in which this peer is connected.</p>
2195 </li>
2196 </ul>
2197
2198 \subsection dbus_peer_signals Signals
2199
2200 <ul>
2201 <li>
2202 <h3>PropertiesChanged ( a{sv} : properties )</h3>
2203 <p>Some properties have changed.
2204 \deprecated Use org.freedesktop.DBus.Properties.PropertiesChanged instead.</p>
2205 \todo Explain how ProertiesChanged signals are supposed to be of any real use with Peer objects (i.e., one signal for multiple peers).
2206 <h4>Arguments</h4>
2207 <dl>
2208 <dt>a{sv} : properties</dt>
2209 <dd>A dictionary with pairs of properties names which have changed and their new values.</dd>
2210 </dl>
2211 </li>
2212 </ul>
2213
2214 \section dbus_group fi.w1.wpa_supplicant1.Group
2215
2216 Interface implemented by objects representing active P2P groups.
2217
2218 \subsection dbus_group_properties Properties
2219
2220 <ul>
2221 <li>
2222 <h3>Members - ao - (read)</h3>
2223 <p>Array of D-Bus object paths for the peer devices that are currently connected to the group. This is valid only on the GO device. An empty array is returned in P2P Client role.
2224 </li>
2225
2226 <li>
2227 <h3>Group - o - (read)</h3>
2228 <p>\todo Why is this here? This D-Bus object path is to this specific group and one needs to know it to fetching this information in the first place..
2229 </p>
2230 </li>
2231
2232 <li>
2233 <h3>Role - s - (read)</h3>
2234 <p>The role of this device in the group: "GO", "client".</p>
2235 </li>
2236
2237 <li>
2238 <h3>SSID - ay - (read)</h3>
2239 <p>P2P Group SSID.</p>
2240 </li>
2241
2242 <li>
2243 <h3>BSSID - ay - (read)</h3>
2244 <p>P2P Group BSSID (the P2P Interface Address of the GO).</p>
2245 </li>
2246
2247 <li>
2248 <h3>Frequency - q - (read)</h3>
2249 <p>The frequency (in MHz) of the group operating channel.</p>
2250 </li>
2251
2252 <li>
2253 <h3>Passphrase - s - (read)</h3>
2254 <p>Passphrase used in the group. This is always available on the GO. For P2P Client role, this may be available depending on whether the peer GO provided the passphrase during the WPS provisioning step. If not available, an empty string is returned.</p>
2255 </li>
2256
2257 <li>
2258 <h3>PSK - ay - (read)</h3>
2259 <p>PSK used in the group.</p>
2260 </li>
2261
2262 <li>
2263 <h3>WPSVendorExtensions - aay - (read/write)</h3>
2264 <p>WPS vendor extension attributes used on the GO. This is valid only the in the GO role. An empty array is returned in P2P Client role. At maximum, 10 separate vendor extension byte arrays can be configured. The GO device will include the configured attributes in WPS exchanges.</p>
2265 </li>
2266 </ul>
2267
2268 \subsection dbus_group_signals Signals
2269
2270 <ul>
2271 <li>
2272 <h3>PeerJoined ( o : peer )</h3>
2273 <p>A peer device has joined the group. This is indicated only on the GO device.</p>
2274 <h4>Arguments</h4>
2275 <dl>
2276 <dt>o : peer</dt>
2277 <dd>A D-Bus path to the object representing the peer. See \ref dbus_peer.</dd>
2278 </dl>
2279 </li>
2280
2281 <li>
2282 <h3>PeerDisconnected ( o : peer )</h3>
2283 <p>A peer device has left the group. This is indicated only on the GO device.</p>
2284 <h4>Arguments</h4>
2285 <dl>
2286 <dt>o : peer</dt>
2287 <dd>A D-Bus path to the object representing the peer. See \ref dbus_peer.</dd>
2288 </dl>
2289 </li>
2290 </ul>
2291
2292 \section dbus_persistent_group fi.w1.wpa_supplicant1.PersistentGroup
2293
2294 Interface implemented by objects representing persistent P2P groups.
2295
2296 \subsection dbus_persistent_group_properties Properties
2297
2298 <ul>
2299 <li>
2300 <h3>Properties - a{sv} - (read/write)</h3>
2301 <p>Properties of the persistent group. These are same properties as in the \ref dbus_network. When writing this, only the entries to be modified are included, i.e., any item that is not included will be left at its existing value. The following entries are used for persistent groups:</p>
2302 <table>
2303 <tr><th>Key</th><th>Value type</th><th>Description</th></tr>
2304 <tr><td>bssid</td><td>s</td><td>P2P Device Address of the GO in the persistent group.</td></tr>
2305 <tr><td>ssid</td><td>s</td><td>SSID of the group</td></tr>
2306 <tr><td>psk</td><td>s</td><td>Passphrase (on the GO and optionally on P2P Client) or PSK (on P2P Client if passphrase ise not known)</td></tr>
2307 <tr><td>disabled</td><td>s</td><td>Set to "2" to indicate special network block use as a P2P persistent group information</td></tr>
2308 <tr><td>mode</td><td>s</td><td>"3" on GO or "0" on P2P Client</td></tr>
2309 </table>
2310 </li>
2311 </ul>
2312
2313 \section dbus_mesh fi.w1.wpa_supplicant1.Interface.Mesh
2314
2315 Interface for performing mesh operations.
2316
2317 \subsection dbus_mesh_properties Properties
2318
2319 <ul>
2320 <li>
2321 <h3>MeshPeers - aay - (read)</h3>
2322 </li>
2323
2324 <li>
2325 <h3>MeshGroup - ay - (read)</h3>
2326 </li>
2327 </ul>
2328
2329 \subsection dbus_mesh_signals Signals
2330
2331 <ul>
2332 <li>
2333 <h3>MeshGroupStarted ( a{sv} : args )</h3>
2334 <p></p>
2335 <h4>Arguments</h4>
2336 <dl>
2337 <dt>a{sv} : args</dt>
2338 <dd>A dictionary containing information of the started mesh group.</dd>
2339 </dl>
2340 </li>
2341 <li>
2342 <h3>MeshGroupRemoved ( a{sv} : args )</h3>
2343 <p></p>
2344 <h4>Arguments</h4>
2345 <dl>
2346 <dt>a{sv} : args</dt>
2347 <dd>A dictionary containing information of the removed mesh group.</dd>
2348 </dl>
2349 </li>
2350 <li>
2351 <h3>MeshPeerConnected ( a{sv} : args )</h3>
2352 <p></p>
2353 <h4>Arguments</h4>
2354 <dl>
2355 <dt>a{sv} : args</dt>
2356 <dd>A dictionary containing information of the connected mesh peer.</dd>
2357 </dl>
2358 </li>
2359 <li>
2360 <h3>MeshPeerDisconnected ( a{sv} : args )</h3>
2361 <p></p>
2362 <h4>Arguments</h4>
2363 <dl>
2364 <dt>a{sv} : args</dt>
2365 <dd>A dictionary containing information of the disconnected mesh peer.</dd>
2366 </dl>
2367 </li>
2368 </ul>
2369
2370 */