Zektor Clarity HD® 8X8 HDMI Matrix - Manual (Page 15)

ClarityHD8x8 Serial Protocol, Version 1.1, 6/7/13 15
Command Syntax
Command Syntax
Command Syntax
The ClarityHD8x8 serial command set uses an ASCII based protocol and a terminal emulator can be
used to test the serial port of the ClarityHD8x8.
Each serial command is formatted as:
^CMD param1,param2,...$
Where:
^ = All commands and responses start with the ‘^’ character.
CMD = The name of the command.
param = Any number of parameters can follow a command.
$ = All commands and responses end with the ‘$’ character.
For instance the name of the command to turn power on / off is ‘ P ’ (must be capitalized) therefore, to
turn on the ClarityHD8x8 send:
^P 1$ -> Command sent to the A/V switch
^+$ <- Acknowledgment indicating valid command
^=P 1$ <- Response from the A/Vswitch for new setting
to turn off the ClarityHD8x8 send:
^P 0$ -> Command sent to the A/V switch
^+$ <- Acknowledgment indicating valid command
^=P 0$ <- Response from the A/V switch for new setting
N OTE : Only the characters between ‘^’ and ‘$’ are valid, any characters sent before the ‘^’ or after the ‘$’
will be ignored.
N OTE : By default, the ClarityHD8x8 adds a carriage return and a line feed to the end of its responses, after
the ‘$’. This makes testing with terminal software easier. Since they are outside the ‘^’ and ‘$’ char-
acters, they should be ignored by software drivers. If desired, this behavior can be disabled. (See:
“‘XS’ Control Settings” on page 23)
Command Responses
Type of Responses and Timing Information
There are three different types of responses: Acknowledgements, Errors and Query Strings.
By default, the ClarityHD8x8 will always respond to a command, there are no “time-out” modes, if
you send a command and don’t get a response within 100ms, something’s wrong with the connection.
The Acknowledgement Response
Every command will be followed by an acknowledgement or error response.
Anytime you issue a command and there are no errors, you will receive the acknowledgement
response. Which is:
^+$