Kramer KDS-17EN, KDS-17DEC User Manual

USER MANUAL

MODELS:

KDS-17EN / KDS-17DEC

4K60 4:4:4 AVoIP Encoder / Decoder

P/N: 2900-301718 Rev 1 www.kramerav.com

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Contents

2

Contents

Contents 2
Introduction 3

Getting Started 3
Overview 4
Typical Applications 5
Controlling your KDS-17 device 5

Defining KDS-17EN 6
Defining KDS-17DEC 8
Mounting the KDS-17 Devices 10
Connecting the KDS-17 Devices 12

Configuring the Network Switch 13
Installing the Kramer recommended SFP transceiver 14
Connecting the Audio/Input Output 14
Connecting to a KDS-17 device with RS-232 15

Operating and Controlling KDS-17 Devices 16

Using the LCD Display 16
Operating via Ethernet 18

Using KDS-17EN Embedded Web Pages 23

Dashboard: Overview of Streaming 24
AV Settings: Define Video and Audio Output 26
EDID: Setting Display Metadata 29
Device Settings: General, Network, Time & Date 30
Security: Passwords, HTTPS, 802.1X and AES256 34
Gateway: CEC, RS-232 and IR definitions 38
Diagnostics: Status, Connections and Logging 41
About 44
Upgrading Firmware 45

Using KDS-17DEC Embedded Web Pages 46

Dashboard: Overview of Streaming 47
AV Settings: Video, OSD, KVM, Video Wall & Overlay 49
Device Settings: General, Network and Time Settings 60
Security: Passwords, HTTPS and 802.1X 64
Gateway: CEC, RS-232 and IR definitions 68
Diagnostics: Status, Connections and Logging 71
About 74
Upgrading Firmware 75

Defining Dante Audio as an Audio Source or Destination 76

Defining Dante input to the KDS-17EN encoder 76
Defining Dante output from the KDS-17DEC decoder 76
Using Dante Software 76

Technical Specifications 79

KDS-17EN Specifications 79
KDS-17DEC Specifications 80
Default Communication Parameters 81

Protocol 3000 82

Understanding Protocol 3000 82
Protocol 3000 Commands 83
Result and Error Codes 102

Warranty 104

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Introduction

3

Go to

http://www.kramerav.com/downloads/kds

application programs, and to check if firmware upgrades are available (where appropriate).

Caution:

Warning:

Introduction

Welcome to Kramer Electronics! Since 1981, Kramer Electronics has been providing a world
of unique, creative, and affordable solutions to the vast range of problems that confront the
video, audio, presentation, and broadcasting professional on a daily basis. In recent years, we
have redesigned and upgraded most of our line, making the best even better!

Getting Started

We recommend that you:

• Unpack the equipment carefully and save the original box and packaging materials for
possible future shipment.

• Review the contents of this user manual.

http://www.kramerav.com/downloads/kds-17en or

Achieving Best Performance

• Use only good quality connection cables (we recommend Kramer high-performance,
high-resolution cables) to avoid interference, deterioration in signal quality due to poor
matching, and elevated noise levels (often associated with low quality cables).

• Do not secure the cables in tight bundles or roll the slack into tight coils.

• Avoid interference from neighboring electrical appliances that may adversely influence

signal quality.

• Position your Kramer KDS-17EN / KDS-17DEC away from moisture, excessive sunlight
and dust.

Safety Instructions

• This equipment is to be used only inside a building. It may only be connected to other
equipment that is installed inside a building.

-17dec to check for up-to-date user manuals,

• For products with relay terminals and GPI\O ports, please refer to the permitted rating
for an external connection, located next to the terminal or in the User Manual.

• There are no operator serviceable parts inside the unit.

• If using a power cord, only use the Kramer approved power cord.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Introduction

4

Recycling Kramer Products

The Waste Electrical and Electronic Equipment (WEEE) Directive 2002/96/EC aims to reduce
the amount of WEEE sent for disposal to landfill or incineration by requiring it to be collected
and recycled. To comply with the WEEE Directive, Kramer Electronics has made
arrangements with the European Advanced Recycling Network (EARN) and will cover any
costs of treatment, recycling and recovery of waste Kramer Electronics branded equipment on
arrival at the EARN facility. For details of Kramer’s recycling arrangements in your particular
country go to our recycling pages at www.kramerav.com/quality/environment

.

Overview

Congratulations on purchasing your Kramer KDS-17EN 4K60 4:4:4 AVoIP Encoder /

KDS-17DEC 4K60 4:4:4 AVoIP Decoder.

KDS-17 advanced encoder/decoders stream 4K video signals via Ethernet over copper cable
in unicast (one-to-one) or multicast (one-to-many) configurations.

KDS-17EN and KDS-17DEC provide:

• High quality video and audio streaming

• Outstanding end-user experience

• Ideal for large-scale deployments

• Simple planning and rollout

Outstanding end–user experience

Present video in superb 4K60 4.4.4 resolution, with best-in-class digital audio. With KDS-17,
every visual detail and every nuance of sound comes through super-clearly. Enjoy extensive
control of video walls, advanced connectivity options, and a wide choice of inputs/outputs and
settings options.

Ideal for large–scale deployments

Provide a high-performance solution fine tuned to the needs of large enterprise, education
and government sites, with integrated advanced management capabilities and support for
many simultaneous video streams.

Easy planning and deployment

Easily and confidently integrate the AV solution into any IP network. Create A/V–enabled
spaces of varying sizes swiftly and effortlessly, even without prior AV expertise. KDS–17 is
very bandwidth–efficient, allowing you to leverage your IT infrastructure without perceptible
network performance disruptions. Use of the existing IT network and Ethernet cabling,
simplified switch configurations, and reduced dependence on skilled technicians save
deployment time and cost.

KDS-17EN / KDS-17DEC – Introduction

5

Typical Applications

KDS-17EN / KDS-17DEC are ideal for the following typical applications:

• Real-time essential installations such as command and control rooms.

Large scale AV content sharing installations using existing wires and infrastructure in

•

corporate offices and government applications.

AV distribution systems with one or more sources and multiple displays in schools,

•

universities, and public venues.

• AV installations where low latency KM/KVM capabilities are required.

Controlling your KDS-17 device

Control your KDS-17 device directly via Navigation buttons, or via:

• The Ethernet using built-in user-friendly web pages.

Kramer Electronics Ltd.

• Protocol commands.

KDS-17EN / KDS-17DEC – Defining KDS-17EN

6

#

Feature

Function

1

HDMI OUT Connector

Connect to loop the signal.

2

HDMI IN Connector

Connect to an HDMI source.

3

HOST USB Type B Port

Connect to a USB host, for example, a PC for KVM/USB support.

4

LCD Display

Use for device configuration such as unique channel/AV stream setting.

5

Menu Navigation
Press to return to the previous menu.



Press to go to the next menu.



Press to move up to the next configuration parameter.



Press to move down to the next configuration parameter.

Enter

Press to enter the menu and to accept changes.

6

LINK

Lights Green

A link is established from KDS-17EN to KDS-17DEC and is transmitting A/V
signals.

Flashes Green

HDMI input is detected, but no valid AV signal is output.

Off

No HDMI input is detected.

7

NET

Off

No IP address is acquired.

Lights Green

A valid IP address has been acquired.

Flashes Green Very
Fast

When a device identification command was received (Find me), flashes for 60
seconds.

Lights Yellow

No DHCP found, device falls back to IP address in subnet range 192.168.0.0/16.

Lights Red

Security is blocking IP access.

8

ON

Lights Green

Device power is on.

Flashes Green Fast

Firmware is downloaded in the background.

Flashes Green Very
Fast

A device identification command is sent (Find me), flashes for 60 seconds.
Lights Yellow

Device falls back to default IP address (192.168.1.39).

Lights Red

Security is blocking IP access.

Flashes Red

On fallback address acquiring, flashes continuously in a slow 0.5/10
secondcadence.

9

20-24V DC Connector

Connect the optional 20-24V DC power adapter (purchased separately).

Defining KDS-17EN

Kramer Electronics Ltd.

Button

LED

LED

Figure 1: KDS-17EN 4K60 4:4:4 AVoIP Encoder



LED

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Defining KDS-17EN

7

#

Feature

Function

10

RESET Recessed Button

Press and hold for 10 seconds to reset the device to factory default values.
All LEDs flash.

11

LAN 1: 1G(PoE+)

Connect to the LAN. KDS-17EN is powered by PoE+ (power over Ethernet)

Multicast: Connect to multiple decoders.

12

LAN 2: 1G SFP OUT IN
Connector

Plug in an SFP (Small Form Factor Pluggable) optical or copper transceiver for
streaming over cable.

13

RS-232 3-pin Terminal Block
Connector

Connect to an RS-232 device to use as a Gateway and bi-directional signal
extension (even when no AV signal is extended).

14

AUDIO IN/OUT 5-pin
Terminal Block Connector

Connect to a balanced analog stereo audio source/acceptor (must be either in or
out, not both).

15

IR 3.5 Mini Jack

Connect to an IR sensor or emitter for bi-directional signal extension (even when
no AV signal is extended). Expected voltage for IR receiver - (3.3V).

16

USB Type A Charging Ports
(1 and 2)

Connect to USB devices, for example, to a speakerphone and webcam.

RJ-45 Port

delivered through the LAN PoE+ port, unless the optional 20-24V DC power
adapter is attached.
Unicast: Connect for streaming either directly to a decoder or via LAN.

KDS-17EN / KDS-17DEC – Defining KDS-17DEC

8

#

Feature

Function

17

LCD Display

Use for device configuration such as unique channel/AV stream setting.

18

Press to return to the previous menu.

Press to go to the next menu.

Press to move up to the next configuration parameter.

Press to move down to the next configuration parameter.

Enter

Press to accept changes.

Lights Green

A link is established from KDS-17DEC to KDS-17EN and A/V signals are being
received.

Flashes Green

A link is established, but no valid AV signal is detected.

Off

Input streaming has been disabled.

Lights Green

A valid IP address has been acquired.

Flashes Green Very
Fast

When a device identification command is sent (Find me), flashes for 60 seconds.
Lights Yellow

No DHCP found, device falls back to IP address in subnet range 192.168.0.0/16.

Lights Red

Security is blocking IP access.

Off

No IP address is acquired.

Lights Green

Device power is on.

Flashes Green Fast

Firmware is downloaded in the background.

Flashes Green Very
Fast

A device identification command is sent (Find me), flashes for 60 seconds.
Lights Yellow

Device falls back to default IP address (192.168.1.40).

Lights Red

Security is blocking IP access.

Flashes Red

On fallback address acquiring, flashes continuously in a slow 0.5/10sec cadence.

22

20-24V DC Connector

Connect to the optional 20-24V DC power adapter (purchased separately).

23

RESET Recessed Button

Press and hold for 10 seconds to reset the device to its factory default values. All
LEDs flash.

Defining KDS-17DEC

Kramer Electronics Ltd.

Menu Navigation

LINK

19

LED

NET

20

LED

Button

Figure 2: KDS-17DEC 4K60 4:4:4 AVoIP Decoder






ON

21

LED

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Defining KDS-17DEC

9

#

Feature

Function

Connect to the LAN. KDS-17DEC is powered by PoE+ (power over Ethernet)

Multicast: Encoder is streaming to multiple decoders.

Plug in an SFP (Small Form Factor Pluggable) optical or copper transceiver for
Ethernet traffic over cable.

RS-232 3-pin Terminal Block
Connector

Connect to an RS-232 device to use as a Gateway and bi-directional signal
extension (even when no AV signal is extended).

AUDIO OUT 5-pin Terminal
Block Connector

Connect to a balanced analog stereo audio source/acceptor.

Connect to an IR sensor or emitter for bi-directional signal extension (even when
no AV signal is extended). Expected voltage for IR receiver - (3.3V).

USB Type A Charging Ports
(1 and 2)

Connect to USB devices, for example, to a speakerphone and webcam.
30

HDMI IN Connector

Connect to an HDMI source.

31

HDMI OUT Connector

Connect to an HDMI acceptor.

LAN 1: 1G(PoE+)

24

RJ-45 Port

25 LAN 2: 1G SFP OUT IN

26

27

28 IR 3.5 Mini Jack

29

delivered through the LAN PoE+ port, unless the optional 20-24V DC power
adapter is attached.
Unicast: Connected for streaming directly from the encoder.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Mounting the KDS-17 Devices

10

• Operation temperature – 0° to 40°C (32 to 104°F).

Caution:

Warning:

Mounting the KDS-17 Devices

Before installing the devices, verify that the environment is within the recommended range:

• Storage temperature – -40° to +70°C (-40 to +158°F).

• Humidity – 10% to 90%, RHL non-condensing.

• Mount KDS-17EN and KDS-17DEC before connecting any cables or power.

• Ensure that the environment (e.g., maximum ambient temperature & air flow) is

compatible for the device.

• Avoid uneven mechanical loading.

• Appropriate consideration of equipment nameplate ratings should be used for avoiding

overloading of the circuits.

• Reliable earthing of rack-mounted equipment should be maintained.

• Maximum mounting height for the device is 2 meters.

Mount KDS-17EN / KDS-17DEC in a rack:

• Use the recommended rack adapter (see www.kramerav.com/product/KDS-17EN).

1. Unfasten the knobs to remove the open panel.

2. Slide the device into the panel opening.

3. Attach the device to the panel using 4 screws (2

on each side to secure the device to the panel).

KDS-17EN / KDS-17DEC – Mounting the KDS-17 Devices

11

bracket (included) on each side

For more information go to www.kramerav.com/downloads/KDS-17EN or

http://www.kramerav.com/downloads/KDS-17DEC

4. Slide the open panel with the device into the rack
opening.

5. Turn the knob to secure panel to rack.

Mount the on a surface using one of the
following methods:

Kramer Electronics Ltd.

• Attach the rubber feet and place the unit
on a flat surface.

• Fasten a

of the unit and attach it to a flat surface.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Connecting the KDS-17 Devices

12

By

can be purchased

to connect the product

Always switch off the power to

KDS

power to each device.

Connecting the KDS-17 Devices

-default, KDS-17 devices use PoE for power. An optional power adapter

-17DEC. After connecting your devices, connect their power and then switch on the

to the mains electricity.

a device before connecting it to your KDS-17EN or

Figure 3: Connecting the KDS-17EN to a KDS-17DEC

KDS-17EN / KDS-17DEC – Connecting the KDS-17 Devices

13

RS
connected to the HDMI OUT connector on the

2

14

11

24

31

27 3 29

15

28

13

26

To connect KDS-17EN as illustrated in the example in Figure 3:

1. Connect an HDMI source (for example, a server or a media player) to the HDMI IN
connector on the KDS-17EN.

2. Connect a balanced stereo audio source (for example, the server audio connector) to
the AUDIO IN/OUT 5-pin terminal block connector on the KDS-17EN.

3. Connect the LAN MEDIA 1G(PoE) RJ-45 port on the KDS-17EN to the LAN MEDIA
1G(PoE) RJ-45 port on the KDS-17DEC via a LAN switch.

4. Connect the HDMI OUT connector on the KDS-17DEC to an HDMI acceptor (for
example, a display).

5. Connect the AUDIO OUT 5-pin terminal block connector on the KDS-17DEC to a
balanced stereo audio acceptor (for example, an audio amplifier).

6. Connect the USB ports:

 On KDS-17EN, connect a laptop or media center to the USB HOST port .

 On KDS-17DEC, connect a mouse and a keyboard to the two USB type A ports .

Kramer Electronics Ltd.

7. Control the dis

play connected to KDS-17DEC from the encoder side via IR:

 On KDS-17EN, connect an IR sensor cable to the IR 3.5mm mini jack .

 On KDS-17DEC, connect the IR 3.5mm mini jack to an emitter cable and attach

the emitter side to the IR sensor of the display.

8. Connect RS-232 3-pin terminal block connectors:

 On the KDS-17EN, connect the RS-232 port to a laptop/controller.

 On the KDS-17DEC, connect RS-232 to the display.

-232 bidirectional signals can be sent between the display and the laptop

KDS-17DEC.

Configuring the Network Switch

Before setting the system, make sure that your AV over IP network switch meets the following
minimum requirements:

• IGMP Snooping – On.

• IGMP Querier – On.

• IGMP Immediate/Fast Leave – On.

• Unregistered Multicast Filtering – On.

• Jumbo frames – Enable (when AES256 full encryption is required).

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Connecting the KDS-17 Devices

14

Warning: Class 1 Laser Product

To achieve specified extension distances, use the recommended Kramer cables

or

Figure 4: Connecting to a Balanced Stereo Audio

Source/Acceptor

Figure 5: Connecting to an Unbalanced Stereo

Audio Acceptor

Figure 6: Connecting an Unbalanced Stereo Audio

Source to the Balanced Input

Installing the Kramer recommended SFP transceiver

1. Remove the currently installed transceiver: Pull down the bale
clasp and insert the dust plug. Store the transceiver in a safe
place.

2. Make sure the bale clasp of the new transceiver is pushed up, in
the closed position.

3. Insert the new transceiver into the SFP port and push it in until it
clicks.

4. Remove the dust cap and store it in a safe place for future use.

Warning: Connecting the SFP connector to an LC(APC) fiber connector
may cause poor performance and damage the connector!

Invisible laser radiation present.

Avoid long-term viewing of laser.

Avoid the use of magnifying viewing aids or instruments (such as binoculars, telescopes, microscopes and

magnifying lenses, but not spectacles or contact lenses).

Avoid placing optical devices in the emitted beam that could cause the concentration of the laser radiation to be

increased.

http://www.kramerav.com/product/kds-17dec. Using third-party cables may cause damage!

available at http://www.kramerav.com/product/kds-17en

Connecting the Audio/Input Output

The following are the pinouts for connecting the input/output to a balanced or unbalanced
stereo audio acceptor:

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Connecting the KDS-17 Devices

15

RS-232 Device KDS-17

13

Connecting to a KDS-17 device with RS-232

KDS-17EN and KDS-17DEC can transmit or receive data via the RS-232 connection and

relay that data to the remote encoder or decoder.

KDS-17 devices feature an RS-232 3-pin terminal block connector which can be used to

transmit RS-232 data between the encoder and decoder and to remotely control connected
devices.

Connect the RS-232 terminal block on the rear panel of the KDS-17 device to a PC/controller,
as follows:

From the RS-232 9-pin D-sub serial port connect:

• Pin 2 to the TX pin on the KDS-17 RS-232 terminal block

• Pin 3 to the RX pin on the KDS-17 RS-232 terminal block

• Pin 5 to the G pin on the KDS-17 RS-232 terminal block

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

16

KDS

Operating and Controlling KDS-17 Devices

Using the LCD Display

Connect the KDS-17 device’s LAN 1 port to a LAN switch with PoE+ (power over ethernet). If
PoE is unavailable, connect the device to the 20-24V DC power adapter and connect the
adapter to the mains electricity. The LEDs light white while the device boots and then the ON
and NET LEDs light green or yellow, indicating that the device is on and has a valid IP
address.

Using the Menu Navigation button

Use the menu navigation button to view and change device parameters in the LCD display.

-17EN and KDS-17DEC have slightly different menus.

Figure 7: The Menu Navigation button

• Up/down arrows – Move to the previous/next menu item.

• Left/right arrow – Open the previous/next level menu.

• Enter button – Select a menu option / accept and save changes.

If the LCD display is blank a single press of Enter will cause it to display the connected
channel number, a second press of Enter opens the Main Menu.

Use Enter to accept and save changes in the MAIN MENU > DEV SETTINGS.

Using the KDS-17 LCD Display Menu

To access the LCD display menu, press Enter on the Menu Navigation button: The Main
Menu is displayed.

The Main Menu has 3 sub-menus (listed below):

 An asterisk (*) indicates the active option.

 Changes are made in MAIN MENU > DEV SETTINGS. Press Enter on an option to

make it active.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

17

Main Menu
Item

Sub-menu Options

Output

LAN 1

IP address of the device.

LAN 2

IP address of the device.

INPUT

(same for both devices)

CH Define (encoder)
CH Select (decoder)

Channel number of the stream.
(same for both devices)

Temperature

Device temperature.

FW: Firmware version

HW: Hardware version.

Channel ID of the output stream.

each digit, press Enter to confirm the final number.

PASSTHROUGH (uses the source HDMI resolution)

3840x2160P60

Channel ID of the input stream.

each digit, press Enter to confirm the final number.

1. DEV

STATUS

Kramer Electronics Ltd.

• I/O Resolution if a signal is input or output.

• HDCP status of the input/output.

2. DEV INFO

Encoder only

3. DEV

Decoder only

3. DEV

SETTINGS

SETTINGS

EDID

HDCP

CH DEFINE

INPUT

RESOLUTION

CH SELECT

BL: Build version

Lists the stored EDIDs (maximum 8).

ON or OFF.

To change the channel use the up/down arrows to change

HDMI IN or STREAM IN.

NATIVE (uses the EDID’s resolution)

To change the channel use the up/down arrows to change

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

18

If both these options fail, then

Directly to a PC

Operating via Ethernet

Allocating an IP Address to the Device

By default, DHCP is enabled, and assigns an IP address to the devices. If a DHCP Server is
not available, for example, if LAN 1 is connected directly to a laptop, the device will try to
allocate the default IP address of 192.168.1.39 (encoder) or 192.168.1.40 (decoder).
If the default IP address is unavailable, the system searches for a random unique IP in the
range of 192.168.X.Y. The allocated IP address can be viewed in the LCD Display (see
instructions below).

follow the instructions in (see Connecting Ethernet Port

To view the allocated IP address on the LCD Display

1. Connect LAN 1 to a LAN switch with PoE+ (power over ethernet). The LEDs light white
while the device boots and then the ON and NET LEDs light green or yellow, indicating
that the device is on and has a valid IP address.

on page 20).

2. Use the Menu Navigation button to view the assigned IP address on the LCD screen:

a. Click Enter to display the channel number and Enter again, to display the LCD’s

MAIN MENU.

b. Use the navigation arrows to select DEV STATUS > LAN1 STATUS and the device

IP is displayed.

Setting the Channel Number

Each encoder requires a unique channel number, and the connected decoders must be tuned
to the encoder’s channel. You can set the channel number via the LCD screen menu or the
embedded web pages.

To set the channel number in the LCD Display’s menu:

1. Connect LAN 1 to a LAN switch with PoE+ (power over ethernet). The LEDs light white
as the device boots and then the ON and NET LEDs light green or yellow, indicating that
the device is on and has a valid IP address.

2. Use the Menu Navigation button to set the channel number with the LCD screen: Press
Enter to display the channel number and Enter again, to display the LCD’s MAIN MENU.

3. Use the arrows to select
encoder - DEV SETTINGS > CH DEFINE
decoder - DEV SETTINGS > CH SELECT.

4. A cursor will flash under the first digit of the channel number. Use the up/down arrow keys
to change the digit and the right arrow to move to the next digit. Press Enter to save your
selection.

5. The channel ID must be the same on both devices.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

19

To set the channel number in the embedded web pages (if not using the LCD Display)

1. Find the device’s IP address (see Allocating an IP address in the previous page).

2. Enter the IP address in the browser on a computer connected to the same network as
the device (or on the computer to which the device is connected).

3. In the Main page (Dashboard tab) set the Channel ID.

Accessing the Embedded Web Pages

The embedded web pages are an HTML user interface stored inside the device.

1. The embedded web pages are accessed by entering the device’s IP address in a
browser (on a computer) connected to the same network as the device.

2. If you don’t know the device’s IP address, see Allocating an IP Address to the Device
on page 18.

3. If security is enabled, enter the Password (default admin).

Figure 8: Login Window

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

20

This type of connection is recommended for identifying
with the factory configured default IP address

Connecting Ethernet Port Directly to a PC

You can connect the Ethernet port of a KDS-17 device directly to the Ethernet port on your
PC using LAN 1 (crossover cable with RJ-45 connectors).

KDS-17EN or KDS-17DEC

After connecting the device to the Ethernet port, configure your PC as follows:

1. Click Start > Settings > Network and Internet.

2. Click Change Adapter Settings.

3. Highlight the network adapter you want to use to connect to the device and click Change
settings of this connection.
The Local Area Connection Properties window for the selected network adapter appears
as shown in Figure 9

.

es.

Figure 9: Local Area Connection Properties Window

4. Highlight either Internet Protocol Version 6 (TCP/IPv6) or Internet Protocol Version 4
(TCP/IPv4) depending on the requirements of your IT system.

5. Click Properties.
The Internet Protocol Properties window relevant to your IT system appears as shown in

Figure 10 or Figure 11

.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

21

Figure 10: Internet Protocol Version 4 Properties Window

Figure 11: Internet Protocol Version 6 Properties Window

6. Select Use the following IP Address for static IP addressing and fill in the details as
shown in Figure 12

.
For TCP/IPv4 you can use any IP address in the range 192.168.1.1 to 192.168.1.255
(excluding 192.168.1.39 and 192.168.1.40) that is provided by your IT department.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Operating and Controlling KDS-17 Devices

22

Figure 12: Internet Protocol Properties Window

7. Click OK.

8. Click Close.

Connecting the Ethernet Ports

You can connect the Ethernet ports of KDS-17EN and KDS-17DEC to the Ethernet port on a
network hub/switch (they must both be connected to the same network) or connect them
directly to one another using a cable with RJ-45 connectors.

Configuring the Ethernet Port

You can set the Ethernet parameters via the embedded web pages (requires a network hub or
switch connection).

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

23

You can also configure

Commands

If a web page does not update correctly, clear your Web browser’s cache.

Some features might not be

Using KDS-17EN Embedded Web Pages

KDS-17EN via Protocol 3000 commands (see Protocol 3000

For instructions on how to connect the encoder and load the web pages, see Accessing the

Embedded Web Pages on page 19.

To Browse the KDS-17EN Web Pages

1. Open your Internet browser.

on page 83).

available in some mobile device operating systems.

2. Type the IP number of the device in the Address bar of your

browser. For example, the default IP number:

The Login window appears.

3. Enter the Password (admin, by default).
The KDS-17EN page appears.

Figure 13: Login Window

Figure 14: Embedded Web Page with Navigation List on Left

4. Click the tabs on the left side of the screen to access the relevant web page.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

24

Dashboard: Overview of Streaming

The KDS-17EN Dashboard shows an overview of AV streaming and audio information. Use
the dashboard to set the streaming channel, mode and audio parameters.

To set the streaming channel

1. In the Dashboard

pane, activate

AV Streaming.

2. Update the channel ID:

 Channel

assignation is

automatic, to

manually set a

channel number

use the arrows or

click on the box (1 -

999).

The same channel

ID must be set on

the decoder.

3. Additional non-editable fields are displayed to describe the input AV:

• Device Name – The network host name. Can be updated in Device > General.

• Input Signal – Source of the input video.

• Video Details – Input video’s resolution.

• HDCP Encryption – Is HDCP active, (High-bandwidth Digital Content Protection) used to

protect copyrighted material.

• Aspect Ratio – Aspect ratio of the input video.

• Audio Channels – Number of channels in audio input.

• Audio Sample Rate – Input audio signal’s sample frequency (number of samples per

second).

• Audio Format – LPCM (uncompressed audio), Dolby (compressed), HBR (compressed high
bit rate, such as Dolby TrueHD).

4. Click the green check to confirm any changes.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

25

Previewing the AV
Stream:

In the Dashboard pane,

activate AV Streaming

Preview.

The AV Streaming Preview

aspect ratio, FPS and

bandwidth can be changed

in AV Settings > Video

(see Preview).

Setting the output audio’s source and format:

• In the Dashboard pane’s Device Audio Routing field group, choose the audio input for
each potential audio output option.

Kramer Electronics Ltd.

Figure 15: Dashboard: Audio Routing Options

For more information on inputting Dante audio, see Defining Dante Audio as an Audio

Source or Destination on page 76.

Additional audio settings can be configured in AV Settings > Audio.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

26

AV Settings: Define Video and Audio Output

Define KDS-17EN output AV stream settings. There are two tabs: Video and Audio.

Video tab: Define video output

1. Select the AV Settings pane. The Video tab opens.

Kramer Electronics Ltd.

_

Figure 16: AV Settings – Video tab

2. Define the following settings:

 HDMI Input: Enable (default) / disable HDCP encryption for the HDMI input.

 HDMI & Stream Output:

 Force RGB on Output – Force video output to separate red, green and blue

colors. Required by some monitors. Off by default.

 IP Casting Mode:

 Unicast / Multicast (default) – Multicast communication transmits the data stream

to multiple receivers simultaneously, select unicast if your stream is intended for a
single receiver.

 Multicast Prefix – Select a prefix for the multicast stream’s IP between 224 and

239 (default prefix is 226.x.x.x). Routers identify multicast streams by their IP
prefix and handle the stream’s packets as data which is not directed to a specific
recipient: It is a general stream addressed to the entire network.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

27

 TTL - Time To Live (TTL) restricts the number of times a packet/data can be

forwarded by network routers before it is discarded. It stops the stream data from
circulating endlessly in the network. Select a value between 1 and 65535.

 Preview: Set the parameters of the Dashboard’s preview stream.

 Width – 1 to 1280 (default 960).

 Height – 1 to 720 (default 540).

 FPS- 1 to 60 (default 15).

 Bandwidth – 1 to 50,000 (default 8000).

3. Click SAVE.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

28

Audio tab: Define Audio Output

Set the source of the encoder audio input and method used to output the audio.

Defining Analog Audio Direction:

Kramer Electronics Ltd.

Figure 17: AV Settings > Audio, Analog Audio

• Analog Audio Direction IN/OUT - Select IN (default) or OUT. Analog audio uses the
encoder’s 5-pin terminal block connector (14 in Defining KDS-17EN on page 6

). It can only be

in one direction (in or out), which must be specified.

Click SAVE after changing settings.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

29

EDID: Setting Display Metadata

EDIDs (Extended Display Identification Data) are metadata sent from HDMI display devices
which describe their formatting and capabilities. The EDID is used to adjust output sent to the
display device, so that it matches the display’s requirements. KDS-17EN can retrieve an EDID
from a remote display (connected to the decoder), use the predefined default EDID or upload
a custom EDID from a connected computer.

Step 1: Select Source.

To set an EDID, click on a Select Source square and then click COPY EDID at the

bottom; The selected EDID will be copied to Step 2.

Select Source options:

 Remote – Opens a pop-up for entry of the desired decoder’s IP address. The EDID

of the screen connected to the HDMI Out port of the selected decoder will be
returned to the device. Click the download icon to store it on your computer.

 Default – A default EDID is supplied with the KDS-17EN. Click the bottom right

corner to view the EDID bitmap. Click the download icon to store it on your
computer.

 Custom - Upload a stored EDID file from your computer.

Step 2: Copy EDID to Destination

Click COPY EDID and your selected EDID will be loaded into Step 2.

EDID is managed.

Figure 18: EDID pane

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

30

When an HDMI OUT screen is connected without input, the screen

Device Settings: General, Network, Time & Date

The KDS-17EN Device pane has three tabs:

• General – Sets the KDS-17EN host name, updates firmware, restarts or resets KDS-

17EN. You can also export or input KDS-17EN settings.

• Network – Set the LAN 1 and LAN 2 parameters for the device.

• Date & Time – Define an NTP (network time protocol) server or set the time. An NTP

server is advisable, as it coordinates the time between all the connected devices.

General tab

Figure 19: Device Settings – General tab

• Device name – Edit or view the device’s Host name (default is <model>-<MAC>).

• Model Name of the encoder.

• Serial Number of the encoder.

• Firmware Version – To update the encoder firmware, download the latest version from

http://www.kramerav.com/downloads/kds-17en

to a local network location and then click

Update to select and upload it.

• Front Panel Lock – Enabling this option prevents use of the LCD Display.

• Device Restart – Click to restart KDS-17EN (confirmation will be requested).

• Factory Reset - Click to reset the device's operation mode and restart the device

(confirmation is requested).

• Find Me – The LEDs will flash fast for 60 seconds to identify the device.

shows the device’s IP.

• Device Configuration –

 Export Device Settings – Outputs a settings file with the name “file.tar.gz”. Settings

are stored in JSON format.

 Import Device Settings – Imports a settings file in the same format as the output file

(tar.gz). The device will be reset to the uploaded settings.

Click Save to store changes or update settings.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

31

Network tab: Using LAN 1 and LAN 2 for different streams

KDS-17EN has two Ethernet ports, LAN 1 and LAN 2 (11 and 12 in Defining KDS-17EN

on page 6). By default, all network connections use both ports, however you can separate the
types of stream sent to/from each port and use different IP addresses for the each port.
For example, use one port for AV and the other for control commands such as P3K (P3000
API) commands.

Figure 20: Device Settings pane – Network Tab

• Ethernet Bridge Mode – Enable if you are using separate IP addresses for LAN 1 and
LAN 2 and want to allow additional data streams to access LAN 2.

o Bridge Port – Must be set to LAN 2.

o VLAN ID – Ethernet data tagged with the VLAN ID will be allowed to reach LAN 2.

IP Address Settings

• Service Name – Stream is for the AV stream. Control is for PK3000 commands, RS-232
or IR data. Dante (Digital Audio Network Through Ethernet) is for transmitting high-quality
digital audio over Ethernet. Dante uses LAN 2.

• Port – LAN 1 or LAN 2. The Ethernet port used by the service.

• 802.1Q – If set to On (off by default), the data transmission uses VLAN tags.

o VLAN Tag – VLAN (virtual local area network) tags (range 2 – 4000) are used to

separate the network into smaller virtual networks. Requires 802.1Q to be set to
On.

• DHCP – If set to On, the service’s IP address is generated automatically. If set Off, you

may need to define a static IP address for the service.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

32

802.1Q and VLAN are not required for the Media port.

In this screen, Dante is also used for AES67 streams.

For more information

on

802.1Q and VLAN are not required for

To separate Control streams from AV streams

1. Change the following settings in the IP Address Settings section of the Network tab
(see Figure 20

for more information):

 In the Control row’s Port column select LAN 2 and set 802.1Q to On.

 In the VLAN Tag column, enter an integer number (2 - 4093) for Control services.

This separates the Control packets.

2. To use a static IP for LAN 2, set DHCP to Off and enter a subnet mask and gateway
address. If no static IP is defined, the DHCP server will allocate the IP.

If no DHCP server exists in the system, the device will look for a random unique IP in the
range of 169.254.X.Y. The allocated IP address

To separate Dante/AES67 Audio from the AV streams:

see Defining Dante Audio as an Audio Source or Destination

page 76.

Kramer Electronics Ltd.

is shown in the IP address field.

1. To export Dante audio from the encoder, you must first go to the KDS-17EN
Dashboard pane and set at least one of the Device Audio Routing INPUTS to
Dante (see Audio OUT: Set the audio output on page 48

2. In the KDS-17EN Device Settings pane, open the Network tab (see Figure 20):

In the IP Address Settings, set the Dante row’s Port column to LAN 2 and set

802.1Q to On.
In the VLAN ID column, enter an integer number (2 - 4093) for Dante services.
Make sure this is different from the number used for the Control packets.

3. To use a static IP for LAN 2, set DHCP to Off and enter a subnet mask and gateway
address. If no static IP is defined, the DHCP server will allocate the IP.

Dante audio output is now defined.

).

LAN 1.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

33

Time & Date tab

To sync device time and date from a network time server:

1. In the Device pane, select the Time & Date tab. If no NTP Time Server is defined, the
time will be set to 1970 every time the device reboots.

2. Set the Time zone.

3. Set Use Time Server (NTP), to On.

4. Enter the Time Server Address IP.

5. Click the green arrows to check that the server is available.

6. Click SAVE.

The devices date and time are synchronized to the server address entered.

Kramer Electronics Ltd.

Figure 21: Device Settings – Time & Date

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

34

Password protection
(

If you change the password, the new password must include a number, a special
character and both upper and lower case letters (no commas or spaces).

Security: Passwords, HTTPS, 802.1X and AES256

of the web pages is only active when the Security Status is On

the default state). The default password is “admin”.

The KDS-17EN Security pane has three tabs:

 Device Security – Enable/disable security and change the device password.

 HTTPS – Use the device’s internal certificate or upload a local certificate.

 802.1X- Enable and setup IEEE 802.1X authentication.

 AES256 – Set the level of AES256 encryption.

Device Security tab: Enable Password Control

Figure 22: Security pane – Device Security tab

To change Security Status

Move the slider to enable/disable security.

When security is enabled, access to the
web pages requires entry of a password.
Changes to the security status require
entry of the device’s current password
(default: “admin”).

Figure 23: Security pane – pop-up

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

35

To change the password

Password protection is only available if
the Security Status is On. To change
the password, enter the Current
Password and then click Change.

The new password must include a
number, a special character and both
upper and lower case letters (no commas
or spaces).

HTTPS tab

To configure HTTPS:

1. In the Security pane’s Device Security tab, Security Status must be enabled.

2. Select the HTTPS tab.

3. Select one of the following authentication methods:

Kramer Electronics Ltd.

Figure 24: Security pane – Change password

 Internal Certificate – Use the factory default certificate for authentication.

 Server Certificate – Upload an authentication certificate from the server (assigned

by your network administrator). Click to upload the certificate. Enter the private
key password.

Figure 25: Security Tab – Server Certificate

4. Click SAVE.

HTTPS is configured.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

36

802.1X tab

802.1X authentication must be defined separately for LAN 1 and LAN 2. 802.1X is a port­based authentication protocol, that uses a RADIUS network access server to authenticate
devices accessing the network. It must be configured separately for LAN 1 and LAN 2.

To configure IEEE 802.1X Authentication:

1. In the Security pane, select the 802.1X tab.

LAN 1 / LAN 2 - LAN 2 has identical settings and is at the bottom of the screen. Enable and

configure LAN 1 and LAN 2 separately.

2. Set 802.1x authentication ON.

3. Authentication Status:

 Green – LAN is using 802.1X and authentication has succeeded.
 Orange – LAN is using 802.1X and authentication is in process.
 Red – LAN is using 802.1X but authentication has failed.
 Grey – 802.1X is disabled.

4. Check one of the following settings:

 EAP-MSCHAP V2 – To use this authentication method, enter the KDS-17EN

KDS-17DEC username and password.

 EAP-TLS – Submit a certificate from your network authentication server. To do so,

enter the KDS-17EN Username (“admin”) and click to upload the Client Certificate
and Private Key. Enter the Private Key Password (assigned by your network
administrator).

5. Server Certificate – (optional) Use a CA (certification authority) issued certificate to
authenticate the RADIUS server. Enable and click to upload the CA certificate.

Figure 26: EAP-TLS – Certificates and Password

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

37

6. Repeat for LAN 2 if necessary.

7. Click SAVE: 802.1X is configured.

AES256 tab

When Device Security is enabled, AES256 encryption is used to encrypt packet headers, Use
AES256 Full to encrypt the whole packet. By default, a system key is used for encryption and
decryption. If you want to enter a custom key, key make sure both encoder and decoders are
updated to use the same key.

Figure 27: Security pane – AES256 tab

AES256 Mode: Standard or Full.

• Standard encrypts the packet headers into blocks of 128 bits each.

• Full encrypts the entire packet and requires that Jumbo Frames are enabled on the switch,

so that the transmitted IP packet is not larger than the maximum Ethernet frame.

AES KEY: Default or customized.

• Default uses 14 rounds of processing to create a device defined 256 bit key.

• Customized requires you to enter a 32 byte hexadecimal string (64 characters using only

the characters 0 – 9 and A to F). No hex code identifier is required before the string.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

38

Gateway: CEC, RS-232 and IR definitions

The KDS-17EN Gateway pane has three tabs:

 CEC – Enable and setup direction of CEC commands.

 RS-232 – Enable and configure the use of RS-232 communication.

 IR- Setup direction of pass-through IR (infrared) controls.

CEC tab: Configuring CEC commands

CEC (Consumer Electronics Control) are commands that HDMI devices can send to
connected devices, so that controls sent to a single device are used to control multiple
connected devices.

KDS-17EN can send CEC commands over LAN to CEC enabled devices that are connected

to the KDS-17DEC.

To set CEC Gateway:

1. In the Gateway pane, click CEC.

Figure 28: Control > Settings Page – CEC Settings

2. Enable the CEC gateway.

3. Select the Gateway HDMI port to which CEC commands are sent (HDMI input or HDMI
output).

4. If you are sending CEC commands to the decoder, set Passthrough HDMI IN with to
Decoder HDMI Output.

5. Click refresh , to see the address of the CEC device attached to the HDMI port.

6. Enter the CEC command in hexadecimal format.

7. Click SEND.

8. View the CEC-enabled device response in the CEC Notifications field.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

39

RS-232 tab

KDS-17EN can receive RS-232 commands over LAN, that were sent to a connected

decoder’s RS-232 port. These commands can be used to remotely control KDS-17EN.

To set RS-232 Gateway:

1. In the Gateway pane, click the RS-232 tab.

Figure 29: Gateway > RS-232

2. Click Enable to enable RS-232 gateway or click Disable.

3. Define the RS-232 gateway port (5001, by default).

4. Enter the Baud Rate: 1200 to 115200 (default).

5. Enter the Data Bits: 5, 6, 7 or 8 (default).

6. Enter Parity: None (default), Odd or Even.

7. Enter Stop Bits: 1 (default) or 2.

8. Click SAVE.

RS-232 Gateway is configured.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

40

IR tab

KDS-17EN can send or receive IR commands over LAN, to or from a connected decoder. The

IR signals can be used to control a relevant device and the direction should be the opposite of
that specified on the connected decoder.

To set RS-232 Gateway:

1. In the Gateway pane, select the IR tab.

2. Set IR direction:

 IN – Configure the IR port as an input port that is connected to an IR receiver cable.

 OUT – Configure the IR port as an output port that is connected to an IR emitter

cable.

3. Click Save.

IR Gateway is configured.

Figure 30: Control > Settings Page – IR Settings

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

41

Diagnostics: Status, Connections and Logging

The KDS-17EN Diagnostics pane has three tabs:

 STATUS – View the device’s activity state, temperature, and output ports.

 CONNECTION – View the device’s active network connections.

 ADVANCED – Activate, view and export the system log.

Status tab

1. In the Diagnostics pane, click Status.

2. Device Status:

 Active, for normal operation (green indication).

 Standby, when device is powered off, booting or in standby mode.

3. Heat Level:

 Normal, for temperatures below 45°C.

 High, for temperatures between 45°C and 60°C.

 Overheat, for temperatures above 60°C.

4. View the status of the outputs:

 HDMI OUT - On, the output channel is transmitting an active signal.

 LAN – On, a signal is being transmitted.

Device status is viewed.

Figure 31: Diagnostics – Status Tab

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

42

Connection tab

View the network devices connected to KDS-17EN.

To view Connections status:

1. In the Diagnostics pane, click Connection.

2. Select the Connections tab.

Kramer Electronics Ltd.

Figure 32: Diagnostics – Connection Tab

3. UCP devices that end the connection will be displayed for 10 minutes after the
connection ends.

Connections’ status is viewed.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

43

Advanced tab

Activate logging, view and download the log and see a counter of the gateway messages.

The Gateway Messages Counter keeps a count of CEC, IR and RS-232 commands
(messages) sent or received.

To view the log and message counter:

1. In the Diagnostics pane, click Advanced.

2. Syslog: Set Active Syslog to On, to activate logging.

Figure 33: [Figure Caption]

3. Active Syslog Server: Set to On if you use a centralized log server or want to analyze
the log messages. You will need to add the Log Server Address.

4. Click VIEW to view the system log (must be active).

5. Click EXPORT to export the system log (in .txt format) to the local PC.

6. Click Save to confirm any changes.

System log and counters are viewed.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

44

About

View the device model, hardware release, firmware version and Kramer Electronics Ltd
details.

Figure 34: About Page

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17EN Embedded Web Pages

45

Click

If the device firmware version is lower than 0.6.3, contact Kramer tech support team at

[e-mail]

http://www.kramerav.com/downloads/KDS

Upgrading Firmware

Upgrade the firmware, view the date of the last upgrade, or rollback to the previous firmware
revision in case of a problem.

ROLLBACK to update to the previous FW version.

To upgrade the firmware:

1. In the Navigation pane, Select Device Settings. The General tab in the Device Settings
page appears.

or go to our Web site at

-17EN

Figure 35: General Tab – Upgrading the Firmware

2. Next to Firmware Version, click Update. The Open window appears.

3. Select the FW file and click Open. The FW upgrade pop-up window appears. Wait for
upgrade completion.

4. Once completed, refresh the web page and log-in.

Firmware upgrade is complete.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

46

You can also configure

Commands

If a web page does not update correctly, clear your Web browser’s cache.

Some features might not be

Using KDS-17DEC Embedded Web Pages

KDS-17DEC via Protocol 3000 commands (see Protocol 3000

For instructions on how to connect to the encoder and load the web pages, see Accessing the

Embedded Web Pages on page 19.

To Browse the KDS-17DEC Web Pages

1. Open your Internet browser.

on page 83).

available in some mobile device operating systems.

2. Type the IP number of the device in the Address bar of your

browser. For example, the default IP number:

If Device Security is enabled, the Login window appears.

3. If required, enter the login password (“admin”, by default).
The KDS-17DEC page appears.

Figure 36: Login Window

Figure 37: Embedded Web Page with Navigation List on Left

4. Click the tabs on the left side of the screen to access the relevant web page.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

47

Dashboard: Overview of Streaming

The KDS-17DEC Dashboard shows an overview of AV streaming and audio information. Use
the dashboard to set the streaming channel, input source and audio parameters.

Figure 38: KDS-DEC Dashboard pane

AV Streaming: Set the streaming channel

1. In the Dashboard pane, activate

AV Streaming.

2. Input Selection – Chose between

Network(default) and HDMI.

3. Channel ID - If the input is network,
the Channel ID must be identical to
the channel entered on the
encoder. Click the Refresh arrows

and the device will automatically

detect the stream and enter its
channel ID.

4. Additional non-editable fields are
displayed to describe the input AV:

• Input Signal – Source of the
input video.

• Aspect Ratio – Aspect ratio of
the input video.

• Video Details – Input video’s
resolution.

• HDCP Encryption – HDCP status (High-bandwidth Digital Content Protection, used to
protect copyrighted material).

• Audio Channels – Number of channels in audio input.

• Audio Sample Rate – Input audio signal’s sample frequency (number of samples per

second).

• Audio Format – LPCM is uncompressed, other types of digital format are usually
compressed.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

48

5. Click the green check to confirm your changes (greyed out if no change is made).

Previewing the AV Stream:

In the Dashboard pane, activate AV Streaming Preview, the

input stream will be displayed in this area.

The AV Streaming Preview aspect ratio, FPS and bandwidth

can be changed in AV Settings > Video (see Preview).

Audio OUT: Set the audio output

1. In the Dashboard pane’s Audio Out field group, choose how KDS-17DEC outputs the
audio.

Kramer Electronics Ltd.

Figure 39: Dashboard: Audio Routing Options

2. If audio input is in Dante format (Digital Audio Network Through Ethernet), set Routing
to Play Audio from Dante.

3. I

f audio output is an audio stream in Dante format, set Audio Streaming Dante OUT to

On.

 For more information on Dante audio, see Defining Dante Audio as an Audio Source

or Destination on page 76.

4. If Audio output is Analog (using the AUDIO OUT 5-pin Terminal Block Connector) set
the volume slider. Values are in %, maximum output is 12dB. The volume slider only
affects the (analog) AUDIO OUT 5-pin Terminal Block Connector (11 in

Defining

KDS-17DEC on page 8). Mute affects HDMI Out and Analog out.

Figure 40: Dashboard: Analog Audio OUT

Additional audio settings can be configured in AV Settings > Audio.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

49

AV Settings: Video, OSD, KVM, Video Wall & Overlay

Define KDS-17DEC output AV stream settings. There are five tabs:

1. Video tab

.

2. OSD tab – On Screen Display menu.

3. KVM / USB tab – External Keyboard, Video and Monitor.

4. Video Wall tab – Grid Video Wall / Mosaic Video Wall.

5. Overlay tab – Overlay an image, text or KVM.

Video tab – Format video output

The Video tab sets 8 features, mostly related to video output. Click Save after making
changes.

1. HDMI Input

 HDCP Appearance – Use this if you are using the decoder’s HDMI IN port and

your media source employs HDCP copyright protection. On by default.

2. HDMI Output

 HDCP Method - Decide how system should handle copyright protection

(encryption).

 Output Resolution – Passthrough (default): Use the resolution of the input

video. Native: Set according to the output EDID (see

Metadata on page 29). Alternatively, select an output resolution.

 Device color depth – Follow Output: Set according to the output display. Force 8

bit: Force output into 8-bit format.

 Force RGB on Output – Force video output to separate red, green and blue

colors. Required by some monitors.

Figure 41: AV Settings > Video – HDMI Input

EDID: Setting Display

Figure 42: AV Settings > Video – HDMI Output

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

50

3. OSD & Overlay Transparency (%)

 Use the slider to set the transparency of the OSD & Overlay texts, KVM Overlay

and Overlay image. Default setting: 50%

Figure 43: AV Settings > Video – OSD & Overlay Transparency

4. Display: Set the number of seconds the device should wait before sleep / shutdown /
Wake-up takes place in the event of video signal loss.

Figure 44: AV Settings > Video – Display (sleep options)

5. IP Casting Mode:

 Unicast / Multicast – Multicast communication transmits the data stream to

multiple receivers simultaneously, select unicast if your stream is intended for a
single receiver.

 Multicast Prefix – Select a prefix for the multicast stream’s IP between 224 and

239 (prefix as in 224.x.x.x). IP prefixes are used by routers to identify the
stream’s packets as data which is not directed to a specific recipient, but a
general stream addressed to the entire network.

 TTL - Time To Live (TTL) restricts the number of times a packet/data can be

forwarded by network routers before it is discarded. It stops the stream data from
circulating endlessly in the network. Select a value between 1 and 65535.

Figure 45: Video - IP Casting Mode

6. Preview: Set the parameters of the Dashboard stream preview window.

 Width – 1 to 1280 / Height – 1 to 720 / FPS- 1 to 60 / Bandwidth – 1 to 50,000.

Default settings: Width 960, Height 540 and FPS 15.

7. Sleep Image: Enable and upload an image to display when the output “sleeps”. On by
default (will display “No source” message if no image is uploaded).

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

51

8. Switching Mode: Set the handling of video inputs. Video can arrive from the HDMI IN
port (locally) or from the stream (remotely from the encoder). Options:

 Manual – Only output video to the current active output connection.

 Last Connected – Only output video to the last used output connection.

 Priority - Dynamically switch according to the defined priority (manually drag the

sources to set the priority). If no audio input is detected on the top priority, the
system will switch to the next priority.
Before switching, the device waits for an audio signal to be detected. The amount
of time it waits is set in the signal loss/detection and cable plug/unplug
parameters (to allow time to detect video input).

9. Click SAVE.

Figure 46: Video output switching mode

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

52

OSD tab – On Screen Display menu

The OSD menu displays an insert on the output display with a

list of the encoders streaming channels to KDS-17DEC

can select a channel from the on-screen menu.

Note: OSD menu transparency is set in the Video tab.

• Menu Settings – Use these settings to configure the on-screen display menu:

Kramer Electronics Ltd.

. Users

Figure 47: OSD menu

• Menu Timeout (length of time the menu is displayed), Text Color, Background color,
Hot Key (the key that opens the menu), Menu Font Size and Menu Position.

• Device Information – The device displays its MAC, IP and the firmware date and
version number in the corner of the screen for a limited number of minutes. Set the
display time (the timeout) or force it to be displayed permanently. Click Display Now to
force it onto the screen.

• Channel List – The list of encoder streams that can be selected.

Figure 48: KDS-17DEC Adding the encoder Channel ID and Name

OSD Keyboard Button Functions:

• Caps Lock: Double tap to open the OSD menu.

• Up/Down (or PgUp/PgDn): Move up/down to the next option.

• Input any word in the Filter textbox: Access to the desired option quickly.

• Enter: Make the selection. After Enter is typed, the OSD menu closes.

• ESC: Exit the OSD menu.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

53

To define and use the OSD menu

1. Open the decoder webpages. The decoder must output to the display on which the OSD
should be displayed.

2. In AV Settings > OSD, add the encoder channel ID and name to the channel list.

Kramer Electronics Ltd.

Figure 49: KDS-17DEC Adding the encoder Channel ID and Name

3. Connect a USB keyboard to the USB-A port of the decoder.

4. On the connected keyboard, double click the Caps Lock.
The OSD Channel Select page OSD appears, listing 10 channel IDs per page.

5. To operate the OSD, use the Keyboard as follows:

 Press Caps Lock twice to open the OSD.

 Press Up/Down (or PgUp/PgDn) to move up/down to the next item.

 Type a menu feature next to Filter (in the OSD) to access a function quickly.

 Press Enter to accept a selection and exit the OSD menu.

 Pres Esc to exit the menu.

OSD menu is accessed.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

54

KVM / USB tab – External Keyboard, Video and Monitor

A KVM or USB keyboard and mouse can be connected to KDS-17DEC and used to control
the stream. The encoder will pass a “USB token” which determines which decoder can be
used for the keyboard.

KVM Roaming allows for interaction with multiple hosts over USB from one master

KDS-17DEC decoder connected to a keyboard and mouse, see the example layout below:

Figure 50: KVM Roaming Layout

Figure 51: AV Settings – KVM / USB

 Optimized for KVM – Enable KVM use and settings. Off allows the USB to be used

for input such as keyboard and mouse or storage (not for webcams), On means that
the USB is allocated to KVM use.

 Request Timeout – The amount of time, from receipt of the USB token, within which

KVM services must be provided. If the KVM is not active within this time, the encoder
will try a different decoder. Default setting is 10 seconds.

 Roaming Master – Only available in Multicast mode (set in Av Settings > Video)

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

55

with Optimized for KVM enabled. When On, this device can control which decoder
will provide the KVM. Enter rows and columns to view additional decoders (enter the
decoders MAC address to add it). If this device is set as the “Master”, other
connected decoders are shown as “slaves”.

Configuring KVM Roaming

To configure KVM roaming:

1. Open the encoder and decoder web pages.

2. For each encoder (KDS-

17EN) Dashboard, set a

unique Channel ID (in the
Dashboard) and a unique
Device Name in Device
Settings > General.

Kramer Electronics Ltd.

Figure 52: KDS-17EN Setting Channel ID

3. In each decoder

(

KDS-17DEC)

Dashboard, pair the

decoder to an encoder.

For example, pair
ENC 1 to DEC 1,
ENC 2 to DEC 2,
ENC 3 to DEC 3 and
ENC 4 to DEC 4.

4. For the Decoder that has

the keyboard and mouse
connected, open the AV
Settings > KVM / USB
page.

Figure 53: KDS-17DEC Setting Channel ID and Name

Figure 54: Defining the Master Decoder for KVM Roaming

5. Set the Decoder as “Master”. The decoder configuration setup appears.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

56

6. Set the row and column numbers as they are set physically.
For example, if the decoder setup is a 2x2 video wall, set Row to 2 and Column to 2.

Figure 55: Setting the Decoder Configuration

7. Check the physical location of the Master decoder (lower left size in this example).
The MAC address is automatically entered.

8. Manually enter the other (slave) decoder MAC addresses according to the physical
setup.

9. Click Save.

KVM Roaming is configured.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

57

Video Wall tab – Grid Video Wall / Mosaic Video Wall

Video walls are an array of displays showing a single image. KDS-17DEC supports two types
of video wall: Mosaic and Grid. KDS-17DEC can output a section of the AV stream according
to its position in the video wall.

Grids are evenly arranged video walls. Mosaic video walls allow displays to be set at different
angles. This type of video wall requires a connection to Kramer’s KDS-7-MNGR device, for
more information on this type of video wall, see the KDS-7MNGR user manual.

 Video Wall Mode – Select Video Wall Mode or Mosaic Video Wall (only available if

KDS-7MNGR is connected).

 Vertical Count / Horizontal Count – The number of displays in the video wall array.

 Device Relative Position – Highlight the square corresponding to this decoder’s

position in the array.

 Stretch Type – Fit In or Stretch Out.

 Fit in stretches the video’s aspect ratio to fit the screen (if required).

 Stretch Out makes no change to the aspect ratio and may leave areas of video

outside the screen.

 Video Rotation – Rotate or mirror (reverse) the video output image.

Figure 56: AV Settings – Video Wall

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

58

Bezel Compensation

Bezel compensation sets a gap between the sections of the output image to correspond to
gaps in the physical video wall. Units are in 0.1mm.

o Viewable Width = VW
o Outside width = OW
o Viewable Height = VH
o Outside Height = OH

 Video Wall Test – Enable to output a test image to the display.

Figure 57: AV Settings – Video Wall, Bezel Compensation

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

59

Overlay tab – Overlay an image, text or KVM

Use overlay to display images or text on the screen at the start (or for the entire duration) of a
stream.

Note: Overlay transparency is set in the Video tab.

Overlay time (min)

Sets the length of time that the overlay is displayed. If timeout is 0, the test or image are
permanently displayed.

Image Overlay

 Image – Upload an image. The image must be PNG, maximum size 640 x 360

maximum size 256KB.

 Align – Set the image position.

Text Overlay

 Text – Enter the text to display.

 Size - Small, medium or large.

 Align – Set the image position on the screen.

 Text Color – Set the text color.

Figure 58: Av Settings - Overlay

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

60

When an HDMI OUT screen is connected, the screen shows the device’s IP.

Device Settings: General, Network and Time Settings

The KDS-17DEC Device pane has three tabs:

 General – Sets the device’s host name, updates firmware, restarts or resets the

device. You can also export or input device settings.

 Network – Set the LAN 1 and LAN 2 parameters for the device.

 Date & Time – Define an NTP (network time protocol) server or set the time. An NTP

server is advisable, as it coordinates the time between all the connected devices.

General tab

Figure 59: Device pane – General tab

• Device name – Edit or view the device’s Host name.

• Model Name of the decoder.

• Serial Number of the decoder.

• Firmware Version – To update the decoder firmware, download the latest version from

http://www.kramerav.com/downloads/kds-17dec

to a local network location and then

click Update to select and upload it.

• Front Panel Lock – Enabling this option prevents use of the LCD Display.

• Device Restart – Click to restart KDS-17DEC (confirmation will be requested).

• Factory Reset - Click to reset the device's operation mode and restart the device

(confirmation is requested).

• Find Me – The LEDs will flash fast for 60 seconds to identify the decoder.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

61

• Device Configuration –

 Export Device Settings – Output a settings file “file.tar.gz”. Settings are stored in

JSON format.

 Import Device Settings – Import a settings file in the same format as the output file.

The device will be reset to the uploaded settings.

Network tab: Using LAN 1 and LAN 2 for different streams

KDS-17DEC has two Ethernet ports, LAN 1 and LAN 2 (see 24 and 25 in Defining

KDS-17DEC on page 8). By default, all network connections use both ports, however you

can separate the types of stream sent to/from each port and give each port a separate IP
address. For example, use one port for AV and the other for control commands such as P3K
(P3000 API) commands.

Figure 60: KDS-17DEC - Device Settings pane – Network Tab

• Ethernet Bridge Mode – Enable if you are using separate IP addresses for LAN 1 and
LAN 2 and want to allow additional data streams to access LAN 2.

o Bridge Port – Must be set to LAN 2.

o VLAN ID – Ethernet data tagged with the VLAN ID will be allowed to reach LAN 2.

• Service Name – Stream is for the AV stream. Control is for PK3000 commands, RS-232
or IR data. Dante (Digital Audio Network Through Ethernet) is for transmitting high-quality
digital audio over Ethernet. Dante uses LAN 2.

• Port – LAN 1 or LAN 2. The Ethernet port used by the service.

• 802.1Q – If set to On (off by default), the data transmission uses VLAN tags.

o VLAN Tag – VLAN (virtual local area network) tags (range 2 – 4000) are used to

separate the network into smaller virtual networks. Requires 802.1Q to be set to
On.

• DHCP – If set to On, the service’s IP address is generated automatically. If set Off, you

may need to define a static IP address for the service.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

62

802.1Q and VLAN are not required for the Media port.

In this screen, Dante is also used for AES67 streams.

For more information

on

802.1Q and VLAN are not required for

To separate Control streams from AV streams

1. Change the following settings in the IP Address Settings section of the Network tab
(see Figure 20

):

 In the Control row’s Port column select LAN 2 and set 802.1Q to On.

 In the VLAN Tag column, enter an integer number (2 - 4093) for Control services.

This separates the Control packets.

2. To use a static IP for LAN 2, set DHCP to Off and enter a subnet mask and gateway
address. If no static IP is defined, the DHCP server will allocate the IP.

If no DHCP server exists in the system, the device will look for a random unique IP in the
range of 169.254.X.Y. The allocated IP address

To separate Dante/AES67 Audio from the AV streams:

Kramer Electronics Ltd.

is shown in the IP address field.

, see Defining Dante Audio as an Audio Source or Destination

page 76.

1. To export Dante audio from the decoder, you must first go to the KDS-17DEC
Dashboard pane and set the Audio Streaming Dante OUT to On (see

Audio OUT:

Set the audio output on page 48).

2. To import Dante audio from the encoder, you must first go to the KDS-17DEC
Dashboard pane and set the Routing to Play Audio from Dante (see

Audio OUT:

Set the audio output on page 48).

3. In the KDS-17DEC Device Settings pane, open the Network tab.

In the IP Address Settings, set the Dante row’s Port column to LAN 2 and set

802.1Q to On.
In the VLAN ID column, enter an integer number (2 - 4093) for Dante services.
Make sure this is different from the number used for the Control packets.

LAN 1.

4. To use a static IP for LAN 2, set DHCP to Off and enter a subnet mask and gateway
address. If no static IP is defined, the DHCP server will allocate the IP.

Dante audio output is now defined.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

63

Time & Date tab

To sync device time and date from a network time server:

1. In the Device pane, select the Date & Time tab.

2. Set the Time zone.

3. Set Use Time Server (NTP), to On.

4. Enter the Time Server Address IP.

5. Click SAVE.

The devices date and time are synchronized to the server address entered.

Kramer Electronics Ltd.

Figure 61: Device Settings pane – Time & Date tab

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

64

Password protection of the web pages is only active when the Security Status is On (the
default state). The default password is

If you change the password, the new password must include a number, a special
character and both upper and lower case letters (no commas or spaces).

Security: Passwords, HTTPS and 802.1X

“admin”.

The KDS-17DEC Security pane has three tabs:

 Device Security – Enable/disable security and change the device password.

 HTTPS – Use the device’s internal certificate or upload a local certificate.

 802.1X- Enable and setup IEEE 802.1X authentication.

 AES256 – Set the level of AES256 encryption.

Device Security tab: Enable Password Control

Kramer Electronics Ltd.

Figure 62: Security pane – Device Security tab

To change Security Status

When security is enabled, access to the web

pages requires entry of a password.

Changes to the security status require entry of

the device’s current password (default: “admin”).

To change the password

Password protection is only available if the
Security Status is On. To change the
password, enter the Current Password and
then click Change.

The new password must include a number, a
special character and both upper and lower
case letters (no commas or spaces).

Figure 63: Security pane – pop-up

Figure 64: Security pane – Change password

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

65

HTTPS tab

To configure HTTPS:

1. In the Security pane’s Device Security tab, Security Status must be enabled.

2. Select the HTTPS tab.

3. Enable HTTPS STATUS and select one of the following authentication methods:

 Internal Certificate – Use the factory default certificate for authentication.

 Server Certificate – Submit a certificate from the server for authentication (assigned

by your network administrator). Click to upload the certificate. Enter the private
key password.

Kramer Electronics Ltd.

4. Click SAVE.

HTTPS is configured.

Figure 65: Security Tab – Server Certificate

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

66

802.1X tab

802.1X authentication must be defined separately for LAN 1 and LAN 2. 802.1X is a port­based authentication protocol, that uses a RADIUS network access server to authenticate
devices accessing the network. It must be configured separately for LAN 1 and LAN 2.

To configure IEEE 802.1X Authentication:

1. In the Security pane, select the 802.1X tab.

LAN 1 / LAN 2 - LAN 2 has identical settings and is at the bottom of the screen. Enable and

configure LAN 1 and LAN 2 separately.

2. Set 802.1x authentication ON.

3. Authentication Status:

 Green – LAN is using 802.1X and authentication has succeeded.
 Orange – LAN is using 802.1X and authentication is in process.
 Red – LAN is using 802.1X but authentication has failed.
 Grey – 802.1X is disabled.

4. Check one of the following settings:

 EAP-MSCHAP V2 – To use this authentication method, enter the KDS-17DEC

username and password.

 EAP-TLS – Submit a certificate from your network authentication server. To do so,

enter the KDS-17DEC Username (“admin”) and click to upload the Client
Certificate and Private Key. Enter the Private Key Password (assigned by your
network administrator).

5. Server Certificate – (optional) Use a CA (certification authority) issued certificate to
authenticate the RADIUS server. Enable and click to upload the CA certificate.

Figure 66: EAP-TLS – Certificates and Password

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

67

6. Repeat for LAN 2 if necessary.

7. Click SAVE: 802.1X is configured.

AES256 tab

When Device Security is enabled, AES256 encryption is used to encrypt packet headers, Use
AES256 Full to encrypt the whole packet. By default, a system key is used for encryption and
decryption. If you want to enter a custom key, key make sure both encoder and decoders are
updated to use the same key.

Figure 67: Security pane – AES256 tab

AES256 Mode: Standard or Full.

• Standard encrypts the packet headers into blocks of 128 bits each.

• Full encrypts the entire packet and requires that Jumbo Frames are enabled on the switch,

so that the transmitted IP packet is not larger than the maximum Ethernet frame.

AES KEY: Default or customized.

• Default uses 14 rounds of processing to create a device defined 256 bit key.

• Customized requires you to enter a 32 byte hexadecimal string (64 characters using only

the characters 0 – 9 and A to F). No hex code identifier is required before the string.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

68

Gateway: CEC, RS-232 and IR definitions

The KDS-17DEC Gateway pane has three tabs:

 CEC – Enable and setup the direction of CEC commands.

 RS-232 – Enable and configure RS-232 communication.

 IR- Setup direction of pass-through IR (infrared) controls.

CEC tab: Configuring CEC commands

CEC (Consumer Electronics Control) commands are sent from an HDMI device to the devices
connected to it and enable a single HDMI device to control its connected environment.

KDS-17DEC can receive CEC commands over LAN from the encoder and send them on to

the CEC enabled device that is connected to its HDMI output.

To set CEC Gateway:

1. In the Gateway pane, click CEC.

Figure 68: Control > Settings Page – CEC Settings

2. Enable the CEC gateway.

3. Select the HDMI port to which CEC commands are sent:

 HDMI Input (HDMI IN).

 HDMI Output (HDMI OUT).

4. Click refresh , to see the address of the CEC device that is attached to the HDMI
port.

5. Enter the CEC command in hexadecimal format.

6. Click SEND.

7. View the CEC-enabled device response in the CEC Notifications field.

CEC Gateway is configured.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

69

RS-232 tab

KDS-17DEC can receive RS-232 commands sent to a remotely connected decoder’s RS-232

port. These commands can be used to remotely control KDS-17DEC.

To set RS-232 Gateway:

1. In the Gateway pane, click the RS-232 tab.

Figure 69: Gateway > RS-232

2. Click Enable to enable RS-232 gateway or click Disable.

3. Define the RS-232 gateway port (5001, by default).

4. Enter the Baud Rate: 1200 to 115200 (default).

5. Enter the Data Bits: 5, 6, 7 or 8 (default).

6. Enter Parity: None (default), Odd or Even.

7. Enter Stop Bits: 1 (default) or 2.

8. Click SAVE.

RS-232 Gateway is configured.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

70

IR tab

KDS-17DEC can send or receive IR commands over LAN, to or from the connected encoder.

The IR signals can be used to control a relevant device. The IR direction should be the
opposite of that specified on the encoder.

To set RS-232 Gateway:

1. In the Gateway pane, select the IR tab.

Figure 70: Control > Settings Page – IR Settings

2. Set IR direction:

 IN – Configure the IR port as an input port that is connected to an IR receiver cable.

 OUT – Configure the IR port as an output port that is connected to an IR emitter

cable.

IR Gateway is configured.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

71

Diagnostics: Status, Connections and Logging

The KDS-17DEC Diagnostics pane has three tabs:

 STATUS – View the device’s activity state, temperature, and output ports.

 CONNECTION – View the device’s active network connections.

 ADVANCED – Activate, view and export the system log.

Status tab

1. In the Diagnostics pane, click Status.

2. Device Status:

 Active, for normal operation (green indication).

 Standby, when device is powered off, booting or in standby mode.

3. Heat Level:

 Normal, for temperatures under 45°C.

 High, for temperatures between 45°C and 60°C.

 Overheat, for temperatures higher than 60°C.

4. View the status of the outputs:

 HDMI OUT - On, the output channel is transmitting an active signal.

Device status is viewed.

Figure 71: Diagnostics – Status Tab

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

72

Connection tab

View the network device’s connected to the device.

To view Connections status:

1. In the Diagnostics pane, click Connection.

2. Select the Connections tab.

Kramer Electronics Ltd.

Figure 72: Diagnostics – Connection Tab

3. UCP devices that end the connection will be displayed for 10 minutes after the
connection ends.

Connections’ status is viewed.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

73

Advanced tab

Activate logging, view and download the log and see a counter of the gateway messages.

The Gateway Messages Counter keeps a count of CEC, IR and RS-232 commands
(messages) sent or received.

To view the log and message counter:

1. In the Diagnostics pane, click Advanced.

2. Syslog: Set Active Syslog to On, to activate logging.

Figure 73: [Figure Caption]

3. Active Syslog Server: Set to On if you use a centralized log server or want to analyze
the log messages. You will need to add the Log Server Address.

4. Click VIEW to view the system log (must be active).

5. Click EXPORT to export the system log (in .txt format) to the local PC.

6. Click Save to confirm any changes.

System log and counters are viewed.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

74

About

View the device model, hardware release, firmware version and Kramer Electronics Ltd
details.

Figure 74: About Page

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Using KDS-17DEC Embedded Web Pages

75

Click

If the device firmware version is lower than 0.6.3, contact Kramer tech support team at

[e-mail]

http://www.kramerav.com/downloads/kds

Upgrading Firmware

Upgrade the firmware, view the date of the last upgrade, or rollback to the previous firmware
revision in case of a problem.

ROLLBACK to update to the previous FW version.

To upgrade the firmware:

1. In the Navigation pane, Select Device Settings. The General tab in the Device Settings
page appears.

or go to our Web site at

-17dec

Figure 75: General Tab – Upgrading the Firmware

2. Next to Firmware Version, click Update. The Open window appears.

3. Select the FW file and click Open. The FW upgrade pop-up window appears. Wait for
upgrade completion.

4. Once completed, refresh the web page and log-in.

Firmware upgrade is complete.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Defining Dante Audio as an Audio Source or Destination

76

Defining Dante Audio as an Audio Source or Destination

Dante is a professional audio over Ethernet technology and is designed for transmission of
multiple audio channels over relatively long distances or to many locations.

Defining Dante input to the KDS-17EN encoder

KDS-17EN can import a Dante audio stream and output it to the decoder.

1. In the KDS-17EN webpages, open the KDS-17EN Dashboard pane.

2. In the Device Audio Routing field group, set the relevant INPUTS to Dante
(see Dashboard: Overview of Streaming on page 24

3. Open the KDS-17EN Device Settings pane and select the NETWORK tab.

).

4. In the NETWORK tab’s IP Address Settings field group, find the Dante row and set the
relevant settings (see To separate Dante/AES67 Audio from the AV streams: on page 32).

Defining Dante output from the KDS-17DEC decoder

KDS-17DEC can import a Dante audio stream and output it in another format or output audio
as a Dante audio stream.

1. In the KDS-17DEC webpages, open the KDS-17DEC Dashboard pane:

a. To import Dante audio, in Audio OUT, set Routing to play audio from Dante

(see Dashboard: Overview of Streaming on page 24

b. To export Dante audio, in Audio OUT, set Audio Streaming Dante OUT to On.

2. Open the KDS-17DEC Device Settings pane and select the NETWORK tab.

3. In the NETWORK tab’s IP Address Settings field group, find the Dante row and set the
relevant settings: see To separate Dante/AES67 Audio from the AV streams: on page 62.

).

Using Dante Software

To input or output Dante audio with KDS-17EN or KDS-17DEC:

1. Download and install Dante Controller software from

https://my.audinate.com/support/downloads/dante-controller

2. Open Dante Controller software on a laptop connected to the same LAN switch as

KDS-17EN.

Dante Controller opens in Network View with the Routing tab open and lists the Dante
enabled devices it has detected on the network. Receivers are shown on the left and
transmitters on the top.

.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Defining Dante Audio as an Audio Source or Destination

77

 To connect a unicast flow (stream) between a transmitter and receiver click on the

intersection between them.

 To create a multicast flow:

a. Open the Device Info tab.

b. Double click the KDS-17EN/KDS-17DEC device to open the Device View screen.

Figure 76: Dante Controller screen (section)

c. If using AES67, click the AES67 Config tab and enable AES67 Mode; You will be

prompted to reboot (restart) Dante Controller (repeat steps a and b after restarting).

Figure 77: Device View screen - AES67 Config tab

d. Select the Receive tab and click the Flow icon to create an audio flow (stream).

Figure 78: Device View screen – Flow icon

e. The Create Multicast Flow dialog box opens. Select the flow type (Dante or

AES67), the channels and press the Create button.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Defining Dante Audio as an Audio Source or Destination

78

Figure 79: Device View screen – Create Multicast Flow box

f. An RTP multicast flow is created and will be visible in Transmit tab.

Figure 80: Device View screen – RTP Multicast Flow in the Transmit tab

g. Use the Dante Controller software to route the audio between the encoder/decoder

and the Dante source or destination.

Dante has been defined.

KDS-17EN / KDS-17DEC – Technical Specifications

79

Inputs

1 HDMI

On a female HDMI connector

Outputs

1 HDMI

On a female HDMI connector

Ports

1 Ethernet

On an RJ-45 connector

1 Ethernet

On an SFP optical/copper transceiver port

1 Balanced Audio

On a 5-pin terminal block connector

1 RS-232

On a 3-pin terminal block connector

1 IR

On a 3.5mm TRS connector

USB

1 USB-B Host

Connecting USB 3.0 PC/laptop

2 USB-A Devices

Connecting USB 3.0 local devices

1 Level USB Hub

When connecting to KDS-17DEC

Network

Multicast

Through RTSP (Real Time Streaming Protocol): IGMP snooping non­blocking, Layer 2

Unicast

Through RTSP (Real Time Streaming Protocol)

Bitrate

Peak: 850Mbps, 4K average: 350Mbps, 1080p average: 250Mbps

Video

Compression
Standard

JPEG2K-Like, private stream
Max Resolution

4K@60Hz (4:4:4)

HDR 10

Up to 4K30 4:2:2 12 bit

HDCP

1.4 and 2.2 supported

EDID

Passthrough, output resolution, predefined default EDID, or custom EDID

Resolution

4096x2160@60Hz

1600x1200@60Hz

1280x960@60Hz

1024x768@60Hz

848x480@60Hz

Audio

Supported

LPCM

Up to 7.1/24-bit/192kHz

6.1, DTS Digital Surround 5.1

Security

HTTPS, 802.1x, OWASP-10, AV Streaming: AES256 encryption

User Interface

Indicators

LINK, NET and ON LEDs, front panel LCD Display

Rear Panel

Restart and factory reset button

front panel navigation buttons

Power

PoE+

37V to 57V, max power 15W

Optional Power Supply

20V DC, 6A

Environmental

Operating Temperature

0° to +45°C (32° to 113°F)

Storage Temperature

-20° to +70°C (-4° to 158°F)

Humidity

10% to 90%, RHL non-condensing

Regulatory
Safety

CE, FCC

Environmental

RoHs, WEEE, UKCA

Enclosure

Size

Mega Tool Deep

Type

Aluminum

Cooling

Convection Ventilation

Dimensions
Net Dimensions (W, D, H)

