Prepare Release 2024-08-18

merge development into master

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -5,11 +5,18 @@ body:
   - type: markdown
     attributes:
       value: >
-        ### ✋ **This is bug tracker, not a support forum**
+        ### ⚠️ Please remember: issues are for *bugs*
+        That is, something you believe affects every single user of OpenDTU, not just you. If you're not sure, start with one of the other options below.
+  - type: markdown
+    attributes:
+      value: |
+        #### Have a question? 👉 [Start a new discussion](https://github.com/tbnobody/OpenDTU/discussions/new) or [ask in chat](https://discord.gg/WzhxEY62mB).
 
-        If something isn't working right, you have questions or need help, [**get in touch on the Discussions**](https://github.com/tbnobody/OpenDTU/discussions).
+        #### Before opening an issue, please double check:
 
-        Please quickly search existing issues first before submitting a bug.
+        - [Documentation](https://www.opendtu.solar).
+        - [The FAQs](https://www.opendtu.solar/firmware/faq/).
+        - [Existing issues and discussions](https://github.com/tbnobody/OpenDTU/search?q=&type=issues).
   - type: textarea
     id: what-happened
     attributes:
@@ -65,4 +72,17 @@ body:
         Links? References? Anything that will give us more context about the issue you are encountering!
         Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
     validations:
-      required: false
+      required: false
+  - type: checkboxes
+    id: required-checks
+    attributes:
+      label: Please confirm the following
+      options:
+        - label: I believe this issue is a bug that affects all users of OpenDTU, not something specific to my installation.
+          required: true
+        - label: I have already searched for relevant existing issues and discussions before opening this report.
+          required: true
+        - label: I have updated the title field above with a concise description.
+          required: true
+        - label: I have double checked that my inverter does not contain a W in the model name (like HMS-xxxW) as they are not supported
+          required: true

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: OpenDTU-onBattery Build
+name: OpenDTU-OnBattery Build
 
 on:
   push:
@@ -8,7 +8,7 @@ on:
     branches:
       - master
       - development
-    tags-ignore:        
+    tags-ignore:
       - 'v**'
   pull_request:
     paths-ignore:
@@ -120,6 +120,7 @@ jobs:
           name: opendtu-onbattery-${{ matrix.environment }}
           path: |
             .pio/build/${{ matrix.environment }}/opendtu-onbattery-${{ matrix.environment }}.bin
+            !.pio/build/generic_esp32_4mb_no_ota/opendtu-onbattery-generic_esp32_4mb_no_ota.bin
             .pio/build/${{ matrix.environment }}/opendtu-onbattery-${{ matrix.environment }}.factory.bin
 
   release:
@@ -130,14 +131,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      
+
       - name: Get tags
         run: git fetch --force --tags origin
 
       - name: Get openDTU core release
         run: |
           echo "OPEN_DTU_CORE_RELEASE=$(git for-each-ref --sort=creatordate --format '%(refname) %(creatordate)' refs/tags | grep 'refs/tags/v' | tail -1 | sed 's#.*/##' | sed 's/ .*//')" >> $GITHUB_ENV
-      
+
       - name: Create openDTU-core-release-Badge
         uses: schneegans/[email protected]
         with:

docs/DeviceProfiles/wt32-eth01.json

@@ -22,6 +22,34 @@
             "clk_mode": 0
         }
     },
+    {
+        "name": "WT32-ETH01 with SH1106",
+        "links": [
+            {"name": "Datasheet", "url": "http://www.wireless-tag.com/portfolio/wt32-eth01/"}
+        ],
+        "nrf24": {
+            "miso": 4,
+            "mosi": 2,
+            "clk": 32,
+            "irq": 33,
+            "en": 14,
+            "cs": 15
+        },
+        "eth": {
+            "enabled": true,
+            "phy_addr": 1,
+            "power": 16,
+            "mdc": 23,
+            "mdio": 18,
+            "type": 0,
+            "clk_mode": 0
+        },
+        "display": {
+            "type": 3,
+            "data": 5,
+            "clk": 17
+        }
+    },
     {
         "name": "WT32-ETH01 with SSD1306",
         "links": [
@@ -78,4 +106,4 @@
             "clk": 17
         }
     }
-]
+]

