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
42 changes: 42 additions & 0 deletions docs/assets/mtr1-corner-mount-view.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
102 changes: 78 additions & 24 deletions docs/products/general/setup/apollo-mmwave-dashboard-setup.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/products/msr1/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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.
description: Install the Apollo mmWave integration from HACS or the Home Assistant Marketplace 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
Expand Down
16 changes: 11 additions & 5 deletions docs/products/msr1/setup/sensor-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Once added to Home Assistant you can configure different settings for your MSR-1

The **Default Update** column is how often each entity refreshes. Radar entities update in real time as targets move. The **LTR390 Light** and **LTR390 UV Index** sensors use the interval set by the **LTR390 Update Interval** number (60s by default).

!!! tip "Lights that turn off while someone sits still"

Run room lights from **Radar Target**. It's on while the radar detects anyone, moving or still. The zone sensors also depend on the distance readings, so they can drop out while Radar Target stays on. Use a zone sensor only when you need one part of the room, and then leave **Reduce DB Reporting** off.

If the lights still turn off while someone sits still, raise **Radar Timeout** to 60 seconds or more. A longer timeout carries **Radar Target** through short dips and only delays the lights going off after everyone leaves. Changing **Radar Timeout** restarts the radar, and the radar may not find someone sitting still again until they move, so change it while nobody's sitting in the room, or ask them to move once afterward.

=== "Controls"

| Control | What it does |
Expand Down Expand Up @@ -38,9 +44,9 @@ Once added to Home Assistant you can configure different settings for your MSR-1
| **Radar Target** | real-time | Whether the radar detects a still or moving target. Good for triggering occupancy automations. |
| **Radar Moving Target** | real-time | Whether the radar currently has a moving target it is tracking. |
| **Radar Still Target** | real-time | Whether the radar currently has a still target. |
| **Radar Moving Distance** | real-time | Distance to the moving target. Holds the last value when no moving target is present, so it can be misleading. |
| **Radar Still Distance** | real-time | Distance to the still target. Holds the last value when no still target is present, so it can be misleading. |
| **Radar Detection Distance** | real-time | The last detected distance by the radar. Holds the last known value, so it can sometimes be misleading. |
| **Radar Moving Distance** | real-time | Distance to the moving target in cm. Reports *Unknown* when no moving target is present. |
| **Radar Still Distance** | real-time | Distance to the still target in cm. Reports *Unknown* when no still target is present. |
| **Radar Detection Distance** | real-time | Distance to the target the radar detects, in cm. Reports *Unknown* when the radar detects nobody. |
| **Radar Move Energy** | real-time | The amount of movement measured by the LD2410. Faster movements report a higher percentage. |
| **Radar Still Energy** | real-time | The energy of the current still target. |
| **Radar Zone 1 Occupancy** | real-time | Whether someone is in Zone 1, a configurable distance band from the sensor. Defined by **Radar Zone 1 Start** and **Radar End Zone 1**. |
Expand All @@ -58,7 +64,7 @@ Once added to Home Assistant you can configure different settings for your MSR-1
| **BME280 Temperature Offset** | 14.54 °C | Calibrates the BME280 temperature reading to a known value. See the <a href="https://wiki.apolloautomation.com/products/general/temp-hum-calibration/" target="_blank" rel="noopener">temperature &amp; humidity calibration guide</a>. |
| **BME280 Humidity Offset** | -18.86 % | Calibrates the BME280 humidity reading to a known value. See the <a href="https://wiki.apolloautomation.com/products/general/temp-hum-calibration/" target="_blank" rel="noopener">temperature &amp; humidity calibration guide</a>. |
| **LTR390 Update Interval** | 60 s | How often the LTR390 light and UV sensors poll (1 to 300 seconds). Disabled by default. |
| **Radar Timeout** | — | The time in seconds that the radar's presence stays detected after the target is lost. |
| **Radar Timeout** | 5 s | How long **Radar Target** stays on, in seconds, after the radar last detects someone. Raise it to 60 s or more if lights turn off while someone sits still. Changing it restarts the radar (see the tip above). |
| **Radar Max Move Distance** | — | Maximum distance gate for movement detection. Value between 2 and 8 inclusive. |
| **Radar Max Still Distance** | — | Maximum distance gate for still detection. Value between 2 and 8 inclusive. |
| **Radar Distance Resolution** | — | Best kept at 0.75 m in most cases. At 0.25 m the first few gates become very sensitive and the maximum detection distance shrinks a lot. Disabled by default. |
Expand All @@ -71,7 +77,7 @@ Once added to Home Assistant you can configure different settings for your MSR-1
| **Radar Control Bluetooth** | Off | Turns on the LD2410's Bluetooth so you can connect with the HLK Radar phone app (for example, to update the radar chip's own firmware, not the MSR-1 in general). |
| **Radar Engineering Mode** | — | Enables the radar's engineering mode, which exposes the per-gate energy readings used for tuning. |
| **Startup Light Blink** | On | Blinks the RGB LED on startup to show the device's connection status. |
| **Reduce DB Reporting** | Off | Filters out small sensor changes so fewer values are logged to your Home Assistant database. |
| **Reduce DB Reporting** | Off | Sends fewer updates to Home Assistant, so its database grows more slowly. While it's on, **Radar Move Energy** and **Radar Still Energy** stop updating, the three distance sensors report only changes of 5 cm (2 in) or more, and the light, UV, and ESP temperature sensors only report larger changes, at least once an hour. **Radar Target**, **Radar Moving Target**, **Radar Still Target**, and the g0-g8 energies aren't affected. With it on, after the radar briefly loses someone and finds them again at almost the same distance, the distance sensors can stay *Unknown* and the zone sensors Clear while **Radar Still Target** is on, until the distance changes by 5 cm or more. Leave it off if you automate on the zone sensors. |
| **query params** | — | Queries the LD2410 for its current parameters. |
| **Factory Reset Radar** | — | Sets the radar's move and still thresholds back to the manufacturer's original values. |
| **Factory Reset ESP** | — | Erases settings and returns the device to factory firmware defaults. Disabled by default. |
Expand Down
2 changes: 1 addition & 1 deletion docs/products/msr2/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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.
description: Install the Apollo mmWave integration from HACS or the Home Assistant Marketplace 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
Expand Down
12 changes: 9 additions & 3 deletions docs/products/msr2/setup/msr2-sensor-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Once added to Home Assistant you can configure different settings for your MSR-2

The **Default Update** column is how often each entity refreshes. Radar entities update in real time as targets move. The **LTR390 Light** and **LTR390 UV Index** sensors use the interval set by the **LTR390 Update Interval** number (60s by default).

!!! tip "Lights that turn off while someone sits still"

Run room lights from **Radar Target**. It's on while the radar detects anyone, moving or still. The zone sensors also depend on the distance readings, so they can drop out while Radar Target stays on. Use a zone sensor only when you need one part of the room, and then leave **Reduce DB Reporting** off.

If the lights still turn off while someone sits still, raise **Radar Timeout** to 60 seconds or more. A longer timeout carries **Radar Target** through short dips and only delays the lights going off after everyone leaves. Changing **Radar Timeout** restarts the radar, and the radar may not find someone sitting still again until they move, so change it while nobody's sitting in the room, or ask them to move once afterward.

!!! note "Ensure that the LD2410 firmware version is V2.04.23022511 or later for proper integration functionality."

The newer version of the firmware includes an "auto calibrate" function, so you might want to test it out.
Expand Down Expand Up @@ -42,7 +48,7 @@ Once added to Home Assistant you can configure different settings for your MSR-2
| **Radar Still Target** | real-time | Whether a stationary target is currently detected. |
| **Radar Moving Distance** | real-time | Distance to a moving target in cm. Reports *Unknown* when no moving target is present. |
| **Radar Still Distance** | real-time | Distance to a still target in cm. Reports *Unknown* when no still target is present. |
| **Radar Detection Distance** | real-time | Last detected distance from the radar in cm. Holds the last value, so it can be misleading when nothing is present. |
| **Radar Detection Distance** | real-time | Distance to the target the radar detects, in cm. Reports *Unknown* when the radar detects nobody. |
| **Radar Move Energy** | real-time | Amount of movement measured by the LD2410. Faster movement reads as a higher percentage. |
| **Radar Still Energy** | real-time | Energy of the current still target. |
| **Radar Zone 1 Occupancy** | real-time | Whether someone is in Zone 1. Zones are distance bands from the sensor, set with **Radar Zone 1 Start** and **Radar End Zone 1**. |
Expand All @@ -58,7 +64,7 @@ Once added to Home Assistant you can configure different settings for your MSR-2
| **Factory Reset ESP** | — | Erases settings and returns the device to factory firmware defaults. Disabled by default. |
| **Factory Reset Radar** | — | Resets the LD2410 radar to its factory move and still thresholds. |
| **Restart Radar** | — | Restarts the LD2410 radar module. |
| **Radar Timeout** | — | How long presence stays detected, in seconds, after the target is lost. |
| **Radar Timeout** | 5 s | How long **Radar Target** stays on, in seconds, after the radar last detects someone. Raise it to 60 s or more if lights turn off while someone sits still. Changing it restarts the radar (see the tip above). |
| **Radar Max Move Distance** | — | Maximum distance gate for movement detection (gate 2 to 8). Use it to ignore movement past a chosen distance. |
| **Radar Max Still Distance** | — | Maximum distance gate for still detection (gate 2 to 8). Use it to ignore still targets past a chosen distance. |
| **Radar Zone 1 Start** | 0 cm | Start distance of Zone 1 from the sensor, in cm (0 to 800). |
Expand All @@ -74,7 +80,7 @@ Once added to Home Assistant you can configure different settings for your MSR-2
| **DPS310 Pressure Offset** | 0.0 hPa | Calibration offset for the DPS310 pressure reading (-100 to +100 hPa in 0.1 hPa steps). Disabled by default. A small subset of devices do not include a DPS310 sensor; if this reads *Unknown*, your device may be one of these units. |
| **DPS Temperature Offset** | 14.54 °C | Offsets heat from the ESP chip for a more accurate DPS310 temperature reading. A small subset of devices do not include a DPS310 sensor. |
| **CO2 Auto Calibration** | On | Keeps the SCD40 CO₂ sensor calibrated automatically. The sensor assumes it sees fresh air (about <a href="https://climate.nasa.gov/vital-signs/carbon-dioxide/?intent=121" target="_blank" rel="noopener">420 ppm</a>) at least once a week and corrects its baseline to match. Turn it off if the device sits in a space that rarely gets fresh air, then calibrate manually with **Calibrate SCD40 To 420ppm** every 1 to 2 years. |
| **Reduce DB Reporting** | Off | Applies filters so many entities only report when they cross a threshold, using less Wi-Fi airtime and less Home Assistant database space. |
| **Reduce DB Reporting** | Off | Applies filters so many entities only report when they change by a set amount, using less Wi-Fi airtime and less Home Assistant database space. While it's on, **Radar Move Energy** and **Radar Still Energy** stop updating, the three distance sensors report only changes of 5 cm (2 in) or more, and the light, UV, pressure, and ESP temperature sensors only report larger changes, at least once an hour. **Radar Target**, **Radar Moving Target**, **Radar Still Target**, and the g0-g8 energies aren't affected. With it on, after the radar briefly loses someone and finds them again at almost the same distance, the distance sensors can stay *Unknown* and the zone sensors Clear while **Radar Still Target** is on, until the distance changes by 5 cm or more. Leave it off if you automate on the zone sensors. |
| **Startup Light Blink** | On | Blinks the RGB LED during the MSR-2's initial boot. |

