Dev

.github/workflows/build-docs.yml

@@ -28,31 +28,34 @@ jobs:
           echo "VERSION=${VERSION}" >> $GITHUB_ENV
 
       - name: Update package.json version
-        if: github.ref == 'refs/heads/master'
+        if: github.ref_name == 'master'
         working-directory: docs
         run: |
           sed -i "s/\"version\": \".*\"/\"version\": \"${VERSION}\"/" package.json
 
       - name: Update package.json version
-        if: github.ref != 'refs/heads/master'
+        if: startsWith(github.ref_name, 'dev')
         working-directory: docs
         run: |
-          sed -i "s/\"version\": \".*\"/\"version\": \"${VERSION}-dev\"/" package.json
+          TIMESTAMP=$(date +%d%H%M)
+          sed -i "s/\"version\": \".*\"/\"version\": \"${VERSION}-dev.${TIMESTAMP}\"/" package.json
 
       - name: Update example fw branch
-        if: github.ref != 'refs/heads/master'
+        if: startsWith(github.ref_name, 'dev')
         working-directory: firmware/examples
         run: |
-          sed -i 's/@master/@dev/g' *.example.yaml
+          BRANCH_NAME=${{ github.ref_name }}
+          sed -i "s/@master/@${BRANCH_NAME}/g" *.example.yaml
 
       - name: Update docs branch
-        if: github.ref != 'refs/heads/master'
+        if: startsWith(github.ref_name, 'dev')
         working-directory: docs
         run: |
-          sed -i 's/@master/@dev/g' */guide/getting-started.md
-          sed -i 's/master/dev/g' */guide/enclosure/3d-printing.md
-          sed -i 's/@master/@dev/g' */reference/schematics.md
-          sed -i 's/@master/@dev/g' */guide/firmware/minimal.example.yaml
+          BRANCH_NAME=${{ github.ref_name }}
+          sed -i "s/@master/@${BRANCH_NAME}/g" */guide/getting-started.md
+          sed -i "s/master/${BRANCH_NAME}/g" */guide/enclosure/3d-printing.md
+          sed -i "s/@master/@${BRANCH_NAME}/g" */reference/schematics.md
+          sed -i "s/@master/@${BRANCH_NAME}/g" */guide/firmware/minimal.example.yaml
 
       - name: Install dependencies
         working-directory: docs

.github/workflows/build-esphome.yml

@@ -22,6 +22,16 @@ on:
         required: true
         type: string
         default: esp32
+      summary:
+        description: Summary of the release
+        required: false
+        type: string
+        default: Not available
+      url:
+        description: URL of the release
+        required: false
+        type: string
+        default: "https://github.com/AzonInc/Doorman/releases"
 
 jobs:
   prepare:
@@ -49,16 +59,19 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Change ESPHome project version to dev
-        if: github.ref != 'refs/heads/master'
+        if: startsWith(github.ref_name, 'dev')
         run: |
           VERSION=$(awk '/project:/, /version:/' firmware/base.yaml | grep 'version:' | awk '{print $2}' | sed 's/[",]//g')
-          sed -i '/^  project:/,/^  platformio_options:/s/^    version: .*/    version: "'"$VERSION"'-dev"/' firmware/base.yaml
+          TIMESTAMP=$(date +%d%H%M)
+          sed -i '/^  project:/,/^  platformio_options:/s/^    version: .*/    version: "'"$VERSION"'-dev.'"$TIMESTAMP"'"/' firmware/base.yaml
 
-      - uses: esphome/build-action@v4.0.1
+      - uses: esphome/build-action@v6.0.0
         id: esphome-build
         with:
           yaml-file: ${{ matrix.file }}
           version: ${{ inputs.esphome_version }}
+          release-url: ${{ inputs.url }}
+          release-summary: ${{ inputs.summary }}
           complete-manifest: true
 
       - name: Change Manifest Firmware Name

.github/workflows/build-nightly.yaml

@@ -13,22 +13,22 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Compile Stock (ESP32-S3) Firmware
-        uses: esphome/build-action@v4.0.1
+      - name: Build Doorman Stock for Home Assistant (ESP32-S3) Firmware
+        uses: esphome/build-action@v6.0.0
         with:
-          yaml-file: firmware/doorman-stock.yaml
+          yaml-file: firmware/ha-doorman-stock.yaml
           version: latest
           complete-manifest: true
 
-      - name: Compile Nuki Bridge (ES32-S3) Firmware
-        uses: esphome/build-action@v4.0.1
+      - name: Build Doorman Nuki Bridge for Home Assistant (ESP32-S3) Firmware
+        uses: esphome/build-action@v6.0.0
         with:
-          yaml-file: firmware/doorman-nuki-bridge.yaml
+          yaml-file: firmware/ha-doorman-nuki-bridge.yaml
           version: latest
           complete-manifest: true
 
-      - name: Compile Component Test (ESP8266) Firmware
-        uses: esphome/build-action@v4.0.1
+      - name: Build Component Test (ESP8266) Firmware
+        uses: esphome/build-action@v6.0.0
         with:
           yaml-file: firmware/tc-bus-component-8266.yaml
           version: latest

.github/workflows/bundle-assets.yml

@@ -25,27 +25,27 @@ jobs:
 
       - name: Copy interactive BOM
         run: cp pcb/bom/ibom.html output/
-
-      - name: Download Doorman Stock (ESP32-S3) artifact
+        
+      - name: Download Doorman Stock for Home Assistant (ESP32-S3) artifact
         uses: actions/download-artifact@v4
         with:
           name: firmware-doorman-stock
           path: output/firmware/release
 
-      - name: Download Doorman Nuki Bridge (ESP32-S3) artifact
+      - name: Download Doorman Nuki Bridge for Home Assistant (ESP32-S3) artifact
         uses: actions/download-artifact@v4
         with:
           name: firmware-doorman-nuki-bridge
           path: output/firmware/release
 
       - name: Upload Pages artifact
-        if: github.ref == 'refs/heads/master'
+        if: github.ref_name == 'master'
         uses: actions/upload-pages-artifact@v3
         with:
           path: output
 
       - name: Upload Assets Bundle
-        if: github.ref != 'refs/heads/master'
+        if: startsWith(github.ref_name, 'dev')
         uses: actions/upload-artifact@v4
         with:
           name: asset-bundle

.github/workflows/deploy.yml

@@ -24,68 +24,115 @@ jobs:
     name: Build Docs
     uses: ./.github/workflows/build-docs.yml
 
+  prepare-release:
+    runs-on: ubuntu-latest
+    name: Prepare release data
+    outputs:
+      release_summary: ${{ steps.generate-summary.outputs.summary }}
+      release_url: ${{ steps.generate-summary.outputs.url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Generate Release Data
+        id: generate-summary
+        run: |
+          GITHUB_REF_NAME=${{ github.ref_name }}
+          SHA=${{ github.sha }}
+
+          URL="https://doorman.azon.ai/changelog/firmware"
+
+          if [[ "${GITHUB_REF_NAME}" == "master" ]]; then
+            SUMMARY="Kindly review the release notes for further details, as there may be some breaking changes."
+          elif [[ "${GITHUB_REF_NAME}" == dev* ]]; then
+            SUMMARY="Please note this is an experimental update (${GITHUB_REF_NAME}) and may contain unstable features. Details: $(git log -1 --pretty=%B), ${SHA}"
+            URL="https://doorman-dev.surge.sh/changelog/firmware"
+          else
+            SUMMARY=""
+          fi
+
+          # Encode special characters
+          SUMMARY="${SUMMARY//'%'/'%25'}"
+          SUMMARY="${SUMMARY//$'\n'/'%0A'}"
+          SUMMARY="${SUMMARY//$'\r'/'%0D'}"
+
+          echo "url=$URL" >> $GITHUB_OUTPUT
+          echo "summary=$SUMMARY" >> $GITHUB_OUTPUT
 
   # Build stable firmware
   build-doorman-stock-stable-firmware:
-    if: github.ref == 'refs/heads/master'
-    name: Build Doorman Stock (ESP32-S3) Firmware (stable)
+    if: github.ref_name == 'master'
+    name: Build Doorman Stock for Home Assistant (ESP32-S3) Firmware (stable)
     uses: ./.github/workflows/build-esphome.yml
+    needs: prepare-release
     with:
-      files: firmware/doorman-stock.yaml
+      files: firmware/ha-doorman-stock.yaml
       name: AzonInc.Doorman
-      esphome_version: dev
+      esphome_version: latest
       directory_name: doorman-stock
+      summary: ${{ needs.prepare-release.outputs.release_summary }}
+      url: ${{ needs.prepare-release.outputs.release_url }}
 
   build-doorman-nuki-bridge-stable-firmware:
-    if: github.ref == 'refs/heads/master'
-    name: Build Doorman Nuki Bridge (ESP32-S3) Firmware (stable)
+    if: github.ref_name == 'master'
+    name: Build Doorman Nuki Bridge for Home Assistant (ESP32-S3) Firmware (stable)
     uses: ./.github/workflows/build-esphome.yml
+    needs: prepare-release
     with:
-      files: firmware/doorman-nuki-bridge.yaml
+      files: firmware/ha-doorman-nuki-bridge.yaml
       name: AzonInc.Doorman-Nuki-Bridge
-      esphome_version: dev
+      esphome_version: latest
       directory_name: doorman-nuki-bridge
+      summary: ${{ needs.prepare-release.outputs.release_summary }}
+      url: ${{ needs.prepare-release.outputs.release_url }}
 
 
   # Build dev firmware
   build-doorman-stock-dev-firmware:
-    if: github.ref != 'refs/heads/master'
-    name: Build Doorman Stock (ESP32-S3) Firmware (dev)
+    if: startsWith(github.ref_name, 'dev')
+    name: Build Doorman Stock for Home Assistant (ESP32-S3) Firmware (dev)
     uses: ./.github/workflows/build-esphome.yml
+    needs: prepare-release
     with:
-      files: firmware/doorman-stock.dev.yaml
+      files: firmware/ha-doorman-stock.dev.yaml
       name: AzonInc.Doorman
-      esphome_version: dev
+      esphome_version: latest
       directory_name: doorman-stock
+      summary: ${{ needs.prepare-release.outputs.release_summary }}
+      url: ${{ needs.prepare-release.outputs.release_url }}
 
   build-doorman-nuki-bridge-dev-firmware:
-    if: github.ref != 'refs/heads/master'
-    name: Build Doorman Nuki Bridge (ESP32-S3) Firmware (dev)
+    if: startsWith(github.ref_name, 'dev')
+    name: Build Doorman Nuki Bridge for Home Assistant (ESP32-S3) Firmware (dev)
     uses: ./.github/workflows/build-esphome.yml
+    needs: prepare-release
     with:
-      files: firmware/doorman-nuki-bridge.dev.yaml
+      files: firmware/ha-doorman-nuki-bridge.dev.yaml
       name: AzonInc.Doorman-Nuki-Bridge
-      esphome_version: dev
+      esphome_version: latest
       directory_name: doorman-nuki-bridge
-
+      summary: ${{ needs.prepare-release.outputs.release_summary }}
+      url: ${{ needs.prepare-release.outputs.release_url }}
 
   # Bundle all assets for Pages
   bundle-assets-stable:
-    if: github.ref == 'refs/heads/master'
+    if: github.ref_name == 'master'
     name: Create asset bundle (stable)
     uses: ./.github/workflows/bundle-assets.yml
     needs: [build-docs, build-doorman-stock-stable-firmware, build-doorman-nuki-bridge-stable-firmware]
 
   bundle-assets-dev:
-    if: github.ref != 'refs/heads/master'
+    if: startsWith(github.ref_name, 'dev')
     name: Create asset bundle (dev)
     uses: ./.github/workflows/bundle-assets.yml
     needs: [build-docs, build-doorman-stock-dev-firmware, build-doorman-nuki-bridge-dev-firmware]
 
 
   # Deployment job
   deploy-stable:
-    if: github.ref == 'refs/heads/master'
+    if: github.ref_name == 'master'
     name: Deploy to Github Pages (stable)
     environment:
       name: github-pages
@@ -98,7 +145,7 @@ jobs:
         uses: actions/deploy-pages@v4
 
   deploy-dev:
-    if: github.ref != 'refs/heads/master'
+    if: startsWith(github.ref_name, 'dev')
     name: Deploy to surge.sh (dev)
     environment:
       name: surge.sh

.gitignore

@@ -22,4 +22,6 @@ TODOs.md
 *.timestamp-*.mjs
 __pycache__
 .esphome
-/*.yaml
+/*.yaml
+.esphome/
+/secrets.yaml

README.md

@@ -14,7 +14,6 @@ The Doorman S3 isn't limited to these intercoms alone. With its integrated relay
 
 If your intercom isn't a TCS, Koch, Niko, Scantron or Jung model but operates on a 2-wire bus within the 14-24V DC range, you might be able to implement other protocols. Additionally, you can monitor the voltage levels on older intercoms (14-24V), allowing you to trigger specific actions based on the voltage readings.
 
-A big thanks to [PCBWay](https://pcbway.com) for sponsoring this project!
 For more details on the manufacturing process, scroll down to the "Manufacturing" section.
 
 ## 🚀 Getting started
@@ -56,17 +55,13 @@ The repository is organized into the following directories:
 
 ## 🛠️ Manufacturing
 
-<img src=".github/images/pcbway_delivery.png" alt="PCBWay Delivery" height="275">
+<img src=".github/images/pcbx_example.png" alt="PCBX Delivery" height="275">
 
-I was unsure which PCB manufacturer to choose, but fortunately, PCBWay reached out and offered to sponsor the PCB fabrication. I couldn't be happier with the results—the quality is exceptional, especially with the vibrant colors. Everything arrived in pristine condition, and sourcing parts was hassle-free. They even included two extra unpopulated PCBs.
+A huge thanks to [PCBX](https://www.pcbx.com/?mtm_campaign=review&mtm_kwd=BD&mtm_source=flo) for manufacturing and sponsoring 10 awesome PCBs for this project! Your support means a lot to us, and your prices are seriously hard to beat. We're thrilled to have you on board!
 
-I handled the soldering of the ESP modules myself using a heating plate, as I already had ESP32 modules at home.
+If you're looking for a reliable PCB manufacturer for your own project, definitely check out [PCBX](https://www.pcbx.com/?mtm_campaign=review&mtm_kwd=BD&mtm_source=flo). While their production might take a little longer than some others, the unbeatable prices and super-easy part sourcing make it absolutely worth it. They handle everything for you!  
 
-PCBWay made the entire process straightforward and responsive. A special thanks to Liam and Lynne for their support throughout, especially given the numerous changes I made. Their patience and assistance were greatly appreciated.
-
-If you're looking for a reliable, high-quality PCB manufacturer, I highly recommend [PCBWay](https://pcbway.com) :)
-
-You can find all the neccessary files [here](https://github.com/AzonInc/doorman/tree/master/pcb).
+You can find all the necessary files for manufacturing the Doorman-S3 [here](https://github.com/AzonInc/doorman/tree/master/pcb).
 
 ## 🙌 Contributing
 If you'd like to contribute to the Doorman project, we welcome your involvement!\