Skip to content

RaftCommandSocketSysMod

Rob Dobson edited this page May 3, 2026 · 1 revision

CommandSocket SysMod

Built-in SysMod that listens on a TCP port and exposes each connected client as a Comms Channel. The remote host gets full access to the REST API via the configured protocol codec.

Source: RaftSysMods/components/CommandSocket/

What it provides

  • Plain-TCP listener on a configurable port.
  • Each accepted connection is registered as a comms channel using the configured protocol codec (typically RICSerial for HDLC framing or RICFrame for length-prefixed framing).
  • Useful as a development/integration channel where WebSockets are inconvenient.

SysType configuration

{
    "name": "CommandSocket",
    "enable": 1,
    "socketPort": 24,
    "protocol": "RICSerial"
}
Key Default Meaning
enable false Master switch
socketPort 24 TCP listen port
protocol "RICSerial" Protocol codec for the channel

REST endpoints exposed

None directly — the SysMod only opens channels. The endpoints reachable through those channels are whatever every other SysMod registered with RestAPIEndpointManager.

Related

Clone this wiki locally