gpsmagcourse: README updates

apps/gpsmagcourse/README.md

@@ -1,9 +1,9 @@
-# GPS Compass heading switcher
+# GPS Compass course switcher
 The GPS course and speed is calculated by the difference of positions.
 However GPS position is noisy and prone to jump around.
 This results in randomly jumping GPS course values when speed is slow or standing still.
-So in these cases a user might want to get his moving direction from a compass instead.
+So in these cases a user might want to get the moving direction from a compass instead.
-This is why this app replaces the GPS heading with the compass heading when the speed is slower then 6 km/h (threshold is configurable, see settings).
+This is why this app replaces the GPS course with the compass heading when the speed is slower then 6 km/h (threshold is configurable, see settings).
 
 ## Important Notes
 * **Watch orientation**
@@ -19,30 +19,25 @@ This is why this app replaces the GPS heading with the compass heading when the
   However the error from local magnetic interference and from calibration will probably be higher..
 
 ## Widget
-The widget indicates if the current GPS heading is provided from GPS or compass.
+The widget indicates if the current GPS course is provided from GPS or compass.
 It can be turned off in the settings.
 On Bangle.js 2 a click on the widget does reset the built-in compass.
 
 ## Settings
-* **speed**
+* **Speed threshold**
-  - (default = 6 km/h) When lower then this use direction from compass
+  - (default = 6 km/h) When GPS speed is lower then this threshold use the compass direction.
-* **compassSrc**
+* **Compass source**
-  - off:
+  - off: Disables this addon.
-  - built-in (default):
+  - built-in (default): Uses the built-in compass. Its calibration can be restarted by pressing the Widget. When tilt compensation is disabled or "Navigation compass" is not installed the watch must be orientated horizontally for the compass heading to be used.
-  - Navigation Compass:
+  - magnav (only if "Navigation Compass" is installed): Compass heading is provided by "Navigation Compass" (magnav). Remember to calibrate it regularly.
-* **reset compass on power on**
+* **Reset compass when powered on**
-  - off:
+  - Off: Do nothing when compass is turned on.
-  - on (default):
+  - On (default): The calibration of the built-in compass is reset when it is turned on.
-* **tilt compensation**
+* **Tilt compensation on built-in compass**
-  - off:
+  Only available if "Navigation Compass" is installed.
-  - on (default):
+  - Off: Leaves the value of the built-in compass unchanged.
-* **show Widget**
+  - On (default): Apply the tilt compensation from "Navigation Compass" to the built-in compass in _all_ applications.
-  - Never
+* **Show Widget**
-  - Active (default): When replacing GPS course with compass course
+  - Never: Widget is hidden.
-  - GPS on
+  - Active (default): Widget is only visible when replacing GPS course with compass heading.
-
+  - GPS on: Widget is shown as soon as GPS is enabled, crossed out when GPS provides the course and displayed normally when the compass heading is used.
-## TODO:
-- Document settings with defaults
-- Check magnav dependency in settings
-- note magnav silently downgrade
-- Test on BangleJS

apps/gpsmagcourse/metadata.json

@@ -4,7 +4,7 @@
   "shortName":"GPS/Compass course",
   "icon": "app.png",
   "version":"0.01",
-  "description": "Replace GPS heading with compass heading when speed is slow or standing still to avoid the heading from jumping around randomly.",
+  "description": "Replaces the GPS course with the compass heading when speed is slow or standing still to avoid the value from jumping randomly. For best experience also install \"Navigation Compass\", although not a requirement (see README).",
   "type": "bootloader",
   "tags": "outdoors,widget",
   "supports": ["BANGLEJS","BANGLEJS2"],

apps/gpsmagcourse/widget.js

@@ -71,7 +71,7 @@
 
     // reset compass on click on widget
     Bangle.on('touch', function(button, touch) {
-      if (WIDGETS.gpsmagcourse && WIDGETS.gpsmagcourse.x && WIDGETS.gpsmagcourse.width && isInside({x: WIDGETS.gpsmagcourse.x, y: WIDGETS.gpsmagcourse.y, w: WIDGETS.gpsmagcourse.width, h: 24}, touch)) {
+      if (touch && WIDGETS.gpsmagcourse && WIDGETS.gpsmagcourse.x && WIDGETS.gpsmagcourse.width && isInside({x: WIDGETS.gpsmagcourse.x, y: WIDGETS.gpsmagcourse.y, w: WIDGETS.gpsmagcourse.width, h: 24}, touch)) {
         Bangle.buzz(50);
         Bangle.resetCompass();
       }