API reference¶
The API reference is for exact, implementation-level questions. Python pages are generated from the SDK's type annotations and docstrings, so the website follows the code rather than maintaining a second hand-written signature.
Reference standards¶
Every public command should document more than its Python arguments:
- units and expected array shapes;
- world, robot, joint, or normalized coordinate conventions;
- whether it addresses one robot or a global scene resource;
- command cadence, watchdog, and latest-value behavior;
- return values, timeout behavior, and likely exceptions;
- safety implications and current implementation limitations;
- one minimal, copy-ready example and links to related APIs.
This is intentionally stricter than a generic generated reference. Robotics code can be syntactically correct while still being wrong by a unit, frame, joint order, or timing assumption.
Available references¶
-
Python SDK
Source-backed classes and methods for control, discovery, telemetry, cameras, markers, and bridge lifecycle.
-
Bridge protocol
WebSocket, TCP, UDP, JSON messages, binary camera framing, rates, and limits.
Generated pages
Each generated page identifies its stability, links to source code, and is
searchable by public name such as sim2bot.Robot.move_to.