wiki.openlighting.org - User contributions [en]

Building OLA for Windows

2014-11-30T21:26:52Z

Nightrune:

This describes how to get OLA compiled for windows, it's a work in progress so it's unlikely to work as is. This tutorial uses gcc as the compiler, other compilers have not been tested.

During [[GSOC2014WindowsPort|Google Summer of Code 2014]], this port will be worked on as one of the selected projects.

== Install Mingw, msys & build tools ==

Together MinGW & msys provide a unix-style shell environment & compiler suite for windows. Read the instructions at the [http://www.mingw.org/ MinGW] site for more info. MinGW now provides an installer to get most of the system up and running quickly. [http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst/ Download] the installer and make sure you select "C++ Compiler". "MSYS Basic System" & "MinGW Developer Toolkit" when prompted.

Once the installer has completed, open the msys shell (under Programs > MinGW) and install some additional packages:

$ mingw-get.exe install msys-coreutils mingw32-base mingw32-pthreads-w32 msys-wget

Note that some of these might already have been installed.

== Install Git ==

Git is used to checkout (and commit) the ola sources. See http://code.google.com/p/msysgit/, be sure to select "checkout as is, commit unix style" during the install otherwise you'll get autoconf errors.

Add the following line to your .bashrc file so that git can be used within msys:

PATH="$PATH:/c/Program Files/Git/bin"
alias git=git.exe

If you are on 64bit windows you may need to use:

PATH="$PATH:/c/Program Files (x86)/Git/bin"
alias git=git.exe

== Install pkg-config ==

Download pkg-config-lite from http://sourceforge.net/projects/pkgconfiglite/files/ (the latest binary should work) and extract it to your MinGW directory.

You also need to add

export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
CPPFLAGS="-I/usr/local/include"
LDFLAGS="-L/usr/local/lib"

to your .bashrc file.

You might also want to edit your .profile file and add <pre>[ -f ~/.bashrc ] && . ~/.bashrc</pre>

If you haven't configured your MSYS fstab yet, do that as well. See http://www.mingw.org/wiki/Getting_Started for instructions.

== Install Dependencies ==

=== pkg-config ===
* Download pkg-config-lite from http://sourceforge.net/projects/pkgconfiglite/files/
* Extract to MinGW directory

=== Python (optional) ===
* Tested version: 2.7 series
* Download and install Python for Windows from https://www.python.org/downloads/

=== msys-git ===
* Download msysgit from https://code.google.com/p/msysgit/downloads/list
* Install and make sure to select "Check-out as is, commit UNIX-style"

=== libuuid ===
* Download and extract the latest libuuid tarball from https://code.google.com/p/gnome-build-stage-1/downloads/list
* Configure, compile and install it using the MinGW MSYS shell

=== protobuf ===
* Download and extract the latest protobuf tarball from https://code.google.com/p/protobuf/downloads/list
* Configure, compile and install it using the MinGW MSYS shell
* if you want to use the OLA Python api, install the protobuf Python bindings from the 'python' subdirectory

=== cppunit ===
* Download and extract the latest cppunit tarball from http://sourceforge.net/projects/cppunit/files/cppunit/
* Configure, compile and install it using the MinGW MSYS shell

=== libmicrohttpd ===
* Download and extract the latest libmicrohttpd tarball from http://ftp.gnu.org/gnu/libmicrohttpd/
* Configure, compile and install it using the MinGW MSYS shell

=== liblo (optional) ===
* Download and extract the latest version of liblo from http://liblo.sourceforge.net/
* Configure, compile and install it using the MinGW MSYS shell

== Build OLA ==

* Do a git checkout of OLA

$ git.exe clone https://github.com/OpenLightingProject/ola.git

* Prepare autotools files
$ autoreconf -i -f

* Run ./configure
$ ./configure --enable-python-libs --disable-e131 --disable-karate --disable-milinst --disable-renard --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx --disable-uart

* Build
$ make

* Optional: Run the tests
$ make check

* Install
$ make install

== Current State / TODO ==

See the [[GSOC2014WindowsPort|GSOC project page]].

== Misc Notes ==

You may run into issues with the latest mingw and protobufs. During runtime it can't find libstdc++-6.dll. Attempt to follow this and see if any of the solutions fixes your problem. We'd love to hear the outcome on irc or the forums.
http://stackoverflow.com/questions/6404636/libstdc-6-dll-not-found

Sean Sill:
I ended up removing libstdc++.dll.a from the C:/MinGW/libs folder.

Building OLA for Windows

2014-11-30T21:20:04Z

Nightrune:

2013-06-02T19:50:26Z

Nightrune: Nevermind I was on an old version of ubuntu

This describes how to get [[OLA]] working on a Linux system either from the git repo or by using a [http://code.google.com/p/open-lighting/downloads/list released tarball].

=Install dependencies =

You need a couple of libraries installed for everything to work correctly. Some of these are available as packages in distros but others need to be downloaded and built manually.

First you'll need at least the following:
* cppunit
* uuid or ossp uuid
* pkg-config
* curses
* lex (or flex)
* yacc (or bison)
* the protocol buffers library [http://code.google.com/p/protobuf/ http://code.google.com/p/protobuf/] (version 2.3.0 or later)
* microhttpd [ftp://ftp.gnu.org/gnu/libmicrohttpd/ ftp://ftp.gnu.org/gnu/libmicrohttpd/] (if you want the web UI). You need version >= 0.4.0 of microhttpd

If you're building from git you'll also need the following:

* libtool
* automake
* autoconf

== Debian / Ubuntu ==
There is a fully packaged version of OLA you can just install, for info see [[OLA Debian / Ubuntu]]. There's also a more specific Ubuntu walkthrough for building [[The Newbie Guide for OLA on Ubuntu]].

Debian/Ubuntu users can install them with apt:

sudo apt-get install libcppunit-dev libcppunit-1.12-1 uuid-dev pkg-config libncurses5-dev libtool autoconf automake g++ libmicrohttpd-dev \
libmicrohttpd10 protobuf-compiler libprotobuf-lite7 python-protobuf libprotobuf-dev zlib1g-dev bison flex make libftdi-dev libftdi1 libusb-1.0-0-dev liblo-dev

Note: Some distributions may offer libprotobuf-lite6 instead of libprotobuf-lite7, which is an acceptable substitution.

If you're using Ubuntu 12.04 or later you can just use the command above. In earlier versions of Ubuntu the version of libprotobuf is too old, so you'll need to install them by hand. You may also need to install an older version of libmicrohttpd (libmicrohttpd9 rather than libmicrohttpd10).

== Centos 6 / RHEL 6 / Fedora 17 ==

Users of rpm based distributions can install them with yum (protobuf*, libmicrohttpd* and libftdi* are in the EPEL repository):

sudo yum install flex bison protobuf protobuf-devel uuid-devel cppunit-devel protobuf-python libmicrohttpd-devel libusb-devel libftdi-devel libuuid-devel openslp-devel

(The remaining libs already come with the OS installation)

== Other Distributions ==

Install using your package manager, or build everything by hand

If you installed things by hand (rather than using your package manager), you need to run ldconfig as root to pick up the new libraries

sudo ldconfig

=Checkout or Download an Archive=

You can either download a tarball, or pull the latest version from the git repo

== Tarball ==

Download the most recent tarball from http://code.google.com/p/open-lighting/downloads/list
Extract using

tar -zxf ola-0.X.Y.tar.gz
cd ola-0.X.Y

== Git ==

If you don't have '''git''' yet, you'll need to install it with your distro's package manager. On Debian / Ubuntu run:

sudo apt-get install git

Check out the git repo with the following command:

git clone https://code.google.com/p/open-lighting/ ola
cd ola

{{ MacOLABuild }}

Finally run ldconfig so you can use the new libraries.

sudo ldconfig

=Device drivers=
Note that, for some devices, it is necessary to install drivers for OLA to work with them. For example, the [[Open DMX USB]] device needs an additional kernel module that could be built using the instuctions on [[LLA_and_Q_Light_Controller_Ubuntu_Tutorial]]. For other devices, refer to the corresponding device page on this wiki.

=Known Issues=

If you get an error like the following:

/bin/sh ./libtool --tag=CC --mode=compile gcc -DHAVE_CONFIG_H -I. -I/opt/local/var/macports/software/protobuf-cpp/2.0.3_0/opt/local/include/ -g -O2 -c -o ltdl.lo ltdl.c
./libtool: line 464: CDPATH: command not found
/Users/simonn/lighting/lla/libltdl/libtool: line 464: CDPATH: command not found
/Users/simonn/lighting/lla/libltdl/libtool: line 1142: func_opt_split: command not found
libtool: Version mismatch error. This is libtool 2.2.6, but the
libtool: definition of this LT_INIT comes from an older release.
libtool: You should recreate aclocal.m4 with macros from libtool 2.2.6
libtool: and run autoconf again.

Your system uses a different version of libtool. Run:

libtoolize --ltdl -c -f

and then start from the autoreconf step again.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

You should be able to prevent this by [http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b editing <code>./src/Makefile.am</code>], removing <code>-Werror</code> and then start from the autoreconfig step again.

OLA on Linux

2013-06-01T22:17:03Z

Nightrune: The build command failed when I tried the original. libmircohttpd10 isn't a real package.

This describes how to get [[OLA]] working on a Linux system either from the git repo or by using a [http://code.google.com/p/open-lighting/downloads/list released tarball].

=Install dependencies =

You need a couple of libraries installed for everything to work correctly. Some of these are available as packages in distros but others need to be downloaded and built manually.

First you'll need at least the following:
* cppunit
* uuid or ossp uuid
* pkg-config
* curses
* lex (or flex)
* yacc (or bison)
* the protocol buffers library [http://code.google.com/p/protobuf/ http://code.google.com/p/protobuf/] (version 2.3.0 or later)
* microhttpd [ftp://ftp.gnu.org/gnu/libmicrohttpd/ ftp://ftp.gnu.org/gnu/libmicrohttpd/] (if you want the web UI). You need version >= 0.4.0 of microhttpd

If you're building from git you'll also need the following:

* libtool
* automake
* autoconf

== Debian / Ubuntu ==
There is a fully packaged version of OLA you can just install, for info see [[OLA Debian / Ubuntu]]. There's also a more specific Ubuntu walkthrough for building [[The Newbie Guide for OLA on Ubuntu]].

Debian/Ubuntu users can install them with apt:

sudo apt-get install libcppunit-dev libcppunit-1.12-1 uuid-dev pkg-config libncurses5-dev libtool autoconf automake g++ libmicrohttpd-dev \
libmicrohttpd5 protobuf-compiler libprotobuf-lite7 python-protobuf libprotobuf-dev zlib1g-dev bison flex make libftdi-dev libftdi1 libusb-1.0-0-dev liblo-dev

Note: Some distributions may offer libprotobuf-lite6 instead of libprotobuf-lite7, which is an acceptable substitution.

If you're using Ubuntu 12.04 or later you can just use the command above. In earlier versions of Ubuntu the version of libprotobuf is too old, so you'll need to install them by hand. You may also need to install an older version of libmicrohttpd (libmicrohttpd9 rather than libmicrohttpd10).

== Centos 6 / RHEL 6 / Fedora 17 ==

Users of rpm based distributions can install them with yum (protobuf*, libmicrohttpd* and libftdi* are in the EPEL repository):

sudo yum install flex bison protobuf protobuf-devel uuid-devel cppunit-devel protobuf-python libmicrohttpd-devel libusb-devel libftdi-devel libuuid-devel openslp-devel

(The remaining libs already come with the OS installation)

== Other Distributions ==

Install using your package manager, or build everything by hand

If you installed things by hand (rather than using your package manager), you need to run ldconfig as root to pick up the new libraries

sudo ldconfig

=Checkout or Download an Archive=

You can either download a tarball, or pull the latest version from the git repo

== Tarball ==

Download the most recent tarball from http://code.google.com/p/open-lighting/downloads/list
Extract using

tar -zxf ola-0.X.Y.tar.gz
cd ola-0.X.Y

== Git ==

If you don't have '''git''' yet, you'll need to install it with your distro's package manager. On Debian / Ubuntu run:

sudo apt-get install git

Check out the git repo with the following command:

git clone https://code.google.com/p/open-lighting/ ola
cd ola

{{ MacOLABuild }}

Finally run ldconfig so you can use the new libraries.

sudo ldconfig

=Device drivers=
Note that, for some devices, it is necessary to install drivers for OLA to work with them. For example, the [[Open DMX USB]] device needs an additional kernel module that could be built using the instuctions on [[LLA_and_Q_Light_Controller_Ubuntu_Tutorial]]. For other devices, refer to the corresponding device page on this wiki.

=Known Issues=

If you get an error like the following:

/bin/sh ./libtool --tag=CC --mode=compile gcc -DHAVE_CONFIG_H -I. -I/opt/local/var/macports/software/protobuf-cpp/2.0.3_0/opt/local/include/ -g -O2 -c -o ltdl.lo ltdl.c
./libtool: line 464: CDPATH: command not found
/Users/simonn/lighting/lla/libltdl/libtool: line 464: CDPATH: command not found
/Users/simonn/lighting/lla/libltdl/libtool: line 1142: func_opt_split: command not found
libtool: Version mismatch error. This is libtool 2.2.6, but the
libtool: definition of this LT_INIT comes from an older release.
libtool: You should recreate aclocal.m4 with macros from libtool 2.2.6
libtool: and run autoconf again.

Your system uses a different version of libtool. Run:

libtoolize --ltdl -c -f

and then start from the autoreconf step again.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

You should be able to prevent this by [http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b editing <code>./src/Makefile.am</code>], removing <code>-Werror</code> and then start from the autoreconfig step again.