Introducing Subsurface-mobile

From 70ebc2bee7bc01e0758b7608cfbbe2e8a945c062 Mon Sep 17 00:00:00 2001 From: Willem Ferguson Date: Tue, 5 May 2020 17:46:48 -0700 Subject: documentation/mobile-manual: create a merged v3 manual Unintentionally two versions of the mobile manual were created. This brings all of Willem's changes into the version for Subsurface-mobile v3, and restores the last version of the v2 mobile manual. This commit was manually created from a pull request that was signed off by Willem, given that he wrote most of the text I am copying that SOB into this commit and will assign authorship to him. To avoid further confusion, we now have a v2 and a v3 manual, explicitly named. The corresponding .html.git files were also updated (reflecting our switch to asciidoctor). Signed-off-by: willemferguson Signed-off-by: Dirk Hohndel --- Documentation/Makefile | 2 +- Documentation/mobile-manual-v2.html.git | 1302 ++++++++++++++++++++ Documentation/mobile-manual-v2.txt | 552 +++++++++ Documentation/mobile-manual-v3.html.git | 2008 ++++++++++++++++++------------- Documentation/mobile-manual-v3.txt | 436 +++---- Documentation/mobile-manual.html.git | 962 --------------- Documentation/mobile-manual.txt | 603 ---------- 7 files changed, 3264 insertions(+), 2601 deletions(-) create mode 100644 Documentation/mobile-manual-v2.html.git create mode 100644 Documentation/mobile-manual-v2.txt delete mode 100644 Documentation/mobile-manual.html.git delete mode 100644 Documentation/mobile-manual.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index 55671b09a..1df632af6 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -13,7 +13,7 @@ HTMLDOCS = $(patsubst %,$(OUT)%.html,$(DOCNAMES)) TEXTDOCS = $(patsubst %,$(OUT)%.text,$(DOCNAMES)) PDFDOCS = $(patsubst %,$(OUT)%.pdf,$(DOCNAMES)) -ASCIIDOC = asciidoc +ASCIIDOC = asciidoctor A2X = a2x BROWSER = firefox THEME = compact_subsurface diff --git a/Documentation/mobile-manual-v2.html.git b/Documentation/mobile-manual-v2.html.git new file mode 100644 index 000000000..12e12d942 --- /dev/null +++ b/Documentation/mobile-manual-v2.html.git @@ -0,0 +1,1302 @@ + + + + + + + +Introducing Subsurface-mobile + + + + + +

Subsurface-mobile USER MANUAL

Manual authors: Willem Ferguson, Dirk Hohndel

Version 2.1.5, December 2018

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

1. Introducing Subsurface-mobile

Subsurface-mobile is a limited mobile version of Subsurface +aimed at Android and iOS smartphone and tablet devices, allowing viewing, entering, sharing, and storage of dive information at dive sites where a desktop +computer is not useful. While the desktop version of Subsurface shows much more detailed information +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 also allows +the gathering of GPS locations where dives are performed.

Users of Subsurface-mobile typically use the +mobile app as a companion to the laptop/desktop version of Subsurface, sharing dive information +between the mobile and the desktop versions. 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 many dive computers.
+
+
Editing many of the dive log data fields, e.g. dive-master, buddy, +equipment or notes relating to a dive.
+
+
Recording, storing and applying GPS positions of dives.
+
+
Viewing the localities of recorded GPS positions and of dives +on a map.
+

These items are discussed in greater detail in the following text. +Subsurface-mobile does not support download of dive data from all the +dive computers that the desktop/laptop version can. This limitation is +mainly caused by the inability of accessing some types of devices on the +two mobile platforms. On Android, a subset of +dive computers that use a FTDI USB interface or a Bluetooth / Bluetooth LE interface +are accessible by Subsurface-mobile. On iOS, only Bluetooth LE based +dive computers are supported.

2. Installing Subsurface-mobile on your mobile device

Find Subsurface-mobile in the Google Play Store or the iTunes Store +and install it. Please note that both stores also contain the older Subsurface companion app (used only for tracking GPS positions) - make sure you actually install Subsurface-mobile.

3. 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. After loading, the Cloud Credentials screen appears +(see image below on left).

3.1. When NOT Using Cloud Storage

Tap the "No cloud mode" button. The app will not access the Subsurface +cloud storage server +to obtain dive log information. This means that dive log information is +stored on the mobile device only. If no dives have been entered into the dive log +yet (the usual case), an empty dive log is created.

3.2. Using Cloud Storage

The Subsurface developers provide a dedicated and +free Internet cloud storage account that can be used for +storing dive log information. This account can be created either from Subsurface on the desktop or from Subsurface-mobile +using a mobile device; you can +do full maintenance of a dive log from Subsurface-mobile alone. By using the same +credentials with Subsurface-mobile and Subsurface for desktop, the Subsurface cloud storage allows sharing of a dive +log between both (or even more than two) devices.

The dive data on the cloud are cached locally both on the mobile device as well as on the desktop - 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. The Subsurface team never accesses a user’s 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.

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 +letters from the alphabet (upper and lower case) and/or numbers. +Tap the "Sign-in or Register" button. If you have already set +up an account from the Subsurface desktop application, enter the same credentials here. +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. Once registered, Subsurface-mobile remembers the cloud credentials and it is not necessary to provide these again when launching the program.

2) 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. The user +information is stored 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.

+ + + + + +

+ +	+Cloud problems: FAQ +

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

+
Check carefully that there is not a spelling mistake in the email address you provided.
+
+
Check that the return email containing the PIN is not in the SPAM folder of your email client.
+
+
Wait for 24 hours and check again for an email with a PIN.
+
+
If there is still no email containing a PIN, send mail to in-app-support@subsurface-divelog.org
+

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

Open the following web address: https://cloud.subsurface-divelog.org/passwordreset

This will require that you enter the same email address that you used during cloud registration.

The dive log can be updated automatically. If there is Internet connectivity, Subsurface-mobile accesses +the cloud-based dive log to verify that the local copy of the dive log is still the +same as the log in the cloud server. If not, the local copy and the copy on +the server are synchronized.

3.3. Changing the existing login credentials on the Subsurface cloud

The login credentials can be changed, for example to work with +multiple accounts. See the section on Changing to a different Subsurface cloud account.

4. 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 main menu. This will open an email to our in app support address in the native email client, including the relevant logs.

5. Menu Structure and User Interface

At the bottom of many Subsurface-mobile screens is a round button that provides for +several actions (see image below). The most common choice is indicated in a round colored action button (in the case below, edit a dive). Alternative actions are indicated in a white action bar. +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.

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

For 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. There are three ways to open the main menu:

+
Tap the "hamburger" symbol in the lower left corner of the screen +(easy to reach for hand held devices)
+
+
Swipe towards the right across the left edge of the screen
+

The image above 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.

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

