Skip to content

docs: update for joy_teleop flat mode switching - #15

Merged
T-K-233 merged 2 commits into
mainfrom
docs/joy-teleop-mode-switching
Jul 20, 2026
Merged

docs: update for joy_teleop flat mode switching#15
T-K-233 merged 2 commits into
mainfrom
docs/joy-teleop-mode-switching

Conversation

@T-K-233

@T-K-233 T-K-233 commented Jul 20, 2026

Copy link
Copy Markdown
Member

Summary

Updates the documentation to match the mode_managerjoy_teleop refactor (Berkeley-Humanoids/humanoid_control_ros2#21). 32 pages.

What changed

Flat model throughout: the five control modes still exist as controllers, but switching is now direct joy_teleop/controller_manager/switch_controller — any transition from any state (BEST_EFFORT), no FSM/gating. Buttons: X=DAMP, L1+A/B/Y=STANDBY poses, R1+A=LOCOMOTION, R1+B=REMOTE, BACK=STOP. Headless via ros2 control switch_controllers; active mode read from list_controllers.

  • concepts/: five_mode_fsm reframed to flat switching; safety_pipeline drops the auto-DAMP-on-/safety_status path (native fallback_controllers; /safety_status is telemetry); architecture, prime_hybrid_actuation, index updated.
  • how_to/: switch_controllers_manually, recover_from_fault (no auto-DAMP; native fallback + operator STOP), calibrate_zero_pose / first_real_bringup / mit_slider_gui (enable_joy_teleop), talk_to_humanoid_control_from_python (call switch_controller, not mode services), plus the rest.
  • reference/: controllers, launch_args, manual_controllers, messages (ControlMode type retained for the DDS bridge; /control_mode topic gone), topics_services (removed /control_mode + mode-service rows), cli_tools / packages (joy_teleop, no mode_manager exe), quick_reference, policy_runner, troubleshooting.
  • tutorials/ + getting_started/ + extras/: mujoco_fsm_walk reframed, lite_101, tracking_policy, run_gravity_compensation, build_your_own_controller, prime_bringup (Prime button map), intro.

Notes

  • MDX-safe; filenames and doc-ids preserved. A few internal H2 anchors were renamed where they named deleted concepts (verified nothing links to them). Two "FSM" anchor headings kept for link stability (now mild misnomers).
  • Diagrams are NOT updated in this PR. The generated SVGs still show the old FSM / mode_manager / auto-DAMP: concepts__five_mode_fsm__01, concepts__safety_pipeline__01, reference__messages__01, getting_started__lite_101__01/__02, how_to__first_real_bringup__01, getting_started__intro__01/__02. They are generated by scripts/draw_diagrams.py, whose palette is out of sync with the current orange recolor — re-running it would revert all diagram colors, so the generator needs reconciling first, then the affected diagram functions updated with visual review.
  • No local Docusaurus build was run (no Node); relying on CI.

🤖 Generated with Claude Code

https://claude.ai/code/session_019T47bdWkZy9wcZeCUJuwWT

T-K-233 and others added 2 commits July 19, 2026 17:43
Reflect the mode_manager -> joy_teleop refactor across the docs: flat
switching (any transition from any state), no /control_mode topic, no
/humanoid_control/mode/* services, native fallback_controllers, standby
constant-PD-from-measured, enable_joy_teleop rename.

Diagrams (generated SVGs) are NOT updated here and still show the old FSM;
they need a separate regeneration pass (see PR description).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019T47bdWkZy9wcZeCUJuwWT
Update the affected SVGs to the new architecture (mode_manager -> joy_teleop,
flat switching, no /control_mode, native fallback_controllers) and re-adopt
draw_diagrams.py as the source of truth: bake the orange-theme recolor into
write_svg (the plain-orange redesign had edited the SVGs directly, desyncing
the generator), verified to reproduce every unaffected diagram byte-for-byte.

Diagrams changed: five_mode_fsm (state graph -> flat button map),
safety_pipeline (auto-DAMP -> native fallback + telemetry), messages (drop
/control_mode + dead mode_manager pub/subs), intro system/packages, lite_101
spawn/internals, first_real_bringup, architecture module_deps.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019T47bdWkZy9wcZeCUJuwWT
@T-K-233
T-K-233 merged commit 3374630 into main Jul 20, 2026
2 checks passed
@T-K-233
T-K-233 deleted the docs/joy-teleop-mode-switching branch July 20, 2026 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant