Kramer Protocol 3000 User Manual

Protocol 3000

Kramer devices can be operated using Kramer Protocol 3000 commands sent via serial or
Ethernet ports.

Understanding Protocol 3000

Protocol 3000 commands are a sequence of ASCII letters, structured according to the
following.

• Command format:

Prefix

Command Name

Constant (Space)

Parameter(s)

Suffix

#

Command



Parameter

<CR>

• Feedback format:

Prefix

Device ID

Constant

Command Name

Parameter(s)

Suffix

~

nn @ Command

Parameter

<CR><LF>

• Command parameters – Multiple parameters must be separated by a comma (,). In
addition, multiple parameters can be grouped as a single parameter using brackets ([
and ]).

• Command chain separator character – Multiple commands can be chained in the
same string. Each command is delimited by a pipe character (|).

• Parameters attributes – Parameters may contain multiple attributes. Attributes are
indicated with pointy brackets (<…>) and must be separated by a period (.).

The command framing varies according to how you interface with the VS-88UT. The following
figure displays how the # command is framed using terminal communication software (such
as Hercules):

Protocol 3000 Commands

Function

Description

Syntax

Parameters/Attributes

Example

#

Protocol handshaking.

Validates the
Protocol 3000
connection and gets
the machine number.

COMMAND

#<CR>

FEEDBACK

~nn@ok<CR><LF>

#<CR>

LOAD

Load file to device.

COMMAND

#LOADfile_name,size<CR>

FEEDBACK

Data sending negotiation:
* Device -

~01@LOADfile_name,sizeready<CR><LF>

* End User (+Device)­Send file in Protocol Packets
* Device -

~01@LOADfile_name,sizeok<CR><LF>

file_name – Name of file to save on device
size – Size of file data that is sent

Using the Packet Protocol

Send a command: LDRV, LOAD, IROUT,

LDEDID
Receive Ready or ERR###
If Ready:

a. Send a packet,

b. Receive OK on the last packet,

c. Receive OK for the command

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

Response: ~nnnnok<CR><LF> (Where

NNNN is the received packet ID in ASCII

hex digits.)

Load the
file_response.dat
file to the device:

#LOADfile_res
ponse.dat,5360

<CR>

EXT-CFG­FILE?

Get configuration file
status.

COMMAND

#EXT-CFG-FILE?<CR>

FEEDBACK

~nn@EXT-CFG-FILEstatus<CR><LF>

status –

1 – configuration.json is ready
2 – configuration.json is not ready

Get the
configuration file
status:

#EXT-CFG­FILE?<CR>

EXT-PSU?

Get the status of the
power supply unit.

COMMAND

#EXT-PSU?ps_id<CR>

FEEDBACK

~nn@EXT­PSUps_id,plug_status,ps_status<CR><LF>

ps_id – Power supply id number:

1–2
* – both PSUs

plug_status – Physical connection status of

the power supply:

ON – Connected
OFF – Disconnected

ps_status – Power status of the power supply:

OK – powered properly
WARN – not powered properly and may need

to be checked
OFFLINE – not receiving power

Get the status of
power supply 1:

#EXT­PSU?1<CR>

EXT-PSU­BUZZER

Enable/disable PSU
warning buzzer.

COMMAND

#EXT-PSU-BUZZERenabled_status<CR>

FEEDBACK

~nn@EXT-PSU-BUZZERenabled_status<CR><LF>

enabled_status –

0 – Disable
1 – Enable

Enable the PSU
warning buzzer:

#EXT-PSU­BUZZER1<CR>

EXT-PSU­BUZZER?

Get the enable/disable
status of the PSU
warning buzzer.

COMMAND

#EXT-PSU-BUZZER?<CR>

FEEDBACK

~nn@EXT-PSU-BUZZER?enabled_status<CR><LF>

enabled_status –

0 – Disabled
1 – Enabled

Get the
enable/disable
status of the PSU
warning buzzer:

#EXT-PSU­BUZZER?<CR>

EXT-VOLT?

Get the voltage of the
board.

COMMAND

#EXT-VOLT?slot_id<CR>

FEEDBACK

~nn@EXT-VOLT?slot_id：

volt_checkpoint_id/volt_checkpoint_total :
stdand value：actual value：status<CR><LF>

slot_id – Module ID (slot number):

1–17

volt_checkpoint_id – ID number of current

voltage detection point, starting from 1

volt_checkpoint_total – Nnumber of

voltage detection points

stdand value – Hardware design value
actual value – Current value
status –

WARN
OK

Get the voltage for
the card in slot 1:

#EXT­VOLT?slot_id<

CR>

EXT-POE

Enable/disable the
+48V input for the PS­4812 PoE power
supply add-on.

Only the input for
the PS-4812 PoE
power supply add-on
can be
enabled/disabled. The
module card ports do
not.

COMMAND

#EXT-POE0,enable_value<CR>

FEEDBACK

~nn@EXT-POE0,enable_value,48V_status<CR><LF>

port_id –

0 – 48V input connector

enable_value –

ON – 48V input is enabled
OFF – 48V input is disabled

48v_status – Operational status of 48V input:

OK – Receiving power
WARN – Not working
POWERDOWN – Enabled, but receiving

power

Enable the 48V
input for the PS­4812 PoE power
supply add-on:

#EXT­POE0,ON<CR>

EXT-POE?

Get the PoE power
operational status for
one of the module
card ports or for the
+48V input for the
PS-4812 PoE power
supply add-on.

COMMAND

#EXT-POE?port_id<CR>

FEEDBACK

~nn@EXT-POE?0,enable_value,48V_status<CR><LF>

port_id –

0 – 48V connector
1–34

enable_value –

ON – 48V input is enabled
OFF – 48V input is disabled

48v_status – Operational status of 48V input:

OK – Receiving power
WARN – Not working
POWERDOWN – Disabled, but receiving

power

Get the
enable/disable
status of the 48V
input for port 2:

#EXT­POE?2<CR>

Function

Description

Syntax

Parameters/Attributes

Example

AUD

Set audio switch state.

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

COMMAND

#AUDin>out_id,in>out_id,…<CR>

FEEDBACK

~nn@AUDin>out_id<CR><LF>

~nn@AUDin>out_id<CR><LF>

in – Input number or '0' to disconnect output
> – Connection character between in and out

parameters

out_id – Output number

1–34
* for all outputs

Switch embedded
audio HDMI™ IN 1
to HDMI OUT 3:

#AUD1>3<CR>

AUD?

Get audio switch
state.

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

COMMAND

#AUD?out_id<CR>

#AUD?*<CR>

FEEDBACK

~nn@AUDin>out,in>out_id,…<CR><LF>

or

~nn@AUD*>out<CR><LF>

in – Input number or '0' to disconnect output
> – Connection character between in and out

parameters

out_id –Output number

1–34
* for all outputs

Get audio switch
state for output 1:

#AUD?1<CR>

AUD-LVL

Set volume level.

COMMAND

#AUD-LVLio_mode,io_index,vol_level<CR>

FEEDBACK

~nn@AUD-LVLio_mode,io_index,vol_level<CR><LF>

io_mode – Input/Output

0 – Input
1 – Output

io_index – Number that indicates the specific

input or output port:
1-34

vol_level – Volume level 0–70

Set AUDIO OUT 2
volume level to 50:

#AUD­LVL1,1,50<CR>

AUD-LVL?

Get volume level.

COMMAND

#AUD-LVL?io_mode,io_index<CR>

FEEDBACK

~nn@AUD-LVLio_mode,io_index,vol_level<CR><LF>

io_mode – Input/Output

0 – Input
1 – Output

io_index – Number that indicates the specific

input or output port:
1–34

vol_level – Volume level 0–70

Get AUDIO OUT 1
volume level

#AUD­LVL?1,1<CR>

AV

Switch audio and
video.

COMMAND

#AVin>out_id,in>out_id,…<CR>

FEEDBACK

~nn@AVin>out_id,in>out_id,…<CR><LF>

in – Number that indicates the specific input:

1–34
0 - disconnect output

> – Connection character between in and out

parameters

out_id – Output number

1–34
* for all outputs

Switch IN 1 to OUT
4:

#AV1>4<CR>

BALANCE

Set balance level.

COMMAND

#BALANCEout_index,balance_level<CR>

FEEDBACK

~nn@BALANCEout_index,balance_level<CR><LF>

out_index – Number that indicates the specific

output:
1–34

balance_level – Balance level

0–100
++ increase current value
– decrease current value

Set the speaker
output balance to
50:

#BALANCE1,50<

CR>

BALANCE?

Get balance level.

COMMAND

#BALANCE?out_index<CR>

FEEDBACK

~nn@BALANCEout_index,balance_level<CR><LF>

out_index – Number that indicates the specific

output:

1–34

balance_level – Balance level

0–100

Get balance level
for Output 1:

#BALANCE?1<CR

>

BASS

Set audio bass level.

COMMAND

#BASSio_index,bass_level<CR>

FEEDBACK

~nn@BASSio_index,bass_level<CR><LF>

io_index – Number that indicates the specific

input or output port:

1–34

bass_level – Bass level

0–15
++ increase current value
– decrease current value

Set audio bass
level of channel 1
to 5:

#BASS1,5<CR>

BASS?

Get audio bass level.

COMMAND

#BASS?io_index<CR>

FEEDBACK

~nn@BASSio_index,bass_level<CR><LF>

io_index – Number that indicates the specific

input or output port:

1–34

bass_level – Bass level

0–15

Get audio bass
level of channel 1:

#BASS?1<CR>

BAUD

Set protocol serial port
baud rate.

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.

COMMAND

#BAUDbaud_rate<CR>

FEEDBACK

~nn@BAUDbaud_rate<CR><LF>

Option 1:

~nn@BAUDcurrent_baud_rate<CR><LF>

baud_rate –

9600, 19200, 38400, 57600, 115200

current_baud_rate –

9600, 19200, 38400, 57600, 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

Set the baud rate to
9600:

#BAUD9600<CR>

Function

Description

Syntax

Parameters/Attributes

Example

BAUD?

Get protocol serial
port baud rate.
(Option 1 - for current
baud rate.
Option 2 - for list of
supported baud
rates).

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.

COMMAND

#BAUD?<CR>

#BAUD?baud_param<CR>

FEEDBACK

~nn@BAUDbaud_rate<CR><LF>

Option 1:

~nn@BAUDcurrent_baud_rate<CR><LF>

baud_rate –

9600, 19200, 38400, 57600, 115200

current_baud_rate –

9600, 19200, 38400, 57600, 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

Get protocol serial
port baud rate:

#BAUD?<CR>

BRIGHTNESS

Set image brightness
per output.

Value limits can
vary for different
module cards.

Value is a property of
input connected to
current output.
Changing input source
might cause changes
in this value (refer
device definitions).

In devices that enable
showing multiple
outputs on one display
– each in a separate
window – this
command relates only
to the window
associated with the
output indicated in the
out-index parameter.

COMMAND

#BRIGHTNESSout_index,value<CR>

FEEDBACK

~nn@BRIGHTNESSout_index,value<CR><LF>

out_index – Number that indicates the specific

output:
1–34

value – Brightness value:

1–63

Set brightness for
output 1 to 50:

#BRIGHTNESS1,

50<CR>

BRIGHTNESS?

Get image brightness
per output.

Value limits can
vary for different
devices.

Value is a property of
input connected to
current output.
Changing input source
might cause changes
in this value (refer
device definitions).

In devices that enable
showing multiple
outputs on one display
– each in a separate
window – this
command relates only
to the window
associated with the
output indicated in the
out-index parameter.

COMMAND

#BRIGHTNESS?out_index<CR>

FEEDBACK

~nn@BRIGHTNESSout_index,value<CR><LF>

out_index – Number that indicates the specific

output:
1–34

value – Brightness value

Get brightness for
output 1:

#BRIGHTNESS?1

<CR>

BUILD-DATE?

Get device build date.

COMMAND

#BUILD-DATE?<CR>

FEEDBACK

~nn@BUILD-DATEdate,time<CR><LF>

date – Format: YYYY/MM/DD where

YYYY = Year
MM = Month
DD = Day

time – Format: hh:mm:ss where

hh = hours
mm = minutes
ss = seconds

Get the device
build date:

#BUILD-DATE?<C

R>

Function

Description

Syntax

Parameters/Attributes

Example

CONTRAST

Set image contrast
per output.

Value limits can
vary for different
devices.

Value is a property of
input connected to
current output.
Changing the input
source might cause
changes in this value
(refer to device
definitions).

In devices that enable
showing multiple
outputs on one display
– each in a separate
window – this
command relates only
to the window
associated with the
output indicated in the
out-index parameter.

COMMAND

#CONTRASTout_index,value<CR>

FEEDBACK

~nn@CONTRASTout_index,value<CR><LF>

out_index – Number that indicates the specific

output:
1–34

value – Contrast value:

1–63

Set contrast for
Output 1 to 40:

#CONTRAST1,40

<CR>

CONTRAST?

Get image contrast
per output.

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

In devices that enable
showing multiple
outputs on one display
– each in a separate
window – this
command relates only
to the window
associated with the
output indicated in the
out-index parameter.

COMMAND

#CONTRAST?out_index<CR>

FEEDBACK

~nn@CONTRASTout_index,value<CR><LF>

out_index – Number that indicates the specific

output:
1–34

value – Contrast value

Get contrast for
Output 1:

#CONTRAST?1<C

R>

CPEDID

Copy EDID data from
the output to the input
EEPROM.

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.

In certain products
Safe_mode is an
optional parameter.
See the HELP
command for its
availability.

COMMAND

#CPEDIDedid_io,src_id,edid_io,dest_bitmap<CR>

or

#CPEDIDedid_io,src_id,edid_io,dest_bitmap,saf

e_mode<CR>

FEEDBACK

~nn@CPEDIDedid_io,src_id,edid_io,dest_bitmap<

CR><LF>

~nn@CPEDIDedid_io,src_id,edid_io,dest_bitmap,

safe_mode<CR><LF>

edid_io – EDID source type (usually output)

0 – Input
1 – Output
2 – Default EDID

src_id – Port ID number of chosen input or

output source

1–34
0 – Default EDID source

edid_io – EDID destination type (always input)

0 – Input

dest_bitmap – Bitmap representing destination

IDs. Format: XXXX…X, where X is hex digit. The
binary form of every hex digit represents
corresponding destinations.

0 – indicates that EDID data is not copied to

this destination.

1 – indicates that EDID data is copied to this

destination.

safe_mode – Safe mode

0 – device accepts the EDID as is without

trying to adjust

1 – device tries to adjust the EDID (default

value if no parameter is sent)

Copy the EDID
data from the
Output 1 (EDID
source) to the
Input:

#CPEDID1,1,0,

0x1<CR>

Copy the EDID
data from the
default EDID
source to the Input:

#CPEDID2,0,0,

0x1<CR>

DETAIL­TIMING?

Get detail timing
parameters.

COMMAND

#DETAIL-TIMING?param,in_index<CR>

FEEDBACK

~nn@DETAIL-TIMINGparam,in_index,value<CR><LF>

param – Detail Timing

2 – H-De-Total
5 – V-De-Total

in_index – Number that indicates the specific

input:
1–34

value – Video parameter in Kramer units, minus

sign precedes negative values

Get detail timing
parameters:

#@DETAIL-TIMIN
G?2,1<CR>

DISPLAY?

Get output HPD
status.

After execution,
response is sent to
the com port from
which the command
was received.
Response is sent after
every change in
output HPD status ON
to OFF.
Response is sent after
every change in
output HDP status
OFF to ON.

COMMAND

#DISPLAY?out_index<CR>

FEEDBACK

~nn@DISPLAYout_index,status<CR><LF>

out_index – Number that indicates the specific

output:
1–34

status – HPD status according to signal

validation

0 – HPD ON to OFF,
1 – HPD OFF to ON,
2 - EDID ready

Get the output HPD
status of Output 1:

#DISPLAY?1<CR

>

Function

Description

Syntax

Parameters/Attributes

Example

EQ-LVL

Set equalization level.

COMMAND

#EQ-LVLio_mode,io_index,eq_type,eq_level<CR>

FEEDBACK

~nn@EQ-LVLio_mode,io_index,eq_type,eq_level<C

R><LF>

io_mode – Input/Output

0 – Input
1 – Output

io_index – Number that indicates the specific

input or output port:
1–34

eq_type – Equalizer Types

0 – Bass
2 – Treble

eq_level – Equalizer level:

0–15

Set Bass EQ level
of the speaker
output to 12:

#EQ­LVL1,1,0,12<C

R>

EQ-LVL?

Get equalization level.

COMMAND

#EQ-LVL?io_mode,io_index,eq_type<CR>

FEEDBACK

~nn@EQ-LVLio_mode,io_index,eq_type,eq_level<C

R><LF>

io_mode – Input/Output

0 – Input
1 – Output

io_index – Number that indicates the specific

input or output port:
1–34

eq_type – Equalizer Types

0 – Bass
2 – Treble

eq_level – Equalizer level:

0–15

Get Bass EQ level
of the speaker
output to 12:

#EQ­LVL?1,2,2<CR>

ETH-PORT

Set Ethernet port
protocol.

If the port number
you enter is already in
use, an error is
returned.
The port number must
be within the following
range: 0-(2^16-1).

COMMAND

#ETH-PORTport_type,port_id<CR>

FEEDBACK

~nn@ETH-PORTport_type,port_id<CR><LF>

port_type – TCP/UDP
port_id – TCP/UDP port number:

1 – 65535

Set the Ethernet
port protocol for
TCP to port 12457:

#ETH-PORT0,12

457<CR>

ETH-PORT?

Get Ethernet port
protocol.

COMMAND

#ETH-PORT?port_type<CR>

FEEDBACK

~nn@ETH-PORTport_type,port_id<CR><LF>

port_type – TCP/UDP
port_id – TCP / UDP port number:

1 – 65535

Get the Ethernet
port protocol for
UDP:

#ETH-PORT?TCP

<CR>

EXT-ETH-PORT

Set Ethernet port
number for a specific
module card.

If the module card
does not support
Ethernet functions,
ERR 034 is returned.

COMMAND

#EXT-ETH-PORTport_type,slot_id,port_id<CR>

FEEDBACK

~nn@EXT-ETH­PORTport_type,slot_id,port_id<CR><LF>

port_type – TCP/UDP
slot_id – Module ID (slot number):

0 or 100 – control module
1–17

port_id – TCP/UDP port number:

1 – 65535

Set the Ethernet
TCP port number
for the card in slot 1
to 12457:

#EXT-ETH­PORTTCP,1,124

57<CR>

EXT-ETH­PORT?

Get Ethernet port
number for a specific
module card.

If the module card
does not support
Ethernet functions,
ERR 034 is returned.

COMMAND

#EXT-ETH-PORT?port_type,slot_id<CR>

FEEDBACK

~nn@EXT-ETH­PORT?port_type,slot_id,port_id<CR><LF>

port_type – TCP/UDP
slot_id – Module ID (slot number):

0 or 100 – control module
1–17

port_id – TCP/UDP port number:

1 – 65535

Get the Ethernet
TCP port number
for the card in slot
1:

#EXT-ETH­PORT?TCP,1<CR

>

EXT-FAN­LEVEL

Set fan operation
speed and mode.

COMMAND

#EXT-FAN­LEVELfan_index,fan_speed,fan_mode<CR>

FEEDBACK

~nn@EXT-FAN­LEVELfan_index,fan_speed,fan_mode,fan_status<

CR><LF>

fan_index – number that indicates the fan

being set:

1–8 – Chassis fans
9–10 – Power supply fans

fan_speed –

0–4

fan_mode –

0 – Fan operation automatically controlled

based on the device temperature

1 – Continuous operation

The default is automatic. If a fan is set to

continuous and the device is reset, the fan
returns to automatic.

fan_status –

0 – OK
1 – Error

Set fan #1 speed to
2 and mode to
continuous:

