Merge remote-tracking branch 'tbnobody/OpenDTU/master' into development

hoylabs · Jun 9, 2023 · e68baa3 · e68baa3
2 parents e0a8da8 + 170978c
commit e68baa3
Show file tree

Hide file tree

Showing 26 changed files with 236 additions and 245 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -39,7 +39,7 @@ jobs:
       - name: Get default environments
         id: envs
         run: |
-          echo "environments=$(pio project config --json-output | jq -cr '.[0][1][0][1]')" >> $GITHUB_OUTPUT
+          echo "environments=$(pio project config --json-output | jq -cr '.[1][1][0][1]|split(",")')" >> $GITHUB_OUTPUT
 
     outputs:
       environments: ${{ steps.envs.outputs.environments }}
@@ -100,17 +100,15 @@ jobs:
       - name: Rename Firmware
         run: mv .pio/build/${{ matrix.environment }}/firmware.bin .pio/build/${{ matrix.environment }}/opendtu-onbattery-${{ matrix.environment }}.bin
 
-      - name: Copy boot_app0.bin
-        run: cp ~/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin .pio/build/${{ matrix.environment }}/boot_app0.bin
+      - name: Rename Factory Firmware
+        run: mv .pio/build/${{ matrix.environment }}/firmware.factory.bin .pio/build/${{ matrix.environment }}/opendtu-${{ matrix.environment }}.factory.bin
 
       - uses: actions/upload-artifact@v3
         with:
           name: opendtu-onbattery-${{ matrix.environment }}
           path: |
             .pio/build/${{ matrix.environment }}/opendtu-onbattery-${{ matrix.environment }}.bin
-            .pio/build/${{ matrix.environment }}/partitions.bin
-            .pio/build/${{ matrix.environment }}/bootloader.bin
-            .pio/build/${{ matrix.environment }}/boot_app0.bin
+            .pio/build/${{ matrix.environment }}/opendtu-${{ matrix.environment }}.factory.bin
 
   release:
     name: Create Release
@@ -140,7 +138,7 @@ jobs:
 
       - name: Build Changelog
         id: github_release
-        uses: mikepenz/release-changelog-builder-action@v3.7.0
+        uses: mikepenz/release-changelog-builder-action@v3
         with:
           failOnError: true
           commitMode: true
@@ -152,12 +150,10 @@ jobs:
         with:
           path: artifacts/
 
-      - name: Create ZIPs
+      - name: Move all files to the same location
         run: |
           ls -R
-          sudo apt install zip
           cd artifacts
-          for i in */; do zip -r "${i%/}.zip" "$i"; done
           for i in */; do cp ${i}opendtu-onbattery-*.bin ./; done
 
       - name: Create release

diff --git a/README.md b/README.md
@@ -399,14 +399,7 @@ It is recommended to make all changes only in the  'platformio_override.ini', th
 
 ### using the pre-compiled .bin files
 
-The pre-compiled binary files can be found here on the [github page behind "Releases"](https://github.com/tbnobody/OpenDTU/releases) (look at the right column). For a first installation on an ESP32, download `opendtu-generic.zip`, unpack and use a ESP32 flash tool of your choice (see next chapter) to flash the `.bin` files to the right addresses:
-
-| Address  | File                   |
-| ---------| ---------------------- |
-| 0x1000   | bootloader.bin         |
-| 0x8000   | partitions.bin         |
-| 0xe000   | boot_app0.bin          |
-| 0x10000  | opendtu-*.bin          |
+The pre-compiled binary files can be found here on the [github page behind "Releases"](https://github.com/tbnobody/OpenDTU/releases) (look at the right column). For a first installation on an ESP32, download `opendtu-generic.factory.bin` and use a ESP32 flash tool of your choice to flash the `.bin` file to the address `0x0`. (The previous method with different .bin files is no more necessary.)
 
 For further updates download `opendtu-generic.bin` and use the over-the-air firmware update in OpenDTU's web interface.
 
@@ -415,10 +408,7 @@ For further updates download `opendtu-generic.bin` and use the over-the-air firm
 ```bash
 esptool.py --port /dev/ttyUSB0 --chip esp32 --before default_reset --after hard_reset \
   write_flash --flash_mode dout --flash_freq 40m --flash_size detect \
-  0x1000 bootloader.bin \
-  0x8000 partitions.bin \
-  0xe000 boot_app0.bin \
-  0x10000 opendtu-generic.bin
+  0x0 opendtu-generic.factory.bin
 ```
 
 #### Flash with Espressif Flash Download Tool (Windows)

diff --git a/docs/DeviceProfiles/nodemcu_esp32.json b/docs/DeviceProfiles/nodemcu_esp32.json
@@ -1,6 +1,6 @@
 [
     {
-        "name": "Generic NodeMCU 32",
+        "name": "NRF24",
         "nrf24": {
             "miso": 19,
             "mosi": 23,
@@ -10,17 +10,11 @@
             "cs": 5
         },
         "eth": {
-            "enabled": false,
-            "phy_addr": -1,
-            "power": -1,
-            "mdc": -1,
-            "mdio": -1,
-            "type": 0,
-            "clk_mode": 0
+            "enabled": false
         }
     },
     {
-        "name": "Generic NodeMCU 32 with CMT2300A",
+        "name": "CMT2300A",
         "nrf24": {
             "miso": -1,
             "mosi": -1,
@@ -38,17 +32,11 @@
             "gpio3": 16
         },
         "eth": {
-            "enabled": false,
-            "phy_addr": -1,
-            "power": -1,
-            "mdc": -1,
-            "mdio": -1,
-            "type": 0,
-            "clk_mode": 0
+            "enabled": false
         }
     },
     {
-        "name": "Generic NodeMCU 32 with SSD1306",
+        "name": "NRF24 with SSD1306",
         "nrf24": {
             "miso": 19,
             "mosi": 23,
@@ -58,13 +46,7 @@
             "cs": 5
         },
         "eth": {
-            "enabled": false,
-            "phy_addr": -1,
-            "power": -1,
-            "mdc": -1,
-            "mdio": -1,
-            "type": 0,
-            "clk_mode": 0
+            "enabled": false
         },
         "display": {
             "type": 2,
@@ -73,7 +55,7 @@
         }
     },
     {
-        "name": "Generic NodeMCU 32 with SH1106",
+        "name": "NRF24 with SH1106",
         "nrf24": {
             "miso": 19,
             "mosi": 23,
@@ -83,13 +65,7 @@
             "cs": 5
         },
         "eth": {
-            "enabled": false,
-            "phy_addr": -1,
-            "power": -1,
-            "mdc": -1,
-            "mdio": -1,
-            "type": 0,
-            "clk_mode": 0
+            "enabled": false
         },
         "display": {
             "type": 3,
@@ -98,7 +74,61 @@
         }
     },
     {
-        "name": "Generic NodeMCU 32 with NRF + CMT Module",
+        "name": "CMT2300A with SSD1306",
+        "nrf24": {
+            "miso": -1,
+            "mosi": -1,
+            "clk": -1,
+            "irq": -1,
+            "en": -1,
+            "cs": -1
+        },
+        "cmt": {
+            "clk": 18,
+            "cs": 4,
+            "fcs": 5,
+            "sdio": 23,
+            "gpio2": 19,
+            "gpio3": 16
+        },
+        "eth": {
+            "enabled": false
+        },
+        "display": {
+            "type": 2,
+            "data": 21,
+            "clk": 22
+        }
+    },
+    {
+        "name": "CMT2300A with SH1106",
+        "nrf24": {
+            "miso": -1,
+            "mosi": -1,
+            "clk": -1,
+            "irq": -1,
+            "en": -1,
+            "cs": -1
+        },
+        "cmt": {
+            "clk": 18,
+            "cs": 4,
+            "fcs": 5,
+            "sdio": 23,
+            "gpio2": 19,
+            "gpio3": 16
+        },
+        "eth": {
+            "enabled": false
+        },
+        "display": {
+            "type": 3,
+            "data": 21,
+            "clk": 22
+        }
+    },
+    {
+        "name": "NRF24 + CMT2300A",
         "nrf24": {
             "miso": 19,
             "mosi": 23,

diff --git a/docs/esp32_flash_download_tool.png b/docs/esp32_flash_download_tool.png
diff --git a/lib/Hoymiles/src/HoymilesRadio.cpp b/lib/Hoymiles/src/HoymilesRadio.cpp
@@ -51,6 +51,69 @@ void HoymilesRadio::sendLastPacketAgain()
     sendEsbPacket(cmd);
 }
 
+void HoymilesRadio::handleReceivedPackage()
+{
+    if (_busyFlag && _rxTimeout.occured()) {
+        Hoymiles.getMessageOutput()->println("RX Period End");
+        std::shared_ptr<InverterAbstract> inv = Hoymiles.getInverterBySerial(_commandQueue.front().get()->getTargetAddress());
+
+        if (nullptr != inv) {
+            CommandAbstract* cmd = _commandQueue.front().get();
+            uint8_t verifyResult = inv->verifyAllFragments(cmd);
+            if (verifyResult == FRAGMENT_ALL_MISSING_RESEND) {
+                Hoymiles.getMessageOutput()->println("Nothing received, resend whole request");
+                sendLastPacketAgain();
+
+            } else if (verifyResult == FRAGMENT_ALL_MISSING_TIMEOUT) {
+                Hoymiles.getMessageOutput()->println("Nothing received, resend count exeeded");
+                _commandQueue.pop();
+                _busyFlag = false;
+
+            } else if (verifyResult == FRAGMENT_RETRANSMIT_TIMEOUT) {
+                Hoymiles.getMessageOutput()->println("Retransmit timeout");
+                _commandQueue.pop();
+                _busyFlag = false;
+
+            } else if (verifyResult == FRAGMENT_HANDLE_ERROR) {
+                Hoymiles.getMessageOutput()->println("Packet handling error");
+                _commandQueue.pop();
+                _busyFlag = false;
+
+            } else if (verifyResult > 0) {
+                // Perform Retransmit
+                Hoymiles.getMessageOutput()->print("Request retransmit: ");
+                Hoymiles.getMessageOutput()->println(verifyResult);
+                sendRetransmitPacket(verifyResult);
+
+            } else {
+                // Successful received all packages
+                Hoymiles.getMessageOutput()->println("Success");
+                _commandQueue.pop();
+                _busyFlag = false;
+            }
+        } else {
+            // If inverter was not found, assume the command is invalid
+            Hoymiles.getMessageOutput()->println("RX: Invalid inverter found");
+            _commandQueue.pop();
+            _busyFlag = false;
+        }
+    } else if (!_busyFlag) {
+        // Currently in idle mode --> send packet if one is in the queue
+        if (!_commandQueue.empty()) {
+            CommandAbstract* cmd = _commandQueue.front().get();
+
+            auto inv = Hoymiles.getInverterBySerial(cmd->getTargetAddress());
+            if (nullptr != inv) {
+                inv->clearRxFragmentBuffer();
+                sendEsbPacket(cmd);
+            } else {
+                Hoymiles.getMessageOutput()->println("TX: Invalid inverter found");
+                _commandQueue.pop();
+            }
+        }
+    }
+}
+
 void HoymilesRadio::dumpBuf(const uint8_t buf[], uint8_t len, bool appendNewline)
 {
     for (uint8_t i = 0; i < len; i++) {

diff --git a/lib/Hoymiles/src/HoymilesRadio.h b/lib/Hoymiles/src/HoymilesRadio.h
@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 #pragma once
 
+#include "TimeoutHelper.h"
 #include "commands/CommandAbstract.h"
 #include "types.h"
 #include <memory>
@@ -30,9 +31,12 @@ class HoymilesRadio {
     virtual void sendEsbPacket(CommandAbstract* cmd) = 0;
     void sendRetransmitPacket(uint8_t fragment_id);
     void sendLastPacketAgain();
+    void handleReceivedPackage();
 
     serial_u _dtuSerial;
     std::queue<std::shared_ptr<CommandAbstract>> _commandQueue;
     bool _isInitialized = false;
     bool _busyFlag = false;
+
+    TimeoutHelper _rxTimeout;
 };
diff --git a/lib/Hoymiles/src/HoymilesRadio_CMT.cpp b/lib/Hoymiles/src/HoymilesRadio_CMT.cpp
@@ -151,65 +151,7 @@ void HoymilesRadio_CMT::loop()
         }
     }
 
-    if (_busyFlag && _rxTimeout.occured()) {
-        Hoymiles.getMessageOutput()->println("RX Period End");
-        std::shared_ptr<InverterAbstract> inv = Hoymiles.getInverterBySerial(_commandQueue.front().get()->getTargetAddress());
-
-        if (nullptr != inv) {
-            CommandAbstract* cmd = _commandQueue.front().get();
-            uint8_t verifyResult = inv->verifyAllFragments(cmd);
-            if (verifyResult == FRAGMENT_ALL_MISSING_RESEND) {
-                Hoymiles.getMessageOutput()->println("Nothing received, resend whole request");
-                sendLastPacketAgain();
-
-            } else if (verifyResult == FRAGMENT_ALL_MISSING_TIMEOUT) {
-                Hoymiles.getMessageOutput()->println("Nothing received, resend count exeeded");
-                _commandQueue.pop();
-                _busyFlag = false;
-
-            } else if (verifyResult == FRAGMENT_RETRANSMIT_TIMEOUT) {
-                Hoymiles.getMessageOutput()->println("Retransmit timeout");
-                _commandQueue.pop();
-                _busyFlag = false;
-
-            } else if (verifyResult == FRAGMENT_HANDLE_ERROR) {
-                Hoymiles.getMessageOutput()->println("Packet handling error");
-                _commandQueue.pop();
-                _busyFlag = false;
-
-            } else if (verifyResult > 0) {
-                // Perform Retransmit
-                Hoymiles.getMessageOutput()->print("Request retransmit: ");
-                Hoymiles.getMessageOutput()->println(verifyResult);
-                sendRetransmitPacket(verifyResult);
-
-            } else {
-                // Successful received all packages
-                Hoymiles.getMessageOutput()->println("Success");
-                _commandQueue.pop();
-                _busyFlag = false;
-            }
-        } else {
-            // If inverter was not found, assume the command is invalid
-            Hoymiles.getMessageOutput()->println("RX: Invalid inverter found");
-            _commandQueue.pop();
-            _busyFlag = false;
-        }
-    } else if (!_busyFlag) {
-        // Currently in idle mode --> send packet if one is in the queue
-        if (!_commandQueue.empty()) {
-            CommandAbstract* cmd = _commandQueue.front().get();
-
-            auto inv = Hoymiles.getInverterBySerial(cmd->getTargetAddress());
-            if (nullptr != inv) {
-                inv->clearRxFragmentBuffer();
-                sendEsbPacket(cmd);
-            } else {
-                Hoymiles.getMessageOutput()->println("TX: Invalid inverter found");
-                _commandQueue.pop();
-            }
-        }
-    }
+    handleReceivedPackage();
 }
 
 void HoymilesRadio_CMT::setPALevel(int8_t paLevel)