wiki.openlighting.org - User contributions [en]

OLA Buildbot

2014-04-05T14:43:34Z

RenZO: /* Build Slave Installation */

We run a [http://buildbot.net/ Buildbot] instance for [[OLA]].

*Web UI: http://buildbot.openlighting.org
*IRC: OLA-buildbot-ch in #openlighting-build on irc.freenode.org

We're currently only building ola, but this could be extended to do other projects such as the QT GUI etc.

== Master Configuration ==
The buildbot master configuration is stored in git at https://github.com/OpenLightingProject/buildbot . It needs checking out, and symlinking to replace master.cfg in the buildbot master's config directory.

N.B. If the main open-lighting git repository (as opposed to buildbot config) is ever moved or changed, ensure the master's gitpoller-workdir folder is emptied out, or the poller won't work properly.

= Adding a Slave =

Buildbot documentation is at http://docs.buildbot.net/current/manual/installation.html#creating-a-buildslave . The steps below should cover everything you need though.

== Prerequisites & Warning ==

Slaves execute code directly from the git repo. Even though submits to the git repo are locked down, this is still a possible attack vector for your machine. For this reason it's best to run build slaves within a virtual machine. TODO: link to some VM solutions.

At the very least you should run the buildslave as a separate user (not root!). Slave passwords aren't stored in the git repo for security, you'll need to get Simon to add new ones.

The buildbot performs full build & test runs with all the options enabled. Please make sure you have all the necessary libraries installed on your system. You need to be able to complete a

<pre>
autoconf -i
./configure --enable-e133 --enable-rdm-tests --enable-python-libs
make
make check
</pre>

cycle before proceeding. If you have trouble ask on the mailing list.

If you're running the lint check, you need ccplint.py in your path somewhere, see README.developer for info on how to obtain it.

Buildbot slaves need to connect to buildbot.openlighting.org:9989 . Make sure your firewall allows this. No port forwarding for inbound connections is required.

== Debian / Ubuntu Instructions ==

This requires wheezy or later. For squeeze you can use the easy_install method below.

=== Build Slave Installation ===

<pre>
sudo apt-get install buildbot-slave
</pre>

=== Slave Configuration ===

Create the slave:

<pre>
sudo -u buildbot buildslave create-slave --usepty=0 /var/lib/buildbot/slaves/ola buildbot.openlighting.org:9989 <slave user> <slave password>
</pre>

Update the slave info, edit the files in /var/lib/buildbot/slaves/ola/info to be relevant to you.

Add config for the slave into /etc/default/buildslave (you'll need to increase the array id if you've got more than one slave on the same host), e.g.:
<pre>
SLAVE_ENABLED[1]=1 # 1-enabled, 0-disabled
SLAVE_NAME[1]="ola" # short name printed on start/stop
SLAVE_USER[1]="buildbot" # user to run slave as
SLAVE_BASEDIR[1]="/var/lib/buildbot/slaves/ola" # basedir to slave (absolute path)
SLAVE_OPTIONS[1]="" # buildbot options
SLAVE_PREFIXCMD[1]="" # prefix command, i.e. nice, linux32, dchroot
</pre>

Start the slave
sudo /etc/init.d/buildslave start

Check the log if there are any issues, or confirm the slave is registered at http://buildbot.openlighting.org/buildslaves:
tail -f /var/lib/buildbot/slaves/ola/twistd.log

== FreeBSD Instructions ==

This was tested on FreeBSD 10.

=== Build Slave Installation ===
As root:
<pre>
pkg install buildbot-slave
</pre>

=== Slave Configuration ===

Setup a new user:

<pre>
su -
adduser
</pre>
Username: ola-build-slave
Use password-based authentication? No

Setup the slave:

Switch to the slave user, I did:
<pre>
su - #To root
su - ola-build-slave #To slave user
cd ~
</pre>

Export the variables needed for configure on FreeBSD:
<pre>
export CPPFLAGS="-I/usr/local/include/"
export LDFLAGS="-L/usr/local/lib/"
</pre>

Setup the slave itself:
<pre>
/usr/local/bin/buildslave create-slave ola-slave buildbot.openlighting.org:9989 <slave user> <slave password>
</pre>

Edit <tt>ola-slave/info/admin</tt> and <tt>ola-slave/info/host</tt> so your slave shows up correctly.

Then start the slave:

<pre>
/usr/local/bin/buildslave start ola-slave
</pre>

You can look at the logs by running

<pre>
tail -f ola-slave/twistd.log
</pre>

At this point you can go to http://buildbot.openlighting.org/buildslaves and you should see your slave connected. It's probably worth asking someone to kick off a build at this point so we can check your slave is working.

Finally, if everything looks good, configure your slave to launch on startup by editing the crontab for the ola-build-slave user (crontab -e). Add the following line:

<pre>
@reboot /usr/local/bin/buildslave start /home/ola-build-slave/ola-slave
</pre>

== NetBSD Instructions ==

This was tested on NetBSD 6.

=== Build Slave Installation ===
As root:
<pre>
pkgin install py27-buildbot-slave
</pre>

=== Slave Configuration ===

Setup a new user:

<pre>
su -
useradd -m ola-build-slave
</pre>
Use password-based authentication? No

Setup the slave:

Switch to the slave user:
<pre>
su - ola-build-slave
cd ~
</pre>

Export the variables needed for git and configure on NetBSD (add these to the .shrc or equivalent for next time):
<pre>
export CPPFLAGS="-I/usr/pkg/include/"
export LDFLAGS="-L/usr/pkg/lib/"
export GIT_SSL_NO_VERIFY=true
</pre>

Setup the slave itself:
<pre>
/usr/pkg/bin/buildslave create-slave ola-slave buildbot.openlighting.org:9989 <slave user> <slave password>
</pre>

Edit <tt>ola-slave/info/admin</tt> and <tt>ola-slave/info/host</tt> so your slave shows up correctly.

Then start the slave:

<pre>
/usr/pkg/bin/buildslave start ola-slave
</pre>

You can look at the logs by running

<pre>
tail -f ola-slave/twistd.log
</pre>

At this point you can go to http://buildbot.openlighting.org/buildslaves and you should see your slave connected. It's probably worth asking someone to kick off a build at this point so we can check your slave is working.

Finally, if everything looks good, configure your slave to launch on startup by editing the crontab for the ola-build-slave user (crontab -e). Add the following line:

<pre>
@reboot /usr/pkg/bin/buildslave start /home/ola-build-slave/ola-slave
</pre>

== OpenBSD Instructions ==

This was tested on OpenBSD 5.4.

=== Build Slave Installation ===
As root:
<pre>
pkg_add py-buildslave
</pre>

=== Slave Configuration ===

Setup a new user:

<pre>
su -
useradd -m ola-build-slave
</pre>

Setup the slave:

Switch to the slave user:
<pre>
su - ola-build-slave
cd ~
</pre>

Export the variables needed for autoconf and configure on OpenBSD (add these to the .profile or equivalent for next time):
<pre>
export AUTOCONF_VERSION=2.69
export AUTOMAKE_VERSION=1.13
export CPPFLAGS="-I/usr/local/include/"
export LDFLAGS="-L/usr/local/lib/"
</pre>

Setup the slave itself:
<pre>
/usr/local/bin/buildslave create-slave ola-slave buildbot.openlighting.org:9989 <slave user> <slave password>
</pre>

Edit <tt>ola-slave/info/admin</tt> and <tt>ola-slave/info/host</tt> so your slave shows up correctly.

Then start the slave:

<pre>
/usr/local/bin/buildslave start ola-slave
</pre>

You can look at the logs by running

<pre>
tail -f ola-slave/twistd.log
</pre>

At this point you can go to http://buildbot.openlighting.org/buildslaves and you should see your slave connected. It's probably worth asking someone to kick off a build at this point so we can check your slave is working.

Finally, if everything looks good, configure your slave to launch on startup by editing the crontab for the ola-build-slave user (crontab -e). Add the following line:

<pre>
@reboot /usr/local/bin/buildslave start /home/ola-build-slave/ola-slave
</pre>

== Other Platforms ==

=== Build Slave Installation ===

The easiest way to get started is by using easy_install. You need to have the Python headers available, so on Debian / Ubuntu run:

<pre>
sudo apt-get install python-dev
</pre>

Then install buildbot-slave:

<pre>
easy_install buildbot-slave
</pre>

=== Slave Configuration ===

Setup a new user:

<pre>
sudo -s
adduser ola-build-slave # use a temp password for now
vi /etc/shadow # delete the password entry
</pre>

Setup the slave:

<pre>
su ola-build-slave
cd ~
buildslave create-slave ola-slave buildbot.openlighting.org:9989 <slave user> <slave password>
</pre>

Edit <tt>ola-slave/info/admin</tt> and <tt>ola-slave/info/host</tt> so your slave shows up correctly.

Then start the slave:

<pre>
buildslave start ola-slave
</pre>

You can look at the logs by running

<pre>
tail -f ola-slave/twistd.log
</pre>

At this point you can go to http://buildbot.openlighting.org/buildslaves and you should see your slave connected. It's probably worth asking someone to kick off a build at this point so we can check your slave is working.

Finally, if everything looks good, configure your slave to launch on startup by editing the crontab for the ola-build-slave user (crontab -e). Add the following line:

<pre>
@reboot buildbot start /home/ola-build-slave/ola-slave
</pre>

== Enabling the C++ Lint Checker ==

The lint checker enforces C++ style. We only run this once per change but it's good to have multiple lint-enabled hosts in case one is down.

Download the cpplint checker and put it in /usr/local/bin

<pre>
wget http://google-styleguide.googlecode.com/svn/trunk/cpplint/cpplint.py
sudo cp cpplint.py /usr/local/bin
chmod a+x /usr/local/bin/cpplint.py
</pre>

Finally drop Simon an email asking him to enable C++ lint for your slave.

== Enabling the Javascript Lint Checker ==

The lint checker enforces Javascript style. We only run this once per change but it's good to have multiple lint-enabled hosts in case one is down.

Install the gjslint checker by following the relevant instructions here:
https://developers.google.com/closure/utilities/docs/linter_howto

Finally drop Simon an email asking him to enable Javascript lint for your slave.

== Enabling the heap checker ==

First we need libunwind:

<pre>
apt-get install libunwind7-dev
</pre>

Then download the latest gperftools from https://code.google.com/p/gperftools/downloads/list .

<pre>
wget ....
tar -zxf gperftools-2.0.tar.gz
cd gperftools-2.0
./configure
make
sudo make install
sudo ldconfig
</pre>

Finally drop Simon an email asking him to enable the heap checker for your slave.

OLA on FreeBSD

2014-03-30T23:15:44Z

RenZO: /* With OLA 0.9.x, we can build on OpenBSD 5.4 :) */

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Quick start==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22 or > 0.9.0

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

https://github.com/OpenLightingProject/ola

You just need to run:
* $ CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.x or 6.x)

