Skip to content

Enhance documentation for logging, tuning, simulation, and vision systems#102

Merged
Project516 merged 1 commit into
mainfrom
docs-update
Jun 12, 2026
Merged

Enhance documentation for logging, tuning, simulation, and vision systems#102
Project516 merged 1 commit into
mainfrom
docs-update

Conversation

@Project516

Copy link
Copy Markdown
Contributor

No description provided.

@Project516 Project516 added the documentation Improvements or additions to documentation label May 13, 2026
@Project516 Project516 marked this pull request as ready for review June 11, 2026 21:44
@Project516 Project516 requested a review from a team as a code owner June 11, 2026 21:44
@Project516 Project516 changed the title [WIP] Enhance documentation for logging, tuning, simulation, and vision systems Enhance documentation for logging, tuning, simulation, and vision systems Jun 11, 2026
@Project516 Project516 requested a review from Copilot June 11, 2026 21:44

This comment was marked as resolved.

Comment thread docs/coding-conventions/documentation-and-comments.md Outdated
Comment thread docs/other-guides/2026-season-specific.md Outdated
Comment thread docs/other-guides/2026-season-specific.md Outdated
| `PM2026` | Practice Machine | Mirrors competition, minor wear-and-tear tweaks. |
| `XM2026` | Experimental Machine | Off-season prototyping. Encoder offsets and attachment flags vary. |
| `AM2026` | Alpha Machine | Earlier prototype, used pre-build. |
| `PHOTON2026` | Photon dev bot | Code-only testing without competition hardware. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOT for code-only its for Photon

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 01353cd — now "Photon's machine — the robot run by Photon, our sister team."

Comment thread docs/other-guides/2026-season-specific.md Outdated
* Releasing `LB` returns to home.

### 2026 Vision (Game REBUILT)
### Pilot action

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also has a lot of 2025 stuff

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Covered by the same rewrite in 01353cd — the intake section and the auto-score diagram were replaced with the real RT/LT intake/launch trigger behavior from RobotStates.

Comment thread docs/tools/leds.md Outdated

The plan is to bring back `CANdleLeds.java` (or its successor) as a thin subsystem wrapper around `SpectrumLEDs`, with `LedStates.java` doing what it did before: binding `Trigger`s — auto mode, transition, alliance shift, endgame, "about to shift" — to `setPattern(...)` calls of varying priority. Whoever picks the work back up should:

1. Replace the Phoenix 6 `CANdle` instantiation with `new SpectrumLEDs(new SpectrumLEDs.Config("StatusLEDs", 20))` (or however many LEDs the bot ends up with).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm 99% sure this is NOT part of the plan. integrate? possibly. replace? nooo

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworded in 01353cd — the CANdle stays as the hardware driver and the doc now describes SpectrumLEDs as something that may get integrated alongside it, not a replacement. Both the state-of-play note and the revival steps were updated.

Comment thread docs/tools/pid-tuning.md

## A Workflow That Works

You're looking for gains that hit the target quickly, don't overshoot, don't oscillate, and don't sit short of the setpoint. The order that tends to converge fastest:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should add my docs ;)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to — I couldn't find your docs in this repo or the org branches. Where do they live? Drop a link and I'll add it to this section.

* `RB` — fully retract the intake extension.
* `RT` / `LT` — intake extension manual voltage out (+/−).
* `Dpad` — same `ShotCalculator` hood/drive offset trims as the pilot.
* `LB + Y` — reset intake-extension position.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not in code at all, where did claude pull this from??

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's in the code — Operator.java:18 sets fn = leftBumper, Operator.java:44 defines resetIntakeExtensionPos = Y.and(fn) (so LB + Y), and OperatorStates.java:27-28 binds it to IntakeExtensionStates.operatorResetIntakeExtension() with a rumble confirm.

* Left stick — field-relative translation; right stick — rotation (exponential curves, deadzone in `PilotConfig`).
* `X` (hold) — `TRACK_TARGET` (launcher + hood aim while driving).
* `A` (hold) — `UNJAM`.
* `B` (hold) — slow intake-extension close.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can't find this anywhere in code, double check

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's in the code — Pilot.java:28 defines BButton = B.and(teleop) and PilotStates.java:38 binds it: pilot.BButton.whileTrue(IntakeExtensionStates.slowIntakeCloseCommand()). The command itself is IntakeExtensionStates.java:87 (slowIntakeCloseCommand, named "IntakeExtension.slowIntakeClose").

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice i didnt notice that

@Project516

Project516 commented Jun 12, 2026 via email

Copy link
Copy Markdown
Contributor Author

@Project516 Project516 merged commit 148a740 into main Jun 12, 2026
2 checks passed
@Project516 Project516 deleted the docs-update branch June 12, 2026 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants