Personal tools
The Open Lighting Project has moved!

We've launched our new site at www.openlighting.org. This wiki will remain and be updated with more technical information.

Difference between revisions of "Open Lighting Architecture"

From wiki.openlighting.org

Jump to: navigation, search
m (→‎Developer Documentation: More APIs)
 
(135 intermediate revisions by 34 users not shown)
Line 1: Line 1:
−
Link: http://code.google.com/p/linux-lighting/ <br>
+
[[Image:OLA-Logo-Fitted-48px.png|right]]
−
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes}}
+
Link: http://www.openlighting.org/ola/ <br>
−
[[Image:Llad_home.png|right]]
+
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes|rdm=yes|win=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 (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 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.
  
−
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.
+
==Supported Protocols==
  
−
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.
+
{| border=1 cellspacing="0"
 +
! '''Protocol'''!! Linux !! '''Mac OS X'''  || '''FreeBSD''' || '''Windows'''
 +
|-
 +
|| [[: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]] || [[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]] ||  Not yet
 +
|-
 +
|| [[:Category:ESP Net|ESP Net]] || [[Image:Green-tick.png|center]]  || [[Image:Green-tick.png|center]]  || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
 +
|-
 +
|| [[KiNET]] ||  [[Image:Trans.gif|center]]  ||  [[Image:Trans.gif|center]] ||  [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
 +
|-
 +
|| [[OSC]] (Open Sound Control)  || [[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]] || [[Image:Green-tick.png|center]]
 +
|-
 +
|| [[:Category:Sandnet|Sandnet]] || [[Image:Green-tick.png|center]]  || [[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]] || [[Image:Green-tick.png|center]]
 +
|}
  
  
−
<b>Bugs</b>: Check the bug tracker at http://code.google.com/p/linux-lighting/issues/list
+
==Supported Devices==
  
−
<b>Questions</b>: See the news group at http://groups.google.com/group/open-lighting
+
{| border=1 cellspacing="0"
−
 
+
! '''Device'''!! Linux !! '''Mac OS X''' || '''FreeBSD''' || '''Windows'''
−
 
+
|-
−
<b>Supported Devices/Protocols:</b>
+
||  [[Anyma uDMX]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]  || ? || no
−
 
+
|-
−
{| border=1
+
|| [[Arduino RGB Mixer]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]]  || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || ? || no
−
! '''Device / Protocol'''!! Linux !! '''Mac OS X'''  
+
|-
 +
|| [[DMX 4 Linux]] || [[Image:Trans.gif|center]]  ||  ||  ? || no
 +
|-
 +
|| [[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]] || no
 +
|-
 +
|| [[DMX USB Pro MkII]] || [[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]] || no
 +
|-
 +
|| [[DMX-TRI]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]] || no
 +
|-
 +
|| [[DMXking USB DMX512-A]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ? || no
 +
|-
 +
|| [[DMXter4 RDM]] / [[MiniDMXter]] || [[Image:Rdm.gif|center]] || [[Image:Rdm.gif|center]] || ? || no
 +
|-
 +
|| [[Eurolite USB DMX512 PRO]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]  || ? || no
 +
|-
 +
|| [[KarateLight]] || [[Image:Trans.gif|center]] ||  || ? || no
 +
|-
 +
|| [http://kmtronic.com/kmtronic-dmx-adapter.html KMtronic DMX Adapter] || [[Image:Trans.gif|center]] ||  || ? || no
 +
|-
 +
|| [[Open DMX USB]] || [[Image:Trans.gif|center]]  ||  || ? || no
 
|-
 
|-
−
|| [[Anyma uDMX]] || In development || In development
+
|| [[Milford Instruments 1-463]] || [[Image:Trans.gif|center]] || ? || ? || no
 
|-
 
|-
−
|| [[Arduino RGB Mixer]] || Yes || Yes
+
|| [[Packetheads USB_DMX Dongle]] || [[Image:Green-tick.png|center]]  ||  [[Image:Green-tick.png|center]]  || ? || no
 
|-
 
|-
−
|| [[:Category:ArtNet|ArtNet]]   || Yes || Yes
+
|| [[RDM USB Pro]] || [[Image:Trans.gif|center]]  [[Image:Recv.gif|center]]  || [[Image:Trans.gif|center]]  [[Image:Recv.gif|center]] || ? || no
 
|-
 
|-
−
|| [[DMX 4 Linux]] || Yes || -
+
|| [[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]]  || no
 
|-
 
|-
−
|| [[DMX USB Pro]] || Yes || Yes
+
|| [http://www.doityourselfchristmas.com/wiki/index.php?title=Renard Renard Serial Protocol (Renard SS24, SS8, etc)] || [[Image:Trans.gif|center]] || ? || ? || no
 
|-
 
|-
−
|| [[DMX-TRI]] || Yes || Yes
+
|| [[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]] || ? || no
 
|-
 
|-
−
|| [[DMXking USB DMX512-A]] || Yes || Yes
+
|| [[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]] ||  ? || no
 
|-
 
|-
−
|| [[E1.31]] / [[ACN]] || Yes || Yes
+
|| [[OLA_LED_Pixels|SPI control of LED pixels]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || ? || ? || no
 
|-
 
|-
−
|| [[:Category:ESP Net|ESP Net]] || Yes || Yes
+
|| [[StageProfi]] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]] (Ethernet version only) || ? || no
 
|-
 
|-
−
|| [[Open DMX USB]] || Yes || -
+
|| [http://machosehead.wordpress.com/2010/06/12/udmx_asp/ uDMX_asp] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]] || ? || no
 
|-
 
|-
−
|| [[:Category:Pathport|Pathport]]  || Yes || Yes
+
|| [[ultraDMX Pro]] ||  [[Image:Trans.gif|center]] [[Image:Recv.gif|center]]  || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]]  || ? || no
 
|-
 
|-
−
|| [[:Category:Sandnet|Sandnet]] || Yes || Yes
+
|| [[ultraDMX Micro]] ||  [[Image:Trans.gif|center]] [[Image:Recv.gif|center]]  || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ? || no
 
|-
 
|-
−
|| [[:Category:ShowNet|ShowNet]] || Yes || Yes
+
|| [[USBDMX2]] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]] || ? || no
 
|-
 
|-
−
|| [[StageProfi]] || Yes || Ethernet version only
+
|| [http://www.soh.cz/produkty/modul-usb-dmx512 USB-DMX512] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]] || ? || no
 
|-
 
|-
−
|| [[USBDMX2]] || Yes || Yes
+
|| [[Velleman K8062]] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]]  || ? || no
 
|-
 
|-
−
|| [[Velleman K8062]] || Yes || Yes
+
|| [[Velleman_K8062_Upgrade|VX8062]] || [[Image:Trans.gif|center]]  || [[Image:Trans.gif|center]] || ? || no
 
|}
 
|}
  
−
 
+
==Getting Started==
−
<b>Getting Started</b>
 
  
 
Start here if you've never used OLA before and read these in order.
 
Start here if you've never used OLA before and read these in order.
−
* [[Download OLA]]
+
* [[Download & Install OLA]]
−
* [[OLA on OS X]] or [[OLA on Linux]] - How to get it compiled.
 
 
* [[Using OLA]] - A basic introduction
 
* [[Using OLA]] - A basic introduction
 
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
 
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
 
* [[OLA Device Specific Configuration]]
 
* [[OLA Device Specific Configuration]]
 
* [[OLA Tips & Tricks]]
 
* [[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]]
 +
* [[OLA on Beaglebone]]
 +
* [[OLAGuruPlug]] - Running OLA on a [http://www.globalscaletechnologies.com/c-4-guruplugs.aspx GuruPlug]
 +
* [[OLA RDM Responder Testing]]
 +
* [[OLA LED Pixels]] - Using OLA and a Pi to drive SPI LED tape
 +
* [[OlaOutput Max External]] - Setup OlaOutput on Mac OS X to send DMX messages from Max/MSP/Jitter
 +
* [[OlaLED]] - control RGB LED via HTTP
  
−
<b>Advanced Topics:</b>
+
===Advanced Topics===
 
* [[OLA Merging Algorithms]]
 
* [[OLA Merging Algorithms]]
 
* [[OLA DiffServ support]] (QOS settings)
 
* [[OLA DiffServ support]] (QOS settings)
 +
* [[OLA Thread Scheduling]] (Control latency)
 +
* [[OLA DMX Trigger]] - Using OLA and DMX to trigger events on a computer
 +
* [[OLA Patch persistency]]
 +
 +
===Developer Documentation===
 +
 +
The developer documentation is in the process of being re-written as doxygen comments in the src tarball. The latest generated copy of the docs is hosted at https://docs.openlighting.org/doc/latest/ versions for specific releases are hosted at https://docs.openlighting.org/doc/. 
  
−
<b>Developer Documentation:</b>
 
 
* [[OLA developer info]] - about the source code and structure
 
* [[OLA developer info]] - about the source code and structure
−
* [[OLA Client API]] - the C++ API
+
* [[doc:index|OLA Doxygen Docs]] - Generated Doxygen docs aimed at developers creating clients.
−
* [[OLA Python API]] - easy DMX programming
+
** See [[OLA_on_Linux#Doxygen_Documentation|here]] for info on generating Doxygen docs locally.
 +
* [[code-raw:plugins/osc/README|Walkthrough of the OSC plugin code]] - good for people wanting to create new plugins
 +
* OLA APIs - See also [https://www.openlighting.org/ola/apis/ https://www.openlighting.org/ola/apis/]
 +
** Protobufs Based
 +
*** [[doc:client_tutorial|OLA Client API]] - the C++ API, (also [[OLA Client API|older examples]])
 +
*** [[OLA Python API]] - easy DMX programming
 +
*** [[code:java|Java]] - currently a work in progress (see an example using it [https://github.com/neophob/ola-to-tpm2net here])
 +
** Alternatives
 +
*** [[OLA JSON API|JSON]] - Browse to /help on your OLA webserver to see the available commands (append ?help=1 to the end of a command for more info in newer versions of OLA)
 +
*** [[OSC]] - Not technically an API, but not strictly a lighting protocol either, enable the OSC plugin and use it to communicate with OLA from a variety of software
 
* [[Build OLA Mac Packages]] - notes for building the .dmg images
 
* [[Build OLA Mac Packages]] - notes for building the .dmg images
 
* [[Building OLA for Windows]] - Notes on Windows support (in progress)
 
* [[Building OLA for Windows]] - Notes on Windows support (in progress)
 +
* [[OLA on Android]] - Notes on Android support (in progress)
 +
* [[Cross Compiling OLA]]
 +
* [[OLA Buildbot|Buildbot]] - For continuous build and testing
 
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++
 
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++
 +
* [[Writing RDM Responder Tests]]
 
* [[Port Throttling]]  
 
* [[Port Throttling]]  
 +
* [[RDM PID Definitions]]
 
* [[OLA Performance Stats]]
 
* [[OLA Performance Stats]]
 +
* [[OLA TimeCode]]
 +
* [[doc:rpc_system|RPC Protocol]] (or "How do I talk to OLA in a different language")
  
−
<b>Tutorials</b>, these refer to the previous release but parts of them are still relevant.
+
===Old Tutorials===
 +
These refer to the previous release but parts of them are still relevant.
 
* [[LLA Sandnet Tutorial]] - Setup Horizon using Sandnet and LLA
 
* [[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 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
 
* [[LLA and Q Light Controller OSX Tutorial]] - Setup LLA on Mac OS X with QLC
−
 
−
<b>Deprecated Documentation</b>
 
−
* [[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:ArtNet]]

Latest revision as of 15:10, 24 March 2016

OLA-Logo-Fitted-48px.png

Link: http://www.openlighting.org/ola/
{{ #if: yes | Free! }}{{ #if: yes | Windows Support }}{{ #if: yes | Linux Support }}{{ #if: yes | Mac OS X Support }}{{ #if: yes | Sends DMX }}{{ #if: yes | Receives DMX }}{{ #if: yes | RDM Support }}{{ #if: | MIDI Support }}{{ #if: yes | HTTP Support }}

Ola-download.png
Universe Settings
RDM Devices Page
Drag & Drop RDM Patching
Mobile UI


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 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 Console using ShowNet can send DMX512 to an Enttec 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

Protocol Linux Mac OS X FreeBSD Windows
ArtNet, ArtNet 2, ArtNet 3
Green-tick.png
Rdm.gif
Green-tick.png
Rdm.gif
Green-tick.png
Rdm.gif
Green-tick.png
Rdm.gif
E1.31 / ACN
Green-tick.png
Green-tick.png
Green-tick.png
 Not yet
ESP Net
Green-tick.png
Green-tick.png
Green-tick.png
Green-tick.png
KiNET
Trans.gif
Trans.gif
Trans.gif
Trans.gif
OSC (Open Sound Control)
Green-tick.png
Green-tick.png
  ?
Green-tick.png
Pathport
Green-tick.png
Green-tick.png
Green-tick.png
Green-tick.png
Sandnet
Green-tick.png
Green-tick.png
Green-tick.png
Green-tick.png
ShowNet
Green-tick.png
Green-tick.png
Green-tick.png
Green-tick.png


Supported Devices

Device Linux Mac OS X FreeBSD Windows
Anyma uDMX
Trans.gif
Trans.gif
  ? no
Arduino RGB Mixer
Green-tick.png
Rdm.gif
Green-tick.png
Rdm.gif
  ? no
DMX 4 Linux
Trans.gif
  ? no
DMX USB Pro
Trans.gif
Recv.gif
Rdm.gif
Trans.gif
Recv.gif
Rdm.gif
Trans.gif
Recv.gif
Rdm.gif
 no
DMX USB Pro MkII
Trans.gif
Recv.gif
Rdm.gif
Trans.gif
Recv.gif
Rdm.gif
Trans.gif
Recv.gif
Rdm.gif
 no
DMX-TRI
Trans.gif
Trans.gif
Trans.gif
 no
DMXking USB DMX512-A
Trans.gif
Recv.gif
Trans.gif
Recv.gif
  ? no
DMXter4 RDM / MiniDMXter
Rdm.gif
Rdm.gif
  ? no
Eurolite USB DMX512 PRO
Trans.gif
Trans.gif
  ? no
KarateLight
Trans.gif
  ? no
KMtronic DMX Adapter
Trans.gif
  ? no
Open DMX USB
Trans.gif
  ? no
Milford Instruments 1-463
Trans.gif
  ?  ? no
Packetheads USB_DMX Dongle
Green-tick.png
Green-tick.png
  ? no
RDM USB Pro
Trans.gif
Recv.gif
Trans.gif
Recv.gif
  ? no
RDM-TRI
Trans.gif
Rdm.gif
Trans.gif
Rdm.gif
Trans.gif
Rdm.gif
 no
Renard Serial Protocol (Renard SS24, SS8, etc)
Trans.gif
  ?  ? no
Robe Universal Interface
Trans.gif
Recv.gif
Rdm.gif
Trans.gif
Recv.gif
Rdm.gif
  ? no
RUNIT WTX
Trans.gif
Recv.gif
Rdm.gif
Trans.gif
Recv.gif
Rdm.gif
  ? no
SPI control of LED pixels
Trans.gif
Rdm.gif
  ?  ? no
StageProfi
Trans.gif
Trans.gif
(Ethernet version only) 		 ? no
uDMX_asp
Trans.gif
Trans.gif
  ? no
ultraDMX Pro
Trans.gif
Recv.gif
Trans.gif
Recv.gif
  ? no
ultraDMX Micro
Trans.gif
Recv.gif
Trans.gif
Recv.gif
  ? no
USBDMX2
Trans.gif
Trans.gif
  ? no
USB-DMX512
Trans.gif
Trans.gif
  ? no
Velleman K8062
Trans.gif
Trans.gif
  ? no
VX8062
Trans.gif
Trans.gif
  ? no

Getting Started

Start here if you've never used OLA before and read these in order.


Tutorials

Advanced Topics

Developer Documentation

The developer documentation is in the process of being re-written as doxygen comments in the src tarball. The latest generated copy of the docs is hosted at https://docs.openlighting.org/doc/latest/ versions for specific releases are hosted at https://docs.openlighting.org/doc/.

Old Tutorials

These refer to the previous release but parts of them are still relevant.

Retrieved from "https://wiki.openlighting.org/index.php?title=Open_Lighting_Architecture&oldid=5865"