Python SDK reference¶
The sim2bot package provides a blocking, thread-based controller for the local
bridge. Start with sim2bot.Robot, then use the
specialized data and stream objects returned by its methods.
Common entry points¶
| Task | API |
|---|---|
| Connect and discover robots | Robot, describe |
| Send joint positions | move_to |
| Stream joint velocities | set_velocity |
| Send a TCP pose | move_to_pose |
| Read telemetry | state, RobotState |
| Inspect joint fields | q, qd, qdd, qddd |
| Inspect TCP fields | tcp, tcp_orientation |
| Inspect model metadata | RobotInfo, home, joint_limits |
| Stream a camera | camera, CameraStream |
| Draw controller diagnostics | marker |
| Start the bridge automatically | ensure_bridge |
Read status labels carefully¶
- Stable means the API is the recommended current integration surface.
- Preview means the API works but has a documented scope or addressing limitation.
- Experimental means behavior is still being validated and may change before public beta.
These labels describe Sim2Bot API maturity, not functional-safety certification. No browser simulation command should be treated as a safety mechanism for real hardware.
Full Python workflow guide¶
The generated pages are intentionally thorough and specific. For an end-to-end narrative with complete examples, see Python SDK workflows. For independent copy-ready programs covering motion, multi-robot control, telemetry, cameras, scene automation, safe cleanup, and authenticated LAN use, see Python examples.