background image

 

 

 

 

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

www.KramerAV.com 
[email protected] 

  

Summary of Contents for KDS-DEC6

Page 1: ...422 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 info KramerAV com ...

Page 2: ...ing 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 ...

Page 3: ...ions 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 t...

Page 4: ...nt 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 ...

Page 5: ... 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 manag...

Page 6: ...rmined 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...

Page 7: ...quals 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 f...

Page 8: ...s 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 start...

Page 9: ...B_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 ...

Page 10: ...Kramer Electronics Ltd KDS EN6 KDS DEC6 Example 9 Example ...

Page 11: ...me_prefix H C hostnamebydipswitch Use default hostname_id based on 4 bits DIP switch When hostnamebydipswitch is y hostname_id s default value is the value of ch_select where default get from on board 4 bits DIP switch y host default n client default H C hostname_id Overwrite hostnamebydipswitch FW A7 0 0 In FW A7 0 0 client maps ch_select to host s hostname in order to find and connect to host In...

Page 12: ...udio ch_select_r IR ch_select_s Serial ch_select_p GPIO Push Button FW 7 2 ch_select_c CEC Change ch_select won t affect anything if ch_select_x is already specified H C ch_select_v ch_select_u ch_select_a ch_select_r ch_select_s ch_select_p ch_select_c Like ch_select but for specific services Default value from ch_select ch_select_v video ch_select_u USB ch_select_a audio ch_select_r IR ch_select...

Page 13: ...efault 1 Force HDR off C v_frame_rate Used to control frame rate of video encode Default set to 0 means no limitation use best effort Set to other value will limit the maximum video encode frame rate Valid range 0 1 2 60 Frame rate v_frame_rate 60 input refresh rate For example set to 30 under 1080p60Hz Frame rate 30 60 60 30 FPS 0 Best effort default H v_hdmi_force_rgb_output v_hdmi_force_rgb_out...

Page 14: ...l stretching type 1 Stretch out 2 Fit in 1 Stretch out 2 Fit in default vw_ver Specify video wall control APIs version 1 Default Specify monitor layout and auto calculate coordinate 2 Manually specify coordinate Easier for mosaic style video wall configuration Following Astparam will be used when vw_ver is 2 vw_v2_x1 vw_v2_y1 vw_v2_x2 1 Default 2 v2 Specify coordinate C HDCP Key Description Value ...

Page 15: ...mmand echo value sys devices platform 150 0_i2s analog_out_vol 1 0 1 2 100 H C IR over IP Key Description Value Host Client no_ir This is a global IR over IP enable disable setting y Disable IRoIP n Enable IRoIP default H C ir_guest_on Enable IR guest mode feature y Enable default n Disable H C ir_sw_decode Enable IR software decode feature y Enable n Disable default H C ir_sw_decode_nec_cfg NEC r...

Page 16: ...baudrate 115200 8n1 H C soip_type2_token_timeout soip_token_timeout For type 2 only 1 2 3 seconds H C For type 2 and type 3 Default value from soip_type2_token_timeout H C ch_select_soip2 ch_select_s Default value from from ch_select N A C Default SoIP channel CEC over IP Key Description Value Host Client no_cec This is a global CEC over IP enable disable setting CEC extension and guest mode are b...

Reviews: