diff options
| author | Jeff Davidson <jpd@google.com> | 2014-08-08 16:48:13 -0700 |
|---|---|---|
| committer | Jeff Davidson <jpd@google.com> | 2014-08-12 18:46:42 -0700 |
| commit | e4ce619880e831992b005c17dfabb7800994d0c7 (patch) | |
| tree | 9e398eb7976735b7f84091b98487ffe28c3a8a24 /wifi/java/android/net/wifi/ScanResult.java | |
| parent | f2546bf4235d0c875e9394986535febf068b6101 (diff) | |
| download | frameworks_base-e4ce619880e831992b005c17dfabb7800994d0c7.zip frameworks_base-e4ce619880e831992b005c17dfabb7800994d0c7.tar.gz frameworks_base-e4ce619880e831992b005c17dfabb7800994d0c7.tar.bz2 | |
Improve documentation of ScanResult and WifiInfo.
Valid dBm ranges should *not* be mentioned in the documentation.
Manufacturers should be able to produce devices which can detect
signal strengths with arbitrary sensitivity rather than being forced
to restrict strengths to a certain range.
Adds a reference to WifiManager.calculateSignalLevel(), an
often-useful method to convert these RSSI values into an absolute
signal level that can be displayed to a user as the signal strength.
Bug: 13731529
Change-Id: I0aae85a6d8bc48ffddd1927d816a1dfbf5230f7e
Diffstat (limited to 'wifi/java/android/net/wifi/ScanResult.java')
| -rw-r--r-- | wifi/java/android/net/wifi/ScanResult.java | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/wifi/java/android/net/wifi/ScanResult.java b/wifi/java/android/net/wifi/ScanResult.java index a561dc2..a01a6b6 100644 --- a/wifi/java/android/net/wifi/ScanResult.java +++ b/wifi/java/android/net/wifi/ScanResult.java @@ -18,8 +18,8 @@ package android.net.wifi; import android.net.wifi.passpoint.WifiPasspointInfo; import android.net.wifi.passpoint.WifiPasspointManager; -import android.os.Parcelable; import android.os.Parcel; +import android.os.Parcelable; /** * Describes information about a detected access point. In addition @@ -48,7 +48,10 @@ public class ScanResult implements Parcelable { */ public String capabilities; /** - * The detected signal level in dBm. + * The detected signal level in dBm, also known as the RSSI. + * + * <p>Use {@link android.net.wifi.WifiManager#calculateSignalLevel} to convert this number into + * an absolute signal level which can be displayed to a user. */ public int level; /** |