Skip to main content

videosdk-teleop

Drive a robot arm over the internet, and know exactly what the operator was looking at when they moved it.

A WebRTC transport for robot teleoperation, with frame-accurate observation/action correlation, a safety envelope that cannot be bypassed, and a recorder that turns every session into training data.

SDK overview


Install

pip install videosdk-teleop               # transport + cameras, ready to run
pip install "videosdk-teleop[lerobot]"    # + the lerobot adapters
pip install "videosdk-teleop[ros2]"       # + the ROS 2 nodes

Python 3.10-3.12. The first line is enough to teleoperate: the WebRTC transport and the camera stack are core dependencies, not extras.

Your robot, in three methods

Everything else is inherited: lease negotiation, clamping, the watchdog, the e-stop latch, correlation, recording.

from videosdk_teleop import Follower, SafetyConfig, single_group_descriptor

class MyArm(Follower):
    def descriptor(self):            return single_group_descriptor(...)
    def read_joints(self):           return {"shoulder": 12.4, "elbow": -3.1}
    def write_joints(self, joints):  ...        # RAISE on failure

MyArm("abcd-efgh-ijkl", safety=SafetyConfig(slew=12.0)).run(hz=50)

Already on lerobot? Wrap the device instead of subclassing:

from videosdk_teleop.adapters.lerobot import (SO101FollowerAdapter,
                                              SO101LeaderAdapter)

follower = SO101FollowerAdapter("abcd-efgh-ijkl", robot=arm, token=TOKEN)

On ROS 2, teleop_bridge_node does the same against your driver topics.

Meeting ids come from the VideoSDK API, or videosdk_teleop.rooms.create_room().

Run it locally, no robot needed

Runnable examples live in videosdk-teleops-examples:

git clone https://github.com/videosdk-live/videosdk-teleops-examples
cd videosdk-teleops-examples

python quickstart/remote_teleop.py --ticks 100   # full chain, in-process
python quickstart/my_arm.py                      # port your own arm
python quickstart/protocol_demo.py               # the wire format, live

remote_teleop.py runs a real follower against a real leader: real gates, real clamps, real observation log. Only the network is swapped for a loopback.

You own the loop

leader.tick()                 # one control period, never blocks
leader.run(hz=50)             # or let it pace the loop for you
for _ in leader.ticks(hz=50):
    obs = leader.observation()          # joints + pixels, same instant
    print(obs.observation_id, obs.joints, obs.images)

    frame = leader.peek_synced()        # watch only: does not arm the echo

Safety

SafetyConfig(
    slew=12.0,                          # max change per joint per tick
    watchdog_timeout_s=0.5,             # silence for this long -> failsafe
    max_staleness_ms=100.0,             # older commands are dropped
    require_deadman=True,
    on_starvation=FailsafeAction.HOLD,
    resume_requires_reclaim=False)
follower.estop()          # unauthenticated by design: anyone can stop an arm
follower.clear_estop()    # latched: only a human on the follower host resumes

Every command is checked before it reaches the motors: who sent it, whether it arrived too late, and how far it moves the arm. If the operator stops sending, the arm holds where it is.

Knowing what the operator saw

Every action is tagged with the exact camera frame the operator was looking at when they sent it. The tag travels with the command, so the two machines never need their clocks in sync.

Recording

follower.start_recording("./sessions")
follower.start_episode("pick up the cube")
...                                          # your loop runs
follower.end_episode(success=True)
follower.stop_recording()

On the follower this captures pixels before an encoder or a network touched them. Episodes open and close on the deadman by default.

VideoSDK can also record the session in the cloud:

follower = MyArm("abcd-efgh-ijkl", cloud_recording=True)

follower.cloud_recording_state    # idle / requested / starting / ready / failed

If the cloud recorder never comes up, recording carries on locally and the state says so.

Watching a session

from videosdk_teleop import attach

attach(follower, host="0.0.0.0", port=8080)   # live page + /snapshot.json

On ROS 2

One node, teleop_bridge_node, one role per host. It never talks to your motors directly: it reads your driver's joint-state topic and writes to your driver's joint-command topic, exactly like any other ROS node.

ros2 launch videosdk_teleop_ros bridge.launch.py \
    role:=follower_side robot_id:=my_arm cameras:=cam_a,cam_b labels:=wrist,front

ros2 service call /videosdk_bridge/enable std_srvs/srv/SetBool "{data: true}"

The bridge sits idle until enable is called, so launching it moves nothing.

Install into the same Python that ROS 2 uses, not whatever python3 your shell resolves to:

/usr/bin/python3 -m pip install --user videosdk-teleop

Documentation

Full documentation at docs.videosdk.live.


Apache-2.0 · docs.videosdk.live · examples

Release files for videosdk-teleop 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for videosdk-teleop 0.1.1
File Size Uploaded
videosdk_teleop-0.1.1.tar.gz 368.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for videosdk-teleop 0.1.1
File Interpreter ABI Platform
videosdk_teleop-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 618.9 kB

Release files / videosdk_teleop-0.1.1.tar.gz

Download URL videosdk_teleop-0.1.1.tar.gz
Size 368.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b14be5e873dac2d51ce7e474fc1688ac7162a6f3ccd182a70382c48bed83d1b4
BLAKE2b-256 checksum
How to use checksums
d162a42f35dea201d18d9ea60bc932097979270ac1f7e5e3c91ec54e47ad203a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.9

Release files / videosdk_teleop-0.1.1-py3-none-any.whl

Download URL videosdk_teleop-0.1.1-py3-none-any.whl
Size 250.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4bcbd035107ea99d3fccf9d4e94144deb49de16bcbd5a78c01b5a10cb986410d
BLAKE2b-256 checksum
How to use checksums
f31f1e0fb87cf0c41365cbeb0b9cff544c6a0941c5f2ee1b3ce91520d1ed669c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.9

Release history Release notifications | RSS feed

0.1.11

3 release files

0.1.10

3 release files

0.1.9

3 release files

0.1.8

3 release files

0.1.7

3 release files

0.1.6

3 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

1 release file

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page