IconMasterâ„¢ Automation Interface Protocol Technical Manual

Automation Interface Protocol

Technical Manual

Edition E, for system software release 3.2 175-000319-00

Edition E, for system software release 3.2 April 2010

IconMasterAutomation Interface Protocol

Technical Manual

Copyright InformationCopyright 2007-2010 Harris Corporation, 1025 West NASA Boulevard, Melbourne, Florida 32919-0001 U.S.A. All rights reserved. This publication supersedes all previous releases. Printed in Canada.

This product and related documentation are protected by copyright and are distributed under licenses restricting their use, copying, distribution, and decompilation. No part of this product or related documentation may be reproduced in any form by any means without prior written authorization of Harris Corporation and its licensors, if any.

This publication could include technical inaccuracies or typographical errors. Changes are periodically added to the information herein; these changes will be incorporated into new editions of the publication. Harris Corporation may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time.

Warranty InformationThe limited warranty policy provides a complete description of your warranty coverage, limitations, and exclusions, as well as procedures for obtaining warranty service. To view the complete warranty, visit our website.

IconMaster Automation Interface Protocol Technical Manual iiiCopyright © 2007-2010, Harris Corporation

Contents

PrefaceManual Information ................................................................................. v

Purpose ............................................................................................. vAudience ........................................................................................... vRevision History ............................................................................... vWriting Conventions ....................................................................... viObtaining Documents ...................................................................... vi

Chapter 1: Automation System Protocol CommandsOverview ................................................................................................. 1General Information ................................................................................ 1

Automation Protocol Changes ......................................................... 1System Software Release3.2 ............................................................ 2System Software Release 2.0 ........................................................... 2System Software Release 1.5 ........................................................... 3Automation Control Port Connection .............................................. 4Enabling/Disabling Automation Control ......................................... 4

Message Protocol ..................................................................................... 5Protocol Format ................................................................................ 5

Command Summary ................................................................................ 7Command Formats ................................................................................ 10

TX_NEXT (Next Transition) ......................................................... 10TX_START (Start Transition) ....................................................... 11TX_TYPE (Select Transition Type) .............................................. 12TX_RATE (Select Transition Rate) ............................................... 13TX_STAT (Transition Status) ........................................................ 14TX_STAT2 (Transition Status) ...................................................... 15XPT_TAKE (Crosspoint Take) ...................................................... 16BREAK_AWAY (Break Away) .................................................... 17OVER_SELECT (Audio Over Select) ........................................... 18OVER_RATIO (Audio Over to Main Ratio) ................................. 19KEY_MOD (Key Modifier) ........................................................... 20KEY_ENABLE (Key Enable) ....................................................... 21KEY_STAT (Key Status) ............................................................... 22AUTO_STAT (Automatic Enable Status) ..................................... 23ALL_STOP (All Stop) ................................................................... 24

iv IconMaster Automation Interface Protocol Technical ManualCopyright © 2007-2010, Harris Corporation

Contents

PREROLL (Current Preroll Time) ................................................. 25CONFIG_PREROLL (Configuration Preroll Time) ...................... 26REMAINING_TIME (Remaining Time Display) ......................... 27SYSTEM_STAT (System Status) .................................................. 28SYSTEM_CONFIG (System Configuration) ................................ 29XPT_AUDIO_MODE (Crosspoint Audio Mode) ......................... 30GPI (GPI Button Operation) .......................................................... 31WIPE_SEL (Select Wipe Patterns) ................................................ 32ERROR_STAT (Error Status) ........................................................ 33PROTO_VER (Protocol Version) .................................................. 34M2100_VER (Software Version) ................................................... 35SUBSCRIBE (Subscription Service) ............................................. 36SUBSCR_PRETRANS (Preroll/Transition Button Press/ Release) .......................................................................................... 37SUBSCR_HOLD (Hold Button Press/Release Events) ................. 38

IconMaster Extensions .......................................................................... 39LOGO_SELECT (Select Logo Number) ....................................... 39AUX_XPT_TAKE (Aux Bus Crosspoint Take) ............................ 40LOGO_SELECT_KEY (Selects Logo and Key) ........................... 41AUDIO_GAIN (Audio Gain Change) ........................................... 42AUDIO_PROFILE (Audio Profile Select) .................................... 44

Chapter 2: Protocol ExamplesOverview 45Example 1 .............................................................................................. 46Example 2 .............................................................................................. 47Example 3 .............................................................................................. 48Example 4 .............................................................................................. 49Example 5 .............................................................................................. 50Example 6 .............................................................................................. 51Example 7 .............................................................................................. 54Example 8 .............................................................................................. 58Example 9 .............................................................................................. 59Example 10 ............................................................................................ 60Example 11 ............................................................................................ 61Example 12 ............................................................................................ 63Example 13 ............................................................................................ 64Example 14 ............................................................................................ 65Example 15 ............................................................................................ 66Example 16 ............................................................................................ 68

IconMaster Automation Interface Protocol Technical Manual vCopyright © 2007-2010, Harris Corporation

Preface

Manual Information

PurposeThis manual provides information about the automation protocol interface used in the IconMaster master control switcher system.

AudienceThis manual is written for engineers and software developers who are responsible for third party control of the IconMaster master control switcher system.

Revision History

Table P-1. Revision History of Manual

Edition Date Revision HistoryPreliminary March 2006 Preliminary release

A April 2006 Initial release

B September 2006 Selected commands added, changed, or clarified; additional example added

C December 2006 Selected commands changed or clarified

D June 2007 Selected commands added, enabled, changed or clarified

E March 2010 Updated to support version 2.1 of the Automation Protocol

vi IconMaster Automation Interface Protocol Technical ManualCopyright © 2007-2010, Harris Corporation

Preface

Writing ConventionsThis manual adheres to the following writing conventions.

Obtaining DocumentsProduct support documents can be viewed or downloaded from our website. Alternatively, contact your Customer Service representative to request a document.

Table P-2. Writing Conventions

Term or Convention DescriptionBold Indicates dialog box, property sheet, field,

button, check box, list box, combo box, menu, submenu, window, list, and selection names

Italics Indicates email addresses, names of books and publications, and first instances of new terms and specialized words that need emphasis

CAPS Indicates a specific key on the keyboard, such as ENTER, TAB, CTRL, ALT, DELETE

Code Indicates variables or command-line entries, such as a DOS entry or something you type into a field.

> Indicates the direction of navigation through a hierarchy of menus and windows.

hyperlink Indicates a jump to another location within the electronic document or elsewhere

Internet address Indicates a jump to a Web site or URL

NoteIndicates important information that helps to avoid and troubleshoot problems

IconMaster Automation Interface Protocol Technical Manual 1Copyright © 2007-2010, Harris Corporation

Chapter 1

Automation System Protocol Commands

OverviewWith automation protocol commands, an external controller can exercise control over the IconMaster using a standard M2100 or an enhanced M2100 control protocol. These commands make it possible to perform the following actions:• Set parameters that are normally set by an operator using the control panels• Execute Takes and other transitions• Query status

General InformationPlease note the following information:• Using this protocol, you do not have access to all of the parameters and

controls of a Remote Control Panel (RCP) connected to the IconMaster. • 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 RCP.

For example: If Next Transition “Key Only” is requested, the RCP cannot be in “Audio Only” mode. The RCP will be forced to the “Married” mode.

• If RCP buttons are being pressed when automation commands are received, the result will be the commands that are received first.

• If protocol commands are received that contain errors, the commands will have no effect on the system.

