diff options
author | Dirk Hohndel <dirk@hohndel.org> | 2017-10-11 05:57:51 -0700 |
---|---|---|
committer | Dirk Hohndel <dirk@hohndel.org> | 2017-10-11 05:57:51 -0700 |
commit | 26ba57d3a88bf7159e868cb9fa684a07cbaee6e6 (patch) | |
tree | bdb8789fc445e1a93e77c633cd0f6ca19ea0deab /Documentation | |
parent | 99418b09c69cf9644e689a7d0667b823f583187c (diff) | |
download | subsurface-26ba57d3a88bf7159e868cb9fa684a07cbaee6e6.tar.gz |
Update included version of mobile user manual
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/mobile-manual.html.git | 439 |
1 files changed, 273 insertions, 166 deletions
diff --git a/Documentation/mobile-manual.html.git b/Documentation/mobile-manual.html.git index fee617580..08ea18a08 100644 --- a/Documentation/mobile-manual.html.git +++ b/Documentation/mobile-manual.html.git @@ -404,89 +404,80 @@ asciidoc.install(3); <div id="content"> <div class="imageblock" style="text-align:center;"> <div class="content"> -<img src="mobile-images/banner.jpg" alt="Banner" /> +<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 author</strong>: Willem Ferguson</p></div> -<div id="toc"> - <div id="toctitle">Table of Contents</div> - <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript> -</div> -<div class="paragraph"><p><span class="blue"><em>Version 1.1, September 2016</em></span></p></div> -<div class="paragraph"><p>Welcome as a user of <em>Subsurface</em>, advanced dive logging software with -extensive infrastructure to describe, organize, interpret and print scuba +<div class="paragraph"><p><strong>Manual authors</strong>: Willem Ferguson, Dirk Hohndel</p></div> +<div class="paragraph"><p><span class="blue"><em>Version 2, October 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, Mac-OS/X, Linux (many distributions), Android and iOS. In addition, <em>Subsurface</em> is open-source software that allows downloading dive -information from most dive computers.</p></div> +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 an extension of <em>Subsurface</em> which -runs on Android smartphone and tablet devices and is a -tool for viewing or sharing dive information at dive sites where a larger -computer is not useful. <em>Subsurface-mobile</em> for Android also allows -the gathering of GPS locations where dives are performed -(Subsurface-mobile for iOS currently does not support GPS functionality).</p></div> -<div class="paragraph"><p><em>Subsurface-mobile</em> allows you to enter and save dive information -using a mobile device. Most users of <em>Subsurface-mobile</em> typically use the -mobile app as an extension to the laptop/desktop version of <em>Subsurface</em>. -This allows the storage of dive logs on the Internet sharing them -between the mobile and the desktop versions. But <em>Subsurface-mobile</em> can -be used independently of <em>Subsurface</em> and does not require the use of -cloud storage. -While the desktop version of <em>Subsurface</em> shows much more detailed information +<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.</p></div> -<div class="paragraph"><p><em>Subsurface-mobile</em> allows you to:</p></div> +previous dives. <em>Subsurface-mobile</em> for Android allows +the gathering of GPS locations where dives are performed +(Subsurface-mobile for iOS currently does not have full functionality). +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 is not dependent on 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 existing dive log information from the Internet. +Download and storage of dive log information using the <em>Subsurface</em> cloud. </p> </li> <li> <p> -View this information on a mobile device. +Viewing this information on a mobile device. </p> </li> <li> <p> -Edit many of the dive log data fields, e.g. divemaster, buddy, - equipment or notes about a dive. +Manually creating and adding new dive records to your dive log. </p> </li> <li> <p> -Manually create and add new dive records to your dive log. +Download dive data directly from many dive computers. </p> </li> <li> <p> -Store the updated dive log in the <em>Subsurface</em> cloud storage. +Editing many of the dive log data fields, e.g. divemaster, buddy, + equipment or notes relating to a dive. </p> </li> <li> <p> -Record, store and apply GPS positions of dives (Android only). +Recording, storing and applying GPS positions of dives (Android only). </p> </li> <li> <p> -View the localities of recorded GPS positions and of dives +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. -What <em>Subsurface-mobile</em> does not support (at this time) is downloading -dive data directly from a dive computer. That still needs to be done using -<em>Subsurface</em> on a desktop or laptop computer. We are investigating ways -to support downloading from a subset of the supported dive computers on -Android devices, but this is not yet ready for testing.</p></div> +<em>Subsurface-mobile</em> does not yet support download of dive data from all the +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 <em>Subsurface-mobile</em>.</p></div> </div> </div> <div class="sect1"> @@ -503,70 +494,62 @@ and install it.</p></div> 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="paragraph"><p>Select whether <em>Subsurface-mobile</em> should access the Internet for dive log information.</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 striked-out cloud icon. The app will not access the <em>Subsurface</em> +<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 manually -entered and stored on the mobile device only.</p></div> +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), then a 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>In order to use the <em>Subsurface</em> cloud storage, an account on the cloud -server is required. If you have already set up an account from the -<em>Subsurface</em> desktop application, enter the credentials here.</p></div> -<div class="paragraph"><p>You can also create a new account from your mobile device.</p></div> -<div class="sect3"> -<h4 id="_using_the_desktop_version_of_em_subsurface_em">3.2.1. Using the desktop version of <em>Subsurface</em>:</h4> -<div class="paragraph"><p>Open the desktop version of <em>Subsurface</em> and -click <em>File → Preferences → Network</em>, explained in detail in the -<a href="https://subsurface-divelog.org/documentation/subsurface-4-user-manual/#_create_a_cloud_storage_account">user -manual for the <em>Subsurface</em> desktop version</a>. Once the account has -been created and verified using the desktop version, -<em>Subsurface</em> desktop alows you to download dive information from dive computers and store this -on the cloud which can, in turn, be downloaded to <em>Subsurface-mobile</em>. <em>Subsurface-mobile</em> -attempts to download the existing dive log from the <em>Subsurface</em> cloud -server. Appropriate messages are shown onscreen. Finally a list of dives is shown.</p></div> -<div class="paragraph"><p>Once the dive -list has been downloaded from the Internet, <em>Subsurface-mobile</em> keeps a local +<div class="paragraph"><p>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 <em>Subsurface</em> desktop application in order to use cloud storage and one can +do full maintenance of a dive log from <em>Subsurface-mobile</em>. On the other hand, if one +shares credentials between <em>Subsurface-mobile</em> and <em>Subsurface</em> for desktop, one’s dive +log can be shared by both devices.</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> 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, <em>Subsurface-mobile</em> 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 +at a dive site, one can still access the local copy and view and manipulate +dive information.</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 either a <em>Subsurface</em> cloud +storage account or from a 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 synchronised.</p></div> -<div class="imageblock" style="text-align:center;"> -<div class="content"> -<img src="mobile-images/Credentials.jpg" alt="FIGURE: Mobile landing screen" /> -</div> -</div> -</div> -<div class="sect3"> -<h4 id="_using_em_subsurface_mobile_em">3.2.2. Using <em>Subsurface-mobile</em>:</h4> -<div class="paragraph"><p>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).</p></div> -<div class="paragraph"><p>2) Tap the Disk (Save) icon at the bottom of the screen. A PIN is sent to the -e-mail address provided.</p></div> -<div class="paragraph"><p>3) Enter the PIN into the field indicated and tap the <em>Save</em> icon again. The user -information is stored on the cloud server and access to the cloud is enabled.</p></div> -<div class="paragraph"><p>4) The dive list is initially empty. You can now start entering dives in the dive -log or you can download existing dives from your <em>Subsurface</em> cloud -storage account.</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 example 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="_a_few_remarks_about_the_user_interface">4. A Few Remarks About The User Interface</h2> +<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 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 <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 @@ -575,7 +558,7 @@ Android back button can be used to cancel the edit without saving changes.</p></ 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" /> +<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, @@ -605,30 +588,32 @@ Drag the action button visible on most screens to </ul></div> <div class="imageblock" style="text-align:center;"> <div class="content"> -<img src="mobile-images/menu.jpg" alt="FIGURE: Dive management subpanel" /> +<img src="mobile-images/Menusystem.jpg" alt="FIGURE: Dive management subpanel" /> </div> </div> -<div class="paragraph"><p>The images above indicate some of the important features of the menu system. -On the left is the main menu that is activated as described above. In the middle is -the menu that opens if you tap the <em>GPS</em> option on the main menu. On the right is -the menu that opens if you tap the <em>Manage Dives</em> option on the main menu.</p></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. As indicated earlier, the iOS version currently doesn’t support <em>GPS</em> features.</p></div> </div> </div> <div class="sect1"> -<h2 id="_viewing_the_dive_list">5. Viewing the Dive List</h2> +<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 (see image on left, below). Once the list is loaded you can scroll up and down. -Tapping a dive on the list brings up a display of <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> +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 <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/DiveList.jpg" alt="FIGURE: Dive list screen" /> +<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 @@ -640,29 +625,28 @@ on iOS; tap the GPS icon on the Action Bar.).</p></div> </div> </div> <div class="sect1"> -<h2 id="_editing_dive_details">6. Editing dive details</h2> +<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 <em>Action Button</em> 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 +<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 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 <em>Save</em> 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).</p></div> +the new information, after which the dive list screen is +updated and shown. To cancel any edits, tap the Android <em>Back</em> Button.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> -<img src="mobile-images/EditDive.jpg" alt="FIGURE: Dive edit screen" /> +<img src="mobile-images/Editdive.jpg" alt="FIGURE: Dive edit screen" /> </div> </div> </div> </div> <div class="sect1"> -<h2 id="_adding_a_new_dive_to_the_dive_list">7. Adding a new dive to the dive list</h2> +<h2 id="S_Add_Dive">7. Manually adding a new dive to the dive list</h2> <div class="sectionbody"> -<div class="paragraph"><p>You can manually add a dive to the existing dive list. On the dive list -tap the "plus" sign in the <em>Action Button</em>, or use the +<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 → 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 @@ -673,7 +657,7 @@ The left-hand image below shows a screenshot of a dive being created and the rig the same dive in <em>Details View</em>.</p></div> <div class="imageblock" style="text-align:center;"> <div class="content"> -<img src="mobile-images/ManuallyEnterDive.jpg" alt="FIGURE: Manual dive entry screen" /> +<img src="mobile-images/Manualdive.jpg" alt="FIGURE: Manual dive entry screen" /> </div> </div> </div> @@ -690,7 +674,7 @@ the screen (see image below).</p></div> <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 specific dive +<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 @@ -703,101 +687,169 @@ instruction to delete the dive.</p></div> </div> </div> <div class="sect1"> -<h2 id="_dive_log_management">9. Dive log management</h2> +<h2 id="S_Download">9. Download dives from a dive computer</h2> +<div class="sectionbody"> +<div class="paragraph"><p>Download of dives is possible from dive computers with a FTDI USB interface, or with a Bluetooth/BTLE interface.</p></div> +<div class="paragraph"><p>First, establish a link between the dive computer and the mobile device.</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 often have a full-sized 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 +receptacle of the mobile device. The +OTG cable often has a full-size 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="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, establish a Bluetooth connection between the dive computer and the +mobile device. Use the tools on the mobile device to achieve pairing between the Bluetooth dice computer +and the mobile device. For of Android devices, +the Settings → Bluetooth tool is probably appropriate. Ensure pairing of the dive computer and mobile device. +<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 → 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 labled <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. +Each dive has a check-box on the left hand side, used for selecting which dives need 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 labled <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.</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). +Afterwards, use the Adroid <em>Back</em> button to return to <em>Subsurface-mobile</em>.</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 contained in a local copy of -the dive log and allows the desktop version of <em>Subsurface</em> to +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 -alternatively tappping the "Hamburger" icon at the bottom left of the screen). -Tap the option <em>Manage dives</em>, enabling a number of options:</p></div> +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="_add_new_dive_manually">9.1. Add new dive manually</h3> -<div class="paragraph"><p>This is described above under the section dealing with the dive list.</p></div> +<h3 id="_dowload_from_dc">11.2. Dowload 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="_sync_the_dive_log_with_the_em_subsurface_em_cloud_storage">9.2. Sync the dive log with the <em>Subsurface</em> cloud storage</h3> -<div class="paragraph"><p>You can upload the dives contained on the mobile device -to the <em>Subsurface</em> cloud storage by tapping the option <em>Manual sync with coud</em>. +<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 on -another device or computer and stored in cloud storage.</p></div> +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="_working_offline_or_online">9.3. Working offline or online</h3> +<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 explicily told to do so (see above). You can choose to always sync with the cloud servers after every modification of the dive list. This is not recommended unless you are in an area with fast and reliable internet connection, as otherwise <em>Subsurface-mobile</em> might appear to hang between operations as it tries to -connect to the cloud server.</p></div> -</div> -<div class="sect2"> -<h3 id="_changing_the_login_credentials_on_the_em_subsurface_em_cloud">9.4. Changing the login credentials on the <em>Subsurface</em> cloud</h3> -<div class="paragraph"><p>If you need to change your login credentials (for example to work with -multiple accounts) you can -open the main menu and tap <em>Cloud credentials</em>. This opens the setup screen -for specifying new credentials.</p></div> +connect to the cloud server. Selecting <em>Enable cloud auto sync</em> causes +the local dive log to be synchronised 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_android_only">10. Recording dive locations using GPS (Android only).</h2> +<h2 id="_recording_dive_locations_using_gps_android_only">12. Recording dive locations using GPS (Android only).</h2> <div class="sectionbody"> <div class="paragraph"><p>The fact that most smartphones have GPS facilities allows <em>Subsurface-mobile</em> 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:</p></div> <div class="sect2"> -<h3 id="_setting_up_the_gps">10.1. Setting up the GPS</h3> -<div class="paragraph"><p>Open the main menu and tap <em>GPS → Preferences</em>. Now specify the way -in which GPS data need to be automatically collected (image on right, -below). You can specify that data are collected at regular intervals, e.g. -every 10 minutes, or at regular +<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 the above approaches. Provide the appropriate information and -tap the <em>Save</em> action button. The program is now ready to collect GPS positions.</p></div> +both of these approaches. Provide the appropriate information and +tap the Android <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/gpssetup.jpg" alt="FIGURE: GPS setup screen" /> +<img src="mobile-images/GPS-config.jpg" alt="FIGURE: GPS configure" /> </div> </div> </div> <div class="sect2"> -<h3 id="_collecting_gps_positions">10.2. Collecting GPS positions</h3> -<div class="paragraph"><p>Ensure that the GPS on the Android device has been activated. At the bottom -of the GPS submenu is a check box <em>Run location service</em> (image on left, above). -Check this box -and <em>Subsurface-mobile</em> 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.</p></div> +<h3 id="_collecting_gps_positions">12.2. Collecting GPS positions</h3> +<div class="paragraph"><p>Ensure that the GPS on the Android device has been activated. +Open the Main Menu and select <em>GPS → 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">10.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 -(image on left, above). Tap <em>Upload GPS data</em> that saves the GPS data +<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">10.4. Downloading GPS data from the <em>Subsurface</em> cloud</h3> +<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 subpanel.</p></div> </div> <div class="sect2"> -<h3 id="_viewing_gps_data">10.5. Viewing GPS data</h3> -<div class="paragraph"><p>From the GPS submenu (image on left, above) select <em>Show GPS fixes</em>. 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 +<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 @@ -809,22 +861,77 @@ options can be hidden by drawing the GPS record to the right, again using the ha </div> </div> <div class="sect2"> -<h3 id="_applying_gps_data_to_dives_in_the_dive_log">10.6. Applying GPS data to dives in the dive log</h3> +<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, you can apply the GPS positions to +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 GPS subpanel, tap <em>GPS-tag dives</em>. The dive list contains the start +From the <em>Dive management</em> subpanel, 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 customisation 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 & Theme" /> +</div> +</div> +</div> +<div class="sect2"> +<h3 id="_changing_the_colour_theme_of_em_subsurface_mobile_em">13.2. Changing the colour theme of <em>Subsurface-mobile</em></h3> +<div class="paragraph"><p><em>Subsurface-mobile</em> 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 <em>Settings</em>, and scroll to the section with heading <em>Theme</em> (see image above). +Select the appropriate colour 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>The Settings screen has a section with heading <em>Dive computer</em>, 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.</p></div> +</div> +<div class="sect2"> +<h3 id="_activating_the_developer_submenu">13.5. Activating the Developer submenu</h3> +<div class="paragraph"><p>Information is available useful 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). 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 behaviour 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 2016-09-04 09:53:24 PDT +Last updated 2017-10-11 05:56:06 PDT </div> </div> </body> |