ELM — User Manual

The ultimate, intuitive LED pixel mapping software solution. Map video content onto LED fixtures of any shape, with output up to 8192 DMX universes via Art-Net, sACN and KiNet.

Get started

ELM is all about displaying your video content on LED fixtures of any shape, in the most convenient way.

Key features

• 3D and 2D vector-based editor
• 8192 DMX universes
• Art-Net, sACN, KiNet output protocols
• Scheduled sequences
• Control via DMX, OSC, OS2L, MIDI and HTTP
• CITP/MSEX for consoles and visualizers
• HD video + audio playback
• Spout + NDI integrations for live video inputs
• Stream LED previews to visualizers via NDI
• DVI outputs for projectors, TVs and Martin P3 system
• Over 100 high quality animations included
• Audio-reactive effects
• RGB, RGBW, RGBA, RGBAW colour support
• Multiple whites support and WWA
• 16-bit colour support
• DXF and CSV import
• Extreme robustness for permanent installations

Computer requirements

ELM is compatible with Windows 7 and up, including Windows 8, 10 and 11. The .Net 4.8 framework is required and you'll be prompted to install it if needed.

Minimum

• Windows 7+, dual core 2 GHz CPU, 2 GB RAM
• NVIDIA GeForce 600 series or Intel HD Graphics 5500, released after 2013 with OpenGL 3.3 support

Recommended

• Windows 10 or 11, quad core 3.5 GHz CPU, 8 GB RAM
• NVIDIA GeForce 900 series or NVIDIA 10 series or better
• SSD hard drive

The computer requirements depend on your media type. Playing multiple HD videos requires a good computer. A rule of thumb is you can play one full HD video at 30 fps for each 2 GHz CPU core. So if you have an Intel i7 4 GHz (4 cores), you should be able to play 8 full HD videos. Increasing the playback speed to 2x means the fps also increases two times and the number of videos you can play simultaneously is roughly divided by two.

The table below shows the approximate number of videos you can play simultaneously at 30 fps depending on your CPU.

For live video performances where you want to change playback speed up to 10x, the recommended video resolution is 640×360.

To use the built-in effects, particularly the eye candy effects, the video card will be doing the hard work. If you're using a laptop, make sure it can sustain continuous use of the effects without overheating. Usually, an integrated video card can render two eye candy effects. For more effects, you need a discrete video card.

About DMX output: a 1 Gigabit network should be able to handle 2048 universes at 44 fps. For more universes, a supplementary network card and a second Ethernet network are recommended.

Licenses

The ELM licensing system has been built with reliability and simplicity in mind. Once a computer has been activated, it will be able to run ELM until it dies, with no internet connection required, so you can be completely off the grid without worrying about the license.

Each license is registered to one individual or company and covers the activation of the software on a certain number of computers, so long as ELM is running on one computer at a time. For example, you can activate a show and a backup computer but only one computer can run ELM at a time.

The license is a simple file that you import once. No hardware dongles are needed, eliminating a whole range of tricky problems (broken dongle, lost dongle, dongle suddenly not detected in the middle of the show, and so on).

The license is linked to your computer's CPU and motherboard. You can upgrade any other components and reinstall the OS without invalidating your license.

A license isn't transferrable. Once your computer stops working, you can only activate ELM on another computer if you still have activations left. Use this online form to activate a computer: enttec.com/my-account/license-registration.

To get more DMX universes, you can activate multiple licenses on the same computer. The DMX universes of all licenses will be added.

Software updates

You always have access to the latest and greatest version, free of charge. To get updates, go to the Settings/About menu and press the Check for updates button. Alternatively, download the latest version from the ELM product page on enttec.com.

Definitions

Art-Net

Protocol to transmit DMX over a standard Ethernet network. Designed by and Copyright Artistic Licence Holdings Ltd.

CITP/MSEX

Controller Interface Transport Protocol / Media Server Extension.

DMX

The most common protocol to control lighting fixtures. Full name is DMX512, which stands for Digital Multiplex.

DMX universe

Represents 512 DMX channels, enough for 170 RGB LEDs (1 LED takes 3 channels, one for red, one for green and one for blue).

FPS

Frames per second. Refers to an output rate for video or DMX.

KiNet

Protocol to transmit DMX over a standard Ethernet network. Designed by Color Kinetics.

LED strip / string

