OLO Documentation

OLO connects ROS 2 robots to a browser-based development experience and provides typed Python and TypeScript libraries for robot programs. This site is the canonical guide to the OLO Platform, the robot-side Appliance, and SDK v2.

Start here

• Getting Started
  • Portal and managed simulation
  • Physical robot or local ROS 2 environment
  • SDK v2 connection check
  • Before motion
• OLO Platform
  • Two channels
  • Platform authentication
  • How scripts run
• OLO Appliance
  • Installation choices
  • Registration and identity
  • ROS 2 configuration
  • SDK v2
  • Platform management is separate
• ROS 2 Concepts for OLO
  • Nodes, topics, services, and actions
  • Domains and discovery
  • Frames and transforms
  • MoveIt and Nav2
  • Simulation time

SDK v2

• Quickstart
  • SDK modules
  • Client
  • Robot namespaces
  • Example usage
• Robot Namespaces
  • Capability handles
  • Default namespace resolution
  • Explicit namespace selection
  • Service-specific handles
  • Core topic and node names
  • Robot TF frames
  • Low-level calls
  • Listing namespaces
• API Reference
  • Client
  • Core
  • Spatial
  • Kinematics
  • Locomotion
  • Navigation
  • Vision
  • AI
  • Local archive
  • Platform
  • Errors
  • TypeScript API

Examples

• Core
  • Topic listing and robot namespaces
  • Publishing messages
  • Subscribing to messages
  • Service discovery and invocation
• Spatial
  • Individual transform lookup
  • Transform tree inspection
  • Spatial Type Construction
  • Composition and Inverses
• Kinematics
  • Robot model, joints, and pose
  • Move to joint targets
  • Move to end-effector poses
  • Move along linear paths
  • Trajectory speed scaling
  • Plan with multiple groups
  • Gripper operations
• Locomotion
  • Local locomotion
  • Velocity streaming
• Navigation
  • Simple navigation
  • Localization with a saved map
  • Inspect the map and navigate to a reachable goal
• Vision
  • Depth camera helpers
  • Point tracking pick loop
• AI
  • Object detection
  • Streaming RGB detection
  • Streaming RGB-D detection
• Archive
  • Local image and video archive
  • Local rosbag recording
  • Cloud archive catalog

Previous SDK

• Migrate from SDK v1
• SDK v1 Archive