#EXT-FAN­LEVEL1,2,1<CR

>

EXT-INFO-IO?

Get a list of ports
according to signal
type (video or audio)
and direction (inputs
or outputs).

COMMAND

#EXT-INFO-IO?signal_type,io_mode<CR>

FEEDBACK

~nn@Devicesignal_type,io_mode,io_index,io_ind

ex,io_index,...<CR><LF>

signal_type–

1 – video
2 – audio

io_mode – Input/Output

0 – Input
1 – Output

io_index – Number that indicates the specific

input or output port:

1–34

Get the list of video
input ports:

#EXT-INFO­IO?1,0<CR>

EXT-NET-MAC?

Get the MAC address
for a module card.

COMMAND

#EXT-NET-MAC?slot_id<CR>

FEEDBACK

~nn@EXT-NET-MAC?slot_id,mac_address<CR><LF>

slot_id – Module ID (slot number):

0 or 100 – control module
1–17

mac_address – Unique MAC address. Format:

XX-XX-XX-XX-XX-XX (where X is a hex digit)

Get the MAC
address for the
card in slot 1:

#EXT-NET­MAC?1<CR>

EXT-PING

Ping the IP address.

COMMAND

#EXT-PINGip_address<CR>

FEEDBACK

~nn@EXT-PINGping_information<CR><LF>

ip_address – Format: xxx.xxx.xxx.xxx

Get the gateway IP
address:

#EXT­PING192.168.1

.39<CR>

Function

Description

Syntax

Parameters/Attributes

Example

FACTORY

Reset device to
factory default
configuration.

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

Your device may
require powering off
and powering on for
the changes to take
effect.

COMMAND

#FACTORY<CR>

FEEDBACK

~nn@FACTORYok<CR><LF>

Reset the device to
factory default
configuration:

#FACTORY<CR>

FPGA-VER?

Get current FPGA
version.

COMMAND

#FPGA-VER?fpga_id<CR>

FEEDBACK

~nn@FPGA-VERfpga_id,expected_ver,ver<CR><LF>

fpga_id – FPGA id
expected_ver – Expected FPGA version for

current firmware

ver – Actual FPGA version

Get current FPGA
version:

#FPGA­VER?1<CR>

GEDID

Get EDID support on
certain input/output.

For old devices
that do not support
this command,
~nn@ERR
002<CR><LF> is
received.

COMMAND

#GEDIDio_mode,in_index<CR>

FEEDBACK

~nn@GEDIDio_mode,in_index,size<CR><LF>

io_mode – Input/Output

0 – Input
1 – Output
2 – Default EDID

io_index – Number that indicates the specific

input or output port:

1–34

size – Size of data to be sent from device, 0

means no EDID support

Get EDID support
information for
input 1:

#GEDID 1<CR>

GET

Get file contents.

COMMAND

#GETfile_name<CR>

FEEDBACK

Multi-line:

~nn@GETfile_name,file_sizeready<CR><LF>

contents

~nn@GETfile_nameok<CR><LF>

file_name – Name of file from which to get

contents, includes:
CONFIGURATION.JSON
CONFIG_LOG.JSON
METADATA.JSON, MESSAGES

contents – Byte stream of file contents
file_size – Size of file (device sends it in

response to give user a chance to get ready)

#GETfile_resp
onse.dat<CR>

HDCP-MOD

Set HDCP mode.

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.

COMMAND

#HDCP-MODin_index,mode<CR>

FEEDBACK

~nn@HDCP-MODin_index,mode<CR><LF>

in_index – Number that indicates the specific

input:
1–34

mode – HDCP mode:

0 – HDCP Off
1 – HDCP On

Set the input
HDCP-MODE of IN
1 to Off:

#HDCP­MOD1,0<CR>

HDCP-MOD?

Get HDCP mode.

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.

COMMAND

#HDCP-MOD?in_index<CR>

FEEDBACK

~nn@HDCP-MODin_index,mode<CR><LF>

in_index – Number that indicates the specific

input:
1–34

mode – HDCP mode:

0 – HDCP Off
3 – HDCP defined according to the connected

output

Get the input
HDCP-MODE of IN
1 HDMI:

#HDCP-MOD?1<C

R>

HDCP-STAT?

Get HDCP signal
status.

io_mode =1 – get
the HDCP signal
status of the sink
device connected to
the specified output.

io_mode =0 – get the
HDCP signal status of
the source device
connected to the
specified input.

COMMAND

#HDCP-STAT?io_mode,in_index<CR>

FEEDBACK

~nn@HDCP-STATio_mode,in_index,status<CR><LF>

io_mode – Input/Output

0 – Input
1 – Output

in_index – Number that indicates the specific

input:
1–34

status – Signal encryption status - valid values

On/Off

0 – HDCP Off
1 – HDCP On

Get the output
HDCP-STATUS of
IN 1:

#HDCP­STAT?0,1<CR>

HELP

Get command list or
help for specific
command.

COMMAND

#HELP<CR>

#HELPcmd_name<CR>

FEEDBACK

1. Multi-line:

~nn@Devicecmd_name,cmd_name…<CR><LF>

To get help for command use: HELP
(COMMAND_NAME)<CR><LF>

~nn@HELPcmd_name:<CR><LF>

description<CR><LF>

USAGE:usage<CR><LF>

cmd_name – Name of a specific command

Get the command
list:

#HELP<CR>

To get help for
HDCP-MOD:
HELPhdcp-

modCR>

Function

Description

Syntax

Parameters/Attributes

Example

H-PHASE

Set H-phase.

COMMAND

#H-PHASEio_mode,io_index,value<CR>

FEEDBACK

~nn@H-PHASEio_mode,io_index,value<CR><LF>

io_mode – Input/Output

1 – Input
2 – Output

io_index – Number that indicates the specific

input or output port:

1–34

value – Video parameter in Kramer units:

0–63
++ increase current value
– decrease current value

Set H-phase:

#H-PHASE1,1,1

<CR>

H-PHASE?

Get H-phase.

COMMAND

#H-PHASE?io_mode,io_index<CR>

FEEDBACK

~nn@H-PHASEio_mode,io_index,value<CR><LF>

io_mode – Input/Output

0 – Input
1 – Output

io_index – Number that indicates the specific

input or output port:
1–34

value – Video parameter in Kramer units, minus

sign precedes negative values

Get H-phase:

#H-PHASE?1,1<

CR>

HW-TEMP?

Get temperature of a
specific region of the
hardware.

The Get command
is not available for all
parts of the hardware,
and is device specific.

COMMAND

#HW-TEMP?region_id<CR>

FEEDBACK

~nn@HW-TEMPregion_id,temperature<CR><LF>

region_id – ID of the region for which to get

the temperature

0 – Control Board
1–17 – Module card slot number
* – Matrix

temperature – Temperature in Celsius of the

HW region, rounded down to the closest integer

Get temperature of
a specific region of
the hardware:

#HW-TEMP?1<CR

>

INFO-IO?

Get in/out count.

COMMAND

#INFO-IO?<CR>

FEEDBACK

~nn@INFO-IOINin_count,OUTout_count<CR><LF>

in_count – Number of inputs in the unit
out_count – Number of outputs in the unit

Get inputs count:

#INFO-IO?<CR>

INFO-PRST?

Get maximum preset
count.

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

COMMAND

#INFO-PRST?<CR>

FEEDBACK

~nn@INFO-PRSTvidvideo_preset_count,audaudio

_preset_count<CR><LF>

video_preset_count – Maximum number of

video presets in the unit

audio_preset_count – Maximum number of

audio presets in the unit

Get number of
video and audio
presets:

#INFO­PRST?<CR>

LDEDID

Write EDID data from
external application to
device.

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

<CR><LF> 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.

COMMAND

Multi-step syntax

FEEDBACK

Step 1:

#LDEDIDedid_io,dest_bitmask,edid_size,safe_mo

de<CR>

Response 1:

~nn@LDEDIDedid_io,dest_bitmask,edid_size,safe

_modeready<CR><LF>

or

~nn@LDEDIDerrnn<CR><LF>

Step 2: If ready was received, send EDID_DATA
Response 2:

~nn@LDEDIDedid_io,dest_bitmask,edid_size,safe

_modeok<CR><LF>

or

~nn@LDEDIDerrnn<CR><LF>

edid_io – EDID destination type (always input)

0 – Input

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

edid_size – EDID data size
safe_mode – 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

Using the Packet Protocol

Send a command: LDRV, LOAD, IROUT,

LDEDID
Receive Ready or ERR###
If Ready:

a. Send a packet,

b. Receive OK on the last packet,

c. Receive OK for the command

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: ~nnnnok<CR><LF> (Where

NNNN is the received packet ID in ASCII

hex digits.)

Write the EDID
data from an
external application
to the HDMI In 1
input without
adjustment
attempts:

#LDEDID0,0x1,
2340,0<CR>

Write the EDID
data from an
external application
to HDMI In 1 and
PC In inputs with
adjustment
attempts:

#LDEDID0,0x5,
2340,1<CR>

LOAD

Load file to device.

COMMAND

#LOADfile_name,size<CR>

FEEDBACK

Data sending negotiation:
* Device -

~01@LOADfile_name,sizeready<CR><LF>

* End User (+Device)­Send file in Protocol Packets
* Device –
~01@LOADfile_name,sizeok<CR><LF>

file_name – Name of file to save on device
size – Size of file data that is sent

Load the
file_response.dat
file to the device:
#LOADfile_respon
se.dat,5360<CR>

LOCK-FP

Lock the front panel.

COMMAND

#LOCK-FPlock/unlock<CR>

FEEDBACK

~nn@LOCK-FPlock/unlock<CR><LF>

lock/unlock – On/Off

0 – unlock front panel
1 – lock front panel

Unlock front panel:

#LOCK-FP0<CR>

LOCK-FP?

Get the front panel
lock state.

In NT-52N, this
command includes the
PortNumber (1-2)
parameter.

COMMAND

#LOCK-FP?<CR>

FEEDBACK

~nn@LOCK-FPlock/unlock<CR><LF>

lock/unlock – On/Off

0 – unlock front panel
1 – lock front panel

Get the front panel
lock state:

#LOCK-FP?<CR>

Function

Description

Syntax

Parameters/Attributes

Example

MIX

Set audio MIX.

COMMAND

#MIXout_index,mix_mode<CR>

FEEDBACK

~nn@MIXout_index,mix_mode<CR><LF>

out_index – Number that indicates the specific

output:

1–34

mix_mode – On/Off

0 – Off
1 – On

Set audio MIX:

#MIX1,1<CR>

MIX?

Get audio MIX.

COMMAND

#MIX?out_index<CR>

FEEDBACK

~nn@MIXout_index,mix_mode<CR><LF>

out_index – Number that indicates the specific

output:

1–34

mix_mode – On/Off

0 – Off
1 – On

Get audio MIX for
output 1:

#MIX?1<CR>

MODEL?

Get device model.

COMMAND

#MODEL?<CR>

FEEDBACK

~nn@MODELmodel_name<CR><LF>

model_name – String of up to 19 printable ASCII

chars

Get the device
model:

#MODEL?<CR>

MODULE-INFO?

Get module
information.

COMMAND

#MODULE-INFO?slot_id<CR>

FEEDBACK

~nn@MODULE-INFOslot_id,m_direction,channel_st

art,channel_end,mod_type,fw_ver,upgradable,mod
_status<CR><LF>

slot_id – Module ID (slot number):

0 – control module
1–17 – I/O cards
200 – test module
201 – keyboard software application
202 – keyboard hardware

m_direction – Transmission direction

0 – input
1 – output
2 – OS system or applications in the control

board or unknown

channel_start – Start ID of the port in the

device

1–34

channel_end – End ID of the port in the device

1–34

mod_type – Module type

18 – VGAA
32 – SDIA
47 – Control module
49 – H2
50 – H2A
57 – DTAxrC2
59 – DTxrD2
203 – Sub-function for control board.
204 – InnerEthSwitcher in the matrix
205 – Power and fan monitor in the matrix
206 – Main board in the matrix

fw_ver – Module firmware version

XX.XX.XXXX where the digit groups are:
major.minor.build version

upgradable – Indicates whether the firmware

can be upgraded

0 – not upgradable
1 – upgradable

mod_status – Module status

0 – OK
1 – unknown error
2 – no communication
3 – module missing or offline

Get information for
the module in slot
8:

#MODULE-INFO?
8<CR>

MODULE-ISP

Set com port
configuration.

After running this
command, power­cycle the device to
return to normal
operation.

COMMAND

#MODULE-ISPslot_id,baud_rate,data_bits,parity
,stop,wait_time<CR>

FEEDBACK

~nn@MODULE-ISPslot_id,baud_rate,data_bits,par

ity,stop,wait_time<CR><LF>

slot_id – Module ID (slot number):

0 or 100 – control module
1–17

baud_rate – 9600 - 115200
data_bits – 7, 8
parity – Parity Type

0 – No
1 – Odd
2 – Even

stop – 1, 2
wait_time – In seconds

1–60

Set baud rate for
the module in slot 1
to 9600, 8 data bits,
parity to none, stop
bit to 1, and wait
time to 30 seconds:

#MODULE­ISP1,9600,8,0
,1,30<CR>

MODULE-TYPE?

Get module type.

COMMAND

#MODULE-TYPE?module_id<CR>

FEEDBACK

~nn@MODULE-TYPEmodule_id,mod_type,mod_status<

CR><LF>

module_id – Number that identifies the module

1–17

mod_type – Module type

18 – VGAA
32 – SDIA
47 – Control module
49 – H2
50 – H2A
57 – DTAxrC2
59 – DTxrD2

mod_status – Module status

0 – OK
1 – Unknown error
2 – No communication
3 – Module missing or offline

Get module type:

#MODULE-TYPE?

1<CR>

Function

Description

Syntax

Parameters/Attributes

Example

MODULE-VER?

Get module version.

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.

COMMAND

#MODULE-VER?module_id<CR>

FEEDBACK

~nn@MODULE-VERmodule_id,fw_version<CR><LF>

module_id – Number that identifies the module

0 – control module
1–17 – I/O cards
220 – Linux OS

fw_version – XX.XX.XXXX where the digit

groups are: major.minor.build version

Get module
version:

#MODULE-VER?1

<CR>

MUTE

Set audio mute.

COMMAND

#MUTEout_index,mute_mode<CR>

FEEDBACK

~nn@MUTEout_index,mute_mode<CR><LF>

out_index – Number that indicates the specific

output:
1–34

mute_mode – On/Off

0 – Off
1 – On

Set Output 1 to
mute:

#MUTE1,1<CR>

MUTE?

Get audio mute.

COMMAND

#MUTE?out_index<CR>

FEEDBACK

~nn@MUTEout_index,mute_mode<CR><LF>

out_index – Number that indicates the specific

output:
1–34

mute_mode – On/Off

0 – Off
1 – On

Get mute status of
output 1

#MUTE?1<CR>

NAME

Set machine (DNS)
name.

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machine_name<CR>

FEEDBACK

~nn@NAMEmachine_name<CR><LF>

machine_name – String of up to 15 alpha-

numeric chars (can include hyphen, not at the
beginning or end)

Set the DNS name
of the device to
room-442:

#NAMEroom-

442<CR>

NAME?

Get machine (DNS)
name.

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?<CR>

FEEDBACK

~nn@NAMEmachine_name<CR><LF>

machine_name – String of up to 15 alpha-

numeric chars (can include hyphen, not at the
beginning or end)

Get the DNS name
of the device:

#NAME?<CR>

NAME-RST

Reset machine (DNS)
name to factory
default.

Factory default of
machine (DNS) name

is “KRAMER_” + 4

last digits of device
serial number.

COMMAND

#NAME-RST<CR>

FEEDBACK

~nn@NAME-RSTok<CR><LF>

Reset the machine
name (S/N last
digits are 0102):

#NAME­RSTkramer_010

2<CR>

NET-CONFIG

Set a network
configuration.

If the gateway
address is not
compliant to the
subnet mask used for
the host IP, the
command will return
an error. Subnet and
gateway compliancy
specified by RFC950.

COMMAND

#NET-CONFIGnetw_id,net_ip,net_mask,gateway<CR

>

FEEDBACK

~nn@NET-CONFIGnetw_id,net_ip,net_mask,gateway

<CR><LF>

netw_id – Network ID–the device network

interface

0 or 100 – control module
1–17 – module cards

net_ip – Network IP
net_mask – Network mask
gateway – Network gateway

Set the device
network
parameters to IP
address

192.168.113.10,
net mask

255.255.0.0, and
gateway

192.168.0.1:

#NET-CONFIG0,

192.168.113.10

,255.255.0.0,1

92.168.0.1<CR>

NET-CONFIG?

Get a network
configuration.

COMMAND

#NET-CONFIG?netw_id<CR>

FEEDBACK

~nn@NET-CONFIGnetw_id,net_ip,net_mask,gateway

<CR><LF>

netw_id – Network ID–the device network

interface

0 or 100 – control module
1–17 – module cards

net_ip – Network IP
net_mask – Network mask
gateway – Network gateway

Get network
configuration for
the module card in
slot 2:

#NET-CONFIG?2

<CR>

Function

Description

Syntax

Parameters/Attributes

Example

NET-DHCP

Set DHCP mode.

Only 1 is relevant
for the mode value. To
disable DHCP, the
user must configure a
static IP address for
the device.

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
NAME command. 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-DHCPdhcp_state<CR>

FEEDBACK

~nn@NET-DHCPdhcp_state<CR><LF>

dhcp_state –

0 – Do not use DHCP. Use the IP set by the

factory or using the NET-CONFIG or NET-
IP command.

1 – Try to use DHCP. If unavailable, use the IP

address set by the factory or the NET-
CONFIG or NET-IP command.

Enable DHCP
mode for port 1, if
available:

#NET­DHCP1,1<CR>

NET-DHCP?

Get DHCP mode.

COMMAND

#NET-DHCP?<CR>

FEEDBACK

~nn@NET-DHCPdhcp_mode<CR><LF>

dhcp_mode –

0 – Do not use DHCP. Use the IP set by the

factory or using the NET-CONFIG or NET-
IP command.

1 – Try to use DHCP. If unavailable, use the IP

set by the factory or using the NET-
CONFIG or NET-IP command.

Get DHCP mode
for port 1:

#NET-DHCP?1<C

R>

NET-GATE

Set gateway IP.

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

COMMAND

#NET-GATEip_address<CR>

FEEDBACK

~nn@NET-GATEip_address<CR><LF>

ip_address – Format: xxx.xxx.xxx.xxx

Set the gateway IP
address to

192.168.0.1:

#NET­GATE192.168.0

00.001<CR>

NET-GATE?

Get gateway IP.

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

COMMAND

#NET-GATE?<CR>

FEEDBACK

~nn@NET-GATEip_address<CR><LF>

ip_address – Format: xxx.xxx.xxx.xxx

Get the gateway IP
address:

#NET-GATE?<CR

>

NET-IP

Set IP address.

For proper settings
consult your network
administrator.

COMMAND

#NET-IPip_address<CR>

FEEDBACK

~nn@NET-IPip_address<CR><LF>

ip_address – Format: xxx.xxx.xxx.xxx

Set the IP address
to 192.168.1.39:

#NET­IP192.168.001
.039<CR>

NET-IP?

Get IP address.

COMMAND

#NET-IP?<CR>

FEEDBACK

~nn@NET-IPip_address<CR><LF>

ip_address – Format: xxx.xxx.xxx.xxx

Get the IP address:

#NET-IP?<CR>

NET-MAC?

Get MAC address.

COMMAND

#NET-MAC?<CR>

FEEDBACK

~nn@NET-MACmac_address<CR><LF>

mac_address – Unique MAC address. Format:

XX-XX-XX-XX-XX-XX where X is hex digit

#NET­MAC?id<CR>

NET-MASK

Set subnet mask.

