sensor-bench/build/README.md

Sensor Bench EXE Build

This folder contains the Windows PyInstaller build setup for Sensor Bench.

Requirements

• Windows x64
• Anaconda or Miniconda available as conda
• Python 3.10 build environment
• Internet access to install orisys from PyPI

The build installs orisys from PyPI. Do not use PYTHONPATH or an editable orisys-sdk checkout for release builds.

Build

From the repository root (cmd or PowerShell):

.\build\create_env.bat
.\build\build_exe.bat

The .bat wrappers bypass the local PowerShell execution policy. If you prefer calling PowerShell directly:

powershell -NoProfile -ExecutionPolicy Bypass -File .\build\create_env.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File .\build\build_exe.ps1

Output:

dist/SensorBench/SensorBench.exe

The build is onedir rather than onefile so startup is faster and bundled DLL/resource issues are easier to diagnose.

Validation

The build script runs:

python tests/test_smoke.py
python build/verify_dist.py

Manual hardware check:

1. Run dist\SensorBench\SensorBench.exe.
2. Confirm the UI opens without setting PYTHONPATH.
3. Confirm the UI defaults to Simplified Chinese and can switch to English.
4. Confirm Orisys status is available and fixed mode shows DDJX01.
5. Use Next / Revert / New Sample Reset on the left workflow panel.
6. Start preview with camera index 0.
7. Confirm raw preview and processed preview update.
8. Record a short clip and verify it appears under dist\SensorBench\recordings.

Locale files are bundled under _internal/config/locales/ (and can also be placed beside the EXE under config/locales/ for overrides). Edit those JSON files to change operator-facing text without rebuilding.