Basic Message Structure - Christie Boxer 4K Technical Reference

used for the serial communications is an integer value (for example, 200 to 4000), not the decimal
value seen on the screen.
Available message types
Message type Description
Set A command to set a projector parameter at a specific level, such as changing the
brightness.
Request A request for information, such as what is the current brightness setting.
Reply Returns the data in response to a request or as confirmation of a command.

Basic message structure

Understand the component fields that comprise a standard ASCII message.
Components
Start and end of message
Prefix characters (optional) To acknowledge that Boxer 4K has responded, and/or maximize message integrity,
Projector numbers
(optional)
Function code
+Subcode
Request/reply symbols
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
Every message begins with the left bracket character and ends with the right bracket
character.
If the start character is received before an end character of the previous message,
the partial (previous) message is discarded.
insert one or two special characters before the three-character function code:
• $ (Simple Acknowledgment)—Causes a dollar sign ($) character to be sent from
Boxer 4K when it has finished processing the message.
• # (Full Acknowledgment)—Causes an echo of the message as a reply to be sent
from Boxer 4K when it has finished processing the message.
• & (Checksum)—Allows a checksum to be put as the last parameter in the
message for verification at Boxer 4K.
To control a selected Boxer 4K or controller within a group, include its assigned
number or address just before the three-character ASCII function code.
The Boxer 4K function you want to work with, such as channel selection or gamma,
is represented by a three-character ASCII code (A-Z, upper or lower case). This
function code appears immediately after the leading bracket that starts the message.
In messages sent to Boxer 4K that do not have a subcode, a space between the
function code and the first parameter (or special character) is optional.
The Boxer 4K function you want to work with may have one or more subcodes that
allow you to select a specific source, image, channel or subfunction.
The subcode is represented by a four-character ASCII code (A-Z, upper or lower
case, and 0-9). This subcode appears immediately after the function code, with a
plus sign (+) character to separate the code and subcode. If there is no subcode, the
plus sign (+) is also omitted. In messages sent to Boxer 4K that have a subcode, a
space between the subcode and the first parameter (or special character) is optional.
If the controller is requesting information from Boxer 4K, a question mark (?)
appears directly after the function code. If Boxer 4K is replying, an exclamation
Communicating with Boxer 4K
7