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