18.9cm x 14.5cm x 2.76cm (7.44" x 5.71" x 1.09")

Shipping Dimensions (W, D, H)

31.2cm x 17.9cm x 7.6cm (12.28" x 7.05" x 2.99")

Weight
Net Weight

0.7kg (1.54lbs) approx.

Shipping Weight

0.9kg (2lbs) approx.

Specifications are subject to change without notice at www.kramerav.com

Technical Specifications

KDS-17EN Specifications

Kramer Electronics Ltd.

Conditions

Compliance

3840x2160@60Hz
1920x1200@50Hz
1920x1080@60Hz
1856x1392@60Hz
1792x1344@60Hz
1680x1050@60Hz

Formats

Controls Embedded web pages, P3K API commands via Ethernet,

Dolby

DTS

1600x900@60Hz
1440x900@60Hz
1400x1050@60Hz
1366x768@60Hz
1360x768@60Hz

Dolby AtmosTM, Dolby TrueHD, Dolby Digital PlusTM, Dolby Digital EX,
Dolby Digital 5.1, Dolby Digital 2/0 Surround, Dolby Digital 2/0
DTS-HD Master AudioTM, DTS-HD, DTS-ES Discrete 6.1, DTS-ES Matrix

1280x800@60Hz
1280x768@60Hz
1280x720@60Hz
1224x768@70Hz
1152x864@70Hz

800x600@60Hz
720x576@60Hz
720x480@50Hz
640x480@60Hz
640x400@85Hz
640x350@85Hz

KDS-17EN / KDS-17DEC – Technical Specifications

80

Inputs

1 HDMI

On a female HDMI connector

Outputs

1 HDMI

On a female HDMI connector

1 Ethernet

On an RJ-45 connector

1 Ethernet

On an SFP optical/copper transceiver port

1 Balanced Audio

On a 5-pin terminal block connector

1 RS-232

On a 3-pin terminal block connector

1 IR

On a 3.5mm TRS connector

USB

1 USB-B Host

Connecting USB 3.0 PC/Laptop

2 USB-A Devices

Connecting USB 3.0 local devices

1 Level USB Hub

When connecting to KDS-17EN

Network

Multicast

Through RTSP (Real Time Streaming Protocol): IGMP
snooping non–blocking, Layer 2

Unicast

Through RTSP (Real Time Streaming Protocol)

Bitrate

Peak: 850Mbps, 4K average: 350Mbps, 1080p average:
250Mbps

Video

Compression Standard

JPEG2K-Like, private stream

Max Resolution

4K@60Hz (4:4:4)

HDR 10

Up to 4K30 4:2:2 12 bit

HDCP

1.4 and 2.2 supported

EDID

Passthrough, output resolution, predefined default EDID, or
custom EDID

Resolution

4096x2160@60Hz,

1680x1050@60Hz,

1600x1200@60Hz,

1280x960@60Hz,

1024x768@60Hz,

848x480@60Hz,

640x350@85Hz

Audio

Supported Formats

LPCM up to 7.1/24-bit/192kHz

DTS-ES Matrix 6.1, DTS Digital Surround 5.1

Security

HTTPS, 802.1x, OWASP-10, AV Streaming: AES256 encryption

User Interface
Indicators

LINK, NET and ON LEDs, front panel LCD Display

Rear Panel

Restart and factory reset button

front panel navigation buttons

Power
PoE+

37V to 57V, maximum power 15W

Optional power supply

20V DC, 6A

Environmental

Operating Temperature

0° to +45°C (32° to 113°F)

Storage Temperature

-20° to +70°C (-4° to 158°F)

Humidity

10% to 90%, RHL non-condensing

Regulatory
Safety

CE, FCC

Environmental

RoHs, WEEE

Enclosure

Size

Mega Tool Deep

Type

Aluminum

Cooling

Convection Ventilation

Dimensions
Net Dimensions (W, D, H)

18.9cm x 14.5cm x 2.76cm (7.44" x 5.71" x 1.09")

Shipping Dimensions (W, D, H)

31.2cm x 17.9cm x 7.6cm (12.28" x 7.05" x 2.99")

Weight
Net Weight

0.7kg (1.54lbs) approx.

Shipping Weight

0.9kg (2lbs) approx.

Specifications are subject to change without notice at www.kramerav.com

KDS-17DEC Specifications

Ports

Kramer Electronics Ltd.

3840x2160@60Hz,
1920x1200@50Hz,
1920x1080@60Hz,
1856x1392@60Hz,
1792x1344@60Hz,

Controls Embedded web pages, P3K API commands via Ethernet,

Conditions

Compliance

1600x900@60Hz,
1440x900@60Hz,
1400x1050@60Hz,
1366x768@60Hz,
1360x768@60Hz,

Dolby AtmosTM, Dolby TrueHD, Dolby Digital PlusTM, Dolby
Digital EX, Dolby Digital 5.1, Dolby Digital 2/0 Surround,
Dolby Digital 2/0
DTS-HD Master AudioTM, DTS-HD, DTS-ES Discrete 6.1,

1280x800@60Hz,
1280x768@60Hz,
1280x720@60Hz,
1224x768@70Hz,
1152x864@70Hz,

800x600@60Hz,
720x576@60Hz,
720x480@50Hz,
640x480@60Hz,
640x400@85Hz,

KDS-17EN / KDS-17DEC – Technical Specifications

81

P3K

Example (stop encoder decoder activity)

#KDS-ACTION 0<CR>

Ethernet

To reset the IP settings to the factory reset values go to: Menu->Setup -> Factory Reset-> press Enter to
confirm

KDS-17EN

KDS-17DEC

DHCP

Default

Default

IP Address:

192.168.1.39

192.168.1.40

Subnet mask:

255.255.255.0

255.255.255.0

Default gateway:

192.168.1.254

192.168.1.254

TCP Port #:

5000

5000

UDP Port #:

50000

50000

Default username:

admin

admin

Default password:

admin

admin

Full Factory Reset

Embedded web pages

Device Settings > General > RESET

Front panel buttons

Press the RESET button on the rear panel for 10 seconds

Default Communication Parameters

Kramer Electronics Ltd.

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

82

Prefix

Command Name

Constant (Space)

Parameter(s)

Suffix

#

Command



Parameter

<CR>

Prefix

Device ID

Constant

Command Name

Parameter(s)

Suffix

~

nn @ Command

Parameter

<CR><LF>

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:

• Feedback format:

• Command parameters – Multiple parameters must be separated by a comma (,). In

addition, multiple parameters can be grouped as a single parameter using brackets ([
and ]).

• 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 KDS-17EN. The following
figure displays how the # command is framed using terminal communication software (such
as Hercules):

KDS-17EN / KDS-17DEC – Protocol 3000

83

Function

Description

Syntax

Response

Parameters/Attributes

Example

#

Protocol handshaking.

a device.

#<CR>

#<CR>

Set beacon rate.

#BEACON-

1800 – 30 minutes (maximum)

Get beacon rate.

#BEACON-EN?<CR>

BEACON-

Get beacon information,

name

Get device build date

#BUILD-DATE?<CR>

ss

CD-

Set the Color Depth

#CD-CONVERT

~nn@CD-CONVERT

out_index – Number that

1 – Force 8 bit

Enable 'force 8 bit'

CD-

Get the Color Depth

#CD-CONVERT? out_index<CR>

~nn@CD-CONVERT?

out_index – Number that

1 – Force 8 bit)

Get the color depth

CEC-GW-

Set CEC Gateway mode

#CEC-GW-PORT-

~nn@CEC-GW-PORT-

EN7)

Set CEC Gateway mode:

Protocol 3000 Commands

Kramer Electronics Ltd.

BEACON-EN

BEACON­EN?

INFO?

BUILD­DATE?

CONVERT

NOTE: Validates the

Protocol 3000 connection
and gets the machine
number.
Step-in master products
use this command to
identify the availability of

including IP address,
UDP control port, TCP
control port, MAC
address, model, name.

NOTE:
+ There is no Set
command. Get command
initiates a notification.
+ 'port_id' must be same
as '#KDS-GW-ETH' used

convert mode.

~nn@OK<CR><LF>

ENport_id,status,rate<CR>

#BEACON-INFO?port_id<CR> ~nn@BEACON-INFOport_i

out_index,cd_mode<CR>

~nn@BEACON-ENport_id,
status,rate<CR><LF>

~nn@BEACON-ENport_id,
status,rate<CR><LF>

d,ip_string,udp_port,tc
p_port,mac_address,mode
l,name<CR><LF>

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

out_index,cd_mode<CR><L

F>

port_id – ID of the Ethernet port,

and must be same as KDS-GW­ETH's netw_id
0 – Media Port
1 – Service Port
status – Enable/Disable beacon.

0 – Disable (default)
1 – Enable
rate – Repetition rate in seconds
1 – 1 second (minimum)
10 – 10 seconds (default)

ort_id – ID of the Ethernet port,
and must be same as KDS-GW­ETH's netw_id
0 – Media Port
1 – Service Port
status – Enable/Disable beacon.
0 – Disable (default)
1 – Enable
rate – Repetition rate in seconds
1 – 1 second (minimum)
10 – 10 seconds (default)
1800 – 30 minutes (maximum)

port_id – ID of the Ethernet port
0 – Media Port
1 – Service Port
ip_string – Dot-separated
representation of the IP address

udp_port – UDP control port
tcp_port – TCP control port
mac_address – Dash-separated

mac address
model – Device model

– Device name

date – Format: YYYY/MM/ DD
where

YYYY = Year
MM = Month
DD = Day
time – Format: hh:mm:ss where
hh = hours
mm = minutes

= seconds

indicates the specific
output:
1-N (N= the total number
of outputs)
cd_mode – Index in
resolution table:
0 – Follow Output
(default)

Set beacon information:
#BEACON-EN0,1,10<CR>

Get beacon information:
#BEACON-EN?<CR>

Get beacon information:
#BEACON-INFO?0<CR>

Get the device build date:
#BUILD-DATE?<CR>

mode for channel 1:
#CD-CONVERT1,1<CR>

CONVERT?

PORT­ACTIVE

convert mode.

- Whether CEC
commands com ing from
HDMI stream to LAN

ACTIVEgw_mode<CR>

out_index,cd_mode<CR><L

F>

ACTIVEgw_mode<CR><LF>

indicates the specific
output:
1-N (N= the total number
of outputs)
cd_mode – Index in
resolution table:
0 – Follow Output
(default)

gw_mode:

0 – CEC Passthrough mode
1 – CEC Gateway mode –
command to be to be sent to HDMI
Input.
2 – CEC Gateway mode –
command to be sent to HDMI
Output. (KDS-DEC7 & WP-DEC7)
3 – CEC Gateway mode –
command to be sent to HDMI Loop
Through (KDS-EN7, KDS-SW2-

convert mode status
for channel 1:

#CD-CONVERT1,1<CR>

#CEC-GW-PORT­ACTIVE1<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

84

Function

Description

Syntax

Response

Parameters/Attributes

Example

CEC-GW-

Get CEC Gateway mode

#CEC-GW-PORT-ACTIVE?<CR>

~nn@CEC-GW-PORT-

CEC-

Get list of CEC logical

#CEC-MEMBERS?

~nn@CEC-MEMBERS?

..<CR><LF>

Port_index – 1

Get gateway members:

CEC-NTFY

Notify about CEC

retrieval from CEC bus

N/A

~nn@CEC-

port_index – CEC port notifying

Notify about CEC command

CEC-SND

Send CEC comm and to

#CEC-

~nn@CEC-

– CEC port

Send CEC command to port:

COM-

Get communication route

seconds (1 to 3600)

COM-

Add a communication

com_id – Machine dependent

Add a communication route

COM-

Remove a

<CR>

CS-

Set the “force RGB color

#CS-

~nn@CS-

out_index – Number that

convert mode

Enable “force RGB color

CS-

Get the “force RGB color

~nn@CS-

out_index – Number that

convert mode

Get the “force RGB color

EDID-ACTIVE

Activate specific EDID

For KDS-17EN

#EDID-

~nn@EDID-

Input_id – 1

Set custom EDID #1 active

PORT­ACTIVE?

MEMBERS?

ROUTE?

- Whether CEC
commands com ing from
HDMI stream to LAN

addresses.

command retrieved from
bus.

NOTE: Notification is
sent to all com ports
upon CEC message

port.

tunnel connection state

ACTIVEgw_mode<CR><LF>

port_index<CR>

SNDport_index,sn_id,cmd_n
ame,cec_len,cec_command<CR

>

#COM-ROUTE?com_id<CR> ~nn@COM-ROUTEcom_id,p

port_index,<la1>,<la2>.

NTFYport_index,len,<c

ec_command…><CR><LF>

SNDport_index,sn_id,c
md_name,cec_mode<CR><LF

>

ort_type,port_id,eth_re
p_en,timeout<CR><LF>

gw_mode:

0 – CEC Passthrough mode
1 – CEC Gateway mode –
command to be sent to HDMI Input.
2 – CEC Gateway mode –
command to be to be sent to HDMI

Output. (KDS-DEC7 & WP-DEC7)
3 – CEC Gateway mode –
command to be sent to HDMI Loop

Through (KDS-EN7, KDS-SW2­EN7)

la – 1 to 15

the command

len – 1–16
cec_command – CEC format

command (in HEX format, no
leading zeros, no ‘0x’ prefix)

port_index

transmitting the command (1 –
number of ports)

sn_id – serial number of command
for flow control and response
commands from device

cmd_name – command name
cec_len – 1–16
cec_command – CEC format

command (in HEX format, no
leading zeros, no ‘0x’ prefix)

cec_mode – CEC mode
0 – Sent (Only support Sent, other

error feedback with common P3K
error code)

com_id – Machine dependent
(number of ports, only 1 accepted), *
(get all route tunnels)
port_type – TCP/UDP
0 – TCP
1 – UDP

port_id – TCP/UDP port number
eth_rep_en – Ethernet Reply

0 – COM port does not send replies
to new clients
1 – COM port sends replies to new
clients.
timeout – Keep alive timeout in

Get CEC Gateway mode:
#CEC-GW-PORT-

ACTIVE?<CR>

#CEC-MEMBERS? 1<CR>

retrieved from bus.:
~01@CEC-

NTFY2,0F36<CR>

#CEC­SND1,1,1,2,E004<CR>

Get tunneling port routing for
all route tunnels:

#COM-ROUTE?*<CR>

ROUTE-ADD

ROUTE­REMOVE

CONVERT

CONVERT?

route tunnel connection

communication route
tunnel connection.

space” convert mode.
For KDS-17DEC

space” convert mode.
For KDS-17DEC

NOTE: only valid in
custom mode. in other
modes will return error.

#COM-ROUTE-ADDcom_id,port
_type,port_id,eth_rep_en,t
imeout<CR>

#COM-ROUTE-REMOVEcom_id<C

R>

CONVERTout_index,cs_mode<

CR>

#CS-CONVERT?out_index<CR>

ACTIVEInput_id,Index<CR>

~nn@COM-ROUTE-ADDcom_
id,port_type,port_id,et
h_rep_en,timeout<CR><LF

>

~nn@COM-ROUTE-REMOVEc
om_id<CR><LF>

CONVERTout_index,cs_m
ode<CR><LF>

CONVERTout_index,cs_m
ode<CR><LF>

ACTIVEInput_id,Index<

CR><LF>

(number of ports, only 1 accepted)
port_type – TCP/UDP
0 – TCP
port_id –port number (5000 to

5999)
eth_rep_en – Ethernet Reply
0 – COM port does not send replies
to new clients
1 – COM port sends replies to new
clients.
timeout – Keep alive timeout in

seconds (1 to 3600)

com_id – Machine dependent
(number of ports, only 1 accepted)

indicates the specific output:
1-N (N= the total number of outputs)
cs_mode – Index in resolution table:
0 – Color space pass (default)
1 – Enable “force RGB color space”

indicates the specific output:
1-N (N= the total number of outputs)
cs_mode – Index in resolution table:
0 – Color space pass (default)
1 – Enable “force RGB color space”

Index - Index in EDID List

tunnel connection:
#COM-ROUTE-ADD1,0,50

01,1,1<CR>

Remove a communication
route tunnel connection:

#COM-ROUTE-REMOVE1

space” convert mode for
channel 1:

#CS-CONVERT1,1<CR>

space” convert mode status
for channel 1:

#CS-CONVERT?1<CR>

on input 1; If not in CUSTOM
mode, return ERROR

#EDID-ACTIVE1,1<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

85

Function

Description

Syntax

Response

Parameters/Attributes

Example

EDID-

Get current active EDID

~nn@EDID-

Get active custom EDID

EDID-LIST?

Get a list of currently

#EDID-LIST?<CR>

~nn@#EDID-

port_idx – HDMI port index, only

Get EDID list

<LF>

EDID-MODE

Set EDID work mode.

#EDID-

~nn@#EDID-

Input_id – 1

Set EDID to custom mode,

EDID-MODE?

Get EDID work mode

~nn@#EDID-

LIST?'

Get EDID Mode

Set MAC on net device to

For KDS-17EN

#EDID-NET-

~nn@EDID-NET-

EDID-NET-

Get MAC on net device

#EDID-NET-

~nn@EDID-NET-

input_id – 1

Get MAC on Net device for

Remove custom EDID

For KDS-17EN

~nn@#EDID-

ETH-PORT

Set Ethernet port

range: 0-(2^16-1).

port_type –

Set the Ethernet port protocol

ETH-PORT?

Get Ethernet port

–

50000~50999

Get the Ethernet port protocol

ETH-

Get an open tunnel

tunnel_id – Tunnel ID number, *

1 – wired connection

Get all open tunnel

FACTORY

Reset device to factory

changes to take effect.

#FACTORY<CR>

Reset the device to factory

GET-MGR-

Get AVoIP Manager IP

#GET-MGR-IP?<CR>

~nn@GET-MGR-IP

mgrip: AVoIP Manager IP

Manager not IP enabled.

Get MGR-IP:

ACTIVE?

EDID-NET­SRC

SRC?

EDID-RM

Note: only valid in
custom mode. in other
modes will return error.
For KDS-17EN

existing EDID’s (Get
only)
For KDS-17EN

For KDS-17EN

For KDS-17EN

be EDID source
It is only valid when
EDID-MODE is set as
PASSTHRU

of EDID source
For KDS-17EN

from EDID list
Note: should return ERR
if this EDID is in USE.

protocol.

NOTE: If the port number
you enter is already in
use, an error is returned.
The port number must be
within the following

protocol.

#EDID-ACTIVE?Input_id<CR>

MODEInput_id,Mode,Index<C

R>

#EDID-MODE?Input_id<CR>

SRCinput_id,src_ip<CR>

SRC?input_id<CR>

#EDID-RMIndex<CR>

#ETH-PORTport_type,port_i
d<CR>

#ETH-PORT?port_type<CR> ~nn@ETH-PORTport_type

ACTIVEInput_id,
Index<CR><LF>

LIST[port_idx,“name”]
,...<CR><LF>

MODEInput_id,Mode,Ind
ex<CR><LF>

MODEInput_id,
Mode,Index<CR><LF>

SRCinput_id,src_ip<CR

><LF>

SRCinput_id,src_ip<CR

><LF>

RMIndex<CR><LF>

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

,port_id<CR><LF>

Input_id – 1

Index - Index in EDID List

1 is accepted.

name – EDID file name

Mode –

- PASSTHRU (get from decoder)

- CUSTOM

- DEFAULT
Index – CUSTOM should have an
'index' from which get from 'EDID­LIST?'

Input_id – 1
Mode –

- PASSTHRU (get from decoder)

- CUSTOM

- DEFAULT
Index – CUSTOM should have an
'index' from which get from 'EDID-

input_id – 1
src_ip – DEC IP address

src_ip –DEC IP address

Index: 1…N - EDID index to

remove which get from 'EDID­LIST?. index 0 (Default) is not
removable.

- TCP

- UDP
port_id –
when port_type = TCP: 5000~5099
when port_type = UDP:
50000~50999

port_type

- TCP

- UDP
port_id –
when port_type = TCP: 5000~5099
when port_type = UDP:

index on Input 1; If not in
CUSTOM mode, return
ERROR

#EDID-ACTIVE?1<CR>

#EDID-LIST?<CR>

Return:
~nn@EDID-

LIST[0,“DEFAULT”],[2,”SO
NY”],[5,”PANASONIC”]<CR>

idx is 1
#EDID-

MODE1,CUSTOM,1<CR>

#EDID-MODE?1<CR>

Set MAC on net device for
Input 1
#EDID-NET-

SRC1,192.168.1.40<CR>

Input 1
#EDID-NET-SRC?1<CR>

remove EDID from slot 3 and
delete the file:

#EDID-RM3<CR>

for TCP to port 5000:
#ETH-PORTTCP,5000<CR

>

for TCP:
#ETH-PORT?TCP<CR>

TUNNEL?

IP?

parameters.

default configuration

NOTE: 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

#ETH-TUNNEL?tunnel_id<CR> ~nn@ETH-TUNNEL[[tunne

l_id,com_id,port_type,p
ort_id,eth_ip,remote_po
rt_id,eth_rep_en,connec
tion_type],...]<CR><LF>

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

mgrip<CR><LF>

(get all open tunnels)
com_id – Machine dependent
1 – First COM Port
port_type – TCP/UDP
0 – TCP

port_id – TCP/UDP port number
eth_ip – Client IP address
remote_port_id – Remote port

number
eth_rep_en – Ethernet Reply
0 – COM port does not send replies

to new clients
1 – COM port sends replies to new
clients
connection_type – Connection
type

0.0.0.0 - means AVoIP

parameters:
#ETH-TUNNEL?*<CR>

default configuration:
#FACTORY<CR>

#GET-MGR-IP?<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

86

Function

Description

Syntax

Response

Parameters/Attributes

Example

GTW-MSG-

Clear Control Gateway

#GTW-MSG-CLEAR

~nn@GTW-MSG-NUM

3 = RS232

Clear all Control Gateway

GTW-MSG-

Get Control Gateway

#GTW-MSG-

~nn@GTW-MSG-

message_type – where

Get Control Gateway

Set HDCP mode.

For KDS-17EN

HDCP-MOD?

Get HDCP mode.

decoder.

Get the input HDCP-MODE

Set HDCP mode on

#HDCPOUT-MOD

~nn@HDCPOUT-MOD

HDCP-OUT-

Get HDCP mode on

#HDCPOUT-MOD? in_index

~nn@HDCPOUT-MOD

HDCP-STAT?

Get HDCP signal status.

– Input/Output

1 – HDCP On

Get the output HDCP-

Get command list or help

#HELP<CR>

1. Multi-line:

cmd_name<CR><LF>

HTTP-AUTH-

Start/stop HTTP/HTTPS

#HTTP-AUTH-

~nn@HTTP-AUTH-

security_state – Security state

Enable the permission

Get HTTP/HTTPS

#HTTP-AUTH-ENABLE?<CR>

~nn@HTTP-AUTH-

CR><LF>

1 – ON (enables security)

HTTP-

Set HTTP inactivity

#LOGOUT-TIMEOUT time<CR>

~nn@LOGOUT-TIMEOUT

time – minutes of logout time

Set Inactivity auto-logout time

HTTP-

TIMEOUT?

Get HTTP inactivity

#LOGOUT-TIMEOUT?<CR>

~nn@LOGOUT-TIMEOUT

time – minutes of logout

0~60

Get Inactivity auto-logout

CLEAR

NUM?

HDCP-MOD

HDCP-OUT­MOD

MOD?

Messages Counter.

Messages Counter from
the device boot done.
Add Recv_Count and
Send_Count

NOTE: <date> is legacy
parameter, for KDS7
always be ignored

NOTE: Set HDCP
working mode on the
device input:
HDCP supported ­HDCP_ON [default].
HDCP not supported ­HDCP OFF.

NOTE: 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.
For KDS-17EN

HDMI Out.

NOTE: Set HDCP
working mode on
the device output

HDMI Out.

NOTE: Get HDCP
working mode on
the device output

NOTE: 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.

message_type<CR>

NUM?message_type,date<CR>

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

#HDCP-MOD?in_index<CR> ~nn@HDCP-MODin_index,

in_index,mode<CR>

<CR>

#HDCP-STAT?io_mode,in_ind
ex<CR>

message_type<CR><LF>

NUMmessage_type,date,
recv_counter,send_count

<CR><LF>

mode<CR><LF>

mode<CR><LF>

in_index,mode<CR><LF>

in_index,mode<CR><LF>

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

message_type - where

0 = ALL
1 = CEC
2 = IR

1 =CEC
2 = IR
3 = RS232

date – Format: DD-MM-YYYY.
Recv_counter – counter of

receive messages
Send_counter – counter of send
messages

in_index – Number that indicates
the specific input:
1-N (N= the total number of inputs)
mode – HDCP mode:
0 – HDCP Off
1 – HDCP On

in_index – Number that indicates
the specific input:
1-N (N= the total number of inputs)
mode – HDCP mode:

0 – HDCP Off
1 – HDCP On
3 – HDCP Mirror Mode - used by
KDS-7 decoder to allow an HDCP

2.2 source connected to the
encoder to play on an HDCP 1.4
TV/display connected to the

in_index – Number that indicates
the specific output:
1-N (N= the total number of
inputs)
mode – HDCP mode:
0 – HDCP follow sink (Default)
1 – HDCP follow source

in_index – Number that indicates
the specific output:
1-N (N= the total number of
inputs)
mode – HDCP mode:
0 – HDCP follow sink (Default)
1 – HDCP follow source

io_mode

0 – Input
1 – Output
io_index – Number that indicates
the specific number of inputs or

outputs (based on io_mode): 1-N
(N=total number of inputs or
outputs)
status – Signal encryption status ­valid values On/Off
0 – HDCP Off

Messages Counter
#GTW-MSG-CLEAR 0<CR>

Messages Counter from
certain period:

#GTW-MSG-NUM?1,01­01-1970<CR>

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

#HDCP-MOD1,0<CR>

of IN 1 HDMI:
#HDCP-MOD<CR>

Set the output HDCP-OUT­MODE of OUT 1 to follow
source:
#HDCP-OUT-MOD 1,1<CR>

Get the output HDCP-OUT­MODE of OUT 1 to follow
source:
#HDCP-OUT-MOD? 1<CR>

STATUS of IN 1:
#HDCP-STAT?0,1<CR>

HELP

ENABLE

HTTP-AUTH­ENABLE?

LOGOUT­TIMEOUT

LOGOUT-

for specific command.

communication security.

NOTE: The
HTTP/HTTPS permission
works only if security is
enabled with the “HTTP­AUTH-ENABLE”
command.

security state.

auto-logout time.

auto-logout time.

ENABLEsecurity_state,pass
word<CR>

~nn@Devicecmd_name,

ENABLEsecurity_state<

CR><LF>

ENABLEsecurity_state<

time<CR><LF>

time<CR><LF>

cmd_name – Name of a specific
command

0 – OFF (disables security)
1 – ON (enables security)
password – password in
uencode64 format, only if the

password is valid, AUTH will be
disabled otherwise reject the
request.

NOTE: It is only required when the
security_state is 0 for disabling the
security.

security_state – Security state
0 – OFF (disables security)

0~60

time

Get the command list:
#HELP<CR>

system:
#HTTP-AUTH-

ENABLE0,dGVzdA==<CR>

Get security state:
#HTTP-AUTH-

ENABLE?<CR>

to 10
#LOGOUT-TIMEOUT
10<CR>

time
#LOGOUT-TIMEOUT?<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

87

Function

Description

Syntax

