subsurface/libdc

Subsurface version of libdivecomputer, upstream at github.com/libdivecomputer/libdivecomputer

Subsurface

Subsurface can be found at http://subsurface-divelog.org

Our user forum is at http://subsurface-divelog.org/user-forum/

Report bugs and issues at https://github.com/Subsurface/subsurface/issues

License: GPLv2

We are releasing 'nightly' builds of Subsurface that are built from the latest version of the code. Versions of this build for Windows, macOS, Android (requiring sideloading), and a Linux AppImage can be downloaded from the Latest Dev Release page on our website. Alternatively, they can be downloaded directly from GitHub. Additionally, those same versions are posted to the Subsurface-daily repos on Ubuntu Launchpad, Fedora COPR, and OpenSUSE OBS, and released to Snapcraft into the 'edge' channel of subsurface.

You can get the sources to the latest development version from the git repository:

git clone https://github.com/Subsurface/subsurface.git

You can also fork the repository and browse the sources at the same site, simply using https://github.com/Subsurface/subsurface

Additionally, artifacts for Windows, macOS, Android, Linux AppImage, and iOS (simulator build) are generated for all open pull requests and linked in pull request comments. Use these if you want to test the changes in a specific pull request and provide feedback before it has been merged.

If you want a more stable version that is a little bit more tested you can get this from the Curent Release page on our website.

Detailed build instructions can be found in the INSTALL.md file.

System Requirements

On desktop, the integrated Googlemaps feature of Subsurface requires a GPU driver that has support for at least OpenGL 2.1. If your driver does not support that, you may have to run Subsurface in software renderer mode.

Subsurface will automatically attempt to detect this scenario, but in case it doesn't you may have to enable the software renderer manually with the following:

1. Learn how to set persistent environment variables on your OS
2. Set the environment variable 'QT_QUICK_BACKEND' with the value of 'software'

Basic Usage

Install and start from the desktop, or you can run it locally from the build directory:

On Linux:

$ ./subsurface

On Mac:

$ open Subsurface.app

Native builds on Windows are not really supported (the official Windows installers are cross-built on Linux).

You can give a data file as command line argument, or (once you have set this up in the Preferences) Subsurface picks a default file for you when started from the desktop or without an argument.

If you have a dive computer supported by libdivecomputer, you can just select "Import from Divecomputer" from the "Import" menu, select which dive computer you have (and where it is connected if you need to - note that there's a special selection for Bluetooth dive computers), and click on "Download".

The latest list of supported dive computers can be found in the file SupportedDivecomputers.txt.

Much more detailed end user instructions can be found from inside Subsurface by selecting Help (typically F1). When building from source this is also available as Documentation/user-manual.html. The documentation for the latest release is also available on-line http://subsurface-divelog.org/documentation/

Contributing

There is a user forum for questions, bug reports, and feature requests: https://groups.google.com/g/subsurface-divelog

If you want to contribute code, please open a pull request with signed-off commits at https://github.com/Subsurface/subsurface/pulls (alternatively, you can also send your patches as emails to the developer mailing list).

Either way, if you don't sign off your patches, we will not accept them. This means adding a line that says "Signed-off-by: Name " at the end of each commit, indicating that you wrote the code and have the right to pass it on as an open source patch under the GPLv2 license.

See: http://developercertificate.org/

Also, please write good git commit messages. A good commit message looks like this:

Header line: explain the commit in one line (use the imperative)

Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc etc.

The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
74 characters or so. That way "git log" will show things
nicely even when it's indented.

Make sure you explain your solution and why you're doing what you're
doing, as opposed to describing what you're doing. Reviewers and your
future self can read the patch, but might not understand why a
particular solution was implemented.

Reported-by: whoever-reported-it
Signed-off-by: Your Name <[email protected]>

where that header line really should be meaningful, and really should be just one line. That header line is what is shown by tools like gitk and shortlog, and should summarize the change in one readable line of text, independently of the longer explanation. Please use verbs in the imperative in the commit message, as in "Fix bug that...", "Add file/feature ...", or "Make Subsurface..."

A bit of Subsurface history

In fall of 2011, when a forced lull in kernel development gave him an opportunity to start on a new endeavor, Linus Torvalds decided to tackle his frustration with the lack of decent divelog software on Linux.

Subsurface is the result of the work of him and a team of developers since then. It now supports Linux, Windows and MacOS and allows data import from a large number of dive computers and several existing divelog programs. It provides advanced visualization of the key information provided by a modern dive computer and allows the user to track a wide variety of data about their diving.

In fall of 2012 Dirk Hohndel took over as maintainer of Subsurface.

libdc's Issues

Android without QT bluetooth : stuck on foreach

Hello,

I'm trying to make libsubsurface work with an OSTC Sport + without Qt Bluetooth, using an Android bluetooth system instead.

I managed to set the device to "download mode" but I seem stuck inside the foreach() function.

I have taken example from qtserialbluetooth.cpp to setup the connection and callbacks.

My assumptions:

1. My device goes to "download mode" with hw_ostc3_read from hw_ostc3.c line 285.
2. hw_ostc3_read from hw_ostc3.c line 293 should create a call to my "read" event fromdc_custom_cbs_t.
3. From the read event I should call my bluetooth socket and fill the void *data with whatever was obtain from the device.
4. Then I should receive something inside my dc_dive_callback_t and start to extract dive information.

I also regularly receive data inside my "write" callback, something that looks like a keep alive for the bluetooth connection.

Are one of my assumptions wrong ?

Thank you for any future reply.

OSTC4 download dives fails with "Error parsing the header"

Hi.

From subsurface/subsurface#590

Trying to download the profiles from some trimix dives gives: "Error parsing the header" in the UI and

subsurface:~$ subsurface
[3.109370] ERROR: Invalid gas mix. [in hw_ostc_parser.c:843 (hw_ostc_parser_samples_foreach)]

Maybe it's because of this
https://user-images.githubusercontent.com/31750016/30662067-238ffc1e-9e46-11e7-8195-9307a779a135.jpg
Not sure how this happened... something with the gas change didn't work as it should (I was anyway diving after RT), and the ppO2 seems screwed up.

Any idea for a quick fix, as this blocks downloading all further new dives and I cannot write my logs now ;-)

