TCP Server

The TCP Server remote opens a TCP port that other software can connect to and send remote control commands, e.g. from a telnet client, a script, or a home automation system.

Configuration

In the configuration app or Control Panel, go to Remote Control and add an interface of type TCP Server (Network category).

  • Bind IP: The local IP address(es) to listen on, separated by commas. Leave empty to listen on all network interfaces.
  • Port: The TCP port to listen on. The default is 9302.
  • Password: If set, clients must authenticate before they can send commands (see below).
  • Command prefix: If set, only lines starting with this prefix (followed by a space) are executed, and the prefix is removed before execution. All other lines are ignored.

Usage

Send one command per line, terminated by CR/LF, e.g.:

PLAYER 1-1 START

If a password is set, the first line must be AUTH <password>. mAirList replies with AUTH OK if the password is correct, or AUTH REQUIRED otherwise. Until the client is authenticated, all other lines are rejected with AUTH REQUIRED.

Multiple clients can be connected at the same time. Connections and disconnections are recorded in the System Log.

A script can send data to all connected clients using the SendString and WriteLine methods of the interface, available through TCPServerRemote(<index>).