Response

Parameters/Attributes

Example

HTTP-

Set password for HTTP

#HTTP-

~nn@HTTP-

letter and one lowercase letter.

Set the password for the

HW-TEMP?

Get device heat

region_id – ID of the region for

closest integer

Get temperature in Celsius of

HW-

Get hardware version

#HW-VERSION?<CR>

~nn@HW-

on<CR><LF>

hardware_version –

Get hardware version

IDV

Set visual indication from

devices.

#IDV<CR>

IR-LEARN

Receive IR command

#IRLEARN<CR>

~nn@IRLEARN

pronto_command – Pronto format

4 – Error

Get TVON IR code:

IR-SND

Send IR comman d to

ir_index – Number that indicates

8 – Error

Send TVON IR command to

KDS-802-1X-

Get authentication status

#KDS-802-1X-AUTH-

~nn@KDS-802-1X-AUTH-

netw_id – Network ID–the device

3 – authentication ongoing

Get media port authentication

Set action to perform by

2 – Save config

PASSWD

VERSION?

user login.
The default password is
"admin".

device.

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

from port.

PASSWDuser,password<CR>

#HW‑TEMP?region_id,mode<C

R>

PASSWDuser,password<C

R><LF>

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

VERSIONhardware_versi

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

ir_status,<pronto­command<CR><LF>

user – user name of login to set

(admin support only).

password – Password for the user,
in uencode64 format. 8 to 24
characters (letters, numbers, and
symbols without spaces or
commas), at least including one
number, one symbols without
spaces or commas, one uppercase

which to get the temperature
0 – Region 0
mode – Celsius or Fahrenheit
0 – Celsius
1 – Fahrenheit
temperature – Temperature of
the HW region, rounded down to the

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

#IDV<CR>

command (in HEX format, no
leading zeros, no ‘0x’ prefix, with
comma separated)
ir_status – IR Status
0 – Done
1 – Busy
2 – Wrong Parameter
3 – Timeout

admin protocol permission
level to ‘Aa12345!’:
#HTTP-

PASSWDadmin,QWExMjM
0NSE=<CR>

first cpu
#HW‑TEMP?0,0<CR>

#HW-VERSION?<CR>

#IRLEARN<CR>

port.

AUTH­STATE?

of IEEE 802.1X

#IR-SNDir_index,sn_id,cmd
_name,repeat_amount,total_
packages,package_id,<pront
o command…><CR>

STATE?netw_id<CR>

~nn@IR-SNDir_index,sn
_id,cmd_name,ir_status<

CR><LF>

STATEnetw_id,mode<CR>

<LF>

the specific IR port:
1-N (N= the total number of inputs)
* - broadcasts to all ports
sn_id – Serial number of command
for flow control and response
commands from device
cmd_name – Command name
(length limit 24 chars)
repeat_amount – Of times the IR
command is transmitted
(limited to 50; repeats > 50 are
truncated to 50), default = 1
total_packages – Number of
messages the original command

was divided into, default = 1
package_id – Chunk serial
number (only valid when

Total_packages >1)
pronto_command – Pronto format
command (in HEX format, no

leading zeros, no ‘0x’ prefix, with
comma separated)
ir_status – IR Status

0 – Sent (no error)
1 – Stop
2 – Done
3 – Busy
4 – Wrong Parameter
5 – Nothing to Stop
6 – Start
7 – Timeout

network interface (if there are more
than one):

0 – Media Port
1 – Service Port
mode – authentication status of
IEEE 802.1X
0 – off
1 – authentication success
2 – authentication failed

IR port 1:
#IR-

SND1,1,TVON,1,1,1,0000,
006D,0000,0022,00ac,00ac,0
016,0040,0016,0040,0016,00
40,0016,0015,0016,0015,001
6,0015,0016,0015,0016,0015
,0016,0040,0016,0040,0016,
0040,0016,0015,0016,0015,0
016,0015,0016,0015,0016,00
15,0016,0040,0016,0015,001
6,0015,0016,0040,0016,0040
,0016,0015,0016,0015,0016,
0040,0016,0015,0016,0040,0
016,0040,0016,0015,0016,00
15,0016,0040,0016,0040,001
6,0015,0016,071c<CR>

status of IEEE 802.1X.
#KDS-802-1X-AUTH-

STATE?0<CR>

KDS-ACTION

encoder/decoder.

#KDS-ACTIONkds_mode<CR> ~nn@KDS-ACTIONkds_mod

e<CR><LF>

kds_mode – Action (state) for

encoder/decoder
0 – Stop
1 – Play

Stop the encoder/decoder:
#KDS-ACTION 0<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

88

Function

Description

Syntax

Response

Parameters/Attributes

Example

KDS-

Get last action (state)

#KDS-ACTION?<CR>

2 – Save config

Get the last action performed

KDS-AES-

Set AES key

~nn@KDS-AES-

key – AES key for

Set AES key for the

KDS-AES-

Get AES key

#KDS-AES-KEY?<CR>

~nn@KDS-AES-

Get AES key of the

Set AES Mode

#KDSAES-MOD mode<CR>

~nn@KDSAES-MOD

1 – full mode

Get AES Mode

#KDSAES-MOD?<CR>

~nn@KDSAES-MOD

1 – full mode

KDS-AUD-

Set KDS17 Audio

~nn@KDS-AUD-ADDON

addon - Audio addon

2 - AES67

Set Audio Addon to Dante

KDS-AUD-

Get KDS17 Audio

#KDS-AUD-ADDON?<CR>

~nn@KDS-AUD-ADDON

addon - Audio addon

2 - AES67

Get Audio Addon

KDS-

Set decoder AV or IR

#KDS-CHANNEL-

~nn@KDS-CHANNEL-

<signal_type> – Signal ID

the channel select.

Tune the decoder to ch_id 1

KDS-

Get decoder AV or IR

#KDS-CHANNEL-

~nn@KDS-CHANNEL-

<signal_type> – Signal ID

the channel select.

Get channel ID

Set daisy chain mode.

#KDS-DAISY-

~nn@KDS-DAISY-

daisy_mode

KDS-DAISY-

Get daisy chain mode.

#KDS-DAISY-CHAIN?<CR>

~nn@KDS-DAISY-

F>

daisy_mode

Get DAISY mode:

Set Encoder AV channel

#KDS-DEFINE-

~nn@KDS-DEFINE-

KDS-DEFINE-

Get Encoder AV channel

#KDS-DEFINE-CHANNEL?<CR>

~nn@KDS-DEFINE-

CHANNEL?<CR>

Set gateway network port

#KDS-GW-

~nn@KDS-GW-

KDS-GW-

Get gateway network

~nn@KDS-GW-

1 – Service Port

Get Dante port:

KDS-ETH-

Set KDS17 Ethernet

#KDS-ETH-BRIDGE

~nn@KDS-ETH-BRIDGE

mode:

vlanid

Set bridge mode to LAN2

ACTION?

KEY

KEY?

KDS-AES­MOD

KDS-AES­MOD?

ADDON

ADDON?

CHANNEL­SELECT

performed by
encoder/decoder.

Addon

Addon

channel. Add
signal_type.
For KDS-17DEC

#KDS-AES-KEYkey<CR>

#KDS-AUD-ADDONmode<CR>

SELECT[signal_type_1,sign
al_type_2…],ch_id<CR>

~nn@KDS-ACTIONkds_mod
e<CR><LF>

KEYkey<CR><LF>

KEYkey<CR><LF>

mode<CR><LF>

mode<CR><LF>

addon<CR><LF>

addon<CR><LF>

SELECT[signal_type_1,

signale_type_2,…],ch_id

<CR><LF>

kds_mode – Action (state) for

encoder/decoder
0 – Stop
1 – Play

encoder/decoder, must be 16 bytes
value represented in hex

0 – default key

key – AES key for encoder/decoder
0 – default key

mode – AES mode for
encoder/decoder,
0 – standard mode

mode – AES mode for
encoder/decoder,
0 – standard mode

0 - None
1 - Dante

0 - None
1 - Dante

attribute:

VIDEO
AUDIO
IR
RS232
USB
CEC
ch_id – Number that indicates the

specific input 0-999. 0 is for cancel

by the encoder/decoder:
#KDS-ACTION?<CR>

encoder/decoder:
# KDS-AES-

KEY001122334455667788
99AABBCCDDEEFF <CR>

encoder/decoder:
#KDS-AES-KEY?<CR>

Set AES mode as full mode:
#KDSAES-MOD 1 <CR>

Get AES mode:
#KDSAES-MOD?<CR>

#KDS-AUD-ADDON 1<CR>

#KDS-AUD-ADDON?<CR>

#KDS-CHANNEL­SELECT[video,audio,rs232

,ir,usb,cec],1<CR>

CHANNEL­SELECT?

KDS-DAISY­CHAIN

CHAIN?

KDS-DEFINE­CHANNEL

CHANNEL?

KDS-GW­ETH

ETH?

channel. Add
signal_type.
For KDS-17DEC

For KDS-17DEC

For KDS-17DEC

ID.
For KDS-17EN

ID.
For KDS-17EN

port.

SELECT?signal_type<CR>

CHAINdaisy_mode<CR>

CHANNELch_id<CR>

ETHgw_type,netw_id<CR>

#KDS-GW-ETH?gw_type<CR>

SELECTsignal_type,ch_

id<CR><LF>

CHAINdaisy_mode<CR><L

F>

CHAINdaisy_mode<CR><L

CHANNELch_id<CR><LF>

CHANNELch_id<CR><LF>

ETHgw_type,netw_id<CR

><LF>

ETHgw_type,netw_id<CR

><LF>

attribute:

VIDEO
AUDIO
IR
RS232
USB
CEC
ch_id – Number that indicates the

specific input 0-999. 0 is for cancel

0 – OFF (disables daisy chain)
1 – ON (enables daisy chain)

0 – OFF (disables daisy chain)
1 – ON (enables daisy chain)

ch_id – Number that indicates the
specific input 1-999.

ch_id – Number that indicates the
specific input 1-999.

gw_type:
0 – Control
1 – Dante – Only available on KDS-

SW3-EN7
netw_id – Network ID–the device
network interface (if there are more

than one):
0 – Media Port
1 – Service Port

gw_type:
0 – Control
1 – Dante – Only available on KDS-

SW3-EN7
netw_id – Network ID–the device
network interface (if there are more

than one).
0 – Media Port

#KDS-CHANNEL­SELECT?video<CR>

Enable DAISY mode:
#KDS-DAISY-

CHAIN1<CR>

#KDS-DAISY-CHAIN?<CR>

Tune the encoder:
#KDS-DEFINE-

CHANNEL1<CR>

Get channel ID:
#KDS-DEFINE-

Set Dante port to eth1:
#KDS-GW-ETH1,1<CR>

#KDS-GW-ETH?1<CR>

BRIDGE

bridge mode

mode,idx,vlanid<CR>

mode,idx,vlanid<CR><LF>

0 - Disable
1 - Enable
idx: interface inde
0 - LAN 1
1 - LAN 2

: 0~4000

#KDS-ETH-BRIDGE 1,2,1

<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

89

Function

Description

Syntax

Response

Parameters/Attributes

Example

KDS-ETH-

Get KDS17 Ethernet

#KDS-ETH-BRIDGE?<CR>

~nn@KDS-ETH-BRIDGE

mode:

vlanid: 1~4000

Get bridge mode

KDS-

Set unicast / multicast.

method – Streaming method

Set current streaming method

KDS-

Get unicast / multicast.

#KDS-METHOD?<CR>

method – Streaming method

Get current streaming

KDS-

Set multicast group

#KDS-

~nn@KDS-

packets.

Get multicast group

#KDS-MULTICAST?<CR>

~nn@KDS-

Set prefix of multicast

#KDS-MULTICAST-

~nn@KDS-MULTICAST-

224<CR>

Get prefix of multicast

#KDS-MULTICAST-PREFIX?<CR>

~nn@KDS-MULTICAST-

PREFIX?<CR>

Set decoder Display

~nn@KDS-OSD-

KDS-OSD-

Get decoder Display

#KDS-OSD-DISPLAY?<CR>

~nn@KDS-OSD-

2 - display now + on

Get OSD display mode:

KDS-OSD-

Set decoder OSD hotkey.

~nn@KDS-OSD-

mode –

Set OSD hotkey to CTL:

Get decoder OSD

#KDS-OSD-HOTKEY?<CR>

~nn@KDS-OSD-

3 - SHIFT

KDS-

Set preview

#KDS-PREVIEW

~nn@KDS-PREVIEW

mode:

mq: 60~100

Set preview on with

KDS-

Get preview

#KDS-PREVIEW?<CR>

~nn@KDS-PREVIEW

mode:

Get preview parameters.

KDS-RATIO?

Get aspect ratio.

#KDS-RATIO?<CR>

~nn@KDS-

width: height, for example “16:9”

BRIDGE?

METHOD

METHOD?

MULTICAST

KDS­MULTICAST?

KDS­MULTICAST­PREFIX

KDS­MULTICAST­PREFIX?

KDS-OSD­DISPLAY

DISPLAY?

bridge mode

address and TTL value.

address and TTL value.

group address.

group address.

Device Information
On/Off
For KDS-17DEC

Device Information status
For KDS-17DEC

mode,idx,vlanid<CR><LF>

#KDS-METHOD1<CR> ~nn@KDS-METHODmethod<

MULTICASTgroup_ip,ttl<CR>

PREFIXprefix<CR>

#KDS-OSD-DISPLAYmode<CR>

CR><LF>

~nn@KDS-METHODmethod<

CR><LF>

MULTICASTgroup_ip,ttl

<CR><LF>

MULTICASTgroup_ip,ttl

<CR><LF>

PREFIXprefix<CR><LF>

PREFIXprefix<CR><LF>

DISPLAYmode<CR><LF>

DISPLAYmode<CR><LF>

0 - Disable
1 - Enable
idx: interface inde
0 - LAN 1
1 - LAN 2

1 Unicast
2 Multicast

1 – Unicast
2 – Multicast

group-ip – Multicast group IP for
KDS7 is ignored, KDS7 managed
multicast address automatically.

ttl – Time to Live of the streamed

group-ip – Multicast group IP for

KDS7 is ignored, KDS7 managed
multicast address automatically, so
always response 0.0.0.0
ttl – Time to Live of the streamed
packets.

prefix – Prefix of multicast group
IP for KDS7
224~239

prefix – Prefix of multicast group
IP for KDS7

mode –
0 - off
1 - on
2 - display now + on

mode –
0 - off
1 - on

#KDS-ETH-BRIDGE?<CR>

of encoder/decoder:
#KDS-METHOD1<CR>

method of encoder/decoder:
#KDS-METHOD<CR>

Set multicast group adress
and TTL value:
#KDS-MULTICAST

0.0.0.0,64<CR>

Get multicast group adress
and TTL value:
#KDS-MULTICAST?<CR>

Set multicast group adress
and TTL value:
#KDS-MULTICAST-PREF IX

Get multicast group adress
and TTL value:
#KDS-MULTICAST-

Set OSD Display mode on:
#KDS-OSD-

DISPLAY1<CR>

#KDS-OSD-DISPLAY?<CR>

HOTKEY

KDS-OSD­HOTKEY?

PREVIEW

PREVIEW?

For KDS-17DEC

hotkey.
For KDS-17DEC

parameters.

NOTE: When
PREVIEW is OFF,
other parameters
should not be provided

parameters.

NOTE: When
PREVIEW is OFF,
other parameters
STILL need be
responded.

#KDS-OSD-HOTKEYmode<CR>

mode,width,height,fps,bw,a
s,mq<CR>

HOTKEYmode<CR><LF>

HOTKEYmode<CR><LF>

mode,width,height,fps,b

w,as,mq<CR>

mode,width,height,fps,b
w,as,mq<CR>

RATIOvalue<CR><LF>

0 - CAP
1 - CTL
2 - TAB
3 - SHIFT

mode –
0 - CAP
1 - CTL
2 - TAB

0 - OFF
1 - ON
width: 0~1280 pixels

height: 0~720 pixels
fps: 1~60 frames per second
bw: 1~50000 Kbps
as:

0 - Do not need keep ratio
1 - Keep ratio

0 - OFF
1 - ON
width: 0~1280 pixels
height: 0~720 pixels
fps: 1~60 frames per second
bw: 1~50000 Kbps
as:
0 - Do not need keep ratio
1 - Keep ratio
mq: 60~100

value – Streamer Decoder Aspect
Ratio

#KDS-OSD­HOTKEY1<CR>

Get OSD hotkey mode:
#KDS-OSD-HOTKEY?<CR>

960x540@10Hz, 8Mbps,
keep ratio.
#KDS-PREVIEW
1,960,5640,15,8000,0,60<CR

>

#KDS-PREVIEW?<CR>

Get Aspect Ratio:
#KDS-RATIO?<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

90

Function

Description

Syntax

Response

Parameters/Attributes

Example

KDS-

Get actual AV stream

#KDS-

~nn@KDS-

Set scaling mode Add

#KDS-

~nn@KDS-

KDS-SCALE?

Get scaling mode Add

#KDS-SCALE?<CR>

~nn@KDS-

– Streamer Decoder Scaling

to #KDS-SCALE

Get scaling mode:

KDS-SLEEP-

Set sleep image mode of

~nn@KDS-SLEEP-

mode – sleep image mode for

1 - On

Stop the Sleep Image:

Get sleep image mode of

#KDS-SLEEP-IMAGE?<CR>

~nn@KDS-SLEEP-

KDS-VLAN-

Set vlan tag of gateway

#KDS-VLAN-

~nn@KDS-VLAN-

Set Dante vlan tag:

RESOL?

KDS-SCALE

IMAGE

resolution.

res_type.
For KDS-17DEC

res_type.
For KDS-17DEC

decoder.
For KDS-17DEC

RESOL?io_mode,io_index,is
_native<CR>

SCALEvalue,res_type<CR>

#KDS-SLEEP-IMAGEmode<CR>

RESOL?io_mode,io_inde
x,is_native,resolution<

CR><LF>

SCALEvalue,res_type<C

R><LF>

SCALEvalue,res_type<C

R><LF>

IMAGEmode<CR><LF>

io_mode – Input/Output

0 - Input
1 - Output
io_index – Number that indicates
the specific input or output port:
1-N (N= the total number of input or

output ports)
is_native – Native resolution flag
0 - Off
1 - On
resolution – Resolution index
0-3 = (Reserved)
4=1280x720p@59.94Hz/60Hz
5-15=(Reserved)
16=1920x1080p@59.94Hz/60Hz
17-30=(Reserved)
31=1920x1080p@50Hz
32-65=(Reserved)
66=1024x768@60Hz
67=1280x768p@60Hz
68=1280x1024p@60Hz
69=1600x1200p@60Hz
70=1680x1050p@60Hz
71=1920x1200@60Hz
72=3840x2160p@24Hz
73=3840x2160p@25Hz
74=3840x2160p@30Hz
75=3840x2160p@50Hz
76=3840x2160p@60Hz
77-1030=(Reserved)
1031=1360x768p@60Hz

1032-1038=(Reserved)
1039=600x900p@60Hz
1040-9999=(Reserved)

value – Streamer Decoder Scaling
Mode
0 - Pass Thru
1 - Scaling
2 - Based on EDID
res_type[option] –Resolution
index
0-3=(Reserved)
4=1280x720p@59.94Hz/60Hz
5-15=(Reserved)
16=1920x1080p@59.94Hz/60Hz
17-30=(Reserved)
31=1920x1080p@50Hz
32-65=(Reserved)
66=1024x768@60Hz
67=1280x768p@60Hz
68=1280x1024p@60Hz
69=(Reserved)
70=1680x1050@60
71=1920x1200@60
72=(Reserved)
73=3840x2160p@25Hz
74=3840x2160p@30Hz
75-1030=(Reserved)
1031=1360x768p@60Hz
1032-1038=(Reserved)
1039=1600x900p@60Hz
1040-9999=(Reserved)

value

Mode
0 - Pass Thru
1 - Scaling
2 - Based on EDID
res_type[option] – res_type refer

decoder
0 - Off

Set scale to scaling,
resolution is 1080P60:

#KDS-SCALE1,16<CR>

#KDS-SCALE?<CR>

# KDS-SLEEP-IMAGE
0<CR>

KDS-SLEEP­IMAGE?

TAG

decoder.
For KDS-17DEC

port.

TAGgw_type,tag_id<CR>

IMAGEmode<CR><LF>

TAGgw_type,tag_id<CR>

<LF>

mode – sleep image mode for

decoder
0 - Off
1 - On

gw_type –
0 - Control
1 - Dante – Only available on KDS-

SW3-EN7
tag_id – vlan tag (1 to 4093)
1 - No VLAN tag

Get the Sleep Image mode:
# KDS-SLEEP-IMAGE?<CR>

#KDS-VLAN­TAG1,33<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

91

Function

Description

Syntax

Response

Parameters/Attributes

