Commit ff037ef9 authored by uycyb's avatar uycyb

updated readme.md

parent a2280188
LenLab build notes
==================
# LenLab
# What is LenLab
LenLab is the software counterpart of the board used in the Etit Workshop that is scheduled in the first two terms of the Electrical Engineering course of studies at the KIT.
This repository only contains the part of the software that runs on your computer.
The board firmware isn't released as opensource at the moment.
# Currently supported board versions
This version of the software currently supports the boards versions below (listed with the supported firmware versions)
* 4.1 - Firmware version: 4.1.4
* 5.1 / 5.2 / 5.3 - Firmware version: 5.2.4
* 5.4 - Firmware version: 5.4.4
Only on boards version 5.4 with firmware version 5.4.4 and higher you will be able to use the current meassurement and the nyquistplot.
# What do you need in order to build LenLab (and some additional information)
1. A Qt installation version 5.3.1 or higher (was tested with 5.3 up to 5.5.1)
2. A installation or build of qwt (a diagram library for qt - http://qwt.sourceforge.net/ )
3. A installation or build of libusb ( http://libusb.info/ ) - A userspace wrapper for direct usb device interaction
The build process was tested on x86 Hardware with the following operating systems:
* Windows 7
* Debian 7 and 8
* Debian Testing
* Ubuntu 14.04
LenLab itself runs on the following systems (tested)
* Windows XP and higher
* Debian 7 and higher
* Ubuntu 14.04 and higher
Based on user reports you should be able to run and build LenLab on any linux distribution you can run Qt version 5 on. (Same for windows and OSX) - but no guarranty.
Below the build process is explained for Mac OSX, Linux and Windows.
If you encounter any problems with linking the libraries to LenLab you might want to adjust the library paths in the LenLab project file (LenLab.pro)
If you enconter any other problems you are free to open a issue tracker or fix the bug and create pull/merge request. But there is no guaranty that it will be processed.
# macx
project directory::
......@@ -10,12 +54,8 @@ project directory::
install
LenLab
macx
====
## qt
qt
--
Qt 5.3.2
......@@ -25,8 +65,8 @@ online installer: http://download.qt-project.org/official_releases/online_instal
no need to build
qwt
---
## qwt
qwt-6.1.1.tar.bz2
......@@ -46,8 +86,8 @@ build commands::
make
make install
libusb
------
## libusb
libusb-1.0.19.tar.bz2
......@@ -61,8 +101,8 @@ build commands::
make
make install
LenLab
------
## LenLab
QtCreator Build LenLabBuildEnv.pro
......@@ -135,22 +175,24 @@ hdiutil create -volname LenLab_20151118 -srcfolder LenLab_MacOSX/ -ov -format UD
win32
=====
# win32
qt
--
Qt 5.3.2 MinGW 32 bit
## qt
Qt 5.3.2 MinGW 32 bit (or newer )
http://qt-project.org
release: http://download.qt-project.org/official_releases/qt/5.3/5.3.2/qt-opensource-windows-x86-mingw482_opengl-5.3.2.exe
online installer: http://download.qt-project.org/official_releases/online_installers/qt-opensource-windows-x86-1.6.0-5-online.exe
have a look at the qt download page!.
no need to build
qwt
---
## qwt
qwt-6.1.1.zip
......@@ -170,8 +212,10 @@ build commands::
make
make install
libusb
------
## libusb
### build from source
libusb-1.0.19.tar.bz2
......@@ -187,47 +231,61 @@ build commands::
make
make install
Remember to adjust the prefix path!
The dll installs to install/bin (not lib)
LenLab
------
### use the provided dll
Inside the base folder you will find directory called: windows.
There's a dll called libusb-1.0.dll. LenLab will link to this dll by default.
(Have a look at the file LenLab.pro). For distribution you will have to provide this dll together with the LenLab executable.
## LenLab
QtCreator Build LenLabBuildEnv.pro
linux
=====
# linux
qt
--
Qt 5.3.1
## qt
system qt
Download a Qt Version > 5.3.1 from the Qt download area or in case your distro provides a fitting Qt Version install Qt with your package manager.
qwt
---
qwt-6.1.1.tar.bz2
## qwt
http://qwt.sourceforge.net
http://sourceforge.net/projects/qwt/files/latest/download?source=files
http://sourceforge.net/projects/qwt/files/qwt/6.1.1/qwt-6.1.1.tar.bz2/download
qwtconfig.pri::
Inside the lenlab folder is a script "installDependencies.sh". Use this script in order to checkout Qwt 6.1. You need subversion installed on your system!
unix {
QWT_INSTALL_PREFIX = /home/christoph/Workshop/install
}
Inside the base folder:
chmod +x installDependencies.sh
./installDependencies.sh
cd ext/qwt
In case you installed qt from the qt website call qmake from its installation folder. For example:
~/Qt5.4.2/5.4/gcc_64/bin/qmake qwt.pro
This path could vary on your system
In case you installed qt from the package repository of your distro use:
qmake qwt.pro
Afterwards run make in order to build qwt
make -j<n>
Replace <n> with the number of your cpu cores.
build commands::
qmake qwt.pro
make
make install
libusb
------
## libusb
### Build from source
libusb-1.0.19.tar.bz2
......@@ -237,14 +295,39 @@ http://sourceforge.net/projects/libusb/files/libusb-1.0/libusb-1.0.19/libusb-1.0
dependency libudev-dev
Remember to adjust your prefix path!
build commands::
./configure --prefix=/Users/christoph/Workshop/install
make
make install
### Install from repository
On Debian or Ubuntu run:
sudo apt-get install libusb-1.0-0-dev libusb-1.0-0
On another distro: use your package manager to search for libusb or build libusb from source.
LenLab
------
## LenLab
### With QtCreator
QtCreator Build LenLabBuildEnv.pro
### On Commandline
Inside the lenlab directory
mkdir -p build
qmake ../LenLab.pro
make -j<n>
Replace <n> with the number of your cpu cores
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment