Documentation/user-manual.txt

   1 Subsurface 1.2
   2
   3 User Manual
   4
   5 Version 0.0.3
   6
   7 Autor documentation: Jacco van Koll <jko@haringstad.com>
   8
   9 Scope of this document is the usage of the program.
  10 Please read the build manual for instructions how to build the
  11 software and (if needed) it´s dependencies.
  12
  13 Audience: Fun Divers, Tec Divers, Professional Divers
  14
  15
  16 1. Introduction:
  17
  18 Subsurface was started because of a lack of viable dive log software
  19 on Linux. It turns out that the resulting software was easily ported
  20 to Windows and Mac, but it clearly is a native Linux program first.
  21 Right now, the program is under development and from version 1.1 it is
  22 already very usable for divers with supported dive-computers.
  23
  24 In this manual the Suunto Viper will be used for all examples.
  25
  26 2. Requirements
  27
  28 Before you are able to import information from your divecomputer into
  29 Subsurface, you need some preparation. Do you have the following:
  30
  31         1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A)
  32         2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook
  33         3. Working installation of Subsurface
  34         4. If needed, the manual of your divecomputer
  35
  36
  37 3. Start using the program:
  38
  39 When you start the program for the first time, it shows no information
  40 at all. This is because the program does not automatically load the
  41 already available dive-log files.
  42
  43 There is a menu, containing 'File', 'Log', 'Filter' and Help.
  44
  45 The screen is devided in 3 area's:
  46
  47         Area with 3 tabs: Dive Notes, Equipment, Info & Stats
  48         Area next to the 3 tabs, which will contain the dive profile
  49         Area with the dives (usually called dive list), which can be sorted by number, date, etc.
  50
  51
  52 4. Import new dives
  53
  54 Before you start fiddeling around with your divecomputer, note that
  55 there are divecomputers that consume more power when they are in the
  56 PC-Communication mode. This could drain your battery. Therefor, ensure
  57 if your computer is recharging when connecting to the USB port. The
  58 Suunto Viper does not recharge trough the USB connection. Please
  59 consult the manual of your divecomputer if you are unsure if it will
  60 be recharged when connected to the USB port.
  61
  62 Now it is time to hook up your divecomputer to your Linux system:
  63
  64     Connect your interface cable to your divecomputer
  65     Connect your interface cable to a free USB port
  66     Put your divecomputer into PC Communication mode. (For Suunto Viper, press Mode - 1 Memory - 3 TR-PC)
  67         (You should consult the manual of your specific divecomputer for your brand and type)
  68     Go in Subsurface to 'File - Import'
  69         Within the popup, under Dive computer, choose your brand and type. Here we choose Suunto Vyper.
  70         Change the devicename under which your interface is connected. Default is /dev/ttyUSB0
  71         Click the 'OK' button.
  72
  73     Now watch how your data is retrieved from your divecomputer!
  74     Depending on your type of computer and/or number of dives, this
  75     could take some time. Please be patient.
  76
  77
  78 5. Viewing and completing your logs
  79
  80 When all data from your divecomputer is transferred, you will see a
  81 listing of your dives in Area 3.
  82
  83 An example:
  84
  85 On Sunday Oct 23, 2011 you made a dive.
  86 In the log line of this dive, you see the following information:
  87
  88     #:          12                              Dive number
  89     Date:       Sun, Oct 23, 2011 10:50         Date and time of your dive
  90     *:                                          Your rating (none at this time)
  91     m:          12.8                            Your maximum depth in meters
  92     min:        31:20                           Your dive-time in minutes and seconds
  93     Deg. C:     13.0                            Lowest water temperature during your dive
  94     Cyl:                                        Your used cylinder (none at this time)
  95     O2%:        air                             What type of mixture
  96     SAC:                                        SAC (none at this time)
  97     Location:                                   Where you performed your dive (empty)
  98
  99     As you can see, some information is already there because it is
 100     retrieved from your divecomputer. Some information is waiting for
 101     you to be added. By double clicking on this dive, you can view and
 102     complete the log.
 103
 104
 105 6. Edit the dive info
 106
 107 When you double click on the dive log line, the editor window
 108 opens. Now you can add information that is missing. Let start with
 109 completing the example:
 110
 111 You double clicked on dive #12, as described in 5. Viewing and
 112 completing your logs.  The Dive Info window pops up and you will see
 113 the following:
 114
 115     Location:    An input where you can enter your new location, or you can choose with the pull-down previous locations
 116     Dive Master: An input where you can enter the name of your Dive Master, or you can choose with the pull-down a previous name
 117     Buddy:       An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name
 118     Rating:      A pull-down where you can rate your dive.
 119     Notes:       A free input where you can enter information about your dive. What you've seen, etc.
 120
 121 In this example we use the following information:
 122
 123     Location:           Oostvoornse Meer
 124     Dive Master:        S. de Vries
 125     Buddy:              S. de Vries
 126     Rating:             3 stars
 127     Notes:              First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive.
 128                         Made movie with 'headcam'.
 129
 130 Now don't press ok yet!
 131
 132
 133 7. Edit equipment info
 134
 135 You also want to edit your Cylinder information. And in the previous
 136 chapter, this was not edited. There is still another item to edit in
 137 the Dive Info screen:
 138
 139     Cylinder:    A double-click fieldset. Here you can edit your Cylinder information
 140
 141 So, when you double click on the cylinder info, you get another
 142 popup. This popup gives you the following:
 143
 144     Cylinder:   Pull-down where you can choose your Cylinder, or add your own
 145     Size:       The volume if not 'filled'
 146     Pressure:   The maximum pressure of this Cylinder
 147     Optional:
 148                 Start Pressure: What was the pressure starting the dive
 149                 End Pressure:   What was the pressure ending the dive
 150                 Nitrox:         What was the percentage of blend
 151
 152 Now we are going to enter the data:
 153
 154     Cylinder:   15.0 l
 155     Size:       15.0
 156     Pressure:   220
 157
 158     Now tick the option for Start & End pressure
 159
 160     Start Pressure:     180
 161     End Pressure:       60
 162     Press Ok
 163
 164 Now your dive information for this dive is complete. You can now press
 165 ok in the Dive Info screen and view the results.
 166
 167 8. Adding equipment info
 168
 169 In Area with the 3 tabs there is the tab Equipment. With this tab, you
 170 can add Cylinders.  We are going to add an additional Cylinder:
 171
 172         In the main screen, click on the Equipment tab. This shows your Cylinder you added in 7.
 173         Now press the Add button and the Cylinder popup comes back.
 174         Just like you added your Cylinder information in 7. Edit equipment info, you add your cylinder
 175         information for the second Cylinder. Fill in all the information about this Cylinder and press OK.
 176
 177 9. View info & Stats
 178
 179 After adding all the information, you can use the tab Info &
 180 Stats. This tab will provide you with all the (statistical and
 181 calculated) information regarding your dive.
 182
 183 The information contains:
 184
 185    Dive Info:
 186
 187         Date:           Date and time of your dive
 188         Dive Time:      Duration of your dive
 189         Surf Intv:      Interval between previous dive and this dive
 190         Max Depth:      Maximum depth of this dive
 191         Avg Depth:      The average depth of this dive
 192         Water Temp:     Lowest temperature of the water
 193         SAC:            The amount of Surface Air Consumption liters per minute
 194         OTU:            The Oxygen Toxicity Units of this dive
 195         O2/He:          Amount of Oxygen/Helium
 196         Gas Used:       The total volume of gas used during this dive
 197
 198    Statistics:
 199
 200         Total time:     Total time of all your dives together, calculated
 201         Avg Time:       The average divetime of your dives, calculated
 202         Max Depth:      The maximum depth of all your dives
 203         Avg Depth:      The average depth of all your dives, calculated
 204         Max SAC:        Highest of Surface Air Consumption of all your dives
 205         Min SAC:        Lowest of Surface Air Consumption of all your dives
 206         Avg SAC:        Average Surface Air Consuption of all your dives, calculated
 207
 208 10. Setting up preferences
 209
 210 Subsurface has the ability to modify the preferences you want. By
 211 using menu 'File - Preferences' you will be presented a popup with the
 212 'Units'. You are free to choose what is your preference, with other
 213 words, use Metric or Imperial.
 214
 215 You can set the following options:
 216         Depth:          Your diving depth in Meters or Feet
 217         Pressure:       The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
 218         Volume:         The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
 219         Temperature:    The temperature of the water in Celcius or Fahrenheit
 220
 221 In the main screen, you did see in Area 3, some information. In the
 222 Columns options, you can enable/disable options you would like to show
 223 there:
 224         Show Temp:      Shows the temperature of your dive
 225         Show Cyl:       Shows the cylinder(s) of your dive
 226         Show O2%:       Shows the O2% of your dive
 227         Show SAC:       Shows the SAC of your dive (Surface Air Consumption)
 228         Show OTU:       Shows the OTU of your dive (Oxygen Toxicity Units)
 229
 230 And, you can change the font usage of the program.
 231
 232 I will give an example here:
 233
 234 I am a diver in The Netherlands, using the Metric System. Therefor, I
 235 go to the menu File, choose Preferences here. In the Units section, I
 236 use the folowing:
 237
 238         Depth:          Meter
 239         Pressure:       Bar
 240         Volume:         Liter
 241         Temperature:    Celcius
 242
 243 I would like to see the:
 244                         Temperature
 245                         Show Cyl
 246                         Show O2%
 247                         Show SAC
 248
 249 As a beginning diver, I don't need to track my OTUs. So I leave this
 250 one not enabled.
 251
 252 Clicking OK on the dialog stores these settings.