Skip to main content

Lightwheel SDK

Welcome to the Lightwheel SDK documentation. The Lightwheel SDK is a Python library that provides easy access to the Lightwheel platform's resources, including 3D objects, floorplans, and scene configurations.

Overview​

The Lightwheel SDK simplifies the process of integrating Lightwheel's robotics and simulation assets into your projects. It provides:

  • Authentication Management - Secure login and session handling
  • Object Loading - Access to 3D objects from the Lightwheel registry
  • Floorplan Loading - Load and configure environment layouts
  • Scene Loading - Retrieve pre-configured simulation scenes
  • CLI Tools - Command-line interface for quick operations
  • Flexible Configuration - Environment-based and programmatic configuration options

Key Features​

  • 🔐 Secure Authentication - Token-based authentication with automatic session management
  • 📦 Asset Management - Easy access to objects, floorplans, and scenes
  • ⚡ Asynchronous Loading - Efficient resource loading with async support
  • 🔧 Flexible Configuration - Configure via environment variables or code
  • 📊 Comprehensive Logging - Built-in logging for debugging and monitoring
  • 🖥️ CLI Interface - Command-line tools for common operations
  • 🐍 Python Native - Built for Python 3.10+

Quick Example​

from lightwheel_sdk.loader import (
    login_manager,
    object_loader,
    floorplan_loader,
    scene_loader
)

# Load an object
file_path, object_name, metadata = object_loader.acquire_by_registry(
    registry_type="objects",
    registry_name=["apple"],
    file_type="USD"
)

# Load a floorplan
usd_path_future = floorplan_loader.acquire_usd(
    scene="robocasakitchen",
    layout_id=1,
    style_id=1
)

Getting Started​

Follow these steps to get started with the Lightwheel SDK:

  1. Install - Install the SDK using pip
  2. Quick Start - Get up and running in minutes
  3. Authentication - Learn about authentication options
  4. Configuration - Configure the SDK for your needs

Documentation Sections​

Getting Started Guide​

Loaders​

Reference​

  • Client - Client and authentication management
  • Exception - Exception classes and error handling
  • Logging - Configure logging for debugging and monitoring

Support​

For issues, questions, or contributions, please refer to the project repository or contact the Lightwheel team.

Requirements​

  • Python 3.10 or higher
  • pip package manager

License​

The Lightwheel SDK is provided as part of the Lightwheel platform. Please refer to the platform's license terms for usage details.