Version 0.0.4 of user manual

Cleanup of the layout
Changed line-length to 74
Added chapter 11. How to find the Device Name
Added Appendix A: Supported divecomputers

Signed-off-by: Jacco van Koll <jacco.van.koll@gmail.com>

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index b1ceaad4bca322b588337241e4442b627250aa0e..469fbd8d97d44f58688274dad3e68915d749906d 100644 (file)
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -2,7 +2,7 @@ Subsurface 1.2
 
 User Manual
 
-Version 0.0.3
+Version 0.0.4
 
 Autor documentation: Jacco van Koll <jko@haringstad.com>
 
@@ -23,6 +23,7 @@ already very usable for divers with supported dive-computers.
 
 In this manual the Suunto Viper will be used for all examples.
 
+
 2. Requirements
 
 Before you are able to import information from your divecomputer into
@@ -164,6 +165,7 @@ Now we are going to enter the data:
 Now your dive information for this dive is complete. You can now press
 ok in the Dive Info screen and view the results.
 
+
 8. Adding equipment info
 
 In Area with the 3 tabs there is the tab Equipment. With this tab, you
@@ -174,6 +176,7 @@ can add Cylinders.  We are going to add an additional Cylinder:
        Just like you added your Cylinder information in 7. Edit equipment info, you add your cylinder
        information for the second Cylinder. Fill in all the information about this Cylinder and press OK.
 
+
 9. View info & Stats
 
 After adding all the information, you can use the tab Info &
@@ -205,6 +208,7 @@ The information contains:
        Min SAC:        Lowest of Surface Air Consumption of all your dives
        Avg SAC:        Average Surface Air Consuption of all your dives, calculated
 
+
 10. Setting up preferences
 
 Subsurface has the ability to modify the preferences you want. By
@@ -250,3 +254,86 @@ As a beginning diver, I don't need to track my OTUs. So I leave this
 one not enabled.
 
 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
+Serial to USB devices, this can be different because '/dev/ttyUSB0' is
+already in use.
+
+One of the ways to find out what your dive name is:
+
+       Disconnect your usb cable of your dive computer
+       Open a terminal
+       Type the command: 'dmesg' and press enter
+       Plug in your usb cable of your divecomputer
+       Type the command: 'dmesg' and press enter
+
+Within your terminal you should see a message similair to this one:
+
+       usb 2-1.1: new full speed USB device number 14 using ehci_hcd
+       usbcore: registered new interface driver usbserial
+       USB Serial support registered for generic
+       usbcore: registered new interface driver usbserial_generic
+       usbserial: USB Serial Driver core
+       USB Serial support registered for FTDI USB Serial Device
+       ftdi_sio 2-1.1:1.0: FTDI USB Serial Device converter detected
+       usb 2-1.1: Detected FT232BM
+       usb 2-1.1: Number of endpoints 2
+       usb 2-1.1: Endpoint 1 MaxPacketSize 64
+       usb 2-1.1: Endpoint 2 MaxPacketSize 64
+       usb 2-1.1: Setting MaxPacketSize 64
+       usb 2-1.1: FTDI USB Serial Device converter now attached to ttyUSB3
+       usbcore: registered new interface driver ftdi_sio
+       ftdi_sio: v1.6.0:USB FTDI Serial Converters Driver
+
+You see that in the third line from the bottom, the usb adapter is
+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, 
+
+Appendix A
+
+The use of libdivecomputer provides the support for divecomputers. Within
+the list of computers in the 'File - import' menu, you will see a listing
+of divecomputers. This list is covering a compatible set. Please check
+your users manual to check if your computer will be supported.
+
+   Supported divecomputers:
+
+       Atomics:
+               Cobalt
+       Cressi:
+               Edi
+       Mares:
+               Icon HD
+               Nemo
+               Puck
+       Oceanic:
+               Veo250
+               VT Pro
+       OSTC: *
+               DR5
+               2N
+       Reefnet:
+               Sensus
+               Sensus Pro
+               Sensus Ultra
+       Suunto:
+               D9
+               Eon
+               Solution
+               Viper
+               Viper Air
+       Uwatec:
+               Aladin
+               Memo Mouse
+               Smart
+       Zeagle:
+               N2iTiON 3
+
+* OSTC computers are listed in the pull-down menu as OSTC. All 3 types are supported.