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