Content

Summary

This document provides information about the Lawo C100 JSON protocol implementation for VSM.

Status of Driver

APPROVED 

Component for Driver

GADGETSERVER

Release (Build) of Component

vsmGadgetserver 5.6.1.139

Revision of Implementation1.2.14.0


Name/Type of 3rd Party APIJSON
Version of 3rd Party API1.10/1.11
Additional 3rd Party information

Connection

Connection TypeTCP/ IP
Default Port80
Stream TypeVirtual

Supported Features

  • Router Control
  • Parameter Control

Compatibility Bundles

Proper interoperability between VSM and V_matrix system depends on specific software versions running on each component, which have been tested together. These tested bundles are listed here:

Configuration Details

Ember+ Mapping

While Lawo V_matrix systems were initially controlled via Ember+ (v1.8), this control interface has been replaced by JSON via Websocket in newer versions (v1.10 or higher). As web-based APIs are handled through vsmGadgetserver, control connections to C100 modules will use vsmGadgetserver as protocol gateway. vsmGadgetserver provides a functionality in the C100 driver, which allows to map a JSON based parameter structure to the existing Ember+ based C100 configuration in vsmStudio. This reduces reconfiguration efforts in VSM to a minimum should you upgrade your C100 modules from v1.8 to 1.10 or higher.

In order to map JSON parameters to the corresponding Ember+ parameters in a configuration, a few steps are recommended to be followed.

JSON to Ember+ Mapping - Step 1:

In the first step you insert vsmGadgetserver into the control connection between the C100 and vsmStudio. Refer to the vsmGadgetserver Manual for a general description of getting started with the service. Once the service is up and running, continue the mapping process by...

  1. creating a JSON consumer and connecting it to the C100 module you want to control, then...
  2. set the "Root Identifier" to Version_1_8 and...
  3. then set the "Ember+ Mapping File" to the path where the mapping file is located, e.g. d:\vsm\vsmGadgetServer.NET\emberMap_1_10

The mapping file is currently available upon request at "support@lawo.com".

It is not allowed to edit and customize the file. Changes in the file must be applied through VSM R&D and require a test run before they can be released. Any requests for changes must be addressed with VSM R&D directly or through Lawo Support (support@lawo.com). Lawo cannot be held responsible for malfunctions that can be traced back to an inofficial mapping file.


JSON to Ember+ Mapping - Step 2:

For the providing side towards the broadcast controller, make sure that...

  1. the "Alias" for the driver mapping is exactly set to V_matrix ...
  2. and "Single Binding Mode" is set to Enabled

Make sure, that the Alias is correctly set, otherwise it will not map to the previous connection.

JSON to Ember+ Mapping - Step 3:

For an efficient management of the connection, make sure you set the reflect identifier.

  1. Open the port settings window for the connection you just connnected to vsmGadgetserver, ...
  2. ... and set the reflect identifier to the previous value.

JSON to Ember+ Mapping - Step 4:

Finally, make sure that the layers get reassigned.

  1. For every c100 connection, go to the Layer Assignment tab and ...
  2. ... modify the layers to match the desired assignment.

FAQ Mapping File


No, the mapping file is not part of a regular installation. It must be copied locally to a vsmGadgetserver host and referred to from each C100 driver instance.
No, the mapping file cannot be edited. It is provided as a binary file. Adjustments are handled through R&D and will need to pass a Q&A test prior to publishing. If you encounter any issues with the mapping file, please get in contact with us through support@lawo.com.
The file is stored local on each cluster server. As it will not be automatically pushed when synchronising a server, you have to make sure the file is manually copied to each cluster server. Each instance of the driver refers to a local file for mapping, so make sure each driver instance points to an existing file.
No, using a mapping file refers to driver instances only, which have been created in vsmGadgetserver to connect to a C100 blade which was initially running on 1.8.x and connected into vsmStudio via Ember+. v_matrix Systems, which were initially running 1.10.x or higher when they were connected to vsmStudio, do not need a mapping file.
The mapping can be requested at our support: support@lawo.com

Known Issues

  • A very limited number of parameters are currently either not available through the driver or cannot be mapped by the file. This may either be to technical limitations, or may change over time