A Python interface and simulation environemtn for the Unitree Go2 robot.
Go to file
Rooholla-KhorramBakht 1bccdbf3a0 readme updated 2024-05-05 00:22:31 -04:00
Go2Py go2py bridge major update 2024-05-05 00:11:18 -04:00
deploy go2py bridge major update 2024-05-05 00:11:18 -04:00
docker examples cleanup 2024-05-04 20:09:01 -04:00
docs openfig added 2024-04-16 16:08:52 -04:00
examples readme updated 2024-05-05 00:22:31 -04:00
go2py_messages go2py bridge major update 2024-05-05 00:11:18 -04:00
scripts go2py bridge major update 2024-05-05 00:11:18 -04:00
.flake8 go2py devcontainer is added 2024-05-03 20:51:20 -04:00
.gitattributes go2py devcontainer is added 2024-05-03 20:51:20 -04:00
.gitignore deployment cleanup 2024-05-04 14:03:03 -04:00
.gitmodules dds message problem fixed 2024-05-04 21:14:41 -04:00
LICENSE Initial commit 2023-10-27 12:15:40 -04:00
MANIFEST.in python interface added 2024-02-09 02:20:48 +08:00
Makefile go2py bridge major update 2024-05-05 00:11:18 -04:00
README.md readme updated 2024-05-05 00:22:31 -04:00
setup.cfg dds message problem fixed 2024-05-04 21:14:41 -04:00
setup.py deployment cleanup 2024-05-04 14:03:03 -04:00

README.md

Go2Py

Go2Py is a Pythonic interface and driver for low-level and high-level control of Unitree Go2 quadruped robots. The motivation of this project is to remove the burden of developing interface, safety systems, and basic components required for starting locomotion reserach using the Go2 quadruped robot. It provides a modular pipeline for real-time communication with the robot in both simulated and real world environment with a unified interface.

image

This project is comprised of the following components:

  • C++ Bridge: A dockerized ROS2 bridge built upon the unitree_ros2 that implements a remote controlled emergency stop and publishes the robot states as standard ROS2 topics usable by upstream systems such as NAV2.
  • Robot Interface: A simple Python class that represents the robot and communicates with the C++ bridge through either DDS (ROS independent) or ROS2 interfaces.
  • Robot Management FSM: A finite state machine for controlling the behavior of the robot up to the point of handover to the user low-level controller (sitting down, standing up) with safety monitors (motor temperatures, emergency stops).
  • Robot Model: A simple to use Pinocchio wrapper for computing the kinematics and dynamics parameters of the robot.
  • Simulation Interface: Simulation environments based on Mujoco and Nvidia Orbit (To be added) with a Python interface identical to the real robot.

How Does Using it Look Like?

Communication with the robot will be as simple as importing a Python class:

from Go2Py.robot.interface.dds import GO2Real
from Go2Py.robot.model import Go2Model
robot = GO2Real(mode='lowlevel')
model = Go2Model()
robot.standDownReset()
while running:
    joint_state = robot.getJointStates()
    imu = robot.getIMU()
    remote = robot.getRemoteState()
    model.update(state['q'], state['dq'],T,vel) # T and vel from the EKF
    info = model.getInfo()
    
    #User control computations ...

    robot.setCommands(q_des, dq_des, kp, kd, tau_ff)

An identical workflow is can be followed for simulation:

from Go2Py.sim.mujoco import Go2Sim
from Go2Py.robot.model import Go2Model
robot = Go2Sim()
model = Go2Model()
robot.standDownReset()
while running:
    joint_state = robot.getJointStates()
    imu = robot.getIMU()
    remote = robot.getRemoteState()
    model.update(state['q'], state['dq'],T,vel) # T and vel from the EKF
    info = model.getInfo()

    #User control computations ...

    robot.setCommands(q_des, dq_des, kp, kd, tau_ff)
    robot.step()

Installation

Follow through the steps in here to setup the robot and Go2Py.

Further Examples

A set examples and tutorials are provided to get you up and running quickly: