Hall Technologies 2/1/2024
Page 24 of 28
HIVE-KP8 API
Telnet Commands (Port 23)
The KP8 is controllable by Telnet on port 23 of the devices IP address.
•
The UI-IP8-
DP responds with “Welcome to Telnet.<CR><LF>” when the user connects to the
Telnet port.
•
Commands are in ASCII format.
•
Commands are not case sensitive. Both uppercase and lowercase characters are acceptable.
•
A single <CR> character terminates each command.
•
One or more <CR><LF> characters terminate each response.
•
Unknown commands respond with “Command FAILED<CR><LF>”.
•
Command syntax errors respond with “Wrong command format!!<CR><LF>”
Command
Response
Description
IPCONFIG
ETHERNET MAC : xx-xx-xx-xx-
xx-xx<cr><lf>
Address Type : DHCP or
STATIC<cr><lf>
IP : xxx.xxx.xxx.xxx<cr><lf>
SN : xxx.xxx.xxx.xxx<cr><lf>
GW : xxx.xxx.xxx.xxx<cr><lf>
HTTP PORT : 80<cr><lf>
Telnet PORT : 23<cr><lf>
Shows the current network IP
configuration
SETIP N,N1,N2
Where
N=x.x.x.x (IP Address)
N1=x.x.x.x (Subnet)
N2=x.x.x.x (Gateway)
If a valid command is used,
most likely there will be no
response unless there was a
command formatting error.
Set the static IP address, subnet
mask and gateway
simultaneously.
There should be no ‘spaces’
between “N”, “N1” and “N2”
values
or a “Wrong command
format!!” message will occur.
SIPADDR X.X.X.X
Set the devices IP address
SNETMASK X.X.X.X
Set the devices subnet mask
SGATEWAY X.X.X.X
Set the devices gateway address
SIPMODE N
Set DHCP or Static IP addressing
VER
<SPACE>-----> vx.xx <-----
<CR><LF>
(There is a leading space)
Show installed firmware version.
Note there is a single leading
space character in the response.
FADEFAULT
Set the device to factory defaults
ETH_FADEFAULT
Set IP settings to factory default
