Skip to main content

Connect to the Unitree Go2 with WebRTC

Project description

Full Unitree Go2 WebRTC Driver

This repository contains a Python implementation of the WebRTC driver to connect to the Unitree Go2 Robot.

  • High level control of the dog through WebRTC (like the Unitree Go app)
  • No jailbreak or firmware manipulation required.
  • Compatible with Go2 AIR/PRO/EDU models.

Description of the image

Installation

pip install go2-webrtc-connect

For audio and video:

pip install "go2-webrtc-connect[audio,video]"

Supported Firmware Versions

The currently supported Go2 firmware packages are:

  • 1.1.1 - 1.1.4 (latest available)
  • 1.0.19 - 1.0.25

Use the Unitree Go2 app to check your firmware version.

Audio Support

There is an audio (sendrecv) channel in WebRTC that you can connect to.

This is supported only on Go2 Pro and Edu. Check out the examples in the /examples/audio folder.

  1. Install portaudio19-dev.
# On Linux
sudo apt update && sudo apt install portaudio19-dev
# On MacOS
brew update && brew install portaudio19-dev
  1. Use the audio optional dependencies
uv run --extra audio  examples/audio/mp3_player/play_mp3.py

Video Support

There is video (recvonly) channel in WebRTC. Use the video optional dependencies for this.

uv run --extra audio  examples/audio/mp3_player/play_mp3.py

Lidar support

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

Connection Methods

The driver supports three types of connection methods:

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

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

    Go2WebRTCConnection(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:

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

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

Multicast scanner

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

Usage

Example programs are located in the /examples 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 and MrRobotow for providing a plot LiDAR example.

Support

This project is originally a fork from the repo of legion1581. Please consider buying the author 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

go2_webrtc_connect-0.1.2.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

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

go2_webrtc_connect-0.1.2-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

Details for the file go2_webrtc_connect-0.1.2.tar.gz.

File metadata

  • Download URL: go2_webrtc_connect-0.1.2.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.6

File hashes

Hashes for go2_webrtc_connect-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f812c1e26a71a39a2946b6360ee7198951093b610fe619edfdaf650fdeda0ca8
MD5 ebd20abbc17e41e505657947527ab07f
BLAKE2b-256 c7e599ca829d998ff737a1ef79158d4a4ea4dbd9d1158f81b5c167eab2118475

See more details on using hashes here.

File details

Details for the file go2_webrtc_connect-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for go2_webrtc_connect-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d1044ac78bb44620888605c40101fa8038ed121847f9c721995f696ec4a3dd40
MD5 0520353f200ac0d171164859cfe55432
BLAKE2b-256 818f99925524ca609cfbc48a88624d61d29e2929c285a8c47d75d7e5c61bcf55

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