-
Notifications
You must be signed in to change notification settings - Fork 3
RaftSysModSettings
Each Raft SysMod is configured via a section of the SysType JSON document keyed by the SysMod's registered name. The pages below describe the configuration keys accepted by the standard SysMods supplied in RaftCore and RaftSysMods.
For an overview of how SysMod configuration is loaded, layered, and applied, see Configuration and SysTypes.
| SysMod | Default config key | Settings page |
|---|---|---|
| SysManager | SysManager |
SysManager Settings |
| NetworkManager | NetMan |
Network Manager Settings |
| BLEManager | BLEMan |
BLE Manager Settings |
| StatePublisher | Publish |
State Publisher Settings |
| DeviceManager | DevMan |
Device Manager Settings |
| LogManager (RaftRemote) | LogManager |
See Remote Logging |
Some configuration values live at the top level of the SysType document rather than inside a per-SysMod section (e.g. SystemName, SystemVersion, DefaultName). These are documented in Top Level SysType Configuration.
For the runtime behaviour and REST API surface of each SysMod, see the per-SysMod documentation pages listed in Home.
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