Kramer Electronics revision1 manual Commands Entering, Commands Forms, Input String Max Length

Page 14

Communication Protocol 3000

4.3Commands Entering

If a terminal software is used to connect over serial \ ethernet \ USB port, it is possible to directly enter all commands characters ( will be entered by Enter key, that key sends also , but this char will be ignored by commands parser).

Sending commands from 3rd party controllers requires the coding of some characters in a special form (such as \X##). With most 3rd party units there is a way to enter all ASCII characters so it is possible to send all the commands also from the controller.

4.4Commands Forms

Some commands have a short name syntax beside the full name to allow faster typing, response is always in long syntax.

4.5Input String Max Length

64 characters.

General Commands

Command

 

 

Syntax

 

 

Response

Protocol Handshaking

 

 

 

~

 

 

 

#DEV_ID@

DEV_ID@ OK

Parameters:

DEV_ID – Each device has its own K-Net ID that matches to a specific device in K-Config configuration tree.

K-Net Auxiliary Device must react only to commands which are preceded by its own ID.

Example:

WebAccess: #03@

Device Application: ~03@ OK

Note:

Every device (or application that emulates a device) should reply to this request if preceded by its K-Net ID.

Room controllers commands

Emulate button action

#01@BTN

BTN

,[

KEYPAD_ID

,[

ACTION

]]CR

 

~01@BTN

BTN

,

KEYPAD_ID

,

ACTION

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

RESULT

CRLF

 

 

 

 

 

 

 

 

 

 

 

 

 

Device needs to send this command to the master device when it wants to emulate button action

 

 

 

 

 

 

 

 

 

BTN – Button ID according to the configuration in K-Config

KEYPAD_ID – The KNET ID of the device that the emulated button belongs to according to the configuration in K-Config ACTION - P=Button Pressing / H= Button Holding / R=Button Release.

Valid button operations sequence will be P->H(->H…)->R or P->R or only R.

Pressing and Holding will activate “Activate while pressed” trigger if defined in K-Config, Releasing will activate “Activate on Release” and “Toggle” triggers.

RESULT – OK

User can supply 1, 2 or 3 arguments.

The default arguments are :

KEYPAD_ID - the first ID on the list (in the file portdef.ini)

ACTION – P=Button Pressing / R=Button Release.

Example (device application emulate releasing of button 1 in keypad 3):

Device Application: #01@BTN 1,3,RCR

Master response: ~01@BTN 1,3,R OKCRLF

Note: Master response may be followed by other commands or replies according to the Action list for the button trigger from configuration in K-Config.

Config RGB button leds

#

DEV_

ID@RGB

BTN

,

RED

,

GREEN

,

BLUE

,

STATE

CR

 

 

~DEV_

ID@RGB

BTN

,

RED

,

GREEN

,

BLUE

,

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

STATE

 

RESULT

CRLF

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Device that implements lit buttons should react to this command and set its button.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Device can support full color buttons or just plain on/off lights.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

12

 

 

 

 

 

 

 

 

 

 

 

KRAMER: SIMPLE CREATIVE TECHNOLOGY

Image 14
Contents Kramer Control Systems Virtual Device Build Guidelines Contents Communication Layer IntroductionDefinitions within the context of this document 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 Host message format Command parts detailsCommunication Protocol Input String Max Length Commands EnteringCommands Forms Master Device#03@RGB 1,0,255,0,1CR Communication Protocol