Special Characters For Text - Christie Boxer 30 Technical Reference

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

Special characters for text

To use special characters in the API commands, you must use a two-character combination.
Special character
"
\
(
)
Line break
Send arbitrary code
Boxer 30 Technical Reference–Serial API Commands
020-102096-08 Rev. 1 (08-2020)
Copyright © 2020 Christie Digital Systems USA, Inc. All rights reserved.
Description
• All values returned by Boxer 30 (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 30
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 30 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". For example, the
time command requires time to be provided in text enclosed in double quotation
mark, as in "19:45:23". Use all characters as required except for special characters
—these require a two-character combination.
Two-character
combination
\"
\\
\(
\)
\n
\h##
Communicating with Boxer 30
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.
Sends one arbitrary code defined by the two
hexadecimal digits ##.
10