6. 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, after which the dive list is shown. Once the list is loaded you can scroll up and down through your dive history. +To upload dives from a dive computer, tap the blue action button. If you wish +to add a dive manually, tap the + button in the action bar (described 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.

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. Filter the dive list

Use this action button:

at the bottom of the dive list to perform filtering of the dive list (see image on left above).

By default, all the dives in the dive log are shown in the dive list. After several years your dive log can become quite long and, sometimes, you might like to list only the dives of a particular type, e.g. those at a particular dive site or those with a specific buddy or dive master. Use the Filter to achieve this. The filter mechanism searches through all the information for each dive, looking for one or more key words. Only the dives containing these key words are listed in the dive list. In the Settings screen there two options that affect the way the filter searches for appropriate information. Firstly, you can select Match filter case sensitive which causes the search of key words to be case sensitive. Secondly, you can select Include notes in full text filtering. If this option is not selected, the filter does not search through the dive notes for key words. Selecting the Filter action button brings up a text box at the top of the dive list. Type the key words to be searched for. In the image on the left, the dive list has been filtered for the word "Nitrox" and 265 dives were found containing this word as a tag. For each trip in the dive list the number of dives containing "Nitrox" as a tag is shown. To clear the filter, remove the key words from the text box and select the Filter action button to switch off filtering.

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

The locations of all dives in the dive list can be viewed from the Main 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. Viewing the location of a dive on Google Maps

In the Details View, the Action Bar at the bottom has a GPS pin on the +left hand side. Tap that pin and the dive site is shown in Google Maps. Close Google Maps by using the Android Back button +or tapping on the Subsurface-mobile link in the top left corner on iOS.

Alternatively, the Details View has a button at the top right hand marked +Map it. Tap this button to open Google Maps showing the dive site (image on left).

10. View a dive

When you tap on a dive in the Dive List, a new screen 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 so the interesting parts are shown.

11. Edit a particular dive

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.

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

13. 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 :

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.

14. Deleting a dive

Delete a dive from the dive list by long-pressing a dive +until a red dustbin appears on the right-hand side (see image above). 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.

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. By default, the following fields are copied:

15. Download dives from a dive computer

From the main menu, +tap Manage dives → Download from DC. A screen is shown requiring that the user specify +the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel dive +computer, the vendor is Shearwater and the Dive computer name is Petrel(see image on the left, below). +Caveats: The download feature in smartphones supports only a limited number of dive computers. On +Android devices these are typically dive computers using an FTDI interface +using a USB OTG cable (but this is blocked on some Android devices by OS +settings). 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. 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 are not used any more. Achieve this by selecting the option +Forget remembered dive computers in the Settings menu. +After all these caveats, let us proceed with download.

For USB FTDI dive computers: +This feature is not supported on iOS and on most newer Android devices. It still works on some older +Android devices (typically Android 7 and older) and is kept enabled for this +reason. Note: USB cables "normally" used for uploading dives to a +desktop/laptop computer do NOT work; these +cables usually have a full-sized ("Type A") male USB plug +on one end which plugs into the USB port of a desktop/laptop computer. For downloads to a mobile device +one needs a USB OTG (USB On-The-Go) cable.

+ ++++ + + + + + + +

In most cases it is required to plug the USB +cable "normally" used with the dive computer into a USB OTG cable which, +in turn, plugs into the mini-USB (or sometimes a USB "Type C") +receptacle of the mobile device. The +OTG cable usually has a full-size ("Type A") female receptacle at one end which +accommodates the full-sized male plug +of the USB cable "normally" used (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 +and even on some devices that do support those cables in general, as mentioned above Subsurface-mobile +does usually not support cable based downloads, except on some older Android devices.

Subsurface 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 "FTDI".

For BLUETOOTH/BTLE 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 BTLE 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. Use the tools on the mobile device to achieve pairing between the Bluetooth dice computer +and the mobile device. For many Android devices, +the Settings → Bluetooth tool of Android is probably appropriate. +Subsurface-mobile performs communication using both Bluetooth and Bluetooth-low-energy (BTLE). +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 Bluetooth-low-energy (BTLE), 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 BTLE. The Connection +information indicates that the Petrel with no BTLE is selected.

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 few minutes. +As a matter of fact, a complete first download from some dive computers can take 45 minutes or longer. +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 be added to the +Subsurface-mobile dive list: dives that are not checked are ignored. With the appropriate downloaded dives +having been checked, tap the button at the bottom left labeled Accept. All the selected dives appear on +the Subsurface-mobile dive list. The downloaded dive information can now be edited as described in the section +above Edit a dive.

16. 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 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 main menu +(by tapping the "Hamburger" icon at the bottom left of the screen). +Tap the option Dive management, enabling a number of options:

16.1. Add new dive manually

This is described above under the section dealing with Manually adding a new dive to the dive list.

16.2. Download from DC

This is described above under the section dealing with Download dives from a dive computer.

16.3. Apply GPS fixes

This is described in the following main section, below.

16.4. Manually sync the dive log with the Subsurface cloud storage

Upload the dives contained on the mobile device +to the Subsurface cloud storage by tapping the option Manual sync with cloud. +This synchronizes the local changes to +the dive log with the cloud storage. It also downloads changes made to +the dive log using another device or computer and stored in shared cloud storage.

16.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 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 every time that +Subsurface-mobile is closed.

17. Recording dive locations using GPS

The fact that most 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:

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

17.2. Collecting GPS positions

+ ++++ + + + + + + +

On the Main Menu select GPS → 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.

17.3. Viewing GPS data

From the GPS submenu 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 +teardrop-shaped icon (actually a Google Maps 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.

17.4. 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, apply the GPS positions to +these dives. GPS positions can only be applied to dives in the dive list. +From the Dive management sub-panel, 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.

18. Specifying the settings for Subsurface-mobile.

The Settings screen allows the customization of Subsurface-mobile. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting.

18.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 Settings on the Main menu and scroll to the section titled Cloud status (see image below). +Tap the Change button. This opens the Cloud credentials screen. +change the credential information, then tap the button Sign-in or register. The appropriate dive list is shown.

18.2. Changing the color theme of Subsurface-mobile

+ ++++ + + + + + + +

Subsurface-mobile has three color schemes to please users with different +tastes (see image above). This user manual shows the default color scheme, comprising blue +colors. Change to a pink or a dark color scheme by opening the main menu, +tap Settings, and scroll to the section with heading Theme (see image above). +Select the appropriate color theme by dragging the appropriate slider on the right-hand. +On the left is the dive list after selecting the Pink theme.

18.3. Configuring the GPS webservice

The Settings screen allows one to set up the way in which GPS positions are collected during dives. See the section on Configuring the GPS service.

18.4. Activating the Developer sub-menu

The information in the subsurface.log generated while running Subsurface-mobile, plus some additional information for understanding the screen rendering of dive information as well as the way in which Subsurface-mobile processed information during a specific occasion while running the app (see section below) is available through a Developer menu at run time. Activate (or deactivate) this menu item on the Main Menu by dragging the slider switch in the Settings screen. +If Display developer menu has been activated in the Settings screen, the Main menu has a Developer item. By tapping this one has two options that are relevant within +the context of program development and debugging.

18.5. App log

This option shows the messages that Subsurface-mobile generates while running. While +most users are not aware of these messages, they are often crucial in detecting any +abnormal behavior of the app. The App log can be found in the root directory of the local storage of the mobile device.

18.6. Theme information

This option provides a wealth of information about the screen characteristics of the mobile +device and the font characteristics used by Subsurface-mobile.

+ + + \ No newline at end of file diff --git a/Documentation/mobile-manual-v2.txt b/Documentation/mobile-manual-v2.txt new file mode 100644 index 000000000..d003c9850 --- /dev/null +++ b/Documentation/mobile-manual-v2.txt @@ -0,0 +1,552 @@ + +// Subsurface-mobile User Manual +// ============================= +// :author: Manual authors: Willem Ferguson, Dirk Hohndel +// :revnumber: 2.1.5 +// :revdate: December 2018 +: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 2.1.5, December 2018_# + +Welcome as a user of _Subsurface_ and _Subsurface-mobile_, advanced dive logging +software with extensive infrastructure to describe, organize, and interpret scuba +and free dives. _Subsurface_ offers many advantages over other similar +software solutions, including compatibility with Windows, macOS, Linux (many +distributions), Android and iOS. In addition, _Subsurface_ is +open-source software that allows downloading dive +information from many dive computers. + +Introducing Subsurface-mobile +----------------------------- + +_Subsurface-mobile_ is a limited mobile version of _Subsurface_ +aimed at Android and iOS smartphone and tablet devices, allowing viewing, entering, sharing, and storage of dive information at dive sites where a desktop +computer is not useful. While the desktop version of _Subsurface_ shows much more detailed information +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_ also allows +the gathering of GPS locations where dives are performed. + +Users of _Subsurface-mobile_ typically use the +mobile app as a companion to the laptop/desktop version of _Subsurface_, sharing dive information +between the mobile and the desktop versions. 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 many dive computers. +- Editing many of the dive log data fields, e.g. dive-master, buddy, + equipment or notes relating to a dive. +- Recording, storing and applying GPS positions of dives. +- Viewing the localities of recorded GPS positions and of dives + on a map. + +These items are discussed in greater detail in the following text. +_Subsurface-mobile_ does not support download of dive data from all the +dive computers that the desktop/laptop version can. This limitation is +mainly caused by the inability of accessing some types of devices on the +two mobile platforms. On Android, a subset of +dive computers that use a FTDI USB interface or a Bluetooth / Bluetooth LE interface +are accessible by _Subsurface-mobile_. On iOS, only Bluetooth LE based +dive computers are supported. + +== Installing _Subsurface-mobile_ on your mobile device + +Find _Subsurface-mobile_ in the _Google Play Store_ or the _iTunes Store_ +and install it. Please note that both stores also contain the older _Subsurface_ companion app (used only for tracking GPS positions) - make sure you actually install _Subsurface-mobile_. + +== 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. After loading, the _Cloud Credentials screen_ appears +(see image below on left). + +image::mobile-images/Credentials.jpg["FIGURE: Mobile credentials screen",align="center"] + +=== When NOT Using Cloud Storage +Tap the "No cloud mode" button. The app will not access the _Subsurface_ +cloud storage server +to obtain dive log information. This means that dive log information is +stored on the mobile device only. If no dives have been entered into the dive log +yet (the usual case), an empty dive log is created. + +=== Using Cloud Storage +The _Subsurface_ developers provide a dedicated and +free Internet cloud storage account that can be used for +storing dive log information. This account can be created either from _Subsurface_ on the desktop or from _Subsurface-mobile_ +using a mobile device; you can +do full maintenance of a dive log from _Subsurface-mobile_ alone. By using the same +credentials with _Subsurface-mobile_ and _Subsurface_ for desktop, the _Subsurface_ cloud storage allows sharing of a dive +log between both (or even more than two) devices. + +The dive data on the cloud are cached locally both on the mobile device as well as on the desktop - 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. The Subsurface team never accesses a user's 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. + +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 +letters from the alphabet (upper and lower case) and/or numbers. +Tap the "Sign-in or Register" button. If you have already set +up an account from the _Subsurface_ desktop application, enter the same credentials here. +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. Once registered, _Subsurface-mobile_ remembers the cloud credentials and it is not necessary to provide these again when launching the program. + +2) 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. The user +information is stored 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. + +**** +[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 there is not a spelling mistake in the email address you provided. +2. Check that the return email containing the PIN is not in the SPAM folder of your email client. +3. Wait for 24 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 facility but I have forgotten my password. How can I reset my password?# + +Open the following web address: https://cloud.subsurface-divelog.org/passwordreset + +This will require that you enter the same email address that you used during cloud registration. +**** + +The dive log can be updated automatically. If there is Internet connectivity, _Subsurface-mobile_ accesses +the cloud-based dive log to verify that the local copy of the dive log is still the +same as the log in the cloud server. If not, the local copy and the copy on +the server are synchronized. + +=== Changing the existing login credentials on the _Subsurface_ cloud + +The login credentials can be changed, for example to work with +multiple accounts. See the section on xref:S_ChangeCloudAccount[Changing to a different _Subsurface_ cloud account]. + +== 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 main menu. This will open an email to our in app support address in the native email client, including the relevant logs. + +== Menu Structure and User Interface + +At the bottom of many _Subsurface-mobile_ screens is a round button that provides for +several actions (see image below). The most common choice is indicated in a round colored _action button_ (in the case below, edit a dive). Alternative actions are indicated in a white _action bar_. +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. + +image::mobile-images/Actionbutton.jpg["FIGURE: Action Button",align="center"] + +On iOS devices, on screens where a "back" action is enabled, a back arrow +is shown in the top left corner of the screen. + +For 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. There are three ways to open the main menu: + +- Tap the "hamburger" symbol in the lower left corner of the screen + (easy to reach for hand held devices) +- Swipe towards the right across the left edge of the screen + +image::mobile-images/Menusystem.jpg["FIGURE: Dive management sub-panel",align="center"] + +The image above 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. + +All screenshots in this user manual are currently from the Android +version. The iOS screens look similar. + +== 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, after which the dive list is shown. Once the list is loaded you can scroll up and down through your dive history. +To upload dives from a dive computer, tap the blue action button. If you wish +to add a dive manually, tap the + button in the action bar (described 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. + +image::mobile-images/Divelist2.jpg["FIGURE: Dive list screen",align="center"] + +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.). + +== Filter the dive list + +Use this action button: + +image::mobile-images/FilterButton.jpg["FIGURE: Filter button",align="center"] + +at the bottom of the dive list to perform filtering of the dive list (see image on left above). + +image::mobile-images/Filter.jpg["FIGURE: Filter tool",align="center"] + +By default, all the dives in the dive log are shown in the dive list. After several years your dive log can become quite long and, sometimes, you might like to list only the dives of a particular type, e.g. those at a particular dive site or those with a specific buddy or dive master. Use the Filter to achieve this. The filter mechanism searches through all the information for each dive, looking for one or more key words. Only the dives containing these key words are listed in the dive list. In the xref:S_Settings[_Settings_] screen there two options that affect the way the filter searches for appropriate information. Firstly, you can select _Match filter case sensitive_ which causes the search of key words to be case sensitive. Secondly, you can select _Include notes in full text filtering_. If this option is not selected, the filter does not search through the dive notes for key words. Selecting the _Filter_ action button brings up a text box at the top of the dive list. Type the key words to be searched for. In the image on the left, the dive list has been filtered for the word "Nitrox" and 265 dives were found containing this word as a tag. For each trip in the dive list the number of dives containing "Nitrox" as a tag is shown. To clear the filter, remove the key words from the text box and select the Filter action button to switch off filtering. + +== 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 _Main 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. + +== Viewing the location of a dive on _Google Maps_ + +image::mobile-images/Map.jpg["FIGURE: Map of dive site",align="center"] +In the _Details View_, the Action Bar at the bottom has a GPS pin on the +left hand side. Tap that pin and the dive site is shown in Google Maps. Close Google Maps by using the Android _Back_ button +or tapping on the _Subsurface-mobile_ link in the top left corner on iOS. + +Alternatively, the _Details View_ has a button at the top right hand marked +_Map it_. Tap this button to open Google Maps showing the dive site (image on left). + +[[S_View_Dive]] +== View a dive + +When you tap on a dive in the _Dive List_, a new screen 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 so the interesting parts are shown. + +[[S_Edit_Dive]] +== Edit a particular dive + +image::mobile-images/Editdive.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 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. + +[[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" 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_. + +image::mobile-images/Manualdive.jpg["FIGURE: Manual dive entry screen",align="center"] + +== 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 + +Delete a dive from the dive list by long-pressing a dive +until a red dustbin appears on the right-hand side (see image above). 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. + +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. By default, the following fields are copied: + +image::mobile-images/Delete_undo.jpg["FIGURE: Undo delete dive",align="center"] + +[[S_Download]] +== Download dives from a dive computer + +From the main menu, +tap _Manage dives -> Download from DC_. A screen is shown requiring that the user specify +the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel dive +computer, the vendor is _Shearwater_ and the Dive computer name is _Petrel_(see image on the left, below). +*Caveats:* The download feature in smartphones supports only a limited number of dive computers. On +Android devices these are typically dive computers using an FTDI interface +using a USB OTG cable (but this is blocked on some Android devices by OS +settings). 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. 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 are not used any more. Achieve this by selecting the option +_Forget remembered dive computers_ in the xref:S_Settings[_Settings_] menu. +After all these caveats, let us proceed with download. + +*For USB FTDI dive computers:* +This feature is not supported on iOS and on most newer Android devices. It still works on some older +Android devices (typically Android 7 and older) and is kept enabled for this +reason. Note: USB cables "normally" used for uploading dives to a +desktop/laptop computer do NOT work; these +cables usually have a full-sized ("Type A") male USB plug +on one end which plugs into the USB port of a desktop/laptop computer. For downloads to a mobile device +one needs a USB OTG (USB On-The-Go) cable. + +[width="100%", frame="None"] +|======= +a|image::mobile-images/USB-OTG.jpg["FIGURE: USB-OTG cable",align="center"] | +In most cases it is required to plug the USB +cable "normally" used with the dive computer into a USB OTG cable which, +in turn, plugs into the mini-USB (or sometimes a USB "Type C") +receptacle of the mobile device. The +OTG cable usually has a full-size ("Type A") female receptacle at one end which +accommodates the full-sized male plug +of the USB cable "normally" used (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* +and even on some devices that do support those cables in general, as mentioned above _Subsurface-mobile_ +does usually not support cable based downloads, except on some older Android devices. +|======= + +_Subsurface_ 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 "FTDI". + +*For BLUETOOTH/BTLE 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 BTLE 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. Use the tools on the mobile device to achieve pairing between the Bluetooth dice computer +and the mobile device. For many Android devices, +the Settings -> Bluetooth tool of Android is probably appropriate. +_Subsurface-mobile_ performs communication using both Bluetooth and Bluetooth-low-energy (BTLE). +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 Bluetooth-low-energy (BTLE), 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 BTLE. The _Connection_ +information indicates that the Petrel with no BTLE is selected. + +*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 few minutes. +As a matter of fact, a complete first download from some dive computers can take 45 minutes or longer. +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 be added to the +_Subsurface-mobile_ dive list: dives that are not checked are ignored. With the appropriate downloaded dives +having been checked, tap the button at the bottom left labeled _Accept_. All the selected dives appear on +the _Subsurface-mobile_ dive list. The downloaded dive information can now 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"] + +== 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 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 main menu +(by tapping the "Hamburger" icon at the bottom left of the screen). +Tap the option _Dive management_, enabling a number of options: + +=== Add new dive manually + +This is described above under the section dealing with xref:S_Add_Dive[Manually adding a new dive to the dive list]. + +=== Download from DC + +This is described above under the section dealing with xref:S_Download[Download dives from a dive computer]. + +=== Apply GPS fixes + +This is described in the following main section, below. + +=== Manually sync the dive log with the _Subsurface_ cloud storage + +Upload the dives contained on the mobile device +to the _Subsurface_ cloud storage by tapping the option _Manual sync with cloud_. +This synchronizes the local changes to +the dive log with the cloud storage. It also downloads changes made to +the dive log using another device or computer and stored in shared cloud storage. + +=== 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 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 every time that +_Subsurface-mobile_ is closed. + +== Recording dive locations using GPS + +The fact that most 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: + +[[S_ConfigureGPS]] +=== Configuring the GPS service + +From the _Main Menu_, select xref:S_Settings[_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. + +image::mobile-images/GPS-config.jpg["FIGURE: GPS configure",align="center"] + +=== Collecting GPS positions + +[width="100%", frame="None"] +|======= +a|image::mobile-images/GPSstart.jpg["FIGURE: GPS start",align="center"] | +On the _Main Menu_ select _GPS -> 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. +|======= + +=== Viewing GPS data + +From the _GPS_ submenu 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 +teardrop-shaped icon (actually a Google Maps 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. + +image::mobile-images/gpsmanagement.jpg["FIGURE: GPS management",align="center"] + +=== 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, apply the GPS positions to +these dives. GPS positions can only be applied to dives in the dive list. +From the _Dive management_ sub-panel, 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. + +[[S_Settings]] +== Specifying the settings for _Subsurface-mobile_. + +The _Settings_ screen allows the customization of _Subsurface-mobile_. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting. + +[[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 _Settings_ on the Main menu and scroll to the section titled _Cloud status_ (see image below). +Tap the _Change_ button. This opens the _Cloud credentials_ screen. +change the credential information, then tap the button _Sign-in or register_. The appropriate dive list is shown. + +image::mobile-images/SettingsCloudTheme.jpg["FIGURE: Settings: Cloud & Theme",align="center"] + +=== Changing the color theme of _Subsurface-mobile_ + +[width="100%", frame="None"] +|======= +a|image::mobile-images/PinkTheme.jpg["FIGURE: GPS start",align="center"] | +_Subsurface-mobile_ has three color schemes to please users with different +tastes (see image above). This user manual shows the default color scheme, comprising blue +colors. Change to a pink or a dark color scheme by opening the main menu, +tap _Settings_, and scroll to the section with heading _Theme_ (see image above). +Select the appropriate color theme by dragging the appropriate slider on the right-hand. +On the left is the dive list after selecting the Pink theme. +|======= + +=== Configuring the GPS webservice + +The Settings screen allows one to set up the way in which GPS positions are collected during dives. See the section on xref:S_ConfigureGPS[Configuring the GPS service]. + +=== Activating the Developer sub-menu + +The information in the subsurface.log generated while running _Subsurface-mobile_, plus some additional information for understanding the screen rendering of dive information as well as the way in which _Subsurface-mobile_ processed information during a specific occasion while running the app (see section below) is available through a _Developer_ menu at run time. Activate (or deactivate) this menu item on the Main Menu by dragging the slider switch in the Settings screen. +If _Display developer menu_ has been activated in the _Settings screen_, the Main menu has a _Developer_ item. By tapping this one has two options that are relevant within +the context of program development and debugging. + +=== App log + +This option shows the messages that _Subsurface-mobile_ generates while running. While +most users are not aware of these messages, they are often crucial in detecting any +abnormal behavior of the app. The App log can be found in the root directory of the local storage of the mobile device. + +=== Theme information + +This option provides a wealth of information about the screen characteristics of the mobile +device and the font characteristics used by _Subsurface-mobile_. + + diff --git a/Documentation/mobile-manual-v3.html.git b/Documentation/mobile-manual-v3.html.git index 28eb03154..0962fd61c 100644 --- a/Documentation/mobile-manual-v3.html.git +++ b/Documentation/mobile-manual-v3.html.git @@ -1,427 +1,564 @@ - - - + + - - - - -

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 +

Subsurface-mobile User Manual

Manual authors: Willem Ferguson, Dirk Hohndel

Version 3.0.5, May 2020

+ +

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, +monetizing your data, etc).

Subsurface-mobile is a limited mobile version of the desktop software 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, @@ -429,418 +566,467 @@ you can prove dive experience on a dive trip to dive shops or review previous dives while on a dive boat. 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 +your choice, Subsurface-mobile supports the downloading of dives from your dive computer.

Users of Subsurface-mobile often 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:

Subsurface-mobile

-
-Download and storage of dive log information using the Subsurface cloud. -
+
Download and storage of dive log information using the Subsurface cloud.
-
-Viewing this information on a mobile device. -
+
Viewing this information on a mobile device.
-
-Manually creating and adding new dive records to your dive log. -
+
Manually creating and adding new dive records to your dive log.
-
-Download dive data directly from some dive computers. -
+
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. -
+
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. -
+
Recording, storing and applying GPS positions to dive information.
-
-Viewing the locations of recorded GPS positions and of dives - on a map. -
+
Viewing the localities of recorded GPS positions and of dives +on a map.

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

Subsurface-mobile has some limitations compared to Subsurface:

+ +

These items are discussed in greater detail below.

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 +
Only a subset of the dive computers supported for download by the desktop +version work with Subsurface-mobile, this being determined +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. -
+are accessible. On iOS, only Bluetooth LE based +dive computers are supported.
-
-No dive planner. -
+
No dive planner.
-
-No printing. -
+
No printing.
-
-No support for media embedded in dive profiles (Subsurface allows to reference images and video clips directly in the dive profile). -
+
No support for media embedded in dive profiles (Subsurface allows access to +images and video clips directly from the dive profile).

2. Installing Subsurface-mobile on your mobile device

1. Installing Subsurface-mobile on your mobile device

Find Subsurface-mobile in the Google Play Store or the Apple App 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.

Find Subsurface-mobile in the Google Play Store or the Apple App 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

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

The best place to get support is the Subsurface User Forum. Additionally, Subsurface-mobile allows +you to send a support request 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

3. 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 right from the very left edge of the screen. The entries in the main menu are all explained -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.

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

You have access to the Main menu through a Hamburger button (three short +horizontal lines) in the lower left corner of the screen. Additionally, the Main menu can be opened by swiping +towards the right from the very left edge of the screen. +In addition, many screens have a Context menu available through a button with three vertical dots in +the lower right corner and that can be opened by tapping and holding a dive or trip header in the dive list.

Additionally, at the bottom of many Subsurface-mobile screens is a round +

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 +actions on that screen (see image on the left). Some screens have only +the round central button, others have one or two additional +actions on either side of the central 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. +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.

+are the sub-menus.

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

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

4. Using Subsurface-mobile for the first time

When you start Subsurface-mobile for the first time, a Subsurface +

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 left image below).

+(see left image below).

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.

4.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. Following installation an empty dive log is created.

5.2. Using Cloud Storage

The Subsurface maintainer provides a dedicated and +

4.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 +You can use this to store your dive log and to share your data between several computers and devices. The Subsurface team never accesses your dive data without explicit permission to do so, the data are not used for any other purpose 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 +created them. There are no ads and no harvesting / analysis of the data / monetization of data +on the Subsurface Cloud storage.

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 +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). +without an 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 +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 +copy on the mobile device. This avoids long delays or even failure of operations if there is poor +internet connectivity. 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 right image above). A PIN is e-mailed +manual sync entry in the Dive management menu entry).

3) If this is a new cloud account, a PIN screen will open (see right image 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 +is no longer needed - it just proves that this is indeed your email account.

A video-tutorial is available that demonstrates +how to connect to the cloud.

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.

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

- +

+ + - -

+Cloud problems: FAQ

Cloud problems: FAQ

+ + +

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

-
-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 encounter, as autocorrect often mangles email addresses. -
+
Check carefully for spelling mistakes in the email address you provided. This is a common problem since autocorrect often mangles email addresses.
-
-Check that the return email containing the PIN is not in the SPAM/Junk folder of your email client. -
+
Check that the return email containing the PIN is not in the SPAM/Junk folder of your email client.
-
-Wait for a few hours and check again for an email with a PIN. -
+
Wait for a few hours and check again for an email with a PIN.
-
-If there is still no email containing a PIN, send mail to in-app-support@subsurface-divelog.org -
+
If there is still no email containing a PIN, send mail to in-app-support@subsurface-divelog.org

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 password reset website

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.

+ +

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

The Help menu has an option Reset forgotten Subsurface Cloud password. Use that or go to the password reset website

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

6. The Dive List

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

The Dive List is the heart of Subsurface-mobile because most of the actions +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, 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.

+and down through your dive history.

The Dive List consists of two types of entries:

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

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

+
Trip headers. A trip header is a line describing the year and month during which a dive trip +took place, as wel as the geographical area of the trip. The second line in the lefthand image below indicates that a 10-dive trip +was made to Guinjata, Moçambique during December 2016.
+
+
Individual dive records. Tapping a trip header expands the dive list to show (or hide) the individual dives performed during the trip. Each dive is represented by a dive record. By default the dives during the last trip are listed with older dives at the bottom and recent dives at the top of the list. In the lefthand image below the last dive during +the Guinjata trip was in the Inhambane Estuary.
+

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.

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 pinch gesture +

5.1. View a dive: the Details view

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 (image on right above). 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 +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 +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 changes.

+forwards through recent changes.

6.3. Viewing the location of a dive on a map

5.2. Viewing the location of a dive on a map

In the Details View, you can either tap the name of a dive site +

In the Details View, you can either tap the name of a dive site or the GPS pin on the left hand side of the Action Button at the bottom of the screen in order to open a map with the dive site in an integrated map viewer. This of course is only possible if the dive site is associated with GPS -information.

+information.

6.4. Edit a dive

5.3. Filter the dive list

By default, all the dives in the dive log are shown in the dive list. After several years your dive +log can become quite long and, sometimes, you might like to list only the dives of a particular +type, e.g. those at a particular dive site or those with a specific buddy or dive master. Use the +Filter to achieve this. The filter mechanism searches through all the information for each dive, +looking for one or more key words. Only the dives containing these key words are listed in the dive +list. To Filter the dive list, tap the Filter action button:

unfloat::[]

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.

at the bottom of the dive list. A text box appears at the top of the screen (image below). Type the +word(s) that you would like to use as a filter.

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.

Three filter modes exist. "Fulltext" searches all text strings. Selecting "People" lists buddies and +dive masters, while "Tags" only filters for tags containing the given text. Filters are not case-sensitive. +To clear the filter, remove the key words from the text box and select the Filter action button to +switch off filtering. The image above represents a full-text search for dives with the word "nitrox".

7. Dive Management

6. Dive List Management and adding dive information

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.

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

6.1. Manually adding a new dive to the dive list

This video-tutorial explains how to add information to a +manually-entered dive.

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.

+the same dive in Details View. After editing the dive information, the dive trip information +needs to be edited as described in the section above on Dive trip editing.

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 +

6.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 on smartphones supports only a limited number of dive computers. On +opened automatically. A screen is shown requiring that the user specify +the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel dive +computer, the vendor is Shearwater and the Dive computer name is Petrel (see image on the left, below). +Caveats: 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 left image below - -section Start the download).

