mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Documentation: update "Web Service and Companion App"

Browse source 
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Dirk Hohndel 2013-05-13 17:17:13 -05:00
parent ca0bad84f8
commit 95f9ba800b
1 changed files with 29 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

42
Documentation/user-manual.txt
View file

@ -1180,21 +1180,37 @@ Web Service and Companion App
----------------------------- -----------------------------
This part of Subsurface is a bit of 'work in progress'. We are This part of Subsurface is a bit of 'work in progress'. We are
developing a companion application for Android that will allow you to developing a companion application for Android that allows you to
track dive sites from your GPS-enabled Android device; at the time of track dive sites from your GPS-enabled Android device.
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 The Subsurface app is available for free in the Google Play store (and
you can use this menu item to connect to our back-end server and sources are available from our git server). A server side webservice
download this data. Enter your userid (you got this when registering is running on our infrastructure to capture and store the data
with the web service) and click 'Download'. If the data was transmitted by the application. An interested user could also run
successfully downloaded you can click apply and Subsurface will match their own web service (the sources for the web service are also
the time stamps of the downloaded location and site name information available).
with the dives in your log and will add the GPS locations and dive
site names to your dives.
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]] [[S_Menu]]
The Menu and Sub-Menus The Menu and Sub-Menus