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
4 changes: 4 additions & 0 deletions docs/_snippets/zone-mapper-tool.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
!!! tip "Using the Apollo mmWave integration?"

Its dashboard has a zone map built in, with a tab for each MTR-1 and R PRO-1, so you don't need Zone Mapper as well. See [Draw zones on the R PRO-1 and MTR-1](/products/general/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1). Either way, leave the radar's **Zone Type** (**LD2450 Zone Type** on an R PRO-1) on **Disabled**. On **Detection**, the radar reports only people inside its own built-in zones, and with none set it reports nobody.

![Zone Mapper card showing drawn zones and tracked targets on a grid](/assets/zonemappertool.png)

Zone Mapper has two parts that work together:
Expand Down
Binary file modified 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.
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-device.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-ld2450-live.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-radar-setup-ld2410.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-radar-setup-ld2450.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-slider-lock-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-slider-lock.mp4
Binary file not shown.
Binary file modified 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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 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: 0 additions & 1 deletion docs/homey.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ description: Guide to integrating Apollo Automation devices with the Homey smart

* [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))
* [Tune your new R PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-hlk/)
* [Draw occupancy regions in Homey with the Zone Mapper tool for MTR-1](products/mtr1/setup/mtr-1-zone-mapper-tool/) or [R PRO-1](products/rpro1/setup/r-pro-1-zone-mapper-tool/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
title: MTR-1 Home Assistant zone configuration
description: "Tutorial for MTR-1 Home Assistant Zone Configuration."
---
--8<-- "products/mtr1/setup/zones-ha.md:5:"
--8<-- "products/mtr1/setup/zones-ha.md:5:6"

--8<-- "products/mtr1/setup/zones-ha.md:11:"
4 changes: 3 additions & 1 deletion docs/homey/products/general/choosing-an-mmwave-sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
title: Choosing an mmWave Sensor
description: Compare the Apollo MSR-2, MTR-1, and R PRO-1 mmWave presence sensors and pick the right one for your space.
---
--8<-- "products/general/choosing-an-mmwave-sensor.md:5:"
--8<-- "products/general/choosing-an-mmwave-sensor.md:5:97"

--8<-- "products/general/choosing-an-mmwave-sensor.md:102:"
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ flowchart LR
* [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))
* [Draw zones on your R PRO-1 or MTR-1 with the Apollo mmWave zone map](products/general/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1)
* [Tune your new R PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/)

### Quick references
Expand Down
6 changes: 2 additions & 4 deletions docs/products/general/choosing-an-mmwave-sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,9 @@ The LD2450 module tracks up to three moving targets and reports each one's X and

To set up zones, follow the guide for your device: [MTR-1 zones](https://wiki.apolloautomation.com/products/mtr1/setup/zones-ha/) or [R PRO-1 (LD2450) zones](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/).

!!! tip "Beta: try the Zone Mapper"
!!! tip "Draw zones on a live map"

We are beta testing **Zone Mapper**, which makes drawing LD2450 zones much easier. It pairs a Home Assistant integration with a Lovelace card, so you can draw rectangular, elliptical, or polygonal zones right on a grid, watch your tracked targets move in real time, and get an occupancy sensor for each zone. Both install through HACS.

Check it out on GitHub: [Zone Mapper integration](https://github.com/ApolloAutomation/zone-mapper) and [Zone Mapper card](https://github.com/ApolloAutomation/zone-mapper-card).
Instead of typing coordinates, you can draw zones over the radar's live targets and get an occupancy sensor for each one. In Home Assistant, the [Apollo mmWave dashboard](/products/general/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) has a zone map for every MTR-1 and R PRO-1, where you draw rectangles, ellipses, or polygons.

## Still detection (MSR-2 and R PRO-1 with the LD2412)

Expand Down
68 changes: 50 additions & 18 deletions docs/products/general/setup/apollo-mmwave-dashboard-setup.md

Large diffs are not rendered by default.

194 changes: 157 additions & 37 deletions docs/products/general/setup/apollo-mmwave-dashboard.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/products/mtr1/setup/apollo-mmwave-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ description: Draw occupancy zones for your Apollo MTR-1 over the radar's live ta

# 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.
On an Apollo MTR-1, the dashboard tab is built around 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, and its troubleshooting starts at [The zone map shows nobody, or only one person](#the-zone-map-shows-nobody-or-only-one-person). 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:"
2 changes: 1 addition & 1 deletion docs/products/mtr1/setup/sensor-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Once added to Home Assistant you can configure different settings for your MTR-1
| **ESP Reboot** | — | Restarts the device. Helpful for troubleshooting or refreshing the connection. |
| **Multi Target Tracking** | from module | Turns multi-target tracking on or off. Initial state is read from the LD2450 at boot. |
| **Timeout** | 5 s | How long presence stays detected after the target is lost. See the <a href="https://esphome.io/components/sensor/ld2450.html#ld2450-binary-sensors" target="_blank" rel="noopener">ESPHome LD2450 docs</a>. |
| **Zone Type** | Disabled | Zone detection mode: `Disabled`, `Detection` (only detect targets inside the zone), or `Filter` (exclude the zone from detection). |
| **Zone Type** | Disabled | Zone detection mode: `Disabled`, `Detection` (only detect targets inside the zone), or `Filter` (exclude the zone from detection). With `Detection` and no zones set, the radar detects nobody, so keep `Disabled` unless you use the radar's own zones (the **Zone-1 / Zone-2 / Zone-3** settings below). |
| **Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-4860 left to 4860 right). |
| **Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 7560). |
| **DPS310 Pressure Offset** | 0.0 hPa | Calibration offset for the DPS310 pressure reading. Disabled by default. |
Expand Down
4 changes: 2 additions & 2 deletions docs/products/mtr1/setup/zones-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Set up the three radar zones on your MTR-1 in Home Assistant by ent

!!! 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.
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. If you draw zones there, leave **Zone Type** on **Disabled** instead of entering zones below: the dashboard's zone map replaces the radar's built-in zones, and its **Radar setup** card offers **Set Zone Type to Disabled** when it isn't.

This guide shows you how to set up your MTR-1's three zones by entering the X and Y coordinates for each one. First you add a card to your dashboard that shows the radar's live targets, then you use it to work out the coordinates for each zone, in millimeters. You can enter the values in Home Assistant, as shown below, or directly on the device's web page by visiting its IP address or hostname.local.

Expand Down Expand Up @@ -91,7 +91,7 @@ Now use the live targets on the card to find the coordinates for each zone, and
* Turn on **Multi Target Tracking** to help the MTR-1 detect up to three targets better.
* **Zone Type** lets you select **Disabled**, **Detection**, or **Filter**:
* **Disabled**: disables zone area detection.
* **Detection**: only detects targets in the specified zone.
* **Detection**: only detects targets in the specified zone. With no zones set, it detects nobody.
* **Filter**: excludes the zone from detection.

2\. Walk, sit, or stand in the area where you want a detection or non-detection zone, and watch where your target appears on the card. Then enter the Zone 1-3 X and Y values to draw zones around the targets you want to detect or filter out. X values go from -4860 mm to 4860 mm, and Y values go from 0 mm to 7560 mm.
Expand Down
6 changes: 5 additions & 1 deletion docs/products/mtr1/setup/zones-hlk.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ With the app installed, you'll turn on the radar's Bluetooth, connect to it from

![HLKRadarTool LD2450 radar view with one target and the Set button circled in red](/assets/Esxscreenshot-20240514-100250-hlkradartool.jpg)

4\. Select **Area Detection**, then toggle Area 1, 2, or 3 and you will see a box with the corresponding number pop up. Then you can press and hold the box to move it and resize it. When your zones are set then select Submit and you should see Setup successfully.
!!! tip "Drawing zones with the Apollo mmWave dashboard?"

In step 4, pick **Close detection** instead of **Area Detection** (Zone Type **Disabled** in Home Assistant). The dashboard's [zone map](/products/mtr1/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) replaces the app's areas. On **Area Detection**, the radar reports only people inside the app's areas, so anyone else is missing from the map, and **Area Filtering** hides the people inside them.

4\. Select **Area Detection** (drawing zones on the Apollo mmWave dashboard instead? Pick **Close detection** and skip the areas; see the tip above), then toggle Area 1, 2, or 3 and you will see a box with the corresponding number pop up. Then you can press and hold the box to move it and resize it. When your zones are set then select Submit and you should see Setup successfully.

!!! tip "There are three ways to use your MTR-1!"

Expand Down
2 changes: 1 addition & 1 deletion docs/products/rpro1/setup/rpro1-sensor-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The R PRO-1 pairs two radars: an **LD2450** that tracks the position of up to th
| **LD2450 Bluetooth** | — | Toggles the LD2450's Bluetooth so you can connect with the <a href="https://wiki.apolloautomation.com/products/msr2/setup/zones-hlk/" target="_blank" rel="noopener">HLK Radartool phone app</a> for tuning. Turn it back off when finished. |
| **LD2450 Multi Target Tracking** | from module | Turns multi-target tracking on or off. Initial state is read from the LD2450 at boot. Disabled by default. |
| **LD2450 Timeout** | — | Seconds the LD2450 presence stays detected after the target is lost. |
| **LD2450 Zone Type** | Disabled | Zone detection mode: `Disabled`, `Detection` (only detect targets inside the zone), or `Filter` (exclude the zone from detection). |
| **LD2450 Zone Type** | Disabled | Zone detection mode: `Disabled`, `Detection` (only detect targets inside the zone), or `Filter` (exclude the zone from detection). With `Detection` and no zones set, the radar detects nobody, so keep `Disabled` unless you use the radar's own zones. |
| **LD2450 Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-4860 left to 4860 right). |
| **LD2450 Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 7560). |
| **LD2450 Factory Reset** | — | Resets the LD2450 radar module to its factory settings. |
Expand Down
4 changes: 4 additions & 0 deletions docs/products/rpro1/setup/zones-ha-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ You can enter the X and Y coordinates for each LD2450 zone manually in Home Assi

