You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: Apollo mmWave 2.4.0 guides: lit zones, walk corners, hold time, ignore zones, movement history - #1201
Updates the Apollo mmWave guides for Apollo mmWave 2.4.0 (first as the 2.4.0b1 test build): lit zones, numbered dots and trails, marking a zone's corners by walking, hold time, ignore zones, presence that reads unavailable while the radar is offline, and movement history.
Guides (products/general/setup/apollo-mmwave-dashboard{,-setup}.md, shown under every MSR-1, MSR-2, R PRO-1 and MTR-1 section)
New sections under Draw zones on the R PRO-1 and MTR-1: Read the map (lit zones, numbered dots and trails, Coverage, ignore zones, Radar offline), Mark corners by walking, Ignore a spot or hold a zone (with the hold's limits in plain words), and Replay movement history (who can see it, where it is kept, how long, backups, the recorder, deleting it, SD card writes, the support file).
Updated: the size readout and the polygon messages under Draw a zone, the flip under Match the map to how the sensor is mounted, Lock and unlock (new messages, the gated clears, a locked map scrolls on a phone, the view-only map), Clear or delete a zone, and Use the zone sensors (presence reads unavailable while the radar is offline and after a restart, and the from: "on" trigger).
Troubleshooting: Zone presence reads unavailable, A zone stays on after everyone left, a dot that moves the opposite way, a tab that says offline while the radar works, the apollo_mmwave.movement repair, and the support file line.
Setup page: what Configure holds, the view-only zone map for phones and wall tablets, and Updating to Apollo mmWave 2.4.0 (offline presence and automations, YAML ?v= addresses, a hard refresh, and turning Movement history off before going back to 2.3.0).
Zone pages: a one-sentence ignore zone tip on the MTR-1 and R PRO-1 Home Assistant and HLK zone pages, inside their existing lines, so the line-range includes are unchanged.
Media (rendered from the built 2.4.0 zone map card in a local harness: the real card bundle with a fake Home Assistant, scripted target positions and a packed movement history; dark theme, 540 px wide, each with alt text or an aria-label that transcribes it):
apollo-mmwave-zone-map-live.mp4 (10 s loop, 64 KB) with a poster: dot 1 walks onto the couch, which lights up, and out again, with a fading trail
apollo-mmwave-zone-map-walk.mp4 (10 s loop at phone width, 108 KB) with a poster: Corner here at four corners, the dashed preview and its size, then Finish and Couch saved
apollo-mmwave-zone-map-history.mp4 (9.6 s loop, 105 KB) with a poster: a 10x replay with numbered dots, trails and zones lighting, then Heatmap
apollo-mmwave-zone-list.png, apollo-mmwave-zone-map-ignore.png, apollo-mmwave-zone-map-offline.png, apollo-mmwave-zone-map-configure.png and apollo-mmwave-zone-map-view-only.png
apollo-mmwave-zone-map.png recaptured on 2.4.0 (zones dashed while nobody is in them, the Coverage button, a dimmed Clear All Zones)
Anything that looks different on real hardware during the 2.4.0b1 test gets recaptured before release.
Checks: local runs of check_markdown (0 errors, 0 warnings), check_images (no GPS data, no large files), mkdocs build (exit 0) and check_links (683 pages, 0 broken links or anchors, 0 missing alt) pass.
HA-only, no Homey mirror.
Do not merge until Apollo mmWave 2.4.0 is released.
Updated Apollo mmWave 2.4.0 guides with numbered targets, live zone states, coverage and ignore zones, map flipping, drawing controls, and zone measurements.
Added guidance for view-only standalone maps, touch scrolling, configurable zone holds, and movement-history replay and retention.
Clarified zone presence during radar outages and restarts, offline map messages, troubleshooting steps, and considerations when reverting to 2.3.0.
Expanded Home Assistant zone setup guidance, including using ignore zones to prevent fans or curtains from triggering dashboard zones.
Update the dashboard guide for Apollo mmWave 2.4.0. Four new sections
under Draw zones on the R PRO-1 and MTR-1: Read the map (numbered dots,
trails, lit zones, the held and ignored labels, Radar offline, and
Coverage), Mark corners by walking, Ignore a spot or hold a zone (not
the LD2450 Zone Type setting, and the hold limits in plain words), and
Replay movement history with who can see it, where it is kept, how long,
backups, the recorder, deleting it, SD card writes, and the support file.
Fold the flip into Match the map to how the sensor is mounted. Lock and
unlock gets the new toasts, the gated clears, a locked map that scrolls,
and the view-only map for phones. Draw a zone gets the size readout and
the polygon toasts, Clear or delete a zone the locked-map refusal, and
Use the zone sensors the hold time and presence that reads unavailable
while the radar is offline and after a restart, with a from: "on" fix
for automations. Troubleshooting adds Zone presence reads unavailable
(with the stale offline note on a tab) and A zone stays on after
everyone left, a pointer for a dot that moves the opposite way, and the
movement history count in the support file.
The setup guide gets the MTR-1 tab's new Configure contents, the
view-only card for your own dashboards, Updating to Apollo mmWave 2.4.0,
and the stale offline note under A tab says the sensor is offline. The
MTR-1 and R PRO-1 zone pages gain a one-line ignore zone tip inside their
existing tip lines, so the line-range includes are unchanged.
Every visual is marked with a MEDIA placeholder comment for the capture
step. Home Assistant only: there is no Homey mirror of these pages.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the nine MEDIA placeholders with media rendered from the built
2.4.0 zone map card in a local harness: the real card bundle with a fake
Home Assistant, scripted target positions and a packed movement history.
- apollo-mmwave-zone-map-live.mp4, apollo-mmwave-zone-map-walk.mp4 and
apollo-mmwave-zone-map-history.mp4: 540 px wide loops, each with a JPG
poster and an aria-label that transcribes what it shows
- apollo-mmwave-zone-list.png, apollo-mmwave-zone-map-ignore.png,
apollo-mmwave-zone-map-offline.png, apollo-mmwave-zone-map-configure.png
and apollo-mmwave-zone-map-view-only.png, with alt text
- apollo-mmwave-zone-map.png recaptured on 2.4.0 (dashed zones while
nobody is in them, the Coverage button, a dimmed Clear All Zones), and
its alt text updated
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Draft PRs are not automatically reviewed by default.
Trigger a manual review
To automatically review draft PRs, update your CodeRabbit configuration:
reviews:
auto_review:
drafts: true
No actionable comments were generated in the recent review.
Walkthrough
The documentation describes Apollo mmWave 2.4.0 map controls, zone states, movement history, outage behavior, and standalone view-only use. Product setup guides also recommend ignore zones for fans or curtains that affect dashboard-drawn zones.
Changes
Apollo mmWave documentation
Layer / File(s)
Summary
Map display, controls, and drawing docs/products/general/setup/apollo-mmwave-dashboard.md, docs/products/general/setup/apollo-mmwave-dashboard-setup.md
The guides describe numbered targets, map controls, drawing and walking-based corner marking, lock behavior, and view-only maps on custom dashboards.
Zone behavior and movement history docs/products/general/setup/apollo-mmwave-dashboard.md
The guide documents zone presence during outages and restarts, ignore zones, hold settings, movement-history controls and storage, and related troubleshooting.
Upgrade and outage guidance docs/products/general/setup/apollo-mmwave-dashboard.md, docs/products/general/setup/apollo-mmwave-dashboard-setup.md
The documentation covers the 2.4.0 upgrade and rollback, offline map messages, troubleshooting, and movement-history status in support files.
Dashboard-drawn zone recommendations docs/products/mtr1/setup/zones-ha.md, docs/products/mtr1/setup/zones-hlk.md, docs/products/rpro1/setup/zones-ha.md, docs/products/rpro1/setup/zones-hlk.md
The setup guides recommend drawing ignore zones over fans or curtains. The Home Assistant guides also retain guidance about disabling built-in zones when using dashboard-drawn zones.
ApolloAutomation/docs#1197: Documents the 2.3.0 zone map and disabling built-in radar zones; this PR updates the same guides for 2.4.0.
Merge Risk: Minimal · previous review b5984
The storage estimate is supported, and no actionable documentation defect remains identified. Coordinate publication with the stated Apollo mmWave 2.4.0 release requirement.
Pre-merge checks: 5
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title clearly identifies the Apollo mmWave 2.4.0 documentation updates and names several major changes covered by the pull request, including zone features, walking-based setup, hold time, ignore …
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title clearly identifies the Apollo mmWave 2.4.0 documentation updates and names several major changes covered by the pull request, including zone features, walking-based setup, hold time, ignore zones, and movement history.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Tip
🎯 Customize your risk assessments
Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.
✅ Automatic approvals, with your rules
Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.
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.
A rabbit hops across the map, And marks each zone with careful tap. The targets dot the radar trail, While view-only maps show without fail. Fan and curtain zones stay clear, New guide notes make the paths appear.
Recent review info
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: 8cc26888-d514-4201-8a3e-ead65388d1e4
Commits
Reviewing files that changed from the base of the PR and between f430a66 and b5984ea.
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
The capture harness now waits for the page to paint before each
screenshot, so a rerun reproduces every frame. The replay clip and its
poster are encoded from that capture; nothing visible changes, and a
rerun of the harness now gives back every apollo-mmwave-zone-map asset
byte for byte.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…orners
The LD2450 reports each position about once a second, and 2.4.0b2 tunes
the hold for that. Say that walking out into the room turns a held zone
off within about 3 seconds, and that walking out of the radar's view turns
it off at once after about two seconds of walking in view. A target the
radar was already tracking when the zone emptied now ends a hold only
within 0.6 m, so replace the 5 m limit, and add the limits for a short walk
out of view and for the radar's half-meter jump before it loses someone
sitting still. A slot swap can look like movement for a second or two.
Also:
- Walk: stand still about 3 seconds at each corner, as the card's hints
now say.
- The flip test works at any Cone rotation: hold the phone so the map's
cone points the way the sensor faces first.
- Zone-off triggers: keep to: "off" for lights, which still catches a
zone that emptied while the radar was offline, and add from: "on" only
where a trigger must see someone leave, such as a notification.
- Anything that can open the configuration folder, such as the Samba
share and Terminal & SSH apps, can read the movement history file.
- The map intro says History is for administrators.
- Link the recorder exclude section of Minimize activity spam.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Every clip and screenshot is rendered from the 2.4.0b2 bundles with the
LD2450's real write pattern: each axis about once a second, Y about 0.45 s
after X. Dots move in steps and trails are straight lines between reports,
so the live, walk and history descriptions say so.
- Walk: the clip and its description use the new hints, which ask for
about 3 seconds of standing still at each corner, and the size readout
drawn over the earlier corners' rings.
- History: the Replay badge sits under the top row of distance labels.
- Ignore: a hollow ring's number is outlined, so the hatching does not run
through it.
- Offline: the Radar offline note sits under the top distance labels.
- View-only: dot 1's trail is two straight steps back to the doorway.
- Setup page: the Radar setup card above the 2.4.0 zone map, with pale
dashed zones, the Coverage button and a dimmed Clear All Zones.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…4.0b2
- Walking out of the radar's view: a walker's speed now counts only
toward an edge ahead of them, and an edge behind or beside them counts
within 0.3 m (1 ft). Drop "or a second of a brisk walk": a brisk second
released in under half the runs at the radar's cadence, so say about two
seconds of walking in the zone, as the integration's docs do.
- Movement history: each radar keeps about 100,000 records, up to 105,000
before the oldest are dropped, so as little as about 4.6 hours in a busy
room.
- Going back to 2.3.0: 2.3.0 ignores view-only mode, so remove or replace
view-only zone maps first.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…otice and the MSR changes
Zone map (R PRO-1 and MTR-1):
- New "Zoom in and move the map" section: the minus, + and Fit row above
m / ft, 1x to 8x, Ctrl or Cmd and scroll, a trackpad pinch in Chrome,
Edge and Firefox, Shift or middle-button drag, two-finger pinch and pan
on phones (locked maps, Walk and no zone selected too), Fit's rules,
finer grid lines, when the zoom resets, and Safari's unhandled pinch.
A MEDIA: zoom marker shows where the clip goes.
- Corners snap to a tenth of the grid step (10 cm at 1 m, 2 in at 2 ft),
Alt or Option places freely, Walk corners never snap, and the drawing
readout reads to the centimeter when the snap is finer than 10 cm.
- The touch readout moves beside the finger near the top of the map; a
second finger drops a started rectangle or ellipse.
- The wider zone map section and the height cap; the MTR-1 and R PRO-1
tab layouts with two-column sections and dense placement.
- The mount-first hint under Cone rotation, the new flip hint, and the
Mark corners by walking chip on phones and tablets.
- Hold: someone seen in a zone for under about 1.2 s counts only within
0.3 m of an edge unless they moved at 0.85 m/s, so a couch or bed zone
holds; slow walks out of view soon after entering often hold.
- Zone presence waits for both halves of the radar's X and Y report,
which can delay a zone up to about half a second.
- A reused zone number starts with fresh generated names, but Home
Assistant brings the old entity IDs back.
- LD2450 Presence on LD2450 Live and Occupancy History.
Tuning cards (MSR-1, MSR-2, R PRO-1 LD2412):
- Gate Energy: "above threshold", faded gates outside the radar's range,
the radar's own answer under the chart, and the LD2410 needs-movement
line. Distances: "distance unknown".
- Start here, Zone Config and Auto-calibrate now point automations at
Radar Target and Radar Timeout. New troubleshooting section for Radar
Target turning off while someone sits still.
Setup page: the Reload and Restart notices in Load the new cards and the
error-after-update entry, and 2.4.0 update notes for the presence delay
and the Radar Target advice.
MTR-1 FAQ #11 and the Timeout row now name 2.4.0's ignore zones and hold
times alongside the 2.3.0 advice from #1202.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… loop
The zone map images and loops show the zoom buttons, the Configure image
shows the mount hint and the new flip hint, and the Walk loop shows the
readout's new place and the Mark corners by walking chip. The Gate Energy
images and loop are rendered from the 2.4.0b3 tuning bundle with the new
legend, faded gates and the radar's answer. A new loop shows zooming in
with Ctrl and the scroll wheel, drawing a snapped zone and Fit. Alt text
and aria-labels describe the new media.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…he map height, zoom clip and slow walk-out figures
The version notice runs in the page's cards, and cards from before 2.4.0
have none, so Load the new cards and the error-after-update section now
say it works on updates from 2.4.0 or later and to reload anyway on the
update to 2.4.0. The map's 240 px is the floor of its height cap only.
The zoom clip's size readout grows from 3 in x 1 in. The slow walk-outs
that keep a zone held cover 1 to 1.5 m of it, about 2 to 2.5 seconds at
0.6 m/s, as in the simulation and docs/configuration.md.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…panel
The zone map now keeps its zones in a Zones panel under the map (Add zone,
a chip with a color dot for each zone, and an editor for the selected
zone), and Configure is now Map settings. These renders come from the
2.4.0 bundles in headless Chrome with a fake Home Assistant:
- apollo-mmwave-zone-map.png: the whole card, with Zone 1's editor.
- apollo-mmwave-zone-list.png: the Zones panel, with the Couch editor's
Type, Hold, hints, Now line and Delete zone.
- apollo-mmwave-zone-map-configure.png: Map settings open, with Clear all
shapes.
- apollo-mmwave-radar-setup-and-zone-map.png, -ignore.png, -offline.png,
and the live and zoom loops: down to the zone chips.
- The walk loop: its ending shows the Zones panel's chips.
The alt text and video labels say what each one now shows. The walk
poster, the history loop and the view-only map show none of this and
are unchanged.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… dashboard restore
Zone map (R PRO-1 and MTR-1):
- The zone settings now live in the Zones panel right under the map, not
in Configure > Zones. New "Pick a zone in the Zones panel" section: the
zone buttons and their color dots, picking a zone by tapping it on the
map, and the editor's Name, size, Type, Hold, Now line, drawing hint and
Delete zone, quoted from the card.
- Add a zone: Add zone beside the Zones heading, the empty state and its
Cone rotation reminder, the 32-zone note, and a new render of a radar
with no zones (apollo-mmwave-zone-map-empty.png, from the 2.4.0 bundle).
- Rename a zone: the name saves on Enter or when you leave the box, with
Saving..., Saved or Not saved beside the heading. Esc puts it back.
- Clear or delete a zone: Delete zone and Clear all shapes (under Map
settings) both ask first, and a double-click on a zone's button no
longer clears it.
- Configure is Map settings everywhere: Cone rotation, the flip, Movement
history, and the lock bullets, which now say what still works on a
locked map and that the editor shows an Unlock button.
- The viewer note, the Type and Hold intro, the Zone presence hint and the
draw and walk steps match the new panel. A troubleshooting entry says
where a zone's name, Type and Hold are.
Dashboard setup:
- New "If your dashboard is missing cards" section: what a saved copy is,
the repair "The Apollo mmWave dashboard is a saved copy" and the options
action "Restore the automatic dashboard", that the copy is kept as
"Apollo mmWave (saved copy)" at apollo-mmwave-saved, out of the sidebar,
what each failure message means, and the manual way back when the
integration no longer records the dashboard.
- The options menu lists Restore, the menu text quotes the current string,
and the Take control, 2.3.0, 2.4.0 and "One sensor has no tab" notes and
a new "The dashboard is missing cards" troubleshooting entry point to the
new section. The usage guide links to it too.
- The MTR-1 tab, Start here and view-only descriptions name the Zones
panel and Map settings, and the 2.4.0 update notes describe the move
from Configure > Zones for people coming from 2.3.0.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The guides describe the 2.4.0 cards, but five screenshots under that text
still showed the older ones: LD2450 Live's row read Presence instead of
LD2450 Presence, Start here had no line about Radar Target in automations,
and the Auto-calibrate checklist and result had no reminder to raise Radar
Timeout. The captures now show those lines, and their alt texts say so.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A picked zone chip on the 2.4.0 card no longer takes the blue fill, on
which a blue zone's dot looked as hollow as a zone not drawn yet; it keeps
the plain fill with a colored ring. The zone map renders that show a picked
chip are made again from the fixed card, and the Zones panel text says how
the picked chip looks.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
From 2.4.0 the integration forgets the dashboard it recorded as soon as
that dashboard is deleted, so one made later at apollo-mmwave is never
judged a saved copy or taken for the integration's own. The catch that is
left, a delete while the integration is not running, is spelled out where
the guide talks about the URL and about the saved-copy repair.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
No deployments
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
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.
Updates the Apollo mmWave guides for Apollo mmWave 2.4.0 (first as the 2.4.0b1 test build): lit zones, numbered dots and trails, marking a zone's corners by walking, hold time, ignore zones, presence that reads unavailable while the radar is offline, and movement history.
Guides (
products/general/setup/apollo-mmwave-dashboard{,-setup}.md, shown under every MSR-1, MSR-2, R PRO-1 and MTR-1 section)from: "on"trigger).apollo_mmwave.movementrepair, and the support file line.?v=addresses, a hard refresh, and turning Movement history off before going back to 2.3.0).Zone pages: a one-sentence ignore zone tip on the MTR-1 and R PRO-1 Home Assistant and HLK zone pages, inside their existing lines, so the line-range includes are unchanged.
Media (rendered from the built 2.4.0 zone map card in a local harness: the real card bundle with a fake Home Assistant, scripted target positions and a packed movement history; dark theme, 540 px wide, each with alt text or an aria-label that transcribes it):
apollo-mmwave-zone-map-live.mp4(10 s loop, 64 KB) with a poster: dot 1 walks onto the couch, which lights up, and out again, with a fading trailapollo-mmwave-zone-map-walk.mp4(10 s loop at phone width, 108 KB) with a poster: Corner here at four corners, the dashed preview and its size, then Finish and Couch savedapollo-mmwave-zone-map-history.mp4(9.6 s loop, 105 KB) with a poster: a 10x replay with numbered dots, trails and zones lighting, then Heatmapapollo-mmwave-zone-list.png,apollo-mmwave-zone-map-ignore.png,apollo-mmwave-zone-map-offline.png,apollo-mmwave-zone-map-configure.pngandapollo-mmwave-zone-map-view-only.pngapollo-mmwave-zone-map.pngrecaptured on 2.4.0 (zones dashed while nobody is in them, the Coverage button, a dimmed Clear All Zones)Anything that looks different on real hardware during the 2.4.0b1 test gets recaptured before release.
Checks: local runs of check_markdown (0 errors, 0 warnings), check_images (no GPS data, no large files), mkdocs build (exit 0) and check_links (683 pages, 0 broken links or anchors, 0 missing alt) pass.
HA-only, no Homey mirror.
Do not merge until Apollo mmWave 2.4.0 is released.
🤖 Generated with Claude Code
Summary by CodeRabbit