From eba0790a040981858a4652d802721f0f7ab9801c Mon Sep 17 00:00:00 2001 From: Willem Ferguson Date: Wed, 7 May 2014 21:47:43 +0200 Subject: Yet some more changes to Companion part of user manual A last few changes before 4.1. The first figure in "Using Companion app" needs a third part. This was inserted. Which, in turn, affected the last figure in that section. So that was also changed accordingly. Few tiny changes to text to clean up references to figures. Signed-off-by: Willem Ferguson Signed-off-by: Dirk Hohndel --- Documentation/user-manual.html.git | 173 +++++++++++++++++++++++++++---------- 1 file changed, 129 insertions(+), 44 deletions(-) (limited to 'Documentation/user-manual.html.git') diff --git a/Documentation/user-manual.html.git b/Documentation/user-manual.html.git index daff41257..3a44d03de 100644 --- a/Documentation/user-manual.html.git +++ b/Documentation/user-manual.html.git @@ -409,7 +409,7 @@ asciidoc.install(3);

USER MANUAL

Manual authors: Willem Ferguson, Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, -Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat

+Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat

Version 4.1, May 2014

Welcome as a user of Subsurface, an advanced dive logging programme with extensive infrastructure to describe, organise, interpret and print scuba @@ -1612,11 +1612,13 @@ divelog. The Companion App stores the dive locations on a dedicated Internet-based file server. Subsurface, in turn, can collect the localities from the file server.

To do this:

+
+

3.4.1. Create a Companion App account

  • Register on the Subsurface companion web page. -A confirmation email with instructions and a personal DIVERID will be send together with +A confirmation email with instructions and a personal DIVERID will be sent, a long number that gives access to the file server and Companion App capabilities.

    • @@ -1624,85 +1626,159 @@ a long number that gives access to the file server and Companion App capabilitie

    Download the app from Google Play Store -or -from +or from F-Droid.

+
-

3.4.1. Using the Subsurface companion app on a smartphone

+

3.4.2. Using the Subsurface companion app on a smartphone

On first use the app has three options:

  • Create a new account. Equivalent to registering in Subsurface companion -page using an Internet browser. +page using an Internet browser. One can request a DIVERID using this option, +but this is supplied via email and followed up by interaction with the +Subsurface companion web page in order to +activate the account.

  • -Retrieve an account. If users forgot their DIVERID they will receive an email +Retrieve an account. If users forgot their DIVERID they will receive an email to recover the number.

  • -Use an existing account. Users are prompted for their DIVERID. The app saves -this DIVERID and does not ask for it again unless one uses the Disconnect menu +Use an existing account. Users are prompted for their DIVERID. The app saves +this DIVERID and does not ask for it again unless one uses the Disconnect menu option (see below).

-

Now one is ready to get a dive position and send it to the server. The Android -display will look like the left hand image (A) below, but without any dive.

-

Touch the "+" icon on the top right to add a new dive site, resulting in a prompt -for a place name (or a request to activate the GPS if it is turned off). -The main screen shows a list of dive locations, each with a name, date and -time. Some locations may have an arrow-up icon on the selection box to the left (see -image B in the middle, below) indicating that they require upload to the server.

-

There are several ways to send locationd to the server; the easiest is by simply -selecting the location. See middle image below (B):

-
-
-FIGURE: Screen shots (A-C) of companion app -
-
-

Touching the right arrow will send it to the server.

- +
Important Users must be careful, as the trash icon on the right means exactly what it should mean: -it deletes the dive location(s).In the Subsurface main program, the DIVERID should also be entered on the +Default Preferences +panel, obtained by selecting File→Preferences→Defaults from the main menu +in Subsurface itself. +This facilitates synchronisation between Subsurface and the Companion App.
-

New dive locations are now stored on the server and can be downloaded to the -Subsurface dive log whenever users upload or add dives to Subsurface. -After a dive trip using the Companion App, all dive locations are ready to be -saved on a Subsurface dive log (see below).

-

When you click on a dive (not selecting the check button as shown in the images above), the -name given to it, date/time and GPS coordinates will be shown, with two options:

+
+
Creating new dive locations
+

Now one is ready to get a dive position and +send it to the server. The Android +display will look like the left hand image (A) below, but without any dive.

+

