doc/dbus.doxygen

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