Subsurface 1.2 User Manual
==========================
-Jacco van Koll <jko@haringstad.com>
-:Author Initials: JvK
+Jacco van_Koll <jko@haringstad.com>
+v0.0.7, January 2012
+:Author Initials: JKO
:toc:
:icons:
:numbered:
:website: http://subsurface.hohndel.org
-Version 0.0.7
-
-Autor documentation: Jacco van Koll <jko@haringstad.com>
-
Scope of this document is the usage of the program.
Please read the build manual for instructions how to build the
software and (if needed) its dependencies.
Audience: Fun Divers, Tec Divers, Professional Divers
-Introduction
-------------
+[[S_Introduction]]
+Introduction:
+-------------
Subsurface was started because of a lack of viable dive log software
on Linux. It turns out that the resulting software was easily ported
In this manual the Suunto Viper will be used for all examples.
+[[S_Requirements]]
Requirements
------------
Before you are able to import information from your divecomputer into
Subsurface, you need some preparation. Do you have the following:
- 1. Your Divecomputer - Compatible with libdivecomputer (see list in Appendix A)
+ 1. Your Divecomputer - Compatible with libdivecomputer (see list in <<AppendixA,Appendix A>>)
2. Communication interface - Cable to connect your divecomputer to your PC/Laptop/Netbook
3. Working installation of Subsurface
4. If needed, the manual of your divecomputer
+[[S_StartUsing]]
Start using the program
-----------------------
- Area with the dives (usually called dive list) which can be sorted by number, date, etc.
+[[S_ImportNewDives]]
Import new dives from your divecomputer
---------------------------------------
could take some time. Please be patient.
+[[S_ViewingLogs]]
Viewing and completing your logs
--------------------------------
On Sunday Oct 23, 2011 you made a dive.
In the log line of this dive, you see the following information:
-
- #::
- 12 Dive number
- Date::
- Sun, Oct 23, 2011 10:50 Date and time of your dive
- *::
- Your rating (none at this time)
- m::
- 12.8 Your maximum depth in meters
- min::
- 31:20 Your dive-time in minutes and seconds
- Deg. C::
- 13.0 Lowest water temperature during your dive
- Cyl::
- Your used cylinder (none at this time)
- O2%::
- air What type of mixture
- SAC::
- SAC (none at this time)
- Location::
- Where you performed your dive (empty)
+[width="70%",cols="<5%,10%,<20%,<65%",grid="none",frame="none",style="monospaced"]
+|===============================================================================
+|| # | 12 | Dive number
+|| Date | Sun, Oct 23, 2011 10:50 | Date and time of your dive
+|| * | | Your rating (none at this time)
+|| m | 12.8 | Your maximum depth in meters
+|| min | 31:20 | Your dive-time in minutes and seconds
+|| Deg. C | 13.0 | Lowest water temperature during your dive
+|| Cyl | | Your used cylinder (none at this time)
+|| O2% | air | What type of mixture
+|| SAC | | SAC (none at this time)
+|| Location | | Where you performed your dive (empty)
+|===============================================================================
As you can see, some information is already there because it is
retrieved from your divecomputer. Some information is waiting for
complete the log.
+[[S_EditDiveInfo]]
Edit the dive info
------------------
opens. Now you can add information that is missing. Let start with
completing the example:
-You double clicked on dive #12, as described in 5. Viewing and
-completing your logs. The Dive Info window pops up and you will see
+You double clicked on dive #12, as described in <<S_ViewingLogs,Viewing and
+completing your logs>>. The Dive Info window pops up and you will see
the following:
-
- - Location: An input where you can enter your new location, or you can choose with the pull-down previous locations
- - 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
- - Buddy: An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name
- - Rating: A pull-down where you can rate your dive.
- - Notes: A free input where you can enter information about your dive. What you've seen, etc.
+[horizontal]
+ *Location*:: An input where you can enter your new location, or you can choose with the pull-down previous locations
+ *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
+ *Buddy*:: An input where you can enter het name of you Buddy, or you can choose with the pull-down a previous name
+ *Rating*:: A pull-down where you can rate your dive.
+ *Notes*:: A free input where you can enter information about your dive. What you've seen, etc.
In this example we use the following information:
-
- - Location: Oostvoornse Meer
- - Dive Master: S. de Vries
- - Buddy: S. de Vries
- - Rating: 3 stars
- - Notes: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive.
- Made movie with 'headcam'.
+[horizontal]
+ *Location*:: Oostvoornse Meer
+ *Dive Master*:: S. de Vries
+ *Buddy*:: S. de Vries
+ *Rating*:: 3 stars
+ *Notes*:: First dive here. Good visibility. Did see the concrete poles, some crab and fish. Very nice and easy dive. +
+ Made movie with headcam.
Now don't press ok yet!
-
+[[S_EditEquipmentInfo]]
Edit equipment info
-------------------
-You also want to edit your Cylinder information. And in the previous
-chapter, this was not edited. There is still another item to edit in
-the Dive Info screen:
+You also want to edit your Cylinder information. And in the
+<<S_EditDiveInfo, previous chapter>>, this was not edited. There is
+still another item to edit in the Dive Info screen:
- Cylinder: A double-click fieldset. Here you can edit your Cylinder information
popup. This popup gives you the following:
- Cylinder: Pull-down where you can choose your Cylinder, or add your own
- - Size: The volume if not 'filled'
+ - Size: The volume if not `filled'
- Pressure: The maximum pressure of this Cylinder
- Optional:
* Start Pressure: What was the pressure starting the dive
Now your dive information for this dive is complete. You can now press
ok in the Dive Info screen and view the results.
-
+[[S_AddingEquipment]]
Adding equipment info
---------------------
info, you add your cylinder information for the second Cylinder.
Fill in all the information about this Cylinder and press OK.
-
+[[S_ViewInfoStats]]
View info & Stats
-----------------
** Min SAC: Lowest of Surface Air Consumption of all your dives
** Avg SAC: Average Surface Air Consuption of all your dives, calculated
-
+[[S_SettingUpPreferences]]
Setting up preferences
----------------------
I am a diver in The Netherlands, using the Metric System. Therefor, I
go to the menu File, choose Preferences here. In the Units section, I
-use the folowing:
+use the following:
- Depth: Meter
- Pressure: Bar
Clicking OK on the dialog stores these settings.
-
+[[S_HowFindDeviceName]]
How to find the Device Name
---------------------------
the import settings as '/dev/ttyUSB3'. Your divecomputer interface is
connected and you should be able to import your dives.
-
+[[S_ImportingDivesJDivelog]]
Importing dives from JDivelog
-----------------------------
this program. You don't have to type all information by hand into
Subsurface, because you can import your divelogs from JDivelog.
-JDivelog stores its information into files with the extention of .jlb.
+JDivelog stores its information into files with the extension of .jlb.
These .jlb contain all the information that has been stored, except your
images in xml format.
By using the menu 'File - Import' you get the popup, like described in
-chapter 4, Importing new dives. Within this popup there is the option
-to import existing files which are already on your computer. To import
-your JDivelog file(s) do the following:
+<<S_ImportNewDives, chapter 4>>, Importing new dives. Within this
+popup there is the option to import existing files which are already
+on your computer. To import your JDivelog file(s) do the following:
- Open 'File - Import' on the menu
- Use the file locator under XML file name
- Click the OK button in the popup
After a few moments, you see your existing logs in Subsurface. Now you can
-edit your dives like explained in chapter 6.
+edit your dives like explained in <<S_EditDiveInfo, chapter 6>>.
Information that is imported from JDivelog into the location field:
- Type of dive
- Dive activity
-Alternatively, you can start subsurface with the --import comand line
+Alternatively, you can start subsurface with the --import command line
which will have the same effect:
subsurface MyDives.xml --import JDivelogDives.jlb
beginning time of the dives to be substantially different) subsurface
will not create duplicate entries.
-
+[[S_ImportingDivesSuunto]]
Importing dives from Suunto Divemanager 3.*
-------------------------------------------
The assumption is that you have exported your Divelogs.SDE on a Windows
system. You have to transfer the file to a location where you can read it
-from within your Linux environment. You can use file-tranfer, shared
+from within your Linux environment. You can use file-transfer, shared
storage or an USB storage device to do this.
The example uses an USB storage:
- The file is now transfered to /tmp
Now the file is in /tmp, we can extract the xml files from it. You can do
-this by hand, or use the example script in Appendix B.
+this by hand, or use the example script in <<AppendixB,Appendix B>>.
To extract the xml files, we need to open a terminal and use the following
commands:
And with the menu 'File - Save' you can save your dives into the
Subsurface format.
-
+[[S_Menu]]
The menu and sub-menus
----------------------
- Save:: Save your current divelogs or changes you made to your divelogs
- Print:: Print your current divelog profiles and information about the dive
- Import:: Import your dives from your divecomputer, JDivelogs or Suunto Divemanager
- - Preferences:: Set your preferences as described in chapter 10
+ - Preferences:: Set your preferences as described in <<S_SettingUpPreferences,chapter 10>>
- Quit:: Quit the program
The Log menu
information and License button.
-Appendix A
-----------
+[[AppendixA]]
+Appendix A: Supported Dive Computers
+------------------------------------
The use of libdivecomputer provides the support for divecomputers. Within
the list of computers in the 'File - import' menu, you will see a listing
* OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported.
-Appendix B
-----------
+[[AppendixB]]
+Appendix B: Suunto Export Unpacking Script
+------------------------------------------
#!/bin/bash
#
projects / ext / subsurface.git / blobdiff