Evertz Quartz D9 Installation and operating instructions

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4

TABLE OF CONTENTS

1. INTRODUCTION...........................................................................................................................1

1.1. SERIAL (RS232 / 422) PHYSICAL INTERFACE..................................................................1

1.1.1. Quartz D9 Serial Pin-Out...........................................................................................1

1.1.2. PC-to-Quartz RS232 Interface Cable........................................................................2

1.1.3. Embedded Control System (FU-0003) Interface........................................................2

2. ETHERNET PHYSICAL INTERFACE............................................................................................4

3. COMMANDS.................................................................................................................................6

3.1. SET XPT MESSAGE ............................................................................................................6

3.1.1. Multiple Set Xpt Message..........................................................................................7

3.2. SYSTEM DESTINATION LOCK ...........................................................................................8

3.3. FIRE SYSTEM SALVO.........................................................................................................8

3.4. INTERROGATE ROUTE.......................................................................................................9

3.5. CONNECT ROUTES ............................................................................................................9

3.6. LIST ROUTES ......................................................................................................................9

3.7. READ NAME TABLE..........................................................................................................10

3.8. WRITE NAME TABLE ........................................................................................................11

3.9. READ CONFIGURATION (EMBEDDED CONTROL SYSTEM ONLY)...............................12

3.10. WRITE CONFIGURATION (EMBEDDED CONTROL SYSTEM ONLY).............................12

3.11. QUEUE (SALVO) COMMAND............................................................................................13

3.11.1. Creating the Salvos.................................................................................................13

3.11.2. Emptying a Salvo ....................................................................................................13

3.11.3. Loading a Salvo.......................................................................................................13

3.11.4. Fire a Salvo.............................................................................................................14

3.11.5. Destroy a Salvo.......................................................................................................14

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4

3.12. LIST THE NUMBER OF ITEMS IN A SALVO.....................................................................14

3.13. GENERAL ENGINEERING COMMANDS ..........................................................................15

3.14. VIDEO STATUS DISPLAY .................................................................................................16

3.15. ENGINEERING COMMANDS.............................................................................................16

4. RESPONSES..............................................................................................................................17

4.1. ACKNOWLEDGE...............................................................................................................17

4.2. ERRORS ............................................................................................................................17

4.3. POWER UP........................................................................................................................17

4.4. UPDATE.............................................................................................................................17

4.4.1. Tieline Update.........................................................................................................17

5. CHANGES BY PANELS .............................................................................................................19

6. EXAMPLES.................................................................................................................................20

7. TIMING (EMBEDDED CONTROL SYSTEMS)............................................................................21

8. OLDER SYSTEMS......................................................................................................................22

9. APPENDIX A...............................................................................................................................23

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4

REVISION HISTORY

REVISION DESCRIPTION DATE

1.2.5 Updates throughout March 2006

1.2.6 Updates throughout July 2006

1.2.7 Changes to the Queue command. October 2009

Change the .QS command changed to .QF command.

Change the loading of salvo crosspoints from

the .SVxx,yy command to .QSxx,yy command.

This change is not backwards compatible.

1.2.8 Changes to Queue commands to remove reset October 2009

and destroy all if 0 specified.

Added fire at specified time command.

1.2.9 .QC{n}(cr) command reply changed from .QC{n}(cr) to .A(cr) January 2010

1.3 Added appendix A, supported commands June 2012

1.3.1 Added notes regarding obsolete commands, adjusted appendix June 2012

A regarding support of .L for certain routers

1.4 Added SC2000 information Nov 2012

Information contained in this manual is believed to be accurate and reliable. However, Evertz assumes no responsibility for the use thereof

nor for the rights of third parties, which may be affected in any way by the use thereof. Any representations in this document concerning

performance of Evertz products are for informational use only and are not warranties of future performance, either expressed or implied. The

only warranty offered by Evertz in relation to this product is the Evertz standard limited warranty, stated in the sales contract or order

confirmation form.

Although every attempt has been made to accurately describe the features, installation and operation of this product in this manual, no

warranty is granted nor liability assumed in relation to any errors or omissions unless specifically undertaken in the Evertz sales contract or

order confirmation. Information contained in this manual is periodically updated and changes will be incorporated into subsequent editions. If

you encounter an error, please notify Evertz Customer Service department. Evertz reserves the right, without notice or liability, to make

changes in equipment design or specifications.

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4

This page left intentionally blank

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4 Page - 1

1. INTRODUCTION

This document specifies a protocol suitable for simple control of a Quartz routing system by a

computer or third party system. The protocol can use any of the physical interfaces available on the

system, either a RS232/422 interface or Ethernet.

As the protocol is ASCII text based, remote changes can be made using a terminal or a computer

running terminal emulation software. For most applications only the .S command will be required to set

crosspoints, with the .I or .L command to interrogate crosspoints. The .#01 command may be used at

system start up to check the RS232/422 link.

1.1. SERIAL (RS232 / 422) PHYSICAL INTERFACE

Most Quartz products have a built in serial port that is link selectable between RS422 and RS232 mode.

For older routing products see the section at the end of this document.

1.1.1. Quartz D9 Serial Pin-Out

The full router pin-out is shown below:

RS232 RS422

Signal

CHASSIS

2 RTS 2 TX-

3 RXD 3 RX+

4 N/C 4 RX GND

5 N/C 5 N/C

6 GND 6 TX GND

7 TXD 7 TX+

8 CTS 8 RX-

9 N/C 9 N/C

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Page - 2 Revision 1.4

For information, the following pin-out is normally used on personal computers, but check your own

computer’s documentation.

D9 PLUG

D25 PLUG

Signal

DCD

TXD

2 RXD 3 RXD

3 TXD 4 RTS

4 DTR 5 CTS

5 GND 6 DSR

6 DSR 7 GND

7 RTS 8 DCD

8 CTS 20 DTR

9 RI 22 RI

1.1.2. PC-to-Quartz RS232 Interface Cable

The cable between a PC with a D9 connector and the router:

The cable between a PC with a D25 connector and the router:

1.1.3. Embedded Control System (FU-0003) Interface

1.1.3.1. Router DIP Switch Settings

DIP switch 2 (DIP-2) must be down to enable the computer port. The port will then only respond to

messages of the correct format as detailed in this protocol document.

D9 Plug D9 Skt Cable D9 Plug

2 (RXD) --------------------------------------- 7 (TXD)

3 (TXD) --------------------------------------- 3 (RXD)

5 (0V) --------------------------------------- 6 (0V)

5 (GND)

Router

D9 Skt

D25 Plug D25 Skt Cable D9 Plug

3 (RXD) --------------------------------------- 7 (TXD)

2 (TXD) --------------------------------------- 3 (RXD)

7 (0V) --------------------------------------- 6 (0V)

5 (GND)

Router

D9 Skt

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4 Page - 3

The normal setting for a master router is Up,Down,Down,Up and for a slave router Up,Down,Up,Up.

1.1.3.2. Protocols

The embedded router/panel firmware EPROM has one remote control protocol built in to it. The

Quartz standard ASCII protocol is indicated by a -1 at the end of the EPROM number i.e. PC215-1.

In later systems the embedded router/panel firmware FLASH device may have one or more remote

control protocol built in to it. These protocols can be selected via the WinSetup configuration editor.

The port operates at 38400, 8 data bits, no parity, and 1 stop bit. Other baud rates and parity options can

be selected from WinSetup.

DIP-1 Up = Default baud rate (38400)

Down = SETUP defined baud rate

DIP-2 Up = Normal position

Down = computer port enable

DIP-3 Up = Slave router

Down = Master router

DIP-4 Up = Normal position

Down = Re-

boot with i/p X to all

o/p’s

PC215-1

V5.00

PC150-1

V5.00

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Page - 4 Revision 1.4

2. ETHERNET PHYSICAL INTERFACE

More recent Quartz products such as the EQX, SC-1000, Q256, Xenon and Topaz are equipped with

an Ethernet port. These support 100base2 or 10base2 Ethernet using CAT5 cable. The network should

ideally be closed (or at least isolated with a suitable switch) for use with devices on the Quartz routing

system.

Both the physical interfaces (Serial and Ethernet) use the same protocol command and reply structure,

which is detailed below. The following few paragraphs just describe the Ethernet configuration and

connection needed in order to communicate with these devices.

Each device on the network must be assigned a unique IP address. Changing and interrogating the IP

addresses are usually sent via serial port commands as documented in 3.15. If two controllers are

installed in the controller or routing frame two stream socket connections will be required to the main

and backup controllers, as either of the two might be in control of the routing system at any point in

time.

Normally Quartz controllers will allow a TCP/IP connection via the telnet port number (23).

On the SC-1000 additional TCP/IP ports can be added to the configuration file currently selected by the

SC-1000. This is configured from WinSetup under the “System”->”SC-1000 Configuration”->”Options”

dialog. A TCP/IP port should be added using the Quartz protocol and at this point the user can specify

a port number for the conversation (please note this port number should be greater than 1024). Please

