Changeset a5bb8ae in subsurface


Ignore:
Timestamp:
Jul 8, 2017, 2:38:29 PM (2 weeks ago)
Author:
Dirk Hohndel <dirk@…>
Branches:
master
Children:
1fd00a3
Parents:
22a0ebe
git-author:
Willem Ferguson <willemferguson@…> (07/04/17 06:03:04)
git-committer:
Dirk Hohndel <dirk@…> (07/08/17 14:38:29)
Message:

Update Subsurface-mobile user manual

[Dirk Hohndel: collapsed all of the commits into one]

Signed-off-by: Willem Ferguson <willemferguson@…>
Signed-off-by: Dirk Hohndel <dirk@…>

Location:
Documentation
Files:
7 added
1 deleted
8 edited

Legend:

Unmodified
Added
Removed
  • Documentation/mobile-manual.txt

    r3f78283 ra5bb8ae  
     1
    12// Subsurface-mobile User Manual
    23// =============================
    34// :author: Manual authors: Willem Ferguson, Dirk Hohndel
    4 // :revnumber: 1.1
    5 // :revdate: September 2016
     5// :revnumber: 2.0
     6// :revdate: July 2017
    67:icons:
    78:toc:
     
    1415[big]#Subsurface-mobile USER MANUAL#
    1516
    16 *Manual author*: Willem Ferguson
     17*Manual authors*: Willem Ferguson, Dirk Hohndel
    1718
    1819toc::[]
    1920
    20 [blue]#_Version 1.1, September 2016_#
     21[blue]#_Version 2, July 2017_#
    2122
    2223Welcome as a user of _Subsurface_, advanced dive logging software with
     
    3233
    3334_Subsurface-mobile_ is an extension of _Subsurface_ which
    34 runs on Android smartphone and tablet devices and is a
     35runs on Android and iOS smartphone and tablet devices and is a
    3536tool for viewing or sharing dive information at dive sites where a larger
    3637computer is not useful. _Subsurface-mobile_ for Android also allows
    3738the gathering of GPS locations where dives are performed
    38 (Subsurface-mobile for iOS currently does not support GPS functionality).
     39(Subsurface-mobile for iOS currently does not have full functionality).
    3940
    4041_Subsurface-mobile_ allows you to enter and save dive information
    41 using a mobile device. Most users of _Subsurface-mobile_ typically use the
    42 mobile app as an extension to the laptop/desktop version of _Subsurface_.
    43 This allows the storage of dive logs on the Internet sharing them
     42using a mobile device. Users of _Subsurface-mobile_ typically use the
     43mobile app as an extension to the laptop/desktop version of _Subsurface_ that
     44allows the storage of dive logs on the Internet and sharing them
    4445between the mobile and the desktop versions. But _Subsurface-mobile_ can
    45 be used independently of _Subsurface_ and does not require the use of
     46also be used independently of _Subsurface_ and does not require the use of
    4647cloud storage.
    4748While the desktop version of _Subsurface_ shows much more detailed information
     
    5758  equipment or notes about a dive.
    5859- Manually create and add new dive records to your dive log.
     60- Download dive data directly from many dive computers.
    5961- Store the updated dive log in the _Subsurface_ cloud storage.
    6062- Record, store and apply GPS positions of dives (Android only).
     
    6365
    6466These items are discussed in greater detail in the following text.
    65 What _Subsurface-mobile_ does not support (at this time) is downloading
    66 dive data directly from a dive computer. That still needs to be done using
    67 _Subsurface_ on a desktop or laptop computer. We are investigating ways
    68 to support downloading from a subset of the supported dive computers on
    69 Android devices, but this is not yet ready for testing.
     67_Subsurface-mobile_ does not yet support download of dive data from all the
     68dive 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
     69dive computers that use a FTDI USB interface or a Bluetooth/BTLE interface
     70are accessible by _Subsurface-mobile_.
    7071
    7172== Installing _Subsurface-mobile_ on your mobile device
     
    8182(see image below on left).
    8283
    83 Select whether _Subsurface-mobile_ should access the Internet for dive log information.
     84Select whether _Subsurface-mobile_ should access the Internet for dive log information as follows:
    8485
    8586=== When NOT Using Cloud Storage
    8687Tap the striked-out cloud icon. The app will not access the _Subsurface_
    8788cloud storage server
    88 to obtain dive log information. This means that dive log information is manually
    89 entered and stored on the mobile device only.
     89to obtain dive log information. This means that dive log information is
     90stored on the mobile device only.
    9091
    9192=== Using Cloud Storage
     
    9495_Subsurface_ desktop application, enter the credentials here.
    9596
    96 You can also create a new account from your mobile device.
     97You can also create a new cloud storage account from your mobile device.
    9798
    9899==== Using the desktop version of _Subsurface_:
     
    136137information is stored on the cloud server and access to the cloud is enabled.
    137138
    138 4) The dive list is initially empty. You can now start entering dives in the dive
    139 log or you can download existing dives from your _Subsurface_ cloud
    140 storage account.
    141 
    142 
    143 == A Few Remarks About The User Interface
     1394) The dive list is initially empty. Start entering dives in the dive
     140log or download dive information from either a _Subsurface_ cloud
     141storage account or from a dive computer.
     142
     143
     144== Menu Structure and User Interface
    144145
    145146At the bottom of many Subsurface-mobile screens is a round button that provides for
     
    169170  the right
    170171
    171 image::mobile-images/menu.jpg["FIGURE: Dive management subpanel",align="center"]
     172image::mobile-images/MainMenu2.jpg["FIGURE: Dive management subpanel",align="center"]
    172173
    173174The images above indicate some of the important features of the menu system.
    174 On the left is the main menu that is activated as described above. In the middle is
    175 the menu that opens if you tap the _GPS_ option on the main menu. On the right is
    176 the menu that opens if you tap the _Manage Dives_ option on the main menu.
     175On the left is the main menu, activated as described above. On the right, above,
     176is a representation of the menu items of all the submenus accessible
     177from the main menu: the main menu items are shown on the left while the submenu contents
     178are shown on a blue background on the right.
    177179
    178180All screenshots in this user manual are currently from the Android
     
    185187dive list. While the dive list is loading from the cloud,
    186188a message appears at the bottom of the screen, indicating that the cloud is
    187 being accessed (see image on left, below). Once the list is loaded you can scroll up and down.
    188 Tapping a dive on the list brings up a display of _Details View_ for that dive (see image on right below).
    189 This includes the dive profile as well as additional information and notes.
     189being accessed. Once the list is loaded you can scroll up and down.
     190Tapping a dive on the list brings up a display of _Details View_ for that dive
     191(see image on right below). This includes the dive profile as well as
     192additional information and notes.
    190193
    191194image::mobile-images/DiveList.jpg["FIGURE: Dive list screen",align="center"]
     
    198201on iOS; tap the GPS icon on the Action Bar.).
    199202
     203[[S_Edit_Dive]]
    200204== Editing dive details
    201205
     
    212216image::mobile-images/EditDive.jpg["FIGURE: Dive edit screen",align="center"]
    213217
     218[[S_Add_Dive]]
    214219== Adding a new dive to the dive list
    215220
     
    244249image::mobile-images/RedDustbin.jpg["FIGURE: delete dive from list",align="center"]
    245250
     251== Download dives from a dive computer
     252
     253Download of dives is possible from dive computers with a FTDI USB interface, or with a Bluetooth interface.
     254
     255First, establish a link between the dive computer and the mobile device.
     256
     257For USB dive computers, USB cables "normally" used
     258for uploading dives to a desktop/laptop computer do NOT work: these cables often have a full-sized male USB plug
     259on one end which plugs into the USB port of a desktop/laptop computer. For downloads to a mobile device
     260one needs a USB OTG (USB On-The-Go) cable. In most cases it is required to plug the USB
     261cable "normally" used with the dive computer into a USB OTG cable which, in turn, plugs into the mini-USB
     262receptacle of the mobile device. The
     263OTG cable often has a full-size female receptacle at one end which accommodates the full-sized male plug
     264of the USB cable "normally" used (see image below). This means that two cables are used to connect the dive computer to the mobile device.
     265
     266image::mobile-images/USB-OTG.jpg["FIGURE: USB-OTG cable",align="center"]
     267
     268For Bluetooth-equipped dive computers, establish a Bluetooth connection between the dive computer and the
     269mobile device. Use the tools on the mobile device to achieve this. For of Android mobile devices,
     270the Settings -> Bluetooth tool is probably appropriate. Ensure pairing of the dive computer and mobile device.
     271_Subsurface-mobile_ performs communication using both Bluetooth and Bluetooth-low-energy (BTLE).
     272The appropriate choice of Bluetooth communication is made by the software and the user need not be concerned with this.
     273
     274With propper communication between dive computer and _Subsurface-mobile_ having been set up, dive download is simple.
     275From the main menu, tap _Manage dives ->  Download from DC_. A screen is shown requiring that the user specify
     276the names of the vendor and model of the dive computer. For instance, when using a Shearwater Petrel 2 dive
     277computer, the vendor is _Shearwater_ and the Dive computer name is _Petrel 2_. From the two dropdown lists
     278at the top of the screen, select the correct vendor and dive computer names (see image on the left, below). If
     279using a dive computer using a Bluetooth connection, then tap the check box labelled _Bluetooth download_.
     280
     281Now tap the button labled _DOWNLOAD_. The downloaded dives appear in the bottom part of the screen, the
     282most recent dive at the top (see image on right, below). Be patient because the download can sometimes take a few mimnutes.
     283Each dive has a check-box on the left hand side, used for selecting which dives need to be added to the
     284_Subsurface-mobile_ dive list: dives that are not checked are ignored. With the appropriate downloaded dives
     285having been checked, tap the button at the bottom left labled _ACCEPT_. All the selected dives appear on
     286the _Subsurface-mobile_ dive list. The downloaded dive information can now be edited as described in the section
     287above xref:S_Edit_Dive[Edit a dive].
     288
     289image::mobile-images/DC-Download.jpg["FIGURE: DC download screen",align="center"]
     290
     291== Viewing the dive location on Google Maps
     292
     293The site of a specific dive can be viewed in two ways using the _Details View_.
     294The Action Bar at the bottom has a GPS pin on the
     295left hand side. Tap that pin and the dive site is shown in Google Maps. Close Google Maps by using the Android _Back_ button.
     296
     297Alternatively, the _Details View_ has a button at the top right hand marked
     298_Map it_. Tap this button to open Google Maps showing the dive site.
     299
     300image::mobile-images/Map.jpg["FIGURE: Map of dive site",align="center"]
     301
    246302== Dive log management
    247303
     
    252308access changes made using the mobile device. This ability is accessed
    253309through the main menu (by dragging the Action Button to the right, or
    254 alternatively tappping the "Hamburger" icon at the bottom left of the screen).
     310alternatively tapping the "Hamburger" icon at the bottom left of the screen).
    255311Tap the option _Manage dives_, enabling a number of options:
    256312
    257313=== Add new dive manually
    258314
    259 This is described above under the section dealing with the dive list.
     315This is described above under the section dealing with xref:S_Add_Dive[Adding a new dive to the dive list].
    260316
    261317=== Sync the dive log with the _Subsurface_ cloud storage
    262318
    263 You can upload the dives contained on the mobile device
    264 to the _Subsurface_ cloud storage by tapping the option _Manual sync with coud_.
     319Upload the dives contained on the mobile device
     320to the _Subsurface_ cloud storage by tapping the option _Manual sync with cloud_.
    265321This synchronizes the local changes to
    266 the dive log with the cloud storage. It also downloads changes made on
    267 another device or computer and stored in cloud storage.
     322the dive log with the cloud storage. It also downloads changes made to
     323the dive log using another device or computer and stored in cloud storage.
    268324
    269325=== Working offline or online
     
    279335=== Changing the login credentials on the _Subsurface_ cloud
    280336
    281 If you need to change your login credentials (for example to work with
    282 multiple accounts) you can
    283 open the main menu and tap _Cloud credentials_. This opens the setup screen
    284 for specifying new credentials.
    285 
     337The login credentials (for example to work with
     338multiple accounts) can be changed by opening
     339the main menu and by tapping _Settings -> Cloud credentials_. This opens
     340the screen for specifying new credentials.
     341
     342=== Changing the colour scheme of _Subsurface-mobile_
     343
     344_Subsurface-mobile_ has three colour schemes to please users with different
     345tastes. This user manual shows the default colour scheme, comprising blue
     346colours. Change to a pink or a dark colour scheme by opening the main menu and
     347tap Settings -> Preferences. This opens the Preferences screen that includes
     348the three colour schemes (see image below).
     349
     350image::mobile-images/ColourSchemes.jpg["FIGURE: Colour scheme setup screen",align="center"]
    286351
    287352== Recording dive locations using GPS (Android only).
     
    296361
    297362Open the main menu and tap _GPS  ->  Preferences_. Now specify the way
    298 in which GPS data need to be automatically collected (image on right,
    299 below). You can specify that data are collected at regular intervals, e.g.
    300 every 10 minutes, or at regular
     363in which GPS data need to be automatically collected (image above). Data
     364are collected at regular intervals, e.g. every 5 minutes, or at regular
    301365distances, e.g. after the boat has moved more than 200m, or a combination of
    302 both of the above approaches. Provide the appropriate information and
     366both of these approaches. Provide the appropriate information and
    303367tap the _Save_ action button. The program is now ready to collect GPS positions.
    304368
    305 image::mobile-images/gpssetup.jpg["FIGURE: GPS setup screen",align="center"]
    306 
    307369=== Collecting GPS positions
    308370
     371image::mobile-images/Mainmenu.jpg["FIGURE: Main menu",align="center"]
     372
    309373Ensure that the GPS on the Android device has been activated. At the bottom
    310 of the GPS submenu is a check box _Run location service_ (image on left, above).
     374of the GPS submenu is a check box _Run location service_ (image above).
    311375Check this box
    312376and _Subsurface-mobile_ starts to collect GPS locations automatically,
     
    317381=== Storing the GPS data on the _Subsurface_ cloud
    318382
    319 Activate the main menu and select the _GPS_ option that brings up the submenu of GPS-related actions
    320 (image on left, above). Tap _Upload GPS data_ that saves the GPS data
     383Activate the main menu and select the _GPS_ option that brings up the submenu
     384of GPS-related actions. Tap _Upload GPS data_ that saves the GPS data
    321385on the _Subsurface_ cloud server. These GPS data are saved *separately*
    322386from the other dive log data. All collected GPS data are kept on the
     
    331395=== Viewing GPS data
    332396
    333 From the GPS submenu (image on left, above) select _Show GPS fixes_. This brings
     397From the GPS submenu select _Show GPS fixes_. This brings
    334398up a list of GPS positions obtained using the location service (image
    335399on left, below). Two actions are possible for each of the locations, enabled if
Note: See TracChangeset for help on using the changeset viewer.