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
|
|
Complex controlling and monitoring features of the Lightware DeviceFrom the Input port switching to the hexadecimal-formatted message sending. |
|
|
Live protocol browsing by the freely available Lightware Device Controller (LDC) softwareFrom the live terminal to the tree structure. |
|
|
All-in-one commandsChanging the same property at all ports by sending only one command (e.g. changing the I/O crosspoint). |
|
|
Transparent EthernetDirect connection to remote Ethernet devices (e.g. source or sink devices). |
|
|
Serial-Ethernet bi-directional signal conversionUse the Command Injection mode to extend RS-232 serial data. |
|
|
SubscriptionGetting a change message automatically if a parameter is changed in the background. |
|
|
Monitoring and identifying potential twisted pair cable issuesBy the TPS Cable Diagnostic Tools. |
|
|
Monitoring the status of the connected devices, cables, and signals of each I/O portSignal present, +5V present, hotplug detection. |
|
|
Querying and changing the video parameters of the signalsTiming, frequencies, scan mode, HDCP encryption, color space, audio sample rate, and many more. |
|
|
Configurable analog audio parametersVolume, 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: