Skip to content

Protocol v0.0.1

Success

1.1.0

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 1.1.0. The remote control server is disabled by default. The feature must be enabled from the MultiTaction OSD on the display.

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=1.1.2-build16419

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

?TEMPERATURE

Description

: Query temperature sensors

Parameters

: Sensor name. One of:

VM

:   Sensor in device computer board. Note that 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

1.3.7

Description

: Set brightness level

Parameters

: 

0-100

:   Brightness level

Result

: None

Examples

: 

Set brightness level to 50%

:   Command:

        BRIGHTNESS 50

    Response:

        OK

?BRIGHTNESS

Success

1.3.7

Description

: Query brightness level

Parameters

: None

Result

: BRIGHTNESS=\$brightness-level

Examples

: Command:

    ?BRIGHTNESS

Response:

    OK
    BRIGHTNESS=50