mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

documentation/mobile-manual: create a merged v3 manual

Browse source 
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 <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
This commit is contained in:
Willem Ferguson 2020-05-05 17:46:48 -07:00 • committed by Dirk Hohndel
parent 33b4ecf055
commit 70ebc2bee7
6 changed files with 2840 additions and 2177 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Documentation/Makefile
View file

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

1302
Documentation/mobile-manual-v2.html.git Normal file
View file

File diff suppressed because it is too large Load diff

277
Documentation/mobile-manual.txt → Documentation/mobile-manual-v2.txt
View file

@ -2,8 +2,8 @@
// Subsurface-mobile User Manual
// =============================
// :author: Manual authors: Willem Ferguson, Dirk Hohndel
// :revnumber: 3.0.0
// :revdate: March 2020
// :revnumber: 2.1.5
// :revdate: December 2018
:icons:
:toc:
:toc-placement: manual
@ -16,8 +16,9 @@ image::mobile-images/Banner.jpg["Banner",align="center"]
*Manual authors*: Willem Ferguson, Dirk Hohndel
// toc::[]
[blue]#_Version 3.0.5, May 2020_#
[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
@ -27,9 +28,6 @@ distributions), Android and iOS. In addition, _Subsurface_ is
open-source software that allows downloading dive
information from many dive computers.
toc::[]
Introducing Subsurface-mobile
-----------------------------
@ -52,7 +50,7 @@ _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.
- 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.
@ -64,15 +62,14 @@ _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
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. For Android devices without access to the _Google Play Store_
APKs can be found in the downloads folder on the Subsurface website.
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
@ -99,13 +96,7 @@ do full maintenance of a dive log from _Subsurface-mobile_ alone. By using the s
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.
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
@ -114,21 +105,14 @@ 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.
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.
log or download dive information from a supported dive computer.
****
[icon="images/icons/important.png"]
@ -140,11 +124,11 @@ how to connect to the cloud.
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]
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?#
Use our https://cloud.subsurface-divelog.org/passwordreset[Internet-based password reset facility].
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.
****
@ -161,18 +145,12 @@ multiple accounts. See the section on xref:S_ChangeCloudAccount[Changing to a di
== 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.
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
@ -188,7 +166,7 @@ _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:
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)
@ -205,44 +183,23 @@ 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,
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.
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.
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"]
[[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).
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).
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.
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
@ -254,15 +211,7 @@ at the bottom of the dive list to perform filtering of the dive list (see image
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".
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
@ -276,10 +225,36 @@ 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
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
@ -292,14 +267,48 @@ 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.
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
@ -308,9 +317,9 @@ tap _Manage dives -> Download from DC_. A screen is shown requiring that the us
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
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
@ -321,8 +330,14 @@ 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.
*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"]
|=======
@ -335,7 +350,8 @@ 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.
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
@ -343,13 +359,7 @@ 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).
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
@ -371,8 +381,6 @@ screen for each mode of communication, allowing a choice. Use the _Connection_ v
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.
@ -383,72 +391,9 @@ Each dive has a check-box on the left hand side, used for selecting which dives
_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].
above xref:S_Edit_Dive[Edit a dive].
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"]
image::mobile-images/DC-Download.jpg["FIGURE: DC download screen",align="center"]
== Dive log management
@ -583,6 +528,10 @@ Select the appropriate color theme by dragging the appropriate slider on the rig
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.

2038
Documentation/mobile-manual-v3.html.git
View file

File diff suppressed because it is too large Load diff

436
Documentation/mobile-manual-v3.txt
View file

@ -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.
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 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_].
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.
The Dive List consists of two types of entries:
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.
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.
image::mobile-images/DiveListAndDetails.jpg["FIGURE: Dive list screen",align="center"]
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.
A tap and hold on a dive or a trip header opens the context menu for that entry.
image::mobile-images/Divelist2.jpg["FIGURE: Dive list screen",align="center"]
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.
=== 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
=== Filter the dive list
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.
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::[]
// == 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.
image::mobile-images/FilterButton.jpg["FIGURE: Filter button",align="center"]
=== Deleting a dive
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.
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_
image::mobile-images/Filter.jpg["FIGURE: Filter tool",align="center"]
If you deleted the wrong dive by mistake you can easily undo the operation in the context menu.
image::mobile-images/UndoDelete.jpg["FIGURE: Undo delete dive",align="center"]
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.
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.
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
*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

