-
Notifications
You must be signed in to change notification settings - Fork 3
RaftFileManagerSysMod
Rob Dobson edited this page May 3, 2026
·
1 revision
Built-in SysMod that mounts a local flash file system (LittleFS or SPIFFS), optionally an SD card, and exposes file-system operations as REST endpoints.
- Mount of
local(LittleFS or SPIFFS) and optionallysd. - File listing, read, delete, upload (HTTP and chunked-RICREST) and full reformat.
- Routing of incoming
FileBlockchunks to ProtocolExchange when uploads come over BLE/serial.
| Key | Default | Meaning |
|---|---|---|
LocalFsDefault |
"littlefs" |
Local FS driver: "littlefs" or "spiffs"
|
LocalFsFormatIfCorrupt |
true |
Auto-format if mount fails |
SDEnabled |
false |
Enable SPI SD card mount |
DefaultSD |
false |
When set, default file ops resolve to the SD card if present |
CacheFileSysInfo |
false |
Cache directory listings between calls |
SDMOSI / SDMISO / SDCLK / SDCS
|
"" |
SD SPI pins (named pin or numeric string) |
In all paths the file system name (local or sd) is the first path segment after the verb; folders use ~ instead of /.
| Endpoint | Method | Purpose |
|---|---|---|
reformatfs/<fs> |
GET | Reformat a file system — destructive |
filelist/<fs>/<folder> |
GET | List directory contents as JSON |
fileread/<fs>/<path> |
GET | Read file contents |
filedelete/<fs>/<path> |
GET | Delete a file |
fileupload |
POST | Upload a file (HTTP multipart or RICREST chunked) |
- File Download Protocol (OKTO) — outbound file streaming
- ProtocolExchange — owns file/stream sessions
- WebServer SysMod — for HTTP access
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": "FileManager", "LocalFsDefault": "littlefs", "LocalFsFormatIfCorrupt": 1, "SDEnabled": 0, "DefaultSD": 0, "CacheFileSysInfo": 0, "SDMOSI": "", "SDMISO": "", "SDCLK": "", "SDCS": "" }