Skip to content

docs: document the 2.6.3 release image's preconfigured hardware settings - #637

Merged
brickbots merged 2 commits into
mainfrom
worktree-image-defaults-docs
Aug 27, 2026
Merged

docs: document the 2.6.3 release image's preconfigured hardware settings#637
brickbots merged 2 commits into
mainfrom
worktree-image-defaults-docs

Conversation

@brickbots

@brickbots brickbots commented Aug 27, 2026

Copy link
Copy Markdown
Owner

Summary

The image distributed starting with 2.6.3 ships preconfigured for a rev4 PiFinder in the right-hand position: Camera Type v3 - imx462, GPS Baud Rate 115200 (UBlox-10), and PiFinder Type Rev4 Right. Anyone flashing it onto a different PiFinder must change some of these, and the docs didn't say so.

  • software.rst — new Match the Settings to Your PiFinder subsection under Prebuilt Release Image. It lists the three image defaults, notes that v3 - imx462 is correct for rev4 (no separate rev4 entry), and walks each revision through what to change: PiFinder Type for everyone whose position differs, GPS Baud Rate 9600 (standard) for v3/v2.5, and the imx296/imx477 camera cases with the full power-cycle requirement.

  • sd_card.rst — the first-boot important block now lists all three defaults instead of only Camera Type, and defers the per-revision detail to the new software.rst section via :ref:.

  • troubleshooting.rstThe GPS never locks gains the baud-mismatch cause: a v3/v2.5 on a freshly imaged card runs at 115200 and never locks, which looks exactly like a dead GPS.

  • troubleshooting.rst / user_guide.rst — the baud-rate paragraph now walks the reader to the Status screen's GPS MSG row, which shows a mismatch directly (?-prefixed names mean undecodable data). The user guide's Status Screen section describes the GPS rows, and its screenshot is re-taken at 176 px (rev4 panel, battery icon), replacing the old 128 px capture.

Verification

  • python -m sphinx -b html -n -q builds clean with zero warnings (all new :ref: targets resolve).
  • Style check on the diff: no em-dashes or semicolons in added prose; terminology follows the house table.

🤖 Generated with Claude Code

https://claude.ai/code/session_017Gn5mzqB9x5jA9KpDHcCMC

brickbots and others added 2 commits August 26, 2026 17:42
The release image now ships set up for a rev4 PiFinder in the right-hand
position: Camera Type v3 - imx462, GPS Baud Rate 115200 (UBlox-10), and
PiFinder Type Rev4 Right. Anyone with a different PiFinder must correct
these after flashing, so:

- software.rst gains a 'Match the Settings to Your PiFinder' subsection
  under Prebuilt Release Image walking each revision through the changes
- sd_card.rst's first-boot warning now lists all three defaults and
  defers the per-revision detail to the new section
- troubleshooting.rst's 'The GPS never locks' notes the baud mismatch a
  v3/v2.5 hits on a freshly imaged card, which looks exactly like a dead
  GPS

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017Gn5mzqB9x5jA9KpDHcCMC
The GPS MSG row on the Status screen names the last message from the
receiver and its age, so it shows a baud mismatch directly: names
starting with ? mean data arrives that can't be decoded. Troubleshooting
now walks the reader to that row from the baud-rate paragraph, and the
user guide's Status Screen section describes the GPS rows.

Re-takes the Status screen screenshot at 176 px (rev4 panel, battery
icon) while editing the section, replacing the old 128 px capture.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017Gn5mzqB9x5jA9KpDHcCMC
@brickbots
brickbots marked this pull request as ready for review August 27, 2026 01:14
@brickbots
brickbots merged commit d09afe3 into main Aug 27, 2026
4 checks passed
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