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

From wiki.openlighting.org

Jump to: navigation, search
(ola_dmxconsole: added some shortcuts)
Line 1: Line 1:
=== ola_artnet ===
+
== ola_artnet ==
  
 
This tool queries and sets the ArtNet node's parameters.
 
This tool queries and sets the ArtNet node's parameters.
Line 28: Line 28:
 
</pre>
 
</pre>
  
=== ola_dmxconsole ===
+
== ola_dmxconsole ==
  
 
Send data to a OLA service.
 
Send data to a OLA service.
Line 40: Line 40:
 
</pre>
 
</pre>
  
==== some shortcuts ====
+
=== some shortcuts ===
 
q = quit
 
q = quit
  
Line 63: Line 63:
 
del = shift channels left
 
del = shift channels left
  
=== ola_dmxmonitor ===
+
== ola_dmxmonitor ==
  
 
Monitor the values on a DMX512 universe
 
Monitor the values on a DMX512 universe
Line 89: Line 89:
 
press page UP or page DOWN
 
press page UP or page DOWN
  
=== ola_e131 ===
+
== ola_e131 ==
  
 
Manage E1.31 options.
 
Manage E1.31 options.
Line 105: Line 105:
 
</pre>
 
</pre>
  
=== ola_set_priority ===
+
== ola_set_priority ==
  
 
Sets the priorities for ports. See [[OLA Merging Algorithms]] for more information on what the does.
 
Sets the priorities for ports. See [[OLA Merging Algorithms]] for more information on what the does.
Line 123: Line 123:
 
</pre>
 
</pre>
  
=== ola_streaming_client ===
+
== ola_streaming_client ==
  
 
Stream data to the OLA server.
 
Stream data to the OLA server.
Line 139: Line 139:
 
</pre>
 
</pre>
  
=== ola_usbpro ===
+
== ola_usbpro ==
  
 
This tools queries and control the parameters of the [[DMX USB Pro|Enttec USB Pro]] devices.
 
This tools queries and control the parameters of the [[DMX USB Pro|Enttec USB Pro]] devices.

Revision as of 08:36, 23 February 2013

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

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

$ ola_artnet  -u 0 -d 1 
10.0.0.88

ola_dmxconsole

Send data to a OLA service.

Options

  • -u The universe ID to send data for
# open a console for universe 10
ola_dmxconsole -u 10

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
# open a monitor for universe 10
ola_dmxmonitor -u 10

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
# turn preview mode on
$ ola_e131 -d X -p 1 --preview_mode

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.
# 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 

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.
# 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

ola_usbpro

This tools queries and control the parameters of the 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.
$ 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