Difference between revisions of "Elphel Software Kit for Ubuntu"

From ElphelWiki
Jump to: navigation, search
(Install needed packages)
(ImageJ and Elphel plugins for imageJ)
 
(110 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
=About=
 
=About=
  
This page is a simple howto for running Elphel software on Ubuntu GNU/Linux.
+
This page is a simple howto for running Elphel software on (K)Ubuntu GNU/Linux.
  
Our software kit is tested on Ubuntu 8.04.1 and is starting to be tested with Ubuntu 8.10 (Intrepid)
+
You can download this GNU/Linux distribution freely from http://www.kubuntu.org/
  
You can download this GNU/Linux distribution freely from http://www.ubuntu.com/
+
A <font size='3'>'''[http://community.elphel.com/files/live-dvd/ Live ISO image]'''</font> with almost all the packages pre-installed (except [[Elphel_Software_Kit_for_Ubuntu#Installation_of_the_source_code_of_Elphel_camera_software|Elphel camera source]] code and [[Elphel_Software_Kit_for_Ubuntu#Installing_Xilinx_WebPack_.28to_be_moved_to_a_separate_page.2C_just_a_link_here.29|Xilinx ISE WebPack]]) is available for downloading from [http://community.elphel.com/files/live-dvd/ here]:
 +
* [http://community.elphel.com/files/live-dvd/kubuntu-elphel-3.iso kubuntu-elphel-3.iso] is based on Kubuntu 9.10 LTS.
 +
* [http://community.elphel.com/files/live-dvd/kubuntu-elphel-4.iso kubuntu-elphel-4.iso] is based on Kubuntu 12.04 LTS.
  
<!--''Update: instructions below are updated for the [http://www.kubuntu.org Kubuntu 9.4] , should work with Ubuntu 9.4 also --[[User:Andrey.filippov|Andrey.filippov]] 02:52, 24 May 2009 (CDT)'' -->
 
  
 
=If you are new to GNU / Linux=
 
=If you are new to GNU / Linux=
Line 22: Line 23:
 
=User software=
 
=User software=
  
Some software need to be patched and recompiled even if they exist in Ubuntu software repositories, some softwares are not yet packaged in Ubuntu, so you have to compile them from sources also. We try to push our software patches to the mainstream applications, but it take time and is not always possible.
+
Some software need to be patched and recompiled even if they exist in Ubuntu software repositories, some softwares are not yet packaged in Ubuntu, so you have to compile them from sources also. We try to push our software patches to the mainstream applications, but it take time and is not always possible. For Ubuntu users some packages can be downloaded and upgraded using our [https://launchpad.net/~elphel/+archive/ppa ppa on launchpad].
  
 +
sudo add-apt-repository "deb http://ppa.launchpad.net/elphel/ppa/ubuntu natty main"
 +
sudo apt-get update
 +
 +
==Mplayer - Ubuntu 9.10 or later==
 +
'''Kubuntu 9.10 includes MPlayer that is working with Elphel camera "out of the box"'''
 +
So for (K)Ubuntu 9.10 you just need to install
 +
sudo apt-get install mplayer-nogui mplayer gecko-mediaplayer
 +
 +
===Mplayer - installation for (K)Ubuntu older than 9.10 release ===
 +
 +
With the previous verions MPlayer has to be patched and recompiled, following instructions document how to do it on (K)Ubuntu or Debian based workstation.
 +
 +
Install gecko-mediaplayer before compiling/installing MPlayer, if you do it later it will install non-patched version of MPlayer
 +
 +
sudo apt-get install gecko-mediaplayer
  
==Mplayer==
 
As for now MPlayer have to be patched and recompiled we document here the most simple way to do it on an Ubuntu or Debian based workstation.
 
  
 
First install some compilation dependencies, mainly libraries...
 
First install some compilation dependencies, mainly libraries...
Line 42: Line 56:
  
 
  sudo apt-get install build-essential debhelper libncurses5-dev libesd0-dev liblircclient-dev libgtk2.0-dev \
 
  sudo apt-get install build-essential debhelper libncurses5-dev libesd0-dev liblircclient-dev libgtk2.0-dev \
  libvorbis-dev libsdl1.2-dev sharutils libasound2-dev liblzo-dev gawk libjpeg62-dev libaudiofile-dev \
+
  libvorbis-dev libsdl1.2-dev sharutils libasound2-dev gawk libjpeg62-dev libaudiofile-dev \
  libsmbclient-dev libxv-dev libpng12-dev libgif-dev libcdparanoia-dev libxvidcore4-dev libdv4-dev \
+
  libsmbclient-dev libxv-dev libpng12-dev libgif-dev libcdparanoia-dev libdv4-dev \
  liblivemedia-dev libfreetype6-dev em8300-headers libgl1-mesa-dev libdvdread-dev libdts-dev libtheora-dev \
+
  liblivemedia-dev libfreetype6-dev libgl1-mesa-dev libdvdread-dev libdts-dev libtheora-dev \
 
  libglu1-mesa-dev libfontconfig-dev libxxf86dga-dev libxinerama-dev libxxf86vm-dev \
 
  libglu1-mesa-dev libfontconfig-dev libxxf86dga-dev libxinerama-dev libxxf86vm-dev \
 
  libxvmc-dev libggi2-dev libmpcdec-dev libspeex-dev libfribidi-dev libfaac-dev  libaa1-dev libcaca-dev \
 
  libxvmc-dev libggi2-dev libmpcdec-dev libspeex-dev libfribidi-dev libfaac-dev  libaa1-dev libcaca-dev \
Line 50: Line 64:
 
  libopenal-dev libjack-dev libtwolame-dev libsvga1-dev libenca-dev libmp3lame-dev
 
  libopenal-dev libjack-dev libtwolame-dev libsvga1-dev libenca-dev libmp3lame-dev
  
 
This command line detects if you are running on 64 bit version of GNU/Linux and conditionally installs '''ia64-libs'''. That library is needed if you'll install Xilinx WebPack software (Xilinx does not allow to use 64-bit programs in their free for download software and the provided installation script does not install 32-bit version on its own). There is [http://ubuntuforums.org/showthread.php?t=203459 another trick] you'll need to be aware of if you are using 32-bit Xilinx WebPack on a 64-bit GNU/Linux system.
 
if [ `uname -m` = "x86_64" ] ; then sudo apt-get install ia32-libs ; fi
 
  
 
<!--
 
<!--
Line 76: Line 87:
 
Configure, compile and prepare Debian package from that source (will take some time):
 
Configure, compile and prepare Debian package from that source (will take some time):
 
  cd mplayer
 
  cd mplayer
  sudo dpkg --install mplayer_1.0~rc2-0ubuntu*.deb
+
  sudo dpkg-buildpackage
Now install the created package
+
Occasionally dpkg-buildpackage fails to build, try the comon ./configure, make, make install way then.
 +
 
 +
Now uninstall the default Ubuntu's mplayer and mencoder & install the created package:
 +
sudo apt-get remove mplayer mencoder mplayer-nogui
 
  cd ..
 
  cd ..
 
  sudo dpkg  --install mplayer_1.0svn*.deb
 
  sudo dpkg  --install mplayer_1.0svn*.deb
  
 +
===MPlayer - testing with Elphel camera ===
 
You should be able now to play videos with up to 5MB frames (highest quality 5MPix images are around 1 MB) as a multicast or unicast video stream. (the streamer in the camera should be ENABLED)
 
You should be able now to play videos with up to 5MB frames (highest quality 5MPix images are around 1 MB) as a multicast or unicast video stream. (the streamer in the camera should be ENABLED)
 
  mplayer rtsp://192.168.0.9:554 -vo x11 -fs -zoom
 
  mplayer rtsp://192.168.0.9:554 -vo x11 -fs -zoom
 +
 +
''Update 10/09/2009: In (K)Ubuntu 9.10 (Karmic Koala) repository the '''50,000 bytes limit on the frame size''' is fixed, but unfortunately the [https://bugs.launchpad.net/ubuntu/+source/mplayer/+bug/296488 other one -'''frame width limit of 2048 pixels'''] (submitted to MPlayer SVN on May, 5, 2009) - is not''--[[User:Andrey.filippov|Andrey.filippov]] 19:03, 9 October 2009 (CDT)
 +
 +
The first (50,000) makes you picture break after the first 50,000 bytes (only top is shown), the second (current for the 9.10) makes MPlayer to report fatal error. So you still have to use MPlayer SVN to have the full resolution from Elphel cameras.
 +
 +
Additionally, to make MPlayer work inside the web page you need to specify video output as "x11" in the [http://howto.wikia.com/wiki/Howto_configure_MPlayer MPlayer config file] - add a line
 +
vo="x11"
 +
To ~/.mplayer/config file
  
 
=For developers=
 
=For developers=
 +
''Following was written for (K)Ubuntu 9.10 and earlier, it also works with 10.04, please see revision-specific notes.''
  
 
==Adding universe and multiverse sources==
 
==Adding universe and multiverse sources==
Line 99: Line 123:
 
  sudo apt-get install cvs build-essential autoconf flex byacc bison libglib2.0-dev tcl gettext libncurses5-dev patch zlib1g-dev nfs-kernel-server bash xutils-dev
 
  sudo apt-get install cvs build-essential autoconf flex byacc bison libglib2.0-dev tcl gettext libncurses5-dev patch zlib1g-dev nfs-kernel-server bash xutils-dev
 
Suggested packages:
 
Suggested packages:
  sudo apt-get install kinfocenter minicom firefox graphviz doxygen kdevelop ctags cervisia php5 php5-cli gecko-mediaplayer xchat ssh kompare # gecko-mediaplayer should be installed before mplayer as it installes the unpatched one
+
  sudo apt-get install kinfocenter minicom firefox graphviz doxygen ctags cervisia php5 php5-cli xchat ssh kompare git-core
 +
 
 +
==Configure your NFS server==
 +
 
 +
Let's say you want to configure an NFS server on your machine and your IP address is '''192.168.0.15'''.
 +
 
 +
<!--Edit /etc/exports file with your favorite editor. Here I use nano.
 +
sudo nano -w /etc/exports
 +
alternatively you may edit the same file with kate
 +
Those who know how to use nano will figure that out themselves --[[User:Andrey.filippov|Andrey.filippov]] 18:09, 23 May 2009 (CDT)
 +
-->
 +
Modify the configuration file:
 +
kdesudo kate /etc/exports
 +
Add at the end of the file:
 +
/nfs            192.168.0.0/255.255.0.0(rw,sync,no_root_squash,no_subtree_check)
 +
save the file.
  
 +
If it does not yet exist make /nfs directory and make it world writable to make it possible to write logs from the camera.
 +
sudo mkdir /nfs
 +
sudo chmod 777 -R /nfs
 +
 +
And finally export the filesystem.
 +
sudo exportfs -a
 +
 +
(Had to reboot after in ubuntu 14.04)
 +
 +
== Installation of GCC Compiler kit for Axis ETRAX processor ==
 +
=== Automatic Installation ((K)Ubuntu 11.04 Natty Narwhal)===
 +
1.
 +
sudo add-apt-repository "deb http://ppa.launchpad.net/elphel/ppa/ubuntu natty main"
 +
 +
(The line above is equivalent to adding the following lines to your sources.list ('''sudo kate /etc/apt/sources.list''')):
 +
deb http://ppa.launchpad.net/elphel/ppa/ubuntu natty main
 +
deb-src http://ppa.launchpad.net/elphel/ppa/ubuntu natty main
 +
 +
2. (in case of) ...public key is not available...
 +
 +
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 6050780EC7A72F76
 +
 +
3.
 +
sudo apt-get update
 +
sudo apt-get install cris-dist
 +
 +
=== Manual Installation ===
 +
====Downloading and unpacking  gcc-cris====
 
Download and install Cris-GCC compiler. It is needed to compile C and C++ programs for the CPU used in Elphel cameras - [http://en.wikipedia.org/wiki/ETRAX_CRIS Axis ETRAX FS] :
 
Download and install Cris-GCC compiler. It is needed to compile C and C++ programs for the CPU used in Elphel cameras - [http://en.wikipedia.org/wiki/ETRAX_CRIS Axis ETRAX FS] :
  cd ~/download ; mkdir axis ; cd axis
+
  mkdir -p ~/Downloads/axis ; cd ~/Downloads/axis
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-linux-headers-1.64.tar.gz   
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-linux-headers-1.64.tar.gz   
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-linux-headersv32-1.64.tar.gz   
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-linux-headersv32-1.64.tar.gz   
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-glibc-1.64.tar.gz  
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-glibc-1.64.tar.gz  
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-1.64.tar.gz
 
  wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-1.64.tar.gz
 +
wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-1.64-1--1.64-2.patch
 
  tar zxvf cris-dist-1.64.tar.gz
 
  tar zxvf cris-dist-1.64.tar.gz
 
  cd cris-dist-1.64/
 
  cd cris-dist-1.64/
Line 112: Line 180:
 
  tar zxvf ../cris-dist-linux-headersv32-1.64.tar.gz                             
 
  tar zxvf ../cris-dist-linux-headersv32-1.64.tar.gz                             
 
  tar zxvf ../cris-dist-glibc-1.64.tar.gz
 
  tar zxvf ../cris-dist-glibc-1.64.tar.gz
 +
patch -p0 < ../cris-dist-1.64-1--1.64-2.patch
  
Unfortunately CRIS compiler does not compile with GCC 4.3.x and the only know working solution would be to temporary downgrade the compiler. You'll rather upgrade it back to the current one after gcc-cris is built:
+
==== Compiling gcc-cris ====
 +
Now you may proceed with compiling gcc-cris (takes some time):
 +
                                       
 +
sudo ./install-cris-tools
 +
answer by default (enter, enter, ...)
 +
 
 +
<!--
 +
Don't forget to export the path to the cris-compiler - the defaul location is /usr/local/cris, as example
  
  sudo apt-get remove gcc
+
  tobias@MoonbaseAlphaOne:~$ export PATH=$PATH:/usr/local/cris/bin
  
See what other packages are removed as being dependent on GCC. You may copy that list an re-install them later with "sudo apt-get install ''list of removed packages''
+
If everything worked out well, you can check the compiler version with
  
  sudo apt-get install gcc-4.2 g++-4.2 \
+
  gcc-cris --version
sudo ln -sf /usr/bin/gcc-4.2 /usr/bin/gcc \
 
sudo ln -sf /usr/bin/g++-4.2 /usr/bin/g++ \
 
sudo ln -sf /usr/bin/gcc-4.2 /usr/bin/cc
 
  
You may verify the current GCC version (make sure it is 4.2.x) with the following command:
+
Which should result in an output like this one (example, might vary with version)
gcc --version
 
  
Now you may proceed with compiling gcc-cris (takes some time):
+
cris-axis-elf-gcc (GCC) 3.2.1 Axis release R64/1.64
                                       
+
Copyright (C) 2002 Free Software Foundation, Inc.
  sudo ./install-cris-tools
+
This is free software; see the source for copying conditions.  There is NO
answer by default (enter, enter, ...)
+
  warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 +
-->
 +
 
 +
== Build Elphel Software==
 +
Get the [http://sourceforge.net/projects/elphel/files/elphel353-8/install-8.0-fromcvs/elphel353_80_install_from_cvs.sh.tar.gz/download script]. Unpack & Launch.
 +
 
 +
 
 +
== Installation of Kdevelop 3.5 ==
 +
''note: Newer KDevelop 4 does not work with Elphel software''
 +
==== pre (K)Ubuntu 9.10 ====
 +
sudo apt-get install kdevelop
  
If everything finished OK you may reinstall the GCC back (and add other packages you may have removed):
+
==== (K)Ubuntu 9.10 (Karmic), 10.4 (Lucid) ====
  sudo apt-get install build-essential g++ gcc
+
  see [[KDevelop#Installation_of_KDevelop_3.5_on_.28K.29Ubuntu_9.10|Installation of KDevelop 3.5 on (K)Ubuntu 9.10]]
  
 
== Install Icarus Verilog and GTKWave ==
 
== Install Icarus Verilog and GTKWave ==
Line 142: Line 224:
  
 
But unfortunately Icarus Verilog (package verilog) is compiled without needed support for compressed output format, so you'll have to compile it
 
But unfortunately Icarus Verilog (package verilog) is compiled without needed support for compressed output format, so you'll have to compile it
  wget "ftp://ftp.icarus.com/pub/eda/verilog/snapshots/verilog-20081118.tar.gz"
+
cd ~/Downloads
  tar zxvf verilog-20081118.tar.gz
+
  wget "ftp://ftp.icarus.com/pub/eda/verilog/v0.9/verilog-0.9.3.tar.gz"
  cd verilog-20081118/
+
  tar zxvf verilog-0.9.3.tar.gz
 +
  cd verilog-0.9.3/
 
  ./configure
 
  ./configure
 
  make
 
  make
 
  sudo make install
 
  sudo make install
  
==Configure your NFS server==
+
== Installing Xilinx WebPack (to be moved to a separate page, just a link here)==
 +
If you plan to compile the FPGA code from the source code you will need to install appropriate software from the FPGA manufacturer web site. This is proprietary (and non-free) software provided by [http://www.xilinx.com Xilinx] free of charge. This software is called the [http://www.xilinx.com/tools/webpack.htm ISE WebPACK] and you may download it (currently some 2.2GB) after registering at Xilinx web site. Currently tested version is 10.1.03, we'll try to update our code when Xilinx will release the new version of their software.
 +
 
 +
You will also need that software if you would like to simulate the FPGA functionality. Elphel camera FPGA code (written in Verilog HDL) is  licensed under GNU GPLv3, simulator and waveform viewer (see below) are also Free Software, but there are a few Verilog models of some primitives of Xilinx FPGA that are not and can be only obtained from Xilinx as a part of their unisims library. For simulation we use small subset of the unisims library components and only for functional simulation so it will probably make sense to re-write those primitives models so the 2.2 GB distribution will not be needed to extract just few kilobytes of required source code.
  
Let's say you want to configure an NFS server on your machine and your IP address is '''192.168.0.15'''.
+
Such independent re-implementation will help us to solve another problem - we have to patch the Xilinx library components to make them work correctly with our code and the simulator we use and currently each Xilinx library update breaks our patches.
  
<!--Edit /etc/exports file with your favorite editor. Here I use nano.
+
When you will build Elphel software (as described later) the installation script will try to locate Xilinx software on your computer and patch a copy of unisims library. If you'll install Xilinx WebPack after building the camera software - you'll need to navigate to ''fpga'' subdirectory of the source tree and execute
sudo nano -w /etc/exports
+
  make clean ; make
alternatively you may edit the same file with kate
+
It is described in file ''README.simulation'' in that subdirectory.
Those who know how to use nano will figure that out themselves --[[User:Andrey.filippov|Andrey.filippov]] 18:09, 23 May 2009 (CDT)
 
-->
 
Modify the configuration file:
 
kdesudo kate /etc/exports
 
Add at the end of the file:
 
  /nfs            192.168.0.0/255.255.0.0(rw,sync,no_root_squash)
 
save the file.
 
  
If it does not yet exist make /nfs directory and make it world writable to make it possible to write logs from the camera.
 
sudo mkdir /nfs
 
sudo chmod 777 -R /nfs
 
  
And finally export the filesystem.
+
There are additional steps required for the Xilinx WebPACK installation if you have a 64-bit GNU/Linux operation system. The next command line detects if you are running on 64 bit version of GNU/Linux and conditionally installs '''ia64-libs'''. That library is needed if you'll install Xilinx WebPack software (Xilinx does not allow to use 64-bit programs in their free for download software and the provided installation script does not install 32-bit version on its own). There is [http://ubuntuforums.org/showthread.php?t=203459 another trick] you'll need to be aware of if you are using 32-bit Xilinx WebPack on a 64-bit GNU/Linux system.
  sudo exportfs -a
+
  if [ `uname -m` = "x86_64" ] ; then sudo apt-get install ia32-libs ; fi
  
==Install sources of Elphel camera==
+
==Installation of the source code of Elphel camera software==
  
===CVS===
+
You may install Elphel source code by either of the two methods. Either from the CVS (the most current code) and form the tarball files.
 +
===Installation from the CVS===
  
 
Get [http://downloads.sourceforge.net/elphel/elphel353_80_install_from_cvs.sh.tar.gz elphel353_80_install_from_cvs.sh] open archive that contains the shell script and execute it. It is recommended that you create subdirectory in your home directory, i.e. "elphel_projects", move and execute elphel353_80_install_from_cvs.sh script there. Directory "distfiles" will be created there and used as a cache for software archives that will be downloaded during installation.
 
Get [http://downloads.sourceforge.net/elphel/elphel353_80_install_from_cvs.sh.tar.gz elphel353_80_install_from_cvs.sh] open archive that contains the shell script and execute it. It is recommended that you create subdirectory in your home directory, i.e. "elphel_projects", move and execute elphel353_80_install_from_cvs.sh script there. Directory "distfiles" will be created there and used as a cache for software archives that will be downloaded during installation.
  
===Release===
+
mkdir -p ~/elphel_projects; cd ~/elphel_projects
 +
wget "http://downloads.sourceforge.net/elphel/elphel353_80_install_from_cvs.sh.tar.gz"
 +
tar zxvf elphel353_80_install_from_cvs.sh.tar.gz
 +
./elphel353_80_install_from_cvs.sh
 +
 
 +
===Installation from the tarball (release file)===
 
http://sourceforge.net/projects/elphel
 
http://sourceforge.net/projects/elphel
  
* get one of the elphel353-7.1 or elphel353-8.0 releases
+
* get one of the elphel353-8.0.* releases
 
* decompress the archive
 
* decompress the archive
 
* execute the ./install_elphel script
 
* execute the ./install_elphel script
 
  ./install_elphel
 
  ./install_elphel
  
 +
There will be created a file build.log in the top installation directory. If you get any installation problems you can compress that file and email it to Elphel support.
  
 +
At the end of installation the script will generate a list of all the files in the target (camera) file system that are to be installed and compares it against the contents of the file ''target.list'' that is included in the distribution. If there are any differences -- they will be reported (there should be none). If there are some missing files it is likely that something failed to install correctly.
  
In Ubuntu 8.10 there can be an error like '''''(update - solved with installation xutils-dev for 'makedep' utility at 8.10)''''':
+
After the installation will be completed successfully you may want to execute the following command in the top installation directory (the one that has apps, configure-files, ... subdirectories)
  *** No rule to make target `../../include/openssl/idea.h', needed by `hmac.o'.
+
  ./prep_kdevelop.php
  
The solution is to create a link:
+
That will create ''elphel353.kdevelop'' - a project file for KDevelop IDE  (version 3.5.x), you can use it as described here - [[KDevelop]]
cd /cvs_sync/elphel353-7.1.8/elphel353-7.1/apps/crypto/openssl-IR0_9_7f-3/openssl/include/openssl
 
ln -s ../../crypto/idea/idea.h
 
  
==Elphel SDK==
 
  
We provide our clients with a complete SDK to develop software, FPGA code and even to redesign the hardware.
+
----
  
===PHP===
+
== ImageJ and Elphel plugins for imageJ ==
*[[PHP in Elphel cameras]]
+
ImageJ is a powerful open source image processing package, written in Java. There are plugins to work with Elphel cameras, the most universal one allows opening JP46 files (stored on a file system or downloaded directly from the camera). This plugin reads meta data from the image and un-applies in-camera non-linear conversion resulting in the linearized image, where each pixel is represented by a floating point value proportional to the number of photons that were detected in that pixel.
*[[Elphel PHP constants]]
 
*[[PHP Examples]]
 
  
===KDevelop IDE===
+
It is a very useful tool to do quantitative analysis of the camera images.
*[[KDevelop]] IDE
 
*work in progress [[KDevelop]] integration with GTKWave & Icarus.
 
  
===FPGA Development in Elphel cameras===
+
* Download plugins:
*[[FPGA Development in Elphel cameras]] is the page to read if you want to install Xilinx tools to do some FPGA development.
+
git clone https://git.elphel.com/Elphel/imagej-elphel.git
*iverilog
+
git clone --branch v1.1 https://git.elphel.com/Elphel/imagej-elphel.git (for Eyesis4Pi393)
*GTKWave
+
* Download [http://www.eclipse.org/downloads/ Eclipse IDE for Java EE Developers] or any other with Maven integration
 +
* Edit ''eclipse.ini'':
 +
-clean -startup
 +
...
 +
-XX:MaxPermSize=24576m
 +
-Xms2048m
 +
-Xmx24576m
 +
* Kubuntu 18.04 might need:
 +
https://stackoverflow.com/questions/6784463/error-trustanchors-parameter-must-be-non-empty
 +
* From Eclipse:
 +
1. File -> Import -> Existing Maven Projects -> set imagej-elphel as Root Directory - a project will appear in the project list -> Finish
 +
    Importing will take some time
 +
 +
2. Create Run Configuration:
 +
    a. Run Configurations -> select Java Application -> New Launch Configuration -> find the needed plugin class -> Run
 +
        Classes:
 +
        * '''Aberration_Calibration''' - work with calibration data, regenerate kernels, etc.
 +
        * '''Eyesis_correction''' - postprocess images.
 +
    b. It will launch ''ImageJ & Aberration_Calibration plugin''
 +
    c. Other plugins are launched from ImageJ window from Plugins
  
= EeeBox (K)Ubuntu 8.10 installation =
+
<!--
 +
=== ImageJ installation ===
 +
You may download ImageJ bundled with Java from the [http://rsbweb.nih.gov/ij/download.html download page]:
  
=== ACPI configuration ===
+
==== With 32-bit Java ====
 +
cd ~/Downloads; wget "http://rsbweb.nih.gov/ij/download/linux/ij147-linux32.zip" ; unzip ij147-linux32.zip
  
EeeBox will suspend and freeze after some time w/o any activity on it, so it's better to turn off suspend. Run this script at this new folder with ''root'' privileges (for example, put text to ''go'' file, make that file executable '''chmod a+x go''', and run with sudo '''sudo ./go'''):
+
cd ~/Downloads; wget "http://rsbweb.nih.gov/ij/download/linux/ij149-linux64.zip" ; unzip ij149-linux64.zip
  
  #!/bin/sh
+
'''If any of the two direct download links above are broken, please use the [http://rsbweb.nih.gov/ij/download.html] to get the new ImageJ version'''
 
 
  # patch ACPI config to turn off suspend
 
 
 
  patch -N /etc/default/acpi-support << 'EOP'
 
  --- a  2008-12-31 00:40:41.000000000 +0200
 
  +++ acpi-support        2008-12-31 00:40:08.000000000 +0200
 
  @@ -56,7 +56,7 @@
 
  # Please specify a space separated list of options. The recommended value is
 
  # "dbus pm-utils"
 
  #
 
  -SUSPEND_METHODS="dbus-pm dbus-hal pm-utils"
 
  +SUSPEND_METHODS=""
 
 
 
 
 
 
 
  @@ -69,10 +69,10 @@
 
  #
 
 
 
  # Comment the next line to disable ACPI suspend to RAM
 
  -ACPI_SLEEP=true
 
  +#ACPI_SLEEP=true
 
 
 
  # Comment the next line to disable suspend to disk
 
  -ACPI_HIBERNATE=true
 
  +#ACPI_HIBERNATE=true
 
 
 
  # Change the following to "standby" to use ACPI S1 sleep, rather than S3.
 
  # This will save less power, but may work on more machines
 
  EOP
 
 
 
  # and apply changes
 
  /etc/init.d/acpi-support restart
 
  /etc/init.d/acpid restart
 
  
=== Network configuration ===
+
===Running ImageJ ===
 +
There is "run" command the newly crated directory. You may start ImageJ with the following command:
 +
/Downloads/ImageJ/run
 +
That command allows Java to use 512M of system memory. If you need more you can change "512" to say "1024" in a single-line "run" script. If the run command is started from the command prompt, you'll be able to see some debug output - either from existent plugins or from your own ones. It is also very useful to see any error diagnostic output.
  
''Please, someone, have a look how to configure network at Kubuntu 8.10 - I have bad luck with that. The main idea is: setup WiFi for internet, and local interface for local network to work with camera. Possible problem: Oleg told me what with POE adapter, not POE switch (as I do) local network will not work - network manager shut down eth0 every time when contact is lost, for example, when cable disconnected from the camera for reflash with button (this used with prod353 system).''
+
=== Installation of Elphel plugins for ImageJ ===
 +
Elphel plugins are available in Elphel project page Git repository. To use it you first need to install git (if it was not already done):
 +
sudo apt-get install git-core
  
=== GCC-CRIS cross-compiler installation ===
+
Then clone the repository - directly to the ImageJ plugins directory. Provided you used the same directory for ImageJ as written above:
 +
cd  ~/Downloads/ImageJ/plugins
 +
old url:  git clone git://elphel.git.sourceforge.net/gitroot/elphel/ImageJ-Elphel
 +
git clone git://git.code.sf.net/p/elphel/ImageJ-Elphel
  
Make a directory where you will build cross-compiler and store sources of it, and run this script at this new folder with ''root'' privileges (for example, put text to ''go'' file, make that file executable '''chmod a+x go''', and run with sudo '''sudo ./go'''):
+
=== Updating Elphel plugins for ImageJ ===
 
+
Later, when you'll need to update your files from the repository you will need another command:
  #!/bin/sh
+
cd ~/Downloads/ImageJ/plugins/ImageJ-Elphel
 
+
git pull
  # install packages to build cross-compiler
+
=== Running Elphel plugin for ImageJ ===
  apt-get install build-essential gcc-4.2 g++-4.2 xutils-dev libncurses5-dev autoconf automake byacc bison zlib1g-dev patch cvs gettext
+
When you just install Elphel plugins you need to select
 
+
~/Downloads/ImageJ/plugins/ImageJ-Elphel/JP46_Reader_camera.java
  # create links to GCC-4.2
+
That command will do exactly as it is named - first compile that source file to the Java bytecode, then execute it. Next time after you close and re-start ImageJ there will be a submenu in Plugins: Plugins->ImageJ-Elphel and JP46_Reader_camera command there,
  rm /usr/bin/gcc
 
  rm /usr/bin/g++
 
  ln -s /usr/bin/gcc-4.2 /usr/bin/gcc
 
  ln -s /usr/bin/g++-4.2 /usr/bin/g++
 
 
 
  # download sources - if links are broken, check developer.axis.com
 
  wget -c http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/old/cris-dist-1.64.tar.gz
 
  wget -c http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/old/cris-dist-glibc-1.64.tar.gz
 
  wget -c http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/old/cris-dist-linux-headers-1.64.tar.gz
 
  wget -c http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/old/cris-dist-linux-headersv32-1.64.tar.gz
 
 
 
  # unarch that
 
  tar -xvf cris-dist-1.64.tar.gz
 
  cd cris-dist-1.64
 
  cp ../cris-dist-glibc-1.64.tar.gz ./
 
  tar -xvf cris-dist-glibc-1.64.tar.gz
 
  cp ../cris-dist-linux-* ./
 
  tar -xvf cris-dist-linux-headers-1.64.tar.gz
 
  tar -xvf cris-dist-linux-headersv32-1.64.tar.gz
 
 
 
  # build and install - agree with all questions, at the finish also
 
  ./install-cris-tools
 
 
 
  # delete build directory - we don't need it anymore
 
  cd ..
 
  rm -R cris-dist-1.64
 
 
 
  # restore host GCC links - out of the box, Ubuntu 8.10 use GCC-4.3 as default
 
  rm /usr/bin/gcc
 
  rm /usr/bin/g++
 
  ln -s /usr/bin/gcc-4.3 /usr/bin/gcc
 
  ln -s /usr/bin/g++-4.3 /usr/bin/g++
 
 
 
  # it's all, cross-compiler was installed; but while we still root, install packages needed to build firmware here
 
  apt-get install libglib2.0-dev pkg-config flex gettext tcl8.5
 
 
 
=== NFS installation and configuration ===
 
 
 
Before firmware build, we should install and configure NFS, because firmware build process will put firmware images in to it for remote (and local) camera reflashing. <!-- Run this script with ''root'' privileges: see discussion tab-->
 
 
 
  sudo apt-get install nfs-kernel-server
 
  sudo mkdir /nfs
 
  # mkdir /nfs/elphel353-2.10 # not used in 8.0
 
  sudo chmod -R a+r /nfs
 
  sudo chmod -R a+w /nfs
 
  sudo echo "/nfs 192.168.0.0/24(rw,async)" >> /etc/exports
 
  sudo /etc/init.d/nfs-kernel-server restart
 
 
 
=== build firmware ===
 
 
 
=== other steps ===
 
 
 
...to be continued - network setup, Firefox,KDeveloper,MPlayer installation...
 
  
 +
When you'll update the source files, you 'll need to re-run "Compile and run...". meanwhile just use the item in Plugins->ImageJ-Elphel menu.
 +
-->
  
[[Category:Operating Systems]]
+
[[Category:353]]
[[Category:Software]]
 

Latest revision as of 13:31, 4 June 2018

About

This page is a simple howto for running Elphel software on (K)Ubuntu GNU/Linux.

You can download this GNU/Linux distribution freely from http://www.kubuntu.org/

A Live ISO image with almost all the packages pre-installed (except Elphel camera source code and Xilinx ISE WebPack) is available for downloading from here:


If you are new to GNU / Linux

Many forums and wikis are available in many languages to help you to install and use Ubuntu. Ex: http://www.google.com/search?q=forum+ubuntu (you can add "&hl=fr" or any language code to the URL)

Most instructions below are commands that you need to enter in the in the terminal window. For the lines that do not end with "\" sign you just copy them one-by-one and paste in the terminal window (in KDE it is Konsole in the "System" menu). For pasting you can not use <cntrl-V> - you need to right-click in the terminal window and select "Paste" from the drop-down context menu. Alternatively you can use the middle mouse button to both copy (drag while middle mouse pressed) and paste - click it in the console window.

Character "\" at the end of the line means continuation, so you can copy the whole block of text where each line but the very last ends with "\" and paste them together.

Many of the commands start with "sudo" - first time system will ask you for your user password that you enter without any starts (provided you have administrative privileges).

If you get some problems it is very useful to copy the error message that system outputs (avoiding anything specific to your particular installation - like user directories names) and paste them into the search box of you browser.

User software

Some software need to be patched and recompiled even if they exist in Ubuntu software repositories, some softwares are not yet packaged in Ubuntu, so you have to compile them from sources also. We try to push our software patches to the mainstream applications, but it take time and is not always possible. For Ubuntu users some packages can be downloaded and upgraded using our ppa on launchpad.

sudo add-apt-repository "deb http://ppa.launchpad.net/elphel/ppa/ubuntu natty main"
sudo apt-get update

Mplayer - Ubuntu 9.10 or later

Kubuntu 9.10 includes MPlayer that is working with Elphel camera "out of the box" So for (K)Ubuntu 9.10 you just need to install

sudo apt-get install mplayer-nogui mplayer gecko-mediaplayer

Mplayer - installation for (K)Ubuntu older than 9.10 release

With the previous verions MPlayer has to be patched and recompiled, following instructions document how to do it on (K)Ubuntu or Debian based workstation.

Install gecko-mediaplayer before compiling/installing MPlayer, if you do it later it will install non-patched version of MPlayer

sudo apt-get install gecko-mediaplayer


First install some compilation dependencies, mainly libraries...


sudo apt-get install build-essential debhelper libncurses5-dev libesd0-dev liblircclient-dev libgtk2.0-dev \
libvorbis-dev libsdl1.2-dev sharutils libasound2-dev gawk libjpeg62-dev libaudiofile-dev \
libsmbclient-dev libxv-dev libpng12-dev libgif-dev libcdparanoia-dev libdv4-dev \
liblivemedia-dev libfreetype6-dev libgl1-mesa-dev libdvdread-dev libdts-dev libtheora-dev \
libglu1-mesa-dev libfontconfig-dev libxxf86dga-dev libxinerama-dev libxxf86vm-dev \
libxvmc-dev libggi2-dev libmpcdec-dev libspeex-dev libfribidi-dev libfaac-dev  libaa1-dev libcaca-dev \
libx264-dev  libpulse-dev libmad0-dev ladspa-sdk libdbus-glib-1-dev libaudio-dev liblzo2-dev libdvdnav-dev \
libopenal-dev libjack-dev libtwolame-dev libsvga1-dev libenca-dev libmp3lame-dev


Current MPlayer code is capable of working with full resolution video produced by Elphel cameras. That is not yet true for the MPlayer packages in Ubuntu repositories, so you'll have to obtain the source code from MPlayer recommended source - their Subversion (SVN) source. First you need to install Subversion itself:

sudo apt-get install subversion

Now create a download directory and get MPlayer source:

mkdir download; cd download
svn checkout svn://svn.mplayerhq.hu/mplayer/trunk mplayer

Configure, compile and prepare Debian package from that source (will take some time):

cd mplayer
sudo dpkg-buildpackage 

Occasionally dpkg-buildpackage fails to build, try the comon ./configure, make, make install way then.

Now uninstall the default Ubuntu's mplayer and mencoder & install the created package:

sudo apt-get remove mplayer mencoder mplayer-nogui
cd ..
sudo dpkg  --install mplayer_1.0svn*.deb

MPlayer - testing with Elphel camera

You should be able now to play videos with up to 5MB frames (highest quality 5MPix images are around 1 MB) as a multicast or unicast video stream. (the streamer in the camera should be ENABLED)

mplayer rtsp://192.168.0.9:554 -vo x11 -fs -zoom

Update 10/09/2009: In (K)Ubuntu 9.10 (Karmic Koala) repository the 50,000 bytes limit on the frame size is fixed, but unfortunately the other one -frame width limit of 2048 pixels (submitted to MPlayer SVN on May, 5, 2009) - is not--Andrey.filippov 19:03, 9 October 2009 (CDT)

The first (50,000) makes you picture break after the first 50,000 bytes (only top is shown), the second (current for the 9.10) makes MPlayer to report fatal error. So you still have to use MPlayer SVN to have the full resolution from Elphel cameras.

Additionally, to make MPlayer work inside the web page you need to specify video output as "x11" in the MPlayer config file - add a line

vo="x11"

To ~/.mplayer/config file

For developers

Following was written for (K)Ubuntu 9.10 and earlier, it also works with 10.04, please see revision-specific notes.

Adding universe and multiverse sources

Please follow this howto for adding universe and multiverse sources.

https://help.ubuntu.com/community/Repositories/Ubuntu

or

https://help.ubuntu.com/community/Repositories/Kubuntu

Install needed packages

Minimal packages:

sudo apt-get install cvs build-essential autoconf flex byacc bison libglib2.0-dev tcl gettext libncurses5-dev patch zlib1g-dev nfs-kernel-server bash xutils-dev

Suggested packages:

sudo apt-get install kinfocenter minicom firefox graphviz doxygen ctags cervisia php5 php5-cli xchat ssh kompare git-core

Configure your NFS server

Let's say you want to configure an NFS server on your machine and your IP address is 192.168.0.15.

Modify the configuration file:

kdesudo kate /etc/exports

Add at the end of the file:

/nfs            192.168.0.0/255.255.0.0(rw,sync,no_root_squash,no_subtree_check)

save the file.

If it does not yet exist make /nfs directory and make it world writable to make it possible to write logs from the camera.

sudo mkdir /nfs
sudo chmod 777 -R /nfs

And finally export the filesystem.

sudo exportfs -a

(Had to reboot after in ubuntu 14.04)

Installation of GCC Compiler kit for Axis ETRAX processor

Automatic Installation ((K)Ubuntu 11.04 Natty Narwhal)

1.

sudo add-apt-repository "deb http://ppa.launchpad.net/elphel/ppa/ubuntu natty main"

(The line above is equivalent to adding the following lines to your sources.list (sudo kate /etc/apt/sources.list)):
deb http://ppa.launchpad.net/elphel/ppa/ubuntu natty main 
deb-src http://ppa.launchpad.net/elphel/ppa/ubuntu natty main 

2. (in case of) ...public key is not available...

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 6050780EC7A72F76

3.

sudo apt-get update
sudo apt-get install cris-dist

Manual Installation

Downloading and unpacking gcc-cris

Download and install Cris-GCC compiler. It is needed to compile C and C++ programs for the CPU used in Elphel cameras - Axis ETRAX FS :

mkdir -p ~/Downloads/axis ; cd ~/Downloads/axis
wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-linux-headers-1.64.tar.gz   
wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-linux-headersv32-1.64.tar.gz  
wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-glibc-1.64.tar.gz 
wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-1.64.tar.gz
wget http://www.axis.com/ftp/pub/axis/tools/cris/compiler-kit/cris-dist-1.64-1--1.64-2.patch
tar zxvf cris-dist-1.64.tar.gz
cd cris-dist-1.64/
tar zxvf ../cris-dist-linux-headers-1.64.tar.gz                                 
tar zxvf ../cris-dist-linux-headersv32-1.64.tar.gz                             
tar zxvf ../cris-dist-glibc-1.64.tar.gz
patch -p0 < ../cris-dist-1.64-1--1.64-2.patch

Compiling gcc-cris

Now you may proceed with compiling gcc-cris (takes some time):

sudo ./install-cris-tools

answer by default (enter, enter, ...)


Build Elphel Software

Get the script. Unpack & Launch.


Installation of Kdevelop 3.5

note: Newer KDevelop 4 does not work with Elphel software

pre (K)Ubuntu 9.10

sudo apt-get install kdevelop

(K)Ubuntu 9.10 (Karmic), 10.4 (Lucid)

see Installation of KDevelop 3.5 on (K)Ubuntu 9.10

Install Icarus Verilog and GTKWave

(If you plan to develop FPGA code or at least look how it works)

GTKWave is OK from repository:

sudo apt-get install gtkwave

But unfortunately Icarus Verilog (package verilog) is compiled without needed support for compressed output format, so you'll have to compile it

cd ~/Downloads
wget "ftp://ftp.icarus.com/pub/eda/verilog/v0.9/verilog-0.9.3.tar.gz"
tar zxvf verilog-0.9.3.tar.gz
cd verilog-0.9.3/
./configure
make
sudo make install

Installing Xilinx WebPack (to be moved to a separate page, just a link here)

If you plan to compile the FPGA code from the source code you will need to install appropriate software from the FPGA manufacturer web site. This is proprietary (and non-free) software provided by Xilinx free of charge. This software is called the ISE WebPACK and you may download it (currently some 2.2GB) after registering at Xilinx web site. Currently tested version is 10.1.03, we'll try to update our code when Xilinx will release the new version of their software.

You will also need that software if you would like to simulate the FPGA functionality. Elphel camera FPGA code (written in Verilog HDL) is licensed under GNU GPLv3, simulator and waveform viewer (see below) are also Free Software, but there are a few Verilog models of some primitives of Xilinx FPGA that are not and can be only obtained from Xilinx as a part of their unisims library. For simulation we use small subset of the unisims library components and only for functional simulation so it will probably make sense to re-write those primitives models so the 2.2 GB distribution will not be needed to extract just few kilobytes of required source code.

Such independent re-implementation will help us to solve another problem - we have to patch the Xilinx library components to make them work correctly with our code and the simulator we use and currently each Xilinx library update breaks our patches.

When you will build Elphel software (as described later) the installation script will try to locate Xilinx software on your computer and patch a copy of unisims library. If you'll install Xilinx WebPack after building the camera software - you'll need to navigate to fpga subdirectory of the source tree and execute

make clean ; make

It is described in file README.simulation in that subdirectory.


There are additional steps required for the Xilinx WebPACK installation if you have a 64-bit GNU/Linux operation system. The next command line detects if you are running on 64 bit version of GNU/Linux and conditionally installs ia64-libs. That library is needed if you'll install Xilinx WebPack software (Xilinx does not allow to use 64-bit programs in their free for download software and the provided installation script does not install 32-bit version on its own). There is another trick you'll need to be aware of if you are using 32-bit Xilinx WebPack on a 64-bit GNU/Linux system.

if [ `uname -m` = "x86_64" ] ; then sudo apt-get install ia32-libs ; fi

Installation of the source code of Elphel camera software

You may install Elphel source code by either of the two methods. Either from the CVS (the most current code) and form the tarball files.

Installation from the CVS

Get elphel353_80_install_from_cvs.sh open archive that contains the shell script and execute it. It is recommended that you create subdirectory in your home directory, i.e. "elphel_projects", move and execute elphel353_80_install_from_cvs.sh script there. Directory "distfiles" will be created there and used as a cache for software archives that will be downloaded during installation.

mkdir -p ~/elphel_projects; cd ~/elphel_projects
wget "http://downloads.sourceforge.net/elphel/elphel353_80_install_from_cvs.sh.tar.gz"
tar zxvf elphel353_80_install_from_cvs.sh.tar.gz
./elphel353_80_install_from_cvs.sh

Installation from the tarball (release file)

http://sourceforge.net/projects/elphel

  • get one of the elphel353-8.0.* releases
  • decompress the archive
  • execute the ./install_elphel script
./install_elphel

There will be created a file build.log in the top installation directory. If you get any installation problems you can compress that file and email it to Elphel support.

At the end of installation the script will generate a list of all the files in the target (camera) file system that are to be installed and compares it against the contents of the file target.list that is included in the distribution. If there are any differences -- they will be reported (there should be none). If there are some missing files it is likely that something failed to install correctly.

After the installation will be completed successfully you may want to execute the following command in the top installation directory (the one that has apps, configure-files, ... subdirectories)

./prep_kdevelop.php

That will create elphel353.kdevelop - a project file for KDevelop IDE (version 3.5.x), you can use it as described here - KDevelop



ImageJ and Elphel plugins for imageJ

ImageJ is a powerful open source image processing package, written in Java. There are plugins to work with Elphel cameras, the most universal one allows opening JP46 files (stored on a file system or downloaded directly from the camera). This plugin reads meta data from the image and un-applies in-camera non-linear conversion resulting in the linearized image, where each pixel is represented by a floating point value proportional to the number of photons that were detected in that pixel.

It is a very useful tool to do quantitative analysis of the camera images.

  • Download plugins:
git clone https://git.elphel.com/Elphel/imagej-elphel.git
git clone --branch v1.1 https://git.elphel.com/Elphel/imagej-elphel.git (for Eyesis4Pi393)
-clean -startup
...
-XX:MaxPermSize=24576m
-Xms2048m
-Xmx24576m
  • Kubuntu 18.04 might need:
https://stackoverflow.com/questions/6784463/error-trustanchors-parameter-must-be-non-empty
  • From Eclipse:
1. File -> Import -> Existing Maven Projects -> set imagej-elphel as Root Directory - a project will appear in the project list -> Finish
   Importing will take some time

2. Create Run Configuration:
   a. Run Configurations -> select Java Application -> New Launch Configuration -> find the needed plugin class -> Run
       Classes:
       * Aberration_Calibration - work with calibration data, regenerate kernels, etc.
       * Eyesis_correction - postprocess images.
   b. It will launch ImageJ & Aberration_Calibration plugin
   c. Other plugins are launched from ImageJ window from Plugins