Fixes from CodeRabbit

Author: Daniel Kampert

.github/workflows/firmware.yaml

@@ -56,9 +56,11 @@ jobs:
           # It's output to GITHUB_ENV so it can be used in the next steps
           # and only needs to be calculated once.
           BUILD_DIR=${{ matrix.board }}_${{ matrix.built_type }}
-          echo "BUILD_DIR=${BUILD_DIR}" | sed 's/\//_/g' >> "$GITHUB_ENV"
+          echo "BUILD_DIR=${BUILD_DIR}" | sed 's/\//_/g' >> ""${GITHUB_ENV}""
 
       - name: Build firmware
+        env:
+          BUILD_DIR: ${{ env.BUILD_DIR }}
         working-directory: BeeLight/firmware/app
         run: |
           set -e
@@ -68,7 +70,9 @@ jobs:
           if [ -z "$src_hex" ] && [ -f "${{ env.BUILD_DIR }}/zephyr/merged.hex" ]; then src_hex="${{ env.BUILD_DIR }}/zephyr/merged.hex"; fi
           if [ -n "$src_hex" ]; then cp "$src_hex" "fw_images/${{ matrix.built_type }}.hex"; else echo "merged.hex not found, skipping"; fi
 
-      - name : Upload Firmware
+      - name: Upload Firmware
+        env:
+          BUILD_DIR: ${{ env.BUILD_DIR }}
         uses: actions/[email protected]
         with:
           name: ${{ env.BUILD_DIR }}

.github/workflows/pcb.yaml

@@ -62,9 +62,9 @@ jobs:
           last_tag="$(git describe --tags --abbrev=0 || echo "")"
           if [[ "${{ github.ref_type }}" == "tag" ]]; then
             echo "Overriding kibot_variant to 'RELEASED' for tag"
-            echo "kibot_variant=RELEASED" >> $GITHUB_ENV
+            echo "kibot_variant=RELEASED" >> "${GITHUB_ENV}"
           else
-            echo "kibot_variant=${{ env.kibot_variant }}" >> $GITHUB_ENV
+            echo "kibot_variant=${{ env.kibot_variant }}" >> "${GITHUB_ENV}"
           fi
 
       - name: Download updated CHANGELOG
@@ -109,7 +109,7 @@ jobs:
       - name: Initialize
         run: |
           mkdir -p log
-          echo "DATE=$(date +'%Y-%m-%d %H:%M:%S')" >> $GITHUB_ENV
+          echo "DATE=$(date +'%Y-%m-%d %H:%M:%S')" >> "${GITHUB_ENV}"
 
       # Run these changelog update steps only on tag pushes
       - name: Pull latest changes for changelog update
@@ -125,7 +125,7 @@ jobs:
         shell: bash
         run: |
           git clone https://github.com/Kampi/KiCad.git kicad-library
-          echo "KICAD_LIBRARY=$(pwd)/kicad-library" >> "$GITHUB_ENV"
+          echo "KICAD_LIBRARY=$(pwd)/kicad-library" >> "${GITHUB_ENV}"
           pip install defusedxml --break-system-packages
 
       - name: Extract release notes
@@ -163,10 +163,10 @@ jobs:
           if [[ "${{ github.ref_type }}" == "tag" ]]; then
             version_arg="-E REVISION='${last_tag}'"
             echo "Overriding kibot_variant to 'RELEASED' for tag"
-            echo "kibot_variant=RELEASED" >> $GITHUB_ENV
+            echo "kibot_variant=RELEASED" >> "${GITHUB_ENV}"
           else
             version_arg="-E REVISION='${last_tag} + (Unreleased)'"
-            echo "kibot_variant=${{ env.kibot_variant }}" >> $GITHUB_ENV
+            echo "kibot_variant=${{ env.kibot_variant }}" >> "${GITHUB_ENV}"
           fi
 
           # Determine additional_args based on the variant
@@ -186,8 +186,8 @@ jobs:
               ;;
           esac
 
-          echo "version_arg=${version_arg}" >> "$GITHUB_ENV"
-          echo "additional_args=${additional_args}" >> "$GITHUB_ENV"
+          echo "version_arg=${version_arg}" >> "${GITHUB_ENV}"
+          echo "additional_args=${additional_args}" >> "${GITHUB_ENV}"
 
       # Generate notes (skipped for DRAFT variant)
       - name: Generate notes
@@ -285,4 +285,4 @@ jobs:
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: ${{ github.ref_name }}
-          commit_message: Push outputs from CI/CD (${{ env.DATE }})
+          commit_message: Push outputs from CI/CD (${{ github.event.head_commit.timestamp }})

.github/workflows/zigbee.yaml

@@ -3,6 +3,9 @@ name: Zigbee-Config
 on:
   workflow_dispatch:
 
+env:
+  root_dir: BeeLight
+
 jobs:
   build:
     runs-on: ubuntu-24.04
@@ -12,23 +15,19 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          path: BeeLight
+          path: ${{ env.root_dir }}
 
       - name: Dependencies
-        working-directory: BeeLight/firmware/app
+        working-directory: ${{ env.root_dir }}/firmware/app
         run: |
           apt-get update && apt-get install -y curl
           curl https://files.nordicsemi.com/artifactory/swtools/external/nrfutil/executables/x86_64-unknown-linux-gnu/nrfutil -o nrfutil
-
-      - name: Setup
-        working-directory: BeeLight/firmware/app
-        run: |
           mkdir -p zigbee
           chmod +x nrfutil
-          ./nrfutil install nrf5sdk-tools==8.1.0
+          ./nrfutil install nrf5sdk-tools=8.1.0
 
       - name: Generate
-        working-directory: BeeLight/firmware/app
+        working-directory: ${{ env.root_dir }}/firmware/app
         run: |
           ./nrfutil nrf5sdk-tools zigbee production_config zigbee_config.yml zigbee/zigbee_config.hex --offset 0x17a000
 
@@ -37,5 +36,5 @@ jobs:
         with:
           name: zigbee-config
           path: |
-            BeeLight/firmware/app/zigbee
+            ${{ env.root_dir }}/firmware/app/zigbee
           if-no-files-found: ignore

firmware/app/scripts/astyle_format_west_command.py

@@ -5,6 +5,7 @@
 
 import os
 import sys
+import shutil
 import subprocess
 
 from west.commands import WestCommand
@@ -32,6 +33,9 @@ def do_add_parser(self, parser_adder):
 
     def do_run(self, args, _unknown_args):
         astyle_args = ["astyle"]
+        if(shutil.which("astyle") is None):
+            print("ERROR: 'astyle' not found in PATH", file = sys.stderr)
+            return 127
 
         if(args.dry_run):
             astyle_args.append("--dry-run")

hardware/BeeLight.kicad_pro

@@ -466,6 +466,7 @@
       "single_global_label": "ignore",
       "unannotated": "error",
       "unconnected_wire_endpoint": "warning",
+      "undefined_netclass": "error",
       "unit_value_mismatch": "error",
       "unresolved_variable": "error",
       "wire_dangling": "error"

hardware/kibot_resources/scripts/docker_kibot_linux.sh

@@ -17,9 +17,9 @@ docker run --rm -it \
     --volume="/home/$USER_NAME:/home/$USER_NAME:rw" \
     --entrypoint /bin/bash \
     "$IMAGE" -c "
-    if ! id $USER_NAME &>/dev/null; then
-        echo \"Creating user $USER_NAME ($USER_ID:$GROUP_ID)...\"
-        useradd -u $USER_ID -g $GROUP_ID -d /home/$USER_NAME -m $USER_NAME
-        chown -R $USER_ID:$GROUP_ID /home/$USER_NAME
+    if ! id '$USER_NAME' >/dev/null 2>&1; then
+        echo \"Creating user '$USER_NAME' ('$USER_ID':'$GROUP_ID')...\"
+        useradd -u '$USER_ID' -g '$GROUP_ID' -d '/home/$USER_NAME' -m '$USER_NAME'
+        chown -R '$USER_ID':'$GROUP_ID' '/home/$USER_NAME'
     fi
-    exec su - $USER_NAME"
+    exec su - '$USER_NAME'"

hardware/kibot_resources/scripts/get_changelog.py

@@ -1,10 +1,10 @@
-import argparse
 import re
 import sys
+import argparse
 
 def parse_changelog(file_path, version, title_only, extra_spaces, separators):
     try:
-        with open(file_path, 'r') as f:
+        with open(file_path, "r") as f:
             changelog = f.read()
     except FileNotFoundError:
         print(f"Error: File '{file_path}' not found.")
@@ -14,22 +14,21 @@ def parse_changelog(file_path, version, title_only, extra_spaces, separators):
     version_pattern = re.compile(rf"## \[{version}\] - (\d{{4}}-\d{{2}}-\d{{2}})\n(.*?)(?=## \[|\[Unreleased\]:|\[\d+\.\d+\.\d+\]:|$)", re.DOTALL)
     match = version_pattern.search(changelog)
 
-    if not match:
+    if(not match):
         print(f"Version {version} not found.")
-        sys.exit(1)
+        return
 
     date, content = match.groups()
 
-    if title_only:
+    if(title_only):
         print(f"Version {version} - {date}")
     else:
-
-        if separators is not None:
+        if(separators is not None):
             content = re.sub(r'^(###.*?)$', '_' * separators + r'\n\1', content, flags=re.MULTILINE)
 
         cleaned_content = re.sub(r'### ', '', content)  # Remove ###
 
-        if extra_spaces:
+        if(extra_spaces):
             cleaned_content = re.sub(r'(?<!\n)\n(?!\n)', '\n\n', cleaned_content)
 
         print(cleaned_content)

hardware/kibot_resources/scripts/get_changelog_version.py

@@ -4,21 +4,21 @@
 
 def get_last_version(file_path):
     try:
-        with open(file_path, 'r') as file:
+        with open(file_path, "r") as file:
             content = file.read()
 
         # Regex to match version entries
         version_pattern = r"## \[(.*?)\]"
         versions = re.findall(version_pattern, content)
 
-        if not versions:
+        if(not versions):
             return "N/A"
 
         # Check the last entry
         last_version = versions[0]  # First match is the most recent
 
-        if last_version.lower() == "unreleased":
-            if len(versions) > 1:
+        if(last_version.lower() == "unreleased"):
+            if(len(versions) > 1):
                 second_last_version = versions[1]
                 return f"{second_last_version}+ (Unreleased)"
             else:
@@ -27,10 +27,10 @@ def get_last_version(file_path):
             return last_version
 
     except FileNotFoundError:
-        print(f"Error: File '{file_path}' not found.", file=sys.stderr)
+        print(f"Error: File '{file_path}' not found.", file = sys.stderr)
         sys.exit(1)
     except (IOError, OSError) as e:
-        print(f"Error: An error occurred: {e}", file=sys.stderr)
+        print(f"Error: An error occurred: {e}", file = sys.stderr)
         sys.exit(1)
 
 if(__name__ == "__main__"):

hardware/kibot_resources/scripts/get_sheet_title.py

@@ -11,16 +11,16 @@ def get_sheet_title(file_path, page_number, dots_number):
 
         for sheet in root.findall(".//sheet"):
             number = sheet.get("number")
-            if number == page_number:
+            if(number == page_number):
                 # Get the last part of the 'name' attribute after '/'
                 name = sheet.get("name")
-                if name:
+                if(name):
                     titles.append(name.split("/")[-2 if name.endswith("/") else -1])
 
-        if not titles:
+        if(not titles):
             print('.'*dots_number)
 
-        elif len(set(titles)) > 1:
+        elif(len(set(titles)) > 1):
             print("Conflicting page numbers")
         else:
             print(titles[0])
@@ -31,7 +31,6 @@ def get_sheet_title(file_path, page_number, dots_number):
     except Exception as e:
         print(f"Error: {e}")
 
-
 def main():
     parser = argparse.ArgumentParser(description = "Get the sheet title based on page number from a KiCad XML file")
     parser.add_argument("-p", "--page-number", type = int, required = True, help = "Page number to search")