TODO: image of DL missing - or link to the 7.2.3 Start the download

When downloading from multiple different dive computers, shortcut +computers. Use the Vendor name and Dive Computer drop-downs to pick the correct +dive computer. 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 are not used any more. Achieve this by selecting the option +Forget remembered dive computers in the Settings menu. +After all these caveats, let us proceed with download.

TODO: image of DL missing - or link to the 7.2.3 Start the download

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.

+Forget remembered dive computers in the Settings menu.

7.2.1. Download from USB serial dive computers

This feature is not supported on iOS.

- --+

6.2.1. Download from USB serial dive computers

This feature is not supported on iOS.

++++ - -

Most current Android devices now have a USB +

Most current Android devices now have a USB Type C port and come with a simple A-to-C adapter plug, which lets you 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 @@ -854,333 +1040,501 @@ but usually all modern Android devices with a USB C plug can be used with a USB

Subsurface-mobile remembers the settings for dive computers that +

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

+(and USB connection number) is shown. Most users only connect one USB dive computer to +their Android device and then things are fairly straightforward. A dialog appears asking if +you want to use Subsurface-mobile to connect to the device. If you confirm, then Subsurface-mobile +opens 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 +

6.2.2. Download from Bluetooth and Bluetooth LE dive computers

This video-tutorial demonstrates downloading dives from a +Bluetooth-equipped dive computer.

The process for Bluetooth download differs between Android and iOS. In iOS the best +results are obtained when the dive computer was +in Bluetooth LE mode before Subsurface-mobile is started. On most dive +computers this is done through a menu entry, others (e.g. Suunto) always respond to Bluetooth LE requests.