Touch the "+" icon on the top right to add a new dive site, a menu will be +showed with 3 options:

  • -Edit: Change the text name of the dive location. +Current: A prompt for a place name (or a request to activate the GPS if it is turned +off) will be displayed, after which the current location is saved.

  • -Maps: Display a map showing the dive location (you’ll be prompted to -choose which helper app use from your installed apps). Currently this feature is -non fully functional, but is under active development. +Use Map: This option allows the user to fix a position by searching a world map. A +world map is shown (see B below) on which one should indicate the desired position +with a long press on the touch +sensitive screen (if the marked location is erroneous, simply indicate a new location) +and select the check symbol in the upper right. A dialog is shown allowing to enter the +name of the dive location and the date-time of the dive (see C below). In order to import this +dive location in Subsurface it’s advisable to set the time to agree with the time of +that dive on the dive computer.

-

After editing and saving a dive location, one needs to upload it to the web +

+
+FIGURE: Companion App, add location using map +
+
+
    +
  • +

    +Import local GPX file: The android device searches for .gpx files and located +archives will be shown. The selected .gpx file is opened and the stored +locations shown. Now one needs to select the appropriate locations, then select the +tab in the upper right, after which the locations will be sent to the web service +and added to the list on the Android device. +

    +
    • +
+
+
+
Lists of dive locations
+

The main screen shows a list of dive locations, each with a name, date and +time (see A below). Some locations may have an arrow-up icon over the selection box to the left +indicating that they require upload to the server. One +can select individual dive locations from the list. A selected location has a +check mark in the selection box on the left. Group operations (such as Delete or Send) +are performed on several locations that are selected.

+

Dive locations in this list can be viewed in two ways: a list of locations or a +map indicating the dive locations. The display mode (List or Map) is changed by +selecting Dives at the top left of the screen (see A below) and then selecting +the display mode. The display mode can be changed either from the list +of locations or from the map (see B below). If one selects a location (on the list +or on the map), an editing +panel opens (see C below) where the dive description or other details may be changed.

+
+
+FIGURE: Companion App, add location using map +
+
+

When one clicks on a dive (not selecting the check box), the +name given to it, date/time and GPS coordinates will be shown, with two options at the top +of the screen:

+
    +
  • +

    +Edit (pencil): Change the text name or other characteristics of the dive location. +

    +
    • +
  • +

    +Maps: Display a map showing the dive location. +

    +
    • +
+

After editing and saving a dive location (see C above), one needs to upload it to the web service, as explained above.

+
+
+
Uploading dive locations
+

There are several ways to send locations to the server. +The easiest is by simply +selecting the locations (See A below) and then touching the right arrow at the +top right of the screen.

+
+ + + +
+Important +Users must be careful, as the trash icon on the right means exactly what it should: +it deletes the selected dive location(s).
+
+
+
+FIGURE: Screen shots (A-B) of companion app +
+
+

After a dive trip using the Companion App, all dive locations are ready to be +downloaded to a Subsurface dive log (see below).

+
Settings on the Companion app
-

Selecting the Settings menu option results in the right hand image above (C).

+

Selecting the Settings menu option results in the right hand image above (B).

Server and account
@@ -1821,7 +1897,7 @@ of another registered diver.

-

3.4.2. Downloading dive locations to the Subsurface divelog

+

3.4.3. Downloading dive locations to the Subsurface divelog

Download dive(s) from a dive computer or enter them manually into Subsurface before obtaining the GPS coordinates from the server. The download dialog can be reached via Ctrl+G or from the Subsurface Main Menu Import @@ -2420,7 +2496,7 @@ below shows the depth profile two such dives that were merged:

6. Exporting the dive log or parts of the dive log

-

A dive log can be saved in two formats:

+

A dive log can be saved in three formats:

  • @@ -2434,15 +2510,24 @@ UDDF is a generic format that enables communication among many dive computers and computer programs.

    • +
  • +

    +CSV format, that includes the most critical information of the dive +profile. Included information of a dive is: number, date, time, +duration, depth, temperature and pressure. +

    +

In order to save the WHOLE dive log (i.e. all trips and dives), select File from the Main menu. To save in Subsurface XML format, select File → Save as. -To save in UDDF format, select File → Export UDDF.

+To save in UDDF format, select File → Export UDDF and to save in CSV +format, select File → Export CSV.

In order to save only one or more dives or one or two trips, select the appropriate dives or trips in the Dive List panel and then right-click the selected dives to bring up the context menu. To save in Subsurface XML -format, select Save as from the context menu. To save in UDDF format, select -Export as UDDF from the context menu.

+format, select Save as from the context menu. To save in UDDF or CSV +format, select Export as UDDF or Export as CSV from the context menu +respectively.

Export to other formats can be achieved through third party facilities, for instance www.divelogs.de.

@@ -3587,7 +3672,7 @@ you may stay in the water for a long time, but spend most of it at the surface.
-- cgit v1.2.3-70-g09d2