Hdmi5 Command Ref; The Hdmi5 K.i.s.s.™ Command Reference; Error Response Codes; The Hdmi5 Command Set - Zektor HDMI5 User Manual

HDMI5 Command Reference
The HDMI5 K.I.S.S.™ Command Reference
This section defines the K.I.S.S.™ commands that are available to the users of the HDMI5.

Error Response Codes

The following are the Error Response codes that can be returned by the HDMI5.
!1<CR><LF>
Unrecognized command.
!2<CR><LF>
A parameter was out of range.
!3<CR><LF>
Syntax error, badly formed command.
!4<CR><LF>
Checksum or CRC-8 error.
!5<CR><LF>
Too many or too few parameters.
!6<CR><LF>
System busy cannot process command.
!7<CR><LF>
Buffer overflow.
And some more detailed descriptions of their meanings:
Error 1: The command given was not recognized as a HDMI5 command. Commands are case
sensitive and in the HDMI5, all commands are upper case.
Error 2: One of the parameters given was too large, or too small, the command will be ignored.
Error 3: Something was wrong with the command's syntax. There was possibly extra data at the
end of the line, or non-decimal data as part of a parameter. There cannot be whitespace before
or after a checksum or CRC-8 checkcode, or this error will be returned.
Error 4: The ';' or ':' character was used to indicate a Checksum or CRC-8 Checkcode was
appended to the command string, but the Checksum or CRC-8 Checkcode did not match the
calculated one. The command will be ingnored.
Error 5: The number of parameters given does not match the number allowed by this command.
Error 6: To prevent conflicts between the front panel Setup Mode and the serial port settings,
when the HDMI5 is in the Setup Mode, many parameters become read only and any attempt at
writing them will return Error 6. The "Front Panel Button Emulation" command with button code
'0' can be used to exit the Setup Mode, at which point the command can be re-issued without an
Error 6 response.
Error 7: An internal buffer has overflowed, for instance more than 16 button codes were sent as
part of the "Front Panel Button Emulation" command.

The HDMI5 Command Set

Each command will be listed in all the different ways it can be issued. Usually each command
has two different ways of being issued. The first is used to set its value, the second as a query
command.
1 HDMI5 Component Video Switch
HDMI5 Command Ref. (Cont'd)
If the command has an associated response string, it will also be listed.
As described in the section on the K.I.S.S.™ protocol, whitespaces and commas are optional
in many cases. The format used here includes a single space after the command and com-
mas, with no spaces, between parameters. The format given here does not show the optional
checksum or CRC-8 checkcodes that may be appended to all commands, nor does it show the
required <CR> that terminates all commands.
The response strings are the strings returned from HDMI5, which use the same format as
described above. The format does not show the optional checksum or CRC-8 checkcodes that
may be appended to all response strings if enabled, nor does it show the <CR><LF> that
terminates all Response Strings.

Version Query

Query for the current firmware version and PCB type of the HDMI5.
V ?
Request version string.
V
Request version string.
Response String:
=V HDMI5 firmware_ver (pcb_rev)
Where:
firmware_ver = Version number of the HDMI5's firmware.
pcb_rev = PCB Revision.

Power Control

Turn on / off, or toggle the power state of the HDMI5.
P 0
Turn off power.
P 1
Turn on power.
P +
Toggle power.
P ?
Query for current setting.
P
Query for current setting.
HDMI5 Component Video Switch 1