make sure the server check box is also ticked.

Quartz controllers use standard TCP/IP stream sockets (sometimes referred to as Berkeley sockets) to

communicate with other network devices needing to control the routing system. Stream sockets are

connection oriented, and so a connection must be opened and maintained for the duration of

communications. Stream sockets are supported for many different host environments and operating

systems.

In order to start communication with a controller the computer or other host device must originate the

communications. In other words the router controller will be the server and the computer will be the

client.

The client should:

1. Create a stream socket.

2. Connect the socket to the IP address of the desired main/reserve controller on the port

specified in the configuration. (Note if there are redundant controllers, each controller will have

its own unique IP address and need a separate stream socket. However, only the active

controller will be able to accept a connection).

3. Once the connection has been successful, commands can then be sent to the routing controller

and the controller will reply according to the command sent as detailed in section 3.

4. Once the connection is finished with, it should be closed as normal.

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Revision 1.4 Page - 5

5. The routing controller will terminate all connections on a download of a new configuration so the

clients program should cope with losing and re-establishing this connection to the controller.

The SC-1000 controller allows the user to see a list of the currently active TCP/IP connections via both

the configuration port and the LCD window on the front of the unit.

Application Note 65

Quartz Routing Switcher Remote Control Protocol

Page - 6 Revision 1.4

3. COMMANDS

All characters used should be in upper case. Values in { } brackets are variable fields. Values in [ ]

brackets are optional variable fields. Values in () brackets are non-printable characters i.e. carriage

return (cr). No space or tab characters are used. All crosspoint numbering starts from one (1) and not

zero (0). The (cr) character is ASCII carriage return (code 0D hex). A reply is only generated after a

(cr).

Some examples are given of ‘C’ code suitable to output messages. These are only intended to clarify the

command structure. They assume a separate ‘C’ routine RS232_printf which is similar to the standard

printf but with is output directed to the RS232 serial port of the host computer.

3.1. SET XPT MESSAGE

This allows a route to be made (crosspoint set) and uses the command format:

.S{level}{dest},{srce}(cr)

The legal levels are V,A,B,C,D,E,F,G in 8 level systems and V,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O in 16 level

systems.

TYPICAL MESSAGE Q1600 LEVEL TYPICAL USE

.SV1,2(cr) level 1 video

.SA2,4(cr) level 2 audio 1

.SB4,1(cr) level 3 audio 2

.SC31,12(cr) level 4 control/time code

The router will reply with a .U{level}{dest},{srce}(cr) message. The error message .E(cr) is generated if

the command is not recognised.

SEND REPLY

.SV001,002(cr) .UV001,002(cr)

.SC9,3(cr) .UC009,003(cr)

.SZ1,1(cr) .E(cr) /* unknown level */

.MA1,1(cr) .E(cr) /* unknown command */

Multiple levels can be set by including more level identifiers in the message

.SVA1,2(cr) level 1,2

.SAC1,2(cr) level 2,4

.SCV1,2(cr) level 4,1

.SVABC1,2(cr) level 1,2,3,4

The router will reply with an update message (see section 5.4)

.SBA1,2(cr) .UAB001,002(cr)

Example ‘C’ code to set a crosspoint on levels 1, 2, & 3.

Table of contents

Other evertz Network Hardware manuals

Popular Network Hardware manuals by other brands

Matrix Switch Corporation

Matrix Switch Corporation MSC-HD161DEL product manual

B&B Electronics

B&B Electronics ZXT9-IO-222R2 product manual

Yudor

Yudor YDS-16 user manual

D-Link

D-Link ShareCenter DNS-320L datasheet

Samsung

Samsung ES1642dc Hardware user manual

Honeywell Home

Honeywell Home LTEM-PV Installation and setup guide

D-Link

D-Link ShareCenter DNS-343 Quick installation guide

Asante

Asante AsanteBridge 1012 user guide

FireBrick

FireBrick FB2700 user manual

Audiovox Electronics

Audiovox Electronics ARWH2T user manual

ADC

ADC DSX-1 Operational Procedures Guide

NetComm

NetComm NF2 user guide

Alcatel-Lucent

Alcatel-Lucent 5620 user guide

Dell EMC

Dell EMC XC6420 Series Solution guide

Lanner

Lanner NCA-1020A user manual

Allied Telesis

Allied Telesis AT-TN121-A Specifications

Arista

Arista CCA-ETM-Q12 quick start guide

Lanner

Lanner NCA-1525 user manual

evertz Quartz D9 Installation and operating instructions

Popular Network Hardware manuals by other brands