Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/m-lab/ndt7-client-android-java

Java NDT7 client for Android OS
https://github.com/m-lab/ndt7-client-android-java

Last synced: about 1 month ago
JSON representation

Java NDT7 client for Android OS

Awesome Lists containing this project

README 

        
# ndt7-java



Java community-supported implementation of the

[NDT7 protocol by M-Lab](https://github.com/m-lab/ndt-server/blob/master/spec/ndt7-protocol.md).



# How it works



Consumers wishing to use the NDT7 speed test should:

- Build this project running `./gradlew assemble`

- Copy the AAR files generated in `libdnt7/build/outputs/aar` into their `libs`

  app folder

- Add the following dependencies in the consumer app's `build.gradle` file:

  - `debugImplementation

    "net.measurementlab.ndt7.android:libndt7-debug:$libndt7_version@aar"`

  - `releaseImplementation

    "net.measurementlab.ndt7.android:libndt7-release:$libndt7_version@aar"`

- Create a subclass of type `NDTTest` and override the functions that it exposes



Instrumented tests can be ran using the following Gradle task `./gradlew

connectedAndroidTest`. For running instrumented tests on a Docker image, the

following commands can be used:

```

docker build -t local-android .

docker run --rm  -it local-android bash -c "adb start-server & sleep 15 ; \

     emulator -avd first_avd -no-audio -no-boot-anim -gpu off -no-window & sleep 90; \

    ./gradlew build; sleep 10; \

    ./gradlew connectedAndroidTest"

```



--------------------------------------------------------------------------------



```

    public void onMeasurementDownloadProgress(Measurement measurement) {

    }

```



Returns Measurement information during the download speed test. You can look at

the Measurement data class to understand what this will provide. If you are

purely interested in download speed, you don't need to override this.



--------------------------------------------------------------------------------



```

    public void onMeasurementUploadProgress(Measurement measurement) {

    }

```



Returns Measurement information during the upload speed test. You can look at

the Measurement data class to understand what this will provide. If you are

purely interested in upload speed, you don't need to override this



--------------------------------------------------------------------------------



```

    public void onDownloadProgress(ClientResponse clientResponse) {

    }

```



This returns the ElapsedTime and NumBytes during the download test. ElapsedTime

is in *microseconds*. To ease data transformation into the commonly used `mbps`,

we expose a static class that assists with the calculations

`DataConverter.convertToMbps(clientResponse) will generate a String that

represents the speed in mbps. Note this is mega*BITS* per second.



--------------------------------------------------------------------------------



```

    public void onUploadProgress(ClientResponse clientResponse) {

    }

```



This returns the ElapsedTime and NumBytes during the upload test. ElapsedTime is

in *microseconds*. To ease data transformation into the commonly used `mbps`, we

expose a static class that assists with the calculations

`DataConverter.convertToMbps(clientResponse) will generate a String that

represents the speed in mbps. Note this is mega*BITS* per second.



--------------------------------------------------------------------------------



```

    public void onFinished(

        ClientResponse clientResponse, 

        Throwable error, 

        TestType testType

    ) {

    }

```



This will be called when a speed test is finished. It includes the type of test.

If you run both an upload and download test, this will be fired twice. Once with

download results and once with the upload results. You should also check the

`error` is null. The reason for this is to allow the consumer to determine if

they wish to use the results. The test may run for 9/10 seconds and then error.

The consumer may believe that the results are accurate enough to use. Error will

be null if the test completed successfully. Otherwise, it is up to the consumer

to determine if they wish to run another scan or if they believe the partial

results are acceptable