For proper settings
consult your network
administrator.

COMMAND

#NET-MASKnet_mask<CR>

FEEDBACK

~nn@NET-MASKnet_mask<CR><LF>

net_mask – Format: xxx.xxx.xxx.xxx

Set the subnet
mask to

255.255.0.0:

#NET­MASK255.255.0

00.000<CR>

NET-MASK?

Get subnet mask.

COMMAND

#NET-MASK?<CR>

FEEDBACK

~nn@NET-MASKnet_mask<CR><LF>

net_mask – Format: xxx.xxx.xxx.xxx

Get the subnet
mask:

#NET-MASK?<CR>

PORT­DIRECTION?

Get port direction for
video port.

This command
gets the direction of a
bidirectional port.

COMMAND

#PORT-DIRECTION?port_index<CR>

FEEDBACK

~nn@PORT-DIRECTIONport_index,direction<CR><LF

>

port_index – Port number

1–34

direction –

0 – Input
1– Output

Get port direction
for port 2:

#PORT­DIRECTION?5<C

R>

PROT-VER?

Get device protocol
version.

COMMAND

#PROT-VER?<CR>

FEEDBACK

~nn@PROT-VER3000:version<CR><LF>

version – XX.XX where X is a decimal digit

Get the device
protocol version:

#PROT-VER?<CR

>

Function

Description

Syntax

Parameters/Attributes

Example

PRST-AUD?

Get audio connections
from saved preset.

Video and audio
presets with the same
number are stored
and recalled together
by commands
#PRST-STO and
#PRST-RCL.

COMMAND

#PRST-AUD?preset,out_index<CR>

#PRST-AUD?preset,*<CR>

FEEDBACK

~@PRST-AUDpreset,in_index>out_index<CR><LF>

~@PRST-AUDpreset,in_index>1,in_index>2,in_ind

ex>3,…<CR><LF>

preset – Preset number
in_index – Number that indicates the specific

input:

1 – N (N= the total number of inputs)
0 – Output is disconnected

> – Connection character between in and out

parameters

out_index – Number that indicates the specific

output:

1 – 34
* – All outputs

Get audio
connection for OUT
3 from saved
preset 1:

#PRST­AUD?1,3<CR>

PRST-LST?

Get saved preset list.

Video and audio
presets with the same
number are stored
and recalled together
by commands

#PRST-STO and
#PRST-RCL.

COMMAND

#PRST-LST?<CR>

FEEDBACK

~nn@PRST-LSTpreset,preset,…<CR><LF>

preset – Preset number

Show preset list:

#PRST-LST?<CR>

PRST-RCL

Recall saved preset
list.

Video and audio
presets with the same
number are stored
and recalled together
by commands

#PRST-STO and
#PRST-RCL.

COMMAND

#PRST-RCLpreset<CR>

FEEDBACK

~nn@PRST-RCLpreset<CR><LF>

preset – Preset number

Recall preset 1:

#PRST­RCL1<CR>

PRST-STO

Store current
connections, volumes,
and modes in preset.

Video and audio
presets with the same
number are stored
and recalled together
by commands

#PRST-STO and
#PRST-RCL.

COMMAND

#PRST-STOpreset<CR>

FEEDBACK

~nn@PRST-STOpreset<CR><LF>

preset – Preset number

Store the current
configuration under
preset 1:

#PRST­STO1<CR>

PRST-VID?

Get video connections
from saved preset.

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-VID?preset,out_index<CR>

#PRST-VID?preset,*<CR>

FEEDBACK

~nn@PRST-VIDpreset,in_index>out_index<CR><LF>

~nn@PRST-VIDpreset,in_index>1,in_index>2,in_i

ndex>3,…<CR><LF>

preset – Preset number
in_index – Number that indicates the specific

input:

1 – 34
0 – Output is disconnected

> – Connection character between in and out

parameters

out_index – Output number

1–34
* for all outputs

Get video
connections from
preset 3 for all
outputs:

#PRST­VID?3,*<CR>

RESET

Reset device.

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.

COMMAND

#RESET<CR>

FEEDBACK

~nn@RESETok<CR><LF>

Reset the device:

#RESET<CR>
ROUTE

Set layer routing.

This command
replaces all other
routing commands.

COMMAND

#ROUTElayer_type,out_index,in_index<CR>

FEEDBACK

~nn@ROUTElayer_type,out_index<CR><LF>

layer_type Layer Enumeration

1 – Video
2 – Audio

out_index – Number that indicates the specific

output

1–34
* for all outputs

in_index – Number that indicates the specific

input

0 – disconnect the output
1–34

Route HDMI IN 2 to
HDMI OUT 4:

#ROUTE1,2,4<C

R>

ROUTE?

Get layer routing.

This command
replaces all other
routing commands.

COMMAND

#ROUTE?layer_type,out_index<CR>

FEEDBACK

~nn@ROUTElayer_type,out_index,in_index<CR><LF

>

layer_type Number that represents the type of

signal

1 – Video
2 – Audio

out_index – Number that indicates the specific

output

1–34
* for all outputs

in_index – Number that indicates the specific

input

0 – output is disconnected
1–34

Get the video
routing for output 2:

#ROUTE?1,2<CR

>

SIGNAL?

Get input signal
status.

COMMAND

#SIGNAL?in_index<CR>

FEEDBACK

~nn@SIGNALin_index,status<CR><LF>

in_index – Number that indicates the specific

input:
1–34

status – Signal status according to signal

validation:

0 – Off
1 – On

Get the input signal
status of IN 1:

#SIGNAL?1<CR>

Function

Description

Syntax

Parameters/Attributes

Example

SN?

Get device serial

number.

COMMAND

#SN?<CR>

FEEDBACK

~nn@SNserial_num<CR><LF>

serial_num – 14 decimal digits, factory

assigned

Get the device
serial number:

#SN?<CR>

TEST-MODE

Put device into
keyboard testing
mode.

Refer to User
Manual for test
instructions.

COMMAND

#TEST-MODE<CR>

FEEDBACK

~nn@TEST-MODEresult<CR><LF>

result – OK – Device has entered keyboard

testing mode

Put device into
keyboard testing
mode:

#TEST-MODE<CR>

TIME

Set device time and
date.

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.

COMMAND

#TIMEday_of_week,date,time<CR>

FEEDBACK

~nn@TIMEday_of_week,date,time<CR><LF>

day_of_week – One of

{SUN,MON,TUE,WED,THU,FRI,SAT}

date – Format: DD-MM-YYYY.
time – Format: hh:mm:ss where

hh = hours
mm = minutes
ss = seconds

Set device time and
date to December
5, 2018 at 2:30pm:

#TIMEmon05­12­2018,14:30:00<

CR>

TIME?

Get device time and
date.

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.

COMMAND

#TIME?<CR>

