From 285c3a9b6659dd82024dc0ea84cbb08f3178fab5 Mon Sep 17 00:00:00 2001 From: Dirk Hohndel Date: Sun, 4 Sep 2016 09:58:10 -0700 Subject: [PATCH] Update Subsurface-mobile manual stored in git Signed-off-by: Dirk Hohndel --- Documentation/mobile-manual.html.git | 314 +++++++++++++++------------ 1 file changed, 177 insertions(+), 137 deletions(-) diff --git a/Documentation/mobile-manual.html.git b/Documentation/mobile-manual.html.git index 835ad63f3..fee617580 100644 --- a/Documentation/mobile-manual.html.git +++ b/Documentation/mobile-manual.html.git @@ -407,40 +407,41 @@ asciidoc.install(3); Banner -

Subsurface-mobile for Android: USER MANUAL

+

Subsurface-mobile USER MANUAL

Manual author: Willem Ferguson

Table of Contents
-

Version 1.0, March 2016

+

Version 1.1, September 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) and Android (iOS under development). In addition, Subsurface is +distributions), Android and iOS. 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 on laptop and -tabletop computers. It runs on Android smartphone and tablet devices and is a +

Subsurface-mobile is an extension of Subsurface which +runs on Android smartphone and tablet devices and is a 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. -This allows the storage of dive logs on the Internet and which -can be shared by the Android version as well as the desktop version. +computer is not useful. Subsurface-mobile for Android also allows +the gathering of GPS locations where dives are performed +(Subsurface-mobile for iOS currently does not support GPS functionality).

+

Subsurface-mobile allows you to enter and save dive information +using a mobile device. Most users of Subsurface-mobile typically use the +mobile app as an extension to the laptop/desktop version of Subsurface. +This allows the storage of dive logs on the Internet sharing them +between the mobile and the desktop versions. But Subsurface-mobile can +be used independently of Subsurface and does not require the use of +cloud storage. 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 +for each dive, the mobile version allows 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:

+

Subsurface-mobile allows you to:

  • @@ -449,7 +450,7 @@ Download existing dive log information from the Internet.

  • -View this information on an Android device. +View this information on a mobile device.

  • @@ -460,17 +461,17 @@ Edit many of the dive log data fields, e.g. divemaster, buddy,

  • -Create and add new dive records to one’s dive log. +Manually create and add new dive records to your dive log.

  • -Store the updated dive log on the Internet. +Store the updated dive log in the Subsurface cloud storage.

  • -Record, store and apply GPS positions of dives. +Record, store and apply GPS positions of dives (Android only).

  • @@ -482,17 +483,17 @@ View the localities of recorded GPS positions and of dives

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 +dive data directly from a dive computer. That still needs to be done using 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

+

2. Installing Subsurface-mobile on your mobile device

-

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

+

Find Subsurface-mobile in the Google Play Store or the iTunes Store +and install it.

@@ -501,65 +502,92 @@ 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 Cloud Credentials screen appears -(see image below).

-
-
-FIGURE: Mobile landing screen +(see image below on left).

+

Select whether Subsurface-mobile should access the Internet for dive log information.

+
+

3.1. When NOT Using Cloud Storage

+

Tap the striked-out cloud icon. The app will not access the Subsurface +cloud storage server +to obtain dive log information. This means that dive log information is manually +entered and stored on the mobile device only.

-
-

Since Subsurface is largely dependent on a dive log saved on the Internet, -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 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.

-
- -
-

4. Local copy of the dive log and synchronisation with Internet

-
+
+

3.2. Using Cloud Storage

+

In order to use the Subsurface cloud storage, an account on the cloud +server is required. If you have already set up an account from the +Subsurface desktop application, enter the credentials here.

+

You can also create a new account from your mobile device.

+
+

3.2.1. Using the desktop version of Subsurface:

+

Open the desktop version of Subsurface and +click 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, +Subsurface desktop alows you to download dive information from dive computers and store this +on the cloud which can, in turn, be downloaded to Subsurface-mobile. Subsurface-mobile +attempts to download the existing dive log from the Subsurface cloud +server. Appropriate messages are shown onscreen. Finally a list of dives is shown.

Once the dive list has been downloaded from the Internet, Subsurface-mobile keeps a local -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 +copy on the mobile device. This means that even if there is no Internet connection +at a dive site, you 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 +the cloud-based dive log to verify that the local copy is still the same as the Internet-stored copy. If not, the local copy and the copy on the server are synchronised.

+
+
+FIGURE: Mobile landing screen +
+
+
+
+

3.2.2. Using Subsurface-mobile:

+

1) Enter an e-mail address and a password in the fields indicated on the screen. +The e-mail should be in lower case and the password should contain a combination of +letters from the alphabet (upper and lower case) and/or numbers. When entering a +password, it is possible to check a checkbox that enables the text of the password to be shown +(image on left, above). At this stage, the red message "Cannot connect to cloud storage" appears on the screen. +This is normal because a valid PIN has not yet been provided (image on left, above).

+

2) Tap the Disk (Save) icon at the bottom of the screen. A PIN is sent to the +e-mail address provided.

+

3) Enter the PIN into the field indicated and tap the Save icon again. The user +information is stored on the cloud server and access to the cloud is enabled.

+

4) The dive list is initially empty. You can now start entering dives in the dive +log or you can download existing dives from your Subsurface cloud +storage account.

+
+
-

5. A Few Remarks About The User Interface

+

4. A Few Remarks About The User Interface

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 +editing dive information, tapping the action button saves the changes while the Android back button can be used to cancel the edit without saving changes.

+

On iOS devices, on screens where a "back" action is enabled, a back arrow +is shown in the top left corner of the screen.

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 +

In order to have a consistent experience between iOS and Android, +Subsurface-mobile on Android does not use the traditional "hamburger" +menu button in the top left or right corner of the screen to open menus. +Instead, 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:

+developed by the Plasma developers. There are three ways to open the main menu:

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

    • @@ -570,7 +598,7 @@ Swipe towards the right across the left edge of the screen

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

    • @@ -582,72 +610,62 @@ Drag the action button visible on most screens with the main action to

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 -

    -
    • -
+the menu that opens if you tap the GPS option on the main menu. On the right is +the menu that opens if you tap the Manage Dives option on the main menu.

+

All screenshots in this user manual are currently from the Android +version. As indicated earlier, the iOS version currently doesn’t support +GPS features.

-

6. Viewing the Dive List

+

5. Viewing the Dive List

Most of the actions of Subsurface-mobile center around the dives on the 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. +being accessed (see image on left, below). Once the list is loaded you 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 +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).

+

You can view other dives by swiping the Details view to the right (for the +previous dive) or to the left (following dive). +Using the Action Bar, it is also possible to delete the dive (tap the dustbin +on the Action Bar) or to view the dive +location on a map viewer (Google Maps on Android, the Google Maps web site +on iOS; tap the GPS icon on the Action Bar.).

-

7. Editing dive details.

+

6. Editing dive details

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 +Tapping the pencil button brings up a panel with edit boxes that allows you 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 action button. Tap this to save the new information. Having saved the data, the dive list screen is -updated and shown. To cancel any edits, tap the Android Back Button.

+updated and shown. To cancel any edits, tap the Android Back Button or +swipe the edit screen up (fling it away).

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

8. Adding a new dive to the dive list

+

7. 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 +

You can manually add a dive to the existing dive list. On the dive list +tap the "plus" sign in the Action Button, or use the +main menu and 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, you +cannot directly add a dive profile from a dive computer. However, if you do 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. @@ -655,70 +673,91 @@ The left-hand image below shows a screenshot of a dive being created and the rig the same dive in Details View.

