xref: /aosp_15_r20/developers/build/prebuilts/gradle/WifiRttScan/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid WifiRttScan Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiSample demonstrates best practices for using WifiRTT APIs in Android. Also, this is a a useful
6*d353a188SXin Liapplication for testing Wifi-RTT enabled phones and access points and validating the estimated
7*d353a188SXin Lidistance is close to the actual distance between them.
8*d353a188SXin Li
9*d353a188SXin LiIntroduction
10*d353a188SXin Li------------
11*d353a188SXin Li
12*d353a188SXin LiSteps for trying out the sample:
13*d353a188SXin Li* Compile and install the mobile app onto your mobile device (for mobile scenario).
14*d353a188SXin Li
15*d353a188SXin LiThis sample demonstrates best practices for using the WifiRtt APIs in Android. The main activity
16*d353a188SXin Lilists all access points that are WifiRtt enabled using the [WifiManager][1]. By clicking on one of
17*d353a188SXin Lithe access points, another activity will launch and initiate [RangingRequest][2] via the
18*d353a188SXin Li[WifiRttManager][3]. The activity will display many of the details returned from the access point
19*d353a188SXin Liincluding the distance between the access point and the phone.
20*d353a188SXin Li
21*d353a188SXin Li[1]: https://developer.android.com/reference/android/net/wifi/WifiManager
22*d353a188SXin Li[2]: https://developer.android.com/reference/android/net/wifi/rtt/RangingRequest
23*d353a188SXin Li[3]: https://developer.android.com/reference/android/net/wifi/rtt/WifiRttManager
24*d353a188SXin Li
25*d353a188SXin LiPre-requisites
26*d353a188SXin Li--------------
27*d353a188SXin Li
28*d353a188SXin Li- Android SDK 28
29*d353a188SXin Li- Android Build Tools v27.0.3
30*d353a188SXin Li- Android Support Repository
31*d353a188SXin Li
32*d353a188SXin LiScreenshots
33*d353a188SXin Li-------------
34*d353a188SXin Li
35*d353a188SXin Li<img src="screenshots/main1.png" height="400" alt="Screenshot"/> <img src="screenshots/main2.png" height="400" alt="Screenshot"/> <img src="screenshots/main3.png" height="400" alt="Screenshot"/>
36*d353a188SXin Li
37*d353a188SXin LiGetting Started
38*d353a188SXin Li---------------
39*d353a188SXin Li
40*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
41*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
42*d353a188SXin Li
43*d353a188SXin LiSupport
44*d353a188SXin Li-------
45*d353a188SXin Li
46*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
47*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
48*d353a188SXin Li
49*d353a188SXin LiIf you've found an error in this sample, please file an issue:
50*d353a188SXin Lihttps://github.com/googlesamples/android-WifiRttScan
51*d353a188SXin Li
52*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
53*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
54*d353a188SXin Li
55*d353a188SXin LiLicense
56*d353a188SXin Li-------
57*d353a188SXin LiLicensed under an Apache 2.0 license. See LICENSE file for details.
58*d353a188SXin Li
59