Table of Contents
Advertisement
K.I.S.S.™ (Keep It Simple Serial™)
The K.I.S.S.™ Command Structure
The following conventions are used to describe the protocol:
<CR>
= An ASCII Carriage Return ('0D' hex)
<LF>
= Line Feed ('0A' hex)
<ESC> = An Escape character ('1B' hex)
CMD
= A command, consisting of only alpha characters (A-Z, a-z).
ERR
= An error code value, consisting of only decimal digits (0-9).
Device
= The Zektor device being controlled.
Controller
= A PC or other system, used to control the Zektor device.
Parameter
= A decimal value that may, in some cases, be prefixed with '+' or '-' (+,-,0-9).
A K.I.S.S.™ command in its simplest form is a CMD following by a <CR> for instance:
V<CR>
This will return the version number of a Zektor device.
A command can have a variable number of parameters with optional whitespace(s) following the
command, for instance:
P1<CR>
or
P 1<CR>
will turn on the power of most Zektor devices. The spaces between the 'P' and '1' are optional.
Since commands consist of alpha characters only, there can never be a 'P1' command and 'P1'
will always be interpreted as 'P 1'.
When a command has more than one parameter, the parameters are separated by either
whitespace(s) or a comma, or both whitespace(s) and a comma, for instance:
LI 3 13<CR>
or
LI 3 , 13<CR>
will set the lower and upper LED front panel intensity levels of most Zektor devices. Once again
the space between the command and 1st parameter is optional. Space(s) may also appear
before and after the comma.
The comma is optional between parameters except when it is necessary to indicate a default
parameter, for instance:
LI ,13<CR>
would set the upper intensity level of the front panel LEDs without affecting the lower level. The
comma is used to indicate the 1st parameter is not supplied and the default value should be
used (in this case the value defaults to the current setting, leaving the value unchanged). The
2
CVS4 Component Video Switch
K.I.S.S.™ (Continued)
space before the comma is optional.
Most commands can be queried for their current settings by substituting the '?' for the parameter
list, or by not supplying any parameters at all. For instance to request the current LED Intensity
settings:
LI ?<CR>
or
LI<CR>
This would cause the device to issue a LED Intensity Response, (the Response String format
is described in the section entitled: "The Response String"). The whitespace before the '?' is
optional.
Commands that can supply more than one Response String per query request, or commands
that are backwards compatible with the HDS4.2 require a '?' and will generate a parameter count
error if no parameters are given.
Using Bitmapped Parameters
Some commands accept "Bitmapped" parameters. These are decimal values that represent a
series of flags, or bits, that control, enable and/or disable different device operations.
Binary arithmetic is used to represent bitmapped parameters, it is assumed the reader has some
familiarity with binary arithmetic.
An example of a command that uses a bitmapped parameter is the "XS settings<CR>" com-
mand, which is defined like this:
XS settings<CR>
Where 'settings' is a bitmapped parameter:
Decimal Value
+128 +64 +32 +16
Bit Position
7
6
5
4
Name
0
CRC CSE IRJ IRS IRE FP
Factory Settings:
0
0
0
1
AS
- 0=Master / Slave mode.
1=Asynchronous Mode.
KB
- 0=Disable Front Panel.
1=Front Panel Enabled
IRE - 0=Disable IR.
1=Enable IR.
IRS - 0=Turn off IR Sensor.
1=Turn on IR Sensor.
IRJ - 0=Turn off IR Jack.
1=Turn on IR Jack.
CSE - 0=Disable CS and CRC-8 1=Append either Checksums or CRC-8 to responses.
CRC - 0=Append Checksums or, 1=Append CRC-8's to reponses.
0
- Reserved, always set to 0.
This indicates the parameter 'settings' is bitmapped parameter, followed by a description of what
each bit represents.
The 'Decimal Value' in the table's header, refers to the values added together to create the deci-
+8
+4
+2
+1
3
2
1
0
AS
1
1
1
0
CVS4 Component Video Switch
Advertisement
Table of Contents
