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
(Created page with '=== 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 l…')
 
Line 21: Line 21:
 
Subnet: 1
 
Subnet: 1
 
</pre>
 
</pre>
 +
 +
=== 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_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 ===
 
=== ola_usbpro ===

Revision as of 12:45, 6 March 2010

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

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