Merge remote-tracking branch 'origin/development' into feature/zendur…

…e_solarflow

.github/workflows/cpplint.yml

@@ -19,7 +19,9 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cpplint
+          pip install cpplint==1.6.1
       - name: Linting
         run: |
-          cpplint --repository=. --recursive --filter=-build/c++11,-runtime/references,-readability/braces,-whitespace,-legal,-build/include ./src ./include ./lib/Hoymiles ./lib/MqttSubscribeParser ./lib/TimeoutHelper ./lib/ResetReason ./lib/ETHSPI
+          cpplint --repository=. --recursive \
+            --filter=-build/c++11,-runtime/references,-readability/braces,-whitespace,-legal,-build/include \
+            ./src ./include ./lib/Hoymiles ./lib/MqttSubscribeParser ./lib/TimeoutHelper ./lib/ResetReason

README.md

@@ -3,7 +3,7 @@
   - [Documentation](#documentation)
   - [State of the project](#state-of-the-project)
   - [History of the project](#history-of-the-project)
-  - [Acknowledgment](#acknowledgment)
+  - [Acknowledgments](#acknowledgments)
 
 # OpenDTU-OnBattery
 
@@ -14,9 +14,9 @@ disabled while "create release badge" action is broken, see .github/build.yml
 ![GitHub tag (latest SemVer)](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/helgeerbe/68b47cc8c8994d04ab3a4fa9d8aee5e6/raw/openDTUcoreRelease.json)
 --->
 
-[![OpenDTU-OnBattery Build](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/build.yml/badge.svg)](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/build.yml)
-[![cpplint](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/cpplint.yml/badge.svg)](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/cpplint.yml)
-[![Yarn Linting](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/yarnlint.yml/badge.svg)](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/yarnlint.yml)
+[![OpenDTU-OnBattery Build](https://github.com/hoylabs/OpenDTU-OnBattery/actions/workflows/build.yml/badge.svg)](https://github.com/hoylabs/OpenDTU-OnBattery/actions/workflows/build.yml)
+[![cpplint](https://github.com/hoylabs/OpenDTU-OnBattery/actions/workflows/cpplint.yml/badge.svg)](https://github.com/hoylabs/OpenDTU-OnBattery/actions/workflows/cpplint.yml)
+[![Yarn Linting](https://github.com/hoylabs/OpenDTU-OnBattery/actions/workflows/yarnlint.yml/badge.svg)](https://github.com/hoylabs/OpenDTU-OnBattery/actions/workflows/yarnlint.yml)
 
 ## What is OpenDTU-OnBattery
 
@@ -33,10 +33,10 @@ The canonical documentation of OpenDTU-OnBattery is hosted at
 
 You may find additional helpful information in the project's
 community-maintained [Github
-Wiki](https://github.com/helgeerbe/OpenDTU-OnBattery/wiki).
+Wiki](https://github.com/hoylabs/OpenDTU-OnBattery/wiki).
 
 To find out what's new or improved have a look at the changelog of the
-[releases](https://github.com/helgeerbe/OpenDTU-OnBattery/releases).
+[releases](https://github.com/hoylabs/OpenDTU-OnBattery/releases).
 
 ## State of the project
 
@@ -57,10 +57,15 @@ didn't like the idea to set up a separate ESP32 to receive the charger's data.
 He decided to fork OpenDTU and extend it with battery charger support and a
 Dynamic Power Limiter.
 
-## Acknowledgment
+In early October 2024, the project moved to the newly founded GitHub
+organisation `hoylabs` and is since maintained by multiple community members.
 
-A special Thank to Thomas Basler (tbnobody) the author of the original [OpenDTU](https://github.com/tbnobody/OpenDTU) project. You are doing a great job!
+## Acknowledgments
 
-@helgeerbe: Last but not least, I would like to thank all the contributors.
-With your ideas and enhancements, you have made OpenDTU-OnBattery much more
-than I originally had in mind.
+* Special thanks to Thomas Basler (@tbnobody), the author of the [upstream
+  project](https://github.com/tbnobody/OpenDTU), for hist continued effort!
+* Thanks to @helgeerbe for starting OpenDTU-OnBattery and his dedication to the
+  project, as well as his trust in the current maintainers of the project,
+  which act as part of the `hoylabs` GitHub organisation.
+* We like to thank all contributors. With your ideas and enhancements, you have
+  made OpenDTU-OnBattery much more than @helgeerbe originally had in mind.

docs/DeviceProfiles/opendtu_fusion.json

@@ -1,6 +1,9 @@
 [
     {
         "name": "OpenDTU Fusion v1",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -25,6 +28,9 @@
     },
     {
         "name": "OpenDTU Fusion v1 with SSD1306 Display",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -54,6 +60,9 @@
     },
     {
         "name": "OpenDTU Fusion v1 with SH1106 Display",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -83,6 +92,9 @@
     },
     {
         "name": "OpenDTU Fusion v2 with CMT2300A and NRF24",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -115,6 +127,9 @@
     },
     {
         "name": "OpenDTU Fusion v2 with CMT2300A, NRF24 and SH1106 Display",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -152,6 +167,9 @@
     },
     {
         "name": "OpenDTU Fusion v2 with CMT2300A, NRF24 and SSD1306 Display",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -188,7 +206,10 @@
         }
     },
     {
-        "name": "OpenDTU Fusion v2 with NRF24 and W5500 ethernet",
+        "name": "OpenDTU Fusion v2 PoE",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
             "miso": 48,
             "mosi": 35,
@@ -198,35 +219,43 @@
             "cs": 37
         },
         "cmt": {
-            "clk": -1,
-            "cs": -1,
-            "fcs": -1,
-            "sdio": -1,
-            "gpio2": -1,
-            "gpio3": -1
-        },
-        "led": {
-            "led0": 17,
-            "led1": 18
+            "clk": 6,
+            "cs": 4,
+            "fcs": 21,
+            "sdio": 5,
+            "gpio2": 3,
+            "gpio3": 8
         },
         "w5500": {
-            "sclk": 39,
             "mosi": 40,
             "miso": 41,
+            "sclk": 39,
             "cs": 42,
-            "rst": 43,
-            "int": 44
+            "int": 44,
+            "rst": 43
+        },
+        "led": {
+            "led0": 17,
+            "led1": 18
+        },
+        "display": {
+            "type": 0,
+            "data": 2,
+            "clk": 1
         }
     },
     {
-        "name": "OpenDTU Fusion v2 with CMT2300A and W5500 ethernet",
+        "name": "OpenDTU Fusion v2 PoE with SH1106 Display",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
         "nrf24": {
-            "miso": -1,
-            "mosi": -1,
-            "clk": -1,
-            "irq": -1,
-            "en": -1,
-            "cs": -1
+            "miso": 48,
+            "mosi": 35,
+            "clk": 36,
+            "irq": 47,
+            "en": 38,
+            "cs": 37
         },
         "cmt": {
             "clk": 6,
@@ -236,17 +265,61 @@
             "gpio2": 3,
             "gpio3": 8
         },
+        "w5500": {
+            "mosi": 40,
+            "miso": 41,
+            "sclk": 39,
+            "cs": 42,
+            "int": 44,
+            "rst": 43
+        },
         "led": {
             "led0": 17,
             "led1": 18
         },
+        "display": {
+            "type": 3,
+            "data": 2,
+            "clk": 1
+        }
+    },
+    {
+        "name": "OpenDTU Fusion v2 PoE with SSD1306 Display",
+        "links": [
+            {"name": "Information", "url": "https://github.com/markusdd/OpenDTUFusionDocs"}
+        ],
+        "nrf24": {
+            "miso": 48,
+            "mosi": 35,
+            "clk": 36,
+            "irq": 47,
+            "en": 38,
+            "cs": 37
+        },
+        "cmt": {
+            "clk": 6,
+            "cs": 4,
+            "fcs": 21,
+            "sdio": 5,
+            "gpio2": 3,
+            "gpio3": 8
+        },
         "w5500": {
-            "sclk": 39,
             "mosi": 40,
             "miso": 41,
+            "sclk": 39,
             "cs": 42,
-            "rst": 43,
-            "int": 44
+            "int": 44,
+            "rst": 43
+        },
+        "led": {
+            "led0": 17,
+            "led1": 18
+        },
+        "display": {
+            "type": 2,
+            "data": 2,
+            "clk": 1
         }
     }
 ]

include/MqttHandleHass.h

@@ -13,7 +13,6 @@ enum DeviceClassType {
     DEVICE_CLS_PWR,
     DEVICE_CLS_VOLTAGE,
     DEVICE_CLS_FREQ,
-    DEVICE_CLS_TEMP,
     DEVICE_CLS_POWER_FACTOR,
     DEVICE_CLS_REACTIVE_POWER,
     DEVICE_CLS_CONNECTIVITY,
@@ -22,7 +21,7 @@ enum DeviceClassType {
     DEVICE_CLS_TEMPERATURE,
     DEVICE_CLS_RESTART
 };
-const char* const deviceClass_name[] = { 0, "current", "energy", "power", "voltage", "frequency", "temperature", "power_factor", "reactive_power", "connectivity", "duration", "signal_strength", "temperature", "restart" };
+const char* const deviceClass_name[] = { 0, "current", "energy", "power", "voltage", "frequency", "power_factor", "reactive_power", "connectivity", "duration", "signal_strength", "temperature", "restart" };
 
 enum StateClassType {
     STATE_CLS_NONE = 0,
@@ -55,7 +54,7 @@ const byteAssign_fieldDeviceClass_t deviceFieldAssignment[] = {
     { FLD_IAC, DEVICE_CLS_CURRENT, STATE_CLS_MEASUREMENT },
     { FLD_PAC, DEVICE_CLS_PWR, STATE_CLS_MEASUREMENT },
     { FLD_F, DEVICE_CLS_FREQ, STATE_CLS_MEASUREMENT },
-    { FLD_T, DEVICE_CLS_TEMP, STATE_CLS_MEASUREMENT },
+    { FLD_T, DEVICE_CLS_TEMPERATURE, STATE_CLS_MEASUREMENT },
     { FLD_PF, DEVICE_CLS_POWER_FACTOR, STATE_CLS_MEASUREMENT },
     { FLD_EFF, DEVICE_CLS_NONE, STATE_CLS_NONE },
     { FLD_IRR, DEVICE_CLS_NONE, STATE_CLS_NONE },
@@ -78,21 +77,21 @@ class MqttHandleHassClass {
     static void publish(const String& subtopic, const String& payload);
     static void publish(const String& subtopic, const JsonDocument& doc);
 
-    static void addCommonMetadata(JsonDocument& doc, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const CategoryType category);
+    static void addCommonMetadata(JsonDocument& doc, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
 
     // Binary Sensor
-    static void publishBinarySensor(JsonDocument& doc, const String& root_device, const String& unique_id_prefix, const String& name, const String& state_topic, const String& payload_on, const String& payload_off, const DeviceClassType device_class, const CategoryType category);
-    static void publishDtuBinarySensor(const String& name, const String& state_topic, const String& payload_on, const String& payload_off, const DeviceClassType device_class, const CategoryType category);
-    static void publishInverterBinarySensor(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& payload_on, const String& payload_off, const DeviceClassType device_class, const CategoryType category);
+    static void publishBinarySensor(JsonDocument& doc, const String& root_device, const String& unique_id_prefix, const String& name, const String& state_topic, const String& payload_on, const String& payload_off, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
+    static void publishDtuBinarySensor(const String& name, const String& state_topic, const String& payload_on, const String& payload_off, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
+    static void publishInverterBinarySensor(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& payload_on, const String& payload_off, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
 
     // Sensor
-    static void publishSensor(JsonDocument& doc, const String& root_device, const String& unique_id_prefix, const String& name, const String& state_topic, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const CategoryType category);
-    static void publishDtuSensor(const String& name, const String& state_topic, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const CategoryType category);
-    static void publishInverterSensor(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const CategoryType category);
+    static void publishSensor(JsonDocument& doc, const String& root_device, const String& unique_id_prefix, const String& name, const String& state_topic, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
+    static void publishDtuSensor(const String& name, const String& state_topic, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
+    static void publishInverterSensor(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& unit_of_measure, const String& icon, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
 
     static void publishInverterField(std::shared_ptr<InverterAbstract> inv, const ChannelType_t type, const ChannelNum_t channel, const byteAssign_fieldDeviceClass_t fieldType, const bool clear = false);
-    static void publishInverterButton(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& payload, const String& icon, const DeviceClassType device_class, const CategoryType category);
-    static void publishInverterNumber(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& command_topic, const int16_t min, const int16_t max, float step, const String& unit_of_measure, const String& icon, const CategoryType category);
+    static void publishInverterButton(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& payload, const String& icon, const DeviceClassType device_class, const StateClassType state_class, const CategoryType category);
+    static void publishInverterNumber(std::shared_ptr<InverterAbstract> inv, const String& name, const String& state_topic, const String& command_topic, const int16_t min, const int16_t max, float step, const String& unit_of_measure, const String& icon, const StateClassType state_class, const CategoryType category);
 
     static void createInverterInfo(JsonDocument& doc, std::shared_ptr<InverterAbstract> inv);
     static void createDtuInfo(JsonDocument& doc);

include/NetworkSettings.h

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 #pragma once
 
+#include "W5500.h"
 #include <DNSServer.h>
 #include <TaskSchedulerDeclarations.h>
 #include <WiFi.h>
@@ -23,18 +24,18 @@ enum class network_event {
     NETWORK_EVENT_MAX
 };
 
-typedef std::function<void(network_event event)> NetworkEventCb;
+typedef std::function<void(network_event event)> DtuNetworkEventCb;
 
-typedef struct NetworkEventCbList {
-    NetworkEventCb cb;
+typedef struct DtuNetworkEventCbList {
+    DtuNetworkEventCb cb;
     network_event event;
 
-    NetworkEventCbList()
+    DtuNetworkEventCbList()
         : cb(nullptr)
         , event(network_event::NETWORK_UNKNOWN)
     {
     }
-} NetworkEventCbList_t;
+} DtuNetworkEventCbList_t;
 
 class NetworkSettingsClass {
 public:
@@ -53,7 +54,7 @@ class NetworkSettingsClass {
     bool isConnected() const;
     network_mode NetworkMode() const;
 
-    bool onEvent(NetworkEventCb cbEvent, const network_event event = network_event::NETWORK_EVENT_MAX);
+    bool onEvent(DtuNetworkEventCb cbEvent, const network_event event = network_event::NETWORK_EVENT_MAX);
     void raiseEvent(const network_event event);
 
 private:
@@ -81,9 +82,9 @@ class NetworkSettingsClass {
     bool _dnsServerStatus = false;
     network_mode _networkMode = network_mode::Undefined;
     bool _ethConnected = false;
-    std::vector<NetworkEventCbList_t> _cbEventList;
+    std::vector<DtuNetworkEventCbList_t> _cbEventList;
     bool _lastMdnsEnabled = false;
-    bool _spiEth = false;
+    std::unique_ptr<W5500> _w5500;
 };
 
 extern NetworkSettingsClass NetworkSettings;