Kramer Electronics revision1 manual Communication Protocol

Page 16

 

 

 

 

 

 

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 K-Config program).

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 re-login until connection will terminate.

For Ethernet connection, sessions will be opened while socket connection is live. For Serial or USB connection, session will live until time-out will reach.

* To reset admin password you need to factory reset all the device data.

14

KRAMER: SIMPLE CREATIVE TECHNOLOGY

Image 16
Contents Kramer Control Systems Virtual Device Build Guidelines Contents Definitions within the context of this document IntroductionCommunication Layer Virtual Device an Application Example System OverviewHardware Setup ImplementationSetup Example Functionalities #\rConnecting the Virtual Device to the Room Controller Connecting Flow Chart Sending and receiving Data to/from Master RC Sent command from Virtual Device application Sending and Receiving Commands Communication Protocol Command parts detailsHost message format Commands Forms Commands EnteringInput String Max Length Master Device#03@RGB 1,0,255,0,1CR Communication Protocol