Skip to content

PupperRecoilProject/simulation_test_recoil

Repository files navigation

前置安裝:你需要安裝 PyYAML。在你的終端機中執行: pip install onnxruntime numpy pip install PyYAML pip install mujoco glfw //這個看看環境有沒有載,我不是用這個 pip install inputs //搖桿用的 pip install pygame pip install pyserial pip install Pillow pip install scipy //運動學 hardware 需用

pip install numpy onnxruntime PyYAML nicegui pygame pyserial Pillow scipy

專案目錄結構與模組化原則

simulation_test_recoil/
├── assets/                     # 靜態資源 (Static Assets)
├── models/                     # AI 模型文件 (AI Model Files)
├── pdf/                        # 參考文檔 (Reference Documents)
├── src/                        # 核心原始碼 (Core Source Code)
│   ├── core/                   # 核心通用模組 (Core Common Modules)
│   ├── controllers/            # 主要控制器與邏輯協調 (Main Controllers & Logic Orchestration)
│   ├── simulation/             # 模擬環境相關 (Simulation Environment Specific)
│   ├── hardware/               # 硬體交互與底層AI推理 (Hardware Interaction & Low-level AI Inference)
│   ├── input_handlers/         # 用戶輸入處理 (User Input Handling)
│   ├── utils/                  # 通用工具函式 (General Utility Functions)
│   └── mock/                   # 模擬/測試用模組 (Mock/Test Modules)
├── test/                       # 測試與輔助腳本 (Tests & Auxiliary Scripts)
├── output/                     # 生成的輸出文件 (Generated Output Files)
├── .gitignore                  # Git 忽略文件 (Git Ignore File)
├── config.yaml                 # 應用程式主配置 (Main Application Configuration)
├── project_overview_config.yaml # 專案概覽工具配置 (Project Overview Tool Configuration)
├── main.py                     # CLI 主入口 (CLI Main Entry Point)
├── main_nicegui.py             # NiceGUI UI 主入口 (NiceGUI UI Main Entry Point)
├── readme.md                   # 專案說明 (Project Readme)
└── tennsy.md                   # Teensy 韌體文檔 (Teensy Firmware Documentation)

目錄說明與分類原則:

  • assets/:
    • 原則: 存放模擬器使用的所有靜態資源文件,例如 MuJoCo 模型所需的 3D 網格 (.stl)、紋理圖檔 (.png) 和場景定義文件 (.xml)。這些文件通常在運行時被載入,但不包含任何可執行邏輯。
  • models/:
    • 原則: 專門用於存放預訓練的 AI 模型文件,例如 ONNX 格式的策略模型 (.onnx, .ort)。這些是應用程式的數據資產,而非程式碼。
  • pdf/:
    • 原則: 存放專案相關的參考文檔,如 MuJoCo 的官方文檔等。
  • src/:
    • 原則: 本專案所有核心 Python 原始碼的根目錄。所有可執行邏輯的模組都應置於此,並在此目錄內進一步細分。這確保了源碼與其他類型的文件清晰分離。
    • src/core/:
      • 原則: 存放應用程式最底層、最通用、被多個高層模組共同依賴且變動頻率較低的模組。它們是整個系統的基石。
      • 內容: 全局配置 (config.py)、中央狀態管理 (state.py)、異步事件匯流排 (event_system.py)、日誌系統 (logger.py)。
    • src/controllers/:
      • 原則: 存放協調應用程式高層邏輯和業務流程的「指揮官」模組。它們負責監聽事件、更新中央狀態、調用低層服務,並確保各子系統的同步運行。
      • 內容: 模擬主控制器 (simulation_controller.py)、硬體主控制器 (hardware_controller.py)、UI 邏輯控制器 (ui_controller.py)。
    • src/simulation/:
      • 原則: 存放與 MuJoCo 物理模擬環境直接相關的模組。這些模組通常需要直接訪問 MuJoCo 的 API 或模型數據。
      • 內容: MuJoCo 模擬器接口 (simulation.py)、3D 渲染與除錯疊層 (rendering.py)、地形管理 (terrain_manager.py)、懸浮控制器 (floating_controller.py)、以及將被新版取代的舊觀察器 (observation.py)。
    • src/hardware/:
      • 原則: 存放與外部硬體設備(如 Teensy、Xbox 搖桿)進行低層通信和 AI 推理邏輯的模組。它們負責將物理世界或感測器的數據轉換為程式碼可處理的格式,或將程式碼指令轉換為硬體可執行的命令。
      • 內容: AI 策略管理 (policy.py)、序列埠通信 (serial_communicator.py)、Xbox 搖桿接口 (xbox_controller.py)。
    • src/input_handlers/:
      • 原則: 專門處理用戶輸入(鍵盤、搖桿)的模組。它們的職責是將原始輸入事件翻譯為應用程式內部的標準命令或請求事件。
      • 內容: 鍵盤輸入處理 (keyboard_input_handler.py)、Xbox 搖桿輸入處理 (xbox_input_handler.py)。
    • src/utils/:
      • 原則: 存放跨多個模塊使用的通用輔助函數或小型工具類。這些模塊通常不包含複雜的業務邏輯,而是提供可重用的功能。
      • 內容: 序列埠選擇工具 (serial_utils.py)。
    • src/mock/:
      • 原則: 存放用於測試或無頭模式下使用的「模擬」或「假」的模組實現。它們提供與真實模組相同的接口,但內部邏輯是簡化或模擬的。
      • 內容: 模擬 MuJoCo 環境和各類控制器 (mock_simulation.py)。
  • test/:
    • 原則: 存放所有自動化測試腳本 (pytest 測試) 和獨立的輔助工具/演示腳本。這些文件不屬於應用程式的核心運行邏輯,但對開發和驗證至關重要。
    • 內容: 專案概覽生成工具 (project_overview.py)、序列埠控制台工具 (test_pyserial_console.py)、以及各種測試用例。
  • output/:
    • 原則: 專門存放腳本在運行時生成的各種輸出文件。這些文件通常不應被版本控制,因此被添加到 .gitignore 中。
    • 內容: 專案概覽報告 (project_overview_*.md/.txt)、地形快照 (terrain_snapshot_*.png)。
  • 根目錄文件:
    • 原則: 存放專案的頂層配置、主要入口點和通用文檔。力求保持根目錄的簡潔和高層次概覽。
    • 內容: Git 忽略文件 (.gitignore)、應用程式主要配置 (config.yaml)、專案概覽工具配置 (project_overview_config.yaml)、主入口腳本 (main.py, main_nicegui.py)、專案總說明 (readme.md)、Teensy 韌體文檔 (tennsy.md)。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •