-
Notifications
You must be signed in to change notification settings - Fork 3
RaftCommandSocketSysMod
Rob Dobson edited this page May 3, 2026
·
1 revision
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.
- Plain-TCP listener on a configurable port.
- Each accepted connection is registered as a comms channel using the configured protocol codec (typically
RICSerialfor HDLC framing orRICFramefor length-prefixed framing). - Useful as a development/integration channel where WebSockets are inconvenient.
| Key | Default | Meaning |
|---|---|---|
enable |
false |
Master switch |
socketPort |
24 |
TCP listen port |
protocol |
"RICSerial" |
Protocol codec for the channel |
None directly — the SysMod only opens channels. The endpoints reachable through those channels are whatever every other SysMod registered with RestAPIEndpointManager.
- Comms Channels
- WebServer SysMod — preferred path when websockets are usable
Getting Started
- Quick Start
- Architecture at a Glance
- Writing Your First SysMod
- Adding a Comms Channel
- Adding an I2C Device Type
- PlatformIO / Arduino
Scaffolding & Building
- Raft CLI
- SysTypes
- Top-Level SysType
- Build Process
- WebUI Build Pipeline
- File System
- Partitions & Flash
- Local Dev Libraries
- Library Developer Guide
Architecture
Built-in SysMods
- NetworkManager
- BLEManager
- WebServer
- MQTTManager
- SerialConsole
- CommandSerial
- CommandSocket
- CommandFile
- FileManager
- LogManager
- ESPOTAUpdate
- StatePublisher
- Remote Logging
- Data Source Registration
Comms & Protocols
- Stack Overview
- Comms Channels
- ProtocolExchange
- RICREST Protocol
- Real-Time Streams
- Adding REST Endpoints
- Built-in REST Endpoints
- File Download (OKTO)
- OTA Update Flow
Devices & Buses
- DeviceManager
- Device Manager REST API
- Device Factory & Classes
- Device Type Records
- Adding an I2C Device Type
- Device Data Publishing
- Data Logger
- I2C Bus
- I2C Device Scanning
- I2C ID & Polling
- MotorControl Overview
- MotorControl Config
- MotorControl Commands
Helpers
Reference
{ "name": "CommandSocket", "enable": 1, "socketPort": 24, "protocol": "RICSerial" }