Neumann Control: the app's code

.cargo/mutants.toml

@@ -0,0 +1,18 @@
+# cargo-mutants: `cargo mutants --workspace` (see README, "Building from source").
+exclude_globs = [
+    # Test infrastructure; its own faults show up as failing tests elsewhere.
+    "crates/core/src/simulator/**",
+    # Drawing code: a moved pixel survives every test by design, which would bury real gaps.
+    "crates/app/src/views/**",
+    "crates/app/src/ui_kit/**",
+    "crates/app/src/main.rs",
+    # The manual generator only runs in the release build, which fails on a broken manual.
+    "crates/manual/src/main.rs",
+]
+# Windows' browser and WinHTTP: no test may start one or go online.
+exclude_re = ["windows_help"]
+# nextest runs the tests of all test binaries at once and stops at the first failure; the
+# tests themselves are short, run one binary after another they were most of a mutant's time.
+test_tool = "nextest"
+# Kittests wait on real sockets; a slow mutant is not a caught one.
+timeout_multiplier = 3.0

.config/nextest.toml

@@ -0,0 +1,4 @@
+# A mutation run only needs to know whether some test fails: the first failure ends the run and
+# stops the tests still running (`NEXTEST_PROFILE=mutants`, see README "Building from source").
+[profile.mutants]
+fail-fast = { max-fail = 1, terminate = "immediate" }

.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.ttf binary

.github/ISSUE_TEMPLATE/new-model.yml

@@ -0,0 +1,35 @@
+name: Support for another model
+description: Send the Full scan of a speaker the app only reads, so it can learn to write it.
+title: "Support for <model>"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        On the **Device** tab of the speaker's device panel, press **Full scan**. It
+        writes `scan-<model>-<firmware>-<date>-<time>.json` and `.txt` next to the executable,
+        without serial number, MAC address, the speaker's name or any network address.
+  - type: input
+    id: model
+    attributes:
+      label: Model
+      placeholder: KH 80
+    validations:
+      required: true
+  - type: input
+    id: firmware
+    attributes:
+      label: Firmware version
+    validations:
+      required: true
+  - type: textarea
+    id: scan
+    attributes:
+      label: Full scan files
+      description: Drag both scan files (.json and .txt) into this field.
+    validations:
+      required: true
+  - type: textarea
+    id: notes
+    attributes:
+      label: Anything else
+      description: Settings you would like to change, or what differs from the KH 120 II.

.github/dependabot.yml

@@ -0,0 +1,17 @@
+# Monthly, grouped: one PR per ecosystem. CI on pull_request tests each bump.
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      actions:
+        patterns: ["*"]
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      cargo:
+        patterns: ["*"]

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+# One pipeline: CI runs the same check.ps1 as the pre-push hook.
+# `branches` and `branches-ignore` must never both appear on one event.
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    runs-on: windows-latest
+    # A cold cache once hit 45 minutes.
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v7
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: .
+      # Prebuilt and checksum-verified: building cargo-audit from source took
+      # about 11 minutes per run and pushed cold-cache runs past the timeout.
+      # Only cargo-audit is unpinned: Dependabot does not update tool
+      # versions here, and an outdated cargo-audit can fail on a newer
+      # advisory database.
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-about@0.9,cargo-audit
+      - run: ./check.ps1
+        shell: pwsh
+      - run: cargo build --release --locked -p neumann-control-app
+      - uses: actions/upload-artifact@v7
+        with:
+          name: neumann-control-exe
+          path: target/release/neumann-control.exe

.github/workflows/release.yml

@@ -0,0 +1,59 @@
+# A tag v<version> on main builds the release on a clean runner and attaches it to a draft
+# GitHub release; publishing the draft stays a manual step.
+name: release
+
+on:
+  push:
+    tags: ['v*']
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: windows-latest
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          # The whole history: the tag must be proven to lie on main.
+          fetch-depth: 0
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt, clippy
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: .
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: cargo-about@0.9,cargo-audit
+      - name: Tag, main and version agree
+        shell: pwsh
+        run: |
+          $tag = '${{ github.ref_name }}'
+          $manifest = Get-Content Cargo.toml -Raw
+          if ($manifest -notmatch '(?s)\[workspace\.package\][^\[]*?\nversion = "([^"]+)"') {
+            throw 'no [workspace.package] version in Cargo.toml'
+          }
+          $version = $Matches[1]
+          if ($tag -ne "v$version") { throw "tag $tag does not match version $version" }
+          git merge-base --is-ancestor HEAD origin/main
+          if ($LASTEXITCODE -ne 0) { throw "tag $tag is not on main" }
+          "VERSION=$version" >> $env:GITHUB_ENV
+      - name: Release notes from the CHANGELOG
+        shell: pwsh
+        run: ./release-notes.ps1 -Version $env:VERSION -OutFile "$env:RUNNER_TEMP/release-notes.md"
+      # The gate and the build, as locally; the version stays the tag's.
+      - name: Build the release folder
+        shell: pwsh
+        run: ./build-release.ps1 -KeepVersion
+      - name: Draft the GitHub release
+        shell: pwsh
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          $folder = "release/neumann-control-$env:VERSION"
+          Compress-Archive -Path $folder -DestinationPath "release/neumann-control-$env:VERSION.zip"
+          gh release create '${{ github.ref_name }}' --draft --verify-tag `
+            --title "Neumann Control $env:VERSION" --notes-file "$env:RUNNER_TEMP/release-notes.md" `
+            "release/neumann-control-$env:VERSION.zip" "$folder/SHA256SUMS"

.gitignore

@@ -0,0 +1,3 @@
+/target
+/release
+/mutants.out*/