SC&T HKM01B-4K Manual
  1. Manuals
  2. Brands
  3. SC&T Manuals
  4. Extender
  5. HKM01B-4K
  6. Manual

SC&T HKM01B-4K Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Product: HKM01B-4K
Date: 1/23/2018
FW Rev:

Table of Contents

Table of Contents
Doc Type:
1/104

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the HKM01B-4K and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for SC&T HKM01B-4K

Summary of Contents for SC&T HKM01B-4K

  • Page 1: Table Of Contents

    Overview Supported Platform Supported FW Version Terminology Preface How to Access the Console How to get HKM01B-4K board's IP address Command Category Command Syntax Conventions Console APIs Link Manager Control Access Settings in Flash - astparam Send Event to Link Manager...
  • Page 2 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get IP Address Get MAC Address Get Ethernet Link Status and Mode Node Discovery and Query Node Discovery and Query Video Commands Configure Graphic/Video Mode [Host Only] Set Anti-Dither Mode [Host Only]...
  • Page 3 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: USBoIP/KMoIP Commands Manually Start/Stop USBoIP and KMoIP [Client Only] Manually Start/Stop USBoIP [Client Only] Manually Start/Stop KMoIP [Client Only] Get USBoIP Status [Client Only] Get KMoIP Status [Client Only] Get Attached Client IP [Host Only]...
  • Page 4 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Button Events Client Link Control Button Events OSD Control Appendix D. List of lmparam Common Host Client Appendix E. Sample Code 4/104...

  • Page 5: Revision History

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Revision History ● 2018/01/16: [Misc.] Add “Reset Setting to Factory Default”. ○ ● 2017/11/27: [USBoIP Device Exporting Policy] Add more description. ○ ● 2017/11/14: [Migrate From Legacy Console APIs] Add “Command Mapping” table.

  • Page 6: Overview

    The “Console APIs” interface is so called “Command Line Interface” (CLI). This document describes the commands which can be used under HKM01B-4K series’ platform’s console interface. HKM01B-4K uses Linux OS and the console is derived by Bash shell. Console can be accessed through: ●...

  • Page 7: Terminology

    Normally refers to control commands sending to ‘Link manager’. service HKM01B-4K provide many over IP extension functions. It is called ‘service’ in general. For example, video over ip, usb over IP…. channel Most of over IP streaming ‘services’ using different multicast IP/group.
  • Page 8 FW Rev: source Video source. Refer to video player whichever feed HDMI/DVI video signal to HKM01B-4K host. Stands for “On Screen Display”. Client display HW engine ‘overlay’ function to overlay 16bits RGB565 data onto video decode picture. FW provide ‘String OSD’ and ‘Picture OSD’ APIs for overlay string or picture onto video decode picture.

  • Page 9: Preface

    2. Use telnet: FW has built-in telnetd server and telnet client built in. Developer can use any telnet client to connect to any HKM01B-4K board. Or write their own program using telnet protocol to connect to any HKM01B-4K board through IP network.

  • Page 10: How To Get Hkm01B-4K Board's Ip Address

    FW default runs "autoip" and uses 169.254.xxx.xxx private IP domain. The IP of target HKM01B-4K board is resolved by its hostname using mDNS protocol. If developers want to use "static ip" or "DHCP client", developer will be responsible to maintain the "IP to board"...

  • Page 11: Command Category

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Command Category Different usage scenario is achieved by different type of commands. “Console APIs” section describes all those commands by usage type. However, by implementation type, Commands can classified into following types: ●...

  • Page 12: Command Syntax Conventions

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: 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. Keywords or parameters that appear within square brackets are optional.

  • Page 13: Console Apis

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Console APIs Link Manager Control After FW boots up, the process hands over to ‘link manager’ script. Link manager is the main process controlling the reset of FW’s life cycle. It maintains connection state machine.

  • Page 14: Access Settings In Flash - Astparam

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Access Settings in Flash - astparam Please read “Documents/Console APIs/All about astparam” for details. 14/104...

  • Page 15: Send Event To Link Manager

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Send Event to Link Manager This is the most used command to control the system. This command has two syntax format. ‘e’ is just a shortcut of ‘ast_send_event -1’. They are basically the same. The detail usage of events will be described in the reset of this document.

  • Page 16: Get/Set Link Manager Internal Parameters

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get/Set Link Manager Internal Parameters lmparam is usually used to query some of link manager’s internal parameters. This command also provide a method to set the value of specified parameter. However, it is rarely useful and may confuse link manager script results in unexpected problem.
  • Page 17 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: / # lmparam dump IS_HOST=y STATE=s_srv_on ACCESS_ON=y DBG=0 SHARE_USB=y SHARE_USB_AUTO_MODE=n SHARE_USB_ON_FIRST_PEER=y CH_SELECT=9999 ………. REMOTE_EDID_PATCH=00000001 LOOPBACK_EDID_PATCH=00000000 LOOPBACK_DEFAULT_ON=y V_RX_DRV=it6802 V_FRAME_RATE=0 17/104...

  • Page 18: Get Link Manager State

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Link Manager State Syntax lmparam g STATE Result ● Host 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 ○...

  • Page 19: Simulate Button Press

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Simulate Button Press Evaluation board has built-in two button. FW defined a set of button behavior. User can use following ‘e’ commands to trigger those button behavior with the need to actually press the button.

  • Page 20: Link Management

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Link Management 20/104...

  • Page 21: Switch Channel [Client Only]

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Switch Channel [Client Only] Command client to connect to a specified channel. For API backward compatibility and easier usage, this command has 3 syntax format. Channel can be specified by channel number (ch-select) or host’s ip address (host-ip-addr).
  • Page 22 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ● By specifying different channel to different services, you can ‘free route’ each services to different host as you want. ● Command supports ch-select from 0000 to 9999, which means there are maximum 10000 host channels can be used.
  • Page 23 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Don’t use it. ch_select_soip2: default value of ‘ch_select_s’. Exists for legacy reason. ○ Don’t use it. NOTE: modify above ‘ch_select_x’s is not allowed and will cause ○ un-expected FW behavior. ● reset_ch_on_boot: To persist channel setting through system reboot, please set astparam, reset_ch_on_boot, to ‘n’.
  • Page 24 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: / # e e_reconnect::9810::v Ex5: Start connect ‘video over IP’ and ‘audio over IP’ to channel ‘1234’. Then connect ‘usb over IP’ to channel ‘8888’. / # e e_reconnect::1234::va / # e e_reconnect::8888::u Ex6: Start connect ‘video over IP’...

  • Page 25: Switch Channel [Host Only]

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Switch Channel [Host Only] Host command. Used to setup host’s multicast IP per channel setting. Issue this command also starts/re-starts host services. This command has 2 syntax format. Syntax e e_reconnect e e_reconnect::{ch-select} Parameters ●...
  • Page 26 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ch_select. Must be the same format as ‘ch_select’, 0000~9999. FW will ■ use ‘0000’ default value if invalid format detected. host’s ‘e_chg_hostname’ event will automatically trigger channel setting ○ change, ‘e_reconnect::{ch_select}’. ‘e_reconnect::{ch_select}’ will automatically change ‘hostname_id’ to ○...

  • Page 27: Stop Link [Client Only]

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Stop Link [Client Only] Used to stop services. Syntax [stop all] e e_stop_link Syntax [specify services] e e_stop_link::{{z|Z}|{v||u||a||r||s||p}} Parameters ● {{z|Z}|{v||u||a||r||s||p}}: Used to specify which function to apply. ○ v: video over IP ■...
  • Page 28 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ● access_on_s: y|n. Set to ‘n’ to not starting Serial over IP service on boot. ● access_on_p: y|n. Set to ‘n’ to not starting GPIO over IP service on boot. Related lmparam ●...

  • Page 29: Stop Link [Host Only]

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Stop Link [Host Only] Used to stop all services. Syntax e e_stop_link Parameters No parameter required. Usage Information ● All services will be stopped. Can’t specify which service to stop. Version History ●...

  • Page 30: Get Current Channel Setting

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Current Channel Setting Syntax lmparam g CH_SELECT[_who] Parameters Use following lmparam to get current channel setting: Host: lmparam Description CH_SELECT All service uses this channel. Client: lmparam Description CH_SELECT System default channel. Used if following CH_SELECT_X is invalid/not defined.
  • Page 31 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ch_select_soip2: default value of ‘ch_select_s’. Exists for legacy reason. ○ Don’t use it. NOTE: modify above ‘ch_select_x’s is not allowed and will cause ○ un-expected FW behavior. ● reset_ch_on_boot: If this value is ‘n’, ‘e_reconnect’ command with {ch- select|host-ip-addr} specified will save the specified value to specified ‘ch_select_x’...

  • Page 32: Ip Network Commands

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: IP Network Commands Change Host Name ID Syntax astparam s hostname_id id;e e_chg_hostname Parameters ● id: The host name id to be configured. Usage Information ● See ‘all about astparam’ document for astparam command details.
  • Page 33 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ● FW >= A7.0.0 Examples Ex1: Change client’s host name to ‘ast3-Rx-test1234’. And save it into flash. /# astparam s hostname_id test1234;e e_chg_hostname;astparam save 33/104...

  • Page 34: Get Host Name

    Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Host Name There are two commands which return different format of host name. First command returns full host name string. Second command returns only the ID part of host name. Syntax...
  • Page 35 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get IP Address Syntax lmparam g MY_IP Usage Information ● For other setting of IP, see document “Console APIs/All About astparam”. Related astparam ● ip_mode ● ipaddr ● netmask ● gatewayip Version History ●...
  • Page 36 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get MAC Address Syntax lmparam g MY_MAC Usage Information ● For other setting of MAC address, see document “Console APIs/All About astparam”. Related astparam ● ethaddr ● random_mac Version History ● FW >= A6.0.0...
  • Page 37 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Ethernet Link Status and Mode Syntax lmparam g ETH_LINK_STATE lmparam g ETH_LINK_MODE Parameters ● ETH_LINK_STATE: Get Ethernet link status. Result can be ‘on’ or ‘off’. ● ETH_LINK_MODE: Get Ethernet link mode. Result can be ‘10M’, ‘100M’ or ‘1G’.
  • Page 38 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Node Discovery and Query Node Discovery and Query This command is an upgrade version of legacy ‘node_list’ command. Use this command to query and list devices node information (node_info) in the network. node_info is a binary file containing a list of key/value pair. User can use this node_query command to add/modify any node_info file.
  • Page 39 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: If node_info doesn’t contain the query key, an empty string “” will be ○ printed out like ‘THE_KEY=””’. ● max: Enter a decimal number. query process stops when matched node_info ○ count over this max value.
  • Page 40 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: "nodes":[ "IS_HOST":"y", "MY_MAC":"02C7C324D7E3", "HOSTNAME":"ast3-gateway0000", "MY_IP":"169.254.10.133", "STATE":"s_srv_on" "IS_HOST":"n", "MY_MAC":"82EAA841BDF1", "HOSTNAME":"ast3-client82EAA841BDF1", "MY_IP":"169.254.10.167", "STATE":"s_srv_on" "count":2 Query Result Those key’s meaning is explained in Appendix D List of lmparam. Host Example [Without --json] MY_IP=169.254.10.133 IS_HOST=y MULTICAST_ON=n...
  • Page 41 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: NO_VIDEO=n NO_USB=n NO_KMOIP=n NO_I2S=n NO_SOIP=n SOIP_GUEST_ON=n SOIP_TYPE=2 NO_IR=y NO_PWRBTN=y STATE=s_srv_on REPLY_TYPE=essential MY_MAC=82EAA841BDF1 Usage Information ● The maximum size of node_info file must < 64KB. Key/value pairs are saved as string characters. Version History ●...
  • Page 42 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: NO_USB=n NO_KMOIP=n NO_I2S=n NO_SOIP=n SOIP_GUEST_ON=n SOIP_TYPE=2 NO_IR=n NO_PWRBTN=y STATE=s_srv_on REPLY_TYPE=essential MY_MAC=82EA88FCD397 Ex2: List all nodes’ MY_MAC value. / # node_query --get_key MY_MAC MY_MAC=02C7C324D7E3 MY_MAC=82EA88FCD397 Ex3: List all host nodes’ STATE value. (host node’s IS_HOST=y). There is only one host in this example.
  • Page 43 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: MY_IP=169.254.10.133 Ex6: Create a local node_info file named “my_node_info” and add “MY_KEY=123” and “MY_KEY2=abc” into it. / # node_query --if my_node_info --of my_node_info --set_key MY_KEY=123 - -set_key MY_KEY2=abc Ex7: Dump my_node_info node_info file from previous example.
  • Page 44 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: / # node_query --dump --json "nodes":[ "MY_IP":"169.254.10.167", "IS_HOST":"n", "HOSTNAME":"ast3-client82EAA841BDF1", "MULTICAST_ON":"y", "NO_VIDEO":"n", "NO_USB":"n", "NO_KMOIP":"n", "NO_I2S":"n", "NO_SOIP":"n", "SOIP_GUEST_ON":"n", "SOIP_TYPE":"2", "NO_IR":"n", "NO_PWRBTN":"y", "ACCESS_ON_P":"y", "ACCESS_ON_U":"y", "CH_SELECT_P":"0000", "CH_SELECT_V":"0000", "CH_SELECT_U":"0000", "CH_SELECT_A":"0000", "CH_SELECT_R":"0000", "CH_SELECT_S":"0000", "STATE":"s_srv_on", "ACCESS_ON_A":"n", "ACCESS_ON_S":"n", "ACCESS_ON_R":"n", "ACCESS_ON_V":"n", "REPLY_TYPE":"essential",...
  • Page 45 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Ex12: Query all node’s following info and output using json format. ● IS_HOST ● MY_MAC ● HOSTNAME ● MY_IP ● STATE There are total two nodes replied. /# node_query --get_key IS_HOST --get_key MY_MAC --get_key HOSTNAME -- get_key MY_IP --get_key STATE --json "nodes":[...
  • Page 46 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Video Commands Configure Graphic/Video Mode [Host Only] Syntax [LM Get] lmparam g V_QUALITY_MODE Syntax [LM Toggle] e e_btn_toggle_video_profile Syntax [LM Set Video Mode] e e_btn_toggle_video_profile_video Syntax [LM Set Graphic Mode] e e_btn_toggle_video_profile_graphic...
  • Page 47 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ● e_btn_toggle_video_profile ● e_btn_toggle_video_profile_graphic ● e_btn_toggle_video_profile_video Related lmparam ● V_QUALITY_MODE Related astparam ● ast_video_quality_mode Version History ● [FW >= A5.0.0] e_btn_toggle_video_profile ● [FW >= A7.0.0] e_btn_toggle_video_profile_graphic, e_btn_toggle_video_profile_video Examples Ex1: Get current mode and toggle change. (Through link manager)
  • Page 48 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Set Anti-Dither Mode [Host Only] Syntax [LM Get] lmparam g V_BCD_THRESHOLD Syntax [LM Toggle] e e_btn_toggle_video_anti_dither Syntax [LM Set] e e_btn_toggle_video_anti_dither_{mode} Syntax [Driver Get] cat /sys/devices/platform/videoip/bcd_threshold Syntax [Driver Set] echo {mode} > /sys/devices/platform/videoip/bcd_threshold Parameters ●...
  • Page 49 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: ● [FW >= A5.0.0] e_btn_toggle_video_anti_dither ● [FW >= A7.0.0] e_btn_toggle_video_anti_dither_{mode} Examples Ex1: Get current mode and toggle change. (Through link manager) / # lmparam g V_BCD_THRESHOLD 0/ # / # e e_btn_toggle_video_anti_dither Ex2: Force to mode 2.
  • Page 50 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Enable/Disable Loopback Port [Host Only] Syntax [LM Get] lmparam g V_LOOPBACK_ENABLED Syntax [LM Toggle] e e_btn_toggle_snoop Syntax [LM Turn On] e e_btn_toggle_snoop_on Syntax [LM Turn Off] e e_btn_toggle_snoop_off Usage Information ● Not all HW platform support this feature.
  • Page 51 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: / # e e_btn_toggle_snoop_off 51/104...
  • Page 52 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Frame Rate Control [Host Only] Used to control video encode’s frame rate. Syntax echo {frame_rate} > /sys/devices/platform/videoip/frame_rate_control Parameters ● frame_rate: Default set to ‘0’ means ‘no limitation’ use best effort. Set to other value will limit the maximum video encode frame rate.
  • Page 53 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Bit Rate Control [Host Only] Bit rate control is done by changing video profile. To change video profile, set astparam, profile, and reboot system to take effect. See ‘Documents/Console APIs/All About astparam’ document for details.
  • Page 54 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Detach/Attach Video Input Port [Host Only] Used to toggle upstream video port hotplug pin. Only valid for HDMI or DVI input. Syntax echo {0|1} > /sys/devices/platform/videoip/detach_input_port Parameters ● {0|1} 1: detach ○...
  • Page 55 FW has EDID patch function and default is enabled. So, uploaded EDID will be patched first before been written into EEPROM. ● For other EDID related commands and topic, please reference to ‘Documents/Video over IP/HKM01B-4K EDID Customization Guide’ and ‘Documents/Video over IP/HKM01B-4K EDID Update Policy’. Related Document ●...
  • Page 56 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Current EDID Reported to Upstream [Host Only] Syntax cat /sys/devices/platform/videoip/edid_cache Version History ● FW >= A5.0.0 Examples Ex1: Get current used EDID / # cat /sys/devices/platform/videoip/edid_cache 00 ff ff ff | ff ff ff 00 | 10 ac c0 a0 | 4c 4e 33 30 |...
  • Page 57 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Video Source Timing Information Syntax cat /sys/devices/platform/videoip/timing_info Version History ● FW >= A6.2.0 Examples Ex1: Get video source timing information / # cat /sys/devices/platform/videoip/timing_info Timing Table: Serial Number[0x000D] [1920]X[1080] [60]Hz Pixel Rate: 148351KHz, Htotal: 2200, Vtotal: 1125...
  • Page 58 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Video Engine State Syntax cat /sys/devices/platform/videoip/State Result ● Host: INITIALIZING: Initializing. ○ OPERATING: Encoding and streaming out. ○ operating: Encoding without streaming. (No client attached yet.) ○ DETECTING_MODE: Detecting video input timing.
  • Page 59 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Video Sink Information Syntax cat /sys/devices/platform/display/monitor_info Usage Informatin ● [Host] This command shows loopback port video sink’s information. NOT client’s sink information. ● Under dual port output situation, this command shows current primary output port’s sink information.
  • Page 60 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Ex2: Get video sink information. (Monitor not attached.) / # cat /sys/devices/platform/display/monitor_info attached=n 60/104...
  • Page 61 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Turn Off/On Video Output [Client Only] Manually force video output off. Syntax echo {1|0} > /sys/devices/platform/display/screen_off Parameters ● 1: Turn off. ● 0: Turn on. Related astparam ● v_src_unavailable_timeout ● v_turn_off_screen_on_pwr_save Version History ●...
  • Page 62 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Pause/Black-out Video Stream [Client Only] Syntax [Get] cat /sys/devices/platform/videoip/pause Syntax [Set, Pause] echo {mode} > /sys/devices/platform/videoip/pause Parameters ● mode: Can be ‘0’, ‘1’ or ‘2’. 0: Resume video streaming. ○ 1: Pause.
  • Page 63 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Select Video Input Port [Host Only] Please read “Document/Video over IP/Notes on Video Dual Input Auto Selection” for details. Scale Video Output/Video Hybrid Mode [Client Only] Please read “Document/Video over IP/Notes on Video Hybrid Mode” for details.
  • Page 64 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Video Wall Commands Please read document under Documents/Video over IP/Video Wall/, for details: ● AST1500 Video Wall Web Configuration Without RS232 Chain ● AST1520 Video Wall API v2.docx Show Picture When Link Down Please read document under Documents/Console APIs/GUI Change Background Picture, for details.
  • Page 65 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: OSD Commands Show String OSD [Client Only] Syntax [long command format] e "e_osd_on_str::{YSTART::YMAX::ALPHA::MASK::OFF_TIME::STRING::FSIZE::FCOLOR}" Syntax [shortcut, center aligned] osd_on.sh “STRING” Syntax [shortcut, top-left aligned, big font] osd_on_tl.sh “STRING” Syntax [turn off OSD] e e_osd_off_str::{WHEN_OFF} Syntax [shortcut, turn off OSD] osd_off.sh {WHEN_OFF} &...
  • Page 66 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: format. ● SIZE: String font size in pixels. ● COLOR: String font color in 32bits hex XRGB888 format, 0xXXRRGGBB: XX: Special code. Can be: ○ FF: Center aligned. ■ F0: Aligned to top-left.
  • Page 67 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Ex4: Show OSD string “Hello OSD”. With: ● ‘25’ transparency ● turn off after ‘5’ seconds ● font size ‘30’ ● font color ‘red’ / # e “e_osd_on_str::0::200::25::1::5::Hello OSD::30::0xFFFF0000” Ex5: Show OSD string “Test:123”. Use default settings. Note: ‘:’ is a reserved character.
  • Page 68 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Show Picture OSD [Client Only] Please read document, “Documents/Console APIs/OSD Control APIs”, for details. 68/104...
  • Page 69 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Audio over IP Commands Audio Source Port Selection [Host Only] Please read “Documents/Audio over IP (I2S)/AST1520 Audio Usage Scenario” for details. Analog Audio Volume Control Please read “Documents/Console APIs/All about astparam” for details. Search for “a_analog_in_vol”...
  • Page 70 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: USBoIP/KMoIP Commands Manually Start/Stop USBoIP and KMoIP [Client Only] Syntax [Start] e e_reconnect::{ch-select|host-ip-addr}::u Syntax [Stop] e e_stop_link::u Usage Information ● See “Swicth Channel [Client Only]” and “Stop Link [Client Only]” sections for details.
  • Page 71 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: 71/104...
  • Page 72 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Manually Start/Stop USBoIP [Client Only] Syntax [Start] e e_start_usb Syntax [Stop] e e_stop_usb Syntax [Toggle] e e_btn_request_usb Usage Information ● This command is for USBoIP, not KMoIP. ● This command is used for runtime control. If you want to disable USBoIP permently, please use astparam, no_usb, instead.
  • Page 73 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Manually Start/Stop KMoIP [Client Only] Syntax [Start] e e_start_kmoip Syntax [Stop] e e_stop_kmoip Usage Information ● This command is for KMoIP. ● This command is used for runtime control. If you want to disable KMoIP permently, please use astparam, no_kmoip, instead.
  • Page 74 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get USBoIP Status [Client Only] Syntax ulmparam g U_USBIP_STATE Result ● on: USBoIP access permission is granted. ● off: USBoIP access permission is not granted or is off. ● request: Requesting USBoIP access permission.
  • Page 75 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get KMoIP Status [Client Only] Syntax ulmparam g U_KMOIP_STATE Result ● on: KMoIP is enabled. ● off: KMoIP is disabled. Usage Information ● ‘ulmparam’ is a command similar to ‘lmparam’. It is used to query USB Link Manager (uLM)’s internal parameters.
  • Page 76 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Get Attached Client IP [Host Only] 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, will return ‘0.0.0.0’. Usage Information Version History ●...
  • Page 77 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: USBoIP Device Exporting Policy [Client Only] This feature is used to block the usage of specified type of USB devices. For example, dis-allowing the usage of USB storage. Please read document, “Documents/USB over IP/USBoIP Device Exporting Policy”, for details.
  • Page 78 Produc ct: HKM01B B-4K Doc Typ Date: 1 1/23/2018 FW Rev IR ov ver IP C Comma ands IR Gu uest Mod de and Pr rotocol D Decode Please read docum ment “Docu uments/IR o over IP/IR Guest Mode e & Softwa re Decode”...
  • Page 79 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: I2C Access FW provide a simple sysfs interface for simple I2C read/write. It is normally used for debug. Read/Write I2C takes and blocks CPU for a long time. So, if you have special application which access I2C quite a lot, please consider write a driver instead of use those commands.
  • Page 80 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Select I2C Bus and Device Used to select which I2C slave device to access. User must specify which BUS_NUM and the device’s DEV_ADDR. Further I2C read/write commands are targeting at a I2C device selected by this command.
  • Page 81 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Set Range for I2C Read Used to specify I2C read range. If not specified, offset is 0 and read one byte. Syntax echo {OFFSET} {BYTES} > /sys/devices/platform/i2c/i_range Parameters ● OFFSET: Register offset to read.
  • Page 82 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Read/Write I2C Slave Syntax [Byte Read] cat /sys/devices/platform/i2c/io_value Syntax [Byte Write] echo {OFFSET} {VALUE} > /sys/devices/platform/i2c/io_value Parameters ● OFFSET: Address offset to write. In one hex byte format. ● VALUE: Hex byte value to write. In one hex byte format.
  • Page 83 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Misc. Reboot Device Syntax reboot Related astparam ● reset_ch_on_boot Version History ● FW >= A5.0.0 Examples Ex1: Reboot system / # reboot 83/104...
  • Page 84 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Turn on/off debug console’s debug message Syntax log.sh [off|on] Parameters ● on: Turn on debug message ● off: Turn off debug message. Default behavior. Related astparam ● en_log: Configure FW boot up default.
  • Page 85 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Reset Setting to Factory Default This command is used to recover wrong user settings back to “Factory Default” setting. “Factory Default” setting is astparam settings saved in “RO” partition. And user settings are the astparams saved in “RW” partition. This command simply erase everything in “RW”...
  • Page 86 ● [Mandatory] Enable IGMP snooping for IGMP V2. ● [Optional] Enable ‘IGMP querier’. (Different from FW <= A6.x.x) [FW>=A7.0.0] HKM01B-4K FW don’t need ‘IGMP querier’. It is ○ recommended to disable it. However enable ‘IGMP querier’ should do no harm.
  • Page 87 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: setting astparam, soc_op_mode, to ‘1’ or ‘2’ may cause unexpected result. Command Changes [C] For client specific. [H] For host specific. ● [C] Although not recommended, legacy “client channel switching” command is still working.
  • Page 88 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Command Mapping FW < A7.x.x FW >= A7.x.x [Client] Switching Channel with ‘reset_ch_on_boot == y’ (to 0001) /# astparam s multicast_ip 225.0.100.001 /# e e_reconnect::0001 /# astparam s ch_select 0001 /# e e_reconnect [Client] Switching Channel with ‘reset_ch_on_boot == n’...
  • Page 89 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: operation. FW auto layout multicast IPs. ch_select Changes: Now, only serves as default value of other ch_select_x. This is a change for supporting ‘free routing’ feature. Impact: No. If you ever create ‘ch_select_x’ astparam by using new ‘e_reconnect::{ch_select}’...
  • Page 90 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: (0000~9999 format), then default ‘0000’ value will be used. FW will automatically append ‘0’ to short digit. For example, ‘16’ will be convert to ‘0016’. 90/104...
  • Page 91 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Appendix A. Channel to Multicast IP Map Different channel need different multicast IP. Also, for supporting free routing, each service has its own multicast IP. So, we map a multicast IP into following 4 parts: 225.1.12.34...
  • Page 92 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: GPIO over IP 225.6.xxx.xxx 225.2.xxx.xxx USBoIP/KMoIP 225.7.xxx.xxx 225.2.xxx.xxx ‘CCC.DDD’ maps from Channel 0000 to 9999: Ch 1234: 225.BBB.12.34 Ch 0000: 225.BBB.0.0 Ch 0001: 225.BBB.0.1 Ch 0002: 225.BBB.0.2 … Ch 0009: 225.BBB.0.9 Ch 0010: 225.BBB.0.10 …...
  • Page 93 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: USBoIP/KMoIP 225.7.0.0 0001 Video over IP 225.2.0.1 Audio over IP 225.3.0.1 IR over IP 225.4.0.1 Serial over IP 225.5.0.1 GPIO over IP 225.6.0.1 USBoIP/KMoIP 225.7.0.1 0099 Video over IP 225.2.0.99 Audio over IP 225.3.0.99...
  • Page 94 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: IR over IP 225.4.12.34 Serial over IP 225.5.12.34 GPIO over IP 225.6.12.34 USBoIP/KMoIP 225.7.12.34 9999 Video over IP 225.2.99.99 Audio over IP 225.3.99.99 IR over IP 225.4.99.99 Serial over IP 225.5.99.99 GPIO over IP 225.6.99.99...
  • Page 95 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: USBoIP/KMoIP 0100 Video over IP 225.2.1.0 Audio over IP IR over IP Serial over IP GPIO over IP USBoIP/KMoIP 1234 Video over IP 225.2.12.34 Audio over IP IR over IP Serial over IP...
  • Page 96 Doc Type: Date: 1/23/2018 FW Rev: Appendix B. IP Port Usage List The IP port usage listed here is for FW >= A7.0.0. For FW version < A7.0.0, please see Documents/System Information/HKM01B-4K IP Port Usage. Category Type Host -> Client Note Host <- Client...
  • Page 97 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: gpio X → 59006 225.6.xxx.xxx 59006 ← X X → 59007 225.7.xxx.xxx 59007 ← X 225.1.0.1 X-> 59101 node_query → node_response X-> 59100 node_response → node_query VideoIP Host encode 225.2.xxx.xxx X → 59200 59201 ←...
  • Page 98 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: extra port needed. 59600 ← X USBoIP USBoIP always use TCP 59700 ← X KMoIP 225.7.xxx.xxx KMoIP always use X → 59702 multicast UDP. 59703 ← X In FW after A7.x.x, KMoIP uses unicast UDP for unicast mode.
  • Page 99 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Appendix C. Link Manager Event List Host Link Control Event Description e_reconnect Switch channel. e_stop_link Stop link. e_chg_hostname Change hostname. Button Events Event Description e_button_link Short press button 1. e_button_link_1 Long press button 1.
  • Page 100 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Client Link Control Event Description e_reconnect Switch channel. e_stop_link Stop link. e_start_usb Manually Start/Stop USBoIP. e_stop_usb e_start_kmoip Manually Start/Stop KMoIP. e_stop_kmoip e_chg_hostname Change hostname. Button Events Event Description e_button_link Short press button 1.
  • Page 101 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: e_btn_toggle_snoop Host video loopback On/Off. e_btn_toggle_snoop_on e_btn_toggle_snoop_off e_btn_request_usb Manually Start/Stop USBoIP. OSD Control Event Description e_osd_on_str Show string OSD. 101/104...
  • Page 102 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Appendix D. List of lmparam Most of lmparam are not allowed to be written from user. Unless special noted, write to lmparam may cause unexpected result. User should use it only for querying link manager’s internal flags.
  • Page 103 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: V_LOOPBACK_ENABLED Current video loopback port on/off state. LOOPBACK_DEFAULT_ON Boot up default status. From astparam, loopback_default_on. USB_CLIENT_IP Attached USBoIP client IP address. Client lmparam Description CH_SELECT Channel selection. In client, each service can choose it CH_SELECT_V own channel to connect to.
  • Page 104 Product: HKM01B-4K Doc Type: Date: 1/23/2018 FW Rev: Appendix E. Sample Code You can find some useful reference source code under Documents/Console APIs/SampleCode/. Folder/File Name Description node_query_windows ‘node_query’ source code and Windows version executable file. node_list_windows ‘node_list’ source code and Windows version executable file.

Table of Contents