diff options
Diffstat (limited to 'Documentation/user-manual.txt')
| -rw-r--r-- | Documentation/user-manual.txt | 439 |
1 files changed, 343 insertions, 96 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index f393bf84e..476207fae 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1,10 +1,12 @@ -Subsurface 3.0.2 User Manual +Subsurface 3.1 User Manual ============================ :author: Jacco_van_Koll,_Dirk_Hohndel,_Reinout_Hoornweg,_Linus_Torvalds,_Miika_Turkia,_Amit_Chaudhuri,_Jan_Schubert :revnumber: v3.0.0 :revdate: March 2013 :revnumber: v3.0.2 :revdate: March 2013 +:revnumber: v3.1 +:revdate: May 2013 :toc: :icons: :numbered: @@ -21,16 +23,34 @@ Introduction: ------------- Subsurface is an open source divelog program that runs on Windows, Mac -and Linux. It was started because of a lack of viable divelog -software on Linux. It then turned out that the resulting software was -fairly easily ported to Windows and Mac and today great effort is put -into making it a viable application on all three platforms. - -The program is under active development and at this point it compares -favorably to many other programs in this market. +and Linux. + +With Subsurface the user can download dive information directly from a +large number of supported dive computers. Alternatively dives can be +imported from a number of other divelog programs of web +services. Dives can also be manually entered. + +Subsurface is able to track single- and multi-tank dives using air, +Nitrox or TriMix. It displays a dive profile with all related +information including air consumption and alarms. It also allows +logging of information like weights and exposure protection used, dive +masters and dive buddies and enables the user to rate dives and +provide additional dive notes. + +With Subsurface the user can track dive locations including GPS +coordinates (which can also be conveniently entered using a map +interface). Subsurface calculates a wide variety of statistics of the +user's diving and keeps track of information like the user's SAC rate, +partial pressures of O2, N2 and He, calculated deco information, and +many more. + +Subsurface allows the user to print out a detailed log book including +dive profiles and other relevant information. The program is localized +in more than a dozen languages and well supported by an active +developer community. While the list of supported dive computers is very long, in this -manual the Suunto Vyper will be used for all examples. +manual the Suunto Vyper will be used for most examples. [[S_Requirements]] @@ -47,8 +67,8 @@ Subsurface, you need some preparation. Do you have the following: Alternatively you can import your divelogs from a couple of other divelog applications (JDiveLog, MacDive, Suunto Dive Manager, -divelogs.de). However, -native download from dive computer directly to Subsurface is +divelogs.de as well as any application that can export to UDDF). +However, native download from dive computer directly to Subsurface is recommended. @@ -80,7 +100,7 @@ However, great effort was taken to keep the profile simple, yet informative. The main information of the dive profile is the depth graph. On top of -the obvious information of the depth it shows also the ascent and +the obvious information of the depth it also shows the ascent and descent rate compared to the recommended speed of going up or down in the water column. This information is given using different colors. Dark red means ascent faster than 18m/60ft per minute or @@ -99,7 +119,9 @@ The air consumption graph displays the tank pressure and its change during the dive. The air consumption takes depth into account so that even when manually entering the start and end pressures the graph is not a straight line. Similarly to the depth graph the tank pressure -gives you information of the SAC rate when using air integrated dive +gives you information about the momentary SAC rate (Surface Air +Consumtion - often also called RMV - Respiratory Minute Volume) when +using an air integrated dive computer. Here the color coding is not relative to some absolute values but relative to the average normalized air consumption during the dive. So areas that are red or orange indicate times of increased @@ -111,40 +133,100 @@ tank pressure readings during the dive are available. Water temperature is displayed with its own blue line with degree markings placed adjacent to significant changes. -It is also possible to zoom in the profile graph. This is done either +It is possible to zoom into the profile graph. This is done either by using the scroll wheel / scroll gesture of your mouse or trackpad or by holding down the left mouse button; the zoom area can be changed by moving the mouse around the profile. There is also a toggle zoom under the 'Log' menu that changes the scale of the dive to fill the -whole area, useful especially for free divers. +whole area, useful especially for free divers. By default Subsurface +always shows a profile area large enough for at least 30 minutes and +30m (100ft) - this way short or shallow dives are intuitively +recognizable; something that free divers clearly won't care about. [[S_TecDiveProfile]] Tec Information in Dive Profile ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The dive profile can include Tec settings. Enabling these is described -in chapter <<S_SettingUpPreferences,Setting up Preferences>>. Basically -you can include graphs of accumulated pO2, pN2, pHe. These graphs are -added below the profile data. On top of the profile the currently used -gradient factors are shown (e.g. GF 35/75). - -The graph can also include both the dive computer reported ceiling and -our calculated ceiling. Because of the differences in used algorithms it -is unlikely that both of these are the same. It is even quite common -that Subsurface calculates ceiling for non-decompression dives when the -dive computer was not in deco mode during the dive. +The dive profile can include further information that is typically +more interesting for tec divers. Enabling these is described +in chapter <<S_SettingUpPreferences,Setting up +Preferences>>. Basically you can include graphs of the partial +pressures O2, N2, and He during the dive as well as a calculated +and dive computer reported deco ceilings (only visible for deep, +long, or repetitive dives). + +The partial pressure graphs are added below the profile data, the +calculated ceiling is shown as a green overlay on top of the dive +profile. Above the profile the currently used gradient factors are +shown (e.g. GF 35/75). Please note that these are NOT the gradient +factors in use by the dive computer in question, but the gradient +factors used by Subsurface to calculate deco obligations during the +dive. + +The graph can also include the dive computer reported ceiling (or more +precisely, the first deco stop that the dive computer recorded - note +that not all dive computers record this information and make it +available for download; for example all of the Suunto dive computers +fail to make this very useful data available to divelog +software). Because of the differences in used algorithms and amount of +data available (and taken into consideration) at the time of the +calculation it is unlikely that both of these are the same; this can +be true even if the same algorithm and gradient factors are used. It +is also quite common that Subsurface calculates a ceiling for +non-decompression dives when the dive computer stayed in non-deco mode +during the whole dive. This is caused by the fact that Subsurface's +calculations describe the deco obligation at that point in time during +a dive, while dive computers usually take the upcoming ascent into +account. During the ascent some excess Nitrogen (and possibly Helium) +are already breathed off so even though the diver technically +encountered a 'ceiling' at depth, the dive still does not require an +explicit deco stop. This feature allows dive computers to offer longer +'non-stop bottom time'. + +[[S_DiveList]] +Dive List +~~~~~~~~~ + +Information in the dive list is taken from different sources. Either +through <<S_ImportingAlienDiveLogs,imports from other diving log +software>> or a <<S_ImportNewDives,dive computer>> or manually entered. +Additional columns can be added through +<<S_SettingUpPreferences,preferences>>. +Existing data can be <<S_EditDiveInfo,manually edited>>, too. + +Because of the inaccuracy of depth gauge of diving computers depth + >20m are shown rounded to the next meter. Despite this the provided +depth is kept in the logfile. Users of imperial system aren't affected +by this. + +An innovative feature in Subsurface is the ability to group dives by +"trips". What this means is that multiple dives can be categorized +together under a common header. Typically this is used by divers who +travel for a limited time to a dive destiation - the location in the +trip header can then be used for the destination information +("Phillippines, Puerto Galera"), while the location in the individual +dive can describe the actual dive site ("Hole in the wall"). + +Subsurface usually does a very good job detecting and grouping dive +trips together. To use this feature simply enable the "Autogroup" +option in the "Log" menu entry. Alternatively, you can select multiple +dives in the dive list and use the context menu (right click on one of +the selected dives) to create a trip. The context menu contains +several additional options to allow manipulation of trips - these +should be self-explanatory. [[S_ImportNewDives]] Import New Dives from your Dive Computer --------------------------------------- -Before you start fiddling around with your dive computer, note that -there are dive computers that consume more power when they are in the -PC-Communication mode. This could drain your battery. Therefor, ensure -if your computer is recharging when connecting to the USB port. The -Suunto Vyper does not recharge through the USB connection. Please -consult the manual of your dive computer if you are unsure if it will -be recharged when connected to the USB port. +[NOTE] +Some dive computers consume more power when they are in their +PC-Communication mode. **This could drain your battery**. We therefore +recommend that you check if your dive computer is recharging when +connected to the USB port of a PC. The Suunto Vyper for example does +not recharge through the USB connection. Please consult the manual of +your dive computer if you are unsure if it will recharge or drain its +batteries while connected to the USB port. Now it is time to hook up your dive computer to your PC: @@ -152,7 +234,11 @@ Now it is time to hook up your dive computer to your PC: * On Linux this means you need to have the correct kernel module loaded. Most distributions will do this automatically - for you. + for you. Make sure you have read/write permissions to that + port. On Ubuntu that could mean you should run the command + following command in a terminal window: + + sudo adduser [your_username] dialout * On Windows, the OS should offer to download the correct driver when you connect your dive computer to the USB port. @@ -163,14 +249,15 @@ Now it is time to hook up your dive computer to your PC: http://www.silabs.com/support/pages/support.aspx?ProductFamily=USB+Bridges (see further hints in <<AppendixB,Appendix B>>) - - Connect your interface cable to a free USB port + - Connect your interface cable to a free USB port (or setup the Infrared + or Bluetooth connection as described later in this manual) - Put your dive computer into PC Communication mode. (For 'Suunto Vyper', press Mode - 1 Memory - 3 TR-PC) (You should consult the manual of your specific dive computer for your brand and type) - In Subsurface go to 'Log - Download From Dive Computer' * Using the two drop down lists, choose your vendor and product. Here we choose 'Suunto' and 'Vyper' as is shown on the screenshot below. - * Select the device name under which your interface is connected from the drop down list. + * If the device name drop down list is enabled, select the device name under which your interface is connected from the drop down list. * Click the 'OK' button. image::images/download_dc.png["Download from Dive Computer",align="center"] @@ -195,7 +282,7 @@ distribution that you use. On Fedora it usually is '/var/run/media/<your_username>/UEMISSDA'. In all cases Subsurface should suggest the correct location in the drop down list. -So once you have selected this as device name you can download the +Once you have selected this as device name you can download the dives from the Uemis Zurich. One technical issue with the Uemis Zurich download implementation (this is a firmware limitation, not a Subsurface issue) is that you cannot download more than about 40-50 @@ -220,10 +307,11 @@ How to Find the Device Name for USB devices ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When you connect your dive computer by using an USB connector, usually -Subsurface will propose a drop down list that contains the correct -device name (or mount point for the Uemis Zurich). In the rare cases -where this doesn't work here are some instructions on ways to find out -what your dive name is: +Subsurface will either propose a drop down list that contains the +correct device name (or mount point for the Uemis Zurich), or it will +disable the device select drop down is now device name is needed at +all. In the rare cases where this doesn't work here are some +instructions on ways to find out what your dive name is: .On Windows: @@ -235,6 +323,8 @@ The drop down box should find all connected dive computers. .On Linux: +Try the following: + - Disconnect your USB cable of your dive computer - Open a terminal - Type the command: 'dmesg' and press enter @@ -377,13 +467,16 @@ Viewing and Completing Your Logs -------------------------------- When all data from your dive computer is transferred, you will see a -listing of your dives in Area 3. +listing of your dives in the dive list on the bottom of the Subsurface +window. The columns shown as well as the units used in some of the columns +depend on preference settings. The example below uses metric units and has +some of the more commonly enabled columns explained. An example: On Sunday Oct 23, 2011 you made a dive. In the log line of this dive, you see the following information: -[width="70%",cols="<20%,40%,40%",options="header"] +[width="95%",cols="<20%,40%,40%",options="header"] |=============================================================================== | Header | Value | Description of field | # | 12 | Dive number @@ -391,22 +484,37 @@ In the log line of this dive, you see the following information: | * | | 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 +| Deg. C | 13.0 | Lowest water temperature during your dive (or with some dive computers the temperature at maximum depth) | kg | | Weight carried (none at this time) | Suit | | Exposure protection suit worn (none at this time) | Cyl | | Your used cylinder (none at this time) -| O2% | air | What type of mixture +| O2% | air | What type of gas you used on the dive | 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 dive computer. Some information is waiting for -you to be added. By double clicking on this dive, you can view and -complete the log. - -The different types of information shown in this list may differ depending on the settings. More -about that in <<S_SettingUpPreferences,Setting up Preferences>>. +you to be added. + +[NOTE] +In order to edit the dive information, you need to either double-click +on this dive in the dive list, right-click on the dive in the dive +list and select "Edit Dive" from the context menu, or select multiple +dives in the dive list, right click on one of them and then select +"Edit Dives" from the context menu. The last option is especially +useful if you want to edit multiple dives that you just downloaded at +the same time in order to set common attributes (like dive master or +buddy). + +As mentioned, the different types of information shown in this list +may differ depending on the settings. More about that in +<<S_SettingUpPreferences,Setting up Preferences>>. Also, the fields +that are filled or empty differ from dive computer to dive +computer. Basic dive computers are less likely to provide a lot of +information, whereas some more advanced once will provide all of the +information listed here (assuming it was correctly entered on the dive +computer). [[S_EditDiveInfo]] Edit the Dive Info @@ -423,6 +531,7 @@ The purpose of the fields is described in the table below: [width="90%",cols="<33%,67%",options="header"] |=============================================================================== | Field | Description of field +| Dive number, date and time | A button with dive number and date that gives a dialog to edit date/time/depth when clicked | Location | An input where you can enter your new location, or you can choose with the pull-down previous locations | GPS (WGS84 or GPS format) | An input where you can enter geographic coordinates of the dive site | Pick on map | A button you can click on to display an interactive map on which you can select the location of the dive site @@ -431,7 +540,8 @@ The purpose of the fields is described in the table below: | Rating | A pull-down where you can rate your dive | Suit | An input where you can track the exposure protection suit you were wearing | Visibility | A pull-down where you can rate the visibility underwater -| Air Temp in deg. C | An input where you can enter the air temperature +| Air Temp in deg. C/F | An input where you can enter the air temperature +| Dive Tags | Check boxes allowing you to describe the dive (e.g. shore & wreck) | Notes | A free input where you can enter information about your dive. What you've seen, etc. |=============================================================================== @@ -521,13 +631,48 @@ Press 'OK'. Now your dive information for this dive is complete. You can now press 'OK' in the Dive Info screen and view the results. +[[S_EditEvents]] +Edit Events and Gas Changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Depending on your dive computer and the specific dive that you are +looking at, a number of events may be indicated by small yellow +triangles within the dive profile. Hovering the mouse pointer over +such an event will show a short explanation of the event in the +tooltip window. On some dive computers few or no events are shows, +other dive computers create these events rather agressively. At times +you may want to remove some of these events, either because they were +created in error (an accidental 'marker' or 'bookmark' set during a +dive) or because the information provided is not useful to you. + +You can either do this by filtering out these events (as explained in +the <<S_FilterMenu, Filter Menu section>>), or by outright deleting +these events from the XML file. In order to do that, point at the +event-triangle with your mouse (it is actually sufficient to have the +mouse point at the point in time when the event happened) and +right-click. A context menu will allow you to remove the event from +the dive. + +In the same way (by picking the correct time with the mouse pointer), +certain events can be added to a dive profile from the right-click +context menu. At this point only 'bookmark' events and 'gas change' +events can be added. The latter ones are especially useful when diving +with multiple tanks but with a dive computer that only supports one +gas, or when forgetting to switch the dive computer to a different +tank during the dive. + +Please note that the gas that you want to switch to must have already +been added to the Equipment list before it can be used here. See the +<<S_EditEquipmentInfo, previous section on Editing Equipment Info>> +for reference. + [[S_ViewInfoStats]] View Dive Info & Stats ---------------------- After adding all the information, you can use the tab 'Dive Info' and -the 'Stats tab'. These tabs will provide you with all the (statistical and -calculated) information regarding your dive. +the 'Stats tab'. These tabs will provide you with lots of (statistical +and calculated) information regarding your dive. The information contains: @@ -562,6 +707,14 @@ The information contains: | Max/Min/Avg SAC | Highest / lowest / average Surface Air Consumption of your covered dives |=============================================================================== +Since the statistics cover all selected dives this feature can be used +to do some more selective analysis of your dives. You can sort your +dives based on one of the columns and then easily select all the dives +with a certain value in that column (for example, all dives in a dry +suit). Or you can use the Filter->Select Tags... menu to only display +dives that include a certain tag, select some or all of those dives +and now see statistics for those dives. + There is also a yearly statistics option that is reachable from the menu 'Log - Yearly Statistics'. These statistics show you information on how many dives you have done per year and how long you spent below surface in total (during each @@ -606,8 +759,9 @@ The Tec Settings offer extra columns to show, settings for more graphs and information to be shown in the dive profile and settings for GFlow and GFhigh. -In General Settings you are free to choose what your preference are for the -units to be displayed, with other words, use Metric or Imperial. +In General Settings you are free to choose what your preference are +for the units to be displayed. You are not restricted to use all +Metric or all Imperial, any combination is fine. You can set the following options with 'Units': @@ -615,15 +769,15 @@ You can set the following options with 'Units': |=============================================================================== | Field | Units to be displayed | Depth | Your diving depth in Meters or Feet -| Pressure | The pressure of your tank(s) in Bar/Ato or PSI (Pressure Square Inch) -| Volume | The volume of your tank(s) in Liter or CuFt (Cubic Feet) (At sea-level pressure) -| Temperature | The temperature of the water in Celsius or Fahrenheit +| Pressure | The pressure of your tank(s) in Bar/Ato or PSI (Pounds per Square Inch) +| Volume | The volume of your tank(s) in Liter (at sea level) or CuFt (Cubic Feet) (at working pressure) +| Temperature | The temperature of the water in degrees Celsius or Fahrenheit | Weight | The weight of your weight system in kg or lbs |=============================================================================== -In the main screen, you did see in Area 3, some information. With the -'Show Columns', you can enable/disable options you would like to show -there: +As mentioned earlier when discussing the information visible in the +dive list at the bottom of the main Subsurface window, you can +enable or disable some of the colums that can be shown there: [width="90%",cols="<33%,67%",options="header"] |=============================================================================== @@ -638,8 +792,9 @@ there: With 'Divelist Font', you can change the font used in the dive list, -And you can use 'Default XML Data File' to specify which file contains the -data the program will use by default. +And you can use 'Default XML Data File' to specify which file contains +the data the program will use by default (the program tries to pick a +reasonable default on all three supported operating systems. The other tab holds the 'Tec Settings' You can select more columns to be shown with 'Show Columns': @@ -863,7 +1018,7 @@ be imported to Subsurface either from command line or from GUI. Export from divelogs.de ^^^^^^^^^^^^^^^^^^^^^^^ - - Login to http://en.divelogs.de with your account + - Login to https://en.divelogs.de with your account - Go to the 'Export Logbook' page - Choose 'DLD Export of your logbook' and save the resulting yourUserName.DLD file @@ -940,20 +1095,69 @@ Please report your findings for UDDF data from different sources than descibed in this document at http://trac.hohndel.org[our bugtracker] or send an email to mailto:subsurface@hohndel.org[our mailing list]. +[[S_Exporting]] +Exporting dives from Subsurface +------------------------------- + +We currently support exporting the divelog to UDDF format and directly uploading to divelogs.de. + +[[S_UploadingDivelogsDe]] +Uploading Dives to divelogs.de +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Subsurface supports uploading dives directly to divelogs.de. You'll +need to provide a valid user name and password for divelogs.de which +can be created from a web browser at +https://en.divelogs.de/newuser.php. You can upload either selected +dives or all the dives (duplicate dives that are already recorded at +divelogs.de will be skipped). When selecting to upload, you are +presented a simple dialog for user name and password. + +[NOTE] +The password is stored in the configuration +file / registry in clear-text. Please do not use this feature if you have +security concerns with this. Also note that when running Subsurface on +Windows at this point the connection to divelogs.de is established through +an http link, so your login credentials and uploaded data can easily be +captured by other people on the same network. + +image::images/upload_divelogs_de.png["Upload to divelogs.de",align="center"] + +Note that uploading dives to divelogs.de requires Internet +connectivity and cannot be done off-line. + +.Uploading selected dives to divelogs.de + +Mark the dives to be uploaded in the dive list. Click right mouse button on one +of the selected dives and select the menu 'Upload dive(s) to divelogs.de'. + +.Uploading all dives to divelogs.de + +You can of course mark all the dives and upload them using the right mouse +button menu. However, you can also select menu 'File - Upload to +divelogs.de...' + +[[S_ExportingUDDF]] +Exporting dives to UDDF +~~~~~~~~~~~~~~~~~~~~~~~ + +When you select dives and choose the exporting option from right click menu, you get a dialog asking where to save the file. Similarly when you select the menu 'File - Export UDDF' you can export all the dives to UDDF file of your choosing. + [[S_DivePlanning]] Planning Dives -------------- -Subsurface supports planning of dives using open and closed circuit -equipment. This allows users to experiment with different plans and see -the effects of changing various parameters of the dives. +Subsurface includes a still rather experimental dive planning feature +that allows the creation of dive plans for both recreational scuba +equipment (open circuit) and rebreathers (closed circuit +equipment). This allows users to experiment with different plans and +see the effects of changing various parameters of the dives. [WARNING] -Deco calculations with optionally displaying the ceiling is -done using a new implementation of the Buhlmann ZH16 algorithm with -gradient factors. Since the planner and our implementation of the -decompression algorithms are new and have received only a limited amount -of testing: + +Deco calculations are done using a new implementation of the Buhlmann +ZH-L16 algorithm with gradient factors. Since the planner and our +implementation of the decompression algorithms are new and have received +only a limited amount of testing: + **WE STRONGLY RECOMMEND NOT TO PLAN DIVES SIMPLY BASED ON THE RESULTS GIVEN HERE.** @@ -969,6 +1173,9 @@ In order to plan a dive some basic information needs to be entered: - planned depths - planned segment times +Additionally there is an option to plan the last deco stop at 6m/20ft +instead of the otherwise used final stop at 3m/10ft. + There is also other information available for those who are familiar with dive planning or use closed circuit rebreathers. @@ -981,7 +1188,7 @@ are familiar with dive planning or use closed circuit rebreathers. | GFlow | Gradient factor low value affects the ceiling calculation, leave to default if you are not familiar with GF | GFhigh | Gradient factor high value affects the ceiling calculation, leave to default if you are not familiar GF | **Ending Depth** | Depth where current segment ends; a different depth from the previous segment creates a transition segment for ascent or descent, keeping the same depth creates a segment at the given depth. By default the planner uses the measurement for length set in the preferences (meters for most users) - this can be overridden by explicitly specifying 'm' or 'ft'. -| **Segment Time** | Enter time in minutes; segment duration / relative time is indicated by a '+': '+3' or '+3:00' creates a segment that lasts 3 minutes, a bare number like '7' is used for a segment that ends 7 minutes after the start of the dive. +| **Segment Time** | Enter time in minutes; segment duration / relative time can be indicated by an optional '+': '+3' or '+3:00' creates a segment that lasts 3 minutes, add an at sign like '@7' for a segment that ends 7 minutes after the start of the dive. | **Gas Used** | Breathing gas mix used; the parser is reasonably flexible and understands terms like AIR, EAN32, 36% or 15/50 (compressed air, 32% nitrox, 36% nitrox or 15% O₂ / 50% He trimix, respectively); leaving this field empty indicates continued use of the previous gas, air by default | **CC SetPoint** | SetPoint when diving with a closed circuit rebreather. Leave empty for open circuit dives with standard scuba equipment |=============================================================================== @@ -1060,21 +1267,37 @@ Web Service and Companion App ----------------------------- This part of Subsurface is a bit of 'work in progress'. We are -developing a companion application for Android that will allow you to -track dive sites from your GPS-enabled Android device; at the time of -the Subsurface 3.0 release the app wasn't ready to be submitted to the -Google Play store, but since it is mostly usable when built form -source we left the server side integration in Subsurface. - -Assuming you have used the companion app to name and locate dive sites -you can use this menu item to connect to our back-end server and -download this data. Enter your userid (you got this when registering -with the web service) and click 'Download'. If the data was -successfully downloaded you can click apply and Subsurface will match -the time stamps of the downloaded location and site name information -with the dives in your log and will add the GPS locations and dive -site names to your dives. - +developing a companion application for Android that allows you to +track dive sites from your GPS-enabled Android device. + +The Subsurface app is available for free in the Google Play store (and +sources are available from our git server). A server side webservice +is running on our infrastructure to capture and store the data +transmitted by the application. An interested user could also run +their own web service (the sources for the web service are also +available). + +The Android companion app allows you to store the GPS location and +name of specific dive sites as their name is entered into the +application. It can also operate as a background service and record +positions at regular intervals (this is especially useful when on a +dive boat). + +After downloading your dives from your dive computer (or manually +adding them in the Subsurface desktop application) you can then use +this menu item to connect to our back-end server and download the +related location data (and dive site names). Enter your userid (you +got this when registering with the web service) and click +'Download'. If the data was successfully downloaded you can click +apply and Subsurface will match the time stamps of the downloaded +location and site name information with the dives in your log and will +add the GPS locations and dive site names to your dives. + +[NOTE] +At this point you can not use the Android Subsurface companion app to +enter dives and then download these dives into the desktop +application. The companion up and webservice can only be used to add +GPS location (and dive site name) to an existing dive in the dive log. [[S_Menu]] The Menu and Sub-Menus @@ -1094,6 +1317,8 @@ The file menu is used for the following menu options: - Save As:: Save your current divelogs or changes you made to your divelogs under a different name - Close:: Close your current divelog, saving as necessary - Import File(s):: Import your dives from files exported by other divelogs + - Export UDDF:: Export all dives to UDDF format + - Upload to divelogs.de Upload all dives to divelogs.de (requires Internet connectivity) - Print:: Print your current divelog profiles and information about the dive - Preferences:: Set your preferences as described in <<S_SettingUpPreferences,chapter Setting up Preferences>> - Quit:: Quit the program @@ -1130,14 +1355,32 @@ The view menu allows you to choose between the following representations: - Prev DC Switch to the previous dive computer - Next DC Switch to the next dive computer +[[S_FilterMenu]] The Filter Menu ~~~~~~~~~~~~~~~ -This menu gives you the choice to enable or disable Events for the -selected divelog(s). At this time, you can enable or disable ascent. -When you enable ascent for your dives, within the dive profile, a yellow -marker with exclamation sign (!) will show on the points where you have -ascended. +The filter menu gives you two very different filter selections. + +The first one allows you to create a global filter for certain kind of +events that you no longer want to see displayed in the dive profile +view. Normally all events are represented by small yellow triangles, +but some dive computers create a large number of events that the user +may or may not want to see in the profile (some dive computers for +exampel are very agressively creating "ascend speed warnings" that can +clutter the profile). Selecting this menu will open a dialog that +allows you to select which events should be globally disabled (they +will still be stored in the XML file). + +Subsurface also allows you to delete specific events from a dive +profile (see <<S_EditEvents, section Edit Events and Gas Changes>>). +As a reminder, his can be done by right-clicking on the specific event +that you want to remove in the dive profile window. Events that are +deleted like this will actually be removed from the XML file as well. + +The second entry in the filter menu allows you to display only a +subset of your dives in the dive list, based on specific tags that are +selected in a dialog. This is especially useful when used in +connection with the statistics features of Subsurface. The Planner Menu ~~~~~~~~~~~~~~~~ @@ -1148,8 +1391,12 @@ in <<S_DivePlanning,chapter Planning Dives>>. The Help Menu ~~~~~~~~~~~~~ -The Help menu shows only the About, which contains the version and author -information and License button. +The Help menu contains the About entry which displays the version and +author information as well as links to the full license under which +Subsurface is developed and to the Subsurface website. + +The second entry in the help menu opens the latest online version of +this manual in the default web browser. [[AppendixA]] @@ -1198,7 +1445,7 @@ Suunto::: * Eon, Solution Alpha and Solution Nitrox/Vario * Vyper, Cobra, Vytec, Vytec DS, D3, Spyder, Gekko, Mosquito, Stinger, Zoop * Vyper2, Cobra2, Cobra3, Vyper Air and HelO2 - * D9, D6, D4, D9tx, D6i and D4i + * DX, D9, D6, D4, D9tx, D6i and D4i Uemis::: * Zurich |