LuckyRobots Documentation

Hyperrealistic robotics simulation framework with Python API for embodied AI training and testing.

Quick Start

Installation:

pip install luckyrobots

Basic Usage:

from luckyrobots import LuckyEngineClient
import numpy as np

client = LuckyEngineClient(host="127.0.0.1", port=50051)
client.connect()

# Send controls
client.send_control(controls=[0.1, 0.2, -0.1], robot_name="two_pandas")

# Get observation
obs = client.get_observation(robot_name="two_pandas")
qpos = np.array(list(obs.joint_state.positions))
print("qpos:", qpos)

# Reset agent
resp = client.reset_agent()
if resp.success:
    print("Agent reset successful")

Contents:

• API Reference
  • Core Classes
  • Models
  • Engine Management
• Examples
  • Minimal gRPC Control
  • Using Robot Configuration
  • Accessing Observations
  • Resetting Agents
  • Command Line Usage
• Architecture
  • System Overview
  • Components
  • Communication Architecture
  • gRPC Services
  • Message System
  • Configuration

Indices and tables

• Index

• Module Index

• Search Page