=== "Diagnostic"
Expand Down
8 changes: 7 additions & 1 deletion docs/products/mtr1/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@ description: Frequently asked questions about the MTR-1 mmWave sensor.

11\. **How do I adjust the sensitivity of the motion detection?**

* Sensitivity can NOT be adjusted via the ESPHome configuration. The MTR-1 LD2450 mmWave sensor cannot be tuned like the MSR-2 can. The MTR-1 can set zones and track multiple users instead.
* The LD2450 radar in the MTR-1 has no sensitivity setting, and ESPHome has none to offer, so it can't be tuned gate by gate like the MSR-2. Here's what you can adjust instead:
* **Where it's mounted and where it points.** This decides what the radar sees, including a little of the next room and reflections off mirrors and glass. See the [mounting tips](setup/general-tips.md#mounting).
* **Zones.** Draw zones on the [Apollo mmWave zone map](setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) and automate on a zone's presence sensor: only someone inside the zone turns it on.
* **Spots to ignore.** Leave a spot outside every zone, such as a mirror, a fan, or the doorway to the next room, and nobody there turns a zone on.
* **Timeout** (**Radar Timeout** on the Apollo mmWave dashboard). It sets how long **LD2450 Presence** stays on after the radar stops seeing anyone in its whole view. It doesn't hold the zones you draw.
* **A delay in your automation.** Give the "turn off" trigger a delay, such as 2 minutes, so a short dropout doesn't turn the lights off.
* Judge detection only while the MTR-1 is mounted where it will stay. Held in your hand, the whole room moves around the radar, so the dots and zones won't match the room.

12\. **Can the MTR-1 detect motion through walls?**

Expand Down
2 changes: 1 addition & 1 deletion docs/products/mtr1/setup/apollo-mmwave-dashboard-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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.
description: Install the Apollo mmWave integration from HACS or the Home Assistant Marketplace 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
Expand Down
Loading
Loading