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 "RDM Responder Testing"

From wiki.openlighting.org

Jump to: navigation, search
(→‎Downloading & Installing the Test Software)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
As part of the [[Open Lighting Project]] a suite of tests for [[RDM]] responders has been developed. This enables manufacturers to check how well a RDM device conforms to the E1.20 specification. The tests cases are written in Python, and use the [[OLA| Open Lighting Architecture]] to communicate with devices.
+
As part of the [[Open Lighting Project]] we've developed a suite of tests for [[RDM]] responders. This enables manufacturers to check how well a RDM device conforms to the E1.20 specification. The tests cases are written in Python, and use the [[OLA| Open Lighting Architecture]] to communicate with devices.
  
−
Have a question? Ask on the [https://groups.google.com/forum/#!forum/rdm-testing RDM Test Group].
+
Have a question? Check the [[Responder Testing FAQ]] or ask on the [https://groups.google.com/forum/#!forum/rdm-testing RDM Test Group].
  
−
Useful Links:
+
== Supported Devices ==
−
* [[Responder Testing FAQ]]
 
−
* [[Running the tests]]
 
−
* [[Writing RDM Responder Tests]]
 
  
−
== Test Categories ==
+
The following RDM Controller devices are supported:
 +
* [[RDM-TRI]] - this device doesn't support the Discovery tests yet.
 +
* [[DMXter4 RDM]] / [[MiniDMXter]]
 +
* [[Robe Universal Interface]] (latest firmware required)
 +
* [[DMX USB Pro]] (2.4 firmware required)
 +
* [[UltraDMX RDM Pro]] (1.3 firmware required. Also set USB Retry Count = 0)
  
−
Tests are grouped according to the sections in the RDM Categories/Parameter ID Defines table in the E1.20 document. There are some extra categories for specific behavior like error  conditions and sub device handling.
+
Please note due to limitations of ArtNet, the RDM tests cannot be run with ArtNet RDM. You need a physical DMX/RDM interface.
 +
 
 +
== Downloading & Installing the Test Software ==
 +
 
 +
The tests are built on top of, and are included with, the [[Open Lighting Architecture]] which runs on Mac OS, Linux and FreeBSD. If you're a Windows user, or want to get up and running quickly, the easiest way is to use the [http://www.raspberrypi.org/ Raspberry Pi].  It's a $35 embedded computer and you can run all the tests through a web browser without ever having to log in.
 +
 
 +
=== Raspberry Pi Instructions ===
 +
 
 +
Follow the [[Responder Testing with the Raspberry Pi]] instructions.
 +
 
 +
=== Mac, Linux or FreeBSD Instructions ===
 +
 
 +
If you want to run the tests from your own computer:
 +
 
 +
# Follow the [[Download & Install OLA|OLA Installation Instructions]]. If you're installing from source you need to add <tt>--enable-rdm-tests</tt> when running <tt>./configure </tt>. If you use Debian or Ubuntu packages make sure you install the <tt>ola-rdm-tests</tt> package. The tests are quite stable at this point, so unless you have a reason to use the Git version I'd stick to using the monthly releases.
 +
# Perform the [[RDM Test Setup Procedure]].
 +
 
 +
== Running the Tests ==
 +
 
 +
The tests can be run from either the [[Running the tests|command line]] or a [[Using the RDM Test UI|web browser]]. If you're new to using the command line we suggest you use the Web UI. It can do everything the command line tests can do.
 +
 
 +
== Interpreting the Output ==
 +
 
 +
See the [[RDM Test Output|Guide to Interpreting Test Output]]. If you decide you want to add some additional tests read the [[Writing RDM Responder Tests| Guide to Writing Responder Tests]].
  
 
== Test Coverage ==
 
== Test Coverage ==
Line 17: Line 42:
 
As of 7th July 2012 the following PIDs in E1.20 aren't tested:
 
As of 7th July 2012 the following PIDs in E1.20 aren't tested:
  
−
* DISC_UNIQUE_BRANCH
 
 
* STATUS_MESSAGES
 
* STATUS_MESSAGES
 
* STATUS_ID_DESCRIPTION
 
* STATUS_ID_DESCRIPTION
 
* SUB_DEVICE_STATUS_REPORT_THRESHOLD
 
* SUB_DEVICE_STATUS_REPORT_THRESHOLD
 
* RESET_DEVICE
 
* RESET_DEVICE
−
 
−
== Test States ==
 
−
 
−
There are four possible result states for a test:
 
−
 
−
; Passed
 
−
: The responder replied with the expected result
 
−
; Failed
 
−
: The responder failed to reply, or replied with an un-expected result
 
−
; Not Run
 
−
: This test wasn't run because the responder doesn't support the required functionality or a previous test failed.
 
−
; Broken
 
−
: An internal error occurred, this indicates a programming error or an error with the test rig.
 
−
 
−
== Log Messages ==
 
−
 
−
;Warnings
 
−
:Warnings indicate behavior that doesn't match the standard, but is unlikely to cause usability issues. Warnings are printed in the summary section of the test output.
 
−
;Advisory Messages
 
−
:Advisory messages indicate issues that are not covered by the standard but are likely to cause problems i.e a sensor temperature out side of the stated scale range.
 

Latest revision as of 01:13, 9 December 2013

As part of the Open Lighting Project we've developed a suite of tests for RDM responders. This enables manufacturers to check how well a RDM device conforms to the E1.20 specification. The tests cases are written in Python, and use the Open Lighting Architecture to communicate with devices.

Have a question? Check the Responder Testing FAQ or ask on the RDM Test Group.

Supported Devices

The following RDM Controller devices are supported:

Please note due to limitations of ArtNet, the RDM tests cannot be run with ArtNet RDM. You need a physical DMX/RDM interface.

Downloading & Installing the Test Software

The tests are built on top of, and are included with, the Open Lighting Architecture which runs on Mac OS, Linux and FreeBSD. If you're a Windows user, or want to get up and running quickly, the easiest way is to use the Raspberry Pi. It's a $35 embedded computer and you can run all the tests through a web browser without ever having to log in.

Raspberry Pi Instructions

Follow the Responder Testing with the Raspberry Pi instructions.

Mac, Linux or FreeBSD Instructions

If you want to run the tests from your own computer:

  1. Follow the OLA Installation Instructions. If you're installing from source you need to add --enable-rdm-tests when running ./configure . If you use Debian or Ubuntu packages make sure you install the ola-rdm-tests package. The tests are quite stable at this point, so unless you have a reason to use the Git version I'd stick to using the monthly releases.
  2. Perform the RDM Test Setup Procedure.

Running the Tests

The tests can be run from either the command line or a web browser. If you're new to using the command line we suggest you use the Web UI. It can do everything the command line tests can do.

Interpreting the Output

See the Guide to Interpreting Test Output. If you decide you want to add some additional tests read the Guide to Writing Responder Tests.

Test Coverage

As of 7th July 2012 the following PIDs in E1.20 aren't tested:

  • STATUS_MESSAGES
  • STATUS_ID_DESCRIPTION
  • SUB_DEVICE_STATUS_REPORT_THRESHOLD
  • RESET_DEVICE
Retrieved from "https://wiki.openlighting.org/index.php?title=RDM_Responder_Testing&oldid=5617"