Introduction

Table of Contents

• Overview
  • Responder Mode
  • Controller Mode
• Powering the Device
• Licensing

This guide describes how to get started with a device running the Open Lighting Embedded (OLE) software. For developer information, including instructions on how to modify the OLE code, see the OLE Developer Guide.

Since the OLE software is customizable, the version running on a particular device may have different functionality from what is described here. Consult your manufacturer's documentation on which features are enabled on each product.

The examples in this guide are from a Number1 since that was the first and most widely available OLE device. Throughout the rest of this document, the device running OLE is simply referred to as the 'device'.

Overview

The device can function as either an RDM Responder or DMX / RDM Controller. On boot, the device will start in Responder mode.

Responder Mode

In responder mode, the device can simulate different types of RDM models, for example a moving light or a dimmer. This allows testing of RDM Controller implementations against a known good RDM Responder implementation. Together the different RDM Models implement all PIDs from the E1.20, E1.37-1 & E1.37-2 standards.

Responder mode is standalone, a host PC is not required but can be connected to view the USB Console logs if desired.

Controller Mode

In controller mode, the device operates as a USB to DMX / RDM Controller. This mode requires a host computer running the Open Lighting Architecture (OLA). The OLA documentation outlines the requirements for the host computer.

When the device is configured as an output port within OLA it will automatically switch into controller mode.

When operating in controller mode, the OLE device reports detailed timing information about the RDM responses. The timing stats are reported when running the RDM Responder Tests.

Powering the Device

The device is powered over the USB port. If the device is connected to a host PC no additional power source is required.

For standalone operation, the device can be powered by a standard USB cell phone charger.

Licensing

The OLE codebase is licensed under the LGPL.

The unit-testing code & mocks are licenced under the GPL.