Skip to content

Commit b0e7d21

Browse files
PeterHassePeterHasse
committed
documentation update
1 parent 856e036 commit b0e7d21

20 files changed

+81
-13
lines changed

‎docs/OpenMobileNetworkToolkit.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# OpenMobileNetworkToolkit User Guide
22

33
* [Quick Start Guide](./quick-start.md)
4-
* [Installation]()
4+
* [Installation](installation.md)
55
* [SIM Card Setup for Carrier Permissions](./carrier-permissions.md)
6-
* [Android Tweeks]()
6+
* [Android Tweeks](android_tweaks.md)
77
* OMNT Usage
88
* [Home](./home.md)
99
* [iPerf3](./iperf3.md)

‎docs/android_tweaks.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,6 @@ The following settings can be found in the android developer settings menue. On
88
* Mobile data always active: Allows to gather mobile network information even if connected to WiFi
99
* Force full GNSS measurements: might improve GNSS accuracy while logging
1010

11-
Depending on your phone there might be more useful options (or less)
11+
Depending on your phone there might be more useful options (or less)
12+
13+
[Home](OpenMobileNetworkToolkit.md)

‎docs/carrier-permissions.md

+2
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,5 @@ aram_delete_all
3131
aram_store_ref_ar_do --aid ffffffffffff --device-app-id E849B63A7B96E571F788FC5845C4AA3C520D18E8 --android-permissions 0000000000000001
3232
```
3333
This assumes the credentials to access the card are stored in the pySim format.
34+
35+
[Home](OpenMobileNetworkToolkit.md)

‎docs/carrier_settings.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Carrier Settings View
22

3-
This view allows to read out and filter the current settings used by the phone for the currently used subscription. Those settings tell the phone how to behave in the specific network. This list of settings displayed here can be very long and differes from phone to phone. To alter the most relevant settings please see [Settings -> Mobile Network](settings/mobile_network.md).
3+
This view allows to read out and filter the current settings used by the phone for the currently used subscription. Those settings tell the phone how to behave in the specific network. This list of settings displayed here can be very long and differes from phone to phone. To alter the most relevant settings please see [Settings -> Mobile Network](settings/mobile_network.md).
4+
5+
[Home](OpenMobileNetworkToolkit.md)

‎docs/home.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,6 @@ This card displays the permissions granted to the OMNT.
2828
This card lists allnetwork interfaces of the UE and there current IP addresses.
2929

3030
## Location
31-
This card shows the current location information provided to OMNT by Android.
31+
This card shows the current location information provided to OMNT by Android.
32+
33+
[Home](OpenMobileNetworkToolkit.md)

‎docs/influxdb.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22

33
This view allows the configuration of a localy (on the phone) running InfluxDB instance. This is currenlty still under developement and should no be considered stable.
44

5-
Configuration of logging and remote InfluxDB hosts can be found in [Settings -> Logging](settings/logging.md)
5+
Configuration of logging and remote InfluxDB hosts can be found in [Settings -> Logging](settings/logging.md)
6+
7+
[Home](OpenMobileNetworkToolkit.md)

‎docs/installation.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Installation
2+
3+
[Home](OpenMobileNetworkToolkit.md)

‎docs/iperf3.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ iPerf3 has been compiled with a [JNI](https://developer.android.com/training/art
33
To see how to integrate iPerf3 into your app, look at [iPerf3 Repo](https://github.com/omnt/iperf)
44

55
![iPerf3](images/iperf3.png)
6+
7+
[Home](OpenMobileNetworkToolkit.md)

‎docs/ping.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
[ICMP](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol) allows a high level analysis of the current network conditions. The input field allows to enter the target IP address as well as options of the ICMP command. If logging is anabled the results of the ICMP test are puhsed to the InfluxDB and can be viewed in the dashbaords. The most relevant KPIs gathered here are:
33
* packet loss
44
* RTT round tripp time
5-
* jitter
5+
* jitter
6+
7+
[Home](OpenMobileNetworkToolkit.md)

‎docs/quick-start.md

+29-1
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,36 @@ Name the datasource what ever you like. As our sample dashboards using Flux as q
3737
Scroll down to ```InfluxDB Details``` and enter the information written down during the InfluxDB setup.
3838
Click on ```Save & Test```
3939

40+
Now you can import the sample dashboards provided at https://github.com/omnt/Dashboards .
41+
4042
# Setup OMNT
41-
Now its time to open OMNT and configure its logging component. Touch the three dots in the right top corner to open the app menue. Select ```Settings```
43+
## InfluxDB Settings
44+
Now its time to open OMNT and configure its logging component. Touch the three dots in the right top corner to open the app menue. Select ```Settings``` and open the ```Logging``` setting page.
4245

4346
<img align="right" src="images/influx_settings_credentials.png">
4447

48+
Fist scroll down to ```Remote logging``` here we configure the credentials for remote InfluxDB.
49+
1) Toggel the ```InfluxDB log``` switch.
50+
2) Copy the url you saved before to ```Influxdb instabnce URL/IP``` option.
51+
3) Copy the organization id to the ```InfluxDB Organization``` option.
52+
4) Copy the token to the ```Influx Token```
53+
5) Copy the bucket id to ```InfluxDB bucket```
54+
55+
## Logging Content
56+
Here we configure what data should be written to the database. Note that this also affects the logfile.
57+
* User Fake location: This will prevent you real location showing up in your logs. Mostly usefull for developpers.
58+
* Measurement Name: This name will be used to identifiy your measurement later on.
59+
* Tags: This should at least have ```device=YourDevice``` as a tag. Further tags can be added comma separated.
60+
* Log network information: log data displayed in the network information card on the home screen
61+
* Log signal data: log data displayed in the signal info card on the home screen
62+
* Log cell information: log data displayed in the cell information card on the home screen
63+
* Log neighbour cells: include neighbour cells in the log
64+
* Log throughput data: log interface throughput statistics
65+
* Log battery information: include current battery and charging state in the log
66+
* Log IP addresses: Include current IP addresses in the log
67+
68+
If everthing is set up you can now scrool up to the top of the logging settings and enable the logging system. If everthing is correct and your phone has a internet connection the logging logo will tun green.
69+
70+
You should now see the device and measurement selectable in the dashboards and graphs ans maps filling with datapoints.
71+
72+
[Home](OpenMobileNetworkToolkit.md)

‎docs/settings/logging.md

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# Logging Settings
2+
3+
[Home](../OpenMobileNetworkToolkit.md)

‎docs/settings/mobile_network.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Mobile Network
2+
3+
[Home](../OpenMobileNetworkToolkit.md)

‎docs/settings/reboot_modem.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Reboot Modem
2+
3+
[Home](../OpenMobileNetworkToolkit.md)

‎docs/settings/set_subscrption.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Set Subscription
2+
3+
[Home](../OpenMobileNetworkToolkit.md)

‎docs/settings/settings.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,6 @@ OMNT has a lot of settings which allow a customization of the app behavior and i
88
* [Logging](logging.md): Configuration of the logging system of OMNT
99
* [Mobile Network](mobile_network.md): Configure Carrier Settings an Mobile Network related options
1010
* [Set Subscription](set_subscrption.md): Choose the subscription to use
11-
* [Reboot Modem](reboot_modem.md): Reboot the modem of the phone
11+
* [Reboot Modem](reboot_modem.md): Reboot the modem of the phone
12+
13+
[Home](OpenMobileNetworkToolkit.md)

‎docs/signing.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ You can also manually re-sign the downloaded .apk file using [apksigner](https:/
1818
```shell
1919
apksigner sign --ks my.keystore OpenMobileNetworkToolkit.apk
2020
```
21-
where my.keystore is your java keystore.
21+
where my.keystore is your java keystore.
22+
23+
[Home](OpenMobileNetworkToolkit.md)

‎docs/slicing.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Network Slicing
22

33
This function is still under development and requires support from the core network.
4+
5+
[Home](OpenMobileNetworkToolkit.md)

‎docs/special_codes.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Special Codes View
22

3-
This view, if carrier permissions are granted, allows to send so called Secret or Special Codes via the dialer API. Those codes are mostly vendor specific or even device specific and either enable hidden features or open developer menues. If carrier permissions are not granted those codes can also be entered into the system dialer. Some vendors e.g. Samsung don't allow this in there custom dialer but its usualy possible to install the google dialer from playstore and make this the default dialer.
3+
This view, if carrier permissions are granted, allows to send so called Secret or Special Codes via the dialer API. Those codes are mostly vendor specific or even device specific and either enable hidden features or open developer menues. If carrier permissions are not granted those codes can also be entered into the system dialer. Some vendors e.g. Samsung don't allow this in there custom dialer but its usualy possible to install the google dialer from playstore and make this the default dialer.
4+
5+
[Home](OpenMobileNetworkToolkit.md)

‎docs/subscriptions.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
# Subscriptions View
2-
Subscriptions are profiles provided bei UICCs and eUICCS "SIMCARDs / eSIMprofiles" to the phone / baseband to connect to mobile networks. This View displays information on currently enable subscriptions.
2+
Subscriptions are profiles provided bei UICCs and eUICCS "SIMCARDs / eSIMprofiles" to the phone / baseband to connect to mobile networks. This View displays information on currently enable subscriptions.
3+
4+
[Home](OpenMobileNetworkToolkit.md)

‎docs/workprofile.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
# Workprofile View
2-
[Android Workprofile](https://support.google.com/work/android/answer/6191949?hl=en) allows to separate Apps into two different spaces. This view allows to create such an workprofile on the phone. The reasons this is in OMNT is that a Workprofile is neccessary on Android to use network slicing. But it might come handy for other usecases to.
2+
[Android Workprofile](https://support.google.com/work/android/answer/6191949?hl=en) allows to separate Apps into two different spaces. This view allows to create such an workprofile on the phone. The reasons this is in OMNT is that a Workprofile is neccessary on Android to use network slicing. But it might come handy for other usecases to.
3+
4+
[Home](OpenMobileNetworkToolkit.md)

0 commit comments

Comments
 (0)