Example

KDS-VLAN-

Get vlan tag of gateway

~nn@KDS-VLAN-

1 - No VLAN tag

KDS-VW-

Set KDS7 Video Wall

#KDS-VW-

~nn@KDS-VW-

oh

Set bezel compensation:

KDS-VW-

Get KDS7 Video Wall

#KDS-VW-BEZEL?<CR>

~nn@KDS-VW-

oh

Set test pattern mode of

~nn@KDS-VW-

KDS-VW-

Get test pattern mode of

#KDS-VW-PATTERN?<CR>

~nn@KDS-VW-

1 - On (Enable test pattern)

LDFW

Load new firmware file.

Step 1:

Response 1:

size – Size of firmware data that is

01

02

03

04

05 Packet ID

Length

Data

CRC

Lock last read EDID.

#LOCK-

~nn@LOCK-

1 - On locks EDID.

Get EDID lock state.

~nn@LOCK-

1 - On locks EDID.

LOCK-FP

Lock the front panel.

Lock/Unlock – On/Off

1 - (On) Locks Front Panel.

Unlock front panel:

Get the front panel lock

#LOCK-FP?<CR>

LOG-ACTION

Reset events log.

#LOG-

~nn@LOG-

– One of

3 - Weekly (default)

Reset events log:

TAG?

BEZEL

BEZEL?

KDS-VW­PATTERN

PATTERN?

port.

bezel compensation.
For KDS-17DEC

bezel compensation.
For KDS-17DEC

video wall.
For KDS-17DEC

video wall.
For KDS-17DEC

NOTE: In most devices
firmware dat a is saved to
flash memory, but the
memory does not update
until receiving the
“UPGRADE” command
and is restarted.

#KDS-VLAN-TAG?gw_type<CR>

BEZELvw,ow,vh,oh<CR>

#KDS-VW-PATTERNmode<CR>

#LDFWsize<CR>
Step 2: If ready was
received, send
FIRMWARE_DATA

TAGgw_type,tag_id<CR>

<LF>

BEZELvw,ow,vh,oh<CR><

LF>

BEZELvw,ow,vh,oh<CR><

LF>

PATTERNmode<CR><LF>

PATTERNmode<CR><LF>

~nn@LDFWsize
ready<CR><LF>
Response 2:

~nn@LDFWsizeok<CR><L

F>

gw_type –

0 - Control
1 - Dante – Only available on KDS­SW3-EN7

tag_id – vlan tag (1 to 4093)

vw – 0~100000
ow – 0~100000
vh – 0~100000

– 0~100000

vw – 0~100000
ow – 0~100000
vh – 0~100000

– 0~100000

Mode –
0 - OFF (Disable test pattern)
1 - On (Enable test pattern)

Mode –
0 - OFF (Disable test pattern)

sent.
firmware_data – HEX or KFW file
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

Get Dante vlan tag:
#KDS-VLAN-TAG?1<CR>

#KDS-VW­BEZEL12210,12310,6860,

6960<CR>

Get bezel compensation:
#KDS-VW-BEZEL?<CR>

Set video wall test pattern on:
#KDS-VW-

PATTERN1<CR>

Get video wall test pattern
on:
#KDS-VW-PATTERN?<CR>

LOCK-EDID

LOCK-EDID?

LOCK-FP?

For KDS-17EN

For KDS-17EN

For KDS-17EN

state.
For KDS-17EN

EDIDin_index,lock_mode<CR

>

#LOCK-EDID?in_index<CR>

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

ACTIONaction,period<CR>

EDIDin_index,lock_mod

e<CR><LF>

EDIDin_index,lock_mod
e<CR><LF>

k<CR><LF>

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

ACTIONaction,period<C

R><LF>

Response: ~nnnn ok<CR><LF>
(Where NNNN is the received
packet ID in ASCII hex digits.)

in_index – 1
lock_mode – On/Off

0 - Off unlocks EDID.

in_index – 1
lock_mode – On/Off

0 - Off unlocks EDID.

0 - (Off) Unlocks Front Panel.

Lock/Unlock – On/Off
0 - (Off) Unlocks Front Panel.
1 - (On) Locks Front Panel.

action

1 - Start, start logging
2 - Pause, pause logging but

keep log content
3 - Resume, resume the logging
4 - Reset, clear all current logs,
keep logging
period – Relevant for "start"(be
ignored by KDS7 Devices)
1 - Keep current
2 - Daily

Lock the last read EDID from
the HDMI In 1 input:

#LOCK-EDID1,1<CR>

Get EDID lock state for Input
1:

#LOCK-EDID? 1<CR>

#LOCK-FP0<CR>

Get the front panel lock state:
#LOCK-FP?<CR>

#LOG-ACTION4,1<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

92

Function

Description

Syntax

Response

Parameters/Attributes

Example

LOG-

Get log state.

#LOG-ACTION?<CR>

~nn@LOG-

3 - Weekly (default)

Set protocol permission.

after timeout.

LOGIN?

Get current protocol

after timeout.

#LOGIN?<CR>

login_level – Level of

Get current protocol

LOGOUT

Cancel current

levels to Not Secure.

#LOGOUT<CR>

#LOGOUT<CR>

LOGOUT-

Set inactivity auto-logout

~nn@LOGOUT-

time – minutes of logout time

Set Inactivity auto-logout time

Get inactivity auto-logout

#LOGOUT-TIMEOUT?<CR>

~nn@LOGOUT-

#LOGOUT-TIMEOUT?<CR>

LOG-SRV

Set log server.

#LOGSRV

~nn@LOGSRV

mode – On/Off

– Log server port

Set log server with IP

LOG-SRV?

Get log server.

#LOGSRV?<CR>

~nn@LOGSRV

mode – On/Off

log_server_port – Log server port

Get log server:

MODE

Set API mode.

#MODE api_mode<CR>

~nn@MODE api_mode<CR>

api_mode

1 - solicited

Set API mode to

#MODE 1<CR>

MODE?

Get API mode.

#MODE? <CR>

~nn@MODE api_mode<CR>

api_mode

1 - solicited

Get API mode to

#MODE?<CR>

ACTION?

LOGIN

NOTE: The permiss ion

system works only if
security is enabled with
the “SECUR” command.
LOGIN allows the user to
run commands with an
End User or
Administrator permission
level.
When the permission
system is enabled,
LOGIN enables running
commands with the User
or Administrator
permission level
When set, login must be
performed upon each
connection
It is not mandatory to
enable the permission
system in or der to use
the device
In each device, some
connections allow
logging in to different
levels. Some do not work
with security at all.
Connection may logout

#LOGINlogin_level,passwor
d<CR>

ACTIONaction,period<C

R><LF>

~nn@LOGINlogin_level,
password ok<CR><LF>

action – One of

1 - Start, start logging
2 - Pause, pause logging but
keep log content
3 - Resume, resume the logging
4 - Reset, clear all current logs,
keep logging
period – Relevant for "start"(be
ignored by KDS7 Devices)
1 - Keep current
2 - Daily

login_level – Level of
permissions required (User or
Admin, only 'admin' is acceptable on
KDS7 devices).
password – Predefined password
(by PASS command). Default
password is 'admin'

Get log state:
#LOG-ACTION?<CR>

Set the protocol permission
level to Admin (when the
password defined in the
PASS command is 33333):

#LOGINadmin,33333<CR>

TIMEOUT

LOGOUT­TIMEOUT?

permission level.

NOTE: The permiss ion
system works only if
security is enabled with
the “SECUR” command.
For devices that support
security, LOGIN allows
the user to run
commands with an End
User or Administrator
permission level.
In each device, some
connections allow
logging in to different
levels. Some do not work
with security at all.
Connection may logout

permission level.

NOTE: Logs out from
End User or
Administrator permission

time.

time.

#LOGOUT-TIMEOUTtime<CR>

mode,log_server_ip,log_ser
ver_port<CR>

~nn@LOGINlogin_level<

CR><LF>

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

TIMEOUTtime<CR><LF>

TIMEOUTtime<CR><LF>

mode,log_server_ip,log_
server_port<CR><LF>

mode,log_server_ip,log_
server_port<CR><LF>

permissions required (User or
Admin, only 'admin' is acceptable on
KDS7 devices)

time – minutes of logout time

0 – Off
1 – On
log_server_ip – Log server IP
address

log_server_port

0 – Off
1 – On
log_server_ip – Log server IP
address

permission level:
#LOGIN?<CR>

to 10:
#LOGOUT-

TIMEOUT10<CR>

Get Inactivity auto-logout
time:

address of

128.138.140.44:5050:
#LOG-SRV
1,128.138.140.44,5050<CR>

#LOG-SRV?<CR>

0 - unsolicited

0 - unsolicited

solicited mode

solicited mode

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

93

Function

Description

Syntax

Response

Parameters/Attributes

Example

MODEL?

Get device model.

requests.

#MODEL?<CR>

Set machine or DANTE

on).

NAME?

Get machine or DANTE

on).

interface_id –

Get the DNS name of the

NAME-RST

Reset machine (DNS)

number.

#NAME-RST<CR>

~nn@NAME-

Reset the machine name

NET-CONFIG

Set a network

automatically.

netw_id – Network ID–ID of the

Set the device network

NET-

Get a network

netw_id – Network ID–ID of the

gateway

Get network configuration:

NET-DHCP

Set DHCP mode.

control port.

netw_id –Network ID–ID of the

Enable DHCP mode for port

NAME

NOTE: This command

identifies equipment
connected to KDS-17EN
and notifies of identity
changes to the
connected equipment.
The Matrix saves this
data in memory to
answer REMOTE-INFO

(DNS) name.

NOTE: The machine
name is not the same as
the model nam e. The
machine name is used to
identify a specific
machine or a network in
use (with DNS feature

(DNS) name.

NOTE: The machine
name is not the same as
the model nam e. The
machine name is used to
identify a specific
machine or a network in
use (with DNS feature

name to facto ry default.

NOTE: Factory default of
machine (DNS ) name is
“KRAMER_” + 4 last
digits of device serial

configuration.

NOTE: For Backward
compatibility, the id
parameter can be
omitted. In this case, the
Network ID, by default, is
0, which is the Ethernet
control port.

NOTE: 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.

NOTE: This set the
device to DHCP OFF

~nn@MODELmodel_name<C

R><LF>

#NAMEinterface_id,host_na
me<CR>

#NAME?interface_id<CR> ~nn@NAMEinterface_id,

~nn@NAMEinterface_id,
host_name<CR><LF>

host_name<CR><LF>

RSTOK<CR><LF>

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

~nn@NET-CONFIGnetw_id
,net_ip,net_mask,gatewa
y<CR><LF>

model_name – String of up to 24

printable ASCII chars

interface_id –
0 – machine name
1 – dante name – Only available on

KDS-SW3-EN7
host_name – String of up to 24
alpha-numeric chars (can include

hyphen, underscore, not at the
beginning or end)

0 – machine name
1 – dante name – Only available on

KDS-SW3-EN7
host_name – String of up to 24
alpha-numeric chars (can include

hyphen, not at the beginning or end)

Ethernet port:
0 - Media Port
1 - Service Port
2 - DANTE Port

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

Get the device model:
#MODEL?<CR>

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

#NAME0,room-442<CR>

device:
#NAME? 0<CR>

(S/N last digits are 0102):
#NAME-RST<CR>

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

13.10,255.255.0.0,192.168.0.
1<CR>

CONFIG?

configuration.

NOTE: 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 comma nd. 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.

NOTE: For Backward
compatibility, the id
parameter can be
omitted. In this case, the
Network ID, by default, is
0, which is the Ethernet

#NET-CONFIG?netw_id<CR> ~nn@NET-CONFIGnetw_id

#NET-DHCPnetw_id,dhcp_sta
te<CR>

,net_ip,net_mask,gatewa
y<CR><LF>

~nn@NET-DHCPnetw_id,d
hcp_state<CR><LF>

Ethernet port:
0 - Media Port
1 - Service Port
2 - DANTE Port

net_ip – Network IP
net_mask – Network mask

– Network gateway

Ethernet port:
0 - Media Port
1 - Service Port
2 - DANTE Port
dhcp_state –
1 - Try to use DHCP. (If unavailable,

use the IP address set by the
factory or the net-ip command).

#NET-CONFIG?0<CR>

1, if available:
#NET-DHCP1,1<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

94

Function

Description

Syntax

Response

Parameters/Attributes

Example

NET-DHCP?

Get DHCP mode

factory or the net-ip command).

Get DHCP mode for port 1, if

NET-IP?

Get a network IP

only.

#NET-IP?<CR>

net_ip – Network IP

Get network ip address:

NET-MAC?

Get MAC address.

#NET-MAC?<CR>

mac_address – Unique MAC

#NET-MAC?<CR>

Set NIC MTU Mode.

#NET-MTU mode<CR>

~nn@NET-MTU

1 - Jumbo MTU with 9018

NET-MTU?

Get NIC MTU Mode.

#NET-MTU?<CR>

~nn@NET-MTU

mode:

1 - Jumbo MTU with 9018

Set MTU mode:

NET-STAT?

Get net connection list of

#NET-STAT?<CR>

~nn@NET-

port_type – TCP/UDP

Get net connection list of this

,ESTABLISHED]<CR><LF>

PASS

Set password for login

login_level – Level of login to

Set the password for the

PASS?

Get password for login

– Level of login to

Get the password for the

PORT-

Set port direction as input

#PORT-

~nn@PORT-

The following attributes comprise

OUT – Output

Set audio analog port

PORT-

Get port direction.

#PORT-

~nn@PORT-

The following attributes comprise

Get audio analog port

NET-MTU

DIRECTION

NOTE: For Backward

compatibility, the id
parameter can be
omitted. In this case, the
Network ID, by default, is
0, which is the Ethernet
control port.

address.
This is an UDP protocol

this machine.

NOTE: The response is
returned in one line and
terminated
with<CR><LF>.
The response format lists
signal IDs separated by
commas.
This is an Ext ended
Protocol 3000 command.

level.
The default password is
"admin".

level.
The default password is
"admin".

or output.

#NET-DHCP?netw_id<CR> ~nn@NET-DHCPnetw_id,d

#PASSlogin_level,password

<CR>

#PASS?login_level<CR> ~nn@PASSlogin_level,p

DIRECTION<direction_type>
.<port_format>.<port_index
>.<signal_type>,direction<

CR>

hcp_state<CR><LF>

~nn@NET-IPnet_ip<CR><

LF>

~nn@NET-MACmac_addres
s<CR><LF>

mode<CR><LF>

mode<CR><LF>

STAT[(<port_type>:<po
rt_index>,<client_ip>:<
client_port>),state],..
,<CR><LF>

~nn@PASSlogin_level,p
assword<CR><LF>

assword<CR><LF>

DIRECTION<direction_t
ype>.<port_format>.<por
t_index>.<signal_type>,
direction<CR><LF>

netw_id –Network ID–ID of the

