background image

MSC-CP59X59E 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.

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 

source.

Page 16 of 56

© 2013-2016 Matrix Switch Corporation

www.matrixswitch

 

 corp.com

Содержание MSC-CP59X59E

Страница 1: ...Matrix Switch Corporation MSC CP59X59E Product Manual 1RU 59x59 Remote Elastomeric Button Panel Revision 1 4 Page 1 of 56 2013 2016 Matrix Switch Corporation www matrixswitchcorp com ...

Страница 2: ...UALITY 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 support and or safety applications is entirely at the buyer s risk and the buyer agrees to defend indemnify and hold harmless Matrix Switch Corporation from any and all damages claims suits or expenses...

Страница 3: ...protocol commands MtxGroup PanelDis and PanelExtEn Updated Mascot protocol information to version 2 4 New manuals for MSC V1616 LS DC MSC 1HD1616 LS DC Revision 1 1 2014 06 24 Updated External Button Control Pinout section Added External Button Control information for MSC HD42L 2014 03 17 Fixed some document cross references Minor text content and figure position changes 2013 11 29 MSC 4HDX6464 ma...

Страница 4: ... 3 Button Panel Settings 14 2 3 Command Tab 14 3 Mascot Control Protocol 16 3 1 Protocol Changes 16 3 2 Telnet Access 17 3 3 Command Format 17 3 3 1 Command Names 18 3 4 Response Format 18 3 5 Command Arguments 18 3 6 System Parameters 19 3 6 1 System Parameter Table 21 3 7 Core Commands 21 3 8 Configuration Commands 22 3 9 Miscellaneous Commands 22 3 10 Command Reference 23 3 10 1 B Command 23 3 ...

Страница 5: ...tNames Command 39 3 10 33 PSub Command 40 3 10 34 PView Command 40 3 10 35 Reboot Command 41 3 10 36 ReclkDis Command 41 3 10 37 RemoteSync Command 41 3 10 38 S Command 42 3 10 39 SerBaud Command 42 3 10 40 Set Command 43 3 10 41 SetA Command 44 3 10 42 SetS Command 44 3 10 43 SrcNames Command 44 3 10 44 SysName Command 45 3 10 45 SysType Command 45 3 10 46 Vars Command 46 3 10 47 W Command 47 3 1...

Страница 6: ...2 5 Troubleshooting 54 5 1 Unknown IP address 54 5 2 No Ethernet link when connected to network switch 54 5 3 Unexpected reboots 54 5 4 Glossary 54 6 Matrix Switch Corporation Warranty 56 Page 6 of 56 2013 2016 Matrix Switch Corporation www matrixswitchcorp com ...

Страница 7: ...is powered it goes through the following startup sequence 5 second startup delay to allow for Power On Software Updates The remote panel will attempt to connect to the IP address assigned to the Remote Router IP Address setting the panel button LEDs will cycle until a connection is established The button control panel is initialized and buttons are illuminated to show the initial routing status 1 ...

Страница 8: ...urrent active lit least significant digit output button which will flash The current selected audio source is indicated on the top row of buttons by lighting the applicable most and least significant buttons Selecting a new source is accomplished by pressing most significant and or least significant source buttons which will switch the audio only 1 4 Web Page Interface All Matrix Switch Corporatio...

Страница 9: ...ter IP Address Remote panels control Matrix Switch Corporation video audio routers with the TCP IP protocol via the Ethernet port The Remote Router IP setting on the Config Tab of the Web Page Interface defines the IP address of the remote router which the panel interface will control This defaults to 192 168 2 60 on remote panels which is the default IP address of Matrix Switch Corporation router...

Страница 10: ...configured by default to use IP addresses in the class C IP subnet 192 168 2 x When integrating devices into an existing LAN network unique IP addresses should be assigned from the applicable network and the Netmask setting of the devices should be set to reflect the class size of the IP network the default of 255 255 255 0 is for class C which accommodates up to 254 addresses The Gateway setting ...

Страница 11: ...inations 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 control Video only and an additional 16x16 remote panel to control Audio independently Use a 4x4 panel to independently control 4 destinations of an 8x8 router and limit selectable sources to 4 sou...

Страница 12: ...utlines 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 System name can be assigned on the Config tab 2 System firmware series and version 3 Tab navigation 4 Preset load drop down selection 5 Source connect buttons 6 Mute button may not be available on all ...

Страница 13: ...descriptive name of the system up to 15 characters displayed at the top of the Web Page interface which is helpful when managing multiple systems 2 2 2 Network Settings WARNING DHCP should only be enabled or the IP Address or Netmask changed if one has an understanding of TCP IP network configuration Once the save button is pressed and the system is rebooted any changes to DHCP enable the IP Addre...

Страница 14: ...destinations of a 16x4 Router 16 source 4 destination Another usage scenario would be to have 2 separate panels control different levels of a Video Audio Router Remote Router IP The IP address of the remote Router to control Dest Offset This setting determines what destination the button panel starts on Defaults to 0 which means the control panel starts on destination 1 Setting this value to 8 for...

Страница 15: ...nd 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 command output in the lower area See the section Mascot Control Protocol for more information Page 15 of 56 2013 2016 Matrix Switch Corporation www matrixswitchcorp com ...

Страница 16: ...COT 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 Added System Parameter commands Get GetS Set SetA and SetS commands Current system parameters are defined in the System Parameter Table su...

Страница 17: ... the IP address 192 168 2 60 press ENTER after the command telnet 192 168 2 60 40 Pressing the ENTER key after successfully connecting should display the command prompt character 3 3 Command Format Commands consist of a command name zero or more arguments separated by commas and a carriage return CR ASCII 13 the Enter key on a keyboard Optionally multiple commands can be combined by separating the...

Страница 18: ... prior to the prompt with the following format E00 Error message 00 will contain a 2 digit decimal error code Table 4 shows possible error codes which may be returned in response to commands Error Message Description E01 Token too long A command name or string argument was too long E02 Invalid command Invalid command name E03 Invalid argument One or more invalid argument values E04 Invalid destina...

Страница 19: ...Cmd String MASCOT command Cond String Condition statement See PanelCond Command Dest 1 N Destination number N Count of destinations IP D D D D IP address string argument specified as 4 decimal numbers from 0 to 255 separated by periods Json String JSON formatted string the structure of which depends on the command The JSON string should be quoted in single quote characters when specifying a JSON v...

Страница 20: ...r SetA Parameter Value Set Active value of a parameter only SetS Parameter Value Set Stored value of a parameter only Table 7 System Parameter Commands Parameter identifiers are represented as one or more alphanumeric words separated by periods representing a tree structure similar to file folders or directories Table 8 below describes the columns in the System Parameter Table Parameter Parameter ...

Страница 21: ... S Network gateway address net ip IP RW S Network interface IP address net mac MAC R Network interface MAC address net netmask IP RW S Network interface mask pnl cmdEn Boolean RW AS Panel command macro enable pnl ip IP RW AS Remote IP address for panel interface to control sys arch String R System architecture Pyxis Carina Lynx etc sys firmware String R Firmware series and version Pyxis 1 1 7 for ...

Страница 22: ...rouping command NetMask Netmask Network mask PairIO 0 1 I O pairing enable Superseded by the MtxGroup command PanelCmd Button Cmd Panel button GPIO command macros PanelCmdEn 0 1 Enable panel button GPIO command macros PanelCond Button Cond Panel button GPIO status conditions PanelDis 0 1 Internal panel button interface disable PanelExtEn 0 1 External panel interface enable if available PanelOfs De...

Страница 23: ...dates section for details 3 10 2 C Command Routers and MSC GCP2U32 only NOTE Superseded by the MtxCfg Command The C command queries the matrix size The response is in the format Dests Srcs Levels Flags1 Flags2 Where Dests is the count of system destinations Srcs is the count of sources and Levels is the number of system levels The Flags1 and Flags2 fields are currently unused and will be 0 Example...

Страница 24: ...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 power up WARNING A DHCP server must be present on your network for this to function properly Using DHCP allows for dynamic IP or fixed IP assignment from a central location the DHCP server Using this option is only recommended if...

Страница 25: ... echo 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 10 6 Firmware Command NOTE Superseded by the sys firmware System Parameter Query the system firmware series and version Example Firmware Pyxis 1 1 7 3 10 7 FrameIP Command NOTE Superseded by the pnl ip System Parameter Query or assign the remote router IP address Usually only ...

Страница 26: ...ameter 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 in Stored memory Values in Stored memory are loaded at system startup and can be queried with the GetS Command See System Parameters for more details Command Description Get Display all system param...

Страница 27: ...parameter 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 10 11 Help Command Display command reference information 3 10 12 IP Command NOTE Superseded by the net ip System Parameter Query or assign the system IP address This setting is saved and recalled on power up WARNI...

Страница 28: ...detection 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 10 14 MAC Command NOTE Superseded by the net mac System Parameter Query system Ethernet MAC address Command Description MAC System Ethernet MAC address in hh hh hh hh hh hh where each hh is a pair of hex digits Example MAC 00 50 C2 8B DF FE 3 10 ...

Страница 29: ...tination 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 destination 1 to physical destination 6 on the second level only 3 10 16 MapSrc Command Routers only Protocol version 3 0 Query or assign matrix source mappings Source mappings provide a means to remap lo...

Страница 30: ...cover 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 10 18 MtxCfg Command Routers and MSC GCP2U32 only Protocol Version 2 0 Query matrix configuration This command replaces the C command and provides the ability to query the matrix dimensions labels current matrix state a...

Страница 31: ...y 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 the response version 1 status STATUS levels name NAME type TYPE destCount DEST_COUNT srcCount SRC_COUNT flags FLAGS destNames NAME NAME srcNames NAME NAME state SRC SRC psetData SRC SRC psetNames NA...

Страница 32: ...d 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 psetData 1 2 3 4 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 psetNames Startup Preset1 Preset2 Preset3 Preset4 Preset5 Preset6 Preset7 Preset8 Preset9 The example output abo...

Страница 33: ... assigning 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 system for dual I O grouping on level 1 and quad I O grouping on level 2 On an example 16x16 two level router this would result in an 8x8 matrix on level 1 and a 4x4 matrix on level 2 3 10 20 NetMa...

Страница 34: ... preset 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 LEVEL Add a connection of SRC to DEST LEVEL on PRESET Example PAdd 1 2 3 PAdd 1 3 0 2 The first command adds a connection from Source 3 to Destination 2 in Preset 1 The second command Mutes Destination...

Страница 35: ...tch 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 button as button 1 followed by number 2 in the lower left corner number 3 in the top second column continuing to alternate between top and bottom rows till the last button lower right hand corner GPIO auxi...

Страница 36: ...s 0 disable 1 enable Examples for querying and enabling panel command conditions PanelCmdEn 0 PanelCmdEn 1 3 10 26 PanelCond Command Protocol Version 3 0 Query and assign panel button GPIO status and indicator conditions Panel button GPIO conditions are a counterpart to Panel Commands and provide a means to easily implement custom status to light panel buttons or change logic states on output GPIO...

Страница 37: ...The 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 current matrix routing matches preset 0 or preset 1 respectively and GPIO pin 3 GPIO pins start at 65 will output a logic 1 if the matrix matches preset 0 The second command queries the panel condit...

Страница 38: ...e setting 0 disabled The second command enables the external panel interface 3 10 29 PanelRate Command Protocol Version 2 1 For changing remote button panel refresh rate When a button panel is configured to control a remote router the current connection status is refreshed at regular intervals This command can be used to increase or decrease the rate which is saved and recalled on system power up ...

Страница 39: ...ase 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 port ProtoSer PROTO Assign the protocol used on the serial port the only valid value is currently Mascot Examples ProtoSer Mascot 3 10 32 PsetNames Command Routers and MSC GCP2U32 only Query or assig...

Страница 40: ... PRESET 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 removes any connection to Destination 2 in Preset 1 The second command removes any connection to Destination 3 Level 2 on Preset 1 3 10 34 PView Command Routers and MSC GCP2U32 only View presets Displ...

Страница 41: ...nly 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 value of reclocker disable ReclkDis 0 1 Enable or disable reclockers 0 or 1 respectively Examples ReclkDis 0 ReclkDis 1 The first command above queries the current reclocker disable value which return...

Страница 42: ...very 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 state of each destination is displayed one per line in the format DestNLvl1 SrcLvl1 DestNLvl2 SrcLvl2 Example S1 Dest1 Src4 Dest1 Src4 Dest2 Src3 Dest2 Src3 Dest3 Src2 Dest3 Src2 Dest4 Src1 Dest4 Src4 T...

