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
m (→‎ola_usbpro: Update with link to man page)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
For information on all OLA commands, see [[man:index|the man pages]].
 +
 
== ola_artnet ==
 
== ola_artnet ==
  
−
This tool queries and sets the ArtNet node's parameters.
+
This tool queries and sets the ArtNet node's parameters, for more information, see [[man:man1/ola_artnet.1|the man page]].
−
 
 
−
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:
 
It can also be used to list the IP addresses of the ArtNet devices listening to a particular universe:
−
 
 
<pre>
 
<pre>
 
$ ola_artnet  -u 0 -d 1  
 
$ ola_artnet  -u 0 -d 1  
Line 28: Line 11:
 
</pre>
 
</pre>
  
−
== ola_dmxconsole ==
+
== ola_dev_info ==
  
−
Send data to a OLA service.
+
Display olad devices and ports, for more information, see [[man:man1/ola_dev_info.1|the man page]].
  
−
Options
+
== ola_dmxconsole ==
−
* -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
+
Send data to the OLA service, for more information, see [[man:man1/ola_dmxconsole.1|the man page]].
−
 
 
−
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 ==
 
== ola_dmxmonitor ==
  
−
Monitor the values on a DMX512 universe
+
Monitor the values on a DMX512 universe, for more information, see [[man:man1/ola_dmxmonitor.1|the man page]].
−
 
 
−
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 ==
 
== ola_e131 ==
  
−
Manage E1.31 options.
+
Manage E1.31 options, for more information, see [[man:man1/ola_e131.1|the man page]].
  
−
Option:
+
== ola_patch ==
−
*  -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>
+
Control OLA port bindings, for more information, see [[man:man1/ola_patch.1|the man page]].
−
# turn preview mode on
 
−
$ ola_e131 -d X -p 1 --preview_mode
 
−
</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, for more information on the command, see [[man:man1/ola_set_priority.1|the man page]].
−
 
 
−
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 ==
 
== ola_streaming_client ==
  
−
Stream data to the OLA server.
+
Stream data to the OLA server, for more information, see [[man:man1/ola_streaming_client.1|the man page]].
−
 
 
−
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>
 
<pre>
Line 138: Line 45:
 
$ dmx_generator | ola_streaming_client  -u 1
 
$ dmx_generator | ola_streaming_client  -u 1
 
</pre>
 
</pre>
 +
 +
== ola_uni_info ==
 +
 +
Display the active universes in OLA, for more information, see [[man:man1/ola_uni_info.1|the man page]].
  
 
== 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, for more information, see [[man:man1/ola_usbpro.1|the man page]].
−
 
 
−
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>
 
<pre>

Latest revision as of 08:28, 24 July 2013

For information on all OLA commands, see the man pages.

ola_artnet

This tool queries and sets the ArtNet node's parameters, for more information, see the man page.

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_dev_info

Display olad devices and ports, for more information, see the man page.

ola_dmxconsole

Send data to the OLA service, for more information, see the man page.

ola_dmxmonitor

Monitor the values on a DMX512 universe, for more information, see the man page.

ola_e131

Manage E1.31 options, for more information, see the man page.

ola_patch

Control OLA port bindings, for more information, see the man page.

ola_set_priority

Sets the priorities for ports. See OLA Merging Algorithms for more information on what the does, for more information on the command, see the man page.

ola_streaming_client

Stream data to the OLA server, for more information, see the man page. 

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

Display the active universes in OLA, for more information, see the man page.

ola_usbpro

This tools queries and control the parameters of the Enttec USB Pro devices, for more information, see the man page. 

$ 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
Retrieved from "https://wiki.openlighting.org/index.php?title=OLA_Command_Line_Tools&oldid=5511"