In contrast, for Bluetooth-equipped dive computers and Android devices, first 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 +Subsurface-mobile performs communication using both Bluetooth and Bluetooth LE (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 dive computer 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.

+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 in the image below indicates that the Petrel with no BLE is selected. For +Bluetooth LE dive computers, the Connection value has an "LE" prefix.

This video-tutorial demonstrates setting up a +Bluetooth connection with an Android device.

7.2.3. Start the download

With communication between dive computer and Subsurface-mobile +

6.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 +long dives and a slow Bluetooth LE 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 right image 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 +the most recent dive at the top (see right image 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 have 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.

+the Subsurface-mobile dive list.

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

6.3. Edit the dive information

This video-tutorial explains how to add information about a dive.

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

7. Edit the dive trip information

When a new dive(s) is entered manually or downloaded from dive computer, a trip header is created at the +top of the dive list only showing the month and the year of the dive trip as well as the number of dives +during the trip (image on left below, showing a trip header with "May 2018", the trip comprising two dives). +You would probably like to include information about the place +where the trip took place, e.g. "Channel Islands" or the dive charter company used. In this case long-press +the dive trip header to activate the context menu. Select the option "Edit trip details" to open a panel +for typing information about the trip (image on right, below). Having provided the required information, +tap the Save action button at the bottom of the screen. This returns you to the dive list, showing some of +the dive trip information that has just been provided.

7.1. Deleting a dive

Delete a dive from the dive list by long-pressing a dive and selecting delete in the context menu. +If the wrong dive was deleted by mistake you can easily undo the operation by using the context menu.

8. Interacting with the cloud storage

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

+or after manually adding or editing dive information on the mobile device. +This can also be triggered by pulling down (and briefly holding) the topmost entry of the Dive List.

7.4. Enable cloud auto sync

By default Subsurface-mobile runs offline and only syncs the dive list +

8.2. 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 +You can choose to always sync with the cloud server. This is not recommended unless you are in -an area with a fast and reliable internet connection, as otherwise +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.

+Subsurface-mobile.

7.5. Dive Summary

The Dive Summary page provides a very simple overview of your diving activities - which can for example +

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

+and the dives during the last six months.

7.6. 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 allows 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).

9.1. 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 allows 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 for the destination website (or a file selection dialog).

8. Location

10. Obtaining dive site locations using the GPS

The fact that almost all smartphones have GPS facilities allows +

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 +the locations of dives.

+
+ + + + + +
+ + +Accuracy of GPS coordinates +
+
+

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. +As of Android V6 (Marshmallow) 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 as described in following chapters.

+during a dive, locations can be automatically recorded at regular intervals. +These locations can then be applied to dives in the dive list as described below

To collect dive site coordinates four step are required:

8.1. Configuring the GPS service

For most users, the defaults for tracking GPS locations will be +

10.1. Configuring the GPS service

For most users, the defaults for tracking GPS locations are appropriate. If you would like to change them, go to the Main Menu, select the Settings screen, and open -the Advanced area on that page. Here you will find the section for +the Advanced area on that page where there is a 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.

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

8.2. Collecting GPS positions

- --+

10.2. Collecting GPS positions

++++ - - +to check between dives that the location service is still running. On the other hand +the battery consumption of a smartphone with GPS enabled is often significantly less than +the battery consumption of a dedicated GPS that is logging a track.

In the Location menu select Run location service. +

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 +location service is running, all menus have a GPS symbol at the bottom, +indicating that the service is active. After returning from the dive, 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 +the option Location → Disable location service. The GPS symbol at the bottom +of 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.

10.3. Viewing GPS data collected during a dive

From the Location submenu 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 +teardrop-shaped icon (actually a Google Maps 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.

8.3. Applying GPS data to dives in the dive log

After running the location service during a dive trip, first either download +

10.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 dive computer 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.

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

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

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

The locations of all dives in the dive list can be viewed from the Location menu by selecting the Map option. +

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.

+of the different dive sites.

9. Settings

12. Specifying the settings for Subsurface-mobile

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

The Settings page allows the customization of Subsurface-mobile. +It is grouped into four sections. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting.

9.1. General settings section

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

12.1.1. Cloud status: Changing to a different Subsurface cloud account

Some users have more than one Subsurface cloud account and need to switch between accounts. +Tap on the Change button next to the Email address in the General settings on the Settings page (see image above). 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.

+The dive list of the newly-opened account is shown.

9.1.2. Default cylinder

When manually entering a dive or when downloading from a dive computer that doesn’t explicitly +

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

+uses the cylinder that you select here as the default, useful for divers that mostly use a particular +type of cylinder. 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.

12.1.3. Forget the remembered dive computers used during dive download

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

9.2. Theme section

12.2. Theme section

9.2.1. Color theme

- --+

12.2.1. Color theme

++++ - - +

The boxes in the image on the left show the various color choices in the theme of your choice.

Besides the default blue color scheme, Subsurface-mobile supports two additional color schemes +

Besides the default blue color scheme, Subsurface-mobile supports two additional color schemes for users with different tastes (see image on left). All screenshots shown in this user manual are -based on the blue default color scheme. You can pick the pink or dark color scheme from +based on the blue default color scheme. You can pick the pink or dark color theme 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.

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

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

+your location.

9.4. Advanced section

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

12.4. Advanced section

As the name indicates, most users do 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

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

12.4.2. Bluetooth

Since most mobile 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 +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.

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

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

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

12.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 user. 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

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

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

13.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 is not available without Internet access.

10.3. Ask for support

This item opens your default email client with a pre-populated email to the Subsurface +

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

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

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

- + \ No newline at end of file diff --git a/Documentation/mobile-manual-v3.txt b/Documentation/mobile-manual-v3.txt index e7843dde1..77e877eeb 100644 --- a/Documentation/mobile-manual-v3.txt +++ b/Documentation/mobile-manual-v3.txt @@ -18,10 +18,9 @@ image::mobile-images/Banner.jpg["Banner",align="center"] // toc::[] -[blue]#_Version 3.0.0, March 2020_# +[blue]#_Version 3.0.5, May 2020_# -Introducing _Subsurface-mobile_ ------------------------------ +toc::[] Welcome to _Subsurface-mobile_, the mobile version of _Subsurface_, advanced dive logging software with extensive infrastructure to display, organize, and interpret scuba @@ -31,7 +30,7 @@ open-source software (in simple terms that means that there is no commercial int 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_, +_Subsurface-mobile_ is a limited mobile version of the desktop software _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, @@ -39,14 +38,13 @@ you can prove dive experience on a dive trip to dive shops or review previous dives while on a dive boat. _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. +your choice, _Subsurface-mobile_ supports the downloading of dives from your dive computer. -Users of _Subsurface-mobile_ typically use the +Users of _Subsurface-mobile_ often 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. - +However _Subsurface-mobile_ is a fully fledged application in its own right that can +also be used independently of the desktop version with or without the use of cloud storage. _Subsurface-mobile_ allows: - Download and storage of dive log information using the _Subsurface_ cloud. @@ -55,59 +53,57 @@ _Subsurface-mobile_ allows: - 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 +- Recording, storing and applying GPS positions to dive information. +- Viewing the localities of recorded GPS positions and of dives on a map. -These items are discussed in greater detail in the following chapters. +These items are discussed in greater detail below. _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 +version work with _Subsurface-mobile_, this being determined +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 +are accessible. 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 reference images and video clips directly in the dive profile). +- No support for media embedded in dive profiles (_Subsurface_ allows access to + images and video clips directly from the dive profile). == Installing _Subsurface-mobile_ on your mobile device Find _Subsurface-mobile_ in the _Google Play Store_ or the _Apple App Store_ -and install it. For Android devices without access to the _Google Play 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 https://subsurface-divelog.org/user-forum[_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 +you to send a support request 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 right from the very left edge of the screen. The entries in the main menu are all explained -starting in section xref:S_Dive_Management[_Dive Management_]. +open source project called _Kirigami_, maintained by the _KDE/Plasma_ development community. +It has a slightly different look and feel than many native Android and iOS apps, +but we find it easy and intuitive to work with. -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. +You have access to the _Main menu_ through a _Hamburger_ button (three short +horizontal lines) in the lower left corner of the screen. Additionally, the _Main menu_ can be opened by swiping +towards the right from the very left edge of the screen. +In addition, many screens have a _Context menu_ available through a button with three vertical dots in +the lower right corner and that can be opened by tapping and holding a dive or trip header in the dive list. image::mobile-images/ActionButton2.jpg["FIGURE: Action Button",float="left"] -Additionally, at the bottom of many _Subsurface-mobile_ screens is a round +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. +actions on that screen (see image on the left). Some screens have only +the round central button, others have one or two additional +actions on either side of the central button. unfloat::[] @@ -118,7 +114,7 @@ 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. +are the sub-menus. image::mobile-images/Subsurface-mobile-menu-system.jpg["FIGURE: Subsurface-mobile menu system",align="center"] @@ -137,16 +133,16 @@ image::mobile-images/Credentials.jpg["FIGURE: Mobile credentials screen",align=" === 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. +on your device. Following installation an empty dive log is created. === 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 +You can use this to store your dive log and to share your data between several computers and devices. The _Subsurface_ team never accesses your dive data without explicit permission to do so, the data are not used for any other purpose 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. +created them. There are no ads and no harvesting / analysis of the data / monetization of data +on the _Subsurface Cloud_ storage. _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 @@ -156,7 +152,7 @@ The dive data in the cloud are cached locally on any device or computer that is 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. +without an Internet connection. To create a _Subsurface Cloud_ account follow these steps: @@ -170,8 +166,8 @@ 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 +copy on the mobile device. This avoids long delays or even failure of operations if there is poor +internet connectivity. 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). @@ -180,6 +176,9 @@ to the email address entered in the previous step. Enter this PIN into the field 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. +A https://www.youtube.com/watch?v=Vp_bEm5ZDRA[*video-tutorial*] is available that demonstrates +how to connect to the cloud. + 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. @@ -194,72 +193,50 @@ provide these again when launching the program. [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 encounter, as autocorrect often mangles email addresses. +1. Check *carefully* for spelling mistakes in the email address you provided. This is a common problem since autocorrect often mangles email addresses. 2. Check that the return email containing the PIN is not in the SPAM/Junk 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 https://cloud.subsurface-divelog.org/passwordreset[password reset website] +The _Help menu_ has an option _Reset forgotten Subsurface Cloud password_. Use that or go to the https://cloud.subsurface-divelog.org/passwordreset[password reset website] -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. +Simply enter the same email address that you used during cloud registration and follow the indicated steps. +To prevent abuse of this system a confirmation email will be sent to your account. **** +The dive log can be updated automatically. If there is Internet connectivity, _Subsurface-mobile_ accesses +the cloud-based dive log to verify that the local copy of the dive log is still the +same as the log in the cloud server. If not, the local copy and the copy on +the server are synchronized. == 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, +The _Dive List_ is the heart of _Subsurface-mobile_ because most of the actions +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, 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. +The Dive List consists of two types of entries: -image::mobile-images/DiveListAndDetails.jpg["FIGURE: Dive list screen",align="center"] +1. *Trip headers*. A trip header is a line describing the year and month during which a dive trip +took place, as wel as the geographical area of the trip. The second line in the lefthand image below indicates that a 10-dive trip +was made to Guinjata, Moçambique during December 2016. -A tap and hold on a dive or a trip header opens the context menu for that entry. +2. *Individual dive records*. Tapping a trip header expands the dive list to show (or hide) the individual dives performed during the trip. Each dive is represented by a dive record. By default the dives during the last trip are listed with older dives at the bottom and recent dives at the top of the list. In the lefthand image below the last dive during +the Guinjata trip was in the Inhambane Estuary. -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 changes. +image::mobile-images/Divelist2.jpg["FIGURE: Dive list screen",align="center"] -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 +=== View a dive: the Details view 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 +and many important details about the dive is opened (image on right above). 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. @@ -284,81 +261,52 @@ to open a map with the dive site in an integrated map viewer. This of course is only possible if the dive site is associated with GPS information. -[[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. +=== Filter the dive list +By default, all the dives in the dive log are shown in the dive list. After several years your dive +log can become quite long and, sometimes, you might like to list only the dives of a particular +type, e.g. those at a particular dive site or those with a specific buddy or dive master. Use the +Filter to achieve this. The filter mechanism searches through all the information for each dive, +looking for one or more key words. Only the dives containing these key words are listed in the dive +list. To Filter the dive list, tap the Filter action button: -// == 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. +unfloat::[] -=== Deleting a dive +image::mobile-images/FilterButton.jpg["FIGURE: Filter button",align="center"] -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_ +at the bottom of the dive list. A text box appears at the top of the screen (image below). Type the +word(s) that you would like to use as a filter. -If you deleted the wrong dive by mistake you can easily undo the operation in the context menu. +image::mobile-images/Filter.jpg["FIGURE: Filter tool",align="center"] -image::mobile-images/UndoDelete.jpg["FIGURE: Undo delete dive",align="center"] +Three filter modes exist. "Fulltext" searches all text strings. Selecting "People" lists buddies and +dive masters, while "Tags" only filters for tags containing the given text. Filters are not case-sensitive. +To clear the filter, remove the key words from the text box and select the Filter action button to +switch off filtering. The image above represents a full-text search for dives with the word "nitrox". [[S_Dive_Management]] -== Dive 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 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. +== Dive List Management and adding dive information [[S_Add_Dive]] === Manually adding a new dive to the dive list +This https://www.youtube.com/watch?v=sF8KB_r0rFw[*video-tutorial*] explains how to add information to a +manually-entered dive. + 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 +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_. +the same dive in _Details View_. After editing the dive information, the dive trip information +needs to be edited as described in the section above on xref:S_Divetrip[Dive trip editing]. -image::mobile-images/ManualAddDive.jpg["FIGURE: Manual dive entry screen",align="center"] +image::mobile-images/Manualdive.jpg["FIGURE: Manual dive entry screen",align="center"] [[S_Download]] === Download dives from a dive computer @@ -366,23 +314,24 @@ image::mobile-images/ManualAddDive.jpg["FIGURE: Manual dive entry screen",align= 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 +opened automatically. A screen is shown requiring that the user specify +the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel dive +computer, the vendor is _Shearwater_ and the Dive computer name is _Petrel_ (see image on the left, below). +*Caveats:* 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 left image below - -section Start the download). +computers. Use the _Vendor name_ and _Dive Computer_ drop-downs to pick the correct +dive computer. 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 are not used any more. Achieve this by selecting the option +_Forget remembered dive computers_ in the xref:S_Settings[_Settings_] menu. +After all these caveats, let us proceed with download. -TODO: image of DL missing - or link to the 7.2.3 Start the download +*TODO: image of DL missing - or link to the 7.2.3 Start the download* 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 @@ -414,71 +363,116 @@ 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 +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 +(and USB connection number) is shown. Most users only connect one USB dive computer to +their Android device and then things are fairly straightforward. A dialog appears asking if +you want to use _Subsurface-mobile_ to connect to the device. If you confirm, then _Subsurface-mobile_ +opens 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 +==== Download from Bluetooth and Bluetooth LE dive computers -The process for Bluetooth download is slightly different between Android and iOS. +This https://www.youtube.com/watch?v=DCi70WZMTws[*video-tutorial*] demonstrates downloading dives from a +Bluetooth-equipped dive computer. -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. +The process for Bluetooth download differs between Android and iOS. In *iOS* the best +results are obtained when the dive computer was +in Bluetooth LE mode before _Subsurface-mobile_ is started. On most dive +computers this is done through a menu entry, others (e.g. Suunto) always respond to Bluetooth LE requests. -For Bluetooth-equipped dive computers and Android devices, establish a Bluetooth connection between the dive computer and the +In contrast, for Bluetooth-equipped dive computers and *Android* devices, first 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 +_Subsurface-mobile_ performs communication using both Bluetooth and Bluetooth LE (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 dive computer 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. +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 in the image below indicates that the Petrel with no BLE is selected. For +Bluetooth LE dive computers, the _Connection_ value has an "LE" prefix. + +This https://www.youtube.com/watch?v=4MtQqm4o7bw[*video-tutorial*] demonstrates setting up a +Bluetooth connection with an Android device. ==== 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 +long dives and a slow Bluetooth LE 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 right image 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 +_Subsurface-mobile_ dive list: dives that are not checked are ignored. Once you have 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]. +the _Subsurface-mobile_ dive list. image::mobile-images/DC-Download.jpg["FIGURE: DC download screen",align="center"] +[[S_Edit_Dive]] +=== Edit the dive information + +This https://www.youtube.com/watch?v=pE3ujzGw_7o[*video-tutorial*] explains how to add information about a dive. + +image::mobile-images/Editdive.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 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 above). +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. + +[[S_Divetrip]] +== Edit the dive trip information + +When a new dive(s) is entered manually or downloaded from dive computer, a trip header is created at the +top of the dive list only showing the month and the year of the dive trip as well as the number of dives +during the trip (image on left below, showing a trip header with "May 2018", the trip comprising two dives). +You would probably like to include information about the place +where the trip took place, e.g. "Channel Islands" or the dive charter company used. In this case long-press +the dive trip header to activate the context menu. Select the option "Edit trip details" to open a panel +for typing information about the trip (image on right, below). Having provided the required information, +tap the _Save_ action button at the bottom of the screen. This returns you to the dive list, showing some of +the dive trip information that has just been provided. + +image::mobile-images/TripDetails.jpg["FIGURE: Edit trip details",align="center"] + +=== Deleting a dive + +Delete a dive from the dive list by long-pressing a dive and selecting delete in the context menu. +If the wrong dive was deleted by mistake you can easily undo the operation by using the context menu. + +image::mobile-images/Delete_undo.jpg["FIGURE: Undo delete dive",align="center"] + +== Interacting with the cloud storage + === 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_. +or after manually adding or editing dive information on the mobile device. +This can also be triggered by pulling down (and briefly holding) the topmost entry of 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 +You can choose to always sync with the cloud server. This is not recommended unless you are in -an area with a fast and reliable internet connection, as otherwise +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 @@ -487,7 +481,7 @@ of closing an app (you can just kill it, which doesn't allow for a final sync wi In general it is safer to manually sync with the cloud once you are done making changes in _Subsurface-mobile_. -=== Dive Summary +== 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 @@ -500,31 +494,40 @@ 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 allows local file based exports as _Subsurface_ +to two websites (_divelogs.de_ and _diveshare_). On iOS it also allows 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). +Tapping on _Next_ opens an additional page for login information for the destination website (or a file selection dialog). -== Location +== Obtaining dive site locations using the GPS 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 +the locations of dives. + +**** +[icon="images/icons/important.png"] +[IMPORTANT] +*Accuracy of GPS coordinates* + +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._* +As of Android V6 (Marshmallow) 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 as described in following chapters. +during a dive, locations can be automatically recorded at regular intervals. +These locations can then be applied to dives in the dive list as described below +**** +To collect dive site coordinates four step are required: [[S_ConfigureGPS]] === Configuring the GPS service -For most users, the defaults for tracking GPS locations will be +For most users, the defaults for tracking GPS locations are 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 +the _Advanced_ area on that page where there is a 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 @@ -541,18 +544,34 @@ 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 +location service is running, all menus have a GPS symbol at the bottom, +indicating that the service is active. After returning from the dive, deactivate the collection of GPS data by tapping -the option _GPS -> Disable location service_. The GPS symbol at the bottom -of all menus disappears. +the option _Location -> Disable location service_. The GPS symbol at the bottom +of 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. +to check between dives that the location service is still running. On the other hand +the battery consumption of a smartphone with GPS enabled is often significantly less than +the battery consumption of a dedicated GPS that is logging a track. |======= +=== Viewing GPS data collected during a dive + +From the _Location_ submenu 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 +teardrop-shaped icon (actually a Google Maps 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. + +image::mobile-images/gpsmanagement.jpg["FIGURE: GPS management",align="center"] + + === Applying GPS data to dives in the dive log After running the location service during a dive trip, first either download @@ -563,7 +582,7 @@ 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 +== Viewing the locations of all dives in the dive list image::mobile-images/DivesMap.jpg["FIGURE: Map of all dive sites",align="center"] @@ -573,34 +592,35 @@ of the world the dive sites appear, indicated by red flags. Zooming in even clos of the different dive sites. [[S_Settings]] -== Settings +== Specifying the settings for _Subsurface-mobile_ The _Settings_ page allows the customization of _Subsurface-mobile_. -It is grouped into four sections. +It is grouped into four sections. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting. === _General settings_ section image::mobile-images/GeneralSettings.jpg["FIGURE: General Settings",align="center"] [[S_ChangeCloudAccount]] -==== Changing to a different _Subsurface_ cloud account +==== Cloud status: 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. +Some users have more than one _Subsurface_ cloud account and need to switch between accounts. +Tap on the _Change_ button next to the _Email address_ in the _General settings_ on the _Settings_ page (see image above). 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. +The dive list of the newly-opened account 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 +uses the cylinder that you select here as the default, useful for divers that mostly use a particular +type of cylinder. If you don't set this entry, no default cylinder is used. -==== Forget the remembered dive computers +==== Forget the remembered dive computers used during dive download -Tap the _Forget_ button to reset the dive computers that are stored in the up to four shortcut +Tap the _Forget_ button to reset the dive computers that are stored in the shortcut buttons on the _Download from dive computer_ page. === _Theme_ section @@ -612,10 +632,10 @@ buttons on the _Download from dive computer_ page. 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 on left). All screenshots shown in this user manual are -based on the blue default color scheme. You can pick the _pink_ or _dark_ color scheme from +based on the blue default color scheme. You can pick the _pink_ or _dark_ color theme from the drop down menu. -The boxes below show the various color choices in the theme of your choice. +The boxes in the image on the left show the various color choices in the theme of your choice. |======= ==== Font size @@ -631,7 +651,7 @@ your location. === _Advanced_ section -As the name indicates, most users will not need to make changes here. +As the name indicates, most users do not need to make changes here. ==== GPS location service thresholds @@ -640,7 +660,7 @@ thresholds for the _location service_ ==== Bluetooth -Since most devices tend to find a _LOT_ of BT/BLE devices that aren't dive computers, by +Since most mobile 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. @@ -663,7 +683,7 @@ 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 +never useful for a regular user. 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 @@ -676,7 +696,7 @@ 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. +device. Unfortunately this option is not available without Internet access. === Ask for support diff --git a/Documentation/mobile-manual.html.git b/Documentation/mobile-manual.html.git deleted file mode 100644 index 58cf88cff..000000000 --- a/Documentation/mobile-manual.html.git +++ /dev/null @@ -1,962 +0,0 @@ - - - - - - - - - - - - -

Subsurface-mobile USER MANUAL

Manual authors: Willem Ferguson, Dirk Hohndel

Version 2, December 2017

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

1. Introducing Subsurface-mobile

Subsurface-mobile is a more limited mobile version of Subsurface -aimed at Android and iOS smartphone and tablet devices, allowing viewing, entering, sharing, and storage of dive information at dive sites where a larger -computer is not useful. While the desktop version of Subsurface shows much more detailed information -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 also allows -the gathering of GPS locations where dives are performed.

Users of Subsurface-mobile typically use the -mobile app as a companion to the laptop/desktop version of Subsurface, sharing dive information -between the mobile and the desktop versions. 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 many dive computers. -
-
-
-Editing many of the dive log data fields, e.g. divemaster, buddy, - equipment or notes relating to a dive. -
-
-
-Recording, storing and applying GPS positions of dives. -
-
-
-Viewing the localities of recorded GPS positions and of dives - on a map. -
-

These items are discussed in greater detail in the following text. -Subsurface-mobile does not support download of dive data from all the -dive computers that the desktop/laptop version can. This limitation is -mainly caused by the ability to access different type of devices on the -two mobile platforms. On Android, a subset of -dive computers that use a FTDI USB interface or a Bluetooth / Bluetooth LE interface -are accessible by Subsurface-mobile. On iOS, only Bluetooth LE based -dive computers are supported.

2. Installing Subsurface-mobile on your mobile device

Find Subsurface-mobile in the Google Play Store or the iTunes Store -and install it. Please note that both stores also contain the older Subsurface companion app (used only for tracking GPS positions) - make sure you actually install Subsurface-mobile.

3. 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. After loading, the Cloud Credentials screen appears -(see image below on left).

3.1. When NOT Using Cloud Storage

Tap the "No cloud mode" button. The app will not access the Subsurface -cloud storage server -to obtain dive log information. This means that dive log information is -stored on the mobile device only. If no dives have been entered into the dive log -yet (the usual case), an empty dive log is created.

3.2. Using Cloud Storage

The Subsurface developers provide a custom -free Internet cloud storage account that can be used for -storing dive log information. This cloud storage account can be created either from Subsurface on the desktop or Subsurface-mobile -using a mobile device; you can -do full maintenance of a dive log from Subsurface-mobile alone. By using the same -credentials wirh Subsurface-mobile and Subsurface for desktop, the Subsurface cloud storage allows you to share your dive -log between both (or even more than two) devices.

The dive data are cached both on the mobile device as well as on the desktop - it is easy to create backups of the data (for example in XML format) on the desktop, and both mobile device and desktop keep a local copy of the data so that the dive log is always accessible, even without Internet connection. The Subsurface team never accesses a user’s 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.

1) Enter an e-mail address and a password in the fields indicated on the screen. -The e-mail address should be in lower case and the password should contain a combination of -letters from the alphabet (upper and lower case) and/or numbers. -Tap the "Sign-in or Register" button. If you have already set -up an account from the Subsurface desktop application, enter the same credentials here. -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.

3) If this is a new 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. The user -information is stored 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.

The dive log can be updated automatically. If there is Internet connectivity, Subsurface-mobile accesses -the cloud-based dive log to verify that the local copy of the dive log is still the -same as the log in the cloud server. If not, the local copy and the copy on -the server are synchronized.

3.3. Changing the existing login credentials on the Subsurface cloud

The login credentials can be changed, for an example in order to work with -multiple accounts. See the section on Changing to a different Subsurface cloud account.

4. Menu Structure and User Interface

At the bottom of many Subsurface-mobile screens is a round button that provides for -several actions (see image below). The most common choice is indicated in a round colored action button (in the case below, edit a dive). Alternative actions are indicated in a white action bar. -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.

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

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. There are three ways to open the main menu:

-
-Tap the "hamburger" symbol in the lower left corner of the screen - (easy to reach for hand held devices) -
-
-
-Swipe towards the right across the left edge of the screen -
-
-
-Drag the action button visible on most screens to - the right -
-

The image above 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 submenus accessible.

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

5. 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, after which the dive list is shown. Once the list is loaded you can scroll up and down -through your dive history. -To upload dives from a dive computer, tap the blue action button. If you wish -to add a dive manually, tap the + button in the action bar (described below). -Tapping an existing 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.

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

6. Editing dive details

At the bottom of the dive details screen the action button is a pencil (image on right, above). -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 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, 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.

When the virtual keyboard is shown, to avoid screen clutter, the action button is hidden. -Once you close the keyboard it is drawn again.

7. Manually adding a new dive to the dive list

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

8. Deleting a dive

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

You can also delete a dive from the dive list by long-pressing a 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.

9. Download dives from a dive computer

The download deature supports only a limited number of dive computers. On -Android devices these are typically dive computers using an FTDI interface -using a USB OTG cable (but this is blocked on some Android devices by OS -settings). Android devices also support all Bluetooth dive computers that -are supported in Subsurface. And both Android and iOS devices allow direct -download of dive data from a hand full of Bluetooth LE enabled dive -computers.

Use the Vendor name and Dive Computer drop-downs to pick the correct -dive computer. When downloading from multiple different dive computers, shortcut -buttons to easily switch between them will appear below the drop-downs.

The process for download is slightly different between the two OSs. -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 BLE requests.

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 USB dive computers, USB cables "normally" used -for uploading dives to a desktop/laptop computer do NOT work: these cables usually have a full-sized ("Type A") male USB plug -on one end which plugs into the USB port of a desktop/laptop computer. For downloads to a mobile device -one needs a USB OTG (USB On-The-Go) cable. In most cases it is required to plug the USB -cable "normally" used with the dive computer into a USB OTG cable which, in turn, plugs into the mini-USB (or sometimes a USB "Type C") -receptacle of the mobile device. The -OTG cable usually has a full-size ("Type A") female receptacle at one end which accommodates the full-sized male plug -of the USB cable "normally" used (see image below). This means that two cables are used to connect the dive computer to the mobile device.

Please note that not all Android devices support OTG cables. And even on some devices that do support those cables in general, Subsurface-mobile still in some cases cannot access a dive computer through a serial port.

