background image

MSC-XD161L Product Manual

3 Mascot Control Protocol

MASCOT (

MA

trix 

S

witch 

CO

rporation Pro

T

ocol) provides an ASCII text based command interface via 

several different transports to control and get status from Matrix Switch Corporation devices.  This command 
protocol can be utilized for manual control or for integration with automation control systems.

Mascot command interface options

Web Page Command Tab

 

 

 – The most convenient user command interface, which can be accessed using a

Web Browser on a Computer by the device's IP address.

TCP/IP port 40 – A TCP/IP command interface is provided on port 40 which uses the device's Ethernet 
connector as a physical transport and can be accessed via a telnet application.

RS-232 Serial Port – Serial can also be used with the configuration parameters: 115200 bps 8N1.

RS-485 Serial Port – An additional serial interface on the same D9 connector as the RS-232 port can 
also be used.  See 

Serial Interface Pinout

 for more details.

3rd Party support

The MASCOT protocol contains a subset of the basic ISIS Protocol command set and therefore some 3

rd

 party 

equipment may work without modification using this protocol.  For information about other third party control 
system manufacturers who support MASCOT, contact Matrix Switch Corporation.

3.1 Protocol Changes

As new commands are added or other changes occur, the MASCOT protocol version is incremented.  The 
protocol revision can be obtained using the 

MascotVer command

.

Protocol revision history

Mascot version 3.0

Adde

System Parameter

 commands: 

Get

GetS

Set

SetA

, and 

SetS

 commands.

Current system parameters are defined in the 

System Parameter Table

, superseding many configuration 

commands.

New commands for defining matrix I/O mapping: 

MapDest

, and 

MapSrc

 commands.

New commands for panel/GPIO command macros and conditions: 

PanelCmd

PanelCmdEn

, and 

PanelCond

.

Commands now grouped int

Core Commands

Configuration Commands

, and 

Miscellaneous 

Commands

.

Mascot version 2.4 (Carina Series Firmware 5.6.3)

Added .

MtxGroup

PanelDis

, and 

PanelExtEn

 commands.

Mascot version 2.3 (Carina Series Firmware 5.5.1)

Adde

Quit Command

SysType Command

 and 

Vars Command

 which have previously been supported 

on the MSC-GCP2U32 only.

Mascot version 2.2 (Carina Series Firmware 5.5.0)

The 

X Command

 now accepts a 0 valued wild card destination to switch all destinations to a given 

Page 19 of 60

© 2013-2018 Matrix Switch Corporation

www.matrixswitch

 

 corp.com

 

 

Summary of Contents for MSC-XD161L

Page 1: ...x Switch Corporation MSC XD161L Product Manual Compact 16 input 1 output 3G SDI Video Router with Button Control Panel Revision 1 8 Page 1 of 60 2013 2018 Matrix Switch Corporation www matrixswitchcor...

Page 2: ...LITY PERFORMANCE MERCHANTABILITY OR FITNESS FOR PURPOSE Matrix Switch Corporation disclaims all liability arising from this information and its use Use of Matrix Switch Corporation devices in life sup...

Page 3: ...commands and Panel GPIO commands Improved Software Update documentation Added pinouts for RS 232 and RS 485 serial port and GPIO Auxiliary interface Added XD series systems Revision 1 3 2016 05 17 Add...

Page 4: ...2 Loading a preset 13 2 3 Presets Tab 13 2 3 1 Loading Work Matrix from a source target 14 2 3 2 Saving Work Matrix to a target 14 2 3 3 Usage scenarios 14 2 4 Labels Tab 14 2 5 Config Tab 15 2 5 1 S...

Page 5: ...and 37 3 11 22 PairIO Command 37 3 11 23 PanelCmd Command 38 3 11 24 PanelCmdEn Command 39 3 11 25 PanelCond Command 39 3 11 26 PanelDis Command 40 3 11 27 PanelExtEn Command 41 3 11 28 PanelRate Comm...

Page 6: ...recovery procedure 52 4 3 TFTP Software 53 4 3 1 Windows 53 4 3 2 Mac OS X 54 4 3 3 Linux 54 5 Troubleshooting 56 5 1 Unknown IP address 56 5 2 Unexpected reboots 56 6 Reference 57 6 1 Specifications...

Page 7: ...DI signals will be auto re clocked for reduced jitter Other non standard rates between 125 Mbit s and 3 0 Gbit s will be passed through without re clocking or jitter reduction Adaptive cable equalizat...

Page 8: ...e factory configured with default settings unless a pre configuration request is made during purchase an example being a multi device application 1 4 1 Accessing The Web Page Interface The default net...

Page 9: ...assigned to presets Labels can be up to 8 characters in length The default source labels use Src as a prefix and the destination labels use Dest as a prefix example Src1 The presets are labeled Startu...

Page 10: ...cted to the same LAN or allow IP packet routing between networks if on separate LANs SECURITY WARNING Matrix Switch Corporation devices are meant for installation in trusted LAN environments In the ev...

Page 11: ...ations sources and or levels Example use scenarios Utilize an 8x1 remote panel to control a single destination of an 8x8 video router Use the local panel of a 16x16 two level Video and Audio router to...

Page 12: ...ines to aid in further description below The web page interface for other router systems is sized appropriately Remote Panels show only the Config and Command tabs Numbered sections in Figure 1 1 Syst...

Page 13: ...Destination or a single level is selected 2 2 2 Loading a preset Presets store connection states for one or more Destinations Loading a Preset on the Routing tab consists of simply clicking on the Lo...

Page 14: ...a Preset will store the Work Matrix state to non volatile memory which persists through device power cycles and can be recalled at a later time 2 3 3 Usage scenarios The flexibility of the Presets Ta...

Page 15: ...mns for Video and Audio Sources and Destinations Single level routers will have a column for Source labels and one for Destination labels On multi level routers secondary levels can be left blank to u...

Page 16: ...haracters displayed at the top of the Web Page interface which is helpful when managing multiple systems Disable Reclockers Disable SDI reclockers not supported by all Routers 3D I O Pairing Enable pa...

Page 17: ...panels control different levels of a Video Audio Router Control Mode Set the matrix control mode only present on Routers Available options include Local Button panel controls the router itself Remote...

Page 18: ...Command text entry line followed by pressing the Enter key to execute them The results will be displayed in the text area below the command line Clicking the Clear Output button will clear all comman...

Page 19: ...without modification using this protocol For information about other third party control system manufacturers who support MASCOT contact Matrix Switch Corporation 3 1 Protocol Changes As new commands...

Page 20: ...d prompt character 3 3 Serial Access Matrix Switch router systems come equipped with a serial port which can be used as another means of sending Mascot commands Connect a Computer system to the device...

Page 21: ...CII 10 The Prompt A prompt character is displayed each time a command or chain of commands is entered to indicate readiness to receive additional commands If an error occurs in response to a command a...

Page 22: ...atically interpret argument as string spaces and commas not allowed Hex 0x3D 0xNN where NN are 2 hex digits from 0 9 A F or a f Double quoted One or more characters surrounded by double quotes An Argu...

Page 23: ...rted String String A generic string argument max length depends on the command Value A general value Value type depends on setting See System Parameters Table 6 Command Argument Types 3 7 System Param...

Page 24: ...ial port baud rate in bits second ctl serial2 log Boolean RW AS RS 485 serial port protocol log enable ctl serial2 proto String RW AS RS 485 serial port protocol selection mascot svs etc mtx serial Nu...

Page 25: ...mplementation and support variations between different system types Many of these commands have been superseded by System Parameters in Mascot protocol version 3 0 Command Arguments Description DHCP 0...

Page 26: ...il Please note that command availability may vary between firmware series and versions Details of availability are documented for each command 3 11 1 C Command Routers and MSC GCP2U32 only NOTE Supers...

Page 27: ...assigned via the IP Netmask and Gateway commands A value of 1 enables DHCP and will obtain the values for the IP address Netmask and Gateway from your DHCP server This value is saved and recalled on p...

Page 28: ...cho enable E 0 1 Set matrix echo enable 0 to disable 1 to enable Examples to query and then enable matrix echo E 0 E 1 3 11 5 Firmware Command NOTE Superseded by the sys firmware System Parameter Quer...

Page 29: ...eter Table for a list of currently defined parameters This command supersedes many individual configuration commands NOTE This command queries Active values of parameters which may differ from values...

Page 30: ...rameter identifier separated by an equals character and the value GetS Parameter Display the Stored value of a single parameter or a subset of parameters under a given parameter node 3 11 10 Help Comm...

Page 31: ...tection for outputs Format is one decimal number per output 0 Unlocked 1 SD 2 HD Example for a 16x4 system SD HD Unlocked Unlocked LockStatus 1 2 0 0 3 11 13 MAC Command NOTE Superseded by the net mac...

Page 32: ...nation 2 on the second level The second example queries the mapping for a single destination The third example maps destination 1 to physical destination 5 on all levels The fourth example maps destin...

Page 33: ...ver what protocol version is in use The returned value is either an integer such as 2 or major and minor version numbers separated by a period such as 2 3 Example MascotVer 2 3 3 11 17 MtxCfg Command...

Page 34: ...or reclocker disable If an argument is specified 0 7 then a more descriptive JSON structure is returned of the following form newlines and spaces added as a visual aid but are not necessarily part of...

Page 35: ...to response as a visual aid MtxCfg7 version 1 status OK levels name Level1 type VIDEO destCount 4 srcCount 4 flags mute destNames Dest1 Dest2 Dest3 Dest4 srcNames Src1 Src2 Src3 Src4 state 1 2 3 4 pse...

Page 36: ...ssigning I O grouping MtxGroup 1 1 MtxGroup 2 4 MtxGroup 2 4 The first example MtxGroup command shows that I O grouping is disabled on both levels of a 2 level system The second command configures the...

Page 37: ...reset information which is retained and available through system power cycles Command Description PAdd PRESET DEST SRC Add a connection of SRC to DEST on PRESET for all levels PAdd PRESET DEST SRC LEV...

Page 38: ...itch to ground Panel buttons and GPIO pins are specified by numeric ID Panel buttons are numbered beginning with ID number 1 Panel button order depends on the panel but generally has the top left butt...

Page 39: ...s 0 disable 1 enable Examples for querying and enabling panel command conditions PanelCmdEn 0 PanelCmdEn 1 3 11 25 PanelCond Command Protocol Version 3 0 Query and assign panel button GPIO status and...

Page 40: ...e first example above queries the currently assigned panel GPIO conditions which shows that button number 1 and 2 have P0 and P1 conditions assigned respectively which lights the button LEDs when the...

Page 41: ...setting 0 disabled The second command enables the external panel interface 3 11 28 PanelRate Command Protocol Version 2 1 For changing remote button panel refresh rate When a button panel is configure...

Page 42: ...e insensitive value Mascot however additional control protocols may be added in the future Value is stored and recalled on power up Command Description ProtoSer Query the protocol used on the serial p...

Page 43: ...RESET DEST Remove any existing connection to DEST in PRESET for any level PSub PRESET DEST LEVEL Remove any existing connection to DEST LEVEL in PRESET Example PSub 1 2 PSub 1 3 2 The first command re...

Page 44: ...y Protocol Version 2 1 Command for disabling or enabling SDI reclockers Not all router systems support this option Value is saved and recalled on power up Command Description ReclkDis Query current va...

Page 45: ...ry destination are shown This command without an argument is equivalent to the X Command with no arguments If an argument value of 1 is supplied then the matrix state is displayed with labels The stat...

Page 46: ...n the parameter and is defined in the System Parameter Table Values in Stored memory are loaded at system startup See System Parameters for more details Command Description Set List all parameter iden...

Page 47: ...ill not take effect until the system is restarted NOTE Some parameters may not be assignable in Stored memory for example if it does not make sense to recall a value on start up See System Parameters...

Page 48: ...E Superseded by the sys name System Parameter Query or assign system name The system name is provided for convenience when managing multiple Matrix Switch Corporation systems This value is stored and...

Page 49: ...mware not supporting the SysType command the second example is what might be returned by an MSC GCP2U32 LCD panel 3 11 45 Vars Command Protocol Version 2 3 Display all system configuration variables U...

Page 50: ...PRESET Example to save state to preset 1 W 1 3 11 47 WebPass Command Assign a web password to password protect the web page interface The serial and TCP IP port Mascot protocol control is not protect...

Page 51: ...a destination if supported for a given level Examples X 1 1 2 2 3 8 0 4 X 3 3 8 X 3 4 X 4 0 2 In the above examples the first command queries the matrix routing state typical of a 16x4 system for exam...

Page 52: ...image has been transferred to the device s FLASH storage area 5 The device will automatically reboot to perform the remainder of the software update during which the web page interface may display a c...

Page 53: ...o the IP address 192 168 2 59 Consult the TFTP Software section for details 4 3 TFTP Software There are many different options for TFTP client programs the choice of which depends on what operating sy...

Page 54: ...put MSC Pyxis Firmware x x x img 6 Make sure to replace MSC Pyxis Firmware x x x img with the correct version number of the file 7 Pressing ENTER after the put command will initiate the TFTP transfer...

Page 55: ...TFTP transfer binary put MSC Pyxis Firmware x x x img 6 Make sure to replace MSC Pyxis Firmware x x x img with the correct version number of the file 7 Pressing ENTER after the put command will initia...

Page 56: ...nning A computer system can then be configured with an IP address on the same IP subnet and the webpage configuration can be loaded for viewing and changing the IP address as described in the section...

Page 57: ...gh 100 Deg C Operating Temp 0 Through 75 Deg C Humidity 0 Through 90 Non Condensing Warranty 2 Years Parts Labor SDI Video Connector type BNC Data Types SMPTE 259M 292M 424M Data Rates 19 Mbit s throu...

Page 58: ...Audio levels Level numbers start from 1 Mascot Protocol An abbreviation of MAtrix Switch COrporation proTocol An ASCII text based protocol for interfacing to Matrix Switch Corporation devices Matrix U...

Page 59: ...MSC XD161L Product Manual devices for remote panel control the MASCOT network interface and the web page interface Page 59 of 60 2013 2018 Matrix Switch Corporation www matrixswitchcorp com...

Page 60: ...hich shall be placed on the outside of the shipping package 6 This warranty does not apply if the product has been damaged by accident abuse misuse misapplication or modification EXCEPT AS SET FORTH A...

Reviews: