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
20 changes: 3 additions & 17 deletions cloudcannon.config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
paths:
# uploads: "docs/assets"
uploads: "docs/assets"
uploads_filename:
uploads_use_relative_path: true
static: ""
Expand All @@ -10,8 +10,8 @@ paths:
data:
layouts:
includes:
#brandon changed this
uploads: '[base_path]/assets'
#brandon changed this back 5/22/25
# uploads: '[base_path]/assets'

collections_config:
docs:
Expand Down Expand Up @@ -57,20 +57,6 @@ _editables:
undo: true
snippet: true
_inputs:
#brandon added this 4/29/25 to add default descriptions
title:
type: text # simple single-line text field
label: Title # human-friendly label
description: Enter the article title
context:
path: "docs/**/*.md"
description:
type: textarea # multi-line text area
label: Description # human-friendly label
description: A short summary of the article
context:
path: "docs/**/*.md"

image:
type: image
options:
Expand Down
12 changes: 6 additions & 6 deletions docs/products/air1/examples/firstof9's-apex-charts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Firstof9's AIR-1 Apex Charts Dashboard
description: A custom dashboard made by discord/github user Firstof9 using Apex Charts for a really neat AIR-1 dashboard.
description: >-
A custom dashboard made by discord/github user Firstof9 using Apex Charts for
a really neat AIR-1 dashboard.
---
# Firstof9's AIR-1 Apex Charts Dashboard

Expand All @@ -22,9 +24,9 @@ Next, you need to edit the dashboards here.

![image.png](../assets/fBWimage.png)

***WARNING YOU ARE ABOUT TO BE ABLE TO WIPE OUT ALL YOUR DASHBOARDS PROCEED WITH CAUTION***
!!! danger "WARNING YOU ARE ABOUT TO BE ABLE TO WIPE OUT ALL YOUR DASHBOARDS PROCEED WITH CAUTION."

***WARNING YOU ARE ABOUT TO BE ABLE TO WIPE OUT ALL YOUR DASHBOARDS PROCEED WITH CAUTION***
You are entering an area where if you copy/paste to the wrong place you could delete other dashboards so please be careful!

Now choose "raw configuration editor"

Expand All @@ -34,7 +36,7 @@ Now you need to be VERY careful. You are editing all of your dashboards but we c

![AIR-1 Dashboard End.png](../assets/air-1-dashboard-end.png)

**Be sure to change the entity ID to match your device or else the card will not work.** You can find your device ID by going to the ESPHome addon and selecting the Edit option.
**Be sure to change the entity ID to match your device or else the card will not work.** You can find your entity ID by going to the ESPHome Device Builder and selecting the Edit option.

![AIR-1 ID.png](../assets/air-1-id.png)

Expand All @@ -44,8 +46,6 @@ VSC Find/Replace

![AIR-1 Find and Replace.png](../assets/OQfair-1-find-and-replace.png)

ChatGPT<br> ![Good ChatGPT.png](../assets/vBggood-chatgpt.png)

**This is the code!**

```yaml
Expand Down
25 changes: 25 additions & 0 deletions docs/products/r-pro-1/addons/adding-90-degree-usb-c-to-msr-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: adding 90 degree USB-C to MSR-2
description: Step by step tutorial for adding 90 degree USB-C to MSR-2
---
# Adding 90 degree USB-C to MSR-2

1\. Gather the MSR-2 and 90 degree addon.

![](assets/msr-2-90-degree-pic-0.jpg)

2\. Align the MSR-2 with the USB-C port facing you and align the 90 degree addon with the shorter end facing the MSR-2 USB-C port.

![](assets/msr-2-90-degree-pic-2.jpg)

3\. Gently push the short end of the 90 degree addon into the MSR-2 side USB-C port.

![](assets/msr-2-90-degree-pic-1.jpg)

4\. Gently push the longer end of the 90 degree addon into a USB-C outlet.

![](assets/msr-2-90-degree-pic-5.jpg)

!!! success "You're ready to begin using your device!"

Make sure to head to our <a href="https://wiki.apolloautomation.com/products/general/setup/getting-started-msr2/" target="_blank" rel="noreferrer nofollow noopener">getting started guide</a> to get your MSR-2 up and running!
23 changes: 23 additions & 0 deletions docs/products/r-pro-1/addons/adding-articulating-stand-to-msr-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Add the rear female usb-c port to your MSR-2
description: Tutorial on adding the rear female usb-c port to your MSR-2.
---
# Adding Articulating Stand To MSR-2

1\. Unplug your MSR-2 from power and remove the back.

![](../../../assets/msr-2-add-co2-pic-1.jpg)

![](../../../assets/msr-2-add-co2-pic-2.jpg)

![](../../../assets/msr-2-add-co2-pic-3-1.jpg)

2\. Align the new backplate that came with the articulating stand addon and gently push down on two corners near the articulating ball mount then the other two corners until it seats flat.

![](assets/msr-2-stand-pic-1.jpg)

![](assets/msr-2-stand-pic-2.jpg)

3\. Align the ball inside the articulating mount and then push down until it's fully seated.

![](assets/msr-2-stand-pic-3.jpg)
31 changes: 31 additions & 0 deletions docs/products/r-pro-1/addons/adding-co2-to-msr-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Add the SCD40 CO2 sensor to your MSR-2
description: Tutorial on adding the SCD40 CO2 sensor to your MSR-2.
---
# Adding CO<sub>2</sub> To MSR-2

1\. Unplug your MSR-2 from power and remove the back

![](../../../assets/msr-2-add-co2-pic-1.jpg)![](../../../assets/msr-2-add-co2-pic-2.jpg)![](../../../assets/msr-2-add-co2-pic-3-1.jpg)

2\. Flip the MSR-2 upside down and gently tap the case on the table and your MSR-2 should slide out of the case.

![](../../../assets/msr-2-add-co2-pic-4.jpg)![](../../../assets/msr-2-add-co2-pic-5.jpg)![](../../../assets/msr-2-add-co2-pic-6.jpg)

3\. With the case removed, identify the bottom right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the SCD40 CO<sub>2</sub> sensor. There is an X on the SCD40 sensor's PCB as well, you can see it in the image below but it is slightly cut off on the PCB itself. There is also a "gold dot" in the top left of the SCD40 when oriented properly.

![](../../../assets/msr-2-add-co2-pic-7.jpg)![](../../../assets/msr-2-add-co2-pic-8.jpg)

4\. Gently push the SCD40 CO<sub>2</sub> module onto the black mezzanine connector.

![](../../../assets/msr-2-add-co2-pic-9.jpg)![](../../../assets/msr-2-add-co2-pic-10.jpg)

5\. Slide the case back over the MSR-2, making sure that the case has the hole for the USB-C port facing the right direction.

![](../../../assets/msr-2-add-co2-pic-11.jpg)![](../../../assets/msr-2-add-co2-pic-12.jpg)

6\. Gently press the backplate of the MSR-2 case onto the MSR-2 until it lightly snaps into place. Please do not force it, if necessary please repeat steps above until it seats in the case without any force required.

![](../../../assets/msr-2-add-co2-pic-15.jpg)

7\. Please refer to our [CO<sub>2</sub> calibration guide](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/ "CO2 Calibration") to calibrate the CO<sub>2</sub> module after installation. This is required for all CO<sub>2</sub> addons purchased from us separately from a product (such as buying it to addon to an existing Apollo device).
35 changes: 35 additions & 0 deletions docs/products/r-pro-1/addons/adding-gpio-header-to-msr-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Add the GPIO Header to your MSR-2
description: Tutorial on adding the GPIO Header to your MSR-2.
---
# Adding GPIO Header To MSR-2

1\. Unplug your MSR-2 from power and remove the back.

![](../../../assets/msr-2-add-co2-pic-1.jpg)

![](../../../assets/msr-2-add-co2-pic-2.jpg)

![](../../../assets/msr-2-add-co2-pic-3-1.jpg)

2\. Identify the "X" on the PCB on the back of your MSR-2 and the "X" on the top left corner of the GPIO Header addon.

![](assets/msr-2-gpio-header-pic-1.jpg)

![](assets/msr-2-gpio-header-pic-2.jpg)

3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.

![](assets/msr-2-gpio-header-pic-3.jpg)

4\. Align the new back for your MSR-2 that came with the GPIO Header addon. Push down on the corners closest to the GPIO Header addon first, and then push the back on securely on the other two corners.

![](assets/msr-2-gpio-header-pic-5.jpg)

![](assets/msr-2-gpio-header-pic-4.jpg)

!!! tip "Make sure to check out our MSR-2 GPIO Header LED Strip Tutorial!"

Brandon AKA SmartHomeSellout made this neat tutorial for how to connect a short LED strip to your MSR-2

<a href="https://wiki.apolloautomation.com/products/msr2/examples/gpio-header-control-an-led-strip/" target="_blank" rel="noreferrer nofollow noopener">GPIO LED Strip Tutorial</a><br>
31 changes: 31 additions & 0 deletions docs/products/r-pro-1/addons/adding-rear-female-usb-to-msr-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Add the rear female usb-c port to your MSR-2
description: Tutorial on adding the rear female usb-c port to your MSR-2.
---
# Adding Rear Female USB-C To MSR-2

1\. Unplug your MSR-2 from power and remove the back

![](../../../assets/msr-2-add-co2-pic-1.jpg)

![](../../../assets/msr-2-add-co2-pic-2.jpg)

![](../../../assets/msr-2-add-co2-pic-3-1.jpg)

2\. Identify the "X" on the PCB on the back of your MSR-2 and the "X" on the top left corner of the Female Rear USB-C addon.

![](assets/msr-2-female-usb-c-pic-1.jpeg)

![](assets/msr-2-female-usb-c-pic-2.jpeg)

3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.

![](assets/msr-2-female-usb-c-pic-3.jpeg)

4\. Align the new back for your MSR-2 that came with the Female USB-C addon. It's possible you might have a flat back version and <a href="https://www.printables.com/model/932026-apollo-automation-msr-2-mmwave-co2-multisensor-for/files#preview.file.oGG7K" target="_blank" rel="noreferrer nofollow noopener">you can print that yourself too!</a>

![](assets/msr-2-female-usb-c-pic-4.jpeg)

5\. Push down on the corners closest to the USB-C addon first, and then push the back on securely on the other two corners.

![](assets/msr-2-female-usb-c-pic-5.jpeg)
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
25 changes: 25 additions & 0 deletions docs/products/r-pro-1/addons/msr2-outlet-mount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: MSR-2 Outlet Mount
description: Tutorial for using the MSR-2 Outlet Mount.
---
# MSR-2 Outlet Mount

1\. Gather a top facing usb-c plug, an MSR-2, and our MSR-2 Outlet Mount.

![](assets/msr-2-outlet-mount-pic-1.jpg)

2\. Align the MSR-2 with the USB-C port facing the left side and align the MSR-2 Outlet Mount as shown in the image below.

![](assets/msr-2-outlet-mount-pic-2.jpg)

3\. Push the MSR-2 Outlet Mount into the usb-c port until it's fully seated. Do not push hard, it will go in very smoothly.

![](assets/msr-2-outlet-mount-pic-3.jpg)

4\. Gently push the other USB-C port of the MSR-2 Outlet Mount into the top of the USB-C top facing plug.

![](assets/msr-2-outlet-mount-pic-4.jpg)

!!! success "You're ready to plug it in and begin using your device!"

Make sure to head to our <a href="https://wiki.apolloautomation.com/products/general/setup/getting-started-msr2/" target="_blank" rel="noreferrer nofollow noopener">getting started guide</a> to get your MSR-2 up and running!
Binary file not shown.
Binary file not shown.
Binary file added docs/products/r-pro-1/assets/20240514-123742.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 not shown.
Binary file not shown.
Binary file not shown.
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 not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/products/r-pro-1/assets/HJuimage.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/products/r-pro-1/assets/alarmo-1.png
Binary file added docs/products/r-pro-1/assets/alarmo-2.png
Binary file added docs/products/r-pro-1/assets/alarmo-3.png
Binary file added docs/products/r-pro-1/assets/alarmo-4.png
Binary file added docs/products/r-pro-1/assets/alarmo-5.png
Binary file added docs/products/r-pro-1/assets/alarmo-6.png
Binary file added docs/products/r-pro-1/assets/alarmo-7.png
Binary file added docs/products/r-pro-1/assets/average.png
Binary file not shown.
Binary file added docs/products/r-pro-1/assets/co-2-graph.png
Binary file added docs/products/r-pro-1/assets/co2-guage.png
Binary file added docs/products/r-pro-1/assets/comselection.png
Binary file added docs/products/r-pro-1/assets/dbn.png
Binary file added docs/products/r-pro-1/assets/dd-dt-and-start.png
Binary file added docs/products/r-pro-1/assets/diagnostic.png
Binary file added docs/products/r-pro-1/assets/em.png
Binary file added docs/products/r-pro-1/assets/find-device.png
Binary file not shown.
Binary file added docs/products/r-pro-1/assets/high-threshold.png
Binary file added docs/products/r-pro-1/assets/img-3784.jpeg
Binary file added docs/products/r-pro-1/assets/img-3787.jpeg
Binary file added docs/products/r-pro-1/assets/img-3788.jpeg
Binary file added docs/products/r-pro-1/assets/img-3789.jpeg
Binary file added docs/products/r-pro-1/assets/intelligent.png
Binary file added docs/products/r-pro-1/assets/ld2410-gates.png
Binary file added docs/products/r-pro-1/assets/ld2410-table.png
Binary file added docs/products/r-pro-1/assets/ld2410-table_1.png
Binary file added docs/products/r-pro-1/assets/low-threshold.png
Binary file added docs/products/r-pro-1/assets/manual.png
Binary file added docs/products/r-pro-1/assets/max.png
Binary file added docs/products/r-pro-1/assets/more-and-ps.png
Binary file added docs/products/r-pro-1/assets/msr-1-radar-map.png
Binary file added docs/products/r-pro-1/assets/msr-2-wwha.png
Binary file not shown.
Binary file not shown.
Binary file added docs/products/r-pro-1/assets/plotly-co2-graph.png
51 changes: 51 additions & 0 deletions docs/products/r-pro-1/calibrating-and-updating/zones-ha.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: MSR-2 Home Assistant Zone Configuration
description: Tutorial for MSR-2 Home Assistant Zone Configuration.
---
# How To Tune mmWave Using Home Assistant

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.


Here is a video of how to tune the mmWave sensor using radar engineering mode,


1. Open Home Assistant
2. Navigate to Settings>Devices & services>ESPHome>Select the MSR-2
3. Scroll down to the Configuration section
4. Turn on Radar Engineering Mode (REM)
![Configuration.png](../assets/5l4configuration.png)
5. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8
![Diagnostic.png](../assets/diagnostic.png)
6. The gates are different distances from the sensor
![ld2410 table.png](../assets/ld2410-table_1.png)![MSR-1 radar map.png](../assets/msr-1-radar-map_1.png)
7. Moving the gate still and move threshold slider to the right increases the amount of energy needed to trigger the sensor. Do this if you want the gate to be less sensitive.
![High Threshold.png](../assets/high-threshold.png)
8. Moving the gate still and move threshold slider to the left decreases the amount of energy needed to trigger the sensor. Do this if you want the gate to be more sensitive.
![Low Threshold.png](../assets/low-threshold.png)

**Alternate Method**

Thanks to [MakeItWorkTech](https://www.youtube.com/@makeitworktech) for this method!

"I ended up maxing out the sliders on all gates and then bringing them down just enough to pick up human presence. Definitely easier than using the LD2410B app."

**Example**

\- You may have an open-concept kitchen and living room, and you want the MSR-1 to activate your under-cabinet lights only when you're in the kitchen.

Here's how:

1. Stand in the desired trigger locations.
2. Observe the gate energy.
3. Adjust the gate threshold slider to the right, increasing the energy required to trigger the mmWave sensor. This ensures that your kitchen lights only come on when you're actually in the kitchen, not just walking by in the living room. Also, you can lower the gate threshold in the kitchen by moving the slider to the left. This makes the mmWave sensor more sensitive, even when standing still. This way, you avoid having the lights go off while reading a recipe or doing the dishes.

\- From clarinetJWD, "Engineering mode is what I was missing at first. I did exactly that, and now detection is basically perfect! My under cabinet lights now come on to max brightness whenever someone is in the kitchen, and return to their previous value when they leave. Next up is replacing the really flaky motion switch in my garage so it stops shutting off when I'm doing a project at the workbench! Thanks, these are really good.

**References**

- [https://youtu.be/dAzHXpP3FcI?t=431](https://youtu.be/dAzHXpP3FcI?t=431)
- [https://community.home-assistant.io/t/ld2410-esphome-tips/477058/316](https://community.home-assistant.io/t/ld2410-esphome-tips/477058/316)
- [https://www.youtube.com/watch?v=l212Lvo1R6s](https://www.youtube.com/watch?v=l212Lvo1R6s)
59 changes: 59 additions & 0 deletions docs/products/r-pro-1/calibrating-and-updating/zones-hlk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: MSR-2 HLKRadarTool app Zone Configuration
description: Tutorial for MSR-2 HLKRadarTool app Zone Configuration.
---
# How To Tune mmWave Using HLKRadarTool

###### **Auto-Calibration**

1\. Download the HLKRadarTool app for either [Android](https://play.google.com/store/apps/details?id=com.hlk.hlkradartool&amp;hl=en_US%E2%89%B7=US)or [Apple](https://apps.apple.com/us/app/hlkradartool/id1638651152).

The default password to connect to the HLKRadarTool is "HiLink"

2\. Ensure the mmWave radar you want to tune has LD2410 Bluetooth turned on. Home Assistant &gt; Settings &gt; Devices & services &gt; ESPHome Devices &gt; Select Device &gt; Scroll down and toggle on ld2410 Bluetooth.

![Radar Control Bluetooth.png](assets/msr-2-mmwave-hlk-pic-1.png)

3\. Open the app and select your device

![Find Device.png](../assets/find-device.png)

4\. Turn on Engineering Mode

![EM.png](../assets/em.png)

5\. Select More and then select Parameter settings

![More and PS.png](../assets/more-and-ps.png)

6\. Select Detect background noise

![DBN.png](../assets/dbn.png)

7\. Insert Delay detection and Detection time values. (For iPhone users Delay detection cannot be 0). Then select Start. This will give us our reference values so we can auto-calibrate the mmWave sensor.

![DD, DT and Start.png](../assets/dd-dt-and-start.png)

8\. Select Back to navigate to the Parameter settings. Then select one of the auto-calibration buttons.

**Average** - Sets the gate sensitivity to the average move and still energy

![Average.png](../assets/average.png)

**Maximum** - Sets the gate sensitivity to the maximum move and still energy

![Max.png](../assets/max.png)

**Intelligent** \- Sets the gate sensitivity equal to or just above the maximum move and still energy.

**![Intelligent.png](../assets/intelligent.png)**

###### Manual Calibration

1\. Repeat steps 1-5 above.

2\. Select Motion or Static sensitivity, change it to your desired value, and select Set.

![Manual.png](../assets/manual.png)

3\. Now your MSR-2 should be tuned to your environment!
1 change: 1 addition & 0 deletions docs/products/r-pro-1/calibrating-co2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "products/general/calibrating-and-updating/co2-calibration-quick.md"
Loading