Страница 43: ... on 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 identifiers which can be set one per line Set Parameter Value Set a parameter s Active and or Stored value depends on parameter Examples of listing all writable parameters and setting the net ip paramet...

Страница 44: ...OTE 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 for more details Command Description SetS List all parameter identifiers which can be set in Stored memory one per line SetS Parameter Value Set a parameter s Stored value 3 10 43 SrcNames Command Routers and MSC GCP2U32 only Query or assign source na...

Страница 45: ...ssign system name The system name is provided for convenience when managing multiple Matrix Switch Corporation systems This value is stored and recalled on power up Command Description SysName Query system name SysName STR Set system name up to 15 characters Example for querying and assigning system name SysName MSC Router SysName MyRouter 3 10 45 SysType Command Protocol Version 2 3 NOTE Supersed...

Страница 46: ...he SysType command the second example is what might be returned by an MSC GCP2U32 LCD panel 3 10 46 Vars Command Protocol Version 2 3 Display all system configuration variables Useful in serial terminal or telnet sessions to view all configuration values Command Description Vars Display all system configuration parameters Note that variables consisting of JSON data simply show the string JSON to k...

Страница 47: ... 3 10 48 WebPass Command Assign a web password to password protect the web page interface The serial and TCP IP port Mascot protocol control is not protected by this password This value is stored and recalled on power up Command Description WebPass STR Set web page password blank to disable Examples of setting and clearing web page password WebPass SeCr3t WebPass 3 10 49 X Command Routers and MSC ...

Страница 48: ... 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 example the second command queries destination 3 only the third command connects source 4 to destination 3 on all levels and the fourth command mutes destination 4 level 2 Command stacking Command stacking is especially useful for...

Страница 49: ... a fixed update IP address of 192 168 2 59 whereas CSU uses the device s configured IP address POSU should be available even if a device s firmware gets corrupted from a previous update attempt whereas CSU will likely no longer be possible POSU has a shorter TFTP update time window of 5 seconds and the TFTP transfer has to occur within this period after power cycling the device This means the PC n...

Страница 50: ... is an Ethernet switch between the device and update PC Steps for executing a Command Software Update 1 Ensure that the Software Update Requirements are met 2 Configure the PC for a unique IP address on the same IP network as the device if not already Make sure that there are no IP conflicts with the PC or device 3 Prepare the TFTP program to transfer the firmware file to the device but do not ini...

Страница 51: ...ing order If network communication with the device is not working ensure network cabling and interconnect hardware is functioning ensure the proper IP address is being used to connect to the device is unique on the network and that the system being used to connect to the device has a unique IP on the same network subnet Consult the Unknown IP address section for details on recovering from an unkno...

Страница 52: ... application for example your home directory at Users your_user_name 2 Open a terminal Applications Utility Terminal 3 Use cd commands to change to the location of the firmware file for example cd Users your_user_name followed by the ENTER key 4 Execute the tftp command with the IP address of the device make sure to use the device s configured IP if the update method being used utilizes the device...

Страница 53: ...f the device make sure to use the device s configured IP if the update method being used utilizes the devices IP address tftp 192 168 2 59 5 Execute the following commands from within the tftp program pressing ENTER after each line except the last one to prepare the TFTP transfer binary put MSC Carina Firmware x x x hex 6 Make sure to replace MSC Carina Firmware x x x hex with the correct version ...

Страница 54: ...with another known good Ethernet device or swap the cable for a known good cable 2 Ensure proper power supply is being used for the system 5 Volt 2 Amp 3 If the switch is a managed switch try forcing 10 BaseT for the Ethernet port the device is connected to instead of rate auto detection 5 3 Unexpected reboots If the device is rebooting unexpectedly detectable on routers when the routing state get...

Страница 55: ...uter devices for remote control with touch buttons Router A Video Audio Routing device routes one or more sources to one or more destinations not to be confused with a Network router which is referred to as a Network Switch in this manual Simple Panel A Matrix Switch Corporation Remote Panel which has buttons only Smart Panel A Matrix Switch Corporation Remote Panel which comes equipped with an LC...

Страница 56: ... which 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 ABOVE NO OTHER WARRANTIES ARE EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE MSC EXPRESSLY DISCLAIMS ALL EXPRESS OR IM...

Отзывы: