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.
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:
-
AP Mode: Go2/G1 is in AP mode, and the WebRTC client is connected directly to it:
UnitreeWebRTCConnection(WebRTCConnectionMethod.LocalAP)
-
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")
-
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:
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file unitree_webrtc_connect_leshy-2.0.7.tar.gz.
File metadata
- Download URL: unitree_webrtc_connect_leshy-2.0.7.tar.gz
- Upload date:
- Size: 34.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9eeddab68e42e286cd9ba1e520303a56fd0920dce2bd4ef0cdec1d21669fda3b
|
|
| MD5 |
57b28773ce58999a9f390c4705ea7507
|
|
| BLAKE2b-256 |
d820a92ceb094188fcf176da5609878c923273d414e93b8b5bbbb32c4f6ffd7c
|
File details
Details for the file unitree_webrtc_connect_leshy-2.0.7-py3-none-any.whl.
File metadata
- Download URL: unitree_webrtc_connect_leshy-2.0.7-py3-none-any.whl
- Upload date:
- Size: 40.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82e2b9d842bf58288ec40e0bfd685780e20af9a2d0495aa9330950afde1d8ce4
|
|
| MD5 |
32e35d806ae8904f80cf1705494c8558
|
|
| BLAKE2b-256 |
611be34448851e1cdad620175e048f58c177ac853564d4d7fdb9aa9cfc21eae7
|