Skip to main content

Connect to the Unitree Go2 and G1 with WebRTC

Project description

Unitree Go2 and G1 WebRTC Driver

This repository contains a Python implementation of the WebRTC driver to connect to the Unitree Go2 and G1 Robots. WebRTC is used by the Unitree Go/Unitree Explore APP and provides high-level control through it. Therefore, no jailbreak or firmware manipulation is required. It works out of the box for Go2 AIR/PRO/EDU models and G1 AIR/EDU.

Description of the image

Currently Supported Firmware Versions

Go2:

  • 1.1.x series: 1.1.1 – 1.1.11 (latest available)
  • 1.0.x series: 1.0.19 – 1.0.25

G1:

  • 1.4.0 (latest available)

Audio and Video Support (Go2 only)

There are video (recvonly) and audio (sendrecv) channels in WebRTC that you can connect to. Check out the examples in the /example folder.

Lidar support (Go2 only)

There is a lidar decoder built in, so you can handle decoded PoinClouds directly. Check out the examples in the /example folder.

Connection Methods

The driver supports three types of connection methods:

  1. AP Mode: Go2/G1 is in AP mode, and the WebRTC client is connected directly to it:

    UnitreeWebRTCConnection(WebRTCConnectionMethod.LocalAP)
    
  2. STA-L Mode: Go2/G1 and the WebRTC client are on the same local network. An IP or Serial number is required:

    UnitreeWebRTCConnection(WebRTCConnectionMethod.LocalSTA, ip="192.168.8.181")
    

    If the IP is unknown, you can specify only the serial number, and the driver will try to find the IP using the special Multicast discovery feature available on Go2:

    UnitreeWebRTCConnection(WebRTCConnectionMethod.LocalSTA, serialNumber="B42D2000XXXXXXXX")
    
  3. STA-T mode: Remote connection through remote Unitrees TURN server. Could control your Go2/G1 even being on the diffrent network. Requires username and pass from Unitree account

    UnitreeWebRTCConnection(WebRTCConnectionMethod.Remote, serialNumber="B42D2000XXXXXXXX", username="email@gmail.com", password="pass")
    

Multicast scanner (Go2 only)

The driver has a built-in Multicast scanner to find the Unitree Go2 on the local network and connect using only the serial number.

PIP installation (Recommended)

cd ~
sudo apt update
sudo apt install -y python3-pip portaudio19-dev
pip install unitree_webrtc_connect

Manual Installation

cd ~
sudo apt update
sudo apt install -y python3-pip portaudio19-dev
pip install --upgrade setuptools pip
git clone https://github.com/legion1581/unitree_webrtc_connect.git
cd unitree_webrtc_connect
pip install -e .

Usage

Example programs are located in the /example directory.

Thanks

A big thank you to TheRoboVerse community! Visit us at TheRoboVerse for more information and support.

Special thanks to the tfoldi WebRTC project and abizovnuralem for adding LiDAR support, MrRobotow for providing a plot LiDAR example. Special thanks to Nico for the aiortc monkey patch.

Support

If you like this project, please consider buying me a coffee:

Buy Me A Coffee

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unitree_webrtc_connect-2.0.1.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unitree_webrtc_connect-2.0.1-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file unitree_webrtc_connect-2.0.1.tar.gz.

File metadata

  • Download URL: unitree_webrtc_connect-2.0.1.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for unitree_webrtc_connect-2.0.1.tar.gz
Algorithm Hash digest
SHA256 a9c5e8a4e9a003e848734b4583e1d8c816edfae58e58e967373639f32dc5f6f3
MD5 5760d6ad407b5b7884c788e8c374caf5
BLAKE2b-256 9cdb1eb83618c1a75dff7d6f9ce1fad38c5c8835d6560284f58178638c7fbbcf

See more details on using hashes here.

File details

Details for the file unitree_webrtc_connect-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: unitree_webrtc_connect-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.14 {"installer":{"name":"uv","version":"0.9.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for unitree_webrtc_connect-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aae5e9ec5642603d7f026d14bfc22805b098c2f45a14c9dd4e252da7f6ecf59f
MD5 946465d5c69e2298020956a519f9f06a
BLAKE2b-256 66e04da282070e79734ec99a7da94c68baa40810e39b4bee45663ccea23ebe49

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page