You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
LCL Network Measurement Tool is an Android App that measures a variety of network metrics, including but not limited to *ping*, *upload/download* speed, *signal strength*.
3
+
**Warning: This doc is outdated! Will update once the kotlin integration is complete.**
4
+
5
+
**LCL Network Measurement Tool** is an Android App that measures a variety of network metrics, including but not limited to *ping*, *upload/download* speed, *signal strength*.
6
+
It also automatically uploads the testing results to the backend server, which will then be displayed on [our coverage map](https://coverage.seattlecommunitynetwork.org/).
7
+
8
+
## Project Structure
9
+
```
10
+
app/src/main/java
11
+
└── com
12
+
└── lcl
13
+
└── lclmeasurementtool
14
+
├── Utils
15
+
├── Receivers
16
+
├── Models
17
+
├── Managers
18
+
├── Functionality
19
+
├── Database
20
+
│ ├── Entity
21
+
│ └── DB
22
+
└── Constants
23
+
```
24
+
25
+
In each sub-directory, there is a README file explaining the module.
26
+
27
+
28
+
## Building, Running, and Installing the project
29
+
### Prerequisite
30
+
* We use Android Studio for development. Download the latest version of Android Studio [here](https://developer.android.com/studio).
31
+
* Android SDK 30 (make sure you have SDK version 30 or above)
32
+
* Android NDK (Download the latest NDK either from Android's website or in Android Studio)
33
+
* Android Emulator
34
+
* Git
35
+
36
+
### Managing SDK, NDK, and Emulators
37
+
Android Studio has tools to help manage the SDK, NDK, and Emulators resources.
Finally, click `OK` and wait for these tools to be installed.
52
+
53
+
#### Emulators
54
+
If you do not have a Andriod Phone, you can install emulators to run the app. Click the `Device Manager` button in the middle. Then click `Create device`.
55
+
Select a phone target (we recommend using Pixel 4). Then select your system image, which should match your API level. Finally click `Finish` and wait for the emulator to be created.
For more information, visit [Android Developer Website](https://developer.android.com/studio/releases/platforms)
59
+
60
+
### Building, Running and Debugging the Code
61
+
Android Studio provides out-of-box build tool and debugger to help build, run, and debug.
62
+
63
+
#### Open the project
64
+
* In order to build the code, clone this project repo to your working folder
65
+
* using HTTPS: `$ git clone https://github.com/Local-Connectivity-Lab/lcl_measurement_tool.git`
66
+
* using SSH if you have set it up: `$ [email protected]:Local-Connectivity-Lab/lcl_measurement_tool.git`
67
+
*`cd` into the directory `lcl_measurement_tool` and change the branch from `main` to `develop` to view the latest codebase `$ git checkout dev`
68
+
* Open the project using Android Studio. Wait for Android Studio to automatically install Gradle and other dependencies used by the project.
69
+
* Under the top-level directory of this project, where this README.md lives, create a new file `iperfkey.properties` and ask either Esther Jang or Zhennan Zhou for the keys.
70
+
71
+
#### Building the project
72
+
* On the top menu bar, find the `Build -> Clean Project` to remove any previous build. Then `Build -> Rebuild Project`.
73
+
*[Optional] On the bottom menu bar, find the Build Panel and view the Build process.
74
+
75
+
#### Running/Debugging the project
76
+
After building the project, we can use Android Studio's "Play" button in the toolbar to run the project on an actual Android phone or in the Emulator of your choice.
77
+
If you need to debug the code, add breakpoints and then click the `bug` button in the toolbar. Android Studio will pop up a debugger attached to the process.
78
+
 Make sure the target shows as `app`.
79
+
80
+
#### Profiling and Inspection
81
+
If you need to inspect the network packet or checking the app's running state, you can use Android Studio's built-in profiler located at the bottom toolbar.
82
+
Make sure you open the profiler when the app is running. To inspect the database, using the App Inspection tool located at the bottom toolbar.
83
+
84
+
85
+
## Contributing to the Project
86
+
We are excited to work alongside you, our amazing community, to build and enhance this measurement tool! If you want to contribute to this project, contact Esther Jang(infared) or Zhennan Zhou(Johnnnzhou) in our Discord channel.
87
+
88
+
### Getting involved with Seattle Community Networks Team
89
+
If you are interested in contributing to the community, visit our [website](https://seattlecommunitynetwork.org/), join our [Discord channel](https://discord.gg/sZkK5RpeCE),
90
+
and follow us on social media: [Instagram](https://instagram.com/seattlecommnet), [Facebook](https://facebook.com/seattlecommnet), and [Twitter](https://twitter.com/seattlecommnet).
91
+
92
+
For more information, visit our [Get Started Pro Tips](https://docs.seattlecommunitynetwork.org/get-started.html).
// Required when setting minSdkVersion to 20 or lower according to <link>https://developer.android.com/studio/write/java8-support#library-desugaring</link>
0 commit comments