-
Notifications
You must be signed in to change notification settings - Fork 3
RaftSysManagerSettings
Rob Dobson edited this page Oct 28, 2024
·
3 revisions
| Setting | Description | Type | Default | Example |
|---|---|---|---|---|
SystemName |
The name of the system. If not specified, a default name is used. | string |
"Unknown" or project-defined |
N/A |
SystemVersion |
The version of the system. Used to track software versions. | string | "0.0.0" |
N/A |
Manufacturer |
The manufacturer string - currently only reported via BLE System Information | string | ||
SysManager |
See SysManager Settings below | JSON object |
| Setting | Description | Type | Default | Example |
|---|---|---|---|---|
DefaultName |
A friendly name for the system if no other name has been set. | string | Same as SystemName
|
"HomeSystem" |
loopAllSysMods |
Determines if all system modules should be looped over. | boolean | true |
N/A |
loopSleepMs |
The sleep time in milliseconds between loops over system modules. | integer | 100 |
200 |
supervisorEnable |
Enables the supervisor to monitor system modules for performance issues. | boolean | true |
N/A |
slowSysModMs |
Threshold in milliseconds for a module's loop to be considered "slow". | integer | 1000 |
500 |
reportSlowSysMod |
If enabled, reports modules that exceed the slowSysModMs threshold. |
boolean | true |
N/A |
monitorPeriodMs |
The interval in milliseconds at which system monitoring occurs. | integer | 10000 |
5000 |
reportEnable |
Enables reporting of system status and statistics. | boolean | true |
N/A |
reportList |
A list of system modules to include in monitoring reports. | array of strings |
[] (empty list) |
["Module1", "Module2"] |
rebootAfterNHours |
Automatically reboots the system after a specified number of hours. | integer |
0 (disabled) |
24 |
rebootIfDiscMins |
Reboots the system if it has been disconnected from the network for a specified number of minutes. | integer |
0 (disabled) |
60 |
pauseWiFiforBLE |
Pauses WiFi when Bluetooth (BLE) is connected. | boolean | false |
true |
serialNo |
The system's serial number, stored in NVS. | string |
"" (empty string) |
"1234-5678" |
altHwPrefix |
An alternate prefix for hardware revision reporting. | string |
"" (empty string) |
"RevA" |
| Setting | Description | Type | Default | Example |
|---|---|---|---|---|
friendlyName |
The system's friendly name, stored in NVS (Non-Volatile Storage). | string |
"" (empty string) |
"HomeSystem" |
nameSet |
A flag indicating if the friendly name has been manually set by the user (in non-volatile storage). | boolean | false |
true |