Changeset a6f9a37 in subsurface


Ignore:
Timestamp:
Jan 7, 2017, 7:19:12 AM (9 months ago)
Author:
Dirk Hohndel <dirk@…>
Branches:
master
Children:
9dd7de3
Parents:
913fa85
git-author:
Willem Ferguson <willemferguson@…> (01/07/17 03:02:23)
git-committer:
Dirk Hohndel <dirk@…> (01/07/17 07:19:12)
Message:

User manual updates

Update:
1) Text dealing with SmartTrak? import. Move text, some corrections,

add image.

2) Text dealing with command-line arguments.

A few other small changes.

Signed-off-by: Willem Ferguson <willemferguson@…>
Signed-off-by: Dirk Hohndel <dirk@…>

Location:
Documentation
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • Documentation/user-manual.txt

    rc084887 ra6f9a37  
    10551055
    10561056
     1057[[S_SmartTrakImport]]
     1058==== Importing Scubapro _SmartTrak_ divelogs
     1059
     1060_SmartTrak_ stores the raw data from a Uwatec/Scubapro dive computer along with a plethora
     1061of other data manually added by the user, ranging from dive points to buddies data or DAN survey
     1062info. However, this is Microsoft Windows-based propietary software by Uwatec (today Scubapro)
     1063using Microsoft Access databases, preventing the integration the importer into the _Subsurface_
     1064core application.
     1065
     1066A stand alone tool for Linux has been developed to import the _.slg_ files
     1067generated by SmartTrak to Subsurface's _.xml_ format. It can be built together
     1068with _Subsurface_ for Linux systems. Two dependencies need to be installed in
     1069your system before building: _libglib2.0_ and _libmdb2_.
     1070
     1071Feel free to contact the _Subsurface_ development team on mailto:subsurface@subsurface-divelog.org[our mailing list]
     1072for assistance in importing _SmartTrak_ dive logs.
     1073
     1074Assuming the above dependencies
     1075have been installed and the _Subsurface_ source tree is in the directory _~/src/subsurface_, then:
     1076
     1077===== Building _smtk2ssrf_
     1078
     1079- Move to the source tree directory.
     1080- Run  " $ ccmake build " and set SMARTTRAK_IMPORT option to *on* (off by
     1081  default).
     1082- Generate with [c] and save and exit with [g].
     1083- Build as you prefer, using the _build.sh_ script (recomended) or moving to build
     1084  directory and running _make_.
     1085- After a successful build, there will be an executable named _smtk2ssrf_ in the
     1086  _subsurface/build_ directory.
     1087  Copy or move it to a directory in your $PATH, e.g. _~/bin_.
     1088
     1089===== Running
     1090
     1091_smtk2ssrf_ accepts 0, 2 or more parameters. If it is launched without
     1092parameters in a graphical user interface, a simple window
     1093opens for choosing the _.slg_ file(s) to import and a destination file to store the
     1094_Subsurface_-formatted data into (see image below).
     1095
     1096image::images/smtk2ssrf.jpg["FIGURE:Download from SmartTrak",align="center"]
     1097
     1098[icon="images/icons/warning2.png"]
     1099[WARNING]
     1100Existing data in the destination file will be
     1101erased, so *DO NOT* use a regular subsurface divelog file as a destination:
     1102rather, specify a *new* filename as a destination.
     1103
     1104If launched from a command line with two or more parameters, the format is as follows:
     1105
     1106        $ smrtk2ssrf /input/file_1.slg /input/file_2.slg /output/file3.xml
     1107
     1108where _input_ is the directory containing the .slg file(s) and _output_ is the
     1109directory where the _Subsurface_-formatted output is written to.
     1110Files _file_1.slg_ and _file_2.slg_ in the _input_ directory are imported and stored
     1111in _file3.xml_ in the _output_ directory. Check any warning and error messages
     1112in the console or in the graphical window: some may be
     1113relevant as support for Galileo family of dive computers is still a work in
     1114progress.
     1115
     1116===== Merging the imported dives with the existing divelog
     1117
     1118Open the new file (generated in the previous steps) using _Subsurface_ and check the dives and data.
     1119If everything is fine, close the _.xml_ file and open your regular divelog.
     1120Then from the *Main Menu* select _Import -> Import log file_ and choose the
     1121_.xml_ file containing the imported dives: these will show in the *Dive List*, time
     1122ordered, along with the existing dives.
     1123The new dives, although time ordered, will keep the numbering system from
     1124_SmartTrak_, so a renumbering action is needed. See the section on xref:S_Renumber[Renumbering
     1125the dives] for instructions on this topic.
     1126
    10571127[[S_ImportingDivelogsDe]]
    10581128==== Importing dives from *divelogs.de*
     
    12321302****
    12331303
    1234 
    12351304[icon="images/icons/important.png"]
    12361305[IMPORTANT]
     
    12431312the limits of the parser used. When encountering problems with _CSV_ imports, first try with
    12441313a smaller file to make sure everything works.
    1245 
    1246 [[S_SmartTrakImport]]
    1247 ==== Importing SmartTrak divelogs
    1248 
    1249 SmartTrak is a Windows based propietary software by Uwatec (today Scubapro).
    1250 It works through Access databases, which makes it difficult to integrate the
    1251 importer in _Subsurface_ core application, and stores the full raw data from
    1252 the DC along with a plethora of other data manually added by the user, ranging
    1253 from dive points to buddies data or DAN survey info.
    1254 
    1255 A little stand alone tool has been developed to import the .slg files
    1256 generated by SmartTrak to Subsurface's .xml format. It can be built together
    1257 with _Subsurface_ for linux systems. Two dependencies need to be installed in
    1258 your system before building: libglib2.0 and libmdb2.
    1259 
    1260 Assuming installed those dependencies and _Subsurface_ source tree placed in a
    1261 directory like ~/src/subsurface, then:
    1262 
    1263 *BUILDING*
    1264 
    1265 - Move to the source tree directory.
    1266 - Run  " $ ccmake build " and set SMARTTRAK_IMPORT option to *on* (off by
    1267   default).
    1268 - Generate with [c] and save and exit with [g].
    1269 - Build as you prefer, using build.sh script (recomended) or moving to build
    1270   directory and running make.
    1271 - After a successful build, there will be an executable in the build directory
    1272   named smtk2ssrf, copy or move it to a directory in your $PATH, e.g. ~/bin
    1273 
    1274 *RUNNING*
    1275 
    1276 smtk2ssrf accepts 0, 2 or more parameters. If it's launched without
    1277 parameters and you are on a graphical environment a simple window will be
    1278 displayed letting you choose the file(s) to import and a file to store the
    1279 subsurface formatted data.
    1280 
    1281 [icon="images/icons/warning2.png"]
    1282 [WARNING]
    1283 Previous data in the output file will be
    1284 erased, so *DO NOT* use your regular subsurface divelog file as output. It's
    1285 advisable to set a brand new file to do the import.
    1286 
    1287 If launched from command line with 2 or more parameters like:
    1288 
    1289         $ smrtk2ssrfc /input/file_1.slg /input/file_2.slg /output/file.xml
    1290 
    1291 Files file_1.slg and file_2.slg in input directory will be imported and stored
    1292 in file.xml in output directory.
    1293 
    1294 Check warning and error messages in console or graphical window, some may be
    1295 interesting, as support for Galileo and family DCs is still a work in
    1296 progress.
    1297 
    1298 *MERGING*
    1299 
    1300 Open the brand new imported file in _Subsurface_ and check the dives and data.
    1301 If everything is fine, close the .xml file and open your regular divelog.
    1302 Then from _Main menu_ select _Import -> Import log file_ and choose the
    1303 imported .xml file.  The imported dives will show in the _Dive List_, time
    1304 ordered, along with the previous dives.
    1305 The new dives, although time ordered, will keep the numbering system from
    1306 SmartTrak, so a renumbering action is needed. See xref:S_Renumber[Renumbering
    1307 the dives] section in this manual for instructions about this topic.
    1308 
    13091314
    13101315=== Importing Dive coordinates from a mobile device with GPS.
     
    30133018process could be used for the Cloud-based storage of dive logs.
    30143019
     3020[[S_user_space]]
    30153021== Several _Subsurface_ users on one desktop computer
    30163022A frequent need is for two or more persons to use _Subsurface_ on the same desktop computer. For instance
    3017 members of a household may use the same computer. There are two approaches for doing this.
     3023members of a household may use the same computer or one family member may perform dive uploads for other
     3024family members/friends. There are two approaches for doing this.
    30183025
    30193026*A)* If the different users of a desktop computer do not log onto the desktop/laptop under different user names
     
    37673774merged dive highlighted in the _Dive List_, switch
    37683775between the planned profile and the real-life profile using the righ-arrow/left-arrow keyboard keys.
     3776
     3777== Running _Subsurface_ from the command-line
     3778_Subsurface_ can be launched from the command-line to set some specialised settings or as
     3779part of an script-based automated process for manipulating a dive log. The format for launching _Subsurface_ from the
     3780command-line is:
     3781
     3782        subsurface [options] [logfile ...] [--import logfile ...]
     3783
     3784The options include:
     3785|====================
     3786|*Command-line option*|*Description*
     3787|--help|Print a summary of the command-line options
     3788| -h|Print a summary of the command-line options
     3789|--import logfile ...|A file name before this option is treated as an existing dive log, everything after is imported into the existing dive log
     3790|--verbose|Print debug information while running _Subsurface_
     3791| -v|Print debug information while running _Subsurface_
     3792| -v -v| Print even more debug information while running _Subsurface_
     3793|--version|Prints the current version of _Subsurface_.
     3794|--survey|Opens the xref:S_UserSurvey[user survey] immediately after starting _Subsurface_
     3795|--user=<username>|Choose the xref:S_user_space[configuration space] of user <username>
     3796|--cloud-timeout=<duration>|Set the timeout for cloud connection (0 < duration < 60). This enables longer timeouts for slow Internet connections
     3797|--win32console|Create a dedicated console if needed (Windows only). Add this option before everything else
     3798|====================
    37693799
    37703800== Description of the Subsurface Main Menu items
Note: See TracChangeset for help on using the changeset viewer.