Ethernet port:
0 - Media Port
1 - Service Port
2 - DANTE Port
dhcp_state –
1 - Try to use DHCP. (If unavailable,
use the IP address set by the

address. Format: XX-XX-XX-XX-XX­XX where X is hex digit

mode:
0 – MTU with 1500

0 – MTU with 1500

0 - TCP
1 - UDP

port_index – Device port
client_ip – Dot-separated

representation of the IP address

client_port – Client port
state – listen or established

set (admin support only).
password – Password for
the login_level. 8 to 24 characters

(letters, numbers, and symbols
without spaces or commas), at least
including one number, one symbols
without spaces or commas, one
uppercase letter and one lowercase
letter.

login_level

set (End User or Administrator).
password – Password for
the login_level.

the signal ID:
<direction_type> – Direction of
the port:
IN – Input
OUT – Output
BOTH – Bi-directional
<port_format> – Type of signal
on the port:
ANALOG_AUDIO
IR
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
IR
<direction> – Direction of the
port:
IN – Input

available:
#NET-DHCP?1<CR>

#NET-IP?<CR>

Set MTU to standard 1500:
#NET-MTU 0<CR>

#NET-MAC?<CR>

machine:
#NET-STATE?<CR>

~01@NETSTAT[(TCP:80,0
.0.0.0:0),LISTEN],[(TCP:5000
,0.0.0.0:0), LISTEN],
[(TCP:80,192.168.114.3:5240

0),ESTABLISHED],[( TCP:500
0,192.168.1.100:51647)

admin protocol permission
level to 33333:

#PASSadmin,33333<CR>

admin protocol permission
level:

#PASS?admin<CR>

direction as input:
#PORT-

DIRECTIONboth.analog.1.
audio,IN<CR>

DIRECTION?

DIRECTION?<direction_type
>.<port_format>.<port_inde
x>.<signal_type><CR>

DIRECTION<direction_t
ype>.<port_format>.<por
t_index>.<signal_type>,
direction<CR><LF>

the signal ID:
<direction_type> – Direction of
the port:
IN – Input
OUT – Output
BOTH – Bi-directional
<port_format> – Type of signal
on the port:
ANALOG_AUDIO
IR
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
IR
<direction> – Direction of the port:
IN – Input
OUT – Output

direction:
#PORT-

DIRECTION?both.analog.1
.audio<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

95

Function

Description

Syntax

Response

Parameters/Attributes

Example

PORTS-

Get the port list of this

#PORTS-LIST?<CR>

The following attributes comprise

Reset device

reopen the port.

#RESET<CR>

ROLLBACK

Rollback firmware to

#ROLLBACK<CR>

>

Perform firmware rollback:

Start/stop P3K

the “SECUR” command.

SECUR?

Get P3K security state.

#SECUR?<CR>

1 - ON (enables security)

Get security state:

SET-MGR-IP

Set AVoIP Manager IP

#SET-MGR-IP mgrip<CR>

~nn@SET-MGR-IP

mgrip: AVoIP Manager IP

Manager IP enabled.

Set MGR-IP as 192.168.1.2:

SIGNALS-

Get signal ID list of this

#SIGNALS-LIST?<CR><LF>

The following attributes comprise

multiple channels of the same type

Get signal ID list:

SN?

Get device serial

#SN?<CR>

LF>

serial_num – 14 decimal digits,

Get the device serial number:

Set device time and date.

ss

LIST?

RESET

SECUR

machine.

NOTE: The response is
returned in one line and
terminated
with<CR><LF>.
The response format lists
port IDs separated by
commas.
This is an Ext ended
Protocol 3000 command.

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

standby version.

communication security.

NOTE: The permiss ion
system works only if
security is enabled with

~nn@PORTS-LIST[<direc
tion_type>.<port_format
>.<port_index>,..,]<CR>

<LF>

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

~nn@ROLLBACKok<CR><LF

#SECURsecurity_state<CR> ~nn@SECURsecurity_sta

te<CR><LF>

~nn@SECURsecurity_sta
te<CR><LF>

the port ID:
<direction_type> – Direction of
the port:
IN
OUT
BOTH
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
RS-232
IR
USB_A
USB_B
USB_C
STREAM
<port_index> – The port number
as printed on the front or rear panel

Reset the device:

security_state – Security state
0 - OFF (disables security)
1 - ON (enables security)

security_state – Security state
0 - OFF (disables security)

Get the ports list:
#PORTS-LIST?<CR>

#RESET<CR>

#ROLLBACK<CR>

Enable the permission
system:

#SECUR0<CR>

#SECUR?<CR>

LIST?

TIME

machine.

NOTE: The response is
returned in one line and
terminated
with<CR><LF>.
The response format lists
signal IDs separated by
commas.
This is an Ext ended
Protocol 3000 command.

number.

NOTE: 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.

#TIMEday_of_week,date,dat
a<CR>

mgrip<CR><LF>

~nn@SIGNALS-LIST[<dir
ection_type>.<port_form
at>.<port_label>.<signa
l_type>.<index>,]<CR><L

F>

~nn@SNserial_num<CR><

~nn@TIMEday_of_week,d
ate,data<CR><LF>

0.0.0.0 - means no AVoIP

the signal ID:
<direction_type> – Direction of
the port:
IN - Input
OUT - Output
BOTH - Bi-directional (e.g. for RS-

232)
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
RS-232
IR
USB_A
USB_B
USB_C
STREAM
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
VIDEO
AUDIO
RS232
IR
USB
<index> – Indicates a specific
channel number when there are

factory assigned

day_of_week – One of
{SUN,MON,TUE,WED,THU,FRI,SA
T}
date – Format: DD-MM-YYYY
where

YYYY = Year
MM = Month
DD = Day
data – Format: hh:mm:ss where
hh = hours
mm = minutes

= seconds

#SET-MGR-IP

192.168.1.2<CR>

#SIGNALS-LIST?<CR>

#SN?<CR>

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

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

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

96

Function

Description

Syntax

Response

Parameters/Attributes

Example

TIME?

Get device time and

#TIME?<CR>

ss

TIME-LOC

Set local time offset from

take effect

TIME-LOC?

Get local time offset from

time not support

#TIME-LOC?<CR>

utc_off – Offset of device time

Get local time offset from

TIME-SRV

Set time server.

mode – On/Off

server_status

Set time server with IP

TIME-SRV?

Get time server.

#TIME-SRV?<CR>

mode – On/Off

server_status

Get time server:

Set the device time

#TIME-ZONE

~nn@TIME-ZONE

command.

TIME-ZONE?

Get the device time

#TIME-ZONE?<CR>

~nn@TIME-ZONE

timezone_str – A string that

command.

Get the device time zone:

Get a list of time

command.

#TIME-ZONE-LIST? <CR>

~nn@TIME-ZONE-LIST

date.

NOTE: 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.

UTC/GMT.

NOTE: 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.

NOTE: Daylight saving
time not support

NOTE: Restart unit to

UTC/GMT.

NOTE: 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.

NOTE: Daylight saving

#TIME-LOCutc_off,dst_stat
e<CR>

~nn@TIMEday_of_week,d
ate,data<CR><LF>

~nn@TIME-LOCutc_off,d
st_state<CR><LF>

~nn@TIME-LOCutc_off,d
st_state<CR><LF>

day_of_week – One of

{SUN,MON,TUE,WED,THU,FRI,SA
T}

date – Format: DD-MM-YYYY
where

YYYY = Year
MM = Month
DD = Day
data – Format: hh:mm:ss where
hh = hours
mm = minutes

= seconds

utc_off – Offset of device time
from UTC/GMT (without daylight
time correction), Format HH:MM
(':MM' is optional)

HH - Hours, -12 ~ 13
MM - Minutes, 00 ~ 59
dst_state – Daylight saving time

state
0 - no daylight saving time

from UTC/GMT (without daylight
time correction), Format HH:MM
(':MM' is optional)

HH - Hours, -12 ~ 13
MM - Minutes, 00 ~ 59
dst_state – Daylight saving time

state
0 - no daylight saving time

Get device time and date:
#TIME?<CR>

Set local time offset to 3 with
no daylight-saving time:

#TIME-LOC3,0<CR>

or
#TIME-LOC03:00,0<CR>

UTC/GMT:
#TIME-LOC?<CR>

TIME-ZONE

TIME-ZONE­LIST?

NOTE: This command is

needed for setting UDP
timeout for the current
client list.

NOTE: This command is
needed for setting UDP
timeout for the current
client list.

zone.

zone.

zones.

Entries from the list
can be set as the
device time zone with
the TIME-ZONE

#TIME-SRVmode,time_server
_ip,sync_hour<CR>

timezone_str<CR>

~nn@TIME-SRVmode,time
_server_ip,sync_hour,se
rver_status<CR><LF>

~nn@TIME-SRVmode,time
_server_ip,sync_hour,se
rver_status<CR><LF>

timezone_str<CR><LF>

timezone_str<CR><LF>

list<CR><LF>

0 - Off
1 - On
time_server_ip – Time server IP
address
sync_hour – Hour in day for time
server sync

0 - Off
1 - On
time_server_ip – Time server IP
address
sync_hour – Hour in day for time
server sync

timezone_str – A string that
identifies the relevant time zone.
Available time zone strings can be
listed using the TIME-ZONE-LIST?

identifies the relevant time zone.
Available time zone strings can be
listed using the TIME-ZONE-LIST?

list – List of available time zones,
one per line. Example:
Africa/Abidjan,Africa/Accra,Africa/Ba
mako,...

– On/Off

– On/Off

address of 128.138.140.44 to
ON:
#TIME-

SRV1,128.138.140.44,0,1<

CR>

#TIME-SRV?<CR>

Set time zone to London,
England:
#TIME-ZONE
europe/london<CR>

#TIME-ZONE?<CR>

Get a list of available time
zones:
#TIME-ZONE-LIST?<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

97

Function

Description

Syntax

Response

Parameters/Attributes

Example

UART

Set com port

serial_type is 485)

Set baud rate to 9600, 8 data

UART?

Get com port

com_id – 1 to n (machine

Set baud rate to 9600, 8 data

UPG-TIME?

Get firmware version last

7

#UPG-TIME?<CR>

~nn@UPG-

Get last upgrade date/time:

UPGRADE

Perform firmware

complete the process.

#UPGRADE<CR>

Perform firmware upgrade:

VERSION?

Get firmware version

#VERSION?<CR>

firmware_version –

are: major.minor.build version

Get the device firmware

#VERSION?<CR>

VIDEO-

Define device video wall

#VIDEO-WALL-

~nn@VIDEO-WALL-

out_id – Number of output (1-

3 - 270 degrees

Set video alignment:

VIDEO-

Get device video wall

#VIDEO-WALL-SETUP?<CR>

~nn@VIDEO-WALL-

out_id – Number of output (1-

3 - 270 degrees

Get video alignment:

Set view mode. In case

10000.

configuration.

NOTE: In the FC-2x the
serial port is selectable to
RS-232 or RS-485
(usually serial port 1).
If Serial is configured
when RS-485 is
selected, the RS-485
UART port automatically
changes.
The command is
backward compatible,
meaning that if the extra
parameters do not exist,
FW goes to.
RS-232.
Stop_bits 1.5 is only
relevant for 5 data_bits.

configuration.

NOTE: In the FC-2x the
serial port is selectable to
RS-232 or RS-485
(usually serial port 1).
If Serial is configured
when RS-485 is
selected, the RS-485
UART port automatically
changes.
The command is
backward compatible,
meaning that if the extra
parameters do not exist,
FW goes to.
RS-232.
Stop_bits 1.5 is only
relevant for 5 data_bits.

upgrade date/time Add
New Command for KDS-

#UARTcom_id,baud_rate,dat
a_bits,parity,stop_bits_mo
de,serial_type,485_term<CR

>

#UART?com_id<CR> ~nn@UARTcom_id,baud_r

~nn@UARTcom_id,baud_r
ate,data_bits,parity,st
op_bits_mode,serial_typ
e,485_term<CR><LF>

ate,data_bits,parity,st
op_bits_mode,serial_typ
e,485_term<CR><LF>

TIMEdate,data<CR><LF>

com_id – 1 to n (machine

dependent)

baud_rate – 9600 - 115200
data_bits – 5-8
parity – Parity Type

0 - No
1 - Odd
2 - Even

stop_bits_mode – 1/1.5/2
serial_type – 232/485

0 - 232
1 - 485
485_term – 485 termination state
0 - disable
1 - enable
(optional - this exists only when

dependent)

baud_rate – 9600 - 115200
data_bits – 5-8
parity – Parity Type

0 - No
1 - Odd
2 - Even

stop_bits_mode – 1/1.5/2
serial_type – 232/485

0 - 232
1 - 485
485_term – 485 termination state
0 - disable
1 - enable
(optional - this exists only when

serial_type is 485)

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

bits, parity to none and stop
bit to 1:

#UART9600,8,node,1<CR>

bits, parity to none and stop
bit to 1:

#UART1,9600,8,node,1<C

R>

#UPG-TIME?<CR>

WALL­SETUP

WALL­SETUP?

VIEW-MOD

upgrade.

NOTE: Not necessary for
some devices.
Firmware usually uploads
to a device via a
command like LDFW.
Reset the device to

number.

relative pos ition and
video alignm ent.
For KDS-17DEC

NOTE: MUST setup with
"#VIEW-MOD 15" or
"#VIEW-MOD 16" to
video wall mode firstly

relative pos ition and
video alignm ent.
For KDS-17DEC

of KDS -7 only Video wall
mode is suppo rted.
Second and third
parameters are “mode”
specific. In case of video
wall, they define video
wall layout, use "VIEW­MOD 15,1,1" for
disabling video wall.
For KDS-17DEC

SETUPout_id,rotation<CR>

#VIEW-MODmode,vw_hsize,vw
_vsize<CR>

or

#VIEW-MODmode,x1,y1,x2,y2

<CR>

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

~nn@VERSIONfirmware_v
ersion<CR><LF>

SETUPout_id,rotation<

CR><LF>

SETUPout_id,rotation<

CR><LF>

~nn@VIEW-MODmode<CR><

LF>

XX.XX.XXXX where the digit groups

256), =1 when view mode is 16
rotation – Rotation degrees in
clockwise
0 - 0 degrees
1 - 90 degrees
2 - 180 degrees

256), =1 when view mode is 16
rotation – Rotation degrees in
clockwise
0 - 0 degrees
1 - 90 degrees
2 - 180 degrees

mode – View Modes
15 - Video wall
16 - Mosaic style video wall
vw_hsize – video wall horrible
size, only required when mode is 15
vw_vsize – video wall vertical size,
only required when mode is 15

(x1, y1) - will be the virtual
coordinates of top left position, only
required when mode is 16
(x2, y2) - will be the virtual
coordinates of bottom right position,
only required when mode is 16
the range for x1, y1, x2, y2 is: 0 ~

#UPGRADE<CR>

version number:

#VIDEO-WALL­SETUP10,1<CR>

#VIDEO-WALL­SETUP?<CR>

Set view mode to a 2x2 grid
video wall:

#VIEW-MOD15,2,2<CR>

Set view mode to a mosaic
style video wall for show 1/4
top left image:
#VIEW-

MOD16,0,0,5000,5000<CR

>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

98

Function

Description

Syntax

Response

Parameters/Attributes

Example

VIEW-MOD?

Get view mode. In case

#VIEW-MOD?<CR>

10000.

WND-

Set video wall stretch.

#WND-

~nn@WND-

out_index – Number that

1 - fit out

Set Video Wall Stretch Type

WND-

Get video wall stretch.

#WND-

~nn@WND-

out_index – Number that

1 - fit out

Get Video Wall Stretch Type:

Get audio signal info.

#X-AUD-

~nn@X-AUD-

TrueHD, DTS HD Master Audio.

X-AUD-LVL

Set audio level of a

#X-AUD-

The following attributes comprise

between 0 to 100)

Set the audio level of a

STRETCH

STRETCH?

X-AUD­DESC?

of KDS -7 only Video wall
mode is suppo rted.
For KDS-17DEC

For KDS-17DEC

For KDS-17DEC.

NOTE:
+ This is an Extended
Protocol 3000 command.
+ On KDS7 only support
active port, so for KDS­SW2-EN7, KDS-SW3­EN7, WP-SW2-EN7 ,
<port_format> HDMI also
identify the USB-C audio
format if USB-C is active.

STRETCHout_index,mode<CR>

STRETCH?out_index<CR>

DESC?<direction_type>.<po

rt_format>.<port_index><CR

>

~nn@VIEW-MODmode,vw_h
size,vw_vsize <CR><LF>

or

~nn@VIEW-MODmode,x1,y
1,x2,y2<CR><LF>

STRETCHout_index,mode

<CR><LF>

STRETCHout_index,mode

<CR><LF>

DESC?<direction_type>
.<port_format>.<port_in
dex>.<signal_type>.<ind
ex>,ch_tot,samp_rate,au
d_format<CR><LF>

mode – View Modes

15 - Video wall
16 - Mosaic style video wall
vw_hsize – video wall horrible
size, only required when mode is 15
vw_vsize – video wall vertical size,
only required when mode is 15

(x1, y1) - will be the virtual
coordinates of top left position, only
required when mode is 16
(x2, y2) - will be the virtual
coordinates of bottom right position,
only required when mode is 16
the range for x1, y1, x2, y2 is: 0 ~

indicates the specific output 1-256:
1-N (N= the total number of outputs)
mode – Strech mode:
0 - fit in

indicates the specific output 1-256:
1-N (N= the total number of outputs)
mode – Strech mode:
0 - fit in

The following attributes comprise
the signal ID:
<direction_type> – Direction of
the port:
IN - Input
OUT - Output
BOTH - Bi-directional (e.g. for RS-

232)
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
STREAM
DANTE – Only available on KDS-

SW3-EN7
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
<index> – Indicates a specific
channel number when there are
multiple ch_tot – Total number of
channels

samp_rate – Sample rate
aud_format – Audio Format:

LPCM - Linear Pulse Code
Modulation audio
Non-LPCM - None Linear Pulse
Code Modulation audio, like Dolby
Digital, DTS, etc.
HBR - High Bitrate Audio, like Dolby

Get view mode:
#VIEW-MOD?<CR>

is Fit In:
#WND-STRETCH1, 0<CR>

#WND-STRETCH?1<CR>

Get the audio signal info:
#X-AUD-

DESC?out.hdmi.1<CR>

specific signal.

NOTE: This is an
Extended Pr otocol 3000
command.

LVL<direction_type>.<port
_format>.<port_index>.<sig
nal_type>.<index>,audio_le
vel<CR>

~nn@X-AUD-LVL<directi
on_type>.<port_format>.
<port_index>.<signal_ty
pe>.<index>,audio_level

<CR><LF>

the signal ID:
<direction_type> – Direction of
the port:
OUT – Output
<port_format> – Type of signal
on the port:
ANALOG_AUDIO
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
<index> – Indicates a specific
channel number when there are
multiple channels of the same type
audio_level – Audio level (range

specific signal to 80:
#X-AUD-

LVLin.analog_audio.1.audi
o.1,80<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

99

Function

Description

Syntax

Response

Parameters/Attributes

Example

X-AUD-LVL?

Get audio level of a

#X-AUD-

~nn@X-AUD-

The following attributes comprise

between 0 to 100)

Get the audio level of a

X-AV-SW-

Set auto-switch mode per

#X-AV-SW-

~nn@X-AV-SW-

The following attributes comprise

Set auto switch mode for

X-AV-SW-

Get auto-switch mode.

#X-AV-SW-

~nn@X-AV-SW-

2 - last connected

Set mute ON/OFF on a

#X-

~nn@X-

MODE

MODE?

specific signal.

NOTE: This is an
Extended Pr otocol 3000
command.

output.

NOTE: This is an
Extended Pr otocol 3000
command.

NOTE: This is an
Extended Pr otocol 3000
command.

LVL?<direction_type>.<por
t_format>.<port_index>.<si
gnal_type>.<index><CR>

MODE<direction_type>.<por
t_format>.<port_index>.<si
gnal_type>.<index>,connect
ion_mode<CR>

MODE?<direction_type>.<po
rt_format>.<port_index>.<s
ignal_type>.<index><CR>

LVL<direction_type>.<
port_format>.<port_inde
x>.<signal_type>.<index
>,audio_level<CR><LF>

MODE<direction_type>.
<port_format>.<port_ind
ex>.<signal_type>.<inde
x>,connection_mode<CR><

LF>

MODE<direction_type>.
<port_format>.<port_ind
ex>.<signal_type>.<inde
x>,connection_mode<CR><

LF>

the signal ID:
<direction_type> – Direction of
the port:
OUT – Output
<port_format> – Type of signal
on the port:
ANALOG_AUDIO
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
<index> – Indicates a specific
channel number when there are

multiple channels of the same type
audio_level – Audio level (range

the signal ID:
<direction_type> – Direction of
the port:
OUT – Output
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
STREAM
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
VIDEO
AUDIO
<index> – Indicates a specific
channel number when there are
multiple channels of the same type
connection_mode – Connection
mode
0 - manual
1 - priority
2 - last connected

The following attributes comprise
the signal ID:
<direction_type> – Direction of
the port:
OUT – Output
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
STREAM
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
VIDEO
AUDIO
<index> – Indicates a specific
channel number when there are
multiple channels of the same type
connection_mode – Connection
mode
0 - manual
1 - priority

specific signal:
#X-AUD-

LVL?out.analog_audio.1.au
dio.1<CR>

HDMI OUT 1 (last
connected):

#X-AV-SW­MODEout.hdmi.1.video.1,2

<CR>

Get auto switch mode for
HDMI OUT 1:
#X-AV-SW-

MODE?out.hdmi.1.video.1

<CR>

X-MUTE

specific signal.

Note: For KDS-17EN,
HDMI, STREAM mute
will effect each other,
and if the
HDMI/STREAM is mute,
analog_audio will be
mute too. It is a
limitation.

MUTE<direction_type>.<por
t_format>.<port_index>.<si
gnal_type>.<index>,state<C

R>

MUTE<direction_type>.
<port_format>.<port_ind
ex>.<signal_type>.<inde
x>,state<CR><LF>

<direction_type> – Direction of

the port:
OUT – Output
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
STREAM
ALL – All audio output
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
<index> – Indicates a specific
channel number when there are
multiple channels of the same type
state – OFF/ON (not case
sensitive)

Mute the audio on HDMI
OUT 1:

#X-MUTEout.hdmi.1.audio.
1,on<CR>

Mute the audio on ALL OUT:
#X-MUTEout.all.1.audio.1,o

n<CR>

Kramer Electronics Ltd.

KDS-17EN / KDS-17DEC – Protocol 3000

100

Function

Description

Syntax

Response

Parameters/Attributes

Example

X-MUTE?

Get mute ON/OFF on a

#X-

~nn@X-

sensitive)

Get the mute state of audio

X-PRIORITY

Set priority order.

#X-

~nn@X-

<direction_type> – Direction of

AUDIO

Set video priority is 3,2,1:

X-PRIORITY?

Get priority order.

#X-

~nn@X-

<direction_type> – Direction of

AUDIO

Get video priority:

X-ROUTE

Send routing command.

[a,b,c,d].

The following attributes comprise

Route HDMI IN 2 to HDMI

specific signal.

MUTE?<direction_type>.<po
rt_format>.<port_index>.<s
ignal_type>.<index><CR>

PRIORITY<direction_type>.
<port_format>.<port_index>
.<signal_type>,[<direction
_type>.<port_format>.<port
_index>.<signal_type>
,...]<CR>

PRIORITY?<direction_type>
.<port_format>.<port_index
>.<signal_type><CR>

MUTE<direction_type>.
<port_format>.<port_ind
ex>.<signal_type>.<inde
x>,state<CR><LF>

PRIORITY<direction_ty
pe>.<port_format>.<port
_index>.<signal_type>,[
<direction_type>.<port_
format>.<port_index>.<s
ignal_type>
,...]<CR><LF>

PRIORITY<direction_ty
pe>.<port_format>.<port
_index>.<signal_type>,[
<direction_type>.<port_
format>.<port_index>.<s
ignal_type>
,...]<CR><LF>

<direction_type> – Direction of

the port:
OUT – Output
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
STREAM
ALL – All audio output
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
AUDIO
<index> – Indicates a specific
channel number when there are

multiple channels of the same type
state – OFF/ON (not case

the port:
IN - Input
OUT - Output
<port_format> – Type of signal
on the port:
HDMI
USB_C
ANALOG_AUDIO
STREAM
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
VIDEO

the port:
IN - Input
OUT - Output
<port_format> – Type of signal
on the port:
HDMI
USB_C
ANALOG_AUDIO
STREAM
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
VIDEO

on HDMI OUT 1:
#X-MUTE?out.hdmi.1.audi

o.1<CR>

#X­PRIORITYout.hdmi.1.video

,[in.usb_c.3.video,in.hdmi.2.vi
deo, in.hdmi.1.video]<CR>

#X­PRIORITY?out.hdmi.1.vide

o<CR>

NOTE: It is
recommended to use the
command #SIGNALS­LIST to get the list of all
signal IDs available in
the system and which
can be used in this
command.
Video 1 is the default port
in this command and is
implied even if not
written:
#X-ROUTE
out.hdmi.1,in.hdmi.1<CR

>

is interpreted as:
#X-ROUTE
out.hdmi.1.video.1,in.hd
mi.1.video .1<CR>

This is an Ext ended
Protocol 3000 command.

Brackets ‘[‘ and
‘]’ are reserved
Protocol 3000
characters that
define a list of
parameters as in

#X-ROUTE[<direction_type1
>.<port_type1>.<port_index
1>.<signal_type1>.<index1>
,...],<direction_type2>.<p
ort_type2>.<port_index2>.<
signal_type2>.<index2><CR>

~nn@X-ROUTE[<directio
n_type1>.<port_type1>.<
port_index1>.<signal_ty
pe1>.<index1>,…],<direc
tion_type2>.<port_type2
>.<port_index2>.<signal
_type2>.<index2><CR><LF

>

the signal ID:
<direction_type> – Direction of
the port:
IN - Input
OUT - Output
BOTH - Bi-directional (e.g. for RS-

232)
<port_format> – Type of signal
on the port:
HDMI
ANALOG_AUDIO
STREAM
DANTE – Only available on KDS-

SW3-EN7
<port_index> – The port number
as printed on the front or rear panel
<signal_type> – Signal ID
attribute:
VIDEO
AUDIO
<index> – Indicates a specific
channel number when there are
multiple channels of the same type

OUT 1:
#X-ROUTEout.hdmi.1.vide

o.1,in.hdmi.2.video.1<CR>

Route audio of
hdmi.1.audio.1 signal to hdmi
output, analog,and dante:

#X-ROUTE[out.hdmi.1.audi
o.1,out.analog_audio.1.audio.
1,out.dante.1.audio.1],in.hdmi
.1.audio.1<CR>