• When IconMaster is in transition, it will return NAK to all automation commands, except for ALL_STOP and query commands.

Automation Protocol ChangesThis section outlines the changes made to the IconMaster automation protocol. Please make note of these changes and, if necessary, update automation drivers appropriately.

2 IconMaster Automation Interface Protocol Technical ManualCopyright © 2007-2010, Harris Corporation

Chapter 1: Automation System Protocol Commands

System Software Release3.2 Commands Added

• AUDIO_PROFILEThis command can be used to associate an audio profile with a button number on the control panel.

System Software Release 2.0 Commands Added

• AUDIO_GAIN

This command can be used to set the audio gain and to mute or unmute the audio channels of selected buses.

• XPT_AUDIO_MODE

This command can be used to set the audio mode (stereo/mono), the audio phase reversal, SWAP, and SUM for the current crosspoint on selected buses and AES pairs.

Commands Clarified or Changed• XPT_TAKE

Extensions were added to the <bus> field and additional values were allowed to be assigned to the <xpt> field.

• BREAK_AWAY

Extensions were added to the <bus> field and additional values were allowed to be assigned to the <xpt> field.

• KEY_ENABLE

Additional information was added to the field information for the <keyer> field. Clarifying information was added to the notes concerning this command.

• KEY_MOD

Additional information was assigned to the field information for the <key mod> and <squeeze back> fields in the Reply form of the message.

• GPI

The <GPI#> field was extended from 8 to 18 to support IconMaster’s additional GPI inputs.

• ERROR_STAT

Clarification notes were added for the <cmd class>, <sub cmd>, <byte position>, <data>, and <arg#> fields.



• TX_TYPE

REPLY responses changed to fix incorrect <trans> parameter returned when transition type is set to TAKE.

• PROTO_VER

Updated to return 2.0 to indicate new protocol extensions.• TX_NEXT

Reply responses fixed to properly report the status of the next transition in relation to the current status of the sqeezeback key.

• KEY_STAT Reply responses fixed to properly report the status of the sqeezeback key.

• TX_STAT2 Reply responses fixed to properly report the status key (Quiescent/Transient) while a squeezeback segment is not finished

• M2100_VER Updated to return 2.0 as version number.

System Software Release 1.5This section outlines the changes made to the IconMaster automation protocol between system software releases 1.4 and 1.5. Please make note of these changes and, if necessary, update automation drivers appropriately.

Commands Clarified or Changed• TX_NEXT

Clarification notes were added to the explanation of this function of this command, and a table of values, transitions, and setup PST Bus information was included.

• KEY_ENABLE

Clarification notes were added to the explanation of this function of this command.

• OVER_SELECT

Additional notes were added to the explanation of this function of this command.

• OVER_RATIO

Clarification notes were changed for this command, and values were added to the information for the Bus Select field.

• XPT_TAKE

Clarification notes were added for the <only> field.• BREAK_AWAY

Clarification notes were added for the <only> field.



• ERROR_STAT

Clarifying information was added to the explanation of the <arg#> field.

Operational NotesWhen IconMaster is in transition, it will return NAK to all automation commands, except for ALL_STOP and query commands. Previously, IconMaster simply ignored commands while it was in transition (except for status queries).The IconMaster may take several fields to complete the XPT_TAKE or BREAK_AWAY command. After sending these commands to the IconMaster, automation systems must query the IconMaster using the ERROR_STAT command (0x20) until it receives a “NoError” response.

Automation Control Port ConnectionCommunication between an automation system and the IconMaster is accomplished via the RS-422 point-to-point serial connection from the MKE-3901 module’s MultiFunction I/O connector. For systems configured with IconMaster breakout modules, the serial connection is a DB-9 connector. See the IconMaster Master Control Switcher Hardware Installation and Configuration Manual for detailed pinout and wiring diagrams.Table 1-1 shows the default settings for the serial connection.

Enabling/Disabling Automation ControlBy default, the automation control is enabled on the IconMaster system. You can disable the automation on the RCP by pressing the Hold button located on the bottom row, far left. If the Hold button is illuminated, automation is disabled. Pressing the Hold button again will extinguish the light, and re-enable the automation control.

Table 1-1. Automation Port Serial Control Settings

Item Specification

Baud 38.4 kbps

Data bits 8

Parity None

Stop bits 1



Message ProtocolThe Master Control Message Protocol defines the low-level format of messages passed to and from the IconMaster master control system. This protocol is based on the industry standard M2100 protocol. The following modifications have been made:• IconMaster has no guaranteed determinism. Commands received by the

IconMaster will be performed as soon as they are received.• Multiple commands or queries can be formatted into a single message.• Every message returns either an ACK (0x04), NAK (0x05), or the data

requested.

Protocol FormatAn IconMaster 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.In Table 1-2 on page 6, items enclosed within < > are required, items enclosed within [ ] are optional, and the notation “...” indicates a repeat of the previous items.After the message has been received, the IconMaster will respond with one of following data types:• Acknowledge to a command <ACK> = 0x04• Data in a response to a query• Not acknowledge to a message <NAK> = 0x05



Table 1-2. Protocol Format

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

stx Start of transmission (1 byte) = 0x02

byteLen0 Byte length of the whole message (1 or 2 bytes)1 (does not include the stx, itself, or the checksum)

1 All byte counts can be encoded as one or two bytes. If the most significant bit of the first byte is set, then the byte count consists of only one byte. This encoding allows up to 127 bytes to be represented with a single byte, and up to 32,767 bytes with two bytes.

cmdClass1 Classification of command to follow (1 byte); see Table 1-4 on page 8

byteLen1 Number of bytes for cmdClass1; does not include itself (1 or 2 bytes)1

subCmd1 A command belonging to the preceding cmdClass; see Table 1-4 on page 8

cmd1Data Optional data associated with subCmd1 (variable number of bytes as defined in the protocol on a per-command basis)

checkSum Twos-complement of the sum of all bytes in the message (excluding STX)



Command SummaryTable 1-3 shows the mnemonic and value for the various Command classes.

Table 1-4 on page 8 and Table 1-5 on page 9 show the mnemonic and the value for various subcommands, as well as whether the feature is supported for commands and/or queries. Detailed information about these commands begins on page 10.

Table 1-3. Command Classes

Mnemonic Value Description

CMD 0x01 Commands are sent from Automation to the IconMaster

QUERY 0x02 Requests are sent from Automation to the IconMaster

STATUS 0x03 Status is returned to Automation from the IconMaster in response to a Query

SUBSCRIPTION 0x04 Status is returned to Automation from the IconMaster in response to a Subscription command

NoteThe automation system can use the command PROTO_VER to determine which version of the protocol the IconMaster is responding to.



Table 1-4. Summary of Subcommands

Mnemonic Value Protocol Version Cmd Query Description

TX_NEXT (page 10) 0x01 1.0 yes yes Next transition

TX_START (page 11) 0x02 1.0 yes no Start transition

TX_TYPE (page 12) 0x03 1.0 yes yes Selects transition type

TX_RATE (page 13) 0x04 1.0 yes yes Selects transition rate

TX_STAT (page 14) 0x05 1.0 no yes Transition status

TX_STAT2 (page 15) 0x15 1.3 no yes Transition status

XPT_TAKE (page 16) 0x06 1.0 yes yes Take crosspoint

BREAK_AWAY (page 17) 0x07 1.0 yes yes Breakaway

OVER_SELECT (page 18) 0x08 1.0 yes yes Audio over select

OVER_RATIO (page 19) 0x09 1.0 yes yes Audio over to main ratio

