Prepare Release 2025.02.10

Merges branch development into master.

Author: AndreasBoehm

.github/workflows/repo-maintenance.yml

@@ -20,15 +20,29 @@ jobs:
         steps:
           - uses: actions/stale@v9
             with:
-                days-before-stale: 14
-                days-before-close: 60
-                any-of-labels: 'cant-reproduce,not a bug'
-                stale-issue-label: stale
-                stale-pr-label: stale
+                start-date: 2023-04-26
+                operations-per-run: 300
+                remove-stale-when-updated: true
+                days-before-issue-stale: 14
+                days-before-issue-close: 14 # days after the issue is marked as stale
                 stale-issue-message: >
                     This issue has been automatically marked as stale because it has not had
                     recent activity. It will be closed if no further activity occurs. Thank you
                     for your contributions.
+                close-issue-message: >
+                    This issue has been automatically closed because it has not had
+                    recent activity. Please add a comment if you want to get this issue re-opened. Thank you
+                    for your contributions.
+                stale-issue-label: stale # adds a label
+                exempt-issue-labels: 'acknowledged, contribution needed' # exclude issues with label
+                days-before-pr-stale: 14
+                days-before-pr-close: -1 # never close prs
+                stale-pr-label: stale # adds a label
+                any-of-pr-labels: 'changes requested' # only consider prs with this label
+                stale-pr-message: >
+                    This pull-request has been automatically marked as stale because it has not had
+                    recent activity. It will be closed if no further activity occurs. Thank you
+                    for your contributions.
 
     lock-threads:
         name: 'Lock Old Threads'

README.md

