-
Notifications
You must be signed in to change notification settings - Fork 3
RaftCommandFileSysMod
Rob Dobson edited this page May 3, 2026
·
1 revision
Built-in SysMod that runs scripted REST API calls from a text file on the local file system. Useful for one-shot automation, demos, or first-boot setup sequences.
- Reads a text file (max 5 KB), executes each non-blank line as a REST API call.
- Supports a simple
sleep <ms>directive between commands and an optional repeat count. - Useful for scripted demos and self-tests.
No required configuration — the SysMod is driven entirely by the filerun REST endpoint.
| Endpoint | Method | Purpose |
|---|---|---|
filerun/<fs>/<path> |
GET | Run the named API script file |
The script file is a plain text list of REST API requests, one per line, e.g.
subscription?action=update&topic=devjson&rateHz=10
sleep 500
pubtopics
- FileManager SysMod — provides the file system the script lives on
- Adding REST API Endpoints
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": "CommandFile" }