For Bluetooth-equipped dive computers and Android devices, establish a Bluetooth connection between the dive computer and the -mobile device. Use the tools on the mobile device to achieve pairing between the Bluetooth dice computer -and the mobile device. For of Android devices, -the Settings → Bluetooth tool is probably appropriate. Ensure pairing of the dive computer and mobile device. -Subsurface-mobile performs communication using both Bluetooth and Bluetooth-low-energy (BTLE). -The appropriate choice of Bluetooth communication is made by the software and the user need not be concerned with this.

With pairing between dive computer and Subsurface-mobile having been set up, dive download is simple. -From the main menu, tap Manage dives → Download from DC. A screen is shown requiring that the user specify -the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel 2 dive -computer, the vendor is Shearwater and the Dive computer name is Petrel 2. From the two dropdown lists -at the top of the screen, select the correct vendor and dive computer names (see image on the left, below).

Now tap the button labeled Download. The downloaded dives appear in the bottom part of the screen, the -most recent dive at the top (see image on right, below). Be patient because the download can take a few minutes. -As a matter of fact, a complete first download from some dive computers has been shown to take 45 minutes and longer.

After the download, each dive has a check-box on the left hand side, used for selecting which dives you want to be added to the -Subsurface-mobile dive list: dives that are not checked are ignored. With the appropriate downloaded dives -having been checked, tap the button at the bottom left labeled Accept. All the selected dives appear on -the Subsurface-mobile dive list. The downloaded dive information can now be edited as described in the section -above Edit a dive.

10. Viewing the dive location on Google Maps

In the Details View, the Action Bar at the bottom has a GPS pin on the -left hand side. Tap that pin and the dive site is shown in Google Maps. Close Google Maps by using the Android Back button -or tapping on the Subsurface-mobile link in the top left corner on iOS.

Alternatively, the Details View has a button at the top right hand marked -Map it. Tap this button to open Google Maps showing the dive site (image below).

11. 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 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 main menu (by dragging the Action Button to the right, or -by tapping the "Hamburger" icon at the bottom left of the screen). -Tap the option Dive management, enabling a number of options:

11.1. Add new dive manually

This is described above under the section dealing with Manually adding a new dive to the dive list.

11.2. Download from DC

This is described above under the section dealing with Download dives from a dive computer.

11.3. Apply GPS fixes

This is described in the following main section, below.

11.4. Manually sync the dive log with the Subsurface cloud storage

Upload the dives contained on the mobile device -to the Subsurface cloud storage by tapping the option Manual sync with cloud. -This synchronizes the local changes to -the dive log with the cloud storage. It also downloads changes made to -the dive log using another device or computer and stored in shared cloud storage.

11.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 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. Selecting Enable cloud auto sync causes -the local dive log to be synchronized with the copy in the cloud every time that -Subsurface-mobile is closed. This option is a switch that allows auto -sync to be either activated or to be switched off.

12. Recording dive locations using GPS

The fact that most smartphones have GPS facilities allows -Subsurface-mobile to record -the locations of dives. If the smartphone is taken on the dive 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:

12.1. Configuring the GPS service

From the Main menu, select Settings. The Settings screen 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.

12.2. Collecting GPS positions

Ensure that the GPS on the mobile device has been activated and that you -have given the app permission to access your location data. -Open the Main Menu and select GPS → Run location service. This activates the -recording of GPS locations.

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 Disable location service. The GPS symbol at the bottom -of all manus disappears.

12.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. Tap Upload GPS data that saves the GPS data -on the Subsurface cloud server. These GPS data are saved separately -from the other dive log data. All collected GPS data are kept on the -Android device, independent of whether they have been uploaded or not.

12.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 sub-panel.

12.5. Viewing GPS data

From the GPS submenu 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 handle (the dotted matrix on the right below) to the left. This exposes two -options. Tapping the dustbin deletes this particular GPS location. Tapping the -teardrop-shaped icon (actually a Google Maps pin) opens up Google Maps with a pin -indicating the exact map position of the GPS record being viewed. The two above -options can be hidden by drawing the GPS record to the right, again using the handle.

12.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, apply the GPS positions to -these dives. GPS positions can therefore only be applied to dives in the dive list. -From the Dive management sub-panel, 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.

13. Using the settings for Subsurface-mobile.

The Settings screen allows the customization of Subsurface-mobile. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting.

13.1. Changing to a different Subsurface cloud account

Some users have more than one Subsurface cloud account and with a need to switch between accounts. Tap Settings on the Main menu and scroll to the section titled Cloud status (see image below). -Tap the Change button. This opens the Cloud credentials screen. -change the credential information, then tap the button Sign-in or register. The appropriate dive list is shown.

13.2. Changing the color theme of Subsurface-mobile

Subsurface-mobile has three color schemes to please users with different -tastes. This user manual shows the default color scheme, comprising blue -colors. Change to a pink or a dark color scheme by opening the main menu, -tap Settings, and scroll to the section with heading Theme (see image above). -Select the appropriate color theme by dragging the appropriate slider on the righthand.

13.3. Configuring the GPS webservice

The Settings screen allows one to set up the way in which GPS positions are collected during dives. See the section on Configuring the GPS service.

13.4. Saving a detailed dive computer dive log

Under the heading Dive computer, you will find a switch to save a detailed log each time dives are downloaded from a dive computer. This is important for solving problems in downloading dives from the dive computer. When contacting the developers with download problems, you will usually be asked to provide the information in this log, which can be found in the root folder of your local storage device as libdivecomputer.log. In the same location you can also find a subsurfacel.log which is always created and which include more information which can be helpful when debugging problems with Subsurface-mobile.

13.5. Activating the Developer submenu

The information in subsurface.log plus some additional information for understanding the screen rendering of dive information as well as the way in which Subsurface-mobile processed information during a specific occasion while running the app (see section below) is available through a Developer menu at run time. Activate (or deactivate) this menu item on the Main Menu by dragging the slider switch in the Settings screen.

14. Developer submenu

If the Developer submenu has been activated in the Settings screen, the Main menu has a Developer item. By tapping this one has two options that are relevant within -the context of program development and debugging.

14.1. App log

This option shows the messages that Subsurface-mobile generates while running. While -most users are not aware of these messages, they are often crucial in detecting any -abnormal behavior of the app. The App log can be found in the root directory of the local storage of the mobile device.

14.2. Theme information

This option provides a wealth of information about the screen characteristics of the mobile -device and the font characteristics used by Subsurface-mobile.

