Commit 8777466a7dfdfcee02cd0a91ca55aa000cf8ea68
1 parent
8dd9f05a
Delete mainpage.dox
Merged into readme
Showing
1 changed file
with
0 additions
and
61 deletions
openhantek/mainpage.dox deleted
| 1 | -/** | ||
| 2 | - | ||
| 3 | -\mainpage OpenHantek Developer Documentation | ||
| 4 | - | ||
| 5 | -\section sec_introduction Introduction | ||
| 6 | -OpenHantek is a free software for %Hantek (Voltcraft/Darkwire/Protek/Acetech) USB DSOs based on HantekDSO. The UI is written in C++/Qt 4 and uses OpenGL to draw the graphs. | ||
| 7 | - | ||
| 8 | -\section sec_compiling Compiling from source | ||
| 9 | -\subsection ssec_dependencies Dependencies | ||
| 10 | -You need the development packages for the following libraries to build OpenHantek from source: | ||
| 11 | -<ul> | ||
| 12 | - <li><a href="http://qt.nokia.com/">Qt 4</a></li> | ||
| 13 | - <li><a href="http://www.libusb.org/">libusb 1.x (or 0.1.x with LIBUSB_VERSION=0)</a></li> | ||
| 14 | - <li><a href="http://www.fftw.org/">fftw 3</a></li> | ||
| 15 | - <li><a href="http://www.opengl.org/">OpenGL</a></li> | ||
| 16 | -</ul> | ||
| 17 | - | ||
| 18 | -\subsection ssec_building Building | ||
| 19 | -After installing these you can build it by running: | ||
| 20 | -<pre> | ||
| 21 | - $ qmake | ||
| 22 | - $ make | ||
| 23 | - $ sudo make install | ||
| 24 | -</pre> | ||
| 25 | - | ||
| 26 | -\subsection ssec_options Build options | ||
| 27 | -You can set environment variables to set various build options (Done best by prepending env VARIABLE=value to the qmake command). The known environment variables are: | ||
| 28 | -<ul> | ||
| 29 | - <li> | ||
| 30 | - <b>PREFIX</b><br /> | ||
| 31 | - The installation prefix for make install. | ||
| 32 | - </li> | ||
| 33 | - <li> | ||
| 34 | - <b>LIBUSB_VERSION</b><br /> | ||
| 35 | - The version of the libusb library that should be used. You can switch into libusb 0.1 mode with LIBUSB_VERSION=0. | ||
| 36 | - </li> | ||
| 37 | -</ul> | ||
| 38 | - | ||
| 39 | -\section sec_firmware Installation of the firmware | ||
| 40 | -\subsection ssec_drivers Getting the Windows drivers | ||
| 41 | -Before using OpenHantek you have to extract the firmware from the official Windows drivers. You can get them from the <a href="http://www.hantek.ru/download.html">Hantek website</a> (<a href="http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2Fwww.hantek.ru%2Fdownload.html">English translation</a>) or automatically download them with the script fwget.sh. | ||
| 42 | -\subsection ssec_extractfw The firmware extraction tool | ||
| 43 | -You need the tool openhantek-extractfw from the sourceforge page too extract the firmware. You have to install libbfd development files and build it by typing: | ||
| 44 | -<pre> | ||
| 45 | - $ make | ||
| 46 | -</pre> | ||
| 47 | -After building it, you can just run the fwget.sh script inside the openhantek-extractfw directory: | ||
| 48 | -<pre> | ||
| 49 | - $ sudo ./fwget.sh /usr/local/share/hantek/ | ||
| 50 | -</pre> | ||
| 51 | -You can also do it manually by placing the DSO*1.SYS file into the same directory and running the built binary: | ||
| 52 | -<pre> | ||
| 53 | - $ ./openhantek-extractfw <driver file> | ||
| 54 | -</pre> | ||
| 55 | -This should create two .hex files that should be placed into /usr/local/share/hantek/. | ||
| 56 | -\subsection ssec_firmware Installing the firmware | ||
| 57 | -Copy the 90-hantek.rules file to /etc/udev/rules.d/. To load the firmware you have to install fxload.<br /> | ||
| 58 | -After restarting udev your oscilloscope should be initialized automatically after connecting it to the computer (You have to reconnect it after installing this package).<br /> | ||
| 59 | -If you can't run OpenHantek as normal user, you have too add your user to the plugdev group. | ||
| 60 | - | ||
| 61 | -**/ |