Driver implemented in: vsmGadgetServer

Content

Summary

This document provides information about the TAG Multiviewer protocol implementation for VSM.

Status of Driver

APPROVED

Component for Driver

GADGETSERVER

Release (Build) of Component

vsmGadgetserver 5.6.x

Revision of Implementation1.0.0.9


Name/Type of 3rd Party APIRest API
Version of 3rd Party API
Additional 3rd Party information

Connection

Connection TypeHTTP
Default Port80

Supported Features

The protocol supports the MCM-9000 device.

  • Reconnect ability as well as support for backup devices where the driver will switch over to an alternative device in case the primary fails.

  • Access to the receivers (Rx) marked by their respective channels (group of receivers) including SDP patching or manual network configuration.

  • Access to Outputs (MV output containing layout with PiPs) including senders (Tx) which contain read only SDP and network parameters.

  • Access to PiPs in each output dependant on the layout type selected for that specific output.

  • Ability to change UMD label text and tally color.

  • When no valid IP address / Endpoint exists in the protocol configuration it will try to connect to 127.0.0.1:80 (If an address exists in the configuration but the driver is trying to connect to 127.0.0.1:80 that might mean wrong endpoint syntax)

Supported Commands

HEAD {IP ADDRESS}Checks if the device is online in case of connection errors / Also serves as Keep Alive when the connection was established.
GET OutputsGets all of the available outputs.
GET OutputGets a specific output by UUID.
PUT OutputEdits a specific output by UUID. Used to change the layout type.
GET LayoutsGets all of the available layouts on the device.
GET LayoutGets a specific layout by UUID.
GET Auxiliary InterfaceGets all of the current aux interfaces (UMD text / tally)
POST Auxiliary InterfaceSends a UMD text / tally update to PiPs with a specific name (multiple PiPs with the same name will receive this update).
GET ReceiversGets all of the receivers (Rx).
GET ReceiverGets a specific receiver (Rx) by UUID.
PUT ReceiverEdits a specific receiver (SDP or network configuration)
GET SendersGets all of the senders (Tx).
GET SenderGets a specific sender (Tx) by UUID

Configuration Details

It's important to make sure that the PiPs on the TAG UI are properly configured. To be able to control the UMD labels top label (UMD 0) should have the #U0# value and bottom label (UMD 1) should have #U1# value. Additional syntax like color and value manipulation can be found in the TAG documentation.

It's important to fill the Tally Settings field for each PiP on the TAG UI if we want to control the PiP at all (minimum 6 characters). Multiple PiPs can share the same name resulting in a single change with some name appearing on all PiPs which share the same name. This value can also have an additional part [border=tl] or [border=tr] where the border of the PiP will inherit respectively the left or right tally colors. (example: TSL_0_3[border=tl])

Protocol Settings:

  • Login - The user login required to access the MV.

  • Password - The user password required to access the MV.

  • PiP Count - The max number of PiPs that can exist in a layout (important for proper configuration) (default 100).

  • Timeout - The timeout length (in milliseconds) for the requests sent to the device (Setting this value too low might lead to problems) (default 500).

  • Polling Interval - The amount of time (in milliseconds) between each lazy poll of the current data of the device (Setting this value too low might lead to problems) (default 10000).

  • Subscription Polling Interval - The amount of time (in milliseconds) between each poll of the subscribed parameters (Setting this value too low might lead to problems) (default 5000).

  • Device Mapping File - Contains the mapping of the device's components like Receivers, Senders, Layouts, Outputs marked with their UUIDs. Can be edited from within the store file.

  • Color Mapping File - Bitmask color mapping file containing 32 entries where each bit has an assigned color hex value. 4 colors are configured by default. The rest is set to #FFFFFF and can be changed by editing the file from within the store file.

Known Issues

  • The device doesn't return the data for the compressed MPTS channels.

  • Setting the polling values too low can result in a lot of connection problems and disconnects since the TAG MV can't keep up.

  • Due to current issues with tally duration the updates will disappear after some time (to be fixed by TAG)

  • Making mistakes when filling the Tally Settings field for PiPs on the TAG UI might lead to value not being parsed correctly and as a result losing control over some PiPs.

  • Workflow inconsistencies may apply - not all exclusively solvable from a VSM perspective. Please carefully consider the workflow capabilities before accepting control requirements.