From a9b33e53ce5098bac730c1b90d6ec31a45cc831c Mon Sep 17 00:00:00 2001 From: Willem Ferguson Date: Wed, 9 Mar 2016 15:43:37 +0200 Subject: Mobile - Update user manual for Subsurface-mobile This replaces eight images and brings the text of the manual up to date. Signed-off-by: Willem Ferguson Signed-off-by: Dirk Hohndel --- Documentation/mobile-manual.html | 349 ++++++++++++++++++++++----------------- 1 file changed, 194 insertions(+), 155 deletions(-) (limited to 'Documentation/mobile-manual.html') diff --git a/Documentation/mobile-manual.html b/Documentation/mobile-manual.html index cdbf3d1d9..3758ff54b 100644 --- a/Documentation/mobile-manual.html +++ b/Documentation/mobile-manual.html @@ -413,33 +413,24 @@ asciidoc.install(3);
Table of Contents
-

Beta release, February 2016

-
- - - -
-Important -For this BETA release it is critical that users report any problems -with the use of the mobile software. After all, one of the objectives -of a beta release is to distribute the software to a broader circle -of users using different Android devices and configurations in order to -iron out any bugs, errors or inconsistencies. Please report -such issues by email to subsurface@subsurface-divelog.org
-
-

Welcome as a user of Subsurface, an advanced dive logging program with +

Beta release, March 2016

+

Welcome as a user of Subsurface, advanced dive logging software with extensive infrastructure to describe, organize, interpret and print scuba and free dives. Subsurface offers many advantages over other similar software solutions, including compatibility with Windows, Mac-OS/X, Linux (many -distributions) as well as Android. In addition, Subsurface allows downloading dive -information from most dive computers. Subsurface software is open-source.

+distributions) and Android (iOS under development). In addition, Subsurface is +open-source software that allows downloading dive +information from most dive computers.

1. Introducing Subsurface-mobile

-

Subsurface-mobile is an extension of Subsurface that runs on laptop and +

Subsurface-mobile is an extension of Subsurface on laptop and tabletop computers. It runs on Android smartphone and tablet devices and is a -tool for viewing or sharing dive information at dive sites. It also allows +tool for viewing or sharing dive information at dive sites where a larger +computer is not useful. Subsurface-mobile also allows the gathering of GPS locations where dives are performed.

+

A version of Subsurface-mobile for iOS is under development but not yet +ready for testing.

While Subsurface-mobile allows one to enter and save dive information using an Android device, users of Subsurface-mobile typically use the mobile app as an extension of the laptop/desktop version of Subsurface. @@ -448,7 +439,8 @@ can be shared by the Android version as well as the desktop version. While the desktop version of Subsurface shows much more detailed information for each dive, the mobile version allows one to have a more accessible dive log on a dive trip, useful for proving dive experience to dive shops or to review -previous dives. Subsurface-mobile allows one to:

+previous dives.

+

Subsurface-mobile allows one to:

  • @@ -488,14 +480,19 @@ View the localities of recorded GPS positions and of dives

-

These items are discussed in greater detail in the following text.

+

These items are discussed in greater detail in the following text. +What Subsurface-mobile does not support (at this time) is downloading +dive data directly from a dive computer. That still has to happen with +Subsurface on a desktop or laptop computer. We are investigating ways +to support downloading from a subset of the supported dive computers on +Android devices, but this is not yet ready for testing.

2. Installing Subsurface-mobile on an Android device

-

Install Subsurface-mobile from the Google -Play Store. Search for Subsurface-mobile and install it.

+

Find Subsurface-mobile in the Google +Play Store. Search for Subsurface-mobile and install it.

@@ -503,26 +500,27 @@ Play Store. Search for Subsurface-mobile and install it.

Upon starting Subsurface-mobile for the first time, a Subsurface splash screen is shown while the program loads. On some devices this -may take several seconds. After loading, the landing screen appears -(see image on left, below). There are three options.

+may take several seconds. After loading, the Cloud Credentials screen appears +(see image below).

FIGURE: Mobile landing screen

Since Subsurface is largely dependent on a dive log saved on the Internet, -select the top option "Connect to Cloudstorage" and enter an email address -and password for access to the Subsurface Internet storage server. If -you do not have credentials to log in, this is obtained through the -desktop version of Subsurface. When entering a password, it is possible to check +provide a user-ID and password for access to the Subsurface Cloud. These +credentials are obtained by opening the desktop version of Subsurface and +by clicking File → Preferences → Network, explained in detail in the +user manual for the Subsurface desktop version. Once the account has +been created and verified using the desktop version one can use Subsurface-mobile.

+

When entering a password, it is possible to check a checkbox that enables the text of the password to be shown. Checking the check box labelled "Remember" allows Susburface-mobile to keep the -credentials for subsequent logins (see image on right, above). -Having entered the credentials, tap "Save". -Subsurface-mobile attempts to download the existing dive log from the -Internet server. Appropriate messages are shown onscreen. Finally -a list of dives are shown (image on left, below).

-

For the beta release, do not choose the options "Transfer from dive computer" or "Add dive manually"

+credentials for subsequent logins (see image above). +Having entered the credentials, tap the disk icon at the bottom of the screen. +Subsurface-mobile attempts to download the existing dive log from the_Subsurface_ cloud +server. Appropriate messages are shown onscreen. Finally +a list of dives are shown.

@@ -530,95 +528,112 @@ a list of dives are shown (image on left, below).

Once the dive list has been downloaded from the Internet, Subsurface-mobile keeps a local -copy on the Android device. This means that, if there is no Internet connection +copy on the mobile device. This means that, if there is no Internet connection at a dive site, one can still access the local copy and view and manipulate dive information. If there is Internet connectivity, Subsurface-mobile accesses the Internet-based dive log to verify that the local copy is still the -same as the Internet-stored copy. If not, the local copy is synchronised with the version on -the Internet.

+same as the Internet-stored copy. If not, the local copy and the copy on +the server are synchronised.

-

5. The Action Button

+

5. A Few Remarks About The User Interface

-

At the bottom of of most Subsurface-mobile screens is a round button that provides -information and enables several actions. The Action Button often has one -or more triangular arrow points. Arrows alongside the Action Button indicate -drag movements that are available by dragging the Action Button. Arrows indicate -that one or more Action Screens are available(i.e. menus that become visible as side -panels) On the other hand icons inside the Action Button indicate -specific actions that can be performed by tapping the button. Examples of different -formats of the Action Button are presented in the images below:

-
- - - -
-Important -This action button indicates that an Action Panel can be viewed -by dragging the Action Button to the right. Doing this exposes the main Action Panel -that allows many actions with respect to one’s dive log. The different Action Panels -are described below.
-
-
- - - -
-Important -This action button indicates that one of two different Action Panels can be viewed -by dragging the Action Button either to the right or to the left.
-
-
- - - -
-Important -This action button contains an icon that indicates that, in addition to the drag action -described above, one can edit one or more fields by tapping the Action Button.
-
-
- - - -
-Important -This action button contains an icon that indicates that, in addition to the drag action -described above, one can abord or an edit of dive data by tapping the Action Button.
+

At the bottom of many Subsurface-mobile screens is a round button that provides for +several actions and which allows the selection of the main affirmative action +(see image above and image below). +On Android devices, use the Android Back +button for "cancel", "discard" or "back" actions. For example, when +editing dive information, tapping the action button saves the changes, the +Android back button can be used to cancel the edit without saving changes.

+
+
+FIGURE: Action Button
+

Instead of the more traditional "hamburger" menu button in the top left or +right corner of the screen to open menus, Subsurface-mobile uses a +different user interaction philosophy based on the Kirigami framework +developed by the Plasma developers. To open the main menu one has +three options:

+
    +
  • +

    +Tap on the right-arrow symbol in the lower left corner of the screen + (easy to reach for hand held devices) +

    +
    • +
  • +

    +Swipe towards the right across the left edge of the screen +

    +
    • +
  • +

    +Drag the action button visible on most screens with the main action to + the right +

    +
    • +
+
+
+FIGURE: Dive management subpanel +
+
+

The images above indicate some of the important features of the menu system. +On the left is the main menu that is activated as described above. In the middle is +the menu that opens if one taps the GPS option on the main menu. On the right is +the menu that opens if one taps the Manage Dives option on the main menu.

+

Similarly, the context menu (currently only available on the dive details screen) can be +opened one of these three ways:

+
    +
  • +

    +Tap on the left-arrow symbol in the lower right corner of the screen +

    +
    • +
  • +

    +Swipe to the left across the right edge of the screen +

    +
    • +
  • +

    +Drag the action button to the left +

    +
    • +
+

6. Viewing the Dive List

Most of the actions of Subsurface-mobile center around the dives on the -dive list. One can scroll up and down the dive list. Tapping a dive on -the list brings up a display of Details View for that dive. -This includes the dive profile as well as additional information and notes -(see image on right, below).

-

One can view other dives by swiping the Details view to the right (for the -previous dive) or to the left (following dive).

+dive list. While the dive list is loading from the cloud, +a message appears at the bottom of the screen, indicating that the cloud is +being accessed (see image on left, below). Once the list is loaded one can scroll up and down. +Tapping a dive on the list brings up a display of Details View for that dive (see image on right below). +This includes the dive profile as well as additional information and notes.

FIGURE: Dive list screen
+

One can view other dives by swiping the Details view to the right (for the +previous dive) or to the left (following dive).

7. Editing dive details.

-

At the bottom of the screen an Action Button -allows aditional actions with respect to a dive that is being shown. In the -details screen (image on right, above) the action button shows a pencil. +

At the bottom of the dive details screen the Action Button contains a pencil (image on right, above). Tapping the button brings up a panel with edit boxes that allows one to change the existing dive information, e.g. adding text to the dive notes or changing the names or values of some of the information (see image below). It may be necessary to scroll the window to access all the information. -At the bottom of the edit screen is a "Save" button. Tap this to save +At the bottom of the edit screen is a Save action button. Tap this to save the new information. Having saved the data, the dive list screen is -shown. To cancel any edits, tap the Action Button.

+updated and shown. To cancel any edits, tap the Android Back Button.

FIGURE: Dive edit screen @@ -627,54 +642,86 @@ shown. To cancel any edits, tap the Action Button.

-

8. Dive log management

+

8. Adding a new dive to the dive list

+
+

It is also possible to add an additional dive to the existing dive list. On the +main menu tap Manage dives → Add dive manually. This opens a screen that is +identical to the editing screen discussed above. When a dive is added manually, one +cannot directly add a dive profile from a dive computer. However, if one does not use a +dive computer, the duration, depth and several other bits of information about +the new dive can be entered. The Action button at the bottom of the screen +contains a disk symbol. Tap this to save the new dive. To cancel any edits, tap the Android Back Button. +The left-hand image below shows a screenshot of a dive being created and the right-hand image shows +the same dive in Details View.

+
+
+FIGURE: Dive edit screen +
+
+
+
+
+

9. Deleting a dive

-

A central part of Subsurface-mobile is the ability to store the dive log on the Internet. +

The details view of a dive has a context menu on the right-hand side that can be activated as described above +(e.g. by tapping the arrow icon at the bottom right of the screen or by dragging the Action Button to the left). +The context menu has a single item: "Delete dive". If this option is tapped, the dive shown in the Details View +is deleted. One has a brief opportunity to undo the delete by tapping the undo message that appears at the bottom of +the screen. If the undo message is not tapped, the dive is deleted.

+
+
+
+

10. Dive log management

+
+

A central part of Subsurface-mobile is the ability to store the dive +log using the Subsurface cloud storage. This provides security against loss or damage to the dive information caintained in a local copy of -the dive log. This ability is accessed throug the Action Panel. Drag the Action Button to the right. -(alternatively tap the Menu button at the top left of the Android screen). -This brings up the Action Panel (image on left, below). Tap the option "Manage dives" (image below in middle).

+the dive log and allows the desktop version of Subsurface to +access changes made using the mobile device. This ability is accessed +throug the main menu (by dragging the Action Button to the right, or +alternatively tap the right angle button at the bottom left of the screen). + Tap the option Manage dives, enabling a number of options:

-

8.1. Upload dive log to the Internet

-

Assuming that the correct credentials have been specified, one can upload the dives contained on the Androis device -to the Internet by tapping the option "Upload to cloud". This saves the local -copy of the dive log to the cloud.

+

10.1. Add new dive manually

+

This is described above under the section dealing with the dive list.

-

8.2. Download dive log from the Internet

-

In the dive management subpanel, tap the option "Refresh" (image below in middle). This causes -the local divelog to be refreshed from the cloud so that the Internet and local versions are synchronised.

-
-
-FIGURE: Dive management subpanel -
+

10.2. Upload dive log to the Subsurface cloud storage

+

One can upload the dives contained on the mobile device +to the Subsurface cloud storage by tapping the option Upload to cloud. +This synchronizes the local changes to +the dive log with the cloud storage.

+
+

10.3. Download dive log from the cloud storage

+

In the dive management subpanel, tap the option Refresh, causing +the local divelog to be refreshed from the cloud so that the cloud +and local versions are synchronised.

-

8.3. Add dive manually

-

Dives can easily be entered by hand. This allows one to describe a dive and add it to the dive log. -In the dive management subpanel tap "Add dive manually". The edit screen opens (image above on right). -Fill in all the appropriate information, then tap the "Save" button at the bottom of the screen. It may be -necessary to scroll down to see the "Save" button. The dive is then saved as part of the dive log. In the -details dive view, a profile of the dive is created.

+

10.4. Changing the login credentials on the Subsurface cloud

+

It may be necessary to change one’s login credentials, for instance if one’s email +address (initially used as a credential) has changed. To change the credentials, +open the main menu and tap Cloud credentials. This opens the setup screen +for specifying new credentials.

-

9. Recording dive locations using GPS.

+

11. Recording dive locations using GPS.

The fact that most smartphones have GPS facilities allows one to record the locations of dives. One can take the smartphone on the dive boat -during a dive and locations will be automatically recorded at regular intervals.

