Kramer KDS-7-MNGR

Kramer Electronics Ltd.
KDS-7-MNGR – Protocol 3000
66
Protocol 3000 Commands
Function
Description
Syntax
Response
Parameters/
Attributes
Example
ADDUSER
Add a new user
+ Require LOGIN
firstly even SECUR
is Off
+ Only admin has
the permission
+ Require LOGIN
firstly
#ADDUSER
<user_name>,<level>,<password><CR
>
~nn@ADDUSER
<user_name>,<level>,<passwor
d><CR>
<user_name> - The
specific username,
alphanumeric, hyphen
and underscore within 24
characters, hyphen and
underscore can not at
beginning or end
<level> - User level
- admin
- config
- operator
<password> - Password,
8 to 24 characters (letters,
numbers, and symbols
without spaces or
commas), at least
including one number,
one symbols without
spaces or commas, one
uppercase letter and one
lowercase letter.
Add a configurator user (Bob):
#ADDUSER Bob,config,Pass1234
RMUSER
Remove an user
+ Require LOGIN
firstly even SECUR
is Off
+ Only admin has
the permission
#RMUSER <user_name><CR>
~nn@RMUSER
<user_name><CR>
<user_name> - The
specific username,
alphanumeric, hyphen
and underscore within 24
characters, hyphen and
underscore can not at
beginning or end
Remove the user Bob:
#RMUSER Bob
BL-VERSION?
Get bootloader
version
#BL-VERSION?<CR>
~nn@BL-VERSION
<bootloader_version><CR><LF>
<bootloader_version> –
XX.XX.XXXX where the
digit groups are:
major.minor.version
Get the BL version:
#BL-VERSION?
ETH-PORT
Set Ethernet port
protocol.
+ If the port number
you enter is already
in use, an error is
returned.
#ETH-PORT
<port_type>,<port_id><CR>
~nn@ETH PORT
<port_type>,<port_id><CR><LF
>
<port_type> - TCP/UDP
<port_id> -
When port_type = TCP:
5000~5099
When port_type = UDP:
50000~50999
Set the Ethernet port protocol for TCP
to port 5001:
#ETH-PORT TCP,5001
ETH-PORT?
Get Ethernet port
protocol.
#ETH-PORT? <port_type><CR>
~nn@ETH PORT
<port_type>,<port_id><CR><LF
>
<port_type> - TCP/UDP
<port_id> -
When port_type = TCP:
5000~5099
When port_type = UDP:
50000~50999
Get the Ethernet port protocol:
#ETH-PORT? TCP
FACTORY
Reset device to
factory default
configuration.
+ This command
deletes all user data
from the device. The
deletion can take
some time.
It does not trigger
reset, it need
another API 'RESET'
for taking effect
#FACTORY<CR>
~nn@FACTORY ok<CR><LF>
N/A
Reset the device to factory default
configuration:
#FACTORY
HW-TEMP?
Get temperature of a
specific region of the
hardware.
+ The Get command
is not available for all
parts of the
hardware, and is
device specific.
#HW-TEMP?
<region_id>,<mode><CR>
~nn@HW-TEMP
<region_id>,<temperature><CR
><LF>
<region_id> - ID of the
region for which to get the
temperature
0 - First CPU
<mode> -
0 - Celsius
1 - Fahrenheit
<temperature> -
Temperature of the HW
region, rounded down to
the closest integer
Get the device temperature in
Celsius:
#HW-TEMP? 0,0
HW-VERSION?
Get hardware
version
#HW-VERSION? <CR>
~nn@HW-VERSION
<hardware_version><CR><LF>
hardware_version –
XX.XX.XXXX where the
digit groups are:
major.minor.version
Get the hardware version:
#HW-VERSION?
IDV
Set visual indication
from device.
+ Using this
command, some
devices can light a
sequence of buttons
or LEDs to allow
identification of a
specific device from
similar devices.
#IDV<CR>
~nn@IDV ok<CR><LF>
N/A
Identify the device:
#IDV
KDS-DEV-
CEC-SND
Send CEC command
to specific device
#KDS-DEV-CEC-SND
<device_id>,<port_index>,<sn_id>,<cm
d_name>,<cec_len>,<cec_command><
CR>
~nn@KDS-DEV-CEC-SND
<device_id>,<port_index>,<sn_i
d>,<cmd_name>,<cec_len>,<ce
c_command><CR><LF>
<device_id> - ID of device
<port_id> - 1 to n
(machine dependent)
<sn_id> - The sequence
number ID
<cmd_name> - Command
name
<cmd_len> - How many
bytes should send
<cec_command> - Hex
string
Send a CEC command to a device
#KDS-DEV-CEC-SND KDS-DEC7-
001D56080B53,1,1,1,2,4004