v1.2.58

- Added support for ST7796 (320x480) display.
- Added experimental *AutodetectDisplay* driver.
- Implemented HTTP Basic Authentication in `NetHelper` (scripting) and the `CameraDisplay` activity.
- Introduced `NetHelper.withCredentials(user, pass)` API for authentication.
- Implemented response callback for API commands issued via terminal.

Author: genemars

README.md

@@ -195,26 +195,18 @@ command using the `/api/` prefix, or enter system commands prefixed by `#` chara
 
 ##### System configuration parameters list 
 
-| Key        | Description                | Default          |
-|------------|----------------------------|------------------|
-| `sys-rb-n` | Factory reset button GPIO# | -1 (-1=not used) |
-| `sys-sl-n` | System status LED GPIO#    | -1 (-1=not used) |
-| `io-typ01` | I/O Ch.1 type              |                  |
-| `io-pin01` | I/O Ch.1 GPIO#             | -1 (-1=not used) |
-| `io-typ02` | I/O Ch.2 type              |                  |
-| `io-pin02` | I/O Ch.2 GPIO#             | -1 (-1=not used) |
-| `io-typ03` | I/O Ch.3 type              |                  |
-| `io-pin03` | I/O Ch.3 GPIO#             | -1 (-1=not used) |
-| `io-typ04` | I/O Ch.4 type              |                  |
-| `io-pin04` | I/O Ch.4 GPIO#             | -1 (-1=not used) |
-| `io-typ05` | I/O Ch.5 type              |                  |
-| `io-pin05` | I/O Ch.5 GPIO#             | -1 (-1=not used) |
-| `io-typ06` | I/O Ch.6 type              |                  |
-| `io-pin06` | I/O Ch.6 GPIO#             | -1 (-1=not used) |
-| `io-typ07` | I/O Ch.7 type              |                  |
-| `io-pin07` | I/O Ch.7 GPIO#             | -1 (-1=not used) |
-| `io-typ08` | I/O Ch.8 type              |                  |
-| `io-pin08` | I/O Ch.8 GPIO#             | -1 (-1=not used) |
+| Key        | Description                                         | Default          |
+|------------|-----------------------------------------------------|------------------|
+| `sys-rb-n` | Factory reset button GPIO#                          | -1 (-1=not used) |
+| `sys-sl-n` | System status LED GPIO#                             | -1 (-1=not used) |
+| `io-typ01` | I/O Ch.1 type                                       |                  |
+| `io-pin01` | I/O Ch.1 GPIO#                                      | -1 (-1=not used) |
+| `io-typ02` | I/O Ch.2 type                                       |                  |
+| `io-pin02` | I/O Ch.2 GPIO#                                      | -1 (-1=not used) |
+| ...        | (channels 3 through 8 follow the same pattern)      | ...              |
+
+
+**IO Channel Type (`io-typ0*`) can be one of the following: 'Switch','Light' or 'Dimmer'.**
 
 *Example **setting** configuration from a terminal connected to the serial port of the device:*
 

examples/smart-sensor-display/README.md

@@ -11,25 +11,25 @@ Smart multi-sensor device with display. HomeGenie Mini UI example application.
 Besides the default system options and the *smart-sensor* options detailed in the `../smart-sensor/README.md` file,
 the `smart-sensor-display` firmware offers the following additional configuration settings:
 
