wiki.openlighting.org - User contributions [en]

OLP SOC Ideas Page

2012-02-12T06:23:43Z

216.239.45.130:

This page lists some ideas for [http://www.google-melange.com/gsoc/homepage/google/gsoc2012 Google Summer of Code 2012] projects for the [[Open Lighting Project]]. You can use these ideas as a basis for your application, or come up with something different. Please see the Google SOC site for the 2012 timeline. If you are thinking of applying to work with us, please send an email to the [https://groups.google.com/forum/?fromgroups#!forum/open-lighting Open Lighting List] introducing yourself.

==Port to Windows Platforms ==

This is the most requested 'feature' and would significantly expand the reach of the project. The current, supported method of running OLA on Windows is using VMWare ([[OLA_on_Windows_with_VMWare|instructions]]). This is sub optimal, since it requires the use of non-free software, is challenging for users without unix command line experience, and doesn't allow Windows applications to communicate with OLA. Work on a Windows port commenced in mid 2011 (see [[Building_OLA_for_Windows|these Notes]]), but was postponed due to lack of resources.

This project would include:
* Refactoring the base classes under [http://code.google.com/p/linux-lighting/source/browse/#git%2Fcommon%2Fnetwork common/network] to use the Windows network & event management APIs and ensuring that all unit tests pass.
* Cleaning up various parts of the code which use POSIX APIs (see http://code.google.com/p/linux-lighting/issues/detail?id=139 for an example)

A Windows port would enable lighting controller applications like [[QLC]] and [[D::Light]] to move to OLA entirely, and not have to maintain their own plugins.

'''Skills Required''': C++, Windows Network Programming 
'''Estimated Difficulty''': Hard

== Asynchronous Web Notification of RDM Messages ==

Thanks to sites like GMail and Facebook, users have come to expect asynchronous notification of events in their web browser. [[RDM]] enabled lighting devices can generate events such as ''Over Temperature'' and ''Lamp Faulty'' so it would be nice to alert the users to this. This project would involve work with two Open Source efforts. The student would need to work with [http://www.gnu.org/software/libmicrohttpd/ libmicrohttpd] to add [http://en.wikipedia.org/wiki/WebSocket WebSocket] support (see the [http://lists.gnu.org/archive/html/libmicrohttpd/2012-01/msg00015.html email thread]).

The second step would involve using WebSockets to deliver events to the browser, and building a UI to notify the user. The [[OLA]] UI is built with [http://code.google.com/closure/ Google Closure].

'''Skills Required''': C++, Network Programming, Javascript, HTML, Google Closure 
'''Estimated Difficulty''': Medium

== Web Based Configuration of Preferences ==

User Preferences for [[OLA]] are stored in text files but the web UI provides no method for changing any preferences beyond port patchings. At the moment the user is required to stop the OLA Daemon, exit the text files and restart if settings are to be changed. This project would involve building a generic preference store and exposing it through the web UI. Changing preferences on the fly is likely to expose bugs in some of the OLA plugins. These will need to be fixed.

'''Skills Required''': C++, Javascript, HTML 
'''Estimated Difficulty''': Easy

== Web Based RDM Tests & Integration with the RDM Index ==

The [[RDM Responder Testing][Automated RDM Responder Tests]] have been very popular in the industry and are used by many manufacturers to test their products prior to release. At the moment the tests are run from the command line and rely on the test engineers to write scripts to post process the test output. Building a web UI for the tests would make them easier to use for the manufacturers and give us the ability to provide more control over how the tests are run.

The second part of this project covers the [http://rdm.openlighting.org/ RDM Product Index], a website that collects information on [[RDM]] enabled products and make it freely available. The work would be to expand the [http://code.google.com/p/linux-lighting/source/browse/tools/rdm/model_collector.py model_collector.py] script to automatically upload new responder data to the site, and build a system for a human to sanity check the new data before publishing it.

'''Skills Required''': Python, HTML, Javascript 
'''Estimated Difficulty''': Easy

RDM Discovery

2012-02-12T03:05:29Z

216.239.45.130: /* Responders that don't mute */

This briefly describes the [[RDM]] discovery process and outlines various scenarios that should be considered when writing software that performs RDM Discovery. Unlike [[DMX]], [[RDM]] is bi-directional, which means bugs in responders can cause the controller to crash or go in to an infinite loop.

This page is not a substitute for the [[E1.20]] standard, which takes precedence over all information presented here. It simply presents situations which designers of controllers should consider when writing their software.

== Process Overview ==

Each responder has a unique identifier (UID) which consists of a 2 byte ESTA manufacturer ID, and a 4 byte device ID. Like a MAC address, no two responders should have the same UID. The 'all devices' UID (ffff:ffffffff) is a broadcast address, to which all devices will listen but not necessarily take action or respond.

There are three RDM messages used during the discovery process, all use the DISCOVERY_COMMAND Command Class.

* DISC_UNIQUE_BRANCH, which takes two parameters, a lower and an upper UID. Any responders within this range (inclusive) must respond.
* DISC_MUTE
* DISC_UN_MUTE

There are many different ways to implement the discovery process, one (simplified) method is described below:

# Send a DISC_UNMUTE to the ALL DEVICES UID
# Send a DISC_MUTE to any previously discovered devices, if they don't respond after multiple attempts remove them from the UID list.
# Send a DISC_UNIQUE_BRANCH with a range of (0000:00000000, ffff:ffffffff). One of three things can happen:
#* No response, which generally means there are no further responders to be muted
#* A single response with a valid checksum. In this case the controller should attempt to mute the responder (DISC_MUTE) and if that succeeds, add the responder to the list of UIDs.
#* A collision, in which case a controller should divide the range in two (0000:7fff:ffffffff), (8000:00000000, ffff:ffffffff) and proceed from step 3.

If everything goes well, eventually all devices will be muted and sending a DISC_UNIQUE_BRANCH with a range of (0000:00000000, ffff:ffffffff) will result in no responses.

== Failure Modes ==

=== Responders that reply outside their range ===

Responders may have bugs in the UID inequality code, causing them to reply to DISC_UNIQUE_BRANCH messages which don't cover their UID. One example may be a responder that replies when just the Manufacturer ID part of the UID matches. Depending on the type of bug, discovery can sometimes proceed in these cases and usually other devices are found and muted first before the bad responder is located.

The worst case is a responder that replies to every DISC_UNIQUE_BRANCH request, which usually prevents discovery of any other responders.

=== Responders that don't reply when within range ===

The opposite of the case above is where a responder fails to respond to a DISC_UNIQUE_BRANCH request for a range which it is part of. A common example of this is the off-by-one case, where a responder doesn't reply if it's at the endpoints of the range. This can cause responders to 'disappear' which happens when a range that previously caused a collision, produces no responses when split in two.

Without proper detection, this can cause controllers to loop indefinitely as they try to locate the missing responders.

=== Responders that don't reply to Mute ===

Some responders may not reply to the MUTE_DEVICE message. This behavior must be differentiated from the case where the MUTE_DEVICE message is corrupted or lost so the responder never replies. The pseudo-code in the [[E1.20]] standard attempts to mute each device up to 10 times before continuing.

=== Responders that don't mute ===

Not to be confused with the scenario above, some responders may acknowledge the MUTE_DEVICE request but continue to respond to discovery requests. If there is only one responder that behaves this way controllers should be able to succeed, but it causes more DISC_UNIQUE_BRANCH messages than required.

=== Proxied Devices ===

The [[E1.20]] states that a proxy shall not provide more than one DISC_UNIQUE_BRANCH response at once. This means that once the proxy has been located and muted, controllers must continue to send DISC_UNIQUE_BRANCH and mute devices one at a time until all proxied devices are found. Alternatively, the PROXIED_DEVICES message can be used to fetch all repsonders located behind a proxy. The key point here is that it's generally not sufficient to do a single pass over the tree, as muting responders (proxies) can cause more responders to appear.

== Example Implementation ==

The implementation of the RDM discovery algorithm as used in the [[Open Lighting Architecture]] can be seen [http://code.google.com/p/linux-lighting/source/browse/common/rdm/DiscoveryAgent.cpp here] . The tests which cover the cases above are in [http://code.google.com/p/linux-lighting/source/browse/common/rdm/DiscoveryAgentTest.cpp DiscoveryAgentTest.cpp]

[[Category:Articles]]

Template:News

2011-01-30T01:30:55Z

216.239.45.130:

<div style="float:right; margin:8px; width:50%; border:1px solid #0000ff">
{| width="100%" cellpadding="4" cellspacing="0"
|-
| bgcolor="#A7C1F2" align="center" | '''Lighting News'''
|-
| {{NewsHeading}} '''OLA on Windows with VMWare''' 29/1/11
|-
| A [[OLA on Windows with VMWare| OLA VMWare Tutorial]] has been added which describes how to setup [[OLA]] on Windows PCs using VMWare.
|-
| {{NewsHeading}} '''RDM Parameter Index Launched ''' 19/1/11
|-
| The [http://rdm.openlighting.org/ Open Lighting Pid Store] holds an index of Manufacturer specific [[RDM]] PIDs. This data is freely available for download from the site.
|-
| {{NewsHeading}} '''libartnet running on iPads''' 16/9/10
|-
| Thanks to Tobi Schäfer, [[libartnet]] is now running on Apple iPads. Instructions are at [[IPad ArtNet Node]].
|-
| {{NewsHeading}} '''OLA 0.8.0 released, now with RDM''' 7/8/10
|-
| [[OLA]] 0.8.0 is the first release to support [[RDM]]. The instructions at [[RDM with OLA]] explain how to get started with RDM, even if you don't own any RDM devices.
|-
| {{NewsHeading}} '''OLA now running on the GuruPlug''' 21/5/10
|-
| [[OLA]] 0.7.4 has been released, and ARM packages for the GuruPlug are now [[OLAGuruPlug|available]]. OLA now supports 9 USB to DMX devices.
|-
| {{NewsHeading}} '''OLA for Max/MSP Released''' 13/4/10
|-
| [http://code.google.com/p/olaoutput/ OlaOutput] allows [http://cycling74.com/products/maxmspjitter/ Max] to communicate with [[OLA]]. See the [[OlaOutput Max External]] tutorial on how to set this up.
|-
| {{NewsHeading}} '''Arduino RGB USB Device''' 7/2/10
|-
| The [[Arduino RGB Mixer]] is a simple & inexpensive way to control RGB LED strips using USB.
|-
|}
</div>

Template:News

2011-01-30T01:30:10Z

216.239.45.130:

<div style="float:right; margin:8px; width:50%; border:1px solid #0000ff">
{| width="100%" cellpadding="4" cellspacing="0"
|-
| bgcolor="#A7C1F2" align="center" | '''Lighting News'''
|-
| {{NewsHeading}} '''OLA on Windows with VMWare''' 29/1/11
|-
| A [[OLA on Windows with VMWare| OLA VMWare Tutorial]] has been added which describes how to setup [[OLA]] on Windows PCs using VMWare.
|-
| {{NewsHeading}} '''RDM Parameter Index Launched ''' 1/19/11
|-
| The [http://rdm.openlighting.org/ Open Lighting Pid Store] holds an index of Manufacturer specific [[RDM]] PIDs. This data is freely available for download from the site.
|-
| {{NewsHeading}} '''libartnet running on iPads''' 16/9/10
|-
| Thanks to Tobi Schäfer, [[libartnet]] is now running on Apple iPads. Instructions are at [[IPad ArtNet Node]].
|-
| {{NewsHeading}} '''OLA 0.8.0 released, now with RDM''' 7/8/10
|-
| [[OLA]] 0.8.0 is the first release to support [[RDM]]. The instructions at [[RDM with OLA]] explain how to get started with RDM, even if you don't own any RDM devices.
|-
| {{NewsHeading}} '''OLA now running on the GuruPlug''' 21/5/10
|-
| [[OLA]] 0.7.4 has been released, and ARM packages for the GuruPlug are now [[OLAGuruPlug|available]]. OLA now supports 9 USB to DMX devices.
|-
| {{NewsHeading}} '''OLA for Max/MSP Released''' 13/4/10
|-
| [http://code.google.com/p/olaoutput/ OlaOutput] allows [http://cycling74.com/products/maxmspjitter/ Max] to communicate with [[OLA]]. See the [[OlaOutput Max External]] tutorial on how to set this up.
|-
| {{NewsHeading}} '''Arduino RGB USB Device''' 7/2/10
|-
| The [[Arduino RGB Mixer]] is a simple & inexpensive way to control RGB LED strips using USB.
|-
|}
</div>

RDM with OLA

2010-08-06T17:36:47Z

216.239.45.130:

[[RDM]] devices can be configured through the web interface (only partially complete) or from the command line. Even if you don't have any RDM devices you can still experiment with RDM because the Dummy Plugin creates a fake RDM device.

== Device Discovery ==

The ''ola_rdm_discovery'' tool displays the UIDs found for each universe.
<pre>
$ ola_rdm_discover -u 1
414c:010014b3
</pre>

Passing the -f options will force the discovery algorithm to be run for the particular universe. This won't produce any output unless and error occurs.

<pre>
$ ola_rdm_discover -u 1 -f
</pre>

== Device Configuration ==

The ''ola_rdm_get'' and ''ola_rdm_get'' commands allow attributes of the devices to be controlled. The first thing to do is to view a list of all known attributes:

<pre>
$ ola_rdm_get --list_pids
boot_software_version_id
boot_software_version_label
capture_preset
clear_status_id
comms_status
default_slot_value
device_hours
device_info
...
</pre>

To fetch the value of a PID from a device use:

<pre>
$ ola_rdm_get --universe 1 --uid 414c:010014b3 device_info
</pre>

Changing the value works in a similar way:

<pre>
$ ola_rdm_set --universe 1 --uid 414c:010014b3 comms_status # clear the communication counters
</pre>

The full list of options can be found by running with --help:

<pre>
-d, --sub_device <device> target a particular sub device (default is 0)
-h, --help display this help message and exit.
-l, --list_pids display a list of pids
-u, --universe <universe> universe number.
--uid <uid> the UID of the device to control.
</pre>

== Useful Tricks ==

If you're using bash, it's worthwhile to set up tab completion of PIDs:

<pre>
$ complete -W "$(ola_rdm_get -l | xargs)" ola_rdm_get
$ complete -W "$(ola_rdm_get -l | xargs)" ola_rdm_set
</pre>

Building OLA for Windows

2010-07-28T17:18:56Z

216.239.45.130:

This describes how to get OLA compiled for windows, it's a work in progress so it's unlikely to work as is.

== Install Mingw, msys & build tools ==

The instructions at http://www.mingw.org/wiki/MSYS are very helpful. There are similar instructions at http://www.cccp-project.net/wiki/index.php?title=Installing_MSYS-MinGW

* Install mingw and msys

* Download these packages
** autoconf [http://ftp.gnu.org/gnu/autoconf/]
** automake [http://ftp.gnu.org/gnu/automake/]
** libtool [http://ftp.gnu.org/gnu/libtool/]

* Launch the msys shell

* Unpack autoconf, automake and libtool to a directory of your choice.

* Install each of them with the following command:

$ ./configure --prefix=/mingw && make && make install

* Update PKG_CONFIG_PATH

As all the libraries will be installed in /mingw, PKG_CONFIG_PATH must be set.

Open the file /etc/profile (C:\msys\1.0\etc\profile) with your favorite editor (make sure it uses LF line endings) and add:

PKG_CONFIG_PATH="/mingw/lib/pkgconfig"

You might also want to set CFLAGS. Safe options for MinGW are:

CFLAGS="-pipe -O2 -mms-bitfields -march=i686"

just before

export HOME LOGNAME MSYSTEM HISTFILE

and modify that line by adding the variables:

export HOME LOGNAME MSYSTEM HISTFILE CFLAGS PKG_CONFIG_PATH

Now restart MSYS. You should now be able to use MSYS without problems.

== Install Git ==

See http://code.google.com/p/msysgit/, be sure to select "unix style carriage returns" otherwise you'll get autoconf errors.

== Install Dependencies ==

* http://code.google.com/p/protobuf/ . Note you need to install the .tar.gz as the zip just contains protoc (we need the libraries as well)
* http://www.ossp.org/pkg/lib/uuid/ , be sure to run configure with ./configure --prefix=/mingw --includedir /mingw/include/ossp
* http://sourceforge.net/projects/cppunit/files/ , download version
* http://code.google.com/p/google-ctemplate/ , you need at least 0.97, see http://code.google.com/p/google-ctemplate/issues/detail?id=48

== Build OLA ==

* Do a git checkout of OLA

* Run ./configure
$ ./configure

* Build
$ make

== Current TODO ==

* Fix the Socket & SelectServer classes or replace them with whatever makes sense on windows
* The USB Pro plugin needs a way to find devices, obviously /dev doesn't exist
* The DMX USB requires libusb win32. Not sure what the status of this is

== Problems ==

Open Lighting Architecture

2010-07-09T18:16:37Z

216.239.45.130:

[[Image:Ola.png|right]]
Link: http://code.google.com/p/linux-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes|rdm=yes}}

OLA (Open Lighting Architecture) is an open source framework which provides applications with a mechanism to send and receive [[DMX512]] using hardware devices and DMX over IP protocols. It enables [[:Category:Controllers | software controllers]] to communicate with DMX hardware either via Ethernet or over traditional DMX512 networks.

[[Image:Llad_home.png|right]]
OLA can also convert DMX data sent using DMX over IP protocols from one format to another, allowing devices from different manufacturers to interact with each other. For example a [[Strand_Lighting|Strand]] Lighting Console using ShowNet can send DMX 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 traditional wired DMX networks.

OLA can run on Linux and on Mac OS X. A port to Windows is feasible if someone wants to add the necessary platform-dependent code.

Contribute: Looking to help? Visit the [[OLA Contributors]] page. The page also lists people and companies who have supported OLA. Please support them in return!

Bugs: Check the bug tracker at http://code.google.com/p/linux-lighting/issues/list

Questions: See the news group at http://groups.google.com/group/open-lighting

Supported Protocols:

{| border=1 cellspacing="0"
! '''Protocol'''!! Linux !! '''Mac OS X'''
|-
|| [[:Category:ArtNet|ArtNet]] || [[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'''
|-
|| [[Anyma uDMX]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[Arduino RGB Mixer]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[DMX 4 Linux]] || [[Image:Trans.gif|center]] ||
|-
|| [[DMX USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]]
|-
|| [[DMX-TRI]] || [[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]]
|-
|| [[Open DMX USB]] || [[Image:Trans.gif|center]] ||
|-
|| [[Packetheads USB_DMX Dongle]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[RDM-TRI]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]]
|-
|| [[StageProfi]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] *
|-
|| [http://machosehead.wordpress.com/2010/06/12/udmx_asp/ uDMX_asp] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[USBDMX2]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[Velleman K8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|}

* Ethernet version only

Getting Started

Start here if you've never used OLA before and read these in order.
* [[Download OLA]]
* [[OLA on OS X]] or [[OLA on Linux]] - How to 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]]

Tutorials
* [[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]

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

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++
* [[Port Throttling]]
* [[OLA Performance Stats]]

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

Deprecated Documentation
* [[OLA 0.3]] - Release Notes

OLA can also run on a wireless access point. [http://nomis52.net/?section=projects&sect2=artnet&page=node]

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

Template:News

2010-05-29T03:23:41Z

216.239.45.130:

<div style="float:right; margin:8px; width:50%; border:1px solid #0000ff">
{| width="100%" cellpadding="4" cellspacing="0"
|-
| bgcolor="#A7C1F2" align="center" | '''Lighting News'''
|-
| {{NewsHeading}} '''OLA now running on the GuruPlug''' 21/5/10
|-
| [[OLA]] 0.7.4 has been released, and ARM packages for the GuruPlug are now [[OLAGuruPlug|available]]. OLA now supports 9 USB to DMX devices.
|-
| {{NewsHeading}} '''OLA for Max/MSP Released''' 13/4/10
|-
| [http://code.google.com/p/olaoutput/ OlaOutput] allows [http://cycling74.com/products/maxmspjitter/ Max] to communicate with [[OLA]]. See the [[OlaOutput Max External]] tutorial on how to set this up.
|-
| {{NewsHeading}} '''Arduino RGB USB Device''' 7/2/10
|-
| The [[Arduino RGB Mixer]] is a simple & inexpensive way to control RGB LED strips using USB.
|-
| {{NewsHeading}} '''Open Lighting Architecture 0.5.0 Released''' 21/11/09
|-
| [[OLA]] 0.5.0 has been released. It now supports SandNet and automatic USB Pro detection.
|-
| {{NewsHeading}} '''Open Lighting Architecture 0.4.0 Released''' 18/10/09
|-
| [[OLA]] 0.4.0 now supports Streaming DMX over ACN known as [[E1.31]].
|-
|}
</div>

Open Lighting Architecture

2010-04-20T01:13:08Z

216.239.45.130:

Link: http://code.google.com/p/linux-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes}}
[[Image:Llad_home.png|right]]

OLA (Open Lighting Architecture) is a framework that allows applications to send and receive [[DMX512]], using various hardware devices and 'DMX over IP' protocols. It enables [[:Category:Controllers | software controllers]] talk to DMX hardware.

OLA allows DMX sent using various DMX over IP protocols to be converted from one format to another. This enables devices from different manufacturers to talk to each another (for example a [[Strand_Lighting|Strand]] Console can send DMX 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 traditional wired DMX networks.

OLA can run on Linux and on Mac OS X. A port to Windows is feasible if someone wants to add the necessary platform-dependent code for plug-ins and create an installer.

Contribute: Looking to help? Visit the [[OLAContributors]] page.

Bugs: Check the bug tracker at http://code.google.com/p/linux-lighting/issues/list

Questions: See the news group at http://groups.google.com/group/open-lighting

Supported Devices/Protocols:

{| border=1
! '''Device / Protocol'''!! Linux !! '''Mac OS X'''
|-
|| [[Anyma uDMX]] || Yes || Yes
|-
|| [[Arduino RGB Mixer]] || Yes || Yes
|-
|| [[:Category:ArtNet|ArtNet]] || Yes || Yes
|-
|| [[DMX 4 Linux]] || Yes || -
|-
|| [[DMX USB Pro]] || Yes || Yes
|-
|| [[DMX-TRI]] || Yes || Yes
|-
|| [[DMXking USB DMX512-A]] || Yes || Yes
|-
|| [[E1.31]] / [[ACN]] || Yes || Yes
|-
|| [[:Category:ESP Net|ESP Net]] || Yes || Yes
|-
|| [[Open DMX USB]] || Yes || -
|-
|| [[:Category:Pathport|Pathport]] || Yes || Yes
|-
|| [[:Category:Sandnet|Sandnet]] || Yes || Yes
|-
|| [[:Category:ShowNet|ShowNet]] || Yes || Yes
|-
|| [[StageProfi]] || Yes || Ethernet version only
|-
|| [[USBDMX2]] || Yes || Yes
|-
|| [[Velleman K8062]] || Yes || Yes
|}

Getting Started

Start here if you've never used OLA before and read these in order.
* [[Download OLA]]
* [[OLA on OS X]] or [[OLA on Linux]] - How to get it compiled.
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]

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

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++
* [[Port Throttling]]
* [[OLA Performance Stats]]

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
* [[OlaOutput Max External]] - Setup OlaOutput on Mac OS X to send DMX messages from Max/MSP/Jitter

Deprecated Documentation
* [[OLA 0.3]] - Release Notes

OLA can also run on a wireless access point. [http://nomis52.net/?section=projects&sect2=artnet&page=node]

There is a project underway to build packages for OpenWrt. See http://lists.culturebase.org/cgi-bin/mailman/listinfo/lla-openwrt for more details.

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

USB Protocol Extensions

2010-04-18T17:48:48Z

216.239.45.130:

This documents the additional message types added to the [[Enttec]] [[DMX USB Pro]] protocol to support multiple device types. As the number of devices supporting the protocol grows, it becomes difficult for software like [[OLA]] to differentiate the device types. The ''Device Manufacturer'' & ''Device Name'' messages allow the host software to determine the device and know which set of messages it supports.

== Other Solutions ==

=== USB Serial Number ===

Enttec USB Pro devices have only started programming the serial numbers recently (>2008?).
When using the standard USB Serial drivers on Mac & Linux, the host application doesn't have access to the serial numbers. This would require us to write our own USB drivers using libusb to expose this information.

=== Use the User Addressable EEPROM ===

Some devices don't support the ''Set Widget Parameters'' message so this isn't an option. Also it suffers from the bootstrapping issue, we need to know what device it is before we can write the information about what device it is...

== Device Manufacturer, Label = 77, no data ==

This message requests the device manufacturer information from the widget. The response is of the form:

{| border=1
! '''Size in Bytes'''!! Description
|-
|| 2 || [[ESTA]] ID, Least significant byte first
|-
|| 32 || Up to 32 bytes containing the manufacturer name. Not null terminated.
|}

== Device Name, Label = 78, no data ==

This message requests the device name information from the widget. The response is of the form:

{| border=1
! '''Size in Bytes'''!! Description
|-
|| 2 || Device Type ID, Manufacturer assigned. Least significant byte first.
|-
|| 32 || Up to 32 bytes containing the device type. Not null terminated.
|}

== Devices Supporting these Message Types ==

* [[Arduino RGB Mixer]] , ESTA ID: 0x7a70, Device ID: 0x1
* [[DMX-TRI]], ESTA ID: 0x6864, Device ID 0x0: 0x1
* [[DMXking USB DMX512-A]], ESTA ID: 0x6A6B, Device ID: 0x0

== External References ==

* [http://www.enttec.com/docs/dmx_usb_pro_api_spec.pdf DMX Pro API]
* [http://www.esta.org/tsp/working_groups/CP/mfctrIDs.php ESTA IDs]

OlaOutput Max External

2010-04-17T20:26:39Z

216.239.45.130:

=== How to use the OlaOutput Max External ===

'''This article describes how to configure OlaOutput on Mac OS X 10.5 (or greater) for use in Cycling 74's Max/MSP/Jitter or Ableton MaxForLive environments.
'''

==Download and Install OLA==

*Download the latest build of OLA from [http://code.google.com/p/linux-lighting/downloads/list here] and install it. OlaOutput is only compatible with OS X (for now).

*OLA is a separate application from Ableton Live and Max/MSP/Jitter. To use OlaOutput to send DMX, you need to start the OLA daemon first.
'''NOTE:''' Before you do this, make sure any USB devices you wish to use are plugged in and their drivers are installed.

*Open Terminal (found in Applications/Utilities), type the following and press enter:

<code><pre>olad</pre></code>

This starts the OLA daemon.

==Configure OLA==

*OLA has a HTTP web interface for configuration. You can access it at: [http://localhost:9090 http://localhost:9090]

*OLA won’t do anything until it’s configured. You need to setup which DMX universe each hardware device will operate on. To do this, select ‘Devices’ from the left-hand menu in the OLA web interface.

*Click on the + next to the device you wish to use. You will see a variety of boxes labeled ‘IN’ and ‘OUT’. We want to configure a universe for output, so choose the correct ‘OUT’ box for the port you wish to use and enter a number into it to specify the universe. A universe value of 1 a typical starting value.

*Once you’ve done this, click ’Save Changes’ at the bottom of the list.

*Click on ‘Universes’ on the left-hand menu. You should now see a list of the universes specified for output, which should include the one you just specified.

*Click on the 'Console' link, and use the sliders to test that OLA is controlling your DMX devices

==Install and Use OlaOutput in Max/MSP/Jitter==

*To install OlaOutput as a Max/MSP external, [http://code.google.com/p/olaoutput/downloads/list download the latest version] and place the files in a folder somewhere on your system. Make a note of this path for the next step.

*Load Max/MSP. Choose ''Options>File Preferences…''. Then use the plus button on the lower left to add the path to the folder containing the externals you wish to install. This will tell Max to look in this folder for externals to use. Make sure you keep the files in this place, or Max will be unable to locate them.

*Create a new Max patcher, and add an OlaObject to the canvas. If Max is unable to find OlaOutput, it will log a message to its output window.

*The OlaOutput object has 2 inlets. The left inlet is used to send a series of DMX messages using the list structure. The (optional) right inlet is used to set the universe that is the destination for messages. For further details about how to use OlaOutput in Max, consult the ''OlaOutput.maxhelp'' file included in the download.

*Create a message object in Max with the values <code>128 200 250</code> (separated by spaces). Connect the outlet of this message object to the left inlet of the OlaOutput object.

*Lock the patcher, and click on the message object. The above values (128, 200, 250) should be sent out to channels 1, 2, 3 respectively.

==Wrapping Up==

*Once you’re done, you can shut down olad using the 'stop olad' link on the ‘Home’ page of OLA's web interface. OLA will remember your universe patchings next time you start it up.

For additional help and information about OLA, visit the [[OLA| OLA Wiki]] page.

[[Category:Articles]]

Template:News

2010-04-17T20:22:33Z

216.239.45.130:

<div style="float:right; margin:8px; width:50%; border:1px solid #0000ff">
{| width="100%" cellpadding="4" cellspacing="0"
|-
| bgcolor="#A7C1F2" align="center" | '''Lighting News'''
|-
| {{NewsHeading}} '''OLA for Max/MSP Released''' 13/4/10
|-
| [http://code.google.com/p/olaoutput/ OlaOutput] allows [http://cycling74.com/products/maxmspjitter/ Max] to communicate with [[OLA]]. See the [[OlaOutput Max External]] tutorial on how to set this up.
|-
| {{NewsHeading}} '''Arduino RGB USB Device''' 7/2/10
|-
| The [[Arduino RGB Mixer]] is a simple & inexpensive way to control RGB LED strips using USB.
|-
| {{NewsHeading}} '''Open Lighting Architecture 0.5.0 Released''' 21/11/09
|-
| [[OLA]] 0.5.0 has been released. It now supports SandNet and automatic USB Pro detection.
|-
| {{NewsHeading}} '''Open Lighting Architecture 0.4.0 Released''' 18/10/09
|-
| [[OLA]] 0.4.0 now supports Streaming DMX over ACN known as [[E1.31]].
|-
| {{NewsHeading}} '''Open Lighting Architecture 0.3.0 Released''' 8/8/09
|-
| The [http://code.google.com/p/linux-lighting/ Open Lighting Project] has released [[OLA]] 0.3.0. OLA provides a cross-platform, cross language library for communicating with DMX devices (both locally and network based).
|-
| {{NewsHeading}} '''Luminair Updated'''
|-
| The team at SyntheFX has released [[Luminair]] 1.5.3, the premier iPhone app for controlling DMX lights.
|}
</div>

DMX USB Pro

2010-03-20T22:50:35Z

216.239.45.130:

[[Category:USB]]

[[Image:Dmxusb_pro.jpg|right]]

Link: http://www.enttec.com/index.php?main_menu=Products&prod=70304&show=description&name=dmxusbpro 
Made by: [[Enttec]] 
{{Features|win=yes|osx=yes|linux=yes|tx=yes|rx=yes|rdm=yes}}

The pro widget unlike it's little brother (The Open DMX USB) contains a microprocessor (ATMEGA88) responsible for framing and transmission, or reception of dmx. Also it's USB interface is a FTDI FT245BM, so VCP (virtual com port) drivers make programming easy as opening a serial port and sending/receiving!

It has 1500v dmx line isolation, A green LED which indicates RX or TX activity, and gold plated Neutrik XLR's (1xmale, 1xfemale wired in parallel). Later versions have NewTide clones of the genuine Neutrik XLR's.

The timings of the transmitted DMX signal can be adjusted.
According the [[Enttec]] [http://enttec.com web site], it has limited [[RDM]] support, and only in some firmware versions, see [http://www.enttec.com/index.php?main_menu=Products&prod=70304&show=firmware] for details.

Enttec provides programs to update the firmware on Windows and Mac. [[LLA]] has a tool to update the firmware which works on Linux and Mac, otherwise [http://kev.coolcavemen.com/2009/05/enttec-dmx-usb-firmware-upgrade-with-qemu/ qemu] can be used.

Earlier units did not have serial numbers programmed and this may affect the ability of certain applications to identify multiple Pro units connected simultaneously.

An open source alternative is available from [[DMXKing]].

Related Products:

* [[RDM USB Pro]]
* [[Open DMX USB]]
* [[DMXking USB DMX512-A]]
* [[Pro Toolkit]]
* [[StageConsole]]
* [[MiniStageConsole]]

Open Lighting Architecture

2010-03-20T22:50:31Z

216.239.45.130:

Link: http://code.google.com/p/linux-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes}}
[[Image:Llad_home.png|right]]

OLA (Open Lighting Architecture) is a framework that allows applications to send and receive [[DMX512]], using various hardware devices and 'DMX over IP' protocols. It enables [[:Category:Controllers | software controllers]] talk to DMX hardware.

OLA allows DMX sent using various DMX over IP protocols to be converted from one format to another. This enables devices from different manufacturers to talk to each another (for example a [[Strand_Lighting|Strand]] Console can send DMX 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 traditional wired DMX networks.

OLA can run on Linux and on Mac OS X. A port to Windows is feasible if someone wants to add the necessary platform-dependent code for plug-ins and create an installer.

Bugs: Check the bug tracker at http://code.google.com/p/linux-lighting/issues/list

Questions: See the news group at http://groups.google.com/group/open-lighting

Supported Devices/Protocols:

{| border=1
! '''Device / Protocol'''!! Linux !! '''Mac OS X'''
|-
|| [[Arduino RGB Mixer]] || Yes || Yes
|-
|| [[:Category:ArtNet|ArtNet]] || Yes || Yes
|-
|| [[DMX 4 Linux]] || Yes || -
|-
|| [[DMX USB Pro]] || Yes || Yes
|-
|| [[DMX-TRI]] || Yes || Yes
|-
|| [[DMXking USB DMX512-A]] || Yes || Yes
|-
|| [[E1.31]] / [[ACN]] || Yes || Yes
|-
|| [[:Category:ESP Net|ESP Net]] || Yes || Yes
|-
|| [[Open DMX USB]] || Yes || -
|-
|| [[:Category:Pathport|Pathport]] || Yes || Yes
|-
|| [[:Category:Sandnet|Sandnet]] || Yes || Yes
|-
|| [[:Category:ShowNet|ShowNet]] || Yes || Yes
|-
|| [[StageProfi]] || Yes || Ethernet version only
|}

Getting Started

Start here if you've never used OLA before and read these in order.
* [[Download OLA]]
* [[OLA on OS X]] or [[OLA on Linux]] - How to get it compiled.
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]

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

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++

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

Deprecated Documentation
* [[OLA 0.3]] - Release Notes

OLA can also run on a wireless access point. [http://nomis52.net/?section=projects&sect2=artnet&page=node]

There is a project underway to build packages for OpenWrt. See http://lists.culturebase.org/cgi-bin/mailman/listinfo/lla-openwrt for more details.

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

Open Lighting Architecture

2009-11-15T21:39:32Z

216.239.45.130:

Link: http://code.google.com/p/linux-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes}}
[[Image:Llad_home.png|right]]

OLA (Open Lighting Architecture) is a framework that allows applications to send and receive DMX, using various hardware devices and 'DMX over IP' protocols. It can make [[:Category:Controllers | software controllers]] talk to DMX hardware. It was formerly known as LLA.

OLA allows DMX sent using various DMX over IP protocols to be converted from one format to another. This enables devices from different manufacturers to talk to each another (for example a [[Strand_Lighting|Strand]] Console can send DMX to an [[Enttec]] [[DmxEtherGate MKII|EtherGate]]).

[[OLA Live]] is a stand-alone bootable CD containing software from the Open Lighting Architecture project.

When combined with a physical DMX interface such as the [[DMX USB Pro]], OLA Live can send and receive data from traditional wired DMX networks.

OLA can run on '''Linux''' with all its plugins, and on '''Mac OS X''' (but at the moment not all the plugins have been ported). A port to '''Windows''' is partly done, but more help/work is needed, if someone wants to add the necessary code for plug-ins and a installer.

Bugs: Check the bug tracker at http://code.google.com/p/linux-lighting/issues/list

Questions: See the news group at http://groups.google.com/group/open-lighting

Supported Devices/Protocols:

{| border=1
! '''Driver'''!! Linux !! '''Mac OS X'''
|-
|| [[:Category:ArtNet|ArtNet]] || Yes || Yes
|-
|| [[:Category:ShowNet|ShowNet]] || Yes || Yes
|-
|| [[:Category:ESP Net|ESP Net]] || Yes || Yes
|-
|| [[:Category:Sandnet|Sandnet]] || Yes || Yes
|-
|| [[E1.31]] / [[ACN]] || Yes || Yes
|-
|| [[DMX USB Pro]] || Yes || Yes
|-
|| [[Open DMX USB]] || Yes || ??
|-
|| [[StageProfi]] || Yes || ??
|-
|| [[:Category:Pathport|Pathport]] || in testing || in testing
|-
|| [[DMX 4 Linux]] || Yes || -
|}

Getting Started

Start here if you've never used OLA before and read these in order.
* [[Download OLA]]
* [[OLA 0.3]] - The latest release
* [[OLA on OS X]] or [[OLA on Linux]] - How to get it compiled.
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]

Developer Documentation:
* [[OLA developer info]] - about the source code and structure
* [[OLA Client API]] - the C++ API
* [[OLA Python API]] - easy DMX programming

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

OLA can also run on a wireless access point. [http://nomis52.net/?section=projects&sect2=artnet&page=node]

There is a project underway to build packages for OpenWrt. See http://lists.culturebase.org/cgi-bin/mailman/listinfo/lla-openwrt for more details.

[[Category:ArtNet]]
[[Category:ESP Net]]
[[Category:Sandnet]]
[[Category:ShowNet]]
[[Category:Utilities]]