KEY_MOD (page 20) 0x0A 1.0 yes yes Key modifier

KEY_ENABLE (page 21) 0x0B 1.0 yes yes Key enable

KEY_STAT (page 22) 0x0C 1.0 no yes Key status

AUTO_STAT (page 23) 0x0D 1.0 no yes Automation enable status

ALL_STOP (page 24) 0x0E 1.0 yes yes Stop on-going transition

PREROLL (page 25) 0x0F 1.0 yes yes Current preroll time

CONFIG_PREROLL (page 26) 0x10 1.0 yes no Configuration preroll time

REMAINING_TIME (page 27) 0x11 1.0 yes no Remaining time display

SYSTEM_STAT (page 28) 0x12 Not supported System status

SYSTEM_CONFIG (page 29) 0x13 Not supported System configuration

XPT_AUDIO_MODE (page 30) 0x14 2.0 Yes yes Crosspoint audio mode

SUBSCRIBE (page 36) 0x16 1.0 yes yes Subscription service

GPI (page 31) 0x17 1.0 yes yes Set/Clear GPI button

WIPE_SEL (page 32) 0x18 Not supported Selects wipe patterns

ERROR_STAT (page 33) 0x20 1.0 no yes Error status for previous message

PROTO_VER (page 34) 0x21 1.0 no yes Protocol version

M2100_VER (page 35) 0x22 1.3 no yes Software version

SUBSCR_PRETRANS (page 37) 0x01 1.0 no no Preroll/Transition button press/Release events

SUBSCR_HOLD (page 38) 0x02 1.0 no no Hold button press/Release events



Table 1-5. IconMaster Protocol Extensions

Mnemonic Value Protocol Version Cmd Query Description

LOGO_SELECT (page 39) 0x51 1.2 yes yes Selects logo number

AUX_XPT_TAKE (page 40) 0x70 1.2 yes yes Aux bus crosspoint select

LOGO_SELECT_KEY (page 41) 0x71 1.2 yes yes Selects logo and keyer

AUDIO_GAIN (page 42) 0x72 2.0 yes yes Audio gain change

AUDIO_PROFILE (page 39) 0x74 2.1 yes yes Audio profile select



Command Formats

TX_NEXT (Next Transition)

Notes This command must always be sent before TX_START to set up the Preset bus for transition.If commands TX_NEXT and KEY_ENABLE are sent in the same field, the KEY_ENABLE command must be sent first.

Value 0x01 (unsigned byte)Command Format TX_NEXT <next trans>Query Format TX_NEXT

Reply Format TX_NEXT <next trans>Field Information <next trans> Next Transition (unsigned byte)

Bit 0 BackgroundBit 1 KeyBit 2-7 Reserved

Value Transition Setup Preset Bus

0 Audio Over Set up Background and Key to match their status on PGM; no change to Audio Over, which should be set by OVER_SELECT

1 Background + Audio Over

Set up Key to match its status on PGM; no change to Background and Audio over, which should be set by XPT_TAKE and OVER_SELECT

2 Key Set up Background and Audio Over to match their status on PGM; no change to Key, which should be set by KEY_ENABLE

3 Background + Audio Over + Key

No change; all should be set by XPT_TAKE, KEY_ENABLE, and OVER_SELECT



TX_START (Start Transition)

Notes The Video/Audio Only transition is ONLY allowed when all audio inputs are discrete; if any or all audio input is embedded, NAK will be returned.

Value 0x02 (unsigned byte)Command Format TX_START <trigger mod>Query Format IllegalReply Format NoneField Information <trigger mod> Trigger Modifier (unsigned byte)

Bit 0 Start videoBit 1 Start audioBit 2 UnusedBit 3 Zero prerollBit 4-7 Reserved

• If only the Start Video bit is set, this will cause a video-only transition.• If only the Start Audio bit is set, this will cause an audio-only transition.• If both bits are set, this will cause a regular video + audio transition.



TX_TYPE (Select Transition Type)

Notes • This command selects the Transition Type for the next transition.• <trans> = 06 (Wipe) is not supported.

Value 0x03 (unsigned byte)Command Format TX_TYPE <tran>Query Format TX_TYPE

Reply Format TX_TYPE <tran>Field Information <tran> Transition Type (unsigned byte)

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



