README
¶
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:
- Running locally — set up the app and drive it from Go via
client/api. - Embedding
<Visualizer />— drop the visualizer into your own Svelte app. - Implementing WorldStateStoreService — produce
Transforms for a Viam WorldStateStoreService module withdraw. - A live playground rendering a snapshot.
Quick start
make setup # one-time: install Node 22, pnpm, bun, 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.
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package client is the legacy v1 drawing client for motion-tools.
|
Package client is the legacy v1 drawing client for motion-tools. |
|
api
Package api provides high-level drawing functions for the motion-tools visualizer.
|
Package api provides high-level drawing functions for the motion-tools visualizer. |
|
colorutil
Package colorutil maps CSS/SVG color names to hex and RGB for the legacy v1 client.
|
Package colorutil maps CSS/SVG color names to hex and RGB for the legacy v1 client. |
|
server
Package server provides an embeddable Connect-RPC draw server.
|
Package server provides an embeddable Connect-RPC draw server. |
|
shapes
Package shapes provides NURBS sample data for the legacy v1 drawing client.
|
Package shapes provides NURBS sample data for the legacy v1 drawing client. |
|
cmd
|
|
|
draw-server
command
|
|
|
docs
|
|
|
examples/basic
command
Package main is a small standalone example that exercises the motion-tools client/api package.
|
Package main is a small standalone example that exercises the motion-tools client/api package. |
|
examples/snapshot
command
Package main generates the snapshot fixture used by the docs playground.
|
Package main generates the snapshot fixture used by the docs playground. |
|
Package draw provides a Go API for building 3D scenes for the motion-tools visualizer.
|
Package draw provides a Go API for building 3D scenes for the motion-tools visualizer. |
|
Package mutils contains utilities for motion tools.
|
Package mutils contains utilities for motion tools. |
Click to show internal directories.
Click to hide internal directories.