TopLevelSysTypeConfig

Top Level SysType Configuration

Configuration Options

Key	Description	Examples	Notes
SystemName	Specify the name to be returned by RaftSysMod::getSystemName(). This is used in many places such as in the JSON response to the "v" (version) REST API, logging (to name the system), BLE advertising (as a default assuming no other name is provided), MQTT (as the basis for the clientID).	"IoT Firmware"	If not specified in the SysType JSON then the build system will default this to the name of the SysType used when building the firmware. It should not be confused with the "friendly name" which is a name given to an instance of the firmware on a device. If not using the RaftCoreApp module as the basis for a Raft app then the constructor of SysManager can override the setting of this value.
SystemVersion	The string returned by RaftSysMod::getSystemVersion(). This is generally a SemVer string (e.g. "1.2.3") and is part of the JSON response in the "v" (version) REST API.	"1.2.3"	If not specified in the SysType JSON, the build system will set this value based on the SYSTEM_VERSION compiler definition which is generally set in the features.cmake file in the folder for the specific SysType at build time.
DefaultName	This is the initial value returned by RaftSysMod::getFriendlyName() when an alternate value is not present in non-volatile storage. It is reported in the JSON response to the "v" (version) REST API and as a default for the advertising name used in BLE.	"My IoT Device"	If not specified in the SysType JSON, this will default to the SystemName (see above). A Raft Core API is provided to handle getting/setting/clearing the friendly name, and any value set is retained in non-volatile storage and reinstated on startup.