Tools¶
Generated from strands_robots/tools/*.py at build.
Every tool is a plain function first. Mutating tools take dry_run=True, default to
mode="sim", and refuse real motion without confirm=True; on top sits the strands
HITL gate for anything that moves hardware. The list is strands_robots.tools.STRANDS_ROBOTS_TOOLS.
14 tools in 6 modules.
| tool | module | parameters | does |
|---|---|---|---|
camera_list |
camera_tools |
max_index: int = MAX_INDEX |
Probe camera indices 0..max_index and list the ones that open, with their frame size. |
camera_snap |
camera_tools |
index: int = 0path: str | None = None |
Grab one frame from camera index and save it as PNG (default under $STRANDS_ROBOTS_HOME/snaps). |
mesh_fleet |
mesh_tools |
wait_s: float = 2.0backend: str | None = None |
Listen on the mesh for wait_s seconds and list every peer heard: robot, liveness, state age, last state. |
mesh_ask |
mesh_tools |
peer: strverb: strargs: dict[str, Any] | None = Nonetimeout_s: float = 5.0backend: str | None = Nonedry_run: bool = Trueconfirm: bool = False |
Send one verb to a mesh peer and return its reply. Motion verbs (act, execute) pass the consent rail. |
mhs_fleet |
mhs_tools |
broker: str | None = Noneallow_insecure: bool | None = None |
Discover every device on the MHS broker: id, type, labels, status, procedures and state keys. |
mhs_invoke |
mhs_tools |
device: strprocedure: strargs: dict[str, Any] | None = Nonebroker: str | None = Nonedry_run: bool = Trueconfirm: bool = Falseallow_insecure: bool | None = Nonetimeout_s: float = 30.0 |
Invoke one procedure on one device. Motion (act, execute_op) passes the consent rail; stop always goes. |
list_policies |
policy_tools |
- | List the policy providers: name, the extra that installs it, the frame it emits, whether it needs images. |
run_policy |
policy_tools |
name: strpolicy: str = 'mock'instruction: str = 'hold still'max_steps: int = 100mode: str = 'sim'port: str | None = Nonecontrol_hz: float = 50.0replan_ratio: float = 0.5dry_run: bool = Trueconfirm: bool = Falserecord: str | None = None |
Roll out a policy on a robot and report the steps, why it stopped and the final joints. |
record_episode |
record_tools |
name: strrepo_id: strpolicy: str = 'mock'instruction: str = 'demonstration'max_steps: int = 300mode: str = 'sim'port: str | None = Noneleader: str | None = Noneleader_port: str | None = Nonefps: int = 30root: str | None = Nonedry_run: bool = Trueconfirm: bool = False |
Record one episode into a lerobot dataset: a policy rollout, or a leader-arm teleop when leader is set. |
dataset_info |
record_tools |
path: str |
Episodes, frames, fps, robot type and feature names of a lerobot dataset directory. |
list_robots |
robot_tools |
- | List every robot in the registry with its joints and the modes (sim, real, twin) it can open. |
observe |
robot_tools |
name: strmode: str = 'sim'port: str | None = None |
Read one observation from a robot: joints in its frame, camera names, scalar sensors. Never moves it. |
move |
robot_tools |
name: straction: Actionmode: str = 'sim'port: str | None = Nonedry_run: bool = Trueconfirm: bool = Falsesettle_s: float = 1.0 |
Move joints to targets and hold until they settle; report the commanded, observed and remaining error. |
preflight |
robot_tools |
name: strpolicy: strmode: str = 'sim'port: str | None = None |
Check that policy can drive name: frame and DOF match and the policy's inputs are observed. |