DFKI Quadruped

This repo contains the quadruped controller used at DFKI's underactuated lab. It mainly contains a simulation, dynamic walking controller using MPC, WBC and different Gait Sequencers and hardware drivers to be used with different quadrupeds.

To install the whole software stack please refer to Installation
To run the simulated experiments from our paper Benchmarking Different QP Formulations and Solvers for Dynamic Quadrupedal Walking please refer to section Run the solver comparison experiments
To run the controller in simulation or on your own hardware (EXPERIMENTAL), pleae refer to Run the software stack

Authors

Shubham Vyas (Project Leader)
Rohit Kumar (Project Leader)
Franek Stark (Software Maintainer)
Hannah Isermann
Jakob Middelberg
Jonas Haack
Mihaela Popescu
Lasse Shala

Acknowledgements

This work has been performed in the AAPLE project funded by the German Federal Ministry for Economic Affairs and Climate Action (BMWK) (Grant Number: 50WK2275). And it is additionally supported by the M-RoCK project funded by the German Aerospace Center (DLR) with federal funds (Grant Number: FKZ 01IW21002) from the Federal Ministry of Education and Research (BMBF). Further, it is additionally supported with project funds from the federal state of Bremen for setting up the Underactuated Robotics Lab (Grant Number: 201-001-10-3/2023-3-2).

Contributing

Please use the issue tracker, to submit bug reports and feature requests. lease use merge requests as described here to add/adapt functionality.

Requirements / Dependencies

The requirements are all external and will be automatically installed when using the docker image, a full list can be found under DEPENDENCIES.

Installation

1. Build the docker image:

If you want to build the image yourself, use the build_new_image.sh script.
```
./build_new_image.sh
```
Note: If you already started a container before and saved important data to it, make a backup, since this script will delete all previously created containers with the "dfki_quad" label.

2. Starting and accessing containers

You can start a new container by executing the run_docker.sh script.
```
./run_docker.sh
```
If you need more than one terminal, you can use the new_docker_shell.sh script. This will launch a new shell for the already running container.
```
./new_docker_shell.sh
```
Connected gampads will automatically be accessible from within the container. If not, simply rerun the run_docker.sh script. Currently, most scripts support Logitech F310 type gamepads. For other gamepads (e.g. xbox360) axes mapping might be different.

Note: If you want to create a new container (e.g. for rebuiling the software stack), you can use the reset_docker_container.sh script. This will delete all current containers with the "dfki_quad" label. After that, you can proceed with the run_docker.sh script, which will create a new container for you.

3. Building the software stack

Inside the container, build the packages and run a simulation by running the following commands.

Note: The --symlink-install option enables you to change yaml and python files without rebuilding. If you want to use it, you have to use it consistently, as it cannot overwrite compilations without this option. Use $ rm -r build/ install/ log/ to remove former compilations if you want to compile with this option the first time.

a) For the ulab quad:
```
colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DROBOT_NAME=ulab
source install/setup.bash
source ~/setup_ulab_workspace.bash
```
b) For the unitree quad:
```
colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DROBOT_NAME=go2
source install/setup.bash
source ~/setup_go2_workspace.bash
```
Note: The unitree software stack requires cyclone dds, which will be setup by the last command. This means that your network interface need to be configured in this script. If you just want to use the simulation, independent from the build command, please just source setup_ulab_workspace.bash.

Run the solver comparison experiments

If you want to repoduce the results from Benchmarking Different QP Formulations and Solvers for Dynamic Quadrupedal Walking follow the following instruction:

Note: If you just want to recreate the plots, you can use our Dataset and jump directly to step (5).

1. Installation

If not yet done, build the docker image and install the software stack using the GO2 quadruped option:

https://github.com/dfki-ric-underactuated-lab/dfki-quad
cd dfki-quad
./build_new_image.sh
./run_docker.sh
cbg # This is a shorthand to build the software stack using the -DROBOT_NAME=go2 option
sr # This is a shorthand to ~/setup_ulab_workspace.bash, which is nececarry since the simulation is used and not a real system

Note: If you want to run the simulation and the controller on two different machines, like in the paper, the installation has to be done on both.

2. Simulation Machine: Start the simulation

On the machine that should run the simulation run the container and start the simulation

sr # This sources the ros environment for the simulation
export ROS_DOMAIN_ID=123 # Make sure both machines run on the same ROS 2 Domain ID
ros2 launch simulator simulator.launch.py sim:=go2

Visualization will be rendered (if configured) and can be seen in the browser (URL will be shown in the terminal, often localhost:7000).

3. Target computer: Setup experiments

The experiments are run from the script ws/src/solver_experiments/solver_experiments/solver_experiments.py,
The experimemts can be configured the following way:
- Line 609 sets which MPC solvers are included in the tests
- Line 619 sets which condensed levels are tested for MPC solvers with a sparse interface
- Line 616 sets which modes are included into the tests for the HPIPM MPC solver
- Line 617 sets which WBC solvers are included in the tests
- Line 618 sets which WBC scenes/formulations are included in the tests
- Line 641 sets how often an experiment is repeated until it is considered as 'failed'

4. Target computer: Run the experiments

Make sure the ws/src/solver_experiments/results folder is empty and exists.
Start the container and run the experiment script. The script will do all experiments automatically
```
sr # This sources the ros environment for the simulation
export ROS_DOMAIN_ID=123 # Make sure both machines run on the same ROS 2 Domain ID
ros2 run solver_experiments solver_experiments      
```
Note: The test script will run all experiments (i.e. combinations of MPC solvers, WBC solvers, condensing levels, etc.). For each experiment it first runs the standing and then the trot scenario. If a single experiment fails (the terminal might show errors etc.), the script will after a while automatically restart the experiment and mark the old one as failed, it will repeat this as often as specified above. The full script might take depending on your system at least one hour. Please wait until the script tells you that it is finished.

Note: If the test script is stopped manually or crashes a subprocess (leg driver or controller) might still be running. In that case it is important to manually kill that processes or just restart the docker container.
Move the ws/src/solver_experiments/results folder to a new location (another empty folder). The folder should be also renamed with the following pattern, such that it can be later imported into the plotting script: <target_platform>-N<precition_horizon>-<experiment_name_tag>
- <target_platform> indicates on which target computer the controller was executed, e.g. arm_orin.
- <prediciton_horizon> indicates whith which MPC prediction horizon the experiments were executed, e.g. 10.
- <experiment_name_tag> is a free field to put some information about the experiments, e.g. if this field contains wbc the respective experiments in that folder will later be excluded from any MPC related plot and vice versa.
Changing the prediction horizon:
- The MPC prediction horizon is a compile constant and has to be changed manually in several places. The easiest is to checkout the branch N10_prediction_horizon and recompile the software stack. (The docker container doesn't need a rebuild.)

5. Generate the plots

Assuming all different experiment result folders (named in the scheme defined above) containing the single experiments have been moved to one empty root folder, the plots can be generated.
The jupyter notebook ws/src/solver_experiments/evaluation_scripts/comparison_paper.ipynb defines at the beginning in the variable result_path the location of that root folder:
```
sr # shorthand to source the types needed to load the ros bags
jupyter notebook --allow-root src/solver_experiments/evaluaion_scripts/comparison_paper.ipynb
```
Note: It is recommended to run the python scripts and Jupyter notebook from the docker image as all dependencies are installed there.
After the location has been set, run the script and the plots are being generated. This might take a while.

Run the software stack

You can run the software stack using the simulation or using a real hardware (for example the Unitree GO2 in the education version). Currently simulation supports either the GO2 or the dfki in house quadruped.

Following components have to be launched to run the software stack:

Hardware driver or Simulation
Leg Driver
Dynamic walking controller
When on the real system: State estimation

Please find instructions for all components below.

Note: Almost all commands in this section need to run in seperate terminals.

Robot selection

When running a launch file, the used robot and whether it is on the real system or in simulation has to be specified. For this, it is required to set either the parameter sim or the parameter real to ulab for the dfki dog or to go2 for the unitree. For this, you have to append either sim:=ulab, sim:=go2, real:=ulab or real:=go2 to the launch commands. Eg. for the MPC controller:
```
ros2 launch controllers mit_controller.launch.py sim:=ulab
# or
ros2 launch controllers mit_controller.launch.py real:=go2
# ...
```

Running the Simulation

In order to run the simulation, start the simulation node:

ros2 launch simulator simulator.launch.py sim:=go2   # or sim:=ulab

All parameters can be set in the src/simulator/config/simulator_params_*.yaml file (there is one configuration file per robot). The parameter visualisation specifies if the simulator also shows a Meshcat visualisation.
Visualization will be rendered (if configured) and can be seen in the browser (URL will be shown in the terminal, often localhost:7000)

Simulation clock

The simulator can run faster or slower than realtime. This can be specified via the parameter simulator_realtime_rate in the config file. A value of 0.0 means that the simulator will run as fast as possible. Note that also for other values (1.0 refers to realtime, 0.5 to half of realtime, 2.0 to double of realtime) this is only an upper bound, meaning that the simulator might run slower.
In order to synchronize the rest of the software stack the simulator publishes the simulation time on the /clock topic (following the ROS 2 convention). To synchronize other nodes, instead of following the computer time (in ROS also known as wall time), they have to listen to this clock topic. This can be archived by setting the use_sim_time parameter to True when launching the respective node. This parameter is automatically set to correctly when using the provided launch files.

Note on developing nodes that use a timer or follow a clock:
Depending on the use_sim_time the call node->get_clock() will return a clock that follows the system's time (wall time) or the /clock topic. To create a timer based on this setting use the following call: rclcpp::create_timer(node, node->get_clock(),...) Using the call node->create_wall_timer(...) will create a timer that follows the system time, ignoring the use_sim_time setting.
It is very important to consider for each timer if it should follow the simulation or real-time during simulation! Making the wrong decision may result in undesired behaviour during simulation.

Reset simulation

The simulation offers a service /reset_sim of type ResetSimulation.srv which will reset the simulation and place the robot to a requested pose. This call might take a few seconds. The joint positions and PID gains will be set to the original initial value. It returns on a successful reset.

ros2 service call /reset_sim interfaces/srv/ResetSimulation "{pose: {position: {z: 0.4}, orientation: {w: 1.0, x: 0, y: 0,  z: 0.0}}, joint_positions: [-0.03287414616578515, 0.7382670992579555, -1.6656333683908857, 0.022376335027853064, 0.7301659339175386, -1.6657410165323536, -0.03343962015375848, 0.7507916433141004, -1.6985474687285194, 0.02383046084651509, 0.7426327340796195, -1.6989789512741746]}"

Manual step the simulation

Normally the simulation starts and runs with a target frequency as specified by the parameter simulator_realtime_rate. In order to step the simulation manually the parameter manually_step_sim in the simulator's config file has to be set to true. The simulator then provides a service /step_sim of type StepSimulation.srv which will advance the simulation by the amount of seconds specified in the request.
```
ros2 service call /step_sim interfaces/srv/StepSimulation dt:\ 10.0\ 
```

Running the real Hardware

Disclaimer: This is research code, this code can destroy your hardware or harm yourself!
------------------------ USE THIS SOFTWARE ON YOUR OWN RISK ----------------------------
When working with a real system be careful and mind the following safety measures:

Brushless motors can be very powerful, moving with tremendous force and speed. Always limit the range of motion, power, force and speed using configurable parameters, current limited supplies, and mechanical design.

Make sure you have access to emergency stop while doing experiments.

Unitree GO2 Edu

Connect the target computer (that should run the controller, leg driver, hardware driver, state estimation) via ethernet to the quadruped, and make sure it is configured as described here.
Install build docker, install the software stack using the GO2 option, as described above.

On the target computer launch a shell (maybe via ssh) and start the hardware driver:

./run_docker # if not already done, or maybe ./new_docker_shell
sg # This is a shorthand to source the workspace and set the correct ROS DDS, FOR THE GO2 QUAD THIS HAS TO BE DONE IN EVERY SHELL
ros2 launch drivers unitree_ros2_motor_driver.launch.py

Note: The target computer could also be the additional onbaord computer of the GO2 EDU. Details on how to acces the computer can be found here.

Ulab quadruped

Connect the robot via ethernet to your computer.
Connect to robot via ssh:
```
ssh ubuntu@10.0.0.20
```
password: ulab-dfki

Set date on robot:

from a new terminal

ssh ubuntu@10.0.0.20 "sudo date -s '$(date +"%Y-%m-%d %H:%M:%S")'"

source repo:
```
ws
```
this is a shortcut for cd dfki-quad-ros2/ws && source .install/setup.bash

rezero legs: attach the 3d printed parts to the robot legs to bring them in streched out pose and use

sh ~/dfki-quad-ros2/ws/src/drivers/scripts/zero_fl_leg.sh
sh ~/dfki-quad-ros2/ws/src/drivers/scripts/zero_fr_leg.sh
sh ~/dfki-quad-ros2/ws/src/drivers/scripts/zero_bl_leg.sh
sh ~/dfki-quad-ros2/ws/src/drivers/scripts/zero_br_leg.sh

on the quadruped or

sh ~/dfki-quad-ros2/ws/src/drivers/scripts/zero_single_leg.sh

on the single leg robot.

launch motor driver:
```
ros2 launch drivers mjbots_ros2_motor_driver.launch.py
```
to change the parameters like the control frequency adapt the file src/drivers/config/mjbots_test_params.yaml.
stop motor driver with ctrl-c. In case the motors don't stop you can use
```
. src/drivers/scripts/shutdown.sh
```
and/or
```
sudo killall  mjbots_ros2_motor_driver
```
Troubleshooting
- interfaces does not compile:
  
  deactivate pyenv using:
```
pyenv deactivate
```

State estimation

Start the state estimation with:

# select robot with sim:=ulab, sim:=go2, real:=ulab or real:=go2
ros2 launch state_estimation state_estimation.launch.py sim:=go2

Leg driver

Start the leg driver with:

# select robot with sim:=ulab, sim:=go2, real:=ulab or real:=go2
ros2 launch drivers leg_driver_launch.py sim:=go2

Dynamic walking controller

First make sure the robot is standing, this can be archived by:

# select robot with sim:=ulab, sim:=go2, real:=ulab or real:=go2
ros2 launch controllers quad_stand_up.launch.py sim:=go2

Then launch the controller (it will also launch the gamepad driver)

# select robot with sim:=ulab, sim:=go2, real:=ulab or real:=go2
ros2 launch controllers mit_controller.launch.py sim:=go2

This command will start the safe launch, which waits for a state message (coming from the simulation or state estimation) and makes sure that the state estimation is not drifting

Note on Code Formatters

Code Formatters

To insure a smooth code development between multiple developers, we urge you to install the following code formatters:

Clang format and tidy for c++ (we use C++17)
Black for python
CMake format for CMakeLists

We recommend to install them using the following instructions and apply them using vscode's "formatOnSave". This is however not an obligation as every developer has understandably their own preferred IDE and OS. However, submitting code that is not formatted according to the above mentioned formatters may result in a longer time to merge your code into the master branch.

To install clang-format and clang-tidy you can simply use an apt install:

sudo apt install clang-format clang-tidy

To install black you can use pip. However, we highly recommend that you never use pip to install packages globally, but rather pipx:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install black

Same for installing cmake-format:

pipx install cmakelang

Once all four code formatters have been installed, you need to add the following extensions to your vscode:

C/C++ (ms-vscode.cpptools)
Clang-Format (xaver.clang-format)
cmake-format (cheshirekow.cmake-format)
markdownlint (davidanson.vscode-markdownlint)
XML Tools (dotjoshjohnson.xml)

You can then add the following lines to your vscode JSON "workspace" or "user" settings file and save it:

"settings": {
  // C++
  "[cpp]": {
   "editor.defaultFormatter": "xaver.clang-format",
   "editor.formatOnSave": true
  },
  "clang-format.fallbackStyle": "Google",
  "clang-format.style": "{BasedOnStyle: 'Google', BreakBeforeBinaryOperators: NonAssignment, BinPackParameters: 'false', BinPackArguments: 'false', PointerAlignment: 'Left', ColumnLimit: 120}",
  "C_Cpp.intelliSenseEngineFallback": "enabled",
  // Python
  "[python]": {
   "editor.formatOnSave": true
  },
  "python.formatting.provider": "black",
  "python.formatting.blackPath": "$HOME/.local/bin/black",
  "python.formatting.blackArgs": [
   "--line-length",
   "120"
  ],
  // Markdown
  "[markdown]": {
   "editor.formatOnSave": true,
   "editor.formatOnPaste": true
  },
  "markdownlint.config": {
   "MD013": false,
   "MD033": false
  },
  // Xml
  "[xml]": {
   "editor.formatOnSave": true
  },
  // General
  "workbench.editor.highlightModifiedTabs": true,
  "editor.renderWhitespace": "all",
  "editor.renderControlCharacters": true,
  "files.trimTrailingWhitespace": true,
  "editor.formatOnSave": true
 }

Make sure the "python.formatting.blackPath" points to the correct location for vscode to find your black installation.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

DFKI Quadruped

Authors

Acknowledgements

Contributing

Requirements / Dependencies

Installation

Run the solver comparison experiments

Run the software stack

Robot selection

Running the Simulation

Simulation clock

Reset simulation

Manual step the simulation

Running the real Hardware

Unitree GO2 Edu

Ulab quadruped

State estimation

Leg driver

Dynamic walking controller

Code Formatters

Files

README.md

Latest commit

History

README.md

File metadata and controls

DFKI Quadruped

Authors

Acknowledgements

Contributing

Requirements / Dependencies

Installation

Run the solver comparison experiments

Run the software stack

Robot selection

Running the Simulation

Simulation clock

Reset simulation

Manual step the simulation

Running the real Hardware

Unitree GO2 Edu

Ulab quadruped

State estimation

Leg driver

Dynamic walking controller

Code Formatters