Repository navigation
Move simulator + AdvantageScope instructions to their own page - #20
Merged
Merged
Conversation
The only instructions for running the simulator lived inline in the Tank Drive challenge, so every later challenge said "run the simulator like before" and sent students hunting back through an earlier page. New robot-fundamentals/simulator.md is the single place for it: start the Simulate Robot config, put a controller in Joystick[0], enable Teleoperated, connect AdvantageScope and import the layout. Adds what the inline version lacked: what each layout tab is for, how to pick up code changes, and a troubleshooting section. Also documents the keyboard joystick fallback that XbotEdu's simgui-ds.json already configures, including its limit: Keyboard 0 defines axes 0-2 only, while the right stick reads WPILib axis 5, so it can drive single-stick controls but not tank drive. Tank Drive now links to the page instead of duplicating it, as do Altering Tank Drive, Command Groups, Moving to a Target Position, Advanced Swerve and the Tank Drive Solution. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This was referenced Oct 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The only instructions for running the simulator lived inline in the Tank Drive challenge. Every later challenge then said some version of "run the simulator like before", leaving students to hunt back through an earlier page. This gives it one page that everything links to.
New:
curriculum/robot-fundamentals/simulator.mdRunning the Simulator, listed under Reference. Covers the same core steps as before — Simulate Robot config, controller into
Joystick[0], select Teleoperated, AdvantageScope → Connect to Simulator → Import Layout — plus what the inline version lacked:AdvantageScope_layout.json: 2d top view, 3d view, Joysticks, Swerve, Table, Console.simgui-ds.jsonalready configures keyboard joysticks, but nothing documented it. It comes with a real limit: Keyboard 0 defines axes 0–2 only, while the gamepad's right stick reads WPILib axis 5 (XboxControllerWpiAdapter→controller.getRightY()). So WASD can drive single-stick controls like arcade drive, but not tank drive — the page says so up front rather than leaving students to discover only one side moves.Linked from
Tank Drive now links to the page instead of duplicating it. Also linked from Altering Tank Drive, Command Groups, Moving to a Target Position, Advanced Swerve Challenges, and the Tank Drive Solution. The
Joystick[0]/ Connect to Simulator / Import Layout steps now appear only insimulator.md.Bug found in XbotEdu, not fixed here
The layout's prebuilt Swerve tab is mis-wired. It reads:
but the swerve code logs from
SwerveDriveSubsystem, and the desired-state key isDesiredSwerveStates(plural) — so that tab likely shows nothing. The Advanced Swerve challenge's manual setup instructions use the correct keys, so the docs point students there and don't promise the prebuilt tab works. The real fix belongs in XbotEdu's layout file.The 2d top view tab is fine: it reads
PoseSubsystem/Location, which matches the code.Verification
pnpm docs:buildpasses. All the factual claims — run config name, layout tab names, joystick port 0, keyboard axis counts, and the swerve log keys — checked against the current XbotEdu and SeriouslyCommonLib sources. Not run in a live simulator.🤖 Generated with Claude Code