Special Characters For Text - Christie Boxer 4K Technical Reference

Components
Data
Text parameters
Related information
Special characters for text (on page 8)
Maximizing message integrity (on page 10)

Special characters for text

To use special characters in the serial API commands, you must use a two-character combination.
Special character
"
\
(
)
Line break
Boxer 4K Serial API Commands Technical Reference
020-101697-05 Rev. 1 (07-2017)
Copyright 2017 Christie Digital Systems USA Inc. All rights reserved.
©
Description
mark (!) appears directly after the function code. For set messages to Boxer 4K,
neither of these characters appear—data directly follows the code and subcode.
The value for a given Boxer 4K state, such as on or off, appears in ASCII-decimal
format directly after the request/reply symbol. You can add an optional space after
the symbol—such as before the data—in a set message, but data in replies follow the
exclamation mark (!) symbol without a space. Other details to remember about data
• All values returned by Boxer 4K (reply messages) have a fixed length,
regardless of the actual value. For a specific parameter, the length is always the
same (for example, contrast is always returned as three characters, Boxer 4K
number is always returned as five characters). The minimum parameter size is
three characters. Values less than the predefined size are padded with leading
zeros as needed. Parameters which have negative signs are zero padded after
the negative sign, and have one less digit to make space for the sign.
• If entering a negative number, there must be a space between the code/
subcode and the value for example (CRM3) and (CRM 3) can both be used when
the number is positive. (CRM -2) is acceptable, but (CRM-2) is not.
• Data in set messages to Boxer 4K do not require padding with zeros.
• Within each message, multiple parameters of data must be separated by one
space character.
• Text parameters such as channel names are enclosed in double quotes following
the data, as in Name.
Most data is simply a numerical value, however some messages also require text.
For example, a channel naming message typically includes a text-based name—
enclose this text in double quotation marks, as in "Tilt the Wagon". Use all
characters as required except for special characters—these require a two-character
combination.
Two-character combination
\"
\\
\(
\)
\n
Communicating with Boxer 4K
Description
Double quotation mark
Backslash
Left bracket
Right bracket
New line —If the text can be
displayed on more than one line,
this sets the line break.
8