Skip to content

docs: Apollo mmWave switch-over from the original repository, zone map caveats - #1192

Merged
Bunton33 merged 12 commits into
devfrom
docs/apollo-mmwave-switch-over
Oct 25, 2026
Merged

Bunton33 merged 12 commits into
devfrom
docs/apollo-mmwave-switch-over

Conversation

@Bunton33

Copy link
Copy Markdown
Contributor

Apollo mmWave dashboard guides (general page, included by the MSR-1, MSR-2, R PRO-1 and MTR-1 copies).

Setup guide:

  • New From the original Apollo mmWave repository section for people who installed from bharvey88/apollo-mmwave, which is no longer on GitHub. Each step and HACS label was checked against the HACS 2.0.5 backend and frontend source: take the old row off Custom repositories (files stay), add the new repository, Download, restart. Two warnings explain why Delete in Home Assistant and Remove / Redownload in HACS lose zones or the shared folder.
  • Upgrade from an older setup now says to back up first and to restart and refresh after updating (with a backup button).
  • Install step 7 includes the Restart confirmation.

Tuning guide:

  • The help card's Full tuning guide link is described as the code has it (this guide on an MSR-1 or MSR-2, the R PRO-1 page on an R PRO-1).
  • An R PRO-1 without the LD2412 can show either Auto-calibrate state; both are covered, with the right count (28).
  • Zone map caveats: zone presence reads off while the sensor is offline; on phones, scroll outside the map and lock it so a swipe does not redraw a zone (Clear All Zones still works while locked).

Checks: mkdocs build clean for these pages, tools/docs-checks (0 broken links or anchors, 0 missing alt), all product copies render the new text. Two independent reviews; every confirmed finding fixed.

🤖 Generated with Claude Code

Bunton33 and others added 12 commits October 25, 2026 13:57
The setup guide's upgrade section gains a subsection for installs from
the original repository, bharvey88/apollo-mmwave, which is no longer on
GitHub: remove its Custom repositories row, add
ApolloAutomation/apollo-mmwave-main, download and restart. Two warnings
cover deleting the integration entry and pressing Remove or Redownload
in HACS. The section now also says to take a backup first and to
restart and refresh after an update, and the install section points
old installs at the new subsection.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The link on an MSR-1 or MSR-2 opens the general version of the tuning
guide (profiles.ts LD2410 wikiUrl), not the MSR-2 guide. On an R PRO-1
it opens the R PRO-1 version at its LD2412 section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Without the addon the card either shows the radar as offline with its
buttons disabled (calibrate-card.ts _online) or refuses the run with
"The radar has not reported 28 of its threshold values yet." The LD2412
check covers all 28 thresholds (calibration.py _chip_sent_thresholds),
so the old 18 was the MSR count. Either way the zone map is what that
sensor uses. The note moves out of the threshold bullet into its own
paragraph, and the bullet now says the count is up to 18 or 28.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The lock stops drawing only (zone-map/card.ts startDrawing and draw);
Clear All Zones, a double-click on a zone button, undo and Configure ->
Zones still change zones. The grid takes every touch (touch-action:
none and preventDefault on the canvas, locked or not), so scroll the
page outside it on a phone and keep the map locked. Zone presence reads
off, not unavailable, while the radar is offline (binary_sensor.py,
docs/configuration.md "Zones in automations").

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The zone button row also holds Clear All Zones, which works while the
map is locked and asks for no confirmation. Telling phone users to
scroll there risks a stray tap clearing every zone's shape. The radar's
name above the grid is a safe place to scroll.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The intro said the entry, dashboard, zones, Undo values and entity IDs
all carry over with no condition. That is not true for every old
version: Undo only exists from 2.2.0, and on 1.x zones of a renamed
radar are kept but not shown. Say that what you already have carries
over, and mark the 1.x or 2.0 paragraph as the exception.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
"HACS updates Apollo mmWave" reads as if HACS installs updates on its
own. HACS 2.0.5 only offers them. Match the install section's wording
("tracks updates") and have the reader do the update.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Step 1 said to back up "as described at the start of this section", but
the backup text and button sit at the start of the parent section.
Readers who follow the link from the install section land on the
subsection and never see them. Give the path and link the section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Step 4 listed paste, set type, add and close, then said to reopen
Custom repositories first if the dialog had closed. A precondition
that comes after the actions it gates is easy to miss.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The sentence says the help card opens the R PRO-1 version of the guide,
but the link was an in-page anchor. The general page is included into
every product copy, so on the general, MSR-1, MSR-2 and MTR-1 pages it
went to that page's own section. Point it at the R PRO-1 page, the
same place the card's link (profiles.ts) opens.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Both warning titles started with "Don't", next to a "Don't:" in the
box and a "don't restart" in step 5. The style guide asks to rephrase
excessive "no" framing positively, and the page's other warnings
already do ("Keep Zone Mapper until your zones have moved over"). The
box text is unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Choosing Restart Home Assistant opens a confirmation dialog
(ui.dialogs.restart.restart.confirm_action, "Restart"). The new
switch-over step 7 already says to click Restart; the install step
left it out, so the page gave two versions of the same restart.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 25, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 11 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2a710542-b02b-477c-81fe-294558c010aa
Commits

Reviewing files that changed from the base of the PR and between 879b83f and f1b6cbd.

Files selected for processing: 2
  • docs/products/general/setup/apollo-mmwave-dashboard-setup.md
  • docs/products/general/setup/apollo-mmwave-dashboard.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

2 participants