-FIGURE: Dive edit screen +FIGURE: Manual dive entry screen
-

9. Deleting a dive

+

8. Deleting a dive

-

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.

+

The Details View of a dive has an Action Bar, including a dustbin. If this is tapped, +the dive shown in the Details View is deleted. You have a brief opportunity to undo +the delete by tapping the grey Undo button in the message that appears at the bottom of +the screen (see image below).

+
+
+FIGURE: Undo delete dive +
+
+

You can also delete a dive from the dive list by long-pressing a specific dive +until a red dustbin appears on the right-hand side (see image below). Tap the dustbin. The dive is +deleted without asking any confirmation because Subsurface-mobile assumes that the +combination of a long tap on the dive with another tap on the red dustbin is an unambiguous +instruction to delete the dive.

+
+
+FIGURE: delete dive from list +
+
-

10. Dive log management

+

9. 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 +This provides security against loss or damage to the dive information contained in a local copy of 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:

+through the main menu (by dragging the Action Button to the right, or +alternatively tappping the "Hamburger" icon at the bottom left of the screen). +Tap the option Manage dives, enabling a number of options:

-

10.1. Add new dive manually

+

9.1. Add new dive manually

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

-

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. +

9.2. Sync the dive log with the Subsurface cloud storage

+

You can upload the dives contained on the mobile device +to the Subsurface cloud storage by tapping the option Manual sync with coud. This synchronizes the local changes to -the dive log with the cloud storage.

+the dive log with the cloud storage. It also downloads changes made on +another device or computer and stored in 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.

+

9.3. Working offline or online

+

By default Subsurface-mobile runs offline and only syncs the dive list +with cloud storage when explicily told to do so (see above). +You can choose to always sync with the cloud servers after every +modification of the dive list. This is not recommended unless you are in +an area with fast and reliable internet connection, as otherwise +Subsurface-mobile might appear to hang between operations as it tries to +connect to the cloud server.

-

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, +

9.4. Changing the login credentials on the Subsurface cloud

+

If you need to change your login credentials (for example to work with +multiple accounts) you can open the main menu and tap Cloud credentials. This opens the setup screen for specifying new credentials.

-

11. Recording dive locations using GPS.

+

10. Recording dive locations using GPS (Android only).

-

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 +

The fact that most smartphones have GPS facilities allows +Subsurface-mobile on Android to record +the locations of dives. You can take the smartphone on the dive boat 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:

-

11.1. Setting up the GPS

+

10.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 +in which GPS data need to be automatically collected (image on right, +below). You 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 action button. The program is now ready to collect GPS positions.

@@ -729,17 +768,17 @@ tap the Save action button. The program is now ready to collect GPS pos
-

11.2. Collecting GPS positions

+

10.2. Collecting GPS positions

Ensure that the GPS on the Android device has been activated. At the bottom 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 +following the preferences specified as described above. After return from +the dive trip you can deactivate the collection of GPS data by de-activating the same check box at the bottom of the main menu.

-

11.3. Storing the GPS data on the Subsurface cloud

+

10.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 @@ -747,16 +786,17 @@ 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.

-

11.4. Downloading GPS data from the Subsurface cloud

-

Download the GPS data that have been saved on the cloud by +

10.4. Downloading GPS data from the Subsurface cloud

+

Download the GPS data that have been saved on the cloud (possibly by a +different device) by selecting Download GPS Data from the GPS subpanel.

-

11.5. Viewing GPS data

+

10.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 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 +you tap 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 @@ -769,14 +809,14 @@ options can be hidden by drawing the GPS record to the right, again using the ha

-

11.6. Applying GPS data to dives in the dive log

+

10.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 Subsurface cloud, one can apply the GPS positions to +been downloaded from the Subsurface cloud, you 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 +From the GPS subpanel, tap GPS-tag dives. 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 list.

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

@@ -784,7 +824,7 @@ in a GPS position for each dive that is saved as part of the dive list.