Open ESPHome Device Builder
+ Open ESPHome Device Builder
2\. Don't have it installed yet? Add it from the App Store with the badge below, then move on to step 3.
@@ -8,6 +8,6 @@
3\. Find your device and click **Edit**.
-
+
4\. Replace the `packages:` line and the line directly below it with the code below.
diff --git a/docs/_snippets/bluetooth-proxy/method2.md b/docs/_snippets/bluetooth-proxy/method2.md
index 7a1dd91b8a..12e133e48e 100644
--- a/docs/_snippets/bluetooth-proxy/method2.md
+++ b/docs/_snippets/bluetooth-proxy/method2.md
@@ -2,7 +2,7 @@ The easiest way is to let ESPHome Device Builder add the component for you. You
1\. Open ESPHome Device Builder and click **Edit** on your device. The button below opens the app right in your Home Assistant.
- Open ESPHome Device Builder
+ Open ESPHome Device Builder
Don't have it installed yet? Add it from the App Store with the badge below first.
@@ -10,7 +10,7 @@ Don't have it installed yet? Add it from the App Store with the badge below firs
2\. Click **Add Component** in the editor toolbar, search for **Bluetooth Proxy**, and click **Add**.
-
+
Device Builder drops a single line into your config:
@@ -22,6 +22,6 @@ That's all it needs. Active connections are on by default, and `bluetooth_proxy`
3\. Click **Save**, then **Install**, and choose **On the Network** to flash the new firmware over Wi-Fi.
-
+
--8<-- "_snippets/bluetooth-proxy/verify.md"
diff --git a/docs/homey.md b/docs/homey.md
index 8e60f82c89..b891397706 100755
--- a/docs/homey.md
+++ b/docs/homey.md
@@ -2,7 +2,7 @@
title: Homey Integration
description: Guide to integrating Apollo Automation devices with the Homey smart home platform.
---
-TEMP-1B reset button - + PLT-1B reset button - + 2\. Press the boot button and let go
TEMP-1B boot button - + PLT-1B boot button - + The RGB Light on your device should flash green if connected to Wi-Fi, blue if connected to Wi-Fi and Home Assistant, or yellow if no Wi-Fi or Home Assistant connection. diff --git a/docs/homey/products/general/calibrating-and-updating/co2-calibration.md b/docs/homey/products/general/calibrating-and-updating/co2-calibration.md index 7ddf0f0836..47c8031525 100755 --- a/docs/homey/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/homey/products/general/calibrating-and-updating/co2-calibration.md @@ -21,17 +21,17 @@ description: "Step by step guide for re-calibrating your SCD40 CO2 sensor" 3\. Navigate to your device, such as via the "Favorite Devices" section and right click (or on mobile short hold) then click on Settings. - + 4\. Scroll down until you see "Maintenance" and select it on mobile, then click on "Calibrate SCD40 to 420ppm" and you should see the CO2 readings at 420 ppm or near it. - + It might take several attempts clicking the "Press" button for it to equalize correctly. If you don't see the SCD40 reporting 400-500 ppm then click the button again. 5\. Now your CO2 sensor should be calibrated! Be sure to setup some nice flows and check out the insights so you can monitor the CO2 levels. - + !!! danger "Dangerous CO2 level considerations" @@ -39,14 +39,14 @@ It might take several attempts clicking the "Press" button for it to equalize co Note the steep decline in CO2 ppm detected due to the door and window being opened and fan turned on. - + Wisconsin Department of Health CO2 Level Chart - + !!! example "CO2 levels dropping due to HVAC Fan on a schedule" This could be improved by increasing air exchange to get below 1000 ppm for a safer environment. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md b/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md index 257e9d8689..ccf5eb958e 100755 --- a/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md +++ b/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md @@ -27,23 +27,23 @@ How to tune the mmWave sensor using radar engineering mode. 3\. Turn on Radar Engineering Mode (REM). - + 4\. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8. - + 5\. The gates are different distances from the sensor. - + 6\. 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. - + 7\. 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. - + !!! quote "Quote from popular Youtuber Make It Work Tech" diff --git a/docs/homey/products/general/introduction.md b/docs/homey/products/general/introduction.md index dd0563ead3..e1b61c76b7 100755 --- a/docs/homey/products/general/introduction.md +++ b/docs/homey/products/general/introduction.md @@ -4,7 +4,7 @@ description: >- Learn what Apollo Automation is all about, including our mission, our products, and how we empower smarter homes. --- - + Apollo Automation is a small startup based in Lexington, Kentucky, dedicated to creating innovative, high-quality, and affordable smart home automation hardware. Founded in 2023 by a group of friends, the company was born out of frustration with existing solutions that lacked transparency and customization options. Named after Trevor’s dog, Apollo, the team set out to build products that offer complete local control without reliance on cloud services or subscriptions! diff --git a/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md b/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md index 760b2efca7..a4883721a1 100755 --- a/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md +++ b/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md @@ -6,13 +6,13 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 1\. Open the Esphome Device Builder. - + 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install Esphome Device Builder.") and then move on to step 3. 3\. Click "Edit" as shown below. - + 4\. Copy the code inside the codeblock below. @@ -22,18 +22,18 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 5\. Paste the code as shown below directly below the yaml you just edited above. Make sure the spaces look the same and there are no red lines under any of the code. - + 6 Click save then Install in the top right. - + 7\. Click "Wirelessly" and let it finish compiling then installing. - + 8\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. - + 9\. You are finished and your Apollo device is now able to connect to your Wi-Fi with a hidden SSID! Make sure you understand the downsides as [mentioned here](https://esphome.io/components/wifi.html "downsides of fast_connect: true").
**fast\_connect** (*Optional*, boolean): If enabled, directly connects to WiFi network without doing a full scan first. This is required for hidden networks and can significantly improve connection times. Defaults to `off`. The downside is that this option connects to the first network the ESP sees, even if that network is very far away and better ones are available. \ No newline at end of file diff --git a/docs/homey/products/general/setup/getting-started.md b/docs/homey/products/general/setup/getting-started.md index ca0ab724e5..09a1e77c33 100755 --- a/docs/homey/products/general/setup/getting-started.md +++ b/docs/homey/products/general/setup/getting-started.md @@ -13,7 +13,7 @@ To get your new Apollo sensor connected to your Wi-Fi, follow the steps below! 2\. On your phone or PC, open the WiFi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the WiFi network to show up. - + 3\. Once connected it should automatically open a dashboard for your sensor @@ -21,7 +21,7 @@ If this does not automatically open the dashboard, please open your web browser 4\. Select the WiFi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**". - + !!! tip "Tip for Mesh Wi-Fi systems or multiple Access Points" @@ -33,9 +33,9 @@ If this does not automatically open the dashboard, please open your web browser 1\. Navigate to this website and click "Install App". For now this needs to be done from a desktop PC or a browser. - + - + 2\. Select the Homey device you want to install it on and then click "Install App" again! @@ -45,25 +45,25 @@ If this does not automatically open the dashboard, please open your web browser 1\. Open the Homey App on your phone and navigate to the Devices tab at the bottom then select the (+) icon in the top right and choose "**New Device**". Choose "Allow" if it pops up asking to find Bluetooth devices, or you can change this later in settings. - + 2\. Select Apollo Automation under Brands in the bottom left then choose "Every Apollo Sensor". When prompted, click "Connect". - + 3\. Your Apollo devices will automatically show up and if not, please first connect it to your Wi-Fi following the steps outlined here. 4\. Select the device you want to add, in this case an Apollo MTR-1 and click Continue at the bottom. - + 5\. Click Continue Setup and choose a Zone to place your device in. If you are new to Homey you can choose Home and move it to another Zone later after you create more zones! - + 6\. Change any other default settings like the Name, icon, etc or just click Finish in the bottom right. - + 7\. You are done! Your sensor is now ready to create flows and add as a favorite to your dashboard! diff --git a/docs/homey/products/general/setup/renaming-apollo-devices.md b/docs/homey/products/general/setup/renaming-apollo-devices.md index 037c4f8c4f..7b999505c3 100755 --- a/docs/homey/products/general/setup/renaming-apollo-devices.md +++ b/docs/homey/products/general/setup/renaming-apollo-devices.md @@ -5,8 +5,8 @@ description: "Rename an Apollo device from the Homey app or the Homey dashboard. 1\. Open the Homey App or dashboard in a browser and right click a device or short hold and then select "Rename". - + 2\. Type in the new name and then hit enter. That's it, you're done! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/general/supported-platforms.md b/docs/homey/products/general/supported-platforms.md index d3b356f740..7776cca95b 100755 --- a/docs/homey/products/general/supported-platforms.md +++ b/docs/homey/products/general/supported-platforms.md @@ -2,7 +2,7 @@ title: Supported Platforms description: A list of platforms compatible with Apollo Automation products. --- - + At Apollo, we are actively working on adding support for every smart home ecosystem out there. Although we are a works with Home Assistant partner and a Made for ESPHome partner, we want everyone to be able to use our sensors! Please take a look at the list of smart home ecosystems below to see the type of support we offer and the type of integration/functionality our sensors have. If you see any outdated info or have any questions/comments/concerns, please reach out to us at support@apolloautomation.com or come say hi in our [discord server](https://link.apolloautomation.com/discord)! diff --git a/docs/homey/products/general/troubleshooting/removing-device-from-homey.md b/docs/homey/products/general/troubleshooting/removing-device-from-homey.md index dde8f77273..f66388dac5 100755 --- a/docs/homey/products/general/troubleshooting/removing-device-from-homey.md +++ b/docs/homey/products/general/troubleshooting/removing-device-from-homey.md @@ -7,6 +7,6 @@ description: "Remove an Apollo device from Homey through the app or the dashboar 2\. Navigate to your device, such as via the "Favorite Devices" section and right click (or on mobile short hold) then click "Delete". - + - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/general/tutorials/high-co2-notification-example.md b/docs/homey/products/general/tutorials/high-co2-notification-example.md index 12f01f8a19..4ae4f55223 100755 --- a/docs/homey/products/general/tutorials/high-co2-notification-example.md +++ b/docs/homey/products/general/tutorials/high-co2-notification-example.md @@ -13,69 +13,69 @@ description: Example flow for sending alerts when CO₂ levels exceed a defined 2\. Click "New Flow" then "Advanced Flow". - + 3\. Click "Add" and select "When". - + 4\. In the search bar at the top, type in "co2 becomes" and select the card for the sensor you want to track. We are choosing "CO2 becomes greater than" for the Apollo AIR-1 device. - + 5\. Place your card on your flow area with a left click. You should have this node on your flow canvas. - + 6\. Select "ppm" and type in your value, we will use 999. - + 7\. Duplicate steps 4 and 5 above but this time select "CO2 becomes less than" and place it on your flow canvas.Make sure to fill in your less than ppm value such as 1000. - + 8\. Click "Add" and select "Then" and search for "set a color" and choose the AIR-1 device option. - + 9\. Draw a line to connect "CO2 becomes greater than 999 ppm. Click the 3 dots and select a color - we have chosen red to indicate a problem. - + 10\. Duplicate steps 7 and 8 but this time select green for the color when "CO2 becomes less than 1000 ppm". - + 11\. Click "Add" and select "Then" and search "push" and choose "Send message to user". - + 12\. Draw a line to connect set a color to the push notification. Write in "The CO2 level in the bedroom is currently CO2 ppm. Open the Window, turn on HVAC, etc to lower this value!" Then replace the second "CO2" and click the little tag icon and type in CO2 then select the blue CO2 option under Apollo AIR-1. - + - + 13\. Click "User" and choose "Everyone who's home" or your preferred option. - + 14\. Click "Add" and select "Delay" and then place it on your flow canvas. Change to minutes and input 5 for adding a 5 minute delay then drag a line from "set a color" to the delay. - + 15\. Click "Add" and select "Then" and search for "turn off" and choose the AIR-1 device option. - + 16\. Drag a line from the Delay in step 14 to the Turn off card and that's it! Click save at the top and give your flow a name. - + 17\. As a bonus, you can add a note reminding you what this automation does. Click "Add" then click "Note" and type in "CO2 level alert with RGB LEDs" on the note. - + 18\. You are done! Your sensor is now ready to create flows and add as a favorite to your dashboard! diff --git a/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md b/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md index 32973140b9..11cc148f3d 100755 --- a/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md +++ b/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md @@ -6,18 +6,18 @@ description: Tutorial on adding the rear female usb-c port to your MSR-2. 1\. Unplug your MSR-2 from power and remove the back. - + - + - + 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. - + - + 3\. Align the ball inside the articulating mount and then push down until it's fully seated. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/msr2/addons/adding-co2-to-msr-2.md b/docs/homey/products/msr2/addons/adding-co2-to-msr-2.md index 20447c9a0e..310b86f431 100755 --- a/docs/homey/products/msr2/addons/adding-co2-to-msr-2.md +++ b/docs/homey/products/msr2/addons/adding-co2-to-msr-2.md @@ -5,26 +5,26 @@ description: "Tutorial on adding the SCD40 CO2 sensor to your MSR-2." 1\. Unplug your MSR-2 from power and remove the back - + 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. - + 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. - + 4\. Gently push the SCD40 CO2 module onto the black mezzanine connector. - + 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. - + 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. - + 7\. Please refer to our [CO2 calibration guide](https://wiki.apolloautomation.com/homey/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/homey/products/msr2/addons/adding-gpio-header-to-msr-2.md b/docs/homey/products/msr2/addons/adding-gpio-header-to-msr-2.md index 596545ac24..ca4f2cfad8 100755 --- a/docs/homey/products/msr2/addons/adding-gpio-header-to-msr-2.md +++ b/docs/homey/products/msr2/addons/adding-gpio-header-to-msr-2.md @@ -5,27 +5,27 @@ description: "Tutorial on adding the GPIO Header to your MSR-2." 1\. Unplug your MSR-2 from power and remove the back. - + - + - + 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. - + - + 3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 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. - + - + !!! tip "Make sure to check out our MSR-2 GPIO Header LED Strip Tutorial!" diff --git a/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md b/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md index 702acaf6fe..d3f5f354db 100755 --- a/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md +++ b/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md @@ -5,26 +5,26 @@ description: "Tutorial on adding the rear female usb-c port to your MSR-2." 1\. Unplug your MSR-2 from power and remove the back - + - + - + 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. - + - + 3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 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! - + 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. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/msr2/addons/msr2-outlet-mount.md b/docs/homey/products/msr2/addons/msr2-outlet-mount.md index eadb44536b..4f4b5ae51b 100755 --- a/docs/homey/products/msr2/addons/msr2-outlet-mount.md +++ b/docs/homey/products/msr2/addons/msr2-outlet-mount.md @@ -6,19 +6,19 @@ description: Tutorial for using the MSR-2 Outlet Mount. 1\. Gather a top facing usb-c plug, an MSR-2, and our MSR-2 Outlet Mount. - + 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. - + 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. - + 4\. Gently push the other USB-C port of the MSR-2 Outlet Mount into the top of the USB-C top facing plug. - + !!! success "You're ready to plug it in and begin using your device!" diff --git a/docs/homey/products/msr2/calibrating-co2.md b/docs/homey/products/msr2/calibrating-co2.md index b475f02732..306de489d2 100755 --- a/docs/homey/products/msr2/calibrating-co2.md +++ b/docs/homey/products/msr2/calibrating-co2.md @@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2 1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA. - + 2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device. @@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2 If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key. - + 3\. Click on the button that says "PRESS" and then you are done. - + diff --git a/docs/homey/products/msr2/examples/msr2-alarmo.md b/docs/homey/products/msr2/examples/msr2-alarmo.md index 832c0e9641..21806af6b8 100755 --- a/docs/homey/products/msr2/examples/msr2-alarmo.md +++ b/docs/homey/products/msr2/examples/msr2-alarmo.md @@ -8,29 +8,29 @@ My grandmother wanted a security system that would alert her when there was move 1\. Install [HACS](https://hacs.xyz/docs/use/download/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) - + - + 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. - + 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.) - + 5\. You can change the Title, Message, and Name of the alarm notification. - + 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. - + 7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered. - + 8\. And that's it, seriously... Now you can enjoy a free and local security system. diff --git a/docs/homey/products/msr2/examples/msr2-dashboards.md b/docs/homey/products/msr2/examples/msr2-dashboards.md index c3c249db34..ecf56115fd 100755 --- a/docs/homey/products/msr2/examples/msr2-dashboards.md +++ b/docs/homey/products/msr2/examples/msr2-dashboards.md @@ -6,7 +6,7 @@ description: "Example dashboard cards for the MSR-2, including an ApexCharts sca **Radar Scatter Plot With Apex Charts For **[**MSR-2**](https://apolloautomation.com/products/msr-2) - + ```plaintext type: custom:apexcharts-card @@ -46,7 +46,7 @@ series: **CO2 Charts** Home Assistant Sensor - + ```plaintext graph: line @@ -59,7 +59,7 @@ hours_to_show: 24 Custom: Plotly Graph Card - + ```plaintext type: custom:plotly-graph @@ -72,7 +72,7 @@ title: Bedroom CO2 Home Assistant Guage - + ```plaintext type: gauge diff --git a/docs/homey/products/msr2/examples/using-msr-2-buzzer.md b/docs/homey/products/msr2/examples/using-msr-2-buzzer.md index bb7547b4ba..c95afbb076 100755 --- a/docs/homey/products/msr2/examples/using-msr-2-buzzer.md +++ b/docs/homey/products/msr2/examples/using-msr-2-buzzer.md @@ -7,7 +7,7 @@ This guide will walk you through using the buzzer on your MSR-2. You can also us 1. Open Home Assistant and navigate to developer tools in the bottom left - + 2\. Click on services @@ -29,4 +29,4 @@ This guide will walk you through using the buzzer on your MSR-2. You can also us 5\. Click on the ACTIONS button in bottom right - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/msr2/setup/msr2-general-tips.md b/docs/homey/products/msr2/setup/msr2-general-tips.md index e52dd60156..1c5cb28d5e 100755 --- a/docs/homey/products/msr2/setup/msr2-general-tips.md +++ b/docs/homey/products/msr2/setup/msr2-general-tips.md @@ -5,7 +5,7 @@ description: "Multiple helpful images for mounting, lux/rgb, and gate and zone v ##### **Light Sensor (LTR-390UV)** - + 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. @@ -17,11 +17,11 @@ When mounting the MSR-2 be sure to position the device so that the two large hol 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. - + The MSR-2 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling. - + !!! tip "These are some useful hints!" @@ -31,6 +31,6 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount ##### **Gate and FOV Visualization** -**** +**** - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/msr2/setup/zones-ha.md b/docs/homey/products/msr2/setup/zones-ha.md index c517827a42..ef72cb59f2 100755 --- a/docs/homey/products/msr2/setup/zones-ha.md +++ b/docs/homey/products/msr2/setup/zones-ha.md @@ -15,15 +15,15 @@ Here is a video of how to tune the mmWave sensor using radar engineering mode, 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) -  +  5. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8 -  +  6. The gates are different distances from the sensor -  +  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. -  +  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. -  +  **Alternate Method** diff --git a/docs/homey/products/msr2/setup/zones-hlk.md b/docs/homey/products/msr2/setup/zones-hlk.md index dacdddb108..1c09558b6c 100755 --- a/docs/homey/products/msr2/setup/zones-hlk.md +++ b/docs/homey/products/msr2/setup/zones-hlk.md @@ -10,41 +10,41 @@ description: "Tutorial for MSR-2 HLKRadarTool app Zone Configuration." 2\. Ensure the mmWave radar you want to tune has Radar Control Bluetooth turned on. Home Assistant > Settings > Devices & services > ESPHome Devices > Select Device > Scroll down and toggle on Radar Control Bluetooth - + 3\. Open the app and select your device - + 4\. Turn on Engineering Mode - + 5\. Select More and then select Parameter settings - + 6\. Select Detect background noise - + 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. - + 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 - + **Maximum** - Sets the gate sensitivity to the maximum move and still energy - + -**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energ**y** **** 9. Now your mmWave should be tuned to your environment! **Manual Calibration** 1. Follow steps 1-5 above +**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energ**y** **** 9. Now your mmWave should be tuned to your environment! **Manual Calibration** 1. Follow steps 1-5 above 2\. Select Motion or Static sensitivity, change it to your desired value, and select Set - + 3\. Now your mmWave should be tuned to your environment! \ No newline at end of file diff --git a/docs/homey/products/msr2/troubleshooting/msr2-boot-mode.md b/docs/homey/products/msr2/troubleshooting/msr2-boot-mode.md index 6db0389267..97d924b021 100755 --- a/docs/homey/products/msr2/troubleshooting/msr2-boot-mode.md +++ b/docs/homey/products/msr2/troubleshooting/msr2-boot-mode.md @@ -11,7 +11,7 @@ description: "Step by step guide for putting The MSR-2 In Boot Mode." 1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button). - + 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. @@ -25,6 +25,6 @@ description: "Step by step guide for putting The MSR-2 In Boot Mode." 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. - + 4\. Continue with uploading the firmware document. \ No newline at end of file diff --git a/docs/homey/products/msr2/troubleshooting/msr2-code.md b/docs/homey/products/msr2/troubleshooting/msr2-code.md index 5510cce6b2..c213fa1e99 100755 --- a/docs/homey/products/msr2/troubleshooting/msr2-code.md +++ b/docs/homey/products/msr2/troubleshooting/msr2-code.md @@ -11,7 +11,7 @@ If your device has already been connected to Home Assistant please 2 sensor. There is an X on the SCD40 sensor's PCB as well, you can see it in the image below. There is also a "gold dot" in the top left of the SCD40 when oriented properly. - + 4\. Gently push the SCD40 CO2 module onto the black mezzanine connector. - + 5\. Slide the case back over the MTR-1, making sure that the case has the hole for the LUX Sensor facing the right direction (to the right). - + 6\. Flip the MTR-1 back over to prepare to put the back case on. - + 7\. Gently press the backplate of the MTR-1 case onto the MTR-1 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. - + 8\. Put the stand back on if applicable. - + 9\. 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/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md b/docs/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md index fc6d3039e2..08834eef19 100755 --- a/docs/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md +++ b/docs/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md @@ -6,31 +6,31 @@ description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1 1\. Unplug your MTR-1 from power and remove the stand if attached. - + 2\. Remove the backplate of the MTR-1. - + 3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the GPIO Header addon. - + - + 4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 5\. Align the new back for your MTR-1 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. - + 6\. The case should sit flush and you're now ready to add functionality to your device! - + - + !!! ! tip "Make sure to check out our GPIO Header LED Strip Tutorial!" diff --git a/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md b/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md index cbd0458171..eccc4f0556 100755 --- a/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md +++ b/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md @@ -6,26 +6,26 @@ description: Step by step tutorial for adding the Rear Male USB addon to the MTR 1\. Unplug your MTR-1 from power and remove the stand if attached. - + 2\. Remove the backplate of the MTR-1. - + 3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the male Rear USB-C addon. - + - + 4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 5\. Align the new back for your MTR-1 that came with the Male USB-C addon. Push down on the corners closest to the USB-C addon first, and then push the back on securely on the other two corners. - + 6\. The case should sit flush and you're now ready to plug into a USB-C Outlet! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md b/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md index a8b2bff103..61e938d299 100755 --- a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md +++ b/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md @@ -6,7 +6,7 @@ description: "Example dashboard cards for the MTR-1, including an ApexCharts rad **Radar Scatter Plot With Apex Charts** - + ```plaintext type: custom:apexcharts-card @@ -46,7 +46,7 @@ series: **CO2 Charts** Home Assistant Sensor - + ```plaintext graph: line @@ -59,7 +59,7 @@ hours_to_show: 24 Custom: Plotly Graph Card - + ```plaintext type: custom:plotly-graph @@ -72,7 +72,7 @@ title: Bedroom CO2 Home Assistant Guage - + ```plaintext type: gauge diff --git a/docs/homey/products/mtr1/examples/mtr1-alarmo.md b/docs/homey/products/mtr1/examples/mtr1-alarmo.md index a366d7c636..21b498137c 100755 --- a/docs/homey/products/mtr1/examples/mtr1-alarmo.md +++ b/docs/homey/products/mtr1/examples/mtr1-alarmo.md @@ -8,29 +8,29 @@ My grandmother wanted a security system that would alert her when there was move 1\. Install [HACS](https://hacs.xyz/docs/use/download/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) - + - + 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. - + 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.) - + 5\. You can change the Title, Message, and Name of the alarm notification. - + 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. - + 7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered. - + 8\. And that's it, seriously... Now you can enjoy a free and local security system. diff --git a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md index a9206e9562..8b36c5f29e 100755 --- a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md +++ b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md @@ -7,7 +7,7 @@ This guide will walk you through using the buzzer on your MTR-1. You can also us 1. Open Home Assistant and navigate to developer tools in the bottom left - + 2\. Click on services @@ -29,4 +29,4 @@ This guide will walk you through using the buzzer on your MTR-1. You can also us 5\. Click on the ACTIONS button in bottom right - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/mtr1/setup/general-tips.md b/docs/homey/products/mtr1/setup/general-tips.md index 3c3aae7ee1..838cad3f4d 100755 --- a/docs/homey/products/mtr1/setup/general-tips.md +++ b/docs/homey/products/mtr1/setup/general-tips.md @@ -4,11 +4,11 @@ description: "Multiple helpful images for mounting, lux/rgb, and zone visualizat ##### **MTR-1 PCB with Sensors** - + ##### **Light Sensor (LTR-390UV)** - + When mounting the MTR-1 be sure to position the device so that the large hole at the top is not covered. This allows more light to enter and will ensure better accuracy @@ -16,19 +16,19 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak ##### **Mounting** - + ##### **LD2450 Performance and Electrical Parameters** ##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf) - + ##### **Expanding Horizontal Distance as Target Moves Further Away** The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance. - + ##### **Increased ESP Temperature** diff --git a/docs/homey/products/mtr1/setup/zones-hlk.md b/docs/homey/products/mtr1/setup/zones-hlk.md index 84ce325bb1..9512e007ae 100755 --- a/docs/homey/products/mtr1/setup/zones-hlk.md +++ b/docs/homey/products/mtr1/setup/zones-hlk.md @@ -20,7 +20,7 @@ The ESPHome Integrations page then select your MTR-1 and scroll down until you see LD2450 Bluetooth. - + 2\. Open the HLKRadarTool App and select your device. @@ -28,11 +28,11 @@ The uploading the firmware document. \ No newline at end of file diff --git a/docs/homey/products/mtr1/troubleshooting/mtr1-code.md b/docs/homey/products/mtr1/troubleshooting/mtr1-code.md index bb26b8451b..d7bf76630f 100755 --- a/docs/homey/products/mtr1/troubleshooting/mtr1-code.md +++ b/docs/homey/products/mtr1/troubleshooting/mtr1-code.md @@ -11,7 +11,7 @@ If your device has already been connected to Home Assistant please Home Assistant Plant Integration
 + 4\. Gently push the SCD40 CO2 module onto the black mezzanine connector. - + 5\. Slide the case back over the MTR-1, making sure that the case has the hole for the LUX Sensor facing the right direction (to the right). - + 6\. Flip the MTR-1 back over to prepare to put the back case on. - + 7\. Gently press the backplate of the MTR-1 case onto the MTR-1 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. - + 8\. Put the stand back on if applicable. - + 9\. 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/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md b/docs/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md index fc6d3039e2..08834eef19 100755 --- a/docs/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md +++ b/docs/homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md @@ -6,31 +6,31 @@ description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1 1\. Unplug your MTR-1 from power and remove the stand if attached. - + 2\. Remove the backplate of the MTR-1. - + 3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the GPIO Header addon. - + - + 4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 5\. Align the new back for your MTR-1 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. - + 6\. The case should sit flush and you're now ready to add functionality to your device! - + - + !!! ! tip "Make sure to check out our GPIO Header LED Strip Tutorial!" diff --git a/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md b/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md index cbd0458171..eccc4f0556 100755 --- a/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md +++ b/docs/homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md @@ -6,26 +6,26 @@ description: Step by step tutorial for adding the Rear Male USB addon to the MTR 1\. Unplug your MTR-1 from power and remove the stand if attached. - + 2\. Remove the backplate of the MTR-1. - + 3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the male Rear USB-C addon. - + - + 4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 5\. Align the new back for your MTR-1 that came with the Male USB-C addon. Push down on the corners closest to the USB-C addon first, and then push the back on securely on the other two corners. - + 6\. The case should sit flush and you're now ready to plug into a USB-C Outlet! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md b/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md index a8b2bff103..61e938d299 100755 --- a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md +++ b/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md @@ -6,7 +6,7 @@ description: "Example dashboard cards for the MTR-1, including an ApexCharts rad **Radar Scatter Plot With Apex Charts** - + ```plaintext type: custom:apexcharts-card @@ -46,7 +46,7 @@ series: **CO2 Charts** Home Assistant Sensor - + ```plaintext graph: line @@ -59,7 +59,7 @@ hours_to_show: 24 Custom: Plotly Graph Card - + ```plaintext type: custom:plotly-graph @@ -72,7 +72,7 @@ title: Bedroom CO2 Home Assistant Guage - + ```plaintext type: gauge diff --git a/docs/homey/products/mtr1/examples/mtr1-alarmo.md b/docs/homey/products/mtr1/examples/mtr1-alarmo.md index a366d7c636..21b498137c 100755 --- a/docs/homey/products/mtr1/examples/mtr1-alarmo.md +++ b/docs/homey/products/mtr1/examples/mtr1-alarmo.md @@ -8,29 +8,29 @@ My grandmother wanted a security system that would alert her when there was move 1\. Install [HACS](https://hacs.xyz/docs/use/download/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) - + - + 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. - + 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.) - + 5\. You can change the Title, Message, and Name of the alarm notification. - + 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. - + 7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered. - + 8\. And that's it, seriously... Now you can enjoy a free and local security system. diff --git a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md index a9206e9562..8b36c5f29e 100755 --- a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md +++ b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md @@ -7,7 +7,7 @@ This guide will walk you through using the buzzer on your MTR-1. You can also us 1. Open Home Assistant and navigate to developer tools in the bottom left - + 2\. Click on services @@ -29,4 +29,4 @@ This guide will walk you through using the buzzer on your MTR-1. You can also us 5\. Click on the ACTIONS button in bottom right - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/mtr1/setup/general-tips.md b/docs/homey/products/mtr1/setup/general-tips.md index 3c3aae7ee1..838cad3f4d 100755 --- a/docs/homey/products/mtr1/setup/general-tips.md +++ b/docs/homey/products/mtr1/setup/general-tips.md @@ -4,11 +4,11 @@ description: "Multiple helpful images for mounting, lux/rgb, and zone visualizat ##### **MTR-1 PCB with Sensors** - + ##### **Light Sensor (LTR-390UV)** - + When mounting the MTR-1 be sure to position the device so that the large hole at the top is not covered. This allows more light to enter and will ensure better accuracy @@ -16,19 +16,19 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak ##### **Mounting** - + ##### **LD2450 Performance and Electrical Parameters** ##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf) - + ##### **Expanding Horizontal Distance as Target Moves Further Away** The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance. - + ##### **Increased ESP Temperature** diff --git a/docs/homey/products/mtr1/setup/zones-hlk.md b/docs/homey/products/mtr1/setup/zones-hlk.md index 84ce325bb1..9512e007ae 100755 --- a/docs/homey/products/mtr1/setup/zones-hlk.md +++ b/docs/homey/products/mtr1/setup/zones-hlk.md @@ -20,7 +20,7 @@ The](http
1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button).
-
+
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.
@@ -19,23 +19,23 @@ If your device has already been connected to Home Assistant please <a href=){kind=link}
This integration can automatically fetch data from OpenPlantBook if you are a registered user. Registration is free.
Plants are set up in the UI and all configuration of your plants can be managed there or by automations and scripts. diff --git a/docs/homey/products/plt1/general-tips.md b/docs/homey/products/plt1/general-tips.md index 88644ab58a..5639c365ef 100755 --- a/docs/homey/products/plt1/general-tips.md +++ b/docs/homey/products/plt1/general-tips.md @@ -7,10 +7,10 @@ description: "Helpful tips to get the most use out of your sensor." When looking at the PLT-1 in the below orientation, the boot button is on the left and the reset is on the right by the USB-C port. - + ## LTR390 UV For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/plt1/setup/prevent-sleep.md b/docs/homey/products/plt1/setup/prevent-sleep.md index e1cba1f6a5..7c97d5bd9a 100755 --- a/docs/homey/products/plt1/setup/prevent-sleep.md +++ b/docs/homey/products/plt1/setup/prevent-sleep.md @@ -13,11 +13,11 @@ description: "Tutorial for how to enable/disable prevent sleep." 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 5 minutes. diff --git a/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md index 492a2a026f..860e57d6dd 100755 --- a/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md @@ -11,7 +11,7 @@ description: "Step by step guide for putting The PLT-1 In Boot Mode." 1\. Position the PLT-1 as shown in the image below and locate the small opening to press the boot button. - + 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. @@ -25,6 +25,6 @@ description: "Step by step guide for putting The PLT-1 In Boot Mode." 3\. Hold down the boot button, then press and release the reset button while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with uploading the firmware document. \ No newline at end of file diff --git a/docs/homey/products/plt1/troubleshooting/plt1-code.md b/docs/homey/products/plt1/troubleshooting/plt1-code.md index aee83e601b..f0ddbe66b1 100755 --- a/docs/homey/products/plt1/troubleshooting/plt1-code.md +++ b/docs/homey/products/plt1/troubleshooting/plt1-code.md @@ -11,29 +11,29 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. - + 2\. Navigate to our installer page and click connect under Non Battery Firmware Apollo PLT-1 Installer 3\. Click the big "Connect" button. - + 4\. Select the open com port then click Connect. - + 5\. Click "Install ApolloAutomation.PLT-1". - + 6\. Click "INSTALL". - + 7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/homey/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md b/docs/homey/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md index 8c3992b9ba..45628b1c7a 100755 --- a/docs/homey/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md +++ b/docs/homey/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md @@ -7,7 +7,7 @@ description: "Step by step guide for resetting the Wi-Fi Credentials on your PLT 2\. Long press the Boot button for 10 seconds - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/homey/products/plt1b/general-tips.md b/docs/homey/products/plt1b/general-tips.md index 3beb9d1ece..b686642dab 100755 --- a/docs/homey/products/plt1b/general-tips.md +++ b/docs/homey/products/plt1b/general-tips.md @@ -7,10 +7,10 @@ description: "Helpful tips to get the most use out of your sensor." When looking at the PLT-1B in the below orientation, the boot button is on the left and the reset is on the right by the USB-C port. - + ## LTR390 UV For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/plt1b/setup/prevent-sleep.md b/docs/homey/products/plt1b/setup/prevent-sleep.md index 0987d02c0c..c313b857d5 100755 --- a/docs/homey/products/plt1b/setup/prevent-sleep.md +++ b/docs/homey/products/plt1b/setup/prevent-sleep.md @@ -13,11 +13,11 @@ description: "Keep the PLT-1B awake instead of letting it sleep, and what that c 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 12 hours. diff --git a/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md index 92a11c3817..2172554c0d 100755 --- a/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -7,15 +7,15 @@ description: "Step by step guide for putting The PLT-1B In Boot Mode." This is needed to force the device into boot mode to reflash the firmware. - + ##### Method 1: Boot Button Only 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. - + - + 2\. Use a pin to press and hold the boot button, while holding the boot button plug the PLT-1B back into your computer/power and then release the boot button @@ -27,8 +27,8 @@ description: "Step by step guide for putting The PLT-1B In Boot Mode." 2\. Press and hold the boot button, while holding it press and release the reset button, then release the boot button - + - + 3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-code/) \ No newline at end of file diff --git a/docs/homey/products/plt1b/troubleshooting/plt1b-code.md b/docs/homey/products/plt1b/troubleshooting/plt1b-code.md index 18774753fa..0c2ea18589 100755 --- a/docs/homey/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/homey/products/plt1b/troubleshooting/plt1b-code.md @@ -13,17 +13,17 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. - + 2\. Navigate to our installer page and click connect under Battery Firmware Apollo PLT-1B Installer @@ -51,23 +51,23 @@ If your device has already been connected to Home Assistant please in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/temp1/examples/temp1-automation-examples.md b/docs/homey/products/temp1/examples/temp1-automation-examples.md index 4e31ed9850..0d61f133a9 100755 --- a/docs/homey/products/temp1/examples/temp1-automation-examples.md +++ b/docs/homey/products/temp1/examples/temp1-automation-examples.md @@ -11,11 +11,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -23,11 +23,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -35,11 +35,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -71,7 +71,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -79,11 +79,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -91,11 +91,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -126,122 +126,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/homey/products/temp1/setup/prevent-sleep.md b/docs/homey/products/temp1/setup/prevent-sleep.md index d23f61f4ee..05151144b8 100755 --- a/docs/homey/products/temp1/setup/prevent-sleep.md +++ b/docs/homey/products/temp1/setup/prevent-sleep.md @@ -13,11 +13,11 @@ description: "Guide for setting up and using the prevent sleep toggle with the T 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 8 minutes. diff --git a/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md index d14f1611e4..bf8da66557 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md @@ -11,13 +11,13 @@ description: "Step by step guide for putting The TEMP-1 In Boot Mode." 1\. Position the TEMP-1 so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. - + If you prefer, please remove the lid by gently prying up on the small slit by the top of the case. - + - + 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 TEMP-1 then let go of the button. diff --git a/docs/homey/products/temp1/troubleshooting/temp1-code.md b/docs/homey/products/temp1/troubleshooting/temp1-code.md index 9826e9fe65..cc1847194c 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-code.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-code.md @@ -15,23 +15,23 @@ If your device has already been connected to Home Assistant please in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1B will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/temp1b/examples/temp1b-automation-examples.md b/docs/homey/products/temp1b/examples/temp1b-automation-examples.md index e19c580163..805ec8ef00 100755 --- a/docs/homey/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/homey/products/temp1b/examples/temp1b-automation-examples.md @@ -11,11 +11,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -23,11 +23,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1B device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -35,11 +35,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1B reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -71,7 +71,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -79,11 +79,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1b device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -91,11 +91,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1B reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -126,122 +126,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/homey/products/temp1b/setup/insert-battery.md b/docs/homey/products/temp1b/setup/insert-battery.md index 8f7bcdf3e8..522fb603d5 100755 --- a/docs/homey/products/temp1b/setup/insert-battery.md +++ b/docs/homey/products/temp1b/setup/insert-battery.md @@ -9,44 +9,44 @@ description: "How to Insert Battery on TEMP-1B." 1\. Gently pry open the case lid as shown in the image below. - + - + 2\. Once the lid is removed either lift the PCB out or gently dump the pcb out by turning it upside down. - + - + 3\. Align the battery as shown in the image below. - + 4\. Insert the battery with the positive terminal facing the + sign. - + - + 5\. Begin reassembly by placing the battery side down with the RGB led in the top right corner. - + - + 6\. You will use the "ledge" of the case to set the PCB down and then it will lay down and rest on the ledge of the other side as well. - + - + 7\. Align the RGB led in the top right with the small hole in the lid. - + 8\. Gently press down until it the lid seats. - + 9 You have now installed or reinstalled the battery! \ No newline at end of file diff --git a/docs/homey/products/temp1b/setup/prevent-sleep.md b/docs/homey/products/temp1b/setup/prevent-sleep.md index 1017b03847..f922c59acd 100755 --- a/docs/homey/products/temp1b/setup/prevent-sleep.md +++ b/docs/homey/products/temp1b/setup/prevent-sleep.md @@ -13,11 +13,11 @@ description: "Keep the TEMP-1B awake instead of letting it sleep, and what that 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of hours you want your sensor to sleep in the "Sleep Duration" box. Defaults to 12 hours. diff --git a/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md index 757cf84c28..a4992032ad 100755 --- a/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md +++ b/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md @@ -11,13 +11,13 @@ description: "Step by step guide for putting The TEMP-1B In Boot Mode." 1\. Position the TEMP-1B so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. - + If you prefer, please remove the lid by gently prying up on the small slit by the top of the case. - + - + 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 TEMP-1B then let go of the button. diff --git a/docs/homey/products/temp1b/troubleshooting/temp1b-code.md b/docs/homey/products/temp1b/troubleshooting/temp1b-code.md index 97b9be9ac8..c6f19b98bc 100755 --- a/docs/homey/products/temp1b/troubleshooting/temp1b-code.md +++ b/docs/homey/products/temp1b/troubleshooting/temp1b-code.md @@ -19,19 +19,19 @@ If your device has already been connected to Home Assistant please
+
4\. Click )
Next - Light Effects
+ Next - Light Effects
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/automations/motion-activated-light.md b/docs/products/ESPHome-Starter-Kit/automations/motion-activated-light.md
index 04b1de041f..f6d1d724fa 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/motion-activated-light.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/motion-activated-light.md
@@ -28,7 +28,7 @@ ESPHome Device Builder has a GUI for building
@@ -132,7 +132,7 @@ Your automation is saved in Device Builder, but the device is still running its
3. Wait for the compile and flash to finish. The device reboots once the install is done.
-
+
## Test the automations
@@ -142,6 +142,6 @@ Your automation is saved in Device Builder, but the device is still running its
With the device back online, wave your hand in front of the PIR sensor. The RGB light turns on as soon as motion is detected, then turns off shortly after the sensor stops seeing movement. If the light triggers right after boot with nothing moving, give the sensor a moment. PIR sensors need a brief warm-up after powering on, usually 5 to 10 seconds, before their readings stabilize.
- + ## Test the automations @@ -142,6 +142,6 @@ Your automation is saved in Device Builder, but the device is still running its With the device back online, wave your hand in front of the PIR sensor. The RGB light turns on as soon as motion is detected, then turns off shortly after the sensor stops seeing movement. If the light triggers right after boot with nothing moving, give the sensor a moment. PIR sensors need a brief warm-up after powering on, usually 5 to 10 seconds, before their readings stabilize. -](https://esphome.io/automa
1. Open your starter kit device in ESPHome Device Builder and click **Edit**. If you need a refresher on the editor, see the [Device Builder Tour](../learning-the-basics/device-builder-tour.md#editor).
2. In the editor's left pane, expand the **Automations** dropdown and click **Add Automation**.
- 
+ 
3. Set up the trigger:
@@ -42,7 +42,7 @@ ESPHome Device Builder has a GUI for building <a href=){kind=link}
Next - Temp-Reactive LEDs
+ Next - Temp-Reactive LEDs
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md b/docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md
index 773276d2fb..47d412b3a2 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md
@@ -35,7 +35,7 @@ ESPHome Device Builder has a GUI for building .
2. In the editor's left pane, expand the **Automations** dropdown and click **Add Automation**.
- 
+ 
3. Set up the trigger:
@@ -49,7 +49,7 @@ ESPHome Device Builder has a GUI for building <a href=)
Next - Connect to Home Assistant
+ Next - Connect to Home Assistant
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/automations/temp-reactive-leds.md b/docs/products/ESPHome-Starter-Kit/automations/temp-reactive-leds.md
index 0da99f9d4b..72fe120b62 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/temp-reactive-leds.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/temp-reactive-leds.md
@@ -51,7 +51,7 @@ ESPHome Device Builder has a GUI for building .
2. In the editor's left pane, expand the **Automations** dropdown and click **Add Automation**.
- 
+ 
#### Cold band: below 18 °C → Blue
@@ -81,7 +81,7 @@ ESPHome Device Builder has a GUI for building <a href=)
Next - Connect to Home Assistant
+ Next - Connect to Home Assistant
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/community-corner.md b/docs/products/ESPHome-Starter-Kit/community-corner.md
index 7603544d54..aac7907c37 100644
--- a/docs/products/ESPHome-Starter-Kit/community-corner.md
+++ b/docs/products/ESPHome-Starter-Kit/community-corner.md
@@ -21,6 +21,6 @@ A printable housing for the LED & Buzzer module. Print one and give your notific
[Download the .STEP file :material-download:](../../assets/apollo_starterkit_housing_var2.step){ .md-button .md-button--primary }
-
+
-
+
diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md b/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md
index e6d074549d..3ae44c3101 100644
--- a/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md
+++ b/docs/products/ESPHome-Starter-Kit/everyday-use/button-toggles-room-light.md
@@ -33,7 +33,7 @@ This is an alternative way to use the Starter Kit's button. Instead of toggling
1. The button registers as a binary sensor. `On` maps to a pressed state - the moment you push the button down. Home Assistant fires the automation at that instant.
- 
+ 
4. Under **Then do**, click **+ Add action**, type `toggle light`, and select **Light: Toggle**.
@@ -47,12 +47,12 @@ This is an alternative way to use the Starter Kit's button. Instead of toggling
1. If you'd rather it always turn on or always turn off, use **Light: Turn on** or **Light: Turn off** instead.
2. You can also set a **Color**, **Color temperature**, or **Brightness** here for when the light turns on. Toggling it off ignores them.
- 
+ 
5. Click **Save**.
6. Give the automation a name like `Button toggles room light`, then click **Save** again.
- 
+ 
??? note "What the automation looks like in YAML"
@@ -85,6 +85,6 @@ Press the button on the Button module. The light you targeted toggles. Press aga
Any light in your home - a bedside lamp, a ceiling group, a smart bulb strip - is one button press away. Swap `light.toggle` for `light.turn_on` with a `brightness_pct` to land on a specific brightness, or target a light group to control a whole room at once.
- Next - Trash Night Reminder
+ Next - Trash Night Reminder
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md b/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md
index 123edf6544..c7adf98abe 100644
--- a/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md
+++ b/docs/products/ESPHome-Starter-Kit/everyday-use/motion-activated-room-lights.md
@@ -42,7 +42,7 @@ A blueprint is a fill-in-the-blanks automation. Home Assistant ships one called
1. Open [Settings → Automations & scenes → Blueprints](https://my.home-assistant.io/redirect/blueprints/) and look for **Motion-activated Light**. If it's there, skip to step 3. (1)
- 
+ 
2. If it's missing, click **Import Blueprint** in the bottom right, paste the URL below, then click **Preview** and **Import Blueprint**.
@@ -55,7 +55,7 @@ A blueprint is a fill-in-the-blanks automation. Home Assistant ships one called
* **Light Target** → the light you want to control.
* **Wait time** → seconds to leave the light on after the last movement. 120 is a sensible start. (2)
- 
+ 
@@ -79,24 +79,24 @@ You could make two automations, one to turn the light on and one to turn it off.
1. Open [Settings → Automations & scenes](https://my.home-assistant.io/redirect/automations/), click **Create Automation**, then **Create new automation**.
2. Click **Add Trigger**, search **motion**, and click **Motion detected**. Set its target to your **Motion Module** sensor. Open the trigger's menu (the three dots), choose **Rename**, and set the **Trigger ID** to `Detected`. (1)
- 
+ 
3. Add another trigger the same way, this time **Motion cleared** on the same **Motion Module**, with **For** → 2 minutes. Set its **Trigger ID** to `Clear`. (2)
- 
+ 
4. Under **Then do**, add **Building Blocks → Choose**.
5. In **Option 1**, add a **Triggered by** condition set to `Detected`, then an action of **Light → Turn on** targeting your room light.
- 
+ 
6. Add **Option 2** with a **Triggered by** condition of `Clear` and a **Light → Turn off** action on the same light.
- 
+ 
7. Click the three dots in the top right, choose **Change mode**, select **Restart**, then click **Change mode** to confirm. (3)
- 
+ 
@@ -158,7 +158,7 @@ You could make two automations, one to turn the light on and one to turn it off.
Click **Save**, give the automation a name like `Motion Activated Lights`, and if you like, add a label such as `Lighting` to group it with your other light automations. Click **Save** to finish.
-
+
Now walk in. The light comes on, the room goes still, and after the quiet period it turns off. From here you can add a [condition](https://www.home-assistant.io/docs/scripts/conditions/) so it only runs after sunset, or point the `Detected` branch at a whole scene.
diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md b/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md
index ae10ec48c8..b49eebe41c 100644
--- a/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md
+++ b/docs/products/ESPHome-Starter-Kit/everyday-use/play-a-tune-from-home-assistant.md
@@ -48,11 +48,11 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
1. Open your starter kit device in ESPHome Device Builder and click **Edit**, then open the **Core configuration** tab and select **Native API**.
- 
+ 
2. Click **Add API Action** and enter `play_pink_panther` as the **Action name**. (1)
- 
+ 
3. Click **Add action**, choose **Rtttl → Play** from the top of the list, and paste the Pink Panther theme into the **Rtttl** field:
@@ -60,7 +60,7 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
PinkPanther:d=4,o=5,b=160:8d#,8e,2p,8f#,8g,2p,8d#,8e,16p,8f#,8g,16p,8c6,8b,16p,8d#,8e,16p,8b,2a#,2p,16a,16g,16e,16d,2e
```
- 
+ 
@@ -90,7 +90,7 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
1. Open your starter kit device in ESPHome Device Builder and click **Edit**, then open the **Core configuration** tab and select **Native API**.
- 
+ 
2. Add a slot for each of the four tunes below. Each slot is its own API action, so **repeat these steps once per song**:
@@ -107,7 +107,7 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
The gif shows the first slot; the tunes for all four are below.
- 
+ 
**`play_song_1`** — Pink Panther
@@ -145,7 +145,7 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
1. Use **λ Lambda**, not **Value**. A plain **Value** treats `song_str` as literal text, a tune named "song_str" that won't play, while the lambda returns the variable's contents. Leave the quotes off `song_str` so it stays the variable and not a string.
- 
+ 
??? note "What the editor built in YAML"
@@ -201,7 +201,7 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
1. Lets the field store what you type. Without it the install fails with *"Either optimistic mode must be enabled, or set_action must be set"*.
2. The play buttons reference these IDs by name, so they have to match exactly, or the install fails with *"Couldn't find ID 'song_1'"*.
- 
+ 
Repeat for **Song 2**, **Song 3**, and **Song 4**, giving each the matching **ID** (`song_2`, `song_3`, `song_4`). To have a tune ready to play right away, paste an RTTTL string into each field's **Initial value**; otherwise leave it empty and paste one in from the dashboard before pressing Play.
@@ -211,7 +211,7 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
- Click **Add action** and choose **Rtttl → Play**.
- Switch the **Rtttl** field to **λ Lambda** and enter `return id(song_1).state;`.
- 
+ 
@@ -315,7 +315,7 @@ Your actions are saved in Device Builder, but the device is still running its ol
3. Wait for the compile and flash to finish. The device reboots once the install is done.
-
+
## Call it from Home Assistant
diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/temperature-on-your-dashboard.md b/docs/products/ESPHome-Starter-Kit/everyday-use/temperature-on-your-dashboard.md
index 1566adfa81..ab78a20b28 100644
--- a/docs/products/ESPHome-Starter-Kit/everyday-use/temperature-on-your-dashboard.md
+++ b/docs/products/ESPHome-Starter-Kit/everyday-use/temperature-on-your-dashboard.md
@@ -27,7 +27,7 @@ A Tile card is the small, modern card you see across most Home Assistant dashboa
2. Search `starter kit` and check both the **Temperature** and **Humidity** sensors. (1)
3. Click **Tile** to lay them out as two tiles, then click **Save**.
- 
+ 
@@ -48,7 +48,7 @@ A Gauge card shines when a higher reading really does mean worse, and indoor hum
3. Set **Minimum** to `0` and **Maximum** to `100`, the full percentage range.
4. Toggle on **Display as needle gauge**, then turn on **Severity** and set green at `0`, yellow at `50`, and red at `60`. (1)
- 
+ 
diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/trash-night-reminder.md b/docs/products/ESPHome-Starter-Kit/everyday-use/trash-night-reminder.md
index dd199107b9..211333cf24 100644
--- a/docs/products/ESPHome-Starter-Kit/everyday-use/trash-night-reminder.md
+++ b/docs/products/ESPHome-Starter-Kit/everyday-use/trash-night-reminder.md
@@ -42,7 +42,7 @@ Home Assistant's **Local Calendar** integration stores events entirely inside Ho
2. Name it `Trash` and click **Submit**. Home Assistant creates a calendar entity called `calendar.trash`.
- 
+ 
**Add the Recycle calendar**
@@ -50,7 +50,7 @@ Home Assistant's **Local Calendar** integration stores events entirely inside Ho
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=local_calendar)
- 
+ 
**Add recurring events**
@@ -75,7 +75,7 @@ Add a repeating event to each calendar to match your actual pickup schedule.
6. Click **Save**.
- 
+ 
??? note "Do the same for the Recycle calendar"
@@ -87,7 +87,7 @@ Add a repeating event to each calendar to match your actual pickup schedule.
- Enable **Repeat** and set it to **Weekly** on that day. If recycle goes out more than once a week, scroll down and select the other day too.
- Click **Save**.
- 
+ 
## Build the automation
diff --git a/docs/products/ESPHome-Starter-Kit/faq.md b/docs/products/ESPHome-Starter-Kit/faq.md
index f77d895ead..9eff86cb5e 100644
--- a/docs/products/ESPHome-Starter-Kit/faq.md
+++ b/docs/products/ESPHome-Starter-Kit/faq.md
@@ -4,7 +4,7 @@ description: Frequently asked questions about the ESPHome Starter Kit, ESPHome D
---
# ESPHome Starter Kit FAQ
-
+
1\. **What is the ESPHome Starter Kit?**
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md
index f13018fcd4..b0448e3727 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/core-components.md
@@ -39,7 +39,7 @@ If you remove the Web Server component, the device still works, but `esphome-sta
3. Click **Add** once more to confirm.
4. Toggle **Show advanced settings**, scroll to **Version**, and select **3**.
- ESPHome Web Server docs
+ ESPHome Web Server docs
---
@@ -70,7 +70,7 @@ If you remove the rail, **the Onboard RGB LED and any plugged-in modules will st
2. Click **Add component**, scroll to **Accessory Power Rail**, and click **Add**.
3. Click **Add** once more to confirm.
- ESPHome GPIO Switch docs
+ ESPHome GPIO Switch docs
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md
index 356bc37b44..2ce3b324a6 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md
@@ -17,7 +17,7 @@ The **ESPHome Device Builder** is the app you used in [First Steps](../setup/fir
ESPHome Device Builder has a tour built in that walks you through creating, configuring, and installing a device. It takes about five minutes. Start it from the menu in the top-right corner, or from **Start guided tour** on the last screen of first-time setup.
-
+
The rest of this page covers the same screens in more detail, so you can come back and read whichever one you need.
@@ -25,7 +25,7 @@ The rest of this page covers the same screens in more detail, so you can come ba
When you open **ESPHome Device Builder**, you see a list of your ESPHome devices.
-
+
* The blue **Edit** button on your device card opens the [configuration editor](#editor). You'll use this most.
@@ -41,7 +41,7 @@ When you open **ESPHome Device Builder**, you see a list of your ESPHome devices
Click **Edit** on your device card and the screen flips into the configuration editor. It has three panes: the **Device navigator** on the left, the **Form pane** in the middle, and the **YAML editor** on the right.
-
+
#### Device navigator (left)
@@ -51,13 +51,13 @@ The left pane is your config's table of contents. It groups everything into thre
* **Components.** The things your device does: switches, sensors, lights. The default Starter Kit has the accessory power switch, the I²C bus, and the AHT10 temperature and humidity sensor. Use **\+ Add component** to add more.
* **Automations.** Reactions that run on the device, like "when this button is pressed, turn that switch on". The Starter Kit ships with none by default.
-
+
#### Form pane (middle)
Click anything in the navigator to see its settings here as a form. Every field has inline help text, and a **Docs** link in the top right takes you to the official ESPHome reference for that component.
-
+
#### YAML editor (right)
@@ -65,7 +65,7 @@ The right pane is the raw YAML for your device, colour-coded with line numbers.
The form pane and the YAML editor are always in sync. Edit either side and the other updates instantly. You can learn [YAML](what-is-yaml.md) by reading what the forms produce.
-
+
## Publishing Changes
@@ -75,13 +75,13 @@ When you have finished making changes:
2. Click **Validate** at the bottom right. ESPHome checks your config and reports any errors with the exact line and reason.
3. After saving, an **Install** button appears at the bottom right of the editor. If there's also a new ESPHome release available, the button reads **Update** instead. Click it, then pick **On the Network** for OTA, or **Plug into this computer** for USB.
-
+
#### Logs
Click **Logs** from the info panel or the device card's three-dot menu to open a live stream of what the device is reporting. Click **Stop** when done.
-
+
Pop them open when something looks off, or just to watch sensor readings come in.
@@ -91,6 +91,6 @@ Pop them open when something looks off, or just to watch sensor readings come in
* Read [What is secrets.yaml?](what-is-secrets-yaml.md) to understand how Wi-Fi and encryption keys are stored.
* Bookmark the [official ESPHome documentation](https://esphome.io) for component reference whenever you click a **Docs** link.
- Back - Explaining ESPHome Next - What is YAML?
+ Back - Explaining ESPHome Next - What is YAML?
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md
index b294dd4d72..89de64e11b 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md
@@ -50,7 +50,7 @@ You get wireless updates, a built-in web page for controlling your device, and d
The official ESPHome documentation covers every component, configuration option, and advanced topic in detail.
- Next - Device Builder Tour Visit esphome.io
+ Next - Device Builder Tour Visit esphome.io
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md
index 4565fbcfb8..46dc8db3eb 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/how-esphome-talks-to-home-assistant.md
@@ -57,7 +57,7 @@ For a single device, the on-device web page is often enough. For anything that t
For UniFi networks specifically, see our [UniFi mDNS troubleshooting guide](../../general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md).
- Back - What is secrets.yaml? Tutorial - Connect to Home Assistant
+ Back - What is secrets.yaml? Tutorial - Connect to Home Assistant
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-i2c.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-i2c.md
index 182f9663b4..4756ba041d 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-i2c.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-i2c.md
@@ -51,7 +51,7 @@ If you plug in a sensor and aren't sure of its address, the scan tells you. If t
Ready to plug something in? The [Breakout Module](/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md) page covers the connectors, and the ESPHome docs list every supported I2C sensor.
- ESPHome I2C docs
+ ESPHome I2C docs
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-secrets-yaml.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-secrets-yaml.md
index 3e1facfd3c..32db86a816 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-secrets-yaml.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-secrets-yaml.md
@@ -40,7 +40,7 @@ Treat secrets.yaml like a password manager entry:
Ready to put this into practice? The Using Secrets tutorial walks through opening secrets.yaml in the Device Builder, the `!secret` syntax, and what to store for every common case (Wi-Fi, Home Assistant API, OTA, web server auth, MQTT).
- Using Secrets tutorial
+ Using Secrets tutorial
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md
index 51a1b33076..3adec0cdc8 100644
--- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md
+++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md
@@ -117,7 +117,7 @@ You did not type any of that. The Builder wrote it when you clicked **Add**. Onc
The official YAML site has the full specification, and the ESPHome docs walk through YAML in the context of ESPHome specifically.
-YAML official site ESPHome YAML guide
+YAML official site ESPHome YAML guide
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md b/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md
index 25570a451d..048091c469 100644
--- a/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md
@@ -21,7 +21,7 @@ Connect the Breakout Module to the ESP32-C6 using one of the FPC ribbon cables t
1\. Unplug the USB-C cable from the ESP32-C6 so it is powered off.
-
+
!!! warning "Handle the FPC connectors gently"
@@ -29,11 +29,11 @@ Connect the Breakout Module to the ESP32-C6 using one of the FPC ribbon cables t
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place.
-
+
3\. Slide the ribbon cable into the Breakout Module with the blue side facing upwards then press the latch down to lock it in place.
-
+
4\. Plug the ESP32-C6 back into your computer.
@@ -41,7 +41,7 @@ Connect the Breakout Module to the ESP32-C6 using one of the FPC ribbon cables t
The Breakout Module is covered in connectors, each labeled on the board. Most of them carry the same I2C bus at different voltages, plus a 1Wire port and a GPIO header for everything else.
-
+
=== "I2C"
@@ -66,13 +66,13 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
Plug your sensor's STEMMA QT (Qwiic) cable into the port. The connector is keyed, so it only fits one way.
- 
+ 
=== "SEN6x"
Sensirion SEN6x air quality sensors, like the SEN65, come with their own ribbon cable. Plug it into the **SEN6x** port at the bottom right, latch side facing up. The connector is keyed, so it only fits one way.
- 
+ 
See the [SEN65 Air Quality Sensor](/products/ESPHome-Starter-Kit/modules/breakout-addons/sen65-air-quality-sensor.md) add-on page for the full walkthrough and what each reading means.
@@ -91,7 +91,7 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
Plug the probe's connector into the 1Wire port with the latch side facing up.
- 
+ 
See the [Temperature Probe](/products/ESPHome-Starter-Kit/modules/breakout-addons/temperature-probe.md) add-on page for the full walkthrough.
@@ -109,7 +109,7 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
The 2x6 header in the middle of the board breaks out power, the UART, and spare GPIOs for anything else you want to wire up.
- 
+ 
A few of these pins pull double duty:
@@ -119,7 +119,7 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
Connect your components to the header with standard jumper wires.
- 
+ 
??? note "Advanced: keeping 3.3V power on during sleep"
@@ -127,7 +127,7 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
If your project needs 3.3V that stays on through sleep, there's a solder jumper on the back of the board, top right, labeled **J5**. The existing bridge between the center pad and the **3vCTRL** pad looks like an H. Cut that bridge, then solder a new bridge from the center pad to the **3V** pad for always-on power.
- 
+ 
This involves cutting a trace and soldering on the board itself, so skip it unless you know you need it. Most projects are fine with the default.
diff --git a/docs/products/ESPHome-Starter-Kit/modules/battery.md b/docs/products/ESPHome-Starter-Kit/modules/battery.md
index 1fec90ca4b..48d59f106d 100644
--- a/docs/products/ESPHome-Starter-Kit/modules/battery.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/battery.md
@@ -24,7 +24,7 @@ The battery connector only fits one way, but check the wire colors before you pu
Push the connector into the battery port until it seats fully.
-
+
## Monitor the battery
diff --git a/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/sen65-air-quality-sensor.md b/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/sen65-air-quality-sensor.md
index b7befba7ae..238e4d0527 100644
--- a/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/sen65-air-quality-sensor.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/sen65-air-quality-sensor.md
@@ -14,7 +14,7 @@ It's part of Sensirion's SEN6x family. The SEN65 does not read CO₂ or formalde
The SEN65 comes with its own ribbon cable. Plug it into the **SEN6x** port at the bottom right of the [Breakout Module](/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md#pinout), latch side facing up. The connector is keyed, so it only fits one way.
-
+
The SEN6x port is on the same I2C bus as the other connectors: **SCL on GPIO0**, **SDA on GPIO1**.
@@ -48,7 +48,7 @@ The SEN65 needs three components in your device config: the accessory power swit
9. Click **Add**, then flash the device. The SEN65's readings show up alongside your other entities.
-
+
Want a single air quality number on top of the individual readings? Add the AQI component too, see [NowCast AQI](#nowcast-aqi) below.
diff --git a/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/temperature-probe.md b/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/temperature-probe.md
index 04c8f49fe2..91048a7c2e 100644
--- a/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/temperature-probe.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/breakout-addons/temperature-probe.md
@@ -21,7 +21,7 @@ Both probes read -55°C to 85°C (-67°F to 185°F) with ±0.5°C accuracy. Pick
Plug the probe's connector into the **1Wire** port at the top right of the [Breakout Module](/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md#pinout) with the latch side facing up.
-
+
The probe's data line is on **GPIO6**.
diff --git a/docs/products/ESPHome-Starter-Kit/modules/button-module.md b/docs/products/ESPHome-Starter-Kit/modules/button-module.md
index 52cab3579d..0640e0c466 100644
--- a/docs/products/ESPHome-Starter-Kit/modules/button-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/button-module.md
@@ -21,7 +21,7 @@ Connect the button module to the ESP32-C6 using one of the FPC ribbon cables tha
1\. Unplug the USB-C cable from the ESP32-C6 so it is powered off.
-
+
!!! warning "Handle the FPC connectors gently"
@@ -29,11 +29,11 @@ Connect the button module to the ESP32-C6 using one of the FPC ribbon cables tha
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place.
-
+
3\. Slide the ribbon cable into the button module with the blue side facing upwards then press the latch down to lock it in place.
-
+
4\. Plug the ESP32-C6 back into your computer.
@@ -47,7 +47,7 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
4. Search for **Button** and select the **Button Module**.
5. Click **Add**. Device Builder inserts the button's binary sensor block into your YAML.
-
+
??? note "What the button YAML does"
@@ -91,19 +91,19 @@ Flash the device so the new button entity goes live.
3. Wait for the compile and flash to finish. First builds can take a few minutes.
4. The device reboots and reconnects to your Wi-Fi on its own.
-
+
## Test the Button
With the device back online, the button entity is live on the web server. Open it in a browser on the same network and watch it react in real time.
-
+
1. In a browser, open `http:// Button Controlled LEDs
- Play a Tune
- Press to Check Climate
+ Button Controlled LEDs
+ Play a Tune
+ Press to Check Climate
--8<-- "_snippets/community-help.md"
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/modules/motion-module.md b/docs/products/ESPHome-Starter-Kit/modules/motion-module.md
index e98ebfbc5d..c1dc7ebf4a 100755
--- a/docs/products/ESPHome-Starter-Kit/modules/motion-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/motion-module.md
@@ -23,7 +23,7 @@ The PIR sensor (the small white dome on a tiny PCB) ships separately from the mo
2. Line up the **Out** name on each side as shown in the gif below.
3. Press it down firmly until the pins are fully seated.
-
+
## Attach Motion module
@@ -31,7 +31,7 @@ Connect the motion module to the ESP32-C6 using one of the FPC ribbon cables tha
1\. Unplug the USB-C cable from the ESP32-C6 so it is powered off.
-
+
!!! warning "Handle the FPC connectors gently"
@@ -39,11 +39,11 @@ Connect the motion module to the ESP32-C6 using one of the FPC ribbon cables tha
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place.
-
+
3\. Slide the ribbon cable into the motion module with the blue side facing upwards then press the latch down to lock it in place.
-
+
4\. Plug the ESP32-C6 back into your computer.
@@ -56,7 +56,7 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
3. Search for **Motion** and select the Apollo Starter Kit PIR motion component.
4. Click **Add**. Device Builder inserts the PIR's binary sensor block into your YAML.
-
+
??? note "What the Motion YAML does"
@@ -94,7 +94,7 @@ Flash the device so the new motion entity goes live.
3. Wait for the compile and flash to finish. First builds can take a few minutes.
4. The device reboots and reconnects to your Wi-Fi on its own.
-
+
## Test Motion
@@ -108,7 +108,7 @@ With the device back online, the Motion entity is live on the web server. Web server page showing the Motion binary sensor toggling between ON and OFF as motion is detected.
@@ -120,6 +120,6 @@ With the device back online, the Motion entity is live on the web server. Motion-Activated Light
+ Motion-Activated Light
--8<-- "_snippets/community-help.md"
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md b/docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md
index 87f0d986ea..42c50344a7 100755
--- a/docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/rgb-buzzer-module.md
@@ -21,7 +21,7 @@ Connect the LED & Buzzer module to the ESP32-C6 using one of the FPC ribbon cabl
1\. Unplug the USB-C cable from the ESP32-C6 so it is powered off.
-
+
!!! warning "Handle the FPC connectors gently"
@@ -29,11 +29,11 @@ Connect the LED & Buzzer module to the ESP32-C6 using one of the FPC ribbon cabl
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place.
-
+
3\. Slide the ribbon cable into the LED & buzzer module with the blue side facing upwards then press the latch down to lock it in place.
-
+
4\. Plug the ESP32-C6 back into your computer.
@@ -47,7 +47,7 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
4. Select the **RGB LED + Buzzer Module Bundle** at the top.
5. Click **Add** -> Click **Add** -> Click **Add** -> Click **Add**. Each section lets you make changes but we will leave them at defaults for now. Device Builder inserts the light, output, and rtttl blocks into your YAML.
-
+
??? note "What the LED & Buzzer Module YAML does"
@@ -107,7 +107,7 @@ Flash the device so the new RGB & Buzzer entities go live.
3. Wait for the compile and flash to finish. First builds can take a few minutes.
4. The device reboots and reconnects to your Wi-Fi on its own.
-
+
## Test the LEDs
@@ -122,7 +122,7 @@ With the device back online, the RGB LED light entity is live on the web server.
1. There's a lot you can do with a light entity. See the [Light Effects tutorial](/products/ESPHome-Starter-Kit/tutorials/light-effects.md) for advanced configurations, or the [ESPHome light strip effects documentation](https://esphome.io/components/light/#strip-animations) to go deeper.
-
+
!!! success "Your LED & Buzzer notification module is wired up!"
@@ -134,9 +134,9 @@ With the device back online, the RGB LED light entity is live on the web server.
Your notification module is ready. Drive it from any of these automations:
- Button Controlled LEDs
- Play a Tune
- Temp-Reactive LEDs
- Motion-Activated Light
+ Button Controlled LEDs
+ Play a Tune
+ Temp-Reactive LEDs
+ Motion-Activated Light
--8<-- "_snippets/community-help.md"
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md b/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md
index 63970f2d2d..909404b26c 100755
--- a/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md
@@ -22,7 +22,7 @@ Connect the Temperature and Humidity module to the ESP32-C6 using one of the FPC
1\. Unplug the USB-C cable from the ESP32-C6 so it is powered off.
-
+
!!! warning "Handle the FPC connectors gently"
@@ -30,11 +30,11 @@ Connect the Temperature and Humidity module to the ESP32-C6 using one of the FPC
2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place.
-
+
3\. Slide the ribbon cable into the temperature and humidity module with the blue side facing upwards then press the latch down to lock it in place.
-
+
4\. Plug the ESP32-C6 back into your computer.
@@ -51,7 +51,7 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
7. Toggle the **Humidity** and **Temperature** selections on.
8. Click **Add**. Device Builder inserts the AHT20F sensor block into your YAML.
-
+
??? note "What the temperature and humidity YAML does"
@@ -99,7 +99,7 @@ Flash the device so the new temperature and humidity entities go live.
3. Wait for the compile and flash to finish. First builds can take a few minutes.
4. The device reboots and reconnects to your Wi-Fi on its own.
-
+
## Test the Temp and Humidity
@@ -109,7 +109,7 @@ With the device back online, the temperature and humidity entities are live on t
2. Find the **Temperature** and **Humidity** entities in the sensor list.
3. Watch the values update on the interval you set. Cup your hand over the sensor or breathe on it, the humidity reading will respond within a few cycles.
-
+
> Web server page showing the Temperature and Humidity sensors with live readings.
@@ -121,7 +121,7 @@ With the device back online, the temperature and humidity entities are live on t
Your sensor is reporting. Now make it drive something:
- Temp-Reactive LEDs
- Press to Check Climate
+ Temp-Reactive LEDs
+ Press to Check Climate
--8<-- "_snippets/community-help.md"
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/setup/first-steps.md b/docs/products/ESPHome-Starter-Kit/setup/first-steps.md
index cf55aa211f..a10b95d790 100755
--- a/docs/products/ESPHome-Starter-Kit/setup/first-steps.md
+++ b/docs/products/ESPHome-Starter-Kit/setup/first-steps.md
@@ -33,7 +33,7 @@ ESPHome Device Builder is the app that gives you a user interface for writing, c
Think of it like telling the starter kit about what devices it has connected and how to use them!
- Learn more about ESPHome
+ Learn more about ESPHome
Pick the platform you'll be running ESPHome Device Builder on:
@@ -48,7 +48,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
If a blue **Windows protected your PC** warning appears when you open the `.exe`, click **More info → Run anyway** to continue.
- 
+ 
The first launch takes a moment while it sets itself up, then the dashboard opens in your browser at http://localhost:6052/. An ESPHome icon lands in your notification area for getting back to it later.
@@ -60,7 +60,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a [five minute walkthrough](../learning-the-basics/device-builder-tour.md), or **Maybe later**.
- 
+ 
=== "Mac"
@@ -89,7 +89,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a [five minute walkthrough](../learning-the-basics/device-builder-tour.md), or **Maybe later**.
- 
+ 
=== "Home Assistant App"
@@ -141,7 +141,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a [five minute walkthrough](../learning-the-basics/device-builder-tour.md), or **Maybe later**.
- 
+ 
#### Add a new device
@@ -149,7 +149,7 @@ With the app installed, it's time to tell it about your kit. If you took the gui
1\. Navigate back to the ESPHome Device Builder and click **Add new device** then click Create new project.
-
+
@@ -159,7 +159,7 @@ With the app installed, it's time to tell it about your kit. If you took the gui
1. Remember the name you choose. You'll use it later to reach your device's web server at `http://your-name.local` (for example, http://esphome-starter-kit.local/).
-
+
### Configure Components
@@ -177,7 +177,7 @@ The Onboard RGB LED is a small LED above the Reset button of your ESP32-C6. Usef
2. Click **Add component**.
3. Scroll to **Onboard RGB LED** and click **Add**.
-
+
### Boot Mode
@@ -189,11 +189,11 @@ The device is required to be flashed via USB using the bootloader mode the very
1\. Hold the sides of the ESP32-C6 and gently push the USB-C cable firmly into the USB-C port. Plug in the other side of the USB-C cable into your computer. Please be careful not to snap or damage the FPC ribbon cable connectors located on the sides of the device.
-
+
2\. Hold down the boot button. While still holding the boot button, press and release the reset button, then release the boot button.
-
+
3\. Your device is now in boot mode - The ESP32-C6 will now stay in bootloader mode until you flash it.
@@ -208,13 +208,13 @@ Before we continue, confirm that you installed the ESPHome Device Builder, confi
5. Wait for the software to compile and install. This usually takes two to five minutes.
6. Once it completes, click **Stop**, then press the **Reset** button on your device. Your device will reboot and it's now ready to test out!
-
+
!!! tip "Click Show details during the install to watch the compile and flash process"
It's a great way to see what's happening under the hood.
- Learn about Core Components
+ Learn about Core Components
### Test your LED
@@ -226,12 +226,12 @@ Your kit's default project includes the [**Web Server**](../learning-the-basics/
It should load your new device with the Onboard RGB LED listed. Click its toggle and the LED on your kit turns on and off.
-
+
The LED on the board, switching on and off.
-
+
- Back - Start Here Add More Modules Connect to Home Assistant
+ Back - Start Here Add More Modules Connect to Home Assistant
--8<-- "_snippets/community-help.md"
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/start-here.md b/docs/products/ESPHome-Starter-Kit/start-here.md
index 51c144ec95..c1bbae3e11 100755
--- a/docs/products/ESPHome-Starter-Kit/start-here.md
+++ b/docs/products/ESPHome-Starter-Kit/start-here.md
@@ -8,7 +8,7 @@ Welcome to the start of your ESPHome journey with the all-new **ESPHome Starter
[:material-cart: Buy the ESPHome Starter Kit](https://apolloautomation.com/products/esk-1-esphome-starter-kit){ .md-button .md-button--primary }
-
+
By the end of this wiki you'll know how to:
@@ -19,7 +19,7 @@ By the end of this wiki you'll know how to:
Your kit arrives as a single snap-apart panel that includes the ESP32-C6 along with a selection of interchangeable modules. The kit also includes three ribbon cables for connecting modules to the ESP32-C6, one more than any project uses at once so you always have a spare, plus a stand for the LED & Buzzer module.
-
+
## Snapping the panel apart
@@ -32,7 +32,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
1. Hold the panel flat on a table with one hand on the module you want to remove.
2. Gently flex the panel along the tab line until the tab snaps cleanly.
-
+
## Meet the modules
@@ -40,7 +40,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* The brain of every project you'll build with the kit. It handles Wi-Fi and Bluetooth, runs your ESPHome config, and exposes the GPIO pins the modules plug into.
-
+
---
@@ -48,7 +48,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* The starter kit's notification module, a strip of ten addressable RGB LEDs and a small piezo buzzer behind the ESPHome logo silkscreen. *Use the included stand to show it off!*
-
+
---
@@ -56,7 +56,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Detects movement in a room and a great way to get started automating your home. It comes in two parts, and the PIR sensor easily plugs into the PIR module board.
-
+
---
@@ -64,7 +64,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Premium feel button perfect to trigger automations for lights and more.
-
+
---
@@ -72,7 +72,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Extremely accurate temp and humidity sensor trustworthy enough to track a room comfort level with ease!
-
+
---
@@ -80,12 +80,12 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Each module connects to the ESP32-C6 through the FPC connector using one of the three provided cables. *Tear the brown paper bag open from one of the ends. Please DO NOT use scissors as you could accidentally cut the cables!*
-
+
## Next: bring it online
Once you've identified your modules and snapped them off the panel, the next step is to connect the ESP32-C6 to your computer and walk through your first ESPHome configuration.
- Next - First Steps
+ Next - First Steps
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
index d259103174..056d5df6c0 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
@@ -27,7 +27,7 @@ Device Builder has an **Add Component** flow that drops the proxy into your conf
3. Search for **Bluetooth Proxy** and select it.
4. Click **Add**. Device Builder inserts the proxy into your YAML.
-
+
??? note "Prefer to add it by hand? Here's the YAML"
@@ -59,7 +59,7 @@ The proxy is saved in Device Builder, but the device is still running its old so
3. Wait for the compile and flash to finish. The device reboots once the install is done.
-
+
## Verify it works
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
index e33db9d7f7..7ab6d10ac6 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
@@ -50,7 +50,7 @@ Open `secrets.yaml` in Device Builder, copy the `api_encryption_key` value, and
Want to understand what just happened under the hood? Read [the Home Assistant integration](../learning-the-basics/how-esphome-talks-to-home-assistant.md).
- Back - First Steps
+ Back - First Steps
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
index ee77db3961..c85162cc9d 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
@@ -32,7 +32,7 @@ Out of the box, your RGB module turns on, turns off, and changes color. ESPHome
6. Click **\+ Add** a second time and pick **Addressable Color Wipe**.
-
+
That gives the light two effects: a continuously cycling rainbow and a sweeping color wipe. Add as many as you like the same way, and click the **X** to the right of an effect's dropdown to drop one.
@@ -67,7 +67,7 @@ The effects are saved in Device Builder, but the device is still running its old
1. We say software because it's the friendlier word. The technically correct term is firmware: code that runs directly on the chip instead of on a computer. That's the word ESPHome's own docs use.
-
+
3\. Wait for the compile and flash to finish. The device reboots once the install is done.
@@ -75,9 +75,9 @@ The effects are saved in Device Builder, but the device is still running its old
With the device back online, open the local web page at `http://esphome-starter-kit.local/` (or whatever you named your device) in a browser on the same Wi-Fi network. Find the RGB light entity and pick **Rainbow** or **Color Wipe** from the **Effect** dropdown. The LEDs start animating right away.
-
+
-
+
If you've already followed [Connect to Home Assistant](/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md), the same **Effect** dropdown shows up on the light entity card in Home Assistant.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
index 95d5d545bd..01639ca630 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
@@ -32,7 +32,7 @@ Start on your Windows PC. This is the machine that will do the compiling.
1. **Paired senders**, just below the toggle, lists every dashboard allowed to send builds here. It stays empty until you pair one.
-
+
## Pair the Two Dashboards
@@ -56,7 +56,7 @@ On your Windows PC, open **Settings → Pairing requests**. It shows **Open** wi
3. **Pair request sent** appears with a row of emoji under **Your fingerprint**. Leave it on screen, you're about to compare it.
-
+
#### Accept It on Your PC
@@ -69,11 +69,11 @@ On your Windows PC, open **Settings → Pairing requests**. It shows **Open** wi
1. Accepting gives that dashboard code execution on your PC. Only accept a request you just sent yourself.
-
+
Back on the sending dashboard, your PC now sits under **Paired build servers** marked **Connected**. That's how you know it worked. The row reads **Pending** while it's waiting on you and flips over once you accept.
-
+
The line underneath tells you which ESPHome version the build server runs, and which one your builds will use. The two don't have to match. Device Builder installs whatever your sending dashboard is on and builds with that.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
index 0b4d65fa38..8b86f60707 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
@@ -24,7 +24,7 @@ In the ESPHome Device Builder dashboard, click the 3 dots menu in the top right
1. You'll see a YAML file with one key per line. If you followed First Steps you should already see `wifi_ssid` and `wifi_password` here.
-
+
---
@@ -66,7 +66,7 @@ The Device Builder can turn a value into a secret for you, no hand editing requi
The Device Builder moves the key into secrets.yaml and swaps the device YAML over to a `!secret` reference. You can now share your device YAML without exposing the key.
-
+
---
diff --git a/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md b/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md
index 25acdf420e..e5cf448355 100755
--- a/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md
+++ b/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md
@@ -6,7 +6,7 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
1\. Unplug your AIR-1 from power and remove the back
-
+
2\. At the bottom center there is a black connector. There is an x in the lower right corner of the connector
@@ -14,6 +14,6 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
4\. Align the connector on the back of the CO2 module with the connector on the AIR-1. Once aligned, push down so the CO2 module fully seats itself
-
+
5\. Put your AIR-1 cover on. 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.
\ No newline at end of file
diff --git a/docs/products/air1/addons/adding-co2-to-air-1.md b/docs/products/air1/addons/adding-co2-to-air-1.md
index bf82eeeee2..260ca6a9ae 100755
--- a/docs/products/air1/addons/adding-co2-to-air-1.md
+++ b/docs/products/air1/addons/adding-co2-to-air-1.md
@@ -10,34 +10,34 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
1\. Unplug your AIR-1 from power and lift the top of the case or "lid".
-
+
2\. Remove the lid completely by grabbing the lid from the other side and gently lifting upwards.
-
+
3\. Hold the PCB and orient it correctly where Apollo (the dog) is facing you in.
-
+
4\. Gently slide the pcb out by sliding it to the left as shown in the images below.
-
+
5\. Flip the PCB over and 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.
-
+
6\. Gently push the SCD40 CO2 module onto the black mezzanine connector.
-
+
7\. Gently slide the PCB back into the 3d printed case as shown below.
-
+
8\. Gently push the case back together as shown below.
-
+
9\. 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/air1/addons/adding-gpio-header-to-air-1.md b/docs/products/air1/addons/adding-gpio-header-to-air-1.md
index 8c95facd6b..df24502e58 100755
--- a/docs/products/air1/addons/adding-gpio-header-to-air-1.md
+++ b/docs/products/air1/addons/adding-gpio-header-to-air-1.md
@@ -6,35 +6,35 @@ description: Adding Optional GPIO Header to AIR-1.
1\. Unplug your AIR-1 from power and lift the top of the case or "lid".
-
+
2\. Remove the lid completely by grabbing the lid from the other side and gently lifting upwards.
-
+
3\. Hold the PCB and orient it correctly where Apollo (the dog) is facing you in.
-
+
4\. Gently slide the pcb out by sliding it to the left as shown in the images below.
-
+
5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below
-
+
6\. Match up the X on the PCB of the GPIO Header and the X on the AIR-1 PCB and then gently push the GPIO Header onto the black mezzanine connector.
-
+
7\. Flip the AIR-1 PCB over and gently slide it back into the new AIR-1 Lid which came with your GPIO Header addon! Please do not use much force, the PCB should slide in relatively smoothly, with a tiny bit of force needed. There are three channels in the plastic where the PCB slides into!
-
+
8\. Gently push the case back together as shown below.
-
+
9\. You are now done and your AIR-1 is now able to be used with the GPIO Header addon! Here is the pinout image below and here's a great wiki article showing you how to add a small led strip!
@@ -42,4 +42,4 @@ description: Adding Optional GPIO Header to AIR-1.
If you plan to use a lot of leds or your gpio project requires a lot of power then you need to use a dedicated power supply and not try to use too much power (under 350mA) from the GPIO of the device! You can power the AIR-1 via the vcc (5v) and GND pins but please do not power it via the pins AND the USB-C port, it should be one or the other.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md b/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
index 3d3ede92a3..e8e5ff2154 100755
--- a/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
+++ b/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
@@ -5,6 +5,6 @@ description: "Calibrate the AIR-1 temperature reading from its SEN55 to your roo
##### The AIR-1 uses the SEN55 for its temperature reading. Calibrating it to your environment is very similar to the MSR-1. See the link below for the temperature calibration guide.
-
+
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/air1/examples/air1-dashboard-examples.md b/docs/products/air1/examples/air1-dashboard-examples.md
index 41fe129dd2..14fe074c8c 100755
--- a/docs/products/air1/examples/air1-dashboard-examples.md
+++ b/docs/products/air1/examples/air1-dashboard-examples.md
@@ -6,7 +6,7 @@ description: AIR-1 Home Assistant Dashboard Examples
Really neat dashboard for your AIR-1 by user "keex"!
-
+
[https://community.home-assistant.io/t/apollo-air-1-dashboard/785311](https://community.home-assistant.io/t/apollo-air-1-dashboard/785311)
@@ -14,7 +14,7 @@ Really neat dashboard for your AIR-1 by user "keex"!
##### Home Assistant Sensor
-
+
```yaml
graph: line
@@ -27,7 +27,7 @@ hours_to_show: 24
#### Custom: Apexcharts Card
-
+
```yaml
type: custom:apexcharts-card
@@ -159,7 +159,7 @@ series:
##### Custom: Plotly Graph Card
-
+
```plaintext
type: custom:plotly-graph
@@ -172,7 +172,7 @@ title: Bedroom CO2
##### Home Assistant Guage
-
+
```plaintext
type: gauge
@@ -191,7 +191,7 @@ severity:
##### Home Assistant Sensor
-
+
```
graph: line
@@ -204,7 +204,7 @@ name: Basement VOC
##### Custom: Plotly Graph Card
-
+
```
type: custom:plotly-graph
@@ -217,7 +217,7 @@ title: Basement VOC
##### Home Assistant Guage
-
+
```
type: gauge
diff --git a/docs/products/air1/examples/firstof9's-apex-charts.md b/docs/products/air1/examples/firstof9's-apex-charts.md
index 2435d87fbc..81f0c53213 100755
--- a/docs/products/air1/examples/firstof9's-apex-charts.md
+++ b/docs/products/air1/examples/firstof9's-apex-charts.md
@@ -10,19 +10,19 @@ Firstof9 has created this beautiful responsive dashboard with [Apexcharts-card](
The colors will change as severity levels change for each of the sensors below.
-
+
This guide assumes you already have HACS installed. If you do not, please first [install HACS](https://hacs.xyz/docs/use/download/prerequisites/ "Install HACS").
First, you need to install apexcharts-card by going to the HACS tab and searching "apexcharts-card".
-
+
Once downloaded, it is ready to be used for dashboards!
Next, you need to edit the dashboards here.
-
+
!!! danger "WARNING YOU ARE ABOUT TO BE ABLE TO WIPE OUT ALL YOUR DASHBOARDS PROCEED WITH CAUTION."
@@ -30,21 +30,21 @@ Next, you need to edit the dashboards here.
Now choose "raw configuration editor"
-
+
Now you need to be VERY careful. You are editing all of your dashboards but we can avoid issues by scrolling to the very bottom and then copying and pasting the code seen below. (Picture below shows where we will paste the code) (Code below)
-
+
**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.
-
+
The easiest way to change all of the entity IDs in the code is by using AI (ChatGPT etc.) or by using a code editor like Visual Studio Code (VSC). In VSC you can Find (ctrl+f) the old ID and Replace (select the small arrow to toggle open the Replace box) it with your ID. Now you are ready to copy the code into the Raw configurator editor. (See code below)
VSC Find/Replace
-
+
**This is the code!**
@@ -491,14 +491,14 @@ VSC Find/Replace
Now click save in the top right and remember to not hit any buttons or make any other edits before saving!
-
+
Finally hit "done" in the top right.
-
+
Hit F5 on your keyboard or refresh your browser and then look for your new "Air Icon" as a new dashboard option and click on it!
-
+
Lastly, we do want to thank [firstof9](https://github.com/firstof9 "Thank firstof9") for creating this dashboard and sharing it.
\ No newline at end of file
diff --git a/docs/products/air1/setup/general-tips.md b/docs/products/air1/setup/general-tips.md
index 10b223ca9a..9e883b4332 100755
--- a/docs/products/air1/setup/general-tips.md
+++ b/docs/products/air1/setup/general-tips.md
@@ -152,11 +152,11 @@ The latest AIR-1 firmware keeps the SCD40 calibrated automatically. The sensor a
If your AIR-1 sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), automatic self-calibration will slowly drag the CO2 readings down. Turn off the **CO2 Auto Calibration** switch on the device page and follow the [manual calibration guide](../../general/calibrating-and-updating/co2-calibration.md) every 1 to 2 years instead.
-
+
Wisconsin Department of Health CO2 Level Chart
-
+
!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when CO2 is over 1000"
diff --git a/docs/products/air1/troubleshooting/air1-boot-mode.md b/docs/products/air1/troubleshooting/air1-boot-mode.md
index d896c384f4..9a88d2506d 100755
--- a/docs/products/air1/troubleshooting/air1-boot-mode.md
+++ b/docs/products/air1/troubleshooting/air1-boot-mode.md
@@ -12,7 +12,7 @@ description: Step by step guide for putting The AIR-1 In Boot Mode.
1\. Position the AIR-1 so that the USB-C port is facing you. On the left side of the USB-C port, locate a small opening to press the boot button (the right button).
-
+
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 AIR-1 then let go of the button.
@@ -26,6 +26,6 @@ description: Step by step guide for putting The AIR-1 In Boot Mode.
3\. Hold down the boot button, then press and release the reset button while keeping the boot button pressed. Finally, release the boot button.
-
+
4\. Continue with uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/air1/troubleshooting/air1-code.md b/docs/products/air1/troubleshooting/air1-code.md
index b764dc22dd..7c42086a17 100755
--- a/docs/products/air1/troubleshooting/air1-code.md
+++ b/docs/products/air1/troubleshooting/air1-code.md
@@ -12,29 +12,29 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. 1. Position the AIR-1 so that the USB-C port is facing you. On the left side of the USB-C port, locate a small opening to press the boot button (the right button).
-
+
2\. Navigate to our installer page and click connect under Battery Firmware Apollo AIR-1 Installer.
3\. Click the big "Connect" button.
-
+
4\. Select the open com port then click Connect.
-
+
5\. Click "Install ApolloAutomation.AIR-1".
-
+
6\. Click "INSTALL".
-
+
7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md b/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
index 30ef052e8e..6c9299ba09 100755
--- a/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
+++ b/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
@@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your AIR-
2\. Press and hold the Boot button for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/apolloodroid/getting-started.md b/docs/products/apolloodroid/getting-started.md
index cdf2fce7c4..17751d9985 100755
--- a/docs/products/apolloodroid/getting-started.md
+++ b/docs/products/apolloodroid/getting-started.md
@@ -17,13 +17,13 @@ This guide will walk you through setting up your Apollo Home Assistant hub aka t
If you'd prefer, you can go into your router and find the IP address that your Odroid received and use the IP address with port 8123 at the end such as: http://192.168.1.30:8123
-
+
-
+
4\. Click on "Create My Smart Home" and wait for the Home Assistant installer to finish.
-
+
5\. Now that you've got Home Assistant running, your Apollo Automation devices are ready to use!
diff --git a/docs/products/apolloodroid/introduction.md b/docs/products/apolloodroid/introduction.md
index 3db4919537..fdfe50b231 100755
--- a/docs/products/apolloodroid/introduction.md
+++ b/docs/products/apolloodroid/introduction.md
@@ -2,7 +2,7 @@
title: Apollo Odroid Introduction
description: The Apollo Odroid is a ready-to-use device designed to kickstart your smart home journey with ease.
---
-
+
The Apollo Odroid is a ready-to-use device designed to kickstart your smart home journey with ease. Built on the powerful ODROID-M1S platform with 8GB of RAM and 64GB of onboard eMMC storage, this unit comes pre-flashed with Home Assistant OS. This means that from the moment you unbox it, you can dive right into automating your home without any complex setup or flashing processes.
diff --git a/docs/products/breakout-boards/scd40-breakout-board/introduction.md b/docs/products/breakout-boards/scd40-breakout-board/introduction.md
index d61f4f08d0..e0ca2d5cad 100755
--- a/docs/products/breakout-boards/scd40-breakout-board/introduction.md
+++ b/docs/products/breakout-boards/scd40-breakout-board/introduction.md
@@ -2,13 +2,13 @@
title: Apollo SCD40 Breakout Board Introduction
description: Apollo SCD40 Breakout Board Introduction
---
-
+
The **SCD40 Breakout Board** is a compact PCB kit featuring the SCD40, making it easy to add CO2 monitoring to any new or existing project.
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md b/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
index 6e71912583..35601aebc6 100755
--- a/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
+++ b/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
@@ -2,13 +2,13 @@
title: Apollo SEN55 and SCD40 Breakout Board Introduction
description: Apollo SEN55 and SCD40 Breakout Board Introduction
---
-
+
The **SEN55 and SCD40 Breakout Board** is a compact PCB kit featuring the SEN55 sensor and an optional SCD40, making it easy to add high-quality air monitoring to any new or existing project.
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/btn1/examples/blueprint.md b/docs/products/btn1/examples/blueprint.md
index 4c1f76a644..d4c7c5c695 100755
--- a/docs/products/btn1/examples/blueprint.md
+++ b/docs/products/btn1/examples/blueprint.md
@@ -14,15 +14,15 @@ description: >-
2\. Click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation BTN-1 Blueprint** and click on **Select a device** then choose your **Apollo BTN-1** from the dropdown menu.
-
+
4\. For the **Single Click** event, click **Add Action**, then search for **Light: Toggle** and select it. Next, choose the entity you want to control, such as **BTN-1 Light**, and click **Save**. Name your automation something like **Apollo BTN-1 Blueprint**. You can repeat this process for **Double Click**, **Triple Click**, and **Hold** events.
-
+
!!! success "You can do this for all four buttons all in one blueprint!"
@@ -34,19 +34,19 @@ description: >-
1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**.
-
+
2\. Copy this link and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation BTN-1 Blueprint** and click on **Select a device** then choose your **Apollo BTN-1** from the dropdown menu.
-
+
3\. For the **Single Click** event, click **Add Action**, then search for **Light: Toggle** and select it. Next, choose the entity you want to control, such as **BTN-1 Light**, and click **Save**. Name your automation something like **Apollo BTN-1 Blueprint**. You can repeat this process for **Double Click**, **Triple Click**, and **Hold** events.
-
+
!!! success "You can do this for all four buttons all in one blueprint!"
diff --git a/docs/products/btn1/examples/example-automation.md b/docs/products/btn1/examples/example-automation.md
index 9db477d129..6fa1c3d9cb 100755
--- a/docs/products/btn1/examples/example-automation.md
+++ b/docs/products/btn1/examples/example-automation.md
@@ -8,11 +8,11 @@ description: Example of how to use the BTN-1 Events to create an automation in H
2\. Click on **Add trigger** then select **Entity** and then **State**. Then search for your btn-1 and select the btn-1 event. Then select the **Event Type** attribute and select **Single Click** in the box labeled **To**.
-
+
3\. Next click on **Add action** and search **Light: Toggle** and select it. Then choose your entity to turn on such as btn-1 light. Check the box next to Brightness and type in 100 then click Save and name your automation.
-
+
4\. Your automation is now live. Click the button 1 button and it should toggle whatever light you selected in the automation!
diff --git a/docs/products/btn1/setup/general-tips.md b/docs/products/btn1/setup/general-tips.md
index 8de126e9b2..ab45910745 100755
--- a/docs/products/btn1/setup/general-tips.md
+++ b/docs/products/btn1/setup/general-tips.md
@@ -8,7 +8,7 @@ description: BTN-1 General Tips
Your BTN-1 comes with two sets of 4 sticky pads or feet to stick on the bottom of the BTN-1 itself or on the optional BTN-1 Mount addon. These are great for just setting the device on your desk!
-
+
### Mounting
@@ -16,16 +16,16 @@ The BTN-1 with the stand addon allows you to mount the device using M3 screws to
###### **Under Desk**
-
+
###### Desk Mount
I used a block of wood instead of mounting it directly to my desk in this example.
-
+
###### **Magnetic Mounting**
-
+
\ No newline at end of file
diff --git a/docs/products/btn1/setup/getting-started.md b/docs/products/btn1/setup/getting-started.md
index e01ced341e..81db3961bd 100755
--- a/docs/products/btn1/setup/getting-started.md
+++ b/docs/products/btn1/setup/getting-started.md
@@ -12,19 +12,19 @@ This will guide you through adding on switches and keycaps to your BTN-1 then ad
Line up the two gold pins with the holes on your BTN-1, then press down gently. Be careful, as the pins can bend or get damaged if too much force is used.
-
+
###### Installing Keycaps
Line up the + on the keycap with the + on the top of the switch you installed. It may require a little pressure, but it should press on smoothly. Once placed, lightly tap to ensure the keycap is fully seated.
-
+
###### Flip Power Switch
Only the battery version has a power switch. If yours has one, ensure it's **turned on**. With the device on its side, flipping the switch **away from you** turns it **on**, and flipping it **toward you** turns it **off**.
-
+
### Connecting Through Hotspot
@@ -40,13 +40,13 @@ To connect through the sensor's onboard hotspot follow the below:
2\. On your phone or PC, open the WiFi settings and connect to "Apollo BTN-1 Hotspot".
-
+
3\. Once connected it should automatically open a dashboard for your sensor. If this does not automatically open the dashboard, please open your web browser and go to [http://192.168.4.1](http://192.168.4.1)
4\. Select the Wi-Fi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**".
-
+
!!! tip "Tip for Mesh Wi-Fi systems or multiple Access Points"
@@ -64,15 +64,15 @@ To connect through the sensor's onboard hotspot follow the below:
1\. Navigate to settings -> integrations then click the "**ADD**" button below your new Apollo device then click **Submit**.
-
+
2\. Once prompted, type in your Wi-Fi name and password in the two fields then click **Submit**. Click on **Close** once it finishes.
-
+
3\. Click on **Add** then click on **Submit**. Choose an area and then click **Finish**.
-
+
4\. Your device is now added to your Wi-Fi and added to the ESPHome Integration in Home Assistant. You should now be ready to setup a blueprint and start using your BTN-1!
@@ -86,7 +86,7 @@ You can add the ESPHome Device Builder app in Home Assistant to easily update yo
Make sure to fill out your Wi-Fi details in the **secrets** section by clicking on the **secrets** button.
-
+
```yaml
# Your Wi-Fi SSID and password - keep the quotes and just replace the name and password between the quotes!
@@ -96,15 +96,15 @@ wifi_password: "your-wifi-pass-here"
1\. Open the ESPHome Device Builder dashboard.
-
+
2\. Click **Show** in the top right to show your discovered devices then click on **Take Control** then click **Install**. This can take multiple minutes or longer on low-end hardware.
-
+
3\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit.
-
+
4\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below!
@@ -112,7 +112,7 @@ wifi_password: "your-wifi-pass-here"
1\. Head to the ESPHome Integration then click on **Add** then click **Submit**. When prompted click **Finish** then give it a location and click **Finish** or click **Skip and Finish**.
-
+
2\. Your device is now added to home assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device!
diff --git a/docs/products/btn1/troubleshooting/btn1-boot-mode.md b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
index 8bfb619098..58b2cd2f6b 100755
--- a/docs/products/btn1/troubleshooting/btn1-boot-mode.md
+++ b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
@@ -18,7 +18,7 @@ description: Step by step guide for putting The BTN-1 In Boot Mode.
2\. Disconnect power from your BTN-1, then hold the right (boot) button while plugging in a USB-C data cable to the BTN-1. Once connected, release the button.
-
+
4\. You are now ready to reflash your device!
@@ -28,15 +28,15 @@ description: Step by step guide for putting The BTN-1 In Boot Mode.
1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your BTN-1.
-
+
2\. With the device facing you, locate the reset (left) and boot (right) buttons.
-
+
2\. 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.
-
+
3\. You are now ready to reflash your device!
diff --git a/docs/products/btn1/troubleshooting/btn1-reflash.md b/docs/products/btn1/troubleshooting/btn1-reflash.md
index 0900ffd175..380fbf4ab0 100755
--- a/docs/products/btn1/troubleshooting/btn1-reflash.md
+++ b/docs/products/btn1/troubleshooting/btn1-reflash.md
@@ -10,27 +10,27 @@ description: Step by step guide for reflashing The BTN-1.
1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your BTN-1.
-
+
2\. With the device facing you, locate the reset (left) and boot (right) buttons.
-
+
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.
-
+
4\. Navigate to our installer page using a chromium based browser such as Chrome or Edge and click **connect** under Apollo BTN-1 Installer. Select the open com port and click **connect**.
-
+
5\. Click Install **BTN-1** then click **Install** again.
-
+
6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md b/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
index 09e50f79ee..1deb6465c7 100755
--- a/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
+++ b/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
@@ -6,11 +6,11 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your BTN-
1\. Plug the BTN-1 into power.
-
+
2\. Long press the Boot button (the button on the right) for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/btn1/troubleshooting/btn1-teardown.md b/docs/products/btn1/troubleshooting/btn1-teardown.md
index 9e6790132c..8004125a26 100755
--- a/docs/products/btn1/troubleshooting/btn1-teardown.md
+++ b/docs/products/btn1/troubleshooting/btn1-teardown.md
@@ -14,34 +14,34 @@ description: >-
1\. Flip the battery switch towards you to the off position. Users with no battery skip to step 2.
-
+
2\. With the BTN-1 USB-C port facing upwards, unplug the USB-C cable and remove the lid.
-
+
3\. Gently lift the BTN-1 green PCB out of the device at an angle so the buttons clear the case easier.
-
+
4\. Remove the 2-pin JST connector and remove the battery.
-
+
###### Reassembly
1\. Re-attach the 2-pin JST connector and place the battery writing side down with the wires on the left side of the case.
-
+
2\. Gently place the BTN-1 green PCB back in the case at an angle so the buttons will slide into cutout in the case.
-
+
3\. Line up the lid of the case with the holes for the rgb leds then gently press down to snap it into place.
-
+
4\. Flip the power switch back on.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/cast1/additional-info/esphome-device-builder.md b/docs/products/cast1/additional-info/esphome-device-builder.md
index 56e8c41789..a131cdf517 100644
--- a/docs/products/cast1/additional-info/esphome-device-builder.md
+++ b/docs/products/cast1/additional-info/esphome-device-builder.md
@@ -25,7 +25,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
If a blue **Windows protected your PC** warning appears when you open the `.exe`, click **More info → Run anyway** to continue.
- 
+ 
The first launch takes a moment while it sets itself up, then the dashboard opens in your browser at http://localhost:6052/. An ESPHome icon lands in your notification area for getting back to it later.
@@ -37,7 +37,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.
- 
+ 
=== "Mac"
@@ -64,7 +64,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.
- 
+ 
=== "Home Assistant App"
@@ -112,7 +112,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.
- 
+ 
### Take Control of Your CAST-1
@@ -122,14 +122,14 @@ Pick the platform you'll be running ESPHome Device Builder on:
2\. Click **Show** next to **Discovered** at the top, then click **Take Control** next to your CAST-1. Change the **Name** and **Friendly Name** if you'd like, or leave them, then click **Take Control** again.
-
+
3\. Click **Install** (the up arrow icon), then click **On the network** and watch it finish installing. (1)
{ .annotate }
1. This takes 5 to 10 minutes depending on how fast your device is.
-
+
4\. Once it completes, click **Stop**, then press the **Reset** button on your device. Your CAST-1 will reboot and it's now ready to test out!
diff --git a/docs/products/cast1/addons/ethernet-module.md b/docs/products/cast1/addons/ethernet-module.md
index ae638a1fa6..2ff7739a38 100644
--- a/docs/products/cast1/addons/ethernet-module.md
+++ b/docs/products/cast1/addons/ethernet-module.md
@@ -15,7 +15,7 @@ The Ethernet add-on gives your CAST-1 a wired network connection. It's a small h
1. Press evenly on both ends. If the module won't sit flat against the case, lift it off and line the pins up again rather than forcing it.
-
+
4\. Plug an Ethernet cable into the module, then plug the CAST-1 back into power.
diff --git a/docs/products/cast1/examples/wizmote-blueprint.md b/docs/products/cast1/examples/wizmote-blueprint.md
index b488125b17..7982ad3a08 100644
--- a/docs/products/cast1/examples/wizmote-blueprint.md
+++ b/docs/products/cast1/examples/wizmote-blueprint.md
@@ -37,7 +37,7 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1.
1. Pairing a different WizMote later? Use **Clear WizMote Pairing** on the device to unpair, then turn **WizMote Auto-Discovery** back on and press a button on the new remote.
-
+
!!! note "Pairing takes longer on a CAST-1 running Ethernet only"
@@ -59,4 +59,4 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1.
6\. Name your automation something like **Apollo CAST-1 WizMote** and click **Save**. Your WizMote now controls your CAST-1!
-
+
diff --git a/docs/products/cast1/introduction.md b/docs/products/cast1/introduction.md
index 386bec16a1..0ef931c60f 100644
--- a/docs/products/cast1/introduction.md
+++ b/docs/products/cast1/introduction.md
@@ -4,7 +4,7 @@ description: Documentation for CAST-1, including setup, usage, and best practice
---
# Introduction
-
+
**Make Any Speakers Smart:** Plug the CAST-1 into a 3.5mm line-in, add it to Home Assistant, and it shows up in Music Assistant as a player you can stream to.
diff --git a/docs/products/cast1/setup/getting-started.md b/docs/products/cast1/setup/getting-started.md
index 21d3044224..3f069c7236 100644
--- a/docs/products/cast1/setup/getting-started.md
+++ b/docs/products/cast1/setup/getting-started.md
@@ -13,7 +13,7 @@ Run a 3.5mm cable from the CAST-1 into the line-in on your powered speakers, rec
1. The CAST-1 has no amplifier of its own, so it needs powered speakers or an amp. If your speakers use RCA or 6.35mm inputs, use a 3.5mm-to-RCA or 3.5mm-to-6.35mm adapter cable.
-
+
### Connect to Your Network
@@ -37,7 +37,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
3\. Select the Wi-Fi network that you would like your CAST-1 to connect to and type in your Wi-Fi password, then click "**Save**".
- 
+ 
4\. Once connected, the dashboard will automatically close. You've successfully connected your CAST-1 to your Wi-Fi.
@@ -55,7 +55,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
3\. Click **Submit** again, give it an **Area**, then click **Finish**.
- 
+ 
Improv adds your CAST-1 to Home Assistant as part of setup, so skip ahead to [installing Music Assistant](#music-assistant).
@@ -63,7 +63,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
With the CAST-1 unplugged, line the Ethernet module up with the two rows of female header pins on top of the case, pin side down, and press it straight down until it sits flat.
- 
+ 
1\. Plug an Ethernet cable into the module, then plug the CAST-1 into power.
@@ -80,7 +80,7 @@ Open the ESPHome Integration, then click **Add** and **Submit**. Edit the name a
-
+
### Music Assistant
@@ -94,7 +94,7 @@ The CAST-1 streams through Apollo CAST-1 Installer.
5\. Click **Connect & Install**. In the browser popup, select **USB JTAG/serial debug unit** and click **Allow**. When the installer opens, click **Install** to flash the firmware, then click **Install** again to confirm.
-
+
6\. Once you see "**Installation complete!**" you are finished. Click **Next** then close out of the browser window.
diff --git a/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md b/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
index 660195f0e7..25f5f284c0 100644
--- a/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
+++ b/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
@@ -12,7 +12,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your CAST
2\. Long press the **boot** button (on the left) for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/dev1/introduction.md b/docs/products/dev1/introduction.md
index b7051bc977..5caacf9afe 100755
--- a/docs/products/dev1/introduction.md
+++ b/docs/products/dev1/introduction.md
@@ -17,7 +17,7 @@ The DEV-1 does NOT come pre-flashed with ESPHome or WLED and requires you to fla
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/dev2/introduction.md b/docs/products/dev2/introduction.md
index 51fa371da7..629aa001e4 100755
--- a/docs/products/dev2/introduction.md
+++ b/docs/products/dev2/introduction.md
@@ -21,7 +21,7 @@ The DEV-2 does NOT come pre-flashed with ESPHome or WLED and requires you to fla
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/general/battery-sensors/awake-ha-helper.md b/docs/products/general/battery-sensors/awake-ha-helper.md
index c2c8b481cf..9eb96920c2 100755
--- a/docs/products/general/battery-sensors/awake-ha-helper.md
+++ b/docs/products/general/battery-sensors/awake-ha-helper.md
@@ -6,29 +6,29 @@ description: How to keep your sensor awake using the Home Assistant Helper.
1\. Open your Home Assistant dashboard and go to settings then select Devices and services and select helpers in the top right. Or click here to go straight there.
-
+
-
+
2\. Select Create Helper in the bottom right.
- +
3\. Scroll down to the bottom and select Toggle. - +
4\. For name use "apollo\_ota\_mode" and choose desired icon such as "mdi:sleep-off" then click Create. - + 5\. Search "apollo\_ota\_mode" and click on the helper shown. - +
6\. Toggle the OTA mode on as shown below. - + 7\. Now when you reboot your Apollo device or when it wakes up on its wake timer, it will no longer go back to sleep. @@ -38,21 +38,21 @@ description: How to keep your sensor awake using the Home Assistant Helper. 8\. Create a new automation and select "add trigger" then select entity then select state. - + - + 9\. Type in "apollo\_ota\_mode" in the box for entity and then select "On" and finally put a 1 in the hours box under "For". This is telling home assistant if the apollo\_ota\_mode is on for one hour then this trigger will fire (trigger). - + 10\. Scroll down to "Then do" and click "Add Action" and type in "input boolean" and choose the option that says "Input Boolean: Turn off". - + 11\. Now select choose entity and select apollo\_ota\_mode as shown below. - + 12\. Now you are done! You can toggle your OTA mode on so that you can update your devices and after one hour it will automatically be turned off for you! diff --git a/docs/products/general/battery-sensors/prevent-sleep.md b/docs/products/general/battery-sensors/prevent-sleep.md index 87ec099327..b0b2fe4ab6 100755 --- a/docs/products/general/battery-sensors/prevent-sleep.md +++ b/docs/products/general/battery-sensors/prevent-sleep.md @@ -12,11 +12,11 @@ description: How to disable Prevent Sleep and allow your Apollo device to sleep! 1\. Head to the ESPHome Integrations page and click on the name of your Apollo device. - + 2\. Scroll down until you see **Prevent Sleep** and **Sleep Duration**. - + 3\. Type in the amount of minutes you want your sensor to sleep in the **Sleep Duration** box. Defaults to 5 minutes for some devices and longer for others. We recommend leaving the default values. diff --git a/docs/products/general/battery-sensors/sensor-connection-check.md b/docs/products/general/battery-sensors/sensor-connection-check.md index a5002a6e8b..4ac794027e 100755 --- a/docs/products/general/battery-sensors/sensor-connection-check.md +++ b/docs/products/general/battery-sensors/sensor-connection-check.md @@ -6,19 +6,19 @@ description: How to check if your device is connected to Wi-Fi, Home Assistant, 1\. Press the reset button and let go to restart the device
TEMP-1B reset button - + PLT-1B reset button - + 2\. Press the boot button and let go
TEMP-1B boot button - + PLT-1B boot button - + The RGB Light on your device should flash green if connected to Wi-Fi, blue if connected to Wi-Fi and Home Assistant, or yellow if no Wi-Fi or Home Assistant connection. diff --git a/docs/products/general/battery-sensors/wake-up-battery-sensor.md b/docs/products/general/battery-sensors/wake-up-battery-sensor.md index ca23452542..214ef1de38 100755 --- a/docs/products/general/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/general/battery-sensors/wake-up-battery-sensor.md @@ -8,11 +8,11 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 1: Reset button.** Press and release the reset button to restart the device. -  +  **Method 2: Boot button.** Quickly press and hold the boot button for 4-5 seconds. -  +  Button locations: [TEMP-1B boot mode](https://wiki.apolloautomation.com/products/temp1b/troubleshooting/temp1b-boot-mode/). @@ -20,11 +20,11 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 1: Reset button.** Press and release the reset button to restart the device. -  +  **Method 2: Boot button.** Quickly press and hold the boot button for 4-5 seconds. -  +  Button locations: [PLT-1B boot mode](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-boot-mode/). @@ -34,7 +34,7 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 2: Boot button.** Quickly press and hold the boot (right) button for 4-5 seconds. -  +  Button locations: [BTN-1 boot mode](https://wiki.apolloautomation.com/products/btn1/troubleshooting/btn1-boot-mode/). @@ -48,7 +48,7 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 2: Boot button.** Quickly press and hold the boot button for 4-5 seconds. -  +  Button locations: [H-1 boot mode](https://wiki.apolloautomation.com/products/h1/boot-mode/). @@ -62,7 +62,7 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 2: Boot button.** Quickly press and hold the boot (right) button for 4-5 seconds. -  +  Button locations: [H-2 boot mode](https://wiki.apolloautomation.com/products/h2/troubleshooting/boot-mode/). diff --git a/docs/products/general/calibrating-and-updating/calibrate-plt1.md b/docs/products/general/calibrating-and-updating/calibrate-plt1.md index 3d12ab542a..95cc828fc8 100644 --- a/docs/products/general/calibrating-and-updating/calibrate-plt1.md +++ b/docs/products/general/calibrating-and-updating/calibrate-plt1.md @@ -10,42 +10,42 @@ This guide will take you through calibrating your PLT-1's moisture sensor. The s 3\. Select Settings and then Devices & Services - + 4\. Select the ESPHome Integration - + 5\. Select your PLT-1 device - + 6\. Scroll down to the diagnostics section and select entity not shown. - + 7\. Select the entity "Soil ADC." - + 8\. Select the gear icon - + 9\. Select Enable - + 10\. Give the sensor a minute for this new entity to populate. 11\. Once the Soil ADC value is populated, enter it into the "Dry Voltage" entity. - + 12\. Now, place the stake/probe portion of the PLT-1 into a cup of water. Be careful not to submerge the entire sensor—only the exposed PCB below the "Apollo" label and the horizontal line can be exposed to water. 13\. Grab the "Soil ADC" value again and enter it into the "100% Water Voltage" entity. - + 14\. You can now return your PLT-1 to your plant. Congratulations, your sensor is calibrated! diff --git a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md index 19aeaebcfb..bf9a48e574 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md @@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2 1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA. - + 2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device. @@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2 If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key. - + 3\. Click on the button that says "PRESS" and then you are done. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/calibrating-and-updating/co2-calibration.md b/docs/products/general/calibrating-and-updating/co2-calibration.md index a26c9c0340..6ec5c462cf 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration.md @@ -14,7 +14,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor The SCD40 CO2 sensor has a long lifetime (over 10 years), but with automatic self-calibration turned off it needs re-calibration back to the 420 ppm baseline every 1 to 2 years. - + 1\. Bring your sensor outside and plug it in. You might need a USB battery bank if you live in an apartment or otherwise cannot get power outside of your building. @@ -22,17 +22,17 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor 3\. Click device as shown in the image below. - + 4\. Click the "Press" button next to Calibrate SCD40 to 420 ppm and you should see the CO2 readings at 420 ppm or near it. - + It might take several attempts clicking the "Press" button for it to equalize correctly. If you don't see the SCD40 reporting 400-500 ppm then click the button again. 5\. Now your CO2 sensor should be calibrated! Be sure to setup some nice cards on your dashboard so you can monitor the CO2 levels. - + !!! danger "Dangerous CO2 level considerations" @@ -40,14 +40,14 @@ It might take several attempts clicking the "Press" button for it to equalize co Note the steep decline in CO2 ppm detected due to the door and window being opened and fan turned on. - + Wisconsin Department of Health CO2 Level Chart - + !!! example "CO2 levels dropping due to HVAC Fan on a schedule" This could be improved by increasing air exchange to get below 1000 ppm for a safer environment. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/calibrating-and-updating/mmwave-videos.md b/docs/products/general/calibrating-and-updating/mmwave-videos.md index 2cb8021ec0..51073097aa 100755 --- a/docs/products/general/calibrating-and-updating/mmwave-videos.md +++ b/docs/products/general/calibrating-and-updating/mmwave-videos.md @@ -26,11 +26,11 @@ How to tune the mmWave sensor using radar engineering mode. 3\. Turn on Radar Engineering Mode (REM). - + 4\. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8. - + 5\. The gates are different distances from the sensor. @@ -38,11 +38,11 @@ How to tune the mmWave sensor using radar engineering mode. 6\. 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. - + 7\. 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. - + !!! quote "Quote from popular Youtuber Make It Work Tech" diff --git a/docs/products/general/calibrating-and-updating/updating-firmware.md b/docs/products/general/calibrating-and-updating/updating-firmware.md index 5dbb2dbb9b..9893edd0bc 100755 --- a/docs/products/general/calibrating-and-updating/updating-firmware.md +++ b/docs/products/general/calibrating-and-updating/updating-firmware.md @@ -22,7 +22,7 @@ Use this route to build the firmware yourself, or if your device has no **Firmwa 1\. In Home Assistant open the ESPHome Device Builder**.** -[](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) +[](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) !!! tip "Make sure you are running the latest version of ESPHome" @@ -30,23 +30,23 @@ Use this route to build the firmware yourself, or if your device has no **Firmwa 2\. Find the sensor you want to update and click the three dots on the far right. - + 3\. Select “**Validate**” from the list. - + 4\. Once the validation completes, click “**Install**” in the bottom right. - + 5\. Click "**Wirelessly**". - + 6\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit. - + ## If no update ever appears diff --git a/docs/products/general/introduction.md b/docs/products/general/introduction.md index 62d6ec0405..e08718771d 100755 --- a/docs/products/general/introduction.md +++ b/docs/products/general/introduction.md @@ -3,7 +3,7 @@ title: Introduction description: "Learn what Apollo Automation is all about, including our mission, our products, and how we empower smarter homes." --- - + Apollo Automation is a small startup based in Lexington, Kentucky, dedicated to creating innovative, high-quality, and affordable smart home automation hardware. Founded in 2023 by a group of friends, the company was born out of frustration with existing solutions that lacked transparency and customization options. Named after Trevor’s dog, Apollo, the team set out to build products that offer complete local control without reliance on cloud services or subscriptions! diff --git a/docs/products/general/piezo.md b/docs/products/general/piezo.md index bdb5d13b2e..f33ea64af8 100755 --- a/docs/products/general/piezo.md +++ b/docs/products/general/piezo.md @@ -18,7 +18,7 @@ This guide will walk you through using the buzzer on your Apollo Device. 4\. Input an RTTTL tone into the the string box such as one of the examples below. - + ??? example "Mario" diff --git a/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md b/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md index 7fe9ae968b..dbb9347ff7 100755 --- a/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md +++ b/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md @@ -7,13 +7,13 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 1\. Open the Esphome Device Builder. - + 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install Esphome Device Builder.") and then move on to step 3. 3\. Click "Edit" as shown below. - + 4\. Copy the code inside the codeblock below. @@ -23,18 +23,18 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 5\. Paste the code as shown below directly below the yaml you just edited above. Make sure the spaces look the same and there are no red lines under any of the code. - + 6 Click save then Install in the top right. - + 7\. Click "Wirelessly" and let it finish compiling then installing. - + 8\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. - + 9\. You are finished and your Apollo device is now able to connect to your Wi-Fi with a hidden SSID! Make sure you understand the downsides as [mentioned here](https://esphome.io/components/wifi.html "downsides of fast_connect: true").
**fast\_connect** (*Optional*, boolean): If enabled, directly connects to WiFi network without doing a full scan first. This is required for hidden networks and can significantly improve connection times. Defaults to `off`. The downside is that this option connects to the first network the ESP sees, even if that network is very far away and better ones are available. \ No newline at end of file diff --git a/docs/products/general/setup/adjusting-wifi-power.md b/docs/products/general/setup/adjusting-wifi-power.md index c559f12ced..d80ad24793 100755 --- a/docs/products/general/setup/adjusting-wifi-power.md +++ b/docs/products/general/setup/adjusting-wifi-power.md @@ -12,13 +12,13 @@ The ESP chips produce a significant amount of energy (heat) constantly using Wi- 1\. Open the ESPHome Device Builder. - + 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install Esphome Device Builder.") and then move on to step 3. 3\. Click "Edit" as shown below. - + 4\. Copy the code inside the codeblock below. @@ -28,14 +28,14 @@ The ESP chips produce a significant amount of energy (heat) constantly using Wi- 5\. Paste the code as shown below - make sure the spaces look the same and there are no red lines under any of the code. - + 6\. In the top right of the same screen click "SAVE" and then "INSTALL". - + 7\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 8\. You are finished and your Apollo device now has power\_save\_mode set to high! \ No newline at end of file diff --git a/docs/products/general/setup/bluetooth-tracking.md b/docs/products/general/setup/bluetooth-tracking.md index 695d6e3f59..3e9945ca49 100755 --- a/docs/products/general/setup/bluetooth-tracking.md +++ b/docs/products/general/setup/bluetooth-tracking.md @@ -306,22 +306,22 @@ wifi: [Apple](https://apps.apple.com/us/app/home-assistant/id1099568401) 3. Navigate to the HA settings -  +  4. Select Companion app -  +  5. Select Manage sensors -  +  6. Turn on the "BLE Transmitter" -  +  7. After opening BLE transmitter and turning it on, then scroll down to get the iBeacon unique ID -  +  8. Add it to the ESPHome yaml config for the MSR-1 -  +  9. Be sure to add "power\_save\_mode: LIGHT" to the wifi section ``` diff --git a/docs/products/general/setup/change-the-update-frequency-of-sensors.md b/docs/products/general/setup/change-the-update-frequency-of-sensors.md index b6914d08e3..4fe2046794 100755 --- a/docs/products/general/setup/change-the-update-frequency-of-sensors.md +++ b/docs/products/general/setup/change-the-update-frequency-of-sensors.md @@ -7,7 +7,7 @@ description: Tutorial for How To Change The Update Frequency Of Sensors. 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Insert the YAML for the sensor you want to edit(The example below is for our AIR-1 SEN55 sensor). @@ -26,4 +26,4 @@ sensor: 4\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/setup/getting-started.md b/docs/products/general/setup/getting-started.md index 5592df2a50..7e73e858a7 100755 --- a/docs/products/general/setup/getting-started.md +++ b/docs/products/general/setup/getting-started.md @@ -14,7 +14,7 @@ To connect through the sensor's onboard hotspot follow the below: 2\. On your phone or PC, open the WiFi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the WiFi network to show up. - + 3\. Once connected it should automatically open a dashboard for your sensor @@ -22,7 +22,7 @@ If this does not automatically open the dashboard, please open your web browser 4\. Select the WiFi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**". - + !!! tip "Tip for Mesh Wi-Fi systems or multiple Access Points" @@ -40,27 +40,27 @@ If this does not automatically open the dashboard, please open your web browser 1\. Navigate to settings -> integrations then click the "**ADD**" button below your new Apollo device! - + 2\. Click submit when it asks if you want to setup your new device and shows you the hostname of your device. - + 3\. Type in your Wi-Fi name and password in the two fields. - + 4\. Wait for it to finish, you will see the image below while it connects. - + 5\. Click the link shown in the image below (do not click close). - + 6\. When successful, you will see this image appear! - + ### Connecting To ESPHome Device Builder @@ -72,7 +72,7 @@ You can add the ESPHome Device Builder app in Home Assistant to easily update yo Make sure to fill out your Wi-Fi details in the SECRETS section by clicking on the SECRETS Image below. - + ```yaml # Your Wi-Fi SSID and password - keep the quotes and just replace the name and password between the quotes! @@ -82,23 +82,23 @@ wifi_password: "your-wifi-pass-here" 1\. Click "Show" in the top right to show your discovered devices! - + 2\. Click the ESPHome Builder in your sidebar then click "**TAKE CONTROL**" for your new Apollo Device! - + 3\. Rename your sensor here (this only renames the sensor in the ESPHome Device Compiler's Dashboard) or skip it and continue on by clicking "**TAKE CONTROL**" again as shown below. - + 4\. Click "**INSTALL**" (DO NOT click skip!) and let your device get adopted into the ESPHome Device Builder. Please have patience as this takes a few minutes to compile and then install to your new Apollo device! - + 5\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit. - + 6\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below! @@ -106,23 +106,23 @@ wifi_password: "your-wifi-pass-here" 1\. Click the "**Notifications**" Icon in the bottom left. - + 2\. Click "**Check it out**" to go to the integrations page and see the new device that was found. - + 3\. Click "**ADD**" to begin adding the device to home assistant. - + 4\. Click "**SUBMIT**" to confirm you want to add your new Apollo device to home assistant. - + 5\. Give it an area and click "**FINISH**". - + 6\. Your device is now added to home assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device! diff --git a/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md b/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md index 064c4f1896..90fefcc414 100755 --- a/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md +++ b/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md @@ -6,7 +6,7 @@ description: Tutorial for How To Add Temp And Humidity entities From the SCD40 C 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Copy the YAML below and put it at the bottom on a new line with no spaces before it. @@ -56,14 +56,14 @@ number: mode: box ``` - + 3\. In the top right of the same screen click "SAVE" and then "INSTALL". 4\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 5\. Once you are finished, you will have two new boxes inside the Home Assistant ESPHome integration device page for your device where you can fill in an offset. Give them up to 1minute to take effect! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/setup/renaming-apollo-devices.md b/docs/products/general/setup/renaming-apollo-devices.md index 3d42f9f6ac..b64456d3d5 100755 --- a/docs/products/general/setup/renaming-apollo-devices.md +++ b/docs/products/general/setup/renaming-apollo-devices.md @@ -12,7 +12,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio 2\. On the device you want to rename, click the pencil icon and enter a new name. Click **Update**, then select the name you just created. - + 3\. Click the 3 dots in the top right and select **Recreate Entity IDs** then select **Update**. @@ -20,11 +20,11 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio You will likely run into a popup showning that 2 entity IDs cannot be regenerated because they are not available. This is fine, we can manually fix these later or just ignore them as they are disabled entities and not expected to be used. - + 4\. Scroll down to the Diagnostic section and click on **\+2 disabled entities**. Select each entity and replace the old name with the new name. Make sure to replace spaces with underscores as shown in the gif below! - + ##### ESPHome Integration - Part 2 @@ -36,7 +36,7 @@ This section only changes the device name shown in the ESPHome integration page. 2\. On the device you would like to rename, click the 3 dots icon and select **Rename** and type in your new name then click **OK**. - + !!! success "The next section is not necessary unless you use ESPHome Device Builder!" @@ -48,7 +48,7 @@ This section only changes the device name shown in the ESPHome integration page. 2\. Click the 3 dots next to your new Apollo device and select **Rename hostname** then enter in the new name of your sensor and click **Rename**. This cannot have any spaces or underscores only hyphens, numbers, and lowercase letters such as "**smart-keys**". Once it finishes it will say OTA successful and you can click close to get back to the main dashboard. - + !!! null "We are now ready to rename the friendly_name to a new name such as Smart Keys" @@ -56,12 +56,12 @@ This section only changes the device name shown in the ESPHome integration page. 3\. Click **Edit** then replace the text after friendly\_name with your new name such as Smart Keys. Click Save and Install in the top right once you are done with the rename and it will save and install. Once it finishes it will say OTA successful and you can click close to get back to the main dashboard. - + 4\. Finally we should delete the device from the ESPHome Integration in home assistant and then add it back! Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then **Delete**. - + 5\. Scroll up and add the new auto-discovered device. The name should be the same Friendly name you put in the ESPHome Device builder and all of your entities should be the correct name to begin with! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/setup/switch-to-beta-branch.md b/docs/products/general/setup/switch-to-beta-branch.md index dee2b739bb..2f323c7010 100755 --- a/docs/products/general/setup/switch-to-beta-branch.md +++ b/docs/products/general/setup/switch-to-beta-branch.md @@ -14,7 +14,7 @@ description: Tutorial for How To Switching to Beta branch with ESPHome Device Bu 2\. Find the sensor you want to edit and click the "**EDIT**". - + !!! danger "This is code and requires you to follow the directions carefully." @@ -22,9 +22,9 @@ description: Tutorial for How To Switching to Beta branch with ESPHome Device Bu 3\. Look for the line that starts with packages and the line below it and put a \# in front of each line as shown in the second image below. - + - + 4\. Select your product below, copy the code, and paste it below the two lines you just commented out. @@ -159,12 +159,12 @@ description: Tutorial for How To Switching to Beta branch with ESPHome Device Bu Changing the name can cause the install to fail due to mDNS issues. If you want to rename your device, [follow this guide](https://wiki.apolloautomation.com/products/general/setup/renaming-apollo-devices/) instead. - + 5\. Click save then install in the top right and click **Wirelessly** when prompted. - + 6\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" in the bottom right to exit. - + diff --git a/docs/products/general/supported-platforms.md b/docs/products/general/supported-platforms.md index 437d8f7a5a..3e3b92d1b0 100755 --- a/docs/products/general/supported-platforms.md +++ b/docs/products/general/supported-platforms.md @@ -2,7 +2,7 @@ title: Supported Platforms description: A list of platforms compatible with Apollo Automation products. --- - + At Apollo, we are actively working on adding support for every smart home ecosystem out there. Although we are a works with Home Assistant partner and a Made for ESPHome partner, we want everyone to be able to use our sensors! Please take a look at the list of smart home ecosystems below to see the type of support we offer and the type of integration/functionality our sensors have. If you see any outdated info or have any questions/comments/concerns, please reach out to us at support@apolloautomation.com or come say hi in our [discord server](https://link.apolloautomation.com/discord)! diff --git a/docs/products/general/troubleshooting/connection-issues.md b/docs/products/general/troubleshooting/connection-issues.md index a1453d4fc1..ecdfcfd02e 100755 --- a/docs/products/general/troubleshooting/connection-issues.md +++ b/docs/products/general/troubleshooting/connection-issues.md @@ -26,7 +26,7 @@ wifi: 1\. Select the ESPHome app and then select Edit under your desired device. - + 2\. Add the code below to your devices yaml file. Then select Save and press Install. @@ -34,6 +34,6 @@ wifi: power_save_mode: none ``` - + 3\. Now your device should have a stronger connection. (This will cause the sensors internal temperature to increase.) \ No newline at end of file diff --git a/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md b/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md index 92c91c1e18..423c8d6ddc 100755 --- a/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md +++ b/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md @@ -12,14 +12,14 @@ Install the mDNS Repeater 1\. Click System -> Click Firmware -> Click Plugins -> Search for "mdns" -> Click the “+” symbol to install os-mdns-repeater. - + 2\. Confirm that the installation was successful. - + 3\. Refresh the page and then go to Services -> mDNS Repeater (if it isn't there after refreshing your screen, verify the plugin install was successful.)-> Check off "enable" -> select your networks containing Home Assistant / ESPHome IoT devices -> click save. - + Now the Home Assistant/ESPHome auto-discover issue should be fixed! \ No newline at end of file diff --git a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md index bf8404df06..2b74b4c76f 100755 --- a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md +++ b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md @@ -14,14 +14,14 @@ This will cover how to remove an Apollo device from Home Assistant 1\. Navigate to Home Assistant and open your ESPHome Device Builder app. - + 2\. On the device you would like to remove, click the three dots and select "Delete" then click Delete to confirm. - + ##### ESPHome Integration 1\. Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then "Delete". - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md index 6b6f92f6e0..1af8f41aea 100755 --- a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md +++ b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md @@ -14,23 +14,23 @@ description: Tutorial to help fix the Ubiquiti Unifi mDNS Auto Discover Issue. 2\. Select Network. - + 3\. Select Settings. - + 4\. Select Networks. - + 5\. Select the Default Network - + 6\. Check Multicast DNS - + 7\. Now the Home Assistant/ESPHome auto-discover issue should be fixed! @@ -38,22 +38,22 @@ description: Tutorial to help fix the Ubiquiti Unifi mDNS Auto Discover Issue. 1\. Open the UniFi app. - + 2\. Tap Settings/Gear Icon - + 3\. Tap Networks - + 4\. Tap Default Network - + 5\. Tap the Multicast DNS slider - + 6\. Now the Home Assistant/ESPHome auto-discover issue should be fixed! \ No newline at end of file diff --git a/docs/products/general/tutorials/change-co2-update-interval.md b/docs/products/general/tutorials/change-co2-update-interval.md index d8a0607b2f..bd8778794e 100644 --- a/docs/products/general/tutorials/change-co2-update-interval.md +++ b/docs/products/general/tutorials/change-co2-update-interval.md @@ -16,7 +16,7 @@ This guide will show you how to edit the CO2 updates down to 5 second 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Copy this code and enter it just like shown in the next step. Make sure there are no extra spaces or any other characters. It needs to look just like the example in the next step. @@ -34,6 +34,6 @@ sensor: 5\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 6\. Once that is finished your sensor should now be reporting CO2 at your new update\_interval such as 5 seconds! diff --git a/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md b/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md index 2725e6eb44..dad0437d5c 100755 --- a/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md +++ b/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md @@ -12,7 +12,7 @@ This guide will show you how to edit the lux updates down to 5 seconds. 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Copy this code and enter it just like shown in the next step. Make sure there are no extra spaces or any other characters it needs to look just like the example in the next step. @@ -26,12 +26,12 @@ sensor: 3\. Paste the code you copied in step 2 below your sensor's existing yaml as shown below. - + 4\. In the top right of the same screen click "SAVE" and then "INSTALL". 5\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 6\. Once that is finished your sensor should now be reporting at your new update\_interval such as 5 seconds! \ No newline at end of file diff --git a/docs/products/h1/boot-mode.md b/docs/products/h1/boot-mode.md index 745748819e..0bf8a92057 100755 --- a/docs/products/h1/boot-mode.md +++ b/docs/products/h1/boot-mode.md @@ -4,7 +4,7 @@ description: Step by step guide for putting The H-1 In Boot Mode. --- This will cover how to put the H-1 into boot mode. Sometimes, this is needed to upload new firmware if the device is struggling. - + ## **Boot Button Only** diff --git a/docs/products/h1/faq.md b/docs/products/h1/faq.md index be14f043d4..bccfee50b3 100755 --- a/docs/products/h1/faq.md +++ b/docs/products/h1/faq.md @@ -2,7 +2,7 @@ title: H-1 FAQ description: Frequently asked questions about the H-1. --- - + 1\. **What songs are pre-loaded on the Apollo H-1?** diff --git a/docs/products/h1/getting-started.md b/docs/products/h1/getting-started.md index de095c42d7..1afba2ea1a 100755 --- a/docs/products/h1/getting-started.md +++ b/docs/products/h1/getting-started.md @@ -6,7 +6,7 @@ description: H-1 Getting Started tutorial. Insert a rechargeable RC-CR123A (16340) battery, preferably an 850 mAh model like the one available in our store, or plug it into a power source using the USB-C port. A normal CR123A will not work! - + 2\. Turn on the Ornament: @@ -20,7 +20,7 @@ Once the ornament is awake, press the gold button (see image below) to play one * 2 Presses: Rudolph the Red-Nosed Reindeer * Long press: Let it Snow - + 4\. Add to Home Assistant (Optional): diff --git a/docs/products/h1/introduction.md b/docs/products/h1/introduction.md index 8240bd6e61..8f32bde4b3 100755 --- a/docs/products/h1/introduction.md +++ b/docs/products/h1/introduction.md @@ -2,7 +2,7 @@ title: H-1 Introduction description: H-1 Introduction. --- - + The Apollo H-1 is our special holiday ornament, designed to bring festive cheer to your home while supporting a good cause. As the first in our annual series, this ornament is crafted with both functionality and community spirit in mind. All proceeds from the H-1 go directly to a local charity in Lexington, KY, reflecting our commitment to giving back and celebrating the season alongside our community. diff --git a/docs/products/h1/reflash.md b/docs/products/h1/reflash.md index 5ecdf3c93f..c3f938a1c6 100755 --- a/docs/products/h1/reflash.md +++ b/docs/products/h1/reflash.md @@ -10,17 +10,17 @@ If your device has already been connected to Home Assistant previously please re 2. Navigate to our installer page and click connect [\*\* Install Page \*\*](https://apolloautomation.github.io/H-1/) 3. Select your Apollo device, it will show with a similar name to the one below, and click connect. If you aren't sure which device it is, you can unplug the sensor and see which disappears. - + If no device shows, click cancel and then install the recommended driver that shows on the popup. If you have installed the driver, tried different cables, and it still won't work refer [here](https://wiki.apolloautomation.com/products/h1/boot-mode/) for putting the sensor in bootloader mode and then retry step 3. 4\. Choose to install the new firmware - + 5\. Wait for the installer to finish - if you see "ERROR Logger is not configured!" that is totally expected! The logger is disabled to make more room for other components on the microcontroller. - + 6\. VERY IMPORTANT - you need to unplug your device and plug it back in to leave boot mode! @@ -29,4 +29,4 @@ If no device shows, click cancel and then install the recommended driver that sh If you encounter the below error, please complete the [Putting H-1 In Boot Mode Document](https://wiki.apolloautomation.com/products/h1/boot-mode/) and go back to step 3. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/h2/setup/getting-started.md b/docs/products/h2/setup/getting-started.md index 5d53015591..47d8767876 100755 --- a/docs/products/h2/setup/getting-started.md +++ b/docs/products/h2/setup/getting-started.md @@ -8,7 +8,7 @@ description: H-2 Getting Started tutorial. Insert a rechargeable RC-CR123A (16340) battery, preferably an 850 mAh model like the one available in our store. A normal CR123A will not work! - + **2\. Turning On the Ornament** diff --git a/docs/products/h2/troubleshooting/boot-mode.md b/docs/products/h2/troubleshooting/boot-mode.md index 9306b75fc7..fda8f96739 100755 --- a/docs/products/h2/troubleshooting/boot-mode.md +++ b/docs/products/h2/troubleshooting/boot-mode.md @@ -18,7 +18,7 @@ description: Step by step guide for putting The H-2 In Boot Mode. 3\. Push and hold the boot button (the right button). While still holding the button down, plug in a USB-C cable into the USB-C port of your H-2 then let go of the button. - + 4\. You are now ready to reflash your device! @@ -28,11 +28,11 @@ description: Step by step guide for putting The H-2 In Boot Mode. 1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your H-2. With the device facing you, locate the reset (left) and boot (right) buttons. - + 2\. 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. - + 3\. You are now ready to reflash your device! diff --git a/docs/products/h2/troubleshooting/reflash.md b/docs/products/h2/troubleshooting/reflash.md index 12c291d4ac..2bd64bb804 100755 --- a/docs/products/h2/troubleshooting/reflash.md +++ b/docs/products/h2/troubleshooting/reflash.md @@ -14,21 +14,21 @@ description: Step by step guide for re-flashing the H-2 back to factory firmware 3\. Push and hold the boot button (the right button). While still holding the button down, plug in a USB-C cable into the USB-C port of your H-2 then let go of the button. - + 4\. Navigate to our installer page using a chromium based browser such as Chrome or Edge and click **connect** under **H-2 Smart Wi-Fi Firmware** or **H-2 No Wi-Fi Firmware**. Select the open com port and click **connect**. [Click here to head to the reflashing site!](https://apolloautomation.github.io/H-2/){ .md-button .md-button--primary } - + 5\. Click Install **H-2** then click **Install** again. - + 6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/led1/examples/led-1-controlling-govee-lights.md b/docs/products/led1/examples/led-1-controlling-govee-lights.md index 91a9b8dce9..de7d20d282 100755 --- a/docs/products/led1/examples/led-1-controlling-govee-lights.md +++ b/docs/products/led1/examples/led-1-controlling-govee-lights.md @@ -4,11 +4,11 @@ description: >- How to use the Apollo LED-1 to control your Govee/3rd Party permanent outdoor LED lights! --- -This is a guide to show you how to use the Apollo LED-1 to control your Govee permanent outdoor lights fully locally and without the need of a cloud based app. +This is a guide to show you how to use the Apollo LED-1 to control your Govee permanent outdoor lights fully locally and without the need of a cloud based app. 1\. Items we will need for this project. - + \- **Apollo LED-1:** https://apolloautomation.com/products/led-1-led-controller
\- **Govee permanent lights:** https://www.amazon.com/Govee-Permanent-Lighting-Waterproof-Assistant/dp/B0DX1WPB9J?th=1
\- **Project box:** https://www.amazon.com/dp/B075DJDT99?ref=fed\_asin\_title&th=1
\- **Barrel plug connector:** https://www.amazon.com/Tugermoola-Threaded-Female-Connector-Adapter/dp/B0D9B7WR23?crid=3OR009XXFZQEF&dib=eyJ2IjoiMSJ9.e5X\_-XWXnB0xBvcSvAvZ55hSjlvd6UzliF-J4c3T3lMAnN0l1TGidk3aJVGRL0GbuOtjayYg4geWqzYV0h6n5GExQBc\_M9LNQWkhMf3dM2\_terh12U-epCikbBTwuTlUmsTSHtmptZdq9Kgidev7ANMjC\_R273mJIMboppBQDsU5LGGll-Opu4SqA7A6hrqgXGDwY38FgtprDsGkQBKJ8ssuIcnegX2gWyZvRd\_tjqk.\_DEjYBsY9V-fP-UNB8aAmKPDi\_DfQ7wuw0-mqq2PtlE&dib\_tag=se&keywords=female%2Bbarrel%2Bplug%2Bconnector%2B24v&qid=1762897344&refinements=p\_85%3A2470955011&rnid=2470954011&rps=1&sprefix=female%2Bbarrel%2Bplug%2Bconnector%2B24v%2Caps%2C101&sr=8-5&th=1
\- **White 3 wire LED connecting wire:** https://www.amazon.com/NEWNEWLIU-Waterproof-Connector-Electrical-Outdoor/dp/B0D6RBKRGQ?ie=UTF8&th=1 @@ -18,21 +18,21 @@ description: >- 2\. Remove the project box lid by unscrewing the 4 screws. - + 3\. Remove two of the rubber grommets and cut a small slit using the hobby knife to allow for the power and data connections. The two bottom grommets might be best for an outdoor setup to prevent any water from getting in. - + 4\. Connect the barrel plug to the WAGO connector. It is the large white compnent on the bottom left of the board below the USB-C port. Connect the RED (+) wire to the top terminal and the BLACK (-) wire to the bottom terminal. You can use the tweezers to depress the top of the WAGO connector, insert the wire, and then release to lock it in place. - + 5\. Remove the cable sheathing of the 3 pin LED connector using the hobby knife. Be careful when cutting, because the cable can roll. - + - + 6\. diff --git a/docs/products/led1/introduction.md b/docs/products/led1/introduction.md index c6632eb5bb..6fc998d72d 100755 --- a/docs/products/led1/introduction.md +++ b/docs/products/led1/introduction.md @@ -4,7 +4,7 @@ description: Documentation for LED-1, including setup, usage, and best practices --- # Introduction - + The Apollo LED-1 is a compact, versatile LED Controller for Home Assistant. Fully open-source and expandable, the LED-1 offers seamless integration with Home Assistant using the WLED Integration, making it ideal for automating lighting. Access to support and customization resources is available via our Discord and GitHub. diff --git a/docs/products/led1/setup/getting-started-led1.md b/docs/products/led1/setup/getting-started-led1.md index 373a35bcb5..259d113051 100755 --- a/docs/products/led1/setup/getting-started-led1.md +++ b/docs/products/led1/setup/getting-started-led1.md @@ -48,7 +48,7 @@ The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V 1\. Grab a male JST-SM 3 pin connector such as the extra included with your led strips and carefully note the red wire for positive, the green for data, and the white for ground. - + 2\. Inspect the LED-1 and look for the two Wago connectors labeled "Output 1" and "Output 2". Insert the red power wire into the far left terminal of output 1 then the green wire into the middle terminal of Output 1 then the white wire into the third terminal for Output 1. @@ -60,7 +60,7 @@ Your device is now ready to connect to your Wi-Fi and begin controlling via Home 1\. Plug your power supply or usb-c power in and the LED-1 device will boot within a couple seconds. Head to the available Wi-Fi networks on your phone and select WLED-AP. It should pop up saying "Welcome to WLED!". If this popup does not occur, please open a web browser and navigate to http://4.3.2.1/ and you should be prompted with the same image seen below. - + ### Join to Home Assistant diff --git a/docs/products/led1/setup/led1-replace-fuse.md b/docs/products/led1/setup/led1-replace-fuse.md index 7cec67a8e6..63f38fe332 100755 --- a/docs/products/led1/setup/led1-replace-fuse.md +++ b/docs/products/led1/setup/led1-replace-fuse.md @@ -6,39 +6,39 @@ description: Tutorial showing how to replace the 10 A Fuse on the LED-1. 1\. Gently pry open the lid - this can be a tight fit so you will want to use a small tool not your fingernail. Remove the lid and set aside. - + 2\. Gently lift the LED-1 PCB out of the case - be careful not use a lot of force this could break components - + 3\. Flip the LED-1 PCB over and locate the replaceable fuse. - + 4\. Gently remove the fuse using tweezers. - + 5\. Orient the new fuse with the writing facing up then place it inside the fuse bay. - + 6\. Gently push down on the fuse to make sure it is fully seated. - + 7\. Flip PCB over and angle it the same way you disassembled and rest the side of the pcb on the "shelf" as shown in the image below. - + 8\. Align the holes on the case so they line up with the Wago connectors. - + 9\. Press down on the case lid to secure it to the bottom of the case. - + 10\. You're all done - enjoy your LED-1! diff --git a/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md b/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md index ddbe4ec666..ea2291c9aa 100755 --- a/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md +++ b/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md @@ -18,7 +18,7 @@ description: Step by step guide for finding the IP address and the hostname of y 3\. Your LED-1 should be detected automatically. Select it, then click the **Config** tab in the top right corner. - + !!! danger "WARNING ~ DO NOT UPDATE IT ~ WARNING" @@ -26,10 +26,10 @@ description: Step by step guide for finding the IP address and the hostname of y 4\. Select **WiFi Setup** and at the bottom you will see a box with .local at the end. The letters inside of the box are your hostname and the IP is directly below it. You can change the hostname to whatever you like (using letters, numbers, and dashes only). Click Save and Connect when done. - + 5\. You can now access your device from a browser at http://the-ip-address-here or http://the-hostname-you-entered.local 6\. Edit the User Interface settings section under the **Server description** with a friendly name that is shown for your device! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/led1/troubleshooting/led1-reflash.md b/docs/products/led1/troubleshooting/led1-reflash.md index cab11c4a05..b79ed21fe5 100755 --- a/docs/products/led1/troubleshooting/led1-reflash.md +++ b/docs/products/led1/troubleshooting/led1-reflash.md @@ -16,15 +16,15 @@ description: Step by step guide for re-flashing the LED-1 back to factory firmwa 5\. Click the **Serial Port** dropdown and choose the available COM port.. - + 6\. Browse to the firmware file from Step 3 and select it. - + 7\. Click **Flash ESP** and wait for the process to complete. Once it's done, it will appear as shown in the image below. - + 8\. The device is still in **boot mode** and needs to be power cycled. To reboot it, either unplug the power cable or press the **reset button** on the back of the device (the button on the right). diff --git a/docs/products/m1/addons/adding-microphone-to-m-1.md b/docs/products/m1/addons/adding-microphone-to-m-1.md index c001a160a7..825008eb90 100755 --- a/docs/products/m1/addons/adding-microphone-to-m-1.md +++ b/docs/products/m1/addons/adding-microphone-to-m-1.md @@ -12,7 +12,7 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th 2\. Insert the microphone addon as shown in the image below. Make sure the Microphone image is facing to the right side and the GND pin is on the bottom right! - + ###### Turn It On @@ -22,7 +22,7 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th If nothing reacts, confirm the microphone board is seated all the way into its connector, then click **Config**, then **Usermods**, and find **AudioReactive**. These are the settings your M-1 ships with, so use them to check nothing has been changed. -  +  === "WLED-MM" @@ -30,10 +30,10 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th 4\. Select **10 digitalmic** for Pin I2s SD, select **12 digitalmic A5** for Pin I2S WS, and select **11 digitalmic** for Pin I2S SCK and click **Save**. -  +  5\. Scroll to the bottom of the **AudioReactive** settings and set the **Mode** to **Off** and click **Save**. -  +  Then pick an effect with a musical note beside it and make some noise. diff --git a/docs/products/m1/addons/wizmote-remote.md b/docs/products/m1/addons/wizmote-remote.md index 5d08602330..a88be44d48 100644 --- a/docs/products/m1/addons/wizmote-remote.md +++ b/docs/products/m1/addons/wizmote-remote.md @@ -28,7 +28,7 @@ The M-1 has no IR receiver, but it does take a Giphy is an easy place to start, and the dancing cat below works as a test. - + Getting it onto the matrix depends on your firmware. WLED converts and resizes on the device, WLED-MM needs an external tool first. @@ -27,15 +27,15 @@ Getting it onto the matrix depends on your firmware. WLED converts and resizes o 2\. Head to ezgif.com and click **Resize** then click Browse and choose your gif then click Upload! -  +  3\. Set the **Width** to **64** and the **Height** to **64** then click **Resize image** then scroll down to the **Resized Image:** section and click the **Save** icon. -  +  4\. Rename the gif to something simple such as cat-dance. We will need to input the name as-is in a future step so renaming it to a simple name is best! -  +  5\. Open a web browser and navigate to `http://` or `http://.local`.
@@ -45,23 +45,23 @@ Getting it onto the matrix depends on your firmware. WLED converts and resizes o
6\. Click **Config**, then scroll down and click **File System** then click **Browse** and select the resized and renamed gif we just created then click **Save**.
- 
+ 
7\. Click the back button on your browser and navigate back to the main page of the M-1 WLED interface. Click in the search bar and type in **image** and select it.
- 
+ 
8\. Click the **arrow** next to Segment 0 and then click the pencil icon to edit the name. Type in the name exactly as you did in step 4 above such as cat-dance.gif
- 
+ 
9\. Click on **\+ Preset** and write in any name you want such as Cat Dance then click **Save**.
- 
+ 
10\. To have the M-1 boot straight into this gif, head to **Config** then **LED Preferences** and scroll down until you see **Apply Preset** and put in your preset number for the effect you just made. If this is your first one then put in 1 and then click **Save**.
- 
+ 
!!! warning "Use a browser, not the WLED phone app"
diff --git a/docs/products/m1/examples/pixel-forge.md b/docs/products/m1/examples/pixel-forge.md
index beeb4bf0e8..8a5cc4bb0a 100644
--- a/docs/products/m1/examples/pixel-forge.md
+++ b/docs/products/m1/examples/pixel-forge.md
@@ -12,7 +12,7 @@ Pixel Forge ships inside WLED and runs on the M-1 itself. It converts images to
Open it from the icon below the color picker in the WLED interface, or go straight to `http:///pixelforge.htm`.
-
+
Pixel Forge has three of its own tabs: **Image Tool**, **Scrolling Text**, and **Other Tools**.
@@ -35,7 +35,7 @@ Turns any image into a GIF the matrix can play.
1. Pixel Forge shows how much filesystem space is left as you go, which matters because the M-1 stores these images on the device.
-
+
## Scrolling Text
@@ -47,7 +47,7 @@ Choose your segment under **Target Segment**, type into **Text to show**, and cl
The useful part is **Available Tokens**. Insert date, time, or temperature and the text keeps itself current instead of showing a fixed string. For values that come from elsewhere in your house, [push them from Home Assistant over the JSON API](/products/m1/examples/share-data-from-home-assistant.md) instead.
-
+
## Other Tools
@@ -57,6 +57,6 @@ Downloads extra utilities onto the M-1. Whatever you download stays there until
Pick your **Target Segment** and canvas size along the top. The color wheel and brush tools run down the left side, with **Size** and **Hard** sliders for the brush, and undo and redo above the canvas. When you are happy, type a **Name** and choose **Save as Preset** or **Save as GIF**.
-
+
On WLED-MM the equivalent workflow is [resizing a GIF externally and uploading it](/products/m1/examples/add-gifs-to-wled.md).
diff --git a/docs/products/m1/examples/scrolling-text.md b/docs/products/m1/examples/scrolling-text.md
index b35a71cac2..31ac283b45 100755
--- a/docs/products/m1/examples/scrolling-text.md
+++ b/docs/products/m1/examples/scrolling-text.md
@@ -18,23 +18,23 @@ description: Step by step guide to adding a WLED Preset for custom scrolling tex
1\. Open a web browser and navigate to `http://` or `http://.local`.
-
+
2\. Click the search box under **Effect mode**, type **"Scrolling Text"**, and select it from the list.
-
+
3\. Once selected, your matrix will show the current date in orange text.
-
+
4\. Look on the right side of the screen and click the pencil icon beside "Segment 0".
-
+
5\. Type in anything you want to scroll on the M-1 such as "Apollo Rocks!". Click on the Check button when you're done and it will update the M-1 LED Matrix with your new text. WLED caps this at 64 characters, and WLED-MM at 32.
-
+
!!! example "Edit settings to fully customize your M-1 with Scrolling Text!"
@@ -46,18 +46,18 @@ description: Step by step guide to adding a WLED Preset for custom scrolling tex
4\. **Font size**: Size of the font. 222 looks good!
-
+
6\. To customize the text's Color, Background Color, and Gradient, just click the Fx, Bg, and Gr circles and choose your colors using the color picker!
-
+
7\. Click on + Preset and write in a name for your new preset such as Apollo Rocks! then click Save.
-
+
8\. Here's what your finished product looks like!
-
+
Want four lines at once instead of one? Split the display first with [Segments](/products/m1/setup/m1-segments.md), then set text on each one. To drive the text from your house rather than typing it, see [Share Data From Home Assistant](/products/m1/examples/share-data-from-home-assistant.md).
diff --git a/docs/products/m1/examples/sendspin.md b/docs/products/m1/examples/sendspin.md
index 557441e531..c30e28dde8 100644
--- a/docs/products/m1/examples/sendspin.md
+++ b/docs/products/m1/examples/sendspin.md
@@ -20,7 +20,7 @@ description: Use the M-1 with SendSpin audio visualizers
2\. Head to the Music Assistant dashboard and select one of your media players. Then click the players icon then click the players icon again and check off your Apollo M-1 LED Matrix.
-
+
That is it. Play something and the matrix picks up the album art and the track title on its own, switching over every time the song changes.
diff --git a/docs/products/m1/examples/share-data-from-home-assistant.md b/docs/products/m1/examples/share-data-from-home-assistant.md
index df2aec1a16..24b1711492 100755
--- a/docs/products/m1/examples/share-data-from-home-assistant.md
+++ b/docs/products/m1/examples/share-data-from-home-assistant.md
@@ -20,7 +20,7 @@ Each line is capped at **64 characters** on WLED and **32** on WLED-MM, which is
1\. Install **Studio Code Server** from the App Store in Home Assistant. Click **Open Web UI** and navigate to your `configuration.yaml`.
-
+
!!! danger "This file is used by Home Assistant and must be carefully edited."
@@ -32,25 +32,25 @@ Each line is capped at **64 characters** on WLED and **32** on WLED-MM, which is
3\. Back in `configuration.yaml`, paste the generated YAML on a new line at the bottom of the file and save.
-
+
4\. Open **Developer Tools** and run **Check Configuration**. A green response means you are clear to continue. Then reload your new command from the **YAML** tab by clicking **RESTful Commands**, or restart Home Assistant. Until you do, the command will not show up in the next step.
5\. Still in **Developer Tools**, scroll down to **Restful Command**, click **Actions** at the top, type "matrix", select the command you just created, and click **Perform Action**. Your text should appear on the matrix straight away.
-
+
6\. Create an **Automation** with a time pattern trigger that fires every minute.
-
+
7\. Add an action, type *matrix*, and pick **RESTful command: matrix\_all\_segments**. Save and name the automation. The matrix now refreshes every minute.
-
+
Here is the finished board on a two panel setup, four segments each pulling a different entity.
-
+
###### Tuning It
diff --git a/docs/products/m1/setup/getting-started-m1-esphome.md b/docs/products/m1/setup/getting-started-m1-esphome.md
index fee7c0d367..7932e1157c 100644
--- a/docs/products/m1/setup/getting-started-m1-esphome.md
+++ b/docs/products/m1/setup/getting-started-m1-esphome.md
@@ -14,7 +14,7 @@ This guide walks you through replacing the stock WLED firmware with [hub75-studi
Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damage in shipping. Gently attach the controller to the back of the M-1 LED Matrix panel as shown in the GIF below.
-
+
### Flash the firmware
@@ -26,13 +26,13 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag
2\. Pick the **Rev6** firmware, click **Connect**, select the M-1's COM port, and follow the installer prompts to flash.
-
+
3\. Confirm the M-1 BIOS screen
Once the firmware finishes installing, the panel displays the **M-1 BIOS** splash showing the CPU, RAM, and the last 6 characters of the controller's MAC address. Seeing this screen confirms the firmware installed successfully.
-
+
### Connect to Wi-Fi
@@ -40,11 +40,11 @@ Once the firmware finishes installing, the panel displays the **M-1 BIOS** splas
2\. The captive portal opens automatically. Either pick your home network from the scanned list and enter the password, or scroll down and type your SSID and password manually.
-
+
3\. Tap **Save**. The M-1 reboots and joins your home network. Once you see the screen with the clock move on to the next section to join to Home Assistant via the ESPHome integration!
-
+
### Join to Home Assistant
@@ -56,7 +56,7 @@ Your device should be auto-discovered by Home Assistant using the ESPHome Integr
Head to the Integrations page in Home Assistant and accept the discovery prompt for your M-1.
-
+
### Optional Features
@@ -72,11 +72,11 @@ Head to the settings -> Apps -> Click Install App -> 3 dots -> click repositories -> click Add -> paste in https://github.com/stuartparmenter/homeassistant-addons
-
+
2\. Click the back button then search Media Proxy and click on it. Click Install and let it install.
-
+
3\. Check off Watchdog and Auto Update then click Start
-
+
4\. To test that it's working, head to the ESPHome integration page then select your M-1 device from the list. Copy this url and paste it into the Media Source box. It should automatically start playing the gif!
-
+
-
+
[Click here to learn what all you can do with the Media Proxy!](https://wiki.apolloautomation.com/products/m1/examples/media-proxy/){ .md-button .md-button--primary }
@@ -130,11 +130,11 @@ The M-1 ESPHome firmware has built-in support for the http://4.3.2.1/ or http://wled.me and you should be prompted with the same image seen below.
- 
+ 
2\. Tap on **WI-FI Settings** then input your Wi-Fi SSID where it shows **Your\_Network** and input your Wi-Fi password directly below it and then click **Save and Connect**.
@@ -82,11 +82,11 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag
1\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **1** then uncheck the "enable automatic brightness limiter and click **Save**. Make sure to select **Hub75Matrix** is set to **64x64**.
- 
+ 
2\. Click on **Config**, then **2D Configuration**. Select **2D Matrix**, click the circle next to **Basic**, change the **Panel dimensions (WxH)** to **64 x 64** and click **Save**.
- 
+ 
### Join to Home Assistant
@@ -96,11 +96,11 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag
- 
+ 
2\. From this page you can control your M-1 in Home Assistant. Change the color, pick effects, run presets, and more.
- 
+ 
=== "WLED-MM"
@@ -108,23 +108,23 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag
- 
+ 
2\. Click **Add**, then **Submit**.
- 
+ 
3\. Give it a name and a location, then click **Skip** and **Finish**.
- 
+ 
4\. Open the WLED integration page and click your M-1.
- 
+ 
5\. From here you can change the color, pick effects, run presets, and more.
- 
+ 
#### What Next
diff --git a/docs/products/m1/setup/m1-matrix-settings.md b/docs/products/m1/setup/m1-matrix-settings.md
index 9d2d54248c..06ba9d6954 100755
--- a/docs/products/m1/setup/m1-matrix-settings.md
+++ b/docs/products/m1/setup/m1-matrix-settings.md
@@ -11,7 +11,7 @@ These are the settings that make the HUB75 panel display correctly. You need the
Click on **Config**, then **User Interface**. In the **Server description** field, enter the name you want your M-1 device to display as in the WLED interface, such as **Apollo LED Matrix**. It ships as **Apollo M-1**, so this is only worth changing if you want something else.
-
+
###### Hostname
@@ -75,7 +75,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
Click on **Config**, then **LED Preferences**. Select **Hub75Matrix 64x64** and set **Chain Length** to **1** then uncheck the "enable automatic brightness limiter and click **Save**.
- 
+ 
###### 2D Settings
@@ -91,7 +91,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
Click on **Config**, then **2D Configuration**. Select **2D Matrix**, click the circle next to **Basic**, change the **Panel dimensions (WxH)** to **64 x 64** and click **Save**.
- 
+ 
###### AudioReactive Settings
@@ -111,10 +111,10 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
For the pins, select **10 digitalmic** for Pin I2s SD, select **12 digitalmic A5** for Pin I2S WS, and select **11 digitalmic** for Pin I2S SCK and click **Save**.
- 
+ 
Scroll to the bottom of the **AudioReactive** settings and set the **Mode** to **Off** and click **Save**.
- 
+ 
diff --git a/docs/products/m1/setup/m1-multiple-panels.md b/docs/products/m1/setup/m1-multiple-panels.md
index 9a4009d491..d4d133d0dc 100755
--- a/docs/products/m1/setup/m1-multiple-panels.md
+++ b/docs/products/m1/setup/m1-multiple-panels.md
@@ -22,43 +22,43 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
1\. Set both of your M-1 panels face down - the M-1 controller panel should be on the far left. Start by connecting the data cable (ribbon cable) to the "JOUT" port on the far left panel into the "JIN" port on the second panel.
- 
+ 
2\. Gently press the Matrix Power Module over the 4 pin header on the second panel as shown below. Make sure the USB-C port is facing to the right!
- 
+ 
3\. Plug in the USB-C cable into the M-1 LED Controller and the second Panel.
- 
+ 
=== "Three Panels"
1\. Set all three of your M-1 panels face down - the M-1 controller panel should be on the far left. Start by connecting the data cable (ribbon cable) to the "JOUT" port on the far left panel into the "JIN" port on the second panel. Repeat for connecting the third panel.
- 
+ 
2\. Gently press the Matrix Power Module over the 4 pin header on the second panel as shown below. Make sure the USB-C port is facing to the right! Repeat for connecting the third panel.
- 
+ 
3\. Plug in the USB-C cable into the M-1 LED Controller, the second panel power module, and the third panel power module.
- 
+ 
=== "Four Panels"
1\. Set all four of your M-1 panels face down - the M-1 controller panel should be on the far left. Start by connecting the data cable (ribbon cable) to the "JOUT" port on the far left panel into the "JIN" port on the second panel. Repeat for connecting the third and fourth panel.
- 
+ 
2\. Gently press the Matrix Power Module over the 4 pin header on the second panel as shown below. Make sure the USB-C port is facing to the right! Repeat for connecting the third and fourth panels.
- 
+ 
3\. Plug in the USB-C cable into the M-1 LED Controller and all three additional panels via the power module USB-C port.
- 
+ 
=== "2x2 Grid"
@@ -74,7 +74,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
3\. Press a Matrix Power Module onto each of the other three panels and give each one its own USB-C feed.
- 
+ 
A 3D printable wall mount system is available on Printables.
@@ -84,7 +84,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
Click **Config**, then **LED Preferences**. Set **Type** to **HUB75 (Half Scan)** and **Panel (width x height)** to **64 x 64**, leave **Reversed** unchecked, then fill in the rest from your layout and click **Save**.
- 
+ 
**rows x cols** means what it says. The first box is how many panels **down**, the second is how many **across**, so a row of four panels is **1** then **4**.
@@ -102,7 +102,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
1. Set it to four panels here and your content repeats on every panel instead of spanning them.
- 
+ 
Set **Dimensions (WxH)** to the combined size of your layout. This field is width first, unlike **rows x cols** above. (1)
{ .annotate }
@@ -126,17 +126,17 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
2\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **2** then **Save**.
- 
+ 
3\. Click on **Config**, then **2D Configuration** and change the **Panel dimensions (WxH)** to **128 x 64** and click **Save**.
Leave **Horizontal panels** and **Vertical panels** at **1**. The combined size goes in the panel dimensions, not the panel counts. **Matrix Dimensions** below should confirm your new total.
- 
+ 
4\. Reboot WLED before proceeding. Tap **Info** at the top, scroll down, and select **Reboot WLED**. When prompted, tap again to confirm the reboot.
- 
+ 
=== "Three Panels"
@@ -144,17 +144,17 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
2\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **3** then **Save**.
- 
+ 
3\. Click on **Config**, then **2D Configuration** and change the **Panel dimensions (WxH)** to **192 x 64** and click **Save**.
Leave **Horizontal panels** and **Vertical panels** at **1**. The combined size goes in the panel dimensions, not the panel counts. **Matrix Dimensions** below should confirm your new total.
- 
+ 
4\. Reboot WLED before proceeding. Tap **Info** at the top, scroll down, and select **Reboot WLED**. When prompted, tap again to confirm the reboot.
- 
+ 
=== "Four Panels"
@@ -162,17 +162,17 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
2\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **4** then **Save**.
- 
+ 
3\. Click on **Config**, then **2D Configuration** and change the **Panel dimensions (WxH)** to **256 x 64** and click **Save**.
Leave **Horizontal panels** and **Vertical panels** at **1**. The combined size goes in the panel dimensions, not the panel counts. **Matrix Dimensions** below should confirm your new total.
- 
+ 
4\. Reboot WLED before proceeding. Tap **Info** at the top, scroll down, and select **Reboot WLED**. When prompted, tap again to confirm the reboot.
- 
+ 
###### Segment Setup
@@ -192,27 +192,27 @@ If you grew an existing setup rather than starting fresh, the default segment ke
2\. Since we are using two panels, we will begin by editing Segment 0 and setting the Stop X to "128" and the Stop Y to "16"
- 
+ 
3\. Click on Add segment, give it a name (such as Segment 1) then set the Start Y to "16" and the Stop Y to "32".
- 
+ 
4\. Click on Add segment, give it a name (such as Segment 2) then set the Start Y to "32" and the Stop Y to "48".
- 
+ 
5\. Click on Add segment, give it a name (such as Segment 3) then set the Start Y to "48" and the Stop Y to "64".
- 
+ 
6\. You should see four equal segments 0-3 at the top of the screen.
- 
+ 
7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want!
- 
+ 
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -220,7 +220,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
8\. Save your segments by creating a new preset. Click on the + Preset button and typing in a name then clicking Save at the bottom.
- 
+ 
=== "Three Panels"
@@ -228,27 +228,27 @@ If you grew an existing setup rather than starting fresh, the default segment ke
2\. Since we are using three panels, we will begin by editing Segment 0 and setting the Stop X to "192" and the Stop Y to "16".
- 
+ 
3\. Click on Add segment, give it a name (such as Segment 1) then set the Start Y to "16" and the Stop Y to "32".
- 
+ 
4\. Click on Add segment, give it a name (such as Segment 2) then set the Start Y to "32" and the Stop Y to "48".
- 
+ 
5\. Click on Add segment, give it a name (such as Segment 3) then set the Start Y to "48" and the Stop Y to "64".
- 
+ 
6\. You should see four equal segments 0-3 at the top of the screen.
- 
+ 
7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want! 32 Character maximum limit in WLED.
- 
+ 
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -256,7 +256,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
8\. Save your segments by creating a new preset. Click on the + Preset button and typing in a name then clicking Save at the bottom.
- 
+ 
=== "Four Panels"
@@ -264,27 +264,27 @@ If you grew an existing setup rather than starting fresh, the default segment ke
2\. Since we are using four panels, we will begin by editing Segment 0 and setting the Stop X to "256" and the Stop Y to "16".
- 
+ 
3\. Click on Add segment, give it a name (such as Segment 1) then set the Start Y to "16" and the Stop Y to "32".
- 
+ 
4\. Click on Add segment, give it a name (such as Segment 2) then set the Start Y to "32" and the Stop Y to "48".
- 
+ 
5\. Click on Add segment, give it a name (such as Segment 3) then set the Start Y to "48" and the Stop Y to "64".
- 
+ 
6\. You should see four equal segments 0-3 at the top of the screen.
- 
+ 
7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want! 32 Character maximum limit in WLED.
- 
+ 
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -292,7 +292,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
8\. Save your segments by creating a new preset. Click on the + Preset button and typing in a name then clicking Save at the bottom.
- 
+ 
=== "2x2 Grid"
diff --git a/docs/products/m1/setup/m1-segments.md b/docs/products/m1/setup/m1-segments.md
index 56baa4d17f..6acf89da20 100755
--- a/docs/products/m1/setup/m1-segments.md
+++ b/docs/products/m1/setup/m1-segments.md
@@ -18,27 +18,27 @@ Segments work the same on WLED and WLED-MM. The steps below split a single 64x64
2\. Since we are only using *one panel*, we will begin by editing **Segment 0** and setting the **Stop Y** to "16".
-
+
3\. Click on Add segment, give it a name such as **Segment 1** then set the **Start Y** to "16" and the **Stop Y** to "32".
-
+
4\. Click on Add segment, give it a name such as Segment 2 then set the **Start Y** to "32" and the **Stop Y** to "48".
-
+
5\. Click on Add segment, give it a name such as Segment 3 then set the **Start Y** to "48" and the **Stop Y** to "64".
-
+
6\. You should see four equal segments 0-3 at the top of the screen.
-
+
7\. Test it by changing the effect to **Scrolling Text** and editing the name of each segment to be any text you want!
-
+
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -46,4 +46,4 @@ Segments work the same on WLED and WLED-MM. The steps below split a single 64x64
8\. Save your segments by creating a new preset. Click on the **\+ Preset** button and typing in a name then clicking **Save** at the bottom.
-
+
diff --git a/docs/products/m1/setup/use-without-wifi.md b/docs/products/m1/setup/use-without-wifi.md
index 60534b9c80..691938d332 100644
--- a/docs/products/m1/setup/use-without-wifi.md
+++ b/docs/products/m1/setup/use-without-wifi.md
@@ -10,7 +10,7 @@ The M-1 does not need a Wi-Fi network. Out of the box it makes its own, and the
Plug the M-1 in. The Apollo dog appears for a few seconds, then the panel shows a setup card and keeps showing it until the device is set up. The card has the steps on it along with a QR code.
-
+
1\. On your phone or laptop, open the Wi-Fi list and join the open network named **Apollo M-1**. There is no password out of the box, though you should [set one](#put-a-password-on-the-hotspot) once you are up and running. (1)
{ .annotate }
diff --git a/docs/products/m1/troubleshooting/m1-boot-mode.md b/docs/products/m1/troubleshooting/m1-boot-mode.md
index 00da22d549..2e2a564f41 100755
--- a/docs/products/m1/troubleshooting/m1-boot-mode.md
+++ b/docs/products/m1/troubleshooting/m1-boot-mode.md
@@ -12,7 +12,7 @@ description: Step by step guide for putting The M-1 In Boot Mode.
2\. Push and hold the boot button (the left button). While still holding the button down, plug in a USB-C cable into the USB-C port of your M-1 LED Matrix then let go of the button.
-
+
3\. You are now ready to reflash your device!
diff --git a/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md b/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
index dfeec2d329..b037f9bf15 100755
--- a/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
+++ b/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
@@ -20,7 +20,7 @@ description: >-
3\. The M-1 LED Matrix should be detected automatically. Select it, then click the **Config** tab in the top right corner.
-
+
!!! danger "WARNING ~ DO NOT UPDATE IT ~ WARNING"
@@ -28,12 +28,12 @@ description: >-
4\. Select **WiFi Setup** and at the bottom you will see a box with .local at the end. The letters inside of the box are your hostname and the IP is directly below it. You can change the hostname to whatever you like (using letters, numbers, and dashes only). Click Save and Connect when done.
-
+
5\. You can now access your device from a browser at http://the-ip-address-here or http://the-hostname-you-entered.local
6\. Edit the User Interface settings section under the **Server description** with a friendly name that is shown for your device!
-
+
[Click here to learn how to add your own image or logo to the M-1](https://wiki.apolloautomation.com/products/m1/examples/pixel-forge/){ .md-button .md-button--primary }
\ No newline at end of file
diff --git a/docs/products/m1/troubleshooting/m1-reflash-esphome.md b/docs/products/m1/troubleshooting/m1-reflash-esphome.md
index 19451d2a22..b447df5e2b 100644
--- a/docs/products/m1/troubleshooting/m1-reflash-esphome.md
+++ b/docs/products/m1/troubleshooting/m1-reflash-esphome.md
@@ -12,7 +12,7 @@ description: Step by step guide for reflashing the M-1 with the hub75-studio ESP
2\. Push and hold the boot button (the left button) on the M-1 controller. While still holding the button, plug the USB-C cable into the M-1, then release the button.
-
+
3\. Open https://pavlov-net.github.io/hub75-studio/ in your Chromium browser.
diff --git a/docs/products/m1/troubleshooting/m1-reflash.md b/docs/products/m1/troubleshooting/m1-reflash.md
index 45ffa3c950..6f03a5650d 100755
--- a/docs/products/m1/troubleshooting/m1-reflash.md
+++ b/docs/products/m1/troubleshooting/m1-reflash.md
@@ -12,7 +12,7 @@ description: Step by step guide for re-flashing the M-1 back to factory firmware
2\. Push and hold the boot button (the left button). While still holding the button down, plug in a USB-C cable into the USB-C port of your M-1 LED Matrix then let go of the button.
-
+
3\. Open the Apollo M-1 installer and choose your firmware. New units ship with **WLED 16.0.1**, which is the default.
@@ -26,7 +26,7 @@ description: Step by step guide for re-flashing the M-1 back to factory firmware
6\. Once you see "Installation complete!" you are finished. Click **Next**, then close the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/msr1/additional-info/exposed-gpio.md b/docs/products/msr1/additional-info/exposed-gpio.md
index 35215f0668..849639f2a3 100755
--- a/docs/products/msr1/additional-info/exposed-gpio.md
+++ b/docs/products/msr1/additional-info/exposed-gpio.md
@@ -3,7 +3,7 @@ description: "What each exposed GPIO pad on the back of the MSR-1 does, includin
---
# Exposed GPIO
-
+
The back of the Apollo MSR-1 has exposed GPIO for a variety of uses.
diff --git a/docs/products/msr1/addons/adding-co2-to-msr-1.md b/docs/products/msr1/addons/adding-co2-to-msr-1.md
index 723a866eea..42281325fb 100755
--- a/docs/products/msr1/addons/adding-co2-to-msr-1.md
+++ b/docs/products/msr1/addons/adding-co2-to-msr-1.md
@@ -5,18 +5,18 @@ description: "Fit the CO2 module to your MSR-1, with photos showing the connecto
1\. Unplug your MSR-1 from power and remove the back
-
+
2\. Remove the board from the case and orientate it like the below image. In the bottom right there is a black connector. There is a x in the lower right corner of the connector
-
+
3\. Orientate the CO2 module so the white x on the module is also in the lower right and the gold dot is in the upper left as seen below
-
+
4\. Align the connector on the back of the CO2 module with the connector on the MSR-1. Once aligned, push down so the CO2 module fully seats itself
-
+
5\. Put your MSR-1 back in the case and slide the back cover on. 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.
\ No newline at end of file
diff --git a/docs/products/msr1/examples/msr1-alarmo.md b/docs/products/msr1/examples/msr1-alarmo.md
index 9f4a2f7385..e8ee3d2f6f 100755
--- a/docs/products/msr1/examples/msr1-alarmo.md
+++ b/docs/products/msr1/examples/msr1-alarmo.md
@@ -8,29 +8,29 @@ My grandmother wanted a security system that would alert her when there was move
1\. Install [HACS](https://hacs.xyz/docs/use/download/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)
-
+
-
+
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.
-
+
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.)
-
+
5\. You can change the Title, Message, and Name of the alarm notification.
-
+
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.
-
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
-
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
diff --git a/docs/products/msr1/examples/msr1-dashboards.md b/docs/products/msr1/examples/msr1-dashboards.md
index f9e33b63e3..c765a1a11a 100755
--- a/docs/products/msr1/examples/msr1-dashboards.md
+++ b/docs/products/msr1/examples/msr1-dashboards.md
@@ -6,7 +6,7 @@ description: "Example Home Assistant dashboard cards for the MSR-1, including an
**Radar Scatter Plot With Apex Charts For MSR-1**
-
+
```plaintext
type: custom:apexcharts-card
@@ -46,7 +46,7 @@ series:
**CO2 Charts**
Home Assistant Sensor
-
+
```plaintext
graph: line
@@ -59,7 +59,7 @@ hours_to_show: 24
Custom: Plotly Graph Card
-
+
```plaintext
type: custom:plotly-graph
@@ -72,7 +72,7 @@ title: Bedroom CO2
Home Assistant Guage
-
+
```plaintext
type: gauge
diff --git a/docs/products/msr1/examples/using-msr-1-buzzer.md b/docs/products/msr1/examples/using-msr-1-buzzer.md
index 6290d08cbb..cab4c2d456 100755
--- a/docs/products/msr1/examples/using-msr-1-buzzer.md
+++ b/docs/products/msr1/examples/using-msr-1-buzzer.md
@@ -7,7 +7,7 @@ This guide will walk you through using the buzzer on your MSR-1. You can also ca
1. Open Home Assistant and navigate to developer tools in the bottom left
-
+
2\. Click on services
@@ -26,4 +26,4 @@ This guide will walk you through using the buzzer on your MSR-1. You can also ca
5\. Click on call service button in bottom right
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr1/introduction.md b/docs/products/msr1/introduction.md
index cc8dd6631c..da1e7c447e 100755
--- a/docs/products/msr1/introduction.md
+++ b/docs/products/msr1/introduction.md
@@ -1,6 +1,6 @@
---
description: "The Apollo MSR-1 multisensor: mmWave radar, LUX and UV, temperature, humidity, and optional CO2, running ESPHome for Home Assistant."
---
-
+
The Apollo MSR-1 is a compact, community-driven multisensor designed for Home Assistant via ESPHome. Measuring just 40.5mm x 32mm, it features mmWave radar for motion detection, LUX/UV sensors, temperature/humidity monitoring, and optional CO2 sensing. Powered by USB-C, the MSR-1 allows for customizable alerts through RGB LEDs and a piezo buzzer.
\ No newline at end of file
diff --git a/docs/products/msr1/setup/general-tips.md b/docs/products/msr1/setup/general-tips.md
index 17e8c463b0..33a2b7689b 100755
--- a/docs/products/msr1/setup/general-tips.md
+++ b/docs/products/msr1/setup/general-tips.md
@@ -5,13 +5,13 @@ description: "Placement and mounting tips for the MSR-1, including keeping the l
##### **MSR-1**
-
+
Picture from Smart Home Scene
##### **Light Sensor (LTR-390UV)**
-
+
When mounting the MSR-1 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.
@@ -23,17 +23,17 @@ When mounting the MSR-1 be sure to position the device so that the two large hol
The MSR-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120degree FOV of the mmWave radar.
-
+
-
+
The MSR-1 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling.
##### **Gate and FOV Visualization**
-****
+****
-
+
!!! tip "These are some useful hints!"
diff --git a/docs/products/msr1/setup/zones-ha.md b/docs/products/msr1/setup/zones-ha.md
index 528828e617..f4c1e0ba58 100755
--- a/docs/products/msr1/setup/zones-ha.md
+++ b/docs/products/msr1/setup/zones-ha.md
@@ -19,15 +19,15 @@ Here is a video of how to tune the mmWave sensor using radar engineering mode,
2. Navigate to Settings>Devices & services>ESPHome>Select the MSR-1
3. Scroll down to the Configuration section
4. Turn on Radar Engineering Mode (REM)
- 
+ 
5. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8
- 
+ 
6. The gates are different distances from the sensor
- 
+ 
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.
- 
+ 
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.
- 
+ 
**Alternate Method**
diff --git a/docs/products/msr1/setup/zones-hlk.md b/docs/products/msr1/setup/zones-hlk.md
index 3e88919b2e..33053810a1 100755
--- a/docs/products/msr1/setup/zones-hlk.md
+++ b/docs/products/msr1/setup/zones-hlk.md
@@ -8,41 +8,41 @@ description: "Tune the MSR-1 mmWave radar over Bluetooth with the HLKRadarTool p
2\. Ensure the mmWave radar you want to tune has Radar Control Bluetooth turned on. Home Assistant > Settings > Devices & services > ESPHome Devices > Select Device > Scroll down and toggle on Radar Control Bluetooth
-
+
3\. Open the app and select your device
-
+
4\. Turn on Engineering Mode
-
+
5\. Select More and then select Parameter settings
-
+
6\. Select Detect background noise
-
+
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.
-
+
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
-
+
**Maximum** - Sets the gate sensitivity to the maximum move and still energy
-
+
-**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energ**y** **** 9. Now your mmWave should be tuned to your environment! **Manual Calibration** 1. Follow steps 1-5 above
+**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energ**y** **** 9. Now your mmWave should be tuned to your environment! **Manual Calibration** 1. Follow steps 1-5 above
2\. Select Motion or Static sensitivity, change it to your desired value, and select Set
-
+
3\. Now your mmWave should be tuned to your environment!
\ No newline at end of file
diff --git a/docs/products/msr1/troubleshooting/msr1-boot-mode.md b/docs/products/msr1/troubleshooting/msr1-boot-mode.md
index 19ba8509f6..ddc5ca3bc8 100755
--- a/docs/products/msr1/troubleshooting/msr1-boot-mode.md
+++ b/docs/products/msr1/troubleshooting/msr1-boot-mode.md
@@ -11,7 +11,7 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede
1\. Position the MSR-1 as shown in the image below and locate the small opening to press the boot button (the right button).
-
+
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.
@@ -25,6 +25,6 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede
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.
-
+
4\. Continue with uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/msr1/troubleshooting/msr1-code.md b/docs/products/msr1/troubleshooting/msr1-code.md
index 0709e98735..f028d31734 100755
--- a/docs/products/msr1/troubleshooting/msr1-code.md
+++ b/docs/products/msr1/troubleshooting/msr1-code.md
@@ -11,33 +11,33 @@ If your device has already been connected to Home Assistant please press the boot button (the left button).
-
+
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-1 then let go of the button.
-
+
3\. Navigate to our installer page and click connect under Apollo MSR-1 Installer.
3\. Click the big "Connect" button.
-
+
3\. Select the open com port then click Connect.
-
+
4\. Click "Install MSR-1".
-
+
5\. Click "INSTALL".
-
+
6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
index 0d0bd089f5..c9876d8829 100755
--- a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
+++ b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
@@ -7,9 +7,9 @@ description: "Reset the MSR-1 Wi-Fi credentials with a 10 second press of the Bo
2\. Long press the Boot button for 10 seconds
-
+
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again
diff --git a/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md b/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
index ef9a3ab0d3..f370b6e8ba 100755
--- a/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
@@ -6,19 +6,19 @@ description: Step by step tutorial for adding 90 degree USB-C to MSR-2
1\. Gather the MSR-2 and 90 degree addon.
-
+
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.
-
+
3\. Gently push the short end of the 90 degree addon into the MSR-2 side USB-C port.
-
+
4\. Gently push the longer end of the 90 degree addon into a USB-C outlet.
-
+
!!! success "You're ready to begin using your device!"
diff --git a/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md b/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md
index 32973140b9..a3e1eba3fb 100755
--- a/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md
@@ -6,18 +6,18 @@ description: Tutorial on adding the rear female usb-c port to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back.
-
+
-
+
-
+
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.
-
+
-
+
3\. Align the ball inside the articulating mount and then push down until it's fully seated.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/addons/adding-co2-to-msr-2.md b/docs/products/msr2/addons/adding-co2-to-msr-2.md
index 75729e3c8e..b95bd00e89 100755
--- a/docs/products/msr2/addons/adding-co2-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-co2-to-msr-2.md
@@ -6,26 +6,26 @@ description: Tutorial on adding the SCD40 CO2 sensor to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back
-
+
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.
-
+
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.
-
+
4\. Gently push the SCD40 CO2 module onto the black mezzanine connector.
-
+
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.
-
+
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.
-
+
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/msr2/addons/adding-gpio-header-to-msr-2.md b/docs/products/msr2/addons/adding-gpio-header-to-msr-2.md
index 2532119bcd..7627c9bd96 100755
--- a/docs/products/msr2/addons/adding-gpio-header-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-gpio-header-to-msr-2.md
@@ -6,27 +6,27 @@ description: Tutorial on adding the GPIO Header to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back.
-
+
-
+
-
+
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.
-
+
-
+
3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
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.
-
+
-
+
!!! tip "Make sure to check out our MSR-2 GPIO Header LED Strip Tutorial!"
diff --git a/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md b/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
index a3b4dc52a5..8dfb9b5e64 100755
--- a/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
@@ -6,26 +6,26 @@ description: Tutorial on adding the rear female usb-c port to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back
-
+
-
+
-
+
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.
-
+
-
+
3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
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!
-
+
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.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/addons/msr2-outlet-mount.md b/docs/products/msr2/addons/msr2-outlet-mount.md
index eadb44536b..95f539142b 100755
--- a/docs/products/msr2/addons/msr2-outlet-mount.md
+++ b/docs/products/msr2/addons/msr2-outlet-mount.md
@@ -6,19 +6,19 @@ description: Tutorial for using the MSR-2 Outlet Mount.
1\. Gather a top facing usb-c plug, an MSR-2, and our MSR-2 Outlet Mount.
-
+
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.
-
+
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.
-
+
4\. Gently push the other USB-C port of the MSR-2 Outlet Mount into the top of the USB-C top facing plug.
-
+
!!! success "You're ready to plug it in and begin using your device!"
diff --git a/docs/products/msr2/calibrating-co2.md b/docs/products/msr2/calibrating-co2.md
index 503caaa143..2e54f8e291 100755
--- a/docs/products/msr2/calibrating-co2.md
+++ b/docs/products/msr2/calibrating-co2.md
@@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2
1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA.
-
+
2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device.
@@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2
If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key.
-
+
3\. Click on the button that says "PRESS" and then you are done.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/examples/msr2-alarmo.md b/docs/products/msr2/examples/msr2-alarmo.md
index 3f616396a5..92cfcff602 100755
--- a/docs/products/msr2/examples/msr2-alarmo.md
+++ b/docs/products/msr2/examples/msr2-alarmo.md
@@ -9,29 +9,29 @@ My grandmother wanted a security system that would alert her when there was move
1\. Install [HACS](https://hacs.xyz/docs/use/download/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)
-
+
-
+
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.
-
+
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.)
-
+
5\. You can change the Title, Message, and Name of the alarm notification.
-
+
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.
-
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
-
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
diff --git a/docs/products/msr2/setup/msr2-general-tips.md b/docs/products/msr2/setup/msr2-general-tips.md
index a7977e37e5..caa5161957 100755
--- a/docs/products/msr2/setup/msr2-general-tips.md
+++ b/docs/products/msr2/setup/msr2-general-tips.md
@@ -6,7 +6,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi
##### **Light Sensor (LTR-390UV)**
-
+
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.
@@ -18,11 +18,11 @@ When mounting the MSR-2 be sure to position the device so that the two large hol
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.
-
+
The MSR-2 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling.
-
+
!!! tip "These are some useful hints!"
@@ -32,8 +32,8 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount
##### **Gate and FOV Visualization**
-****
+****
-
+
#####
\ No newline at end of file
diff --git a/docs/products/msr2/setup/msr2-tuning-dashboard.md b/docs/products/msr2/setup/msr2-tuning-dashboard.md
index 9601be09cd..06113fab4d 100755
--- a/docs/products/msr2/setup/msr2-tuning-dashboard.md
+++ b/docs/products/msr2/setup/msr2-tuning-dashboard.md
@@ -22,7 +22,7 @@ This guide will create a beautiful and helpful dashboard to simplify configurati
4\. Head to your Home Assistant dashboard and Take control of your dashboard by clicking **Edit Dashboard** in the top right then the 3 dots from the **Edit Dashboard** menu and click **Take control**. (this step is only necessary for new Home Assistant users).
-
+
5\. Use the YAML generator below and enter in your device name such as apollo\_msr\_2\_m4c4dd and then click **Generate YAML**. It will copy the YAML for you to use in the next step!
@@ -39,8 +39,8 @@ This guide will create a beautiful and helpful dashboard to simplify configurati
Home Assistant depends on this file to function correctly - it is what displays your dashboard "views". Only make the changes exactly as outlined below. Do not add extra spaces or modify anything beyond what is specified in the instructions.
-
+
7\. You should now have a new dashboard view called **MSR-2 Configuration** and you should be ready to configure your sensor!
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/setup/zones-ha.md b/docs/products/msr2/setup/zones-ha.md
index 6131517a42..f76207cda3 100755
--- a/docs/products/msr2/setup/zones-ha.md
+++ b/docs/products/msr2/setup/zones-ha.md
@@ -28,22 +28,22 @@ How to tune the mmWave sensor using radar engineering mode.
2\. Scroll down to the Configuration section and turn on "Radar Engineering Mode".
-
+
3\. Scroll down to the Diagnostic section and you will see that when REM is enabled, the move and still energy for gates 0-8 are shown.
-
+
The gates are 0.75meter increments from the sensor - allowing you to "tune" each 0.75 meter section until your sensor works as intended!
-
+
-
+
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.
-
+
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.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/setup/zones-hlk.md b/docs/products/msr2/setup/zones-hlk.md
index 158e08d506..12201270e7 100755
--- a/docs/products/msr2/setup/zones-hlk.md
+++ b/docs/products/msr2/setup/zones-hlk.md
@@ -20,41 +20,41 @@ The default password to connect to the HLKRadarTool is "HiLink".
1\. Head to the ESPHome Integrations page then select your MSR-2 and scroll down until you see LD2410 Bluetooth.
-
+
2\. Open the app and select your device
-
+
3\. Turn on Engineering Mode
-
+
4\. Select More and then select Parameter settings
-
+
5\. Select Detect background noise
-
+
6\. 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.
-
+
7\. 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
-
+
**Maximum** - Sets the gate sensitivity to the maximum move and still energy
-
+
**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energy.
-****
+****
###### Manual Calibration
@@ -62,6 +62,6 @@ The default password to connect to the HLKRadarTool is "HiLink".
2\. Select Motion or Static sensitivity, change it to your desired value, and select Set.
-
+
3\. Now your MSR-2 should be tuned to your environment!
\ No newline at end of file
diff --git a/docs/products/msr2/troubleshooting/msr2-boot-mode.md b/docs/products/msr2/troubleshooting/msr2-boot-mode.md
index 72937708aa..b4dc6bb4e5 100755
--- a/docs/products/msr2/troubleshooting/msr2-boot-mode.md
+++ b/docs/products/msr2/troubleshooting/msr2-boot-mode.md
@@ -12,7 +12,7 @@ description: Step by step guide for putting The MSR-2 In Boot Mode.
1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button).
-
+
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.
@@ -26,6 +26,6 @@ description: Step by step guide for putting The MSR-2 In Boot Mode.
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.
-
+
4\. Continue with uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/msr2/troubleshooting/msr2-code.md b/docs/products/msr2/troubleshooting/msr2-code.md
index e081444cd4..2fccb01b6e 100755
--- a/docs/products/msr2/troubleshooting/msr2-code.md
+++ b/docs/products/msr2/troubleshooting/msr2-code.md
@@ -12,7 +12,7 @@ If your device has already been connected to Home Assistant please 2 sensor. There is an X on the SCD40 sensor's PCB as well, you can see it in the image below. There is also a "gold dot" in the top left of the SCD40 when oriented properly.
-
+
4\. Gently push the SCD40 CO2 module onto the black mezzanine connector.
-
+
5\. Slide the case back over the MTR-1, making sure that the case has the hole for the LUX Sensor facing the right direction (to the right).
-
+
6\. Flip the MTR-1 back over to prepare to put the back case on.
-
+
7\. Gently press the backplate of the MTR-1 case onto the MTR-1 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.
-
+
8\. Put the stand back on if applicable.
-
+
9\. 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/mtr1/addons/adding-gpio-header-to-mtr-1.md b/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
index 9e3dcc19f5..9bf63fb5d7 100755
--- a/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
@@ -6,30 +6,30 @@ description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1
1\. Unplug your MTR-1 from power and remove the stand if attached.
-
+
2\. Remove the backplate of the MTR-1.
-
+
3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the GPIO Header addon.
-
+
-
+
4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
5\. Align the new back for your MTR-1 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.
-
+
6\. The case should sit flush and you're now ready to add functionality to your device!
-
+
-
+
[Click here to head to the GPIO Header LED Strip Tutorial!](https://wiki.apolloautomation.com/products/msr2/examples/gpio-header-control-an-led-strip/){ .md-button .md-button--primary }
\ No newline at end of file
diff --git a/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md b/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
index cbd0458171..36246b478b 100755
--- a/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
@@ -6,26 +6,26 @@ description: Step by step tutorial for adding the Rear Male USB addon to the MTR
1\. Unplug your MTR-1 from power and remove the stand if attached.
-
+
2\. Remove the backplate of the MTR-1.
-
+
3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the male Rear USB-C addon.
-
+
-
+
4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
5\. Align the new back for your MTR-1 that came with the Male USB-C addon. Push down on the corners closest to the USB-C addon first, and then push the back on securely on the other two corners.
-
+
6\. The case should sit flush and you're now ready to plug into a USB-C Outlet!
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/mtr1/examples/mtr1-alarmo.md b/docs/products/mtr1/examples/mtr1-alarmo.md
index 2d366f1d64..0b362ff0dd 100755
--- a/docs/products/mtr1/examples/mtr1-alarmo.md
+++ b/docs/products/mtr1/examples/mtr1-alarmo.md
@@ -9,29 +9,29 @@ My grandmother wanted a security system that would alert her when there was move
1\. Install [HACS](https://hacs.xyz/docs/use/download/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)
-
+
-
+
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.
-
+
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.)
-
+
5\. You can change the Title, Message, and Name of the alarm notification.
-
+
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.
-
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
-
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
diff --git a/docs/products/mtr1/setup/general-tips.md b/docs/products/mtr1/setup/general-tips.md
index a5b6b2cc54..cb57b6d6cf 100755
--- a/docs/products/mtr1/setup/general-tips.md
+++ b/docs/products/mtr1/setup/general-tips.md
@@ -6,11 +6,11 @@ description: Multiple helpful images for mounting, lux/rgb, and zone visualizati
##### **MTR-1 PCB with Sensors**
-
+
##### **Light Sensor (LTR-390UV)**
-
+
When mounting the MTR-1 be sure to position the device so that the large hole at the top is not covered. This allows more light to enter and will ensure better accuracy
@@ -18,19 +18,19 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak
##### **Mounting**
-
+
##### **LD2450 Performance and Electrical Parameters**
##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf)
-
+
##### **Expanding Horizontal Distance as Target Moves Further Away**
The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance.
-
+
##### **Increased ESP Temperature**
diff --git a/docs/products/mtr1/setup/zones-ha.md b/docs/products/mtr1/setup/zones-ha.md
index 88e75790eb..2a9d8de209 100755
--- a/docs/products/mtr1/setup/zones-ha.md
+++ b/docs/products/mtr1/setup/zones-ha.md
@@ -22,17 +22,17 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho
4\. Head to a dashboard view and click the pencil icon to edit dashboard then click one of the large "+" signs, type in manual, and click on it.
-
+
5\. Delete any text in the custom card then paste the YAML you copied above and click save when finished. You should now have a custom card that looks just like the card below!
-
+
6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page")
7\. Click device as shown in the image below
-
+
8\. Scroll down until you get to the Configuration section and you see the empty boxes for zones 1-3 for both X and Y coordinates.
@@ -46,7 +46,7 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho
9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -7000 mm to 7000 mm, and the Y values are 0 mm to 7000 mm.
-
+
!!! tip "Helpful Hints to understand zones better!"
@@ -62,23 +62,23 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho
10\. If you use the imperial system (Freedom Units) then you will need to do this step. Metric users can skip this. For the targets to show up correctly we first need to update the Target 1-3 X and Y measurements from inches (in) to millimeters (mm). Find Target 1-3 X and Y under the Sensors section and select them. You will want to update all 3 X and Y target values.
-
+
11\. Select the Settings cog in the top right.
-
+
12\. Change the unit of measurement to mm and select Update.
-
+
13\. Your X and Y Targets will now look like this.
-
+
14\. Now you should see targets on the card.
-
+
15\. Now we can make zones around the targets where you want to Detect presence or filter them out.
diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md
index ec04c50ae7..bb0e722a2b 100755
--- a/docs/products/mtr1/setup/zones-hlk.md
+++ b/docs/products/mtr1/setup/zones-hlk.md
@@ -22,7 +22,7 @@ The ESPHome Integrations page then select your MTR-1 and scroll down until you see LD2450 Bluetooth.
-
+
2\. Open the HLKRadarTool App and select your device.
@@ -30,11 +30,11 @@ The uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/mtr1/troubleshooting/mtr1-code.md b/docs/products/mtr1/troubleshooting/mtr1-code.md
index aa9ef31e64..7a0fd41101 100755
--- a/docs/products/mtr1/troubleshooting/mtr1-code.md
+++ b/docs/products/mtr1/troubleshooting/mtr1-code.md
@@ -12,7 +12,7 @@ If your device has already been connected to Home Assistant please Apollo PUMP-1 Installer.
-
+
5\. Select the open com port then click Connect.
-
+
7\.. Click Install PUMP-1.
-
+
7\. Click Install.
-
+
8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md b/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md
index 6228f41331..ec352e0fbf 100755
--- a/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md
+++ b/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md
@@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP
2\. Long press the Boot button (the button on the right) for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/new-product-template/troubleshooting/productname-teardown.md b/docs/products/new-product-template/troubleshooting/productname-teardown.md
index b43e5c591f..095800a7bb 100755
--- a/docs/products/new-product-template/troubleshooting/productname-teardown.md
+++ b/docs/products/new-product-template/troubleshooting/productname-teardown.md
@@ -14,22 +14,22 @@ description: >-
1\. Unplug the USB-C cable and remove the lid.
-
+
2\. Remove the 3 pin JST connectors using your fingers or needle nose pliers.
-
+
3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling - this makes removal much easier.
-
+
###### Reassembly
1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1.
-
+
2\. Insert the JST connector coming from your bottle's sensor into the **right-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection. Follow up by inserting the second JST connector from the optional fluid output sensor into the **left-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. Finally, place the lid on top of the pump-1 case and gently snap it in place.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/plt1/examples/blueprint.md b/docs/products/plt1/examples/blueprint.md
index 37721c53c0..8959f2d99a 100644
--- a/docs/products/plt1/examples/blueprint.md
+++ b/docs/products/plt1/examples/blueprint.md
@@ -14,17 +14,17 @@ description: >-
2\. Click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation PLT-1 Blueprint** and click on **Select a device** then choose your **Apollo PLT-1** or **PLT-1B** from the dropdown menu.
-
+
4\. Enter your **plant's name** (this appears in notification messages), then select your **mobile device** for push notifications.
5\. Enable the sensor groups you want to monitor (e.g. Soil Moisture, Air Temperature, Light Intensity) and adjust the thresholds to suit your plant.
-
+
!!! success "Each sensor group is disabled by default — enable only what matters!"
@@ -41,19 +41,19 @@ description: >-
1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**.
-
+
2\. Copy this link and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation PLT-1 Blueprint** and click on **Select a device** then choose your **Apollo PLT-1** or **PLT-1B** from the dropdown menu.
-
+
4\. Enter your **plant's name**, select your **mobile device**, enable the sensor groups you want, and set your thresholds.
-
+
!!! success "Each sensor group is disabled by default — enable only what matters!"
diff --git a/docs/products/plt1/examples/flower-card.md b/docs/products/plt1/examples/flower-card.md
index b0a9e29bd2..5be7eab68c 100755
--- a/docs/products/plt1/examples/flower-card.md
+++ b/docs/products/plt1/examples/flower-card.md
@@ -2,7 +2,7 @@
title: PLT-1 Flower Card
description: This suggests using the Flower Card inside Home Assistant for your device!
---
-
+
Home Assistant Plant Integration
This integration can automatically fetch data from OpenPlantBook if you are a registered user. Registration is free.
Plants are set up in the UI and all configuration of your plants can be managed there or by automations and scripts. diff --git a/docs/products/plt1/general-tips.md b/docs/products/plt1/general-tips.md index f7953c6ed9..290d345d74 100755 --- a/docs/products/plt1/general-tips.md +++ b/docs/products/plt1/general-tips.md @@ -8,4 +8,4 @@ description: Helpful tips to get the most use out of your sensor. For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/plt1/setup/prevent-sleep.md b/docs/products/plt1/setup/prevent-sleep.md index 388b657989..26a8381aee 100755 --- a/docs/products/plt1/setup/prevent-sleep.md +++ b/docs/products/plt1/setup/prevent-sleep.md @@ -14,11 +14,11 @@ description: Tutorial for how to enable/disable prevent sleep. 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 5 minutes. diff --git a/docs/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/products/plt1/troubleshooting/plt1-boot-mode.md index 3084f12a70..1fa4b8fde6 100755 --- a/docs/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/products/plt1/troubleshooting/plt1-boot-mode.md @@ -12,7 +12,7 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. 1\. Position the PLT-1 as shown in the image below and locate the small opening to press the boot button. - + 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. @@ -26,6 +26,6 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. 3\. Hold down the boot button, then press and release the reset button while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with uploading the firmware document. \ No newline at end of file diff --git a/docs/products/plt1/troubleshooting/plt1-code.md b/docs/products/plt1/troubleshooting/plt1-code.md index 2d9d8194b0..c0305644f8 100755 --- a/docs/products/plt1/troubleshooting/plt1-code.md +++ b/docs/products/plt1/troubleshooting/plt1-code.md @@ -12,29 +12,29 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. - + 2\. Navigate to our installer page and click connect under Non Battery Firmware Apollo PLT-1 Installer 3\. Click the big "Connect" button. - + 4\. Select the open com port then click Connect. - + 5\. Click "Install ApolloAutomation.PLT-1". - + 6\. Click "INSTALL". - + 7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md b/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md index 02cb8eddd5..8c99f3cf1b 100755 --- a/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md +++ b/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md @@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PLT- 2\. Long press the Boot button for 10 seconds - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/products/plt1b/additional-info/insert-battery.md b/docs/products/plt1b/additional-info/insert-battery.md index 2e16013b50..c31af6ef72 100644 --- a/docs/products/plt1b/additional-info/insert-battery.md +++ b/docs/products/plt1b/additional-info/insert-battery.md @@ -10,28 +10,28 @@ description: How to Insert Battery on PLT-1B. 1\. Gently press your thumb on the case above the stake and the lid should pop off. - + 2\. Hold the case and push the stake down a bit, then gently lift it out of the bottom case section. - + 3\. Flip the PLT-1B over and identify the `+` and `-` markings. The `+` is on the left side and the `-` is on the right side. Double check before going any further. 4\. The top of the battery (the positive end, marked with a `+` and a small ring around the terminal) goes on the left side, matching the `+` on the PLT-1B. - + 5\. Hold the PCB. You'll need to use a bit of force to push in the battery. Start with the right `-` side, then push in the left `+` side. - + 6\. Flip the sensor back over and lay the PCB inside the case so it sits flat. - + 7\. Line up the notch in the top left of the lid, then gently press down until the lid snaps into place. - + You have now installed or reinstalled the battery! \ No newline at end of file diff --git a/docs/products/plt1b/general-tips.md b/docs/products/plt1b/general-tips.md index 6e098b9fd5..a569e1de74 100755 --- a/docs/products/plt1b/general-tips.md +++ b/docs/products/plt1b/general-tips.md @@ -8,4 +8,4 @@ description: Helpful tips to get the most use out of your sensor. For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md index 56712c6c7b..25ceb70bf1 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -8,15 +8,15 @@ description: Step by step guide for putting The PLT-1B In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. - + ##### Method 1: Boot Button Only 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. - + - + 2\. Use a pin to press and hold the boot button, while holding the boot button plug the PLT-1B back into your computer/power and then release the boot button @@ -28,8 +28,8 @@ description: Step by step guide for putting The PLT-1B In Boot Mode. 2\. Press and hold the boot button, while holding it press and release the reset button, then release the boot button - + - + 3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-code/) \ No newline at end of file diff --git a/docs/products/plt1b/troubleshooting/plt1b-code.md b/docs/products/plt1b/troubleshooting/plt1b-code.md index ae2534b6b8..e02b44a9e8 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/products/plt1b/troubleshooting/plt1b-code.md @@ -14,17 +14,17 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. - + 2\. Navigate to our installer page and click connect under Battery Firmware Apollo PLT-1B Installer @@ -52,23 +52,23 @@ If your device has already been connected to Home Assistant please Apollo PUMP-1 Installer. - + 5\. Select the open com port then click Connect. - + 7\.. Click Install PUMP-1. - + 7\. Click Install. - + 8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md b/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md index 6228f41331..ec352e0fbf 100755 --- a/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md +++ b/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md @@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP 2\. Long press the Boot button (the button on the right) for 10 seconds. - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/products/pump1/troubleshooting/pump1-teardown.md b/docs/products/pump1/troubleshooting/pump1-teardown.md index b43e5c591f..095800a7bb 100755 --- a/docs/products/pump1/troubleshooting/pump1-teardown.md +++ b/docs/products/pump1/troubleshooting/pump1-teardown.md @@ -14,22 +14,22 @@ description: >- 1\. Unplug the USB-C cable and remove the lid. - + 2\. Remove the 3 pin JST connectors using your fingers or needle nose pliers. - + 3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling - this makes removal much easier. - + ###### Reassembly 1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1. - + 2\. Insert the JST connector coming from your bottle's sensor into the **right-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection. Follow up by inserting the second JST connector from the optional fluid output sensor into the **left-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. Finally, place the lid on top of the pump-1 case and gently snap it in place. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md b/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md index 3ac4ddd8f5..68099dbb11 100755 --- a/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md +++ b/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md @@ -4,7 +4,7 @@ description: Tutorial on adding the LD2412 mmwave sensor to your R PRO-1 --- # Install the LD2412 in R PRO-1 - + !!! tip "Check out the gif above or step by step directions below!" @@ -12,20 +12,20 @@ description: Tutorial on adding the LD2412 mmwave sensor to your R PRO-1 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Place the LD2412 on the 4 and 3 pin headers (only fits one way). - + 4\. Place back into the case with the ethernet module facing up and the usb-c port facing you. - + 5\. Snap the lid back into place! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md b/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md index 7fbc6d7335..ae85a328e3 100755 --- a/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md +++ b/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md @@ -6,7 +6,7 @@ description: Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. With the back removed, identify the bottom left 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. @@ -17,12 +17,12 @@ description: Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1. 3\. Gently push the SCD40 CO2 module onto the black mezzanine connector. - + 4\. Slide the case back over the R PRO-1, making sure that the case has the hole for the USB-C port and the SCD40 facing toward you. 5\. Gently press the backplate of the R PRO-1 case onto the R PRO-1 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. - + [Click here to head to the CO2 calibration guide!](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md index fe7ef71573..43eeac1adc 100755 --- a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md +++ b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md @@ -8,11 +8,11 @@ description: Tutorial on adding the gang box mounts to your R-Pro-1. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently lift the PCB out of the case and set it face up with the USB-C port facing down. - + 3\. Take the two gang box mount pieces and identify the one labeled "TOP" and the other piece which is the bottom mount. @@ -22,26 +22,26 @@ description: Tutorial on adding the gang box mounts to your R-Pro-1. 3\. Gently push the top mount labeled "TOP" into the pcb as shown below. Make sure the orientation is identical to the image below! - + 4\. Gently push the top mount into the pcb as shown below. Make sure the orientation is identical to the image below! - + 5\. The end result should look identical to the image below. You are now ready to install it inside of a 1 gang box. - + ###### Install in 1-Gang Box 1\. Line up the holes in your 1-gang box (yours will be attached to the wall already). - + 2\. Place screws through the blank faceplate and gently place over the r-pro-1 mounting holes. - + 3\. Screw in the screws slowly to make sure not to break the mounts or the blank faceplate. At the end yours will look just like the image below! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md index 58d271f9a2..0319f25329 100755 --- a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md +++ b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md @@ -12,13 +12,13 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. 1\. Unplug your R PRO-1 from power and remove the back. - + - + 2\. Gently lift the PCB out of the case and set it face up with the USB-C port facing down. - + 3\. Take the two ceiling mount pieces and identify the one labeled "TOP" and the other piece which is the bottom mount. @@ -28,15 +28,15 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. 3\. Gently push the top mount labeled "TOP" into the pcb as shown below. Make sure the orientation is identical to the image below! - + 4\. Gently push the bottom mount into the pcb as shown below. Make sure the orientation is identical to the image below! - + 5\. The end result should look identical to the image below. You are now ready to install it inside of the ceiling mount. - + ###### Cut the Ceiling Hole @@ -46,22 +46,22 @@ The Ceiling Mount needs a 3.5 inch (around 89mm) circular hole in the ceiling. C 1\. Remove the cover to expose the inside of the installed Ceiling Mount. - + 2\. Plug in Ethernet cable or USB-C cable. - + 3\. Gently slide R PRO-1 into the Ceiling Mount. - + 4\. Push the R PRO-1 back 1inch (around 2.5cm) to make sure the lip of the cover fits over the Ceiling Mount. - + 5\. Gently press the ceiling mount cover until it is securely attached to the Ceiling Mount. - + \ No newline at end of file diff --git a/docs/products/rpro1/calibrating-co2.md b/docs/products/rpro1/calibrating-co2.md index 4427c558c6..e431278ba9 100755 --- a/docs/products/rpro1/calibrating-co2.md +++ b/docs/products/rpro1/calibrating-co2.md @@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2 1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA. - + 2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device. @@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2 If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key. - + 3\. Click on the button that says "PRESS" and then you are done. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-general-tips.md b/docs/products/rpro1/setup/rpro1-general-tips.md index f3e2dfb474..0a40ee17f0 100755 --- a/docs/products/rpro1/setup/rpro1-general-tips.md +++ b/docs/products/rpro1/setup/rpro1-general-tips.md @@ -6,7 +6,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi ##### **Light Sensor (LTR-390UV)** - + The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't directly reach the sensor for UV detection. However, light can still enter from around the edges or behind the front panel, allowing the lux readings to spike when ambient light is present. @@ -18,13 +18,13 @@ The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't di The R PRO-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120 degree FOV for the LD2450 and 150 degree FOV for the LD2412. - + ##### **Ceiling Mounting** The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ceiling using our ceiling mount kit. - + !!! tip "There are actually two sensors in your r-pro-1 if you bought the optional LD2412 addon!" @@ -50,4 +50,4 @@ The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ##### **Gate Visualization** - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-switch-firmware.md b/docs/products/rpro1/setup/rpro1-switch-firmware.md index ac5aea3fb0..5ad4ae1d25 100755 --- a/docs/products/rpro1/setup/rpro1-switch-firmware.md +++ b/docs/products/rpro1/setup/rpro1-switch-firmware.md @@ -14,15 +14,15 @@ description: >- 1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R PRO-1. - + 2\. Scroll down until you see the "Firmware Type" dropdown and select "Ethernet". - + 3\. Locate the Firmware Update entity and click on "PRESS". - + 4\. Wait a few minutes - this will download the new firmware file from our github repo and then install the image. @@ -32,15 +32,15 @@ description: >- 1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R PRO-1. - + 2\. Scroll down until you see the "Firmware Type" dropdown and select "WiFi". - + 3\. Locate the Firmware Update entity and click on "PRESS". - + 4\. Wait a few minutes - this will download the new firmware file from our github repo and then install the image. diff --git a/docs/products/rpro1/setup/zones-ha-new.md b/docs/products/rpro1/setup/zones-ha-new.md index 5f892d5ce1..942fe2e4e6 100755 --- a/docs/products/rpro1/setup/zones-ha-new.md +++ b/docs/products/rpro1/setup/zones-ha-new.md @@ -20,11 +20,11 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 2\. Scroll down until you see "LD2450 Zone Type" and choose "Detection" from the drop-down menu. - + 3\. Begin entering in the X and Y coordinates for each zone. - + !!! null "Helpful Hints to understand LD2450 zones better!" diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index 3d7655f57f..e8f171658f 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -32,17 +32,17 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 4\. Head to a dashboard view and click the pencil icon to edit dashboard then click one of the large "+" signs, type in manual, and click on it. - + 5\. Delete any text in the custom card then paste the YAML you copied above and click save when finished. You should now have a custom card that looks just like the card below! - + 6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page") 7\. Click device as shown in the image below - + 8\. Scroll down until you get to the Configuration section and you see the empty boxes for zones 1-3 for both X and Y coordinates. @@ -56,7 +56,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -7000 mm to 7000 mm, and the Y values are 0 mm to 7000 mm. - + !!! tip "Helpful Hints to understand zones better!" @@ -72,23 +72,23 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 10\. If you use the imperial system (Freedom Units) then you will need to do this step. Metric users can skip this. For the targets to show up correctly we first need to update the Target 1-3 X and Y measurements from inches (in) to millimeters (mm). Find Target 1-3 X and Y under the Sensors section and select them. You will want to update all 3 X and Y target values. - + 11\. Select the Settings cog in the top right. - + 12\. Change the unit of measurement to mm and select Update. - + 13\. Your X and Y Targets will now look like this. - + 14\. Now you should see targets on the card. - + 15\. Now we can make zones around the targets where you want to Detect presence or filter them out. @@ -100,7 +100,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below the Apollo R PRO-1. - + 2\. Scroll down until you see "LD2412 Mode" and change it from "Normal" to "Engineering". @@ -112,14 +112,14 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 3\. Scroll down to the Diagnostic section and you will see "LD2412 g00 move energy" through "LD2412 g13 still energy" are showing percentages from 0-100%. - + 4\. Scroll up to the Configuration section and identify the threshold sliders for g0-g13 for both moving and still energy. 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. - + 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. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/setup/zones-hlk.md b/docs/products/rpro1/setup/zones-hlk.md index c5bcfb48e9..0f63a5613e 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -24,7 +24,7 @@ The ESPHome Integrations page then select your R PRO-1 and scroll down until you see LD2450 Bluetooth. - + 2\. Open the HLKRadarTool App and select your device. @@ -32,11 +32,11 @@ The ESPHome Integrations page then select your R PRO-1 and scroll down until you see **LD2412 Bluetooth**. Toggle it on. - + 2\. Open the HLKRadarTool app. Your R PRO-1 should appear in the device list. Tap it to connect. @@ -104,7 +104,7 @@ The same HLKRadarTool app is used for both sensors. The LD2412 connects over Bluetooth, which means you need to be within a few feet of the sensor for it to appear in the app. If it doesn't show up, move closer and pull down to refresh the list. - + 3\. Once connected, enable **Engineering Mode** as shown above. This turns on the live energy graph, which shows you what the sensor is actually seeing at each distance gate in real time. @@ -116,7 +116,7 @@ The same HLKRadarTool app is used for both sensors. 4\. Leave the room empty and make sure nothing is moving, then tap **Auto** in the app. The sensor scans the environment for about 10 seconds and automatically sets thresholds to filter out static interference from electronics, HVAC, and other background sources. When it's done you'll see **Completed** and the app will return to showing the detection distance. This gives you a clean baseline before any manual tuning. - + 5\. Tap **Settings** in the top right and use the **Detection Range** slider to set which gates the sensor monitors. You can set both a start and end gate — for example, Gate 3 to Gate 6 means the sensor only looks between 2.25m and 4.5m from the device. Limiting the range prevents the sensor from picking up movement through walls or in adjacent rooms. @@ -124,14 +124,14 @@ The same HLKRadarTool app is used for both sensors. Each gate is 0.75m. Gate 1 = 0.75m, Gate 2 = 1.5m, Gate 3 = 2.25m, Gate 4 = 3m, Gate 5 = 3.75m, Gate 6 = 4.5m, Gate 7 = 5.25m, Gate 8 = 6m. - + 6\. To fine-tune which distances trigger detection, head to the ESPHome Integrations page, select your R PRO-1, and use the gate sensitivity sliders on the device page. - **Raise** a gate's sensitivity to make it harder to trigger at that distance (useful for ignoring a fan, HVAC vent, or a window where cars pass). - **Lower** a gate's sensitivity to make it more sensitive at that distance (useful for reliably detecting someone sitting still in a chair). - + 7\. Tap **Settings** at the top of the app and set the **Unmanned Duration**. This controls how many seconds the sensor waits after it stops detecting before it reports "no one present." The default is 10 seconds — increase it if you're getting false "nobody home" readings in your space. In Home Assistant, this same setting is called **LD2412 Timeout**. diff --git a/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md b/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md index 7c170e56cd..47633aa3b8 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md +++ b/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md @@ -12,15 +12,15 @@ description: Step by step guide for putting The R PRO-1 In Boot Mode. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Locate the boot button on the bottom right side of the PCB. - + 4\. 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 R PRO-1 then let go of the button. @@ -30,19 +30,19 @@ description: Step by step guide for putting The R PRO-1 In Boot Mode. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Locate the boot button on the bottom right side of the PCB. - + 4\. Locate the reset button on the bottom left side of the PCB. - + 5\. 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. diff --git a/docs/products/rpro1/troubleshooting/rpro1-code.md b/docs/products/rpro1/troubleshooting/rpro1-code.md index 6921bd527f..25be9c4cd9 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-code.md +++ b/docs/products/rpro1/troubleshooting/rpro1-code.md @@ -12,29 +12,29 @@ If your device has already been connected to Home Assistant please as shown here. 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 R PRO-1 then let go of the button. - + 3\. Navigate to our installer page and click connect under Apollo R PRO-1 Installer. 3\. Click the big "Connect" button. - + 3\. Select the open com port then click Connect. - + 4\. Click "Install R PRO-1". - + 5\. Click "INSTALL". - + 6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md b/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md index 2ca448b35b..ac8bc78031 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md +++ b/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md @@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your R PR 2\. Long press the Boot button (the button on the right) for 10 seconds. - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/products/rpro1/troubleshooting/rpro1-teardown.md b/docs/products/rpro1/troubleshooting/rpro1-teardown.md index 245b726f68..3a91fa6c78 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-teardown.md +++ b/docs/products/rpro1/troubleshooting/rpro1-teardown.md @@ -8,34 +8,34 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts, 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Gently remove the LD2412 as shown below. - + 4\. Gently remove the LD2450 as shown below. - + ###### Reassembly 1\. Place the LD2450 on the 8 pin header. - + 2\. Place the LD2412 on the 4 and 3 pin headers (only fits one way). - + 3\. Place back into the case with the ethernet module facing up and the usb-c port facing you. - + 4\. Snap the lid back into place! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temp1/addons/food-probe.md b/docs/products/temp1/addons/food-probe.md index 2a5b74e144..41964bdd64 100755 --- a/docs/products/temp1/addons/food-probe.md +++ b/docs/products/temp1/addons/food-probe.md @@ -6,13 +6,13 @@ description: Step by step guide for installing and using the optional Food Probe The TEMP-1 comes with an optional food probe which can be used to monitor food temperatures when baking, grilling, etc. It includes a heat-resistant cable but the TEMP-1 itself needs to stay in a cool environment. - + 1\. To use your food probe simply take it out of the package and insert it into the 3.5mm port on your TEMP-1. - + - + 2\. Once inserted, proceed to step 3 unless you have a battery in it @@ -22,11 +22,11 @@ The TEMP-1 comes with an optional food probe which can be used to monitor food t - + 3\. Go to the device page of your TEMP-1 in Home Assistant and choose probe "Food". - + !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/temp1/addons/magnetic-mount.md b/docs/products/temp1/addons/magnetic-mount.md index 7a8eed8701..495caee00c 100755 --- a/docs/products/temp1/addons/magnetic-mount.md +++ b/docs/products/temp1/addons/magnetic-mount.md @@ -6,27 +6,27 @@ description: Step by step guide for installing and using the optional Magnetic M The TEMP-1 comes with an optional magnetic mount which can be used to secure the TEMP-1 to your fridge or grill as shown below. - + 1\. To use your magnetic mount place it with the magnet facing upwards as shown: - + 2\. Align the lid with the hole in the top right and place your TEMP-1 inside the magnetic mount and gently press down. - + - + 3\. It will sit flush as shown in the image below. - + 4\. Affix your TEMP-1 to the outside of fridge or a safe cool place on the grill. - + - + !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/temp1/addons/multiple-probes.md b/docs/products/temp1/addons/multiple-probes.md index 9584f894db..d5af079fea 100755 --- a/docs/products/temp1/addons/multiple-probes.md +++ b/docs/products/temp1/addons/multiple-probes.md @@ -12,11 +12,11 @@ The TEMP-1 comes with an optional [3.5mm Multi-Probe Splitter](https://apolloaut 1\. To use your TEMP-1 Multi-Probe Splitter gently plug it into the 3.5mm port on your device. - + 2\. Plug in your long or short temp probes into the Multi-Probe Splitter. - + !!! success "Power on your TEMP-1 after plugging in all of your probes!" @@ -24,19 +24,19 @@ The TEMP-1 comes with an optional [3.5mm Multi-Probe Splitter](https://apolloaut 3\. Go to the device page of your TEMP-1 in Home Assistant and confirm the Temperature Probe is selected from the dropdown. - + 4\. Enable the disabled 3rd and 4th temp probe entities if you have more than 2 probes! - + 5\. Once completed you will see all four probes updating the temperature! - + 6\. To rename the probes you can edit each probe and choose a unique name such as "Fridge Probe" and "Freezer Probe" as shown below! - + !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/temp1/addons/temp-probe.md b/docs/products/temp1/addons/temp-probe.md index 7ec0bae253..86fe512fce 100755 --- a/docs/products/temp1/addons/temp-probe.md +++ b/docs/products/temp1/addons/temp-probe.md @@ -8,17 +8,17 @@ The TEMP-1 comes with an optional temp probe which can be used to monitor a frid 1\. To use your temp probe simply take it out of the package and insert it into the 3.5mm port on your TEMP-1. - + - + 2\. Once inserted, proceed to step 3. - + 3\. Go to the device page of your TEMP-1 in Home Assistant and choose the Temperature Probe. - + !!! danger "Do not leave your sensor outside or let it get wet!" @@ -26,15 +26,15 @@ The TEMP-1 comes with an optional temp probe which can be used to monitor a frid **Example images of the long temperature probe in a mini freezer:** - + - + ## Probe Pinout The 1.5m and 20cm DS18B20 temp probes use a standard 3.5mm TRS plug. Wire yours the same way if you're building your own probe or repairing a cut cable. - + | Contact | Signal | | --- | --- | diff --git a/docs/products/temp1/examples/hot-water-recirculation.md b/docs/products/temp1/examples/hot-water-recirculation.md index 57c23ea354..9d3630c350 100644 --- a/docs/products/temp1/examples/hot-water-recirculation.md +++ b/docs/products/temp1/examples/hot-water-recirculation.md @@ -116,7 +116,7 @@ Donovan's whole system is one blueprint. Import it, pick your entities, set your 2\. Click **Preview**, then **Import blueprint**. - + 3\. Click **Apollo Automation Hot Water Recirculation (TEMP-1)**, create an automation from it, and fill in the inputs below. diff --git a/docs/products/temp1/examples/temp1-alert-example.md b/docs/products/temp1/examples/temp1-alert-example.md index fd8a60cbc0..6b9768a84a 100755 --- a/docs/products/temp1/examples/temp1-alert-example.md +++ b/docs/products/temp1/examples/temp1-alert-example.md @@ -12,12 +12,12 @@ This will guide you through how to setup the built in alarm using the temperatur 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30F so I would want to go slightly above that range. However, in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temp1/examples/temp1-automation-examples.md b/docs/products/temp1/examples/temp1-automation-examples.md index dbb0f7bd5f..1a6a448fb9 100755 --- a/docs/products/temp1/examples/temp1-automation-examples.md +++ b/docs/products/temp1/examples/temp1-automation-examples.md @@ -12,11 +12,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -24,11 +24,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -36,11 +36,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -72,7 +72,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -80,11 +80,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -92,11 +92,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -127,122 +127,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/products/temp1/setup/prevent-sleep.md b/docs/products/temp1/setup/prevent-sleep.md index 4cf9fac91d..d759dca993 100755 --- a/docs/products/temp1/setup/prevent-sleep.md +++ b/docs/products/temp1/setup/prevent-sleep.md @@ -14,11 +14,11 @@ description: Guide for setting up and using the prevent sleep toggle with the TE 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 8 minutes. diff --git a/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md b/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md index bfd2203d18..9ac30ecb0f 100644 --- a/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md +++ b/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md @@ -12,7 +12,7 @@ By default the TEMP-1 reports its **Temperature Probe** every 60 seconds. You ca 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on your TEMP-1. - + 2\. Paste this YAML below your device's existing config. The `!extend` keyword edits the probe that is already defined in the firmware, so you only need the lines you want to change. @@ -27,13 +27,13 @@ sensor: update_interval: 10s ``` - + 3\. In the top right click "SAVE" and then "INSTALL". When the install options appear, choose "On the network". 4\. Once you see the logs showing the new update interval of 10 seconds the flash has succeeded and you can click "STOP" to exit. - + Your Temperature Probe will now report at the new interval. diff --git a/docs/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/products/temp1/troubleshooting/temp1-boot-mode.md index 57cebc0484..b34bf40ebb 100755 --- a/docs/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/products/temp1/troubleshooting/temp1-boot-mode.md @@ -12,13 +12,13 @@ description: Step by step guide for putting The TEMP-1 In Boot Mode. 1\. Position the TEMP-1 so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. - + If you prefer, please remove the lid by gently prying up on the small slit by the top of the case. - + - + 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 TEMP-1 then let go of the button. @@ -32,6 +32,6 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Hold down the boot button (shown above), then press and release the reset button (shown below) while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1/troubleshooting/temp1-code/). \ No newline at end of file diff --git a/docs/products/temp1/troubleshooting/temp1-code.md b/docs/products/temp1/troubleshooting/temp1-code.md index 23d0998876..f493d06e72 100755 --- a/docs/products/temp1/troubleshooting/temp1-code.md +++ b/docs/products/temp1/troubleshooting/temp1-code.md @@ -20,23 +20,23 @@ If your device has already been connected to Home Assistant please in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1B will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temp1b/examples/temp1b-automation-examples.md b/docs/products/temp1b/examples/temp1b-automation-examples.md index 7f4d6b0bad..5448213591 100755 --- a/docs/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/products/temp1b/examples/temp1b-automation-examples.md @@ -12,11 +12,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -24,11 +24,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1B device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -36,11 +36,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1B reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -72,7 +72,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -80,11 +80,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1b device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -92,11 +92,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1B reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -127,122 +127,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/products/temp1b/setup/insert-battery.md b/docs/products/temp1b/setup/insert-battery.md index 88c0dbf2a2..2582aa8449 100755 --- a/docs/products/temp1b/setup/insert-battery.md +++ b/docs/products/temp1b/setup/insert-battery.md @@ -10,44 +10,44 @@ description: How to Insert Battery on TEMP-1B. 1\. Gently pry open the case lid as shown in the image below. - + - + 2\. Once the lid is removed either lift the PCB out or gently dump the pcb out by turning it upside down. - + - + 3\. Align the battery as shown in the image below. - + 4\. Insert the battery with the positive terminal facing the + sign. - + - + 5\. Begin reassembly by placing the battery side down with the RGB led in the top right corner. - + - + 6\. You will use the "ledge" of the case to set the PCB down and then it will lay down and rest on the ledge of the other side as well. - + - + 7\. Align the RGB led in the top right with the small hole in the lid. - + 8\. Gently press down until it the lid seats. - + 9 You have now installed or reinstalled the battery! \ No newline at end of file diff --git a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md index 231835f4c2..4027f9365b 100755 --- a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md +++ b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md @@ -12,13 +12,13 @@ description: Step by step guide for putting The TEMP-1B In Boot Mode. 1\. Position the TEMP-1B so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. - + If you prefer, please remove the lid by gently prying up on the small slit by the top of the case. - + - + 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 TEMP-1B then let go of the button. @@ -32,6 +32,6 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Hold down the boot button (shown above), then press and release the reset button (shown below) while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1b/troubleshooting/temp1b-code/). \ No newline at end of file diff --git a/docs/products/temp1b/troubleshooting/temp1b-code.md b/docs/products/temp1b/troubleshooting/temp1b-code.md index ec21ee2682..fc7993b017 100755 --- a/docs/products/temp1b/troubleshooting/temp1b-code.md +++ b/docs/products/temp1b/troubleshooting/temp1b-code.md @@ -20,7 +20,7 @@ If your device has already been connected to Home Assistant please in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temppro1/examples/temp1-automation-examples.md b/docs/products/temppro1/examples/temp1-automation-examples.md index dbb0f7bd5f..507a0b3ff2 100755 --- a/docs/products/temppro1/examples/temp1-automation-examples.md +++ b/docs/products/temppro1/examples/temp1-automation-examples.md @@ -12,11 +12,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -24,11 +24,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -36,11 +36,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -72,7 +72,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -80,11 +80,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -92,11 +92,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -127,122 +127,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md index 71f2a9cfa4..ccbf87f961 100755 --- a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md +++ b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md @@ -12,11 +12,11 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. 1\. Position the TEMP Pro-1 so that the USB-C port is facing you. Remove the lid by gently prying up on the small slit by the top of the case. - + 2\. Locate the boot button as show in the image below. - + 3\. 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 TEMP Pro-1 then let go of the button. @@ -30,6 +30,6 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. 3\. Hold down the boot button (shown above), then press and release the reset button (shown below) while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temppro1/troubleshooting/temp-pro1-code/). \ No newline at end of file diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-code.md b/docs/products/temppro1/troubleshooting/temp-pro1-code.md index 7e4e7cf504..dd0b9f3746 100755 --- a/docs/products/temppro1/troubleshooting/temp-pro1-code.md +++ b/docs/products/temppro1/troubleshooting/temp-pro1-code.md @@ -16,23 +16,23 @@ If your device has already been connected to Home Assistant please - 1\. Gently pry open the case lid as shown in the image below. - + 2\. The teardown is complete! \ No newline at end of file From d7e5a0b21030f7629389229ebaa32b99588ea0f5 Mon Sep 17 00:00:00 2001 From: Justin Bunton <130115204+Bunton33@users.noreply.github.com> Date: Mon, 12 Oct 2026 06:27:58 -0400 Subject: [PATCH 2/4] docs: fix typos, grammar, and product and brand name casing One copy-edit pass over all 710 pages, clear errors only (no rewording for style, no technical changes). An independent reviewer per chunk checked every changed hunk against HEAD. - 151 typos (e.g. "sumamry", "Presense", "recieve"), 94 grammar fixes (e.g. "set up" as a verb, "comes", sentence capitals), 7 British to US spellings. - 43 product ID slips (Air-1, temp-1, btn-1, R-Pro-1 -> AIR-1, TEMP-1, BTN-1, R PRO-1) and 191 brand casing slips (esphome, home assistant, WiFi, Github, Youtuber, usb-c, bluetooth -> ESPHome, Home Assistant, Wi-Fi, GitHub, YouTuber, USB-C, Bluetooth). Wi-Fi is the dominant form in the repo (256 vs 64). - Untouched by design: code, YAML, URLs, entity IDs, hostnames, hotspot and device-reported names, on-screen labels, external video titles, and all numbers. A script checked every file against HEAD for this. Co-Authored-By: Claude Opus 5.5
---
docs/_snippets/bluetooth-proxy/intro.md | 2 +-
docs/homey.md | 2 +-
.../air1/addons/adding-co2-to-air-1.md | 2 +-
.../addons/adding-gpio-header-to-air-1.md | 2 +-
docs/homey/products/air1/air1-reviews.md | 2 +-
.../air-quality-notification-example.md | 4 +--
.../air1/troubleshooting/air1-code.md | 2 +-
.../co2-calibration.md | 2 +-
.../calibrating-and-updating/mmwave-videos.md | 6 ++--
docs/homey/products/general/comparisons.md | 2 +-
docs/homey/products/general/links.md | 2 +-
.../mmwave-presence-sensor-comparison.md | 2 +-
...dding-apollo-devices-to-hidden-networks.md | 2 +-
.../products/general/setup/getting-started.md | 6 ++--
...ubiquiti-unifi-mdns-auto-discover-issue.md | 2 +-
.../high-co2-notification-example.md | 4 +--
.../adding-articulating-stand-to-msr-2.md | 4 +--
.../addons/adding-rear-female-usb-to-msr-2.md | 2 +-
.../products/msr2/addons/msr2-outlet-mount.md | 4 +--
.../products/msr2/examples/msr2-alarmo.md | 4 +--
.../products/msr2/examples/msr2-dashboards.md | 2 +-
.../msr2/examples/using-msr-2-buzzer.md | 4 +--
docs/homey/products/msr2/faq.md | 6 ++--
docs/homey/products/msr2/msr2-reviews.md | 2 +-
.../products/msr2/setup/mmwave-videos.md | 2 +-
.../addons/adding-90-degree-usb-c-to-mtr-1.md | 2 +-
...mtr-1-home-assistant-dashboard-examples.md | 2 +-
.../products/mtr1/examples/mtr1-alarmo.md | 2 +-
.../mtr1/examples/using-mtr-1-buzzer.md | 4 +--
docs/homey/products/mtr1/faq.md | 4 +--
docs/homey/products/mtr1/mtr1-reviews.md | 2 +-
.../homey/products/mtr1/setup/general-tips.md | 4 +--
.../mtr-1-temperature-&-humidity-offsets.md | 6 ++--
docs/homey/products/mtr1/setup/zones-hlk.md | 2 +-
docs/homey/products/plt1/faq.md | 6 ++--
docs/homey/products/plt1/reviews.md | 2 +-
.../products/plt1/setup/prevent-sleep.md | 2 +-
.../plt1/troubleshooting/plt1-code.md | 2 +-
docs/homey/products/plt1b/faq.md | 6 ++--
docs/homey/products/plt1b/reviews.md | 2 +-
.../products/plt1b/setup/prevent-sleep.md | 2 +-
.../plt1b/troubleshooting/plt1b-code.md | 4 +--
...add-the-ld2412-mmwave-sensor-to-r-pro-1.md | 2 +-
.../rpro1/addons/adding-co2-to-r-pro-1.md | 2 +-
.../attaching-gang-box-mount-to-r-pro-1.md | 2 +-
docs/homey/products/rpro1/faq.md | 2 +-
docs/homey/products/rpro1/introduction.md | 2 +-
docs/homey/products/rpro1/rpro1-reviews.md | 2 +-
docs/homey/products/rpro1/setup/zones-hlk.md | 6 ++--
.../products/temp1/addons/magnetic-mount.md | 2 +-
.../temp1/examples/temp1-alert-example.md | 6 ++--
.../examples/temp1-automation-examples.md | 22 +++++++--------
docs/homey/products/temp1/faq.md | 4 +--
docs/homey/products/temp1/reviews.md | 2 +-
.../products/temp1/setup/prevent-sleep.md | 2 +-
.../temp1/troubleshooting/temp1-code.md | 2 +-
.../temp1/troubleshooting/temp1-teardown.md | 2 +-
.../products/temp1b/addons/magnetic-mount.md | 2 +-
.../temp1b/examples/temp1b-alert-example.md | 6 ++--
.../examples/temp1b-automation-examples.md | 18 ++++++------
docs/homey/products/temp1b/faq.md | 6 ++--
docs/homey/products/temp1b/reviews.md | 2 +-
.../products/temp1b/setup/insert-battery.md | 2 +-
.../products/temp1b/setup/prevent-sleep.md | 2 +-
.../temp1b/troubleshooting/temp1b-code.md | 2 +-
.../temp1b/troubleshooting/temp1b-teardown.md | 2 +-
docs/index.md | 2 +-
.../device-builder-tour.md | 2 +-
.../learning-the-basics/what-is-yaml.md | 2 +-
.../modules/apollo-breakout-module.md | 2 +-
.../modules/button-module.md | 4 +--
.../modules/motion-module.md | 2 +-
.../modules/rgb-buzzer-module.md | 4 +--
.../modules/temperature-humidity-module.md | 2 +-
.../ESPHome-Starter-Kit/setup/first-steps.md | 2 +-
.../tutorials/bluetooth-proxy.md | 2 +-
.../tutorials/light-effects.md | 2 +-
.../addons/adding-gpio-header-to-air-1.md | 2 +-
docs/products/air1/air1-reviews.md | 2 +-
.../air1/examples/air1-dashboard-examples.md | 4 +--
.../air1/examples/firstof9's-apex-charts.md | 4 +--
docs/products/air1/faq.md | 6 ++--
docs/products/air1/introduction.md | 2 +-
.../air1/troubleshooting/air1-code.md | 2 +-
docs/products/apolloodroid/faq.md | 2 +-
docs/products/apolloodroid/getting-started.md | 2 +-
.../btn1/examples/example-automation.md | 4 +--
docs/products/btn1/faq.md | 2 +-
docs/products/btn1/setup/getting-started.md | 14 +++++-----
.../btn1/troubleshooting/btn1-reflash.md | 2 +-
docs/products/cast1/setup/getting-started.md | 2 +-
.../cast1/troubleshooting/cast1-reflash.md | 2 +-
docs/products/dev2/introduction.md | 2 +-
.../battery-sensors/awake-ha-helper.md | 4 +--
.../general/battery-sensors/prevent-sleep.md | 2 +-
.../co2-calibration-quick.md | 2 +-
.../co2-calibration.md | 2 +-
.../calibrating-and-updating/mmwave-videos.md | 6 ++--
docs/products/general/comparisons.md | 4 +--
docs/products/general/faq.md | 8 +++---
docs/products/general/links.md | 2 +-
.../mmwave-presence-sensor-comparison.md | 4 +--
docs/products/general/piezo.md | 4 +--
...dding-apollo-devices-to-hidden-networks.md | 4 +--
.../general/setup/adjusting-wifi-power.md | 14 +++++-----
.../change-the-update-frequency-of-sensors.md | 2 +-
.../products/general/setup/getting-started.md | 16 +++++------
...how-to-add-temp-and-humidity-from-scd40.md | 2 +-
.../general/setup/renaming-apollo-devices.md | 6 ++--
.../general/setup/switch-to-beta-branch.md | 8 +++---
docs/products/general/temp-hum-calibration.md | 6 ++--
.../troubleshooting/connection-issues.md | 8 +++---
.../firmware-updates-not-appearing.md | 2 +-
.../removing-device-from-home-assistant.md | 2 +-
...ubiquiti-unifi-mdns-auto-discover-issue.md | 12 ++++----
.../tutorials/change-co2-update-interval.md | 2 +-
...-edit-your-sensor's-lux-update-interval.md | 4 +--
.../tutorials/smartthings-direct-control.md | 8 +++---
docs/products/h1/faq.md | 6 ++--
docs/products/h1/reflash.md | 4 +--
docs/products/h2/faq.md | 6 ++--
docs/products/h2/introduction.md | 2 +-
docs/products/h2/troubleshooting/reflash.md | 2 +-
docs/products/h3/introduction.md | 2 +-
docs/products/h3/troubleshooting/reflash.md | 2 +-
.../led-1-controlling-govee-lights.md | 2 +-
.../led1/setup/getting-started-led1.md | 2 +-
docs/products/led1/setup/led1-replace-fuse.md | 2 +-
.../led1/troubleshooting/led1-reflash.md | 4 +--
docs/products/m1/examples/add-gifs-to-wled.md | 6 ++--
.../products/m1/examples/qr-code-generator.md | 2 +-
docs/products/m1/examples/scrolling-text.md | 2 +-
docs/products/m1/examples/sendspin.md | 6 ++--
docs/products/m1/faq.md | 4 +--
.../m1/setup/getting-started-m1-esphome.md | 4 +--
docs/products/m1/setup/getting-started-m1.md | 4 +--
docs/products/m1/setup/m1-matrix-settings.md | 2 +-
docs/products/m1/setup/m1-multiple-panels.md | 28 +++++++++----------
docs/products/m1/setup/m1-segments.md | 2 +-
docs/products/m1/setup/use-without-wifi.md | 2 +-
.../m1-find-ip-address-and-hostname.md | 2 +-
.../m1/troubleshooting/m1-panel-faults.md | 2 +-
.../msr1/additional-info/exposed-gpio.md | 2 +-
.../msr1/addons/adding-co2-to-msr-1.md | 2 +-
docs/products/msr1/examples/msr1-alarmo.md | 2 +-
.../products/msr1/examples/msr1-dashboards.md | 2 +-
.../msr1/examples/using-msr-1-buzzer.md | 4 +--
docs/products/msr1/faq.md | 2 +-
docs/products/msr1/setup/general-tips.md | 2 +-
docs/products/msr1/setup/mmwave-videos.md | 2 +-
.../msr1/troubleshooting/msr1-code.md | 2 +-
.../addons/adding-90-degree-usb-c-to-msr-2.md | 2 +-
.../adding-articulating-stand-to-msr-2.md | 4 +--
.../msr2/addons/adding-co2-to-msr-2.md | 2 +-
.../addons/adding-rear-female-usb-to-msr-2.md | 4 +--
.../products/msr2/addons/msr2-outlet-mount.md | 4 +--
docs/products/msr2/examples/msr2-alarmo.md | 4 +--
docs/products/msr2/faq.md | 6 ++--
docs/products/msr2/msr2-reviews.md | 2 +-
docs/products/msr2/setup/mmwave-videos.md | 2 +-
docs/products/msr2/setup/msr2-general-tips.md | 2 +-
.../msr2/setup/msr2-tuning-dashboard.md | 4 +--
docs/products/msr2/setup/zones-ha.md | 2 +-
.../msr2/troubleshooting/msr2-code.md | 2 +-
.../addons/adding-90-degree-usb-c-to-mtr-1.md | 2 +-
.../mtr1/addons/adding-co2-to-mtr-1.md | 2 +-
docs/products/mtr1/examples/mtr1-alarmo.md | 4 +--
docs/products/mtr1/faq.md | 4 +--
docs/products/mtr1/introduction.md | 2 +-
docs/products/mtr1/mtr1-reviews.md | 2 +-
docs/products/mtr1/setup/general-tips.md | 4 +--
docs/products/mtr1/setup/zones-hlk.md | 4 +--
.../mtr1/troubleshooting/mtr1-code.md | 2 +-
.../productname-reviews.md | 2 +-
.../setup/productname-general-tips.md | 2 +-
.../troubleshooting/productname-reflash.md | 2 +-
.../troubleshooting/productname-teardown.md | 2 +-
docs/products/plt1/faq.md | 6 ++--
docs/products/plt1/introduction.md | 2 +-
docs/products/plt1/reviews.md | 2 +-
docs/products/plt1/setup/prevent-sleep.md | 2 +-
.../plt1/troubleshooting/plt1-code.md | 2 +-
docs/products/plt1b/faq.md | 12 ++++----
docs/products/plt1b/introduction.md | 2 +-
docs/products/plt1b/reviews.md | 2 +-
.../plt1b/troubleshooting/plt1b-code.md | 4 +--
.../pump1/setup/pump1-general-tips.md | 2 +-
.../pump1/troubleshooting/pump1-reflash.md | 2 +-
.../pump1/troubleshooting/pump1-teardown.md | 2 +-
...add-the-ld2412-mmwave-sensor-to-r-pro-1.md | 8 +++---
.../rpro1/addons/adding-co2-to-r-pro-1.md | 4 +--
.../attaching-gang-box-mount-to-r-pro-1.md | 6 ++--
docs/products/rpro1/calibrating-co2.md | 2 +-
docs/products/rpro1/faq.md | 14 +++++-----
docs/products/rpro1/introduction.md | 2 +-
docs/products/rpro1/rpro1-reviews.md | 4 +--
.../rpro1/setup/rpro1-general-tips.md | 2 +-
.../rpro1/setup/rpro1-switch-firmware.md | 8 +++---
docs/products/rpro1/setup/zones-ha-new.md | 6 ++--
docs/products/rpro1/setup/zones-ha.md | 6 ++--
docs/products/rpro1/setup/zones-hlk.md | 8 +++---
.../rpro1/troubleshooting/rpro1-code.md | 2 +-
.../rpro1/troubleshooting/rpro1-teardown.md | 2 +-
.../temp1/examples/temp1-alert-example.md | 6 ++--
.../examples/temp1-automation-examples.md | 22 +++++++--------
docs/products/temp1/faq.md | 10 +++----
docs/products/temp1/introduction.md | 2 +-
docs/products/temp1/reviews.md | 2 +-
docs/products/temp1/setup/prevent-sleep.md | 2 +-
.../temp1/troubleshooting/temp1-code.md | 2 +-
.../temp1b/examples/temp1b-alert-example.md | 6 ++--
.../examples/temp1b-automation-examples.md | 20 ++++++-------
docs/products/temp1b/faq.md | 10 +++----
docs/products/temp1b/introduction.md | 2 +-
docs/products/temp1b/reviews.md | 2 +-
docs/products/temp1b/setup/insert-battery.md | 2 +-
.../temp1b/troubleshooting/temp1b-code.md | 2 +-
.../temppro1/examples/temp1-alert-example.md | 6 ++--
.../examples/temp1-automation-examples.md | 24 ++++++++--------
docs/products/temppro1/examples/use-cases.md | 2 +-
docs/products/temppro1/faq.md | 10 +++----
docs/products/temppro1/introduction.md | 2 +-
docs/products/temppro1/reviews.md | 2 +-
.../setup/temp-pro-1-sensor-definitions.md | 2 +-
.../troubleshooting/temp-pro1-boot-mode.md | 2 +-
.../troubleshooting/temp-pro1-code.md | 2 +-
226 files changed, 447 insertions(+), 447 deletions(-)
diff --git a/docs/_snippets/bluetooth-proxy/intro.md b/docs/_snippets/bluetooth-proxy/intro.md
index af75c962ca..de9441ed76 100644
--- a/docs/_snippets/bluetooth-proxy/intro.md
+++ b/docs/_snippets/bluetooth-proxy/intro.md
@@ -1 +1 @@
-This guide shows you how to make your Apollo device act as a "BLE Proxy" which lets Bluetooth devices talk back to home assistant using Apollo devices as the "next hop"!
+This guide shows you how to make your Apollo device act as a "BLE Proxy" which lets Bluetooth devices talk back to Home Assistant using Apollo devices as the "next hop"!
diff --git a/docs/homey.md b/docs/homey.md
index b891397706..03b610a5ec 100755
--- a/docs/homey.md
+++ b/docs/homey.md
@@ -29,7 +29,7 @@ description: Guide to integrating Apollo Automation devices with the Homey smart
* [Understanding your AIR-1 and the various sensors it exposes](https://wiki.apolloautomation.com/products/air1/setup/general-tips/)
* [How to re-calibrate your CO2 sensor](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/)
* [Put your Apollo devices to sleep!](https://wiki.apolloautomation.com/products/general/battery-sensors/prevent-sleep/)
-* [Setup your new M-1 LED Matrix with Multiple Panels](https://wiki.apolloautomation.com/products/m1/setup/m1-multiple-panels/)
+* [Set up your new M-1 LED Matrix with Multiple Panels](https://wiki.apolloautomation.com/products/m1/setup/m1-multiple-panels/)
* [3D Print your own case in any color or material](https://wiki.apolloautomation.com/products/general/links/)
-1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on the name of your new device!
+1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on the name of your new device!
2\. Scroll down to the Configuration section.
@@ -45,7 +45,7 @@ How to tune the mmWave sensor using radar engineering mode.
-!!! quote "Quote from popular Youtuber Make It Work Tech"
+!!! quote "Quote from popular YouTuber Make It Work Tech"
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. - MakeItWorkTech
diff --git a/docs/homey/products/general/comparisons.md b/docs/homey/products/general/comparisons.md
index 24a61fd578..fbbbc366d5 100755
--- a/docs/homey/products/general/comparisons.md
+++ b/docs/homey/products/general/comparisons.md
@@ -1,4 +1,4 @@
---
-description: "mmWave Presense Sensor Comparison Chart."
+description: "mmWave Presence Sensor Comparison Chart."
---
--8<-- "products/general/comparisons.md:5:"
\ No newline at end of file
diff --git a/docs/homey/products/general/links.md b/docs/homey/products/general/links.md
index 2d2812dcc3..35b4590933 100755
--- a/docs/homey/products/general/links.md
+++ b/docs/homey/products/general/links.md
@@ -1,4 +1,4 @@
---
-description: "Links to our github, printables, and discord!"
+description: "Links to our GitHub, printables, and discord!"
---
--8<-- "products/general/links.md:5:"
\ No newline at end of file
diff --git a/docs/homey/products/general/mmwave-presence-sensor-comparison.md b/docs/homey/products/general/mmwave-presence-sensor-comparison.md
index a2ebbc2ed5..f4f1862367 100755
--- a/docs/homey/products/general/mmwave-presence-sensor-comparison.md
+++ b/docs/homey/products/general/mmwave-presence-sensor-comparison.md
@@ -1,4 +1,4 @@
---
-description: "mmWave Presense Sensor Comparison Chart."
+description: "mmWave Presence Sensor Comparison Chart."
---
--8<-- "products/general/mmwave-presence-sensor-comparison.md:5:"
\ No newline at end of file
diff --git a/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md b/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md
index a4883721a1..0a5d7373cd 100755
--- a/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md
+++ b/docs/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md
@@ -4,7 +4,7 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks.
---
# Adding Apollo Devices To Hidden Networks
-1\. Open the Esphome Device Builder.
+1\. Open the ESPHome Device Builder.
diff --git a/docs/homey/products/general/setup/getting-started.md b/docs/homey/products/general/setup/getting-started.md
index 09a1e77c33..7d0283e2a2 100755
--- a/docs/homey/products/general/setup/getting-started.md
+++ b/docs/homey/products/general/setup/getting-started.md
@@ -11,15 +11,15 @@ To get your new Apollo sensor connected to your Wi-Fi, follow the steps below!
1\. Plug the sensor into a quality power brick. They require 5v and under an amp so most phone chargers will be fine. ESP devices are sensitive to power fluctuations and users have had some issues with really cheap power bricks. If your device is restarting or unavailable please try a different power brick.
-2\. On your phone or PC, open the WiFi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the WiFi network to show up.
+2\. On your phone or PC, open the Wi-Fi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the Wi-Fi network to show up.
-3\. Once connected it should automatically open a dashboard for your sensor
+3\. Once connected it should automatically open a dashboard for your sensor.
If this does not automatically open the dashboard, please open your web browser and go to [http://192.168.4.1](http://192.168.4.1)
-4\. Select the WiFi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**".
+4\. Select the Wi-Fi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**".
diff --git a/docs/homey/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md b/docs/homey/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
index c3970305b9..2edaa97c12 100755
--- a/docs/homey/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
+++ b/docs/homey/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
@@ -1,4 +1,4 @@
---
-description: "Tutorial to help fix the Ubiquiti Unifi mDNS Auto Discover Issue."
+description: "Tutorial to help fix the Ubiquiti UniFi mDNS Auto Discover Issue."
---
--8<-- "products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md:5:"
\ No newline at end of file
diff --git a/docs/homey/products/general/tutorials/high-co2-notification-example.md b/docs/homey/products/general/tutorials/high-co2-notification-example.md
index 4ae4f55223..9712409f3c 100755
--- a/docs/homey/products/general/tutorials/high-co2-notification-example.md
+++ b/docs/homey/products/general/tutorials/high-co2-notification-example.md
@@ -31,7 +31,7 @@ description: Example flow for sending alerts when CO₂ levels exceed a defined
-7\. Duplicate steps 4 and 5 above but this time select "CO2 becomes less than" and place it on your flow canvas.Make sure to fill in your less than ppm value such as 1000.
+7\. Duplicate steps 4 and 5 above but this time select "CO2 becomes less than" and place it on your flow canvas. Make sure to fill in your less than ppm value such as 1000.
@@ -39,7 +39,7 @@ description: Example flow for sending alerts when CO₂ levels exceed a defined
-9\. Draw a line to connect "CO2 becomes greater than 999 ppm. Click the 3 dots and select a color - we have chosen red to indicate a problem.
+9\. Draw a line to connect "CO2 becomes greater than 999 ppm". Click the 3 dots and select a color - we have chosen red to indicate a problem.
diff --git a/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md b/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md
index 11cc148f3d..6f85e42a2a 100755
--- a/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md
+++ b/docs/homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md
@@ -1,6 +1,6 @@
---
-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.
+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
diff --git a/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md b/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
index d3f5f354db..b5cc63f3ac 100755
--- a/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
+++ b/docs/homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
@@ -1,5 +1,5 @@
---
-description: "Tutorial on adding 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
diff --git a/docs/homey/products/msr2/addons/msr2-outlet-mount.md b/docs/homey/products/msr2/addons/msr2-outlet-mount.md
index 4f4b5ae51b..c755968409 100755
--- a/docs/homey/products/msr2/addons/msr2-outlet-mount.md
+++ b/docs/homey/products/msr2/addons/msr2-outlet-mount.md
@@ -4,7 +4,7 @@ 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.
+1\. Gather a top facing USB-C plug, an MSR-2, and our MSR-2 Outlet Mount.
@@ -12,7 +12,7 @@ description: Tutorial for using the MSR-2 Outlet Mount.
-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.
+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.
diff --git a/docs/homey/products/msr2/examples/msr2-alarmo.md b/docs/homey/products/msr2/examples/msr2-alarmo.md
index 21806af6b8..6db6a604ed 100755
--- a/docs/homey/products/msr2/examples/msr2-alarmo.md
+++ b/docs/homey/products/msr2/examples/msr2-alarmo.md
@@ -1,5 +1,5 @@
---
-description: "A tutorial for how To use the MSR-2 with Alarmo for an advanced DIY alarm system."
+description: "A tutorial for how to use the MSR-2 with Alarmo for an advanced DIY alarm system."
---
# MSR-2 + Alarmo Home Security Install
@@ -24,7 +24,7 @@ My grandmother wanted a security system that would alert her when there was move
-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.
+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. Under Entity select your sensors RGB light.
diff --git a/docs/homey/products/msr2/examples/msr2-dashboards.md b/docs/homey/products/msr2/examples/msr2-dashboards.md
index ecf56115fd..60362ec128 100755
--- a/docs/homey/products/msr2/examples/msr2-dashboards.md
+++ b/docs/homey/products/msr2/examples/msr2-dashboards.md
@@ -70,7 +70,7 @@ refresh_interval: 10
title: Bedroom CO2
```
-Home Assistant Guage
+Home Assistant Gauge
diff --git a/docs/homey/products/msr2/examples/using-msr-2-buzzer.md b/docs/homey/products/msr2/examples/using-msr-2-buzzer.md
index c95afbb076..16cc491ad1 100755
--- a/docs/homey/products/msr2/examples/using-msr-2-buzzer.md
+++ b/docs/homey/products/msr2/examples/using-msr-2-buzzer.md
@@ -13,7 +13,7 @@ This guide will walk you through using the buzzer on your MSR-2. You can also us
3\. Choose your MSR-2's buzzer (You can type in buzzer to find it easier)
-4\. Put a rtttl tone into the the string box
+4\. Put an rtttl tone into the string box
- - Mario: ```
smb:d=4,o=5,b=100:16e6,16e6,32p,8e6,16c6,8e6,8g6,8p,8g,8p,8c6,16p,8g,16p,8e,16p,8a,8b,16a#,8a,16g.,16e6,16g6,8a6,16f6,8g6,8e6,16c6,16d6,8b,16p,8c6,16p,8g,16p,8e,16p,8a,8b,16a#,8a,16g.,16e6,16g6,8a6,16f6,8g6,8e6,16c6,16d6,8b,8p,16g6,16f#6,16f6,16d#6,16p,16e6,16p,16g#,16a,16c6,16p,16a,16c6,16d6,8p,16g6,16f#6,16f6,16d#6,16p,16e6,16p,16c7,16p,16c7,16c7,p,16g6,16f#6,16f6,16d#6,16p,16e6,16p,16g#,16a,16c6,16p,16a,16c6,16d6,8p,16d#6,8p,16d6,8p,16c6
@@ -25,7 +25,7 @@ This guide will walk you through using the buzzer on your MSR-2. You can also us
StarWars/Imp:d=4,o=5,b=112:8d.,16p,8d.,16p,8d.,16p,8a#4,16p,16f,8d.,16p,8a#4,16p,16f,d.,8p,8a.,16p,8a.,16p,8a.,16p,8a#,16p,16f,8c#.,16p,8a#4,16p,16f,d.,8p,8d.6,16p,8d,16p,16d,8d6,8p,8c#6,16p,16c6,16b,16a#,8b,8p,16d#,16p,8g#,8p,8g,16p,16f#,16f,16e,8f,8p,16a#4,16p,2c#
```
- Huge list: [https://picaxe.com/rtttl-ringtones-for-tune-command/](https://picaxe.com/rtttl-ringtones-for-tune-command/)
- - This is a good site to test rttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/)
+ - This is a good site to test rtttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/)
5\. Click on the ACTIONS button in bottom right
diff --git a/docs/homey/products/msr2/faq.md b/docs/homey/products/msr2/faq.md
index c0bca19eaf..10c5898420 100755
--- a/docs/homey/products/msr2/faq.md
+++ b/docs/homey/products/msr2/faq.md
@@ -27,7 +27,7 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor."
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.
+* The MSR-2 connects to your Home Assistant instance through ESPHome using Wi-Fi. 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?**
@@ -67,7 +67,7 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor."
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.
+* 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?**
@@ -91,7 +91,7 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor."
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.
+* Installation is straightforward, with the MSR-2 powered via USB-C and connecting to Home Assistant through Wi-Fi. 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?**
diff --git a/docs/homey/products/msr2/msr2-reviews.md b/docs/homey/products/msr2/msr2-reviews.md
index 484ee0b59d..78bb4b3e55 100755
--- a/docs/homey/products/msr2/msr2-reviews.md
+++ b/docs/homey/products/msr2/msr2-reviews.md
@@ -1,5 +1,5 @@
---
-description: "Youtuber reviews and feedback about the MSR-2 sensor from Apollo Automation."
+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)
diff --git a/docs/homey/products/msr2/setup/mmwave-videos.md b/docs/homey/products/msr2/setup/mmwave-videos.md
index 3945ce2d59..b651f38e90 100644
--- a/docs/homey/products/msr2/setup/mmwave-videos.md
+++ b/docs/homey/products/msr2/setup/mmwave-videos.md
@@ -1,4 +1,4 @@
---
-description: "Two short videos and a quick sumamry on how to best tune the LD2410B in the MSR-2!"
+description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2!"
---
--8<-- "homey/products/general/calibrating-and-updating/mmwave-videos.md"
diff --git a/docs/homey/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md b/docs/homey/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
index 390cb4a67a..660955f1b5 100755
--- a/docs/homey/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
+++ b/docs/homey/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
@@ -16,7 +16,7 @@ description: Step by step tutorial for adding 90 degree USB-C to MTR-1.
-4\. Gently push the connector into one of the top usb-c ports.
+4\. Gently push the connector into one of the top USB-C ports.
diff --git a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md b/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md
index 61e938d299..dfcdab55bb 100755
--- a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md
+++ b/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md
@@ -70,7 +70,7 @@ refresh_interval: 10
title: Bedroom CO2
```
-Home Assistant Guage
+Home Assistant Gauge
diff --git a/docs/homey/products/mtr1/examples/mtr1-alarmo.md b/docs/homey/products/mtr1/examples/mtr1-alarmo.md
index 21b498137c..7dfdb31866 100755
--- a/docs/homey/products/mtr1/examples/mtr1-alarmo.md
+++ b/docs/homey/products/mtr1/examples/mtr1-alarmo.md
@@ -24,7 +24,7 @@ My grandmother wanted a security system that would alert her when there was move
-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.
+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. Under Entity select your sensors RGB light.
diff --git a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md
index 8b36c5f29e..1ce165353a 100755
--- a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md
+++ b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md
@@ -13,7 +13,7 @@ This guide will walk you through using the buzzer on your MTR-1. You can also us
3\. Choose your MTR-1's buzzer (You can type in buzzer to find it easier)
-4\. Put a rtttl tone into the the string box
+4\. Put an rtttl tone into the string box
- - Mario: ```
smb:d=4,o=5,b=100:16e6,16e6,32p,8e6,16c6,8e6,8g6,8p,8g,8p,8c6,16p,8g,16p,8e,16p,8a,8b,16a#,8a,16g.,16e6,16g6,8a6,16f6,8g6,8e6,16c6,16d6,8b,16p,8c6,16p,8g,16p,8e,16p,8a,8b,16a#,8a,16g.,16e6,16g6,8a6,16f6,8g6,8e6,16c6,16d6,8b,8p,16g6,16f#6,16f6,16d#6,16p,16e6,16p,16g#,16a,16c6,16p,16a,16c6,16d6,8p,16g6,16f#6,16f6,16d#6,16p,16e6,16p,16c7,16p,16c7,16c7,p,16g6,16f#6,16f6,16d#6,16p,16e6,16p,16g#,16a,16c6,16p,16a,16c6,16d6,8p,16d#6,8p,16d6,8p,16c6
@@ -25,7 +25,7 @@ This guide will walk you through using the buzzer on your MTR-1. You can also us
StarWars/Imp:d=4,o=5,b=112:8d.,16p,8d.,16p,8d.,16p,8a#4,16p,16f,8d.,16p,8a#4,16p,16f,d.,8p,8a.,16p,8a.,16p,8a.,16p,8a#,16p,16f,8c#.,16p,8a#4,16p,16f,d.,8p,8d.6,16p,8d,16p,16d,8d6,8p,8c#6,16p,16c6,16b,16a#,8b,8p,16d#,16p,8g#,8p,8g,16p,16f#,16f,16e,8f,8p,16a#4,16p,2c#
```
- Huge list: [https://picaxe.com/rtttl-ringtones-for-tune-command/](https://picaxe.com/rtttl-ringtones-for-tune-command/)
- - This is a good site to test rttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/)
+ - This is a good site to test rtttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/)
5\. Click on the ACTIONS button in bottom right
diff --git a/docs/homey/products/mtr1/faq.md b/docs/homey/products/mtr1/faq.md
index 82560cb9b4..0ab8bced99 100755
--- a/docs/homey/products/mtr1/faq.md
+++ b/docs/homey/products/mtr1/faq.md
@@ -35,7 +35,7 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor."
9\. **How do I connect the MTR-1 to Home Assistant?**
-* The MTR-1 connects to Home Assistant through ESPHome using WiFi. Once connected, you can access data from all the sensors and create automations based on the sensor readings.
+* The MTR-1 connects to Home Assistant through ESPHome using Wi-Fi. Once connected, you can access data from all the sensors and create automations based on the sensor readings.
10\. **What kind of automations can I set up with the MTR-1?**
@@ -95,7 +95,7 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor."
24\. **How do I install the MTR-1?**
-* Installation is simple. The MTR-1 is powered via USB-C and connects to your WiFi. From there, you configure it through ESPHome and integrate it into your Home Assistant setup. Detailed instructions are available on our documentation wiki, and we offer support via our Discord community.
+* Installation is simple. The MTR-1 is powered via USB-C and connects to your Wi-Fi. From there, you configure it through ESPHome and integrate it into your Home Assistant setup. Detailed instructions are available on our documentation wiki, and we offer support via our Discord community.
25\. **How secure is the MTR-1?**
diff --git a/docs/homey/products/mtr1/mtr1-reviews.md b/docs/homey/products/mtr1/mtr1-reviews.md
index 18bd5105ed..0dbe31e433 100755
--- a/docs/homey/products/mtr1/mtr1-reviews.md
+++ b/docs/homey/products/mtr1/mtr1-reviews.md
@@ -1,5 +1,5 @@
---
-description: "Youtuber reviews and feedback about the MTR-1 sensor from Apollo Automation."
+description: "YouTuber reviews and feedback about the MTR-1 sensor from Apollo Automation."
---
# [Home Tech Innovations MTR-1 Review](https://youtu.be/q5GejbxnByA?si=PMgK4ro6U8Q7idCm)
diff --git a/docs/homey/products/mtr1/setup/general-tips.md b/docs/homey/products/mtr1/setup/general-tips.md
index 838cad3f4d..7c6b61eb27 100755
--- a/docs/homey/products/mtr1/setup/general-tips.md
+++ b/docs/homey/products/mtr1/setup/general-tips.md
@@ -32,11 +32,11 @@ The detection is 60 degrees from center on each side. So it is a cone when you a
##### **Increased ESP Temperature**
-If you are experiencing higher than normal ESP temperatures ~140+ degrees F then changing the wifi power save mode option might help decrease the temperature. Here is the link to the ESPHome WiFi Component [Power Save Mode](https://esphome.io/components/wifi.html#power-save-mode).
+If you are experiencing higher than normal ESP temperatures ~140+ degrees F then changing the Wi-Fi power save mode option might help decrease the temperature. Here is the link to the ESPHome WiFi Component [Power Save Mode](https://esphome.io/components/wifi.html#power-save-mode).
##### **Improve Wi-Fi Connection**
-The Wi-Fi interface of all ESP32 devices offer three power save modes to reduce the amount of power spent on Wi-Fi. While some options can reduce the power usage of the ESP, they generally also decrease the reliability of the Wi-Fi connection, with frequent disconnections from the router in the highest power saving mode. Switch to "none" to get the best Wi-Fi performance!
+The Wi-Fi interface of all ESP32 devices offers three power save modes to reduce the amount of power spent on Wi-Fi. While some options can reduce the power usage of the ESP, they generally also decrease the reliability of the Wi-Fi connection, with frequent disconnections from the router in the highest power saving mode. Switch to "none" to get the best Wi-Fi performance!
```yaml
wifi:
diff --git a/docs/homey/products/mtr1/setup/mtr-1-temperature-&-humidity-offsets.md b/docs/homey/products/mtr1/setup/mtr-1-temperature-&-humidity-offsets.md
index b55056f859..458d8ea29f 100755
--- a/docs/homey/products/mtr1/setup/mtr-1-temperature-&-humidity-offsets.md
+++ b/docs/homey/products/mtr1/setup/mtr-1-temperature-&-humidity-offsets.md
@@ -5,7 +5,7 @@ description: "Add temperature and humidity offsets to your MTR-1 so its readings
#### **Simple Offsets for Temperature and Humidity:**
-**Please add these to the bottom of your esphome yaml for your device then click save and install. Once you are finished, you will have two new boxes inside the home assistant esphome integration device page for your device where you can fill in an offset. Give them up to 1minute to take effect!**
+**Please add these to the bottom of your ESPHome yaml for your device then click save and install. Once you are finished, you will have two new boxes inside the Home Assistant ESPHome integration device page for your device where you can fill in an offset. Give them up to 1minute to take effect!**
```yaml
sensor:
@@ -54,11 +54,11 @@ The DPS310 and SCD40 sensors are known for their precision in measuring temperat
#### **Adjusting the DPS310 and SCD40 Temperature Offset**
-For users who want to fine-tune their sensors, the DPS310 and SCD40 Temperature Offset entities can be manually adjusted to match the conditions in their home. The offset values are subtracted from the raw temperature & humidity readings in the firmware to update the sensor readings in the home assistant entity. For example: scd40\_temperature entity = raw scd40 temperature reading - scd40\_offset.
+For users who want to fine-tune their sensors, the DPS310 and SCD40 Temperature Offset entities can be manually adjusted to match the conditions in their home. The offset values are subtracted from the raw temperature & humidity readings in the firmware to update the sensor readings in the Home Assistant entity. For example: scd40\_temperature entity = raw scd40 temperature reading - scd40\_offset.
By default, these offsets are preset to values based on our NIST certified thermometer, it's important to note that these values are calibrated for our environment. They might not be accurate for all settings. Therefore, by using a reference thermometer, users can adjust the difference between the readings to get a more accurate representation.
-Users will also notice the `dps310_temperature_calibrated`, `scd40_humidity_calibrated`, and `scd40_temperature_calibrated`entities. These values utilize the linear filter in the ESPHome firmware to adjust the readings based on our collected data. Again, due to environmental differences, these might not always be precise.
+Users will also notice the `dps310_temperature_calibrated`, `scd40_humidity_calibrated`, and `scd40_temperature_calibrated` entities. These values utilize the linear filter in the ESPHome firmware to adjust the readings based on our collected data. Again, due to environmental differences, these might not always be precise.
#### **Modeling the Relationship Between Sensors**
diff --git a/docs/homey/products/mtr1/setup/zones-hlk.md b/docs/homey/products/mtr1/setup/zones-hlk.md
index 9512e007ae..14ba096709 100755
--- a/docs/homey/products/mtr1/setup/zones-hlk.md
+++ b/docs/homey/products/mtr1/setup/zones-hlk.md
@@ -26,7 +26,7 @@ The YAML is on Github and our .STEP and .STL CAD files are available for community use.
+* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the PLT-1B. Our YAML is on GitHub and our .STEP and .STL CAD files are available for community use.
11\. **What are the RGB LED and piezo buzzer used for?**
diff --git a/docs/homey/products/plt1/reviews.md b/docs/homey/products/plt1/reviews.md
index 15427b6d8b..57c6dcd7c3 100755
--- a/docs/homey/products/plt1/reviews.md
+++ b/docs/homey/products/plt1/reviews.md
@@ -1,5 +1,5 @@
---
-description: "Youtuber reviews and feedback about the PLT-1 sensor from Apollo Automation."
+description: "YouTuber reviews and feedback about the PLT-1 sensor from Apollo Automation."
---
# [Simon Says Home Assistant PLT-1 Review](https://youtu.be/hocliw98_Gk?si=8TMFLD7xiYah1RmJ)
diff --git a/docs/homey/products/plt1/setup/prevent-sleep.md b/docs/homey/products/plt1/setup/prevent-sleep.md
index 7c97d5bd9a..209c26014c 100755
--- a/docs/homey/products/plt1/setup/prevent-sleep.md
+++ b/docs/homey/products/plt1/setup/prevent-sleep.md
@@ -5,7 +5,7 @@ description: "Tutorial for how to enable/disable prevent sleep."
!!! tip "Put your sensors to sleep!"
- All of our battery powered device are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements.
+ All of our battery powered devices are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements.
The temperature offsets needed will be much lower for your sensors as the microcontroller will not put off as much heat when it is sleeping and then waking for short periods to report the sensor values.
diff --git a/docs/homey/products/plt1/troubleshooting/plt1-code.md b/docs/homey/products/plt1/troubleshooting/plt1-code.md
index f0ddbe66b1..03c65cad4d 100755
--- a/docs/homey/products/plt1/troubleshooting/plt1-code.md
+++ b/docs/homey/products/plt1/troubleshooting/plt1-code.md
@@ -39,4 +39,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and setup your sensor as a new device!
\ No newline at end of file
+8\. Please proceed to the getting started guide and set up your sensor as a new device!
\ No newline at end of file
diff --git a/docs/homey/products/plt1b/faq.md b/docs/homey/products/plt1b/faq.md
index 1eebfb8c94..352cba525b 100755
--- a/docs/homey/products/plt1b/faq.md
+++ b/docs/homey/products/plt1b/faq.md
@@ -31,7 +31,7 @@ description: "PLT-1B FAQ."
8\. **How does the PLT-1B connect to Home Assistant?**
-* The PLT-1B connects via WiFi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant.
+* The PLT-1B connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant.
9\. **What kind of automations can I set up with the PLT-1B?**
@@ -43,7 +43,7 @@ description: "PLT-1B FAQ."
11\. **Can I customize the PLT-1B functionality?**
-* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the PLT-1B. Our YAML is on Github and our .STEP and .STL CAD files are available for community use.
+* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the PLT-1B. Our YAML is on GitHub and our .STEP and .STL CAD files are available for community use.
12\. **What are the RGB LED and piezo buzzer used for?**
@@ -79,7 +79,7 @@ description: "PLT-1B FAQ."
20\. **What’s the difference between the battery and non-battery versions?**
-* The PLT-1B is battery-operated (18650) and slightly larger, while the non-battery (NB) version is compact and requires USB-C power at 5 volts using 1amp or less (5W). They both have all of the same components for measuring soil moisture, air temp/humdity, lux/uv, etc.
+* The PLT-1B is battery-operated (18650) and slightly larger, while the non-battery (NB) version is compact and requires USB-C power at 5 volts using 1amp or less (5W). They both have all of the same components for measuring soil moisture, air temp/humidity, lux/uv, etc.
21\. **Can I use multiple PLT-1B sensors in one Home Assistant setup?**
diff --git a/docs/homey/products/plt1b/reviews.md b/docs/homey/products/plt1b/reviews.md
index 292c73f7fd..4b084d6c3d 100644
--- a/docs/homey/products/plt1b/reviews.md
+++ b/docs/homey/products/plt1b/reviews.md
@@ -1,4 +1,4 @@
---
-description: "Youtuber reviews and feedback about the PLT-1 sensor from Apollo Automation."
+description: "YouTuber reviews and feedback about the PLT-1 sensor from Apollo Automation."
---
--8<-- "homey/products/plt1/reviews.md"
diff --git a/docs/homey/products/plt1b/setup/prevent-sleep.md b/docs/homey/products/plt1b/setup/prevent-sleep.md
index c313b857d5..40b0e78488 100755
--- a/docs/homey/products/plt1b/setup/prevent-sleep.md
+++ b/docs/homey/products/plt1b/setup/prevent-sleep.md
@@ -5,7 +5,7 @@ description: "Keep the PLT-1B awake instead of letting it sleep, and what that c
!!! tip "Put your sensors to sleep!"
- All of our battery powered device are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements.
+ All of our battery powered devices are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements.
The temperature offsets needed will be much lower for your sensors as the microcontroller will not put off as much heat when it is sleeping and then waking for short periods to report the sensor values.
diff --git a/docs/homey/products/plt1b/troubleshooting/plt1b-code.md b/docs/homey/products/plt1b/troubleshooting/plt1b-code.md
index 0c2ea18589..37e0ad4420 100755
--- a/docs/homey/products/plt1b/troubleshooting/plt1b-code.md
+++ b/docs/homey/products/plt1b/troubleshooting/plt1b-code.md
@@ -29,7 +29,7 @@ If no device shows, click cancel and then install the recommended driver that sh
Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode!
-6\. Please proceed to the getting started guide and setup your sensor as a new device!
+6\. Please proceed to the getting started guide and set up your sensor as a new device!
# Factory Re-Flash PLT-1B
@@ -73,4 +73,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and setup your sensor as a new device!
\ No newline at end of file
+8\. Please proceed to the getting started guide and set up your sensor as a new device!
\ No newline at end of file
diff --git a/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md b/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md
index 7a7ed100d4..0697268a78 100644
--- a/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md
+++ b/docs/homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md
@@ -1,4 +1,4 @@
---
-description: "Tutorial on adding the LD2412 mmwave sensor to your R PRO-1"
+description: "Tutorial on adding the LD2412 mmWave sensor to your R PRO-1"
---
--8<-- "products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md:5:"
diff --git a/docs/homey/products/rpro1/addons/adding-co2-to-r-pro-1.md b/docs/homey/products/rpro1/addons/adding-co2-to-r-pro-1.md
index 24b490d1ba..ec2d6812f1 100644
--- a/docs/homey/products/rpro1/addons/adding-co2-to-r-pro-1.md
+++ b/docs/homey/products/rpro1/addons/adding-co2-to-r-pro-1.md
@@ -1,4 +1,4 @@
---
-description: "Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1."
+description: "Tutorial on adding the SCD40 CO2 sensor to your R PRO-1."
---
--8<-- "products/rpro1/addons/adding-co2-to-r-pro-1.md:5:"
diff --git a/docs/homey/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md b/docs/homey/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md
index 46d4d3dfa3..bb31a9f7f8 100644
--- a/docs/homey/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md
+++ b/docs/homey/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md
@@ -1,4 +1,4 @@
---
-description: "Tutorial on adding the gang box mounts to your R-Pro-1."
+description: "Tutorial on adding the gang box mounts to your R PRO-1."
---
--8<-- "products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md:5:"
diff --git a/docs/homey/products/rpro1/faq.md b/docs/homey/products/rpro1/faq.md
index 861272d0aa..ac0890cccd 100644
--- a/docs/homey/products/rpro1/faq.md
+++ b/docs/homey/products/rpro1/faq.md
@@ -1,4 +1,4 @@
---
-description: "Frequently asked questions about the R-Pro-1 PoE mmWave sensor."
+description: "Frequently asked questions about the R PRO-1 PoE mmWave sensor."
---
--8<-- "products/rpro1/faq.md:5:"
diff --git a/docs/homey/products/rpro1/introduction.md b/docs/homey/products/rpro1/introduction.md
index ff1a64064e..3691e5a466 100644
--- a/docs/homey/products/rpro1/introduction.md
+++ b/docs/homey/products/rpro1/introduction.md
@@ -1,4 +1,4 @@
---
-description: "Documentation for R-Pro-1, including setup, usage, and best practices."
+description: "Documentation for R PRO-1, including setup, usage, and best practices."
---
--8<-- "products/rpro1/introduction.md:5:"
diff --git a/docs/homey/products/rpro1/rpro1-reviews.md b/docs/homey/products/rpro1/rpro1-reviews.md
index 0bb99c88c6..fbc0fb7165 100644
--- a/docs/homey/products/rpro1/rpro1-reviews.md
+++ b/docs/homey/products/rpro1/rpro1-reviews.md
@@ -1,4 +1,4 @@
---
-description: "Youtuber reviews and feedback about the R-Pro-1 sensor from Apollo Automation."
+description: "YouTuber reviews and feedback about the R PRO-1 sensor from Apollo Automation."
---
--8<-- "products/rpro1/rpro1-reviews.md:5:"
diff --git a/docs/homey/products/rpro1/setup/zones-hlk.md b/docs/homey/products/rpro1/setup/zones-hlk.md
index b1c90dce45..0eea7225fd 100644
--- a/docs/homey/products/rpro1/setup/zones-hlk.md
+++ b/docs/homey/products/rpro1/setup/zones-hlk.md
@@ -1,5 +1,5 @@
---
-description: "Tutorial for R-Pro-1 HLKRadarTool app Zone Configuration."
+description: "Tutorial for R PRO-1 HLKRadarTool app Zone Configuration."
---
# How To Tune mmWave Using HLKRadarTool
@@ -41,7 +41,7 @@ The **Disabled**: Disable multi-zone area detection and just tracks one big area. Learn about Core Components
+ Learn about Core Components
### Test your LED
@@ -226,12 +226,12 @@ Your kit's default project includes the [**Web Server**](../learning-the-basics/
It should load your new device with the Onboard RGB LED listed. Click its toggle and the LED on your kit turns on and off.
-
+
The LED on the board, switching on and off.
-
+
- Back - Start Here Add More Modules Connect to Home Assistant
+ Back - Start Here Add More Modules Connect to Home Assistant
--8<-- "_snippets/community-help.md"
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/start-here.md b/docs/products/ESPHome-Starter-Kit/start-here.md
index 51c144ec95..c1bbae3e11 100755
--- a/docs/products/ESPHome-Starter-Kit/start-here.md
+++ b/docs/products/ESPHome-Starter-Kit/start-here.md
@@ -8,7 +8,7 @@ Welcome to the start of your ESPHome journey with the all-new **ESPHome Starter
[:material-cart: Buy the ESPHome Starter Kit](https://apolloautomation.com/products/esk-1-esphome-starter-kit){ .md-button .md-button--primary }
-
+
By the end of this wiki you'll know how to:
@@ -19,7 +19,7 @@ By the end of this wiki you'll know how to:
Your kit arrives as a single snap-apart panel that includes the ESP32-C6 along with a selection of interchangeable modules. The kit also includes three ribbon cables for connecting modules to the ESP32-C6, one more than any project uses at once so you always have a spare, plus a stand for the LED & Buzzer module.
-
+
## Snapping the panel apart
@@ -32,7 +32,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
1. Hold the panel flat on a table with one hand on the module you want to remove.
2. Gently flex the panel along the tab line until the tab snaps cleanly.
-
+
## Meet the modules
@@ -40,7 +40,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* The brain of every project you'll build with the kit. It handles Wi-Fi and Bluetooth, runs your ESPHome config, and exposes the GPIO pins the modules plug into.
-
+
---
@@ -48,7 +48,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* The starter kit's notification module, a strip of ten addressable RGB LEDs and a small piezo buzzer behind the ESPHome logo silkscreen. *Use the included stand to show it off!*
-
+
---
@@ -56,7 +56,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Detects movement in a room and a great way to get started automating your home. It comes in two parts, and the PIR sensor easily plugs into the PIR module board.
-
+
---
@@ -64,7 +64,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Premium feel button perfect to trigger automations for lights and more.
-
+
---
@@ -72,7 +72,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Extremely accurate temp and humidity sensor trustworthy enough to track a room comfort level with ease!
-
+
---
@@ -80,12 +80,12 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
* Each module connects to the ESP32-C6 through the FPC connector using one of the three provided cables. *Tear the brown paper bag open from one of the ends. Please DO NOT use scissors as you could accidentally cut the cables!*
-
+
## Next: bring it online
Once you've identified your modules and snapped them off the panel, the next step is to connect the ESP32-C6 to your computer and walk through your first ESPHome configuration.
- Next - First Steps
+ Next - First Steps
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
index d259103174..056d5df6c0 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
@@ -27,7 +27,7 @@ Device Builder has an **Add Component** flow that drops the proxy into your conf
3. Search for **Bluetooth Proxy** and select it.
4. Click **Add**. Device Builder inserts the proxy into your YAML.
-
+
??? note "Prefer to add it by hand? Here's the YAML"
@@ -59,7 +59,7 @@ The proxy is saved in Device Builder, but the device is still running its old so
3. Wait for the compile and flash to finish. The device reboots once the install is done.
-
+
## Verify it works
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
index e33db9d7f7..7ab6d10ac6 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
@@ -50,7 +50,7 @@ Open `secrets.yaml` in Device Builder, copy the `api_encryption_key` value, and
Want to understand what just happened under the hood? Read [the Home Assistant integration](../learning-the-basics/how-esphome-talks-to-home-assistant.md).
- Back - First Steps
+ Back - First Steps
--8<-- "_snippets/community-help.md"
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
index ee77db3961..c85162cc9d 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
@@ -32,7 +32,7 @@ Out of the box, your RGB module turns on, turns off, and changes color. ESPHome
6. Click **\+ Add** a second time and pick **Addressable Color Wipe**.
-
+
That gives the light two effects: a continuously cycling rainbow and a sweeping color wipe. Add as many as you like the same way, and click the **X** to the right of an effect's dropdown to drop one.
@@ -67,7 +67,7 @@ The effects are saved in Device Builder, but the device is still running its old
1. We say software because it's the friendlier word. The technically correct term is firmware: code that runs directly on the chip instead of on a computer. That's the word ESPHome's own docs use.
-
+
3\. Wait for the compile and flash to finish. The device reboots once the install is done.
@@ -75,9 +75,9 @@ The effects are saved in Device Builder, but the device is still running its old
With the device back online, open the local web page at `http://esphome-starter-kit.local/` (or whatever you named your device) in a browser on the same Wi-Fi network. Find the RGB light entity and pick **Rainbow** or **Color Wipe** from the **Effect** dropdown. The LEDs start animating right away.
-
+
-
+
If you've already followed [Connect to Home Assistant](/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md), the same **Effect** dropdown shows up on the light entity card in Home Assistant.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
index 95d5d545bd..01639ca630 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
@@ -32,7 +32,7 @@ Start on your Windows PC. This is the machine that will do the compiling.
1. **Paired senders**, just below the toggle, lists every dashboard allowed to send builds here. It stays empty until you pair one.
-
+
## Pair the Two Dashboards
@@ -56,7 +56,7 @@ On your Windows PC, open **Settings → Pairing requests**. It shows **Open** wi
3. **Pair request sent** appears with a row of emoji under **Your fingerprint**. Leave it on screen, you're about to compare it.
-
+
#### Accept It on Your PC
@@ -69,11 +69,11 @@ On your Windows PC, open **Settings → Pairing requests**. It shows **Open** wi
1. Accepting gives that dashboard code execution on your PC. Only accept a request you just sent yourself.
-
+
Back on the sending dashboard, your PC now sits under **Paired build servers** marked **Connected**. That's how you know it worked. The row reads **Pending** while it's waiting on you and flips over once you accept.
-
+
The line underneath tells you which ESPHome version the build server runs, and which one your builds will use. The two don't have to match. Device Builder installs whatever your sending dashboard is on and builds with that.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
index 0b4d65fa38..8b86f60707 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
@@ -24,7 +24,7 @@ In the ESPHome Device Builder dashboard, click the 3 dots menu in the top right
1. You'll see a YAML file with one key per line. If you followed First Steps you should already see `wifi_ssid` and `wifi_password` here.
-
+
---
@@ -66,7 +66,7 @@ The Device Builder can turn a value into a secret for you, no hand editing requi
The Device Builder moves the key into secrets.yaml and swaps the device YAML over to a `!secret` reference. You can now share your device YAML without exposing the key.
-
+
---
diff --git a/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md b/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md
index 25acdf420e..e5cf448355 100755
--- a/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md
+++ b/docs/products/air1/addons/adding-co2-to-air-1-mesh-case-design.md
@@ -6,7 +6,7 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
1\. Unplug your AIR-1 from power and remove the back
-
+
2\. At the bottom center there is a black connector. There is an x in the lower right corner of the connector
@@ -14,6 +14,6 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
4\. Align the connector on the back of the CO2 module with the connector on the AIR-1. Once aligned, push down so the CO2 module fully seats itself
-
+
5\. Put your AIR-1 cover on. 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.
\ No newline at end of file
diff --git a/docs/products/air1/addons/adding-co2-to-air-1.md b/docs/products/air1/addons/adding-co2-to-air-1.md
index bf82eeeee2..260ca6a9ae 100755
--- a/docs/products/air1/addons/adding-co2-to-air-1.md
+++ b/docs/products/air1/addons/adding-co2-to-air-1.md
@@ -10,34 +10,34 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
1\. Unplug your AIR-1 from power and lift the top of the case or "lid".
-
+
2\. Remove the lid completely by grabbing the lid from the other side and gently lifting upwards.
-
+
3\. Hold the PCB and orient it correctly where Apollo (the dog) is facing you in.
-
+
4\. Gently slide the pcb out by sliding it to the left as shown in the images below.
-
+
5\. Flip the PCB over and 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.
-
+
6\. Gently push the SCD40 CO2 module onto the black mezzanine connector.
-
+
7\. Gently slide the PCB back into the 3d printed case as shown below.
-
+
8\. Gently push the case back together as shown below.
-
+
9\. 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/air1/addons/adding-gpio-header-to-air-1.md b/docs/products/air1/addons/adding-gpio-header-to-air-1.md
index 8c95facd6b..df24502e58 100755
--- a/docs/products/air1/addons/adding-gpio-header-to-air-1.md
+++ b/docs/products/air1/addons/adding-gpio-header-to-air-1.md
@@ -6,35 +6,35 @@ description: Adding Optional GPIO Header to AIR-1.
1\. Unplug your AIR-1 from power and lift the top of the case or "lid".
-
+
2\. Remove the lid completely by grabbing the lid from the other side and gently lifting upwards.
-
+
3\. Hold the PCB and orient it correctly where Apollo (the dog) is facing you in.
-
+
4\. Gently slide the pcb out by sliding it to the left as shown in the images below.
-
+
5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below
-
+
6\. Match up the X on the PCB of the GPIO Header and the X on the AIR-1 PCB and then gently push the GPIO Header onto the black mezzanine connector.
-
+
7\. Flip the AIR-1 PCB over and gently slide it back into the new AIR-1 Lid which came with your GPIO Header addon! Please do not use much force, the PCB should slide in relatively smoothly, with a tiny bit of force needed. There are three channels in the plastic where the PCB slides into!
-
+
8\. Gently push the case back together as shown below.
-
+
9\. You are now done and your AIR-1 is now able to be used with the GPIO Header addon! Here is the pinout image below and here's a great wiki article showing you how to add a small led strip!
@@ -42,4 +42,4 @@ description: Adding Optional GPIO Header to AIR-1.
If you plan to use a lot of leds or your gpio project requires a lot of power then you need to use a dedicated power supply and not try to use too much power (under 350mA) from the GPIO of the device! You can power the AIR-1 via the vcc (5v) and GND pins but please do not power it via the pins AND the USB-C port, it should be one or the other.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md b/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
index 3d3ede92a3..e8e5ff2154 100755
--- a/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
+++ b/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
@@ -5,6 +5,6 @@ description: "Calibrate the AIR-1 temperature reading from its SEN55 to your roo
##### The AIR-1 uses the SEN55 for its temperature reading. Calibrating it to your environment is very similar to the MSR-1. See the link below for the temperature calibration guide.
-
+
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/air1/examples/air1-dashboard-examples.md b/docs/products/air1/examples/air1-dashboard-examples.md
index 41fe129dd2..14fe074c8c 100755
--- a/docs/products/air1/examples/air1-dashboard-examples.md
+++ b/docs/products/air1/examples/air1-dashboard-examples.md
@@ -6,7 +6,7 @@ description: AIR-1 Home Assistant Dashboard Examples
Really neat dashboard for your AIR-1 by user "keex"!
-
+
[https://community.home-assistant.io/t/apollo-air-1-dashboard/785311](https://community.home-assistant.io/t/apollo-air-1-dashboard/785311)
@@ -14,7 +14,7 @@ Really neat dashboard for your AIR-1 by user "keex"!
##### Home Assistant Sensor
-
+
```yaml
graph: line
@@ -27,7 +27,7 @@ hours_to_show: 24
#### Custom: Apexcharts Card
-
+
```yaml
type: custom:apexcharts-card
@@ -159,7 +159,7 @@ series:
##### Custom: Plotly Graph Card
-
+
```plaintext
type: custom:plotly-graph
@@ -172,7 +172,7 @@ title: Bedroom CO2
##### Home Assistant Guage
-
+
```plaintext
type: gauge
@@ -191,7 +191,7 @@ severity:
##### Home Assistant Sensor
-
+
```
graph: line
@@ -204,7 +204,7 @@ name: Basement VOC
##### Custom: Plotly Graph Card
-
+
```
type: custom:plotly-graph
@@ -217,7 +217,7 @@ title: Basement VOC
##### Home Assistant Guage
-
+
```
type: gauge
diff --git a/docs/products/air1/examples/firstof9's-apex-charts.md b/docs/products/air1/examples/firstof9's-apex-charts.md
index 2435d87fbc..81f0c53213 100755
--- a/docs/products/air1/examples/firstof9's-apex-charts.md
+++ b/docs/products/air1/examples/firstof9's-apex-charts.md
@@ -10,19 +10,19 @@ Firstof9 has created this beautiful responsive dashboard with [Apexcharts-card](
The colors will change as severity levels change for each of the sensors below.
-
+
This guide assumes you already have HACS installed. If you do not, please first [install HACS](https://hacs.xyz/docs/use/download/prerequisites/ "Install HACS").
First, you need to install apexcharts-card by going to the HACS tab and searching "apexcharts-card".
-
+
Once downloaded, it is ready to be used for dashboards!
Next, you need to edit the dashboards here.
-
+
!!! danger "WARNING YOU ARE ABOUT TO BE ABLE TO WIPE OUT ALL YOUR DASHBOARDS PROCEED WITH CAUTION."
@@ -30,21 +30,21 @@ Next, you need to edit the dashboards here.
Now choose "raw configuration editor"
-
+
Now you need to be VERY careful. You are editing all of your dashboards but we can avoid issues by scrolling to the very bottom and then copying and pasting the code seen below. (Picture below shows where we will paste the code) (Code below)
-
+
**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.
-
+
The easiest way to change all of the entity IDs in the code is by using AI (ChatGPT etc.) or by using a code editor like Visual Studio Code (VSC). In VSC you can Find (ctrl+f) the old ID and Replace (select the small arrow to toggle open the Replace box) it with your ID. Now you are ready to copy the code into the Raw configurator editor. (See code below)
VSC Find/Replace
-
+
**This is the code!**
@@ -491,14 +491,14 @@ VSC Find/Replace
Now click save in the top right and remember to not hit any buttons or make any other edits before saving!
-
+
Finally hit "done" in the top right.
-
+
Hit F5 on your keyboard or refresh your browser and then look for your new "Air Icon" as a new dashboard option and click on it!
-
+
Lastly, we do want to thank [firstof9](https://github.com/firstof9 "Thank firstof9") for creating this dashboard and sharing it.
\ No newline at end of file
diff --git a/docs/products/air1/setup/general-tips.md b/docs/products/air1/setup/general-tips.md
index 10b223ca9a..9e883b4332 100755
--- a/docs/products/air1/setup/general-tips.md
+++ b/docs/products/air1/setup/general-tips.md
@@ -152,11 +152,11 @@ The latest AIR-1 firmware keeps the SCD40 calibrated automatically. The sensor a
If your AIR-1 sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), automatic self-calibration will slowly drag the CO2 readings down. Turn off the **CO2 Auto Calibration** switch on the device page and follow the [manual calibration guide](../../general/calibrating-and-updating/co2-calibration.md) every 1 to 2 years instead.
-
+
Wisconsin Department of Health CO2 Level Chart
-
+
!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when CO2 is over 1000"
diff --git a/docs/products/air1/troubleshooting/air1-boot-mode.md b/docs/products/air1/troubleshooting/air1-boot-mode.md
index d896c384f4..9a88d2506d 100755
--- a/docs/products/air1/troubleshooting/air1-boot-mode.md
+++ b/docs/products/air1/troubleshooting/air1-boot-mode.md
@@ -12,7 +12,7 @@ description: Step by step guide for putting The AIR-1 In Boot Mode.
1\. Position the AIR-1 so that the USB-C port is facing you. On the left side of the USB-C port, locate a small opening to press the boot button (the right button).
-
+
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 AIR-1 then let go of the button.
@@ -26,6 +26,6 @@ description: Step by step guide for putting The AIR-1 In Boot Mode.
3\. Hold down the boot button, then press and release the reset button while keeping the boot button pressed. Finally, release the boot button.
-
+
4\. Continue with uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/air1/troubleshooting/air1-code.md b/docs/products/air1/troubleshooting/air1-code.md
index b764dc22dd..7c42086a17 100755
--- a/docs/products/air1/troubleshooting/air1-code.md
+++ b/docs/products/air1/troubleshooting/air1-code.md
@@ -12,29 +12,29 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. 1. Position the AIR-1 so that the USB-C port is facing you. On the left side of the USB-C port, locate a small opening to press the boot button (the right button).
-
+
2\. Navigate to our installer page and click connect under Battery Firmware Apollo AIR-1 Installer.
3\. Click the big "Connect" button.
-
+
4\. Select the open com port then click Connect.
-
+
5\. Click "Install ApolloAutomation.AIR-1".
-
+
6\. Click "INSTALL".
-
+
7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md b/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
index 30ef052e8e..6c9299ba09 100755
--- a/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
+++ b/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
@@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your AIR-
2\. Press and hold the Boot button for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/apolloodroid/getting-started.md b/docs/products/apolloodroid/getting-started.md
index cdf2fce7c4..17751d9985 100755
--- a/docs/products/apolloodroid/getting-started.md
+++ b/docs/products/apolloodroid/getting-started.md
@@ -17,13 +17,13 @@ This guide will walk you through setting up your Apollo Home Assistant hub aka t
If you'd prefer, you can go into your router and find the IP address that your Odroid received and use the IP address with port 8123 at the end such as: http://192.168.1.30:8123
-
+
-
+
4\. Click on "Create My Smart Home" and wait for the Home Assistant installer to finish.
-
+
5\. Now that you've got Home Assistant running, your Apollo Automation devices are ready to use!
diff --git a/docs/products/apolloodroid/introduction.md b/docs/products/apolloodroid/introduction.md
index 3db4919537..fdfe50b231 100755
--- a/docs/products/apolloodroid/introduction.md
+++ b/docs/products/apolloodroid/introduction.md
@@ -2,7 +2,7 @@
title: Apollo Odroid Introduction
description: The Apollo Odroid is a ready-to-use device designed to kickstart your smart home journey with ease.
---
-
+
The Apollo Odroid is a ready-to-use device designed to kickstart your smart home journey with ease. Built on the powerful ODROID-M1S platform with 8GB of RAM and 64GB of onboard eMMC storage, this unit comes pre-flashed with Home Assistant OS. This means that from the moment you unbox it, you can dive right into automating your home without any complex setup or flashing processes.
diff --git a/docs/products/breakout-boards/scd40-breakout-board/introduction.md b/docs/products/breakout-boards/scd40-breakout-board/introduction.md
index d61f4f08d0..e0ca2d5cad 100755
--- a/docs/products/breakout-boards/scd40-breakout-board/introduction.md
+++ b/docs/products/breakout-boards/scd40-breakout-board/introduction.md
@@ -2,13 +2,13 @@
title: Apollo SCD40 Breakout Board Introduction
description: Apollo SCD40 Breakout Board Introduction
---
-
+
The **SCD40 Breakout Board** is a compact PCB kit featuring the SCD40, making it easy to add CO2 monitoring to any new or existing project.
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md b/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
index 6e71912583..35601aebc6 100755
--- a/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
+++ b/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
@@ -2,13 +2,13 @@
title: Apollo SEN55 and SCD40 Breakout Board Introduction
description: Apollo SEN55 and SCD40 Breakout Board Introduction
---
-
+
The **SEN55 and SCD40 Breakout Board** is a compact PCB kit featuring the SEN55 sensor and an optional SCD40, making it easy to add high-quality air monitoring to any new or existing project.
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/btn1/examples/blueprint.md b/docs/products/btn1/examples/blueprint.md
index 4c1f76a644..d4c7c5c695 100755
--- a/docs/products/btn1/examples/blueprint.md
+++ b/docs/products/btn1/examples/blueprint.md
@@ -14,15 +14,15 @@ description: >-
2\. Click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation BTN-1 Blueprint** and click on **Select a device** then choose your **Apollo BTN-1** from the dropdown menu.
-
+
4\. For the **Single Click** event, click **Add Action**, then search for **Light: Toggle** and select it. Next, choose the entity you want to control, such as **BTN-1 Light**, and click **Save**. Name your automation something like **Apollo BTN-1 Blueprint**. You can repeat this process for **Double Click**, **Triple Click**, and **Hold** events.
-
+
!!! success "You can do this for all four buttons all in one blueprint!"
@@ -34,19 +34,19 @@ description: >-
1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**.
-
+
2\. Copy this link and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation BTN-1 Blueprint** and click on **Select a device** then choose your **Apollo BTN-1** from the dropdown menu.
-
+
3\. For the **Single Click** event, click **Add Action**, then search for **Light: Toggle** and select it. Next, choose the entity you want to control, such as **BTN-1 Light**, and click **Save**. Name your automation something like **Apollo BTN-1 Blueprint**. You can repeat this process for **Double Click**, **Triple Click**, and **Hold** events.
-
+
!!! success "You can do this for all four buttons all in one blueprint!"
diff --git a/docs/products/btn1/examples/example-automation.md b/docs/products/btn1/examples/example-automation.md
index 9db477d129..6fa1c3d9cb 100755
--- a/docs/products/btn1/examples/example-automation.md
+++ b/docs/products/btn1/examples/example-automation.md
@@ -8,11 +8,11 @@ description: Example of how to use the BTN-1 Events to create an automation in H
2\. Click on **Add trigger** then select **Entity** and then **State**. Then search for your btn-1 and select the btn-1 event. Then select the **Event Type** attribute and select **Single Click** in the box labeled **To**.
-
+
3\. Next click on **Add action** and search **Light: Toggle** and select it. Then choose your entity to turn on such as btn-1 light. Check the box next to Brightness and type in 100 then click Save and name your automation.
-
+
4\. Your automation is now live. Click the button 1 button and it should toggle whatever light you selected in the automation!
diff --git a/docs/products/btn1/setup/general-tips.md b/docs/products/btn1/setup/general-tips.md
index 8de126e9b2..ab45910745 100755
--- a/docs/products/btn1/setup/general-tips.md
+++ b/docs/products/btn1/setup/general-tips.md
@@ -8,7 +8,7 @@ description: BTN-1 General Tips
Your BTN-1 comes with two sets of 4 sticky pads or feet to stick on the bottom of the BTN-1 itself or on the optional BTN-1 Mount addon. These are great for just setting the device on your desk!
-
+
### Mounting
@@ -16,16 +16,16 @@ The BTN-1 with the stand addon allows you to mount the device using M3 screws to
###### **Under Desk**
-
+
###### Desk Mount
I used a block of wood instead of mounting it directly to my desk in this example.
-
+
###### **Magnetic Mounting**
-
+
\ No newline at end of file
diff --git a/docs/products/btn1/setup/getting-started.md b/docs/products/btn1/setup/getting-started.md
index e01ced341e..81db3961bd 100755
--- a/docs/products/btn1/setup/getting-started.md
+++ b/docs/products/btn1/setup/getting-started.md
@@ -12,19 +12,19 @@ This will guide you through adding on switches and keycaps to your BTN-1 then ad
Line up the two gold pins with the holes on your BTN-1, then press down gently. Be careful, as the pins can bend or get damaged if too much force is used.
-
+
###### Installing Keycaps
Line up the + on the keycap with the + on the top of the switch you installed. It may require a little pressure, but it should press on smoothly. Once placed, lightly tap to ensure the keycap is fully seated.
-
+
###### Flip Power Switch
Only the battery version has a power switch. If yours has one, ensure it's **turned on**. With the device on its side, flipping the switch **away from you** turns it **on**, and flipping it **toward you** turns it **off**.
-
+
### Connecting Through Hotspot
@@ -40,13 +40,13 @@ To connect through the sensor's onboard hotspot follow the below:
2\. On your phone or PC, open the WiFi settings and connect to "Apollo BTN-1 Hotspot".
-
+
3\. Once connected it should automatically open a dashboard for your sensor. If this does not automatically open the dashboard, please open your web browser and go to [http://192.168.4.1](http://192.168.4.1)
4\. Select the Wi-Fi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**".
-
+
!!! tip "Tip for Mesh Wi-Fi systems or multiple Access Points"
@@ -64,15 +64,15 @@ To connect through the sensor's onboard hotspot follow the below:
1\. Navigate to settings -> integrations then click the "**ADD**" button below your new Apollo device then click **Submit**.
-
+
2\. Once prompted, type in your Wi-Fi name and password in the two fields then click **Submit**. Click on **Close** once it finishes.
-
+
3\. Click on **Add** then click on **Submit**. Choose an area and then click **Finish**.
-
+
4\. Your device is now added to your Wi-Fi and added to the ESPHome Integration in Home Assistant. You should now be ready to setup a blueprint and start using your BTN-1!
@@ -86,7 +86,7 @@ You can add the ESPHome Device Builder app in Home Assistant to easily update yo
Make sure to fill out your Wi-Fi details in the **secrets** section by clicking on the **secrets** button.
-
+
```yaml
# Your Wi-Fi SSID and password - keep the quotes and just replace the name and password between the quotes!
@@ -96,15 +96,15 @@ wifi_password: "your-wifi-pass-here"
1\. Open the ESPHome Device Builder dashboard.
-
+
2\. Click **Show** in the top right to show your discovered devices then click on **Take Control** then click **Install**. This can take multiple minutes or longer on low-end hardware.
-
+
3\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit.
-
+
4\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below!
@@ -112,7 +112,7 @@ wifi_password: "your-wifi-pass-here"
1\. Head to the ESPHome Integration then click on **Add** then click **Submit**. When prompted click **Finish** then give it a location and click **Finish** or click **Skip and Finish**.
-
+
2\. Your device is now added to home assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device!
diff --git a/docs/products/btn1/troubleshooting/btn1-boot-mode.md b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
index 8bfb619098..58b2cd2f6b 100755
--- a/docs/products/btn1/troubleshooting/btn1-boot-mode.md
+++ b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
@@ -18,7 +18,7 @@ description: Step by step guide for putting The BTN-1 In Boot Mode.
2\. Disconnect power from your BTN-1, then hold the right (boot) button while plugging in a USB-C data cable to the BTN-1. Once connected, release the button.
-
+
4\. You are now ready to reflash your device!
@@ -28,15 +28,15 @@ description: Step by step guide for putting The BTN-1 In Boot Mode.
1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your BTN-1.
-
+
2\. With the device facing you, locate the reset (left) and boot (right) buttons.
-
+
2\. 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.
-
+
3\. You are now ready to reflash your device!
diff --git a/docs/products/btn1/troubleshooting/btn1-reflash.md b/docs/products/btn1/troubleshooting/btn1-reflash.md
index 0900ffd175..380fbf4ab0 100755
--- a/docs/products/btn1/troubleshooting/btn1-reflash.md
+++ b/docs/products/btn1/troubleshooting/btn1-reflash.md
@@ -10,27 +10,27 @@ description: Step by step guide for reflashing The BTN-1.
1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your BTN-1.
-
+
2\. With the device facing you, locate the reset (left) and boot (right) buttons.
-
+
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.
-
+
4\. Navigate to our installer page using a chromium based browser such as Chrome or Edge and click **connect** under Apollo BTN-1 Installer. Select the open com port and click **connect**.
-
+
5\. Click Install **BTN-1** then click **Install** again.
-
+
6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md b/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
index 09e50f79ee..1deb6465c7 100755
--- a/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
+++ b/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
@@ -6,11 +6,11 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your BTN-
1\. Plug the BTN-1 into power.
-
+
2\. Long press the Boot button (the button on the right) for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/btn1/troubleshooting/btn1-teardown.md b/docs/products/btn1/troubleshooting/btn1-teardown.md
index 9e6790132c..8004125a26 100755
--- a/docs/products/btn1/troubleshooting/btn1-teardown.md
+++ b/docs/products/btn1/troubleshooting/btn1-teardown.md
@@ -14,34 +14,34 @@ description: >-
1\. Flip the battery switch towards you to the off position. Users with no battery skip to step 2.
-
+
2\. With the BTN-1 USB-C port facing upwards, unplug the USB-C cable and remove the lid.
-
+
3\. Gently lift the BTN-1 green PCB out of the device at an angle so the buttons clear the case easier.
-
+
4\. Remove the 2-pin JST connector and remove the battery.
-
+
###### Reassembly
1\. Re-attach the 2-pin JST connector and place the battery writing side down with the wires on the left side of the case.
-
+
2\. Gently place the BTN-1 green PCB back in the case at an angle so the buttons will slide into cutout in the case.
-
+
3\. Line up the lid of the case with the holes for the rgb leds then gently press down to snap it into place.
-
+
4\. Flip the power switch back on.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/cast1/additional-info/esphome-device-builder.md b/docs/products/cast1/additional-info/esphome-device-builder.md
index 56e8c41789..a131cdf517 100644
--- a/docs/products/cast1/additional-info/esphome-device-builder.md
+++ b/docs/products/cast1/additional-info/esphome-device-builder.md
@@ -25,7 +25,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
If a blue **Windows protected your PC** warning appears when you open the `.exe`, click **More info → Run anyway** to continue.
- 
+ 
The first launch takes a moment while it sets itself up, then the dashboard opens in your browser at http://localhost:6052/. An ESPHome icon lands in your notification area for getting back to it later.
@@ -37,7 +37,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.
- 
+ 
=== "Mac"
@@ -64,7 +64,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.
- 
+ 
=== "Home Assistant App"
@@ -112,7 +112,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
Then take **Start guided tour** for a five minute walkthrough, or **Maybe later**.
- 
+ 
### Take Control of Your CAST-1
@@ -122,14 +122,14 @@ Pick the platform you'll be running ESPHome Device Builder on:
2\. Click **Show** next to **Discovered** at the top, then click **Take Control** next to your CAST-1. Change the **Name** and **Friendly Name** if you'd like, or leave them, then click **Take Control** again.
-
+
3\. Click **Install** (the up arrow icon), then click **On the network** and watch it finish installing. (1)
{ .annotate }
1. This takes 5 to 10 minutes depending on how fast your device is.
-
+
4\. Once it completes, click **Stop**, then press the **Reset** button on your device. Your CAST-1 will reboot and it's now ready to test out!
diff --git a/docs/products/cast1/addons/ethernet-module.md b/docs/products/cast1/addons/ethernet-module.md
index ae638a1fa6..2ff7739a38 100644
--- a/docs/products/cast1/addons/ethernet-module.md
+++ b/docs/products/cast1/addons/ethernet-module.md
@@ -15,7 +15,7 @@ The Ethernet add-on gives your CAST-1 a wired network connection. It's a small h
1. Press evenly on both ends. If the module won't sit flat against the case, lift it off and line the pins up again rather than forcing it.
-
+
4\. Plug an Ethernet cable into the module, then plug the CAST-1 back into power.
diff --git a/docs/products/cast1/examples/wizmote-blueprint.md b/docs/products/cast1/examples/wizmote-blueprint.md
index b488125b17..7982ad3a08 100644
--- a/docs/products/cast1/examples/wizmote-blueprint.md
+++ b/docs/products/cast1/examples/wizmote-blueprint.md
@@ -37,7 +37,7 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1.
1. Pairing a different WizMote later? Use **Clear WizMote Pairing** on the device to unpair, then turn **WizMote Auto-Discovery** back on and press a button on the new remote.
-
+
!!! note "Pairing takes longer on a CAST-1 running Ethernet only"
@@ -59,4 +59,4 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1.
6\. Name your automation something like **Apollo CAST-1 WizMote** and click **Save**. Your WizMote now controls your CAST-1!
-
+
diff --git a/docs/products/cast1/introduction.md b/docs/products/cast1/introduction.md
index 386bec16a1..0ef931c60f 100644
--- a/docs/products/cast1/introduction.md
+++ b/docs/products/cast1/introduction.md
@@ -4,7 +4,7 @@ description: Documentation for CAST-1, including setup, usage, and best practice
---
# Introduction
-
+
**Make Any Speakers Smart:** Plug the CAST-1 into a 3.5mm line-in, add it to Home Assistant, and it shows up in Music Assistant as a player you can stream to.
diff --git a/docs/products/cast1/setup/getting-started.md b/docs/products/cast1/setup/getting-started.md
index 21d3044224..3f069c7236 100644
--- a/docs/products/cast1/setup/getting-started.md
+++ b/docs/products/cast1/setup/getting-started.md
@@ -13,7 +13,7 @@ Run a 3.5mm cable from the CAST-1 into the line-in on your powered speakers, rec
1. The CAST-1 has no amplifier of its own, so it needs powered speakers or an amp. If your speakers use RCA or 6.35mm inputs, use a 3.5mm-to-RCA or 3.5mm-to-6.35mm adapter cable.
-
+
### Connect to Your Network
@@ -37,7 +37,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
3\. Select the Wi-Fi network that you would like your CAST-1 to connect to and type in your Wi-Fi password, then click "**Save**".
- 
+ 
4\. Once connected, the dashboard will automatically close. You've successfully connected your CAST-1 to your Wi-Fi.
@@ -55,7 +55,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
3\. Click **Submit** again, give it an **Area**, then click **Finish**.
- 
+ 
Improv adds your CAST-1 to Home Assistant as part of setup, so skip ahead to [installing Music Assistant](#music-assistant).
@@ -63,7 +63,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
With the CAST-1 unplugged, line the Ethernet module up with the two rows of female header pins on top of the case, pin side down, and press it straight down until it sits flat.
- 
+ 
1\. Plug an Ethernet cable into the module, then plug the CAST-1 into power.
@@ -80,7 +80,7 @@ Open the ESPHome Integration, then click **Add** and **Submit**. Edit the name a
-
+
### Music Assistant
@@ -94,7 +94,7 @@ The CAST-1 streams through Apollo CAST-1 Installer.
5\. Click **Connect & Install**. In the browser popup, select **USB JTAG/serial debug unit** and click **Allow**. When the installer opens, click **Install** to flash the firmware, then click **Install** again to confirm.
-
+
6\. Once you see "**Installation complete!**" you are finished. Click **Next** then close out of the browser window.
diff --git a/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md b/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
index 660195f0e7..25f5f284c0 100644
--- a/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
+++ b/docs/products/cast1/troubleshooting/cast1-reset-wi-fi-credentials.md
@@ -12,7 +12,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your CAST
2\. Long press the **boot** button (on the left) for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/dev1/introduction.md b/docs/products/dev1/introduction.md
index b7051bc977..5caacf9afe 100755
--- a/docs/products/dev1/introduction.md
+++ b/docs/products/dev1/introduction.md
@@ -17,7 +17,7 @@ The DEV-1 does NOT come pre-flashed with ESPHome or WLED and requires you to fla
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/dev2/introduction.md b/docs/products/dev2/introduction.md
index 51fa371da7..629aa001e4 100755
--- a/docs/products/dev2/introduction.md
+++ b/docs/products/dev2/introduction.md
@@ -21,7 +21,7 @@ The DEV-2 does NOT come pre-flashed with ESPHome or WLED and requires you to fla
Please go to this website and copy the randomly generated API key inside the code block as shown below then paste it in the code below where you see "use-a-randomly-generated-key-here".
-
+
**GPIO Pins Listed:**
diff --git a/docs/products/general/battery-sensors/awake-ha-helper.md b/docs/products/general/battery-sensors/awake-ha-helper.md
index c2c8b481cf..9eb96920c2 100755
--- a/docs/products/general/battery-sensors/awake-ha-helper.md
+++ b/docs/products/general/battery-sensors/awake-ha-helper.md
@@ -6,29 +6,29 @@ description: How to keep your sensor awake using the Home Assistant Helper.
1\. Open your Home Assistant dashboard and go to settings then select Devices and services and select helpers in the top right. Or click here to go straight there.
-
+
-
+
2\. Select Create Helper in the bottom right.
+
3\. Home Assistant discovers the Music Assistant integration automatically. Open your integrations page, find **Music Assistant**, then click **Add** and **Submit**.
@@ -108,7 +108,7 @@ The CAST-1 streams through <a href=){kind=link}
- +
3\. Scroll down to the bottom and select Toggle. - +
4\. For name use "apollo\_ota\_mode" and choose desired icon such as "mdi:sleep-off" then click Create. - + 5\. Search "apollo\_ota\_mode" and click on the helper shown. - +
6\. Toggle the OTA mode on as shown below. - + 7\. Now when you reboot your Apollo device or when it wakes up on its wake timer, it will no longer go back to sleep. @@ -38,21 +38,21 @@ description: How to keep your sensor awake using the Home Assistant Helper. 8\. Create a new automation and select "add trigger" then select entity then select state. - + - + 9\. Type in "apollo\_ota\_mode" in the box for entity and then select "On" and finally put a 1 in the hours box under "For". This is telling home assistant if the apollo\_ota\_mode is on for one hour then this trigger will fire (trigger). - + 10\. Scroll down to "Then do" and click "Add Action" and type in "input boolean" and choose the option that says "Input Boolean: Turn off". - + 11\. Now select choose entity and select apollo\_ota\_mode as shown below. - + 12\. Now you are done! You can toggle your OTA mode on so that you can update your devices and after one hour it will automatically be turned off for you! diff --git a/docs/products/general/battery-sensors/prevent-sleep.md b/docs/products/general/battery-sensors/prevent-sleep.md index 87ec099327..b0b2fe4ab6 100755 --- a/docs/products/general/battery-sensors/prevent-sleep.md +++ b/docs/products/general/battery-sensors/prevent-sleep.md @@ -12,11 +12,11 @@ description: How to disable Prevent Sleep and allow your Apollo device to sleep! 1\. Head to the ESPHome Integrations page and click on the name of your Apollo device. - + 2\. Scroll down until you see **Prevent Sleep** and **Sleep Duration**. - + 3\. Type in the amount of minutes you want your sensor to sleep in the **Sleep Duration** box. Defaults to 5 minutes for some devices and longer for others. We recommend leaving the default values. diff --git a/docs/products/general/battery-sensors/sensor-connection-check.md b/docs/products/general/battery-sensors/sensor-connection-check.md index a5002a6e8b..4ac794027e 100755 --- a/docs/products/general/battery-sensors/sensor-connection-check.md +++ b/docs/products/general/battery-sensors/sensor-connection-check.md @@ -6,19 +6,19 @@ description: How to check if your device is connected to Wi-Fi, Home Assistant, 1\. Press the reset button and let go to restart the device
TEMP-1B reset button - + PLT-1B reset button - + 2\. Press the boot button and let go
TEMP-1B boot button - + PLT-1B boot button - + The RGB Light on your device should flash green if connected to Wi-Fi, blue if connected to Wi-Fi and Home Assistant, or yellow if no Wi-Fi or Home Assistant connection. diff --git a/docs/products/general/battery-sensors/wake-up-battery-sensor.md b/docs/products/general/battery-sensors/wake-up-battery-sensor.md index ca23452542..214ef1de38 100755 --- a/docs/products/general/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/general/battery-sensors/wake-up-battery-sensor.md @@ -8,11 +8,11 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 1: Reset button.** Press and release the reset button to restart the device. -  +  **Method 2: Boot button.** Quickly press and hold the boot button for 4-5 seconds. -  +  Button locations: [TEMP-1B boot mode](https://wiki.apolloautomation.com/products/temp1b/troubleshooting/temp1b-boot-mode/). @@ -20,11 +20,11 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 1: Reset button.** Press and release the reset button to restart the device. -  +  **Method 2: Boot button.** Quickly press and hold the boot button for 4-5 seconds. -  +  Button locations: [PLT-1B boot mode](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-boot-mode/). @@ -34,7 +34,7 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 2: Boot button.** Quickly press and hold the boot (right) button for 4-5 seconds. -  +  Button locations: [BTN-1 boot mode](https://wiki.apolloautomation.com/products/btn1/troubleshooting/btn1-boot-mode/). @@ -48,7 +48,7 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 2: Boot button.** Quickly press and hold the boot button for 4-5 seconds. -  +  Button locations: [H-1 boot mode](https://wiki.apolloautomation.com/products/h1/boot-mode/). @@ -62,7 +62,7 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 2: Boot button.** Quickly press and hold the boot (right) button for 4-5 seconds. -  +  Button locations: [H-2 boot mode](https://wiki.apolloautomation.com/products/h2/troubleshooting/boot-mode/). diff --git a/docs/products/general/calibrating-and-updating/calibrate-plt1.md b/docs/products/general/calibrating-and-updating/calibrate-plt1.md index 3d12ab542a..95cc828fc8 100644 --- a/docs/products/general/calibrating-and-updating/calibrate-plt1.md +++ b/docs/products/general/calibrating-and-updating/calibrate-plt1.md @@ -10,42 +10,42 @@ This guide will take you through calibrating your PLT-1's moisture sensor. The s 3\. Select Settings and then Devices & Services - + 4\. Select the ESPHome Integration - + 5\. Select your PLT-1 device - + 6\. Scroll down to the diagnostics section and select entity not shown. - + 7\. Select the entity "Soil ADC." - + 8\. Select the gear icon - + 9\. Select Enable - + 10\. Give the sensor a minute for this new entity to populate. 11\. Once the Soil ADC value is populated, enter it into the "Dry Voltage" entity. - + 12\. Now, place the stake/probe portion of the PLT-1 into a cup of water. Be careful not to submerge the entire sensor—only the exposed PCB below the "Apollo" label and the horizontal line can be exposed to water. 13\. Grab the "Soil ADC" value again and enter it into the "100% Water Voltage" entity. - + 14\. You can now return your PLT-1 to your plant. Congratulations, your sensor is calibrated! diff --git a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md index 19aeaebcfb..bf9a48e574 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md @@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2 1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA. - + 2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device. @@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2 If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key. - + 3\. Click on the button that says "PRESS" and then you are done. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/calibrating-and-updating/co2-calibration.md b/docs/products/general/calibrating-and-updating/co2-calibration.md index a26c9c0340..6ec5c462cf 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration.md @@ -14,7 +14,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor The SCD40 CO2 sensor has a long lifetime (over 10 years), but with automatic self-calibration turned off it needs re-calibration back to the 420 ppm baseline every 1 to 2 years. - + 1\. Bring your sensor outside and plug it in. You might need a USB battery bank if you live in an apartment or otherwise cannot get power outside of your building. @@ -22,17 +22,17 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor 3\. Click device as shown in the image below. - + 4\. Click the "Press" button next to Calibrate SCD40 to 420 ppm and you should see the CO2 readings at 420 ppm or near it. - + It might take several attempts clicking the "Press" button for it to equalize correctly. If you don't see the SCD40 reporting 400-500 ppm then click the button again. 5\. Now your CO2 sensor should be calibrated! Be sure to setup some nice cards on your dashboard so you can monitor the CO2 levels. - + !!! danger "Dangerous CO2 level considerations" @@ -40,14 +40,14 @@ It might take several attempts clicking the "Press" button for it to equalize co Note the steep decline in CO2 ppm detected due to the door and window being opened and fan turned on. - + Wisconsin Department of Health CO2 Level Chart - + !!! example "CO2 levels dropping due to HVAC Fan on a schedule" This could be improved by increasing air exchange to get below 1000 ppm for a safer environment. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/calibrating-and-updating/mmwave-videos.md b/docs/products/general/calibrating-and-updating/mmwave-videos.md index 2cb8021ec0..51073097aa 100755 --- a/docs/products/general/calibrating-and-updating/mmwave-videos.md +++ b/docs/products/general/calibrating-and-updating/mmwave-videos.md @@ -26,11 +26,11 @@ How to tune the mmWave sensor using radar engineering mode. 3\. Turn on Radar Engineering Mode (REM). - + 4\. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8. - + 5\. The gates are different distances from the sensor. @@ -38,11 +38,11 @@ How to tune the mmWave sensor using radar engineering mode. 6\. 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. - + 7\. 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. - + !!! quote "Quote from popular Youtuber Make It Work Tech" diff --git a/docs/products/general/calibrating-and-updating/updating-firmware.md b/docs/products/general/calibrating-and-updating/updating-firmware.md index 5dbb2dbb9b..9893edd0bc 100755 --- a/docs/products/general/calibrating-and-updating/updating-firmware.md +++ b/docs/products/general/calibrating-and-updating/updating-firmware.md @@ -22,7 +22,7 @@ Use this route to build the firmware yourself, or if your device has no **Firmwa 1\. In Home Assistant open the ESPHome Device Builder**.** -[](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) +[](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) !!! tip "Make sure you are running the latest version of ESPHome" @@ -30,23 +30,23 @@ Use this route to build the firmware yourself, or if your device has no **Firmwa 2\. Find the sensor you want to update and click the three dots on the far right. - + 3\. Select “**Validate**” from the list. - + 4\. Once the validation completes, click “**Install**” in the bottom right. - + 5\. Click "**Wirelessly**". - + 6\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit. - + ## If no update ever appears diff --git a/docs/products/general/introduction.md b/docs/products/general/introduction.md index 62d6ec0405..e08718771d 100755 --- a/docs/products/general/introduction.md +++ b/docs/products/general/introduction.md @@ -3,7 +3,7 @@ title: Introduction description: "Learn what Apollo Automation is all about, including our mission, our products, and how we empower smarter homes." --- - + Apollo Automation is a small startup based in Lexington, Kentucky, dedicated to creating innovative, high-quality, and affordable smart home automation hardware. Founded in 2023 by a group of friends, the company was born out of frustration with existing solutions that lacked transparency and customization options. Named after Trevor’s dog, Apollo, the team set out to build products that offer complete local control without reliance on cloud services or subscriptions! diff --git a/docs/products/general/piezo.md b/docs/products/general/piezo.md index bdb5d13b2e..f33ea64af8 100755 --- a/docs/products/general/piezo.md +++ b/docs/products/general/piezo.md @@ -18,7 +18,7 @@ This guide will walk you through using the buzzer on your Apollo Device. 4\. Input an RTTTL tone into the the string box such as one of the examples below. - + ??? example "Mario" diff --git a/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md b/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md index 7fe9ae968b..dbb9347ff7 100755 --- a/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md +++ b/docs/products/general/setup/adding-apollo-devices-to-hidden-networks.md @@ -7,13 +7,13 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 1\. Open the Esphome Device Builder. - + 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install Esphome Device Builder.") and then move on to step 3. 3\. Click "Edit" as shown below. - + 4\. Copy the code inside the codeblock below. @@ -23,18 +23,18 @@ description: Tutorial for how to add Apollo Devices To Hidden Networks. 5\. Paste the code as shown below directly below the yaml you just edited above. Make sure the spaces look the same and there are no red lines under any of the code. - + 6 Click save then Install in the top right. - + 7\. Click "Wirelessly" and let it finish compiling then installing. - + 8\. When you see this "OTA Successful" it has finished and you can click "Close" in the bottom right. - + 9\. You are finished and your Apollo device is now able to connect to your Wi-Fi with a hidden SSID! Make sure you understand the downsides as [mentioned here](https://esphome.io/components/wifi.html "downsides of fast_connect: true").
**fast\_connect** (*Optional*, boolean): If enabled, directly connects to WiFi network without doing a full scan first. This is required for hidden networks and can significantly improve connection times. Defaults to `off`. The downside is that this option connects to the first network the ESP sees, even if that network is very far away and better ones are available. \ No newline at end of file diff --git a/docs/products/general/setup/adjusting-wifi-power.md b/docs/products/general/setup/adjusting-wifi-power.md index c559f12ced..d80ad24793 100755 --- a/docs/products/general/setup/adjusting-wifi-power.md +++ b/docs/products/general/setup/adjusting-wifi-power.md @@ -12,13 +12,13 @@ The ESP chips produce a significant amount of energy (heat) constantly using Wi- 1\. Open the ESPHome Device Builder. - + 2\. If you do not have it installed, [go here](https://esphome.io/guides/getting_started_hassio.html#installing-esphome-device-compiler "Install Esphome Device Builder.") and then move on to step 3. 3\. Click "Edit" as shown below. - + 4\. Copy the code inside the codeblock below. @@ -28,14 +28,14 @@ The ESP chips produce a significant amount of energy (heat) constantly using Wi- 5\. Paste the code as shown below - make sure the spaces look the same and there are no red lines under any of the code. - + 6\. In the top right of the same screen click "SAVE" and then "INSTALL". - + 7\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 8\. You are finished and your Apollo device now has power\_save\_mode set to high! \ No newline at end of file diff --git a/docs/products/general/setup/bluetooth-tracking.md b/docs/products/general/setup/bluetooth-tracking.md index 695d6e3f59..3e9945ca49 100755 --- a/docs/products/general/setup/bluetooth-tracking.md +++ b/docs/products/general/setup/bluetooth-tracking.md @@ -306,22 +306,22 @@ wifi: [Apple](https://apps.apple.com/us/app/home-assistant/id1099568401) 3. Navigate to the HA settings -  +  4. Select Companion app -  +  5. Select Manage sensors -  +  6. Turn on the "BLE Transmitter" -  +  7. After opening BLE transmitter and turning it on, then scroll down to get the iBeacon unique ID -  +  8. Add it to the ESPHome yaml config for the MSR-1 -  +  9. Be sure to add "power\_save\_mode: LIGHT" to the wifi section ``` diff --git a/docs/products/general/setup/change-the-update-frequency-of-sensors.md b/docs/products/general/setup/change-the-update-frequency-of-sensors.md index b6914d08e3..4fe2046794 100755 --- a/docs/products/general/setup/change-the-update-frequency-of-sensors.md +++ b/docs/products/general/setup/change-the-update-frequency-of-sensors.md @@ -7,7 +7,7 @@ description: Tutorial for How To Change The Update Frequency Of Sensors. 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Insert the YAML for the sensor you want to edit(The example below is for our AIR-1 SEN55 sensor). @@ -26,4 +26,4 @@ sensor: 4\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/setup/getting-started.md b/docs/products/general/setup/getting-started.md index 5592df2a50..7e73e858a7 100755 --- a/docs/products/general/setup/getting-started.md +++ b/docs/products/general/setup/getting-started.md @@ -14,7 +14,7 @@ To connect through the sensor's onboard hotspot follow the below: 2\. On your phone or PC, open the WiFi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the WiFi network to show up. - + 3\. Once connected it should automatically open a dashboard for your sensor @@ -22,7 +22,7 @@ If this does not automatically open the dashboard, please open your web browser 4\. Select the WiFi network that you would like your sensor to connect to or scroll to the bottom and type in your Wi-Fi network then click "**Save**". - + !!! tip "Tip for Mesh Wi-Fi systems or multiple Access Points" @@ -40,27 +40,27 @@ If this does not automatically open the dashboard, please open your web browser 1\. Navigate to settings -> integrations then click the "**ADD**" button below your new Apollo device! - + 2\. Click submit when it asks if you want to setup your new device and shows you the hostname of your device. - + 3\. Type in your Wi-Fi name and password in the two fields. - + 4\. Wait for it to finish, you will see the image below while it connects. - + 5\. Click the link shown in the image below (do not click close). - + 6\. When successful, you will see this image appear! - + ### Connecting To ESPHome Device Builder @@ -72,7 +72,7 @@ You can add the ESPHome Device Builder app in Home Assistant to easily update yo Make sure to fill out your Wi-Fi details in the SECRETS section by clicking on the SECRETS Image below. - + ```yaml # Your Wi-Fi SSID and password - keep the quotes and just replace the name and password between the quotes! @@ -82,23 +82,23 @@ wifi_password: "your-wifi-pass-here" 1\. Click "Show" in the top right to show your discovered devices! - + 2\. Click the ESPHome Builder in your sidebar then click "**TAKE CONTROL**" for your new Apollo Device! - + 3\. Rename your sensor here (this only renames the sensor in the ESPHome Device Compiler's Dashboard) or skip it and continue on by clicking "**TAKE CONTROL**" again as shown below. - + 4\. Click "**INSTALL**" (DO NOT click skip!) and let your device get adopted into the ESPHome Device Builder. Please have patience as this takes a few minutes to compile and then install to your new Apollo device! - + 5\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" to exit. - + 6\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below! @@ -106,23 +106,23 @@ wifi_password: "your-wifi-pass-here" 1\. Click the "**Notifications**" Icon in the bottom left. - + 2\. Click "**Check it out**" to go to the integrations page and see the new device that was found. - + 3\. Click "**ADD**" to begin adding the device to home assistant. - + 4\. Click "**SUBMIT**" to confirm you want to add your new Apollo device to home assistant. - + 5\. Give it an area and click "**FINISH**". - + 6\. Your device is now added to home assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device! diff --git a/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md b/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md index 064c4f1896..90fefcc414 100755 --- a/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md +++ b/docs/products/general/setup/how-to-add-temp-and-humidity-from-scd40.md @@ -6,7 +6,7 @@ description: Tutorial for How To Add Temp And Humidity entities From the SCD40 C 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Copy the YAML below and put it at the bottom on a new line with no spaces before it. @@ -56,14 +56,14 @@ number: mode: box ``` - + 3\. In the top right of the same screen click "SAVE" and then "INSTALL". 4\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 5\. Once you are finished, you will have two new boxes inside the Home Assistant ESPHome integration device page for your device where you can fill in an offset. Give them up to 1minute to take effect! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/setup/renaming-apollo-devices.md b/docs/products/general/setup/renaming-apollo-devices.md index 3d42f9f6ac..b64456d3d5 100755 --- a/docs/products/general/setup/renaming-apollo-devices.md +++ b/docs/products/general/setup/renaming-apollo-devices.md @@ -12,7 +12,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio 2\. On the device you want to rename, click the pencil icon and enter a new name. Click **Update**, then select the name you just created. - + 3\. Click the 3 dots in the top right and select **Recreate Entity IDs** then select **Update**. @@ -20,11 +20,11 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio You will likely run into a popup showning that 2 entity IDs cannot be regenerated because they are not available. This is fine, we can manually fix these later or just ignore them as they are disabled entities and not expected to be used. - + 4\. Scroll down to the Diagnostic section and click on **\+2 disabled entities**. Select each entity and replace the old name with the new name. Make sure to replace spaces with underscores as shown in the gif below! - + ##### ESPHome Integration - Part 2 @@ -36,7 +36,7 @@ This section only changes the device name shown in the ESPHome integration page. 2\. On the device you would like to rename, click the 3 dots icon and select **Rename** and type in your new name then click **OK**. - + !!! success "The next section is not necessary unless you use ESPHome Device Builder!" @@ -48,7 +48,7 @@ This section only changes the device name shown in the ESPHome integration page. 2\. Click the 3 dots next to your new Apollo device and select **Rename hostname** then enter in the new name of your sensor and click **Rename**. This cannot have any spaces or underscores only hyphens, numbers, and lowercase letters such as "**smart-keys**". Once it finishes it will say OTA successful and you can click close to get back to the main dashboard. - + !!! null "We are now ready to rename the friendly_name to a new name such as Smart Keys" @@ -56,12 +56,12 @@ This section only changes the device name shown in the ESPHome integration page. 3\. Click **Edit** then replace the text after friendly\_name with your new name such as Smart Keys. Click Save and Install in the top right once you are done with the rename and it will save and install. Once it finishes it will say OTA successful and you can click close to get back to the main dashboard. - + 4\. Finally we should delete the device from the ESPHome Integration in home assistant and then add it back! Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then **Delete**. - + 5\. Scroll up and add the new auto-discovered device. The name should be the same Friendly name you put in the ESPHome Device builder and all of your entities should be the correct name to begin with! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/setup/switch-to-beta-branch.md b/docs/products/general/setup/switch-to-beta-branch.md index dee2b739bb..2f323c7010 100755 --- a/docs/products/general/setup/switch-to-beta-branch.md +++ b/docs/products/general/setup/switch-to-beta-branch.md @@ -14,7 +14,7 @@ description: Tutorial for How To Switching to Beta branch with ESPHome Device Bu 2\. Find the sensor you want to edit and click the "**EDIT**". - + !!! danger "This is code and requires you to follow the directions carefully." @@ -22,9 +22,9 @@ description: Tutorial for How To Switching to Beta branch with ESPHome Device Bu 3\. Look for the line that starts with packages and the line below it and put a \# in front of each line as shown in the second image below. - + - + 4\. Select your product below, copy the code, and paste it below the two lines you just commented out. @@ -159,12 +159,12 @@ description: Tutorial for How To Switching to Beta branch with ESPHome Device Bu Changing the name can cause the install to fail due to mDNS issues. If you want to rename your device, [follow this guide](https://wiki.apolloautomation.com/products/general/setup/renaming-apollo-devices/) instead. - + 5\. Click save then install in the top right and click **Wirelessly** when prompted. - + 6\. Once you see "**INFO OTA successful**" you are done. Click "**STOP**" in the bottom right to exit. - + diff --git a/docs/products/general/supported-platforms.md b/docs/products/general/supported-platforms.md index 437d8f7a5a..3e3b92d1b0 100755 --- a/docs/products/general/supported-platforms.md +++ b/docs/products/general/supported-platforms.md @@ -2,7 +2,7 @@ title: Supported Platforms description: A list of platforms compatible with Apollo Automation products. --- - + At Apollo, we are actively working on adding support for every smart home ecosystem out there. Although we are a works with Home Assistant partner and a Made for ESPHome partner, we want everyone to be able to use our sensors! Please take a look at the list of smart home ecosystems below to see the type of support we offer and the type of integration/functionality our sensors have. If you see any outdated info or have any questions/comments/concerns, please reach out to us at support@apolloautomation.com or come say hi in our [discord server](https://link.apolloautomation.com/discord)! diff --git a/docs/products/general/troubleshooting/connection-issues.md b/docs/products/general/troubleshooting/connection-issues.md index a1453d4fc1..ecdfcfd02e 100755 --- a/docs/products/general/troubleshooting/connection-issues.md +++ b/docs/products/general/troubleshooting/connection-issues.md @@ -26,7 +26,7 @@ wifi: 1\. Select the ESPHome app and then select Edit under your desired device. - + 2\. Add the code below to your devices yaml file. Then select Save and press Install. @@ -34,6 +34,6 @@ wifi: power_save_mode: none ``` - + 3\. Now your device should have a stronger connection. (This will cause the sensors internal temperature to increase.) \ No newline at end of file diff --git a/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md b/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md index 92c91c1e18..423c8d6ddc 100755 --- a/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md +++ b/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md @@ -12,14 +12,14 @@ Install the mDNS Repeater 1\. Click System -> Click Firmware -> Click Plugins -> Search for "mdns" -> Click the “+” symbol to install os-mdns-repeater. - + 2\. Confirm that the installation was successful. - + 3\. Refresh the page and then go to Services -> mDNS Repeater (if it isn't there after refreshing your screen, verify the plugin install was successful.)-> Check off "enable" -> select your networks containing Home Assistant / ESPHome IoT devices -> click save. - + Now the Home Assistant/ESPHome auto-discover issue should be fixed! \ No newline at end of file diff --git a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md index bf8404df06..2b74b4c76f 100755 --- a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md +++ b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md @@ -14,14 +14,14 @@ This will cover how to remove an Apollo device from Home Assistant 1\. Navigate to Home Assistant and open your ESPHome Device Builder app. - + 2\. On the device you would like to remove, click the three dots and select "Delete" then click Delete to confirm. - + ##### ESPHome Integration 1\. Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then "Delete". - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md index 6b6f92f6e0..1af8f41aea 100755 --- a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md +++ b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md @@ -14,23 +14,23 @@ description: Tutorial to help fix the Ubiquiti Unifi mDNS Auto Discover Issue. 2\. Select Network. - + 3\. Select Settings. - + 4\. Select Networks. - + 5\. Select the Default Network - + 6\. Check Multicast DNS - + 7\. Now the Home Assistant/ESPHome auto-discover issue should be fixed! @@ -38,22 +38,22 @@ description: Tutorial to help fix the Ubiquiti Unifi mDNS Auto Discover Issue. 1\. Open the UniFi app. - + 2\. Tap Settings/Gear Icon - + 3\. Tap Networks - + 4\. Tap Default Network - + 5\. Tap the Multicast DNS slider - + 6\. Now the Home Assistant/ESPHome auto-discover issue should be fixed! \ No newline at end of file diff --git a/docs/products/general/tutorials/change-co2-update-interval.md b/docs/products/general/tutorials/change-co2-update-interval.md index d8a0607b2f..bd8778794e 100644 --- a/docs/products/general/tutorials/change-co2-update-interval.md +++ b/docs/products/general/tutorials/change-co2-update-interval.md @@ -16,7 +16,7 @@ This guide will show you how to edit the CO2 updates down to 5 second 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Copy this code and enter it just like shown in the next step. Make sure there are no extra spaces or any other characters. It needs to look just like the example in the next step. @@ -34,6 +34,6 @@ sensor: 5\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 6\. Once that is finished your sensor should now be reporting CO2 at your new update\_interval such as 5 seconds! diff --git a/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md b/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md index 2725e6eb44..dad0437d5c 100755 --- a/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md +++ b/docs/products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md @@ -12,7 +12,7 @@ This guide will show you how to edit the lux updates down to 5 seconds. 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. - + 2\. Copy this code and enter it just like shown in the next step. Make sure there are no extra spaces or any other characters it needs to look just like the example in the next step. @@ -26,12 +26,12 @@ sensor: 3\. Paste the code you copied in step 2 below your sensor's existing yaml as shown below. - + 4\. In the top right of the same screen click "SAVE" and then "INSTALL". 5\. Once you see "INFO OTA successful" you are done. Click "STOP" to exit. - + 6\. Once that is finished your sensor should now be reporting at your new update\_interval such as 5 seconds! \ No newline at end of file diff --git a/docs/products/h1/boot-mode.md b/docs/products/h1/boot-mode.md index 745748819e..0bf8a92057 100755 --- a/docs/products/h1/boot-mode.md +++ b/docs/products/h1/boot-mode.md @@ -4,7 +4,7 @@ description: Step by step guide for putting The H-1 In Boot Mode. --- This will cover how to put the H-1 into boot mode. Sometimes, this is needed to upload new firmware if the device is struggling. - + ## **Boot Button Only** diff --git a/docs/products/h1/faq.md b/docs/products/h1/faq.md index be14f043d4..bccfee50b3 100755 --- a/docs/products/h1/faq.md +++ b/docs/products/h1/faq.md @@ -2,7 +2,7 @@ title: H-1 FAQ description: Frequently asked questions about the H-1. --- - + 1\. **What songs are pre-loaded on the Apollo H-1?** diff --git a/docs/products/h1/getting-started.md b/docs/products/h1/getting-started.md index de095c42d7..1afba2ea1a 100755 --- a/docs/products/h1/getting-started.md +++ b/docs/products/h1/getting-started.md @@ -6,7 +6,7 @@ description: H-1 Getting Started tutorial. Insert a rechargeable RC-CR123A (16340) battery, preferably an 850 mAh model like the one available in our store, or plug it into a power source using the USB-C port. A normal CR123A will not work! - + 2\. Turn on the Ornament: @@ -20,7 +20,7 @@ Once the ornament is awake, press the gold button (see image below) to play one * 2 Presses: Rudolph the Red-Nosed Reindeer * Long press: Let it Snow - + 4\. Add to Home Assistant (Optional): diff --git a/docs/products/h1/introduction.md b/docs/products/h1/introduction.md index 8240bd6e61..8f32bde4b3 100755 --- a/docs/products/h1/introduction.md +++ b/docs/products/h1/introduction.md @@ -2,7 +2,7 @@ title: H-1 Introduction description: H-1 Introduction. --- - + The Apollo H-1 is our special holiday ornament, designed to bring festive cheer to your home while supporting a good cause. As the first in our annual series, this ornament is crafted with both functionality and community spirit in mind. All proceeds from the H-1 go directly to a local charity in Lexington, KY, reflecting our commitment to giving back and celebrating the season alongside our community. diff --git a/docs/products/h1/reflash.md b/docs/products/h1/reflash.md index 5ecdf3c93f..c3f938a1c6 100755 --- a/docs/products/h1/reflash.md +++ b/docs/products/h1/reflash.md @@ -10,17 +10,17 @@ If your device has already been connected to Home Assistant previously please re 2. Navigate to our installer page and click connect [\*\* Install Page \*\*](https://apolloautomation.github.io/H-1/) 3. Select your Apollo device, it will show with a similar name to the one below, and click connect. If you aren't sure which device it is, you can unplug the sensor and see which disappears. - + If no device shows, click cancel and then install the recommended driver that shows on the popup. If you have installed the driver, tried different cables, and it still won't work refer [here](https://wiki.apolloautomation.com/products/h1/boot-mode/) for putting the sensor in bootloader mode and then retry step 3. 4\. Choose to install the new firmware - + 5\. Wait for the installer to finish - if you see "ERROR Logger is not configured!" that is totally expected! The logger is disabled to make more room for other components on the microcontroller. - + 6\. VERY IMPORTANT - you need to unplug your device and plug it back in to leave boot mode! @@ -29,4 +29,4 @@ If no device shows, click cancel and then install the recommended driver that sh If you encounter the below error, please complete the [Putting H-1 In Boot Mode Document](https://wiki.apolloautomation.com/products/h1/boot-mode/) and go back to step 3. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/h2/setup/getting-started.md b/docs/products/h2/setup/getting-started.md index 5d53015591..47d8767876 100755 --- a/docs/products/h2/setup/getting-started.md +++ b/docs/products/h2/setup/getting-started.md @@ -8,7 +8,7 @@ description: H-2 Getting Started tutorial. Insert a rechargeable RC-CR123A (16340) battery, preferably an 850 mAh model like the one available in our store. A normal CR123A will not work! - + **2\. Turning On the Ornament** diff --git a/docs/products/h2/troubleshooting/boot-mode.md b/docs/products/h2/troubleshooting/boot-mode.md index 9306b75fc7..fda8f96739 100755 --- a/docs/products/h2/troubleshooting/boot-mode.md +++ b/docs/products/h2/troubleshooting/boot-mode.md @@ -18,7 +18,7 @@ description: Step by step guide for putting The H-2 In Boot Mode. 3\. Push and hold the boot button (the right button). While still holding the button down, plug in a USB-C cable into the USB-C port of your H-2 then let go of the button. - + 4\. You are now ready to reflash your device! @@ -28,11 +28,11 @@ description: Step by step guide for putting The H-2 In Boot Mode. 1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your H-2. With the device facing you, locate the reset (left) and boot (right) buttons. - + 2\. 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. - + 3\. You are now ready to reflash your device! diff --git a/docs/products/h2/troubleshooting/reflash.md b/docs/products/h2/troubleshooting/reflash.md index 12c291d4ac..2bd64bb804 100755 --- a/docs/products/h2/troubleshooting/reflash.md +++ b/docs/products/h2/troubleshooting/reflash.md @@ -14,21 +14,21 @@ description: Step by step guide for re-flashing the H-2 back to factory firmware 3\. Push and hold the boot button (the right button). While still holding the button down, plug in a USB-C cable into the USB-C port of your H-2 then let go of the button. - + 4\. Navigate to our installer page using a chromium based browser such as Chrome or Edge and click **connect** under **H-2 Smart Wi-Fi Firmware** or **H-2 No Wi-Fi Firmware**. Select the open com port and click **connect**. [Click here to head to the reflashing site!](https://apolloautomation.github.io/H-2/){ .md-button .md-button--primary } - + 5\. Click Install **H-2** then click **Install** again. - + 6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/led1/examples/led-1-controlling-govee-lights.md b/docs/products/led1/examples/led-1-controlling-govee-lights.md index 91a9b8dce9..de7d20d282 100755 --- a/docs/products/led1/examples/led-1-controlling-govee-lights.md +++ b/docs/products/led1/examples/led-1-controlling-govee-lights.md @@ -4,11 +4,11 @@ description: >- How to use the Apollo LED-1 to control your Govee/3rd Party permanent outdoor LED lights! --- -This is a guide to show you how to use the Apollo LED-1 to control your Govee permanent outdoor lights fully locally and without the need of a cloud based app. +This is a guide to show you how to use the Apollo LED-1 to control your Govee permanent outdoor lights fully locally and without the need of a cloud based app. 1\. Items we will need for this project. - + \- **Apollo LED-1:** https://apolloautomation.com/products/led-1-led-controller
\- **Govee permanent lights:** https://www.amazon.com/Govee-Permanent-Lighting-Waterproof-Assistant/dp/B0DX1WPB9J?th=1
\- **Project box:** https://www.amazon.com/dp/B075DJDT99?ref=fed\_asin\_title&th=1
\- **Barrel plug connector:** https://www.amazon.com/Tugermoola-Threaded-Female-Connector-Adapter/dp/B0D9B7WR23?crid=3OR009XXFZQEF&dib=eyJ2IjoiMSJ9.e5X\_-XWXnB0xBvcSvAvZ55hSjlvd6UzliF-J4c3T3lMAnN0l1TGidk3aJVGRL0GbuOtjayYg4geWqzYV0h6n5GExQBc\_M9LNQWkhMf3dM2\_terh12U-epCikbBTwuTlUmsTSHtmptZdq9Kgidev7ANMjC\_R273mJIMboppBQDsU5LGGll-Opu4SqA7A6hrqgXGDwY38FgtprDsGkQBKJ8ssuIcnegX2gWyZvRd\_tjqk.\_DEjYBsY9V-fP-UNB8aAmKPDi\_DfQ7wuw0-mqq2PtlE&dib\_tag=se&keywords=female%2Bbarrel%2Bplug%2Bconnector%2B24v&qid=1762897344&refinements=p\_85%3A2470955011&rnid=2470954011&rps=1&sprefix=female%2Bbarrel%2Bplug%2Bconnector%2B24v%2Caps%2C101&sr=8-5&th=1
\- **White 3 wire LED connecting wire:** https://www.amazon.com/NEWNEWLIU-Waterproof-Connector-Electrical-Outdoor/dp/B0D6RBKRGQ?ie=UTF8&th=1 @@ -18,21 +18,21 @@ description: >- 2\. Remove the project box lid by unscrewing the 4 screws. - + 3\. Remove two of the rubber grommets and cut a small slit using the hobby knife to allow for the power and data connections. The two bottom grommets might be best for an outdoor setup to prevent any water from getting in. - + 4\. Connect the barrel plug to the WAGO connector. It is the large white compnent on the bottom left of the board below the USB-C port. Connect the RED (+) wire to the top terminal and the BLACK (-) wire to the bottom terminal. You can use the tweezers to depress the top of the WAGO connector, insert the wire, and then release to lock it in place. - + 5\. Remove the cable sheathing of the 3 pin LED connector using the hobby knife. Be careful when cutting, because the cable can roll. - + - + 6\. diff --git a/docs/products/led1/introduction.md b/docs/products/led1/introduction.md index c6632eb5bb..6fc998d72d 100755 --- a/docs/products/led1/introduction.md +++ b/docs/products/led1/introduction.md @@ -4,7 +4,7 @@ description: Documentation for LED-1, including setup, usage, and best practices --- # Introduction - + The Apollo LED-1 is a compact, versatile LED Controller for Home Assistant. Fully open-source and expandable, the LED-1 offers seamless integration with Home Assistant using the WLED Integration, making it ideal for automating lighting. Access to support and customization resources is available via our Discord and GitHub. diff --git a/docs/products/led1/setup/getting-started-led1.md b/docs/products/led1/setup/getting-started-led1.md index 373a35bcb5..259d113051 100755 --- a/docs/products/led1/setup/getting-started-led1.md +++ b/docs/products/led1/setup/getting-started-led1.md @@ -48,7 +48,7 @@ The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V 1\. Grab a male JST-SM 3 pin connector such as the extra included with your led strips and carefully note the red wire for positive, the green for data, and the white for ground. - + 2\. Inspect the LED-1 and look for the two Wago connectors labeled "Output 1" and "Output 2". Insert the red power wire into the far left terminal of output 1 then the green wire into the middle terminal of Output 1 then the white wire into the third terminal for Output 1. @@ -60,7 +60,7 @@ Your device is now ready to connect to your Wi-Fi and begin controlling via Home 1\. Plug your power supply or usb-c power in and the LED-1 device will boot within a couple seconds. Head to the available Wi-Fi networks on your phone and select WLED-AP. It should pop up saying "Welcome to WLED!". If this popup does not occur, please open a web browser and navigate to http://4.3.2.1/ and you should be prompted with the same image seen below. - + ### Join to Home Assistant diff --git a/docs/products/led1/setup/led1-replace-fuse.md b/docs/products/led1/setup/led1-replace-fuse.md index 7cec67a8e6..63f38fe332 100755 --- a/docs/products/led1/setup/led1-replace-fuse.md +++ b/docs/products/led1/setup/led1-replace-fuse.md @@ -6,39 +6,39 @@ description: Tutorial showing how to replace the 10 A Fuse on the LED-1. 1\. Gently pry open the lid - this can be a tight fit so you will want to use a small tool not your fingernail. Remove the lid and set aside. - + 2\. Gently lift the LED-1 PCB out of the case - be careful not use a lot of force this could break components - + 3\. Flip the LED-1 PCB over and locate the replaceable fuse. - + 4\. Gently remove the fuse using tweezers. - + 5\. Orient the new fuse with the writing facing up then place it inside the fuse bay. - + 6\. Gently push down on the fuse to make sure it is fully seated. - + 7\. Flip PCB over and angle it the same way you disassembled and rest the side of the pcb on the "shelf" as shown in the image below. - + 8\. Align the holes on the case so they line up with the Wago connectors. - + 9\. Press down on the case lid to secure it to the bottom of the case. - + 10\. You're all done - enjoy your LED-1! diff --git a/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md b/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md index ddbe4ec666..ea2291c9aa 100755 --- a/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md +++ b/docs/products/led1/troubleshooting/led1-find-ip-address-and-hostname.md @@ -18,7 +18,7 @@ description: Step by step guide for finding the IP address and the hostname of y 3\. Your LED-1 should be detected automatically. Select it, then click the **Config** tab in the top right corner. - + !!! danger "WARNING ~ DO NOT UPDATE IT ~ WARNING" @@ -26,10 +26,10 @@ description: Step by step guide for finding the IP address and the hostname of y 4\. Select **WiFi Setup** and at the bottom you will see a box with .local at the end. The letters inside of the box are your hostname and the IP is directly below it. You can change the hostname to whatever you like (using letters, numbers, and dashes only). Click Save and Connect when done. - + 5\. You can now access your device from a browser at http://the-ip-address-here or http://the-hostname-you-entered.local 6\. Edit the User Interface settings section under the **Server description** with a friendly name that is shown for your device! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/led1/troubleshooting/led1-reflash.md b/docs/products/led1/troubleshooting/led1-reflash.md index cab11c4a05..b79ed21fe5 100755 --- a/docs/products/led1/troubleshooting/led1-reflash.md +++ b/docs/products/led1/troubleshooting/led1-reflash.md @@ -16,15 +16,15 @@ description: Step by step guide for re-flashing the LED-1 back to factory firmwa 5\. Click the **Serial Port** dropdown and choose the available COM port.. - + 6\. Browse to the firmware file from Step 3 and select it. - + 7\. Click **Flash ESP** and wait for the process to complete. Once it's done, it will appear as shown in the image below. - + 8\. The device is still in **boot mode** and needs to be power cycled. To reboot it, either unplug the power cable or press the **reset button** on the back of the device (the button on the right). diff --git a/docs/products/m1/addons/adding-microphone-to-m-1.md b/docs/products/m1/addons/adding-microphone-to-m-1.md index c001a160a7..825008eb90 100755 --- a/docs/products/m1/addons/adding-microphone-to-m-1.md +++ b/docs/products/m1/addons/adding-microphone-to-m-1.md @@ -12,7 +12,7 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th 2\. Insert the microphone addon as shown in the image below. Make sure the Microphone image is facing to the right side and the GND pin is on the bottom right! - + ###### Turn It On @@ -22,7 +22,7 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th If nothing reacts, confirm the microphone board is seated all the way into its connector, then click **Config**, then **Usermods**, and find **AudioReactive**. These are the settings your M-1 ships with, so use them to check nothing has been changed. -  +  === "WLED-MM" @@ -30,10 +30,10 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th 4\. Select **10 digitalmic** for Pin I2s SD, select **12 digitalmic A5** for Pin I2S WS, and select **11 digitalmic** for Pin I2S SCK and click **Save**. -  +  5\. Scroll to the bottom of the **AudioReactive** settings and set the **Mode** to **Off** and click **Save**. -  +  Then pick an effect with a musical note beside it and make some noise. diff --git a/docs/products/m1/addons/wizmote-remote.md b/docs/products/m1/addons/wizmote-remote.md index 5d08602330..a88be44d48 100644 --- a/docs/products/m1/addons/wizmote-remote.md +++ b/docs/products/m1/addons/wizmote-remote.md @@ -28,7 +28,7 @@ The M-1 has no IR receiver, but it does take a Giphy is an easy place to start, and the dancing cat below works as a test. - + Getting it onto the matrix depends on your firmware. WLED converts and resizes on the device, WLED-MM needs an external tool first. @@ -27,15 +27,15 @@ Getting it onto the matrix depends on your firmware. WLED converts and resizes o 2\. Head to ezgif.com and click **Resize** then click Browse and choose your gif then click Upload! -  +  3\. Set the **Width** to **64** and the **Height** to **64** then click **Resize image** then scroll down to the **Resized Image:** section and click the **Save** icon. -  +  4\. Rename the gif to something simple such as cat-dance. We will need to input the name as-is in a future step so renaming it to a simple name is best! -  +  5\. Open a web browser and navigate to `http://
- 
+ 
2\. From this page you can control your M-1 in Home Assistant. Change the color, pick effects, run presets, and more.
- 
+ 
=== "WLED-MM"
@@ -108,23 +108,23 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag
- 
+ 
2\. Click **Add**, then **Submit**.
- 
+ 
3\. Give it a name and a location, then click **Skip** and **Finish**.
- 
+ 
4\. Open the WLED integration page and click your M-1.
- 
+ 
5\. From here you can change the color, pick effects, run presets, and more.
- 
+ 
#### What Next
diff --git a/docs/products/m1/setup/m1-matrix-settings.md b/docs/products/m1/setup/m1-matrix-settings.md
index 9d2d54248c..06ba9d6954 100755
--- a/docs/products/m1/setup/m1-matrix-settings.md
+++ b/docs/products/m1/setup/m1-matrix-settings.md
@@ -11,7 +11,7 @@ These are the settings that make the HUB75 panel display correctly. You need the
Click on **Config**, then **User Interface**. In the **Server description** field, enter the name you want your M-1 device to display as in the WLED interface, such as **Apollo LED Matrix**. It ships as **Apollo M-1**, so this is only worth changing if you want something else.
-
+
###### Hostname
@@ -75,7 +75,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
Click on **Config**, then **LED Preferences**. Select **Hub75Matrix 64x64** and set **Chain Length** to **1** then uncheck the "enable automatic brightness limiter and click **Save**.
- 
+ 
###### 2D Settings
@@ -91,7 +91,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
Click on **Config**, then **2D Configuration**. Select **2D Matrix**, click the circle next to **Basic**, change the **Panel dimensions (WxH)** to **64 x 64** and click **Save**.
- 
+ 
###### AudioReactive Settings
@@ -111,10 +111,10 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
For the pins, select **10 digitalmic** for Pin I2s SD, select **12 digitalmic A5** for Pin I2S WS, and select **11 digitalmic** for Pin I2S SCK and click **Save**.
- 
+ 
Scroll to the bottom of the **AudioReactive** settings and set the **Mode** to **Off** and click **Save**.
- 
+ 
diff --git a/docs/products/m1/setup/m1-multiple-panels.md b/docs/products/m1/setup/m1-multiple-panels.md
index 9a4009d491..d4d133d0dc 100755
--- a/docs/products/m1/setup/m1-multiple-panels.md
+++ b/docs/products/m1/setup/m1-multiple-panels.md
@@ -22,43 +22,43 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
1\. Set both of your M-1 panels face down - the M-1 controller panel should be on the far left. Start by connecting the data cable (ribbon cable) to the "JOUT" port on the far left panel into the "JIN" port on the second panel.
- 
+ 
2\. Gently press the Matrix Power Module over the 4 pin header on the second panel as shown below. Make sure the USB-C port is facing to the right!
- 
+ 
3\. Plug in the USB-C cable into the M-1 LED Controller and the second Panel.
- 
+ 
=== "Three Panels"
1\. Set all three of your M-1 panels face down - the M-1 controller panel should be on the far left. Start by connecting the data cable (ribbon cable) to the "JOUT" port on the far left panel into the "JIN" port on the second panel. Repeat for connecting the third panel.
- 
+ 
2\. Gently press the Matrix Power Module over the 4 pin header on the second panel as shown below. Make sure the USB-C port is facing to the right! Repeat for connecting the third panel.
- 
+ 
3\. Plug in the USB-C cable into the M-1 LED Controller, the second panel power module, and the third panel power module.
- 
+ 
=== "Four Panels"
1\. Set all four of your M-1 panels face down - the M-1 controller panel should be on the far left. Start by connecting the data cable (ribbon cable) to the "JOUT" port on the far left panel into the "JIN" port on the second panel. Repeat for connecting the third and fourth panel.
- 
+ 
2\. Gently press the Matrix Power Module over the 4 pin header on the second panel as shown below. Make sure the USB-C port is facing to the right! Repeat for connecting the third and fourth panels.
- 
+ 
3\. Plug in the USB-C cable into the M-1 LED Controller and all three additional panels via the power module USB-C port.
- 
+ 
=== "2x2 Grid"
@@ -74,7 +74,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
3\. Press a Matrix Power Module onto each of the other three panels and give each one its own USB-C feed.
- 
+ 
A 3D printable wall mount system is available on Printables.
@@ -84,7 +84,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
Click **Config**, then **LED Preferences**. Set **Type** to **HUB75 (Half Scan)** and **Panel (width x height)** to **64 x 64**, leave **Reversed** unchecked, then fill in the rest from your layout and click **Save**.
- 
+ 
**rows x cols** means what it says. The first box is how many panels **down**, the second is how many **across**, so a row of four panels is **1** then **4**.
@@ -102,7 +102,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
1. Set it to four panels here and your content repeats on every panel instead of spanning them.
- 
+ 
Set **Dimensions (WxH)** to the combined size of your layout. This field is width first, unlike **rows x cols** above. (1)
{ .annotate }
@@ -126,17 +126,17 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
2\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **2** then **Save**.
- 
+ 
3\. Click on **Config**, then **2D Configuration** and change the **Panel dimensions (WxH)** to **128 x 64** and click **Save**.
Leave **Horizontal panels** and **Vertical panels** at **1**. The combined size goes in the panel dimensions, not the panel counts. **Matrix Dimensions** below should confirm your new total.
- 
+ 
4\. Reboot WLED before proceeding. Tap **Info** at the top, scroll down, and select **Reboot WLED**. When prompted, tap again to confirm the reboot.
- 
+ 
=== "Three Panels"
@@ -144,17 +144,17 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
2\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **3** then **Save**.
- 
+ 
3\. Click on **Config**, then **2D Configuration** and change the **Panel dimensions (WxH)** to **192 x 64** and click **Save**.
Leave **Horizontal panels** and **Vertical panels** at **1**. The combined size goes in the panel dimensions, not the panel counts. **Matrix Dimensions** below should confirm your new total.
- 
+ 
4\. Reboot WLED before proceeding. Tap **Info** at the top, scroll down, and select **Reboot WLED**. When prompted, tap again to confirm the reboot.
- 
+ 
=== "Four Panels"
@@ -162,17 +162,17 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
2\. Click on **Config**, then **LED Preferences**. set **Chain Length** to **4** then **Save**.
- 
+ 
3\. Click on **Config**, then **2D Configuration** and change the **Panel dimensions (WxH)** to **256 x 64** and click **Save**.
Leave **Horizontal panels** and **Vertical panels** at **1**. The combined size goes in the panel dimensions, not the panel counts. **Matrix Dimensions** below should confirm your new total.
- 
+ 
4\. Reboot WLED before proceeding. Tap **Info** at the top, scroll down, and select **Reboot WLED**. When prompted, tap again to confirm the reboot.
- 
+ 
###### Segment Setup
@@ -192,27 +192,27 @@ If you grew an existing setup rather than starting fresh, the default segment ke
2\. Since we are using two panels, we will begin by editing Segment 0 and setting the Stop X to "128" and the Stop Y to "16"
- 
+ 
3\. Click on Add segment, give it a name (such as Segment 1) then set the Start Y to "16" and the Stop Y to "32".
- 
+ 
4\. Click on Add segment, give it a name (such as Segment 2) then set the Start Y to "32" and the Stop Y to "48".
- 
+ 
5\. Click on Add segment, give it a name (such as Segment 3) then set the Start Y to "48" and the Stop Y to "64".
- 
+ 
6\. You should see four equal segments 0-3 at the top of the screen.
- 
+ 
7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want!
- 
+ 
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -220,7 +220,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
8\. Save your segments by creating a new preset. Click on the + Preset button and typing in a name then clicking Save at the bottom.
- 
+ 
=== "Three Panels"
@@ -228,27 +228,27 @@ If you grew an existing setup rather than starting fresh, the default segment ke
2\. Since we are using three panels, we will begin by editing Segment 0 and setting the Stop X to "192" and the Stop Y to "16".
- 
+ 
3\. Click on Add segment, give it a name (such as Segment 1) then set the Start Y to "16" and the Stop Y to "32".
- 
+ 
4\. Click on Add segment, give it a name (such as Segment 2) then set the Start Y to "32" and the Stop Y to "48".
- 
+ 
5\. Click on Add segment, give it a name (such as Segment 3) then set the Start Y to "48" and the Stop Y to "64".
- 
+ 
6\. You should see four equal segments 0-3 at the top of the screen.
- 
+ 
7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want! 32 Character maximum limit in WLED.
- 
+ 
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -256,7 +256,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
8\. Save your segments by creating a new preset. Click on the + Preset button and typing in a name then clicking Save at the bottom.
- 
+ 
=== "Four Panels"
@@ -264,27 +264,27 @@ If you grew an existing setup rather than starting fresh, the default segment ke
2\. Since we are using four panels, we will begin by editing Segment 0 and setting the Stop X to "256" and the Stop Y to "16".
- 
+ 
3\. Click on Add segment, give it a name (such as Segment 1) then set the Start Y to "16" and the Stop Y to "32".
- 
+ 
4\. Click on Add segment, give it a name (such as Segment 2) then set the Start Y to "32" and the Stop Y to "48".
- 
+ 
5\. Click on Add segment, give it a name (such as Segment 3) then set the Start Y to "48" and the Stop Y to "64".
- 
+ 
6\. You should see four equal segments 0-3 at the top of the screen.
- 
+ 
7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want! 32 Character maximum limit in WLED.
- 
+ 
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -292,7 +292,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
8\. Save your segments by creating a new preset. Click on the + Preset button and typing in a name then clicking Save at the bottom.
- 
+ 
=== "2x2 Grid"
diff --git a/docs/products/m1/setup/m1-segments.md b/docs/products/m1/setup/m1-segments.md
index 56baa4d17f..6acf89da20 100755
--- a/docs/products/m1/setup/m1-segments.md
+++ b/docs/products/m1/setup/m1-segments.md
@@ -18,27 +18,27 @@ Segments work the same on WLED and WLED-MM. The steps below split a single 64x64
2\. Since we are only using *one panel*, we will begin by editing **Segment 0** and setting the **Stop Y** to "16".
-
+
3\. Click on Add segment, give it a name such as **Segment 1** then set the **Start Y** to "16" and the **Stop Y** to "32".
-
+
4\. Click on Add segment, give it a name such as Segment 2 then set the **Start Y** to "32" and the **Stop Y** to "48".
-
+
5\. Click on Add segment, give it a name such as Segment 3 then set the **Start Y** to "48" and the **Stop Y** to "64".
-
+
6\. You should see four equal segments 0-3 at the top of the screen.
-
+
7\. Test it by changing the effect to **Scrolling Text** and editing the name of each segment to be any text you want!
-
+
!!! warning "Your segments need to be saved to a Preset or they will disappear when you reboot or run other presets."
@@ -46,4 +46,4 @@ Segments work the same on WLED and WLED-MM. The steps below split a single 64x64
8\. Save your segments by creating a new preset. Click on the **\+ Preset** button and typing in a name then clicking **Save** at the bottom.
-
+
diff --git a/docs/products/m1/setup/use-without-wifi.md b/docs/products/m1/setup/use-without-wifi.md
index 60534b9c80..691938d332 100644
--- a/docs/products/m1/setup/use-without-wifi.md
+++ b/docs/products/m1/setup/use-without-wifi.md
@@ -10,7 +10,7 @@ The M-1 does not need a Wi-Fi network. Out of the box it makes its own, and the
Plug the M-1 in. The Apollo dog appears for a few seconds, then the panel shows a setup card and keeps showing it until the device is set up. The card has the steps on it along with a QR code.
-
+
1\. On your phone or laptop, open the Wi-Fi list and join the open network named **Apollo M-1**. There is no password out of the box, though you should [set one](#put-a-password-on-the-hotspot) once you are up and running. (1)
{ .annotate }
diff --git a/docs/products/m1/troubleshooting/m1-boot-mode.md b/docs/products/m1/troubleshooting/m1-boot-mode.md
index 00da22d549..2e2a564f41 100755
--- a/docs/products/m1/troubleshooting/m1-boot-mode.md
+++ b/docs/products/m1/troubleshooting/m1-boot-mode.md
@@ -12,7 +12,7 @@ description: Step by step guide for putting The M-1 In Boot Mode.
2\. Push and hold the boot button (the left button). While still holding the button down, plug in a USB-C cable into the USB-C port of your M-1 LED Matrix then let go of the button.
-
+
3\. You are now ready to reflash your device!
diff --git a/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md b/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
index dfeec2d329..b037f9bf15 100755
--- a/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
+++ b/docs/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
@@ -20,7 +20,7 @@ description: >-
3\. The M-1 LED Matrix should be detected automatically. Select it, then click the **Config** tab in the top right corner.
-
+
!!! danger "WARNING ~ DO NOT UPDATE IT ~ WARNING"
@@ -28,12 +28,12 @@ description: >-
4\. Select **WiFi Setup** and at the bottom you will see a box with .local at the end. The letters inside of the box are your hostname and the IP is directly below it. You can change the hostname to whatever you like (using letters, numbers, and dashes only). Click Save and Connect when done.
-
+
5\. You can now access your device from a browser at http://the-ip-address-here or http://the-hostname-you-entered.local
6\. Edit the User Interface settings section under the **Server description** with a friendly name that is shown for your device!
-
+
[Click here to learn how to add your own image or logo to the M-1](https://wiki.apolloautomation.com/products/m1/examples/pixel-forge/){ .md-button .md-button--primary }
\ No newline at end of file
diff --git a/docs/products/m1/troubleshooting/m1-reflash-esphome.md b/docs/products/m1/troubleshooting/m1-reflash-esphome.md
index 19451d2a22..b447df5e2b 100644
--- a/docs/products/m1/troubleshooting/m1-reflash-esphome.md
+++ b/docs/products/m1/troubleshooting/m1-reflash-esphome.md
@@ -12,7 +12,7 @@ description: Step by step guide for reflashing the M-1 with the hub75-studio ESP
2\. Push and hold the boot button (the left button) on the M-1 controller. While still holding the button, plug the USB-C cable into the M-1, then release the button.
-
+
3\. Open https://pavlov-net.github.io/hub75-studio/ in your Chromium browser.
diff --git a/docs/products/m1/troubleshooting/m1-reflash.md b/docs/products/m1/troubleshooting/m1-reflash.md
index 45ffa3c950..6f03a5650d 100755
--- a/docs/products/m1/troubleshooting/m1-reflash.md
+++ b/docs/products/m1/troubleshooting/m1-reflash.md
@@ -12,7 +12,7 @@ description: Step by step guide for re-flashing the M-1 back to factory firmware
2\. Push and hold the boot button (the left button). While still holding the button down, plug in a USB-C cable into the USB-C port of your M-1 LED Matrix then let go of the button.
-
+
3\. Open the Apollo M-1 installer and choose your firmware. New units ship with **WLED 16.0.1**, which is the default.
@@ -26,7 +26,7 @@ description: Step by step guide for re-flashing the M-1 back to factory firmware
6\. Once you see "Installation complete!" you are finished. Click **Next**, then close the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/msr1/additional-info/exposed-gpio.md b/docs/products/msr1/additional-info/exposed-gpio.md
index 35215f0668..849639f2a3 100755
--- a/docs/products/msr1/additional-info/exposed-gpio.md
+++ b/docs/products/msr1/additional-info/exposed-gpio.md
@@ -3,7 +3,7 @@ description: "What each exposed GPIO pad on the back of the MSR-1 does, includin
---
# Exposed GPIO
-
+
The back of the Apollo MSR-1 has exposed GPIO for a variety of uses.
diff --git a/docs/products/msr1/addons/adding-co2-to-msr-1.md b/docs/products/msr1/addons/adding-co2-to-msr-1.md
index 723a866eea..42281325fb 100755
--- a/docs/products/msr1/addons/adding-co2-to-msr-1.md
+++ b/docs/products/msr1/addons/adding-co2-to-msr-1.md
@@ -5,18 +5,18 @@ description: "Fit the CO2 module to your MSR-1, with photos showing the connecto
1\. Unplug your MSR-1 from power and remove the back
-
+
2\. Remove the board from the case and orientate it like the below image. In the bottom right there is a black connector. There is a x in the lower right corner of the connector
-
+
3\. Orientate the CO2 module so the white x on the module is also in the lower right and the gold dot is in the upper left as seen below
-
+
4\. Align the connector on the back of the CO2 module with the connector on the MSR-1. Once aligned, push down so the CO2 module fully seats itself
-
+
5\. Put your MSR-1 back in the case and slide the back cover on. 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.
\ No newline at end of file
diff --git a/docs/products/msr1/examples/msr1-alarmo.md b/docs/products/msr1/examples/msr1-alarmo.md
index 9f4a2f7385..e8ee3d2f6f 100755
--- a/docs/products/msr1/examples/msr1-alarmo.md
+++ b/docs/products/msr1/examples/msr1-alarmo.md
@@ -8,29 +8,29 @@ My grandmother wanted a security system that would alert her when there was move
1\. Install [HACS](https://hacs.xyz/docs/use/download/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)
-
+
-
+
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.
-
+
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.)
-
+
5\. You can change the Title, Message, and Name of the alarm notification.
-
+
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.
-
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
-
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
diff --git a/docs/products/msr1/examples/msr1-dashboards.md b/docs/products/msr1/examples/msr1-dashboards.md
index f9e33b63e3..c765a1a11a 100755
--- a/docs/products/msr1/examples/msr1-dashboards.md
+++ b/docs/products/msr1/examples/msr1-dashboards.md
@@ -6,7 +6,7 @@ description: "Example Home Assistant dashboard cards for the MSR-1, including an
**Radar Scatter Plot With Apex Charts For MSR-1**
-
+
```plaintext
type: custom:apexcharts-card
@@ -46,7 +46,7 @@ series:
**CO2 Charts**
Home Assistant Sensor
-
+
```plaintext
graph: line
@@ -59,7 +59,7 @@ hours_to_show: 24
Custom: Plotly Graph Card
-
+
```plaintext
type: custom:plotly-graph
@@ -72,7 +72,7 @@ title: Bedroom CO2
Home Assistant Guage
-
+
```plaintext
type: gauge
diff --git a/docs/products/msr1/examples/using-msr-1-buzzer.md b/docs/products/msr1/examples/using-msr-1-buzzer.md
index 6290d08cbb..cab4c2d456 100755
--- a/docs/products/msr1/examples/using-msr-1-buzzer.md
+++ b/docs/products/msr1/examples/using-msr-1-buzzer.md
@@ -7,7 +7,7 @@ This guide will walk you through using the buzzer on your MSR-1. You can also ca
1. Open Home Assistant and navigate to developer tools in the bottom left
-
+
2\. Click on services
@@ -26,4 +26,4 @@ This guide will walk you through using the buzzer on your MSR-1. You can also ca
5\. Click on call service button in bottom right
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr1/introduction.md b/docs/products/msr1/introduction.md
index cc8dd6631c..da1e7c447e 100755
--- a/docs/products/msr1/introduction.md
+++ b/docs/products/msr1/introduction.md
@@ -1,6 +1,6 @@
---
description: "The Apollo MSR-1 multisensor: mmWave radar, LUX and UV, temperature, humidity, and optional CO2, running ESPHome for Home Assistant."
---
-
+
The Apollo MSR-1 is a compact, community-driven multisensor designed for Home Assistant via ESPHome. Measuring just 40.5mm x 32mm, it features mmWave radar for motion detection, LUX/UV sensors, temperature/humidity monitoring, and optional CO2 sensing. Powered by USB-C, the MSR-1 allows for customizable alerts through RGB LEDs and a piezo buzzer.
\ No newline at end of file
diff --git a/docs/products/msr1/setup/general-tips.md b/docs/products/msr1/setup/general-tips.md
index 17e8c463b0..33a2b7689b 100755
--- a/docs/products/msr1/setup/general-tips.md
+++ b/docs/products/msr1/setup/general-tips.md
@@ -5,13 +5,13 @@ description: "Placement and mounting tips for the MSR-1, including keeping the l
##### **MSR-1**
-
+
Picture from Smart Home Scene
##### **Light Sensor (LTR-390UV)**
-
+
When mounting the MSR-1 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.
@@ -23,17 +23,17 @@ When mounting the MSR-1 be sure to position the device so that the two large hol
The MSR-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120degree FOV of the mmWave radar.
-
+
-
+
The MSR-1 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling.
##### **Gate and FOV Visualization**
-****
+****
-
+
!!! tip "These are some useful hints!"
diff --git a/docs/products/msr1/setup/zones-ha.md b/docs/products/msr1/setup/zones-ha.md
index 528828e617..f4c1e0ba58 100755
--- a/docs/products/msr1/setup/zones-ha.md
+++ b/docs/products/msr1/setup/zones-ha.md
@@ -19,15 +19,15 @@ Here is a video of how to tune the mmWave sensor using radar engineering mode,
2. Navigate to Settings>Devices & services>ESPHome>Select the MSR-1
3. Scroll down to the Configuration section
4. Turn on Radar Engineering Mode (REM)
- 
+ 
5. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8
- 
+ 
6. The gates are different distances from the sensor
- 
+ 
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.
- 
+ 
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.
- 
+ 
**Alternate Method**
diff --git a/docs/products/msr1/setup/zones-hlk.md b/docs/products/msr1/setup/zones-hlk.md
index 3e88919b2e..33053810a1 100755
--- a/docs/products/msr1/setup/zones-hlk.md
+++ b/docs/products/msr1/setup/zones-hlk.md
@@ -8,41 +8,41 @@ description: "Tune the MSR-1 mmWave radar over Bluetooth with the HLKRadarTool p
2\. Ensure the mmWave radar you want to tune has Radar Control Bluetooth turned on. Home Assistant > Settings > Devices & services > ESPHome Devices > Select Device > Scroll down and toggle on Radar Control Bluetooth
-
+
3\. Open the app and select your device
-
+
4\. Turn on Engineering Mode
-
+
5\. Select More and then select Parameter settings
-
+
6\. Select Detect background noise
-
+
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.
-
+
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
-
+
**Maximum** - Sets the gate sensitivity to the maximum move and still energy
-
+
-**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energ**y** **** 9. Now your mmWave should be tuned to your environment! **Manual Calibration** 1. Follow steps 1-5 above
+**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energ**y** **** 9. Now your mmWave should be tuned to your environment! **Manual Calibration** 1. Follow steps 1-5 above
2\. Select Motion or Static sensitivity, change it to your desired value, and select Set
-
+
3\. Now your mmWave should be tuned to your environment!
\ No newline at end of file
diff --git a/docs/products/msr1/troubleshooting/msr1-boot-mode.md b/docs/products/msr1/troubleshooting/msr1-boot-mode.md
index 19ba8509f6..ddc5ca3bc8 100755
--- a/docs/products/msr1/troubleshooting/msr1-boot-mode.md
+++ b/docs/products/msr1/troubleshooting/msr1-boot-mode.md
@@ -11,7 +11,7 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede
1\. Position the MSR-1 as shown in the image below and locate the small opening to press the boot button (the right button).
-
+
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.
@@ -25,6 +25,6 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede
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.
-
+
4\. Continue with uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/msr1/troubleshooting/msr1-code.md b/docs/products/msr1/troubleshooting/msr1-code.md
index 0709e98735..f028d31734 100755
--- a/docs/products/msr1/troubleshooting/msr1-code.md
+++ b/docs/products/msr1/troubleshooting/msr1-code.md
@@ -11,33 +11,33 @@ If your device has already been connected to Home Assistant please press the boot button (the left button).
-
+
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-1 then let go of the button.
-
+
3\. Navigate to our installer page and click connect under Apollo MSR-1 Installer.
3\. Click the big "Connect" button.
-
+
3\. Select the open com port then click Connect.
-
+
4\. Click "Install MSR-1".
-
+
5\. Click "INSTALL".
-
+
6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
index 0d0bd089f5..c9876d8829 100755
--- a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
+++ b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
@@ -7,9 +7,9 @@ description: "Reset the MSR-1 Wi-Fi credentials with a 10 second press of the Bo
2\. Long press the Boot button for 10 seconds
-
+
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again
diff --git a/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md b/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
index ef9a3ab0d3..f370b6e8ba 100755
--- a/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
@@ -6,19 +6,19 @@ description: Step by step tutorial for adding 90 degree USB-C to MSR-2
1\. Gather the MSR-2 and 90 degree addon.
-
+
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.
-
+
3\. Gently push the short end of the 90 degree addon into the MSR-2 side USB-C port.
-
+
4\. Gently push the longer end of the 90 degree addon into a USB-C outlet.
-
+
!!! success "You're ready to begin using your device!"
diff --git a/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md b/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md
index 32973140b9..a3e1eba3fb 100755
--- a/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-articulating-stand-to-msr-2.md
@@ -6,18 +6,18 @@ description: Tutorial on adding the rear female usb-c port to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back.
-
+
-
+
-
+
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.
-
+
-
+
3\. Align the ball inside the articulating mount and then push down until it's fully seated.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/addons/adding-co2-to-msr-2.md b/docs/products/msr2/addons/adding-co2-to-msr-2.md
index 75729e3c8e..b95bd00e89 100755
--- a/docs/products/msr2/addons/adding-co2-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-co2-to-msr-2.md
@@ -6,26 +6,26 @@ description: Tutorial on adding the SCD40 CO2 sensor to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back
-
+
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.
-
+
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.
-
+
4\. Gently push the SCD40 CO2 module onto the black mezzanine connector.
-
+
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.
-
+
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.
-
+
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/msr2/addons/adding-gpio-header-to-msr-2.md b/docs/products/msr2/addons/adding-gpio-header-to-msr-2.md
index 2532119bcd..7627c9bd96 100755
--- a/docs/products/msr2/addons/adding-gpio-header-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-gpio-header-to-msr-2.md
@@ -6,27 +6,27 @@ description: Tutorial on adding the GPIO Header to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back.
-
+
-
+
-
+
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.
-
+
-
+
3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
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.
-
+
-
+
!!! tip "Make sure to check out our MSR-2 GPIO Header LED Strip Tutorial!"
diff --git a/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md b/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
index a3b4dc52a5..8dfb9b5e64 100755
--- a/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
@@ -6,26 +6,26 @@ description: Tutorial on adding the rear female usb-c port to your MSR-2.
1\. Unplug your MSR-2 from power and remove the back
-
+
-
+
-
+
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.
-
+
-
+
3\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
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!
-
+
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.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/addons/msr2-outlet-mount.md b/docs/products/msr2/addons/msr2-outlet-mount.md
index eadb44536b..95f539142b 100755
--- a/docs/products/msr2/addons/msr2-outlet-mount.md
+++ b/docs/products/msr2/addons/msr2-outlet-mount.md
@@ -6,19 +6,19 @@ description: Tutorial for using the MSR-2 Outlet Mount.
1\. Gather a top facing usb-c plug, an MSR-2, and our MSR-2 Outlet Mount.
-
+
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.
-
+
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.
-
+
4\. Gently push the other USB-C port of the MSR-2 Outlet Mount into the top of the USB-C top facing plug.
-
+
!!! success "You're ready to plug it in and begin using your device!"
diff --git a/docs/products/msr2/calibrating-co2.md b/docs/products/msr2/calibrating-co2.md
index 503caaa143..2e54f8e291 100755
--- a/docs/products/msr2/calibrating-co2.md
+++ b/docs/products/msr2/calibrating-co2.md
@@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2
1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA.
-
+
2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device.
@@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2
If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key.
-
+
3\. Click on the button that says "PRESS" and then you are done.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/examples/msr2-alarmo.md b/docs/products/msr2/examples/msr2-alarmo.md
index 3f616396a5..92cfcff602 100755
--- a/docs/products/msr2/examples/msr2-alarmo.md
+++ b/docs/products/msr2/examples/msr2-alarmo.md
@@ -9,29 +9,29 @@ My grandmother wanted a security system that would alert her when there was move
1\. Install [HACS](https://hacs.xyz/docs/use/download/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)
-
+
-
+
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.
-
+
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.)
-
+
5\. You can change the Title, Message, and Name of the alarm notification.
-
+
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.
-
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
-
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
diff --git a/docs/products/msr2/setup/msr2-general-tips.md b/docs/products/msr2/setup/msr2-general-tips.md
index a7977e37e5..caa5161957 100755
--- a/docs/products/msr2/setup/msr2-general-tips.md
+++ b/docs/products/msr2/setup/msr2-general-tips.md
@@ -6,7 +6,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi
##### **Light Sensor (LTR-390UV)**
-
+
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.
@@ -18,11 +18,11 @@ When mounting the MSR-2 be sure to position the device so that the two large hol
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.
-
+
The MSR-2 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling.
-
+
!!! tip "These are some useful hints!"
@@ -32,8 +32,8 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount
##### **Gate and FOV Visualization**
-****
+****
-
+
#####
\ No newline at end of file
diff --git a/docs/products/msr2/setup/msr2-tuning-dashboard.md b/docs/products/msr2/setup/msr2-tuning-dashboard.md
index 9601be09cd..06113fab4d 100755
--- a/docs/products/msr2/setup/msr2-tuning-dashboard.md
+++ b/docs/products/msr2/setup/msr2-tuning-dashboard.md
@@ -22,7 +22,7 @@ This guide will create a beautiful and helpful dashboard to simplify configurati
4\. Head to your Home Assistant dashboard and Take control of your dashboard by clicking **Edit Dashboard** in the top right then the 3 dots from the **Edit Dashboard** menu and click **Take control**. (this step is only necessary for new Home Assistant users).
-
+
5\. Use the YAML generator below and enter in your device name such as apollo\_msr\_2\_m4c4dd and then click **Generate YAML**. It will copy the YAML for you to use in the next step!
@@ -39,8 +39,8 @@ This guide will create a beautiful and helpful dashboard to simplify configurati
Home Assistant depends on this file to function correctly - it is what displays your dashboard "views". Only make the changes exactly as outlined below. Do not add extra spaces or modify anything beyond what is specified in the instructions.
-
+
7\. You should now have a new dashboard view called **MSR-2 Configuration** and you should be ready to configure your sensor!
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/setup/zones-ha.md b/docs/products/msr2/setup/zones-ha.md
index 6131517a42..f76207cda3 100755
--- a/docs/products/msr2/setup/zones-ha.md
+++ b/docs/products/msr2/setup/zones-ha.md
@@ -28,22 +28,22 @@ How to tune the mmWave sensor using radar engineering mode.
2\. Scroll down to the Configuration section and turn on "Radar Engineering Mode".
-
+
3\. Scroll down to the Diagnostic section and you will see that when REM is enabled, the move and still energy for gates 0-8 are shown.
-
+
The gates are 0.75meter increments from the sensor - allowing you to "tune" each 0.75 meter section until your sensor works as intended!
-
+
-
+
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.
-
+
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.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/msr2/setup/zones-hlk.md b/docs/products/msr2/setup/zones-hlk.md
index 158e08d506..12201270e7 100755
--- a/docs/products/msr2/setup/zones-hlk.md
+++ b/docs/products/msr2/setup/zones-hlk.md
@@ -20,41 +20,41 @@ The default password to connect to the HLKRadarTool is "HiLink".
1\. Head to the ESPHome Integrations page then select your MSR-2 and scroll down until you see LD2410 Bluetooth.
-
+
2\. Open the app and select your device
-
+
3\. Turn on Engineering Mode
-
+
4\. Select More and then select Parameter settings
-
+
5\. Select Detect background noise
-
+
6\. 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.
-
+
7\. 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
-
+
**Maximum** - Sets the gate sensitivity to the maximum move and still energy
-
+
**Intelligent** - Sets the gate sensitivity equal to or just above the maximum move and still energy.
-****
+****
###### Manual Calibration
@@ -62,6 +62,6 @@ The default password to connect to the HLKRadarTool is "HiLink".
2\. Select Motion or Static sensitivity, change it to your desired value, and select Set.
-
+
3\. Now your MSR-2 should be tuned to your environment!
\ No newline at end of file
diff --git a/docs/products/msr2/troubleshooting/msr2-boot-mode.md b/docs/products/msr2/troubleshooting/msr2-boot-mode.md
index 72937708aa..b4dc6bb4e5 100755
--- a/docs/products/msr2/troubleshooting/msr2-boot-mode.md
+++ b/docs/products/msr2/troubleshooting/msr2-boot-mode.md
@@ -12,7 +12,7 @@ description: Step by step guide for putting The MSR-2 In Boot Mode.
1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button).
-
+
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.
@@ -26,6 +26,6 @@ description: Step by step guide for putting The MSR-2 In Boot Mode.
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.
-
+
4\. Continue with uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/msr2/troubleshooting/msr2-code.md b/docs/products/msr2/troubleshooting/msr2-code.md
index e081444cd4..2fccb01b6e 100755
--- a/docs/products/msr2/troubleshooting/msr2-code.md
+++ b/docs/products/msr2/troubleshooting/msr2-code.md
@@ -12,7 +12,7 @@ If your device has already been connected to Home Assistant please 2 sensor. There is an X on the SCD40 sensor's PCB as well, you can see it in the image below. There is also a "gold dot" in the top left of the SCD40 when oriented properly.
-
+
4\. Gently push the SCD40 CO2 module onto the black mezzanine connector.
-
+
5\. Slide the case back over the MTR-1, making sure that the case has the hole for the LUX Sensor facing the right direction (to the right).
-
+
6\. Flip the MTR-1 back over to prepare to put the back case on.
-
+
7\. Gently press the backplate of the MTR-1 case onto the MTR-1 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.
-
+
8\. Put the stand back on if applicable.
-
+
9\. 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/mtr1/addons/adding-gpio-header-to-mtr-1.md b/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
index 9e3dcc19f5..9bf63fb5d7 100755
--- a/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
@@ -6,30 +6,30 @@ description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1
1\. Unplug your MTR-1 from power and remove the stand if attached.
-
+
2\. Remove the backplate of the MTR-1.
-
+
3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the GPIO Header addon.
-
+
-
+
4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
5\. Align the new back for your MTR-1 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.
-
+
6\. The case should sit flush and you're now ready to add functionality to your device!
-
+
-
+
[Click here to head to the GPIO Header LED Strip Tutorial!](https://wiki.apolloautomation.com/products/msr2/examples/gpio-header-control-an-led-strip/){ .md-button .md-button--primary }
\ No newline at end of file
diff --git a/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md b/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
index cbd0458171..36246b478b 100755
--- a/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
@@ -6,26 +6,26 @@ description: Step by step tutorial for adding the Rear Male USB addon to the MTR
1\. Unplug your MTR-1 from power and remove the stand if attached.
-
+
2\. Remove the backplate of the MTR-1.
-
+
3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the male Rear USB-C addon.
-
+
-
+
4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector.
-
+
5\. Align the new back for your MTR-1 that came with the Male USB-C addon. Push down on the corners closest to the USB-C addon first, and then push the back on securely on the other two corners.
-
+
6\. The case should sit flush and you're now ready to plug into a USB-C Outlet!
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/mtr1/examples/mtr1-alarmo.md b/docs/products/mtr1/examples/mtr1-alarmo.md
index 2d366f1d64..0b362ff0dd 100755
--- a/docs/products/mtr1/examples/mtr1-alarmo.md
+++ b/docs/products/mtr1/examples/mtr1-alarmo.md
@@ -9,29 +9,29 @@ My grandmother wanted a security system that would alert her when there was move
1\. Install [HACS](https://hacs.xyz/docs/use/download/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)
-
+
-
+
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.
-
+
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.)
-
+
5\. You can change the Title, Message, and Name of the alarm notification.
-
+
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.
-
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
-
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
diff --git a/docs/products/mtr1/setup/general-tips.md b/docs/products/mtr1/setup/general-tips.md
index a5b6b2cc54..cb57b6d6cf 100755
--- a/docs/products/mtr1/setup/general-tips.md
+++ b/docs/products/mtr1/setup/general-tips.md
@@ -6,11 +6,11 @@ description: Multiple helpful images for mounting, lux/rgb, and zone visualizati
##### **MTR-1 PCB with Sensors**
-
+
##### **Light Sensor (LTR-390UV)**
-
+
When mounting the MTR-1 be sure to position the device so that the large hole at the top is not covered. This allows more light to enter and will ensure better accuracy
@@ -18,19 +18,19 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak
##### **Mounting**
-
+
##### **LD2450 Performance and Electrical Parameters**
##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf)
-
+
##### **Expanding Horizontal Distance as Target Moves Further Away**
The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance.
-
+
##### **Increased ESP Temperature**
diff --git a/docs/products/mtr1/setup/zones-ha.md b/docs/products/mtr1/setup/zones-ha.md
index 88e75790eb..2a9d8de209 100755
--- a/docs/products/mtr1/setup/zones-ha.md
+++ b/docs/products/mtr1/setup/zones-ha.md
@@ -22,17 +22,17 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho
4\. Head to a dashboard view and click the pencil icon to edit dashboard then click one of the large "+" signs, type in manual, and click on it.
-
+
5\. Delete any text in the custom card then paste the YAML you copied above and click save when finished. You should now have a custom card that looks just like the card below!
-
+
6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page")
7\. Click device as shown in the image below
-
+
8\. Scroll down until you get to the Configuration section and you see the empty boxes for zones 1-3 for both X and Y coordinates.
@@ -46,7 +46,7 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho
9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -7000 mm to 7000 mm, and the Y values are 0 mm to 7000 mm.
-
+
!!! tip "Helpful Hints to understand zones better!"
@@ -62,23 +62,23 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho
10\. If you use the imperial system (Freedom Units) then you will need to do this step. Metric users can skip this. For the targets to show up correctly we first need to update the Target 1-3 X and Y measurements from inches (in) to millimeters (mm). Find Target 1-3 X and Y under the Sensors section and select them. You will want to update all 3 X and Y target values.
-
+
11\. Select the Settings cog in the top right.
-
+
12\. Change the unit of measurement to mm and select Update.
-
+
13\. Your X and Y Targets will now look like this.
-
+
14\. Now you should see targets on the card.
-
+
15\. Now we can make zones around the targets where you want to Detect presence or filter them out.
diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md
index ec04c50ae7..bb0e722a2b 100755
--- a/docs/products/mtr1/setup/zones-hlk.md
+++ b/docs/products/mtr1/setup/zones-hlk.md
@@ -22,7 +22,7 @@ The ESPHome Integrations page then select your MTR-1 and scroll down until you see LD2450 Bluetooth.
-
+
2\. Open the HLKRadarTool App and select your device.
@@ -30,11 +30,11 @@ The uploading the firmware document.
\ No newline at end of file
diff --git a/docs/products/mtr1/troubleshooting/mtr1-code.md b/docs/products/mtr1/troubleshooting/mtr1-code.md
index aa9ef31e64..7a0fd41101 100755
--- a/docs/products/mtr1/troubleshooting/mtr1-code.md
+++ b/docs/products/mtr1/troubleshooting/mtr1-code.md
@@ -12,7 +12,7 @@ If your device has already been connected to Home Assistant please Apollo PUMP-1 Installer.
-
+
5\. Select the open com port then click Connect.
-
+
7\.. Click Install PUMP-1.
-
+
7\. Click Install.
-
+
8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
-
+
!!! warning "Power cycle your device before doing anything else!"
diff --git a/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md b/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md
index 6228f41331..ec352e0fbf 100755
--- a/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md
+++ b/docs/products/new-product-template/troubleshooting/productname-reset-wi-fi-credentials.md
@@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP
2\. Long press the Boot button (the button on the right) for 10 seconds.
-
+
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
diff --git a/docs/products/new-product-template/troubleshooting/productname-teardown.md b/docs/products/new-product-template/troubleshooting/productname-teardown.md
index b43e5c591f..095800a7bb 100755
--- a/docs/products/new-product-template/troubleshooting/productname-teardown.md
+++ b/docs/products/new-product-template/troubleshooting/productname-teardown.md
@@ -14,22 +14,22 @@ description: >-
1\. Unplug the USB-C cable and remove the lid.
-
+
2\. Remove the 3 pin JST connectors using your fingers or needle nose pliers.
-
+
3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling - this makes removal much easier.
-
+
###### Reassembly
1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1.
-
+
2\. Insert the JST connector coming from your bottle's sensor into the **right-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection. Follow up by inserting the second JST connector from the optional fluid output sensor into the **left-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. Finally, place the lid on top of the pump-1 case and gently snap it in place.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/products/plt1/examples/blueprint.md b/docs/products/plt1/examples/blueprint.md
index 37721c53c0..8959f2d99a 100644
--- a/docs/products/plt1/examples/blueprint.md
+++ b/docs/products/plt1/examples/blueprint.md
@@ -14,17 +14,17 @@ description: >-
2\. Click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation PLT-1 Blueprint** and click on **Select a device** then choose your **Apollo PLT-1** or **PLT-1B** from the dropdown menu.
-
+
4\. Enter your **plant's name** (this appears in notification messages), then select your **mobile device** for push notifications.
5\. Enable the sensor groups you want to monitor (e.g. Soil Moisture, Air Temperature, Light Intensity) and adjust the thresholds to suit your plant.
-
+
!!! success "Each sensor group is disabled by default — enable only what matters!"
@@ -41,19 +41,19 @@ description: >-
1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**.
-
+
2\. Copy this link and paste it into the **Blueprint address** box and click **Preview** then click **Import blueprint**.
-
+
3\. Click on **Apollo Automation PLT-1 Blueprint** and click on **Select a device** then choose your **Apollo PLT-1** or **PLT-1B** from the dropdown menu.
-
+
4\. Enter your **plant's name**, select your **mobile device**, enable the sensor groups you want, and set your thresholds.
-
+
!!! success "Each sensor group is disabled by default — enable only what matters!"
diff --git a/docs/products/plt1/examples/flower-card.md b/docs/products/plt1/examples/flower-card.md
index b0a9e29bd2..5be7eab68c 100755
--- a/docs/products/plt1/examples/flower-card.md
+++ b/docs/products/plt1/examples/flower-card.md
@@ -2,7 +2,7 @@
title: PLT-1 Flower Card
description: This suggests using the Flower Card inside Home Assistant for your device!
---
-
+
Home Assistant Plant Integration + 4\. Gently push the SCD40 CO2 module onto the black mezzanine connector. - + 5\. Slide the case back over the MTR-1, making sure that the case has the hole for the LUX Sensor facing the right direction (to the right). - + 6\. Flip the MTR-1 back over to prepare to put the back case on. - + 7\. Gently press the backplate of the MTR-1 case onto the MTR-1 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. - + 8\. Put the stand back on if applicable. - + 9\. 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/mtr1/addons/adding-gpio-header-to-mtr-1.md b/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md index 9e3dcc19f5..9bf63fb5d7 100755 --- a/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md +++ b/docs/products/mtr1/addons/adding-gpio-header-to-mtr-1.md @@ -6,30 +6,30 @@ description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1 1\. Unplug your MTR-1 from power and remove the stand if attached. - + 2\. Remove the backplate of the MTR-1. - + 3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the GPIO Header addon. - + - + 4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 5\. Align the new back for your MTR-1 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. - + 6\. The case should sit flush and you're now ready to add functionality to your device! - + - + [Click here to head to the GPIO Header LED Strip Tutorial!](https://wiki.apolloautomation.com/products/msr2/examples/gpio-header-control-an-led-strip/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md b/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md index cbd0458171..36246b478b 100755 --- a/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md +++ b/docs/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md @@ -6,26 +6,26 @@ description: Step by step tutorial for adding the Rear Male USB addon to the MTR 1\. Unplug your MTR-1 from power and remove the stand if attached. - + 2\. Remove the backplate of the MTR-1. - + 3\. Identify the "X" on the PCB on the back of your MTR-1 and the "X" on the top left corner of the male Rear USB-C addon. - + - + 4\. Keep the "X" aligned on both sides and gently push down until it securely seats in the small mezzanine connector. - + 5\. Align the new back for your MTR-1 that came with the Male USB-C addon. Push down on the corners closest to the USB-C addon first, and then push the back on securely on the other two corners. - + 6\. The case should sit flush and you're now ready to plug into a USB-C Outlet! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/mtr1/examples/mtr1-alarmo.md b/docs/products/mtr1/examples/mtr1-alarmo.md index 2d366f1d64..0b362ff0dd 100755 --- a/docs/products/mtr1/examples/mtr1-alarmo.md +++ b/docs/products/mtr1/examples/mtr1-alarmo.md @@ -9,29 +9,29 @@ My grandmother wanted a security system that would alert her when there was move 1\. Install [HACS](https://hacs.xyz/docs/use/download/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) - + - + 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. - + 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.) - + 5\. You can change the Title, Message, and Name of the alarm notification. - + 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. - + 7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered. - + 8\. And that's it, seriously... Now you can enjoy a free and local security system. diff --git a/docs/products/mtr1/setup/general-tips.md b/docs/products/mtr1/setup/general-tips.md index a5b6b2cc54..cb57b6d6cf 100755 --- a/docs/products/mtr1/setup/general-tips.md +++ b/docs/products/mtr1/setup/general-tips.md @@ -6,11 +6,11 @@ description: Multiple helpful images for mounting, lux/rgb, and zone visualizati ##### **MTR-1 PCB with Sensors** - + ##### **Light Sensor (LTR-390UV)** - + When mounting the MTR-1 be sure to position the device so that the large hole at the top is not covered. This allows more light to enter and will ensure better accuracy @@ -18,19 +18,19 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak ##### **Mounting** - + ##### **LD2450 Performance and Electrical Parameters** ##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf) - + ##### **Expanding Horizontal Distance as Target Moves Further Away** The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance. - + ##### **Increased ESP Temperature** diff --git a/docs/products/mtr1/setup/zones-ha.md b/docs/products/mtr1/setup/zones-ha.md index 88e75790eb..2a9d8de209 100755 --- a/docs/products/mtr1/setup/zones-ha.md +++ b/docs/products/mtr1/setup/zones-ha.md @@ -22,17 +22,17 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho 4\. Head to a dashboard view and click the pencil icon to edit dashboard then click one of the large "+" signs, type in manual, and click on it. - + 5\. Delete any text in the custom card then paste the YAML you copied above and click save when finished. You should now have a custom card that looks just like the card below! - + 6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page") 7\. Click device as shown in the image below - + 8\. Scroll down until you get to the Configuration section and you see the empty boxes for zones 1-3 for both X and Y coordinates. @@ -46,7 +46,7 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho 9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -7000 mm to 7000 mm, and the Y values are 0 mm to 7000 mm. - + !!! tip "Helpful Hints to understand zones better!" @@ -62,23 +62,23 @@ Below are steps to manually enter in the X and Y coordinates for each zone in Ho 10\. If you use the imperial system (Freedom Units) then you will need to do this step. Metric users can skip this. For the targets to show up correctly we first need to update the Target 1-3 X and Y measurements from inches (in) to millimeters (mm). Find Target 1-3 X and Y under the Sensors section and select them. You will want to update all 3 X and Y target values. - + 11\. Select the Settings cog in the top right. - + 12\. Change the unit of measurement to mm and select Update. - + 13\. Your X and Y Targets will now look like this. - + 14\. Now you should see targets on the card. - + 15\. Now we can make zones around the targets where you want to Detect presence or filter them out. diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md index ec04c50ae7..bb0e722a2b 100755 --- a/docs/products/mtr1/setup/zones-hlk.md +++ b/docs/products/mtr1/setup/zones-hlk.md @@ -22,7 +22,7 @@ The](http
1\. Position the MSR-2 as shown in the image below and locate the small opening to press the boot button (the right button).
-
+
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.
@@ -20,23 +20,23 @@ If your device has already been connected to Home Assistant please <a href=){kind=link}
This integration can automatically fetch data from OpenPlantBook if you are a registered user. Registration is free.
Plants are set up in the UI and all configuration of your plants can be managed there or by automations and scripts. diff --git a/docs/products/plt1/general-tips.md b/docs/products/plt1/general-tips.md index f7953c6ed9..290d345d74 100755 --- a/docs/products/plt1/general-tips.md +++ b/docs/products/plt1/general-tips.md @@ -8,4 +8,4 @@ description: Helpful tips to get the most use out of your sensor. For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/plt1/setup/prevent-sleep.md b/docs/products/plt1/setup/prevent-sleep.md index 388b657989..26a8381aee 100755 --- a/docs/products/plt1/setup/prevent-sleep.md +++ b/docs/products/plt1/setup/prevent-sleep.md @@ -14,11 +14,11 @@ description: Tutorial for how to enable/disable prevent sleep. 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 5 minutes. diff --git a/docs/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/products/plt1/troubleshooting/plt1-boot-mode.md index 3084f12a70..1fa4b8fde6 100755 --- a/docs/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/products/plt1/troubleshooting/plt1-boot-mode.md @@ -12,7 +12,7 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. 1\. Position the PLT-1 as shown in the image below and locate the small opening to press the boot button. - + 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. @@ -26,6 +26,6 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. 3\. Hold down the boot button, then press and release the reset button while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with uploading the firmware document. \ No newline at end of file diff --git a/docs/products/plt1/troubleshooting/plt1-code.md b/docs/products/plt1/troubleshooting/plt1-code.md index 2d9d8194b0..c0305644f8 100755 --- a/docs/products/plt1/troubleshooting/plt1-code.md +++ b/docs/products/plt1/troubleshooting/plt1-code.md @@ -12,29 +12,29 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. - + 2\. Navigate to our installer page and click connect under Non Battery Firmware Apollo PLT-1 Installer 3\. Click the big "Connect" button. - + 4\. Select the open com port then click Connect. - + 5\. Click "Install ApolloAutomation.PLT-1". - + 6\. Click "INSTALL". - + 7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md b/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md index 02cb8eddd5..8c99f3cf1b 100755 --- a/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md +++ b/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md @@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PLT- 2\. Long press the Boot button for 10 seconds - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/products/plt1b/additional-info/insert-battery.md b/docs/products/plt1b/additional-info/insert-battery.md index 2e16013b50..c31af6ef72 100644 --- a/docs/products/plt1b/additional-info/insert-battery.md +++ b/docs/products/plt1b/additional-info/insert-battery.md @@ -10,28 +10,28 @@ description: How to Insert Battery on PLT-1B. 1\. Gently press your thumb on the case above the stake and the lid should pop off. - + 2\. Hold the case and push the stake down a bit, then gently lift it out of the bottom case section. - + 3\. Flip the PLT-1B over and identify the `+` and `-` markings. The `+` is on the left side and the `-` is on the right side. Double check before going any further. 4\. The top of the battery (the positive end, marked with a `+` and a small ring around the terminal) goes on the left side, matching the `+` on the PLT-1B. - + 5\. Hold the PCB. You'll need to use a bit of force to push in the battery. Start with the right `-` side, then push in the left `+` side. - + 6\. Flip the sensor back over and lay the PCB inside the case so it sits flat. - + 7\. Line up the notch in the top left of the lid, then gently press down until the lid snaps into place. - + You have now installed or reinstalled the battery! \ No newline at end of file diff --git a/docs/products/plt1b/general-tips.md b/docs/products/plt1b/general-tips.md index 6e098b9fd5..a569e1de74 100755 --- a/docs/products/plt1b/general-tips.md +++ b/docs/products/plt1b/general-tips.md @@ -8,4 +8,4 @@ description: Helpful tips to get the most use out of your sensor. For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md index 56712c6c7b..25ceb70bf1 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -8,15 +8,15 @@ description: Step by step guide for putting The PLT-1B In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. - + ##### Method 1: Boot Button Only 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. - + - + 2\. Use a pin to press and hold the boot button, while holding the boot button plug the PLT-1B back into your computer/power and then release the boot button @@ -28,8 +28,8 @@ description: Step by step guide for putting The PLT-1B In Boot Mode. 2\. Press and hold the boot button, while holding it press and release the reset button, then release the boot button - + - + 3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-code/) \ No newline at end of file diff --git a/docs/products/plt1b/troubleshooting/plt1b-code.md b/docs/products/plt1b/troubleshooting/plt1b-code.md index ae2534b6b8..e02b44a9e8 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/products/plt1b/troubleshooting/plt1b-code.md @@ -14,17 +14,17 @@ If your device has already been connected to Home Assistant please Put your device in boot mode by holding down the boot button and then plugging in the USB cable. - + 2\. Navigate to our installer page and click connect under Battery Firmware Apollo PLT-1B Installer @@ -52,23 +52,23 @@ If your device has already been connected to Home Assistant please Apollo PUMP-1 Installer. - + 5\. Select the open com port then click Connect. - + 7\.. Click Install PUMP-1. - + 7\. Click Install. - + 8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md b/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md index 6228f41331..ec352e0fbf 100755 --- a/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md +++ b/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md @@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP 2\. Long press the Boot button (the button on the right) for 10 seconds. - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/products/pump1/troubleshooting/pump1-teardown.md b/docs/products/pump1/troubleshooting/pump1-teardown.md index b43e5c591f..095800a7bb 100755 --- a/docs/products/pump1/troubleshooting/pump1-teardown.md +++ b/docs/products/pump1/troubleshooting/pump1-teardown.md @@ -14,22 +14,22 @@ description: >- 1\. Unplug the USB-C cable and remove the lid. - + 2\. Remove the 3 pin JST connectors using your fingers or needle nose pliers. - + 3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling - this makes removal much easier. - + ###### Reassembly 1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1. - + 2\. Insert the JST connector coming from your bottle's sensor into the **right-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection. Follow up by inserting the second JST connector from the optional fluid output sensor into the **left-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. Finally, place the lid on top of the pump-1 case and gently snap it in place. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md b/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md index 3ac4ddd8f5..68099dbb11 100755 --- a/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md +++ b/docs/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md @@ -4,7 +4,7 @@ description: Tutorial on adding the LD2412 mmwave sensor to your R PRO-1 --- # Install the LD2412 in R PRO-1 - + !!! tip "Check out the gif above or step by step directions below!" @@ -12,20 +12,20 @@ description: Tutorial on adding the LD2412 mmwave sensor to your R PRO-1 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Place the LD2412 on the 4 and 3 pin headers (only fits one way). - + 4\. Place back into the case with the ethernet module facing up and the usb-c port facing you. - + 5\. Snap the lid back into place! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md b/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md index 7fbc6d7335..ae85a328e3 100755 --- a/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md +++ b/docs/products/rpro1/addons/adding-co2-to-r-pro-1.md @@ -6,7 +6,7 @@ description: Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. With the back removed, identify the bottom left 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. @@ -17,12 +17,12 @@ description: Tutorial on adding the SCD40 CO2 sensor to your R-Pro-1. 3\. Gently push the SCD40 CO2 module onto the black mezzanine connector. - + 4\. Slide the case back over the R PRO-1, making sure that the case has the hole for the USB-C port and the SCD40 facing toward you. 5\. Gently press the backplate of the R PRO-1 case onto the R PRO-1 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. - + [Click here to head to the CO2 calibration guide!](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md index fe7ef71573..43eeac1adc 100755 --- a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md +++ b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md @@ -8,11 +8,11 @@ description: Tutorial on adding the gang box mounts to your R-Pro-1. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently lift the PCB out of the case and set it face up with the USB-C port facing down. - + 3\. Take the two gang box mount pieces and identify the one labeled "TOP" and the other piece which is the bottom mount. @@ -22,26 +22,26 @@ description: Tutorial on adding the gang box mounts to your R-Pro-1. 3\. Gently push the top mount labeled "TOP" into the pcb as shown below. Make sure the orientation is identical to the image below! - + 4\. Gently push the top mount into the pcb as shown below. Make sure the orientation is identical to the image below! - + 5\. The end result should look identical to the image below. You are now ready to install it inside of a 1 gang box. - + ###### Install in 1-Gang Box 1\. Line up the holes in your 1-gang box (yours will be attached to the wall already). - + 2\. Place screws through the blank faceplate and gently place over the r-pro-1 mounting holes. - + 3\. Screw in the screws slowly to make sure not to break the mounts or the blank faceplate. At the end yours will look just like the image below! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md index 58d271f9a2..0319f25329 100755 --- a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md +++ b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md @@ -12,13 +12,13 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. 1\. Unplug your R PRO-1 from power and remove the back. - + - + 2\. Gently lift the PCB out of the case and set it face up with the USB-C port facing down. - + 3\. Take the two ceiling mount pieces and identify the one labeled "TOP" and the other piece which is the bottom mount. @@ -28,15 +28,15 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. 3\. Gently push the top mount labeled "TOP" into the pcb as shown below. Make sure the orientation is identical to the image below! - + 4\. Gently push the bottom mount into the pcb as shown below. Make sure the orientation is identical to the image below! - + 5\. The end result should look identical to the image below. You are now ready to install it inside of the ceiling mount. - + ###### Cut the Ceiling Hole @@ -46,22 +46,22 @@ The Ceiling Mount needs a 3.5 inch (around 89mm) circular hole in the ceiling. C 1\. Remove the cover to expose the inside of the installed Ceiling Mount. - + 2\. Plug in Ethernet cable or USB-C cable. - + 3\. Gently slide R PRO-1 into the Ceiling Mount. - + 4\. Push the R PRO-1 back 1inch (around 2.5cm) to make sure the lip of the cover fits over the Ceiling Mount. - + 5\. Gently press the ceiling mount cover until it is securely attached to the Ceiling Mount. - + \ No newline at end of file diff --git a/docs/products/rpro1/calibrating-co2.md b/docs/products/rpro1/calibrating-co2.md index 4427c558c6..e431278ba9 100755 --- a/docs/products/rpro1/calibrating-co2.md +++ b/docs/products/rpro1/calibrating-co2.md @@ -16,7 +16,7 @@ This article will guide you through a simple calibration of your CO2 1\. Plug in your sensor outdoors and leave it for at least 5 minutes to allow the readings to stabilize. This should be around 420 ppm per NASA. - + 2\. Go to your Home Assistant dashboard and hit the letter "e" - It will pop up with an entity filter then type in "Calibrate CO2" and select the correct device. @@ -24,8 +24,8 @@ This article will guide you through a simple calibration of your CO2 If you cannot get this menu to pop-up, click somewhere on the Home Assistant dashboard then press your "e" key. - + 3\. Click on the button that says "PRESS" and then you are done. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-general-tips.md b/docs/products/rpro1/setup/rpro1-general-tips.md index f3e2dfb474..0a40ee17f0 100755 --- a/docs/products/rpro1/setup/rpro1-general-tips.md +++ b/docs/products/rpro1/setup/rpro1-general-tips.md @@ -6,7 +6,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi ##### **Light Sensor (LTR-390UV)** - + The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't directly reach the sensor for UV detection. However, light can still enter from around the edges or behind the front panel, allowing the lux readings to spike when ambient light is present. @@ -18,13 +18,13 @@ The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't di The R PRO-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120 degree FOV for the LD2450 and 150 degree FOV for the LD2412. - + ##### **Ceiling Mounting** The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ceiling using our ceiling mount kit. - + !!! tip "There are actually two sensors in your r-pro-1 if you bought the optional LD2412 addon!" @@ -50,4 +50,4 @@ The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ##### **Gate Visualization** - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-switch-firmware.md b/docs/products/rpro1/setup/rpro1-switch-firmware.md index ac5aea3fb0..5ad4ae1d25 100755 --- a/docs/products/rpro1/setup/rpro1-switch-firmware.md +++ b/docs/products/rpro1/setup/rpro1-switch-firmware.md @@ -14,15 +14,15 @@ description: >- 1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R PRO-1. - + 2\. Scroll down until you see the "Firmware Type" dropdown and select "Ethernet". - + 3\. Locate the Firmware Update entity and click on "PRESS". - + 4\. Wait a few minutes - this will download the new firmware file from our github repo and then install the image. @@ -32,15 +32,15 @@ description: >- 1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below your Apollo R PRO-1. - + 2\. Scroll down until you see the "Firmware Type" dropdown and select "WiFi". - + 3\. Locate the Firmware Update entity and click on "PRESS". - + 4\. Wait a few minutes - this will download the new firmware file from our github repo and then install the image. diff --git a/docs/products/rpro1/setup/zones-ha-new.md b/docs/products/rpro1/setup/zones-ha-new.md index 5f892d5ce1..942fe2e4e6 100755 --- a/docs/products/rpro1/setup/zones-ha-new.md +++ b/docs/products/rpro1/setup/zones-ha-new.md @@ -20,11 +20,11 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 2\. Scroll down until you see "LD2450 Zone Type" and choose "Detection" from the drop-down menu. - + 3\. Begin entering in the X and Y coordinates for each zone. - + !!! null "Helpful Hints to understand LD2450 zones better!" diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index 3d7655f57f..e8f171658f 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -32,17 +32,17 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 4\. Head to a dashboard view and click the pencil icon to edit dashboard then click one of the large "+" signs, type in manual, and click on it. - + 5\. Delete any text in the custom card then paste the YAML you copied above and click save when finished. You should now have a custom card that looks just like the card below! - + 6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page") 7\. Click device as shown in the image below - + 8\. Scroll down until you get to the Configuration section and you see the empty boxes for zones 1-3 for both X and Y coordinates. @@ -56,7 +56,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -7000 mm to 7000 mm, and the Y values are 0 mm to 7000 mm. - + !!! tip "Helpful Hints to understand zones better!" @@ -72,23 +72,23 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 10\. If you use the imperial system (Freedom Units) then you will need to do this step. Metric users can skip this. For the targets to show up correctly we first need to update the Target 1-3 X and Y measurements from inches (in) to millimeters (mm). Find Target 1-3 X and Y under the Sensors section and select them. You will want to update all 3 X and Y target values. - + 11\. Select the Settings cog in the top right. - + 12\. Change the unit of measurement to mm and select Update. - + 13\. Your X and Y Targets will now look like this. - + 14\. Now you should see targets on the card. - + 15\. Now we can make zones around the targets where you want to Detect presence or filter them out. @@ -100,7 +100,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on "1 device" below the Apollo R PRO-1. - + 2\. Scroll down until you see "LD2412 Mode" and change it from "Normal" to "Engineering". @@ -112,14 +112,14 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 3\. Scroll down to the Diagnostic section and you will see "LD2412 g00 move energy" through "LD2412 g13 still energy" are showing percentages from 0-100%. - + 4\. Scroll up to the Configuration section and identify the threshold sliders for g0-g13 for both moving and still energy. 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. - + 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. - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/rpro1/setup/zones-hlk.md b/docs/products/rpro1/setup/zones-hlk.md index c5bcfb48e9..0f63a5613e 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -24,7 +24,7 @@ The ESPHome Integrations page then select your R PRO-1 and scroll down until you see LD2450 Bluetooth. - + 2\. Open the HLKRadarTool App and select your device. @@ -32,11 +32,11 @@ The ESPHome Integrations page then select your R PRO-1 and scroll down until you see **LD2412 Bluetooth**. Toggle it on. - + 2\. Open the HLKRadarTool app. Your R PRO-1 should appear in the device list. Tap it to connect. @@ -104,7 +104,7 @@ The same HLKRadarTool app is used for both sensors. The LD2412 connects over Bluetooth, which means you need to be within a few feet of the sensor for it to appear in the app. If it doesn't show up, move closer and pull down to refresh the list. - + 3\. Once connected, enable **Engineering Mode** as shown above. This turns on the live energy graph, which shows you what the sensor is actually seeing at each distance gate in real time. @@ -116,7 +116,7 @@ The same HLKRadarTool app is used for both sensors. 4\. Leave the room empty and make sure nothing is moving, then tap **Auto** in the app. The sensor scans the environment for about 10 seconds and automatically sets thresholds to filter out static interference from electronics, HVAC, and other background sources. When it's done you'll see **Completed** and the app will return to showing the detection distance. This gives you a clean baseline before any manual tuning. - + 5\. Tap **Settings** in the top right and use the **Detection Range** slider to set which gates the sensor monitors. You can set both a start and end gate — for example, Gate 3 to Gate 6 means the sensor only looks between 2.25m and 4.5m from the device. Limiting the range prevents the sensor from picking up movement through walls or in adjacent rooms. @@ -124,14 +124,14 @@ The same HLKRadarTool app is used for both sensors. Each gate is 0.75m. Gate 1 = 0.75m, Gate 2 = 1.5m, Gate 3 = 2.25m, Gate 4 = 3m, Gate 5 = 3.75m, Gate 6 = 4.5m, Gate 7 = 5.25m, Gate 8 = 6m. - + 6\. To fine-tune which distances trigger detection, head to the ESPHome Integrations page, select your R PRO-1, and use the gate sensitivity sliders on the device page. - **Raise** a gate's sensitivity to make it harder to trigger at that distance (useful for ignoring a fan, HVAC vent, or a window where cars pass). - **Lower** a gate's sensitivity to make it more sensitive at that distance (useful for reliably detecting someone sitting still in a chair). - + 7\. Tap **Settings** at the top of the app and set the **Unmanned Duration**. This controls how many seconds the sensor waits after it stops detecting before it reports "no one present." The default is 10 seconds — increase it if you're getting false "nobody home" readings in your space. In Home Assistant, this same setting is called **LD2412 Timeout**. diff --git a/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md b/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md index 7c170e56cd..47633aa3b8 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md +++ b/docs/products/rpro1/troubleshooting/rpro1-boot-mode.md @@ -12,15 +12,15 @@ description: Step by step guide for putting The R PRO-1 In Boot Mode. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Locate the boot button on the bottom right side of the PCB. - + 4\. 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 R PRO-1 then let go of the button. @@ -30,19 +30,19 @@ description: Step by step guide for putting The R PRO-1 In Boot Mode. 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Locate the boot button on the bottom right side of the PCB. - + 4\. Locate the reset button on the bottom left side of the PCB. - + 5\. 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. diff --git a/docs/products/rpro1/troubleshooting/rpro1-code.md b/docs/products/rpro1/troubleshooting/rpro1-code.md index 6921bd527f..25be9c4cd9 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-code.md +++ b/docs/products/rpro1/troubleshooting/rpro1-code.md @@ -12,29 +12,29 @@ If your device has already been connected to Home Assistant please as shown here. 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 R PRO-1 then let go of the button. - + 3\. Navigate to our installer page and click connect under Apollo R PRO-1 Installer. 3\. Click the big "Connect" button. - + 3\. Select the open com port then click Connect. - + 4\. Click "Install R PRO-1". - + 5\. Click "INSTALL". - + 6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. - + !!! warning "Power cycle your device before doing anything else!" diff --git a/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md b/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md index 2ca448b35b..ac8bc78031 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md +++ b/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md @@ -8,7 +8,7 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your R PR 2\. Long press the Boot button (the button on the right) for 10 seconds. - + 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. diff --git a/docs/products/rpro1/troubleshooting/rpro1-teardown.md b/docs/products/rpro1/troubleshooting/rpro1-teardown.md index 245b726f68..3a91fa6c78 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-teardown.md +++ b/docs/products/rpro1/troubleshooting/rpro1-teardown.md @@ -8,34 +8,34 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts, 1\. Unplug your R PRO-1 from power and remove the back. - + 2\. Gently remove the PCB from the case and flip it over. - + 3\. Gently remove the LD2412 as shown below. - + 4\. Gently remove the LD2450 as shown below. - + ###### Reassembly 1\. Place the LD2450 on the 8 pin header. - + 2\. Place the LD2412 on the 4 and 3 pin headers (only fits one way). - + 3\. Place back into the case with the ethernet module facing up and the usb-c port facing you. - + 4\. Snap the lid back into place! - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temp1/addons/food-probe.md b/docs/products/temp1/addons/food-probe.md index 2a5b74e144..41964bdd64 100755 --- a/docs/products/temp1/addons/food-probe.md +++ b/docs/products/temp1/addons/food-probe.md @@ -6,13 +6,13 @@ description: Step by step guide for installing and using the optional Food Probe The TEMP-1 comes with an optional food probe which can be used to monitor food temperatures when baking, grilling, etc. It includes a heat-resistant cable but the TEMP-1 itself needs to stay in a cool environment. - + 1\. To use your food probe simply take it out of the package and insert it into the 3.5mm port on your TEMP-1. - + - + 2\. Once inserted, proceed to step 3 unless you have a battery in it @@ -22,11 +22,11 @@ The TEMP-1 comes with an optional food probe which can be used to monitor food t - + 3\. Go to the device page of your TEMP-1 in Home Assistant and choose probe "Food". - + !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/temp1/addons/magnetic-mount.md b/docs/products/temp1/addons/magnetic-mount.md index 7a8eed8701..495caee00c 100755 --- a/docs/products/temp1/addons/magnetic-mount.md +++ b/docs/products/temp1/addons/magnetic-mount.md @@ -6,27 +6,27 @@ description: Step by step guide for installing and using the optional Magnetic M The TEMP-1 comes with an optional magnetic mount which can be used to secure the TEMP-1 to your fridge or grill as shown below. - + 1\. To use your magnetic mount place it with the magnet facing upwards as shown: - + 2\. Align the lid with the hole in the top right and place your TEMP-1 inside the magnetic mount and gently press down. - + - + 3\. It will sit flush as shown in the image below. - + 4\. Affix your TEMP-1 to the outside of fridge or a safe cool place on the grill. - + - + !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/temp1/addons/multiple-probes.md b/docs/products/temp1/addons/multiple-probes.md index 9584f894db..d5af079fea 100755 --- a/docs/products/temp1/addons/multiple-probes.md +++ b/docs/products/temp1/addons/multiple-probes.md @@ -12,11 +12,11 @@ The TEMP-1 comes with an optional [3.5mm Multi-Probe Splitter](https://apolloaut 1\. To use your TEMP-1 Multi-Probe Splitter gently plug it into the 3.5mm port on your device. - + 2\. Plug in your long or short temp probes into the Multi-Probe Splitter. - + !!! success "Power on your TEMP-1 after plugging in all of your probes!" @@ -24,19 +24,19 @@ The TEMP-1 comes with an optional [3.5mm Multi-Probe Splitter](https://apolloaut 3\. Go to the device page of your TEMP-1 in Home Assistant and confirm the Temperature Probe is selected from the dropdown. - + 4\. Enable the disabled 3rd and 4th temp probe entities if you have more than 2 probes! - + 5\. Once completed you will see all four probes updating the temperature! - + 6\. To rename the probes you can edit each probe and choose a unique name such as "Fridge Probe" and "Freezer Probe" as shown below! - + !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/temp1/addons/temp-probe.md b/docs/products/temp1/addons/temp-probe.md index 7ec0bae253..86fe512fce 100755 --- a/docs/products/temp1/addons/temp-probe.md +++ b/docs/products/temp1/addons/temp-probe.md @@ -8,17 +8,17 @@ The TEMP-1 comes with an optional temp probe which can be used to monitor a frid 1\. To use your temp probe simply take it out of the package and insert it into the 3.5mm port on your TEMP-1. - + - + 2\. Once inserted, proceed to step 3. - + 3\. Go to the device page of your TEMP-1 in Home Assistant and choose the Temperature Probe. - + !!! danger "Do not leave your sensor outside or let it get wet!" @@ -26,15 +26,15 @@ The TEMP-1 comes with an optional temp probe which can be used to monitor a frid **Example images of the long temperature probe in a mini freezer:** - + - + ## Probe Pinout The 1.5m and 20cm DS18B20 temp probes use a standard 3.5mm TRS plug. Wire yours the same way if you're building your own probe or repairing a cut cable. - + | Contact | Signal | | --- | --- | diff --git a/docs/products/temp1/examples/hot-water-recirculation.md b/docs/products/temp1/examples/hot-water-recirculation.md index 57c23ea354..9d3630c350 100644 --- a/docs/products/temp1/examples/hot-water-recirculation.md +++ b/docs/products/temp1/examples/hot-water-recirculation.md @@ -116,7 +116,7 @@ Donovan's whole system is one blueprint. Import it, pick your entities, set your 2\. Click **Preview**, then **Import blueprint**. - + 3\. Click **Apollo Automation Hot Water Recirculation (TEMP-1)**, create an automation from it, and fill in the inputs below. diff --git a/docs/products/temp1/examples/temp1-alert-example.md b/docs/products/temp1/examples/temp1-alert-example.md index fd8a60cbc0..6b9768a84a 100755 --- a/docs/products/temp1/examples/temp1-alert-example.md +++ b/docs/products/temp1/examples/temp1-alert-example.md @@ -12,12 +12,12 @@ This will guide you through how to setup the built in alarm using the temperatur 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30F so I would want to go slightly above that range. However, in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temp1/examples/temp1-automation-examples.md b/docs/products/temp1/examples/temp1-automation-examples.md index dbb0f7bd5f..1a6a448fb9 100755 --- a/docs/products/temp1/examples/temp1-automation-examples.md +++ b/docs/products/temp1/examples/temp1-automation-examples.md @@ -12,11 +12,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -24,11 +24,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -36,11 +36,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -72,7 +72,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -80,11 +80,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -92,11 +92,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -127,122 +127,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/products/temp1/setup/prevent-sleep.md b/docs/products/temp1/setup/prevent-sleep.md index 4cf9fac91d..d759dca993 100755 --- a/docs/products/temp1/setup/prevent-sleep.md +++ b/docs/products/temp1/setup/prevent-sleep.md @@ -14,11 +14,11 @@ description: Guide for setting up and using the prevent sleep toggle with the TE 2\. Click on the name "1 device" below your Apollo device's name. - + 3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". - + 4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 8 minutes. diff --git a/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md b/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md index bfd2203d18..9ac30ecb0f 100644 --- a/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md +++ b/docs/products/temp1/setup/temp1-change-temp-probe-update-interval.md @@ -12,7 +12,7 @@ By default the TEMP-1 reports its **Temperature Probe** every 60 seconds. You ca 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on your TEMP-1. - + 2\. Paste this YAML below your device's existing config. The `!extend` keyword edits the probe that is already defined in the firmware, so you only need the lines you want to change. @@ -27,13 +27,13 @@ sensor: update_interval: 10s ``` - + 3\. In the top right click "SAVE" and then "INSTALL". When the install options appear, choose "On the network". 4\. Once you see the logs showing the new update interval of 10 seconds the flash has succeeded and you can click "STOP" to exit. - + Your Temperature Probe will now report at the new interval. diff --git a/docs/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/products/temp1/troubleshooting/temp1-boot-mode.md index 57cebc0484..b34bf40ebb 100755 --- a/docs/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/products/temp1/troubleshooting/temp1-boot-mode.md @@ -12,13 +12,13 @@ description: Step by step guide for putting The TEMP-1 In Boot Mode. 1\. Position the TEMP-1 so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. - + If you prefer, please remove the lid by gently prying up on the small slit by the top of the case. - + - + 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 TEMP-1 then let go of the button. @@ -32,6 +32,6 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Hold down the boot button (shown above), then press and release the reset button (shown below) while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1/troubleshooting/temp1-code/). \ No newline at end of file diff --git a/docs/products/temp1/troubleshooting/temp1-code.md b/docs/products/temp1/troubleshooting/temp1-code.md index 23d0998876..f493d06e72 100755 --- a/docs/products/temp1/troubleshooting/temp1-code.md +++ b/docs/products/temp1/troubleshooting/temp1-code.md @@ -20,23 +20,23 @@ If your device has already been connected to Home Assistant please in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1B will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temp1b/examples/temp1b-automation-examples.md b/docs/products/temp1b/examples/temp1b-automation-examples.md index 7f4d6b0bad..5448213591 100755 --- a/docs/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/products/temp1b/examples/temp1b-automation-examples.md @@ -12,11 +12,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -24,11 +24,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1B device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -36,11 +36,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1B reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -72,7 +72,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -80,11 +80,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1b device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -92,11 +92,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1B reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -127,122 +127,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/products/temp1b/setup/insert-battery.md b/docs/products/temp1b/setup/insert-battery.md index 88c0dbf2a2..2582aa8449 100755 --- a/docs/products/temp1b/setup/insert-battery.md +++ b/docs/products/temp1b/setup/insert-battery.md @@ -10,44 +10,44 @@ description: How to Insert Battery on TEMP-1B. 1\. Gently pry open the case lid as shown in the image below. - + - + 2\. Once the lid is removed either lift the PCB out or gently dump the pcb out by turning it upside down. - + - + 3\. Align the battery as shown in the image below. - + 4\. Insert the battery with the positive terminal facing the + sign. - + - + 5\. Begin reassembly by placing the battery side down with the RGB led in the top right corner. - + - + 6\. You will use the "ledge" of the case to set the PCB down and then it will lay down and rest on the ledge of the other side as well. - + - + 7\. Align the RGB led in the top right with the small hole in the lid. - + 8\. Gently press down until it the lid seats. - + 9 You have now installed or reinstalled the battery! \ No newline at end of file diff --git a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md index 231835f4c2..4027f9365b 100755 --- a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md +++ b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md @@ -12,13 +12,13 @@ description: Step by step guide for putting The TEMP-1B In Boot Mode. 1\. Position the TEMP-1B so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. - + If you prefer, please remove the lid by gently prying up on the small slit by the top of the case. - + - + 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 TEMP-1B then let go of the button. @@ -32,6 +32,6 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Hold down the boot button (shown above), then press and release the reset button (shown below) while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1b/troubleshooting/temp1b-code/). \ No newline at end of file diff --git a/docs/products/temp1b/troubleshooting/temp1b-code.md b/docs/products/temp1b/troubleshooting/temp1b-code.md index ec21ee2682..fc7993b017 100755 --- a/docs/products/temp1b/troubleshooting/temp1b-code.md +++ b/docs/products/temp1b/troubleshooting/temp1b-code.md @@ -20,7 +20,7 @@ If your device has already been connected to Home Assistant please in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off - \ No newline at end of file + \ No newline at end of file diff --git a/docs/products/temppro1/examples/temp1-automation-examples.md b/docs/products/temppro1/examples/temp1-automation-examples.md index dbb0f7bd5f..507a0b3ff2 100755 --- a/docs/products/temppro1/examples/temp1-automation-examples.md +++ b/docs/products/temppro1/examples/temp1-automation-examples.md @@ -12,11 +12,11 @@ This will guide you through how to setup an automation in Home Assistant using t 2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. - + 3\. We now need to convert F to C since the max and min temps are measured in Celsius. My new values I will input are max probe temp 2°C and a min probe temp of -30°C. Reminder, yours will likely be different values, especially your max probe temp. - + 4\. The automation is now ready to be created - @@ -24,11 +24,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. - + 7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -36,11 +36,11 @@ This will guide you through how to setup an automation in Home Assistant using t 8\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and "Check the freezer!". - + 9\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -72,7 +72,7 @@ This will guide you through how to setup an automation in Home Assistant using t 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. - + 2\. Place the food probe inside your food once it's on the grill. Make sure your TEMP-1 is in a cool dry place - only the food probe and the wire can withstand temperatures on a grill, in the oven, etc. @@ -80,11 +80,11 @@ This will guide you through how to setup an automation in Home Assistant using t 4\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. - + 5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. - + !!! tip "If you still do not see your device as shown in step 7 read this!" @@ -92,11 +92,11 @@ This will guide you through how to setup an automation in Home Assistant using t 6\. Type in your preferred message and if you want, check the box for title and type in your title for the message as well. Mine says: "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and "Check the food!". - + 7\. Click save in the bottom right and then give it a Name and optionally a Description and a Category as well. You are done! - + --- @@ -127,122 +127,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo 1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. - + 2\. Edit your dashboard, add a button card, select Chicken Monitor, and then save. - + 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! 4\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "On". Advanced users skip to step 25 for the YAML. - + 5\. Create a Trigger ID for this called "Chicken Monitor On". - + 6\. Click Add Trigger then Entity then State and search for "Chicken Monitor" then in the box labeled "To" select "Off". Create a Trigger ID for this called "Chicken Monitor Off". - + 7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. - + 8\. Create a Trigger ID for this called "Temp Reached". - + 9\. Click Add Action and search "choose" then select it. - + 10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. - + 11\. Check off the option "Button Pressed" that we created in step 5 above. - + 12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. - + 13\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 14\. Click "Advanced Options" and then click the check box for Color name then select a color from the dropdown such as Green. - + 15\. While still under Option 1 in the choose action: Click Add Action and search "mobile" and then select your phone in the list. - + 16\. Write in a custom title and or message- the message is required but the title is not. - + 17\. This is how option 1 will look when you are done with this part: - + 18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. - + 19\. Check off the option "Temp Reached" that we created in step 7 above. - + 20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. - + 21\. Under Until Conditions, select "Add condition" then search "state". - + 22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. - + 23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below. - + 24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device - + 25\. Head down to Add Action under Option 2 and search "mobile" then select your phone as you did above in step 15. Give it a message and a title as shown below. - + 26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. - + 27\. Click "Add Option" (this is now Option 3). We will choose add condition then search "triggered by" and then choose the "Chicken Monitor Off" Trigger ID that we created in step 6. 28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off. - + 29\. Click choose entity then search for your device such as "Temp-1 RGB Light". - + 30\. Choose "Add Action" and search mobile like we did above and select your mobile phone. Give it an optional title and message as shown below. - + 31\. Click save in the bottom right then give it a name and save - + 32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md index 71f2a9cfa4..ccbf87f961 100755 --- a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md +++ b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md @@ -12,11 +12,11 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. 1\. Position the TEMP Pro-1 so that the USB-C port is facing you. Remove the lid by gently prying up on the small slit by the top of the case. - + 2\. Locate the boot button as show in the image below. - + 3\. 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 TEMP Pro-1 then let go of the button. @@ -30,6 +30,6 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. 3\. Hold down the boot button (shown above), then press and release the reset button (shown below) while keeping the boot button pressed. Finally, release the boot button. - + 4\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temppro1/troubleshooting/temp-pro1-code/). \ No newline at end of file diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-code.md b/docs/products/temppro1/troubleshooting/temp-pro1-code.md index 7e4e7cf504..dd0b9f3746 100755 --- a/docs/products/temppro1/troubleshooting/temp-pro1-code.md +++ b/docs/products/temppro1/troubleshooting/temp-pro1-code.md @@ -16,23 +16,23 @@ If your device has already been connected to Home Assistant please - 1\. Gently pry open the case lid as shown in the image below. - + 2\. The teardown is complete! \ No newline at end of file From d7e5a0b21030f7629389229ebaa32b99588ea0f5 Mon Sep 17 00:00:00 2001 From: Justin Bunton <130115204+Bunton33@users.noreply.github.com> Date: Mon, 12 Oct 2026 06:27:58 -0400 Subject: [PATCH 2/4] docs: fix typos, grammar, and product and brand name casing One copy-edit pass over all 710 pages, clear errors only (no rewording for style, no technical changes). An independent reviewer per chunk checked every changed hunk against HEAD. - 151 typos (e.g. "sumamry", "Presense", "recieve"), 94 grammar fixes (e.g. "set up" as a verb, "comes", sentence capitals), 7 British to US spellings. - 43 product ID slips (Air-1, temp-1, btn-1, R-Pro-1 -> AIR-1, TEMP-1, BTN-1, R PRO-1) and 191 brand casing slips (esphome, home assistant, WiFi, Github, Youtuber, usb-c, bluetooth -> ESPHome, Home Assistant, Wi-Fi, GitHub, YouTuber, USB-C, Bluetooth). Wi-Fi is the dominant form in the repo (256 vs 64). - Untouched by design: code, YAML, URLs, entity IDs, hostnames, hotspot and device-reported names, on-screen labels, external video titles, and all numbers. A script checked every file against HEAD for this. Co-Authored-By: Claude Opus 5.5
Community
diff --git a/docs/homey/products/air1/addons/adding-co2-to-air-1.md b/docs/homey/products/air1/addons/adding-co2-to-air-1.md index 0afab68d1b..048d3c77b9 100755 --- a/docs/homey/products/air1/addons/adding-co2-to-air-1.md +++ b/docs/homey/products/air1/addons/adding-co2-to-air-1.md @@ -1,5 +1,5 @@ --- -title: add SCD40 CO₂ Sensor +title: Add SCD40 CO₂ Sensor description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1. --- # Adding CO2 to AIR-1 diff --git a/docs/homey/products/air1/addons/adding-gpio-header-to-air-1.md b/docs/homey/products/air1/addons/adding-gpio-header-to-air-1.md index ff20050acd..8a0c535532 100755 --- a/docs/homey/products/air1/addons/adding-gpio-header-to-air-1.md +++ b/docs/homey/products/air1/addons/adding-gpio-header-to-air-1.md @@ -20,7 +20,7 @@ description: Adding Optional GPIO Header to AIR-1.  -5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below +5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below.  diff --git a/docs/homey/products/air1/air1-reviews.md b/docs/homey/products/air1/air1-reviews.md index ee74ffbca6..c059259e25 100755 --- a/docs/homey/products/air1/air1-reviews.md +++ b/docs/homey/products/air1/air1-reviews.md @@ -1,4 +1,4 @@ --- -description: "Youtuber reviews and feedback about the AIR-1 sensor from Apollo Automation." +description: "YouTuber reviews and feedback about the AIR-1 sensor from Apollo Automation." --- --8<-- "products/air1/air1-reviews.md:5:" \ No newline at end of file diff --git a/docs/homey/products/air1/examples/air-quality-notification-example.md b/docs/homey/products/air1/examples/air-quality-notification-example.md index ecba4f74a2..a048144f91 100755 --- a/docs/homey/products/air1/examples/air-quality-notification-example.md +++ b/docs/homey/products/air1/examples/air-quality-notification-example.md @@ -30,7 +30,7 @@ description: Example flow that sends alerts based on changing indoor air quality  -7\. Duplicate steps 4 and 5 above but this time select "CO2 becomes less than" and place it on your flow canvas.Make sure to fill in your less than ppm value such as 1000. +7\. Duplicate steps 4 and 5 above but this time select "CO2 becomes less than" and place it on your flow canvas. Make sure to fill in your less than ppm value such as 1000.  @@ -38,7 +38,7 @@ description: Example flow that sends alerts based on changing indoor air quality  -9\. Draw a line to connect "CO2 becomes greater than 999 ppm. Click the 3 dots and select a color - we have chosen red to indicate a problem. +9\. Draw a line to connect "CO2 becomes greater than 999 ppm". Click the 3 dots and select a color - we have chosen red to indicate a problem.  diff --git a/docs/homey/products/air1/troubleshooting/air1-code.md b/docs/homey/products/air1/troubleshooting/air1-code.md index 8295fcae89..d89e3999d6 100755 --- a/docs/homey/products/air1/troubleshooting/air1-code.md +++ b/docs/homey/products/air1/troubleshooting/air1-code.md @@ -38,4 +38,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and setup your sensor as a new device! \ No newline at end of file +8\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file diff --git a/docs/homey/products/general/calibrating-and-updating/co2-calibration.md b/docs/homey/products/general/calibrating-and-updating/co2-calibration.md index 47c8031525..b85ca3b92b 100755 --- a/docs/homey/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/homey/products/general/calibrating-and-updating/co2-calibration.md @@ -29,7 +29,7 @@ description: "Step by step guide for re-calibrating your SCD40 CO2 sensor" It might take several attempts clicking the "Press" button for it to equalize correctly. If you don't see the SCD40 reporting 400-500 ppm then click the button again. -5\. Now your CO2 sensor should be calibrated! Be sure to setup some nice flows and check out the insights so you can monitor the CO2 levels. +5\. Now your CO2 sensor should be calibrated! Be sure to set up some nice flows and check out the insights so you can monitor the CO2 levels.  diff --git a/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md b/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md index ccf5eb958e..f51f620716 100755 --- a/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md +++ b/docs/homey/products/general/calibrating-and-updating/mmwave-videos.md @@ -1,5 +1,5 @@ --- -description: "Two short videos and a quick sumamry on how to best tune the LD2410B in the MSR-2!" +description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2!" --- # This needs to be redone for Homey if it can be duplicated. @@ -21,7 +21,7 @@ How to tune the mmWave sensor using radar engineering mode.**Detection**: Only detects targets within each of the three zones.
**Filter**: Excludes a zone from detection and detects presence everywhere else. + You can use any of these three choices to control your R PRO-1 differently. The most common option is "Detection" which lets you set up three areas and track three targets within them.
**Disabled**: Disables multi-zone area detection and just tracks one big area.
**Detection**: Only detects targets within each of the three zones.
**Filter**: Excludes a zone from detection and detects presence everywhere else. Disabled allows you to just use the sensor as a "basic" presence sensor and "Filter" lets you filter out an area and detect everything else, which is useful to avoid a fan! diff --git a/docs/homey/products/temp1/addons/magnetic-mount.md b/docs/homey/products/temp1/addons/magnetic-mount.md index 9de17e541a..752d9c0f01 100755 --- a/docs/homey/products/temp1/addons/magnetic-mount.md +++ b/docs/homey/products/temp1/addons/magnetic-mount.md @@ -21,7 +21,7 @@ The TEMP-1 comes with an optional magnetic mount which can be used to secure the  -4\. Affix your TEMP-1 to the outside of fridge or a safe cool place on the grill. +4\. Affix your TEMP-1 to the outside of a fridge or a safe cool place on the grill.  diff --git a/docs/homey/products/temp1/examples/temp1-alert-example.md b/docs/homey/products/temp1/examples/temp1-alert-example.md index 00c46636b4..7b210a1178 100755 --- a/docs/homey/products/temp1/examples/temp1-alert-example.md +++ b/docs/homey/products/temp1/examples/temp1-alert-example.md @@ -5,11 +5,11 @@ description: "Step by step guide for alerting outside the set range with the TEM ###### -This will guide you through how to setup the built in alarm using the temperature probe in your freezer! +This will guide you through how to set up the built in alarm using the temperature probe in your freezer! 1\. Place the temperature probe into your freezer (not the entire TEMP-1, just the probe!) and then wait for it to normalize around 0 degrees F aka -18C. -2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30F so I would want to go slightly above that range. However, in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. +2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30F so I would want to go slightly above that range. However, in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. My minimums are around -20F.  @@ -17,6 +17,6 @@ This will guide you through how to setup the built in alarm using the temperatur  -4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off +4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1 will play an audible alert with its buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off  \ No newline at end of file diff --git a/docs/homey/products/temp1/examples/temp1-automation-examples.md b/docs/homey/products/temp1/examples/temp1-automation-examples.md index 0d61f133a9..10c24c297a 100755 --- a/docs/homey/products/temp1/examples/temp1-automation-examples.md +++ b/docs/homey/products/temp1/examples/temp1-automation-examples.md @@ -5,11 +5,11 @@ description: "Multiple automation examples with the TEMP-1." ###### Freezer Temperature Probe Example -This will guide you through how to setup an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. +This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. 1\. Place the temperature probe into your freezer and then wait for it to normalize around 0°F (-18°C). Make sure your TEMP-1 is in a cool dry place - only the temp probe and wire can withstand the temperatures in the fridge, freezer, etc. -2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. +2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. My minimums are around -20°F.  @@ -21,11 +21,11 @@ This will guide you through how to setup an automation in Home Assistant using t 5\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there! -6\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10. +6\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you found in step 2 above. Advanced users skip to step 10.  -7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. +7\. Click Add Action then type in "iPhone" and select your phone. If you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed.  @@ -67,7 +67,7 @@ mode: single ###### Food Probe Example -This will guide you through how to setup an automation in Home Assistant using the food probe with Chicken(or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. +This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken(or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. @@ -77,11 +77,11 @@ This will guide you through how to setup an automation in Home Assistant using t 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left. Click here to go straight there! -4\. Click Add Trigger then Entity then Numeric state and search for your temp-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. +4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1 device such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8.  -5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. +5\. Click Add Action then type in "iPhone" and select your phone. If you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed.  @@ -146,7 +146,7 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -7\. Click Add Trigger then Entity then Numeric state and search for your temp-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill. +7\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1 food probe entity such as "temp-1 max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 160°F(71.1C) because the Chicken will rest and reach 165°F once removed from the oven/grill.  @@ -214,7 +214,7 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device +24\. Search "light toggle" in the search bar shown then select "Choose entity" and select the rgb led for your device  @@ -222,7 +222,7 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. +26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already set up.  @@ -244,4 +244,4 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file +32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to Discord user RalphP for this example! \ No newline at end of file diff --git a/docs/homey/products/temp1/faq.md b/docs/homey/products/temp1/faq.md index cd65645c89..4e8d6a0cc9 100755 --- a/docs/homey/products/temp1/faq.md +++ b/docs/homey/products/temp1/faq.md @@ -21,7 +21,7 @@ Sensor Interface: Equipped with a 3.5mm jack for connecting optional external te 4\. **How does the TEMP-1 connect to Home Assistant?** -* The TEMP-1 connects via WiFi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. +* The TEMP-1 connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. 5\. **How often does the TEMP-1 send sensor data?** @@ -29,7 +29,7 @@ Sensor Interface: Equipped with a 3.5mm jack for connecting optional external te 6\. **Can I customize the TEMP-1 functionality?** -* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the TEMP-1. Our YAML is on Github and our .STEP and .STL CAD files are available for community use. +* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the TEMP-1. Our YAML is on GitHub and our .STEP and .STL CAD files are available for community use. 7\. **What are the RGB LED and piezo buzzer used for?** diff --git a/docs/homey/products/temp1/reviews.md b/docs/homey/products/temp1/reviews.md index b6407266cb..1fdcabe333 100755 --- a/docs/homey/products/temp1/reviews.md +++ b/docs/homey/products/temp1/reviews.md @@ -1,5 +1,5 @@ --- -description: "Youtuber reviews and feedback about the TEMP-1 sensor from Apollo Automation." +description: "YouTuber reviews and feedback about the TEMP-1 sensor from Apollo Automation." --- # [Simon Says Home Assistant](https://youtu.be/95etWGwEJPE?si=gdLCXFiWmuj2JUjD) diff --git a/docs/homey/products/temp1/setup/prevent-sleep.md b/docs/homey/products/temp1/setup/prevent-sleep.md index 05151144b8..d78b682d20 100755 --- a/docs/homey/products/temp1/setup/prevent-sleep.md +++ b/docs/homey/products/temp1/setup/prevent-sleep.md @@ -5,7 +5,7 @@ description: "Guide for setting up and using the prevent sleep toggle with the T !!! tip "Put your sensors to sleep!" - All of our battery powered device are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements. + All of our battery powered devices are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements. The temperature offsets needed will be much lower for your sensors as the microcontroller will not put off as much heat when it is sleeping and then waking for short periods to report the sensor values. diff --git a/docs/homey/products/temp1/troubleshooting/temp1-code.md b/docs/homey/products/temp1/troubleshooting/temp1-code.md index cc1847194c..fc6f61b086 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-code.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-code.md @@ -37,4 +37,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and setup your sensor as a new device! \ No newline at end of file +7\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file diff --git a/docs/homey/products/temp1/troubleshooting/temp1-teardown.md b/docs/homey/products/temp1/troubleshooting/temp1-teardown.md index 08df6e0463..4faa3ab9da 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-teardown.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-teardown.md @@ -19,7 +19,7 @@ description: "Step by step guide for tearing down your TEMP-1 to replace parts,  -4\. Make sure during reassembly that the RGB LED is in the bottom left as shown in image below then press on the lid as shown below until it snaps into place! +4\. Make sure during reassembly that the RGB LED is in the bottom left as shown in the image below then press on the lid as shown below until it snaps into place!  diff --git a/docs/homey/products/temp1b/addons/magnetic-mount.md b/docs/homey/products/temp1b/addons/magnetic-mount.md index ca8a14a27e..3e70d04179 100755 --- a/docs/homey/products/temp1b/addons/magnetic-mount.md +++ b/docs/homey/products/temp1b/addons/magnetic-mount.md @@ -21,7 +21,7 @@ The TEMP-1B comes with an optional magnetic mount which can be used to secure th  -4\. Affix your TEMP-1B to the outside of fridge or a safe cool place on the grill. +4\. Affix your TEMP-1B to the outside of a fridge or a safe cool place on the grill.  diff --git a/docs/homey/products/temp1b/examples/temp1b-alert-example.md b/docs/homey/products/temp1b/examples/temp1b-alert-example.md index ed40cafad0..2b143c7355 100755 --- a/docs/homey/products/temp1b/examples/temp1b-alert-example.md +++ b/docs/homey/products/temp1b/examples/temp1b-alert-example.md @@ -5,11 +5,11 @@ description: "Step by step guide for alerting outside the set range with the TEM ###### -This will guide you through how to setup the built in alarm using the temperature probe in your freezer! +This will guide you through how to set up the built in alarm using the temperature probe in your freezer! 1\. Place the temperature probe into your freezer (not the entire TEMP-1B, just the probe!) and then wait for it to normalize around 0 degrees F aka -18C. -2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30F so I would want to go slightly above that range. However, in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. my minimums are around -20F. +2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30F so I would want to go slightly above that range. However, in most freezers they should NOT reach above 0F so you will likely need to input a lower value than me. My minimums are around -20F.  @@ -17,6 +17,6 @@ This will guide you through how to setup the built in alarm using the temperatur  -4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1B will play an audible alert with it's buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off +4\. Enable the "Alarm Outside Temp Range" toggle and now your TEMP-1B will play an audible alert with its buzzer when the temp thresholds are reached. If the temp goes under the min or over the max the alarm will go off  \ No newline at end of file diff --git a/docs/homey/products/temp1b/examples/temp1b-automation-examples.md b/docs/homey/products/temp1b/examples/temp1b-automation-examples.md index 805ec8ef00..14d1bef0e5 100755 --- a/docs/homey/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/homey/products/temp1b/examples/temp1b-automation-examples.md @@ -5,11 +5,11 @@ description: "Multiple automation examples with the TEMP-1B." ###### Freezer Temperature Probe Example -This will guide you through how to setup an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. +This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. 1\. Place the temperature probe into your freezer and then wait for it to normalize around 0°F (-18°C). Make sure your TEMP-1B is in a cool dry place - only the temp probe and wire can withstand the temperatures in the fridge, freezer, etc. -2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. my minimums are around -20°F. +2\. Once normalized, look at the graph and determine a good value to set for both the maximum and minimum temperatures. My mini freezer seems to max out at 30°F so I would want to go slightly above that range. However, in most freezers, they should NOT reach above 0°F so you will likely need to input a lower value than me. My minimums are around -20°F.  @@ -25,7 +25,7 @@ This will guide you through how to setup an automation in Home Assistant using t  -7\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. +7\. Click Add Action then type in "iPhone" and select your phone. If you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed.  @@ -67,7 +67,7 @@ mode: single ###### Food Probe Example -This will guide you through how to setup an automation in Home Assistant using the food probe with Chicken(or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. +This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken(or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. 1\. Set your Max Probe Temp to 73.9°C. The offsets MUST be in Celsius even if you are using F in the automation below. @@ -77,11 +77,11 @@ This will guide you through how to setup an automation in Home Assistant using t 3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left. Click here to go straight there! -4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1b device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8. +4\. Click Add Trigger then Entity then Numeric state and search for your TEMP-1B device such as "temp-1b max probe temp" then in the box labeled "Above" type in the max probe temp number you want for your food - In this example we will use 165°F(73.9C) such as the temperature it's safe to cook Chicken to. Advanced users skip to step 8.  -5\. Click Add Action then type in "iPhone" and select your phone. if you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed. +5\. Click Add Action then type in "iPhone" and select your phone. If you do not see your phone or have an Android, try typing in "notify" instead and scrolling down until you find your phone listed.  @@ -214,7 +214,7 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -24\. Search "light toggle" in the search bar shown then select "Choose entity" and select your the rgb led for your device +24\. Search "light toggle" in the search bar shown then select "Choose entity" and select the rgb led for your device  @@ -222,7 +222,7 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already setup. +26\. Optionally add another action here for speaking out loud on your smart speakers such as Homepods. Click add Action then search "TTS". This requires you to have piper and a few other things already set up.  @@ -244,4 +244,4 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  -32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to discord user RalphP for this example! \ No newline at end of file +32\. You now have one automation which unifies the button you created in the dashboard and alerts you when your chicken is almost done via a phone notification, a blinking green led, and an optional TTS notification to your smart speakers! Thanks again to Discord user RalphP for this example! \ No newline at end of file diff --git a/docs/homey/products/temp1b/faq.md b/docs/homey/products/temp1b/faq.md index 7547a6e69a..86e25e7317 100755 --- a/docs/homey/products/temp1b/faq.md +++ b/docs/homey/products/temp1b/faq.md @@ -27,7 +27,7 @@ description: "Frequently asked questions about the TEMP-1B temperature sensor." 6\. **How does the TEMP-1B connect to Home Assistant?** -* The TEMP-1B connects via WiFi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. +* The TEMP-1B connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. 7\. **How often does the TEMP-1B send sensor data?** @@ -35,7 +35,7 @@ description: "Frequently asked questions about the TEMP-1B temperature sensor." 8\. **Can I customize the TEMP-1B’s functionality?** -* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the TEMP-1B. Our YAML is on Github and our .STEP and .STL CAD files are available for community use. +* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the TEMP-1B. Our YAML is on GitHub and our .STEP and .STL CAD files are available for community use. 9\. **What are the RGB LED and piezo buzzer used for?** @@ -55,7 +55,7 @@ description: "Frequently asked questions about the TEMP-1B temperature sensor." 13\. **What’s the difference between the battery and non-battery versions?** -* The TEMP-1B is battery-operated and slightly larger, while the non-battery (NB) version is compact and requires USB-C power at 5 volts using 1amp or less (5W). They both have all of the same components for measuring soil moisture, air temp/humdity, lux/uv, etc. +* The TEMP-1B is battery-operated and slightly larger, while the non-battery (NB) version is compact and requires USB-C power at 5 volts using 1amp or less (5W). They both have all of the same components for measuring soil moisture, air temp/humidity, lux/uv, etc. 14\. **Can I use multiple TEMP-1B sensors in one Home Assistant setup?** diff --git a/docs/homey/products/temp1b/reviews.md b/docs/homey/products/temp1b/reviews.md index fe12abb815..f3644bd6c5 100755 --- a/docs/homey/products/temp1b/reviews.md +++ b/docs/homey/products/temp1b/reviews.md @@ -1,5 +1,5 @@ --- -description: "Youtuber reviews and feedback about the TEMP-1B sensor from Apollo Automation." +description: "YouTuber reviews and feedback about the TEMP-1B sensor from Apollo Automation." --- # [Simon Says Home Assistant](https://youtu.be/95etWGwEJPE?si=gdLCXFiWmuj2JUjD) diff --git a/docs/homey/products/temp1b/setup/insert-battery.md b/docs/homey/products/temp1b/setup/insert-battery.md index 522fb603d5..4c0221cc1a 100755 --- a/docs/homey/products/temp1b/setup/insert-battery.md +++ b/docs/homey/products/temp1b/setup/insert-battery.md @@ -45,7 +45,7 @@ description: "How to Insert Battery on TEMP-1B."  -8\. Gently press down until it the lid seats. +8\. Gently press down until the lid seats.  diff --git a/docs/homey/products/temp1b/setup/prevent-sleep.md b/docs/homey/products/temp1b/setup/prevent-sleep.md index f922c59acd..dc6e11ff08 100755 --- a/docs/homey/products/temp1b/setup/prevent-sleep.md +++ b/docs/homey/products/temp1b/setup/prevent-sleep.md @@ -5,7 +5,7 @@ description: "Keep the TEMP-1B awake instead of letting it sleep, and what that !!! tip "Put your sensors to sleep!" - All of our battery powered device are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements. + All of our battery powered devices are able to go to sleep to save battery life. Our non-battery sensor devices like the AIR-1 and PLT-1 can also sleep to get better temperature and humidity measurements. The temperature offsets needed will be much lower for your sensors as the microcontroller will not put off as much heat when it is sleeping and then waking for short periods to report the sensor values. diff --git a/docs/homey/products/temp1b/troubleshooting/temp1b-code.md b/docs/homey/products/temp1b/troubleshooting/temp1b-code.md index c6f19b98bc..1172203fb5 100755 --- a/docs/homey/products/temp1b/troubleshooting/temp1b-code.md +++ b/docs/homey/products/temp1b/troubleshooting/temp1b-code.md @@ -37,4 +37,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and setup your sensor as a new device! \ No newline at end of file +7\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file diff --git a/docs/homey/products/temp1b/troubleshooting/temp1b-teardown.md b/docs/homey/products/temp1b/troubleshooting/temp1b-teardown.md index 7ea60870f0..037ac5e096 100755 --- a/docs/homey/products/temp1b/troubleshooting/temp1b-teardown.md +++ b/docs/homey/products/temp1b/troubleshooting/temp1b-teardown.md @@ -9,7 +9,7 @@ description: "Step by step guide for tearing down your TEMP-1B to replace parts,  -2\. Once the lid is removed either lift the PCB out or gently dump the pcb out by turning it upside down. +2\. Once the lid is removed either lift the PCB out or gently dump the PCB out by turning it upside down.  diff --git a/docs/index.md b/docs/index.md index 56a9259df3..d71a7c1fe3 100755 --- a/docs/index.md +++ b/docs/index.md @@ -117,7 +117,7 @@ flowchart LR * [Understanding your AIR-1 and the various sensors it exposes](https://wiki.apolloautomation.com/products/air1/setup/general-tips/) * [How to re-calibrate your CO2 sensor](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/) * [Put your Apollo devices to sleep!](https://wiki.apolloautomation.com/products/general/battery-sensors/prevent-sleep/) -* [Setup your new M-1 LED Matrix with Multiple Panels](https://wiki.apolloautomation.com/products/m1/setup/m1-multiple-panels/) +* [Set up your new M-1 LED Matrix with Multiple Panels](https://wiki.apolloautomation.com/products/m1/setup/m1-multiple-panels/) * [3D Print your own case in any color or material](https://wiki.apolloautomation.com/products/general/links/) ### Community diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md index 2ce3b324a6..be9c70d825 100644 --- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md +++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/device-builder-tour.md @@ -61,7 +61,7 @@ Click anything in the navigator to see its settings here as a form. Every field #### YAML editor (right) -The right pane is the raw YAML for your device, colour-coded with line numbers. You can read it, scroll it, and edit it directly. +The right pane is the raw YAML for your device, color-coded with line numbers. You can read it, scroll it, and edit it directly. The form pane and the YAML editor are always in sync. Edit either side and the other updates instantly. You can learn [YAML](what-is-yaml.md) by reading what the forms produce. diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md index 3adec0cdc8..a9089183b0 100644 --- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md +++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/what-is-yaml.md @@ -6,7 +6,7 @@ description: A short primer on YAML, the configuration format ESPHome uses, with YAML is a plain-text format used to describe configuration in a way that is readable for both people and computers. ESPHome uses YAML to describe what your device is and what it should do. -You do not have to write YAML yourself when using the **ESPHome Device Builder**. The Builder generates it for you as you click around. Recognising what you are looking at when you peek at the YAML view helps you understand what your device is doing, and a little YAML opens up advanced settings the GUI does not expose. +You do not have to write YAML yourself when using the **ESPHome Device Builder**. The Builder generates it for you as you click around. Recognizing what you are looking at when you peek at the YAML view helps you understand what your device is doing, and a little YAML opens up advanced settings the GUI does not expose. ## The basics diff --git a/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md b/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md index 048091c469..012c61a7e0 100644 --- a/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md +++ b/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md @@ -27,7 +27,7 @@ Connect the Breakout Module to the ESP32-C6 using one of the FPC ribbon cables t The latches are small and the ribbon cable is fragile. Lift the latch with a fingernail, slide the cable in, and press the latch down. Never pull on the cable itself. -2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place. +2\. Flip up the latch on the FPC connector then gently slide the ribbon cable into the connector with the blue side facing upwards. Gently press the latch down to lock it in place.  diff --git a/docs/products/ESPHome-Starter-Kit/modules/button-module.md b/docs/products/ESPHome-Starter-Kit/modules/button-module.md index 0640e0c466..c992ea7dc5 100644 --- a/docs/products/ESPHome-Starter-Kit/modules/button-module.md +++ b/docs/products/ESPHome-Starter-Kit/modules/button-module.md @@ -27,7 +27,7 @@ Connect the button module to the ESP32-C6 using one of the FPC ribbon cables tha The latches are small and the ribbon cable is fragile. Lift the latch with a fingernail, slide the cable in, and press the latch down. Never pull on the cable itself. -2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place. +2\. Flip up the latch on the FPC connector then gently slide the ribbon cable into the connector with the blue side facing upwards. Gently press the latch down to lock it in place.  @@ -109,7 +109,7 @@ With the device back online, the button entity is live on the web server. - Wire up the ESPHome Starter Kit RGB & Buzzer module, add it through ESPHome - Device Builder, then turn the lights and off and change colors. + Device Builder, then turn the lights on and off and change colors. --- # Adding the LED & Buzzer Module @@ -27,7 +27,7 @@ Connect the LED & Buzzer module to the ESP32-C6 using one of the FPC ribbon cabl The latches are small and the ribbon cable is fragile. Lift the latch with a fingernail, slide the cable in, and press the latch down. Never pull on the cable itself. -2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place. +2\. Flip up the latch on the FPC connector then gently slide the ribbon cable into the connector with the blue side facing upwards. Gently press the latch down to lock it in place.  diff --git a/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md b/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md index 909404b26c..ea674dbe33 100755 --- a/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md +++ b/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md @@ -28,7 +28,7 @@ Connect the Temperature and Humidity module to the ESP32-C6 using one of the FPC The latches are small and the ribbon cable is fragile. Lift the latch with a fingernail, slide the cable in, and press the latch down. Never pull on the cable itself. -2\. Flip up the latch on the FPC connector then gently slide the ribbon cable in to the connector with the blue side facing upwards. Gently press the latch down to lock it in place. +2\. Flip up the latch on the FPC connector then gently slide the ribbon cable into the connector with the blue side facing upwards. Gently press the latch down to lock it in place.  diff --git a/docs/products/ESPHome-Starter-Kit/setup/first-steps.md b/docs/products/ESPHome-Starter-Kit/setup/first-steps.md index a10b95d790..cea209b7e7 100755 --- a/docs/products/ESPHome-Starter-Kit/setup/first-steps.md +++ b/docs/products/ESPHome-Starter-Kit/setup/first-steps.md @@ -181,7 +181,7 @@ The Onboard RGB LED is a small LED above the Reset button of your ESP32-C6. Usef ### Boot Mode -The device is required to be flashed via USB using the bootloader mode the very first time it is used. Once you flash it once, you do not have to do these steps again +The device is required to be flashed via USB using the bootloader mode the very first time it is used. Once you flash it once, you do not have to do these steps again. !!! tip "Use a quality USB-C cable and power source" diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md index 056d5df6c0..631ea1f561 100644 --- a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md +++ b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md @@ -27,7 +27,7 @@ Device Builder has an **Add Component** flow that drops the proxy into your conf 3. Search for **Bluetooth Proxy** and select it. 4. Click **Add**. Device Builder inserts the proxy into your YAML. - + ??? note "Prefer to add it by hand? Here's the YAML" diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md index c85162cc9d..01af581665 100644 --- a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md +++ b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md @@ -25,7 +25,7 @@ Out of the box, your RGB module turns on, turns off, and changes color. ESPHome 3. Turn on **Show advanced settings** near the bottom of the form. Effects are an advanced option, so the field stays hidden until you do. 4. Scroll to **Effects** and click **\+ Add**. -5. Pick **Addressable Rainbow** from the dropdown. Its own settings unfold underneath: **Name**, **Speed**, and **Width**. Leave them alone for now, the greyed-out values are the defaults ESPHome uses. (1) +5. Pick **Addressable Rainbow** from the dropdown. Its own settings unfold underneath: **Name**, **Speed**, and **Width**. Leave them alone for now, the grayed-out values are the defaults ESPHome uses. (1) { .annotate } 1. Want something other than rainbow? Everything in the dropdown works on your RGB module, and the full library is documented at esphome.io/components/light. The entries starting with "Addressable" animate each LED separately, which is what makes a rainbow or a wipe travel along the strip. The rest, like **Pulse**, **Strobe**, and **Flicker**, drive the whole strip as one color at a time. diff --git a/docs/products/air1/addons/adding-gpio-header-to-air-1.md b/docs/products/air1/addons/adding-gpio-header-to-air-1.md index df24502e58..23fbecc83b 100755 --- a/docs/products/air1/addons/adding-gpio-header-to-air-1.md +++ b/docs/products/air1/addons/adding-gpio-header-to-air-1.md @@ -20,7 +20,7 @@ description: Adding Optional GPIO Header to AIR-1.  -5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below +5\. Flip the PCB over and identify the Top Right corner where the small black mezzanine connector lives. You will see an "X" indicating which corner needs to be lined up with the PCB of the GPIO Header. There is an X on the GPIO Header's PCB as well, you can see it in the images below.  diff --git a/docs/products/air1/air1-reviews.md b/docs/products/air1/air1-reviews.md index 4956f52e4e..0706c6b187 100755 --- a/docs/products/air1/air1-reviews.md +++ b/docs/products/air1/air1-reviews.md @@ -1,6 +1,6 @@ --- title: AIR-1 Reviews -description: Youtuber reviews and feedback about the AIR-1 sensor from Apollo Automation. +description: YouTuber reviews and feedback about the AIR-1 sensor from Apollo Automation. --- # [The Bearded Tech Guy AIR-1 Review](https://youtu.be/k0SDJ6_SBqk?si=3uLfXC3GUDaYJNEs) diff --git a/docs/products/air1/examples/air1-dashboard-examples.md b/docs/products/air1/examples/air1-dashboard-examples.md index 14fe074c8c..985578172b 100755 --- a/docs/products/air1/examples/air1-dashboard-examples.md +++ b/docs/products/air1/examples/air1-dashboard-examples.md @@ -170,7 +170,7 @@ refresh_interval: 10 title: Bedroom CO2 ``` -##### Home Assistant Guage +##### Home Assistant Gauge  @@ -215,7 +215,7 @@ refresh_interval: 10 title: Basement VOC ``` -##### Home Assistant Guage +##### Home Assistant Gauge  diff --git a/docs/products/air1/examples/firstof9's-apex-charts.md b/docs/products/air1/examples/firstof9's-apex-charts.md index 81f0c53213..cee3404119 100755 --- a/docs/products/air1/examples/firstof9's-apex-charts.md +++ b/docs/products/air1/examples/firstof9's-apex-charts.md @@ -1,7 +1,7 @@ --- title: Firstof9's AIR-1 Apex Charts Dashboard description: >- - A custom dashboard made by discord/github user Firstof9 using Apex Charts for + 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 @@ -40,7 +40,7 @@ Now you need to be VERY careful. You are editing all of your dashboards but we c  -The easiest way to change all of the entity IDs in the code is by using AI (ChatGPT etc.) or by using a code editor like Visual Studio Code (VSC). In VSC you can Find (ctrl+f) the old ID and Replace (select the small arrow to toggle open the Replace box) it with your ID. Now you are ready to copy the code into the Raw configurator editor. (See code below) +The easiest way to change all of the entity IDs in the code is by using AI (ChatGPT etc.) or by using a code editor like Visual Studio Code (VSC). In VSC you can Find (ctrl+f) the old ID and Replace (select the small arrow to toggle open the Replace box) it with your ID. Now you are ready to copy the code into the Raw configuration editor. (See code below) VSC Find/Replace diff --git a/docs/products/air1/faq.md b/docs/products/air1/faq.md index 4f77bbef6f..e1a1979cb7 100755 --- a/docs/products/air1/faq.md +++ b/docs/products/air1/faq.md @@ -13,7 +13,7 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in 3\. **How do I connect the AIR-1 to Home Assistant?** -* The AIR-1 connects via WiFi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. +* The AIR-1 connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. 4\. **Does the AIR-1 require cloud connectivity or a subscription?** @@ -101,7 +101,7 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in 25\. **What are the optional add-ons for the AIR-1?** -* The AIR-1 offers two optional add-ons: a SCD40 CO2 sensor and the MiCS gas sensor. These can be added to enhance air quality monitoring with very accurate CO2 measurements and the ability to detect multiple gases with the MiCS gas sensor. +* The AIR-1 offers two optional add-ons: an SCD40 CO2 sensor and the MiCS gas sensor. These can be added to enhance air quality monitoring with very accurate CO2 measurements and the ability to detect multiple gases with the MiCS gas sensor. 26\. **What's in the box?** @@ -121,7 +121,7 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in 30\. **How long does it take to set up the AIR-1?** -* Setup typically takes around 5-10 minutes. Once powered and connected to WiFi, it can be configured quickly through ESPHome and Home Assistant. +* Setup typically takes around 5-10 minutes. Once powered and connected to Wi-Fi, it can be configured quickly through ESPHome and Home Assistant. 31\. **How secure is the AIR-1?** diff --git a/docs/products/air1/introduction.md b/docs/products/air1/introduction.md index 3890acd275..bf9f5db2ff 100755 --- a/docs/products/air1/introduction.md +++ b/docs/products/air1/introduction.md @@ -4,7 +4,7 @@ description: Documentation for AIR-1, including setup, usage, and best practices --- -The Apollo AIR-1 is a compact, feature-rich air quality sensor designed for Home Assistant users. It operates locally over WiFi using ESPHome, without the need for a cloud or subscription. Powered by USB-C, the AIR-1 offers open-source software and CAD drawings for customization. +The Apollo AIR-1 is a compact, feature-rich air quality sensor designed for Home Assistant users. It operates locally over Wi-Fi using ESPHome, without the need for a cloud or subscription. Powered by USB-C, the AIR-1 offers open-source software and CAD drawings for customization. Key features include monitoring PM levels (dust, pollen), VOCs, CO2 (optional), temperature, humidity, and even gas levels with an optional sensor. The device also integrates RGB LEDs for notifications and Bluetooth tracking for added automation. diff --git a/docs/products/air1/troubleshooting/air1-code.md b/docs/products/air1/troubleshooting/air1-code.md index 7c42086a17..54511b76cb 100755 --- a/docs/products/air1/troubleshooting/air1-code.md +++ b/docs/products/air1/troubleshooting/air1-code.md @@ -40,4 +40,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and setup your sensor as a new device! \ No newline at end of file +8\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file diff --git a/docs/products/apolloodroid/faq.md b/docs/products/apolloodroid/faq.md index 36385d905f..c676264521 100755 --- a/docs/products/apolloodroid/faq.md +++ b/docs/products/apolloodroid/faq.md @@ -35,7 +35,7 @@ The Apollo Odroid comes equipped with: 6\. **Does the Apollo Odroid support wireless connectivity?** -* Yes, the ODROID-M1S platform supports both WiFi and Ethernet connections, giving you flexible options for integrating it into your network. +* Yes, the ODROID-M1S platform supports both Wi-Fi and Ethernet connections, giving you flexible options for integrating it into your network. 7\. **Can I customize the Home Assistant installation on the Apollo Odroid?** diff --git a/docs/products/apolloodroid/getting-started.md b/docs/products/apolloodroid/getting-started.md index 17751d9985..7e7922443a 100755 --- a/docs/products/apolloodroid/getting-started.md +++ b/docs/products/apolloodroid/getting-started.md @@ -13,7 +13,7 @@ This guide will walk you through setting up your Apollo Home Assistant hub aka t 3\.From a phone or computer connected to your home's internet open your web browser and navigate to http://homeassistant.local:8123. -!!! tip "You can also access your device from it's IP address instead of the default hostname of homeassistant.local" +!!! tip "You can also access your device from its IP address instead of the default hostname of homeassistant.local" If you'd prefer, you can go into your router and find the IP address that your Odroid received and use the IP address with port 8123 at the end such as: http://192.168.1.30:8123 diff --git a/docs/products/btn1/examples/example-automation.md b/docs/products/btn1/examples/example-automation.md index 6fa1c3d9cb..b74c3b26c4 100755 --- a/docs/products/btn1/examples/example-automation.md +++ b/docs/products/btn1/examples/example-automation.md @@ -6,11 +6,11 @@ description: Example of how to use the BTN-1 Events to create an automation in H 1\. Head to the automations page and click on **Create Automation** in the bottom right then select **Create new automation**. -2\. Click on **Add trigger** then select **Entity** and then **State**. Then search for your btn-1 and select the btn-1 event. Then select the **Event Type** attribute and select **Single Click** in the box labeled **To**. +2\. Click on **Add trigger** then select **Entity** and then **State**. Then search for your BTN-1 and select the BTN-1 event. Then select the **Event Type** attribute and select **Single Click** in the box labeled **To**.  -3\. Next click on **Add action** and search **Light: Toggle** and select it. Then choose your entity to turn on such as btn-1 light. Check the box next to Brightness and type in 100 then click Save and name your automation. +3\. Next click on **Add action** and search **Light: Toggle** and select it. Then choose your entity to turn on such as BTN-1 light. Check the box next to Brightness and type in 100 then click Save and name your automation.  diff --git a/docs/products/btn1/faq.md b/docs/products/btn1/faq.md index 1b546c0246..64c656ccb8 100755 --- a/docs/products/btn1/faq.md +++ b/docs/products/btn1/faq.md @@ -16,7 +16,7 @@ description: Frequently asked questions about the BTN-1 Macro Deck 4\. **How do I connect the BTN-1 to Home Assistant?** -* The BTN-1 connects to your Home Assistant instance through the ESPHome Integration using WiFi. +* The BTN-1 connects to your Home Assistant instance through the ESPHome Integration using Wi-Fi. 5\. **Does the BTN-1 support Zigbee firmware?** diff --git a/docs/products/btn1/setup/getting-started.md b/docs/products/btn1/setup/getting-started.md index 81db3961bd..ed13a00dbb 100755 --- a/docs/products/btn1/setup/getting-started.md +++ b/docs/products/btn1/setup/getting-started.md @@ -32,13 +32,13 @@ To connect through the sensor's onboard hotspot follow the below: 1\. Plug the BTN-1 in via USB-C. A 5v 1amp power supply will work fine -!!! success "If your sensor is restarting or not broadcasting Wi-Fi try another usb-c cable and power supply!" +!!! success "If your sensor is restarting or not broadcasting Wi-Fi try another USB-C cable and power supply!" The BTN-1 is sensitive to power fluctuations and needs constant 5v power. It draws 1amp or less so most used phone chargers will work, just make sure it's a quality one! Still no hotspot? Follow the Reset Wi-Fi Credentials guide to make it broadcast again. -2\. On your phone or PC, open the WiFi settings and connect to "Apollo BTN-1 Hotspot". +2\. On your phone or PC, open the Wi-Fi settings and connect to "Apollo BTN-1 Hotspot".  @@ -60,7 +60,7 @@ To connect through the sensor's onboard hotspot follow the below: !!! note "Pre-requirement: Bluetooth proxy or Bluetooth Home Assistant hardware required" - Bluetooth built in such as a raspberry pi or at least one ESP32 BLE Proxy is required to use this to setup your Apollo device. If you have already followed the "Connecting through Hotspot" please skip this section. + Bluetooth built in such as a raspberry pi or at least one ESP32 BLE Proxy is required to use this to set up your Apollo device. If you have already followed the "Connecting through Hotspot" please skip this section. 1\. Navigate to settings -> integrations then click the "**ADD**" button below your new Apollo device then click **Submit**. @@ -74,7 +74,7 @@ To connect through the sensor's onboard hotspot follow the below:  -4\. Your device is now added to your Wi-Fi and added to the ESPHome Integration in Home Assistant. You should now be ready to setup a blueprint and start using your BTN-1! +4\. Your device is now added to your Wi-Fi and added to the ESPHome Integration in Home Assistant. You should now be ready to set up a blueprint and start using your BTN-1! ### Connecting To ESPHome Device Builder @@ -82,7 +82,7 @@ To connect through the sensor's onboard hotspot follow the below: Feel free to [skip to the next section by clicking here](https://wiki.apolloautomation.com/products/general/setup/getting-started/#connecting-to-home-assistant-via-esphome-integration "Click to jump to the ESPHome Integration steps!") unless you need to rename your sensor or do manual edits to the yaml -You can add the ESPHome Device Builder app in Home Assistant to easily update your device or edit the yaml. If you don't have the ESPHome Device Builder app installed you can search esphome device builder in the app store and install it. +You can add the ESPHome Device Builder app in Home Assistant to easily update your device or edit the yaml. If you don't have the ESPHome Device Builder app installed you can search ESPHome Device Builder in the app store and install it. Make sure to fill out your Wi-Fi details in the **secrets** section by clicking on the **secrets** button. @@ -114,6 +114,6 @@ wifi_password: "your-wifi-pass-here"  -2\. Your device is now added to home assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device! +2\. Your device is now added to Home Assistant via the ESPHome integration, and you can easily navigate to it by going to settings -> ESPHome integration -> click on the name of your new device! -[Click here to setup a blueprint and easily automate using your BTN-1! :simple-blueprint:](https://wiki.apolloautomation.com/products/btn1/examples/blueprint/){ .md-button .md-button--primary } \ No newline at end of file +[Click here to set up a blueprint and easily automate using your BTN-1! :simple-blueprint:](https://wiki.apolloautomation.com/products/btn1/examples/blueprint/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/btn1/troubleshooting/btn1-reflash.md b/docs/products/btn1/troubleshooting/btn1-reflash.md index 380fbf4ab0..e916661a4d 100755 --- a/docs/products/btn1/troubleshooting/btn1-reflash.md +++ b/docs/products/btn1/troubleshooting/btn1-reflash.md @@ -36,4 +36,4 @@ description: Step by step guide for reflashing The BTN-1. Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! -[Head to the Getting Started article to setup your BTN-1 as a new device!](https://wiki.apolloautomation.com/products/btn1/setup/getting-started/){ .md-button .md-button--primary } \ No newline at end of file +[Head to the Getting Started article to set up your BTN-1 as a new device!](https://wiki.apolloautomation.com/products/btn1/setup/getting-started/){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/cast1/setup/getting-started.md b/docs/products/cast1/setup/getting-started.md index 3f069c7236..b889868054 100644 --- a/docs/products/cast1/setup/getting-started.md +++ b/docs/products/cast1/setup/getting-started.md @@ -45,7 +45,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on !!! note "Pre-requirement: Bluetooth proxy or Bluetooth Home Assistant hardware required" - Bluetooth built in such as a Raspberry Pi or at least one ESP32 BLE Proxy is required to use this to setup your Apollo device. + Bluetooth built in such as a Raspberry Pi or at least one ESP32 BLE Proxy is required to use this to set up your Apollo device. 1\. Open your integrations page in Home Assistant. diff --git a/docs/products/cast1/troubleshooting/cast1-reflash.md b/docs/products/cast1/troubleshooting/cast1-reflash.md index bf408646dd..5142547538 100644 --- a/docs/products/cast1/troubleshooting/cast1-reflash.md +++ b/docs/products/cast1/troubleshooting/cast1-reflash.md @@ -33,4 +33,4 @@ description: Step by step guide for reflashing The CAST-1. Your device is still in boot mode and needs to be power cycled, meaning power removed, to make it boot in a normal mode! -[Head to the Getting Started article to setup your CAST-1 as a new device!](https://wiki.apolloautomation.com/products/cast1/setup/getting-started/){ .md-button .md-button--primary } +[Head to the Getting Started article to set up your CAST-1 as a new device!](https://wiki.apolloautomation.com/products/cast1/setup/getting-started/){ .md-button .md-button--primary } diff --git a/docs/products/dev2/introduction.md b/docs/products/dev2/introduction.md index 629aa001e4..15f696c90d 100755 --- a/docs/products/dev2/introduction.md +++ b/docs/products/dev2/introduction.md @@ -12,7 +12,7 @@ The Apollo DEV-2 is a very small dev board that we use to prototype before creat The DEV-2 is a great starter device for tinkerers and can be purchased on its own or with a breadboard and dupont wires (jumper wires) if you need those too. -The DEV-2 does NOT come pre-flashed with ESPHome or WLED and requires you to flash it yourself, however there is a getting started video we've made here on the older DEV-1 board. The information is still the same except you'll be using a slightly differently yaml as shared below: +The DEV-2 does NOT come pre-flashed with ESPHome or WLED and requires you to flash it yourself, however there is a getting started video we've made here on the older DEV-1 board. The information is still the same except you'll be using a slightly different yaml as shared below: -1\. Navigate to the ESPHome integration by going to settings -> esphome integration -> click on the name of your new device! +1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on the name of your new device! 2\. Scroll down to the Configuration section. @@ -44,7 +44,7 @@ How to tune the mmWave sensor using radar engineering mode.  -!!! quote "Quote from popular Youtuber Make It Work Tech" +!!! quote "Quote from popular YouTuber Make It Work Tech" 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. - MakeItWorkTech diff --git a/docs/products/general/comparisons.md b/docs/products/general/comparisons.md index 3cdd5f7fd3..aa11aecad0 100755 --- a/docs/products/general/comparisons.md +++ b/docs/products/general/comparisons.md @@ -1,6 +1,6 @@ --- -title: mmWave Presense Sensor Comparison Chart -description: mmWave Presense Sensor Comparison Chart. +title: mmWave Presence Sensor Comparison Chart +description: mmWave Presence Sensor Comparison Chart. ---
Apollo Automation | Apollo MSR-2 | Everything Presence One Kit | Everything Presence Lite Kit | Apollo MTR-1 | Screek Human Sensor 1U | Screek Human Sensor 2A | Aqara FP1 | Aqara FP2 |
|---|---|---|---|---|---|---|---|---|
Price (USD) | $ 34.99 | $ 78.00 | $ 37.00 | $ 36.99 | $25.99 | $29.99 | $49.99 | $82.99 |
mmWave | LD2410B | SEN0395 | LD2450 | LD2450 | LD2410C | LD2450 | BGT60TR13C | IWR6843 |
Detection Distance (m) | 6 | 9 | 6 | 6 | 6 | 6 | 5 | 6 to 8 |
Detection Zones | 3 zones and 9 gates (adjustable and distance based) | 3 zones | 3 zones | 6 | 6 | 5 | 6 to 8 | |
Target Tracking | 1 | 1 | 2-3 (3 not great) | 2-3 (3 not great) | x | x | x | |
PIR | Panasonic | x | x | x | ||||
ESP | ESP32-C3-MINI | ESP32-WROOM-32 | ESP32-WROOM-32 | ESP32-C3-MINI | ESP32-S2 | ESP32-C3 | ESP32-WROOM-32U | |
Country | USA | EU | EU | USA | China | China | China | China |
CO2 | SCD40 $20 | SCD40 $20 | ||||||
UV/LUX | LTR390 | LTR390 | ||||||
Buzzer | Piezo | Piezo | ||||||
RGB LED | ws2812b | ws2812b | ws2812b | ws2812b | ||||
GPIO Header | $ 4.99 (Optional with GPIO Header) | Onboard | Onboard | $ 4.99 (Optional with GPIO Header) | ||||
Size (mm) | 40x24x15 | |||||||
Stand | $4.99 (Optional) | Included | ||||||
Product Link | Aqara FP1 | |||||||
Apollo Automation | Apollo MSR-2 | Everything Presence One Kit | Everything Presence Lite Kit | Apollo MTR-1 | Screek Human Sensor 1U | Screek Human Sensor 2A | Aqara FP1 | Aqara FP2 |
|---|---|---|---|---|---|---|---|---|
Price (USD) | $ 34.99 | $ 78.00 | $ 37.00 | $ 36.99 | $25.99 | $29.99 | $49.99 | $82.99 |
mmWave | LD2410B | SEN0395 | LD2450 | LD2450 | LD2410C | LD2450 | BGT60TR13C | IWR6843 |
Detection Distance (m) | 6 | 9 | 6 | 6 | 6 | 6 | 5 | 6 to 8 |
Detection Zones | 3 zones and 9 gates (adjustable and distance based) | 3 zones | 3 zones | 6 | 6 | 5 | 6 to 8 | |
Target Tracking | 1 | 1 | 2-3 (3 not great) | 2-3 (3 not great) | x | x | x | |
PIR | Panasonic | x | x | x | ||||
ESP | ESP32-C3-MINI | ESP32-WROOM-32 | ESP32-WROOM-32 | ESP32-C3-MINI | ESP32-S2 | ESP32-C3 | ESP32-WROOM-32U | |
Country | USA | EU | EU | USA | China | China | China | China |
CO2 | SCD40 $20 | SCD40 $20 | ||||||
UV/LUX | LTR390 | LTR390 | ||||||
Buzzer | Piezo | Piezo | ||||||
RGB LED | ws2812b | ws2812b | ws2812b | ws2812b | ||||
GPIO Header | $ 4.99 (Optional with GPIO Header) | Onboard | Onboard | $ 4.99 (Optional with GPIO Header) | ||||
Size (mm) | 40x24x15 | |||||||
Stand | $4.99 (Optional) | Included | ||||||
Product Link | Aqara FP1 | |||||||
PM Type | Size (µm) | Description |
|---|---|---|
PM1 | ≤ 1.0 | Ultrafine particles that can reach deep into the lungs and bloodstream. |
PM2.5 | ≤ 2.5 | Fine particles; linked to respiratory and cardiovascular issues. |
PM4 | ≤ 4.0 | Less commonly regulated; typically used in industrial settings. |
PM10 | ≤ 10 | Inhalable particles; may irritate eyes, nose, and throat. |
Learn about Core Components
-### Test your LED
+## Test your LED
Your kit's default project includes the [**Web Server**](../learning-the-basics/core-components.md#web-server) component, which lets you navigate to the IP address of your device or the hostname.local such as http://esphome-starter-kit.local/
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
index 7ab6d10ac6..e2221d4d0b 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/connect-to-home-assistant.md
@@ -33,13 +33,13 @@ Toggle the **Onboard RGB LED** light entity and confirm the LED responds on the
## Troubleshooting
-#### The device never appears under Discovered
+### The device never appears under Discovered
* Confirm Home Assistant is on the same Wi-Fi network as the device.
* Some routers and VLAN setups block mDNS broadcasts across subnets. If you run UniFi, turning on mDNS in your network settings usually fixes this. See the [UniFi mDNS guide](../../general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md). Otherwise, add the integration manually using the device's IP address. Look the IP up on your router's client list or in the **Device Information** section of the ESPHome Device Builder info panel.
* The device's web page should still load at the hostname or IP. If it does not, the device is not reachable from your computer yet and Home Assistant will not find it either.
-#### The encryption key is rejected
+### The encryption key is rejected
Open `secrets.yaml` in Device Builder, copy the `api_encryption_key` value, and paste it back into the Home Assistant prompt. If the value in Device Builder has changed since you last flashed, install the software again so the device knows the new key. (1)
{ .annotate }
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
index 01639ca630..fe0b5fab71 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
@@ -38,14 +38,14 @@ Start on your Windows PC. This is the machine that will do the compiling.
Pairing goes in one direction: the sending dashboard asks, your PC accepts. Both machines show the same row of emoji partway through, and comparing them by eye is what proves you're pairing with your own PC.
-#### Open the Pairing Window on Your PC
+### Open the Pairing Window on Your PC
On your Windows PC, open **Settings → Pairing requests**. It shows **Open** with a countdown beside it. (1)
{ .annotate }
1. Requests only arrive while that countdown is running. Click **Extend** if it runs out before you've finished.
-#### Send the Request From the Other Dashboard
+### Send the Request From the Other Dashboard
1. Go to **Settings → Send builds**. Your PC appears under **Known dashboards** with its address and ESPHome version. Click **Pair**.
@@ -58,7 +58,7 @@ On your Windows PC, open **Settings → Pairing requests**. It shows **Open** wi
-#### Accept It on Your PC
+### Accept It on Your PC
1. The request shows up under **Pairing requests** with the sender's name and **From IP**. Click **Review**.
@@ -77,7 +77,7 @@ Back on the sending dashboard, your PC now sits under **Paired build servers** m
The line underneath tells you which ESPHome version the build server runs, and which one your builds will use. The two don't have to match. Device Builder installs whatever your sending dashboard is on and builds with that.
-#### If Your PC Isn't Listed
+### If Your PC Isn't Listed
Device Builder finds other dashboards over mDNS, which doesn't cross subnets or VLANs and which some networks block outright. Enter the address yourself instead.
@@ -103,7 +103,7 @@ Plugging a device in over USB still works. Your PC compiles and sends the firmwa
To stop using the build server, turn off the toggle on its row under **Paired build servers**. Builds go back to compiling locally, and the pairing stays in place for when you want it again.
-#### Keeping It Working
+### Keeping It Working
* Your PC has to be awake and running Device Builder. If it's asleep, builds queue until it comes back.
* The two machines don't need the same ESPHome version. If you'd rather they matched, **Settings → Send builds** has a version-match setting to enforce it.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
index 8b86f60707..cdc69748e1 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
@@ -14,7 +14,7 @@ When you set up your kit in [First Steps](../setup/first-steps.md), the Device B
---
-### Open Secrets
+## Open Secrets
@@ -28,7 +28,7 @@ In the ESPHome Device Builder dashboard, click the 3 dots menu in the top right
---
-### Syntax
+## Syntax
Each entry is a `key: "value"` pair:
@@ -50,7 +50,7 @@ When the device compiles, ESPHome substitutes the value from secrets.yaml in pla
---
-### Make a Secret in the GUI
+## Make a Secret in the GUI
@@ -70,11 +70,11 @@ The Device Builder moves the key into secrets.yaml and swaps the device YAML ove
---
-### What to store
+## What to store
Each section below shows the line you add to secrets.yaml and the line in your device YAML that references it.
-#### Wi-Fi credentials
+### Wi-Fi credentials
You set these up in [First Steps](../setup/first-steps.md). They're the baseline every device needs.
@@ -93,7 +93,7 @@ wifi:
password: !secret wifi_password
```
-#### Fallback hotspot password
+### Fallback hotspot password
If you want the device's fallback hotspot to require a password instead of being open, store that here too.
@@ -114,7 +114,7 @@ wifi:
password: !secret ap_password
```
-#### Home Assistant API encryption key
+### Home Assistant API encryption key
ESPHome encrypts the connection between your device and Home Assistant. The key is a 32-byte base64 string, and the Device Builder generates one for every new device. The easiest way to make it a secret is the **Use secret** button covered in [Make a Secret in the GUI](#make-a-secret-in-the-gui) above, which names the entry after your device. If you'd rather add it by hand, it looks like this:
@@ -136,7 +136,7 @@ api:
Using the same `api_encryption_key` for every Apollo device on your network is fine and keeps your secrets file short. Home Assistant prompts for the key the first time it discovers a device, then remembers it.
-#### OTA password
+### OTA password
OTA (over-the-air) updates let you re-flash a device wirelessly after the first USB flash. The password protects that endpoint so a stranger on your network can't push software to your device. (1)
{ .annotate }
@@ -157,7 +157,7 @@ ota:
password: !secret ota_password
```
-#### Web server username and password
+### Web server username and password
If you enable the optional `web_server:` component to access your device at `http://device-name.local/`, you can require a login.
@@ -178,7 +178,7 @@ web_server:
password: !secret web_server_password
```
-#### MQTT broker, username, and password
+### MQTT broker, username, and password
If you publish to an MQTT broker instead of (or in addition to) the Home Assistant API, all three of these belong in secrets.yaml.
@@ -201,7 +201,7 @@ mqtt:
---
-### Complete Example
+## Complete Example
Putting it all together, a fully loaded secrets.yaml looks like this:
@@ -231,7 +231,7 @@ You don't have to include every entry. If a device doesn't use MQTT, leave those
---
-#### Good practice
+### Good practice
!!! info "Treat secrets.yaml like a password manager"
diff --git a/docs/products/air1/additional-info/air-quality-sensor-comparison.md b/docs/products/air1/additional-info/air-quality-sensor-comparison.md
index bc6368f455..1f2a6fe27d 100755
--- a/docs/products/air1/additional-info/air-quality-sensor-comparison.md
+++ b/docs/products/air1/additional-info/air-quality-sensor-comparison.md
@@ -5,4 +5,4 @@ description: A technical comparison of air quality sensors used with the AIR-1,
# Air Quality Sensor Comparison
-#### [Air Quality Sensor Comparison](https://apolloautomation-my.sharepoint.com/:x:/p/trevor/Ea1--coB6rNKvRX07CGsVHEBUF-zUPuyyFvRED-WdjCC_Q?e=NFjC1Y)
\ No newline at end of file
+## [Air Quality Sensor Comparison](https://apolloautomation-my.sharepoint.com/:x:/p/trevor/Ea1--coB6rNKvRX07CGsVHEBUF-zUPuyyFvRED-WdjCC_Q?e=NFjC1Y)
\ No newline at end of file
diff --git a/docs/products/air1/air1-reviews.md b/docs/products/air1/air1-reviews.md
index 0706c6b187..bbd046c453 100755
--- a/docs/products/air1/air1-reviews.md
+++ b/docs/products/air1/air1-reviews.md
@@ -5,14 +5,14 @@ description: YouTuber reviews and feedback about the AIR-1 sensor from Apollo Au
# [The Bearded Tech Guy AIR-1 Review](https://youtu.be/k0SDJ6_SBqk?si=3uLfXC3GUDaYJNEs)
-# [Smart Home Scene AIR-1 Review](https://smarthomescene.com/reviews/apollo-air-1-review-complete-air-quality-monitoring-for-home-assistant/)
+## [Smart Home Scene AIR-1 Review](https://smarthomescene.com/reviews/apollo-air-1-review-complete-air-quality-monitoring-for-home-assistant/)
-# [Simon Says Home Assistant AIR-1 Review](https://youtu.be/WCaYAvYPgqc?si=Uo4qQtRia7ZoaBYc)
+## [Simon Says Home Assistant AIR-1 Review](https://youtu.be/WCaYAvYPgqc?si=Uo4qQtRia7ZoaBYc)
-# [BeardedTinker AIR-1 Review](https://youtu.be/3JjV3oo3FMU?si=RZueY1j6gHUSi8OC)
+## [BeardedTinker AIR-1 Review](https://youtu.be/3JjV3oo3FMU?si=RZueY1j6gHUSi8OC)
-# [Hands On Katie AIR-1 Review](https://www.youtube.com/watch?v=dQhwOuFlFWo)
+## [Hands On Katie AIR-1 Review](https://www.youtube.com/watch?v=dQhwOuFlFWo)
-# [MostlyChris AIR-1 Review](https://youtu.be/1-lTbOyfvVI?si=NfIgSMSN-f6aNeah)
+## [MostlyChris AIR-1 Review](https://youtu.be/1-lTbOyfvVI?si=NfIgSMSN-f6aNeah)
-# [Michael Leen AIR-1 Review](https://youtu.be/zdvcg1i6fGU?si=4wqaDjEBiA5qfH8q)
\ No newline at end of file
+## [Michael Leen AIR-1 Review](https://youtu.be/zdvcg1i6fGU?si=4wqaDjEBiA5qfH8q)
\ No newline at end of file
diff --git a/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md b/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
index e8e5ff2154..972245db89 100755
--- a/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
+++ b/docs/products/air1/calibrating-and-updating/air-1-temp-calibration.md
@@ -1,9 +1,10 @@
---
+title: AIR-1 Temperature Calibration
description: "Calibrate the AIR-1 temperature reading from its SEN55 to your room using a temperature offset in Home Assistant."
---
# AIR-1 Temperature Calibration
-##### The AIR-1 uses the SEN55 for its temperature reading. Calibrating it to your environment is very similar to the MSR-1. See the link below for the temperature calibration guide.
+## The AIR-1 uses the SEN55 for its temperature reading. Calibrating it to your environment is very similar to the MSR-1. See the link below for the temperature calibration guide.
diff --git a/docs/products/air1/examples/air1-dashboard-examples.md b/docs/products/air1/examples/air1-dashboard-examples.md
index 985578172b..3e24b92fae 100755
--- a/docs/products/air1/examples/air1-dashboard-examples.md
+++ b/docs/products/air1/examples/air1-dashboard-examples.md
@@ -10,9 +10,9 @@ Really neat dashboard for your AIR-1 by user "keex"!
[https://community.home-assistant.io/t/apollo-air-1-dashboard/785311](https://community.home-assistant.io/t/apollo-air-1-dashboard/785311)
-#### **CO2 Charts**
+## **CO2 Charts**
-##### Home Assistant Sensor
+### Home Assistant Sensor
@@ -25,7 +25,7 @@ name: Bedroom CO2
hours_to_show: 24
```
-#### Custom: Apexcharts Card
+## Custom: Apexcharts Card
@@ -157,7 +157,7 @@ series:
value: 0
```
-##### Custom: Plotly Graph Card
+### Custom: Plotly Graph Card
@@ -170,7 +170,7 @@ refresh_interval: 10
title: Bedroom CO2
```
-##### Home Assistant Gauge
+### Home Assistant Gauge
@@ -187,9 +187,9 @@ severity:
red: 2000
```
-#### **VOC Charts**
+## **VOC Charts**
-##### Home Assistant Sensor
+### Home Assistant Sensor
@@ -202,7 +202,7 @@ hours_to_show: 24
name: Basement VOC
```
-##### Custom: Plotly Graph Card
+### Custom: Plotly Graph Card
@@ -215,7 +215,7 @@ refresh_interval: 10
title: Basement VOC
```
-##### Home Assistant Gauge
+### Home Assistant Gauge
diff --git a/docs/products/air1/setup/general-tips.md b/docs/products/air1/setup/general-tips.md
index 9e883b4332..ec1609069f 100755
--- a/docs/products/air1/setup/general-tips.md
+++ b/docs/products/air1/setup/general-tips.md
@@ -8,11 +8,11 @@ description: >-
The AIR-1 has multiple different types of sensors and this guide will help you understand which ones you should be concerned with and expected safe or not safe thresholds to alert or automate on.
-###### SEN55 Environmental Sensor
+## SEN55 Environmental Sensor
The SEN55 is the powerhouse of the AIR-1 with multiple sensors such as particulate matter, volatile organic compounds (VOCs), oxidizing gases, such as nitrogen oxides (NOx), as well as humidity & temperature.
-###### Particulate Matter
+## Particulate Matter
Per the EPA: particulate matter (also called particle pollution): the term for a mixture of solid particles and liquid droplets found in the air. Some particles, such as dust, dirt, soot, or smoke, are large or dark enough to be seen with the naked eye. Others are so small they can only be detected using an electron microscope. Sources of pm particles here.
@@ -26,11 +26,11 @@ The SEN55 is the powerhouse of the AIR-1 with multiple sensors such as particula
This article goes over lots of ways to reduce pm particles in your home!
-###### Safe PM Levels
+## Safe PM Levels
Particulate Matter (PM) refers to a mixture of solid particles and liquid droplets found in the air. These are often classified by size, as smaller particles pose greater risks to health due to their ability to penetrate deeper into the lungs.
-###### What Do PM1, PM2.5, PM4, and PM10 Mean?
+## What Do PM1, PM2.5, PM4, and PM10 Mean?
@@ -40,7 +40,7 @@ Particulate Matter (PM) refers to a mixture of solid particles and liquid drople
---
-###### Recommended Safe Exposure Limits
+## Recommended Safe Exposure Limits
The **World Health Organization (WHO)** provides the following exposure limits for particulate matter:
@@ -48,7 +48,7 @@ The **World Health Organization (WHO)** defines safety thresholds for PM2.5 based on a 24-hour average:
@@ -56,7 +56,7 @@ The **U.S. Environmental Protection Agency (EPA)**NowCast AQI takes your PM2.5 and PM10 readings and converts them into a single 0–500 number using the EPA's formula. That number maps directly to the AQI categories in the table above: bigger = worse.
@@ -68,7 +68,7 @@ The AIR-1 calculates this automatically and exposes it as a sensor in Home Assis
---
-###### Indoor Air Quality Notes
+## Indoor Air Quality Notes
* **PM1** and **PM2.5** are especially important for indoor air monitoring since these smaller particles are more likely to come from cooking, candles, smoking, or inadequate ventilation.
* Use an **air purifier with a HEPA filter** to reduce PM1–PM2.5 concentrations indoors.
@@ -80,7 +80,7 @@ The AIR-1 calculates this automatically and exposes it as a sensor in Home Assis
---
-###### VOC Index
+## VOC Index
Per Sensirion,
@@ -102,7 +102,7 @@ Per Sensirion,
>
> that there are fewer VOCs compared to the average
-###### VOC Quality
+## VOC Quality
This uses the VOC index and a scale to output an easier to use variable.
@@ -112,7 +112,7 @@ This uses the NOX Index
+## NOX Index
Per Sensirion,
@@ -142,7 +142,7 @@ Per Sensirion,
---
-##### SCD40 CO2 sensor
+## SCD40 CO2 sensor
The optional CO2 sensor addon is a great way to add the ability to track CO2. CO2 levels in a closed, poorly ventilated bedroom can quickly rise to concentrations that may impair focus or even pose health risks. Notice the CO2 levels dropping in the image below when the HVAC was turned on overnight!
@@ -164,6 +164,6 @@ The latest AIR-1 firmware keeps the SCD40 calibrated automatically. The sensor a
---
-##### MiCS-4514 Gas Sensor
+## MiCS-4514 Gas Sensor
The MiCS-4514 is a very unique sensor able to distinguish between multiple gases such as Carbon Monoxide, Nitrogen, Ethanol, Hydrogen, Ammonia, and Methane.
\ No newline at end of file
diff --git a/docs/products/air1/troubleshooting/air1-boot-mode.md b/docs/products/air1/troubleshooting/air1-boot-mode.md
index 9a88d2506d..b3f9ebcedb 100755
--- a/docs/products/air1/troubleshooting/air1-boot-mode.md
+++ b/docs/products/air1/troubleshooting/air1-boot-mode.md
@@ -8,7 +8,7 @@ description: Step by step guide for putting The AIR-1 In Boot Mode.
This is needed to force the device into boot mode to reflash the firmware.
-##### Method 1: Boot Button Only
+## Method 1: Boot Button Only
1\. Position the AIR-1 so that the USB-C port is facing you. On the left side of the USB-C port, locate a small opening to press the boot button (the right button).
@@ -18,7 +18,7 @@ description: Step by step guide for putting The AIR-1 In Boot Mode.
3\. Continue with uploading the firmware document.
-##### Method 2: Boot and Reset Buttons
+## Method 2: Boot and Reset Buttons
1\. Unplug the device and locate the boot and reset buttons as shown in the image above.
diff --git a/docs/products/btn1/battery-sensors/wake-up-battery-sensor.md b/docs/products/btn1/battery-sensors/wake-up-battery-sensor.md
index 023266d9c9..e5adaf6759 100644
--- a/docs/products/btn1/battery-sensors/wake-up-battery-sensor.md
+++ b/docs/products/btn1/battery-sensors/wake-up-battery-sensor.md
@@ -1,4 +1,5 @@
---
+title: How To Wake Up Your Sensor
description: "How to wake up your Apollo device which is currently sleeping."
---
--8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:"
diff --git a/docs/products/btn1/examples/blueprint.md b/docs/products/btn1/examples/blueprint.md
index d4c7c5c695..7017f1a799 100755
--- a/docs/products/btn1/examples/blueprint.md
+++ b/docs/products/btn1/examples/blueprint.md
@@ -6,7 +6,7 @@ description: >-
---
# Blueprint Setup
-### Automatic Import
+## Automatic Import
1\. Click the Import Blueprint button below and then click **Open link**.
@@ -30,7 +30,7 @@ description: >-
5\. Your blueprint is now live. Click the button 1 button and it should toggle whatever light you selected in the blueprint. This can be anything in Home Assistant such as your light, fan, scene, etc!
-### Manual Import
+## Manual Import
1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**.
diff --git a/docs/products/btn1/setup/general-tips.md b/docs/products/btn1/setup/general-tips.md
index ab45910745..71f9dac1f9 100755
--- a/docs/products/btn1/setup/general-tips.md
+++ b/docs/products/btn1/setup/general-tips.md
@@ -4,27 +4,27 @@ description: BTN-1 General Tips
---
# General Tips
-### Sticky Pads
+## Sticky Pads
Your BTN-1 comes with two sets of 4 sticky pads or feet to stick on the bottom of the BTN-1 itself or on the optional BTN-1 Mount addon. These are great for just setting the device on your desk!
-### Mounting
+## Mounting
The BTN-1 with the stand addon allows you to mount the device using M3 screws to attach using one of three mounting scenarios as shown below. It also allows for magnetic mounting from one orientation!
-###### **Under Desk**
+### **Under Desk**
-###### Desk Mount
+### Desk Mount
I used a block of wood instead of mounting it directly to my desk in this example.
-###### **Magnetic Mounting**
+### **Magnetic Mounting**
diff --git a/docs/products/btn1/setup/getting-started.md b/docs/products/btn1/setup/getting-started.md
index ed13a00dbb..07947a9514 100755
--- a/docs/products/btn1/setup/getting-started.md
+++ b/docs/products/btn1/setup/getting-started.md
@@ -6,27 +6,27 @@ description: Step by step guide to getting started with your BTN-1!
This will guide you through adding on switches and keycaps to your BTN-1 then adding it to your Wi-Fi and Home Assistant!
-### Physical Setup
+## Physical Setup
-###### Installing Brown Switches
+### Installing Brown Switches
Line up the two gold pins with the holes on your BTN-1, then press down gently. Be careful, as the pins can bend or get damaged if too much force is used.
-###### Installing Keycaps
+### Installing Keycaps
Line up the + on the keycap with the + on the top of the switch you installed. It may require a little pressure, but it should press on smoothly. Once placed, lightly tap to ensure the keycap is fully seated.
-###### Flip Power Switch
+### Flip Power Switch
Only the battery version has a power switch. If yours has one, ensure it's **turned on**. With the device on its side, flipping the switch **away from you** turns it **on**, and flipping it **toward you** turns it **off**.
-### Connecting Through Hotspot
+## Connecting Through Hotspot
To connect through the sensor's onboard hotspot follow the below:
@@ -56,7 +56,7 @@ To connect through the sensor's onboard hotspot follow the below:
[Click here for next steps!](https://wiki.apolloautomation.com/products/btn1/setup/getting-started/#connecting-to-home-assistant-via-esphome-integration){ .md-button .md-button--primary }
-### Connecting with Improv via BLE
+## Connecting with Improv via BLE
!!! note "Pre-requirement: Bluetooth proxy or Bluetooth Home Assistant hardware required"
@@ -76,7 +76,7 @@ To connect through the sensor's onboard hotspot follow the below:
4\. Your device is now added to your Wi-Fi and added to the ESPHome Integration in Home Assistant. You should now be ready to set up a blueprint and start using your BTN-1!
-### Connecting To ESPHome Device Builder
+## Connecting To ESPHome Device Builder
!!! tip "Skip the ESPHome Device Builder unless..."
@@ -108,7 +108,7 @@ wifi_password: "your-wifi-pass-here"
4\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below!
-### Connecting to Home Assistant via ESPHome Integration:
+## Connecting to Home Assistant via ESPHome Integration:
1\. Head to the ESPHome Integration then click on **Add** then click **Submit**. When prompted click **Finish** then give it a location and click **Finish** or click **Skip and Finish**.
diff --git a/docs/products/btn1/troubleshooting/btn1-boot-mode.md b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
index 58b2cd2f6b..5c55f22aac 100755
--- a/docs/products/btn1/troubleshooting/btn1-boot-mode.md
+++ b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
@@ -8,7 +8,7 @@ description: Step by step guide for putting The BTN-1 In Boot Mode.
This is needed to force the device into boot mode to reflash the firmware.
-##### Method 1: Boot Button Only
+## Method 1: Boot Button Only
!!! success "If you have the battery model skip to Method 2!"
@@ -24,7 +24,7 @@ description: Step by step guide for putting The BTN-1 In Boot Mode.
[Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/btn1/troubleshooting/btn1-reflash/){ .md-button .md-button--primary }
-##### Method 2: Boot and Reset Buttons
+## Method 2: Boot and Reset Buttons
1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your BTN-1.
diff --git a/docs/products/btn1/troubleshooting/btn1-teardown.md b/docs/products/btn1/troubleshooting/btn1-teardown.md
index 8004125a26..6748548f43 100755
--- a/docs/products/btn1/troubleshooting/btn1-teardown.md
+++ b/docs/products/btn1/troubleshooting/btn1-teardown.md
@@ -6,7 +6,7 @@ description: >-
---
# Teardown and Reassembly Of BTN-1
-###### Disassembly
+## Disassembly
!!! warning "If you have a BTN-1 with a battery you should flip the power switch to off"
@@ -28,7 +28,7 @@ description: >-
-###### Reassembly
+## Reassembly
1\. Re-attach the 2-pin JST connector and place the battery writing side down with the wires on the left side of the case.
diff --git a/docs/products/cast1/additional-info/esphome-device-builder.md b/docs/products/cast1/additional-info/esphome-device-builder.md
index a131cdf517..6609318d6e 100644
--- a/docs/products/cast1/additional-info/esphome-device-builder.md
+++ b/docs/products/cast1/additional-info/esphome-device-builder.md
@@ -10,7 +10,7 @@ description: Optional. Use ESPHome Device Builder to rename your CAST-1 or edit
ESPHome Device Builder is the software that gives you a user interface for editing, compiling, and flashing ESPHome YAML. You'll use it to take control of your CAST-1 and edit its configuration.
-### Install ESPHome Device Builder
+## Install ESPHome Device Builder
Pick the platform you'll be running ESPHome Device Builder on:
@@ -114,7 +114,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
-### Take Control of Your CAST-1
+## Take Control of Your CAST-1
1\. Open the ESPHome Device Builder.
diff --git a/docs/products/cast1/examples/tts-announcements.md b/docs/products/cast1/examples/tts-announcements.md
index d55564f045..eb2a35b6ba 100644
--- a/docs/products/cast1/examples/tts-announcements.md
+++ b/docs/products/cast1/examples/tts-announcements.md
@@ -8,14 +8,14 @@ Your CAST-1 can speak. Send it a text-to-speech message and it plays over whatev
You'll need a text-to-speech engine set up in Home Assistant first. The examples below use Piper, which runs locally and sounds good, but any engine works since the CAST-1 just plays what Home Assistant sends it.
-### Which Player to Use
+## Which Player to Use
Your CAST-1 has two media players and either one handles announcements.
* **Apollo CAST-1 Player** is the ESPHome media player with the announcement pipeline.
* **Apollo CAST-1 Sendspin Player** is the Music Assistant streaming target. Announcements sent here get forwarded to the announcement pipeline, so your music still ducks.
-### Send an Announcement
+## Send an Announcement
1\. Open **Developer Tools** in Home Assistant and go to the **Actions** tab.
@@ -35,13 +35,13 @@ data:
3\. Run it with music playing and you'll hear the music drop, the message play, then the music come back.
-### What Happens During an Announcement
+## What Happens During an Announcement
The CAST-1 ducks the music by 40 dB the instant an announcement starts, so speech stays clear without the music stopping. The onboard LEDs turn cyan while it's talking. When the message finishes, the music fades back over a second and the LEDs go out.
That LED change is a handy way to tell an announcement from a glitch when you're across the room.
-### Announce a Sound Instead of Speech
+## Announce a Sound Instead of Speech
Anything you can play can be an announcement, not just speech. A doorbell chime works the same way, ducking the music and lighting the LEDs:
@@ -57,7 +57,7 @@ data:
The `announce: true` is what routes it to the announcement pipeline. Leave it out and the sound replaces your music instead of playing over it.
-### Use It in an Automation
+## Use It in an Automation
??? example "Announce when the washing machine finishes"
diff --git a/docs/products/cast1/examples/wizmote-blueprint.md b/docs/products/cast1/examples/wizmote-blueprint.md
index 7982ad3a08..5bc69a4173 100644
--- a/docs/products/cast1/examples/wizmote-blueprint.md
+++ b/docs/products/cast1/examples/wizmote-blueprint.md
@@ -22,7 +22,7 @@ Every button ships with a sensible default, so your WizMote works the moment you
Each dropdown offers the same choices: Nothing, Play, Pause, Play / Pause, Next Track, Previous Track, Volume Up, Volume Down, Toggle Light, or Send HA Event.
-### Pair Your WizMote
+## Pair Your WizMote
Before the blueprint can control anything, pair your WizMote with the CAST-1.
@@ -43,7 +43,7 @@ Before the blueprint can control anything, pair your WizMote with the CAST-1.
A CAST-1 that's on Ethernet and not joined to any Wi-Fi network has no channel to follow, so it hops through radio channels 1 through 13 hunting for the WizMote, moving on every couple of seconds until it hears one. Keep pressing a button and it should pair within a minute.
-### Import the Blueprint
+## Import the Blueprint
1\. Click the Import Blueprint button below then click **Open link**.
diff --git a/docs/products/cast1/setup/getting-started.md b/docs/products/cast1/setup/getting-started.md
index b889868054..db4151771b 100644
--- a/docs/products/cast1/setup/getting-started.md
+++ b/docs/products/cast1/setup/getting-started.md
@@ -6,7 +6,7 @@ description: Step by step guide to getting started with your CAST-1!
This will guide you through connecting your CAST-1 to your speakers, adding it to your Wi-Fi and Home Assistant, and streaming to it with Music Assistant.
-### Physical Setup
+## Physical Setup
Run a 3.5mm cable from the CAST-1 into the line-in on your powered speakers, receiver, or active soundbar, then plug the CAST-1 into power with USB-C. A 5V 1A power supply is plenty. (1)
{ .annotate }
@@ -15,7 +15,7 @@ Run a 3.5mm cable from the CAST-1 into the line-in on your powered speakers, rec
-### Connect to Your Network
+## Connect to Your Network
There are three ways to get your CAST-1 online. Pick whichever is easier, you only need to do one.
@@ -74,7 +74,7 @@ There are three ways to get your CAST-1 online. Pick whichever is easier, you on
3\. Home Assistant discovers your CAST-1 automatically. Add it below, then check the **Network Connection** sensor on the device page to confirm it reads **Ethernet**.
-### Add to Home Assistant
+## Add to Home Assistant
Open the ESPHome Integration, then click **Add** and **Submit**. Edit the name and choose an **Area** then click **Finish**.
@@ -82,11 +82,11 @@ Open the ESPHome Integration, then click **Add** and **Submit**. Edit the name a
-### Music Assistant
+## Music Assistant
The CAST-1 streams through Music Assistant. Once Music Assistant is running, your CAST-1 shows up as a player automatically, no extra configuration needed.
-###### Install Music Assistant
+### Install Music Assistant
1\. Head to the App Store to install Music Assistant.
@@ -100,7 +100,7 @@ The CAST-1 streams through
-###### Stream To Your CAST-1
+### Stream To Your CAST-1
1\. Open **Music Assistant** from the Home Assistant sidebar.
@@ -110,7 +110,7 @@ The CAST-1 streams through Discord for some help.
-### Connecting Through Hotspot
+## Connecting Through Hotspot
To connect through the sensor's onboard hotspot follow the below:
@@ -32,7 +32,7 @@ If this does not automatically open the dashboard, please open your web browser
[Click here for next steps!](https://wiki.apolloautomation.com/products/general/setup/getting-started/#connecting-to-home-assistant-via-esphome-integration){ .md-button .md-button--primary }
-### Connecting with Improv via BLE
+## Connecting with Improv via BLE
!!! note "Pre-requirement:"
@@ -62,7 +62,7 @@ If this does not automatically open the dashboard, please open your web browser
-### Connecting To ESPHome Device Builder
+## Connecting To ESPHome Device Builder
!!! tip "Skip the ESPHome Device Builder unless..."
@@ -102,7 +102,7 @@ wifi_password: "your-wifi-pass-here"
6\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below!
-### Connecting to Home Assistant via ESPHome Integration:
+## Connecting to Home Assistant via ESPHome Integration:
1\. Click the "**Notifications**" Icon in the bottom left.
diff --git a/docs/products/general/setup/renaming-apollo-devices.md b/docs/products/general/setup/renaming-apollo-devices.md
index 7f2af0e246..23e56c22c2 100755
--- a/docs/products/general/setup/renaming-apollo-devices.md
+++ b/docs/products/general/setup/renaming-apollo-devices.md
@@ -4,7 +4,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio
---
# Renaming Apollo Devices
-##### ESPHome Integration - Part 1
+## ESPHome Integration - Part 1
1\. Click the button below to open the ESPHome Integrations page.
@@ -26,7 +26,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio
-##### ESPHome Integration - Part 2
+## ESPHome Integration - Part 2
This section only changes the device name shown in the ESPHome integration page. It is safe to skip, but we recommend doing it to keep naming consistent.
@@ -42,7 +42,7 @@ This section only changes the device name shown in the ESPHome integration page.
The next section is for ESPHome device builder which is for tinkerers and advanced users to take control of their device and edit the yaml. Please skip the next section if you do not use ESPHome Device Builder!
-##### ESPHome Device Builder
+## ESPHome Device Builder
1\. Make sure you are already using the ESPHome Device Builder app as gone over in the getting started wiki articles.
diff --git a/docs/products/general/temp-hum-calibration.md b/docs/products/general/temp-hum-calibration.md
index ce977fcc45..bc2979a685 100755
--- a/docs/products/general/temp-hum-calibration.md
+++ b/docs/products/general/temp-hum-calibration.md
@@ -4,7 +4,7 @@ description: Temp and Humidity Calibration and Offset Examples.
---
# Simple and Advanced Examples of Temperature & Humidity Offsets
-### **Simple Offsets for Temperature and Humidity:**
+## **Simple Offsets for Temperature and Humidity:**
**Please add these to the bottom of your ESPHome yaml for your device then click save and install. Once you are finished, you will have two new boxes inside the Home Assistant ESPHome integration device page for your device where you can fill in an offset. Give them up to 1 minute to take effect!**
@@ -49,11 +49,11 @@ number:
mode: box
```
-### **BME280 & SCD40 Sensors: Overcoming Temperature & Humidity Reading Challenges**
+## **BME280 & SCD40 Sensors: Overcoming Temperature & Humidity Reading Challenges**
The BME280 and SCD40 sensors are known for their precision in measuring temperature and humidity. However, like all sensor systems, they can sometimes provide inaccurate readings due to various factors. In the case of the BME280 and SCD40 sensors, one significant challenge arises from the heat produced by the ESP chip, which can alter the environment inside its enclosure, thereby skewing the readings.
-### **Adjusting the BME280 and SCD40 Temperature Offset**
+## **Adjusting the BME280 and SCD40 Temperature Offset**
For users who want to fine-tune their sensors, the BME280 and SCD40 Temperature Offset entities can be manually adjusted to match the conditions in their home. The offset values are subtracted from the raw temperature & humidity readings in the firmware to update the sensor readings in the Home Assistant entity. For example: scd40\_temperature entity = raw scd40 temperature reading - scd40\_offset.
@@ -61,7 +61,7 @@ By default, these offsets are preset to values based on our NIST certified therm
Users will also notice the `bme280_humidity_calibrated`, `scd40_humidity_calibrated`, `bme280_temperature_calibrated`, and `scd40_temperature_calibrated` entities. These values utilize the linear filter in the ESPHome firmware to adjust the readings based on our collected data. Again, due to environmental differences, these might not always be precise.
-### **Modeling the Relationship Between Sensors**
+## **Modeling the Relationship Between Sensors**
Another approach to getting accurate readings is to model the relationship between the ESP temperature and the other sensors compared against a reference temperature. This can be achieved by creating a template sensor in Home Assistant that employs a decision tree or our regression coefficients.
@@ -134,10 +134,10 @@ notify:
```
-### **The Interrelation of Temperature and Humidity**
+## **The Interrelation of Temperature and Humidity**
It's important to understand that temperature and humidity share an interdependent relationship. When the air temperature rises, its capacity to hold moisture increases, which can decrease relative humidity levels. Conversely, when the temperature falls, the air's capacity to hold moisture decreases, leading to increased humidity. This relationship plays a significant role in how sensors detect and interpret readings, making it even more crucial to ensure accuracy.
-### **Advanced Accuracy with GPIO**
+## **Advanced Accuracy with GPIO**
For those seeking the highest accuracy, an advanced solution is available. The exposed mezzanine connector on the back of our Apollo boards can be utilized to connect a temperature/humidity sensor. This modification can dramatically improve both temperature and humidity readings, providing data that's as accurate as possible.
\ No newline at end of file
diff --git a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md
index 49c6af74c0..f95551958a 100755
--- a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md
+++ b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md
@@ -4,7 +4,7 @@ description: Tutorial for Removing Device From Home Assistant.
---
# Removing Device From Home Assistant
-##### ESPHome app
+## ESPHome app
This will cover how to remove an Apollo device from Home Assistant
@@ -20,7 +20,7 @@ This will cover how to remove an Apollo device from Home Assistant
-##### ESPHome Integration
+## ESPHome Integration
1\. Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then "Delete".
diff --git a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
index 84275a51c7..8e0916c602 100755
--- a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
+++ b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
@@ -8,7 +8,7 @@ description: Tutorial to help fix the Ubiquiti UniFi mDNS Auto Discover Issue.
If you have different networks that Homey and ESPHome devices are on, then you will need mDNS working across both networks and firewall rules allowing access between them. Below are guides for using your PC and the UniFi iOS app to fix this issue.
-##### **Method 1: Browser**
+## **Method 1: Browser**
1\. Log into your UniFi network through your default IP address which is usually http://192.168.1.1
@@ -34,7 +34,7 @@ description: Tutorial to help fix the Ubiquiti UniFi mDNS Auto Discover Issue.
7\. Now the Home Assistant/ESPHome auto-discover issue should be fixed!
-##### **Method 2: UniFi iOS App.**
+## **Method 2: UniFi iOS App.**
1\. Open the UniFi app.
diff --git a/docs/products/h1/battery-sensors/wake-up-battery-sensor.md b/docs/products/h1/battery-sensors/wake-up-battery-sensor.md
index 023266d9c9..e5adaf6759 100644
--- a/docs/products/h1/battery-sensors/wake-up-battery-sensor.md
+++ b/docs/products/h1/battery-sensors/wake-up-battery-sensor.md
@@ -1,4 +1,5 @@
---
+title: How To Wake Up Your Sensor
description: "How to wake up your Apollo device which is currently sleeping."
---
--8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:"
diff --git a/docs/products/h1/reviews.md b/docs/products/h1/reviews.md
index ecee5b8da8..1abea53cca 100755
--- a/docs/products/h1/reviews.md
+++ b/docs/products/h1/reviews.md
@@ -6,18 +6,18 @@ description: H-1 Reviews.
-#
Michael Lean +##
Michael Lean -#
Mostly Chris +##
Mostly Chris -#
Smart Home Sellout +##
Smart Home Sellout -#
Smart Home Australia +##
Smart Home Australia \ No newline at end of file diff --git a/docs/products/h2/battery-sensors/wake-up-battery-sensor.md b/docs/products/h2/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/h2/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/h2/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/h2/examples/holiday-songs.md b/docs/products/h2/examples/holiday-songs.md index 58f9bcfd94..3c0f86774c 100644 --- a/docs/products/h2/examples/holiday-songs.md +++ b/docs/products/h2/examples/holiday-songs.md @@ -1,4 +1,5 @@ --- -description: ">-" +title: Holiday Songs +description: List of Holiday Songs to use with the Holiday ornaments or any Apollo device with a buzzer. --- --8<-- "products/general/holiday-songs.md:7:" diff --git a/docs/products/h2/h2-reviews.md b/docs/products/h2/h2-reviews.md index 3f0e510db5..87be955321 100755 --- a/docs/products/h2/h2-reviews.md +++ b/docs/products/h2/h2-reviews.md @@ -9,18 +9,18 @@ these need to be updated -#
Michael Lean +##
Michael Lean -#
Mostly Chris +##
Mostly Chris -#
Smart Home Sellout +##
Smart Home Sellout -#
Smart Home Australia +##
Smart Home Australia \ No newline at end of file diff --git a/docs/products/led1/setup/getting-started-led1.md b/docs/products/led1/setup/getting-started-led1.md index 1dc0ea93a7..f66166414a 100755 --- a/docs/products/led1/setup/getting-started-led1.md +++ b/docs/products/led1/setup/getting-started-led1.md @@ -6,7 +6,7 @@ description: Getting started with your new LED-1! Congrats on your new LED-1! Below we will go through steps to get you up and running in no time. -### Choose how to power it +## Choose how to power it The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V or 12V up to 3 amps) or a dedicated power supply using either 5V, 12V, or 24V. @@ -40,7 +40,7 @@ The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V Before proceeding to the next steps, make sure to unplug your device! -### Wire up LEDs +## Wire up LEDs !!! danger "Before proceeding, consider double checking your power supply and leds use the same voltage!" @@ -54,7 +54,7 @@ The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V 3\. Repeat step 2 for a second led strip using Output 2 if you have a second led strip! -### Connect to Wi-Fi +## Connect to Wi-Fi Your device is now ready to connect to your Wi-Fi and begin controlling via Home Assistant, the WLED app for iPhone and Android, or via a web browser! @@ -62,7 +62,7 @@ Your device is now ready to connect to your Wi-Fi and begin controlling via Home  -### Join to Home Assistant +## Join to Home Assistant 1\. Your device should be auto-discovered by Home Assistant using the WLED Integration as shown below! diff --git a/docs/products/led1/setup/led1-general-tips.md b/docs/products/led1/setup/led1-general-tips.md index 27dc91a04d..2c3f4ed5e4 100755 --- a/docs/products/led1/setup/led1-general-tips.md +++ b/docs/products/led1/setup/led1-general-tips.md @@ -4,7 +4,7 @@ description: Multiple helpful tips to use your LED-1 to the fullest! --- # General Tips -##### Power Supplies +## Power Supplies Meanwell power supplies are best but most power supplies off Amazon will be sufficient. As a rule of thumb, over 80% usage on a power supply is bad. So if you want to run with 3amps, buy a 4 or 5amp power supply so that the power supply is not running at its maximum potential amperage. @@ -14,7 +14,7 @@ Most power supplies will have a barrel connector only rated for 3 amps on it, so The LED-1 will protect itself, but not the led strips connected to it. So if you connect a 24 volt power supply to the device, it will send 24v out to the LED strips. Make sure to pair your LEDs and Power supplies with the same voltage! -##### LED Strips +## LED Strips * WS2812B which are 5V RGB LED strips. * SK6812 which are 5V RGBW LED strips. @@ -24,13 +24,13 @@ Most power supplies will have a barrel connector only rated for 3 amps on it, so We suggest buying only BTF Lighting off of amazon or directly from us (we source only BTF Lighting). They also have an Aliexpress store! -##### LED Connectors +## LED Connectors JST-SM 3 pin connectors are helpful to connect multiple led strips or to solder them onto led strips to create multiple smaller sections. These have a maximum rating of 3 amps. 10mm Width Transparent Connector Kit You might want to use these 24v FCOB connectors for the WS2814 LEDs suggested above. Make sure to choose the same width of led strip + connector (10mm, 12mm, etc). -##### Additional Tools +## Additional Tools Wago Connectors are a great option for connecting wires together without soldering. diff --git a/docs/products/m1/addons/adding-microphone-to-m-1.md b/docs/products/m1/addons/adding-microphone-to-m-1.md index 825008eb90..e84bdbe8d1 100755 --- a/docs/products/m1/addons/adding-microphone-to-m-1.md +++ b/docs/products/m1/addons/adding-microphone-to-m-1.md @@ -6,7 +6,7 @@ This will guide you through installing and configuring the microphone on your M- The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have the connector for it. The revision is printed on the controller board. -###### Install the Hardware +## Install the Hardware 1\. Unplug your M-1 from power and set the matrix side face down with the M-1 Controller PCB facing you. @@ -14,7 +14,7 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th  -###### Turn It On +## Turn It On === "WLED" diff --git a/docs/products/m1/addons/wizmote-remote.md b/docs/products/m1/addons/wizmote-remote.md index a88be44d48..6e9ea56402 100644 --- a/docs/products/m1/addons/wizmote-remote.md +++ b/docs/products/m1/addons/wizmote-remote.md @@ -10,7 +10,7 @@ The M-1 has no IR receiver, but it does take a WLED ESP-NOW documentation covers the button codes if you want something other than the defaults. -###### Troubleshooting +## Troubleshooting If nothing shows up in **Last device seen**, start with a fresh battery in the WizMote and confirm you saved the page after ticking **Enable ESP-NOW**. When the field stays blank after that, reboot the M-1 and press a button on the remote again. diff --git a/docs/products/m1/choose-your-firmware.md b/docs/products/m1/choose-your-firmware.md index c55a26963c..c519c8cd58 100644 --- a/docs/products/m1/choose-your-firmware.md +++ b/docs/products/m1/choose-your-firmware.md @@ -6,7 +6,7 @@ description: Find out which firmware your M-1 runs and what each one gives you. Most M-1 pages on this wiki have a **WLED** and a **WLED-MM** tab. Pick your firmware once and the rest of the wiki follows it, so this page is only here to help you work out which one you have. -#### Which One Do I Have? +## Which One Do I Have? Open your M-1 in a browser and tap **Info**. The version is at the top. diff --git a/docs/products/m1/examples/share-data-from-home-assistant.md b/docs/products/m1/examples/share-data-from-home-assistant.md index 24b1711492..abcecc77ed 100755 --- a/docs/products/m1/examples/share-data-from-home-assistant.md +++ b/docs/products/m1/examples/share-data-from-home-assistant.md @@ -52,7 +52,7 @@ Here is the finished board on a two panel setup, four segments each pulling a di  -###### Tuning It +## Tuning It A minute suits temperatures and forecasts. For something that changes faster, like a countdown timer, drop the time pattern to every ten or thirty seconds. Going much below that gains you little, since the text has to finish scrolling before anyone can read it anyway. diff --git a/docs/products/m1/setup/getting-started-m1-esphome.md b/docs/products/m1/setup/getting-started-m1-esphome.md index a46ccc56b4..a1b9eb0da5 100644 --- a/docs/products/m1/setup/getting-started-m1-esphome.md +++ b/docs/products/m1/setup/getting-started-m1-esphome.md @@ -10,13 +10,13 @@ description: Getting started with your new M-1 running the hub75-studio ESPHome This guide walks you through replacing the stock WLED firmware with [hub75-studio](https://github.com/pavlov-net/hub75-studio), an ESPHome firmware tailored for the M-1, and getting it onto your home network and into Home Assistant. -### Attach M-1 LED Controller +## Attach M-1 LED Controller Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damage in shipping. Gently attach the controller to the back of the M-1 LED Matrix panel as shown in the GIF below.  -### Flash the firmware +## Flash the firmware !!! success "Use the Rev6 build unless you have an older M-1 Controller!" @@ -34,7 +34,7 @@ Once the firmware finishes installing, the panel displays the **M-1 BIOS** splas  -### Connect to Wi-Fi +## Connect to Wi-Fi 1\. On your phone, open Wi-Fi settings and join the network **apollo-m1-r6-XXXXXX**, where the last 6 characters match the MAC suffix shown on the BIOS screen. @@ -46,7 +46,7 @@ Once the firmware finishes installing, the panel displays the **M-1 BIOS** splas  -### Join to Home Assistant +## Join to Home Assistant !!! tip "Your device should be auto-discovered by Home Assistant using the ESPHome Integration as shown below!" @@ -58,9 +58,9 @@ Head to the Media Proxy app allows you to view gifs, still images, YouTube videos, and even use Sendspin with album art when using Music Assistant! @@ -120,7 +120,7 @@ The WiZ WizMote remote, so you can change pages, dim the panel, and toggle it on/off without your phone. diff --git a/docs/products/m1/setup/getting-started-m1.md b/docs/products/m1/setup/getting-started-m1.md index 403bd95737..8cda38bb86 100644 --- a/docs/products/m1/setup/getting-started-m1.md +++ b/docs/products/m1/setup/getting-started-m1.md @@ -8,13 +8,13 @@ Congrats on your new M-1! Pick your firmware below and the rest of the M-1 wiki New units ship with **WLED**. Units shipped earlier came with **WLED-MM**. Open your M-1 in a browser and tap **Info** to see which you have: 16.0.1 or newer is WLED, 14.5.1 is WLED-MM. Running ESPHome instead? Head to [Set Up ESPHome](/products/m1/setup/getting-started-m1-esphome.md). -### Attach M-1 LED Controller +## Attach M-1 LED Controller Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damage in shipping. Gently attach the M-1 controller by lining up its power and data headers to the back of the LED Matrix panel as shown below.  -### Connect to Wi-Fi +## Connect to Wi-Fi === "WLED" @@ -88,7 +88,7 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag  -### Join to Home Assistant +## Join to Home Assistant === "WLED" @@ -126,7 +126,7 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag  -#### What Next +### What Next === "WLED" diff --git a/docs/products/m1/setup/m1-matrix-settings.md b/docs/products/m1/setup/m1-matrix-settings.md index 60f1053090..25899a24b9 100755 --- a/docs/products/m1/setup/m1-matrix-settings.md +++ b/docs/products/m1/setup/m1-matrix-settings.md @@ -7,13 +7,13 @@ description: >- These are the settings that make the HUB75 panel display correctly. You need them if you reflashed your M-1, wiped its settings, or changed the number of panels. Units that ship on WLED arrive already configured for one 64x64 panel. -###### Friendly Name +## Friendly Name Click on **Config**, then **User Interface**. In the **Server description** field, enter the name you want your M-1 device to display as in the WLED interface, such as **Apollo LED Matrix**. It ships as **Apollo M-1**, so this is only worth changing if you want something else.  -###### Hostname +## Hostname Your M-1 already has one. It ships as **apollo-led-matrix-xxxxxx**, with the last six characters unique to your unit, so several M-1s can sit on the same network without clashing. @@ -49,7 +49,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address** * Hostnames are **not case sensitive** (`HostName` = `hostname`). -###### LED Settings +## LED Settings === "WLED" @@ -77,7 +77,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**  -###### 2D Settings +## 2D Settings === "WLED" @@ -93,7 +93,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**  -###### AudioReactive Settings +## AudioReactive Settings !!! success "The Audioreactive is only available on a rev6 PCB with the optional microphone addon" diff --git a/docs/products/m1/setup/m1-multiple-panels.md b/docs/products/m1/setup/m1-multiple-panels.md index e8d83cda5d..c05edcef9d 100755 --- a/docs/products/m1/setup/m1-multiple-panels.md +++ b/docs/products/m1/setup/m1-multiple-panels.md @@ -10,11 +10,11 @@ description: Tutorial for wiring and configuring multiple panels with your M-1 L Using panels you sourced yourself rather than Apollo ones? They need to match the M-1's own: **64x64 half scan**, sometimes written 1/32. Indoor P2.5 and P3 64x64 panels usually qualify. Quarter-scan panels, often sold as outdoor, do not work. -###### Power +## Power A 64x64 panel can pull about 3A at 5V at full white. The M-1's onboard 5V rail passes roughly 3A, which is one panel's worth, so every panel beyond the first needs its own feed from a Matrix Power Module. Skipping it gives you dim output, color shifts, and random reboots on bright content. -###### Hardware Setup +## Hardware Setup Wiring is the same whichever firmware you run. Choose the number of panels you are using below to get started! @@ -78,7 +78,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a A 3D printable wall mount system is available on Printables. -###### Software Setup +## Software Setup === "WLED" @@ -174,7 +174,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a  -###### Segment Setup +## Segment Setup !!! success "WLED works using segments and your device now has different stop and end pixels for each segment since you have added more LEDs with each additional panel" @@ -308,7 +308,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke 5\. Save the layout as a preset, or it disappears on the next reboot. -###### What to Expect +## What to Expect Driving four panels asks a lot more of the controller than one, and a few things change that are worth knowing before you decide something is broken. @@ -318,7 +318,7 @@ The LED memory gauge on the LED Preferences page reads high with four panels. Th Ghosting shows up more readily. Four chained panels load the drive lines harder than one, so faint red fringing behind bright content or at a seam appears at a lower brightness than you are used to. It is harmless. Drop the global brightness a step if it bothers you. -###### Going Bigger Than Four Panels +## Going Bigger Than Four Panels Four panels per M-1 is the limit, in any arrangement that multiplies to four or fewer. That is a real constraint rather than an artificial cap: the display driver keeps its frame buffer in the fastest part of the chip's memory and four panels already fill most of it, the panel hardware refreshes more slowly as the chain grows, and eight panels of bright content would need something like a 25 amp supply. diff --git a/docs/products/m1/setup/m1-wall-mounting.md b/docs/products/m1/setup/m1-wall-mounting.md index e17492dc9e..0923a60a4a 100644 --- a/docs/products/m1/setup/m1-wall-mounting.md +++ b/docs/products/m1/setup/m1-wall-mounting.md @@ -12,7 +12,7 @@ Download the files from the These cheap ones off Amazon work great. @@ -37,7 +37,7 @@ Make sure to use M3 8mm screws. 2 To MSR-1 diff --git a/docs/products/msr1/examples/msr-1-automation-guide.md b/docs/products/msr1/examples/msr-1-automation-guide.md index 1edb86c5ab..b08e40cec2 100755 --- a/docs/products/msr1/examples/msr-1-automation-guide.md +++ b/docs/products/msr1/examples/msr-1-automation-guide.md @@ -1,4 +1,5 @@ --- +title: MSR-1 Automation Guide description: "A walkthrough of building Home Assistant automations around the MSR-1." --- # MSR-1 Automation Guide diff --git a/docs/products/msr1/examples/msr-1-examples-from-github.md b/docs/products/msr1/examples/msr-1-examples-from-github.md index 91a4f28f62..999250c903 100755 --- a/docs/products/msr1/examples/msr-1-examples-from-github.md +++ b/docs/products/msr1/examples/msr-1-examples-from-github.md @@ -1,6 +1,7 @@ --- +title: MSR-1 Examples From GitHub description: "Example MSR-1 configurations and automations published in the Apollo GitHub repository." --- # MSR-1 Examples From GitHub -#### [https://github.com/ApolloAutomation/MSR-1/tree/main/Examples](https://github.com/ApolloAutomation/MSR-1/tree/main/Examples) \ No newline at end of file +## [https://github.com/ApolloAutomation/MSR-1/tree/main/Examples](https://github.com/ApolloAutomation/MSR-1/tree/main/Examples) \ No newline at end of file diff --git a/docs/products/msr1/examples/msr1-alarmo.md b/docs/products/msr1/examples/msr1-alarmo.md index f8e8dd05d0..bad5916018 100755 --- a/docs/products/msr1/examples/msr1-alarmo.md +++ b/docs/products/msr1/examples/msr1-alarmo.md @@ -1,4 +1,5 @@ --- +title: MSR-1 + Alarmo Home Security Install description: "Build a home security system from three MSR-1 sensors and Alarmo in Home Assistant, installed through HACS." --- # MSR-1 + Alarmo Home Security Install diff --git a/docs/products/msr1/examples/msr1-dashboards.md b/docs/products/msr1/examples/msr1-dashboards.md index 4254c0855f..767296005d 100755 --- a/docs/products/msr1/examples/msr1-dashboards.md +++ b/docs/products/msr1/examples/msr1-dashboards.md @@ -1,4 +1,5 @@ --- +title: MSR-1 Home Assistant Dashboard Examples description: "Example Home Assistant dashboard cards for the MSR-1, including an ApexCharts scatter plot of radar detection distance you can copy and paste." --- # MSR-1 Home Assistant Dashboard Examples diff --git a/docs/products/msr1/examples/using-msr-1-buzzer.md b/docs/products/msr1/examples/using-msr-1-buzzer.md index 063e1a430c..907853a848 100755 --- a/docs/products/msr1/examples/using-msr-1-buzzer.md +++ b/docs/products/msr1/examples/using-msr-1-buzzer.md @@ -1,4 +1,5 @@ --- +title: Using MSR-1 Buzzer description: "Trigger the MSR-1 buzzer from Home Assistant developer tools, then reuse the same call in an automation." --- # Using MSR-1 Buzzer diff --git a/docs/products/msr1/faq.md b/docs/products/msr1/faq.md index d33f9aea2f..cb3760bc7e 100755 --- a/docs/products/msr1/faq.md +++ b/docs/products/msr1/faq.md @@ -1,4 +1,5 @@ --- +title: FAQ description: "Common MSR-1 questions answered: which sensors are inside, what the mmWave radar detects, and how the device talks to Home Assistant." --- 1\. **What sensors are included in the MSR-1?** diff --git a/docs/products/msr1/introduction.md b/docs/products/msr1/introduction.md index da1e7c447e..27f146f0e7 100755 --- a/docs/products/msr1/introduction.md +++ b/docs/products/msr1/introduction.md @@ -1,4 +1,5 @@ --- +title: Introduction description: "The Apollo MSR-1 multisensor: mmWave radar, LUX and UV, temperature, humidity, and optional CO2, running ESPHome for Home Assistant." ---  diff --git a/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md b/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md index 94bbb7de06..9317053bf7 100755 --- a/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md @@ -1,7 +1,8 @@ --- +title: BeardedTinker MSR-1 Review description: "BeardedTinker's video review of the Apollo MSR-1." --- # BeardedTinker MSR-1 Review -##### BeardedTinker YouTube Video review - MSR-1 +## BeardedTinker YouTube Video review - MSR-1 diff --git a/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md b/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md index b01b89e93b..efbbaad4f5 100755 --- a/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md @@ -1,9 +1,10 @@ --- +title: DrZzs MSR-1 Review description: "The DrZzs review of the Apollo MSR-1, starting at 19:53 in the stream." --- # DrZzs MSR-1 Review -##### +## diff --git a/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md b/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md index 2bacf1201c..bcfda6a39f 100755 --- a/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md @@ -1,11 +1,12 @@ --- +title: Make It Work Tech MSR-1 Review description: "The Make It Work Tech review of the Apollo MSR-1, starting at 31:22 in the video." --- # Make It Work Tech MSR-1 Review -##### +## -##### Apollo MSR-1 Review starts at [31:22](https://www.youtube.com/watch?v=Kt1FpRM8R18&t=1882s). \ No newline at end of file +## Apollo MSR-1 Review starts at [31:22](https://www.youtube.com/watch?v=Kt1FpRM8R18&t=1882s). \ No newline at end of file diff --git a/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md b/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md index c7756232be..ea48311429 100755 --- a/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md @@ -1,4 +1,5 @@ --- +title: MostlyChris MSR-1 Review description: "MostlyChris reviews the Apollo MSR-1." --- # MostlyChris MSR-1 Review diff --git a/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md b/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md index 047af30665..917a23542c 100755 --- a/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md @@ -1,4 +1,5 @@ --- +title: Simon Says Home Assistant MSR-1 Review description: "Simon Says Home Assistant reviews the Apollo MSR-1." --- # Simon Says Home Assistant MSR-1 Review diff --git a/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md b/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md index 70ab1157b2..6269fba402 100755 --- a/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md @@ -1,6 +1,7 @@ --- +title: Smart Home Scene MSR-1 Review description: "The Smart Home Scene written review of the Apollo MSR-1." --- # Smart Home Scene MSR-1 Review -#### [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) \ No newline at end of file +## [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) \ No newline at end of file diff --git a/docs/products/msr1/msr1-reviews.md b/docs/products/msr1/msr1-reviews.md index 394e625c8d..7e607d5768 100755 --- a/docs/products/msr1/msr1-reviews.md +++ b/docs/products/msr1/msr1-reviews.md @@ -1,14 +1,15 @@ --- +title: Make It Work Tech MSR-1 Review description: "Video and written reviews of the Apollo MSR-1 from across the community." --- # [Make It Work Tech MSR-1 Review](https://youtu.be/Kt1FpRM8R18?si=GgMGCjpbSwpSqIsr) -# [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) +## [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) -# [DrZzs MSR-1 Review](https://www.youtube.com/live/YGNCw1nFwjg?si=gmdQTtnY2XdzVHV3) +## [DrZzs MSR-1 Review](https://www.youtube.com/live/YGNCw1nFwjg?si=gmdQTtnY2XdzVHV3) -# [BeardedTinker MSR-1 Review](https://youtu.be/vz1oWhPoIwA?si=Gk8p8S_LUIsMC7D-) +## [BeardedTinker MSR-1 Review](https://youtu.be/vz1oWhPoIwA?si=Gk8p8S_LUIsMC7D-) -# [Simon Says Home Assistant MSR-1 Review](https://youtu.be/M-HAuPH9KOk?si=Fy7RkfsOJdjaodkr) +## [Simon Says Home Assistant MSR-1 Review](https://youtu.be/M-HAuPH9KOk?si=Fy7RkfsOJdjaodkr) -# [MostlyChris MSR-1 Review](https://youtu.be/u8q3lMIkolc?si=aWrkRHIru_eOY1jw) \ No newline at end of file +## [MostlyChris MSR-1 Review](https://youtu.be/u8q3lMIkolc?si=aWrkRHIru_eOY1jw) \ No newline at end of file diff --git a/docs/products/msr1/setup/co2-calibration-for-msr-1.md b/docs/products/msr1/setup/co2-calibration-for-msr-1.md index e2f786007f..46ac167148 100755 --- a/docs/products/msr1/setup/co2-calibration-for-msr-1.md +++ b/docs/products/msr1/setup/co2-calibration-for-msr-1.md @@ -1,6 +1,7 @@ --- +title: CO2 Calibration For MSR-1 description: "CO2 calibration for the MSR-1, covered by the general calibration guide." --- # CO2 Calibration For MSR-1 -##### Please refer to the [General CO2 Calibration](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/) article \ No newline at end of file +## Please refer to the [General CO2 Calibration](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/) article \ No newline at end of file diff --git a/docs/products/msr1/setup/general-tips.md b/docs/products/msr1/setup/general-tips.md index a7a76ac2d7..0a031ed1b8 100755 --- a/docs/products/msr1/setup/general-tips.md +++ b/docs/products/msr1/setup/general-tips.md @@ -1,15 +1,16 @@ --- +title: General Tips description: "Placement and mounting tips for the MSR-1, including keeping the light sensor holes clear and stopping the RGB LED from skewing LUX readings." --- # General Tips -##### **MSR-1** +## **MSR-1**  Picture from Smart Home Scene -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -19,7 +20,7 @@ When mounting the MSR-1 be sure to position the device so that the two large hol 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** +## **Mounting** The MSR-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120-degree FOV of the mmWave radar. @@ -29,7 +30,7 @@ The MSR-1 should be mounted 1.5-2 meters off the ground which will then provide The MSR-1 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling. -##### **Gate and FOV Visualization** +## **Gate and FOV Visualization** **** diff --git a/docs/products/msr1/setup/mmwave-videos.md b/docs/products/msr1/setup/mmwave-videos.md index 873d3e483e..9c7703ff14 100644 --- a/docs/products/msr1/setup/mmwave-videos.md +++ b/docs/products/msr1/setup/mmwave-videos.md @@ -1,4 +1,5 @@ --- +title: mmWave Tuning Videos description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2!" --- --8<-- "products/general/calibrating-and-updating/mmwave-videos.md:5:" diff --git a/docs/products/msr1/setup/updating-msr-1-firmware.md b/docs/products/msr1/setup/updating-msr-1-firmware.md index 9c4ec26938..2f9485b6be 100755 --- a/docs/products/msr1/setup/updating-msr-1-firmware.md +++ b/docs/products/msr1/setup/updating-msr-1-firmware.md @@ -1,6 +1,7 @@ --- +title: Updating MSR-1 Firmware description: "Updating MSR-1 firmware, covered by the general firmware update guide." --- # Updating MSR-1 Firmware -##### Please refer to the [general firmware update](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/ "Updating Firmware") article \ No newline at end of file +## Please refer to the [general firmware update](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/ "Updating Firmware") article \ No newline at end of file diff --git a/docs/products/msr1/setup/zones-ha.md b/docs/products/msr1/setup/zones-ha.md index f4c1e0ba58..226ceed6b3 100755 --- a/docs/products/msr1/setup/zones-ha.md +++ b/docs/products/msr1/setup/zones-ha.md @@ -1,4 +1,5 @@ --- +title: How To Tune mmWave Using Home Assistant description: "Tune the MSR-1 mmWave radar from Home Assistant using Radar Engineering Mode to find which gates cause false triggers and raise their thresholds." --- # How To Tune mmWave Using Home Assistant diff --git a/docs/products/msr1/setup/zones-hlk.md b/docs/products/msr1/setup/zones-hlk.md index 33053810a1..909fcaedf5 100755 --- a/docs/products/msr1/setup/zones-hlk.md +++ b/docs/products/msr1/setup/zones-hlk.md @@ -1,4 +1,5 @@ --- +title: How To Tune mmWave Using HLKRadarTool description: "Tune the MSR-1 mmWave radar over Bluetooth with the HLKRadarTool phone app, covering both auto-calibration and manual gate settings." --- # How To Tune mmWave Using HLKRadarTool diff --git a/docs/products/msr1/troubleshooting/msr1-boot-mode.md b/docs/products/msr1/troubleshooting/msr1-boot-mode.md index ddc5ca3bc8..f6e27566e8 100755 --- a/docs/products/msr1/troubleshooting/msr1-boot-mode.md +++ b/docs/products/msr1/troubleshooting/msr1-boot-mode.md @@ -1,4 +1,5 @@ --- +title: Putting The MSR-1 In Boot Mode description: "Put the MSR-1 into boot mode using the boot button, which is needed before reflashing its firmware." --- # Putting The MSR-1 In Boot Mode @@ -7,7 +8,7 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the MSR-1 as shown in the image below and locate the small opening to press the boot button (the right button). @@ -17,7 +18,7 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede 3\. Continue with uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/msr1/troubleshooting/msr1-code.md b/docs/products/msr1/troubleshooting/msr1-code.md index 7b35cd12a1..20ad00bd2c 100755 --- a/docs/products/msr1/troubleshooting/msr1-code.md +++ b/docs/products/msr1/troubleshooting/msr1-code.md @@ -1,4 +1,5 @@ --- +title: Factory Re-Flash MSR-1 description: "Reflash the MSR-1 back to factory firmware from a Chromium based browser when it stops responding." --- # Factory Re-Flash MSR-1 diff --git a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md index c9876d8829..2f3d03f6a1 100755 --- a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md +++ b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md @@ -1,4 +1,5 @@ --- +title: Reset Wi-Fi Credentials description: "Reset the MSR-1 Wi-Fi credentials with a 10 second press of the Boot button, then reconnect through its hotspot." --- # Reset Wi-Fi Credentials diff --git a/docs/products/msr1/troubleshooting/msr1-teardown.md b/docs/products/msr1/troubleshooting/msr1-teardown.md index 1ae2408de1..39d115ecb2 100755 --- a/docs/products/msr1/troubleshooting/msr1-teardown.md +++ b/docs/products/msr1/troubleshooting/msr1-teardown.md @@ -1,4 +1,5 @@ --- +title: Teardown and Reassembly Of MSR-1 description: "Video walkthrough of taking an MSR-1 apart." --- \ No newline at end of file diff --git a/docs/products/msr2/msr2-reviews.md b/docs/products/msr2/msr2-reviews.md index 7d6ded79ba..5ba7fce8e2 100755 --- a/docs/products/msr2/msr2-reviews.md +++ b/docs/products/msr2/msr2-reviews.md @@ -4,12 +4,12 @@ description: YouTuber reviews and feedback about the MSR-2 sensor from Apollo Au --- # [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/) +## [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) +## [Home Tech Innovations MSR-2 Review](https://www.youtube.com/watch?v=K3j2rR2dsY0) -# [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ) +## [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ) -# [Smart Home Australia MSR-2 Review](https://www.youtube.com/watch?v=EzVyzFwdgN4) +## [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 +## [Michael Leen MSR-2 Review](https://www.youtube.com/watch?v=VdVR8Gs002Q) \ No newline at end of file diff --git a/docs/products/msr2/setup/mmwave-videos.md b/docs/products/msr2/setup/mmwave-videos.md index 873d3e483e..9c7703ff14 100644 --- a/docs/products/msr2/setup/mmwave-videos.md +++ b/docs/products/msr2/setup/mmwave-videos.md @@ -1,4 +1,5 @@ --- +title: mmWave Tuning Videos description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2!" --- --8<-- "products/general/calibrating-and-updating/mmwave-videos.md:5:" diff --git a/docs/products/msr2/setup/msr2-general-tips.md b/docs/products/msr2/setup/msr2-general-tips.md index 92aa8740d2..fc35b509e7 100755 --- a/docs/products/msr2/setup/msr2-general-tips.md +++ b/docs/products/msr2/setup/msr2-general-tips.md @@ -4,7 +4,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi --- # General Tips -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -14,7 +14,7 @@ When mounting the MSR-2 be sure to position the device so that the two large hol 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** +## **Mounting** The MSR-2 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120-degree FOV of the mmWave radar. @@ -30,7 +30,7 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount * 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** +## **Gate and FOV Visualization** **** diff --git a/docs/products/msr2/setup/zones-hlk.md b/docs/products/msr2/setup/zones-hlk.md index 12201270e7..eab46fe25a 100755 --- a/docs/products/msr2/setup/zones-hlk.md +++ b/docs/products/msr2/setup/zones-hlk.md @@ -4,7 +4,7 @@ description: Tutorial for MSR-2 HLKRadarTool app Zone Configuration. --- # How To Tune MSR-2 Using HLKRadarTool -###### **Auto-Calibration** +## **Auto-Calibration** 1\. Download the HLKRadarTool app. @@ -56,7 +56,7 @@ The default password to connect to the HLKRadarTool is "HiLink". **** -###### Manual Calibration +## Manual Calibration 1\. Repeat steps 1-5 above. diff --git a/docs/products/msr2/troubleshooting/msr2-boot-mode.md b/docs/products/msr2/troubleshooting/msr2-boot-mode.md index b4dc6bb4e5..f876bd6a41 100755 --- a/docs/products/msr2/troubleshooting/msr2-boot-mode.md +++ b/docs/products/msr2/troubleshooting/msr2-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The MSR-2 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## 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). @@ -18,7 +18,7 @@ description: Step by step guide for putting The MSR-2 In Boot Mode. 3\. Continue with uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/mtr1/mtr1-reviews.md b/docs/products/mtr1/mtr1-reviews.md index 9ecbdcaaa6..8b8a119fac 100755 --- a/docs/products/mtr1/mtr1-reviews.md +++ b/docs/products/mtr1/mtr1-reviews.md @@ -5,10 +5,10 @@ description: YouTuber reviews and feedback about the MTR-1 sensor from Apollo Au # [Home Tech Innovations MTR-1 Review](https://youtu.be/q5GejbxnByA?si=PMgK4ro6U8Q7idCm) -# [Simon Says Home Assistant MTR-1 Review](https://www.youtube.com/watch?v=FFN-vIkDRLk) +## [Simon Says Home Assistant MTR-1 Review](https://www.youtube.com/watch?v=FFN-vIkDRLk) -# [Smart Home Australia MTR-1 Review](https://www.youtube.com/watch?v=xyxgk7WGHCY) +## [Smart Home Australia MTR-1 Review](https://www.youtube.com/watch?v=xyxgk7WGHCY) -# [Smart Home Scene MTR-1 Review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) +## [Smart Home Scene MTR-1 Review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) -# [Michael Leen MTR-1 Review](https://www.youtube.com/watch?v=7qFvqRw1uds) \ No newline at end of file +## [Michael Leen MTR-1 Review](https://www.youtube.com/watch?v=7qFvqRw1uds) \ No newline at end of file diff --git a/docs/products/mtr1/setup/general-tips.md b/docs/products/mtr1/setup/general-tips.md index 297edbce26..51290b8977 100755 --- a/docs/products/mtr1/setup/general-tips.md +++ b/docs/products/mtr1/setup/general-tips.md @@ -4,11 +4,11 @@ description: Multiple helpful images for mounting, lux/rgb, and zone visualizati --- # General Tips -##### **MTR-1 PCB with Sensors** +## **MTR-1 PCB with Sensors**  -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -16,27 +16,27 @@ When mounting the MTR-1 be sure to position the device so that the large hole at The onboard RGB LED will trigger the light sensor. Be cognizant of this when making automations based on light/LUX. -##### **Mounting** +## **Mounting**  -##### **LD2450 Performance and Electrical Parameters** +## **LD2450 Performance and Electrical Parameters** -##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf) +## [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf)  -##### **Expanding Horizontal Distance as Target Moves Further Away** +## **Expanding Horizontal Distance as Target Moves Further Away** The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance.  -##### **Increased ESP Temperature** +## **Increased ESP Temperature** If you are experiencing higher than normal ESP temperatures ~140+ degrees F then changing the Wi-Fi power save mode option might help decrease the temperature. Here is the link to the ESPHome WiFi Component [Power Save Mode](https://esphome.io/components/wifi.html#power-save-mode). -##### **Improve Wi-Fi Connection** +## **Improve Wi-Fi Connection** The Wi-Fi interface of all ESP32 devices offers three power save modes to reduce the amount of power spent on Wi-Fi. While some options can reduce the power usage of the ESP, they generally also decrease the reliability of the Wi-Fi connection, with frequent disconnections from the router in the highest power saving mode. Switch to "none" to get the best Wi-Fi performance! diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md index f0d89d1e78..5f9efd9e04 100755 --- a/docs/products/mtr1/setup/zones-hlk.md +++ b/docs/products/mtr1/setup/zones-hlk.md @@ -4,7 +4,7 @@ description: Tutorial for MTR-1 HLKRadarTool app Zone Configuration. --- -###### Configure Zones +## Configure Zones !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -64,7 +64,7 @@ The uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/new-product-template/setup/productname-general-tips.md b/docs/products/new-product-template/setup/productname-general-tips.md index d91c021636..57e68a472a 100755 --- a/docs/products/new-product-template/setup/productname-general-tips.md +++ b/docs/products/new-product-template/setup/productname-general-tips.md @@ -6,10 +6,10 @@ description: >- --- # General Tips -###### Fluid Sensor +## Fluid Sensor The fluid level sensor should be securely taped or mounted flat against the surface of your chosen water reservoir. The fluid sensor is rated to go through up to 5mm of plastic but could possibly go further. -###### Pump Control +## Pump Control There is a disabled entity by default called **Pump Control** which will just turn the pump on or off and run it instead of using the **Run Pump** entity. The **Pump Control** entity will ignore the **Pump Run Seconds** however this entity is still affected by the **Max Safe Run Time**. For example, if **Max Safe Run Time** is set to 120 seconds, then when you turn on the **Pump Control** entity, it will run for 120 seconds and then turn off unless you manually turn it off sooner. \ No newline at end of file diff --git a/docs/products/new-product-template/troubleshooting/productname-boot-mode.md b/docs/products/new-product-template/troubleshooting/productname-boot-mode.md index 7dc1b3ddd3..f46c35b72f 100755 --- a/docs/products/new-product-template/troubleshooting/productname-boot-mode.md +++ b/docs/products/new-product-template/troubleshooting/productname-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only !!! danger "Empty the water reservoir and make sure no water is present in the tubes" @@ -26,7 +26,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. [Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/pump1/troubleshooting/pump1-reflash/){ .md-button .md-button--primary } -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your PUMP-1. With the device facing you, locate the reset (left) and boot (right) buttons. diff --git a/docs/products/new-product-template/troubleshooting/productname-teardown.md b/docs/products/new-product-template/troubleshooting/productname-teardown.md index a30a77f0f8..d4f0bfc131 100755 --- a/docs/products/new-product-template/troubleshooting/productname-teardown.md +++ b/docs/products/new-product-template/troubleshooting/productname-teardown.md @@ -6,7 +6,7 @@ description: >- --- # Teardown and Reassembly Of PUMP-1 -###### Disassembly +## Disassembly !!! danger "Drain all liquid from the PUMP-1 before disassembling!" @@ -24,7 +24,7 @@ description: >-  -###### Reassembly +## Reassembly 1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1. diff --git a/docs/products/plt1/examples/blueprint.md b/docs/products/plt1/examples/blueprint.md index 8959f2d99a..55195553b2 100644 --- a/docs/products/plt1/examples/blueprint.md +++ b/docs/products/plt1/examples/blueprint.md @@ -6,7 +6,7 @@ description: >- --- # Blueprint Setup -### Automatic Import +## Automatic Import 1\. Click the Import Blueprint button below and then click **Open link**. @@ -37,7 +37,7 @@ description: >- 7\. Click **Save**. Your blueprint is now live and will send push notifications whenever your plant needs attention! -### Manual Import +## Manual Import 1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**. diff --git a/docs/products/plt1/general-tips.md b/docs/products/plt1/general-tips.md index 290d345d74..27a51d468b 100755 --- a/docs/products/plt1/general-tips.md +++ b/docs/products/plt1/general-tips.md @@ -4,7 +4,7 @@ description: Helpful tips to get the most use out of your sensor. --- # General Tips -###### LTR390 UV +## LTR390 UV For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. diff --git a/docs/products/plt1/reviews.md b/docs/products/plt1/reviews.md index bc5670e645..b07eb2d6ba 100755 --- a/docs/products/plt1/reviews.md +++ b/docs/products/plt1/reviews.md @@ -8,22 +8,22 @@ description: YouTuber reviews and feedback about the PLT-1 sensor from Apollo Au -# [Michael Leen PLT-1 Review](https://youtu.be/tSYUJESNyFM?si=9k0OBns9XvNzYjyz) +## [Michael Leen PLT-1 Review](https://youtu.be/tSYUJESNyFM?si=9k0OBns9XvNzYjyz) -# [Mostly Chris PLT-1 Review](https://youtu.be/9TtLOLbf9zI?si=0wRhrtZ8f9KXqAhB) +## [Mostly Chris PLT-1 Review](https://youtu.be/9TtLOLbf9zI?si=0wRhrtZ8f9KXqAhB) -# Bearded Tinker PLT-1 Review +## Bearded Tinker PLT-1 Review -# Hands On Katie PLT-1 Review +## Hands On Katie PLT-1 Review -# Smart Home Scene PLT-1 Review +## Smart Home Scene PLT-1 Review -# Smart Home Australia PLT-1 Review \ No newline at end of file +## Smart Home Australia PLT-1 Review \ No newline at end of file diff --git a/docs/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/products/plt1/troubleshooting/plt1-boot-mode.md index 1fa4b8fde6..7cfc9fc9fa 100755 --- a/docs/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/products/plt1/troubleshooting/plt1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the PLT-1 as shown in the image below and locate the small opening to press the boot button. @@ -18,7 +18,7 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. 3\. Continue with uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/plt1b/battery-sensors/awake-ha-helper.md b/docs/products/plt1b/battery-sensors/awake-ha-helper.md index b4be1fbaed..4b683b4871 100644 --- a/docs/products/plt1b/battery-sensors/awake-ha-helper.md +++ b/docs/products/plt1b/battery-sensors/awake-ha-helper.md @@ -1,4 +1,5 @@ --- +title: Keep Your Sensor Awake With HA Helper description: "How to keep your sensor awake using the Home Assistant Helper." --- --8<-- "products/general/battery-sensors/awake-ha-helper.md:5:" diff --git a/docs/products/plt1b/battery-sensors/sensor-connection-check.md b/docs/products/plt1b/battery-sensors/sensor-connection-check.md index 4c138fe50e..dc0b58396d 100644 --- a/docs/products/plt1b/battery-sensors/sensor-connection-check.md +++ b/docs/products/plt1b/battery-sensors/sensor-connection-check.md @@ -1,4 +1,5 @@ --- +title: Sensor Connection Check description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." --- --8<-- "products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md b/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/plt1b/examples/flower-card.md b/docs/products/plt1b/examples/flower-card.md index 0f6385fb3e..b9b4204653 100644 --- a/docs/products/plt1b/examples/flower-card.md +++ b/docs/products/plt1b/examples/flower-card.md @@ -1,4 +1,5 @@ --- +title: Flower Card description: "This suggests using the Flower Card inside Home Assistant for your device!" --- --8<-- "products/plt1/examples/flower-card.md:5:" diff --git a/docs/products/plt1b/general-tips.md b/docs/products/plt1b/general-tips.md index a569e1de74..7e460a7683 100755 --- a/docs/products/plt1b/general-tips.md +++ b/docs/products/plt1b/general-tips.md @@ -4,7 +4,7 @@ description: Helpful tips to get the most use out of your sensor. --- # General Tips -###### LTR390 UV +## LTR390 UV For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. diff --git a/docs/products/plt1b/reviews.md b/docs/products/plt1b/reviews.md index 6f242e2559..a6fbeb2c0b 100644 --- a/docs/products/plt1b/reviews.md +++ b/docs/products/plt1b/reviews.md @@ -1,4 +1,5 @@ --- +title: Reviews description: "YouTuber reviews and feedback about the PLT-1 sensor from Apollo Automation." --- --8<-- "products/plt1/reviews.md:5:" diff --git a/docs/products/plt1b/setup/getting-started-plt1.md b/docs/products/plt1b/setup/getting-started-plt1.md index 3bf2f82d6e..4fd0d4228d 100644 --- a/docs/products/plt1b/setup/getting-started-plt1.md +++ b/docs/products/plt1b/setup/getting-started-plt1.md @@ -1,4 +1,5 @@ --- +title: Getting Started description: "Generic getting started article." --- --8<-- "products/general/setup/getting-started.md:5:" diff --git a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md index 25ceb70bf1..90fd3d95a6 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -10,7 +10,7 @@ description: Step by step guide for putting The PLT-1B In Boot Mode.  -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. @@ -22,7 +22,7 @@ description: Step by step guide for putting The PLT-1B In Boot Mode. 3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-code/) -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Plug in the device diff --git a/docs/products/plt1b/troubleshooting/plt1b-code.md b/docs/products/plt1b/troubleshooting/plt1b-code.md index 67c3a789ff..d2a751e2b1 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/products/plt1b/troubleshooting/plt1b-code.md @@ -32,7 +32,7 @@ If no device shows, click cancel and then install the recommended driver that sh 6\. Please proceed to the getting started guide and set up your sensor as a new device! -# Factory Re-Flash PLT-1B +## Factory Re-Flash PLT-1B !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the below guide." diff --git a/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md b/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md index 3067fd7ebe..1e383e9806 100755 --- a/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md +++ b/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md @@ -4,7 +4,7 @@ description: Tutorial for Attaching The Input and Output Fluid Level Sensors to --- # Attaching Fluid Level Sensors to the PUMP-1 -##### Installing Fluid Input Sensor +## Installing Fluid Input Sensor 1\. Begin by placing the small white connector through the hole in the base of the water bottle and gently press the input fluid level sensor into place. @@ -14,13 +14,13 @@ description: Tutorial for Attaching The Input and Output Fluid Level Sensors to  -##### Connecting Fluid Input Sensor +## Connecting Fluid Input Sensor 1\. Insert the small white connector into the **right-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection.  -##### Connecting Fluid Output Sensor +## Connecting Fluid Output Sensor 1\. Insert the small white connector into the **left-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection. diff --git a/docs/products/pump1/setup/pump1-general-tips.md b/docs/products/pump1/setup/pump1-general-tips.md index 3f0b012b45..2b2f457593 100755 --- a/docs/products/pump1/setup/pump1-general-tips.md +++ b/docs/products/pump1/setup/pump1-general-tips.md @@ -6,17 +6,17 @@ description: >- --- # General Tips -###### Fluid Sensor +## Fluid Sensor The fluid level sensor is a non-contact capacitive sensor. It detects water through the wall of the container, so it should be securely taped or mounted flat against the outside surface of your chosen water reservoir. The sensor is rated to read through up to 5mm of plastic and often manages more. Do not submerge the fluid level sensor or place it inside your reservoir. It is not sealed against water, and submerging one can damage both the sensor and the PUMP-1 it is plugged into. -###### Pump Control +## Pump Control There is a disabled entity by default called **Pump Control** which will just turn the pump on or off and run it instead of using the **Run Pump** entity. The **Pump Control** entity will ignore the **Pump Run Seconds** however this entity is still affected by the **Max Safe Run Time**. For example, if **Max Safe Run Time** is set to 120 seconds, then when you turn on the **Pump Control** entity, it will run for 120 seconds and then turn off unless you manually turn it off sooner. -###### Siphon Concerns +## Siphon Concerns If you plan to use the PUMP-1 with the output reservoir positioned lower than the input reservoir, please note that a siphon-like effect can occur. In this setup, small amounts of water may continue to drip even when the pump is turned off. diff --git a/docs/products/pump1/troubleshooting/pump1-boot-mode.md b/docs/products/pump1/troubleshooting/pump1-boot-mode.md index 7dc1b3ddd3..f46c35b72f 100755 --- a/docs/products/pump1/troubleshooting/pump1-boot-mode.md +++ b/docs/products/pump1/troubleshooting/pump1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only !!! danger "Empty the water reservoir and make sure no water is present in the tubes" @@ -26,7 +26,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. [Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/pump1/troubleshooting/pump1-reflash/){ .md-button .md-button--primary } -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your PUMP-1. With the device facing you, locate the reset (left) and boot (right) buttons. diff --git a/docs/products/pump1/troubleshooting/pump1-teardown.md b/docs/products/pump1/troubleshooting/pump1-teardown.md index a30a77f0f8..d4f0bfc131 100755 --- a/docs/products/pump1/troubleshooting/pump1-teardown.md +++ b/docs/products/pump1/troubleshooting/pump1-teardown.md @@ -6,7 +6,7 @@ description: >- --- # Teardown and Reassembly Of PUMP-1 -###### Disassembly +## Disassembly !!! danger "Drain all liquid from the PUMP-1 before disassembling!" @@ -24,7 +24,7 @@ description: >-  -###### Reassembly +## Reassembly 1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1. diff --git a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md index d8315a76a6..86f84335ca 100755 --- a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md +++ b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md @@ -4,7 +4,7 @@ description: Tutorial on adding the gang box mounts to your R PRO-1. --- # Adding Gang Box Mounts To R PRO-1 -###### Attaching Mounts +## Attaching Mounts 1\. Unplug your R PRO-1 from power and remove the back. @@ -32,7 +32,7 @@ description: Tutorial on adding the gang box mounts to your R PRO-1.  -###### Install in 1-Gang Box +## Install in 1-Gang Box 1\. Line up the holes in your 1-gang box (yours will be attached to the wall already). diff --git a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md index 0319f25329..ff52b3bcc8 100755 --- a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md +++ b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md @@ -8,7 +8,7 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. -###### Attaching Mounts +## Attaching Mounts 1\. Unplug your R PRO-1 from power and remove the back. @@ -38,11 +38,11 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount.  -###### Cut the Ceiling Hole +## Cut the Ceiling Hole The Ceiling Mount needs a 3.5 inch (around 89mm) circular hole in the ceiling. Cut that hole before you install the mount. A [2 in. to 7 in. adjustable hole saw](https://www.homedepot.com/p/Milwaukee-2-in-to-7-in-Black-Oxide-Adjustable-Hole-Saw-Cutter-49-56-0320/205744284) set to 3.5 inches is what we used. -###### Install in Ceiling Mount +## Install in Ceiling Mount 1\. Remove the cover to expose the inside of the installed Ceiling Mount. diff --git a/docs/products/rpro1/rpro1-reviews.md b/docs/products/rpro1/rpro1-reviews.md index b1660dce05..9d6dbba611 100755 --- a/docs/products/rpro1/rpro1-reviews.md +++ b/docs/products/rpro1/rpro1-reviews.md @@ -6,8 +6,8 @@ description: YouTuber reviews and feedback about the R PRO-1 sensor from Apollo # Simon Says Home Assistant R PRO-1 Review -# [Smart Home Scene R PRO-1 Review](https://smarthomescene.com/reviews/apollo-r-pro-1-review-dual-mmwave-presence-multisensor-with-poe-support/) +## [Smart Home Scene R PRO-1 Review](https://smarthomescene.com/reviews/apollo-r-pro-1-review-dual-mmwave-presence-multisensor-with-poe-support/) -# [MostlyChris R PRO-1 Review](https://www.youtube.com/watch?v=wVgNE8UtsAM) +## [MostlyChris R PRO-1 Review](https://www.youtube.com/watch?v=wVgNE8UtsAM) -# Pete Scargill R PRO-1 Review \ No newline at end of file +## Pete Scargill R PRO-1 Review \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-general-tips.md b/docs/products/rpro1/setup/rpro1-general-tips.md index fa26dd23b8..05f240fbfa 100755 --- a/docs/products/rpro1/setup/rpro1-general-tips.md +++ b/docs/products/rpro1/setup/rpro1-general-tips.md @@ -4,7 +4,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi --- # General Tips -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -14,13 +14,13 @@ The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't di 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. -##### **Wall Mounting** +## **Wall Mounting** The R PRO-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120 degree FOV for the LD2450 and 150 degree FOV for the LD2412.  -##### **Ceiling Mounting** +## **Ceiling Mounting** The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ceiling using our ceiling mount kit. @@ -48,6 +48,6 @@ The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the * The vertical FOV angle is -35 to 35 degrees - 70 degrees total. * Gates are pre-defined by the radar module and are in 0.75 meter increments. -##### **Gate Visualization** +## **Gate Visualization**  \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-switch-firmware.md b/docs/products/rpro1/setup/rpro1-switch-firmware.md index eeb32889c8..fe4eda823d 100755 --- a/docs/products/rpro1/setup/rpro1-switch-firmware.md +++ b/docs/products/rpro1/setup/rpro1-switch-firmware.md @@ -10,7 +10,7 @@ description: >- Your device needs to be able to connect to the internet to switch between firmware files. If you are connecting to an IoT network on a subnet/vlan unable to access github.com then this will not work. You can also manually reflash your device serially (usb) by following our flashing guide! -###### Switch to Ethernet +## Switch to Ethernet 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below your Apollo R PRO-1. @@ -28,7 +28,7 @@ description: >- 5\. Your device is now on the Ethernet firmware and is ready to configure! -###### Switch to Wi-Fi +## Switch to Wi-Fi 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below your Apollo R PRO-1. diff --git a/docs/products/rpro1/setup/zones-ha-new.md b/docs/products/rpro1/setup/zones-ha-new.md index f319fa91f0..ecb7d33ad0 100755 --- a/docs/products/rpro1/setup/zones-ha-new.md +++ b/docs/products/rpro1/setup/zones-ha-new.md @@ -12,7 +12,7 @@ description: Tutorial for R PRO-1 Home Assistant Zone Configuration. The optional LD2412 mmWave sensor allows you to have perfect still detection for one target at up to 9 meters so it's a great addition to the sensor. -###### LD2450 Configuration +## LD2450 Configuration Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to tune using the HLK Radartool App and we suggest using that to set up your LD2450 instead. @@ -40,6 +40,6 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir -###### LD2412 Configuration +## LD2412 Configuration \ No newline at end of file diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index 9da17659d1..b7619768be 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -18,7 +18,7 @@ description: Tutorial for R PRO-1 Home Assistant Zone Configuration. Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to tune using the HLK Radartool App and we suggest using that to set up your R PRO-1 LD2450. -###### LD2450 Configuration +## LD2450 Configuration 1\. Install [HACS](https://hacs.xyz/docs/use/). @@ -96,7 +96,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir If your zone configurations are not saved when restarting the device then try turning on the LD2450 Bluetooth for a few seconds and then turning it off again. You can also try to toggle on Multi Target Radar. This should wake up the mmWave module and retrieve your saved zones -###### LD2412 Configuration +## LD2412 Configuration 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below the Apollo R PRO-1. diff --git a/docs/products/rpro1/setup/zones-hlk.md b/docs/products/rpro1/setup/zones-hlk.md index 35eaa54038..69c66d28aa 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -6,7 +6,7 @@ description: Tutorial for R PRO-1 HLKRadarTool app Zone Configuration. -###### LD2450 Configuration +## LD2450 Configuration !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -60,7 +60,7 @@ The uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug your R PRO-1 from power and remove the back. diff --git a/docs/products/rpro1/troubleshooting/rpro1-teardown.md b/docs/products/rpro1/troubleshooting/rpro1-teardown.md index bae62ef410..a70d5b9c04 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-teardown.md +++ b/docs/products/rpro1/troubleshooting/rpro1-teardown.md @@ -4,7 +4,7 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts, --- # Teardown and Reassembly Of R PRO-1 -###### Disassembly: +## Disassembly: 1\. Unplug your R PRO-1 from power and remove the back. @@ -22,7 +22,7 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts,  -###### Reassembly +## Reassembly 1\. Place the LD2450 on the 8 pin header. diff --git a/docs/products/temp1/battery-sensors/awake-ha-helper.md b/docs/products/temp1/battery-sensors/awake-ha-helper.md index b4be1fbaed..4b683b4871 100644 --- a/docs/products/temp1/battery-sensors/awake-ha-helper.md +++ b/docs/products/temp1/battery-sensors/awake-ha-helper.md @@ -1,4 +1,5 @@ --- +title: Keep Your Sensor Awake With HA Helper description: "How to keep your sensor awake using the Home Assistant Helper." --- --8<-- "products/general/battery-sensors/awake-ha-helper.md:5:" diff --git a/docs/products/temp1/battery-sensors/sensor-connection-check.md b/docs/products/temp1/battery-sensors/sensor-connection-check.md index 4c138fe50e..dc0b58396d 100644 --- a/docs/products/temp1/battery-sensors/sensor-connection-check.md +++ b/docs/products/temp1/battery-sensors/sensor-connection-check.md @@ -1,4 +1,5 @@ --- +title: Sensor Connection Check description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." --- --8<-- "products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md b/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/temp1/examples/temp1-automation-examples.md b/docs/products/temp1/examples/temp1-automation-examples.md index cb8ba5fead..1a35daa3d9 100755 --- a/docs/products/temp1/examples/temp1-automation-examples.md +++ b/docs/products/temp1/examples/temp1-automation-examples.md @@ -4,7 +4,7 @@ description: Multiple automation examples with the TEMP-1. --- # Automation Examples using a TEMP-1 -###### Freezer Temperature Probe Example +## Freezer Temperature Probe Example This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -66,7 +66,7 @@ actions: mode: single ``` -###### Food Probe Example +## Food Probe Example This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken (or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -121,7 +121,7 @@ actions: mode: single ``` -###### Cook Chicken Example +## Cook Chicken Example This will guide you through adding a button to your dashboard called "Chicken Monitor" and an automation that runs when the button is pressed! This will turn the RGB LED Green when running, message your phone when it starts and when it finishes, plus when the temperature is reached, then turn the RGB LED off. Thanks to Discord user RalphP for this! diff --git a/docs/products/temp1/reviews.md b/docs/products/temp1/reviews.md index 8aeaaaebdd..7c448be335 100755 --- a/docs/products/temp1/reviews.md +++ b/docs/products/temp1/reviews.md @@ -8,22 +8,22 @@ description: YouTuber reviews and feedback about the TEMP-1 sensor from Apollo A -# [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) +## [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) -# [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) +## [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) -# [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) +## [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) -# [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) +## [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) \ No newline at end of file diff --git a/docs/products/temp1/setup/temp1-general-tips.md b/docs/products/temp1/setup/temp1-general-tips.md index 884b3c5998..bb9c9b180a 100755 --- a/docs/products/temp1/setup/temp1-general-tips.md +++ b/docs/products/temp1/setup/temp1-general-tips.md @@ -8,10 +8,10 @@ description: >- The TEMP-1 has an optional Dallas temperature probe (long or short variants) and an optional food-safe probe. -###### Physical Buffered Temperature +## Physical Buffered Temperature For accurate vaccine storage monitoring, the CDC recommends using buffered temperature probes—a principle the Dallas temperature probe can follow using a glycol or glass bead vial. Buffering mimics the thermal behavior of stored vaccines, filtering out brief air temp fluctuations (e.g., door openings) that don’t reflect true vaccine exposure. This results in more reliable, regulation-aligned readings when using Dallas sensors like the DS18B20 in a buffered medium. You can also achieve better results by just placing the probe inside a bottle of water (for the fridge not freezer). -###### Virtual Temperature Buffering +## Virtual Temperature Buffering Instead of placing your Dallas temperature probe (like a DS18B20) in a vial of glycol or glass beads to mimic how vaccines warm up or cool down, you can use a software method called **Virtual Temperature Buffering**. It filters out quick air temperature changes—like when you open the fridge door—and gives a more stable, realistic reading similar to a physical buffer. This means you get accurate, regulation-friendly temps without needing messy liquids or bulky containers. \ No newline at end of file diff --git a/docs/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/products/temp1/troubleshooting/temp1-boot-mode.md index b34bf40ebb..1beb60a6ab 100755 --- a/docs/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/products/temp1/troubleshooting/temp1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The TEMP-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the TEMP-1 so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. @@ -24,7 +24,7 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1/troubleshooting/temp1-code/). -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and remove the case as shown in the images above diff --git a/docs/products/temp1b/battery-sensors/awake-ha-helper.md b/docs/products/temp1b/battery-sensors/awake-ha-helper.md index b4be1fbaed..4b683b4871 100644 --- a/docs/products/temp1b/battery-sensors/awake-ha-helper.md +++ b/docs/products/temp1b/battery-sensors/awake-ha-helper.md @@ -1,4 +1,5 @@ --- +title: Keep Your Sensor Awake With HA Helper description: "How to keep your sensor awake using the Home Assistant Helper." --- --8<-- "products/general/battery-sensors/awake-ha-helper.md:5:" diff --git a/docs/products/temp1b/battery-sensors/sensor-connection-check.md b/docs/products/temp1b/battery-sensors/sensor-connection-check.md index 4c138fe50e..dc0b58396d 100644 --- a/docs/products/temp1b/battery-sensors/sensor-connection-check.md +++ b/docs/products/temp1b/battery-sensors/sensor-connection-check.md @@ -1,4 +1,5 @@ --- +title: Sensor Connection Check description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." --- --8<-- "products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md b/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/temp1b/examples/temp1b-automation-examples.md b/docs/products/temp1b/examples/temp1b-automation-examples.md index ffa9635304..7fa9be146a 100755 --- a/docs/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/products/temp1b/examples/temp1b-automation-examples.md @@ -4,7 +4,7 @@ description: Multiple automation examples with the TEMP-1B. --- # Automation Examples using a TEMP-1B -###### Freezer Temperature Probe Example +## Freezer Temperature Probe Example This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -66,7 +66,7 @@ actions: mode: single ``` -###### Food Probe Example +## Food Probe Example This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken (or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -121,7 +121,7 @@ actions: mode: single ``` -###### Cook Chicken Example +## Cook Chicken Example This will guide you through adding a button to your dashboard called "Chicken Monitor" and an automation that runs when the button is pressed! This will turn the RGB LED Green when running, message your phone when it starts and when it finishes, plus when the temperature is reached, then turn the RGB LED off. Thanks to Discord user RalphP for this! diff --git a/docs/products/temp1b/reviews.md b/docs/products/temp1b/reviews.md index 7eba564dbb..0d5b9bfbfe 100755 --- a/docs/products/temp1b/reviews.md +++ b/docs/products/temp1b/reviews.md @@ -8,22 +8,22 @@ description: YouTuber reviews and feedback about the TEMP-1B sensor from Apollo -# [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) +## [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) -# [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) +## [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) -# [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) +## [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) -# [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) +## [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) \ No newline at end of file diff --git a/docs/products/temp1b/setup/getting-started-temp1.md b/docs/products/temp1b/setup/getting-started-temp1.md index 3bf2f82d6e..4fd0d4228d 100644 --- a/docs/products/temp1b/setup/getting-started-temp1.md +++ b/docs/products/temp1b/setup/getting-started-temp1.md @@ -1,4 +1,5 @@ --- +title: Getting Started description: "Generic getting started article." --- --8<-- "products/general/setup/getting-started.md:5:" diff --git a/docs/products/temp1b/setup/temp1-general-tips.md b/docs/products/temp1b/setup/temp1-general-tips.md index 82fc08d105..3adb8932c4 100644 --- a/docs/products/temp1b/setup/temp1-general-tips.md +++ b/docs/products/temp1b/setup/temp1-general-tips.md @@ -1,4 +1,5 @@ --- -description: ">-" +title: General Tips +description: General tips for the TEMP-1 device and suggestions for improving the usability of the temp and food probe sensor. --- --8<-- "products/temp1/setup/temp1-general-tips.md:7:" diff --git a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md index 4027f9365b..df52384215 100755 --- a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md +++ b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The TEMP-1B In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the TEMP-1B so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. @@ -24,7 +24,7 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1b/troubleshooting/temp1b-code/). -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and remove the case as shown in the images above diff --git a/docs/products/temppro1/examples/temp1-automation-examples.md b/docs/products/temppro1/examples/temp1-automation-examples.md index 3dcfee4687..938327c916 100755 --- a/docs/products/temppro1/examples/temp1-automation-examples.md +++ b/docs/products/temppro1/examples/temp1-automation-examples.md @@ -4,7 +4,7 @@ description: Multiple automation examples with the TEMP-1. --- # Automation Examples using a TEMP-1 -###### Freezer Temperature Probe Example +## Freezer Temperature Probe Example This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -66,7 +66,7 @@ actions: mode: single ``` -###### Food Probe Example +## Food Probe Example This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken (or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -121,7 +121,7 @@ actions: mode: single ``` -###### Cook Chicken Example +## Cook Chicken Example This will guide you through adding a button to your dashboard called "Chicken Monitor" and an automation that runs when the button is pressed! This will turn the RGB LED Green when running, message your phone when it starts and when it finishes, plus when the temperature is reached, then turn the RGB LED off. Thanks to Discord user RalphP for this! diff --git a/docs/products/temppro1/reviews.md b/docs/products/temppro1/reviews.md index d5439c23e8..0a84601755 100755 --- a/docs/products/temppro1/reviews.md +++ b/docs/products/temppro1/reviews.md @@ -12,22 +12,22 @@ These Reviews need to be swapped for new ones -# [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) +## [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) -# [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) +## [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) -# [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) +## [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) -# [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) +## [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) \ No newline at end of file diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md index fb25fe7acf..ec6f4c6b30 100755 --- a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md +++ b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the TEMP Pro-1 so that the USB-C port is facing you. Remove the lid by gently prying up on the small slit by the top of the case. @@ -22,7 +22,7 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. 3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temppro1/troubleshooting/temp-pro1-code/). -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and remove the case as shown in the images above From 12130b9a8ef7bffa7b20dbc9000cc497b8ed123a Mon Sep 17 00:00:00 2001 From: Justin Bunton <130115204+Bunton33@users.noreply.github.com> Date: Mon, 12 Oct 2026 06:31:44 -0400 Subject: [PATCH 4/4] docs: alphabetize nav groups and use one section order per product Nav only: no page is added, removed, or moved to a new URL. All 736 entries are kept (checked by script). - One section order for every product, in both the Home Assistant and Homey trees: Introduction, FAQ, Getting Started, setup groups, Additional Info, Addons, Examples, Troubleshooting, Reviews. Reviews moved to the end on 9 products; Addons now precede Examples on M-1. - Homey MTR-1 Zone Configuration and Homey MSR-2 Radar Tuning move out of Additional Info to sit after Getting Started, as they do in the Home Assistant tree and for Homey R PRO-1. - Products within a category are alphabetical (mmWave: MSR-1, MSR-2, MTR-1, R PRO-1). - Items within Additional Info, Addons, Examples, Troubleshooting, Battery Sensors, Calibrating, and Example Flows are alphabetical, with General Tips and Sensor Definitions kept first. Sequential sections (Getting Started, ESPHome Starter Kit lessons, Zone Configuration's Good/Better/Best) keep their order. - Labels: PLT-1B troubleshooting entries said "PLT-1" (6 entries, both trees); WiFi -> Wi-Fi (3); Unifi -> UniFi (2). Co-Authored-By: Claude Opus 5.5
---
mkdocs.yml | 334 ++++++++++++++++++++++++++---------------------------
1 file changed, 167 insertions(+), 167 deletions(-)
diff --git a/mkdocs.yml b/mkdocs.yml
index b9b96add06..106101073d 100755
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -197,11 +197,14 @@ nav:
- FAQ: products/general/faq.md
- Getting Started: products/general/setup/getting-started.md
- Additional Info:
+ - Adding SCD40 Temp/Hum: products/general/setup/how-to-add-temp-and-humidity-from-scd40.md
+ - Adjusting Wi-Fi Power: products/general/setup/adjusting-wifi-power.md
+ - Bluetooth Proxy: products/general/setup/bluetooth-proxy.md
+ - Bluetooth Tracking: products/general/setup/bluetooth-tracking.md
- Calibrating:
+ - Calibrate PLT-1 Soil Moisture: products/general/calibrating-and-updating/calibrate-plt1.md
- CO2: products/general/calibrating-and-updating/co2-calibration.md
- CO2 Quick: products/general/calibrating-and-updating/co2-calibration-quick.md
- - Temperature and Humidity: products/general/temp-hum-calibration.md
- - Calibrate PLT-1 Soil Moisture: products/general/calibrating-and-updating/calibrate-plt1.md
- Radar Tuning:
- (Best) Apollo mmWave Dashboard:
- Setup: products/general/setup/apollo-mmwave-dashboard-setup.md
@@ -209,36 +212,33 @@ nav:
- Home Assistant: products/general/calibrating-and-updating/radar-tuning/zones-ha.md
- HLK Radar Tool App: products/general/calibrating-and-updating/radar-tuning/zones-hlk.md
- mmWave Tuning Videos: products/general/calibrating-and-updating/mmwave-videos.md
+ - Temperature and Humidity: products/general/temp-hum-calibration.md
- Zone Configuration:
- (Best) Apollo mmWave Dashboard: /products/general/setup/apollo-mmwave-dashboard/#draw-zones-on-the-r-pro-1-and-mtr-1
- (Good) Home Assistant: products/general/calibrating-and-updating/zone-configuration/zones-ha.md
- (Better) HLK Radar Tool App: products/general/calibrating-and-updating/zone-configuration/zones-hlk.md
- (Better) Zone Mapper Tool: products/general/calibrating-and-updating/zone-configuration/zone-mapper-tool.md
- - Updating: products/general/calibrating-and-updating/updating-firmware.md
- - Renaming Devices: products/general/setup/renaming-apollo-devices.md
- - Change Update Frequency: products/general/setup/change-the-update-frequency-of-sensors.md
- - Change Lux Update Interval: products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md
- Change CO2 Update Interval: products/general/tutorials/change-co2-update-interval.md
+ - Change Lux Update Interval: products/general/tutorials/how-to-edit-your-sensor's-lux-update-interval.md
+ - Change Update Frequency: products/general/setup/change-the-update-frequency-of-sensors.md
+ - Hidden Wi-Fi Networks: products/general/setup/adding-apollo-devices-to-hidden-networks.md
- Minimize mmWave Activity Spam: products/general/tutorials/minimize-mmwave-activity-spam.md
- - SmartThings Direct Control: products/general/tutorials/smartthings-direct-control.md
- - Adding SCD40 Temp/Hum: products/general/setup/how-to-add-temp-and-humidity-from-scd40.md
- - Adjusting WiFi Power: products/general/setup/adjusting-wifi-power.md
- - Hidden WiFi Networks: products/general/setup/adding-apollo-devices-to-hidden-networks.md
- - Bluetooth Proxy: products/general/setup/bluetooth-proxy.md
- - Bluetooth Tracking: products/general/setup/bluetooth-tracking.md
- Piezo Buzzer: products/general/piezo.md
+ - Renaming Devices: products/general/setup/renaming-apollo-devices.md
+ - SmartThings Direct Control: products/general/tutorials/smartthings-direct-control.md
- Switch to Beta: products/general/setup/switch-to-beta-branch.md
+ - Updating: products/general/calibrating-and-updating/updating-firmware.md
- Troubleshooting:
- - Removing Devices: products/general/troubleshooting/removing-device-from-home-assistant.md
- Connection Issues: products/general/troubleshooting/connection-issues.md
- Firmware Updates Not Appearing: products/general/troubleshooting/firmware-updates-not-appearing.md
- - Unifi Auto Discover Device mDNS Issue: products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
- OPNsense Auto Discover Device mDNS Issue: products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md
+ - Removing Devices: products/general/troubleshooting/removing-device-from-home-assistant.md
+ - UniFi Auto Discover Device mDNS Issue: products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
- Battery Sensors:
- How To Wake Up Your Sensor: products/general/battery-sensors/wake-up-battery-sensor.md
- Keep Your Sensor Awake With HA Helper: products/general/battery-sensors/awake-ha-helper.md
- - Sensor Connection Check: products/general/battery-sensors/sensor-connection-check.md
- Prevent Sleep: products/general/battery-sensors/prevent-sleep.md
+ - Sensor Connection Check: products/general/battery-sensors/sensor-connection-check.md
- Source Code and 3D Files: products/general/links.md
- Choosing an mmWave Sensor: products/general/choosing-an-mmwave-sensor.md
- Sensor Comparisons: products/general/comparisons.md
@@ -252,15 +252,15 @@ nav:
- General Tips: products/btn1/setup/general-tips.md
- Sensor Definitions: products/btn1/setup/sensor-definitions.md
- Bluetooth Proxy: products/btn1/additional-info/bluetooth-proxy.md
- - Prevent Sleep: products/btn1/additional-info/prevent-sleep.md
- How To Wake Up Your Sensor: products/btn1/battery-sensors/wake-up-battery-sensor.md
+ - Prevent Sleep: products/btn1/additional-info/prevent-sleep.md
- Examples:
- Blueprint: products/btn1/examples/blueprint.md
- Troubleshooting:
- BTN-1 Boot Mode: products/btn1/troubleshooting/btn1-boot-mode.md
- Factory Re-Flash BTN-1: products/btn1/troubleshooting/btn1-reflash.md
- - Teardown and Reassembly Of BTN-1: products/btn1/troubleshooting/btn1-teardown.md
- Reset Wi-Fi Credentials: products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of BTN-1: products/btn1/troubleshooting/btn1-teardown.md
- CAST-1:
- Introduction: products/cast1/introduction.md
- FAQ: products/cast1/faq.md
@@ -295,14 +295,14 @@ nav:
- Additional Info:
- General Tips: products/air1/setup/general-tips.md
- Sensor Definitions: products/air1/setup/sensor-definitions.md
- - Prevent Sleep: products/air1/additional-info/prevent-sleep.md
+ - Bluetooth Proxy: products/air1/additional-info/bluetooth-proxy.md
- LED Indicator: products/air1/additional-info/led-indicator.md
- Predicted Temp & Humidity: products/air1/additional-info/predicted-room-temp-humidity.md
- - Bluetooth Proxy: products/air1/additional-info/bluetooth-proxy.md
+ - Prevent Sleep: products/air1/additional-info/prevent-sleep.md
- Addons:
- CO2 Addon: products/air1/addons/adding-co2-to-air-1.md
- - MiCS Addon: products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
- GPIO Addon: products/air1/addons/adding-gpio-header-to-air-1.md
+ - MiCS Addon: products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
- Examples:
- Air Quality Dashboard: products/air1/examples/air1-dashboard-examples.md
- Firstof9's Apex Charts: products/air1/examples/firstof9's-apex-charts.md
@@ -310,8 +310,8 @@ nav:
- Troubleshooting:
- AIR-1 Boot Mode: products/air1/troubleshooting/air1-boot-mode.md
- Factory Re-Flash AIR-1: products/air1/troubleshooting/air1-code.md
- - Teardown and Reassembly Of AIR-1: products/air1/troubleshooting/air1-teardown.md
- Reset Wi-Fi Credentials: products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of AIR-1: products/air1/troubleshooting/air1-teardown.md
- Reviews: products/air1/air1-reviews.md
- TEMP-1:
- Introduction: products/temp1/introduction.md
@@ -320,27 +320,27 @@ nav:
- Additional Info:
- General Tips: products/temp1/setup/temp1-general-tips.md
- Sensor Definitions: products/temp1/setup/temp1-sensor-definitions.md
+ - Bluetooth Proxy: products/temp1/additional-info/bluetooth-proxy.md
- Change Temp Probe Update Interval: products/temp1/setup/temp1-change-temp-probe-update-interval.md
- - Prevent Sleep: products/temp1/additional-info/prevent-sleep.md
- How To Wake Up Your Sensor: products/temp1/battery-sensors/wake-up-battery-sensor.md
- Keep Your Sensor Awake With HA Helper: products/temp1/battery-sensors/awake-ha-helper.md
+ - Prevent Sleep: products/temp1/additional-info/prevent-sleep.md
- Sensor Connection Check: products/temp1/battery-sensors/sensor-connection-check.md
- - Bluetooth Proxy: products/temp1/additional-info/bluetooth-proxy.md
- Addons:
- - Magnetic Mount: products/temp1/addons/magnetic-mount.md
- - Temp Probe: products/temp1/addons/temp-probe.md
- Food Probe: products/temp1/addons/food-probe.md
+ - Magnetic Mount: products/temp1/addons/magnetic-mount.md
- Multi-Probe Splitter: products/temp1/addons/multiple-probes.md
+ - Temp Probe: products/temp1/addons/temp-probe.md
- Examples:
- Alert Outside Range: products/temp1/examples/temp1-alert-example.md
- - Use Cases: products/temp1/examples/use-cases.md
- Automations: products/temp1/examples/temp1-automation-examples.md
- Hot Water Recirculation: products/temp1/examples/hot-water-recirculation.md
+ - Use Cases: products/temp1/examples/use-cases.md
- Troubleshooting:
- - TEMP-1 Boot Mode: products/temp1/troubleshooting/temp1-boot-mode.md
- Factory Re-Flash TEMP-1: products/temp1/troubleshooting/temp1-code.md
- - Teardown and Reassembly Of TEMP-1: products/temp1/troubleshooting/temp1-teardown.md
- Reset Wi-Fi Credentials: products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of TEMP-1: products/temp1/troubleshooting/temp1-teardown.md
+ - TEMP-1 Boot Mode: products/temp1/troubleshooting/temp1-boot-mode.md
- Reviews: products/temp1/reviews.md
- TEMP-1B:
- Introduction: products/temp1b/introduction.md
@@ -349,27 +349,27 @@ nav:
- Additional Info:
- General Tips: products/temp1b/setup/temp1-general-tips.md
- Sensor Definitions: products/temp1b/setup/temp1b-sensor-definitions.md
- - Prevent Sleep: products/temp1b/additional-info/prevent-sleep.md
+ - Bluetooth Proxy: products/temp1b/additional-info/bluetooth-proxy.md
- How To Wake Up Your Sensor: products/temp1b/battery-sensors/wake-up-battery-sensor.md
- - Keep Your Sensor Awake With HA Helper: products/temp1b/battery-sensors/awake-ha-helper.md
- Insert Battery: products/temp1b/setup/insert-battery.md
+ - Keep Your Sensor Awake With HA Helper: products/temp1b/battery-sensors/awake-ha-helper.md
+ - Prevent Sleep: products/temp1b/additional-info/prevent-sleep.md
- Sensor Connection Check: products/temp1b/battery-sensors/sensor-connection-check.md
- - Bluetooth Proxy: products/temp1b/additional-info/bluetooth-proxy.md
- Addons:
- - Magnetic Mount: products/temp1b/addons/magnetic-mount.md
- - Temp Probe: products/temp1b/addons/temp-probe.md
- Food Probe: products/temp1b/addons/food-probe.md
+ - Magnetic Mount: products/temp1b/addons/magnetic-mount.md
- Multi-Probe Splitter: products/temp1b/addons/multiple-probes.md
+ - Temp Probe: products/temp1b/addons/temp-probe.md
- Examples:
- Alert Outside Range: products/temp1b/examples/temp1b-alert-example.md
- - Use Cases: products/temp1b/examples/use-cases.md
- Automations: products/temp1b/examples/temp1b-automation-examples.md
- Hot Water Recirculation: products/temp1b/examples/hot-water-recirculation.md
+ - Use Cases: products/temp1b/examples/use-cases.md
- Troubleshooting:
- - TEMP-1B Boot Mode: products/temp1b/troubleshooting/temp1b-boot-mode.md
- Factory Re-Flash TEMP-1B: products/temp1b/troubleshooting/temp1b-code.md
- - Teardown and Reassembly Of TEMP-1B: products/temp1b/troubleshooting/temp1b-teardown.md
- Reset Wi-Fi Credentials: products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of TEMP-1B: products/temp1b/troubleshooting/temp1b-teardown.md
+ - TEMP-1B Boot Mode: products/temp1b/troubleshooting/temp1b-boot-mode.md
- Reviews: products/temp1b/reviews.md
- ESPHome Starter Kit:
- Start Here: products/ESPHome-Starter-Kit/start-here.md
@@ -421,24 +421,24 @@ nav:
- Getting Started: products/h1/getting-started.md
- Additional Info:
- How To Wake Up Your Sensor: products/h1/battery-sensors/wake-up-battery-sensor.md
- - Reviews: products/h1/reviews.md
- Examples:
- Holiday Songs: products/general/holiday-songs.md
- Troubleshooting:
- - H-1 Boot Mode: products/h1/boot-mode.md
- Factory Re-Flash H-1: products/h1/reflash.md
+ - H-1 Boot Mode: products/h1/boot-mode.md
+ - Reviews: products/h1/reviews.md
- H-2:
- Introduction: products/h2/introduction.md
- FAQ: products/h2/faq.md
- Getting Started: products/h2/setup/getting-started.md
- Additional Info:
- How To Wake Up Your Sensor: products/h2/battery-sensors/wake-up-battery-sensor.md
- - Reviews: products/h2/h2-reviews.md
- Examples:
- Holiday Songs: products/h2/examples/holiday-songs.md
- Troubleshooting:
- - H-2 Boot Mode: products/h2/troubleshooting/boot-mode.md
- Factory Re-Flash H-2: products/h2/troubleshooting/reflash.md
+ - H-2 Boot Mode: products/h2/troubleshooting/boot-mode.md
+ - Reviews: products/h2/h2-reviews.md
- M-1 (LED Matrix):
- Introduction: products/m1/introduction.md
- FAQ: products/m1/faq.md
@@ -450,23 +450,23 @@ nav:
- Multiple Panels: products/m1/setup/m1-multiple-panels.md
- Segments: products/m1/setup/m1-segments.md
- Additional Info:
- - Wall Mounting your Panels: products/m1/setup/m1-wall-mounting.md
- - Use Without Wi-Fi: products/m1/setup/use-without-wifi.md
- General Tips: products/m1/setup/m1-general-tips.md
+ - Use Without Wi-Fi: products/m1/setup/use-without-wifi.md
+ - Wall Mounting your Panels: products/m1/setup/m1-wall-mounting.md
+ - Addons:
+ - Microphone: products/m1/addons/adding-microphone-to-m-1.md
+ - WizMote Remote: products/m1/addons/wizmote-remote.md
- Examples:
- - Pixel Forge: products/m1/examples/pixel-forge.md
- Add GIFs: products/m1/examples/add-gifs-to-wled.md
- - Scrolling Text: products/m1/examples/scrolling-text.md
+ - Pixel Forge: products/m1/examples/pixel-forge.md
- QR Code Generator: products/m1/examples/qr-code-generator.md
+ - Scrolling Text: products/m1/examples/scrolling-text.md
- Share Data From Home Assistant: products/m1/examples/share-data-from-home-assistant.md
- - Addons:
- - Microphone: products/m1/addons/adding-microphone-to-m-1.md
- - WizMote Remote: products/m1/addons/wizmote-remote.md
- Troubleshooting:
- - Panel Troubleshooting: products/m1/troubleshooting/m1-panel-faults.md
- - M-1 Boot Mode: products/m1/troubleshooting/m1-boot-mode.md
- Factory Re-Flash M-1: products/m1/troubleshooting/m1-reflash.md
- Find IP and Hostname: products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
+ - M-1 Boot Mode: products/m1/troubleshooting/m1-boot-mode.md
+ - Panel Troubleshooting: products/m1/troubleshooting/m1-panel-faults.md
- Using ESPHome:
- Set Up ESPHome: products/m1/setup/getting-started-m1-esphome.md
- Reflash: products/m1/troubleshooting/m1-reflash-esphome.md
@@ -475,6 +475,32 @@ nav:
- SendSpin: products/m1/examples/sendspin.md
- Reviews: products/m1/m1-reviews.md
- mmWave Sensors:
+ - MSR-1:
+ - Introduction: products/msr1/introduction.md
+ - FAQ: products/msr1/faq.md
+ - Getting Started: products/general/setup/getting-started-msr1.md
+ - Additional Info:
+ - General Tips: products/msr1/setup/general-tips.md
+ - Sensor Definitions: products/msr1/setup/sensor-definitions.md
+ - Bluetooth Proxy: products/msr1/additional-info/bluetooth-proxy.md
+ - Exposed GPIO: products/msr1/additional-info/exposed-gpio.md
+ - Radar Tuning:
+ - (Best) Apollo mmWave Dashboard:
+ - Setup: products/msr1/setup/apollo-mmwave-dashboard-setup.md
+ - Calibrate and Tune: products/msr1/setup/apollo-mmwave-dashboard.md
+ - Home Assistant: products/msr1/setup/zones-ha.md
+ - HLK Radar Tool App: products/msr1/setup/zones-hlk.md
+ - mmWave Tuning Videos: products/msr1/setup/mmwave-videos.md
+ - Addons: products/msr1/addons/adding-co2-to-msr-1.md
+ - Examples:
+ - MSR-1 Alarmo: products/msr1/examples/msr1-alarmo.md
+ - MSR-1 Dashboards: products/msr1/examples/msr1-dashboards.md
+ - Troubleshooting:
+ - Factory Re-Flash MSR-1: products/msr1/troubleshooting/msr1-code.md
+ - MSR-1 Boot Mode: products/msr1/troubleshooting/msr1-boot-mode.md
+ - Reset Wi-Fi Credentials: products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of MSR-1: products/msr1/troubleshooting/msr1-teardown.md
+ - Reviews: products/msr1/msr1-reviews.md
- MSR-2:
- Introduction: products/msr2/introduction.md
- FAQ: products/msr2/faq.md
@@ -492,20 +518,20 @@ nav:
- Sensor Definitions: products/msr2/setup/msr2-sensor-definitions.md
- Bluetooth Proxy: products/msr2/additional-info/bluetooth-proxy.md
- Addons:
+ - 90 Degree Addon: products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
- Articulating Stand: products/msr2/addons/adding-articulating-stand-to-msr-2.md
- CO2 Addon: products/msr2/addons/adding-co2-to-msr-2.md
- Female Rear USB-C: products/msr2/addons/adding-rear-female-usb-to-msr-2.md
- GPIO Addon: products/msr2/addons/adding-gpio-header-to-msr-2.md
- Outlet Mount: products/msr2/addons/msr2-outlet-mount.md
- - 90 Degree Addon: products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
- Examples:
- - MSR-2 Alarmo: products/msr2/examples/msr2-alarmo.md
- GPIO Header LED Strip: products/msr2/examples/gpio-header-control-an-led-strip.md
+ - MSR-2 Alarmo: products/msr2/examples/msr2-alarmo.md
- Troubleshooting:
- - MSR-2 Boot Mode: products/msr2/troubleshooting/msr2-boot-mode.md
- Factory Re-Flash MSR-2: products/msr2/troubleshooting/msr2-code.md
- - Teardown and Reassembly Of MSR-2: products/msr2/troubleshooting/msr2-teardown.md
+ - MSR-2 Boot Mode: products/msr2/troubleshooting/msr2-boot-mode.md
- Reset Wi-Fi Credentials: products/msr2/troubleshooting/msr2-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of MSR-2: products/msr2/troubleshooting/msr2-teardown.md
- Reviews: products/msr2/msr2-reviews.md
- MTR-1:
- Introduction: products/mtr1/introduction.md
@@ -523,19 +549,19 @@ nav:
- Sensor Definitions: products/mtr1/setup/sensor-definitions.md
- Bluetooth Proxy: products/mtr1/additional-info/bluetooth-proxy.md
- Addons:
+ - 90 Degree Addon: products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
- Articulating Stand: products/mtr1/addons/adding-articulating-stand-to-mtr-1.md
- CO2 Addon: products/mtr1/addons/adding-co2-to-mtr-1.md
- - Male Rear USB-C: products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
- GPIO Addon: products/mtr1/addons/adding-gpio-header-to-mtr-1.md
- - 90 Degree Addon: products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
+ - Male Rear USB-C: products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
- Examples:
- - MTR-1 Corner Mount: products/mtr1/examples/crookedtoe-mtr1.md
- MTR-1 Alarmo: products/mtr1/examples/mtr1-alarmo.md
+ - MTR-1 Corner Mount: products/mtr1/examples/crookedtoe-mtr1.md
- Troubleshooting:
- - MTR-1 Boot Mode: products/mtr1/troubleshooting/mtr1-boot-mode.md
- Factory Re-Flash MTR-1: products/mtr1/troubleshooting/mtr1-code.md
- - Teardown and Reassembly Of MTR-1: products/mtr1/troubleshooting/mtr1-teardown.md
+ - MTR-1 Boot Mode: products/mtr1/troubleshooting/mtr1-boot-mode.md
- Reset Wi-Fi Credentials: products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of MTR-1: products/mtr1/troubleshooting/mtr1-teardown.md
- Reviews: products/mtr1/mtr1-reviews.md
- R PRO-1:
- Introduction: products/rpro1/introduction.md
@@ -549,47 +575,21 @@ nav:
- (Better) HLK Radar Tool App: products/rpro1/setup/zones-hlk.md
- (Better) Zone Mapper Tool: products/rpro1/setup/r-pro-1-zone-mapper-tool.md
- Additional Info:
- - Switch Firmware: products/rpro1/setup/rpro1-switch-firmware.md
- General Tips: products/rpro1/setup/rpro1-general-tips.md
- Sensor Definitions: products/rpro1/setup/rpro1-sensor-definitions.md
- Bluetooth Proxy: products/rpro1/additional-info/bluetooth-proxy.md
+ - Switch Firmware: products/rpro1/setup/rpro1-switch-firmware.md
- Addons:
- - CO2 Addon: products/rpro1/addons/adding-co2-to-r-pro-1.md
- 1-Gang Box Mount: products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md
- Ceiling Mount: products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md
+ - CO2 Addon: products/rpro1/addons/adding-co2-to-r-pro-1.md
- LD2412 Addon: products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md
- Troubleshooting:
- - R PRO-1 Boot Mode: products/rpro1/troubleshooting/rpro1-boot-mode.md
- Factory Re-Flash R PRO-1: products/rpro1/troubleshooting/rpro1-code.md
- - Teardown and Reassembly Of R PRO-1: products/rpro1/troubleshooting/rpro1-teardown.md
+ - R PRO-1 Boot Mode: products/rpro1/troubleshooting/rpro1-boot-mode.md
- Reset Wi-Fi Credentials: products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of R PRO-1: products/rpro1/troubleshooting/rpro1-teardown.md
- Reviews: products/rpro1/rpro1-reviews.md
- - MSR-1:
- - Introduction: products/msr1/introduction.md
- - FAQ: products/msr1/faq.md
- - Getting Started: products/general/setup/getting-started-msr1.md
- - Additional Info:
- - General Tips: products/msr1/setup/general-tips.md
- - Sensor Definitions: products/msr1/setup/sensor-definitions.md
- - Radar Tuning:
- - (Best) Apollo mmWave Dashboard:
- - Setup: products/msr1/setup/apollo-mmwave-dashboard-setup.md
- - Calibrate and Tune: products/msr1/setup/apollo-mmwave-dashboard.md
- - Home Assistant: products/msr1/setup/zones-ha.md
- - HLK Radar Tool App: products/msr1/setup/zones-hlk.md
- - mmWave Tuning Videos: products/msr1/setup/mmwave-videos.md
- - Exposed GPIO: products/msr1/additional-info/exposed-gpio.md
- - Bluetooth Proxy: products/msr1/additional-info/bluetooth-proxy.md
- - Addons: products/msr1/addons/adding-co2-to-msr-1.md
- - Examples:
- - MSR-1 Dashboards: products/msr1/examples/msr1-dashboards.md
- - MSR-1 Alarmo: products/msr1/examples/msr1-alarmo.md
- - Troubleshooting:
- - MSR-1 Boot Mode: products/msr1/troubleshooting/msr1-boot-mode.md
- - Factory Re-Flash MSR-1: products/msr1/troubleshooting/msr1-code.md
- - Teardown and Reassembly Of MSR-1: products/msr1/troubleshooting/msr1-teardown.md
- - Reset Wi-Fi Credentials: products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
- - Reviews: products/msr1/msr1-reviews.md
- Plant Sensors:
- PLT-1:
- Introduction: products/plt1/introduction.md
@@ -598,17 +598,17 @@ nav:
- Additional Info:
- General Tips: products/plt1/general-tips.md
- Sensor Definitions: products/plt1/setup/plt1-sensor-definitions.md
+ - Bluetooth Proxy: products/plt1/additional-info/bluetooth-proxy.md
- Calibrating Soil Moisture: products/plt1/calibrate-plt1.md
- Prevent Sleep: products/plt1/additional-info/prevent-sleep.md
- - Bluetooth Proxy: products/plt1/additional-info/bluetooth-proxy.md
- Examples:
- - Flower Card: products/plt1/examples/flower-card.md
- Blueprint: products/plt1/examples/blueprint.md
+ - Flower Card: products/plt1/examples/flower-card.md
- Troubleshooting:
- - PLT-1 Boot Mode: products/plt1/troubleshooting/plt1-boot-mode.md
- Factory Re-Flash PLT-1: products/plt1/troubleshooting/plt1-code.md
- - Teardown and Reassembly Of PLT-1: products/plt1/troubleshooting/plt1-teardown.md
+ - PLT-1 Boot Mode: products/plt1/troubleshooting/plt1-boot-mode.md
- Reset Wi-Fi Credentials: products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of PLT-1: products/plt1/troubleshooting/plt1-teardown.md
- Reviews: products/plt1/reviews.md
- PLT-1B:
- Introduction: products/plt1b/introduction.md
@@ -617,21 +617,21 @@ nav:
- Additional Info:
- General Tips: products/plt1b/general-tips.md
- Sensor Definitions: products/plt1b/setup/plt1b-sensor-definitions.md
+ - Bluetooth Proxy: products/plt1b/additional-info/bluetooth-proxy.md
- Calibrating Soil Moisture: products/plt1b/calibrate-plt1.md
- - Prevent Sleep: products/plt1b/additional-info/prevent-sleep.md
- How To Wake Up Your Sensor: products/plt1b/battery-sensors/wake-up-battery-sensor.md
- - Keep Your Sensor Awake With HA Helper: products/plt1b/battery-sensors/awake-ha-helper.md
- Insert Battery: products/plt1b/additional-info/insert-battery.md
+ - Keep Your Sensor Awake With HA Helper: products/plt1b/battery-sensors/awake-ha-helper.md
+ - Prevent Sleep: products/plt1b/additional-info/prevent-sleep.md
- Sensor Connection Check: products/plt1b/battery-sensors/sensor-connection-check.md
- - Bluetooth Proxy: products/plt1b/additional-info/bluetooth-proxy.md
- Examples:
- - Flower Card: products/plt1b/examples/flower-card.md
- Blueprint: products/plt1b/examples/blueprint.md
+ - Flower Card: products/plt1b/examples/flower-card.md
- Troubleshooting:
- - PLT-1 Boot Mode: products/plt1b/troubleshooting/plt1b-boot-mode.md
- - Factory Re-Flash PLT-1: products/plt1b/troubleshooting/plt1b-code.md
- - Teardown and Reassembly Of PLT-1: products/plt1b/troubleshooting/plt1b-teardown.md
+ - Factory Re-Flash PLT-1B: products/plt1b/troubleshooting/plt1b-code.md
+ - PLT-1B Boot Mode: products/plt1b/troubleshooting/plt1b-boot-mode.md
- Reset Wi-Fi Credentials: products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of PLT-1B: products/plt1b/troubleshooting/plt1b-teardown.md
- Reviews: products/plt1b/reviews.md
- PUMP-1:
- Introduction: products/pump1/introduction.md
@@ -643,13 +643,13 @@ nav:
- Bluetooth Proxy: products/pump1/additional-info/bluetooth-proxy.md
- Addons:
- Bottle Addon: products/pump1/addons/attaching-bottle-to-pump-1.md
- - Inlet and Outlet Tube Addons: products/pump1/addons/attaching-tubes-to-pump-1.md
- Fluid Sensor Addons: products/pump1/addons/attaching-fluid-level-sensors-pump-1.md
+ - Inlet and Outlet Tube Addons: products/pump1/addons/attaching-tubes-to-pump-1.md
- Troubleshooting:
- - PUMP-1 Boot Mode: products/pump1/troubleshooting/pump1-boot-mode.md
- Factory Re-Flash PUMP-1: products/pump1/troubleshooting/pump1-reflash.md
- - Teardown and Reassembly Of PUMP-1: products/pump1/troubleshooting/pump1-teardown.md
+ - PUMP-1 Boot Mode: products/pump1/troubleshooting/pump1-boot-mode.md
- Reset Wi-Fi Credentials: products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of PUMP-1: products/pump1/troubleshooting/pump1-teardown.md
- Contact Us / Support: products/general/contact-us/contact-us-support.md
#### ***START OF HOMEY SECTION***
- Homey:
@@ -667,13 +667,13 @@ nav:
- CO2: homey/products/general/calibrating-and-updating/co2-calibration.md
- Radar Tuning:
- mmWave Tuning Videos: homey/products/general/calibrating-and-updating/mmwave-videos.md
- - Hidden WiFi Networks: homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md
+ - Hidden Wi-Fi Networks: homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md
- Renaming Devices: homey/products/general/setup/renaming-apollo-devices.md
- Troubleshooting:
- - Removing Devices: homey/products/general/troubleshooting/removing-device-from-homey.md
- Connection Issues: homey/products/general/troubleshooting/connection-issues.md
- - Unifi Auto Discover Device mDNS Issue: homey/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
- OPNsense Auto Discover Device mDNS Issue: homey/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md
+ - Removing Devices: homey/products/general/troubleshooting/removing-device-from-homey.md
+ - UniFi Auto Discover Device mDNS Issue: homey/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
- Battery Sensors:
- How To Wake Up Your Sensor: homey/products/general/battery-sensors/wake-up-battery-sensor.md
- Sensor Connection Check: homey/products/general/battery-sensors/sensor-connection-check.md
@@ -689,8 +689,8 @@ nav:
- Additional Info:
- General Tips: homey/products/btn1/setup/general-tips.md
- Sensor Definitions: homey/products/btn1/setup/sensor-definitions.md
- - Prevent Sleep: homey/products/btn1/additional-info/prevent-sleep.md
- How To Wake Up Your Sensor: homey/products/btn1/battery-sensors/wake-up-battery-sensor.md
+ - Prevent Sleep: homey/products/btn1/additional-info/prevent-sleep.md
- Addons:
- BTN-1 Addon: homey/products/btn1/addons/btn1-addon.md
- Examples:
@@ -699,8 +699,8 @@ nav:
- Troubleshooting:
- BTN-1 Boot Mode: homey/products/btn1/troubleshooting/btn1-boot-mode.md
- Factory Re-Flash BTN-1: homey/products/btn1/troubleshooting/btn1-reflash.md
- - Teardown and Reassembly Of BTN-1: homey/products/btn1/troubleshooting/btn1-teardown.md
- Reset Wi-Fi Credentials: homey/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of BTN-1: homey/products/btn1/troubleshooting/btn1-teardown.md
- Environmental Sensors:
- AIR-1:
- Introduction: homey/products/air1/introduction.md
@@ -712,65 +712,65 @@ nav:
- Prevent Sleep: homey/products/air1/setup/prevent-sleep.md
- Addons:
- CO2 Addon: homey/products/air1/addons/adding-co2-to-air-1.md
- - MiCS Addon: homey/products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
- GPIO Addon: homey/products/air1/addons/adding-gpio-header-to-air-1.md
- - Reviews: homey/products/air1/air1-reviews.md
+ - MiCS Addon: homey/products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
- Examples:
- Air Quality Dashboard: homey/products/air1/examples/air-quality-notification-example.md
- Troubleshooting:
- AIR-1 Boot Mode: homey/products/air1/troubleshooting/air1-boot-mode.md
- Factory Re-Flash AIR-1: homey/products/air1/troubleshooting/air1-code.md
- - Teardown and Reassembly Of AIR-1: homey/products/air1/troubleshooting/air1-teardown.md
- Reset Wi-Fi Credentials: homey/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of AIR-1: homey/products/air1/troubleshooting/air1-teardown.md
+ - Reviews: homey/products/air1/air1-reviews.md
- TEMP-1:
- Introduction: homey/products/temp1/introduction.md
- FAQ: homey/products/temp1/faq.md
- Getting Started: homey/products/temp1/setup/getting-started-temp1.md
- Additional Info:
- Sensor Definitions: homey/products/temp1/setup/temp1-sensor-definitions.md
- - Prevent Sleep: homey/products/temp1/setup/prevent-sleep.md
- How To Wake Up Your Sensor: homey/products/temp1/battery-sensors/wake-up-battery-sensor.md
+ - Prevent Sleep: homey/products/temp1/setup/prevent-sleep.md
- Sensor Connection Check: homey/products/temp1/battery-sensors/sensor-connection-check.md
- Addons:
- - Magnetic Mount: homey/products/temp1/addons/magnetic-mount.md
- - Temp Probe: homey/products/temp1/addons/temp-probe.md
- Food Probe: homey/products/temp1/addons/food-probe.md
+ - Magnetic Mount: homey/products/temp1/addons/magnetic-mount.md
- Multi-Probe Splitter: homey/products/temp1/addons/multiple-probes.md
- - Reviews: homey/products/temp1/reviews.md
+ - Temp Probe: homey/products/temp1/addons/temp-probe.md
- Examples:
- Alert Outside Range: homey/products/temp1/examples/temp1-alert-example.md
- - Use Cases: homey/products/temp1/examples/use-cases.md
- Automations: homey/products/temp1/examples/temp1-automation-examples.md
+ - Use Cases: homey/products/temp1/examples/use-cases.md
- Troubleshooting:
- - TEMP-1 Boot Mode: homey/products/temp1/troubleshooting/temp1-boot-mode.md
- Factory Re-Flash TEMP-1: homey/products/temp1/troubleshooting/temp1-code.md
- - Teardown and Reassembly Of TEMP-1: homey/products/temp1/troubleshooting/temp1-teardown.md
- Reset Wi-Fi Credentials: homey/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of TEMP-1: homey/products/temp1/troubleshooting/temp1-teardown.md
+ - TEMP-1 Boot Mode: homey/products/temp1/troubleshooting/temp1-boot-mode.md
+ - Reviews: homey/products/temp1/reviews.md
- TEMP-1B:
- Introduction: homey/products/temp1b/introduction.md
- FAQ: homey/products/temp1b/faq.md
- Getting Started: homey/products/temp1b/setup/getting-started-temp1.md
- Additional Info:
- Sensor Definitions: homey/products/temp1b/setup/temp1b-sensor-definitions.md
- - Prevent Sleep: homey/products/temp1b/setup/prevent-sleep.md
- How To Wake Up Your Sensor: homey/products/temp1b/battery-sensors/wake-up-battery-sensor.md
- Insert Battery: homey/products/temp1b/setup/insert-battery.md
+ - Prevent Sleep: homey/products/temp1b/setup/prevent-sleep.md
- Sensor Connection Check: homey/products/temp1b/battery-sensors/sensor-connection-check.md
- Addons:
- - Magnetic Mount: homey/products/temp1b/addons/magnetic-mount.md
- - Temp Probe: homey/products/temp1b/addons/temp-probe.md
- Food Probe: homey/products/temp1b/addons/food-probe.md
+ - Magnetic Mount: homey/products/temp1b/addons/magnetic-mount.md
- Multi-Probe Splitter: homey/products/temp1b/addons/multiple-probes.md
- - Reviews: homey/products/temp1b/reviews.md
+ - Temp Probe: homey/products/temp1b/addons/temp-probe.md
- Examples:
- Alert Outside Range: homey/products/temp1b/examples/temp1b-alert-example.md
- - Use Cases: homey/products/temp1b/examples/use-cases.md
- Automations: homey/products/temp1b/examples/temp1b-automation-examples.md
+ - Use Cases: homey/products/temp1b/examples/use-cases.md
- Troubleshooting:
- - TEMP-1B Boot Mode: homey/products/temp1b/troubleshooting/temp1b-boot-mode.md
- Factory Re-Flash TEMP-1B: homey/products/temp1b/troubleshooting/temp1b-code.md
- - Teardown and Reassembly Of TEMP-1B: homey/products/temp1b/troubleshooting/temp1b-teardown.md
- Reset Wi-Fi Credentials: homey/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of TEMP-1B: homey/products/temp1b/troubleshooting/temp1b-teardown.md
+ - TEMP-1B Boot Mode: homey/products/temp1b/troubleshooting/temp1b-boot-mode.md
+ - Reviews: homey/products/temp1b/reviews.md
- M-1 (LED Matrix):
- Introduction: homey/products/m1/introduction.md
- FAQ: homey/products/m1/faq.md
@@ -782,77 +782,77 @@ nav:
- Multiple Panels: homey/products/m1/setup/m1-multiple-panels.md
- Segments: homey/products/m1/setup/m1-segments.md
- Additional Info:
- - Use Without Wi-Fi: homey/products/m1/setup/use-without-wifi.md
- General Tips: homey/products/m1/setup/m1-general-tips.md
+ - Use Without Wi-Fi: homey/products/m1/setup/use-without-wifi.md
+ - Addons:
+ - Microphone: homey/products/m1/addons/adding-microphone-to-m-1.md
+ - WizMote Remote: homey/products/m1/addons/wizmote-remote.md
- Examples:
- - Pixel Forge: homey/products/m1/examples/pixel-forge.md
- Add GIFs: homey/products/m1/examples/add-gifs-to-wled.md
- - Scrolling Text: homey/products/m1/examples/scrolling-text.md
+ - Pixel Forge: homey/products/m1/examples/pixel-forge.md
- QR Code Generator: homey/products/m1/examples/qr-code-generator.md
+ - Scrolling Text: homey/products/m1/examples/scrolling-text.md
- Share Data From Home Assistant: homey/products/m1/examples/share-data-from-home-assistant.md
- - Addons:
- - Microphone: homey/products/m1/addons/adding-microphone-to-m-1.md
- - WizMote Remote: homey/products/m1/addons/wizmote-remote.md
- Troubleshooting:
- - Panel Troubleshooting: homey/products/m1/troubleshooting/m1-panel-faults.md
- - M-1 Boot Mode: homey/products/m1/troubleshooting/m1-boot-mode.md
- Factory Re-Flash M-1: homey/products/m1/troubleshooting/m1-reflash.md
- Find IP and Hostname: homey/products/m1/troubleshooting/m1-find-ip-address-and-hostname.md
+ - M-1 Boot Mode: homey/products/m1/troubleshooting/m1-boot-mode.md
+ - Panel Troubleshooting: homey/products/m1/troubleshooting/m1-panel-faults.md
- Reviews: homey/products/m1/m1-reviews.md
- mmWave Sensors:
- MSR-2:
- Introduction: homey/products/msr2/introduction.md
- FAQ: homey/products/msr2/faq.md
- Getting Started: homey/products/general/setup/getting-started-msr2.md
+ - Radar Tuning:
+ - Home Assistant: homey/products/msr2/setup/zones-ha.md
+ - HLK Radar Tool App: homey/products/msr2/setup/zones-hlk.md
+ - mmWave Tuning Videos: homey/products/msr2/setup/mmwave-videos.md
- Additional Info:
- General Tips: homey/products/msr2/setup/msr2-general-tips.md
- Sensor Definitions: homey/products/msr2/setup/msr2-sensor-definitions.md
- - Radar Tuning:
- - Home Assistant: homey/products/msr2/setup/zones-ha.md
- - HLK Radar Tool App: homey/products/msr2/setup/zones-hlk.md
- - mmWave Tuning Videos: homey/products/msr2/setup/mmwave-videos.md
- Addons:
+ - 90 Degree Addon: homey/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
- Articulating Stand: homey/products/msr2/addons/adding-articulating-stand-to-msr-2.md
- CO2 Addon: homey/products/msr2/addons/adding-co2-to-msr-2.md
- Female Rear USB-C: homey/products/msr2/addons/adding-rear-female-usb-to-msr-2.md
- GPIO Addon: homey/products/msr2/addons/adding-gpio-header-to-msr-2.md
- Outlet Mount: homey/products/msr2/addons/msr2-outlet-mount.md
- - 90 Degree Addon: homey/products/msr2/addons/adding-90-degree-usb-c-to-msr-2.md
- - Reviews: homey/products/msr2/msr2-reviews.md
- Examples:
- - MSR-2 Dashboards: homey/products/msr2/examples/msr2-dashboards.md
- - MSR-2 Alarmo: homey/products/msr2/examples/msr2-alarmo.md
- GPIO Header LED Strip: homey/products/msr2/examples/gpio-header-control-an-led-strip.md
+ - MSR-2 Alarmo: homey/products/msr2/examples/msr2-alarmo.md
+ - MSR-2 Dashboards: homey/products/msr2/examples/msr2-dashboards.md
- Troubleshooting:
- - MSR-2 Boot Mode: homey/products/msr2/troubleshooting/msr2-boot-mode.md
- Factory Re-Flash MSR-2: homey/products/msr2/troubleshooting/msr2-code.md
- - Teardown and Reassembly Of MSR-2: homey/products/msr2/troubleshooting/msr2-teardown.md
+ - MSR-2 Boot Mode: homey/products/msr2/troubleshooting/msr2-boot-mode.md
- Reset Wi-Fi Credentials: homey/products/msr2/troubleshooting/msr2-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of MSR-2: homey/products/msr2/troubleshooting/msr2-teardown.md
+ - Reviews: homey/products/msr2/msr2-reviews.md
- MTR-1:
- Introduction: homey/products/mtr1/introduction.md
- FAQ: homey/products/mtr1/faq.md
- Getting Started: homey/products/general/setup/getting-started-mtr1.md
+ - Zone Configuration:
+ - (Better) HLK Radar Tool App: homey/products/mtr1/setup/zones-hlk.md
+ - (Best) Zone Mapper Tool: homey/products/mtr1/setup/mtr-1-zone-mapper-tool.md
- Additional Info:
- General Tips: homey/products/mtr1/setup/general-tips.md
- Sensor Definitions: homey/products/mtr1/setup/sensor-definitions.md
- - Zone Configuration:
- - (Better) HLK Radar Tool App: homey/products/mtr1/setup/zones-hlk.md
- - (Best) Zone Mapper Tool: homey/products/mtr1/setup/mtr-1-zone-mapper-tool.md
- Addons:
+ - 90 Degree Addon: homey/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
- Articulating Stand: homey/products/mtr1/addons/adding-articulating-stand-to-mtr-1.md
- CO2 Addon: homey/products/mtr1/addons/adding-co2-to-mtr-1.md
- - Male Rear USB-C: homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
- GPIO Addon: homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
- - 90 Degree Addon: homey/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
- - Reviews: homey/products/mtr1/mtr1-reviews.md
+ - Male Rear USB-C: homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
- Examples:
- - MTR-1 Corner Mount: homey/products/mtr1/examples/crookedtoe-mtr1.md
- MTR-1 Alarmo: homey/products/mtr1/examples/mtr1-alarmo.md
+ - MTR-1 Corner Mount: homey/products/mtr1/examples/crookedtoe-mtr1.md
- Troubleshooting:
- - MTR-1 Boot Mode: homey/products/mtr1/troubleshooting/mtr1-boot-mode.md
- Factory Re-Flash MTR-1: homey/products/mtr1/troubleshooting/mtr1-code.md
- - Teardown and Reassembly Of MTR-1: homey/products/mtr1/troubleshooting/mtr1-teardown.md
+ - MTR-1 Boot Mode: homey/products/mtr1/troubleshooting/mtr1-boot-mode.md
- Reset Wi-Fi Credentials: homey/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of MTR-1: homey/products/mtr1/troubleshooting/mtr1-teardown.md
+ - Reviews: homey/products/mtr1/mtr1-reviews.md
- R PRO-1:
- Introduction: homey/products/rpro1/introduction.md
- FAQ: homey/products/rpro1/faq.md
@@ -860,19 +860,19 @@ nav:
- (Better) HLK Radar Tool App: homey/products/rpro1/setup/zones-hlk.md
- (Best) Zone Mapper Tool: homey/products/rpro1/setup/r-pro-1-zone-mapper-tool.md
- Additional Info:
- - Switch Firmware: homey/products/rpro1/setup/rpro1-switch-firmware.md
- General Tips: homey/products/rpro1/setup/rpro1-general-tips.md
- Sensor Definitions: homey/products/rpro1/setup/rpro1-sensor-definitions.md
+ - Switch Firmware: homey/products/rpro1/setup/rpro1-switch-firmware.md
- Addons:
- - CO2 Addon: homey/products/rpro1/addons/adding-co2-to-r-pro-1.md
- 1-Gang Box Mount: homey/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md
- Ceiling Mount: homey/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md
+ - CO2 Addon: homey/products/rpro1/addons/adding-co2-to-r-pro-1.md
- LD2412 Addon: homey/products/rpro1/addons/add-the-ld2412-mmwave-sensor-to-r-pro-1.md
- Troubleshooting:
- - R PRO-1 Boot Mode: homey/products/rpro1/troubleshooting/rpro1-boot-mode.md
- Factory Re-Flash R PRO-1: homey/products/rpro1/troubleshooting/rpro1-code.md
- - Teardown and Reassembly Of R PRO-1: homey/products/rpro1/troubleshooting/rpro1-teardown.md
+ - R PRO-1 Boot Mode: homey/products/rpro1/troubleshooting/rpro1-boot-mode.md
- Reset Wi-Fi Credentials: homey/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of R PRO-1: homey/products/rpro1/troubleshooting/rpro1-teardown.md
- Reviews: homey/products/rpro1/rpro1-reviews.md
- Plant Sensors:
- PLT-1:
@@ -884,14 +884,14 @@ nav:
- Sensor Definitions: homey/products/plt1/setup/plt1-sensor-definitions.md
- Calibrating Soil Moisture: homey/products/plt1/calibrate-plt1.md
- Prevent Sleep: homey/products/plt1/setup/prevent-sleep.md
- - Reviews: homey/products/plt1/reviews.md
- Examples:
- Flower Card: homey/products/plt1/examples/flower-card.md
- Troubleshooting:
- - PLT-1 Boot Mode: homey/products/plt1/troubleshooting/plt1-boot-mode.md
- Factory Re-Flash PLT-1: homey/products/plt1/troubleshooting/plt1-code.md
- - Teardown and Reassembly Of PLT-1: homey/products/plt1/troubleshooting/plt1-teardown.md
+ - PLT-1 Boot Mode: homey/products/plt1/troubleshooting/plt1-boot-mode.md
- Reset Wi-Fi Credentials: homey/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of PLT-1: homey/products/plt1/troubleshooting/plt1-teardown.md
+ - Reviews: homey/products/plt1/reviews.md
- PLT-1B:
- Introduction: homey/products/plt1b/introduction.md
- FAQ: homey/products/plt1b/faq.md
@@ -900,18 +900,18 @@ nav:
- General Tips: homey/products/plt1b/general-tips.md
- Sensor Definitions: homey/products/plt1b/setup/plt1b-sensor-definitions.md
- Calibrating Soil Moisture: homey/products/plt1b/calibrate-plt1.md
- - Prevent Sleep: homey/products/plt1b/setup/prevent-sleep.md
- How To Wake Up Your Sensor: homey/products/plt1b/battery-sensors/wake-up-battery-sensor.md
- Insert Battery: homey/products/plt1b/additional-info/insert-battery.md
+ - Prevent Sleep: homey/products/plt1b/setup/prevent-sleep.md
- Sensor Connection Check: homey/products/plt1b/battery-sensors/sensor-connection-check.md
- - Reviews: homey/products/plt1b/reviews.md
- Examples:
- Flower Card: homey/products/plt1b/examples/flower-card.md
- Troubleshooting:
- - PLT-1 Boot Mode: homey/products/plt1b/troubleshooting/plt1b-boot-mode.md
- - Factory Re-Flash PLT-1: homey/products/plt1b/troubleshooting/plt1b-code.md
- - Teardown and Reassembly Of PLT-1: homey/products/plt1b/troubleshooting/plt1b-teardown.md
+ - Factory Re-Flash PLT-1B: homey/products/plt1b/troubleshooting/plt1b-code.md
+ - PLT-1B Boot Mode: homey/products/plt1b/troubleshooting/plt1b-boot-mode.md
- Reset Wi-Fi Credentials: homey/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md
+ - Teardown and Reassembly Of PLT-1B: homey/products/plt1b/troubleshooting/plt1b-teardown.md
+ - Reviews: homey/products/plt1b/reviews.md
- PUMP-1:
- Introduction: homey/products/pump1/introduction.md
- FAQ: homey/products/pump1/faq.md
@@ -920,11 +920,11 @@ nav:
- Sensor Definitions: homey/products/pump1/setup/pump1-sensor-definitions.md
- Addons:
- Bottle Addon: homey/products/pump1/addons/attaching-bottle-to-pump-1.md
- - Inlet and Outlet Tube Addons: homey/products/pump1/addons/attaching-tubes-to-pump-1.md
- Fluid Sensor Addons: homey/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md
+ - Inlet and Outlet Tube Addons: homey/products/pump1/addons/attaching-tubes-to-pump-1.md
- Troubleshooting:
- - PUMP-1 Boot Mode: homey/products/pump1/troubleshooting/pump1-boot-mode.md
- Factory Re-Flash PUMP-1: homey/products/pump1/troubleshooting/pump1-reflash.md
- - Teardown and Reassembly Of PUMP-1: homey/products/pump1/troubleshooting/pump1-teardown.md
+ - PUMP-1 Boot Mode: homey/products/pump1/troubleshooting/pump1-boot-mode.md
- Reset Wi-Fi Credentials: homey/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md
- - Contact Us / Support: homey/products/general/contact-us/contact-us-support.md
\ No newline at end of file
+ - Teardown and Reassembly Of PUMP-1: homey/products/pump1/troubleshooting/pump1-teardown.md
+ - Contact Us / Support: homey/products/general/contact-us/contact-us-support.md
PM Type | Size (µm) | Description |
|---|---|---|
PM1 | ≤ 1.0 | Ultrafine particles that can reach deep into the lungs and bloodstream. |
PM2.5 | ≤ 2.5 | Fine particles; linked to respiratory and cardiovascular issues. |
PM4 | ≤ 4.0 | Less commonly regulated; typically used in industrial settings. |
PM10 | ≤ 10 | Inhalable particles; may irritate eyes, nose, and throat. |
-###### Stream To Your CAST-1
+### Stream To Your CAST-1
1\. Open **Music Assistant** from the Home Assistant sidebar.
@@ -110,7 +110,7 @@ The CAST-1 streams through Discord for some help.
-### Connecting Through Hotspot
+## Connecting Through Hotspot
To connect through the sensor's onboard hotspot follow the below:
@@ -32,7 +32,7 @@ If this does not automatically open the dashboard, please open your web browser
[Click here for next steps!](https://wiki.apolloautomation.com/products/general/setup/getting-started/#connecting-to-home-assistant-via-esphome-integration){ .md-button .md-button--primary }
-### Connecting with Improv via BLE
+## Connecting with Improv via BLE
!!! note "Pre-requirement:"
@@ -62,7 +62,7 @@ If this does not automatically open the dashboard, please open your web browser
-### Connecting To ESPHome Device Builder
+## Connecting To ESPHome Device Builder
!!! tip "Skip the ESPHome Device Builder unless..."
@@ -102,7 +102,7 @@ wifi_password: "your-wifi-pass-here"
6\. Your new device is now adopted into the ESPHome Device Builder and you can move on to Integrating with Home Assistant via the ESPHome Integration below!
-### Connecting to Home Assistant via ESPHome Integration:
+## Connecting to Home Assistant via ESPHome Integration:
1\. Click the "**Notifications**" Icon in the bottom left.
diff --git a/docs/products/general/setup/renaming-apollo-devices.md b/docs/products/general/setup/renaming-apollo-devices.md
index 7f2af0e246..23e56c22c2 100755
--- a/docs/products/general/setup/renaming-apollo-devices.md
+++ b/docs/products/general/setup/renaming-apollo-devices.md
@@ -4,7 +4,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio
---
# Renaming Apollo Devices
-##### ESPHome Integration - Part 1
+## ESPHome Integration - Part 1
1\. Click the button below to open the ESPHome Integrations page.
@@ -26,7 +26,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio
-##### ESPHome Integration - Part 2
+## ESPHome Integration - Part 2
This section only changes the device name shown in the ESPHome integration page. It is safe to skip, but we recommend doing it to keep naming consistent.
@@ -42,7 +42,7 @@ This section only changes the device name shown in the ESPHome integration page.
The next section is for ESPHome device builder which is for tinkerers and advanced users to take control of their device and edit the yaml. Please skip the next section if you do not use ESPHome Device Builder!
-##### ESPHome Device Builder
+## ESPHome Device Builder
1\. Make sure you are already using the ESPHome Device Builder app as gone over in the getting started wiki articles.
diff --git a/docs/products/general/temp-hum-calibration.md b/docs/products/general/temp-hum-calibration.md
index ce977fcc45..bc2979a685 100755
--- a/docs/products/general/temp-hum-calibration.md
+++ b/docs/products/general/temp-hum-calibration.md
@@ -4,7 +4,7 @@ description: Temp and Humidity Calibration and Offset Examples.
---
# Simple and Advanced Examples of Temperature & Humidity Offsets
-### **Simple Offsets for Temperature and Humidity:**
+## **Simple Offsets for Temperature and Humidity:**
**Please add these to the bottom of your ESPHome yaml for your device then click save and install. Once you are finished, you will have two new boxes inside the Home Assistant ESPHome integration device page for your device where you can fill in an offset. Give them up to 1 minute to take effect!**
@@ -49,11 +49,11 @@ number:
mode: box
```
-### **BME280 & SCD40 Sensors: Overcoming Temperature & Humidity Reading Challenges**
+## **BME280 & SCD40 Sensors: Overcoming Temperature & Humidity Reading Challenges**
The BME280 and SCD40 sensors are known for their precision in measuring temperature and humidity. However, like all sensor systems, they can sometimes provide inaccurate readings due to various factors. In the case of the BME280 and SCD40 sensors, one significant challenge arises from the heat produced by the ESP chip, which can alter the environment inside its enclosure, thereby skewing the readings.
-### **Adjusting the BME280 and SCD40 Temperature Offset**
+## **Adjusting the BME280 and SCD40 Temperature Offset**
For users who want to fine-tune their sensors, the BME280 and SCD40 Temperature Offset entities can be manually adjusted to match the conditions in their home. The offset values are subtracted from the raw temperature & humidity readings in the firmware to update the sensor readings in the Home Assistant entity. For example: scd40\_temperature entity = raw scd40 temperature reading - scd40\_offset.
@@ -61,7 +61,7 @@ By default, these offsets are preset to values based on our NIST certified therm
Users will also notice the `bme280_humidity_calibrated`, `scd40_humidity_calibrated`, `bme280_temperature_calibrated`, and `scd40_temperature_calibrated` entities. These values utilize the linear filter in the ESPHome firmware to adjust the readings based on our collected data. Again, due to environmental differences, these might not always be precise.
-### **Modeling the Relationship Between Sensors**
+## **Modeling the Relationship Between Sensors**
Another approach to getting accurate readings is to model the relationship between the ESP temperature and the other sensors compared against a reference temperature. This can be achieved by creating a template sensor in Home Assistant that employs a decision tree or our regression coefficients.
@@ -134,10 +134,10 @@ notify:
```
-### **The Interrelation of Temperature and Humidity**
+## **The Interrelation of Temperature and Humidity**
It's important to understand that temperature and humidity share an interdependent relationship. When the air temperature rises, its capacity to hold moisture increases, which can decrease relative humidity levels. Conversely, when the temperature falls, the air's capacity to hold moisture decreases, leading to increased humidity. This relationship plays a significant role in how sensors detect and interpret readings, making it even more crucial to ensure accuracy.
-### **Advanced Accuracy with GPIO**
+## **Advanced Accuracy with GPIO**
For those seeking the highest accuracy, an advanced solution is available. The exposed mezzanine connector on the back of our Apollo boards can be utilized to connect a temperature/humidity sensor. This modification can dramatically improve both temperature and humidity readings, providing data that's as accurate as possible.
\ No newline at end of file
diff --git a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md
index 49c6af74c0..f95551958a 100755
--- a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md
+++ b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md
@@ -4,7 +4,7 @@ description: Tutorial for Removing Device From Home Assistant.
---
# Removing Device From Home Assistant
-##### ESPHome app
+## ESPHome app
This will cover how to remove an Apollo device from Home Assistant
@@ -20,7 +20,7 @@ This will cover how to remove an Apollo device from Home Assistant
-##### ESPHome Integration
+## ESPHome Integration
1\. Head to the ESPHome Integrations page. Next to the device you would like to remove, click the three dots and then "Delete".
diff --git a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
index 84275a51c7..8e0916c602 100755
--- a/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
+++ b/docs/products/general/troubleshooting/ubiquiti-unifi-mdns-auto-discover-issue.md
@@ -8,7 +8,7 @@ description: Tutorial to help fix the Ubiquiti UniFi mDNS Auto Discover Issue.
If you have different networks that Homey and ESPHome devices are on, then you will need mDNS working across both networks and firewall rules allowing access between them. Below are guides for using your PC and the UniFi iOS app to fix this issue.
-##### **Method 1: Browser**
+## **Method 1: Browser**
1\. Log into your UniFi network through your default IP address which is usually http://192.168.1.1
@@ -34,7 +34,7 @@ description: Tutorial to help fix the Ubiquiti UniFi mDNS Auto Discover Issue.
7\. Now the Home Assistant/ESPHome auto-discover issue should be fixed!
-##### **Method 2: UniFi iOS App.**
+## **Method 2: UniFi iOS App.**
1\. Open the UniFi app.
diff --git a/docs/products/h1/battery-sensors/wake-up-battery-sensor.md b/docs/products/h1/battery-sensors/wake-up-battery-sensor.md
index 023266d9c9..e5adaf6759 100644
--- a/docs/products/h1/battery-sensors/wake-up-battery-sensor.md
+++ b/docs/products/h1/battery-sensors/wake-up-battery-sensor.md
@@ -1,4 +1,5 @@
---
+title: How To Wake Up Your Sensor
description: "How to wake up your Apollo device which is currently sleeping."
---
--8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:"
diff --git a/docs/products/h1/reviews.md b/docs/products/h1/reviews.md
index ecee5b8da8..1abea53cca 100755
--- a/docs/products/h1/reviews.md
+++ b/docs/products/h1/reviews.md
@@ -6,18 +6,18 @@ description: H-1 Reviews.
-# 
-###### Play In Multiple Rooms
+### Play In Multiple Rooms
Have more than one CAST-1? Group them to play the same music in sync across every room.
diff --git a/docs/products/cast1/troubleshooting/cast1-boot-mode.md b/docs/products/cast1/troubleshooting/cast1-boot-mode.md
index 75ed3eb6b9..a029119720 100644
--- a/docs/products/cast1/troubleshooting/cast1-boot-mode.md
+++ b/docs/products/cast1/troubleshooting/cast1-boot-mode.md
@@ -8,7 +8,7 @@ description: Step by step guide for putting The CAST-1 In Boot Mode.
This is needed to force the device into boot mode to reflash the firmware. Both methods do the same thing, so use whichever is easier for you.
-##### Method 1: Boot Button Only
+## Method 1: Boot Button Only
1\. With the CAST-1 unplugged, hold down the **boot** button (on the left) while plugging a USB-C data cable into the CAST-1. Once connected, release the button.
@@ -18,7 +18,7 @@ description: Step by step guide for putting The CAST-1 In Boot Mode.
[Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/cast1/troubleshooting/cast1-reflash/){ .md-button .md-button--primary }
-##### Method 2: Boot and Reset Buttons
+## Method 2: Boot and Reset Buttons
1\. Plug a USB-C cable that supports power and data into your computer and connect the other end to your CAST-1.
diff --git a/docs/products/general/calibrating-and-updating/radar-tuning/zones-ha.md b/docs/products/general/calibrating-and-updating/radar-tuning/zones-ha.md
index 7e1cc7b9b0..6bd8da8fef 100644
--- a/docs/products/general/calibrating-and-updating/radar-tuning/zones-ha.md
+++ b/docs/products/general/calibrating-and-updating/radar-tuning/zones-ha.md
@@ -1,10 +1,11 @@
---
+title: Home Assistant
description: ){kind=link}
Michael Lean +##
Michael Lean -#
Mostly Chris +##
Mostly Chris -#
Smart Home Sellout +##
Smart Home Sellout -#
Smart Home Australia +##
Smart Home Australia \ No newline at end of file diff --git a/docs/products/h2/battery-sensors/wake-up-battery-sensor.md b/docs/products/h2/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/h2/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/h2/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/h2/examples/holiday-songs.md b/docs/products/h2/examples/holiday-songs.md index 58f9bcfd94..3c0f86774c 100644 --- a/docs/products/h2/examples/holiday-songs.md +++ b/docs/products/h2/examples/holiday-songs.md @@ -1,4 +1,5 @@ --- -description: ">-" +title: Holiday Songs +description: List of Holiday Songs to use with the Holiday ornaments or any Apollo device with a buzzer. --- --8<-- "products/general/holiday-songs.md:7:" diff --git a/docs/products/h2/h2-reviews.md b/docs/products/h2/h2-reviews.md index 3f0e510db5..87be955321 100755 --- a/docs/products/h2/h2-reviews.md +++ b/docs/products/h2/h2-reviews.md @@ -9,18 +9,18 @@ these need to be updated -#
Michael Lean +##
Michael Lean -#
Mostly Chris +##
Mostly Chris -#
Smart Home Sellout +##
Smart Home Sellout -#
Smart Home Australia +##
Smart Home Australia \ No newline at end of file diff --git a/docs/products/led1/setup/getting-started-led1.md b/docs/products/led1/setup/getting-started-led1.md index 1dc0ea93a7..f66166414a 100755 --- a/docs/products/led1/setup/getting-started-led1.md +++ b/docs/products/led1/setup/getting-started-led1.md @@ -6,7 +6,7 @@ description: Getting started with your new LED-1! Congrats on your new LED-1! Below we will go through steps to get you up and running in no time. -### Choose how to power it +## Choose how to power it The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V or 12V up to 3 amps) or a dedicated power supply using either 5V, 12V, or 24V. @@ -40,7 +40,7 @@ The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V Before proceeding to the next steps, make sure to unplug your device! -### Wire up LEDs +## Wire up LEDs !!! danger "Before proceeding, consider double checking your power supply and leds use the same voltage!" @@ -54,7 +54,7 @@ The LED-1 can be powered via USB (5V up to 3 amps) or via USB Power Delivery (5V 3\. Repeat step 2 for a second led strip using Output 2 if you have a second led strip! -### Connect to Wi-Fi +## Connect to Wi-Fi Your device is now ready to connect to your Wi-Fi and begin controlling via Home Assistant, the WLED app for iPhone and Android, or via a web browser! @@ -62,7 +62,7 @@ Your device is now ready to connect to your Wi-Fi and begin controlling via Home  -### Join to Home Assistant +## Join to Home Assistant 1\. Your device should be auto-discovered by Home Assistant using the WLED Integration as shown below! diff --git a/docs/products/led1/setup/led1-general-tips.md b/docs/products/led1/setup/led1-general-tips.md index 27dc91a04d..2c3f4ed5e4 100755 --- a/docs/products/led1/setup/led1-general-tips.md +++ b/docs/products/led1/setup/led1-general-tips.md @@ -4,7 +4,7 @@ description: Multiple helpful tips to use your LED-1 to the fullest! --- # General Tips -##### Power Supplies +## Power Supplies Meanwell power supplies are best but most power supplies off Amazon will be sufficient. As a rule of thumb, over 80% usage on a power supply is bad. So if you want to run with 3amps, buy a 4 or 5amp power supply so that the power supply is not running at its maximum potential amperage. @@ -14,7 +14,7 @@ Most power supplies will have a barrel connector only rated for 3 amps on it, so The LED-1 will protect itself, but not the led strips connected to it. So if you connect a 24 volt power supply to the device, it will send 24v out to the LED strips. Make sure to pair your LEDs and Power supplies with the same voltage! -##### LED Strips +## LED Strips * WS2812B which are 5V RGB LED strips. * SK6812 which are 5V RGBW LED strips. @@ -24,13 +24,13 @@ Most power supplies will have a barrel connector only rated for 3 amps on it, so We suggest buying only BTF Lighting off of amazon or directly from us (we source only BTF Lighting). They also have an Aliexpress store! -##### LED Connectors +## LED Connectors JST-SM 3 pin connectors are helpful to connect multiple led strips or to solder them onto led strips to create multiple smaller sections. These have a maximum rating of 3 amps. 10mm Width Transparent Connector Kit You might want to use these 24v FCOB connectors for the WS2814 LEDs suggested above. Make sure to choose the same width of led strip + connector (10mm, 12mm, etc). -##### Additional Tools +## Additional Tools Wago Connectors are a great option for connecting wires together without soldering. diff --git a/docs/products/m1/addons/adding-microphone-to-m-1.md b/docs/products/m1/addons/adding-microphone-to-m-1.md index 825008eb90..e84bdbe8d1 100755 --- a/docs/products/m1/addons/adding-microphone-to-m-1.md +++ b/docs/products/m1/addons/adding-microphone-to-m-1.md @@ -6,7 +6,7 @@ This will guide you through installing and configuring the microphone on your M- The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have the connector for it. The revision is printed on the controller board. -###### Install the Hardware +## Install the Hardware 1\. Unplug your M-1 from power and set the matrix side face down with the M-1 Controller PCB facing you. @@ -14,7 +14,7 @@ The microphone addon fits Rev6 and newer controllers. Rev4 boards do not have th  -###### Turn It On +## Turn It On === "WLED" diff --git a/docs/products/m1/addons/wizmote-remote.md b/docs/products/m1/addons/wizmote-remote.md index a88be44d48..6e9ea56402 100644 --- a/docs/products/m1/addons/wizmote-remote.md +++ b/docs/products/m1/addons/wizmote-remote.md @@ -10,7 +10,7 @@ The M-1 has no IR receiver, but it does take a WLED ESP-NOW documentation covers the button codes if you want something other than the defaults. -###### Troubleshooting +## Troubleshooting If nothing shows up in **Last device seen**, start with a fresh battery in the WizMote and confirm you saved the page after ticking **Enable ESP-NOW**. When the field stays blank after that, reboot the M-1 and press a button on the remote again. diff --git a/docs/products/m1/choose-your-firmware.md b/docs/products/m1/choose-your-firmware.md index c55a26963c..c519c8cd58 100644 --- a/docs/products/m1/choose-your-firmware.md +++ b/docs/products/m1/choose-your-firmware.md @@ -6,7 +6,7 @@ description: Find out which firmware your M-1 runs and what each one gives you. Most M-1 pages on this wiki have a **WLED** and a **WLED-MM** tab. Pick your firmware once and the rest of the wiki follows it, so this page is only here to help you work out which one you have. -#### Which One Do I Have? +## Which One Do I Have? Open your M-1 in a browser and tap **Info**. The version is at the top. diff --git a/docs/products/m1/examples/share-data-from-home-assistant.md b/docs/products/m1/examples/share-data-from-home-assistant.md index 24b1711492..abcecc77ed 100755 --- a/docs/products/m1/examples/share-data-from-home-assistant.md +++ b/docs/products/m1/examples/share-data-from-home-assistant.md @@ -52,7 +52,7 @@ Here is the finished board on a two panel setup, four segments each pulling a di  -###### Tuning It +## Tuning It A minute suits temperatures and forecasts. For something that changes faster, like a countdown timer, drop the time pattern to every ten or thirty seconds. Going much below that gains you little, since the text has to finish scrolling before anyone can read it anyway. diff --git a/docs/products/m1/setup/getting-started-m1-esphome.md b/docs/products/m1/setup/getting-started-m1-esphome.md index a46ccc56b4..a1b9eb0da5 100644 --- a/docs/products/m1/setup/getting-started-m1-esphome.md +++ b/docs/products/m1/setup/getting-started-m1-esphome.md @@ -10,13 +10,13 @@ description: Getting started with your new M-1 running the hub75-studio ESPHome This guide walks you through replacing the stock WLED firmware with [hub75-studio](https://github.com/pavlov-net/hub75-studio), an ESPHome firmware tailored for the M-1, and getting it onto your home network and into Home Assistant. -### Attach M-1 LED Controller +## Attach M-1 LED Controller Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damage in shipping. Gently attach the controller to the back of the M-1 LED Matrix panel as shown in the GIF below.  -### Flash the firmware +## Flash the firmware !!! success "Use the Rev6 build unless you have an older M-1 Controller!" @@ -34,7 +34,7 @@ Once the firmware finishes installing, the panel displays the **M-1 BIOS** splas  -### Connect to Wi-Fi +## Connect to Wi-Fi 1\. On your phone, open Wi-Fi settings and join the network **apollo-m1-r6-XXXXXX**, where the last 6 characters match the MAC suffix shown on the BIOS screen. @@ -46,7 +46,7 @@ Once the firmware finishes installing, the panel displays the **M-1 BIOS** splas  -### Join to Home Assistant +## Join to Home Assistant !!! tip "Your device should be auto-discovered by Home Assistant using the ESPHome Integration as shown below!" @@ -58,9 +58,9 @@ Head to the Media Proxy app allows you to view gifs, still images, YouTube videos, and even use Sendspin with album art when using Music Assistant! @@ -120,7 +120,7 @@ The WiZ WizMote remote, so you can change pages, dim the panel, and toggle it on/off without your phone. diff --git a/docs/products/m1/setup/getting-started-m1.md b/docs/products/m1/setup/getting-started-m1.md index 403bd95737..8cda38bb86 100644 --- a/docs/products/m1/setup/getting-started-m1.md +++ b/docs/products/m1/setup/getting-started-m1.md @@ -8,13 +8,13 @@ Congrats on your new M-1! Pick your firmware below and the rest of the M-1 wiki New units ship with **WLED**. Units shipped earlier came with **WLED-MM**. Open your M-1 in a browser and tap **Info** to see which you have: 16.0.1 or newer is WLED, 14.5.1 is WLED-MM. Running ESPHome instead? Head to [Set Up ESPHome](/products/m1/setup/getting-started-m1-esphome.md). -### Attach M-1 LED Controller +## Attach M-1 LED Controller Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damage in shipping. Gently attach the M-1 controller by lining up its power and data headers to the back of the LED Matrix panel as shown below.  -### Connect to Wi-Fi +## Connect to Wi-Fi === "WLED" @@ -88,7 +88,7 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag  -### Join to Home Assistant +## Join to Home Assistant === "WLED" @@ -126,7 +126,7 @@ Your M-1 LED Matrix and M-1 controller were shipped separately to minimize damag  -#### What Next +### What Next === "WLED" diff --git a/docs/products/m1/setup/m1-matrix-settings.md b/docs/products/m1/setup/m1-matrix-settings.md index 60f1053090..25899a24b9 100755 --- a/docs/products/m1/setup/m1-matrix-settings.md +++ b/docs/products/m1/setup/m1-matrix-settings.md @@ -7,13 +7,13 @@ description: >- These are the settings that make the HUB75 panel display correctly. You need them if you reflashed your M-1, wiped its settings, or changed the number of panels. Units that ship on WLED arrive already configured for one 64x64 panel. -###### Friendly Name +## Friendly Name Click on **Config**, then **User Interface**. In the **Server description** field, enter the name you want your M-1 device to display as in the WLED interface, such as **Apollo LED Matrix**. It ships as **Apollo M-1**, so this is only worth changing if you want something else.  -###### Hostname +## Hostname Your M-1 already has one. It ships as **apollo-led-matrix-xxxxxx**, with the last six characters unique to your unit, so several M-1s can sit on the same network without clashing. @@ -49,7 +49,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address** * Hostnames are **not case sensitive** (`HostName` = `hostname`). -###### LED Settings +## LED Settings === "WLED" @@ -77,7 +77,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**  -###### 2D Settings +## 2D Settings === "WLED" @@ -93,7 +93,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**  -###### AudioReactive Settings +## AudioReactive Settings !!! success "The Audioreactive is only available on a rev6 PCB with the optional microphone addon" diff --git a/docs/products/m1/setup/m1-multiple-panels.md b/docs/products/m1/setup/m1-multiple-panels.md index e8d83cda5d..c05edcef9d 100755 --- a/docs/products/m1/setup/m1-multiple-panels.md +++ b/docs/products/m1/setup/m1-multiple-panels.md @@ -10,11 +10,11 @@ description: Tutorial for wiring and configuring multiple panels with your M-1 L Using panels you sourced yourself rather than Apollo ones? They need to match the M-1's own: **64x64 half scan**, sometimes written 1/32. Indoor P2.5 and P3 64x64 panels usually qualify. Quarter-scan panels, often sold as outdoor, do not work. -###### Power +## Power A 64x64 panel can pull about 3A at 5V at full white. The M-1's onboard 5V rail passes roughly 3A, which is one panel's worth, so every panel beyond the first needs its own feed from a Matrix Power Module. Skipping it gives you dim output, color shifts, and random reboots on bright content. -###### Hardware Setup +## Hardware Setup Wiring is the same whichever firmware you run. Choose the number of panels you are using below to get started! @@ -78,7 +78,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a A 3D printable wall mount system is available on Printables. -###### Software Setup +## Software Setup === "WLED" @@ -174,7 +174,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a  -###### Segment Setup +## Segment Setup !!! success "WLED works using segments and your device now has different stop and end pixels for each segment since you have added more LEDs with each additional panel" @@ -308,7 +308,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke 5\. Save the layout as a preset, or it disappears on the next reboot. -###### What to Expect +## What to Expect Driving four panels asks a lot more of the controller than one, and a few things change that are worth knowing before you decide something is broken. @@ -318,7 +318,7 @@ The LED memory gauge on the LED Preferences page reads high with four panels. Th Ghosting shows up more readily. Four chained panels load the drive lines harder than one, so faint red fringing behind bright content or at a seam appears at a lower brightness than you are used to. It is harmless. Drop the global brightness a step if it bothers you. -###### Going Bigger Than Four Panels +## Going Bigger Than Four Panels Four panels per M-1 is the limit, in any arrangement that multiplies to four or fewer. That is a real constraint rather than an artificial cap: the display driver keeps its frame buffer in the fastest part of the chip's memory and four panels already fill most of it, the panel hardware refreshes more slowly as the chain grows, and eight panels of bright content would need something like a 25 amp supply. diff --git a/docs/products/m1/setup/m1-wall-mounting.md b/docs/products/m1/setup/m1-wall-mounting.md index e17492dc9e..0923a60a4a 100644 --- a/docs/products/m1/setup/m1-wall-mounting.md +++ b/docs/products/m1/setup/m1-wall-mounting.md @@ -12,7 +12,7 @@ Download the files from the These cheap ones off Amazon work great. @@ -37,7 +37,7 @@ Make sure to use M3 8mm screws. 2 To MSR-1 diff --git a/docs/products/msr1/examples/msr-1-automation-guide.md b/docs/products/msr1/examples/msr-1-automation-guide.md index 1edb86c5ab..b08e40cec2 100755 --- a/docs/products/msr1/examples/msr-1-automation-guide.md +++ b/docs/products/msr1/examples/msr-1-automation-guide.md @@ -1,4 +1,5 @@ --- +title: MSR-1 Automation Guide description: "A walkthrough of building Home Assistant automations around the MSR-1." --- # MSR-1 Automation Guide diff --git a/docs/products/msr1/examples/msr-1-examples-from-github.md b/docs/products/msr1/examples/msr-1-examples-from-github.md index 91a4f28f62..999250c903 100755 --- a/docs/products/msr1/examples/msr-1-examples-from-github.md +++ b/docs/products/msr1/examples/msr-1-examples-from-github.md @@ -1,6 +1,7 @@ --- +title: MSR-1 Examples From GitHub description: "Example MSR-1 configurations and automations published in the Apollo GitHub repository." --- # MSR-1 Examples From GitHub -#### [https://github.com/ApolloAutomation/MSR-1/tree/main/Examples](https://github.com/ApolloAutomation/MSR-1/tree/main/Examples) \ No newline at end of file +## [https://github.com/ApolloAutomation/MSR-1/tree/main/Examples](https://github.com/ApolloAutomation/MSR-1/tree/main/Examples) \ No newline at end of file diff --git a/docs/products/msr1/examples/msr1-alarmo.md b/docs/products/msr1/examples/msr1-alarmo.md index f8e8dd05d0..bad5916018 100755 --- a/docs/products/msr1/examples/msr1-alarmo.md +++ b/docs/products/msr1/examples/msr1-alarmo.md @@ -1,4 +1,5 @@ --- +title: MSR-1 + Alarmo Home Security Install description: "Build a home security system from three MSR-1 sensors and Alarmo in Home Assistant, installed through HACS." --- # MSR-1 + Alarmo Home Security Install diff --git a/docs/products/msr1/examples/msr1-dashboards.md b/docs/products/msr1/examples/msr1-dashboards.md index 4254c0855f..767296005d 100755 --- a/docs/products/msr1/examples/msr1-dashboards.md +++ b/docs/products/msr1/examples/msr1-dashboards.md @@ -1,4 +1,5 @@ --- +title: MSR-1 Home Assistant Dashboard Examples description: "Example Home Assistant dashboard cards for the MSR-1, including an ApexCharts scatter plot of radar detection distance you can copy and paste." --- # MSR-1 Home Assistant Dashboard Examples diff --git a/docs/products/msr1/examples/using-msr-1-buzzer.md b/docs/products/msr1/examples/using-msr-1-buzzer.md index 063e1a430c..907853a848 100755 --- a/docs/products/msr1/examples/using-msr-1-buzzer.md +++ b/docs/products/msr1/examples/using-msr-1-buzzer.md @@ -1,4 +1,5 @@ --- +title: Using MSR-1 Buzzer description: "Trigger the MSR-1 buzzer from Home Assistant developer tools, then reuse the same call in an automation." --- # Using MSR-1 Buzzer diff --git a/docs/products/msr1/faq.md b/docs/products/msr1/faq.md index d33f9aea2f..cb3760bc7e 100755 --- a/docs/products/msr1/faq.md +++ b/docs/products/msr1/faq.md @@ -1,4 +1,5 @@ --- +title: FAQ description: "Common MSR-1 questions answered: which sensors are inside, what the mmWave radar detects, and how the device talks to Home Assistant." --- 1\. **What sensors are included in the MSR-1?** diff --git a/docs/products/msr1/introduction.md b/docs/products/msr1/introduction.md index da1e7c447e..27f146f0e7 100755 --- a/docs/products/msr1/introduction.md +++ b/docs/products/msr1/introduction.md @@ -1,4 +1,5 @@ --- +title: Introduction description: "The Apollo MSR-1 multisensor: mmWave radar, LUX and UV, temperature, humidity, and optional CO2, running ESPHome for Home Assistant." ---  diff --git a/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md b/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md index 94bbb7de06..9317053bf7 100755 --- a/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md @@ -1,7 +1,8 @@ --- +title: BeardedTinker MSR-1 Review description: "BeardedTinker's video review of the Apollo MSR-1." --- # BeardedTinker MSR-1 Review -##### BeardedTinker YouTube Video review - MSR-1 +## BeardedTinker YouTube Video review - MSR-1 diff --git a/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md b/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md index b01b89e93b..efbbaad4f5 100755 --- a/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/drzzs-msr-1-review.md @@ -1,9 +1,10 @@ --- +title: DrZzs MSR-1 Review description: "The DrZzs review of the Apollo MSR-1, starting at 19:53 in the stream." --- # DrZzs MSR-1 Review -##### +## diff --git a/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md b/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md index 2bacf1201c..bcfda6a39f 100755 --- a/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/make-it-work-tech-msr-1-review.md @@ -1,11 +1,12 @@ --- +title: Make It Work Tech MSR-1 Review description: "The Make It Work Tech review of the Apollo MSR-1, starting at 31:22 in the video." --- # Make It Work Tech MSR-1 Review -##### +## -##### Apollo MSR-1 Review starts at [31:22](https://www.youtube.com/watch?v=Kt1FpRM8R18&t=1882s). \ No newline at end of file +## Apollo MSR-1 Review starts at [31:22](https://www.youtube.com/watch?v=Kt1FpRM8R18&t=1882s). \ No newline at end of file diff --git a/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md b/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md index c7756232be..ea48311429 100755 --- a/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/mostlychris-msr-1-review.md @@ -1,4 +1,5 @@ --- +title: MostlyChris MSR-1 Review description: "MostlyChris reviews the Apollo MSR-1." --- # MostlyChris MSR-1 Review diff --git a/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md b/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md index 047af30665..917a23542c 100755 --- a/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/simon-says-home-assistant-msr-1-review.md @@ -1,4 +1,5 @@ --- +title: Simon Says Home Assistant MSR-1 Review description: "Simon Says Home Assistant reviews the Apollo MSR-1." --- # Simon Says Home Assistant MSR-1 Review diff --git a/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md b/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md index 70ab1157b2..6269fba402 100755 --- a/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md +++ b/docs/products/msr1/msr-1-reviews/smart-home-scene-msr-1-review.md @@ -1,6 +1,7 @@ --- +title: Smart Home Scene MSR-1 Review description: "The Smart Home Scene written review of the Apollo MSR-1." --- # Smart Home Scene MSR-1 Review -#### [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) \ No newline at end of file +## [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) \ No newline at end of file diff --git a/docs/products/msr1/msr1-reviews.md b/docs/products/msr1/msr1-reviews.md index 394e625c8d..7e607d5768 100755 --- a/docs/products/msr1/msr1-reviews.md +++ b/docs/products/msr1/msr1-reviews.md @@ -1,14 +1,15 @@ --- +title: Make It Work Tech MSR-1 Review description: "Video and written reviews of the Apollo MSR-1 from across the community." --- # [Make It Work Tech MSR-1 Review](https://youtu.be/Kt1FpRM8R18?si=GgMGCjpbSwpSqIsr) -# [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) +## [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/) -# [DrZzs MSR-1 Review](https://www.youtube.com/live/YGNCw1nFwjg?si=gmdQTtnY2XdzVHV3) +## [DrZzs MSR-1 Review](https://www.youtube.com/live/YGNCw1nFwjg?si=gmdQTtnY2XdzVHV3) -# [BeardedTinker MSR-1 Review](https://youtu.be/vz1oWhPoIwA?si=Gk8p8S_LUIsMC7D-) +## [BeardedTinker MSR-1 Review](https://youtu.be/vz1oWhPoIwA?si=Gk8p8S_LUIsMC7D-) -# [Simon Says Home Assistant MSR-1 Review](https://youtu.be/M-HAuPH9KOk?si=Fy7RkfsOJdjaodkr) +## [Simon Says Home Assistant MSR-1 Review](https://youtu.be/M-HAuPH9KOk?si=Fy7RkfsOJdjaodkr) -# [MostlyChris MSR-1 Review](https://youtu.be/u8q3lMIkolc?si=aWrkRHIru_eOY1jw) \ No newline at end of file +## [MostlyChris MSR-1 Review](https://youtu.be/u8q3lMIkolc?si=aWrkRHIru_eOY1jw) \ No newline at end of file diff --git a/docs/products/msr1/setup/co2-calibration-for-msr-1.md b/docs/products/msr1/setup/co2-calibration-for-msr-1.md index e2f786007f..46ac167148 100755 --- a/docs/products/msr1/setup/co2-calibration-for-msr-1.md +++ b/docs/products/msr1/setup/co2-calibration-for-msr-1.md @@ -1,6 +1,7 @@ --- +title: CO2 Calibration For MSR-1 description: "CO2 calibration for the MSR-1, covered by the general calibration guide." --- # CO2 Calibration For MSR-1 -##### Please refer to the [General CO2 Calibration](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/) article \ No newline at end of file +## Please refer to the [General CO2 Calibration](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/) article \ No newline at end of file diff --git a/docs/products/msr1/setup/general-tips.md b/docs/products/msr1/setup/general-tips.md index a7a76ac2d7..0a031ed1b8 100755 --- a/docs/products/msr1/setup/general-tips.md +++ b/docs/products/msr1/setup/general-tips.md @@ -1,15 +1,16 @@ --- +title: General Tips description: "Placement and mounting tips for the MSR-1, including keeping the light sensor holes clear and stopping the RGB LED from skewing LUX readings." --- # General Tips -##### **MSR-1** +## **MSR-1**  Picture from Smart Home Scene -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -19,7 +20,7 @@ When mounting the MSR-1 be sure to position the device so that the two large hol 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** +## **Mounting** The MSR-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120-degree FOV of the mmWave radar. @@ -29,7 +30,7 @@ The MSR-1 should be mounted 1.5-2 meters off the ground which will then provide The MSR-1 can also be mounted on the ceiling if you can provide power and mount our articulating stand on the ceiling. -##### **Gate and FOV Visualization** +## **Gate and FOV Visualization** **** diff --git a/docs/products/msr1/setup/mmwave-videos.md b/docs/products/msr1/setup/mmwave-videos.md index 873d3e483e..9c7703ff14 100644 --- a/docs/products/msr1/setup/mmwave-videos.md +++ b/docs/products/msr1/setup/mmwave-videos.md @@ -1,4 +1,5 @@ --- +title: mmWave Tuning Videos description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2!" --- --8<-- "products/general/calibrating-and-updating/mmwave-videos.md:5:" diff --git a/docs/products/msr1/setup/updating-msr-1-firmware.md b/docs/products/msr1/setup/updating-msr-1-firmware.md index 9c4ec26938..2f9485b6be 100755 --- a/docs/products/msr1/setup/updating-msr-1-firmware.md +++ b/docs/products/msr1/setup/updating-msr-1-firmware.md @@ -1,6 +1,7 @@ --- +title: Updating MSR-1 Firmware description: "Updating MSR-1 firmware, covered by the general firmware update guide." --- # Updating MSR-1 Firmware -##### Please refer to the [general firmware update](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/ "Updating Firmware") article \ No newline at end of file +## Please refer to the [general firmware update](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/ "Updating Firmware") article \ No newline at end of file diff --git a/docs/products/msr1/setup/zones-ha.md b/docs/products/msr1/setup/zones-ha.md index f4c1e0ba58..226ceed6b3 100755 --- a/docs/products/msr1/setup/zones-ha.md +++ b/docs/products/msr1/setup/zones-ha.md @@ -1,4 +1,5 @@ --- +title: How To Tune mmWave Using Home Assistant description: "Tune the MSR-1 mmWave radar from Home Assistant using Radar Engineering Mode to find which gates cause false triggers and raise their thresholds." --- # How To Tune mmWave Using Home Assistant diff --git a/docs/products/msr1/setup/zones-hlk.md b/docs/products/msr1/setup/zones-hlk.md index 33053810a1..909fcaedf5 100755 --- a/docs/products/msr1/setup/zones-hlk.md +++ b/docs/products/msr1/setup/zones-hlk.md @@ -1,4 +1,5 @@ --- +title: How To Tune mmWave Using HLKRadarTool description: "Tune the MSR-1 mmWave radar over Bluetooth with the HLKRadarTool phone app, covering both auto-calibration and manual gate settings." --- # How To Tune mmWave Using HLKRadarTool diff --git a/docs/products/msr1/troubleshooting/msr1-boot-mode.md b/docs/products/msr1/troubleshooting/msr1-boot-mode.md index ddc5ca3bc8..f6e27566e8 100755 --- a/docs/products/msr1/troubleshooting/msr1-boot-mode.md +++ b/docs/products/msr1/troubleshooting/msr1-boot-mode.md @@ -1,4 +1,5 @@ --- +title: Putting The MSR-1 In Boot Mode description: "Put the MSR-1 into boot mode using the boot button, which is needed before reflashing its firmware." --- # Putting The MSR-1 In Boot Mode @@ -7,7 +8,7 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the MSR-1 as shown in the image below and locate the small opening to press the boot button (the right button). @@ -17,7 +18,7 @@ description: "Put the MSR-1 into boot mode using the boot button, which is neede 3\. Continue with uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/msr1/troubleshooting/msr1-code.md b/docs/products/msr1/troubleshooting/msr1-code.md index 7b35cd12a1..20ad00bd2c 100755 --- a/docs/products/msr1/troubleshooting/msr1-code.md +++ b/docs/products/msr1/troubleshooting/msr1-code.md @@ -1,4 +1,5 @@ --- +title: Factory Re-Flash MSR-1 description: "Reflash the MSR-1 back to factory firmware from a Chromium based browser when it stops responding." --- # Factory Re-Flash MSR-1 diff --git a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md index c9876d8829..2f3d03f6a1 100755 --- a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md +++ b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md @@ -1,4 +1,5 @@ --- +title: Reset Wi-Fi Credentials description: "Reset the MSR-1 Wi-Fi credentials with a 10 second press of the Boot button, then reconnect through its hotspot." --- # Reset Wi-Fi Credentials diff --git a/docs/products/msr1/troubleshooting/msr1-teardown.md b/docs/products/msr1/troubleshooting/msr1-teardown.md index 1ae2408de1..39d115ecb2 100755 --- a/docs/products/msr1/troubleshooting/msr1-teardown.md +++ b/docs/products/msr1/troubleshooting/msr1-teardown.md @@ -1,4 +1,5 @@ --- +title: Teardown and Reassembly Of MSR-1 description: "Video walkthrough of taking an MSR-1 apart." --- \ No newline at end of file diff --git a/docs/products/msr2/msr2-reviews.md b/docs/products/msr2/msr2-reviews.md index 7d6ded79ba..5ba7fce8e2 100755 --- a/docs/products/msr2/msr2-reviews.md +++ b/docs/products/msr2/msr2-reviews.md @@ -4,12 +4,12 @@ description: YouTuber reviews and feedback about the MSR-2 sensor from Apollo Au --- # [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/) +## [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) +## [Home Tech Innovations MSR-2 Review](https://www.youtube.com/watch?v=K3j2rR2dsY0) -# [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ) +## [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ) -# [Smart Home Australia MSR-2 Review](https://www.youtube.com/watch?v=EzVyzFwdgN4) +## [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 +## [Michael Leen MSR-2 Review](https://www.youtube.com/watch?v=VdVR8Gs002Q) \ No newline at end of file diff --git a/docs/products/msr2/setup/mmwave-videos.md b/docs/products/msr2/setup/mmwave-videos.md index 873d3e483e..9c7703ff14 100644 --- a/docs/products/msr2/setup/mmwave-videos.md +++ b/docs/products/msr2/setup/mmwave-videos.md @@ -1,4 +1,5 @@ --- +title: mmWave Tuning Videos description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2!" --- --8<-- "products/general/calibrating-and-updating/mmwave-videos.md:5:" diff --git a/docs/products/msr2/setup/msr2-general-tips.md b/docs/products/msr2/setup/msr2-general-tips.md index 92aa8740d2..fc35b509e7 100755 --- a/docs/products/msr2/setup/msr2-general-tips.md +++ b/docs/products/msr2/setup/msr2-general-tips.md @@ -4,7 +4,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi --- # General Tips -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -14,7 +14,7 @@ When mounting the MSR-2 be sure to position the device so that the two large hol 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** +## **Mounting** The MSR-2 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120-degree FOV of the mmWave radar. @@ -30,7 +30,7 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount * 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** +## **Gate and FOV Visualization** **** diff --git a/docs/products/msr2/setup/zones-hlk.md b/docs/products/msr2/setup/zones-hlk.md index 12201270e7..eab46fe25a 100755 --- a/docs/products/msr2/setup/zones-hlk.md +++ b/docs/products/msr2/setup/zones-hlk.md @@ -4,7 +4,7 @@ description: Tutorial for MSR-2 HLKRadarTool app Zone Configuration. --- # How To Tune MSR-2 Using HLKRadarTool -###### **Auto-Calibration** +## **Auto-Calibration** 1\. Download the HLKRadarTool app. @@ -56,7 +56,7 @@ The default password to connect to the HLKRadarTool is "HiLink". **** -###### Manual Calibration +## Manual Calibration 1\. Repeat steps 1-5 above. diff --git a/docs/products/msr2/troubleshooting/msr2-boot-mode.md b/docs/products/msr2/troubleshooting/msr2-boot-mode.md index b4dc6bb4e5..f876bd6a41 100755 --- a/docs/products/msr2/troubleshooting/msr2-boot-mode.md +++ b/docs/products/msr2/troubleshooting/msr2-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The MSR-2 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## 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). @@ -18,7 +18,7 @@ description: Step by step guide for putting The MSR-2 In Boot Mode. 3\. Continue with uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/mtr1/mtr1-reviews.md b/docs/products/mtr1/mtr1-reviews.md index 9ecbdcaaa6..8b8a119fac 100755 --- a/docs/products/mtr1/mtr1-reviews.md +++ b/docs/products/mtr1/mtr1-reviews.md @@ -5,10 +5,10 @@ description: YouTuber reviews and feedback about the MTR-1 sensor from Apollo Au # [Home Tech Innovations MTR-1 Review](https://youtu.be/q5GejbxnByA?si=PMgK4ro6U8Q7idCm) -# [Simon Says Home Assistant MTR-1 Review](https://www.youtube.com/watch?v=FFN-vIkDRLk) +## [Simon Says Home Assistant MTR-1 Review](https://www.youtube.com/watch?v=FFN-vIkDRLk) -# [Smart Home Australia MTR-1 Review](https://www.youtube.com/watch?v=xyxgk7WGHCY) +## [Smart Home Australia MTR-1 Review](https://www.youtube.com/watch?v=xyxgk7WGHCY) -# [Smart Home Scene MTR-1 Review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) +## [Smart Home Scene MTR-1 Review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) -# [Michael Leen MTR-1 Review](https://www.youtube.com/watch?v=7qFvqRw1uds) \ No newline at end of file +## [Michael Leen MTR-1 Review](https://www.youtube.com/watch?v=7qFvqRw1uds) \ No newline at end of file diff --git a/docs/products/mtr1/setup/general-tips.md b/docs/products/mtr1/setup/general-tips.md index 297edbce26..51290b8977 100755 --- a/docs/products/mtr1/setup/general-tips.md +++ b/docs/products/mtr1/setup/general-tips.md @@ -4,11 +4,11 @@ description: Multiple helpful images for mounting, lux/rgb, and zone visualizati --- # General Tips -##### **MTR-1 PCB with Sensors** +## **MTR-1 PCB with Sensors**  -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -16,27 +16,27 @@ When mounting the MTR-1 be sure to position the device so that the large hole at The onboard RGB LED will trigger the light sensor. Be cognizant of this when making automations based on light/LUX. -##### **Mounting** +## **Mounting**  -##### **LD2450 Performance and Electrical Parameters** +## **LD2450 Performance and Electrical Parameters** -##### [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf) +## [**LD2450 Datasheet**](https://www.tinytronics.nl/index.php?route=product/product/get_file&file=6000/HLK-LD2450-Instruction-Manual.pdf)  -##### **Expanding Horizontal Distance as Target Moves Further Away** +## **Expanding Horizontal Distance as Target Moves Further Away** The detection is 60 degrees from center on each side. So it is a cone when you are close to it but at 4 feet away to the side you might not be visible. If you are further from the wall it can detect further in a horizontal distance.  -##### **Increased ESP Temperature** +## **Increased ESP Temperature** If you are experiencing higher than normal ESP temperatures ~140+ degrees F then changing the Wi-Fi power save mode option might help decrease the temperature. Here is the link to the ESPHome WiFi Component [Power Save Mode](https://esphome.io/components/wifi.html#power-save-mode). -##### **Improve Wi-Fi Connection** +## **Improve Wi-Fi Connection** The Wi-Fi interface of all ESP32 devices offers three power save modes to reduce the amount of power spent on Wi-Fi. While some options can reduce the power usage of the ESP, they generally also decrease the reliability of the Wi-Fi connection, with frequent disconnections from the router in the highest power saving mode. Switch to "none" to get the best Wi-Fi performance! diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md index f0d89d1e78..5f9efd9e04 100755 --- a/docs/products/mtr1/setup/zones-hlk.md +++ b/docs/products/mtr1/setup/zones-hlk.md @@ -4,7 +4,7 @@ description: Tutorial for MTR-1 HLKRadarTool app Zone Configuration. --- -###### Configure Zones +## Configure Zones !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -64,7 +64,7 @@ The uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/new-product-template/setup/productname-general-tips.md b/docs/products/new-product-template/setup/productname-general-tips.md index d91c021636..57e68a472a 100755 --- a/docs/products/new-product-template/setup/productname-general-tips.md +++ b/docs/products/new-product-template/setup/productname-general-tips.md @@ -6,10 +6,10 @@ description: >- --- # General Tips -###### Fluid Sensor +## Fluid Sensor The fluid level sensor should be securely taped or mounted flat against the surface of your chosen water reservoir. The fluid sensor is rated to go through up to 5mm of plastic but could possibly go further. -###### Pump Control +## Pump Control There is a disabled entity by default called **Pump Control** which will just turn the pump on or off and run it instead of using the **Run Pump** entity. The **Pump Control** entity will ignore the **Pump Run Seconds** however this entity is still affected by the **Max Safe Run Time**. For example, if **Max Safe Run Time** is set to 120 seconds, then when you turn on the **Pump Control** entity, it will run for 120 seconds and then turn off unless you manually turn it off sooner. \ No newline at end of file diff --git a/docs/products/new-product-template/troubleshooting/productname-boot-mode.md b/docs/products/new-product-template/troubleshooting/productname-boot-mode.md index 7dc1b3ddd3..f46c35b72f 100755 --- a/docs/products/new-product-template/troubleshooting/productname-boot-mode.md +++ b/docs/products/new-product-template/troubleshooting/productname-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only !!! danger "Empty the water reservoir and make sure no water is present in the tubes" @@ -26,7 +26,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. [Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/pump1/troubleshooting/pump1-reflash/){ .md-button .md-button--primary } -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your PUMP-1. With the device facing you, locate the reset (left) and boot (right) buttons. diff --git a/docs/products/new-product-template/troubleshooting/productname-teardown.md b/docs/products/new-product-template/troubleshooting/productname-teardown.md index a30a77f0f8..d4f0bfc131 100755 --- a/docs/products/new-product-template/troubleshooting/productname-teardown.md +++ b/docs/products/new-product-template/troubleshooting/productname-teardown.md @@ -6,7 +6,7 @@ description: >- --- # Teardown and Reassembly Of PUMP-1 -###### Disassembly +## Disassembly !!! danger "Drain all liquid from the PUMP-1 before disassembling!" @@ -24,7 +24,7 @@ description: >-  -###### Reassembly +## Reassembly 1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1. diff --git a/docs/products/plt1/examples/blueprint.md b/docs/products/plt1/examples/blueprint.md index 8959f2d99a..55195553b2 100644 --- a/docs/products/plt1/examples/blueprint.md +++ b/docs/products/plt1/examples/blueprint.md @@ -6,7 +6,7 @@ description: >- --- # Blueprint Setup -### Automatic Import +## Automatic Import 1\. Click the Import Blueprint button below and then click **Open link**. @@ -37,7 +37,7 @@ description: >- 7\. Click **Save**. Your blueprint is now live and will send push notifications whenever your plant needs attention! -### Manual Import +## Manual Import 1\. Head to the automations page and click on **Blueprints** in the top right then select **Import Blueprint**. diff --git a/docs/products/plt1/general-tips.md b/docs/products/plt1/general-tips.md index 290d345d74..27a51d468b 100755 --- a/docs/products/plt1/general-tips.md +++ b/docs/products/plt1/general-tips.md @@ -4,7 +4,7 @@ description: Helpful tips to get the most use out of your sensor. --- # General Tips -###### LTR390 UV +## LTR390 UV For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. diff --git a/docs/products/plt1/reviews.md b/docs/products/plt1/reviews.md index bc5670e645..b07eb2d6ba 100755 --- a/docs/products/plt1/reviews.md +++ b/docs/products/plt1/reviews.md @@ -8,22 +8,22 @@ description: YouTuber reviews and feedback about the PLT-1 sensor from Apollo Au -# [Michael Leen PLT-1 Review](https://youtu.be/tSYUJESNyFM?si=9k0OBns9XvNzYjyz) +## [Michael Leen PLT-1 Review](https://youtu.be/tSYUJESNyFM?si=9k0OBns9XvNzYjyz) -# [Mostly Chris PLT-1 Review](https://youtu.be/9TtLOLbf9zI?si=0wRhrtZ8f9KXqAhB) +## [Mostly Chris PLT-1 Review](https://youtu.be/9TtLOLbf9zI?si=0wRhrtZ8f9KXqAhB) -# Bearded Tinker PLT-1 Review +## Bearded Tinker PLT-1 Review -# Hands On Katie PLT-1 Review +## Hands On Katie PLT-1 Review -# Smart Home Scene PLT-1 Review +## Smart Home Scene PLT-1 Review -# Smart Home Australia PLT-1 Review \ No newline at end of file +## Smart Home Australia PLT-1 Review \ No newline at end of file diff --git a/docs/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/products/plt1/troubleshooting/plt1-boot-mode.md index 1fa4b8fde6..7cfc9fc9fa 100755 --- a/docs/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/products/plt1/troubleshooting/plt1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the PLT-1 as shown in the image below and locate the small opening to press the boot button. @@ -18,7 +18,7 @@ description: Step by step guide for putting The PLT-1 In Boot Mode. 3\. Continue with uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and locate the boot and reset buttons as shown in the image above. diff --git a/docs/products/plt1b/battery-sensors/awake-ha-helper.md b/docs/products/plt1b/battery-sensors/awake-ha-helper.md index b4be1fbaed..4b683b4871 100644 --- a/docs/products/plt1b/battery-sensors/awake-ha-helper.md +++ b/docs/products/plt1b/battery-sensors/awake-ha-helper.md @@ -1,4 +1,5 @@ --- +title: Keep Your Sensor Awake With HA Helper description: "How to keep your sensor awake using the Home Assistant Helper." --- --8<-- "products/general/battery-sensors/awake-ha-helper.md:5:" diff --git a/docs/products/plt1b/battery-sensors/sensor-connection-check.md b/docs/products/plt1b/battery-sensors/sensor-connection-check.md index 4c138fe50e..dc0b58396d 100644 --- a/docs/products/plt1b/battery-sensors/sensor-connection-check.md +++ b/docs/products/plt1b/battery-sensors/sensor-connection-check.md @@ -1,4 +1,5 @@ --- +title: Sensor Connection Check description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." --- --8<-- "products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md b/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/plt1b/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/plt1b/examples/flower-card.md b/docs/products/plt1b/examples/flower-card.md index 0f6385fb3e..b9b4204653 100644 --- a/docs/products/plt1b/examples/flower-card.md +++ b/docs/products/plt1b/examples/flower-card.md @@ -1,4 +1,5 @@ --- +title: Flower Card description: "This suggests using the Flower Card inside Home Assistant for your device!" --- --8<-- "products/plt1/examples/flower-card.md:5:" diff --git a/docs/products/plt1b/general-tips.md b/docs/products/plt1b/general-tips.md index a569e1de74..7e460a7683 100755 --- a/docs/products/plt1b/general-tips.md +++ b/docs/products/plt1b/general-tips.md @@ -4,7 +4,7 @@ description: Helpful tips to get the most use out of your sensor. --- # General Tips -###### LTR390 UV +## LTR390 UV For the most accurate UV and LUX readings, be sure to expose the sensor circled in the image below to light. diff --git a/docs/products/plt1b/reviews.md b/docs/products/plt1b/reviews.md index 6f242e2559..a6fbeb2c0b 100644 --- a/docs/products/plt1b/reviews.md +++ b/docs/products/plt1b/reviews.md @@ -1,4 +1,5 @@ --- +title: Reviews description: "YouTuber reviews and feedback about the PLT-1 sensor from Apollo Automation." --- --8<-- "products/plt1/reviews.md:5:" diff --git a/docs/products/plt1b/setup/getting-started-plt1.md b/docs/products/plt1b/setup/getting-started-plt1.md index 3bf2f82d6e..4fd0d4228d 100644 --- a/docs/products/plt1b/setup/getting-started-plt1.md +++ b/docs/products/plt1b/setup/getting-started-plt1.md @@ -1,4 +1,5 @@ --- +title: Getting Started description: "Generic getting started article." --- --8<-- "products/general/setup/getting-started.md:5:" diff --git a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md index 25ceb70bf1..90fd3d95a6 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -10,7 +10,7 @@ description: Step by step guide for putting The PLT-1B In Boot Mode.  -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. @@ -22,7 +22,7 @@ description: Step by step guide for putting The PLT-1B In Boot Mode. 3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-code/) -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Plug in the device diff --git a/docs/products/plt1b/troubleshooting/plt1b-code.md b/docs/products/plt1b/troubleshooting/plt1b-code.md index 67c3a789ff..d2a751e2b1 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/products/plt1b/troubleshooting/plt1b-code.md @@ -32,7 +32,7 @@ If no device shows, click cancel and then install the recommended driver that sh 6\. Please proceed to the getting started guide and set up your sensor as a new device! -# Factory Re-Flash PLT-1B +## Factory Re-Flash PLT-1B !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the below guide." diff --git a/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md b/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md index 3067fd7ebe..1e383e9806 100755 --- a/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md +++ b/docs/products/pump1/addons/attaching-fluid-level-sensors-pump-1.md @@ -4,7 +4,7 @@ description: Tutorial for Attaching The Input and Output Fluid Level Sensors to --- # Attaching Fluid Level Sensors to the PUMP-1 -##### Installing Fluid Input Sensor +## Installing Fluid Input Sensor 1\. Begin by placing the small white connector through the hole in the base of the water bottle and gently press the input fluid level sensor into place. @@ -14,13 +14,13 @@ description: Tutorial for Attaching The Input and Output Fluid Level Sensors to  -##### Connecting Fluid Input Sensor +## Connecting Fluid Input Sensor 1\. Insert the small white connector into the **right-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection.  -##### Connecting Fluid Output Sensor +## Connecting Fluid Output Sensor 1\. Insert the small white connector into the **left-side port** on your PUMP-1 device. Ensure it is fully seated for proper operation. The small bump on top of the white connector must be facing **upwards** when inserting it. This ensures proper alignment and a secure connection. diff --git a/docs/products/pump1/setup/pump1-general-tips.md b/docs/products/pump1/setup/pump1-general-tips.md index 3f0b012b45..2b2f457593 100755 --- a/docs/products/pump1/setup/pump1-general-tips.md +++ b/docs/products/pump1/setup/pump1-general-tips.md @@ -6,17 +6,17 @@ description: >- --- # General Tips -###### Fluid Sensor +## Fluid Sensor The fluid level sensor is a non-contact capacitive sensor. It detects water through the wall of the container, so it should be securely taped or mounted flat against the outside surface of your chosen water reservoir. The sensor is rated to read through up to 5mm of plastic and often manages more. Do not submerge the fluid level sensor or place it inside your reservoir. It is not sealed against water, and submerging one can damage both the sensor and the PUMP-1 it is plugged into. -###### Pump Control +## Pump Control There is a disabled entity by default called **Pump Control** which will just turn the pump on or off and run it instead of using the **Run Pump** entity. The **Pump Control** entity will ignore the **Pump Run Seconds** however this entity is still affected by the **Max Safe Run Time**. For example, if **Max Safe Run Time** is set to 120 seconds, then when you turn on the **Pump Control** entity, it will run for 120 seconds and then turn off unless you manually turn it off sooner. -###### Siphon Concerns +## Siphon Concerns If you plan to use the PUMP-1 with the output reservoir positioned lower than the input reservoir, please note that a siphon-like effect can occur. In this setup, small amounts of water may continue to drip even when the pump is turned off. diff --git a/docs/products/pump1/troubleshooting/pump1-boot-mode.md b/docs/products/pump1/troubleshooting/pump1-boot-mode.md index 7dc1b3ddd3..f46c35b72f 100755 --- a/docs/products/pump1/troubleshooting/pump1-boot-mode.md +++ b/docs/products/pump1/troubleshooting/pump1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only !!! danger "Empty the water reservoir and make sure no water is present in the tubes" @@ -26,7 +26,7 @@ description: Step by step guide for putting The PUMP-1 In Boot Mode. [Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/pump1/troubleshooting/pump1-reflash/){ .md-button .md-button--primary } -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Plug in a USB cable that supports power and data into your computer and connect the other end to your PUMP-1. With the device facing you, locate the reset (left) and boot (right) buttons. diff --git a/docs/products/pump1/troubleshooting/pump1-teardown.md b/docs/products/pump1/troubleshooting/pump1-teardown.md index a30a77f0f8..d4f0bfc131 100755 --- a/docs/products/pump1/troubleshooting/pump1-teardown.md +++ b/docs/products/pump1/troubleshooting/pump1-teardown.md @@ -6,7 +6,7 @@ description: >- --- # Teardown and Reassembly Of PUMP-1 -###### Disassembly +## Disassembly !!! danger "Drain all liquid from the PUMP-1 before disassembling!" @@ -24,7 +24,7 @@ description: >-  -###### Reassembly +## Reassembly 1\. Attach the two tubes to the pump as shown below. The fluid input tube is the left tube on the same side as the USB-C port and the fluid output tube is the tube on the right on the side of the PUMP-1. diff --git a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md index d8315a76a6..86f84335ca 100755 --- a/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md +++ b/docs/products/rpro1/addons/attaching-gang-box-mount-to-r-pro-1.md @@ -4,7 +4,7 @@ description: Tutorial on adding the gang box mounts to your R PRO-1. --- # Adding Gang Box Mounts To R PRO-1 -###### Attaching Mounts +## Attaching Mounts 1\. Unplug your R PRO-1 from power and remove the back. @@ -32,7 +32,7 @@ description: Tutorial on adding the gang box mounts to your R PRO-1.  -###### Install in 1-Gang Box +## Install in 1-Gang Box 1\. Line up the holes in your 1-gang box (yours will be attached to the wall already). diff --git a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md index 0319f25329..ff52b3bcc8 100755 --- a/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md +++ b/docs/products/rpro1/addons/install-ceiling-mount-for-r-pro-1.md @@ -8,7 +8,7 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. -###### Attaching Mounts +## Attaching Mounts 1\. Unplug your R PRO-1 from power and remove the back. @@ -38,11 +38,11 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount.  -###### Cut the Ceiling Hole +## Cut the Ceiling Hole The Ceiling Mount needs a 3.5 inch (around 89mm) circular hole in the ceiling. Cut that hole before you install the mount. A [2 in. to 7 in. adjustable hole saw](https://www.homedepot.com/p/Milwaukee-2-in-to-7-in-Black-Oxide-Adjustable-Hole-Saw-Cutter-49-56-0320/205744284) set to 3.5 inches is what we used. -###### Install in Ceiling Mount +## Install in Ceiling Mount 1\. Remove the cover to expose the inside of the installed Ceiling Mount. diff --git a/docs/products/rpro1/rpro1-reviews.md b/docs/products/rpro1/rpro1-reviews.md index b1660dce05..9d6dbba611 100755 --- a/docs/products/rpro1/rpro1-reviews.md +++ b/docs/products/rpro1/rpro1-reviews.md @@ -6,8 +6,8 @@ description: YouTuber reviews and feedback about the R PRO-1 sensor from Apollo # Simon Says Home Assistant R PRO-1 Review -# [Smart Home Scene R PRO-1 Review](https://smarthomescene.com/reviews/apollo-r-pro-1-review-dual-mmwave-presence-multisensor-with-poe-support/) +## [Smart Home Scene R PRO-1 Review](https://smarthomescene.com/reviews/apollo-r-pro-1-review-dual-mmwave-presence-multisensor-with-poe-support/) -# [MostlyChris R PRO-1 Review](https://www.youtube.com/watch?v=wVgNE8UtsAM) +## [MostlyChris R PRO-1 Review](https://www.youtube.com/watch?v=wVgNE8UtsAM) -# Pete Scargill R PRO-1 Review \ No newline at end of file +## Pete Scargill R PRO-1 Review \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-general-tips.md b/docs/products/rpro1/setup/rpro1-general-tips.md index fa26dd23b8..05f240fbfa 100755 --- a/docs/products/rpro1/setup/rpro1-general-tips.md +++ b/docs/products/rpro1/setup/rpro1-general-tips.md @@ -4,7 +4,7 @@ description: Multiple helpful images for mounting, lux/rgb, and gate and zone vi --- # General Tips -##### **Light Sensor (LTR-390UV)** +## **Light Sensor (LTR-390UV)**  @@ -14,13 +14,13 @@ The R PRO-1 doesn't have any slits on the front of the case, so UV rays can't di 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. -##### **Wall Mounting** +## **Wall Mounting** The R PRO-1 should be mounted 1.5-2 meters off the ground which will then provide a nice even 120 degree FOV for the LD2450 and 150 degree FOV for the LD2412.  -##### **Ceiling Mounting** +## **Ceiling Mounting** The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the ceiling using our ceiling mount kit. @@ -48,6 +48,6 @@ The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the * The vertical FOV angle is -35 to 35 degrees - 70 degrees total. * Gates are pre-defined by the radar module and are in 0.75 meter increments. -##### **Gate Visualization** +## **Gate Visualization**  \ No newline at end of file diff --git a/docs/products/rpro1/setup/rpro1-switch-firmware.md b/docs/products/rpro1/setup/rpro1-switch-firmware.md index eeb32889c8..fe4eda823d 100755 --- a/docs/products/rpro1/setup/rpro1-switch-firmware.md +++ b/docs/products/rpro1/setup/rpro1-switch-firmware.md @@ -10,7 +10,7 @@ description: >- Your device needs to be able to connect to the internet to switch between firmware files. If you are connecting to an IoT network on a subnet/vlan unable to access github.com then this will not work. You can also manually reflash your device serially (usb) by following our flashing guide! -###### Switch to Ethernet +## Switch to Ethernet 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below your Apollo R PRO-1. @@ -28,7 +28,7 @@ description: >- 5\. Your device is now on the Ethernet firmware and is ready to configure! -###### Switch to Wi-Fi +## Switch to Wi-Fi 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below your Apollo R PRO-1. diff --git a/docs/products/rpro1/setup/zones-ha-new.md b/docs/products/rpro1/setup/zones-ha-new.md index f319fa91f0..ecb7d33ad0 100755 --- a/docs/products/rpro1/setup/zones-ha-new.md +++ b/docs/products/rpro1/setup/zones-ha-new.md @@ -12,7 +12,7 @@ description: Tutorial for R PRO-1 Home Assistant Zone Configuration. The optional LD2412 mmWave sensor allows you to have perfect still detection for one target at up to 9 meters so it's a great addition to the sensor. -###### LD2450 Configuration +## LD2450 Configuration Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to tune using the HLK Radartool App and we suggest using that to set up your LD2450 instead. @@ -40,6 +40,6 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir -###### LD2412 Configuration +## LD2412 Configuration \ No newline at end of file diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index 9da17659d1..b7619768be 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -18,7 +18,7 @@ description: Tutorial for R PRO-1 Home Assistant Zone Configuration. Manually enter in the X and Y coordinates for each zone in Home Assistant or directly from the device's webserver by visiting the IP address or hostname.local. It's much easier to tune using the HLK Radartool App and we suggest using that to set up your R PRO-1 LD2450. -###### LD2450 Configuration +## LD2450 Configuration 1\. Install [HACS](https://hacs.xyz/docs/use/). @@ -96,7 +96,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir If your zone configurations are not saved when restarting the device then try turning on the LD2450 Bluetooth for a few seconds and then turning it off again. You can also try to toggle on Multi Target Radar. This should wake up the mmWave module and retrieve your saved zones -###### LD2412 Configuration +## LD2412 Configuration 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below the Apollo R PRO-1. diff --git a/docs/products/rpro1/setup/zones-hlk.md b/docs/products/rpro1/setup/zones-hlk.md index 35eaa54038..69c66d28aa 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -6,7 +6,7 @@ description: Tutorial for R PRO-1 HLKRadarTool app Zone Configuration. -###### LD2450 Configuration +## LD2450 Configuration !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -60,7 +60,7 @@ The uploading the firmware document. -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug your R PRO-1 from power and remove the back. diff --git a/docs/products/rpro1/troubleshooting/rpro1-teardown.md b/docs/products/rpro1/troubleshooting/rpro1-teardown.md index bae62ef410..a70d5b9c04 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-teardown.md +++ b/docs/products/rpro1/troubleshooting/rpro1-teardown.md @@ -4,7 +4,7 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts, --- # Teardown and Reassembly Of R PRO-1 -###### Disassembly: +## Disassembly: 1\. Unplug your R PRO-1 from power and remove the back. @@ -22,7 +22,7 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts,  -###### Reassembly +## Reassembly 1\. Place the LD2450 on the 8 pin header. diff --git a/docs/products/temp1/battery-sensors/awake-ha-helper.md b/docs/products/temp1/battery-sensors/awake-ha-helper.md index b4be1fbaed..4b683b4871 100644 --- a/docs/products/temp1/battery-sensors/awake-ha-helper.md +++ b/docs/products/temp1/battery-sensors/awake-ha-helper.md @@ -1,4 +1,5 @@ --- +title: Keep Your Sensor Awake With HA Helper description: "How to keep your sensor awake using the Home Assistant Helper." --- --8<-- "products/general/battery-sensors/awake-ha-helper.md:5:" diff --git a/docs/products/temp1/battery-sensors/sensor-connection-check.md b/docs/products/temp1/battery-sensors/sensor-connection-check.md index 4c138fe50e..dc0b58396d 100644 --- a/docs/products/temp1/battery-sensors/sensor-connection-check.md +++ b/docs/products/temp1/battery-sensors/sensor-connection-check.md @@ -1,4 +1,5 @@ --- +title: Sensor Connection Check description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." --- --8<-- "products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md b/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/temp1/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/temp1/examples/temp1-automation-examples.md b/docs/products/temp1/examples/temp1-automation-examples.md index cb8ba5fead..1a35daa3d9 100755 --- a/docs/products/temp1/examples/temp1-automation-examples.md +++ b/docs/products/temp1/examples/temp1-automation-examples.md @@ -4,7 +4,7 @@ description: Multiple automation examples with the TEMP-1. --- # Automation Examples using a TEMP-1 -###### Freezer Temperature Probe Example +## Freezer Temperature Probe Example This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -66,7 +66,7 @@ actions: mode: single ``` -###### Food Probe Example +## Food Probe Example This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken (or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -121,7 +121,7 @@ actions: mode: single ``` -###### Cook Chicken Example +## Cook Chicken Example This will guide you through adding a button to your dashboard called "Chicken Monitor" and an automation that runs when the button is pressed! This will turn the RGB LED Green when running, message your phone when it starts and when it finishes, plus when the temperature is reached, then turn the RGB LED off. Thanks to Discord user RalphP for this! diff --git a/docs/products/temp1/reviews.md b/docs/products/temp1/reviews.md index 8aeaaaebdd..7c448be335 100755 --- a/docs/products/temp1/reviews.md +++ b/docs/products/temp1/reviews.md @@ -8,22 +8,22 @@ description: YouTuber reviews and feedback about the TEMP-1 sensor from Apollo A -# [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) +## [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) -# [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) +## [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) -# [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) +## [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) -# [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) +## [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) \ No newline at end of file diff --git a/docs/products/temp1/setup/temp1-general-tips.md b/docs/products/temp1/setup/temp1-general-tips.md index 884b3c5998..bb9c9b180a 100755 --- a/docs/products/temp1/setup/temp1-general-tips.md +++ b/docs/products/temp1/setup/temp1-general-tips.md @@ -8,10 +8,10 @@ description: >- The TEMP-1 has an optional Dallas temperature probe (long or short variants) and an optional food-safe probe. -###### Physical Buffered Temperature +## Physical Buffered Temperature For accurate vaccine storage monitoring, the CDC recommends using buffered temperature probes—a principle the Dallas temperature probe can follow using a glycol or glass bead vial. Buffering mimics the thermal behavior of stored vaccines, filtering out brief air temp fluctuations (e.g., door openings) that don’t reflect true vaccine exposure. This results in more reliable, regulation-aligned readings when using Dallas sensors like the DS18B20 in a buffered medium. You can also achieve better results by just placing the probe inside a bottle of water (for the fridge not freezer). -###### Virtual Temperature Buffering +## Virtual Temperature Buffering Instead of placing your Dallas temperature probe (like a DS18B20) in a vial of glycol or glass beads to mimic how vaccines warm up or cool down, you can use a software method called **Virtual Temperature Buffering**. It filters out quick air temperature changes—like when you open the fridge door—and gives a more stable, realistic reading similar to a physical buffer. This means you get accurate, regulation-friendly temps without needing messy liquids or bulky containers. \ No newline at end of file diff --git a/docs/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/products/temp1/troubleshooting/temp1-boot-mode.md index b34bf40ebb..1beb60a6ab 100755 --- a/docs/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/products/temp1/troubleshooting/temp1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The TEMP-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the TEMP-1 so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. @@ -24,7 +24,7 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1/troubleshooting/temp1-code/). -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and remove the case as shown in the images above diff --git a/docs/products/temp1b/battery-sensors/awake-ha-helper.md b/docs/products/temp1b/battery-sensors/awake-ha-helper.md index b4be1fbaed..4b683b4871 100644 --- a/docs/products/temp1b/battery-sensors/awake-ha-helper.md +++ b/docs/products/temp1b/battery-sensors/awake-ha-helper.md @@ -1,4 +1,5 @@ --- +title: Keep Your Sensor Awake With HA Helper description: "How to keep your sensor awake using the Home Assistant Helper." --- --8<-- "products/general/battery-sensors/awake-ha-helper.md:5:" diff --git a/docs/products/temp1b/battery-sensors/sensor-connection-check.md b/docs/products/temp1b/battery-sensors/sensor-connection-check.md index 4c138fe50e..dc0b58396d 100644 --- a/docs/products/temp1b/battery-sensors/sensor-connection-check.md +++ b/docs/products/temp1b/battery-sensors/sensor-connection-check.md @@ -1,4 +1,5 @@ --- +title: Sensor Connection Check description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." --- --8<-- "products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md b/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md index 023266d9c9..e5adaf6759 100644 --- a/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/temp1b/battery-sensors/wake-up-battery-sensor.md @@ -1,4 +1,5 @@ --- +title: How To Wake Up Your Sensor description: "How to wake up your Apollo device which is currently sleeping." --- --8<-- "products/general/battery-sensors/wake-up-battery-sensor.md:5:" diff --git a/docs/products/temp1b/examples/temp1b-automation-examples.md b/docs/products/temp1b/examples/temp1b-automation-examples.md index ffa9635304..7fa9be146a 100755 --- a/docs/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/products/temp1b/examples/temp1b-automation-examples.md @@ -4,7 +4,7 @@ description: Multiple automation examples with the TEMP-1B. --- # Automation Examples using a TEMP-1B -###### Freezer Temperature Probe Example +## Freezer Temperature Probe Example This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -66,7 +66,7 @@ actions: mode: single ``` -###### Food Probe Example +## Food Probe Example This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken (or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -121,7 +121,7 @@ actions: mode: single ``` -###### Cook Chicken Example +## Cook Chicken Example This will guide you through adding a button to your dashboard called "Chicken Monitor" and an automation that runs when the button is pressed! This will turn the RGB LED Green when running, message your phone when it starts and when it finishes, plus when the temperature is reached, then turn the RGB LED off. Thanks to Discord user RalphP for this! diff --git a/docs/products/temp1b/reviews.md b/docs/products/temp1b/reviews.md index 7eba564dbb..0d5b9bfbfe 100755 --- a/docs/products/temp1b/reviews.md +++ b/docs/products/temp1b/reviews.md @@ -8,22 +8,22 @@ description: YouTuber reviews and feedback about the TEMP-1B sensor from Apollo -# [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) +## [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) -# [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) +## [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) -# [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) +## [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) -# [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) +## [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) \ No newline at end of file diff --git a/docs/products/temp1b/setup/getting-started-temp1.md b/docs/products/temp1b/setup/getting-started-temp1.md index 3bf2f82d6e..4fd0d4228d 100644 --- a/docs/products/temp1b/setup/getting-started-temp1.md +++ b/docs/products/temp1b/setup/getting-started-temp1.md @@ -1,4 +1,5 @@ --- +title: Getting Started description: "Generic getting started article." --- --8<-- "products/general/setup/getting-started.md:5:" diff --git a/docs/products/temp1b/setup/temp1-general-tips.md b/docs/products/temp1b/setup/temp1-general-tips.md index 82fc08d105..3adb8932c4 100644 --- a/docs/products/temp1b/setup/temp1-general-tips.md +++ b/docs/products/temp1b/setup/temp1-general-tips.md @@ -1,4 +1,5 @@ --- -description: ">-" +title: General Tips +description: General tips for the TEMP-1 device and suggestions for improving the usability of the temp and food probe sensor. --- --8<-- "products/temp1/setup/temp1-general-tips.md:7:" diff --git a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md index 4027f9365b..df52384215 100755 --- a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md +++ b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The TEMP-1B In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the TEMP-1B so that the USB-C port is facing you. On the right side of the device, locate a small opening where you can use a paperclip to press the boot button. @@ -24,7 +24,7 @@ If you prefer, please remove the lid by gently prying up on the small slit by th 3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temp1b/troubleshooting/temp1b-code/). -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and remove the case as shown in the images above diff --git a/docs/products/temppro1/examples/temp1-automation-examples.md b/docs/products/temppro1/examples/temp1-automation-examples.md index 3dcfee4687..938327c916 100755 --- a/docs/products/temppro1/examples/temp1-automation-examples.md +++ b/docs/products/temppro1/examples/temp1-automation-examples.md @@ -4,7 +4,7 @@ description: Multiple automation examples with the TEMP-1. --- # Automation Examples using a TEMP-1 -###### Freezer Temperature Probe Example +## Freezer Temperature Probe Example This will guide you through how to set up an automation in Home Assistant using the temperature probe in your freezer! At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -66,7 +66,7 @@ actions: mode: single ``` -###### Food Probe Example +## Food Probe Example This will guide you through how to set up an automation in Home Assistant using the food probe with Chicken (or anything) cooking to 165°F(73.9C). At the end, you will have an automation that sends your phone a notification when your temp is exceeded. @@ -121,7 +121,7 @@ actions: mode: single ``` -###### Cook Chicken Example +## Cook Chicken Example This will guide you through adding a button to your dashboard called "Chicken Monitor" and an automation that runs when the button is pressed! This will turn the RGB LED Green when running, message your phone when it starts and when it finishes, plus when the temperature is reached, then turn the RGB LED off. Thanks to Discord user RalphP for this! diff --git a/docs/products/temppro1/reviews.md b/docs/products/temppro1/reviews.md index d5439c23e8..0a84601755 100755 --- a/docs/products/temppro1/reviews.md +++ b/docs/products/temppro1/reviews.md @@ -12,22 +12,22 @@ These Reviews need to be swapped for new ones -# [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) +## [Digiblur DIY](https://youtu.be/HhyBVV27sqM?si=klFlZ5TAtmob88ti) -# [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) +## [Smart Home Scene](https://smarthomescene.com/reviews/apollo-temp-1-probe-temperature-sensor-review/) -# [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) +## [Smart Home Solver](https://youtu.be/OWiPaKARNcU?si=5fCiOV4kA2KZ5i6W) -# [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) +## [Michael Leen](https://youtu.be/FJjD0iZZhHY?si=pkQlUNpIASznIeD0) \ No newline at end of file diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md index fb25fe7acf..ec6f4c6b30 100755 --- a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md +++ b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md @@ -8,7 +8,7 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. This is needed to force the device into boot mode to reflash the firmware. -##### Method 1: Boot Button Only +## Method 1: Boot Button Only 1\. Position the TEMP Pro-1 so that the USB-C port is facing you. Remove the lid by gently prying up on the small slit by the top of the case. @@ -22,7 +22,7 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode. 3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temppro1/troubleshooting/temp-pro1-code/). -##### Method 2: Boot and Reset Buttons +## Method 2: Boot and Reset Buttons 1\. Unplug the device and remove the case as shown in the images above From 12130b9a8ef7bffa7b20dbc9000cc497b8ed123a Mon Sep 17 00:00:00 2001 From: Justin Bunton <130115204+Bunton33@users.noreply.github.com> Date: Mon, 12 Oct 2026 06:31:44 -0400 Subject: [PATCH 4/4] docs: alphabetize nav groups and use one section order per product Nav only: no page is added, removed, or moved to a new URL. All 736 entries are kept (checked by script). - One section order for every product, in both the Home Assistant and Homey trees: Introduction, FAQ, Getting Started, setup groups, Additional Info, Addons, Examples, Troubleshooting, Reviews. Reviews moved to the end on 9 products; Addons now precede Examples on M-1. - Homey MTR-1 Zone Configuration and Homey MSR-2 Radar Tuning move out of Additional Info to sit after Getting Started, as they do in the Home Assistant tree and for Homey R PRO-1. - Products within a category are alphabetical (mmWave: MSR-1, MSR-2, MTR-1, R PRO-1). - Items within Additional Info, Addons, Examples, Troubleshooting, Battery Sensors, Calibrating, and Example Flows are alphabetical, with General Tips and Sensor Definitions kept first. Sequential sections (Getting Started, ESPHome Starter Kit lessons, Zone Configuration's Good/Better/Best) keep their order. - Labels: PLT-1B troubleshooting entries said "PLT-1" (6 entries, both trees); WiFi -> Wi-Fi (3); Unifi -> UniFi (2). Co-Authored-By: Claude Opus 5.5