Kramer Electronics Ltd.
KDS-EN6, KDS-DEC6
– Introduction
3
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.
[x]
Keywords or parameters that appear within square brackets are optional.
{x}
Keywords or parameters within braces must be entered.
x|y
Keywords or parameters separated by a vertical bar require you to choose one option.
x||y
Keywords or parameters separated by a double vertical bar allow you to choose any or
all the options.
All commands and parameters are case sensitive.
“
/ #
“ in a command example refers to a command prompt and is not part of the command.
To access the console using Telnet
Every KDS-6 host/client FW has Telnet and a Telnet client 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 by the “Configuration APIs” (called “Astparam”). Astparam is the console
command to access these system configurations. We also name these system configuration
as Astparam.
Astparam can be saved in flash ROM. So that system configuration is not lost after a system
power failure.
The Astparam format is simply a key=value string pair. Both the
“key” and “value” are ANSI
strings and case sensitive. The firmware decides how to use it. The firmware does not
validate the Astparam, so any typed error could cause unexpected results.
All configuration modifications are saved in RAM until
astparam save
command is called.