ConfigModule Class Reference

Save and Load Config to/from SPIFF of the ESP. More...

#include <ConfigModule.h>

Public Member Functions
	ConfigModule (String _configFilePath)
void	setup ()
bool	saveConfig (const Config &config)
	Serialize Config to JSON and save to SPIFF. More...
const Config	loadConfig ()
	Load config JSON from SPIFF and deserialize it. More...

Private Member Functions
Config	parseJsonConfig (const JsonObject &jsonObject)
	Fill config values from JsonObject to Config struct. More...
void	copyToJsonConfig (JsonObject &json, const Config &config)
	Copy Config values to JsonObject. More...

Private Attributes
const String	configFilePath

Detailed Description

Save and Load Config to/from SPIFF of the ESP.

Definition at line 28 of file ConfigModule.h.

Constructor & Destructor Documentation

ConfigModule()

ConfigModule::ConfigModule

(

String

_configFilePath

)

Definition at line 7 of file ConfigModule.cpp.

Member Function Documentation

copyToJsonConfig()

void ConfigModule::copyToJsonConfig ( JsonObject &  json, const Config &  config  )

private

Copy Config values to JsonObject.

Parameters

json	To be filled JsonObject, by reference
config	Source Config

Definition at line 103 of file ConfigModule.cpp.

loadConfig()

const Config ConfigModule::loadConfig

(

)

Load config JSON from SPIFF and deserialize it.

Returns

On success: Saved Config; On Failure: Empty Config

Definition at line 49 of file ConfigModule.cpp.

parseJsonConfig()

Config ConfigModule::parseJsonConfig ( const JsonObject &  jsonObject )

private

Fill config values from JsonObject to Config struct.

Parameters

jsonObject

Returns

Filled Config Object.

Definition at line 83 of file ConfigModule.cpp.

saveConfig()

bool ConfigModule::saveConfig

(

const Config &

config

)

Serialize Config to JSON and save to SPIFF.

Parameters

config

Returns

true on success

Definition at line 23 of file ConfigModule.cpp.

setup()

void ConfigModule::setup

(

)

Definition at line 9 of file ConfigModule.cpp.

Member Data Documentation

configFilePath

const String ConfigModule::configFilePath

private

Definition at line 30 of file ConfigModule.h.

---

The documentation for this class was generated from the following files:

• /Users/jolau/Documents/Projekte/QlockTwo_DIY/GIT/esp8266/src/ConfigModule.h
• /Users/jolau/Documents/Projekte/QlockTwo_DIY/GIT/esp8266/src/ConfigModule.cpp