Kramer KDS-EN6 Api Manual
  1. Manuals
  2. Brands
  3. Kramer Manuals
  4. Media Converter
  5. KDS-EN6
  6. Api manual

Kramer KDS-EN6 Api Manual

Hide thumbs Also See for KDS-EN6:
Table of Contents

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the KDS-EN6 and is the answer not in the manual?

Questions and answers

Related Manuals for Kramer KDS-EN6

Summary of Contents for Kramer KDS-EN6

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

  • Page 2: Table Of Contents

    Multicast (M to N group) IIC 33 UART Console APIs Debug Console APIs Link Manager APIs Video Over IP Driver Statistic/Control APIs Display Driver Statistic/Control APIs OSD APIs Configurations APIs IIC APIs UART Port 1 APIs Configuration Option List KDS-EN6, KDS-DEC6 - Overview...

  • Page 3: Overview

    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.

  • Page 4: How To Access The 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 (;). KDS-EN6, KDS-DEC6 - Overview...

  • Page 5: Astparam Configuration Api

    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. KDS-EN6, KDS-DEC6 - Astparam Configuration API...

  • Page 6: How To Access Astparam

    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: KDS-EN6, KDS-DEC6 - Astparam Configuration API...

  • Page 7: List Of Astparams

    Multicast mode n: Unicast mode ui_feature ignore_e_button_link ignore_e_button_link pwr_led_type default: share_usb: en_log ‘y’ show debug message on debug console. stop_on_boot_test_fa telnetd_param ‘-p 24’: use IP port 24. -p 24 lm_link_off_timeout 15: 15 seconds KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 8 'serial over ip' modules. board_revision [>= AST1520] Used to indicate firmware 300: different kind of HW board design. 301: 300: [Host] AST152x v1.x reference board. 301: [Host] AST1520 v2.x splitter loopback design with HDCP 2.2 support KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 9 Default resolution is 640x480@60Hz. Note: System reboot is required for ui_default_res to be applied. ui_show_text ‘y’ to display diagnostic information on the y: Display bottom of the GUI. ‘n’ to hide it. n: Hide KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 10 [>= AST1510] 1500: 8000: multicast_ip_prefix Uses a different multicast IP prefix. 225.0.10 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. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 11 Kramer Electronics Ltd. Button: (> A3.2) Description Value Host/ (bold is default) Client btn1_short btn1_long btn1_short_on_boot btn1_long_on_boot btn1_short_on_eth_of btn1_long_on_eth_off btn2_short btn2_long btn2_short_on_boot btn2_long_on_boot btn2_short_on_eth_of btn2_long_on_eth_off btn_init btn1_delay btn2_delay KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 12 Set this option to ‘y’ to ignore this requirement. v_type [>= AST1520] Overwrite “video type” 0: VGA setting. Default value is received from the 1: disable GPIO pin (HDMI or VGA). 2: HDMI 3: DVI KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 13 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 KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 14 Valid range is 0~255. Good value range: 15~64. Set the value too high or too low may cause bad result. loopback_edid_patch Copy EDID patch option for local 00000000 loopback video port. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 15 Specify if the HW board has dual input n: doesn’t have 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. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 16 “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. v_hdmi_hdr_mode [FW >= A6.3.0] 0: HDR passthrough 1: Force HDR off KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 17 Don’t accept HDCP video source. y: enable n: disable hdcp_cts_option [FW >= A6.2.0] 32bits bitmap options for 0x00000000: HDCP CTS test. 0x80000000: Disable auto SiI9678/9679 firmware update. 0x00000001: HDCP 2.2 Only firmware 0x00000002: HDCP 1.x Only firmware KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 18 << 0) usb_fast_switch Set to ‘y’ to enable ‘usb fast switch’ n: Disable mode. This enhances about 2 seconds of y: Enable USB switching time, but sacrifices video switching time from 2 to 5 seconds. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 19 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. usb_enable_devices Policy setup to enable per USB’s PnP ID. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 20 Kramer Electronics Ltd. There is no default value. Each device should be separated by a space. For example, usb_enable_devices=0781:000c 0770:1234. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 21 [FW >= A6.3.0] Used to set KMoIP’s USB poll interval. Both host and client must be set to the same value. Unit is in ms. Default value should be good for most KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 22 Kramer Electronics Ltd. cases: AST1500: 35 AST1510: 35 AST1520: 10 [FW >=A6.3.0], 35 [FW < A6.3.0] KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 23 Always select audio port per video port used. When HDMI/DVI video port is used, HDMI always use HDMI audio port. When VGA video port is used, always use analog audio port. KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 24 This setting requires system reset to take effect. To runtime change the volume, please use following command: echo [value] > /sys/devices/platform/150 0_i2s/analog_out_vol IR over IP Description Value Host/ Client (bold is default) no_ir KDS-EN6, KDS-DEC6 - Astparam Configuration API...
  • Page 25 (bold is default) no_soip y: Disable SoIP n: Enable SoIP soip_type2 soip_guest_on s0_baudrate 115200-8n1 soip_type2_token_tim [>=A1.38] 1,2,3... seconds eout ch_select_soip2 [>=A5.3.0] GPIO over IP (Push Button over IP) Description Value Host/ Client (bold is default) no_pwrbtn KDS-EN6, KDS-DEC6 - Astparam Configuration API...

  • Page 26: Getting Kds-6 Board's Ip Address

    Kramer Electronics Ltd. Getting KDS-6 Board's IP Address Kramer KDS-6 FW default runs "static ip" and uses the following address: 192.168.1.39. If the device is set to "autoip" and uses 169.254.xxx.xxx private IP domain, the IP of the target KDS-6 board can be resolved by its hostname using mDNS protocol..

  • Page 27: Application Scenario

    Multicast M to N group: Extension of built-in multicast M to N mode. In this mode, there are multiple video sources and multiple groups of monitors. Console APIs provide APIs to enable clients to join different multicast groups. • Extra IIC remote communication: • Extra UART port remote communication: KDS-EN6, KDS-DEC6 - Application Scenario:...

  • Page 28: Faqs

    • dhcp client: Use DHCP client to get an IP address. A DHCP server is required to use this mode. • static ip: Use a static IP address, that can be configured through the Console API. KDS-EN6, KDS-DEC6 - FAQs...
  • Page 29 For a host board with "hostname_id" as "ABCD", the board's "hostname" is "ast- gatewayABCD". The board's IP can by resolved by $./astresname ast-gatewayABCD.local • For client board with "hostname_id" as "1234", the board's "hostname" is "ast-client1234". The board's IP can be resolved by $./astresname ast-client1234.local KDS-EN6, KDS-DEC6 - FAQs...
  • Page 30 How do I dynamically enable/disable remote access (host)? 1. Use Telnet or the debug console to connect to the host board. 2. Get the current link manager state: $cat /var/ast_device_status Link Manager APIs on page for details KDS-EN6, KDS-DEC6 - FAQs...
  • Page 31 Client: $cat /sys/devices/platform/videoip/State will be WAITING_HOST_MODE • When video is streaming • Host: $cat /sys/devices/platform/videoip/State will be OPERATING • Client: $cat /sys/devices/platform/videoip/State will be OPERATING How do I check if the Ethernet cable is connected and works? $cat /sys/devices/platform/ftgmac/link_state KDS-EN6, KDS-DEC6 - FAQs...
  • Page 32 1. Use Telnet or the debug console to connect to the device. 2. $lmparam g MY_MAC 3. [A3.50] Query current connected host IP on client: 4. Use Telnet or the debug console to connect to the client. 5. $lmparam g GWIP KDS-EN6, KDS-DEC6 - FAQs...
  • Page 33 There are 2 ways to overwrite the multicast IP: • astparam "multicast_ip" – you must set "reset_ch_on_boot" to "n" and do the "astparam save" command to save it into flash ROM, so that the setting won't disappear after box reset. KDS-EN6, KDS-DEC6 - FAQs...

  • Page 34: Unicast (Kvm Over Ip)

    4. Change the hostname_id: $./astparam s hostname_id 1001 5. Trigger hostname change: $./ast_send_event -1 e_chg_hostname 6. If you want to save the setting into flash and keep the setting after reboot: $./astparam s reset_ch_on_boot n $./astparam save 7. Restart Link: $./ast_send_event -1 e_reconnect KDS-EN6, KDS-DEC6 - FAQs...

  • Page 35: Multicast (M To N Group)

    6. To write offset X to value Y: $echo X Y > /sys/devices/platform/i2c/io_value Why is the sysfs approach used for IIC access? IIC access consumes a very high percentage of the CPU resources. Using the sysfs approach, we ensure that developers' IIC access won't impact system performance. KDS-EN6, KDS-DEC6 - FAQs...

  • Page 36: Uart

    2. Create pipe: $mknod p1 p && mknod p2 p 3. Enable bi-directional repeater mode by: Host: • Start read: $cat p1 & • Start write: $cat > p2 Client: • Start read: $cat p2 & • Start write: $cat > p1 KDS-EN6, KDS-DEC6 - FAQs...
  • Page 37 UART port 1? For example, controlling all host/client boards through a network attached PC. We call it "Serial over IP guest mode". Please request sample code if you need this feature. KDS-EN6, KDS-DEC6 - FAQs...

  • Page 38: Console Apis

    ■ t : specify the device type to list ○ EXAMPLE ■ List all clients: ■ $./node_list -t client ■ List all hosts: ■ $./node_list -t host ● Get IP from hostname: ○ NAME: astresname ○ EXAMPLE: ■ Get "ast-gateway0001.local"'s IP address: KDS-EN6, KDS-DEC6 - Console APIs...

  • Page 39: Link Manager Apis

    ■ s_srv_on: Client is connected to Host ■ other states: non-stable states Video Over IP Driver Statistic/Control APIs The interface is presented as files and located under /sys/devices/platform/videoip/. ● Connected client list: ○ FILE: unlink ○ USAGE: cat /sys/devices/platform/videoip/unlink KDS-EN6, KDS-DEC6 - Console APIs...

  • Page 40: Display Driver Statistic/Control Apis

    ■ The OSD string takes ‘printf’ like special character input, for example: ■ ./osd_on.sh “Line 1 \n Line 2” ■ Use following code for reserved characters: ■ \x3A: ‘:’ ■ \n: CR ■ \t: tab ○ Environment Variables: Please see the comments in osd_on.sh ■ OSD_STR KDS-EN6, KDS-DEC6 - Console APIs...
  • Page 41 ● Turn OFF: ○ ./osd_off.sh ○ USAGE: To disable OSD message after 5 seconds: ■ ./osd_off.sh 5 & Note: The maximum number of characters an OSD string can show is software limited to 128 characters. KDS-EN6, KDS-DEC6 - Console APIs...

  • Page 42: Configurations Apis

    ■ $./astparam s ip_mode ● Reset setting to factory default: ○ NAME: reset_to_default.sh ○ DESCRIPTION: ■ reset RW section but keeps the random generated MAC address. A system reboot is required to take effect. ○ EXAMPLE: ■ $./reset_to_default.sh KDS-EN6, KDS-DEC6 - Configurations APIs...

  • Page 43: Iic Apis

    ○ DESCRIPTION: Used to set the range for read. See "io_value" for example. UART Port 1 APIs ● Setup /dev/ttyS0: ○ NAME: stty ○ DESCRIPTION: http://linux.about.com/od/lna_guide/a/gdelna38t01.htm ○ Example: set baudrate to 115200 ■ $stty 115200 -F /dev/ttyS0 KDS-EN6, KDS-DEC6 - Configurations APIs...

  • Page 44: Configuration Option List

    ○ DESCRIPTION: Used when "ip_mode" is "static". If not defined, default value is used. ○ DEFAULT: ■ Host: 169.254.0.222 ■ Cllient: 169.254.0.111 ○ PARTITION: RO, RW ● netmask ○ DESCRIPTION: Used when "ip_mode" is "static". If not defined, default value is used. KDS-EN6, KDS-DEC6 - Configuration Option List...
  • Page 45 ○ DESCRIPTION: Set to 'y' to reset channel related settings to the setting of the 4-bits DIP switch after board reset. By using this feature, the modification of multicast group or unicast target disappears after board reset. The following settings are reset: KDS-EN6, KDS-DEC6 - Configuration Option List...
  • Page 46 IP" feature is enabled. This setting only takes effect on system reboot and "Serial Over IP" feature is enabled. ○ OPTIONS: ■ n: Use "Serial over IP type 1" ■ y: Use "Serial over IP type 2" ○ DEFAULT: Default value is configured by manufacturer using "autoterm" KDS-EN6, KDS-DEC6 - Configuration Option List...
  • Page 47 ○ DESCRIPTION: A new setting used to overwrite the setting of ‘share_usb’ depending on the setting of ‘multicast_on’. ○ OPTIONS: ■ y: enable. The value of ‘share_usb’ is always: ■ share_usb will be ‘n’ under unicast mode KDS-EN6, KDS-DEC6 - Configuration Option List...
  • Page 48 Kramer Electronics Ltd. ■ share_usb will be ‘y’ under multicast mode ■ n: disable. ○ DEFAULT: ■ n: For backward compatibility. The default value is ‘n’. ○ PARTITION: RO, RW KDS-EN6, KDS-DEC6 - Configuration Option List...
  • Page 49 SAFETY WARNING Disconnect the unit from the power supply before opening and servicing 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.

This manual is also suitable for:

Kds-dec660-000290

Table of Contents