Lighting fixture that may contain many LED elements and have a certain physical length. Some LED strips are flexible and can be bent to create curves and all kinds of shapes. ELM handles all lighting fixtures as if they were strips, giving you a lot of positioning flexibility.

Mapping

Mechanism used to associate a pixel from a media source to a specific lighting fixture element.

Media

Any type of visual content, including videos and pictures.

NDI (Network Device Interface)

Protocol to stream live videos over the network. Developed by NewTek.

OSC (Open Sound Control)

Network protocol allowing multimedia apps to communicate. ELM can be remotely controlled via OSC.

RGB, RGBW, RGBA, RGBWA

Various colour components: red, green, blue, white and amber.

sACN

Protocol to transmit DMX over a standard Ethernet network, like Art-Net. More specifically, the E1.31 subset is used for DMX control. Developed by ESTA.

Spout

Real-time video sharing framework for Windows. Similar to Syphon on Mac.

Stage

A mapping surface defining the position of the media placeholder and the position of lighting fixtures.

Setup

How ELM connects to your LED fixtures, and a high-level overview of the stages concept.

Getting started with LED strips

ELM can control any DMX-enabled lighting fixtures, not only LED strips. This is made possible because ELM outputs industry standard protocols like Art-Net, sACN and KiNet. ELM can therefore control traditional DMX dimmers and any RGB, RGBW, RGBA and RGBAW lighting fixtures, as well as complex fixtures like moving heads.

Controlling LED strips is a little bit different from traditional DMX fixtures. The main difference is that you need to use LED controllers to drive your strips. They replace the Art-Net nodes you use for traditional DMX fixtures. The LED controller receives DMX via Art-Net/sACN and converts it to the special protocol the LEDs understand.

The next step is to get LED strips and DMX fixtures. Since there are many LED protocols out there, you need to make sure your LED controller fits with your LEDs. Common protocols for RGB LEDs are WS2811 and WS2812/B. For more information about getting compatible LEDs, contact your ENTTEC representative.

Here are examples of ENTTEC Pixelator products that can be used to control LED tapes:

Quick overview

ELM allows dividing your installation into multiple zones and layers called stages. You control the media content independently for each stage. Stages can overlap and they are merged (blended) to generate the result.

A common scenario is to create a stage spanning the whole installation to map media across the board. To enable precise control over specific zones, you create smaller stages inside the big stage, then activate these zones whenever you want. For example, you can play a video on the overall stage (which acts as the background layer), and when there's a special event, activate the logo zone and make it flash.

To represent your LED strips and DMX fixtures inside a stage, ELM has a powerful vector-based editor. This way, you can easily draw many types of shapes, including matrices, loops and curves. ELM computes the position of each LED based on your drawing.

Application tour

A guided tour of every screen and control in ELM.

Home screen

Welcome! Start a new project or load an existing one. To see keyboard shortcut keys, press the key.

New stage dialog

A rule of thumb is to create a stage with dimensions respecting the aspect ratio of your media. Then you'll position your LED strips on it to create the mapping. For example, you can create a full HD stage (which has a rectangular aspect ratio) to fit your media sources, and then map a 20×20 square LED array on it.

You can easily change the dimensions later, so don't worry. The minimum recommended size is 320×180. Smaller than this, you'll need to constantly work at a very high zoom level, which isn't very convenient. So it's better to use a higher size and let ELM scale your media.

Pro tip: To help you position strips like they are in the real world, use a picture of your installation as the stage's background (see Stage Tab). No pictures handy? Use your phone's camera to get one.

Stages

Shortcut key:

You can create as many stages as you want. Generally, you'll want an overall stage corresponding to the whole installation and multiple individual stages to target specific zones. The overall stage allows you to map content across the board. Then the other stages allow you to override specific parts of your installation whenever you want. You can select the current stage by clicking its name at the top.

Pro tip: Different effects may demand different mapping layouts. One goal of the mapping is to ease content creation. Don't hesitate to create multiple stages with the same LED strips but positioned in different ways.

Status indicator

At the left of the stage's name, a small indicator tells you the current control mode and its status. The activated status means a media is selected and the stage's intensity is greater than 0%.

Stage syncing

All stages using the same media slot are considered to be synced. You can still change the individual stage output parameters like the intensity and the colour filter, but the media content is the same on all synced stages. When applicable to the media type, the media playback speed is determined by the maximum speed of all stages using this media.

Pro tip: To play the same video file on multiple stages but at different speeds, load the video file in multiple media slots. Then use a different media slot for each stage.

Stage merging and layering

When multiple stages contain the same LED strips, a merge occurs following the order as shown in the Stages Manager. This allows creating complex visuals by layering multiple stages on top of each other. You can target specific zones by creating stages with only a subset of all strips or with parts of the strips outside the stage. A stage must be activated (a media is selected and the stage's intensity is greater than 0), otherwise it is considered to be transparent and will not be part of the merge.

Pro tip: To easily target specific zones of an installation, first create the overall mapping then select the strips corresponding to the individual zones and right-click in the strip list to access the "new stages from strips" menu.

Edit zone

You can position your strips as they are in the real world or based on the effect you want to create with your media. A strip has start (green) and end (red) control points indicating the direction of the patch. Multiple intermediate control points can be used to create various shapes. You can bundle multiple strips together to simplify the handling of complex shapes.

You can position parts of your strips outside the stage. In this case, the LEDs outside the stage will not be mapped. This is a common scenario when using the same strips in multiple stages and you want to target specific parts in each stage.

Strips tab

Shortcut key:

Strip list

The strips for the current stage are shown in this list. Select one or multiple strips in the list to also select them in the edit zone. Right-click in the list for more options. You can click the column headers to sort. Type text in the filter box to filter based on the group names.

Pro tip: Use the group and sub-group fields wisely in order to use the filter box and quickly select the strips you want.

Add strips dialog (patching)

Shortcut key:

Quickly patch your strips and lighting fixtures to create arrays and any shapes you can imagine. Multiple LED types (or colour types) are supported, including RGB, RGBW, RGBA, RGBAW/RGBWA and white (dimmers) in multiple configurable colour temperatures like WWA. Most colour component orders (GRB, BGR, and so on) are supported. For lighting fixtures supporting high precision colours, 16-bit colour depth can be used via the RGB16, GRB16, RGBA16, RGBW16 and White16 types. RGBWmax activates all channels (RGB + white) when white is needed for maximum brightness.

Pro tip: Got the patching direction wrong? No problem. You can easily flip your strips horizontally and vertically later. For snake mode, right-click in the strip list and use the select odd/even option.

Pro tip: Want to control more complex DMX fixtures like moving heads? Let's say your moving head has 20 channels and the RGB channels start at 3. In ELM, patch it with a start address of 3 and a LED address offset of 20. ELM will send 0 for the unused channels, which allows merging the DMX data from ELM with the DMX data from a console. The console provides the values for pan, tilt and all other channels except the RGB.

Pro tip: Whites! You can get a more accurate preview by using the right type of white LED type. Use WhiteCool, WhiteNeutral, WhiteWarm and WWA. Unlike the White LED type which takes the perceived brightness of the media as its value, you get finer control with the other whites.

Pixel types

Pro tip: For the colour temperature settings to get a more accurate stage monitor preview, see White Balance.

Duplicate strips dialog

Shortcut key:

Copy the selected strips and create new strips by applying certain transformations.

Pro tip: When in the design phase of the lighting installation, keep the duplicate options in mind. They allow creating complex shapes by copying simple elements, which is a real time saver.

Pro tip: To make sure certain strips always stay together, use the bundle feature. You can create complex shapes by combining multiple simple elements. See the bundle/unbundle options in the Edit Zone.

Pro tip: To copy strips to another stage, select your strips and use the copy () and paste () keyboard shortcuts. You can also right-click in the Strip List to see all options.

Edit strips dialog

Shortcut key:

Edit the selected strips and allow changing the patch.

Offset / resize strips dialog

Shortcut key:

Precisely change the position and size of the selected strips.

Pro tip: Right-click in a numeric box and move the mouse left/right to quickly change the value.

Stage tab

Shortcut key:

Pro tip: When editing and zoomed in very closely, if a media is playing in the preview, your computer may have a hard time. To help it, disable the preview by setting the preview opacity to 0%.

Monitor window

The monitor window lets you see the result of the stage only or after all stages have been merged. When you don't have access to the real fixtures, this is an indispensable tool while creating effects. Alternatively, you can use any 3rd party visualizer able to receive the LED rendering via NDI (see NDI output in the Stages Manager) or supporting Art-Net or sACN.

Pro tip: Try reducing the stage's size and see if the output is still good. Also reduce your videos and other media size accordingly to potentially save a lot of CPU. High resolution media is not always a good thing.

Testing tab

Shortcut key:

Quickly test the mapping by generating a rectangle that you can move over the strips.

Pro tip: Reduce the width and height of the testing rectangle and drag the rectangle around the stage. This way, you can see if the patch order is right. For example, if dragging the rectangle from left to right makes the LEDs go on from right to left, then you know you need to flip them horizontally. To do so, go to the Strips Tab and click the Flip X button.

Pro tip: Quickly test the red, green and blue component order of your LEDs by generating a pure red, pure green and pure blue test. For each test, note the colour of your LEDs. If you're not getting a RGB order, edit your LED strips and select the LED type corresponding to the order you've observed (BGR, GRB, GBR…).

Pro tip: While the testing mode is active, the DMX is constantly being output at the full output rate, even when there's no change. This is handy while you're configuring your LED controllers and want to see if it's working. This is also a good way to test whether your network supports the load.

Pro tip: Use the "test selected strips only" option, go in the Strips Tab and change the selection in the strip list. This is similar to traditional lighting consoles' locate function.

Stages manager

Shortcut key:

Select multiple stages in the list to modify them all at once. The first stage of the list is the bottom media layer and the following stages can override any preceding stages. Drag and drop stages to reorder.

Pro tip: You can use ELM to output video to a projector or TV without controlling LEDs. Simply create a stage and don't put any LEDs on it. Then in the stage manager, click on the DVI button.

3D tools

Shortcut key:

A 3D structure is composed of multiple stages layered on top of each other. Everything you already know about stages can be applied to 3D, including merging, media and remote control.

Media library

Shortcut key:

You can manage your media and see what's active. Up to 255 media items can be loaded.

Video files (with or without audio)

Most video formats are supported when the appropriate DirectShow video codecs are installed. By default, ELM can play these files: .mov, .avi, .wmv, .mpeg, .mp4, .mp2, .mkv, .webm, .ogv and .ogg. There's no video size and resolution limits. The audio track is played back on the default sound device. If not needed, you can remove the audio by using the transcode button.

The recommended video format is MPEG4 in an avi file. For smaller files at the expense of a higher CPU usage, you can use H264 in an avi file.

Picture files

Use images like bmp, jpeg, gif (animated or not) and png.

Effects

The built-in effects give you pixel-perfect and configurable visuals. There are 100+ effects available, each one configurable in multiple ways. Many effect parameters are controllable via the DMX remote.

Capture devices

Use live videos captured with a video card input or a connected camera like a webcam. Any DirectX/DirectShow compatible hardware and software are supported.

Screen capture

Capture any part of your screen and use it as media in ELM. For example, play a video on YouTube and map it to your LEDs. Another utility is to capture your video editor (like Adobe After Effects) preview zone and let ELM generate a LED preview in real-time to assist your content creation. This avoids having to render your video before trying it in ELM.

Screen capture dominant colours

Capture any part of your screen and extract the dominant colours. This is useful to do colour matching between any kind of content and your LEDs.

Texts

Generate scrolling text with various fonts.

Spout (v2.007)

Use live videos generated by the most common video frameworks and VJ software. This includes Resolume, Ableton Live, Processing, Max/MSP, TouchDesigner, Cinder, OpenFramework, VVVV, Isadora, After Effects, Mapio, Unity3D and more. The Spout integration gives you total control over the content and is the way to go when you want interactive visuals.

Network Device Interface (NDI v6.0)

Receive live video streams via the network, as commonly used in professional live show productions. Easily connect ELM to a multitude of NDI compatible hardware and software, including capture cards, IP cameras and video over the cloud. NDI has been developed by NewTek.

MJPEG streams

The most basic way to receive video streams via the network. If your IP camera doesn't support the more complete NDI protocol, it should at least support MJPEG streaming.

DMX bitmap

This special media allows receiving DMX from a lighting console and converting it to a video. You can then use this video like any other media and map it on your LEDs. A common usage scenario is to control groups of LEDs with one RGB or intensity value.

Pro tip: To quickly test your installation without having the final videos, just use the built-in effects. You can create your schedules and test everything right away. Then when you get your videos, replace the built-in effects.

Pro tip: Media file paths are saved relatively to your project file. Use the consolidate feature to copy all files in a directory next to your project. Then copy everything to your other computer.

Sequences

Shortcut key:

The sequences section allows you to create sequences and steps (cues) for your stages and launch the perform panel for live performances. First you create groups for your stages either based on the different zones of your installation and/or the different layers. A stage can only be in one group. You can duplicate a stage (see Stages Manager) if you want to put it in multiple groups or if you'd like multiple layers like a background and a foreground. This way, you'll be able to create sequences for the background group and other punchier sequences for the foreground group.

Edit sequences

Go in the live panel and configure the stages of the group as you want and then store the result as a step of a sequence. The settings for each stage that are stored in a step are: main media selection, media parameters, stage activation, stage speed, stage colour filter, transition duration, transition effect and the whole state of the audio mix. An interpolation is made for transitions between steps and sequences for all numeric parameters, including the media parameters. For example, you can change the zoom level of an eye candy effect to animate it between steps.

Each group can have up to 255 sequences and each sequence can have as many steps (cues) as you want. You'll then be able to recall these sequences during a live show or via any remote mode.

Overview section (upper part)

Pro tip: The keyboard shortcuts for the add, update, insert and delete steps work even when the focus is outside the edit sequence window. So you can press to add a step while working in the live panel.

Details section (bottom part)

Schedule

You can schedule your sequence so that it starts playing automatically. A group has its own scheduler, allowing each group to play one sequence at a time.

Perform panel

The perform panel is a touchscreen, keyboard and MIDI controller friendly interface to control your show. You can trigger your sequences and play live with the intensity, speed, strobe, tap tempo and more. Most of the controls can also be controlled via HTTP and OSC.

Live mode

Shortcut key:

The main goal of the live mode is to see what's playing on each stage and configure the effects. For example, if a playlist is running, you'll see what's happening in real-time, including the transitions. If nothing is controlling the stage, you'll be able to manually select what's playing.

Pro tip: Using black and white media allows you to use the colour filter and get exactly the RGB colour you want as output.

Pro tip: Use the live mode as a monitor to help you see what's going on while remotely controlling ELM with another lighting console. You can also open multiple DVI outputs (one per stage) and use them as monitors.

Reference

All settings panels, remote control options (DMX, OSC, OS2L, HTTP), troubleshooting, and the end-user licence agreement.

Settings — project

Shortcut key:

This is the overall panel, displaying the most important info about your project status.

A project backup file is created every 5 minutes. To avoid slowdown during a live show, you need to manually save the project to trigger the backup creation. To open a backup, select the Backup file type in the file browser when opening a project. To set the backup to be the current project, simply save the project.

Import xLights / xModels

Select one or multiple xModel files to import. Strips will be automatically created to best fit the models.

Import CSV LEDs

Select one or multiple CSV files to import. Strips will be automatically created to best fit the LEDs. Each row of the CSV file can contain the following columns:

A stage will be created to contain all LEDs based on their X and Y positions. To export the LEDs of a stage as a CSV, see Stages Manager.

Import strips from AutoCAD DXF file

Select a DXF file to import using the AutoCAD 2000 and up format, either in binary or text. Strips will be created based on the entities. Notes are also created based on the Text and MText entities.

Art-Net

Settings for the Art-Net universes.

sACN

Settings for the sACN universes.

KiNet

Settings for the Philips Color Kinetics devices (power supplies). Both protocol versions are supported, which are KiNet v1 (DMXOUT) and KiNet v2 (PORTOUT). For KiNet v2, you map each KiNet device's port to a universe in ELM. You can map up to 8192 ports. Use Philips QuickPlay Pro to configure and get the IP addresses of your KiNet devices.

Scheduler

The scheduler is responsible for activating your sequences for those with scheduling options. The sunrise and sunset times are automatically updated throughout the year based on your location.

Audio

Activate and configure up to 8 audio inputs. The audio inputs are used by the audio reactive effects and the audio reactive mix. Activate the loopback input to listen to what's playing on this computer.

MIDI

The detected MIDI controllers are listed here. Activate the ones you want to use for your performance. The configuration for which notes and CC messages to use is done in the Perform panel. Multiple controllers can be used at the same time as long as they are transmitting on different channels or at least sending different note or CC messages.

White balance

Adjust the colour temperature and intensity of the various LED types in order to get a more accurate preview in the stage monitor. This is particularly important when you're using LEDs with multiple types of whites. For example, the WWA LED type is composed of the cool white, neutral white and warm white (or amber). Adjusting any of these whites will change the appearance of the WWA LEDs in the stage monitor.

License

Manage your licenses. You can import multiple licenses to get more DMX universes.

Remote control — DMX

ELM can be remotely controlled in many ways. Multiple inputs can be active at the same time to give you even more flexibility. The DMX input always takes priority.

Settings for remotely controlling ELM with a lighting console (Art-Net, sACN or an ENTTEC USB Pro interface).

The DMX sheet showing what can be controlled and by which channel is integrated in ELM. It is dynamically generated based on the current remote settings and your stages, so you can't lose it.

The groups created in the sequences panel are automatically added to the remote control.

When no DMX data is received for more than 5 seconds, the remote control mode will automatically be deactivated. This is a failsafe feature in case the remote console has a problem. When this happens, the schedule resumes right away. If there are no schedules, then the current media will continue to play.

Basic fixture mode (8 channels per stage)

Extended fixture mode (15 channels per stage)

Group mode (12 channels per group)

CITP/MSEX

Activate this option to enable ELM to communicate with other CITP/MSEX compatible consoles and software. CITP/MSEX versions 1.0, 1.1 and 1.2 are available. ELM can:

• Send the media thumbnails to your console.
• Stream the LED preview of every stage to your console or visualizer.
• Send the stage statuses, including the current playing media.

OSC

Settings for remotely controlling ELM via OSC (Open Sound Control) over the network. ELM listens for incoming OSC on all network adapters.

/elm/stages/{stage name}/
  live/
    intensity              0..1
    rgb                    0..1, 0..1, 0..1
    media                  0..99
    speed                  0..10
    transitionFx           0..43
    transitionDuration     0..9999 seconds
    audioMixControlled     {0: no, 1: yes}
    remotelyControlled     {0: no, 1: yes}
  mix/
    position               0..1
    A/
      media                0..99
      speed                0..10
    B/
      media                0..99
      speed                0..10

/elm/groups/{group name}/
  performer/
    active                 {0: no, 1: yes}
    paramTransitionDuration 0..9999 seconds
    intensity              0..1
    blackout               {0: no, 1: yes}
    bumpingIntensity       {0: no, 1: yes}
    strobing               {0: no, 1: yes}
    strobeOnDuration       0..1 seconds
    rgb (or r, g, b)       0..1, 0..1, 0..1
    speed                  0..10
    freeze                 {0: no, 1: yes}
    bumpingSpeed           {0: no, 1: yes}
    tempoBPM               0..300
    tap                    press the tap tempo button
    cleartempo             deactivate the tap tempo
    tempoDivider           1..128
    autoGo                 {0: no, 1: yes}
    playMode               {0: loop, 1: row, 2: column, ...}
    play                   sequenceId, [stepId]
    go                     play the next step
    back                   play the previous step

/elm/groups/{group name}/
  sequences/{sequenceId}/schedule/
    enabled                {0: no, 1: yes}

/elm/media/
  slots/{slotId}
    parameters/{name}      (range as in the live panel)

  for normalized values, use:
    {name}/normalized      0..1

/elm/settings/
  masterIntensity          0..1
  masterSpeed              0..2
  dmxOutputActive          {0: no, 1: yes}
  schedulerActive          {0: no, 1: yes}

Note: Addresses and names are case-insensitive. Media index 0 is an empty slot. RGB can be sent in 3 parts at the /r, /g and /b addresses. audioMixControlled controls the audio mix activation. remotelyControlled determines whether OSC overrides the scheduler. Use * (wildcard character) in the stage name to target multiple stages at once. For example, /elm/stages/*/XYZ targets all stages. /elm/stages/background*/XYZ targets all stages with a name starting with background.

OS2L

Use the Open Sound to Light (OS2L) protocol to receive commands from VirtualDJ. This allows using the timeline editor in VirtualDJ to trigger your lighting effects in sync with the song that is playing. The commands can be used to control the perform panel via its shortcuts, under the sequences menu.

To activate OS2L in VirtualDJ, go in the options and check yes for os2l and set os2lDirectIp to the ELM IP address (or 127.0.0.1 if the same computer) and port. For example: 127.0.0.1:9666.

HTTP

Settings for remotely controlling ELM via HTTP, which is a protocol based on TCP/IP. This is the most reliable way to integrate ELM with control systems like Crestron and Pharos or to create custom web interfaces. ELM listens for incoming HTTP requests on all network adapters.

The base URL to access the API is: http://YOUR-COMPUTER-NAME:port/elm. If you prefer, you can replace the computer name by its IP address or localhost if the server is running on the same computer. The port can be omitted if it's 80, which is the default for HTTP.

You can restrict the access to the API by activating the Basic Auth feature. For more details see Basic access authentication.

Worked examples

To start sequence #1 of the group "background", the request is:

POST /elm/groups/background/performer?active=1&sequenceId=1 HTTP/1.0\x0D\x0A
Content-Type: application/x-www-form-urlencoded\x0D\x0A
Content-Length: 0\x0D\x0A
\x0D\x0A
\x0D\x0A

To get info about the "background" group, the request is:

GET /elm/groups/background/performer HTTP/1.0\x0D\x0A
\x0D\x0A
\x0D\x0A

Notes:

• Each line ends with \r\n characters which are \x0D\x0A in hexadecimal.
• There are two empty lines at the end of a request.
• Use * (wildcard character) in the stage name to target multiple stages at once for POST.
• All data is returned in JSON.
• Use the returned HTTP status code to do proper error handling.
• Addresses and names are case-insensitive.
• Parameters can be provided in the query string or form data.
• Media id 0 is an empty slot.

Troubleshooting

Output — Art-Net / sACN / KiNet

General

EULA

This End-User License Agreement (EULA) is a legal agreement between you (either an individual or a single entity) and the mentioned author and copyright holder (Lightjams inc.) and distributor (ENTTEC LLC) of this Software for the software product identified above, which includes computer software and may include associated media, printed materials, and "online" or electronic documentation ("SOFTWARE PRODUCT").

By installing, copying, or otherwise using the SOFTWARE PRODUCT, you agree to be bound by the terms of this EULA. If you do not agree to the terms of this EULA, do not install or use the SOFTWARE PRODUCT.

Software product licence

1. Grant of licence. This EULA grants you the following rights: Installation and Use. Each license is registered to one person and covers the use of the SOFTWARE PRODUCT on one or multiple computers depending on the license type, so long as multiple computers are not used at the same time. The license is locked to the computer's CPU and motherboard.

2. Description of other rights and limitations. Limitations exist on Reverse Engineering, Decompilation, Disassembly and changing (adding, deleting or modifying) the resources in the compiled assembly of the SOFTWARE PRODUCT. You may not reverse engineer, decompile, or disassemble the SOFTWARE PRODUCT, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.

Updates and maintenance. ELM updates are FREE of charge.

Separation of components. The SOFTWARE PRODUCT is licensed as a single product. Its component parts may not be separated for use on more than one computer.

Software transfer. You may not rent, lease or sublicense the SOFTWARE PRODUCT on a temporary or permanent basis.

Termination. Without prejudice to any other rights, the Author of this Software may terminate this EULA if you fail to comply with the terms and conditions of this EULA. In such event, you must destroy all copies of the SOFTWARE PRODUCT and all of its component parts.

Copyright

All title and copyrights in and to the SOFTWARE PRODUCT (including but not limited to any images, photographs, clipart, libraries, and examples incorporated into the SOFTWARE PRODUCT), the accompanying printed materials, and any copies of the SOFTWARE PRODUCT are owned by the Author of this Software (Lightjams inc). The SOFTWARE PRODUCT is protected by copyright laws and international treaty provisions. Therefore, you must treat the SOFTWARE PRODUCT like any other copyrighted material.

Limited warranty

No warranties. The Author of this Software expressly disclaims any warranty for the SOFTWARE PRODUCT. The SOFTWARE PRODUCT and any related documentation is provided "as is" without warranty of any kind, either express or implied, including, without limitation, the implied warranties of merchantability, fitness for a particular purpose, or noninfringement. The entire risk arising out of use or performance of the SOFTWARE PRODUCT remains with you.

No liability for damages. In no event shall the author of this Software be liable for any special, consequential, incidental or indirect damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use this product, even if the Author of this Software is aware of the possibility of such damages and known defects.

Note: Due to constant innovation, information within this document is subject to change.