(without python-libs because python-protobuf is missing):

For current release 6.1.3 :

<code>pkgin install bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd ncurses autoconf automake libtool</code>

some tools on a fresh install :
pkgin install nano screen wget git

$ env GIT_SSL_NO_VERIFY=true git clone https://github.com/OpenLightingProject/ola

<code>CPPFLAGS="-I/usr/pkg/include/" LDFLAGS="-L/usr/pkg/lib/" ./configure</code>

$ make

---

For older releases :

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

==== With OLA 0.9.x, we can build on OpenBSD 5.4 :) ====

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.4/packages/amd64/"

* pkg_add bison protobuf ossp-uuid cppunit
* pkg_add autoconf automake libtool git

* export AUTOCONF_VERSION=2.69
* export AUTOMAKE_VERSION=1.13

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure</code>

* make

With OLA 0.8.x, we had problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-30T23:03:38Z

RenZO: /* With OLA 0.9.x, we can build on OpenBSD :) */

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Quick start==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22 or > 0.9.0

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

https://github.com/OpenLightingProject/ola

You just need to run:
* $ CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.x or 6.x)

(without python-libs because python-protobuf is missing):

For current release 6.1.3 :

<code>pkgin install bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd ncurses autoconf automake libtool</code>

some tools on a fresh install :
pkgin install nano screen wget git

$ env GIT_SSL_NO_VERIFY=true git clone https://github.com/OpenLightingProject/ola

<code>CPPFLAGS="-I/usr/pkg/include/" LDFLAGS="-L/usr/pkg/lib/" ./configure</code>

$ make

---

For older releases :

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

==== With OLA 0.9.x, we can build on OpenBSD 5.4 :) ====

* pkg_add bison protobuf ossp-uuid cppunit
* pkg_add autoconf automake libtool git

* export AUTOCONF_VERSION=2.69
* export AUTOMAKE_VERSION=1.13

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure</code>

* make

With OLA 0.8.x, we had problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-30T21:30:14Z

RenZO: /* OpenBSD */ build on 0.9.x

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Quick start==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22 or > 0.9.0

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

https://github.com/OpenLightingProject/ola

You just need to run:
* $ CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.x or 6.x)

(without python-libs because python-protobuf is missing):

For current release 6.1.3 :

<code>pkgin install bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd ncurses autoconf automake libtool</code>

some tools on a fresh install :
pkgin install nano screen wget git

$ env GIT_SSL_NO_VERIFY=true git clone https://github.com/OpenLightingProject/ola

<code>CPPFLAGS="-I/usr/pkg/include/" LDFLAGS="-L/usr/pkg/lib/" ./configure</code>

$ make

---

For older releases :

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

==== With OLA 0.9.x, we can build on OpenBSD :) ====

* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure</code>

* make

With OLA 0.8.x, we had problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-09T21:20:00Z

RenZO: /* NetBSD */ update 6.1.3

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Quick start==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22 or > 0.9.0

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

https://github.com/OpenLightingProject/ola

You just need to run:
* $ CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.x or 6.x)

(without python-libs because python-protobuf is missing):

For current release 6.1.3 :

<code>pkgin install bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd ncurses autoconf automake libtool</code>

some tools on a fresh install :
pkgin install nano screen wget git

$ env GIT_SSL_NO_VERIFY=true git clone https://github.com/OpenLightingProject/ola

<code>CPPFLAGS="-I/usr/pkg/include/" LDFLAGS="-L/usr/pkg/lib/" ./configure</code>

$ make

---

For older releases :

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-08T14:14:47Z

RenZO: /* Building OLA */ update to github and add flags

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Quick start==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22 or > 0.9.0

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

https://github.com/OpenLightingProject/ola

You just need to run:
* $ CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-08T14:11:45Z

RenZO: /* FreeBSD */

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Quick start==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-08T14:00:01Z

RenZO: /* FreeBSD */ add configure flags

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==FreeBSD==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

You need to use these flags :

<code>CPPFLAGS="-I/usr/local/include/" LDFLAGS="-L/usr/local/lib/" ./configure --enable-rdm-tests</code>

Then make and make install.

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2014-03-07T12:12:52Z

RenZO: /* OpenBSD */ update to 5.2

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==FreeBSD 10 pkgng==

One-liner to install everything using the new pkgng in FreeBSD 10

