SC&T HKM01B-4K Bedienungsanleitung

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

1/104

Table of Contents

Revision History

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

Get/Set Link Manager Internal Parameters

Get Link Manager State

Simulate Button Press

Link Management

Switch Channel [Client Only]

Switch Channel [Host Only]

Stop Link [Client Only]

Stop Link [Host Only]

Get Current Channel Setting

IP Network Commands

Change Host Name ID

Get Host Name

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

2/104

Get IP Address

Get MAC Address

Get Ethernet Link Status and Mode

Node Discovery and Query

Video Commands

Configure Graphic/Video Mode [Host Only]

Set Anti-Dither Mode [Host Only]

Enable/Disable Loopback Port [Host Only]

Frame Rate Control [Host Only]

Bit Rate Control [Host Only]

Detach/Attach Video Input Port [Host Only]

Upload/Copy Video Downstream Sink’s EDID

Get Current EDID Reported to Upstream [Host Only]

Get Video Source Timing Information

Get Video Engine State

Get Video Sink Information

Turn Off/On Video Output [Client Only]

Pause/Black-out Video Stream [Client Only]

Select Video Input Port [Host Only]

Scale Video Output/Video Hybrid Mode [Client Only]

Take Video Snapshot

Video Wall Commands

Show Picture When Link Down

OSD Commands

Show String OSD [Client Only]

Show Picture OSD [Client Only]

Audio over IP Commands

Audio Source Port Selection [Host Only]

Analog Audio Volume Control

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

3/104

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]

USBoIP Device Exporting Policy [Client Only]

IR over IP Commands

IR Guest Mode and Protocol Decode

I2C Access

Initial I2C Bus

Select I2C Bus and Device

Set Range for I2C Read

Read/Write I2C Slave

Misc.

Reboot Device

Turn on/off debug console’s debug message

Reset Setting to Factory Default

Migrate From Legacy Console APIs

Ethernet Switch Configuration

Incompatible

Command Changes

Command Mapping

astparam Changes

Appendix A. Channel to Multicast IP Map

Appendix B. IP Port Usage List

Appendix C. Link Manager Event List

Host

Link Control

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

4/104

Button Events

Client

Link Control

Button Events

OSD Control

Appendix D. List of lmparam

Common

Host

Client

Appendix E. Sample Code

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

5/104

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.

● 2017/11/10:

○ [Appendix D::Client] Add GWIP lmparam. Will be supported after A7.1.1.

for backward compatible with A6.x FW.

● 2017/10/30:

○ [Change Host Name ID] Due to above behavior, we recommended don’t

use astparam, hostname_id, on host device. Use

‘e_reconnect::{ch_select}’ command instead.

○ [IR over IP Commands] Add IR guest mode information.

● 2017/10/5:

○ [Appendix B. IP Port Usage List] Add FW version information.

● 2017/09/12:

○ [Switch Channel (Client Only)] Update Ex7.

● 2017/08/01:

○ [Analog Audio Volume Control] Add “Analog Audio Volume Control”

information.

● 2017/07/24:

○ [Switch Channel (Client Only)] Add more ‘CH_SELECT’ details.

● 2017/07/18:

○ [Manually Start/Stop USBoIP and KMoIP] Add Ex3.

● 2017/07/14:

○ [Node Discovery and Query] Add new ‘--intf’ option for ‘node_query’

command.

● 2017/07/12:

○ Revised “Migrate From Legacy Console APIs::Ethernet Switch

Configuration”.

○ Revised “Overview::Supported Platform”.

● 2017/07/07:

○ First version.

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

6/104

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:

● Debug console: is set to UART port 2 using baud rate at 115200-8n1.

● Telnet port 24: There is built-in telnet server to connect to HKM01B-4K devices.

● Web CGI: Controlled through web protocol. Mapping CGI command to console

command.

Through console APIs, developers can get more control on HKM01B-4K firmware and

extend product's features and capability.

Supported Platform

● AST1520

● AST1525

● AST1510: Only supports commands introduced before A7.0.0. FW >= A7.0.0

doesn’t support AST1510 platform.

● AST1500: Only supports commands introduced before A7.0.0. FW >= A7.0.0

doesn’t support AST1500 platform.

Supported FW Version

Supported FW version is listed in each command. This document is based on A7.0.0.

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

7/104

Terminology

Term. Description

HKM01B-4K Refers to all series of AST1500, AST1510, AST1520.. platform.

AST152X Refers to AST1520 and AST1525.

host The HKM01B-4K video encoder board.

Tx Same as ‘host’.

client The HKM01B-4K video decoder board.

Rx Same as ‘client’.

node Generic term for ‘host’ and ‘client’.

device Same as ‘node’.

FW Short of ‘firmware’. Normally refers to HKM01B-4K’s firmware.

HW Short of ‘hardware’. Normally refers to HKM01B-4K’s HW platform.

console FW’s command line interface (CLI).

console API FW provides commands through console as API.

Link Manager A major FW script/program handling most of user space link

management.

astparam A command to access parameters in flash. Also refer to those

parameters accessed through this command.

lmparam A command to access internal parameters of ‘Link Manager’. Also

refer to those parameters accessed through this command.

event 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. To simplify the process of choosing multicast IP, we use

‘channel’ to represent/mapping each service’s multicast IP/group.

Normally, each host has its own unique channel setting. So that

client can choose which host to connect to by specifying the host’s

‘channel’ number.

switch channel The process of changing ‘channel’ number.

sink Video sink. Refer to TV, monitor which attached to HKM01B-4K’s

client video output port or HKM01B-4K host’s video loopback output

port.

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

8/104

source Video source. Refer to video player whichever feed HDMI/DVI video

signal to HKM01B-4K host.

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

USBoIP Short of ‘USB over IP’ extension function. Specially refers to

‘transparent’ type of ‘USB over IP’ extension function. Comparing to

‘KMoIP’ which is ‘emulation’ type.

KMoIP Short of ‘Keyboard/Mouse over IP’ extension function. It is a kind of

USB extension, but uses ‘emulation’ technology instead of

‘transparent’ USBoIP.

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

9/104

Preface

How to Access the Console

There are 3 ways to access the console:

1. UART2 debug port: It is a RS232 interface using 115200-8n1 baudrate setting.

Developer can attach to this debug port to access console.

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. NOTE: Default use telnet port 24 instead of 23. Use "root" to

3. Use Web CGI: FW has built-in web server and has a CGI command to mapping console

commands to CGI. Check the Web UI ⇒ System ⇒ Utilities ⇒ Console API Command.

Use telnet or web protocol are recommended way for developing control software.

UART2 debug port is usually used for engineering test and debug. By default, debug port

will output a lot of debug messages. You can turn it off.

Product: HKM01B-4K

Date: 1/23/2018

FW Rev:

Doc Type:

10/104

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" mapping by themselves. Here are the methods to resolve the IP address using

"autoip" mode.

● Client's GUI: The client's GUI will display the client's IP address and connected

host's IP address.

● Console APIs: Following console APIs are provided:

○ [FW >= A7.0.0] node_query: An enhanced version of node_list. See

“Node Discovery and Query” section for details.

○ [FW < A7.0.0] node_list: use this command to list all HKM01B-4K

boards' hostname and IP address.

○ astresname: use this command to resolve a target's IP address by

providing target's hostname.

● From PC: Following methods are provided:

○ For end users, please reference to “Documents/Web UI/How to Connect to

Web UI” document.

○ Developer can use/implement ASPEED proprietary discovery protocol.

Reference to “node_query” or “node_list” sample code. There is pre-

compiled execute files for Windows OS under “Documents/Console

APIs/SampleCode/”.

○ Use the mDNS libraries. For example:

■ Bonjour: http://developer.apple.com/networking/bonjour/

■ pyZeroConfig: http://sourceforge.net/projects/pyzeroconf/files/

Inhaltsverzeichnis

Andere SC&T Extender Handbücher

SC&T

SC&T HE01SE Bedienungsanleitung

SC&T

SC&T UE02H Bedienungsanleitung

SC&T

SC&T AE01-T Bedienungsanleitung

SC&T

SC&T HKM01-4K Bedienungsanleitung

SC&T

SC&T HE01SE Bedienungsanleitung

SC&T

SC&T HKM01-4K-KS Bedienungsanleitung

SC&T

SC&T HE03 Bedienungsanleitung

SC&T

SC&T DKM01 Bedienungsanleitung

SC&T

SC&T IP05I Bedienungsanleitung

SC&T

SC&T HKM01T-4K Bedienungsanleitung

SC&T

SC&T HE04SEK Bedienungsanleitung

SC&T

SC&T UE03 Bedienungsanleitung

SC&T

SC&T Cable Series Bedienungsanleitung

SC&T

SC&T VKM04 Bedienungsanleitung

SC&T

SC&T HE01SL Bedienungsanleitung

SC&T

SC&T IP01 Bedienungsanleitung

SC&T

SC&T HE02PT Bedienungsanleitung

SC&T

SC&T HE03L-4K Bedienungsanleitung

SC&T

SC&T VKM03T Bedienungsanleitung

SC&T

SC&T HE05BT Gebrauchs- und Pflegehandbuch

SC&T

SC&T VKM02 Bedienungsanleitung

SC&T

SC&T HE01S Bedienungsanleitung

SC&T

SC&T HD401F-5M Bedienungsanleitung

SC&T

SC&T VE05AL Bedienungsanleitung

Beliebte Extender Handbücher anderer Marken

SY HDBT-60T Bedienungsanleitung

Appsys ProAudio

Appsys ProAudio ADX-16 Bedienungsanleitung

Atlona

Atlona RS232 Bedienungsanleitung

IDK

IDK OPF-TH1000-A Bedienungsanleitung

Enable-IT

Enable-IT 824WP Bedienungsanleitung

Worx

Worx Landroid RadioLink WA0864 Technisches Datenblatt

TP-Link

TP-Link TL-WA730RE Bedienungsanleitung

Camplex

Camplex CMX-HDMI-SFPL Bedienungsanleitung

Marmitek

Marmitek MegaView70 Bedienungsanleitung

Samsung

Samsung SCS-26UC4 Bedienungsanleitung

Foxun

Foxun SX-GES24 Bedienungsanleitung

MuxLab

MuxLab 500771 Bedienungsanleitung

foxunhd

foxunhd SX-AEX01 Bedienungsanleitung

TERK Technologies

TERK Technologies LFIRX2 Bedienungsanleitung

Devolo

Devolo Audio Extender Handbuch

Edimax

Edimax EW-7438RPn V2 Bedienungsanleitung

Shinybow USA

Shinybow USA SB-6335T5 Bedienungsanleitung

SECO-LARM

SECO-LARM ENFORCER EVT-PB1-V1TGQ Bedienungsanleitung