From 97c7fad53dc1a8eeaad41a4a5efd5feff4e455b5 Mon Sep 17 00:00:00 2001 From: Dirk Hohndel Date: Sun, 22 Mar 2020 18:52:58 -0700 Subject: Subsurface-mobile v3 user manual While this is based in large parts on the existing manual, it is a fairly substantial rewrite with mostly new screenshots. Includes edits by Rainer Mohr. Signed-off-by: Dirk Hohndel --- Documentation/Makefile | 2 +- Documentation/compact_subsurface.css | 2 +- Documentation/mobile-images/ActionButton.jpg | Bin 0 -> 6820 bytes Documentation/mobile-images/DiveDetailsEdit.jpg | Bin 0 -> 34662 bytes Documentation/mobile-images/DiveListAndDetails.jpg | Bin 0 -> 86247 bytes Documentation/mobile-images/DiveSiteMap.jpg | Bin 0 -> 44040 bytes Documentation/mobile-images/FilteredDivelist.jpg | Bin 0 -> 77457 bytes Documentation/mobile-images/GPSConfig.jpg | Bin 0 -> 7467 bytes Documentation/mobile-images/GeneralSettings.jpg | Bin 0 -> 20780 bytes Documentation/mobile-images/LocationMenu.jpg | Bin 0 -> 25001 bytes Documentation/mobile-images/ManualAddDive.jpg | Bin 0 -> 32098 bytes .../Subsurface-mobile-menu-system.jpg | Bin 0 -> 30793 bytes Documentation/mobile-images/ThemeSettings.jpg | Bin 0 -> 21691 bytes Documentation/mobile-images/UndoDelete.jpg | Bin 0 -> 23238 bytes Documentation/mobile-manual-v3.html.git | 1199 ++++++++++++++++++++ Documentation/mobile-manual-v3.txt | 689 +++++++++++ 16 files changed, 1890 insertions(+), 2 deletions(-) create mode 100644 Documentation/mobile-images/ActionButton.jpg create mode 100644 Documentation/mobile-images/DiveDetailsEdit.jpg create mode 100644 Documentation/mobile-images/DiveListAndDetails.jpg create mode 100644 Documentation/mobile-images/DiveSiteMap.jpg create mode 100644 Documentation/mobile-images/FilteredDivelist.jpg create mode 100644 Documentation/mobile-images/GPSConfig.jpg create mode 100644 Documentation/mobile-images/GeneralSettings.jpg create mode 100644 Documentation/mobile-images/LocationMenu.jpg create mode 100644 Documentation/mobile-images/ManualAddDive.jpg create mode 100644 Documentation/mobile-images/Subsurface-mobile-menu-system.jpg create mode 100644 Documentation/mobile-images/ThemeSettings.jpg create mode 100644 Documentation/mobile-images/UndoDelete.jpg create mode 100644 Documentation/mobile-manual-v3.html.git create mode 100644 Documentation/mobile-manual-v3.txt (limited to 'Documentation') diff --git a/Documentation/Makefile b/Documentation/Makefile index e2771465f..55671b09a 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -7,7 +7,7 @@ # submitting patches to the user manual, only submit the changes to the .txt # file - the maintainer will recreate the .html.git file -DOCNAMES = user-manual user-manual_es user-manual_fr user-manual_ru user-manual_nl mobile-manual +DOCNAMES = user-manual user-manual_es user-manual_fr user-manual_ru user-manual_nl mobile-manual mobile-manual-v3 HTMLDOCS = $(patsubst %,$(OUT)%.html,$(DOCNAMES)) TEXTDOCS = $(patsubst %,$(OUT)%.text,$(DOCNAMES)) diff --git a/Documentation/compact_subsurface.css b/Documentation/compact_subsurface.css index abc87d12e..8c2f9c94d 100644 --- a/Documentation/compact_subsurface.css +++ b/Documentation/compact_subsurface.css @@ -8,7 +8,7 @@ */ * { padding: 0; margin: 0; } -img { border: 0; } +img { border: 0; margin: 15px; } /*** Layout ***/ diff --git a/Documentation/mobile-images/ActionButton.jpg b/Documentation/mobile-images/ActionButton.jpg new file mode 100644 index 000000000..981020dbe Binary files /dev/null and b/Documentation/mobile-images/ActionButton.jpg differ diff --git a/Documentation/mobile-images/DiveDetailsEdit.jpg b/Documentation/mobile-images/DiveDetailsEdit.jpg new file mode 100644 index 000000000..5aebb0bcb Binary files /dev/null and b/Documentation/mobile-images/DiveDetailsEdit.jpg differ diff --git a/Documentation/mobile-images/DiveListAndDetails.jpg b/Documentation/mobile-images/DiveListAndDetails.jpg new file mode 100644 index 000000000..ecd472420 Binary files /dev/null and b/Documentation/mobile-images/DiveListAndDetails.jpg differ diff --git a/Documentation/mobile-images/DiveSiteMap.jpg b/Documentation/mobile-images/DiveSiteMap.jpg new file mode 100644 index 000000000..f8c8e96bf Binary files /dev/null and b/Documentation/mobile-images/DiveSiteMap.jpg differ diff --git a/Documentation/mobile-images/FilteredDivelist.jpg b/Documentation/mobile-images/FilteredDivelist.jpg new file mode 100644 index 000000000..b4d34cc8a Binary files /dev/null and b/Documentation/mobile-images/FilteredDivelist.jpg differ diff --git a/Documentation/mobile-images/GPSConfig.jpg b/Documentation/mobile-images/GPSConfig.jpg new file mode 100644 index 000000000..0f757a7b6 Binary files /dev/null and b/Documentation/mobile-images/GPSConfig.jpg differ diff --git a/Documentation/mobile-images/GeneralSettings.jpg b/Documentation/mobile-images/GeneralSettings.jpg new file mode 100644 index 000000000..6f8a8fd99 Binary files /dev/null and b/Documentation/mobile-images/GeneralSettings.jpg differ diff --git a/Documentation/mobile-images/LocationMenu.jpg b/Documentation/mobile-images/LocationMenu.jpg new file mode 100644 index 000000000..dc0b6a976 Binary files /dev/null and b/Documentation/mobile-images/LocationMenu.jpg differ diff --git a/Documentation/mobile-images/ManualAddDive.jpg b/Documentation/mobile-images/ManualAddDive.jpg new file mode 100644 index 000000000..71a5775e5 Binary files /dev/null and b/Documentation/mobile-images/ManualAddDive.jpg differ diff --git a/Documentation/mobile-images/Subsurface-mobile-menu-system.jpg b/Documentation/mobile-images/Subsurface-mobile-menu-system.jpg new file mode 100644 index 000000000..dd80c2f15 Binary files /dev/null and b/Documentation/mobile-images/Subsurface-mobile-menu-system.jpg differ diff --git a/Documentation/mobile-images/ThemeSettings.jpg b/Documentation/mobile-images/ThemeSettings.jpg new file mode 100644 index 000000000..d5a990add Binary files /dev/null and b/Documentation/mobile-images/ThemeSettings.jpg differ diff --git a/Documentation/mobile-images/UndoDelete.jpg b/Documentation/mobile-images/UndoDelete.jpg new file mode 100644 index 000000000..0f46010b9 Binary files /dev/null and b/Documentation/mobile-images/UndoDelete.jpg differ diff --git a/Documentation/mobile-manual-v3.html.git b/Documentation/mobile-manual-v3.html.git new file mode 100644 index 000000000..f6c0a43bf --- /dev/null +++ b/Documentation/mobile-manual-v3.html.git @@ -0,0 +1,1199 @@ + + + + + + + + + + + + +
+
+
+Banner +
+
+

Subsurface-mobile User Manual

+

Manual authors: Willem Ferguson, Dirk Hohndel

+

Version 3.0.0, March 2020

+
+

1. Introducing Subsurface-mobile

+
+

