Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.17 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.17 KB

Viam Visualization

3D visualization interface for spatial data using Viam's APIs — frame systems, geometries, point clouds, drawings — for motion-related monitoring, testing, and debugging.

Documentation

📚 viamrobotics.github.io/visualization is our guide to a few popular use cases. It covers:

Quick start

make setup     # one-time: install Node 22, pnpm, Go, buf, project deps
make up        # http://localhost:5173

For manual setup, machine configs, multiple instances, and troubleshooting see the local-usage guide.

Contributing

Run the dev server with HMR:

pnpm dev

See CLAUDE.md for contributor conventions.

Desktop app

The visualizer also builds as a desktop app with Tauri v2. It wraps the same static build the browser gets and does not bundle the Go draw server, so the draw-service panel reads offline until make up starts one. You need the Tauri system dependencies and Rust 1.90 or newer.

pnpm tauri:dev     # dev server in a native window, with HMR
pnpm tauri:build   # .app and .dmg under src-tauri/target/release/bundle/

The bundle version follows version in package.json.

Programmatic camera control

The visualizer exposes a cameraControls object on window. Open the browser console and call methods on it to move the camera or tweak its settings at runtime. Full API: https://github.com/yomotsu/camera-controls#properties.