ykcheungab
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
# orisys-app
|
|
|
|
Desktop applications that consume the Orisys SDK.
|
|
|
|
| App | Status |
|
|
|-----|--------|
|
|
| `apps/customer` | Scaffold shell (theme / locale / prefs / logging) |
|
|
| `apps/internal` | Stub for future calibration & automated testing |
|
|
|
|
## Layout
|
|
|
|
- `shared/` — common paths, prefs, theme, i18n, logging
|
|
- `apps/customer/config/` — locales, default prefs, editable `sensors/` copies
|
|
- `apps/customer/outputs/` — generated logs and calibration exports (gitignored)
|
|
- `build/` — Windows PyInstaller packaging (`build/customer/build.ps1`)
|
|
|
|
## Run (customer shell)
|
|
|
|
```powershell
|
|
cd D:\repo\orisys-app
|
|
python -m pip install -e .\shared -e .\apps\customer
|
|
python .\apps\customer\run.py
|
|
```
|
|
|
|
Or without install:
|
|
|
|
```powershell
|
|
$env:PYTHONPATH = "D:\repo\orisys-app\shared\src;D:\repo\orisys-app\apps\customer\src"
|
|
python D:\repo\orisys-app\apps\customer\run.py
|
|
```
|
|
|
|
## Branding
|
|
|
|
Window / EXE icon: `shared/resources/branding/logo.png`
|
|
Top bar / About: `shared/resources/branding/logo_topbar.png`
|
|
|
|
Dark mode is the default. Logos currently sit on a black tile; a transparent (or light) variant may be needed for polished light mode later.
|
|
|
|
## Versioning
|
|
|
|
- **Customer app version** (`orisys_customer.__version__`) — shown in Help → About and used for releases.
|
|
- **Shared package version** (`orisys_app_shared.__version__`) — internal library version.
|
|
- **Shared API** (`orisys_app_shared.API_VERSION`) — compatibility tag. Customer declares `REQUIRES_SHARED_API`; startup logs a warning on mismatch.
|
|
|
|
## Deferred
|
|
|
|
Run/Stop pipeline, arrow/force plots, units, calibration capture, Open3D finger mesh, sync-from-wheel for `config/sensors`, PyInstaller packaging, and the internal app.
|