]> git.tdb.fi Git - ext/subsurface.git/blobdiff - Documentation/user-manual.txt
There's a difference between "it's" and "its"
[ext/subsurface.git] / Documentation / user-manual.txt
index 469fbd8d97d44f58688274dad3e68915d749906d..4b4eee3343f0b079e74ea34a8e4332c202e6e44a 100644 (file)
@@ -2,13 +2,13 @@ Subsurface 1.2
 
 User Manual
 
-Version 0.0.4
+Version 0.0.6
 
 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) it´s dependencies.
+software and (if needed) its dependencies.
 
 Audience: Fun Divers, Tec Divers, Professional Divers
 
@@ -62,13 +62,32 @@ be recharged when connected to the USB port.
 
 Now it is time to hook up your divecomputer to your Linux system:
 
-    Connect your interface cable to your divecomputer
+    Make sure that your OS has the required drivers installed
+
+        On Linux this means you need to have the correct kernel
+        module loaded. Most distributions will do this automatically
+        for you.
+
+        On Windows, the OS should offer to download the correct
+        driver when you connect to the USB port.
+
+        On a Mac you at times have to manually hunt for the correct
+        driver. For example the correct driver for the Mares Puck
+        devices can be found as Mac_OSX_VCP_Driver.zip at
+        http://www.silabs.com/support/pages/support.aspx?ProductFamily=USB+Bridges
+
     Connect your interface cable to a free USB port
+
     Put your divecomputer into PC Communication mode. (For Suunto Viper, press Mode - 1 Memory - 3 TR-PC)
        (You should consult the manual of your specific divecomputer for your brand and type)
+
     Go in Subsurface to 'File - Import'
        Within the popup, under Dive computer, choose your brand and type. Here we choose Suunto Vyper.
-       Change the devicename under which your interface is connected. Default is /dev/ttyUSB0
+       Change the devicename under which your interface is connected.
+              On Linux, default is /dev/ttyUSB0
+              On Windows, default is COM3
+              On Mac, default is ... specific to the dive computer
+
        Click the 'OK' button.
 
     Now watch how your data is retrieved from your divecomputer!
@@ -259,7 +278,7 @@ Clicking OK on the dialog stores these settings.
 11. How to find the Device Name
 
 When you connect your divecomputer by using an USB connector, most of the
-time, the default of ´/dev/ttyUSB0' should work. But if you have other
+time, the default of '/dev/ttyUSB0' should work. But if you have other
 Serial to USB devices, this can be different because '/dev/ttyUSB0' is
 already in use.
 
@@ -294,7 +313,149 @@ detected and is connected to 'ttyUSB3'. Now you use this information in
 the import settings as '/dev/ttyUSB3'. Your divecomputer interface is
 connected and you should be able to import your dives.
 
