Personal tools
The Open Lighting Project has moved!

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

Running the tests


Revision as of 04:13, 15 September 2012 by RenZO (talk | contribs) (Move the warning)
Jump to: navigation, search

This describes how to run the RDM Responder Tests. Before starting you may want to read the Responder Testing FAQ.

Install OLA

Follow one of OLA on OS X or OLA on Linux or OLA on Windows with VMWare to install OLA. If you want the biggest benefit from the tests you should use the version in the git repo as tests are added regularly.

Setup the Test Rig

The following controller devices are supported:

DMXter Instructions

You need to put the DMXter into dongle mode. From the RDM menu, hold the left and right buttons and then hit the center button. The display should change to "USB Dongle Mode".

RDM TRI Instructions

In order to use the full test suite you need to use this interface in raw RDM mode. This allows the test suite to send malformed & unusual RDM packets to check the responder does the right thing. [TODO(someone): confirm which version of the firmware you need for this]

To enable raw rdm mode, in ~/.ola/ola-usbserial.conf, change the tri_use_raw_rdm line:

tri_use_raw_rdm = true

Discovering Responders

Connect the device under test to the controller device and start olad. Patch the output port on the controller device to a universe (UNIVERSE_NUMBER). Then run ola_rdm_discover, you should see the responder's UID appear:

 $ ola_rdm_discover -u UNIVERSE_NUMBER


Warning: The tests send SET messages to the broadcast UIDs. This means that they will change the start address, device label etc. of all devices connected to the controller. Think twice about running this on your production lighting rig.

RDM Tests Server and Web UI

Since OLA 0.8.23, you can run rdm-tests from a web ui. Start the server with:

Checking olad status
Running RDM Tests Server on

Then, open a web browser and go to:

Running the Tests from the command line

The tests are written in Python and run using Below is the output from a typical test run:

 $ ./ --universe 1  00a1:00010003
 Starting tests, universe 3, UID 00a1:00010003
 SetManufacturerLabel: Passed
 SetSoftwareVersionLabel: Passed
 GetManufacturerLabel: Passed
 GetSoftwareVersionLabelWithData: Failed
 ------------- Warnings --------------
 ------------ By Category ------------
   Product Information:  7 /  7   100%
       RDM Information:  1 /  1   100%
    Core Functionality:  2 /  2   100%
      Error Conditions: 10 / 16   62%
          DMX512 Setup:  3 /  3   100%
 29 / 30 tests run, 23 passed, 6 failed, 0 broken

Useful Options has some options which can assist in debugging failures. For a full list of options run with -h

-d, --debug
Show all debugging output, including actual & expected responses.
-l, --log
Log the output of the tests to a file. The UID and timestamp is appended to the filename
-t Test1,Test2 , --tests=Test1,Test2
Only run a subset of the Tests. Only the tests listed (and their dependencies) will be run.
Some responders take time to write state changes to memory. When using broadcast SETs, the controller doesn't know how long to wait before sending the next message. This setting adds a delay after (in ms) to wait after sending broadcast set commands.