Compare commits

...

33 Commits

Author SHA1 Message Date
JackM323 a649865643 Hardware Connection fix 2026-09-20 13:01:36 +02:00
JackM323 b6cb5bb6a1 log upload 2026-09-15 18:31:41 +02:00
JackM323 5a1ac694e0 env output missing variable 2026-09-13 13:32:23 +02:00
JackM323 14251aa415 Readme and comments and reward pdated
readme was outdated
env rewards got a penalty for standing still while it should move instead of 0 reward
2026-09-13 13:28:24 +02:00
JackM323 0fe0a8697f Upload of trained models 2026-09-13 13:06:58 +02:00
JackM323 7b9c52955b decrease extreme explorationin training 2026-08-27 21:55:16 +02:00
JackM323 4cc2d37d94 direct and residual movement inconsistency fixed 2026-08-27 21:40:57 +02:00
JackM323 cd870a4afc Win Initialize fix 2026-08-21 13:44:45 +02:00
JackM323 f5c07edc0a unfinished Readme changes 2026-08-13 09:11:16 +02:00
JackM323 12b8f80002 import order changed 2026-08-07 14:51:37 +02:00
JackM323 3e6e40f0c5 pretrain logic and small fixes 2026-08-07 14:32:35 +02:00
JackM323 a1eb7b8573 no robot coloring 2026-08-07 14:31:58 +02:00
JackM323 7200531af3 deleted leftover file 2026-08-07 14:31:25 +02:00
JackM323 f9a3e8ddba learning tweaks 2026-08-07 10:42:28 +02:00
JackM323 405e3ad5f2 Callback restored 2026-08-06 16:15:29 +02:00
JackM323 346ec9e949 simulation physics fixed
fuck them physics
2026-08-06 15:18:06 +02:00
JackM323 523a4aea89 added Robot kinematic use for training
HUGE BUG -> SimManager physics broken (at least with Robot kinematics)
2026-08-06 13:48:08 +02:00
JackM323 c93c524a10 code reduction for training and eval
reward and everything else changed
again
wont be the last time
2026-08-05 22:44:05 +02:00
JackM323 15e0206739 adjusted rewards and requirements 2026-08-05 11:08:33 +02:00
JackM323 f684bf44b8 Evaluation Phase Usage 2026-08-04 22:29:30 +02:00
JackM323 101004ead1 reward ajustments
robot starts balancing without changing phase and farms alive bonus
fix ->external force and bigger height penalty
2026-08-04 22:17:33 +02:00
JackM323 402c20dfb5 env cleanup
rewards adjustment
pybullet logic contained in SimManager
2026-08-04 21:03:53 +02:00
JackM323 766f2855da Unused Exploration Bonus 2026-08-03 22:58:27 +02:00
JackM323 9d2e001ea4 Higher Height penalty
falling behavior was slightly positiv
therefore the penatly was increased again
2026-08-03 22:52:13 +02:00
JackM323 4fdfadfd3f stage requirements more dependened on distance 2026-08-03 22:50:24 +02:00
JackM323 59b49d3b99 harder stage requirements
the robot should master the stage before proceeding to the next
2026-08-03 22:39:01 +02:00
JackM323 d50d5ac14f Metric stacking bug fixed 2026-08-03 22:30:30 +02:00
JackM323 acb3d671be Reworked training
new reward/penalty system
learning phases with curriculum learning
new training parameters
cleanup of old code
better logging while training
multiple environments instead of robots (they could bumb into each other)
2026-08-03 22:27:26 +02:00
JackM323 5317ef1299 fixed env eval setup 2026-07-31 18:35:09 +02:00
JackM323 a3e46c3abf updated evaluation code for previous env changes
outdated code from previous changes on env
2026-07-31 16:33:50 +02:00
JackM323 846fbfaaab Readme reward/termination explanaition added 2026-07-31 15:56:11 +02:00
JackM323 42974fd994 Readme Updated 2026-07-31 14:50:59 +02:00
JackM323 01f993d727 new default values for training 2026-07-31 14:17:22 +02:00
27 changed files with 1876 additions and 929 deletions
+6 -2
View File
@@ -3,8 +3,12 @@ node_modules/
.venv/ .venv/
.vscode/ .vscode/
__pycache__/ __pycache__/
ml/checkpoints/ ml/checkpoints/*
ml/tensorboard/ !ml/checkpoints/jackbot_kinematics_base.zip
!ml/checkpoints/jackbot_ppo6_149994_steps.zip
!ml/checkpoints/jackbot_ppo6_199992_steps.zip
!ml/checkpoints/jackbot_ppo6_499980_steps.zip
#ml/logs/
# Ignore environment files with private passwords/keys # Ignore environment files with private passwords/keys
.env .env
+13 -3
View File
@@ -11,7 +11,7 @@ class ArduinoCommunication(Thread):
def __init__(self, port=cfg.port, baudrate=cfg.baudrate, timeout=cfg.comm_timeout): def __init__(self, port=cfg.port, baudrate=cfg.baudrate, timeout=cfg.comm_timeout):
super().__init__() super().__init__()
self.daemon = True # Thread schlie�t sich beim Programmende self.daemon = True # Thread schlie�t sich beim Programmende
self.serial_conn = serial.Serial(port, baudrate, timeout=timeout) self.serial_conn = serial.Serial(port, baudrate, timeout=timeout)
time.sleep(2) # Warten bis Arduino ready time.sleep(2) # Warten bis Arduino ready
self.command_queue = Queue() self.command_queue = Queue()
@@ -19,6 +19,9 @@ class ArduinoCommunication(Thread):
self.running = Event() self.running = Event()
self.running.set() self.running.set()
def send_motion(self, radial_array):
self.write(radial_array)
def run(self): def run(self):
while self.running.is_set(): while self.running.is_set():
# 1. Befehle senden # 1. Befehle senden
@@ -70,5 +73,12 @@ class ArduinoCommunication(Thread):
def stop(self): def stop(self):
self.running.clear() self.running.clear()
self.join() try:
self.serial_conn.close() self.join(timeout=0.5)
except RuntimeError:
pass
if self.serial_conn and self.serial_conn.is_open:
self.serial_conn.close()
def close(self):
self.stop()
+12 -2
View File
@@ -25,8 +25,12 @@ HEADER_FMT = "<B B H I" # ID, Ver, Len, Timestamp
TLV_FMT = "<B H" TLV_FMT = "<B H"
class ESP32Communication(Thread): class ESP32Communication(Thread):
def __init__(self, host=cfg.esp32_ip, port=cfg.esp32_port): def __init__(self, host=None, port=None, ip=None):
super().__init__(daemon=True) super().__init__(daemon=True)
if ip is not None:
host = ip
host = cfg.esp32_ip if host is None else host
port = cfg.esp32_port if port is None else port
self.addr = (host, port) self.addr = (host, port)
# UDP Socket - Zero Lag # UDP Socket - Zero Lag
@@ -126,4 +130,10 @@ class ESP32Communication(Thread):
def stop(self): def stop(self):
self.running.clear() self.running.clear()
self.sock.close() try:
self.sock.close()
except Exception:
pass
def close(self):
self.stop()
+440 -66
View File
@@ -1,21 +1,123 @@
# JackBot — Hexapod Control, Simulation & RL Framework
# JackBot — Hexapod Control & Simulation JackBot is a modular Python framework for controlling a six-legged robot in simulation or on hardware. The current workspace reflects a matured control stack with a PyBullet-based simulator, a GUI-driven manual runtime, and a reinforcement-learning pipeline for PPO training and evaluation.
JackBot is a Python project for controlling and simulating a six-legged hexapod robot. ---
It uses IKPy for inverse kinematics, PyBullet for optional simulation, and can send joint commands to ESP32 or Arduino hardware.
## Requirements ## What JackBot Is
- Python 3.12 is safest for `pygame` compatibility JackBot is a Python-based hexapod project that combines:
- Required Python packages:
- `numpy`
- `pygame`
- `ikpy`
- `pybullet`
- `pyserial`
- `matplotlib`
## Setup * a robot control stack for a six-legged walking robot,
* a physics simulator (`simulation.py`) for testing in software before using real hardware,
* a reinforcement learning pipeline that trains locomotion policies with PPO and behavioral cloning,
* and a GUI/gamepad input layer for manual operation.
The project can currently:
* run the robot in a PyBullet simulation,
* accept commands from a GUI or gamepad,
* stream target joint positions to physical hardware (ESP32 / Arduino),
* train PPO models and evaluate saved checkpoints,
* generate kinematics-based teacher data for behavioral cloning.
---
## Why the Project Exists
A hexapod is hard to control manually because each leg has multiple joints and the robot must maintain balance while moving. The project uses a robot model and physics simulation as a testbed for learning motion strategies, refining kinematic control, and validating behavior before applying commands to real hardware.
In the current codebase, the practical workflow is:
1. Start the robot in either simulation or hardware mode.
2. Feed motion commands from GUI/gamepad or a training environment.
3. Convert target foot positions into joint targets using inverse kinematics.
4. Apply these targets to the active backend.
5. Train or evaluate PPO policies against the simulated robot.
---
## Key Components
* **Robot abstraction (`Robot.py`)**: Central handler for the active backend, current joint state, IK/FK helpers, gait handling, and RL action application.
* **Kinematics (`kinematics.py`)**: Converts target foot positions into joint angles using IKPy chains for each leg.
* **Simulation (`simulation.py`)**: Manages PyBullet scene loading, stepping, joint actuation, base pose queries, and physics telemetry.
* **Inputs (`inputs/`)**: Receives commands from GUI sliders, Pygame gamepads, and random command generation.
* **ML Subsystem (`ml/`)**: Contains the Gymnasium environment (`env.py`), PPO training (`run_train.py`), evaluation (`run_eval.py`), BC pretraining (`pretrain_bc.py`), callbacks, and metrics overlays.
* **States (`states/`)**: Contains additional state-machine classes such as `IdleState`, `WalkingState`, and `WaveState`. These exist in the repository, but the current active runtime in `main.py` does not currently drive them through `Robot.tick()`.
---
## Project Architecture
```text
JackBot/
├── main.py # Manual runtime entry point
├── Robot.py # Unified robot wrapper + backend selection
├── config.py # Central runtime configuration
├── kinematics.py # IK/FK helpers
├── simulation.py # PyBullet scene / physics manager
├── robot_init.py # Initial joint definitions and center points
├── DataTypes.py # Typed arrays for positions / angles
├── JackBotUrdf.urdf # Robot URDF
│
├── states/ # State classes present in the project
│ ├── State.py
│ ├── IdleState.py
│ ├── WalkingState.py
│ ├── WaveState.py
│ ├── ml_walking.py
│ └── __init__.py
│
├── inputs/ # Command input providers
│ ├── InputProvider.py
│ ├── PygameController.py
│ ├── RandomeInputProvider.py
│ └── RandomInputProvider.py
│
├── gui/ # GUI/dashboard control layer
│ └── MainWindow.py
│
├── ml/ # Gymnasium RL training + evaluation stack
│ ├── env.py # RL environment + reward logic
│ ├── callbacks.py # SB3 callbacks for logs/curriculum
│ ├── pretrain_bc.py # Behavior cloning pretraining
│ ├── run_train.py # PPO training entry point
│ ├── run_eval.py # Evaluation of saved checkpoints
│ ├── run_eval_training.py # Kinematics-mode benchmark script
│ ├── MetricsOverlay.py # 3D in-scene metrics HUD
│ └── checkpoints/ # Model checkpoints + saved runs
│
├── EspCommunication.py # ESP32 UDP communication layer
├── ArduinoCommunication.py # Arduino serial communication layer
├── Helper Scripts/ # Utility scripts
│ ├── FindCenterPoints.py
│ └── torqueCalc.py
│
├── requirements.txt
├── README.md
└── ...
```
### Important current-state note
The repository contains a few pieces that are still present but not fully connected to the current runtime:
* `states/WalkingState.py`, `states/WaveState.py`, and `states/ml_walking.py` exist, but `main.py` currently drives `Robot.tick()` directly instead of routing through the active `STATE_REGISTRY`.
* `inputs/RandomeInputProvider.py` exists, but the active runtime does not currently use it directly. The GUI resolves random walking behavior in `gui/MainWindow.py`.
* `WaveEmoteState` / `LaolaWaveEmoteState` are defined in `states/WaveState.py`, but they are not currently registered in `states/__init__.py`.
---
## System Requirements
* **Python:** 3.12 recommended
* **OS:** Windows 10/11 or Linux
* **Dependencies:** `pybullet`, `gymnasium`, `stable-baselines3`, `torch`, `numpy`, `pygame`, `ikpy`, `pyserial`, `matplotlib`, `dearpygui`
---
## Installation & Setup
### Linux (Bash) ### Linux (Bash)
@@ -29,81 +131,353 @@ pip install -r requirements.txt
### Windows (PowerShell) ### Windows (PowerShell)
```powershell ```powershell
python3.12 -m venv .venv Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process
python -m venv .venv
.\.venv\Scripts\Activate.ps1 .\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip setuptools wheel python -m pip install --upgrade pip setuptools wheel
pip install -r requirements.txt pip install -r requirements.txt
``` ```
If PowerShell blocks activation: ---
```powershell ## Usage Guide
Set-ExecutionPolicy -Scope Process -ExecutionPolicy RemoteSigned
.\.venv\Scripts\Activate.ps1
```
## Run ## Manual Control & Hardware Streaming (`main.py`)
From the repository root: `main.py` is the main operational entry point for driving the robot manually through the GUI or a connected gamepad.
``` To launch:
```bash
python main.py python main.py
``` ```
If Linux breaks with ### Configuration (`config.py`)
```
ExampleBrowserThreadFunc started
X11 functions dynamically loaded using dlopen/dlsym OK!
cannot connect to X server Before launching `main.py`, edit `config.py` to select the backend and connection targets.
```
run: * **Backend Selection (`cfg.backend`)**:
``` * `BackendType.SIMULATION`: run inside a PyBullet window
export DISPLAY=:0 * `BackendType.ESP32`: stream motion over UDP to an ESP32
python main.py * `BackendType.ARDUINO`: stream motion over serial to an Arduino
Supported configuration values in the current code include:
* `backend`
* `urdf_path`
* `port`, `baudrate`
* `esp32_ip`, `esp32_port`
* `tick_rate_hz`, `step_duration`
* `step_height`, `step_length`
### GUI input sources
The current GUI (`gui/MainWindow.py`) exposes these input sources:
* `Gamepad`
* `GUI Sliders`
* `Random Walk`
The active `main.py` runtime resolves commands through `resolve_active_command(...)` and then passes the resulting `vector_dirmov` directly to `Robot.tick()`.
---
## Machine Learning Pipeline (`ml/`)
The ML subsystem currently uses:
* **Gymnasium** as the environment API
* **PyBullet** as the physics engine
* **Stable-Baselines3 PPO** as the learning algorithm
* **Curriculum phases** to gradually expose more difficult command spaces
### Current ML scripts
* `ml/run_train.py` — PPO training entry point
* `ml/run_eval.py` — phase-based model evaluation
* `ml/run_eval_training.py` — reward benchmark for kinematics mode
* `ml/pretrain_bc.py` — collect teacher data from the kinematics solver and pretrain a base policy
* `ml/env.py` — environment definition and reward logic
* `ml/callbacks.py` — reward logging and curriculum callbacks
### Training flow
Training is launched with:
```bash
python ml/run_train.py --total-timesteps 1500000 --gui
``` ```
## Configuration The current training script creates a vectorized PPO environment, optionally loads a pre-trained checkpoint, and saves results into `ml/checkpoints/` and `ml/logs/`.
Edit `config.py` before running: ### Evaluation flow
- `sim = True` to enable PyBullet simulation Evaluation is launched with:
- `sim = False` to use hardware control
- `arduinoConnection = True` to use Arduino
- `arduinoConnection = False` to use ESP32
- `port` and `baudrate` for Arduino
- `esp32_ip` and `esp32_port` for ESP32
- `urdf_path = "JackBotUrdf.urdf"`
## Project structure ```bash
python ml/run_eval.py --model ml/checkpoints/jackbot_kinematics_base.zip --episodes-per-phase 5 --gui
```
- `main.py` — main application entry point This script runs a multi-phase deterministic evaluation suite with fixed command vectors for:
- `Controller.py` — Pygame-based controller and input display
- `kinematics.py` — IKPy forward/inverse kinematics
- `simulation.py` — PyBullet simulation wrapper
- `GlobalVariables.py` — shared runtime state and comms
- `DataTypes.py` — typed arrays and control intent
- `RobotState/idle.py` — idle robot state
- `RobotState/walking.py` — walking robot state
- `EspCommunication.py` — ESP32 communication
- `ArduinoCommunication.py` — Arduino communication
- `JackBotUrdf.urdf` — robot model file
## Notes * `FORWARD`
* `TURN_AND_DIRECTION`
* `OMNI_DIRECTION`
* `FULL_COMMAND`
- `GlobalVariables.py` initializes either `Simulation()` or the selected hardware comm class. ### Behavioral cloning pretraining
- `DataTypes.py` declares `PosArray`, `DegArray`, `RadArray`, `RobotCommand`, and `ControlIntent`.
- `Controller.py` updates `gv.vector_dirmov` and `gv.robot_state` from joystick input.
- `kinematics.py` loads leg chains from `JackBotUrdf.urdf` and computes IK.
## Troubleshooting The repository also contains a behavioral cloning route:
- If `pygame` installation fails on Windows, use Python 3.12 and upgrade `pip setuptools wheel` first. ```bash
- If `python` is not found on Windows, install Python and enable "Add Python to PATH". python ml/pretrain_bc.py --num-samples 100000 --epochs 15 --save-path ml/checkpoints/jackbot_kinematics_base.zip
- If the program crashes on startup, verify `JackBotUrdf.urdf` path and `config.py` settings. ```
## Suggested improvements This script gathers `(observation, action)` data from the kinematics teacher and trains a PPO policy to act as a learned base model.
- Add a `requirements.txt` or `pyproject.toml`. ---
- Add a `LICENSE` file before sharing the project.
- Document hardware wiring and packet formats for ESP32/Arduino. ## What the Reward Is Trying to Teach
The reward function in `ml/env.py` is designed to teach several things at once:
* survival and stability,
* following the commanded direction,
* avoiding lateral drift,
* maintaining base height,
* reducing abrupt control changes,
* staying close to a stable stance when the command is zero.
The environment uses several reward components, including:
* height reward,
* stability reward,
* pose closeness reward,
* smoothness reward,
* linear velocity tracking,
* angular velocity tracking,
* jitter penalty,
* stand-by penalty when the command is zero.
### Detailed reward structure
The reward is built step by step inside `JackBotEnv._compute_reward()` in `ml/env.py`. It is not a single binary success signal; it is a dense shaping signal that rewards good behavior continuously throughout the episode.
At each control step, the environment measures:
* current body height,
* roll and pitch angles,
* current joint configuration,
* measured linear and angular velocities,
* the active command vector `[vx, vy, omega]`,
* the difference between the current action and the previous actions.
From these values, it computes a set of sub-rewards:
* `height reward`: a Gaussian-style reward based on how close the robot body is to the target height.
* `stability reward`: a reward for keeping roll/pitch low and the body well balanced.
* `pose closeness reward`: rewards staying near the default standing joint posture.
* `smoothness reward`: rewards actions that change gradually instead of abruptly.
* `linear velocity reward`: encourages the robot to move in the commanded direction and speed.
* `angular velocity reward`: rewards matching the commanded turning rate.
The environment then adds two kinds of correction terms:
* `jitter penalty`: subtracts a small amount when action changes are noisy or jerky.
* `stand_penalty`: when the command is effectively zero, penalizes unintended movement and yaw drift.
This makes the reward function behave as a soft guidance system: the agent gets a steady gradient that says “this is closer to what we want” or “this is worse than the desired behavior.”
### Standing mode vs. walking mode
The reward code handles two cases differently:
#### 1. Standing mode
When the command vector is close to zero (`cmd_norm < 0.05` and `abs(cmd_yaw) < 0.05`), the agent is not supposed to move much. In that case the reward focuses on:
* keeping the body at the correct height,
* staying stable,
* maintaining a clean posture,
* staying smooth.
A small `stand_penalty` is then applied to discourage unintended speed and yaw drift while the robot is supposed to hold position.
#### 2. Walking mode
When a non-zero command is active, the robot is rewarded for moving in the intended direction and turning at the requested rate. The reward then emphasizes:
* matching the commanded linear velocity,
* matching the commanded yaw rate,
* continuing to maintain height and stability,
* staying smooth in its control inputs.
If the command expects movement but the robot is effectively still, the code now applies a stronger `stillness_penalty` instead of a neutral reward. This means standing while the command says to move is explicitly discouraged.
### Why the reward is shaped this way
The goal is not just to teach the robot to stay alive. The reward is designed so that a PPO agent learns multiple useful habits at once:
* do not collapse or tip over,
* keep the body at a sensible height,
* follow directional commands,
* avoid unstable oscillations,
* avoid overreactive control jumps,
* stay near a normal standing pose when no motion is requested.
This is why the environment is not based on a single sparse reward such as “+1 for success, 0 otherwise.” Instead, it uses dense reward shaping so the policy receives useful feedback on every step.
### Are the penalties real penalties?
Yes — in the reward function they are real negative contributions. For example:
* `jitter_penalty` subtracts from the step reward when action changes are too abrupt,
* `stand_penalty` subtracts when the robot moves unnecessarily while standing,
* `stillness_penalty` subtracts when movement is commanded but the robot remains essentially frozen.
In the current implementation, a non-zero command that is not followed by meaningful motion now yields an explicit penalty instead of a neutral reward. This is the main behavior change requested for the training setup: standing while the command says to move is now actively discouraged.
The code does this:
```python
final_reward = step_reward + jitter_penalty + alive_bonus
```
That means:
* negative penalty terms can now reduce the reward below zero,
* the reward is no longer clipped to zero in this path,
* and the episode is still only ended by the separate failure check in `_update_robot_failure()`.
So the answer is:
* the penalties are real reward penalties,
* they are now strong enough to discourage command-mismatch behavior,
* and the actual terminal condition remains the failure check in `_update_robot_failure()`.
### What actually ends an episode?
The episode ends when the robot is considered failed, not when a reward penalty is applied. In `ml/env.py`, the environment marks the robot as failed if:
* it is too tilted (`roll` or `pitch` exceed the configured failure threshold), or
* it has collapsed below a minimum body-height threshold.
That is a hard termination condition. In other words:
* reward penalties discourage bad behavior,
* failure conditions stop the episode when the robot is clearly unstable or collapsed.
### Practical interpretation
A good mental model is:
* the reward function teaches the robot what “good locomotion” looks like,
* the failure check prevents the robot from continuing when it is physically broken or unstable,
* and the curriculum gradually increases the difficulty of the commands as the robot becomes more capable.
This combination is a common reinforcement-learning setup for locomotion: dense rewards shape the desired behavior, while hard failure conditions protect the training process from degenerate states.
This reward shaping encourages the robot to learn locomotion patterns rather than simply freezing in place.
---
## Curriculum / Phase Progression
The environment currently uses the following curriculum stages:
* **STAND_ONLY**
* **FORWARD**
* **TURN_AND_DIRECTION**
* **OMNI_DIRECTION**
* **FULL_COMMAND**
The training environment gradually advances phase complexity based on survival, stability, and movement metrics. `ml/callbacks.py` includes custom curriculum-handling logic for the online learning loop.
---
## How the Control Loop Works in Practice
A simplified view of the current runtime is:
1. `main.py` starts the joystick controller process and opens the GUI.
2. The GUI resolves active commands (`Gamepad`, slider, or random walk).
3. `Robot.tick()` receives the current motion vector and applies it through the active backend.
4. In simulation mode, `Simulation.step()` advances the PyBullet world.
5. In training/evaluation mode, `JackBotEnv.step()` computes reward, updates curriculum, and returns observations.
6. PPO uses the observation/action loop to improve the policy.
---
## What Makes this Project Useful
This repository is useful because it combines several layers that are often separate:
* robot control and kinematics,
* physics simulation,
* command input sources,
* RL environment construction,
* PPO training and evaluation,
* hardware communication layers.
For a newcomer, the easiest way to think about the project is:
- `main.py` is the manual control entry point,
- `Robot.py` is the core robot wrapper,
- `simulation.py` is the physics layer,
- `ml/env.py` is the environment interface for RL,
- `ml/run_train.py`, `ml/run_eval.py`, and `ml/pretrain_bc.py` are the main ML workflows.
---
## Current runtime notes and caveats
### State system status
The state classes are present in the repository, but the current runtime path is not using them as the main control loop:
* `Robot.tick()` currently updates the robot directly from `vector_dirmov`
* the `STATE_REGISTRY` exists, but it is not the path used by the current `main.py` execution flow
* the state subsystem remains partially implemented and should be treated as a legacy or optional extension
### Input source status
The repository currently includes both:
* `inputs/PygameController.py` for gamepad input
* `gui/MainWindow.py` for selecting `Gamepad`, `GUI Sliders`, and `Random Walk`
The standalone random input provider file is present, but it is not the path currently used by `main.py`.
### Hardware communication status
The hardware communication classes still exist:
* `EspCommunication.py` for ESP32 UDP
* `ArduinoCommunication.py` for Arduino serial
They are available via `cfg.backend`, but they are not the primary path in the current example workflows shown here.
---
## Helper Scripts
### `Helper Scripts/FindCenterPoints.py`
This script appears to be a utility for analyzing kinematic center point data and related foot-placement experiments. It is not part of the active runtime path.
### `Helper Scripts/torqueCalc.py`
This is a stand-alone Tkinter utility for estimating servo torque requirements based on robot mass, leg dimensions, and safety factor. It is a design/support script rather than part of the main robot runtime.
---
## Bottom Line
The current codebase is a working hybrid of:
* real-time robot control,
* PyBullet simulation,
* GUI/manual input,
* PPO-based RL training and evaluation,
* partial state-machine scaffolding,
* hardware communication support.
The information in this README has been updated to match the current files in the workspace, especially around the true ML entry points, active runtime flow, and the fact that some older state-helper modules are present but not currently wired into the main execution path.
+171 -92
View File
@@ -1,12 +1,9 @@
""" """
Robot.py - Unified Robot Class for JackBot Robot.py - Central Robot Control, Kinematics, State Machine & Hardware Abstraction
Handles state, kinematics, backends (Hardware/Simulation), and motion execution.
""" """
from typing import Protocol, Optional, Union, Tuple, List
from typing import Protocol, Optional, Union
import numpy as np import numpy as np
import math import math
import pybullet as p
from states import STATE_REGISTRY from states import STATE_REGISTRY
from states.State import State from states.State import State
@@ -15,92 +12,130 @@ import kinematics as kin
import robot_init as ri import robot_init as ri
from config import cfg, BackendType from config import cfg, BackendType
# Import communications and simulation modules
from simulation import Simulation from simulation import Simulation
from EspCommunication import ESP32Communication from EspCommunication import ESP32Communication
from ArduinoCommunication import ArduinoCommunication from ArduinoCommunication import ArduinoCommunication
class RobotBackend(Protocol): class RobotBackend(Protocol):
"""Abstraction layer for hardware vs simulation output.""" """Protocol defining hardware abstraction for both Simulation and Hardware backends."""
def send_angles(self, rad_array: dt.RadArray) -> None: def send_angles(self, rad_array: dt.RadArray) -> None: ...
... def step_simulation(self) -> None: ...
def step_simulation(self) -> None: def hard_reset_joints(self, target_angles: np.ndarray) -> None: ...
... def reset_base(self, position: Optional[List[float]] = None, orientation: Optional[List[float]] = None) -> None: ...
def cleanup(self) -> None: def get_joint_angles(self) -> np.ndarray: ...
... def get_base_pose_and_rpy(self) -> Tuple[List[float], Tuple[float, float, float]]: ...
def get_base_velocity(self) -> Tuple[List[float], List[float]]: ...
def cleanup(self) -> None: ...
class HardwareBackend: class HardwareBackend:
"""Backend for physical ESP32 or Arduino robot.""" """Backend for physical ESP32 or Arduino microcontrollers."""
def __init__(self, comm_channel): def __init__(self, comm_channel):
self.comm_channel = comm_channel self.comm_channel = comm_channel
self.internal_angles = np.zeros(18, dtype=np.float32)
def send_angles(self, rad_array: dt.RadArray) -> None: def send_angles(self, rad_array: dt.RadArray) -> None:
self.internal_angles = rad_array.data.flatten().copy()
if self.comm_channel: if self.comm_channel:
self.comm_channel.send_motion(rad_array) self.comm_channel.send_motion(rad_array)
def step_simulation(self) -> None: def step_simulation(self) -> None:
pass # Physical hardware steps in real-time pass
def hard_reset_joints(self, target_angles: np.ndarray) -> None:
self.internal_angles = target_angles.flatten().copy()
def reset_base(self, position: Optional[List[float]] = None, orientation: Optional[List[float]] = None) -> None:
pass
def get_joint_angles(self) -> np.ndarray:
return self.internal_angles.copy()
def get_base_pose_and_rpy(self) -> Tuple[List[float], Tuple[float, float, float]]:
return [0.0, 0.0, 0.122], (0.0, 0.0, 0.0)
def get_base_velocity(self) -> Tuple[List[float], List[float]]:
return [0.0, 0.0, 0.0], [0.0, 0.0, 0.0]
def cleanup(self) -> None: def cleanup(self) -> None:
if self.comm_channel and hasattr(self.comm_channel, 'close'): if self.comm_channel:
self.comm_channel.close() if hasattr(self.comm_channel, 'stop'):
self.comm_channel.stop()
elif hasattr(self.comm_channel, 'close'):
self.comm_channel.close()
class PyBulletBackend: class PyBulletBackend:
"""Backend for PyBullet simulation execution.""" """Backend mapping Robot operations directly to PyBullet simulation engine."""
def __init__(self, sim_instance, body_id: Optional[int] = None): def __init__(self, sim_instance: Simulation):
self.sim = sim_instance self.sim = sim_instance
self.body_id = body_id
def send_angles(self, rad_array: dt.RadArray) -> None: def send_angles(self, rad_array: dt.RadArray) -> None:
if self.sim: if self.sim:
# If body_id is set, target that specific robot body self.sim.set_robot_joint_angles(rad_array)
if self.body_id is not None and hasattr(self.sim, 'updatePosForBody'):
self.sim.updatePosForBody(self.body_id, rad_array)
else:
self.sim.updatePos(rad_array)
def step_simulation(self) -> None: def step_simulation(self) -> None:
if self.sim: if self.sim:
self.sim.step() self.sim.step()
def hard_reset_joints(self, target_angles: np.ndarray) -> None:
if self.sim:
self.sim.hard_reset_joint_angles(target_angles)
def reset_base(self, position: Optional[List[float]] = None, orientation: Optional[List[float]] = None) -> None:
if self.sim:
self.sim.reset_robot_base(pos=position, orn=orientation)
def get_joint_angles(self) -> np.ndarray:
return self.sim.get_robot_joint_angles() if self.sim else np.zeros(18, dtype=np.float32)
def get_base_pose_and_rpy(self) -> Tuple[List[float], Tuple[float, float, float]]:
return self.sim.get_robot_pose_and_rpy() if self.sim else ([0, 0, 0], (0, 0, 0))
def get_base_velocity(self) -> Tuple[List[float], List[float]]:
return self.sim.get_robot_velocity() if self.sim else ([0, 0, 0], [0, 0, 0])
def cleanup(self) -> None: def cleanup(self) -> None:
if self.sim and hasattr(self.sim, 'disconnect'): if self.sim:
self.sim.disconnect() self.sim.disconnect()
class Robot: class Robot:
""" """
Encapsulates a single JackBot hexapod instance. Unified JackBot Class.
Maintains joint states, leg positions, kinematics, and backend control. Coordinates joint memory, IK solvers, procedural tripods, and backend communication.
""" """
def __init__( def __init__(
self, self,
backend_type: Union[BackendType, RobotBackend] = BackendType.SIMULATION, backend_type: Union[BackendType, RobotBackend] = BackendType.SIMULATION,
start_pose: str = "init_deg", start_pose: str = "init_deg",
urdf_path: str = cfg.urdf_path urdf_path: str = cfg.urdf_path,
mode: str = "kinematics" # "kinematics", "residual", or "direct"
): ):
self.urdf_path = urdf_path self.urdf_path = urdf_path
self.start_pose = start_pose
self.mode = mode
# --- BACKEND FACTORY CREATION --- # --- BACKEND INSTANTIATION ---
if isinstance(backend_type, BackendType): if isinstance(backend_type, BackendType):
if backend_type == BackendType.SIMULATION: if backend_type == BackendType.SIMULATION:
# Launch PyBullet 3D Simulation GUI sim_instance = Simulation(urdf_path=self.urdf_path, use_gui=True)
sim_instance = Simulation(urdf_path=self.urdf_path) sim_instance.load_scene()
self.backend: RobotBackend = PyBulletBackend(sim_instance) self.backend: RobotBackend = PyBulletBackend(sim_instance)
elif backend_type == BackendType.ESP32: elif backend_type == BackendType.ESP32:
comm = ESP32Communication(ip=cfg.esp32_ip, port=cfg.esp32_port) comm = ESP32Communication(ip=cfg.esp32_ip, port=cfg.esp32_port)
comm.start()
self.backend = HardwareBackend(comm) self.backend = HardwareBackend(comm)
elif backend_type == BackendType.ARDUINO: elif backend_type == BackendType.ARDUINO:
comm = ArduinoCommunication(port=cfg.port, baudrate=cfg.baudrate) comm = ArduinoCommunication(port=cfg.port, baudrate=cfg.baudrate)
comm.start()
self.backend = HardwareBackend(comm) self.backend = HardwareBackend(comm)
else: else:
self.backend = backend_type self.backend = backend_type
# Kinematics and position initialization # Kinematics initialization
pose_deg = ri.init_deg if start_pose == "init_deg" else ri.init90_deg pose_deg = ri.init_deg if start_pose == "init_deg" else ri.init90_deg
self.current_rad: dt.RadArray = pose_deg.to_rad() self.current_rad: dt.RadArray = pose_deg.to_rad()
self.current_pos: dt.PosArray = kin.ikpyForward(self.current_rad) self.current_pos: dt.PosArray = kin.ikpyForward(self.current_rad)
@@ -108,31 +143,20 @@ class Robot:
ri.get_center_points() if hasattr(ri, "get_center_points") else ri.center_points ri.get_center_points() if hasattr(ri, "get_center_points") else ri.center_points
) )
# RL configuration # RL configuration & Gait state variables
self.action_scale = 0.1 # Joint delta step size (radians) self.action_scale = 0.1 # Radian step scale for RL deltas
self.gait_phase = 0.0
# Gait / motion variables
self.leg_state = np.array(["step", "drag", "step", "drag", "step", "drag"])
self.robot_state = "idle"
self.vector_dirmov = [0.0, 0.0, 0.0] # [vx, vy, omega] self.vector_dirmov = [0.0, 0.0, 0.0] # [vx, vy, omega]
self.robot_state = "idle"
self.leg_state = np.array(["step", "drag", "step", "drag", "step", "drag"])
# State machine initialization # State Machine Initialization
self.current_state_key: str = "idle" self.current_state_key: str = "idle"
self.current_state: State = STATE_REGISTRY["idle"] self.current_state: State = STATE_REGISTRY["idle"]
self.current_state.enter(self) self.current_state.enter(self)
def change_state(self, new_state: State) -> None:
if self.current_state:
self.current_state.exit(self)
self.current_state = new_state
self.current_state.enter(self)
def update(self) -> None:
if self.current_state:
self.current_state.execute(self)
self.step_sim()
def set_joint_angles(self, target_rad: dt.RadArray) -> None: def set_joint_angles(self, target_rad: dt.RadArray) -> None:
"""Updates internal Python memory state and sends angles to active backend."""
self.current_rad = target_rad self.current_rad = target_rad
if self.backend: if self.backend:
self.backend.send_angles(target_rad) self.backend.send_angles(target_rad)
@@ -142,10 +166,18 @@ class Robot:
self.backend.step_simulation() self.backend.step_simulation()
def reset_to_init(self) -> None: def reset_to_init(self) -> None:
self.current_rad = ri.init_deg.to_rad() """Resets kinematics state and forces instant joint alignment in backend."""
pose_deg = ri.init_deg if self.start_pose == "init_deg" else ri.init90_deg
self.current_rad = pose_deg.to_rad()
self.current_pos = kin.ikpyForward(self.current_rad) self.current_pos = kin.ikpyForward(self.current_rad)
self.set_joint_angles(self.current_rad) self.gait_phase = 0.0
self.step_sim() self.robot_state = "idle"
self.leg_state = np.array(["step", "drag", "step", "drag", "step", "drag"])
init_flat = self.current_rad.data.flatten()
if self.backend:
self.backend.hard_reset_joints(init_flat)
self.backend.send_angles(self.current_rad)
def compute_ik(self, target_pos: dt.PosArray) -> dt.RadArray: def compute_ik(self, target_pos: dt.PosArray) -> dt.RadArray:
return kin.ikpyInverse(target_pos, initial_rad=self.current_rad) return kin.ikpyInverse(target_pos, initial_rad=self.current_rad)
@@ -161,57 +193,104 @@ class Robot:
self.current_state = STATE_REGISTRY[next_state_key] self.current_state = STATE_REGISTRY[next_state_key]
self.current_state.enter(self) self.current_state.enter(self)
def tick(self) -> None: def tick(self, action: Optional[np.ndarray] = None) -> None:
next_state_key = self.current_state.execute(self) """
if next_state_key: Unified control loop tick.
self.transition_to(next_state_key) Processes commands through direct RL, residual RL, or State Machine kinematics.
"""
vx, vy, omega = self.vector_dirmov
if self.mode == "direct":
if action is not None:
self.apply_rl_action(action)
elif self.mode == "residual":
self.step_kinematic_gait(vx, vy, omega)
if action is not None:
self.apply_rl_action_delta(action)
else: # "kinematics" / standard State Machine execution
next_state_key = self.current_state.execute(self)
if next_state_key:
self.transition_to(next_state_key)
self.step_sim() self.step_sim()
# --- RL METHODS --- def step_kinematic_gait(self, vx: float, vy: float, omega: float) -> None:
"""Procedural Tripod Gait solver."""
cmd_mag = math.hypot(vx, vy) + abs(omega)
if cmd_mag < 0.03:
target_rad = self.compute_ik(self.center_points)
self.set_joint_angles(target_rad)
return
def apply_rl_action(self, action: np.ndarray) -> None: self.gait_phase = (self.gait_phase + 0.22) % (2.0 * math.pi)
""" stride_len = cfg.step_length
Applies continuous RL action deltas [-1, 1] to current joint angles. step_height = cfg.step_height
"""
action = np.asarray(action, dtype=np.float32)
scaled_action = np.clip(action, -1.0, 1.0) * self.action_scale
current_flat = self.current_rad.data.flatten() center_data = (
updated_flat = np.clip( self.center_points.data if hasattr(self.center_points, 'data') else np.array(self.center_points)
current_flat + scaled_action,
-np.pi / 2,
np.pi / 2
) )
target_positions = []
for leg_id in range(6):
base_pos = np.array(center_data[leg_id], dtype=np.float32)
phase_offset = 0.0 if (leg_id % 2 == 0) else math.pi
leg_phase = (self.gait_phase + phase_offset) % (2.0 * math.pi)
lx, ly = base_pos[0], base_pos[1]
rot_dx = -omega * ly
rot_dy = omega * lx
dx_dir = vx + rot_dx
dy_dir = vy + rot_dy
dir_norm = math.hypot(dx_dir, dy_dir) + 1e-6
dx_unit = dx_dir / dir_norm
dy_unit = dy_dir / dir_norm
if leg_phase < math.pi:
# Swing phase (leg lifted in air, moving forward)
progress = math.cos(leg_phase)
lift = math.sin(leg_phase) * step_height
dx = progress * stride_len * dx_unit
dy = progress * stride_len * dy_unit
dz = lift
else:
# Stance phase (leg on ground, pushing body forward)
progress = math.cos(leg_phase - math.pi)
dx = -progress * stride_len * dx_unit
dy = -progress * stride_len * dy_unit
dz = 0.0
target_positions.append(base_pos + np.array([dx, dy, dz], dtype=np.float32))
target_pos_array = dt.PosArray(np.array(target_positions))
target_rad = self.compute_ik(target_pos_array)
self.set_joint_angles(target_rad)
def apply_rl_action(self, action: np.ndarray) -> None:
action = np.asarray(action, dtype=np.float32)
new_rad = dt.RadArray(data=action.reshape(self.current_rad.data.shape))
self.set_joint_angles(new_rad)
def apply_rl_action_delta(self, action: np.ndarray) -> None:
"""Applies action deltas on top of joint state for Residual RL."""
action = np.asarray(action, dtype=np.float32)
scaled_action = np.clip(action, -1.0, 1.0) * self.action_scale
current_flat = self.backend.get_joint_angles().flatten()
updated_flat = np.clip(current_flat + scaled_action, -np.pi / 2, np.pi / 2)
new_rad = dt.RadArray(data=updated_flat.reshape(self.current_rad.data.shape)) new_rad = dt.RadArray(data=updated_flat.reshape(self.current_rad.data.shape))
self.set_joint_angles(new_rad) self.set_joint_angles(new_rad)
def get_observation(self, command: Optional[np.ndarray] = None) -> np.ndarray: def get_observation(self, command: Optional[np.ndarray] = None) -> np.ndarray:
""" """Extracts joint positions directly from active backend."""
Returns observation vector [18 joint angles] + [optional 4 command dimensions]. joint_angles = self.backend.get_joint_angles().flatten().astype(np.float32)
Queries PyBullet if backend is PyBulletBackend; otherwise falls back to internal state.
"""
if isinstance(self.backend, PyBulletBackend) and self.backend.sim and hasattr(self.backend.sim, 'physics_client'):
physics_client = self.backend.sim.physics_client
body_id = self.backend.body_id if self.backend.body_id is not None else 0
# Retrieve joint mapping from SimManager/Simulation if available
if hasattr(self.backend.sim, 'robot_joints') and body_id in self.backend.sim.robot_joints:
joint_indices = self.backend.sim.robot_joints[body_id]
else:
joint_indices = list(range(18))
joint_states = p.getJointStates(body_id, joint_indices, physicsClientId=physics_client)
joint_angles = np.array([state[0] for state in joint_states], dtype=np.float32)
else:
joint_angles = self.current_rad.data.flatten().astype(np.float32)
if command is not None: if command is not None:
cmd = np.asarray(command, dtype=np.float32).flatten() cmd = np.asarray(command, dtype=np.float32).flatten()
return np.concatenate([joint_angles, cmd]).astype(np.float32) return np.concatenate([joint_angles, cmd]).astype(np.float32)
return joint_angles
return joint_angles.astype(np.float32)
def cleanup(self) -> None: def cleanup(self) -> None:
if self.backend and hasattr(self.backend, 'cleanup'): if self.backend:
self.backend.cleanup() self.backend.cleanup()
+9 -1
View File
@@ -22,7 +22,7 @@ class RobotConfig:
# Hardware Connection Settings # Hardware Connection Settings
port: str = "COM4" # Serial Port for Arduino port: str = "COM4" # Serial Port for Arduino
baudrate: int = 38400 # Baudrate for Serial baudrate: int = 38400 # Baudrate for Serial
esp32_ip: str = "192.168.188.32" # Wi-Fi IP for ESP32 UDP communication esp32_ip: str = "192.168.188.32" # Wi-Fi IP for ESP32 UDP communication
esp32_port: int = 3323 # UDP Target Port esp32_port: int = 3323 # UDP Target Port
comm_timeout: float = 2.0 # Connection timeout threshold [s] comm_timeout: float = 2.0 # Connection timeout threshold [s]
@@ -38,6 +38,14 @@ class RobotConfig:
tick_rate_hz: float = 25.0 # Motion loop execution rate [ticks/sec] tick_rate_hz: float = 25.0 # Motion loop execution rate [ticks/sec]
step_duration: float = 0.8 # Time to complete full gait stride [s] step_duration: float = 0.8 # Time to complete full gait stride [s]
@property
def standard_tickpersec(self) -> float:
return self.tick_rate_hz
@standard_tickpersec.setter
def standard_tickpersec(self, value: float) -> None:
self.tick_rate_hz = value
@property @property
def tick_duration(self) -> float: def tick_duration(self) -> float:
return 1.0 / self.tick_rate_hz return 1.0 / self.tick_rate_hz
+65 -81
View File
@@ -1,7 +1,11 @@
""" """
ml/MetricsOverlay.py - Camera-Facing (Billboard) 3D Floating Text Overlay ml/MetricsOverlay.py - 3D HUD overlay for live simulation telemetry.
This file provides a small PyBullet HUD renderer that draws live robot metrics in the
simulation scene. It is used during GUI runs to show the current phase, command vector,
reward information, and basic motion statistics without leaving the 3D view.
""" """
from typing import List, Tuple, Optional from typing import List, Tuple, Optional, Dict
import numpy as np import numpy as np
import pybullet as p import pybullet as p
@@ -21,20 +25,15 @@ class MetricsHUD:
yaw = cam_info[8] yaw = cam_info[8]
pitch = cam_info[9] pitch = cam_info[9]
# Orient the text normal toward the camera view direction
# PyBullet text default faces local +Z/-Y depending on roll,
# converting visualizer yaw/pitch to Euler angles (roll, pitch, yaw in radians)
roll_rad = 0.0
pitch_rad = np.radians(pitch + 90.0) pitch_rad = np.radians(pitch + 90.0)
yaw_rad = np.radians(yaw) yaw_rad = np.radians(yaw)
text_orientation = p.getQuaternionFromEuler( text_orientation = p.getQuaternionFromEuler(
[pitch_rad, roll_rad, yaw_rad], [pitch_rad, 0.0, yaw_rad],
physicsClientId=self.client_id physicsClientId=self.client_id
) )
return text_orientation return text_orientation
except Exception: except Exception:
# Fallback default orientation if camera info call fails
return [0.0, 0.0, 0.0, 1.0] return [0.0, 0.0, 0.0, 1.0]
def update( def update(
@@ -44,30 +43,49 @@ class MetricsHUD:
robot_rewards: List[float], robot_rewards: List[float],
cmd_vel: np.ndarray, cmd_vel: np.ndarray,
fps: float = 0.0, fps: float = 0.0,
avg_height: float = 0.0, height: float = 0.0,
roll_pitch: Tuple[float, float] = (0.0, 0.0) roll_pitch: Tuple[float, float] = (0.0, 0.0),
mode: str = "direct",
phase: str = "STAND_ONLY",
distance: float = 0.0,
status: str = "ALIVE",
reward_components: Optional[Dict[str, float]] = None,
ep_step: int = 0,
) -> None: ) -> None:
"""Updates floating black text block in 3D space with billboarding.""" """Updates floating text block in 3D space with expanded telemetry."""
sorted_rewards = sorted(robot_rewards, reverse=True) sorted_rewards = sorted(robot_rewards, reverse=True)
top1 = f"{sorted_rewards[0]:+.2f}" if len(sorted_rewards) > 0 else "0.00" top1 = f"{sorted_rewards[0]:+.2f}" if len(sorted_rewards) > 0 else "0.00"
top2 = f"{sorted_rewards[1]:+.2f}" if len(sorted_rewards) > 1 else "0.00"
top3 = f"{sorted_rewards[2]:+.2f}" if len(sorted_rewards) > 2 else "0.00"
vx = cmd_vel[0] if len(cmd_vel) > 0 else 0.0 vx = cmd_vel[0] if len(cmd_vel) > 0 else 0.0
vy = cmd_vel[1] if len(cmd_vel) > 1 else 0.0 vy = cmd_vel[1] if len(cmd_vel) > 1 else 0.0
omega = cmd_vel[3] if len(cmd_vel) > 3 else 0.0 omega = cmd_vel[2] if len(cmd_vel) > 2 else 0.0
hud_text = ( lines = [
f"=== JACKBOT METRICS ===\n" "=== JACKBOT TELEMETRY ===",
f"Episode: {episode}\n" f"Mode: {mode.upper()}",
f"Global Step: {step}\n" f"Curriculum: {phase}",
f"FPS: {fps:.1f}\n" f"Status: {status}",
f"----------------------\n" f"Episode: {episode} (Step {ep_step})",
f"Top Rewards: [{top1}, {top2}, {top3}]\n" f"Global Step: {step}",
f"Cmd (X,Y,W): [{vx:+.2f}, {vy:+.2f}, {omega:+.2f}]\n" f"FPS: {fps:.1f}",
f"Height: {avg_height:.3f} m\n" "-------------------------",
f"Roll/Pitch: {roll_pitch[0]:+.1f}° / {roll_pitch[1]:+.1f}°" f"Episode Rew: {top1}",
) f"Cmd (X,Y,W): [{vx:+.2f}, {vy:+.2f}, {omega:+.2f}]",
f"Height: {height:.3f} m",
f"Roll/Pitch: {roll_pitch[0]:+.1f}° / {roll_pitch[1]:+.1f}°",
f"Max Dist: {distance:.2f} m",
]
if reward_components:
lin_v = reward_components.get("lin_vel", 0.0)
stab = reward_components.get("stability", 0.0)
h_rew = reward_components.get("height", 0.0)
jit = reward_components.get("jitter_penalty", 0.0)
lines.append("--- Reward Components ---")
lines.append(f"LinVel: {lin_v:.2f} | Stab: {stab:.2f}")
lines.append(f"Height: {h_rew:.2f} | Jitter: {jit:+.3f}")
hud_text = "\n".join(lines)
# Position above origin in simulation world # Position above origin in simulation world
text_position = [-0.8, -0.8, 1.2] text_position = [-0.8, -0.8, 1.2]
@@ -76,62 +94,28 @@ class MetricsHUD:
# Calculate dynamic orientation to align text flat against camera plane # Calculate dynamic orientation to align text flat against camera plane
text_orientation = self._get_camera_facing_orientation() text_orientation = self._get_camera_facing_orientation()
if self._text_id is None: # Safely remove old text to prevent PyBullet ghosting/overlapping
self._text_id = p.addUserDebugText( if self._text_id is not None:
text=hud_text, try:
textPosition=text_position, p.removeUserDebugItem(self._text_id, physicsClientId=self.client_id)
textColorRGB=text_color, except Exception:
textSize=0.1, pass
textOrientation=text_orientation,
physicsClientId=self.client_id # Draw fresh text
) self._text_id = p.addUserDebugText(
else: text=hud_text,
self._text_id = p.addUserDebugText( textPosition=text_position,
text=hud_text, textColorRGB=text_color,
textPosition=text_position, textSize=0.085,
textColorRGB=text_color, textOrientation=text_orientation,
textSize=0.1, physicsClientId=self.client_id
textOrientation=text_orientation, )
replaceItemUniqueId=self._text_id,
physicsClientId=self.client_id
)
def reset(self) -> None: def reset(self) -> None:
"""Clears text reference on environment reset.""" """Removes the active debug text item so a new episode starts with a clean overlay."""
self._text_id = None if self._text_id is not None:
try:
p.removeUserDebugItem(self._text_id, physicsClientId=self.client_id)
class LeaderCrown: except Exception:
"""Renders a floating crown or star emoji above the leading robot in PyBullet.""" pass
def __init__(self, physics_client_id: int = 0):
self.client_id = physics_client_id
self._text_id = None
def update(self, leader_pos: list[float]):
"""Positions a floating crown ~0.35m directly above the lead robot's base."""
crown_pos = [leader_pos[0], leader_pos[1], leader_pos[2] + 0.35]
# You can use "👑 CROWN", "⭐ LEADER", or "★ TOP1"
crown_text = "👑"
if self._text_id is None:
self._text_id = p.addUserDebugText(
text=crown_text,
textPosition=crown_pos,
textColorRGB=[1.0, 0.84, 0.0],
textSize=2.0,
physicsClientId=self.client_id
)
else:
self._text_id = p.addUserDebugText(
text=crown_text,
textPosition=crown_pos,
textColorRGB=[1.0, 0.84, 0.0],
textSize=2.0,
replaceItemUniqueId=self._text_id,
physicsClientId=self.client_id
)
def reset(self):
self._text_id = None self._text_id = None
-59
View File
@@ -1,59 +0,0 @@
JackBot ML training and evaluation
Quick-start
1. Create a Python virtualenv and activate it:
```bash
python -m venv .venv
source .venv/bin/activate
```
2. Install dependencies (GPU users should install `torch` appropriate for their CUDA):
```bash
pip install -r requirements.txt
```
3. Quick training (short, for smoke test):
```bash
python ml/run_train.py --timesteps 50000 --model ml/checkpoints/ppo_joint_command
```
Use multi-robot training with `--num-robots` and `--robot-spacing`:
```bash
python ml/run_train.py --timesteps 50000 --model ml/checkpoints/ppo_joint_command --num-robots 3 --robot-spacing 0.75
```
Choose the start pose at reset with `--start-pose`:
```bash
python ml/run_train.py --timesteps 50000 --model ml/checkpoints/ppo_joint_command --start-pose init_deg
```
If you want to watch the agent train in the PyBullet window, add `--gui`:
```bash
python ml/run_train.py --timesteps 50000 --model ml/checkpoints/ppo_joint_command --gui
```
4. Evaluate the trained model in GUI mode:
```bash
python ml/run_eval.py --model ml/checkpoints/ppo_joint_command.zip --episodes 3 --gui
```
For evaluation with multiple robots and start pose:
```bash
python ml/run_eval.py --model ml/checkpoints/ppo_joint_command.zip --episodes 3 --gui --num-robots 2 --robot-spacing 0.6 --start-pose init_deg
```
Notes
- `ml/env.py` exposes a `JackBotEnv` gym environment that uses your `JackBotUrdf.urdf`.
- The observation is `[joint_angles..., vx, vy, vz, omega]` and the action is per-joint delta in [-1,1].
- Start with small timesteps and in `use_gui=False` to speed up iteration. Increase timesteps and tune the reward for better walking quality.
- Keep the trained models off hardware until they behave well in simulation.
-88
View File
@@ -1,88 +0,0 @@
"""
ml/SimManager.py - PyBullet Simulation & Multi-Body Manager
"""
from typing import Dict, List, Tuple
import pybullet as p
import pybullet_data
import DataTypes as dt
class SimManager:
"""Manages PyBullet simulation lifecycle and multi-robot physics."""
def __init__(self, use_gui: bool = True):
self.use_gui = use_gui
self.physics_client = None
self.robot_joints: Dict[int, List[int]] = {}
def connect(self):
"""Connects to PyBullet and hides side GUI panels."""
if self.physics_client is not None and p.isConnected(self.physics_client):
return
flags = p.GUI if self.use_gui else p.DIRECT
self.physics_client = p.connect(flags)
p.setAdditionalSearchPath(pybullet_data.getDataPath())
p.setGravity(0, 0, -9.81, physicsClientId=self.physics_client)
if self.use_gui:
# Disable PyBullet side panel and preview windows
p.configureDebugVisualizer(p.COV_ENABLE_GUI, 0, physicsClientId=self.physics_client)
p.configureDebugVisualizer(p.COV_ENABLE_SEGMENTATION_MARK_PREVIEW, 0, physicsClientId=self.physics_client)
p.configureDebugVisualizer(p.COV_ENABLE_DEPTH_BUFFER_PREVIEW, 0, physicsClientId=self.physics_client)
p.configureDebugVisualizer(p.COV_ENABLE_RGB_BUFFER_PREVIEW, 0, physicsClientId=self.physics_client)
def load_scene(
self, urdf_path: str, num_robots: int, robot_spacing: float, base_pos_fn
) -> Tuple[int, List[int], List[List[int]]]:
"""Loads plane and hexapod bodies into the simulation scene."""
plane_id = p.loadURDF("plane.urdf", physicsClientId=self.physics_client)
robots = []
robot_joint_indices = []
self.robot_joints.clear()
for r_id in range(num_robots):
base_pos = base_pos_fn(r_id, num_robots, robot_spacing)
robot = p.loadURDF(
urdf_path,
basePosition=base_pos,
useFixedBase=False,
physicsClientId=self.physics_client
)
robots.append(robot)
joint_indices = [
i for i in range(p.getNumJoints(robot, physicsClientId=self.physics_client))
if p.getJointInfo(robot, i, physicsClientId=self.physics_client)[2] == p.JOINT_REVOLUTE
]
robot_joint_indices.append(joint_indices)
self.robot_joints[robot] = joint_indices
return plane_id, robots, robot_joint_indices
def updatePosForBody(self, body_id: int, current_rad: dt.RadArray):
"""Sets joint motor position targets on individual robot bodies."""
if body_id not in self.robot_joints:
return
joint_indices = self.robot_joints[body_id]
radflat = current_rad.data.flatten()
for joint_index, target_angle in zip(joint_indices, radflat):
p.setJointMotorControl2(
bodyIndex=body_id,
jointIndex=joint_index,
controlMode=p.POSITION_CONTROL,
targetPosition=float(target_angle),
force=250,
physicsClientId=self.physics_client
)
def step(self):
p.stepSimulation(physicsClientId=self.physics_client)
def disconnect(self):
if self.physics_client is not None and p.isConnected(self.physics_client):
p.disconnect(self.physics_client)
self.physics_client = None
+2 -5
View File
@@ -1,6 +1,3 @@
from .env import JackBotEnv from .env import JackBotEnv, CurriculumPhase
from .model import ActorCritic
from .train import train
from .evaluate import evaluate
__all__ = ["JackBotEnv", "ActorCritic", "train", "evaluate"] __all__ = ["JackBotEnv", "CurriculumPhase"]
+102
View File
@@ -0,0 +1,102 @@
"""
ml/callbacks.py - Stable-Baselines3 callbacks for training diagnostics.
These callbacks extend SB3 training with two responsibilities: logging reward-component
statistics for TensorBoard/console output, and checking whether the curriculum should
advance to a harder set of commands based on recent training performance.
"""
import numpy as np
from stable_baselines3.common.callbacks import BaseCallback
class RewardLoggerCallback(BaseCallback):
"""
Logs individual reward component averages to TensorBoard and prints
the best worker's performance breakdown to the console per iteration.
"""
def __init__(self, verbose: int = 1):
super().__init__(verbose)
self.iteration = 0
def _on_step(self) -> bool:
return True
def _on_rollout_end(self) -> None:
self.iteration += 1
if self.training_env is None:
return
try:
# Safely query method across all parallel worker processes
all_worker_averages = self.training_env.env_method("get_reward_component_averages")
except Exception:
return
if not all_worker_averages or len(all_worker_averages) == 0:
return
# 1. Log mean component values across ALL workers to TensorBoard
component_keys = all_worker_averages[0].keys()
for key in component_keys:
mean_val = float(np.mean([w.get(key, 0.0) for w in all_worker_averages]))
self.logger.record(f"reward_components/{key}", mean_val)
# 2. Identify the best performing worker of this iteration
worker_totals = [sum(w.values()) for w in all_worker_averages]
best_worker_idx = int(np.argmax(worker_totals))
best_averages = all_worker_averages[best_worker_idx]
best_total = worker_totals[best_worker_idx]
# 3. Print best worker breakdown to console
if self.verbose > 0:
print(f"\n" + "=" * 65)
print(f" ITERATION {self.iteration} | BEST WORKER (#{best_worker_idx}) REWARD BREAKDOWN")
print(f" Total Avg Reward / Step: {best_total:+.4f}")
print("-" * 65)
for key, val in best_averages.items():
print(f" • {key:<26}: {val:+.5f}")
print("=" * 65 + "\n")
class CurriculumCallback(BaseCallback):
"""
Monitors training metrics using SB3's native ep_info_buffer and
dynamically advances curriculum phases across worker processes.
"""
def __init__(self, reward_threshold: float = 100.0, verbose: int = 1):
super().__init__(verbose)
self.reward_threshold = reward_threshold
def _on_step(self) -> bool:
return True
def _on_rollout_end(self) -> None:
if self.training_env is None:
return
# SB3 natively records finished episode stats in self.model.ep_info_buffer
if hasattr(self.model, "ep_info_buffer") and len(self.model.ep_info_buffer) > 0:
recent_rewards = [ep_info["r"] for ep_info in self.model.ep_info_buffer]
mean_reward = float(np.mean(recent_rewards[-50:]))
try:
# Query current phase from worker 0
phases = self.training_env.get_attr("curriculum_phase")
current_phase = phases[0]
# Advance curriculum if mean reward exceeds threshold
if mean_reward >= self.reward_threshold:
if hasattr(current_phase, "next"):
next_phase = current_phase.next()
if next_phase != current_phase:
self.training_env.set_attr("curriculum_phase", next_phase)
if self.verbose > 0:
print(
f"\n[Curriculum] 🚀 Promoted workers to phase: {next_phase.name} "
f"(Mean Reward: {mean_reward:.2f})"
)
except Exception:
pass # Keep rollout loop running safely if phase check fails
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+357 -180
View File
@@ -1,279 +1,456 @@
""" """
ml/env.py - Gymnasium Environment for JackBot Hexapod RL Training ml/env.py - Gymnasium environment for JackBot RL training and evaluation.
This file defines JackBotEnv, the main training/evaluation environment used by PPO.
It wraps the PyBullet simulation and Robot interfaces into a Gymnasium-compatible
step/reset loop, manages command sampling, curriculum progression, and reward
calculation, and exposes metrics that the training callbacks can log.
""" """
import time import time
import math import math
from enum import IntEnum
from typing import Optional, Tuple, Dict, Any, List from typing import Optional, Tuple, Dict, Any, List
from collections import defaultdict
import gymnasium as gym import gymnasium as gym
from gymnasium import spaces from gymnasium import spaces
import numpy as np import numpy as np
import pybullet as p
from config import cfg from config import cfg
from simulation import Simulation
from Robot import Robot, PyBulletBackend from Robot import Robot, PyBulletBackend
from ml.SimManager import SimManager from ml.MetricsOverlay import MetricsHUD
from ml.MetricsOverlay import MetricsHUD, LeaderCrown
# Color Palette RGBA for Terminated/Failed Robots
COLOR_FAILED = [0.3, 0.3, 0.3, 0.6] # Collapsed / Tilted Robot (Dark Semi-Transparent Gray) class CurriculumPhase(IntEnum):
STAND_ONLY = 0
FORWARD = 1
TURN_AND_DIRECTION = 2
OMNI_DIRECTION = 3
FULL_COMMAND = 4
class JackBotEnv(gym.Env): class JackBotEnv(gym.Env):
"""Gymnasium environment wrapping JackBot hexapods with floating text & crown overlay.""" """Gymnasium environment wrapping JackBot hexapod simulation."""
def __init__( def __init__(
self, self,
use_gui: bool = True, use_gui: bool = True,
random_command: bool = True, random_command: bool = True,
num_robots: int = 1,
robot_spacing: float = 0.5,
start_pose: str = "init_deg",
max_episode_steps: int = 3000, max_episode_steps: int = 3000,
urdf_path: str = cfg.urdf_path, urdf_path: str = cfg.urdf_path,
termination_threshold: float = 0.001, # Termination ratio threshold robot_mode: str = "direct", # "direct", "residual", or "kinematics"
): ):
super().__init__() super().__init__()
self.robot_mode = robot_mode
self.use_gui = use_gui self.use_gui = use_gui
self.random_command = random_command self.random_command = random_command
self.num_robots = num_robots
self.robot_spacing = robot_spacing
self.start_pose = start_pose
self.max_episode_steps = max_episode_steps self.max_episode_steps = max_episode_steps
self.urdf_path = urdf_path self.urdf_path = urdf_path
self.termination_threshold = termination_threshold self.max_robot_speed = 0.6
self.episode_count = 0
self.step_count = 0 self.step_count = 0
self.total_steps = 0 self.total_steps = 0
self.cumulative_reward = 0.0 self.cumulative_reward = 0.0
self.robot_rewards = [0.0 for _ in range(self.num_robots)] self.robot_reward = 0.0
self.failed_robots_mask = [False for _ in range(self.num_robots)] self.is_failed = False
self.episode_count = 0
self.episode_height_sum = 0.0
self.episode_roll_sum = 0.0
self.episode_pitch_sum = 0.0
self._curriculum_advanced = False
self._first_reset = True self._first_reset = True
# Initialize Simulation Manager self.last_reward_components: Dict[str, float] = {}
self.sim_manager = SimManager(use_gui=self.use_gui) self.episode_reward_components_sum: Dict[str, float] = defaultdict(float)
self.sim_manager.connect()
# Connect physics world self.control_freq = 60
self.plane, self.pb_robots, self.robot_joint_indices = self.sim_manager.load_scene( self.min_cmd_hold_steps = int(2.0 * self.control_freq)
self.urdf_path, self.num_robots, self.robot_spacing, self._robot_base_position self.max_cmd_hold_steps = int(6.0 * self.control_freq)
) self.next_cmd_resample_step = 0
self.initial_stand_steps = 120
# Instantiate Robot Python wrappers per PyBullet body ID # --- INITIALIZE PYBULLET SIMULATION ENGINE ---
self.robots = [ self.sim = Simulation(urdf_path=self.urdf_path, use_gui=self.use_gui)
Robot( self.plane_id, self.pb_robot, self.revolute_joints = self.sim.load_scene()
backend_type=PyBulletBackend(self.sim_manager, body_id=pb_id),
start_pose=self.start_pose,
urdf_path=self.urdf_path
)
for pb_id in self.pb_robots
]
# Action (18 joint deltas per robot) & Observation (18 angles + 4 command dims per robot) # --- INITIALIZE ROBOT WITH BACKEND ---
action_dim = self.num_robots * 18 self.backend = PyBulletBackend(self.sim)
obs_dim = self.num_robots * (18 + 4) self.robot = Robot(backend_type=self.backend, urdf_path=self.urdf_path, mode=self.robot_mode)
action_dim = 18
obs_dim = 18 + 3 # 18 Joint Angles + 3 Command Inputs [vx, vy, omega]
self.action_space = spaces.Box(-1.0, 1.0, shape=(action_dim,), dtype=np.float32) self.action_space = spaces.Box(-1.0, 1.0, shape=(action_dim,), dtype=np.float32)
self.observation_space = spaces.Box(-np.inf, np.inf, shape=(obs_dim,), dtype=np.float32) self.observation_space = spaces.Box(-np.inf, np.inf, shape=(obs_dim,), dtype=np.float32)
self.min_joint_limits, self.max_joint_limits = self.sim._get_urdf_joint_limits()
self.commands = np.zeros((self.num_robots, 4), dtype=np.float32) self.command = np.zeros(3, dtype=np.float32) # [vx, vy, omega]
self.last_action = np.zeros(action_dim, dtype=np.float32) self.last_action = np.zeros(action_dim, dtype=np.float32)
self.last_last_action = np.zeros(action_dim, dtype=np.float32)
self.target_height = 0.122
self.collapse_height_fraction = 0.55
self.tilt_failure_rad = 0.9
# Floating HUD & Leader Crown Visualizers self.start_position = [0.0, 0.0, 0.0]
self.hud = MetricsHUD(physics_client_id=self.sim_manager.physics_client) self.max_distance_from_start = 0.0
self.leader_crown = LeaderCrown(physics_client_id=self.sim_manager.physics_client) self.max_survival_steps = 0
self.default_joint_angles = np.zeros(18, dtype=np.float32)
self.curriculum_phase = CurriculumPhase.STAND_ONLY
self.curriculum_stage_requirements = {
CurriculumPhase.FORWARD: {"survival_steps": 300, "min_avg_height_ratio": 0.88, "max_avg_roll_pitch": 0.18},
CurriculumPhase.TURN_AND_DIRECTION: {"survival_steps": 500, "min_forward_distance": 2.5, "max_lateral_drift": 0.8, "min_avg_height_ratio": 0.85, "stability_roll_pitch": 0.25},
CurriculumPhase.OMNI_DIRECTION: {"survival_steps": 600, "min_distance": 5.0, "min_avg_height_ratio": 0.85, "stability_roll_pitch": 0.25},
CurriculumPhase.FULL_COMMAND: {"survival_steps": 750, "min_distance": 8.0, "min_avg_height_ratio": 0.85, "stability_roll_pitch": 0.20},
}
self.hud = MetricsHUD(physics_client_id=self.sim.physics_client)
self.last_time = time.time() self.last_time = time.time()
def _set_robot_color(self, pb_id: int, rgba: List[float]):
"""Helper to change the visual color of a robot body and all its links."""
num_joints = p.getNumJoints(pb_id, physicsClientId=self.sim_manager.physics_client)
p.changeVisualShape(pb_id, -1, rgbaColor=rgba, physicsClientId=self.sim_manager.physics_client)
for j in range(num_joints):
p.changeVisualShape(pb_id, j, rgbaColor=rgba, physicsClientId=self.sim_manager.physics_client)
def _robot_base_position(self, robot_id: int, num_robots: int = 1, spacing: float = 0.5) -> list[float]:
cols = int(math.sqrt(num_robots - 1)) + 1
row = robot_id // cols
col = robot_id % cols
x = (col - (cols - 1) / 2.0) * spacing
y = (row - (cols - 1) / 2.0) * spacing
return [x, y, 0.2]
def sample_command(self) -> np.ndarray: def sample_command(self) -> np.ndarray:
vx = np.random.uniform(-1.0, 1.0) """Samples a command vector [vx, vy, omega] based on active curriculum phase."""
vy = np.random.uniform(-0.5, 0.5) phase = self.curriculum_phase
vz = 0.0 stand_probs = {
omega = np.random.uniform(-1.0, 1.0) CurriculumPhase.STAND_ONLY: 1.0,
return np.array([vx, vy, vz, omega], dtype=np.float32) CurriculumPhase.FORWARD: 0.25,
CurriculumPhase.TURN_AND_DIRECTION: 0.20,
CurriculumPhase.OMNI_DIRECTION: 0.15,
CurriculumPhase.FULL_COMMAND: 0.15,
}
if np.random.random() < stand_probs.get(phase, 0.15):
return np.zeros(3, dtype=np.float32)
if phase == CurriculumPhase.FORWARD:
vx, vy, omega = np.random.uniform(0.15, 0.50), 0.0, 0.0
elif phase == CurriculumPhase.TURN_AND_DIRECTION:
vx, vy, omega = np.random.uniform(-0.8, 0.8), 0.0, np.random.uniform(-0.8, 0.8)
elif phase == CurriculumPhase.OMNI_DIRECTION:
vx, vy, omega = np.random.uniform(-0.8, 0.8), np.random.uniform(-0.5, 0.5), np.random.uniform(-0.8, 0.8)
else:
vx, vy, omega = np.random.uniform(-1.0, 1.0), np.random.uniform(-1.0, 1.0), np.random.uniform(-1.0, 1.0)
return np.array([vx, vy, omega], dtype=np.float32)
def reset(self, seed: Optional[int] = None, options: Optional[Dict[str, Any]] = None): def reset(self, seed: Optional[int] = None, options: Optional[Dict[str, Any]] = None):
super().reset(seed=seed) super().reset(seed=seed)
self.episode_count += 1 self.episode_count += 1
self.step_count = 0 self.step_count = 0
self.cumulative_reward = 0.0 self.cumulative_reward = 0.0
self.robot_rewards = [0.0 for _ in range(self.num_robots)] self.robot_reward = 0.0
self.failed_robots_mask = [False for _ in range(self.num_robots)] self.is_failed = False
if not self._first_reset: self.episode_height_sum = 0.0
p.resetSimulation(physicsClientId=self.sim_manager.physics_client) self.episode_roll_sum = 0.0
p.setGravity(0, 0, -9.81, physicsClientId=self.sim_manager.physics_client) self.episode_pitch_sum = 0.0
p.configureDebugVisualizer(p.COV_ENABLE_GUI, 0, physicsClientId=self.sim_manager.physics_client) self.last_reward_components = {}
self.hud.reset() self.episode_reward_components_sum = defaultdict(float)
self.leader_crown.reset()
self.plane, self.pb_robots, self.robot_joint_indices = self.sim_manager.load_scene( spawn_pos = [0.0, 0.0, 0.15]
self.urdf_path, self.num_robots, self.robot_spacing, self._robot_base_position spawn_orn = [0.0, 0.0, 0.0, 1.0]
)
for robot_obj, pb_id in zip(self.robots, self.pb_robots): # 1. Reset base pose and velocities
robot_obj.backend = PyBulletBackend(self.sim_manager, body_id=pb_id) self.sim.reset_robot_base(spawn_pos, spawn_orn)
else:
# 2. Reset internal kinematics & hard reset joints in PyBullet
self.robot.reset_to_init()
action_dim = self.action_space.shape[0]
self.last_action = np.zeros(action_dim, dtype=np.float32)
self.last_last_action = np.zeros(action_dim, dtype=np.float32)
self.max_distance_from_start = 0.0
self.max_survival_steps = 0
if self._first_reset:
self.curriculum_phase = CurriculumPhase.STAND_ONLY
self._first_reset = False self._first_reset = False
self.last_action = np.zeros(self.action_space.shape[0], dtype=np.float32) self.command = np.zeros(3, dtype=np.float32)
self.next_cmd_resample_step = self.initial_stand_steps
if self.random_command: pos, _ = self.sim.get_robot_pose()
self.commands = np.stack([self.sample_command() for _ in range(self.num_robots)]) self.start_position = list(pos)
else:
self.commands = np.zeros((self.num_robots, 4), dtype=np.float32)
for robot in self.robots: # Drop settlement
robot.reset_to_init() self.target_height = self.sim.settle_and_measure_height(
target_angles=self.robot.current_rad,
steps=300,
fallback_height=0.122
)
self.default_joint_angles = self.sim.get_robot_joint_angles()
self.default_action = np.clip(self.default_joint_angles / (np.pi / 2.0), -1.0, 1.0)
for _ in range(100): if self.use_gui:
self.sim_manager.step() self.hud.reset()
self._update_hud()
self._update_hud()
return self._get_obs(), {} return self._get_obs(), {}
def _get_obs(self) -> np.ndarray: def _get_obs(self) -> np.ndarray:
obs_list = [] # Read raw joint angles from backend
for idx, (pb_id, joint_indices) in enumerate(zip(self.pb_robots, self.robot_joint_indices)): raw_angles = np.asarray(self.robot.backend.get_joint_angles(), dtype=np.float32).flatten()
joint_states = p.getJointStates(
pb_id,
joint_indices,
physicsClientId=self.sim_manager.physics_client
)
joint_angles = np.array([state[0] for state in joint_states], dtype=np.float32)
robot_obs = np.concatenate([joint_angles, self.commands[idx]])
obs_list.append(robot_obs)
return np.concatenate(obs_list).astype(np.float32) min_lim = self.min_joint_limits.flatten()
max_lim = self.max_joint_limits.flatten()
# Map raw joint radians [min, max] -> normalized [-1, 1]
normalized_joints = 2.0 * (raw_angles - min_lim) / (max_lim - min_lim) - 1.0
normalized_joints = np.clip(normalized_joints, -1.0, 1.0)
# Concatenate normalized joints with active command vector
obs = np.concatenate([normalized_joints, self.command]).astype(np.float32)
return obs
def step(self, action: np.ndarray) -> Tuple[np.ndarray, float, bool, bool, Dict[str, Any]]: def step(self, action: np.ndarray) -> Tuple[np.ndarray, float, bool, bool, Dict[str, Any]]:
previous_action = self.last_action.copy()
self.step_count += 1 self.step_count += 1
self.total_steps += 1 self.total_steps += 1
self.last_last_action = self.last_action.copy()
self.last_action = action.copy() self.last_action = action.copy()
action_per_robot = action.reshape(self.num_robots, 18) # Command resampling ONLY if random_command is True
if self.random_command and (
self.step_count >= self.next_cmd_resample_step or self._curriculum_advanced):
self.command = self.sample_command()
random_interval = np.random.randint(self.min_cmd_hold_steps, self.max_cmd_hold_steps + 1)
self.next_cmd_resample_step = self.step_count + random_interval
for robot, act in zip(self.robots, action_per_robot): # Extract active [vx, vy, omega]
robot.apply_rl_action(act) cmd_vx, cmd_vy, cmd_omega = self.command
self.sim_manager.step() # Mirror input resolution logic to keep robot state synchronized
self.robot.robot_state = "walking" if (abs(cmd_vx) > 0.01 or abs(cmd_vy) > 0.01 or abs(cmd_omega) > 0.01) else "idle"
self.robot.vector_dirmov = [float(cmd_vx), float(cmd_vy), float(cmd_omega)]
# Update failure status & gray coloring # Direct Mode: Target joint scaling
self._update_robot_failures() action_flat = np.asarray(action, dtype=np.float32).flatten()
action_clipped = np.clip(action_flat, -1.0, 1.0)
if self.robot_mode == "direct":
# Map [-1, 1] linearly to physical joint limits [min, max]
min_lim = self.min_joint_limits.flatten()
max_lim = self.max_joint_limits.flatten()
target_angles = min_lim + (action_clipped + 1.0) * 0.5 * (max_lim - min_lim)
else:
# Residual mode mapping logic
target_angles = self.default_joint_angles.flatten() + action_clipped * 0.20
# Apply target joint angles to physics engine
self.robot.tick(action=target_angles, physics_substeps=4)
if self.robot_mode != "kinematics" and self.step_count % 60 == 0:
random_force = np.random.uniform(-2.0, 2.0, size=2)
self.sim.apply_external_force(force=[random_force[0], random_force[1], 0.0])
self._update_robot_failure()
self._update_distance_metrics()
self._update_curriculum()
# Build next observation preserving active command
obs = self._get_obs() obs = self._get_obs()
reward, per_robot_step_rewards = self._compute_reward() reward = self._compute_reward(action_flat, previous_action)
self.cumulative_reward += reward self.cumulative_reward += reward
for idx, r_step in enumerate(per_robot_step_rewards): self.robot_reward += reward
self.robot_rewards[idx] += r_step
terminated = self._is_done() terminated = self.is_failed
truncated = self.step_count >= self.max_episode_steps truncated = self.step_count >= self.max_episode_steps
info = {"reward_components": self.last_reward_components.copy()}
self._update_hud() if self.step_count % 120 == 0 and self.use_gui:
self._update_leader_visuals() self._update_hud()
return obs, reward, terminated, truncated, {}
def _compute_reward(self) -> Tuple[float, list[float]]: if self.use_gui:
rewards = [] time.sleep(1.0 / self.control_freq)
for idx, pb_id in enumerate(self.pb_robots):
linear_vel, angular_vel = p.getBaseVelocity(pb_id, physicsClientId=self.sim_manager.physics_client)
_, orientation = p.getBasePositionAndOrientation(pb_id, physicsClientId=self.sim_manager.physics_client)
roll, pitch, _ = p.getEulerFromQuaternion(orientation)
command = self.commands[idx]
forward_reward = command[0] * linear_vel[0] + command[1] * linear_vel[1] return obs, reward, terminated, truncated, info
rotation_reward = command[3] * angular_vel[2]
stability_penalty = abs(roll) + abs(pitch)
action_penalty = float(np.sum(np.square(self.last_action.reshape(self.num_robots, -1)[idx]))) * 0.01
r_step = 0.1 + forward_reward + rotation_reward - 0.2 * stability_penalty - action_penalty def _update_distance_metrics(self):
rewards.append(r_step) pos, _ = self.sim.get_robot_pose()
self.episode_height_sum += float(pos[2])
start_x, start_y, _ = self.start_position
dist = float(np.linalg.norm(np.array([pos[0] - start_x, pos[1] - start_y], dtype=np.float32)))
self.max_distance_from_start = max(self.max_distance_from_start, dist)
self.max_survival_steps = max(self.max_survival_steps, self.step_count)
return float(np.sum(rewards)), rewards def _phase_progress_ready(self, next_phase: CurriculumPhase) -> bool:
if next_phase not in self.curriculum_stage_requirements:
return False
def _is_done(self) -> bool: req = self.curriculum_stage_requirements[next_phase]
"""Returns True only when the percentage of failed robots exceeds the threshold.""" survival_ok = self.max_survival_steps >= req["survival_steps"]
failed_count = sum(self.failed_robots_mask) avg_roll = self.episode_roll_sum / max(1, self.step_count)
failure_ratio = failed_count / self.num_robots avg_pitch = self.episode_pitch_sum / max(1, self.step_count)
return failure_ratio >= self.termination_threshold max_allowed_angle = req.get("max_avg_roll_pitch", 0.20)
stability_ok = (avg_roll <= max_allowed_angle) and (avg_pitch <= max_allowed_angle)
avg_height = self.episode_height_sum / max(1, self.step_count)
required_min_avg_height = self.target_height * req.get("min_avg_height_ratio", 0.85)
height_ok = avg_height >= required_min_avg_height
pos, _ = self.sim.get_robot_pose()
dx, dy = pos[0] - self.start_position[0], pos[1] - self.start_position[1]
dist_2d = math.hypot(dx, dy)
distance_ok = True
if "min_forward_distance" in req:
distance_ok = dx >= req["min_forward_distance"]
elif "min_distance" in req:
distance_ok = dist_2d >= req["min_distance"]
drift_ok = abs(dy) <= req["max_lateral_drift"] if "max_lateral_drift" in req else True
return survival_ok and height_ok and stability_ok and distance_ok and drift_ok
def _update_curriculum(self):
self._curriculum_advanced = False
if self.curriculum_phase < CurriculumPhase.FORWARD and (self._phase_progress_ready(CurriculumPhase.FORWARD)):
self.curriculum_phase = CurriculumPhase.FORWARD
self._curriculum_advanced = True
elif self.curriculum_phase < CurriculumPhase.TURN_AND_DIRECTION and self._phase_progress_ready(CurriculumPhase.TURN_AND_DIRECTION):
self.curriculum_phase = CurriculumPhase.TURN_AND_DIRECTION
self._curriculum_advanced = True
elif self.curriculum_phase < CurriculumPhase.OMNI_DIRECTION and self._phase_progress_ready(CurriculumPhase.OMNI_DIRECTION):
self.curriculum_phase = CurriculumPhase.OMNI_DIRECTION
self._curriculum_advanced = True
elif self.curriculum_phase < CurriculumPhase.FULL_COMMAND and self._phase_progress_ready(CurriculumPhase.FULL_COMMAND):
self.curriculum_phase = CurriculumPhase.FULL_COMMAND
self._curriculum_advanced = True
def _compute_reward(self, action: np.ndarray, previous_action: np.ndarray) -> float:
pos, (roll, pitch, yaw) = self.sim.get_robot_pose_and_rpy()
linear_vel, angular_vel = self.sim.get_robot_velocity()
current_joints = self.sim.get_robot_joint_angles()
cmd_vx, cmd_vy, cmd_yaw = self.command
cmd_norm = math.hypot(cmd_vx, cmd_vy)
raw_speed = math.hypot(linear_vel[0], linear_vel[1])
# Forgiving zones: ignore noise below 0.04 m/s and 0.05 rad/s
filtered_vx, filtered_vy = (linear_vel[0], linear_vel[1]) if raw_speed >= 0.04 else (0.0, 0.0)
filtered_speed = raw_speed if raw_speed >= 0.04 else 0.0
raw_yaw_rate = abs(angular_vel[2])
filtered_yaw_rate = raw_yaw_rate if raw_yaw_rate >= 0.05 else 0.0
# --- 1. FIXED JITTER PENALTY ---
# Scaled way down (0.005) and capped so it can never dominate the reward
action_accel = action - 2.0 * self.last_action + self.last_last_action
raw_jitter = float(np.mean(np.square(action_accel)))
jitter_penalty = -0.005 * min(raw_jitter, 10.0)
# --- Base Components ---
height_error = pos[2] - self.target_height
r_height = math.exp(-150.0 * (height_error ** 2))
r_stability = math.exp(-25.0 * (roll**2 + pitch**2))
r_pose = math.exp(-2.0 * np.mean(np.square(current_joints - self.default_joint_angles)))
r_smoothness = math.exp(-0.1 * np.mean(np.square(action - previous_action)))
r_lin_vel, r_ang_vel, stillness_penalty = 0.0, 0.0, 0.0
stand_penalty = 0.0
# --- 2. COMMAND IS ZERO: STANDING MODE ---
if cmd_norm < 0.05 and abs(cmd_yaw) < 0.05:
w_height, w_stability, w_pose, w_smoothness = 0.35, 0.35, 0.20, 0.10
base_reward = (w_height * r_height) + (w_stability * r_stability) + (w_pose * r_pose) + (w_smoothness * r_smoothness)
# Soft quadratic penalty on filtered speed (gives a forgiving gap near 0)
stand_penalty = -0.5 * filtered_speed - 0.1 * filtered_yaw_rate
total_reward = base_reward + stand_penalty
# --- 3. COMMAND IS NON-ZERO: WALKING MODE ---
else:
is_moving = (filtered_speed > 0.0) or (filtered_yaw_rate > 0.0)
target_vx, target_vy = cmd_vx * self.max_robot_speed, cmd_vy * self.max_robot_speed
target_speed = math.hypot(target_vx, target_vy)
if not is_moving:
# If the command says move but the robot stays effectively still,
# give a real penalty instead of a neutral reward.
stillness_penalty = -0.10
total_reward = stillness_penalty
else:
lin_vel_error = (filtered_vx - target_vx)**2 + (filtered_vy - target_vy)**2
r_lin_vel = math.exp(-25.0 * lin_vel_error)
r_ang_vel = math.exp(-15.0 * ((filtered_yaw_rate - cmd_yaw)**2))
if target_speed > 0.08 and raw_speed < 0.03:
r_lin_vel = 0.0
stillness_penalty = -0.05
w_lin_vel, w_ang_vel, w_height, w_stability, w_smoothness = 0.55, 0.15, 0.10, 0.12, 0.08
total_reward = (
(w_lin_vel * r_lin_vel) + (w_ang_vel * r_ang_vel) + (w_height * r_height)
+ (w_stability * r_stability) + (w_smoothness * r_smoothness) + stillness_penalty
)
step_reward = float(total_reward / 10.0)
alive_bonus = 0.01
final_reward = step_reward + jitter_penalty + alive_bonus
self.last_reward_components = {
"height": float(r_height),
"stability": float(r_stability),
"pose": float(r_pose),
"smoothness": float(r_smoothness),
"lin_vel": float(r_lin_vel),
"ang_vel": float(r_ang_vel),
"jitter_penalty": float(jitter_penalty),
"stand_penalty": float(stand_penalty),
"stillness_penalty": float(stillness_penalty),
"total": final_reward,
}
for k, v in self.last_reward_components.items():
self.episode_reward_components_sum[k] += v
return final_reward
def get_reward_component_averages(self) -> Dict[str, float]:
steps = max(1, self.step_count)
return {k: v / steps for k, v in self.episode_reward_components_sum.items()}
def get_current_robot_metrics(self) -> List[Dict[str, Any]]:
linear_vel, angular_vel = self.sim.get_robot_velocity()
speed = float(math.hypot(linear_vel[0], linear_vel[1]))
yaw_rate = float(abs(angular_vel[2]))
metrics = {
"alive": not self.is_failed,
"phase_name": self.curriculum_phase.name,
"reward": float(self.cumulative_reward),
"speed": speed,
"yaw_rate": yaw_rate,
"distance_from_start": float(self.max_distance_from_start),
"survival_steps": int(self.max_survival_steps),
}
return [metrics]
def _update_hud(self): def _update_hud(self):
if not self.use_gui or not self.pb_robots: if not self.use_gui:
return return
now = time.time() now = time.time()
fps = 1.0 / max(now - self.last_time, 1e-5) fps = 1.0 / max(now - self.last_time, 1e-5)
self.last_time = now self.last_time = now
pos, (roll, pitch, _) = self.sim.get_robot_pose_and_rpy()
heights = []
rolls = []
pitches = []
for pb_id in self.pb_robots:
pos, orient = p.getBasePositionAndOrientation(pb_id, physicsClientId=self.sim_manager.physics_client)
roll, pitch, _ = p.getEulerFromQuaternion(orient)
heights.append(pos[2])
rolls.append(math.degrees(roll))
pitches.append(math.degrees(pitch))
avg_height = float(np.mean(heights))
avg_roll_pitch = (float(np.mean(rolls)), float(np.mean(pitches)))
self.hud.update( self.hud.update(
episode=self.episode_count, episode=self.episode_count, step=self.total_steps, robot_rewards=[self.robot_reward],
step=self.total_steps, cmd_vel=self.command, fps=fps, height=pos[2], roll_pitch=(math.degrees(roll), math.degrees(pitch))
robot_rewards=self.robot_rewards,
cmd_vel=self.commands[0],
fps=fps,
avg_height=avg_height,
roll_pitch=avg_roll_pitch
) )
def _update_leader_visuals(self): def _update_robot_failure(self):
"""Positions floating crown above top robot without altering active materials.""" if self.is_failed:
if not self.use_gui or self.num_robots <= 1:
return return
best_idx = int(np.argmax(self.robot_rewards)) position, (roll, pitch, _) = self.sim.get_robot_pose_and_rpy()
leader_pb_id = self.pb_robots[best_idx] collapse_threshold = max(0.04, self.collapse_height_fraction * self.target_height)
leader_pos, _ = p.getBasePositionAndOrientation( is_tilted = abs(roll) > self.tilt_failure_rad or abs(pitch) > self.tilt_failure_rad
leader_pb_id, physicsClientId=self.sim_manager.physics_client is_collapsed = position[2] < collapse_threshold
)
self.leader_crown.update(leader_pos)
def _update_robot_failures(self): if is_tilted or is_collapsed:
"""Checks failure condition for each robot and turns failed ones gray.""" self.is_failed = True
for idx, pb_id in enumerate(self.pb_robots):
if self.failed_robots_mask[idx]:
continue # Already marked failed
position, orientation = p.getBasePositionAndOrientation(
pb_id, physicsClientId=self.sim_manager.physics_client
)
roll, pitch, _ = p.getEulerFromQuaternion(orientation)
is_tilted = abs(roll) > 0.7 or abs(pitch) > 0.7
is_collapsed = position[2] < 0.05
if is_tilted or is_collapsed:
self.failed_robots_mask[idx] = True
if self.use_gui:
# Turn failed robot semi-transparent dark gray
self._set_robot_color(pb_id, COLOR_FAILED)
def close(self): def close(self):
self.sim_manager.disconnect() self.sim.disconnect()
-78
View File
@@ -1,78 +0,0 @@
import argparse
import numpy as np
from .env import JackBotEnv
def evaluate(
model_path: str,
episodes: int = 5,
use_gui: bool = False,
num_robots: int = 1,
robot_spacing: float = 0.5,
start_pose: str = "init_deg",
):
try:
from stable_baselines3 import PPO
except ImportError as exc:
raise ImportError(
"stable-baselines3 is required for evaluation. Install with: pip install stable-baselines3"
) from exc
env = JackBotEnv(
use_gui=use_gui,
random_command=False,
num_robots=num_robots,
robot_spacing=robot_spacing,
start_pose=start_pose,
)
model = PPO.load(model_path)
for episode in range(episodes):
reset_res = env.reset()
# handle Gym / Gymnasium compatibility: reset may return (obs, info)
if isinstance(reset_res, tuple) and len(reset_res) == 2:
obs, _ = reset_res
else:
obs = reset_res
done = False
episode_reward = 0.0
while not done:
# pass only the observation to the policy
action, _ = model.predict(obs, deterministic=True)
step_res = env.step(action)
# Gymnasium-style: (obs, reward, terminated, truncated, info)
if isinstance(step_res, tuple) and len(step_res) == 5:
obs, reward, terminated, truncated, info = step_res
done = bool(terminated or truncated)
else:
# legacy Gym: (obs, reward, done, info)
obs, reward, done, info = step_res
episode_reward += float(reward)
print(f"Episode {episode + 1}: reward={episode_reward:.2f}")
env.close()
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="Evaluate a trained JackBot policy.")
parser.add_argument("--model-path", type=str, required=True)
parser.add_argument("--episodes", type=int, default=5)
parser.add_argument("--gui", action="store_true")
parser.add_argument("--num-robots", type=int, default=1, help="Number of robots in the environment")
parser.add_argument("--robot-spacing", type=float, default=0.5, help="Spacing between robots in meters")
parser.add_argument("--start-pose", type=str, choices=["init_deg", "init90_deg"], default="init_deg", help="Initial robot pose at reset")
args = parser.parse_args()
evaluate(
args.model_path,
episodes=args.episodes,
use_gui=args.gui,
num_robots=args.num_robots,
robot_spacing=args.robot_spacing,
start_pose=args.start_pose,
)
Binary file not shown.
-49
View File
@@ -1,49 +0,0 @@
import torch
import torch.nn as nn
from torch.distributions import Normal
class ActorCritic(nn.Module):
def __init__(self, obs_dim: int, action_dim: int, hidden_sizes=(256, 256)):
super().__init__()
self.backbone = nn.Sequential(
nn.Linear(obs_dim, hidden_sizes[0]),
nn.ReLU(),
nn.Linear(hidden_sizes[0], hidden_sizes[1]),
nn.ReLU(),
)
self.mean_head = nn.Linear(hidden_sizes[1], action_dim)
self.value_head = nn.Linear(hidden_sizes[1], 1)
self.log_std = nn.Parameter(torch.zeros(action_dim, dtype=torch.float32))
def forward(self, obs: torch.Tensor):
x = self.backbone(obs)
mean = self.mean_head(x)
std = self.log_std.exp()
value = self.value_head(x).squeeze(-1)
return mean, std, value
def get_action(self, obs: torch.Tensor):
mean, std, value = self.forward(obs)
dist = Normal(mean, std)
action = dist.sample()
log_prob = dist.log_prob(action).sum(-1)
return action, log_prob, value
def evaluate_actions(self, obs: torch.Tensor, actions: torch.Tensor):
mean, std, value = self.forward(obs)
dist = Normal(mean, std)
log_prob = dist.log_prob(actions).sum(-1)
entropy = dist.entropy().sum(-1)
return value, log_prob, entropy
def save(self, path: str):
torch.save(self.state_dict(), path)
@classmethod
def load(cls, path: str, obs_dim: int, action_dim: int, hidden_sizes=(256, 256)):
model = cls(obs_dim, action_dim, hidden_sizes)
model.load_state_dict(torch.load(path, map_location=torch.device("cpu")))
model.eval()
return model
+155
View File
@@ -0,0 +1,155 @@
"""
ml/pretrain_bc.py - Behavioral Cloning teacher-data pipeline.
This script collects observation/action pairs from the kinematics solver, then uses
those pairs as training data for a PPO policy. In practice it serves as a teacher-
student pretraining step: the kinematics controller generates sample trajectories, and
this file teaches the policy to imitate those behavior patterns before PPO training.
"""
import sys
import time
import argparse
from pathlib import Path
import numpy as np
import torch
import torch.nn as nn
from torch.utils.data import DataLoader, TensorDataset
from stable_baselines3 import PPO
from tqdm import tqdm # <--- Progress Bar Support
# Ensure project root is in sys.path
sys.path.append(str(Path(__file__).resolve().parent.parent))
from ml.env import JackBotEnv, CurriculumPhase
def collect_kinematics_dataset(num_samples: int = 100_000, use_gui: bool = False):
"""Collects (Observation, Action) pairs directly from Kinematics Teacher."""
print(f"\n[Pretrain] Collecting {num_samples} samples from Kinematics Teacher (GUI={use_gui})...")
# Disable random command resampling inside env.step so manual command locks persist
env = JackBotEnv(use_gui=use_gui, robot_mode="kinematics", random_command=False)
env.curriculum_phase = CurriculumPhase.FULL_COMMAND
observations = []
actions = []
obs, _ = env.reset()
# --- PROGRESS BAR: Data Collection ---
pbar = tqdm(range(num_samples), desc=" Collecting Data", unit="step")
for i in pbar:
# 1. Update command and vector targets every 120 steps
if i % 120 == 0:
env.command = env.sample_command()
cmd_vx, cmd_vy, cmd_omega = env.command
env.robot.robot_state = (
"walking"
if (abs(cmd_vx) > 0.01 or abs(cmd_vy) > 0.01 or abs(cmd_omega) > 0.01)
else "idle"
)
env.robot.vector_dirmov = [float(cmd_vx), float(cmd_vy), float(cmd_omega)]
# 2. Capture observation BEFORE stepping environment
current_obs = env._get_obs()
# 3. Step environment ONCE (updates kinematics solver, PyBullet physics, and computes IK)
obs, _, terminated, truncated, _ = env.step(np.zeros(18, dtype=np.float32))
# 4. Extract procedural IK joint targets computed during this step
target_ik_rad = env.robot.current_rad.data.flatten().copy()
# Step 5: Convert target radians directly to [-1, 1] relative to joint limits
min_lim = env.min_joint_limits.flatten()
max_lim = env.max_joint_limits.flatten()
normalized_action = 2.0 * (target_ik_rad - min_lim) / (max_lim - min_lim) - 1.0
normalized_action = np.clip(normalized_action, -1.0, 1.0)
# Step 6: Store matching input (obs) and target ground truth (normalized_action)
observations.append(current_obs.copy())
actions.append(normalized_action.copy())
if use_gui:
time.sleep(1.0 / 60.0)
# 7. Handle episode boundaries using terminated and truncated
if terminated or truncated:
obs, _ = env.reset()
env.close()
print("[Pretrain] Data collection complete!\n")
return np.array(observations, dtype=np.float32), np.array(actions, dtype=np.float32)
def pretrain_policy(
save_path: str = "ml/checkpoints/jackbot_kinematics_base.zip",
epochs: int = 15,
batch_size: int = 256,
num_samples: int = 100_000,
use_gui: bool = False
):
# Collect dataset from Kinematics teacher
obs_data, action_data = collect_kinematics_dataset(num_samples=num_samples, use_gui=use_gui)
# Initialize Dummy Env & Fresh SB3 PPO Model
dummy_env = JackBotEnv(use_gui=False, robot_mode="direct")
model = PPO("MlpPolicy", dummy_env, learning_rate=5e-4, verbose=0, device="cpu")
# Extract PyTorch Policy Network & Optimizer
policy = model.policy
optimizer = torch.optim.Adam(policy.parameters(), lr=5e-4)
loss_fn = nn.MSELoss()
# Convert to PyTorch Dataloader
dataset = TensorDataset(torch.tensor(obs_data), torch.tensor(action_data))
loader = DataLoader(dataset, batch_size=batch_size, shuffle=True)
print(f"[Pretrain] Pre-training Policy Network ({epochs} Epochs)...")
policy.train()
# --- PROGRESS BAR: Epoch Training ---
for epoch in range(epochs):
epoch_loss = 0.0
batch_pbar = tqdm(loader, desc=f" Epoch {epoch + 1:02d}/{epochs:02d}", leave=True, unit="batch")
for batch_obs, batch_actions in batch_pbar:
optimizer.zero_grad()
distribution = policy.get_distribution(batch_obs)
predicted_actions = distribution.distribution.mean
loss = loss_fn(predicted_actions, batch_actions)
loss.backward()
optimizer.step()
current_loss = loss.item()
epoch_loss += current_loss * len(batch_obs)
# Dynamic loss update in progress bar tail
batch_pbar.set_postfix({"loss": f"{current_loss:.6f}"})
avg_loss = epoch_loss / len(dataset)
tqdm.write(f" └─ Epoch {epoch + 1:02d}/{epochs:02d} Complete | Mean MSE Loss: {avg_loss:.6f}")
# Save SB3 Model Checkpoint
out_file = Path(save_path)
out_file.parent.mkdir(parents=True, exist_ok=True)
model.save(out_file)
dummy_env.close()
print(f"\n[Pretrain] Successfully saved pre-trained base model to: {out_file.resolve()}")
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="JackBot Behavioral Cloning Pre-trainer")
parser.add_argument("--gui", action="store_true", help="Enable PyBullet 3D visual GUI rendering during collection")
parser.add_argument("--num-samples", type=int, default=100_000, help="Number of dataset samples to collect")
parser.add_argument("--epochs", type=int, default=15, help="Number of BC training epochs")
parser.add_argument("--save-path", type=str, default="ml/checkpoints/jackbot_kinematics_base.zip", help="Output path for pre-trained model .zip")
args = parser.parse_args()
pretrain_policy(
save_path=args.save_path,
epochs=args.epochs,
num_samples=args.num_samples,
use_gui=args.gui
)
+135 -21
View File
@@ -1,39 +1,153 @@
"""Run a trained policy in the PyBullet sim for quick inspection. """
ml/run_eval.py - Evaluate a saved JackBot policy across fixed command phases.
Usage: This script loads a trained PPO checkpoint, instantiates the Gymnasium environment in
python ml/run_eval.py --model ml/checkpoints/ppo_joint_command.zip --episodes 3 --gui non-random mode, and runs deterministic evaluation episodes for several command
regimes. It is used to measure whether a policy can survive, move, and maintain
stability under forward, turning, lateral, and omni-direction commands.
""" """
import argparse import argparse
import json
import time
import sys import sys
from pathlib import Path from pathlib import Path
import numpy as np
from stable_baselines3 import PPO
ROOT_DIR = Path(__file__).resolve().parent.parent # Ensure project root is in sys.path
if str(ROOT_DIR) not in sys.path: sys.path.append(str(Path(__file__).resolve().parent.parent))
sys.path.insert(0, str(ROOT_DIR)) from ml.env import JackBotEnv, CurriculumPhase
from ml.evaluate import evaluate
def main(): def main():
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser(description="JackBot Phase-by-Phase Policy Evaluator")
parser.add_argument("--model", type=str, required=True, help="Path to the trained model file (.zip)") parser.add_argument("--model", type=str, required=True, help="Path to trained model checkpoint (.zip)")
parser.add_argument("--episodes", type=int, default=3, help="Number of 'rounds' to run. One episode lasts from reset until the robot falls over or the time limit is reached.") parser.add_argument("--episodes-per-phase", type=int, default=1, help="Number of test episodes per phase")
parser.add_argument("--gui", action="store_true", help="Show the PyBullet GUI during evaluation") parser.add_argument("--max-steps-per-episode", type=int, default=600, help="Max simulation steps per episode")
parser.add_argument("--num-robots", type=int, default=1, help="Number of robots in the evaluation environment") parser.add_argument("--gui", action="store_true", help="Enable PyBullet 3D visual GUI rendering")
parser.add_argument("--robot-spacing", type=float, default=0.5, help="Spacing between robots in meters") parser.add_argument("--save-metrics", type=str, default=None, help="Optional JSON path to save evaluation summary")
parser.add_argument("--start-pose", type=str, choices=["init_deg", "init90_deg"], default="init_deg", help="Initial robot pose at reset")
args = parser.parse_args() args = parser.parse_args()
evaluate( print(f"[Eval] Loading policy model from: {args.model}")
model_path=args.model, model = PPO.load(args.model, device="cpu")
episodes=args.episodes,
# Instantiate environment with random_command disabled so our test command stays locked
env = JackBotEnv(
use_gui=args.gui, use_gui=args.gui,
num_robots=args.num_robots, random_command=False,
robot_spacing=args.robot_spacing, max_episode_steps=args.max_steps_per_episode,
start_pose=args.start_pose, robot_mode="direct"
) )
# Multi-Phase Configurations Suite
phase_configs = [
#(CurriculumPhase.STAND_ONLY, "STAND", np.array([0.0, 0.0, 0.0], dtype=np.float32)),
(CurriculumPhase.FORWARD, "FORWARD GAIT", np.array([1.0, 0.0, 0.0], dtype=np.float32)),
(CurriculumPhase.TURN_AND_DIRECTION, "FORWARD + YAW TURN", np.array([0.5, 0.0, 0.4], dtype=np.float32)),
(CurriculumPhase.OMNI_DIRECTION, "STRIDE LATERAL", np.array([0.5, 0.5, 0.0], dtype=np.float32)),
(CurriculumPhase.FULL_COMMAND, "FULL OMNI COMBINATION", np.array([0.3, 0.2, 0.3], dtype=np.float32)),
]
phase_summary = []
try:
print("\n" + "=" * 75)
print(" STARTING MULTI-PHASE EVALUATION SUITE")
print("=" * 75)
for phase_enum, phase_name, test_cmd in phase_configs:
print(f"\n▶ Testing Phase [{phase_enum.value}]: {phase_enum.name} ({phase_name})")
print(f" Target Command Vector [vx, vy, omega]: {test_cmd.tolist()}")
ep_rewards = []
ep_steps = []
ep_distances = []
for ep in range(args.episodes_per_phase):
obs, _ = env.reset()
# Force environment into active curriculum phase and lock command BEFORE getting obs
env.curriculum_phase = phase_enum
env.command = test_cmd.copy()
cmd_vx, cmd_vy, cmd_omega = test_cmd
env.robot.robot_state = (
"walking"
if (abs(cmd_vx) > 0.01 or abs(cmd_vy) > 0.01 or abs(cmd_omega) > 0.01)
else "idle"
)
env.robot.vector_dirmov = [float(cmd_vx), float(cmd_vy), float(cmd_omega)]
# Get correct observation with test_cmd attached
obs = env._get_obs()
done = False
total_reward = 0.0
steps = 0
while not done:
# Predict deterministic action from policy
action, _ = model.predict(obs, deterministic=True)
# Step environment
obs, reward, terminated, truncated, _ = env.step(action)
done = terminated or truncated
total_reward += float(reward)
steps += 1
if args.gui:
time.sleep(1.0 / 60.0)
status_str = "FAILED (Collapsed)" if terminated else "SUCCESS (Completed)"
dist = float(env.max_distance_from_start)
print(
f" └─ Ep {ep + 1}/{args.episodes_per_phase}: {status_str:<19} | "
f"Steps: {steps:<4} | Reward: {total_reward:+.2f} | Max Dist: {dist:.2f}m"
)
ep_rewards.append(total_reward)
ep_steps.append(steps)
ep_distances.append(dist)
phase_summary.append({
"phase_id": phase_enum.value,
"phase_name": phase_enum.name,
"label": phase_name,
"command": test_cmd.tolist(),
"mean_reward": float(np.mean(ep_rewards)),
"mean_steps": float(np.mean(ep_steps)),
"mean_distance": float(np.mean(ep_distances)),
})
finally:
env.close()
# Print Summary Table
print("\n" + "=" * 80)
print(" EVALUATION SUMMARY REPORT")
print("=" * 80)
print(f"{'Phase ID & Name':<25} | {'Label':<22} | {'Reward':<8} | {'Steps':<6} | {'Max Dist':<8}")
print("-" * 80)
for res in phase_summary:
phase_str = f"[{res['phase_id']}] {res['phase_name']}"
print(
f"{phase_str:<25} | "
f"{res['label']:<22} | "
f"{res['mean_reward']:<+8.2f} | "
f"{res['mean_steps']:<6.0f} | "
f"{res['mean_distance']:<8.2f}m"
)
print("=" * 80)
# Save JSON Report if requested
if args.save_metrics:
out_path = Path(args.save_metrics)
out_path.parent.mkdir(parents=True, exist_ok=True)
with open(out_path, "w") as f:
json.dump({"model_path": str(args.model), "summary": phase_summary}, f, indent=4)
print(f"\n[Eval] Saved report to: {out_path.resolve()}")
if __name__ == "__main__": if __name__ == "__main__":
main() main()
+78
View File
@@ -0,0 +1,78 @@
"""
ml/run_eval_training.py - Run a kinematics-mode reward benchmark.
This script repeatedly resets the JackBot environment in kinematics mode and applies
fixed command vectors for each curriculum phase. It is intended as a lightweight
benchmark to inspect reward components, movement quality, and survival behavior without
requiring an already-trained PPO model.
"""
import time
import numpy as np
import sys
from pathlib import Path
sys.path.append(str(Path(__file__).resolve().parent.parent))
from ml.env import JackBotEnv, CurriculumPhase
def evaluate_kinematics(episode_length: int = 1000):
env = JackBotEnv(
use_gui=True,
random_command=False,
max_episode_steps=episode_length,
robot_mode="kinematics"
)
print("\n" + "=" * 70)
print(" RUNNING MULTI-PHASE REWARD BENCHMARK (KINEMATICS MODE)")
print("=" * 70 + "\n")
phase_configs = [
(CurriculumPhase.STAND_ONLY, "STAND", np.array([1.0, 0.0, 0.0], dtype=np.float32)),
(CurriculumPhase.FORWARD, "FORWARD GAIT", np.array([1.0, 0.0, 0.0], dtype=np.float32)),
(CurriculumPhase.TURN_AND_DIRECTION, "FORWARD + YAW TURN", np.array([0.5, 0.0, 0.4], dtype=np.float32)),
(CurriculumPhase.OMNI_DIRECTION, "STRIDE LATERAL", np.array([0.5, 0.5, 0.0], dtype=np.float32)),
(CurriculumPhase.FULL_COMMAND, "FULL OMNI COMBINATION",np.array([0.3, 0.2, 0.3], dtype=np.float32)),
]
for phase_enum, label, cmd in phase_configs:
obs, _ = env.reset()
env.curriculum_phase = phase_enum
env.command = cmd.copy()
done = False
total_reward = 0.0
step_count = 0
while not done:
dummy_action = np.zeros(18, dtype=np.float32)
obs, reward, terminated, truncated, _ = env.step(dummy_action)
total_reward += reward
step_count += 1
done = terminated or truncated
time.sleep(1.0 / 60.0)
comp_averages = env.get_reward_component_averages()
print(f"\n--- Episode Stage: [{phase_enum.name}] ({label}) ---")
print(f"Command Applied: vx={cmd[0]:.2f}, vy={cmd[1]:.2f}, yaw={cmd[2]:.2f}")
print(f"Total Episode Reward: {total_reward:.4f}")
print("Component Step Averages:")
for name, value in comp_averages.items():
print(f" • {name:<20}: {value:+.5f}")
metrics = env.get_current_robot_metrics()
dist = metrics[0]["distance_from_start"] if metrics else 0.0
speed = metrics[0]["speed"] if metrics else 0.0
avg_reward = total_reward / max(1, step_count)
print(f" ├─ Average Reward / Step: {avg_reward:.4f}")
print(f" ├─ Distance Travelled: {dist:.2f} m")
print(f" ├─ Actual Avg Speed: {speed:.2f} m/s")
print(f" └─ Steps Survived: {step_count} / {episode_length}")
print("-" * 70)
env.close()
if __name__ == "__main__":
evaluate_kinematics()
+142 -28
View File
@@ -1,46 +1,160 @@
"""Minimal training launcher for quick experiments. """PPO training launcher for JackBot.
This script is the main entry point for training a policy in the JackBot Gymnasium
environment. It creates a vectorized environment, optionally loads a pretrained base
model, runs Stable-Baselines3 PPO for a configured number of timesteps, and saves
checkpoints plus evaluation artifacts during training.
Usage: Usage:
python ml/run_train.py --timesteps 50000 --model ml/checkpoints/ppo_joint_command python ml/run_train.py --total-timesteps 1500000 --gui
This is a convenience wrapper around `ml.train.train` with friendly defaults
for interactive experimentation.
""" """
import argparse import argparse
import os
import re
import sys import sys
import warnings
from pathlib import Path from pathlib import Path
from stable_baselines3 import PPO
from stable_baselines3.common.vec_env import SubprocVecEnv, DummyVecEnv
from stable_baselines3.common.callbacks import CheckpointCallback, EvalCallback
ROOT_DIR = Path(__file__).resolve().parent.parent sys.path.append(str(Path(__file__).resolve().parent.parent))
if str(ROOT_DIR) not in sys.path: from ml.env import JackBotEnv
sys.path.insert(0, str(ROOT_DIR)) from ml.callbacks import CurriculumCallback, RewardLoggerCallback
from ml.train import train # Silence SB3's UserWarning about SubprocVecEnv vs DummyVecEnv
warnings.filterwarnings("ignore", category=UserWarning, module="stable_baselines3")
def get_next_run_number(save_dir: str) -> int:
"""Scans the save directory for existing ppo<number> patterns and returns the next integer."""
if not os.path.exists(save_dir):
return 1
existing_numbers = []
for item in os.listdir(save_dir):
# Match pattern ppo followed by numbers (e.g., ppo1, ppo_1, jackbot_ppo12)
matches = re.findall(r"ppo_?(\d+)", item, re.IGNORECASE)
for m in matches:
existing_numbers.append(int(m))
return max(existing_numbers, default=0) + 1
def make_env(rank: int, use_gui: bool = False, seed: int = 0):
"""Utility helper to instantiate parallel JackBot environments."""
def _init():
env = JackBotEnv(
use_gui=use_gui,
random_command=True,
)
env.reset(seed=seed + rank)
return env
return _init
def main(): def main():
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser(description="JackBot PPO Curriculum Trainer")
parser.add_argument("--timesteps", type=int, default=50000, help="Total number of 'practice steps'.") parser.add_argument("--num-workers", type=int, default=16, help="Number of parallel sub-process environments")
parser.add_argument("--model", type=str, default="ml/checkpoints/ppo_joint_command", help="Path to save the trained model") parser.add_argument("--total-timesteps", type=int, default=1_500_000, help="Total training timesteps")
parser.add_argument("--seed", type=int, default=0, help="Random seed for reproducibility") parser.add_argument("--log-dir", type=str, default="ml/logs", help="Directory for TensorBoard logs")
parser.add_argument("--device", type=str, default="auto", help="Device to use: 'cpu', 'cuda', or 'auto'") parser.add_argument("--save-dir", type=str, default="ml/checkpoints", help="Directory for model checkpoints")
parser.add_argument("--gui", action="store_true", help="Show the PyBullet GUI during training") parser.add_argument("--save-freq", type=int, default=50_000, help="Checkpoint save frequency (steps)")
parser.add_argument("--num-robots", type=int, default=1, help="Number of robots in the training environment") parser.add_argument("--gui", action="store_true", help="Enable PyBullet 3D visual GUI rendering")
parser.add_argument("--robot-spacing", type=float, default=0.5, help="Spacing between robots in meters") parser.add_argument(
parser.add_argument("--start-pose", type=str, choices=["init_deg", "init90_deg"], default="init_deg", help="Initial robot pose at reset") "--pretrained-model",
type=str,
default=None,
help="Path to pre-trained base model checkpoint (.zip) to start PPO training from"
)
args = parser.parse_args() args = parser.parse_args()
Path(args.model).parent.mkdir(parents=True, exist_ok=True) os.makedirs(args.log_dir, exist_ok=True)
train( os.makedirs(args.save_dir, exist_ok=True)
total_timesteps=args.timesteps,
model_path=args.model, # Automatically determine next run number (e.g. ppo1, ppo2, ppo3...)
seed=args.seed, run_num = get_next_run_number(args.save_dir)
device=args.device, ppo_name = f"ppo{run_num}"
use_gui=args.gui,
num_robots=args.num_robots, print(f"[Train] Initializing Run #{run_num} ('{ppo_name}') with {args.num_workers} parallel workers...")
robot_spacing=args.robot_spacing,
start_pose=args.start_pose, env_fns = [
make_env(rank=i, use_gui=(args.gui if i == 0 else False))
for i in range(args.num_workers)
]
vec_env = SubprocVecEnv(env_fns)
# Initialize or Load PPO Policy Model
if args.pretrained_model and os.path.exists(args.pretrained_model):
print(f"[Train] Loading pre-trained base knowledge from: {args.pretrained_model}")
model = PPO.load(
args.pretrained_model,
env=vec_env,
learning_rate=5e-5, # Lower learning rate so RL fine-tunes without destroying base gait
ent_coef=0.0,
target_kl=0.05,
vf_coef=0.5,
max_grad_norm=0.5,
verbose=2,
tensorboard_log=args.log_dir,
device="cpu",
)
else:
print("[Train] No base model provided. Starting training from scratch...")
model = PPO(
policy="MlpPolicy",
env=vec_env,
learning_rate=5e-5,
n_steps=256,
batch_size=256,
n_epochs=10,
gamma=0.99,
gae_lambda=0.95,
clip_range=0.2,
ent_coef=0.0,
target_kl=0.05,
vf_coef=0.5,
max_grad_norm=0.5,
verbose=2,
tensorboard_log=args.log_dir,
device="cpu",
)
model.policy.log_std.data.fill_(-2.0)
# Setup Callbacks with ppo<number> naming
checkpoint_callback = CheckpointCallback(
save_freq=max(1, args.save_freq // args.num_workers),
save_path=args.save_dir,
name_prefix=f"jackbot_{ppo_name}",
) )
reward_logger_callback = RewardLoggerCallback(verbose=1)
curriculum_callback = CurriculumCallback()
eval_env = DummyVecEnv([lambda: JackBotEnv(use_gui=False, random_command=True)])
best_model_path = os.path.join(args.save_dir, f"best_model_{ppo_name}")
eval_callback = EvalCallback(
eval_env,
best_model_save_path=best_model_path,
log_path="ml/logs/results",
eval_freq=max(1, 50_000 // args.num_workers),
deterministic=True,
render=False,
)
print(f"[Train] Starting training for {args.total_timesteps} timesteps...")
try:
model.learn(
total_timesteps=args.total_timesteps,
callback=[checkpoint_callback, reward_logger_callback, curriculum_callback, eval_callback],
progress_bar=True,
)
final_model_path = os.path.join(args.save_dir, f"jackbot_{ppo_name}_final.zip")
model.save(final_model_path)
print(f"[Train] Training complete! Saved final model to {final_model_path}")
finally:
vec_env.close()
eval_env.close()
if __name__ == "__main__": if __name__ == "__main__":
-113
View File
@@ -1,113 +0,0 @@
import argparse
import os
from pathlib import Path
from .env import JackBotEnv
def parse_args():
parser = argparse.ArgumentParser(description="Train a joint-command policy for JackBot.")
parser.add_argument("--timesteps", type=int, default=500_000, help="Total training timesteps")
parser.add_argument("--model-path", type=str, default="ml/checkpoints/ppo_joint_command", help="Where to save the trained model")
parser.add_argument("--seed", type=int, default=0, help="Random seed")
parser.add_argument("--device", type=str, default="auto", help="Device to use: 'cpu', 'cuda', or 'auto' to autodetect")
parser.add_argument("--use-gui", action="store_true", help="Enable PyBullet GUI during training")
parser.add_argument("--num-robots", type=int, default=1, help="Number of robots in the training environment")
parser.add_argument("--robot-spacing", type=float, default=0.5, help="Spacing between robots in meters")
parser.add_argument("--start-pose", type=str, choices=["init_deg", "init90_deg"], default="init_deg", help="Initial robot pose at reset")
return parser.parse_args()
def train(
total_timesteps: int,
model_path: str,
seed: int = 0,
device: str = "auto",
use_gui: bool = False,
num_robots: int = 1,
robot_spacing: float = 0.5,
start_pose: str = "init_deg",
):
try:
from stable_baselines3 import PPO
from stable_baselines3.common.vec_env import DummyVecEnv
except ImportError as exc:
raise ImportError(
"stable-baselines3 and gym are required for training. "
"Install them with: pip install stable-baselines3 gym"
) from exc
env = DummyVecEnv([
lambda: JackBotEnv(
use_gui=use_gui,
random_command=True,
num_robots=num_robots,
robot_spacing=robot_spacing,
start_pose=start_pose,
)
])
def resolve_device(requested_device: str) -> str:
try:
import torch
except ImportError:
if requested_device != "cpu":
raise RuntimeError(
"PyTorch is not installed in the active environment. "
"Install torch with a GPU-enabled build before using --device cuda."
)
return "cpu"
hip_supported = getattr(torch.version, "hip", None) is not None
cuda_available = torch.cuda.is_available()
hip_available = hip_supported and getattr(torch.backends, "hip", None) is not None and torch.backends.hip.is_available()
if requested_device == "auto":
if hip_available or cuda_available:
return "cuda"
return "cpu"
if requested_device in {"cuda", "gpu", "hip"}:
if hip_available or cuda_available:
return "cuda"
raise RuntimeError(
f"GPU device requested ({requested_device}) but no CUDA/ROCm-capable PyTorch is available. "
f"Installed torch build: {torch.__version__} (hip={getattr(torch.version, 'hip', None)}, cuda={cuda_available})"
)
if requested_device == "cpu":
return "cpu"
raise ValueError(
f"Unsupported device '{requested_device}'. Use 'cpu', 'cuda', or 'auto'."
)
device = resolve_device(device)
model = PPO(
"MlpPolicy",
env,
verbose=1,
seed=seed,
device=device,
tensorboard_log=str(Path(__file__).resolve().parent / "tensorboard"),
)
model.learn(total_timesteps=total_timesteps)
Path(model_path).parent.mkdir(parents=True, exist_ok=True)
model.save(model_path)
env.close()
if __name__ == "__main__":
args = parse_args()
train(
args.timesteps,
args.model_path,
seed=args.seed,
device=args.device,
use_gui=args.use_gui,
num_robots=args.num_robots,
robot_spacing=args.robot_spacing,
start_pose=args.start_pose,
)
+3 -2
View File
@@ -4,11 +4,12 @@ ikpy
pybullet pybullet
pyserial pyserial
matplotlib matplotlib
dearpygui
# Deep learning / RL # Deep learning / RL
torch torch
stable-baselines3 stable-baselines3
gym stable-baselines3[extra]
gymnasium[box2d] gymnasium
shimmy shimmy
tensorboard tensorboard
+181 -54
View File
@@ -1,89 +1,216 @@
""" """
simulation.py - PyBullet Simulation Interface & Standalone Runner simulation.py - PyBullet Simulation Interface & Physics Engine
Consolidates scene management, physics queries, motor control, and rendering.
""" """
import time import time
import math import math
from typing import List, Tuple, Optional, Union
import numpy as np import numpy as np
import pybullet as p import pybullet as p
import pybullet_data # Added missing import import pybullet_data
from config import cfg from config import cfg
import DataTypes as dt import DataTypes as dt
class Simulation: class Simulation:
def __init__(self, urdf_path: str = cfg.urdf_path): """Single PyBullet simulation manager providing getters/setters for JackBot."""
def __init__(self, urdf_path: str = cfg.urdf_path, use_gui: bool = True):
self.urdf_path = urdf_path self.urdf_path = urdf_path
self.use_gui = use_gui
self.physics_client: Optional[int] = None
self.plane_id: Optional[int] = None
self.robot_id: Optional[int] = None
self.revolute_joints: List[int] = []
self.connect()
def connect(self) -> None:
"""Establishes connection to PyBullet GUI or DIRECT mode."""
if self.physics_client is not None and p.isConnected(self.physics_client):
return
flags = p.GUI if self.use_gui else p.DIRECT
self.physics_client = p.connect(flags)
# Connect to PyBullet GUI
self.physicsClient = p.connect(p.GUI)
p.setAdditionalSearchPath(pybullet_data.getDataPath()) p.setAdditionalSearchPath(pybullet_data.getDataPath())
p.setGravity(0, 0, -9.81) p.setGravity(0, 0, -9.81, physicsClientId=self.physics_client)
# Load plane and robot URDF if self.use_gui:
self.planeId = p.loadURDF("plane.urdf") p.configureDebugVisualizer(p.COV_ENABLE_GUI, 0, physicsClientId=self.physics_client)
self.robot = p.loadURDF(self.urdf_path, [0, 0, 0.2]) p.configureDebugVisualizer(p.COV_ENABLE_SEGMENTATION_MARK_PREVIEW, 0, physicsClientId=self.physics_client)
p.configureDebugVisualizer(p.COV_ENABLE_DEPTH_BUFFER_PREVIEW, 0, physicsClientId=self.physics_client)
# Discover revolute joint indices dynamically p.configureDebugVisualizer(p.COV_ENABLE_RGB_BUFFER_PREVIEW, 0, physicsClientId=self.physics_client)
self.revolute_joints = [] p.resetDebugVisualizerCamera(
for j in range(p.getNumJoints(self.robot)): cameraDistance=1.0, cameraYaw=50, cameraPitch=-35, cameraTargetPosition=[0, 0, 0],
joint_info = p.getJointInfo(self.robot, j) physicsClientId=self.physics_client
if joint_info[2] == p.JOINT_REVOLUTE:
self.revolute_joints.append(j)
self.set_all_joints_to_90()
p.resetDebugVisualizerCamera(
cameraDistance=1.0,
cameraYaw=50,
cameraPitch=-35,
cameraTargetPosition=[0, 0, 0],
)
def set_all_joints_to_90(self):
for joint_index in self.revolute_joints:
p.resetJointState(self.robot, joint_index, math.radians(90))
def updatePos(self, current_rad: dt.RadArray):
radflat = current_rad.data.flatten()
for joint_index, target_angle in zip(self.revolute_joints, radflat):
p.setJointMotorControl2(
bodyIndex=self.robot,
jointIndex=joint_index,
controlMode=p.POSITION_CONTROL,
targetPosition=target_angle,
force=500,
) )
def step(self): def load_scene(self, spawn_pos: Optional[List[float]] = None) -> Tuple[int, int, List[int]]:
p.stepSimulation() """Loads plane and robot URDF, discovering revolute joint indices dynamically."""
if spawn_pos is None:
spawn_pos = [0.0, 0.0, 0.20]
def disconnect(self): self.plane_id = p.loadURDF("plane.urdf", physicsClientId=self.physics_client)
if p.isConnected(self.physicsClient): self.robot_id = p.loadURDF(self.urdf_path, spawn_pos, physicsClientId=self.physics_client)
p.disconnect(self.physicsClient)
def close(self): self.revolute_joints = []
"""Cleanup wrapper for Robot backend compatibility.""" for j in range(p.getNumJoints(self.robot_id, physicsClientId=self.physics_client)):
info = p.getJointInfo(self.robot_id, j, physicsClientId=self.physics_client)
if info[2] == p.JOINT_REVOLUTE:
self.revolute_joints.append(j)
return self.plane_id, self.robot_id, self.revolute_joints
# --- ACTUATION (SETTERS) ---
def set_robot_joint_angles(
self, target_angles: Union[np.ndarray, List[float], dt.RadArray]
) -> None:
"""Applies motor torque to pull joints toward target position angles."""
if isinstance(target_angles, dt.RadArray):
radflat = target_angles.data.flatten()
elif isinstance(target_angles, np.ndarray):
radflat = target_angles.flatten()
else:
radflat = target_angles
for joint_index, target_angle in zip(self.revolute_joints, radflat):
p.setJointMotorControl2(
bodyIndex=self.robot_id,
jointIndex=joint_index,
controlMode=p.POSITION_CONTROL,
targetPosition=float(target_angle),
force=30,
physicsClientId=self.physics_client
)
def hard_reset_joint_angles(self, target_angles: Union[np.ndarray, dt.RadArray]) -> None:
"""Instantly teleports joint angles to target positions, clearing velocity state."""
radflat = target_angles.data.flatten() if isinstance(target_angles, dt.RadArray) else target_angles.flatten()
for joint_index, target_angle in zip(self.revolute_joints, radflat):
p.resetJointState(
bodyUniqueId=self.robot_id,
jointIndex=joint_index,
targetValue=float(target_angle),
targetVelocity=0.0,
physicsClientId=self.physics_client
)
def reset_robot_base(
self,
pos: Optional[List[float]] = None,
orn: Optional[List[float]] = None,
linear_velocity: Optional[List[float]] = None,
angular_velocity: Optional[List[float]] = None
) -> None:
"""Resets root torso position, orientation quaternion, and clears base velocities."""
if pos is None:
pos = [0.0, 0.0, 0.20]
if orn is None:
orn = [0.0, 0.0, 0.0, 1.0]
lin_v = linear_velocity if linear_velocity is not None else [0.0, 0.0, 0.0]
ang_v = angular_velocity if angular_velocity is not None else [0.0, 0.0, 0.0]
p.resetBasePositionAndOrientation(self.robot_id, pos, orn, physicsClientId=self.physics_client)
p.resetBaseVelocity(self.robot_id, linearVelocity=lin_v, angularVelocity=ang_v, physicsClientId=self.physics_client)
# --- TELEMETRY (GETTERS) ---
def get_robot_pose(self) -> Tuple[List[float], List[float]]:
pos, orn = p.getBasePositionAndOrientation(self.robot_id, physicsClientId=self.physics_client)
return list(pos), list(orn)
def get_robot_rpy(self) -> Tuple[float, float, float]:
_, orn = p.getBasePositionAndOrientation(self.robot_id, physicsClientId=self.physics_client)
roll, pitch, yaw = p.getEulerFromQuaternion(orn)
return float(roll), float(pitch), float(yaw)
def get_robot_pose_and_rpy(self) -> Tuple[List[float], Tuple[float, float, float]]:
pos, orn = p.getBasePositionAndOrientation(self.robot_id, physicsClientId=self.physics_client)
roll, pitch, yaw = p.getEulerFromQuaternion(orn)
return list(pos), (float(roll), float(pitch), float(yaw))
def get_robot_velocity(self) -> Tuple[List[float], List[float]]:
lin_v, ang_v = p.getBaseVelocity(self.robot_id, physicsClientId=self.physics_client)
return list(lin_v), list(ang_v)
def get_robot_joint_angles(self) -> np.ndarray:
joint_states = p.getJointStates(self.robot_id, self.revolute_joints, physicsClientId=self.physics_client)
return np.array([state[0] for state in joint_states], dtype=np.float32)
def _get_urdf_joint_limits(self) -> Tuple[np.ndarray, np.ndarray]:
"""Dynamically reads lower and upper limits for all revolute joints from PyBullet."""
lower_limits = []
upper_limits = []
# Iterate through joints in PyBullet
for j_idx in range(p.getNumJoints(self.robot_id, physicsClientId=self.physics_client)):
info = p.getJointInfo(self.robot_id, j_idx, physicsClientId=self.physics_client)
joint_type = info[2]
# Only collect limits for revolute joints
if joint_type == p.JOINT_REVOLUTE:
lower_limits.append(info[8]) # Index 8 = jointLowerLimit
upper_limits.append(info[9]) # Index 9 = jointUpperLimit
return np.array(lower_limits, dtype=np.float32), np.array(upper_limits, dtype=np.float32)
# --- SIMULATION LIFECYCLE CONTROLS ---
def step(self) -> None:
"""Advances physics simulation by 1 time step."""
p.stepSimulation(physicsClientId=self.physics_client)
def settle_and_measure_height(
self, target_angles: Optional[np.ndarray] = None, steps: int = 100, fallback_height: float = 0.122
) -> float:
"""Settles the robot into the ground while actively holding target joint angles."""
for _ in range(steps):
if target_angles is not None:
self.set_robot_joint_angles(target_angles)
self.step()
pos, _ = self.get_robot_pose()
return pos[2] if pos[2] > 0.0 else fallback_height
def apply_external_force(
self, force: Union[List[float], np.ndarray], link_index: int = -1, position: Tuple[float, float, float] = (0.0, 0.0, 0.0)
) -> None:
p.applyExternalForce(
objectUniqueId=self.robot_id,
linkIndex=link_index,
forceObj=list(force),
posObj=list(position),
flags=p.WORLD_FRAME,
physicsClientId=self.physics_client,
)
def disconnect(self) -> None:
if self.physics_client is not None and p.isConnected(self.physics_client):
p.disconnect(self.physics_client)
self.physics_client = None
def close(self) -> None:
self.disconnect() self.disconnect()
if __name__ == "__main__": if __name__ == "__main__":
from Robot import Robot, PyBulletBackend from Robot import Robot, PyBulletBackend
# 1. Initialize PyBullet simulation environment sim_instance = Simulation(use_gui=True)
sim_instance = Simulation() sim_instance.load_scene()
backend = PyBulletBackend(sim_instance)
# 2. Instantiate Robot with simulation backend backend = PyBulletBackend(sim_instance)
robot = Robot(backend_type=backend) robot = Robot(backend_type=backend, mode="kinematics")
robot.reset_to_init() robot.reset_to_init()
# 3. Command forward movement [vx, vy, omega] # Forward velocity command
robot.vector_dirmov = [1.0, 0.0, 0.0] robot.vector_dirmov = [0.3, 0.0, 0.0]
# 4. Main test execution loop
try: try:
while True: while True:
# Executes state machine logic
robot.tick() robot.tick()
time.sleep(1.0 / 60.0) time.sleep(1.0 / 60.0)
except KeyboardInterrupt: except KeyboardInterrupt: