M-2100 Automation Interface Protocol Manual

M-2100DIGITAL MASTER CONTROL SYSTEM

Automation Interface Protocol Manual

SOFTWARE VERSION 6.0

071011606JULY 2003

2 M-2100 Automation Interface Protocol Manual

Contacting Grass Valley

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.

Region Voice Fax Address Web Site

North America (800) 547-8949Support: 530-478-4148

Sales: (530) 478-3347Support: (530) 478-3181

Grass ValleyP.O. Box 599000Nevada City, CA 95959-7900 USA

www.thomsongrassvalley.com

Pacific Operations +852-2585-6688Support: 852-2585-6579

+852-2802-2996

U.K., Europe, Asia, Middle East +44 1753 218 777 +44 1753 218 757

France +33 1 45 29 73 00

Germany +49 221 1791 234 +49 221 1791 235

http://www.thomsongrassvalley.com

ContentsPreface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Section 1 — Automation Message Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Automation Control Port Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Enabling/Disabling Automation Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Protocol Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Automation Determinacy Constant Considerations . . . . . . . . . . . . . . . . . . . . . . . . 13

XPT_TAKE and BREAK_AWAY Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13TX_START Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Protocol Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Example 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Example 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Example 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Example 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Example 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Section 2 — Automation System Protocol Commands. . . . . . . . . . . . . . . . 29Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Command Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Command Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

TX_NEXT — Next Transition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31TX_START — Start Transition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31TX_TYPE — Select Transition Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32TX_RATE — Select Transition Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32TX_STAT — Transition Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33TX_STAT2 — Transition Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34XPT_TAKE — Crosspoint Take. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35BREAK_AWAY — Break Away . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36OVER_SELECT — Audio Over Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37OVER_RATIO — Audio Over to Main Ratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37KEY_MOD — Key Modifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38KEY_ENABLE — Key Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39KEY_STAT — Key Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39AUTO_STAT — Automation Enable Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40ALL_STOP — All Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40PREROLL — Current Preroll Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

M-2100 Automation Interface Protocol Manual 3

Contents

CONFIG_PREROLL — Configuration Preroll Time . . . . . . . . . . . . . . . . . . . . . . 41REMAINING_TIME — Remaining Time Display. . . . . . . . . . . . . . . . . . . . . . . . 42SYSTEM_STAT — System Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42SYSTEM_CONFIG — System Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43XPT_AUDIO_MODE — Crosspoint Audio Mode . . . . . . . . . . . . . . . . . . . . . . . 45GPI — GPI Button Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46WIPE_SEL — Select Wipe Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47ERROR_STAT — Error Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47PROTO_VER — Protocol Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49M2100_VER — FCM Software Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50SUBSCRIBE — Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51SUBSCR_PRETRANS - Preroll/Transition Button Press/Release Events . . . . 51SUBSCR_HOLD - Hold Button Press/Release Events . . . . . . . . . . . . . . . . . . . . 51

Automation Protocol Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Subscription Command Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Appendix A — Tally Expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Physical. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Enabling and Setup Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Packet Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Packet Byte Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Protocol Version Command Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Tally Command Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Checksum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Command Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Data Value Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Data Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Video PST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Aux 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Aux 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Aux 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Aux 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60AP1 PGM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60AP1 PST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61AP2 PGM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62AP2 PST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62AP3 PGM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63AP3 PST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64AP4 PGM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64AP4 PST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Appendix B — M–2100 MCP Frame Tally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

MCP Aux Ports 1 – 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Setup Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Enabling the MCP Frame Tally Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Protocol Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71


Contents

Message Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71FCM Name Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71FCM Name Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

DOS Test Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75


Contents


Preface

About This ManualThis manual describes the automation protocol for externally controlling an M–2100 Master Control Switcher. The system message protocol and pro-tocol commands are described in this reference document as well as instructions for connecting an external device to the processor frame. Appendices are provided for Expansion and MCP Frame Tally function-ality.


Preface


Section 1Automation Message Protocol

IntroductionThis section describes the Master Control protocol standard for the M-2100 Digital Master Control product. The Master Control Message Protocol defines the low-level format of messages passed to/from the Master Control system.

Commands for controlling the M–2100 automation interface are given in Section 2 of this manual. Refer to the M–2100 User Manual for more infor-mation on the operational functions that the protocol commands execute.

General InformationThe 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.

• Commands with bit fields allow more than one option to be selected.

• All numbers are in decimal, except for hexadecimal numbers which have a 0x prefix (for example, 0x12 hex = 18 dec).

• Automation commands will override any inconsistent setting on the MCP. For example: If Next Transition Key Only is requested, the MCP cannot be in Audio Only mode. The MCP will be forced to Married mode.

• If MCP buttons are being pressed when automation commands are received, the result will be the commands that are received first. How-ever, hot cuts from the control panel will not be accepted during auto-mation-triggered transitions and will respond with a panel beep. Hot cuts from automation will not be accepted during MCP triggered or automation transitions.

• If protocol commands are received that contain errors, the commands will still be processed and executed to the extent possible. The M–2100 can be queried to help find the error.


Section 1 — Automation Message Protocol

Automation Control Port ConnectionCommunication between an automation system and the M–2100 is accom-plished 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. The cable pinout (cable not provided) for J21 is given in Table 1. Transfer rates between 38.4k bps to 115.2k bps are supported on this RS-422 serial port.

The default settings for the serial connection are given in Table 2.

Parameters for the FCM-to-automation serial communication link are set in the General Parameters form of the M–2100 Configuration Manager appli-cation. Refer to the System Configuration section of the M-2100 Installation and Service Manual for details on setting the automation control.

Enabling/Disabling Automation ControlFor systems with no Manual Control Panel (MCP), the automation status is enabled by default. Automation status may be queried with the AUTO–STAT command (AUTO_STAT — Automation Enable Status on page 40). Automation may be enabled from the FCM Console port using the vxShell command, automEnableCfgSee (on/off).

For single channel systems with an MCP, the GPI buttons, GPI 1 and GPI 2, on the panel can be programmed to enable or disable automation.

Table 1. Automation Control Connector J21 Pinout

Shielded 9-Pin D; socket contacts Pin

Automation Control (J21)

1 Frame GND

2 TX–

3 RX+

4 RX Com

5 Spare

6 TX Com

7 TX+

8 RX–

9 Frame GND

Shield Frame GND

Table 2. Automation Port Serial Control Settings

Baud 38.4k bps

Data Bits 8

Parity None

Stop Bits 1

D-9 Female

Pin 1

Pin 6

Pin 9Pin

5


Protocol Format

To activate these buttons for automation control, 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, the GPI buttons are not programmable for this function.

For multiple channel systems with an MCP, automation is enabled and dis-abled with Auto Enable 1 – 4 buttons on the Channel Control multichannel subpanel option.

Protocol FormatThe protocol is based on the SMPTE standard with the following modifica-tions:

• Messages larger than 256 bytes are now allowed.

• Message synchronization is accomplished by a delay in the stream of bytes sent to the M–2100, instead of a break/address sequence. A gap of at least 1.3 milliseconds between successive bytes indicates the start of a new message.

• To guarantee determinism (refer to Automation Determinacy Constant Considerations on page 13), commands must be received by the M–2100 no later than 13 milliseconds into the field. All commands will be per-formed 2 fields after they are received, except for the commands which are affected by the determinacy constance value setting in the configu-ration (see Table 5 on page 30).

• Multiple commands or queries can be formatted into a single message.

• Every message returns an ACK (0x04), NAK (0x05), or the data requested.



An M–2100 protocol message consists of a series of required and optional fields. The Command Class and Sub-Command fields consist of 1 byte. Byte lengths are 2 bytes; data fields are variable lengths. Fields that consist of more than 1 byte are output with the Most Significant Byte (MSB) first.

Note In Table 3 below, items enclosed within < > are required, items enclosed with [] are optional, ... indicates a repeat of the previous item(s).

After the message has been received, the M–2100 will respond with one of three data types:

1. Acknowledge to a command <ACK>.

2. Data in response to a query.

3. Not acknowledge to a message <NAK>.

Table 3. Protocol Format

<stx> <byteLen0> <cmdClass1> <byteLen1> <subCmd1> [cmd1Data] [subCmd2]... [cmdClass2] [byteLen2] [subCmd2]... <checkSum>

stx Start of transmission (1 byte).byteLen0 Byte length of the whole message (1 or 2 bytes)a. Does not include the stx, itself, or the

checksum.

a All byte counts can be encoded as one or two bytes. If the most signiÞcant bit of the Þrst byte is set, then the byte countconsists of only one byte. This encoding allows up to 127 bytes to be represented with a single byte while up to 32,767bytes with two bytes.

cmdClass1 ClassiÞcation of command to follow (1 byte). (Refer to Table 5 on page 30.) byteLen1 Number of bytes for cmdClass1. Does not include itself (1 or 2 bytes).b

b All byte counts can be encoded as one or two bytes. If the most signiÞcant bit of the Þrst byte is set, then the byte countconsists of only one byte. This encoding allows up to 127 bytes to be represented with a single byte while up to 32,767bytes with two bytes.

subCmd1 A command belonging to the preceding cmdClass. (Refer to Table 5 on page 30.)cmd1Data Optional data associated with subCmd1 (variable number of bytes as deÞned in the protocol on a

per-command basis).checkSum Twos-complement of the sum of all bytes in the message (excluding STX).


Automation Determinacy Constant Considerations

Automation Determinacy Constant ConsiderationsAll 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. Some automation commands can be sent as a command or as a query. Com-mands and queries have been summarized in Table 5 on page 30 which lists each command and their possible state.

Deterministic commands always require a certain amount of time to execute on the M–2100 before the next command or query is received. The time allowed for execution of commands is called the Automation Deter-minacy Constant. 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. It is set to a minimal default value of 2 fields.

To guarantee enough time for the execution of a deterministic command to complete, commands must be received by the M–2100 no later than 13 mil-liseconds into the field. All commands will be performed 2 fields after they are received, unless the Automation Determinacy Constant has been set to a different value. As stated above, queries are executed immediately and are not affected by the Automation Determinacy Constant.

When multiple commands are sent from an automation system, there must be a gap of at least 1.3 milliseconds between the end of one automation message and the start of the next message. If this minimum duration is not observed, the M-2100 may assume that the two messages are part of a single message and they may not be executed properly.

Automation commands of the same type that are sent in sequence must be also separated by enough time to allow their complete execution. It is con-sidered 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. For example, if a TX_NEXT command is sent, the automation system must wait until that command has completely executed before sending another TX_NEXT command.

Commands with special considerations are summarized below.

XPT_TAKE and BREAK_AWAY CommandsThe XPT_TAKE and BREAK_AWAY commands cut the indicated cross-points on the designated buses. These hard cuts occur immediately upon expiration of the Automation Determinacy Constant interval.



TX_START CommandThere is another consideration for the TX_START command. It is recom-mended that the audio component not be a hard cut as a normal practice. The purely digital switch of the M–2100 will be clean, but the possibly dra-matic change in audio energy is likely to cause artifacts such as pops and thumps in the analog audio processing that may follow.

Therefore, any audio take transition is automatically changed to a Fade for the audio component. A Take transition is upgraded to a Fade-Fade for audio (but the video and key components, if any, remain as Takes). A Take-Fade transition is similarly upgraded to an asymmetrical Fade-Fade, again for the audio component only.

If a transition contains an audio component that is transitioned using a Fade-Fade transition type, and a video and/or key component is transi-tioned using a Take transition type, it is necessary to delay the Take to occur at the minimum point (bottom) of the fade. Thus the switching of the video and key components of a transition will be delayed if there is an audio com-ponent in a transition.

This is an intolerable situation for the deterministic TX_START command.

To correct this situation, an additional delay constant, referred to as the Transition Delay Constant, was introduced. As depicted in Figure 1, 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.

During this Transition Delay Constant, an audio component, if present, will be fading down, At the end of the Transition Delay Constant, the video and key cuts will occur (assuming a Take transition type) and the audio will be at the bottom of the fade, beginning the fade up to the new source.

The Transition Delay Constant operates for all transition types and all source components. The normal value of this constant is 6 fields, and is fixed for all field rates. The Transition Delay Constant must always be equal or greater than the Audio Fade Rate for a Cut, which is normally 100 ms (6 fields in 525 line rate, 5 fields in 625 line rate).

The Transition Delay Constant can be set using the VxShell command transDelayConsCfgSee and is not accessible via the Configuration Manager.

The Audio Fade Rate for a Cut Constant can be set using the VxShell command cutAudioRateCfgSee () and is expressed as milliseconds. It is not accessible via the Configuration Manager.

This audio cut rate value can be set to any value desired but will only apply to a Take transition. All other transition types (fade-fade, take-fade, fade-take) are set to a default value of 100 mS.


Automation Determinacy Constant Considerations

Once the audio cut rate is programmed with the Console command, it will be used as the cut audio rate each time a Take type transition is performed. Selecting another transition type will recall the default value of 100 mS. The new programmed value will remain after a system reboot. The pro-grammed cut audio rate will only change when it is reprogrammed with the Console command or the system NVRAM is cleared. When the system NVRAM is cleared using the Console command voidNvramSee 1, the Take audio cut rate will return to the default of 100 mS.

Figure 1. TX_START - Transition Delay Constant

1Field: 0 2 3 4 5 6 7 8 9 10 11 12 13 14 15

TX_STARTcommand(Note 1)

Guaranteed cut point, start ofmix/wipe, or matte/silent forfade type transitions.

Beginning ofaudio fade (Note 4)

End ofaudiofade

Center ofaudiofade

Trans. Delay Constantin fields. 6 fieldsnormally (Note 3)

AutomationDeterminancyConstant2 fields minimum(Note 2)

Example 1Take:Video,Audio,& Key

Example 2

Take:No Audio

Video

Video

Key

Key

Audio

Notes:1. The command must be received no later than 13 ms into the field.2. Set using autoDeterCfgSee, or the PC Configuration Manager.3. Set using transDelayConsCfgSee. Not available in Configuration Manager.4. The audio fade rate for a cut is normally 100 ms (6 fields for 525 lines, 5 fields for 625 standard). This can be set using cutAudioRateCfgSee. Not available in Configuration Manager.



Protocol ExamplesThe following examples demonstrate the message format for the M–2100 Protocol. The AUTO -> M–2100 symbol in the example indicates that Auto-mation is transmitting to the Master Control. The M–2100 -> AUTO symbol in the example indicates Master Control is transmitting to Automation.

Example 1A single command from the automation system selects a Mix transition type.

AUTO -> M–2100

[02] STX Start of transmission

[84] Byte Count Message byte count1

[01] CMD Classification of commands to follow

[82] Byte Count Message byte count

[03] TX_TYPE Transition Type command

[04] MIX Transition Type selection

[F2]Checksum Message checksum

M–2100 -> AUTO

[04] ACK Acknowledge to message

Example 2Two commands from the automation system select a Wipe transition type and a Transition Rate of 30 frames.

AUTO -> M–2100


[00] Byte 0 Message byte count MSB

[09] Byte 1 Message byte count LSB

[01] CMD Classification of commands to follow.




1. Note that the Most Significant Bit is set, indicating a 1 byte byte count.


Protocol Examples

[06] WIPE Transition Type selection

[04] TX_RATE Transition rate select

[00] RATE Use rate value to follow

[00] Byte 0 Transition rate value MSB

[1e] Byte 1 Transition rate value LSB

[c5] Checksum Message checksum

M–2100 -> AUTO


Example 3A single query from the automation system requests the current transition rate.

AUTO -> M–2100




[02] QUERY Classification of queries to follow.



[04] TX_RATE Transition rate query

[F5] Checksum Message checksum

M–2100 -> AUTO




[03] STATUS Classification of status to follow.


[04] Byte 1 Message byte count LS

[04] TX_RATE Transition rate reply

[00] R ATE Current rate selected




[1e] Byte 1 Transition rate value LSB

[d0] Checksum Message checksum

Example 4Two commands and two queries from the automation system select a Mix transition type and a slow transition rate, then invoke a query for transition type and transition rate.

AUTO -> M–2100


[00 Byte 0 Message byte count MSB

[0e] Byte 1 Message byte count LSB




[03] TX_TYPE Transition type command

[04] MIX Transition type selection

[04] TX_RATE Transition rate command

[01] SLOW Transition rate selection

[00] Byte 0 Transition rate value MSB (N/A)

[00] Byte 1 Transition rate value LSB (N/A)

[02] QUERY Classification of queries to follow.



[03] TX_TYPE Transition type query

[04] TX_RATE Transition rate query

[d4] Checksum Message checksum: Two’s complement,excluding STX.

M–2100 -> AUTO





Protocol Examples

[03] STATUS Classification of queries to follow.



[03] TX_TYPE Transition type reply

[03] TAKE_FADE Current transition type

[04] TX_RATE Transition rate reply

[01] SLOW Current rate selected


[2c] Byte 1 Transition rate value LSB (rate of 60 currently beingused for SLOW)

[b7] Checksum Message checksum: Two’s complement excludingSTX.

Example 5A single command from the automation system selects a Wipe transition type. The M–2100 returns an error, because the Wipe Option is not avail-able. The next command issued is a request for Error Status, which returns information about what was wrong with the previous message.

AUTO -> M–2100








[06] WIPE Transition Type selection (note: assume the option isnot available)

[ef] Checksum Message checksum: Two’s complement, excludingSTX.

M–2100 -> AUTO

[05]NAK Not acknowledge to message

AUTO->M–2100





[02] QUERY Classification of Query to follow

[81] Byte Count Command Class byte count

[20] ERROR_STAT Error Status query

[DA] Checksum Message checksum: Twos complement,excluding STX.

M–2100->AUTO


[00] Byte Count 0 Message byte count MSB

[0E] Byte Count 1 Message byte count LSB

[03] STATUS Classification of Status to follow

[00] Byte Count 0 Command Class byte count MSB

[0B] Byte Count 1 Command Class byte count LSB

[20] ERROR_STAT Error Status reply

[06] FEATURE_ERR Type of error (feature not available)

[01] CMD Command Class of offending command

[03] TX_TYPE Sub-Command of offending command

[00] Byte Pos1 Byte position of error MSB

[05] Byte Pos2 Byte position of error LSB (5th byte)

[00] data1 Data byte #1



[06] WIPE Data byte #4, data from TX_TYPE command

[01] Arg # Argument #1 was found to be in error

[AE] Checksum Message checksum: Twos complement,excluding STX


Protocol Examples

Example 6The following example demonstrates how to setup Keyer 1 and transition it to air. First send a keyer modification message for a linear self key with a video fill.

AUTO->M-2100

[02] STX Start of Message

[86] Byte Count Message Byte Count



[0A] KEY_MOD Key Modifier Command

[01] <keyer> Keyer Number

[03] <key mod> Keyer Modification

[00] <squeeze back> Squeeze Back Modifiers

[E7] Checksum Message Checksum

M-2100->AUTO

[04} ACK Acknowledge to message

Next, 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


Next set transition type to Key or Key/Background. The example below assumes a Key only transition.



AUTO->M-2100

[02] STX

[84] Byte Count

[01] CMD

[82] Byte Count

[01] TX_NEXT

[02] <next trans>

[F6] Checksum

M-2100->AUTO


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


We could also do all of the above commands in two messages by using the multiple command facility of the automation protocol.


[8A] Byte Count Message Byte Count



[0A] KEY_MOD Key Modifier Command


[03] <key mod> Keyer Modification

[00] <squeeze back> Squeeze Back Modifiers


Protocol Examples

[0B] KEY_ENABLE Enable Keyer Command


[01] TX_NEXT Transition Type Command

[02] <next trans> Transition Type Selection

[D0] Checksum

M-2100->AUTO


AUTO->M-2100





[02] TX_START Transition Start Command

[02] <trigger mod> Transition Start Selection

[F5] Checksum

M-2100->AUTO

[04] ACK



Example 7The following example demonstrates how to determine which keys are on-air and then take them off-air. We will assume that Keyer number 1 and 2 are on-air.

First get key status:

AUTO->M-2100



[02] QUERY Classification of queries to follow


[0C] KEY_STAT Key Status Query

[EE] Checksum Message Checksum

M-2100->AUTO

[02] STX

[00] Byte Count 0 Message Byte Count MSB

[05] Byte Count 1 Message Byte Count LSB




[0C] KEY_STAT Key Status Reply

[03] <status> Key Status


Next set transition type to Key or Key/Background. 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.

AUTO->M-2100

[02] STX

[84] Byte Count

[01] CMD

[82] Byte Count

[01] TX_NEXT

[02] <next trans>


Protocol Examples

[F6] Checksum

M-2100->AUTO


Next determine which keys are enabled. We do this so that we don't disable a key that is supposed to go on-air at the next transition. We will assume that Keyer number 4 is enabled to go on-air at the next transition.

AUTO->M-2100



[02] QUERY Classification of queries to follow


[0B] KEY_ENABLE Key Enable Query

[EF] Checksum Message Checksum

M-2100->AUTO

[02] STX






[0B] KEY_ENABLE Key Status Reply

[0B] <keyer> Keyer


Next we enable Keyers 1, 2, and 4. Remember that we are enabling Keyer 4 because it was already enabled. The KEY_ENABLE command tells the switcher what state the Keyers should be after the next transition, so the value we put into the <keyer> field is not Keyer Number 1, 2 & 4 (0x0B) but rather Keyer 4. (0x08) This is because after the transition we want only Keyer 4 on-air. 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



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.This is because the KEY_ENABLE command checks the state of the Next Transition, and if it is not set to Key, then it toggles the button state. There can be a race condition with the TX_NEXT command that will toggle the key transition off.

AUTO->M-2100

[02] STX

[84] Byte Count

[01] CMD

[82] Byte Count

[0B] KEY_ENABLE

[08] <keyer>

[E6] Checksum

M-2100->AUTO


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



Protocol Examples

Example 8The following is an example of a a video breakaway to crosspoint 3 on the Program bus.

AUTO->M2100

[02] STX Start of message


[01] CMD Classification Command to follow


[07] BREAK_AWAY Break Away command

[01] <type> Break Away type video.

[00] <bus> Bus Select MSB

[01] <bus> Bus Select LSB (PGM bus selected)

[03] <xpt> Break away to crosspoint 3

[00] <only> No change to the Audio Only crosspoints.

[E5] Checksum

M2100->AUTO

[04] ACK



Example 9The following is an example of an audio breakaway to crosspoint 9 on the Preset bus.

AUTO->M2100

[02] STX Start of message


[01] CMD Classification Command to follow


[07] BREAK_AWAY Break Away command

[02] <type> Break Away type audio.

[00] <bus> Bus Select MSB

[02] <bus> Bus Select LSB (PST bus selected)

[09] <xpt> Break away to crosspoint 9

[00] <only> No change to the Audio Only crosspoints.

[DD] Checksum

M2100->AUTO

[04] ACK


Section 2Automation System Protocol Commands

IntroductionThe Automation Protocol allows an external controller to exercise control over the M–2100 in a variety of ways.

You can:

• Set parameters normally set by operator using the manual control panels or system configuration,

• Execute Takes and other transitions, and

• Query status.

The Master Control System Message protocol is defined in Section 1. This section describes the transmit and receive message formats, including errors.

Command SummaryTable 4 shows the mnemonic and value for the various Command classes.

Table 4. Command Classes

Mnemonic Value Description

CMD 0x01 Commands sent from Automation to the M–2100.

QUERY 0x02 Requests sent from Automation to the M–2100.

STATUS 0x03 Status returned to Automation from the M–2100 in response to a Query.

SUBSCRIPTION 0X04 Status returned to Automation from the M–2100 in response to a Subscription command.


Section 2 — Automation System Protocol Commands

Table 5 shows the mnemonic and value for various subcommands, as well as whether the feature is supported for commands and/or queries and whether the command is deterministic.

Table 5. Summary of Subcommands

Mnemonic Value Cmd Query Deterministic Description

TX_NEXT 0x01 yes yes yes Next Transition

TX_START 0x02 yes no yes Start Transition

TX_TYPE 0x03 yes yes yes Selects Transition Type

TX_RATE 0x04 yes yes yes Selects Transition Rate

TX_STAT 0x05 no yes no Transition Status

TX_STAT2 0x15 no yes no Transition Status

XPT_TAKE 0x06 yes yes yes Take Crosspoint

BREAK_AWAY 0x07 yes yes yes Break away

OVER_SELECT 0x08 yes yes yes Audio over Select

OVER_RATIO 0x09 yes yes yes Audio over to Main Ratio

KEY_MOD 0x0A yes yes yes Key Modifier

KEY_ENABLE 0x0B yes yes yes Key Enable

KEY_STAT 0x0C no yes no Key Status

AUTO_STAT 0x0D no yes no Automation Enable Status

ALL_STOP 0x0E yes no yes Stop on going transition

PREROLL 0x0F yes yes yes Current Preroll Time

CONFIG_PREROLL 0x10 yes no yes Configuration Preroll Time

REMAINING_TIME 0x11 yes no yes Remaining Time Display

SYSTEM_STAT 0x12 no yes no System Status

SYSTEM_CONFIG 0x13 no yes no System Configuration

XPT_AUDIO_MODE 0x14 yes yes yes Crosspoint Audio Mode

SUBSCRIBE 0x16 yes yes yes Subscription Service

GPI 0x17 yes yes yes Set/Clear GPI button

WIPE_SEL 0x18 yes yes yes Select Wipe Patterns

ERROR_STAT 0X20 no yes no Error Status for previous message

PROTO_VER 0X21 no yes no Protocol / Version

M2100_VER 0X22 no yes no M2100/FCM Version

SUBSCR_PRETRANS 0x01 no no no Preroll/Transition Button Press/Release Events

SUBSCR_HOLD 0x02 no no no Hold Button Press/Release Events


Command Formats

Command Formats

TX_NEXT — Next Transitionvalue: 0x01 (unsigned byte)command format: TX_NEXT <next trans>query format: TX_NEXTreply format: TX_NEXT <next trans>notes: - If a protocol request for Key Only is received, and the MCP is in an Audio Only state, it

will be forced to a Married state prior to honoring the Key Only request.- If commands TX_NEXT and KEY_ENABLE are sent in the same field, theKEY_ENABLE command must be sent first.

field information: <next trans> Next Transition (unsigned byte)

bit 0 Background1

bit 1 Key1

bit 2-7 Reserved

TX_START — Start Transitionvalue: 0x02 (unsigned byte)command format: TX_START <trigger mod>query format: illegalreply format: nonenotes: 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, while allowing the auto-mation to override those requirements when it is providing its own machine control.

field information: <trigger mod> Trigger Modifier (unsigned byte)

bit 0 Start video2

bit 1 Start audio2

bit 2 Inhibit Start Relays (No start relays are closed.)bit 3 Zero Preroll (Zero preroll time is assumed.)bit 4-7 reserved

1. Either bit 0, bit 1, or both must be selected.2. Either bit 0, bit 1, or both must be selected.



TX_TYPE — Select Transition Typevalue: 0x03 (unsigned byte)command format: TX_TYPE <tran>query format: TX_TYPEreply format: TX_TYPE <tran>notes: Select the Transition Type for the next transition. A Wipe transition selection requires that

the Software Authorization Module enable Wipes.field information: <tran> Transition Type (unsigned byte)

01 Take02 Fade-Fade03 Take-Fade04 Mix05 Fade-Take06 Wipe

Notes:1. If a transition type has been configured as a custom transition, the transition will execute as a custom transition.

TX_RATE — Select Transition Ratevalue: 0x04 (unsigned byte)command format: TX_RATE <rate type> <rate>query format: TX_RATEreply format: TX_RATE <rate type> <rate>notes: - Command: rate type = 0 indicates that the rate value is to be used.

- Replies: returns the rate type and rate value for the next transition.- If <rate_type> = “Rate,” the Rate field will override any currently selected rate on theMCP. MCP Rate buttons will tally off; however the Rate Value will be displayed.- If a new Transition Type is selected by either the MCP or the Automation system, anypreviously specified protocol rate will be overridden by the rate associated with theselected Transition Type. Therefore the automation system must first send the desiredTransition Type, then send the Rate.- If a Rate is selected on the MCP, it is “remembered” as associated with the currentlyselected (non-Cut Transition Type. Whenever that Transition Type is again selected, theremembered Rate is recalled (Slow, Medium, Fast). When automation selects a <rate type> (Slow, Medium, Fast), it is remembered. When automation selects a <rate type> = (Rate) and supplies a value, the value will notbe remembered for the current Transition Type.

field information: <rate type> Rate Type (unsigned byte)00 Rate rate value to be used.01 Slow02 Medium03 Fast04 No Rate (For replies only - No Rate currently selected.)

<rate> Transition Rate (unsigned two bytes) 00 through 65535 frames


Command Formats

TX_STAT — Transition Statusvalue: 0x05 (unsigned byte)command format: illegalquery format: TX_STATreply format: TX_STAT <video> <ap1> <ap2> <ap3> <ap4> <hold>notes: Status of transition at the time this query was received.field information: <video> Transition Video Status (unsigned byte)

01 Quiescent02 Preroll03 Transitional04 Fading To Black05 Fading From Black06 In Black

<ap1-4> Transition Audio Status (unsigned byte)01 Quiescent02 Preroll03 Transitional04 Fading To Silent05 Fading From Silent06 In Silent

<hold> Hold On/Off Status (unsigned byte)00 OFF01 ON



TX_STAT2 — Transition Statusvalue: 0x15 (unsigned byte)command format: illegalquery format: TX_STATreply format: TX_STAT <video> <keyer> <ap1> <ap2> <ap3> <ap4> <hold>notes: Status of transition at the time this query was received.field information: <video> Transition Video Status (unsigned byte)

01 Quiescent02 Preroll03 Transitional04 Fading To Black05 Fading From Black06 In Black

<keyer> Keyer 1-4 Summary Status (unsigned byte)01 Quiescent02 Preroll03 Transitional04 Fading To Black05 Fading From Black06 In Black

<ap1-4> Transition Audio Status (unsigned byte)01 Quiescent02 Preroll03 Transitional04 Fading To Silent05 Fading From Silent06 In Silent

<hold> Hold On/Off Status (unsigned byte)00 OFF01 ON


Command Formats

XPT_TAKE — Crosspoint Takevalue: 0x06 (unsigned byte)command format: XPT_TAKE <bus> <xpt> <only>query format: XPT_TAKE <bus>reply format: XPT_TAKE <bus> <xpt> <only>notes: Audio onlies are not used for the AUX buses. The crosspoint Take command will clear any

overs that may be selected.

field information: <bus> Bus Select (unsigned two bytes)1

bit 0 Program Busbit 1 Preset Busbit 2 Audio Processor 1bit 3 Audio Processor 2bit 4 Audio Processor 3bit 5 Audio Processor 4bit 6 Aux 1 Busbit 7 Aux 2 Busbit 8 Aux 3 Busbit 9 Aux 4 Busbit10-15 Reserved

<xpt> Crosspoint (unsigned byte)2

00 No Change01 - 16 Crosspoint number

<only> Audio Only Crosspoint (unsigned byte)2

00 No Change01 Audio Only 102 Audio Only 203 Audio Only 304 Audio Only 4

Notes:1. Hot cuts (XPT–Take, 0x06) are not allowed when a transition is in progress. If a transition is in progress when it is time for a hot cut to be executed, the hot cut will not be executed through the FCM although an ACK will be returned to the requesting automation system. An error will be generated (OTHER–ERR, 0x0A) which will indi-cate that the command request could not be executed.2. An Aux Bus Take does not require any of the Audio Processor bits to be set.3. For a Program Bus or Preset Bus Take: If no Audio Processor bits are set the operation will be anaudio/video breakaway; only the video will be switched.4. For a Program Bus or Preset Bus Take: If Audio Processor 1 is selected, any or all of Audio Processors 2 — 4 can be selected and will switch also.5. For a Program Bus or Preset Bus Take: If Audio Processor 1 is not selected, only one of Audio Processors 2 — 4 can be selected. In this case, only the designated Audio Processor will switch.6. For a Program Bus or Preset Bus Take: If Audio Processor 1 and any other audio processor bits are set,then the audio processor whose bits are set will be delegated. This delegation may be used by the

1. One or more buses must be selected for the command format of this field. Only one bus may be selected for the query format ofthis field. No buses selected is an invalid condition.2. Select a crosspoint from <xpt> or <only>, but not both.



BREAK_AWAY command. If Audio Processor 1 is not set, then no change in delegation will occur.

BREAK_AWAY — Break Awayvalue: 0x07 (unsigned byte)command format: BREAK_AWAY <type> <bus> <xpt> <only>query format: BREAK_AWAY <type> <bus>reply format: BREAK_AWAY <type> <bus> <xpt> <only>notes: Breaks away (Takes) audio from video, or video from audio. Clears any overs that may be se-

lected.field information: <type> Break Away Type (unsigned byte)

01 Video02 Audio

<bus> Bus Select (unsigned two bytes)1

bit 0 Program Busbit 1 Preset Busbit 2-15 Reserved

<xpt> Crosspoint (unsigned byte)2

00 No Change01 - 16 Crosspoint number

<only> Audio Only Crosspoint (unsigned byte)2

00 No Change01 Audio Only 102 Audio Only 203 Audio Only 304 Audio Only 4

Note:For an Audio Breakaway, all audio processors delegated by an immediately previous XPT_TAKE command will be affect-ed. Audio Processor 1 will always be affected.

1. One or more buses must be selected for the command format of this field. Only one bus may be selected for the query format ofthis field. No buses selected is an invalid condition.2. Select a crosspoint from <xpt> or <only>, but not both.


Command Formats

OVER_SELECT — Audio Over Selectvalue: 0x08 (unsigned byte)command format: OVER_SELECT <bus> <over>query format: OVER_SELECT <bus>reply format: OVER_SELECT <bus> <over>notes: If this command is to be used in conjunction with the XPT_TAKE or BREAK_AWAY

commands, it should be issued after these commands to prevent the clearing of Audio Overselections.


bit 0 Program Busbit 1 Preset Busbit 2 Audio Processor 1bit 3 Audio Processor 2bit 4 Audio Processor 3bit 5 Audio Processor 4bit 6-15 Reserved

<over> Over Select (unsigned byte)00 Clear overs on selected bus or buses01 Over 102 Over 203 Over 304 Over 4

Notes:1. At least one of the Audio Processor 1 – Audio Processor 4 bits must be set2. If Audio Processor 1 is selected, any or all of Audio Processors 2 – 4 can be selected and will also switch.3. If Audio Processor 1 is not selected, only one of Audio Processors 2 – 4 can be selected. In this case, onlythe designated audio processor will switch.

OVER_RATIO — Audio Over to Main Ratiovalue: 0x09 (unsigned byte)command format: OVER_RATIO <bus> <ratio>query format: OVER_RATIO <bus>reply format: OVER_RATIO <bus> <ratio>notes: This command will set the Over Ratio for any or all of Audio Processors 1 – 4 indicated.


bit 0 Program Busbit 1 Preset Busbit 2 Audio Processor 1bit 3 Audio Processor 2bit 4 Audio Processor 3bit 5 Audio Processor 4bit 6-15 Reserved

<ratio> Ratio (one byte unsigned)

1. One or more buses must be selected for the command format of this field. Only one bus may be selected for the query format ofthis field. No buses selected is an invalid condition.



0 through 100, where 0 is full PGM, 100 is full OVER, and 50 is an equal mix of both.

KEY_MOD — Key Modifiervalue: 0x0A (unsigned byte)command format: KEY_MOD <keyer> <key mod> <squeeze back>query format: KEY_MOD <keyer>reply format: KEY_MOD <keyer> <key mod> <squeeze back>notes: - Selects the characteristics for the requested key(s). The squeeze back field has no effect when

the squeeze back bit in the keyer field is equal to zero. - The “Keyer Select” parameter selects a key for modification; but does not “Select” itas you do on the MCP.- An error condition will be generated if: “Keyer Select” bits are set for non-existentKeyers. (All existing Keyers will be processed correctly.)- An error condition will be generated if: an attempt is made to modify the SqueezeBackpattern, and the SqueezeBack feature has not been enabled by the Software Authorization Mod-ule.- An error condition will be generated if: an attempt is made to set Key Border or Shadow, and Borders 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 - neither will be set.

field information: <keyer> Keyer Select (unsigned byte)1

Bit 0 Keyer 1Bit 1 Keyer 2Bit 2 Keyer 3Bit 3 Keyer 4Bit 4 SqueezeBackBit 5-7 Reserved

<key mod> Key Modifier (unsigned byte)bit 0 0 = Self

1 = Externalbit 1 0 = Matte

1 = Video

bit 2 Border2

bit 3 Shadow2

bit 4 0 = Linear1 = Luminance

Bit 5-7 Reserved

<squeeze back> SqueezeBack Position (unsigned byte)3

00 No change01 Squeeze to upper right02 Squeeze to upper left

1. One or more keyers must be selected for the command format of this field. Only one keyer may be selected for the query

format of this field. No keyers selected is an invalid condition.2. Mutually exclusive; only one may be set at a time.3. Only valid when squeeze back bit is set in the keyer field.


Command Formats

03 Squeeze to lower right04 Squeeze to lower left

KEY_ENABLE — Key Enablevalue: 0x0B (unsigned byte)command format: KEY_ENABLE <keyer>query format: KEY_ENABLEreply format: KEY_ENABLE <keyer>notes: - Selects the keyers and/or SqueezeBack to be on or off air after the next transition.

- Selecting a Keyer (bit=1) at the next transition will take an off-air key on-air, or leave anon-air key on-air. Setting (bit=0) has a similar, but complimentary effect.- Selecting a Keyer (bit=1) for a currently off-air Keyer will cause that Key to be seen onthe PST bus.- An error condition will be generated if: an attempt is made to enable a Key that is notphysically present.- An error condition will be generated if: SqueezeBack is selected, but SqueezeBack is notenabled by the Software Authorization Module.- See comments in the TX_NEXT command notes concerning interaction with theKEY_ENABLE command.

field information: <keyer> Keyer Select (unsigned byte)1

Bit 0 Keyer 1Bit 1 Keyer 2Bit 2 Keyer 3Bit 3 Keyer 4Bit 4 SqueezeBackBit 5-7 Reserved

KEY_STAT — Key Statusvalue: 0x0C (unsigned byte)command format: illegalquery format: KEY_STATreply format: KEY_STAT <status>notes: Status for Keyers that are not physically present will be reported as off-air. Use the System

Status and System Configuration commands to obtain more information.field information: <status> Keyer Status (unsigned byte)

Bit 0 Keyer 1 (0 = Off air, 1 = On air)Bit 1 Keyer 2Bit 2 Keyer 3Bit 3 Keyer 4Bit 4 SqueezeBackBit 5-7 Reserved

1. One or more keyers must be selected for the command format of this field. Only one keyer may be selected for the queryformat of this field. No keyers selected is an invalid condition.



AUTO_STAT — Automation Enable Statusvalue: 0x0D (unsigned byte)command format: illegalquery format: AUTO_STATreply format: AUTO_STAT <status>notes: By default – if the manual control panel is not present the automation status is enabled.

When the Automation Interface is disabled, commands will be acknowledged, but notexecuted. Queries sent to the M-2100 when the interface is disabled will still be honored.

field information: <status> Status (unsigned byte)00 Disabled01 Enabled

ALL_STOP — All Stopvalue: 0x0E (unsigned byte)command format: ALL_STOP <options>query format: illegalreply format: nonenotes: Stops all on-going transitions and resets the system to a known state.field information: <options> All-Stop Options (unsigned byte)

bit 0 Background and key transition is stoppedbit 1 Reservedbit 2 The transition mode is set to background.bit 3 All keys are removed.bit 4 Change PGM and all AP’s to crosspoint #1 (normally black)bit 5-7 Reserved

PREROLL — Current Preroll Timevalue: 0x0F (unsigned byte)command format: PREROLL <preroll>query format: PREROLLreply format: PREROLL <preroll>notes: Overrides the preroll of all the sources currently selected on the PST bus for the next transition

only. Query returns longest effective preroll, based on the current PST bus status and current preroll values.

field information: <preroll> Preroll value (unsigned two bytes) 0 through 65535 frames


Command Formats

CONFIG_PREROLL — Configuration Preroll Timevalue: 0x10 (unsigned byte)command format: CONFIG_PREROLL <xpt> <only> <keyer> <preroll>query format: illegalreply format: nonenotes: Sets the configured preroll of the selected sources. The new preroll stays in effect until changed

by downloading a new system configuration, or another Configuration Preroll Time command is issued. This command does not effect the Master Preroll Time kept in the host computer’s system configuration.

field information: <xpt> Crosspoint (unsigned byte)00 No Change01 - 16 Crosspoint number255 Select all sources

<only> Audio Only Select (unsigned byte)00 No Change01 Audio Only 102 Audio Only 203 Audio Only 304 Audio Only 4255 Select all Onlies

<keyer> Keyer Select (unsigned byte)Bit 0 Keyer 1Bit 1 Keyer 2Bit 2 Keyer 3Bit 3 Keyer 4Bit 4 SqueezeBackBit 5-7 Reserved

<preroll> Preroll value (unsigned two bytes) 00 through 65535 frames



REMAINING_TIME — Remaining Time Displayvalue: 0x11 (unsigned byte)command format: REMAINING_TIME <remaining time>query format: illegalreply format: nonenotes: This command jams the Remaining Time display on the MCP. Optionally, the time

can be commanded to begin decrementing.field information: <remaining time> Remaining Time (unsigned four bytes in BCD format)

Byte 1bit 0-3 Ones digit - Hourbit 4-6 Tens digit - Hour bit 7 Decrement remaining time display

Byte 2bit 0-3 Ones digit - Minutebit 4-7 Tens digit - Minute

Byte 3bit 0-3 Ones digit - Secondbit 4-7 Tens digit - Second

Byte 4bit 0-3 Ones digit - Framebit 4-7 Tens digit - Frame

Note:If the most significant bit of the hour Ten’s digit is set (bit 7 of Byte 1), the displayed remaining time will begin decrement-ing.

SYSTEM_STAT — System Statusvalue: 0x12 (unsigned byte)command format: illegalquery format: SYSTEM_STATreply format: SYSTEM_STAT <status>notes: In general, if a bit is zero, it indicates an “okay” condition. This is done so the entire

<status> can be tested against zero to determine if anything is not functioning.field information <status> System Status (unsigned two bytes)

bit 0 FCM Power = 0 okay. = 1 One of two is non-functional.

bit 1 Reservedbit 2 Crosspoint Module

= 0 okay or not installed. = 1 non-functional.

bit 3 Mixer Module = 0 okay or not installed. = 1 non-functional.

bit 4 Audio Processor 1 = 0 okay or not installed. = 1 non-functional.


Command Formats




bit 8 Keyer 1 = 0 okay or not installed. = 1 non-functional.




bit 12-15 Reserved

SYSTEM_CONFIG — System Configurationvalue: 0x13 (unsigned byte)command format: illegalquery format: SYSTEM_CONFIGreply format: SYSTEM_CONFIG <config>notes: nonefield information <config> Configuration (unsigned three bytes)

bit 0 Reservedbit 1 Audio Processor 1

= 0 non-functional or not present. = 1 present.

bit 2 Audio Processor 2 = 0 non-functional or not present. = 1 present.



bit 5 SqueezeBack = 0 not software authorized. = 1 software authorized.

bit 6 Wipe Transition = 0 not software authorized.



= 1 software authorized.bit 7 Embedded Audio Processing

= 0 not software authorized. = 1 software authorized.

bit 8-9 Keyer 1 = 00 non-functional or not present. = 01 chroma = 10 Luminance/linear key borders, not software

authorized. = 11 Luminance/linear key borders, software authorized.

bit10-11 Keyer 2 = 00 non-functional or not present. = 01 chroma = 10 Luminance/linear key borders, not software






bit 16 Audio Processor 2 Over Configuration = 0 Disabled. = 1 Enabled.



bit 19-23 reserved


Command Formats

XPT_AUDIO_MODE — Crosspoint Audio Modevalue: 0x14 (unsigned byte)command format: XPT_AUDIO_MODE <bus> <mode> <phase>query format: XPT_AUDIO_MODE <bus>reply format: XPT_AUDIO_MODE <bus> <mode> <phase>notes: This command is used to set the audio mode (stereo/mono) and the audio phase reversal for

the current crosspoint on the specified bus.field information: <bus> Bus Select (unsigned two bytes)

Bit 0 Program BusBit 1 Preset BusBit 2 Audio Processor 1Bit 3 Audio Processor 2Bit 4 Audio Processor 3Bit 5 Audio Processor 4Bits 6-15 Reserved

<mode> Audio Mode (unsigned byte)0 No change1 Stereo2 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).

Note 1: One or more buses must be selected. None selected is an invalid condition. In addition, at least one Audio Processor bus must be selected. The command is effective on all indicated APs. AP delegation, if changed, is restored.

Note 2: Phase reversal is applied to the left channel, which can be inverted or set to normal. However, if the right channel has been inverted (by action of a MCP operation), 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. Note 3: Although this command is applied to AP(s) on one or more buses, the settings made belong to the crosspoint source, using the same rules that the operator of the MCP panel sees.

1: If an over is selected on the bus, the settings are directed to that source (e.g. The over source will haveits mono-mode/phase changed).

2: If a change is made to a source on the PGM bus and then the program bus source is changed, the new

source will assert its mono-mode/phase setting instead of what might have been previously set for thatsource.

3: If a change is made on a PST bus source and the source is reselected, the original settings will be

restored. A PST source selection always picks up the last settings of this source the last time it was onair. Thus if a change is made to a PST source and the source is reselected, the settings present on the PGMbus are reasserted.



GPI — GPI Button Operationvalue: 0x17 (unsigned byte)command format: GPI <GPI#><true|false>query format: GPI <GPI#>reply format: GPI <GPI#><true|false>notes: GPI commands set/clear the specified GPI button at the MCP. GPI

button operations occur according to the current GPI configurationmode. Set/clear operations do not correspond to press/release; set/clearoperations incorporate both button press and release, and treat the GPIbutton as on or off, as specified in the automation command (true/false)and according to GPI mode. For example, if GPI1 is set to “Clear Segment Display” mode, then theGPI 1, true command has the effect of a GPI button press/release,which clears the Segment display. In this example, a GPI 1, falsecommand is a no operation (nop).

field information: <GPI#> GPI button bit 0 GPI 1bit 1 GPI 2Note: These bits are mutually exclusive. Illegal combinations (when bothare set or clear, are ignored. That is, for field <GPI#> 1 or 2 are the legal values.

<true|false>bit 0 true = setfalse = clear


Command Formats

WIPE_SEL — Select Wipe Patternsvalue: 0x18 (unsigned byte)command format: WIPE_SEL <wipe pattern><wipe mod><soft value>query format: WIPE_SELreply format: WIPE_SEL <wipe pattern><wipe mod><soft value>notes: —

field information: <wipe pattern> Wipe pattern (unsigned byte) 10 Horizontal00 Vertical04 Bottom left diagonal14 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, wipe is hard, if 1, wipe is soft)Bit 1 Reverse (If 0, wipe is left-to-right or top -to-bottom, if 1, wipe is reversed)Bit 2-7 Reserved<soft value> Soft value (unsigned two bytes)0-100% Valid only when the soft modifier is selected.

ERROR_STAT — Error Status

value: 0x20 (unsigned byte)command format: illegalquery format: ERROR_STATreply format: ERROR_STAT <err code> <cmd class> <sub cmd> <byte position> <data> <arg #>notes: 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. Upon receipt of a message, the M–2100 will perform a cursory check to validate it and may uncover other errors when the command is actually pro-cessed. If no errors have occurred since the last message was received by the M–2100, an error code of NO_ERR will be returned.

field information: <err code> Error Code (unsigned byte)

00 No_err No errors have occurred since the last message was received.01 Checksum_err The checksum computed by the M–2100 did not match the

checksum in the message.02 Command_err Invalid or unrecognized Command-Class/

Sub-Command combination.

03 Bitfield_err Invalid combination of bits selected in a data field.

04 Selection_err Invalid selection in data field.

05 Range_err Number in data field is out of range.



06 Feature_err Requested feature is not implemented or not available.

07 Install_err Requested feature is not installed.

08 Internal_err Internal processing error.09 Auto_disabled Automation interface currently disabled.

10 Other_err Other unexpected error (not fitting into any of thecategories listed above).

<cmd class> Command Class (unsigned byte)

Byte code found in the Command Class position of the message. Should be one of the Command Classes from Table 1.1. This field will be zero for the No_Err and Checksum_Err error codes.

<sub cmd> Sub-Command (unsigned byte)

Byte code found in the Sub-Command position of the message. Should be one of the Sub-Commands from Table 1.2. This field will be zero for the No_Err and Checksum_Err error codes.

<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). This field will be zero for the No_Err error code.

<data> Offending data (unsigned 4 bytes)

Data that was found to be in error. If the data corresponding to the Command Class and Sub-Command is less than four bytes (as defined in the protocol), the data will be put in the least significant bytes of the 4-byte <data> field. This field will be zero for the No_Err error code. For a Checksum_Err, the <data> field will contain the checksum calculated by the M–2100.

<arg #> Argument number (unsigned byte)

Argument or field number where the offending data was found.


Command Formats

PROTO_VER — Protocol Version

value: 0x21 (unsigned byte)command format: illegalquery format: PROTO_VER <major> <minor>reply format: PROTO_VER <major> <minor>notes: 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. The M–2100 (tributary) will respond with the version of the protocol that it is using. Incompatible versions between the controller and tributary may yield inconsistent results. The major/minor version is typically expressed in combination such as 2.1, where “2” is the major version and “1” is the minor version.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 communi-cations line. Anytime the major number is incremented, the minor number is reset to zero.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 communi-cations line.

field information: <major> (unsigned byte)

In the query format of PROTO_VER, the major field indicates the major protocol versionthat the controller is using. In the reply format, the field indicate the major protocolversion that the tributary is using.

<minor> (unsigned byte)

In the query format of PROTO_VER, the minor field indicates the minor protocol versionthat the controller is using. In the reply format, the field indicate the minor protocolversion that the tributary is using.



M2100_VER — FCM Software Version

value: 0x22 (unsigned byte)command format: illegalquery format: M2100_VERreply format: M2100_VER <major> <minor>notes: This query is provided to identify the software version running on the FCM.

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 commu-nications line. Anytime the major number is incremented, the minor number is reset to zero.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 commu-nications line.

field information: <major> (unsigned byte)<minor> (unsigned byte)


Command Formats

SUBSCRIBE — Subscription ServiceRefer to Automation Protocol Subscription Service, and Subscription Command Operation on page 52 for detailed infor-mation on the subscription commands.

value: 0x16 (unsigned byte)command format: SUBSCRIBE <subscription bits>query format: SUBSCRIBEreply format: SUBSCRIBE <subscription bits>notes: Any bit set = 1 in the <subscription bits> will enable subscription to that item.

Any bit set = 0 will disable subscription to that item. All currently undefined bits should be set = 0.

field information: <subscription bits> (unsigned four bytes)bit 0 Preroll/Take Event. Whenever the user presses or releases PrerollTake, any subscriber to this event will be notified as described below.bit 1 Hold Event. Whenever the user presses or releases Hold, any sub-scriber to this event will be notified as described below. bits 2-31 Reserved for future subscription items

SUBSCR_PRETRANS - Preroll/Transition Button Press/Release Eventsvalue: 0x01 (unsigned byte)status format: SUBSCR_PRETRANS <press/release flag>notes: If this information is currently subscribed-to, 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 notexecuted.

field information: <press/release flag> (unsigned byte)00 Preroll/Trans Button released01 Preroll/Trans Button pressed

SUBSCR_HOLD - Hold Button Press/Release Eventsvalue: 0x02 (unsigned byte)status format: SUBSCR_HOLD <press/release flag>notes: If this information is currently subscribed-to, it is sent to the Automation

Controller when the user presses/releases the MCP’s Hold button. Normal Hold logic in the frame controller is not executed.

field information: <press/release flag> (unsigned byte)00 Hold Button released01 Hold Button pressed



Automation Protocol Subscription ServiceThis feature allows automation controllers to subscribe to specific system information. If specific information is subscribed to, the Controller will be notified (unsolicited) if that system information changes. For example, if the Controller subscribes to “Preroll/Take” event information, the Con-troller will be sent a protocol message whenever the Preroll/Take button is pressed or released.

• 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.

• Subscriptions to the Preroll/Transition button press event will return data telling the controller when the button is pressed and when it is released.

• Subscriptions to the Hold button press event will return data telling the controller when the button is pressed and when it is released.

Subscription Command OperationThe Controller can subscribe to any subset of the available subscription items using a single command and a bit field that defines subscription items. The Controller is responsible for ensuring that every time that command is sent, all such items are identified.

The Controller can query for the bit field defining all currently subscribed-to items.

In general, subscription information will come in two forms:

• Notification of an event (no data).

• Notification of an event or change of some operational parameter (with data). Data length will vary as per event definition.

If the MCP Channel Control Automation Enable button is disabled (tally = off), subscriptions are temporarily disabled. When Automation is re-enabled, subscription information resumes. Changes or events that occur while Automation is disabled are not queued and are not reported when Automation is re-enabled.

A console command option allows you to select one of the following actions:

• Cancel all subscriptions on FCM reboot.

• All subscriptions continue after an FCM reboot.

This console command is: > autoSubSvcTempSaveCfgSee [on/off]


Automation Protocol Subscription Service

Setting this attribute “on” results in the temporary saving of Subscription Data that is cleared when the FCM reboots.

Note the following about this command: If this attribute is set off, and Sub-scription Service Requests are made by the Automation Controller, those subscribed-to items will be permanently saved (in FCM’s NVRAM), and restored on FCM reboot. The Controller can then ask the FCM for those values. If the Controller then sets this attribute to on, and sends new sub-scription requests, the new subscription requests will override those saved in NVRAM— but will not persist after the next reboot.




Appendix ATally Expansion

IntroductionSource 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, 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.

General Information• The tally data stream is in serial format.

• Router linked sources may not be directly tallied.

• Router linked sources are tallied by using M–2100 input tally to qualify router destinations that feed the M–2100 physical inputs.

• Router linked sources receive tally from the linking router.


Appendix A — Tally Expansion

Specifications

Physical• Processor Frame Connection

• Expansion Control Port (J23) (see Table 6)

• 9-Pin D Connector

Enabling and Setup ParametersEnabling the tally function and setting parameters for communication are set in the General Parameters form in Configuration Manager. You must enable the Tally Expansion and set the FCM-to-tally expansion system communication link using the controls provided. Refer to Section 4—System Configuration in the M–2100 Installation and Service Manual for complete details.

Table 6. Expansion Control Port Pin-Out

Shielded 9-Pin D; socket contacts Pin Expansion

Port (J23)

1 Frame GND

2 RX–

3 TX+

4 TX Com

5 Spare

6 RX Com

7 RX+

8 TX–

9 Frame GND

Shield Frame GND

D-9 Female

Pin 1

Pin 6

Pin 9Pin

5


Specifications

Packet FormatStart of Transmission (STX)

Packet Byte 1, Value = 02h

Packet Byte Count This two-byte value provides a count of the total number of bytes in the packet including the STX, and Checksum.

Packet Byte 2, BC0, value will normally be 00h.

Packet Byte 3, BC1, value in first release will be 2Ch.

Protocol Version Command CodeThe version command code (01) signifies the start of the protocol version identifier. The next two bytes specify the protocol version (e.g., 1.0)


Protocol Major Version Number


Protocol Minor Version Number


Tally Command CodeThe Tally command code (02h) signifies the start of the 40 byte Tally Expan-sion Message.


ChecksumThis one-byte value is the 2's compliment of the sum of all bytes excluding the STX.

Packet Byte 48, Value = (message dependent)

Note After the Checksum Byte, there will be a MINIMUM of 1.3 milliseconds (the equivalent to 5 characters at 38,400Bp/s) before the next byte is transmitted. Typically, the byte count should indicate the end of where the message is. If for some reason the Checksum doesn't compute, simply wait for the next gap in the byte stream to sync up.



Command Formats

Data Value LimitsValid data values within the Tally Message will be 00h – 7Fh.

Data Fields

Video PGM

Msg Byte 1

Prime Video Source (Pgm Bus Component)

Value = 00h – 10h, 00h = matte source, 01h-10h= physical input #

Msg Byte 2

Second Video Source (Preset Bus Component)

Value = 00h – 10h, 00h = matte OR no source, 01h-10h= physical input #

Msg Byte 3

Backup Pgm Video Source


Msg Byte 4, Bit Field

Bit 0, Key1: 1 = Key1 Active, 0 = Key 1 inactive




Bit 4, SqueezeBack: 1 = SqueezeBack Active,0 = SqueezeBack inactive

Bit 5, Fade-To-Black: 1= Fade to Black active,0 = Fade to Black inactive

Bit 6, Bypass: 1 = Pgm Output in Bypass Mode,0 = Normal Mode

Bit 7, Not Assigned: Always clear to 0


Command Formats

Video PST

Msg Byte 5

Prime Video Source (Preset Bus Component)

Value = 00h – 10h, 00h = matte source, 01h-10h= physical input #

Msg Byte 6

Second Video Source (Pgm Bus Component)

Value =00h – 10h, 00h = matte OR no source, 01h-10h= physical input #

Msg Byte 7

Backup Pst Video Source


Msg Byte 8 Bit Field





Bit 4, Squeeze Back: 1 = Squeeze Back Active,0 = Squeeze Back inactive

Bit 5, Fade-To-Black: 1= Fade to Black active,0 = Fade to Black inactive

Bit 6, Bypass: 1 = Pgm Output in Bypass Mode,0 = Normal Mode

Bit 7, Not Assigned: Always clear to 0

Aux 1

Msg Byte 9

Active Aux Bus 1 Source

Value = 01h – 10h, 01h-10h= physical input #



Aux 2

Msg Byte 10



Aux 3

Msg Byte 11



Aux 4

Msg Byte 12



AP1 PGM

Msg Byte 13

Prime Audio Source (Audio Pgm Bus Component)

Embedded Source Value = 00h – 10h, Direct Source Value = 11h-24h

Value = 00h indicates silent source

Msg Byte 14

Second Audio Source (Audio Pst Bus Component)


Value = 00h indicates silent source OR no source


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


Value = 00h indicates silent source OR no Backup Source

AP1 PST

Msg Byte 17

Prime Audio Source (Audio Pst Bus Component)



Msg Byte 18

Audio Over Source



Msg Byte 19

Backup Pst Audio Source





AP2 PGM

Msg Byte 20




Msg Byte 21




Msg Byte 22

Audio Over Source



Msg Byte 23




AP2 PST

Msg Byte 24





Command Formats

Msg Byte 25

Audio Over Source



Msg Byte 26




AP3 PGM

Msg Byte 27


Embedded Source Value = 00h –10h, Direct Source Value = 10h-30h11h-24h


Msg Byte 28




Msg Byte 29

Audio Over Source



Msg Byte 30






AP3 PST

Msg Byte 31




Msg Byte 32

Audio Over Source



Msg Byte 33




AP4 PGM

Msg Byte 34




Msg Byte 35





Command Formats

Msg Byte 36

Audio Over Source



Msg Byte 37




AP4 PST

Msg Byte 38

Prime Audio Source (Audio PgmBus Component)

Embedded Source Value = 00h – 10h. Direct Source Value = 11h-24h


Msg Byte 39

Audio Over Source


Value = 00 h indicates no Audio Over source selected

Msg Byte 40







Appendix BM�2100 MCP Frame Tally

IntroductionThe M–2100 MCP Frame Tally provides a serial protocol interface from the MCP (Manual Control Panel) to an external video relay device for notifica-tion of active frame (FCM) status. When multiple frames are connected to an MCP, an external relay device can tally which frame is currently active according to information sent by the MCP.

General Information• Data transfers are serial communication with RS–485 electrical inter-

faces from the M–2100.

• This feature is enabled/disabled by a vxShell Console command while connected to the Communication port on the inside of the MCP.

• The serial port (Aux 1 – 4) used for communication can be chosen using the Console command.

• Settings are stored in non-volatile memory, and remain after a reboot or power cycle.


Appendix B — M–2100 MCP Frame Tally

InstallationThe MCP Frame Tally feature is accessed through one of the four Aux ports on the rear of the panel. The control device must be connected to one of the ports and configured to communicate with the serial protocol.

Note Older version MCPs may only have two Aux ports available.

MCP Aux Ports 1 – 4The MCP Frame Tally is accessible from one of the Aux ports (1 – 4) on the back of the MCP as shown in Figure 2.

Note Aux Port 1 is dedicated to the optional Chroma Key Expert Level application and may already be in use.

Figure 2. MCP Rear View, Aux Ports 1 – 4

Power Supply 1 Power Supply 2

90-132/175-264 V~ 50/60 Hz

2A

Analog Reference

Input MCP Net

Segment Time

Time Code Outputs Remaining

Time Power Supply Alarms

Dry Contacts Aux1

Aux 2

Aux 3

Aux 4

Analog Reference

Input MCP Net

Segment Time

Time Code Outputs Remaining

Time Power Supply Alarms

Dry Contacts Aux 1

Aux 2

Aux 3

Aux 4

Note: Aux 1 is dedicatedto Chroma Key Expert LevelControl Panel if used.

Aux Port 1, 2, 3,or 4 may be used for MCP Frame Tally

0116

_01


Installation

The pinouts for Aux Port 1 – 4 are given in Table 7. 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.

Setup ParametersConnect the control device to the rear of the MCP and set the control parameters to the values listed in Table 8.

Table 7. Aux Ports 1 – 4 Pinouts

Shielded 9-Pin D; socket contacts Pin MCP

Aux 1– 4

1 Frame GND

2 RX–

3 TX+

4 TX Com

5 Spare

6 RX Com

7 RX+

8 TX–

9 Frame GND

Shield Frame GND

Table 8. Aux Port 1 – 4 Serial Control Settings

Baud 9600 bps

Data Bits 8

Parity None

Stop Bits 1

D-9 Female

Pin 1

Pin 6

Pin 9Pin

5



Enabling the MCP Frame Tally FeatureTo enable this feature on the MCP, you will need to connect a PC running HyperTerminal to the MCP motherboard configuration port inside the MCP as shown in Figure 3.

Figure 3. MCP Configuration Port

1. 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). You may purchase a suitable cable or construct one according to the typical pinout given in Table 9.

2. Launch HyperTerminal and set the serial control settings to the values listed in Table 10.

Table 9. Null Modem Cable Pinout (typical)

DB-25 DB-9 Signal Name

8 1 DCD

3 2 TXD

2 3 RXD

20 4 DTR

7 5 GND

6 6 DSR

4 7 RTS

4 8 CTS

Table 10. Serial Control Settings

Baud 9600

Data Bits 8

Parity None

Stop Bits 1

Flow Control None

Configuration Port

Motherboard

0109

_03


Protocol Definition

3. The HyperTerminal window displays a prompt asking if you wish to enter the configuration interface. Type vxShell (instead of y or n) to bring up the vxshell prompt –>.

4. At the vxShell prompt type the following command with the exact syntax shown here:

RtlCfgSee

5. To enable the function, enter a 1 (one) and then the desired port number (1 – 4). For example typing RtlCfgSee 1, 2 would enable the feature at port 2.

6. To disable the feature, enter a –1 (minus one) at the command, the port number can be entered as 0 (zero) as shown below:RtlCfgSee -1, 0

Note No check is performed to ensure that the serial port selected doesn’t interfere with any other serial port.

Protocol DefinitionThis protocol has been defined to keep an external relay device informed of the current active frame name acquired by the MCP. A solicited message is sent from the MCP to the external relay device upon receipt of a request from the relay device. 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.

Message DefinitionThere are two messages defined in this protocol:

• FCM name request (originating at the External Relay device), and

• FCM name message (originating at the MCP).

FCM Name RequestThis message is two bytes in length, having the format shown in Table 11.

Table 11. FCM Frame Name Message Format

Name Value

Sync1 0xfe

Frame Name Requested 0x20



FCM Name Message

The frame name is represented by fields name0 through name7, which contain ASCII character values. If the name has fewer than eight characters, the trailing values contain null (0x0) values.

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. A deselected frame has nulls (0x0) for all eight name values.

The FCM frame name message formats are given in Table 12.

DOS Test ProgramA DOS test program, written in C language, is available to simulates the MCP Frame Tally feature for purposes of validating the external interface to the M–2100 MCP. The test is run using a batch file named “RTL.BAT” and a program named RTL_TEST.EXE. (Source code is named RTL_TEST.C). These files are available from the Thomson Grass Valley ftp site.

To run the test program perform the following steps:

1. Open a DOS window and go to the DOS directory containing the test program.

Note The batch file RTL.BAT assumes that the PC serial port is COM 1. If the output port of the PC is Port 2, edit the batch file to include a -P2 option on the program invocation line.

Table 12. FCM Frame Name Message Format

Description Value

Sync1 0xfe

name0 (data)

name1 (data)

name2 (data)

name3 (data)

name4 (data)

name5 (data)

name6 (data)

name7 (data)

termination 0x00

state (value)

Sync2 0xdc


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.




Index

AAutomation Determinism Constant 11Automation Protocol Subscription Service 52

CCommand Formats

ALL_STOP — All Stop 40ALL_STOP (All Stop) 40AUTO_STAT — Automation Enable Status 40AUTO_STAT (Automation Enable Status) 40BREAK_AWAY — Break Away 36BREAK_AWAY (Break Away) 36CONFIG_PREROLL — Configuration Preroll

Time 41CONFIG_PREROLL (Configuration Preroll

Time) 41ERROR_STAT — Error Status 46GPI — GPI Button Operation 52KEY_ENABLE — Key Enable 39KEY_ENABLE (Key Enable) 39KEY_MOD (Key Modifier) 38KEY_STAT — Key Status 39KEY_STAT (Key Status) 39M2100_VER — FCM Sotware Version 50OVER_RATIO — Audio Over to Main Ratio 37OVER_RATIO (Audio Over to Main Ratio) 37OVER_SELECT — Audio Over Select 37OVER_SELECT (Audio Over Select) 37PREROLL — Current Preroll Time 40PREROLL (Current Preroll Time) 40PROTO_VER — Protocol Version 49REMAINING_TIME — Remaining Time

Display 42REMAINING_TIME (Remaining Time

Display) 42SUBSCR_HOLD - Hold Button Press/Release

Events 51SUBSCR_PRETRANS - Preroll/Transition

Button Press/Release Events 51SUBSCRIBE — Subscription Service 51SYSTEM_CONFIG — System Configuration

43

SYSTEM_CONFIG (System Configuration) 43SYSTEM_STAT — System Status 42SYSTEM_STAT (System Status) 42TX_NEXT — Next Transition 31TX_NEXT (Next Transition) 31TX_RATE — Selects Transition Rate 32TX_RATE (Selects Transition Rate) 32TX_START — Start Transition 31TX_STAT — Transition Status 33TX_STAT2 — Transition Status 34TX_TYPE — Selects Transition Type 32WIPE_SEL — Select Wipe Patterns 51XPT_AUDIO_MODE — Crosspoint Audio

Mode 45XPT_TAKE — Crosspoint Take 35XPT_TAKE (Crosspoint Take) 35

Command Summarycommand classes 29list of commands 30

Ddocumentation online 2

EExample 28Example 9

audio breakaway 28

FFAQ database 2Figure 2-2. TX_START - Transition Delay

Constant 15frequently asked questions 2

GGrass Valley Group website 2


Index

MMaster Control Message Protocol

definition 9format 12

Oonline documentation 2

PProtocol Examples

audio breakaway 28request transition rate 17select mix transition 16select mix transition and rate 18select wipe transition type and rate 16setup key, transition to air 21take keys on/off air 24video breakaway 27wipe transition 19

Ssoftware download from web 2Subscription Command Operation 52

Wweb site documentation 2web site FAQ database 2web site Grass Valley Group 2web site software download 2


071011606

Documents

M-2100 Automation Interface Protocol Manual