Plugins: Allow view specific config #201
Conversation
Add a method for view specfic configuration keys via json. The goal is to allow additional settings (i.e. 64x64 layouts) without increasing the footprint for others. A new interface called IJsonConfig defines the API to use. Both plugins and views can implement it. The plugins then forward config calls to the views to have view specific settings covered (if needed).
|
The change doen't fullfill its goal to save flash right now 👎 Default config: feature/view_config: Development: |
| @@ -333,6 +318,13 @@ class PluginWithConfig : public Plugin | |||
| bool m_storeConfigReq; /**< Is requested to store the configuration in persistent memory? */ | |||
| bool m_reloadConfigReq; /**< Is requested to reload the configuration from persistent memory? */ | |||
|
|
|||
| /*TODO REMOVE if all plugins have it. Right now only in DateTimePlugin. */ | |||
| bool mergeConfiguration(JsonObject& jsonMerged, const JsonObjectConst& jsonSource) | |||
There was a problem hiding this comment.
What is the idea later with mergeConfiguration() method in this class? Isn't it only used between the plugin main class and its views only?
| @@ -47,6 +47,8 @@ | |||
| #include <WString.h> | |||
| #include <cerrno> | |||
|
|
|||
| #include <YAColor.h> | |||
There was a problem hiding this comment.
library.json dependency update is missing. Now Utilities are depended on YAGfx.
| * updates. It is used to provide and apply configuration settings to and from | ||
| * a REST API. | ||
| */ | ||
| class IJsonConfig |
There was a problem hiding this comment.
Not sure whether the interface class is necessary, see my comment in PluginWithConfig.hpp
mergeConfiguration() is only required between plugin main class and its view. The other two methods are in general required for configuration file handling in PluginWithConfig.
Additional it increases the dependency from plugin library to common library. But could live in plugin library.
|
|
||
| if (false == jsonAnalogClock.isNull()) | ||
| { | ||
| jsonMerged["analogClock"] = jsonAnalogClock; |
There was a problem hiding this comment.
Did you check the REST API if you change a color value?
|
|
||
| bool DateTimeView64x64::setConfiguration(const JsonObjectConst& jsonCfg) | ||
| { | ||
| bool result = true; |
There was a problem hiding this comment.
The result will be true even if "analogClock" would be a string instead an object.
| if (false == jsonAnalogClock.isNull()) | ||
| { | ||
| jsonMerged["analogClock"] = jsonAnalogClock; | ||
| result = true; |
There was a problem hiding this comment.
Be aware, mergeConfiguration() will receive all JSON parameters as String! A conversion might be necessary here.
Add a method for view specfic configuration
keys via json. The goal is to allow additional
settings (i.e. 64x64 layouts) without increasing
the footprint for others.
A new interface called IJsonConfig defines the API to use. Both plugins and views can implement it. The plugins then forward config calls to the views to have view specific settings covered (if needed).