7 Autor documentation: Jacco van Koll <jko@haringstad.com>
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.
13 Audience: Fun Divers, Tec Divers, Professional Divers
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.
24 In this manual the Suunto Viper will be used for all examples.
29 Before you are able to import information from your divecomputer into
30 Subsurface, you need some preparation. Do you have the following:
32 1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A)
33 2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook
34 3. Working installation of Subsurface
35 4. If needed, the manual of your divecomputer
38 3. Start using the program:
40 When you start the program for the first time, it shows no information
41 at all. This is because the program does not automatically load the
42 already available dive-log files.
44 There is a menu, containing 'File', 'Log', 'Filter' and Help.
46 The screen is devided in 3 area's:
48 Area with 3 tabs: Dive Notes, Equipment, Info & Stats
49 Area next to the 3 tabs, which will contain the dive profile
50 Area with the dives (usually called dive list), which can be sorted by number, date, etc.
55 Before you start fiddeling around with your divecomputer, note that
56 there are divecomputers that consume more power when they are in the
57 PC-Communication mode. This could drain your battery. Therefor, ensure
58 if your computer is recharging when connecting to the USB port. The
59 Suunto Viper does not recharge trough the USB connection. Please
60 consult the manual of your divecomputer if you are unsure if it will
61 be recharged when connected to the USB port.
63 Now it is time to hook up your divecomputer to your Linux system:
65 Connect your interface cable to your divecomputer
66 Connect your interface cable to a free USB port
67 Put your divecomputer into PC Communication mode. (For Suunto Viper, press Mode - 1 Memory - 3 TR-PC)
68 (You should consult the manual of your specific divecomputer for your brand and type)
69 Go in Subsurface to 'File - Import'
70 Within the popup, under Dive computer, choose your brand and type. Here we choose Suunto Vyper.
71 Change the devicename under which your interface is connected. Default is /dev/ttyUSB0
72 Click the 'OK' button.
74 Now watch how your data is retrieved from your divecomputer!
75 Depending on your type of computer and/or number of dives, this
76 could take some time. Please be patient.
79 5. Viewing and completing your logs
81 When all data from your divecomputer is transferred, you will see a
82 listing of your dives in Area 3.
86 On Sunday Oct 23, 2011 you made a dive.
87 In the log line of this dive, you see the following information:
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)
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
106 6. Edit the dive info
108 When you double click on the dive log line, the editor window
109 opens. Now you can add information that is missing. Let start with
110 completing the example:
112 You double clicked on dive #12, as described in 5. Viewing and
113 completing your logs. The Dive Info window pops up and you will see
116 Location: An input where you can enter your new location, or you can choose with the pull-down previous locations
117 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
118 Buddy: An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name
119 Rating: A pull-down where you can rate your dive.
120 Notes: A free input where you can enter information about your dive. What you've seen, etc.
122 In this example we use the following information:
124 Location: Oostvoornse Meer
125 Dive Master: S. de Vries
128 Notes: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive.
129 Made movie with 'headcam'.
131 Now don't press ok yet!
134 7. Edit equipment info
136 You also want to edit your Cylinder information. And in the previous
137 chapter, this was not edited. There is still another item to edit in
138 the Dive Info screen:
140 Cylinder: A double-click fieldset. Here you can edit your Cylinder information
142 So, when you double click on the cylinder info, you get another
143 popup. This popup gives you the following:
145 Cylinder: Pull-down where you can choose your Cylinder, or add your own
146 Size: The volume if not 'filled'
147 Pressure: The maximum pressure of this Cylinder
149 Start Pressure: What was the pressure starting the dive
150 End Pressure: What was the pressure ending the dive
151 Nitrox: What was the percentage of blend
153 Now we are going to enter the data:
159 Now tick the option for Start & End pressure
165 Now your dive information for this dive is complete. You can now press
166 ok in the Dive Info screen and view the results.
169 8. Adding equipment info
171 In Area with the 3 tabs there is the tab Equipment. With this tab, you
172 can add Cylinders. We are going to add an additional Cylinder:
174 In the main screen, click on the Equipment tab. This shows your Cylinder you added in 7.
175 Now press the Add button and the Cylinder popup comes back.
176 Just like you added your Cylinder information in 7. Edit equipment info, you add your cylinder
177 information for the second Cylinder. Fill in all the information about this Cylinder and press OK.
182 After adding all the information, you can use the tab Info &
183 Stats. This tab will provide you with all the (statistical and
184 calculated) information regarding your dive.
186 The information contains:
190 Date: Date and time of your dive
191 Dive Time: Duration of your dive
192 Surf Intv: Interval between previous dive and this dive
193 Max Depth: Maximum depth of this dive
194 Avg Depth: The average depth of this dive
195 Water Temp: Lowest temperature of the water
196 SAC: The amount of Surface Air Consumption liters per minute
197 OTU: The Oxygen Toxicity Units of this dive
198 O2/He: Amount of Oxygen/Helium
199 Gas Used: The total volume of gas used during this dive
203 Total time: Total time of all your dives together, calculated
204 Avg Time: The average divetime of your dives, calculated
205 Max Depth: The maximum depth of all your dives
206 Avg Depth: The average depth of all your dives, calculated
207 Max SAC: Highest of Surface Air Consumption of all your dives
208 Min SAC: Lowest of Surface Air Consumption of all your dives
209 Avg SAC: Average Surface Air Consuption of all your dives, calculated
212 10. Setting up preferences
214 Subsurface has the ability to modify the preferences you want. By
215 using menu 'File - Preferences' you will be presented a popup with the
216 'Units'. You are free to choose what is your preference, with other
217 words, use Metric or Imperial.
219 You can set the following options:
220 Depth: Your diving depth in Meters or Feet
221 Pressure: The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch)
222 Volume: The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure)
223 Temperature: The temperature of the water in Celcius or Fahrenheit
225 In the main screen, you did see in Area 3, some information. In the
226 Columns options, you can enable/disable options you would like to show
228 Show Temp: Shows the temperature of your dive
229 Show Cyl: Shows the cylinder(s) of your dive
230 Show O2%: Shows the O2% of your dive
231 Show SAC: Shows the SAC of your dive (Surface Air Consumption)
232 Show OTU: Shows the OTU of your dive (Oxygen Toxicity Units)
234 And, you can change the font usage of the program.
236 I will give an example here:
238 I am a diver in The Netherlands, using the Metric System. Therefor, I
239 go to the menu File, choose Preferences here. In the Units section, I
247 I would like to see the:
253 As a beginning diver, I don't need to track my OTUs. So I leave this
256 Clicking OK on the dialog stores these settings.
259 11. How to find the Device Name
261 When you connect your divecomputer by using an USB connector, most of the
262 time, the default of ´/dev/ttyUSB0' should work. But if you have other
263 Serial to USB devices, this can be different because '/dev/ttyUSB0' is
266 One of the ways to find out what your dive name is:
268 Disconnect your usb cable of your dive computer
270 Type the command: 'dmesg' and press enter
271 Plug in your usb cable of your divecomputer
272 Type the command: 'dmesg' and press enter
274 Within your terminal you should see a message similair to this one:
276 usb 2-1.1: new full speed USB device number 14 using ehci_hcd
277 usbcore: registered new interface driver usbserial
278 USB Serial support registered for generic
279 usbcore: registered new interface driver usbserial_generic
280 usbserial: USB Serial Driver core
281 USB Serial support registered for FTDI USB Serial Device
282 ftdi_sio 2-1.1:1.0: FTDI USB Serial Device converter detected
283 usb 2-1.1: Detected FT232BM
284 usb 2-1.1: Number of endpoints 2
285 usb 2-1.1: Endpoint 1 MaxPacketSize 64
286 usb 2-1.1: Endpoint 2 MaxPacketSize 64
287 usb 2-1.1: Setting MaxPacketSize 64
288 usb 2-1.1: FTDI USB Serial Device converter now attached to ttyUSB3
289 usbcore: registered new interface driver ftdi_sio
290 ftdi_sio: v1.6.0:USB FTDI Serial Converters Driver
292 You see that in the third line from the bottom, the usb adapter is
293 detected and is connected to 'ttyUSB3'. Now you use this information in
294 the import settings as '/dev/ttyUSB3'. Your divecomputer interface is
295 connected and you should be able to import your dives.
297 interface cable to this serial port,
301 The use of libdivecomputer provides the support for divecomputers. Within
302 the list of computers in the 'File - import' menu, you will see a listing
303 of divecomputers. This list is covering a compatible set. Please check
304 your users manual to check if your computer will be supported.
306 Supported divecomputers:
339 * OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported.