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 opens. Now you
 108 can add information that is missing. Let start with completing the example:
 109
 110 You double clicked on dive #12, as described in 5. Viewing and completing your logs.
 111 The Dive Info window pops up and you will see the following:
 112
 113     Location:    An input where you can enter your new location, or you can choose with the pull-down previous locations
 114     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
 115     Buddy:       An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name
 116     Rating:      A pull-down where you can rate your dive.
 117     Notes:       A free input where you can enter information about your dive. What you've seen, etc.
 118
 119 In this example we use the following information:
 120
 121     Location:           Oostvoornse Meer
 122     Dive Master:        S. de Vries
 123     Buddy:              S. de Vries
 124     Rating:             3 stars
 125     Notes:              First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive.
 126                         Made movie with 'headcam'.
 127
 128 Now don't press ok yet!
 129
 130
 131 7. Edit equipment info
 132
 133 You also want to edit your Cylinder information. And in the previous chapter, this was not edited. There is
 134 still another item to edit in the Dive Info screen:
 135
 136     Cylinder:    A double-click fieldset. Here you can edit your Cylinder information
 137
 138 So, when you double click on the cylinder info, you get another popup. This popup gives you the following:
 139
 140     Cylinder:   Pull-down where you can choose your Cylinder, or add your own
 141     Size:       The volume if not 'filled'
 142     Pressure:   The maximum pressure of this Cylinder
 143     Optional:
 144                 Start Pressure: What was the pressure starting the dive
 145                 End Pressure:   What was the pressure ending the dive
 146                 Nitrox:         What was the percentage of blend
 147
 148 Now we are going to enter the data:
 149
 150     Cylinder:   15.0 l
 151     Size:       15.0
 152     Pressure:   220
 153
 154     Now tick the option for Start & End pressure
 155
 156     Start Pressure:     180
 157     End Pressure:       60
 158     Press Ok
 159
 160 Now your dive information for this dive is complete. You can now press ok in the Dive Info screen and view the results.
 161
 162 8. Adding equipment info
 163
 164 In Area with the 3 tabs there is the tab Equipment. With this tab, you can add Cylinders.
 165 We are going to add an additional Cylinder:
 166
 167         In the main screen, click on the Equipment tab. This shows your Cylinder you added in 7.
 168         Now press the Add button and the Cylinder popup comes back.
 169         Just like you added your Cylinder information in 7. Edit equipment info, you add your cylinder
 170         information for the second Cylinder. Fill in all the information about this Cylinder and press OK.
 171
 172 9. View info & Stats
 173
 174 After adding all the information, you can use the tab Info & Stats. This tab will provide
 175 you with all the (statistical and calculated) information regarding your dive.
 176
 177 The information contains:
 178
 179    Dive Info:
 180
 181         Date:           Date and time of your dive
 182         Dive Time:      Duration of your dive
 183         Surf Intv:      Interval between previous dive and this dive
 184         Max Depth:      Maximum depth of this dive
 185         Avg Depth:      The average depth of this dive
 186         Water Temp:     Lowest temperature of the water
 187         SAC:            The amount of Surface Air Consumption liters per minute
 188         OTU:            The Oxygen Toxicity Units of this dive
 189         O2/He:          Amount of Oxygen/Helium
 190         Gas Used:       The total volume of gas used during this dive
 191
 192    Statistics:
 193
 194         Total time:     Total time of all your dives together, calculated
 195         Avg Time:       The average divetime of your dives, calculated
 196         Max Depth:      The maximum depth of all your dives
 197         Avg Depth:      The average depth of all your dives, calculated
 198         Max SAC:        Highest of Surface Air Consumption of all your dives
 199         Min SAC:        Lowest of Surface Air Consumption of all your dives
 200         Avg SAC:        Average Surface Air Consuption of all your dives, calculated
 201
 202 10. Setting up preferences
 203
 204 Subsurface has the ability to modify the preferences you want. By
 205 using menu 'File - Preferences' you will be presented a popup with the
 206 'Units'. You are free to choose what is your preference, with other
 207 words, use Metric or Imperial.
 208
 209 You can set the following options:
 210         Depth:          Your diving depth in Meters or Feet
 211         Pressure:       The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
 212         Volume:         The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
 213         Temperature:    The temperature of the water in Celcius or Fahrenheit
 214
 215 In the main screen, you did see in Area 3, some information. In the Columns options, you can enable/disable options you  would like to show there:
 216         Show Temp:      Shows the temperature of your dive
 217         Show Cyl:       Shows the cylinder(s) of your dive
 218         Show O2%:       Shows the O2% of your dive
 219         Show SAC:       Shows the SAC of your dive (Surface Air Consumption)
 220         Show OTU:       Shows the OTU of your dive (Oxygen Toxicity Units)
 221
 222 And, you can change the font usage of the program.
 223
 224 I will give an example here:
 225
 226 I am a diver in The Netherlands, using the Metric System. Therefor, I
 227 go to the menu File, choose Preferences here. In the Units section, I
 228 use the folowing:
 229
 230         Depth:          Meter
 231         Pressure:       Bar
 232         Volume:         Liter
 233         Temperature:    Celcius
 234
 235 I would like to see the:
 236                         Temperature
 237                         Show Cyl
 238                         Show O2%
 239                         Show SAC
 240
 241 As a beginning diver, I don't need to track my OTUs. So I leave this
 242 one not enabled.
 243
 244 Clicking OK on the dialog stores these settings.