Kramer KDS-EN6 User manual

P/N: 2900-301422 Rev 1 www.kramerAV.com
API Guide
MODEL:
KDS-EN6, KDS-DEC6
Application Programming Interface
P/N:
2900-301422
Rev:
1
SAFETY WARNING
Disconnect the unit from the power supply before opening andservicing
For the latest information on our products and a list of Kramer distributors, visit our Web site where
updates to this user manual may be found.
We welcome your questions, comments, and feedback.
www.KramerAV.com
[e-mail]

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Contents
i
Contents
Introduction 2
Overview 2
Astparam APIs Overview 3
Accessing Astparam 4
Start/Stop KMoIP [KDS-DEC6] 4
Console APIs 5
Switch Channel [KDS-DEC6] 5
Stop Link [KDS-DEC6] 7
Get Video Manager State 7
Get Attached Client IP [KDS-EN6] 8
Example 9
Astparam APIs 10
Generic 10
IP Network Setting 10
Video over IP 12
Video Wall 13
HDCP 13
Audio 14
IR over IP 14
Serial over IP 15
CEC over IP 15

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Introduction
2
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!
Overview
This document describes the commands that can be used for KDS-6 console for managing
USB. KDS-6 uses Linux OS and the console is operated by a BusyBox shell. API supports
KDS-6 firmware versions 7.2 and above.
Defaults:
•Telnet port: 24.
•User name: "admin"
•Password: “admin” to log in.
Terms
•Commands starting with "$" –Console commands executed under the Linux shell
console. The default value of multicast IP (multicast_ip) is 225.0.10x.xxx. Please use this
multicast_ip value.
•The ‘ast_send_event -1 xxx’ command has a new shortcut named ‘e’. All of the
following ‘ast_send_evnt -1 xxx’ commands can be replaced with the shortcut command
like ‘e xxx’. They are exactly the same.
•USBoIP (USB over IP) extension function.
A ‘transparent’ type of ‘USB over IP’ extension function. Comparing to ‘KMoIP’ which is
‘emulation’ type.
•KMoIP (Keyboard/Mouse over IP) extension function.
A USB extension, but uses ‘emulation’ technology instead of ‘transparent’ USBoIP,
optimized for USB Interrupt mode of work, guarantee quick responses.
•Host - KDS-EN6
•Client –KDS-DEC6

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Introduction
3
Command Syntax Conventions
Following table describes the syntax used with the commands in this document.
Convention
Description
boldface
Commands and keywords.
italic
Command input that is supplied by you.
[x]
Keywords or parameters that appear within square brackets are optional.
{x}
Keywords or parameters within braces must be entered.
x|y
Keywords or parameters separated by a vertical bar require you to choose one option.
x||y
Keywords or parameters separated by a double vertical bar allow you to choose any or
all the options.
All commands and parameters are case sensitive.
“/ # “ in a command example refers to a command prompt and is not part of the command.
To access the console using Telnet
Every KDS-6 host/client FW has Telnet and a Telnet client built in. A developer can use KDS-
6's Telnet client to connect to any other KDS-6 board or write their own program using Telnet
protocol to connect to any KDS-6 board through the Ethernet network.
•Default is Telnet port 24.
•Use "root" to log in.
•No password is required.
Astparam APIs Overview
KDS-6 series firmware includes many firmware features that are configurable. Most of the
configuration is done by the “Configuration APIs” (called “Astparam”). Astparam is the console
command to access these system configurations. We also name these system configuration
as Astparam.
Astparam can be saved in flash ROM. So that system configuration is not lost after a system
power failure.
The Astparam format is simply a key=value string pair. Both the “key” and “value” are ANSI
strings and case sensitive. The firmware decides how to use it. The firmware does not
validate the Astparam, so any typed error could cause unexpected results.
All configuration modifications are saved in RAM until astparam save command is called.

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Accessing Astparam
4
Accessing Astparam
The most fundamental and powerful way to access Astparam is through the Astparam
Console API command. Most alternative approaches are just a wrap of Astparam commands.
To learn more about Console API commands and how to use console APIs, see Console
APIs on page 5) or reference the “Console APIs v2” document.
To use Astparam:
$ astparam OPTIONS [KEY] [VALUE]
OPTIONS:
•g: read from RW partition cache file. [KEY] is required.
•s: write to RW partition cache file (not saved to flash ROM yet). [KEY] and [VALUE] are
required. If [VALUE] is empty the [KEY] is removed.
•flush: clear all settings in RW partition cache file including random generated MAC
address. "./astparam save" is needed to clear all settings in flash ROM.
•dump: dump all parameters in RW partition cache file.
•save: save all parameters in RW partition cache file into flash ROM.
Start/Stop KMoIP [KDS-DEC6]
In order to manage KMoIP use np_kmoip Astparam:
Key
Description
Value (bold is FW default)
Decoder/Encoder
no_kmoip
Enable/disable KMoIP function.
y: disable KMoIP
n: enable KMoIP
Decoder/Encoder
Syntax [Start]
>>astparam s no_kmoip n
Syntax [Stop]
>>astparam s no_kmoip y
Usage Information:
•This command is for KMoIP.
•This command is used for runtime control.

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Console APIs
5
Console APIs
Switch Channel [KDS-DEC6]
Command client to connect to a specified channel. For API backward compatibility and easier
usage, this command has 3 syntax formats. Channel can be specified by channel number (ch-
select) or host’s ip address (host-ip-addr).
Syntax [legacy, refresh current connection] e e_reconnect
Syntax [specify channel, apply to all services] e e_reconnect:: {ch-select|host-ip-addr}
Parameters
•ch-select:
▪Enter 4 digit decimal number from 0000 to 9999. It must be in 4 digit format
prepending with 0.
Example: 0000, 0001, 0100, 1000, 3456, 1342, 8888, 9999….
▪Default value: Determined from on-board 4-bits DIP switch. Since it is 4-bits 0 or 1, it
can only represent 16 channels in total. They are 0000, 0001, 0010, 0011, 0100,
0101,..., 1111. Default values are also interpreted as decimal number instead of
binary value.
•host-ip-addr:
▪Enter an IP address in dotted decimal format. Used to specify the host’s IP address
to connect to.
Example: 169.254.11.22
▪{{Z}|{v||u||a| }}:
Used to specify which function to apply.
v: video over IP
u: USB over IP
a: Audio over IP
Z: all features except video over IP
Usage Information
•Command supports ch-select from 0000 to 9999, which means there are maximum
10000 host channels can be used.
•To simplify configuration process, FW will automatically map
•‘channel’ to ‘multicast IP’. Users don’t have to specify ‘multicast IP’.
•For a trick to improve video switching time, please see Ex5 in following examples
section.

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Console APIs
6
Version History
FW >= A7.0.0
Examples
Ex1: Start connect all services to ‘current’ channel. ‘current’ channel is by default got from on-
board 4-bits DIP switch. Only this command triggers FW to re-read 4-bits DIP switch value.
/ # e e_reconnect
/ #
Ex2: Start connect all services to channel ‘9810’.
/#e e_reconnect::9810
/ #
Ex3: Above command equals to following command:
/#e e_reconnect::9810::Z
/ #
Ex4: Start connect ‘video over IP’ to channel ‘9810’. The others use ‘current’ channel.
/#e e_reconnect::9810::v
/ #
Ex5: Use following command (without specifying ‘functions’) can switch video under only 1
second.
/#e e_reconnect::1222
/ #
Ex8: Connect ‘USB over IP’ to ‘169.254.2.3’
/ # e e_reconnect::169.254.2.3::u
/ #
"Switchto X", where X=Channel number command is a legacy command being used for
switch channel. It is still being supported but we strongly encourage to use e_reconnect
command instead. Its support will be discontinued in the next KDS-6 major release.

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Console APIs
7
Stop Link [KDS-DEC6]
Used to stop services.
Syntax [stop all] e e_stop_link
Usage Information
•All services will be stopped.
•Client’s ‘e_stop_link’ state will NOT persist between client reboot.
Version History
FW >= A7.0.0
Examples
Ex1: Stop services.
/#e e_stop_link
/ #
Get Video Manager State
Syntax lmparam g STATE
Result
•Encoder
▪s_init: System is under initialization.
▪s_idle: System is idle. Services are stopped.
▪s_attaching: Services are started, but no client attached or no video source.
▪s_srv_on: Services are started.
▪s_error: Fatal error.
•Decoder
▪s_init: System is under initialization.
▪s_idle: System is idle. Services are stopped.
▪s_srv_on: Services are started.
▪s_error: fatal error.
Example
Ex1: Get video manager current state.
/# lmparam g STATE
s_srv_on
/#

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Console APIs
8
Get Attached Client IP [KDS-EN6]
Syntax lmparam g USB_CLIENT_IP
Result
•xxx.xxx.xxx.xxx: Return the IP address of last requested USBoIP client. If there is no one
requested, it returns ‘0.0.0.0’.
Usage Information
Version History
FW >= A7.0.0
Examples
Ex1: Get current USBoIP status. Current requested client’s IP is ‘169.254.10.167’.
/#lmparam g USB_CLIENT_IP
169.254.10.167/ #

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 –Example
9
Example