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