TX_RATE (Select Transition 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 the RCP.• If a new Transition Type is selected by either the RCP or the Automation

system, any previously specified protocol rate will be overridden by the rate associated with the selected Transition Type. Therefore, the automation system must first send the desired Transition Type, and then send the Rate.

• If a Rate is selected on the RCP, it is “remembered” as associated with the currently selected (non-Cut) Transition Type. Whenever that Transition Type is selected again, the remembered Rate is recalled (Slow, Medium, or 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 not be remembered for the current Transition Type.

• <rate> greater than 300 will be reduced to the maximum transition rate of 300. No error will be reported.

Value 0x04 (unsigned byte)Command Format TX_RATE <rate type><rate>Query Format TX_RATE

Reply Format TX_RATE <rate type><rate>Field Information <rate type> Rate Type (unsigned byte)

00 Rate value to be used01 Slow02 Medium03 Fast04 No Rate (For replies only – No Rate currently selected)<rate> Transition Rate (unsigned two bytes)00 through 300 frames



TX_STAT (Transition Status)

Notes Status of transition at the time this query was receivedValue 0x05 (unsigned byte)Command Format IllegalQuery Format TX_STAT

Reply Format TX_STAT <video><ap1><ap2><ap3><ap4><hold>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 Status)

Notes Status of the transition at the time this query was received.Value 0x15 (unsigned byte)Command Format IllegalQuery Format TX_STAT2

Reply Format TX_STAT2 <video><keyer><ap1><ap2><ap3><ap4><hold>

Field Information <video> Transition Video Status (unsigned byte)01 Quiescent02 Preroll03 Transitional04 Fading To Black05 Fading From Black06 In Black

<keyer> Keyer 1-6 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



XPT_TAKE (Crosspoint Take)

Notes • The audio/video breakaway is ONLY allowed when all audio inputs are discrete; if any or all audio input is embedded, NAK will be returned.

• The XPT_TAKE command will clear any Audio Over that may be selected.

• Only one of the Program Bus, Preset Bus, or Aux Busses can be selected.• For a Program Bus Take or a Preset Bus Take, if the Audio is not set, the

operation will cause an audio/video breakaway, and only the video will be switched.

• XPT_TAKE on the Program Bus needs some time to set up the switch; during this period of time, NAK will be returned to all automation commands, but not queries. ERROR_STAT can be queried to know when XPT_TAKE on the Program Bus is completed.

• Automation XPT Behaviour is set by the IconMaster Configuration Utility. For backward compatibility with pre-2.0 IconMaster firmware, ensure this setting is in Logical mode.

Value 0x06 (unsigned byte)Command Format XPT_TAKE <bus> <xpt> <only>Query Format XPT_TAKE <bus>Reply Format XPT_TAKE <bus> <xpt> <only>Field Information <bus> Bus Select (unsigned two bytes)

Bit 0 Program BusBit 1 Preset BusBit 2 AudioBit 3-5 UnusedBit 6 Aux 1 BusBit 7 Aux 2 BusBit 8 Aux 3 BusBit 9 Aux 4 BusBit 10-12 ReservedBit 13-15 XPT number extension bits (see <xpt> below)

<xpt> Crosspoint (unsigned byte)00 No Change01-12 or 01-22 IconMaster Input Number (when Iconmaster’s Automation XPT Behaviour is configured to run in Logical IconMaster Inputs mode)OR01-255 Primary Router Crosspoint Number (when Iconmaster’s Automation XPT Behaviour is configured to run in Physical Router Inputs mode)To access Primary Router Crosspoints 256 through 2047, the <xpt> value is extended using <bus> bits 13-15 as <xpt> bits 8-10.

<only> (unsigned byte) (not supported)



BREAK_AWAY (Break Away)

Notes • The audio/video breakaway is ONLY allowed when all audio inputs are discrete; if any or all audio input is embedded, NAK will be returned.

• The BREAK_AWAY command will clear any Audio Over that may be selected.

• This command operates differently from GVG-M2100: BREAK_AWAY will affect all audio channels of a source, not just the specified channels (parameter <only> is ignored).

• Only one of Program Bus or Present Bus can be selected.• BREAK_AWAY on the Program Bus needs some time to set up the switch;

during this period of time, NAK will be returned to all automation commands, but not queries. ERROR_STAT can be queried to know when BREAK_AWAY on the Program Bus is completed.

• Automation XPT Behaviour is set by the IconMaster Configuration Utility. For backward compatibility with pre-2.0 IconMaster firmware, ensure this setting is in Logical mode.

Value 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>Field Information <type> Break Away Type (unsigned byte)

01 Video02 Audio

<bus> Bus Select (unsigned two bytes)Bit 0 Program BusBit 1 Preset BusBit 2-12 ReservedBit 13-15 XPT number extension bits (see <xpt> below)

<xpt> Crosspoint (unsigned byte)00 No Change01-12 or 01-22 IconMaster Input Number (when Iconmaster’s Automation XPT Behaviour is configured to run in Logical IconMaster Inputs mode)OR01-255 Primary Router Crosspoint Number (when Iconmaster’s Automation XPT Behaviour is configured to run in Physical Router Inputs mode)To access Primary Router Crosspoints 256 through 2047, the <xpt> value is extended using <bus> bits 13-15 as <xpt> bits 8-10.

<only> (unsigned byte) (not supported)



OVER_SELECT (Audio Over Select)

Notes • This command selects the AO on or off air after the next transition.• Selecting an AO (bit=1) at the next transition will take an off-air AO

on-air, or leave an on-air AO on-air. Setting (bit=0) has a similar, but complementary effect.

• Selecting an AO (bit=1) for a currently off-air AO will cause that AO to be heard on the PST bus.

• This command should be sent after XPT_TAKE or BREAK_AWAY command to prevent clearing AO selection.

• This command operates differently from GVG-M2100: the parameter <over> selects the logical source (AO1 or AO2), not the physical AES Audio Over input. AES Audio Over inputs can be freely assigned to logical AO1 or AO2.

Value 0x08 (unsigned byte)Command Format OVER_SELECT <bus> <over>Query Format OVER_SELECT <bus>Reply Format OVER_SELECT <bus> <over>Field Information <bus> Bus Select (unsigned two bytes)

01 Query status on Program Bus02 Query status on Preset bus

The bus field is ignored in command format. It is only valid in query format.<over> Over Select (unsigned byte)

Bit 0 Audio Over 1Bit 1 Audio Over 2Bit 2-7 Reserved

If <over> = 0, then Audio Over is cleared on the Preset Bus.



OVER_RATIO (Audio Over to Main Ratio)

Notes This command sets the Over ratio for all audio over(s) on the selected bus.Value 0x09 (unsigned byte)Command Format OVER_RATIO <bus> <ratio>Query Format OVER_RATIO <bus>Reply Format OVER_RATIO <bus> <ratio>Field Information <bus> Bus Select (unsigned two bytes)

Bit 0 Program BusBit 1 Preset BusBit 2–5 UnusedBit 6–15 Reserved

<ratio> Ratio (unsigned byte)0 through 100, where 0 is full audio, 100 is full OVER, and 50 is an equal mix of both



KEY_MOD (Key Modifier)Notes • Selects parameters for the various external keyers

• Modifies external keys• One or more keys must be selected.• <squeeze back> field is valid ONLY when squeeze back Bit is

set in the keyer field.• Only one keyer in the <keyer> parameter can be set in the QUERY

format of this command. Value 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>Field Information <keyer> Keyer Select (unsigned byte)

Bit 0 Keyer1Bit 1 Keyer2Bit 2-3 UnusedBit 4 SqueezeBackBit 5-7 Reserved

<key mod> Key Modifier (unsigned byte)Bit 0 (0=Self, 1=External)Bit 1 (0=Matte, 1=Video)Bit 2-4 UnusedBit 5-7 Reserved for COMMAND and QUERY formats. For REPLY format, if <keyer> bit 4 (squeezeback) is set, <key mod> bits 5-7 will return the number of segments in the squeezeback effect minus one. For example, if the effect has 1 segment, <key_mod> = 0x00. If the effect has 3 segments, <key_mod> = 0x40 (bits 5-7 = 2). This way, the parameter is fully backwards compatible for single-segment effects

<squeeze back> SqueezeBack Position (unsigned byte)Bits 0-5

00 No Change01 through 16 for Effect 1 through Effect 16

Bits 6-7 Reserved (0) for COMMAND format. For REPLY format, these bits indicate additional effect information:

Bit 6 (0=External background, 1=PST background)Bit 7 (0=1 channel effect, 1=2 channel effect)



KEY_ENABLE (Key Enable)

Notes • This command 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 an on-air key on-air. Setting (bit=0) has a similar, but complementary effect.

• Selecting a Keyer (bit=1) for a currently off-air Keyer will cause that Key to be seen on the Preset bus.

• When querying KEY_ENABLE, it returns the Keyer status on the Preset bus.

• For this command to take effect on the next transition, a TX_NEXT command must be sent AFTER this KEY_ENABLE command.

• One or more keys must be selected.• The TX_NEXT command must follow after the KEY_ENABLE

command.• Squeeze Back Suspend is supported in protocol version 2.1 and later.

Value 0x0B (unsigned byte)Command Format KEY_ENABLE <keyer>

Query Format KEY_ENABLE

Reply Format KEY_ENABLE <keyer>

Field Information <keyer> Keyer Select (unsigned byte)Bit 0 Keyer 1Bit 1 Keyer 2Bit 2 Keyer 3Bit 3 Keyer 4Bit 4 SqueezeBackBit 5 Keyer 5Bit 6 Keyer 6Bit 7 will be used to request an effect change to the next segment. If bit 4 is set (squeezeback bit), then bit 7 may also be set.If bit 4 and bit 7 are both set, any effect prepared or in progress will proceed to the next segment at the next transition. If the effect is already at the last segment, the effect will hold at that state. The effect will not be taken off-air if bit 4 is set.



KEY_STAT (Key Status)

Notes This command returns status for keyers that are on the Program Bus.Value 0x0C (unsigned byte)Command Format IllegalQuery Format KEY_STAT

Reply Format KEY_STAT <status>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 Keyer 5Bit 6 Keyer 6Bit 7 Reserved



AUTO_STAT (Automatic Enable Status)

Notes When the Automation Interface is disabled, commands will be acknowledged, but not executed. Queries sent to the IconMaster when the interface is disabled will still be honored.

Value 0x0D (unsigned byte)Command Format IllegalQuery Format AUTO_STAT

Reply Format AUTO_STAT <status>Field Information <status> Status (unsigned byte)

00 Disabled01 Enabled



ALL_STOP (All Stop)

Notes This command stops all on-going transitions and resets the system to a known state.

Value 0x0E (unsigned byte)Command Format ALL_STOP <options>Query Format IllegalReply Format NoneField 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 to crosspoint #1 (normally black)Bit 5-7 Reserved



PREROLL (Current Preroll Time)

Notes This command 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

Value 0x0F (unsigned byte)Command Format PREROLL <preroll>Query Format PREROLL

Reply Format PREROLL <preroll>PST bus status and current preroll values

Field Information <preroll> Preroll value (unsigned two bytes)0 through 600 frames



CONFIG_PREROLL (Configuration Preroll Time)

Notes This command 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.

Value 0x10 (unsigned byte)Command Format CONFIG_PREROLL <xpt> <only> <keyer> <preroll>Query Format IllegalReply Format NoneField Information <xpt>Crosspoint (unsigned byte)

00 No Change01 –12 Crosspoint number255 Select all sources

<only> Audio Only Select (unsigned byte) (ignored)<keyer> Keyer Select (unsigned byte)

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

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



REMAINING_TIME (Remaining Time Display)

Notes • This command jams the Remaining Time display on the RCP. Optionally, the time can be commanded to begin decrementing.

• If the most significant Bit of the hour Ten’s digit is set (Bit 7 of Byte 1), the displayed remaining time will begin decrementing

Value 0x11 (unsigned byte)Command Format REMAINING_TIME <remaining time>Query Format IllegalReply Format NoneField Information <remaining time> Remaining Time (unsigned 4 bytes in BCD format)

Byte 1Bit 0-3 Ones digit - HourBit 4-6 Tens digit - HourBit 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



SYSTEM_STAT (System Status)

Notes UnsupportedValue 0x12 (unsigned byte)Command Format IllegalQuery Format SYSTEM_STAT

Reply Format SYSTEM_STAT <status>



SYSTEM_CONFIG (System Configuration)

Notes UnsupportedValue 0x13 (unsigned byte)Command Format IllegalQuery Format SYSTEM_CONFIG

Reply Format SYSTEM_CONFIG <config>



XPT_AUDIO_MODE (Crosspoint Audio Mode)

Notes This command is used to set the audio mode (stereo/mono), the audio phase reversal, SWAP and SUM for the current crosspoint on the SELECTED bus(es) and AES pairs.

Value 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>Field Information <bus> Bus Select (unsigned two bytes)

Bit 0 Program bus Bit 1 Preset busBit 2 Audio Processor 1 (AES 1)Bit 3 Audio Processor 2 (AES 2)Bit 4 Audio Processor 3 (AES 3)Bit 5 Audio Processor 4 (AES 4)Bit 6 Audio Processor 5 (AES 5) (Note 1*)Bit 7 Audio Processor 6 (AES 6) (Note 1*)Bit 8 Audio Processor 7 (AES 7) (Note 1*)Bit 9 Audio Processor 8 (AES 8) (Note 1*)

<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)4 Sum: Adds right + left channel and assign the mono result to both channels5 Swap: Swaps right and left channels

<phase> Phase Reverse (unsigned byte)0 No change1 Set to Phase Normal2 Set to Phase reverse

Additional Notes * Note 1: <bus> bits 6 through 9 are extensions of the original M2100 protocol, allowing access to AES channels 5 through 8 for 16 channel IconMaster systems. Example: Setting the PGM source AES 2 & 3 to Stereo and Phase reverse. The XPT_AUDIO_MODE part of the command will be 0x14 0x19 0x01 0x02



GPI (GPI Button Operation)

Notes GPI commands trigger the specified GPI functions assigned to the IconMaster. GPI button operations occur according to the current GPI configuration mode. Set/clear operations do not correspond to press/release; set/clear operations incorporate both button press and release, and treat the GPI button as on or off, as specified in the automation command (true/false) and according to GPI mode.

Value 0x17 (unsigned byte)Command Format GPI <GPI#><true/false>Query Format GPI <GPI#>Reply Format GPI <GPI#><true/false>Field Information <GPI#> GPI button (unsigned byte)

00 No Change01 through 18 GPI 1 through GPI 18



WIPE_SEL (Select Wipe Patterns)

Notes UnsupportedValue 0x18 (unsigned byte)Command Format WIPE_SEL <wipe pattern> <wipe mod> <soft value>Query Format WIPE_SEL

Reply Format WIPE_SEL <wipe pattern> <wipe mod> <soft value>



ERROR_STAT (Error Status)

Notes IconMaster needs to take some time to process XPT_TAKE and BREAK_AWAY commands on PGM bus. In this process, IconMaster is busy and returns NAK to all automation commands, except for query commands. After sending an XPT_TAKE or BREAK_AWAY on PGM bus query ERROR_STAT before sending any other command until the error code is 0.

Value 0x20 (unsigned byte)Command Format IllegalQuery Format ERROR_STAT

Reply Format ERROR_STAT <err code> <cmd class> <sub cmd> <byte position> <data> <arg#>

Field Information <err code> Error Code (unsigned byte)00 No error20 System is busy

<cmd class> (unsigned byte) (not supported)<sub cmd> (unsigned byte) (not supported)<byte position> (unsigned two bytes) (not supported)<data> (unsigned four bytes) (not supported)<arg#> (unsigned byte) (not supported)



PROTO_VER (Protocol Version)

Notes • This query is provided so that the automation controller of the IconMaster can determine which version of the IconMaster protocol is being used. The IconMaster 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 communications line. Any time 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 communications line.

• See Table 1-4 on page 8 and Table 1-5 on page 9 for specific information on supported commands and PROTO_VER returned version numbers.

Value 0x21 (unsigned byte)Command Format IllegalQuery Format PROTO_VER <major> <minor>Reply Format PROTO_VER <major> <minor>Field Information <major> (unsigned byte)

In the query format of PROTO_VER, the major field indicates the major protocol version that the automation controller is using. In the reply format, the field indicates the major protocol version that the IconMaster is using.<minor> (unsigned byte)In the query format of PROTO_VER, the minor field indicates the minor protocol version that the automation controller is using. In the reply format, the field indicates the minor protocol version that the IconMaster is using.



M2100_VER (Software Version)

Notes This query is provided to identify the software version running on the IconMaster.

Value 0x22 (unsigned byte)Command Format IllegalQuery Format M2100_VER <major> <minor>Reply Format M2100_VER <major> <minor>Field Information <major> (unsigned byte)

<minor> (unsigned byte)



SUBSCRIBE (Subscription Service)

Notes • The 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 This 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 Controller will be sent a protocol message whenever the Preroll/Take button is pressed or released.

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

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

Value 0x16 (unsigned byte)Command Format SUBSCRIBE <subscription bits>Query Format SUBSCRIBE

Reply Format SUBSCRIBE <subscription bits>Field Information <subscription bits> (unsigned four bytes)

Bit 0 Preroll/Take Event (Whenever the user presses or releases Preroll Take, any subscriber to this event will be notified as described below.)Bit 1 Hold Event (Whenever the user presses or releases Hold, any subscriber to this event will be notified as described below)bits 2-31 Reserved for future subscription items



SUBSCR_PRETRANS (Preroll/Transition Button Press/ Release)

Notes If this information is currently subscribed-to, it is sent to the Automation Controller when the user presses/releases the RCP’s Preset/Preroll button. Normal Preroll/Transition logic in the frame controller is not executed.

Value 0x01 (unsigned byte)Command Format SUBSCR_PRETRANS <press/release flag>Field Information <press/release flag> (unsigned byte)

