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
Copy file name to clipboardexpand all lines: docs/android_tweaks.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Android Tweaks
2
2
3
-
While OMNT should work without changes on the phone settings needed there are some options usefull to set for better measurement results.
3
+
While OMNT should work without changes on the phone settings needed there are some options useful to set for better measurement results.
4
4
5
5
## Developer Settings
6
-
The following settings can be found in the android developer settings menue. On Vanilla Android devices they are enabled by going to ```Settings -> About the phone``` and pressing there multiple times ```Build number```. If this is not working on your device a quick websearch with your phone name and ```developer settings``` should help. After enabeling the developer settings they are usually accessible via ```Settings -> System -> Developer Options```.
6
+
The following settings can be found in the android developer settings menu. On Vanilla Android devices they are enabled by going to ```Settings -> About the phone``` and pressing there multiple times ```Build number```. If this is not working on your device a quick web search with your phone name and ```developer settings``` should help. After enabling the developer settings they are usually accessible via ```Settings -> System -> Developer Options```.
7
7
* USB debugging: Install and debug apps via ADB
8
8
* Mobile data always active: Allows to gather mobile network information even if connected to WiFi
9
9
* Force full GNSS measurements: might improve GNSS accuracy while logging
Copy file name to clipboardexpand all lines: docs/carrier-permissions.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# SIM UICC configuration for Carrier Permissions
2
-
Carrier specific settings can only be accessed by apps running with so-called carrier privileges. This was added in android 6 and is mostly relevant for 4G and 5G networks. (https://source.android.com/devices/tech/config/carrier). These permissions also allow OMNT to talk to APIs restricted to system apps (apps that are shipped with your phone usually not removable). OMNT works with out these permissions but some features will be disbaled.
2
+
Carrier specific settings can only be accessed by apps running with so-called carrier privileges. This was added in android 6 and is mostly relevant for 4G and 5G networks. (https://source.android.com/devices/tech/config/carrier). These permissions also allow OMNT to talk to APIs restricted to system apps (apps that are shipped with your phone usually not removable). OMNT works with out these permissions but some features will be disabled.
3
3
4
4
Carrier or researcher who are able (admin key to the SIM card is required) to program their own sim cards can store a fingerprint of an signing certificate in an access rule applet (ARA-M) on the SIM card.
5
5
An app signed with this certificate will get carrier privileges granted by Android. (https://source.android.com/devices/tech/config/uicc)
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 differs from phone to phone. To alter the most relevant settings please see [Settings -> Mobile Network](settings/mobile_network.md).
Copy file name to clipboardexpand all lines: docs/home.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,30 @@
2
2
3
3
When starting the OMNT or touching the OMNT logo in the top left corner the home screen is displayed.
4
4
Here are all information the OMNT can collect displayed. Different cards grouped the data into categories.
5
-
The data displayed is updates on load and swipe down. This way the data of the time of refreash can be analyzed.
5
+
The data displayed is updates on load and swipe down. This way the data of the time of refresh can be analyzed.
6
6
The same grouping is applied to the data send to the InfluxDB.
7
7
8
8
## Cell Information
9
-
This card displays information from the Android [CellInfo API](https://developer.android.com/reference/android/telephony/CellInfo). The cell informations are on the cell the phone is camping on or registered to. If neighbourcells are present / announecd and display of neigbourcells is enabled in the settings they are displayed to. Information on neighbours cells are usualy limitted.
9
+
This card displays information from the Android [CellInfo API](https://developer.android.com/reference/android/telephony/CellInfo). The cell information are on the cell the phone is camping on or registered to. If neighbor cells are present / announced and display of neighbor cells is enabled in the settings they are displayed to. Information on neighbor cells are usually limited.
10
10
11
11
## Signal Strength Information
12
-
This card displays information from the Android [Signal Strength API](https://developer.android.com/reference/android/telephony/SignalStrength). Signal informations have less properties then the Cell info API but on some devices they seem to be more accurat / more often updated.
12
+
This card displays information from the Android [Signal Strength API](https://developer.android.com/reference/android/telephony/SignalStrength). Signal information have less properties then the Cell info API but on some devices they seem to be more accurate / more often updated.
13
13
14
14
## Network Information
15
15
This card presents the current network state of the phone. This includes the current mobile network registration as well as the default route, currently used access network and DNS.
16
16
17
17
18
18
## Device Information
19
-
This card displays information on the phone it self. This information only change on e.g. firmware updates. It is often helpfull to e.g. compare baseband versions between to phones to spot the cause for different behavior.
19
+
This card displays information on the phone it self. This information only change on e.g. firmware updates. It is often helpful to e.g. compare base band versions between to phones to spot the cause for different behavior.
20
20
21
21
## Device Features
22
-
This card displays the availablilty of some relevant APIs on the phone.
22
+
This card displays the availability of some relevant APIs on the phone.
23
23
24
24
## APP Permissions
25
25
This card displays the permissions granted to the OMNT.
26
26
27
27
## Network Interfaces
28
-
This card lists allnetwork interfaces of the UE and there current IP addresses.
28
+
This card lists all network interfaces of the UE and there current IP addresses.
29
29
30
30
## Location
31
31
This card shows the current location information provided to OMNT by Android.
Copy file name to clipboardexpand all lines: docs/influxdb.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# InfluxDB View
2
2
3
-
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.
3
+
This view allows the configuration of a locally (on the phone) running InfluxDB instance. This is currently still under development and should no be considered stable.
4
4
5
5
Configuration of logging and remote InfluxDB hosts can be found in [Settings -> Logging](settings/logging.md)
[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:
2
+
[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 enabled the results of the ICMP test are pushed to the InfluxDB and can be viewed in the dashboards. The most relevant KPIs gathered here are:
Copy file name to clipboardexpand all lines: docs/quick-start.md
+19-16
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,10 @@
2
2
3
3
This guide aims to bring you quickly to a working setup with InfluxDB and Grafana by using the cloud accounts. You will be able to store your measurements in an InfluxDB instance and visualize the data with our example dashboard in Grafana. This guide further assumes you have an Android phone with a compatible Android Version and you either already know how to build OMNT yourself or a release APK.
4
4
5
-
Note: If you run your own Grafana / InfluxDB you can jump ahead to #TODO
5
+
Note: If you run your own Grafana / InfluxDB you can jump ahead to [Setup OMNT](#setup-omnt).
6
+
If you want to setup Grafana and InfluxDB yourself checkout:
This guide assumes you will use the free cloud accounts of InfluxDB and Grafana. If you don't have accounts for both services:
@@ -17,22 +20,22 @@ The simplest way to install the app is by downloading it on the phone, if ADB is
17
20
18
21
adb install release.apk
19
22
20
-
or use android studio to build and install OMNT. Follow #TODO for more information on building the app.
23
+
or use android studio to build and install OMNT. Follow [build](build.md) for more information on building the app.
21
24
22
25
# Setup InfluxDB
23
-
Log into your influxDB account and hower over the top symbol in the right menue bar (below the influx logo), in now visible menu select ```buckets```. Click on the ```Create bucket``` button in the top right of the screen. You can name the bucket what ever you want e.g. ```omnt```.
26
+
Log into your influxDB account and hover over the top symbol in the right menu bar (below the influx logo), in now visible menu select ```buckets```. Click on the ```Create bucket``` button in the top right of the screen. You can name the bucket what ever you want e.g. ```omnt```.
24
27
25
-
Next click on the ```api tocken``` tab and create an API tocken. Again naming is up to you.
28
+
Next click on the ```api token``` tab and create an API token. Again naming is up to you.
26
29
For simplicity create an ```all access``` token.
27
30
Make sure to copy the token somewhere you find it later, it will not be shown again.
28
31
29
32
On the top of the window you see you organization, most likely something like ```dev```, write this down to.
30
33
31
-
The last information you need from influx is the url to your instance. It depence on the cloud zone you choose and will look e.g. like this ```https://eu-central-1-1.aws.cloud2.influxdata.com/```
34
+
The last information you need from influx is the url to your instance. It depends on the cloud zone you choose and will look e.g. like this ```https://eu-central-1-1.aws.cloud2.influxdata.com/```
32
35
33
36
# Setup Grafana
34
-
Log into your Grafna account and add a new datasource by selecting ```Connections``` and than ```add new datasource```. Now choose ```InfluxDB``` and click on ```add datasource```.
35
-
Name the datasource what ever you like. As our sample dashboards using Flux as querry language select ```flux``` from the dropdown menu. If you later develop you own dashboards you can also use InfluxQL or SQL on the same data.
37
+
Log into your Grafana account and add a new data source by selecting ```Connections``` and than ```add new data source```. Now choose ```InfluxDB``` and click on ```add data source```.
38
+
Name the data source what ever you like. As our sample dashboards using Flux as query language select ```flux``` from the dropdown menu. If you later develop you own dashboards you can also use InfluxQL or SQL on the same data.
36
39
37
40
Scroll down to ```InfluxDB Details``` and enter the information written down during the InfluxDB setup.
38
41
Click on ```Save & Test```
@@ -41,32 +44,32 @@ Now you can import the sample dashboards provided at https://github.com/omnt/Das
41
44
42
45
# Setup OMNT
43
46
## 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.
47
+
Now its time to open OMNT and configure its logging component. Touch the three dots in the right top corner to open the app menu. Select ```Settings``` and open the ```Logging``` setting page.
* Log battery information: include current battery and charging state in the log
66
69
* Log IP addresses: Include current IP addresses in the log
67
70
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.
71
+
If everything is set up you can now scroll up to the top of the logging settings and enable the logging system. If your phone has a internet connection the logging logo will tun green when data is successfully transmitted to the database.
69
72
70
-
You should now see the device and measurement selectable in the dashboards and graphs ans maps filling with datapoints.
73
+
You should now see the device and measurement selectable in the dashboards and graphs ans maps filling with data points.
* Enable: Start / Stop the logging component of OMNT. This effects all data logging targets, iPerf and Ping measurements and the Notification bar.
5
+
* Start on boot: Start OMNT and its logging component on device boot.
6
+
* Interval: Logging interval in milliseconds
7
+
* Enable Notification Update: Show current cell information in the notification area of android. This will wake up the screen and my raise power consumption.
8
+
9
+
## Local Logging
10
+
* InfluxDB log: This is work in progress and should allow the usage of a on device database
11
+
* Log file: Measurements a written to a file on the phones internal memory.
12
+
13
+
## Remote Logging
14
+
This section configured the remote logging function to an InfluxDB. This has been tested with on-prem InfluxDB 2.x installation
15
+
as well with InfluxDB 3.x cloud.
16
+
17
+
* InfluxDb Log: Enable the logging to remote database
18
+
* InfluxDB instance URL / IP: Address of the database e.g. ```https://example.com/influxd:443```
19
+
* Influx Organization: Either ID or Name of the Org to which the bucket and token belongs
20
+
* Influx Token: The InfluxDB API token to be used
21
+
* Influx Bucket: Name or ID of the bucket to be used
22
+
23
+
## Logging Content
24
+
Here the content of what data should be logged is configured. Note that this also affects all logging targets.
25
+
* User Fake location: This will replace the GNSS location with a static one. Mostly useful for developers.
26
+
* Measurement Name: This name will be used to identifier the measurement later on.
27
+
* Tags: This should at least have ```device=YourDevice``` as a tag. Further tags can be added comma separated.
28
+
* Log network information: log data displayed in the network information card on the home screen
29
+
* Log signal data: log data displayed in the signal info card on the home screen
30
+
* Log cell information: log data displayed in the cell information card on the home screen
31
+
* Log neighbor cells: include neighbor cells in the log
This section of the OMNT settings combines the mobile network related settings. OMNT needs carrier permissions to apply those settings.
3
+
Note that not all devices will silently ignore some of the settings.
2
4
3
-
[Home](../OpenMobileNetworkToolkit.md)
5
+
## Radio Settings
6
+
* Select Access Network Type: Limit the network types the modem will use a specific technology.
7
+
* Set PLMN: Force the modem to only attach to a specific PLMN and ignore other available cells.
8
+
* Persist until reboot: Make sure the setting will be applied after e.g. a SIM change until the next reboot
9
+
10
+
## Carrier Settings
11
+
While there are a lot more carrier settings part of a phone configuration not all relevant or even accessible. This section allows to configure the profile
12
+
applied for the selected subscription. OMNT will try to restore them after each network change event which mostly happens on SIM change, modem reboot and similar.
13
+
This section reflects the settings desired to be applied and not necessary the current state. To look at the current state please use the [Carrier Settings](../carrier_settings.md) View from the menu.
14
+
15
+
* Apply carrier settings now: This button will request the phone to apply the settings configured below to be applied.
16
+
17
+
The different settings are grouped by the android API level on which they where introduced and will be disabled if the phones runs an older version.
18
+
Details on the different settings can be found [here](https://developer.android.com/reference/android/telephony/CarrierConfigManager)
0 commit comments