diff options
24 files changed, 193 insertions, 162 deletions
diff --git a/Documentation/mobile-images/Actionbutton.jpg b/Documentation/mobile-images/Actionbutton.jpg Binary files differnew file mode 100644 index 000000000..339176def --- /dev/null +++ b/Documentation/mobile-images/Actionbutton.jpg diff --git a/Documentation/mobile-images/banner.jpg b/Documentation/mobile-images/Banner.jpg Binary files differindex 0823bc7fd..0823bc7fd 100644 --- a/Documentation/mobile-images/banner.jpg +++ b/Documentation/mobile-images/Banner.jpg diff --git a/Documentation/mobile-images/ColourSchemes.jpg b/Documentation/mobile-images/ColourSchemes.jpg Binary files differdeleted file mode 100644 index a157b91db..000000000 --- a/Documentation/mobile-images/ColourSchemes.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Colourschemes.jpg b/Documentation/mobile-images/Colourschemes.jpg Binary files differnew file mode 100644 index 000000000..43199e63f --- /dev/null +++ b/Documentation/mobile-images/Colourschemes.jpg diff --git a/Documentation/mobile-images/Credentials.jpg b/Documentation/mobile-images/Credentials.jpg Binary files differindex ada9ac38b..70f062594 100644 --- a/Documentation/mobile-images/Credentials.jpg +++ b/Documentation/mobile-images/Credentials.jpg diff --git a/Documentation/mobile-images/DC-Download.jpg b/Documentation/mobile-images/DC-Download.jpg Binary files differindex 5cbc77e4b..e3dd3c4ed 100644 --- a/Documentation/mobile-images/DC-Download.jpg +++ b/Documentation/mobile-images/DC-Download.jpg diff --git a/Documentation/mobile-images/DiveList.jpg b/Documentation/mobile-images/DiveList.jpg Binary files differdeleted file mode 100644 index 751c345d5..000000000 --- a/Documentation/mobile-images/DiveList.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Divelist2.jpg b/Documentation/mobile-images/Divelist2.jpg Binary files differnew file mode 100644 index 000000000..c0a166343 --- /dev/null +++ b/Documentation/mobile-images/Divelist2.jpg diff --git a/Documentation/mobile-images/EditDive.jpg b/Documentation/mobile-images/EditDive.jpg Binary files differdeleted file mode 100644 index d63b38321..000000000 --- a/Documentation/mobile-images/EditDive.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Editdive.jpg b/Documentation/mobile-images/Editdive.jpg Binary files differnew file mode 100644 index 000000000..078a465fa --- /dev/null +++ b/Documentation/mobile-images/Editdive.jpg diff --git a/Documentation/mobile-images/GPS-config.jpg b/Documentation/mobile-images/GPS-config.jpg Binary files differnew file mode 100644 index 000000000..c38338d82 --- /dev/null +++ b/Documentation/mobile-images/GPS-config.jpg diff --git a/Documentation/mobile-images/GPS-setup.jpg b/Documentation/mobile-images/GPS-setup.jpg Binary files differdeleted file mode 100644 index a14370ec1..000000000 --- a/Documentation/mobile-images/GPS-setup.jpg +++ /dev/null diff --git a/Documentation/mobile-images/GPSstart.jpg b/Documentation/mobile-images/GPSstart.jpg Binary files differnew file mode 100644 index 000000000..b3c56117e --- /dev/null +++ b/Documentation/mobile-images/GPSstart.jpg diff --git a/Documentation/mobile-images/MainMenu2.jpg b/Documentation/mobile-images/MainMenu2.jpg Binary files differdeleted file mode 100644 index 8b2cd08b1..000000000 --- a/Documentation/mobile-images/MainMenu2.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Mainmenu.jpg b/Documentation/mobile-images/Mainmenu.jpg Binary files differdeleted file mode 100644 index 99b0c9f4e..000000000 --- a/Documentation/mobile-images/Mainmenu.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Manualdive.jpg b/Documentation/mobile-images/Manualdive.jpg Binary files differnew file mode 100644 index 000000000..bd64e53bc --- /dev/null +++ b/Documentation/mobile-images/Manualdive.jpg diff --git a/Documentation/mobile-images/ManuallyEnterDive.jpg b/Documentation/mobile-images/ManuallyEnterDive.jpg Binary files differdeleted file mode 100644 index 26678bf7f..000000000 --- a/Documentation/mobile-images/ManuallyEnterDive.jpg +++ /dev/null diff --git a/Documentation/mobile-images/Map.jpg b/Documentation/mobile-images/Map.jpg Binary files differindex 7cc134197..98b005b17 100644 --- a/Documentation/mobile-images/Map.jpg +++ b/Documentation/mobile-images/Map.jpg diff --git a/Documentation/mobile-images/Menusystem.jpg b/Documentation/mobile-images/Menusystem.jpg Binary files differnew file mode 100644 index 000000000..f73472f80 --- /dev/null +++ b/Documentation/mobile-images/Menusystem.jpg diff --git a/Documentation/mobile-images/SettingsCloudTheme.jpg b/Documentation/mobile-images/SettingsCloudTheme.jpg Binary files differnew file mode 100644 index 000000000..5e00a6441 --- /dev/null +++ b/Documentation/mobile-images/SettingsCloudTheme.jpg diff --git a/Documentation/mobile-images/actionbutton.jpg b/Documentation/mobile-images/actionbutton.jpg Binary files differdeleted file mode 100644 index d5cdf3ee1..000000000 --- a/Documentation/mobile-images/actionbutton.jpg +++ /dev/null diff --git a/Documentation/mobile-images/gpsmanagement.jpg b/Documentation/mobile-images/gpsmanagement.jpg Binary files differindex 5f51b082b..6de2d60ec 100644 --- a/Documentation/mobile-images/gpsmanagement.jpg +++ b/Documentation/mobile-images/gpsmanagement.jpg diff --git a/Documentation/mobile-images/menu.jpg b/Documentation/mobile-images/menu.jpg Binary files differdeleted file mode 100644 index db906088b..000000000 --- a/Documentation/mobile-images/menu.jpg +++ /dev/null diff --git a/Documentation/mobile-manual.txt b/Documentation/mobile-manual.txt index 07f0f7971..0b5684787 100644 --- a/Documentation/mobile-manual.txt +++ b/Documentation/mobile-manual.txt @@ -3,69 +3,63 @@ // ============================= // :author: Manual authors: Willem Ferguson, Dirk Hohndel // :revnumber: 2.0 -// :revdate: July 2017 +// :revdate: October 2017 :icons: :toc: :toc-placement: manual :numbered: // :website: http://subsurface-divelog.org -image::mobile-images/banner.jpg["Banner",align="center"] +image::mobile-images/Banner.jpg["Banner",align="center"] [big]#Subsurface-mobile USER MANUAL# *Manual authors*: Willem Ferguson, Dirk Hohndel -toc::[] +// toc::[] -[blue]#_Version 2, July 2017_# +[blue]#_Version 2, October 2017_# -Welcome as a user of _Subsurface_, advanced dive logging software with -extensive infrastructure to describe, organize, interpret and print scuba +Welcome as a user of _Subsurface_ and _Subsurface-mobile_, advanced dive logging +software with extensive infrastructure to describe, organize, and interpret scuba and free dives. _Subsurface_ offers many advantages over other similar software solutions, including compatibility with Windows, Mac-OS/X, Linux (many distributions), Android and iOS. In addition, _Subsurface_ is open-source software that allows downloading dive -information from most dive computers. +information from many dive computers. Introducing Subsurface-mobile ----------------------------- -_Subsurface-mobile_ is an extension of _Subsurface_ which -runs on Android and iOS smartphone and tablet devices and is a -tool for viewing or sharing dive information at dive sites where a larger -computer is not useful. _Subsurface-mobile_ for Android also allows +_Subsurface-mobile_ is a more limited mobile version of _Subsurface_ +aimed at Android and iOS smartphone and tablet devices, allowing viewing, entering, sharing, and storage of dive information at dive sites where a larger +computer is not useful. While the desktop version of _Subsurface_ shows much more detailed information +for each dive, the mobile version allows a more accessible dive log +on a dive trip, useful for proving dive experience to dive shops or to review +previous dives. _Subsurface-mobile_ for Android allows the gathering of GPS locations where dives are performed (Subsurface-mobile for iOS currently does not have full functionality). - -_Subsurface-mobile_ allows you to enter and save dive information -using a mobile device. Users of _Subsurface-mobile_ typically use the -mobile app as an extension to the laptop/desktop version of _Subsurface_ that -allows the storage of dive logs on the Internet and sharing them -between the mobile and the desktop versions. But _Subsurface-mobile_ can -also be used independently of _Subsurface_ and does not require the use of +Users of _Subsurface-mobile_ typically use the +mobile app as a companion to the laptop/desktop version of _Subsurface_, sharing dive information +between the mobile and the desktop versions. However _Subsurface-mobile_ can +also be used independently of the desktop version and is not dependent on the use of cloud storage. -While the desktop version of _Subsurface_ shows much more detailed information -for each dive, the mobile version allows a more accessible dive log -on a dive trip, useful for proving dive experience to dive shops or to review -previous dives. -_Subsurface-mobile_ allows you to: +_Subsurface-mobile_ allows: -- Download existing dive log information from the Internet. -- View this information on a mobile device. -- Edit many of the dive log data fields, e.g. divemaster, buddy, - equipment or notes about a dive. -- Manually create and add new dive records to your dive log. +- Download and storage of dive log information using the _Subsurface_ cloud. +- Viewing this information on a mobile device. +- Manually creating and adding new dive records to your dive log. - Download dive data directly from many dive computers. -- Store the updated dive log in the _Subsurface_ cloud storage. -- Record, store and apply GPS positions of dives (Android only). -- View the localities of recorded GPS positions and of dives +- Editing many of the dive log data fields, e.g. divemaster, buddy, + equipment or notes relating to a dive. +- Recording, storing and applying GPS positions of dives (Android only). +- Viewing the localities of recorded GPS positions and of dives on a map. These items are discussed in greater detail in the following text. _Subsurface-mobile_ does not yet support download of dive data from all the -dive computers that the desktop/laptop version can: that still needs to be done using _Subsurface_ on a desktop or laptop computer. Only a subset of +dive computers that the desktop/laptop version can. Only a subset of dive computers that use a FTDI USB interface or a Bluetooth/BTLE interface are accessible by _Subsurface-mobile_. @@ -81,71 +75,57 @@ splash screen is shown while the program loads. On some devices this may take several seconds. After loading, the _Cloud Credentials screen_ appears (see image below on left). -Select whether _Subsurface-mobile_ should access the Internet for dive log information as follows: +image::mobile-images/Credentials.jpg["FIGURE: Mobile credentials screen",align="center"] === When NOT Using Cloud Storage -Tap the striked-out cloud icon. The app will not access the _Subsurface_ +Tap the "No cloud mode" button. The app will not access the _Subsurface_ cloud storage server to obtain dive log information. This means that dive log information is -stored on the mobile device only. +stored on the mobile device only. If no dives have been entered into the dive log +yet (the usual case), then a an empty dive log is created. === Using Cloud Storage -In order to use the _Subsurface_ cloud storage, an account on the cloud -server is required. If you have already set up an account from the -_Subsurface_ desktop application, enter the credentials here. - -You can also create a new cloud storage account from your mobile device. - -==== Using the desktop version of _Subsurface_: - -Open the desktop version of _Subsurface_ and -click _File -> Preferences -> Network_, explained in detail in the -https://subsurface-divelog.org/documentation/subsurface-4-user-manual/#\_create_a_cloud_storage_account[user -manual for the _Subsurface_ desktop version]. Once the account has -been created and verified using the desktop version, -_Subsurface_ desktop alows you to download dive information from dive computers and store this -on the cloud which can, in turn, be downloaded to _Subsurface-mobile_. _Subsurface-mobile_ -attempts to download the existing dive log from the _Subsurface_ cloud -server. Appropriate messages are shown onscreen. Finally a list of dives is shown. +A free Internet cloud storage account is created for +storing dive log information in future. One can create a new cloud storage account +using a mobile device: there is no need to have credentials created +using the _Subsurface_ desktop application in order to use cloud storage and one can +do full maintenance of a dive log from _Subsurface-mobile_. On the other hand, if one +shares credentials between _Subsurface-mobile_ and _Subsurface_ for desktop, one's dive +log can be shared by both devices. +1) Enter an e-mail address and a password in the fields indicated on the screen. +The e-mail address should be in lower case and the password should contain a combination of +letters from the alphabet (upper and lower case) and/or numbers. +Tap the "Sign-in or Register" button. If you have already set +up an account from the _Subsurface_ desktop application, enter the same credentials here. Once the dive -list has been downloaded from the Internet, _Subsurface-mobile_ keeps a local +list has been downloaded from the cloud, _Subsurface-mobile_ keeps a local copy on the mobile device. This means that even if there is no Internet connection -at a dive site, you can still access the local copy and view and manipulate -dive information. If there is Internet connectivity, _Subsurface-mobile_ accesses -the cloud-based dive log to verify that the local copy is still the -same as the Internet-stored copy. If not, the local copy and the copy on -the server are synchronised. - - -image::mobile-images/Credentials.jpg["FIGURE: Mobile landing screen",align="center"] - - -==== Using _Subsurface-mobile_: - -1) Enter an e-mail address and a password in the fields indicated on the screen. -The e-mail should be in lower case and the password should contain a combination of -letters from the alphabet (upper and lower case) and/or numbers. When entering a -password, it is possible to check a checkbox that enables the text of the password to be shown -(image on left, above). At this stage, the red message "Cannot connect to cloud storage" appears on the screen. -This is normal because a valid PIN has not yet been provided (image on left, above). - -2) Tap the Disk (Save) icon at the bottom of the screen. A PIN is sent to the -e-mail address provided. - -3) Enter the PIN into the field indicated and tap the _Save_ icon again. The user -information is stored on the cloud server and access to the cloud is enabled. - -4) The dive list is initially empty. Start entering dives in the dive +at a dive site, one can still access the local copy and view and manipulate +dive information. + +3) If this is a new account, a PIN screen will open (see image on right, above). A PIN is e-mailed +to the email address entered in the previous step. Enter this PIN into the field indicated +and tap the _Register_ button. The user +information is stored on the cloud server and access to the cloud is enabled. In this case +the dive list is initially empty. Start entering dives in the dive log or download dive information from either a _Subsurface_ cloud storage account or from a dive computer. +The dive log can be updated automatically. If there is Internet connectivity, _Subsurface-mobile_ accesses +the cloud-based dive log to verify that the local copy of the dive log is still the +same as the log in the cloud server. If not, the local copy and the copy on +the server are synchronised. + +=== Changing the existing login credentials on the _Subsurface_ cloud + +The login credentials can be changed, for example to work with +multiple accounts. See the section on xref:S_ChangeCloudAccount[Changing to a different _Subsurface_ cloud account]. == Menu Structure and User Interface At the bottom of many Subsurface-mobile screens is a round button that provides for -several actions and which allows the selection of the main affirmative action -(see image above and image below). +several actions (see image below). The most appropriate choice is indicated in a round blue _action button_ (in the case below, edit a dive). Alternative actions are indicated in a white _action bar_. On Android devices, use the Android Back button for "cancel", "discard" or "back" actions. For example, when editing dive information, tapping the action button saves the changes while the @@ -154,7 +134,7 @@ Android back button can be used to cancel the edit without saving changes. On iOS devices, on screens where a "back" action is enabled, a back arrow is shown in the top left corner of the screen. -image::mobile-images/actionbutton.jpg["FIGURE: Action Button",align="center"] +image::mobile-images/Actionbutton.jpg["FIGURE: Action Button",align="center"] In order to have a consistent experience between iOS and Android, _Subsurface-mobile_ on Android does not use the traditional "hamburger" @@ -169,29 +149,29 @@ developed by the Plasma developers. There are three ways to open the main menu: - Drag the action button visible on most screens to the right -image::mobile-images/MainMenu2.jpg["FIGURE: Dive management subpanel",align="center"] +image::mobile-images/Menusystem.jpg["FIGURE: Dive management subpanel",align="center"] -The images above indicate some of the important features of the menu system. -On the left is the main menu, activated as described above. On the right, above, -is a representation of the menu items of all the submenus accessible -from the main menu: the main menu items are shown on the left while the submenu contents -are shown on a blue background on the right. +The image above indicates some of the important features of the menu system. +On the left is the main menu, activated as described above. On the right of the image +are the items of all the submenus accessible. All screenshots in this user manual are currently from the Android version. As indicated earlier, the iOS version currently doesn't support _GPS_ features. -== Viewing the Dive List +== The Dive List Most of the actions of _Subsurface-mobile_ center around the dives on the dive list. While the dive list is loading from the cloud, a message appears at the bottom of the screen, indicating that the cloud is -being accessed. Once the list is loaded you can scroll up and down. -Tapping a dive on the list brings up a display of _Details View_ for that dive +being accessed, after which the dive list is shown. Once the list is loaded you can scroll up and down. +To upload dives from a dive computer, tap the blue action button. If you wish +to add a dive manually, tap the + button in the action bar (described below). +Tapping an existing dive on the list brings up a display of _Details View_ for that dive (see image on right below). This includes the dive profile as well as additional information and notes. -image::mobile-images/DiveList.jpg["FIGURE: Dive list screen",align="center"] +image::mobile-images/Divelist2.jpg["FIGURE: Dive list screen",align="center"] You can view other dives by swiping the _Details view_ to the right (for the previous dive) or to the left (following dive). @@ -203,23 +183,22 @@ on iOS; tap the GPS icon on the Action Bar.). [[S_Edit_Dive]] == Editing dive details -At the bottom of the dive details screen the _Action Button_ contains a pencil (image on right, above). -Tapping the pencil button brings up a panel with edit boxes that allows you to -change the existing dive information, e.g. adding text to the dive notes +At the bottom of the dive details screen the action button is a pencil (image on right, above). +Tapping the pencil button brings up a panel with edit boxes that allows +changing the existing dive information, e.g. adding text to the dive notes or changing the names or values of some of the information (see image below). It may be necessary to scroll the window to access all the information. At the bottom of the edit screen is a _Save_ action button. Tap this to save -the new information. Having saved the data, the dive list screen is -updated and shown. To cancel any edits, tap the Android Back Button or -swipe the edit screen up (fling it away). +the new information, after which the dive list screen is +updated and shown. To cancel any edits, tap the Android _Back_ Button. -image::mobile-images/EditDive.jpg["FIGURE: Dive edit screen",align="center"] +image::mobile-images/Editdive.jpg["FIGURE: Dive edit screen",align="center"] [[S_Add_Dive]] -== Adding a new dive to the dive list +== Manually adding a new dive to the dive list -You can manually add a dive to the existing dive list. On the dive list -tap the "plus" sign in the _Action Button_, or use the +One can manually add a dive to the existing dive list. On the dive list +tap the "plus" sign in the action bar, or use the main menu and tap _Manage dives -> Add dive manually_. This opens a screen that is identical to the editing screen discussed above. When a dive is added manually, you cannot directly add a dive profile from a dive computer. However, if you do not use a @@ -229,7 +208,7 @@ contains a disk symbol. Tap this to save the new dive. To cancel any edits, tap The left-hand image below shows a screenshot of a dive being created and the right-hand image shows the same dive in _Details View_. -image::mobile-images/ManuallyEnterDive.jpg["FIGURE: Manual dive entry screen",align="center"] +image::mobile-images/Manualdive.jpg["FIGURE: Manual dive entry screen",align="center"] == Deleting a dive @@ -240,7 +219,7 @@ the screen (see image below). image::mobile-images/Delete_undo.jpg["FIGURE: Undo delete dive",align="center"] -You can also delete a dive from the dive list by long-pressing a specific dive +You can also delete a dive from the dive list by long-pressing a dive until a red dustbin appears on the right-hand side (see image below). Tap the dustbin. The dive is deleted without asking any confirmation because _Subsurface-mobile_ assumes that the combination of a long tap on the dive with another tap on the red dustbin is an unambiguous @@ -248,11 +227,12 @@ instruction to delete the dive. image::mobile-images/RedDustbin.jpg["FIGURE: delete dive from list",align="center"] +[[S_Download]] == Download dives from a dive computer -Download of dives is possible from dive computers with a FTDI USB interface, or with a Bluetooth interface. +Download of dives is possible from dive computers with a FTDI USB interface, or with a Bluetooth/BTLE interface. -First, establish a link between the dive computer and the mobile device. +First, establish a link between the dive computer and the mobile device. For USB dive computers, USB cables "normally" used for uploading dives to a desktop/laptop computer do NOT work: these cables often have a full-sized male USB plug @@ -266,23 +246,23 @@ of the USB cable "normally" used (see image below). This means that two cables a image::mobile-images/USB-OTG.jpg["FIGURE: USB-OTG cable",align="center"] For Bluetooth-equipped dive computers, establish a Bluetooth connection between the dive computer and the -mobile device. Use the tools on the mobile device to achieve this. For of Android mobile devices, +mobile device. Use the tools on the mobile device to achieve pairing between the Bluetooth dice computer +and the mobile device. For of Android devices, the Settings -> Bluetooth tool is probably appropriate. Ensure pairing of the dive computer and mobile device. _Subsurface-mobile_ performs communication using both Bluetooth and Bluetooth-low-energy (BTLE). The appropriate choice of Bluetooth communication is made by the software and the user need not be concerned with this. -With propper communication between dive computer and _Subsurface-mobile_ having been set up, dive download is simple. +With pairing between dive computer and _Subsurface-mobile_ having been set up, dive download is simple. From the main menu, tap _Manage dives -> Download from DC_. A screen is shown requiring that the user specify the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel 2 dive computer, the vendor is _Shearwater_ and the Dive computer name is _Petrel 2_. From the two dropdown lists -at the top of the screen, select the correct vendor and dive computer names (see image on the left, below). If -using a dive computer using a Bluetooth connection, then tap the check box labelled _Bluetooth download_. +at the top of the screen, select the correct vendor and dive computer names (see image on the left, below). -Now tap the button labled _DOWNLOAD_. The downloaded dives appear in the bottom part of the screen, the -most recent dive at the top (see image on right, below). Be patient because the download can sometimes take a few mimnutes. +Now tap the button labled _Download_. The downloaded dives appear in the bottom part of the screen, the +most recent dive at the top (see image on right, below). Be patient because the download can take a few minutes. Each dive has a check-box on the left hand side, used for selecting which dives need to be added to the _Subsurface-mobile_ dive list: dives that are not checked are ignored. With the appropriate downloaded dives -having been checked, tap the button at the bottom left labled _ACCEPT_. All the selected dives appear on +having been checked, tap the button at the bottom left labled _Accept_. All the selected dives appear on the _Subsurface-mobile_ dive list. The downloaded dive information can now be edited as described in the section above xref:S_Edit_Dive[Edit a dive]. @@ -290,12 +270,12 @@ image::mobile-images/DC-Download.jpg["FIGURE: DC download screen",align="center" == Viewing the dive location on Google Maps -The site of a specific dive can be viewed in two ways using the _Details View_. -The Action Bar at the bottom 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. 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. +_Map it_. Tap this button to open Google Maps showing the dive site (image below). +Afterwards, use the Adroid _Back_ button to return to _Subsurface-mobile_. image::mobile-images/Map.jpg["FIGURE: Map of dive site",align="center"] @@ -303,26 +283,34 @@ image::mobile-images/Map.jpg["FIGURE: Map of dive site",align="center"] A central part of _Subsurface-mobile_ is the ability to store the dive log using the _Subsurface_ cloud storage. -This provides security against loss or damage to the dive information contained in a local copy of -the dive log and allows the desktop version of _Subsurface_ to +This provides security against loss or damage to the dive information in a local copy +and allows the desktop version of _Subsurface_ to access changes made using the mobile device. This ability is accessed through the main menu (by dragging the Action Button to the right, or -alternatively tapping the "Hamburger" icon at the bottom left of the screen). -Tap the option _Manage dives_, enabling a number of options: +by tapping the "Hamburger" icon at the bottom left of the screen). +Tap the option _Dive management_, enabling a number of options: === Add new dive manually -This is described above under the section dealing with xref:S_Add_Dive[Adding a new dive to the dive list]. +This is described above under the section dealing with xref:S_Add_Dive[Manually adding a new dive to the dive list]. -=== Sync the dive log with the _Subsurface_ cloud storage +=== Dowload from DC + +This is described above under the section dealing with xref:S_Download[Download dives from a dive computer]. + +=== Apply GPS fixes + +This is described in the following main section, below. + +=== Manually sync the dive log with the _Subsurface_ cloud storage Upload the dives contained on the mobile device to the _Subsurface_ cloud storage by tapping the option _Manual sync with cloud_. This synchronizes the local changes to the dive log with the cloud storage. It also downloads changes made to -the dive log using another device or computer and stored in cloud storage. +the dive log using another device or computer and stored in shared cloud storage. -=== Working offline or online +=== Enable cloud auto sync By default _Subsurface-mobile_ runs offline and only syncs the dive list with cloud storage when explicily told to do so (see above). @@ -330,53 +318,46 @@ You can choose to always sync with the cloud servers after every modification of the dive list. This is not recommended unless you are in an area with fast and reliable internet connection, as otherwise _Subsurface-mobile_ might appear to hang between operations as it tries to -connect to the cloud server. - -=== Changing the login credentials on the _Subsurface_ cloud - -The login credentials (for example to work with -multiple accounts) can be changed by opening -the main menu and by tapping _Settings -> Cloud credentials_. This opens -the screen for specifying new credentials. - -=== Changing the colour scheme of _Subsurface-mobile_ - -_Subsurface-mobile_ has three colour schemes to please users with different -tastes. This user manual shows the default colour scheme, comprising blue -colours. Change to a pink or a dark colour scheme by opening the main menu and -tap Settings -> Preferences. This opens the Preferences screen that includes -the three colour schemes (see image below). - -image::mobile-images/ColourSchemes.jpg["FIGURE: Colour scheme setup screen",align="center"] +connect to the cloud server. Selecting _Enable cloud auto sync_ causes +the local dive log to be synchronised with the copy in the cloud every time that +_Subsurface-mobile_ is closed. This option is a switch that allows auto +sync to be either activated or to be switched off. == Recording dive locations using GPS (Android only). The fact that most smartphones have GPS facilities allows _Subsurface-mobile_ on Android to record -the locations of dives. You can take the smartphone on the dive boat -during a dive and locations will be automatically recorded at regular intervals. +the locations of dives. If the smartphone is taken on the dive boat +during a dive, locations will be automatically recorded at regular intervals. These locations can then be applied to dives in the dive list. Here is how it's done: -=== Setting up the GPS +[[S_ConfigureGPS]] +=== Configuring the GPS service -Open the main menu and tap _GPS -> Preferences_. Now specify the way -in which GPS data need to be automatically collected (image above). Data +From the Main menu, select _Settings_. The Settings screen has a section for +configuring the GPS service (image below). GPS location data are collected at regular intervals, e.g. every 5 minutes, or at regular distances, e.g. after the boat has moved more than 200m, or a combination of both of these approaches. Provide the appropriate information and -tap the _Save_ action button. The program is now ready to collect GPS positions. +tap the Android _Back_ button. The program is now ready to collect GPS positions. + +image::mobile-images/GPS-config.jpg["FIGURE: GPS configure",align="center"] === Collecting GPS positions -image::mobile-images/Mainmenu.jpg["FIGURE: Main menu",align="center"] +Ensure that the GPS on the Android device has been activated. +Open the Main Menu and select _GPS -> Run location service_. This activates the +recording of GPS locations. + +image::mobile-images/GPSstart.jpg["FIGURE: GPS start",align="center"] -Ensure that the GPS on the Android device has been activated. At the bottom -of the GPS submenu is a check box _Run location service_ (image above). -Check this box -and _Subsurface-mobile_ starts to collect GPS locations automatically, -following the preferences specified as described above. After return from -the dive trip you can deactivate the collection of GPS data by de-activating -the same check box at the bottom of the main menu. +_Subsurface-mobile_ starts to collect GPS locations automatically, +following the preferences specified as described above. While the GPS +location service is running, all menus have a GPS symbol at the bottom +of the menu, indicating that the service is active. After return from +the dive trip, deactivate the collection of GPS data by tapping +the option _Disable location service_. The GPS symbol at the bottom +of all manus disappears. === Storing the GPS data on the _Subsurface_ cloud @@ -395,10 +376,9 @@ selecting _Download GPS Data_ from the GPS subpanel. === Viewing GPS data From the GPS submenu select _Show GPS fixes_. This brings -up a list of GPS positions obtained using the location service (image -on left, below). Two actions are possible for each of the locations, enabled if -you tap the handle (the three horisontal stripes on the right, see image on left, below) and -then drags the specific item to the left (image on right, below). This exposes two +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 @@ -409,9 +389,60 @@ image::mobile-images/gpsmanagement.jpg["FIGURE: GPS management",align="center"] === Applying GPS data to dives in the dive log Assuming that all the dives have been entered into the dive log or have -been downloaded from the _Subsurface_ cloud, you can apply the GPS positions to +been downloaded from the _Subsurface_ cloud, apply the GPS positions to these dives. GPS positions can therefore only be applied to dives in the dive list. -From the GPS subpanel, tap _GPS-tag dives_. The dive list contains the start +From the _Dive management_ subpanel, tap _Apply GPS fixes_. The dive list contains the start and end times of each dive. Now, _Subsurface-mobile_ applies the first GPS position that falls within the dive period of each dive. This results in a GPS position for each dive that is saved as part of the dive log. + +== Using the settings for _Subsurface-mobile_. + +The Settings screen allows the customisation of _Subsurface-mobile_. Many of the settings involve dragging a slider switch to activate or deactivate a particular setting. + +[[S_ChangeCloudAccount]] +=== Changing to a different _Subsurface_ cloud account + +Some users have more than one _Subsurface_ cloud account and with a need to switch between accounts. Tap _Settings_ on the Main menu and scroll to the section titled _Cloud status_ (see image below). +Tap the _Change_ button. This opens the _Cloud credentials_ screen. +change the credential information, then tap the button _Sign-in or register_. The appropriate dive list is shown. + +image::mobile-images/SettingsCloudTheme.jpg["FIGURE: Settings: Cloud & Theme",align="center"] + +=== Changing the colour theme of _Subsurface-mobile_ + +_Subsurface-mobile_ has three colour schemes to please users with different +tastes. This user manual shows the default colour scheme, comprising blue +colours. Change to a pink or a dark colour scheme by opening the main menu, +tap _Settings_, and scroll to the section with heading _Theme_ (see image above). +Select the appropriate colour theme by dragging the appropriate slider on the righthand. + +=== 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]. + +=== Saving a detailed dive computer dive log + +The Settings screen has a section with heading _Dive computer_, containing 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. + +=== Activating the Developer submenu + +Information is available useful 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). Activate (or deactivate) this menu item on the Main Menu by dragging the slider switch in the Settings screen. + +== Developer submenu + +If the Developer submenu has been activated in the Settings screen, the Main menu has a _Developer_ item. By tapping this one has two options that are relevant within +the context of program development and debugging. + +=== App log + +This option shows the messages that _Subsurface-mobile_ generates while running. While +most users are not aware of these messages, they are often crucial in detecting any +abnormal behaviour of the app. The App log can be found in the root directory of the local storage of the mobile device. + +=== Theme information + +This option provides a wealth of information about the screen characteristics of the mobile +device and the font characteristics used by _Subsurface-mobile_. + + |
