- Update CHANGELOG

- Update README
- Add release or debug info to Zigbee FW version
- Fixes from CodeRabbit
- Simplify the cluster definitions and rename them

Signed-off-by: Daniel Kampert <DanielKampert@kampis-elektroecke.de>

Author: Kampi

.github/workflows/firmware.yaml

@@ -9,11 +9,12 @@ env:
 jobs:
   build:
     runs-on: ubuntu-24.04
-    container: ghcr.io/zephyrproject-rtos/ci:latest
+    container: ghcr.io/zephyrproject-rtos/ci:v0.27.4
     strategy:
       matrix:
         built_type: [debug, release]
         board: [beelight@1/nrf54l15/cpuapp]
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -23,8 +24,6 @@ jobs:
 
       - name: Dependencies
         run: |
-          apt-get update && apt-get install -y lbzip2 build-essential cmake pkg-config libsdl2-dev || true
-          apt-get install -f -y
           wget https://sourceforge.net/projects/astyle/files/astyle/astyle%203.4/astyle-3.4.10.tar.bz2/download -O astyle.tar.bz2
           tar -xf astyle.tar.bz2
           cd astyle-3.4.10
@@ -56,9 +55,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 +69,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/upload-artifact@v4.3.3
         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
@@ -227,6 +227,16 @@ jobs:
           name: Log-${{ env.kibot_variant }}
           path: log
 
+      - name: Clean up
+        shell: bash
+        run: |
+          rm -rf "${KICAD_LIBRARY}"
+          find . -type f -iname \*.log -delete
+          find . -type f -iname \*.ogv -delete
+          find . -type f -iname \*.kicad_pro-bak -delete
+          rm ${{ env.kibot_input_dir }}/kibot_*.kicad_pro
+          rm ${{ env.kibot_input_dir }}/kibot_*.kicad_pcb
+
       - name: Upload artifacts (results)
         uses: actions/upload-artifact@v4
         with:
@@ -241,16 +251,6 @@ jobs:
           name: CHANGELOG
           path: ${{ env.kibot_input_dir }}/CHANGELOG.md
 
-      - name: Clean up
-        shell: bash
-        run: |
-          rm -rf "${KICAD_LIBRARY}"
-          find . -type f -iname \*.log -delete
-          find . -type f -iname \*.ogv -delete
-          find . -type f -iname \*.kicad_pro-bak -delete
-          rm ${{ env.kibot_input_dir }}/kibot_*.kicad_pro
-          rm ${{ env.kibot_input_dir }}/kibot_*.kicad_pcb
-
       - name: Pull latest changes
         shell: bash
         run: |
@@ -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,33 +3,31 @@ name: Zigbee-Config
 on:
   workflow_dispatch:
 
+env:
+  root_dir: BeeLight
+
 jobs:
   build:
     runs-on: ubuntu-24.04
-    container: debian:latest
+    container: debian:12
 
     steps:
       - 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 self-upgrade
           ./nrfutil install nrf5sdk-tools
 
       - 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
 
@@ -38,5 +36,5 @@ jobs:
         with:
           name: zigbee-config
           path: |
-            BeeLight/firmware/app/zigbee
+            ${{ env.root_dir }}/firmware/app/zigbee
           if-no-files-found: ignore

README.md

@@ -16,19 +16,19 @@
         - [Using the command line](#using-the-command-line)
     - [Housing](#housing)
     - [Zigbee](#zigbee)
-      - [Standard cluster](#standard-cluster)
+      - [Standard clusters](#standard-clusters)
       - [Custom cluster](#custom-cluster)
       - [Zigbee Dongle](#zigbee-dongle)
       - [Install the device to Zigbee2MQTT](#install-the-device-to-zigbee2mqtt)
   - [Directory structure](#directory-structure)
-  - [Ressources](#ressources)
+  - [Resources](#resources)
   - [Maintainer](#maintainer)
 
 ## About
 
-Open-Source Zigbee-based light and environmental sensor with [Zigbee2MQTT](https://www.zigbee2mqtt.io/) support for your Home Automation with I. e. Home Assistant.
+Open-Source Zigbee-based light and environmental sensor with [Zigbee2MQTT](https://www.zigbee2mqtt.io/) support for your Home Automation (e.g., Home Assistant).
 
-![Rendering](/docs/images/Rendering.png)
+![Rendering](docs/images/Rendering.png)
 
 ### Technical features
 
@@ -43,11 +43,11 @@ Open-Source Zigbee-based light and environmental sensor with [Zigbee2MQTT](https
   - VOC equivalent
   - Light intensity
   - Battery voltage
-- Small housing (40x42 mm)
+- Small housing (40x42x20 mm)
 - Very basic electronic → Can be assembled by hand very easily
 - Zigbee2MQTT compatibility
 
-![Block diagram](/docs/images/Block%20diagram.png)
+![Block diagram](docs/images/Block%20diagram.png)
 
 ## Before you start
 
@@ -62,12 +62,6 @@ west init -l .
 west update
 ```
 
-Run the following commands to install the BSEC2 library:
-
-```sh
-west update
-```
-
 You also need [nrfutil](https://www.nordicsemi.com/Products/Development-tools/nRF-Util) and the `nrf5sdk-tools` to flash the production configuration to the sensor. First install `nrfutil` and then run the following command to install the SDK tools:
 
 ```sh
@@ -105,7 +99,7 @@ west build --build-dir build . --pristine --board beelight@1/nrf54l15/cpuapp --
 You also need a Zigbee network to test and integrate the device. I use [Zigbee2MQTT](https://www.zigbee2mqtt.io/) running on a Raspberry Pi which allows me to connect my Zigbee network with my Home Automation.
 
 > **NOTE**
-> I do not support other Zigbee networks (like [ZHA](https://www.home-assistant.io/integrations/zha/)). The Zigbee standard allows you to connect the device with all other networks but I can´t deliver a functional integration for these networks. You have to do it on your own!
+> I do not support other Zigbee networks (like [ZHA](https://www.home-assistant.io/integrations/zha/)). The Zigbee standard allows you to connect the device with all other networks but I can't deliver a functional integration for these networks. You have to do it on your own!
 
 #### Flash the firmware
 
@@ -147,7 +141,7 @@ The housing is optimized for 3D printing and needs ~12 g of filament (PLA). You
 
 The device uses different standard and custom cluster to report the data to the network.
 
-#### Standard cluster
+#### Standard clusters
 
 | Cluster | ID |
 | ------- | -- |
@@ -158,7 +152,7 @@ The device uses different standard and custom cluster to report the data to the
 
 #### Custom cluster
 
-The device uses two custom cluster to report `IAQ`, `VOC` and `CO2` to the network. Both clusters have three attributes for `value`, `min_value`, `max_value` and `tolerance`.
+The device uses three custom cluster to report `IAQ`, `VOC` and `CO2` to the network. Both clusters have three attributes for `value`, `min_value`, `max_value` and `tolerance`.
 
 | Cluster | ID |
 | ------- | -- |
@@ -180,7 +174,7 @@ Make sure to use a Zigbee 3 compatible dongle like [SONOFF ZBDongle-E](https://s
 #### Install the device to Zigbee2MQTT
 
 > **NOTE**
-> Because it's not possible to use custom cluster with Zigbee2MQTT easily, you must adjust the application directly to use the sensor. Please take a look into the directory `z2m/data/external_converters/example` if you want to check how the modified files look like.
+> Because it's not possible to use custom clusters with Zigbee2MQTT easily, you must adjust the application directly to use the sensor. Please take a look into the directory `z2m/data/external_converters/example` if you want to check how the modified files look like.
 
 1. Download and install [Zigbee2MQTT](https://github.com/zigbee2mqtt/hassio-zigbee2mqtt)
 2. Copy the external converter from `z2m/data_external_converters` to the `data` directory of your `Zigbee2MQTT` installation
@@ -276,18 +270,18 @@ The device can now be connected to your Zigbee network and with this to your Hom
 
 ## Directory structure
 
-- `3d-print`: All 3D print related files
+- `3d-print`: All 3D print.related files
 - `cad`: All relevant 3D models
 - `docs`: All kinds of project documentation like schematics, BOM, etc.
   - `drawings`: 2D drawings for subcomponents, etc.
-  - `images`: All documentation related images
+  - `images`: All documentation-relateBd images
 - `hardware`: KiCad project for the PCB
 - `firmware`: Zephyr project for the device firmware
 - `prebuilt`: Prebuilt binaries
 - `production`: Production files from the latest CI/CD run
-- `z2m`: Zigbee2MQTT related files
+- `z2m`: Zigbee2MQTT-related files
 
-## Ressources
+## Resources
 
 - [Adding new Zigbee2MQTT devices](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html)
 - [Zigbee Cluster Library Specification](https://zigbeealliance.org/wp-content/uploads/2019/12/07-5123-06-zigbee-cluster-library-specification.pdf)
@@ -298,4 +292,3 @@ The device can now be connected to your Zigbee network and with this to your Hom
 ## Maintainer
 
 - [Daniel Kampert](mailto:DanielKampert@kampis-elektroecke.de)
-

docs/BeeLight.drawio

@@ -38,7 +38,7 @@
             <mxPoint y="-22" as="offset" />
           </mxGeometry>
         </mxCell>
-        <mxCell id="nr2zP_MkdF4-R_Vxk9Jf-3" value="BME686" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
+        <mxCell id="nr2zP_MkdF4-R_Vxk9Jf-3" value="BME688" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
           <mxGeometry x="133" y="320" width="107" height="30" as="geometry" />
         </mxCell>
         <mxCell id="nr2zP_MkdF4-R_Vxk9Jf-31" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.449;exitY=1.004;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitPerimeter=0;" parent="1" source="nr2zP_MkdF4-R_Vxk9Jf-6" target="nr2zP_MkdF4-R_Vxk9Jf-29" edge="1">
@@ -51,7 +51,7 @@
             <mxPoint x="-20" y="10" as="offset" />
           </mxGeometry>
         </mxCell>
-        <mxCell id="nr2zP_MkdF4-R_Vxk9Jf-6" value="nRF54L" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
+        <mxCell id="nr2zP_MkdF4-R_Vxk9Jf-6" value="nRF54L15" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
           <mxGeometry x="370" y="180" width="210" height="180" as="geometry" />
         </mxCell>
         <mxCell id="nr2zP_MkdF4-R_Vxk9Jf-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=-0.005;entryY=0.861;entryDx=0;entryDy=0;entryPerimeter=0;startArrow=classic;startFill=1;" parent="1" source="nr2zP_MkdF4-R_Vxk9Jf-3" target="nr2zP_MkdF4-R_Vxk9Jf-6" edge="1">

docs/images/Rendering.png

@@ -0,0 +1,2 @@
+{
+}

firmware/.vscode/settings.json

@@ -4,7 +4,7 @@
 
 **Changed:**
 
-- Switch to nRF SDK v3 and NCS v3
+- Switch to nRF SDK Connect SDK (NCS) v3
 - Switch to ZBOSS R23
 
 **Added:**
@@ -14,7 +14,7 @@
 - Add blocklist to west manifest
 - Add groupfilters to west manifest
 - Add west command to build and flash the device configuration
-- Add custom cluster for VOC, IAQ and CO2 for Zigbee2Mqtt
+- Add custom cluster for VOC, IAQ and CO2 for Zigbee2MQTT
 - Add patches for custom cluster for ncs-zigbee
 
 ## [1.0] - 12.01.2024

firmware/app/CHANGELOG.md

@@ -24,6 +24,7 @@ add_subdirectory(src/events)
 add_subdirectory(src/sensors)
 
 include_directories(src)
+include_directories(src/events)
 
 target_sources(app PRIVATE
                    src/main.c

firmware/app/CMakeLists.txt

@@ -34,16 +34,23 @@
         full-ohms = <(8200 + 2200)>;
         power-gpios = <&gpio2 4 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
     };
+
+    gpio_i2c0: gpio_i2c {
+        status = "okay";
+        compatible = "gpio-i2c";
+        clock-frequency = <I2C_BITRATE_FAST>;
+        sda-gpios = <&gpio2 6 GPIO_OPEN_DRAIN>;
+        scl-gpios = <&gpio0 3 GPIO_OPEN_DRAIN>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+    };
 };
 
 &i2c20 {
-    status = "okay";
-    compatible = "nordic,nrf-twim";
-    clock-frequency = <I2C_BITRATE_FAST>;
-    pinctrl-0 = <&i2c_default>;
-    pinctrl-1 = <&i2c_sleep>;
-    pinctrl-names = "default", "sleep";
+    status = "disabled";
+};
 
+&gpio_i2c0 {
     apds9306: apds9306@52 {
         status = "okay";
         compatible = "avago,apds9306";
@@ -58,4 +65,4 @@
         compatible = "bosch,bme680";
         reg = <0x76>;
     };
-};
+};