Merge pull request #201 from nhjschulz/feature/view_config

Plugins: Allow view specific config

lib/DateTimePlugin/src/DateTimePlugin.h

@@ -293,9 +293,6 @@ class DateTimePlugin : public PluginWithConfig
     /** Default date format according to strftime(). */
     static const char       DATE_FORMAT_DEFAULT[];
 
-    /** Color key names for the analog clock configuration. */
-    static const char*      ANALOG_CLOCK_COLOR_KEYS[IDateTimeView::ANA_CLK_COL_MAX];
-
     /**
      * If the slot duration is infinite (0s), the default duration of 30s shall be assumed as base
      * for toggling between time and date on the display.
@@ -333,6 +330,20 @@ class DateTimePlugin : public PluginWithConfig
      */
     bool setConfiguration(const JsonObjectConst& jsonCfg) final;
 
+    /**
+     * Merge JSON configuration with local settings to create a complete set.
+     *
+     * The received configuration may not contain all single key/value pair.
+     * Therefore create a complete internal configuration and overwrite it
+     * with the received one.
+     *  
+     * @param[out] jsonMerged  The complete config set with merge content from jsonSource.
+     * @param[in]  jsonSource  The recevied congi set, which may not cover all keys.
+     * @return     true        Keys needed merging.
+     * @return     false       Nothing needed merging.
+     */
+    bool mergeConfiguration(JsonObject& jsonMerged, const JsonObjectConst& jsonSource);
+
     /**
      * Get current date/time and update the text, which to be displayed.
      * The update takes only place, if the date changed.
@@ -355,34 +366,6 @@ class DateTimePlugin : public PluginWithConfig
      */
     bool getTimeAsString(String& time, const String& format, const tm *currentTime = nullptr);
 
-    /**
-     * Convert color to HTML format.
-     * 
-     * @param[in] color Color
-     * 
-     * @return Color in HTML format
-     */
-    static String colorToHtml(const Color& color);
-
-    /**
-     * Convert color from HTML format.
-     * 
-     * @param[in] htmlColor Color in HTML format
-     * 
-     * @return Color
-     */
-    static Color colorFromHtml(const String& htmlColor);
-
-    /**
-     * Check if analog cfg is valid when present.
-     * 
-     * @param jsonCfg[in]  The json configuration, may be isNull(). 
-     * @param cfg[out]     The parsed config data if json present and valid.
-     * @return true        If no configuration or valid json values.
-     */
-    static bool checkAnalogClockConfig(
-        JsonVariantConst& jsonCfg,
-        IDateTimeView::AnalogClockConfig & cfg);
 };
 
 /******************************************************************************

lib/DateTimePlugin/web/DateTimePlugin.html

@@ -318,9 +318,7 @@ <h3>Display</h3>
                         startOfWeek: $("#startOfWeek").val(),
                         dayOnColor: $("#dayOnColor").val(),
                         dayOffColor: $("#dayOffColor").val(),
-                        handHourCol: $("#handHourCol").val(),
                         viewMode: $('input[name=viewMode]:checked').val()
-
                     };
 
                 if ((64 <= ~DISPLAY_HEIGHT~) && (64 <= ~DISPLAY_WIDTH~))

lib/Plugin/src/PluginWithConfig.hpp

@@ -332,7 +332,6 @@ class PluginWithConfig : public Plugin
     SimpleTimer m_cfgReloadTimer;               /**< Timer is used to cyclic reload the configuration from persistent memory. */
     bool        m_storeConfigReq;               /**< Is requested to store the configuration in persistent memory? */
     bool        m_reloadConfigReq;              /**< Is requested to reload the configuration from persistent memory? */
-
 };
 
 /******************************************************************************

lib/Utilities/library.json

@@ -17,6 +17,8 @@
         "owner": "bblanchon",
         "name": "ArduinoJson",
         "version": "~6.21.5"
+    }, {
+        "name": "YAGfx"
     }, {
         "name": "FS"
     }, {

lib/Utilities/src/Util.cpp

@@ -247,6 +247,27 @@ extern uint32_t Util::hexToUInt32(const String& str)
     return value;
 }
 
+String Util::colorToHtml(const Color& color)
+{
+    char buffer[8]; /* '#' + 3x byte in hex + '\0' */
+
+    (void)snprintf(buffer, sizeof(buffer), "#%02X%02X%02X", color.getRed(), color.getGreen(), color.getBlue());
+
+    return String(buffer);
+}
+
+Color Util::colorFromHtml(const String& htmlColor)
+{
+    Color color;
+
+    if ('#' == htmlColor[0])
+    {
+        color = Util::hexToUInt32(htmlColor.substring(1U));
+    }
+
+    return color;
+}
+
 /******************************************************************************
  * Local Functions
  *****************************************************************************/

lib/Utilities/src/Util.h

@@ -47,6 +47,8 @@
 #include <WString.h>
 #include <cerrno>
 
+#include <YAColor.h>
+
 /******************************************************************************
  * Macros
  *****************************************************************************/
@@ -214,6 +216,23 @@ constexpr T max(T valA, T valB)
     return (valA > valB) ? valA : valB;
 }
 
+/**
+ * Convert color to HTML format.
+ * 
+ * @param[in] color Color
+ * 
+ * @return Color in HTML format
+ */
+extern String colorToHtml(const Color& color);
+
+/**
+ * Convert color from HTML format.
+ * 
+ * @param[in] htmlColor Color in HTML format
+ * 
+ * @return Color
+ */
+extern Color colorFromHtml(const String& htmlColor);
 }
 
 #endif  /* UTILITY_H */

lib/Views/src/IDateTimeView.h

@@ -42,6 +42,7 @@
 /******************************************************************************
  * Includes
  *****************************************************************************/
+#include <ArduinoJson.h>
 #include <YAGfx.h>
 #include <Fonts.h>
 #include <WString.h>
@@ -81,38 +82,6 @@ class IDateTimeView
         VIEW_MODE_MAX            /**< Number of configurations */
     };
 
-    /** 
-     * Options for displaying seconds in analog clock.
-     */
-    enum SecondsDisplayMode
-    {
-        SECOND_DISP_OFF = 0U,  /**< No second indicator display. */
-        SECOND_DISP_HAND = 1U, /**< Draw second clock hand. */
-        SECOND_DISP_RING = 2U, /**< Show passed seconds on minute tick ring. */
-        SECOND_DISP_BOTH = 3U, /**< Show hand and on ring. */
-        SECONDS_DISP_MAX       /**< Number of configurations. */
-    };
-
-    /** 
-     * Color array indexes for the analog clock drawing.
-     */
-    enum AnalogClockColor
-    {
-        ANA_CLK_COL_HAND_HOUR = 0U, /**< Hour clock hand color. */
-        ANA_CLK_COL_HAND_MIN,       /**< Minutes clock hand color. */
-        ANA_CLK_COL_HAND_SEC,       /**< Seconds colock hand color */
-        ANA_CLK_COL_RING_MIN5_MARK, /**< Ring five minute marks color. */
-        ANA_CLK_COL_RING_MIN_DOT,   /**< Ring minut dots color. */
-        ANA_CLK_COL_MAX             /**< Number of colors. */
-    };
-
-    /** Analog clock appearance configuration. */
-    struct AnalogClockConfig
-    {
-        SecondsDisplayMode m_secondsMode;              /**< Seconds visualisation mode. */
-        Color              m_colors[ANA_CLK_COL_MAX];  /**< Clock colors to use.        */
-    };
-
     /**
      * Initialize view, which will prepare the widgets and the default values.
      */
@@ -219,27 +188,41 @@ class IDateTimeView
     virtual bool setViewMode(ViewMode mode) = 0;
 
     /**
-     * Get the analog clock clonfiguration.
+     * @brief Update current time values in view.
      * 
-     * @return AnalogClockConfig or nullptr if unsupported.
+     * @param[in] now current time
      */
-    virtual const AnalogClockConfig* getAnalogClockConfig() const = 0;
+    virtual void setCurrentTime(const tm& now) = 0;
 
-    /**
-     * Set the analog clock configuration.
-     * 
-     * @param[in] cfg The new configuration to apply.
+        /**
+     * Get current active configuration in JSON format.
      * 
-     * @return success or failure
+     * @param[out] cfg  Configuration
      */
-    virtual bool setAnalogClockConfig(const AnalogClockConfig& cfg) = 0;
+    virtual void getConfiguration(JsonObject& jsonCfg) const = 0;
 
     /**
-     * @brief Update current time values in view.
+     * Apply configuration from JSON.
      * 
-     * @param[in] now current time
+     * @param[in] cfg   Configuration
+     * 
+     * @return If successful set, it will return true otherwise false.
      */
-    virtual void setCurrentTime(const tm& now) = 0;
+    virtual bool setConfiguration(const JsonObjectConst& jsonCfg) = 0;
+
+     /**
+     * Merge JSON configuration with local settings to create a complete set.
+     *
+     * The received configuration may not contain all single key/value pair.
+     * Therefore create a complete internal configuration and overwrite it
+     * with the received one.
+     *  
+     * @param[out] jsonMerged  The complete config set with merge content from jsonSource.
+     * @param[in]  jsonSource  The recevied congi set, which may not cover all keys.
+     * @return     true        Keys needed merging.
+     * @return     false       Nothing needed merging.
+     */
+    virtual bool mergeConfiguration(JsonObject& jsonMerged, const JsonObjectConst& jsonSource) = 0;
 
 protected:
 

lib/Views/src/layouts/DateTimeView32x8.h

@@ -275,23 +275,47 @@ class DateTimeView32x8 : public IDateTimeView
     }
 
     /**
-     * Get the analog clock seconds display mode (none, ring, hand or both).
+     * Get current active configuration in JSON format.
      * 
-     * @return SecondsDisplayMode pointer or nullptr if unsupported. 
+     * @param[out] cfg  Configuration
      */
-    const AnalogClockConfig* getAnalogClockConfig() const override
+    void getConfiguration(JsonObject& jsonCfg) const final
     {
-        return nullptr; /* 32X8 layout can only do digital.*/
+        (void)jsonCfg;  /* No configuration for 32x8 */
     }
 
     /**
-     * Set the analog clock seconds display mode (none, ring, hand or both).
+     * Apply configuration from JSON.
      * 
-     * @return success of failure
+     * @param[in] cfg   Configuration
+     * 
+     * @return If successful set, it will return true otherwise false.
+     */
+    bool setConfiguration(const JsonObjectConst& jsonCfg) final
+    {
+        (void)jsonCfg;
+
+        return true;
+    }
+
+    /**
+     * Merge JSON configuration with local settings to create a complete set.
+     *
+     * The received configuration may not contain all single key/value pair.
+     * Therefore create a complete internal configuration and overwrite it
+     * with the received one.
+     *  
+     * @param[out] jsonMerged  The complete config set with merge content from jsonSource.
+     * @param[in]  jsonSource  The recevied congi set, which may not cover all keys.
+     * @return     true        Keys needed merging.
+     * @return     false       Nothing needed merging.
      */
-    bool setAnalogClockConfig(const AnalogClockConfig& cfg) override
+    bool mergeConfiguration(JsonObject& jsonMerged, const JsonObjectConst& jsonSource) final
     {
-        return true;  /* No analog clock in 32x8 layout, ignore request. */
+        (void)jsonMerged;
+        (void)jsonSource;
+
+        return false; /* Nothing to merge. */
     }
 
     /**