It's much easier to tune using the [HLK Radartool App](zones-hlk.md), and we suggest using that to set up your LD2450 instead.

!!! tip "Drawing zones with the Apollo mmWave dashboard?"

Skip these steps and leave **LD2450 Zone Type** on **Disabled**. The dashboard's [zone map](apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) replaces the radar's built-in zones. On **Detection**, the radar reports only people inside the zones you enter here, and with none set it reports nobody, so the map stays empty.

1\. Go to **Settings → Devices & services**, open the <a href="http://homeassistant.local:8123/config/integrations/integration/esphome" target="_blank" rel="noopener">ESPHome integration</a>, and click the name of your new device.

2\. Scroll down until you see **LD2450 Zone Type** and choose **Detection** from the drop-down menu.
Expand Down
4 changes: 2 additions & 2 deletions docs/products/rpro1/setup/zones-ha.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Tutorial for R PRO-1 Home Assistant Zone Configuration.

!!! 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.
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. If you draw zones there, leave **LD2450 Zone Type** on **Disabled** instead of entering zones below: the dashboard's zone map replaces the radar's built-in zones, and its **Radar setup** card offers **Set Zone Type to Disabled** when it isn't.

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.

Expand Down Expand Up @@ -57,7 +57,7 @@ Follow these steps to add a Plotly card that shows your LD2450 targets, then set
* Multi Target Tracking toggled on helps it detect up to three targets better.
* Zone Type allows you to select Disabled, Detection, or Filter.
* Disabled: Disable zone area detection.
* Detection: Only detects targets in the specified zone.
* Detection: Only detects targets in the specified zone. With no zones set, it detects nobody.
* Filter: Excludes a zone from detection.

9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -4860 mm to 4860 mm, and the Y values are 0 mm to 7560 mm.
Expand Down
6 changes: 5 additions & 1 deletion docs/products/rpro1/setup/zones-hlk.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ Follow these steps to turn on the LD2450's Bluetooth and set up its zones in the

![HLKRadarTool app LD2450 zone map with the Set button highlighted in the top right](/assets/r-pro-1-hlk-app-select-set.png)

4\. Enable Area Detection, then toggle Area 1, 2, and 3 to display a colored box with the matching number. You can press and hold the box to move or resize it as needed. Once your zones are configured, click **Submit**. You should see a confirmation message: **"Setup successfully."**
!!! tip "Drawing zones with the Apollo mmWave dashboard?"

In step 4, pick **Close detection** instead of **Area Detection** (**LD2450 Zone Type** **Disabled** in Home Assistant). The dashboard's [zone map](/products/rpro1/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) replaces the app's areas. On **Area Detection**, the radar reports only people inside the app's areas, so anyone else is missing from the map, and **Area Filtering** hides the people inside them.

4\. Enable Area Detection (drawing zones on the Apollo mmWave dashboard instead? Pick **Close detection** and skip the areas; see the tip above), then toggle Area 1, 2, and 3 to display a colored box with the matching number. You can press and hold the box to move or resize it as needed. Once your zones are configured, click **Submit**. You should see a confirmation message: **"Setup successfully."**

!!! tip "There are three ways to use your R PRO-1!"

Expand Down
Loading