Merge branch 'helgeerbe:development' into mqtt-dynamic-power-limiter

.github/workflows/build.yml

@@ -23,14 +23,14 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Cache pip
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 
@@ -60,22 +60,31 @@ jobs:
       - name: Get tags
         run: git fetch --force --tags origin
 
+      - name: Create and switch to a meaningful branch for pull-requests
+        if: github.event_name == 'pull_request'
+        run: |
+          OWNER=${{ github.repository_owner }}
+          NAME=${{ github.event.repository.name }}
+          ID=${{ github.event.pull_request.number }}
+          DATE=$(date +'%Y%m%d%H%M')
+          git switch -c ${OWNER}/${NAME}/pr${ID}-${DATE}
+
       - name: Cache pip
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
 
       - name: Cache PlatformIO
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.platformio
           key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 

.github/workflows/cpplint.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
       - name: Install dependencies

docs/DeviceProfiles/AhoyDTU-ESP32.json

@@ -0,0 +1,76 @@
+[
+    {
+        "name": "AhoyDTU ESP32 Display LED",
+        "links": [
+            {"name": "Information", "url": "https://ahoydtu.de/getting_started/"}
+        ],
+        "nrf24": {
+            "miso": 19,
+            "mosi": 23,
+            "clk": 18,
+            "irq": 16,
+            "en": 4,
+            "cs": 5
+        },
+        "led": {
+            "led0": 25,
+            "led1": 26
+        },
+        "display": {
+            "type": 2,
+            "data": 21,
+            "clk": 22
+        }
+    },
+    {
+        "name": "AhoyDTU ESP32 Display",
+        "links": [
+            {"name": "Information", "url": "https://ahoydtu.de/getting_started/"}
+        ],
+        "nrf24": {
+            "miso": 19,
+            "mosi": 23,
+            "clk": 18,
+            "irq": 16,
+            "en": 4,
+            "cs": 5
+        },
+        "display": {
+            "type": 2,
+            "data": 21,
+            "clk": 22
+        }
+    },
+    {
+        "name": "AhoyDTU ESP32 LED",
+        "links": [
+            {"name": "Information", "url": "https://ahoydtu.de/getting_started/"}
+        ],
+        "nrf24": {
+            "miso": 19,
+            "mosi": 23,
+            "clk": 18,
+            "irq": 16,
+            "en": 4,
+            "cs": 5
+        },
+        "led": {
+            "led0": 25,
+            "led1": 26
+        }
+    },
+    {
+        "name": "AhoyDTU ESP32",
+        "links": [
+            {"name": "Information", "url": "https://ahoydtu.de/getting_started/"}
+        ],
+        "nrf24": {
+            "miso": 19,
+            "mosi": 23,
+            "clk": 18,
+            "irq": 16,
+            "en": 4,
+            "cs": 5
+        }
+    }
+]

docs/DeviceProfiles/liligo_t-eth-lite_poe.json

@@ -0,0 +1,74 @@
+[
+    {
+        "name": "LILYGO T-ETH-Lite-POE CMT",
+        "links": [
+            {"name": "Datasheet", "url": "https://www.lilygo.cc/products/t-eth-lite"}
+        ],
+        "eth": {
+            "enabled": true,
+            "phy_addr": 0,
+            "power": 12,
+            "mdc": 23,
+            "mdio": 18,
+            "type": 2,
+            "clk_mode": 0
+        },
+        "cmt": {
+            "clk": 15,
+            "cs": 32,
+            "fcs": 33,
+            "sdio": 4
+        }
+    },
+    {
+        "name": "LILYGO T-ETH-Lite-POE NRF24",
+        "links": [
+            {"name": "Datasheet", "url": "https://www.lilygo.cc/products/t-eth-lite"}
+        ],
+        "eth": {
+            "enabled": true,
+            "phy_addr": 0,
+            "power": 12,
+            "mdc": 23,
+            "mdio": 18,
+            "type": 2,
+            "clk_mode": 0
+        },
+        "nrf24": {
+            "miso": 34,
+            "mosi": 13,
+            "clk": 14,
+            "irq": 35,
+            "en": 4,
+            "cs": 2
+        }
+    },
+    {
+        "name": "LILYGO T-ETH-Lite-POE NRF24 + Display",
+        "links": [
+            {"name": "Datasheet", "url": "https://www.lilygo.cc/products/t-eth-lite"}
+        ],
+        "eth": {
+            "enabled": true,
+            "phy_addr": 0,
+            "power": 12,
+            "mdc": 23,
+            "mdio": 18,
+            "type": 2,
+            "clk_mode": 0
+        },
+        "nrf24": {
+            "miso": 34,
+            "mosi": 13,
+            "clk": 14,
+            "irq": 35,
+            "en": 4,
+            "cs": 2
+        },
+        "display": {
+            "type": 3,
+            "data": 32,
+            "clk": 33
+        }
+    }
+]

include/BatteryStats.h

