orisys-sdk/examples/README.md

Examples

Product-facing demos live under examples/products/. Shared helpers stay in pipeline/, viz/, and gui/. Run commands from the repository root.

Product Entry Points

Product	Entry	Default config
ORY-BOX	products/ory_box/basic_pipeline.py	ddjx01
ORY-MINI	products/ory_mini/basic_pipeline.py	mini
ORY-FINGER (2D)	products/ory_finger/finger_pipeline.py	dd02
ORY-FINGER (3D Qt)	products/ory_finger/finger_pipeline_3dview.py	dd02

dd02 is the stable ORY-FINGER alias and currently resolves to dd02-ov.

Compatibility wrappers still exist at the examples/ root (basic_pipeline.py, finger_pipeline.py, finger_pipeline_3dview.py) and forward to the product entries above.

Typical Usage

ORY-BOX:

python examples/products/ory_box/basic_pipeline.py -v 0 -c ddjx01

ORY-MINI:

python examples/products/ory_mini/basic_pipeline.py -v 0 -c mini

ORY-FINGER 2D:

python examples/products/ory_finger/finger_pipeline.py --camera_id 0 --config dd02

ORY-FINGER video file:

python examples/products/ory_finger/finger_pipeline.py --video ./data/sample.mp4 --config dd02

ORY-FINGER 3D Qt dashboard:

pip install -e ".[gui]"
python examples/products/ory_finger/finger_pipeline_3dview.py --video 0 --config dd02

Other Root Examples

• plot_data.py — single-sensor OpenCV views plus PyQtGraph force charts
• two_sensor_pipeline.py — two-sensor multiprocessing demo

Requirements

• SDK installed from the repository root, for example pip install -e .
• camera index or test video path
• matching config names under ./config/ (or packaged orisys/configs/)

Qt / PyQtGraph examples additionally require:

pip install -e ".[gui]"

Notes

• products/ory_finger/finger_pipeline_3dview.py is the main interactive finger demo. It uses gui/app_paths.py so the same entry works in editable and packaged runs.
• Dashboard controls: click 启动 to start acquisition; use Record CSV / Stop CSV and the CSV save-directory browser to log contact/force data; Q quits, R resets, S starts video recording, E stops video recording, and Esc toggles fullscreen.
• products/ory_finger/finger_pipeline.py is the leanest finger example if you want to validate UV unroll + force/contact processing without the full dashboard.