+during a dive and locations will be automatically recorded at regular intervals. +These locations can then be applied to dives in the dive list. Here is how it’s done:

-

9.1. Setting up the GPS

-

Drag the Action Button to the right. This brings up the Action Panel (image -on left, above). Select "Preferences". Now specify the way -in which GPS data need to be automatically collected (image on left, below). One can specify that +

11.1. Setting up the GPS

+

Open the main menu and tap GPS → Preferences. Now specify the way +in which GPS data need to be automatically collected (image on right, below). One can specify that data are collected at regular intervals, e.g. every 10 minutes, or at regular distances, e.g. after the boat has moved more than 200m, or a combination of both of the above approaches. Provide the appropriate information and -tap the "Save" button. The program is now ready to collect GPS positions.

+tap the Save action button. The program is now ready to collect GPS positions.

FIGURE: GPS setup screen @@ -682,47 +729,39 @@ tap the "Save" button. The program is now ready to collect GPS positions.

-

9.2. Collecting GPS positions

+

11.2. Collecting GPS positions

Ensure that the GPS on the Android device has been activated. At the bottom -of the Action Panel is a check box "Run location service" (image on right, above). +of the GPS submenu is a check box Run location service (image on left, above). Check this box and Subsurface-mobile starts to collect GPS locations automatically, following the preferences specified as described above. After the dive one can deactivate the collection of GPS data by de-activating -the same check box at the bottom of the Action Panel.

+the same check box at the bottom of the main menu.

-

9.3. Storing the GPS data

-

Activate the Action Panel (image on right, above) by drawing the Action Button to the right. -Select the "GPS" option that brings up a submenu of GPS-related actions -(image on left, below). Tap "Upload GPS data" that saves the GPS data -on the Subsurface Internet server. These GPS data are saved separately +

11.3. Storing the GPS data on the Subsurface cloud

+

Activate the main menu and select the GPS option that brings up the submenu of GPS-related actions +(image on left, above). Tap Upload GPS data that saves the GPS data +on the Subsurface cloud server. These GPS data are saved separately from the other dive log data. All collected GPS data are kept on the Android device, independent of whether they have been uploaded or not.

-

9.4. Viewing GPS data

-

From the GPS submenu (image on left, below) select "Show GPS fixes". This brings +

11.4. Downloading GPS data from the Subsurface cloud

+

Download the GPS data that have been saved on the cloud by +selecting Download GPS Data from the GPS subpanel.

+
+
+

11.5. Viewing GPS data

+

From the GPS submenu (image on left, above) select Show GPS fixes. This brings up a list of GPS positions obtained using the location service (image -in middle, below). Two actions are possible for each of the locations, enabled if -one taps the handle (the three horisontal stripes on the right, see image in middle, below) and +on left, below). Two actions are possible for each of the locations, enabled if +one taps the handle (the three horisontal stripes on the right, see image on left, below) and then drags the specific item to the left (image on right, below). This exposes two options. Tapping the dustbin deletes this particular GPS location. Tapping the teardrop-shaped icon (actually a Google Maps pin) opens up Google Maps with a pin -indicating the exact map position of the record being viewed. The two above +indicating the exact map position of the GPS record being viewed. The two above options can be hidden by drawing the GPS record to the right, again using the handle.

-
-
-
-
-

10. Saving GPS positions on the Internet

-
-

One can save the collected GPS data on the Internet by -selecting "Upload GPS Data" from the GPS submanu (Image on left, below).

-
-

10.1. Downloading GPS data from the Internet

-

One can download the GPS data that have been saved on the Internet by -selecting "Download GPS Data" from the GPS subpanel (Image on left, below).

FIGURE: GPS management @@ -730,14 +769,14 @@ selecting "Download GPS Data" from the GPS subpanel (Image on left, below).

<
-

10.2. Applying GPS data to dives in the dive log

+

11.6. Applying GPS data to dives in the dive log

Assuming that all the dives have been entered into the dive log or have -been downloaded from the Internet, one can apply the GPS positions to -these dives. GPS positions can therefore only be applied to dives in the dive log. -From the GPS subpanel, tap "Apply GPS fixes" (image on left, above). The dive log contains the start +been downloaded from the Subsurface cloud, one can apply the GPS positions to +these dives. GPS positions can therefore only be applied to dives in the dive list. +From the GPS subpanel, tap Apply GPS fixes. The dive list contains the start and end times of each dive. Now, Subsurface-mobile applies the first GPS position that falls within the dive period of each dive. This results -in a GPS position for each dive that is saved as part of the dive log.

+in a GPS position for each dive that is saved as part of the dive list.

@@ -746,7 +785,7 @@ in a GPS position for each dive that is saved as part of the dive log.

-- cgit v1.2.3-70-g09d2