diff --git a/cloudcannon.config.yml b/cloudcannon.config.yml index f8d32b6ed..1eb940149 100644 --- a/cloudcannon.config.yml +++ b/cloudcannon.config.yml @@ -1,5 +1,5 @@ paths: -# uploads: "docs/assets" + uploads: "docs/assets" uploads_filename: uploads_use_relative_path: true static: "" @@ -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: @@ -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: diff --git a/docs/products/air1/examples/firstof9's-apex-charts.md b/docs/products/air1/examples/firstof9's-apex-charts.md index 0a06098a3..06bd991a6 100644 --- a/docs/products/air1/examples/firstof9's-apex-charts.md +++ b/docs/products/air1/examples/firstof9's-apex-charts.md @@ -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 @@ -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" @@ -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) @@ -44,8 +46,6 @@ VSC Find/Replace ![AIR-1 Find and Replace.png](../assets/OQfair-1-find-and-replace.png) -ChatGPT
![Good ChatGPT.png](../assets/vBggood-chatgpt.png) - **This is the code!** ```yaml diff --git a/docs/products/r-pro-1/addons/adding-90-degree-usb-c-to-msr-2.md b/docs/products/r-pro-1/addons/adding-90-degree-usb-c-to-msr-2.md new file mode 100644 index 000000000..405c38a7e --- /dev/null +++ b/docs/products/r-pro-1/addons/adding-90-degree-usb-c-to-msr-2.md @@ -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 getting started guide to get your MSR-2 up and running! \ No newline at end of file diff --git a/docs/products/r-pro-1/addons/adding-articulating-stand-to-msr-2.md b/docs/products/r-pro-1/addons/adding-articulating-stand-to-msr-2.md new file mode 100644 index 000000000..94ca63aa3 --- /dev/null +++ b/docs/products/r-pro-1/addons/adding-articulating-stand-to-msr-2.md @@ -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) \ No newline at end of file diff --git a/docs/products/r-pro-1/addons/adding-co2-to-msr-2.md b/docs/products/r-pro-1/addons/adding-co2-to-msr-2.md new file mode 100644 index 000000000..df6b270a9 --- /dev/null +++ b/docs/products/r-pro-1/addons/adding-co2-to-msr-2.md @@ -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 CO2 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 CO2 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 CO2 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 [CO2 calibration guide](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/ "CO2 Calibration") to calibrate the CO2 module after installation. This is required for all CO2 addons purchased from us separately from a product (such as buying it to addon to an existing Apollo device). \ No newline at end of file diff --git a/docs/products/r-pro-1/addons/adding-gpio-header-to-msr-2.md b/docs/products/r-pro-1/addons/adding-gpio-header-to-msr-2.md new file mode 100644 index 000000000..6daff857d --- /dev/null +++ b/docs/products/r-pro-1/addons/adding-gpio-header-to-msr-2.md @@ -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 + + GPIO LED Strip Tutorial
\ No newline at end of file diff --git a/docs/products/r-pro-1/addons/adding-rear-female-usb-to-msr-2.md b/docs/products/r-pro-1/addons/adding-rear-female-usb-to-msr-2.md new file mode 100644 index 000000000..4e2caeba0 --- /dev/null +++ b/docs/products/r-pro-1/addons/adding-rear-female-usb-to-msr-2.md @@ -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 you can print that yourself too! + +![](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) \ No newline at end of file diff --git a/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-0.jpg b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-0.jpg new file mode 100644 index 000000000..10953210c Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-0.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-1.jpg b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-1.jpg new file mode 100644 index 000000000..5a13cb60a Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-1.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-2.jpg b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-2.jpg new file mode 100644 index 000000000..01916982b Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-2.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-3.jpg b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-3.jpg new file mode 100644 index 000000000..54f6858f6 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-3.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-5.jpg b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-5.jpg new file mode 100644 index 000000000..506b87101 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-90-degree-pic-5.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-1.jpeg b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-1.jpeg new file mode 100644 index 000000000..aecaf1be1 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-1.jpeg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-2.jpeg b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-2.jpeg new file mode 100644 index 000000000..c7691a99e Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-2.jpeg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-3.jpeg b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-3.jpeg new file mode 100644 index 000000000..e69c4f49a Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-3.jpeg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-4.jpeg b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-4.jpeg new file mode 100644 index 000000000..ad512a039 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-4.jpeg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-5.jpeg b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-5.jpeg new file mode 100644 index 000000000..573c47b13 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-female-usb-c-pic-5.jpeg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-1.jpg b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-1.jpg new file mode 100644 index 000000000..307177388 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-1.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-2.jpg b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-2.jpg new file mode 100644 index 000000000..0137048af Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-2.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-3.jpg b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-3.jpg new file mode 100644 index 000000000..639f7a50b Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-3.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-4.jpg b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-4.jpg new file mode 100644 index 000000000..10938fd60 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-4.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-5.jpg b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-5.jpg new file mode 100644 index 000000000..e4458f16c Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-gpio-header-pic-5.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-1.jpg b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-1.jpg new file mode 100644 index 000000000..0938854c9 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-1.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-2.jpg b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-2.jpg new file mode 100644 index 000000000..189ee32a8 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-2.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-3.jpg b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-3.jpg new file mode 100644 index 000000000..2f8af4d49 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-3.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-4.jpg b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-4.jpg new file mode 100644 index 000000000..5461c700e Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-outlet-mount-pic-4.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-1.jpg b/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-1.jpg new file mode 100644 index 000000000..f3fc58fcb Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-1.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-2.jpg b/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-2.jpg new file mode 100644 index 000000000..ce3761f01 Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-2.jpg differ diff --git a/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-3.jpg b/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-3.jpg new file mode 100644 index 000000000..75c4d527b Binary files /dev/null and b/docs/products/r-pro-1/addons/assets/msr-2-stand-pic-3.jpg differ diff --git a/docs/products/r-pro-1/addons/msr2-outlet-mount.md b/docs/products/r-pro-1/addons/msr2-outlet-mount.md new file mode 100644 index 000000000..bb9342ad2 --- /dev/null +++ b/docs/products/r-pro-1/addons/msr2-outlet-mount.md @@ -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 getting started guide to get your MSR-2 up and running! \ No newline at end of file diff --git a/docs/products/r-pro-1/assets/0Jrm5FqWzsc9G2KmWBJWMLEr2J4aYyj4Bg.jpg_1719609483 b/docs/products/r-pro-1/assets/0Jrm5FqWzsc9G2KmWBJWMLEr2J4aYyj4Bg.jpg_1719609483 new file mode 100644 index 000000000..b5c419355 Binary files /dev/null and b/docs/products/r-pro-1/assets/0Jrm5FqWzsc9G2KmWBJWMLEr2J4aYyj4Bg.jpg_1719609483 differ diff --git a/docs/products/r-pro-1/assets/1OhdBudlNh2Rk8SoytNKdoUHqknn8KA8sQ.png_1719613457 b/docs/products/r-pro-1/assets/1OhdBudlNh2Rk8SoytNKdoUHqknn8KA8sQ.png_1719613457 new file mode 100644 index 000000000..142796408 Binary files /dev/null and b/docs/products/r-pro-1/assets/1OhdBudlNh2Rk8SoytNKdoUHqknn8KA8sQ.png_1719613457 differ diff --git a/docs/products/r-pro-1/assets/20240514-123742.jpg b/docs/products/r-pro-1/assets/20240514-123742.jpg new file mode 100644 index 000000000..5226af86c Binary files /dev/null and b/docs/products/r-pro-1/assets/20240514-123742.jpg differ diff --git a/docs/products/r-pro-1/assets/28MMBJEeIQOmwUGtP9L3cx0PtCaTL0HX_Q.png_1719612259 b/docs/products/r-pro-1/assets/28MMBJEeIQOmwUGtP9L3cx0PtCaTL0HX_Q.png_1719612259 new file mode 100644 index 000000000..2a71521c7 Binary files /dev/null and b/docs/products/r-pro-1/assets/28MMBJEeIQOmwUGtP9L3cx0PtCaTL0HX_Q.png_1719612259 differ diff --git a/docs/products/r-pro-1/assets/4Er61OH8tF-IaiVvom0cWPeOyfNkRWtibw.jpg_1719610507 b/docs/products/r-pro-1/assets/4Er61OH8tF-IaiVvom0cWPeOyfNkRWtibw.jpg_1719610507 new file mode 100644 index 000000000..23be94aa0 Binary files /dev/null and b/docs/products/r-pro-1/assets/4Er61OH8tF-IaiVvom0cWPeOyfNkRWtibw.jpg_1719610507 differ diff --git a/docs/products/r-pro-1/assets/4OHLuxZVKc1TcCGLfvAEf-1UUl-IzmeHzQ.jpg_1719610515 b/docs/products/r-pro-1/assets/4OHLuxZVKc1TcCGLfvAEf-1UUl-IzmeHzQ.jpg_1719610515 new file mode 100644 index 000000000..4ab4cceb8 Binary files /dev/null and b/docs/products/r-pro-1/assets/4OHLuxZVKc1TcCGLfvAEf-1UUl-IzmeHzQ.jpg_1719610515 differ diff --git a/docs/products/r-pro-1/assets/5T520240514-120819.jpg b/docs/products/r-pro-1/assets/5T520240514-120819.jpg new file mode 100644 index 000000000..22d1690b1 Binary files /dev/null and b/docs/products/r-pro-1/assets/5T520240514-120819.jpg differ diff --git a/docs/products/r-pro-1/assets/5l4configuration.png b/docs/products/r-pro-1/assets/5l4configuration.png new file mode 100644 index 000000000..22ba463ef Binary files /dev/null and b/docs/products/r-pro-1/assets/5l4configuration.png differ diff --git a/docs/products/r-pro-1/assets/5qmwmycqbmvoz-mlkdotbzwkc-4-rei8a.jpg b/docs/products/r-pro-1/assets/5qmwmycqbmvoz-mlkdotbzwkc-4-rei8a.jpg new file mode 100644 index 000000000..11e7ec311 Binary files /dev/null and b/docs/products/r-pro-1/assets/5qmwmycqbmvoz-mlkdotbzwkc-4-rei8a.jpg differ diff --git a/docs/products/r-pro-1/assets/6uv5liNNA-wHLFfHxiadM56YpIonKQalTg.jpg_1719609565 b/docs/products/r-pro-1/assets/6uv5liNNA-wHLFfHxiadM56YpIonKQalTg.jpg_1719609565 new file mode 100644 index 000000000..906a52641 Binary files /dev/null and b/docs/products/r-pro-1/assets/6uv5liNNA-wHLFfHxiadM56YpIonKQalTg.jpg_1719609565 differ diff --git a/docs/products/r-pro-1/assets/9UJnA9aCGf0TNw1uc3ik2xEFxXlLs95bOw.jpg_1719609472 b/docs/products/r-pro-1/assets/9UJnA9aCGf0TNw1uc3ik2xEFxXlLs95bOw.jpg_1719609472 new file mode 100644 index 000000000..5460fb4b9 Binary files /dev/null and b/docs/products/r-pro-1/assets/9UJnA9aCGf0TNw1uc3ik2xEFxXlLs95bOw.jpg_1719609472 differ diff --git a/docs/products/r-pro-1/assets/BDLaEPEomVhYjATCJMSVMltiTS9aoVY9YQ.jpg_1719611545 b/docs/products/r-pro-1/assets/BDLaEPEomVhYjATCJMSVMltiTS9aoVY9YQ.jpg_1719611545 new file mode 100644 index 000000000..4b6224cce Binary files /dev/null and b/docs/products/r-pro-1/assets/BDLaEPEomVhYjATCJMSVMltiTS9aoVY9YQ.jpg_1719611545 differ diff --git a/docs/products/r-pro-1/assets/EQdHu-pdF_2D7T6GJkjdqSQYZptmHk-cmw.png_1719612604 b/docs/products/r-pro-1/assets/EQdHu-pdF_2D7T6GJkjdqSQYZptmHk-cmw.png_1719612604 new file mode 100644 index 000000000..097ce6c83 Binary files /dev/null and b/docs/products/r-pro-1/assets/EQdHu-pdF_2D7T6GJkjdqSQYZptmHk-cmw.png_1719612604 differ diff --git a/docs/products/r-pro-1/assets/GublKQEhWUdU-OxJiA948P3_HGiwxTpn4w.png_1719613216 b/docs/products/r-pro-1/assets/GublKQEhWUdU-OxJiA948P3_HGiwxTpn4w.png_1719613216 new file mode 100644 index 000000000..5035caed8 Binary files /dev/null and b/docs/products/r-pro-1/assets/GublKQEhWUdU-OxJiA948P3_HGiwxTpn4w.png_1719613216 differ diff --git a/docs/products/r-pro-1/assets/HJuimage.png b/docs/products/r-pro-1/assets/HJuimage.png new file mode 100644 index 000000000..2c7109d76 Binary files /dev/null and b/docs/products/r-pro-1/assets/HJuimage.png differ diff --git a/docs/products/r-pro-1/assets/JI4fSugUQvhRpK1FauJEEPoj3Vwe-QD02Q.jpg_1719613900 b/docs/products/r-pro-1/assets/JI4fSugUQvhRpK1FauJEEPoj3Vwe-QD02Q.jpg_1719613900 new file mode 100644 index 000000000..4043896c9 Binary files /dev/null and b/docs/products/r-pro-1/assets/JI4fSugUQvhRpK1FauJEEPoj3Vwe-QD02Q.jpg_1719613900 differ diff --git a/docs/products/r-pro-1/assets/LwzqEXM9B89IWUQCIdZtwo_uYIbYVzdT0g.jpg_1719611264 b/docs/products/r-pro-1/assets/LwzqEXM9B89IWUQCIdZtwo_uYIbYVzdT0g.jpg_1719611264 new file mode 100644 index 000000000..8744410dd Binary files /dev/null and b/docs/products/r-pro-1/assets/LwzqEXM9B89IWUQCIdZtwo_uYIbYVzdT0g.jpg_1719611264 differ diff --git a/docs/products/r-pro-1/assets/MJ120240514-123742.jpg b/docs/products/r-pro-1/assets/MJ120240514-123742.jpg new file mode 100644 index 000000000..953c5f987 Binary files /dev/null and b/docs/products/r-pro-1/assets/MJ120240514-123742.jpg differ diff --git a/docs/products/r-pro-1/assets/Me6P6lhhZUQMhuY--kIQqoFHV6QgrxpO0g.jpg_1719611251 b/docs/products/r-pro-1/assets/Me6P6lhhZUQMhuY--kIQqoFHV6QgrxpO0g.jpg_1719611251 new file mode 100644 index 000000000..fc80512ed Binary files /dev/null and b/docs/products/r-pro-1/assets/Me6P6lhhZUQMhuY--kIQqoFHV6QgrxpO0g.jpg_1719611251 differ diff --git a/docs/products/r-pro-1/assets/ObY0NPGDBIBaXPuhUVzo80fr1fToBm5ekg.png_1719613432 b/docs/products/r-pro-1/assets/ObY0NPGDBIBaXPuhUVzo80fr1fToBm5ekg.png_1719613432 new file mode 100644 index 000000000..2dc48a278 Binary files /dev/null and b/docs/products/r-pro-1/assets/ObY0NPGDBIBaXPuhUVzo80fr1fToBm5ekg.png_1719613432 differ diff --git a/docs/products/r-pro-1/assets/P3TZVCVhVSBYXFOWtPc4fZML_8-LQTEHQw.jpg_1719609689 b/docs/products/r-pro-1/assets/P3TZVCVhVSBYXFOWtPc4fZML_8-LQTEHQw.jpg_1719609689 new file mode 100644 index 000000000..7f181cb03 Binary files /dev/null and b/docs/products/r-pro-1/assets/P3TZVCVhVSBYXFOWtPc4fZML_8-LQTEHQw.jpg_1719609689 differ diff --git a/docs/products/r-pro-1/assets/YfpAVN1FtpsODgbFgZg8qEVBNjl3NgaAvQ.png_1719613175 b/docs/products/r-pro-1/assets/YfpAVN1FtpsODgbFgZg8qEVBNjl3NgaAvQ.png_1719613175 new file mode 100644 index 000000000..3d8fbdfbd Binary files /dev/null and b/docs/products/r-pro-1/assets/YfpAVN1FtpsODgbFgZg8qEVBNjl3NgaAvQ.png_1719613175 differ diff --git a/docs/products/r-pro-1/assets/a6nANg-L_gqIkPH6ZKQo6mCSSSbacF7FkQ.jpg_1719609655 b/docs/products/r-pro-1/assets/a6nANg-L_gqIkPH6ZKQo6mCSSSbacF7FkQ.jpg_1719609655 new file mode 100644 index 000000000..15e7dde9c Binary files /dev/null and b/docs/products/r-pro-1/assets/a6nANg-L_gqIkPH6ZKQo6mCSSSbacF7FkQ.jpg_1719609655 differ diff --git a/docs/products/r-pro-1/assets/alarmo-1.png b/docs/products/r-pro-1/assets/alarmo-1.png new file mode 100644 index 000000000..d82c261b5 Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-1.png differ diff --git a/docs/products/r-pro-1/assets/alarmo-2.png b/docs/products/r-pro-1/assets/alarmo-2.png new file mode 100644 index 000000000..0fe0ff4dc Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-2.png differ diff --git a/docs/products/r-pro-1/assets/alarmo-3.png b/docs/products/r-pro-1/assets/alarmo-3.png new file mode 100644 index 000000000..abc5827e2 Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-3.png differ diff --git a/docs/products/r-pro-1/assets/alarmo-4.png b/docs/products/r-pro-1/assets/alarmo-4.png new file mode 100644 index 000000000..362ced1e3 Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-4.png differ diff --git a/docs/products/r-pro-1/assets/alarmo-5.png b/docs/products/r-pro-1/assets/alarmo-5.png new file mode 100644 index 000000000..3b7f2ef0d Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-5.png differ diff --git a/docs/products/r-pro-1/assets/alarmo-6.png b/docs/products/r-pro-1/assets/alarmo-6.png new file mode 100644 index 000000000..cb66f727e Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-6.png differ diff --git a/docs/products/r-pro-1/assets/alarmo-7.png b/docs/products/r-pro-1/assets/alarmo-7.png new file mode 100644 index 000000000..b300844cd Binary files /dev/null and b/docs/products/r-pro-1/assets/alarmo-7.png differ diff --git a/docs/products/r-pro-1/assets/average.png b/docs/products/r-pro-1/assets/average.png new file mode 100644 index 000000000..3215aea02 Binary files /dev/null and b/docs/products/r-pro-1/assets/average.png differ diff --git a/docs/products/r-pro-1/assets/cS6XiR5FyO8wvSBi9sW3466gHoUWfT7HhA.png_1719600483 b/docs/products/r-pro-1/assets/cS6XiR5FyO8wvSBi9sW3466gHoUWfT7HhA.png_1719600483 new file mode 100644 index 000000000..ce4d91633 Binary files /dev/null and b/docs/products/r-pro-1/assets/cS6XiR5FyO8wvSBi9sW3466gHoUWfT7HhA.png_1719600483 differ diff --git a/docs/products/r-pro-1/assets/co-2-graph.png b/docs/products/r-pro-1/assets/co-2-graph.png new file mode 100644 index 000000000..c7f761edb Binary files /dev/null and b/docs/products/r-pro-1/assets/co-2-graph.png differ diff --git a/docs/products/r-pro-1/assets/co2-guage.png b/docs/products/r-pro-1/assets/co2-guage.png new file mode 100644 index 000000000..cb0259e7f Binary files /dev/null and b/docs/products/r-pro-1/assets/co2-guage.png differ diff --git a/docs/products/r-pro-1/assets/comselection.png b/docs/products/r-pro-1/assets/comselection.png new file mode 100644 index 000000000..7dc7450cf Binary files /dev/null and b/docs/products/r-pro-1/assets/comselection.png differ diff --git a/docs/products/r-pro-1/assets/dbn.png b/docs/products/r-pro-1/assets/dbn.png new file mode 100644 index 000000000..71787debc Binary files /dev/null and b/docs/products/r-pro-1/assets/dbn.png differ diff --git a/docs/products/r-pro-1/assets/dd-dt-and-start.png b/docs/products/r-pro-1/assets/dd-dt-and-start.png new file mode 100644 index 000000000..5af2e97e1 Binary files /dev/null and b/docs/products/r-pro-1/assets/dd-dt-and-start.png differ diff --git a/docs/products/r-pro-1/assets/diagnostic.png b/docs/products/r-pro-1/assets/diagnostic.png new file mode 100644 index 000000000..48b84ba54 Binary files /dev/null and b/docs/products/r-pro-1/assets/diagnostic.png differ diff --git a/docs/products/r-pro-1/assets/em.png b/docs/products/r-pro-1/assets/em.png new file mode 100644 index 000000000..200709754 Binary files /dev/null and b/docs/products/r-pro-1/assets/em.png differ diff --git a/docs/products/r-pro-1/assets/find-device.png b/docs/products/r-pro-1/assets/find-device.png new file mode 100644 index 000000000..22be2ff59 Binary files /dev/null and b/docs/products/r-pro-1/assets/find-device.png differ diff --git a/docs/products/r-pro-1/assets/gate-zones-and-rr.png b/docs/products/r-pro-1/assets/gate-zones-and-rr.png new file mode 100644 index 000000000..a6a5574f4 Binary files /dev/null and b/docs/products/r-pro-1/assets/gate-zones-and-rr.png differ diff --git a/docs/products/r-pro-1/assets/hbfGA0fIQlpnykuuZOhiEuHlZDW7r3GfoQ.jpg_1719609715 b/docs/products/r-pro-1/assets/hbfGA0fIQlpnykuuZOhiEuHlZDW7r3GfoQ.jpg_1719609715 new file mode 100644 index 000000000..2307f1b39 Binary files /dev/null and b/docs/products/r-pro-1/assets/hbfGA0fIQlpnykuuZOhiEuHlZDW7r3GfoQ.jpg_1719609715 differ diff --git a/docs/products/r-pro-1/assets/high-threshold.png b/docs/products/r-pro-1/assets/high-threshold.png new file mode 100644 index 000000000..ee736d4ae Binary files /dev/null and b/docs/products/r-pro-1/assets/high-threshold.png differ diff --git a/docs/products/r-pro-1/assets/image-1698806082666.png b/docs/products/r-pro-1/assets/image-1698806082666.png new file mode 100644 index 000000000..53d35e32e Binary files /dev/null and b/docs/products/r-pro-1/assets/image-1698806082666.png differ diff --git a/docs/products/r-pro-1/assets/image-1698806750134.png b/docs/products/r-pro-1/assets/image-1698806750134.png new file mode 100644 index 000000000..a3830789a Binary files /dev/null and b/docs/products/r-pro-1/assets/image-1698806750134.png differ diff --git a/docs/products/r-pro-1/assets/image-1698806793309.png b/docs/products/r-pro-1/assets/image-1698806793309.png new file mode 100644 index 000000000..d8f0d3097 Binary files /dev/null and b/docs/products/r-pro-1/assets/image-1698806793309.png differ diff --git a/docs/products/r-pro-1/assets/img-3784.jpeg b/docs/products/r-pro-1/assets/img-3784.jpeg new file mode 100644 index 000000000..eb461de0c Binary files /dev/null and b/docs/products/r-pro-1/assets/img-3784.jpeg differ diff --git a/docs/products/r-pro-1/assets/img-3787.jpeg b/docs/products/r-pro-1/assets/img-3787.jpeg new file mode 100644 index 000000000..baa9d7bbc Binary files /dev/null and b/docs/products/r-pro-1/assets/img-3787.jpeg differ diff --git a/docs/products/r-pro-1/assets/img-3788.jpeg b/docs/products/r-pro-1/assets/img-3788.jpeg new file mode 100644 index 000000000..ce759c489 Binary files /dev/null and b/docs/products/r-pro-1/assets/img-3788.jpeg differ diff --git a/docs/products/r-pro-1/assets/img-3789.jpeg b/docs/products/r-pro-1/assets/img-3789.jpeg new file mode 100644 index 000000000..b8e922133 Binary files /dev/null and b/docs/products/r-pro-1/assets/img-3789.jpeg differ diff --git a/docs/products/r-pro-1/assets/intelligent.png b/docs/products/r-pro-1/assets/intelligent.png new file mode 100644 index 000000000..8fa27927d Binary files /dev/null and b/docs/products/r-pro-1/assets/intelligent.png differ diff --git a/docs/products/r-pro-1/assets/jpe-apex-charts-3.png b/docs/products/r-pro-1/assets/jpe-apex-charts-3.png new file mode 100644 index 000000000..f1f1990db Binary files /dev/null and b/docs/products/r-pro-1/assets/jpe-apex-charts-3.png differ diff --git a/docs/products/r-pro-1/assets/ld2410-gates.png b/docs/products/r-pro-1/assets/ld2410-gates.png new file mode 100644 index 000000000..84c84531f Binary files /dev/null and b/docs/products/r-pro-1/assets/ld2410-gates.png differ diff --git a/docs/products/r-pro-1/assets/ld2410-mounting-hor-1.jpeg b/docs/products/r-pro-1/assets/ld2410-mounting-hor-1.jpeg new file mode 100644 index 000000000..36c3939f7 Binary files /dev/null and b/docs/products/r-pro-1/assets/ld2410-mounting-hor-1.jpeg differ diff --git a/docs/products/r-pro-1/assets/ld2410-table.png b/docs/products/r-pro-1/assets/ld2410-table.png new file mode 100644 index 000000000..bc6177712 Binary files /dev/null and b/docs/products/r-pro-1/assets/ld2410-table.png differ diff --git a/docs/products/r-pro-1/assets/ld2410-table_1.png b/docs/products/r-pro-1/assets/ld2410-table_1.png new file mode 100644 index 000000000..bc6177712 Binary files /dev/null and b/docs/products/r-pro-1/assets/ld2410-table_1.png differ diff --git a/docs/products/r-pro-1/assets/ld2410-zone-map.png b/docs/products/r-pro-1/assets/ld2410-zone-map.png new file mode 100644 index 000000000..d1d54bb9a Binary files /dev/null and b/docs/products/r-pro-1/assets/ld2410-zone-map.png differ diff --git a/docs/products/r-pro-1/assets/low-threshold.png b/docs/products/r-pro-1/assets/low-threshold.png new file mode 100644 index 000000000..488ac79f8 Binary files /dev/null and b/docs/products/r-pro-1/assets/low-threshold.png differ diff --git a/docs/products/r-pro-1/assets/manual.png b/docs/products/r-pro-1/assets/manual.png new file mode 100644 index 000000000..6eaedf6eb Binary files /dev/null and b/docs/products/r-pro-1/assets/manual.png differ diff --git a/docs/products/r-pro-1/assets/max.png b/docs/products/r-pro-1/assets/max.png new file mode 100644 index 000000000..fab26d74e Binary files /dev/null and b/docs/products/r-pro-1/assets/max.png differ diff --git a/docs/products/r-pro-1/assets/more-and-ps.png b/docs/products/r-pro-1/assets/more-and-ps.png new file mode 100644 index 000000000..79fb88b2d Binary files /dev/null and b/docs/products/r-pro-1/assets/more-and-ps.png differ diff --git a/docs/products/r-pro-1/assets/msr-1-radar-map.png b/docs/products/r-pro-1/assets/msr-1-radar-map.png new file mode 100644 index 000000000..3f69c244d Binary files /dev/null and b/docs/products/r-pro-1/assets/msr-1-radar-map.png differ diff --git a/docs/products/r-pro-1/assets/msr-1-radar-map_1.png b/docs/products/r-pro-1/assets/msr-1-radar-map_1.png new file mode 100644 index 000000000..3f69c244d Binary files /dev/null and b/docs/products/r-pro-1/assets/msr-1-radar-map_1.png differ diff --git a/docs/products/r-pro-1/assets/msr-2-bare-pcb-front.jpg b/docs/products/r-pro-1/assets/msr-2-bare-pcb-front.jpg new file mode 100644 index 000000000..6bfee23e4 Binary files /dev/null and b/docs/products/r-pro-1/assets/msr-2-bare-pcb-front.jpg differ diff --git a/docs/products/r-pro-1/assets/msr-2-bare-pcb-rear.jpg b/docs/products/r-pro-1/assets/msr-2-bare-pcb-rear.jpg new file mode 100644 index 000000000..31433b6a3 Binary files /dev/null and b/docs/products/r-pro-1/assets/msr-2-bare-pcb-rear.jpg differ diff --git a/docs/products/r-pro-1/assets/msr-2-ld2410-front-no-case.jpg b/docs/products/r-pro-1/assets/msr-2-ld2410-front-no-case.jpg new file mode 100644 index 000000000..2be242dd4 Binary files /dev/null and b/docs/products/r-pro-1/assets/msr-2-ld2410-front-no-case.jpg differ diff --git a/docs/products/r-pro-1/assets/msr-2-wwha.png b/docs/products/r-pro-1/assets/msr-2-wwha.png new file mode 100644 index 000000000..952d53947 Binary files /dev/null and b/docs/products/r-pro-1/assets/msr-2-wwha.png differ diff --git a/docs/products/r-pro-1/assets/n0MT-JcoqRwPKYfZOaYyBD2RU4K3x_gmOA.jpg_1719611527 b/docs/products/r-pro-1/assets/n0MT-JcoqRwPKYfZOaYyBD2RU4K3x_gmOA.jpg_1719611527 new file mode 100644 index 000000000..940583ae8 Binary files /dev/null and b/docs/products/r-pro-1/assets/n0MT-JcoqRwPKYfZOaYyBD2RU4K3x_gmOA.jpg_1719611527 differ diff --git a/docs/products/r-pro-1/assets/oBW2IxCJX5zKaZGj_o4JtXuoulEGI8DH5Q.jpg_1719610557 b/docs/products/r-pro-1/assets/oBW2IxCJX5zKaZGj_o4JtXuoulEGI8DH5Q.jpg_1719610557 new file mode 100644 index 000000000..12bbb9492 Binary files /dev/null and b/docs/products/r-pro-1/assets/oBW2IxCJX5zKaZGj_o4JtXuoulEGI8DH5Q.jpg_1719610557 differ diff --git a/docs/products/r-pro-1/assets/plotly-co2-graph.png b/docs/products/r-pro-1/assets/plotly-co2-graph.png new file mode 100644 index 000000000..debd967da Binary files /dev/null and b/docs/products/r-pro-1/assets/plotly-co2-graph.png differ diff --git a/docs/products/r-pro-1/assets/radar-control-bluetooth.png b/docs/products/r-pro-1/assets/radar-control-bluetooth.png new file mode 100644 index 000000000..a6704d99f Binary files /dev/null and b/docs/products/r-pro-1/assets/radar-control-bluetooth.png differ diff --git a/docs/products/r-pro-1/assets/radar-gates-colored.png b/docs/products/r-pro-1/assets/radar-gates-colored.png new file mode 100644 index 000000000..80667876e Binary files /dev/null and b/docs/products/r-pro-1/assets/radar-gates-colored.png differ diff --git a/docs/products/r-pro-1/assets/screenshot-2023-11-01-at-10-52-38-pm.png b/docs/products/r-pro-1/assets/screenshot-2023-11-01-at-10-52-38-pm.png new file mode 100644 index 000000000..c4762afda Binary files /dev/null and b/docs/products/r-pro-1/assets/screenshot-2023-11-01-at-10-52-38-pm.png differ diff --git a/docs/products/r-pro-1/calibrating-and-updating/assets/msr-2-mmwave-hlk-pic-1.png b/docs/products/r-pro-1/calibrating-and-updating/assets/msr-2-mmwave-hlk-pic-1.png new file mode 100644 index 000000000..c79849c36 Binary files /dev/null and b/docs/products/r-pro-1/calibrating-and-updating/assets/msr-2-mmwave-hlk-pic-1.png differ diff --git a/docs/products/r-pro-1/calibrating-and-updating/zones-ha.md b/docs/products/r-pro-1/calibrating-and-updating/zones-ha.md new file mode 100644 index 000000000..c1fcf709b --- /dev/null +++ b/docs/products/r-pro-1/calibrating-and-updating/zones-ha.md @@ -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) \ No newline at end of file diff --git a/docs/products/r-pro-1/calibrating-and-updating/zones-hlk.md b/docs/products/r-pro-1/calibrating-and-updating/zones-hlk.md new file mode 100644 index 000000000..11079a546 --- /dev/null +++ b/docs/products/r-pro-1/calibrating-and-updating/zones-hlk.md @@ -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&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 > Settings > Devices & services > ESPHome Devices > Select Device > 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! \ No newline at end of file diff --git a/docs/products/r-pro-1/calibrating-co2.md b/docs/products/r-pro-1/calibrating-co2.md new file mode 100644 index 000000000..087c1044e --- /dev/null +++ b/docs/products/r-pro-1/calibrating-co2.md @@ -0,0 +1 @@ +--8<-- "products/general/calibrating-and-updating/co2-calibration-quick.md" \ No newline at end of file diff --git a/docs/products/r-pro-1/examples/gpio-header-control-an-led-strip.md b/docs/products/r-pro-1/examples/gpio-header-control-an-led-strip.md new file mode 100644 index 000000000..c4d4c2618 --- /dev/null +++ b/docs/products/r-pro-1/examples/gpio-header-control-an-led-strip.md @@ -0,0 +1,131 @@ +--- +title: How To Use The Apollo GPIO Header To Control An LED Strip +description: A tutorial for how To Use The Apollo GPIO Header To Control An LED Strip. +--- +# How To Use The Apollo GPIO Header To Control An LED Strip + +This tutorial will guide you through setting up one of our MSR-2 devices (works with any mezzanine port on any Apollo Device) with the optional $4.99 GPIO Header which adds pins for you to easily add functionality to your device! In this tutorial, however, we will be focusing on adding an LED strip to your Apollo device. + +**Materials Needed for tutorial:** + +- [Apollo MSR-2](https://apolloautomation.com/products/msr-2), [Apollo MTR-1](https://apolloautomation.com/products/mtr-1), and all other future Apollo Automation products with the mezzanine port. +- [Apollo GPIO Header](https://apolloautomation.com/products/msr-2-gpio-header) +- ws2812b aka neopixel RGB led strip or similar. sk6812 RGBW strip will also work. +- Optional DuPont Cables for GPIO Header but any DuPont cables will do. +- USB-C cable and power brick to power MSR-2 + +You are limited to 300mA of power output from the 5v port. You can either attach an external power supply and power the MSR-2 via 5v and gnd pins or work with the limited power output of the port + +![GPIO Pinout](../assets/cS6XiR5FyO8wvSBi9sW3466gHoUWfT7HhA.png_1719600483) + +Above is an image of the GPIO Header and its pinouts. We can use ports 2,4,6,7 for our data channel to an LED strip or multiple LED strips. We will also use the top two ports which are ground and 5v for power. + +Did you know you can power the esp32 from the 5v and gnd pin? That means you can connect an external power supply and power it without the side USB port being used! This also allows for more power to be given to your LEDs! + +We cannot use the IO ports 0,1,18, or 19 for LEDs but you can use ports 0 and 1 for i2c sensors. + + + +**Connecting the GPIO Header to the MSR-2** + +The first thing we will do is remove our MSR-2 back plate and connect our GPIO Header to our MSR-2 and then put the new GPIO back plate on (blue). + +Step 1. Remove the backplate of the MSR-2 + +![](../assets/0Jrm5FqWzsc9G2KmWBJWMLEr2J4aYyj4Bg.jpg_1719609483) ![](../assets/9UJnA9aCGf0TNw1uc3ik2xEFxXlLs95bOw.jpg_1719609472) + +Step 2. Line up the Xs shown on the msr-2 and the GPIO Header. They should both be facing in the same direction as shown below. + +![](../assets/6uv5liNNA-wHLFfHxiadM56YpIonKQalTg.jpg_1719609565) + +Step 3. Gently push down onto the GPIO Header as shown below: + +![](../assets/a6nANg-L_gqIkPH6ZKQo6mCSSSbacF7FkQ.jpg_1719609655) + +Step 4. Confirm the GPIO Header is seated properly as shown below. + +![](../assets/P3TZVCVhVSBYXFOWtPc4fZML_8-LQTEHQw.jpg_1719609689) + +Step 5. Slide the GPIO Header back plate for the MSR-2 over your sensor and gently push down until it clicks into place. + +![](../assets/hbfGA0fIQlpnykuuZOhiEuHlZDW7r3GfoQ.jpg_1719609715) + +If the back plate does not gently go onto the sensor please investigate and confirm it is in the right orientation. + +**Connecting DuPont pins to proper GPIO ports** +Now we need to reference the GPIO pinout we looked at above and then connect three wires. You will need three male-to-male DuPont wires included in your kit. I suggest using red for power aka 5v, White for ground aka GND, and green for data aka port IO7. Most LED strips will also have this same color scheme and it's easier to match like colors together. + +![](../assets/4OHLuxZVKc1TcCGLfvAEf-1UUl-IzmeHzQ.jpg_1719610515) + +![](../assets/4Er61OH8tF-IaiVvom0cWPeOyfNkRWtibw.jpg_1719610507) + +![](../assets/oBW2IxCJX5zKaZGj_o4JtXuoulEGI8DH5Q.jpg_1719610557) + +You can add a bit of hot glue to the Dupont wires to hold them together. DO NOT put hot glue into the GPIO Header's female pins that will ruin the addon. I am only suggesting that you can hot-glue the Dupont pins outer shell themselves together to stiffen them up. + +![5QMWMycqBmvOz_mlKdoTbZwkC-4__REi8A.jpg](../assets/5qmwmycqbmvoz-mlkdotbzwkc-4-rei8a.jpg) + +**Connecting DuPont pins to LED Strip** + +Next, we need to connect the other side of the Dupont pins to the LED strip. Most likely your LED strip will have a JST-SM connector which is a 3amp max connector with three wires connected: red for 5v, green for data, and white for gnd. We will be matching up our red, green, and white wires already attached to the GPIO add-on pins in the MSR-2 (using IO7 as the data pin for this tutorial) + +![](../assets/Me6P6lhhZUQMhuY--kIQqoFHV6QgrxpO0g.jpg_1719611251) ![](../assets/LwzqEXM9B89IWUQCIdZtwo_uYIbYVzdT0g.jpg_1719611264) + +Make sure to connect to the correct side of the LED strip. The led strip will have an arrow going down the led strip showing one direction for the data line. you want the data channel going FROM the msr-2 TO the led strip going in a "forward" direction as shown below. + +![](../assets/n0MT-JcoqRwPKYfZOaYyBD2RU4K3x_gmOA.jpg_1719611527) ![](../assets/BDLaEPEomVhYjATCJMSVMltiTS9aoVY9YQ.jpg_1719611545) + +**Edit the YAML of your MSR-2 to let it know about your new LED strip** + +Finally, we need to tell the MSR-2 that we connected an LED strip. We need to tell it how many LEDs we have and we need to tell it that it's our second LED since the built-in LED is the first. This tutorial assumes you are comfortable with the ESPHome dashboard. + +Step 1. Open ESPhome Dashboard and click edit to bring up the yaml your sensor is currently using. + +![](../assets/28MMBJEeIQOmwUGtP9L3cx0PtCaTL0HX_Q.png_1719612259) + +You will see some YAML code here and you do NOT want to touch anything above line 20. If you need to, click your cursor at the end of wifi\_password and hit enter to create a new line then make sure you backspace until you are "flush" with the line numbers like how wifi: is. + +Step 2. Copy the code below and paste it to line 20 in your ESPHome yaml for this device. + +```generic +light: + - platform: esp32_rmt_led_strip + id: bed_led + name: "Bed LED" + pin: GPIO7 + rmt_channel: 1 + default_transition_length: 0s + chipset: WS2812 + num_leds: 60 + rgb_order: grb + effects: + - pulse: + name: "Slow Pulse" + transition_length: 1000ms + update_interval: 1000ms + min_brightness: 50% + max_brightness: 100% + - pulse: + name: "Fast Pulse" + transition_length: 100ms + update_interval: 100ms + min_brightness: 50% + max_brightness: 100% + - addressable_rainbow: +``` + + +This is where you can change your number of LEDs as well as the GPIO pin used for the LED data! +Make sure to check out [https://esphome.io/components/light/index.html#light-effects](https://esphome.io/components/light/index.html#light-effects) for all the effects supported such as addressable scan effect!Step 3. Confirm you do not have any red lines showing errors in your code![](../assets/EQdHu-pdF_2D7T6GJkjdqSQYZptmHk-cmw.png_1719612604) +You change the rmt\_channel to 1 because 0 is being used by the built-in LED of the MSR-2. +Step 4. Hit save and then install in the top right. It should have a popup where you select "wirelessly" then it will begin compiling the firmware and finally installing the compiled firmware to your MSR-2.Step 5. Go into home assistant and confirm you now have a new light entity called Bed LED + +![](../assets/YfpAVN1FtpsODgbFgZg8qEVBNjl3NgaAvQ.png_1719613175) + +Step 6. Click on the name "Bed LED" circled and it will pop up a color picker. You can then choose the color wheel option to pick any color of the rainbow, or select "effect" and choose an effect. + +![](../assets/GublKQEhWUdU-OxJiA948P3_HGiwxTpn4w.png_1719613216) ![](../assets/ObY0NPGDBIBaXPuhUVzo80fr1fToBm5ekg.png_1719613432) ![](../assets/1OhdBudlNh2Rk8SoytNKdoUHqknn8KA8sQ.png_1719613457) + +![](../assets/JI4fSugUQvhRpK1FauJEEPoj3Vwe-QD02Q.jpg_1719613900) + +That's all folks! Thanks to Smart Home Sellout for putting this tutorial together! \ No newline at end of file diff --git a/docs/products/r-pro-1/examples/msr2-alarmo.md b/docs/products/r-pro-1/examples/msr2-alarmo.md new file mode 100644 index 000000000..33028f1be --- /dev/null +++ b/docs/products/r-pro-1/examples/msr2-alarmo.md @@ -0,0 +1,38 @@ +--- +title: How To use the MSR-2 with Alarmo +description: A tutorial for how To use the MSR-2 with Alarmo for an advanced DIY alarm system. +--- +# MSR-2 + Alarmo Home Security Install + +My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo add-on, quickly and easily allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. + +1\. Install [HACS](https://hacs.xyz/docs/setup/download/) +2\. Install [Alarmo](https://github.com/nielsfaber/alarmo?tab=readme-ov-file#installation) and the [Alarmo Card](https://github.com/nielsfaber/alarmo-card) (Pretty Arm and Disarm card for your HA dashboard) + +![Alarmo 7.png](../assets/alarmo-7.png) + +![Alarmo 1.png](../assets/alarmo-1.png) + +3\. Find Alarmo on the left, select the Sensors tab, and toggle on the sensor entities that you would like to use for your alarm system. + +![Alarmo 2.png](../assets/alarmo-2.png) + +4\. Now select the Actions tab and under Condition > Event > Select "Alarm is triggered". You can also select the device you would like to receive a notification on under Task > Target > Select Device (Phone, tablet, etc.) + +![Alarmo 3.png](../assets/alarmo-3.png) + +5\. You can change the Title, Message, and Name of the alarm notification. + +![Alarmo 4.png](../assets/alarmo-4.png) + +6\. After saving that action we can add another one that will turn on our sensor lights and/or make the onboard piezo buzzers play an alarm sound. Uner Entity select your sensors RGB light. + +![Alarmo 5.png](../assets/alarmo-5.png) + +7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered. + +![Alarmo 6.png](../assets/alarmo-6.png) + +8\. And that's it, seriously... Now you can enjoy a free and local security system. + +We hope this was helpful and please let us know if there are any questions! \ No newline at end of file diff --git a/docs/products/r-pro-1/examples/msr2-dashboards.md b/docs/products/r-pro-1/examples/msr2-dashboards.md new file mode 100644 index 000000000..b9b9e7be4 --- /dev/null +++ b/docs/products/r-pro-1/examples/msr2-dashboards.md @@ -0,0 +1,89 @@ +--- +title: MSR-2 Dashboard Examples +description: MSR-2 Dashboard Examples. +--- +# MSR-2 Home Assistant Dashboard Examples + +**Radar Scatter Plot With Apex Charts For **[**MSR-2**](https://shop.apolloautomation.cloud/products/multisensor-mk1) + + +![JPE Apex Charts 3.png](../assets/jpe-apex-charts-3.png) + +```plaintext +type: custom:apexcharts-card +header: + show: true + title: MSR-1 Radar Distance + show_states: true + colorize_states: true +apex_config: + legend: + position: top + horizontalAlign: center + offsetX: -80 + offsetY: 0 +experimental: + brush: true +brush: + selection_span: 4h +graph_span: 24hr +chart_type: scatter +series: + - entity: sensor.apollo_msr_1_a79e14_radar_detection_distance + name: Detection + stroke_width: 1 + color: green + show: + in_brush: true + extremas: true + - entity: sensor.apollo_msr_1_a79e14_radar_moving_distance + name: Moving + stroke_width: 1 + - entity: sensor.apollo_msr_1_a79e14_radar_still_distance + name: Still + stroke_width: 1 +``` + +**CO2 Charts** +Home Assistant Sensor + +![CO 2 Graph.png](../assets/co-2-graph.png) + +```plaintext +graph: line +type: sensor +entity: sensor.apollo_msr_1_a79e38_co2 +detail: 2 +name: Bedroom CO2 +hours_to_show: 24 +``` + +Custom: Plotly Graph Card + +![Plotly CO2 Graph.png](../assets/plotly-co2-graph.png) + +```plaintext +type: custom:plotly-graph +entities: + - entity: sensor.apollo_msr_1_a79e38_co2 +hours_to_show: 24 +refresh_interval: 10 +title: Bedroom CO2 +``` + +Home Assistant Guage + +![CO2 Guage.png](../assets/co2-guage.png) + +```plaintext +type: gauge +entity: sensor.apollo_msr_1_a79e38_co2 +needle: true +unit: ppm +min: 0 +max: 3000 +severity: + green: 0 + yellow: 1000 + red: 2000 +``` \ No newline at end of file diff --git a/docs/products/r-pro-1/faq.md b/docs/products/r-pro-1/faq.md new file mode 100644 index 000000000..766366ad1 --- /dev/null +++ b/docs/products/r-pro-1/faq.md @@ -0,0 +1,103 @@ +--- +title: MSR-2 FAQ +description: Frequently asked questions about the MSR-2 mmWave sensor. +--- +1\. **What sensors are included in the MSR-2?** + +* The MSR-2 includes several built-in sensors such as an mmWave radar for motion detection, a LUX and UV sensor, a temperature and pressure sensor, and an optional CO2 sensor. + +2\. **How does the mmWave radar sensor work?** + +* The mmWave radar sensor can detect movement, even subtle motions like someone sitting still in a room. It works by emitting radar waves that reflect off objects and detects motion based on the change in the signal. The sensor is highly effective in detecting people in a room, even through light walls. + +3\. **What is the maximum detection range of the mmWave radar?** + +* The HLK-LD2410B mmWave radar sensor has a maximum detection range of about 6 meters (19.6 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring. + +4\. **Can the MSR-2 detect multiple people?** + +* No, the MSR-2 supports single-target tracking only but it has better still detection than the MTR-1 which makes it uniquely suited for situations where you need to track a very still target like on a bed, couch, etc. + +5\. **What is the benefit of the LUX and UV sensor?** + +* The LUX sensor measures the amount of light in a room, while the UV sensor tracks the ultraviolet index from the sun. These readings can be used to automate lighting systems, such as turning on or off lights depending on the ambient brightness, or to measure sunlight exposure in a room. + +6\. **How does the optional CO2 sensor work?** + +* The optional SCD-40 CO2 sensor provides accurate carbon dioxide measurements and is useful for tracking air quality in enclosed spaces. This sensor can be used to automate HVAC systems, sending alerts when CO2 levels are too high and suggesting when to ventilate the area. + +7\. **How do I connect the MSR-2 to Home Assistant?** + +* The MSR-2 connects to your Home Assistant instance through ESPHome using WiFi. Once connected, you can monitor data from all the sensors and set up automations. + +8\. **What kind of automations can I create with the MSR-2?** + +* You can create a variety of automations, such as turning on lights when motion is detected, adjusting ventilation when CO2 levels rise, or triggering alarms based on motion or environmental changes. + +9\. **What are the RGB LED and piezo buzzer used for?** + +* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure. + +10\. **How do I adjust the sensitivity of the presence detection?** + +* Sensitivity adjustments can be made through the Home Assistant Device Page or HLK Radar Tool app allowing you to fine-tune the radar to avoid false positives or to increase its sensitivity for more precise detections. + +11\. **Does the mmWave sensor detect through walls?** + +* Yes, the mmWave sensor can detect movement through certain materials like thin walls, which is helpful in larger spaces but may require sensitivity adjustments if false positives occur due to adjacent rooms. + +12\. **Can the MSR-2 be used outdoors?** + +* No, the MSR-2 is primarily designed for indoor use and high humidity or temperatures too high or low could damage the device. + +13\. **What’s new in the MSR-2 compared to the MSR-1?** + +* The MSR-2 introduces several improvements, including a smaller form factor, an additional expansion slot for future accessories, an updated DPS310 pressure sensor for more accurate readings, and improved temperature and pressure tracking. + +14\. **Can the MSR-2 track the exact location of people in a room?** + +* Yes, the MSR-2 uses multi-zone mmWave radar technology to track the approximate location of people within a room. It can determine whether someone is sitting, walking, or standing in different areas of the space. + +15\. **How does the temperature and pressure sensor work?** + +* The DPS310 sensor provides precise readings of air temperature and pressure, which are especially useful when combined with the optional CO2 sensor to improve air quality monitoring. Keep in mind the heat generated by the ESP32 may require a temperature offset adjustment in the configuration. + +16\. **What kind of power supply is required for the MSR-2?** + +* The MSR-2 is powered via USB-C and can be plugged into a standard wall outlet using a 5V adapter. + +17\. **Can I customize the MSR-2 functionality?** + +* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the MSR-2. Our YAML is on Github and our .STEP and .STL CAD files are available for community use. + +18\. **How often does the MSR-2 report sensor data?** + +* The reporting frequency can be customized through the ESPHome YAML configuration. You can set it to report data as frequently as every second or reduce the frequency to save energy or bandwidth. + +19\. **Is the MSR-2 compatible with other smart home platforms?** + +* The MSR-2 is specifically designed for Home Assistant via ESPHome. While it could be compatible with other platforms through custom integrations, its primary functionality is optimized for Home Assistant. + +20\. **Can I use multiple MSR-2 sensors in my Home Assistant setup?** + +* Yes, you can have multiple MSR-2 sensors connected to the same Home Assistant instance. Each device will show up as a separate entity, allowing you to monitor and automate different rooms or areas in your home. + +21\. **What accessories are available for the MSR-2?** + +* The MSR-2 has an additional expansion slot for future accessories. Currently, accessories such as a USB-C wall plug mount and a ball mount for flexible positioning are available. We are also working on new expansion boards for future updates. + +22\. **Is the MSR-2 secure?** + +* The MSR-2 communicates over your local network using ESPHome, which provides a secure, local connection without the need for cloud services. No data is sent to external servers, ensuring privacy. + +23\. **How do I install and configure the MSR-2?** + +* Installation is straightforward, with the MSR-2 powered via USB-C and connecting to Home Assistant through WiFi. Configuration is done in ESPHome, where you can set sensor parameters, adjust automations, and more. We provide detailed documentation and support through our Discord community and GitHub. + +24\. **What makes the MSR-2 stand out from other motion sensors?** + +* The MSR-2 stands out due to its mmWave radar’s ability to detect still motion (like someone sitting still) and its capability to track multiple targets and zones. Additionally, its compact size, multi-sensor integration (motion, LUX, UV, CO2, temperature, pressure), and the open-source nature of the product make it highly versatile and customizable. + +25\. **What is the warranty for the MSR-2?** + +* The MSR-2 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement. \ No newline at end of file diff --git a/docs/products/r-pro-1/introduction.md b/docs/products/r-pro-1/introduction.md new file mode 100644 index 000000000..33231b8c4 --- /dev/null +++ b/docs/products/r-pro-1/introduction.md @@ -0,0 +1,21 @@ +--- +title: Introduction +description: Documentation for MSR-2, including setup, usage, and best practices. +--- +# Introduction + +
+ +
+ + +The Apollo MSR-2 is a compact, versatile mmWave multisensor for Home Assistant, designed for precise motion detection and smart home automation. It builds on the MSR-1 with a smaller form factor, an additional expansion slot, and improved sensors for temperature and pressure. The sensor includes LUX and UV detection, an optional CO2 sensor, RGB LED, and piezo buzzer for customizable notifications. Fully open-source and expandable, the MSR-2 offers seamless integration with Home Assistant, making it ideal for automating lighting, air quality monitoring, and more. Access to support and customization resources is available via our Discord and GitHub. \ No newline at end of file diff --git a/docs/products/r-pro-1/msr2-reviews.md b/docs/products/r-pro-1/msr2-reviews.md new file mode 100644 index 000000000..cd8ed23ac --- /dev/null +++ b/docs/products/r-pro-1/msr2-reviews.md @@ -0,0 +1,15 @@ +--- +title: MSR-2 Reviews +description: Youtuber reviews and feedback about the MSR-2 sensor from Apollo Automation. +--- +# [Simon Says Home Assistant MSR-2 Review](https://www.youtube.com/watch?v=U4qUhFSAxbk) + +# [Smart Home Scene MSR-2 Review](https://smarthomescene.com/reviews/apollo-msr-2-review-the-smallest-presence-sensor-ever-made/) + +# [Home Tech Innovations MSR-2 Review](https://www.youtube.com/watch?v=K3j2rR2dsY0) + +# [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ) + +# [Smart Home Australia MSR-2 Review](https://www.youtube.com/watch?v=EzVyzFwdgN4) + +# [Michael Leen MSR-2 Review](https://www.youtube.com/watch?v=VdVR8Gs002Q) \ No newline at end of file diff --git a/docs/products/r-pro-1/setup/r-pro-1-general-tips.md b/docs/products/r-pro-1/setup/r-pro-1-general-tips.md new file mode 100644 index 000000000..3d3f9057e --- /dev/null +++ b/docs/products/r-pro-1/setup/r-pro-1-general-tips.md @@ -0,0 +1,39 @@ +--- +title: R-Pro-1 General Tips +description: Multiple helpful images for mounting, lux/rgb, and gate and zone visualization. +--- +# General Tips + +##### **Light Sensor (LTR-390UV)** + +![20240514_123742.jpg](../assets/20240514-123742.jpg) + +When mounting the MSR-2 be sure to position the device so that the two large holes are not covered. This allows more light to enter and will ensure better accuracy. + +!!! warning "The RGB LED will trigger the Light sensor!" + + Make sure that your automations do not interfere with each other. This includes being aware that your onboard LED can trigger the lux reading but not the uv reading of the LTR390 in your device. + +##### **Mounting** + +The MSR-2 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120degree FOV of the mmWave radar. + +![ld2410_mounting_hor-1.jpeg](../assets/ld2410-mounting-hor-1.jpeg) + +The MSR-2 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling. + +![LD2410 Gates.png](../assets/ld2410-gates.png) + +!!! tip "These are some useful hints!" + + * The FOV angle is -60 to 60 degrees - 120 degrees total. + * Gates are pre-defined by the radar module and are in 0.75 meter increments. + * Zones are user-configurable and are in cm. + +##### **Gate and FOV Visualization** + +**![ld2410 table.png](../assets/ld2410-table.png)![Gate, Zones and RR.png](../assets/gate-zones-and-rr.png)** + +![MSR-1 radar map.png](../assets/msr-1-radar-map.png)![Radar gates Colored.png](../assets/radar-gates-colored.png) + +##### \ No newline at end of file diff --git a/docs/products/r-pro-1/setup/r-pro-1-sensor-definitions.md b/docs/products/r-pro-1/setup/r-pro-1-sensor-definitions.md new file mode 100644 index 000000000..6cc463329 --- /dev/null +++ b/docs/products/r-pro-1/setup/r-pro-1-sensor-definitions.md @@ -0,0 +1,337 @@ +--- +title: R-Pro-1 Sensor Definitions +description: These are all of the entities exposed by the R-Pro-1 to automate on! +--- +# Sensor Definitions + +!!! 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! + +Once added to Home Assistant you can configure different settings for your sensor. Below is what each setting does. + +???+ info "Controls" + + **RGB Light** + + * One RGB Neopixel LED. Click on the light bulb or color wheel to change the color. Click on the toggle to turn on or off. + + **Calibrate SCD40 to 420ppm** + + * A control option to calibrate the SCD40 CO₂ sensor to outdoor baseline levels. + +???+ info "Sensors" + + **CO2** + + * True CO2 reading from the SCD40. This will be Unknown if you do not have the CO2 module. SDC40 can be calibrated following this guide. + + **ESP Temperature** + + * This is the temperature of the internal microcontroller. Think of it like your measured CPU temp on your PC. + + **DPS310 Pressure** + + * Measures the air pressure in the environment. + + **DPS310 Temperature** + + * Measures the ambient air temperature using the DPS310 sensor. + + **LTR390 Light** + + * Light level measured in lux by LTR390. + + **LTR390 UV Index** + + * UV index measured by LTR390. + + **Radar Detection Distance** + + * The last detected distance by the radar. This will stay at the last known value so sometimes can be misleading. + + **Radar Move Energy** + + * The amount of movement measured by the LD2410B. Faster movements have higher percentage. + + **Radar Moving Target** + + * Does the radar have a moving target it is tracking. + + **Radar Still Distance** + + * The last measured distance of a still target. It will hold the last value so sometimes can be misleading. + + **Radar Still Energy** + + * The energy of the current still target. + + **Radar Still Target** + + * Does the radar have a still target. + + **Radar Target** + + * Does the radar have a still or moving target. Good for triggering automation. + + **Radar Zone 1 Occupancy** + + * This is a configurable zone. Think of zones like distances from the radar unit. Zone 1 might be from 0 cm to 100 cm from the sensor. This is telling you if there is someone in that zone. The zones can be defined in the configuration section with “Radar End Zone 1” + + **Radar Zone 2 Occupancy** + + * This is a configurable zone. Think of zones like distances from the radar unit. Zone 2 might be from 100 cm to 200 cm from the sensor. This is telling you if there is someone in that zone. The zones can be defined in the configuration section with “Radar End Zone 2” + + **Radar Zone 3 Occupancy** + + * This is a configurable zone. Think of zones like distances from the radar unit. Zone 3 might be from 200 cm to 300 cm from the sensor. This is telling you if there is someone in that zone. The zones can be defined in the configuration section with “Radar End Zone 3” + +???+ info "Configuration" + + **ESP Reboot** + + * Performs a restart of the sensor + + **Factory Reset Radar** + + * Sets the radar's move thresholds back to their original values from the manufacturer + + **g0-g8 Move & Still Threshold** + + * Please refer to the radar tuning guide: [Here](https://wiki.apolloautomation.com/products/msr2/calibrating-and-updating/zones-ha/) + + **ld2410 Bluetooth** + + * This allows you to turn on the LD2410's Bluetooth. This allows you to connect to the HLK Radar phone app [used for tuning](https://wiki.apolloautomation.com/products/msr2/calibrating-and-updating/zones-hlk/). + + **Radar Zone 1 Start** + + * This sets the starting distance for Zone 1 in cm. This is the distance from the sensor to the start of Zone 1 + + **DPS Temperature Offset** + + * Offsets the heat from the ESP chip for a more accurate temperature. + + **ESP Reboot** + + * A control to reboot the ESP32 system. + + **Factory Reset Radar** + + * Resets the radar to its factory settings. + + **Firmware Update** + + * Shows whether a firmware update is available. + + ??? info "Radar End Zones" + + **Radar End Zone 1** + + * This defines “Zone 1” of the radar. It is a distance from the sensor that specifies what “Zone 1” is. It connects to the “Radar Zone 1 Occupancy” sensor. So if this number is set to “100” that means from 0 to 100 centimeters from the sensor is zone 1. + + **Radar End Zone 2** + + * This defines “Zone 2” of the radar. It is a distance from the sensor that specifies what “Zone 2” is. It connects to the “Radar Zone 2 Occupancy” sensor. So if this number is set to “200” that means from zone 2 end distance to 200 centimeters from the sensor is zone 2. + + **Radar End Zone 3** + + * It is a distance from the sensor that specifies what “Zone 3” is. It connects to the “Radar Zone 3 Occupancy” sensor. So if this number is set to “300” that means from zone 2 end distance to 300 centimeters from the sensor is zone 3. + + **Radar Engineering Mode** + + * Used to enable g0-g8 threshold sliders for mmWave tuning. + + **Radar Timeout** + + * Configures the timeout for the radar in seconds. + + **Reduce DB Reporting** + + * A toggle to enable or disable reduced reporting from various entities on the msr-2. This will make multiple entities use filters and not update their state unless a threshold is met - ultimately using less Wi-Fi airtime and less database usage in home assistant. + + **Startup Light Blink** + + * A toggle to enable or disable the blinking of the RGB LED during MSR-2 initial boot. + + ???+ info "Radar Gate Distance Tuning and Timeout" + + ???+ example "Radar Max Move Distance" + + * Maximum distance gate for movement detection. Value between 2 and 8 inclusive + * Useful in a bathroom or other scenario where you want to avoid detection after a certain gate number (distance). + * Useful for triggering on "radar target" instead of triggering on zone 1/2/3 occupancy instead. + + ???+ example "Radar Max Still Distance " + + * Maximum distance gate for still detection. Value between 2 and 8 inclusive. Defaults to 8. + * Useful in a bathroom or other scenario where you want to avoid detection after a certain gate number (distance). + * Useful for triggering on "radar target" instead of triggering on zone 1/2/3 occupancy instead. + + ???+ info "Radar Timeout" + + The time in seconds that the radar's presence will stay high after the target is lost. + +??? success "Radar Sensors" + + **Radar Detection Distance** + + * Shows the distance to the detected target, measured in cm. + + **Radar Move Energy** + + * Displays the energy of movement detected by the radar, represented as a percentage. + + **Radar Moving Distance** + + * Displays the distance of a moving target, measured in cm. + + **Radar Moving Target** + + * Detects whether a moving target is present. + + **Radar Still Distance** + + * Displays the distance of a still target, measured in cm. + + **Radar Still Energy** + + * Displays the energy detected from still objects. + + **Radar Still Target** + + * Detects whether a still target is present. + + **Radar Target** + + * Overall detection of a target by the radar. + + **Radar Zone 1 Occupancy** + + * Indicates whether Zone 1 is occupied or clear. + + **Radar Zone 2 Occupancy** + + * Indicates whether Zone 2 is occupied or clear. + + **Radar Zone 3 Occupancy** + + * Indicates whether Zone 3 is occupied or clear. + +??? info "Radar Gate Configuration" + + !!! warning "Keeping these enabled permanently is bad" + + Please toggle ld2410 Bluetooth on, configure your sensor, then turn ld2410 Bluetooth back off. Otherwise, your Wi-Fi and database could become overwhelmed with excessive traffic. + + **g0 Move Threshold** + + * Configures the movement sensitivity threshold for gate 0. + + **g0 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 0. + + **g1 Move Threshold** + + * Configures the movement sensitivity threshold for gate 1. + + **g1 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 1. + + **g2 Move Threshold** + + * Configures the movement sensitivity threshold for gate 2. + + **g2 Still Threshold** + + * Configures the stillness sensitivity threshold for for gate 2. + + **g3 Move Threshold** + + * Configures the movement sensitivity threshold for gate 3. + + **g3 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 3. + + **g4 Move Threshold** + + * Configures the movement sensitivity threshold for gate 4. + + **g4 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 4. + + **g5 Move Threshold** + + * Configures the movement sensitivity threshold for gate 5. + + **g5 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 5. + + **g6 Move Threshold** + + * Configures the movement sensitivity threshold for gate 6. + + **g6 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 6. + + **g7 Move Threshold** + + * Configures the movement sensitivity threshold for gate 7. + + **g7 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 7. + + **g8 Move Threshold** + + * Configures the movement sensitivity threshold for gate 8. + + **g8 Still Threshold** + + * Configures the stillness sensitivity threshold for gate 8. + +??? info "Diagnostic" + + **ESP Temperature** + + * Displays the current temperature of the ESP32 chip. + + **g0 move energy to g8 move energy** + + * Displays the move energy levels for gates g0 through g8 + + **g0 move energy to g8 still energy** + + * Displays the still energy levels for gates g0 through g8 + + **Online** + + * Shows the connection status. + + **Query Params** + + * Button to query parameters for debugging or advanced configurations. + + **Radar Firmware Version** + + * Displays the current firmware version for the radar. + + **Restart Radar** + + * Button to restart the radar sensor. + + **RSSI** + + * Displays the Wi-Fi signal strength. + + **Uptime** + + * Shows the time since last reboot. + +[Join our Discord if you need more help! :simple-discord:](https://dsc.gg/apolloautomation){ .md-button } \ No newline at end of file diff --git a/docs/products/r-pro-1/troubleshooting/assets/msr-2-boot-button.jpg b/docs/products/r-pro-1/troubleshooting/assets/msr-2-boot-button.jpg new file mode 100644 index 000000000..da0af5f8f Binary files /dev/null and b/docs/products/r-pro-1/troubleshooting/assets/msr-2-boot-button.jpg differ diff --git a/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-1.png b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-1.png new file mode 100644 index 000000000..f31036e96 Binary files /dev/null and b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-1.png differ diff --git a/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-2.png b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-2.png new file mode 100644 index 000000000..04e62643b Binary files /dev/null and b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-2.png differ diff --git a/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-3.png b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-3.png new file mode 100644 index 000000000..318eeea03 Binary files /dev/null and b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-3.png differ diff --git a/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-4.png b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-4.png new file mode 100644 index 000000000..08cf6d44f Binary files /dev/null and b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reflash-pic-4.png differ diff --git a/docs/products/r-pro-1/troubleshooting/assets/msr-2-reset-button.jpg b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reset-button.jpg new file mode 100644 index 000000000..7b4573d22 Binary files /dev/null and b/docs/products/r-pro-1/troubleshooting/assets/msr-2-reset-button.jpg differ diff --git a/docs/products/r-pro-1/troubleshooting/msr2-boot-mode.md b/docs/products/r-pro-1/troubleshooting/msr2-boot-mode.md new file mode 100644 index 000000000..bbcea6a02 --- /dev/null +++ b/docs/products/r-pro-1/troubleshooting/msr2-boot-mode.md @@ -0,0 +1,31 @@ +--- +title: Putting The MSR-2 In Boot Mode +description: Step by step guide for putting The MSR-2 In Boot Mode. +--- +# Putting The MSR-2 In Boot Mode + +!!! info "This will cover how to put the MSR-2 into boot mode." + + This is needed to force the device into boot mode to reflash the firmware. + +##### Method 1: Boot Button Only + +1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button). + +![](assets/msr-2-boot-button.jpg) + +2\. Push and hold the boot button. While still holding the button down, plug in a USB-C cable into the USB-C port of your MSR-2 then let go of the button. + +3\. Continue with uploading the firmware document. + +##### Method 2: Boot and Reset Buttons + +1\. Unplug the device and locate the boot and reset buttons as shown in the image above. + +2\. Plug it into your computer. + +3\. Hold down the boot button (the right button), then press and release the reset button (the left button) while keeping the boot button pressed. Finally, release the boot button. + +![](assets/msr-2-reset-button.jpg) + +4\. Continue with uploading the firmware document. \ No newline at end of file diff --git a/docs/products/r-pro-1/troubleshooting/msr2-code.md b/docs/products/r-pro-1/troubleshooting/msr2-code.md new file mode 100644 index 000000000..f5d1b36b3 --- /dev/null +++ b/docs/products/r-pro-1/troubleshooting/msr2-code.md @@ -0,0 +1,45 @@ +--- +title: Factory Re-Flash MSR-2 +description: Step by step guide for re-flashing the MSR-2 back to factory firmware. +--- +# Factory Re-Flash MSR-2 + +!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." + + This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser. + +If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. + +1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button). + +![](assets/msr-2-boot-button.jpg) + +2\. Push and hold the boot button. While still holding the button down, plug in a USB-C cable into the USB-C port of your MSR-2 then let go of the button. + +3\. Navigate to our installer page and click connect under Apollo MSR-2 Installer. + +3\. Click the big "Connect" button. + +![](assets/msr-2-reflash-pic-1.png) + +3\. Select the open com port then click Connect. + +![](assets/msr-2-reflash-pic-2.png) + +4\. Click "Install MSR-2". + +![](assets/msr-2-reflash-pic-3.png) + +5\. Click "INSTALL". + +![](assets/msr-2-reflash-pic-4.png) + +6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. + +![](../../air1/troubleshooting/assets/air-1-reflash-pic-5.png) + +!!! warning "Power cycle your device before doing anything else!" + + Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! + +7\. Please proceed to the getting started guide and setup your sensor as a new device! \ No newline at end of file diff --git a/docs/products/r-pro-1/troubleshooting/msr2-reset-wi-fi-credentials.md b/docs/products/r-pro-1/troubleshooting/msr2-reset-wi-fi-credentials.md new file mode 100644 index 000000000..a44241bbf --- /dev/null +++ b/docs/products/r-pro-1/troubleshooting/msr2-reset-wi-fi-credentials.md @@ -0,0 +1,15 @@ +--- +title: Reset Wi-Fi Credentials +description: Step by step guide for resetting the Wi-Fi Credentials on your MSR-2. +--- +# Reset Wi-Fi Credentials on your MSR-2 + +1\. Plug the device into power. + +2\. Long press the Boot button (the button on the right) for 10 seconds + +![](../../../assets/msr2-boot-button-pic-1.jpg)![](../../../assets/msr2-boot-button-pic-2.jpg)![](../../../assets/msr2-boot-button-pic-3.jpg) + +3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. + +4\. Connect to the hotspot titled "Apollo MSR2 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file diff --git a/docs/products/r-pro-1/troubleshooting/msr2-teardown.md b/docs/products/r-pro-1/troubleshooting/msr2-teardown.md new file mode 100644 index 000000000..8c3339679 --- /dev/null +++ b/docs/products/r-pro-1/troubleshooting/msr2-teardown.md @@ -0,0 +1,7 @@ +--- +title: MSR-2 Teardown +description: Step by step guide for tearing down your MSR-2 to replace parts, clean it, swap cases, etc. +--- +# Teardown and Reassembly Of MSR-2 + +
\ No newline at end of file