include/BatteryCanReceiver.h

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+#pragma once
+
+#include "Battery.h"
+#include <driver/twai.h>
+#include <Arduino.h>
+
+class BatteryCanReceiver : public BatteryProvider {
+public:
+    bool init(bool verboseLogging, char const* providerName);
+    void deinit() final;
+    void loop() final;
+
+    virtual void onMessage(twai_message_t rx_message) = 0;
+
+protected:
+    uint8_t readUnsignedInt8(uint8_t *data);
+    uint16_t readUnsignedInt16(uint8_t *data);
+    int16_t readSignedInt16(uint8_t *data);
+    uint32_t readUnsignedInt32(uint8_t *data);
+    float scaleValue(int16_t value, float factor);
+    bool getBit(uint8_t value, uint8_t bit);
+
+    bool _verboseLogging = true;
+
+private:
+    char const* _providerName = "Battery CAN";
+};

include/BatteryStats.h

@@ -14,33 +14,37 @@ class BatteryStats {
     public:
         String const& getManufacturer() const { return _manufacturer; }
 
-        // the last time *any* datum was updated
+        // the last time *any* data was updated
         uint32_t getAgeSeconds() const { return (millis() - _lastUpdate) / 1000; }
         bool updateAvailable(uint32_t since) const;
 
         uint8_t getSoC() const { return _soc; }
         uint32_t getSoCAgeSeconds() const { return (millis() - _lastUpdateSoC) / 1000; }
+        uint8_t getSoCPrecision() const { return _socPrecision; }
 
         float getVoltage() const { return _voltage; }
         uint32_t getVoltageAgeSeconds() const { return (millis() - _lastUpdateVoltage) / 1000; }
 
+        float getChargeCurrent() const { return _current; };
+        uint8_t getChargeCurrentPrecision() const { return _currentPrecision; }
+
         // convert stats to JSON for web application live view
         virtual void getLiveViewData(JsonVariant& root) const;
 
         void mqttLoop();
 
-        // the interval at which all battery datums will be re-published, even
+        // the interval at which all battery data will be re-published, even
         // if they did not change. used to calculate Home Assistent expiration.
         virtual uint32_t getMqttFullPublishIntervalMs() const;
 
         bool isSoCValid() const { return _lastUpdateSoC > 0; }
         bool isVoltageValid() const { return _lastUpdateVoltage > 0; }
+        bool isCurrentValid() const { return _lastUpdateCurrent > 0; }
 
         // returns true if the battery reached a critically low voltage/SoC,
         // such that it is in need of charging to prevent degredation.
         virtual bool getImmediateChargingRequest() const { return false; };
 
-        virtual float getChargeCurrent() const { return 0; };
         virtual float getChargeCurrentLimitation() const { return FLT_MAX; };
 
     protected:
@@ -57,9 +61,16 @@ class BatteryStats {
             _lastUpdateVoltage = _lastUpdate = timestamp;
         }
 
+        void setCurrent(float current, uint8_t precision, uint32_t timestamp) {
+            _current = current;
+            _currentPrecision = precision;
+            _lastUpdateCurrent = _lastUpdate = timestamp;
+        }
+
         String _manufacturer = "unknown";
         String _hwversion = "";
         String _fwversion = "";
+        String _serial = "";
         uint32_t _lastUpdate = 0;
 
     private:
@@ -69,6 +80,12 @@ class BatteryStats {
         uint32_t _lastUpdateSoC = 0;
         float _voltage = 0; // total battery pack voltage
         uint32_t _lastUpdateVoltage = 0;
+
+        // total current into (positive) or from (negative)
+        // the battery, i.e., the charging current
+        float _current = 0;
+        uint8_t _currentPrecision = 0; // decimal places
+        uint32_t _lastUpdateCurrent = 0;
 };
 
 class PylontechBatteryStats : public BatteryStats {
@@ -78,7 +95,6 @@ class PylontechBatteryStats : public BatteryStats {
         void getLiveViewData(JsonVariant& root) const final;
         void mqttPublish() const final;
         bool getImmediateChargingRequest() const { return _chargeImmediately; } ;
-        float getChargeCurrent() const { return _current; } ;
         float getChargeCurrentLimitation() const { return _chargeCurrentLimitation; } ;
 
     private:
@@ -89,9 +105,6 @@ class PylontechBatteryStats : public BatteryStats {
         float _chargeCurrentLimitation;
         float _dischargeCurrentLimitation;
         uint16_t _stateOfHealth;
-        // total current into (positive) or from (negative)
-        // the battery, i.e., the charging current
-        float _current;
         float _temperature;
 
         bool _alarmOverCurrentDischarge;
@@ -115,6 +128,80 @@ class PylontechBatteryStats : public BatteryStats {
         bool _chargeImmediately;
 };
 
+class PytesBatteryStats : public BatteryStats {
+    friend class PytesCanReceiver;
+
+    public:
+        void getLiveViewData(JsonVariant& root) const final;
+        void mqttPublish() const final;
+        float getChargeCurrentLimitation() const { return _chargeCurrentLimit; } ;
+
+    private:
+        void setManufacturer(String&& m) { _manufacturer = std::move(m); }
+        void setLastUpdate(uint32_t ts) { _lastUpdate = ts; }
+        void updateSerial() {
+            if (!_serialPart1.isEmpty() && !_serialPart2.isEmpty()) {
+                _serial = _serialPart1 + _serialPart2;
+            }
+        }
+
+        String _serialPart1 = "";
+        String _serialPart2 = "";
+
+        float _chargeVoltageLimit;
+        float _chargeCurrentLimit;
+        float _dischargeVoltageLimit;
+        float _dischargeCurrentLimit;
+
+        uint16_t _stateOfHealth;
+
+        float _temperature;
+
+        uint16_t _cellMinMilliVolt;
+        uint16_t _cellMaxMilliVolt;
+        float _cellMinTemperature;
+        float _cellMaxTemperature;
+
+        String _cellMinVoltageName;
+        String _cellMaxVoltageName;
+        String _cellMinTemperatureName;
+        String _cellMaxTemperatureName;
+
+        uint8_t _moduleCountOnline;
+        uint8_t _moduleCountOffline;
+
+        uint8_t _moduleCountBlockingCharge;
+        uint8_t _moduleCountBlockingDischarge;
+
+        uint16_t _totalCapacity;
+        uint16_t _availableCapacity;
+
+        float _chargedEnergy = -1;
+        float _dischargedEnergy = -1;
+
+        bool _alarmUnderVoltage;
+        bool _alarmOverVoltage;
+        bool _alarmOverCurrentCharge;
+        bool _alarmOverCurrentDischarge;
+        bool _alarmUnderTemperature;
+        bool _alarmOverTemperature;
+        bool _alarmUnderTemperatureCharge;
+        bool _alarmOverTemperatureCharge;
+        bool _alarmInternalFailure;
+        bool _alarmCellImbalance;
+
+        bool _warningLowVoltage;
+        bool _warningHighVoltage;
+        bool _warningHighChargeCurrent;
+        bool _warningHighDischargeCurrent;
+        bool _warningLowTemperature;
+        bool _warningHighTemperature;
+        bool _warningLowTemperatureCharge;
+        bool _warningHighTemperatureCharge;
+        bool _warningInternalFailure;
+        bool _warningCellImbalance;
+};
+
 class JkBmsBatteryStats : public BatteryStats {
     public:
         void getLiveViewData(JsonVariant& root) const final {
@@ -152,7 +239,6 @@ class VictronSmartShuntStats : public BatteryStats {
         void updateFrom(VeDirectShuntController::data_t const& shuntData);
 
     private:
-        float _current;
         float _temperature;
         bool _tempPresent;
         uint8_t _chargeCycles;
@@ -180,7 +266,7 @@ class MqttBatteryStats : public BatteryStats {
         // we do NOT publish the same data under a different topic.
         void mqttPublish() const final { }
 
-        // 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
+        // we don't need a card in the liveview, since the SoC and
+        // voltage (if available) is already displayed at the top.
         void getLiveViewData(JsonVariant& root) const final { }
 };