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