Welcome to Subsurface-mobile, the mobile version of Subsurface, advanced dive logging +software with extensive infrastructure to describe, organize, and interpret scuba +and free dives. Subsurface runs on Windows, macOS, most common distributions of Linux. +Subsurface-mobile is available for Android and iOS. Both are +open-source software (in simple terms that means that there is no commercial interest behind +them, all the sources code needed to build them is available, there are no ads, no one is +monetizing your data, etc).

+

Subsurface-mobile is a limited mobile version of Subsurface +aimed at Android and iOS smartphone and tablet devices. +While the desktop version of Subsurface shows much more detailed information +for each dive, the mobile version allows a more accessible dive log on the go, for example +on a dive trip, useful for proving dive experience to dive shops or to review +previous dives. Subsurface-mobile also allows +the gathering of GPS locations where dives are performed. +Assuming you have a dive computer that is supported by the mobile OS of +your choice, Subsurface-mobile even supports the downloading of dive +information.

+

Users of Subsurface-mobile typically use the +mobile app together with the desktop version of Subsurface, sharing dive information +between the mobile and the desktop versions using a free Subsurface Cloud account. +However Subsurface-mobile can +also be used independently of the desktop version and does not require the use of cloud storage.

+

Subsurface-mobile allows:

+
    +
  • +

    +Download and storage of dive log information using the Subsurface cloud. +

    +
    • +
  • +

    +Viewing this information on a mobile device. +

    +
    • +
  • +

    +Manually creating and adding new dive records to your dive log. +

    +
    • +
  • +

    +Download dive data directly from some dive computers. +

    +
    • +
  • +

    +Editing most of the dive log data, e.g. dive-master, buddy, + equipment or notes relating to a dive. +

    +
    • +
  • +

    +Recording, storing and applying GPS positions of dives. +

    +
    • +
  • +

    +Viewing the locations of recorded GPS positions and of dives + on a map. +

    +
    • +
+

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

+

Subsurface-mobile has some limitations compared to Subsurface:

+
    +
  • +

    +Only a subset of the dive computers supported for download by the desktop +version work with Subsurface-mobile. This limitation is +mainly caused by hardware and OS limitations in the two +two mobile platforms. On Android, a subset of +dive computers that use USB serial cables or a Bluetooth / Bluetooth LE interface +are accessible by Subsurface-mobile. On iOS, only Bluetooth LE based +dive computers are supported. +

    +
    • +
  • +

    +No dive planner. +

    +
    • +
  • +

    +No printing. +

    +
    • +
  • +

    +No support for media embedded in dive profiles (Subsurface allows to refernce images and video clips directly in the dive profile). +

    +
    • +
+
+
+
+

2. Installing Subsurface-mobile on your mobile device

+
+

Find Subsurface-mobile in the Google Play Store or the iTunes Store +and install it. For Android devices without access to the Google Play Store +APKs can be found in the downloads folder on the Subsurface website.

+
+
+
+

3. Getting Support

+
+

The best place to get support is the Subsurface User Forum. Additionally, Subsurface-mobile allows +you to send a support email by tapping on Ask for support in the Help menu. This will open an +email to our in app support address in the native email client, including the relevant logs.

+
+
+
+

4. User Interface

+
+

Subsurface-mobile uses the same user interface philosophy on both Android and iOS, based on an +open source project called Kirigami that is maintained by the KDE/Plasma development community. +This user interface has a slightly different look and feel than many native Android and iOS apps, +but we (the developers) feel that it is very easy and intuitive to work with.

+

On every screen you have access to the Main menu through a Hamburger button (three short +horizontal lines) in the lower left corner. Additionally, the Main menu can be opened by swiping +towards the the right across the left edge of the screen. The entries in the main menu are all explain +starting in section Dive Management

+

On many pages there is also a Context menu available through a button with three vertical dots in +the lower right corner. +In the dive list this Context menu can also be opened by tapping and holding a dive or trip header.

+
+
+FIGURE: Action Button +
+
+

Additionally, at the bottom of many Subsurface-mobile screens is a round +Action button that provides quick access to the most commonly needed +actions on that screen (see image on the left). On some screens there is only +the round center button enabled, on others there are one or two additional +actions available on either side of that center button.

+
+

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 while the +Android back button can be used to cancel the edit without saving changes.

+

The image below indicates some of the important features of the menu system. +On the left is the main menu, activated as described above. On the right of the image +are the items of all the sub-menus accessible.

+
+
+FIGURE: Subsurface-mobile menu system +
+
+

All screenshots in this user manual are currently from the Android +version. The iOS screens look similar.

+
+
+
+

5. Using Subsurface-mobile for the first time

+
+

When you start Subsurface-mobile for the first time, a Subsurface +splash screen is shown while the program loads. On some devices this +may take several seconds. Afterwards the Cloud Credentials screen appears +m(see image below on left).

+
+
+FIGURE: Mobile credentials screen +
+
+
+

5.1. Using Subsurface-mobile without Cloud Storage

+

Tap the "No cloud mode" button. The app will only store dive log information locally +on your device. After the first start the dive log will therefore be empty.

+
+
+

5.2. Using Cloud Storage

+

The Subsurface maintainer provides a dedicated and +free Internet cloud storage account for users of Subsurface and Subsurface-mobile. +You can use this to store your dive log and to share your data between various computers +and devices. The Subsurface team never accesses your dive data without explicit +permission to do so, the data are not used for any purpose other than providing them to the user who +created them. There are no ads and no harvesting / analysis of the data +stored in the Subsurface Cloud storage. There is no monetization whatsoever.

+

Subsurface-mobile is sufficient to do full maintenance of a dive log. In addition you can use the +more advanced features in Subsurface when you have access to a computer while still +being able to work with your dive data when only a mobile device is available.

+

The dive data in the cloud are cached locally on any device or computer that is connected to +the Subsurface Cloud account. +It is easy to create backups of the data (for example in XML format) on the desktop: both mobile +device and desktop keep a local copy of the data so that the dive log is always accessible, even +without Internet connection.

+

To create a Subsurface Cloud account follow these steps:

+

1) Enter an e-mail address and a password in the fields indicated on the screen (see image above). +The e-mail address should be in lower case and the password should contain a combination of +upper and lower case letters and/or numbers.

+

2) Tap the "Sign-in or Register" button.

+

If you have already set +up an account on a different computer or device, simply enter the same credentials here. +Subsurface-mobile will now download your existing dive log data. Once the dive +list has been downloaded from the cloud, Subsurface-mobile usually works only with the the local +copy on the mobile device. This avoids long delays or even failure of operations if there is a bad +(or no) internet connection, a situation fairly common at many dive sites. Remember to manually sync +with the server after making local changes (either by pulling down on the dive list, or by using the +manual sync entry in the Dive management menu entry).

+

3) If this is a new cloud account, a PIN screen will open (see image on right, above). A PIN is e-mailed +to the email address entered in the previous step. Enter this PIN into the field indicated +and tap the Register button. After the PIN has been entered it +is no longer needed - it just proves that this is indeed your email account.

+

At this point a new account for you has been created on the cloud server and access to the cloud is +enabled. In this case the dive list is initially empty. Start entering dives in the dive +log or download dive information from a supported dive computer.

+

Once registered, Subsurface-mobile remembers the cloud credentials and it is not necessary to +provide these again when launching the program.

+
+
+
+ + + +
+Important +Cloud problems: FAQ
+
+

After filling in the correct information and submitting it, I did not receive a PIN by email

+
    +
  1. +

    +Check carefully that didn’t make a spelling mistake in the email address you provided. You would be surprised how often this is the problem that people encouter, as autocorrect often mangles email addresses. +

    +
    2. +
  2. +

    +Check that the return email containing the PIN is not in the SPAM folder of your email client. +

    +
    3. +
  3. +

    +Wait for a few hours and check again for an email with a PIN. +

    +
    4. +
  4. +

    +If there is still no email containing a PIN, send mail to in-app-support@subsurface-divelog.org +

    +
    5. +
