Embed system settings vars/GUI

 - Add system-related vars to the embui initialization code
 - Predefined code for "settings' web-page
 - generic example changed to adopt predefined settings UI

Signed-off-by: Emil Muratov <gpm@hotplug.ru>

Author: vortigont

EmbUI/EmbUI.cpp

@@ -27,11 +27,11 @@
  #define GZ_HEADER 0x1F
 #endif
 
-
 #ifdef ESP32
  #define U_FS   U_SPIFFS
 #endif
 
+
 EmbUI embui;
 
 void section_main_frame(Interface *interf, JsonObject *data) {}
@@ -204,8 +204,9 @@ void notFound(AsyncWebServerRequest *request) {
 }
 
 void EmbUI::begin(){
-    load();     // try to load config from file
-    create_parameters();    // use defaults for params missing in config
+    load();                 // try to load config from file
+    create_sysvars();       // create system variables (if missing)
+    create_parameters();    // weak function, creates user-defined variables
 
     LOG(println, String(F("UI CONFIG: ")) + embui.deb());
     #ifdef ESP8266
@@ -422,6 +423,11 @@ void EmbUI::handle(){
     send_pub();
 }
 
+/**
+ * метод для установки коллбеков на системные события, типа:
+ * - WiFi подключиля/отключился
+ * - получено время от NTP
+ */
 void EmbUI::set_callback(CallBack set, CallBack action, callback_function_t callback){
 
     switch (action){
@@ -456,3 +462,24 @@ uint8_t uploadProgress(size_t len, size_t total){
     }
     return progress;
 }
+
+/**
+ * call to create system-dependent variables,
+ * both run-time and persistent
+ */
+void EmbUI::create_sysvars(){
+    LOG(println, F("UI: Creating system vars"));
+    var_create(FPSTR(P_hostname), "");                // device hostname (autogenerated on first-run)
+    var_create(FPSTR(P_APonly),  FPSTR(P_false));     // режим AP-only (только точка доступа), не трогать
+    var_create(FPSTR(P_APpwd), "");                   // пароль внутренней точки доступа
+    // параметры подключения к MQTT
+    var_create(FPSTR(P_m_host), "");                   // MQTT server hostname
+    var_create(FPSTR(P_m_port), "");                   // MQTT port
+    var_create(FPSTR(P_m_user), "");                   // MQTT login
+    var_create(FPSTR(P_m_pass), "");                   // MQTT pass
+    var_create(FPSTR(P_m_pref), embui.mc);             // MQTT topic == use ESP MAC address
+    var_create(FPSTR(P_m_tupd), "");                   // интервал отправки данных по MQTT в секундах
+    // date/time related vars
+    var_create(FPSTR(P_TZSET), "");                   // TimeZone/DST rule (empty value == GMT/no DST)
+    var_create(FPSTR(P_userntp), "");                 // Backup NTP server
+}

EmbUI/EmbUI.h

@@ -255,12 +255,21 @@ class EmbUI
      */
     void wifi_connect(const char *ssid=nullptr, const char *pwd=nullptr);
 
-
+    /**
+     * метод для установки коллбеков на системные события, типа:
+     * - WiFi подключиля/отключился
+     * - получено время от NTP
+     */
     void set_callback(CallBack set, CallBack action, callback_function_t callback=nullptr);
 
 
 
   private:
+    /**
+     * call to create system-dependent variables,
+     * both run-time and persistent
+     */ 
+    void create_sysvars();
     //void led_handle();        // пока убираю
     void led_on();
     void led_off();
@@ -274,7 +283,9 @@ class EmbUI
     void mqtt_handle();
     void subscribeAll(bool isOnlyGetSet=true);
     void mqtt_reconnect();
-    
+
+    // WiFi-related
+    Ticker embuischedw;        // планировщик WiFi
     /**
       * устанавлием режим WiFi
       */
@@ -295,8 +306,6 @@ class EmbUI
 
     void connectToMqtt();
     void onMqttConnect();
-    void setup_mDns();
-    Ticker embuischedw;        // планировщик WiFi
 
     static void onMqttDisconnect(AsyncMqttClientDisconnectReason reason);
     static void onMqttSubscribe(uint16_t packetId, uint8_t qos);
@@ -316,6 +325,8 @@ class EmbUI
     callback_function_t _cb_STADisconnected = nullptr;
     callback_function_t _cb_STAGotIP = nullptr;
 
+    void setup_mDns();
+
 #ifdef USE_SSDP
     void ssdp_begin() {
           String hn = param(FPSTR(P_hostname));

EmbUI/basicui.cpp

@@ -0,0 +1,243 @@
+#include "basicui.h"
+
+/**
+ * Define configuration variables and controls handlers
+ * 
+ * Variables has literal names and are kept within json-configuration file on flash
+ * Control handlers are bound by literal name with a particular method. This method is invoked
+ * by manipulating controls
+ * 
+ * this method owerrides weak definition in framework
+ * 
+ */
+void BasicUI::add_sections(){
+    LOG(println, F("UI: Creating webui vars"));
+
+    // variable for UI language (specific to basicui translations)
+    embui.var_create(FPSTR(P_LANGUAGE), String((uint8_t)lang));
+
+    /**
+     * обработчики действий
+     */ 
+    // вывод BasicUI секций
+    embui.section_handle_add(FPSTR(T_SETTINGS), section_settings_frame);    // generate "settings" UI section
+    embui.section_handle_add(FPSTR(T_SH_NETW), block_settings_netw);        // generate "network settings" UI section
+    embui.section_handle_add(FPSTR(T_SH_TIME), block_settings_time);         // generate "time settings" UI section
+    //embui.section_handle_add(FPSTR(T_SH_OTHER), show_settings_other);
+
+    // обработка базовых настроек
+    embui.section_handle_add(FPSTR(T_SET_WIFI), set_settings_wifi);         // обработка настроек WiFi Client
+    embui.section_handle_add(FPSTR(T_SET_WIFIAP), set_settings_wifiAP);     // обработка настроек WiFi AP
+    embui.section_handle_add(FPSTR(T_SET_MQTT), set_settings_mqtt);         // обработка настроек MQTT
+    embui.section_handle_add(FPSTR(T_SET_TIME), set_settings_time);         // установки даты/времени
+    embui.section_handle_add(FPSTR(P_LANGUAGE), set_language);              // смена языка интерфейса
+
+    //embui.section_handle_add(FPSTR(T_004B), set_settings_other);
+}
+
+/**
+ * This code adds "Settings" section to the MENU
+ * it is up to you to properly open/close Interface menu json_section
+ */
+void BasicUI::opt_setup(Interface *interf, JsonObject *data){
+    if (!interf) return;
+    interf->option(FPSTR(T_SETTINGS), FPSTR(T_DICT[lang][TD::D_SETTINGS]));     // пункт меню "настройки"
+}
+
+/**
+ * формирование секции "настроек",
+ * вызывается либо по выбору из "меню" либо при вызове из
+ * других блоков/обработчиков
+ * 
+ */
+void BasicUI::section_settings_frame(Interface *interf, JsonObject *data){
+    if (!interf) return;
+    interf->json_frame_interface("");       // саму секцию целиком не обрабатываем
+
+    interf->json_section_main(FPSTR(T_SETTINGS), FPSTR(T_DICT[lang][TD::D_SETTINGS]));
+
+    interf->select(FPSTR(P_LANGUAGE), String(lang), String(FPSTR(T_DICT[lang][TD::D_LANG])), true);
+    interf->option("0", "Rus");
+    interf->option("1", "Eng");
+    interf->json_section_end();
+
+    interf->spacer();
+
+    interf->button(FPSTR(T_SH_NETW), FPSTR(T_DICT[lang][TD::D_WIFI_MQTT]));  // кнопка перехода в настройки сети
+    interf->button(FPSTR(T_SH_TIME), FPSTR(T_DICT[lang][TD::D_Time]));       // кнопка перехода в настройки времени
+
+    interf->spacer();
+    block_settings_update(interf, data);                                     // добавляем блок интерфейса "обновления ПО"
+
+    interf->json_section_end();
+    interf->json_frame_flush();
+}
+
+/**
+ *  BasicUI блок интерфейса настроек WiFi/MQTT
+ */
+void BasicUI::block_settings_netw(Interface *interf, JsonObject *data){
+    if (!interf) return;
+    interf->json_frame_interface();
+
+    // Headline
+    interf->json_section_main(FPSTR(T_OPT_NETW), FPSTR(T_DICT[lang][TD::D_WIFI_MQTT]));
+
+    // форма настроек Wi-Fi Client
+    interf->json_section_hidden(FPSTR(T_SET_WIFI), FPSTR(T_DICT[lang][TD::D_WiFiClient]));
+    interf->spacer(FPSTR(T_DICT[lang][TD::D_WiFiClientOpts]));
+    interf->text(FPSTR(P_hostname), FPSTR(T_DICT[lang][TD::D_Hostname]));
+    interf->text(FPSTR(P_WCSSID), WiFi.SSID(), FPSTR(T_DICT[lang][TD::D_WiFiSSID]), false);
+    interf->password(FPSTR(P_WCPASS), "", FPSTR(T_DICT[lang][TD::D_Password]));
+    interf->button_submit(FPSTR(T_SET_WIFI), FPSTR(T_DICT[lang][TD::D_CONNECT]), FPSTR(P_GRAY));
+    interf->json_section_end();
+
+    // форма настроек Wi-Fi AP
+    interf->json_section_hidden(FPSTR(T_SET_WIFIAP), FPSTR(T_DICT[lang][TD::D_WiFiAP]));
+    interf->text(FPSTR(P_hostname), FPSTR(T_DICT[lang][TD::D_Hostname]));
+    interf->spacer(FPSTR(T_DICT[lang][TD::D_WiFiAPOpts]));
+    interf->comment(FPSTR(T_DICT[lang][TD::D_MSG_APOnly]));
+    interf->checkbox(FPSTR(P_APonly), FPSTR(T_DICT[lang][TD::D_APOnlyMode]));
+    interf->password(FPSTR(P_APpwd),  FPSTR(T_DICT[lang][TD::D_MSG_APProtect]));
+    interf->button_submit(FPSTR(T_SET_WIFIAP), FPSTR(T_DICT[lang][TD::D_SAVE]), FPSTR(P_GRAY));
+    interf->json_section_end();
+
+    // форма настроек MQTT
+    interf->json_section_hidden(FPSTR(T_SET_MQTT), FPSTR(T_DICT[lang][TD::D_MQTT]));
+    interf->text(FPSTR(P_m_host), FPSTR(T_DICT[lang][TD::D_MQTT_Host]));
+    interf->number(FPSTR(P_m_port), FPSTR(T_DICT[lang][TD::D_MQTT_Port]));
+    interf->text(FPSTR(P_m_user), FPSTR(T_DICT[lang][TD::D_User]));
+    interf->text(FPSTR(P_m_pass), FPSTR(T_DICT[lang][TD::D_Password]));
+    interf->text(FPSTR(P_m_pref), FPSTR(T_DICT[lang][TD::D_MQTT_Topic]));
+    interf->number(FPSTR(P_m_tupd), FPSTR(T_DICT[lang][TD::D_MQTT_Interval]));
+    interf->button_submit(FPSTR(T_SET_MQTT), FPSTR(T_DICT[lang][TD::D_CONNECT]), FPSTR(P_GRAY));
+    interf->json_section_end();
+
+    interf->spacer();
+    interf->button(FPSTR(T_SETTINGS), FPSTR(T_DICT[lang][TD::D_EXIT]));
+
+    interf->json_section_end();
+
+    interf->json_frame_flush();
+}
+
+/**
+ *  BasicUI блок загрузки обновлений ПО
+ */
+void BasicUI::block_settings_update(Interface *interf, JsonObject *data){
+    if (!interf) return;
+    interf->json_section_hidden(FPSTR(T_DO_OTAUPD), FPSTR(T_DICT[lang][TD::D_Update]));
+    interf->spacer(FPSTR(T_DICT[lang][TD::D_FWLOAD]));
+    interf->file(FPSTR(T_DO_OTAUPD), FPSTR(T_DO_OTAUPD), FPSTR(T_DICT[lang][TD::D_UPLOAD]));
+}
+
+/**
+ *  BasicUI блок настройки даты/времени
+ */
+void BasicUI::block_settings_time(Interface *interf, JsonObject *data){
+    if (!interf) return;
+    interf->json_frame_interface();
+
+    // Headline
+    interf->json_section_main(FPSTR(T_SET_TIME), FPSTR(T_DICT[lang][TD::D_DATETIME]));
+
+    interf->comment(FPSTR(T_DICT[lang][TD::D_MSG_TZSet01]));     // комментарий-описание секции
+    interf->text(FPSTR(P_TZSET), FPSTR(T_DICT[lang][TD::D_MSG_TZONE]));
+    interf->text(FPSTR(P_userntp), FPSTR(T_DICT[lang][TD::D_NTP_Secondary]));
+    interf->text(FPSTR(P_DTIME), "", FPSTR(T_DICT[lang][TD::D_MSG_DATETIME]), false);
+    interf->button_submit(FPSTR(T_SET_TIME), FPSTR(T_DICT[lang][TD::D_SAVE]), FPSTR(P_GRAY));
+
+    interf->spacer();
+    interf->button(FPSTR(T_SETTINGS), FPSTR(T_DICT[lang][TD::D_EXIT]));
+
+    interf->json_section_end();
+    interf->json_frame_flush();
+}
+
+/**
+ * Обработчик настроек WiFi в режиме клиента
+ */
+void BasicUI::set_settings_wifi(Interface *interf, JsonObject *data){
+    if (!data) return;
+
+    SETPARAM(FPSTR(P_hostname));        // сохраняем hostname в конфиг
+
+    const char *ssid = (*data)[FPSTR(P_WCSSID)];    // переменные доступа в конфиге не храним
+    const char *pwd = (*data)[FPSTR(P_WCPASS)];     // фреймворк хранит последнюю доступную точку самостоятельно
+
+    if(ssid){
+        embui.wifi_connect(ssid, pwd);
+    } else {
+        LOG(println, F("UI WiFi: No SSID defined!"));
+    }
+
+    section_settings_frame(interf, data);           // переходим в раздел "настройки"
+}
+
+/**
+ * Обработчик настроек WiFi в режиме AP
+ */
+void BasicUI::set_settings_wifiAP(Interface *interf, JsonObject *data){
+    if (!data) return;
+
+    SETPARAM(FPSTR(P_hostname));    // эти переменные будут сохранены в конфиг-файл
+    SETPARAM(FPSTR(P_APonly));
+    SETPARAM(FPSTR(P_APpwd));
+
+    embui.save();
+    embui.wifi_connect();           // иницируем WiFi-подключение с новыми параметрами
+
+    section_settings_frame(interf, data);   // переходим в раздел "настройки"
+}
+
+/**
+ * Обработчик настроек MQTT
+ */
+void BasicUI::set_settings_mqtt(Interface *interf, JsonObject *data){
+    if (!data) return;
+    // сохраняем настройки в конфиг
+    SETPARAM(FPSTR(P_m_host));
+    SETPARAM(FPSTR(P_m_port));
+    SETPARAM(FPSTR(P_m_user));
+    SETPARAM(FPSTR(P_m_pass));
+    SETPARAM(FPSTR(P_m_pref));
+    SETPARAM(FPSTR(P_m_tupd));
+    //SETPARAM(FPSTR(P_m_tupd), some_mqtt_object.semqtt_int((*data)[FPSTR(P_m_tupd)]));
+
+    embui.save();
+
+    section_settings_frame(interf, data);
+}
+
+/**
+ * Обработчик настроек даты/времени
+ */
+void BasicUI::set_settings_time(Interface *interf, JsonObject *data){
+    if (!data) return;
+
+    String datetime=(*data)[FPSTR(P_DTIME)];
+    if (datetime.length())
+        embui.timeProcessor.setTime(datetime);
+    SETPARAM(FPSTR(P_TZSET), embui.timeProcessor.tzsetup((*data)[FPSTR(P_TZSET)]));
+    SETPARAM(FPSTR(P_userntp), embui.timeProcessor.setcustomntp((*data)[FPSTR(P_userntp)]));
+
+    section_settings_frame(interf, data);
+}
+
+void BasicUI::set_language(Interface *interf, JsonObject *data){
+        if (!data) return;
+
+    //lang = (*data)[FPSTR(P_LANGUAGE)].as<unsigned char>();
+    SETPARAM(FPSTR(P_LANGUAGE), lang = (*data)[FPSTR(P_LANGUAGE)].as<unsigned char>() );
+
+    section_settings_frame(interf, data);
+}
+
+void BasicUI::embuistatus(Interface *interf){
+    if (!interf) return;
+    interf->json_frame_value();
+    interf->value(F("pTime"), embui.timeProcessor.getFormattedShortTime(), true);
+    interf->value(F("pMem"), String(ESP.getFreeHeap()), true);
+    interf->value(F("pUptime"), String(millis()/1000), true);
+    interf->json_frame_flush();
+}