962
Documentation/mobile-manual.html.git
View file

@ -1,962 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.10" />
<title></title>
<style type="text/css">
/*
* compact_subsurface.css, a special style sheet for Subsurface,
* modified by Willem Ferguson and derived from:
* compact.css, version 1.3 by Alex Efros <powerman@powerman.name>
* Licence: Public Domain
*
* Usage: asciidoc -a theme=compact_subsurface ...
*/
* { padding: 0; margin: 0; }
img { border: 0; }
/*** Layout ***/
body { margin: 10px 20px; }
#header br { display: none; }
#revnumber { display: block; }
#toc { margin: 1em 0; }
.toclevel2 { margin-left: 1em; }
.toclevel3 { margin-left: 2em; }
#footer { margin-top: 2em; }
#preamble .sectionbody,
h2,
h3,
h4,
h5 { margin: 1em 0 0 0; }
.admonitionblock,
.listingblock,
.sidebarblock,
.exampleblock,
.tableblock,
.literalblock { margin: 1em 0; }
.admonitionblock td.icon { padding-right: 0.5em; }
.admonitionblock td.content { padding-left: 0.5em; }
.listingblock .content { padding: 0.5em; }
.sidebarblock > .content { padding: 0.5em; }
.exampleblock > .content { padding: 0 0.5em; }
.tableblock caption { padding: 0 0 0.5em 0; }
.tableblock thead th,
.tableblock tbody td,
.tableblock tfoot td { padding: 0 0.5em; }
.quoteblock { padding: 0 2.0em; }
.paragraph { margin: 1em 0 0 0; }
.sidebarblock .paragraph:first-child,
.exampleblock .paragraph:first-child,
.admonitionblock .paragraph:first-child { margin: 0; }
.ulist, .olist, .dlist, .hdlist, .qlist { margin: 1em 0; }
li .ulist, li .olist, li .dlist, li .hdlist, li .qlist,
dd .ulist, dd .olist, dd .dlist, dd .hdlist, dd .qlist { margin: 0; }
ul { margin-left: 1.5em; }
ol { margin-left: 2em; }
dd { margin-left: 3em; }
td.hdlist1 { padding-right: 1em; }
/*** Fonts ***/
body { font-family: Verdana, sans-serif; }
#header { font-family: Arial, sans-serif; }
#header h1 { font-family: Arial, sans-serif; }
#footer { font-family: Georgia, serif; }
#email { font-size: 0.85em; }
#revnumber { font-size: 0.75em; }
#toc { font-size: 0.9em; }
#toctitle { font-weight: bold; }
#footer { font-size: 0.8em; }
h2, h3, h4, h5, .title { font-family: Arial, sans-serif; }
h2 { font-size: 1.5em; }
.sectionbody { font-size: 0.85em; }
.sectionbody .sectionbody { font-size: inherit; }
h3 { font-size: 159%; } /* 1.35em */
h4 { font-size: 141%; } /* 1.2em */
h5 { font-size: 118%; } /* 1em */
.title { font-size: 106%; /* 0.9em */
font-weight: bold;
}
tt, .monospaced { font-family: monospace; font-size: 106%; } /* 0.9em */
dt, td.hdlist1, .qlist em { font-family: Times New Roman, serif;
font-size: 118%; /* 1em */
font-style: italic;
}
.tableblock tfoot td { font-weight: bold; }
/*** Colors and Backgrounds ***/
h1 { color: #527bbd; border-bottom: 2px solid silver; }
#footer { border-top: 2px solid silver; }
h2 { color: #527bbd; border-bottom: 2px solid silver; }
h3 { color: #5D7EAE; border-bottom: 2px solid silver; }
h3 { display: inline-block; }
h4,h5 { color: #5D7EAE; }
.admonitionblock td.content { border-left: 2px solid silver; }
.listingblock .content { background: #f4f4f4; border: 1px solid silver; border-left: 5px solid #e0e0e0; }
.sidebarblock > .content { background: #ffffee; border: 1px solid silver; border-left: 5px solid #e0e0e0; }
.exampleblock > .content { border-left: 2px solid silver; }
.quoteblock { border-left: 5px solid #e0e0e0; }
.tableblock table {
border-collapse: collapse;
border-width: 3px;
border-color: #527bbd;
}
.tableblock table[frame=hsides] { border-style: solid none; }
.tableblock table[frame=border] { border-style: solid; }
.tableblock table[frame=void] { border-style: none; }
.tableblock table[frame=vsides] { border-style: none solid; }
.tableblock table[rules=all] tbody tr *,
.tableblock table[rules=rows] tbody tr * {
border-top: 1px solid #527bbd;
}
.tableblock table[rules=all] tr *,
.tableblock table[rules=cols] tr * {
border-left: 1px solid #527bbd;
}
.tableblock table tbody tr:first-child * {
border-top: 1px solid white; /* none don't work here... %-[] */
}
.tableblock table tr *:first-child {
border-left: none;
}
.tableblock table[frame] thead tr *,
.tableblock table[frame] thead tr * {
border-top: 1px solid white;
border-bottom: 2px solid #527bbd;
}
.tableblock table tr td p.table,
.tableblock table tr td p.table * {
border: 0px;
}
tt, .monospaced { color: navy; }
li { color: #a0a0a0; }
li > * { color: black; }
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
/*** Misc ***/
.admonitionblock td.icon { vertical-align: top; }
.attribution { text-align: right; }
ul { list-style-type: disc; }
ol.arabic { list-style-type: decimal; }
ol.loweralpha { list-style-type: lower-alpha; }
ol.upperalpha { list-style-type: upper-alpha; }
ol.lowerroman { list-style-type: lower-roman; }
ol.upperroman { list-style-type: upper-roman; }
.hdlist td { vertical-align: top; }
</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = { // Namespace.
/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////
/* Author: Mihai Bazon, September 2002
* http://students.infoiasi.ro/~mishoo
*
* Table Of Content generator
* Version: 0.4
*
* Feel free to use this script under the terms of the GNU General Public
* License, as long as you do not remove or alter this notice.
*/
/* modified by Troy D. Hanson, September 2006. License: GPL */
/* modified by Stuart Rackham, 2006, 2009. License: GPL */
// toclevels = 1..4.
toc: function (toclevels) {
function getText(el) {
var text = "";
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
text += i.data;
else if (i.firstChild != null)
text += getText(i);
}
return text;
}
function TocEntry(el, text, toclevel) {
this.element = el;
this.text = text;
this.toclevel = toclevel;
}
function tocEntries(el, toclevels) {
var result = new Array;
var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install(3);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
</div>
<div id="content">
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Banner.jpg" alt="Banner" />
</div>
</div>
<div class="paragraph"><p><span class="big">Subsurface-mobile USER MANUAL</span></p></div>
<div class="paragraph"><p><strong>Manual authors</strong>: Willem Ferguson, Dirk Hohndel</p></div>
<div class="paragraph"><p><span class="blue"><em>Version 2, December 2017</em></span></p></div>
<div class="paragraph"><p>Welcome as a user of <em>Subsurface</em> and <em>Subsurface-mobile</em>, advanced dive logging
software with extensive infrastructure to describe, organize, and interpret scuba
and free dives. <em>Subsurface</em> offers many advantages over other similar
software solutions, including compatibility with Windows, macOS, Linux (many
distributions), Android and iOS. In addition, <em>Subsurface</em> is
open-source software that allows downloading dive
information from many dive computers.</p></div>
<div class="sect1">
<h2 id="_introducing_subsurface_mobile">1. Introducing Subsurface-mobile</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>Subsurface-mobile</em> is a more limited mobile version of <em>Subsurface</em>
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 <em>Subsurface</em> 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. <em>Subsurface-mobile</em> also allows
the gathering of GPS locations where dives are performed.</p></div>
<div class="paragraph"><p>Users of <em>Subsurface-mobile</em> typically use the
mobile app as a companion to the laptop/desktop version of <em>Subsurface</em>, sharing dive information
between the mobile and the desktop versions. However <em>Subsurface-mobile</em> can
also be used independently of the desktop version and does not require the use of
cloud storage.</p></div>
<div class="paragraph"><p><em>Subsurface-mobile</em> allows:</p></div>
<div class="ulist"><ul>
<li>
<p>
Download and storage of dive log information using the <em>Subsurface</em> cloud.
</p>
</li>
<li>
<p>
Viewing this information on a mobile device.
</p>
</li>
<li>
<p>
Manually creating and adding new dive records to your dive log.
</p>
</li>
<li>
<p>
Download dive data directly from many dive computers.
</p>
</li>
<li>
<p>
Editing many of the dive log data fields, e.g. divemaster, buddy,
equipment or notes relating to a dive.
</p>
</li>
<li>
<p>
Recording, storing and applying GPS positions of dives.
</p>
</li>
<li>
<p>
Viewing the localities of recorded GPS positions and of dives
on a map.
</p>
</li>
</ul></div>
<div class="paragraph"><p>These items are discussed in greater detail in the following text.
<em>Subsurface-mobile</em> 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 <em>Subsurface-mobile</em>. On iOS, only Bluetooth LE based
dive computers are supported.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_installing_em_subsurface_mobile_em_on_your_mobile_device">2. Installing <em>Subsurface-mobile</em> on your mobile device</h2>
<div class="sectionbody">
<div class="paragraph"><p>Find <em>Subsurface-mobile</em> in the <em>Google Play Store</em> or the <em>iTunes Store</em>
and install it. Please note that both stores also contain the older <em>Subsurface</em> companion app (used only for tracking GPS positions) - make sure you actually install <em>Subsurface-mobile</em>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_using_em_subsurface_mobile_em_for_the_first_time">3. Using <em>Subsurface-mobile</em> for the first time</h2>
<div class="sectionbody">
<div class="paragraph"><p>When you start <em>Subsurface-mobile</em> 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 <em>Cloud Credentials screen</em> appears
(see image below on left).</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Credentials.jpg" alt="FIGURE: Mobile credentials screen" />
</div>
</div>
<div class="sect2">
<h3 id="_when_not_using_cloud_storage">3.1. When NOT Using Cloud Storage</h3>
<div class="paragraph"><p>Tap the "No cloud mode" button. The app will not access the <em>Subsurface</em>
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.</p></div>
</div>
<div class="sect2">
<h3 id="_using_cloud_storage">3.2. Using Cloud Storage</h3>
<div class="paragraph"><p>The <em>Subsurface</em> 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 <em>Subsurface</em> on the desktop or <em>Subsurface-mobile</em>
using a mobile device; you can
do full maintenance of a dive log from <em>Subsurface-mobile</em> alone. By using the same
credentials wirh <em>Subsurface-mobile</em> and <em>Subsurface</em> for desktop, the <em>Subsurface</em> cloud storage allows you to share your dive
log between both (or even more than two) devices.</p></div>
<div class="paragraph"><p>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&#8217;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.</p></div>
<div class="paragraph"><p>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 <em>Subsurface</em> desktop application, enter the same credentials here.
Once the dive
list has been downloaded from the cloud, <em>Subsurface-mobile</em> 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.</p></div>
<div class="paragraph"><p>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 <em>Register</em> 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.</p></div>
<div class="paragraph"><p>The dive log can be updated automatically. If there is Internet connectivity, <em>Subsurface-mobile</em> 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.</p></div>
</div>
<div class="sect2">
<h3 id="_changing_the_existing_login_credentials_on_the_em_subsurface_em_cloud">3.3. Changing the existing login credentials on the <em>Subsurface</em> cloud</h3>
<div class="paragraph"><p>The login credentials can be changed, for an example in order to work with
multiple accounts. See the section on <a href="#S_ChangeCloudAccount">Changing to a different <em>Subsurface</em> cloud account</a>.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_menu_structure_and_user_interface">4. Menu Structure and User Interface</h2>
<div class="sectionbody">
<div class="paragraph"><p>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 <em>action button</em> (in the case below, edit a dive). Alternative actions are indicated in a white <em>action bar</em>.
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.</p></div>
<div class="paragraph"><p>On iOS devices, on screens where a "back" action is enabled, a back arrow
is shown in the top left corner of the screen.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Actionbutton.jpg" alt="FIGURE: Action Button" />
</div>
</div>
<div class="paragraph"><p>In order to have a consistent experience between iOS and Android,
<em>Subsurface-mobile</em> on Android does not use the traditional "hamburger"
menu button in the top left or right corner of the screen to open menus.
Instead, <em>Subsurface-mobile</em> 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:</p></div>
<div class="ulist"><ul>
<li>
<p>
Tap the "hamburger" symbol in the lower left corner of the screen
(easy to reach for hand held devices)
</p>
</li>
<li>
<p>
Swipe towards the right across the left edge of the screen
</p>
</li>
<li>
<p>
Drag the action button visible on most screens to
the right
</p>
</li>
</ul></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Menusystem.jpg" alt="FIGURE: Dive management sub-panel" />
</div>
</div>
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>All screenshots in this user manual are currently from the Android
version. The iOS screens look fairly similar.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_the_dive_list">5. The Dive List</h2>
<div class="sectionbody">
<div class="paragraph"><p>Most of the actions of <em>Subsurface-mobile</em> 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 <em>Details View</em> for that dive
(see image on right below). This includes the dive profile as well as
additional information and notes.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Divelist2.jpg" alt="FIGURE: Dive list screen" />
</div>
</div>
<div class="paragraph"><p>You can view other dives by swiping the <em>Details view</em> 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.).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="S_Edit_Dive">6. Editing dive details</h2>
<div class="sectionbody">
<div class="paragraph"><p>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 <em>Save</em> 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 <em>Back</em> Button or
the application back button at the top left of the screen on iOS.</p></div>
<div class="paragraph"><p>When the virtual keyboard is shown, to avoid screen clutter, the action button is hidden.
Once you close the keyboard it is drawn again.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Editdive.jpg" alt="FIGURE: Dive edit screen" />
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="S_Add_Dive">7. Manually adding a new dive to the dive list</h2>
<div class="sectionbody">
<div class="paragraph"><p>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 <em>Manage dives &#8594; Add dive manually</em>. 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 <em>Action button</em> 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 <em>Details View</em>.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Manualdive.jpg" alt="FIGURE: Manual dive entry screen" />
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_deleting_a_dive">8. Deleting a dive</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <em>Details View</em> of a dive has an Action Bar, including a dustbin. If this is tapped,
the dive shown in the <em>Details View</em> is deleted. You have a brief opportunity to undo
the delete by tapping the grey <em>Undo</em> button in the message that appears at the bottom of
the screen (see image below).</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Delete_undo.jpg" alt="FIGURE: Undo delete dive" />
</div>
</div>
<div class="paragraph"><p>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 <em>Subsurface-mobile</em> 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.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/RedDustbin.jpg" alt="FIGURE: delete dive from list" />
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="S_Download">9. Download dives from a dive computer</h2>
<div class="sectionbody">
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>Use the <em>Vendor name</em> and <em>Dive Computer</em> 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.</p></div>
<div class="paragraph"><p>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 <em>Subsurface-mobile</em> is started. On most dive
computers this is done through a menu entry, others (like the Suunto
models) always respond to BLE requests.</p></div>
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>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.</p></div>
<div class="paragraph"><p>Please note that not all Android devices support OTG cables. And even on some devices that do support those cables in general, <em>Subsurface-mobile</em> still in some cases cannot access a dive computer through a serial port.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/USB-OTG.jpg" alt="FIGURE: USB-OTG cable" />
</div>
</div>
<div class="paragraph"><p>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 &#8594; Bluetooth tool is probably appropriate. Ensure pairing of the dive computer and mobile device.
<em>Subsurface-mobile</em> 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.</p></div>
<div class="paragraph"><p>With pairing between dive computer and <em>Subsurface-mobile</em> having been set up, dive download is simple.
From the main menu, tap <em>Manage dives &#8594; Download from DC</em>. 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 <em>Shearwater</em> and the Dive computer name is <em>Petrel 2</em>. 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).</p></div>
<div class="paragraph"><p>Now tap the button labeled <em>Download</em>. 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.</p></div>
<div class="paragraph"><p>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
<em>Subsurface-mobile</em> 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 <em>Accept</em>. All the selected dives appear on
the <em>Subsurface-mobile</em> dive list. The downloaded dive information can now be edited as described in the section
above <a href="#S_Edit_Dive">Edit a dive</a>.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/DC-Download.jpg" alt="FIGURE: DC download screen" />
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_viewing_the_dive_location_on_google_maps">10. Viewing the dive location on Google Maps</h2>
<div class="sectionbody">
<div class="paragraph"><p>In the <em>Details View</em>, 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 <em>Back</em> button
or tapping on the <em>Subsurface-mobile</em> link in the top left corner on iOS.</p></div>
<div class="paragraph"><p>Alternatively, the <em>Details View</em> has a button at the top right hand marked
<em>Map it</em>. Tap this button to open Google Maps showing the dive site (image below).</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/Map.jpg" alt="FIGURE: Map of dive site" />
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_dive_log_management">11. Dive log management</h2>
<div class="sectionbody">
<div class="paragraph"><p>A central part of <em>Subsurface-mobile</em> is the ability to store the dive
log using the <em>Subsurface</em> cloud storage.
This provides security against loss or damage to the dive information in a local copy
and allows the desktop version of <em>Subsurface</em> 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 <em>Dive management</em>, enabling a number of options:</p></div>
<div class="sect2">
<h3 id="_add_new_dive_manually">11.1. Add new dive manually</h3>
<div class="paragraph"><p>This is described above under the section dealing with <a href="#S_Add_Dive">Manually adding a new dive to the dive list</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_download_from_dc">11.2. Download from DC</h3>
<div class="paragraph"><p>This is described above under the section dealing with <a href="#S_Download">Download dives from a dive computer</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_apply_gps_fixes">11.3. Apply GPS fixes</h3>
<div class="paragraph"><p>This is described in the following main section, below.</p></div>
</div>
<div class="sect2">
<h3 id="_manually_sync_the_dive_log_with_the_em_subsurface_em_cloud_storage">11.4. Manually sync the dive log with the <em>Subsurface</em> cloud storage</h3>
<div class="paragraph"><p>Upload the dives contained on the mobile device
to the <em>Subsurface</em> cloud storage by tapping the option <em>Manual sync with cloud</em>.
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.</p></div>
</div>
<div class="sect2">
<h3 id="_enable_cloud_auto_sync">11.5. Enable cloud auto sync</h3>
<div class="paragraph"><p>By default <em>Subsurface-mobile</em> 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
<em>Subsurface-mobile</em> might appear to hang between operations as it tries to
connect to the cloud server. Selecting <em>Enable cloud auto sync</em> causes
the local dive log to be synchronized with the copy in the cloud every time that
<em>Subsurface-mobile</em> is closed. This option is a switch that allows auto
sync to be either activated or to be switched off.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_recording_dive_locations_using_gps">12. Recording dive locations using GPS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The fact that most smartphones have GPS facilities allows
<em>Subsurface-mobile</em> 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&#8217;s done:</p></div>
<div class="sect2">
<h3 id="S_ConfigureGPS">12.1. Configuring the GPS service</h3>
<div class="paragraph"><p>From the Main menu, select <em>Settings</em>. 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 <em>Back</em> button. The program is now ready to collect GPS positions.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/GPS-config.jpg" alt="FIGURE: GPS configure" />
</div>
</div>
</div>
<div class="sect2">
<h3 id="_collecting_gps_positions">12.2. Collecting GPS positions</h3>
<div class="paragraph"><p>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 <em>GPS &#8594; Run location service</em>. This activates the
recording of GPS locations.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/GPSstart.jpg" alt="FIGURE: GPS start" />
</div>
</div>
<div class="paragraph"><p><em>Subsurface-mobile</em> 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 <em>Disable location service</em>. The GPS symbol at the bottom
of all manus disappears.</p></div>
</div>
<div class="sect2">
<h3 id="_storing_the_gps_data_on_the_em_subsurface_em_cloud">12.3. Storing the GPS data on the <em>Subsurface</em> cloud</h3>
<div class="paragraph"><p>Activate the main menu and select the <em>GPS</em> option that brings up the submenu
of GPS-related actions. Tap <em>Upload GPS data</em> that saves the GPS data
on the <em>Subsurface</em> cloud server. These GPS data are saved <strong>separately</strong>
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.</p></div>
</div>
<div class="sect2">
<h3 id="_downloading_gps_data_from_the_em_subsurface_em_cloud">12.4. Downloading GPS data from the <em>Subsurface</em> cloud</h3>
<div class="paragraph"><p>Download the GPS data that have been saved on the cloud (possibly by a
different device) by
selecting <em>Download GPS Data</em> from the GPS sub-panel.</p></div>
</div>
<div class="sect2">
<h3 id="_viewing_gps_data">12.5. Viewing GPS data</h3>
<div class="paragraph"><p>From the GPS submenu select <em>Show GPS fixes</em>. 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.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/gpsmanagement.jpg" alt="FIGURE: GPS management" />
</div>
</div>
</div>
<div class="sect2">
<h3 id="_applying_gps_data_to_dives_in_the_dive_log">12.6. Applying GPS data to dives in the dive log</h3>
<div class="paragraph"><p>Assuming that all the dives have been entered into the dive log or have
been downloaded from the <em>Subsurface</em> cloud, apply the GPS positions to
these dives. GPS positions can therefore only be applied to dives in the dive list.
From the <em>Dive management</em> sub-panel, tap <em>Apply GPS fixes</em>. The dive list contains the start
and end times of each dive. Now, <em>Subsurface-mobile</em> 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.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_using_the_settings_for_em_subsurface_mobile_em">13. Using the settings for <em>Subsurface-mobile</em>.</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Settings screen allows the customization of <em>Subsurface-mobile</em>. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting.</p></div>
<div class="sect2">
<h3 id="S_ChangeCloudAccount">13.1. Changing to a different <em>Subsurface</em> cloud account</h3>
<div class="paragraph"><p>Some users have more than one <em>Subsurface</em> cloud account and with a need to switch between accounts. Tap <em>Settings</em> on the Main menu and scroll to the section titled <em>Cloud status</em> (see image below).
Tap the <em>Change</em> button. This opens the <em>Cloud credentials</em> screen.
change the credential information, then tap the button <em>Sign-in or register</em>. The appropriate dive list is shown.</p></div>
<div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/SettingsCloudTheme.jpg" alt="FIGURE: Settings: Cloud &amp; Theme" />
</div>
</div>
</div>
<div class="sect2">
<h3 id="_changing_the_color_theme_of_em_subsurface_mobile_em">13.2. Changing the color theme of <em>Subsurface-mobile</em></h3>
<div class="paragraph"><p><em>Subsurface-mobile</em> 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 <em>Settings</em>, and scroll to the section with heading <em>Theme</em> (see image above).
Select the appropriate color theme by dragging the appropriate slider on the righthand.</p></div>
</div>
<div class="sect2">
<h3 id="_configuring_the_gps_webservice">13.3. Configuring the GPS webservice</h3>
<div class="paragraph"><p>The Settings screen allows one to set up the way in which GPS positions are collected during dives. See the section on <a href="#S_ConfigureGPS">Configuring the GPS service</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_saving_a_detailed_dive_computer_dive_log">13.4. Saving a detailed dive computer dive log</h3>
<div class="paragraph"><p>Under the heading <em>Dive computer</em>, 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 <code>libdivecomputer.log</code>. In the same location you can also find a <code>subsurfacel.log</code> which is always created and which include more information which can be helpful when debugging problems with Subsurface-mobile.</p></div>
</div>
<div class="sect2">
<h3 id="_activating_the_developer_submenu">13.5. Activating the Developer submenu</h3>
<div class="paragraph"><p>The information in subsurface.log plus some additional information for understanding the screen rendering of dive information as well as the way in which <em>Subsurface-mobile</em> processed information during a specific occasion while running the app (see section below) is available through a <em>Developer</em> menu at run time. Activate (or deactivate) this menu item on the Main Menu by dragging the slider switch in the Settings screen.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_developer_submenu">14. Developer submenu</h2>
<div class="sectionbody">
<div class="paragraph"><p>If the Developer submenu has been activated in the Settings screen, the Main menu has a <em>Developer</em> item. By tapping this one has two options that are relevant within
the context of program development and debugging.</p></div>
<div class="sect2">
<h3 id="_app_log">14.1. App log</h3>
<div class="paragraph"><p>This option shows the messages that <em>Subsurface-mobile</em> 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.</p></div>
</div>
<div class="sect2">
<h3 id="_theme_information">14.2. Theme information</h3>
<div class="paragraph"><p>This option provides a wealth of information about the screen characteristics of the mobile
device and the font characteristics used by <em>Subsurface-mobile</em>.</p></div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
2018-09-21 19:29:32 PDT
</div>
</div>
</body>
</html>