+

I want to access the Subsurface Cloud storage but I have forgotten my password. How can I reset my password?

+

There is a Reset forgotten Subsurface Cloud password entry in the Help menu in Subsurface-mobile, or you can go to the following web address: https://cloud.subsurface-divelog.org/passwordreset

+

Simply enter the same email address that you used during cloud registration and follow the indicated steps. A confirmation email will be sent to your account to prevent abuse of this system.

+
+
+
+
+
+

6. The Dive List

+
+

Most of the actions of Subsurface-mobile center around the dives in 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, after which the dive list is shown. Once the list is loaded you can scroll up +and down through your dive history. +Subsurface typically structures your dive list by dive trips, but using those is optional +(and for divers who are lucky enough to be able to dive all the time at local dive sites, +trips might only make sense for dive vacations).

+

Two Dive Management actions are available by tapping on the +action buttons at the bottom of the Dive List page: +To Download dives from a dive computer, tap the main action button. If you wish +to Manually add a dive, tap the + button in the action bar. Both of these +actions are described in detail below.

+

Tapping an existing dive on the list brings up a display of the Details View +for that dive including the dive profile, notes, and additional information.

+
+
+FIGURE: Dive list screen +
+
+

A tap and hold on a dive or a trip header opens the context menu for that entry.

+

For a dive this allows moving the dive into or out of trips or between trips, deleting +the dive or showing the dive on an integrated map viewer (assuming the dive has the +necessary GPS information). The context menu also allows access to the undo and redo +system that allows you to step backwards and forwards through recent actions.

+

For a trip header the context menu gives you an option to edit the trip title (typically +the trip location) and some quick notes for the trip.

+
+

6.1. Filter the dive list

+
+
+
+FIGURE: Filter button +
+
+

The left action button shows three horizontal lines of declining length, symbolizing a filter. +When you tap this button, a text entry line appears at the top of screen which will allow you to +enter a filter search term that is either used in a full text search, a search just of the people +involved in a dive (in the Divemaster and Buddy fields), or a search of the tags you have used +to classify your dives. Tapping the filter button again clears the filter and shows the full +dive list.

+
+
+FIGURE: Filter tool +
+
+
+
+

6.2. View a dive

+

When you tap on a dive in the Dive List, a Dive Details page with the dive profile +and many important details about the dive is opened. You can use a pich gesture +to zoom into the profile, and tapping with one finger, waiting briefly until +the profile becomes translucent, and then dragging the finger around allows you +to pan the profile and see more details in specific parts of the profile.

+

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 an integrated map viewer.

+

The context menu (accessible by tapping on the vertical three dots in the lower right corner of the +screen) offers additional options to move dives between trips, the same delete and map options +already mentioned, and access to the undo and redo facility that allows you to step backwards and +forwards through recent actions.

+
+
+

6.3. Viewing the location of a dive on a map

+
+
+FIGURE: Map of dive site +
+
+

In the Details View, you can either tap the Map it button on top of the +page to the right of the dive site name, or the GPS pin on the +left hand side of the Action Button at the bottom of the screen. +The dive site is shown in an integrated map viewer.

+
+
+

6.4. Edit a dive

+
+
+FIGURE: Dive edit screen +
+
+

At the bottom of the Dive Details screen the action button is a pencil. +Tapping the pencil button changes the page and enables edit boxes that allow +modifying 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 on left). +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, after which the dive list screen is +updated and shown. To cancel any edits, tap the Android Back Button or +the application back button at the top left of the screen on iOS.

+
+
+

6.5. Deleting a dive

+

You can delete a dive from the dive list by long-pressing a dive and selecting delete in the context menu. +You can also delete a dive from the Details View by tapping on the trash can icon on the right +side of the Action Button

+

If you deleted the wrong dive by mistake you can easily undo the operation in the context menu.

+
+
+FIGURE: Undo delete dive +
+
+
+
+
+
+

7. Dive Managent

+
+

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 of the dive information in a local copy +and allows the desktop version of Subsurface to +access changes made using the mobile device. This ability is accessed +through the Dive management option in the main menu.

+
+

7.1. Manually adding a new dive to the dive list

+

You can manually add a dive to the existing dive list. On the dive list +tap the "plus" sign in the action bar, or use the +main menu and tap Dive management → 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 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: Manual dive entry screen +
+
+
+
+

7.2. Download dives from a dive computer

+

There are several ways to get to the Download Page. You can either tap on the main Action Button on +the bottom of the Dive List, or you can select Dive management → Download from DC in the main menu. +On Android devices, when you plug in a USB serial cable for a dive computer, the Download Page will be +opened automatically.

+

The download feature in smartphones supports only a limited number of dive computers. On +Android devices these are typically dive computers using a serial USB interface +using a USB OTG cable or a simple USB C-A adapter on newer devices. +Android devices also support Bluetooth dive computers that +are supported in Subsurface on the desktop. Both Android and iOS devices allow direct +download of dive data from a handful of Bluetooth LE enabled dive +computers.

+

Use the Vendor name and Dive Computer drop-downs to pick the correct +dive computer. +For instance, when using a Shearwater Petrel dive +computer, the vendor is Shearwater and the product is Petrel(see image on the left, below).

+

When downloading from multiple different dive computers, shortcut +buttons appear below the drop-downs to easily switch between them. In the Settings menu +you can remove these buttons, a useful feature for removing buttons of dive +computers that you do not use any more. Achieve this by selecting the option +Forget remembered dive computers in the Settings menu.

+
+

7.2.1. Download from USB serial dive computers

+

This feature is not supported on iOS.

+
+ +++ + + + + + +
+
+FIGURE: USB-OTG cable +
+

Most current Android devices now have a USB +Type C port and come with a simple A-to-C adapter plug, which allows to plug in +the dive computer cable into the phone or tablet. +For older Android devices with micro USB connector you will need to plug the USB +cable used with the dive computer into a USB OTG cable which, +in turn, plugs into the micro-USB port. +The OTG cable usually has a full-size ("Type A") female receptacle at one end which +accommodates the full-sized male plug +of the dive computer USB cable (see image below). This means that two cables are used to connect +the dive computer to the mobile device. Not all Android devices support OTG cables +but usually all modern Android devices with a USB C plug can be used with a USB A-to-C adapter.

+
+

Subsurface-mobile remembers the settings for dive computers that +have been successfully used (image on right, below). These appear +as buttons under a heading "Previously used dive computers". +Select the appropriate button. Having connected the USB dive computer to the +Subsurface computer and having selected the appropriate vendor and dive computer, +ensure that the Connection text box shows the corresponding connection. For a small number of dive +computers the connection name shows the dive computer vendor, for most only the cable chipset vendor +(and USB connection number) is shown. Most users of course only connect one USB dive computer to +their Android device and then things are fairly straight forward. A dialog will pop up and ask if +you want to use Subsurface-mobile to connect to the device. If you confirm, then Subsurface-mobile will +open to the dive computer download screen with the correct connection selected (and if it can deduce +the correct dive computer based on the cable used, even that information is already pre-filled).

+
+
+

7.2.2. Download from BT/BLW dive computers

+

The process for Bluetooth download is slightly different between Android and iOS.

+

In our testing we got the best results on iOS when the dive computer was +in Bluetooth mode before Subsurface-mobile is started. On most dive +computers this is done through a menu entry, others (like the Suunto +models) always respond to Bluetooth LE requests. However, on Android devices, +you should first establish a link between the +Bluetooth or Bluetooth LE dive computer and the mobile device using +Android utilities. See below for more details.

+

