API 参考

Python SDK

fastsim 各子包 API 参考文档——按模块浏览类、继承层级、方法与签名说明。

具体类抽象类 (ABC)
fastsim.app
2 类

Primary entry point for loading configuration, building the scene, and running the simulation loop. FastSim wraps the full lifecycle: init → setup → reset → step/start → close.

  • FastSim
  • StepContext
查看文档
fastsim.configs
1 类1 静态

Unified configuration management: load YAML/JSON configs, validate against schemas, export working configs, and generate starter templates.

  • ConfigManager
查看文档
fastsim.unisim
24 类9 抽象6 静态

Backend-agnostic scene and entity API. SceneManager provides access to all spawned robots, objects, and sensors regardless of the underlying simulator backend. Abstract base classes define the lifecycle contract for every entity type.

  • UniSimABC
  • SpawnableABC
  • ArticulationSpawnable
  • RobotArticulation
  • GeneralRobotRobot
  • +19 更多
查看文档
fastsim.controllers
10 类1 抽象5 静态

High-level controller classes decorated with @apiclass. Each controller wraps one or more backend capabilities and returns a structured Result object. The command queue system allows multi-step actions to be dispatched and awaited.

  • Result
  • PriorityLevelIntEnum
  • CommandABC
  • SimpleCommandCommand
  • MultiCommandCommand
  • +5 更多
查看文档
fastsim.extensions
46 类7 抽象7 静态

Optional capability modules (recording, benchmark, ROS, HTTP server, data collection, …) that plug into the simulation lifecycle. Enabled via config and wired through ExtensionManager. Also contains the action/goal/observer/backend subsystems used by these modules.

  • ExtensionManager
  • ExtensionABC
  • DataCollectorExtension
  • RecorderExtension
  • ReplayerExtension
  • +41 更多
查看文档
fastsim.planner
3 类1 抽象1 静态

Abstract planner interface for motion planning backends. Implement Planner to integrate a custom IK/FK/motion-plan solver. CuroboPlanner provides a ready-to-use GPU-accelerated implementation.

  • PlannerABC
  • CuroboPlannerPlanner
  • PlannerFactory
查看文档
fastsim.utils
6 类5 静态

Utility classes for pose math, asset resolution, structured logging, visualization, and kinematics helpers used throughout the framework.

  • Pose
  • Asset
  • Log
  • PoseUtil
  • Visualizer
  • +1 更多
查看文档
fastsim.task
5 类1 静态

Task execution framework: define multi-action tasks, track their status, and manage them through TaskManager. Each Task contains an ordered sequence of Actions evaluated against Goals.

  • TaskStatus
  • ActionResultStatus
  • GoalResultStatus
  • Task
  • TaskManager
查看文档
fastsim.cli
1 类

Command-line tools installed with the fastsim package. Run these from any terminal after installation.

  • CLI Commands
查看文档