K R A ME R E LE CT R O N IC S L TD .

REFERENCE
GUIDE

Protocol 3000

Version 2.11 (User)

P/N: 2900-300488 Rev 1

Contents
1 Syntax 1
1.1 Host Message Format 1
1.2 Device Message Format 1
1.3 Command Terms 2
1.4 Entering Commands 3
1.5 Bidirectional Definition 3
1.6 Command Chaining 3
1.7 Maximum String Length 4
1.8 Backward Support 4
2 Commands 5
2.1 System Commands - Mandatory 6
2.2 System Commands 11
2.3 File System Commands 31
2.4 Authentication Commands 35
2.5 Switching/Routing Commands 38
2.6 Video Commands 42
2.7 Audio Commands 50
2.8 Communication Commands 61
2.9 Multiviewer/Scaler Commands 66
2.10 EDID Handling Commands 83
2.11 Step-in Commands 87
3 Messages and Codes 89
3.1 Device Initiated Messages 89
3.2 Result and Error Codes 89
4 Packet Protocol Structure 91
4.1 Using the Packet Protocol 91
4.2 Calculating the CRC 92
5 Parameters 93
5.1 On/Off 93
5.2 Stage 93
5.3 Signal Type 93
5.4 Genlock Types 93
5.5 Video Resolutions 94
5.6 Color Space 95
5.7 Image Properties 96
5.8 View Modes 96
5.9 Custom Resolution Parameters 96
5.10 Detail Timing Parameters 97
5.11 Video/Audio Signal Changes 97
5.12 Font Size 98
5.13 Layer Enumeration 98
5.14 Software Programmed 98
5.15 EDID Source 98
5.16 EDID Audio Capabilities 98
5.17 Signal Validation 99
5.18 Ethernet Port Types 99
5.19 HDCP Types 99
5.20 Parity Types 99
5.21 Serial Types 99

Protocol 3000 - Syntax i

5.22 Audio Signal Types 100
5.23 Frequency Number 100
5.24 Audio Level 100
5.25 Audio Delay 101
6 Command Index 101

Revision History
Rev Author Date Changes
1.01 M Tal 27/11/11 Rewrite sections 2.1-2.2
1.02 M Tal 1/12/11 Rewrite sections 2.3-2.5
1.03 E Litvak 1/12/11 Rewrite sections 2.6-2.7
Added section 4.2
1.04 M Tal 4/12/11 Rewrite section 2.8
Some fixes
1.05 E Litvak 21/12/11 Commands edited: #LDEDID, #LDFW, #GEDID
Commands added: #CPEDID, #GEDID-EXT
Added Section 4
Added section 1.5
1.06 E Litvak 27/12/11 Commands added: #SIGNAL, #SIGNAL?, #DISPLAY,
#DISPLAY?
Edited section 3.1
1.07 F Strauss 18/1/12 Reformat and correct
1.08 F Strauss 5/2/12 Commands added: BAUD, BAUD?, GEDID-INF, GEDID-
EXT-INF, IREN, IREN?, FPGA-VER?, LDFPGA, TMSRV,
TMSRV?, NTDNS, NTDNS?, layer, TMLOC?, RGB?
Result and error codes
Device specific commands: MV-6, VP-81SID, PIP-4
Appendix entry: CRC calculation
1.09 C Hoyzer 22/10/13 Added new commands from the following documents:
FC-2xETH
P3K Commands to Add
Protocol 3000 Matrix 1.8
Protocol 3001 - Multiviewers and more 1.10
TP577-X1 new commands
VS-62D additional commands
VS-88HFS protocol
2.2 R Bernstein 22/10/13 Moved new commands to Section 2
Sorted commands and tables alphabetically
Removed index
Added parameter table Section 6
Added cross references to parameter table
2.3 R Bernstein 27/10/13 Added signal validation table
Removed CMD short columns
Attended to factory and debug commands
2.4 R Bernstein 28/10/13 Repaired cross-references
2.5 F Strauss 17/02/14 Added index, reformatted

ii Protocol 3000 - Syntax

 Rev Author Date Changes
2.6 N Aharon 28/04/14 Commands removed: TMSRV, TMSRV?, TMLOC, TMLOC?
Commands added: TIME-SRV, TIME-SRV?, TIME-LOC,
TIME-LOC?
Commands edited: AV-SW-TIMEOUT
2.7 F Strauss 12/05/14 Extensive reformatting
Commands added: VID-PATTERN, VID-PATTERN?,
TUNNEL-CTRL, KLINK-INF, KLINK-CLS, MTX-MODE,
MTX-MODE?
2.8 F Strauss 20/05/14 Factory commands separated, added missing commands
2.9 F Strauss 28/05/14 Commands added:
DPSW-STATUS?, EQ-LVL, MIC-GAIN, MIX-LVL, IMAGE-
PROP, SCLR-AS, SCLR-AUDIO-DELAY, SCLR-PCAUTO,
SHOW-OSD
2.10 F Strauss 11/8/14 Command removed: NTDNS
Commands added: LOCK-EDID, VFRZ, VIEW-MOD
2.11 F Strauss 13/5/14 Commands added: TEST-FREQ, MIC-DELAY
Commands edited: AV-SW-TIMEOUT, VID-RES, VMUTE,
STEREO, TLK, DEF-RES
Command moved: VIEW-MOD
Parameter table added: 5.11 Video/Audio Signal Changes
Sections added: Step-in, EDID Handling

Protocol 3000 - Syntax iii

1 Syntax

With Kramer Protocol 3000 you can control a device from any standard
terminal software (for example, the Windows® HyperTerminal Application).
This RS-232/RS-485 communications protocol uses a data rate of 115,200
baud, no parity, 8 data bits, and 1 stop bit.

1.1 Host Message Format

Start Address (opt) Body Delimiter
# Destination_id@ Message CR

1.1.1 Simple Command

Command string with only one command without addressing:

Start Body Delimiter
# Command SP Parameter_1,Parameter_2,… CR

1.1.2 Command String

Formal syntax with commands concatenation and addressing:

Start Address Body Delimiter
# Destination_id@ Command_1 CR
Parameter1_1,Parameter1_2,…|
Command_2
Parameter2_1,Parameter2_2,…|
Command_3
Parameter3_1,Parameter3_2,…|

1.2 Device Message Format

Start Address (opt) Body Delimiter
~ Sender_id@ Message CR LF

1.2.1 Device Long Response

Echoing command:
Start Address (opt) Body Delimiter
~ Sender_id@ Command SP [Param1,Param2 …] result CR LF

Protocol 3000 - Syntax 1

 CR = Carriage return (ASCII 13 = 0x0D)
LF = Line feed (ASCII 10 = 0x0A)
SP = Space (ASCII 32 = 0x20)

1.3 Command Terms

Command
A sequence of ASCII letters ('A'-'Z', 'a'-'z' and '-').
Command and parameters must be separated by at least one space.

Parameters
A sequence of alphameric ASCII characters ('0'-'9','A'-'Z','a'-'z' and some
special characters for specific commands). Parameters are separated by
commas.

Message string
Every command entered as part of a message string begins with a
message starting character and ends with a message closing character.
Note: A string can contain more than one command. Multiple commands
are separated by a pipe ('|') character.

Message starting character

'#' - For host command/query
'~' - For machine response or machine command performed by keystroke
operation on the front panel or IR remote controller.

Device address (Optional when directly connected to the device)