For Bluetooth-equipped dive computers and Android devices, establish a Bluetooth connection between the dive computer and the +mobile device using Android system tools to achieve pairing. +For many Android devices, +the Settings → Bluetooth tool of Android is probably appropriate. +Subsurface-mobile performs communication using both Bluetooth and Bluetooth-low-energy (BLE). +The appropriate choice of Bluetooth communication is often made by the software and the user need not be concerned with this. +For dive computers with both Bluetooth and BLE, a separate button is presented on the download +screen for each mode of communication, allowing a choice. Use the Connection value to distinguish between the +two options. In the image on the right, below, there are three buttons labeled "Shearwater Petrel 2". These represent two Shearwater Petrel dive computers, one of which can communicate in both Bluetooth as well as BLE. The Connection +information indicates that the Petrel with no BLE is selected.

+
+
+

7.2.3. Start the download

+

With communication between dive computer and Subsurface-mobile +having been set up, tap the Download button. Be patient because the download can take a while - with many +long dives and a slow BLE connection we have seen download times of 45 minutes or longer. But usually downloading +a day’s worth of diving happens reasonably quickly. +The downloaded dives appear in the bottom part of the screen, +the most recent dive at the top (see image on right, below).

+

Each dive has a check-box on the left hand side, used for selecting which dives you want to add to the +Subsurface-mobile dive list: dives that are not checked are ignored. Once you picked the dives +you want to add to the dive list, tap the button at the bottom left labeled Accept. The selected dives will +now appear as part of +the Subsurface-mobile dive list. The downloaded dive information can be edited as described in the section +above Edit a dive.

+
+
+FIGURE: DC download screen +
+
+
+
+
+

7.3. Apply GPS fixes

+

This is described in the following main section, below.

+
+
+

7.4. Manually sync the dive log with the Subsurface Cloud

+

As the name indicates, this ensures that the local changes on the mobile device and changes +made by other devices and computers to the data stored in the Subsurface Cloud are synchronized. +It is highly recommended to sync with cloud storage after downloading new dives from a dive computer +or manually adding or editing dive information on the mobile device.

+

This can also be triggered by pulling down (and briefly holding) the Dive List.

+
+
+

7.5. Enable cloud auto sync

+

By default Subsurface-mobile runs offline and only syncs the dive list +with cloud storage when explicitly told to do so (see the previous entry above). +You can choose to always sync with the cloud servers. This is not +recommended unless you are in +an area with a fast and reliable internet connection, as otherwise +Subsurface-mobile might appear to hang between operations as it tries to +connect to the cloud server. Selecting Enable cloud auto sync causes +the local dive log to be synchronized with the copy in the cloud after most changes as well +as (on Android) every time that Subsurface-mobile is closed. iOS doesn’t support the concept +of closing an app (you can just kill it, which doesn’t allow for a final sync with the cloud). +In general it is safer to manually sync with the cloud once you are done making changes in +Subsurface-mobile.

+
+
+

7.6. Dive Summary

+

The Dive Summary page provides a very simple overview of your diving activities - which can for example +be useful when documenting total dive experience and recent dive activity for a dive center at +the beginning of a dive trip.

+

