Documentation/user-manual.txt

   1 Subsurface 1.2
   2
   3 User Manual
   4
   5 Version 0.0.2
   6
   7 Autor documentation: Jacco van Koll
   8
   9
  10 Scope of this document is the usage of the program.
  11 Please read the build manual for instructions how to build the
  12 software and (if needed) it´s dependencies.
  13
  14
  15 Audience: Fun Divers, Tec Divers, Professional Divers
  16
  17
  18 1. Introduction:
  19
  20 Subsurface was started because of a lack of viable dive log software
  21 on Linux. It turns out that the resulting software was easily ported
  22 to Windows and Mac, but it clearly is a native Linux program first.
  23 Right now, the program is under development and from version 1.1 it is
  24 already very usable for divers with supported dive-computers.
  25
  26 In this manual the Suunto Viper will be used for all examples.
  27
  28 2. Requirements
  29
  30 Before you are able to import information from your divecomputer into
  31 Subsurface, you need some preparation. Do you have the following:
  32
  33         1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A)
  34         2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook
  35         3. Working installation of Subsurface
  36         4. If needed, the manual of your divecomputer
  37
  38
  39 3. Start using the program:
  40
  41 When you start the program for the first time, it shows no information
  42 at all. This is because the program does not automatically load the
  43 already available dive-log files.
  44
  45 There is a menu, containing 'File', 'Log', 'Filter' and Help.
  46
  47 The screen is devided in 3 area's:
  48
  49         Area with 3 tabs: Dive Notes, Equipment, Info & Stats
  50         Area next to the 3 tabs, which will contain the dive profile
  51         Area with the dives (usually called dive list), which can be sorted by number, date, etc.
  52
  53
  54 4. Import new dives
  55
  56 Before you start fiddeling around with your divecomputer, note that
  57 there are divecomputers that consume more power when they are in the
  58 PC-Communication mode. This could drain your battery. Therefor, ensure
  59 if your computer is recharging when connecting to the USB port. The
  60 Suunto Viper does not recharge trough the USB connection. Please
  61 consult the manual of your divecomputer if you are unsure if it will
  62 be recharged when connected to the USB port.
  63
  64 Now it is time to hook up your divecomputer to your Linux system:
  65
  66     Connect your interface cable to your divecomputer
  67     Connect your interface cable to a free USB port
  68     Put your divecomputer into PC Communication mode. (For Suunto Viper, press Mode - 1 Memory - 3 TR-PC)
  69         (You should consult the manual of your specific divecomputer for your brand and type)
  70     Go in Subsurface to 'File - Import'
  71         Within the popup, under Dive computer, choose your brand and type. Here we choose Suunto Vyper.
  72         Change the devicename under which your interface is connected. Default is /dev/ttyUSB0
  73         Click the 'OK' button.
  74
  75     Now watch how your data is retrieved from your divecomputer!
  76     Depending on your type of computer and/or number of dives, this
  77     could take some time. Please be patient.
  78
  79
  80 5. Viewing and completing your logs
  81
  82 When all data from your divecomputer is transferred, you will see a
  83 listing of your dives in Area 3.
  84
  85 An example:
  86
  87 On Sunday Oct 23, 2011 you made a dive. In the log line of this dive, you see the following information:
  88
  89     #:          12                              Dive number
  90     Date:       Sun, Oct 23, 2011 10:50         Date and time of your dive
  91     *:                                          Your rating (none at this time)
  92     m:          12.8                            Your maximum depth in meters
  93     min:        31:20                           Your dive-time in minutes and seconds
  94     Deg. C:     13.0                            Lowest water temperature during your dive
  95     Cyl:                                        Your used cylinder (none at this time)
  96     O2%:        air                             What type of mixture
  97     SAC:                                        SAC (none at this time)
  98     Location:                                   Where you performed your dive (empty)
  99
 100     As you can see, some information is already there because it is
 101     retrieved from your divecomputer. Some information is waiting for
 102     you to be added. By double clicking on this dive, you can view and
 103     complete the log.
 104
 105
 106 6. Edit the dive info
 107
 108
 109
 110 7. Edit equipment info
 111
 112
 113 8. Setting up preferences
 114
 115 Subsurface has the ability to modify the preferences you want. By
 116 using menu 'File - Preferences' you will be presented a popup with the
 117 'Units'. You are free to choose what is your preference, with other
 118 words, use Metric or Imperial.
 119
 120 You can set the following options:
 121         Depth:          Your diving depth in Meters or Feet
 122         Pressure:       The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
 123         Volume:         The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
 124         Temperature:    The temperature of the water in Celcius or Fahrenheit
 125
 126 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:
 127         Show Temp:      Shows the temperature of your dive
 128         Show Cyl:       Shows the cylinder(s) of your dive
 129         Show O2%:       Shows the 02% of your dive
 130         Show SAC:       Shows the SAC of your dive (Surface Air Consumption)
 131         Show OTU:       Shows the OTU of your dive (Oxygen Toxicity Units)
 132
 133 And, you can change the font usage of the program.
 134
 135 I will give an example here:
 136
 137 I am a diver in The Netherlands, using the Metric System. Therefor, I
 138 go to the menu File, choose Preferences here. In the Units section, I
 139 use the folowing:
 140
 141         Depth:          Meter
 142         Pressure:       Bar
 143         Volume:         Liter
 144         Temperature:    Celcius
 145
 146 I would like to see the:
 147                         Temperature
 148                         Show Cyl
 149                         Show O2%
 150                         Show SAC
 151
 152 As a beginning diver, I don't need to track my OTUs. So I leave this
 153 one not enabled.
 154
 155 Clicking OK on the dialog stores these settings.