@@ -4,6 +4,7 @@
 ![GitHub tag (latest SemVer)](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/AndreasBoehm/856dda48c1cadac6ea495213340c612b/raw/openDTUcoreRelease.json)
 
 - [OpenDTU-OnBattery](#opendtu-onbattery)
+  - [About Hardware For Sale](#%EF%B8%8F--about-hardware-for-sale)
   - [Getting Started](#getting-started)
   - [Important Differences](#important-differences)
   - [Documentation](#documentation)
@@ -16,8 +17,54 @@
 OpenDTU-OnBattery is a fork of [OpenDTU](https://github.com/tbnobody/OpenDTU),
 which adds support for battery chargers, battery management systems (BMS), and
 power meters on a single ESP32. Its Dynamic Power Limiter can adjust the
-inverter's power production to the actual houshold consumption. In this way, it
-is possible to implement a zero export policy.
+power production of one or more solar- and/or battery-powered inverter(s) to
+the actual houshold consumption. In this way, it is possible to implement a
+zero export policy.
+
+## ⚠️  About Hardware For Sale
+
+### Do It Yourself
+
+You are always welcome to select and use your own set of parts to run
+OpenDTU-OnBattery. Our [documentation](https://opendtu-onbattery.net/hardware/)
+should give you the information you need. There are also [case
+designs](https://opendtu-onbattery.net/3rd_party/cases/) available for you to
+print yourself.
+
+### Ready-To-Use
+
+If you are interested in ready-to-use hardware available for sale, the
+OpenDTU-OnBattery project endorses the **[OpenDTU Fusion
+board](https://opendtu-onbattery.net/3rd_party/opendtu_fusion/)**.
+
+### Distribution Channels
+
+OpenDTU Fusion boards and accessories (cases in particular) are available
+exclusively through:
+
+- [AllianceApps](https://shop.allianceapps.io/)
+- [Semy3D](https://shop.semy3d.de/)
+
+Please note that we do not have any connections to hardware sold on platforms
+like eBay, Kleinanzeigen, or similar marketplaces. Items sold there may not
+meet the quality and compatibility standards expected by our community.
+
+### Why Purchase Through the Endorsed Channels?
+
+Buying from the trusted sources listed above ensures:
+
+1. Access to reliable, well-tested hardware that meets the project’s requirements.
+2. Support for suppliers who align with the values of the OpenDTU community.
+
+To allow for a good overall experience, we encourage users to avoid unverified
+hardware sources.
+
+### 🚨 Misleading Claims
+
+We are aware that some sellers falsely advertise that purchasing their hardware
+supports the OpenDTU-OnBattery, OpenDTU, and/or AhoyDTU developers financially.
+**This is not true.** The OpenDTU-OnBattery project does **not** receive any
+financial benefit from the sale of hardware.
 
 ## Getting Started
 

include/Configuration.h

@@ -10,7 +10,7 @@
 
 #define CONFIG_FILENAME "/config.json"
 #define CONFIG_VERSION 0x00011d00 // 0.1.29 // make sure to clean all after change
-#define CONFIG_VERSION_ONBATTERY 4
+#define CONFIG_VERSION_ONBATTERY 5
 
 #define WIFI_MAX_SSID_STRLEN 32
 #define WIFI_MAX_PASSWORD_STRLEN 64
@@ -136,11 +136,13 @@ struct POWERLIMITER_INVERTER_CONFIG_T {
     uint64_t Serial;
     bool IsGoverned;
     bool IsBehindPowerMeter;
-    bool IsSolarPowered;
     bool UseOverscaling;
     uint16_t LowerPowerLimit;
     uint16_t UpperPowerLimit;
     uint8_t ScalingThreshold;
+
+    enum InverterPowerSource { Battery = 0, Solar = 1, SmartBuffer = 2 };
+    InverterPowerSource PowerSource;
 };
 using PowerLimiterInverterConfig = struct POWERLIMITER_INVERTER_CONFIG_T;
 

include/PowerLimiter.h

@@ -52,7 +52,10 @@ class PowerLimiterClass {
     void setMode(Mode m) { _mode = m; }
     Mode getMode() const { return _mode; }
     bool usesBatteryPoweredInverter();
-    bool isGovernedInverterProducing();
+    bool usesSmartBufferPoweredInverter();
+
+    // used to interlock Huawei R48xx grid charger against battery-powered inverters
+    bool isGovernedBatteryPoweredInverterProducing();
 
 private:
     void loop();
@@ -83,7 +86,7 @@ class PowerLimiterClass {
     std::pair<float, char const*> getInverterDcVoltage();
     float getBatteryVoltage(bool log = false);
     uint16_t dcPowerBusToInverterAc(uint16_t dcPower);
-    void fullSolarPassthrough(PowerLimiterClass::Status reason);
+    void unconditionalFullSolarPassthrough();
     int16_t calcConsumption();
     using inverter_filter_t = std::function<bool(PowerLimiterInverter const&)>;
     uint16_t updateInverterLimits(uint16_t powerRequested, inverter_filter_t filter, std::string const& filterExpression);
@@ -102,6 +105,7 @@ class PowerLimiterClass {
     bool isStopThresholdReached();
     bool isBelowStopThreshold();
     void calcNextInverterRestart();
+    bool isSolarPassThroughEnabled();
     bool isFullSolarPassthroughActive();
 };
 

include/PowerLimiterBatteryInverter.h

@@ -12,7 +12,6 @@ class PowerLimiterBatteryInverter : public PowerLimiterInverter {
     uint16_t applyReduction(uint16_t reduction, bool allowStandby) final;
     uint16_t applyIncrease(uint16_t increase) final;
     uint16_t standby() final;
-    bool isSolarPowered() const final { return false; }
 
 private:
     void setAcOutput(uint16_t expectedOutputWatts) final;

include/PowerLimiterInverter.h

@@ -68,7 +68,10 @@ class PowerLimiterInverter {
     uint64_t getSerial() const { return _config.Serial; }
     char const* getSerialStr() const { return _serialStr; }
     bool isBehindPowerMeter() const { return _config.IsBehindPowerMeter; }
-    virtual bool isSolarPowered() const = 0;
+
+    bool isBatteryPowered() const { return _config.PowerSource == PowerLimiterInverterConfig::InverterPowerSource::Battery; }
+    bool isSolarPowered() const { return _config.PowerSource == PowerLimiterInverterConfig::InverterPowerSource::Solar; }
+    bool isSmartBufferPowered() const { return _config.PowerSource == PowerLimiterInverterConfig::InverterPowerSource::SmartBuffer; }
 
     void debug() const;
 

include/PowerLimiterOverscalingInverter.h

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+#pragma once
+
+#include "PowerLimiterInverter.h"
+
+class PowerLimiterOverscalingInverter : public PowerLimiterInverter {
+public:
+    PowerLimiterOverscalingInverter(bool verboseLogging, PowerLimiterInverterConfig const& config);
+
+    uint16_t applyIncrease(uint16_t increase) final;
+
+protected:
+    void setAcOutput(uint16_t expectedOutputWatts) final;
+
+private:
+    uint16_t scaleLimit(uint16_t expectedOutputWatts);
+};

include/PowerLimiterSmartBufferInverter.h

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+#pragma once
+
+#include "PowerLimiterOverscalingInverter.h"
+
+class PowerLimiterSmartBufferInverter : public PowerLimiterOverscalingInverter {
+public:
+    PowerLimiterSmartBufferInverter(bool verboseLogging, PowerLimiterInverterConfig const& config);
+
+    uint16_t getMaxReductionWatts(bool allowStandby) const final;
+    uint16_t getMaxIncreaseWatts() const final;
+    uint16_t applyReduction(uint16_t reduction, bool allowStandby) final;
+    uint16_t standby() final;
+};

include/PowerLimiterSolarInverter.h

@@ -1,20 +1,14 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 #pragma once
 
-#include "PowerLimiterInverter.h"
+#include "PowerLimiterOverscalingInverter.h"
 
-class PowerLimiterSolarInverter : public PowerLimiterInverter {
+class PowerLimiterSolarInverter : public PowerLimiterOverscalingInverter {
 public:
     PowerLimiterSolarInverter(bool verboseLogging, PowerLimiterInverterConfig const& config);
 
     uint16_t getMaxReductionWatts(bool allowStandby) const final;
     uint16_t getMaxIncreaseWatts() const final;
     uint16_t applyReduction(uint16_t reduction, bool allowStandby) final;
-    uint16_t applyIncrease(uint16_t increase) final;
     uint16_t standby() final;
-    bool isSolarPowered() const final { return true; }
-
-private:
-    uint16_t scaleLimit(uint16_t expectedOutputWatts);
-    void setAcOutput(uint16_t expectedOutputWatts) final;
 };

include/WebApi_network.h

@@ -6,10 +6,14 @@
 
 class WebApiNetworkClass {
 public:
+    WebApiNetworkClass();
     void init(AsyncWebServer& server, Scheduler& scheduler);
 
 private:
     void onNetworkStatus(AsyncWebServerRequest* request);
     void onNetworkAdminGet(AsyncWebServerRequest* request);
     void onNetworkAdminPost(AsyncWebServerRequest* request);
+
+    Task _applyDataTask;
+    void applyDataTaskCb();
 };

include/defaults.h

@@ -131,7 +131,6 @@
 #define POWERLIMITER_CONDUCTION_LOSSES 3
 #define POWERLIMITER_BATTERY_ALWAYS_USE_AT_NIGHT false
 #define POWERLIMITER_IS_INVERTER_BEHIND_POWER_METER true
-#define POWERLIMITER_IS_INVERTER_SOLAR_POWERED false
 #define POWERLIMITER_USE_OVERSCALING false
 #define POWERLIMITER_INVERTER_CHANNEL_ID 0
 #define POWERLIMITER_TARGET_POWER_CONSUMPTION 0

include/solarcharger/DummyStats.h

@@ -13,6 +13,9 @@ class DummyStats : public Stats {
     std::optional<uint16_t> getPanelPowerWatts() const final { return std::nullopt; }
     std::optional<float> getYieldTotal() const final { return std::nullopt; }
     std::optional<float> getYieldDay() const final { return std::nullopt; }
+    std::optional<StateOfOperation> getStateOfOperation() const final { return std::nullopt; }
+    std::optional<float> getFloatVoltage() const final { return std::nullopt; }
+    std::optional<float> getAbsorptionVoltage() const final { return std::nullopt; }
     void getLiveViewData(JsonVariant& root, const boolean fullUpdate, const uint32_t lastPublish) const final {}
     void mqttPublish() const final {}
     void mqttPublishSensors(const boolean forcePublish) const final {}

include/solarcharger/Stats.h

@@ -26,6 +26,16 @@ class Stats {
     // sum of today's yield of all MPPT charge controllers in Wh
     virtual std::optional<float> getYieldDay() const;
 
+    // state of operation from the first available controller
+    enum class StateOfOperation : uint8_t { Off = 0, Bulk = 1, Absorption = 2, Float = 3, Various = 255 };
+    virtual std::optional<Stats::StateOfOperation> getStateOfOperation() const;
+
+    // float voltage from the first available charge controller
+    virtual std::optional<float> getFloatVoltage() const;
+
+    // absorption voltage from the first available charge controller
+    virtual std::optional<float> getAbsorptionVoltage() const;
+
     // convert stats to JSON for web application live view
     virtual void getLiveViewData(JsonVariant& root, const boolean fullUpdate, const uint32_t lastPublish) const;
 

include/solarcharger/mqtt/Stats.h

@@ -17,6 +17,9 @@ friend class Provider;
     std::optional<uint16_t> getPanelPowerWatts() const final { return std::nullopt; }
     std::optional<float> getYieldTotal() const final { return std::nullopt; }
     std::optional<float> getYieldDay() const final { return std::nullopt; }
+    std::optional<StateOfOperation> getStateOfOperation() const final { return std::nullopt; }
+    std::optional<float> getFloatVoltage() const final { return std::nullopt; }
+    std::optional<float> getAbsorptionVoltage() const final { return std::nullopt; }
 
     void getLiveViewData(JsonVariant& root, const boolean fullUpdate, const uint32_t lastPublish) const final;
 

include/solarcharger/victron/Stats.h

@@ -16,6 +16,9 @@ class Stats : public ::SolarChargers::Stats {
     std::optional<uint16_t> getPanelPowerWatts() const final;
     std::optional<float> getYieldTotal() const final;
     std::optional<float> getYieldDay() const final;
+    std::optional<StateOfOperation> getStateOfOperation() const final;
+    std::optional<float> getFloatVoltage() const final;
+    std::optional<float> getAbsorptionVoltage() const final;
 
     void getLiveViewData(JsonVariant& root, const boolean fullUpdate, const uint32_t lastPublish) const final;
     void mqttPublish() const final;