<code>pkg install bison pkgconf protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf autoconf automake libtool</code>

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD (5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.2/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.12p1 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.12
* hack config/ola.m4 if you want
* autoreconf -fi

++

RDM PID Definitions

2013-04-20T23:19:38Z

RenZO: /* Adding New Parameters */ add rdm-pid-builder

== Parameter Definitions and OLA ==

[[OLA]] reads the structure of [[RDM]] parameter messages at runtime. This allows the users to update PID definitions without upgrading the binaries and also means we can add knowledge of new manufacturer PIDs to the RDM controller software very quickly.

To enable this, we've designed a parameter definition language which allows us to describe the structure of RDM parameter messages in a language-independent manner. This language has the following assumptions:

* The structure of a message (i.e. # of repeated values and the length of variable sized fields) must be able to be determined solely from the parameter definition and the length of the message. All parameters in E1.20 and E1.37-1 conform to this, as well as every manufacturer parameter I've encountered. This means that only one variable-sized field can be present in each message, and that [http://en.wikipedia.org/wiki/Type-length-value TLV] style messages aren't supported.

To get the full benefits of the definition language, the parameter definitions should also:

* Use big-endian for multi-byte fields
* When integer values are used, the values are stores as normal int values, not as ASCII.

The canonical parameter definitions are stored on the http://rdm.openlighting.org site. The data from the site is used to generate an ASCII [http://code.google.com/p/protobuf protocol buffer] which is then checked into the OLA codebase and distributed with the tarball. One day we may support automatic updating of the parameter definition files.

You can see the latest pid protobufs at <tt>[http://code.google.com/p/open-lighting/source/browse/data/rdm/pids.proto pids.proto]</tt> and <tt>[http://code.google.com/p/open-lighting/source/browse/data/rdm/manufacturer_pids.proto manufacturer_pids.proto]</tt>. In the tarball the files are in <tt>data/rdm/</tt> and they are usually installed into <tt>/usr/local/share/ola/pids/</tt>.

== Adding New Parameters ==

Parameters are added to the rdm.openlighting.org site by specifying the message structure, as well as properties like the parameter name and PID in a Python file. To get started, clone the rdm.openlighting.org code from http://code.google.com/p/open-lighting/source/checkout?repo=rdm-app. The definitions are found in <tt>data/pid_data.py</tt>. Once you have edited this file push the change to a public git repo and email the open-lighting list asking for a pull request. Simon will sanity check the new parameters and push them to the rdm.openlighting.org site.

You can use RDM Pid Builder to add your definitions:
http://imaginux.com/lighting/pids/addpids.php

Or use the tool locally:
https://github.com/RenZ0/rdm-pid-builder

== Structure ==

The section describes the syntax of the parameter definition language in the Python representation used by the rdm.openlighting.org site. The protobuf representation is very similar and the concepts are the same for both representations.

The parameter definitions file is just a Python data structure. At the top level there are two variables <tt>MANUFACTURER_PIDS</tt> and <tt>ESTA_PIDS</tt>.

<pre>
MANUFACTURER_PIDS = [
{'id': <int>, # the manufacturer ID, written in hex
'name': <string>, # the manufacturer name
'pids': [<parameter_definition>],
},
...
]

ESTA_PIDS = [
<parameter_definition>
]
</pre>

Each Parameter Definition takes the form:

<pre>
{
'get_request': {'items': [<item>]},
'get_response': {'items': [<item>]},
'get_sub_device_range': <int>,
'name': <string>,
'set_request': {'items': [<item>]},
'set_response': {'items': [<item>]},
'set_sub_device_range': <int>,
'link': <string>, # the URL for more information
'notes': <string>,
'value': <int>, # the PID
}
</pre>

; {get,set}_request
: The structure of the GET / SET request. This specifies a list of items which are the fields in the parameter message. See the section below for more details.
; {get,set}_response
: The structure of the GET / SET response, same structure as the _request fields.
; {get,set}_sub_device_range
: A value between 0 and 3 which places restrictions on the value of the SubDevice field in the RDM message.
; name
: The name of the PID, should be in CAPS like the names in E1.20
; link
: A URL pointing to where this information was obtained, set to the empty string is there isn't one
; notes
: A text description of what this parameter does. This should be explain to the user how to use the parameter.
; value
: The parameter ID (PID).

The allowed values for the sub_device_ranges are:

; 0
: ROOT_DEVICE, implies the subdevice field is 0x0000
; 1
: ROOT_OR_ALL_SUBDEVICE, the subdevice field is 0x0000 to 0x0200 or 0xffff
; 2
: ROOT_OR_SUBDEVICE, the subdevice field is 0x0000 to 0x0200
; 3
: ONLY_SUBDEVICES, the sub device field is 0x0001 to 0x0200

If a {get,set}_request field isn't present, this means the parameter doesn't support the GET / SET operation. In that case the corresponding _response field should also not be present. Note that this differs from a _request field which is present, but contains no items. The latter means that the parameter data length is 0.

== Items ==

Items represent the data fields within each message. An item can also be a group of items, which is how repeated fields are supported. There are only two required attributes for an item:

<pre>
{
'name': <string>,
'type': <string>',
}
</pre>

Item names should be all lower case, with spaces replaced by _ . In OLA, item names are run through CustomCapitalizeLabel() before being displayed to the user. This replaces '_' with ' ' and capitalizes words. For more details see the code in [http://code.google.com/p/open-lighting/source/browse/common/utils/StringUtils.cpp StringUtils.cpp].

The valid item types are:

* bool
* uint8
* uint16
* uint32
* int8
* int16
* int32
* string
* group, a group of items, see below for more details.
* ipv4, a 32 bit IP address
* uid, a 48 bit UID.

All multi-byte items are big endian.

=== Optional Attributes ===

These are only defined for certain item types.

==== Labels ====

Labels can be used with int items (uint8, uint16, uint32, int8, int16, int32) to attach string descriptions to values.

Using DISPLAY_INVERT as an example:

<pre>
{'name': 'invert_status', 'type': 'uint8',
'labels': [(0, 'Off'), (1, 'On'), (2, 'Auto')],
}
</pre>

Labels implicitly restrict the values that the item can hold. In the example above, a value outside the range 0-2 will generate an exception.

==== Ranges ====

Ranges are used to limit the values for an int item. Using REAL_TIME_CLOCK as the example:

<pre>
{'name': 'month', 'type': 'uint8', 'range': [(1, 12)]}
</pre>

If both ranges and labels are specified, the union of values is used as the set of allowed values for the item.

==== Multiplier ====

This is used to shift the decimal point for int items. For example, in PRESET_INFO, the fade times are reported in 10ths of a second.

<pre>
{'name': 'max_preset_fade_time', 'type': 'uint16', 'multiplier': -1},
</pre>

==== Max Size ====

This limits the maximum size of a string, or the maximum allowed groups in a repeated item. From DEVICE_LABEL:

<pre>
{'name': 'label', 'max_size': 32, 'type': 'string'}
</pre>

==== Min Size ====

The opposite of max_size, used for strings and groups. From LANGUAGE_CAPABILITIES:

<pre>
{'name': 'language', 'max_size': 2, 'min_size': 2, 'type': 'string'}
</pre>

=== Item Groups ===

TODO: fill this in

== Examples ==

These examples show how parameters from E1.20 are described using the PID Definitions Syntax.

=== DEVICE_INFO ===

A simple example is DEVICE_INFO. This is only defined for GET commands, and returns a message with various mixed-type fields:

<pre>
{'get_request': {'items': []},
'get_response': {'items': [
{'name': 'protocol_major', 'type': 'uint8'},
{'name': 'protocol_minor', 'type': 'uint8'},
{'name': 'device_model', 'type': 'uint16'},
{'name': 'product_category', 'type': 'uint16'},
{'name': 'software_version','type': 'uint32'},
{'name': 'dmx_footprint', 'type': 'uint16'},
{'name': 'current_personality', 'type': 'uint8'},
{'name': 'personality_count','type': 'uint8'},
{'name': 'dmx_start_address', 'type': 'uint16'},
{'name': 'sub_device_count','type': 'uint16'},
{'name': 'sensor_count', 'type': 'uint8'}]},
'get_sub_device_range': 2,
'name': 'DEVICE_INFO',
'value': 96},
</pre>

=== DEVICE_LABEL ===

DEVICE_LABEL is defined for GET and SET. This example shows how to limit the length of a string.

<pre>
{'get_request': {'items': []},
'get_response': {'items': [
{'name': 'label', 'max_size': 32, 'type': 'string'}
]},
'get_sub_device_range': 2,
'name': 'DEVICE_LABEL',
'set_request': {'items': [
{'name': 'label','max_size': 32, 'type': 'string'}
]},
'set_response': {'items': []},
'set_sub_device_range': 1,
'value': 130},
}
</pre>

=== SLOT_INFO ===

This example shows how repeated fields work:

<pre>
{'get_request': {'items': []},
'get_response': {'items': [
{'name': 'slots',
'type': 'group',
'items': [
{'name': 'slot_offset', 'type': 'uint16'},
{'name': 'slot_type', 'type': 'uint8'},
{'name': 'slot_label_id', 'type': 'uint16'}
]},
]},
'get_sub_device_range': 2,
'name': 'SLOT_INFO',
'value': 288},
</pre>

RDM PID Definitions

2013-04-06T18:55:00Z

RenZO: /* Structure */ typo fix

== Parameter Definitions and OLA ==

[[OLA]] reads the structure of [[RDM]] parameter messages at runtime. This allows the users to update PID definitions without upgrading the binaries and also means we can add knowledge of new manufacturer PIDs to the RDM controller software very quickly.

To enable this, we've designed a parameter definition language which allows us to describe the structure of RDM parameter messages in a language-independent manner. This language has the following assumptions:

* The structure of a message (i.e. # of repeated values and the length of variable sized fields) must be able to be determined solely from the parameter definition and the length of the message. All parameters in E1.20 and E1.37-1 conform to this, as well as every manufacturer parameter I've encountered. This means that only one variable-sized field can be present in each message, and that [http://en.wikipedia.org/wiki/Type-length-value TLV] style messages aren't supported.

To get the full benefits of the definition language, the parameter definitions should also:

* Use big-endian for multi-byte fields
* When integer values are used, the values are stores as normal int values, not as ASCII.

The canonical parameter definitions are stored on the http://rdm.openlighting.org site. The data from the site is used to generate an ASCII [http://code.google.com/p/protobuf protocol buffer] which is then checked into the OLA codebase and distributed with the tarball. One day we may support automatic updating of the parameter definition files.

You can see the latest pid protobufs at <tt>[http://code.google.com/p/open-lighting/source/browse/data/rdm/pids.proto pids.proto]</tt> and <tt>[http://code.google.com/p/open-lighting/source/browse/data/rdm/manufacturer_pids.proto manufacturer_pids.proto]</tt>. In the tarball the files are in <tt>data/rdm/</tt> and they are usually installed into <tt>/usr/local/share/ola/pids/</tt>.

== Adding New Parameters ==

Parameters are added to the rdm.openlighting.org site by specifying the message structure, as well as properties like the parameter name and PID in a Python file. To get started, clone the rdm.openlighting.org code from http://code.google.com/p/open-lighting/source/checkout?repo=rdm-app. The definitions are found in <tt>data/pid_data.py</tt>. Once you have edited this file push the change to a public git repo and email the open-lighting list asking for a pull request. Simon will sanity check the new parameters and push them to the rdm.openlighting.org site.

TODO: link to and describe Laruent's site.

== Structure ==

The section describes the syntax of the parameter definition language in the Python representation used by the rdm.openlighting.org site. The protobuf representation is very similar and the concepts are the same for both representations.

The parameter definitions file is just a Python data structure. At the top level there are two variables <tt>MANUFACTURER_PIDS</tt> and <tt>ESTA_PIDS</tt>.

<pre>
MANUFACTURER_PIDS = [
{'id': <int>, # the manufacturer ID, written in hex
'name': <string>, # the manufacturer name
'pids': [<parameter_definition>],
},
...
]

ESTA_PIDS = [
<parameter_definition>
]
</pre>

Each Parameter Definition takes the form:

<pre>
{
'get_request': {'items': [<item>]},
'get_response': {'items': [<item>]},
'get_sub_device_range': <int>,
'name': <string>,
'set_request': {'items': [<item>]},
'set_response': {'items': [<item>]},
'set_sub_device_range': <int>,
'link': <string>, # the URL for more information
'notes': <string>,
'value': <int>, # the PID
}
</pre>

; {get,set}_request
: The structure of the GET / SET request. This specifies a list of items which are the fields in the parameter message. See the section below for more details.
; {get,set}_response
: The structure of the GET / SET response, same structure as the _request fields.
; {get,set}_sub_device_range
: A value between 0 and 3 which places restrictions on the value of the SubDevice field in the RDM message.
; name
: The name of the PID, should be in CAPS like the names in E1.20
; link
: A URL pointing to where this information was obtained, set to the empty string is there isn't one
; notes
: A text description of what this parameter does. This should be explain to the user how to use the parameter.
; value
: The parameter ID (PID).

The allowed values for the sub_device_ranges are:

; 0
: ROOT_DEVICE, implies the subdevice field is 0x0000
; 1
: ROOT_OR_ALL_SUBDEVICE, the subdevice field is 0x0000 to 0x0200 or 0xffff
; 2
: ROOT_OR_SUBDEVICE, the subdevice field is 0x0000 to 0x0200
; 3
: ONLY_SUBDEVICES, the sub device field is 0x0001 to 0x0200

If a {get,set}_request field isn't present, this means the parameter doesn't support the GET / SET operation. In that case the corresponding _response field should also not be present. Note that this differs from a _request field which is present, but contains no items. The latter means that the parameter data length is 0.

== Items ==

Items represent the data fields within each message. An item can also be a group of items, which is how repeated fields are supported. There are only two required attributes for an item:

<pre>
{
'name': <string>,
'type': <string>',
}
</pre>

Item names should be all lower case, with spaces replaced by _ . In OLA, item names are run through CustomCapitalizeLabel() before being displayed to the user. This replaces '_' with ' ' and capitalizes words. For more details see the code in [http://code.google.com/p/open-lighting/source/browse/common/utils/StringUtils.cpp StringUtils.cpp].

The valid item types are:

* bool
* uint8
* uint16
* uint32
* int8
* int16
* int32
* string
* group, a group of items, see below for more details.
* ipv4, a 32 bit IP address
* uid, a 48 bit UID.

All multi-byte items are big endian.

=== Optional Attributes ===

These are only defined for certain item types.

==== Labels ====

Labels can be used with int items (uint8, uint16, uint32, int8, int16, int32) to attach string descriptions to values.

Using DISPLAY_INVERT as an example:

<pre>
{'name': 'invert_status', 'type': 'uint8',
'labels': [(0, 'Off'), (1, 'On'), (2, 'Auto')],
}
</pre>

Labels implicitly restrict the values that the item can hold. In the example above, a value outside the range 0-2 will generate an exception.

==== Ranges ====

Ranges are used to limit the values for an int item. Using REAL_TIME_CLOCK as the example:

<pre>
{'name': 'month', 'type': 'uint8', 'range': [(1, 12)]}
</pre>

If both ranges and labels are specified, the union of values is used as the set of allowed values for the item.

==== Multiplier ====

This is used to shift the decimal point for int items. For example, in PRESET_INFO, the fade times are reported in 10ths of a second.

<pre>
{'name': 'max_preset_fade_time', 'type': 'uint16', 'multiplier': -1},
</pre>

==== Max Size ====

This limits the maximum size of a string, or the maximum allowed groups in a repeated item. From DEVICE_LABEL:

<pre>
{'name': 'label', 'max_size': 32, 'type': 'string'}
</pre>

==== Min Size ====

The opposite of max_size, used for strings and groups. From LANGUAGE_CAPABILITIES:

<pre>
{'name': 'language', 'max_size': 2, 'min_size': 2, 'type': 'string'}
</pre>

=== Item Groups ===

TODO: fill this in

== Examples ==

These examples show how parameters from E1.20 are described using the PID Definitions Syntax.

=== DEVICE_INFO ===

A simple example is DEVICE_INFO. This is only defined for GET commands, and returns a message with various mixed-type fields:

<pre>
{'get_request': {'items': []},
'get_response': {'items': [
{'name': 'protocol_major', 'type': 'uint8'},
{'name': 'protocol_minor', 'type': 'uint8'},
{'name': 'device_model', 'type': 'uint16'},
{'name': 'product_category', 'type': 'uint16'},
{'name': 'software_version','type': 'uint32'},
{'name': 'dmx_footprint', 'type': 'uint16'},
{'name': 'current_personality', 'type': 'uint8'},
{'name': 'personality_count','type': 'uint8'},
{'name': 'dmx_start_address', 'type': 'uint16'},
{'name': 'sub_device_count','type': 'uint16'},
{'name': 'sensor_count', 'type': 'uint8'}]},
'get_sub_device_range': 2,
'name': 'DEVICE_INFO',
'value': 96},
</pre>

=== DEVICE_LABEL ===

DEVICE_LABEL is defined for GET and SET. This example shows how to limit the length of a string.

<pre>
{'get_request': {'items': []},
'get_response': {'items': [
{'name': 'label', 'max_size': 32, 'type': 'string'}
]},
'get_sub_device_range': 2,
'name': 'DEVICE_LABEL',
'set_request': {'items': [
{'name': 'label','max_size': 32, 'type': 'string'}
]},
'set_response': {'items': []},
'set_sub_device_range': 1,
'value': 130},
}
</pre>

=== SLOT_INFO ===

This example shows how repeated fields work:

<pre>
{'get_request': {'items': []},
'get_response': {'items': [
{'name': 'slots',
'type': 'group',
'items': [
{'name': 'slot_offset', 'type': 'uint16'},
{'name': 'slot_type', 'type': 'uint8'},
{'name': 'slot_label_id', 'type': 'uint16'}
]},
]},
'get_sub_device_range': 2,
'name': 'SLOT_INFO',
'value': 288},
</pre>

OLA on FreeBSD

2013-03-04T02:20:29Z

RenZO: /* NetBSD */

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD (5.1 or 5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2013-03-04T02:19:23Z

RenZO: /* NetBSD */

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

*$ ./configure
*$ make
*# make install

==OpenBSD==

We still have problems to build on OpenBSD (5.1 or 5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2013-03-04T02:16:54Z

RenZO: /* NetBSD */ add 6.0

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1 or 6.0)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
or
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.0/All/"

* pkg_add bison pkg-config protobuf ossp-uuid cppunit
* pkg_add libmicrohttpd (will install more dependencies)

* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

*./configure
*make
*make install

==OpenBSD==

We still have problems to build on OpenBSD (5.1 or 5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2013-03-02T01:00:16Z

RenZO: /* OpenBSD */ precise versions

Since version 0.8.22, OLA can run on FreeBSD (tested on 9.0).

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

---

Version >= 0.8.22

See here what has been done:

http://forums.freebsd.org/showthread.php?t=33715

---

Code:

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

But you need to know that bsd is not like linux, each system has its kernel and userland.

So it could work on one system and not on another.

==NetBSD==

You can build ola on NetBSD (5.1)

(without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
* pkg_add bison pkg-config protobuf ossp-uuid cppunit

* pkg_add libmicrohttpd (will install more dependencies)
* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

==OpenBSD==

We still have problems to build on OpenBSD (5.1 or 5.2) :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* hack config/ola.m4 if you want
* autoreconf -fi

++

OLA on FreeBSD

2013-03-02T00:40:25Z

RenZO: /* Building OLA */ add link for details

OLA Debian / Ubuntu

2012-10-09T08:23:01Z

RenZO: update about init scripts

Packages are hosted at http://apt.openlighting.org

= Edit sources.list =

Add the relevant line to your /etc/apt/sources.list file

== Debian ==

<pre>
deb http://apt.openlighting.org/debian squeeze main
</pre>

== Raspbian ==

<pre>
deb http://apt.openlighting.org/raspbian wheezy main
</pre>

== Ubuntu Precise 12.04 ==

<pre>
deb http://apt.openlighting.org/ubuntu precise main
</pre>

== Ubuntu Natty 11.04 ==

<pre>
deb http://apt.openlighting.org/ubuntu natty main
</pre>

= Install =

<pre>
apt-get update
apt-get install ola
#Optional:
apt-get install ola-python ola-rdm-tests
</pre>

= Usage =

== OLA daemon ==

Since ola-0.8.23, you can choose to start olad at boot.
The question is asked the first time you install ola.
If you chose 'No', you can change it with:
<pre>sudo dpkg-reconfigure ola</pre>

Since you choose 'Yes', the init script will be active and you will get the advantages below.
Take care, if you start olad manually in a terminal, you will loose these advantages.

*Control the olad process with:
<pre>
sudo /etc/init.d/olad start
sudo /etc/init.d/olad stop
sudo /etc/init.d/olad restart
sudo /etc/init.d/olad status
</pre>

*olad is started by the 'olad' system user (automatically created and added to groups dialout and plugdev).
So olad is ready to use USB devices (thanks to udev rules).

== RDM Test Server ==

Since ola-0.8.25, you can choose to start rdm_test_server at boot.
The question is asked the first time you install ola-rdm-tests.
If you chose 'No', you can change it with:
<pre>sudo dpkg-reconfigure ola-rdm-tests</pre>

Since you choose 'Yes', the init script will be active.

*Control the rdm_test_server process with:
<pre>
sudo /etc/init.d/rdm_test_server start
sudo /etc/init.d/rdm_test_server stop
sudo /etc/init.d/rdm_test_server restart
sudo /etc/init.d/rdm_test_server status
</pre>

= Configuration =

*conf files are in /var/lib/ola/conf/ and owned by 'olad'.
To configure the plugins, you need to add yourself to the olad group.
For example:
<pre>sudo adduser renzo olad</pre>
then logout and login again (you need to do it only once).

You are now able to edit the conf files, for example:
<pre>gedit /var/lib/ola/conf/ola-artnet.conf</pre>

*You can try my bash script to set the plugins easily
<pre>
apt-get update
apt-get install ola-conf-plugins
</pre>

Check the conf path with:
<pre>
sh ola_conf_plugins.sh
---
settings path is:
/var/lib/ola/conf
---
</pre>

If you want to use ftdidmx plugin (for opendmx and so), you need to do:
<pre>
sh ola_conf_plugins.sh disable all
sh ola_conf_plugins.sh enable ftdi
</pre>

= Logs =

*Read the olad logs with:
<pre>cat /var/log/syslog | grep olad</pre>
if you want to see the 20 last lines (including system messages like usb ones):
<pre>cat /var/log/syslog | tail -n20</pre>

= See Also =

[[Notes on Building Debian Packages]]

OLA Debian / Ubuntu

2012-09-22T12:13:58Z

RenZO:

Packages are hosted at http://apt.openlighting.org

= Edit sources.list =

Add the relevant line to your /etc/apt/sources.list file

== Debian ==

<pre>
deb http://apt.openlighting.org/debian squeeze main
</pre>

== Raspbian ==

<pre>
deb http://apt.openlighting.org/raspbian wheezy main
</pre>

== Ubuntu Precise ==

<pre>
deb http://apt.openlighting.org/ubuntu precise main
</pre>

== Ubuntu Natty ==

<pre>
deb http://apt.openlighting.org/ubuntu natty main
</pre>

= Install =

<pre>
apt-get update
apt-get install ola
#Optional:
apt-get install ola-python ola-rdm-tests
</pre>

= Usage =

Since ola-0.8.23, you can choose to start olad at boot.
The question is asked the first time you install ola.
If you chose 'No', you can change it with:
<pre>sudo dpkg-reconfigure ola</pre>

Since you choose 'Yes', the init script will be active and you will get the advantages below.
Take care, if you start olad manually in a terminal, you will loose these advantages.

*Control the olad process with:
<pre>
sudo /etc/init.d/ola start
sudo /etc/init.d/ola stop
sudo /etc/init.d/ola restart
</pre>

*olad is started by the 'olad' system user (automatically created and added to groups dialout and plugdev).
So olad is ready to use USB devices (thanks to udev rules).

*conf files are in /var/lib/ola/conf/ and owned by 'olad'.
To configure the plugins, you need to add yourself to the olad group.
For example:
<pre>sudo adduser renzo olad</pre>
then logout and login again (you need to do it only once).

You are now able to edit the conf files, for example:
<pre>gedit /var/lib/ola/conf/ola-artnet.conf</pre>

*You can try my bash script to set the plugins easily
<pre>
apt-get update
apt-get install ola-conf-plugins
</pre>

Check the conf path with:
<pre>
sh ola_conf_plugins.sh
---
settings path is:
/var/lib/ola/conf
---
</pre>

If you want to use ftdidmx plugin (for opendmx and so), you need to do:
<pre>
sh ola_conf_plugins.sh disable all
sh ola_conf_plugins.sh enable ftdi
</pre>

*Read the olad logs with:
<pre>cat /var/log/syslog | grep olad</pre>
if you want to see the 20 last lines (including system messages like usb ones):
<pre>cat /var/log/syslog | tail -n20</pre>

= See Also =

[[Notes on Building Debian Packages]]

OLA Debian / Ubuntu

2012-09-22T12:12:09Z

RenZO: /* Install */ add ola-rdm-tests

Packages are hosted at http://apt.openlighting.org

= Edit sources.list =

Add the relevant line to your /etc/apt/sources.list file

== Debian ==

<pre>
deb http://apt.openlighting.org/debian squeeze main
</pre>

== Raspbian ==

<pre>
deb http://apt.openlighting.org/raspbian wheezy main
</pre>

== Ubuntu Precise ==

<pre>
deb http://apt.openlighting.org/ubuntu precise main
</pre>

== Ubuntu Natty ==

<pre>
deb http://apt.openlighting.org/ubuntu natty main
</pre>

= Install =

<pre>
apt-get update
apt-get install ola
apt-get install ola-python ola-rdm-tests
</pre>

= Usage =

Since ola-0.8.23, you can choose to start olad at boot.
The question is asked the first time you install ola.
If you chose 'No', you can change it with:
<pre>sudo dpkg-reconfigure ola</pre>

Since you choose 'Yes', the init script will be active and you will get the advantages below.
Take care, if you start olad manually in a terminal, you will loose these advantages.

*Control the olad process with:
<pre>
sudo /etc/init.d/ola start
sudo /etc/init.d/ola stop
sudo /etc/init.d/ola restart
</pre>

*olad is started by the 'olad' system user (automatically created and added to groups dialout and plugdev).
So olad is ready to use USB devices (thanks to udev rules).

*conf files are in /var/lib/ola/conf/ and owned by 'olad'.
To configure the plugins, you need to add yourself to the olad group.
For example:
<pre>sudo adduser renzo olad</pre>
then logout and login again (you need to do it only once).

You are now able to edit the conf files, for example:
<pre>gedit /var/lib/ola/conf/ola-artnet.conf</pre>

*You can try my bash script to set the plugins easily
<pre>
apt-get update
apt-get install ola-conf-plugins
</pre>

Check the conf path with:
<pre>
sh ola_conf_plugins.sh
---
settings path is:
/var/lib/ola/conf
---
</pre>

If you want to use ftdidmx plugin (for opendmx and so), you need to do:
<pre>
sh ola_conf_plugins.sh disable all
sh ola_conf_plugins.sh enable ftdi
</pre>

*Read the olad logs with:
<pre>cat /var/log/syslog | grep olad</pre>
if you want to see the 20 last lines (including system messages like usb ones):
<pre>cat /var/log/syslog | tail -n20</pre>

= See Also =

[[Notes on Building Debian Packages]]

OLA Debian / Ubuntu

2012-09-22T12:09:44Z

RenZO: add raspbian, update ola-conf-plugins

Packages are hosted at http://apt.openlighting.org

= Edit sources.list =

Add the relevant line to your /etc/apt/sources.list file

== Debian ==

<pre>
deb http://apt.openlighting.org/debian squeeze main
</pre>

== Raspbian ==

<pre>
deb http://apt.openlighting.org/raspbian wheezy main
</pre>

== Ubuntu Precise ==

<pre>
deb http://apt.openlighting.org/ubuntu precise main
</pre>

== Ubuntu Natty ==

<pre>
deb http://apt.openlighting.org/ubuntu natty main
</pre>

= Install =

<pre>
apt-get update
apt-get install ola ola-python
</pre>

= Usage =

Since ola-0.8.23, you can choose to start olad at boot.
The question is asked the first time you install ola.
If you chose 'No', you can change it with:
<pre>sudo dpkg-reconfigure ola</pre>

Since you choose 'Yes', the init script will be active and you will get the advantages below.
Take care, if you start olad manually in a terminal, you will loose these advantages.

*Control the olad process with:
<pre>
sudo /etc/init.d/ola start
sudo /etc/init.d/ola stop
sudo /etc/init.d/ola restart
</pre>

*olad is started by the 'olad' system user (automatically created and added to groups dialout and plugdev).
So olad is ready to use USB devices (thanks to udev rules).

*conf files are in /var/lib/ola/conf/ and owned by 'olad'.
To configure the plugins, you need to add yourself to the olad group.
For example:
<pre>sudo adduser renzo olad</pre>
then logout and login again (you need to do it only once).

You are now able to edit the conf files, for example:
<pre>gedit /var/lib/ola/conf/ola-artnet.conf</pre>

*You can try my bash script to set the plugins easily
<pre>
apt-get update
apt-get install ola-conf-plugins
</pre>

Check the conf path with:
<pre>
sh ola_conf_plugins.sh
---
settings path is:
/var/lib/ola/conf
---
</pre>

If you want to use ftdidmx plugin (for opendmx and so), you need to do:
<pre>
sh ola_conf_plugins.sh disable all
sh ola_conf_plugins.sh enable ftdi
</pre>

*Read the olad logs with:
<pre>cat /var/log/syslog | grep olad</pre>
if you want to see the 20 last lines (including system messages like usb ones):
<pre>cat /var/log/syslog | tail -n20</pre>

= See Also =

[[Notes on Building Debian Packages]]

Running the tests

2012-09-15T11:13:08Z

RenZO: Move the warning

This describes how to run the [[OLA RDM Responder Testing | RDM Responder Tests]]. Before starting you may want to read the [[Responder Testing FAQ]].

== Install OLA ==

Follow one of [[OLA on OS X]] or [[OLA on Linux]] or [[OLA on Windows with VMWare]] to install [[OLA]]. If you want the biggest benefit from the tests you should use the version in the git repo as tests are added regularly.

== Setup the Test Rig ==

The following controller devices are supported:
* [[RDM-TRI]]
* [[DMXter4 RDM]] / [[MiniDMXter]]
* [[Robe Universal Interface]] (latest firmware required)
* [[DMX USB Pro]] (latest firmware required)

==== DMXter Instructions ====

You need to put the DMXter into dongle mode. From the RDM menu, hold the left and right buttons and then hit the center button. The display should change to "USB Dongle Mode".

==== RDM TRI Instructions ====

In order to use the full test suite you need to use this interface in raw RDM mode. This allows the test suite to send malformed & unusual RDM packets to check the responder does the right thing. [TODO(someone): confirm which version of the firmware you need for this]

To enable raw rdm mode, in ~/.ola/ola-usbserial.conf, change the '''tri_use_raw_rdm''' line:

<pre>
tri_use_raw_rdm = true
</pre>

== Discovering Responders ==
Connect the device under test to the controller device and start ''olad''. Patch the output port on the controller device to a universe (UNIVERSE_NUMBER). Then run ''ola_rdm_discover'', you should see the responder's UID appear:

$ ola_rdm_discover -u UNIVERSE_NUMBER
00a1:00010003
7a70:ffffff00

== Important ==

<div style="border: 1px solid #ff0000; background-color: #ffccff; padding: 3px">
Warning: The tests send SET messages to the broadcast UIDs. This means that they will change the start address, device label etc. of all devices connected to the controller. Think twice about running this on your production lighting rig.
</div>

== RDM Tests Server and Web UI ==

Since OLA 0.8.23, you can run rdm-tests from a web ui.
Start the server with:
<pre>
$ rdm_test_server.py
Checking olad status
Running RDM Tests Server on 127.0.0.1:9099
</pre>

Then, open a web browser and go to:
http://127.0.0.1:9099/

== Running the Tests from the command line ==

The tests are written in Python and run using ''rdm_responder_test.py''. Below is the output from a typical test run:

$ ./rdm_responder_test.py --universe 1 00a1:00010003
Starting tests, universe 3, UID 00a1:00010003
SetManufacturerLabel: Passed
SetSoftwareVersionLabel: Passed
GetManufacturerLabel: Passed
GetSoftwareVersionLabelWithData: Failed
...
------------- Warnings --------------
------------ By Category ------------
Product Information: 7 / 7 100%
RDM Information: 1 / 1 100%
Core Functionality: 2 / 2 100%
Error Conditions: 10 / 16 62%
DMX512 Setup: 3 / 3 100%
-------------------------------------
29 / 30 tests run, 23 passed, 6 failed, 0 broken

== Useful Options ==

''rdm_responder_test.py'' has some options which can assist in debugging failures. For a full list of options run with -h

; -d, --debug
: Show all debugging output, including actual & expected responses.
; -l, --log
: Log the output of the tests to a file. The UID and timestamp is appended to the filename
; -t Test1,Test2 , --tests=Test1,Test2
: Only run a subset of the Tests. Only the tests listed (and their dependencies) will be run.
;-w BROADCAST_WRITE_DELAY, --broadcast_write_delay=BROADCAST_WRITE_DELAY
: Some responders take time to write state changes to memory. When using broadcast SETs, the controller doesn't know how long to wait before sending the next message. This setting adds a delay after (in ms) to wait after sending broadcast set commands.

Running the tests

2012-09-15T11:08:26Z

RenZO: Add RDM Tests Server

This describes how to run the [[OLA RDM Responder Testing | RDM Responder Tests]]. Before starting you may want to read the [[Responder Testing FAQ]].

== Install OLA ==

Follow one of [[OLA on OS X]] or [[OLA on Linux]] or [[OLA on Windows with VMWare]] to install [[OLA]]. If you want the biggest benefit from the tests you should use the version in the git repo as tests are added regularly.

== Setup the Test Rig ==

The following controller devices are supported:
* [[RDM-TRI]]
* [[DMXter4 RDM]] / [[MiniDMXter]]
* [[Robe Universal Interface]] (latest firmware required)
* [[DMX USB Pro]] (latest firmware required)

==== DMXter Instructions ====

You need to put the DMXter into dongle mode. From the RDM menu, hold the left and right buttons and then hit the center button. The display should change to "USB Dongle Mode".

==== RDM TRI Instructions ====

In order to use the full test suite you need to use this interface in raw RDM mode. This allows the test suite to send malformed & unusual RDM packets to check the responder does the right thing. [TODO(someone): confirm which version of the firmware you need for this]

To enable raw rdm mode, in ~/.ola/ola-usbserial.conf, change the '''tri_use_raw_rdm''' line:

<pre>
tri_use_raw_rdm = true
</pre>

== Discovering Responders ==
Connect the device under test to the controller device and start ''olad''. Patch the output port on the controller device to a universe (UNIVERSE_NUMBER). Then run ''ola_rdm_discover'', you should see the responder's UID appear:

$ ola_rdm_discover -u UNIVERSE_NUMBER
00a1:00010003
7a70:ffffff00

== RDM Tests Server and Web UI ==

Since OLA 0.8.23, you can run rdm-tests from a web ui.
Start the server with:
<pre>
$ rdm_test_server.py
Checking olad status
Running RDM Tests Server on 127.0.0.1:9099
</pre>

Then, open a web browser and go to:
http://127.0.0.1:9099/

== Running the Tests from the command line ==

<div style="border: 1px solid #ff0000; background-color: #ffccff; padding: 3px">
Warning: The tests send SET messages to the broadcast UIDs. This means that they will change the start address, device label etc. of all devices connected to the controller. Think twice about running this on your production lighting rig.
</div>

The tests are written in Python and run using ''rdm_responder_test.py''. Below is the output from a typical test run:

$ ./rdm_responder_test.py --universe 1 00a1:00010003
Starting tests, universe 3, UID 00a1:00010003
SetManufacturerLabel: Passed
SetSoftwareVersionLabel: Passed
GetManufacturerLabel: Passed
GetSoftwareVersionLabelWithData: Failed
...
------------- Warnings --------------
------------ By Category ------------
Product Information: 7 / 7 100%
RDM Information: 1 / 1 100%
Core Functionality: 2 / 2 100%
Error Conditions: 10 / 16 62%
DMX512 Setup: 3 / 3 100%
-------------------------------------
29 / 30 tests run, 23 passed, 6 failed, 0 broken

== Useful Options ==

''rdm_responder_test.py'' has some options which can assist in debugging failures. For a full list of options run with -h

; -d, --debug
: Show all debugging output, including actual & expected responses.
; -l, --log
: Log the output of the tests to a file. The UID and timestamp is appended to the filename
; -t Test1,Test2 , --tests=Test1,Test2
: Only run a subset of the Tests. Only the tests listed (and their dependencies) will be run.
;-w BROADCAST_WRITE_DELAY, --broadcast_write_delay=BROADCAST_WRITE_DELAY
: Some responders take time to write state changes to memory. When using broadcast SETs, the controller doesn't know how long to wait before sending the next message. This setting adds a delay after (in ms) to wait after sending broadcast set commands.

OLA Debian / Ubuntu

2012-09-15T10:44:35Z

RenZO: /* Usage */

Packages are hosted at http://apt.openlighting.org

= Edit sources.list =

Add the relevant line to your /etc/apt/sources.list file

== Debian ==

<pre>
deb http://apt.openlighting.org/debian squeeze main
</pre>

== Ubuntu Precise ==

<pre>
deb http://apt.openlighting.org/ubuntu precise main
</pre>

== Ubuntu Natty ==

<pre>
deb http://apt.openlighting.org/ubuntu natty main
</pre>

= Install =

<pre>
apt-get update
apt-get install ola ola-python
</pre>

= Usage =

Since ola-0.8.23, you can choose to start olad at boot.
The question is asked the first time you install ola.
If you chose 'No', you can change it with:
<pre>sudo dpkg-reconfigure ola</pre>

Since you choose 'Yes', the init script will be active and you will get the advantages below.
Take care, if you start olad manually in a terminal, you will loose these advantages.

*Control the olad process with:
<pre>
sudo /etc/init.d/ola start
sudo /etc/init.d/ola stop
sudo /etc/init.d/ola restart
</pre>

*olad is started by the 'olad' system user (automatically created and added to groups dialout and plugdev).
So olad is ready to use USB devices (thanks to udev rules).

*conf files are in /var/lib/ola/conf/ and owned by 'olad'.
To configure the plugins, you need to add yourself to the olad group.
For example:
<pre>sudo adduser renzo olad</pre>
then logout and login again (you need to do it only once).

You are now able to edit the conf files, for example:
<pre>gedit /var/lib/ola/conf/ola-artnet.conf</pre>

*You can try my bash script to set the plugins easily
(but uncomment the second line to use debian path):
http://www.imaginux.com/ccount/click.php?id=155

Check the conf path with:
<pre>
sh ola_conf_plugins.sh
---
settings path is:
/var/lib/ola/conf
---
</pre>

If you want to use ftdidmx plugin (for opendmx and so), you need to do:
<pre>
sh ola_conf_plugins.sh disable all
sh ola_conf_plugins.sh enable ftdi
</pre>

*Read the olad logs with:
<pre>cat /var/log/syslog | grep olad</pre>
if you want to see the 20 last lines (including system messages like usb ones):
<pre>cat /var/log/syslog | tail -n20</pre>

= See Also =

[[Notes on Building Debian Packages]]

OLA Debian / Ubuntu

2012-09-15T10:32:42Z

RenZO: Add Usage (about init)

OLA Device Specific Configuration

2012-09-09T04:51:50Z

RenZO: /* Linux */

==Anyma ==

===Linux===

You need a [http://www.reactivated.net/writing_udev_rules.html udev rule] like this in /etc/udev/rules.d/10-local.rules

<pre>
# udev rules file for the anyma dmx device
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="05dc", GROUP="plugdev"
</pre>

==ArtNet ==

If you've having problems sending ArtNet data is may be because your receivers don't support ArtNet II and/or send ArtPollReply messages. You can force OLA to always broadcast data by changing ~/.ola/ola-artnet.conf to contain:

always_broadcast = true

==Eurolite USB DMX512 PRO==

===Linux===

Sometime the cdc_acm kernel module claims the device. If this happens you'll see errors like "Cannot claim device" and/or "another process has device opened for exclusive access". To avoid this you can remove the module (rmmod). A udev rule like what is used for the Anyma device should also work.

===Mac===

Install the [http://code.google.com/p/open-lighting/downloads/detail?name=euroliteusbshield.dmg&can=2&q=#makechanges KEXT].

==Open DMX USB / FTDI RS485 ==

There are two options, the 'Open DMX' plugin that requires the kernel module and the native FTDI driver.

===Linux===

If you're using the FTDI Driver, you need to have libftdi-dev installed before you run ./configure. You also need to add the following udev rule

<pre>
# udev rules for ftdi devices
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6001", GROUP="plugdev"
</pre>

==StageProfi==

This comes in two flavors, a USB model and an Ethernet/IP model.

device = /dev/ttyUSB0
device = 192.168.1.250

==USB Pro==

===Mac===

Make sure you install the drives: http://www.ftdichip.com/Drivers/VCP.htm

After a restart run:

ls /dev/cu.usbserial-*

Make sure your ~/.ola/ola-usbpro.conf file matches the path above:

device_dir = /dev
device_prefix = ttyUSB
device_prefix = cu.usbserial-

i.e. Look for devices at /dev/ttyUSB* , /dev/cu.usbserial-*

OLA also comes with a tool to update the firmware on a USB Pro:

./tools/usbpro_firmware -d /dev/cu.usbserial-0000101D -f <firmware_file>

==USBDMX2==

===Linux===

You need a [http://www.reactivated.net/writing_udev_rules.html udev rule] like this in /etc/udev/rules.d/10-local.rules

<pre>
# udev rules file for the usbdmx2 dmx device
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="0962", GROUP="plugdev"
</pre>

There is an issue where the device isn't detected correctly the first time. You may need to restart OLA once the DMX Transmit led comes on.

===Mac===

There is an issue where the device isn't detected correctly the first time. You may need to restart OLA once the DMX Transmit led comes on.

==Velleman VM166 / K8062==

===Mac===

If you're installed from source you'll need the codeless KEXT which is available [http://code.google.com/p/open-lighting/downloads/detail?name=libdmxusbshield.dmg here]. If you installed OLA from the mac binary package this is already included.

===Linux===

You need a [http://www.reactivated.net/writing_udev_rules.html udev rule] like this in /etc/udev/rules.d/10-local.rules

<pre>
# udev rules file for the velleman dmx device
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="10cf", ATTRS{idProduct}=="8062", GROUP="plugdev"
</pre>

Then make sure the user olad runs as is a member of plugdev.

OLA Device Specific Configuration

2012-09-09T04:50:27Z

RenZO: /* Open DMX USB */ update udev rule

==Anyma ==

===Linux===

You need a [http://www.reactivated.net/writing_udev_rules.html udev rule] like this in /etc/udev/rules.d/10-local.rules

<pre>
# udev rules file for the anyma dmx device
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="05dc", GROUP="plugdev"
</pre>

==ArtNet ==

If you've having problems sending ArtNet data is may be because your receivers don't support ArtNet II and/or send ArtPollReply messages. You can force OLA to always broadcast data by changing ~/.ola/ola-artnet.conf to contain:

always_broadcast = true

==Eurolite USB DMX512 PRO==

===Linux===

Sometime the cdc_acm kernel module claims the device. If this happens you'll see errors like "Cannot claim device" and/or "another process has device opened for exclusive access". To avoid this you can remove the module (rmmod). A udev rule like what is used for the Anyma device should also work.

===Mac===

Install the [http://code.google.com/p/open-lighting/downloads/detail?name=euroliteusbshield.dmg&can=2&q=#makechanges KEXT].

==Open DMX USB / FTDI RS485 ==

There are two options, the 'Open DMX' plugin that requires the kernel module and the native FTDI driver.

===Linux===

If you're using the FTDI Driver, you need to have libftdi-dev installed before you run ./configure. You also need to add the following udev rule

<pre>
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6001", GROUP="plugdev"
</pre>

==StageProfi==

This comes in two flavors, a USB model and an Ethernet/IP model.

device = /dev/ttyUSB0
device = 192.168.1.250

==USB Pro==

===Mac===

Make sure you install the drives: http://www.ftdichip.com/Drivers/VCP.htm

After a restart run:

ls /dev/cu.usbserial-*

Make sure your ~/.ola/ola-usbpro.conf file matches the path above:

device_dir = /dev
device_prefix = ttyUSB
device_prefix = cu.usbserial-

i.e. Look for devices at /dev/ttyUSB* , /dev/cu.usbserial-*

OLA also comes with a tool to update the firmware on a USB Pro:

./tools/usbpro_firmware -d /dev/cu.usbserial-0000101D -f <firmware_file>

==USBDMX2==

===Linux===

You need a [http://www.reactivated.net/writing_udev_rules.html udev rule] like this in /etc/udev/rules.d/10-local.rules

<pre>
# udev rules file for the usbdmx2 dmx device
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="0962", GROUP="plugdev"
</pre>

There is an issue where the device isn't detected correctly the first time. You may need to restart OLA once the DMX Transmit led comes on.

===Mac===

There is an issue where the device isn't detected correctly the first time. You may need to restart OLA once the DMX Transmit led comes on.

==Velleman VM166 / K8062==

===Mac===

If you're installed from source you'll need the codeless KEXT which is available [http://code.google.com/p/open-lighting/downloads/detail?name=libdmxusbshield.dmg here]. If you installed OLA from the mac binary package this is already included.

===Linux===

You need a [http://www.reactivated.net/writing_udev_rules.html udev rule] like this in /etc/udev/rules.d/10-local.rules

<pre>
# udev rules file for the velleman dmx device
SUBSYSTEM=="usb|usb_device", ACTION=="add", ATTRS{idVendor}=="10cf", ATTRS{idProduct}=="8062", GROUP="plugdev"
</pre>

Then make sure the user olad runs as is a member of plugdev.

Open Lighting Architecture

2012-09-04T22:05:52Z

RenZO: add *net to FreeBSD

[[Image:OLA-Logo-Fitted-48px.png|right]]
Link: http://code.google.com/p/open-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes|rdm=yes}}
[[Image:Ola-download.png |right|link=http://opendmx.net/index.php/Download_%26_Install_OLA]]
[[Image:Llad_home.png| thumb |200px|right|Universe Settings]]
[[Image:Ola-rdm.png|thumb|200px|right|RDM Devices Page]]
[[Image:OLA_patching.png|thumb|200px|right|Drag & Drop RDM Patching]]
[[Image:Ola-mobile.png|thumb|200px|right|Mobile UI]]

__NOTOC__
The Open Lighting Architecture (OLA) is part of the [[Open Lighting Project]] and provides applications with a mechanism to send and receive [[DMX512]] & [[RDM]] commands using hardware devices and DMX over IP protocols. This enables [[:Category:Controllers | software lighting controllers]] to communicate with hardware either via Ethernet or traditional DMX512 networks.

OLA can also convert DMX512 data sent using DMX over IP protocols from one format to another, allowing devices from different manufacturers to interact with one another. For example a [[Strand_Lighting|Strand]] Lighting Console using ShowNet can send DMX512 to an [[Enttec]] [[DmxEtherGate MKII|EtherGate]]. When combined with a physical DMX interface such as the [[DMX USB Pro]], OLA can send and receive data from wired DMX512 networks.

==Supported Protocols==

{| border=1 cellspacing="0"
! '''Protocol'''!! Linux !! '''Mac OS X''' || '''FreeBSD'''
|-
|| [[:Category:ArtNet|ArtNet, ArtNet 2, ArtNet 3]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]]
|-
|| [[E1.31]] / [[ACN]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:ESP Net|ESP Net]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:Pathport|Pathport]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:Sandnet|Sandnet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:ShowNet|ShowNet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|}

==Supported Devices==

{| border=1 cellspacing="0"
! '''Device'''!! Linux !! '''Mac OS X''' || '''FreeBSD'''
|-
|| [[Anyma uDMX]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Arduino RGB Mixer]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[DMX 4 Linux]] || [[Image:Trans.gif|center]] || || ?
|-
|| [[DMX USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[DMX-TRI]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[DMXking USB DMX512-A]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[DMXter4 RDM]] / [[MiniDMXter]] || [[Image:Rdm.gif|center]] || [[Image:Rdm.gif|center]] || ?
|-
|| [[Eurolite USB DMX512 PRO]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Open DMX USB]] || [[Image:Trans.gif|center]] || || ?
|-
|| [[Packetheads USB_DMX Dongle]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[RDM USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[RDM-TRI]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[Robe Universal Interface]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[RUNIT WTX]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[StageProfi]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] (Ethernet version only) || ?
|-
|| [http://machosehead.wordpress.com/2010/06/12/udmx_asp/ uDMX_asp] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[ultraDMX Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[ultraDMX Micro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[USBDMX2]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Velleman K8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Velleman_K8062_Upgrade|VX8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|}

==Getting Started==

Start here if you've never used OLA before and read these in order.
* [[Download & Install OLA]]
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]
* [[RDM with OLA]]

Tutorials
* [[OLA on Windows with VMWare]]
* [[OLA Live CD]], instructions on how to use the Live CD
* [[OLA Raspberry Pi]]
* [[OlaOutput Max External]] - Setup OlaOutput on Mac OS X to send DMX messages from Max/MSP/Jitter
* [[OLAGuruPlug]] - Running OLA on a [http://www.globalscaletechnologies.com/c-4-guruplugs.aspx GuruPlug]
* [[OlaLED]] - control RGB LED via http
* [[OLA RDM Responder Testing]]

Advanced Topics:
* [[OLA Merging Algorithms]]
* [[OLA DiffServ support]] (QOS settings)
* [[OLA DMX Trigger]]

Developer Documentation:
* [[OLA developer info]] - about the source code and structure
* [[OLA Client API]] - the C++ API
* [[OLA Python API]] - easy DMX programming
* [[Build OLA Mac Packages]] - notes for building the .dmg images
* [[Building OLA for Windows]] - Notes on Windows support (in progress)
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++
* [[Writing RDM Responder Tests]]
* [[Port Throttling]]
* [[OLA Performance Stats]]
* [[OLA TimeCode]]

Tutorials, these refer to the previous release but parts of them are still relevant.
* [[LLA Sandnet Tutorial]] - Setup Horizon using Sandnet and LLA
* [[LLA and Q Light Controller Ubuntu Tutorial]] - Setup LLA on Ubuntu/Debian-type distro with QLC
* [[LLA and Q Light Controller OSX Tutorial]] - Setup LLA on Mac OS X with QLC

[[Category:ArtNet]]
[[Category:ESP Net]]
[[Category:E1.31]]
[[Category:Sandnet]]
[[Category:ShowNet]]
[[Category:Utilities]]
[[Category:Pathport]]

Open Lighting Architecture

2012-09-04T20:37:58Z

RenZO: add ArtNet and E1.31 to FreeBSD

[[Image:OLA-Logo-Fitted-48px.png|right]]
Link: http://code.google.com/p/open-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes|rdm=yes}}
[[Image:Ola-download.png |right|link=http://opendmx.net/index.php/Download_%26_Install_OLA]]
[[Image:Llad_home.png| thumb |200px|right|Universe Settings]]
[[Image:Ola-rdm.png|thumb|200px|right|RDM Devices Page]]
[[Image:OLA_patching.png|thumb|200px|right|Drag & Drop RDM Patching]]
[[Image:Ola-mobile.png|thumb|200px|right|Mobile UI]]

__NOTOC__
The Open Lighting Architecture (OLA) is part of the [[Open Lighting Project]] and provides applications with a mechanism to send and receive [[DMX512]] & [[RDM]] commands using hardware devices and DMX over IP protocols. This enables [[:Category:Controllers | software lighting controllers]] to communicate with hardware either via Ethernet or traditional DMX512 networks.

OLA can also convert DMX512 data sent using DMX over IP protocols from one format to another, allowing devices from different manufacturers to interact with one another. For example a [[Strand_Lighting|Strand]] Lighting Console using ShowNet can send DMX512 to an [[Enttec]] [[DmxEtherGate MKII|EtherGate]]. When combined with a physical DMX interface such as the [[DMX USB Pro]], OLA can send and receive data from wired DMX512 networks.

==Supported Protocols==

{| border=1 cellspacing="0"
! '''Protocol'''!! Linux !! '''Mac OS X''' || '''FreeBSD'''
|-
|| [[:Category:ArtNet|ArtNet, ArtNet 2, ArtNet 3]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]]
|-
|| [[E1.31]] / [[ACN]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:ESP Net|ESP Net]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:Pathport|Pathport]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:Sandnet|Sandnet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:ShowNet|ShowNet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|}

==Supported Devices==

{| border=1 cellspacing="0"
! '''Device'''!! Linux !! '''Mac OS X''' || '''FreeBSD'''
|-
|| [[Anyma uDMX]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Arduino RGB Mixer]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[DMX 4 Linux]] || [[Image:Trans.gif|center]] || || ?
|-
|| [[DMX USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[DMX-TRI]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[DMXking USB DMX512-A]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[DMXter4 RDM]] / [[MiniDMXter]] || [[Image:Rdm.gif|center]] || [[Image:Rdm.gif|center]] || ?
|-
|| [[Eurolite USB DMX512 PRO]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Open DMX USB]] || [[Image:Trans.gif|center]] || || ?
|-
|| [[Packetheads USB_DMX Dongle]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[RDM USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[RDM-TRI]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[Robe Universal Interface]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[RUNIT WTX]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[StageProfi]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] (Ethernet version only) || ?
|-
|| [http://machosehead.wordpress.com/2010/06/12/udmx_asp/ uDMX_asp] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[ultraDMX Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[ultraDMX Micro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[USBDMX2]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Velleman K8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Velleman_K8062_Upgrade|VX8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|}

==Getting Started==

Start here if you've never used OLA before and read these in order.
* [[Download & Install OLA]]
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]
* [[RDM with OLA]]

Tutorials
* [[OLA on Windows with VMWare]]
* [[OLA Live CD]], instructions on how to use the Live CD
* [[OLA Raspberry Pi]]
* [[OlaOutput Max External]] - Setup OlaOutput on Mac OS X to send DMX messages from Max/MSP/Jitter
* [[OLAGuruPlug]] - Running OLA on a [http://www.globalscaletechnologies.com/c-4-guruplugs.aspx GuruPlug]
* [[OlaLED]] - control RGB LED via http
* [[OLA RDM Responder Testing]]

Advanced Topics:
* [[OLA Merging Algorithms]]
* [[OLA DiffServ support]] (QOS settings)
* [[OLA DMX Trigger]]

Developer Documentation:
* [[OLA developer info]] - about the source code and structure
* [[OLA Client API]] - the C++ API
* [[OLA Python API]] - easy DMX programming
* [[Build OLA Mac Packages]] - notes for building the .dmg images
* [[Building OLA for Windows]] - Notes on Windows support (in progress)
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++
* [[Writing RDM Responder Tests]]
* [[Port Throttling]]
* [[OLA Performance Stats]]
* [[OLA TimeCode]]

Tutorials, these refer to the previous release but parts of them are still relevant.
* [[LLA Sandnet Tutorial]] - Setup Horizon using Sandnet and LLA
* [[LLA and Q Light Controller Ubuntu Tutorial]] - Setup LLA on Ubuntu/Debian-type distro with QLC
* [[LLA and Q Light Controller OSX Tutorial]] - Setup LLA on Mac OS X with QLC

[[Category:ArtNet]]
[[Category:ESP Net]]
[[Category:E1.31]]
[[Category:Sandnet]]
[[Category:ShowNet]]
[[Category:Utilities]]
[[Category:Pathport]]

OLA Notes on Building Debian Packages

2012-08-11T22:57:50Z

RenZO: chmod info

These are mostly Simon's notes to himself on how to build the packages to the Raspberry Pi. RenZO looks after the Debian config files.

* Download tarball, unpack
* Edit debian/changelog to have the following

<pre>
ola (0.8.22-1~squeeze1) squeeze; urgency=low
</pre>

* Run debuild -B, to build the arch dependent, binary packages (arch-independent packages are done by Renzo).
* Make sure that your files are chmod 644 (-rw-r--r--)
* Make sure ~/.dupload.conf is setup correctly:

<pre>
package config;

delete $preupload{'changes'};

$cfg{'openlighting-debian'} = {
fqdn => "apt.openlighting.org",
login => "simon",
method => "scp",
incoming => "/opt/packages/incoming/debian/",
};

$default_host = "openlighting-debian";
</pre>

* Run dupload:

<pre>
dupload ola_0.8.22-1_armel.changes
</pre>

If having more than one dupload config:
<pre>
dupload -t openlighting-ubuntu precise32/*changes
</pre>

OLA Notes on Building Debian Packages

2012-08-11T17:11:17Z

RenZO:

These are mostly Simon's notes to himself on how to build the packages to the Raspberry Pi. RenZO looks after the Debian config files.

* Download tarball, unpack
* Edit debian/changelog to have the following

<pre>
ola (0.8.22-1~squeeze1) squeeze; urgency=low
</pre>

* Run debuild -B, to build the arch dependent, binary packages (arch-independent packages are done by Renzo).
* Make sure ~/.dupload.conf is setup correctly:

<pre>
package config;

delete $preupload{'changes'};

$cfg{'openlighting-debian'} = {
fqdn => "apt.openlighting.org",
login => "simon",
method => "scp",
incoming => "/opt/packages/incoming/debian/",
};

$default_host = "openlighting-debian";
</pre>

* Run dupload:

<pre>
dupload ola_0.8.22-1_armel.changes
</pre>

If having more than one dupload config:
<pre>
dupload -t openlighting-ubuntu precise32/*changes
</pre>

OLA on FreeBSD

2012-08-09T23:34:31Z

RenZO: /* Other BSD */ info about bsd nature

OLA on FreeBSD

2012-08-09T07:30:19Z

RenZO:

OLA on FreeBSD

2012-08-08T22:18:18Z

RenZO: precise bsd versions

OLA on FreeBSD

2012-08-08T21:46:20Z

RenZO: /* NetBSD */

Since version 0.8.22, OLA can run on FreeBSD.

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

Version >= 0.8.22

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

==NetBSD==

You can build ola (without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
* pkg_add bison pkg-config protobuf ossp-uuid cppunit

* pkg_add libmicrohttpd (will install more dependencies)
* pkg_add ncurses (not enough, feel free to edit)
* pkg_add autoconf automake libtool
* pkg_add scmgit (to use git repo)

* $ ./configure --disable-fatal-warnings
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* autoreconf -fi

++

OLA on FreeBSD

2012-08-08T21:40:33Z

RenZO: /* OpenBSD */ link to the bug

Since version 0.8.22, OLA can run on FreeBSD.

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

Version >= 0.8.22

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

==NetBSD==

You can build ola (without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit
* pkg_add -r ncurses (not enough)
* pkg_add -r libmicrohttpd (will install more dependencies)
* pkg_add -r autoconf automake libtool

* $ ./configure --disable-fatal-warnings
* $ make
* # make install

==OpenBSD==

We still have problems to build on OpenBSD :/

Because of this bug:

http://code.google.com/p/protobuf/issues/detail?id=406

But you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* autoreconf -fi

++

OLA on FreeBSD

2012-08-07T22:46:21Z

RenZO: add Other BSD

Since version 0.8.22, OLA can run on FreeBSD.

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

=Building OLA=

You can use the tarball or git to get the code.

Version >= 0.8.22

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

=Other BSD=

We don't forget these nice systems !

==NetBSD==

You can build ola (without python-libs because python-protobuf is missing):

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit
* pkg_add -r ncurses (not enough)
* pkg_add -r libmicrohttpd (will install more dependencies)
* pkg_add -r autoconf automake libtool

* $ ./configure --disable-fatal-warnings
* $ make
* # make install

==OpenBSD==

Some packages are missing but you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* autoreconf -fi

We still have problems to build on OpenBSD :/

++

OLA on FreeBSD

2012-08-07T21:45:35Z

RenZO: add NetBSD

Since version 0.8.22, OLA can run on FreeBSD.

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Tools==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

==OpenBSD==

Some packages are missing but you can try with:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* autoreconf -fi

==NetBSD==

Some packages are missing but you can try with:

* ksh (Don't forget to switch to ksh !)
* export PKG_PATH="http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/5.1/All/"
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit
* pkg_add -r libmicrohttpd (will install more dependencies)
* pkg_add -r autoconf automake libtool

=Building OLA=

You can use the tarball or git to get the code.

Version >= 0.8.22

http://code.google.com/p/open-lighting/source/checkout

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

Since you built with libmicrohttpd, you can use the web UI from http://127.0.0.1:9090

Enjoy :)

OLA on FreeBSD

2012-08-07T07:51:01Z

RenZO: /* OpenBSD */

Since version 0.8.22, OLA can run on FreeBSD.

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Git==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

==OpenBSD==

It's almost the same packages with OpenBSD (5.1), if you want to try to build:

* export PKG_PATH="ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/"
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* autoreconf -fi

=Building OLA=

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

You can use the web UI from http://127.0.0.1:9090

Enjoy :)

Open Lighting Architecture

2012-08-06T20:49:59Z

RenZO: /* Supported Devices */ add dmx-tri and usb pro to freebsd

[[Image:Ola.png|right]]
Link: http://code.google.com/p/open-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes|rdm=yes}}
[[Image:Ola-download.png |right|link=http://opendmx.net/index.php/Download_%26_Install_OLA]]
[[Image:Llad_home.png| thumb |200px|right|Universe Settings]]
[[Image:Ola-rdm.png|thumb|200px|right|RDM Devices Page]]
[[Image:OLA_patching.png|thumb|200px|right|Drag & Drop RDM Patching]]
[[Image:Ola-mobile.png|thumb|200px|right|Mobile UI]]

__NOTOC__
The Open Lighting Architecture (OLA) is part of the [[Open Lighting Project]] and provides applications with a mechanism to send and receive [[DMX512]] & [[RDM]] commands using hardware devices and DMX over IP protocols. This enables [[:Category:Controllers | software lighting controllers]] to communicate with hardware either via Ethernet or traditional DMX512 networks.

OLA can also convert DMX512 data sent using DMX over IP protocols from one format to another, allowing devices from different manufacturers to interact with one another. For example a [[Strand_Lighting|Strand]] Lighting Console using ShowNet can send DMX512 to an [[Enttec]] [[DmxEtherGate MKII|EtherGate]]. When combined with a physical DMX interface such as the [[DMX USB Pro]], OLA can send and receive data from wired DMX512 networks.

==Supported Protocols==

{| border=1 cellspacing="0"
! '''Protocol'''!! Linux !! '''Mac OS X''' || '''FreeBSD'''
|-
|| [[:Category:ArtNet|ArtNet, ArtNet 2, ArtNet 3]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]] || ?
|-
|| [[E1.31]] / [[ACN]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:ESP Net|ESP Net]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:Pathport|Pathport]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:Sandnet|Sandnet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[:Category:ShowNet|ShowNet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|}

==Supported Devices==

{| border=1 cellspacing="0"
! '''Device'''!! Linux !! '''Mac OS X''' || '''FreeBSD'''
|-
|| [[Anyma uDMX]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Arduino RGB Mixer]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[DMX 4 Linux]] || [[Image:Trans.gif|center]] || || ?
|-
|| [[DMX USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[DMX-TRI]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[DMXking USB DMX512-A]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[DMXter4 RDM]] / [[MiniDMXter]] || [[Image:Rdm.gif|center]] || [[Image:Rdm.gif|center]] || ?
|-
|| [[Eurolite USB DMX512 PRO]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Open DMX USB]] || [[Image:Trans.gif|center]] || || ?
|-
|| [[Packetheads USB_DMX Dongle]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ?
|-
|| [[RDM USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[RDM-TRI]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[Robe Universal Interface]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[RUNIT WTX]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ?
|-
|| [[StageProfi]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] (Ethernet version only) || ?
|-
|| [http://machosehead.wordpress.com/2010/06/12/udmx_asp/ uDMX_asp] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[ultraDMX Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ?
|-
|| [[USBDMX2]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Velleman K8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|-
|| [[Velleman_K8062_Upgrade|VX8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ?
|}

==Getting Started==

Start here if you've never used OLA before and read these in order.
* [[Download & Install OLA]]
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]
* [[RDM with OLA]]

Tutorials
* [[OLA on Windows with VMWare]]
* [[OLA Live CD]], instructions on how to use the Live CD
* [[OLA Raspberry Pi]]
* [[OlaOutput Max External]] - Setup OlaOutput on Mac OS X to send DMX messages from Max/MSP/Jitter
* [[OLAGuruPlug]] - Running OLA on a [http://www.globalscaletechnologies.com/c-4-guruplugs.aspx GuruPlug]
* [[OlaLED]] - control RGB LED via http
* [[OLA RDM Responder Testing]]

Advanced Topics:
* [[OLA Merging Algorithms]]
* [[OLA DiffServ support]] (QOS settings)
* [[OLA DMX Trigger]]

Developer Documentation:
* [[OLA developer info]] - about the source code and structure
* [[OLA Client API]] - the C++ API
* [[OLA Python API]] - easy DMX programming
* [[Build OLA Mac Packages]] - notes for building the .dmg images
* [[Building OLA for Windows]] - Notes on Windows support (in progress)
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++
* [[Writing RDM Responder Tests]]
* [[Port Throttling]]
* [[OLA Performance Stats]]
* [[OLA TimeCode]]

Tutorials, these refer to the previous release but parts of them are still relevant.
* [[LLA Sandnet Tutorial]] - Setup Horizon using Sandnet and LLA
* [[LLA and Q Light Controller Ubuntu Tutorial]] - Setup LLA on Ubuntu/Debian-type distro with QLC
* [[LLA and Q Light Controller OSX Tutorial]] - Setup LLA on Mac OS X with QLC

[[Category:ArtNet]]
[[Category:ESP Net]]
[[Category:E1.31]]
[[Category:Sandnet]]
[[Category:ShowNet]]
[[Category:Utilities]]
[[Category:Pathport]]

OLA on FreeBSD

2012-08-06T18:19:05Z

RenZO: /* Dependencies */ add infos about openbsd

Since version 0.8.22, OLA can run on FreeBSD.

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

==Packages==

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

pkg_info (FreeBSD 9.0-RELEASE)

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==Git==

If you want to run autoreconf (after git clone for example):
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

==OpenBSD==

It's almost the same packages with OpenBSD (5.1), if you want to try to build:

* export PKG_PATH=”ftp://ftp.openbsd.org/pub/OpenBSD/5.1/packages/i386/”
* pkg_add bison protobuf ossp-uuid cppunit

* pkg_add autoconf automake (it will tell you the versions)
* pkg_add autoconf-2.68 automake-1.11.1p2 libtool
* export AUTOCONF_VERSION=2.68
* export AUTOMAKE_VERSION=1.11
* autoreconf -fi

=Building OLA=

You just need to run:
* $ ./configure (--enable-rdm-tests will need python)
* $ make
* # make install

=Running OLA=

* $ olad -l3

You can use the web UI from http://127.0.0.1:9090

Enjoy :)

OLA on FreeBSD

2012-08-05T02:12:04Z

RenZO:

OLA on FreeBSD

2012-08-05T01:54:04Z

RenZO:

OLA on FreeBSD

2012-08-05T01:13:45Z

RenZO: complete dependencies

=Dependencies=

* pkg_add -r bison (will install m4, libiconv, gettext)
* pkg_add -r pkg-config
* pkg_add -r protobuf
* pkg_add -r ossp-uuid
* pkg_add -r cppunit
* pkg_add -r libmicrohttpd

* pkg_add -r python27
* pkg_add -r py27-protobuf (will install py27-setuptools)

You can use this combo line:
* pkg_add -r bison pkg-config protobuf ossp-uuid cppunit libmicrohttpd python27 py27-protobuf

==On FreeBSD 9.0-RELEASE==

pkg_info

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* gettext-0.18.1.1 GNU gettext package
* libiconv-1.13.1_1 A character set conversion library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality
* m4-1.4.16,1 GNU m4
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* pkg-config-0.25_1 A utility to retrieve information about installed libraries
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* py27-setuptools-0.6c11_1 Download, build, install, upgrade, and uninstall Python pac
* python27-2.7.2_3 An interpreted object-oriented programming language

==For building==

If you want to run autoreconf:
* pkg_add -r autoconf268 automake111 libtool

pkg_info

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

OLA on FreeBSD

2012-08-03T22:38:05Z

RenZO:

=Dependencies=

* pkg_add -r bison ossp-uuid cppunit protobuf libmicrohttpd
* pkg_add -r python27 py27-protobuf
* pkg_add -r autoconf268 automake111 libtool

==On FreeBSD 9.0-RELEASE==

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality

==For building==

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

OLA on FreeBSD

2012-08-03T22:36:23Z

RenZO:

Dependencies:

* pkg_add -r bison ossp-uuid cppunit protobuf libmicrohttpd
* pkg_add -r python27 py27-protobuf
* pkg_add -r autoconf268 automake111 libtool

----

On FreeBSD 9.0-RELEASE:

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality

For building:

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script

OLA on FreeBSD

2012-08-03T22:35:19Z

RenZO: freebsd dependencies

Dependencies:

* pkg_add -r bison ossp-uuid cppunit protobuf libmicrohttpd
* pkg_add -r python27 py27-protobuf
* pkg_add -r autoconf268 automake111 libtool

----

On FreeBSD 9.0-RELEASE:

* bison-2.4.3,1 A parser generator from FSF, (mostly) compatible with Yacc
* ossp-uuid-1.6.2_1 ISO-C & Perl API and CLI for generating Universally Unique
* cppunit-1.12.1 C++ port of the JUnit framework for unit testing
* protobuf-2.4.1 A data interchange format library
* py27-protobuf-2.4.1 Google protobuf Python Client Library
* libmicrohttpd-0.9.15 C library for embedding HTTP server functionality

* autoconf-2.68 Automatically configure source code on many Un*x platforms
* automake-1.11.1 GNU Standards-compliant Makefile generator (1.11)
* libtool-2.4_1 Generic shared library support script