docs: create 'Adding a Robot' embodiment cookbook (closes #64)#128
docs: create 'Adding a Robot' embodiment cookbook (closes #64)#128DsThakurRawat wants to merge 1 commit into
Conversation
|
Thanks @DsThakurRawat — the 4-step structure of this cookbook is exactly the right teaching shape. Credit preserved via The reason this didn't merge as-is: the example JSONs used field names that aren't in The replacement PR rewrites both worked examples using only real schema fields, validates them against the live Closing in favor of the replacement PR. Please keep contributing! |
Adds docs/adding_a_robot.md walking new contributors through adding a fifth embodiment to Reflex. Two worked examples — MyArm-6 (6-DOF arm + gripper) and SkyScout (quadcopter delivery drone) — both validated against the live src/reflex/embodiments/schema.json before commit. The example JSONs use only real schema fields (mean_action / std_action / mean_state / std_state, resolution + color_space, etc.) so anyone copy-pasting can run validate_embodiment_config on them and get a clean pass after Step 3. Drops fabrications from the original attempt (#128): - Field names like 'labels', 'mean'/'std' (instead of mean_action), camera 'width'/'height'/'encoding' (instead of resolution + color_space), 'workspace_bbox' — none of which are in schema.json - The 'configs/embodiments/' duplicate-file step (that location was a dev fallback; #132 made src/reflex/embodiments/presets/ canonical) Reflects what's actually shipped after recent foundation merges: - Optional gripper + payload_release (from #132) - New quadcopter preset with 10-DOF state matching MAVROS Odometry - ROS2 bridge --state-msg-type flag (from #133) for drone deployments - 'Common patterns by vertical' section reflects the FastCrest customer research vault's P0 verticals (warehouse AMR, farm, drone, smart-camera) Supersedes #128. Co-authored-by: Divyansh Rawat <186957976+DsThakurRawat@users.noreply.github.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Description
Adds
docs/adding_a_robot.md, an 'Embodiment Cookbook' that provides a step-by-step tutorial for adding new robots (arms, drones, AGVs, etc.) to Reflex.Key Additions:
MyArm-6: A 6-DOF robotic arm for warehouse/farm use.SkyScout: A 5-DOF surveillance drone for retail/traffic monitoring.Type of Change
How Has This Been Tested?
pytest tests/passes locallyreflex doctorsanity checkChecklist