-interface cable to this serial port, 
+
+12. Importing dives from JDivelog
+
+Maybe you have been using JDivelog and you have a lot of dives logged in
+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.
+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:
+
+       Open 'File - Import' on the menu
+       Use the file locator under XML file name
+       Browse your directories to the location where your *.jlb file is
+       Select your existing *.jlb file and click 'open'
+       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.
+
+Information that is imported from JDivelog into the location field:
+
+       Extended dive location information
+
+Information that is merged into the location or notes field:
+
+       Used amount of weight
+       Used type of suit
+       Used type of gloves
+       Type of dive
+       Dive activity
+
+Alternatively, you can start subsurface with the --import comand line
+which will have the same effect:
+
+      subsurface MyDives.xml --import JDivelogDives.jlb
+
+will open your divelog (assuming that's called MyDives.xml) and then
+import the dives from JdivelogDives.jlb. You can now save the combined
+divelog back as MyDives.xml.
+
+Subsurface will similarly import xml exports from DivingLog as well as
+Suunto DiveManager.
+
+When importing dives subsurface tries to detect multiple records for
+the same dive and merges the information as best as it can. So as long
+as there are no time zone issues (or other reasons that would cause the
+beginning time of the dives to be substantially different) subsurface
+will not create duplicate entries.
+
+
+13. Importing dives from Suunto Divemanager 3.*
+
+Before you can start importing dives from Suunto Divemanager, you first
+have to export the dives you want to import. Subsurface does not import
+directly from the Suunto Divemanager log files. The following procedures
+unpacking instructions for Linux and Windows.
+
+13.1 Export from Suunto Divemanager:
+
+       Start Suunto Divemanager and login with the name containing the logs
+       Do not start the import wizard to import dives from your computer.
+       In the navigation tree on the left side of the program-window, select your dives.
+       Within the list of dives, select the dives you would like to import later:
+               To select certain dives: hold ctrl and point & click the dive
+               To select all dives:  Select the first dive, hold down shift and select the last dive
+       With the dives marked, use the program menu 'File - Export'
+       The export popup will show
+       Within this popup, there is one field called Export Path.
+               Click the button browse next to the field Export Path
+                       A file-manager like window pops up
+                       Navigate to the directory where you want to store the Divelog.SDE file
+                       Optional change the name of the file you want to save
+                       Click 'Save'
+               You are back in the Export popup. Press the button 'Export'
+       Your dives are now exported to the file Divelogs.SDE.
+
+13.2 Unpacking the Divelogs.SDE on Windows
+
+Renaming your file to a .zip:
+
+       Use the filemanager (explorer) and navigate to your Divelogs.SDE file
+       Right click on the Divelogs.SDE file and choose 'Rename'
+               Change the name into Divelogs.SDE.zip
+               Press enter when done. A warning popup shows:
+                       The file could be unusable when changing the extension. Are you sure:
+                       Press OK.
+       Your filemanager will show now the filename Divelogs.SDE.zip
+
+When you double click your Divelogs.SDE.zip file, your preferred archiving
+tool will start and show you the list of xml files that are in the zip
+archive. Select all the xml files and extract them to a place where you
+can find them later in the process.
+
+13.3 Unpacking the Divelogs.SDE on Linux
+
+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
+storage or an USB storage device to do this.
+The example uses an USB storage:
+
+       Insert your USB storage into your Windows computer
+       Use the filemanager (explorer) to navigate to the location where your Divelogs.SDE file is located
+       Copy the file to your USB storage:
+               Select the file by 1 click
+               Press Ctrl+c
+               Navigate to your USB Storage
+               Press Ctrl+v
+       Disconnect your USB storage by right clicking your USB storage in the explorer and choose Eject
+       Insert your USB storage into your Linux computer
+       Use your favourite filemanager to navigate to your USB storage
+       Copy the file to /tmp by:
+               Right click on the file
+               select copy
+               navigate to /tmp
+               press Ctrl+v or use the menu 'Edit - Paste'
+       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.
+
+To extract the xml files, we need to open a terminal and use the following
+commands:
+
+       cd /tmp
+       mkdir suunto
+       cd suunto
+       unzip ../Divelogs.SDE
+
+Your divelogs have now been extracted from the Divelogs.SDE file and you
+can import them with the command:
+
+       subsurface *.xml
+
+And with the menu 'File - Save' you can save your dives into the
+Subsurface format.
+
 
 Appendix A
 
@@ -313,6 +474,7 @@ your users manual to check if your computer will be supported.
                Icon HD
                Nemo
                Puck
+                       Air
        Oceanic:
                Veo250
                VT Pro
@@ -324,11 +486,30 @@ your users manual to check if your computer will be supported.
                Sensus Pro
                Sensus Ultra
        Suunto:
+               Cobra
+                       2
+                       3
+               D3
                D9
+                       D4
+                       D4i
+                       D6
+                       D6i
+                       D9tx
                Eon
+               Gekko
+               HelO2
+               Mosquito
                Solution
-               Viper
-               Viper Air
+                       Alpha
+                       Nitrox/Vario
+               Stinger
+               Vyper
+                       2
+                       Air
+               Vytec
+                       DS
+               Zoop
        Uwatec:
                Aladin
                Memo Mouse
@@ -337,3 +518,31 @@ your users manual to check if your computer will be supported.
                N2iTiON 3
 
 * OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported.
+
+
+Appendix B
+
+#!/bin/bash
+#
+# Small basic example script to unpack Suunto Export files
+# for the use with Subsurface
+#
+
+echo -n "Enter the directory where you stored your Suunto Divemanager export file: "
+read SuuntoExportDir
+
+echo -n "Enter the name of your Suunto Divemanager export file: "
+read SuuntoExportFile
+
+echo "You have entered: $SuuntoExportDir/$SuuntoExportFile"
+
+cd $SuuntoExportDir
+
+       if [ -e ./$SuuntoExportFile ]; then
+               mkdir SuuntoXML
+               cd SuuntoXML
+               unzip ../$SuuntoExportFile
+               subsurface *.xml
+       else
+               echo "Nothing found! Try again!"
+       fi