Thanks!

Using libdc to power my arduino dive computer project

I'm wondering if people have used libdc as the algorithm backend for a dive computer? I have an arduino box reading live depth measurements and I want a robust library to take those depth measurements and instruct me with regards to deco stops, safety stops, etc.

Linker errors

I compiled v4.7.6 like this:

autoreconf --install
./configure --prefix=/app
make -j4 -l8

which resulted in the following errors:

usbhid.c: In function ‘usbhid_packet_close’:
usbhid.c:138:9: warning: implicit declaration of function ‘dc_usbhid_close’ [-Wimplicit-function-declaration]
  return dc_usbhid_close(usbhid);
         ^~~~~~~~~~~~~~~
usbhid.c: In function ‘usbhid_packet_read’:
usbhid.c:145:9: warning: implicit declaration of function ‘dc_usbhid_read’ [-Wimplicit-function-declaration]
  return dc_usbhid_read(usbhid, data, size, actual);
         ^~~~~~~~~~~~~~
usbhid.c: In function ‘usbhid_packet_write’:
usbhid.c:166:9: warning: implicit declaration of function ‘dc_usbhid_write’ [-Wimplicit-function-declaration]
  return dc_usbhid_write(usbhid, data, size, actual);
         ^~~~~~~~~~~~~~~
usbhid.c: In function ‘dc_usbhid_custom_io’:
usbhid.c:189:2: warning: implicit declaration of function ‘dc_usbhid_set_timeout’ [-Wimplicit-function-declaration]
  dc_usbhid_set_timeout(usbhid, 10);
  ^~~~~~~~~~~~~~~~~~~~~
  CC       custom.lo
  CC       custom_io.lo
  GEN      libdivecomputer.exp
  CCLD     libdivecomputer.la
ar: `u' modifier ignored since `D' is the default (see `U')
Making all in examples
  CC       common.o
  CC       dctool.o
  CC       dctool_help.o
dctool.c: In function ‘main’:
dctool.c:242:23: warning: cast discards ‘const’ qualifier from pointer target type [-Wcast-qual]
  char *argv_help[] = {(char *) "help", NULL, NULL};
                       ^
  CC       dctool_version.o
  CC       dctool_list.o
  CC       dctool_download.o
  CC       dctool_dump.o
  CC       dctool_parse.o
  CC       dctool_read.o
  CC       dctool_write.o
  CC       dctool_timesync.o
  CC       dctool_fwupdate.o
  CC       output.o
  CC       output_raw.o
  CC       output_xml.o
  CC       utils.o
  CCLD     dctool
../src/.libs/libdivecomputer.so: undefined reference to `dc_usbhid_close'
../src/.libs/libdivecomputer.so: undefined reference to `dc_usbhid_write'
../src/.libs/libdivecomputer.so: undefined reference to `dc_usbhid_set_timeout'
../src/.libs/libdivecomputer.so: undefined reference to `dc_usbhid_read'
collect2: error: ld returned 1 exit status
make[2]: *** [Makefile:432: dctool] Error 1
make[1]: *** [Makefile:479: all-recursive] Error 1
make: *** [Makefile:388: all] Error 2