wiki.openlighting.org - User contributions [en]

OLA Patch persistency

2013-03-03T18:32:34Z

Ssm2017: /* Patch Persistency */ added the warning

= Patch Persistency =
The patch persistency information is stored in plain text files inside your configuration folder (~/.ola or /var/lib/ola/conf)

The "universe" information is stored inside "ola-universe.conf"

The "patch" information is stored inside "ola-port.conf"

To start with something clean we can delete the "ola-universe.conf" and "ola-port.conf" files and ola will create them again when stopping ola.

WARNING : To keep a persistency, ola need to stop cleanly. That means that is the computer is crashing or if ola is crashing, the patch is not stored in files.

== Example ==
We are going to patch an ArtNet universe as an input with a DmxKing ultraDMX Micro as an output.

On this example, i have enabled only the plugins :
* ArtNet
and
* serial usb
setting all the plugins in the config folder with
enabled = false
except the 2 ones needed witch i have enabled using
enabled = true

=== Starting ola ===
We are starting ola using either the command
/etc/init.d/olad start
or
olad -l 3
-l 3 : means that we are starting ola with the login level 3

=== Getting devices info ===
To get the devices info we are using the command
ola_device_info
That is returning :
Device 1: ArtNet [10.0.0.2]
port 0, IN , priority 100, RDM supported
port 1, IN , priority 100, RDM supported
port 2, IN , priority 100, RDM supported
port 3, IN , priority 100, RDM supported
port 0, OUT , RDM supported
port 1, OUT , RDM supported
port 2, OUT , RDM supported
port 3, OUT , RDM supported
Device 2: DMXking.com - ultraDMX Micro
port 0, IN Serial #: 84000775, priority 100
port 0, OUT Serial #: 84000775, RDM supported

