M2100

M-2100DIGITAL MASTER CONTROL SYSTEM Automation Interface Protocol Manual SOFTWARE VERSION 6.0 071011606 JULY 2003 Contacting Grass Valley Region North America Pacific Operations Voice (800) 547-8949 Support: 530-478-4148 +852-2585-6688 Support: 852-2585-6579 +33 1 45 29 73 00 +49 221 1791 234 +49 221 1791 235 Fax Sales: (530) 478-3347 Support: (530) 478-3181 +852-2802-2996 +44 1753 218 757 Address Grass Valley P.O. Box 599000 Nevada City, CA 959597900 USA Web Site www.thomsongrassvalley.com U.K., Europe, Asia, Middle East +44 1753 218 777 France Germany Copyright © Thomson Broadcast and Media Solutions All rights reserved. Grass Valley Web Site The www.thomsongrassvalley.com web site offers the following: Online User Documentation — Current versions of product catalogs, brochures, data sheets, ordering guides, planning guides, manuals, and release notes in .pdf format can be downloaded. FAQ Database — Solutions to problems and troubleshooting efforts can be found by searching our Frequently Asked Questions (FAQ) database. Software Downloads — Software updates, drivers, and patches can be down- loaded. 2 M-2100 Automation Interface Protocol Manual Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Section 1 — Automation Message Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Automation Control Port Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Enabling/Disabling Automation Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Protocol Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Automation Determinacy Constant Considerations . . . . . . . . . . . . . . . . . . . . . . . . 13 XPT_TAKE and BREAK_AWAY Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 TX_START Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Protocol Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Example 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Example 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Example 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 29 29 29 31 31 31 32 32 33 34 35 36 37 37 38 39 39 40 40 40 Section 2 — Automation System Protocol Commands . . . . . . . . . . . . . . . . Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TX_NEXT — Next Transition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TX_START — Start Transition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TX_TYPE — Select Transition Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TX_RATE — Select Transition Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TX_STAT — Transition Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TX_STAT2 — Transition Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XPT_TAKE — Crosspoint Take. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BREAK_AWAY — Break Away . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . OVER_SELECT — Audio Over Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . OVER_RATIO — Audio Over to Main Ratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . KEY_MOD — Key Modifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KEY_ENABLE — Key Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KEY_STAT — Key Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AUTO_STAT — Automation Enable Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ALL_STOP — All Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PREROLL — Current Preroll Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M-2100 Automation Interface Protocol Manual 3 . Video PST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 42 42 43 45 46 47 47 49 50 51 51 51 52 52 55 55 55 56 56 56 57 57 57 57 57 58 58 58 59 59 60 60 60 60 61 62 62 63 64 64 65 67 67 67 68 68 69 70 71 Appendix A — Tally Expansion . . . . . . . . . . . . . . . . . . . . . . . .. . . . Command Formats. . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GPI — GPI Button Operation . . . . . . . . . . . . . Data Fields . . . . PROTO_VER — Protocol Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AP1 PST . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . Aux 4 . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MCP Aux Ports 1 – 4. . . . . . . . . . . . . . AP4 PGM . . . . . . . . . . . . . . . . . . . . . . . . . . . SYSTEM_STAT — System Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ERROR_STAT — Error Status . . . . . . . . . . . . . . .Preroll/Transition Button Press/Release Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SUBSCRIBE — Subscription Service . . . . . . . . . . . . . . . Tally Command Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . .. .. . . Specifications. . . . . . . . . . . . . . Packet Byte Count . . . . . . Enabling the MCP Frame Tally Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents CONFIG_PREROLL — Configuration Preroll Time . . . . . . . General Information. . . . . . . . . . . . . . . REMAINING_TIME — Remaining Time Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Packet Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SUBSCR_HOLD . . . . . . . . . . . . . . . . . Automation Protocol Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . Appendix B — M–2100 MCP Frame Tally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . Protocol Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subscription Command Operation . . Data Value Limits . . Aux 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SUBSCR_PRETRANS . . . . . . . . . . . Aux 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling and Setup Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setup Parameters . . . . . . . . . Protocol Version Command Code . . . . . . . . . . . . . . AP3 PST . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . Aux 2 . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . .. . . . . . . . M2100_VER — FCM Software Version . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AP2 PGM . . . . . . . . . . . . . . . SYSTEM_CONFIG — System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XPT_AUDIO_MODE — Crosspoint Audio Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . AP1 PGM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AP2 PST . . . . . . . . . . . . . AP3 PGM . . . . . . . . . . . . . . . . . . . . . . . . . .Hold Button Press/Release Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checksum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AP4 PST . . 4 M-2100 Automation Interface Protocol Manual . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . .. Physical. . . . . . . . . . . . WIPE_SEL — Select Wipe Patterns . . Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . M-2100 Automation Interface Protocol Manual 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 71 72 72 75 Index .Contents Message Definition . . . . . . . . . . . . . FCM Name Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DOS Test Program. . . . . . . . . . . . . . . . . . . FCM Name Message . . . . . . . . . . . . . . . . . . . . . Contents 6 M-2100 Automation Interface Protocol Manual . Appendices are provided for Expansion and MCP Frame Tally functionality. M-2100 Automation Interface Protocol Manual 7 .Preface About This Manual This manual describes the automation protocol for externally controlling an M–2100 Master Control Switcher. The system message protocol and protocol commands are described in this reference document as well as instructions for connecting an external device to the processor frame. Preface 8 M-2100 Automation Interface Protocol Manual . • • M-2100 Automation Interface Protocol Manual 9 . Commands for controlling the M–2100 automation interface are given in Section 2 of this manual. The MCP will be forced to Married mode. Commands with bit fields allow more than one option to be selected. General Information The following general rules apply to this protocol: • • • • This protocol does not allow access to all parameters and controls of a Manual Control Panel (MCP) connected to the M–2100. the commands will still be processed and executed to the extent possible. Automation commands will override any inconsistent setting on the MCP. For example: If Next Transition Key Only is requested. the result will be the commands that are received first. Refer to the M–2100 User Manual for more information on the operational functions that the protocol commands execute. The M–2100 can be queried to help find the error.Section 1 Automation Message Protocol Introduction This section describes the Master Control protocol standard for the M-2100 Digital Master Control product. 0x12 hex = 18 dec). The Master Control Message Protocol defines the low-level format of messages passed to/from the Master Control system. except for hexadecimal numbers which have a 0x prefix (for example. Hot cuts from automation will not be accepted during MCP triggered or automation transitions. the MCP cannot be in Audio Only mode. If protocol commands are received that contain errors. If MCP buttons are being pressed when automation commands are received. All numbers are in decimal. hot cuts from the control panel will not be accepted during automation-triggered transitions and will respond with a panel beep. However. Section 1 — Automation Message Protocol Automation Control Port Connection Communication between an automation system and the M–2100 is accomplished via the RS-422 point-to-point serial connection at AUTOMATION CONTROL connector J21 on the rear of the M–2100 SD and HD frame.2k bps are supported on this RS-422 serial port. 10 M-2100 Automation Interface Protocol Manual . socket contacts Pin 1 D-9 Female Pin 1 Pin 5 Pin 6 Pin 9 2 3 4 5 6 7 8 9 Shield Automation Control (J21) Frame GND TX– RX+ RX Com Spare TX Com TX+ RX– Frame GND Frame GND The default settings for the serial connection are given in Table 2. GPI 1 and GPI 2. Automation may be enabled from the FCM Console port using the vxShell command. Table 2. Table 1. Automation status may be queried with the AUTO– STAT command (AUTO_STAT — Automation Enable Status on page 40). the GPI buttons. The cable pinout (cable not provided) for J21 is given in Table 1.4k bps 8 None 1 Parameters for the FCM-to-automation serial communication link are set in the General Parameters form of the M–2100 Configuration Manager application. Automation Port Serial Control Settings Baud Data Bits Parity Stop Bits 38. For single channel systems with an MCP. on the panel can be programmed to enable or disable automation.4k bps to 115. Refer to the System Configuration section of the M-2100 Installation and Service Manual for details on setting the automation control. the automation status is enabled by default. Enabling/Disabling Automation Control For systems with no Manual Control Panel (MCP). automEnableCfgSee (on/off). Automation Control Connector J21 Pinout Shielded 9-Pin D. Transfer rates between 38. assign Automation Enable to either or both buttons in the GPI Form in the M–2100 Configuration Manager application. Note When the Channel Control subpanel is installed in the MCP. All commands will be performed 2 fields after they are received. Every message returns an ACK (0x04). A gap of at least 1. Protocol Format The protocol is based on the SMPTE standard with the following modifications: • • Messages larger than 256 bytes are now allowed.3 milliseconds between successive bytes indicates the start of a new message. Message synchronization is accomplished by a delay in the stream of bytes sent to the M–2100. or the data requested. Multiple commands or queries can be formatted into a single message. To guarantee determinism (refer to Automation Determinacy Constant Considerations on page 13). the GPI buttons are not programmable for this function. NAK (0x05).Protocol Format To activate these buttons for automation control. instead of a break/address sequence. commands must be received by the M–2100 no later than 13 milliseconds into the field. except for the commands which are affected by the determinacy constance value setting in the configuration (see Table 5 on page 30). automation is enabled and disabled with Auto Enable 1 – 4 buttons on the Channel Control multichannel subpanel option. For multiple channel systems with an MCP. • • • M-2100 Automation Interface Protocol Manual 11 . Twos-complement of the sum of all bytes in the message (excluding STX).. items enclosed with [] are optional.b A command belonging to the preceding cmdClass. [cmdClass2] [byteLen2] [subCmd2]. The Command Class and Sub-Command fields consist of 1 byte. the M–2100 will respond with one of three data types: 1. (Refer to Table 5 on page 30. items enclosed within < > are required. byte counts can be encoded as one or two bytes. Does not include itself (1 or 2 bytes). . ClassiÞcation of command to follow (1 byte). Does not include the stx. then the byte count consists of only one byte. Acknowledge to a command <ACK>. This encoding allows up to 127 bytes to be represented with a single byte while up to 32. This encoding allows up to 127 bytes to be represented with a single byte while up to 32. b All After the message has been received.. data fields are variable lengths.) Optional data associated with subCmd1 (variable number of bytes as deÞned in the protocol on a per-command basis). 12 M-2100 Automation Interface Protocol Manual . or the checksum.767 bytes with two bytes. 2.. Fields that consist of more than 1 byte are output with the Most Significant Byte (MSB) first. Table 3. 3. (Refer to Table 5 on page 30..) Number of bytes for cmdClass1. Byte length of the whole message (1 or 2 bytes)a. indicates a repeat of the previous item(s)..Section 1 — Automation Message Protocol An M–2100 protocol message consists of a series of required and optional fields. Data in response to a query. <checkSum> stx byteLen0 cmdClass1 byteLen1 subCmd1 cmd1Data checkSum a All Start of transmission (1 byte). byte counts can be encoded as one or two bytes. If the most signiÞcant bit of the Þrst byte is set. Protocol Format <stx> <byteLen0> <cmdClass1> <byteLen1> <subCmd1> [cmd1Data] [subCmd2]. then the byte count consists of only one byte. Not acknowledge to a message <NAK>.. Byte lengths are 2 bytes. If the most signiÞcant bit of the Þrst byte is set.767 bytes with two bytes. itself. Note In Table 3 below. All commands will be performed 2 fields after they are received. To guarantee enough time for the execution of a deterministic command to complete. It is set to a minimal default value of 2 fields. Automation commands of the same type that are sent in sequence must be also separated by enough time to allow their complete execution. Commands and queries have been summarized in Table 5 on page 30 which lists each command and their possible state. M-2100 Automation Interface Protocol Manual 13 . Commands with special considerations are summarized below. if a TX_NEXT command is sent. The time allowed for execution of commands is called the Automation Determinacy Constant. the M-2100 may assume that the two messages are part of a single message and they may not be executed properly. As stated above. there must be a gap of at least 1. If this minimum duration is not observed. For example.3 milliseconds between the end of one automation message and the start of the next message. It is considered an error for an automation system to send an automation command before execution of a previously sent command of the same type has been completed. unless the Automation Determinacy Constant has been set to a different value. queries are executed immediately and are not affected by the Automation Determinacy Constant.Automation Determinacy Constant Considerations Automation Determinacy Constant Considerations All messages sent as commands are considered to be deterministic (their execution must occur a guaranteed time after the M–2100's receipt of the command) and they must be sent with certain considerations. Queries are executed as soon as they are received and are not considered deterministic. XPT_TAKE and BREAK_AWAY Commands The XPT_TAKE and BREAK_AWAY commands cut the indicated crosspoints on the designated buses. Some automation commands can be sent as a command or as a query. the automation system must wait until that command has completely executed before sending another TX_NEXT command. Deterministic commands always require a certain amount of time to execute on the M–2100 before the next command or query is received. When multiple commands are sent from an automation system. commands must be received by the M–2100 no later than 13 milliseconds into the field. These hard cuts occur immediately upon expiration of the Automation Determinacy Constant interval. It can be set by the user in the Automation Control section of the General Parameters form in the M–2100 Configuration Manager application or using the VxShell command autoDeterCfgSee at the FCM Console port. the video and key cuts will occur (assuming a Take transition type) and the audio will be at the bottom of the fade. referred to as the Transition Delay Constant. fadetake) are set to a default value of 100 mS. take-fade. All other transition types (fade-fade. if present. was introduced. If a transition contains an audio component that is transitioned using a Fade-Fade transition type. This is an intolerable situation for the deterministic TX_START command. As depicted in Figure 1. Thus the switching of the video and key components of a transition will be delayed if there is an audio component in a transition. it is necessary to delay the Take to occur at the minimum point (bottom) of the fade. The normal value of this constant is 6 fields. Therefore. It is not accessible via the Configuration Manager. The Transition Delay Constant must always be equal or greater than the Audio Fade Rate for a Cut. will be fading down. but the possibly dramatic change in audio energy is likely to cause artifacts such as pops and thumps in the analog audio processing that may follow.Section 1 — Automation Message Protocol TX_START Command There is another consideration for the TX_START command. 14 M-2100 Automation Interface Protocol Manual . an audio component. The Audio Fade Rate for a Cut Constant can be set using the VxShell command cutAudioRateCfgSee () and is expressed as milliseconds. The purely digital switch of the M–2100 will be clean. This audio cut rate value can be set to any value desired but will only apply to a Take transition. At the end of the Transition Delay Constant. A TakeFade transition is similarly upgraded to an asymmetrical Fade-Fade. 5 fields in 625 line rate). which is normally 100 ms (6 fields in 525 line rate. During this Transition Delay Constant. remain as Takes). beginning the fade up to the new source. an additional delay constant. and is fixed for all field rates. and a video and/or key component is transitioned using a Take transition type. The Transition Delay Constant can be set using the VxShell command transDelayConsCfgSee and is not accessible via the Configuration Manager. any audio take transition is automatically changed to a Fade for the audio component. It is recommended that the audio component not be a hard cut as a normal practice. The Transition Delay Constant operates for all transition types and all source components. To correct this situation. A Take transition is upgraded to a Fade-Fade for audio (but the video and key components. this Transition Delay Constant is the guaranteed additional delay. after the expiration of the Automation Determinacy Constant. to the point where the new video/audio/key signals first appear on the program bus. again for the audio component only. if any. Figure 1. the Take audio cut rate will return to the default of 100 mS. The programmed cut audio rate will only change when it is reprogrammed with the Console command or the system NVRAM is cleared. Set using autoDeterCfgSee. M-2100 Automation Interface Protocol Manual 15 . it will be used as the cut audio rate each time a Take type transition is performed.Transition Delay Constant Automation Determinancy Constant 2 fields minimum (Note 2) TX_START command (Note 1) Guaranteed cut point. The command must be received no later than 13 ms into the field. This can be set using cutAudioRateCfgSee. 4. Delay Constant in fields. 3. 5 fields for 625 standard). Trans. 2. or matte/silent for fade type transitions. & Key Video Audio Beginning of audio fade (Note 4) Key Video Key Center of audio fade End of audio fade Example 2 Take: No Audio Field: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Notes: 1. TX_START . start of mix/wipe. 6 fields normally (Note 3) Example 1 Take: Video.Automation Determinacy Constant Considerations Once the audio cut rate is programmed with the Console command. Not available in Configuration Manager. Set using transDelayConsCfgSee. Audio. When the system NVRAM is cleared using the Console command voidNvramSee 1. or the PC Configuration Manager. The new programmed value will remain after a system reboot. The audio fade rate for a cut is normally 100 ms (6 fields for 525 lines. Not available in Configuration Manager. Selecting another transition type will recall the default value of 100 mS. Message byte count MSB Message byte count LSB Transition Type command that the Most Significant Bit is set.Section 1 — Automation Message Protocol Protocol Examples The following examples demonstrate the message format for the M–2100 Protocol. Note Start of transmission Message byte count MSB Message byte count LSB Classification of commands to follow. indicating a 1 byte byte count. AUTO -> M–2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [03] TX_TYPE [04] MIX [F2]Checksum Start of transmission Message byte count1 Classification of commands to follow Message byte count Transition Type command Transition Type selection Message checksum M–2100 -> AUTO [04] ACK Acknowledge to message Example 2 Two commands from the automation system select a Wipe transition type and a Transition Rate of 30 frames. AUTO -> M–2100 [02] STX [00] Byte 0 [09] Byte 1 [01] CMD [00] Byte 0 [06] Byte 1 [03] TX_TYPE 1. 16 M-2100 Automation Interface Protocol Manual . The M–2100 -> AUTO symbol in the example indicates Master Control is transmitting to Automation. Example 1 A single command from the automation system selects a Mix transition type. The AUTO -> M–2100 symbol in the example indicates that Automation is transmitting to the Master Control. Message byte count MSB Message byte count LS Transition rate reply Current rate selected M-2100 Automation Interface Protocol Manual 17 . AUTO -> M–2100 [02] STX [00] Byte 0 [04] Byte 1 [02] QUERY [00] Byte 0 [01] Byte 1 [04] TX_RATE [F5] Checksum Start of transmission Message byte count MSB Message byte count LSB Classification of queries to follow.Protocol Examples [06] WIPE [04] TX_RATE [00] RATE [00] Byte 0 [1e] Byte 1 [c5] Checksum Transition Type selection Transition rate select Use rate value to follow Transition rate value MSB Transition rate value LSB Message checksum M–2100 -> AUTO [04] ACK Acknowledge to message Example 3 A single query from the automation system requests the current transition rate. Message byte count MSB Message byte count LSB Transition rate query Message checksum M–2100 -> AUTO [02] STX [00] Byte 0 [07] Byte 1 [03] STATUS [00] Byte 0 [04] Byte 1 [04] TX_RATE [00] R ATE Start of transmission Message byte count MSB Message byte count LSB Classification of status to follow. excluding STX. AUTO -> M–2100 [02] STX [00 Byte 0 [0e] Byte 1 [01] CMD [00] Byte 0 [06] Byte 1 [03] TX_TYPE [04] MIX [04] TX_RATE [01] SLOW [00] Byte 0 [00] Byte 1 [02] QUERY [00] Byte 0 [02] Byte 1 [03] TX_TYPE [04] TX_RATE [d4] Checksum Start of transmission Message byte count MSB Message byte count LSB Classification of commands to follow. Message byte count MSB Message byte count LSB Transition type command Transition type selection Transition rate command Transition rate selection Transition rate value MSB (N/A) Transition rate value LSB (N/A) Classification of queries to follow. then invoke a query for transition type and transition rate.Section 1 — Automation Message Protocol [00] Byte 0 [1e] Byte 1 [d0] Checksum Transition rate value MSB Transition rate value LSB Message checksum Example 4 Two commands and two queries from the automation system select a Mix transition type and a slow transition rate. Message byte count MSB Message byte count LSB Transition type query Transition rate query Message checksum: Two’s complement. M–2100 -> AUTO [02] STX [00] Byte 0 [09] Byte 1 Start of transmission Message byte count MSB Message byte count LSB 18 M-2100 Automation Interface Protocol Manual . because the Wipe Option is not available. which returns information about what was wrong with the previous message. Message byte count MSB Message byte count LSB Transition Type command Transition Type selection (note: assume the option is not available) Message checksum: Two’s complement. AUTO->M–2100 [02] STX M-2100 Automation Interface Protocol Manual Start of transmission 19 . AUTO -> M–2100 [02] STX [00] Byte 0 [05] Byte 1 [01] CMD [00] Byte 0 [02] Byte 1 [03] TX_TYPE [06] WIPE [ef] Checksum M–2100 -> AUTO [05]NAK Not acknowledge to message Start of transmission Message byte count MSB Message byte count LSB Classification of commands to follow. The M–2100 returns an error. Example 5 A single command from the automation system selects a Wipe transition type. The next command issued is a request for Error Status. Message byte count MSB Message byte count LSB Transition type reply Current transition type Transition rate reply Current rate selected Transition rate value MSB Transition rate value LSB (rate of 60 currently being used for SLOW) Message checksum: Two’s complement excluding STX.Protocol Examples [03] STATUS [00] Byte 0 [06] Byte 1 [03] TX_TYPE [03] TAKE_FADE [04] TX_RATE [01] SLOW [00] Byte 0 [2c] Byte 1 [b7] Checksum Classification of queries to follow. excluding STX. data from TX_TYPE command Argument #1 was found to be in error Message checksum: Twos complement. M–2100->AUTO [02] STX [00] Byte Count 0 [0E] Byte Count 1 [03] STATUS [00] Byte Count 0 [0B] Byte Count 1 [20] ERROR_STAT [06] FEATURE_ERR [01] CMD [03] TX_TYPE [00] Byte Pos1 [05] Byte Pos2 [00] data1 [00] data2 [00] data3 [06] WIPE [01] Arg # [AE] Checksum Start of transmission Message byte count MSB Message byte count LSB Classification of Status to follow Command Class byte count MSB Command Class byte count LSB Error Status reply Type of error (feature not available) Command Class of offending command Sub-Command of offending command Byte position of error MSB Byte position of error LSB (5th byte) Data byte #1 Data byte #2 Data byte #3 Data byte #4. excluding STX 20 M-2100 Automation Interface Protocol Manual . excluding STX.Section 1 — Automation Message Protocol [83] Byte Count [02] QUERY [81] Byte Count [20] ERROR_STAT [DA] Checksum Message byte count Classification of Query to follow Command Class byte count Error Status query Message checksum: Twos complement. Protocol Examples Example 6 The following example demonstrates how to setup Keyer 1 and transition it to air. M-2100 Automation Interface Protocol Manual 21 . enable Keyer 1 AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [0B] KEY_ENABLE [01] <keyer> [ED] Checksum M-2100->AUTO [04] ACK Acknowledge to message Next set transition type to Key or Key/Background. The example below assumes a Key only transition. AUTO->M-2100 [02] STX [86] Byte Count [01] CMD [84] Byte Count [0A] KEY_MOD [01] <keyer> [03] <key mod> Start of Message Message Byte Count Classification of commands to follow Message Byte Count Key Modifier Command Keyer Number Keyer Modification [00] <squeeze back> Squeeze Back Modifiers [E7] Checksum Message Checksum M-2100->AUTO [04} ACK Acknowledge to message Next. First send a keyer modification message for a linear self key with a video fill. [02] STX [8A] Byte Count [01] CMD [88] Byte Count [0A] KEY_MOD [01] <keyer> [03] <key mod> Start of Message Message Byte Count Classification of commands to follow Message Byte Count Key Modifier Command Keyer Number Keyer Modification [00] <squeeze back> Squeeze Back Modifiers 22 M-2100 Automation Interface Protocol Manual .Section 1 — Automation Message Protocol AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [01] TX_NEXT [02] <next trans> [F6] Checksum M-2100->AUTO [04] ACK Acknowledge to message Finally. start the transition AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [02] TX_START [02] <trigger mod> [F5] Checksum M-2100->AUTO [04] ACK Acknowledge to message We could also do all of the above commands in two messages by using the multiple command facility of the automation protocol. Protocol Examples [0B] KEY_ENABLE [01] <keyer> [01] TX_NEXT [02] <next trans> [D0] Checksum Enable Keyer Command Keyer Number Transition Type Command Transition Type Selection M-2100->AUTO [04] ACK Acknowledge to message AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [02] TX_START [02] <trigger mod> [F5] Checksum Start of Message Message Byte Count Classification of commands to follow Message Byte Count Transition Start Command Transition Start Selection M-2100->AUTO [04] ACK M-2100 Automation Interface Protocol Manual 23 . The example below assumes a Key only transition. It is important to execute this command before querying KEY_ENABLE status because the KEY_ENABLE status indicates which Keyers will be on-air after the next transition.Section 1 — Automation Message Protocol Example 7 The following example demonstrates how to determine which keys are onair and then take them off-air. AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [01] TX_NEXT [02] <next trans> 24 M-2100 Automation Interface Protocol Manual . First get key status: AUTO->M-2100 [02] STX [83] Byte Count [02] QUERY [81] Byte Count [0C] KEY_STAT [EE] Checksum Start of Message Message Byte Count Classification of queries to follow Message Byte Count Key Status Query Message Checksum M-2100->AUTO [02] STX [00] Byte Count 0 [05] Byte Count 1 [03] STATUS [00] Byte Count 0 [02] Byte Count 1 [0C] KEY_STAT [03] <status> [E7] Checksum Message Byte Count MSB Message Byte Count LSB Classification of Status to follow Message Byte Count MSB Message Byte Count LSB Key Status Reply Key Status Message Checksum Next set transition type to Key or Key/Background. We will assume that Keyer number 1 and 2 are on-air. (0x08) This is because after the transition we want only Keyer 4 on-air. so the value we put into the <keyer> field is not Keyer Number 1. 2. Remember that we are enabling Keyer 4 because it was already enabled. We do this so that we don't disable a key that is supposed to go on-air at the next transition. A simple boolean expression gives us the value to put in the <keyer> field: Let x = value to put in KEY_ENABLE command Let y = value returned in KEY_ENABLE status message above Let z = value returned in KEY_STAT status message above x = (NOT z) AND y M-2100 Automation Interface Protocol Manual 25 . AUTO->M-2100 [02] STX [83] Byte Count [02] QUERY [81] Byte Count [0B] KEY_ENABLE [EF] Checksum M-2100->AUTO [02] STX [00] Byte Count 0 [05] Byte Count 1 [03] STATUS [00] Byte Count 0 [02] Byte Count 1 [0B] KEY_ENABLE [0B] <keyer> [E0] Checksum Message Byte Count MSB Message Byte Count LSB Classification of Status to follow Message Byte Count MSB Message Byte Count LSB Key Status Reply Keyer Message Checksum Start of Message Message Byte Count Classification of queries to follow Message Byte Count Key Enable Query Message Checksum Next we enable Keyers 1. We will assume that Keyer number 4 is enabled to go on-air at the next transition. and 4. The KEY_ENABLE command tells the switcher what state the Keyers should be after the next transition.Protocol Examples [F6] Checksum M-2100->AUTO [04] ACK Acknowledge to message Next determine which keys are enabled. 2 & 4 (0x0B) but rather Keyer 4. There can be a race condition with the TX_NEXT command that will toggle the key transition off. and if it is not set to Key.Section 1 — Automation Message Protocol So for our example the expression is: x = (NOT 0x03) AND 0x0B => x = 0xfC AND 0x0B => x = 0x08 Note Ensure that the TX_NEXT command above and the following command are sent in different video fields. start the transition AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [02] TX_START [02] <trigger mod> [F5] Checksum M-2100->AUTO [04] ACK Acknowledge to message 26 M-2100 Automation Interface Protocol Manual .This is because the KEY_ENABLE command checks the state of the Next Transition. AUTO->M-2100 [02] STX [84] Byte Count [01] CMD [82] Byte Count [0B] KEY_ENABLE [08] <keyer> [E6] Checksum M-2100->AUTO [04] ACK Acknowledge to message Finally. then it toggles the button state. Bus Select MSB Bus Select LSB (PGM bus selected) Break away to crosspoint 3 No change to the Audio Only crosspoints.Protocol Examples Example 8 The following is an example of a a video breakaway to crosspoint 3 on the Program bus. AUTO->M2100 [02] STX [88] Byte Count [01] CMD [86] Byte Count [07] BREAK_AWAY [01] <type> [00] <bus> [01] <bus> [03] <xpt> [00] <only> [E5] Checksum Start of message Message byte count Classification Command to follow Message byte count Break Away command Break Away type video. M2100->AUTO [04] ACK M-2100 Automation Interface Protocol Manual 27 . Bus Select MSB Bus Select LSB (PST bus selected) Break away to crosspoint 9 No change to the Audio Only crosspoints. AUTO->M2100 [02] STX [88] Byte Count [01] CMD [86] Byte Count [07] BREAK_AWAY [02] <type> [00] <bus> [02] <bus> [09] <xpt> [00] <only> [DD] Checksum Start of message Message byte count Classification Command to follow Message byte count Break Away command Break Away type audio.Section 1 — Automation Message Protocol Example 9 The following is an example of an audio breakaway to crosspoint 9 on the Preset bus. M2100->AUTO [04] ACK 28 M-2100 Automation Interface Protocol Manual . M-2100 Automation Interface Protocol Manual 29 . and Query status. Table 4. Status returned to Automation from the M–2100 in response to a Subscription command. Requests sent from Automation to the M–2100. The Master Control System Message protocol is defined in Section 1. Execute Takes and other transitions. Command Summary Table 4 shows the mnemonic and value for the various Command classes.Section 2 Automation System Protocol Commands Introduction The Automation Protocol allows an external controller to exercise control over the M–2100 in a variety of ways. Status returned to Automation from the M–2100 in response to a Query. including errors. This section describes the transmit and receive message formats. Command Classes Mnemonic CMD QUERY STATUS SUBSCRIPTION Value 0x01 0x02 0x03 0X04 Description Commands sent from Automation to the M–2100. You can: • • • Set parameters normally set by operator using the manual control panels or system configuration. as well as whether the feature is supported for commands and/or queries and whether the command is deterministic. Table 5.Section 2 — Automation System Protocol Commands Table 5 shows the mnemonic and value for various subcommands. Summary of Subcommands Mnemonic TX_NEXT TX_START TX_TYPE TX_RATE TX_STAT TX_STAT2 XPT_TAKE BREAK_AWAY OVER_SELECT OVER_RATIO KEY_MOD KEY_ENABLE KEY_STAT AUTO_STAT ALL_STOP PREROLL CONFIG_PREROLL REMAINING_TIME SYSTEM_STAT SYSTEM_CONFIG XPT_AUDIO_MODE SUBSCRIBE GPI WIPE_SEL ERROR_STAT PROTO_VER M2100_VER SUBSCR_PRETRANS SUBSCR_HOLD Value 0x01 0x02 0x03 0x04 0x05 0x15 0x06 0x07 0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F 0x10 0x11 0x12 0x13 0x14 0x16 0x17 0x18 0X20 0X21 0X22 0x01 0x02 Cmd yes yes yes yes no no yes yes yes yes yes yes no no yes yes yes yes no no yes yes yes yes no no no no no Query yes no yes yes yes yes yes yes yes yes yes yes yes yes no yes no no yes yes yes yes yes yes yes yes yes no no Deterministic yes yes yes yes no no yes yes yes yes yes yes no no yes yes yes yes no no yes yes yes yes no no no no no Next Transition Start Transition Selects Transition Type Selects Transition Rate Transition Status Transition Status Take Crosspoint Break away Audio over Select Audio over to Main Ratio Key Modifier Key Enable Key Status Automation Enable Status Stop on going transition Current Preroll Time Configuration Preroll Time Remaining Time Display System Status System Configuration Crosspoint Audio Mode Subscription Service Set/Clear GPI button Select Wipe Patterns Error Status for previous message Protocol / Version M2100/FCM Version Preroll/Transition Button Press/Release Events Hold Button Press/Release Events Description 30 M-2100 Automation Interface Protocol Manual . Either 2. while allowing the automation to override those requirements when it is providing its own machine control. Either bit 0. or both must be selected. and the MCP is in an Audio Only state. .If a protocol request for Key Only is received.If commands TX_NEXT and KEY_ENABLE are sent in the same field. bit 0. <next trans> Next Transition (unsigned byte) bit 0 Background1 field information: bit 1 Key1 bit 2-7 Reserved TX_START — Start Transition value: command format: query format: reply format: notes: 0x02 (unsigned byte) TX_START <trigger mod> illegal none The inhibit start relays and zero preroll bits provide the means to allow inputs to be configured to reflect the reality of their machine control and preroll requirements. bit 1. bit 1.Command Formats Command Formats TX_NEXT — Next Transition value: command format: query format: reply format: notes: 0x01 (unsigned byte) TX_NEXT <next trans> TX_NEXT TX_NEXT <next trans> . the KEY_ENABLE command must be sent first.) field information: 1. it will be forced to a Married state prior to honoring the Key Only request. or both must be selected. M-2100 Automation Interface Protocol Manual 31 . <trigger mod> Trigger Modifier (unsigned byte) bit 0 bit 1 bit 2 bit 3 bit 4-7 Start video2 Start audio2 Inhibit Start Relays Zero Preroll reserved (No start relays are closed.) (Zero preroll time is assumed. Fast). the remembered Rate is recalled (Slow.If a new Transition Type is selected by either the MCP or the Automation system.No Rate currently selected.Command: rate type = 0 indicates that the rate value is to be used. Medium.Replies: returns the rate type and rate value for the next transition. When automation selects a <rate type> = (Rate) and supplies a value. 01 Slow 02 Medium 03 Fast 04 No Rate (For replies only . . Fast).If a Rate is selected on the MCP. TX_RATE — Select Transition Rate value: command format: query format: reply format: notes: 0x04 (unsigned byte) TX_RATE <rate type> <rate> TX_RATE TX_RATE <rate type> <rate> . When automation selects a <rate type> (Slow. Whenever that Transition Type is again selected. <tran> Transition Type (unsigned byte) 01 Take 02 Fade-Fade 03 Take-Fade 04 Mix 05 Fade-Take 06 Wipe Notes: 1. then send the Rate. . .) <rate> Transition Rate (unsigned two bytes) 00 through 65535 frames field information: 32 M-2100 Automation Interface Protocol Manual . it is remembered. If a transition type has been configured as a custom transition. Therefore the automation system must first send the desired Transition Type. the transition will execute as a custom transition. A Wipe transition selection requires that the Software Authorization Module enable Wipes. the value will not be remembered for the current Transition Type. Medium. MCP Rate buttons will tally off. .” the Rate field will override any currently selected rate on the MCP. any previously specified protocol rate will be overridden by the rate associated with the selected Transition Type.If <rate_type> = “Rate.Section 2 — Automation System Protocol Commands TX_TYPE — Select Transition Type value: command format: query format: reply format: notes: field information: 0x03 (unsigned byte) TX_TYPE <tran> TX_TYPE TX_TYPE <tran> Select the Transition Type for the next transition. however the Rate Value will be displayed. it is “remembered” as associated with the currently selected (non-Cut Transition Type. <rate type> Rate Type (unsigned byte) 00 Rate rate value to be used. <video> Transition Video Status (unsigned byte) 01 Quiescent 02 Preroll 03 Transitional 04 Fading To Black 05 Fading From Black 06 In Black <ap1-4> Transition Audio Status (unsigned byte) 01 Quiescent 02 Preroll 03 Transitional 04 Fading To Silent 05 Fading From Silent 06 In Silent <hold> Hold On/Off Status (unsigned byte) 00 OFF 01 ON M-2100 Automation Interface Protocol Manual 33 .Command Formats TX_STAT — Transition Status value: command format: query format: reply format: notes: field information: 0x05 (unsigned byte) illegal TX_STAT TX_STAT <video> <ap1> <ap2> <ap3> <ap4> <hold> Status of transition at the time this query was received. Section 2 — Automation System Protocol Commands TX_STAT2 — Transition Status value: command format: query format: reply format: notes: field information: 0x15 (unsigned byte) illegal TX_STAT TX_STAT <video> <keyer> <ap1> <ap2> <ap3> <ap4> <hold> Status of transition at the time this query was received. <video> Transition Video Status (unsigned byte) 01 Quiescent 02 Preroll 03 Transitional 04 Fading To Black 05 Fading From Black 06 In Black <keyer> Keyer 1-4 Summary Status (unsigned byte) 01 Quiescent 02 Preroll 03 Transitional 04 Fading To Black 05 Fading From Black 06 In Black <ap1-4> Transition Audio Status (unsigned byte) 01 Quiescent 02 Preroll 03 Transitional 04 Fading To Silent 05 Fading From Silent 06 In Silent <hold> Hold On/Off Status (unsigned byte) 00 OFF 01 ON 34 M-2100 Automation Interface Protocol Manual . 0x0A) which will indicate that the command request could not be executed. In this case. but not both. 2. For a Program Bus or Preset Bus Take: If no Audio Processor bits are set the operation will be an audio/video breakaway. only the video will be switched. 0x06) are not allowed when a transition is in progress. No buses selected is an invalid condition. Only one bus may be selected for the query format of this field. The crosspoint Take command will clear any overs that may be selected. 2.16 Crosspoint number <only> Audio Only Crosspoint (unsigned byte)2 00 No Change 01 Audio Only 1 02 Audio Only 2 03 Audio Only 3 04 Audio Only 4 Notes: 1.Command Formats XPT_TAKE — Crosspoint Take value: command format: query format: reply format: notes: field information: 0x06 (unsigned byte) XPT_TAKE <bus> <xpt> <only> XPT_TAKE <bus> XPT_TAKE <bus> <xpt> <only> Audio onlies are not used for the AUX buses. For a Program Bus or Preset Bus Take: If Audio Processor 1 and any other audio processor bits are set. For a Program Bus or Preset Bus Take: If Audio Processor 1 is not selected. 6. the hot cut will not be executed through the FCM although an ACK will be returned to the requesting automation system. Hot cuts (XPT–Take. An Aux Bus Take does not require any of the Audio Processor bits to be set. If a transition is in progress when it is time for a hot cut to be executed. 5. This delegation may be used by the 1. any or all of Audio Processors 2 — 4 can be selected and will switch also. 3. then the audio processor whose bits are set will be delegated. For a Program Bus or Preset Bus Take: If Audio Processor 1 is selected. only the designated Audio Processor will switch. An error will be generated (OTHER–ERR. One or more buses must be selected for the command format of this field. 4. only one of Audio Processors 2 — 4 can be selected. Select a crosspoint from <xpt> or <only>. M-2100 Automation Interface Protocol Manual 35 . <bus> Bus Select (unsigned two bytes)1 bit 0 Program Bus bit 1 Preset Bus bit 2 Audio Processor 1 bit 3 Audio Processor 2 bit 4 Audio Processor 3 bit 5 Audio Processor 4 bit 6 Aux 1 Bus bit 7 Aux 2 Bus bit 8 Aux 3 Bus bit 9 Aux 4 Bus bit10-15 Reserved <xpt> Crosspoint (unsigned byte)2 00 No Change 01 . No buses selected is an invalid condition. but not both. 36 M-2100 Automation Interface Protocol Manual .Section 2 — Automation System Protocol Commands BREAK_AWAY command. Select a crosspoint from <xpt> or <only>. all audio processors delegated by an immediately previous XPT_TAKE command will be affected.16 Crosspoint number <only> Audio Only Crosspoint (unsigned byte)2 00 No Change 01 Audio Only 1 02 Audio Only 2 03 Audio Only 3 04 Audio Only 4 Note: For an Audio Breakaway. Clears any overs that may be selected. then no change in delegation will occur. 1. BREAK_AWAY — Break Away value: command format: query format: reply format: notes: field information: 0x07 (unsigned byte) BREAK_AWAY <type> <bus> <xpt> <only> BREAK_AWAY <type> <bus> BREAK_AWAY <type> <bus> <xpt> <only> Breaks away (Takes) audio from video. One or more buses must be selected for the command format of this field. If Audio Processor 1 is not set. or video from audio. Audio Processor 1 will always be affected. 2. <type> Break Away Type (unsigned byte) 01 Video 02 Audio <bus> Bus Select (unsigned two bytes)1 bit 0 Program Bus bit 1 Preset Bus bit 2-15 Reserved <xpt> Crosspoint (unsigned byte)2 00 No Change 01 . Only one bus may be selected for the query format of this field. only one of Audio Processors 2 – 4 can be selected. it should be issued after these commands to prevent the clearing of Audio Over selections. Only one bus may be selected for the query format of this field. OVER_RATIO — Audio Over to Main Ratio value: command format: query format: reply format: notes: field information: 0x09 (unsigned byte) OVER_RATIO <bus> <ratio> OVER_RATIO <bus> OVER_RATIO <bus> <ratio> This command will set the Over Ratio for any or all of Audio Processors 1 – 4 indicated. If Audio Processor 1 is selected. At least one of the Audio Processor 1 – Audio Processor 4 bits must be set 2. In this case. No buses selected is an invalid condition. any or all of Audio Processors 2 – 4 can be selected and will also switch. only the designated audio processor will switch. One or more buses must be selected for the command format of this field.Command Formats OVER_SELECT — Audio Over Select value: command format: query format: reply format: notes: 0x08 (unsigned byte) OVER_SELECT <bus> <over> OVER_SELECT <bus> OVER_SELECT <bus> <over> If this command is to be used in conjunction with the XPT_TAKE or BREAK_AWAY commands. <bus> Bus Select (unsigned two bytes)1 bit 0 Program Bus bit 1 Preset Bus bit 2 Audio Processor 1 bit 3 Audio Processor 2 bit 4 Audio Processor 3 bit 5 Audio Processor 4 bit 6-15 Reserved <over> Over Select (unsigned byte) 00 Clear overs on selected bus or buses 01 Over 1 02 Over 2 03 Over 3 04 Over 4 field information: Notes: 1. 3. M-2100 Automation Interface Protocol Manual 37 . If Audio Processor 1 is not selected. <bus> Bus Select (unsigned two bytes)1 bit 0 Program Bus bit 1 Preset Bus bit 2 Audio Processor 1 bit 3 Audio Processor 2 bit 4 Audio Processor 3 bit 5 Audio Processor 4 bit 6-15 Reserved <ratio> Ratio (one byte unsigned) 1. 2. and 50 is an equal mix of both. .) . The squeeze back field has no effect when the squeeze back bit in the keyer field is equal to zero. but does not “Select” it as you do on the MCP. (All existing Keyers will be processed correctly. Only valid when squeeze back bit is set in the keyer field. Only one keyer may be selected for the query exclusive. <keyer> Keyer Select (unsigned byte)1 Bit 0 Keyer 1 Bit 1 Keyer 2 Bit 2 Keyer 3 Bit 3 Keyer 4 Bit 4 SqueezeBack Bit 5-7 Reserved <key mod> Key Modifier (unsigned byte) bit 0 0 = Self 1 = External bit 1 0 = Matte 1 = Video bit 2 bit 3 bit 4 Border2 Shadow2 0 = Linear 1 = Luminance Bit 5-7 Reserved <squeeze back> SqueezeBack Position (unsigned byte)3 00 No change 01 Squeeze to upper right 02 Squeeze to upper left 1. . .An error condition will be generated if: an attempt is made to set Key Border or Shadow. KEY_MOD — Key Modifier value: command format: query format: reply format: notes: 0x0A (unsigned byte) KEY_MOD <keyer> <key mod> <squeeze back> KEY_MOD <keyer> KEY_MOD <keyer> <key mod> <squeeze back> .An error condition will be generated if: an attempt is made to modify the SqueezeBack pattern.Selects the characteristics for the requested key(s). and the SqueezeBack feature has not been enabled by the Software Authorization Module.An error condition will be generated if: an attempt is made to set both Key Border and Shadow .Section 2 — Automation System Protocol Commands 0 through 100. No keyers selected is an invalid condition.An error condition will be generated if: “Keyer Select” bits are set for non-existent Keyers. where 0 is full PGM. and Borders feature has not been enabled by the Software Authorization Module.neither will be set. 38 M-2100 Automation Interface Protocol Manual . 100 is full OVER. .The “Keyer Select” parameter selects a key for modification. only one may be set at a time. format of this field. Mutually 3. One field information: or more keyers must be selected for the command format of this field. Command Formats 03 04 Squeeze to lower right Squeeze to lower left KEY_ENABLE — Key Enable value: command format: query format: reply format: notes: 0x0B (unsigned byte) KEY_ENABLE <keyer> KEY_ENABLE KEY_ENABLE <keyer> . .Selecting a Keyer (bit=1) for a currently off-air Keyer will cause that Key to be seen on the PST bus. . .Selecting a Keyer (bit=1) at the next transition will take an off-air key on-air. Use the System Status and System Configuration commands to obtain more information. . Setting (bit=0) has a similar. M-2100 Automation Interface Protocol Manual 39 . or leave an on-air key on-air.See comments in the TX_NEXT command notes concerning interaction with the KEY_ENABLE command. One or more keyers must be selected for the command format of this field. 1 = On air) Bit 1 Keyer 2 Bit 2 Keyer 3 Bit 3 Keyer 4 Bit 4 SqueezeBack Bit 5-7 Reserved 1.An error condition will be generated if: an attempt is made to enable a Key that is not physically present. but SqueezeBack is not enabled by the Software Authorization Module.Selects the keyers and/or SqueezeBack to be on or off air after the next transition. <keyer> Keyer Select (unsigned byte)1 Bit 0 Keyer 1 Bit 1 Keyer 2 Bit 2 Keyer 3 Bit 3 Keyer 4 Bit 4 SqueezeBack Bit 5-7 Reserved field information: KEY_STAT — Key Status value: command format: query format: reply format: notes: field information: 0x0C (unsigned byte) illegal KEY_STAT KEY_STAT <status> Status for Keyers that are not physically present will be reported as off-air. No keyers selected is an invalid condition. . Only one keyer may be selected for the query format of this field. <status> Keyer Status (unsigned byte) Bit 0 Keyer 1 (0 = Off air. but complimentary effect.An error condition will be generated if: SqueezeBack is selected. based on the current PST bus status and current preroll values. Query returns longest effective preroll. commands will be acknowledged. bit 4 Change PGM and all AP’s to crosspoint #1 (normally black) bit 5-7 Reserved PREROLL — Current Preroll Time value: command format: query format: reply format: notes: 0x0F (unsigned byte) PREROLL <preroll> PREROLL PREROLL <preroll> Overrides the preroll of all the sources currently selected on the PST bus for the next transition only. bit 3 All keys are removed. <status> Status (unsigned byte) 00 Disabled 01 Enabled field information: ALL_STOP — All Stop value: command format: query format: reply format: notes: field information: 0x0E (unsigned byte) ALL_STOP <options> illegal none Stops all on-going transitions and resets the system to a known state.Section 2 — Automation System Protocol Commands AUTO_STAT — Automation Enable Status value: command format: query format: reply format: notes: 0x0D (unsigned byte) illegal AUTO_STAT AUTO_STAT <status> By default – if the manual control panel is not present the automation status is enabled. but not executed. <options> All-Stop Options (unsigned byte) bit 0 Background and key transition is stopped bit 1 Reserved bit 2 The transition mode is set to background. Queries sent to the M-2100 when the interface is disabled will still be honored. When the Automation Interface is disabled. <preroll> Preroll value (unsigned two bytes) 0 through 65535 frames field information: 40 M-2100 Automation Interface Protocol Manual . <xpt> Crosspoint (unsigned byte) 00 No Change 01 . This command does not effect the Master Preroll Time kept in the host computer’s system configuration. The new preroll stays in effect until changed by downloading a new system configuration.16 Crosspoint number 255 Select all sources <only> Audio Only Select (unsigned byte) 00 No Change 01 Audio Only 1 02 Audio Only 2 03 Audio Only 3 04 Audio Only 4 255 Select all Onlies <keyer> Keyer Select (unsigned byte) Bit 0 Keyer 1 Bit 1 Keyer 2 Bit 2 Keyer 3 Bit 3 Keyer 4 Bit 4 SqueezeBack Bit 5-7 Reserved <preroll> Preroll value (unsigned two bytes) 00 through 65535 frames field information: M-2100 Automation Interface Protocol Manual 41 .Command Formats CONFIG_PREROLL — Configuration Preroll Time value: command format: query format: reply format: notes: 0x10 (unsigned byte) CONFIG_PREROLL <xpt> <only> <keyer> <preroll> illegal none Sets the configured preroll of the selected sources. or another Configuration Preroll Time command is issued. =1 non-functional. the time can be commanded to begin decrementing. bit 4 Audio Processor 1 =0 okay or not installed. if a bit is zero. <status> System Status (unsigned two bytes) bit 0 FCM Power =0 okay. bit 3 Mixer Module =0 okay or not installed.Frame bit 4-7 Tens digit . 42 M-2100 Automation Interface Protocol Manual .Hour bit 4-6 Tens digit . This is done so the entire <status> can be tested against zero to determine if anything is not functioning.Second Byte 4 bit 0-3 Ones digit .Frame Note: If the most significant bit of the hour Ten’s digit is set (bit 7 of Byte 1). Optionally.Second bit 4-7 Tens digit . the displayed remaining time will begin decrementing.Minute bit 4-7 Tens digit . bit 1 Reserved bit 2 Crosspoint Module =0 okay or not installed.Hour bit 7 Decrement remaining time display Byte 2 bit 0-3 Ones digit . SYSTEM_STAT — System Status value: command format: query format: reply format: notes: field information 0x12 (unsigned byte) illegal SYSTEM_STAT SYSTEM_STAT <status> In general. =1 non-functional. =1 non-functional.Section 2 — Automation System Protocol Commands REMAINING_TIME — Remaining Time Display value: command format: query format: reply format: notes: field information: 0x11 (unsigned byte) REMAINING_TIME <remaining time> illegal none This command jams the Remaining Time display on the MCP. it indicates an “okay” condition.Minute Byte 3 bit 0-3 Ones digit . =1 One of two is non-functional. <remaining time> Remaining Time (unsigned four bytes in BCD format) Byte 1 bit 0-3 Ones digit . bit 6 Audio Processor 3 =0 okay or not installed. =1 present. bit 10 Keyer 3 =0 okay or not installed. =1 software authorized. bit 3 Audio Processor 3 =0 non-functional or not present.Command Formats bit 5 Audio Processor 2 =0 okay or not installed. =1 non-functional. =1 non-functional. bit 2 Audio Processor 2 =0 non-functional or not present. =1 present. =1 present. =1 non-functional. bit 4 Audio Processor 4 =0 non-functional or not present. bit 6 Wipe Transition =0 not software authorized. bit 11 Keyer 4 =0 okay or not installed. bit 9 Keyer 2 =0 okay or not installed. bit 12-15 Reserved SYSTEM_CONFIG — System Configuration value: command format: query format: reply format: notes: field information 0x13 (unsigned byte) illegal SYSTEM_CONFIG SYSTEM_CONFIG <config> none <config> Configuration (unsigned three bytes) bit 0 Reserved bit 1 Audio Processor 1 =0 non-functional or not present. bit 8 Keyer 1 =0 okay or not installed. =1 non-functional. M-2100 Automation Interface Protocol Manual 43 . =1 non-functional. =1 non-functional. =1 present. bit 7 Audio Processor 4 =0 okay or not installed. bit 5 SqueezeBack =0 not software authorized. =1 non-functional. =1 Enabled. bit 19-23 reserved 44 M-2100 Automation Interface Protocol Manual . = 01 chroma = 10 Luminance/linear key borders. software authorized. =1 software authorized. not software authorized. bit10-11 Keyer 2 = 00 non-functional or not present. =1 Enabled. = 01 chroma = 10 Luminance/linear key borders. software authorized. Embedded Audio Processing =0 not software authorized. = 11 Luminance/linear key borders. bit12-13 Keyer 3 = 00 non-functional or not present. software authorized. = 01 chroma = 10 Luminance/linear key borders. = 11 Luminance/linear key borders. bit 18 Audio Processor 4 Over Configuration =0 Disabled.Section 2 — Automation System Protocol Commands =1 software authorized. software authorized. not software authorized. chroma Luminance/linear key borders. = 11 Luminance/linear key borders. not software authorized. bit 17 Audio Processor 3 Over Configuration =0 Disabled. bit 16 Audio Processor 2 Over Configuration =0 Disabled. =1 Enabled. bit 8-9 Keyer 1 = 00 non-functional or not present. not software authorized. = 11 Luminance/linear key borders. bit 7 bit14-15 Keyer 4 = 00 = 01 = 10 non-functional or not present. if changed. using the same rules that the operator of the MCP panel sees. is restored. 1: If an over is selected on the bus. application of this command for either phase normal or phase reverse will result in the right channel being set to phase normal and the left channel set as indicated. The command is effective on all indicated APs. Note 3: Although this command is applied to AP(s) on one or more buses. the original settings will be restored. the settings present on the PGM bus are reasserted. Note 2: Phase reversal is applied to the left channel. None selected is an invalid condition. However. A PST source selection always picks up the last settings of this source the last time it was on air. which can be inverted or set to normal. Thus if a change is made to a PST source and the source is reselected.g. In addition. Note 1: One or more buses must be selected.Command Formats XPT_AUDIO_MODE — Crosspoint Audio Mode value: command format: query format: reply format: notes: field information: 0x14 (unsigned byte) XPT_AUDIO_MODE <bus> <mode> <phase> XPT_AUDIO_MODE <bus> XPT_AUDIO_MODE <bus> <mode> <phase> This command is used to set the audio mode (stereo/mono) and the audio phase reversal for the current crosspoint on the specified bus. if the right channel has been inverted (by action of a MCP operation). the new source will assert its mono-mode/phase setting instead of what might have been previously set for that source. the settings are directed to that source (e. 2: If a change is made to a source on the PGM bus and then the program bus source is changed. The over source will have its mono-mode/phase changed). the settings made belong to the crosspoint source. M-2100 Automation Interface Protocol Manual 45 . AP delegation. 3: If a change is made on a PST bus source and the source is reselected. at least one Audio Processor bus must be selected. <bus> Bus Select (unsigned two bytes) Bit 0 Program Bus Bit 1 Preset Bus Bit 2 Audio Processor 1 Bit 3 Audio Processor 2 Bit 4 Audio Processor 3 Bit 5 Audio Processor 4 Bits 6-15 Reserved <mode> Audio Mode (unsigned byte) 0 No change 1 Stereo 2 Left Mono (Left input channel to left and right output channels) 3 Right Mono (Right input channel to left and right output channels) <phase> Phase Reverse (unsigned byte) 0 No change 1 Set to Normal 2 Set to Phase Reverse (Note 2). if GPI1 is set to “Clear Segment Display” mode. true command has the effect of a GPI button press/release. as specified in the automation command (true/false) and according to GPI mode. and treat the GPI button as on or off. Set/clear operations do not correspond to press/release. a GPI 1. for field <GPI#> 1 or 2 are the legal val ues. false command is a no operation (nop). GPI button operations occur according to the current GPI configuration mode. which clears the Segment display. For example.Section 2 — Automation System Protocol Commands GPI — GPI Button Operation value: command format: query format: reply format: notes: 0x17 (unsigned byte) GPI <GPI#><true|false> GPI <GPI#> GPI <GPI#><true|false> GPI commands set/clear the specified GPI button at the MCP. <GPI#> GPI button bit 0 GPI 1 bit 1 GPI 2 Note: These bits are mutually exclusive. In this example. then the GPI 1. are ignored. That is. Illegal combinations (when both are set or clear. set/clear operations incorporate both button press and release. <true|false> bit 0 true = set false = clear field information: 46 M-2100 Automation Interface Protocol Manual . field information: 03 04 05 Bitfield_err Selection_err Range_err M-2100 Automation Interface Protocol Manual 47 . The checksum computed by the M–2100 did not match the checksum in the message. if 1. Upon receipt of a message. ERROR_STAT — Error Status value: command format: query format: reply format: notes: 0x20 (unsigned byte) illegal ERROR_STAT ERROR_STAT <err code> <cmd class> <sub cmd> <byte position> <data> <arg #> This query should only be issued after a NAK has been received from the M–2100 or the M– 2100 did not perform the desired action. wipe is reversed) Bit 2-7 Reserved <soft value> Soft value (unsigned two bytes) 0-100% Valid only when the soft modifier is selected. Invalid combination of bits selected in a data field. the M–2100 will perform a cursory check to validate it and may uncover other errors when the command is actually processed. Number in data field is out of range. If no errors have occurred since the last message was received by the M–2100. wipe is left-to-right or top -to-bottom.Command Formats WIPE_SEL — Select Wipe Patterns value: command format: query format: reply format: notes: field information: 0x18 (unsigned byte) WIPE_SEL <wipe pattern><wipe mod><soft value> WIPE_SEL WIPE_SEL <wipe pattern><wipe mod><soft value> — <wipe pattern> Wipe pattern (unsigned byte) 10 Horizontal 00 Vertical 04 Bottom left diagonal 14 Top left diagonal <wipe mod> Wipe pattern (unsigned byte) 00 Normal (left-to-right or top-to-bottom and hard not soft) Bit 0 Soft (If 0. <err code> Error Code (unsigned byte) 00 01 02 No_err Checksum_err Command_err No errors have occurred since the last message was received. Invalid or unrecognized Command-Class/ Sub-Command combination. if 1. wipe is soft) Bit 1 Reverse (If 0. an error code of NO_ERR will be returned. wipe is hard. Invalid selection in data field. the <data> field will contain the checksum calculated by the M–2100. <data> Offending data (unsigned 4 bytes) Data that was found to be in error.2. Requested feature is not installed. For a Checksum_Err. Internal processing error. This field will be zero for the No_Err error code. Automation interface currently disabled. 48 M-2100 Automation Interface Protocol Manual . This field will be zero for the No_Err error code. <arg #> Argument number (unsigned byte) Argument or field number where the offending data was found. <sub cmd> Sub-Command (unsigned byte) Byte code found in the Sub-Command position of the message. If the data corresponding to the Command Class and Sub-Command is less than four bytes (as defined in the protocol). <byte position> Byte Position (unsigned 2 bytes) Approximate byte position in the message where the error was found (starting with the first byte after the STX and overall message byte count).Section 2 — Automation System Protocol Commands 06 07 08 09 10 Feature_err Install_err Internal_err Auto_disabled Other_err Requested feature is not implemented or not available. Should be one of the Command Classes from Table 1. <cmd class> Command Class (unsigned byte) Byte code found in the Command Class position of the message. Other unexpected error (not fitting into any of the categories listed above). This field will be zero for the No_Err and Checksum_Err error codes. Should be one of the Sub-Commands from Table 1. This field will be zero for the No_Err and Checksum_Err error codes. the data will be put in the least significant bytes of the 4-byte <data> field.1. <major> (unsigned byte) In the query format of PROTO_VER. The major/minor version is typically expressed in combination such as 2. <minor> (unsigned byte) In the query format of PROTO_VER. The major number is incremented if a change to the protocol or the applications which use the protocol is not backward compatible and will break the operation of either end of the communications line. In the reply format. The M–2100 (tributary) will respond with the version of the protocol that it is using. the minor number is reset to zero. where “2” is the major version and “1” is the minor version. The minor number is incremented if a change to the protocol or the applications which use the protocol is backward compatible and will not break the operation of either end of the communications line. the field indicate the major protocol version that the tributary is using. the field indicate the minor protocol version that the tributary is using.1.Command Formats PROTO_VER — Protocol Version value: command format: query format: reply format: notes: 0x21 (unsigned byte) illegal PROTO_VER <major> <minor> PROTO_VER <major> <minor> This query is provided so the controller of the M–2100 can inform the tributary which version of the M–2100 protocol is being used. field information: M-2100 Automation Interface Protocol Manual 49 . Anytime the major number is incremented. the minor field indicates the minor protocol version that the controller is using. the major field indicates the major protocol version that the controller is using. Incompatible versions between the controller and tributary may yield inconsistent results. In the reply format. The minor number is incremented if a change to the software or the applications which use the software is backward compatible and will not break the operation of either end of the communications line. <major> (unsigned byte) <minor> (unsigned byte) field information: 50 M-2100 Automation Interface Protocol Manual . The major number is incremented if a change to the software or the applications which use the software is not backward compatible and will break the operation of either end of the communications line.Section 2 — Automation System Protocol Commands M2100_VER — FCM Software Version value: command format: query format: reply format: notes: 0x22 (unsigned byte) illegal M2100_VER M2100_VER <major> <minor> This query is provided to identify the software version running on the FCM. Anytime the major number is incremented. the minor number is reset to zero. Hold Button Press/Release Events value: status format: notes: 0x02 (unsigned byte) SUBSCR_HOLD <press/release flag> If this information is currently subscribed-to. it is sent to the Automation Controller when the user presses/releases the MCP’s Hold button. bit 1 Hold Event.Preroll/Transition Button Press/Release Events value: status format: notes: 0x01 (unsigned byte) SUBSCR_PRETRANS <press/release flag> If this information is currently subscribed-to.Command Formats SUBSCRIBE — Subscription Service Refer to Automation Protocol Subscription Service. any subscriber to this event will be notified as described below. it is sent to the Automation Controller when the user presses/releases the MCP’s Preset/Preroll button. Normal Preroll/Transition logic in the frame controller is not executed. Any bit set = 0 will disable subscription to that item. All currently undefined bits should be set = 0. Whenever the user presses or releases Hold. value: command format: query format: reply format: notes: 0x16 (unsigned byte) SUBSCRIBE <subscription bits> SUBSCRIBE SUBSCRIBE <subscription bits> Any bit set = 1 in the <subscription bits> will enable subscription to that item. and Subscription Command Operation on page 52 for detailed information on the subscription commands. bits 2-31 Reserved for future subscription items field information: SUBSCR_PRETRANS . <subscription bits> (unsigned four bytes) bit 0 Preroll/Take Event. Nor mal Hold logic in the frame controller is not executed. <press/release flag> (unsigned byte) 00 Hold Button released 01 Hold Button pressed field information: M-2100 Automation Interface Protocol Manual 51 . Whenever the user presses or releases Preroll Take. <press/release flag> (unsigned byte) 00 Preroll/Trans Button released 01 Preroll/Trans Button pressed field information: SUBSCR_HOLD . any subscriber to this event will be notified as described below. A console command option allows you to select one of the following actions: • • Cancel all subscriptions on FCM reboot. the Controller will be notified (unsolicited) if that system information changes. the Controller will be sent a protocol message whenever the Preroll/Take button is pressed or released. subscription information resumes. Changes or events that occur while Automation is disabled are not queued and are not reported when Automation is re-enabled. Data length will vary as per event definition. Subscriptions to the Preroll/Transition button press event will return data telling the controller when the button is pressed and when it is released. This console command is: > autoSubSvcTempSaveCfgSee [on/off] 52 M-2100 Automation Interface Protocol Manual . For example. subscriptions are temporarily disabled. The Controller can query for the bit field defining all currently subscribedto items. Notification of an event or change of some operational parameter (with data). All subscriptions continue after an FCM reboot. The Controller is responsible for ensuring that every time that command is sent. In general. all such items are identified. • To use this feature you must have a Software Authorization Key attached to the FCM’s console port that is programmed to enable the Subscription Service Software Option. subscription information will come in two forms: • • Notification of an event (no data). When Automation is reenabled.Section 2 — Automation System Protocol Commands Automation Protocol Subscription Service This feature allows automation controllers to subscribe to specific system information. If specific information is subscribed to. If the MCP Channel Control Automation Enable button is disabled (tally = off). • • Subscription Command Operation The Controller can subscribe to any subset of the available subscription items using a single command and a bit field that defines subscription items. if the Controller subscribes to “Preroll/Take” event information. Subscriptions to the Hold button press event will return data telling the controller when the button is pressed and when it is released. If the Controller then sets this attribute to on. The Controller can then ask the FCM for those values.Automation Protocol Subscription Service Setting this attribute “on” results in the temporary saving of Subscription Data that is cleared when the FCM reboots. and Subscription Service Requests are made by the Automation Controller. M-2100 Automation Interface Protocol Manual 53 . Note the following about this command: If this attribute is set off. those subscribed-to items will be permanently saved (in FCM’s NVRAM). and restored on FCM reboot. the new subscription requests will override those saved in NVRAM— but will not persist after the next reboot. and sends new subscription requests. Section 2 — Automation System Protocol Commands 54 M-2100 Automation Interface Protocol Manual . Router linked sources are tallied by using M–2100 input tally to qualify router destinations that feed the M–2100 physical inputs. General Information • • • • The tally data stream is in serial format. Router linked sources receive tally from the linking router. Router linked sources may not be directly tallied. M-2100 Automation Interface Protocol Manual 55 . 2100-TLY-S) that must be installed and enabled. Note This appendix is intended to be used by System Administrators and Thomson Grass Valley Field Service Engineers.Appendix A Tally Expansion Introduction Source tally expansion provides on-air tally of video inputs to the M–2100 A/V/C Processor Frame. This is a software-enabled option (2100-TLY. Refer to Section 4— System Configuration in the M–2100 Installation and Service Manual for complete details. You must enable the Tally Expansion and set the FCM-to-tally expansion system communication link using the controls provided.Appendix A — Tally Expansion Specifications Physical • • • Processor Frame Connection Expansion Control Port (J23) (see Table 6) 9-Pin D Connector Table 6. Expansion Control Port Pin-Out Shielded 9-Pin D. socket contacts Pin 1 D-9 Female Pin 1 Pin 5 Pin 6 Pin 9 2 3 4 5 6 7 8 9 Shield Expansion Port (J23) Frame GND RX– TX+ TX Com Spare RX Com RX+ TX– Frame GND Frame GND Enabling and Setup Parameters Enabling the tally function and setting parameters for communication are set in the General Parameters form in Configuration Manager. 56 M-2100 Automation Interface Protocol Manual . Protocol Version Command Code The version command code (01) signifies the start of the protocol version identifier. Packet Byte 3. and Checksum.0) Packet Byte 4. Value = 02h Packet Byte Count This two-byte value provides a count of the total number of bytes in the packet including the STX. Value = 00h Tally Command Code The Tally command code (02h) signifies the start of the 40 byte Tally Expansion Message. If for some reason the Checksum doesn't compute.Specifications Packet Format Start of Transmission (STX) Packet Byte 1. there will be a MINIMUM of 1. Value = (message dependent) Note After the Checksum Byte.g. simply wait for the next gap in the byte stream to sync up. Value = 01h Protocol Minor Version Number Packet Byte 6. M-2100 Automation Interface Protocol Manual 57 . value will normally be 00h. Value = 02h Checksum This one-byte value is the 2's compliment of the sum of all bytes excluding the STX. value in first release will be 2Ch. Packet Byte 2. Packet Byte 48. the byte count should indicate the end of where the message is.. BC1.400Bp/s) before the next byte is transmitted. 1.3 milliseconds (the equivalent to 5 characters at 38. Typically. Packet Byte 7. BC0. The next two bytes specify the protocol version (e. Value = 01h Protocol Major Version Number Packet Byte 5. 0 = Normal Mode Bit 7. Bypass: 1 = Pgm Output in Bypass Mode. 0 = Key 2 inactive Bit 2. 0 = Key 4 inactive Bit 4. 01h-10h= physical input # Msg Byte 2 Second Video Source (Preset Bus Component) Value = 00h – 10h. Bit Field Bit 0. 0 = Key 1 inactive Bit 1. Key3: 1 = Key3 Active. Data Fields Video PGM Msg Byte 1 Prime Video Source (Pgm Bus Component) Value = 00h – 10h. 0 = Key 3 inactive Bit 3. Key4: 1 = Key4 Active. 00h = matte OR no source.Appendix A — Tally Expansion Command Formats Data Value Limits Valid data values within the Tally Message will be 00h – 7Fh. Key2: 1 = Key2 Active. SqueezeBack: 1 = SqueezeBack Active. Fade-To-Black: 1= Fade to Black active. Key1: 1 = Key1 Active. 00h = matte OR no source. 0 = SqueezeBack inactive Bit 5. 01h-10h= physical input # Msg Byte 3 Backup Pgm Video Source Value = 00h – 10h. Not Assigned: Always clear to 0 58 M-2100 Automation Interface Protocol Manual . 01h-10h= physical input # Msg Byte 4. 0 = Fade to Black inactive Bit 6. 00h = matte source. 01h-10h= physical input # M-2100 Automation Interface Protocol Manual 59 . Squeeze Back: 1 = Squeeze Back Active. Key3: 1 = Key3 Active. 01h-10h= physical input # Msg Byte 8 Bit Field Bit 0. 0 = Key 2 inactive Bit 2. Bypass: 1 = Pgm Output in Bypass Mode. Key4: 1 = Key4 Active. 00h = matte OR no source. 01h-10h= physical input # Msg Byte 6 Second Video Source (Pgm Bus Component) Value =00h – 10h.Command Formats Video PST Msg Byte 5 Prime Video Source (Preset Bus Component) Value = 00h – 10h. 01h-10h= physical input # Msg Byte 7 Backup Pst Video Source Value = 00h – 10h. 00h = matte OR no source. 0 = Key 4 inactive Bit 4. 0 = Normal Mode Bit 7. Key2: 1 = Key2 Active. Fade-To-Black: 1= Fade to Black active. 0 = Key 1 inactive Bit 1. 00h = matte source. 0 = Fade to Black inactive Bit 6. 0 = Squeeze Back inactive Bit 5. Not Assigned: Always clear to 0 Aux 1 Msg Byte 9 Active Aux Bus 1 Source Value = 01h – 10h. Key1: 1 = Key1 Active. 0 = Key 3 inactive Bit 3. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no source 60 M-2100 Automation Interface Protocol Manual . Direct Source Value = 11h-24h Value = 00h indicates silent source Msg Byte 14 Second Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h.Appendix A — Tally Expansion Aux 2 Msg Byte 10 Active Aux Bus 2 Source Value = 01h – 10h. 01h-10h= physical input # Aux 4 Msg Byte 12 Active Aux Bus 3 Source Value = 01h – 10h. 01h-10h= physical input # Aux 3 Msg Byte 11 Active Aux Bus 3 Source Value = 01h – 10h. 01h-10h= physical input # AP1 PGM Msg Byte 13 Prime Audio Source (Audio Pgm Bus Component) Embedded Source Value = 00h – 10h. Command Formats Msg Byte 15 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 16 Backup Pgm Audio Source Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source AP1 PST Msg Byte 17 Prime Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source Msg Byte 18 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 19 Backup Pst Audio Source Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source M-2100 Automation Interface Protocol Manual 61 . Direct Source Value = 11h-24h Value = 00h indicates silent source Msg Byte 21 Second Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source 62 M-2100 Automation Interface Protocol Manual .Appendix A — Tally Expansion AP2 PGM Msg Byte 20 Prime Audio Source (Audio Pgm Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source AP2 PST Msg Byte 24 Prime Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no source Msg Byte 22 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 23 Backup Pgm Audio Source Embedded Source Value = 00h – 10h. Command Formats Msg Byte 25 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 26 Backup Pst Audio Source Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source M-2100 Automation Interface Protocol Manual 63 . Direct Source Value = 10h-30h11h24h Value = 00h indicates silent source Msg Byte 28 Second Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source AP3 PGM Msg Byte 27 Prime Audio Source (Audio Pgm Bus Component) Embedded Source Value = 00h –10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no source Msg Byte 29 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 30 Backup Pgm Audio Source Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source AP4 PGM Msg Byte 34 Prime Audio Source (Audio Pgm Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no source 64 M-2100 Automation Interface Protocol Manual .Appendix A — Tally Expansion AP3 PST Msg Byte 31 Prime Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source Msg Byte 35 Second Audio Source (Audio Pst Bus Component) Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source Msg Byte 32 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 33 Backup Pst Audio Source Embedded Source Value = 00h – 10h. Command Formats Msg Byte 36 Audio Over Source Value = 00h OR 21h-24h Value = 00h indicates no Audio Over source selected Msg Byte 37 Backup Pgm Audio Source Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source M-2100 Automation Interface Protocol Manual 65 . Direct Source Value = 11h-24h Value = 00h indicates silent source Msg Byte 39 Audio Over Source Value = 00h OR 21h-24h Value = 00 h indicates no Audio Over source selected Msg Byte 40 Backup Pst Audio Source Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h Value = 00h indicates silent source OR no Backup Source AP4 PST Msg Byte 38 Prime Audio Source (Audio PgmBus Component) Embedded Source Value = 00h – 10h. Appendix A — Tally Expansion 66 M-2100 Automation Interface Protocol Manual . This feature is enabled/disabled by a vxShell Console command while connected to the Communication port on the inside of the MCP.Appendix B M–2100 MCP Frame Tally Introduction The M–2100 MCP Frame Tally provides a serial protocol interface from the MCP (Manual Control Panel) to an external video relay device for notification of active frame (FCM) status. General Information • • • • Data transfers are serial communication with RS–485 electrical interfaces from the M–2100. When multiple frames are connected to an MCP. Settings are stored in non-volatile memory. M-2100 Automation Interface Protocol Manual 67 . an external relay device can tally which frame is currently active according to information sent by the MCP. The serial port (Aux 1 – 4) used for communication can be chosen using the Console command. and remain after a reboot or power cycle. The control device must be connected to one of the ports and configured to communicate with the serial protocol.Appendix B — M–2100 MCP Frame Tally Installation The MCP Frame Tally feature is accessed through one of the four Aux ports on the rear of the panel. Aux Ports 1 – 4 Analog Reference Input Aux 2 Aux 4 Time Code Outputs Segment Remaining Time Time Power Supply Alarms Dry Contacts Power Supply 2 Power Supply 1 MCP Net Aux1 Aux 3 90-132/175-264 V~ 50/60 Hz 2A Analog Reference Input Aux 2 Aux 4 Time Code Outputs Segment Remaining Time Time Power Supply Alarms Dry Contacts 0116_01 MCP Net Aux 1 Aux 3 Aux Port 1. Note Older version MCPs may only have two Aux ports available. 68 M-2100 Automation Interface Protocol Manual . Note Aux Port 1 is dedicated to the optional Chroma Key Expert Level application and may already be in use. 3. Figure 2.or 4 may be used for MCP Frame Tally Note: Aux 1 is dedicated to Chroma Key Expert Level Control Panel if used. MCP Aux Ports 1 – 4 The MCP Frame Tally is accessible from one of the Aux ports (1 – 4) on the back of the MCP as shown in Figure 2. 2. MCP Rear View. Aux Port 1 – 4 Serial Control Settings Baud Data Bits Parity Stop Bits 9600 bps 8 None 1 M-2100 Automation Interface Protocol Manual 69 . This is an RS-485 serial port and requires an RS-232/RS-485 converter to connect to the control device with a standard RS-232 cable.Installation The pinouts for Aux Port 1 – 4 are given in Table 7. Table 7. socket contacts Pin 1 D-9 Female Pin 1 Pin 5 Pin 6 Pin 9 2 3 4 5 6 7 8 9 Shield MCP Aux 1– 4 Frame GND RX– TX+ TX Com Spare RX Com RX+ TX– Frame GND Frame GND Setup Parameters Connect the control device to the rear of the MCP and set the control parameters to the values listed in Table 8. Table 8. Aux Ports 1 – 4 Pinouts Shielded 9-Pin D. Launch HyperTerminal and set the serial control settings to the values listed in Table 10.Appendix B — M–2100 MCP Frame Tally Enabling the MCP Frame Tally Feature To enable this feature on the MCP. Table 9. MCP Configuration Port Motherboard Configuration Port 1. you will need to connect a PC running HyperTerminal to the MCP motherboard configuration port inside the MCP as shown in Figure 3. Null Modem Cable Pinout (typical) DB-25 8 3 2 20 7 6 4 4 DB-9 1 2 3 4 5 6 7 8 Signal Name DCD TXD RXD DTR GND DSR RTS CTS 2. Serial Control Settings Baud Data Bits Parity Stop Bits Flow Control 9600 8 None 1 None 70 M-2100 Automation Interface Protocol Manual 0109_03 . Figure 3. Table 10. You may purchase a suitable cable or construct one according to the typical pinout given in Table 9. Connect the 9-pin serial port from your PC to the 25-pin Configuration port with a DB-9 female to DB-25 male null modem cable (not provided). and FCM name message (originating at the MCP). enter a –1 (minus one) at the command. An unsolicited message is sent whenever the MCP operator acquires a new FCM making it the active frame or deselects a frame without selecting another. Table 11. 2 would enable the feature at port 2. FCM Frame Name Message Format Name Sync1 Frame Name Requested Value 0xfe 0x20 M-2100 Automation Interface Protocol Manual 71 . 6. The HyperTerminal window displays a prompt asking if you wish to enter the configuration interface. Protocol Definition This protocol has been defined to keep an external relay device informed of the current active frame name acquired by the MCP. 4. 0 Note No check is performed to ensure that the serial port selected doesn’t interfere with any other serial port. A solicited message is sent from the MCP to the external relay device upon receipt of a request from the relay device. enter a 1 (one) and then the desired port number (1 – 4). Type vxShell (instead of y or n) to bring up the vxshell prompt –>. To enable the function. For example typing RtlCfgSee 1. having the format shown in Table 11. the port number can be entered as 0 (zero) as shown below: RtlCfgSee -1.Protocol Definition 3. At the vxShell prompt type the following command with the exact syntax shown here: RtlCfgSee 5. To disable the feature. FCM Name Request This message is two bytes in length. Message Definition There are two messages defined in this protocol: • • FCM name request (originating at the External Relay device). Table 12. Note The batch file RTL. The test is run using a batch file named “RTL. If the output port of the PC is Port 2. The state parameter indicates whether the current name is an active frame. An active (selected) frame has State = 1 and an inactive (deselected) frame has State = 0. Open a DOS window and go to the DOS directory containing the test program. To run the test program perform the following steps: 1. These files are available from the Thomson Grass Valley ftp site.Appendix B — M–2100 MCP Frame Tally FCM Name Message The frame name is represented by fields name0 through name7. (Source code is named RTL_TEST. If the name has fewer than eight characters. A deselected frame has nulls (0x0) for all eight name values. FCM Frame Name Message Format Description Sync1 name0 name1 name2 name3 name4 name5 name6 name7 termination state Sync2 Value 0xfe (data) (data) (data) (data) (data) (data) (data) (data) 0x00 (value) 0xdc DOS Test Program A DOS test program.BAT” and a program named RTL_TEST.EXE.BAT assumes that the PC serial port is COM 1. is available to simulates the MCP Frame Tally feature for purposes of validating the external interface to the M–2100 MCP. written in C language. edit the batch file to include a -P2 option on the program invocation line. which contain ASCII character values. the trailing values contain null (0x0) values.C). 72 M-2100 Automation Interface Protocol Manual . The FCM frame name message formats are given in Table 12. Protocol Definition 2. Run the RTL_TEST.EXE. While running, the program displays all messages transmitted form the M–2100 MCP. To verify, use the M–2100 Channel Control buttons to select/deselect and alter active FCMs. The PC display should show the corresponding message. 3. To send a Frame Name Request from the PC to the MCP, press F1 (or F2 or F3). The PC display indicates that the message was sent. When a reply message is received, message contents are shown on the PC display. M-2100 Automation Interface Protocol Manual 73 Appendix B — M–2100 MCP Frame Tally 74 M-2100 Automation Interface Protocol Manual Index A Automation Determinism Constant 11 Automation Protocol Subscription Service 52 SYSTEM_CONFIG (System Configuration) 43 SYSTEM_STAT — System Status 42 SYSTEM_STAT (System Status) 42 TX_NEXT — Next Transition 31 TX_NEXT (Next Transition) 31 TX_RATE — Selects Transition Rate 32 TX_RATE (Selects Transition Rate) 32 TX_START — Start Transition 31 TX_STAT — Transition Status 33 TX_STAT2 — Transition Status 34 TX_TYPE — Selects Transition Type 32 WIPE_SEL — Select Wipe Patterns 51 XPT_AUDIO_MODE — Crosspoint Audio Mode 45 XPT_TAKE — Crosspoint Take 35 XPT_TAKE (Crosspoint Take) 35 Command Summary command classes 29 list of commands 30 C Command Formats ALL_STOP — All Stop 40 ALL_STOP (All Stop) 40 AUTO_STAT — Automation Enable Status 40 AUTO_STAT (Automation Enable Status) 40 BREAK_AWAY — Break Away 36 BREAK_AWAY (Break Away) 36 CONFIG_PREROLL — Configuration Preroll Time 41 CONFIG_PREROLL (Configuration Preroll Time) 41 ERROR_STAT — Error Status 46 GPI — GPI Button Operation 52 KEY_ENABLE — Key Enable 39 KEY_ENABLE (Key Enable) 39 KEY_MOD (Key Modifier) 38 KEY_STAT — Key Status 39 KEY_STAT (Key Status) 39 M2100_VER — FCM Sotware Version 50 OVER_RATIO — Audio Over to Main Ratio 37 OVER_RATIO (Audio Over to Main Ratio) 37 OVER_SELECT — Audio Over Select 37 OVER_SELECT (Audio Over Select) 37 PREROLL — Current Preroll Time 40 PREROLL (Current Preroll Time) 40 PROTO_VER — Protocol Version 49 REMAINING_TIME — Remaining Time Display 42 REMAINING_TIME (Remaining Time Display) 42 SUBSCR_HOLD - Hold Button Press/Release Events 51 SUBSCR_PRETRANS - Preroll/Transition Button Press/Release Events 51 SUBSCRIBE — Subscription Service 51 SYSTEM_CONFIG — System Configuration 43 D documentation online 2 E Example 28 Example 9 audio breakaway 28 F FAQ database 2 Figure 2-2. TX_START - Transition Delay Constant 15 frequently asked questions 2 G Grass Valley Group website 2 M-2100 Automation Interface Protocol Manual 75 transition to air 21 take keys on/off air 24 video breakaway 27 wipe transition 19 S software download from web 2 Subscription Command Operation 52 W web site documentation 2 web site FAQ database 2 web site Grass Valley Group 2 web site software download 2 76 M-2100 Automation Interface Protocol Manual .Index M Master Control Message Protocol definition 9 format 12 O online documentation 2 P Protocol Examples audio breakaway 28 request transition rate 17 select mix transition 16 select mix transition and rate 18 select wipe transition type and rate 16 setup key. . 071011606 .