Refactoring and new Features

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.13"
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run local validation
+        run: python scripts/check_all.py
+
+      - name: Check pull request diff whitespace
+        if: github.event_name == 'pull_request'
+        run: git diff --check "origin/${{ github.base_ref }}...HEAD"

.github/workflows/compat.yml

@@ -0,0 +1,31 @@
+name: Klipper And Kalico Compatibility
+
+on:
+  schedule:
+    - cron: "17 4 * * 1"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  firmware-contract:
+    name: Firmware contracts
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Check repository
+        run: python scripts/check_all.py
+
+      - name: Check firmware contracts
+        run: python scripts/check_firmware_compat.py

.github/workflows/release.yml

@@ -0,0 +1,174 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Existing tag to draft, for example v1.2.0"
+        required: true
+        type: string
+      channel:
+        description: "Expected release channel"
+        required: true
+        default: "stable"
+        type: choice
+        options:
+          - stable
+          - beta
+
+permissions:
+  contents: read
+
+jobs:
+  validate-release-ref:
+    name: Validate release ref
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.release.outputs.tag }}
+      version: ${{ steps.release.outputs.version }}
+      channel: ${{ steps.release.outputs.channel }}
+      prerelease: ${{ steps.release.outputs.prerelease }}
+      title: ${{ steps.release.outputs.title }}
+    env:
+      RELEASE_TAG: ${{ github.event_name == 'workflow_dispatch' && inputs.tag || github.ref_name }}
+      RELEASE_CHANNEL: ${{ github.event_name == 'workflow_dispatch' && inputs.channel || '' }}
+
+    steps:
+      - name: Validate release metadata
+        id: release
+        run: |
+          stable_re='^v([0-9]+\.[0-9]+\.[0-9]+)$'
+          beta_re='^v([0-9]+\.[0-9]+\.[0-9]+-beta\.[0-9]+)$'
+
+          if [[ "$RELEASE_TAG" =~ $stable_re ]]; then
+              version="${BASH_REMATCH[1]}"
+              channel="stable"
+              prerelease="false"
+          elif [[ "$RELEASE_TAG" =~ $beta_re ]]; then
+              version="${BASH_REMATCH[1]}"
+              channel="beta"
+              prerelease="true"
+          else
+              echo "invalid release tag '$RELEASE_TAG'; expected vX.Y.Z or vX.Y.Z-beta.N" >&2
+              exit 1
+          fi
+
+          if [ -n "$RELEASE_CHANNEL" ] \
+             && [ "$channel" != "$RELEASE_CHANNEL" ]; then
+              echo "tag $RELEASE_TAG is $channel, not $RELEASE_CHANNEL" >&2
+              exit 1
+          fi
+
+          {
+              echo "tag=$RELEASE_TAG"
+              echo "version=$version"
+              echo "channel=$channel"
+              echo "prerelease=$prerelease"
+              echo "title=$RELEASE_TAG"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Verify tag exists
+        env:
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ steps.release.outputs.tag }}
+        run: gh api --silent "repos/${GITHUB_REPOSITORY}/git/ref/tags/${TAG}"
+
+  validate-source:
+    name: Validate source and build archive
+    runs-on: ubuntu-latest
+    needs:
+      - validate-release-ref
+    env:
+      RELEASE_VERSION: ${{ needs.validate-release-ref.outputs.version }}
+
+    steps:
+      - name: Check out release tag
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10  # actions/checkout@v6.0.3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+          ref: refs/tags/${{ needs.validate-release-ref.outputs.tag }}
+
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # actions/setup-python@v6.2.0
+        with:
+          python-version: "3.13"
+
+      - name: Run local validation
+        run: python scripts/check_all.py
+
+      - name: Build source archive
+        run: |
+          mkdir -p dist
+          archive="dist/klipper_z_calibration-${RELEASE_VERSION}.tar.gz"
+          git archive \
+              --format=tar.gz \
+              --prefix="klipper_z_calibration-${RELEASE_VERSION}/" \
+              --output="$archive" \
+              HEAD
+
+      - name: Upload release archive
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # actions/upload-artifact@v7.0.1
+        with:
+          name: release-archive
+          path: dist/klipper_z_calibration-${{ env.RELEASE_VERSION }}.tar.gz
+          if-no-files-found: error
+          retention-days: 1
+
+  draft-release:
+    name: Draft release
+    runs-on: ubuntu-latest
+    needs:
+      - validate-release-ref
+      - validate-source
+    environment: release
+    permissions:
+      contents: write
+    env:
+      PRERELEASE: ${{ needs.validate-release-ref.outputs.prerelease }}
+      RELEASE_TAG: ${{ needs.validate-release-ref.outputs.tag }}
+      RELEASE_TITLE: ${{ needs.validate-release-ref.outputs.title }}
+
+    steps:
+      - name: Download release archive
+        uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3  # actions/download-artifact@v8.0.0
+        with:
+          name: release-archive
+          path: dist
+
+      - name: Create or update draft GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          if gh release view "$RELEASE_TAG" >/dev/null 2>&1; then
+              release_api="repos/${GITHUB_REPOSITORY}/releases/tags/${RELEASE_TAG}"
+              release_id="$(gh api "$release_api" --jq '.id')"
+              is_draft="$(gh api "$release_api" --jq '.draft')"
+              if [ "$is_draft" != "true" ]; then
+                  echo "Release $RELEASE_TAG already exists and is not a draft" >&2
+                  exit 1
+              fi
+              gh api --method PATCH \
+                  "repos/${GITHUB_REPOSITORY}/releases/${release_id}" \
+                  -F draft=true \
+                  -F prerelease="$PRERELEASE" \
+                  -F name="$RELEASE_TITLE" >/dev/null
+              gh release upload "$RELEASE_TAG" dist/*.tar.gz --clobber
+              exit 0
+          fi
+
+          create_args=(
+              release create "$RELEASE_TAG"
+              dist/*.tar.gz
+              --draft
+              --verify-tag
+              --title "$RELEASE_TITLE"
+              --generate-notes
+          )
+          if [ "$PRERELEASE" = "true" ]; then
+              create_args+=(--prerelease)
+          fi
+          gh "${create_args[@]}"

.gitignore

@@ -0,0 +1,24 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+.pytest_cache/
+.coverage
+htmlcov/
+
+.mypy_cache/
+.ruff_cache/
+
+.venv/
+venv/
+env/
+
+.idea/
+.vscode/
+*.swp
+*~
+.codex/
+.agents/
+.compat_repos/
+
+.DS_Store