Kramer KDS-EN6 User manual

P/N: 2900-300839 Rev 1 www.KramerAV.com
API Guide
MODEL:
KDS-EN6, KDS-DEC6

KDS-EN6, KDS-DEC6 - Overview
i
Contents
Overview 1
Terms 1
How to Access the Console 2
Astparam Configuration API 3
Overview 3
How to Access astparam 4
List of astparams 5
Getting KDS-6 Board's IP Address 24
Application Scenario: 25
FAQs: 26
Generic Configuration: 26
Unicast (KVM over IP) 32
Multicast (M to 1 group) 32
Multicast (M to N group) 33
IIC 33
UART 34
Console APIs 36
Debug Console APIs 36
Link Manager APIs 37
Video Over IP Driver Statistic/Control APIs 37
Display Driver Statistic/Control APIs 38
OSD APIs 38
Configurations APIs 40
IIC APIs 41
UART Port 1 APIs 41
Configuration Option List 42

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Overview
1
Overview
This document describes the commands that can be used for KDS-6 console. KDS-6 uses
Linux OS and the console is operated by BusyBox shell.
Using console APIs, developers can control KDS-6 firmware and extend the product's features
and capabilities.
Kramer KDS
-6 is based on Aspeed A6.4.3 firmware.
Default is Telnet port 24
.
Use "root" to log in.
No password is required.
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.

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Overview
2
How to Access the Console
•Telnet
Every KDS-6 host/client FW has Telnet and a Telnet client built in. a developer can use
one 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.
•Web UI
Use this approach when you need to modify astparam and prefer to enter commands via a
web interface instead of a console.
To modify astparam via a web interface:
1. Connect to the device’s Web UI
2. Enter astparam commands in “System->Utilities->Console API command:”
Note: You can enter multiple commands in a single line, separated by a semicolon (;).

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
3
Astparam Configuration API
Overview
KDS-6 firmware includes many configurable features. Most of the configuration are done using
the “Configuration API” called astparam. astparam is the console command to access these
system configurations.
astparam can be saved in flash ROM, so that system configuration is not lost when the system
loses power. Typical applications of astparam are:
•Enable/disable firmware features like serial over IP or video wall.
•Configure factory default firmware features on a production line.
•Prepare an SPI flash image for production, including default astparam settings.
•Enable/Disable firmware features on end customer side.
The format of astparam is a key=value string pair. For example, a astparam:
“en_video_wall=y” means astparam key “en_video_wall”’s value is “y”. Both “key” and “value”
are ANSI string and case sensitive. The firmware decides how to use it.
Note: The firmware does not validate the astparam. So, any type error could cause
unexpected results. The advantage is that a user can add any astparam key/value pair, even if
KDS-6’s reference firmware doesn’t need it. Both RO and RW astparams can be modified or
even removed.
The firmware reserves two flash partitions for system configuration. One is read only (RO) the
other is read-write (RW).
Note: BOTH ‘RO’ and ‘RW’ partitions are actually read/writable. Their usage is just defined
differently.
The firmware treats the setting in the RO partition as the system’s factory default settings. It is
recommended to save non-factory default changes in the RW partition (including the random
ethaddr). When firmware boots up, it takes astparam in the following priority order: RW > RO >
firmware default. Firmware uses the value in RW if the astparam exists. If the astparam is not
available in RW partition, then the value in RO partition is used. Firmware hard coded value is
used only when the astparam doesn’t exist in both RO and RW partition.
When the firmware starts up, both RO and RW configurations are read from flash and saved in
RAM.
Note: All configuration modifications are saved in RAM until the "astparam save [ro]"
command is called.

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
4
The process of "reset_to_default.sh" erases the RW partition but keeps the 'ethaddr' value (by
rewriting it after partition erase.). Since everything in the RW is gone, the firmware takes
values from the RO partition, which is the 'factory default'.
How to Access astparam
The most fundamental and powerful way to access astparam is through the “astparam”
Console API command. Most of alternative approaches are just a wrap of the “astparam”
command.
$ astparam OPTIONS [KEY] [VALUE]
OPTIONS
•r : read from RO partition cache file. [KEY] is required.
•w: write to RO partition cache file (not save to flash ROM yet). [KEY] and [VALUE] are
required. If [VALUE] is empty the [KEY] will be removed.
•g : read from RW partition cache file. [KEY] is required.
•s : write to RW partition cache file (not save to flash ROM yet). [KEY] and [VALUE] are
required. If [VALUE] is empty the [KEY] will be 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.
•dump ro: dump all parameters in RO partition cache file.
•dd: dump all parameters in RW partition directly from flash ROM.
•dd ro: dump all parameters in RO partition directly from flash ROM.
•save: save all parameters in RW partition cache file into flash ROM.
•save ro: save all parameters in RO partition cache file into flash ROM.
Examples:
•Read "ip_mode" setting from RO partition cache file:
$./astparam r ip_mode
•Read "ip_mode" setting from RW partition cache file:
$./astparam g ip_mode
•Write "ip_mode" setting as "autoip" to RW partition cache file:
$./astparam s ip_mode autoip
•Clear all settings in RW partition cache file:
$./astparam flush
•Clear ip_mode setting in RW partition cache file:
$./astparam s ip_mode
•Write RW partition cache file back to SPI flash ROM’s RW partition:

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
5
$./astparam save
•Write RO partition cache file back to SPI flash ROM’s RO partition:
$./astparam save ro
List of astparams
Generic Settings
Key
Description
Value
(bold is default)
Host/
Client
scenario
pc2tv:
usb_only:
H/C
astaccess
Host: ‘y’ boot up default accept connection
from client.
Client: ‘y’ boot up default auto connect to
host.
y:
n:
H/C
multicast_on
Configure casting mode
y: Multicast mode
n: Unicast mode
H/C
ui_feature
y:
n:
C
ignore_e_button_link
y:
n:
H/C
ignore_e_button_link
_1
y:
n:
H/C
pwr_led_type
default:
share_usb:
H/C
en_log
‘y’ show debug message on debug
console.
y:
n:
H/C
stop_on_boot_test_fa
il
y:
n:
H/C
telnetd_param
‘-p 24’: use IP port 24.
-p 24
H/C
lm_link_off_timeout
15: 15 seconds
C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
6
Key
Description
Value
(bold is default)
Host/
Client
cs_gpio_inv
[>= A5.3.3] Invert 4-bits DIP switch value.
Default value is '0000', means all 4bits
(CH0,CH1,CH2,CH3) no invert. To invert
CH1, for example, set the value to '0100'.
0000
H/C
soc_op_mode
[>= AST1520][>= A6.2.0] Config backward
compatibility mode.
0: as it is
1: AST1500
compatible
2: AST1510
compatible
H/C
web_ui_cfg
Used to customize Web UI. The default
value is automatically generated based on
enabled functions during first time boot up.
The value is a series of characters:
e: essential functions (can’t be disabled)
n: network
v: video
w: video wall
a: audio (i2s)
u: usb
s: serial over ip
r: IR
Character order does not matter.
Example 1: To enable all UI elements, set
the value to ‘envwausr’.
Example 2: 'envas' means show ‘essential
functions’, 'network', 'video', 'audio', and
'serial over ip' modules.
C
board_revision
[>= AST1520] Used to indicate firmware
different kind of HW board design.
300: [Host] AST152x v1.x reference board.
301: [Host] AST1520 v2.x splitter loopback
design with HDCP 2.2 support
300:
301:
H

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
7
Key
Description
Value
(bold is default)
Host/
Client
ui_default_res
[>= A6.1.0] Change the bootup and GUI
default resolution. Default resolution is
640x480@60Hz.
Note: System reboot is required for
ui_default_res to be applied.
640x480@60
C
ui_show_text
‘y’ to display diagnostic information on the
bottom of the GUI. ‘n’ to hide it.
y: Display
n: Hide
C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
8
IP Network Setting
Key
Description
Value
(bold is default)
Host/
Client
ip_mode
static:
dhcp:
autoip:
H/C
ipaddr H/C
netmask
H/C
gatewayip
[> A 1.38]
H/C
hostname_prefix
ast: For AST1500
ast2: For AST1510
ast3: For AST1520
H/C
hostnamebydipswitch
Use default hostname_id based on 4-bits
DIP switch.
Host default is ‘y’
Client default is ‘n’
y:
n:
H/C
hostname_id
Overwrite “hostnamebydipswitch”
H/C
multicast_ip H/C
ch_select
H/C
reset_ch_on_boot
Resets link related astparam on boot, to
prevent the user from entering the wrong
channel setting. The following astparam
is cleared to the default value:
ch_select
multicast_ip
hostname_id
y: enable
n: disable
H/C
jumbo_mtu
[>= AST1510]
1500:
8000:
H/C
multicast_ip_prefix Uses a different multicast IP prefix.
Default value is ‘225.0.10’ which means
multicast IP is ‘225.0.10x.xxx’ where x’s
value depends on 4-bits DIP switch.
225.0.10 H/C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
9
Button: (> A3.2)
Key
Description
Value
(bold is default)
Host/
Client
btn1_short
H/C
btn1_long
H/C
btn1_short_on_boot
H/C
btn1_long_on_boot H/C
btn1_short_on_eth_of
f
H/C
btn1_long_on_eth_off
H/C
btn2_short
H/C
btn2_long
H/C
btn2_short_on_boot
H/C
btn2_long_on_boot
H/C
btn2_short_on_eth_of
f
H/C
btn2_long_on_eth_off
H/C
btn_init
H/C
btn1_delay
H/C
btn2_delay
H/C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
10
Video over IP
Key
Description
Value
(bold is default)
Host/
Client
no_video
y: disable VideoIP
n: enable VideoIP
H/C
ast_video_quality_mo
de
-1: Video mode
0: Graphic mode
H
v_bcd_threshold
0: anti-dither off
1: anti-dither 1
2: anti-dither 2
H
v_1080i_to_720p
H/C
en_video_wall
y:
n:
H/C
profile
[< A6.0.0] Select ‘giga’ or ‘analog’.
[>= A6.x.x] Revised the naming to:
auto, 10M, 50M, 100M, 150M, 200M.
SoC V1 and V2 only support ‘auto’.
auto:
10M:
50M:
100M:
150M:
200M:
H
v_chunk_size
[OP_MODE < 3] Used to control video
network stream’s burst size. A smaller
value smooths the Ethernet switch’s
loading, but may causes video streaming
performance issues.
Default value is ‘64512’. Use ‘7376’ when
you want to smooth the video stream
packets. Don’t touch this setting unless
you know what you are doing.
64512
H
v_ignore_cts7_33 HDMI compliant test (CTS 7-33) requires
the HDMI source to always output a DVI
signal when the downstream sink is not
an HDMI sink (EDID is not HDMI device).
Set this option to ‘y’ to ignore this
requirement.
n: follow CTS
y: ignore CTS H/C
v_type
[>= AST1520] Overwrite “video type”
setting. Default value is received from the
GPIO pin (HDMI or VGA).
0: VGA
1: disable
2: HDMI
3: DVI
H/C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
11
Key
Description
Value
(bold is default)
Host/
Client
v_loopback_type
[>= AST1520] Set video loopback port
type. Overwrite HW GPIO setting. Default
value is gotten from GPIO pin.
Default value when GPIO pin is set to
enable:
AST1525: the same as v_type setting.
AST1520:
‘board_revision’ == 301, default 2
(HDMI).
If the board is ‘301’ type and has VGA
loopback, please set
v_loopback_type to ‘0’.
v_dual_port to ‘1’.
Otherwise
[<= A6.2.6] Default as v_type setting.
[> A6.2.6] Default as 0 (VGA).
0: VGA
1: disable
2: HDMI
3: DVI
H
v_output_timing_conv
ert
[>= AST1520] Force specific video output
timing.
Examples:
00000000: Pass-Through
80000010: Full HD 1080p60
8000001F: Full HD 1080p50
8000005F: Ultra HD 2160p30
8000005E: Ultra HD 2160p25
80000004: HD 720p60
81000061: WXGA 1366x768@60
81000040: WXGA+ 1440x900@60
81000051: WUXGA 1920x1200@60
8100003C: SXGA+ 1400x1050@60
0: Pass-Through
C
v_eng_drv_option
[>= AST1520] 32bits bitmap VE driver
options to tweak driver behavior. Default
value is 0.
0x00000001: [>=A6.0.0][Host] Convert
2160p30Hz to 1080p
0x00000002: [>=A6.0.0][Host] Convert
2160p60Hz (YUV420) to 1080p60Hz
0x00010000: [>=A6.1.0][Client] Do not
black out after switching to new video
source
0: Default value
H/C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
12
Key
Description
Value
(bold is default)
Host/
Client
v_dual_port
[>= AST1520] Dual output mode. Client
set to ‘1’ to output video signal to both
VGA and HDMI port. Host set to ‘1’ to
output HDMI input to VGA loopback port.
Default value:
Host: 0
Client: 1
1: enable
0: disable
H/C
v_rx_drv
[>= A6.0.0] Used to specify HDMI
receiver driver used. Default value for
different SoC version:
AST1500: cat6023
AST1510: cat6023
AST1520: it6802
AST1525: it6802
cat6023: for
IT6604, IT6605
chip
it6802: for IT6802
chip
H
v_src_unavailable_tim
eout
Wait for a v_src_unavailable_timeout ms
before entering power save. Set to ‘-1’
means never timeout.
10000: 10 seconds
-1: never timeout
C
v_turn_off_screen_on
_pwr_save
Turn off video output sync after
connected host stops streaming video to
client.
y: Turn off
n: Do not turn off.
Will switch back to
GUI screen
C
v_rx_drv_option Special bitmap options for HDMI receiver
driver. (IT6604, IT6802…)
0x00000002: Always report HDMI audio
as 2Ch 48KHz
0x00000004: Always report HDMI audio
is ON
0: default
H
v_analog_edge_
detect
[>= A6.1.12] For VGA analog video input
only. Used to adjust edge detection
threshold value. Default value should be
fine in most of cases. Increase the value
when edge detection is not accurate.
Valid range is 0~255. Good value range:
15~64. Set the value too high or too low
may cause bad result.
37: default value
H
loopback_edid_patch
Copy EDID patch option for local
loopback video port.
00000000
H

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
13
Key
Description
Value
(bold is default)
Host/
Client
remote_edid_patch
Copy EDID patch option for remote client.
Default values:
AST1500: 00230017
AST1510: 00000005
AST1520/AST1525:
[FW < A6.3.0] 00000000
[FW >= A6.3.0] 00000001
H
v_input_select
[>=AST1520][>=A6.3.0]
Configure different types of input select
mode:
auto: auto detect. always controlled by
GPIO.
detect_sync: auto switch after video lost
fixed: fixed selection
auto
detect_sync
fixed
H
v_dual_input
[>=AST1520][>=A6.3.0]
Specify if the HW board has dual input
port or not. This astparam is optional.
The FW will automatically detect the HW
configuration based on the availability of
EDID ROM of both ports.
y: has
n: doesn’t have
H

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
14
Key
Description
Value
(bold is default)
Host/
Client
edid_use
By design, all connected client and host
loopback video port’s EDID is received by
host’s VE driver. All EDID information
also contains the ‘edid_use’ flag. The
host VE driver will ONLY write the
received EDID into EEPROM when the
‘edid_use’ is set to ‘primary’. So,
‘edid_use’ flag is used to control whether
a host should write a received EDID into
EEPROM or not. Different casting mode
has different ‘edid_use’ default value.
By default:
Unicast Mode: All client’s ‘edid_use’ will
ALWAYS be ‘primary’. host loopback’s
‘edid_use’ default is ‘primary’.
Multicast Mode: All host and client
‘edid_use’ default is ‘secondary’. And
“press and hold Button 2 on device
reboot” can force the device to be
‘primary’.
In most of cases, leaving ‘edid_use’ as
default is fine.
primary:
secondary:
H/C
v_hdmi_hdr_mode
[FW >= A6.3.0]
0: HDR
passthrough
1: Force HDR off
C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
15
Video Wall
Key
Description
Value
(bold is default)
Host/
Client
en_video_wall
Enable video wall feature. Please also
check the value of astparam ,web_ui_cfg,
for the video wall Web UI.
y: enable
n: disable
H/C
vw_rotate
[>= AST1520] Clock-wise rotate output
picture.
Console API:
echo 3 >
/sys/devices/platform/display/vw_rotate
0: No rotate
3: 180 degree
6: 270 degree
C
HDCP
Key Description Value
(bold is default) Host/ Client
hdcp_always_on
[Host >=A5.3.1]
[Client >=A6.1.0]
Always enable HDCP 1.4
y: enable
n: disable
H/C
hdcp_always_on_22
[Host >=A6.0.0]
[Client >=A6.1.0]
Always enable HDCP 2.2.
y: enable
n: disable
H/C
v_reject_hdcp
Don’t accept HDCP video source.
y: enable
n: disable
H
hdcp_cts_option
[FW >= A6.2.0] 32bits bitmap options for
HDCP CTS test.
0x80000000: Disable auto SiI9678/9679
firmware update.
0x00000001: HDCP 2.2 Only firmware
0x00000002: HDCP 1.x Only firmware
0x00000000:
H/C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
16
USB over IP
Key
Description
Value
(bold is default)
Host/
Client
no_usb
y:
n:
H/C
share_usb
Default value: (when
‘share_usb_auto_mode’ is ‘n’)
Multicast mode: ‘share_usb = y’.
Unicast mode: ‘share_usb = n’.
y:
n:
H/C
share_usb_auto_mod
e
When ‘share_usb_auto_mode == y’,
‘share_usb’ setting will automatically
change depends on the setting of casting
mode (‘multicast_on’).
y:
n:
H/C
share_usb_on_first_
peer
[>A6.1.8] Applied to ‘share_usb == y’
mode.
When value is ‘y’, the first connected
client automatically requests USBoIP
function. By enabling this feature,
USBoIP automatically enabled when
there is only one client connected to host
under multicast mode.
y: auto connect first
peer
n:
H
usb_set_addr_hack
It is a hack for some buggy BIOS to be
able to recognize USBoIP devices. The
problem is rarely seen.
0: disable
1: enable
H
usb_hid_urb_interval
Set to 35 to resolve some USB HID long
latency issue.
Applies to both KMoIP and USBoIP.
0: ASAP
35: 35ms
H
usb_quirk
[>=A5.3.3] 32bits bitmap options for
resolving some vhub compatibility issues.
VHUB_QUIRK_BULK_SSPLIT (0x1UL
<< 0)
0:
H
usb_fast_switch
Set to ‘y’ to enable ‘usb fast switch’
mode. This enhances about 2 seconds of
USB switching time, but sacrifices video
switching time from 2 to 5 seconds.
n: Disable
y: Enable
C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
17
USB over IP Exporting Policy: (> A 5.2.2)
Key
Description
Value
(bold is default)
Host/
Client
usb_default_policy
The default/global exporting policy used
when a specific policy is not available.
auto_export
no_auto_export
C
usb_conflict_policy
Policy used when a device has different
interfaces with conflict exporting policy.
auto_export
no_auto_export
C
usb_disable_classes
(>A5.1.0 b1701)
Policy setup to disable per USB classes.
There is no default value. Each class
should be separated by a space. For
example, usb_disable_classes=audio
video printer.
per_interface
audio
comm
hid
physical
still_image
printer
mass_storage
cdc_data
cscid
content_sec
video
personal_healthcar
e
audio_video
diagnostic
wireless_controller
misc
app_spec
vendor_spec
C
usb_enable_classes
Policy setup to enable per USB classes.
There is no default value. Each class
should be separated by a space. For
example, usb_enable_classes=audio
video printer.
same as
“usb_disable_class
es”
C
usb_disable_devices
Policy setup to disable per USB’s PnP ID.
There is no default value. Each device
should be separated by a space. For
example,
usb_disable_devices=0781:000c
0770:1234.
C
usb_enable_devices
Policy setup to enable per USB’s PnP ID.
C

Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6 - Astparam Configuration API
18
There is no default value. Each device
should be separated by a space. For
example,
usb_enable_devices=0781:000c
0770:1234.