Protocol v0.0.1
Success
2.0.2
The remote control protocol is based on sending and receiving commands as ASCII strings. The aim is to keep the commands as human-readable as possible.
Requirements
The remote control protocol is available with MultiTaction firmware version 2.0.2, the MT557D's initial public release. The remote control server is disabled by default. The feature must be enabled from the MultiTaction OSD on the display.
Unauthenticated, unencrypted control channel
The remote control server listens on TCP port 6000 by default. The connection is plaintext and unauthenticated — anyone who can reach that port on the network can send commands, including standing the display down (STANDBY 1). Restrict access at the network level (firewall the port to trusted control systems only, or keep the display on an isolated control VLAN); do not expose it on a general-purpose or customer network.
Strings
Strings should consist of only ASCII characters. The maximum length for send and return strings should be less than 256 characters. Strings are terminated with CR, LF.
Command structure
There are four types of strings used in the command protocol:
- Command strings (client → MultiTaction Cell)
- ACK string (MultiTaction Cell → client)
- Query response strings (MultiTaction Cell → client)
- Error strings (MultiTaction Cell → client)
Command strings
<Command name> [param 0][param 1...]<Line feed>
Command name and parameters are separated by ASCII space character. Example: STANDBY 1\r\n is STANDBY command with one parameter 1. Query commands are prefixed with ?, for example, ?STANDBY\r\n would query the standby status. All integer parameters are encoded as ASCII decimal character arrays.
ACK String
OK<Line feed>
Server will send ACK response when it has parsed a command from the client and there has been no errors when processing the command.
Error strings
Error <Human readable description><Line feed>
In case of internal error or invalid / unknown command server will send error string to client.
Command reference
?VERSION
Description
: Query version information
Parameters
: Optional version component. One of
PROTOCOL
: Remote control protocol version currently used
FIRMWARE
: Firmware version installed on the device
If no parameters are given, PROTOCOL is assumed
Result
: VERSION \$component=\$version
Examples
:
Query protocol version
: Command:
?VERSION
Response:
OK
VERSION PROTOCOL=0.0.1
Query firmware version
: Command:
?VERSION FIRMWARE
Response:
OK
VERSION FIRMWARE=2.0.6
QUIT
Description
: Close the remote control connection
Parameters
: None
Result
: None
STANDBY
Description
: Set standby mode
Parameters
:
0
: Disable standby mode
1
: Enable standby mode
Result
: None
Examples
:
Enable standby mode
: Command:
STANDBY 1
Response:
OK
?STANDBY
Description
: Query standby status
Parameters
: None
Result
:
STANDBY=1
: standby mode active
STANDBY=0
: standby mode not active
Examples
: Command:
?STANDBY
Response:
OK
STANDBY=0
NETWORKED-STANDBY
Description
: Set networked standby mode. Unlike STANDBY, this powers the display down through the hardware management controller rather than the display's own standby path.
Parameters
:
0
: Disable networked standby
1
: Enable networked standby
Result
: None
Examples
:
Enable networked standby
: Command:
NETWORKED-STANDBY 1
Response:
OK
?TEMPERATURE
Description
: Query temperature sensors
Parameters
: Sensor name. One of:
VM
: Sensor in device computer board. Temperature is not updated when standby is active.
Result
: TEMPERATURE \$sensor=\$temperature
The temperature unit used is celsius.
Examples
:
Query VM temperature:
: Command:
?TEMPERATURE VM
Response:
OK
TEMPERATURE VM=42
BRIGHTNESS
Success
2.0.2
Description
: Set brightness level
Parameters
:
0-100
: Brightness level
Result
: None
Examples
:
Set brightness level to 50%
: Command:
BRIGHTNESS 50
Response:
OK
?BRIGHTNESS
Success
2.0.2
Description
: Query brightness level
Parameters
: None
Result
: BRIGHTNESS=\$brightness-level
Examples
: Command:
?BRIGHTNESS
Response:
OK
BRIGHTNESS=50