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: aat-android/src/main/assets/documentation/manual.html
+84-23Lines changed: 84 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,35 @@ <h1>Getting started with the UI</h1>
2
2
3
3
<h2>Main view</h2>
4
4
5
-
<p>When starting AAT the first time it shows the <strong>main view</strong> with a list of sub-views you can open. The first 3 entries are <strong>"Cockpit A, Cockpit B, and Map"</strong> if you have one of these open you can cycle through them with the down arrow. The right arrow switches trough the different pages of the view.</p>
5
+
<p>When starting <strong>AAT-Android</strong> the first time it shows the <strong>main view</strong> with a list of sub-views you can open. </p>
6
+
7
+
<p>The first 3 entries are <strong>"Cockpit A, Cockpit B, and Map"</strong>. </p>
8
+
9
+
<p>Use the right arrow to switch trough the different pages of the view.</p>
6
10
7
11
<h2>Map view (and full screen map)</h2>
8
12
9
-
<p><strong>Tap the edges of the map view, to get extra functionality</strong>. <br>
10
-
Top edge: Cycle trough cockpit views. <br>
11
-
Left edge: Edit current track or <code>draft.gpx</code>. <br>
12
-
Right edge: Configure map, select grid, map search, import/export of center location. <br>
13
-
Bottom edge: Zoom in and out, lock to current position, frame tracks. </p>
13
+
<p><strong>Tap the edges of the map view, to get extra functionality</strong>:</p>
14
+
15
+
<ul>
16
+
<li>Top edge: Cycle trough cockpit views.</li>
17
+
<li>Left edge: Edit current track or <code>draft.gpx</code>.</li>
18
+
<li>Right edge: Configure map, select grid, map search, import/export of center location.</li>
19
+
<li>Bottom edge: Zoom in and out, lock to current position, frame tracks.</li>
20
+
</ul>
14
21
15
22
<h2>Display recorded track</h2>
16
23
17
-
<p>Once you have stopped the tracker go back to the <strong>main view</strong> with your phones back button. Then select <strong>Track list</strong> to show a list of all recorded GPX tracks. Every track has a preview image if you tap on this image, you'll get a context menu for this GPX-file. <em>Here you can for example select this track for one of the 4 overlay slots.</em> You can display any recorded track by taping the text area of the list entry. (Always go back to the list with the phones back button). In the track view there are again different pages (graph, summary and map) and you can cycle trough all tracks with the up and down arrow.</p>
24
+
<p>Once you have stopped the tracker go back to the <strong>main view</strong> with your phones back button.
25
+
Then select <strong>Track list</strong> to show a list of all recorded GPX tracks. </p>
26
+
27
+
<p>Every track has a preview image if you tap on this image, you'll get a context menu for this GPX-file.
28
+
<em>Here you can for example select this track for one of the 4 overlay slots.</em></p>
29
+
30
+
<p>You can display any recorded track by taping the text area of the list entry.
31
+
(Always go back to the list with the phones back button). </p>
32
+
33
+
<p>In the track view there are again different pages (graph, summary and map) and you can cycle trough all tracks with the up and down arrow.</p>
18
34
19
35
<p>There are different pages in the <strong>Track list</strong> view (Access them with < … > ). These pages offer <strong>a map as an alternative to the track list</strong>, <strong>summary information</strong> and <strong>filter options</strong>.</p>
20
36
@@ -49,16 +65,27 @@ <h2>OpenAndroMaps step by step</h2>
49
65
50
66
<h1>Where to find files?</h1>
51
67
52
-
<p>AAT lets you create and view files in GPX format. These files are exchangeable with many other applications. They can also be edited in a text editor.
53
-
These and other files are stored in subdirectories of the data directory. You can choose the location of the data directory from the settings.
54
-
The structure of the data directory is as follows: </p>
68
+
<p>AAT lets you create and view files in GPX format. These files are exchangeable with many other applications.
69
+
They can also be edited in a text editor.
70
+
These and other files are stored in subdirectories of the data directory. </p>
71
+
72
+
<p>Storing data in <code>/aat_data</code> is preferred by AAT. This needs special permission but makes it easier to access and share files.</p>
73
+
74
+
<p>With limited permission <strong>AAT-Android</strong> will store files in <code>/Android/data/ch.bailu.aat/</code> which is private space for the application and a standard on Android. This is also managed somehow by Android <em>which means that files there are getting deleted when uninstalling AAT</em>.</p>
75
+
76
+
<p>On <strong>AAT-GTK</strong> the location of the data directory is either <code>~/aat_data</code> or <code>~/.config/aat-gtk</code>.</p>
77
+
78
+
<p>You can choose any location for the data directory in the preferences: <code>Preferences->General/System/Data directory</code>.</p>
79
+
80
+
<p>The structure (subdirectories) of the data directory is as follows: </p>
<li><code>aat_data/log</code> : activity that gets tracked at the moment</li>
85
+
<li><code>aat_data/query</code> : search results from OSM-Nominatim, OSM-Overpass and offline POI </li>
86
+
<li><code>aat_data/overlay</code> : GPX-files that can be used as overlays: Routes, way-points, search results…</li>
87
+
<li><code>aat_data/dem3</code> : cached <ahref="https://bailu.ch/dem3/">Digital elevation data files </a></li>
88
+
<li><code>aat_data/maps</code> : alternative location for offline maps</li>
62
89
</ul>
63
90
64
91
<h1>Calculating calories</h1>
@@ -67,25 +94,59 @@ <h1>Calculating calories</h1>
67
94
MET stands for <ahref="https://en.wikipedia.org/wiki/Metabolic_equivalent">metabolic equivalent</a>. The higher the value, the more energy you would use
68
95
for this specific activity. A complete list of activities and MET values can be found <ahref="https://sites.google.com/site/compendiumofphysicalactivities/Activity-Categories">here</a>.</p>
69
96
70
-
<p>Both MET and weight can be provided in the settings dialog. The MET value is leading the activity's name. For example: <code>6.8 bicycling, leisure, moderate effort</code></p>
97
+
<p>Both MET and weight can be provided in the settings dialog. The MET value is leading the activity's name.
98
+
For example: <code>6.8 bicycling, leisure, moderate effort</code></p>
99
+
100
+
<h1>AAT-Android and permissions</h1>
101
+
102
+
<p>Some features like <strong>GPS-tracking</strong>, accessing <strong>shared storage</strong> and accessing <strong>sensor-devices</strong> need extra permission.
103
+
This needed permissions are different on different Android versions.</p>
104
+
105
+
<p>AAT-Android tries to aquire all those permissions on the first application start.</p>
106
+
107
+
<p>To acquire permissions later open <code>Preferences->General/System->App permission</code>.
108
+
There you find an overview of missing permissions and a button to request permissions.</p>
109
+
110
+
<p>Some permissions can only be enabled manually in the Android settings: <code>App Info -> Permissions -> … -> All permissions</code></p>
111
+
112
+
<p><strong>Some important permissions</strong></p>
113
+
114
+
<p>(Naming might be different on different Android versions)</p>
115
+
116
+
<ul>
117
+
<li><code>Location permission (allow all the time)</code>, <code>access location in the background</code> and <code>use precise location</code>: GPS-Tracking only works if those are enabled. If tracking stops working when AAT-Android is in the background then some of these permissions are missing.</li>
118
+
<li><code>Notifications (all notifications)</code>: To display tracker status in the top bar.</li>
119
+
<li><code>Read heart rate</code>, <code>connect to paired BT devices</code>, <code>discover and pair nearby BT devices</code> and many more: To access BT and other sensors.</li>
120
+
</ul>
121
+
122
+
<p><strong>Shared storage</strong></p>
123
+
124
+
<p>On some Android versions Storage Access Framework (SAF) is needed to access shared storage locations.
125
+
SAF is token based and the token has to be renewed under some conditions like after rebooting the device.
126
+
To use SAF just select <code>Pick (SAF)…</code> in the location menu found with some preferences. Example: <code>Preferences->General/System/Data directory->Pick (SAF)…</code> and then select a directory.</p>
127
+
128
+
<p>On other Android versions access to shared storage can be acquired by selecting <code>Preferences->General/System->App permission->Request permissions</code> and then enable <code>Allow access to manage all files</code></p>
71
129
72
130
<h1>Contribution</h1>
73
131
74
132
<h2>Issues and feedback</h2>
75
133
76
-
<p>For questions, feedback and bug reports <ahref="https://github.com/bailuk/AAT/issues">report an issue</a> or send an e-mail to aat@bailu.ch</p>
134
+
<ul>
135
+
<li><ahref="https://github.com/bailuk/AAT/issues">Report an issue</a></li>
136
+
<li><ahref="https://github.com/bailuk/AAT/discussions">Start a discussion</a></li>
137
+
</ul>
77
138
78
139
<h2>Translation</h2>
79
140
80
-
<p>You can open a pull request or send me your translation as e-mail or publish them as an issue report.</p>
141
+
<p>Open a pull request on GitHub to update or add translations.</p>
81
142
82
143
<h3>File tree structure</h3>
83
144
84
-
<p>Resources (like text and icons) are located in <ahref="https://github.com/bailuk/AAT/blob/stage/aat-android/src/main/res">app/src/main/res</a>. </p>
85
-
86
-
<p>English text strings are in this file: <ahref="https://github.com/bailuk/AAT/blob/stage/aat-android/src/main/res/values/strings.xml">/app/src/main/res/values/strings.xml</a></p>
87
-
88
-
<p>German translations are in this file: <ahref="https://github.com/bailuk/AAT/blob/stage/aat-android/src/main/res/values-de/strings.xml">/app/src/main/res/values-de/strings.xml</a></p>
145
+
<ul>
146
+
<li>Resources (like text and icons) are located in <ahref="https://github.com/bailuk/AAT/blob/stage/aat-android/src/main/res">app/src/main/res</a>. </li>
147
+
<li>English text strings are in this file: <ahref="https://github.com/bailuk/AAT/blob/stage/aat-android/src/main/res/values/strings.xml">/app/src/main/res/values/strings.xml</a></li>
148
+
<li>German translations are in this file: <ahref="https://github.com/bailuk/AAT/blob/stage/aat-android/src/main/res/values-de/strings.xml">/app/src/main/res/values-de/strings.xml</a></li>
0 commit comments