Lightware's Open API Environment

What is an API?

An Application Programming Interface (API) is a set of protocols, commands, functions and objects that programmers can use to create software or interact with an external system. The API developed by Lightware Visual Engineering for its video signal management equipment is an open environment protocol, where every bit of data is openly available for higher level management, control and monitoring systems.

The protocol descriptions are freely available and the set of protocols typically used in a given device is always included in the product’s User Manual.

LW2 and LW3 Protocol Sets

There are two sets of protocols of the Lightware API system: LW2 is a simpler, but very definite set of protocols, while LW3 is more sophisticated, allowing fine-tuning of processes in more detail.

These protocols are present in the Lightware devices, no additional purchase or subscription are necessary to use them. To check the current LW2 or LW3 communication in the devices, the freely downloadable Lightware Device Controller software can be used to connect to the Lightware device over one of the available connections.

Both LW2 and LW3 are uncomplicated, user friendly, and can query and modify the most important properties and settings of a device by sending commands over various types of connections including Ethernet, serial RS-232 and USB – depending on the capabilities of the given device.

10 Advantages of the Lightware Protocols

Complete Control

Complex controlling and monitoring features of the Lightware Device

From the Input port switching to the hexadecimal-formatted message sending.


Protocol browsing

Live protocol browsing by the freely available Lightware Device Controller (LDC) software

From the live terminal to the tree structure.


All in one

All-in-one commands

Changing the same property at all ports by sending only one command (e.g. changing the I/O crosspoint).


Transparent Ethernet

Transparent Ethernet

Use the Command Injection mode to extend RS-232 serial data.


Command Injection

Serial-Ethernet bi-directional signal conversion

Use the Command Injection mode to extend RS-232 serial data.


Subscription

Subscription

Getting a change message automatically if a parameter is changed in the background.


TPS diagnostics

Monitoring and identifying potential twisted pair cable issues

By the TPS Cable Diagnostic Tools.


Hotplug

Monitoring the status of the connected devices, cables, and signals of each I/O port

Signal present, +5V present, hotplug detection.


Video parameters

Querying and changing the video parameters of the signals

Timing, frequencies, scan mode, HDCP encryption, color space, audio sample rate, and many more.


Advanced Audio

Configurable analog audio parameters

Volume, Gain, Balance, Treble, Bass settings.


To learn more about Lightware’ open API protocols, their advantages and examples on usage, please download the Summary of Lightware’s Open API Environment white paper here: