Merge release v2.0.0

Author: github-actions[bot]

.dockerignore

@@ -1,8 +1,16 @@
+.git
+.github
+.venv
 __pycache__
-*.pyc
-*.pyo
-*.pyd
-.Python
+*.py[cod]
+*.egg-info
+dist
+build
+.mypy_cache
+.ruff_cache
+.pytest_cache
+tests
+docs
+config.ini
+.DS_Store
 .env
-.git
-**/*_test.py

.github/ISSUE_TEMPLATE/issue_report.md

@@ -10,7 +10,7 @@ assignees: []
 <!-- Describe what's happening or what you need help with -->
 
 ## Your setup
-- **Installation method**: <!-- Home Assistant Add-on / Docker / Python / Node-RED -->
+- **Installation method**: <!-- Home Assistant App / Docker / Python -->
 - **Storage system**: <!-- e.g. B2500, Jupiter, Venus + firmware version if known -->
 - **Power meter source**: <!-- e.g. Shelly 3EM, Home Assistant sensor, etc. -->
 

.github/workflows/build-image.yml

@@ -11,11 +11,10 @@ on:
         required: true
         type: string
         description: "Platform to build for (e.g. linux/amd64)"
-      base:
-        required: false
+      cache_scope:
+        required: true
         type: string
-        description: "Base image to use (e.g. distroless, alpine)"
-        default: ""
+        description: "Unique GHA cache scope for this platform/image (avoid matrix collisions)"
       context:
         required: true
         type: string
@@ -57,6 +56,15 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ inputs.registry }}/${{ steps.lower-repo.outputs.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=tag
+            type=ref,event=pr
+            type=sha
+            type=raw,value=next,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}},enable=${{ github.ref_type == 'tag' }}
+            type=semver,pattern={{major}}.{{minor}},enable=${{ github.ref_type == 'tag' }}
+            type=semver,pattern={{major}},enable=${{ github.ref_type == 'tag' }}
           flavor: |
             latest=${{ github.ref == 'refs/heads/main' }}
       - name: Set up Docker Buildx
@@ -71,7 +79,7 @@ jobs:
       - name: Build and push by digest
         id: build
         if: inputs.push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: ${{ inputs.context }}
           platforms: ${{ inputs.platform }}
@@ -81,13 +89,13 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |
             ${{ inputs.build-args }}
-            BASE=${{ inputs.base }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
+            GIT_COMMIT_SHA=${{ github.sha }}
+          cache-from: type=gha,scope=${{ inputs.cache_scope }}
+          cache-to: type=gha,mode=max,scope=${{ inputs.cache_scope }}
       - name: Build (no push)
         id: build-no-push
         if: inputs.push == false
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v6
         with:
           context: ${{ inputs.context }}
           platforms: ${{ inputs.platform }}
@@ -96,9 +104,8 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |
             ${{ inputs.build-args }}
-            BASE=${{ inputs.base }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
+            GIT_COMMIT_SHA=${{ github.sha }}
+          cache-from: type=gha,scope=${{ inputs.cache_scope }}
       - name: Export digest
         if: inputs.push
         run: |
@@ -118,4 +125,4 @@ jobs:
           name: ${{ inputs.digest-prefix }}${{ steps.platform.outputs.name }}
           path: /tmp/digests/*
           if-no-files-found: error
-          retention-days: 1
+          retention-days: 1

.github/workflows/ci.yml

@@ -2,107 +2,166 @@ name: CI Pipeline
 
 on:
   push:
-    branches: [ main ]
+    branches: [ "main", "develop" ]
     tags: [ "*.*.*" ]
   pull_request:
-    branches: [ main ]
+    branches: [ "main", "develop" ]
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 permissions:
-  packages: write
   contents: read
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: uv sync --frozen --extra dev
+
+      - name: Ruff check
+        run: uv run ruff check .
+
+      - name: Ruff format
+        run: uv run ruff format --check .
+
+      - name: Mypy
+        run: uv run mypy src/
+
   validate:
+    needs: [ lint ]
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-suffix: ${{ matrix.python-version }}
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Install mosquitto (for MQTT integration tests)
+        run: sudo apt-get update -qq && sudo apt-get install -y -qq mosquitto
+
       - name: Install dependencies
-        run: |
-          pip install pipenv
-          pipenv install --dev
+        run: uv sync --frozen --extra dev
 
       - name: Run tests
-        run: pipenv run python3 -m pytest --junitxml=test-results.xml
-
-      - name: Validate Python code with flake8
-        run: pipenv run python3 -m flake8 --select BLK **/*.py
+        run: uv run pytest --cov=astrameter --cov-report=xml --junitxml=test-results.xml
 
       - name: Upload test results
+        if: ${{ always() }}
         uses: actions/upload-artifact@v4
         with:
           name: test-results-${{ matrix.python-version }}
           path: test-results.xml
 
+      - name: Upload coverage XML
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.python-version }}
+          path: coverage.xml
+
   build:
+    needs: [ validate ]
+    permissions:
+      contents: read
+      packages: write
     strategy:
       fail-fast: false
       matrix:
         config:
           - platform: linux/amd64
-            base: distroless
-          - platform: linux/arm/v6
-            base: alpine
+            cache_scope: base-linux-amd64
           - platform: linux/arm/v7
-            base: alpine
+            cache_scope: base-linux-arm-v7
           - platform: linux/arm64
-            base: distroless
+            cache_scope: base-linux-arm64
     uses: ./.github/workflows/build-image.yml
     with:
       registry: ghcr.io
       platform: ${{ matrix.config.platform }}
-      base: ${{ matrix.config.base }}
+      cache_scope: ${{ matrix.config.cache_scope }}
       context: .
       dockerfile: ./Dockerfile
       image-suffix: ""
       digest-prefix: "digests-base-"
       push: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
 
   merge:
-    needs: [build]
+    needs: [ build ]
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+    permissions:
+      contents: read
+      packages: write
     uses: ./.github/workflows/merge-manifests.yml
     with:
       registry: ghcr.io
       image-suffix: ""
       digest-prefix: "digests-base-"
+      legacy-image-name: tomquist/b2500-meter
 
   build-addon:
+    needs: [ validate ]
+    permissions:
+      contents: read
+      packages: write
     strategy:
       fail-fast: false
       matrix:
-        platform:
-          - linux/amd64
-          - linux/arm64
-          - linux/arm/v7
-          - linux/arm/v6
+        include:
+          - platform: linux/amd64
+            cache_scope: addon-linux-amd64
+          - platform: linux/arm64
+            cache_scope: addon-linux-arm64
     uses: ./.github/workflows/build-image.yml
     with:
       registry: ghcr.io
       platform: ${{ matrix.platform }}
+      cache_scope: ${{ matrix.cache_scope }}
       context: .
       dockerfile: ./ha_addon/Dockerfile
       build-args: |
-        BUILD_FROM=ghcr.io/hassio-addons/base:14.2.2
+        BUILD_FROM=ghcr.io/hassio-addons/base:17.0.1
       image-suffix: "-addon"
       digest-prefix: "digests-addon-"
       push: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
 
   merge-addon:
-    needs: [build-addon]
+    needs: [ build-addon ]
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+    permissions:
+      contents: read
+      packages: write
     uses: ./.github/workflows/merge-manifests.yml
     with:
       registry: ghcr.io
       image-suffix: "-addon"
-      digest-prefix: "digests-addon-"
+      digest-prefix: "digests-addon-"
+      legacy-image-name: tomquist/b2500-meter

.github/workflows/merge-manifests.yml

@@ -13,6 +13,11 @@ on:
       digest-prefix:
         required: true
         type: string
+      legacy-image-name:
+        required: false
+        type: string
+        default: ""
+        description: "Optional legacy image name (e.g. owner/repo) to publish the same manifest under for backward compatibility"
 
 jobs:
   merge:
@@ -32,11 +37,26 @@ jobs:
       - id: lower-repo
         run: |
           echo "IMAGE_NAME=${GITHUB_REPOSITORY@L}${{ inputs.image-suffix }}" >> $GITHUB_OUTPUT
+          if [ -n "${{ inputs.legacy-image-name }}" ]; then
+            LEGACY_LOWER=$(echo "${{ inputs.legacy-image-name }}" | tr '[:upper:]' '[:lower:]')
+            echo "LEGACY_IMAGE_NAME=${LEGACY_LOWER}${{ inputs.image-suffix }}" >> $GITHUB_OUTPUT
+          fi
       - name: Extract metadata
         id: meta
         uses: docker/metadata-action@v5
         with:
-          images: ${{ inputs.registry }}/${{ steps.lower-repo.outputs.IMAGE_NAME }}
+          images: |
+            ${{ inputs.registry }}/${{ steps.lower-repo.outputs.IMAGE_NAME }}
+            ${{ inputs.legacy-image-name != '' && format('{0}/{1}', inputs.registry, steps.lower-repo.outputs.LEGACY_IMAGE_NAME) || '' }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=tag
+            type=ref,event=pr
+            type=sha
+            type=raw,value=next,enable=${{ github.ref == 'refs/heads/develop' }}
+            type=semver,pattern={{version}},enable=${{ github.ref_type == 'tag' }}
+            type=semver,pattern={{major}}.{{minor}},enable=${{ github.ref_type == 'tag' }}
+            type=semver,pattern={{major}},enable=${{ github.ref_type == 'tag' }}
           flavor: |
             latest=${{ github.ref == 'refs/heads/main' }}
       - name: Log in to Container registry

.gitignore

@@ -1,2 +1,15 @@
 **/__pycache__/*
-.venv
+*.py[cod]
+.venv/
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+test-results.xml
+coverage.xml
+config.ini
+.DS_Store

AGENTS.md

@@ -0,0 +1,32 @@
+# Agent notes
+
+Resolved versions live in **`uv.lock`**. Install dev dependencies the same way CI does:
+
+```bash
+uv sync --extra dev
+```
+
+Before finishing Python changes, run (from repo root, with dev deps):
+
+```bash
+uv run ruff format .
+uv run ruff check .
+uv run mypy src/
+uv run pytest
+```
+
+CI runs the same steps (see `.github/workflows/ci.yml`).
+
+## Changelog
+
+For user-facing work on a branch, keep **one bullet under `## Next`** that summarizes the **overall** outcome of that branch. **Add** it when you first document the change; on **later iterations** on the same branch, **edit that same bullet** if the scope or wording shifts—do **not** append extra bullets for each follow-up. Skip `CHANGELOG.md` entirely when nothing users would notice changes (refactors, tests-only, etc.).
+
+Do **not** expand `CHANGELOG.md` with every internal or tooling-only follow-up. If the branch bullet already states the high-level theme, leave it unless the **user-visible** story changes.
+
+## Adding a powermeter
+
+1. **Implementation** — Add `src/astrameter/powermeter/<module>.py` with a class subclassing `Powermeter`; implement `get_powermeter_watts()` (and `wait_for_message()` only if the base default is wrong for your source).
+2. **Exports** — Import and re-export the class from `src/astrameter/powermeter/__init__.py`.
+3. **Config** — In `src/astrameter/config/config_loader.py`: import the class, define a `*_SECTION` string, add a `section.startswith(...)` branch in `create_powermeter()`, and a `create_*_powermeter()` factory that reads options from the section. `POWER_OFFSET` / `POWER_MULTIPLIER`, `THROTTLE_INTERVAL`, and `NETMASK` are handled globally for any section that returns a powermeter — no extra wiring unless you need something custom.
+4. **Examples, docs & changelog** — Add a commented example to `config.ini.example` and a subsection under **Configuration** in `README.md`, plus one **`## Next`** bullet for the powermeter (add once, then update that bullet on follow-up iterations if needed—see **Changelog** above).
+5. **Tests** — Add `src/astrameter/powermeter/<module>_test.py` (or extend existing tests) and run the commands above before finishing.