Merge branch 'development'

README.md

@@ -46,7 +46,7 @@ This project is still under development and adds following features:
 
 [Full documentation of OpenDTU-onBattery extensions can be found at the project's wiki](https://github.com/helgeerbe/OpenDTU-OnBattery/wiki).
 
-For documentation of openDTU core functionality I refer to the original [repo](https://github.com/tbnobody/OpenDTU) and its [wiki](https://github.com/tbnobody/OpenDTU/wiki).
+For documentation of openDTU core functionality I refer to the original [repo](https://github.com/tbnobody/OpenDTU) and its [documentation](https://tbnobody.github.io/OpenDTU-docs/).
 
 Please note that openDTU-onBattery may change significantly during its development.
 Bug reports, comments, feature requests and fixes are most welcome!

docs/Display.md

@@ -1,20 +1,3 @@
 # Display integration
 
-OpenDTU currently supports 3 types of displays (SSD1306, SH1106 and PCD8544). Currently only displays with a resolution of 128x64 pixel are supported. To activate a display you have to specify it's type and pin assignment either in the `platformio_override.ini` or in a device profile. Due to the fact that device profiles work with the pre-compiled binary the following documentation will only cover the device profile method.
-
-You can either create your own device profile as described [here](DeviceProfiles.md) or use some pre-defined. The pre-defined profiles can be found [here](DeviceProfiles/). You can simply open the json file with a text editor of your choice to view/edit the pin assignment.
-
-## Uploading Device Profiles
-
-Use the "Config Management" site to upload (Restore) the json file. Make sure to choose "Pin Mapping (pin_mapping.json)" in the combo box. After you click on restore the ESP will restart. At this point, the profile is not yet active. Please read the next chapter.
-![Config Management](screenshots/14_ConfigManagement.png)
-
-## Selecting a Device Profile
-
-After you uploaded the device profile you can select the profile in the "Device Manager" view. After a click on "Save" the ESP will be restarted and the pin assignment is active. At this point the display should already show something. Please see the next chapter for display settings.
-![Device Manager](screenshots/20_DeviceManager_Pin.png)
-
-## Display Settings
-
-Display settings can also be found in the "Device Manager".
-![Device Manager Display](screenshots/21_DeviceManager_Display.png)
+This documentation will has been moved and can be found here: <https://tbnobody.github.io/OpenDTU-docs/hardware/display/>

docs/UpgradePartition.md

@@ -1,21 +1,3 @@
 # Upgrade Partition
 
-To be able to install further updates you have to update the partition table of the ESP32. Doing so will **erase** all configuration data. Over The Air update using the web interface is **NOT** possible!
-
-**So make sure you export a backup of your configuration files before continuing.**
-
-There are several possibilities to update the partition table:
-
-- Using Visual Studio Code or PlatformIO CLI
-
-   If you have already used Visual Studio Code or the `platformio` command you can use it again to install the latest version. The partition table is upgraded automatically.
-
-- Any kind of flash interface
-
-   If you like to use any kind of flash interface like `esptool.py`, Espressif Flash Download Tool, ESP_Flasher or esptool-js you have to make sure to upload the provided .factory.bin file. It is important to enter the correct target address.
-
-   | Address  | File                   |
-   | ---------| ---------------------- |
-   | 0x0      | opendtu-*.factory.bin  |
-
-After upgrading the ESP32 will open the intergrated access point (AP) again. Just connect to it using the default password ("openDTU42"). If you are connected, just visit <http://192.168.4.1> and enter the "Configuration Management". Recover the previously backuped config files.
+This documentation will has been moved and can be found here: <https://tbnobody.github.io/OpenDTU-docs/firmware/howto/upgrade_partition/>

include/Battery.h

@@ -29,7 +29,6 @@ class BatteryClass {
 
         Task _loopTask;
 
-        uint32_t _lastMqttPublish = 0;
         mutable std::mutex _mutex;
         std::unique_ptr<BatteryProvider> _upProvider = nullptr;
 };

include/BatteryStats.h

@@ -23,15 +23,24 @@ class BatteryStats {
         // convert stats to JSON for web application live view
         virtual void getLiveViewData(JsonVariant& root) const;
 
-        virtual void mqttPublish() const;
+        void mqttLoop();
+
+        // the interval at which all battery datums will be re-published, even
+        // if they did not change. used to calculate Home Assistent expiration.
+        virtual uint32_t getMqttFullPublishIntervalMs() const;
 
         bool isValid() const { return _lastUpdateSoC > 0 && _lastUpdate > 0; }
 
     protected:
+        virtual void mqttPublish() const;
+
         String _manufacturer = "unknown";
         uint8_t _SoC = 0;
         uint32_t _lastUpdateSoC = 0;
         uint32_t _lastUpdate = 0;
+
+    private:
+        uint32_t _lastMqttPublish = 0;
 };
 
 class PylontechBatteryStats : public BatteryStats {
@@ -89,6 +98,8 @@ class JkBmsBatteryStats : public BatteryStats {
 
         void mqttPublish() const final;
 
+        uint32_t getMqttFullPublishIntervalMs() const final { return 60 * 1000; }
+
         void updateFrom(JkBms::DataPointContainer const& dp);
 
     private:

include/Display_Graphic.h

@@ -20,6 +20,7 @@ enum DisplayType_t {
     SSD1306,
     SH1106,
     SSD1309,
+    ST7567_GM12864I_59N,
     DisplayType_Max,
 };
 

include/MqttHandlePylontechHass.h → include/MqttHandleBatteryHass.h

@@ -4,11 +4,10 @@
 #include <ArduinoJson.h>
 #include <TaskSchedulerDeclarations.h>
 
-class MqttHandlePylontechHassClass {
+class MqttHandleBatteryHassClass {
 public:
     void init(Scheduler& scheduler);
-    void publishConfig();
-    void forceUpdate();
+    void forceUpdate() { _doPublish = true; }
 
 private:
     void loop();
@@ -19,9 +18,8 @@ class MqttHandlePylontechHassClass {
 
     Task _loopTask;
 
-    bool _wasConnected = false;
-    bool _updateForced = false;
+    bool _doPublish = true;
     String serial = "0001"; // pseudo-serial, can be replaced in future with real serialnumber
 };
 
-extern MqttHandlePylontechHassClass MqttHandlePylontechHass;
+extern MqttHandleBatteryHassClass MqttHandleBatteryHass;

lib/VeDirectFrameHandler/VeDirectFrameHandler.cpp

@@ -301,16 +301,30 @@ uint32_t VeDirectFrameHandler::getLastUpdate() const
  */
 frozen::string const& VeDirectFrameHandler::veStruct::getPidAsString() const
 {
-	static constexpr frozen::map<uint16_t, frozen::string, 77> values = {
+	/**
+	 * this map is rendered from [1], which is more recent than [2]. Phoenix
+	 * inverters are not included in the map. unfortunately, the documents do
+	 * not fully align. PID 0xA07F is only present in [1]. PIDs 0xA048, 0xA110,
+	 * and 0xA111 are only present in [2]. PIDs 0xA06D and 0xA078 are rev3 in
+	 * [1] but rev2 in [2].
+	 *
+	 * [1] https://www.victronenergy.com/upload/documents/VE.Direct-Protocol-3.33.pdf
+	 * [2] https://www.victronenergy.com/upload/documents/BlueSolar-HEX-protocol.pdf
+	 */
+	static constexpr frozen::map<uint16_t, frozen::string, 105> values = {
+		{ 0x0203, "BMV-700" },
+		{ 0x0204, "BMV-702" },
+		{ 0x0205, "BMV-700H" },
 		{ 0x0300, "BlueSolar MPPT 70|15" },
 		{ 0xA040, "BlueSolar MPPT 75|50" },
 		{ 0xA041, "BlueSolar MPPT 150|35" },
 		{ 0xA042, "BlueSolar MPPT 75|15" },
 		{ 0xA043, "BlueSolar MPPT 100|15" },
 		{ 0xA044, "BlueSolar MPPT 100|30" },
 		{ 0xA045, "BlueSolar MPPT 100|50" },
-		{ 0xA046, "BlueSolar MPPT 100|70" },
+		{ 0xA046, "BlueSolar MPPT 150|70" },
 		{ 0xA047, "BlueSolar MPPT 150|100" },
+		{ 0xA048, "BlueSolar MPPT 75|50 rev2" },
 		{ 0xA049, "BlueSolar MPPT 100|50 rev2" },
 		{ 0xA04A, "BlueSolar MPPT 100|30 rev2" },
 		{ 0xA04B, "BlueSolar MPPT 150|35 rev2" },
@@ -327,7 +341,7 @@ frozen::string const& VeDirectFrameHandler::veStruct::getPidAsString() const
 		{ 0xA056, "SmartSolar MPPT 100|30" },
 		{ 0xA057, "SmartSolar MPPT 100|50" },
 		{ 0xA058, "SmartSolar MPPT 150|35" },
-		{ 0xA059, "SmartSolar MPPT 150|10 rev2" },
+		{ 0xA059, "SmartSolar MPPT 150|100 rev2" },
 		{ 0xA05A, "SmartSolar MPPT 150|85 rev2" },
 		{ 0xA05B, "SmartSolar MPPT 250|70" },
 		{ 0xA05C, "SmartSolar MPPT 250|85" },
@@ -352,33 +366,57 @@ frozen::string const& VeDirectFrameHandler::veStruct::getPidAsString() const
 		{ 0xA06F, "BlueSolar MPPT 150|45 rev2" },
 		{ 0xA070, "BlueSolar MPPT 150|60 rev2" },
 		{ 0xA071, "BlueSolar MPPT 150|70 rev2" },
+		{ 0xA072, "BlueSolar MPPT 150|45 rev3" },
+		{ 0xA073, "SmartSolar MPPT 150|45 rev3" },
+		{ 0xA074, "SmartSolar MPPT 75|10 rev2" },
+		{ 0xA075, "SmartSolar MPPT 75|15 rev2" },
+		{ 0xA076, "BlueSolar MPPT 100|30 rev3" },
+		{ 0xA077, "BlueSolar MPPT 100|50 rev3" },
+		{ 0xA078, "BlueSolar MPPT 150|35 rev3" },
+		{ 0xA079, "BlueSolar MPPT 75|10 rev2" },
+		{ 0xA07A, "BlueSolar MPPT 75|15 rev2" },
+		{ 0xA07B, "BlueSolar MPPT 100|15 rev2" },
+		{ 0xA07C, "BlueSolar MPPT 75|10 rev3" },
+		{ 0xA07D, "BlueSolar MPPT 75|15 rev3" },
+		{ 0xA07E, "SmartSolar MPPT 100|30 12V" },
+		{ 0xA07F, "All-In-1 SmartSolar MPPT 75|15 12V" },
 		{ 0xA102, "SmartSolar MPPT VE.Can 150|70" },
 		{ 0xA103, "SmartSolar MPPT VE.Can 150|45" },
 		{ 0xA104, "SmartSolar MPPT VE.Can 150|60" },
 		{ 0xA105, "SmartSolar MPPT VE.Can 150|85" },
 		{ 0xA106, "SmartSolar MPPT VE.Can 150|100" },
 		{ 0xA107, "SmartSolar MPPT VE.Can 250|45" },
 		{ 0xA108, "SmartSolar MPPT VE.Can 250|60" },
-		{ 0xA109, "SmartSolar MPPT VE.Can 250|80" },
+		{ 0xA109, "SmartSolar MPPT VE.Can 250|70" },
 		{ 0xA10A, "SmartSolar MPPT VE.Can 250|85" },
 		{ 0xA10B, "SmartSolar MPPT VE.Can 250|100" },
 		{ 0xA10C, "SmartSolar MPPT VE.Can 150|70 rev2" },
 		{ 0xA10D, "SmartSolar MPPT VE.Can 150|85 rev2" },
 		{ 0xA10E, "SmartSolar MPPT VE.Can 150|100 rev2" },
 		{ 0xA10F, "BlueSolar MPPT VE.Can 150|100" },
 		{ 0xA110, "SmartSolar MPPT RS 450|100" },
+		{ 0xA111, "SmartSolar MPPT RS 450|200" },
 		{ 0xA112, "BlueSolar MPPT VE.Can 250|70" },
 		{ 0xA113, "BlueSolar MPPT VE.Can 250|100" },
 		{ 0xA114, "SmartSolar MPPT VE.Can 250|70 rev2" },
 		{ 0xA115, "SmartSolar MPPT VE.Can 250|100 rev2" },
 		{ 0xA116, "SmartSolar MPPT VE.Can 250|85 rev2" },
+		{ 0xA117, "BlueSolar MPPT VE.Can 150|100 rev2" },
+		{ 0xA340, "Phoenix Smart IP43 Charger 12|50 (1+1)" },
+		{ 0xA341, "Phoenix Smart IP43 Charger 12|50 (3)" },
+		{ 0xA342, "Phoenix Smart IP43 Charger 24|25 (1+1)" },
+		{ 0xA343, "Phoenix Smart IP43 Charger 24|25 (3)" },
+		{ 0xA344, "Phoenix Smart IP43 Charger 12|30 (1+1)" },
+		{ 0xA345, "Phoenix Smart IP43 Charger 12|30 (3)" },
+		{ 0xA346, "Phoenix Smart IP43 Charger 24|16 (1+1)" },
+		{ 0xA347, "Phoenix Smart IP43 Charger 24|16 (3)" },
 		{ 0xA381, "BMV-712 Smart" },
 		{ 0xA382, "BMV-710H Smart" },
 		{ 0xA383, "BMV-712 Smart Rev2" },
 		{ 0xA389, "SmartShunt 500A/50mV" },
 		{ 0xA38A, "SmartShunt 1000A/50mV" },
 		{ 0xA38B, "SmartShunt 2000A/50mV" },
-		{ 0xA3F0, "SmartShunt 2000A/50mV" }
+		{ 0xA3F0, "Smart BuckBoost 12V/12V-50A" },
 	};
 
 	return getAsString(values, PID);

src/Battery.cpp

@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 #include "Battery.h"
 #include "MessageOutput.h"
-#include "MqttSettings.h"
 #include "PylontechCanReceiver.h"
 #include "JkBmsController.h"
 #include "VictronSmartShunt.h"
@@ -76,14 +75,5 @@ void BatteryClass::loop()
 
     _upProvider->loop();
 
-    CONFIG_T& config = Configuration.get();
-
-    if (!MqttSettings.getConnected()
-            || (millis() - _lastMqttPublish) < (config.Mqtt.PublishInterval * 1000)) {
-        return;
-    }
-
-    _upProvider->getStats()->mqttPublish();
-
-    _lastMqttPublish = millis();
+    _upProvider->getStats()->mqttLoop();
 }

src/BatteryStats.cpp

@@ -5,6 +5,7 @@
 #include "Configuration.h"
 #include "MqttSettings.h"
 #include "JkBmsDataPoints.h"
+#include "MqttSettings.h"
 
 template<typename T>
 static void addLiveViewInSection(JsonVariant& root,
@@ -187,6 +188,31 @@ void JkBmsBatteryStats::getJsonData(JsonVariant& root, bool verbose) const
     }
 }
 
+void BatteryStats::mqttLoop()
+{
+    auto& config = Configuration.get();
+
+    if (!MqttSettings.getConnected()
+            || (millis() - _lastMqttPublish) < (config.Mqtt.PublishInterval * 1000)) {
+        return;
+    }
+
+    mqttPublish();
+
+    _lastMqttPublish = millis();
+}
+
+uint32_t BatteryStats::getMqttFullPublishIntervalMs() const
+{
+    auto& config = Configuration.get();
+
+    // this is the default interval, see mqttLoop(). mqttPublish()
+    // implementations in derived classes may choose to publish some values
+    // with a lower frequency and hence implement this method with a different
+    // return value.
+    return config.Mqtt.PublishInterval * 1000;
+}
+
 void BatteryStats::mqttPublish() const
 {
     MqttSettings.publish(F("battery/manufacturer"), _manufacturer);
@@ -236,11 +262,10 @@ void JkBmsBatteryStats::mqttPublish() const
         Label::BatterySoCPercent // already published by base class
     };
 
-    CONFIG_T& config = Configuration.get();
-
-    // publish all topics every minute, unless the retain flag is enabled
-    bool fullPublish = _lastFullMqttPublish + 60 * 1000 < millis();
-    fullPublish &= !config.Mqtt.Retain;
+    // regularly publish all topics regardless of whether or not their value changed
+    bool neverFullyPublished = _lastFullMqttPublish == 0;
+    bool intervalElapsed = _lastFullMqttPublish + getMqttFullPublishIntervalMs() < millis();
+    bool fullPublish = neverFullyPublished || intervalElapsed;
 
     for (auto iter = _dataPoints.cbegin(); iter != _dataPoints.cend(); ++iter) {
         // skip data points that did not change since last published

src/Display_Graphic.cpp

@@ -13,6 +13,7 @@ std::map<DisplayType_t, std::function<U8G2*(uint8_t, uint8_t, uint8_t, uint8_t)>
     { DisplayType_t::SSD1306, [](uint8_t reset, uint8_t clock, uint8_t data, uint8_t cs) { return new U8G2_SSD1306_128X64_NONAME_F_HW_I2C(U8G2_R0, reset, clock, data); } },
     { DisplayType_t::SH1106, [](uint8_t reset, uint8_t clock, uint8_t data, uint8_t cs) { return new U8G2_SH1106_128X64_NONAME_F_HW_I2C(U8G2_R0, reset, clock, data); } },
     { DisplayType_t::SSD1309, [](uint8_t reset, uint8_t clock, uint8_t data, uint8_t cs) { return new U8G2_SSD1309_128X64_NONAME0_F_HW_I2C(U8G2_R0, reset, clock, data); } },
+    { DisplayType_t::ST7567_GM12864I_59N, [](uint8_t reset, uint8_t clock, uint8_t data, uint8_t cs) { return new U8G2_ST7567_ENH_DG128064I_F_HW_I2C(U8G2_R0, reset, clock, data); } },
 };
 
 // Language defintion, respect order in languages[] and translation lists
@@ -50,6 +51,9 @@ void DisplayGraphicClass::init(Scheduler& scheduler, const DisplayType_t type, c
     if (isValidDisplay()) {
         auto constructor = display_types[_display_type];
         _display = constructor(reset, clk, data, cs);
+        if (_display_type == DisplayType_t::ST7567_GM12864I_59N) {
+            _display->setI2CAddress(0x3F << 1);
+        }
         _display->begin();
         setContrast(DISPLAY_CONTRAST);
         setStatus(true);

src/InverterSettings.cpp

@@ -109,6 +109,7 @@ void InverterSettingsClass::init(Scheduler& scheduler)
 void InverterSettingsClass::settingsLoop()
 {
     const CONFIG_T& config = Configuration.get();
+    const bool isDayPeriod = SunPosition.isDayPeriod();
 
     for (uint8_t i = 0; i < INV_MAX_COUNT; i++) {
         auto const& inv_cfg = config.Inverter[i];
@@ -120,8 +121,8 @@ void InverterSettingsClass::settingsLoop()
             continue;
         }
 
-        inv->setEnablePolling(inv_cfg.Poll_Enable && (SunPosition.isDayPeriod() || inv_cfg.Poll_Enable_Night));
-        inv->setEnableCommands(inv_cfg.Command_Enable && (SunPosition.isDayPeriod() || inv_cfg.Command_Enable_Night));
+        inv->setEnablePolling(inv_cfg.Poll_Enable && (isDayPeriod || inv_cfg.Poll_Enable_Night));
+        inv->setEnableCommands(inv_cfg.Command_Enable && (isDayPeriod || inv_cfg.Command_Enable_Night));
     }
 }