FEEDBACK

~nn@TIMEday_of_week,date,time<CR><LF>

day_of_week – One of

{SUN,MON,TUE,WED,THU,FRI,SAT}

date – Format: DD-MM-YYYY where

DD = Day
MM = Month

YYYY = Year

time – Format: hh:mm:ss where

hh = hours
mm = minutes
ss = seconds

Get device time
and date:

#TIME?<CR>

TREBLE

Set audio treble level.

COMMAND

#TREBLEio_index,treble_level<CR>

FEEDBACK

~nn@TREBLEio_index,treble_level<CR><LF>

io_index – Number that indicates the specific

input or output port:
1–34

treble_level – Audio parameter in Kramer

units, minus sign precedes negative values

0-15
++ increase current value
– decrease current value

Set audio treble
level:

#TREBLE1,1<CR

>

TREBLE?

Get audio treble level.

COMMAND

#TREBLE?io_index<CR>

FEEDBACK

~nn@TREBLEio_index,treble_level<CR><LF>

io_index – Number that indicates the specific

input or output port:
1–34

treble_level – Audio parameter in Kramer

units, minus sign precedes negative values

0-15

Get audio treble
level:

#TREBLE?1<CR>

VERSION?

Get firmware version
number.

COMMAND

#VERSION?<CR>

FEEDBACK

~nn@VERSIONfirmware_version<CR><LF>

firmware_version – XX.XX.XXXX where the

digit groups are: major.minor.build version

Get the device
firmware version
number:

#VERSION?<CR>

VID

Set video switch state.

COMMAND

#VIDin_id>out_id<CR>

FEEDBACK

~nn@VIDin_id>out_id<CR><LF>

in_id – Indicates the ID of the input:

0 – Disconnect output
1–34

> – Connection character between in and out

parameters

out_id – Output number

1–34
* for all outputs

Switch IN 1 to OUT
3:

#VID1>3<CR>

VID?

Get video switch
state.

The GET
command identifies
input switching on
Step-in clients.

The SET
command is for
remote input switching
on Step-in clients
(essentially via by the
Web).

COMMAND

#VID?out_id<CR>

FEEDBACK

~nn@VID>out_id<CR><LF>

in_id – Indicates the ID of the input:

0 – Output disconnected
1–34

> – Connection character between in and out

parameters

out_id – Output number

1–34
* for all outputs

Get video switch
state:

#VID?2<CR>

X-MUTE

Set mute ON/OFF on
a specific signal.

This command is
designed to Mute a
Signal. This means
that it could be
applicable on any type
of signal. Could be
audio, video and
maybe IR, USB, or
data if this capability is
supported by the
product.

COMMAND

#X-MUTE<direction_type>. <port_format>.

<port_index>. <signal_type>. <index>,state<CR>

FEEDBACK

~nn@X-MUTE<direction_type>. <port_format>.

<port_index>. <signal_type>.
<index>,state<CR><LF>

The following attributes comprise the signal ID:

▪ <direction_type> – Direction of the port:

o IN – Input
o OUT – Output

▪ <port_format> – Type of signal on the

port:

o ANALOG_AUDIO

▪ <port_index> – The port number as

printed on the front or rear panel

▪ <signal_type> – Signal ID attribute:

o AUDIO

▪ <index> – 1

state – OFF/ON (not case sensitive)

Mute the video on
HDMI OUT 2:

hd.outMUTE-#X

mi.2.video.1,o

n<CR>

Function

Description

Syntax

Parameters/Attributes

Example

X-MUTE?

Get mute ON/OFF
state on a specific
signal.

COMMAND

#X-MUTE?<direction_type>. <port_format>.

<port_index>. <signal_type>. <index><CR>

FEEDBACK

~nn@X-MUTE<direction_type>. <port_format>.

<port_index>. <signal_type>.
<index>,state<CR><LF>

The following attributes comprise the signal ID:

▪ <direction_type> – Direction of the port:

o IN – Input
o OUT – Output

▪ <port_format> – Type of signal on the

port:

o ANALOG_AUDIO

▪ <port_index> – The port number as

printed on the front or rear panel

▪ <signal_type> – Signal ID attribute:

o AUDIO

▪ <index> – 1

state – OFF/ON (not case sensitive)

Get the mute
ON/OFF state on a
specific signal:

#X-MUTE?out.h

dmi.4.video.1<

CR>

Result and Error Codes

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

Error Codes

Error Name

Error
Code

Description

P3K_NO_ERROR

0

No error

ERR_PROTOCOL_SYNTAX

1

Protocol syntax

ERR_COMMAND_NOT_AVAILABLE

2

Command not available

ERR_PARAMETER_OUT_OF_RANGE

3

Parameter out of range

ERR_UNAUTHORIZED_ACCESS

4

Unauthorized access

ERR_INTERNAL_FW_ERROR

5

Internal FW error

ERR_BUSY

6

Protocol busy

ERR_WRONG_CRC

7

Wrong CRC

ERR_TIMEDOUT

8

Timeout

ERR_RESERVED

9

(Reserved)

ERR_FW_NOT_ENOUGH_SPACE

10

Not enough space for data (firmware, FPGA…)

ERR_FS_NOT_ENOUGH_SPACE

11

Not enough space – file system

ERR_FS_FILE_NOT_EXISTS

12

File does not exist

ERR_FS_FILE_CANT_CREATED

13

File can’t be created

ERR_FS_FILE_CANT_OPEN

14

File can’t open

ERR_FEATURE_NOT_SUPPORTED

15

Feature is not supported

ERR_RESERVED_2

16

(Reserved)

ERR_RESERVED_3

17

(Reserved)

ERR_RESERVED_4

18

(Reserved)

ERR_RESERVED_5

19

(Reserved)

ERR_RESERVED_6

20

(Reserved)

ERR_PACKET_CRC

21

Packet CRC error

ERR_PACKET_MISSED

22

Packet number isn't expected (missing packet)

ERR_PACKET_SIZE

23

Packet size is wrong

ERR_RESERVED_7

24

(Reserved)

ERR_RESERVED_8

25

(Reserved)

ERR_RESERVED_9

26

(Reserved)

ERR_RESERVED_10

27

(Reserved)

ERR_RESERVED_11

28

(Reserved)

ERR_RESERVED_12

29

(Reserved)

ERR_EDID_CORRUPTED

30

EDID corrupted

ERR_NON_LISTED

31

Device specific errors

ERR_SAME_CRC

32

File has the same CRC – no changed

ERR_WRONG_MODE

33

Wrong operation mode

ERR_NOT_CONFIGURED

34

Device/chip was not initialized

HDMI, HDMI High-Definition Multimedia Interface, and the HDMI Logo are trademarks or registered trademarks of HDMI Licensing Administrator,
Inc.