Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/apollo-mmwave-calibrate-idle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-calibrate-poster.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-calibrate-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-calibrate-r-pro-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-calibrate-restored.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-calibrate-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-calibrate.mp4
Binary file not shown.
Binary file added docs/assets/apollo-mmwave-controls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-distances.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-gate-energy-live.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-gate-energy.mp4
Binary file not shown.
Binary file added docs/assets/apollo-mmwave-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-start-here.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/apollo-mmwave-zone-map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ flowchart LR

### Radar & Zones

* [Set up the Apollo mmWave dashboard](https://wiki.apolloautomation.com/products/general/setup/apollo-mmwave-dashboard-setup/) and [calibrate your radar or draw zones with it](https://wiki.apolloautomation.com/products/general/setup/apollo-mmwave-dashboard/)
* [Tuning out false positives with the MSR-2](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/mmwave-videos/)
* [Setting up zones on MTR-1 with the HLK app](https://wiki.apolloautomation.com/products/mtr1/setup/zones-hlk/)
* [Beta test our new Zone Mapper tool!](https://github.com/ApolloAutomation/zone-mapper) - [Use this custom card along with Zone Mapper!](https://github.com/ApolloAutomation/zone-mapper-card)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
---
description: "Tune the MSR-1 mmWave radar from Home Assistant using Radar Engineering Mode to find which gates cause false triggers and raise their thresholds."
---
--8<-- "products/msr1/setup/zones-ha.md:4:"
--8<-- "products/msr1/setup/zones-ha.md:4:4"

!!! tip "Prefer a guided dashboard?"

The Apollo mmWave integration gives your Apollo MSR-1, MSR-2, or R PRO-1 a tuning dashboard with a Gate Energy chart and a **Calibrate with empty room** button that sets the gate thresholds for you. The [Apollo mmWave dashboard guide](/products/general/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below.

--8<-- "products/msr1/setup/zones-ha.md:10:"
203 changes: 203 additions & 0 deletions docs/products/general/setup/apollo-mmwave-dashboard-setup.md

Large diffs are not rendered by default.

343 changes: 343 additions & 0 deletions docs/products/general/setup/apollo-mmwave-dashboard.md

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions docs/products/msr1/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Set up the Apollo mmWave dashboard for the MSR-1
description: Install the Apollo mmWave integration from HACS and get an auto-built Home Assistant dashboard with a radar tuning tab for your Apollo MSR-1.
---

# Set up the Apollo mmWave dashboard for the MSR-1

--8<-- "products/general/setup/apollo-mmwave-dashboard-setup.md:7:"
8 changes: 8 additions & 0 deletions docs/products/msr1/setup/apollo-mmwave-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Tune your MSR-1 radar with the Apollo mmWave dashboard
description: Calibrate the radar in your Apollo MSR-1 against an empty room, read its live charts, and fine-tune each gate from the Apollo mmWave dashboard in Home Assistant.
---

# Tune your MSR-1 radar with the Apollo mmWave dashboard

--8<-- "products/general/setup/apollo-mmwave-dashboard.md:7:"
4 changes: 4 additions & 0 deletions docs/products/msr1/setup/zones-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ description: "Tune the MSR-1 mmWave radar from Home Assistant using Radar Engine
---
# How To Tune mmWave Using Home Assistant

!!! tip "Prefer a guided dashboard?"

The Apollo mmWave integration gives your Apollo MSR-1 a tuning dashboard with a Gate Energy chart and a **Calibrate with empty room** button that sets the gate thresholds for you. The [Apollo mmWave dashboard guide](/products/msr1/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below.

If you're experiencing false triggers, we recommend using Radar Engineering Mode (REM) to monitor the gate energy and adjust the gate threshold to eliminate them.

Here is a quick introduction video of the ld2410b gates and zones.
Expand Down
8 changes: 8 additions & 0 deletions docs/products/msr2/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Set up the Apollo mmWave dashboard for the MSR-2
description: Install the Apollo mmWave integration from HACS and get an auto-built Home Assistant dashboard with a radar tuning tab for your Apollo MSR-2.
---

# Set up the Apollo mmWave dashboard for the MSR-2

--8<-- "products/general/setup/apollo-mmwave-dashboard-setup.md:7:"
8 changes: 8 additions & 0 deletions docs/products/msr2/setup/apollo-mmwave-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Tune your MSR-2 radar with the Apollo mmWave dashboard
description: Calibrate the radar in your Apollo MSR-2 against an empty room, read its live charts, and fine-tune each gate from the Apollo mmWave dashboard in Home Assistant.
---

# Tune your MSR-2 radar with the Apollo mmWave dashboard

--8<-- "products/general/setup/apollo-mmwave-dashboard.md:7:"
4 changes: 4 additions & 0 deletions docs/products/msr2/setup/msr2-tuning-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: Tutorial on creating an MSR-2 tuning dashboard.
---
# MSR-2 Tuning Dashboard

!!! tip "There is a newer way to do this"

The Apollo mmWave integration now builds this dashboard for you automatically, with nothing to paste. It also adds auto-calibration, which sets your gate thresholds from a one-minute listen to the empty room and saves your previous values so you can undo it. Follow the [Apollo mmWave dashboard setup guide](/products/msr2/setup/apollo-mmwave-dashboard-setup.md) to get started. The steps below still work if you'd rather keep the YAML version.

!!! note "Huge shoutout to discord user MirkoP for creating this!"

We all owe a huge thanks to MirkoP from discord/github for creating and sharing this with everyone! <a href="https://github.com/mirkop/apollo-home-assistant/blob/master/streamline_cards/ld2410/README.md" target="_blank" rel="noreferrer nofollow noopener">Source here</a>.
Expand Down
6 changes: 4 additions & 2 deletions docs/products/msr2/setup/zones-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ description: Tutorial for MSR-2 Home Assistant Zone Configuration.
---
# How To Tune the MSR-2 Using Home Assistant

!!! tip "Radar Engineering Mode (REM)"
!!! tip "Prefer a guided dashboard?"

If you're experiencing false triggers, we recommend using Radar Engineering Mode (REM) to monitor the gate energy and adjust the gate threshold to eliminate them.
The Apollo mmWave integration gives your Apollo MSR-2 a tuning dashboard with a Gate Energy chart and a **Calibrate with empty room** button that sets the gate thresholds for you. The [Apollo mmWave dashboard guide](/products/msr2/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below.

If you're experiencing false triggers, Radar Engineering Mode (REM) lets you monitor the gate energy and adjust the gate thresholds to eliminate them.

Quick introduction video of the LD2410B gates and zones.

Expand Down
8 changes: 8 additions & 0 deletions docs/products/mtr1/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Set up the Apollo mmWave dashboard for the MTR-1
description: Install the Apollo mmWave integration from HACS and get an auto-built Home Assistant dashboard with a zone map tab for your Apollo MTR-1.
---

# Set up the Apollo mmWave dashboard for the MTR-1

--8<-- "products/general/setup/apollo-mmwave-dashboard-setup.md:7:"
10 changes: 10 additions & 0 deletions docs/products/mtr1/setup/apollo-mmwave-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Draw MTR-1 zones with the Apollo mmWave dashboard
description: Draw occupancy zones for your Apollo MTR-1 over the radar's live targets, using the zone map on the Apollo mmWave dashboard in Home Assistant.
---

# Draw MTR-1 zones with the Apollo mmWave dashboard

On an Apollo MTR-1, the dashboard tab is the zone map, so [Draw zones on the R PRO-1 and MTR-1](#draw-zones-on-the-r-pro-1-and-mtr-1) is the section you need. The calibration and tuning sections are for the Apollo MSR-1, MSR-2, and R PRO-1.

--8<-- "products/general/setup/apollo-mmwave-dashboard.md:7:"
4 changes: 4 additions & 0 deletions docs/products/mtr1/setup/zones-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: Tutorial for MTR-1 Home Assistant Zone Configuration.
---
# How To Tune The MTR-1 Using Home Assistant

!!! tip "Prefer a guided dashboard?"

The Apollo mmWave integration gives your Apollo MTR-1 its own dashboard tab with a zone map where you draw zones over the radar's live targets, with no Plotly card or YAML to set up. The [Apollo mmWave dashboard guide](/products/mtr1/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) walks you through it as a guided alternative to the manual steps below.

Below are steps to manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to <a href="https://wiki.apolloautomation.com/products/rpro1/setup/zones-hlk/" rel="noreferrer nofollow">tune using the HLK Radartool App</a> and we suggest using that to set up your MTR-1.

1\. Install [HACS](https://hacs.xyz/docs/use/).
Expand Down
8 changes: 8 additions & 0 deletions docs/products/rpro1/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Set up the Apollo mmWave dashboard for the R PRO-1
description: Install the Apollo mmWave integration from HACS and get an auto-built Home Assistant dashboard with a zone map tab for your Apollo R PRO-1, plus radar tuning for the optional LD2412 addon.
---

# Set up the Apollo mmWave dashboard for the R PRO-1

--8<-- "products/general/setup/apollo-mmwave-dashboard-setup.md:7:"
8 changes: 8 additions & 0 deletions docs/products/rpro1/setup/apollo-mmwave-dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Draw R PRO-1 zones and tune the LD2412 addon with the Apollo mmWave dashboard
description: Draw occupancy zones over the live targets of your Apollo R PRO-1, and calibrate and fine-tune the optional LD2412 addon, from the Apollo mmWave dashboard in Home Assistant.
---

# Draw R PRO-1 zones and tune the LD2412 addon with the Apollo mmWave dashboard

--8<-- "products/general/setup/apollo-mmwave-dashboard.md:7:"
4 changes: 4 additions & 0 deletions docs/products/rpro1/setup/zones-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ description: Tutorial for R PRO-1 Home Assistant Zone Configuration.

The optional LD2412 mmWave sensor allows you to have perfect still detection for one target at up to 9 meters so it's a great addition to the sensor.

!!! tip "Prefer a guided dashboard?"

The Apollo mmWave integration gives your R PRO-1 a dashboard tab where you draw LD2450 zones over live targets and tune the LD2412 gates with a **Calibrate with empty room** button. The [Apollo mmWave dashboard guide](/products/rpro1/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below.

Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to <a href="https://wiki.apolloautomation.com/products/rpro1/setup/zones-hlk/" rel="noreferrer nofollow">tune using the HLK Radartool App</a> and we suggest using that to set up your R PRO-1 LD2450.

###### LD2450 Configuration
Expand Down
26 changes: 22 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ plugins:
'homey/products/msr2/calibrating-and-updating/updating-msr-2-firmware.md': 'homey/products/msr2/setup/updating-msr-2-firmware.md'
'homey/products/msr2/calibrating-and-updating/zones-ha.md': 'homey/products/msr2/setup/zones-ha.md'
'homey/products/msr2/calibrating-and-updating/zones-hlk.md': 'homey/products/msr2/setup/zones-hlk.md'
# Apollo mmWave dashboard usage guide moved next to its setup guide
'products/general/calibrating-and-updating/radar-tuning/apollo-mmwave-dashboard.md': 'products/general/setup/apollo-mmwave-dashboard.md'

extra:
social:
Expand Down Expand Up @@ -201,13 +203,17 @@ nav:
- Temperature and Humidity: products/general/temp-hum-calibration.md
- Calibrate PLT-1 Soil Moisture: products/general/calibrating-and-updating/calibrate-plt1.md
- Radar Tuning:
- (Best) Apollo mmWave Dashboard:
- Setup: products/general/setup/apollo-mmwave-dashboard-setup.md
- Calibrate, Tune, and Draw Zones: products/general/setup/apollo-mmwave-dashboard.md
- Home Assistant: products/general/calibrating-and-updating/radar-tuning/zones-ha.md
- HLK Radar Tool App: products/general/calibrating-and-updating/radar-tuning/zones-hlk.md
- mmWave Tuning Videos: products/general/calibrating-and-updating/mmwave-videos.md
- Zone Configuration:
- (Best) Apollo mmWave Dashboard: /products/general/setup/apollo-mmwave-dashboard/#draw-zones-on-the-r-pro-1-and-mtr-1
- (Good) Home Assistant: products/general/calibrating-and-updating/zone-configuration/zones-ha.md
- (Better) HLK Radar Tool App: products/general/calibrating-and-updating/zone-configuration/zones-hlk.md
- (Best) Zone Mapper Tool: products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md
- (Better) Zone Mapper Tool: products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md
- Updating: products/general/calibrating-and-updating/updating-firmware.md
- Renaming Devices: products/general/setup/renaming-apollo-devices.md
- Change Update Frequency: products/general/setup/change-the-update-frequency-of-sensors.md
Expand Down Expand Up @@ -474,7 +480,10 @@ nav:
- FAQ: products/msr2/faq.md
- Getting Started: products/general/setup/getting-started-msr2.md
- Radar Tuning:
- MSR-2 Tuning Dashboard: products/msr2/setup/msr2-tuning-dashboard.md
- (Best) Apollo mmWave Dashboard:
- Setup: products/msr2/setup/apollo-mmwave-dashboard-setup.md
- Calibrate and Tune: products/msr2/setup/apollo-mmwave-dashboard.md
- Legacy Tuning Dashboard (YAML): products/msr2/setup/msr2-tuning-dashboard.md
- Home Assistant: products/msr2/setup/zones-ha.md
- HLK Radar Tool App: products/msr2/setup/zones-hlk.md
- mmWave Tuning Videos: products/msr2/setup/mmwave-videos.md
Expand Down Expand Up @@ -503,9 +512,12 @@ nav:
- FAQ: products/mtr1/faq.md
- Getting Started: products/general/setup/getting-started-mtr1.md
- Zone Configuration:
- (Best) Apollo mmWave Dashboard:
- Setup: products/mtr1/setup/apollo-mmwave-dashboard-setup.md
- Draw Zones: products/mtr1/setup/apollo-mmwave-dashboard.md
- (Good) Home Assistant: products/mtr1/setup/zones-ha.md
- (Better) HLK Radar Tool App: products/mtr1/setup/zones-hlk.md
- (Best) Zone Mapper Tool: products/mtr1/setup/mtr-1-zone-mapper-tool.md
- (Better) Zone Mapper Tool: products/mtr1/setup/mtr-1-zone-mapper-tool.md
- Additional Info:
- General Tips: products/mtr1/setup/general-tips.md
- Sensor Definitions: products/mtr1/setup/sensor-definitions.md
Expand All @@ -530,9 +542,12 @@ nav:
- FAQ: products/rpro1/faq.md
- Getting Started: products/general/setup/getting-started-rpro1.md
- Zone Configuration:
- (Best) Apollo mmWave Dashboard:
- Setup: products/rpro1/setup/apollo-mmwave-dashboard-setup.md
- Calibrate, Tune, and Draw Zones: products/rpro1/setup/apollo-mmwave-dashboard.md
- (Good) Home Assistant: products/rpro1/setup/zones-ha.md
- (Better) HLK Radar Tool App: products/rpro1/setup/zones-hlk.md
- (Best) Zone Mapper Tool: products/rpro1/setup/r-pro-1-zone-mapper-tool.md
- (Better) Zone Mapper Tool: products/rpro1/setup/r-pro-1-zone-mapper-tool.md
- Additional Info:
- Switch Firmware: products/rpro1/setup/rpro1-switch-firmware.md
- General Tips: products/rpro1/setup/rpro1-general-tips.md
Expand All @@ -557,6 +572,9 @@ nav:
- General Tips: products/msr1/setup/general-tips.md
- Sensor Definitions: products/msr1/setup/sensor-definitions.md
- Radar Tuning:
- (Best) Apollo mmWave Dashboard:
- Setup: products/msr1/setup/apollo-mmwave-dashboard-setup.md
- Calibrate and Tune: products/msr1/setup/apollo-mmwave-dashboard.md
- Home Assistant: products/msr1/setup/zones-ha.md
- HLK Radar Tool App: products/msr1/setup/zones-hlk.md
- mmWave Tuning Videos: products/msr1/setup/mmwave-videos.md
Expand Down
Loading