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