@@ -15,11 +15,14 @@ class BatteryStats {
 
         // the last time *any* datum was updated
         uint32_t getAgeSeconds() const { return (millis() - _lastUpdate) / 1000; }
-        bool updateAvailable(uint32_t since) const { return _lastUpdate > since; }
+        bool updateAvailable(uint32_t since) const;
 
-        uint8_t getSoC() const { return _SoC; }
+        uint8_t getSoC() const { return _soc; }
         uint32_t getSoCAgeSeconds() const { return (millis() - _lastUpdateSoC) / 1000; }
 
+        float getVoltage() const { return _voltage; }
+        uint32_t getVoltageAgeSeconds() const { return (millis() - _lastUpdateVoltage) / 1000; }
+
         // convert stats to JSON for web application live view
         virtual void getLiveViewData(JsonVariant& root) const;
 
@@ -29,18 +32,33 @@ class BatteryStats {
         // if they did not change. used to calculate Home Assistent expiration.
         virtual uint32_t getMqttFullPublishIntervalMs() const;
 
-        bool isValid() const { return _lastUpdateSoC > 0 && _lastUpdate > 0; }
+        bool isSoCValid() const { return _lastUpdateSoC > 0; }
+        bool isVoltageValid() const { return _lastUpdateVoltage > 0; }
 
     protected:
         virtual void mqttPublish() const;
 
+        void setSoC(float soc, uint8_t precision, uint32_t timestamp) {
+            _soc = soc;
+            _socPrecision = precision;
+            _lastUpdateSoC = timestamp;
+        }
+
+        void setVoltage(float voltage, uint32_t timestamp) {
+            _voltage = voltage;
+            _lastUpdateVoltage = timestamp;
+        }
+
         String _manufacturer = "unknown";
-        uint8_t _SoC = 0;
-        uint32_t _lastUpdateSoC = 0;
         uint32_t _lastUpdate = 0;
 
     private:
         uint32_t _lastMqttPublish = 0;
+        float _soc = 0;
+        uint8_t _socPrecision = 0; // decimal places
+        uint32_t _lastUpdateSoC = 0;
+        float _voltage = 0; // total battery pack voltage
+        uint32_t _lastUpdateVoltage = 0;
 };
 
 class PylontechBatteryStats : public BatteryStats {
@@ -52,14 +70,12 @@ class PylontechBatteryStats : public BatteryStats {
 
     private:
         void setManufacturer(String&& m) { _manufacturer = std::move(m); }
-        void setSoC(uint8_t SoC) { _SoC = SoC; _lastUpdateSoC = millis(); }
         void setLastUpdate(uint32_t ts) { _lastUpdate = ts; }
 
         float _chargeVoltage;
         float _chargeCurrentLimitation;
         float _dischargeCurrentLimitation;
         uint16_t _stateOfHealth;
-        float _voltage; // total voltage of the battery pack
         // total current into (positive) or from (negative)
         // the battery, i.e., the charging current
         float _current;
@@ -123,7 +139,6 @@ class VictronSmartShuntStats : public BatteryStats {
         void updateFrom(VeDirectShuntController::veShuntStruct const& shuntData);
 
     private:
-        float _voltage;
         float _current;
         float _temperature;
         bool _tempPresent;
@@ -141,14 +156,14 @@ class VictronSmartShuntStats : public BatteryStats {
 };
 
 class MqttBatteryStats : public BatteryStats {
+    friend class MqttBattery;
+
     public:
         // since the source of information was MQTT in the first place,
         // we do NOT publish the same data under a different topic.
         void mqttPublish() const final { }
 
-        // the SoC is the only interesting value in this case, which is already
-        // displayed at the top of the live view. do not generate a card.
+        // if the voltage is subscribed to at all, it alone does not warrant a
+        // card in the live view, since the SoC is already displayed at the top
         void getLiveViewData(JsonVariant& root) const final { }
-
-        void setSoC(uint8_t SoC) { _SoC = SoC; _lastUpdateSoC = _lastUpdate = millis(); }
 };

include/Configuration.h

@@ -207,12 +207,14 @@ struct CONFIG_T {
         uint8_t BatteryDrainStategy;
         uint32_t Interval;
         bool IsInverterBehindPowerMeter;
+        bool IsInverterSolarPowered;
         uint8_t InverterId;
         uint8_t InverterChannelId;
         int32_t TargetPowerConsumption;
         int32_t TargetPowerConsumptionHysteresis;
         int32_t LowerPowerLimit;
         int32_t UpperPowerLimit;
+        bool IgnoreSoc;
         uint32_t BatterySocStartThreshold;
         uint32_t BatterySocStopThreshold;
         float VoltageStartThreshold;
@@ -230,7 +232,8 @@ struct CONFIG_T {
         uint8_t Provider;
         uint8_t JkBmsInterface;
         uint8_t JkBmsPollingInterval;
-        char MqttTopic[MQTT_MAX_TOPIC_STRLEN + 1];
+        char MqttSocTopic[MQTT_MAX_TOPIC_STRLEN + 1];
+        char MqttVoltageTopic[MQTT_MAX_TOPIC_STRLEN + 1];
     } Battery;
 
     struct {

include/MqttBattery.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <optional>
 #include "Battery.h"
 #include <espMqttClient.h>
 
@@ -15,8 +16,12 @@ class MqttBattery : public BatteryProvider {
     private:
         bool _verboseLogging = false;
         String _socTopic;
+        String _voltageTopic;
         std::shared_ptr<MqttBatteryStats> _stats = std::make_shared<MqttBatteryStats>();
 
-        void onMqttMessage(espMqttClientTypes::MessageProperties const& properties,
+        std::optional<float> getFloat(std::string const& src, char const* topic);
+        void onMqttMessageSoC(espMqttClientTypes::MessageProperties const& properties,
+                char const* topic, uint8_t const* payload, size_t len, size_t index, size_t total);
+        void onMqttMessageVoltage(espMqttClientTypes::MessageProperties const& properties,
                 char const* topic, uint8_t const* payload, size_t len, size_t index, size_t total);
 };