From: Jouni Malinen <j@w1.fi>
Date: Sun, 28 Dec 2014 17:30:26 +0000 (+0200)
Subject: doc: Add D-Bus SignalPoll() method
X-Git-Tag: hostap_2_4~630
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a46652fe224f84a26666637ab05b58e7bb55c133;p=thirdparty%2Fhostap.git

doc: Add D-Bus SignalPoll() method

Commit 7a4a93b9593575ffd64ba72739429d98e4b90858 ('dbus: Add SignalPoll()
method to report current signal properties') added this method, but
forgot to document it.

Signed-off-by: Jouni Malinen <j@w1.fi>
---

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 86aee8bce..fffc2a549 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -443,6 +443,27 @@ fi.w1.wpa_supplicant1.CreateInterface.
 	  <dd>Reinit of the EAPOL state machine with the new PKCS #11 engine and module path failed.</dd>
 	</dl>
       </li>
+      <li>
+	<h3>SignalPoll ( ) --> a{sv} : properties</h3>
+	<p>Fetch signal properties for the current connection.</p>
+	<h4>Returns</h4>
+	<dl>
+	  <dt>a{sv} : properties</dt>
+	  <dd>
+	    <table>
+	      <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th>
+	      <tr><td>linkspeed</td><td>i</td><td>Link speed (Mbps)</td><td>No</td>
+	      <tr><td>noise</td><td>i</td><td>Noise (dBm)</td><td>No</td>
+	      <tr><td>width</td><td>s</td><td>Channel width</td><td>No</td>
+	      <tr><td>frequency</td><td>u</td><td>Frequency (MHz)</td><td>No</td>
+	      <tr><td>rssi</td><td>i</td><td>RSSI (dBm)</td><td>No</td>
+	      <tr><td>avg-rssi</td><td>i</td><td>Average RSSI (dBm)</td><td>No</td>
+	      <tr><td>center-frq1</td><td>i</td><td>VHT segment 1 frequency (MHz)</td><td>No</td>
+	      <tr><td>center-frq2</td><td>i</td><td>VHT segment 2 frequency (MHz)</td><td>No</td>
+	    </table>
+	  </dd>
+	</dl>
+      </li>
     </ul>
 
 \subsection dbus_interface_properties Properties