00 Preroll/Trans Button released01 Preroll/Trans Button pressed



SUBSCR_HOLD (Hold Button Press/Release Events)

Notes If this information is currently subscribed-to, it is sent to the Automation Controller when the user presses/releases the RCP’s Hold button. Normal Hold logic in the frame controller is not executed.

Value 0x02 (unsigned byte)Command Format SUBSCR_HOLD <press/release flag>Field Information <press/release flag> (unsigned byte)

00 Hold Button released01 Hold Button pressed



IconMaster ExtensionsThese commands are IconMaster specific extensions, and are not typically supported by legacy GVG M2100 Protocol Automation Systems.

LOGO_SELECT (Select Logo Number)

Notes Select logo (1-255) for Key 3Value 0x51 (unsigned byte)Command Format LOGO_SELECT <logo>Query Format LOGO_SELECT

Reply Format LOGO_SELECT <logo>Field Information <logo> Logo Number (unsigned byte)

1 through 255, 0 will be returned if no logo selected.



AUX_XPT_TAKE (Aux Bus Crosspoint Take)

NotesValue 0x70 (unsigned byte)Command Format AUX_XPT_TAKE<bus><xpt>

Query Format AUX_XPT_TAKE<bus>

Reply Format AUX_XPT_TAKE<bus><xpt>

Field Information <bus> Bus Select (unsigned byte)1 through 12, Aux Bus 1 to 12

<xpt> Crosspoint (unsigned byte)00 No Change01-12 Crosspoint Number



LOGO_SELECT_KEY (Selects Logo and Key)

Notes Selects logo (1-999) for key3 through key6Value 0x71Command Format LOGO_SELECT_KEY <key number> <logo>Query Format LOGO_SELECT_KEY <key number>Reply Format LOGO_SELECT_KEY <key number> <logo>Field Information <key number> Key Number (unsigned byte)

3 through 6 for Key3 through Key6<logo> Logo Number (unsigned two bytes)

1 through 999, 0 will be returned if no logo is selected



AUDIO_GAIN (Audio Gain Change)

Notes This command is used to set the audio gain and to mute/unmute the audio channels of the SELECTED bus(es)

Value 0x72 (unsigned byte)Command Format AUDIO_GAIN <bus> <channel> <gain> <mode>

Query Format AUDIO_GAIN <bus> <channel>

Reply Format AUDIO_GAIN <bus> <channel> <gain> <mode>

Field Information <bus> Bus Select (unsigned byte)Bit 0 Program bus Bit 1 Preset busBit 2 Audio Over 1Bit 3 Audio Over 2Bit 4-7 Reserved (set to 0)

<channel> Channel select (unsigned two bytes)Bit 0 Select audio channel 1Bit 1 Select audio channel 2Bit 2 Select audio channel 3Bit 3 Select audio channel 4Bit 4 Select audio channel 5Bit 5 Select audio channel 6Bit 6 Select audio channel 7Bit 7 Select audio channel 8Bit 8 Select audio channel 9 Bit 9 Select audio channel 10Bit 10 Select audio channel 11Bit 11 Select audio channel 12Bit 12 Select audio channel 13Bit 13 Select audio channel 14Bit 14 Select audio channel 15Bit 15 Select audio channel 16

<gain> Gain value (signed two bytes) This value represents the relative gain, in number of 0.1 dB units by which the current gain of the selected channels will be increased or decreased. The way this value is interpreted depends on the setting of bits 0 and 1 from the <mode> field. The gain range of IconMaster is +12 dB (<gain> = 120) to -108 dB (<gain> = -1080).



<mode> (unsigned byte) This value selects the gain mode and selects mute options.Bit 0-1 Mute mode

Bit 1 | Bit 0 ---------------0 | 0 -- NO CHANGE in Mute mode0 | 1 -- MUTE selected channels1 | 1 -- UNMUTE selected channels

Bit 2- 3 Gain mode; sets the way the <gain> field will be interpreted.Bit 3 | Bit 2 ---------------0 | 0 -- NO CHANGE in gain (ignore the <gain> field)0 | 1 -- ABSOLUTE gain mode (<gain> is an absolute value, in dB) 1 | 1 -- RELATIVE gain mode. (<gain> value is a relative value that will be added to the current value of the gain on the selected channels; note that the <gain> field caries a SIGNED value, so if the gain values is negative, this command will decrease the gain on the channel)

Bit 4-7 - unused (set to 0)Examples Example 1: Set channels 1-4 of the PST bus source to an absolute gain

setting of 1.0 dB, and mute the channels. The command will be 0x72 0x02 0x00 0x0F 0x00 0x0A 05.Example 2: Increase the gain by 0.6 dB on channels 1 and 2 of the PGM and AO1 buses, and unmute them. The command will be 0x72 0x05 0x00 0x03 0x00 0x06 0x0F.



AUDIO_PROFILE (Audio Profile Select)

Notes This command is used to associate an audio profile with a button number on the control panel.When the button number is higher than 21, the command is not executed. When the audio profile number is higher than 15, the command is not executed, and and NAK is returned in response to the Command or Query.

Value 0x74 (unsigned byte) Command Format AUDIO_PROFILE <button number> <audio profile number>

Query Format AUDIO_PROFILE <button number>

Reply Format AUDIO_PROFILE <button number> <audio profile number>

Field Information <button number> Button Number (unsigned byte) Button number Range 0 - 21<audio profile number> Audio Profile Range 0 - 15


Chapter 2

Protocol Examples

OverviewThe following examples demonstrate the message format for the IconMaster Automation Protocol. The AUTO —> IconMaster symbol in the example indicates that Automation is transmitting to the Master Control. The IconMaster —> AUTO symbol in the example indicates Master Control is transmitting to Automation.


Chapter 2: Protocol Examples

Example 1A single command from the automation system selects a Mix transition type. AUTO —> IconMaster[02] STX Start of transmission[84] Byte Count message byte count1

1 The Most Significant Bit is set, indicating a 1 byte count.

