summaryrefslogtreecommitdiffstats
path: root/Documentation/user-manual.txt
diff options
context:
space:
mode:
authorGravatar Dirk Hohndel <dirk@hohndel.org>2013-05-13 17:17:13 -0500
committerGravatar Dirk Hohndel <dirk@hohndel.org>2013-05-13 17:17:13 -0500
commit95f9ba800b45c72100ad3809e375b662a6c52852 (patch)
tree2ca3d46159a79c6bddb2a5a7130d86f62d472056 /Documentation/user-manual.txt
parentca0bad84f8f2739ce929e24228b653c3e8074d57 (diff)
downloadsubsurface-95f9ba800b45c72100ad3809e375b662a6c52852.tar.gz
Documentation: update "Web Service and Companion App"
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'Documentation/user-manual.txt')
-rw-r--r--Documentation/user-manual.txt44
1 files changed, 30 insertions, 14 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index dac333b2f..943c8aca6 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1180,21 +1180,37 @@ Web Service and Companion App
-----------------------------
This part of Subsurface is a bit of 'work in progress'. We are
-developing a companion application for Android that will allow you to
-track dive sites from your GPS-enabled Android device; at the time of
-the Subsurface 3.0 release the app wasn't ready to be submitted to the
-Google Play store, but since it is mostly usable when built form
-source we left the server side integration in Subsurface.
-
-Assuming you have used the companion app to name and locate dive sites
-you can use this menu item to connect to our back-end server and
-download this data. Enter your userid (you got this when registering
-with the web service) and click 'Download'. If the data was
-successfully downloaded you can click apply and Subsurface will match
-the time stamps of the downloaded location and site name information
-with the dives in your log and will add the GPS locations and dive
-site names to your dives.
+developing a companion application for Android that allows you to
+track dive sites from your GPS-enabled Android device.
+
+The Subsurface app is available for free in the Google Play store (and
+sources are available from our git server). A server side webservice
+is running on our infrastructure to capture and store the data
+transmitted by the application. An interested user could also run
+their own web service (the sources for the web service are also
+available).
+
+The Android companion app allows you to store the GPS location and
+name of specific dive sites as their name is entered into the
+application. It can also operate as a background service and record
+positions at regular intervals (this is especially useful when on a
+dive boat).
+
+After downloading your dives from your dive computer (or manually
+adding them in the Subsurface desktop application) you can then use
+this menu item to connect to our back-end server and download the
+related location data (and dive site names). Enter your userid (you
+got this when registering with the web service) and click
+'Download'. If the data was successfully downloaded you can click
+apply and Subsurface will match the time stamps of the downloaded
+location and site name information with the dives in your log and will
+add the GPS locations and dive site names to your dives.
+[NOTE]
+At this point you can not use the Android Subsurface companion app to
+enter dives and then download these dives into the desktop
+application. The companion up and webservice can only be used to add
+GPS location (and dive site name) to an existing dive in the dive log.
[[S_Menu]]
The Menu and Sub-Menus