Add stable CYD firmware, USB calibration wizard and complete setup guide

tools/export_bundle.py

@@ -0,0 +1,58 @@
+"""Export an allowlisted, neutral starter ZIP (never copies local secrets/logs)."""
+import argparse
+from pathlib import Path
+import re
+import zipfile
+
+ROOT = Path(__file__).resolve().parents[1]
+FILES = ['.gitignore', 'README.md', 'AGENTS.md', 'requirements.txt', 'device.example.yaml',
+         'calibration.example.yaml', 'secrets.yaml.example', 'cyd_ui.h', 'LICENSE',
+         'TILE_CONFIGURATION.md', 'CYD_STABILITY.md', 'TEST_RESULTS.md']
+FOLDERS = ['docs', 'tools', 'tests', 'components', 'diagnostics', 'fonts']
+SUFFIXES = {'.py', '.cpp', '.h', '.md', '.ttf', '.txt'}
+
+
+def neutral_base(root):
+    defaults = '\n'.join((root / name).read_text() for name in ['device.example.yaml', 'calibration.example.yaml'])
+    replacements = dict(re.findall(r'^  (\w+): ("[^"\n]*")', defaults, re.M))
+    base = (root / 'home-like-2432s028.yaml').read_text()
+    def replace(match):
+        key = match[1]
+        return f'  {key}: {replacements.get(key, match[2])}'
+    return re.sub(r'^  (\w+): ("[^"\n]*")', replace, base, flags=re.M)
+
+
+def export(root, output):
+    root, output = Path(root).resolve(), Path(output)
+    paths = [root / name for name in FILES]
+    for folder in FOLDERS:
+        for path in (root / folder).rglob('*'):
+            if path.is_file() and '__pycache__' not in path.parts and (path.suffix in SUFFIXES or path.name == 'LICENSE'):
+                paths.append(path)
+    for path in paths:
+        if path.is_symlink() or not path.resolve().is_relative_to(root):
+            raise ValueError(f'Geen bestanden buiten de bronmap of symlinks toegestaan: {path}')
+        if not path.is_file():
+            raise ValueError(f'Ontbrekend bundelbestand: {path}')
+    output.parent.mkdir(parents=True, exist_ok=True)
+    # Exclusive mode refuses to replace a previously delivered bundle.
+    with zipfile.ZipFile(output, 'x', zipfile.ZIP_DEFLATED) as archive:
+        archive.writestr('cyd-display/home-like-2432s028.yaml', neutral_base(root))
+        for path in sorted(set(paths)):
+            archive.write(path, 'cyd-display/' + path.relative_to(root).as_posix())
+    return output
+
+
+def main():
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument('--output', type=Path, default=ROOT / 'dist' / 'cyd-starter.zip')
+    args = parser.parse_args()
+    try:
+        print(f'Deel deze ZIP: {export(ROOT, args.output)}')
+        print('Geen lokale secrets, device.yaml, kalibratiemetingen, logs of firmwarebackups opgenomen.')
+    except (OSError, ValueError) as exc:
+        parser.exit(1, f'Fout: {exc}\n')
+
+
+if __name__ == '__main__':
+    main()