|
|
|
|
|
| Communication Protocol 3000 | |||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Result codes (errors) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Syntax |
| ||||||||
No error. Command running succeeded |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| OK |
|
|
| ||||||
| ~DEV_ID@ | COMMAND |
| PARAMETERS | CRLF |
|
| ||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Protocol Errors |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Syntax Error (For example: Not enough parameters) |
| ~DEV_ID@ | COMMAND | ERR001 | CRLF |
|
| ||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |||||
Command not available for this device |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ||||||
| ~DEV_ID@ ERR002 | CRLF |
|
|
| ||||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ||||||||
Parameter is out of range |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ERR003 |
|
|
|
|
|
| |||||
|
|
|
|
|
| ~DEV_ID@ | COMMAND | CRLF |
|
| |||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ||||||
Unauthorized access (running command without the matching login). |
|
|
|
|
|
|
|
|
|
| ERR004 |
|
|
|
|
|
| ||||||||||
| ~DEV_ID@ | COMMAND | CRLF |
|
| ||||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Security commands |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Command |
| Syntax |
|
| Response | ||||||||||||||||||||||
Read Security flag |
| SECUR? |
|
| SECUR |
|
|
|
|
|
|
| |||||||||||||||
| ON/OFF | ||||||||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| ||||||||||||
Login |
| LOGIN |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AUTH |
| PASSWORD |
|
|
| LOGIN | AUTH |
| RESULT |
| |||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
| ||||||||||||||||
|
|
|
|
|
|
|
|
|
| ||||||||||||||||||
Get Login |
| LOGIN? |
|
| LOGIN |
|
|
|
|
| |||||||||||||||||
| AUTH | ||||||||||||||||||||||||||
|
|
|
|
|
|
|
| ||||||||||||||||||||
Logout |
| LOGOUT |
|
| LOGOUT |
|
|
|
|
|
| ||||||||||||||||
| RESULT | ||||||||||||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AUTH = USER \ ADMIN.
ON/OFF = "0" or "OFF" "1" or "ON"
Login flow:
(Password and SECUR mode can be set from
1.Send SECUR? Command
2.If answer is SECUR OFF – no login needed.
3.If answer is SECUR ON – continue to login (step 4)
4.Send LOGIN USER, PASSWORD
5.Device will start to work normally.
6.If communication is not active for more than 5 minutes – UDP socket will be closed and device will logout automatically so you will need to LOGIN again.
7.To eliminate automatic logout – you can send any command (for example Handshake) from time to time.
8.On program exit send LOGOUT (If not – device will automatically logout after timeout).
Password sessions:
Login with user or admin password will open a match session, so it is possible to continue entering commands without
For Ethernet connection, sessions will be opened while socket connection is live. For Serial or USB connection, session will live until
* To reset admin password you need to factory reset all the device data.
14 | KRAMER: SIMPLE CREATIVE TECHNOLOGY |
