dbus.doxygen 21 KB

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