The summary page lists the date of your first dive in the dive list as well as your most recent dive. +It also provides two columns of data for selectable time ranges (by default all dives in the dive list +and the dives during the last six months.

+
+
+

7.7. Export

+

The Export feature is somewhat experimental. On Andtoid it only allows the upload of your dive list +to two websites (divelogs.de and diveshare). On iOS it also allws local file based exports as Subsurface +specific XML files (both for dives and dive sites) as well as UDDF.

+

Tapping on Next opens an additional page for login information (or a file selection dialog).

+
+
+
+
+

8. Location

+
+

The fact that almost all smartphones have GPS facilities allows +Subsurface-mobile to record +the locations of dives. IMPORTANT: GPS-derived coordinates on a smartphone +are not always accurate and can have an error greater than 1 km. GPS accuracy +is determined by the hardware and software of the +smartphone as well as by the GPS settings selected within Android/iOS. +As of Android V6 select Android Settings → Communication → Location → High accuracy. +If the smartphone is taken on the boat +during a dive, 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:

+
+

8.1. Configuring the GPS service

+

From the Main Menu, select Settings screen which has a section for +configuring the GPS service (image below). GPS location data +are collected at regular intervals, e.g. every 5 minutes, or at regular +distances, e.g. after the boat has moved more than 200m, or a combination of +both of these approaches. Provide the appropriate information and +tap the Back button. The program is now ready to collect GPS positions.

+
+
+FIGURE: GPS configure +
+
+
+
+

8.2. Collecting GPS positions

+
+ +++ + + + + + +
+
+FIGURE: GPS start +
+

In the Location menu select Run location service. +Subsurface-mobile starts to collect GPS locations automatically, +following the preferences specified as described above. While the GPS +location service is running, all menus have a GPS symbol at the bottom +of the menu, indicating that the service is active. After return from +the dive trip, deactivate the collection of GPS data by tapping +the option GPS → Disable location service. The GPS symbol at the bottom +of all menus disappears.

+

Collecting GPS fixes like this is relatively battery intensive and unfortunately +both Android and especially iOS have become increasingly aggressive in killing +applications that are running while the screen is turned off. It may make sense +to check between dives that the location service is still running.

+
+
+
+

8.3. Viewing GPS data

+

From the Location menu select Show GPS fixes. This brings +up a list of GPS positions obtained by the location service (image +below). Two actions are possible for each of the locations, enabled by +dragging the right part of a location to the left. This exposes two +options. Tapping the dustbin deletes this particular GPS location. Tapping the +GPS map pin opens up Google Maps with a pin +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.

+
+
+FIGURE: GPS management +
+
+
+
+

8.4. Applying GPS data to dives in the dive log

+

After running the location service during a dive trip, first either download +the dives from your divecomputer or manually enter the dives into the dive list. +Now you can apply the GPS positions to these dives. +From the Dive management menu, 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.

+
+
+

8.5. Viewing the locations of all dives in the dive list

+
+
+FIGURE: Map of all dive sites +
+
+

The locations of all dives in the dive list can be viewed from the Location menu by selecting the Map option. +A satellite image of the world is shown. At that scale no dive sites are shown. If you zoom into a particular region +of the world the dive sites appear, indicated by red flags. Zooming in even closer indicates the names of each +of the different dive sites.

+
+
+
+
+

9. Settings

+
+

The Settings page allows the customization of Subsurface-mobile. +It is grouped into four sections.

+
+

9.1. General settings section

+
+

9.1.1. Changing to a different Subsurface cloud account

+

Some users have more than one Subsurface cloud account and have a need to switch between accounts. +Tap on the Change button next to the Email address in the General settings on the Settings page. +This opens the Cloud credentials page. +Here you can change the email address and password used and then tap the button Sign-in or register. +The appropriate dive list is shown.

+
+
+

9.1.2. Default cylinder

+

When manually entering a dive or when downloading from a dive computer that doesn’t explicitly +include cylinder size information (very few dive computers support that feature), Subsurface-mobile +uses the cylinder that you select here as the default. If you don’t set this entry, no default +cylinder is used.

+
+
+

9.1.3. Forget the remembered dive computers

+

Tap the Forget button to reset the dive computers that are stored in the up to four shortcut +buttons on the Download from dive computer page.

+
+
+
+

9.2. Theme section

+
+
+FIGURE: Settings: Cloud & Theme +
+
+
+

9.2.1. Color theme

+
+ +++ + + + + + +
+
+FIGURE: GPS start +
+

Besides the default blue color scheme, Subsurface-mobile supports two additional color schemes +for users with different tastes (see image above). All screenshots in this user manual shows are +based on the the blue default color scheme. You can pick the pink or dark color scheme from +the drop down menu.

+

The boxes below show the various color choices in the theme of your choice.

+
+
+
+

9.2.2. Font size

+

Depending on the size and the screen resolution of your mobile device, you may prefer slightly +smaller or slightly larger fonts. You can make this selection with the three buttons here.

+
+
+
+

9.3. Units section

+

Here you can pick metric, imperial, or personalized units for the user interface. +In most cases Subsurface-mobile should pick the regionally typical unit system for +your location.

+
+
+

9.4. Advanced section

+

As the name indicates, most users will not need to make changes here.

+
+

9.4.1. GPS location service thresholds

+

As indicated above in the Location section of this manual, here you can set the distance and time +thresholds for the location service

+
+
+

9.4.2. Bluetooth

+

Since most devices tend to find a LOT of BT/BLE devices that aren’t dive computers, by +default Subsurface-mobile only shows known dive computers to make the connection list +easier to use.

+

This setting tells Subsurface-mobile to temporarily show ALL Bluetooth and BLE devices as +possible connections on the Download Page, not just the ones recognized as dive computers. +If you end up needing this option in order to select a dive computer that is not recognized +by Subsurface-mobile, please send an email to the developers (using the Help → Ask for support +menu entry) so we can add the missing code to recognize your dive computer as well.

+
+
+

9.4.3. Display

+

Subsurface-mobile tries to make efficient use of the available screen real estate of your +mobile device. In most cases this leads to reasonable choices regarding the number of parallel +columns that are being displayed. Some users have expressed the desire to force Subsurface-mobile +to show only one column in portrait mode, even on large devices like tablets, as this results +in a larger profile on the Dive Details page. Select this option if you want to enable that +feature.

+
+
+

9.4.4. Activating the Developer sub-menu

+

This enables an additional menu item in the Main menu which contains options which are almost +never useful for a regular users. Here you can find the detailed app log file as well as several +test screens that help the developers track down issues you might encounter.

+
+
+
+
+
+

10. Help

+
+
+

10.1. About

+

This page shows you the exact version of Subsurface-mobile that you are running and provides +a convenient way to copy the application logs to the clipboard.

+
+
+

10.2. Show user manual

+

This menu entry opens the online version of this user manual in the native browser of your +device. Unfortunately this option isn’t available if your device is offline.

+
+
+

10.3. Ask for support

+

This item opens your default email client with a pre-populated email to the Subsurface +support alias and copies the app logs into that email. Simply add your question or the +but that you are reporting and send us your message.

+
+
+

10.4. Reset forgotten Subsurface Cloud password

+

As mentioned earlier in this manual, this is a convenient link to a web page that allows +you to reset the password for your Subsurface Cloud account.

+
+
+
+
+
+ + + diff --git a/Documentation/mobile-manual-v3.txt b/Documentation/mobile-manual-v3.txt new file mode 100644 index 000000000..a0b0e5ae7 --- /dev/null +++ b/Documentation/mobile-manual-v3.txt @@ -0,0 +1,689 @@ + +// Subsurface-mobile User Manual +// ============================= +// :author: Manual authors: Willem Ferguson, Dirk Hohndel +// :revnumber: 3.0.0 +// :revdate: March 2020 +:icons: +:toc: +:toc-placement: manual +:numbered: +// :website: http://subsurface-divelog.org + +image::mobile-images/Banner.jpg["Banner",align="center"] + +[big]#_Subsurface-mobile_ User Manual# + +*Manual authors*: Willem Ferguson, Dirk Hohndel + +// toc::[] + +[blue]#_Version 3.0.0, March 2020_# + +Introducing _Subsurface-mobile_ +----------------------------- + +Welcome to _Subsurface-mobile_, the mobile version of _Subsurface_, advanced dive logging +software with extensive infrastructure to display, organize, and interpret scuba +and free dives. _Subsurface_ runs on Windows, macOS, most common distributions of Linux. +_Subsurface-mobile_ is available for Android and iOS. Both are +open-source software (in simple terms that means that there is no commercial interest behind +them, all the source code needed to build them is available, there are no ads, no one is +monetizing your data, etc). + +_Subsurface-mobile_ is a limited mobile version of _Subsurface_ +aimed at Android and iOS smartphone and tablet devices. +While the desktop version of _Subsurface_ shows much more detailed information +for each dive, the mobile version allows a more accessible dive log on the go, for example +on a dive trip, useful for proving dive experience to dive shops or to review +previous dives. _Subsurface-mobile_ also allows +the gathering of GPS locations where dives are performed. +Assuming you have a dive computer that is supported by the mobile OS of +your choice, _Subsurface-mobile_ even supports the downloading of dives from your dive computer. + +Users of _Subsurface-mobile_ typically use the +mobile app together with the desktop version of _Subsurface_, sharing dive information +between the mobile and the desktop versions using a free _Subsurface Cloud_ account. +However _Subsurface-mobile_ can +also be used independently of the desktop version and does not require the use of cloud storage. + +_Subsurface-mobile_ allows: + +- Download and storage of dive log information using the _Subsurface_ cloud. +- Viewing this information on a mobile device. +- Manually creating and adding new dive records to your dive log. +- Download dive data directly from some dive computers. +- Editing most of the dive log data, e.g. dive-master, buddy, + equipment or notes relating to a dive. +- Recording, storing and applying GPS positions to dives. +- Viewing the locations of recorded GPS positions and of dives + on a map. + +These items are discussed in greater detail in the following text. + +_Subsurface-mobile_ has some limitations compared to _Subsurface_: + +- Only a subset of the dive computers supported for download by the desktop +version work with _Subsurface-mobile_. This limitation is +mainly caused by hardware and OS limitations in the +two mobile platforms. On Android, a subset of +dive computers that use USB serial cables or a Bluetooth / Bluetooth LE interface +are accessible by _Subsurface-mobile_. On iOS, only Bluetooth LE based +dive computers are supported. +- No dive planner. +- No printing. +- No support for media embedded in dive profiles (_Subsurface_ allows to refernce images and video clips directly in the dive profile). + +== Installing _Subsurface-mobile_ on your mobile device + +Find _Subsurface-mobile_ in the _Google Play Store_ or the _iTunes Store_ +and install it. For Android devices without access to the _Google Play Store_ +APKs can be found in the downloads folder on the _Subsurface_ website. + +== Getting Support + +The best place to get support is the _Subsurface_ User Forum. Additionally, _Subsurface-mobile_ allows +you to send a support email by tapping on _Ask for support_ in the _Help_ menu. This will open an +email to our in-app-support address in the native email client, including the relevant logs. + +== User Interface + +_Subsurface-mobile_ uses the same user interface philosophy on both Android and iOS, based on an +open source project called _Kirigami_ that is maintained by the _KDE/Plasma_ development community. +This user interface has a slightly different look and feel than many native Android and iOS apps, +but we (the developers) feel that it is very easy and intuitive to work with. + +On every screen you have access to the _Main menu_ through a _Hamburger_ button (three short +horizontal lines) in the lower left corner. Additionally, the _Main menu_ can be opened by swiping +towards the the right from the very left edge of the screen. The entries in the main menu are all explained +starting in section xref:S_DiveManagement[_Dive Management_] + +On many pages there is also a _Context menu_ available through a button with three vertical dots in +the lower right corner. +In the dive list this _Context menu_ can also be opened by tapping and holding a dive or trip header. + +image::mobile-images/ActionButton.jpg["FIGURE: Action Button",float="left"] +Additionally, at the bottom of many _Subsurface-mobile_ screens is a round +_Action button_ that provides quick access to the most commonly needed +actions on that screen (see image on the left). On some screens there is only +the round center button enabled, on others there are one or two additional +actions available on either side of that center button. + +unfloat::[] + +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 while the +Android back button can be used to cancel the edit without saving changes. + +The image below indicates some of the important features of the menu system. +On the left is the main menu, activated as described above. On the right of the image +are the items of all the sub-menus available. + +image::mobile-images/Subsurface-mobile-menu-system.jpg["FIGURE: Subsurface-mobile menu system",align="center"] + + +All screenshots in this user manual are currently from the Android +version. The iOS screens look similar. + +== Using _Subsurface-mobile_ for the first time + +When you start _Subsurface-mobile_ for the first time, a _Subsurface_ +splash screen is shown while the program loads. On some devices this +may take several seconds. Afterwards the _Cloud Credentials screen_ appears +(see image below on left). + +image::mobile-images/Credentials.jpg["FIGURE: Mobile credentials screen",align="center"] + +=== Using _Subsurface-mobile_ without Cloud Storage +Tap the "No cloud mode" button. The app will only store dive log information locally +on your device. After the first start the dive log will therefore be empty. + +=== Using Cloud Storage +The _Subsurface_ maintainer provides a dedicated and +free Internet cloud storage account for users of _Subsurface_ and _Subsurface-mobile_. +You can use this to store your dive log and to share your data between various computers +and devices. The _Subsurface_ team never accesses your dive data without explicit +permission to do so, the data are not used for any purpose other than providing them to the user who +created them. There are no ads and no harvesting / analysis of the data +stored in the _Subsurface Cloud_ storage. There is no monetization whatsoever. + +_Subsurface-mobile_ is sufficient to fully maintain a dive log. In addition you can use the +more advanced features in _Subsurface_ when you have access to a computer while still +being able to work with your dive data when only a mobile device is available. + +The dive data in the cloud are cached locally on any device or computer that is connected to +the _Subsurface Cloud_ account. +It is easy to create backups of the data (for example in XML format) on the desktop: both the mobile +device and the desktop keep a local copy of the data so that the dive log is always accessible, even +without Internet connection. + +To create a _Subsurface Cloud_ account follow these steps: + +1) Enter an e-mail address and a password in the fields indicated on the screen (see image above). +The e-mail address should be in lower case and the password should contain a combination of +upper and lower case letters and/or numbers. + +2) Tap the "Sign-in or Register" button. + +If you have already set +up an account on a different computer or device, simply enter the same credentials here. +_Subsurface-mobile_ will now download your existing dive log data. Once the dive +list has been downloaded from the cloud, _Subsurface-mobile_ usually works only with the the local +copy on the mobile device. This avoids long delays or even failure of operations if there is a bad +(or no) internet connection, a situation fairly common at many dive sites. Remember to manually sync +with the server after making local changes (either by pulling down on the dive list, or by using the +manual sync entry in the Dive management menu entry). + +3) If this is a new cloud account, a PIN screen will open (see image on right, above). A PIN is e-mailed +to the email address entered in the previous step. Enter this PIN into the field indicated +and tap the _Register_ button. After the PIN has been entered it +is no longer needed - it just proves that this is indeed your email account. + +At this point a new account has been created for you on the cloud server and access to the cloud is +enabled. In this case the dive list is initially empty. Start entering dives in the dive +log or download dive information from a supported dive computer. + +Once registered, _Subsurface-mobile_ remembers the cloud credentials and it is not necessary to +provide these again when launching the program. + +**** +[icon="images/icons/important.png"] +[IMPORTANT] +*Cloud problems: FAQ* + +[blue]#After filling in the correct information and submitting it, I did not receive a PIN by email# + +1. Check *carefully* that you didn't make a spelling mistake in the email address you provided. You would be surprised how often this is the problem that people encouter, as autocorrect often mangles email addresses. +2. Check that the return email containing the PIN is not in the SPAM folder of your email client. +3. Wait for a few hours and check again for an email with a PIN. +4. If there is still no email containing a PIN, send mail to in-app-support@subsurface-divelog.org + +[blue]#I want to access the _Subsurface Cloud_ storage but I have forgotten my password. How can I reset my password?# + +There is a _Reset forgotten Subsurface Cloud password_ entry in the _Help_ menu in _Subsurface-mobile_, or you can go to the following web address: https://cloud.subsurface-divelog.org/passwordreset + +Simply enter the same email address that you used during cloud registration and follow the indicated steps. A confirmation email will be sent to your account to prevent abuse of this system. + +**** + + +== The Dive List + +Most of the actions of _Subsurface-mobile_ center around the dives in 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, after which the dive list is shown. Once the list is loaded you can scroll up +and down through your dive history. +_Subsurface_ typically structures your dive list by dive trips, but using those is optional +(and for divers who are lucky enough to be able to dive all the time at local dive sites, +trips might only make sense for dive vacations). + +Two xref:S_Dive_Management[_Dive Management_] actions are available by tapping on the +action buttons at the bottom of the _Dive List_ page: +To xref:S_Download[_Download dives from a dive computer_], tap the main action button. If you wish +to xref:S_Add_Dive[_Manually add a dive_], tap the + button in the action bar. Both of these +actions are described in detail below. + +Tapping an existing dive on the list brings up a display of the xref:S_ViewDive[_Details View_] +for that dive including the dive profile, notes, and additional information. + +image::mobile-images/DiveListAndDetails.jpg["FIGURE: Dive list screen",align="center"] + +A tap and hold on a dive or a trip header opens the context menu for that entry. + +For a dive this allows moving the dive into or out of trips or between trips, deleting +the dive or showing the dive on an integrated map viewer (assuming the dive has the +necessary GPS information). The context menu also allows access to the undo and redo +system that allows you to step backwards and forwards through recent actions. + +For a trip header the context menu gives you an option to edit the trip title (typically +the trip location) and some quick notes for the trip. + +=== Filter the dive list + +unfloat::[] + +image::mobile-images/FilterButton.jpg["FIGURE: Filter button",float="right"] +The left action button shows three horizontal lines of declining length, symbolizing a filter. +When you tap this button, a text entry line appears at the top of screen which will allow you to +enter a filter search term that is either used in a full text search, a search just of the people +involved in a dive (in the Divemaster and Buddy fields), or a search of the tags you have used +to classify your dives. Tapping the filter button again clears the filter and shows the full +dive list. + +image::mobile-images/FilteredDivelist.jpg["FIGURE: Filter tool",align="center"] + +[[S_View_Dive]] +=== View a dive + +When you tap on a dive in the _Dive List_, a _Dive Details_ page with the dive profile +and many important details about the dive is opened. You can use a pinch gesture +to zoom into the profile. Tapping and holding with one finger (until +the profile becomes translucent) allows you +to pan the profile and see more details in specific parts of the profile. + +You can view other dives by swiping the _Details view_ to the right (for the +previous dive) or to the left (next dive). +Using the Action Bar, it is also possible to delete the dive (tap the Trash Icon +on the Action Bar) or to view the dive location on an integrated map viewer. + +The context menu (accessible by tapping on the vertical three dots in the lower right corner of the +screen) offers additional options to move dives between trips, the same delete and map options +already mentioned, and access to the undo and redo facility that allows you to step backwards and +forwards through recent actions. + +=== Viewing the location of a dive on a map + +image::mobile-images/DiveSiteMap.jpg["FIGURE: Map of dive site",align="center"] +In the _Details View_, you can either tap the _Map it_ button on top of the +page to the right of the dive site name, or the GPS pin on the +left hand side of the _Action Button_ at the bottom of the screen. +The dive site is shown in an integrated map viewer. + +[[S_Edit_Dive]] +=== Edit a dive + +image::mobile-images/DiveDetailsEdit.jpg["FIGURE: Dive edit screen",align="center"] +At the bottom of the _Dive Details_ screen, the action button is a pencil. +Tapping the pencil button changes the page and enables editing +the dive details, e.g. adding text to the dive notes +or changing the names or values of some of the information (see image on left). +It may be necessary to scroll the window to access all the available fields. +At the bottom of the edit screen is a _Save_ action button. Tap this to save +the new information, after which the dive list screen is +updated and displayed. To cancel any edits, tap the Android _Back_ Button or +the application back button at the top left of the screen on iOS. + + +// == Copy dive information from one dive to another +// +// When editing dives it is possible to transfer information from one dive to another. For instance, +// when diving with the same buddy and the same equipment configuration during a particular dive trip +// it can be efficient to simply copy all this information from the previous dive into the dive that +// is being edited. Currently a standard list of dive information is copied to the clipboard: +// +// Divemaster, Buddy, Suit, Tags, Cylinders, Weights. +// +// Copy and paste dive information is performed on the Dive List. Long-press on a dive. A panel +// with three icons appears on top the selected dive : +// +// image::mobile-images/CopyDeleteDive.jpg["FIGURE: Copy/Delete dive information",align="center"] +// +// To copy the above information to the clipboard, select the leftmost of the three icons. A "Copy" +// notification briefly appears on the screen. Now long-press the dive into which the copied information +// needs to be pasted. The same three icons appear on the target dive. Select the middle icon. A "Paste" +// notification briefly appears on the screen. This completes the copy-and-paste action. Continue by +// reviewing this new (pasted) information by manually editing the target dive. +// +// To choose what dive details to copy, long-press the copy button. This will open +// up a configuration page where you can toggle the details you want to copy over +// to the destination. + +=== Deleting a dive + +You can delete a dive from the dive list by long-pressing a dive and selecting delete in the context menu. +You can also delete a dive from the _Details View_ by tapping on the trash can icon on the right +side of the _Action Button_ + +If you deleted the wrong dive by mistake you can easily undo the operation in the context menu. + +image::mobile-images/UndoDelete.jpg["FIGURE: Undo delete dive",align="center"] + + +[[S_Dive_Managent]] +== Dive Managent + +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 of the dive information in a local copy +and allows the desktop version of _Subsurface_ to +access changes made using the mobile device. This feature is accessed +through the _Dive management_ option in the main menu. + +[[S_Add_Dive]] +=== Manually adding a new dive to the dive list + +You can manually add a dive to the existing dive list. On the dive list +tap the "plus"-icon in the action bar, or use the +main menu and tap _Dive management -> Add dive manually_. This opens a screen that is +identical to the editing screen described 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 _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_. + +image::mobile-images/ManualAddDive.jpg["FIGURE: Manual dive entry screen",align="center"] + +[[S_Download]] +=== Download dives from a dive computer + +There are several ways to get to the _Download Page_. You can either tap on the main _Action Button_ on +the bottom of the _Dive List_, or you can select _Dive management -> Download from DC_ in the main menu. +On Android devices, when you plug in a USB serial cable for a dive computer, the _Download Page_ will be +opened automatically. + +The download feature on smartphones supports only a limited number of dive computers. On +Android devices these are typically dive computers using a serial USB interface +using a USB OTG cable or a simple USB C-A adapter on newer devices. +Android devices also support Bluetooth dive computers that +are supported in _Subsurface_ on the desktop. Both Android and iOS devices allow direct +download of dive data from a handful of Bluetooth LE enabled dive +computers. + +Use the _Vendor name_ and _Dive Computer_ drop-downs to pick the correct +dive computer. +For instance, when using a Shearwater Petrel dive +computer, the vendor is _Shearwater_ and the product is _Petrel_(see image on the left, below). + + +When downloading from multiple different dive computers, shortcut +buttons appear below the drop-downs to easily switch between them. In the xref:S_Settings[_Settings_] menu +you can remove these buttons, a useful feature for removing buttons of dive +computers that you do not use any more. Achieve this by selecting the option +_Forget remembered dive computers_ in the xref:S_Settings[_Settings_] menu. + +==== Download from USB serial dive computers +This feature is not supported on iOS. + +[width="100%", frame="None"] +|======= +a|image::mobile-images/USB-OTG.jpg["FIGURE: USB-OTG cable",align="center"] | +Most current Android devices now have a USB +Type C port and come with a simple A-to-C adapter plug, which allows to plug in +the dive computer cable into the phone or tablet. +For older Android devices with micro USB connector you will need to plug the USB +cable used with the dive computer into a USB OTG cable which, +in turn, plugs into the micro-USB port. +The OTG cable usually has a full-size ("Type A") female receptacle at one end which +accommodates the full-sized male plug +of the dive computer USB cable (see image below). This means that two cables are used to connect +the dive computer to the mobile device. *Not all Android devices support OTG cables* +but usually all modern Android devices with a USB C plug can be used with a USB A-to-C adapter. +|======= + +_Subsurface-mobile_ remembers the settings for dive computers that +have been successfully used (image on right, below). These appear +as buttons under a heading "_Previously used dive computers_". +Select the appropriate button. Having connected the USB dive computer to the +_Subsurface_ computer and having selected the appropriate vendor and dive computer, +ensure that the Connection text box shows the corresponding connection. For a small number of dive +computers the connection name shows the dive computer vendor, for most only the cable chipset vendor +(and USB connection number) is shown. Most users of course only connect one USB dive computer to +their Android device and then things are fairly straightforward. A dialog will pop up and ask if +you want to use _Subsurface-mobile_ to connect to the device. If you confirm, then _Subsurface-mobile_ will +open to the dive computer download screen with the correct connection selected (and if it can deduce +the correct dive computer based on the cable used, even that information is already pre-filled). + +==== Download from BT/BLW dive computers + +The process for Bluetooth download is slightly different between Android and iOS. + +In our testing we got the best results on iOS when the dive computer was +in Bluetooth mode before _Subsurface-mobile_ is started. On most dive +computers this is done through a menu entry, others (like the Suunto +models) always respond to Bluetooth LE requests. However, on Android devices, +you should first establish a link between the +Bluetooth or Bluetooth LE dive computer and the mobile device using +Android utilities. See below for more details. + +For Bluetooth-equipped dive computers and Android devices, establish a Bluetooth connection between the dive computer and the +mobile device using Android system tools to achieve pairing. +For many Android devices, +the Settings -> Bluetooth tool of Android is probably appropriate. +_Subsurface-mobile_ performs communication using both Bluetooth and Bluetooth-low-energy (BLE). +The best choice of Bluetooth communication is often made by the software and the user need not be concerned with this. +For dive computers with both Bluetooth and BLE, a separate button is presented on the download +screen for each mode of communication, allowing a choice. Use the _Connection_ value to distinguish between the +two options. In the image on the below right, there are three buttons labeled "Shearwater Petrel 2". These represent two Shearwater Petrel dive computers, one of which can communicate in both Bluetooth as well as BLE. The _Connection_ +information indicates that the Petrel with no BLE is selected. + +==== Start the download + +With communication between dive computer and _Subsurface-mobile_ +having been set up, tap the _Download_ button. Be patient because the download can take a while - with many +long dives and a slow BLE connection we have seen download times of 45 minutes or longer. But usually downloading +a day's worth of diving happens reasonably quickly. +The downloaded dives appear in the bottom part of the screen, +the most recent dive at the top (see image on right, below). + +Each dive has a check-box on the left hand side, used for selecting which dives you want to add to the +_Subsurface-mobile_ dive list: dives that are not checked are ignored. Once you picked the dives +you want to add to the dive list, tap the button at the bottom left labeled _Accept_. The selected dives will +now appear as part of +the _Subsurface-mobile_ dive list. The downloaded dive information can be edited as described in the section +above xref:S_Edit_Dive[Edit a dive]. + +image::mobile-images/DC-Download.jpg["FIGURE: DC download screen",align="center"] + +=== Apply GPS fixes + +This is described in the following main section below. + +=== Manually sync the dive log with the _Subsurface Cloud_ + +As the name indicates, this ensures that the local changes on the mobile device and changes +made by other devices and computers to the data stored in the _Subsurface Cloud_ are synchronized. +It is highly recommended to sync with cloud storage after downloading new dives from a dive computer +or manually adding or editing dive information on the mobile device. + +This can also be triggered by pulling down (and briefly holding) the _Dive List_. + +=== Enable cloud auto sync + +By default _Subsurface-mobile_ runs offline and only syncs the dive list +with cloud storage when explicitly told to do so (see the previous entry above). +You can choose to always sync with the cloud servers. This is not +recommended unless you are in +an area with a fast and reliable internet connection, as otherwise +_Subsurface-mobile_ might appear to hang between operations as it tries to +connect to the cloud server. Selecting _Enable cloud auto sync_ causes +the local dive log to be synchronized with the copy in the cloud after most changes as well +as (on Android) every time that _Subsurface-mobile_ is closed. iOS doesn't support the concept +of closing an app (you can just kill it, which doesn't allow for a final sync with the cloud). +In general it is safer to manually sync with the cloud once you are done making changes in +_Subsurface-mobile_. + +=== Dive Summary + +The _Dive Summary_ page provides a very simple overview of your diving activities - which can for example +be useful when documenting total dive experience and recent dive activity for a dive center at +the beginning of a dive trip. + +The summary page lists the date of your first dive in the dive list as well as your most recent dive. +It also provides two columns of data for selectable time ranges (by default all dives in the dive list +and the dives during the last six months. + +=== Export + +The _Export_ feature is somewhat experimental. On Android it only allows the upload of your dive list +to two websites (divelogs.de and diveshare). On iOS it also allws local file based exports as _Subsurface_ +specific XML files (both for dives and dive sites) as well as _UDDF_. + +Tapping on _Next_ opens an additional page for login information (or a file selection dialog). + +== Location + +The fact that almost all smartphones have GPS facilities allows +_Subsurface-mobile_ to record +the locations of dives. *IMPORTANT: GPS-derived coordinates on a smartphone +are not always accurate and can have an error greater than 1 km. GPS accuracy +is determined by the hardware and software of the +smartphone as well as by the GPS settings selected within Android/iOS. +As of Android V6 select Android _Settings -> Communication -> Location -> High accuracy._* +If the smartphone is taken on the boat +during a dive, locations will be automatically be recorded at regular intervals. +These locations can then be applied to dives in the dive list. Here is how it's done: + +[[S_ConfigureGPS]] +=== Configuring the GPS service + +For most users, the defaults for tracking GPS locations will be +appropriate. If you would like to change them, go to +the _Main Menu_, select the xref:S_Settings[_Settings_] screen, and open +the _Advanced_ area on that page. Here you will find the section for +configuring the GPS service (see image below). GPS location data +are collected at regular intervals, e.g. every 5 minutes, or at regular +distances, e.g. after the boat has moved more than 200m, or a combination of +both of these approaches. Provide the appropriate information and +tap the _Back_ button. The program is now ready to collect GPS positions. + +image::mobile-images/GPSConfig.jpg["FIGURE: GPS configure",align="center"] + +=== Collecting GPS positions + +[width="100%", frame="None"] +|======= +a|image::mobile-images/LocationMenu.jpg["FIGURE: GPS start",align="center"] | +In the _Location_ menu select _Run location service_. +_Subsurface-mobile_ starts to collect GPS locations automatically, +following the preferences specified as described above. While the GPS +location service is running, all menus have a GPS symbol at the bottom +of the menu, indicating that the service is active. After returning from +the dive trip, deactivate the collection of GPS data by tapping +the option _GPS -> Disable location service_. The GPS symbol at the bottom +of all menus disappears. + +Collecting GPS fixes like this is relatively battery intensive and unfortunately +both Android and especially iOS have become increasingly aggressive in killing +applications that are running while the screen is turned off. It may make sense +to check between dives that the location service is still running. +|======= + +=== Applying GPS data to dives in the dive log + +After running the location service during a dive trip, first either download +the dives from your divecomputer or manually enter the dives into the dive list. +Now you can apply the GPS positions to these dives. +From the _Dive management_ menu, 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. + +=== Viewing the locations of all dives in the dive list + +image::mobile-images/DivesMap.jpg["FIGURE: Map of all dive sites",align="center"] + +The locations of all dives in the dive list can be viewed from the _Location_ menu by selecting the _Map_ option. +A satellite image of the world is shown. At that scale no dive sites are shown. If you zoom into a particular region +of the world the dive sites appear, indicated by red flags. Zooming in even closer indicates the names of each +of the different dive sites. + +[[S_Settings]] +== Settings + +The _Settings_ page allows the customization of _Subsurface-mobile_. +It is grouped into four sections. + +=== _General settings_ section + +image::mobile-images/GeneralSettings.jpg["FIGURE: General Settings",align="center"] + +[[S_ChangeCloudAccount]] +==== Changing to a different _Subsurface_ cloud account + +Some users have more than one _Subsurface_ cloud account and have a need to switch between accounts. +Tap on the _Change_ button next to the _Email address_ in the _General settings_ on the _Settings_ page. +This opens the _Cloud credentials_ page. +Here you can change the email address and password used and then tap the button _Sign-in or register_. +The appropriate dive list is shown. + +==== Default cylinder + +When manually entering a dive or when downloading from a dive computer that doesn't explicitly +include cylinder size information (very few dive computers support that feature), _Subsurface-mobile_ +uses the cylinder that you select here as the default. If you don't set this entry, no default +cylinder is used. + +==== Forget the remembered dive computers + +Tap the _Forget_ button to reset the dive computers that are stored in the up to four shortcut +buttons on the _Download from dive computer_ page. + +=== _Theme_ section + +==== Color theme + +[width="100%", frame="None"] +|======= +a|image::mobile-images/ThemeSettings.jpg["FIGURE: Theme Settings",align="center"] | +Besides the default blue color scheme, _Subsurface-mobile_ supports two additional color schemes +for users with different tastes (see image above). All screenshots in this user manual shows are +based on the the blue default color scheme. You can pick the _pink_ or _dark_ color scheme from +the drop down menu. + +The boxes below show the various color choices in the theme of your choice. +|======= + +==== Font size + +Depending on the size and the screen resolution of your mobile device, you may prefer slightly +smaller or slightly larger fonts. You can make this selection with the three buttons here. + +=== _Units_ section + +Here you can pick _metric_, _imperial_, or _personalized_ units for the user interface. +In most cases _Subsurface-mobile_ should pick the regionally typical unit system for +your location. + +=== _Advanced_ section + +As the name indicates, most users will not need to make changes here. + +==== GPS location service thresholds + +As indicated above in the _Location_ section of this manual, here you can set the distance and time +thresholds for the _location service_ + +==== Bluetooth + +Since most devices tend to find a _LOT_ of BT/BLE devices that aren't dive computers, by +default _Subsurface-mobile_ only shows known dive computers to make the connection list +easier to use. + +This setting tells _Subsurface-mobile_ to temporarily show _ALL_ Bluetooth and BLE devices as +possible connections on the _Download Page_, not just the ones recognized as dive computers. +If you end up needing this option in order to select a dive computer that is not recognized +by _Subsurface-mobile_, please send an email to the developers (using the _Help -> Ask for support_ +menu entry) so we can add the missing code to recognize your dive computer as well. + +==== Display + +_Subsurface-mobile_ tries to make efficient use of the available screen real estate of your +mobile device. In most cases this leads to reasonable choices regarding the number of parallel +columns that are being displayed. Some users have expressed the desire to force _Subsurface-mobile_ +to show only one column in portrait mode, even on large devices like tablets, as this results +in a larger profile on the _Dive Details_ page. Select this option if you want to enable that +feature. + + +==== Activating the Developer sub-menu + +This enables an additional menu item in the _Main_ menu which contains options which are almost +never useful for a regular users. Here you can find the detailed app log file as well as several +test screens that help the developers track down issues you might encounter. + +== Help + +=== About + +This page shows you the exact version of _Subsurface-mobile_ that you are running and provides +a convenient way to copy the application logs to the clipboard. + +=== Show user manual + +This menu entry opens the online version of this user manual in the native browser of your +device. Unfortunately this option isn't available if your device is offline. + +=== Ask for support + +This item opens your default email client with a pre-populated email to the _Subsurface_ +support alias and copies the app logs into that email. Simply add your question or the +but that you are reporting and send us your message. + +=== Reset forgotten _Subsurface Cloud_ password + +As mentioned earlier in this manual, this is a convenient link to a web page that allows +you to reset the password for your _Subsurface Cloud_ account. -- cgit v1.2.3-70-g09d2