voussoir/trkpt
1
0
Fork 0
Code Issues Projects Releases Packages Activity

updated Readme & fastlane description

Browse source
This commit is contained in:
y20k 2020-02-15 20:03:19 +01:00
parent 12d7545755
commit 837b6f4e4f
No known key found for this signature in database
GPG key ID: 824D4259F41FAFF6
2 changed files with 33 additions and 71 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -1,13 +1,11 @@
README README
====== ======
# Trackbook - Movement Recorder for Android # Trackbook - Android Movement Recorder
<img src="https://raw.githubusercontent.com/y20k/trackbook/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" width="192" /> <img src="https://raw.githubusercontent.com/y20k/trackbook/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" width="192" />
**Version 2.0.x ("Echoes")** **Version 2.0.x ("Echoes")**
**Please note: Trackbook is currently being completely re-written in Kotlin. No line of code is left unchanged. The process is not finished yet.**
Trackbook is a bare bones app for recording your movements. Trackbook is great for hiking, vacation or workout. Once started it traces your movements on a map. The map data is provided by [OpenStreetMap (OSM)](https://www.openstreetmap.org/). Trackbook is a bare bones app for recording your movements. Trackbook is great for hiking, vacation or workout. Once started it traces your movements on a map. The map data is provided by [OpenStreetMap (OSM)](https://www.openstreetmap.org/).
Trackbook is free software. It is published under the [MIT open source license](https://opensource.org/licenses/MIT). Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid) to display the map, which is also free software published under the [Apache License](https://github.com/osmdroid/osmdroid/blob/master/LICENSE). Want to help? Please check out the notes in [CONTRIBUTE.md](https://github.com/y20k/trackbook/blob/master/CONTRIBUTE.md) first. Trackbook is free software. It is published under the [MIT open source license](https://opensource.org/licenses/MIT). Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid) to display the map, which is also free software published under the [Apache License](https://github.com/osmdroid/osmdroid/blob/master/LICENSE). Want to help? Please check out the notes in [CONTRIBUTE.md](https://github.com/y20k/trackbook/blob/master/CONTRIBUTE.md) first.
@ -19,48 +17,30 @@ You can install it via Google Play and F-Droid - or you can go and grab the late
[<img src="https://cloud.githubusercontent.com/assets/9103935/14702535/45f6326a-07ab-11e6-9256-469c1dd51c22.png" width="192">](https://f-droid.org/repository/browse/?fdid=org.y20k.trackbook) [<img src="https://cloud.githubusercontent.com/assets/9103935/14702535/45f6326a-07ab-11e6-9256-469c1dd51c22.png" width="192">](https://f-droid.org/repository/browse/?fdid=org.y20k.trackbook)
## How to use Trackbook ## Good To Know
### Start recording movements ### Start Recording via Quick Settings Tile
Press the big blue button to start recording your movements. Trackbook will continuously drop markers onto the map. You can start a recording without opening Trackbook. Just pull down the System's Quick Settings and tap on the Start Recording tile. You need to manually add Trackbook's Recording tile to Quick Settings first. You can find information on customizing Quick Settings [here](https://support.google.com/android/answer/9083864?hl=en) and [here](https://www.xda-developers.com/get-custom-quick-settings-tiles/)
### Stop recording movements ### Save Recordings as GPX
To stop your recording press the big blue button again or use the stop button in the Trackbook's notification. You can look at the recorded movements on the map afterwards. Recordings can be exported as GPX ([GPS Exchange Format](https://en.wikipedia.org/wiki/GPS_Exchange_Format)). Tap on the save button in the lower right corner when viewing a previosly recorded track.
### Save last recording ### Copy GPX Files Manually
Stop the recording and then tap again on the big blue button. It will offer an option to "Save and Clear". Trackbook stores saved recordings as plaintext JSON files in the directory `/Android/data/org.y20k.trackbook/files/tracks`. Trackbook automacally generates GPX files for every recording. You can find them in the folder `/Android/data/org.y20k.trackbook/files/gpx/` on your device's storage.
### Clear main map ### How Does Trackbook Measure Distance?
Stop the recording and then tap again on the big blue button. Chose the option "Clear", if you just want to clear the map without saving your recording.
### Statistics and Last Tracks
Peek into Trackbook's notification to see the distance and duration of your current recording. Switch to the "Last Tracks" view to review your last recordings - up to 25 tracks. Pull up the statistics to see distance and duration of that recording, as well as the steps taken.
### GPX Export
Saved recordings can be exported as GPX ([GPS Exchange Format](https://en.wikipedia.org/wiki/GPS_Exchange_Format)) from the "Last Tracks" view. Just tap the export icon next to the track selection menu.
### How does Trackbook measure distance?
Trackbook calculates the distance between markers and adds them up. Trackbook calculates the distance between markers and adds them up.
## A word on privacy ### How Does Transistor Measure Altitude?
Many devices have altitude sensors (of varying accuracy). Trackbook compares the altitude of each new marker with the previously stored altitude. The difference is added to either the uphill or downhill elevation value.
Trackbook begins to store location data on device as soon a user presses the record button. Those recordings are stored in the directory `/Android/data/org.y20k.trackbook/files/tracks`. They never leave the device. There is no web-service backing Trackbook. ### What Does Accuracy Threshold Mean?
Every location fix, that Trackbook receives, is associated with an accuracy estimate. You can look up, how Android defines accuracy, in the [developer documentation](https://developer.android.com/reference/kotlin/android/location/Location.html#getaccuracy). `Accuracy Threshold` is the value, from which on location fixes are rejected. It can be adjusted in Trackbook's settings. You can increase the value, if your recordings tend to be incomplete. Trackbook will then also record less accurate location fixes.
Trackbook does not use Google Play Services to get its location data. It will however try to use data from the [NETWORK_PROVIDER](https://developer.android.com/reference/android/location/LocationManager#NETWORK_PROVIDER) on your device to augment the location data it received via GPS. The NETWORK_PROVIDER is a system-wide service, that Trackbook has no control over whatsoever. This service will usually query an online database for the location of cell towers or Wi-Fi access points a device can see. You can prevent those kinds of requests on your device, if you set the location preferences system-wide to `Device Only`. ## A Word on Privacy
Trackbook begins to store location data on device as soon a user presses the record button. Those recordings are stored in the directory `/Android/data/org.y20k.trackbook/files/`. They never leave the device. There is no web-service backing Trackbook.
## Which permissions does Trackbook need? Trackbook does not use Google Play Services to get its location data. It will however try to use data from the [NETWORK_PROVIDER](https://developer.android.com/reference/android/location/LocationManager#NETWORK_PROVIDER) on your device to augment the location data it received via GPS. The NETWORK_PROVIDER is a system-wide service, that Trackbook has no control over. This service will usually query an online database for the location of cell towers or Wi-Fi access points a device can see. You can prevent those kinds of requests on your device, if you set the location preferences system-wide to `Device Only`. Additionally Trackbook has a Setting `Restrict to GPS`
### Permission "INTERNET"
Trackbook needs to download map data from OpenStreetMap servers and therefore needs access to the internet.
### Permission "ACCESS\_NETWORK\_STATE" and "ACCESS\_WIFI\_STATE"
Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid/) to draw its maps. osmdroid needs to know the current state of your device’s connectivity - see [Prerequisites](https://github.com/osmdroid/osmdroid/wiki/Prerequisites).
### Permission "ACCESS\_COARSE\_LOCATION" and "ACCESS\_FINE\_LOCATION"
Trackbook needs accurate GPS location data to be able to record your movements. If the GPS data is not available or not accurate enough Trackbook uses location data from cell tower and WiFi triangulation.
### Permission "VIBRATE"
Tapping and holding some controls will toggle a tiny vibration (force feedback).
## Screenshots (v1.1) ## Screenshots (v1.1)
[<img src="https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p1.png" width="240">](https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p1.png) [<img src="https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p1.png" width="240">](https://raw.githubusercontent.com/y20k/trackbook/master/metadata/en-US/phoneScreenshots/p1.png)

52
metadata/en-US/full_description.txt
View file

@ -2,49 +2,31 @@ Trackbook is a bare bones app for recording your movements. Trackbook is great f
Trackbook is free software. It is published under the MIT open source license. Trackbook uses osmdroid to display the map, which is also free software published under the Apache License. Trackbook is free software. It is published under the MIT open source license. Trackbook uses osmdroid to display the map, which is also free software published under the Apache License.
GOOD TO KNOW
------------
HOW TO USE TRACKBOOK START RECORDING VIA QUICK SETTINGS TILE
-------------------- You can start a recording without opening Trackbook. Just pull down the System's Quick Settings and tap on the Start Recording tile. You need to manually add Trackbook's Recording tile to Quick Settings first. Information on customizing Quick Settings:
https://support.google.com/android/answer/9083864?hl=en
https://www.xda-developers.com/get-custom-quick-settings-tiles/
START RECORDING MOVEMENTS SAVE RECORDINGS AS GPX
Press the big blue button to start recording your movements. Trackbook will continuously drop markers onto the map. Recordings can be exported as GPX (GPS Exchange Format). Tap on the save button in the lower right corner when viewing a previosly recorded track.
STOP RECORDING MOVEMENTS COPY GPX FILES MANUALLY
To stop your recording press the big blue button again or use the stop button in the Trackbook's notification. You can look at the recorded movements on the map afterwards. Trackbook automacally generates GPX files for every recording. You can find them in the folder /Android/data/org.y20k.trackbook/files/gpx/ on your device's storage.
SAVE LAST RECORDING
Stop the recording and then tap again on the big blue button. It will offer an option to "Save and Clear". Trackbook stores saved recordings as plaintext JSON files in the directory /Android/data/org.y20k.trackbook/files/tracks.
CLEAR MAIN MAP
Stop the recording and then tap again on the big blue button. Chose the option "Clear", if you just want to clear the map without saving your recording.
STATISTICS AND LAST TRACKS
Peek into Trackbook's notification to see the distance and duration of your current recording. Switch to the "Last Tracks" view to review your last recordings - up to 25 tracks. Pull up the statistics to see distance and duration of that recording, as well as the steps taken.
GPX EXPORT
Saved recordings can be exported as GPX (GPS Exchange Format) from the "Last Tracks" view. Just tap the share icon next to the track selection menu.
HOW DOES TRACKBOOK MEASURE DISTANCE? HOW DOES TRACKBOOK MEASURE DISTANCE?
Trackbook calculates the distance between markers and adds them up. Trackbook calculates the distance between markers and adds them up.
HOW DOES TRANSISTOR MEASURE ALTITUDE?
Many devices have altitude sensors (of varying accuracy). Trackbook compares the altitude of each new marker with the previously stored altitude. The difference is added to either the uphill or downhill elevation value.
WHAT DOES ACCURACY THRESHOLD MEAN?
Every location fix, that Trackbook receives, is associated with an accuracy estimate. You can look up, how Android defines accuracy, in the [developer documentation](https://developer.android.com/reference/kotlin/android/location/Location.html#getaccuracy). `Accuracy Threshold` is the value, from which on location fixes are rejected. It can be adjusted in Trackbook's settings. You can increase the value, if your recordings tend to be incomplete. Trackbook will then also record less accurate location fixes.
A WORD ON PRIVACY A WORD ON PRIVACY
----------------- -----------------
Trackbook begins to store location data on device as soon a user presses the record button. Those recordings are stored in the directory /Android/data/org.y20k.trackbook/files/tracks. They never leave the device. There is no web-service backing Trackbook. Trackbook begins to store location data on device as soon a user presses the record button. Those recordings are stored in the directory /Android/data/org.y20k.trackbook/files/. They never leave the device. There is no web-service backing Trackbook.
Trackook does not use Google Play Services to get its location data. It will however try to use data from the NETWORK_PROVIDER on your device to augment the location data it received via GPS. The NETWORK_PROVIDER is a system-wide service, that Trackbook has no control over whatsoever. This service will usually query an online database for the location of cell towers or Wi-Fi access points a device can see. You can prevent those kinds of requests on your device, if you set the location preferences system-wide to "Device Only". Trackbook does not use Google Play Services to get its location data. It will however try to use data from the NETWORK_PROVIDER on your device to augment the location data it received via GPS. The NETWORK_PROVIDER is a system-wide service, that Trackbook has no control over. This service will usually query an online database for the location of cell towers or Wi-Fi access points a device can see. You can prevent those kinds of requests on your device, if you set the location preferences system-wide to `Device Only`. Additionally Trackbook has a Setting `Restrict to GPS`
WHICH PERMISSIONS DOES TRACKBOOK NEED?
--------------------------------------
Permission "INTERNET"
Trackbook needs to download map data from OpenStreetMap servers and therefore needs access to the internet.
Permission "ACCESS_NETWORK_STATE" and "ACCESS_WIFI_STATE"
Trackbook uses [osmdroid](https://github.com/osmdroid/osmdroid/) to draw its maps. osmdroid needs to know the current state of your device’s connectivity - see [Prerequisites](https://github.com/osmdroid/osmdroid/wiki/Prerequisites).
Permission "ACCESS_COARSE_LOCATION" and "ACCESS_FINE_LOCATION"
Trackbook needs accurate GPS location data to be able to record your movements. If the GPS data is not available or not accurate enough Trackbook uses location data from cell tower and WiFi triangulation.
Permission "VIBRATE"
Tapping and holding some controls will toggle a tiny vibration (force feedback).