Liminal Control Gateway Interfaces

When the Liminal Control Gateway starts, a Client is initialized which implementing methods for interfacing with the connected device. Similar to the application These methods are invoked through Remote Procedure Calls (RPC) over MQTT allowing clients connected to MQTT to control devices directly through the Web Console, or throguh thier own applications.

Clients interface with connected devices through may protocols with TCP and HTTP/REST being the most common, but most TCP and UDP connection types may be supported such as Serial over TCP, SOAP, OSC, etc.

Each client should implement one, or more base control interfaces. These control protocols help standardize and normalize methods across devices making is easier to develop generic controls across device types. Clients may also implement custom methods when an existing interface does not implemement a needed function, and it does not fit within an existing interface or does not warrant a new interface.

For example, the power interface implements on, off and restart and is used by clients such a the Intel AMT client (SOAP over HTTP), and Shelby Cloud (REST over HTTP).

And the mediaplyer interface implements play, pause, stop, etc and is used by clients such a Madmapper (OSC) and VLC (REST over HTTP).

This document outlines the different content interfaces along with their associated methods in Liminal.

WARNING

Move this ...

Response:

{
    "msg": "io.upswell.xagent.ControlResponse",
    "mid": "123abc",
    "alias": "<device alias>",
    "method": "on",
    "data": {},
    "status_code": 200,
    "received": "2025-08-31T12:39:49.246257"
}