FredM67
diff --git a/‎.github/workflows/build.yml‎
Lines changed: 213 additions & 34 deletions b/‎.github/workflows/build.yml‎
Lines changed: 213 additions & 34 deletions
diff --git a/‎.pre-commit-config.yaml‎
Lines changed: 1 addition & 0 deletions b/‎.pre-commit-config.yaml‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 64 additions & 5 deletions b/‎CONTRIBUTING.md‎
Lines changed: 64 additions & 5 deletions
@@ -1,48 +1,227 @@
-# This is a basic workflow to help you get started with Actions
+# CI workflow for PVRouter-3-phase
+# Runs build and tests on push/PR to main and dev branches
 
 name: CI
 permissions:
   contents: read
+  checks: write
 
-# Controls when the action will run. Triggers the workflow on push or pull request
-# events but only for the master branch
 on:
   push:
-    branches: [ main ]
+    branches: [ main, dev ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, dev ]
+
+env:
+  PROJECT_DIR: Mk2_3phase_RFdatalog_temp
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
+  # Setup job: installs dependencies and populates cache
+  setup:
+    name: Setup Environment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: 'true'
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '>=3.11'
+
+      - name: Cache PlatformIO
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.platformio
+          key: ${{ runner.os }}-pio-${{ hashFiles('**/platformio.ini') }}
+
+      - name: Install PlatformIO
+        run: |
+          python -m pip install --upgrade pip
+          pip install --upgrade platformio
+
+      - name: Install PlatformIO libraries
+        run: pio pkg install --project-dir ${{ env.PROJECT_DIR }}
+
+  # Build job: compiles firmware for embedded targets
   build:
-    # The type of runner that the job will run on
+    name: Build Firmware
+    needs: setup
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: 'true'
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '>=3.11'
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
+      - name: Restore PlatformIO cache
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.platformio
+          key: ${{ runner.os }}-pio-${{ hashFiles('**/platformio.ini') }}
+
+      - name: Install PlatformIO
+        run: pip install --upgrade platformio
+
+      - name: Build firmware
+        run: pio run --project-dir ${{ env.PROJECT_DIR }}
+
+  # Native test jobs: runs each native test separately
+  test-native:
+    name: Native (${{ matrix.test }})
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        test:
+          - test_ewma_avg
+          - test_utils_override
     steps:
-    - uses: actions/checkout@v6
-      with:
-        submodules: 'true'
-    - uses: actions/cache@v5
-      with:
-        path: |
-          ~/.cache/pip
-          ~/.platformio/.cache
-        key: ${{ runner.os }}-pio
-    - name: Set up Python
-      uses: actions/setup-python@v6
-      with:
-        python-version: '>=3.11'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-    - name: Install PlatformIO Core
-      run: |
-        pip install --upgrade platformio
-    # It is important to first install the libraries before compiling, since otherwise compilation might fail to find the just-installed libraries
-    - name: Install platformIO libraries
-      run: pio pkg install --project-dir Mk2_3phase_RFdatalog_temp
-    - name: Run PlatformIO
-      run: |
-        pio run --project-dir Mk2_3phase_RFdatalog_temp
+      - uses: actions/checkout@v6
+        with:
+          submodules: 'true'
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '>=3.11'
+
+      - name: Restore PlatformIO cache
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.platformio
+          key: ${{ runner.os }}-pio-${{ hashFiles('**/platformio.ini') }}
+
+      - name: Install PlatformIO
+        run: pip install --upgrade platformio
+
+      - name: Run ${{ matrix.test }}
+        run: pio test --project-dir ${{ env.PROJECT_DIR }} -e native -f "*${{ matrix.test }}*"
+
+  # Embedded test jobs: runs each test in Wokwi simulator
+  test-embedded:
+    name: Embedded (${{ matrix.test }})
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        test:
+          - test_fastdivision
+          - test_utils_pins
+          - test_utils_relay
+          - test_teleinfo
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: 'true'
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '>=3.11'
+
+      - name: Restore PlatformIO cache
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.platformio
+          key: ${{ runner.os }}-pio-${{ hashFiles('**/platformio.ini') }}
+
+      - name: Install PlatformIO
+        run: pip install --upgrade platformio
+
+      - name: Install Wokwi CLI
+        run: |
+          curl -L https://wokwi.com/ci/install.sh | sh
+          echo "$HOME/bin" >> $GITHUB_PATH
+          echo "$HOME/.wokwi/bin" >> $GITHUB_PATH
+
+      - name: Build test firmware
+        run: pio test --project-dir ${{ env.PROJECT_DIR }} -e uno -f "*${{ matrix.test }}*" --without-uploading --without-testing
+
+      - name: Run ${{ matrix.test }} in Wokwi
+        env:
+          WOKWI_CLI_TOKEN: ${{ secrets.WOKWI_CLI_TOKEN }}
+        run: |
+          wokwi-cli --timeout 60000 \
+            --expect-text "OK" \
+            --fail-text "FAIL" \
+            --diagram-file ../diagram.json \
+            --elf ${{ env.PROJECT_DIR }}/.pio/build/uno/firmware.elf \
+            --serial-log-file wokwi-output.txt \
+            ${{ env.PROJECT_DIR }}/test/embedded/${{ matrix.test }}
+
+      - name: Convert Unity output to JUnit XML
+        if: always()
+        run: |
+          # Convert Unity test output to JUnit XML format
+          python3 << 'EOF'
+          import re
+          import sys
+          from xml.etree.ElementTree import Element, SubElement, tostring
+          from xml.dom import minidom
+
+          with open('wokwi-output.txt', 'r', encoding='utf-8', errors='ignore') as f:
+              content = f.read()
+
+          # Parse Unity output
+          test_pattern = r'([^:]+):(\d+):([^:]+):(PASS|FAIL)'
+          summary_pattern = r'(\d+) Tests (\d+) Failures (\d+) Ignored'
+
+          tests = re.findall(test_pattern, content)
+          summary = re.search(summary_pattern, content)
+
+          # Build JUnit XML
+          testsuites = Element('testsuites')
+          testsuite = SubElement(testsuites, 'testsuite')
+          testsuite.set('name', '${{ matrix.test }}')
+          testsuite.set('tests', str(len(tests)))
+
+          failures = 0
+          for file, line, name, result in tests:
+              testcase = SubElement(testsuite, 'testcase')
+              testcase.set('name', name)
+              testcase.set('classname', file.split('/')[-1])
+              if result == 'FAIL':
+                  failures += 1
+                  failure = SubElement(testcase, 'failure')
+                  failure.set('message', f'Test failed at {file}:{line}')
+
+          testsuite.set('failures', str(failures))
+
+          # Pretty print
+          xml_str = minidom.parseString(tostring(testsuites)).toprettyxml(indent="  ")
+          with open('test-results.xml', 'w') as f:
+              f.write(xml_str)
+          EOF
+
+      - name: Publish test results
+        if: always()
+        uses: dorny/test-reporter@v1
+        with:
+          name: ${{ matrix.test }}
+          path: test-results.xml
+          reporter: java-junit
+
+      - name: Upload test artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.test }}-output
+          path: |
+            wokwi-output.txt
+            test-results.xml
@@ -14,6 +14,7 @@ repos:
       - id: no-commit-to-branch
         args:
           - --branch=main
+          - --branch=dev
       - id: end-of-file-fixer
         exclude: ^(.*/)?\.vscode/|\.drawio$
       - id: trailing-whitespace
 
@@ -6,8 +6,6 @@ Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approacha
 
 In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
 
-Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
-
 ## New contributor guide
 
 To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
@@ -18,6 +16,69 @@ To get an overview of the project, read the [README](README.md). Here are some r
 - [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
 
 
+## Branching Strategy
+
+This project uses a two-branch workflow:
+
+| Branch | Purpose | Description |
+|--------|---------|-------------|
+| `main` | Stable releases | Production-ready code that users download (default branch) |
+| `dev` | Development | Active development and testing |
+
+> **Note:** Direct commits to `main` and `dev` are blocked by pre-commit hooks. Always work in feature branches.
+
+### Daily Development Workflow
+
+**Starting a new feature:**
+
+```bash
+# Switch to dev and update
+git checkout dev
+git pull origin dev
+
+# Create feature branch
+git checkout -b feature/my-feature-name
+```
+
+**Working on your feature:**
+
+```bash
+# Make changes, commit as usual
+git add .
+git commit -m "feat: description of changes"
+
+# Push your feature branch
+git push -u origin feature/my-feature-name
+```
+
+**Creating a Pull Request:**
+
+```bash
+# Create PR targeting dev branch
+gh pr create --base dev --title "feat: my feature"
+
+# Or use GitHub UI and change base branch from 'main' to 'dev'
+```
+
+### Release Workflow
+
+**When ready to release stable code to users:**
+
+```bash
+# Switch to main branch
+git checkout main
+git pull origin main
+
+# Merge dev into main
+git merge dev
+
+# Tag the release
+git tag v1.x.x
+git push origin main --tags
+```
+
+After merging to `main`, users will get the latest stable release when they clone or download the repository.
+
 ## Getting started
 
 To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) :confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
@@ -40,8 +101,6 @@ Scan through our [existing issues](https://github.com/github/docs/issues) to fin
 
 Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
 
- <img src="./assets/images/contribution_cta.png" width="300" height="150" />
-
 #### Make changes in a codespace
 
 For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)."
@@ -125,7 +184,7 @@ If you need to commit without running hooks (not recommended):
 git commit --no-verify
 ```
 
-> **Note:** The `no-commit-to-branch` hook prevents direct commits to `main`. Create a feature branch for your changes.
+> **Note:** The `no-commit-to-branch` hook prevents direct commits to `main` and `dev`. Always create a feature branch for your changes (typically branching from `dev`).
 
 ### Commit your update