- - - diff --git a/Documentation/mobile-manual.txt b/Documentation/mobile-manual.txt deleted file mode 100644 index 58558b6b5..000000000 --- a/Documentation/mobile-manual.txt +++ /dev/null @@ -1,603 +0,0 @@ - -// 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 - - -[blue]#_Version 3.0.5, May 2020_# - -Welcome as a user of _Subsurface_ and _Subsurface-mobile_, advanced dive logging -software with extensive infrastructure to describe, organize, and interpret scuba -and free dives. _Subsurface_ offers many advantages over other similar -software solutions, including compatibility with Windows, macOS, Linux (many -distributions), Android and iOS. In addition, _Subsurface_ is -open-source software that allows downloading dive -information from many dive computers. - -toc::[] - - -Introducing Subsurface-mobile ------------------------------ - -_Subsurface-mobile_ is a limited mobile version of _Subsurface_ -aimed at Android and iOS smartphone and tablet devices, allowing viewing, entering, sharing, and storage of dive information at dive sites where a desktop -computer is not useful. While the desktop version of _Subsurface_ shows much more detailed information -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_ also allows -the gathering of GPS locations where dives are performed. - -Users of _Subsurface-mobile_ typically use the -mobile app as a companion to the laptop/desktop version of _Subsurface_, sharing dive information -between the mobile and the desktop versions. 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 many of the dive log data fields, e.g. dive-master, buddy, - equipment or notes relating to a dive. -- Recording, storing and applying GPS positions of dives. -- Viewing the localities of recorded GPS positions and of dives - on a map. - -These items are discussed in greater detail in the following text. -_Subsurface-mobile_ does not support download of dive data from all the -dive computers that the desktop/laptop version can. This limitation is -mainly caused by the inability of accessing some types of devices on 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. - -== 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. - -== 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. After loading, the _Cloud Credentials screen_ appears -(see image below on left). - -image::mobile-images/Credentials.jpg["FIGURE: Mobile credentials screen",align="center"] - -=== When NOT Using Cloud Storage -Tap the "No cloud mode" button. The app will not access the _Subsurface_ -cloud storage server -to obtain dive log information. This means that dive log information is -stored on the mobile device only. If no dives have been entered into the dive log -yet (the usual case), an empty dive log is created. - -=== Using Cloud Storage -The _Subsurface_ developers provide a dedicated and -free Internet cloud storage account that can be used for -storing dive log information. This account can be created either from _Subsurface_ on the desktop or from _Subsurface-mobile_ -using a mobile device; you can -do full maintenance of a dive log from _Subsurface-mobile_ alone. By using the same -credentials with _Subsurface-mobile_ and _Subsurface_ for desktop, the _Subsurface_ cloud storage allows sharing of a dive -log between both (or even more than two) devices. - -The dive data in the cloud are cached locally both on the mobile device as well as on the desktop - -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. The Subsurface team never accesses a user's 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. - -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 -letters from the alphabet (upper and lower case) and/or numbers. -Tap the "Sign-in or Register" button. If you have already set -up an account from the _Subsurface_ desktop application, enter the same credentials here. -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. Once registered, -_Subsurface-mobile_ remembers the cloud credentials and it is not necessary to provide these again -when launching the program. - -2) 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. The user -information is stored 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. After the PIN has been entered it -is no longer needed - it just proves that this is indeed your email account. - -A https://www.youtube.com/watch?v=Vp_bEm5ZDRA[*video-tutorial*] is available that demonstrates -how to connect to the cloud. - -**** -[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 there is not a spelling mistake in the email address you provided. -2. Check that the return email containing the PIN is not in the SPAM folder of your email client. -3. Wait for 24 hours and check again for an email with a PIN. -4. If there is still no email containing a PIN, send mail to mailto:in-app-support@subsurface-divelog.org[our in-app-support address] - -[blue]#I want to access the Subsurface cloud facility but I have forgotten my password. How can I reset my password?# - -Use our https://cloud.subsurface-divelog.org/passwordreset[Internet-based password reset facility]. - -This will require that you enter the same email address that you used during cloud registration. -**** - -The dive log can be updated automatically. If there is Internet connectivity, _Subsurface-mobile_ accesses -the cloud-based dive log to verify that the local copy of the dive log is still the -same as the log in the cloud server. If not, the local copy and the copy on -the server are synchronized. - -=== Changing the existing login credentials on the _Subsurface_ cloud - -The login credentials can be changed, for example to work with -multiple accounts. See the section on xref:S_ChangeCloudAccount[Changing to a different _Subsurface_ cloud account]. - -== 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 main menu. This will open an -email to our in app support address in the native email client, including the relevant logs. - -== Menu Structure and User Interface - -At the bottom of many _Subsurface-mobile_ screens is a round button that provides for -several actions (see image below). The most common choice is indicated in a round colored _action button_ (in the case below, edit a dive). Alternative actions are indicated in a white _action bar_. -On some screen a context menu is available by tapping on the three dots in the lower right corner -of the screen. In the dive list this can also be opened by tapping and holding a dive ot trip -header. - -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. - -image::mobile-images/Actionbutton.jpg["FIGURE: Action Button",align="center"] - -On iOS devices, on screens where a "back" action is enabled, a back arrow -is shown in the top left corner of the screen. - -For 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. There are two ways to open the main menu: - -- Tap the "hamburger" symbol in the lower left corner of the screen - (easy to reach for hand held devices) -- Swipe towards the right across the left edge of the screen - -image::mobile-images/Menusystem.jpg["FIGURE: Dive management sub-panel",align="center"] - -The image above 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. - -All screenshots in this user manual are currently from the Android -version. The iOS screens look similar. - -== The Dive List - -The _Dive List_ is the heart of _Subsurface-mobile_ because most of the actions -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, after which the dive list is shown. Once the list is loaded you can scroll up and down -through your dive history. - -The Dive List consists of two types of entries: - -1. *Trip headers*. A trip header is a line describing the year and month during which a dive trip -took place, as wel as the geographical area of the trip. The second line in the lefthand image below indicates that a 10-dive trip -was made to Guinjata, Moçambique during December 2016. - -2. *Individual dive records*. Tapping a trip header expands the dive list to show (or hide) the individual dives performed during the trip. Each dive is represented by a dive record. By default the dives during the last trip are listed with older dives at the bottom and recent dives at the top of the list. In the lefthand image below the last dive during -the Guinjata trip was in the Inhambane Estuary. - -image::mobile-images/Divelist2.jpg["FIGURE: Dive list screen",align="center"] - -[[S_View_Dive]] -== View a dive: the _Details View_ - -Tapping on a dive in the _Dive List_ brings up a screen with the dive profile -and many important details about the dive is opened (image on right, above). The dive details usually -do not fit in a single screen and one needs to scroll the screen to see all the information. -View other dives by swiping the _Details view_ to the right (for the -previous dive) or to the left (following dive). Alternatively use a pinch gesture -to zoom into the profile and tapping with one finger, waiting briefly until -the profile becomes translucent, and then dragging the finger around -to pan the profile so the interesting parts are shown. -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 (to the left of the pencil action button in image on the right, above). - -To upload dives from a dive computer, tap the blue action button. If you wish -to add a dive manually, tap the + button in the action bar (described below). -Using the Action Bar, it is also possible to delete the dive (tap the dustbin -on the Action Bar). -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 and to undo and redo previous actions. - -== Filter the dive list - -Use this action button: - -image::mobile-images/FilterButton.jpg["FIGURE: Filter button",align="center"] - -at the bottom of the dive list to perform filtering of the dive list (see image on left above). - -image::mobile-images/Filter.jpg["FIGURE: Filter tool",align="center"] - -By default, all the dives in the dive log are shown in the dive list. After several years your dive -log can become quite long and, sometimes, you might like to list only the dives of a particular -type, e.g. those at a particular dive site or those with a specific buddy or dive master. Use the -Filter to achieve this. The filter mechanism searches through all the information for each dive, -looking for one or more key words. Only the dives containing these key words are listed in the dive -list. Three filter modes exist. "Fulltext" searches all text strings. Selecting "People" lists buddies and -dive masters, while "Tags" only filters for tags containing the given text. Filters are not case-sensitive. -To clear the filter, remove the key words from the text box and select the Filter action button to -switch off filtering. The image above represents a full-text search for dives with the word "nitrox". - -== 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 _Main 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. - -== Viewing the location of a dive on _Google Maps_ - -image::mobile-images/Map.jpg["FIGURE: Map of dive site",align="center"] -In the _Details View_, the Action Bar at the bottom of the screen has a GPS pin on the -left hand side. Tap that pin and the dive site is shown in Google Maps. Close Google Maps by using the Android _Back_ button -or tapping on the _Subsurface-mobile_ link in the top left corner on iOS. - -[[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" 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_. After editing the dive information, the dive trip information -needs to be edited as described in the section above on xref:S_Divetrip[Dive trip editing]. - -This https://www.youtube.com/watch?v=sF8KB_r0rFw[*video-tutorial*] explains how to add information to a -manually-entered dive. - -image::mobile-images/Manualdive.jpg["FIGURE: Manual dive entry screen",align="center"] - -[[S_Download]] -== Download dives from a dive computer - -From the main menu, -tap _Manage dives -> Download from DC_. A screen is shown requiring that the user specify -the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel dive -computer, the vendor is _Shearwater_ and the Dive computer name is _Petrel_(see image on the left, below). -*Caveats:* 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. 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 are not used any more. Achieve this by selecting the option -_Forget remembered dive computers_ in the xref:S_Settings[_Settings_] menu. -After all these caveats, let us proceed with download. - -*For 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"] | -In most cases it is required to plug the USB -cable "normally" used with the dive computer into a USB OTG cable which, -in turn, plugs into the mini-USB (or sometimes a USB "Type C") -receptacle of the mobile device. The -OTG cable usually has a full-size ("Type A") female receptacle at one end which -accommodates the full-sized male plug -of the USB cable "normally" used (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-C adapter. -|======= - -_Subsurface_ 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 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). - -*For BLUETOOTH/BTLE 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 BTLE 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. Use the tools on the mobile device to achieve pairing between the Bluetooth dice computer -and the mobile device. For many Android devices, -the Settings -> Bluetooth tool of Android is probably appropriate. -_Subsurface-mobile_ performs communication using both Bluetooth and Bluetooth-low-energy (BTLE). -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 Bluetooth-low-energy (BTLE), 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 BTLE. The _Connection_ -information indicates that the Petrel with no BTLE is selected. - -This https://www.youtube.com/watch?v=4MtQqm4o7bw[*video-tutorial*] demonstrates setting up a Bluetooth connection with an Android device. - -*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 few minutes. -As a matter of fact, a complete first download from some dive computers can take 45 minutes or longer. -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 be added to the -_Subsurface-mobile_ dive list: dives that are not checked are ignored. With the appropriate downloaded dives -having been checked, tap the button at the bottom left labeled _Accept_. All the selected dives appear on -the _Subsurface-mobile_ dive list. The downloaded dive information can now be edited as described in the section -above xref:S_Edit_Dive[Edit the dive information]. After editing the dive information, the dive trip information -needs to be edited as described in the section above on xref:S_Divetrip[Edit the dive trip information]. - -This https://www.youtube.com/watch?v=DCi70WZMTws[*video-tutorial*] demonstrates downloading dives from a Bluetooth-equipped dive computer. - -[[S_Edit_Dive]] -== Edit the dive information - -image::mobile-images/Editdive.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 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. - -This https://www.youtube.com/watch?v=pE3ujzGw_7o[*video-tutorial*] explains how to add information about a dive. - -[[S_Divetrip]] -== Edit the dive trip information - -When a new dive(s) is entered manually or downloaded from dive computer, a trip header is created at the -top of the dive list only showing the month and the year of the dive trip as well as the number of dives -during the trip (image on left below, showing a trip header with "May 2018", the trip comprising two dives). -You would probably like to include information about the place -where the trip took place, e.g. "Channel Islands" or the dive charter company used. In this case long-press -the dive trip header to activate the context menu. Select the option "Edit trip details" to open a panel -for typing information about the trip (image on right, below). Having provided the required information, -tap the _Save_ action button at the bottom of the screen. This returns you to the dive list, showing some of -the dive trip information that has just been provided. - -image::mobile-images/TripDetails.jpg["FIGURE: Edit trip details",align="center"] - -// == 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 - -Delete a dive from the dive list by long-pressing a dive and selecting delete in the context menu. -If the wrong dive was deleted by mistake you can easily undo the operation by using the context menu. - -image::mobile-images/Delete_undo.jpg["FIGURE: Undo delete dive",align="center"] - -== 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 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 main menu -(by tapping the "Hamburger" icon at the bottom left of the screen). -Tap the option _Dive management_, enabling a number of options: - -=== Add new dive manually - -This is described above under the section dealing with xref:S_Add_Dive[Manually adding a new dive to the dive list]. - -=== Download from DC - -This is described above under the section dealing with xref:S_Download[Download dives from a dive computer]. - -=== Apply GPS fixes - -This is described in the following main section, below. - -=== Manually sync the dive log with the _Subsurface_ cloud storage - -Upload the dives contained on the mobile device -to the _Subsurface_ cloud storage by tapping the option _Manual sync with cloud_. -This synchronizes the local changes to -the dive log with the cloud storage. It also downloads changes made to -the dive log using another device or computer and stored in shared cloud storage. - -=== 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 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 every time that -_Subsurface-mobile_ is closed. - -== Recording dive locations using GPS - -The fact that most 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: - -[[S_ConfigureGPS]] -=== Configuring the GPS service - -From the _Main Menu_, select xref:S_Settings[_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. - -image::mobile-images/GPS-config.jpg["FIGURE: GPS configure",align="center"] - -=== Collecting GPS positions - -[width="100%", frame="None"] -|======= -a|image::mobile-images/GPSstart.jpg["FIGURE: GPS start",align="center"] | -On the _Main Menu_ select _GPS -> 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. -|======= - -=== Viewing GPS data - -From the _GPS_ submenu 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 -teardrop-shaped icon (actually a Google Maps 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. - -image::mobile-images/gpsmanagement.jpg["FIGURE: GPS management",align="center"] - -=== 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, apply the GPS positions to -these dives. GPS positions can only be applied to dives in the dive list. -From the _Dive management_ sub-panel, 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. - -[[S_Settings]] -== Specifying the settings for _Subsurface-mobile_. - -The _Settings_ screen allows the customization of _Subsurface-mobile_. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting. - -[[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 _Settings_ on the Main menu and scroll to the section titled _Cloud status_ (see image below). -Tap the _Change_ button. This opens the _Cloud credentials_ screen. -change the credential information, then tap the button _Sign-in or register_. The appropriate dive list is shown. - -image::mobile-images/SettingsCloudTheme.jpg["FIGURE: Settings: Cloud & Theme",align="center"] - -=== Changing the color theme of _Subsurface-mobile_ - -[width="100%", frame="None"] -|======= -a|image::mobile-images/PinkTheme.jpg["FIGURE: GPS start",align="center"] | -_Subsurface-mobile_ has three color schemes to please users with different -tastes (see image above). This user manual shows the default color scheme, comprising blue -colors. Change to a pink or a dark color scheme by opening the main menu, -tap _Settings_, and scroll to the section with heading _Theme_ (see image above). -Select the appropriate color theme by dragging the appropriate slider on the right-hand. -On the left is the dive list after selecting the Pink theme. -|======= - -=== Activating the Developer sub-menu - -The information in the subsurface.log generated while running _Subsurface-mobile_, plus some additional information for understanding the screen rendering of dive information as well as the way in which _Subsurface-mobile_ processed information during a specific occasion while running the app (see section below) is available through a _Developer_ menu at run time. Activate (or deactivate) this menu item on the Main Menu by dragging the slider switch in the Settings screen. -If _Display developer menu_ has been activated in the _Settings screen_, the Main menu has a _Developer_ item. By tapping this one has two options that are relevant within -the context of program development and debugging. - -=== App log - -This option shows the messages that _Subsurface-mobile_ generates while running. While -most users are not aware of these messages, they are often crucial in detecting any -abnormal behavior of the app. The App log can be found in the root directory of the local storage of the mobile device. - -=== Theme information - -This option provides a wealth of information about the screen characteristics of the mobile -device and the font characteristics used by _Subsurface-mobile_. - - -- cgit v1.2.3-70-g09d2