www.project-moonshot.org Git - mech_eap.orig/blob - 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_bss
  14 - \ref dbus_network
  15
  16
  17 \section dbus_main fi.w1.wpa_supplicant1
  18
  19 Interface implemented by the main %wpa_supplicant D-Bus object
  20 registered in the bus with fi.w1.wpa_supplicant1 name.
  21
  22 \subsection dbus_main_methods Methods
  23
  24     <ul>
  25       <li>
  26         <h3>CreateInterface ( a{sv} : args ) --> o : interface</h3>
  27         <p>Registers a wireless interface in %wpa_supplicant.</p>
  28         <h4>Arguments</h4>
  29         <dl>
  30           <dt>a{sv} : args</dt>
  31           <dd>
  32             A dictionary with arguments used to add the interface to %wpa_supplicant. The dictionary may contain the following entries:
  33             <table>
  34               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
  35               <tr><td>Ifname</td><td>s</td><td>Name of the network interface to control, e.g., wlan0</td><td>Yes</td>
  36               <tr><td>Bridge_ifname</td><td>s</td><td>Name of the bridge interface to control, e.g., br0</td><td>No</td>
  37               <tr><td>Driver</td><td>s</td><td>Driver name which the interface uses, e.g., nl80211</td><td>No</td>
  38             </table>
  39           </dd>
  40         </dl>
  41         <h4>Returns</h4>
  42         <dl>
  43           <dt>o : interface</dt>
  44           <dd>A D-Bus path to object representing created interface</dd>
  45         </dl>
  46         <h4>Possible errors</h4>
  47         <dl>
  48           <dt>fi.w1.wpa_supplicant1.InterfaceExists</dt>
  49           <dd>%wpa_supplicant already controls this interface.</dd>
  50           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
  51           <dd>Creating interface failed for an unknown reason.</dd>
  52           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
  53           <dd>Invalid entries were found in the passed argument.</dd>
  54         </dl>
  55       </li>
  56
  57       <li>
  58         <h3>RemoveInterface ( o : interface ) --> nothing</h3>
  59         <p>Deregisters a wireless interface from %wpa_supplicant.</p>
  60         <h4>Arguments</h4>
  61         <dl>
  62           <dt>o : interface</dt>
  63           <dd>A D-Bus path to an object representing an interface to remove returned by CreateInterface</dd>
  64         </dl>
  65         <h4>Possible errors</h4>
  66         <dl>
  67           <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt>
  68           <dd>Object pointed by the path doesn't exist or doesn't represent an interface.</dd>
  69           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
  70           <dd>Removing interface failed for an unknown reason.</dd>
  71         </dl>
  72       </li>
  73
  74       <li>
  75         <h3>GetInterface ( s : ifname ) --> o : interface</h3>
  76         <p>Returns a D-Bus path to an object related to an interface which %wpa_supplicant already controls.</p>
  77         <h4>Arguments</h4>
  78         <dl>
  79           <dt>s : ifname</dt>
  80           <dd>Name of the network interface, e.g., wlan0</dd>
  81         </dl>
  82         <h4>Returns</h4>
  83         <dl>
  84           <dt>o : interface</dt>
  85           <dd>A D-Bus path to an object representing an interface</dd>
  86         </dl>
  87         <h4>Possible errors</h4>
  88         <dl>
  89           <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt>
  90           <dd>An interface with the passed name in not controlled by %wpa_supplicant.</dd>
  91           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
  92           <dd>Getting an interface object path failed for an unknown reason.</dd>
  93         </dl>
  94       </li>
  95     </ul>
  96
  97 \subsection dbus_main_properties Properties
  98
  99     <ul>
 100       <li>
 101         <h3>DebugParams - (ibb) - (read/write)</h3>
 102         <p>A structure describing debugging properties. The structure elements are (in order): debug level (i), show timestamps (b), show keys (b).</p>
 103       </li>
 104
 105       <li>
 106         <h3>Interfaces - ao - (read)</h3>
 107         <p>An array with paths to D-Bus objects representing controlled interfaces each.</p>
 108       </li>
 109
 110       <li>
 111         <h3>EapMethods - as - (read)</h3>
 112         <p>An array with supported EAP methods names.</p>
 113       </li>
 114     </ul>
 115
 116 \subsection dbus_main_signals Signals
 117
 118     <ul>
 119       <li>
 120         <h3>InterfaceAdded ( o : interface )</h3>
 121         <p>A new interface was added to %wpa_supplicant.</p>
 122         <h4>Arguments</h4>
 123         <dl>
 124           <dt>o : interface</dt>
 125           <dd>A D-Bus path to an object representing the added interface</dd>
 126         </dl>
 127       </li>
 128
 129       <li>
 130         <h3>InterfaceRemoved ( o : interface )</h3>
 131         <p>An interface was removed from %wpa_supplicant.</p>
 132         <h4>Arguments</h4>
 133         <dl>
 134           <dt>o : interface</dt>
 135           <dd>A D-Bus path to an object representing the removed interface</dd>
 136         </dl>
 137       </li>
 138
 139       <li>
 140         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 141         <p>Some properties have changed.</p>
 142         <h4>Arguments</h4>
 143         <dl>
 144           <dt>a{sv} : properties</dt>
 145           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "DebugParams"</dd>
 146         </dl>
 147       </li>
 148     </ul>
 149
 150
 151 \section dbus_interface fi.w1.wpa_supplicant1.Interface
 152
 153 Interface implemented by objects related to network interface added to
 154 %wpa_supplicant, i.e., returned by
 155 fi.w1.wpa_supplicant1.CreateInterface.
 156
 157 \subsection dbus_interface_methods Methods
 158
 159     <ul>
 160       <li>
 161         <h3>Scan ( a{sv} : args ) --> nothing</h3>
 162         <p>Triggers a scan.</p>
 163         <h4>Arguments</h4>
 164         <dl>
 165           <dt>a{sv} : args</dt>
 166           <dd>
 167             A dictionary with arguments describing scan type:
 168             <table>
 169               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 170               <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td>
 171               <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>
 172               <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>
 173               <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>
 174             </table>
 175           </dd>
 176         </dl>
 177         <h4>Possible errors</h4>
 178         <dl>
 179           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 180           <dd>Invalid entries were found in the passed argument.</dd>
 181         </dl>
 182       </li>
 183
 184       <li>
 185         <h3>Disconnect ( ) --> nothing</h3>
 186         <p>Disassociates the interface from current network.</p>
 187         <h4>Possible errors</h4>
 188         <dl>
 189           <dt>fi.w1.wpa_supplicant1.Interface.NotConnected</dt>
 190           <dd>Interface is not connected to any network.</dd>
 191         </dl>
 192       </li>
 193
 194       <li>
 195         <h3>AddNetwork ( a{sv} : args ) --> o : network</h3>
 196         <p>Adds a new network to the interface.</p>
 197         <h4>Arguments</h4>
 198         <dl>
 199           <dt>a{sv} : args</dt>
 200           <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>
 201         </dl>
 202         <h4>Returns</h4>
 203         <dl>
 204           <dt>o : network</dt>
 205           <dd>A D-Bus path to an object representing a configured network</dd>
 206         </dl>
 207         <h4>Possible errors</h4>
 208         <dl>
 209           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 210           <dd>Invalid entries were found in the passed argument.</dd>
 211           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 212           <dd>Adding network failed for an unknown reason.</dd>
 213         </dl>
 214       </li>
 215
 216       <li>
 217         <h3>RemoveNetwork ( o : network ) --> nothing</h3>
 218         <p>Removes a configured network from the interface.</p>
 219         <h4>Arguments</h4>
 220         <dl>
 221           <dt>o : network</dt>
 222           <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
 223         </dl>
 224         <h4>Possible errors</h4>
 225         <dl>
 226           <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt>
 227           <dd>A passed path doesn't point to any network object.</dd>
 228           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 229           <dd>A passed path doesn't point to any network object.</dd>
 230           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 231           <dd>Removing network failed for an unknown reason.</dd>
 232         </dl>
 233       </li>
 234
 235       <li>
 236         <h3>SelectNetwork ( o : network ) --> nothing</h3>
 237         <p>Attempt association with a configured network.</p>
 238         <h4>Arguments</h4>
 239         <dl>
 240           <dt>o : network</dt>
 241           <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd>
 242         </dl>
 243         <h4>Possible errors</h4>
 244         <dl>
 245           <dt>fi.w1.wpa_supplicant1.Interface.NetworkUnknown</dt>
 246           <dd>A passed path doesn't point to any network object.</dd>
 247           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 248           <dd>A passed path doesn't point to any network object.</dd>
 249         </dl>
 250       </li>
 251
 252       <li>
 253         <h3>AddBlob ( s : name, ay : data ) --> nothing</h3>
 254         <p>Adds a blob to the interface.</p>
 255         <h4>Arguments</h4>
 256         <dl>
 257           <dt>s : name</dt>
 258           <dd>A name of a blob</dd>
 259           <dt>ay : data</dt>
 260           <dd>A blob data</dd>
 261         </dl>
 262         <h4>Possible errors</h4>
 263         <dl>
 264           <dt>fi.w1.wpa_supplicant1.Interface.BlobExists</dt>
 265           <dd>A blob with the specified name already exists.</dd>
 266         </dl>
 267       </li>
 268
 269       <li>
 270         <h3>RemoveBlob ( s : name ) --> nothing</h3>
 271         <p>Removes the blob from the interface.</p>
 272         <h4>Arguments</h4>
 273         <dl>
 274           <dt>s : name</dt>
 275           <dd>A name of the blob to remove</dd>
 276         </dl>
 277         <h4>Possible errors</h4>
 278         <dl>
 279           <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt>
 280           <dd>A blob with the specified name doesn't exist.</dd>
 281         </dl>
 282       </li>
 283
 284       <li>
 285         <h3>GetBlob ( s : name ) --> ay : data</h3>
 286         <p>Returns the blob data of a previously added blob.</p>
 287         <h4>Arguments</h4>
 288         <dl>
 289           <dt>s : name</dt>
 290           <dd>A name of the blob</dd>
 291         </dl>
 292         <h4>Returns</h4>
 293         <dl>
 294           <dt>ay : data</dt>
 295           <dd>A blob data</dd>
 296         </dl>
 297         <h4>Possible errors</h4>
 298         <dl>
 299           <dt>fi.w1.wpa_supplicant1.Interface.BlobUnknown</dt>
 300           <dd>A blob with the specified name doesn't exist.</dd>
 301         </dl>
 302       </li>
 303     </ul>
 304
 305 \subsection dbus_interface_properties Properties
 306
 307     <ul>
 308       <li>
 309         <h3>Capabilities - a{sv} - (read)</h3>
 310         <p>Capabilities of the interface. Dictionary contains following entries:</p>
 311         <table>
 312           <tr><th>Key</th><th>Value type</th><th>Description</th>
 313           <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "none"</td>
 314           <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp", "tkip", "wep104", "wep40"</td>
 315           <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-eap", "ieee8021x", "wpa-none", "wps", "none"</td>
 316           <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td>
 317           <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td>
 318           <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td>
 319           <tr><td>Modes</td><td>as</td><td>Possible array elements: "infrastructure", "ad-hoc", "ap"</td>
 320         </table>
 321       </li>
 322
 323       <li>
 324         <h3>State - s - (read)</h3>
 325         <p>A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".</p>
 326       </li>
 327
 328       <li>
 329         <h3>Scanning - b - (read)</h3>
 330         <p>Determines if the interface is already scanning or not</p>
 331       </li>
 332
 333       <li>
 334         <h3>ApScan - u - (read/write)</h3>
 335         <p>Identical to ap_scan entry in %wpa_supplicant configuration file. Possible values are 0, 1 or 2.</p>
 336       </li>
 337
 338       <li>
 339         <h3>Ifname - s - (read)</h3>
 340         <p>Name of network interface controlled by the interface, e.g., wlan0.</p>
 341       </li>
 342
 343       <li>
 344         <h3>BridgeIfname - s - (read)</h3>
 345         <p>Name of bridge network interface controlled by the interface, e.g., br0.</p>
 346       </li>
 347
 348       <li>
 349         <h3>Driver - s - (read)</h3>
 350         <p>Name of driver used by the interface, e.g., nl80211.</p>
 351       </li>
 352
 353       <li>
 354         <h3>CurrentBSS - o - (read)</h3>
 355         <p>Path to D-Bus object representing BSS which %wpa_supplicant is associated with, or "/" if is not associated at all.</p>
 356       </li>
 357
 358       <li>
 359         <h3>CurrentNetwork - o - (read)</h3>
 360         <p>Path to D-Bus object representing configured network which %wpa_supplicant uses at the moment, or "/" if doesn't use any.</p>
 361       </li>
 362
 363       <li>
 364         <h3>Blobs - as - (read)</h3>
 365         <p>List of blobs names added to the Interface.</p>
 366       </li>
 367
 368       <li>
 369         <h3>BSSs - ao - (read)</h3>
 370         <p>List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.</p>
 371       </li>
 372
 373       <li>
 374         <h3>Networks - ao - (read)</h3>
 375         <p>List of D-Bus objects paths representing configured networks.</p>
 376       </li>
 377     </ul>
 378
 379 \subsection dbus_interface_signals Signals
 380
 381     <ul>
 382       <li>
 383         <h3>ScanDone ( b : success )</h3>
 384         <p>Scanning finished. </p>
 385         <h4>Arguments</h4>
 386         <dl>
 387           <dt>s : success</dt>
 388           <dd>Determines if scanning was successful. If so, results are available.</dd>
 389         </dl>
 390       </li>
 391
 392       <li>
 393         <h3>StateChanged ( s : newState, s : oldState )</h3>
 394         <p>Interface state has changed.</p>
 395         <h4>Arguments</h4>
 396         <dl>
 397           <dt>s : newState</dt>
 398           <dd>A state which the interface goes to</dd>
 399           <dt>s : oldState</dt>
 400           <dd>A state which the interface goes from</dd>
 401         </dl>
 402       </li>
 403
 404       <li>
 405         <h3>BSSAdded ( o : BSS )</h3>
 406         <p>Interface became aware of a new BSS.</p>
 407         <h4>Arguments</h4>
 408         <dl>
 409           <dt>o : BSS</dt>
 410           <dd>A D-Bus path to an object representing the new BSS.</dd>
 411         </dl>
 412       </li>
 413
 414       <li>
 415         <h3>BSSRemoved ( o : BSS )</h3>
 416         <p>BSS disappeared.</p>
 417         <h4>Arguments</h4>
 418         <dl>
 419           <dt>o : BSS</dt>
 420           <dd>A D-Bus path to an object representing the BSS.</dd>
 421         </dl>
 422       </li>
 423
 424       <li>
 425         <h3>BlobAdded ( s : blobName )</h3>
 426         <p>A new blob has been added to the interface.</p>
 427         <h4>Arguments</h4>
 428         <dl>
 429           <dt>s : blobName</dt>
 430           <dd>A name of the added blob.</dd>
 431         </dl>
 432       </li>
 433
 434       <li>
 435         <h3>BlobRemoved ( s : blobName )</h3>
 436         <p>A blob has been removed from the interface.</p>
 437         <h4>Arguments</h4>
 438         <dl>
 439           <dt>s : blobName</dt>
 440           <dd>A name of the removed blob.</dd>
 441         </dl>
 442       </li>
 443
 444       <li>
 445         <h3>NetworkAdded ( o : network )</h3>
 446         <p>A new network has been added to the interface.</p>
 447         <h4>Arguments</h4>
 448         <dl>
 449           <dt>o : network</dt>
 450           <dd>A D-Bus path to an object representing the added network.</dd>
 451         </dl>
 452       </li>
 453
 454       <li>
 455         <h3>NetworkRemoved ( o : network )</h3>
 456         <p>The network has been removed from the interface.</p>
 457         <h4>Arguments</h4>
 458         <dl>
 459           <dt>o : network</dt>
 460           <dd>A D-Bus path to an object representing the removed network.</dd>
 461         </dl>
 462       </li>
 463
 464       <li>
 465         <h3>NetworkSelected ( o : network )</h3>
 466         <p>The network has been selected.</p>
 467         <h4>Arguments</h4>
 468         <dl>
 469           <dt>o : network</dt>
 470           <dd>A D-Bus path to an object representing the selected network.</dd>
 471         </dl>
 472       </li>
 473
 474       <li>
 475         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 476         <p>Some properties have changed.</p>
 477         <h4>Arguments</h4>
 478         <dl>
 479           <dt>a{sv} : properties</dt>
 480           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ApScan", "Scanning", "CurrentBSS", "CurrentNetwork"</dd>
 481         </dl>
 482       </li>
 483     </ul>
 484
 485
 486 \section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS
 487
 488 Interface implemented by objects related to network interface added to
 489 &wpa_supplicant, i.e., returned by fi.w1.wpa_supplicant1.CreateInterface.
 490
 491 \subsection dbus_wps_methods Methods
 492
 493     <ul>
 494       <li>
 495         <h3>Start ( a{sv} : args ) --> a{sv} : output</h3>
 496         <p>Starts WPS configuration.</p>
 497         <h4>Arguments</h4>
 498         <dl>
 499           <dt>a{sv} : args</dt>
 500           <dd>
 501             A dictionary with arguments used to start WPS configuration. The dictionary may contain the following entries:
 502             <table>
 503               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 504               <tr><td>Role</td><td>s</td><td>The device's role. Possible values are "enrollee" and "registrar".</td><td>Yes</td>
 505               <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>
 506               <tr><td>Pin</td><td>s</td><td>WPS Pin.</td><td>Yes, for registrar role; otherwise optional</td>
 507               <tr><td>Bssid</td><td>ay</td><td></td><td>No</td>
 508             </table>
 509           </dd>
 510         </dl>
 511         <h4>Returns</h4>
 512         <dl>
 513           <dt>a{sv} : output</dt>
 514           <dd>
 515             <table>
 516               <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
 517               <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>
 518             </table>
 519           </dd>
 520         </dl>
 521         <h4>Possible errors</h4>
 522         <dl>
 523           <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
 524           <dd>Starting WPS configuration failed for an unknown reason.</dd>
 525           <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
 526           <dd>Invalid entries were found in the passed argument.</dd>
 527         </dl>
 528       </li>
 529     </ul>
 530
 531 \subsection dbus_wps_properties Properties
 532
 533     <ul>
 534       <li>
 535         <h3>ProcessCredentials - b - (read/write)</h3>
 536         <p>Determines if the interface will process the credentials (credentials_processed configuration file parameter).</p>
 537       </li>
 538     </ul>
 539
 540 \subsection dbus_wps_signals Signals
 541
 542     <ul>
 543       <li>
 544         <h3>Event ( s : name, a{sv} : args )</h3>
 545         <p>WPS event occurred.</p>
 546         <h4>Arguments</h4>
 547         <dl>
 548           <dt>s : event</dt>
 549           <dd>Event type. Possible values are: "success, "fail" and "m2d"</dd>
 550           <dt>a{sv} : args</dt>
 551           <dd>
 552             Event arguments. Empty for success event, one entry ( "msg" : i ) for fail event and following entries for m2d event:
 553             <table>
 554               <tr><th>config_methods</th><th>Value type</th>
 555               <tr><td>manufacturer</td><td>q</td>
 556               <tr><td>model_name</td><td>ay</td>
 557               <tr><td>model_number</td><td>ay</td>
 558               <tr><td>serial_number</td><td>ay</td>
 559               <tr><td>dev_name</td><td>ay</td>
 560               <tr><td>primary_dev_type</td><td>ay</td>
 561               <tr><td>config_error</td><td>q</td>
 562               <tr><td>dev_password_id</td><td>q</td>
 563             </table>
 564           </dd>
 565         </dl>
 566       </li>
 567
 568       <li>
 569         <h3>Credentials ( a{sv} : credentials )</h3>
 570         <p>WPS credentials. Dictionary contains:</p>
 571         <table>
 572           <tr><th>Key</th><th>Value type</th><th>Description</th>
 573           <tr><td>BSSID</td><td>ay</td><td></td>
 574           <tr><td>SSID</td><td>s</td><td></td>
 575           <tr><td>AuthType</td><td>as</td><td>Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk"</td>
 576           <tr><td>EncrType</td><td>as</td><td>Possible array elements: "none", "wep", "tkip", "aes"</td>
 577           <tr><td>Key</td><td>ay</td><td>Key data</td>
 578           <tr><td>KeyIndex</td><td>u</td><td>Key index</td>
 579         </table>
 580       </li>
 581
 582       <li>
 583         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 584         <p>Some properties have changed.</p>
 585         <h4>Arguments</h4>
 586         <dl>
 587           <dt>a{sv} : properties</dt>
 588           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ProcessCredentials"</dd>
 589         </dl>
 590       </li>
 591     </ul>
 592
 593
 594 \section dbus_bss fi.w1.wpa_supplicant1.Interface.BSS
 595
 596 Interface implemented by objects representing a scanned BSSs, i.e.,
 597 scan results.
 598
 599 \subsection dbus_bss_properties Properties
 600
 601     <ul>
 602       <li>
 603         <h3>BSSID - ay - (read)</h3>
 604         <p>BSSID of the BSS.</p>
 605       </li>
 606       <li>
 607         <h3>SSID - ay - (read)</h3>
 608         <p>SSID of the BSS.</p>
 609       </li>
 610       <li>
 611         <h3>WPAIE - ay - (read)</h3>
 612         <p>WPA information element of the BSS. The second byte contain number of bytes following it.</p>
 613       </li>
 614       <li>
 615         <h3>RSNIE - ay - (read)</h3>
 616         <p>RSN information element of the BSS. The second byte contain number of bytes following it.</p>
 617       </li>
 618       <li>
 619         <h3>WPSIE - ay - (read)</h3>
 620         <p>WPS information element of the BSS. The second byte contain number of bytes following it.</p>
 621       </li>
 622       <li>
 623         <h3>Privacy - b - (read)</h3>
 624         <p>Indicates if BSS supports privacy.</p>
 625       </li>
 626       <li>
 627         <h3>Mode - s - (read)</h3>
 628         <p>Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".</p>
 629       </li>
 630       <li>
 631         <h3>Frequency - q - (read)</h3>
 632         <p>Frequency of the BSS in MHz.</p>
 633       </li>
 634       <li>
 635         <h3>MaxRate - q - (read)</h3>
 636         <p>Maximal data rate of the BSS in bits per second.</p>
 637       </li>
 638       <li>
 639         <h3>Signal - n - (read)</h3>
 640         <p>Signal strength of the BSS.</p>
 641       </li>
 642     </ul>
 643
 644
 645 \section dbus_network fi.w1.wpa_supplicant1.Interface.Network
 646
 647 Interface implemented by objects representing configured networks,
 648 i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork.
 649
 650 \subsection dbus_network_properties Properties
 651
 652     <ul>
 653       <li>
 654         <h3>Enabled - b - (read/write)</h3>
 655         <p>Determines if the configured network is enabled or not.</p>
 656       </li>
 657
 658       <li>
 659         <h3>Properties - a{sv} - (read)</h3>
 660         <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.
 661       </li>
 662     </ul>
 663
 664 \subsection dbus_network_signals Signals
 665
 666     <ul>
 667       <li>
 668         <h3>PropertiesChanged ( a{sv} : properties )</h3>
 669         <p>Some properties have changed.</p>
 670         <h4>Arguments</h4>
 671         <dl>
 672           <dt>a{sv} : properties</dt>
 673           <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "Enabled"</dd>
 674         </dl>
 675       </li>
 676     </ul>
 677
 678 */