[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 checksumIconMaster —> AUTO[04] ACK Acknowledge to message



Example 2Two commands from the automation system select a Fade transition type and a Transition Rate of 30 frames.AUTO —> IconMaster[02] STX Start of transmission[00] Byte 0 Message byte count MSB[09] Byte 1 Message byte count LSB[01] CMD Classification of commands to follow[00] Byte 0 Message byte count MSB[06] Byte 1 Message byte count LSB[03] TX_TYPE Transition Type command[02] Fade-Fade 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[c1] Checksum Message checksumIconMaster —> AUTO[04] ACK Acknowledge to message



Example 3A single query from the automation system requests the current transition rate.AUTO —> IconMaster[02] STX Start of transmission[00] Byte 0 Message byte count MSB[04] Byte 1 Message byte count LSB[02] QUERY Classification of queries to follow[00] Byte 0 Message byte count MSB[01] Byte 1 Message byte count LSB[04] TX_RATE Transition rate query[F5] Checksum Message checksumIconMaster —> AUTO[02] STX Start of transmission[00] Byte 0 Message byte count MSB[07] Byte 1 Message byte count LSB[03] STATUS Classification of status to follow[00] Byte 0 Message byte count MSB[04] Byte 1 Message byte count LS[04] TX_RATE Transition rate reply[00] RATE Current rate selected[00] Byte 0 Transition rate value MSB[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 —> IconMaster[02] STX Start of transmission[00] Byte 0 Message byte count MSB[0e] Byte 1 Message byte count LSB[01] CMD Classification of commands to follow.[00] Byte 0 Message byte count MSB[06] 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[00] Byte 0 Message byte count MSB[02] Byte 1 Message byte count LSB[03] TX_TYPE Transition type query[04] TX_RATE Transition rate query[d4] Checksum Message checksum: two’s

complement, excluding STX.IconMaster —> AUTO[02] STX Start of transmission[00] Byte 0 Message byte count MSB[09] Byte 1 Message byte count LSB[03] STATUS Classification of commands to follow[00] Byte 0 Message byte count MSB[06] Byte 1 Message byte count LSB[03] TX_TYPE Transition type reply[04] MIX Current transition type[04] TX_RATE Transition rate reply[01] SLOW Current rate selected[00] Byte 0 Transition rate value MSB[2c] Byte 1 Transition rate value LSB (rate of 60

currently being used for SLOW)[b7] Checksum Message checksum: two’s

complement excluding STX



Example 5A single command from the automation system selects a Wipe transition type. The IconMaster returns an error, because the Wipe Option is not available.AUTO —> IconMaster[02] STX Start of transmission[00] Byte 0 Message byte count MSB[05] Byte 1 Message byte count LSB[01] CMD Classification of commands to follow[00] Byte 0 Message byte count MSB[02] Byte 1 Message byte count LSB[03] TX_TYPE Transition Type command[06] WIPE Transition Type selection (note:

assume the option is not available)[ef] Checksum Message checksum: two’s

complement, excluding STXIconMaster —> AUTO[05] NAK Not acknowledge to message



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 —> IconMaster[02] STX Message[86] Byte Count message byte count[01] CMD Classification of commands to follow[84] 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 checksumIconMaster —> AUTO[04] ACK Acknowledge to message Next, enable Keyer 1

AUTO —> IconMaster[02] STX[84] Byte Count[01] CMD[82] Byte Count[0B] KEY_ENABLE[01] <keyer>[ED] ChecksumIconMaster —> AUTO[04] ACK Acknowledge to message



Example 6 (continued)Next, set the transition type to Key or Key/Background. The example below assumes a Key only transition. AUTO —> IconMaster[02] STX[84] Byte Count[01] CMD[82] Byte Count[01] TX_NEXT[02] <next trans>[F6] ChecksumIconMaster —> AUTO[04] ACK

Finally, start the transition.

AUTO —> IconMaster[02] STX[84] Byte Count[01] CMD[82] Byte Count[02] TX_START[02] <rigger mod>[F5] ChecksumIconMaster —> AUTO[04] ACK



Example 6 (continued)You can also perform all of the previous commands in two messages by using the multiple command facility of the automation protocol.AUTO —> IconMaster[02] STX Start of message[8A] Byte Count message byte count[01] CMD Classification of commands to follow[88] 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[0B] KEY_ENABLE Enable keyer command[01] <keyer> Keyer number[01] TX_NEXT Transition Type command[02] <next trans> Transition Type selection[D0] Checksum Message checksumIconMaster —> AUTO[04] ACK Acknowledge to messageAUTO —> IconMaster[02] STX Start of message[84] Byte Count Message byte count[01] CMD Classification of commands to follow[82] Byte Count Message byte count[02] TX_START Transition Start command[02] <trigger mod> Transition Start selection[F5] Checksum Message checksumIconMaster —>AUTO[04] ACK Acknowledge to message



Example 7The following example demonstrates how to determine which keys are on-air, and then take them off-air. It is assumed that Keyer number 1 and 2 are on-air. The first step is to obtain the key status, as described below:AUTO —> IconMaster[02] STX Start of message [83] Byte Count Message byte count[02] QUERY Classification of queries to follow [81] Byte Count Message byte count[0C] KEY_STAT Key status query [EE] Checksum Message checksumIconMaster —> AUTO[02] STX Start of message [00] Byte Count 0 Message byte count MSB[05] Byte Count 1 Message byte count LSB[03] STATUS Classification of status to follow [00] Byte Count 0 Message byte count MSB[02] Byte Count 1 Message byte count LSB[0C] KEY_STAT Key status reply



Example 7 (continued)Next, set the transition type to Key or Key/Background. The example below assumes a Key only transition. You must execute this command before querying the KEY_ENABLE status, as the KEY_ENABLE status indicates which Keyers will be on-air after the next transition

The next step is to determine which keys are enabled. This prevents the disabling of a key that is intended to go on-air at the next transition. In this example, it is assumed that Keyer number 4 is enabled to go on-air at the next transition.

AUTO —> IconMaster[02] STX[84] Byte Count[01] CMD[82] Byte Count[01] TX_NEXT[02] <next trans>[F6] ChecksumIconMaster —> AUTO[04] ACK

NoteYou must ensure that the TX_NEXT command described here and on the following page are sent in different video fields. The KEY_ENABLE command checks the state of the Next Transition, and if it is not set to Key, it toggles the button state. There can be a race condition with the TX_NEXT command that will toggle the key transition off.

AUTO —> IconMaster[02] STX Start of message[83] Byte Count Message byte count [02] QUERY Classification of queries to follow[81] Byte Count Message byte count[0B] KEY_ENABLE Key enable query[EF] Checksum Message checksum



Example 7 (continued)

Next, enable Keyers 1, 2, and 4. (Keyer 4 is being enabled because it was already enabled.) The KEY_ENABLE command communicates to the switcher what state the Keyers should be in, after the next transition. Thus, the value inserted in the <keyer> field is not Keyer Number 1, 2 & 4 (0x0B) but instead, Keyer 4 (0x08). (After the transition, only Keyer 4 is to be on-air.)A simple boolean expression provides 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 Thus, for the example the expression is: x = (NOT 0x03) AND 0x0B => x = 0xfC AND 0x0B => x = 0x08

IconMaster —> AUTO[02] STX[00] Byte Count 0 Message byte count MSB[05] Byte Count 1 Message byte count LSB[03] STATUS Classification of status to follow[00] Byte Count 0 Message byte count MSB[02] Byte Count 1 Message byte count LSB[0B] KEY_ENABLE Key status reply[0B] <keyer> Keyer[E0] Checksum Message checksum



Example 7 (continued)AUTO —> IconMaster[02] STX[84] Byte Count[01] CMD[82] Byte Count[0B] KEY_ENABLE[08] <keyer>[E6] ChecksumIconMaster —> AUTO[04] ACK

Finally, start the transition.

AUTO —> IconMaster[02] STX [84] Byte Count [01] CMD [82] Byte Count [02] TX_START [02] <trigger mod> [F5] Checksum IconMaster —> AUTO[04] ACK



Example 8The following is an example of a video breakaway to crosspoint 3 on the Program bus.AUTO —> IconMaster[02] STX Start of message[88] Byte Count Message byte count[01] CMD Classification Command to follow[86] Byte Count Message byte count[07] BREAK_AWAY Breakaway command[01] <type> Breakaway type video[00] <bus> Bus select MSB[01] <bus> Bus select LSB (Program Bus

selected)[03] <xpt> Breakaway to crosspoint 3[00] <only> No change to Audio Only crosspoints[E5] Checksum Message checksumIconMaster —> AUTO[04] ACK Acknowledge to message



Example 9The following is an example of an audio breakaway to crosspoint 9 on the Preset bus.AUTO —> IconMaster[02] STX Start of message[88] Byte Count Message byte count[01] CMD Classification Command to follow[86] Byte Count Message byte count[07] BREAK_AWAY Breakaway command[02] <type> Breakaway 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 Audio Only crosspoints[DD] Checksum Message checksumIconMaster —> AUTO[04] ACK Acknowledge to message



Example 10The following example shows how to recall two logos: logo 12 into key layer 3, and logo 47 into key layer 5:AUTO —> IconMaster[02] STX Start of message[88] Byte Count Message byte count[01] CMD Classification Command to follow[86] Byte Count Message byte count[71] LOGO_SELECT_KEY Select Logo and Key message[03] <key number> Key layer 3[0C] <logo> Select logo # 12[71] LOGO_SELECT_KEY Select Logo and Key message[05] <key number> Key layer 5[2F] <logo> Select logo # 47[CC] Checksum Message checksumIconMaster —> AUTO[04] ACK Acknowledge to message



Example 11The following example shows how to put Audio Over 1 on-air and query the Audio Over status on the Program Bus.• Select Audio Over 1 in next transition (on Preset Bus)

• Clear background and key in next transition (this will do Audio Over only):

AUTO —> IconMaster[02] STX[00] Byte Count 0[07] Byte Count 1[01] CMD[00] Byte Count 0[04] Byte Count 1[08] OVER_SELECT[00] <bus> MSB[00] <bus> LSB[01] <over>[EB] ChecksumIconMaster —> AUTO[04] ACK

AUTO —> IconMaster[02] STX[00] Byte Count 0[05] Byte Count 1[01] CMD[00] Byte Count 0[02] Byte Count 1[01] TX_NEXT[00] <next trans>[F7] ChecksumIconMaster —> AUTO[04] ACK



Example 11 (continued)• Start transition to put Audio Over 1 on-air (Program Bus):

• Query Audio Over status on Program Bus

AUTO —> IconMaster[02] STX[00] Byte Count 0[05] Byte Count 1[01] CMD[00] Byte Count 0[02] Byte Count 1[02] TX_START[03] <trigger mode>[F3] ChecksumIconMaster —> AUTO[04] ACK

AUTO —> IconMaster[02] STX[00] Byte Count 0[06] Byte Count 1[02] QUERY[00] Byte Count 0[03] Byte Count 1[08] TX_START[00] <bus> MSB[01] <bus> LSB[EC] ChecksumIconMaster —> AUTO[02] STX[00] Byte Count 0[07] Byte Count 1[03] STATUS[00] Byte Count 0[04] Byte Count 1[08] TX_START[00] <bus> MSB[01] <bus> LSB[01] <over>[E8] Checksum



Example 12The following is an example of how to put a one-segment Squeezeback effect on-air, and take it off-air.• Setup to put effect on-air and transition

• Setup to take effect off and transition

KEY_ENABLE with SqueezeBack bit set CMD = 0B 10KEY_MOD with SqueezeBack bit set, and <squeezeback> parameter = effect number

CMD = 0A 10 02 04 (for effect # 4)

TX_NEXT with Key bit set CMD = 01 02TX_START will transition the effect to PGM

CMD = 02 03

KEY_ENABLE with SqueezeBack bit CLEAR

CMD = 0B 00

TX_NEXT with Key bit set CMD = 01 02TX_START will transition the effect off PGM CMD = 02 03



Example 13The following is an example of the same Squeezeback effect as in Example 12, but this time hold on-air and transition new PST to PGM• Setup to put effect on-air and transition

• Setup to keep effect on-air, select new PST source, and transition



CMD = 0A 10 02 04 (for effect # 4)

TX_NEXT with Key bit set CMD = 01 02TX_START will transition the effect to PGM CMD = 02 03

KEY_ENABLE with SqueezeBack bit STILL SET

CMD = 0B 10

TX_NEXT with Background bit set CMD = 01 01XPT_TAKE with Preset bit set, and <xpt> to select new source

CMD = 06 00 02 07 (for crosspoint # 7)

TX_START will transition the new source to PGM, leaving effect on PGM (FX are “suspended”)

CMD = 02 03


CMD = 0B 00




Example 14The following is an example of the same Squeezeback effect as in Example 12, but this time hold on-air and transition keyers KEY1+KEY2 to PGM.• Setup to put effect on-air and transition

• Setup to keep effect on-air, select KEY1+KEY2 to go on-air, and transition

• Setup to take effect off and leave Key2 on-air


CMD = 0A 10 02 04 (for effect # 4)


KEY_ENABLE with SqueezeBack bit STILL SET, and set Key1 and Key2 bits

CMD = 0B 13

TX_NEXT with Key bit set CMD = 01 02TX_START will transition the two keyers to PGM, leaving effect on PGM (FX are “suspended”)

CMD = 02 03

KEY_ENABLE with SqueezeBack bit CLEAR, and Key1 bit CLEAR, and Key2 bit STILL SET

CMD = 0B 03




Example 15The following is an example of how to put a three-segment Squeezeback effect on-air, transition through sequence, hold at last segment and put new PST to PGM, and then finally take off-air.• Setup to put effect on-air and transition

• Query the effect to see the number of segments.

• Transition to segment # 2.

• Transition to segment # 3


CMD = 0A 10 02 04 (for effect # 4)


KEY_MOD Query with SqueezeBack bit set will return Reply with SqueezeBack bit set, and <key_mod> bits 5-7 = 010, indicating 3 segment effect

QUERY = 0A 10REPLY = 0A 10 42 04

KEY_ENABLE with SqueezeBack bit set and bit 7 set to indicate GOTO NEXT SEGMENT

CMD = 0B 90

TX_NEXT with Key bit set CMD = 01 02TX_START will transition the effect to the next segment on PGM

CMD = 02 03

KEY_ENABLE with SqueezeBack bit set and bit 7 set to indicate GOTO NEXT SEGMENT

CMD = 0B 90

TX_NEXT with Key bit set CMD = 01 02TX_START will transition the effect to the next segment on PGM

CMD = 02 03



• Setup to keep effect on-air, select new PST source, and transition


KEY_ENABLE with SqueezeBack bit STILL SET but bit 7 NOT SET (to indicate do not go to next segment)

CMD = 0B 10

TX_NEXT with Background bit set CMD = 01 01XPT_TAKE with Preset bit set, and <xpt> to select new source

CMD = 06 00 02 07 (for crosspoint # 7)

TX_START will transition the new source to PGM, leaving effect on PGM (FX are “suspended”)

CMD = 02 03


CMD = 0B 00

TX_NEXT with Key bit set. CMD = 01 02TX_START will transition the effect off PGM CMD = 02 03



Example 16The following is an example of how to put a three-segment Squeezeback effect on-air, do not use new bit-7 to transition through sequence, and take off-air.In this last example, we are illustrating compatibility with older automation systems, which only know only of single segment Squeezebacks. Regardless of where IconMaster is in an effect sequence, if it gets a command sequence to take the SqueezeBack off-air, it will JUMP to the END segment and execute the transition.• Setup to put effect on-air and transition

• Query the effect to see the number of segments.


KEY_ENABLE with SqueezeBack bit set. CMD = 0B 10KEY_MOD with SqueezeBack bit set, and <squeezeback> parameter = effect number.

CMD = 0A 10 02 04 (for effect # 4)

TX_NEXT with Key bit set. CMD = 01 02TX_START will transition the effect to PGM. CMD = 02 03

KEY_MOD Query with SqueezeBack bit set will return REPLY with SqueezeBack bit set, and <key_mod> bits 5-7 = 010, indicating 3 segment effect

QUERY = 0A 10REPLY = 0A 10 42 04


CMD = 0B 00

TX_NEXT with Key bit set. CMD = 01 02TX_START will transition the effect off PGM CMD = 02 03