K-Net Device ID or MACHINE NUMBER followed by '@'
(ex. #02@CR LF )

Query sign
'?' follows some commands to define a query request.

All outputs sign

'*' defines all outputs.

Message closing character

CR - For host messages; carriage return (ASCII 13)

2 Protocol 3000 - Syntax

 CR LF - For machine messages; carriage return (ASCII 13) + line-feed
(ASCII 10)

Command chain separator character

When a message string contains more than one command, a pipe ('|')
character separates each command.

Spaces between parameters or command terms are ignored.

1.4 Entering Commands

You can directly enter all commands using a terminal with ASCII
communication software, such as HyperTerminal, Hercules, etc. Connect
the terminal to the serial, Ethernet, or USB port on the Kramer device. To
enter CR, press the Enter key. (LF is also sent but is ignored by the
command parser).

For commands sent from some non-Kramer controllers such as Crestron,

some characters require special coding (such as, /X##). Refer to the
controller manual.

1.5 Bidirectional Definition

All commands are bidirectional. That is, if the device receives the code, it
performs the instruction. If the instruction is performed (due to a keystroke
operation on the front panel or IR controller) these codes are sent to the PC
or other RS-232 / Ethernet / USB controller.

1.6 Command Chaining

Multiple commands can be chained in the same string. Each command is

delimited by a pipe character ('|'). When chaining commands, enter the
message starting character and the message closing character once
only, at the beginning of the string and at the end.
Commands in the string do not execute until the closing character is
entered. A separate response is sent for every command in the chain.

Protocol 3000 - Syntax 3

1.7 Maximum String Length

64 characters

1.8 Backward Support

Protocol 2000 is transparently supported by Protocol 3000. You can switch

between protocols using a switch protocol command from either platform.

4 Protocol 3000 - Syntax

2 Commands

This section lists and describes all the commands of Protocol 3000.

 System Commands - Mandatory (see Section ‎2.1)

 System Commands (see Section ‎2.2)

 File System Commands (see Section ‎2.3)

 Authentication Commands (see Section ‎2.4)

 Switching/Routing Commands (see Section ‎2.5)

 Video Commands (see Section ‎2.6)

 Audio Commands (see Section ‎2.7)

 Communication Commands (see Section ‎2.8)

 Multiviewer/Scaler Commands (see Section ‎2.9)

 EDID Handling Commands (see Section ‎2.10)

 Step-in Commands (see Section ‎2.11)

Protocol 3000 - Commands 5

 2.1 System Commands - Mandatory

All devices running Protocol 3000 use these commands.

Command Description Type Permission

# Protocol handshaking System-mandatory End User
BUILD-DATE? Get device build date System-mandatory End User
FACTORY Reset to factory default configuration System-mandatory End User
HELP Get command list System-mandatory End User
MODEL? Get device model System-mandatory End User
PROT-VER? Get device protocol version System-mandatory End User
RESET Reset device System-mandatory Administrator
SN? Get device serial number System-mandatory End User
VERSION? Get device firmware version System-mandatory End User

Command - # Command Type - System-mandatory

Command Name Permission Transparency
Set: # End User Public
Get: - - -
Description Syntax
Set: Protocol handshaking #␍
Get: - -
Response

~nn@␠OK␍␊
Parameters

Response Triggers

Notes
Use to validate the Protocol 3000 connection and get the machine number

6 Protocol 3000 - Commands

Command - BUILD-DATE Command Type - System-mandatory
Command Name Permission Transparency
Set: - - -
Get: BUILD-DATE? End User Public
Description Syntax
Set: Get device build date #BUILD-DATE␍
Get: - -
Response

~nn@BUILD-DATE␠date␠time␍␊
Parameters
date - Format: YYYY/MM/DD where YYYY = Year, MM = Month, DD = Day
time - Format: hh:mm:ss where hh = hours, mm = minutes, ss = seconds
Response Triggers

Notes

Command - FACTORY Command Type - System-mandatory

Command Name Permission Transparency
Set: FACTORY End User Public
Get: - - -
Description Syntax
Reset device to factory default
Set: #FACTORY␍
configuration
Get: - -
Response

~nn@FACTORY␠OK␍␊
Parameters

Response Triggers

Notes
This command deletes all user data from the device. The deletion can take some time.

Protocol 3000 - Commands 7

Command - HELP Command Type - System-mandatory
Command Name Permission Transparency
Set: - - -
Get: HELP End User Public
Description Syntax
Set: - -
2 options:
Get command list or help for specific
Get: 1. #HELP␍
command
2. #HELP␠command_name␍
Response

1. Multi-line: ~nn@Device available protocol 3000 commands:␍␊command,␠command…␍␊

To get help for command use: HELP (COMMAND_NAME)␍␊
2. Multi-line: ~nn@HELP␠command:␍␊description␍␊USAGE:usage ␍␊
Parameters

Response Triggers

Notes

Command - MODEL? Command Type - System-mandatory

Command Name Permission Transparency
Set: - - -
Get: MODEL? End User Public
Description Syntax
Set: - -
Get: Get device model #MODEL?␍
Response

~nn@MODEL␠model_name␍␊
Parameters
model_name - String of up to 19 printable ASCII chars
Response Triggers

Notes

8 Protocol 3000 - Commands

Command - PROT-VER? Command Type - System-mandatory
Command Name Permission Transparency
Set: - - -
Get: PROT-VER? End User Public
Description Syntax
Set: - -
Get: Get device protocol version #PROT-VER?␍
Response

~nn@PROT-VER␠3000:version␍␊
Parameters
Version - XX.XX where X is a decimal digit
Response Triggers

Notes

Command - RESET Command Type - System-mandatory

Command Name Permission Transparency
Set: RESET Administrator Public
Get: - - -
Description Syntax
Set: Reset device #RESET␍
Get: - -
Response

~nn@RESET␠OK␍␊
Parameters

Response Triggers

Notes
To avoid locking the port due to a USB bug in Windows, disconnect USB connections immediately after
running this command. If the port was locked, disconnect and reconnect the cable to reopen the port.

Protocol 3000 - Commands 9

Command - SN? Command Type - System-mandatory
Command Name Permission Transparency
Set: - - -
Get: SN? End User Public
Description Syntax
Set: - -
Get: Get device serial number #SN?␍
Response

~nn@SN␠serial_number␍␊
Parameters
serial_number - 11 decimal digits, factory assigned
Response Triggers

Notes
For new products with 14 digit serial numbers, use only the last 11 digits

Command - VERSION? Command Type - System-mandatory

Command Name Permission Transparency
Set: - - -
Get: VERSION? End User Public
Description Syntax
Set: - -
Get: Get firmware version number #VERSION?␍
Response

~nn@VERSION␠firmware_version␍␊
Parameters
firmware_version - XX.XX.XXXX where the digit groups are: major.minor.build version
Response Triggers

Notes

10 Protocol 3000 - Commands

2.2 System Commands
Command Description Type Permission
AV-SW-MODE Set/get auto switch mode System End user
AV-SW-TIMEOUT Set/get auto switching timeout System End user
BAUD Set/get protocol serial port baud rate System End User
DISPLAY? Get output HPD status Switch End User
DPSW-STATUS? Get the DIP-switch status System End User
FPGA-VER? Get current FPGA version System End User
HDCP-MOD Set/get HDCP mode System Administrator
HDCP-STAT? Get HDCP signal status System End user
IDV Set visual indication from device System End User
INFO-IO? Get in/out count System End User
INFO-PRST? Get maximum preset count System End User
IREN Set/get IR interface state System End User
LABEL Set/get input/output label System End User
LDFPGA Load new FPGA file System - Administrator
Packets
LDFW Load new firmware file System End User Internal
SW
LOCK-FP Set/get front panel lock System Administrator
MACH-NUM Set machine number System Administrator
NAME Set/get machine (DNS) name System Administrator
NAME-RST Reset machine name to factory default System Administrator
(DNS)
P2000 Switch to Protocol 2000 System End User
POWER-SAVE Set/get power save mode System Administrator
PRIO Set/get input priority System Administrator
PRIORITY Set/get priority for all channels System Administrator
PRST-AUD? Get audio connections from saved preset System End User
PRST-LST? Get saved preset list System End User
PRST-RCL Recall saved preset list System End User
PRST-STO Store current connections to preset System End User
PRST-VID? Get video connections from saved preset System End User
SIGNAL? Get input signal lock status System End User
TIME Set/get device time and date System Administrator
TIME-LOC Set/get local time offset from UTC/GMT System End User

Protocol 3000 - Commands 11

Command - AV-SW-MODE Command Type - System
Command Name Permission Transparency
Set: AV-SW-MODE End user Public
Get: AV-SW-MODE? End user Public
Description Syntax
Set: Set input auto switch mode (per output) # AV-SW-MODE␠layer,output_id,mode␍
Get: Get input auto switch mode (per output) # AV-SW-MODE?␠layer,output_id␍
Response

~ nn@AV-SW-MODE␠layer,output_id,mode␍␊
Parameters
layer – see Section ‎5.13 Layer Enumeration
output_id - 1….num‎of‎system‎outputs
mode - 0 - manual
1 - priority switch
2 - last connected switch
Response Triggers

Notes

Command - AV-SW-TIMEOUT Command Type - System

Command Name Permission Transparency
Set: AV-SW-TIMEOUT End User Public
Get: AV-SW-TIMEOUT? End User Public
Description Syntax
Set: Set auto switching timeout #AV-SW-TIMEOUT␠action,time_out ␍
Get: Get auto switching timeout #AV-SW-TIMEOUT?␠action ␍
Response

~ nn@AV-SW-TIMEOUT␠action,time_out ␍
Parameters
action - see Section ‎5.11 Video/Audio Signal Changes
timeout - timeout in seconds
Response Triggers

Notes

12 Protocol 3000 - Commands

Command - BAUD Command Type - System
Command Name Permission Transparency
Set: BAUD Administrator Public
Get: BAUD? Administrator Public
Description Syntax
Set: Set protocol serial port baud rate #BAUD␠baud_rate␍
Get protocol serial port baud rate
(Option 1 - for current baud rate, Option 1: #BAUD?␍
Get:
Option 2 - for list of supported baud
Option 2: #BAUD?␠baud_param␍
rates)
Response

~nn@BAUD␠baud_rate␍␊
Option 1: ~nn@BAUD␠current_baud_rate␍␊
Option 2: ~nn@BAUD␠baud_rate1, baud_rate2,...␍␊
Parameters
baud_rate - 9600 / 115200 / else - new baud rate to set
current_baud_rate - 9600 / 115200 / else - current protocol serial port baud rate
baud_param - 0 - get the list of supported baud rates
baud_rate1, baud_rate2, …‎- list of supported baud rates
Response Triggers

Notes
The new defined baud rate is stored in the EEPROM and used when powering up
Default baud rate is 115200 (on factory reset)
Only works with devices supporting this command (if ERR 002 is returned, the default baud rate is used)

Protocol 3000 - Commands 13

Command - DISPLAY? Command Type - System
Command Name Permission Transparency
Set: - - -
Get DISPLAY? End User Public
Description Syntax
Set: - -
Get: Get output HPD status #DISPLAY?␠out_id␍
Response

~ nn@DISPLAY ␠out_id,status ␍␊
Parameters
out_id - output number
status - HPD status according to signal validation (see Section ‎5.17 Signal Validation)
Response Triggers
After execution, response is sent to the com port from which the Get was received
Response is sent after every change in output HPD status ON to OFF
Response is sent after every change in output HPD status OFF to ON and ALL parameters (new EDID,
etc.) are stable and valid
Notes

Command – DPSW-STATUS? Command Type – System

Command Name Permission Transparency
Set: - - -
Get: DPSW-STATUS? End User Public
Description Syntax
Set: - -
Get : Get the DIP-switch state # DPSW-STATUS?␠ dp_sw_id ␍
Response

~nn @ DPSW-STATUS?␠ dp_sw_id, status␍␊

Parameters
dp_sw_id - 1….num‎of‎DIP switches
status - 0: up
1: down
Response Triggers

Notes

14 Protocol 3000 - Commands

Command - FPGA-VER? Command Type - System
Command Name Permission Transparency
Set: - - -
Get: FPGA-VER? End User Public
Description Syntax
Set: - -
Get: Get current FPGA version #FPGA-VER?␠id␍
Response

~nn@FPGA-VER␠id, expected_ver, actual_ver␍␊

Parameters
id - FPGA id
expected_ver - expected FPGA version for current firmware
actual_ver - actual FPGA version
Response Triggers

Notes

Command - HDCP-MOD Command Type - System

Command Name Permission Transparency
Set: HDCP-MOD Administrator Public
Get: HDCP-MOD? End User Public
Description Syntax

Set: Set HDCP mode #HDCP-MOD ␠ inp_id,mode ␍

Get: Get HDCP mode #HDCP-MOD?␠ stage_id ␍
Response

Set / Get: ~ nn@HDCP-MOD␠stage_id,mode ␍␊

Parameters
inp_id - input number (1.. max number of inputs)
mode - HDCP mode (see Section ‎5.19 - HDCP Types)
Response Triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
Response is sent to all com ports after execution if HDCP-MOD was set by any other external control
device (button press, device menu and similar) or HDCP mode changed
Notes
Set HDCP working mode on the device input:
HDCP supported - HDCP_ON [default]
HDCP not supported - HDCP OFF
HDCP support changes following detected sink - MIRROR OUTPUT

Protocol 3000 - Commands 15

Command - HDCP-STAT Command Type - System
Command Name Permission Transparency
Set: - - -
Get: HDCP-STAT? End User Public
Description Syntax
Set: None -
Get: Get HDCP signal status #HDCP-STAT?␠stage,stage_id␍
Response

Set / Get: ~ nn@HDCP-STAT␠stage,stage_id,mode␍␊

Parameters
stage – input/output (see Section ‎5.2 Stage)
stage_id - number of chosen stage (1.. max number of inputs/outputs)
actual_status - signal encryption status - valid values ON/OFF (see Section ‎5.19 HDCP Types)
Response Triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
Response is sent to all com ports after execution if HDCP-STAT was set by any other external control
device (button press, device menu and similar) or HDCP mode changed
Notes
On output – sink status
On input – signal status

16 Protocol 3000 - Commands

Command - IDV Command Type - System
Command Name Permission Transparency
Set: IDV End User Public
Get: - - -
Description Syntax
Set: Set visual indication from device #IDV␍
Get: - -
Response

~nn@IDV␠OK␍␊
Parameters

Response Triggers

Notes
Using this command, some devices can light a sequence of buttons or LEDs to allow identification of a
specific device from similar devices

Protocol 3000 - Commands 17

Command - INFO-IO? Command Type - System
Command Name Permission Transparency
Set: - - -
Get: INFO-IO? End User Public
Description Syntax
Set: - -
Get: Get in/out count #INFO-IO?␍
Response

~nn@INFO-IO?␠IN␠ inputs_count, OUT␠outputs_count␍␊

Parameters
inputs_count - number of inputs in the unit
outputs_count - number of outputs in the unit
Response Triggers

Notes

Command - INFO-PRST? Command Type - System

Command Name Permission Transparency
Set: - - -
Get: INFO-PRST? End User Public
Description Syntax
Set: - -
Get: Get maximum preset count #INFO-PRST?␍
Response

~nn@INFO-PRST?␠VID␠preset_video_count, AUD␠preset_audio_count␍␊
Parameters
preset_video_count - maximum number of video presets in the unit
preset_audio_count - maximum number of audio presets in the unit
Response Triggers

Notes
In most units, video and audio presets with the same number are stored and recalled together by
commands #PRST-STO and #PRST-RCL

18 Protocol 3000 - Commands

Command - IREN Command Type - System
Command Name Permission Transparency
Set: IREN End User Public
Get: IREN? End User Public
Description Syntax
Set: Set IR interface state #IREN␠enable␍
Get: Get IR interface state #IREN?␍
Response

~nn@IREN␠enable␍␊
Parameters
enable - 0 - disable IR interface
1 - enable IR interface
Response Triggers

Notes

Command - LABEL Command Type - System

Command Name Permission Transparency
Set: LABEL End User Public
Get: LABEL? End User Public
Description Syntax
Set: Set input/output label # LABEL␠stage, stage_id, switch, label␍
Get: Get input/output label # LABEL?␠stage_id␍
Response

~nn @ LABEL␠stage, stage_id, switch, label ␍␊

Parameters
stage – see Section ‎5.2 Stage
stage_id – input/ output number
switch – on/off (enable/disable) custom label
label – custom label string
Response Triggers

Notes

Protocol 3000 - Commands 19

Command - LDFPGA Command Type - System - Packets
Command Name Permission Transparency
Set: LDFPGA Internal SW Public
Get: - - -
Description Syntax

Step 1: #LDFPGA␠size, CRC, fpga_id, force␍

Set: Load new FPGA file
Step 2: If ready was received, send FPGA_DATA
Get: - -
Response

Response 1: ~nn@LDFPGA␠size␠READY␍␊ or ~nn@LDFW␠ERRnn␍␊

Response 2: ~nn@LDFPGA␠size␠OK␍␊
Parameters
size -size of firmware data that is sent
CRC - FPGA file CRC (see appendix)
fpga_id - FPGA ID (if there are more than one). Default - 1
force – 1, ignore CRC calculation
FPGA_DATA - *.rbf file in protocol packets (see Section 4)
Response Triggers

Notes
See Protocol Packet reference in Section ‎4. Use this command in dedicated SW application

20 Protocol 3000 - Commands

Command - LDFW Command Type - System - Packets
Command Name Permission Transparency
Set: LDFW Internal SW Public
Get: - - -
Description Syntax

Step 1: #LDFW␠size␍
Set: Load new firmware file
Step 2: If ready was received, send FIRMWARE_DATA
Get: - -
Response

Response 1: ~nn@LDFW␠size␠READY␍␊ or ~nn@LDFW␠ERRnn␍␊

Response 2: ~nn@LDFW␠size␠OK␍␊
Parameters
size - size of firmware data that is sent
FIRMWARE_DATA - HEX or KFW file in protocol packets (see Section 4)
Response Triggers

Notes
In most devices firmware data is saved to flash memory, but the memory does not update until receiving
the‎“UPGRADE”‎command‎and‎is restarted.
See Protocol Packet reference in Section ‎4. Use this command in dedicated SW application

Protocol 3000 - Commands 21

Command - LOCK-FP Command Type - System
Command Name Permission Transparency
Set: LOCK-FP End User Public
Get: LOCK-FP? End User Public
Description Syntax

Option 1: #LOCK-FP␠lock_mode␍
Set: Lock front panel
Option 2: #LOCK-FP␠device_id,lock_mode␍

Option 1: #LOCK-FP?␍
Get: Get front panel lock state
Option 2: #LOCK-FP?␠device_id␍
Response

Set: Option 1: ~nn@LOCK-FP␠lock_mode␠OK␍␊

Option 2: ~01@LOCK-FP␠device_id,lock_mode␠OK␍␊
Get: Option 1: ~nn@LOCK-FP␠lock_mode␍␊
Option 2: ~01@LOCK-FP␠device_id, lock_mode␍␊
Parameters
lock_mode - 0/OFF - unlocks the front panel buttons, 1/ON - locks the front panel buttons
device_id - for K-Net controllers, select the button panel to lock. Locking is allowed only from the master
Response Triggers

Notes

Command - MACH-NUM Command Type - System

Command Name Permission Transparency
Set: MACH-NUM End User Public
Get: - - -
Description Syntax
Set: Set machine number #MACH-NUM␠machine_number␍
Get: - -
Response

~nn@MACH-NUM␠machine_number␍␊
Parameters
machine_number - new device machine number
Response Triggers

Notes
Some devices do not set the new machine number until the device is restarted
Some devices can change the machine number only from DIP-switches

22 Protocol 3000 - Commands

Command - NAME Command Type - System (Ethernet)
Command Name Permission Transparency
Set: NAME Administrator Public
Get: NAME? End User Public
Description Syntax
Set: Set machine (DNS) name #NAME␠machine_name␍
Get: Get machine (DNS) name #NAME?␍
Response

Set: ~nn@NAME␠machine_name␍␊
Get: ~nn@NAME?␠machine_name␍␊
Parameters
machine_name - String of up to 14 alpha-numeric chars (can include hyphen, not at the beginning or end)
Response Triggers

Notes
The machine name is not the same as the model name. The machine name is used to identify a specific
machine or a network in use (with DNS feature on)

Command - NAME-RST Command Type - System (Ethernet)

Command Name Permission Transparency
Set: NAME-RST Administrator Public
Get: - - -
Description Syntax
Reset machine (DNS) name to
Set: #NAME-RST␍
factory default
Get: - -
Response

~nn@NAME-RST␠OK␍␊
Parameters

Response Triggers

Notes
Factory‎default‎of‎machine‎(DNS)‎name‎is‎“KRAMER_”‎+‎4‎last‎digits‎of‎device‎serial‎number

Protocol 3000 - Commands 23

Command - P2000 Command Type - System
Command Name Permission Transparency
Set: P2000 End User Public
Get: - - -
Description Syntax
Set: Switch to Protocol 2000 #P2000␍
Get: - -
Response

~nn@P2000␠OK␍␊
Parameters

Response Triggers

Notes
Available only for devices that support Protocol 2000
Protocol 2000 has a command to switch back to an ASCII protocol like Protocol 3000

Command - POWER-SAVE Command Type - System

Command Name Permission Transparency
Set: POWER-SAVE Administrator Public
Get: POWER-SAVE? End User Public
Description Syntax
Set: Set power save mode #POWER-SAVE␠mode␍
Get: Get power save mode #POWER-SAVE?␍
Response

~nn@POWER-SAVE␠mode␍␊

Parameters
Set mode – 0/OFF - deactivates power saving mode, 1/ON - activates power saving mode
Get mode - OFF when power saving mode is not active, ON when power saving mode is active
Response Triggers

Notes

24 Protocol 3000 - Commands

Command - PRIO Command Type - System
Command Name Permission Transparency
Set: PRIO Administrator Public
Get PRIO? Administrator Public
Description Syntax
Set: Set input priority #PRIO␠input_id,prio␍
Get: Get input priority #PRIO?␠input_id ␍
Response

~ nn@PRIO ␠input_id,prio␍␊
Parameters
input_id - window number setting new source
prio - assigned priority (1.. max priority)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if PRIO was set by any other external control device
(button press, device menu and similar)
Notes
The PRIO max value may vary for different devices

Command - PRIORITY Command Type - System

Command Name Permission Transparency
Set: PRIORITY Administrator Public
Get: PRIORITY? Administrator Public
Description Syntax

# PRIORITY␠layer,PRIORITY1, PRIORITY2…‎
Set: Set input priority
PRIORITYn ␍
Get: Get input priority # PRIORITY?layer ␍
Response

~ nn@ PRIORITY␠layer,PRIORITY1, PRIORITY2… PRIORITYn ␍␊

Parameters
layer – see Section ‎5.13 Layer Enumeration
PRIORITY1 - priority of first input
PRIORITYn- priority of input n
Response Triggers

Notes
WP-577VH – layer parameter is not used

Protocol 3000 - Commands 25

Command - PRST-AUD? Command Type - System
Command Name Permission Transparency
Set: - - -
Get: PRST-AUD? End User Public
Description Syntax
Set: - -

Get audio connections from #PRST-AUD?␠ preset, out␍

Get:
saved preset
#PRST-AUD?␠ preset,* ␍
Response

~nn@PRST-AUD␠ preset, in>out ␍␊

~nn@PRST-AUD␠ preset, in>1, in>2, in>3,… ␍␊
Parameters
preset - preset number
n - input number or '0' if output is disconnected
> - Connection character between in and out parameters
out - Output number or '*' for all outputs
Response Triggers

Notes
In most units, video and audio presets with the same number are stored and recalled together by
commands #PRST-STO and #PRST-RCL

Command - PRST-LST? Command Type - System

Command Name Permission Transparency
Set: - - -
Get: PRST-LST? End User Public
Description Syntax
Set: - -
Get: Get saved preset list #PRST-LST?␍
Response

~nn@PRST-LST␠ preset, preset, … ␍␊

Parameters
preset - preset number
Response Triggers

Notes
In most units, video and audio presets with the same number are stored and recalled together by
commands #PRST-STO and #PRST-RCL

26 Protocol 3000 - Commands

Command - PRST-RCL Command Type - System
Command Name Permission Transparency
Set: PRST-RCL End User Public
Get: - - -
Description Syntax
Set: Recall saved preset list #PRST-RCL␠ preset ␍
Get: - -
Response

~nn@PRST-RCL␠preset␍␊
Parameters
preset - preset number
Response Triggers

Notes
In most units, video and audio presets with the same number are stored and recalled together by
commands #PRST-STO and #PRST-RCL

Command - PRST-STO Command Type - System

Command Name Permission Transparency
Set: PRST-STO End User Public
Get: - - -
Description Syntax
Store current connections,
Set:
volumes and modes in preset #PRST-STO␠preset ␍
Get: - -
Response

~nn@PRST-STO␠ preset␍␊
Parameters
preset - preset number
Response Triggers

Notes
In most units, video and audio presets with the same number are stored and recalled together by
commands #PRST-STO and #PRST-RCL

Protocol 3000 - Commands 27

Command - PRST-VID? Command Type - System
Command Name Permission Transparency
Set: - - -
Get: PRST-VID? End User Public
Description Syntax
Set: - -

Get video connections from saved #PRST-VID?␠preset, out␍

Get:
preset
#PRST-VID?␠preset, * ␍
Response

~nn@PRST-VID␠preset, in>out ␍␊
~nn@PRST-VID␠preset, in>1, in>2, in>3,‎…‎␍␊
Parameters
preset - preset number
n - input number or '0' if output disconnected
> - connection character between in and out parameters
out - output number or '*' for all outputs
Response Triggers

Notes
In most units, video and audio presets with the same number are stored and recalled together by
commands #PRST-STO and #PRST-RCL
Examples
Store current audio and video connections, #PRST-STO 5␍ ~PRST-STO 5␍␊
volumes and modes to preset 5
Recall audio and video connections from preset 3 #PRCL 3␍ ~PRST-RCL 3␍␊
Show source of video output 2 from preset 3 #PRST-VID? 3,2␍ ~PRST-VID 3, 4>2␍␊

28 Protocol 3000 - Commands

Command - SIGNAL Command Type - System
Command Name Permission Transparency
Set: - - -
Get SIGNAL? End User Public
Description Syntax
Set: - -
Get: Get input signal lock status #SIGNAL?␠inp_id␍
Response

~ nn@SIGNAL ␠ inp_id,status ␍␊
Parameters
inp_id - input number
status - lock status according to signal validation (see Section ‎5.17 Signal Validation)
Response Triggers
After execution, a response is sent to the com port from which the Get was received
Response is sent after every change in input signal status ON to OFF, or OFF to ON
Notes

Command - TIME Command Type - System

Command Name Permission Transparency
Set: TIME Administrator Public
Get: TIME? End User Public
Description Syntax
Set: Set device time and date #TIME␠day_of_week,date,time␍
Get: Get device time and date #TIME?␍
Response

~nn@TIME␠day_of_week, date, time␍␊

Parameters
day_of_week - one of {SUN,MON,TUE,WED,THU,FRI,SAT}
date - Format: DD-MM-YYYY.
time - Format: hh:mm:ss
Response Triggers

Notes
The year must be 4 digits
The device does not validate the day of week from the date
Time format - 24 hours
Date format - Day, Month, Year

Protocol 3000 - Commands 29

Command - TIME-LOC Command Type - System
Command Name Permission Transparency
Set: TIME-LOC End User Public
Get: TIME-LOC? End User Public
Description Syntax
Set: Set local time offset from UTC/GMT #TIME-LOC␠UTC_off,DayLight␍
Get: Get local time offset from UTC/GMT #TIME-LOC?␍
Response

~nn@ TIME-LOC␠UTC_off,DayLight ␍␊
Parameters
UTC_off - Offset of device time from UTC/GMT (without daylight time correction)
DayLight - 0 - no daylight saving time, 1 - daylight saving time
Response Triggers

Notes
If the time server is configured, device time calculates by adding UTC_off to UTC time (that it got from the
time server) + 1 hour if daylight savings time is in effect
TIME command sets the device time without considering these settings

30 Protocol 3000 - Commands

2.3 File System Commands

Command Description Type Permission

DEL Delete file File System Administrator
DIR List files in device File System Administrator
FORMAT Format file system File System Administrator
FS-FREE? Get file system free space File System Administrator
GET Get file File System Administrator
LOAD Load file to device File System End User Internal SW

Command - DEL Command Type - File System

Command Name Permission Transparency
Set: DEL Administrator Public
Get: - - -
Description Syntax
Set: Delete file #DEL␠file_name␍
Get:
Response

~nn@DEL␠file_name␍␊
Parameters
file_name - name of file to delete (file names are case-sensitive)
Response Triggers

Notes

Protocol 3000 - Commands 31

Command - DIR Command Type - File System
Command Name Permission Transparency
Set: DIR Administrator Public
Get: - - -
Description Syntax
Set: List files in device #DIR␍
Get: - -
Response
Multi Line:
~nn@DIR␍␊
file_name TAB file_size␠bytes,␠ ID:␠file_id␍␊
TABfree_size␠bytes.␍␊
Parameters
file_name - name of file
file_size - file size in bytes. A file can take more space on device memory
file_id - internal ID for file in file system
free_size - free space in bytes in device file system
Response Triggers

Notes

Command - FORMAT Command Type - File System

Command Name Permission Transparency
Set: FORMAT Administrator Public
Get: - - -
Description Syntax
Set: Format file system #FORMAT␍
Get: - -
Response

~nn@FORMAT␠OK␍␊
Parameters

Response Triggers

Notes
Response could take some time (seconds) until formatting completes

32 Protocol 3000 - Commands

 Command - FS-FREE? Command Type - File System
Command Name Permission Transparency
Set: - - -
Get: FS-FREE? Administrator Public
Description Syntax
Set: - -
Get: Get file system free space #FS-FREE?␍
Response

~nn@FS_FREE␠free_size␍␊
Parameters
free_size - free size in device file system in bytes
Response Triggers

Notes

Command - GET Command Type - File System

Command Name Permission Transparency
Set: - - -
Get: GET Administrator Public
Description Syntax
Set: - -
Get: Get file #GET␠file_name␍
Response
Multi-line:
~nn@GET␠file_name, file_size␠READY ␍␊
contents
~nn@GET␠file_name␠OK ␍␊
Parameters
file_name - name of file to get contents
contents - byte stream of file contents
file_size - size of file (device sends it in response to give user a chance to get ready)
Response Triggers

Notes

Protocol 3000 - Commands 33

Command - LOAD Command Type - System - Packets
Command Name Permission Transparency
Set: LOAD Administrator Public
Get: - - -
Description Syntax
Set: Load file to device #LOAD␠file_name,size␍
Get: - -
Response
Data sending negotiation:
* Device -
~01@LOAD␠file_name,size␠READY␍␊
* End User (+Device)-
Send file in Protocol Packets
* Device -
~01@LOAD␠file_name, size␠OK␍␊
Parameters
file_name - name of file to save on device
size - size of file data that is sent.
Response Triggers

Notes
See the Protocol Packet reference in Section ‎4

34 Protocol 3000 - Commands

2.4 Authentication Commands

Command Description Type Permission

LOGIN Set/get protocol permission Authentication Not Secure
LOGOUT Cancel current permission level Authentication Not Secure
PASS Set/get password for login level Authentication Administrator
SECUR Set/get current security state Authentication Administrator

Command - LOGIN Command Type - Authentication

Command Name Permission Transparency
Set: LOGIN Not Secure Public
Get: LOGIN? Not Secure Public
Description Syntax
Set: Set protocol permission #LOGIN␠login_level, password␍
Get: Get current protocol permission level #LOGIN?␍
Response

Set: ~nn@LOGIN␠login_level,password␠OK␍␊
or
~nn@LOGIN␠ERR␠004␍␊ (if bad password entered)
Get: ~nn@LOGIN␠login_level␍␊
Parameters
login_level - level of permissions required (End User or Admin)
password - predefined password (by PASS command). Default password is an empty string
Response Triggers

Notes
For devices that support security, LOGIN allows to the user to run commands with an End User or
Administrator permission level
In each device, some connections can be logged in to different levels and some do not work with security at
all
Connection may logout after timeout
The‎permission‎system‎works‎only‎if‎security‎is‎enabled‎with‎the‎“SECUR”‎command

Protocol 3000 - Commands 35

Command - LOGOUT Command Type - Authentication
Command Name Permission Transparency
Set: LOGOUT Not Secure Public
Get: - - -
Description Syntax
Set: Cancel current permission level #LOGOUT␍
Get: - -
Response

~nn@LOGOUT␠OK␍␊
Parameters

Response Triggers

Notes
Logs out from End User or Administrator permission levels to Not Secure

Command - PASS Command Type - Authentication

Command Name Permission Transparency
Set: PASS Administrator Public
Get: PASS? Administrator Public
Description Syntax
Set: Set password for login level #PASS␠login_level, password␍
Get: Get password for login level #PASS?␠login_level␍
Response

~nn@PASS␠login_level, password␍␊
Parameters
login_level - level of login to set (End User or Administrator).
password - password for the login_level. Up to 15 printable ASCII chars
Response Triggers

Notes
The default password is an empty string

36 Protocol 3000 - Commands

Command - SECUR Command Type - Authentication
Command Name Permission Transparency
Set: SECUR Administrator Public
Get: SECUR? Not Secure Public
Description Syntax
Set: Start/stop security #SECUR␠security_mode␍
Get: Get current security state #SECUR?␍
Response

~nn@SECUR␠security_mode␍␊
Parameters
security_mode – 1/ON - enables security, 0/OFF - disables security
Response Triggers

Notes
The permission system works‎only‎if‎security‎is‎enabled‎with‎the‎“SECUR”‎command

Protocol 3000 - Commands 37

2.5 Switching/Routing Commands

Note: Use the ROUTE command in preference to legacy AUD, VID, and AV
commands (see below).

Command Description Type Permission

AFV Set/get audio follow video mode Switching End User
AUD Set/get audio switch state Switching End User
AV Switch audio and video Switching End User
MTX-MODE Set/get auto-switch mode Switching End User
ROUTE Set/get layer routing Routing End User
VID Set/get video switch state Switching End User

Command - AFV Command Type - Switching

Command Name Permission Transparency
Set: AFV End User Public
Get: AFV? End User Public
Description Syntax
Set audio follow video/audio breakaway
Set: #AFV␠afv_mode␍
mode
Get: Get audio follow video mode status #AFV?␍
Response

~nn@AFV␠afv_mode␍␊
Parameters
afv_mode - front panel AFV mode
0/afv - sets the unit to the audio-follow-video switching mode
1/brk - sets the unit to the audio breakaway switching mode
Response Triggers

Notes
When the unit moves from breakaway to audio follow video switching mode, all audio switch settings are
reset according to the video switch settings.

38 Protocol 3000 - Commands

Command - AUD Command Type - Switching
Command Name Permission Transparency
Set: AUD End User Public
Get: AUD? End User Public
Description Syntax
Set: Set audio switch state #AUD␠in>out, in>out,…␍

#AUD?␠out␍
Get: Get audio switch state
#AUD?␠* ␍
Response

Set: ~nn@AUD␠in>out␍␊
~nn@AUD␠in>out␍␊ …
Get: ~nn@AUD␠in>out␍␊
~nn@AUD␠in>1,in>2,…␍␊
Parameters
In - input number or '0' to disconnect output
> - connection character between in and out parameters
out - output number or '*' for all outputs
Response Triggers

Notes
When AFV switching mode is active, this command also switches video and the unit replies with command
~AV

Command - AV Command Type - Switching

Command Name Permission Transparency
Set: AV End User Public
Get: - - -
Description Syntax
Set: Switch audio and video #AV␠in>out, in>out,…␍
Get: - -
Response

~nn@AV␠in>out, in>out,…␍␊
Parameters
in - input number or '0' to disconnect output
> - connection character between in and out parameters
out - output number or '*' for all outputs
Response Triggers

Notes

Protocol 3000 - Commands 39

Command – MTX-MODE Command Type – Switch
Command Name Permission Transparency
Set: MTX-MODE End User Public
Get: MTX-MODE? End User Public
Description Syntax
Set: Set auto-switch mode # MTX-MODE ␠output_id, mode␍
Get : Get auto-switch mode # MTX-MODE? ␠ output_id␍
Response

~ nn@ MTX-MODE␠output_id,mode␍
Parameters
output_id - 1….num‎of‎system‎outputs
mode - 0 - manual, 1 - auto priority, 2 - auto last connected
Response Triggers
After execution, a response is sent to the com port from which the Set/Get was received
After execution, a response is sent to all com ports if MTX-MODE was set by any other external control
device (button press, WEB, device menu and similar)
Notes
Not recommended for new devices

Command - ROUTE Command Type - Routing

Command Name Permission Transparency
Set: ROUTE End User Public
Get: ROUTE? End User Public
Description Syntax
Set: Set layer routing #ROUTE␠layer, dest, src␍
Get: Get layer routing #ROUTE?␠layer, dest␍
Response

~ nn@ ROUTE␠ layer, dest, src ␍␊

Parameters
layer - see Section ‎5.13 Layer Enumeration
dest - * - ALL
x - disconnect, otherwise destination id
src - source id
Response Triggers

Notes
This command replaces all other routing commands.

40 Protocol 3000 - Commands

Command - VID Command Type - Switching
Command Name Permission Transparency
Set: VID End User Public
Get: VID? End User Public
Description Syntax
Set: Set video switch state #VID␠in>out, in>out,…␍

#VID?␠out␍
Get: Get video switch state
#VID?␠ * ␍
Response

Set: ~nn@VID␠in>out ␍␊
~nn@VID␠in>out ␍␊ …
Get: ~nn@VID␠in>out ␍␊
~nn@VID␠in>1, in>2, …‎␍␊
Parameters
in - input number or '0' to disconnect output
> - connection character between in and out parameters
out - output number or '*' for all outputs
Response Triggers

Notes
When AFV switching mode is active, this command also switches audio and the unit replies with command
~AV.
Examples
When AFV switching mode is active, this command also switches audio and the unit replies with command
~AV.
Switch video and audio input 3 to output 7 #AV 3>7CR ~01@AV 3>7CRLF
Switch video input 2 to output 4 #V 2>4CR ~01@VID 2>4CRLF
Switch video input 4 to output 2 in machine 6 #6@VID 4>2CR ~06@VID 4>2CRLF
Disconnect video and audio output 4 #AV 0>4CR ~01@AV 0>4CRLF
Switch video input 3 to all outputs #V 3>* CR ~01@VID 3>* CRLF
Chaining #AV 1>* | V 3>4, 2>2, 2>1, 0>2 | V 3>9 | A 0>1 | V? * CR
multiple 1. Switch audio and video from input 1 to all outputs ~AV 1>*CRLF
commands 2. Switch video input 3 to output 4, ~VID 3>4 CRLF
video input 2 to output 2, ~VID 2>2 CRLF
video input 2 to output 1 and
~VID 2>1 CRLF
disconnect video output 2
~VID 0>2 CRLF
3. Switch video input 3 to output 9 (non-existent)
4. Disconnect audio output 1
5. Get status of all video links ~VID ERR003 CRLF
Command processing begins after entering CR ~AUD 0>1CRLF
A response is sent for each command after processing ~VID 2>1, 0>2, 1>3,
3>4 CRLF

Protocol 3000 - Commands 41

2.6 Video Commands
Command Description Type Permission
BCKGRND Set/get screen background color Video End User
DEF-RES Set/get custom defined scaled video output Video Administrator
resolution‎to‎“VIC”‎index‎
DETAIL-TIMING Set/get detail timing parameters Video End User
GNLCK Set/get genlock state Video End User
H-PHASE Set/get H-phase Video End User
SIG-TYPE Set/get signal type on input/output Video End User
VFRZ Set/get output freeze Video End User
VID-PATTERN Set/get test pattern on output Video End User
VID-RES Set/get output resolution Video End User
VIEW-MOD Set/get view mode Video End User
VMUTE Set/get video on output mute Video End User

Command - BCKGRND Command Type - Video

Command Name Permission Transparency
Set: BCKGRND End User Public
Get BCKGRND? End User Public
Description Syntax
Set: Set screen background color #BCKGRND␠ColSpaceType,p1,p2,p3␍
Get: Get screen background color #BCKGRND?␍
Response

~ nn@BCKGRND␠ColSpaceType,p1,p2,p3␍␊
Parameters
ColSpaceType - define color space in use (see Section ‎5.6 Color Space)
p1,p2,p3 - according to color space value:
RGB - R,G,B
YCbCr - Y,Cb,Cr
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if BCKGRND was set by any other external control device
(button press, device menu and similar)
Notes

42 Protocol 3000 - Commands

Command - DEF-RES Command Type - Video
Command Name Permission Transparency
Set DEF-RES Administrator Public
Get DEF-RES? End User Public
Description Syntax

Set custom defined #DEF-RES␠

Set: scaled video output Table_id,Width,Height,Htotal,VTotal,HSyncW,HSyncBackPorch,
resolution to ID index VSyncW,VSyncBackPorch,FrRate,Interlaced ␍
Get custom defined video
Get:
resolution #DEF-RES?␠Table_id,stage,stage_id ␍

Response

~ nn@DEF-RES ␠
Table_id,Width,Height,Htotal,VTotal,HSyncW,HSyncBackPorch,VSyncW,VSyncBackPorch,FrRate,Interlaced␍␊
Parameters
Table_id - index in resolution table (see Section ‎5.5 Video Resolutions). Valid indexes for SET are 100-104
only
Custom resolution parameters - by name (self-explanatory), numeric value
Interlaced - interlaced/progressive according to Section ‎5.1 On/Off (“ON”- I,‎“OFF”‎- P)
Stage - input/output (see Section ‎5.2 Stage)
Stage_id - number of chosen stage (1...max number of inputs/outputs)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if DEF-RES was set by any other external control device
(button press, device menu and similar)
Notes

If a requested custom resolution is not defined, yet is in the device, it returns ERR␠003 (out of range)
Only indexes 100-104 are valid for custom defined resolution
In Get command when sending:
index 0 - device replies with detailed info of native resolution
index 255 - device replies with detailed info of current resolution

Protocol 3000 - Commands 43

Command - DETAIL-TIMING Command Type - Video
Command Name Permission Transparency
Set: DETAIL-TIMING End User Public
Get: DETAIL-TIMING? End User Public
Description Syntax
Set: Set detail timing parameters #DETAIL-TIMING␠param, channel, value␍
Get: Get detail timing parameters #@DETAIL-TIMING?␠param, channe␍␊
Response

Set / Get: ~nn@DETAIL-TIMING␠param, channel, value␍␊

Parameters
param – See Section ‎5.10 Detail Timing Parameters
channel - input number
value - video parameter in Kramer units, minus sign precedes negative values
++ increase current value,
-- decrease current value
Response Triggers

Notes

Command - GNLCK Command Type - Video

Command Name Permission Transparency
Set: GNLCK Administrator Public
Get: GNLCK? End User Public
Description Syntax
Set: Set genlock source and mode #GNLCK␠out,in,type␍
Get: Get genlock source, mode and status #GNLCK?␠out␍
Response

Set / Get: ~ nn@GNLCK␠out,in,status ␍␊

Parameters
out - output number (1 .. max number of outputs)
in - input number (1…‎max‎number of inputs)
type - genlock type (see Section ‎5.4 Genlock Types)
status - genlock status (ON/OFF) (see Section ‎5.1 On/Off )
Response Triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if GNLCK was set for any other external control device
(button press, device menu and similar) or genlock status changed
Notes

44 Protocol 3000 - Commands

Command - H-PHASE Command Type - Video
Command Name Permission Transparency
Set: H-PHASE End User Public
Get: H-PHASE? End User Public
Description Syntax
Set: Set H-phase #H-PHASE␠stage, channel, value␍
Get: Get H-phase #H-PHASE?␠stage, channel␍
Response

Set / Get: ~nn@H-PHASE ␠stage, channel, value␍␊

Parameters
stage - ‘IN,‎’OUT’‎or‎numeric‎value‎of‎present‎video‎processing‎stage‎
For‎example:‎‘1’‎for‎input‎value,‎‘2’‎for‎output
channel - input or output number
value - video parameter in Kramer units, minus sign precedes negative values
++ increase current value,
-- decrease current value
Response Triggers

Notes

Command - SIG-TYPE Command Type - Video

Command Name Permission Transparency
Set: SIG-TYPE End User Public
Get SIG-TYPE? End User Public
Description Syntax

Set: Set signal type on input/output #SIG-TYPE␠stage, stage_id,type␍

Get: Get signal type on input/output #SIG-TYPE?␠stage,stage_id␍
Response

~ nn@SIG-TYPE ␠stage,stage_id,type␍␊
Parameters
stage - input/output (see Section ‎5.2 Stage)
stage_id - number of chosen stage (1.. max number of inputs/outputs)
type - signal type (see Section ‎5.3 Signal Type)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if SIG-TYPE was set by any other external control device
(button press, device menu and similar)
Notes
“Set”‎command‎is‎not‎available‎for‎all‎devices‎(refer‎to device specifications)

Protocol 3000 - Commands 45

Command - VFRZ Command Type - Multiviewer
Command Name Permission Transparency
Set: VFRZ End User Public
Get VFRZ? End User Public
Description Syntax

Set: Set freeze on selected output #VFRZ␠out_id,freeze_flag␍

Get: Get output freeze status #VFRZ?␠out_id␍

Response

~ nn @VFRZ␠win_num, freeze_flag␍␊

Parameters
out_id -output number
freeze_flag - see Section ‎5.1 On/Off
Response Triggers

After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if VFRZ was set by any other external control device
(button press, device menu and similar)

Notes

46 Protocol 3000 - Commands

Command – VID-PATTERN Command Type – Video
Command Name Permission Transparency
Set: VID-PATTERN End User Public
Get: VID-PATTERN? End User Public
Description Syntax
Set: Set test pattern on output #VID-PATTERN␠output_id,pattern_id␍
Get : Get test pattern on output #VID-PATTERN?␠output_id␍
Response

~ nn@VID-PATTERN␠output_id,pattern_id␍
Parameters
output_id - 1….num‎of‎system‎outputs
pattern_id - 1…num‎of‎system‎patterns
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if VID-PATTERN was set by any other external control
device (button press, WEB, device menu and similar)
Notes

Protocol 3000 - Commands 47

Command - VID-RES Command Type - Video
Command Name Permission Transparency
Set: VID-RES End User Public
Get VID-RES? End User Public
Description Syntax
Set: Set output resolution #VID-RES␠stage, stage_id,is_native,resolution␍
Get: Get output resolution #VID-RES?␠stage,stage_id,is_native ␍
Response

~ nn@VID-RES ␠stage,stage_id,is_native,resolution␍␊
Parameters
stage - input/output (see Section ‎5.2 Stage)
stage_id - number of chosen stage (1... max number of inputs/outputs)
is_native - native resolution flag (see Section ‎5.1 On/Off )
resolution - resolution index (see Section ‎5.5 Video Resolutions)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if VID-RES was set by any other external control device
(button press, device menu and similar)
Notes
“Set”‎command‎is‎only‎applicable‎for‎stage=Output
“Set”‎command‎with‎is_native=ON sets native resolution on selected output (resolution index sent = 0).
Device sends as answer actual VIC ID of native resolution
“Get”‎command‎with‎is_native=ON returns native resolution VIC, with is_native=OFF returns current
resolution
To‎use‎“custom‎resolutions”‎(entries‎100-105 In Section ‎5.8 View Modes), define them using the DEF-RES
command

48 Protocol 3000 - Commands

Command - VMUTE Command Type - Video
Command Name Permission Transparency
Set: VMUTE End User Public
Get: VMUTE? End User Public
Description Syntax
Set: Set enable/disable video on output #VMUTE␠output_id, flag␍
Get: Get video on output status #VMUTE?␠output_id␠ ␍
Response

Set / Get: ~ nn@ VMUTE␠output_id, flag␍␊

Parameters
output_id - 1….num‎of‎system‎outputs
flag - 0 - disable video on output
1 - enable video on output
2 - blank video
Response Triggers

Notes

Protocol 3000 - Commands 49

2.7 Audio Commands

These commands are used by audio devices running Protocol 3000.

Command Description Type Permission

AUD-EMB Set/get audio in video embedding status Audio End user
AUD-LVL Set/get audio level in specific amplifier stage Audio End User
AUD-SIGNAL? Get audio input signal status Audio End user
AUX-DELAY Set/get audio delay level Audio End user
BALANCE Set/get balance level Audio End User
BASS Set/get audio bass level Audio End User
EQ-LVL Set/get equalization level Audio End User
LOUDNESS Set/get audio loudness Audio End User
MIC-DELAY Set/get delay for microphone output Audio End User
MIC-GAIN Set/get microphone gain Audio End User
MIDRANGE Set/get audio midrange level Audio End User
MIX Set/get audio mix Audio End User
MIX-LVL Set/get mixing level of selected output Audio End User
MUTE Set/get audio mute Audio End User
STEREO Set/get stereo audio Audio End User
TEST-FREQ Set/get signal generator frequency Audio End User
TLK Set/get audio talkover mode status Audio End User
TREBLE Set/get audio treble level Audio End User

50 Protocol 3000 - Commands

Command - AUD-EMB Command Type - Audio
Command Name Permission Transparency
Set: AUD-EMB End User Public
Get: AUD-EMB? End User Public
Description Syntax
Set: Set audio in video embedding status #AUD-EMB␠in,out,status␍
Get: Get audio in video embedding status #AUD-EMB?␠in,out␍
Response

Set/Get: ~ nn@AUD-EMB␠in,out,status␍␊
Parameters
in - audio input to be embedded number (1…‎max‎number of inputs)
out - video output to embed into number (1 .. max number of outputs)
status - embedded (ON), or not (OFF) status (see Section ‎5.1 On/Off)
Response Triggers
Response is sent to the com port from which the Set (before execution)/Get command was received
After execution, response is sent to all com ports if AUD-EMB was set by any other external control device
(button press, device menu and similar)
Notes

Command - AUD-LVL Command Type - Audio

Command Name Permission Transparency
Set: AUD-LVL End User Public
Get: AUD-LVL? End User Public
Description Syntax
Set: Set audio level in specific amplifier stage #AUD-LVL␠stage, channel, volume␍
Get: Get audio level in specific amplifier stage #AUD-LVL?␠stage, channel␍
Response

~nn@AUD-LVL␠stage, channel, volume␍␊

Parameters
stage - ‘IN,‎’OUT’‎or‎numeric‎value‎of‎present‎audio‎processing stage
For‎example:‎‘1’‎for‎input‎level,‎‘2’‎for‎output
channel - input or output number
volume - audio parameter in Kramer units, minus sign precedes negative values.
++ increase current value,
-- decrease current value
Response Triggers

Notes

Protocol 3000 - Commands 51

Command - AUD-SIGNAL Command Type - Audio
Command Name Permission Transparency
Set: - - -
Get AUD-SIGNAL? End User Public
Description Syntax
Set: - -
Get: Get audio input signal status # AUD-SIGNAL?␠inp_id␍
Response

~ nn@ AUD-SIGNAL␠ inp_id, status ␍␊

Parameters
Inp_id - input number (1 .. max input number)
status - 0 - OFF (no signal)
1 - ON (signal present
Response Triggers
After execution, response is sent to the com port from which the Get was received
Response is sent to all com ports if audio status state was changed on any input
Notes

Command - AUD-DELAY Command Type - Audio

Command Name Permission Transparency
Set: AUX-DELAY End User Public
Get AUX-DELAY? End User Public
Description Syntax

Set: Set audio delay value #AUX-DELAY␠out_channel, delay_value␍

Get: Get audio delay value #AUX-DELAY?␠ out_channel ␍

Response

~ nn@ AUD-SIGNAL␠ inp_id, status ␍␊

~ nn @AUX-DELAY␠out_channel, delay_value␍␊
Parameters
out_channel - output number or 0 / 1 / 2 for left / right / both
delay_value - audio parameter in Kramer units, minus sign precedes negative values
++ increase current value
- - decrease current value
Response Triggers

Notes

52 Protocol 3000 - Commands

Command - BALANCE Command Type - Audio
Command Name Permission Transparency
Set: BALANCE End User Public
Get: BALANCE? End User Public
Description Syntax
Set: Set balance level #BALANCE␠out_channel, balance_level␍
Get: Get balance level #BALANCE?␠out_channel␍
Response

~nn@BALANCE␠out_channel, balance_level␍␊
Parameters
out_channel - output number
balance_level - audio parameter in Kramer units, minus sign precedes negative values
++ increase current value
-- decrease current value
Response Triggers

Notes

Protocol 3000 - Commands 53

Command - BASS Command Type - Audio
Command Name Permission Transparency
Set: BASS End User Public
Get: BASS? End User Public
Description Syntax
Set: Set audio bass level #BASS␠channel, bass_level␍
Get: Get audio bass level #BASS?␠channel␍
Response

~nn@BASS␠channel, bass_level␍␊
Parameters
channel - input or output number
bass_level - audio parameter in Kramer units, minus sign precedes negative values
++ increase current value
-- decrease current value
Response Triggers

Notes

Command – EQ-LVL Command Type – Audio

Command Name Permission Transparency
Set: EQ-LVL End User Public
Get: EQ-LVL? End User Public
Description Syntax

Set: Set equalization level # EQ-LVL␠ P1,P2,P3 ␍

Get : Get equalization level # EQ-LVL? ␠ P1,P2 ␍
Response

Set / Get : ~ nn @EQ-LVL ␠ P1,P2,P3 ␍␊

Parameters
P1 - audio output number – 0-audio out, 1-Scaler1, 2-Scaler2
P2 - frequency number – See Section ‎5.23 Frequency Number
P3 – audio level – See Section ‎5.24 Audio Level
Response triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the EQ level for the selected frequency of the selected audio output

54 Protocol 3000 - Commands

Command - LOUDNESS Command Type - Audio
Command Name Permission Transparency
Set: LOUDNESS End User Public
Get: LOUDNESS? End User Public
Description Syntax
Set: Set audio loudness #LOUDNESS␠channel, loudness␍
Get: Get audio loudness #LOUDNESS?␠channel␍
Response

~nn@LOUDNESS␠channel, loudness␍␊
Parameters
channel - input or output number
loudness - 0 or OFF / 1 or ON
Response Triggers

Notes

Command - MIC-DELAY Command Type - Audio

Command Name Permission Transparency
Set: MIC-DELAY End User Public
Get: MIC-DELAY? End User Public
Description Syntax

Set: Set delay for microphone output. # MIC-DELAY␠id, delay ␍

Get: Get delay for microphone output. # MIC-DELAY? ␠id␍

Response

~nn@MIC-DELAY␠id,delay␍␊
Parameters
Id - MIC id
Delay - 0-85ms
Response Triggers

Notes

Protocol 3000 - Commands 55

Command – MIC-GAIN Command Type – Audio
Command Name Permission Transparency
Set: MIC-GAIN End User Public
Get: MIC-GAIN? End User Public
Description Syntax

Set: Set the microphone gain # MIC-GAIN ␠ P1,P2 ␍

Get : Get the microphone gain # MIC-GAIN? ␠ P1 ␍
Response

Set / Get : ~ nn @MIC-GAIN ␠ P1,P2 ␍␊

Parameters
P1 - Input number, for VP-553 always 0
P2 - level – 0 to 100
Response Triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the microphone input audio gain

Command - MIDRANGE Command Type - Audio

Command Name Permission Transparency
Set: MIDRANGE End User Public
Get: MIDRANGE? End User Public
Description Syntax
Set: Set audio midrange level #MIDRANGE␠channel, midrange_level␍
Get: Get audio midrange level #MIDRANGE?␠channel␍
Response

~nn@MIDRANGE␠channel, midrange_level␍␊
Parameters
channel - input or output number
midrange_level - audio parameter in Kramer units, minus sign precedes negative values
++ increase current value
-- decrease current value
Response Triggers

Notes

56 Protocol 3000 - Commands

Command - MIX Command Type - Audio
Command Name Permission Transparency
Set: MIX End User Public
Get: MIX? End User Public
Description Syntax
Set: Set audio MIX #MIX␠channel, mix_mode␍
Get: Get audio MIX #MIX?␍
Response

~nn@MIX␠channel, mix_mode␍␊
Parameters
channel - output number
mix_mode - 0 or OFF / 1 or ON
Response Triggers

Notes

Command – MIX-LVL Command Type – Audio

Command Name Permission Transparency
Set: MIX-LVL End User Public
Get: MIX-LVL? End User Public
Description Syntax

Set: Set mixing level of selected output # MIX-LVL␠ P1,P2 ␍

Get : Get mixing level of selected output # MIX-LVL?␠ P1 ␍
Response

Set / Get : ~ nn @MIX-LVL ␠ P1,P2 ␍␊

Parameters
P1 - output number
P2 – mixing level - 0 to 100
Response triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the mixing level between the audio of the selected video In and the selected AUX audio channel

Protocol 3000 - Commands 57

Command - MUTE Command Type - Audio
Command Name Permission Transparency
Set: MUTE End User Public
Get: MUTE? End User Public
Description Syntax
Set: Set audio mute #MUTE␠channel,mute_mode␍
Get: Get audio mute #MUTE?␠channel␍
Response

~nn@MUTE␠channel, mute_mode␍␊
Parameters
channel - output number
mute_mode - 0 or OFF / 1 or ON
Response Triggers

Notes

Command - STEREO Command Type - Audio

Command Name Permission Transparency
Set: STEREO End User Public
Get: STEREO? End User Public
Description Syntax
Set: Set stereo audio #STEREO␠channel,stereo_mode␍
Get: Get stereo audio #STEREO?channel,␍
Response

~nn@STEREO␠ channel,stereo_mode␍␊
Parameters
channel - output number
stereo_mode - 0 or OFF / 1 or ON
Response Triggers

Notes

58 Protocol 3000 - Commands

Command - TEST-FREQ Command Type - Audio
Command Name Permission Transparency
Set: TEST-FREQ End User Public
Get: TEST-FREQ? End User Public
Description Syntax

Set: Sets signal generator frequency #TEST_FREQ␠frequency ␍

Get: Gets signal generator frequency #TEST_FREQ? ␠

Response

~ nn@TEST_FREQ␠frequency ␍␊
Parameters
frequency - 20-24000Hz
Response Triggers

Notes

Command - TLK Command Type - Audio

Command Name Permission Transparency
Set: TLK End User Public
Get: TLK? End User Public
Description Syntax
Set: Set audio talkover mode status #TLK␠channel,talkover_mode␍
Get: Get audio talkover mode status #TLK?channel,␍
Response

~nn@TLK␠channel,talkover_mode␍␊
Parameters
channel - output number
talkover_mode - 0 or OFF / 1 or ON
Response Triggers

Notes

Protocol 3000 - Commands 59

Command - TREBLE Command Type - Audio
Command Name Permission Transparency
Set: TREBLE End User Public
Get: TREBLE? End User Public
Description Syntax
Set: Set audio treble level #TREBLE␠channel, treble_level␍
Get: Get audio treble level #TREBLE?␠channel␍
Response

~nn@TREBLE␠channel, treble_level␍␊
Parameters
channel - input or output number
treble_level - audio parameter in Kramer units, minus sign precedes negative values
++ increase current value
-- decrease current value
Response Triggers

Notes

60 Protocol 3000 - Commands

2.8 Communication Commands

These commands are used by network devices running Protocol 3000.

Command Description Type Permission

ETH-PORT Set/get Ethernet port protocol Communication Administrator
NET-DHCP Set/get DHCP mode Communication Administrator
NET-GATE Set/get gateway IP Communication Administrator
NET-IP Set/get IP address Communication Administrator
NET-MAC? Get MAC address Communication End User
NET-MASK Set/get subnet mask Communication Administrator
TIME-SRV Set/get time server Communication Administrator
UART Set/get com port configuration Communication Administrator
UDP-TOUT Set/get UDP client timeout Communication Administrator

Command - ETH-PORT Command Type - Communication

Command Name Permission Transparency
Set: ETH-PORT Administrator Public
Get: ETH-PORT? End User Public
Description Syntax
Set: Set Ethernet port protocol #ETH-PORT␠portType, ETHPort ␍
Get: Get Ethernet port protocol #ETH-PORT?␠portType ␍
Response

~nn@ ETH-PORT␠portType, ETHPort␍␊

Parameters
portType - TCP/UDP
ETHPort - TCP/UDP port number
Response Triggers

Notes

Protocol 3000 - Commands 61

Command - NET-DHCP Command Type - Communication
Command Name Permission Transparency
Set: NET-DHCP Administrator Public
Get: NET-DHCP? End User Public
Description Syntax
Set: Set DHCP mode #NET-DHCP␠mode␍
Get: Get DHCP mode #NET-DHCP?␍
Response

~nn@ NET-DHCP␠mode␍␊
Parameters
mode - 0 - Do not use DHCP. Use the IP set by the factory or using the IP set command
1 - Try to use DHCP. If unavailable, use IP as above
Response Triggers

Notes
Connecting Ethernet to devices with DHCP may take more time in some networks
To connect with a randomly assigned IP by DHCP, specify the device DNS name (if available) using the
command‎“NAME”.‎You‎can‎also‎get‎an‎assigned‎IP‎by‎direct‎connection to USB or RS-232 protocol port if
available
For proper settings consult your network administrator

Command - NET-GATE Command Type - Communication

Command Name Permission Transparency
Set: NET-GATE Administrator Public
Get: NET-GATE? End User Public
Description Syntax
Set: Set gateway IP #NET-GATE␠ ip_address␍
Get: Get gateway IP #NET-GATE?␍
Response

~nn@NET-GATE␠ip_address␍␊
Parameters
ip_address - format: xxx.xxx.xxx.xxx
Response Triggers

Notes
A network gateway connects the device via another network and maybe over the Internet. Be careful of
security problems. For proper settings consult your network administrator

62 Protocol 3000 - Commands

Command - NET-IP Command Type - Communication
Command Name Permission Transparency
Set: NET-IP Administrator Public
Get: NET-IP? End User Public
Description Syntax
Set: Set IP address #NET-IP␠ip_address␍
Get: Get IP address #NET-IP?␍
Response

~nn@ NET-IP␠ip_address␍␊
Parameters
ip_address - format: xxx.xxx.xxx.xxx
Response Triggers

Notes
For proper settings consult your network administrator

Command - NET-MAC? Command Type - Communication

Command Name Permission Transparency
Set: - - -
Get: NET-MAC? End User Public
Description Syntax
Set: - -
Get: Get MAC address #NET-MAC?␍
Response

~nn@NET-MAC␠mac_address␍␊
Parameters
mac_address - Unique MAC address. Format: XX-XX-XX-XX-XX-XX where X is hex digit
Response Triggers

Notes

Protocol 3000 - Commands 63

Command - NET-MASK Command Type - Communication
Command Name Permission Transparency
Set: NET-MASK Administrator Public
Get: NET-MASK? End User Public
Description Syntax
Set: Set subnet mask #NET-MASK␠net_mask␍
Get: Get subnet mask #NET-MASK?␍
Response

~nn@NET-MASK␠net_mask␍␊
Parameters
net_mask - format: xxx.xxx.xxx.xxx
Response Triggers
The subnet mask limits the Ethernet connection within the local network
For proper settings consult your network administrator
Notes

Command - TIME-SRV Command Type - Communication

Command Name Permission Transparency
Set: TIME-SRV Administrator Public
Get: TIME-SRV? End User Public
Description Syntax
Set: Set time server #TIME-SRV␠mode, time_server_IP, time_server_Sync_Hour, ␍
Get: Get time server #TIME-SRV?␍
Response

~ nn@TIME-SRV␠mode, time_server_IP, time_server_Sync_Hour,server_status␍␊

Parameters
mode - 0 - OFF, 1 - ON
time_server_IP - time server IP address
time_server_Sync_Hour - hour in day for time server sync
server_status – ON/OFF
Response Triggers

Notes
This command is needed for setting UDP timeout for the current client list

64 Protocol 3000 - Commands

Command - UART Command Type - Communication
Command Name Permission Transparency
Set: UART Administrator Public
Get: UART? End User Public
Description Syntax
Set: Set com port configuration # UART␠COM_Num, baud_rate, data_bit, parity, stop_bit␍
Get: Get com port configuration # UART?␠COM_Num␍
Response

Set: ~ nn@ UART␠COM_Num, baud_rate, data_bit, parity, stop_bit␍␊

Get: ~ nn@ UART␠COM_Num, baud_rate, data_bit, parity, stop_bit, serial1_type, 485_term␍␊
Parameters
COM_Num - 1-4
baud_rate - 9600 - 115200
data_bit - 7-8
parity - 'N', 'O', 'E', 'M', 'S' (see Section ‎5.20 Parity Types)
stop_bit - 1-2
serial1_type - 232/485 (see Section ‎5.21 Serial Types)
485_term - 1/0 (optional - this exists exist only when serial1_type = 485)
Response Triggers

Notes
In the FC-2x the serial port is selectable to RS-232 or RS-485 (usually serial port 1).
If Serial1 is configured when RS-485 is selected, the RS-485 UART port is automatically changed

Command - UDP-TOUT Command Type - Communication

Command Name Permission Transparency
Set: UDP-TOUT Administrator Public
Get: UDP-TOUT? End User Public
Description Syntax
Set: Set UDP client timeout #UDP-TOUT␠timeout_value, timeout_mode␍
Get: Get UDP client timeout #UDP-TOUT?␍
Response

~ nn@UDP-TOUT␠timeout_value, timeout_mode␍␊
Parameters
timeout_value - 0 - 43200 sec ( 0 - 12H)
timeout_mode - 0 - 3 (NO_TOUT/PROTOCOL_PORTS_ONLY/ /ALL_PORTS)
Response Triggers

Notes
This command is needed for setting UDP timeout client current client list

Protocol 3000 - Commands 65

2.9 Multiviewer/Scaler Commands

Command Description Type Permission

BEZEL Set bezel on/off , H/V correction Multiviewer End User
BRIGHTNESS Set/get window brightness Multiviewer End User
CONTRAST Set/get window contrast Multiviewer End User
CRDT Set/get window size and position Multiviewer End User
IMAGE-PROP Set/get the image size Multiviewer End User
OVRL Set/get text overlay parameters Multiviewer End User
OVRLBK Set/get text overlay background parameters Multiviewer End User
OVRLTXT Set/get overlay text Multiviewer End User
SCLR-AS Set/get auto-sync features Multiviewer End User
SCLR-AUDIO-DELAY Set audio delay for selected audio output Multiviewer End User
SCLR-PCAUTO Set PC auto sync of selected scaler Multiviewer End User
SHOW-OSD Set/get OSD display Multiviewer End User
VIEW-MOD Set/get layer display mode Multiviewer End User
W-ACTIVE Set/get active window Multiviewer End User
W-BRD Set/get window border Multiviewer End User
W-COLOR Set/get window color intensity Multiviewer End User
W-ENABLE Set/get window visibility Multiviewer End User
W-FRZ Set/get freeze on selected window Multiviewer End User
W-HUE Set/get window hue value Multiviewer End User
W-LAYER Set/get window overlay order OR Multiviewer End User
Set/get ALL window overlay order
W-POS Set/get window position Multiviewer End User
W-SATURATION Set/get window saturation Multiviewer End User
W-SHARP Set/get window sharpness value Multiviewer End User
W-SRC Set/get window source Multiviewer End User
W-ZOOM Set/get windows zoom Multiviewer End User

66 Protocol 3000 - Commands

Command - BEZEL Command Type - Multiviewer
Command Name Permission Transparency
Set: BEZEL End User Public
Get BEZEL? End User Public
Description Syntax
Set: Set bezel On/Off , H/V correction #BEZEL␠id,type,H,V␍
Get: Get bezel switch, H/V correction status #BEZEL␠id␍
Response

~ nn @ BEZEL␠id,type,H,V␍␊
Parameters
id - window id (for VP444, use "1")
type – 0-current H/V value, 1-max. H/V value
switch - enable/disable bezel correction (see Section ‎5.1 On/Off)
H,V – horizontal, vertical correction values
Response Triggers

Notes

Command - BRIGHTNESS Command Type - Multiviewer

Command Name Permission Transparency
Set: BRIGHTNESS End User Public
Get BRIGHTNESS? End User Public
Description Syntax
Set: Set window brightness #BRIGHTNESS␠win_num,value␍
Get: Get window brightness #BRIGHTNESS?␠win_num␍
Response

~ nn@BRIGHTNESS␠win_num, value␍␊
Parameters
win_num - window number setting brightness
value - brightness value
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if BRIGHTNESS was set by any other external control
device (button press, device menu and similar)
Notes
Value limits can vary for different devices
Value is a property of input connected to current window. Changing window input source might cause
changes in this value (refer device definitions)

Protocol 3000 - Commands 67

Command - CONTRAST Command Type - Multiviewer
Command Name Permission Transparency
Set: CONTRAST End User Public
Get CONTRAST? End User Public
Description Syntax
Set: Set window contract #CONTRAST␠win_num, value␍
Get: Get window contract #CONTRAST?␠win_num ␍
Response

~ nn@CONTRAST␠win_num, value␍␊
Parameters
win_num - window number setting contrast
value - contrast value
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if CONTRAST was set by any other external control device
(button press, device menu and similar)
Notes
Value limits can vary for different devices
Value is a property of input connected to current window. Changing the window input source might cause
changes in this value (refer to device definitions)

68 Protocol 3000 - Commands

Command - CRDT Command Type - Multiviewer
Command Name Permission Transparency
Set: CRDT End User Public
Get CRDT? End User Public
Description Syntax
Set: Set window size and position #CRDT␠win_num,x0,y0,x1,y1␍
Get: Get window size and position #CRDT?␠win_num␍
Response

Set: ~ nn@CRDT␠win_num,x0,y0,x1,y1[result]␍␊
Get: ~ nn@CRDT␠win_num,x0,y0,x1,y1␍␊
Parameters
Set: win_num - 1-4; x0,y0 - top-left coordinate, x1, y1 - bottom-right coordinate
Get:
x0,x1 <=180
y0,y1 <=144(for PAL)
y0,y1 <= 120(for NTSC)
win_num = 1-4 or 0 (for output window)
Response Triggers

Notes

Command – IMAGE-PROP Command Type – Multiviewer/Scaler

Command Name Permission Transparency
Set: IMAGE-PROP End User Public
Get: IMAGE-PROP? End User Public
Description Syntax

Set: Set the image size # IMAGE-PROP ␠ P1 ␍

Get : Get the image size # IMAGE-PROP? ␠ P1,…,P6 ␍
Response

Set / Get : ~ nn @IMAGE-PROP ␠ P1,P2…. ␍␊

Parameters
P1 - scaler number - 1-Scaler1, 2-Scaler2
P2 – status – See Section ‎5.7 Image Properties
Response triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the image properties of the selected scaler

Protocol 3000 - Commands 69

Command - OVRL Command Type - Multiviewer
Command Name Permission Transparency
Set: OVRL End User Public
Get OVRL? End User Public
Description Syntax
Set: Set text overlay parameters #OVRL␠stage, stage_id,mode,r,g,b,alpha␍
Get: Get text overlay parameters #OVRL?␠stage, stage_id ␍
Response

~ nn@OVRL␠stage, stage_id,mode,r,g,b,alpha␍␊
Parameters
stage - input/output (see Section ‎5.2 Stage)
stage_id - number of chosen stage (1.. max number of inputs/outputs)
mode - show/ hide text overlay string (see Section ‎5.1 On/Off)
r - red component value (0-255)
g - green component value (0-255)
b - blue component value (0-255)
alpha - alpha value (0-255)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if OVRL was set by any other external control device (button
press, device menu and similar)
Notes

70 Protocol 3000 - Commands

Command - OVRLBK Command Type - Multiviewer
Command Name Permission Transparency
Set: OVRLBK End User Public
Get OVRLBK? End User Public
Description Syntax
Set: Set text overlay background parameters #OVRLBK␠stage, stage_id,r,g,b,alpha␍
Get: Get text overlay background parameters #OVRLBK?␠stage, stage_id ␍
Response

~ nn@OVRLBK␠stage, stage_id,r,g,b,alpha␍␊
Parameters
stage - input/output - see Section ‎5.2 Stage
stage_id - number of chosen stage (1.. max number of inputs/outputs)
r - red component value (0-255)
g - green component value (0-255)
b - blue component value (0-255)
alpha - alpha value (0-255)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if OVRLBK was set by any other external control device
(button press, device menu and similar)
Notes

Protocol 3000 - Commands 71

Command - OVRLTXT Command Type - Multiviewer
Command Name Permission Transparency
Set: OVRLTXT End User Public
Get OVRLTXT? End User Public
Description Syntax
Set: Set overlay text #OVRLTXT␠stage,stage_id,type,size,x,y,string␍
Get: Get overlay text #OVRLTXT?␠stage,stage_id ␍
Response

~ nn@OVRLTXT␠stage,stage_id,type,size,x,y,string␍␊
Parameters
stage - input/output (see Section ‎5.2 Stage)
stage_id - number of chosen stage (1.. max number of inputs/outputs)
type - font type (only 0 supported currently, TBD)
size - font size (see Section ‎5.12 Font Size) for values
x - horizontal alignment (0 - Left, 1- Centered, 2- Right)
y - vertical alignment (0 - Top, 1- Centered, 2- Bottom)
string - tile text (up to 10 characters)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if OVRLTXT was set by any other external control device
(button press, device menu and similar)
Notes

72 Protocol 3000 - Commands

Command – SCLR-AS Command Type – Multiviewer/Scaler
Command Name Permission Transparency
Set: SCLR-AS End User Public
Get: SCLR-AS? End User Public
Description Syntax

Set: Set auto-sync features # SCLR-AS ␠ P1,P2 ␍

Get : Get auto-sync features # SCLR-AS?␠ P1 ␍
Response

Set / Get : ~ nn @ SCLR-AS ␠ P1,P2…. ␍␊

Parameters
P1 – scaler Number – 1-Scaler1, 2-Scaler2
P2 – On/Off – See Section ‎5.1 On/Off
Response triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the auto sync features for the selected scaler

Command – SCLR-AUDIO-DELAY Command Type – Multiviewer/Scaler

Command Name Permission Transparency
Set: SCLR-AUDIO-DELAY End User Public
Get: SCLR-AUDIO-DELAY? End User Public
Description Syntax

Set: Set the scaler audio delay # SCLR-AUDIO-DELAY␠ P1,P2 ␍

Get : Get the scaler audio delay # SCLR-AUDIO-DELAY? ␠ P1 ␍
Response

Set / Get : ~ nn @SCLR-AUDIO-DELAY ␠ P1,P2 ␍␊

Parameters
P1 - audio output number – 0-audio out, 1-Scaler1, 2-Scaler2
P2 - delay – See Section ‎5.25 Audio Delay
Response triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the audio delay for the selected audio output

Protocol 3000 - Commands 73

Command – SCLR-PCAUTO Command Type – Multiviewer/Scaler
Command Name Permission Transparency
Set: SCLR-PCAUTO End User Public
Get: - - -
Description Syntax

Set: Set PC auto sync of scaler # SCLR-PCAUTO ␠ P1,P2 ␍

Get : - -
Response

~ nn @ SCLR-PCAUTO ␠ P1,P2…. ␍␊
Parameters
P1 - Scaler number – 1-Scaler1, 2-Scaler2
P2 - Off/On – See Section ‎5.1 On/Off
Response triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if CMD-NAME was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes
Sets the PC auto sync of the selected scaler

Command – SHOW-OSD Command Type – Multiviewer/Scaler

Command Name Permission Transparency
Set: SHOW-OSD End User Public
Get: SHOW-OSD? End User Public
Description Syntax

Set: Set the OSD of selected channel # SHOW-OSD ␠ id,switch ␍

Get : Get the OSD of selected channel # SHOW-OSD?␠ ␍
Response

~ nn @SHOW-OSD ␠ id,switch ␍␊
Parameters
id – channel number
switch - On/Off – See Section ‎5.1 On/Off
Response Triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
After execution, response is sent to all com ports if SHOW-OSD was set any other external control device
(button press, device menu and similar) or genlock status was changed
Notes

74 Protocol 3000 - Commands

Command – VIEW-MOD Command Type – Multiviewer/Scaler
Command Name Permission Transparency
Set: VIEW-MOD End User Public
Get: VIEW-MOD? End User Public
Description Syntax

Set: Set view mode #VIEW-MOD ␠ mode ␍

Get : Get view mode #VIEW-MOD?␠
Response

~ nn @ VIEW-MOD ␠ ,mode␍␊
Parameters
mode – See Section ‎5.8 View Modes
Response Triggers

Notes

Command - W-ACTIVE Command Type - Multiviewer

Command Name Permission Transparency
Set: W-ACTIVE End User Public
Get W-ACTIVE? End User Public
Description Syntax
Set: Set active window #W-ACTIVE␠win_num␍
Get: Get active window #W-ACTIVE?␍
Response

~ nn@ W-ACTIVE␠ win_num␍␊

Parameters
win_num - window number setting active
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-ACTIVE was set by any other external control device
(button press, device menu and similar)
Notes

Protocol 3000 - Commands 75

Command - W-BRD Command Type - Multiviewer
Command Name Permission Transparency
Set: W-BRD End User Public
Get W-BRD? End User Public
Description Syntax
Set: Set window border #W-BRD␠win_num, enable␍
Get: Get window border status #W-BRD?␠win_num␍
Response

~ nn@W-BRD␠ id, switch,ColSpace,p1,p2,p3␍␊

Parameters
id - window id. (not applicable for VP-444, use "1") – goes to VP444 UM only
switch - enable/disable border, see Section ‎5.1 On/Off
ColSpace - See ‎5.6Section ‎5.6 Color Space. (for VP-444 RGB = 1)
P1,P2,P3 - R,G,B (ot Y,Cb,Cr) components for color, defined in the User Manual
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-BRD was set by any other external control device
(button press, device menu and similar)
Notes

76 Protocol 3000 - Commands

Command - W-COLOR Command Type - Multiviewer
Command Name Permission Transparency
Set: W-COLOR End User Public
Get W-COLOR? End User Public
Description Syntax
Set: Set window color intensity #W-COLOR␠win_num, value␍
Get: Get window color intensity #W-COLOR?␠win_num␍
Response

~ nn@ W-COLOR␠win_num, value␍␊

Parameters
win_num - window number setting contrast
value - color intensity value
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-COLOR was set by any other external control device
(button press, device menu and similar)
Notes
Value limits can vary for different devices
Depending on used color space, device firmware might make a translation from value to‎RGB/‎YCbCr…
Value is a property of input connected to current window. Changing window input source might cause
changes in this value (refer to device definitions)

Command - W-ENABLE Command Type - Multiviewer

Command Name Permission Transparency
Set: W-ENABLE End User Public
Get: W-ENABLE? End User Public
Description Syntax
Set: Set window visibility #W-ENABLE␠win_num,enable_flag␍
Get: Get window visibility status #W-ENABLE?␠win_num␍
Response

~ nn@ W-ENABLE␠win_num, enable_flag␍␊

Parameters
win_num - window number to enable/disable
enable_flag - See Section ‎5.1 On/Off
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-ENABLE was set by any other external control device
(button press, device menu and similar)
Notes

Protocol 3000 - Commands 77

Command - W-FRZ Command Type - Multiviewer
Command Name Permission Transparency
Set: W-FRZ End User Public
Get W-FRZ? End User Public
Description Syntax
Set: Set freeze on selected window #W-FRZ␠win_num,freeze_flag␍
Get: Get window freeze status #W-FRZ?␠win_num␍
Response

~ nn@W-FRZ␠win_num, freeze_flag␍␊
Parameters
win_num - window number to enable/disable
freeze_flag - see Section ‎5.1 On/Off
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-FRZ was set by any other external control device
(button press, device menu and similar)
Notes

Command - W-HUE Command Type - Multiviewer

Command Name Permission Transparency
Set: W-HUE End User Public
Get W-HUE? End User Public
Description Syntax
Set: Set window hue value #W-HUE␠win_num, value␍
Get: Get window hue value #W-HUE?␠win_num ␍
Response

~ nn@W-HUE␠win_num, value␍␊
Parameters
win_num - window number setting contrast
value - hue value
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-HUE was set by any other external control device
(button press, device menu and similar)
Notes
Value limits can vary for different devices
Value is a property of input connected to current window. Changing window input source might cause changes
in this value (refer device definitions)

78 Protocol 3000 - Commands

Command - W-LAYER Command Type - Multiviewer
Command Name Permission Transparency
Set: W-LAYER End User Public
Get W-LAYER? End User Public
Description Syntax
Set 1: Set window overlay order #W-LAYER␠win_num,value␍
Set 2: Set all window overlay order #W-LAYER␠0xFF,value1,value2, …,valueN␍
Get 1: Get window overlay order #W-LAYER?␠win_num␍
Get 2: Get all window overlay order #W-LAYER?␠0xFF␍
Response

Set 1/Get 1: ~ nn@W-LAYER␠win_num, value␍␊

Set 2/Get 2: ~ nn@W-LAYER␠0xFF,value1,value2,…valueN␍␊
Parameters
win_num - window number setting layer
value - overlay order number
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-LAYER was set by any other external control device
(button press, device menu and similar)
Notes
In case of overlays order list, number of expected layers is maximum number of windows in device

Protocol 3000 - Commands 79

Command - W-POS Command Type - Multiviewer
Command Name Permission Transparency
Set: W-POS End User Public
Get: W-POS? End User Public
Description Syntax
Set: Set window position #W-POS␠win_num,x0,y0,width,height␍
Get: Get window position #W-POS?␠win_num␍
Response

~ nn@W-POS␠win_num,x0,y0,width,height␍␊
Parameters
win_num - window number setting window position
x0,y0 - origin coordinate
width - window width
height - window height
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-POS was set by any other external control device
(button press, device menu and similar)
Notes

Command - W-SATURATION Command Type - Multiviewer

Command Name Permission Transparency
Set: W- SATURATION End User Public
Get: W- SATURATION? End User Public
Description Syntax
Set: Set window saturation # W-SATURATION␠win_id,value␍
Get: Get window saturation # W-SATURATION?␠win_id ␍
Response

~ nn @ W-SATURATION␠win_id,value␍␊
Parameters
win_id – window/output picture id
value – saturation value (0-100)
Response Triggers

Notes

80 Protocol 3000 - Commands

Command – W-SHARP Command Type - Multiviewer
Command Name Permission Transparency
Set : W-SHARP User Public
Get: W-SHARP? User Public
Description Syntax

Set: Set window sharpness value #W-SHARP ␠ win_num,value ␍

Get: Get window sharpness value #W-SHARP?␠ win_num ␍
Response

~ nn @W-SHARP ␠ win_num,value ␍␊
Parameters
win_num - window number to set sharpness
value - sharpness value
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-POS was set by any other external control device
(button press, device menu and similar)
Notes
Value limits can vary for different devices
Value is a property of input connected to current window. Changing window input source might cause
changes in this value (refer device definitions)

Command – W-SRC Command Type - Multiviewer

Command Name Permission Transparency
Set : W-SRC User Public
Get W-SRC? User Public
Description Syntax
Set: Set window source #W-SRC ␠ win_num,src ␍
Get: Get window source #W-SRC?␠ win_num ␍
Response

~ nn @W-SRC ␠ win_num,src ␍␊
Parameters
win_num - window number to set new source
src – input‎source‎to‎connect‎to‎window‎(1…‎max‎input‎number)
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-SRC was set by any other external control device
(button press, device menu and similar)
Notes
src limits can vary for different devices

Protocol 3000 - Commands 81

Command - W-ZOOM Command Type - Multiviewer
Command Name Permission Transparency
Set: W-ZOOM End User Public
Get W-ZOOM? End User Public
Description Syntax
Set: Set window zoom #W-ZOOM␠win_num,scale␍
Get: Get window zoom #W-ZOOM?␠win_num ␍
Response

~ nn@W-ZOOM␠win_num,scale␍␊
Parameters
win_num - window number setting new source
scale - zoom scale in percentage
Response Triggers
After execution, response is sent to the com port from which the Set/Get was received
After execution, response is sent to all com ports if W-ZOOM was set by any other external control device
(button press, device menu and similar)
Notes

82 Protocol 3000 - Commands

2.10 EDID Handling Commands
Command Description Type Permission
CPEDID Copy EDID data from the output to the EDID Handling
End User
input EEPROM
EDID-AUDIO Set/get audio capabilities for EDID EDID Handling End User
GEDID Set/get EDID data EDID Handling End User
LDEDID Load EDID data EDID Handling End User
LOCK-EDID Lock last read EDID EDID Handling End User

Command - CPEDID Command Type - EDID Handling

Command Name Permission Transparency
Set: CPEDID End User Public
Get: - - -
Description Syntax

Copy EDID data from the output to #CPEDID␠src_type, src_id, dst_type,

Set:
the input EEPROM dest_bitmap␍
Get: - -
Response

~nn@CPEDID␠src_stg, src_id, dst_type, dest_bitmap␍␊

Parameters
src_type - EDID source type (usually output) (see Section ‎5.15 EDID Source)
src_id - number of chosen source stage (1.. max number of inputs/outputs)
dst_type - EDID destination type (usually input) (see Section ‎5.15 EDID Source)
dest_bitmap - bitmap‎representing‎destination‎IDs.‎Format:‎XXXX…X,‎where‎X‎is hex digit. The binary
form‎of‎every‎hex‎digit‎represents‎corresponding‎destinations.‎Setting‎‘1’‎says‎that‎EDID‎data‎has‎to‎be‎
copied to this destination
Response Triggers
Response is sent to the com port from which the Set was received (before execution)
Notes
Destination bitmap size depends on device properties (for 64 inputs it is a 64-bit word)
Example: bitmap 0x0013 means inputs 1,2 and 5 are loaded with the new EDID

Protocol 3000 - Commands 83

Command – EDID-AUDIO Command Type – EDID Handling
Command Name Permission Transparency
Set: EDID-AUDIO - -
Get: EDID-AUDIO? End User Public
Description Syntax
Set: Set audio capabilities for EDID # EDID-AUDIO␠mode␍
Get : Get audio capabilities for EDID # EDID-AUDIO?␠␍
Response

~nn@ EDID-AUDIO␠mode␍␊
Parameters
mode – audio block added to EDID ( see Section ‎5.16 EDID Audio Capabilities)
Response Triggers

Notes

Command - GEDID Command Type - EDID Handling

Command Name Permission Transparency
Set: GEDID Administrator Public
Get: GEDID? End User Public
Description Syntax
Set: Set EDID data from device #GEDID␠stage, stage_id ␍
Get: Get EDID support on certain input/output #GEDID?␠stage, stage_id ␍
Response
Set:
Multi-line response:
~nn@GEDID␠stage,stage_id,size␍␊
EDID_data␍␊
~nn@GEDID␠stage,stage_id␠OK␍␊
Get:
~nn@GEDID␠stage,stage_id,size␍␊
Parameters
stage - input/output (see Section ‎5.15 EDID Source)
stage_id - number of chosen stage (1.. max number of inputs/outputs)
size - EDID data size. For Set, size of data to be sent from device, for Get, 0 means no EDID support
Response Triggers
Response is sent to the com port from which the Set (before execution) / Get command was received
Notes
For Get, size=0 means EDID is not supported
For old devices that do not support this command, ~nn@ ERR 002␍␊ is received

84 Protocol 3000 - Commands

Command - LDEDID Command Type - EDID Handling
Command Name Permission Transparency
Set: LDEDID End User Public
Get: - - -
Description Syntax
Write EDID data from external
Set: Multi-step syntax (see following steps)
application to device
Get: None None
Communication Steps (Command and Response)

Step 1: #LDEDID␠dst_type, dest_bitmask, size, safe_mode␍

Response 1: ~nn@LDEDID␠dst_type, dest_bitmask, size, safe_mode␠READY␍␊ or
~nn@LDEDID␠ERRnn␍␊

Step 2: If ready was received, send EDID_DATA

Response 2: ~ nn@LDEDID ␠dst_type, dest_bitmask, size, safe_mode␠ OK␍␊ or
~nn@LDEDID␠ERRnn␍␊
Parameters
dst_type - EDID destination type (usually input) (see Section ‎5.15 EDID Source)
dest_bitmask - bitmap representing destination IDs. Format: 0x********, where * is ASCII presentation of
hex digit. The binary presentation of this number is a bit mask for destinations. Setting‎‘1’‎means‎EDID‎
data has to be copied to this destination
size - EDID data size
safe_mode - 0 - Device accepts the EDID as is without trying to adjust
1 - Device tries to adjust the EDID
EDID_DATA - data in protocol packets (see Section ‎4)
Response Triggers
Response is sent to the com port from which the Set (before execution)
Notes
When the unit receives the LDEDID command it replies with READY and enters the special EDID packet
wait mode. In this mode the unit can receive only packets and not regular protocol commands.
If the unit does not receive correct packets for 30 seconds or is interrupted for more than 30 seconds
before receiving all packets, it sends timeout error ~nn@LDEDID␠ERR01␍␊ and returns to the regular
protocol mode. If the unit received data that is not a correct packet, it sends the corresponding error and
returns to the regular protocol mode.
See Protocol Packet reference in Section ‎4

Protocol 3000 - Commands 85

Command – LOCK-EDID Command Type – EDID Handling
Command Name Permission Command Name
Set: LOCK-EDID End User End User
Get: LOCK-EDID? End User End User
Description Syntax
Set: Lock last read EDID #LOCK-EDID␠ input_id,lock_mode ␍
Get : Get EDID lock state #LOCK-EDID? ␠ input_id ␍
Response

~nn@LOCK-EDID␠ input_id,lock_mode ␍␊
Parameters
input_id - 1….num‎of‎system‎inputs
lock_mode - 0/OFF - unlocks EDID, 1/ON - locks EDID (see noitceS‎5.1 On/Off)
Response triggers

Notes

86 Protocol 3000 - Commands

2.11 Step-in Commands
Command Description Type Permission
BTN Set/get module state Step-in End User
PROG-ACTION Set/get step-in button action list Step-in End User
STEPIN-CP Get module STEP-IN capabilities Step-in End User

Command - BTN Command Type - Step-in

Command Name Permission Transparency
Set: BTN User Public
Get: BTN? User Public
Description Syntax
Set: Set module state #BTN␠button_num,mode␍
Get: Get module state #BTN?button_num␍
Response

~nn@BTN␠ button_num,mode␍␊
Parameters
Button_num – button‎number‎(0…n)
mode - 0 – mode state muted
1 – mode state active
255 (0xFF) – pending (asking to step-in) (Get only)
Response Triggers

Notes
Values 0, 1 valid for Set/Get
Value 255 valid for Get only

Protocol 3000 - Commands 87

Command - PROG-ACTION Command Type - Step-in
Command Name Permission Transparency
Set: PROG-ACTION End user Public
Get: PROG-ACTION? End user Public
Description Syntax
Set: Set step-in button action list # PROG-ACTION␠type, port_id, button_id, action_type␍
Get: Get step-in button action list # PROG-ACTION?␠port_type, port_id, button_id␍
Response

Get / Set:~ nn @ PROG-ACTION␠port_type, port_id, button_id, action_type␍␊

Parameters
port_type - input/output (see Section ‎5.2 Stage)
port_id - port id
button_id - external programmable button ID
action_type - action to perform after receiving button_id (see Section ‎5.14 Software Programmed)
Response Triggers

Notes
Programs matrix action as a response for external event (programmable button pressed)

Command – STEPIN-CP Command Type - Step-in

Command Name Permission Transparency
Set: - - -
Get: STEPIN-CP? End User Public
Description Syntax
Set: - -
Get: Get module STEP-IN capabilities # STEPIN-CP? ␍
Response

~nn @ STEPIN-CP␠capabilities,num_of_inputs,num_of_cntl_btn␍␊

Parameters
capabilities – 1 - module support STEP-IN
0 - module‎doesn’t‎support‎STEP-IN
num_of_inputs - number of video inputs for remote switching
num_of_cntl_btn - number of control buttons to program in master device
Response Triggers

Notes
If a module does not support step-in‎it‎might‎respond‎with‎an‎error‎“command‎not‎supported”.

88 Protocol 3000 - Commands

3 Messages and Codes
3.1 Device Initiated Messages
Command Syntax
Start message ~nn@Protocol Start␍␊
Switcher actions:
Audio-video channel has switched (AFV mode) ~nn@AV␠in>out␍␊
Video channel has switched (breakaway mode) ~nn@VID␠in>out␍␊
Audio channel has switched (breakaway mode) ~nn@AUD␠in>out␍␊

3.2 Result and Error Codes

3.2.1 Syntax

In case of an error, the device responds with an error message. The error
message syntax:

~NN@ ERR XXX<CR><LF> - when general error, no specific command

~NN@CMD ERR XXX<CR><LF> - for specific command

NN - machine number of device, default = 01

XXX - error code

Protocol 3000 - Messages and Codes 89

3.2.2 Error Codes

Error Description
0 No error
1 Protocol syntax
2 Command not available
3 Parameter out of range
4 Unauthorized access
5 Internal FW error
6 Protocol busy
7 Wrong CRC
8 Timeout
9 (Reserved)
10 Not‎enough‎space‎for‎data‎(firmware,‎FPGA…)
11 Not enough space - file system
12 File does not exist
13 File‎can’t‎be created
14 File‎can’t‎open
15-20 (Reserved)
21 Packet CRC error
22 Packet number isn't expected (missing packet)
23 Packet size wrong
24-29 (Reserved)
30 EDID corrupted
31-39 Device specific errors

90 Protocol 3000 - Messages and Codes

4 Packet Protocol Structure

The packet protocol is designed to transfer large amounts of data, such as

files, IR commands, EDID data, etc.

4.1 Using the Packet Protocol

To use the packet protocol:

1. Send a command: LDRV, LOAD, IROUT, LDEDID

2. Receive Ready or ERR###

3. If Ready:

 Send a packet

 Receive OK on the last packet

 Receive OK for the command

4. Packet structure:

 Packet‎ID‎(1,‎2,‎3…)‎(2 bytes in length)

 Length (data length + 2 for CRC) - (2 bytes in length)

 Data (data length -2 bytes)

 CRC - 2 bytes

01 02 03 04 05…

Packet ID Length Data CRC

5. Response:

~NNNNSPOKCR LF

Where NNNN is the received packet ID in ASCII hex digits.

Protocol 3000 - Packet Protocol Structure 91

4.2 Calculating the CRC

The polynomial for the 16-bit CRC is:

CRC-CCITT: 0x1021 = x16 + x12 + x5 + 1
Initial value: 0000
Final XOR Value: 0

For a code example, see:

http://sanity-free.org/133/crc_16_ccitt_in_csharp.html

CRC example:
Data‎=‎“123456789”
Result => 0x31C3

92 Protocol 3000 - Packet Protocol Structure

5 Parameters
5.1 On/Off
Number Value
0 Off
1 On

5.2 Stage
Number Value
0 Input
1 Output
2 (Reserved)
3 (Reserved)

5.3 Signal Type

Number Value
0 No signal
1 DVI
2 HDMI
3 DisplayPort
4 HDBaseT
5 SDI
6 VGA
7 Follow output
8 DGKat

5.4 Genlock Types

Number Value
0 Free run
1 Digital
2 Analog

Protocol 3000 - Parameters 93

5.5 Video Resolutions
VIC Number Resolution
0 No Signal (for input) / Native - EDID (for output)
1 640x480p @59.94Hz/60Hz
2 720x480p @59.94Hz/60Hz
3 720x480p @59.94Hz/60Hz
4 1280x720p @59.94Hz/60Hz
5 1920x1080i @59.94Hz/60Hz
6 720(1440)x480i @59.94Hz/60Hz
7 720(1440)x480i @59.94Hz/60Hz
8 720(1440)x240p @59.94Hz/60Hz
9 720(1440)x240p @59.94Hz/60Hz
10 2880x480i @59.94Hz/60Hz
11 2880x480i @59.94Hz/60Hz
12 2880x240p @59.94Hz/60Hz
13 2880x240p @59.94Hz/60Hz
14 1440x480p @59.94Hz/60Hz
15 1440x480p @59.94Hz/60Hz
16 1920x1080p @59.94Hz/60Hz
17 720x576p @50Hz
18 720x576p @50Hz
19 1280x720p @50Hz
20 1920x1080i @50Hz
21 720(1440)x576i @50Hz
22 720(1440)x576i @50Hz
23 720(1440)x288p @50Hz
24 720(1440)x288p @50Hz
25 2880x576i @50Hz
26 2880x576i @50Hz
27 2880x288p @50Hz
28 2880x288p @50Hz
29 1440x576p @50Hz
30 1440x576p @50Hz
31 1920x1080p @50Hz
32 1920x1080p @23.97Hz/24Hz
33 1920x1080p @25Hz
34 1920x1080p @29.97Hz/30Hz
35 2880x480p @59.94Hz/60Hz
36 2880x480p @59.94Hz/60Hz
37 2880x576p @50Hz
38 2880x576p @50Hz

94 Protocol 3000 - Parameters

 VIC Number Resolution
39 1920x1080i @50Hz
40 1920x1080i @100Hz
41 1280x720p @100Hz
42 720x576p @100Hz
43 720x576p @100Hz
44 720(1440)x576i @100Hz
45 720(1440)x576i @100Hz
46 1920x1080i @119.88/120Hz
47 1280x720p @119.88/120Hz
48 720x480p @119.88/120Hz
49 720x480p @119.88/120Hz
50 720(1440)x480i @119.88/120Hz
51 720(1440)x480i @119.88/120Hz
52 720x576p @200Hz
53 720x576p @200Hz
54 720(1440)x576i @200Hz
55 720(1440)x576i @200Hz
56 720x480p @239.76/240Hz
57 720x480p @239.76/240Hz
58 720(1440)x480i @239.76/240Hz
59 720(1440)x480i @239.76/240Hz
60 1280x720p @23.97Hz/24Hz
61 1280x720p @25Hz
62 1280x720p @29.97Hz/30Hz
63 1920x1080p @119.88/120Hz
64 1920x1080p @100Hz
65-100 (Reserved)
100 Custom resolution 1
101 Custom resolution 2
102 Custom resolution 3
103 Custom resolution 4
104 Custom resolution 5
104-254 (Reserved)

5.6 Color Space

Number Value
0 RGB
1 YCbCr 4:2:2
2 YCbCr 4:4:4

Protocol 3000 - Parameters 95

5.7 Image Properties
Number Value
0 Overscan
1 Full
2 Best fit
3 Panscan
4 Letterbox
5 Underscan 2
6 Underscan 1

5.8 View Modes

Number Value
0 PIP off (matrix)
1 PIP on (dual PIP)
2 Preview (not applicable)
3 Quad
4 Video wall
5 POP

5.9 Custom Resolution Parameters

Number Value
0 Width
1 Height
2 HTotal
3 VTotal
4 HSync width
5 HSync back porch
6 VSync width
7 VSync back porch
8 Frame rate
9 Interlaced (0)/Progressive (1)

96 Protocol 3000 - Parameters

5.10 Detail Timing Parameters
Number Value
1 H-De-Start
2 H-De-Total
3 H-Total
4 V-De-Start
5 V-De-Total
6 Auto-DE-adjust
7 Auto-PHASE-adjust

5.11 Video/Audio Signal Changes

Number Value
0 Video signal lost
1 New video signal detected
2 Audio signal lost
3 Audio signal detected
4 Disable 5V on video output if no input signal detected
5 Video cable unplugged
6 Audio cable unplugged

Protocol 3000 - Parameters 97

5.12 Font Size
Number Value
0 Small
1 Medium
2 Large

5.13 Layer Enumeration

Number Value
1 Video
2 Audio
3 Data

5.14 Software Programmed

Number Value
0 Do nothing
1 Step-in out 1
2 Step-in out 2
… …
128 Step-in out 128
129 Echo to controller

5.15 EDID Source

Number Value
0 Input
1 Output
2 Default EDID

5.16 EDID Audio Capabilities

Number Value
0 LPCM 2CH
1 LPCM 6CH
2 LPCM 8CH
3 Bitstream
4 HD

98 Protocol 3000 - Parameters

5.17 Signal Validation
Number Value
0 Signal or sink is not valid
1 Signal or sink is valid
2 Sink and EDID is valid

5.18 Ethernet Port Types

Number Value
0 TCP
1 UDP

5.19 HDCP Types

Number Value
0 HDCP Off
1 HDCP On
2 Follow input
3 Mirror‎output‎(“MAC‎mode”)

5.20 Parity Types

Number Value
0 No
1 Odd
2 Even
3 Mark
4 Space

5.21 Serial Types

Number Value
0 232
1 485

Protocol 3000 - Parameters 99

5.22 Audio Signal Types
Number Value
0 No info
1 PCM
2 AC-3
3 MPEG1
4 MP3
5 MPEG2
6 AAC LC
7 DTS
8 ATRAC
9 DSD
10 E-AC-3
11 DTS-HD
12 MLP
13 DST
14 WMA Pro

5.23 Frequency Number

Number Value
0 120
1 200
3 500
4 1200
5 3000
6 7500
8 12000

5.24 Audio Level

Number Value
0 -10dB
20 0dB
40 +10dB

100 Protocol 3000 - Parameters

5.25 Audio Delay
Number Value
0 Off
1 10ms
2 20ms
3 30ms
4 40ms
5 50ms
6 60ms
7 70ms
8 80ms
9 Auto

Command Index
DPSW-STATUS ............................. 14
# ........................................................ 6
EDID-AUDIO .................................. 84
AFV ................................................. 38
EQ-LVL ........................................... 54
AUD ................................................ 39
ETH-PORT...................................... 61
AUD-DELAY? ................................ 52
FACTORY......................................... 7
AUD-EMB ....................................... 51
FORMAT......................................... 32
AUD-LVL ........................................ 51
FPGA-VER? ................................... 15
AUD-SIGNAL? ............................... 52
FS-FREE? ...................................... 33
AV ................................................... 39
GEDID ............................................. 84
AV-SW-MODE ................................ 12
GET ................................................. 33
AV-SW-TIMEOUT .......................... 12
GNLCK ........................................... 44
BALANCE ...................................... 53
HDCP-MOD .................................... 15
BASS .............................................. 54
HDCP-STAT? ................................. 16
BAUD .............................................. 13
HELP ................................................ 8
BCKGRND...................................... 42
H-PHASE ........................................ 45
BEZEL ............................................ 67
IDV .................................................. 17
BRIGHTNESS ................................ 67
IMAGE-PROP ................................. 69
BTN ................................................. 87
INFO-IO? ........................................ 18
BUILD-DATE .................................... 7
INFO-PRST? .................................. 18
CONTRAST .................................... 68
IREN ............................................... 19
CPEDID .......................................... 83
LABEL ............................................ 19
CRDT .............................................. 69
LDEDID ........................................... 85
DEF-RES ........................................ 43
LDFPGA ......................................... 20
DEL ................................................. 31
LDFW .............................................. 21
DETAIL-TIMING ............................. 44
LOAD .............................................. 34
DIR .................................................. 32
LOCK-EDID .................................... 86
DISPLAY? ...................................... 14

Protocol 3000 - Parameters 101

 LOCK-FP ........................................ 22 SCLR-AS ........................................ 73
LOGIN ............................................. 35 SCLR-AUDIO-DELAY .................... 73
LOGOUT......................................... 36 SCLR-PCAUTO .............................. 74
LOUDNESS .................................... 55 SECUR ........................................... 37
MACH-NUM .................................... 22 SHOW-OSD .................................... 74
MIC-DELAY .................................... 55 SIGNAL? ........................................ 29
MIC-GAIN ....................................... 56 SIG-TYPE ....................................... 45
MIDRANGE .................................... 56 SN? ................................................. 10
MIX .................................................. 57 STEPIN-CP ..................................... 88
MIX-LVL.......................................... 57 STEREO ......................................... 58
MODEL? ........................................... 8 TEST-FREQ ................................... 59
MTX-MODE .................................... 40 TIME ............................................... 29
MUTE .............................................. 58 TIME-SRV ....................................... 64
NAME ............................................. 23 TLK ................................................. 59
NAME-RST ..................................... 23 TMLOC ........................................... 30
NET-DHCP ..................................... 62 TREBLE .......................................... 60
NET-GATE...................................... 62 UART .............................................. 65
NET-IP ............................................ 63 UDP-TOUT ..................................... 65
NET-MAC? ..................................... 63 VERSION?...................................... 10
NET-MASK ..................................... 64 VFRZ ............................................... 46
OVRL .............................................. 70 VID .................................................. 41
OVRLBK ......................................... 71 VID-PATTERN ................................ 47
OVRLTXT ....................................... 72 VID-RES ......................................... 48
P2000 .............................................. 24 VIEW-MOD ..................................... 75
PASS .............................................. 36 VMUTE ........................................... 49
POWER-SAVE ............................... 24 W- SATURATION ........................... 80
PRIO ............................................... 25 W-ACTIVE ...................................... 75
PRIORITY ....................................... 25 W-BRD ............................................ 76
PROG-ACTION .............................. 88 W-COLOR ...................................... 77
PROT-VER? ..................................... 9 W-ENABLE..................................... 77
PRST-AUD? ................................... 26 W-FRZ ............................................ 78
PRST-LST? .................................... 26 W-HUE ............................................ 78
PRST-RCL ...................................... 27 W-LAYER ....................................... 79
PRST-STO ...................................... 27 W-POS ............................................ 80
PRST-VID? ..................................... 28 W-SHARP ....................................... 81
RESET .............................................. 9 W-SRC ............................................ 81
ROUTE ........................................... 40 W-ZOOM ......................................... 82

102 Protocol 3000 - Parameters