-| Key         | Description                                                | Default  |
-|-------------|------------------------------------------------------------|----------|
-| `disp-typ`  | Display driver ("GC9A01" or "ST7789")                      | "GC9A01" |
-| `disp-sclk` | DISPLAY_SCLK                                               |          |
-| `disp-mosi` | DISPLAY_MOSI                                               |          |
-| `disp-miso` | DISPLAY_MISO                                               |          |
-| `disp-dc`   | DISPLAY_DC                                                 |          |
-| `disp-cs`   | DISPLAY_CS                                                 |          |
-| `disp-rst`  | DISPLAY_RST                                                |          |
-| `disp-bl`   | DISPLAY_BL (backlight)                                     |          |
-| `dstch-prt` | TOUCH_PORT                                                 |          |
-| `dstch-adr` | TOUCH_ADDRESS                                              |          |
-| `dstch-sda` | TOUCH_SDA                                                  |          |
-| `dstch-scl` | TOUCH_SCL                                                  |          |
-| `dstch-rst` | TOUCH_RST                                                  |          |
-| `dstch-int` | TOUCH_INTERRUPT                                            |          |
-| `imus-typ`  | Inertial Measurement Unit type ("QMI8658")                 |          |
-| `imus-sda`  | IMU SDA                                                    |          |
-| `imus-scl`  | IMU SCL                                                    |          |
+| Key         | Description                                              | Default  |
+|-------------|----------------------------------------------------------|----------|
+| `disp-typ`  | Display driver ("GC9A01", "ST7789", "ST7796" or "AUTO")  | "GC9A01" |
+| `disp-sclk` | DISPLAY_SCLK                                             |          |
+| `disp-mosi` | DISPLAY_MOSI                                             |          |
+| `disp-miso` | DISPLAY_MISO                                             |          |
+| `disp-dc`   | DISPLAY_DC                                               |          |
+| `disp-cs`   | DISPLAY_CS                                               |          |
+| `disp-rst`  | DISPLAY_RST                                              |          |
+| `disp-bl`   | DISPLAY_BL (backlight)                                   |          |
+| `dstch-prt` | TOUCH_PORT                                               |          |
+| `dstch-adr` | TOUCH_ADDRESS                                            |          |
+| `dstch-sda` | TOUCH_SDA                                                |          |
+| `dstch-scl` | TOUCH_SCL                                                |          |
+| `dstch-rst` | TOUCH_RST                                                |          |
+| `dstch-int` | TOUCH_INTERRUPT                                          |          |
+| `imus-typ`  | Inertial Measurement Unit type ("QMI8658")               |          |
+| `imus-sda`  | IMU SDA                                                  |          |
+| `imus-scl`  | IMU SCL                                                  |          |
 
 For default GPIO# values used by the display driver see `ui/drivers/RoundDisplay.h` and
 `ui/drivers/StandardDisplay.h` files.

examples/smart-sensor-display/configuration.h

@@ -29,8 +29,10 @@
 #include "defs.h"
 
 #include <ui/Dashboard.h>
-#include <ui/drivers/RoundDisplay.h>
-#include <ui/drivers/StandardDisplay.h>
+#include <ui/drivers/GC9A01.h>
+#include <ui/drivers/ST7789.h>
+#include <ui/drivers/ST7796.h>
+#include <ui/drivers/AutodetectDisplay.h>
 #include <ui/activities/utilities/SystemInfoActivity.h>
 
 #ifdef BOARD_HAS_PSRAM
@@ -64,7 +66,7 @@ namespace DisplayConfig = DisplayApi::Configuration;
 namespace DisplayOption = DisplayApi::Options;
 
 
-Dashboard* dashboard;
+Dashboard* dashboard = nullptr;
 
 
 // UI options update listener
@@ -148,7 +150,7 @@ void addDashboardActivities(String &list) {
             static int systemInfoCount = 0;
             if (elementName == "SystemInfo") {
                 // single instance activity
-                if (systemInfoCount++ == 0) {
+                if (++systemInfoCount == 1) {
                     auto systemInfo = new SystemInfoActivity();
                     dashboard->addActivity(systemInfo);
                 }
@@ -159,7 +161,7 @@ void addDashboardActivities(String &list) {
             static int sensorValuesCount = 0;
             if (elementName == "SensorValues") {
                 // single instance activity
-                if (sensorValuesCount++ == 0) {
+                if (++sensorValuesCount == 1) {
                     auto miniModule = HomeGenie::getInstance()->getDefaultModule();
                     auto sensorValues = new SensorValuesActivity(miniModule);
                     dashboard->addActivity(sensorValues);
@@ -171,7 +173,7 @@ void addDashboardActivities(String &list) {
             static int digitalClockCount = 0;
             if (elementName == "DigitalClock") {
                 // single instance activity
-                if (digitalClockCount++ == 0) {
+                if (++digitalClockCount == 1) {
                     auto digitalClock = new DigitalClockActivity();
                     dashboard->addActivity(digitalClock);
                 }
@@ -181,8 +183,9 @@ void addDashboardActivities(String &list) {
             // user-definable devices. Each button emits events
             // that can be automated using the device Scheduler.
             // It can be configured using HomeGenie Panel app.
+            static int switchControlCount = 0;
             if (elementName == "SwitchControl") {
-                String address = "D1";
+                String address = "D" + String(++switchControlCount);
                 if (elementOptions.length() > 0) {
                     address = elementOptions;
                 }
@@ -196,8 +199,9 @@ void addDashboardActivities(String &list) {
 
 #ifndef DISABLE_LVGL
             // Similar to the SwitchControl but using LVGL
+            static int levelControlCount = 0;
             if (elementName == "LevelControl") {
-                String address = "M1";
+                String address = "M" + String(++levelControlCount);
                 if (elementOptions.length() > 0) {
                     address = elementOptions;
                 }
@@ -209,8 +213,9 @@ void addDashboardActivities(String &list) {
 #endif
             }
             // Color control
+            static int colorControlCount = 0;
             if (elementName == "ColorControl") {
-                String address = "H1";
+                String address = "H" + String(++colorControlCount);
                 if (elementOptions.length() > 0) {
                     address = elementOptions;
                 }
@@ -226,12 +231,12 @@ void addDashboardActivities(String &list) {
             // or local camera directly connected to the ESP32.
             static int cameraDisplayCount = 0;
             if (elementName == "CameraDisplay") {
-                String address = "V1";
+                String address = "V" + String(++cameraDisplayCount);
                 if (elementOptions.length() > 0) {
                     address = elementOptions;
                 }
                 auto cameraDisplay = new CameraDisplayActivity(address.c_str());
-                if (cameraDisplayCount++ == 0) {
+                if (cameraDisplayCount == 1) {
                     // The first instance is reserved for
                     // onboard ESP32 camera module if enabled
                     if (Config::getSetting(Camera_Sensor::SensorType).equals("esp32-cam")) {
@@ -245,15 +250,15 @@ void addDashboardActivities(String &list) {
             static int analogClockCount = 0;
             if (elementName == "AnalogClock") {
                 // single instance activity
-                if (analogClockCount++ == 0) {
+                if (++analogClockCount == 1) {
                     auto analogClock = new AnalogClockActivity();
                     dashboard->addActivity(analogClock);
                 }
             }
             static int gaugeExampleCount = 0;
             if (elementName == "GaugeExample") {
                 // single instance activity
-                if (gaugeExampleCount++ == 0) {
+                if (++gaugeExampleCount == 1) {
                     auto gaugeExample = new GaugeExampleActivity();
                     dashboard->addActivity(gaugeExample);
                 }

examples/smart-sensor-display/smart-sensor-display.cpp

@@ -43,16 +43,27 @@ void setup() {
     miniModule->setProperty(Implements::Scheduling, "true");
     miniModule->setProperty(Implements::Scheduling_ModuleEvents, "true");
 
-    DisplayDriver* displayDriver;
+    DisplayDriver* displayDriver = nullptr;
     auto displayType = Config::getSetting("disp-typ");
     if (displayType.equals("ST7789")) {
-        displayDriver = new UI::Drivers::StandardDisplay();
-    } else {
-        // fallback to "GC9A01"
-        displayDriver = new UI::Drivers::RoundDisplay();
+        // ST7789 320x240 display
+        displayDriver = new UI::Drivers::ST7789();
+    } else if (displayType.equals("ST7796")) {
+        // ST7789 480x320 display
+        displayDriver = new UI::Drivers::ST7796();
+    } else if (displayType.equals("GC9A01")) {
+        // GC9A01 240x240 round display
+        displayDriver = new UI::Drivers::GC9A01();
+    } else if (displayType.equals("AUTO")) {
+        // fallback to autodetect
+        displayDriver = new UI::Drivers::AutodetectDisplay();
     }
 
-    initDashboard(displayDriver, miniModule);
+    if (displayDriver) {
+        initDashboard(displayDriver, miniModule);
+    } else {
+        Serial.println("ERROR: display driver not set, could not initialize Dashboard.");
+    }
 
     if (Config::isDeviceConfigured()) {
 
@@ -94,29 +105,38 @@ void setup() {
         }
 #endif
 
-        auto dashboardConfig = Config::getSetting(
-                "dashboard",
+        if (dashboard) {
+
+            auto dashboardConfig = Config::getSetting(
+                    "dashboard",
 #ifdef BOARD_HAS_PSRAM
-                "SensorValues,CameraDisplay:V1,LevelControl:M1,ColorControl:H1,SwitchControl:D1,DigitalClock,"
-#ifdef LGFX_EXAMPLES
-                "AnalogClock,GaugeExample,"
-#endif
-                "SystemInfo"
+                    "SensorValues,CameraDisplay:V1,LevelControl:M1,ColorControl:H1,SwitchControl:D1,DigitalClock,"
+                    #ifdef LGFX_EXAMPLES
+                    "AnalogClock,GaugeExample,"
+                    #endif
+                    "SystemInfo"
 #else
-                "SensorValues,SystemInfo"
+                    "SensorValues,SystemInfo"
 #endif
-        );
-
-        // ----------------------------------------------------------------
-        // NOTE: Activities can be added if free RAM remains above ~110KB.
-        //       This threshold accounts for scheduler and system task
-        //       memory requirements.
-        // ----------------------------------------------------------------
-
-        // Add activities to UI
-        addDashboardActivities(dashboardConfig);
+            );
+            // very basic consistency check
+            dashboardConfig.trim();
+            if (dashboardConfig.isEmpty()) {
+                // ensure there is at least the SystemInfo activity
+                dashboardConfig = "SystemInfo";
+            }
+
+            // ----------------------------------------------------------------
+            // NOTE: Activities can be added if free RAM remains above ~110KB.
+            //       This threshold accounts for scheduler and system task
+            //       memory requirements.
+            // ----------------------------------------------------------------
+
+            // Add activities to UI
+            addDashboardActivities(dashboardConfig);
+        }
 
-    } else {
+    } else if (dashboard) {
 
         // On devices with default RAM, activating
         // Bluetooth will get most of the available RAM,

platformio.ini

@@ -220,7 +220,7 @@ lib_ignore =
     ESP32_BleSerial
 
 [env:smart-sensor-display]
-build_flags = ${env.build_flags} -I examples -I src -D ENABLE_UI -D ENABLE_SCREEN_SAVER -D DISABLE_BLUETOOTH -D DISABLE_LVGL
+build_flags = ${env.build_flags} -I examples -I src -D ENABLE_UI -D ENABLE_SCREEN_SAVER -D DISABLE_BLUETOOTH -D DISABLE_LVGL -D LGFX_AUTODETECT
               -D DEFAULT_CONFIG='{"sys-rb-n":"0","sys-sl-n":"-1","io-typ01":"Dimmer","io-pin01":"15","io-typ02":"Dimmer","io-pin02":"17","sdht-typ":"22","sdht-pin":"21","motn-typ":"switch","motn-pin":"16"}'
 build_src_filter = +<src> -<src/main.cpp> +<examples/smart-sensor> -<examples/smart-sensor/smart-sensor.cpp> +<examples/smart-sensor-display>
 board_build.partitions = ./src/partitions.csv
@@ -230,7 +230,7 @@ lib_deps = ${env:smart-sensor.lib_deps}
 
 [env:smart-sensor-display-s3]
 board = esp32-s3-devkitc-1
-build_flags = ${env.build_flags} -I examples -I src -D ESP32_S3 -D ENABLE_UI -D ENABLE_SCREEN_SAVER
+build_flags = ${env.build_flags} -I examples -I src -D ESP32_S3 -D ENABLE_UI -D ENABLE_SCREEN_SAVER -D LGFX_AUTODETECT
               -D ESP32S3_DEV -D BOARD_HAS_PSRAM
               -D DEFAULT_CONFIG='{"sys-rb-n":"0","sys-sl-n":"-1", "motn-pms": "sleep", "disp-typ":"GC9A01","imus-typ":"QMI8658-dis","imus-sda":"6","imus-scl":"7","io-typ01":"Dimmer","io-pin01":"15","io-typ02":"Dimmer","io-pin02":"17","sdht-typ":"22","sdht-pin":"21","motn-typ":"switch","motn-pin":"16"}'
 build_src_filter = ${env:smart-sensor-display.build_src_filter}
@@ -249,7 +249,7 @@ lib_deps = ${env:smart-sensor.lib_deps}
 
 [env:smart-sensor-display-s3-opi]
 board = esp32-s3-devkitc-1
-build_flags = ${env.build_flags} -I examples -I src -D ESP32_S3 -D ENABLE_UI -D ENABLE_SCREEN_SAVER -D ESP32_S3_LCD_CAM -D ESP_CAMERA_SUPPORTED
+build_flags = ${env.build_flags} -I examples -I src -D ESP32_S3 -D ENABLE_UI -D ENABLE_SCREEN_SAVER -D ESP32_S3_LCD_CAM -D ESP_CAMERA_SUPPORTED -D LGFX_AUTODETECT
               -D ESP32S3_DEV -D BOARD_HAS_PSRAM -D ARDUINO_USB_MODE=1 -D ARDUINO_USB_CDC_ON_BOOT=1
               -D DEFAULT_CONFIG='{"sys-rb-n":"0","sys-sl-n":"-1","disp-typ":"ST7789","imus-typ":"QMI8658","imus-sda":"48","imus-scl":"47","io-typ01":"Dimmer","io-pin01":"","io-typ02":"Dimmer","io-pin02":"","sdht-typ":"none","sdht-pin":"","motn-typ":"none","motn-pin":""}'
 build_src_filter = ${env:smart-sensor-display.build_src_filter}

src/HomeGenie.cpp

@@ -165,8 +165,7 @@ namespace Service {
             if (cmd.startsWith("#")) {
                 Config::handleConfigCommand(cmd);
             } else if (!cmd.isEmpty()) {
-                // TODO: implement SerialCallback
-                auto callback = DummyResponseCallback();
+                auto callback = TerminalResponseCallback();
                 onNetRequest(this, cmd.c_str(), &callback);
             }
         }

src/Utility.cpp

@@ -225,3 +225,63 @@ void Utility::simpleJsonStringEscape(String& s) {
     }
     s = result;
 }
+
+bool Utility::isNumeric(const char *s) {
+    return strlen(s) > 0 && strspn(s, "0123456789.") == strlen(s);
+}
+
+float Utility::roundDecimals(float value, unsigned int n_decimals) {
+    float multiplier = std::pow(10.0f, static_cast<float>(n_decimals));
+    return std::round(value * multiplier) / multiplier;
+}
+
+Utility::UrlParts Utility::parseURL(const String &url) {
+    UrlParts parts;
+    parts.url = url;
+    int protocolEndPos = url.indexOf("://");
+    if (protocolEndPos != -1) {
+        parts.protocol = url.substring(0, protocolEndPos);
+    }
+    // credentials lookup
+    int atPos = (protocolEndPos != -1) ? url.indexOf('@', protocolEndPos + 3) : url.indexOf('@');
+    if (atPos == -1) {
+        return parts;
+    }
+    String protocolPart = (protocolEndPos != -1) ? url.substring(0, protocolEndPos + 3) : "";
+    String credentials = url.substring(protocolPart.length(), atPos);
+    String hostAndPath = url.substring(atPos + 1);
+    // build clean URL
+    parts.url = protocolPart + hostAndPath;
+    // parse credentials
+    int colonPos = credentials.indexOf(':');
+    if (colonPos != -1) {
+        parts.username = urlDecode(credentials.substring(0, colonPos));
+        parts.password = urlDecode(credentials.substring(colonPos + 1));
+    } else {
+        parts.username = urlDecode(credentials);
+    }
+    return parts;
+}
+
+String Utility::urlDecode(const String &str) {
+    String encodedString = "";
+    char c;
+    char code0;
+    char code1;
+    for (int i = 0; i < str.length(); i++){
+        c=str.charAt(i);
+        if (c == '+') {
+            encodedString += ' ';
+        } else if (c == '%') {
+            i++;
+            code0=str.charAt(i);
+            i++;
+            code1=str.charAt(i);
+            c = (hexToInt(code0) << 4) | hexToInt(code1);
+            encodedString += c;
+        } else {
+            encodedString += c;
+        }
+    }
+    return encodedString;
+}