Merge branch 'development' of https://github.com/helgeerbe/OpenDTU-On…

…Battery into development
hoylabs · Sep 20, 2024 · 9e8c7f1 · 9e8c7f1
2 parents 5df13c3 + d1aad0b
commit 9e8c7f1
Show file tree

Hide file tree

Showing 136 changed files with 1,702 additions and 1,485 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -4,19 +4,19 @@ labels: ["bug"]
 body:
   - type: markdown
     attributes:
-      value: >
-        ### ⚠️ Please remember: issues are for *bugs*
+      value: |
+        ### ⚠️ 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).
+        #### Have a question? 👉 [Start a new discussion](https://github.com/helgeerbe/OpenDTU-OnBattery/discussions/new/choose) or [ask in chat](https://discord.gg/WzhxEY62mB).
 
         #### Before opening an issue, please double check:
 
-        - [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).
+        - [Documentation](https://opendtu-onbattery.net)
+        - [The FAQs](https://opendtu-onbattery.net/firmware/faq/)
+        - [Existing issues and discussions](https://github.com/helgeerbe/OpenDTU-OnBattery/search?q=&type=issues)
   - type: textarea
     id: what-happened
     attributes:
@@ -47,7 +47,8 @@ body:
       label: Install Method
       description: How did you install OpenDTU?
       options:
-        - Pre-Compiled binary from GitHub
+        - Pre-Compiled binary from GitHub releases
+        - Pre-Compiles binary from GitHub actions/pull-request
         - Self-Compiled
     validations:
       required: true
@@ -59,6 +60,14 @@ body:
       placeholder: "e.g. 359d513"
     validations:
       required: true
+  - type: input
+    id: environment
+    attributes:
+      label: What firmware variant (PIO Environment) are you using?
+      description: You can find this in by going to Info -> System
+      placeholder: "generic_esp32s3_usb"
+    validations:
+      required: true
   - type: textarea
     id: logs
     attributes:
@@ -78,11 +87,11 @@ body:
     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.
+        - label: I believe this issue is a bug that affects all users of OpenDTU-OnBattery, 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
+        - 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
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -4,5 +4,5 @@ contact_links:
     url: https://discord.gg/WzhxEY62mB
     about: Discuss with us on Discord
   - name: 🤔 Have questions or need support?
-    url: https://github.com/tbnobody/OpenDTU/discussions
+    url: https://github.com/helgeerbe/OpenDTU-OnBattery/discussions
     about: Use the GitHub Discussions feature
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,12 +1,12 @@
 name: ✨ Request a feature
-description: Suggest an improvement idea for OpenDTU!
+description: Suggest an improvement idea for OpenDTU-OnBattery!
 title: "[Request]"
 labels: ["enhancement"]
 body:
   - type: markdown
     attributes:
       value: >
-        **Thank you for wanting to request a feature in OpenDTU!**
+        **Thank you for wanting to request a feature in OpenDTU-OnBattery!**
 
         Before you go ahead with your request, please first consider if it wouldn't be
         better suited in a external home automation software like OpenHAB, ioBroker, Home Assistant etc.

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -48,7 +48,7 @@ jobs:
       environments: ${{ steps.envs.outputs.environments }}
 
   build:
-    name: Build Enviornments
+    name: Build Environments
     runs-on: ubuntu-latest
     needs: get_default_envs
     strategy:
@@ -93,6 +93,11 @@ jobs:
           python -m pip install --upgrade pip
           pip install --upgrade platformio setuptools
 
+      - name: Enable Corepack
+        run: |
+            cd webapp
+            corepack enable
+
       - name: Setup Node.js and yarn
         uses: actions/setup-node@v4
         with:
@@ -101,10 +106,14 @@ jobs:
           cache-dependency-path: "webapp/yarn.lock"
 
       - name: Install WebApp dependencies
-        run: yarn --cwd webapp install --frozen-lockfile
+        run: |
+            cd webapp
+            yarn install --frozen-lockfile
 
       - name: Build WebApp
-        run: yarn --cwd webapp build
+        run: |
+            cd webapp
+            yarn build
 
       - name: Build firmware
         run: pio run -e ${{ matrix.environment }}
@@ -130,7 +139,7 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/2')
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Get tags
         run: git fetch --force --tags origin
@@ -139,15 +148,18 @@ jobs:
         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:
-          auth: ${{ secrets.GIST_SECRET }}
-          gistID: 68b47cc8c8994d04ab3a4fa9d8aee5e6
-          filename: openDTUcoreRelease.json
-          label: based on original OpenDTU
-          message: ${{ env.OPEN_DTU_CORE_RELEASE }}
-          color: lightblue
+# disabled as uploading the changed gist failed repeatedly.
+# maybe the token in secrets.GIST_SECRET has expired?
+# need help from repo owner @helgeerbe to fix this.
+#      - name: Create openDTU-core-release-Badge
+#        uses: schneegans/[email protected]
+#        with:
+#          auth: ${{ secrets.GIST_SECRET }}
+#          gistID: 68b47cc8c8994d04ab3a4fa9d8aee5e6
+#          filename: openDTUcoreRelease.json
+#          label: based on original OpenDTU
+#          message: ${{ env.OPEN_DTU_CORE_RELEASE }}
+#          color: lightblue
 
       - name: Build Changelog
         id: github_release

diff --git a/.github/workflows/config/release-notes-config.json b/.github/workflows/config/release-notes-config.json
@@ -18,6 +18,12 @@
                 "fix"
             ]
         },
+        {
+            "title": "## 🌎 Web Application",
+            "labels": [
+                "webapp"
+            ]
+        },
         {
             "title": "## 📚 Documentation",
             "labels": [

diff --git a/.github/workflows/cpplint.yml b/.github/workflows/cpplint.yml
@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -18,4 +18,4 @@ jobs:
           pip install cpplint
       - 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
+          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
diff --git a/.github/workflows/test_build.yml b/.github/workflows/test_build.yml
diff --git a/.github/workflows/yarnlint.yml b/.github/workflows/yarnlint.yml
@@ -6,17 +6,23 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
+    defaults:
+      run:
+        working-directory: webapp
+
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+      - name: Enable Corepack
+        run: corepack enable
       - name: Setup Node.js and yarn
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "20"
           cache: "yarn"
           cache-dependency-path: "webapp/yarn.lock"
 
       - name: Install WebApp dependencies
-        run: yarn --cwd webapp install --frozen-lockfile
+        run: yarn install --frozen-lockfile
 
       - name: Linting
-        run: yarn --cwd webapp lint
+        run: yarn lint
diff --git a/.github/workflows/yarnprettier.yml b/.github/workflows/yarnprettier.yml
@@ -0,0 +1,28 @@
+name: Yarn Prettier
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: webapp
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Enable Corepack
+        run: corepack enable
+      - name: Setup Node.js and yarn
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "yarn"
+          cache-dependency-path: "webapp/yarn.lock"
+
+      - name: Install WebApp dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Check Formatting
+        run: yarn prettier --check src/
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@
 platformio-device-monitor*.log
 logs/device-monitor*.log
 platformio_override.ini
+webapp_dist/
 .DS_Store