Control API

Definitions

This section describes the communication protocol between the control system and the MCP4kR2


Connection	TCP (NGTC-MCP4kR2 is server), Port 84
Command Format	!Command(parameter)`<cr>` or !Command?`<cr>`

Caution

All commands start with “!”, end with <CR>
<CR>stands for “carriage return”, corresponding hex is 0x0D
<LF> stands for “line feed”, corresponding hex is 0x0A
If a command has a parameter, the parameter is in between “(” “)”
If a command is a “set” command “(parameter)”, then there is no reply
If a command is a “request” command “?”,the value will be in the reply

Caution

Send only one command at the time and wait for reply before sending the next one

Ping

Communication	Command	Parameter	Example
Request	!PING`<CR>`
Reply	!PONG`<CR><LF>`

Verbosity

Select verbosity

Communication	Command	Parameter	Example
Request	!VERB(Parameter)`<CR>`
		0: (default) Only send requested datal
		1: Send requested data plus status changes
		2: Send requested data, status and echo commands
			!VERB(2)`<CR>`
Reply

Request active verbosity

Communication	Command	Example
Request	!VERB?`<CR>`
		!VERB?`<CR>`
Reply	!VERB(2)`<CR><LF>`

Post processing

Select post processing

Communication	Command	Parameter	Example
Request	!POSTP(Parameter)`<CR>`
		0: None
		1: PROLOGIC
		2: PROLOGIC II MUSIC
		3: PROLOGIC II MOVIE
		4: DTS NEO6 MUSIC
		4: DTS NEO6 CINEMA
			!POSTP(2)`<CR>`
Reply

Request active post processing number

Communication	Command	Example
Request	!POSTP?`<CR>`
		!POSTP?`<CR>`
Reply	!POSTP(3)`<CR><LF>`

Request active post processing name

Communication	Command	Example
Request	!POSTPNAME?`<CR>`
		!POSTPNAME?`<CR>`
Reply	!POSTPNAME(Music)`<CR><LF>`

Audio format

Request active audio format

Communication	Command	Example
Request	!AUDIOSTATUS?`<CR>`
		!AUDIOSTATUS?`<CR>`
Reply	!AUDIOSTATUS(TRUEHD)`<CR><LF>`

HDMI audio output

Enable HDMI audio output

Communication	Command	Example
Request	!HDMIAUDON<`<CR>`
		!HDMIAUDON<`<CR>`
Reply

Disable HDMI audio output

Communication	Command	Example
Request	!HDMIAUDOFF<`<CR>`
		!HDMIAUDOFF<`<CR>`
Reply

Request HDMI audio output

Communication	Command	Example
Request	!HDMIAUD?`<CR>`
		!HDMIAUD`<CR>`
Reply	!HDMIAUDOFF()`<CR><LF>`

Source

Select source

Communication	Command	Parameter	Example
Request	!SRC(Parameter)`<CR>`
		0: Optical
		1: HDMI 1
		2: HDMI 2
		3: HDMI 3
		4: HDMI 4
		5: AES67*
			!SRC(3)`<CR>`
Reply

*Hardware revision B (MCP4kR2B) only

Request active source number

Communication	Command	Example
Request	!SRC?`<CR>`
		!SRC?`<CR>`
Reply	!SRC(3)`<CR><LF>`

Request active source name

Communication	Command	Example
Request	!SRCNAME?<`<CR>`
		!SRCNAME?<`<CR>`
Reply	!HDMI 3`<CR><LF>`

Select next source

Communication	Command	Example
Request	!SRCUP?<`<CR>`
		!SRCUP?<`<CR>`
Reply

Select previous source

Communication	Command	Example
Request	!SRCDN?<`<CR>`
		!SRCDN?<`<CR>`
Reply

Select video source for audio only input (optical or AES67)*

Communication	Command	Parameter	Example
Request	!OPTVID(Parameter)`<CR>`
		0: No Input
		1: HDMI 1
		2: HDMI 2
		3: HDMI 3
		4: HDMI 4
			!OPTVID(3)`<CR>`
Reply

*Hardware revision B (MCP4kR2B) only

Request active video source for audio only input (optical or AES67)*

Communication	Command	Example
Request	!OPTVID?`<CR>`
		!OPTVID?`<CR>`
Reply	!SRC(3)`<CR><LF>`

*Hardware revision B (MCP4kR2B) only

Speaker setup

Select speaker setup

Communication	Command	Parameter	Example
Request	!SPKSETUP(Parameter)`<CR>`
		2.0: 2ch, full range
		2.1: 2ch, full range, LFE
		5.1: 5ch, full range, LFE
		7.1: 5ch, full range, LFE
			!SPKSETUP(5.1)<`<CR>`
Reply

Request active speaker setup

Communication	Command	Example
Request	!SPKSETUP?`<CR>`
		!SPKSETUP?`<CR>`
Reply	!SPKSETUP(5.1)`<CR><LF>`

Request video status

Communication	Command	Example
Request	!VIDEOSTATUS?`<CR>`
		!VIDEOSTATUS?`<CR>`
Reply	!VIDEOSTATUS(2160p)`<CR><LF>`