=== Patching the devices ===
Fist we are patching the ArtNet device using
ola_patch -d 1 -i -p 0 -u 0
That means :
patch device 1 (-d 1) input (-i) port 0 (-p 0) to the universe 0 (-u 0)
(ola is using the output port as the default one, this is why we need to tell it to use the input using -i.

Then we are patching the ultraDMX micro using
ola_patch -d 2 -p 0 -u 0

Now the device info is returning
Device 1: ArtNet [10.0.0.2]
port 0, IN ArtNet Universe 0:0:0, priority 100, patched to universe 0, RDM supported
port 1, IN , priority 100, RDM supported
port 2, IN , priority 100, RDM supported
port 3, IN , priority 100, RDM supported
port 0, OUT , RDM supported
port 1, OUT , RDM supported
port 2, OUT , RDM supported
port 3, OUT , RDM supported
Device 2: DMXking.com - ultraDMX Micro
port 0, IN Serial #: 84000775, priority 100
port 0, OUT Serial #: 84000775, patched to universe 0, RDM supported

=== Resulted files ===
After stopping ola (using "/etc/init.d/olad stop" or "ctrl+c" (if running it directly on the command line))

The ola-port.conf and ola-universe.conf are filled with the infos.

==== ola-universe.conf ====
Here is the content of this file
uni_0_merge = LTP
uni_0_name = Universe 0
LTP priority is set by default.

A default name "Universe 0" was given to the universe 0.

==== ola-port.conf ====
Here is the content of this file
2-1-I-0 = 0
2-1-I-0_priority_value = 100
2-1-I-1_priority_value = 100
2-1-I-2_priority_value = 100
2-1-I-3_priority_value = 100
5-84000775-I-0_priority_value = 100
5-84000775-O-0 = 0

What does it mean ?

First we need to know about the plugins ids.

To get the plugins infos, we are using
ola_plugin_info
That is returning
Id Plugin Name
--------------------------------------
1 Dummy
2 ArtNet
3 ShowNet
4 ESP Net
5 Serial USB
6 Enttec Open DMX
7 SandNet
8 StageProfi
9 Pathport
11 E1.31 (sACN)
12 USB
13 FTDI USB DMX
14 OSC
--------------------------------------
In this example, we are only using the ArtNet plugin and the Serial USB plugins.

We can see that the ArtNet has the id 2 and the Serial USB has the id 5.

The ola-port.conf file is storing the info as
<plugin-id>-<device-id>-<port-id>
We can translate the first line as :

The plugin 2, device 1 and input port 0 is patched to the universe 0.

The second line is defining the priority level.

Then we can see that other ports are not patched.

And then on the sixth line, we can translate it as :

The plugin 5, device 84000775 (remember ola_device_info values) Input port 0 is not patched.

And on the 7th line we can see translate it as :

The plugin 5, device 84000775 Output port 0 is patched to universe 0.

OLA Patch persistency

2013-03-03T18:30:10Z

Ssm2017: Creating the file

= Patch Persistency =
The patch persistency information is stored in plain text files inside your configuration folder (~/.ola or /var/lib/ola/conf)

The "universe" information is stored inside "ola-universe.conf"

The "patch" information is stored inside "ola-port.conf"

To start with something clean we can delete the "ola-universe.conf" and "ola-port.conf" files and ola will create them again when stopping ola.

== Example ==
We are going to patch an ArtNet universe as an input with a DmxKing ultraDMX Micro as an output.

On this example, i have enabled only the plugins :
* ArtNet
and
* serial usb
setting all the plugins in the config folder with
enabled = false
except the 2 ones needed witch i have enabled using
enabled = true

=== Starting ola ===
We are starting ola using either the command
/etc/init.d/olad start
or
olad -l 3
-l 3 : means that we are starting ola with the login level 3

=== Getting devices info ===
To get the devices info we are using the command
ola_device_info
That is returning :
Device 1: ArtNet [10.0.0.2]
port 0, IN , priority 100, RDM supported
port 1, IN , priority 100, RDM supported
port 2, IN , priority 100, RDM supported
port 3, IN , priority 100, RDM supported
port 0, OUT , RDM supported
port 1, OUT , RDM supported
port 2, OUT , RDM supported
port 3, OUT , RDM supported
Device 2: DMXking.com - ultraDMX Micro
port 0, IN Serial #: 84000775, priority 100
port 0, OUT Serial #: 84000775, RDM supported

=== Patching the devices ===
Fist we are patching the ArtNet device using
ola_patch -d 1 -i -p 0 -u 0
That means :
patch device 1 (-d 1) input (-i) port 0 (-p 0) to the universe 0 (-u 0)
(ola is using the output port as the default one, this is why we need to tell it to use the input using -i.

Then we are patching the ultraDMX micro using
ola_patch -d 2 -p 0 -u 0

Now the device info is returning
Device 1: ArtNet [10.0.0.2]
port 0, IN ArtNet Universe 0:0:0, priority 100, patched to universe 0, RDM supported
port 1, IN , priority 100, RDM supported
port 2, IN , priority 100, RDM supported
port 3, IN , priority 100, RDM supported
port 0, OUT , RDM supported
port 1, OUT , RDM supported
port 2, OUT , RDM supported
port 3, OUT , RDM supported
Device 2: DMXking.com - ultraDMX Micro
port 0, IN Serial #: 84000775, priority 100
port 0, OUT Serial #: 84000775, patched to universe 0, RDM supported

=== Resulted files ===
After stopping ola (using "/etc/init.d/olad stop" or "ctrl+c" (if running it directly on the command line))

The ola-port.conf and ola-universe.conf are filled with the infos.

==== ola-universe.conf ====
Here is the content of this file
uni_0_merge = LTP
uni_0_name = Universe 0
LTP priority is set by default.

A default name "Universe 0" was given to the universe 0.

==== ola-port.conf ====
Here is the content of this file
2-1-I-0 = 0
2-1-I-0_priority_value = 100
2-1-I-1_priority_value = 100
2-1-I-2_priority_value = 100
2-1-I-3_priority_value = 100
5-84000775-I-0_priority_value = 100
5-84000775-O-0 = 0

What does it mean ?

First we need to know about the plugins ids.

To get the plugins infos, we are using
ola_plugin_info
That is returning
Id Plugin Name
--------------------------------------
1 Dummy
2 ArtNet
3 ShowNet
4 ESP Net
5 Serial USB
6 Enttec Open DMX
7 SandNet
8 StageProfi
9 Pathport
11 E1.31 (sACN)
12 USB
13 FTDI USB DMX
14 OSC
--------------------------------------
In this example, we are only using the ArtNet plugin and the Serial USB plugins.

We can see that the ArtNet has the id 2 and the Serial USB has the id 5.

The ola-port.conf file is storing the info as
<plugin-id>-<device-id>-<port-id>
We can translate the first line as :

The plugin 2, device 1 and input port 0 is patched to the universe 0.

The second line is defining the priority level.

Then we can see that other ports are not patched.

And then on the sixth line, we can translate it as :

The plugin 5, device 84000775 (remember ola_device_info values) Input port 0 is not patched.

And on the 7th line we can see translate it as :

The plugin 5, device 84000775 Output port 0 is patched to universe 0.

Open Lighting Architecture

2013-03-03T18:12:49Z

Ssm2017: /* Getting Started */ added "OLA Patch persistency"

[[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]]
|-
|| [[OSC]] (Open Sound Control) || [[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 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]]
|-
|| [[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]] || ?
|-
|| SPI || [[Image:Trans.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]] || ?
|-
|| [http://www.soh.cz/produkty/modul-usb-dmx512 USB-DMX512] || [[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]]
* [[OLA on Beaglebone]]
* [[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]]
* [[OLA Patch persistency]]

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 Command Line Tools

2013-02-22T07:12:45Z

Ssm2017: /* ola_dmxconsole */ added some shortcuts

=== ola_artnet ===

This tool queries and sets the ArtNet node's parameters.

Options:
* -d, --dev <device_id> The device id to configure.
* -l, --long_name <long_name> Set the long name of the ArtNet device
* -n, --name <name> Set the name of the ArtNet device
* -s, --subnet <subnet> Set the subnet of the ArtNet device

<pre>
$ ola_artnet -d 1
Name: ola - ArtNet node
Long Name: ola - ArtNet node
Subnet: 0

$ ola_artnet -d 1 -n "new name" -s 1
Name: new name
Long Name: ola - ArtNet node
Subnet: 1
</pre>

It can also be used to list the IP addresses of the ArtNet devices listening to a particular universe:

<pre>
$ ola_artnet -u 0 -d 1
10.0.0.88
</pre>

=== ola_dmxconsole ===

Send data to a OLA service.

Options
* -u The universe ID to send data for

<pre>
# open a console for universe 10
ola_dmxconsole -u 10
</pre>

==== some shortcuts ====
q = quit

f = all channel @ full

b = all channels blackout

arrow keys = move between channels

up/down = coarse change channel value

+/- = fine change channel value

space bar = toggle channel value 0 / full

m = change display mode (% hex dec)

n = toggle display 1 thru 512 or 0 thru 511

u = undo

del = shift channels left

=== ola_dmxmonitor ===

Monitor the values on a DMX512 universe

Options
* -u The universe ID to monitor

<pre>
# open a monitor for universe 10
ola_dmxmonitor -u 10
</pre>

in the app, you can change :

* display in octal/hexa/decimal

press m

* increment/decrement channel

press + or -

* increment/decrement per 10 unit

press page UP or page DOWN

=== ola_e131 ===

Manage E1.31 options.

Option:
* -d, --dev Id of the device to control.
* -h, --help Display this help message and exit.
* -i Input port
* -p, --port_id Id of the port to control
* --preview_mode Set the preview mode bit

<pre>
# turn preview mode on
$ ola_e131 -d X -p 1 --preview_mode
</pre>

=== ola_set_priority ===

Sets the priorities for ports. See [[OLA Merging Algorithms]] for more information on what the does.

Options:
* -d, --device <device> Id of device to patch.
* -h, --help Display this help message and exit.
* -i, --input Set an input port
* -o, --override <value> Set the port priority to a static value.
* -p, --port <port> Id of the port to patch.

<pre>
# Override an input port's priority
$ ola_set_priority -d X -p 1 -i -o 50
# Reset an output port to inherit mode
$ ola_set_priority -d X -p 1
</pre>

=== ola_streaming_client ===

Stream data to the OLA server.

Options:
* -d, --dmx <dmx_data> DMX512 data, e.g. '1,240,0,255'
* -h, --help Display this help message and exit.
* -u, --universe <universe_id> Id of universe to send data for.

<pre>
# send a single update
$ ola_streaming_client -u 1 -d 1,2,255,255
# read data from stdin
$ dmx_generator | ola_streaming_client -u 1
</pre>

=== ola_usbpro ===

This tools queries and control the parameters of the [[DMX USB Pro|Enttec USB Pro]] devices.

Options:
* -d, --dev <dev_id> The device id to configure.
* -s, --serial Show the serial number for this device.
* -b, --brk <brk> Set the break time in 10.67 microseconds steps (9 - 127)
* -m, --mab <mab> Set the make after-break-time in 10.67 microseconds steps (1 - 127)
* -r, --rate <rate> Set the transmission rate to <rate> frames per second (1-40)
* -s, --serial Get the serial number.

<pre>
$ ola_usbpro -d 5
Device: 5
Firmware: 1.44
Break Time: 96.03us
MAB Time: 96.03us
Packet Rate: 40 packets/sec

$ ola_usbpro -d 5 -s
Device: 5
Serial: 02050016

$ ola_usbpro -d 5 -m 1 -b 9 -r 30
Device: 5
Firmware: 1.44
Break Time: 96.03us
MAB Time: 10.67us
Packet Rate: 30 packets/sec

</pre>