**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 +You're finished! Your Apollo device can now connect to your Wi-Fi with a hidden SSID. + +!!! warning "Understand the downside of fast_connect" + + `fast_connect` (optional, true or false): when enabled, your device connects directly to your Wi-Fi network without doing a full scan first. This is required for hidden networks and can significantly improve connection times. It defaults to `off`. The downside is that your device connects to the first network it sees, even if that network is very far away and better ones are available. Read more about the downsides [in the ESPHome Wi-Fi documentation](https://esphome.io/components/wifi.html "downsides of fast_connect: true"). diff --git a/docs/homey/products/general/setup/getting-started.md b/docs/homey/products/general/setup/getting-started.md index 513f14bcb1..43f2927da1 100755 --- a/docs/homey/products/general/setup/getting-started.md +++ b/docs/homey/products/general/setup/getting-started.md @@ -1,18 +1,18 @@ --- -title: Getting Started +title: Getting started description: "Generic getting started article." --- -# Getting Started +# Getting started This will walk you through the process of connecting your new Apollo Automation sensor to Homey. If at any point you get stuck, join our Discord for some help. -## Connecting Through Hotspot: +## Connecting through hotspot: 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 Wi-Fi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the Wi-Fi network to show up. +2\. On your phone or PC, open the Wi-Fi settings and connect to "Apollo MSR2 Hotspot", it might take a minute for the Wi-Fi network to show up.  @@ -30,7 +30,9 @@ If this does not automatically open the dashboard, please open your web browser 5\. Once connected, the sensor's dashboard will automatically close. You've successfully connected your sensor to your Wi-Fi. -## Adding Apollo Automation App in Homey: +## Adding Apollo Automation app in Homey: + +You'll install the Apollo Automation app on your Homey from a desktop PC or a browser. 1\. Navigate to this website and click "Install App". For now this needs to be done from a desktop PC or a browser. @@ -44,6 +46,8 @@ If this does not automatically open the dashboard, please open your web browser ## Connecting to Homey: +Next, you'll add your Apollo sensor to Homey from the Homey app on your phone. + 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.  @@ -62,7 +66,7 @@ If this does not automatically open the dashboard, please open your web browser  -6\. Change any other default settings like the Name, icon, etc or just click Finish in the bottom right. +6\. Change any other default settings like the Name, icon, etc or click Finish in the bottom right.  diff --git a/docs/homey/products/general/setup/renaming-apollo-devices.md b/docs/homey/products/general/setup/renaming-apollo-devices.md index d75ec0c440..153ba13acc 100755 --- a/docs/homey/products/general/setup/renaming-apollo-devices.md +++ b/docs/homey/products/general/setup/renaming-apollo-devices.md @@ -1,8 +1,8 @@ --- -title: Renaming Apollo Devices +title: Renaming Apollo devices description: "Rename an Apollo device from the Homey app or the Homey dashboard." --- -# Renaming Apollo Devices +# Renaming Apollo devices 1\. Open the Homey App or dashboard in a browser and right click a device or short hold and then select "Rename". diff --git a/docs/homey/products/general/supported-platforms.md b/docs/homey/products/general/supported-platforms.md index 7776cca95b..6d56a43cbc 100755 --- a/docs/homey/products/general/supported-platforms.md +++ b/docs/homey/products/general/supported-platforms.md @@ -1,5 +1,5 @@ --- -title: Supported Platforms +title: Supported platforms description: A list of platforms compatible with Apollo Automation products. ---  @@ -23,7 +23,7 @@ At Apollo, we are actively working on adding support for every smart home ecosys ## **Hubitat** -* **Integration:** Working on support - check back soon! +* **Integration:** Working on support. Check back soon! * **Support:** We do not provide support for this platform but if enough users want it that could change. We of course always support the hardware of our products though! ## **openHAB** diff --git a/docs/homey/products/general/troubleshooting/connection-issues.md b/docs/homey/products/general/troubleshooting/connection-issues.md index b57abf73a6..efd85b9c61 100755 --- a/docs/homey/products/general/troubleshooting/connection-issues.md +++ b/docs/homey/products/general/troubleshooting/connection-issues.md @@ -1,15 +1,17 @@ --- -title: Connection Issues -description: Suggestions for Connection Issues +title: Connection issues +description: Checks to work through when your Apollo device won't stay connected or Homey can't find it. --- -# Common Connection Issues +# Common connection issues -1\. Try a couple of different power cord and power brick combinations - this matters a lot more than you'd think! +Work through these checks if your Apollo device won't stay connected or Homey can't find it. -2\. Check to see if the sensor's hotspot is showing up. (this means it is not connected to a network) +1\. Try a couple of different power cord and power brick combinations. This matters a lot more than you'd think! -3\. Check the router's connected devices - the device will show up with the Apollo name and a 6 digit hex value of the end of the mac address. +2\. Check your Wi-Fi list for the device's hotspot. If the hotspot is showing up, the device is not connected to a network. Connect to the hotspot and add your Wi-Fi network, as shown in [Connecting through hotspot](../../setup/getting-started/#connecting-through-hotspot). + +3\. Check your router's list of connected devices. Your device shows up with the Apollo name followed by a 6-digit hex value, which is the end of its hardware (MAC) address. !!! tip "Look at the mDNS wiki articles as well" - mDNS is something that is used to tell what devices are seen on the network and if there are firewall issues or mDNS traffic is not being forwarded then there can be issues with Auto Discovery. \ No newline at end of file + Auto discovery depends on mDNS, which is used to tell which devices are on your network. If a firewall blocks mDNS, or your network doesn't forward mDNS traffic, auto discovery can run into issues. If you use UniFi or OPNsense, see the [UniFi mDNS guide](../ubiquiti-unifi-mdns-auto-discover-issue/) or the [OPNsense mDNS guide](../opnsense-mdns-auto-discover-issue/). 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 181122b140..186313bf6b 100755 --- a/docs/homey/products/general/troubleshooting/removing-device-from-homey.md +++ b/docs/homey/products/general/troubleshooting/removing-device-from-homey.md @@ -1,8 +1,8 @@ --- -title: Removing Devices from Homey +title: Removing devices from Homey description: "Remove an Apollo device from Homey through the app or the dashboard." --- -# Removing Devices from Homey +# Removing devices from Homey 1\. Open your Homey app or desktop browser and navigate to the Homey Dashboard. 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 9712409f3c..d91d9edafe 100755 --- a/docs/homey/products/general/tutorials/high-co2-notification-example.md +++ b/docs/homey/products/general/tutorials/high-co2-notification-example.md @@ -1,9 +1,9 @@ --- -title: High CO₂ Notification Example +title: High CO₂ notification example description: Example flow for sending alerts when CO₂ levels exceed a defined threshold. --- -# High CO2 Notification +# High CO2 notification !!! tip "This guide will show you how to create a flow that sends a notification to everyone who's home when the CO2 is over a set threshold, 1000 ppm in this example." @@ -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 900 (the screenshot shows 1000; use 900). The gap between 900 and 999 keeps the light from flickering between red and green when CO2 hovers around 1000 ppm.  @@ -39,11 +39,11 @@ 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.  -10\. Duplicate steps 7 and 8 but this time select green for the color when "CO2 becomes less than 1000 ppm". +10\. Duplicate steps 8 and 9 but this time select green for the color when "CO2 becomes less than 900 ppm" (the screenshot shows 1000; use 900).  @@ -61,7 +61,7 @@ description: Example flow for sending alerts when CO₂ levels exceed a defined  -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. +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 (the screenshot shows 1000; use 900).  @@ -69,11 +69,11 @@ description: Example flow for sending alerts when CO₂ levels exceed a defined  -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. +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. Your finished flow should look like this (the screenshot shows 1000; use 900).  -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. +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. Your flow should now look like this (the screenshot shows 1000; use 900).  diff --git a/docs/homey/products/general/tutorials/region-light-flow-example.md b/docs/homey/products/general/tutorials/region-light-flow-example.md index 8eb449217f..899bd0b9bf 100644 --- a/docs/homey/products/general/tutorials/region-light-flow-example.md +++ b/docs/homey/products/general/tutorials/region-light-flow-example.md @@ -24,7 +24,7 @@ Every detect region gives your sensor three flow cards: **A region became occupi The sensor's whole-room card, **The occupancy alarm turned on**, only fires when the room goes from empty to occupied. Pairing it with a **Server is occupied** condition misses the moment someone who is already in the room walks over to the server, so the light stays off. -## Flow 1: turn the light on +## Flow 1: Turn the light on This flow has one trigger and one action, so it needs no **And** card. @@ -45,7 +45,7 @@ The flow now shows in **My Flows**. Walk into the region and the light turns on. The region picker lists your **Detect people here** regions. Areas set to **Ignore this area** never report occupied, so they don't appear. -## Flow 2: turn the light off +## Flow 2: Turn the light off The second flow mirrors the first. Build it the same way, with two changes: 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 6f85e42a2a..cddcde9394 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,8 +1,10 @@ --- -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 articulating stand to your MSR-2 +description: Tutorial on adding the Articulating Stand addon to your MSR-2. --- -# Adding Articulating Stand To MSR-2 +# Adding articulating stand to MSR-2 + +You'll swap the back of your sensor for the articulating stand backplate, then seat the stand's ball in its mount. 1\. Unplug your MSR-2 from power and remove the back. 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 3b6028426e..83001e9148 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 @@ -1,8 +1,10 @@ --- -title: Adding CO₂ To MSR-2 +title: Adding CO₂ to MSR-2 description: "Tutorial on adding the SCD40 CO2 sensor to your MSR-2." --- -# Adding CO2 To MSR-2 +# Adding CO2 to MSR-2 + +You'll slide your sensor out of its case, fit the SCD40 module onto the mezzanine connector, and put the case back together. 1\. Unplug your MSR-2 from power and remove the back 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 215b851e98..be481ae6b0 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 @@ -1,8 +1,10 @@ --- -title: Adding GPIO Header To MSR-2 +title: Adding GPIO header to MSR-2 description: "Tutorial on adding the GPIO Header to your MSR-2." --- -# Adding GPIO Header To MSR-2 +# Adding GPIO header to MSR-2 + +You'll seat the GPIO Header addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it. 1\. Unplug your MSR-2 from power and remove the back. @@ -28,7 +30,7 @@ description: "Tutorial on adding the GPIO Header to your MSR-2."  -## GPIO Header pinout +## GPIO header pinout With the header installed, these are the pins you can wire to. IO18 and IO19 can't be used while you flash the MSR-2, and IO0 and IO1 carry the I2C bus (SDA and SCL). @@ -38,4 +40,4 @@ With the header installed, these are the pins you can wire to. IO18 and IO19 can Brandon AKA SmartHomeSellout made this neat tutorial for how to connect a short LED strip to your MSR-2 - GPIO LED Strip Tutorial
\ No newline at end of file + GPIO LED Strip Tutorial
\ No newline at end of file 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 3701facaf2..809b4f7122 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,8 +1,10 @@ --- -title: Adding Rear Female USB-C To MSR-2 +title: Adding rear female USB-C to MSR-2 description: "Tutorial on adding the rear female USB-C port to your MSR-2." --- -# Adding Rear Female USB-C To MSR-2 +# Adding rear female USB-C to MSR-2 + +You'll seat the Female Rear USB-C addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it. 1\. Unplug your MSR-2 from power and remove the back diff --git a/docs/homey/products/msr2/addons/msr2-outlet-mount.md b/docs/homey/products/msr2/addons/msr2-outlet-mount.md index c755968409..66979a793c 100755 --- a/docs/homey/products/msr2/addons/msr2-outlet-mount.md +++ b/docs/homey/products/msr2/addons/msr2-outlet-mount.md @@ -1,8 +1,10 @@ --- -title: MSR-2 Outlet Mount +title: MSR-2 outlet mount description: Tutorial for using the MSR-2 Outlet Mount. --- -# MSR-2 Outlet Mount +# MSR-2 outlet mount + +You'll attach your sensor to a top facing USB-C plug with the Outlet Mount. 1\. Gather a top facing USB-C plug, an MSR-2, and our MSR-2 Outlet Mount. @@ -22,4 +24,4 @@ description: Tutorial for using the MSR-2 Outlet Mount. !!! success "You're ready to plug it in and begin using your device!" - Make sure to head to our getting started guide to get your MSR-2 up and running! \ No newline at end of file + Make sure to head to our getting started guide to get your MSR-2 up and running! \ No newline at end of file diff --git a/docs/homey/products/msr2/calibrating-co2.md b/docs/homey/products/msr2/calibrating-co2.md deleted file mode 100755 index 306de489d2..0000000000 --- a/docs/homey/products/msr2/calibrating-co2.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: CO2 Calibration Tutorial (quick) -description: Step by step guide for re-calibrating your SCD40 CO2 sensor ---- -# CO2 Calibration - The Quick method - Desktop Only not mobile - -!!! info "Your MSR-2 calibrates itself" - - The latest MSR-2 firmware enables the SCD40's automatic self-calibration by default. As long as the sensor sees fresh air (about 420 ppm) at least once a week, it corrects its own baseline and you never need to calibrate manually. You only need this guide if the device sits in a space that rarely gets fresh air (a sealed office, a basement, a grow room), where auto calibration slowly drags the readings down. In that case, turn off the **CO2 Auto Calibration** switch in your device's settings and calibrate manually with the steps below. - -!!! tip "Calibrate manually every 1 to 2 years when auto calibration is off" - - 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. - -This article will guide you through a simple calibration of your CO2 sensor for any Apollo Automation device! - -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. - -!!! tip "Hint" - - 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 30dd0ebf07..09a316f8bd 100755 --- a/docs/homey/products/msr2/examples/msr2-alarmo.md +++ b/docs/homey/products/msr2/examples/msr2-alarmo.md @@ -1,38 +1,52 @@ --- -title: MSR-2 + Alarmo Home Security Install -description: "A tutorial for how to use the MSR-2 with Alarmo for an advanced DIY alarm system." +title: MSR-2 + Alarmo home security install +description: "Use the Alarmo integration in Home Assistant to turn your MSR-2 into a local alarm that notifies your phone and turns on your sensors' RGB lights." --- -# MSR-2 + Alarmo Home Security Install - -My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo add-on, quickly and easily allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. - -1\. Install [HACS](https://hacs.xyz/docs/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. Under 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. - -We hope this was helpful and please let us know if there are any questions! \ No newline at end of file +# MSR-2 + Alarmo home security install + +My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. With the Alarmo integration, they quickly became a fully local, private security system: no cloud and no monthly subscription. She can arm and disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. + +This guide shows you how to build the same system with your Apollo MSR-2. Alarmo watches your sensors and, when the alarm is triggered, sends a notification to your phone and turns on your sensors' RGB lights. + +!!! note "Before you start" + + - This guide is for Home Assistant, not Homey. HACS, Alarmo, and the Alarmo Card all run in Home Assistant. + - You need a motion or presence sensor, such as your MSR-2, already set up in Home Assistant. + +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). The card puts arm and disarm buttons on your Home Assistant dashboard, as in the first screenshot below. The second shows Alarmo's **General** tab, with its global alarm settings and arm modes. + + + + + +3\. Find **Alarmo** in the sidebar on the left, select the **Sensors** tab, and turn on the sensor entities you want to use for your alarm system. + + + +*Shown with MSR-1 sensors; add your MSR-2 radar target entities the same way.* + +4\. Select the **Actions** tab. Under **Condition → Event**, select **Alarm is triggered**. Then, under **Task → Target → Select Device**, choose the device you want the notification on, such as your phone or tablet. + + + +5\. Change the **Title**, **Message**, and **Name** of the alarm notification if you like, then save the action. + + + +6\. Add a second action that turns on your sensors' RGB lights. Under **Entity**, select your sensor's RGB light. (An action like this can also make the sensors' onboard piezo buzzers play an alarm sound; this guide sets up the lights.) + + + +*Shown with AIR-1 and MSR-1 lights; pick your MSR-2 RGB light the same way.* + +7\. Under **Action**, select **Turn On**. + + + +*Shown with AIR-1 and MSR-1 lights; the MSR-2 steps are the same.* + +And that's it! When the alarm is triggered, your sensors' RGB lights turn on and the notification goes to your phone. Enjoy your free and local security system. + +We hope this was helpful. Please let us know if you have any questions! diff --git a/docs/homey/products/msr2/examples/msr2-dashboards.md b/docs/homey/products/msr2/examples/msr2-dashboards.md index 705b048605..06fe0fbada 100755 --- a/docs/homey/products/msr2/examples/msr2-dashboards.md +++ b/docs/homey/products/msr2/examples/msr2-dashboards.md @@ -1,19 +1,26 @@ --- -title: MSR-2 Home Assistant Dashboard Examples -description: "Example dashboard cards for the MSR-2, including an ApexCharts scatter plot of radar distance you can copy and paste." +title: MSR-2 Home Assistant dashboard examples +description: "Copy-and-paste Home Assistant dashboard cards for the MSR-2: an ApexCharts radar distance scatter plot and three CO2 charts." --- -# MSR-2 Home Assistant Dashboard Examples +# MSR-2 Home Assistant dashboard examples -**Radar Scatter Plot With Apex Charts For **[**MSR-2**](https://apolloautomation.com/products/msr-2) +These example cards put readings from your [Apollo MSR-2](https://apolloautomation.com/products/msr-2) on a Home Assistant dashboard. Each section shows a screenshot of the card, followed by its YAML. Copy the YAML for the card you want and paste it into a new card on your dashboard. + +!!! note "Use your own entity IDs" + + The entity IDs in every YAML block on this page contain the placeholder `xxxxxx`. Replace `xxxxxx` with the last six characters of your MSR-2's name. + +## Radar scatter plot with ApexCharts (custom card) + +This card plots the radar's detection, moving, and still distances as a scatter plot over 24 hours. -  ```plaintext type: custom:apexcharts-card header: show: true - title: MSR-1 Radar Distance + title: MSR-2 Radar Distance show_states: true colorize_states: true apex_config: @@ -29,55 +36,58 @@ brush: graph_span: 24hr chart_type: scatter series: - - entity: sensor.apollo_msr_1_a79e14_radar_detection_distance + - entity: sensor.apollo_msr_2_xxxxxx_radar_detection_distance name: Detection stroke_width: 1 color: green show: in_brush: true extremas: true - - entity: sensor.apollo_msr_1_a79e14_radar_moving_distance + - entity: sensor.apollo_msr_2_xxxxxx_radar_moving_distance name: Moving stroke_width: 1 - - entity: sensor.apollo_msr_1_a79e14_radar_still_distance + - entity: sensor.apollo_msr_2_xxxxxx_radar_still_distance name: Still stroke_width: 1 ``` -**CO2 Charts** -Home Assistant Sensor +## CO2 charts + +These three cards show readings from the CO2 sensor, so your MSR-2 needs the [CO2 addon](../../addons/adding-co2-to-msr-2/) installed. + +### Home Assistant sensor card  ```plaintext graph: line type: sensor -entity: sensor.apollo_msr_1_a79e38_co2 +entity: sensor.apollo_msr_2_xxxxxx_co2 detail: 2 name: Bedroom CO2 hours_to_show: 24 ``` -Custom: Plotly Graph Card +### Plotly graph card (custom card)  ```plaintext type: custom:plotly-graph entities: - - entity: sensor.apollo_msr_1_a79e38_co2 + - entity: sensor.apollo_msr_2_xxxxxx_co2 hours_to_show: 24 refresh_interval: 10 title: Bedroom CO2 ``` -Home Assistant Gauge +### Home Assistant gauge card  ```plaintext type: gauge -entity: sensor.apollo_msr_1_a79e38_co2 +entity: sensor.apollo_msr_2_xxxxxx_co2 needle: true unit: ppm min: 0 @@ -86,4 +96,4 @@ severity: green: 0 yellow: 1000 red: 2000 -``` \ No newline at end of file +``` diff --git a/docs/homey/products/msr2/examples/using-msr-2-buzzer.md b/docs/homey/products/msr2/examples/using-msr-2-buzzer.md deleted file mode 100755 index e6c8d0adbf..0000000000 --- a/docs/homey/products/msr2/examples/using-msr-2-buzzer.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Using MSR-2 Buzzer -description: "Trigger the MSR-2 buzzer from developer tools, then reuse the same call in an automation." ---- -# Using MSR-2 Buzzer - -This guide will walk you through using the buzzer on your MSR-2. You can also use the "action" in an automation in Home Assistant. - -1. Open Home Assistant and navigate to developer tools in the bottom left - - - -2\. Click on services - -3\. Choose your MSR-2's buzzer (You can type in buzzer to find it easier) - -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 - ``` - - Cantina: ``` - Cantina:d=4,o=5,b=250:8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,a,8a,8g#,8a,g,8f#,8g,8f#,f.,8d.,16p,p.,8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,8a,8p,8g,8p,g.,8f#,8g,8p,8c6,a#,a,g - ``` - - Star Wars Imperial Death March: ``` - 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 rtttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/) - -5\. Click on the ACTIONS button in bottom right - - \ No newline at end of file diff --git a/docs/homey/products/msr2/faq.md b/docs/homey/products/msr2/faq.md index a39d5609fb..91e15b9966 100755 --- a/docs/homey/products/msr2/faq.md +++ b/docs/homey/products/msr2/faq.md @@ -1,7 +1,9 @@ --- -title: FAQ -description: "Frequently asked questions about the MSR-2 mmWave sensor." +title: MSR-2 FAQ +description: "Answers to common questions about the MSR-2 mmWave sensor with Homey: sensors, radar tuning, distance zones, flows, and reporting." --- +# MSR-2 FAQ + 1\. **What sensors are included in the MSR-2?** * The MSR-2 includes several built-in sensors such as an mmWave radar for motion detection, a LUX and UV sensor, a temperature and pressure sensor, and an optional CO2 sensor. @@ -12,7 +14,7 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor." 3\. **What is the maximum detection range of the mmWave radar?** -* The HLK-LD2410B mmWave radar sensor has a maximum detection range of about 6 meters (19.6 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring. +* The HLK-LD2410B mmWave radar sensor has a maximum detection range of about 6 meters (19.7 feet), making it ideal for room-wide monitoring. 4\. **Can the MSR-2 detect multiple people?** @@ -26,21 +28,29 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor." * The optional SCD-40 CO2 sensor provides accurate carbon dioxide measurements and is useful for tracking air quality in enclosed spaces. This sensor can be used to automate HVAC systems, sending alerts when CO2 levels are too high and suggesting when to ventilate the area. -7\. **How do I connect the MSR-2 to Home Assistant?** +7\. **How do I connect the MSR-2 to Homey?** + +* The MSR-2 joins your Wi-Fi, and the Apollo Automation app for Homey talks to it directly over your local network through the ESPHome native API, with no cloud account. Once you add it, every sensor's readings show up on the device in Homey, ready for flows and Insights. The app runs on Homey Pro; Homey Cloud isn't supported. + +!!! success "Next step: add your MSR-2 to Homey" + + Connect the sensor to your Wi-Fi through its hotspot, then add it with the Apollo Automation app. The getting started guide walks you through both. -* 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. + [Get started with Homey](../../general/setup/getting-started-msr2/){ .md-button .md-button--primary } -8\. **What kind of automations can I create with the MSR-2?** +8\. **What kind of flows can I create with the MSR-2?** -* You can create a variety of automations, such as turning on lights when motion is detected, adjusting ventilation when CO2 levels rise, or triggering alarms based on motion or environmental changes. +* Flows can start from presence, from a distance zone, or from any reading. Turn on lights with **Radar target detected**, react to someone near the sensor with **Radar zone 1 becomes occupied**, adjust ventilation when CO2 levels rise (with the CO2 addon), or trigger alarms based on motion or environmental changes. 9\. **What are the RGB LED and piezo buzzer used for?** -* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure. +* The RGB LED is the MSR-2's light in Homey. Turn it on or off, dim it, or change its color from the device or in a flow, for example to show detected motion or high UV exposure. +* The piezo buzzer is played through an ESPHome action, and the Apollo Automation app has no flow card for it, so Homey can't sound the buzzer. If you also run Home Assistant, it can: see the [piezo buzzer guide](../../../../products/general/piezo/). 10\. **How do I adjust the sensitivity of the presence detection?** -* Sensitivity adjustments can be made through the Home Assistant Device Page or HLK Radar Tool app allowing you to fine-tune the radar to avoid false positives or to increase its sensitivity for more precise detections. +* In the device's **Settings** in the Homey app, the **Radar tuning (MSR-1 / MSR-2)** group has **Radar timeout** (how long presence holds after the last detection), **Radar max move distance gate**, and **Radar max still distance gate**. Each gate is 0.75 m, and gate 8 reaches 6 m, so lowering the max gates stops the radar from reacting to motion farther away. +* Per-gate sensitivity (the move and still thresholds for each gate) isn't in Homey. Tune it with the [HLK Radar Tool app](../setup/zones-hlk/), or on the sensor's own web page: in a browser, open `http://apollo-msr-2-xxxxxx.local`, where `xxxxxx` is the last 6 characters of the device's name in Homey. 11\. **Does the mmWave sensor detect through walls?** @@ -56,11 +66,12 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor." 14\. **Can the MSR-2 track the exact location of people in a room?** -* Yes, the MSR-2 uses multi-zone mmWave radar technology to track the approximate location of people within a room. It can determine whether someone is sitting, walking, or standing in different areas of the space. +* No. The MSR-2 tracks a single target and reports how far it is from the sensor and whether it is moving or still. You can set up to three distance-based zones (Radar Zone 1 to 3) to tell roughly how far away someone is. For X/Y positions of up to three people, use the MTR-1 or R PRO-1. +* In Homey, set where zone 1 starts and where each zone ends under **Radar zones for MSR-2** in the device's **Settings**, and start flows with cards such as **Radar zone 2 becomes occupied** and **Radar zone 2 becomes clear**. 15\. **How does the temperature and pressure sensor work?** -* The DPS310 sensor provides precise readings of air temperature and pressure, which are especially useful when combined with the optional CO2 sensor to improve air quality monitoring. Keep in mind the heat generated by the ESP32 may require a temperature offset adjustment in the configuration. +* The DPS310 sensor provides precise readings of air temperature and pressure, which are especially useful when combined with the optional CO2 sensor to improve air quality monitoring. Keep in mind the heat generated by the ESP32 may require a temperature offset. Set it with **DPS temperature offset** under **Calibration offsets** in the device's **Settings** in the Homey app. 16\. **What kind of power supply is required for the MSR-2?** @@ -72,15 +83,16 @@ description: "Frequently asked questions about the MSR-2 mmWave sensor." 18\. **How often does the MSR-2 report sensor data?** -* The reporting frequency can be customized through the ESPHome YAML configuration. You can set it to report data as frequently as every second or reduce the frequency to save energy or bandwidth. +* The radar reports presence as it changes, and most other readings update every 60 seconds by default. These intervals are set in the firmware, and Homey has no setting for them. +* The light and UV interval is the one you can change without editing the firmware: set **LTR390 Update Interval** (1 to 300 seconds) on the sensor's own web page (see question 10 for the address). The page hides this setting at first, so click **Show All** to list it. Changing the other intervals means editing the firmware with ESPHome. 19\. **Is the MSR-2 compatible with other smart home platforms?** -* The MSR-2 is specifically designed for Home Assistant via ESPHome. While it could be compatible with other platforms through custom integrations, its primary functionality is optimized for Home Assistant. +* Yes. Besides Homey (through the Apollo Automation app), the MSR-2 works with Home Assistant and with other platforms that support the ESPHome API. See [Supported platforms](../../general/supported-platforms/). -20\. **Can I use multiple MSR-2 sensors in my Home Assistant setup?** +20\. **Can I use multiple MSR-2 sensors with one Homey?** -* Yes, you can have multiple MSR-2 sensors connected to the same Home Assistant instance. Each device will show up as a separate entity, allowing you to monitor and automate different rooms or areas in your home. +* Yes. Add each MSR-2 with the Apollo Automation app. Each one shows up as its own device in Homey with its own readings and settings, so you can monitor and automate different rooms or areas in your home. 21\. **What accessories are available for the MSR-2?** @@ -92,12 +104,12 @@ 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 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. +* Power the MSR-2 over USB-C, connect it to your Wi-Fi through its hotspot, and add it in Homey with the Apollo Automation app. Radar tuning, distance zones, and calibration offsets are all in the device's **Settings** in Homey. We provide detailed documentation and support through our Discord community and GitHub. 24\. **What makes the MSR-2 stand out from other motion sensors?** -* The MSR-2 stands out due to its mmWave radar’s ability to detect still motion (like someone sitting still) and its capability to track multiple targets and zones. Additionally, its compact size, multi-sensor integration (motion, LUX, UV, CO2, temperature, pressure), and the open-source nature of the product make it highly versatile and customizable. +* The MSR-2 stands out due to its mmWave radar’s ability to detect still motion (like someone sitting still) and its three distance-based zones. Additionally, its compact size, multi-sensor integration (motion, LUX, UV, CO2, temperature, pressure), and the open-source nature of the product make it highly versatile and customizable. 25\. **What is the warranty for the MSR-2?** -* The MSR-2 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement. \ No newline at end of file +* The MSR-2 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement. diff --git a/docs/homey/products/msr2/msr-2-reviews/home-tech-innovations-msr-2-review.md b/docs/homey/products/msr2/msr-2-reviews/home-tech-innovations-msr-2-review.md index 6beb8a94df..08f9d95ca4 100755 --- a/docs/homey/products/msr2/msr-2-reviews/home-tech-innovations-msr-2-review.md +++ b/docs/homey/products/msr2/msr-2-reviews/home-tech-innovations-msr-2-review.md @@ -1,8 +1,13 @@ --- -title: Home Tech Innovations MSR-2 Review +title: Home Tech Innovations MSR-2 review description: "Home Tech Innovations sets up the Apollo MSR-2 in three steps." --- -# Home Tech Innovations MSR-2 Review +# Home Tech Innovations MSR-2 review -> #### Setup MSR-2 in 3 EASY Steps! +In this video, Home Tech Innovations walks through setting up the Apollo MSR-2 in three steps. Watch it below, or open it on YouTube. + + +[:fontawesome-brands-youtube: Watch "Setup MSR-2 in 3 EASY Steps!" on YouTube](https://www.youtube.com/watch?v=K3j2rR2dsY0){ target=_blank rel="noreferrer nofollow noopener" } + +For more videos and articles about the MSR-2, see [MSR-2 reviews](../../msr2-reviews/). diff --git a/docs/homey/products/msr2/msr-2-reviews/michael-leen-msr-2-review.md b/docs/homey/products/msr2/msr-2-reviews/michael-leen-msr-2-review.md index d7f3ca9737..56c370e65c 100755 --- a/docs/homey/products/msr2/msr-2-reviews/michael-leen-msr-2-review.md +++ b/docs/homey/products/msr2/msr-2-reviews/michael-leen-msr-2-review.md @@ -1,8 +1,13 @@ --- -title: Michael Leen MSR-2 Review +title: Michael Leen MSR-2 review description: "Michael Leen reviews the Apollo MSR-2 mmWave multisensor." --- -# Michael Leen MSR-2 Review +# Michael Leen MSR-2 review -> #### Don’t Be Fooled By Its Size: Apollo MSR-2 mmWave Multisensor +In this video, Michael Leen reviews the Apollo MSR-2 mmWave multisensor. Watch it below, or open it on YouTube. + + +[:fontawesome-brands-youtube: Watch "Don't Be Fooled By Its Size: Apollo MSR-2 mmWave Multisensor" on YouTube](https://www.youtube.com/watch?v=VdVR8Gs002Q){ target=_blank rel="noreferrer nofollow noopener" } + +For more videos and articles about the MSR-2, see [MSR-2 reviews](../../msr2-reviews/). diff --git a/docs/homey/products/msr2/msr-2-reviews/mostlychris-msr-2-review.md b/docs/homey/products/msr2/msr-2-reviews/mostlychris-msr-2-review.md index 823dbf7381..de17b6bec6 100755 --- a/docs/homey/products/msr2/msr-2-reviews/mostlychris-msr-2-review.md +++ b/docs/homey/products/msr2/msr-2-reviews/mostlychris-msr-2-review.md @@ -1,8 +1,13 @@ --- -title: MostlyChris MSR-2 Review +title: MostlyChris MSR-2 review description: "MostlyChris reviews the Apollo MSR-2 presence sensor." --- -# MostlyChris MSR-2 Review +# MostlyChris MSR-2 review -> #### Even SMALLER Presence Sensor for Home Assistant! +In this video, MostlyChris reviews the Apollo MSR-2 presence sensor. Watch it below, or open it on YouTube. + + +[:fontawesome-brands-youtube: Watch "Even SMALLER Presence Sensor for Home Assistant!" on YouTube](https://www.youtube.com/watch?v=nQpi2n5UWoQ){ target=_blank rel="noreferrer nofollow noopener" } + +For more videos and articles about the MSR-2, see [MSR-2 reviews](../../msr2-reviews/). diff --git a/docs/homey/products/msr2/msr-2-reviews/simon-says-home-assistant-msr-2-review.md b/docs/homey/products/msr2/msr-2-reviews/simon-says-home-assistant-msr-2-review.md index ab3f35b3a2..67be895102 100755 --- a/docs/homey/products/msr2/msr-2-reviews/simon-says-home-assistant-msr-2-review.md +++ b/docs/homey/products/msr2/msr-2-reviews/simon-says-home-assistant-msr-2-review.md @@ -1,8 +1,13 @@ --- -title: Simon Says Home Assistant MSR-2 Review +title: Simon Says Home Assistant MSR-2 review description: "Simon Says Home Assistant reviews the Apollo MSR-2." --- -# Simon Says Home Assistant MSR-2 Review +# Simon Says Home Assistant MSR-2 review -> #### The Apollo MSR2 Presence Sensor is now even smaller! +In this video, Simon Says Home Assistant reviews the Apollo MSR-2. Watch it below, or open it on YouTube. + + +[:fontawesome-brands-youtube: Watch "The Apollo MSR2 Presence Sensor is now even smaller!" on YouTube](https://www.youtube.com/watch?v=U4qUhFSAxbk){ target=_blank rel="noreferrer nofollow noopener" } + +For more videos and articles about the MSR-2, see [MSR-2 reviews](../../msr2-reviews/). diff --git a/docs/homey/products/msr2/msr-2-reviews/smart-home-australia-msr-2-review.md b/docs/homey/products/msr2/msr-2-reviews/smart-home-australia-msr-2-review.md index 6d2dce1220..f4fc6d79b8 100755 --- a/docs/homey/products/msr2/msr-2-reviews/smart-home-australia-msr-2-review.md +++ b/docs/homey/products/msr2/msr-2-reviews/smart-home-australia-msr-2-review.md @@ -1,8 +1,13 @@ --- -title: Smart Home Australia MSR-2 Review +title: Smart Home Australia MSR-2 review description: "Smart Home Australia reviews the Apollo MSR-2 radar motion sensor." --- -# Smart Home Australia MSR-2 Review +# Smart Home Australia MSR-2 review -> #### Apollo MSR2 Radar Motion Sensor - Small just got tiny !! +In this video, Smart Home Australia reviews the Apollo MSR-2 radar motion sensor. Watch it below, or open it on YouTube. + + +[:fontawesome-brands-youtube: Watch "Apollo MSR2 Radar Motion Sensor - Small just got tiny !!" on YouTube](https://www.youtube.com/watch?v=EzVyzFwdgN4){ target=_blank rel="noreferrer nofollow noopener" } + +For more videos and articles about the MSR-2, see [MSR-2 reviews](../../msr2-reviews/). diff --git a/docs/homey/products/msr2/msr-2-reviews/smart-home-scene-msr-2-review.md b/docs/homey/products/msr2/msr-2-reviews/smart-home-scene-msr-2-review.md index 42354520b9..039ed6a6de 100755 --- a/docs/homey/products/msr2/msr-2-reviews/smart-home-scene-msr-2-review.md +++ b/docs/homey/products/msr2/msr-2-reviews/smart-home-scene-msr-2-review.md @@ -1,7 +1,7 @@ --- -title: Smart Home Scene MSR-2 Review +title: Smart Home Scene MSR-2 review description: "The Smart Home Scene written review of the Apollo MSR-2." --- -# Smart Home Scene MSR-2 Review +# Smart Home Scene MSR-2 review > #### [Apollo MSR-2 Review: The Smallest Presence Sensor Ever Made](https://smarthomescene.com/reviews/apollo-msr-2-review-the-smallest-presence-sensor-ever-made/) \ No newline at end of file diff --git a/docs/homey/products/msr2/msr2-reviews.md b/docs/homey/products/msr2/msr2-reviews.md index 04fce09dd1..d3c797a37b 100755 --- a/docs/homey/products/msr2/msr2-reviews.md +++ b/docs/homey/products/msr2/msr2-reviews.md @@ -1,15 +1,31 @@ --- -title: Simon Says Home Assistant MSR-2 Review -description: "YouTuber reviews and feedback about the MSR-2 sensor from Apollo Automation." +title: MSR-2 reviews +description: "Video and written reviews of the Apollo MSR-2 from YouTubers and smart-home sites." --- -# [Simon Says Home Assistant MSR-2 Review](https://www.youtube.com/watch?v=U4qUhFSAxbk) +# MSR-2 reviews -## [Smart Home Scene MSR-2 Review](https://smarthomescene.com/reviews/apollo-msr-2-review-the-smallest-presence-sensor-ever-made/) +These creators have reviewed the Apollo MSR-2. Each review below is a YouTube video, except Smart Home Scene, which is a written article. -## [Home Tech Innovations MSR-2 Review](https://www.youtube.com/watch?v=K3j2rR2dsY0) +## Simon Says Home Assistant -## [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ) +[Watch "The Apollo MSR2 Presence Sensor is now even smaller!" on YouTube](https://www.youtube.com/watch?v=U4qUhFSAxbk) -## [Smart Home Australia MSR-2 Review](https://www.youtube.com/watch?v=EzVyzFwdgN4) +## Smart Home Scene -## [Michael Leen MSR-2 Review](https://www.youtube.com/watch?v=VdVR8Gs002Q) \ No newline at end of file +[Read "Apollo MSR-2 Review: The Smallest Presence Sensor Ever Made" on Smart Home Scene](https://smarthomescene.com/reviews/apollo-msr-2-review-the-smallest-presence-sensor-ever-made/) + +## Home Tech Innovations + +[Watch "Setup MSR-2 in 3 EASY Steps!" on YouTube](https://www.youtube.com/watch?v=K3j2rR2dsY0) + +## MostlyChris + +[Watch "Even SMALLER Presence Sensor for Home Assistant!" on YouTube](https://www.youtube.com/watch?v=nQpi2n5UWoQ) + +## Smart Home Australia + +[Watch "Apollo MSR2 Radar Motion Sensor - Small just got tiny !!" on YouTube](https://www.youtube.com/watch?v=EzVyzFwdgN4) + +## Michael Leen + +[Watch "Don't Be Fooled By Its Size: Apollo MSR-2 mmWave Multisensor" on YouTube](https://www.youtube.com/watch?v=VdVR8Gs002Q) diff --git a/docs/homey/products/msr2/setup/co2-calibration-for-msr-2.md b/docs/homey/products/msr2/setup/co2-calibration-for-msr-2.md index 2f758a8e11..6ec2c9c3b6 100755 --- a/docs/homey/products/msr2/setup/co2-calibration-for-msr-2.md +++ b/docs/homey/products/msr2/setup/co2-calibration-for-msr-2.md @@ -1,7 +1,7 @@ --- -title: CO2 Calibration For MSR-2 +title: CO2 calibration for MSR-2 description: "CO2 calibration for the MSR-2, covered by the general calibration guide." --- -# CO2 Calibration For MSR-2 +# CO2 calibration for MSR-2 -## 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/homey/products/general/calibrating-and-updating/co2-calibration/) article \ No newline at end of file diff --git a/docs/homey/products/msr2/setup/how-to-change-the-update-frequency-of-sensors.md b/docs/homey/products/msr2/setup/how-to-change-the-update-frequency-of-sensors.md index 9efe6ad0b5..a8543506c7 100755 --- a/docs/homey/products/msr2/setup/how-to-change-the-update-frequency-of-sensors.md +++ b/docs/homey/products/msr2/setup/how-to-change-the-update-frequency-of-sensors.md @@ -1,7 +1,7 @@ --- -title: How To Change The Update Frequency Of Sensors +title: How to change the update frequency of sensors description: "Changing how often the MSR-2 sensors report readings, covered by the general guide." --- -# How To Change The Update Frequency Of Sensors +# How to change the update frequency of sensors -## [How To Change The Update Frequency Of Sensors](https://wiki.apolloautomation.com/products/general/setup/change-the-update-frequency-of-sensors/) \ No newline at end of file +## [How to change the update frequency of sensors](https://wiki.apolloautomation.com/products/general/setup/change-the-update-frequency-of-sensors/) \ 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 fbaaf90537..dc459d24cc 100755 --- a/docs/homey/products/msr2/setup/msr2-general-tips.md +++ b/docs/homey/products/msr2/setup/msr2-general-tips.md @@ -1,14 +1,14 @@ --- -title: General Tips +title: General tips description: "Multiple helpful images for mounting, lux/rgb, and gate and zone visualization." --- -# General Tips +# General tips -## **Light Sensor (LTR-390UV)** +## **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. +When mounting the MSR-2, position it so the center vent slots (outlined in red above) are not covered. This lets more light reach the sensor and keeps the readings accurate. !!! warning "The RGB LED will trigger the Light sensor!" @@ -26,12 +26,12 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount !!! tip "These are some useful hints!" - * The FOV angle is -60 to 60 degrees - 120 degrees total. + * The FOV angle is -60 to 60 degrees (120 degrees total). * Gates are pre-defined by the radar module and are in 0.75 meter increments. * Zones are user-configurable and are in cm. -## **Gate and FOV Visualization** +## **Gate and FOV visualization** -**** +**** - \ No newline at end of file + \ No newline at end of file diff --git a/docs/homey/products/msr2/setup/updating-msr-2-firmware.md b/docs/homey/products/msr2/setup/updating-msr-2-firmware.md index 35d0cfba78..f1eea576c0 100755 --- a/docs/homey/products/msr2/setup/updating-msr-2-firmware.md +++ b/docs/homey/products/msr2/setup/updating-msr-2-firmware.md @@ -1,7 +1,7 @@ --- -title: Updating MSR-2 Firmware +title: Updating MSR-2 firmware description: "Updating MSR-2 firmware, covered by the general firmware update guide." --- -# Updating MSR-2 Firmware +# Updating MSR-2 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 diff --git a/docs/homey/products/msr2/setup/zones-ha.md b/docs/homey/products/msr2/setup/zones-ha.md index 4a899335ef..f007904c18 100755 --- a/docs/homey/products/msr2/setup/zones-ha.md +++ b/docs/homey/products/msr2/setup/zones-ha.md @@ -1,51 +1,125 @@ --- -title: How To Tune mmWave Using Home Assistant -description: "Tune the MSR-2 mmWave radar using Radar Engineering Mode to find which gates cause false triggers and raise their thresholds." +title: Tune the MSR-2 radar from its web page +description: "Use Radar Engineering Mode on your MSR-2's built-in web page to find the radar gates behind false triggers and adjust their thresholds, then check the result in Homey." --- -# How To Tune mmWave Using Home Assistant +# Tune the MSR-2 radar from its web page -If you're experiencing false triggers, we recommend using Radar Engineering Mode (REM) to monitor the gate energy and adjust the gate threshold to eliminate them. - -Here is a quick introduction video of the ld2410b gates and zones. +The radar in your Apollo MSR-2 divides the room into gates: bands 0.75 m deep that reach out to 6 m from the sensor. Each gate has a move threshold and a still threshold, the amount of radar energy it takes to count as a person. If your MSR-2 reports presence in an empty room, or loses you while you sit still, adjusting those thresholds fixes it. Radar Engineering Mode (REM) shows the live energy in every gate, so you can see which gate is causing the trouble. +!!! note "Before you start" -Here is a video of how to tune the mmWave sensor using radar engineering mode, + - Connect your MSR-2 to Wi-Fi and add it to Homey. See [Getting started](../../../general/setup/getting-started-msr2/). + - Have a phone or computer on the same network as your MSR-2. You tune the radar in a web browser. +!!! tip "Why you tune on the web page, not in Homey" -1. Open Home Assistant -2. Navigate to Settings>Devices & services>ESPHome>Select the MSR-2 -3. Scroll down to the Configuration section -4. Turn on Radar Engineering Mode (REM) -  -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. -  + The Apollo Automation app for Homey doesn't show the gate thresholds, Radar Engineering Mode, or the gate energy readings. Your MSR-2 has a built-in web page with all three. The thresholds you set there are stored in the radar itself, so the presence readings on your MSR-2 in Homey follow them. -**Alternate Method** +## Watch the videos -Thanks to [MakeItWorkTech](https://www.youtube.com/@makeitworktech) for this method! +Two short videos from Apollo cover the basics. The first explains the radar's gates and zones, and the second shows how to tune it with Radar Engineering Mode. Both use the MSR-1, which has the same LD2410B radar as your MSR-2. If a video tunes the radar in Home Assistant, follow along on your MSR-2's web page instead, using the steps below. -"I ended up maxing out the sliders on all gates and then bringing them down just enough to pick up human presence. Definitely easier than using the LD2410B app." + -**Example** + -\- You may have an open-concept kitchen and living room, and you want the MSR-1 to activate your under-cabinet lights only when you're in the kitchen. +## Open your MSR-2's web page -Here's how: +Your MSR-2 serves its own web page on your network, with the sensor's controls and readings. You open it in any browser with the sensor's `.local` address. -1. Stand in the desired trigger locations. -2. Observe the gate energy. -3. Adjust the gate threshold slider to the right, increasing the energy required to trigger the mmWave sensor. This ensures that your kitchen lights only come on when you're actually in the kitchen, not just walking by in the living room. Also, you can lower the gate threshold in the kitchen by moving the slider to the left. This makes the mmWave sensor more sensitive, even when standing still. This way, you avoid having the lights go off while reading a recipe or doing the dishes. +1. In the Homey app, open your MSR-2 and note the last 6 characters of its name. For example, **Apollo MSR-2 c64a28** gives you `c64a28`. +2. In a browser on the same network, go to `http://apollo-msr-2-c64a28.local/`, using your own 6 characters. -\- From clarinetJWD, "Engineering mode is what I was missing at first. I did exactly that, and now detection is basically perfect! My under cabinet lights now come on to max brightness whenever someone is in the kitchen, and return to their previous value when they leave. Next up is replacing the really flaky motion switch in my garage so it stops shutting off when I'm doing a project at the workbench! Thanks, these are really good. +The page opens with your MSR-2's readings and controls, grouped into sections such as **Configuration** and **Diagnostic**. -**References** +!!! tip "If the .local address doesn't load" -- [https://youtu.be/dAzHXpP3FcI?t=431](https://youtu.be/dAzHXpP3FcI?t=431) -- [https://community.home-assistant.io/t/ld2410-esphome-tips/477058/316](https://community.home-assistant.io/t/ld2410-esphome-tips/477058/316) -- [https://www.youtube.com/watch?v=l212Lvo1R6s](https://www.youtube.com/watch?v=l212Lvo1R6s) \ No newline at end of file + Some networks and browsers can't open `.local` addresses, and a renamed device no longer shows the 6 characters. Use the IP address instead and go to `http://
+ [GPIO LED Strip Tutorial](../../msr2/examples/gpio-header-control-an-led-strip.md) \ No newline at end of file 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 eccc4f0556..20f53363f8 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 @@ -1,8 +1,10 @@ --- -title: adding Rear Male USB to MTR-1 +title: Adding rear male USB to MTR-1 description: Step by step tutorial for adding the Rear Male USB addon to the MTR-1. --- -# Adding Rear male USB-C To MTR-1 +# Adding rear male USB-C to MTR-1 + +You'll seat the Rear Male USB-C addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it. 1\. Unplug your MTR-1 from power and remove the stand if attached. diff --git a/docs/homey/products/mtr1/examples/crookedtoe-mtr1.md b/docs/homey/products/mtr1/examples/crookedtoe-mtr1.md index 18ae4a0aeb..842d4f0c56 100755 --- a/docs/homey/products/mtr1/examples/crookedtoe-mtr1.md +++ b/docs/homey/products/mtr1/examples/crookedtoe-mtr1.md @@ -1,7 +1,7 @@ --- -title: MTR-1 Corner Mount STL by user CrookedToe +title: MTR-1 corner mount STL by user CrookedToe description: "MTR-1 Corner Mount STL file" --- -# MTR-1 Corner Mount STL by user CrookedToe +# MTR-1 corner mount STL by user CrookedToe ## [https://www.printables.com/model/941493-mtr-1-inside-corner-mount](https://www.printables.com/model/941493-mtr-1-inside-corner-mount) \ 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 deleted file mode 100755 index 852613bd33..0000000000 --- a/docs/homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: MTR-1 Home Assistant Dashboard Examples -description: "Example dashboard cards for the MTR-1, including an ApexCharts radar scatter plot you can copy and paste." ---- -# MTR-1 Home Assistant Dashboard Examples - -**Radar Scatter Plot With Apex Charts** - - - - -```plaintext -type: custom:apexcharts-card -header: - show: true - title: MTR-1 Radar Distance - show_states: true - colorize_states: true -apex_config: - legend: - position: top - horizontalAlign: center - offsetX: -80 - offsetY: 0 -experimental: - brush: true -brush: - selection_span: 4h -graph_span: 24hr -chart_type: scatter -series: - - entity: sensor.apollo_mtr_1_a79e14_radar_detection_distance - name: Detection - stroke_width: 1 - color: green - show: - in_brush: true - extremas: true - - entity: sensor.apollo_mtr_1_a79e14_radar_moving_distance - name: Moving - stroke_width: 1 - - entity: sensor.apollo_mtr_1_a79e14_radar_still_distance - name: Still - stroke_width: 1 -``` - -**CO2 Charts** -Home Assistant Sensor - - - -```plaintext -graph: line -type: sensor -entity: sensor.apollo_mtr_1_a79e38_co2 -detail: 2 -name: Bedroom CO2 -hours_to_show: 24 -``` - -Custom: Plotly Graph Card - - - -```plaintext -type: custom:plotly-graph -entities: - - entity: sensor.apollo_mtr_1_a79e38_co2 -hours_to_show: 24 -refresh_interval: 10 -title: Bedroom CO2 -``` - -Home Assistant Gauge - - - -```plaintext -type: gauge -entity: sensor.apollo_mtr_1_a79e38_co2 -needle: true -unit: ppm -min: 0 -max: 3000 -severity: - green: 0 - yellow: 1000 - red: 2000 -``` \ No newline at end of file diff --git a/docs/homey/products/mtr1/examples/mtr1-alarmo.md b/docs/homey/products/mtr1/examples/mtr1-alarmo.md index 2ab0e3ad13..e01042a76f 100755 --- a/docs/homey/products/mtr1/examples/mtr1-alarmo.md +++ b/docs/homey/products/mtr1/examples/mtr1-alarmo.md @@ -1,38 +1,53 @@ --- -title: MTR-1 + Alarmo Home Security Install -description: "MTR-1 Alarmo setup" +title: MTR-1 + Alarmo home security install +description: "Build a fully local home security system with no monthly subscription, using the Apollo MTR-1 and the Alarmo integration for Home Assistant." --- -# MTR-1 + Alarmo Home Security Install - -My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo add-on, quickly and easily allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA. - -1\. Install [HACS](https://hacs.xyz/docs/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. Under 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. - -We hope this was helpful and please let us know if there are any questions! \ No newline at end of file +# MTR-1 + Alarmo home security install + +My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So I set up three of our Apollo Automation mmWave sensors with the Alarmo integration. Together, they quickly gave her a fully local, private, cloud-free security system with no monthly subscription. She can arm and disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. + +This guide shows you how to build the same system with your Apollo MTR-1. + +!!! note "Before you start" + + This guide is for Home Assistant. Alarmo is a Home Assistant integration, so these steps don't apply to Homey. You need a motion or presence sensor, such as your MTR-1, already set up in Home Assistant. + +Follow these steps to install Alarmo, choose the sensors that trigger your alarm, and decide what happens when it goes off. + +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). The Alarmo Card adds a good-looking arm and disarm card to your Home Assistant dashboard. + + + + + +3\. Open **Alarmo** from the sidebar on the left, select the **Sensors** tab, and turn on the sensor entities you want your alarm system to use. + + + +*Shown with MSR-1 sensors; add your MTR-1 target entities the same way.* + +4\. Select the **Actions** tab. Under **Condition → Event**, select **Alarm is triggered**. To choose which device gets the notification, such as your phone or tablet, select it under **Task → Target**. + + + +5\. Optionally, change the **Title**, **Message**, and **Name** of the alarm notification. + + + +6\. Save that action, then add another one. A second action can turn on your sensors' lights, make their onboard piezo buzzers play an alarm sound, or both. This guide sets up the lights: under **Entity**, select your sensors' RGB light. + + + +*Shown with AIR-1 and MSR-1 lights; pick your MTR-1 RGB light the same way.* + +7\. Under **Action**, select **Turn On**. Your sensors' RGB lights now turn on whenever the alarm is triggered. + + + +*Shown with AIR-1 and MSR-1 lights; the MTR-1 steps are the same.* + +That's it, seriously. You now have a free, local security system that sends you an alert and lights up your sensors when the alarm is triggered. + +We hope this was helpful. If you have any questions, please let us know! diff --git a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md b/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md deleted file mode 100755 index a470d6284a..0000000000 --- a/docs/homey/products/mtr1/examples/using-mtr-1-buzzer.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Using MTR-1 Buzzer -description: "Trigger the MTR-1 buzzer from developer tools, then reuse the same call in an automation." ---- -# Using MTR-1 Buzzer - -This guide will walk you through using the buzzer on your MTR-1. You can also use the "action" in an automation in Home Assistant. - -1. Open Home Assistant and navigate to developer tools in the bottom left - - - -2\. Click on services - -3\. Choose your MTR-1's buzzer (You can type in buzzer to find it easier) - -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 - ``` - - Cantina: ``` - Cantina:d=4,o=5,b=250:8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,a,8a,8g#,8a,g,8f#,8g,8f#,f.,8d.,16p,p.,8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,8a,8p,8g,8p,g.,8f#,8g,8p,8c6,a#,a,g - ``` - - Star Wars Imperial Death March: ``` - 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 rtttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/) - -5\. Click on the ACTIONS button in bottom right - - \ No newline at end of file diff --git a/docs/homey/products/mtr1/faq.md b/docs/homey/products/mtr1/faq.md index 8dbc852d39..52bd38994e 100755 --- a/docs/homey/products/mtr1/faq.md +++ b/docs/homey/products/mtr1/faq.md @@ -1,7 +1,9 @@ --- -title: FAQ -description: "Frequently asked questions about the MTR-1 mmWave sensor." +title: MTR-1 FAQ +description: "Answers to common questions about the MTR-1 multi-target mmWave sensor with Homey: sensors, radar regions, flows, reporting, and firmware." --- +# MTR-1 FAQ + 1\. **What sensors are included in the MTR-1?** * The MTR-1 includes a multi-target mmWave radar sensor for detecting motion and positioning, as well as LUX, UV, temperature, and pressure sensors. There’s also an optional CO2 sensor available. @@ -16,7 +18,7 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." 4\. **What is the maximum detection range of the mmWave radar?** -* The mmWave radar sensor in the MTR-1 has a maximum detection range of 6 meters (about 19.6 feet), making it ideal for monitoring large rooms or spaces. +* The mmWave radar sensor in the MTR-1 has a maximum detection range of 6 meters (about 19.7 feet), making it ideal for monitoring large rooms or spaces. 5\. **Can the MTR-1 be used to track the exact location of people in a room?** @@ -34,21 +36,29 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." * The MTR-1 can be used to automate lights based on people’s presence in a room, trigger alarms or notifications when someone enters a space, and adjust HVAC settings based on CO2 levels. Its precise tracking capabilities also make it great for monitoring multiple zones within a room, such as distinguishing when someone is at the stove versus the sink. -9\. **How do I connect the MTR-1 to Home Assistant?** +9\. **How do I connect the MTR-1 to Homey?** + +* The MTR-1 joins your Wi-Fi, and the Apollo Automation app for Homey talks to it directly over your local network through the ESPHome native API, with no cloud account. Once you add it, every sensor's readings show up on the device in Homey, ready for flows and Insights. The app runs on Homey Pro; Homey Cloud isn't supported. + +10\. **What kind of flows can I set up with the MTR-1?** + +* Flows can start from presence, from a region of the room, or from any reading. Turn lights on and off as people come and go, run an air purifier when CO2 rises (with the CO2 addon), or get a notification when someone walks into a doorway. +* Draw regions with the **Radar regions** widget, and every detect region works with the region flow cards **A region became occupied**, **A region became empty**, and **A region is occupied**. Because the MTR-1 tracks up to three people, a region can react to someone walking over to the desk even while someone else is on the couch. -* 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. +!!! success "Next step: build your first region flow" -10\. **What kind of automations can I set up with the MTR-1?** + Draw a region with the [Zone Mapper tool](../setup/mtr-1-zone-mapper-tool/), then make it do something: the step-by-step guide walks you through a flow that turns a light on when someone enters a region and off when they leave. -* You can create automations for turning lights on/off based on motion, adjusting air filtration when CO2 levels rise, and sending notifications when specific zones (like doorways) detect movement. The multi-target tracking allows for even more advanced automations, such as adjusting lights depending on where people are in the room. + [Turn on a light when someone enters a region](../../general/tutorials/region-light-flow-example/){ .md-button .md-button--primary } 11\. **How do I adjust the sensitivity of the motion detection?** -* Sensitivity can NOT be adjusted via the ESPHome configuration. The MTR-1 LD2450 mmWave sensor cannot be tuned like the MSR-2 can. The MTR-1 can set zones and track multiple users instead. +* The MTR-1's LD2450 radar has no sensitivity settings to tune, unlike the radar in the MSR-2. Shape detection with regions instead: draw the areas you care about in the **Radar regions** widget, and mark spots that cause false detections, such as a fan or a curtain, as **Ignore this area**. An ignored area hides targets from your detect regions, so build your flows on the regions. +* To change how long presence holds after someone leaves, set **Timeout** (in seconds) under **Radar tuning (MTR-1 / R PRO-1)** in the device's **Settings** in the Homey app. 12\. **Can the MTR-1 detect motion through walls?** -* Yes, the mmWave radar in the MTR-1 can detect movement through certain materials, such as light walls or thin furniture, though you may need to adjust the zones to prevent false positives from nearby rooms. [Please visit the tuning articles for more info](https://wiki.apolloautomation.com/products/mtr1/setup/zones-ha/)! +* Yes, the mmWave radar in the MTR-1 can detect movement through certain materials, such as light walls or thin furniture. If a neighboring room triggers it, keep your detect regions inside the room, or draw a region set to **Ignore this area** over the spot. See the [Zone Mapper tool](../setup/mtr-1-zone-mapper-tool/) guide. 13\. **Can the MTR-1 be used outdoors?** @@ -56,7 +66,7 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." 14\. **Does the MTR-1 work with other smart home platforms?** -* The MTR-1 is designed to work seamlessly with Home Assistant via ESPHome. While it could potentially be integrated into other smart home platforms through custom configurations, its primary use case is for Home Assistant. +* Yes. Besides Homey (through the Apollo Automation app), the MTR-1 works with Home Assistant and with other platforms that support the ESPHome API. See [Supported platforms](../../general/supported-platforms/). 15\. **How does the temperature and pressure sensor work?** @@ -68,7 +78,8 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." 17\. **What is the purpose of the RGB LED and piezo buzzer?** -* The RGB LED can display different colors for various events or alerts, such as turning red when air quality is poor or green for general notifications. The piezo buzzer can be used for sound alerts, such as a beep when motion is detected or a CO2 level warning. +* The RGB LED is the MTR-1's light in Homey. Turn it on or off, dim it, or change its color from the device or in a flow, for example red when CO2 is high or green for a general notification. +* The piezo buzzer is played through an ESPHome action, and the Apollo Automation app has no flow card for it, so Homey can't sound the buzzer. If you also run Home Assistant, it can: see the [piezo buzzer guide](../../../../products/general/piezo/). 18\. **Can I customize the MTR-1’s features?** @@ -76,11 +87,12 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." 19\. **What is the reporting frequency of the MTR-1’s sensors?** -* The reporting frequency for each sensor can be adjusted through the ESPHome YAML configuration. You can choose to report data as frequently as every second or extend the intervals to reduce power consumption. +* The radar reports as people move. The other sensors report on intervals set in the firmware: by default, CO2 every 60 seconds and pressure and temperature every 30 seconds. Homey has no setting for these intervals. +* The light and UV interval is the one you can change without editing the firmware: set **LTR390 Update Interval** (1 to 300 seconds, 60 by default) on the sensor's own web page. In a browser, open `http://apollo-mtr-1-xxxxxx.local`, where `xxxxxx` is the last 6 characters of the device's name in Homey. Changing the other intervals means editing the firmware with ESPHome. 20\. **Can I use multiple MTR-1 sensors in my smart home setup?** -* Yes, you can integrate multiple MTR-1 sensors into your Home Assistant system. Each will show up as a separate entity, allowing you to monitor multiple rooms or areas in your home simultaneously. +* Yes. Add each MTR-1 with the Apollo Automation app. Each one shows up as its own device in Homey with its own readings, so you can monitor several rooms at the same time. The **Radar regions** widget works per device, so add one widget for each MTR-1. 21\. **What’s the difference between the MTR-1 and MSR-2?** @@ -96,7 +108,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 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. +* Power the MTR-1 over USB-C, connect it to your Wi-Fi through its hotspot, then add it in Homey with the Apollo Automation app. The [getting started guide](../../general/setup/getting-started-mtr1/) walks you through each step, and we offer support via our Discord community. 25\. **How secure is the MTR-1?** @@ -104,11 +116,12 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." 26\. **Does the MTR-1 require cloud connectivity?** -* No, the MTR-1 works entirely within your local network through Home Assistant and ESPHome. You don’t need cloud access or a subscription to use the sensor. +* No. The MTR-1 talks to Homey directly over your local network through the ESPHome native API. You don’t need cloud access or a subscription to use the sensor. 27\. **How do I update the firmware on the MTR-1?** -* Firmware updates for the MTR-1 can be done directly through ESPHome. When updates are available, you can install them wirelessly over-the-air (OTA), making it simple to keep the sensor up to date. +* Homey doesn't install firmware updates: the Apollo Automation app reads and controls the MTR-1 but has no update action. To put new firmware on, flash it over USB with the Apollo installer, as described in [Factory re-flash MTR-1](../troubleshooting/mtr1-code/), then add the sensor to Homey again. +* If you also run Home Assistant, ESPHome can update the MTR-1 over the air instead. See [Updating firmware](../../../../products/general/calibrating-and-updating/updating-firmware/). 28\. **What is the warranty on the MTR-1?** @@ -116,8 +129,8 @@ description: "Frequently asked questions about the MTR-1 mmWave sensor." 29\. **How long does it take to set up the MTR-1?** -* Setup is quick and easy. Most users report being able to configure and integrate the MTR-1 into their Home Assistant setup within 10-15 minutes. +* Plan on 10 to 15 minutes to connect the MTR-1 to your Wi-Fi and add it to Homey. 30\. **What’s in the box?** -* Each MTR-1 package includes the assembled board, case, support stand, and a link to documentation, open-source code, and CAD models. Additionally, you’ll receive an Apollo Automation sticker. \ No newline at end of file +* Each MTR-1 package includes the assembled board, case, support stand, and a link to documentation, open-source code, and CAD models. Additionally, you’ll receive an Apollo Automation sticker. diff --git a/docs/homey/products/mtr1/mtr-1-reviews/home-tech-innovations-mtr-1-review.md b/docs/homey/products/mtr1/mtr-1-reviews/home-tech-innovations-mtr-1-review.md index 9ab6ac9986..75580287b0 100755 --- a/docs/homey/products/mtr1/mtr-1-reviews/home-tech-innovations-mtr-1-review.md +++ b/docs/homey/products/mtr1/mtr-1-reviews/home-tech-innovations-mtr-1-review.md @@ -1,8 +1,14 @@ --- -title: Home Tech Innovations MTR-1 Review +title: Home Tech Innovations MTR-1 review description: "Home Tech Innovations sets up the Apollo MTR-1 in three steps." --- -# Home Tech Innovations MTR-1 Review +# Home Tech Innovations MTR-1 review -> #### Setup MTR-1 in 3 EASY Steps! +Home Tech Innovations walks through setting up the Apollo MTR-1 multi-target radar in three steps. + + +Watch [Setup MTR-1 in 3 EASY Steps!](https://youtu.be/q5GejbxnByA?si=PMgK4ro6U8Q7idCm) on YouTube. diff --git a/docs/homey/products/mtr1/mtr-1-reviews/michael-leen-mtr-1-review.md b/docs/homey/products/mtr1/mtr-1-reviews/michael-leen-mtr-1-review.md index 3193ba63b3..43dde6c3ae 100755 --- a/docs/homey/products/mtr1/mtr-1-reviews/michael-leen-mtr-1-review.md +++ b/docs/homey/products/mtr1/mtr-1-reviews/michael-leen-mtr-1-review.md @@ -1,8 +1,14 @@ --- -title: Michael Leen MTR-1 Review +title: Michael Leen MTR-1 review description: "Michael Leen reviews presence detection on the Apollo MTR-1 multi-target radar." --- -# Michael Leen MTR-1 Review +# Michael Leen MTR-1 review -## PRECISE Presence Detection: Apollo MTR-1 Multi-Target Radar +Michael Leen reviews presence detection on the Apollo MTR-1 multi-target radar. + + +Watch [PRECISE Presence Detection: Apollo MTR-1 Multi-Target Radar](https://www.youtube.com/watch?v=7qFvqRw1uds) on YouTube. diff --git a/docs/homey/products/mtr1/mtr-1-reviews/simon-says-home-assistant-mtr-1-review.md b/docs/homey/products/mtr1/mtr-1-reviews/simon-says-home-assistant-mtr-1-review.md index 19ca249bbf..bd6dd6512d 100755 --- a/docs/homey/products/mtr1/mtr-1-reviews/simon-says-home-assistant-mtr-1-review.md +++ b/docs/homey/products/mtr1/mtr-1-reviews/simon-says-home-assistant-mtr-1-review.md @@ -1,8 +1,14 @@ --- -title: Simon Says Home Assistant MTR-1 Review +title: Simon Says Home Assistant MTR-1 review description: "Simon Says Home Assistant reviews the Apollo MTR-1 multi-target radar." --- -# Simon Says Home Assistant MTR-1 Review +# Simon Says Home Assistant MTR-1 review -> #### New Apollo MTR-1 Multi-target Radar For Home Assistant (ld2450) +Simon Says Home Assistant reviews the Apollo MTR-1 multi-target radar. The video is made for Home Assistant users, so any setup it shows is for Home Assistant, not Homey. + + +Watch [New Apollo MTR-1 Multi-target Radar For Home Assistant (ld2450)](https://www.youtube.com/watch?v=FFN-vIkDRLk) on YouTube. diff --git a/docs/homey/products/mtr1/mtr-1-reviews/smart-home-australia-mtr-1-review.md b/docs/homey/products/mtr1/mtr-1-reviews/smart-home-australia-mtr-1-review.md index 2cd7f96605..a18ed5c205 100755 --- a/docs/homey/products/mtr1/mtr-1-reviews/smart-home-australia-mtr-1-review.md +++ b/docs/homey/products/mtr1/mtr-1-reviews/smart-home-australia-mtr-1-review.md @@ -1,8 +1,14 @@ --- -title: Smart Home Australia MTR-1 Review +title: Smart Home Australia MTR-1 review description: "Smart Home Australia reviews the Apollo MTR-1, from installation through dashboards." --- -# Smart Home Australia MTR-1 Review +# Smart Home Australia MTR-1 review -> #### NEW Apollo MTR-1: mmWare sensor: Review, Home Assistant installation, dashboard and conclusion +Smart Home Australia reviews the Apollo MTR-1, installs it in Home Assistant, shows a dashboard, and shares their conclusion. The installation in this video is for Home Assistant, not Homey. + + +Watch [NEW Apollo MTR-1: mmWare sensor: Review, Home Assistant installation, dashboard and conclusion](https://www.youtube.com/watch?v=xyxgk7WGHCY) on YouTube. diff --git a/docs/homey/products/mtr1/mtr-1-reviews/smart-home-scene-mtr-1-review.md b/docs/homey/products/mtr1/mtr-1-reviews/smart-home-scene-mtr-1-review.md index 0beadc5390..cb2186ff03 100755 --- a/docs/homey/products/mtr1/mtr-1-reviews/smart-home-scene-mtr-1-review.md +++ b/docs/homey/products/mtr1/mtr-1-reviews/smart-home-scene-mtr-1-review.md @@ -1,9 +1,9 @@ --- -title: Smart Home Scene MTR-1 Review +title: Smart Home Scene MTR-1 review description: "The Smart Home Scene written review of the Apollo MTR-1 multi-target tracking radar." --- -# Smart Home Scene MTR-1 Review +# Smart Home Scene MTR-1 review > #### 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/) \ No newline at end of file +## [Smart Home Scene MTR-1 review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) \ No newline at end of file diff --git a/docs/homey/products/mtr1/mtr1-reviews.md b/docs/homey/products/mtr1/mtr1-reviews.md index d8646f5b5d..e4321af7d9 100755 --- a/docs/homey/products/mtr1/mtr1-reviews.md +++ b/docs/homey/products/mtr1/mtr1-reviews.md @@ -1,13 +1,27 @@ --- -title: Home Tech Innovations MTR-1 Review -description: "YouTuber reviews and feedback about the MTR-1 sensor from Apollo Automation." +title: MTR-1 reviews +description: "Video and written reviews of the Apollo MTR-1 from YouTubers and smart-home sites." --- -# [Home Tech Innovations MTR-1 Review](https://youtu.be/q5GejbxnByA?si=PMgK4ro6U8Q7idCm) +# MTR-1 reviews -## [Simon Says Home Assistant MTR-1 Review](https://www.youtube.com/watch?v=FFN-vIkDRLk) +These creators have reviewed the Apollo MTR-1. Each review below is a YouTube video, except Smart Home Scene, which is a written article. -## [Smart Home Australia MTR-1 Review](https://www.youtube.com/watch?v=xyxgk7WGHCY) +## Home Tech Innovations -## [Smart Home Scene MTR-1 Review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) +[Watch the Home Tech Innovations review on YouTube](https://youtu.be/q5GejbxnByA?si=PMgK4ro6U8Q7idCm) -## [Michael Leen MTR-1 Review](https://www.youtube.com/watch?v=7qFvqRw1uds) \ No newline at end of file +## Simon Says Home Assistant + +[Watch the Simon Says Home Assistant review on YouTube](https://www.youtube.com/watch?v=FFN-vIkDRLk) + +## Smart Home Australia + +[Watch the Smart Home Australia review on YouTube](https://www.youtube.com/watch?v=xyxgk7WGHCY) + +## Smart Home Scene + +[Read the Smart Home Scene review](https://smarthomescene.com/reviews/apollo-mtr-1-multi-target-tracking-radar-review/) + +## Michael Leen + +[Watch the Michael Leen review on YouTube](https://www.youtube.com/watch?v=7qFvqRw1uds) diff --git a/docs/homey/products/mtr1/setup/co2-calibration-for-mtr-1.md b/docs/homey/products/mtr1/setup/co2-calibration-for-mtr-1.md index edc004c3b6..324e5aad5b 100755 --- a/docs/homey/products/mtr1/setup/co2-calibration-for-mtr-1.md +++ b/docs/homey/products/mtr1/setup/co2-calibration-for-mtr-1.md @@ -1,7 +1,7 @@ --- -title: CO2 Calibration For MTR-1 +title: CO2 calibration for MTR-1 description: "CO2 calibration for the MTR-1, covered by the general calibration guide." --- -# CO2 Calibration For MTR-1 +# CO2 calibration for MTR-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/homey/products/general/calibrating-and-updating/co2-calibration/) article \ 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 94a42bca94..0cccc7429c 100755 --- a/docs/homey/products/mtr1/setup/general-tips.md +++ b/docs/homey/products/mtr1/setup/general-tips.md @@ -1,13 +1,13 @@ --- -title: General Tips +title: General tips description: "Multiple helpful images for mounting, lux/rgb, and zone visualization." --- -## **MTR-1 PCB with Sensors** +## **MTR-1 PCB with sensors**  -## **Light Sensor (LTR-390UV)** +## **Light sensor (LTR-390UV)**  @@ -19,23 +19,23 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak  -## **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! @@ -43,4 +43,8 @@ The Wi-Fi interface of all ESP32 devices offers three power save modes to reduce wifi: # ... power_save_mode: none -``` \ No newline at end of file +``` + +!!! note "Changing these settings needs ESPHome Device Builder" + + Homey can't edit your MTR-1's YAML. To change the Wi-Fi power save mode, use the [standalone ESPHome Device Builder](https://esphome.io/guides/installing_esphome/). It runs on a computer, so you don't need Home Assistant. For the edit and install steps, see [Adding Apollo Devices To Hidden Networks](/homey/products/general/setup/adding-apollo-devices-to-hidden-networks.md). \ No newline at end of file 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 0b62981839..a87c04fcb0 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 @@ -1,12 +1,38 @@ --- -title: "MTR-1 Temperature & Humidity Offsets" +title: "MTR-1 temperature and humidity offsets" description: "Add temperature and humidity offsets to your MTR-1 so its readings match the room it sits in." --- -# MTR-1 Temperature & Humidity Offsets +# MTR-1 temperature and humidity offsets -## **Simple Offsets for Temperature and Humidity:** +Heat from the ESP chip inside the Apollo MTR-1 can skew the temperature and humidity readings from the DPS310 and SCD40 sensors. This page explains why, shows you how to add offsets that correct them, and covers advanced options for even better accuracy. -**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!** +!!! note "Before you start" + + This guide uses ESPHome and Home Assistant. You add YAML to your MTR-1's ESPHome configuration, then enter the offsets on the MTR-1's device page in the Home Assistant ESPHome integration. The advanced options also use Home Assistant template sensors and automations. + +## Why the readings need offsets + +The DPS310 and SCD40 sensors are known for their precision in measuring temperature and humidity. Like any sensor, though, they can sometimes give inaccurate readings. For these two sensors, one significant cause is heat from the ESP chip, which changes the environment inside the enclosure and skews the readings. + +Temperature and humidity are also linked. When the air temperature rises, the air can hold more moisture, which can lower the relative humidity. When the temperature falls, the air can hold less moisture, which raises the humidity. This relationship plays a big part in how the sensors detect and interpret readings, which makes accuracy even more important. + +## How the offsets work + +You can adjust the DPS310 and SCD40 temperature offset entities by hand to match the conditions in your home. The firmware subtracts each offset from the raw temperature or humidity reading, and the result is what the Home Assistant entity shows. For example: + +`scd40_temperature` entity = raw SCD40 temperature reading - `scd40_offset` + +By default, the offsets are preset to values based on Apollo's NIST-certified thermometer. Those values are calibrated for Apollo's environment, so they might not be accurate in your home. Use a reference thermometer, and adjust the offset by the difference between its reading and the MTR-1's. + +You'll also see the `dps310_temperature_calibrated`, `scd40_humidity_calibrated`, and `scd40_temperature_calibrated` entities. These use the linear filter in the ESPHome firmware to adjust the readings based on Apollo's collected data. Because every environment is different, these might not always be precise either. + +## Add simple offsets + +These steps add two boxes to your MTR-1's device page in Home Assistant, one for a humidity offset and one for a temperature offset. + +1\. Open your MTR-1's YAML in ESPHome Device Builder. + +2\. Add this YAML to the bottom of the file: ```yaml sensor: @@ -49,23 +75,23 @@ number: mode: box ``` -## **DPS310 & SCD40 Sensors: Overcoming Temperature & Humidity Reading Challenges** +3\. Click **Save**, then **Install**. + +4\. Open your MTR-1's device page in the Home Assistant ESPHome integration and fill in the two new offset boxes. + +5\. Give the new offsets up to 1 minute to take effect. -The DPS310 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 DPS310 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. +Your MTR-1's temperature and humidity readings now include your offsets, and you can fine-tune them from the device page at any time. -## **Adjusting the DPS310 and SCD40 Temperature Offset** +## Advanced options -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. +If simple offsets aren't accurate enough, these options go further. -## **Modeling the Relationship Between Sensors** +### Model 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. +Another way to get accurate readings is to model how the ESP temperature and the other sensors relate to a reference temperature. You do this with a template sensor in Home Assistant that uses a decision tree or Apollo's regression coefficients. -Here's an example that can be added to a configuration YAML: +Add the example below to your Home Assistant configuration YAML. Replace xxxxxx with the 6-character suffix of your MTR-1. The coefficients come from Apollo's MSR-1 testing, so treat them as a starting point. ```plaintext sensor: @@ -76,10 +102,10 @@ sensor: unit_of_measurement: '°C' value_template: > {{ - 0.3228 * states('sensor.apollo_msr_1_a79e24_esp_temperature') | float + - 0.8702 * states('sensor.apollo_msr_1_a79e24_scd40_temperature') | float + - -0.1285 * states('sensor.apollo_msr_1_a79e24_dps310_temperature') | float + - -0.0491 * states('sensor.apollo_msr_1_a79e24_scd40_humidity') | float + + 0.3228 * states('sensor.apollo_mtr_1_xxxxxx_esp_temperature') | float + + 0.8702 * states('sensor.apollo_mtr_1_xxxxxx_scd40_temperature') | float + + -0.1285 * states('sensor.apollo_mtr_1_xxxxxx_dps310_temperature') | float + + -0.0491 * states('sensor.apollo_mtr_1_xxxxxx_scd40_humidity') | float + 0.0851 }} @@ -89,16 +115,19 @@ sensor: unit_of_measurement: '%' value_template: > {{ - -1.2468 * states('sensor.apollo_msr_1_a79e24_esp_temperature') | float + - -2.1959 * states('sensor.apollo_msr_1_a79e24_scd40_temperature') | float + - 2.9604 * states('sensor.apollo_msr_1_a79e24_dps310_temperature') | float + - 0.2380 * states('sensor.apollo_msr_1_a79e24_scd40_humidity') | float + + -1.2468 * states('sensor.apollo_mtr_1_xxxxxx_esp_temperature') | float + + -2.1959 * states('sensor.apollo_mtr_1_xxxxxx_scd40_temperature') | float + + 2.9604 * states('sensor.apollo_mtr_1_xxxxxx_dps310_temperature') | float + + 0.2380 * states('sensor.apollo_mtr_1_xxxxxx_scd40_humidity') | float + 1.8283 }} ``` +### Log your own data -For users who want to gather their own data with a reference sensor and MSR-2 within their home, we recommend logging data to a CSV using the following YAML entries: +To gather your own data with a reference sensor and your MTR-1 at home, Apollo recommends logging the readings to a CSV file. The automation below writes a row every minute to match the reference sensor. + +The block has two parts. Add the part under `#Configuration.yaml` to your `configuration.yaml` file, and the part under `#Automations.yaml` to your `automations.yaml` file. Replace xxxxxx with the 6-character suffix of your MTR-1 here too. ```plaintext #Configuration.yaml @@ -119,21 +148,16 @@ notify: data_template: message: > {{ now().strftime('%Y-%m-%d %H:%M:%S') }}, - {{ states('sensor.apollo_msr_1_a79e24_esp_temperature') | default('NA') }}, - {{ states('sensor.apollo_msr_1_a79e24_scd40_temperature') | default('NA') }}, - {{ states('sensor.apollo_msr_1_a79e24_dps310_temperature') | default('NA') }}, - {{ states('sensor.apollo_msr_1_a79e24_scd40_humidity') | default('NA') }}, - {{ states('number.apollo_msr_1_a79e24_dps310_temperature_offset') | default('NA') }}, - {{ states('number.apollo_msr_1_a79e24_scd40_humidity_offset') | default('NA') }}, - {{ states('number.apollo_msr_1_a79e24_scd40_temperature_offset') | default('NA') }}, - {{ states('sensor.apollo_msr_1_a79e24_uptime') | default('NA') }} + {{ states('sensor.apollo_mtr_1_xxxxxx_esp_temperature') | default('NA') }}, + {{ states('sensor.apollo_mtr_1_xxxxxx_scd40_temperature') | default('NA') }}, + {{ states('sensor.apollo_mtr_1_xxxxxx_dps310_temperature') | default('NA') }}, + {{ states('sensor.apollo_mtr_1_xxxxxx_scd40_humidity') | default('NA') }}, + {{ states('number.apollo_mtr_1_xxxxxx_dps310_temperature_offset') | default('NA') }}, + {{ states('number.apollo_mtr_1_xxxxxx_scd40_humidity_offset') | default('NA') }}, + {{ states('number.apollo_mtr_1_xxxxxx_scd40_temperature_offset') | default('NA') }}, + {{ states('sensor.apollo_mtr_1_xxxxxx_uptime') | default('NA') }} ``` +### Connect an external sensor with GPIO -## **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** - -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 +For the highest accuracy, connect a temperature and humidity sensor to the exposed mezzanine connector on the back of the Apollo board. This modification can dramatically improve both temperature and humidity readings, giving you data that's as accurate as possible. diff --git a/docs/homey/products/mtr1/setup/updating-mtr-1-firmware.md b/docs/homey/products/mtr1/setup/updating-mtr-1-firmware.md index bdc3355358..ae0242f519 100755 --- a/docs/homey/products/mtr1/setup/updating-mtr-1-firmware.md +++ b/docs/homey/products/mtr1/setup/updating-mtr-1-firmware.md @@ -1,7 +1,7 @@ --- -title: Updating MTR-1 Firmware +title: Updating MTR-1 firmware description: "Updating MTR-1 firmware, covered by the general firmware update guide." --- -# Updating MTR-1 Firmware +# Updating MTR-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 diff --git a/docs/homey/products/mtr1/setup/zones-hlk.md b/docs/homey/products/mtr1/setup/zones-hlk.md index e59da59cdd..036457b577 100755 --- a/docs/homey/products/mtr1/setup/zones-hlk.md +++ b/docs/homey/products/mtr1/setup/zones-hlk.md @@ -1,9 +1,18 @@ --- -title: (Better) HLK Radar Tool App +title: (Better) HLK Radar Tool app description: "Tutorial for MTR-1 HLKRadarTool app Zone Configuration." --- -## Configure Zones +!!! tip "Finding your MTR-1's web server address" + + Some steps below require opening your device's web server in a browser. To find your address: + + 1. In Homey, open your MTR-1 device and note the last 6 characters of its name. For example, **Apollo MTR-1 c64a28** gives you `c64a28`. + 2. Build your URL: `http://apollo-mtr-1-c64a28.local/` + + If the `.local` address doesn't load, use your router to find the device's IP address and use that instead. + +## Configure zones !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -19,7 +28,9 @@ The Click here to download -1\. Head to the ESPHome Integrations page then select your MTR-1 and scroll down until you see LD2450 Bluetooth. +With the app installed, you'll turn on the radar's Bluetooth, connect to it from the HLKRadarTool app, and set up your zones. + +1\. Open your MTR-1's web server (see address tip above), scroll down until you see **LD2450 Bluetooth**, and toggle it on.  @@ -35,19 +46,17 @@ The **Disabled**: Disable zone area detection
**Detection**: Only detects targets in the specified zone
**Filter**: Excludes a zone from detection + You can use any of these three choices to control your MTR-1 differently. The most common option is **Area Detection**, which lets you set up three areas and track three targets within them.
**Close detection** (Disabled on the web server): zone detection is off
**Area Detection** (Detection): only detects targets inside your zones
**Area Filtering** (Filter): ignores targets inside your zones - 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! + Close detection lets you use the sensor as a basic presence sensor, and Area Filtering lets you filter out an area and detect everything else, which is useful to avoid a fan!  -5\. If set up correctly the zones should be saved as different colors. You can double-check that the settings are saved by looking at your HA entities (picture below). You should be all set! - - +5\. If set up correctly the zones should be saved as different colors. You should be all set!  @@ -60,23 +69,4 @@ The If you're unsure of your device name, go to the ESPHome Integrations page, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_mtr\_1\_c64a28", with six random characters at the end. - - - -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! - - \ No newline at end of file diff --git a/docs/homey/products/mtr1/troubleshooting/mtr1-boot-mode.md b/docs/homey/products/mtr1/troubleshooting/mtr1-boot-mode.md index 528ac07e58..7f9def9c1e 100755 --- a/docs/homey/products/mtr1/troubleshooting/mtr1-boot-mode.md +++ b/docs/homey/products/mtr1/troubleshooting/mtr1-boot-mode.md @@ -1,14 +1,16 @@ --- -title: Putting The MTR-1 In Boot Mode +title: Putting the MTR-1 in boot mode description: "Step by step guide for putting The MTR-1 In Boot Mode." --- -# Putting The MTR-1 In Boot Mode +# Putting the MTR-1 in boot mode !!! info "This will cover how to put the MTR-1 into 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 + +You'll hold the boot button while you plug in the USB-C cable. 1\. Position the MTR-1 as shown in the image below and locate the small opening to press the boot button (the right button). @@ -16,11 +18,13 @@ description: "Step by step guide for putting The MTR-1 In Boot Mode." 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 MTR-1 then let go of the button. -3\. Continue with uploading the firmware document. +3\. Continue with uploading the firmware document. + +## Method 2: Boot and reset buttons -## Method 2: Boot and Reset Buttons +You'll use the boot and reset buttons together while the device is plugged into your computer. -1\. Unplug the device and locate the boot and reset buttons as shown in the image above. +1\. Unplug the device and locate the boot button (the right opening, shown in the image above) and the reset button (the left opening, shown in the image below). 2\. Plug it into your computer. @@ -28,4 +32,4 @@ description: "Step by step guide for putting The MTR-1 In Boot Mode."  -4\. Continue with uploading the firmware document. \ No newline at end of file +4\. Continue with 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 28eedab404..a168ece8d2 100755 --- a/docs/homey/products/mtr1/troubleshooting/mtr1-code.md +++ b/docs/homey/products/mtr1/troubleshooting/mtr1-code.md @@ -1,14 +1,14 @@ --- -title: Factory Re-Flash MTR-1 +title: Factory re-flash MTR-1 description: "Step by step guide for re-flashing the MTR-1 back to factory firmware." --- -# Factory Re-Flash MTR-1 +# Factory re-flash MTR-1 !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser. -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. +If your device has already been added to Homey, please remove it from Homey before continuing. 1\. Position the MTR-1 as shown in the image below and locate the small opening to press the boot button (the right button). @@ -18,23 +18,23 @@ If your device has already been connected to Home Assistant please Apollo MTR-1 Installer. -3\. Click the big "Connect" button. +4\. Click the big "Connect" button.  -3\. Select the open com port then click Connect. +5\. Select the open com port then click Connect.  -4\. Click "Install MTR-1". +6\. Click "Install MTR-1".  -5\. Click "INSTALL". +7\. Click "INSTALL".  -6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.  @@ -42,4 +42,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 +9\. Please [proceed to the getting started guide](../../general/setup/getting-started-mtr1.md) and set up your sensor as a new device! \ No newline at end of file diff --git a/docs/homey/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md b/docs/homey/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md index a9707a90f0..92bde90704 100755 --- a/docs/homey/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md +++ b/docs/homey/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials -description: "Step by step guide for resetting the Wi-Fi Credentials on your AIR-1." +title: Reset Wi-Fi credentials +description: "Step by step guide for resetting the Wi-Fi Credentials on your MTR-1." --- -# Reset Wi-Fi Credentials +# Reset Wi-Fi credentials + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the device into power diff --git a/docs/homey/products/mtr1/troubleshooting/mtr1-teardown.md b/docs/homey/products/mtr1/troubleshooting/mtr1-teardown.md index 8051dd8ec6..408c92612d 100755 --- a/docs/homey/products/mtr1/troubleshooting/mtr1-teardown.md +++ b/docs/homey/products/mtr1/troubleshooting/mtr1-teardown.md @@ -1,8 +1,8 @@ --- -title: Teardown and Reassembly of the MTR-1 +title: Teardown and reassembly of the MTR-1 description: "Step by step guide for tearing down your MTR-1 to replace parts, clean it, swap cases, etc." --- -# Teardown and Reassembly of the MTR-1 +# Teardown and reassembly of the MTR-1 diff --git a/docs/homey/products/plt1/examples/flower-card.md b/docs/homey/products/plt1/examples/flower-card.md index 400829088f..a96d461e09 100755 --- a/docs/homey/products/plt1/examples/flower-card.md +++ b/docs/homey/products/plt1/examples/flower-card.md @@ -1,22 +1,40 @@ --- title: Flower Card -description: "Show PLT-1 readings with the Flower Card, using the Plant integration and OpenPlantBook." +description: "Show PLT-1 readings on a Home Assistant dashboard with the Flower Card, the Plant integration, and OpenPlantBook." --- +# Flower Card + +The Flower Card shows a plant's moisture, temperature, light, and humidity as bars on a Home Assistant dashboard. +  -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. +!!! note "Before you start" + + This page is for Home Assistant. The Flower Card is a Home Assistant dashboard card, and it works with the two Home Assistant integrations below: the Plant integration and the Open Plant Book integration. + +## Plant integration + +Home Assistant Plant Integration -Open Plant Book Integration
This integration allows fetching plants information from and uploading plant sensors' data to OpenPlantBook. It creates a few service calls in Home Assistant to interact with OpenPlantbook API which are: +You set up your plants in the Home Assistant UI, and manage all of their configuration there or with automations and scripts. If you're a registered OpenPlantBook user, the integration can fetch plant data from it automatically. Registration is free. + +## Open Plant Book integration + +Open Plant Book Integration + +This integration fetches plant information from OpenPlantBook and uploads your plant sensors' data to it. It adds these service calls to Home Assistant for the OpenPlantbook API: * Search plant * Get plant details * Upload plants sensors data -This is used as a base for the sister-integration [https://github.com/Olen/homeassistant-plant](https://github.com/Olen/homeassistant-plant) which utilizes this API to add threshold values for such as moisture, temperature, conductivity etc. based on the plant species. +Its sister integration, the [Plant integration](https://github.com/Olen/homeassistant-plant), is built on it. The Plant integration uses this API to add threshold values, such as moisture, temperature, and conductivity, based on the plant species. + +## Add the Flower Card Flower Card GitHub -Flower Card Code +Add the card to your dashboard with this YAML. Replace `plant.my_plant` and `sensor.demo_battery` with your own entity IDs. ```yaml type: custom:flower-card @@ -27,4 +45,4 @@ show_bars: - moisture - temperature battery_sensor: sensor.demo_battery -``` \ No newline at end of file +``` diff --git a/docs/homey/products/plt1/faq.md b/docs/homey/products/plt1/faq.md index ceabd7d43d..828c76aed4 100755 --- a/docs/homey/products/plt1/faq.md +++ b/docs/homey/products/plt1/faq.md @@ -1,7 +1,9 @@ --- -title: FAQ -description: "PLT-1 FAQ." +title: PLT-1 FAQ +description: "Answers to common questions about the PLT-1 plant sensor with Homey: sensors, power, connecting to Homey, flows, and how often it reports." --- +# PLT-1 FAQ + 1\. **What sensors are included in the PLT-1?** * The PLT-1 comes with sensors to measure soil moisture, air temperature, humidity, LUX, and UV. There is also an optional DS18b20 waterproof soil temperature probe available for measuring soil temperature. @@ -26,25 +28,32 @@ description: "PLT-1 FAQ." * The PLT-1 is primarily designed for indoor use. While some components, such as the waterproof soil temperature probe, can withstand harsher environments, the main body of the sensor is not rated for outdoor use unless adequately protected. -7\. **How does the PLT-1 connect to Home Assistant?** +7\. **How does the PLT-1 connect to Homey?** + +* The PLT-1 joins your Wi-Fi, and the Apollo Automation app for Homey talks to it directly over your local network through the ESPHome native API, with no cloud account. Once you add it, its readings show up on the device in Homey, ready for flows and Insights. The app runs on Homey Pro; Homey Cloud isn't supported. + +!!! success "Next step: add your PLT-1 to Homey" + + Connect the sensor to your Wi-Fi through its hotspot, then add it with the Apollo Automation app. The getting started guide walks you through both. -* The PLT-1 uses Wi-Fi to connect to your Home Assistant instance through ESPHome. Once connected, you can configure automations, monitor data, and set alerts directly in Home Assistant. + [Get started with Homey](../../general/setup/getting-started-plt1/){ .md-button .md-button--primary } -8\. **What kind of automations can I set up with the PLT-1?** +8\. **What kind of flows can I set up with the PLT-1?** -* You can create automations for plant care, such as setting notifications when soil moisture is low, turning on lights when LUX readings drop below a certain level, or adjusting your HVAC system based on air temperature and humidity around your plants. +* Any PLT-1 reading can start a flow in Homey. For example, send a notification when soil moisture drops, turn on a grow light when the light level falls, or adjust your heating or cooling based on the air temperature and humidity around your plants. 9\. **How often does the PLT-1 send sensor data?** -* The update intervals for each sensor are configurable in ESPHome. For example, you can have the soil moisture sensor report every second or extend it to save battery power in the battery-powered version. +* Most readings update every 60 seconds by default. The intervals are set in the sensor's firmware, and Homey has no setting for them. The light and UV interval is the one you can change without editing the firmware: set **LTR390 Update Interval** (1 to 300 seconds) on the sensor's own web page. In a browser, open `http://apollo-plt-1-xxxxxx.local`, where `xxxxxx` is the last 6 characters of the device's name in Homey. Changing the other intervals means editing the firmware with ESPHome. 10\. **Can I customize the PLT-1’s 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-1. 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?** -* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure. +* The RGB LED is the PLT-1's light in Homey. Turn it on or off, dim it, or change its color from the device or in a flow, for example to glow red when the soil gets dry. +* The piezo buzzer is played through an ESPHome action, and the Apollo Automation app has no flow card for it, so Homey can't sound the buzzer. If you also run Home Assistant, it can: see the [piezo buzzer guide](../../../../products/general/piezo/). 12\. **What is the benefit of using a conformal coating on the soil moisture sensor?** @@ -52,7 +61,7 @@ description: "PLT-1 FAQ." 13\. **What plants are compatible with the PLT-1?** -* Compatible with various indoor plants, the PLT-1B can apply ideal care conditions (e.g., light, humidity, moisture) using Open Plant Book with Home Assistant. +* The PLT-1 works with all kinds of indoor plants. Look up the light, humidity, and soil moisture your plant likes, then use those values as thresholds in your Homey flows, so you hear about it when a reading drifts out of range. 14\. **Can I monitor multiple plants with one PLT-1?** @@ -60,26 +69,26 @@ description: "PLT-1 FAQ." 15\. **What makes the PLT-1 better than other plant sensors?** -* The PLT-1B features a durable capacitive soil moisture sensor, real-time data reporting, and tracks various environmental factors—all in one compact device that integrates seamlessly with Home Assistant. +* The PLT-1 pairs a durable capacitive soil moisture sensor with real-time reporting of several environmental factors, all in one compact device that works with Homey on your local network. 16\. **Is the PLT-1 compatible with other smart home platforms?** -* While designed for Home Assistant via ESPHome, it may be compatible with other platforms using the ESPHome API or MQTT. +* Yes. Besides Homey (through the Apollo Automation app), the PLT-1 works with Home Assistant, and it may work with other platforms through the ESPHome API or MQTT. See [Supported platforms](../../general/supported-platforms/). 17\. **Do I need coding knowledge to use the PLT-1?** -* Basic knowledge of Home Assistant and ESPHome is helpful, but most users can utilize it out of the box. For advanced customization, YAML knowledge is recommended. +* No. Adding the PLT-1 to Homey and building flows takes no code. YAML knowledge only matters if you want to customize the firmware with ESPHome. 18\. **Can I access data from the PLT-1 remotely?** -* Yes, once connected to Home Assistant, you can access your sensor data remotely through your Home Assistant dashboard, provided your setup allows for remote access. +* Yes. The PLT-1 reports to your Homey over your local network, and the Homey app shows its readings wherever you are, as long as your Homey is reachable remotely. -20\. **Can I use multiple PLT-1 sensors in one Home Assistant setup?** +19\. **Can I use multiple PLT-1 sensors with one Homey?** -* Yes, you can add multiple PLT-1B sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces. +* Yes. Add each PLT-1 with the Apollo Automation app. Each one shows up as its own device in Homey, so you can monitor several plants or spaces. -21\. **Optional Probe Addons:** +20\. **Optional Probe Addons:** * 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. \ No newline at end of file +* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. diff --git a/docs/homey/products/plt1/general-tips.md b/docs/homey/products/plt1/general-tips.md index 15d192ca4b..9e00b1ed3a 100755 --- a/docs/homey/products/plt1/general-tips.md +++ b/docs/homey/products/plt1/general-tips.md @@ -1,10 +1,10 @@ --- -title: General Tips +title: General tips description: "Helpful tips to get the most use out of your sensor." --- -# General Tips +# General tips -## Boot and Reset Buttons +## Boot and reset buttons 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. diff --git a/docs/homey/products/plt1/reviews.md b/docs/homey/products/plt1/reviews.md index 934bb5feed..93b062082f 100755 --- a/docs/homey/products/plt1/reviews.md +++ b/docs/homey/products/plt1/reviews.md @@ -1,29 +1,29 @@ --- -title: Simon Says Home Assistant PLT-1 Review -description: "YouTuber reviews and feedback about the PLT-1 sensor from Apollo Automation." +title: PLT-1 reviews +description: "Reviews of the Apollo PLT-1 from smart-home creators, with videos you can watch on the page." --- -# [Simon Says Home Assistant PLT-1 Review](https://youtu.be/hocliw98_Gk?si=8TMFLD7xiYah1RmJ) +# PLT-1 reviews + +These creators have reviewed the Apollo PLT-1. Watch each review here, or open it on YouTube with the link under the video. + +## Simon Says Home Assistant - +[Watch the Simon Says Home Assistant review on YouTube](https://youtu.be/hocliw98_Gk?si=8TMFLD7xiYah1RmJ) -## [Michael Leen PLT-1 Review](https://youtu.be/tSYUJESNyFM?si=9k0OBns9XvNzYjyz) +## Michael Leen - +[Watch the Michael Leen review on YouTube](https://youtu.be/tSYUJESNyFM?si=9k0OBns9XvNzYjyz) -## [Mostly Chris PLT-1 Review](https://youtu.be/9TtLOLbf9zI?si=0wRhrtZ8f9KXqAhB) +## Mostly Chris - - -## Bearded Tinker PLT-1 Review - -## Hands On Katie PLT-1 Review +[Watch the Mostly Chris review on YouTube](https://youtu.be/9TtLOLbf9zI?si=0wRhrtZ8f9KXqAhB) -## Smart Home Scene PLT-1 Review +## More reviews -## Smart Home Australia PLT-1 Review \ No newline at end of file +Bearded Tinker, Hands On Katie, Smart Home Scene, and Smart Home Australia have also reviewed the PLT-1. diff --git a/docs/homey/products/plt1/setup/prevent-sleep.md b/docs/homey/products/plt1/setup/prevent-sleep.md index 85f032a75c..815671e73e 100755 --- a/docs/homey/products/plt1/setup/prevent-sleep.md +++ b/docs/homey/products/plt1/setup/prevent-sleep.md @@ -1,35 +1,52 @@ --- -title: Prevent Sleep -description: "Tutorial for how to enable/disable prevent sleep." +title: Prevent sleep +description: "Why the USB-powered PLT-1 stays awake in Homey, what its Prevent sleep and Sleep duration settings do, and how to correct the air temperature instead." --- -# Prevent Sleep +# Prevent sleep -!!! tip "Put your sensors to sleep!" +Your Apollo PLT-1 runs on USB power, but its firmware can still sleep between readings: it wakes up, reports, and goes back to sleep. Sleeping keeps the board from warming itself up, so the air temperature reads closer to the room. The PLT-1 ships with **Prevent sleep** on, so it stays awake and reports all the time. - 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. +## Sleep isn't available for the PLT-1 in Homey - 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. +In Homey, your PLT-1 stays awake. You'll see **Prevent sleep** and **Sleep duration** in your PLT-1's **Settings** in the Homey app, under **Battery settings (if battery is present)**, but the Apollo Automation app only lets you change **Prevent sleep** on a sensor with a battery. If you uncheck it on the PLT-1, Homey refuses the change and shows **Battery settings are not supported on this device.** -1\. Head to the ESPHome Integrations page. +Staying awake is how Homey expects a USB-powered sensor to work, so there's nothing you need to change here. -2\. Click on the name "1 device" below your Apollo device's name. +!!! tip "Leave Sleep duration as it is" - + Homey shows **Sleep duration** in hours, but the PLT-1 reads the number as minutes: the default of 5 means 5 minutes. It only applies while Prevent sleep is off, so you don't need to change it in Homey. -3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". +!!! tip "Using Home Assistant too?" - + Home Assistant can turn sleep on for the PLT-1. See the [Home Assistant Prevent Sleep guide](../../../../../products/plt1/additional-info/prevent-sleep/). While the PLT-1 sleeps, Homey loses its connection between reports. -4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 5 minutes. +## Correct the air temperature instead -!!! warning "Read this before turning off Prevent Sleep!" +If you wanted sleep to stop the board's own warmth from nudging the air temperature up, an offset fixes the reading without it. You need a reference thermometer you trust. - When "Prevent Sleep" is toggled off, your sensor will immediately begin sleeping. Please make sure you are ready to make this sensor sleep before toggling off prevent sleep. +1. Put the reference thermometer next to your PLT-1 and give both time to settle. +2. Compare the PLT-1's air temperature reading in Homey with the reference. +3. In your PLT-1's **Settings**, under **Calibration offsets**, set **Air temperature offset** to how many degrees Celsius the PLT-1 reads too high, and save. For example, if the PLT-1 shows 23.5 °C and the reference shows 22 °C, enter 1.5. -5\. When you are ready, toggle off "Prevent Sleep" and your sensor will go to sleep. It will wake up every 5 minutes, or on the interval you set in step 4. If you need to keep your sensor awake, head to our OTA Awake helper tutorial! +The PLT-1's air temperature in Homey now matches your reference thermometer. The offset only changes the air reading, not the soil temperature probe. -6\. You can wake your sensor by following this guide or you can power cycle your device. If there is a battery in it, the battery will need to be removed or the reset button pressed. +!!! tip "Homey set to Fahrenheit?" -!!! danger "Do not leave your sensor outside or let it get wet!" + The offset is always in degrees Celsius. Divide the difference you see in °F by 1.8: a reading 2.7 °F too high is an offset of 1.5. - The PLT-1 should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your PLT-1 if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file +## If your PLT-1 was set to sleep before + +If Prevent sleep was turned off earlier, for example in Home Assistant, the PLT-1 remembers it and keeps sleeping after you add it to Homey, so Homey keeps losing the connection. Homey can't change Prevent sleep on the PLT-1, so turn it back on with the boot button. [Putting the PLT-1 in boot mode](../../troubleshooting/plt1-boot-mode/) shows where the button is. + +!!! warning "Don't hold the boot button while you plug in" + + Plugging in with the boot button held puts the PLT-1 in boot mode for flashing firmware instead. Also let go before 10 seconds: holding the boot button that long resets the PLT-1 to factory settings and erases its Wi-Fi. + +1. Unplug the PLT-1 and plug it back in to wake it. +2. Wait a few seconds, then press and hold the boot button for 4 to 5 seconds and let go. + +The PLT-1 turns Prevent sleep back on and stays connected to Homey, and **Prevent sleep** shows as checked in its settings. If Homey loses the connection again a few seconds later, the PLT-1 was already on its way back to sleep. It still remembers Prevent sleep, so unplug it and plug it back in once more, and it stays awake this time. + +!!! danger "Keep the main body dry" + + The main body of the PLT-1 isn't rated for outdoor use. Don't leave it outside for long periods or let it get wet. If it will sit in damp air or could see rain, put it inside another, protective case. diff --git a/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md index 28885aaa39..b661b45c78 100755 --- a/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md @@ -1,26 +1,30 @@ --- -title: Putting The PLT-1 In Boot Mode +title: Putting the PLT-1 in boot mode description: "Step by step guide for putting The PLT-1 In Boot Mode." --- -# Putting The PLT-1 In Boot Mode +# Putting the PLT-1 in boot mode !!! info "This will cover how to put the PLT-1 into 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 + +You can put your device into boot mode with only the boot button and a USB-C cable. 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. +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 PLT-1 then let go of the button. + +3\. Continue with uploading the firmware document. -3\. Continue with uploading the firmware document. +## Method 2: Boot and reset buttons -## Method 2: Boot and Reset Buttons +You can also put your device into boot mode by pressing the reset button while you hold the boot button. -1\. Unplug the device and locate the boot and reset buttons as shown in the image above. +1\. Unplug the device and locate the boot button (on the side, shown in the image above) and the reset button (near the USB-C port, shown in the image below). 2\. Plug it into your computer. @@ -28,4 +32,4 @@ description: "Step by step guide for putting The PLT-1 In Boot Mode."  -4\. Continue with uploading the firmware document. \ No newline at end of file +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 9cb9033934..383eb7e825 100755 --- a/docs/homey/products/plt1/troubleshooting/plt1-code.md +++ b/docs/homey/products/plt1/troubleshooting/plt1-code.md @@ -1,16 +1,18 @@ --- -title: Factory Re-Flash PLT-1 +title: Factory re-flash PLT-1 description: "Step by step guide for re-flashing the PLT-1 back to factory firmware." --- -# Factory Re-Flash PLT-1 +# Factory re-flash PLT-1 !!! 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." This needs to be done in Chrome, Edge, or another Chromium based browser. -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. +If your device has already been added to Homey, please remove it from Homey before continuing. -1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable. +Follow these steps to put your device in boot mode and install the factory firmware. + +1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable.  @@ -40,4 +42,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and set up 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/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md b/docs/homey/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md index 42b2e4a932..cae3a67bd2 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 @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials on your PLT-1 +title: Reset Wi-Fi credentials on your PLT-1 description: "Step by step guide for resetting the Wi-Fi Credentials on your PLT-1." --- -# Reset Wi-Fi Credentials on your PLT-1 +# Reset Wi-Fi credentials on your PLT-1 + +You can clear the Wi-Fi details saved on your device and connect it to a new Wi-Fi network through its hotspot. 1\. Plug the device into power. @@ -12,4 +14,4 @@ description: "Step by step guide for resetting the Wi-Fi Credentials on your PLT 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. -4\. Connect to the hotspot titled "Apollo PLT-1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file +4\. Connect to the hotspot titled "Apollo PLT1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file diff --git a/docs/homey/products/plt1/troubleshooting/plt1-teardown.md b/docs/homey/products/plt1/troubleshooting/plt1-teardown.md index dd42896629..da977b14a7 100755 --- a/docs/homey/products/plt1/troubleshooting/plt1-teardown.md +++ b/docs/homey/products/plt1/troubleshooting/plt1-teardown.md @@ -1,5 +1,5 @@ --- -title: Teardown and Reassembly Of PLT-1 +title: Teardown and reassembly of PLT-1 description: "Step by step guide for tearing down your PLT-1 to replace parts, clean it, swap cases, etc." --- \ No newline at end of file diff --git a/docs/homey/products/plt1b/battery-sensors/sensor-connection-check.md b/docs/homey/products/plt1b/battery-sensors/sensor-connection-check.md index 6bc40dbe4f..7e1509c948 100644 --- a/docs/homey/products/plt1b/battery-sensors/sensor-connection-check.md +++ b/docs/homey/products/plt1b/battery-sensors/sensor-connection-check.md @@ -1,5 +1,5 @@ --- title: Sensor Connection Check -description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." +description: "How to check if your device is connected to Wi-Fi, Homey, or nothing." --- --8<-- "homey/products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/homey/products/plt1b/faq.md b/docs/homey/products/plt1b/faq.md index aa6003d37d..35ac8b1eed 100755 --- a/docs/homey/products/plt1b/faq.md +++ b/docs/homey/products/plt1b/faq.md @@ -1,7 +1,9 @@ --- -title: FAQ -description: "PLT-1B FAQ." +title: PLT-1B FAQ +description: "Answers to common questions about the PLT-1B battery plant sensor with Homey: sensors, battery, connecting to Homey, flows, and sleep settings." --- +# PLT-1B FAQ + 1\. **What sensors are included in the PLT-1B?** * The PLT-1B comes with sensors to measure soil moisture, air temperature, humidity, LUX, and UV. There is also an optional DS18b20 waterproof soil temperature probe available for measuring soil temperature. @@ -30,17 +32,27 @@ description: "PLT-1B FAQ." * The PLT-1B is primarily designed for indoor use, but components like the waterproof soil probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection. -8\. **How does the PLT-1B connect to Home Assistant?** +8\. **How does the PLT-1B connect to Homey?** + +* The PLT-1B joins your Wi-Fi, and the Apollo Automation app for Homey talks to it directly over your local network through the ESPHome native API, with no cloud account. Once you add it, its readings show up on the device in Homey, ready for flows and Insights. The app runs on Homey Pro; Homey Cloud isn't supported. + +!!! success "Next step: add your PLT-1B to Homey" -* The PLT-1B connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. + Connect the sensor to your Wi-Fi through its hotspot, then add it with the Apollo Automation app. The getting started guide walks you through both. -9\. **What kind of automations can I set up with the PLT-1B?** + [Get started with Homey](../setup/getting-started-plt1/){ .md-button .md-button--primary } -* Automations can include low moisture alerts, light adjustments based on LUX levels, or HVAC control based on temperature and humidity around your plants. +9\. **What kind of flows can I set up with the PLT-1B?** + +* Any PLT-1B reading can start a flow in Homey. For example, send a notification when soil moisture drops, turn on a grow light when the light level falls, or adjust your heating or cooling based on the air temperature and humidity around your plants. 10\. **How often does the PLT-1B send sensor data?** -* The PLT-1B’s reporting frequency is adjustable in ESPHome. You can set it for frequent updates or extend intervals to conserve battery life. +* A new PLT-1B ships with **Prevent sleep** checked, so it stays awake and reports most readings every 60 seconds. That drains the battery fast. Once you uncheck Prevent sleep, the PLT-1B wakes up, sends all its readings to Homey, and goes back to sleep to save battery. How long it sleeps is the **Sleep duration** setting, in hours (12 by default). Both settings are under **Battery settings (if battery is present)** in the device's **Settings** in the Homey app. A shorter sleep gives fresher readings and a shorter battery life. See [Prevent sleep](../setup/prevent-sleep/) for the details. + +!!! tip "Change settings while the PLT-1B is awake" + + Homey can only send a setting while the sensor is awake and connected. If it's asleep, Homey shows **The device is asleep. Settings can be changed when it next wakes up.** [Keep the sensor awake](../setup/prevent-sleep/#keep-your-plt-1b-awake-again) and try again. 11\. **Can I customize the PLT-1B functionality?** @@ -48,7 +60,8 @@ description: "PLT-1B FAQ." 12\. **What are the RGB LED and piezo buzzer used for?** -* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure. +* The RGB LED is the PLT-1B's light in Homey. Turn it on or off, dim it, or change its color from the device or in a flow, for example to glow red when the soil gets dry. Commands reach the sensor only while it's awake. +* The piezo buzzer is played through an ESPHome action, and the Apollo Automation app has no flow card for it, so Homey can't sound the buzzer. If you also run Home Assistant, it can: see the [piezo buzzer guide](../../../../products/general/piezo/). 13\. **What is the benefit of using a conformal coating on the soil moisture sensor?** @@ -56,7 +69,7 @@ description: "PLT-1B FAQ." 14\. **What plants are compatible with the PLT-1B?** -* Compatible with various indoor plants, the PLT-1B can apply ideal care conditions (e.g., light, humidity, moisture) using Open Plant Book with Home Assistant. +* The PLT-1B works with all kinds of indoor plants. Look up the light, humidity, and soil moisture your plant likes, then use those values as thresholds in your Homey flows, so you hear about it when a reading drifts out of range. 15\. **Can I monitor multiple plants with one PLT-1B?** @@ -64,29 +77,29 @@ description: "PLT-1B FAQ." 16\. **What makes the PLT-1B better than other plant sensors?** -* The PLT-1B features a durable capacitive soil moisture sensor, real-time data reporting, and tracks various environmental factors—all in one compact device that integrates seamlessly with Home Assistant. +* The PLT-1B pairs a durable capacitive soil moisture sensor with real-time reporting of several environmental factors, all in one compact, battery-powered device that works with Homey on your local network. 17\. **Is the PLT-1B compatible with other smart home platforms?** -* While designed for Home Assistant via ESPHome, it may be compatible with other platforms using the ESPHome API or MQTT. +* Yes. Besides Homey (through the Apollo Automation app), the PLT-1B works with Home Assistant, and it may work with other platforms through the ESPHome API or MQTT. See [Supported platforms](../../general/supported-platforms/). 18\. **Do I need coding knowledge to use the PLT-1B?** -* Basic knowledge of Home Assistant and ESPHome is helpful, but most users can utilize it out of the box. For advanced customization, YAML knowledge is recommended. +* No. Adding the PLT-1B to Homey and building flows takes no code. YAML knowledge only matters if you want to customize the firmware with ESPHome. 19\. **Can I access data from the PLT-1B remotely?** -* Yes, you can access sensor data remotely via the Home Assistant dashboard if your setup is configured for remote access. +* Yes. The PLT-1B reports to your Homey over your local network, and the Homey app shows its latest readings wherever you are, as long as your Homey is reachable remotely. 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/humidity, lux/uv, etc. -21\. **Can I use multiple PLT-1B sensors in one Home Assistant setup?** +21\. **Can I use multiple PLT-1B sensors with one Homey?** -* Yes, you can add multiple PLT-1B sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces. +* Yes. Add each PLT-1B with the Apollo Automation app. Each one shows up as its own device in Homey, so you can monitor several plants or spaces. 22\. **Optional Probe Addons:** * 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. \ No newline at end of file +* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. diff --git a/docs/homey/products/plt1b/general-tips.md b/docs/homey/products/plt1b/general-tips.md index 683dace8a2..af76cd6b9f 100755 --- a/docs/homey/products/plt1b/general-tips.md +++ b/docs/homey/products/plt1b/general-tips.md @@ -1,12 +1,12 @@ --- -title: General Tips +title: General tips description: "Helpful tips to get the most use out of your sensor." --- -# General Tips +# General tips -## Boot and Reset Buttons +## Boot and reset buttons -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. +When looking at the PLT-1B in the below orientation, the reset button is on the left and the boot button is on the right by the USB-C port.  diff --git a/docs/homey/products/plt1b/setup/prevent-sleep.md b/docs/homey/products/plt1b/setup/prevent-sleep.md index 442dc6c6ea..461e6aef21 100755 --- a/docs/homey/products/plt1b/setup/prevent-sleep.md +++ b/docs/homey/products/plt1b/setup/prevent-sleep.md @@ -1,35 +1,79 @@ --- -title: Prevent Sleep -description: "Keep the PLT-1B awake instead of letting it sleep, and what that costs in battery life." +title: Prevent sleep +description: "Let the PLT-1B sleep between readings to save battery, or keep it awake, with the Prevent sleep and Sleep duration settings in Homey." --- -# Prevent Sleep +# Prevent sleep -!!! tip "Put your sensors to sleep!" +Your Apollo PLT-1B can sleep between readings: it wakes up, reports to Homey, and goes back to sleep until the next report. Sleeping is what makes the battery last. It also keeps the board from warming itself up, so the air temperature readings need less offset. - 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 PLT-1B ships with **Prevent sleep** turned on, so it stays awake and reports all the time. That's handy while you set it up, but it drains the battery far faster. Once the sensor is in its pot, turn Prevent sleep off and let it sleep. - 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. +!!! note "Before you start" -1\. Head to the ESPHome Integrations page. + - Add your PLT-1B to Homey. See [Getting started](../getting-started-plt1/). + - Homey can only change these settings while the sensor is awake and connected. If it's asleep, Homey shows **The device is asleep. Settings can be changed when it next wakes up.** In that case, [keep it awake](#keep-your-plt-1b-awake-again) first. -2\. Click on the name "1 device" below your Apollo device's name. +## The sleep settings in Homey - +Both settings sit in your PLT-1B's **Settings** in the Homey app, under **Battery settings (if battery is present)**. They're device settings only, so there's no flow card that turns sleep on or off. -3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". +| Setting | What it does | +| --- | --- | +| **Prevent sleep** | Checked, the sensor stays awake. Unchecked, it sleeps between reports. A new PLT-1B has it checked. | +| **Sleep duration** | How many hours the sensor sleeps between reports, from 0 to 800, with up to two decimals: 0.5 is 30 minutes. The default is 12. | - +## Let your PLT-1B sleep -4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 12 hours. +Set how long the sensor sleeps first, then let it go to sleep. Make the two changes one at a time: the sensor falls asleep the moment Prevent sleep turns off, so a change sent along with it may never arrive. -!!! warning "Read this before turning off Prevent Sleep!" +!!! warning "Read this before you uncheck Prevent sleep" - When "Prevent Sleep" is toggled off, your sensor will immediately begin sleeping. Please make sure you are ready to make this sensor sleep before toggling off prevent sleep. + The PLT-1B goes to sleep as soon as Prevent sleep is off, and Homey can't reach it again until it wakes up. Put the sensor where you want it and finish any other settings, such as soil calibration, first. -5\. When you are ready, toggle off "Prevent Sleep" and your sensor will go to sleep. It will wake up every 5 minutes, or on the interval you set in step 4. If you need to keep your sensor awake, head to our OTA Awake helper tutorial! +1. In the Homey app, open your PLT-1B's **Settings**. +2. Under **Battery settings (if battery is present)**, set **Sleep duration** to the hours you want between reports, and save the change. Leave it at 12 unless you need fresher readings. +3. Uncheck **Prevent sleep** and save. -6\. You can wake your sensor by following this guide or you can power cycle your device. If there is a battery in it, the battery will need to be removed or the reset button pressed. +Your PLT-1B is now asleep. It wakes up after each Sleep duration, connects to Homey, sends fresh readings, and goes back to sleep about 20 seconds after it connects. -!!! danger "Do not leave your sensor outside or let it get wet!" +!!! tip "Device disconnected is normal between reports" - The PLT-1B should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your PLT-1B if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file + While the PLT-1B sleeps, Homey shows it as **Device disconnected**. That's expected: Homey reconnects on its own each time the sensor wakes up. + +## Keep your PLT-1B awake again + +To change a setting, calibrate the soil readings, update the firmware, or troubleshoot, the sensor has to stay awake. Turn Prevent sleep back on from the sensor itself or from the Homey app. + +### With the buttons on the sensor + +The buttons work even when Homey can't reach the sensor, which makes this the most reliable way. The [sensor connection check](../../battery-sensors/sensor-connection-check/) has photos of the reset and boot buttons. + +!!! warning "Watch how long you hold the boot button" + + Hold the boot button for 4 to 5 seconds, no longer. Holding it for 10 seconds or more resets the PLT-1B to factory settings and erases its Wi-Fi, and you'd have to [connect it to Wi-Fi](../getting-started-plt1/) again. A short press of under 3 seconds runs the connection check instead. + +1. Press and release the reset button to wake the sensor. You can also take the battery out and put it back in. +2. Wait a few seconds, then press and hold the boot button for 4 to 5 seconds and let go. + +The sensor turns Prevent sleep on and stays awake. In Homey, **Prevent sleep** shows as checked again once the sensor is connected. If Homey loses the connection again a few seconds later, the sensor was already on its way back to sleep. It still remembers Prevent sleep, so press the reset button once more and it stays awake this time. + +### From the Homey app + +The sensor stays awake for only about 20 seconds after Homey connects, so have the Homey app open and ready before you start. + +1. Wake the sensor with the reset button, or take the battery out and put it back in. +2. In the Homey app, open your PLT-1B and wait until it no longer shows **Device disconnected**. +3. Right away, open its **Settings**, check **Prevent sleep** under **Battery settings (if battery is present)**, and save. +4. If Homey loses the connection again a few seconds later, press the reset button once more. + +Your PLT-1B now stays awake until you uncheck Prevent sleep again. If the sensor was already on its way back to sleep at step 3, it still keeps the change and starts up with Prevent sleep on after the reset in step 4. If Homey shows **The device is asleep. Settings can be changed when it next wakes up.** instead, the change didn't reach the sensor: start again from step 1, or use the buttons. + +!!! danger "Keep the main body dry" + + The main body of the PLT-1B isn't rated for outdoor use. Don't leave it outside for long periods or let it get wet. If it will sit in damp air or could see rain, put it inside another, protective case. + +!!! success "Next step: check your sensor's connection" + + Not sure whether your PLT-1B woke up and reached Homey? The light on the sensor tells you in a few seconds. + + [Run the sensor connection check](../../battery-sensors/sensor-connection-check/){ .md-button .md-button--primary } diff --git a/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md index b6da440c1d..ee6b30a6a4 100755 --- a/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -1,8 +1,8 @@ --- -title: Putting The PLT-1B In Boot Mode +title: Putting the PLT-1B in boot mode description: "Step by step guide for putting The PLT-1B In Boot Mode." --- -# Putting The PLT-1B In Boot Mode +# Putting the PLT-1B in boot mode !!! info "This will cover how to put the PLT-1B into boot mode." @@ -10,7 +10,9 @@ description: "Step by step guide for putting The PLT-1B In Boot Mode."  -## Method 1: Boot Button Only +## Method 1: Boot button only + +You can put your device into boot mode with only the boot button and a pin. 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. @@ -20,9 +22,11 @@ description: "Step by step guide for putting The PLT-1B In Boot Mode." 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 -3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/plt1b/troubleshooting/plt1b-code/) +3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/homey/products/plt1b/troubleshooting/plt1b-code/) + +## Method 2: Boot and reset buttons -## Method 2: Boot and Reset Buttons +You can also put your device into boot mode by pressing the reset button while you hold the boot button. 1\. Plug in the device @@ -32,4 +36,4 @@ 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/) \ No newline at end of file +3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/homey/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 8bac3c6fcf..3d9c413f19 100755 --- a/docs/homey/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/homey/products/plt1b/troubleshooting/plt1b-code.md @@ -1,77 +1,56 @@ --- -title: Factory Re-Flash PLT-1B -description: "Step by step guide for re-flashing the PLT-1B back to factory firmware." +title: Re-flash the PLT-1B factory firmware +description: "Re-flash an unresponsive PLT-1B with its factory firmware using the Apollo web installer, then set it up again in Homey." --- -# Factory Re-Flash PLT-1B +# Re-flash the PLT-1B factory firmware -!!! 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." +If your PLT-1B becomes unresponsive and you've tried the other troubleshooting steps, re-flash its factory firmware. The Apollo web installer does this from your browser while the PLT-1B is plugged into your computer by USB. - This needs to be done in Chrome, Edge, or another Chromium based browser. +!!! note "Before you start" -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. + - Use Chrome, Edge, or another Chromium-based browser. + - If your PLT-1B has already been added to Homey, remove it from Homey before you continue. -1. Plug your sensor into your computer with a quality USB-C cable that supports data transfer -2. Navigate to our installer page and click connect [\*\* Install Page \*\*](https://apolloautomation.github.io/PLT-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. +!!! warning "Remove the battery" -[](/assets/comselection.png) + The re-flash doesn't work properly while the battery is still supplying power to the PLT-1B. If you run into issues during these steps, remove the battery. -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/plt1b/troubleshooting/plt1b-boot-mode/) for putting the sensor in boot mode and then retry step 3. +Follow these steps to put your PLT-1B in boot mode and install the factory firmware. -4\. Choose to install the new firmware +1\. Put your PLT-1B in boot mode: hold down the boot button, then plug in the USB cable. -[](/assets/image-1698806750134.png) + -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. +2\. Open the Apollo PLT-1B Installer. -[](/assets/image-1698806082666.png) - -!!! warning "Power cycle your device before doing anything else!" - - Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! - -6\. Please proceed to the getting started guide and set up your sensor as a new device! - -## 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." - - This needs to be done in Chrome, Edge, or another Chromium based browser. - -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. - -1\. 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 - -!!! failure "Remove the battery!" - - This will not work properly if the battery is still supplying power to the TEMP-1B. Please remove the battery if you are having issues! - -3\. Click the big "Connect" button. +3\. Under **Battery Firmware**, click the big **Connect** button.  -4\. Select the open com port then click Connect. +4\. Select the open COM port, then click **Connect**.  -5\. Click "Install ApolloAutomation.PLT-1B". +!!! note "No device in the list?" + + If no device shows up, click **Cancel** and install the recommended driver from the pop-up. + +5\. Click **Install ApolloAutomation.PLT-1B**.  -6\. Click "INSTALL". +6\. Click **INSTALL**.  -7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +7\. When you see **Installation complete!**, the install is finished. Click **Next**, then close the browser window.  -!!! warning "Power cycle your device before doing anything else!" +!!! warning "Power cycle your PLT-1B before anything else" + + Your PLT-1B is still in boot mode. Power cycle it (remove its power, then power it again) so it starts in normal mode. - Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! +8\. Follow the getting started guide to set up your PLT-1B as a new device. -8\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file +Once you finish the getting started guide, your PLT-1B is running its factory firmware again and set up as a new device. diff --git a/docs/homey/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md b/docs/homey/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md index bb79f458ae..fafa00aacb 100755 --- a/docs/homey/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md +++ b/docs/homey/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials on your PLT-1B +title: Reset Wi-Fi credentials on your PLT-1B description: "Step by step guide for resetting the Wi-Fi Credentials on your PLT-1B." --- -# Reset Wi-Fi Credentials on your PLT-1B +# Reset Wi-Fi credentials on your PLT-1B + +You can clear the Wi-Fi details saved on your device and connect it to a new Wi-Fi network through its hotspot. 1\. Plug the device into power. @@ -14,4 +16,4 @@ description: "Step by step guide for resetting the Wi-Fi Credentials on your PLT 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. -4\. Connect to the hotspot titled "Apollo PLT-1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file +4\. Connect to the hotspot titled "Apollo PLT1B Hotspot" and enter your new Wi-Fi details! \ No newline at end of file diff --git a/docs/homey/products/plt1b/troubleshooting/plt1b-teardown.md b/docs/homey/products/plt1b/troubleshooting/plt1b-teardown.md index b0d1294e6d..0129e1d076 100755 --- a/docs/homey/products/plt1b/troubleshooting/plt1b-teardown.md +++ b/docs/homey/products/plt1b/troubleshooting/plt1b-teardown.md @@ -1,5 +1,5 @@ --- -title: Teardown and Reassembly Of PLT-1B +title: Teardown and reassembly of PLT-1B description: "Step by step guide for tearing down your PLT-1B to replace parts, clean it, swap cases, etc." --- \ No newline at end of file diff --git a/docs/homey/products/pump1/setup/pump1-general-tips.md b/docs/homey/products/pump1/setup/pump1-general-tips.md index 061c7ea708..750c607277 100644 --- a/docs/homey/products/pump1/setup/pump1-general-tips.md +++ b/docs/homey/products/pump1/setup/pump1-general-tips.md @@ -1,5 +1,5 @@ --- title: General Tips -description: Multiple helpful images for mounting, lux/rgb, and gate and zone visualization. +description: Tips for placing the PUMP-1 fluid sensor, controlling the pump, and preventing siphoning. --- ---8<-- "products/pump1/setup/pump1-general-tips.md:7:" +--8<-- "products/pump1/setup/pump1-general-tips.md:5:" diff --git a/docs/homey/products/rpro1/faq.md b/docs/homey/products/rpro1/faq.md index c67ff78dd2..857b3dae2f 100644 --- a/docs/homey/products/rpro1/faq.md +++ b/docs/homey/products/rpro1/faq.md @@ -1,5 +1,108 @@ --- -title: FAQ -description: "Frequently asked questions about the R PRO-1 PoE mmWave sensor." +title: R PRO-1 FAQ +description: "Answers to common questions about the R PRO-1 PoE mmWave sensor with Homey: sensors, Ethernet firmware, radar tuning, radar regions, and flows." --- ---8<-- "products/rpro1/faq.md:5:" +# R PRO-1 FAQ + +1\. **What sensors are included in the R PRO-1?** + +* The R PRO-1 includes several built-in sensors such as an LD2450 mmWave radar sensor and optional LD2412 mmWave radar for presence detection, a LUX and UV sensor, and an optional CO2 sensor. + +2\. **How does the mmWave radar sensor work?** + +* The LD2450 emits **millimeter-wave radar signals (at 24GHz)** into the environment. When these signals hit a person or object, they bounce back. The sensor detects these returned signals and calculates key information. + +3\. **What is the maximum detection range of the mmWave radar?** + +* The HLK-LD2450 mmWave radar sensor has a maximum detection range of about 6 meters (19.7 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring. +* The optional HLK-LD2412 mmWave radar sensor has a maximum detection range of about 9 meters (29.5 feet) with single tracking capabilities and ability to tune moving and still energy which is perfect for still targets like sleeping in a bed, laying on a couch, etc. + +4\. **Can the R PRO-1 detect multiple people?** + +* Yes, the R PRO-1 comes with an LD2450 which can detect 3 people in up to 3 zones. The optional LD2412 addon will only detect one person. + +5\. **What is the benefit of the LUX and UV sensor?** + +* The LUX sensor measures the amount of light in a room, while the UV sensor tracks the ultraviolet index from the sun. These readings can be used to automate lighting systems, such as turning on or off lights depending on the ambient brightness, or to measure sunlight exposure in a room. +!!! tip "Mounting behind a faceplate or using ceiling mount removes ability for lux or UV to work properly" + + There is no way for the lux or UV index to work properly if there is no light or UV able to hit the sensor. + +6\. **How does the optional CO2 sensor work?** + +* The optional SCD-40 CO2 sensor provides accurate carbon dioxide measurements and is useful for tracking air quality in enclosed spaces. This sensor can be used to automate HVAC systems, sending alerts when CO2 levels are too high and suggesting when to ventilate the area. + +7\. **How do I connect the R PRO-1 to Homey?** + +* The R PRO-1 ships with Wi-Fi firmware. Connect it to your Wi-Fi through its hotspot, then add it in Homey with the Apollo Automation app, which talks to it directly over your local network through the ESPHome native API. The app runs on Homey Pro; Homey Cloud isn't supported. See [Getting started](../../general/setup/getting-started/). +* Once it's connected, you can switch to Ethernet firmware for PoE from the sensor's own web page: in a browser, open `http://apollo-r-pro-1-w-xxxxxx.local`, where `xxxxxx` is the last 6 characters of the device's name in Homey. Choose **Ethernet** under **Firmware Type**, then press **Firmware Update**. The sensor downloads the new firmware from GitHub, so it needs internet access. You can also reflash it to Ethernet firmware with the R PRO-1 installer. +* Homey recognizes the R PRO-1 by its hardware address, so after the switch it stays the same device in Homey. + +8\. **What kind of flows can I create with the R PRO-1?** + +* Flows can start from presence, from a region of the room, or from any reading. Turn on lights with **Presence detected**, adjust ventilation when CO2 levels rise (with the CO2 addon), or trigger alarms based on motion or environmental changes. +* Draw regions with the **Radar regions** widget, and every detect region works with the region flow cards **A region became occupied**, **A region became empty**, and **A region is occupied**. + +!!! success "Next step: build your first region flow" + + Draw a region with the [Zone Mapper tool](../setup/r-pro-1-zone-mapper-tool/), then make it do something: the step-by-step guide walks you through a flow that turns a light on when someone enters a region and off when they leave. + + [Turn on a light when someone enters a region](../../general/tutorials/region-light-flow-example/){ .md-button .md-button--primary } + +9\. **What is the RGB LED used for?** + +* The RGB LED provides visual alerts like high CO2 levels! It's also the R PRO-1's light in Homey, so you can turn it on or off, dim it, or change its color from the device or in a flow. + +10\. **How do I adjust the sensitivity of the presence detection?** + +* In the device's **Settings** in the Homey app, **Radar tuning (MTR-1 / R PRO-1)** has **LD2450 timeout** and **LD2412 timeout**: how long each radar holds presence after the last detection, in seconds. +* The LD2412's per-gate sensitivity (the move and still thresholds for each gate) and its min and max distance gates aren't in Homey. Tune them on the sensor's own web page (see question 7 for the address), or with the [HLK Radar Tool app](../setup/zones-hlk/). +* The LD2450 has no sensitivity settings. Shape its detection with regions in the **Radar regions** widget instead, and mark spots that cause false detections, such as a fan or a curtain, as **Ignore this area**. An ignored area hides targets from your detect regions, so build your flows on the regions. + +11\. **Does the mmWave sensor detect through walls?** + +* Yes, the mmWave sensor can detect movement through certain materials like drywall and thin wood. In some instances it will need to be tuned to make sure adjacent rooms are not triggering the sensor. + +12\. **Can the R PRO-1 be used outdoors?** + +* No, the R PRO-1 is primarily designed for indoor use and high humidity or temperatures too high or low could damage the device. + +13\. **Can the R PRO-1 track the exact location of people in a room?** + +* Yes. The LD2450 reports the X and Y position of up to three people. In Homey, draw regions on a live map of the radar's view with the **Radar regions** widget, up to 32 per device. Each detect region reports occupied or empty as its own occupancy tile and works with the region flow cards. See the [Zone Mapper tool](../setup/r-pro-1-zone-mapper-tool/) guide. + +14\. **What kind of power supply is required for the R PRO-1?** + +* The R PRO-1 is powered via PoE (802.3af compliant) or USB-C and can be plugged into a standard wall outlet using a 5V 2A or bigger power supply. + +15\. **Can I customize the R PRO-1 functionality?** + +* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the R PRO-1. Our YAML is on GitHub and our .STEP and .STL CAD files are available for community use. + +16\. **How often does the R PRO-1 report sensor data?** + +* Most sensors report every 60 seconds by default, and the mmWave sensors report immediately on change. These intervals are set in the firmware, and Homey has no setting for them, so changing one means editing the firmware with ESPHome. + +17\. **Is the R PRO-1 compatible with other smart home platforms?** + +* Yes, it is compatible with any system that can integrate with the ESPHome API, including Homey through the Apollo Automation app and Home Assistant. We also have a [list of supported platforms](../../general/supported-platforms/). + +18\. **Can I use multiple R PRO-1 sensors with one Homey?** + +* Yes. Add each R PRO-1 with the Apollo Automation app. Each one shows up as its own device in Homey with its own readings and settings, so you can monitor and automate different rooms or areas in your home. The **Radar regions** widget works per device, so add one widget for each R PRO-1. + +19\. **What addons are available for the R PRO-1?** + +* The R PRO-1 has a mezzanine port for an optional SCD40 CO2 sensor. We also sell a gang box mount and a ceiling mount kit. + +20\. **Is the R PRO-1 secure?** + +* The R PRO-1 communicates with Homey over your local network through the ESPHome API. This provides a local connection without the need for cloud services. No data is sent to external servers, ensuring privacy. + +21\. **What makes the R PRO-1 stand out from other motion sensors?** + +* The R PRO-1 is the only dual mmWave sensor with PoE and the ability to integrate with multiple smart home platforms. It combines the MSR-2's ability to detect still detection perfectly and the MTR-1's ability to detect up to three targets in three zones! + +22\. **What is the warranty for the R PRO-1?** + +* The R PRO-1 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement. diff --git a/docs/homey/products/rpro1/setup/zones-hlk.md b/docs/homey/products/rpro1/setup/zones-hlk.md index f4f5a45935..d826295ca3 100644 --- a/docs/homey/products/rpro1/setup/zones-hlk.md +++ b/docs/homey/products/rpro1/setup/zones-hlk.md @@ -1,8 +1,8 @@ --- -title: How To Tune mmWave Using HLKRadarTool +title: How to tune mmWave using HLKRadarTool description: "Tutorial for R PRO-1 HLKRadarTool app Zone Configuration." --- -# How To Tune mmWave Using HLKRadarTool +# How to tune mmWave using HLKRadarTool @@ -10,7 +10,7 @@ description: "Tutorial for R PRO-1 HLKRadarTool app Zone Configuration." Some steps below require opening your device's web server in a browser. To find your address: - 1. In Homey, open your R PRO-1 device and note the last 6 characters of its name — for example, **Apollo R_PRO-1 353fd4** gives you `353fd4`. + 1. In Homey, open your R PRO-1 device and note the last 6 characters of its name. For example, **Apollo R_PRO-1 353fd4** gives you `353fd4`. 2. Check whether you set it up over **WiFi** or **Ethernet**. 3. Build your URL: - WiFi: `http://apollo-r-pro-1-w-353fd4.local/` @@ -18,7 +18,7 @@ description: "Tutorial for R PRO-1 HLKRadarTool app Zone Configuration." If the `.local` address doesn't load, use your router to find the device's IP address and use that instead. -## LD2450 Configuration +## LD2450 configuration !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -34,10 +34,14 @@ The Click here to download +Follow these steps to turn on the LD2450's Bluetooth and set up its zones in the HLKRadarTool app. + 1\. Open your R PRO-1's web server (see address tip above), scroll down until you see **LD2450 Bluetooth**, and toggle it on.  +*Shown on an MTR-1; the R PRO-1 has the same LD2450 Bluetooth switch.* + 2\. Open the HLKRadarTool App and select your device. !!! success "You need to be close to your device!" @@ -50,13 +54,13 @@ The **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. + 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 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! + Disabled allows you to 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!  @@ -69,12 +73,11 @@ The Difficulty: Level 1 -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. +Your Apollo TEMP-1 sends its temperature probe reading to Homey about once a minute, and every new reading can start a flow. In this guide you build two flows in the Homey mobile app that keep watch on a freezer: the first sends a push notification when the probe gets too warm, the second when it gets too cold. -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. +!!! note "Before you start" - + - Add your TEMP-1 to Homey with the Apollo Automation app. See [Getting started](../../setup/getting-started-temp1/). + - Plug the [temperature probe](../../addons/temp-probe/) into the TEMP-1. Open your TEMP-1's **Settings** and, under **Probes and offsets for TEMP-1 and TEMP-1B**, set **Select probe** to **Temperature**. With **Food** selected, the temperature probe sends no readings. + - Install the Homey mobile app on every phone that should get the alert. -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. +## Pick your range - +Find out what your freezer normally swings between before you set any limits. That way the alert only fires when something is actually wrong. -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 +1. Place the probe in the freezer and run its flat cable out through the door seal. Keep the TEMP-1 itself outside the freezer, somewhere cool and dry: only the probe and its cable can handle the cold. +2. Leave it for a few hours so the reading settles. [Most freezers should sit at or below -18 °C (0 °F)](https://www.fda.gov/food/buy-store-serve-safe-food/refrigerator-thermometers-cold-facts-about-food-safety). +3. In Homey Insights, look at your TEMP-1's **Temperature Probe** history. Note the highest and lowest readings. +4. Pick a maximum a little above the highest reading and a minimum a little below the lowest. This guide uses -10 °C and -30 °C; yours will likely differ. - \ No newline at end of file +You now have a range that covers normal use and flags a real problem. + +!!! tip "Enter your limits in degrees Celsius" + + The **Temperature Probe** reading, and the **Temperature** token the flows below compare, are always in °C. If you think in Fahrenheit, convert first: -10 °C is 14 °F, and -30 °C is -22 °F. + +## Flow 1: Too warm + +This flow runs each time the probe reading changes, checks it against your maximum, and sends the alert when the freezer is too warm. + +1. In the Homey mobile app, tap **Flow** in the bottom bar, then tap **+** at the top right (or **Create a Flow** if you have none yet). +2. Under **When...**, tap **Add Card**. Open **Apollo Automation** under **Apps**, and choose your TEMP-1. +3. Choose the card **Temperature probe changed**. It hands the new reading to the rest of the flow as the **Temperature** token. +4. Under **And...**, tap **Add Card** and add Homey's built-in condition for comparing numbers. Set it to check that the **Temperature** token is greater than **-10**. +5. Under **Then...**, tap **Add Card** and choose **Send Message to User** from **Push Notifications**. +6. Type a message, for example **Check the freezer! The TEMP-1 probe reads**, and add the **Temperature** token after it. +7. Tap **User** and pick who gets the alert, such as **Everyone**, then tap the check mark at the top right. +8. Tap **Next**. Name the flow, for example **Freezer too warm**, and tap **Save Flow**. + +The flow now shows in **My Flows**. Any probe reading above -10 °C sends the alert to your phone. + +## Flow 2: Too cold + +The second flow mirrors the first. Build it the same way, with these changes: + +1. In the **And...** condition, check that the **Temperature** token is less than **-30**. +2. Change the message, for example to **The freezer is colder than usual. The TEMP-1 probe reads**, followed by the **Temperature** token. +3. Name the flow **Freezer too cold** and tap **Save Flow**. + +Both ends of your range are now covered: you hear about it whether the freezer warms up or runs too cold. + +!!! warning "Expect a reminder with each new reading" + + **Temperature probe changed** runs every time the reading changes, not only when it crosses your limit. While the probe stays out of range, every change sends another notification, up to once a minute, until the temperature is back inside your range. To pause the reminders while you deal with the freezer, switch the flow off in **My Flows**, and switch it back on afterwards. + +## Test your flows + +To check the alert without warming up your freezer, tap the play button next to a flow in **My Flows**. It runs its **Then** cards once, and a green check mark confirms it ran. Your phone gets the notification. + +If a flow doesn't run when the freezer is out of range: + +- Check that **Select probe** is set to **Temperature** and that the **Temperature Probe** reading keeps updating. +- Check that your limits are in °C. +- Check that both flows are switched on in **My Flows**. + +## Optional: sound the TEMP-1's buzzer too + +The TEMP-1 can also raise the alarm on its own. When you turn this on, the sensor checks every probe reading against a minimum and maximum you store on the device and sounds a short siren from its buzzer when the reading is outside them. It works alongside your flows, so anyone near the freezer hears it even if their phone is on silent. + +1. Open your TEMP-1's **Settings**. +2. Under **Probes and offsets for TEMP-1 and TEMP-1B**, set **Minimum probe temperature** and **Maximum probe temperature** in °C, for example **-30** and **-10**. +3. Under **Temperature range and alarm settings for TEMP PRO-1**, turn on **Alarm when temperature outside configured range**. The group is named for the TEMP PRO-1, but this setting also switches the TEMP-1's alarm on and off. + +The TEMP-1 now sounds the siren with each probe reading outside your range, until the reading is back inside it. + +!!! tip "Use the probe settings, not the TEMP PRO-1 ones" + + **Minimum temperature** and **Maximum temperature** in the TEMP PRO-1 group belong to the TEMP PRO-1 and don't change anything on a TEMP-1. Set the range with **Minimum probe temperature** and **Maximum probe temperature** instead. + +!!! success "Next step: know when dinner is ready" + + Your freezer is covered. The automation examples put the food probe to work: a flow that lights your TEMP-1 green and sends you one notification when your food reaches its target temperature. + + [Build the food probe flow](../temp1-automation-examples/#food-probe-reaches-a-target-temperature){ .md-button .md-button--primary } diff --git a/docs/homey/products/temp1/examples/temp1-automation-examples.md b/docs/homey/products/temp1/examples/temp1-automation-examples.md index b932f49a83..fd6510980b 100755 --- a/docs/homey/products/temp1/examples/temp1-automation-examples.md +++ b/docs/homey/products/temp1/examples/temp1-automation-examples.md @@ -1,248 +1,100 @@ --- -title: Automation Examples using a TEMP-1 -description: "Multiple automation examples with the TEMP-1." +title: Automation examples using a TEMP-1 +description: "Homey flows for the TEMP-1: a push notification when your freezer gets too warm, and a green light plus one notification when the food probe reaches its target temperature." --- -# Automation Examples using a TEMP-1 -## Freezer Temperature Probe Example +# Automation examples using a TEMP-1 -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. +Difficulty: Level 2 -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. +
🌱 New here? Try these first:
+
+
-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.
+Your Apollo TEMP-1 sends every probe reading to Homey, and each new reading can start a flow. This page has two flows to build in the Homey mobile app: a freezer alert, and a food probe flow that lights the TEMP-1 green and messages you when dinner is almost ready.
-
+!!! note "Before you start"
-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.
+ - Add your TEMP-1 to Homey with the Apollo Automation app. See [Getting started](../../setup/getting-started-temp1/).
+ - Install the Homey mobile app on every phone that should get a notification.
+ - For the freezer flow, plug in the [temperature probe](../../addons/temp-probe/). For the food flow, plug in the [food probe](../../addons/food-probe/).
-
+## How probe readings reach Homey
-4\. The automation is now ready to be created -
+The Apollo Automation app gives each probe its own reading on the TEMP-1 and its own trigger card. Which one reports depends on the **Select probe** setting: open your TEMP-1's **Settings** and find it under **Probes and offsets for TEMP-1 and TEMP-1B**.
-5\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there!
+| Probe | Reading in Homey | Trigger card | How often it reports | Set **Select probe** to |
+| --- | --- | --- | --- | --- |
+| Temperature probe | **Temperature Probe** | **Temperature probe changed** | About once a minute | **Temperature** |
+| Food probe | **Food Probe** | **Food probe changed** | Every few seconds | **Food** |
-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.
+Both cards hand the new reading to the flow as a **Temperature** token, always in °C. The probe that isn't selected sends no readings, so its card never runs.
-
+The cards run each time the reading changes, not only when it crosses your limit. That's why each flow below checks the **Temperature** token in an **And...** condition, and why the food flow adds a second condition so it alerts you once instead of every few seconds.
-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.
+## Freezer over its maximum temperature
-
+This flow sends a push notification whenever the freezer probe reads warmer than your maximum. It is Flow 1 from [TEMP-1 alert outside a temperature range](../temp1-alert-example/#flow-1-too-warm), which walks through every tap and shows you how to pick a limit that suits your freezer.
-!!! tip "If you still do not see your device as shown in step 7 read this!"
+| Column | Card | Set it to |
+| --- | --- | --- |
+| **When...** | **Temperature probe changed**, from **Apollo Automation** for your TEMP-1 | Nothing to set |
+| **And...** | Homey's built-in condition for comparing numbers | **Temperature** token greater than **-10** |
+| **Then...** | **Send Message to User**, from **Push Notifications** | A message such as **Check the freezer!** with the **Temperature** token, sent to **Everyone** |
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
+Once it's saved, any probe reading above -10 °C sends the alert, with a reminder each time the reading changes until the freezer cools down again.
-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!".
+## Food probe reaches a target temperature
-
+Chicken is safe to eat at 74 °C (165 °F), and it keeps rising a few degrees while it rests. This flow fires at 71 °C (160 °F) so you can take it off the heat in time. When the food probe gets there, the TEMP-1's light turns green and your phone gets one notification.
-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!
+The light also stops the alert from repeating. The food probe reports every few seconds, so the flow only runs while the light is off; once the flow has turned it green, later readings leave it alone.
-
+!!! warning "Keep the TEMP-1 away from the heat"
----
-
-10\. YAML for Advanced Users
-
-```yaml
-alias: Freezer Over Max Temp Automation
-description: Warning for the freezer when it reaches the max temperature.
-triggers:
- - trigger: numeric_state
- entity_id:
- - number.apollo_temp_1_max_probe_temp
- above: 30
-conditions: []
-actions:
- - action: notify.mobile_app_brandons_iphone
- metadata: {}
- data:
- title: Check the freezer!
- message: >-
- The temperature probe on your TEMP-1 reached its max temperature and
- your freezer might be having issues.
-mode: single
-```
-
-## 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.
-
-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.
-
-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.
-
-
-
-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!"
-
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
-
-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!
-
-
-
----
-
-8\. YAML for Advanced Users
-
-```yaml
-alias: Food Over Max Temp Automation
-description: Warning for the food when it reaches the max temperature.
-triggers:
- - trigger: numeric_state
- entity_id:
- - number.apollo_temp_1_max_probe_temp
- above: 165
-conditions: []
-actions:
- - action: notify.mobile_app_brandons_iphone
- metadata: {}
- data:
- title: Check the food!
- message: >-
- The temperature probe on your TEMP-1 reached its max temperature and your food is ready.
-mode: single
-```
-
-## 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!
-
-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 the rgb led for your device
-
-
+ Only the food probe and its cable can go on the grill or in the oven. Set the TEMP-1 itself somewhere cool and dry, such as a side shelf.
-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.
+Before you build the flow, set **Select probe** to **Food** and check that the **Food Probe** reading on your TEMP-1 changes when you hold the probe tip in your hand.
-
+1. In the Homey mobile app, tap **Flow** in the bottom bar, then tap **+** at the top right (or **Create a Flow** if you have none yet).
+2. Under **When...**, tap **Add Card**. Open **Apollo Automation** under **Apps**, choose your TEMP-1, and choose **Food probe changed**.
+3. Under **And...**, tap **Add Card** and add Homey's built-in condition for comparing numbers. Set it to check that the **Temperature** token is greater than **71**.
+4. Under **And...**, tap **Add Card** again. Find your TEMP-1 under **Zones & Devices** and choose its condition for whether it is turned on. Turn on **Invert**, so the card checks that the TEMP-1 is turned off. On a TEMP-1, turned on and off means its RGB light.
+5. Under **Then...**, tap **Add Card**. Find your TEMP-1 under **Zones & Devices** and choose **Turn on**.
+6. Under **Then...**, tap **Add Card** again. Choose **Set a color** for your TEMP-1, pick green, and tap the check mark.
+7. Under **Then...**, add **Send Message to User** from **Push Notifications**. Type a message such as **Check the food! The food probe reads**, add the **Temperature** token after it, and pick a **User**.
+8. Tap **Next**. Name the flow, for example **Food is ready**, and tap **Save Flow**.
-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.
+The flow now shows in **My Flows**. When the food probe passes 71 °C, your TEMP-1 glows green and your phone gets one notification.
-
+### Reset it for the next cook
-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.
+When the food is off the heat, open your TEMP-1 in the Homey app and turn it off, which turns its light off. With the light off, the flow is ready to alert you again. Between cooks, you can also switch the flow off in **My Flows**.
-28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off.
+## Test your flows
-
+To check the alert without cooking anything, tap the play button next to the flow in **My Flows**. It runs its **Then** cards once, and a green check mark confirms it ran: the TEMP-1 lights green and the notification arrives. Turn the TEMP-1's light off afterwards so the flow is ready for the real thing.
-29\. Click choose entity then search for your device such as "Temp-1 RGB Light".
+If a flow doesn't run:
-
+- Check that **Select probe** matches the probe the flow uses: **Temperature** for the freezer flow, **Food** for the food flow.
+- Check that your limits are in °C.
+- For the food flow, check that the TEMP-1's light is off before the food reaches its target.
+- Check that the flow is switched on in **My Flows**.
-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.
+## Take it further
-
+- **More probes**: with the [Multi-Probe Splitter](../../addons/multiple-probes/), the extra probes each get their own trigger card: **Temperature probe 2 changed**, **Temperature probe 3 changed**, and **Temperature probe 4 changed**. Build the freezer flow once per probe to watch a fridge and a freezer from one TEMP-1.
+- **Other targets**: change the number in the food flow's condition for other dishes, and give each one its own message.
-31\. Click save in the bottom right then give it a name and save
+## Coming from the Home Assistant cook chicken example
-
+The [Home Assistant version of the cook chicken example](../../../../../products/temp1/examples/temp1-automation-examples/#cook-chicken-example), shared by Discord user RalphP, does a few things the Homey flow above handles differently or leaves out:
-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
+- **A dashboard button to start and stop monitoring.** In Homey, switch the flow on in **My Flows** when you start cooking and off when you're done.
+- **A blinking light when the food is ready.** The TEMP-1 has pulse effects for its light, but the Apollo Automation app has no card for them, so in Homey the light stays solid green.
+- **A spoken announcement on smart speakers.** The Home Assistant version uses text-to-speech. This guide doesn't cover speakers.
diff --git a/docs/homey/products/temp1/examples/use-cases.md b/docs/homey/products/temp1/examples/use-cases.md
index 2e630e30d8..3209c83aae 100755
--- a/docs/homey/products/temp1/examples/use-cases.md
+++ b/docs/homey/products/temp1/examples/use-cases.md
@@ -1,8 +1,8 @@
---
-title: Use Cases for the TEMP-1
+title: Use cases for the TEMP-1
description: "List of use cases for the TEMP-1."
---
-# Use Cases for the TEMP-1
+# Use cases for the TEMP-1
1\. Monitoring fridge / freezer: There are settings to set the maximum temperature the sensor should reach. It can alert through the onboard buzzer if it rises above that temperature. The cable on the probe is flat to not interfere with fridge seals.
diff --git a/docs/homey/products/temp1/faq.md b/docs/homey/products/temp1/faq.md
index a99889b9ef..ca88647e3c 100755
--- a/docs/homey/products/temp1/faq.md
+++ b/docs/homey/products/temp1/faq.md
@@ -1,8 +1,8 @@
---
title: TEMP-1 FAQ
-description: "Frequently asked questions about the TEMP-1 temperature sensor."
+description: "Answers to common questions about the TEMP-1 temperature sensor with Homey: power, probes, connecting to Homey, the out-of-range alarm, and reporting."
---
-# **TEMP-1 FAQ**
+# TEMP-1 FAQ
1\. **How is the TEMP-1 powered?**
@@ -12,21 +12,27 @@ description: "Frequently asked questions about the TEMP-1 temperature sensor."
* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
* 20cm (~8in) Waterproof Flat Cable (DS18B20) -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
-* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 204°C (400°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
+* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
-Sensor Interface: Equipped with a 3.5mm jack for connecting optional external temperature probes (sold separately). Compatible probe options include:
+ TEMP-1 alert outside a temperature range
+ Difficulty: Level 1
+
+\- 1.5m (~5ft) waterproof flat cable (DS18B20 sensor). Max 85°C 185°F
\- 20cm (~8in) waterproof flat cable (DS18B20 sensor). Max 85°C 185°F
\- 1m (~3ft) stainless steel food-safe probe (NTC sensor). Max 204°C 400°F **Not dishwasher safe** +Sensor Interface: Equipped with a 3.5mm jack for connecting optional external temperature probes (sold separately). Compatible probe options include:
\- 1.5m (~5ft) waterproof flat cable (DS18B20 sensor). Max 85°C 185°F
\- 20cm (~8in) waterproof flat cable (DS18B20 sensor). Max 85°C 185°F
\- 1m (~3ft) stainless steel food-safe probe (NTC sensor). Max 350°C 662°F **Not dishwasher safe** 3\. **Is the TEMP-1 weatherproof? Can I use it outdoors?** -* The TEMP-1 is primarily designed for indoor use, but components like the waterproof soil probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection. +* The TEMP-1 is primarily designed for indoor use, but the optional waterproof DS18B20 probes are suited for harsh conditions. The main body is not rated for outdoor use without additional protection. -4\. **How does the TEMP-1 connect to Home Assistant?** +4\. **How does the TEMP-1 connect to Homey?** -* The TEMP-1 connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant. +* The TEMP-1 joins your Wi-Fi, and the Apollo Automation app for Homey talks to it directly over your local network through the ESPHome native API, with no cloud account. Once you add it, its readings show up on the device in Homey, ready for flows and Insights. The app runs on Homey Pro; Homey Cloud isn't supported. + +!!! success "Next step: add your TEMP-1 to Homey" + + Connect the sensor to your Wi-Fi through its hotspot, then add it with the Apollo Automation app. The getting started guide walks you through both. + + [Get started with Homey](../setup/getting-started-temp1/){ .md-button .md-button--primary } 5\. **How often does the TEMP-1 send sensor data?** -* The TEMP-1’s reporting frequency is adjustable in ESPHome but most things default to 60seconds. You can set it for frequent updates or extend intervals to conserve battery life. +* Most TEMP-1 readings, including the temperature probe, update every 60 seconds by default. The interval is set in the sensor's firmware, and Homey has no setting for it, so changing it means editing the firmware with ESPHome. 6\. **Can I customize the TEMP-1 functionality?** @@ -34,24 +40,29 @@ Sensor Interface: Equipped with a 3.5mm jack for connecting optional external te 7\. **What are the RGB LED and piezo buzzer used for?** -* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure. +* The RGB LED is the TEMP-1's light in Homey. Turn it on or off, dim it, or change its color from the device or in a flow. +* The piezo buzzer sounds an alarm on its own when the probe temperature goes outside a range you set. In the device's **Settings** in the Homey app, set **Minimum probe temperature** and **Maximum probe temperature** (in °C), then check **Alarm when temperature outside configured range**. The alarm watches the probe chosen in **Select probe**. Homey flows can't play the buzzer themselves. + +!!! tip "The alarm checkbox is listed under TEMP PRO-1" + + **Alarm when temperature outside configured range** sits in the group **Temperature range and alarm settings for TEMP PRO-1**, but it works on the TEMP-1 too. The minimum and maximum are under **Probes and offsets for TEMP-1 and TEMP-1B**. For a full walkthrough, see [TEMP-1 alert outside a temperature range](../examples/temp1-alert-example/). 8\. **Is the TEMP-1 compatible with other smart home platforms?** -* While designed for Home Assistant via ESPHome, it may be compatible with other platforms using the ESPHome API or MQTT. +* Yes. Besides Homey (through the Apollo Automation app), the TEMP-1 works with Home Assistant, and it may work with other platforms through the ESPHome API or MQTT. See [Supported platforms](../../general/supported-platforms/). 9\. **Do I need coding knowledge to use the TEMP-1?** -* Basic knowledge of Home Assistant and ESPHome is helpful, but most users can utilize it out of the box. For advanced customization, YAML knowledge is recommended. +* No. Adding the TEMP-1 to Homey and building flows takes no code. YAML knowledge only matters if you want to customize the firmware with ESPHome. 10\. **Can I access data from the TEMP-1 remotely?** -* Yes, you can access sensor data remotely via the Home Assistant dashboard if your setup is configured for remote access. +* Yes. The TEMP-1 reports to your Homey over your local network, and the Homey app shows its readings wherever you are, as long as your Homey is reachable remotely. 11\. **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 connects directly to a USB-C power source. -12\. **Can I use multiple TEMP-1 sensors in one Home Assistant setup?** +12\. **Can I use multiple TEMP-1 sensors with one Homey?** -* Yes, you can add multiple TEMP-1 sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces. \ No newline at end of file +* Yes. Add each TEMP-1 with the Apollo Automation app. Each one shows up as its own device in Homey, so you can monitor several rooms or spaces at the same time. diff --git a/docs/homey/products/temp1/setup/getting-started-temp1.md b/docs/homey/products/temp1/setup/getting-started-temp1.md index 7e77e91c4a..340c9b1ac9 100644 --- a/docs/homey/products/temp1/setup/getting-started-temp1.md +++ b/docs/homey/products/temp1/setup/getting-started-temp1.md @@ -2,4 +2,4 @@ title: Getting Started description: "Generic getting started article." --- ---8<-- "homey/products/general/setup/getting-started-temp1.md:5:" +--8<-- "homey/products/general/setup/getting-started.md:6:" diff --git a/docs/homey/products/temp1/setup/prevent-sleep.md b/docs/homey/products/temp1/setup/prevent-sleep.md index 2eeea90ed5..aac6cd1304 100755 --- a/docs/homey/products/temp1/setup/prevent-sleep.md +++ b/docs/homey/products/temp1/setup/prevent-sleep.md @@ -1,35 +1,52 @@ --- -title: Prevent Sleep -description: "Guide for setting up and using the prevent sleep toggle with the TEMP-1." +title: Prevent sleep +description: "Why the USB-powered TEMP-1 stays awake in Homey, what its Prevent sleep and Sleep duration settings do, and how to correct the board temperature instead." --- -# Prevent Sleep +# Prevent sleep -!!! tip "Put your sensors to sleep!" +Your Apollo TEMP-1 runs on USB power, but its firmware can still sleep between readings: it wakes up, reports, and goes back to sleep. Sleeping keeps the board from warming itself up, so the board temperature reads closer to the room. The TEMP-1 ships with **Prevent sleep** on, so it stays awake and reports all the time. - 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. +## Sleep isn't available for the TEMP-1 in Homey - 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. +In Homey, your TEMP-1 stays awake. You'll see **Prevent sleep** and **Sleep duration** in your TEMP-1's **Settings** in the Homey app, under **Battery settings (if battery is present)**, but the Apollo Automation app only lets you change **Prevent sleep** on a sensor with a battery. If you uncheck it on the TEMP-1, Homey refuses the change and shows **Battery settings are not supported on this device.** -1\. Head to the ESPHome Integrations page. +Staying awake is how Homey expects a USB-powered sensor to work, so there's nothing you need to change here. -2\. Click on the name "1 device" below your Apollo device's name. +!!! tip "Leave Sleep duration as it is" - + Homey shows **Sleep duration** in hours, but the TEMP-1 reads the number as minutes: the default of 8 means 8 minutes. It only applies while Prevent sleep is off, so you don't need to change it in Homey. -3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration". +!!! tip "Using Home Assistant too?" - + Home Assistant can turn sleep on for the TEMP-1. See the [Home Assistant Prevent Sleep guide](../../../../../products/temp1/additional-info/prevent-sleep/). While the TEMP-1 sleeps, Homey loses its connection between reports. -4\. Type in the amount of minutes you want your sensor to sleep in the "Sleep Duration" box. Defaults to 8 minutes. +## Correct the board temperature instead -!!! warning "Read this before turning off Prevent Sleep!" +If you wanted sleep to stop the board's own warmth from nudging the temperature up, an offset fixes the reading without it. You need a reference thermometer you trust. - When "Prevent Sleep" is toggled off, your sensor will immediately begin sleeping. Please make sure you are ready to make this sensor sleep before toggling off prevent sleep. +1. Put the reference thermometer next to your TEMP-1 and give both time to settle. +2. Compare the TEMP-1's temperature reading in Homey with the reference. Use the board reading, not a probe. +3. In your TEMP-1's **Settings**, under **Probes and offsets for TEMP-1 and TEMP-1B**, set **Board temperature offset** to how many degrees Celsius the TEMP-1 reads too high, and save. For example, if the TEMP-1 shows 23.5 °C and the reference shows 22 °C, enter 1.5. -5\. When you are ready, toggle off "Prevent Sleep" and your sensor will go to sleep. It will wake up every 8 minutes, or on the interval you set in step 4. If you need to keep your sensor awake, head to our OTA Awake helper tutorial! +The TEMP-1's temperature in Homey now matches your reference thermometer. The offset only changes the board reading, not a probe plugged into the TEMP-1. -6\. You can wake your sensor by following this guide or you can power cycle your device. If there is a battery in it, the battery will need to be removed or the reset button pressed. +!!! tip "Homey set to Fahrenheit?" -!!! danger "Do not leave your sensor outside or let it get wet!" + The offset is always in degrees Celsius. Divide the difference you see in °F by 1.8: a reading 2.7 °F too high is an offset of 1.5. - The TEMP-1B should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your TEMP-1B if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file +## If your TEMP-1 was set to sleep before + +If Prevent sleep was turned off earlier, for example in Home Assistant, the TEMP-1 remembers it and keeps sleeping after you add it to Homey, so Homey keeps losing the connection. Homey can't change Prevent sleep on the TEMP-1, so turn it back on with the boot button. [Putting the TEMP-1 in boot mode](../../troubleshooting/temp1-boot-mode/) shows where the button is. + +!!! warning "Don't hold the boot button while you plug in" + + Plugging in with the boot button held puts the TEMP-1 in boot mode for flashing firmware instead. Also let go before 10 seconds: holding the boot button that long resets the TEMP-1 to factory settings and erases its Wi-Fi. + +1. Unplug the TEMP-1 and plug it back in to wake it. +2. Wait a few seconds, then press and hold the boot button for 4 to 5 seconds and let go. + +The TEMP-1 turns Prevent sleep back on and stays connected to Homey, and **Prevent sleep** shows as checked in its settings. If Homey loses the connection again a few seconds later, the TEMP-1 was already on its way back to sleep. It still remembers Prevent sleep, so unplug it and plug it back in once more, and it stays awake this time. + +!!! danger "Keep your TEMP-1 dry" + + Don't leave the TEMP-1 outside for long periods or let it get wet. If it will sit in damp air or could see rain, put it inside another, protective case. diff --git a/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md index 765fb4f692..8080bf6350 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md @@ -1,14 +1,16 @@ --- -title: Putting The TEMP-1 In Boot Mode +title: Putting the TEMP-1 in boot mode description: "Step by step guide for putting The TEMP-1 In Boot Mode." --- -# Putting The TEMP-1 In Boot Mode +# Putting the TEMP-1 in boot mode !!! info "This will cover how to put the TEMP-1 into 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 + +You can put your device into boot mode with only the boot button and a paperclip. 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 +26,9 @@ 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/homey/products/temp1/troubleshooting/temp1-code/). -## Method 2: Boot and Reset Buttons +## Method 2: Boot and reset buttons + +You can also open the case and use the boot and reset buttons together to put your device into boot mode. 1\. Unplug the device and remove the case as shown in the images above diff --git a/docs/homey/products/temp1/troubleshooting/temp1-code.md b/docs/homey/products/temp1/troubleshooting/temp1-code.md index 5b5511e7ad..df8bdf9783 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-code.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-code.md @@ -1,36 +1,42 @@ --- -title: Factory Re-Flash TEMP-1 +title: Factory re-flash TEMP-1 description: "Step by step guide for re-flashing the TEMP-1 back to factory firmware." --- -# Factory Re-Flash TEMP-1 +# Factory re-flash TEMP-1 !!! 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." This needs to be done in Chrome, Edge, or another Chromium based browser. -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. +If your device has already been added to Homey, please remove it from Homey before continuing. -1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable. +Follow these steps to put your device in boot mode and install the factory firmware. -2\. Navigate to our installer page and click connect under Battery Firmware [Apollo TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/). +1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable. -3\. Click "Connect" under the Non Battery Firmware option since you are using a TEMP-1. +2\. Navigate to the [Apollo TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/). - +3\. Click "Connect" under **Non Battery Firmware Revision 2** since you are using a TEMP-1. -3\. Select the open com port then click Connect. +!!! tip "Use R2 version unless instructed to use R1 by support!" + + R2 is what all of our devices use except a very small batch of TEMP-1 and TEMP-1B + + + +4\. Select the open com port then click Connect.  -4\. Click "Install ApolloAutomation.TEMP-1". +5\. Click "Install ApolloAutomation.TEMP-1".  -5\. Click "INSTALL". +6\. Click "INSTALL".  -6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.  @@ -38,4 +44,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and set up 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/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md b/docs/homey/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md index e4d198b3f7..f06eecfa0a 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials on your TEMP-1 +title: Reset Wi-Fi credentials on your TEMP-1 description: "Step by step guide for resetting the Wi-Fi Credentials on your TEMP-1." --- -# Reset Wi-Fi Credentials on your TEMP-1 +# Reset Wi-Fi credentials on your TEMP-1 + +You can clear the Wi-Fi details saved on your device and connect it to a new Wi-Fi network through its hotspot. 1\. Plug the device into power. @@ -14,4 +16,4 @@ description: "Step by step guide for resetting the Wi-Fi Credentials on your TEM 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. -4\. Connect to the hotspot titled "Apollo TEMP-1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file +4\. Connect to the hotspot titled "Apollo TEMP1 Hotspot" and enter your new Wi-Fi details! \ 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 6bb0a66537..cdeb35ca38 100755 --- a/docs/homey/products/temp1/troubleshooting/temp1-teardown.md +++ b/docs/homey/products/temp1/troubleshooting/temp1-teardown.md @@ -1,8 +1,10 @@ --- -title: Teardown Of TEMP-1 +title: Teardown of TEMP-1 description: "Step by step guide for tearing down your TEMP-1 to replace parts, clean it, swap cases, etc." --- -# Teardown Of TEMP-1 +# Teardown of TEMP-1 + +Follow these steps to take your sensor apart and put it back together. 1\. Gently pry open the case lid as shown in the image below. diff --git a/docs/homey/products/temp1b/addons/food-probe.md b/docs/homey/products/temp1b/addons/food-probe.md index fa776a744f..ce8366ac1e 100755 --- a/docs/homey/products/temp1b/addons/food-probe.md +++ b/docs/homey/products/temp1b/addons/food-probe.md @@ -1,14 +1,14 @@ --- -title: TEMP-1B Food Probe +title: TEMP-1B food probe description: "Step by step guide for installing and using the optional Food Probe with the TEMP-1B." --- -# TEMP-1B Food Probe +# TEMP-1B food probe -The TEMP-1B 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. +The TEMP-1B 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-1B 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-1B. +1\. To use your food probe, take it out of the package and insert it into the 3.5mm port on your TEMP-1B.  @@ -18,15 +18,13 @@ The TEMP-1B comes with an optional food probe which can be used to monitor food !!! tip "If you are using it with a battery you need to push the reset button." - The TEMP-1B looks for the food probe when it boots and if it is not there then the sensor is marked as failed and will not work properly in Home Assistant. You need to click the reset button if you have a battery in it or power cycle your TEMP-1B to make it reliably use the new food temperature probe. + The TEMP-1B looks for the food probe when it boots and if it is not there then the sensor is marked as failed and will not report a temperature. You need to click the reset button if you have a battery in it or power cycle your TEMP-1B to make it reliably use the new food temperature probe.  -3\. Go to the device page of your TEMP-1B in Home Assistant and choose probe "Food". - - +3\. In the Homey app, open your TEMP-1B's **Settings** and, under **Probes and offsets for TEMP-1 and TEMP-1B**, set **Select probe** to **Food**. !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/homey/products/temp1b/addons/magnetic-mount.md b/docs/homey/products/temp1b/addons/magnetic-mount.md index d7c12c7d1e..030fca8b66 100755 --- a/docs/homey/products/temp1b/addons/magnetic-mount.md +++ b/docs/homey/products/temp1b/addons/magnetic-mount.md @@ -1,8 +1,8 @@ --- -title: TEMP-1B Magnetic Mount +title: TEMP-1B magnetic mount description: "Step by step guide for installing and using the optional Magnetic Mount with the TEMP-1B." --- -# TEMP-1B Magnetic Mount +# TEMP-1B magnetic mount The TEMP-1B comes with an optional magnetic mount which can be used to secure the TEMP-1B to your fridge or grill as shown below. diff --git a/docs/homey/products/temp1b/battery-sensors/sensor-connection-check.md b/docs/homey/products/temp1b/battery-sensors/sensor-connection-check.md index 6bc40dbe4f..7e1509c948 100644 --- a/docs/homey/products/temp1b/battery-sensors/sensor-connection-check.md +++ b/docs/homey/products/temp1b/battery-sensors/sensor-connection-check.md @@ -1,5 +1,5 @@ --- title: Sensor Connection Check -description: "How to check if your device is connected to Wi-Fi, Home Assistant, or nothing." +description: "How to check if your device is connected to Wi-Fi, Homey, or nothing." --- --8<-- "homey/products/general/battery-sensors/sensor-connection-check.md:5:" diff --git a/docs/homey/products/temp1b/examples/temp1b-alert-example.md b/docs/homey/products/temp1b/examples/temp1b-alert-example.md index eccc8681b4..cd74054b1d 100755 --- a/docs/homey/products/temp1b/examples/temp1b-alert-example.md +++ b/docs/homey/products/temp1b/examples/temp1b-alert-example.md @@ -1,23 +1,104 @@ --- -title: TEMP-1B Alert Outside Temp Range Example -description: "Step by step guide for alerting outside the set range with the TEMP-1B." +title: TEMP-1B alert outside a temperature range +description: "Build two Homey flows that send a push notification when the TEMP-1B temperature probe reads warmer or colder than the range you pick, and optionally sound the TEMP-1B's own buzzer." --- -# TEMP-1B Alert Outside Temp Range Example -###### +# TEMP-1B alert outside a temperature range -This will guide you through how to set up the built in alarm using the temperature probe in your freezer! +Difficulty: Level 1 -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. +Your Apollo TEMP-1B sends its temperature probe reading to Homey whenever it's awake, and every new reading can start a flow. In this guide you build two flows in the Homey mobile app that keep watch on a freezer: the first sends a push notification when the probe gets too warm, the second when it gets too cold. -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. +!!! note "Before you start" - + - Add your TEMP-1B to Homey with the Apollo Automation app. See [Getting started](../../setup/getting-started-temp1/). + - Plug the [temperature probe](../../addons/temp-probe/) into the TEMP-1B. Open your TEMP-1B's **Settings** and, under **Probes and offsets for TEMP-1 and TEMP-1B**, set **Select probe** to **Temperature**. With **Food** selected, the temperature probe sends no readings. + - Install the Homey mobile app on every phone that should get the alert. + - Decide how quickly you need to hear about a problem. A sleeping TEMP-1B only reports when it wakes; [How often your TEMP-1B reports](#how-often-your-temp-1b-reports) explains the trade-off with battery life. -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. +## How often your TEMP-1B reports - +Your flows can only react to readings the TEMP-1B sends, and it only sends them while it's awake. -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 +- With **Prevent sleep** on, the TEMP-1B stays connected and reports the probe about once a minute. This drains the battery fastest. +- With **Prevent sleep** off, it sleeps between readings and reports once each time it wakes, every 12 hours unless you change **Sleep duration**. An alert can arrive that long after the problem started. - \ No newline at end of file +For a freezer, set **Sleep duration** (in hours) to the longest delay you're comfortable with, for example **1** for a reading every hour. Shorter sleeps use more battery. Both settings are under **Battery settings (if battery is present)** in your TEMP-1B's **Settings**, and [Prevent sleep](../../setup/prevent-sleep/) walks you through changing them. + +!!! warning "Change settings while the TEMP-1B is awake" + + Homey can only change the TEMP-1B's settings while it's awake. If Homey shows **The device is asleep. Settings can be changed when it next wakes up.**, wake the sensor and try again. See [How to wake up your sensor](../../battery-sensors/wake-up-battery-sensor/). + +## Pick your range + +Find out what your freezer normally swings between before you set any limits. That way the alert only fires when something is actually wrong. + +1. Place the probe in the freezer and run its flat cable out through the door seal. Keep the TEMP-1B itself outside the freezer, somewhere cool and dry: only the probe and its cable can handle the cold. +2. Leave it for a few hours so the reading settles. [Most freezers should sit at or below -18 °C (0 °F)](https://www.fda.gov/food/buy-store-serve-safe-food/refrigerator-thermometers-cold-facts-about-food-safety). +3. In Homey Insights, look at your TEMP-1B's **Temperature Probe** history. Note the highest and lowest readings. +4. Pick a maximum a little above the highest reading and a minimum a little below the lowest. This guide uses -10 °C and -30 °C; yours will likely differ. + +You now have a range that covers normal use and flags a real problem. + +!!! tip "Enter your limits in degrees Celsius" + + The **Temperature Probe** reading, and the **Temperature** token the flows below compare, are always in °C. If you think in Fahrenheit, convert first: -10 °C is 14 °F, and -30 °C is -22 °F. + +## Flow 1: Too warm + +This flow runs each time the probe reading changes, checks it against your maximum, and sends the alert when the freezer is too warm. + +1. In the Homey mobile app, tap **Flow** in the bottom bar, then tap **+** at the top right (or **Create a Flow** if you have none yet). +2. Under **When...**, tap **Add Card**. Open **Apollo Automation** under **Apps**, and choose your TEMP-1B. +3. Choose the card **Temperature probe changed**. It hands the new reading to the rest of the flow as the **Temperature** token. +4. Under **And...**, tap **Add Card** and add Homey's built-in condition for comparing numbers. Set it to check that the **Temperature** token is greater than **-10**. +5. Under **Then...**, tap **Add Card** and choose **Send Message to User** from **Push Notifications**. +6. Type a message, for example **Check the freezer! The TEMP-1B probe reads**, and add the **Temperature** token after it. +7. Tap **User** and pick who gets the alert, such as **Everyone**, then tap the check mark at the top right. +8. Tap **Next**. Name the flow, for example **Freezer too warm**, and tap **Save Flow**. + +The flow now shows in **My Flows**. The next probe reading above -10 °C sends the alert to your phone. + +## Flow 2: Too cold + +The second flow mirrors the first. Build it the same way, with these changes: + +1. In the **And...** condition, check that the **Temperature** token is less than **-30**. +2. Change the message, for example to **The freezer is colder than usual. The TEMP-1B probe reads**, followed by the **Temperature** token. +3. Name the flow **Freezer too cold** and tap **Save Flow**. + +Both ends of your range are now covered: you hear about it whether the freezer warms up or runs too cold. + +!!! warning "Expect a reminder with each new reading" + + **Temperature probe changed** runs every time the reading changes, not only when it crosses your limit. While the probe stays out of range, every change sends another notification (up to once a minute while the TEMP-1B is awake, or once per wake-up while it sleeps) until the temperature is back inside your range. To pause the reminders while you deal with the freezer, switch the flow off in **My Flows**, and switch it back on afterwards. + +## Test your flows + +To check the alert without warming up your freezer, tap the play button next to a flow in **My Flows**. It runs its **Then** cards once, and a green check mark confirms it ran. Your phone gets the notification. + +If a flow doesn't run when the freezer is out of range: + +- Check that **Select probe** is set to **Temperature** and that the **Temperature Probe** reading updates each time the TEMP-1B wakes. +- Check that your limits are in °C. +- Check that both flows are switched on in **My Flows**. + +## Optional: sound the TEMP-1B's buzzer too + +The TEMP-1B can also raise the alarm on its own. When you turn this on, the sensor checks every probe reading against a minimum and maximum you store on the device and sounds a short siren from its buzzer when the reading is outside them. It works alongside your flows, so anyone near the freezer hears it even if their phone is on silent. Like your flows, it only checks readings the TEMP-1B takes while it's awake. + +1. Open your TEMP-1B's **Settings**. +2. Under **Probes and offsets for TEMP-1 and TEMP-1B**, set **Minimum probe temperature** and **Maximum probe temperature** in °C, for example **-30** and **-10**. +3. Under **Temperature range and alarm settings for TEMP PRO-1**, turn on **Alarm when temperature outside configured range**. The group is named for the TEMP PRO-1, but this setting also switches the TEMP-1B's alarm on and off. + +The TEMP-1B now sounds the siren with each probe reading outside your range, until the reading is back inside it. + +!!! tip "Use the probe settings, not the TEMP PRO-1 ones" + + **Minimum temperature** and **Maximum temperature** in the TEMP PRO-1 group belong to the TEMP PRO-1 and don't change anything on a TEMP-1B. Set the range with **Minimum probe temperature** and **Maximum probe temperature** instead. + +!!! success "Next step: know when dinner is ready" + + Your freezer is covered. The automation examples put the food probe to work: a flow that lights your TEMP-1B green and sends you one notification when your food reaches its target temperature. + + [Build the food probe flow](../temp1b-automation-examples/#food-probe-reaches-a-target-temperature){ .md-button .md-button--primary } diff --git a/docs/homey/products/temp1b/examples/temp1b-automation-examples.md b/docs/homey/products/temp1b/examples/temp1b-automation-examples.md index 108cca7f5d..3266075b3f 100755 --- a/docs/homey/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/homey/products/temp1b/examples/temp1b-automation-examples.md @@ -1,248 +1,111 @@ --- -title: Automation Examples using a TEMP-1B -description: "Multiple automation examples with the TEMP-1B." +title: Automation examples using a TEMP-1B +description: "Homey flows for the TEMP-1B: a push notification when your freezer gets too warm, and a green light plus one notification when the food probe reaches its target temperature." --- -# Automation Examples using a TEMP-1B -## Freezer Temperature Probe Example +# Automation examples using a TEMP-1B -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. +Difficulty: Level 2 -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. +
🌱 New here? Try these first:
+
+
-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.
+Your Apollo TEMP-1B sends every probe reading to Homey while it's awake, and each new reading can start a flow. This page has two flows to build in the Homey mobile app: a freezer alert, and a food probe flow that lights the TEMP-1B green and messages you when dinner is almost ready.
-
+!!! note "Before you start"
-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.
+ - Add your TEMP-1B to Homey with the Apollo Automation app. See [Getting started](../../setup/getting-started-temp1/).
+ - Install the Homey mobile app on every phone that should get a notification.
+ - For the freezer flow, plug in the [temperature probe](../../addons/temp-probe/). For the food flow, plug in the [food probe](../../addons/food-probe/).
-
+## How probe readings reach Homey
-4\. The automation is now ready to be created -
+The Apollo Automation app gives each probe its own reading on the TEMP-1B and its own trigger card. Which one reports depends on the **Select probe** setting: open your TEMP-1B's **Settings** and find it under **Probes and offsets for TEMP-1 and TEMP-1B**.
-5\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there!
+| Probe | Reading in Homey | Trigger card | How often it reports while awake | Set **Select probe** to |
+| --- | --- | --- | --- | --- |
+| Temperature probe | **Temperature Probe** | **Temperature probe changed** | About once a minute | **Temperature** |
+| Food probe | **Food Probe** | **Food probe changed** | Every few seconds | **Food** |
-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.
+Both cards hand the new reading to the flow as a **Temperature** token, always in °C. The probe that isn't selected sends no readings, so its card never runs.
-
+The cards run each time the reading changes, not only when it crosses your limit. That's why each flow below checks the **Temperature** token in an **And...** condition, and why the food flow adds a second condition so it alerts you once instead of every few seconds.
-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.
+### Readings and sleep
-
+The TEMP-1B only sends readings while it's awake. With **Prevent sleep** on, it stays connected and reports as shown in the table. With **Prevent sleep** off, it reports once each time it wakes, every 12 hours unless you change **Sleep duration** (in hours). Both settings are under **Battery settings (if battery is present)** in your TEMP-1B's **Settings**, and [Prevent sleep](../../setup/prevent-sleep/) walks you through changing them.
-!!! tip "If you still do not see your device as shown in step 7 read this!"
+!!! warning "Change settings while the TEMP-1B is awake"
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
+ Homey can only change the TEMP-1B's settings, including **Select probe** and **Prevent sleep**, while it's awake. If Homey shows **The device is asleep. Settings can be changed when it next wakes up.**, wake the sensor and try again. See [How to wake up your sensor](../../battery-sensors/wake-up-battery-sensor/).
-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!".
+## Freezer over its maximum temperature
-
+This flow sends a push notification whenever the freezer probe reads warmer than your maximum. It is Flow 1 from [TEMP-1B alert outside a temperature range](../temp1b-alert-example/#flow-1-too-warm), which walks through every tap and shows you how to pick a limit and a **Sleep duration** that suit your 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!
+| Column | Card | Set it to |
+| --- | --- | --- |
+| **When...** | **Temperature probe changed**, from **Apollo Automation** for your TEMP-1B | Nothing to set |
+| **And...** | Homey's built-in condition for comparing numbers | **Temperature** token greater than **-10** |
+| **Then...** | **Send Message to User**, from **Push Notifications** | A message such as **Check the freezer!** with the **Temperature** token, sent to **Everyone** |
-
+Once it's saved, any probe reading above -10 °C sends the alert, with a reminder each time the reading changes until the freezer cools down again.
----
-
-10\. YAML for Advanced Users
-
-```yaml
-alias: Freezer Over Max Temp Automation
-description: Warning for the freezer when it reaches the max temperature.
-triggers:
- - trigger: numeric_state
- entity_id:
- - number.apollo_temp_1b_max_probe_temp
- above: 30
-conditions: []
-actions:
- - action: notify.mobile_app_brandons_iphone
- metadata: {}
- data:
- title: Check the freezer!
- message: >-
- The temperature probe on your TEMP-1B reached its max temperature and
- your freezer might be having issues.
-mode: single
-```
-
-## 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.
-
-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.
-
-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.
-
-
-
-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!"
-
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
-
-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!
-
-
-
----
-
-8\. YAML for Advanced Users
-
-```yaml
-alias: Food Over Max Temp Automation
-description: Warning for the food when it reaches the max temperature.
-triggers:
- - trigger: numeric_state
- entity_id:
- - number.apollo_temp_1b_max_probe_temp
- above: 165
-conditions: []
-actions:
- - action: notify.mobile_app_brandons_iphone
- metadata: {}
- data:
- title: Check the food!
- message: >-
- The temperature probe on your TEMP-1B reached its max temperature and your food is ready.
-mode: single
-```
-
-## 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!
-
-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.
+## Food probe reaches a target temperature
-
+Chicken is safe to eat at 74 °C (165 °F), and it keeps rising a few degrees while it rests. This flow fires at 71 °C (160 °F) so you can take it off the heat in time. When the food probe gets there, the TEMP-1B's light turns green and your phone gets one notification.
-23\. Click "Add Action" under the "until" condition we created above. Be very careful to select the correct "Add Action" button as shown below.
+The light also stops the alert from repeating. The food probe reports every few seconds, so the flow only runs while the light is off; once the flow has turned it green, later readings leave it alone.
-
+!!! warning "Keep the TEMP-1B away from the heat"
-24\. Search "light toggle" in the search bar shown then select "Choose entity" and select the rgb led for your device
+ Only the food probe and its cable can go on the grill or in the oven. Set the TEMP-1B itself somewhere cool and dry, such as a side shelf.
-
+Before you build the flow, wake your TEMP-1B, turn on **Prevent sleep** so it reports for the whole cook, and set **Select probe** to **Food**. Check that the **Food Probe** reading on your TEMP-1B changes when you hold the probe tip in your hand.
-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.
+1. In the Homey mobile app, tap **Flow** in the bottom bar, then tap **+** at the top right (or **Create a Flow** if you have none yet).
+2. Under **When...**, tap **Add Card**. Open **Apollo Automation** under **Apps**, choose your TEMP-1B, and choose **Food probe changed**.
+3. Under **And...**, tap **Add Card** and add Homey's built-in condition for comparing numbers. Set it to check that the **Temperature** token is greater than **71**.
+4. Under **And...**, tap **Add Card** again. Find your TEMP-1B under **Zones & Devices** and choose its condition for whether it is turned on. Turn on **Invert**, so the card checks that the TEMP-1B is turned off. On a TEMP-1B, turned on and off means its RGB light.
+5. Under **Then...**, tap **Add Card**. Find your TEMP-1B under **Zones & Devices** and choose **Turn on**.
+6. Under **Then...**, tap **Add Card** again. Choose **Set a color** for your TEMP-1B, pick green, and tap the check mark.
+7. Under **Then...**, add **Send Message to User** from **Push Notifications**. Type a message such as **Check the food! The food probe reads**, add the **Temperature** token after it, and pick a **User**.
+8. Tap **Next**. Name the flow, for example **Food is ready**, and tap **Save Flow**.
-
+The flow now shows in **My Flows**. When the food probe passes 71 °C, your TEMP-1B glows green and your phone gets one notification.
-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.
+### Reset it for the next cook
-
+When the food is off the heat, open your TEMP-1B in the Homey app and turn it off, which turns its light off. With the light off, the flow is ready to alert you again. The TEMP-1B also turns its light off whenever it goes to sleep.
-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.
+Then turn **Prevent sleep** off again if you want to save battery, and switch the flow off in **My Flows** until your next cook.
-28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off.
+## Test your flows
-
+To check the alert without cooking anything, wake your TEMP-1B and tap the play button next to the flow in **My Flows**. It runs its **Then** cards once, and a green check mark confirms it ran: the TEMP-1B lights green and the notification arrives. Turn the TEMP-1B's light off afterwards so the flow is ready for the real thing.
-29\. Click choose entity then search for your device such as "Temp-1 RGB Light".
+If a flow doesn't run:
-
+- Check that **Select probe** matches the probe the flow uses: **Temperature** for the freezer flow, **Food** for the food flow.
+- Check that the TEMP-1B is awake, or wait for its next wake-up.
+- Check that your limits are in °C.
+- For the food flow, check that the TEMP-1B's light is off before the food reaches its target.
+- Check that the flow is switched on in **My Flows**.
-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.
+## Take it further
-
+- **More probes**: with the [Multi-Probe Splitter](../../addons/multiple-probes/), the extra probes each get their own trigger card: **Temperature probe 2 changed**, **Temperature probe 3 changed**, and **Temperature probe 4 changed**. Build the freezer flow once per probe to watch a fridge and a freezer from one TEMP-1B.
+- **Other targets**: change the number in the food flow's condition for other dishes, and give each one its own message.
-31\. Click save in the bottom right then give it a name and save
+## Coming from the Home Assistant cook chicken example
-
+The [Home Assistant version of the cook chicken example](../../../../../products/temp1b/examples/temp1b-automation-examples/#cook-chicken-example), shared by Discord user RalphP, does a few things the Homey flow above handles differently or leaves out:
-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
+- **A dashboard button to start and stop monitoring.** In Homey, switch the flow on in **My Flows** when you start cooking and off when you're done.
+- **A blinking light when the food is ready.** The TEMP-1B has pulse effects for its light, but the Apollo Automation app has no card for them, so in Homey the light stays solid green.
+- **A spoken announcement on smart speakers.** The Home Assistant version uses text-to-speech. This guide doesn't cover speakers.
diff --git a/docs/homey/products/temp1b/examples/use-cases.md b/docs/homey/products/temp1b/examples/use-cases.md
index 922bd1ab1e..bc67d644b6 100755
--- a/docs/homey/products/temp1b/examples/use-cases.md
+++ b/docs/homey/products/temp1b/examples/use-cases.md
@@ -1,8 +1,8 @@
---
-title: Use Cases for the TEMP-1B
+title: Use cases for the TEMP-1B
description: "List of use cases for the TEMP-1B."
---
-# Use Cases for the TEMP-1B
+# Use cases for the TEMP-1B
1\. Monitoring fridge / freezer: There are settings to set the maximum temperature the sensor should reach. It can alert through the onboard buzzer if it rises above that temperature. The cable on the probe is flat to not interfere with fridge seals.
diff --git a/docs/homey/products/temp1b/faq.md b/docs/homey/products/temp1b/faq.md
index 9469fbc1b9..4a7750dc80 100755
--- a/docs/homey/products/temp1b/faq.md
+++ b/docs/homey/products/temp1b/faq.md
@@ -1,10 +1,10 @@
---
title: TEMP-1B FAQ
-description: "Frequently asked questions about the TEMP-1B temperature sensor."
+description: "Answers to common questions about the TEMP-1B battery temperature sensor with Homey: battery, probes, connecting to Homey, sleep settings, and the out-of-range alarm."
---
-# **TEMP-1B FAQ**
+# TEMP-1B FAQ
-1\.**How is the TEMP-1B powered?**
+1\. **How is the TEMP-1B powered?**
* The TEMP-1B operates with a **rechargeable** 16340 Flat Top battery (not included), giving it portability for temp monitoring without being tied to an outlet.
@@ -20,19 +20,29 @@ description: "Frequently asked questions about the TEMP-1B temperature sensor."
* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
-* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 204°C (400°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
+* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
5\. **Is the TEMP-1B weatherproof? Can I use it outdoors?**
-* The TEMP-1B is primarily designed for indoor use, but components like the waterproof soil probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection.
+* The TEMP-1B is primarily designed for indoor use, but the waterproof DS18B20 temperature probes are suited for harsh conditions. The main body is not rated for outdoor use without additional protection.
-6\. **How does the TEMP-1B connect to Home Assistant?**
+6\. **How does the TEMP-1B connect to Homey?**
-* The TEMP-1B connects via Wi-Fi to ESPHome on Home Assistant, enabling data monitoring, automations, and alerts directly within Home Assistant.
+* The TEMP-1B joins your Wi-Fi, and the Apollo Automation app for Homey talks to it directly over your local network through the ESPHome native API, with no cloud account. Once you add it, its readings show up on the device in Homey, ready for flows and Insights. The app runs on Homey Pro; Homey Cloud isn't supported.
+
+!!! success "Next step: add your TEMP-1B to Homey"
+
+ Connect the sensor to your Wi-Fi through its hotspot, then add it with the Apollo Automation app. The getting started guide walks you through both.
+
+ [Get started with Homey](../setup/getting-started-temp1/){ .md-button .md-button--primary }
7\. **How often does the TEMP-1B send sensor data?**
-* The TEMP-1B’s reporting frequency is adjustable in ESPHome but most things default to 60seconds. You can set it for frequent updates or extend intervals to conserve battery life.
+* A new TEMP-1B ships with **Prevent sleep** checked, so it stays awake and reports most readings every 60 seconds. That drains the battery fast. Once you uncheck Prevent sleep, the TEMP-1B wakes up, sends its readings to Homey, and goes back to sleep to save battery. How long it sleeps is the **Sleep duration** setting, in hours (12 by default). Both settings are under **Battery settings (if battery is present)** in the device's **Settings** in the Homey app. A shorter sleep gives fresher readings and a shorter battery life. See [Prevent sleep](../setup/prevent-sleep/) for the details.
+
+!!! tip "Change settings while the TEMP-1B is awake"
+
+ Homey can only send a setting while the sensor is awake and connected. If it's asleep, Homey shows **The device is asleep. Settings can be changed when it next wakes up.** [Keep the sensor awake](../setup/prevent-sleep/#keep-your-temp-1b-awake-again) and try again.
8\. **Can I customize the TEMP-1B’s functionality?**
@@ -40,24 +50,29 @@ description: "Frequently asked questions about the TEMP-1B temperature sensor."
9\. **What are the RGB LED and piezo buzzer used for?**
-* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure.
+* The RGB LED is the TEMP-1B's light in Homey. Turn it on or off, dim it, or change its color from the device or in a flow. Commands reach the sensor only while it's awake.
+* The piezo buzzer sounds an alarm on its own when the probe temperature goes above or below a range you set. In the device's **Settings** in the Homey app, set **Minimum probe temperature** and **Maximum probe temperature** (in °C), then check **Alarm when temperature outside configured range**. The alarm watches the probe chosen in **Select probe**, and it checks each time the sensor is awake and takes a reading. Homey flows can't play the buzzer themselves.
+
+!!! tip "The alarm checkbox is listed under TEMP PRO-1"
+
+ **Alarm when temperature outside configured range** sits in the group **Temperature range and alarm settings for TEMP PRO-1**, but it works on the TEMP-1B too. The minimum and maximum are under **Probes and offsets for TEMP-1 and TEMP-1B**. For a full walkthrough, see [TEMP-1B alert outside a temperature range](../examples/temp1b-alert-example/).
10\. **Is the TEMP-1B compatible with other smart home platforms?**
-* While designed for Home Assistant via ESPHome, it may be compatible with other platforms using the ESPHome API or MQTT.
+* Yes. Besides Homey (through the Apollo Automation app), the TEMP-1B works with Home Assistant, and it may work with other platforms through the ESPHome API or MQTT. See [Supported platforms](../../general/supported-platforms/).
11\. **Do I need coding knowledge to use the TEMP-1B?**
-* Basic knowledge of Home Assistant and ESPHome is helpful, but most users can utilize it out of the box. For advanced customization, YAML knowledge is recommended.
+* No. Adding the TEMP-1B to Homey and building flows takes no code. YAML knowledge only matters if you want to customize the firmware with ESPHome.
12\. **Can I access data from the TEMP-1B remotely?**
-* Yes, you can access sensor data remotely via the Home Assistant dashboard if your setup is configured for remote access.
+* Yes. The TEMP-1B reports to your Homey over your local network, and the Homey app shows its latest readings wherever you are, as long as your Homey is reachable remotely.
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/humidity, 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 the same components: a 3.5mm port for the waterproof temperature probe or the food probe, plus onboard air temperature and humidity.
-14\. **Can I use multiple TEMP-1B sensors in one Home Assistant setup?**
+14\. **Can I use multiple TEMP-1B sensors with one Homey?**
-* Yes, you can add multiple TEMP-1B sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces.
\ No newline at end of file
+* Yes. Add each TEMP-1B with the Apollo Automation app. Each one shows up as its own device in Homey, so you can monitor several fridges, freezers, rooms, or other spaces.
diff --git a/docs/homey/products/temp1b/setup/insert-battery.md b/docs/homey/products/temp1b/setup/insert-battery.md
index 917e662bc0..a1d47fabf9 100755
--- a/docs/homey/products/temp1b/setup/insert-battery.md
+++ b/docs/homey/products/temp1b/setup/insert-battery.md
@@ -1,13 +1,15 @@
---
-title: How to Insert the Battery
+title: How to insert the battery
description: "How to Insert Battery on TEMP-1B."
---
-# How to Insert the Battery
+# How to insert the battery
!!! info "16340 AKA RC-CR123A and charger required!"
The TEMP-1B is a very neat sensor but it does *NOT* include a battery nor a charging circuit. You will have to buy your own rechargeable RC-CR123A aka 16340 battery and also a separate 16340 charger such as a Nitecore 2 or 4bay model.
+Follow these steps to open the case, insert the battery, and close it again.
+
1\. Gently pry open the case lid as shown in the image below.
diff --git a/docs/homey/products/temp1b/setup/prevent-sleep.md b/docs/homey/products/temp1b/setup/prevent-sleep.md
index 49c48de5c2..6845ec2a3c 100755
--- a/docs/homey/products/temp1b/setup/prevent-sleep.md
+++ b/docs/homey/products/temp1b/setup/prevent-sleep.md
@@ -1,35 +1,79 @@
---
-title: Prevent Sleep
-description: "Keep the TEMP-1B awake instead of letting it sleep, and what that costs in battery life."
+title: Prevent sleep
+description: "Let the TEMP-1B sleep between readings to save battery, or keep it awake, with the Prevent sleep and Sleep duration settings in Homey."
---
-# Prevent Sleep
+# Prevent sleep
-!!! tip "Put your sensors to sleep!"
+Your Apollo TEMP-1B can sleep between readings: it wakes up, reports to Homey, and goes back to sleep until the next report. Sleeping is what makes the battery last. It also keeps the board from warming itself up, so the temperature readings need less offset.
- 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 TEMP-1B ships with **Prevent sleep** turned on, so it stays awake and reports all the time. That's handy while you set it up, but it drains the battery far faster. Once the sensor is in place, turn Prevent sleep off and let it sleep.
- 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.
+!!! note "Before you start"
-1\. Head to the ESPHome Integrations page.
+ - Add your TEMP-1B to Homey. See [Getting started](../getting-started-temp1/).
+ - Homey can only change these settings while the sensor is awake and connected. If it's asleep, Homey shows **The device is asleep. Settings can be changed when it next wakes up.** In that case, [keep it awake](#keep-your-temp-1b-awake-again) first.
-2\. Click on the name "1 device" below your Apollo device's name.
+## The sleep settings in Homey
-
+Both settings sit in your TEMP-1B's **Settings** in the Homey app, under **Battery settings (if battery is present)**. They're device settings only, so there's no flow card that turns sleep on or off.
-3\. Scroll down until you see "Prevent Sleep" and "Sleep Duration".
+| Setting | What it does |
+| --- | --- |
+| **Prevent sleep** | Checked, the sensor stays awake. Unchecked, it sleeps between reports. A new TEMP-1B has it checked. |
+| **Sleep duration** | How many hours the sensor sleeps between reports, from 0 to 800, with up to two decimals: 0.5 is 30 minutes. The default is 12. |
-
+## Let your TEMP-1B sleep
-4\. Type in the amount of hours you want your sensor to sleep in the "Sleep Duration" box. Defaults to 12 hours.
+Set how long the sensor sleeps first, then let it go to sleep. Make the two changes one at a time: the sensor falls asleep the moment Prevent sleep turns off, so a change sent along with it may never arrive.
-!!! warning "Read this before turning off Prevent Sleep!"
+!!! warning "Read this before you uncheck Prevent sleep"
- When "Prevent Sleep" is toggled off, your sensor will immediately begin sleeping. Please make sure you are ready to make this sensor sleep before toggling off prevent sleep.
+ The TEMP-1B goes to sleep as soon as Prevent sleep is off, and Homey can't reach it again until it wakes up. Put the sensor where you want it and finish any other settings first.
-5\. When you are ready, toggle off "Prevent Sleep" and your sensor will go to sleep. It will wake up every 12 hours, or on the interval you set in step 4. If you need to keep your sensor awake, head to our OTA Awake helper tutorial!
+1. In the Homey app, open your TEMP-1B's **Settings**.
+2. Under **Battery settings (if battery is present)**, set **Sleep duration** to the hours you want between reports, and save the change. Leave it at 12 unless you need fresher readings.
+3. Uncheck **Prevent sleep** and save.
-6\. You can wake your sensor by following this guide or you can power cycle your device. If there is a battery in it, the battery will need to be removed or the reset button pressed.
+Your TEMP-1B is now asleep. It wakes up after each Sleep duration, connects to Homey, sends fresh readings, and goes back to sleep about 20 seconds after it connects.
-!!! danger "Do not leave your sensor outside or let it get wet!"
+!!! tip "Device disconnected is normal between reports"
- The TEMP-1B should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your TEMP-1B if there will be high moisture content in the air or if it is expected to rain.
\ No newline at end of file
+ While the TEMP-1B sleeps, Homey shows it as **Device disconnected**. That's expected: Homey reconnects on its own each time the sensor wakes up.
+
+## Keep your TEMP-1B awake again
+
+To change a setting, update the firmware, or troubleshoot, the sensor has to stay awake. Turn Prevent sleep back on from the sensor itself or from the Homey app.
+
+### With the buttons on the sensor
+
+The buttons work even when Homey can't reach the sensor, which makes this the most reliable way. The [sensor connection check](../../battery-sensors/sensor-connection-check/) has photos of the reset and boot buttons.
+
+!!! warning "Watch how long you hold the boot button"
+
+ Hold the boot button for 4 to 5 seconds, no longer. Holding it for 10 seconds or more resets the TEMP-1B to factory settings and erases its Wi-Fi, and you'd have to [connect it to Wi-Fi](../getting-started-temp1/) again. A short press of under 3 seconds runs the connection check instead.
+
+1. Press and release the reset button to wake the sensor. You can also take the battery out and put it back in.
+2. Wait a few seconds, then press and hold the boot button for 4 to 5 seconds and let go.
+
+The sensor turns Prevent sleep on and stays awake. In Homey, **Prevent sleep** shows as checked again once the sensor is connected. If Homey loses the connection again a few seconds later, the sensor was already on its way back to sleep. It still remembers Prevent sleep, so press the reset button once more and it stays awake this time.
+
+### From the Homey app
+
+The sensor stays awake for only about 20 seconds after Homey connects, so have the Homey app open and ready before you start.
+
+1. Wake the sensor with the reset button, or take the battery out and put it back in.
+2. In the Homey app, open your TEMP-1B and wait until it no longer shows **Device disconnected**.
+3. Right away, open its **Settings**, check **Prevent sleep** under **Battery settings (if battery is present)**, and save.
+4. If Homey loses the connection again a few seconds later, press the reset button once more.
+
+Your TEMP-1B now stays awake until you uncheck Prevent sleep again. If the sensor was already on its way back to sleep at step 3, it still keeps the change and starts up with Prevent sleep on after the reset in step 4. If Homey shows **The device is asleep. Settings can be changed when it next wakes up.** instead, the change didn't reach the sensor: start again from step 1, or use the buttons.
+
+!!! danger "Keep your TEMP-1B dry"
+
+ Don't leave the TEMP-1B outside for long periods or let it get wet. If it will sit in damp air or could see rain, put it inside another, protective case.
+
+!!! success "Next step: check your sensor's connection"
+
+ Not sure whether your TEMP-1B woke up and reached Homey? The light on the sensor tells you in a few seconds.
+
+ [Run the sensor connection check](../../battery-sensors/sensor-connection-check/){ .md-button .md-button--primary }
diff --git a/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md
index 02146f5d1e..1023f416e5 100755
--- a/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md
+++ b/docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md
@@ -1,14 +1,16 @@
---
-title: Putting The TEMP-1B In Boot Mode
+title: Putting the TEMP-1B in boot mode
description: "Step by step guide for putting The TEMP-1B In Boot Mode."
---
-# Putting The TEMP-1B In Boot Mode
+# Putting the TEMP-1B in boot mode
!!! info "This will cover how to put the TEMP-1B into 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
+
+Use this method to put your device into boot mode by pressing the boot button through the opening in the side of the case.
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 +26,9 @@ 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/homey/products/temp1b/troubleshooting/temp1b-code/).
-## Method 2: Boot and Reset Buttons
+## Method 2: Boot and reset buttons
+
+Use this method to put your device into boot mode with the case removed, using both the boot and reset buttons.
1\. Unplug the device and remove the case as shown in the images above
diff --git a/docs/homey/products/temp1b/troubleshooting/temp1b-code.md b/docs/homey/products/temp1b/troubleshooting/temp1b-code.md
index 4f5e59e328..76f2d8d7e8 100755
--- a/docs/homey/products/temp1b/troubleshooting/temp1b-code.md
+++ b/docs/homey/products/temp1b/troubleshooting/temp1b-code.md
@@ -1,16 +1,16 @@
---
-title: Factory Re-Flash TEMP-1B
+title: Factory re-flash TEMP-1B
description: "Step by step guide for re-flashing the TEMP-1B back to factory firmware."
---
-# Factory Re-Flash TEMP-1B
+# Factory re-flash TEMP-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."
This needs to be done in Chrome, Edge, or another Chromium based browser.
-If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing.
+If your device has already been added to Homey, please remove it from Homey before continuing.
-1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable.
+1\. 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 TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/)
@@ -38,4 +38,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and set up 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-reset-wi-fi-credentials.md b/docs/homey/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
index 391698c438..cb650414b1 100755
--- a/docs/homey/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
+++ b/docs/homey/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials on your TEMP-1B
+title: Reset Wi-Fi credentials on your TEMP-1B
description: "Step by step guide for resetting the Wi-Fi Credentials on your TEMP-1B."
---
-# Reset Wi-Fi Credentials on your TEMP-1B
+# Reset Wi-Fi credentials on your TEMP-1B
+
+Follow these steps to clear your device's saved Wi-Fi credentials so it broadcasts its hotspot again and you can enter new Wi-Fi details.
1\. Plug the device into power.
@@ -12,4 +14,4 @@ description: "Step by step guide for resetting the Wi-Fi Credentials on your TEM
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
-4\. Connect to the hotspot titled "Apollo TEMP-1 Hotspot" and enter your new Wi-Fi details!
\ No newline at end of file
+4\. Connect to the hotspot titled "Apollo TEMP1B Hotspot" and enter your new Wi-Fi details!
\ 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 06fd327083..8cda42fff5 100755
--- a/docs/homey/products/temp1b/troubleshooting/temp1b-teardown.md
+++ b/docs/homey/products/temp1b/troubleshooting/temp1b-teardown.md
@@ -1,8 +1,10 @@
---
-title: Teardown Of TEMP-1B
+title: Teardown of TEMP-1B
description: "Step by step guide for tearing down your TEMP-1B to replace parts, clean it, swap cases, etc."
---
-# Teardown Of TEMP-1B
+# Teardown of TEMP-1B
+
+Follow these steps to open the case and take out the PCB.
1\. Gently pry open the case lid as shown in the image below.
diff --git a/docs/index.md b/docs/index.md
index d71a7c1fe3..6234b7409b 100755
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,5 +1,5 @@
---
-title: Home Assistant Integration
+title: Home Assistant integration
description: >-
Guide to integrating Apollo Automation devices with the Home Assistant smart
home platform.
@@ -63,7 +63,7 @@ description: >-
-### Which mmWave Sensor Should I Buy?
+### Which mmWave sensor should I buy?
```mermaid
%%{init: {'flowchart': {'nodeSpacing': 30, 'rankSpacing': 50}}}%%
@@ -98,21 +98,21 @@ flowchart LR
click GUIDE href "https://wiki.apolloautomation.com/products/general/choosing-an-mmwave-sensor/" _blank
```
-### Most Popular
+### Most popular
* [Getting started with your brand new Apollo device](https://wiki.apolloautomation.com/products/general/setup/getting-started/)
* [Updating Firmware](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/updating-firmware/)
* [Add Bluetooth Proxy functionality to your Apollo device](https://wiki.apolloautomation.com/products/general/setup/bluetooth-proxy/)
-### Radar & Zones
+### Radar & zones
* [Set up the Apollo mmWave dashboard](https://wiki.apolloautomation.com/products/general/setup/apollo-mmwave-dashboard-setup/) and [calibrate your radar or draw zones with it](https://wiki.apolloautomation.com/products/general/setup/apollo-mmwave-dashboard/)
* [Tuning out false positives with the MSR-2](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/mmwave-videos/)
* [Setting up zones on MTR-1 with the HLK app](https://wiki.apolloautomation.com/products/mtr1/setup/zones-hlk/)
-* [Beta test our new Zone Mapper tool!](https://github.com/ApolloAutomation/zone-mapper) - [Use this custom card along with Zone Mapper!](https://github.com/ApolloAutomation/zone-mapper-card)
+* [Beta test our new Zone Mapper tool!](https://github.com/ApolloAutomation/zone-mapper) ([Use this custom card along with Zone Mapper!](https://github.com/ApolloAutomation/zone-mapper-card))
* [Tune your new R PRO-1 PoE mmWave sensor](https://wiki.apolloautomation.com/products/rpro1/setup/zones-ha/)
-### Quick References
+### Quick references
* [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/)
@@ -122,13 +122,13 @@ flowchart LR
### Community
-* [Discord - Support, community, updates, live streams](https://link.apolloautomation.com/discord)
-* [YouTube - Tutorials and live streams](https://www.youtube.com/@ApolloAutomation)
+* [Discord: Support, community, updates, live streams](https://link.apolloautomation.com/discord)
+* [YouTube: Tutorials and live streams](https://www.youtube.com/@ApolloAutomation)
### What is Apollo Automation?
-Apollo Automation builds high-quality, affordable, open-source home automation hardware - designed and assembled in Lexington, KY. What started as a side project among friends (named after Trevor's dog, Apollo) grew into a full-fledged business driven by community feedback. We build everything in-house, keep our designs transparent, and host a monthly livestream on Discord and YouTube so you can connect with us directly.
+Apollo Automation builds high-quality, affordable, open-source home automation hardware, designed and assembled in Lexington, KY. What started as a side project among friends (named after Trevor's dog, Apollo) grew into a full-fledged business driven by community feedback. We build everything in-house, keep our designs transparent, and host a monthly livestream on Discord and YouTube so you can connect with us directly.
### What do we offer?
-Sensors and devices that solve real problems in home automation - presence detection, air quality monitoring, plant care, and more. Every product ships with ESPHome firmware, full Home Assistant integration, and support from a team that actually uses what we build.
\ No newline at end of file
+Sensors and devices that solve real problems in home automation: presence detection, air quality monitoring, plant care, and more. Every product ships with ESPHome firmware, full Home Assistant integration, and support from a team that actually uses what we build.
\ No newline at end of file
diff --git a/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md b/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md
index 81115981e8..f24402f5ba 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/button-controlled-leds.md
@@ -1,10 +1,10 @@
---
-title: Button Controlled LEDs
+title: Button controlled LEDs
description: >-
Build your first automation in the new ESPHome Device Builder GUI: pressing
the Button module toggles the RGB module on and off.
---
-# Build a Button-Controlled RGB Light
+# Build a button-controlled RGB light
Difficulty: Level 1
@@ -98,6 +98,6 @@ With the device back online, press the button on the Button module. You should h
The same trigger-then-action pattern works for every automation you'll build in Device Builder. Swap the trigger (motion, temperature crossing a threshold, a schedule) or the action (turn on, dim, play a buzzer tone) and you have a new automation.
-
+ TEMP-1B alert outside a temperature range
+ Difficulty: Level 1
+
+
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 d272c240a5..0ae9b2fad0 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/motion-activated-light.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/motion-activated-light.md
@@ -1,11 +1,11 @@
---
-title: Turn On a Light with Motion
+title: Turn on a light with motion
description: >-
Build an ESPHome Device Builder automation: the Motion module turns the LED
& Buzzer module's RGB light on when it detects movement and off when motion
stops.
---
-# Turn On a Light with Motion
+# Turn on a light with motion
Difficulty: Level 1
@@ -25,6 +25,8 @@ ESPHome Device Builder has a GUI for building 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 47d412b3a2..646eb081a3 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/play-a-tune.md
@@ -1,10 +1,10 @@
---
-title: Play a Tune with the Button
+title: Play a tune with the button
description: >-
Build a second ESPHome Device Builder automation: pressing the Button module
plays an RTTTL tune on the LED & Buzzer module, plus where to find more tunes.
---
-# Play a Tune with the Button
+# Play a tune with the button
Difficulty: Level 1
diff --git a/docs/products/ESPHome-Starter-Kit/automations/press-to-check-climate.md b/docs/products/ESPHome-Starter-Kit/automations/press-to-check-climate.md
index 097c22d176..49a35c9bee 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/press-to-check-climate.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/press-to-check-climate.md
@@ -1,11 +1,11 @@
---
-title: Press to Check Climate
+title: Press to check climate
description: >-
ESPHome Device Builder automation: one button click flashes the Onboard RGB
LED for the current temperature band, then for humidity. Available in a
hardcoded-thresholds version and an editable / unit-toggle version.
---
-# Press to Check Climate
+# Press to check climate
Difficulty: Level 3
@@ -56,7 +56,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
The AHT20 sensor publishes its readings in Celsius, so the **Above** and **Below** values you enter for the temperature `If` conditions need to be Celsius numbers. The Fahrenheit equivalents in the table above are for reference only.
- A single **Button → On Click** automation whose action body chains nine steps: three `If` conditions for temperature, a delay and clear, another delay, three `If` conditions for humidity, a final delay and clear.
+ A single **Button → On Click** automation whose action body chains 11 actions: three `If` conditions for temperature, a delay, a turn-off, another delay, three `If` conditions for humidity, then a final delay and turn-off.
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**.
@@ -171,7 +171,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
sensor.in_range:
- id: aht_temperature
+ id: aht20_temperature
below: 18.0
then:
- light.turn_on:
@@ -183,7 +183,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
sensor.in_range:
- id: aht_temperature
+ id: aht20_temperature
above: 18.0
below: 24.0
then:
@@ -196,7 +196,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
sensor.in_range:
- id: aht_temperature
+ id: aht20_temperature
above: 24.0
then:
- light.turn_on:
@@ -211,7 +211,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
sensor.in_range:
- id: aht_humidity
+ id: aht20_humidity
below: 30.0
then:
- light.turn_on:
@@ -223,7 +223,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
sensor.in_range:
- id: aht_humidity
+ id: aht20_humidity
above: 30.0
below: 60.0
then:
@@ -236,7 +236,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
sensor.in_range:
- id: aht_humidity
+ id: aht20_humidity
above: 60.0
then:
- light.turn_on:
@@ -259,6 +259,8 @@ This tutorial has two versions of the same automation. Both end with the same bu
**Temperature threshold numbers**
+ Start with the two template numbers that hold your cold and hot temperature thresholds.
+
1. In Device Builder, click **Edit** on your starter kit device.
2. Scroll to **Components** and click **+ Add Component**.
3. Search for **Template Number** and click **Add**.
@@ -291,6 +293,8 @@ This tutorial has two versions of the same automation. Both end with the same bu
**Temperature unit select**
+ Add the select you'll use to switch the temperature unit between °C and °F.
+
1. Click **+ Add Component**, search for **Template Select**, and click **Add**.
2. Fill in the form:
@@ -394,7 +398,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
```cpp
float t = id(temp_min).state;
if (id(temp_unit).current_option() == "°F") t = fahrenheit_to_celsius(t);
- return id(aht_temperature).state < t;
+ return id(aht20_temperature).state < t;
```
3. Under the `If`'s **Then** branch, click **+ Add action** and pick **Light → Turn On**:
@@ -409,7 +413,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
bool is_f = id(temp_unit).current_option() == "°F";
float tmin = is_f ? fahrenheit_to_celsius(id(temp_min).state) : id(temp_min).state;
float tmax = is_f ? fahrenheit_to_celsius(id(temp_max).state) : id(temp_max).state;
- float t = id(aht_temperature).state;
+ float t = id(aht20_temperature).state;
return t >= tmin && t <= tmax;
```
@@ -420,13 +424,15 @@ This tutorial has two versions of the same automation. Both end with the same bu
```cpp
float t = id(temp_max).state;
if (id(temp_unit).current_option() == "°F") t = fahrenheit_to_celsius(t);
- return id(aht_temperature).state > t;
+ return id(aht20_temperature).state > t;
```
**Then** → **Light → Turn On** **Onboard RGB LED** with **Brightness** `100%`, **Red** `100%`, **Green** `0%`, **Blue** `0%`.
**Pause, then clear the LED**
+ Hold the temperature band's color, then turn the LED off briefly so you can tell the next color is humidity, not temperature.
+
1. Add a **Control flow → Delay** of `3s`.
2. Add **Light → Turn Off** on **Onboard RGB LED**.
3. Add a **Control flow → Delay** of `1s`.
@@ -438,7 +444,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
1. Lambda condition:
```cpp
- return id(aht_humidity).state < id(humidity_min).state;
+ return id(aht20_humidity).state < id(humidity_min).state;
```
**Then** → **Light → Turn On** **Onboard RGB LED** with **Brightness** `100%`, **Red** `100%`, **Green** `50%`, **Blue** `0%` (orange).
@@ -446,7 +452,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
2. Second `If`:
```cpp
- float h = id(aht_humidity).state;
+ float h = id(aht20_humidity).state;
return h >= id(humidity_min).state && h <= id(humidity_max).state;
```
@@ -455,7 +461,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
3. Third `If`:
```cpp
- return id(aht_humidity).state > id(humidity_max).state;
+ return id(aht20_humidity).state > id(humidity_max).state;
```
**Then** → **Light → Turn On** with **Brightness** `100%`, **Red** `0%`, **Green** `0%`, **Blue** `100%` (blue).
@@ -485,7 +491,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
lambda: |-
float t = id(temp_min).state;
if (id(temp_unit).current_option() == "°F") t = fahrenheit_to_celsius(t);
- return id(aht_temperature).state < t;
+ return id(aht20_temperature).state < t;
then:
- light.turn_on:
id: onboard_rgb_led
@@ -499,7 +505,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
bool is_f = id(temp_unit).current_option() == "°F";
float tmin = is_f ? fahrenheit_to_celsius(id(temp_min).state) : id(temp_min).state;
float tmax = is_f ? fahrenheit_to_celsius(id(temp_max).state) : id(temp_max).state;
- float t = id(aht_temperature).state;
+ float t = id(aht20_temperature).state;
return t >= tmin && t <= tmax;
then:
- light.turn_on:
@@ -513,7 +519,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
lambda: |-
float t = id(temp_max).state;
if (id(temp_unit).current_option() == "°F") t = fahrenheit_to_celsius(t);
- return id(aht_temperature).state > t;
+ return id(aht20_temperature).state > t;
then:
- light.turn_on:
id: onboard_rgb_led
@@ -526,7 +532,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- delay: 1s
- if:
condition:
- lambda: 'return id(aht_humidity).state < id(humidity_min).state;'
+ lambda: 'return id(aht20_humidity).state < id(humidity_min).state;'
then:
- light.turn_on:
id: onboard_rgb_led
@@ -537,7 +543,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
- if:
condition:
lambda: |-
- float h = id(aht_humidity).state;
+ float h = id(aht20_humidity).state;
return h >= id(humidity_min).state && h <= id(humidity_max).state;
then:
- light.turn_on:
@@ -548,7 +554,7 @@ This tutorial has two versions of the same automation. Both end with the same bu
blue: 0%
- if:
condition:
- lambda: 'return id(aht_humidity).state > id(humidity_max).state;'
+ lambda: 'return id(aht20_humidity).state > id(humidity_max).state;'
then:
- light.turn_on:
id: onboard_rgb_led
@@ -647,7 +653,7 @@ With the device back online, press the button on the Button module. The Onboard
The same trigger / condition / delay / light pattern works with any sensor and any light on your kit. Swap the temperature sensor for a CO2 reading, the button trigger for a motion event, or the Onboard RGB LED for the LED & Buzzer module's `rgb_leds` strip, and you have a new readout. Then bring it into Home Assistant so you can tune it from anywhere.
- 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 b19fe8e702..fcc69a30f6 100644
--- a/docs/products/ESPHome-Starter-Kit/automations/temp-reactive-leds.md
+++ b/docs/products/ESPHome-Starter-Kit/automations/temp-reactive-leds.md
@@ -1,10 +1,10 @@
---
-title: Temp-Reactive LEDs
+title: Temp-reactive LEDs
description: >-
Build an ESPHome Device Builder automation that drives the LED & Buzzer
module to a color band based on the current temperature reading.
---
-# Temp-Reactive LEDs
+# Temp-reactive LEDs
Difficulty: Level 2
@@ -53,7 +53,9 @@ ESPHome Device Builder has a GUI for building 
-### Cold band: below 18 °C → Blue
+### Cold band: below 18 °C → blue
+
+Your first automation turns the RGB LEDs blue whenever the temperature reading falls into the cold band.
1. Set up the trigger:
@@ -83,11 +85,11 @@ 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 aac7907c37..61dcae0681 100644
--- a/docs/products/ESPHome-Starter-Kit/community-corner.md
+++ b/docs/products/ESPHome-Starter-Kit/community-corner.md
@@ -1,19 +1,19 @@
---
-title: Community Corner
+title: Community corner
description: >-
Creations from the Apollo community for the ESPHome Starter Kit, including
3D-printable cases, automations, and mods.
---
-# Community Corner
+# Community corner
The Community Corner is dedicated to sharing some really great projects created by the community. It could be anything: a 3D-printed case, a clever automation, a cool use case, you name it. Post your build on our forums, Discord, or Reddit and we'll see if it's worthy of being displayed for the masses.
[Join our Discord :simple-discord:](https://link.apolloautomation.com/discord){ .md-button .md-button--discord }
[Community Forum :material-forum:](https://forum.apolloautomation.com/){ .md-button .md-button--primary }
-## 3D Prints
+## 3D prints
-### LED & Buzzer Module Case
+### LED & Buzzer module case
*Created by @_cadster on Discord*
diff --git a/docs/products/ESPHome-Starter-Kit/everyday-use/air-quality-on-your-dashboard.md b/docs/products/ESPHome-Starter-Kit/everyday-use/air-quality-on-your-dashboard.md
index 936f4342ca..92711fd8d7 100644
--- a/docs/products/ESPHome-Starter-Kit/everyday-use/air-quality-on-your-dashboard.md
+++ b/docs/products/ESPHome-Starter-Kit/everyday-use/air-quality-on-your-dashboard.md
@@ -1,11 +1,11 @@
---
-title: Air Quality on Your Dashboard
+title: Air quality on your dashboard
description: >-
Put your SEN65's air quality readings on a Home Assistant dashboard and get a
push notification when the air goes bad, all with built-in cards and a native
automation.
---
-# Air Quality on Your Dashboard
+# Air quality on your dashboard
The [SEN65](../modules/breakout-addons/sen65-air-quality-sensor.md) reads particulate matter, VOC, and NOx, and the AQI component turns your PM readings into a single NowCast AQI number. Putting those on a Home Assistant dashboard gives you a live air quality monitor, and one small automation can nudge you when it's time to open a window. Everything here uses cards and triggers that ship with Home Assistant, so there's nothing to install.
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 a795e0cbf6..fe99173908 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
@@ -1,10 +1,10 @@
---
-title: Button Toggles a Room Light
+title: Button toggles a room light
description: >-
Build a Home Assistant automation that uses your ESPHome Starter Kit's
button to toggle any light in your home.
---
-# Button Toggles a Room Light
+# Button toggles a room light
Difficulty: Level 1
@@ -20,6 +20,8 @@ This is an alternative way to use the Starter Kit's button. Instead of toggling
## Build the automation
+You'll build a Home Assistant automation that toggles a light in your home each time you press the Button module.
+
1. Open **Settings → Automations & scenes** in Home Assistant.
[](https://my.home-assistant.io/redirect/automations/)
@@ -34,7 +36,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.
+ 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.
@@ -86,8 +88,8 @@ Press the button on the Button module. The light you targeted toggles. Press aga
!!! success "Your kit is now a physical remote for Home Assistant!"
- 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.
+ 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 5bab15ecd7..e227baa669 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
@@ -1,10 +1,10 @@
---
-title: Motion-Activated Room Lights
+title: Motion-activated room lights
description: >-
Use your ESPHome Starter Kit's motion sensor to turn the real lights in a room
on and off through a Home Assistant automation.
---
-# Motion-Activated Room Lights
+# Motion-activated room lights
This is where the kit stops being a learning toy and starts earning its keep. Your Starter Kit's motion sensor reports into Home Assistant, so it can switch on the actual lights in a room, a smart bulb, a wall switch, a lamp on a plug, then switch them back off once the room goes quiet.
@@ -84,7 +84,7 @@ You could make two automations, one to turn the light on and one to turn it off.
[](https://my.home-assistant.io/redirect/automations/)
-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)
+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 **Edit ID**, and set the **Trigger ID** to `Detected`. (1)
@@ -107,7 +107,7 @@ You could make two automations, one to turn the light on and one to turn it off.
-1. The trigger ID is just a name. The **Choose** action reads it to decide which branch to run.
+1. The trigger ID is a name. The **Choose** action reads it to decide which branch to run.
2. The **For** delay means **Clear** only fires after the room has been still for two full minutes, so the light doesn't drop the moment you hold still.
3. `restart` makes fresh motion reset the off-timer. The default `single` mode would ignore movement until the run finished.
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 a0eef86ed0..d2becbd2ef 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
@@ -1,10 +1,10 @@
---
-title: Play a Tune from Home Assistant
+title: Play a tune from Home Assistant
description: >-
Build an ESPHome API action in Device Builder so Home Assistant can play tunes
on the LED & Buzzer module, then call it from Developer Tools or an automation.
---
-# Play a Tune from Home Assistant
+# Play a tune from Home Assistant
🌱 New here? Try these first:
@@ -109,25 +109,25 @@ Start with a single named song, or set up a bank of swappable song slots. Pick a
- **`play_song_1`** — Pink Panther
+ **`play_song_1`**: Pink Panther
```text
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
```
- **`play_song_2`** — Imperial March
+ **`play_song_2`**: Imperial March
```text
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#
```
- **`play_song_3`** — Cantina
+ **`play_song_3`**: Cantina
```text
Cantina:d=4,o=5,b=250:8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,a,8a,8g#,8a,g,8f#,8g,8f#,f.,8d.,16p,p.,8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,8a,8p,8g,8p,g.,8f#,8g,8p,8c6,a#,a,g
```
- **`play_song_4`** — Simpsons
+ **`play_song_4`**: Simpsons
```text
The Simpsons:d=4,o=5,b=160:c.,e,f#,8a,g.,e,c,8a4,8f#4,8f#4,8f#4,2g4,8p,8p,8f#4,8f#4,8f#4,8g4,a4.,8c,16p,8c,16p,8c,2c
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 ab78a20b28..72211e276b 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
@@ -1,10 +1,10 @@
---
-title: Temperature on Your Dashboard
+title: Temperature on your dashboard
description: >-
Add your ESPHome Starter Kit's temperature and humidity readings to a Home
Assistant dashboard using built-in Tile and Gauge cards.
---
-# Temperature on Your Dashboard
+# Temperature on your dashboard
Your kit reads the temperature and humidity of whatever room it's in. Putting those readings on a Home Assistant dashboard turns it into a glanceable display you'll actually check. Everything here uses cards that ship with Home Assistant, so there's nothing to install.
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 211333cf24..f4b996cc21 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
@@ -1,10 +1,10 @@
---
-title: Trash Night Reminder
+title: Trash night reminder
description: >-
Use two Home Assistant Local Calendars and the LED & Buzzer module's RGB
LEDs to light up your Starter Kit on trash and recycle night.
---
-# Trash Night Reminder
+# Trash night reminder
Difficulty: Level 2
@@ -20,7 +20,7 @@ description: >-
-Never miss bin night again. Two **Home Assistant Local Calendars** - one for trash, one for recycle - drive a single automation that lights up the Starter Kit's RGB LEDs in a different color for each pickup. When the event starts the LEDs come on; when the event ends they go off.
+Never miss bin night again. Two **Home Assistant Local Calendars** (one for trash, one for recycle) drive a single automation that lights up the Starter Kit's RGB LEDs in a different color for each pickup. When the event starts the LEDs come on; when the event ends they go off.
!!! note "Before you start"
@@ -32,7 +32,7 @@ Never miss bin night again. Two **Home Assistant Local Calendars** - one for tra
## Create the calendars
-Home Assistant's **Local Calendar** integration stores events entirely inside Home Assistant - no Google account or external service required.
+Home Assistant's **Local Calendar** integration stores events entirely inside Home Assistant: no Google account or external service required.
**Add the Trash calendar**
@@ -73,7 +73,7 @@ Add a repeating event to each calendar to match your actual pickup schedule.
1. The LEDs turn on at the start time and off at the end time, so this is your reminder window. Keep it to one evening rather than running it into the next day.
-6. Click **Save**.
+6. Click **Add event** at the bottom of the dialog.
@@ -85,13 +85,13 @@ Add a repeating event to each calendar to match your actual pickup schedule.
- **Title** → `Recycle Pickup`
- Set the **start time** and **end time** to a window that evening, for example 7 PM to 9 PM.
- 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**.
+ - Click **Add event** at the bottom of the dialog.
## Build the automation
-One automation handles both calendars. Four triggers - event start and event end for each calendar - feed into a **Choose** action that picks the right color or turns the LEDs off depending on which trigger fired.
+One automation handles both calendars. Four triggers (event start and event end for each calendar) feed into a **Choose** action that picks the right color or turns the LEDs off depending on which trigger fired.
**Create the automation**
@@ -107,28 +107,30 @@ Add four triggers, one at a time. Each one is a **Calendar** trigger, and each g
- **Calendar** → `Trash`
- **Event** → **Start**
- - Open the trigger's three-dot menu, choose **Rename**, and set the **Trigger ID** to `trash_start`.
+ - Open the trigger's three-dot menu, choose **Edit ID**, and set the **Trigger ID** to `trash_start`.
3. Click **+ Add trigger** and add another **Calendar** trigger.
- **Calendar** → `Trash`
- **Event** → **End**
- - Three-dot menu, **Rename**, **Trigger ID** → `trash_end`.
+ - Three-dot menu, **Edit ID**, **Trigger ID** → `trash_end`.
4. Click **+ Add trigger** and add another **Calendar** trigger.
- **Calendar** → `Recycle`
- **Event** → **Start**
- - Three-dot menu, **Rename**, **Trigger ID** → `recycle_start`.
+ - Three-dot menu, **Edit ID**, **Trigger ID** → `recycle_start`.
5. Click **+ Add trigger** and add another **Calendar** trigger.
- **Calendar** → `Recycle`
- **Event** → **End**
- - Three-dot menu, **Rename**, **Trigger ID** → `recycle_end`.
+ - Three-dot menu, **Edit ID**, **Trigger ID** → `recycle_end`.
**Add the choose action**
+Now you'll add the **Choose** action that sets the LED color for each pickup and turns the LEDs off when an event ends.
+
6. Under **Then do**, click **+ Add action** and search for **Choose**.
The **Choose** block works like a branching decision: it checks each option's condition in order and runs the first one that matches.
@@ -215,7 +217,7 @@ Add four triggers, one at a time. Each one is a **Calendar** trigger, and each g
!!! success "Your kit is now a physical reminder for Home Assistant events!"
- The same pattern works for any calendar-driven reminder - medication schedules, bin days for a second home, watering days for the garden. Swap the colors, the calendar name, or the action and you have a new reminder with no extra hardware.
+ The same pattern works for any calendar-driven reminder: medication schedules, bin days for a second home, watering days for the garden. Swap the colors, the calendar name, or the action and you have a new reminder with no extra hardware.
## Tune the colors
diff --git a/docs/products/ESPHome-Starter-Kit/faq.md b/docs/products/ESPHome-Starter-Kit/faq.md
index 9eff86cb5e..6f58e13ab2 100644
--- a/docs/products/ESPHome-Starter-Kit/faq.md
+++ b/docs/products/ESPHome-Starter-Kit/faq.md
@@ -24,7 +24,7 @@ description: Frequently asked questions about the ESPHome Starter Kit, ESPHome D
5\. **Does it require Home Assistant?**
-* No. The ESPHome Desktop app runs as a standalone download on Mac, Windows, and Linux, so you can build with the kit without installing Home Assistant or running a server first. The devices then work as standalone ESPHome devices over Wi-Fi, reachable at their `.local` hostname, and integrate seamlessly with Home Assistant whenever you want to add it. Home Assistant finds them automatically over [mDNS](learning-the-basics/how-esphome-talks-to-home-assistant.md#auto-discovery). See [Connect to Home Assistant](tutorials/connect-to-home-assistant.md) when you are ready.
+* No. The ESPHome Desktop app runs as a standalone download on Mac, Windows, and Linux, so you can build with the kit without installing Home Assistant or running a server first. The devices then work as standalone ESPHome devices over Wi-Fi, reachable at their `.local` hostname, and integrate with Home Assistant whenever you want to add it. Home Assistant finds them automatically over [mDNS](learning-the-basics/how-esphome-talks-to-home-assistant.md#auto-discovery). See [Connect to Home Assistant](tutorials/connect-to-home-assistant.md) when you are ready.
6\. **Can the kit run on battery power?**
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 32fee22f59..493285eaec 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
@@ -1,8 +1,8 @@
---
-title: Core Components
+title: Core components
description: A guide to the Web Server and Accessory Power Rail components that ship enabled by default on the Apollo ESPHome Starter Kit.
---
-# Core Components
+# Core components
When you create a new Apollo ESPHome Starter Kit project in **ESPHome Device Builder**, two components are included for you by default:
@@ -17,9 +17,9 @@ You don't have to do anything to turn these on. This page explains what each one
The **Web Server** component runs a small website directly on your ESP32-C6. As soon as your device is on Wi-Fi, you can open esphome-starter-kit.local (or its IP address) on any phone or PC on the same network and control the device.
-Apollo ships it on by default so the kit works without Home Assistant. If you only want a smart LED on your desk, you never have to touch HA, you just visit the device's page in a browser.
+Apollo ships it on by default so the kit works without Home Assistant. If you only want a smart LED on your desk, you never have to touch HA: you visit the device's page in a browser.
-### Common Settings
+### Common settings
- **Version (v2 vs v3).** The Apollo project pins **Version 3**, the newer single-page interface that loads faster, looks cleaner, and shows controls and sensors in a sensible order. v2 is the older multi-page layout. There's almost no reason to switch back.
- **Port.** Defaults to **80** so plain `esphome-starter-kit.local` works. Change it only if something else on your network is already serving on port 80 and you want to avoid a clash.
@@ -30,7 +30,7 @@ Apollo ships it on by default so the kit works without Home Assistant. If you on
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.
- **Including/excluding entities.** Advanced setting that lets you hide specific entities from the web page without removing them from Home Assistant. Useful if you have internal helpers you don't want users to see.
-### Add Component
+### Add component
If you remove the Web Server component, the device still works, but `esphome-starter-kit.local` will stop responding. To add it back:
@@ -51,18 +51,18 @@ When the rail is **on**, your modules and the Onboard RGB LED have power and res
Apollo ships the rail enabled and set to come back on after a reboot, so the kit "just works" out of the box. The reason it exists as a switch (rather than always-on) is that turning the rail off briefly is the cleanest way to reset a misbehaving module without unplugging the kit, and it can be automated from Home Assistant.
-### Common Settings
+### Common settings
- **Restore mode.** Controls what happens to the rail when the device powers back on after losing power. The Apollo default is **restore the last state, default to on**, so a power blip won't leave your modules dark. Other options like "always on" or "always off" are available if you want a specific boot behavior.
- **Hide it from Home Assistant.** By default the rail shows up as a controllable switch entity in HA, handy for power-cycling a flaky module from an automation. If you'd rather it not clutter your dashboard, mark it `internal: true` under the advanced settings.
- **Icon and name.** Cosmetic, but you can rename the entity or change its icon if "Accessory Power Rail" isn't how you want it to appear in HA.
-- **GPIO pin.** Informational, not something you should change. The pin is fixed in hardware on the ESP32-C6, so editing it will just stop the rail from working.
+- **GPIO pin.** Informational, not something you should change. The pin is fixed in hardware on the ESP32-C6, so editing it will stop the rail from working.
-### How It Works
+### How it works
The Accessory Power Rail is an ESPHome **GPIO switch** under the hood. Apollo gives it a friendly name and pre-fills the pin so you don't have to know that, but if you ever want to see the raw configuration, look at the GPIO switch component in the ESPHome docs.
-### Add Component
+### Add component
If you remove the rail, **the Onboard RGB LED and any plugged-in modules will stop working properly** because they get their power from it. To add it back:
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 ae0405b315..3504fa04f0 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
@@ -1,10 +1,10 @@
---
-title: Device Builder Tour
+title: Device Builder tour
description: >-
A guided tour of every screen in the ESPHome Device Builder, using your Apollo
ESPHome Starter Kit as the example device.
---
-# Device Builder Tour
+# Device Builder tour
The **ESPHome Device Builder** is the app you used in [First Steps](../setup/first-steps.md) to install software on your Starter Kit, (1) and it's where you go every time you change something on the device. This page walks through each screen so you know what you're looking at.
{ .annotate }
@@ -13,7 +13,7 @@ The **ESPHome Device Builder** is the app you used in [First Steps](../setup/fir
---
-## Guided Tour
+## Guided tour
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.
@@ -48,7 +48,7 @@ Click **Edit** on your device card and the screen flips into the configuration e
The left pane is your config's table of contents. It groups everything into three buckets:
* **Core configuration.** Foundational settings like the device name, Wi-Fi, the connection to Home Assistant, OTA updates, and the web server. For the Starter Kit these are all pre-configured. See [Core Components](core-components.md) for details on each.
-* **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.
+* **Components.** The things your device does: switches, sensors, lights. The default Starter Kit has the accessory power switch, the I²C bus, and the AHT20 temperature and humidity sensor (Device Builder lists it as **AHT10 Temperature+Humidity Sensor**, the ESPHome platform that drives AHT10, AHT20, and AHT30 chips). 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.
@@ -67,7 +67,7 @@ The form pane and the YAML editor are always in sync. Edit either side and the o
-## Publishing Changes
+## Publishing changes
When you have finished making changes:
@@ -79,13 +79,13 @@ When you have finished making changes:
### 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.
+Click the **Logs** button (the terminal icon) on the device card 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.
+Pop them open when something looks off, or to watch sensor readings come in.
-### Next Steps
+### Next steps
* Pick a module from the [Modules](../modules/button-module.md) section to add to your Starter Kit and watch the components list update.
* Read [What is secrets.yaml?](what-is-secrets-yaml.md) to understand how Wi-Fi and encryption keys are stored.
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 7711ea6e8a..d06548ffa4 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
@@ -1,8 +1,8 @@
---
-title: HA Integration
+title: HA integration
description: A conceptual overview of how ESPHome devices announce themselves to Home Assistant, what the encryption key is for, and how device components turn into Home Assistant entities.
---
-# HA Integration
+# HA integration
The **ESPHome integration** is what makes your Starter Kit visible to Home Assistant. Once it's set up, every switch, sensor, and light you defined in ESPHome Device Builder appears in Home Assistant as something you can read, control, or automate against. This page explains how that handoff actually works.
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 012c61a7e0..44f8e41d79 100644
--- a/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/apollo-breakout-module.md
@@ -64,7 +64,11 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
=== "STEMMA QT (Qwiic)"
- Plug your sensor's STEMMA QT (Qwiic) cable into the port. The connector is keyed, so it only fits one way.
+ Plug your sensor's STEMMA QT (Qwiic) cable into the **3.3V STEMMA QT** port at the middle left of the board, labeled **Stemma 3V**. The board has two 4-pin STEMMA ports: this 3.3V STEMMA QT port and a 5V STEMMA port at the bottom center, labeled **VStemma 5V**. Use the 5V port only for sensors that need 5V. The connector is keyed, so it only fits one way.
+
+ !!! note "The clip shows the 5V port"
+
+ The clip below plugs the cable into the 5V STEMMA port at the bottom center. For a STEMMA QT (Qwiic) sensor, use the 3.3V port at the middle left instead.
@@ -89,7 +93,7 @@ The Breakout Module is covered in connectors, each labeled on the board. Most of
Data is on **GPIO6**. In your config, the One Wire component sets up the bus on that pin, and the Dallas temperature sensor reads each probe on it.
- Plug the probe's connector into the 1Wire port with the latch side facing up.
+ Push the probe's 3.5mm plug all the way into the **1Wire** jack at the top right of the board.
@@ -145,12 +149,12 @@ The Open it in a browser on the same network and watch it react in real time.
-1. In a browser, open `http://
-1. In a browser, open `http://.local/`. If you used `esphome-starter-kit` as the device name in Getting Started, that's `http://esphome-starter-kit.local/`.
+1. In a browser, open `http://.local/`. If you used `esphome-starter-kit` as the device name in [First Steps](/products/ESPHome-Starter-Kit/setup/first-steps.md), that's `http://esphome-starter-kit.local/`.
2. Toggle the **RGB LEDs** entity and play around with the colors and brightness. (1)
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 ea674dbe33..589a5101ff 100755
--- a/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md
+++ b/docs/products/ESPHome-Starter-Kit/modules/temperature-humidity-module.md
@@ -1,11 +1,11 @@
---
-title: Adding the Temperature and Humidity Module
+title: Adding the temperature and humidity module
description: >-
Wire up the ESPHome Starter Kit Temperature and Humidity module. This is a
trustworthy aht20 great for accurate temp and humidity measurements in any
room!
---
-# Adding the Temperature and Humidity Module
+# Adding the temperature and humidity module
The temperature and humidity module is your starter kit's first environmental sensor, reading the air around it on whatever interval you choose. By the end of this tutorial you'll have an AHT20F wired to your ESP32-C6, surfaced as two sensors in your YAML, and updating live in the web server.
@@ -16,7 +16,7 @@ The temperature and humidity module is your starter kit's first environmental se
* [Start Here](/products/ESPHome-Starter-Kit/start-here.md) to snap the temperature and humidity module off the panel.
* [First Steps](/products/ESPHome-Starter-Kit/setup/first-steps.md) to install ESPHome Device Builder and create your starter kit device.
-## Attach Temp and Humidity module
+## Attach temp and humidity module
Connect the Temperature and Humidity module to the ESP32-C6 using one of the FPC ribbon cables that came with the kit. Either FPC connector on the ESP32-C6 works, top or bottom.
@@ -90,22 +90,22 @@ ESPHome Device Builder ships an **Add Component** flow that knows the pin layout
Flash the device so the new temperature and humidity entities go live.
-1. Click **Install** on your device card in ESPHome Device Builder. (1)
+1. Click **Install** at the bottom right of the editor. (1)
{ .annotate }
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.
-2. Choose **Plug into the computer running ESPHome Device Builder** for the first flash, or **On The Network** if the device is already on your Wi-Fi.
+2. Choose **On the network** if the device is already on your Wi-Fi, or **Plug into this computer** to flash over USB.
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
+## Test the temp and humidity
With the device back online, the temperature and humidity entities are 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://
-2\. Select the Apollo ESPHome Starter Kit and give it a name such as esphome-starter-kit, then click **Next**. Type in your Wi-Fi network name (SSID) and Wi-Fi password, then click **Finish Setup**. (1)
+2\. Under **Featured**, select **ESPHome Starter Kit By Apollo** and give it a name such as esphome-starter-kit, then click **Next**. Type in your Wi-Fi network name (SSID) and Wi-Fi password, then click **Finish Setup**. (1)
@@ -161,7 +169,7 @@ With the app installed, it's time to tell it about your kit. If you took the gui
-## Configure Components
+## Configure components
!!! tip "We're now ready to add your first component and turn your project into a smart device!"
@@ -179,7 +187,7 @@ The Onboard RGB LED is a small LED above the Reset button of your ESP32-C6. Usef
-## Boot Mode
+## 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.
@@ -195,9 +203,9 @@ The device is required to be flashed via USB using the bootloader mode the very
-3\. Your device is now in boot mode - The ESP32-C6 will now stay in bootloader mode until you flash it.
+3\. Your device is now in boot mode. The ESP32-C6 will now stay in bootloader mode until you flash it.
-## Installing Software
+## Installing software
Before we continue, confirm that you installed the ESPHome Device Builder, configured your components, and put your device in boot mode.
@@ -222,7 +230,7 @@ Your kit's default project includes the [**Web Server**](../learning-the-basics/
!!! warning "Use http:// not https://"
- Your kit only speaks `http://`. Some browsers quietly try `https://` first, and the page just won't load. If that happens, click the address bar and add `http://` before the name (so it looks like `http://esphome-starter-kit.local/`).
+ Your kit only speaks `http://`. Some browsers quietly try `https://` first, and the page won't load. If that happens, click the address bar and add `http://` before the name (so it looks like `http://esphome-starter-kit.local/`).
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.
diff --git a/docs/products/ESPHome-Starter-Kit/start-here.md b/docs/products/ESPHome-Starter-Kit/start-here.md
index c1bbae3e11..8d87c8be59 100755
--- a/docs/products/ESPHome-Starter-Kit/start-here.md
+++ b/docs/products/ESPHome-Starter-Kit/start-here.md
@@ -1,5 +1,5 @@
---
-title: ESPHome Starter Kit - Start Here
+title: ESPHome Starter Kit - Start here
description: Landing page of the ESPHome Starter Kit QR Code.
---
# Welcome to the ESPHome Starter Kit!
@@ -54,7 +54,7 @@ Each module is connected to the panel by small breakaway tabs. Follow the steps
**Motion module**
-* 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.
+* Detects movement in a room and a great way to get started automating your home. It comes in two parts, and the PIR sensor plugs into the PIR module board.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
index 13686cbd20..d14b184a62 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/bluetooth-proxy.md
@@ -1,10 +1,10 @@
---
-title: Bluetooth Proxy
+title: Bluetooth proxy
description: >-
Turn your ESPHome Starter Kit into a Bluetooth proxy so Home Assistant can see
BLE devices anywhere in your home, using one line of config.
---
-# Turn Your Starter Kit into a Bluetooth Proxy
+# Turn your starter kit into a Bluetooth proxy
Home Assistant can talk to Bluetooth devices directly, but only ones close to the machine it runs on. A Bluetooth proxy fixes that. Your starter kit's ESP32-C6 listens for nearby BLE devices and relays them back to Home Assistant over Wi-Fi, so a sensor two rooms away shows up as if it were sitting next to your server. Drop a few of these around the house and Home Assistant gets Bluetooth coverage everywhere.
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 ca62f4238d..a10d0d58f5 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
@@ -13,6 +13,8 @@ Once your ESPHome Starter Kit is flashed and on Wi-Fi, Home Assistant sees it au
## Add your device
+You'll accept your Starter Kit into Home Assistant through the ESPHome integration.
+
1. Open **Settings → Devices & services** in Home Assistant. Look for a card titled **ESPHome** under **Discovered** listing `esphome-starter-kit`.
[](https://my.home-assistant.io/redirect/integrations/)
@@ -36,7 +38,7 @@ Open the **ESPHome** integration in Home Assistant (**Settings → Devices & ser
You should see:
-* Every component you added in ESPHome Device Builder as an entity (the **GPIO Switch** for accessory power, the **AHT10** temperature and humidity sensors, the **Onboard RGB LED**).
+* Every component you added in ESPHome Device Builder as an entity, such as the **Accessory Power Rail** switch, the **Onboard RGB LED** light, and, if you added the temperature and humidity module, its **Temperature** and **Humidity** sensors.
* A green status indicator showing the device is online.
Toggle the **Onboard RGB LED** light entity and confirm the LED responds on the ESP32-C6. That's the round trip working: Home Assistant talks to your device, your device talks back.
diff --git a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
index 01af581665..44e6884f94 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/light-effects.md
@@ -1,10 +1,10 @@
---
-title: Light Effects
+title: Light effects
description: >-
Add built-in ESPHome light effects (rainbow, color wipe, and more) to your RGB
module using the Effects picker in ESPHome Device Builder.
---
-# Add Light Effects to Your RGB Module
+# Add light effects to your RGB module
Out of the box, your RGB module turns on, turns off, and changes color. ESPHome ships a library of built-in light effects (rainbow cycles, color wipes, flickers, and more), and Device Builder can add them from a dropdown. No typing required. This tutorial adds two effects to get you started.
@@ -17,6 +17,8 @@ Out of the box, your RGB module turns on, turns off, and changes color. ESPHome
## Add the effects
+You'll add the Addressable Rainbow and Addressable Color Wipe effects to one of your RGB lights.
+
1. Open your starter kit device in ESPHome Device Builder and click **Edit**.
2. In the editor's left pane, scroll to **Components** and click the RGB light you want to add effects to. (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 fe0b5fab71..199d0a8369 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/remote-build-server.md
@@ -1,10 +1,10 @@
---
-title: Build Server
+title: Build server
description: >-
Pair a second ESPHome Device Builder with your Windows PC so builds compile on
the PC instead of the machine you normally build from.
---
-# Use Your PC as a Build Server
+# Use your PC as a build server
Compiling is the slow part of ESPHome. Every time you click **Install**, the machine running Device Builder turns your YAML into firmware, and on a Raspberry Pi that can take several minutes. A desktop PC gets through the same build far quicker.
@@ -19,7 +19,7 @@ Device Builder can hand the work to another computer on your network. You pair t
* A second Device Builder to send builds from. This page uses the app in Home Assistant, but any other install works the same way, on a laptop, a Mac, or another server.
* Both machines on the same network, and the PC awake whenever you want to build.
-## Turn On the Build Server
+## Turn on the build server
Start on your Windows PC. This is the machine that will do the compiling.
@@ -34,18 +34,20 @@ Start on your Windows PC. This is the machine that will do the compiling.
-## Pair the Two Dashboards
+## Pair the two dashboards
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
+
+On the sending dashboard, you'll ask your PC to pair.
1. Go to **Settings → Send builds**. Your PC appears under **Known dashboards** with its address and ESPHome version. Click **Pair**.
@@ -58,7 +60,9 @@ On your Windows PC, open **Settings → Pairing requests**. It shows **Open** wi
-### Accept It on Your PC
+### Accept it on your PC
+
+Back on your PC, you'll check the emoji fingerprint and accept the request.
1. The request shows up under **Pairing requests** with the sender's name and **From IP**. Click **Review**.
@@ -77,7 +81,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.
@@ -92,7 +96,7 @@ Device Builder finds other dashboards over mDNS, which doesn't cross subnets or
The ESPHome Device Builder documentation goes further on setups where the two machines sit on different networks.
-## Send Your First Build
+## Send your first build
Nothing changes about how you install. Open your starter kit in the Device Builder you paired from and click **Install**. Your PC does the compiling from here on.
@@ -103,7 +107,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 cdc69748e1..eca494f02f 100644
--- a/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
+++ b/docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
@@ -4,7 +4,7 @@ description: >-
Store API encryption keys, OTA passwords, MQTT credentials, and more in a
single secrets.yaml file so they stay out of your device configs.
---
-# Using Secrets
+# Using secrets
When you set up your kit in [First Steps](../setup/first-steps.md), the Device Builder saved the Wi-Fi name and password you typed in to secrets.yaml. That same file can hold every other sensitive value your device needs, from your Home Assistant API key to your MQTT password. This tutorial walks through what to put in there and how to reference it from your device YAML.
@@ -22,7 +22,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.
+1. You'll see a table of your secrets, one name and value per row, with an **Add secret** button below it. If you followed First Steps you should already see `wifi_ssid` and `wifi_password` here.
@@ -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
@@ -201,7 +201,7 @@ mqtt:
---
-## Complete Example
+## Complete example
Putting it all together, a fully loaded secrets.yaml looks like this:
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 1f2a6fe27d..9b949ef5db 100755
--- a/docs/products/air1/additional-info/air-quality-sensor-comparison.md
+++ b/docs/products/air1/additional-info/air-quality-sensor-comparison.md
@@ -1,8 +1,10 @@
---
-title: Air Quality Sensor Comparison
+title: Air quality sensor comparison
description: A technical comparison of air quality sensors used with the AIR-1, including performance, accuracy, and specifications.
---
-# Air Quality Sensor Comparison
+# 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
+This comparison covers the air quality sensors used with the Apollo AIR-1, including their performance, accuracy, and specifications. It's a spreadsheet that opens in SharePoint, outside this wiki.
+
+[Open the air quality sensor comparison](https://apolloautomation-my.sharepoint.com/:x:/p/trevor/Ea1--coB6rNKvRX07CGsVHEBUF-zUPuyyFvRED-WdjCC_Q?e=NFjC1Y){ .md-button .md-button--primary target=_blank rel="noopener" }
diff --git a/docs/products/air1/additional-info/bluetooth-proxy.md b/docs/products/air1/additional-info/bluetooth-proxy.md
index 76483a7e36..8f34e00556 100644
--- a/docs/products/air1/additional-info/bluetooth-proxy.md
+++ b/docs/products/air1/additional-info/bluetooth-proxy.md
@@ -1,8 +1,8 @@
---
-title: AIR-1 Bluetooth Proxy
+title: AIR-1 Bluetooth proxy
description: Tutorial for how to turn your AIR-1 into a BLE proxy!
---
-# AIR-1 Bluetooth Proxy
+# AIR-1 Bluetooth proxy
--8<-- "_snippets/bluetooth-proxy/intro.md"
diff --git a/docs/products/air1/additional-info/led-indicator.md b/docs/products/air1/additional-info/led-indicator.md
index aba732bdc1..dffc9839e5 100644
--- a/docs/products/air1/additional-info/led-indicator.md
+++ b/docs/products/air1/additional-info/led-indicator.md
@@ -1,8 +1,8 @@
---
-title: AIR-1 LED Indicator
+title: AIR-1 LED indicator
description: Color the AIR-1's onboard RGB LEDs by air quality, using NowCast AQI, CO₂, or the VOC Index.
---
-# AIR-1 LED Indicator
+# AIR-1 LED indicator
The AIR-1's three onboard RGB LEDs can double as an air quality gauge. Pick what they track and they shift from green to red as that reading climbs, so you can read the room from across it.
diff --git a/docs/products/air1/additional-info/predicted-room-temp-humidity.md b/docs/products/air1/additional-info/predicted-room-temp-humidity.md
index a5d98e7baa..d9576b5e95 100644
--- a/docs/products/air1/additional-info/predicted-room-temp-humidity.md
+++ b/docs/products/air1/additional-info/predicted-room-temp-humidity.md
@@ -1,8 +1,8 @@
---
-title: AIR-1 Predicted Room Temperature & Humidity
+title: AIR-1 predicted room temperature & humidity
description: Get a more accurate room temperature and humidity from the AIR-1 by blending its three sensors and correcting for case self-heating.
---
-# AIR-1 Predicted Room Temperature & Humidity
+# AIR-1 predicted room temperature & humidity
The AIR-1's own electronics warm the air inside the case, so the SEN55 and SCD40 read a little warmer and drier than the room around them. The **Predicted Room Temperature** and **Predicted Room Humidity** sensors correct for that. They blend the SEN55, DPS310, and SCD40 readings and apply a physics model to estimate what the room is actually doing.
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 e5cf448355..d4e9282780 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
@@ -1,8 +1,10 @@
---
-title: add SCD40 CO₂ Sensor
+title: Add the SCD40 CO₂ sensor to your AIR-1 (original design)
description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
---
-# Adding The SCD40 CO2 Sensor To The AIR-1 (Original Design)
+# Adding the SCD40 CO2 sensor to the AIR-1 (original design)
+
+Here you open the back of the case and seat the SCD40 module on the black connector inside.
1\. Unplug your AIR-1 from power and remove the back
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 260ca6a9ae..d23c125d09 100755
--- a/docs/products/air1/addons/adding-co2-to-air-1.md
+++ b/docs/products/air1/addons/adding-co2-to-air-1.md
@@ -1,5 +1,5 @@
---
-title: add SCD40 CO₂ Sensor
+title: Add the SCD40 CO₂ sensor to your AIR-1
description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
---
# Adding CO2 to AIR-1
@@ -8,6 +8,8 @@ description: Adding The SCD40 CO₂ Sensor from Sensirion To The AIR-1.
[If you have the Original Design of the AIR-1 please click here](https://wiki.apolloautomation.com/products/air1/addons/adding-co2-to-air-1-mesh-case-design/ "Mesh Case Design for the AIR-1")
+Here you open the case, slide out the PCB, and seat the SCD40 module on its mezzanine connector.
+
1\. Unplug your AIR-1 from power and lift the top of the case or "lid".
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 23fbecc83b..9cd9cff467 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
@@ -4,6 +4,8 @@ description: Adding Optional GPIO Header to AIR-1.
---
# Adding GPIO Header to AIR-1
+Here you open the case, slide out the PCB, and seat the GPIO Header on its mezzanine connector.
+
1\. Unplug your AIR-1 from power and lift the top of the case or "lid".
diff --git a/docs/products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md b/docs/products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
index 20f51c6e6e..b9cf141809 100755
--- a/docs/products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
+++ b/docs/products/air1/addons/adding-the-mics-4514-gas-sensor-to-the-air-1.md
@@ -1,8 +1,8 @@
---
-title: Adding MiCS-4514 Gas Sensor To The AIR-1
+title: Adding MiCS-4514 gas sensor to the AIR-1
description: Adding Optional MiCS-4514 Gas Sensor To The AIR-1.
---
-# Adding The MiCS-4514 Gas Sensor To The AIR-1
+# Adding the MiCS-4514 gas sensor to the AIR-1
!!! tip "Tip"
diff --git a/docs/products/air1/air1-reviews.md b/docs/products/air1/air1-reviews.md
index bbd046c453..a2bc1cfd4c 100755
--- a/docs/products/air1/air1-reviews.md
+++ b/docs/products/air1/air1-reviews.md
@@ -1,18 +1,18 @@
---
-title: AIR-1 Reviews
+title: AIR-1 reviews
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)
+# [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 972245db89..47cdc65823 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,11 +1,29 @@
---
-title: AIR-1 Temperature Calibration
+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
+# 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 Apollo AIR-1 reads temperature from its SEN55 sensor. If that reading doesn't match your room, set the **SEN55 Temperature Offset** on the AIR-1's device page in Home Assistant to bring it in line.
+
+!!! note "Before you start"
+
+ You need a reference thermometer you trust to compare against the AIR-1's temperature reading.
+
+Follow these steps to set the offset.
+
+1\. Place your reference thermometer next to the AIR-1 and compare the two temperature readings.
+
+2\. In Home Assistant, go to **Settings → Devices & services → ESPHome** and select your AIR-1 to open its device page.
+
+[](https://my.home-assistant.io/redirect/integration/?domain=esphome)
+
+3\. In the **Configuration** card, find **SEN55 Temperature Offset** and adjust it until the AIR-1's temperature matches your reference thermometer. The screenshots below show an example offset of 5.0 °C.
-
\ No newline at end of file
+The card can cut the entity name short. Hover over the field to confirm it's **SEN55 Temperature Offset**.
+
+
+
+Your AIR-1 now applies the offset to its SEN55 temperature reading. For more on how offsets work, and for advanced calibration options, see the [temperature and humidity calibration guide](../../../general/temp-hum-calibration/).
diff --git a/docs/products/air1/examples/air1-dashboard-examples.md b/docs/products/air1/examples/air1-dashboard-examples.md
index dc0065afeb..68ae1e25e3 100755
--- a/docs/products/air1/examples/air1-dashboard-examples.md
+++ b/docs/products/air1/examples/air1-dashboard-examples.md
@@ -1,8 +1,8 @@
---
-title: AIR-1 Home Assistant Dashboard Examples
+title: AIR-1 Home Assistant dashboard examples
description: AIR-1 Home Assistant Dashboard Examples
---
-# AIR-1 Home Assistant Dashboard Examples
+# AIR-1 Home Assistant dashboard examples
Really neat dashboard for your AIR-1 by user "keex"!
@@ -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
This card installs from HACS, so add it there first:
@@ -161,7 +161,7 @@ series:
value: 0
```
-### Custom: Plotly Graph Card
+### Custom: Plotly graph card
This card installs from HACS, so add it there first:
@@ -178,10 +178,12 @@ refresh_interval: 10
title: Bedroom CO2
```
-### Home Assistant Gauge
+### Home Assistant gauge
+*Shown with an MSR-1; the AIR-1 CO2 gauge looks the same.*
+
```plaintext
type: gauge
entity: sensor.apollo_air_1_a79e38_co2
@@ -195,9 +197,9 @@ severity:
red: 2000
```
-## **VOC Charts**
+## **VOC charts**
-### Home Assistant Sensor
+### Home Assistant sensor
@@ -210,7 +212,7 @@ hours_to_show: 24
name: Basement VOC
```
-### Custom: Plotly Graph Card
+### Custom: Plotly graph card
@@ -223,7 +225,7 @@ refresh_interval: 10
title: Basement VOC
```
-### Home Assistant Gauge
+### 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 a9d99b8db2..c687d29ef6 100755
--- a/docs/products/air1/examples/firstof9's-apex-charts.md
+++ b/docs/products/air1/examples/firstof9's-apex-charts.md
@@ -1,54 +1,64 @@
---
-title: Firstof9's AIR-1 Apex Charts Dashboard
+title: Firstof9's AIR-1 Apex Charts dashboard
description: >-
- A custom dashboard made by Discord/GitHub user Firstof9 using Apex Charts for
- a really neat AIR-1 dashboard.
+ A responsive, color-coded AIR-1 dashboard built by Discord and GitHub user
+ Firstof9 with the ApexCharts card, and how to add it to Home Assistant.
---
-# Firstof9's AIR-1 Apex Charts Dashboard
+# Firstof9's AIR-1 Apex Charts dashboard
-Firstof9 has created this beautiful responsive dashboard with [Apexcharts-card](https://github.com/RomRider/apexcharts-card "ApexCharts-card") custom card from [HACS](https://hacs.xyz/ "Home Assistant Community Store")!
-
-The colors will change as severity levels change for each of the sensors below.
+Discord and GitHub user Firstof9 built this responsive dashboard for the Apollo AIR-1 with the [Apexcharts-card](https://github.com/RomRider/apexcharts-card "ApexCharts-card") custom card from [HACS](https://hacs.xyz/ "Home Assistant Community Store"). Each chart changes color as that sensor's severity level changes.
-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").
+This guide walks you through three stages: install the card, adapt Firstof9's code to your AIR-1, and paste it into your dashboard.
+
+!!! note "Before you start"
+
+ This guide assumes you already have HACS installed. If you don't, [install HACS](https://hacs.xyz/docs/use/download/prerequisites/ "Install HACS") first.
+
+## Install the ApexCharts card
-First, you need to install apexcharts-card by going to the HACS tab and searching "apexcharts-card".
+Every chart on this dashboard is an apexcharts-card, so install the card from HACS first.
+
+1\. Go to the HACS tab and search for `apexcharts-card`. The button below opens the repository in HACS directly.
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=RomRider&repository=apexcharts-card&category=plugin)
-Once downloaded, it is ready to be used for dashboards!
+2\. Download apexcharts-card.
-Next, you need to edit the dashboards here.
+Once it's downloaded, the card is ready to use in your dashboards.
-
+## Prepare the dashboard code
-!!! danger "WARNING YOU ARE ABOUT TO BE ABLE TO WIPE OUT ALL YOUR DASHBOARDS PROCEED WITH CAUTION."
+Firstof9's code uses `downstairs_air_sensor` as the prefix in every entity ID (for example `sensor.downstairs_air_sensor_co2`). Before you paste the code into your dashboard, swap that prefix for your own AIR-1's.
- You are entering an area where if you copy/paste to the wrong place you could delete other dashboards so please be careful!
+!!! warning "Change the entity IDs first"
-Now choose "raw configuration editor"
+ If the entity IDs in the code don't match your device, the cards won't work.
-
+### Find your entity ID prefix
-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)
+Your prefix comes from the entity IDs Home Assistant gave your AIR-1. Look it up on the CO2 sensor:
-
+1\. Go to **Settings → Devices & services → ESPHome** and select your AIR-1.
+
+[](https://my.home-assistant.io/redirect/integration/?domain=esphome)
+
+2\. Click its CO2 sensor, then the settings cog.
-**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.
+3\. Look at the **Entity ID**, for example `sensor.apollo_air_1_ccaac4_co2`. The part between `sensor.` and `_co2` is your prefix.
-
+Your prefix uses underscores, not the hyphens shown in ESPHome Device Builder.
-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)
+### Swap in your prefix
-VSC Find/Replace
+The fastest way to change every entity ID in the code is a code editor like Visual Studio Code (VS Code), or an AI assistant like ChatGPT. In VS Code, open Find (Ctrl+F), then select the small arrow to toggle open the Replace box. Find `downstairs_air_sensor` and replace it with your prefix.
-**This is the code!**
+Here's Firstof9's dashboard code. Copy it into your editor and replace the prefix. Once every entity ID matches your AIR-1, the code is ready to paste.
```yaml
- type: sections
@@ -491,16 +501,40 @@ VSC Find/Replace
grid_rows: 6
```
-Now click save in the top right and remember to not hit any buttons or make any other edits before saving!
+## Add the dashboard to Home Assistant
+
+With your code ready, add it to the end of your dashboard's raw configuration. This is where the charts go live.
+
+!!! warning "This editor can wipe out your dashboards"
+
+ In the raw configuration editor you're editing all of your dashboards at once. If you copy or paste into the wrong place, you could delete other dashboards. Paste only at the very bottom.
+
+1\. Open your dashboard and click the pencil icon in the top right to edit it.
+
+
+
+2\. Open the three-dot menu and choose **Raw configuration editor**.
+
+
+
+3\. Scroll to the very bottom of the editor and paste your edited code on the empty last line.
+
+
+
+4\. Click **Save** in the top right. Don't click any other buttons or make any other edits before you save.
-Finally hit "done" in the top right.
+5\. Click **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!
+6\. Press F5 or refresh your browser, then look for the new air icon among your dashboard tabs and click 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
+Your AIR-1 readings now fill Firstof9's color-coded charts, and each chart changes color as its sensor's severity level changes.
+
+## Thanks
+
+Thanks to [firstof9](https://github.com/firstof9 "Thank firstof9") for creating this dashboard and sharing it.
diff --git a/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md b/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md
index d0bf241102..ed8dd37015 100755
--- a/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md
+++ b/docs/products/air1/examples/how-to-use-the-apollo-gpio-header-to-control-an-led-strip.md
@@ -18,7 +18,7 @@ Click any photo to see it full size.
!!! warning "Watch the current draw"
- The 5V pin supplies up to 300mA. A meter of 60 LEDs at full white draws far more than that, so anything longer than a short strip needs its own 5V supply. You can power the AIR-1 itself from the 5V and GND pins instead of the USB-C port, but use one or the other, never both.
+ The 5V pin supplies up to 350mA. A meter of 60 LEDs at full white draws far more than that, so anything longer than a short strip needs its own 5V supply. You can power the AIR-1 itself from the 5V and GND pins instead of the USB-C port, but use one or the other, never both.
## Choosing a data pin
@@ -50,6 +50,8 @@ Opening an AIR-1 takes a few more steps than the other Apollo sensors, because t
## Wiring the strip
+Next, you connect the strip to the header and check that data flows in the right direction.
+
1. Run three wires from the header to the strip: 5V, GND, and data. Matching the colors to the strip's own wiring saves a lot of squinting later, so use red for 5V, white for GND, and green for data on IO7.
{ width="200" } { width="200" } { width="200" }
diff --git a/docs/products/air1/examples/tim-air-1-erv-whole-home.md b/docs/products/air1/examples/tim-air-1-erv-whole-home.md
index e7dfcae700..5851c604ab 100755
--- a/docs/products/air1/examples/tim-air-1-erv-whole-home.md
+++ b/docs/products/air1/examples/tim-air-1-erv-whole-home.md
@@ -1,17 +1,29 @@
---
-title: Tim's AIR-1 ERV Whole Home Solution
-description: A user-shared ERV solution featuring the AIR-1 - Tim's AIR-1 ERV Whole Home Solution.
+title: Tim's AIR-1 ERV whole-home solution
+description: How AIR-1 owner Tim built a whole-home ventilation system with an AIR-1 inside it and logs its readings in a custom Grafana dashboard.
---
-# Tim's AIR-1 ERV Whole Home Solution
+# Tim's AIR-1 ERV whole-home solution
-esp32 C6 which drives two single phase inverters via two dac mcp4725 and four relays. Hrv is o3ozon cwp250. Ducts zinc plated steel at fi160 and max vents 90mm distribution.
+Tim, an Apollo AIR-1 owner, built a whole-home ventilation system (an ERV, or energy recovery ventilator) and put an AIR-1 inside it. Here's what his setup is made of, the data he tracks, and why he built it.
+
+## The setup
+
+Tim's system has three main parts:
+
+- **Controller:** an ESP32-C6 that drives two single-phase inverters through two MCP4725 DACs (digital-to-analog converters) and four relays.
+- **Ventilator:** an o3ozon CWP250, which Tim lists as an HRV (heat recovery ventilator).
+- **Ducts:** zinc-plated steel at fi160, with the distribution to the vents at 90mm max.
-Check out the data he's logging with the AIR-1 into his custom grafana dashboard!
+## The data
+
+Tim logs his AIR-1 readings into a custom Grafana dashboard:
-!!! warning "Tim's warning to others:"
+## Why Tim built it
+
+!!! quote "Tim's warning to others"
- I had constant sinuses burn due to lack of ventilation. Probably co poisoning in the past and also temperature inversion in my mountainous valley which cause massive spikes in smog. While relatively good air beyond that. Home was working as reservoir of smog.
\ No newline at end of file
+ My sinuses burned constantly due to lack of ventilation. It was probably CO poisoning in the past, and also temperature inversions in my mountainous valley, which cause massive spikes in smog even though the air is relatively good beyond that. My home was working as a reservoir of smog.
diff --git a/docs/products/air1/faq.md b/docs/products/air1/faq.md
index e1a1979cb7..4629c86a4d 100755
--- a/docs/products/air1/faq.md
+++ b/docs/products/air1/faq.md
@@ -73,11 +73,11 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in
18\. **My AIR-1 CO2 sensors are having a sawtooth pattern, is there any explanation?**
-* Some users have noticed the AIR-1 with the "Apollo" side facing up will produce strange behavior with the CO2 sensor readings fluctuating way more than they should. Simply turning the AIR-1 to the other side makes this problem go away!
+* Some users have noticed the AIR-1 with the "Apollo" side facing up will produce strange behavior with the CO2 sensor readings fluctuating way more than they should. Turning the AIR-1 to the other side makes this problem go away!
19\. **Can I integrate multiple AIR-1 sensors in my smart home?**
-* Yes, you can have multiple AIR-1 sensors in your Home Assistant setup. Each sensor will be recognized as a separate entity, allowing you to monitor air quality across different rooms or spaces simultaneously.
+* Yes, you can have multiple AIR-1 sensors in your Home Assistant setup. Each one shows up as its own device with its own set of entities, so you can monitor air quality across different rooms or spaces at the same time.
20\. **How customizable is the AIR-1?**
@@ -89,7 +89,7 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in
22\. **Does the AIR-1 require specific software?**
-* The AIR-1 is designed to work seamlessly with Home Assistant through ESPHome. All configuration, monitoring, and automation setups are done through these platforms.
+* The AIR-1 is designed to work with Home Assistant through ESPHome. All configuration, monitoring, and automation setups are done through these platforms.
23\. **Is the AIR-1 compatible with other smart home platforms?**
@@ -109,7 +109,7 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in
27\. **How do I install the AIR-1?**
-* Installation is easy. Simply plug the AIR-1 into a wall outlet using the USB-C cable, connect it to your Home Assistant through ESPHome, and configure the settings as desired. Detailed setup instructions are available in our documentation.
+* Plug the AIR-1 into a wall outlet using the USB-C cable, connect it to your Home Assistant through ESPHome, and configure the settings as desired. Detailed setup instructions are available in our documentation.
28\. **What is the warranty on the AIR-1?**
diff --git a/docs/products/air1/setup/general-tips.md b/docs/products/air1/setup/general-tips.md
index ec1609069f..fa77893a05 100755
--- a/docs/products/air1/setup/general-tips.md
+++ b/docs/products/air1/setup/general-tips.md
@@ -1,64 +1,73 @@
---
-title: AIR-1 General Tips
+title: AIR-1 general tips
description: >-
- Guide to help you understand which sensors you should be concerned with and
- expected safe or not safe thresholds to alert or automate on.
+ Learn which AIR-1 sensor readings matter most, and the safe and unsafe
+ thresholds to alert or automate on.
---
-# AIR-1 General Tips
+# AIR-1 general tips
-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.
+Your Apollo AIR-1 has several different types of sensors. This guide helps you understand which readings you should be concerned with, and the safe and unsafe 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.
+The SEN55 is the powerhouse of the AIR-1. It measures particulate matter, volatile organic compounds (VOCs), oxidizing gases such as nitrogen oxides (NOx), humidity, and 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.
+The EPA defines particulate matter (also called particle pollution) as 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. Read about the sources of indoor PM particles.
-**PM10** : inhalable particles, with diameters that are generally 10 micrometers and smaller; and
+The EPA describes two common sizes:
-**PM2\.5** : fine inhalable particles, with diameters that are generally 2.5 micrometers and smaller.
+* **PM10**: inhalable particles, with diameters that are generally 10 micrometers and smaller.
+* **PM2\.5**: fine inhalable particles, with diameters that are generally 2.5 micrometers and smaller.
-* How small is 2.5 micrometers? Think about a single hair from your head. The average human hair is about 70 micrometers in diameter – making it 30 times larger than the largest fine particle.
+How small is 2.5 micrometers? Think about a single hair from your head. The average human hair is about 70 micrometers in diameter, making it 30 times larger than the largest fine particle.
-!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when PM particles are rising"
+!!! tip "Automate when PM levels rise"
- This article goes over lots of ways to reduce pm particles in your home!
+ Trigger an alert automation, your HVAC, or a fan when PM particles are rising. This article goes over lots of ways to reduce PM particles in your home.
-## Safe PM Levels
+### What PM1, PM2.5, PM4, and PM10 mean
-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?
+PM is often classified by size, because smaller particles pose greater risks to health: they can penetrate deeper into the lungs. Here's what each size means:
-!!! note "PM2.5 and PM10 are the most widely monitored and regulated for public health purposes."
+!!! note "PM2.5 and PM10 are the most common"
- The PM 1, PM2.5, PM4, and PM10 are all four useful even if PM 2.5 and PM 10 are the most common!
+ PM2.5 and PM10 are the most widely monitored and regulated for public health purposes, but all four readings (PM1, PM2.5, PM4, and PM10) are useful.
----
+## Safe PM levels
-## Recommended Safe Exposure Limits
+Health agencies publish limits for how much particulate matter is safe to breathe. Use these tables to pick the thresholds for your alerts and automations.
+
+### Recommended safe exposure limits (WHO)
The **World Health Organization (WHO)** provides the following exposure limits for particulate matter:
----
+### U.S. EPA Air Quality Index (AQI) for PM2.5
-## U.S. EPA Air Quality Index (AQI) – PM2.5
+The **U.S. Environmental Protection Agency (EPA)** defines safety thresholds for PM2.5 based on a 24-hour average:
-The **U.S. Environmental Protection Agency (EPA)** defines safety thresholds for PM2.5 based on a 24-hour average:
+
-
+### PM safe ranges at a glance
----
+This table sums up the WHO and EPA limits above for each PM size:
+
+
+
+### 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 and PM2.5 concentrations indoors.
+* Keep **PM2.5 below 12 µg/m³** indoors for general safety, and below **5 µg/m³** for ideal long-term health protection.
## NowCast AQI
-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.
+NowCast AQI takes your PM2.5 and PM10 readings and converts them into a single number from 0 to 500 using the EPA's formula. That number maps directly to the categories in the EPA AQI table above: bigger means worse.
The AIR-1 calculates this automatically and exposes it as a sensor in Home Assistant.
@@ -66,85 +75,53 @@ The AIR-1 calculates this automatically and exposes it as a sensor in Home Assis
Instead of comparing µg/m³ values across PM1, PM2.5, PM4, and PM10, you get one number. Set an automation to trigger at 100 (Moderate) or 150 (Unhealthy for Sensitive Groups) and anyone in your household can understand why it fired.
----
-
-## 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.
-* Keep **PM2.5 below 12 µg/m³** indoors for general safety; below **5 µg/m³** for ideal long-term health protection.
-
----
-
-
-
----
-
## VOC Index
-Per Sensirion,
+Per Sensirion:
-> The VOC Index
->
-> describes the current VOC status in a room relative to the sensor’s
->
-> recent history. In this way, the VOC Index behaves like a human nose
+> The VOC Index describes the current VOC status in a room relative to the sensor’s recent history. In this way, the VOC Index behaves like a human nose.
-!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when the VOC Index rises above 100"
+!!! tip "Automate when the VOC Index rises above 100"
- Per Sensirion:
+ Trigger an alert automation, your HVAC, or a fan when the VOC Index rises above 100. Per Sensirion:
- > a VOC Index above 100 means that there are more
- >
- > VOCs compared to the average (e.g., induced by a VOC event from
- >
- > cooking, cleaning, breathing, etc.) while a VOC Index below 100 means
- >
- > that there are fewer VOCs compared to the average
+ > a VOC Index above 100 means that there are more VOCs compared to the average (e.g., induced by a VOC event from cooking, cleaning, breathing, etc.) while a VOC Index below 100 means that there are fewer VOCs compared to the average
## VOC Quality
-This uses the VOC index and a scale to output an easier to use variable.
-
-0-79: **Improved** -> 80-149: **Normal** -> 150-249: **Abnormal** -> 250-399: **Very abnormal** -> 400+: **Extremely abnormal**
+VOC Quality uses the VOC Index and a scale to output an easier-to-use rating. Each VOC Index range maps to one rating:
-!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when the VOC Quality changes to Abnormal or Very Abnormal or Extremely Abnormal."
+| VOC Index | VOC Quality |
+| --- | --- |
+| 0-79 | **Improved** |
+| 80-149 | **Normal** |
+| 150-249 | **Abnormal** |
+| 250-399 | **Very abnormal** |
+| 400+ | **Extremely abnormal** |
- This is a very easy way to automate based on the air quality changing over the past 24 hours but you will still want to automate on particulate matter as well!
+!!! tip "Automate when VOC Quality turns Abnormal or worse"
-## NOX Index
+ Trigger an alert automation, your HVAC, or a fan when VOC Quality changes to Abnormal, Very abnormal, or Extremely abnormal. This is a quick way to automate on air quality changes over the past 24 hours, but you'll still want to automate on particulate matter as well.
-Per Sensirion,
+## NOx Index
-> The NO x Index describes the current NO x condition in a
->
-> room relative to the sensor’s recent history. In this way, the NO x Index
->
-> behaves like a human nose.
+Per Sensirion:
-!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when NOx rises above 1"
+> The NOx Index describes the current NOx condition in a room relative to the sensor’s recent history. In this way, the NOx Index behaves like a human nose.
- Per Sensirion:
+!!! tip "Automate when the NOx Index rises above 1"
- > On the NO x Index scale, this offset is always mapped to
- >
- > the value of 1, making the readout as easy as possible: an NO x Index
- >
- > above 1 means that there are more NO x compounds compared to the
- >
- > average (e.g., induced by cooking on a gas stove), while an NO x Index
- >
- > close to 1 means that there are (nearly) no NO x gases present, which is
- >
- > the case most of the time (or induced by fresh air from an open window,
- >
- > using an air purifier, etc.).
+ Trigger an alert automation, your HVAC, or a fan when the NOx Index rises above 1. Per Sensirion:
----
+ > On the NOx Index scale, this offset is always mapped to the value of 1, making the readout as easy as possible: an NOx Index above 1 means that there are more NOx compounds compared to the average (e.g., induced by cooking on a gas stove), while an NOx Index close to 1 means that there are (nearly) no NOx gases present, which is the case most of the time (or induced by fresh air from an open window, using an air purifier, etc.).
## 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!
+The optional CO2 sensor addon lets your AIR-1 track CO2. CO2 levels in a closed, poorly ventilated bedroom can quickly rise to concentrations that may impair focus or even pose health risks. In the chart below, notice the CO2 levels dropping when the HVAC was turned on overnight.
+
+
+
+### Automatic calibration
The latest AIR-1 firmware keeps the SCD40 calibrated automatically. The sensor assumes it sees fresh air (about 420 ppm) at least once a week and corrects its baseline to match, so you no longer need to re-calibrate it manually every 1 to 2 years.
@@ -152,18 +129,16 @@ 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.
-
+### CO2 levels and health effects
-Wisconsin Department of Health CO2 Level Chart
+The Wisconsin Department of Health CO2 Level Chart lists CO2 levels and their health effects:
-!!! tip "We suggest triggering alert automations, hvac or a fan turning on, etc when CO2 is over 1000"
-
- Opening a window, turning on a fan, the HVAC in the house, etc are all great ways to get CO2 to go down!
+!!! tip "Automate when CO2 is over 1000 ppm"
----
+ Trigger an alert automation, your HVAC, or a fan when CO2 goes over 1000 ppm. Opening a window, turning on a fan, or running the HVAC in your house are all great ways to bring CO2 down.
-## 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
+The MiCS-4514 is a unique sensor that can distinguish between multiple gases, such as carbon monoxide, nitrogen dioxide (NO2), ethanol, hydrogen, ammonia, and methane.
diff --git a/docs/products/air1/setup/sensor-definitions.md b/docs/products/air1/setup/sensor-definitions.md
index e1f1830b95..041458c185 100755
--- a/docs/products/air1/setup/sensor-definitions.md
+++ b/docs/products/air1/setup/sensor-definitions.md
@@ -1,8 +1,8 @@
---
-title: AIR-1 Sensor Definitions
+title: AIR-1 sensor definitions
description: Full list of definitions for the AIR-1 and its various sensors.
---
-# Sensor Definitions
+# Sensor definitions
Once added to Home Assistant you can configure different settings for your AIR-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them.
@@ -12,7 +12,7 @@ Once added to Home Assistant you can configure different settings for your AIR-1
The **Default Update** column is how often each sensor refreshes while the AIR-1 is awake. By default **Prevent Sleep** is on, so the device stays awake and reports continuously at these intervals. Turn **Prevent Sleep** off to let the AIR-1 deep-sleep between readings for more accurate onboard SEN55 temperature and humidity (the ESP chip's heat skews them while it is awake); it then wakes for about 2 minutes, reports, and sleeps for the **Sleep Duration**.
- To update firmware on a sleeping device, just click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand.
+ To update firmware on a sleeping device, click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand.
=== "Controls"
diff --git a/docs/products/air1/troubleshooting/air1-boot-mode.md b/docs/products/air1/troubleshooting/air1-boot-mode.md
index b3f9ebcedb..9e7a503895 100755
--- a/docs/products/air1/troubleshooting/air1-boot-mode.md
+++ b/docs/products/air1/troubleshooting/air1-boot-mode.md
@@ -1,14 +1,16 @@
---
-title: Putting The AIR-1 In Boot Mode
+title: Putting the AIR-1 in boot mode
description: Step by step guide for putting The AIR-1 In Boot Mode.
---
-# Putting The AIR-1 In Boot Mode
+# Putting the AIR-1 in boot mode
!!! info "This will cover how to put the AIR-1 into 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
+
+With this method, you hold the boot button while you plug in the USB-C 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).
@@ -18,9 +20,11 @@ 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
+
+With this method, you use the boot and reset buttons while the device is plugged into your computer.
-1\. Unplug the device and locate the boot and reset buttons as shown in the image above.
+1\. Unplug the device and locate the boot and reset buttons as shown in the image below.
2\. Plug it into your computer.
diff --git a/docs/products/air1/troubleshooting/air1-code.md b/docs/products/air1/troubleshooting/air1-code.md
index 54511b76cb..ee82ad9421 100755
--- a/docs/products/air1/troubleshooting/air1-code.md
+++ b/docs/products/air1/troubleshooting/air1-code.md
@@ -1,43 +1,48 @@
---
-title: Factory Re-Flash AIR-1
-description: Step by step guide for re-flashing the AIR-1 back to factory firmware.
+title: Factory re-flash AIR-1
+description: Re-flash your AIR-1 with its factory firmware over USB when it becomes unresponsive.
---
-# Factory Re-Flash AIR-1
+# Factory re-flash AIR-1
-!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below."
+If your Apollo AIR-1 becomes unresponsive and you've exhausted the other troubleshooting methods, you can re-flash the factory firmware by following the steps below.
- This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser.
+!!! note "Before you start"
-If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing.
+ - Do the factory re-flash in Chrome, Edge, or another Chromium-based browser.
+ - If your AIR-1 has already been connected to Home Assistant, remove it from the ESPHome integration and the ESPHome Device Builder before continuing.
-1\. 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).
+## Re-flash the factory firmware
+
+Follow these steps to put the factory firmware back on your AIR-1 from the Apollo AIR-1 Installer.
+
+1\. Put your AIR-1 in boot mode: hold down the boot button (the right of the two buttons beside the USB-C port), then plug in the USB cable. Let go of the button once the cable is in.
-2\. Navigate to our installer page and click connect under Battery Firmware Apollo AIR-1 Installer.
+2\. Navigate to the Apollo AIR-1 Installer.
-3\. Click the big "Connect" button.
+3\. Click the big **Connect** button on the installer page.
-4\. Select the open com port then click Connect.
+4\. In the browser pop-up, select your AIR-1's open serial (COM) port, then click **Connect**. In the screenshot below, it's listed as USB JTAG/serial debug unit.
-5\. Click "Install ApolloAutomation.AIR-1".
+5\. Click **Install AIR-1**.
-6\. Click "INSTALL".
+6\. Click **INSTALL**.
-7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
+7\. When you see **Installation complete!**, the factory firmware is installed. Click **Next**, then close the browser window.
-!!! warning "Power cycle your device before doing anything else!"
+!!! warning "Power cycle your AIR-1 before doing anything else"
- Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode!
+ Your AIR-1 is still in boot mode. Power cycle it (unplug it to remove power, then plug it back in) so it boots in normal mode.
-8\. Please proceed to the getting started guide and set up your sensor as a new device!
\ No newline at end of file
+8\. Go to the getting started guide and set up your AIR-1 as a new device.
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 6c9299ba09..65c1dcf4dd 100755
--- a/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
+++ b/docs/products/air1/troubleshooting/air1-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials
+title: Reset Wi-Fi credentials
description: Step by step guide for resetting the Wi-Fi Credentials on your AIR-1.
---
-# Reset Wi-Fi Credentials
+# Reset Wi-Fi credentials
+
+Here you clear the saved Wi-Fi credentials so you can enter new Wi-Fi details through the device's hotspot.
1\. Plug the device into power.
diff --git a/docs/products/air1/troubleshooting/air1-teardown.md b/docs/products/air1/troubleshooting/air1-teardown.md
index 9e53d73682..6ea85f9082 100755
--- a/docs/products/air1/troubleshooting/air1-teardown.md
+++ b/docs/products/air1/troubleshooting/air1-teardown.md
@@ -1,12 +1,12 @@
---
-title: AIR-1 Teardown
+title: AIR-1 teardown
description: Step by step guide for tearing down your AIR-1 to replace parts, clean it, swap cases, etc.
---
-## **Original Design**
+## **Original design**
-## **Latest Design**
+## **Latest design**
\ No newline at end of file
diff --git a/docs/products/apolloodroid/faq.md b/docs/products/apolloodroid/faq.md
index c676264521..cd1ab6e45b 100755
--- a/docs/products/apolloodroid/faq.md
+++ b/docs/products/apolloodroid/faq.md
@@ -5,7 +5,7 @@ description: Apollo Odroid FAQ.
1\. **What is the Apollo Odroid?**
-The Apollo Odroid is a plug-and-play device pre-configured with Home Assistant OS. It’s designed to simplify the setup of your smart home by providing an out-of-the-box solution for home automation, running on the powerful ODROID-M1S platform.
+The Apollo Odroid is a plug-and-play device pre-configured with Home Assistant OS. It’s designed to simplify the setup of your smart home by providing an out-of-the-box solution for home automation, running on the ODROID-M1S platform.
2\. **What hardware does the Apollo Odroid include?**
@@ -19,11 +19,11 @@ The Apollo Odroid comes equipped with:
• USB-C power supply (USA plug)
-• Ethernet cable for easy network connection
+• Ethernet cable for your network connection
3\. **How do I set up the Apollo Odroid?**
-* Simply plug in the device using the included USB-C power supply and Ethernet cable. Once powered on, connect it to your local network, access Home Assistant via your web browser, and begin configuring your smart home devices. No flashing or technical setup is required.
+* Plug in the device using the included USB-C power supply and Ethernet cable. Once powered on, connect it to your local network, access Home Assistant via your web browser, and begin configuring your smart home devices. No flashing or technical setup is required.
4\. **Is this device cloud-dependent?**
@@ -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 Wi-Fi and Ethernet connections, giving you flexible options for integrating it into your network.
+* Not built in. The ODROID-M1S has Gigabit Ethernet but no onboard Wi-Fi or Bluetooth. You can add Wi-Fi with a USB adapter such as Hardkernel's WiFi Module 5BK, but we recommend wired Ethernet for a Home Assistant server.
7\. **Can I customize the Home Assistant installation on the Apollo Odroid?**
@@ -59,4 +59,4 @@ The Apollo Odroid comes equipped with:
12\. **How does the Apollo Odroid compare to other smart home hubs?**
-* The Apollo Odroid is unique because it offers local control, requires no cloud or subscription services, and runs on the powerful Home Assistant platform, providing unmatched flexibility and control over your smart home setup. Plus, it’s completely open-source and can be customized to fit your needs.
\ No newline at end of file
+* The Apollo Odroid is unique because it offers local control, requires no cloud or subscription services, and runs on the Home Assistant platform, providing unmatched flexibility and control over your smart home setup. Plus, it’s completely open-source and can be customized to fit your needs.
\ No newline at end of file
diff --git a/docs/products/apolloodroid/getting-started.md b/docs/products/apolloodroid/getting-started.md
index 7e7922443a..c94450d9d1 100755
--- a/docs/products/apolloodroid/getting-started.md
+++ b/docs/products/apolloodroid/getting-started.md
@@ -1,9 +1,9 @@
---
-title: Getting Started With Apollo Odroid
+title: Getting started with Apollo Odroid
description: Getting Started With Apollo Odroid Flashed With Home Assistant (Odroid M1S).
---
-# Getting Started With Apollo Odroid Flashed With Home Assistant (Odroid M1S)
+# Getting started with Apollo Odroid flashed with Home Assistant (Odroid M1S)
This guide will walk you through setting up your Apollo Home Assistant hub aka the Apollo Odroid.
diff --git a/docs/products/apolloodroid/introduction.md b/docs/products/apolloodroid/introduction.md
index fdfe50b231..af69db9141 100755
--- a/docs/products/apolloodroid/introduction.md
+++ b/docs/products/apolloodroid/introduction.md
@@ -1,11 +1,11 @@
---
-title: Apollo Odroid Introduction
+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.
+The Apollo Odroid is a ready-to-use device designed to kickstart your smart home journey with ease. Built on the 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.
Perfect for both beginners and seasoned Home Assistant users, the Apollo Odroid offers a streamlined experience. It’s housed in an Apollo Automation-designed case, powered via a USB-C connection, and includes everything you need, such as a USA power supply and an Ethernet cable. Whether you’re looking to manage lights, climate, security, or any other smart home devices, the Apollo Odroid is your reliable gateway to full local control without the need for cloud services.
-With this device, we aim to provide a plug-and-play solution that’s affordable, powerful, and community-driven.
\ No newline at end of file
+With this device, we aim to provide a plug-and-play solution that’s affordable and community-driven.
\ No newline at end of file
diff --git a/docs/products/apolloodroid/reviews.md b/docs/products/apolloodroid/reviews.md
index aba31b9905..8359c5aa2f 100755
--- a/docs/products/apolloodroid/reviews.md
+++ b/docs/products/apolloodroid/reviews.md
@@ -1,5 +1,5 @@
---
-title: Apollo Odroid Reviews
+title: Apollo Odroid reviews
description: The Apollo Odroid Reviews.
---
# Simon Says Home Assistant
diff --git a/docs/products/breakout-boards/scd40-breakout-board/introduction.md b/docs/products/breakout-boards/scd40-breakout-board/introduction.md
index e0ca2d5cad..6b33cef91c 100755
--- a/docs/products/breakout-boards/scd40-breakout-board/introduction.md
+++ b/docs/products/breakout-boards/scd40-breakout-board/introduction.md
@@ -1,15 +1,17 @@
---
-title: Apollo SCD40 Breakout Board Introduction
+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.
+The **SCD40 Breakout Board** is a compact PCB kit featuring the SCD40, so you can 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".
+The example also reads its OTA password from your secrets.yaml, so add an `ota_password` line there before you install. See [Using Secrets](/products/ESPHome-Starter-Kit/tutorials/using-secrets.md#ota-password) for the format.
+
**GPIO Pins Listed:**
```yaml
@@ -72,7 +74,7 @@ api:
ota:
- platform: esphome
- password: "a53d93acd493275512730c776f88722a"
+ password: !secret ota_password
wifi:
ssid: !secret wifi_ssid
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 35601aebc6..d7b13f83b5 100755
--- a/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
+++ b/docs/products/breakout-boards/sen55-scd40-breakout-board/introduction.md
@@ -1,10 +1,10 @@
---
-title: Apollo SEN55 and SCD40 Breakout Board Introduction
+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.
+The **SEN55 and SCD40 Breakout Board** is a compact PCB kit featuring the SEN55 sensor and an optional SCD40, so you can 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".
@@ -79,7 +79,7 @@ api:
ota:
- platform: esphome
- password: "a53d93acd493275512730c776f88722a"
+ password: !secret ota_password
wifi:
ssid: !secret wifi_ssid
diff --git a/docs/products/btn1/additional-info/bluetooth-proxy.md b/docs/products/btn1/additional-info/bluetooth-proxy.md
index 2647239658..7835fd67c4 100644
--- a/docs/products/btn1/additional-info/bluetooth-proxy.md
+++ b/docs/products/btn1/additional-info/bluetooth-proxy.md
@@ -1,8 +1,8 @@
---
-title: BTN-1 Bluetooth Proxy
+title: BTN-1 Bluetooth proxy
description: Tutorial for how to turn your BTN-1 into a BLE proxy!
---
-# BTN-1 Bluetooth Proxy
+# BTN-1 Bluetooth proxy
--8<-- "_snippets/bluetooth-proxy/intro.md"
diff --git a/docs/products/btn1/addons/btn1-addon.md b/docs/products/btn1/addons/btn1-addon.md
index 253f6cb3fe..db0c1a41c5 100755
--- a/docs/products/btn1/addons/btn1-addon.md
+++ b/docs/products/btn1/addons/btn1-addon.md
@@ -1,11 +1,13 @@
---
-title: BTN-1 attaching keys
-description: BTN-1 attaching keys to the BTN-1
+title: Attaching switches and keycaps to your BTN-1
+description: Attach switches and keycaps to your BTN-1, or swap in your own Cherry MX switches.
---
-# BTN-1 Attaching Switches and Keys
+# Attaching switches and keycaps to your BTN-1
-!!! tip "Protip: You can use your own mx cherry red, brown, blue etc switches!"
+Your Apollo BTN-1 uses mechanical keyboard switches with keycaps on top. The step-by-step instructions for installing both live in the Physical setup section of the BTN-1 getting started guide.
- We sell mx cherry brown switches because they are mostly silent, however, some people prefer a very "clicky" switch. You are able to buy off the shelf mechanical keyboard switches and place them on your BTN-1!
+[Install switches and keycaps](../setup/getting-started.md#physical-setup){ .md-button .md-button--primary }
-
\ No newline at end of file
+!!! tip "Use your own Cherry MX switches"
+
+ We sell Cherry MX Brown switches because they're mostly silent, but some people prefer a very "clicky" switch. You can buy off-the-shelf mechanical keyboard switches (Cherry MX Red, Brown, Blue, and others) and place them on your BTN-1.
diff --git a/docs/products/btn1/examples/blueprint.md b/docs/products/btn1/examples/blueprint.md
index 2292ec14d4..181abdb2a5 100755
--- a/docs/products/btn1/examples/blueprint.md
+++ b/docs/products/btn1/examples/blueprint.md
@@ -1,12 +1,14 @@
---
-title: BTN-1 4 Event Blueprint
+title: BTN-1 4 event blueprint
description: >-
Example of how to use the BTN-1 Events with the BTN-1 4 Event Blueprint in
Home Assistant!
---
-# Blueprint Setup
+# Blueprint setup
-## Automatic Import
+## Automatic import
+
+You'll import the blueprint with the button below, then choose an action for each button event.
1\. Click the Import Blueprint button below and then click **Open link**.
@@ -26,11 +28,13 @@ description: >-
!!! success "You can do this for all four buttons all in one blueprint!"
- This blueprint is packed with features - you can do a Single Click, a Double Click, Three Clicks, or a Hold on each of the four buttons. Just click Add action and set them all up!
+ This blueprint is packed with features: you can do a Single Click, a Double Click, Three Clicks, or a Hold on each of the four buttons. Click Add action and set them all up!
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
+
+You can also import the blueprint by pasting its address into Home Assistant yourself.
1\. Go to **Settings → Automations & scenes**, click **Blueprints** at the top, then click **Import blueprint**.
@@ -54,6 +58,6 @@ https://raw.githubusercontent.com/ApolloAutomation/Blueprints/refs/heads/main/BT
!!! success "You can do this for all four buttons all in one blueprint!"
- This blueprint is packed with features - you can do a Single Click, a Double Click, Three Clicks, or a Hold on each of the four buttons. Just click Add action and set them all up!
+ This blueprint is packed with features: you can do a Single Click, a Double Click, Three Clicks, or a Hold on each of the four buttons. Click Add action and set them all up!
4\. 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.
\ No newline at end of file
diff --git a/docs/products/btn1/examples/example-automation.md b/docs/products/btn1/examples/example-automation.md
index b74c3b26c4..162e313c6c 100755
--- a/docs/products/btn1/examples/example-automation.md
+++ b/docs/products/btn1/examples/example-automation.md
@@ -1,9 +1,11 @@
---
-title: BTN-1 Example automation
+title: BTN-1 example automation
description: Example of how to use the BTN-1 Events to create an automation in Home Assistant!
---
# Examples
+Here you'll build an automation that toggles a light when you single-click the first button.
+
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**.
@@ -18,4 +20,4 @@ description: Example of how to use the BTN-1 Events to create an automation in H
!!! tip "This is a very simple example automation."
- This example will work, however, it will require the attribute such as "Single Click" to change to Double Click or Long Press before it will toggle the light on a Single Click. You can get around this with advanced jinja templating - ChatGPT or Claude is great at helping with this!
\ No newline at end of file
+ This example will work, however, it will require the attribute such as "Single Click" to change to Double Click or Long Press before it will toggle the light on a Single Click. You can get around this with advanced jinja templating. ChatGPT or Claude is great at helping with this!
\ No newline at end of file
diff --git a/docs/products/btn1/faq.md b/docs/products/btn1/faq.md
index 64c656ccb8..ed7949c74f 100755
--- a/docs/products/btn1/faq.md
+++ b/docs/products/btn1/faq.md
@@ -8,11 +8,11 @@ description: Frequently asked questions about the BTN-1 Macro Deck
2\. **How long will the BTN-1 last on battery if it's not sleeping?**
-* It's expected to last 18 hours on a single charge if you need to take it on the go - great for all ESP-NOW projects!
+* It's expected to last 18 hours on a single charge if you need to take it on the go. Great for all ESP-NOW projects!
3\. **Why won't my BTN-1 multi presses work? Single press works fine!**
-* The device is most likely sleeping - when sleeping, no multi clicks are supported. Only a physical button single press because that wakes the device up.
+* The device is most likely sleeping. When sleeping, no multi clicks are supported. Only a physical button single press because that wakes the device up.
4\. **How do I connect the BTN-1 to Home Assistant?**
@@ -20,7 +20,7 @@ description: Frequently asked questions about the BTN-1 Macro Deck
5\. **Does the BTN-1 support Zigbee firmware?**
-* The BTN-1 uses an 8MB C6 mini MCU so it technically does support zigbee - we might have official firmware for this in the future!
+* The BTN-1 uses an 8MB C6 mini MCU so it technically does support zigbee. We might have official firmware for this in the future!
6\. **What kind of things can I do with the BTN-1?**
diff --git a/docs/products/btn1/setup/general-tips.md b/docs/products/btn1/setup/general-tips.md
index 71f9dac1f9..2e0b5f4e33 100755
--- a/docs/products/btn1/setup/general-tips.md
+++ b/docs/products/btn1/setup/general-tips.md
@@ -1,12 +1,12 @@
---
-title: BTN-1 General Tips
+title: BTN-1 general tips
description: BTN-1 General Tips
---
-# 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!
+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 setting the device on your desk!
@@ -14,17 +14,17 @@ Your BTN-1 comes with two sets of 4 sticky pads or feet to stick on the bottom o
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 07947a9514..9f131e3af2 100755
--- a/docs/products/btn1/setup/getting-started.md
+++ b/docs/products/btn1/setup/getting-started.md
@@ -1,32 +1,32 @@
---
-title: BTN-1 Getting Started Guide
+title: BTN-1 getting started guide
description: Step by step guide to getting started with your BTN-1!
---
-# BTN-1 Getting Started
+# BTN-1 getting started
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:
@@ -34,11 +34,11 @@ To connect through the sensor's onboard hotspot follow the below:
!!! 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!
+ 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. 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 Wi-Fi settings and connect to "Apollo BTN-1 Hotspot".
+2\. On your phone or PC, open the Wi-Fi settings and connect to "Apollo BTN1 Hotspot".
@@ -58,6 +58,8 @@ To connect through the sensor's onboard hotspot follow the below:
## Connecting with Improv via BLE
+With Improv via BLE, you add your device to your Wi-Fi and to the ESPHome integration right from Home Assistant.
+
!!! 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 set up your Apollo device. If you have already followed the "Connecting through Hotspot" please skip this section.
@@ -76,13 +78,13 @@ 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..."
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 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.
@@ -108,12 +110,12 @@ 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**.
-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 navigate to it by going to settings -> ESPHome integration -> click on the name of your new device!
-[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
+[Click here to set up a blueprint and 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/setup/sensor-definitions.md b/docs/products/btn1/setup/sensor-definitions.md
index 9a60c3f693..5e5af1a703 100755
--- a/docs/products/btn1/setup/sensor-definitions.md
+++ b/docs/products/btn1/setup/sensor-definitions.md
@@ -1,14 +1,14 @@
---
-title: BTN-1 Sensor Definitions
+title: BTN-1 sensor definitions
description: These are all of the entities exposed by the BTN-1 to automate on!
---
-# Sensor Definitions
+# Sensor definitions
Once added to Home Assistant you can configure different settings for your BTN-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them.
!!! note "How often readings update"
- The BTN-1 is a battery-powered device that deep-sleeps by default. The **Default Update** column is how often each entity refreshes while the BTN-1 is awake. With **Prevent Sleep** off, the BTN-1 wakes for about 90 seconds (on a button press or after the **Sleep Duration**), reports its values, then deep-sleeps again. While asleep it does not respond to Home Assistant. Turn **Prevent Sleep** on to keep it awake and reporting continuously, which is required for OTA updates.
+ The BTN-1 is a battery-powered device that can deep-sleep to save battery. **Prevent Sleep** is on out of the box, so it stays awake and reports continuously (required for OTA updates). The **Default Update** column is how often each entity refreshes while the BTN-1 is awake. Turn **Prevent Sleep** off and the BTN-1 wakes for about 90 seconds (on a button press or after the **Sleep Duration**), reports its values, then deep-sleeps again. While asleep it does not respond to Home Assistant.
=== "Controls"
diff --git a/docs/products/btn1/troubleshooting/btn1-boot-mode.md b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
index 5c55f22aac..b44210fb1d 100755
--- a/docs/products/btn1/troubleshooting/btn1-boot-mode.md
+++ b/docs/products/btn1/troubleshooting/btn1-boot-mode.md
@@ -1,14 +1,16 @@
---
-title: Putting The BTN-1 In Boot Mode
+title: Putting the BTN-1 in boot mode
description: Step by step guide for putting The BTN-1 In Boot Mode.
---
-# Putting The BTN-1 In Boot Mode
+# Putting the BTN-1 in boot mode
!!! info "This will cover how to put the BTN-1 into 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
+
+This method puts your device into boot mode using only the boot button.
!!! success "If you have the battery model skip to Method 2!"
@@ -24,7 +26,9 @@ 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
+
+This method uses the boot and reset buttons, and it's the one to use if your device has a battery.
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-reflash.md b/docs/products/btn1/troubleshooting/btn1-reflash.md
index e916661a4d..e2694e4e76 100755
--- a/docs/products/btn1/troubleshooting/btn1-reflash.md
+++ b/docs/products/btn1/troubleshooting/btn1-reflash.md
@@ -1,8 +1,8 @@
---
-title: Reflashing The BTN-1.
+title: Reflashing the BTN-1.
description: Step by step guide for reflashing The BTN-1.
---
-# Reflashing The BTN-1
+# Reflashing the BTN-1
!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below."
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 1deb6465c7..3adf4d03b2 100755
--- a/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
+++ b/docs/products/btn1/troubleshooting/btn1-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials
+title: Reset Wi-Fi credentials
description: Step by step guide for resetting the Wi-Fi Credentials on your BTN-1.
---
-# Reset Wi-Fi Credentials on your BTN-1
+# Reset Wi-Fi credentials on your BTN-1
+
+Resetting the Wi-Fi credentials makes your device broadcast its hotspot again so you can enter new Wi-Fi details.
1\. Plug the BTN-1 into power.
@@ -14,4 +16,4 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your BTN-
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
-4\. Connect to the hotspot titled "Apollo BTN-1 Hotspot" and enter your new Wi-Fi details!
\ No newline at end of file
+4\. Connect to the hotspot titled "Apollo BTN1 Hotspot" and enter your new Wi-Fi details!
\ No newline at end of file
diff --git a/docs/products/btn1/troubleshooting/btn1-teardown.md b/docs/products/btn1/troubleshooting/btn1-teardown.md
index 6748548f43..c9ed28e263 100755
--- a/docs/products/btn1/troubleshooting/btn1-teardown.md
+++ b/docs/products/btn1/troubleshooting/btn1-teardown.md
@@ -1,13 +1,15 @@
---
-title: BTN-1 Teardown
+title: BTN-1 teardown
description: >-
Step by step guide for tearing down your BTN-1 to replace parts, clean it,
swap cases, etc.
---
-# Teardown and Reassembly Of BTN-1
+# Teardown and reassembly of BTN-1
## Disassembly
+You'll remove the lid, lift out the green PCB, and disconnect the battery.
+
!!! warning "If you have a BTN-1 with a battery you should flip the power switch to off"
The BTN-1 ships with a lithium ion battery, however, this means it needs a master shutoff switch, which is on the left side of your BTN-1
@@ -30,6 +32,8 @@ description: >-
## Reassembly
+To put everything back together, you'll reconnect the battery, seat the PCB, and snap the lid back on.
+
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 4f56b6463a..c6b7c1fca2 100644
--- a/docs/products/cast1/additional-info/esphome-device-builder.md
+++ b/docs/products/cast1/additional-info/esphome-device-builder.md
@@ -6,7 +6,7 @@ description: Optional. Use ESPHome Device Builder to rename your CAST-1 or edit
!!! tip "Most people don't need this"
- Your CAST-1 ships ready to use. You only need the ESPHome Device Builder if you want to rename it or make manual edits to its YAML. To just add your CAST-1 to Home Assistant, follow the [Getting Started guide](https://wiki.apolloautomation.com/products/cast1/setup/getting-started/#add-to-home-assistant).
+ Your CAST-1 ships ready to use. You only need the ESPHome Device Builder if you want to rename it or make manual edits to its YAML. To add your CAST-1 to Home Assistant, follow the [Getting Started guide](https://wiki.apolloautomation.com/products/cast1/setup/getting-started/#add-to-home-assistant).
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.
@@ -78,6 +78,8 @@ Pick the platform you'll be running ESPHome Device Builder on:
**Method 2**
+ You can also install it yourself from the Home Assistant App Store.
+
1. In Home Assistant, open **Settings → Apps → App Store**.
2. Search for **ESPHome Device Builder** and click **Install**.
3. Once installed, click **Start**, then **Open Web UI**. The Device Builder will open inside your Home Assistant dashboard.
@@ -102,7 +104,7 @@ Pick the platform you'll be running ESPHome Device Builder on:
If your CAST-1 doesn't appear as a serial port later, add your user to the `dialout` group with `sudo usermod -a -G dialout $USER`, then log out and back in.
- 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 system tray for getting back to it later. Some Linux desktops, notably GNOME without a tray extension, don't show tray icons at all. The app still runs, so just use the dashboard in your browser.
+ 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 system tray for getting back to it later. Some Linux desktops, notably GNOME without a tray extension, don't show tray icons at all. The app still runs, so use the dashboard in your browser.
A short wizard runs the first time:
@@ -114,7 +116,9 @@ Pick the platform you'll be running ESPHome Device Builder on:
-## Take Control of Your CAST-1
+## Take control of your CAST-1
+
+Taking control adopts your device into the ESPHome Device Builder so you can rename it or edit its YAML.
1\. Open the ESPHome Device Builder.
diff --git a/docs/products/cast1/addons/ethernet-module.md b/docs/products/cast1/addons/ethernet-module.md
index 2ff7739a38..04995682e9 100644
--- a/docs/products/cast1/addons/ethernet-module.md
+++ b/docs/products/cast1/addons/ethernet-module.md
@@ -1,8 +1,8 @@
---
-title: Add the Ethernet Module to CAST-1
+title: Add the Ethernet module to CAST-1
description: "How to install the Ethernet add-on module on your CAST-1."
---
-# Adding the Ethernet Module
+# Adding the Ethernet module
The Ethernet add-on gives your CAST-1 a wired network connection. It's a small header board that presses onto the top of the CAST-1, so there's no case to open and nothing to solder.
diff --git a/docs/products/cast1/examples/led-strip.md b/docs/products/cast1/examples/led-strip.md
index 8ecba3d354..35d4361d57 100644
--- a/docs/products/cast1/examples/led-strip.md
+++ b/docs/products/cast1/examples/led-strip.md
@@ -1,8 +1,8 @@
---
-title: Add an LED Strip to CAST-1
+title: Add an LED strip to CAST-1
description: "Wire an addressable LED strip to your CAST-1 and control it from Home Assistant, including a Music Mode that follows playback."
---
-# Add an LED Strip
+# Add an LED strip
Your CAST-1 has three exposed pins, **5V**, **GND** and **IO1**, that can drive an addressable LED strip. Once it's wired up, the strip shows up in Home Assistant as a light with effects, and it can switch on by itself whenever music is playing.
@@ -10,7 +10,7 @@ Your CAST-1 has three exposed pins, **5V**, **GND** and **IO1**, that can drive
LED strip support arrived in firmware 26.10.13.1. If your CAST-1 is on an older version, update it from the **Firmware Update** entity on its device page. Until this release reaches the Stable channel, [switch to the Beta channel](../../general/setup/switch-to-beta-branch.md) first.
-## What You'll Need
+## What you'll need
- **An addressable RGB strip that uses a single data wire.** WS2812B is the most common. WS2812, SK6812 (RGB), WS2811, APA106 and SM16703 also work.
- Three wires to connect the strip to the CAST-1.
@@ -30,6 +30,8 @@ Every LED draws current. A WS2812B LED pulls up to about 60 mA at full white, so
## Wiring
+You'll connect the strip's power, ground and data wires to the matching pins on your device.
+
1\. Unplug your CAST-1 from power.
2\. Find the input end of the strip. Its pads are labelled **DIN** or **DI**, and the arrows printed on the strip point away from it. (1)
@@ -47,7 +49,7 @@ Every LED draws current. A WS2812B LED pulls up to about 60 mA at full white, so
4\. Plug your CAST-1 back into power.
-## Turn On the LED Strip Controls
+## Turn on the LED strip controls
The LED strip controls are hidden until you turn them on, so CAST-1s without a strip don't show extra controls.
@@ -66,7 +68,7 @@ The LED strip controls are hidden until you turn them on, so CAST-1s without a s
If the colors come out in the wrong order (for example, green when the test shows red), change **LED Strip Color Order** until they match. GRB is right for most WS2812B strips.
-## LED Strip Controls
+## LED strip controls
| Entity | What it does |
| --- | --- |
diff --git a/docs/products/cast1/examples/tts-announcements.md b/docs/products/cast1/examples/tts-announcements.md
index 403d44cebf..034e854d1f 100644
--- a/docs/products/cast1/examples/tts-announcements.md
+++ b/docs/products/cast1/examples/tts-announcements.md
@@ -1,21 +1,23 @@
---
-title: CAST-1 TTS and Announcements
+title: CAST-1 TTS and announcements
description: Send text-to-speech and announcements to your CAST-1, with music ducking automatically.
---
-# TTS and Announcements
+# TTS and announcements
Your CAST-1 can speak. Send it a text-to-speech message and it plays over whatever is already going, ducking the music down and bringing it back when it's done. Nothing stops or resumes, the two run at once.
-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.
+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 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
+
+You'll send a test announcement from Developer Tools and hear it play over your music.
1\. Open **Developer Tools** in Home Assistant (**Settings → Tools** in Home Assistant 2026.8 and newer) and go to the **Actions** tab.
@@ -37,13 +39,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:
@@ -59,7 +61,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 e48f052677..107c9d8a44 100644
--- a/docs/products/cast1/examples/wizmote-blueprint.md
+++ b/docs/products/cast1/examples/wizmote-blueprint.md
@@ -1,8 +1,8 @@
---
-title: CAST-1 WizMote Control
+title: CAST-1 WizMote control
description: Control your CAST-1 with a WizMote using the Apollo CAST-1 WizMote blueprint in Home Assistant.
---
-# WizMote Control
+# WizMote control
A WizMote gives you physical control over playback on your CAST-1. The **Apollo CAST-1 WizMote** blueprint maps each of the nine buttons to a playback action, a light toggle, or any Home Assistant action you want, all set up without leaving Home Assistant.
@@ -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,9 @@ 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
+
+You'll import the blueprint, pick your device, and choose what each WizMote button does.
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 0135aaf9ef..3a38b8bd84 100644
--- a/docs/products/cast1/setup/getting-started.md
+++ b/docs/products/cast1/setup/getting-started.md
@@ -1,12 +1,12 @@
---
-title: CAST-1 Getting Started Guide
+title: CAST-1 getting started guide
description: Step by step guide to getting started with your CAST-1!
---
-# CAST-1 Getting Started
+# CAST-1 getting started
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.
@@ -88,6 +88,8 @@ The CAST-1 streams through
-
-
+- **Built-in RGB light:** on GPIO3.
+- **3.3V pin:** supplies up to 600mA, but the microcontroller itself uses 100-200mA of that.
-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".
+!!! warning "Use one power source at a time"
-
+ You can power the DEV-1 through the USB-C port or back-feed power through the 5V and G (ground) pins, but **not** both at the same time.
+
+### GPIO pins
-**GPIO Pins Listed:**
+These are the DEV-1's I2C, UART, ADC, and onboard RGB LED pins, written as ESPHome YAML:
```yaml
#These are the i2c pins
@@ -38,7 +38,26 @@ uart:
#Onboard RGB LED: GPIO3
```
-**Example ESPHome yaml:**
+## Flash your DEV-1
+
+The DEV-1 doesn't come pre-flashed with ESPHome or WLED, so you flash it yourself. This getting started video we made walks you through it:
+
+
+
+## Example ESPHome YAML
+
+Use the example configuration below as a starting point for your DEV-1. Before you use it, give it your own API encryption key:
+
+1\. Open the ESPHome API documentation and copy the randomly generated API key from the code block, as shown in the red box below.
+
+
+
+2\. In the YAML below, find the `key:` line under `api:` and replace `use-a-randomly-generated-key-here` with the key you copied.
+
+Your configuration now uses its own encryption key. Here's the full example for the DEV-1:
```yaml
#Define Project
@@ -72,7 +91,7 @@ api:
ota:
- platform: esphome
- password: "a53d93acd493275512730c776f88722a"
+ password: !secret ota_password
wifi:
ssid: !secret wifi_ssid
@@ -139,4 +158,4 @@ text_sensor:
ip_address:
name: "${name} IP"
icon: "mdi:ip-outline"
-```
\ No newline at end of file
+```
diff --git a/docs/products/dev2/introduction.md b/docs/products/dev2/introduction.md
index 15f696c90d..881ec66bb5 100755
--- a/docs/products/dev2/introduction.md
+++ b/docs/products/dev2/introduction.md
@@ -1,29 +1,25 @@
---
-title: Apollo DEV-2 Introduction
-description: Apollo DEV-2 Introduction.
+title: Apollo DEV-2 introduction
+description: Pinout, power limits, a flashing video, and an example ESPHome YAML for the Apollo DEV-2 dev board.
---
-
+# Apollo DEV-2 introduction
-The Apollo DEV-2 is a very small dev board that we use to prototype before creating other new products. It has a built in RGB light (using GPIO3) and can push up to 600mA out of the 3.3v pin however 100-200mA of that will be used by the microcontroller itself. You are able to back-feed power via the 5v and G (ground) pins or use the USB-C port to power it, but NOT both at the same time.
+The Apollo DEV-2 is a very small dev board that we use to prototype before creating other new products. It's a great starter device for tinkerers. You can buy it on its own, or with a breadboard and dupont wires (jumper wires) if you need those too.
-!!! tip "New version has 8MB flash but originally sold with 4MB flash"
+## Pinout and power
- If you're using an older DEV-2 with 4MB flash change the flash\_size: to say 4MB instead of 8MB.
+
-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.
+- **Built-in RGB light:** on GPIO3.
+- **3.3V pin:** supplies up to 600mA, but the microcontroller itself uses 100-200mA of that.
-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:
+!!! warning "Use one power source at a time"
-
+ You can power the DEV-2 through the USB-C port or back-feed power through the 5V and G (ground) pins, but **not** both at the same time.
-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
-
-
-**GPIO Pins Listed:**
+These are the DEV-2's I2C, UART, ADC, and onboard RGB LED pins, written as ESPHome YAML:
```yaml
#These are the i2c pins
@@ -42,7 +38,32 @@ uart:
#Onboard RGB LED: GPIO3
```
-**Example ESPHome yaml:**
+## Flash your DEV-2
+
+The DEV-2 doesn't come pre-flashed with ESPHome or WLED, so you flash it yourself. We made the getting started video below on the older DEV-1 board. The information is still the same, except you use the DEV-2 YAML further down this page.
+
+
+
+## Example ESPHome YAML
+
+Use the example configuration below as a starting point for your DEV-2. Before you use it, give it your own API encryption key:
+
+1\. Open the ESPHome API documentation and copy the randomly generated API key from the code block, as shown in the red box below.
+
+
+
+2\. In the YAML below, find the `key:` line under `api:` and replace `your-api-key-here` with the key you copied.
+
+Your configuration now uses its own encryption key.
+
+!!! tip "The DEV-2 now has 8MB flash, but was originally sold with 4MB flash"
+
+ If you're using an older DEV-2 with 4MB flash, change `flash_size: 8MB` to `flash_size: 4MB` in the YAML below.
+
+Here's the full example for the DEV-2:
```yaml
#Define Project
@@ -77,7 +98,7 @@ api:
ota:
- platform: esphome
- password: "a53d93acd493275512730c776f88722a"
+ password: !secret ota_password
wifi:
ssid: !secret wifi_ssid
@@ -144,4 +165,4 @@ text_sensor:
ip_address:
name: "${name} IP"
icon: "mdi:ip-outline"
-```
\ No newline at end of file
+```
diff --git a/docs/products/general/90-degree-usb-c-addon.md b/docs/products/general/90-degree-usb-c-addon.md
index 9c44e3cdc3..7781bb0057 100755
--- a/docs/products/general/90-degree-usb-c-addon.md
+++ b/docs/products/general/90-degree-usb-c-addon.md
@@ -1,8 +1,8 @@
---
-title: 90 Degree Male USB-C Addon Tutorial
+title: 90 degree male USB-C addon tutorial
description: QR Code from the 90 Degree Male USB-C Addon for both MSR-2 and MTR-1 points here
---
-# 90 Degree USB-C Addon
+# 90 degree USB-C addon
We have the 90 Degree USB-C Addon for both the MSR-2 and the MTR-1. Choose your specific Apollo sensor below to head to that wiki article!
diff --git a/docs/products/general/articulating-stand-addon.md b/docs/products/general/articulating-stand-addon.md
index 8538759dd0..81053c22d7 100755
--- a/docs/products/general/articulating-stand-addon.md
+++ b/docs/products/general/articulating-stand-addon.md
@@ -1,11 +1,11 @@
---
-title: Articulating Stand Addon Tutorial
+title: Articulating stand addon tutorial
description: QR Code from the Articulating stand for both MSR-2 and MTR-1 points here
---
-# Articulating Stand Addon
+# Articulating stand addon
We have the Articulating Stand Addon for both the MSR-2 and the MTR-1. Choose your specific Apollo sensor below to head to that wiki article!
-[MSR-2 Click Here!](https://wiki.apolloautomation.com/products/msr2/addons/adding-90-degree-usb-c-to-msr-2/){ .md-button .md-button--primary }
+[MSR-2 Click Here!](/products/msr2/addons/adding-articulating-stand-to-msr-2.md){ .md-button .md-button--primary }
-[MTR-1 Click Here!](https://wiki.apolloautomation.com/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1/){ .md-button .md-button--primary }
\ No newline at end of file
+[MTR-1 Click Here!](/products/mtr1/addons/adding-articulating-stand-to-mtr-1.md){ .md-button .md-button--primary }
\ No newline at end of file
diff --git a/docs/products/general/battery-sensors/awake-ha-helper.md b/docs/products/general/battery-sensors/awake-ha-helper.md
index e9e7fbd844..7f2923a2af 100755
--- a/docs/products/general/battery-sensors/awake-ha-helper.md
+++ b/docs/products/general/battery-sensors/awake-ha-helper.md
@@ -1,10 +1,20 @@
---
-title: Apollo Battery Devices - Awake HA Helper
-description: How to keep your sensor awake using the Home Assistant Helper.
+title: Apollo battery devices - Awake HA helper
+description: Create a Home Assistant toggle that keeps your Apollo battery devices awake for updates, plus an automation that turns it off after one hour.
---
-# How to keep your sensor awake using the Home Assistant Helper
+# Keep your sensor awake with a 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 use the button below to go straight there.
+When an `apollo_ota_mode` toggle in Home Assistant is on, your Apollo battery devices stay awake so you can update them. In this guide you create that toggle, then add an automation that turns it off again after one hour.
+
+!!! warning "This keeps every Apollo device awake"
+
+ While `apollo_ota_mode` is on, none of your Apollo devices go back to sleep. Finish the second part of this guide to create an automation that turns the helper off after it has been on for one hour.
+
+## Create the OTA mode toggle
+
+Start by creating the toggle helper and switching it on.
+
+1\. Go to **Settings → Devices & services** and select the **Helpers** tab at the top. Or use the button below to go straight there.
[](https://my.home-assistant.io/redirect/helpers/)
@@ -12,52 +22,54 @@ description: How to keep your sensor awake using the Home Assistant Helper.
-2\. Select Create Helper in the bottom right.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. |
PM Type | 24-Hour Limit (µg/m³) | Annual Average (µg/m³) |
|---|---|---|
PM2.5 | ≤ 15 | ≤ 5 |
PM10 | ≤ 45 | ≤ 15 |
PM2.5 (µg/m³) | AQI Category | Health Implications |
|---|---|---|
0.0 to 12.0 | Good | Air quality is satisfactory. |
12.1 to 35.4 | Moderate | Acceptable; some risk for sensitive individuals. |
35.5 to 55.4 | Unhealthy for Sensitive Groups | Increased risk for those with heart/lung issues, children, and older adults. |
55.5 to 150.4 | Unhealthy | Everyone may begin to experience health effects. |
150.5 to 250.4 | Very Unhealthy | Health alert: serious effects possible. |
>250.5 | Hazardous | Emergency conditions for all populations. |
PM2.5 (µg/m³) | AQI Category | Health Implications |
|---|---|---|
0.0 – 12.0 | Good | Air quality is satisfactory. |
12.1 – 35.4 | Moderate | Acceptable; some risk for sensitive individuals. |
35.5 – 55.4 | Unhealthy for Sensitive Groups | Increased risk for those with heart/lung issues, children, and older adults. |
55.5 – 150.4 | Unhealthy | Everyone may begin to experience health effects. |
150.5 – 250.4 | Very Unhealthy | Health alert: serious effects possible. |
>250.5 | Hazardous | Emergency conditions for all populations. |
PM Size | Safe Range | Health Concern |
|---|---|---|
PM1 | No official limit (keep as low as possible) | Ultrafine particles (most dangerous) |
PM2.5 | ≤ 12 µg/m³ (EPA), ≤ 5 µg/m³ (WHO annual) | Penetrates lungs and bloodstream |
PM4 | Industrial contexts only (no public health limits) | Less regulated |
PM10 | ≤ 45 µg/m³ (WHO 24-hour) | Triggers upper respiratory irritation |
PM Size | Safe Range | Health Concern |
|---|---|---|
PM1 | No official limit — keep as low as possible | Ultrafine particles — most dangerous |
PM2.5 | ≤ 12 µg/m³ (EPA), ≤ 5 µg/m³ (WHO annual) | Penetrates lungs and bloodstream |
PM4 | Industrial contexts only — no public health limits | Less regulated |
PM10 | ≤ 45 µg/m³ (WHO 24-hour) | Triggers upper respiratory irritation |
](https://my.home-assistant.io/redirect/supervisor_app/?app=d5369777_music_assistant&repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon)
@@ -100,7 +102,9 @@ The CAST-1 streams through <a href=){kind=link}
+2\. Select **Create helper** in the bottom right.  -
3\. Scroll down to the bottom and select Toggle. +3\. Scroll to the bottom of the list and select **Toggle**.  -
4\. For name use "apollo\_ota\_mode" and choose desired icon such as "mdi:sleep-off" then click Create. +4\. Name the toggle `apollo_ota_mode`, choose an icon such as `mdi:sleep-off`, and click **Create**.  -5\. Search "apollo\_ota\_mode" and click on the helper shown. +5\. Search the helpers list for `apollo_ota_mode` and click the helper that appears.  -
6\. Toggle the OTA mode on as shown below. +6\. Switch the toggle on.  -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. +OTA mode is now on. The next time your Apollo device reboots or wakes up on its wake timer, it stays awake instead of going back to sleep. -!!! null "Warning: This will keep ALL of your Apollo devices from sleeping." +## Turn OTA mode off after one hour - Please keep reading to create an automation to turn this helper off after one hour of it being on. +Next, create an automation that switches `apollo_ota_mode` off once it has been on for one hour, so you never leave your devices awake by accident. -8\. Create a new automation (**Settings → Automations & scenes → Create automation**) and select "add trigger" then select entity then select state. +1\. Go to **Settings → Automations & scenes** and click **Create automation**. [](https://my.home-assistant.io/redirect/automations/) +2\. Click **Add trigger**, then select **Entity**. +  +3\. 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). +4\. In the **Entity** box, enter `apollo_ota_mode`. Set **To** to **On**, and enter 1 in the hours box under **For**. This trigger fires once `apollo_ota_mode` has been on for one hour.  -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". +5\. Scroll down to **Then do**, click **Add action**, search for `input boolean`, and choose **Input boolean: Turn off**.  -11\. Now select choose entity and select apollo\_ota\_mode as shown below. +6\. Click **Choose entity** and select `apollo_ota_mode`.  -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! - - \ No newline at end of file +You're done. Turn `apollo_ota_mode` on whenever you want to update your devices, and the automation turns it off for you after one hour. diff --git a/docs/products/general/battery-sensors/prevent-sleep.md b/docs/products/general/battery-sensors/prevent-sleep.md index aaa1308f55..6645f1b806 100755 --- a/docs/products/general/battery-sensors/prevent-sleep.md +++ b/docs/products/general/battery-sensors/prevent-sleep.md @@ -1,5 +1,5 @@ --- -title: Apollo Battery Devices - Prevent Sleep +title: Apollo battery devices - Prevent Sleep description: How to disable Prevent Sleep and allow your Apollo device to sleep! --- # Prevent Sleep @@ -10,6 +10,8 @@ description: How to disable Prevent Sleep and allow your Apollo device to sleep! 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. +You'll set how long your sensor sleeps, then turn off **Prevent Sleep** so it can start sleeping. + 1\. Head to the ESPHome Integrations page and click on the name of your Apollo device.  @@ -18,13 +20,13 @@ description: How to disable Prevent Sleep and allow your Apollo device to sleep!  -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. +3\. Type in how long you want your sensor to sleep in the **Sleep Duration** box. Check the unit next to the box: it is minutes on the AIR-1 (default 5), PLT-1 (default 5), and TEMP-1 (default 8), and hours on the BTN-1 (default 24), PLT-1B (default 12), and TEMP-1B (default 12). We recommend leaving the default values. !!! warning "Read this before turning off Prevent Sleep!" When "Prevent Sleep" is toggled off, your sensor will immediately begin sleeping. Please make sure you are ready to make this sensor sleep before toggling off prevent sleep. -4\. When you are ready, toggle off **Prevent Sleep** and your sensor will go to sleep. It will wake up every 5 minutes, or on the interval you set in step 3. If you need to keep your sensor awake, head to our OTA Awake helper tutorial! +4\. When you are ready, toggle off **Prevent Sleep** and your sensor will go to sleep. It will wake up on the Sleep Duration interval from step 3. If you need to keep your sensor awake, head to our OTA Awake helper tutorial! 5\. You can wake your sensor by following this guide or you can power cycle your device. If there is a battery in it, the battery will need to be removed or the reset button pressed. diff --git a/docs/products/general/battery-sensors/sensor-connection-check.md b/docs/products/general/battery-sensors/sensor-connection-check.md index 4ac794027e..650159808c 100755 --- a/docs/products/general/battery-sensors/sensor-connection-check.md +++ b/docs/products/general/battery-sensors/sensor-connection-check.md @@ -1,8 +1,8 @@ --- -title: Apollo Battery Devices - Sensor Connection Check +title: Apollo battery devices - Sensor connection check description: How to check if your device is connected to Wi-Fi, Home Assistant, or nothing. --- -# Sensor Connection Check +# Sensor connection check 1\. Press the reset button and let go to restart the device
TEMP-1B reset button 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 214ef1de38..cc7c8f1088 100755 --- a/docs/products/general/battery-sensors/wake-up-battery-sensor.md +++ b/docs/products/general/battery-sensors/wake-up-battery-sensor.md @@ -1,16 +1,16 @@ --- -title: Apollo Battery Devices - wake up battery device. +title: Apollo battery devices - Wake up battery device. description: How to wake up your Apollo device which is currently sleeping. --- -There are two ways to wake a sleeping Apollo battery sensor: press the reset button, or hold the boot button. Select your device below for the button locations. +To wake a sleeping Apollo battery sensor, press the reset button. A BTN-1 also wakes when you press Button 1, 2, 3, or 4, and an H-1 or H-2 wakes when you press a gold song button. The boot button can't wake a sleeping device. Select your device below for the button locations. === "TEMP-1B" - **Method 1: Reset button.** Press and release the reset button to restart the device. + **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. + **Boot button.** The boot button can't wake a sleeping TEMP-1B. Once the TEMP-1B is awake, you can use the boot button to keep it awake, as described below.  @@ -18,11 +18,11 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but === "PLT-1B" - **Method 1: Reset button.** Press and release the reset button to restart the device. + **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. + **Boot button.** The boot button can't wake a sleeping PLT-1B. Once the PLT-1B is awake, you can use the boot button to keep it awake, as described below.  @@ -32,7 +32,9 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 1: Reset button.** Press and release the reset (left) button to restart the device. - **Method 2: Boot button.** Quickly press and hold the boot (right) button for 4-5 seconds. + **Method 2: Buttons 1 to 4.** Press and release Button 1, 2, 3, or 4. Home Assistant receives that press as a click of that button once the BTN-1 reconnects, so any automation you've tied to a click of that button runs. Use the reset button when you only want to wake it. + + The boot (right) button can't wake a sleeping BTN-1. Once the BTN-1 is awake, you can use the boot button to keep it awake, as described below.  @@ -46,9 +48,13 @@ 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. + **Method 2: Gold button.** Press and release the gold button (SW1). + + The boot button can't wake a sleeping H-1. Once the H-1 is awake, you can use the boot button to keep it awake, as described below. + +  -  + The unlabeled circled button at the lower left is the gold button (SW1), which plays the built-in songs. Button locations: [H-1 boot mode](https://wiki.apolloautomation.com/products/h1/boot-mode/). @@ -60,7 +66,9 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but **Method 1: Reset button.** Press and release the reset (left) button to restart the device. - **Method 2: Boot button.** Quickly press and hold the boot (right) button for 4-5 seconds. + **Method 2: Song buttons.** Press and release any of the four gold song buttons on the back of the H-2. The H-2 wakes and plays that button's song. + + The boot (right) button can't wake a sleeping H-2. Once the H-2 is awake, you can use the boot button to keep it awake, as described below.  @@ -68,6 +76,12 @@ There are two ways to wake a sleeping Apollo battery sensor: press the reset but Your device is now awake, but it will not stay awake on its own yet. Click the **Prevent Sleep** button on your device page in Home Assistant, or directly on the device web server such as plt-1.local or its IP address. +You can also turn on Prevent Sleep from the device itself. Once it's awake, press and hold the boot button for 4-5 seconds, then let go. + +!!! warning "Watch how you use the boot button" + + Press the boot button only after the device has restarted. Holding it while you press reset puts the device in boot mode for flashing firmware instead. Holding it for 10 seconds or more resets the device to factory settings and erases its Wi-Fi. + !!! success "Head to the awake helper wiki article" If you need to keep your sensor awake for extended periods of time we suggest using our [OTA awake helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/). diff --git a/docs/products/general/calibrating-and-updating/calibrate-plt1.md b/docs/products/general/calibrating-and-updating/calibrate-plt1.md index 95cc828fc8..c68f2070cd 100644 --- a/docs/products/general/calibrating-and-updating/calibrate-plt1.md +++ b/docs/products/general/calibrating-and-updating/calibrate-plt1.md @@ -1,5 +1,5 @@ --- -title: Calibrating PLT Soil Moisture +title: Calibrating PLT soil moisture description: Step by step guide for calibrating the PLT soil moisture sensor. --- This guide will take you through calibrating your PLT-1's moisture sensor. The sensors come with a default calibration, so this method is only necessary if you want to make your own adjustments. @@ -40,12 +40,12 @@ This guide will take you through calibrating your PLT-1's moisture sensor. The s 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. +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 a6e1233ad8..43625f3dc3 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration-quick.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration-quick.md @@ -1,8 +1,8 @@ --- -title: CO2 Calibration Tutorial (quick) +title: CO2 calibration tutorial (quick) description: Step by step guide for re-calibrating your SCD40 CO2 sensor --- -# CO2 Calibration - The Quick method - Desktop Only not mobile +# CO2 calibration - The quick method - Desktop only not mobile !!! info "Your sensor calibrates itself" @@ -10,7 +10,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor !!! tip "Calibrate manually every 1 to 2 years when auto calibration is off" - 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. + 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. This article will guide you through a simple calibration of your CO2 sensor for any Apollo Automation device! @@ -18,7 +18,7 @@ This article will guide you through a simple calibration of your CO2  -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. +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. !!! tip "Hint" diff --git a/docs/products/general/calibrating-and-updating/co2-calibration.md b/docs/products/general/calibrating-and-updating/co2-calibration.md index 46e8beedc7..4dcea5b8c9 100755 --- a/docs/products/general/calibrating-and-updating/co2-calibration.md +++ b/docs/products/general/calibrating-and-updating/co2-calibration.md @@ -1,8 +1,8 @@ --- -title: CO2 Calibration Tutorial +title: CO2 calibration tutorial description: Step by step guide for re-calibrating your SCD40 CO2 sensor --- -# CO2 Calibration +# CO2 calibration !!! info "Your sensor calibrates itself" @@ -12,7 +12,9 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor !!! tip "Calibrate manually every 1 to 2 years when auto calibration is off" - 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. + 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. + +To calibrate manually, you'll take your sensor outside into fresh air and reset its baseline from Home Assistant.  diff --git a/docs/products/general/calibrating-and-updating/mmwave-videos.md b/docs/products/general/calibrating-and-updating/mmwave-videos.md index b33bc215db..2364b68594 100755 --- a/docs/products/general/calibrating-and-updating/mmwave-videos.md +++ b/docs/products/general/calibrating-and-updating/mmwave-videos.md @@ -1,5 +1,5 @@ --- -title: mmWave Tuning Videos +title: mmWave tuning videos description: Two short videos and a quick summary on how to best tune the LD2410B in the MSR-2! --- !!! tip "Radar Engineering Mode (REM)" @@ -20,6 +20,8 @@ How to tune the mmWave sensor using radar engineering mode. +To tune your sensor, you'll turn on Radar Engineering Mode and adjust the gate thresholds. + 1\. Go to **Settings → Devices & services → ESPHome** and click the name of your device. [](https://my.home-assistant.io/redirect/integration/?domain=esphome) @@ -52,6 +54,8 @@ How to tune the mmWave sensor using radar engineering mode. !!! example "Open-Concept kitchen and living room with MSR-2 to activate the under-cabinet lights only when person in the kitchen" + Here's how you tune the gates so the kitchen lights only come on when you're in the kitchen. + 1. Stand in the desired trigger locations. 2. Observe the gate energy. 3. Adjust the gate threshold slider to the right, increasing the energy required to trigger the mmWave sensor. This ensures that your kitchen lights only come on when you're actually in the kitchen, not just walking by in the living room. Also, you can lower the gate threshold in the kitchen by moving the slider to the left. This makes the mmWave sensor more sensitive, even when standing still. This way, you avoid having the lights go off while reading a recipe or doing the dishes. 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 6bd8da8fef..86869791ac 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 @@ -6,6 +6,6 @@ description: "Tune the MSR-1 mmWave radar from Home Assistant using Radar Engine !!! tip "Prefer a guided dashboard?" - The Apollo mmWave integration gives your Apollo MSR-1, MSR-2, or R PRO-1 a tuning dashboard with a Gate Energy chart and a **Calibrate with empty room** button that sets the gate thresholds for you. The [Apollo mmWave dashboard guide](/products/general/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below. + The Apollo mmWave integration gives your Apollo MSR-1 a tuning dashboard with a Gate Energy chart and a **Calibrate with empty room** button that sets the gate thresholds for you. It also works on the MSR-2, and on an R PRO-1 with the optional LD2412 radar addon. The [Apollo mmWave dashboard guide](/products/general/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below, which are written for the MSR-1. --8<-- "products/msr1/setup/zones-ha.md:11:" diff --git a/docs/products/general/calibrating-and-updating/updating-firmware.md b/docs/products/general/calibrating-and-updating/updating-firmware.md index fec19c2c89..e434045f12 100755 --- a/docs/products/general/calibrating-and-updating/updating-firmware.md +++ b/docs/products/general/calibrating-and-updating/updating-firmware.md @@ -1,8 +1,8 @@ --- -title: Updating Firmware Guide +title: Updating firmware guide description: Step by step guide on how to update the firmware on your Apollo device! --- -# Updating Firmware +# Updating firmware ## From Home Assistant diff --git a/docs/products/general/choosing-an-mmwave-sensor.md b/docs/products/general/choosing-an-mmwave-sensor.md index f41ff5b3c5..4476c5cd41 100644 --- a/docs/products/general/choosing-an-mmwave-sensor.md +++ b/docs/products/general/choosing-an-mmwave-sensor.md @@ -1,8 +1,8 @@ --- -title: Choosing an mmWave Sensor +title: Choosing an mmWave sensor description: Compare the Apollo MSR-2, MTR-1, and R PRO-1 mmWave presence sensors and pick the right one for your space. --- -# Choosing an mmWave Sensor +# Choosing an mmWave sensor Apollo mmWave sensors detect the **moving** and **still** energy of people and animals, which makes them excellent for presence detection in a room. They are not meant to detect vehicles, so for a car an ultrasonic sensor is a better fit. This guide compares our three current mmWave sensors so you can pick the right one for your space. @@ -44,7 +44,7 @@ Apollo mmWave sensors detect the **moving** and **still** energy of people and a | **PoE / Ethernet** | :material-minus: | :material-minus: | :material-check: | | **Horizontal FoV** | 120° | 120° | 120°
150° with LD2412 | | **Vertical FoV** | 70° | 70° | 70° | -| **Power** | USB-C | USB-C | PoE, Ethernet, Wi-Fi, USB-C | +| **Power** | USB-C | USB-C | PoE (802.3af) or USB-C | | **mmWave module** | LD2410B | LD2450 | LD2450, optional LD2412 | ## Field of view diff --git a/docs/products/general/co2-installation.md b/docs/products/general/co2-installation.md index 7ba330c4cf..a6eacbb9c4 100755 --- a/docs/products/general/co2-installation.md +++ b/docs/products/general/co2-installation.md @@ -1,8 +1,8 @@ --- -title: CO2 Installation Page with Redirects to all products. +title: CO2 installation page with redirects to all products. description: QR Code for the CO2 addon points here --- -# CO2 Installation +# CO2 installation We have the CO2 Addon for the MSR-2, MTR-1, AIR-1, and new R PRO-1. Choose your specific Apollo sensor below to head to that wiki article! diff --git a/docs/products/general/comparisons.md b/docs/products/general/comparisons.md index aa11aecad0..2d13fdf65b 100755 --- a/docs/products/general/comparisons.md +++ b/docs/products/general/comparisons.md @@ -1,7 +1,209 @@ --- -title: mmWave Presence Sensor Comparison Chart -description: mmWave Presence Sensor Comparison Chart. +title: mmWave presence sensor comparison chart +description: Compare the Apollo MSR-2 and MTR-1 with other mmWave presence sensors on price, radar chip, detection range, zones, target tracking, and extra sensors. --- -
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) | +$37.99 ($57.99 with CO2) | +$64.00 | +$39.00 | +$39.99 ($59.99 with CO2) | +$25.99 | +$29.99 | +$49.99 | +$82.99 | +
| mmWave | +LD2410B | +SEN0609 (older units: SEN0395) | +LD2450 | +LD2450 | +LD2410C | +LD2450 | +BGT60TR13C | +IWR6843 | +
| Detection Distance (m) | +6 | +25 (PIR: 12) | +5 to 6 | +6 | +5 | +6 | +5 | +8 (wall-mounted) | +
| Detection Zones | +3 distance zones and 9 gates (0.75 m each, adjustable) | ++ | 4 zones + 2 exclusion | +3 zones (detection or filter) | +9 distance gates (no zones) | +3 zones + 1 exclusion | +Up to 10 regions | +Up to 30 zones | +
| Target Tracking | +1 | +1 | +Up to 3 | +Up to 3 | ++ | Up to 3 | +x | +Up to 5 (best with 3 or fewer) | +
| PIR | ++ | Panasonic EKMC1603111/3 | ++ | + | + | x | +x | +x | +
| ESP | +ESP32-C3-MINI | +ESP32 | +ESP32 | +ESP32-C3-MINI | +ESP32-S2 | +ESP32-C3 | +None (Zigbee) | +ESP32-WROOM-32U | +
| Country | +USA | +UK | +UK | +USA | +China | +China | +China | +China | +
| CO2 | +SCD40 (optional, +$20) | +SCD40 add-on (optional, $30) | +SCD40 add-on (optional, $30) | +SCD40 (optional, +$20) | ++ | + | + | + |
| UV/LUX | +LTR390 | +BH1750 (lux only) | +BH1750 (lux only) | +LTR390 | +LD2410C light level (no UV) | +BH1750 (lux only) | ++ | Light sensor (lux only) | +
| Buzzer | +Piezo | ++ | + | Piezo | ++ | + | + | + |
| RGB LED | +WS2812 | ++ | + | WS2812 | ++ | + | + | + |
| GPIO Header | +$4.99 (optional add-on) | +Onboard (GPIO18, 19, 21, 22, 5V, GND) | +Onboard | +$4.99 (optional add-on) | ++ | + | + | + |
| Size (mm) | +40x24x15 | +65x49x50 | +69x50x50 | +49x32x15 | +36.7x30x13.8 | +56.9x56.9x14.3 | ++ | 64x64x29.5 | +
| Stand | +$4.99 (optional) | +Not included (case sold separately) | +Not included (case included) | +$4.99 (optional) | +Not included (adhesive pad) | +$2.85 (optional, magnetic) | ++ | Included (magnetic, adjustable) | +
| Product Link | +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 | +
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 | |||||||
**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 +Your Apollo device can now connect to your Wi-Fi network with a hidden SSID. + +!!! warning "Know the tradeoff before you rely on it" + + With `fast_connect` on, your device connects to Wi-Fi directly without doing a full scan first. That's what makes hidden networks work, and it can significantly improve connection times. The downside is that it connects to the first network the ESP sees, even if that network is very far away and better ones are available. The option defaults to `off`. Read more about the [downsides of fast_connect](https://esphome.io/components/wifi.html "downsides of fast_connect: true") in the ESPHome docs. diff --git a/docs/products/general/setup/adjusting-wifi-power.md b/docs/products/general/setup/adjusting-wifi-power.md index 9e0fc930fe..a3658c4f46 100755 --- a/docs/products/general/setup/adjusting-wifi-power.md +++ b/docs/products/general/setup/adjusting-wifi-power.md @@ -1,8 +1,8 @@ --- -title: Adjusting Wi-Fi Power Save +title: Adjusting Wi-Fi power save description: Tutorial for how to adjust Wi-Fi Power Save. --- -# Adjusting Wi-Fi Power Save +# Adjusting Wi-Fi power save The ESP chips produce a significant amount of energy (heat) constantly using Wi-Fi. This guide explains how to adjust the Wi-Fi power save mode to high to combat this. @@ -28,7 +28,7 @@ The ESP chips produce a significant amount of energy (heat) constantly using Wi- power_save_mode: HIGH ``` -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. +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.  diff --git a/docs/products/general/setup/apollo-mmwave-dashboard.md b/docs/products/general/setup/apollo-mmwave-dashboard.md index 738e6c875b..5ab0930bf6 100644 --- a/docs/products/general/setup/apollo-mmwave-dashboard.md +++ b/docs/products/general/setup/apollo-mmwave-dashboard.md @@ -48,6 +48,8 @@ A threshold of 100 means that gate never triggers, so some people set a gate to ### Run a calibration +You start the calibration from the card, then stay out of the room for about a minute and a half while it listens. + 1. Press **Calibrate with empty room** on the **Auto-calibrate** card. Take your phone with you if you'd like to watch the countdown and the listen from outside the room. 2. Leave the room while the countdown runs and close the door behind you. Then move away from the door and the walls: the radar can see through drywall and thin doors, so waiting right outside can count as someone in the room. If the room has no door, go to another room, out of the sensor's view. 3. Come back after about a minute and a half, once the card shows **Thresholds updated**, and read the result. @@ -218,6 +220,8 @@ Open **Configure → Zones** and press **Add Zone**. The new zone is named **Zon ### Draw a zone +You draw each zone on the grid as a rectangle, ellipse, or polygon. + 1. Unlock the map and press the zone's button to select it. 2. Press ✎ (**Drawing modes**) in the bottom-left corner and pick a shape: ▭ (**Rectangle**), ◯ (**Ellipse**), or ⬠ (**Polygon**). 3. For a rectangle or ellipse, drag across the grid and let go to save. diff --git a/docs/products/general/setup/bluetooth-proxy.md b/docs/products/general/setup/bluetooth-proxy.md index d4a7056fe7..8ebb23a223 100755 --- a/docs/products/general/setup/bluetooth-proxy.md +++ b/docs/products/general/setup/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: Bluetooth Proxy Setup +title: Bluetooth proxy setup description: Tutorial for how to turn your Apollo device into a BLE proxy! --- -# Bluetooth Proxy +# Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" @@ -60,7 +60,7 @@ Select your product below to see the full walkthrough. --- -## Method 2: Manually enter the BLE proxy yaml +## Method 2: Manually enter the BLE proxy YAML This method works the same on every product. diff --git a/docs/products/general/setup/bluetooth-tracking.md b/docs/products/general/setup/bluetooth-tracking.md index 212d4db127..868246f517 100755 --- a/docs/products/general/setup/bluetooth-tracking.md +++ b/docs/products/general/setup/bluetooth-tracking.md @@ -1,30 +1,33 @@ --- -title: Bluetooth Tracker Setup -description: Tutorial for how to turn your Apollo device into a BLE tracker to track an iPhone! +title: Bluetooth tracker setup +description: Turn your Apollo device into a Bluetooth (BLE) tracker for your Apple Watch or Android phone in Home Assistant, with an iPhone alternative and an active-scanning Bluetooth proxy setup. --- -# Bluetooth Tracking +# Bluetooth tracking -**Apple iPhone and Apple Watch** +Your Apollo device can listen for the Bluetooth Low Energy (BLE) signals that phones and watches send out, so Home Assistant can tell when you're nearby. This page covers three setups: tracking an Apple Watch in ESPHome, detecting an Android phone as an iBeacon, and running your Apollo MSR-1 as a Bluetooth proxy that also scans for iBeacons. -Alternative HACS Integration: [iPhone Detect](https://github.com/mudape/iphonedetect) +## Apple iPhone and Apple Watch + +As an alternative to the ESPHome setup below, you can install the [iPhone Detect](https://github.com/mudape/iphonedetect) integration from HACS. [](https://my.home-assistant.io/redirect/hacs_repository/?owner=mudape&repository=iphonedetect&category=integration) -[https://community.home-assistant.io/t/implement-espresense-fuctionality-in-home-assistant-taking-advantage-of-ble-proxy-of-esphome/524019/6](https://community.home-assistant.io/t/implement-espresense-fuctionality-in-home-assistant-taking-advantage-of-ble-proxy-of-esphome/524019/6) +The Home Assistant Community also has a thread on [bringing ESPresense-style tracking to Home Assistant with ESPHome Bluetooth proxies](https://community.home-assistant.io/t/implement-espresense-fuctionality-in-home-assistant-taking-advantage-of-ble-proxy-of-esphome/524019/6). -Thanks to user [Jacob Pfeifer](https://discord.com/channels/1126966963206361199/1126966963755819080/1202032228050419732)!
Ok, so looks like I've got signal strength tracking working for Apple watches by getting the mac address from the home assistant private ble device integration. Here's a quick write-up if anyone else is interested. The end of the doc has a complete configuration file example. +### Track an Apple Watch in ESPHome -``` -# Tracking an Apple Watch in esphome -Using esphome on an Apollo msr-1 to track an Apple Watch +Thanks to community member [Jacob Pfeifer](https://discord.com/channels/1126966963206361199/1126966963755819080/1202032228050419732) for this write-up! It uses ESPHome on an MSR-1 to track an Apple Watch's signal strength (RSSI), by reading the watch's current MAC address from the Home Assistant Private BLE Device integration. Jacob used the [dalehumby/ESPHome-Apple-Watch-detection](https://github.com/dalehumby/ESPHome-Apple-Watch-detection) repository as a starting point. A complete configuration example sits at the end of this section. + +#### Track your watch's signal strength + +Set up RSSI tracking first. Step 1 happens in Home Assistant, and steps 2 to 5 each add a block to your MSR-1's ESPHome configuration. + +1\. Set up your Apple Watch in the **Private BLE Device** integration by following the instructions on the [Private BLE Device integration page](https://www.home-assistant.io/integrations/private_ble_device/). -## Acknowledgements: -The following github repo was used as a starting point for this configuration: https://github.com/dalehumby/ESPHome-Apple-Watch-detection +[](https://my.home-assistant.io/redirect/config_flow_start/?domain=private_ble_device) -## RSSI Tracking -1.) Setup your apple watch in the "Private BLE Device" integration by following the instructions on the integration page: https://www.home-assistant.io/integrations/private_ble_device/ +2\. Create a text sensor that reads your Apple Watch's current MAC address from Home Assistant. Replace `device_tracker.your_apple_watch_home_assistant_id` with your watch's entity ID. -2.) Create a text sensor in the esphome config that grabs the apple watch current mac address from home assistant: ```yaml text_sensor: - platform: homeassistant @@ -34,7 +37,7 @@ text_sensor: attribute: current_address ``` -3\.) Create a template sensor for storing and transmitting the rssi value: +3\. Create a template sensor that stores and sends the RSSI value: ```yaml sensor: @@ -50,7 +53,7 @@ sensor: send_every: 1 ``` -4\.) Create a custom ble tracker that uses the mac address from home assistant to match the device: +4\. Create a custom BLE tracker that uses the MAC address from Home Assistant to match your watch: ```yaml esp32_ble_tracker: @@ -68,18 +71,20 @@ esp32_ble_tracker: } ``` -5. Ensure the power save mode for wifi is set to light (msr-1 defaults to using none which does not work with bluetooth tracking): +5\. Set the Wi-Fi power save mode to `light`. The MSR-1 defaults to `none`, which doesn't work with Bluetooth tracking. ```yaml wifi: power_save_mode: light ``` -At this point if you install the changes on the device you should be successfully tracking the rssi for your apple watch. If you want you can optionally add some configuration for a basic presence detection sensor by doing the following: +Install the changes on your device, and your MSR-1 starts tracking your Apple Watch's RSSI. -OPTIONAL PRESENCE DETECTION SECTION +#### Optional: add presence detection -6. Create configuration values for detection signal strength: +To turn the RSSI into a basic presence sensor, add these blocks on top of the RSSI tracking setup. + +1\. Create settings for the signal strength levels that count as present and absent: ```yaml number: @@ -109,7 +114,7 @@ number: update_interval: never ``` -7. Create a sensor for storing and filtering the presence value: +2\. Create a sensor that stores and filters the presence value: ```yaml sensor: @@ -121,7 +126,7 @@ sensor: send_every: 1 ``` -8. Create a sensor for transmitting the filtered presence state: +3\. Create a binary sensor that sends the filtered presence state to Home Assistant: ```yaml binary_sensor: @@ -139,7 +144,7 @@ binary_sensor: } ``` -9. Update the rssi value to set the presence value when it receives a new rssi value: +4\. Replace the `apple_watch_rssi` sensor you created earlier with this version, which updates the presence value each time it receives a new RSSI value. It calls a `presence_timeout` script, which you'll find in the complete configuration below. ```yaml sensor: @@ -164,11 +169,11 @@ sensor: - script.execute: presence_timeout # Publish 0 if no rssi received ``` -Now once you install the esphome changes you should be able to go to the device and set db values for the presence detection and also should see a presence sensor state. +Install the ESPHome changes. On the device's page you can now set the dB levels for presence detection (**RSSI Presence Level** and **RSSI Absence Level**), and you see the presence sensor's state. -COMPLETE CONFIGURATION +#### Complete configuration -A complete example of a configuration: +Here is Jacob's complete configuration as an example. It uses his own device name, encryption key, and IDs (such as `jacobs_watch_mac` and `device_tracker.jacob_s_apple_watch`), so replace those with your own. ```yaml substitutions: @@ -293,37 +298,41 @@ wifi: password: !secret wifi_password ``` +## Android + +An Android phone can act as an iBeacon through the BLE Transmitter sensor in the Home Assistant Companion app, and your MSR-1 can detect it. Follow these steps to set it up. + +1. Install the iBeacon integration in Home Assistant. The [iBeacon Install Guide](https://www.home-assistant.io/integrations/ibeacon/) walks you through it. + + [](https://my.home-assistant.io/redirect/config_flow_start/?domain=ibeacon) -**Android** Helpful links: -[ESP32 Bluetooth Low Energy Tracker Hub](https://esphome.io/components/esp32_ble_tracker.html) -[iBeacon support for ble\_presence](https://github.com/esphome/esphome/pull/1627) -[ESP32 Bluetooth Low Energy Beacon](https://esphome.io/components/esp32_ble_beacon.html) -[iBeacon Region](https://owntracks.org/booklet/features/beacons/) +2. Install the Home Assistant Companion app on your phone, for [Android](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android&hl=en_US&gl=US&pli=1) or [Apple](https://apps.apple.com/us/app/home-assistant/id1099568401). -1. Install the iBeacon integration in HA - [iBeacon Install Guide](https://www.home-assistant.io/integrations/ibeacon/) -2. Install the Home Assistant App on your device - [Android](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android&hl=en_US≷=US&pli=1) - [Apple](https://apps.apple.com/us/app/home-assistant/id1099568401) -3. Navigate to the HA settings +3. In the app, open **Settings**.  -4. Select Companion app + +4. Select **Companion app**.  -5. Select Manage sensors + +5. Select **Manage sensors**.  -6. Turn on the "BLE Transmitter" + +6. Open **BLE Transmitter** and turn it on.  -7. After opening BLE transmitter and turning it on, then scroll down to get the iBeacon unique ID + +7. Scroll down to find the iBeacon unique ID.  -8. Add it to the ESPHome yaml config for the MSR-1 + +8. In ESPHome, click **Edit** on your MSR-1 and add the iBeacon unique ID to its YAML configuration. In the example in the next step, the ID goes in `ibeacon_uuid`.  -9. Be sure to add "power\_save\_mode: LIGHT" to the wifi section + +9. Make sure your `wifi` section includes `power_save_mode: LIGHT`, as in this example: ``` # Example config.yaml @@ -342,31 +351,38 @@ wifi: name: "Jane's Phone" ``` -10. Should be all set! -## Thanks to our Discord user albuquerquefx for the information below! +You should now be all set: your MSR-1 can detect your phone through the `ble_presence` binary sensor. + +For more detail, see: +- [ESP32 Bluetooth Low Energy Tracker Hub](https://esphome.io/components/esp32_ble_tracker.html) +- [iBeacon support for ble\_presence](https://github.com/esphome/esphome/pull/1627) +- [ESP32 Bluetooth Low Energy Beacon](https://esphome.io/components/esp32_ble_beacon.html) +- [iBeacon Region](https://owntracks.org/booklet/features/beacons/) +## Bluetooth proxy with active scanning -For those interested in using their MSR-1 as a Bluetooth proxy while also actively scanning for BLE devices, you'll need to add the following to your ESP32 YAML file (I'm using a 1.5-second scan interval with a 750ms window for sensing BLE beacons): +Thanks to Discord user albuquerquefx for this setup! -esp32\_ble\_tracker: - id: ${name}\_ble\_tracker - scan\_parameters: - interval: 1500ms - window: 750ms - active: true +To use your MSR-1 as a Bluetooth proxy while it also actively scans for BLE devices, add the following to its ESPHome YAML file. This example uses a 1.5-second scan interval with a 750ms window for sensing BLE beacons. + + esp32_ble_tracker: + id: ${name}_ble_tracker + scan_parameters: + interval: 1500ms + window: 750ms + active: true -bluetooth\_proxy: - active: true + bluetooth_proxy: + active: true -Additionally, you need to include this entry in your existing Wi-Fi section: +Also add `power_save_mode: light` to your existing Wi-Fi section. -power\_save\_mode: light +After a few minutes near any iBeacon device within listening range of your MSR-1, Home Assistant announces a discovered **iBeacon Tracker** integration on your **Settings** page. Once it's installed, it starts sensing nearby devices. -Once complete, after a few minutes within the presence of any iBeacon device within listening distance of your MSR-1, Home Assistant should announce the presence of an iBeacon Tracker integration on your settings page. While I didn't capture a screenshot of it, it's now installed and sensing things. +!!! tip "Devices with a blank name" -If you encounter a device with a blank name (e.g., anything Android), you'll need to click "Configure" and enter the UUID manually. This is because Home Assistant does not allow devices with empty names (interestingly, their own companion app permits forcing an Android to become an iBeacon but then doesn't require a name field). + If a device has a blank name (for example, anything Android), click **Configure** and enter its UUID manually. Home Assistant doesn't allow devices with empty names, even though its own Companion app lets you turn an Android phone into an iBeacon without requiring a name. -For devices where you don't know the IRK, you may have to wait about 300 seconds for your iBeacon Tracker to process 10 different iterations of the same UUID but with the last four characters randomly changed. Once ten instances have appeared, the iBeacon Tracker integration should recognize they're all the same device and combine them into a single tracker element. Just be patient, though it can be a bit frustrating. -``` \ No newline at end of file +If you don't know a device's IRK (Identity Resolving Key), you may have to wait about 300 seconds while your iBeacon Tracker processes 10 different versions of the same UUID, each with the last four characters randomly changed. Once ten have appeared, the integration should recognize they're all the same device and combine them into a single tracker element. It can be a bit frustrating, so be patient. 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 73c4fd7d5f..3af57b4769 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 @@ -1,9 +1,11 @@ --- -title: How To Change The Update Frequency Of Sensors +title: How to change the update frequency of sensors description: Tutorial for How To Change The Update Frequency Of Sensors. --- -# How To Change The Update Frequency Of Sensors +# How to change the update frequency of sensors + +You change how often a sensor updates by adding a few lines of YAML to your device in ESPHome Builder, then installing the update. 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. If it isn't in your sidebar, the button below opens the app. diff --git a/docs/products/general/setup/getting-started.md b/docs/products/general/setup/getting-started.md index c605719d72..174e5c95c9 100755 --- a/docs/products/general/setup/getting-started.md +++ b/docs/products/general/setup/getting-started.md @@ -1,20 +1,20 @@ --- -title: Getting Started +title: Getting started description: Generic getting started article. --- -# Getting Started +# Getting started This will walk you through the process of connecting your new Apollo Automation sensor to Home Assistant through ESPHome. If at any point you get stuck, join our Discord for some help. -## Connecting Through Hotspot +## Connecting through hotspot To connect through the sensor's onboard hotspot follow the 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 Wi-Fi settings and connect to "Apollo MSR-2 Hotspot", it might take a minute for the Wi-Fi network to show up. +2\. On your phone or PC, open the Wi-Fi settings and connect to the sensor's hotspot, such as "Apollo MSR2 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 @@ -34,6 +34,8 @@ If this does not automatically open the dashboard, please open your web browser ## Connecting with Improv via BLE +You connect your sensor to Wi-Fi from Home Assistant over Bluetooth, then finish adding it through ESPHome. + !!! note "Pre-requirement:" Bluetooth built in such as a Raspberry Pi or at least one ESP32 BLE Proxy. If you have already followed the "Connecting through Hotspot" please skip this section. @@ -66,7 +68,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..." @@ -108,7 +110,9 @@ 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: + +Next, you add your new Apollo device to Home Assistant through the ESPHome integration. 1\. Click the "**Notifications**" Icon in the bottom left. 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 cdbb0ffe7a..b9660ba347 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 @@ -1,8 +1,10 @@ --- -title: How To Add Temp And Humidity From SCD40 +title: How to add temp and humidity from SCD40 description: Tutorial for How To Add Temp And Humidity entities From the SCD40 CO2 sensor. --- -# How To Add Temp And Humidity From SCD40 +# How to add temp and humidity from SCD40 + +You add YAML in ESPHome Builder to get SCD40 temperature and humidity entities, with offsets you can adjust in Home Assistant. 1\. Select the ESPHome Builder in the sidebar then click "EDIT" on the device you want to change. If it isn't in your sidebar, the button below opens the app. @@ -14,7 +16,7 @@ description: Tutorial for How To Add Temp And Humidity entities From the SCD40 C !!! note "This example is for the AIR-1" - However this will also work with our MSR-2 and MTR-1 devices too! + It also works on the MSR-2 once the CO2 addon is installed. The MTR-1 firmware already includes **SCD40 Temperature** and **SCD40 Humidity** entities with their offsets (disabled by default), so on an MTR-1 with the CO2 addon, enable those entities on the device page instead of adding this YAML. ```yaml sensor: @@ -34,6 +36,7 @@ number: - platform: template name: SCD40 Temperature Offset id: scd40_temperature_offset + restore_value: true initial_value: 14.54 min_value: -70.0 max_value: 70.0 diff --git a/docs/products/general/setup/renaming-apollo-devices.md b/docs/products/general/setup/renaming-apollo-devices.md index cb6a77be74..6f7c6a21c6 100755 --- a/docs/products/general/setup/renaming-apollo-devices.md +++ b/docs/products/general/setup/renaming-apollo-devices.md @@ -1,10 +1,12 @@ --- -title: Renaming Apollo Devices +title: Renaming Apollo devices description: Tutorial for How To Rename Apollo Devices in the ESPHome integration and ESPHome Device Builder! --- -# Renaming Apollo Devices +# Renaming Apollo devices -## ESPHome Integration - Part 1 +## ESPHome integration - part 1 + +You rename the device in the ESPHome integration, then update its entity IDs to match. 1\. Click the button below to open the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). @@ -18,7 +20,7 @@ description: Tutorial for How To Rename Apollo Devices in the ESPHome integratio !!! success "It's okay if there are some entities that cannot be regenerated!" - You will likely run into a popup showing 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. + You will likely run into a popup showing that 2 entity IDs cannot be regenerated because they are not available. This is fine, we can manually fix these later or ignore them as they are disabled entities and not expected to be used.  @@ -26,7 +28,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. @@ -44,6 +46,8 @@ This section only changes the device name shown in the ESPHome integration page. ## ESPHome Device Builder +You change the device's hostname and friendly name in ESPHome Device Builder, then re-add it to Home Assistant under the new name. + 1\. Make sure you are already using the ESPHome Device Builder app as gone over in the getting started wiki articles. [](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) diff --git a/docs/products/general/setup/switch-to-beta-branch.md b/docs/products/general/setup/switch-to-beta-branch.md index 800277e897..ec9cdec9c5 100755 --- a/docs/products/general/setup/switch-to-beta-branch.md +++ b/docs/products/general/setup/switch-to-beta-branch.md @@ -1,14 +1,14 @@ --- -title: Switch to Beta Firmware +title: Switch to beta firmware description: How to switch your Apollo device to beta firmware to try new features early, and how to switch back. --- -# Switch to Beta Firmware +# Switch to beta firmware Beta firmware gets new features and fixes before they reach Stable. It's a great way to help us test, and you can switch back at any time. -## With the Firmware Channel Setting +## With the Firmware Channel setting -This is the easy way. Use it if your device has a **Firmware Channel** setting on its device page, like the CAST-1. +This is the simpler way. Use it if your device has a **Firmware Channel** setting on its device page, like the CAST-1. @@ -54,7 +54,7 @@ Use this if your device doesn't have a **Firmware Channel** setting, or if you b !!! danger "This is code and requires you to follow the directions carefully." - Editing the YAML here means even a space matters. Follow the guide just as shown and ask questions if you need help! + Editing the YAML here means even a space matters. Follow the guide exactly as shown and ask questions if you need help! 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. diff --git a/docs/products/general/supported-platforms.md b/docs/products/general/supported-platforms.md index 3e3b92d1b0..0819c81e63 100755 --- a/docs/products/general/supported-platforms.md +++ b/docs/products/general/supported-platforms.md @@ -1,5 +1,5 @@ --- -title: Supported Platforms +title: Supported platforms description: A list of platforms compatible with Apollo Automation products. ---  @@ -23,7 +23,7 @@ At Apollo, we are actively working on adding support for every smart home ecosys ## **Hubitat** -* **Integration:** Working on support - check back soon! +* **Integration:** Working on support. Check back soon! * **Support:** We do not provide support for this platform but if enough users want it that could change. We of course always support the hardware of our products though! ## **openHAB** @@ -43,7 +43,7 @@ At Apollo, we are actively working on adding support for every smart home ecosys ## Samsung SmartThings -* **Integration:** Supported via direct OAuth2 from your Apollo ESPHome device — no hub or Home Assistant required. See our [SmartThings Direct Control tutorial](tutorials/smartthings-direct-control.md) for full setup instructions including zone-based presence detection and autonomous token renewal. +* **Integration:** Supported via direct OAuth2 from your Apollo ESPHome device, no hub or Home Assistant required. See our [SmartThings Direct Control tutorial](tutorials/smartthings-direct-control.md) for full setup instructions including zone-based presence detection and autonomous token renewal. * **Support:** We do not provide official support for this platform, but the community tutorial covers the full setup including token renewal and troubleshooting. ## MQTT diff --git a/docs/products/general/temp-hum-calibration.md b/docs/products/general/temp-hum-calibration.md index bc2979a685..49c0b65774 100755 --- a/docs/products/general/temp-hum-calibration.md +++ b/docs/products/general/temp-hum-calibration.md @@ -1,12 +1,22 @@ --- -title: Temp and Humidity Calibration and Offset Examples -description: Temp and Humidity Calibration and Offset Examples. +title: Temp and humidity calibration and offset examples +description: Learn why Apollo temperature and humidity readings can be off, then correct them with simple offsets or advanced template sensors. --- -# Simple and Advanced Examples of Temperature & Humidity Offsets +# Simple and advanced temperature and humidity offsets -## **Simple Offsets for Temperature and Humidity:** +Your Apollo device's temperature and humidity readings can differ from the true value. This page explains why, then shows how to correct them: simple offsets you set from the device page, or advanced template sensors that estimate the true values from all of your readings. -**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!** +## Why readings can be off + +The BME280 and SCD40 sensors are known for measuring temperature and humidity precisely. Like any sensor, though, they can sometimes give inaccurate readings. One significant cause is heat from the ESP chip, which warms the air inside the enclosure and skews the readings. + +Temperature and humidity are also linked. When the air temperature rises, the air can hold more moisture, which can lower the relative humidity. When the temperature falls, the air can hold less moisture, so the humidity rises. This relationship plays a big part in how the sensors detect and interpret readings, which makes accurate readings even more important. + +## Add simple offsets + +Add two offset boxes to your device so you can correct its SCD40 temperature and humidity readings from Home Assistant. + +1\. In ESPHome Device Builder, open your device's YAML and paste the following at the bottom: ```yaml sensor: @@ -38,6 +48,7 @@ number: - platform: template name: SCD40 Temperature Offset id: scd40_temperature_offset + restore_value: true initial_value: 14.54 min_value: -70.0 max_value: 70.0 @@ -49,23 +60,25 @@ number: mode: box ``` -## **BME280 & SCD40 Sensors: Overcoming Temperature & Humidity Reading Challenges** +2\. Click **Save**, then **Install**. -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. +3\. In Home Assistant, open your device's page in the ESPHome integration. Fill in your offsets in the two new boxes, **SCD40 Humidity Offset** and **SCD40 Temperature Offset**. -## **Adjusting the BME280 and SCD40 Temperature Offset** +Give the new offsets up to 1 minute to take effect. The next section explains how to choose the right values. -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. - -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 `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. +## How the offsets work -## **Modeling the Relationship Between Sensors** +You can adjust the BME280 and SCD40 Temperature Offset entities by hand to match the conditions in your home. The firmware subtracts each offset from the raw temperature or humidity reading, and the result is what the sensor's entity shows in Home Assistant. For example, the `scd40_temperature` entity equals the raw SCD40 temperature reading minus `scd40_offset`. -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. +The default offsets come from our NIST-certified thermometer and are calibrated for our environment, so they might not be accurate in your home. To fine-tune them, compare your sensor with a reference thermometer and adjust the offsets by the difference between the two readings. -Here's an example that can be added to a configuration YAML: +You may also notice the `bme280_humidity_calibrated`, `scd40_humidity_calibrated`, `bme280_temperature_calibrated`, and `scd40_temperature_calibrated` entities. These use the linear filter in the ESPHome firmware to adjust the readings based on data we collected. Because every home is different, they might not always be precise either. + +## Advanced: model the relationship between sensors + +Another way to get accurate readings is to model how the ESP chip temperature and the other sensors relate to a reference temperature. A template sensor in Home Assistant does this for you: it combines your sensor's live readings into an estimated true temperature and humidity, using either a decision tree or our regression coefficients (the multipliers in the example below). + +Add the example below to your Home Assistant configuration YAML. Its entity IDs belong to one Apollo MSR-1 (`apollo_msr_1_a79e24`), so replace them with your own device's entity IDs. ```plaintext sensor: @@ -99,8 +112,9 @@ sensor: }} ``` +### Collect your own data -For users who want to gather their own data with a reference sensor and MSR-1 within their home, we recommend logging data to a CSV using the following YAML entries: +To gather your own data with a reference sensor and an MSR-1 in your home, we recommend logging the readings to a CSV file. The YAML below logs once a minute to match the reference sensor. As its comments show, the `notify` entry goes in `configuration.yaml` and the automation goes in `automations.yaml`. ```plaintext #Configuration.yaml @@ -133,11 +147,6 @@ notify: {{ states('sensor.apollo_msr_1_a79e24_uptime') | default('NA') }} ``` +## Advanced accuracy with GPIO -## **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** - -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 +For the highest accuracy, connect a temperature and humidity sensor to the exposed mezzanine connector on the back of your Apollo board. This modification can dramatically improve both temperature and humidity readings, giving you data that's as accurate as possible. diff --git a/docs/products/general/troubleshooting/connection-issues.md b/docs/products/general/troubleshooting/connection-issues.md index c378feb4e4..2dc6c54ac6 100755 --- a/docs/products/general/troubleshooting/connection-issues.md +++ b/docs/products/general/troubleshooting/connection-issues.md @@ -1,41 +1,54 @@ --- -title: Connection Issues -description: Suggestions for Connection Issues +title: Connection issues +description: Checks to work through when your Apollo device drops offline or won't stay connected to Wi-Fi, including how to turn off Wi-Fi power save mode. --- -1\. Try a couple of different power cord and power brick combinations - this matters a lot more than you'd think! +# Connection issues -2\. Check to see if the sensor's hotspot is showing up. (this means it is not connected to a network) +If your Apollo device keeps dropping offline or won't stay connected to your Wi-Fi, work through these checks in order. -3\. Check the router's connected devices - the device will show up with the Apollo name and a 6 digit hex value of the end of the mac address. +1\. Try a few different combinations of power cord and power brick. Power quality matters a lot more than you'd think. -4\. Disable [power save mode](https://esphome.io/components/wifi.html#power-save-mode) in ESPHome. (See directions below) +2\. On your phone or PC, open your Wi-Fi settings and look for the sensor's hotspot. If the hotspot shows up, the sensor isn't connected to a network. [Connect it to your Wi-Fi through the hotspot](../../setup/getting-started/#connecting-through-hotspot) again. -# Wi-Fi Power Save Mode +3\. Check your router's list of connected devices. Your device shows up with the Apollo name and a 6-digit hex value taken from the end of its MAC address. -The Wi-Fi interface of all ESPs 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. +4\. Turn off [power save mode](https://esphome.io/components/wifi.html#power-save-mode) in ESPHome. The steps are in the next section. -* `NONE` (least power saving, Default for ESP8266) -* `LIGHT` (Default for ESP32) +## Turn off Wi-Fi power save mode + +The Wi-Fi interface of every ESP chip offers three power save modes that cut the power spent on Wi-Fi. Some of them *can* lower the ESP's power use, but they generally make the Wi-Fi connection less reliable. The highest power saving mode causes frequent disconnections from the router. + +* `NONE` (least power saving, default for ESP8266) +* `LIGHT` (default for ESP32) * `HIGH` (most power saving) +For the most reliable connection, set the mode to `none`. In your device's YAML file, the setting sits inside the `wifi:` section, where `# ...` stands for the lines already in that section: + ```yaml wifi: # ... power_save_mode: none ``` -1\. Select the ESPHome app and then select Edit under your desired device. If it isn't in your sidebar, the button below opens the app. +!!! note "Your sensor runs warmer" + + Turning off power save mode makes the sensor's internal temperature increase. + +Follow these steps to turn power save mode off from the ESPHome app in Home Assistant. + +1\. Open the ESPHome app from your Home Assistant sidebar and click **Edit** under the device you want to change. If the app isn't in your sidebar, the button below opens it. [](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon)  -2\. Add the code below to your device's yaml file. Then select Save and press Install. +2\. Add `power_save_mode: none` under the `wifi:` section of your device's YAML file, indented to line up with the other lines in that section. If your file doesn't have a `wifi:` line, add one. Then click **Save** and **Install**. ```yaml -power_save_mode: none +wifi: + power_save_mode: none ```  -3\. Now your device should have a stronger connection. (This will cause the sensor's internal temperature to increase.) \ No newline at end of file +Your device should now have a stronger connection to your Wi-Fi. diff --git a/docs/products/general/troubleshooting/firmware-updates-not-appearing.md b/docs/products/general/troubleshooting/firmware-updates-not-appearing.md index 33cfe83d96..69065c1cac 100644 --- a/docs/products/general/troubleshooting/firmware-updates-not-appearing.md +++ b/docs/products/general/troubleshooting/firmware-updates-not-appearing.md @@ -1,5 +1,5 @@ --- -title: Firmware Updates Not Appearing +title: Firmware updates not appearing description: What to check when the Firmware Update entity never offers an update. --- Apollo devices check for new firmware by downloading a small manifest file from `apolloautomation.github.io` over HTTPS. If the **Firmware Update** entity in Home Assistant always shows *up to date* even though a newer release exists, work through the list below. @@ -7,17 +7,17 @@ Apollo devices check for new firmware by downloading a small manifest file from 1\. **Make sure the device can reach the internet.** * The device needs outbound HTTPS (port 443) to `apolloautomation.github.io`. If your sensors live on an isolated IoT VLAN that blocks traffic leaving the network, the update check fails silently and the entity shows *up to date* forever. -* To confirm, watch the device logs (ESPHome Device Builder → Logs, or the device's web page) — a blocked check logs `Failed to fetch manifest` with `ESP_ERR_HTTP_CONNECT`. +* To confirm, watch the device logs (ESPHome Device Builder → Logs, or the device's web page). A blocked check logs `Failed to fetch manifest` with `ESP_ERR_HTTP_CONNECT`. * Allow the device to reach `apolloautomation.github.io` on port 443 in your firewall rules, then reboot the device. -2\. **Give it a moment after a reboot — or update your firmware.** +2\. **Give it a moment after a reboot, or update your firmware.** * On older firmware the very first update check after a boot can be skipped if Wi-Fi isn't connected yet, and the next check only happens about 6 hours later. Newer firmware checks as soon as the network connects. * If the entity looks stale right after a reboot, either wait, reboot once more while the network is up, or update to the latest firmware release. 3\. **Devices adopted in the ESPHome Device Builder update differently.** -* If you have taken control of the device's configuration in the ESPHome Device Builder, Home Assistant manages updates through the Device Builder instead of the manufacturer Firmware Update entity. That is expected — build and install updates from the Device Builder in that case. +* If you have taken control of the device's configuration in the ESPHome Device Builder, Home Assistant manages updates through the Device Builder instead of the manufacturer Firmware Update entity. That is expected. Build and install updates from the Device Builder in that case. !!! tip "Battery devices" 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 423c8d6ddc..b6375d86de 100755 --- a/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md +++ b/docs/products/general/troubleshooting/opnsense-mdns-auto-discover-issue.md @@ -1,8 +1,8 @@ --- -title: OPNsense mDNS Auto Discover Issue +title: OPNsense mDNS auto discover issue description: Tutorial to help fix the OPNsense mDNS Auto Discover Issue --- -# OPNsense mDNS Auto Discover Issue +# OPNsense mDNS auto discover issue !!! tip "If mDNS is unchecked then Home Assistant and ESPHome will not auto discover new devices" 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 ca96a04b7b..e4771eae7e 100755 --- a/docs/products/general/troubleshooting/removing-device-from-home-assistant.md +++ b/docs/products/general/troubleshooting/removing-device-from-home-assistant.md @@ -1,8 +1,8 @@ --- -title: Removing Device From Home Assistant +title: Removing device from Home Assistant description: Tutorial for Removing Device From Home Assistant. --- -# Removing Device From Home Assistant +# Removing device from Home Assistant ## ESPHome app @@ -22,7 +22,7 @@ This will cover how to remove an Apollo device from Home Assistant  -## ESPHome Integration +## ESPHome integration 1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**). 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 8e0916c602..7d7405e188 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 @@ -1,15 +1,17 @@ --- -title: Ubiquiti UniFi mDNS Auto Discover Issue +title: Ubiquiti UniFi mDNS auto discover issue description: Tutorial to help fix the Ubiquiti UniFi mDNS Auto Discover Issue. --- -# Ubiquiti UniFi mDNS Auto Discover Issue +# Ubiquiti UniFi mDNS auto discover issue !!! tip "If mDNS is unchecked then Home Assistant and ESPHome will not auto discover new devices" - 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. + If your Home Assistant (or Homey) hub and your ESPHome devices are on different networks, you need mDNS working across both networks and firewall rules that allow traffic between them. Below are guides for fixing this from your PC or the UniFi mobile app. ## **Method 1: Browser** +You can turn on Multicast DNS for your Default Network from a browser on your PC. + 1\. Log into your UniFi network through your default IP address which is usually http://192.168.1.1 2\. Select Network. @@ -34,7 +36,9 @@ 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 mobile app** + +You can also turn on Multicast DNS for your Default Network from the UniFi mobile app. 1\. Open the UniFi app. diff --git a/docs/products/general/tutorials/change-co2-update-interval.md b/docs/products/general/tutorials/change-co2-update-interval.md index 4caed22372..3df5cfbbf6 100644 --- a/docs/products/general/tutorials/change-co2-update-interval.md +++ b/docs/products/general/tutorials/change-co2-update-interval.md @@ -1,8 +1,8 @@ --- -title: How to edit your Sensor's CO2 update interval +title: How to edit your sensor's CO2 update interval description: How to edit your Sensor's CO2 update interval --- -# How to edit your Sensor's CO2 update interval +# How to edit your sensor's CO2 update interval This guide will show you how to edit the CO2 updates down to 5 seconds, which is the fastest the SCD40 sensor supports. This is useful for use-cases that benefit from smoother graphs or quicker reaction to CO2 changes, such as grow rooms, offices, or sleep spaces. @@ -18,7 +18,7 @@ This guide will show you how to edit the CO2 updates down to 5 second  -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. +2\. Copy this code and enter it exactly as shown in the next step. Make sure there are no extra spaces or any other characters. It needs to look exactly like the example in the next step. ```yaml #CO2 sensor update interval 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 4bc97d5a92..0a480c1fdd 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 @@ -1,8 +1,8 @@ --- -title: How to edit your Sensor's LUX update interval +title: How to edit your sensor's lux update interval description: How to edit your Sensor's LUX update interval --- -# How to edit your Sensor's LUX update interval +# How to edit your sensor's lux update interval This guide will show you how to edit the lux updates down to 5 seconds. @@ -14,7 +14,7 @@ This guide will show you how to edit the lux updates down to 5 seconds.  -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. +2\. Copy this code and enter it exactly as shown in the next step. Make sure there are no extra spaces or any other characters. It needs to look exactly like the example in the next step. ```yaml #LUX sensor update interval diff --git a/docs/products/general/tutorials/minimize-mmwave-activity-spam.md b/docs/products/general/tutorials/minimize-mmwave-activity-spam.md index ecf135eb1a..6ba31a26a3 100644 --- a/docs/products/general/tutorials/minimize-mmwave-activity-spam.md +++ b/docs/products/general/tutorials/minimize-mmwave-activity-spam.md @@ -2,7 +2,7 @@ title: How to minimize activity spam description: How to minimize the activity spam on your Apollo mmWave sensors --- -# Minimize Activity Spam +# Minimize activity spam Apollo mmWave sensors report frequently by design, which can cause internal radar entities like target direction, target count, and zone occupancy to flood your Home Assistant Activity log. Adding a `logbook.exclude` block to your `configuration.yaml` tells Home Assistant to stop recording those entities. diff --git a/docs/products/general/tutorials/smartthings-direct-control.md b/docs/products/general/tutorials/smartthings-direct-control.md index 048efbe9c9..6a60a25565 100644 --- a/docs/products/general/tutorials/smartthings-direct-control.md +++ b/docs/products/general/tutorials/smartthings-direct-control.md @@ -1,18 +1,18 @@ --- -title: Direct SmartThings Integration (No Hub) -description: Control SmartThings devices directly from Apollo ESPHome sensors using OAuth2 — no Home Assistant or hub required. +title: Direct SmartThings integration (no hub) +description: Control SmartThings devices directly from Apollo ESPHome sensors using OAuth2, no Home Assistant or hub required. --- -# Apollo Sensors + SmartThings Direct Control +# Apollo sensors + SmartThings direct control !!! note "Compatible Devices" - This works with any Apollo ESPHome device running ESPHome: MTR-1, MSR-2, AIR-1, and others. The OAuth2 token block is fully device-agnostic — just swap the `packages:` line for your device. + This works with any Apollo ESPHome device running ESPHome: MTR-1, MSR-2, AIR-1, and others. The OAuth2 token block is fully device-agnostic: swap the `packages:` line for your device. ## Background -Since early 2025, Samsung SmartThings no longer supports permanent Personal Access Tokens (PAT). All API access now requires OAuth2 tokens that expire every 24 hours. This makes direct ESP32 integrations tricky — but not impossible. +Since early 2025, Samsung SmartThings no longer supports permanent Personal Access Tokens (PAT). All API access now requires OAuth2 tokens that expire every 24 hours. This makes direct ESP32 integrations tricky, but not impossible. -This tutorial shows how to make your Apollo MTR-1 control SmartThings lights directly, with zero external servers, no Home Assistant, and no intermediate hub. The ESP32 handles the full OAuth2 token lifecycle autonomously — including persisting the refresh token across reboots using NVS flash storage. Once set up, it runs forever without any manual intervention. +This tutorial shows how to make your Apollo MTR-1 control SmartThings lights directly, with zero external servers, no Home Assistant, and no intermediate hub. The ESP32 handles the full OAuth2 token lifecycle autonomously, including persisting the refresh token across reboots using NVS flash storage. Once set up, it runs forever without any manual intervention. **What you will achieve:** @@ -20,7 +20,7 @@ This tutorial shows how to make your Apollo MTR-1 control SmartThings lights dir - Fully autonomous OAuth2 token renewal every 20 hours - Token persistence across power cuts and reboots via NVS flash -## What You Need +## What you need - Apollo MTR-1 (the same pattern works for MSR-2, AIR-1, and other Apollo ESPHome devices) - A Samsung SmartThings account @@ -30,30 +30,30 @@ This tutorial shows how to make your Apollo MTR-1 control SmartThings lights dir --- -## Part 1: Create a SmartThings OAuth2 App +## Part 1: Create a SmartThings OAuth2 app This is a one-time setup. You need to register an OAuth2 client in the SmartThings Developer Workspace to get your `client_id` and `client_secret`. -**Step 1 — Create a project:** +**Step 1. Create a project:** 1. Go to [https://developer.smartthings.com](https://developer.smartthings.com) and sign in with your Samsung account 2. Click **"Create Project"** → select **"Automation for SmartThings"** 3. Give it any name, e.g. "Apollo MTR-1" -**Step 2 — Add an OAuth2 Client:** +**Step 2. Add an OAuth2 Client:** 1. Inside your project, go to **Automation → OAuth2** 2. Set the Redirect URI to: `https://oauth.pstmn.io/v1/callback` 3. Set scopes: `r:devices:*` `w:devices:*` `x:devices:*` -4. Save — you will receive a **Client ID** and a **Client Secret**. Note both down. +4. Save. You will receive a **Client ID** and a **Client Secret**. Note both down. --- -## Part 2: Get Your First Token Pair (One-Time via Browser) +## Part 2: Get your first token pair (one-time via browser) SmartThings requires a one-time browser-based authorization. After this, the ESP32 renews everything automatically. -**Step 1 — Open this URL in your browser** (replace `YOUR_CLIENT_ID`): +**Step 1. Open this URL in your browser** (replace `YOUR_CLIENT_ID`): ``` https://api.smartthings.com/oauth/authorize?client_id=YOUR_CLIENT_ID&scope=x:devices:*+w:devices:*+r:devices:*&response_type=code&redirect_uri=https://oauth.pstmn.io/v1/callback @@ -65,9 +65,9 @@ Log in with your Samsung account and authorize the app. You will be redirected t https://oauth.pstmn.io/v1/callback?code=XXXXXX ``` -Copy the `code` value. **It expires in about 60 seconds — act fast.** +Copy the `code` value. **It expires in about 60 seconds. Act fast.** -**Step 2 — Exchange the code for tokens (PowerShell on Windows):** +**Step 2. Exchange the code for tokens (PowerShell on Windows):** ```powershell $b64 = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("YOUR_CLIENT_ID:YOUR_CLIENT_SECRET")) @@ -98,15 +98,15 @@ Save this Base64 string too. --- -## Part 3: Create Virtual Switches and Find Device IDs +## Part 3: Create virtual switches and find device IDs To map your physical MTR-1 zones to SmartThings routines without a hub, we need Virtual Switches. The MTR-1 will send ON/OFF commands to these virtual switches, which you can then use in SmartThings to trigger your actual lights. -**Step 1 — Create Virtual Switches** +**Step 1. Create Virtual Switches** Log into your account @ [my.smartthings.com](https://my.smartthings.com) > advanced > add device > cloud > switch -**Step 2 — Find Your SmartThings Device IDs** +**Step 2. Find Your SmartThings Device IDs** In the my.smartthings webapp you can copy your new virtual device IDs. @@ -114,18 +114,18 @@ For each light or switch you want to control, you need its Device ID (format: `x --- -## Part 4: The ESPHome Configuration +## Part 4: The ESPHome configuration Below is the complete, production-tested YAML. Replace all `YOUR_*` placeholders with your actual values. !!! tip "Key Design Decisions" - 1. **`wifi: on_connect` instead of `on_boot`** — the ESP-IDF HTTP stack is not ready at boot time. Using `on_connect` with a 15-second delay guarantees the network is fully available before the first token refresh fires. - 2. **`script: mode: single`** — prevents a second token refresh from being triggered while the first one is still running. This is critical during router reboots or mesh Wi-Fi reconnects where `wifi: on_connect` can fire multiple times in rapid succession. - 3. **`restore_value: yes` on `st_refresh_token`** — saves the latest refresh token to NVS flash after every successful renewal. It survives reboots and power cuts. The `initial_value` in the YAML is only ever used on the very first flash. - 4. **`body: !lambda |-`** — plain string bodies are silently ignored by the ESP-IDF HTTP client. The lambda syntax is required for the POST body to actually be sent. + 1. **`wifi: on_connect` instead of `on_boot`**: the ESP-IDF HTTP stack is not ready at boot time. Using `on_connect` with a 15-second delay guarantees the network is fully available before the first token refresh fires. + 2. **`script: mode: single`**: prevents a second token refresh from being triggered while the first one is still running. This is critical during router reboots or mesh Wi-Fi reconnects where `wifi: on_connect` can fire multiple times in rapid succession. + 3. **`restore_value: yes` on `st_refresh_token`**: saves the latest refresh token to NVS flash after every successful renewal. It survives reboots and power cuts. The `initial_value` in the YAML is only ever used on the very first flash. + 4. **`body: !lambda |-`**: plain string bodies are silently ignored by the ESP-IDF HTTP client. The lambda syntax is required for the POST body to actually be sent. ```yaml -substitution: +substitutions: name: "apollo-mtr1" friendly_name: "Apollo MTR-1" @@ -278,9 +278,12 @@ binary_sensor: body: '{"commands": [{"component": "main", "capability": "switch", "command": "off"}]}' ``` +!!! warning "`verify_ssl: false` turns off certificate checking" + This setting tells the device to skip certificate checks on every SmartThings API call it makes, including the token refresh. The example does this because the certificate bundle the ESP32 would need to check those certificates is too large to fit comfortably on the device. Anyone who can intercept your network traffic could read your SmartThings token, so keep the device on a trusted network. + --- -## Part 5: Flash and Verify +## Part 5: Flash and verify ``` esphome run your_config.yaml --device 192.168.x.x @@ -298,11 +301,11 @@ Within 15 seconds of connecting to Wi-Fi, you should see in the logs: Then walk into one of your defined zones. The SmartThings API response will show `content-type: application/json` (not `text/html`) and your light turns on. -If you see `HTTP Request failed; Code: 401` — the access token has expired. A simple reboot fixes it: the `wifi: on_connect` handler will fetch a fresh token automatically. +If you see `HTTP Request failed; Code: 401`, the access token has expired. A simple reboot fixes it: the `wifi: on_connect` handler will fetch a fresh token automatically. --- -## How the Token Lifecycle Works +## How the token lifecycle works ```text First flash: initial_value token → refresh → new access + refresh → saved to NVS @@ -317,17 +320,17 @@ After the first flash, the `initial_value` in the YAML is never used again. The ## Troubleshooting !!! warning "401 on SmartThings API calls" - The access token has expired. Reboot the device — the `wifi: on_connect` handler will fetch a fresh pair automatically. + The access token has expired. Reboot the device. The `wifi: on_connect` handler will fetch a fresh pair automatically. !!! warning "400 `invalid_grant` on token refresh" The refresh token was invalidated. This can happen if the device was offline for more than 30 days, or if a previous refresh failed mid-way. Re-run the browser OAuth flow from Part 2, update both `initial_value` fields in your YAML, flash once, and the self-sustaining chain resumes from there. !!! warning "400 `invalid_grant` after router reboot or power outage" - This is the trickiest failure mode. It happens when the device reconnects to Wi-Fi multiple times in quick succession (e.g. during a router restart), causing two parallel token refresh calls. Both use the same refresh token — one succeeds, one invalidates it. The broken token then gets saved to NVS flash and survives every reboot. + This is the trickiest failure mode. It happens when the device reconnects to Wi-Fi multiple times in quick succession (e.g. during a router restart), causing two parallel token refresh calls. Both use the same refresh token: one succeeds, one invalidates it. The broken token then gets saved to NVS flash and survives every reboot. `mode: single` on the script prevents this going forward, but if you already have a broken NVS token, here is the recovery procedure (no USB required): - **Step 1 — Get a fresh refresh token via PowerShell:** + **Step 1. Get a fresh refresh token via PowerShell:** ```powershell $b64 = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("YOUR_CLIENT_ID:YOUR_CLIENT_SECRET")) @@ -340,7 +343,7 @@ After the first flash, the `initial_value` in the YAML is never used again. The If that returns 400 too, use the browser OAuth flow from Part 2 to get a completely fresh pair. - **Step 2 — Flash 1: add an `on_boot` override** (priority 600 runs after NVS load but before Wi-Fi): + **Step 2. Flash 1: add an `on_boot` override** (priority 600 runs after NVS load but before Wi-Fi): ```yaml esphome: @@ -353,9 +356,9 @@ After the first flash, the `initial_value` in the YAML is never used again. The ESP_LOGI("oauth", ">>> Boot: token override active"); ``` - Flash OTA and wait for `HTTP Status: 200` and `Refresh token updated: xxxxxxxx-...` in the logs. Note down the full new refresh token. + Flash OTA and wait for `HTTP Status: 200` and `Refresh token updated and saved to NVS` in the logs. - **Step 3 — Flash 2: remove the override immediately** (while device is still running): Remove the entire `on_boot` block, update `initial_value` for `st_refresh_token` to the token you just noted, keep `restore_value: yes`. Flash OTA again. + **Step 3. Flash 2: remove the override immediately** (while device is still running): Remove the entire `on_boot` block, keep `restore_value: yes`, and flash OTA again. You do not need to change `initial_value`, because the device has already saved the new refresh token to NVS. The NVS now holds the correct token and the self-sustaining chain resumes. @@ -363,11 +366,11 @@ After the first flash, the `initial_value` in the YAML is never used again. The You are likely triggering the refresh from `on_boot`. The ESP-IDF HTTP stack is not ready at that point. Move to `wifi: on_connect` with a 15-second delay as shown above. !!! warning "POST body is not being sent" - Make sure you use `body: !lambda |- return std::string("...");` — plain YAML string values for `body:` are silently dropped by the ESP-IDF HTTP client. + Make sure you use `body: !lambda |- return std::string("...");`. Plain YAML string values for `body:` are silently dropped by the ESP-IDF HTTP client. --- -## Adapting for Other Apollo Devices +## Adapting for other Apollo devices The OAuth2 token block (globals, script, wifi on_connect, interval) is completely device-agnostic. Swap the `packages:` line for your device and add your own triggers: diff --git a/docs/products/h1/boot-mode.md b/docs/products/h1/boot-mode.md index 0bf8a92057..a5c9de82c0 100755 --- a/docs/products/h1/boot-mode.md +++ b/docs/products/h1/boot-mode.md @@ -1,12 +1,14 @@ --- -title: Putting The H-1 In Boot Mode +title: Putting the H-1 in boot mode 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** +## **Boot button only** + +You can enter boot mode using only the boot button. 1\. Make sure the device is not powered and see the photo above to help find the boot button @@ -14,7 +16,9 @@ This will cover how to put the H-1 into boot mode. Sometimes, this is needed to 3\. Continue with [uploading the firmware](https://wiki.apolloautomation.com/products/h1/reflash/) -## **Boot and Reset Buttons** +## **Boot and reset buttons** + +You can also enter boot mode with the boot and reset buttons while the device is plugged in. 1\. Plug in the device diff --git a/docs/products/h1/faq.md b/docs/products/h1/faq.md index 8a65b1b7f9..a39673f2dc 100755 --- a/docs/products/h1/faq.md +++ b/docs/products/h1/faq.md @@ -6,7 +6,7 @@ description: Frequently asked questions about the H-1. 1\. **What songs are pre-loaded on the Apollo H-1?** -* The H-1 comes with three classic holiday songs: Sleigh Bells, Rudolph the Red-Nosed Reindeer, and Let it Snow. You can play these songs by pressing the gold button on the back of the ornament—one press for Sleigh Bells, two for Rudolph the Red-Nosed Reindeer, and three for Let it Snow. Each song is paired with a unique LED effect for added festive flair. +* The H-1 comes with three classic holiday songs: Sleigh Bells, Rudolph the Red-Nosed Reindeer, and Let it Snow. You can play these songs by pressing the gold button on the back of the ornament: one press for Sleigh Bells, two for Rudolph the Red-Nosed Reindeer, and a long press for Let it Snow. Each song is paired with a unique LED effect for added festive flair. 2\. **Can I customize the songs and LED effects?** @@ -37,13 +37,13 @@ description: Frequently asked questions about the H-1. 8\. **Does the ornament require any additional power source?** -* The Apollo H-1 can operate on battery power, making it easy to hang and place wherever you'd like in your holiday decorations. It uses a (rechargeable) RC-CR123A aka 16340 battery (ideally 850mAh). It can also be powered by the USB-C port. The H-1 USB-C port will NOT charge the battery, you need an external charger. +* The Apollo H-1 can operate on battery power, so you can hang and place it wherever you'd like in your holiday decorations. It uses a (rechargeable) RC-CR123A aka 16340 battery (ideally 850mAh). It can also be powered by the USB-C port. The H-1 USB-C port will NOT charge the battery, you need an external charger. 9\. **Can I gift the Apollo H-1 to friends or family?** * Yes, the H-1 makes a wonderful gift! It’s unique, festive, and supports a good cause, making it a great option for holiday gifting. -10\. **My H-1 is draining battery too fast- how do I fix this?** +10\. **My H-1 is draining battery too fast. How do I fix this?** * Please make sure if you are on the smart firmware to disable the "prevent sleep" option on the Home Assistant device page! diff --git a/docs/products/h1/getting-started.md b/docs/products/h1/getting-started.md index 1afba2ea1a..10f42e85e6 100755 --- a/docs/products/h1/getting-started.md +++ b/docs/products/h1/getting-started.md @@ -1,7 +1,9 @@ --- -title: H-1 Getting Started +title: H-1 getting started description: H-1 Getting Started tutorial. --- +Follow these steps to power up your ornament, play its pre-loaded songs, and optionally add it to Home Assistant. + 1\. Power Up the H-1: 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! diff --git a/docs/products/h1/introduction.md b/docs/products/h1/introduction.md index 8f32bde4b3..61ba4bff20 100755 --- a/docs/products/h1/introduction.md +++ b/docs/products/h1/introduction.md @@ -1,12 +1,12 @@ --- -title: H-1 Introduction +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. -The H-1 is pre-flashed with a playful firmware featuring three classic holiday songs. With just a press of the gold button on the back, you can enjoy the tunes with synchronized LED effects: one press for Sleigh Bells, two presses for Rudolph the Red-Nosed Reindeer, and long press for Let it Snow. Each song brings its own light show, making the H-1 both fun and festive right out of the box. +The H-1 is pre-flashed with a playful firmware featuring three classic holiday songs. With a press of the gold button on the back, you can enjoy the tunes with synchronized LED effects: one press for Sleigh Bells, two presses for Rudolph the Red-Nosed Reindeer, and long press for Let it Snow. Each song brings its own light show, making the H-1 both fun and festive right out of the box. For those looking to personalize their experience, the H-1 can also be integrated with Home Assistant, transforming it into a “smart” ornament. Through this setup, you can customize songs, LED effects, and create unique holiday automations to suit your style. diff --git a/docs/products/h1/reflash.md b/docs/products/h1/reflash.md index cb9ac41756..bdde6a66ea 100755 --- a/docs/products/h1/reflash.md +++ b/docs/products/h1/reflash.md @@ -1,34 +1,56 @@ --- -title: Factory Re-Flash H-1 -description: Step by step guide for re-flashing the H-1 back to factory firmware. +title: Factory re-flash H-1 +description: Step-by-step guide to re-flashing the H-1 back to its factory firmware from Chrome or Edge. --- -If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can upload a fresh set of firmware by following the below guide. The utility does need to be run from Chrome or Edge. +# Factory re-flash H-1 -If your device has already been connected to Home Assistant previously please refer to Removing Device From Home Assistant first before proceeding +If your Apollo H-1 becomes unresponsive and you've exhausted the other troubleshooting methods, you can upload a fresh set of firmware to it by following this guide. -1. Hold the boot button then plug your sensor into your computer with a quality USB-C cable that supports data transfer. Let go of the boot button once you plug the USB cable in! -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. +!!! note "Before you start" + + - Use Chrome or Edge. The install utility needs to run from one of them. + - Already added this H-1 to Home Assistant? [Remove it from Home Assistant](../../general/troubleshooting/removing-device-from-home-assistant/) first, then come back here. + +Follow these steps to flash fresh firmware onto your H-1 and find it again in Home Assistant. + +1\. Hold the boot button, then plug your H-1 into your computer with a quality USB-C cable that supports data transfer. Let go of the boot button once the USB cable is plugged in. + +2\. Open our [H-1 install page](https://apolloautomation.github.io/H-1/) and click **Connect**. + +3\. Select your Apollo device and click **Connect**. It shows with a name similar to the one below. If you aren't sure which device it is, unplug the H-1 and see which one 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. +!!! tip "No device in the list?" + + Click **Cancel**, then install the recommended driver that shows on the popup. If you've installed the driver and tried different cables and it still won't work, [put the H-1 in bootloader mode](https://wiki.apolloautomation.com/products/h1/boot-mode/) and then retry step 3. -4\. Choose to install the new firmware +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. +*Shown with the MSR-1 installer; the H-1 installer looks the same.* + +!!! warning "Seeing the error below?" + + If the installer shows this error, complete the [H-1 boot mode guide](https://wiki.apolloautomation.com/products/h1/boot-mode/) and go back to step 3. + +  + + *Shown with the MSR-1 installer; the H-1 shows the same error.* + +5\. Wait for the installer to finish. If you see "ERROR Logger is not configured!", that's 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! +*Shown with the MSR-1 installer; the H-1 installer looks the same.* + +6\. Unplug your H-1 and plug it back in to leave boot mode. **Don't skip this step.** The H-1 stays in boot mode until you do. -1. After finishing, check for the Apollo hotspot and connect. This might not show if you previously had the H-1 connected to your Wi-Fi -2. Log into Home Assistant and go to the ESPHome app check to see if you can adopt the device. +7\. Check for the Apollo hotspot and connect to it. The hotspot might not show if your H-1 was connected to your Wi-Fi before. - [](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) +8\. Log into Home Assistant, go to the ESPHome app, and check whether you can adopt the device. -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. +[](https://my.home-assistant.io/redirect/supervisor_app/?app=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) - \ No newline at end of file +Your H-1 is now running a fresh set of firmware. diff --git a/docs/products/h1/reviews.md b/docs/products/h1/reviews.md index 1abea53cca..9e84593187 100755 --- a/docs/products/h1/reviews.md +++ b/docs/products/h1/reviews.md @@ -1,5 +1,5 @@ --- -title: H-1 Reviews +title: H-1 reviews description: H-1 Reviews. --- # Simon Says Home Assistant diff --git a/docs/products/h2/faq.md b/docs/products/h2/faq.md index 761b21f261..4b7722cc0f 100755 --- a/docs/products/h2/faq.md +++ b/docs/products/h2/faq.md @@ -4,7 +4,7 @@ description: Frequently asked questions about the H-2. --- 1\. **What songs are pre-loaded on the Apollo H-2?** -* The H-2 comes with four classic holiday songs: Sleigh Bells, Rudolph the Red-Nosed Reindeer, Let it Snow, and White Christmas. You can play these songs by pressing the 4 different gold buttons on the back of the ornament. Each song is paired with a unique LED effect for added festive flair. +* The H-2 comes with four classic holiday songs: Jingle Bells, Rudolph the Red-Nosed Reindeer, Let it Snow, and Blue Christmas. You can play these songs by pressing the 4 different gold buttons on the back of the ornament. Each song is paired with a unique LED effect for added festive flair. 2\. **Can I customize the songs and LED effects?** @@ -32,13 +32,13 @@ description: Frequently asked questions about the H-2. 8\. **Does the ornament require any additional power source?** -* The Apollo H-2 can operate on battery power, making it easy to hang and place wherever you'd like in your holiday decorations. It uses a 16340 rechargeable battery. It can also be powered by the USB-C port. The H-2 USB-C port will not charge the battery. You need a dedicated 16340 charger such as this nitecore model. +* The Apollo H-2 can operate on battery power, so you can hang and place it wherever you'd like in your holiday decorations. It uses a 16340 rechargeable battery. It can also be powered by the USB-C port. The H-2 USB-C port will not charge the battery. You need a dedicated 16340 charger such as this nitecore model. 9\. **Can I gift the Apollo H-2 to friends or family?** * Yes, the H-2 makes a wonderful gift! It’s unique, festive, and supports a good cause, making it a great option for holiday gifting. -10\. **My H-2 is draining battery too fast- how do I fix this?** +10\. **My H-2 is draining battery too fast. How do I fix this?** * Please make sure if you are on the smart firmware to disable the "prevent sleep" option on the Home Assistant device page! diff --git a/docs/products/h2/h2-reviews.md b/docs/products/h2/h2-reviews.md index 87be955321..6337ca685d 100755 --- a/docs/products/h2/h2-reviews.md +++ b/docs/products/h2/h2-reviews.md @@ -1,26 +1,29 @@ --- -title: H-2 Reviews -description: H-2 Reviews. +title: H-2 reviews +description: Video reviews from smart home YouTube creators of the Apollo H-1, the first edition of Apollo's holiday ornament. --- +# H-2 reviews -these need to be updated + -# Simon Says Home Assistant +The [Apollo H-2](../introduction/) is the second edition of Apollo's annual holiday ornament. The reviews below cover the first edition, the Apollo H-1, and also appear on the [H-1 reviews](../../h1/reviews/) page. + +## Simon Says Home Assistant -##
Michael Lean +## Michael Leen -##
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/introduction.md b/docs/products/h2/introduction.md index 63e5c9d404..1d20af568d 100755 --- a/docs/products/h2/introduction.md +++ b/docs/products/h2/introduction.md @@ -1,5 +1,5 @@ --- -title: H-2 Introduction +title: H-2 introduction description: H-2 Introduction. --- @@ -8,7 +8,7 @@ description: H-2 Introduction. The Apollo H-2 is the second edition of our annual holiday ornament! It's our way of saying thank you for your support and giving back to our community. -The H-2 ships pre-flashed with a basic firmware featuring four classic holiday tunes. Simply press any of the four buttons on the back to play: Button 1 for Jingle Bells, Button 2 for Rudolph the Red-Nosed Reindeer, Button 3 for Let it Snow, and Button 4 for Blue Christmas. The LEDs light up with unique effects to match each tune! +The H-2 ships pre-flashed with a basic firmware featuring four classic holiday tunes. Press any of the four buttons on the back to play: Button 1 for Jingle Bells, Button 2 for Rudolph the Red-Nosed Reindeer, Button 3 for Let it Snow, and Button 4 for Blue Christmas. The LEDs light up with unique effects to match each tune! You can also integrate it with Home Assistant to unlock more features, such as changing the songs and LED effects, Bluetooth proxy, and Bluetooth tracking. You will need to reflash it to the smart firmware first! diff --git a/docs/products/h2/setup/getting-started.md b/docs/products/h2/setup/getting-started.md index 47d8767876..9650bfd48b 100755 --- a/docs/products/h2/setup/getting-started.md +++ b/docs/products/h2/setup/getting-started.md @@ -1,8 +1,10 @@ --- -title: H-2 Getting Started +title: H-2 getting started description: H-2 Getting Started tutorial. --- -# Getting Started +# Getting started + +Follow these steps to power up your ornament, play its pre-loaded songs, and optionally add it to Home Assistant. **1\. Powering On the H-2** @@ -16,9 +18,13 @@ If the device is in sleep mode, press one of the gold buttons on the back to wak **3\. Play Holiday Songs** -After the ornament is awake, press the gold buttons (see image below) to play a pre-loaded song: +After the ornament is awake, press one of the four gold buttons to play a pre-loaded song. The buttons are on the back of the H-2, one at the tip of each side arm. + + + +Each button plays one of these songs: -* **Button 1:** Sleigh Bells +* **Button 1:** Jingle Bells * **Button 2:** Rudolph the Red-Nosed Reindeer * **Button 3:** Let It Snow * **Button 4:** Blue Christmas diff --git a/docs/products/h2/troubleshooting/boot-mode.md b/docs/products/h2/troubleshooting/boot-mode.md index fda8f96739..6ccca32fbb 100755 --- a/docs/products/h2/troubleshooting/boot-mode.md +++ b/docs/products/h2/troubleshooting/boot-mode.md @@ -1,18 +1,20 @@ --- -title: Putting The H-2 In Boot Mode +title: Putting the H-2 in boot mode description: Step by step guide for putting The H-2 In Boot Mode. --- !!! info "This will cover how to put the H-2 into boot mode." This is needed to force the device into boot mode to reflash the firmware. -## **Boot Button Only** +## **Boot button only** + +You can enter boot mode using only the boot button. !!! tip "Make sure that the battery is removed prior to putting it in boot mode" - Make sure that there is no battery in the device - the battery will prevent it from entering boot mode. + Make sure that there is no battery in the device. The battery will prevent it from entering boot mode. -1\. Disconnect your H-2 from power. With the device facing you, locate the boot button—it’s the small black button on the right. +1\. Disconnect your H-2 from power. With the device facing you, locate the boot button. It’s the small black button on the right. 2\. Plug in a USB cable that supports power and data into your computer. @@ -24,7 +26,9 @@ description: Step by step guide for putting The H-2 In Boot Mode. [Click here to go to the reflashing guide!](https://wiki.apolloautomation.com/products/h2/troubleshooting/reflash/){ .md-button .md-button--primary } -## **Boot and Reset Buttons** +## **Boot and reset buttons** + +You can also enter boot mode with the boot and reset buttons while the device is plugged in. 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. diff --git a/docs/products/h2/troubleshooting/reflash.md b/docs/products/h2/troubleshooting/reflash.md index a3519beeed..b5a65f9302 100755 --- a/docs/products/h2/troubleshooting/reflash.md +++ b/docs/products/h2/troubleshooting/reflash.md @@ -1,14 +1,14 @@ --- -title: Factory Re-Flash H-2 +title: Factory re-flash H-2 description: Step by step guide for re-flashing the H-2 back to factory firmware. --- -# Reflashing The H-2 +# Reflashing the H-2 !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser. -1\. Disconnect your H-2 from power. With the device facing you, locate the boot button - it’s the small black button on the right. +1\. Disconnect your H-2 from power. With the device facing you, locate the boot button. It’s the small black button on the right. 2\. Plug in a USB cable that supports power and data into your computer. diff --git a/docs/products/h3/introduction.md b/docs/products/h3/introduction.md index 8cf3beeb95..127bf0f724 100644 --- a/docs/products/h3/introduction.md +++ b/docs/products/h3/introduction.md @@ -1,5 +1,5 @@ --- -title: H-3 Introduction +title: H-3 introduction description: "H-3 Introduction." --- **Can be powered by USB-C or two AA batteries.** We suggest non-rechargeable AAs. diff --git a/docs/products/h3/setup/getting-started.md b/docs/products/h3/setup/getting-started.md index 95c4e2bf1c..f8a25cded6 100644 --- a/docs/products/h3/setup/getting-started.md +++ b/docs/products/h3/setup/getting-started.md @@ -1,8 +1,10 @@ --- -title: H-3 Getting Started +title: H-3 getting started description: "H-3 Getting Started tutorial." --- -# Getting Started +# Getting started + +Follow these steps to power up your ornament, play its holiday songs, and optionally add it to Home Assistant. **1\. Powering On the H-3** diff --git a/docs/products/h3/troubleshooting/boot-mode.md b/docs/products/h3/troubleshooting/boot-mode.md index c33460fda6..bb47820ee0 100644 --- a/docs/products/h3/troubleshooting/boot-mode.md +++ b/docs/products/h3/troubleshooting/boot-mode.md @@ -1,5 +1,5 @@ --- -title: Putting The H-3 In Boot Mode +title: Putting the H-3 in boot mode description: "Step by step guide for putting the H-3 in boot mode." --- Boot mode is what lets you reflash the firmware over USB. You need it to move between the basic firmware and the smart firmware, and to recover an ornament that has stopped responding. diff --git a/docs/products/h3/troubleshooting/reflash.md b/docs/products/h3/troubleshooting/reflash.md index 67b6787325..cf0b1ba54b 100644 --- a/docs/products/h3/troubleshooting/reflash.md +++ b/docs/products/h3/troubleshooting/reflash.md @@ -1,8 +1,8 @@ --- -title: Factory Re-Flash H-3 +title: Factory re-flash H-3 description: "Step by step guide for re-flashing the H-3 back to factory firmware." --- -# Reflashing The H-3 +# Reflashing the H-3 !!! info "Reflash the H-3 if it stops responding, or to move between the basic and smart firmware." 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 fe41ac099c..fa4e186063 100755 --- a/docs/products/led1/examples/led-1-controlling-govee-lights.md +++ b/docs/products/led1/examples/led-1-controlling-govee-lights.md @@ -1,61 +1,55 @@ --- -title: LED-1 Controlling Govee Lights +title: LED-1 controlling Govee lights description: >- - How to use the Apollo LED-1 to control your Govee/3rd Party permanent outdoor - LED lights! + Use the Apollo LED-1 to control Govee or other third-party permanent outdoor + LED lights fully locally, without 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. +# Controlling Govee lights with the LED-1 -1\. Items we will need for this project. + + +This guide shows you how to use the Apollo LED-1 to control your Govee permanent outdoor lights fully locally, without a cloud-based app. So far, the steps cover preparing a project box, wiring power into the LED-1, and preparing the LED cable. + +!!! note "This guide is still being written" + + The steps below get the LED-1 connected. More steps are coming. + +1\. Gather the parts and tools 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 +**Parts** + +- [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) +- [Waterproof sealant](https://www.amazon.com/DAP-18387-Flexible-Purpose-Waterproof/dp/B07JNX6LB1?crid=1L3FXWGEC0AD0&dib=eyJ2IjoiMSJ9.MgTYKMsWiIbFqfkK51cOTUX07s4VqXsG3SpWV-uQDUcsj78Afwg3otaP63d8RayUsmSKqm0QPDW-PCWyZYN1\_r7Qy19p9mD5UaZ\_9xRHqBlvFjW4qJONw8-J7gAP4d9sjD1-\_0-LbuupmNKwFEcJG1tzYmq2yo8Cz7MGzXygPppPOliBbbqNcCJ36tttsN7aeUek8G2nCsO5NRQuMFukLUnlmooIMga88MChiJ7EH7c.gn06pZFOuf3lvwtZYCBbM-jfr7Htp\_GiPG1vw-vMr5I&dib\_tag=se&keywords=Ultra%2BClear%2B5%2Boz.%2BAll%2BPurpose%2BWaterproof%2BSealant&qid=1762895638&sprefix=ultra%2Bclear%2B5%2Boz.%2Ball%2Bpurpose%2Bwaterproof%2Bsealant%2Caps%2C108&sr=8-3&th=1) -\- **Project box:** https://www.amazon.com/dp/B075DJDT99?ref=fed\_asin\_title&th=1 +**Tools** -\- **Waterproof sealant:** https://www.amazon.com/DAP-18387-Flexible-Purpose-Waterproof/dp/B07JNX6LB1?crid=1L3FXWGEC0AD0&dib=eyJ2IjoiMSJ9.MgTYKMsWiIbFqfkK51cOTUX07s4VqXsG3SpWV-uQDUcsj78Afwg3otaP63d8RayUsmSKqm0QPDW-PCWyZYN1\_r7Qy19p9mD5UaZ\_9xRHqBlvFjW4qJONw8-J7gAP4d9sjD1-\_0-LbuupmNKwFEcJG1tzYmq2yo8Cz7MGzXygPppPOliBbbqNcCJ36tttsN7aeUek8G2nCsO5NRQuMFukLUnlmooIMga88MChiJ7EH7c.gn06pZFOuf3lvwtZYCBbM-jfr7Htp\_GiPG1vw-vMr5I&dib\_tag=se&keywords=Ultra%2BClear%2B5%2Boz.%2BAll%2BPurpose%2BWaterproof%2BSealant&qid=1762895638&sprefix=ultra%2Bclear%2B5%2Boz.%2Ball%2Bpurpose%2Bwaterproof%2Bsealant%2Caps%2C108&sr=8-3&th=1
\- **Screwdriver**
\- **Wire strippers**
\- **Hobby knife**
\- **Tweezers** +- Screwdriver +- Wire strippers +- Hobby knife +- Tweezers -2\. Remove the project box lid by unscrewing the 4 screws. +2\. Unscrew the 4 screws and remove the project box lid.  -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. +3\. Remove two of the rubber grommets. Use the hobby knife to cut a small slit in each one for the power and data connections. For an outdoor setup, the two bottom grommets might be best, to help keep water from getting in.  -4\. Connect the barrel plug to the WAGO connector. It is the large white component 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. +4\. Connect the barrel plug to the WAGO connector, the large white component at 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. To insert each wire, use the tweezers to press down 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. +5\. Use the hobby knife to remove the cable sheathing from the 3-pin LED connector. Cut carefully, because the cable can roll.   -6\. - - - -7\. - - - -8\. - - - -9\. - - - -10\. - - - - - - - - \ No newline at end of file +You've finished the steps written so far: the grommets are cut, the barrel plug is wired to the LED-1, and the 3-pin LED connector is stripped and ready. diff --git a/docs/products/led1/faq.md b/docs/products/led1/faq.md index 27f8ca780f..e649b706af 100755 --- a/docs/products/led1/faq.md +++ b/docs/products/led1/faq.md @@ -19,7 +19,7 @@ description: Frequently asked questions about the LED-1 controller. 4\. **How does the microphone work?** -* Audio-reactive WLED is built into the WLED firmware we ship with the LED-1. Just make sure to enable it from the "info" pane and then try using an effect with the little Musical Note Image next to them! +* Audio-reactive WLED is built into the WLED firmware we ship with the LED-1. Make sure to enable it from the "info" pane and then try using an effect with the little Musical Note Image next to them! 5\. **My LEDs are the wrong color how do I fix it?** diff --git a/docs/products/led1/introduction.md b/docs/products/led1/introduction.md index 6fc998d72d..8919a51b27 100755 --- a/docs/products/led1/introduction.md +++ b/docs/products/led1/introduction.md @@ -6,11 +6,11 @@ description: Documentation for LED-1, including setup, usage, and best practices  -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. +The Apollo LED-1 is a compact, versatile LED Controller for Home Assistant. Fully open-source and expandable, the LED-1 integrates 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. **Key Features:** * Powered via either USB-C (5 V only), USB-C PD (5 V or 12 V) or external power supply (5 V, 12 V, or 24 V). -* Two fused outputs able to handle 10 Amps total - either from one output or both but max of 10 Amps. +* Two fused outputs able to handle 10 Amps total, either from one output or both but max of 10 Amps. * Built in MEMS digital microphone for WLED Audio Reactive functionality. * Built in relay to kill power to LEDs for less power usage (great for battery projects). \ 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 f66166414a..f5d0bac980 100755 --- a/docs/products/led1/setup/getting-started-led1.md +++ b/docs/products/led1/setup/getting-started-led1.md @@ -1,69 +1,89 @@ --- -title: Getting Started -description: Getting started with your new LED-1! +title: Getting started +description: Power your LED-1, wire up your LED strips, and connect it to Wi-Fi and Home Assistant. --- -# Getting Started +# Getting started -Congrats on your new LED-1! Below we will go through steps to get you up and running in no time. +Congrats on your new Apollo LED-1! This guide walks you through powering it, wiring up your LEDs, and connecting it to Wi-Fi. ## 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. +You can power the LED-1 in three ways: + +- **USB Power**: 5V, up to 3 amps +- **USB Power Delivery**: 5V or 12V, up to 3 amps +- **External Power Supply**: a dedicated power supply using either 5V, 12V, or 24V + +Pick the tab that matches your setup. === "USB Power" - 1\. Connect a USB-C cable to a 5V 3A or larger power supply and the other end into your LED-1. We suggest using a quality USB-C cable that can handle 3 amps or larger. If you are not sure if yours supports 3 amps, buy a new cable from our store or a reputable one off of Amazon, Monoprice, etc. + 1\. Connect a USB-C cable to a 5V 3A or larger power supply, and plug the other end into your LED-1. - !!! warning "Unplug the power!" + !!! tip "Use a cable rated for 3 amps" - Before proceeding to the next steps, make sure to unplug your device! + We suggest a quality USB-C cable that can handle 3 amps or more. If you're not sure whether yours supports 3 amps, buy a new cable from our store or a reputable seller such as Amazon or Monoprice. === "USB Power Delivery" - 1\. Decide if you are using 5V or 12V with USB-C PD. If you are using 12V, you will need to first flip the switch as shown below. If you are using 5V, skip to the next step! + 1\. Decide whether you're using 5V or 12V with USB-C PD. If you're using 12V, first flip the switch on the LED-1 board (the board render on the [LED-1 introduction](../../introduction/) page shows where it is). If you're using 5V, skip to the next step. - 2\. Connect your USB-C PD wall charger to the USB-C cable and then plug in the other end into the USB-C port of the LED-1. + 2\. Connect your USB-C PD wall charger to the USB-C cable, then plug the other end into the USB-C port of the LED-1. - 3\. Your device will now output either 5V or 12V to the + and - terminals for Output 1 and Output 2 of the LED-1. + Your LED-1 now outputs either 5V or 12V to the + and - terminals of Output 1 and Output 2. - !!! warning "Unplug the power!" +=== "External Power Supply" - Before proceeding to the next steps, make sure to unplug your device! + An external power supply is the best way to get the longest distance and the most power out of your device. You can get up to 10 amps of power at 5V, 12V, or 24V. -=== "External Power Supply" + 1\. Connect your power supply's output wires to the input terminals of your LED-1. Be very careful to connect the positive red wire to the + sign and the negative black wire to the - sign. + + If you still need a power supply, check out our power supply suggestions. - The External Power Supply is the best way to get the longest distance and power out of your device. You can get up to 10amps of power at 5V, 12V, or 24V using an external power supply! + !!! tip "Cut off the barrel connector" - 1\. Take your power supply and connect the output power to the input terminals of your LED-1. If you still need a power supply, check out our suggestions here. Be very careful and make sure you are connecting the positive red wire to the + sign and the negative black wire to the - sign. Most power supplies will have a barrel connector only rated for 3 amps on it, so we suggest that you cut the barrel connector off and split out the red and black wires to put directly into the LED-1. + Most power supplies have a barrel connector that's only rated for 3 amps. We suggest cutting the barrel connector off and splitting out the red and black wires to put directly into the LED-1. - !!! warning "Unplug the power!" +!!! warning "Unplug the power!" - Before proceeding to the next steps, make sure to unplug your device! + Before you move on to wiring up your LEDs, make sure to unplug your LED-1. ## Wire up LEDs -!!! danger "Before proceeding, consider double checking your power supply and leds use the same voltage!" +!!! danger "Use LEDs that match your power supply's voltage" - The LED-1 will output the same voltage that is input to the device, so make sure to connect 5V led strips if you're using a 5V power supply - same with 12V and 24V! + The LED-1 outputs the same voltage that is input to the device. It protects itself, but not the LED strips connected to it. Connect 5V LED strips if you're using a 5V power supply, and do the same with 12V and 24V. -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. +Next, connect your LED strip to the first output of the LED-1. + +1\. Grab a male JST-SM 3-pin connector, such as the extra one included with your LED strips. Carefully note which wire is which: red is positive, green is data, and white is 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. +2\. Find the two WAGO connectors on the LED-1 labeled "Output 1" and "Output 2". Insert the wires into Output 1: + +- Red power wire: far left terminal of Output 1 +- Green data wire: middle terminal of Output 1 +- White ground wire: third terminal of Output 1 + +3\. If you have a second LED strip, repeat step 2 for it using Output 2. -3\. Repeat step 2 for a second led strip using Output 2 if you have a second led strip! +Your LEDs are wired up and ready for power. ## 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! +Your device is now ready to connect to your Wi-Fi. Once it's connected, you can control it from Home Assistant, the WLED app for iPhone and Android, or a web browser. + +1\. Plug in your power supply or USB-C power. The LED-1 boots within a couple of seconds. + +2\. On your phone, open the list of available Wi-Fi networks and select **WLED-AP**. -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. +3\. Wait for the "Welcome to WLED!" page to pop up. If it doesn't, open a web browser and go to http://4.3.2.1/. You should see the same page shown below.  -## Join to Home Assistant +When the "Welcome to WLED!" page opens, you're connected to your LED-1. -1\. Your device should be auto-discovered by Home Assistant using the WLED Integration as shown below! +## Add the LED-1 to Home Assistant - \ No newline at end of file +Home Assistant should discover your LED-1 automatically using the WLED integration. diff --git a/docs/products/led1/setup/led1-general-tips.md b/docs/products/led1/setup/led1-general-tips.md index 2c3f4ed5e4..b32f27d6e3 100755 --- a/docs/products/led1/setup/led1-general-tips.md +++ b/docs/products/led1/setup/led1-general-tips.md @@ -1,10 +1,10 @@ --- -title: LED-1 General Tips +title: LED-1 general tips description: Multiple helpful tips to use your LED-1 to the fullest! --- -# General Tips +# 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/led1/setup/led1-pinout-guide.md b/docs/products/led1/setup/led1-pinout-guide.md index d9f6c3ab5b..cd49294a1e 100755 --- a/docs/products/led1/setup/led1-pinout-guide.md +++ b/docs/products/led1/setup/led1-pinout-guide.md @@ -1,8 +1,8 @@ --- -title: LED-1 Pinout Guide +title: LED-1 pinout guide description: LED-1 Pinout Guide --- -# LED-1 Pinout Guide +# LED-1 pinout guide
GPIO Pin | LED-1 PCB | Use Case |
|---|---|---|
GPIO_0 | Button | Touch button |
GPIO_13 | LED Data 1 Output | Data line for LEDs |
GPIO_15 | LED Data 2 Output | Data line for LEDs |
GPIO_22 | LED Relay | Relay for LEDs |
GPIO_12 | Pin I2S SD | Microphone SD |
GPIO_27 | Pin I2S WS | Microphone WS |
GPIO_14 | Pin I2S SCK | Microphone SCK |
GPIO_25 | Extra GPIO | Extra GPIO |
GPIO_32 | Extra GPIO | Extra GPIO |
GPIO_33 | Extra GPIO | Extra GPIO |
GND Pin | GND Pin | Exposed Ground |
5V Pin | 5V Pin | Exposed 5V |
3.3V Pin | 3.3V Pin | Exposed 3.3V |
@@ -126,7 +130,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-general-tips.md b/docs/products/m1/setup/m1-general-tips.md
index 9fab22bd57..127e9b85d8 100755
--- a/docs/products/m1/setup/m1-general-tips.md
+++ b/docs/products/m1/setup/m1-general-tips.md
@@ -1,8 +1,8 @@
---
-title: M-1 LED Matrix General Tips
+title: M-1 LED Matrix general tips
description: Multiple helpful tips to use your M-1 LED Matrix to the fullest!
---
-# General Tips
+# General tips
=== "WLED"
diff --git a/docs/products/m1/setup/m1-matrix-settings.md b/docs/products/m1/setup/m1-matrix-settings.md
index 25899a24b9..11eb885212 100755
--- a/docs/products/m1/setup/m1-matrix-settings.md
+++ b/docs/products/m1/setup/m1-matrix-settings.md
@@ -1,13 +1,13 @@
---
-title: M-1 LED Matrix Settings
+title: M-1 LED Matrix settings
description: >-
Settings needed to get your M-1 LED Matrix driving the HUB75 panel correctly.
---
-# M-1 LED Matrix Settings
+# M-1 LED Matrix settings
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.
@@ -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"
@@ -109,7 +109,7 @@ To change it, click on **Config**, then **WiFi Setup**. In the **mDNS address**
Click on **Config**, then **AudioReactive**. Check **Enabled** then select **Generic I2S** for the Type.
- 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**.
+ For the pins, select **10 digitalmic** for Pin I2S SD, **12 digitalmic** for Pin I2S WS, and **11 digitalmic** for Pin I2S SCK, then click **Save**.
diff --git a/docs/products/m1/setup/m1-multiple-panels.md b/docs/products/m1/setup/m1-multiple-panels.md
index c05edcef9d..07383c5846 100755
--- a/docs/products/m1/setup/m1-multiple-panels.md
+++ b/docs/products/m1/setup/m1-multiple-panels.md
@@ -1,8 +1,8 @@
---
-title: M-1 LED Matrix - Multiple Panel Setup
+title: M-1 LED Matrix - multiple panel setup
description: Tutorial for wiring and configuring multiple panels with your M-1 LED Matrix.
---
-# M-1 LED Matrix - Multiple Panels
+# M-1 LED Matrix - multiple panels
!!! info "Prerequisites needed for multiple panels"
@@ -14,13 +14,13 @@ Using panels you sourced yourself rather than Apollo ones? They need to match th
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!
=== "Two Panels"
- 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.
+ 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.
@@ -34,7 +34,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
=== "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.
+ 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.
@@ -48,7 +48,7 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
=== "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.
+ 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.
@@ -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"
@@ -120,6 +120,8 @@ Wiring is the same whichever firmware you run. Choose the number of panels you a
=== "WLED-MM"
+ You'll set the chain length and combined panel dimensions for your number of panels, then reboot WLED.
+
=== "Two Panels"
1\. Navigate to your WLED instance in a browser or using the WLED-native app on your phone. You can use http://your-hostname-here.local or its IP address. Click here if you need to find your IP or hostname.
@@ -174,15 +176,15 @@ 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"
Below we will create multiple Segments in WLED which we will then edit until they are set up to show the correct number of pixels for your number of panels.
- Think of segments like taking one big set of LEDs and cutting them into smaller chunks to then individually control. Segment 1 will control the top 1/4 of the display, Segment 2 will control the second 1/4, Segment 3 will control the third 1/4 and Segment 4 will control the bottom 1/4 of the matrix.
+ Think of segments like taking one big set of LEDs and cutting them into smaller chunks to then individually control. Segment 0 will control the top 1/4 of the display, Segment 1 will control the second 1/4, Segment 2 will control the third 1/4 and Segment 3 will control the bottom 1/4 of the matrix.
- You can go back later and change these to your own layout - for example maybe you want to control all of the first LED matrix with Segment 0 and the second matrix with Segment 1 you can definitely do that!
+ You can go back later and change these to your own layout. For example, maybe you want to control all of the first LED matrix with Segment 0 and the second matrix with Segment 1. You can definitely do that!
If you grew an existing setup rather than starting fresh, the default segment keeps its old bounds and your new pixels stay dark. Set **Stop X** and **Stop Y** to your new dimensions before adding any more segments.
@@ -246,7 +248,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
- 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.
+ 7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want! Scrolling text tops out at 64 characters on WLED and 32 on WLED-MM.
@@ -282,7 +284,7 @@ If you grew an existing setup rather than starting fresh, the default segment ke
- 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.
+ 7\. Test it by changing the effect to "Scrolling Text" and editing the name of each segment to be any text you want! Scrolling text tops out at 64 characters on WLED and 32 on WLED-MM.
@@ -308,7 +310,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 +320,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-segments.md b/docs/products/m1/setup/m1-segments.md
index b720288fd9..72739ca051 100755
--- a/docs/products/m1/setup/m1-segments.md
+++ b/docs/products/m1/setup/m1-segments.md
@@ -1,5 +1,5 @@
---
-title: M-1 LED Matrix Creation of Segments
+title: M-1 LED Matrix creation of segments
description: >-
Step by step guide for splitting your M-1 Matrix into multiple segments to
display more information.
@@ -10,7 +10,7 @@ description: >-
The WLED firmware on your device will allow you to split your M-1 LED Matrix (or multiple) into segments to display four or more lines of text on your matrix!
- Think of segments like taking one big set of LEDs and cutting them into smaller chunks to then individually control. Segment 1 will control the top 1/4 of the display, Segment 2 will control the second 1/4, Segment 3 will control the third 1/4 and Segment 4 will control the bottom 1/4 of the matrix.
+ Think of segments like taking one big set of LEDs and cutting them into smaller chunks to then individually control. Segment 0 will control the top 1/4 of the display, Segment 1 will control the second 1/4, Segment 2 will control the third 1/4 and Segment 3 will control the bottom 1/4 of the matrix.
Segments work the same on WLED and WLED-MM. The steps below split a single 64x64 panel into four bands. On a larger layout, use your full width for **Stop X** and divide your height instead, which [Multiple Panels](/products/m1/setup/m1-multiple-panels.md) covers per arrangement.
diff --git a/docs/products/m1/setup/m1-wall-mounting.md b/docs/products/m1/setup/m1-wall-mounting.md
index 0923a60a4a..c5c3d611b7 100644
--- a/docs/products/m1/setup/m1-wall-mounting.md
+++ b/docs/products/m1/setup/m1-wall-mounting.md
@@ -1,9 +1,9 @@
---
-title: Wall Mounting your M-1 Panels
+title: Wall mounting your M-1 panels
description: >-
How to print the M-1 LED Matrix frames, screw your panels into them, and hang the finished panel on a wall.
---
-# Wall Mounting your M-1 Panels
+# Wall mounting your M-1 panels
The printed frames wrap the edges of a panel and screw into the mounting holes on its back. Every panel gets its own frame, and small joiners bridge the seams where panels meet, so a row or a grid ends up as one flat piece you can hang on a wall.
@@ -12,7 +12,7 @@ Download the files from the -
Step by step guide for finding the IP address and the hostname of your M-1
device.
---
-# How to Find IP address and hostname of your M-1 device.
+# How to find IP address and hostname of your M-1 device.
+
+You'll use the WLED Native app to find your device's IP address and hostname.
1\. Download the WLED Native app for iOS and Android.
diff --git a/docs/products/m1/troubleshooting/m1-panel-faults.md b/docs/products/m1/troubleshooting/m1-panel-faults.md
index b3a4fd48c9..1cfd97fc0a 100644
--- a/docs/products/m1/troubleshooting/m1-panel-faults.md
+++ b/docs/products/m1/troubleshooting/m1-panel-faults.md
@@ -1,8 +1,8 @@
---
-title: M-1 Panel Troubleshooting
+title: M-1 panel troubleshooting
description: Match what your M-1 panel is showing to the likely cause and the fix.
---
-# M-1 Panel Troubleshooting
+# M-1 panel troubleshooting
Find what you are seeing in the table below and work top to bottom. The first row that matches is usually the cause.
@@ -23,7 +23,7 @@ If the display is wrong on more than one count, or nothing above matches, run th
If the symptom survives a full reinstall, it is worth contacting support with a photo of the panel.
-## Factory Reset
+## Factory reset
On WLED, holding the button for ten seconds resets the M-1 to factory settings, including the display size, without needing a computer. You will need to reconnect it to Wi-Fi afterward.
diff --git a/docs/products/m1/troubleshooting/m1-reflash-esphome.md b/docs/products/m1/troubleshooting/m1-reflash-esphome.md
index b447df5e2b..a4373cae01 100644
--- a/docs/products/m1/troubleshooting/m1-reflash-esphome.md
+++ b/docs/products/m1/troubleshooting/m1-reflash-esphome.md
@@ -8,6 +8,8 @@ description: Step by step guide for reflashing the M-1 with the hub75-studio ESP
All M-1 units currently being sold are Rev6. On the hub75-studio installer, select the **Rev6** firmware before clicking **Connect**.
+You'll put the controller into boot mode and reflash it with the hub75-studio ESPHome firmware from your browser.
+
1\. Plug a USB-C cable that supports power and data into your computer.
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.
diff --git a/docs/products/m1/troubleshooting/m1-reflash.md b/docs/products/m1/troubleshooting/m1-reflash.md
index 6f03a5650d..6a37ed0b93 100755
--- a/docs/products/m1/troubleshooting/m1-reflash.md
+++ b/docs/products/m1/troubleshooting/m1-reflash.md
@@ -1,8 +1,8 @@
---
-title: Factory Re-Flash M-1
+title: Factory re-flash M-1
description: Step by step guide for re-flashing the M-1 back to factory firmware.
---
-# Factory Re-Flash M-1
+# Factory re-flash M-1
!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below."
diff --git a/docs/products/msr1/additional-info/bluetooth-proxy.md b/docs/products/msr1/additional-info/bluetooth-proxy.md
index 95f1506b52..f9574261eb 100644
--- a/docs/products/msr1/additional-info/bluetooth-proxy.md
+++ b/docs/products/msr1/additional-info/bluetooth-proxy.md
@@ -1,8 +1,8 @@
---
-title: MSR-1 Bluetooth Proxy
+title: MSR-1 Bluetooth proxy
description: Tutorial for how to turn your MSR-1 into a BLE proxy!
---
-# MSR-1 Bluetooth Proxy
+# MSR-1 Bluetooth proxy
--8<-- "_snippets/bluetooth-proxy/intro.md"
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 48071b407a..a9564d9fab 100755
--- a/docs/products/msr1/addons/adding-co2-to-msr-1.md
+++ b/docs/products/msr1/addons/adding-co2-to-msr-1.md
@@ -1,8 +1,10 @@
---
-title: Adding CO₂ To MSR-1
+title: Adding CO₂ to MSR-1
description: "Fit the CO2 module to your MSR-1, with photos showing the connector orientation at each step."
---
-# Adding CO2 To MSR-1
+# Adding CO2 to MSR-1
+
+You'll open your sensor, fit the CO2 module onto its board, and close the case back up.
1\. Unplug your MSR-1 from power and remove the back
diff --git a/docs/products/msr1/examples/msr-1-automation-guide.md b/docs/products/msr1/examples/msr-1-automation-guide.md
index b08e40cec2..67c0328cbd 100755
--- a/docs/products/msr1/examples/msr-1-automation-guide.md
+++ b/docs/products/msr1/examples/msr-1-automation-guide.md
@@ -1,6 +1,11 @@
---
-title: MSR-1 Automation Guide
-description: "A walkthrough of building Home Assistant automations around the MSR-1."
+title: MSR-1 automation guide
+description: "Where to find MSR-1 automation guides, from an Alarmo security system to the buzzer and the example repository on GitHub."
---
-# MSR-1 Automation Guide
+# MSR-1 automation guide
+A full automation walkthrough for the Apollo MSR-1 isn't on this page yet. In the meantime, these guides show you how to put your MSR-1 to work in Home Assistant:
+
+- [MSR-1 and Alarmo home security](../msr1-alarmo/): build a fully local security system from MSR-1 sensors and Alarmo, installed through HACS, that you arm and disarm from your dashboard.
+- [Using the MSR-1 buzzer](../using-msr-1-buzzer/): play a tune on the buzzer from Home Assistant, then reuse the same action in an automation.
+- [MSR-1 examples from GitHub](../msr-1-examples-from-github/): example MSR-1 configurations and automations published in the Apollo GitHub repository.
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 999250c903..6dfbe872b8 100755
--- a/docs/products/msr1/examples/msr-1-examples-from-github.md
+++ b/docs/products/msr1/examples/msr-1-examples-from-github.md
@@ -1,7 +1,9 @@
---
-title: MSR-1 Examples From GitHub
+title: MSR-1 examples from GitHub
description: "Example MSR-1 configurations and automations published in the Apollo GitHub repository."
---
-# MSR-1 Examples From GitHub
+# 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
+The Apollo MSR-1 GitHub repository has an Examples folder with example MSR-1 configurations and automations. Browse it for a starting point you can adapt to your own home.
+
+[Browse MSR-1 examples on GitHub](https://github.com/ApolloAutomation/MSR-1/tree/main/Examples){ .md-button .md-button--primary }
diff --git a/docs/products/msr1/examples/msr1-alarmo.md b/docs/products/msr1/examples/msr1-alarmo.md
index f7a11b7e6c..101ad344eb 100755
--- a/docs/products/msr1/examples/msr1-alarmo.md
+++ b/docs/products/msr1/examples/msr1-alarmo.md
@@ -1,48 +1,71 @@
---
-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."
+title: MSR-1 and Alarmo home security
+description: "Build a fully local home security system in Home Assistant from MSR-1 sensors and Alarmo, installed through HACS, with phone alerts and sensor lights that turn on when the alarm is triggered."
---
-# MSR-1 + Alarmo Home Security Install
+# MSR-1 and Alarmo home security
-My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo integration, quickly allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA.
+This setup started with a grandmother who wanted an alert if anything moved in her home after she had gone to bed. Three Apollo MSR-1 mmWave sensors and the Alarmo integration gave her a fully local, private, cloud-free security system with no monthly subscription, and she arms and disarms it with one button on her Home Assistant dashboard. Follow the steps below to build the same system in your home.
-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)
+!!! note "Before you start"
-The first button opens Alarmo in HACS and the second opens the Alarmo Card:
+ Your MSR-1, or another motion or presence sensor, is already set up in Home Assistant. If it isn't, follow the [MSR-1 getting started guide](../../../general/setup/getting-started-msr1/) first.
+
+## Install Alarmo
+
+Alarmo runs the alarm system itself, and the Alarmo Card puts arm and disarm buttons on your dashboard. Both install through HACS.
+
+1\. Install [HACS](https://hacs.xyz/docs/use/download/download/) if you don't have it yet.
+
+2\. Install [Alarmo](https://github.com/nielsfaber/alarmo?tab=readme-ov-file#installation) and the [Alarmo Card](https://github.com/nielsfaber/alarmo-card). The first button below opens Alarmo in HACS, and the second opens the Alarmo Card:
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo&category=integration)
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=nielsfaber&repository=alarmo-card&category=plugin)
-Restart Home Assistant once both are installed, then add the Alarmo integration under **Settings → Devices & services → Add integration**. Alarmo shows up in the sidebar after that.
+3\. Restart Home Assistant once both are installed. The power icon is under **Settings → System**.
+
+[](https://my.home-assistant.io/redirect/system_dashboard/)
+
+4\. Add the Alarmo integration under **Settings → Devices & services → Add integration**. Alarmo shows up in the sidebar after that.
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=alarmo)
-
-
-
-
-
-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. Under 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.
-
-We hope this was helpful and please let us know if there are any questions!
\ No newline at end of file
+
+5\. Add the Alarmo Card to a dashboard: open the dashboard, click **Edit dashboard**, click **Add card**, choose **Custom: Alarmo Card**, and pick your Alarmo entity. The card shows the alarm state and the buttons to arm and disarm it.
+
+
+
+Alarmo is installed and ready to configure:
+
+
+
+## Set up your alarm
+
+Now choose which sensors trigger the alarm and what happens when they do: a notification on your phone, and your sensors' RGB lights turning on.
+
+1\. Open **Alarmo** from the sidebar, select the **Sensors** tab, and toggle on the sensor entities you want your alarm system to use.
+
+
+
+2\. Select the **Actions** tab to set up a notification. Under **Condition → Event**, select **Alarm is triggered**. Under **Task → Target**, select the device that should get the notification, such as your phone or tablet.
+
+
+
+3\. Change the **Title**, **Message**, and **Name** of the notification if you like, then save it.
+
+
+
+4\. Add a second action, for the same **Alarm is triggered** event, to turn on your sensor lights. Under **Entity**, select each sensor's RGB light.
+
+
+
+5\. Under **Action**, select **Turn On**. Your sensors' RGB lights now turn on when the alarm is triggered.
+
+
+
+That's it. You now have a free, local security system that you arm and disarm from your dashboard.
+
+!!! tip "Add an alarm sound"
+
+ The second action can also make the onboard piezo buzzer on each MSR-1 play an alarm sound. To learn how to play a tune on the buzzer, see [Using the MSR-1 buzzer](../using-msr-1-buzzer/).
+
+We hope this was helpful. If you have any questions, let us know!
diff --git a/docs/products/msr1/examples/msr1-dashboards.md b/docs/products/msr1/examples/msr1-dashboards.md
index fed4a07507..549bb03b7b 100755
--- a/docs/products/msr1/examples/msr1-dashboards.md
+++ b/docs/products/msr1/examples/msr1-dashboards.md
@@ -1,16 +1,21 @@
---
-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."
+title: MSR-1 Home Assistant dashboard examples
+description: "Copy-and-paste Home Assistant dashboard cards for the MSR-1: an ApexCharts scatter plot of radar detection distance, plus CO2 sensor, Plotly graph, and gauge cards."
---
-# MSR-1 Home Assistant Dashboard Examples
+# MSR-1 Home Assistant dashboard examples
-**Radar Scatter Plot With Apex Charts For MSR-1**
+Each example below is a Home Assistant dashboard card for your Apollo MSR-1, with a screenshot of the result and the YAML that builds it. To use one, install any custom card it needs from HACS (its section has a button), then add a card to your dashboard and paste in the YAML.
-This card installs from HACS, so add it there first:
+!!! warning "Change the entity IDs to your own"
+
+ The YAML uses the entity IDs of the MSR-1s these examples were built on. Before you save a card, replace the `a79e14` or `a79e38` part of each entity ID with your own MSR-1's ID, or the card won't find your sensor. You'll find your MSR-1's entities on its device page under **Settings → Devices & services → ESPHome**.
+
+## Radar scatter plot
+
+This ApexCharts card plots your MSR-1's radar detection, moving, and still distances as a scatter plot. The card installs from HACS, so add it there first:
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=RomRider&repository=apexcharts-card&category=plugin)
-
```plaintext
@@ -48,8 +53,13 @@ series:
stroke_width: 1
```
-**CO2 Charts**
-Home Assistant Sensor
+## CO2 charts
+
+These cards chart readings from the MSR-1's optional CO2 sensor. If you haven't fitted it yet, see [Adding CO2 to MSR-1](../../addons/adding-co2-to-msr-1/).
+
+### Home Assistant sensor card
+
+This card is built into Home Assistant, so there's nothing to install.
@@ -62,7 +72,7 @@ name: Bedroom CO2
hours_to_show: 24
```
-Custom: Plotly Graph Card
+### Plotly graph card (custom)
This card installs from HACS, so add it there first:
@@ -79,7 +89,9 @@ refresh_interval: 10
title: Bedroom CO2
```
-Home Assistant Gauge
+### Home Assistant gauge card
+
+This card is also built into Home Assistant. Its needle points into a green, yellow, or red range depending on the CO2 level.
diff --git a/docs/products/msr1/examples/using-msr-1-buzzer.md b/docs/products/msr1/examples/using-msr-1-buzzer.md
index 907853a848..0580b87c92 100755
--- a/docs/products/msr1/examples/using-msr-1-buzzer.md
+++ b/docs/products/msr1/examples/using-msr-1-buzzer.md
@@ -1,30 +1,43 @@
---
-title: Using MSR-1 Buzzer
-description: "Trigger the MSR-1 buzzer from Home Assistant developer tools, then reuse the same call in an automation."
+title: Using the MSR-1 buzzer
+description: "Play a tune on the MSR-1 buzzer from Home Assistant's action tools, then reuse the same action in an automation."
---
-# Using MSR-1 Buzzer
+# Using the MSR-1 buzzer
-This guide will walk you through using the buzzer on your MSR-1. You can also call the below service through automations in Home Assistant.
+Your Apollo MSR-1 has an onboard piezo buzzer that can play short tunes. In this guide, you play one from Home Assistant to hear it for yourself. Once it works, you can use the same action in your Home Assistant automations.
-1. Open Home Assistant and navigate to developer tools in the bottom left
+1\. Open Home Assistant and go to **Developer tools** in the bottom left of the sidebar (**Settings → Tools** in Home Assistant 2026.8 and newer).
+
+[](https://my.home-assistant.io/redirect/tools_actions/)
-2\. Click on services
+2\. Click **Actions** at the top of the page. Older Home Assistant versions call this tab **Services**, as in the screenshot at the end of this guide.
+
+3\. Choose your MSR-1's buzzer action. Start typing `buzzer` to find it faster.
+
+4\. Paste an RTTTL tune into the `song_str` field. RTTTL is a plain-text ringtone format. Expand one of the two samples below and copy it:
+
+??? example "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
+ ```
+
+??? example "Cantina"
+
+ ```
+ Cantina:d=4,o=5,b=250:8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,a,8a,8g#,8a,g,8f#,8g,8f#,f.,8d.,16p,p.,8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,8a,8p,8g,8p,g.,8f#,8g,8p,8c6,a#,a,g
+ ```
+
+Find more tunes in this list of RTTTL ringtones, and test them in an online RTTTL player before you send them to your MSR-1.
-3\. Choose your MSR-1's buzzer (You can type in buzzer to find it easier)
+5\. Click the **Perform action** button in the bottom right.
-4\. Put a 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
- ```
- - Cantina: ```
- Cantina:d=4,o=5,b=250:8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,a,8a,8g#,8a,g,8f#,8g,8f#,f.,8d.,16p,p.,8a,8p,8d6,8p,8a,8p,8d6,8p,8a,8d6,8p,8a,8p,8g#,8a,8p,8g,8p,g.,8f#,8g,8p,8c6,a#,a,g
- ```
- - 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 rtttl tones: [https://adamonsoon.github.io/rtttl-play/](https://adamonsoon.github.io/rtttl-play/)
+Your MSR-1 plays the tune.
-5\. Click on call service button in bottom right
+!!! tip "Play a tune from an automation"
-
\ No newline at end of file
+ The same action works in your Home Assistant automations. When you build an automation, add an action, choose your MSR-1's buzzer action, and paste the tune into the `song_str` field.
diff --git a/docs/products/msr1/faq.md b/docs/products/msr1/faq.md
index cb3760bc7e..1a705ccbb2 100755
--- a/docs/products/msr1/faq.md
+++ b/docs/products/msr1/faq.md
@@ -56,7 +56,7 @@ description: "Common MSR-1 questions answered: which sensors are inside, what th
14\. **What is the mmWave detection range?**
-* The mmWave radar sensor can detect movement up to 5 meters (16.4 feet) with a detection angle of about 60 degrees (though in practice, this can be close to 90 degrees). It’s excellent for detecting both large and small movements, making it suitable for automations like turning on lights or detecting presence in a room.
+* The mmWave radar sensor can detect movement up to about 6 meters (19.7 feet) with a detection angle of about 60 degrees (though in practice, this can be close to 90 degrees). It’s excellent for detecting both large and small movements, making it suitable for automations like turning on lights or detecting presence in a room.
15\. **Can the mmWave sensor detect through walls?**
@@ -64,11 +64,11 @@ description: "Common MSR-1 questions answered: which sensors are inside, what th
16\. **How do I set up automations with the MSR-1?**
-* Automations can be easily configured in Home Assistant using ESPHome. For example, you can automate lights to turn on when motion is detected or trigger a fan when CO2 levels rise. The sensor data can be used in combination with other Home Assistant devices for more complex automations.
+* Automations can be configured in Home Assistant using ESPHome. For example, you can automate lights to turn on when motion is detected or trigger a fan when CO2 levels rise. The sensor data can be used in combination with other Home Assistant devices for more complex automations.
17\. **What is the power source for the MSR-1?**
-* The MSR-1 is powered via USB-C. Simply plug it into a standard 5V USB power adapter, and you’re good to go.
+* The MSR-1 is powered via USB-C. Plug it into a standard 5V USB power adapter, and you’re good to go.
18\. **What is the reporting interval for the MSR-1 sensors?**
@@ -96,7 +96,7 @@ description: "Common MSR-1 questions answered: which sensors are inside, what th
24\. **How do I calibrate the CO2 sensor?**
-* The optional CO2 sensor (SCD40) comes pre-calibrated, so no manual calibration is necessary. However, you can perform recalibration via ESPHome if needed.
+* The optional CO2 sensor (SCD40) is factory calibrated, but the MSR-1 firmware turns its automatic self-calibration off. Calibrate it to fresh air (about 420 ppm) after you install it and every 1 to 2 years after that by pressing **Calibrate SCD40 To 420ppm** outdoors, as described in the [CO2 calibration guide](/products/general/calibrating-and-updating/co2-calibration.md).
25\. **How can I use the MSR-1 for light control?**
diff --git a/docs/products/msr1/introduction.md b/docs/products/msr1/introduction.md
index 27f146f0e7..39217b784e 100755
--- a/docs/products/msr1/introduction.md
+++ b/docs/products/msr1/introduction.md
@@ -4,4 +4,4 @@ description: "The Apollo MSR-1 multisensor: mmWave radar, LUX and UV, temperatur
---
-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
+The Apollo MSR-1 is a compact, community-driven multisensor designed for Home Assistant via ESPHome. Measuring 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/msr-1-reviews/beardedtinker-msr-1-review.md b/docs/products/msr1/msr-1-reviews/beardedtinker-msr-1-review.md
index 9317053bf7..861cd8937b 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,8 +1,11 @@
---
-title: BeardedTinker MSR-1 Review
-description: "BeardedTinker's video review of the Apollo MSR-1."
+title: BeardedTinker MSR-1 review
+description: "BeardedTinker's YouTube video review of the Apollo MSR-1."
---
-# BeardedTinker MSR-1 Review
+# BeardedTinker MSR-1 review
-## BeardedTinker YouTube Video review - MSR-1
+BeardedTinker reviews the Apollo MSR-1 in a YouTube video.
+[Watch the review on YouTube](https://youtu.be/vz1oWhPoIwA){ .md-button .md-button--primary }
+
+For more videos and articles about the MSR-1, see [MSR-1 reviews](../../msr1-reviews/).
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 efbbaad4f5..226e0d6e07 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,11 +1,9 @@
---
-title: DrZzs MSR-1 Review
+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
+# DrZzs MSR-1 review
-##
+DrZzs covers the Apollo MSR-1 during a YouTube livestream. The review starts at [19:53](https://youtu.be/YGNCw1nFwjg?t=1193).
-
-
-Apollo MSR-1 review starts at [19:53](https://youtu.be/YGNCw1nFwjg?t=1193).
\ No newline at end of file
+For more videos and articles about the MSR-1, see [MSR-1 reviews](../../msr1-reviews/).
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 bcfda6a39f..ea70cc9573 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,12 +1,9 @@
---
-title: Make It Work Tech MSR-1 Review
+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
+# Make It Work Tech MSR-1 review
-##
+Make It Work Tech reviews the Apollo MSR-1 partway through a longer YouTube video. The review starts at [31:22](https://www.youtube.com/watch?v=Kt1FpRM8R18&t=1882s).
-
-
-
-## Apollo MSR-1 Review starts at [31:22](https://www.youtube.com/watch?v=Kt1FpRM8R18&t=1882s).
\ No newline at end of file
+For more videos and articles about the MSR-1, see [MSR-1 reviews](../../msr1-reviews/).
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 ea48311429..48f32fea62 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,8 +1,13 @@
---
-title: MostlyChris MSR-1 Review
-description: "MostlyChris reviews the Apollo MSR-1."
+title: MostlyChris MSR-1 review
+description: "MostlyChris reviews the Apollo MSR-1 on YouTube."
---
-# MostlyChris MSR-1 Review
+# MostlyChris MSR-1 review
-> #### The little sensor that does it all! ESPHome and Home Assistant Ready!
+MostlyChris reviews the Apollo MSR-1 on YouTube:
+> The little sensor that does it all! ESPHome and Home Assistant Ready!
+
+[Watch the review on YouTube](https://youtu.be/u8q3lMIkolc){ .md-button .md-button--primary }
+
+For more videos and articles about the MSR-1, see [MSR-1 reviews](../../msr1-reviews/).
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 917a23542c..9f70c32f4b 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,8 +1,13 @@
---
-title: Simon Says Home Assistant MSR-1 Review
-description: "Simon Says Home Assistant reviews the Apollo MSR-1."
+title: Simon Says Home Assistant MSR-1 review
+description: "Simon Says Home Assistant reviews the Apollo MSR-1 on YouTube."
---
-# Simon Says Home Assistant MSR-1 Review
+# Simon Says Home Assistant MSR-1 review
-> #### Check out the Apollo Multisensor MSR-1
+Simon Says Home Assistant reviews the Apollo MSR-1 on YouTube:
+> Check out the Apollo Multisensor MSR-1
+
+[Watch the review on YouTube](https://youtu.be/M-HAuPH9KOk){ .md-button .md-button--primary }
+
+For more videos and articles about the MSR-1, see [MSR-1 reviews](../../msr1-reviews/).
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 6269fba402..eec48cea55 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,7 +1,7 @@
---
-title: Smart Home Scene MSR-1 Review
+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
-## [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 7e607d5768..34ee8f702b 100755
--- a/docs/products/msr1/msr1-reviews.md
+++ b/docs/products/msr1/msr1-reviews.md
@@ -1,15 +1,31 @@
---
-title: Make It Work Tech MSR-1 Review
+title: MSR-1 reviews
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)
+# MSR-1 reviews
-## [Smart Home Scene MSR-1 Review](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/)
+These creators have reviewed the Apollo MSR-1. Each review below is a YouTube video, except Smart Home Scene, which is a written article. In two of the videos, the MSR-1 review starts partway through, so its start time is listed.
-## [DrZzs MSR-1 Review](https://www.youtube.com/live/YGNCw1nFwjg?si=gmdQTtnY2XdzVHV3)
+## Make It Work Tech
-## [BeardedTinker MSR-1 Review](https://youtu.be/vz1oWhPoIwA?si=Gk8p8S_LUIsMC7D-)
+[Watch the review on YouTube](https://youtu.be/Kt1FpRM8R18?si=GgMGCjpbSwpSqIsr). The MSR-1 review starts at 31:22.
-## [Simon Says Home Assistant MSR-1 Review](https://youtu.be/M-HAuPH9KOk?si=Fy7RkfsOJdjaodkr)
+## Smart Home Scene
-## [MostlyChris MSR-1 Review](https://youtu.be/u8q3lMIkolc?si=aWrkRHIru_eOY1jw)
\ No newline at end of file
+[Read the written review on Smart Home Scene](https://smarthomescene.com/reviews/apollo-msr-1-review-miniature-multi-sensor-for-presence-and-co2-monitoring/)
+
+## DrZzs
+
+[Watch the livestream on YouTube](https://www.youtube.com/live/YGNCw1nFwjg?si=gmdQTtnY2XdzVHV3). The MSR-1 review starts at 19:53.
+
+## BeardedTinker
+
+[Watch the review on YouTube](https://youtu.be/vz1oWhPoIwA?si=Gk8p8S_LUIsMC7D-)
+
+## Simon Says Home Assistant
+
+[Watch the review on YouTube](https://youtu.be/M-HAuPH9KOk?si=Fy7RkfsOJdjaodkr)
+
+## MostlyChris
+
+[Watch the review on YouTube](https://youtu.be/u8q3lMIkolc?si=aWrkRHIru_eOY1jw)
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 46ac167148..8e05bf0dc5 100755
--- a/docs/products/msr1/setup/co2-calibration-for-msr-1.md
+++ b/docs/products/msr1/setup/co2-calibration-for-msr-1.md
@@ -1,7 +1,7 @@
---
-title: CO2 Calibration For MSR-1
+title: CO2 calibration for MSR-1
description: "CO2 calibration for the MSR-1, covered by the general calibration guide."
---
-# CO2 Calibration For MSR-1
+# 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 0a031ed1b8..dc88b4b763 100755
--- a/docs/products/msr1/setup/general-tips.md
+++ b/docs/products/msr1/setup/general-tips.md
@@ -1,8 +1,8 @@
---
-title: General Tips
+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
+# General tips
## **MSR-1**
@@ -10,7 +10,7 @@ description: "Placement and mounting tips for the MSR-1, including keeping the l
Picture from Smart Home Scene
-## **Light Sensor (LTR-390UV)**
+## **Light sensor (LTR-390UV)**
@@ -30,14 +30,16 @@ 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**
-****
+****
-
+
+
+Each gate is 0.75 m deep, so the eight gates reach 6 m (19.69 ft) from the sensor.
!!! tip "These are some useful hints!"
- * The FOV angle is -60 to 60 degrees - 120 degrees total.
+ * The FOV angle is -60 to 60 degrees (120 degrees total).
* Gates are pre-defined by the radar module and are in 0.75 meter increments.
* Zones are user-configurable and are in cm.
\ No newline at end of file
diff --git a/docs/products/msr1/setup/mmwave-videos.md b/docs/products/msr1/setup/mmwave-videos.md
index 9c7703ff14..f65c240e6f 100644
--- a/docs/products/msr1/setup/mmwave-videos.md
+++ b/docs/products/msr1/setup/mmwave-videos.md
@@ -1,5 +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!"
+description: "Two short videos and a quick summary on how to best tune the LD2410B in the MSR-1!"
---
--8<-- "products/general/calibrating-and-updating/mmwave-videos.md:5:"
diff --git a/docs/products/msr1/setup/sensor-definitions.md b/docs/products/msr1/setup/sensor-definitions.md
index a1cd8d9fc3..2648fd9032 100755
--- a/docs/products/msr1/setup/sensor-definitions.md
+++ b/docs/products/msr1/setup/sensor-definitions.md
@@ -1,8 +1,8 @@
---
-title: MSR-1 Sensor Definitions
+title: MSR-1 sensor definitions
description: Full list of definitions for the MSR-1 and its various sensors.
---
-# Sensor Definitions
+# Sensor definitions
Once added to Home Assistant you can configure different settings for your MSR-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them.
diff --git a/docs/products/msr1/setup/updating-msr-1-firmware.md b/docs/products/msr1/setup/updating-msr-1-firmware.md
index 2f9485b6be..37fe1fc3a2 100755
--- a/docs/products/msr1/setup/updating-msr-1-firmware.md
+++ b/docs/products/msr1/setup/updating-msr-1-firmware.md
@@ -1,7 +1,7 @@
---
-title: Updating MSR-1 Firmware
+title: Updating MSR-1 firmware
description: "Updating MSR-1 firmware, covered by the general firmware update guide."
---
-# Updating MSR-1 Firmware
+# 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
diff --git a/docs/products/msr1/setup/zones-ha.md b/docs/products/msr1/setup/zones-ha.md
index 4bf77a0ecd..3dbc04ed42 100755
--- a/docs/products/msr1/setup/zones-ha.md
+++ b/docs/products/msr1/setup/zones-ha.md
@@ -1,58 +1,110 @@
---
-title: How To Tune mmWave Using Home Assistant
+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
+# How to tune mmWave using Home Assistant
!!! tip "Prefer a guided dashboard?"
The Apollo mmWave integration gives your Apollo MSR-1 a tuning dashboard with a Gate Energy chart and a **Calibrate with empty room** button that sets the gate thresholds for you. The [Apollo mmWave dashboard guide](/products/msr1/setup/apollo-mmwave-dashboard.md) walks you through it as a guided alternative to the manual steps below.
-If you're experiencing false triggers, we recommend using Radar Engineering Mode (REM) to monitor the gate energy and adjust the gate threshold to eliminate them.
-
-Here is a quick introduction video of the ld2410b gates and zones.
+If you're experiencing false triggers, use Radar Engineering Mode (REM) to track them down. REM shows the move and still energy the radar picks up in each gate, so you can see which gates cause the false triggers and adjust their thresholds to eliminate them.
+## Watch the videos
-Here is a video of how to tune the mmWave sensor using radar engineering mode,
+These two videos cover the basics before you start tuning.
+A quick introduction to the LD2410B gates and zones:
-1. Open Home Assistant
-2. Navigate to Settings>Devices & services>ESPHome>Select the MSR-1
+
+
+How to tune the mmWave sensor using Radar Engineering Mode:
+
+
+
+## Turn on Radar Engineering Mode
+
+Turn on REM from your MSR-1's device page in Home Assistant to see the energy readings for every gate.
+
+1. Open Home Assistant.
+2. Go to **Settings → Devices & services → ESPHome** and select your MSR-1.
[](https://my.home-assistant.io/redirect/integration/?domain=esphome)
-3. Scroll down to the Configuration section
-4. Turn on Radar Engineering Mode (REM)
+3. Scroll down to the **Configuration** section.
+4. Turn on **Radar Engineering Mode**.
+
-5. Scroll down to the Diagnostic section and you will see that REM shows the move and still energy for gates 0-8
+
+5. Scroll down to the **Diagnostic** section. With REM on, it shows the move and still energy for gates 0 to 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.
+
+REM is now on, so you can monitor the energy in each gate while you adjust its thresholds.
+
+## How the gates work
+
+Each gate covers a different distance from the sensor. Use this table to match a gate to a spot in your room.
+
+| Gate | Distance | Default move threshold | Default still threshold |
+|---|---|---|---|
+| 0 | 0 m / 0 ft | 50 | 0 |
+| 1 | 0-0.75 m / 0-2.46 ft | 50 | 0 |
+| 2 | 0.75-1.5 m / 2.46-4.92 ft | 40 | 40 |
+| 3 | 1.5-2.25 m / 4.92-7.38 ft | 40 | 40 |
+| 4 | 2.25-3 m / 7.38-9.84 ft | 40 | 40 |
+| 5 | 3-3.75 m / 9.84-12.30 ft | 40 | 40 |
+| 6 | 3.75-4.5 m / 12.30-14.76 ft | 30 | 15 |
+| 7 | 4.5-5.25 m / 14.76-17.22 ft | 30 | 15 |
+| 8 | 5.25-6 m / 17.22-19.69 ft | 30 | 15 |
+
+
+
+## Adjust a gate's sensitivity
+
+Each gate has a move threshold slider and a still threshold slider. The sliders set how much energy it takes for that gate to trigger the sensor, so to stop false triggers, make the gates that cause them less sensitive.
+
+- **To make a gate less sensitive**, move its still and move threshold sliders to the right. This increases the amount of energy needed to trigger the sensor.
+
-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.
+
+- **To make a gate more sensitive**, move its still and move threshold sliders to the left. This decreases the amount of energy needed to trigger the sensor.
+
-**Alternate Method**
+## Alternate method: start with every slider at maximum
+
+Another way to tune is to start with every gate at its least sensitive and work down from there. Thanks to [MakeItWorkTech](https://www.youtube.com/@makeitworktech) for this method!
+
+!!! quote "MakeItWorkTech"
+
+ 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.
-Thanks to [MakeItWorkTech](https://www.youtube.com/@makeitworktech) for this method!
+## Example: kitchen lights in an open-concept room
-"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."
+Say you have an open-concept kitchen and living room, and you want the MSR-1 to activate your under-cabinet lights only when you're in the kitchen. Here's how to tune the gates for that:
-**Example**
+1. Stand in the spots where you want the lights to trigger.
+2. Observe the gate energy to see which gates pick you up.
+3. Move the threshold sliders to the right on the gates that cover the living room. This increases the energy required to trigger the mmWave sensor, so your kitchen lights only come on when you're actually in the kitchen, not when you're walking by in the living room.
+4. Optionally, move the threshold sliders to the left on the gates that cover the kitchen. This lowers the gate threshold and makes the mmWave sensor more sensitive, even when you're standing still, so the lights don't go off while you're reading a recipe or doing the dishes.
-\- You may have an open-concept kitchen and living room, and you want the MSR-1 to activate your under-cabinet lights only when you're in the kitchen.
+Your MSR-1 now detects you in the kitchen, but not when you walk by in the living room.
-Here's how:
+!!! quote "clarinetJWD"
-1. Stand in the desired trigger locations.
-2. Observe the gate energy.
-3. Adjust the gate threshold slider to the right, increasing the energy required to trigger the mmWave sensor. This ensures that your kitchen lights only come on when you're actually in the kitchen, not just walking by in the living room. Also, you can lower the gate threshold in the kitchen by moving the slider to the left. This makes the mmWave sensor more sensitive, even when standing still. This way, you avoid having the lights go off while reading a recipe or doing the dishes.
+ Engineering mode is what I was missing at first. I did exactly that, and now detection is basically perfect! My under cabinet lights now come on to max brightness whenever someone is in the kitchen, and return to their previous value when they leave. Next up is replacing the really flaky motion switch in my garage so it stops shutting off when I'm doing a project at the workbench! Thanks, these are really good.
-\- From clarinetJWD, "Engineering mode is what I was missing at first. I did exactly that, and now detection is basically perfect! My under cabinet lights now come on to max brightness whenever someone is in the kitchen, and return to their previous value when they leave. Next up is replacing the really flaky motion switch in my garage so it stops shutting off when I'm doing a project at the workbench! Thanks, these are really good.
+## References
-**References**
+For more background on tuning the radar, see:
- [https://youtu.be/dAzHXpP3FcI?t=431](https://youtu.be/dAzHXpP3FcI?t=431)
- [https://community.home-assistant.io/t/ld2410-esphome-tips/477058/316](https://community.home-assistant.io/t/ld2410-esphome-tips/477058/316)
-- [https://www.youtube.com/watch?v=l212Lvo1R6s](https://www.youtube.com/watch?v=l212Lvo1R6s)
\ No newline at end of file
+- [https://www.youtube.com/watch?v=l212Lvo1R6s](https://www.youtube.com/watch?v=l212Lvo1R6s)
diff --git a/docs/products/msr1/setup/zones-hlk.md b/docs/products/msr1/setup/zones-hlk.md
index 6c00b98b9f..a26cb1407b 100755
--- a/docs/products/msr1/setup/zones-hlk.md
+++ b/docs/products/msr1/setup/zones-hlk.md
@@ -1,51 +1,67 @@
---
-title: How To Tune mmWave Using HLKRadarTool
+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
+# How to tune mmWave using HLKRadarTool
-**Auto-Calibration (Average, Maximum, and Intelligent)**
-1\. Download the HLKRadarTool app for either [Android ](https://play.google.com/store/apps/details?id=com.hlk.hlkradartool&hl=en_US≷=US)or [Apple](https://apps.apple.com/us/app/hlkradartool/id1638651152)
-
-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
+The HLKRadarTool phone app connects to your mmWave radar over Bluetooth, so you can tune it to your room. You have two options: let the app set the gate sensitivity for you from a background-noise reading (auto-calibration), or set the sensitivity values yourself (manual calibration).
+
+## Auto-calibration (Average, Maximum, and Intelligent)
+
+In auto-calibration, the app first measures your room's background noise, then uses that reading to set the gate sensitivity in one click. Follow these steps to connect to the radar, take the reading, and pick a calibration mode.
+
+1\. Download the HLKRadarTool app for [Android](https://play.google.com/store/apps/details?id=com.hlk.hlkradartool&hl=en_US&gl=US) or [Apple](https://apps.apple.com/us/app/hlkradartool/id1638651152).
+
+2\. Turn on Bluetooth for the mmWave radar you want to tune. In Home Assistant, go to **Settings → Devices & services → ESPHome Devices**, select your device, scroll down, and turn on **Radar Control Bluetooth**.
[](https://my.home-assistant.io/redirect/integration/?domain=esphome)
-
-
-
-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
-
-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
+
+
+
+3\. Open the HLKRadarTool app and select your device.
+
+
+
+4\. Turn on **Engineering Mode**.
+
+
+
+5\. Select **More**, then select **Parameter settings**.
+
+
+
+6\. Select **Detect background noise**.
+
+
+
+7\. Enter the **Delay detection** and **Detection time** values, then select **Start**. On iPhone, **Delay detection** can't be 0. The app measures your room's background noise, which gives it the reference values it needs to auto-calibrate the mmWave sensor.
+
+
+
+8\. Select **Back** to return to **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.
+
+ 
+
+Your mmWave sensor is now tuned to your environment.
+
+## Manual calibration
+
+To choose the sensitivity values yourself, set them directly in the app's **Parameter settings**.
+
+1\. Follow steps 1 to 5 in the auto-calibration section above.
+
+2\. Select Motion or Static sensitivity, change it to the value you want, and select **Set**.
+
+
+
+Your mmWave sensor is now tuned to your environment.
diff --git a/docs/products/msr1/troubleshooting/msr1-boot-mode.md b/docs/products/msr1/troubleshooting/msr1-boot-mode.md
index f6e27566e8..435be0b4ba 100755
--- a/docs/products/msr1/troubleshooting/msr1-boot-mode.md
+++ b/docs/products/msr1/troubleshooting/msr1-boot-mode.md
@@ -1,30 +1,34 @@
---
-title: Putting The MSR-1 In Boot Mode
+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
+# Putting the MSR-1 in boot mode
!!! info "This will cover how to put the MSR-1 into 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-1 as shown in the image below and locate the small opening to press the boot button (the right button).
+You'll hold the boot button while you plug in the USB-C cable.
+
+1\. Position the MSR-1 as shown in the image below and locate the small opening to 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-2 then let go of the 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\. Continue with uploading the firmware document.
-## Method 2: Boot and Reset Buttons
+## Method 2: Boot and reset buttons
+
+You'll use the boot and reset buttons together while the device is plugged into your computer.
-1\. Unplug the device and locate the boot and reset buttons as shown in the image above.
+1\. Unplug the device and locate the boot and reset buttons as shown in the image below.
2\. Plug it into your computer.
-3\. Hold down the boot button (the right button), then press and release the reset button (the left button) while keeping the boot button pressed. Finally, release the boot button.
+3\. Hold down the boot button (the left button), then press and release the reset button (the right button) while keeping the boot button pressed. Finally, release the boot button.
diff --git a/docs/products/msr1/troubleshooting/msr1-code.md b/docs/products/msr1/troubleshooting/msr1-code.md
index 20ad00bd2c..428c7ec9a2 100755
--- a/docs/products/msr1/troubleshooting/msr1-code.md
+++ b/docs/products/msr1/troubleshooting/msr1-code.md
@@ -1,8 +1,8 @@
---
-title: Factory Re-Flash MSR-1
+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
+# Factory re-flash MSR-1
!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below."
@@ -16,27 +16,25 @@ If your device has already been connected to Home Assistant please Apollo MSR-1 Installer.
-3\. Click the big "Connect" button.
+4\. Click the big "Connect" button.
-3\. Select the open com port then click Connect.
+5\. Select the open com port then click Connect.
-4\. Click "Install MSR-1".
+6\. Click "Install MSR-1".
-5\. Click "INSTALL".
+7\. Click "INSTALL".
-6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
+8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
@@ -44,4 +42,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and set up your sensor as a new device!
\ No newline at end of file
+9\. 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/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
index 2f3d03f6a1..19cd9bfc55 100755
--- a/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
+++ b/docs/products/msr1/troubleshooting/msr1-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials
+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
+# Reset Wi-Fi credentials
+
+You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot.
1\. Plug in the device
diff --git a/docs/products/msr1/troubleshooting/msr1-teardown.md b/docs/products/msr1/troubleshooting/msr1-teardown.md
index 39d115ecb2..6cd01dc60e 100755
--- a/docs/products/msr1/troubleshooting/msr1-teardown.md
+++ b/docs/products/msr1/troubleshooting/msr1-teardown.md
@@ -1,5 +1,5 @@
---
-title: Teardown and Reassembly Of MSR-1
+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/additional-info/bluetooth-proxy.md b/docs/products/msr2/additional-info/bluetooth-proxy.md
index 2419bf8a62..459e953c63 100644
--- a/docs/products/msr2/additional-info/bluetooth-proxy.md
+++ b/docs/products/msr2/additional-info/bluetooth-proxy.md
@@ -1,8 +1,8 @@
---
-title: MSR-2 Bluetooth Proxy
+title: MSR-2 Bluetooth proxy
description: Tutorial for how to turn your MSR-2 into a BLE proxy!
---
-# MSR-2 Bluetooth Proxy
+# MSR-2 Bluetooth proxy
--8<-- "_snippets/bluetooth-proxy/intro.md"
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 05cc917bb9..66934fd0c4 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
@@ -4,6 +4,8 @@ description: Step by step tutorial for adding 90 degree USB-C to MSR-2
---
# Adding 90 degree USB-C to MSR-2
+You'll attach this addon to your sensor and plug it into a USB-C outlet.
+
1\. Gather the MSR-2 and 90 degree addon.
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 7ae8e2ee07..576ebdaf75 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
@@ -1,8 +1,10 @@
---
-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 articulating stand to your MSR-2
+description: Tutorial on adding the articulating stand to your MSR-2.
---
-# Adding Articulating Stand To MSR-2
+# Adding articulating stand to MSR-2
+
+You'll swap the back of your sensor for the articulating stand backplate, then seat the stand's ball in its mount.
1\. Unplug your MSR-2 from power and remove the back.
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 3861720efc..d40a6bca1d 100755
--- a/docs/products/msr2/addons/adding-co2-to-msr-2.md
+++ b/docs/products/msr2/addons/adding-co2-to-msr-2.md
@@ -2,7 +2,9 @@
title: Add the SCD40 CO2 sensor to your MSR-2
description: Tutorial on adding the SCD40 CO2 sensor to your MSR-2.
---
-# Adding CO2 To MSR-2
+# Adding CO2 to MSR-2
+
+You'll slide your sensor out of its case, fit the SCD40 module onto its mezzanine connector, and put the case back together.
1\. Unplug your MSR-2 from power and remove the back
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 4712267ff9..f6990d67c2 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
@@ -1,8 +1,10 @@
---
-title: Add the GPIO Header to your MSR-2
+title: Add the GPIO header to your MSR-2
description: Tutorial on adding the GPIO Header to your MSR-2.
---
-# Adding GPIO Header To MSR-2
+# Adding GPIO header to MSR-2
+
+You'll seat the GPIO Header addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it.
1\. Unplug your MSR-2 from power and remove the back.
@@ -28,7 +30,7 @@ description: Tutorial on adding the GPIO Header to your MSR-2.
-## GPIO Header pinout
+## GPIO header pinout
With the header installed, these are the pins you can wire to. IO18 and IO19 can't be used while you flash the MSR-2, and IO0 and IO1 carry the I2C bus (SDA and SCL).
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 3ecd33868d..b14f0b53df 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
@@ -2,7 +2,9 @@
title: Add the rear female USB-C port to your MSR-2
description: Tutorial on adding the rear female USB-C port to your MSR-2.
---
-# Adding Rear Female USB-C To MSR-2
+# Adding rear female USB-C to MSR-2
+
+You'll seat the Female Rear USB-C addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it.
1\. Unplug your MSR-2 from power and remove the back
diff --git a/docs/products/msr2/addons/msr2-outlet-mount.md b/docs/products/msr2/addons/msr2-outlet-mount.md
index 9d3b033fbc..21e37ec025 100755
--- a/docs/products/msr2/addons/msr2-outlet-mount.md
+++ b/docs/products/msr2/addons/msr2-outlet-mount.md
@@ -1,8 +1,10 @@
---
-title: MSR-2 Outlet Mount
+title: MSR-2 outlet mount
description: Tutorial for using the MSR-2 Outlet Mount.
---
-# MSR-2 Outlet Mount
+# MSR-2 outlet mount
+
+You'll attach your sensor to a top facing USB-C plug with the Outlet Mount.
1\. Gather a top facing USB-C plug, an MSR-2, and our MSR-2 Outlet Mount.
diff --git a/docs/products/msr2/calibrating-co2.md b/docs/products/msr2/calibrating-co2.md
index 2e54f8e291..c9eab549ad 100755
--- a/docs/products/msr2/calibrating-co2.md
+++ b/docs/products/msr2/calibrating-co2.md
@@ -1,8 +1,8 @@
---
-title: CO2 Calibration Tutorial (quick)
+title: CO2 calibration tutorial (quick)
description: Step by step guide for re-calibrating your SCD40 CO2 sensor
---
-# CO2 Calibration - The Quick method - Desktop Only not mobile
+# CO2 calibration - the quick method - desktop only not mobile
!!! info "Your MSR-2 calibrates itself"
@@ -10,7 +10,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor
!!! tip "Calibrate manually every 1 to 2 years when auto calibration is off"
- 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.
+ 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.
This article will guide you through a simple calibration of your CO2 sensor for any Apollo Automation device!
@@ -18,7 +18,9 @@ This article will guide you through a simple calibration of your CO2
-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.
+*Shown with an AIR-1; set your MSR-2 outdoors the same way.*
+
+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.
!!! tip "Hint"
@@ -26,6 +28,10 @@ This article will guide you through a simple calibration of your CO2
+*Shown for an AIR-1; your MSR-2 lists the same Calibrate SCD40 To 420ppm button.*
+
3\. Click on the button that says "PRESS" and then you are done.
-
\ No newline at end of file
+
+
+*Shown for an AIR-1; the MSR-2 button dialog looks the same.*
\ No newline at end of file
diff --git a/docs/products/msr2/examples/gpio-header-control-an-led-strip.md b/docs/products/msr2/examples/gpio-header-control-an-led-strip.md
index c131423d8a..90ef3d518b 100755
--- a/docs/products/msr2/examples/gpio-header-control-an-led-strip.md
+++ b/docs/products/msr2/examples/gpio-header-control-an-led-strip.md
@@ -1,8 +1,8 @@
---
-title: Control an LED strip with the GPIO Header
+title: Control an LED strip with the GPIO header
description: Wire a WS2812B LED strip to the Apollo GPIO Header and control it from Home Assistant.
---
-# Control an LED strip with the GPIO Header
+# Control an LED strip with the GPIO header
The GPIO Header addon brings the MSR-2's spare pins out to a row of headers, so you can hang your own hardware off the sensor. This guide wires a WS2812B strip to one of those pins and gets it into Home Assistant as its own light entity, color picker and effects included.
@@ -18,7 +18,7 @@ The same steps work on any Apollo device with a mezzanine port, including the MT
!!! warning "Watch the current draw"
- The 5V pin supplies up to 300mA. A meter of 60 LEDs at full white draws far more than that, so anything longer than a short strip needs its own 5V supply. You can power the MSR-2 itself from the 5V and GND pins instead of the USB-C port, but use one or the other, never both.
+ The 5V pin supplies up to 350mA. A meter of 60 LEDs at full white draws far more than that, so anything longer than a short strip needs its own 5V supply. You can power the MSR-2 itself from the 5V and GND pins instead of the USB-C port, but use one or the other, never both.
## Choosing a data pin
@@ -26,7 +26,9 @@ IO2, IO4, IO6, and IO7 are free for LED data, and you can drive more than one st
{ width="480" }
-## Attaching the GPIO Header
+## Attaching the GPIO header
+
+You'll seat the GPIO Header on your sensor's mezzanine connector, then fit the blue back plate that came with the addon.
1. Unplug the MSR-2 from power and pull the back plate off.
@@ -46,6 +48,8 @@ IO2, IO4, IO6, and IO7 are free for LED data, and you can drive more than one st
## Wiring the strip
+You'll run three wires from the header to your strip, then check which way the data flows.
+
1. Run three wires from the header to the strip: 5V, GND, and data. Matching the colors to the strip's own wiring saves a lot of squinting later, so use red for 5V, white for GND, and green for data on IO7.
{ width="200" } { width="200" } { width="200" }
diff --git a/docs/products/msr2/examples/msr2-alarmo.md b/docs/products/msr2/examples/msr2-alarmo.md
index e4d2a4fb27..4b5e01c1ff 100755
--- a/docs/products/msr2/examples/msr2-alarmo.md
+++ b/docs/products/msr2/examples/msr2-alarmo.md
@@ -1,8 +1,8 @@
---
-title: How To use the MSR-2 with Alarmo
+title: How to use the MSR-2 with Alarmo
description: A tutorial for how to use the MSR-2 with Alarmo for an advanced DIY alarm system.
---
-# MSR-2 + Alarmo Home Security Install
+# MSR-2 + Alarmo home security install
My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo integration, quickly allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA.
@@ -27,6 +27,8 @@ Restart Home Assistant once both are installed, then add the Alarmo integration
+*Shown with MSR-1 sensors; add your MSR-2 radar target entities the same way.*
+
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.)
@@ -39,10 +41,14 @@ Restart Home Assistant once both are installed, then add the Alarmo integration
+*Shown with AIR-1 and MSR-1 lights; pick your MSR-2 RGB light the same way.*
+
7\. Under Action select Turn On and now your sensors RGB lights will turn on when the alarm is triggered.
+*Shown with AIR-1 and MSR-1 lights; the MSR-2 steps are the same.*
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
We hope this was helpful and please let us know if there are any questions!
\ No newline at end of file
diff --git a/docs/products/msr2/faq.md b/docs/products/msr2/faq.md
index c340cc9404..970d5989f8 100755
--- a/docs/products/msr2/faq.md
+++ b/docs/products/msr2/faq.md
@@ -1,107 +1,121 @@
---
title: MSR-2 FAQ
-description: Frequently asked questions about the MSR-2 mmWave sensor.
+description: "Answers to common questions about the MSR-2 mmWave multisensor: its sensors, the radar, setup in Home Assistant, accessories, and support."
---
+# MSR-2 FAQ
+
+Answers to common questions about the Apollo MSR-2, grouped by topic.
+
+## Sensors and features
+
1\. **What sensors are included in the MSR-2?**
-* The MSR-2 includes several built-in sensors such as an mmWave radar for motion detection, a LUX and UV sensor, a temperature and pressure sensor, and an optional CO2 sensor.
+* The MSR-2 has an mmWave radar for motion detection, a LUX and UV sensor, and a temperature and pressure sensor built in. An optional CO2 sensor is also available.
-2\. **How does the mmWave radar sensor work?**
+2\. **What's new in the MSR-2 compared to the MSR-1?**
-* The mmWave radar sensor can detect movement, even subtle motions like someone sitting still in a room. It works by emitting radar waves that reflect off objects and detects motion based on the change in the signal. The sensor is highly effective in detecting people in a room, even through light walls.
+* The MSR-2 introduces several improvements: a smaller form factor, an additional expansion slot for future accessories, an updated DPS310 pressure sensor for more accurate readings, and improved temperature and pressure tracking.
-3\. **What is the maximum detection range of the mmWave radar?**
+3\. **What makes the MSR-2 stand out from other motion sensors?**
-* The HLK-LD2410B mmWave radar sensor has a maximum detection range of about 6 meters (19.6 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring.
+* Its mmWave radar can detect still motion (like someone sitting still), and it reports presence in configurable distance zones. It's also compact, combines several sensors in one device (motion, LUX, UV, CO2, temperature, and pressure), and is open source, so you can customize it.
-4\. **Can the MSR-2 detect multiple people?**
+4\. **What is the benefit of the LUX and UV sensor?**
-* No, the MSR-2 supports single-target tracking only but it has better still detection than the MTR-1 which makes it uniquely suited for situations where you need to track a very still target like on a bed, couch, etc.
+* The LUX sensor measures the amount of light in a room, and the UV sensor tracks the ultraviolet index from the sun. Use these readings to automate your lighting, such as turning lights on or off based on the ambient brightness, or to measure how much sunlight a room gets.
-5\. **What is the benefit of the LUX and UV sensor?**
+5\. **How does the optional CO2 sensor work?**
-* The LUX sensor measures the amount of light in a room, while the UV sensor tracks the ultraviolet index from the sun. These readings can be used to automate lighting systems, such as turning on or off lights depending on the ambient brightness, or to measure sunlight exposure in a room.
+* The optional SCD-40 CO2 sensor provides accurate carbon dioxide measurements, which helps you track air quality in enclosed spaces. Use it to automate your HVAC system, send alerts when CO2 levels are too high, and know when to ventilate the area.
-6\. **How does the optional CO2 sensor work?**
+6\. **How does the temperature and pressure sensor work?**
-* The optional SCD-40 CO2 sensor provides accurate carbon dioxide measurements and is useful for tracking air quality in enclosed spaces. This sensor can be used to automate HVAC systems, sending alerts when CO2 levels are too high and suggesting when to ventilate the area.
+* The DPS310 sensor provides precise readings of air temperature and pressure. These are especially useful alongside the optional CO2 sensor for air quality monitoring. Heat from the ESP32 can affect the temperature reading, so you may need to adjust the temperature offset in the configuration.
-7\. **How do I connect the MSR-2 to Home Assistant?**
+7\. **My DPS310 Pressure or DPS310 Temperature shows as "unknown" in Home Assistant. Is something wrong?**
-* 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.
+* No, your device is fine. A small subset of units shipped without the DPS310 sensor because the part was discontinued by the manufacturer. If you see those entities reporting "unknown," your unit is one of these. Every other sensor on the device works normally.
-8\. **What kind of automations can I create with the MSR-2?**
+8\. **What are the RGB LED and piezo buzzer used for?**
-* You can create a variety of automations, such as turning on lights when motion is detected, adjusting ventilation when CO2 levels rise, or triggering alarms based on motion or environmental changes.
+* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like high CO2 levels or high UV exposure.
-9\. **What are the RGB LED and piezo buzzer used for?**
+## mmWave radar
-* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure.
+9\. **How does the mmWave radar sensor work?**
-10\. **How do I adjust the sensitivity of the presence detection?**
+* The mmWave radar sends out radar waves that reflect off objects, and it detects motion from the change in the reflected signal. It picks up even subtle motion, like someone sitting still in a room. The sensor is highly effective at detecting people in a room, even through light walls.
-* Sensitivity adjustments can be made through the Home Assistant Device Page or HLK Radar Tool app allowing you to fine-tune the radar to avoid false positives or to increase its sensitivity for more precise detections.
+10\. **What is the maximum detection range of the mmWave radar?**
-11\. **Does the mmWave sensor detect through walls?**
+* The HLK-LD2410B mmWave radar sensor has a maximum detection range of about 6 meters (19.7 feet), which makes it ideal for monitoring a whole room.
-* Yes, the mmWave sensor can detect movement through certain materials like thin walls, which is helpful in larger spaces but may require sensitivity adjustments if false positives occur due to adjacent rooms.
+11\. **Can the MSR-2 detect multiple people?**
-12\. **Can the MSR-2 be used outdoors?**
+* No. The MSR-2 supports single-target tracking only. It does have better still detection than the MTR-1, which makes it uniquely suited to tracking a very still target, such as someone on a bed or couch.
-* No, the MSR-2 is primarily designed for indoor use and high humidity or temperatures too high or low could damage the device.
+12\. **Can the MSR-2 track the exact location of people in a room?**
-13\. **What’s new in the MSR-2 compared to the MSR-1?**
+* No. The LD2410B reports how far away a moving or still target is, not where it is in the room. The MSR-2 uses that distance to tell you which of three configurable distance zones is occupied, and whether the target is moving or still.
-* The MSR-2 introduces several improvements, including a smaller form factor, an additional expansion slot for future accessories, an updated DPS310 pressure sensor for more accurate readings, and improved temperature and pressure tracking.
+13\. **Does the mmWave sensor detect through walls?**
-14\. **Can the MSR-2 track the exact location of people in a room?**
+* Yes. The mmWave sensor can detect movement through certain materials, such as thin walls. That helps in larger spaces, but if movement in an adjacent room causes false positives, you may need to adjust the sensitivity (see question 14).
-* Yes, the MSR-2 uses multi-zone mmWave radar technology to track the approximate location of people within a room. It can determine whether someone is sitting, walking, or standing in different areas of the space.
+14\. **How do I adjust the sensitivity of the presence detection?**
-15\. **How does the temperature and pressure sensor work?**
+* Adjust it from the Home Assistant Device Page or the HLK Radar Tool app. Both let you fine-tune the radar to avoid false positives, or increase its sensitivity for more precise detection.
-* The DPS310 sensor provides precise readings of air temperature and pressure, which are especially useful when combined with the optional CO2 sensor to improve air quality monitoring. Keep in mind the heat generated by the ESP32 may require a temperature offset adjustment in the configuration.
+## Setup and use
-16\. **My DPS310 Pressure or DPS310 Temperature shows as "unknown" in Home Assistant. Is something wrong?**
+15\. **How do I install and configure the MSR-2?**
-* No, your device is fine. A small subset of units shipped without the DPS310 sensor because the part was discontinued by the manufacturer. If you see those entities reporting "unknown," your unit is one of these. Every other sensor on the device works normally.
+* Power the MSR-2 over USB-C, then connect it to Home Assistant over Wi-Fi. You configure it in ESPHome, where you can set sensor parameters, adjust automations, and more. Apollo provides detailed documentation, plus support through the Apollo Discord community and GitHub.
-17\. **What kind of power supply is required for the MSR-2?**
+16\. **What kind of power supply is required for the MSR-2?**
-* The MSR-2 is powered via USB-C and can be plugged into a standard wall outlet using a 5V adapter.
+* The MSR-2 is powered over USB-C. Plug it into a standard wall outlet with a 5V adapter.
-18\. **Can I customize the MSR-2 functionality?**
+17\. **How do I connect the MSR-2 to Home Assistant?**
-* 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.
+* The MSR-2 connects to your Home Assistant instance through ESPHome over Wi-Fi. Once it's connected, you can monitor data from all the sensors and set up automations.
-19\. **How often does the MSR-2 report sensor data?**
+18\. **Can I use multiple MSR-2 sensors in my Home Assistant setup?**
-* The reporting frequency can be customized through the ESPHome YAML configuration. You can set it to report data as frequently as every second or reduce the frequency to save energy or bandwidth.
+* Yes, you can have multiple MSR-2 sensors connected to the same Home Assistant instance. Each one shows up as its own device with its own set of entities, so you can monitor and automate different rooms or areas in your home.
+
+19\. **Is the MSR-2 compatible with other smart home platforms?**
+
+* The MSR-2 is designed specifically for Home Assistant through ESPHome, and its primary functionality is optimized for Home Assistant. It could be compatible with other platforms through custom integrations.
+
+20\. **What kind of automations can I create with the MSR-2?**
+
+* You can create a variety of automations, such as turning on lights when motion is detected, adjusting ventilation when CO2 levels rise, or triggering alarms based on motion or environmental changes.
-20\. **Is the MSR-2 compatible with other smart home platforms?**
+21\. **How often does the MSR-2 report sensor data?**
-* The MSR-2 is specifically designed for Home Assistant via ESPHome. While it could be compatible with other platforms through custom integrations, its primary functionality is optimized for Home Assistant.
+* You can customize the reporting frequency in the ESPHome YAML configuration. Set it to report data as often as every second, or reduce the frequency to save energy or bandwidth.
-21\. **Can I use multiple MSR-2 sensors in my Home Assistant setup?**
+22\. **Can the MSR-2 be used outdoors?**
-* Yes, you can have multiple MSR-2 sensors connected to the same Home Assistant instance. Each device will show up as a separate entity, allowing you to monitor and automate different rooms or areas in your home.
+* No. The MSR-2 is designed primarily for indoor use. High humidity, or temperatures that are too high or too low, could damage the device.
-22\. **What accessories are available for the MSR-2?**
+## Customization and accessories
-* The MSR-2 has an additional expansion slot for future accessories. Currently, accessories such as a USB-C wall plug mount and a ball mount for flexible positioning are available. We are also working on new expansion boards for future updates.
+23\. **Can I customize the MSR-2 functionality?**
-23\. **Is the MSR-2 secure?**
+* Yes. You can modify the firmware and settings with ESPHome, and you can print custom cases for the MSR-2. The YAML is on GitHub, and the .STEP and .STL CAD files are available for community use.
-* The MSR-2 communicates over your local network using ESPHome, which provides a secure, local connection without the need for cloud services. No data is sent to external servers, ensuring privacy.
+24\. **What accessories are available for the MSR-2?**
-24\. **How do I install and configure the MSR-2?**
+* The MSR-2 has an additional expansion slot for future accessories. Available accessories include a USB-C wall plug mount and a ball mount for flexible positioning. Apollo is also working on new expansion boards for future updates.
-* 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.
+## Privacy and support
-25\. **What makes the MSR-2 stand out from other motion sensors?**
+25\. **Is the MSR-2 secure?**
-* The MSR-2 stands out due to its mmWave radar’s ability to detect still motion (like someone sitting still) and its capability to track multiple targets and zones. Additionally, its compact size, multi-sensor integration (motion, LUX, UV, CO2, temperature, pressure), and the open-source nature of the product make it highly versatile and customizable.
+* The MSR-2 communicates over your local network using ESPHome, which provides a secure, local connection without the need for cloud services. No data is sent to external servers, so your data stays private.
26\. **What is the warranty for the MSR-2?**
-* The MSR-2 comes with a standard one-year warranty. If you experience any issues, our support team is available through Discord, email, or the website to assist with troubleshooting or replacement.
\ No newline at end of file
+* The MSR-2 comes with a standard one-year warranty. If you run into an issue, Apollo's support team can help with troubleshooting or a replacement through Discord, email, or the website.
diff --git a/docs/products/msr2/introduction.md b/docs/products/msr2/introduction.md
index 31ddede80d..287c5e6ada 100755
--- a/docs/products/msr2/introduction.md
+++ b/docs/products/msr2/introduction.md
@@ -4,4 +4,4 @@ description: Documentation for MSR-2, including setup, usage, and best practices
---
-The Apollo MSR-2 is a compact, versatile mmWave multisensor for Home Assistant, designed for precise motion detection and smart home automation. It builds on the MSR-1 with a smaller form factor, an additional expansion slot, and improved sensors for temperature and pressure. The sensor includes LUX and UV detection, an optional CO2 sensor, RGB LED, and piezo buzzer for customizable notifications. Fully open-source and expandable, the MSR-2 offers seamless integration with Home Assistant, making it ideal for automating lighting, air quality monitoring, and more. Access to support and customization resources is available via our Discord and GitHub.
\ No newline at end of file
+The Apollo MSR-2 is a compact, versatile mmWave multisensor for Home Assistant, designed for precise motion detection and smart home automation. It builds on the MSR-1 with a smaller form factor, an additional expansion slot, and improved sensors for temperature and pressure. The sensor includes LUX and UV detection, an optional CO2 sensor, RGB LED, and piezo buzzer for customizable notifications. Fully open-source and expandable, the MSR-2 integrates with Home Assistant, making it ideal for automating lighting, air quality monitoring, and more. Access to support and customization resources is available via our Discord and GitHub.
\ No newline at end of file
diff --git a/docs/products/msr2/msr2-reviews.md b/docs/products/msr2/msr2-reviews.md
index 5ba7fce8e2..d3c797a37b 100755
--- a/docs/products/msr2/msr2-reviews.md
+++ b/docs/products/msr2/msr2-reviews.md
@@ -1,15 +1,31 @@
---
-title: MSR-2 Reviews
-description: YouTuber reviews and feedback about the MSR-2 sensor from Apollo Automation.
+title: MSR-2 reviews
+description: "Video and written reviews of the Apollo MSR-2 from YouTubers and smart-home sites."
---
-# [Simon Says Home Assistant MSR-2 Review](https://www.youtube.com/watch?v=U4qUhFSAxbk)
+# MSR-2 reviews
-## [Smart Home Scene MSR-2 Review](https://smarthomescene.com/reviews/apollo-msr-2-review-the-smallest-presence-sensor-ever-made/)
+These creators have reviewed the Apollo MSR-2. Each review below is a YouTube video, except Smart Home Scene, which is a written article.
-## [Home Tech Innovations MSR-2 Review](https://www.youtube.com/watch?v=K3j2rR2dsY0)
+## Simon Says Home Assistant
-## [MostlyChris MSR-2 Review](https://www.youtube.com/watch?v=nQpi2n5UWoQ)
+[Watch "The Apollo MSR2 Presence Sensor is now even smaller!" on YouTube](https://www.youtube.com/watch?v=U4qUhFSAxbk)
-## [Smart Home Australia MSR-2 Review](https://www.youtube.com/watch?v=EzVyzFwdgN4)
+## Smart Home Scene
-## [Michael Leen MSR-2 Review](https://www.youtube.com/watch?v=VdVR8Gs002Q)
\ No newline at end of file
+[Read "Apollo MSR-2 Review: The Smallest Presence Sensor Ever Made" on Smart Home Scene](https://smarthomescene.com/reviews/apollo-msr-2-review-the-smallest-presence-sensor-ever-made/)
+
+## Home Tech Innovations
+
+[Watch "Setup MSR-2 in 3 EASY Steps!" on YouTube](https://www.youtube.com/watch?v=K3j2rR2dsY0)
+
+## MostlyChris
+
+[Watch "Even SMALLER Presence Sensor for Home Assistant!" on YouTube](https://www.youtube.com/watch?v=nQpi2n5UWoQ)
+
+## Smart Home Australia
+
+[Watch "Apollo MSR2 Radar Motion Sensor - Small just got tiny !!" on YouTube](https://www.youtube.com/watch?v=EzVyzFwdgN4)
+
+## Michael Leen
+
+[Watch "Don't Be Fooled By Its Size: Apollo MSR-2 mmWave Multisensor" on YouTube](https://www.youtube.com/watch?v=VdVR8Gs002Q)
diff --git a/docs/products/msr2/setup/msr2-general-tips.md b/docs/products/msr2/setup/msr2-general-tips.md
index fc35b509e7..1bc40664af 100755
--- a/docs/products/msr2/setup/msr2-general-tips.md
+++ b/docs/products/msr2/setup/msr2-general-tips.md
@@ -1,14 +1,14 @@
---
-title: MSR-2 General Tips
+title: MSR-2 general tips
description: Multiple helpful images for mounting, lux/rgb, and gate and zone visualization.
---
-# General Tips
+# General tips
-## **Light Sensor (LTR-390UV)**
+## **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.
+When mounting the MSR-2, position it so the center vent slots (outlined in red above) are not covered. This lets more light reach the sensor and keeps the readings accurate.
!!! warning "The RGB LED will trigger the Light sensor!"
@@ -26,14 +26,14 @@ The MSR-2 can also be mounted on the ceiling if you can provide power and mount
!!! tip "These are some useful hints!"
- * The FOV angle is -60 to 60 degrees - 120 degrees total.
+ * The FOV angle is -60 to 60 degrees (120 degrees total).
* Gates are pre-defined by the radar module and are in 0.75 meter increments.
* Zones are user-configurable and are in cm.
-## **Gate and FOV Visualization**
+## **Gate and FOV visualization**
-****
+****
-
+
#####
\ No newline at end of file
diff --git a/docs/products/msr2/setup/msr2-sensor-definitions.md b/docs/products/msr2/setup/msr2-sensor-definitions.md
index dd4addb328..3fb18f2a58 100755
--- a/docs/products/msr2/setup/msr2-sensor-definitions.md
+++ b/docs/products/msr2/setup/msr2-sensor-definitions.md
@@ -1,8 +1,8 @@
---
-title: MSR-2 Sensor Definitions
+title: MSR-2 sensor definitions
description: These are all of the entities exposed by the MSR-2 to automate on!
---
-# Sensor Definitions
+# Sensor definitions
Once added to Home Assistant you can configure different settings for your MSR-2. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them.
diff --git a/docs/products/msr2/setup/msr2-tuning-dashboard.md b/docs/products/msr2/setup/msr2-tuning-dashboard.md
index 2253e2a35e..0be781ac3e 100755
--- a/docs/products/msr2/setup/msr2-tuning-dashboard.md
+++ b/docs/products/msr2/setup/msr2-tuning-dashboard.md
@@ -1,8 +1,8 @@
---
-title: MSR-2 Tuning Dashboard Setup
+title: MSR-2 tuning dashboard setup
description: Tutorial on creating an MSR-2 tuning dashboard.
---
-# MSR-2 Tuning Dashboard
+# MSR-2 tuning dashboard
!!! tip "There is a newer way to do this"
@@ -12,9 +12,9 @@ description: Tutorial on creating an MSR-2 tuning dashboard.
We all owe a huge thanks to MirkoP from Discord/GitHub for creating and sharing this with everyone! Source here.
-This guide will create a beautiful and helpful dashboard to simplify configuration of your MSR-2 sensor. You can easily view the current gate and zone thresholds which will help tune your sensor for your environment!
+This guide will create a beautiful and helpful dashboard to simplify configuration of your MSR-2 sensor. You can view the current gate and zone thresholds which will help tune your sensor for your environment!
-1\. First make sure you have HACS installed - if not, download it here and install it.
+1\. First make sure you have HACS installed. If not, download it here and install it.
2\. Install the Streamline Card in HACS here which is required for the steps below.
@@ -35,7 +35,7 @@ This guide will create a beautiful and helpful dashboard to simplify configurati
!!! tip "Create backups to restore to before moving forward!"
- Back up your Home Assistant instance and back up a copy of the **Raw configuration editor** mentioned below before you make any changes just to be safe!
+ Back up your Home Assistant instance and back up a copy of the **Raw configuration editor** mentioned below before you make any changes, to be safe!
[](https://my.home-assistant.io/redirect/backup/)
@@ -43,7 +43,7 @@ This guide will create a beautiful and helpful dashboard to simplify configurati
!!! danger "This file is used by Home Assistant and must be carefully edited."
- 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.
+ 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.
diff --git a/docs/products/msr2/setup/zones-ha.md b/docs/products/msr2/setup/zones-ha.md
index 6d9d6d641c..27af95e338 100755
--- a/docs/products/msr2/setup/zones-ha.md
+++ b/docs/products/msr2/setup/zones-ha.md
@@ -1,8 +1,8 @@
---
-title: MSR-2 Home Assistant Zone Configuration
+title: MSR-2 Home Assistant zone configuration
description: Tutorial for MSR-2 Home Assistant Zone Configuration.
---
-# How To Tune the MSR-2 Using Home Assistant
+# How to tune the MSR-2 using Home Assistant
!!! tip "Prefer a guided dashboard?"
@@ -24,6 +24,8 @@ How to tune the mmWave sensor using radar engineering mode.
+You'll turn on Radar Engineering Mode to see the move and still energy for each gate.
+
1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) and select your MSR-2.
[](https://my.home-assistant.io/redirect/integration/?domain=esphome)
@@ -36,11 +38,21 @@ How to tune the mmWave sensor using radar engineering mode.
-The gates are 0.75 meter increments from the sensor - allowing you to "tune" each 0.75 meter section until your sensor works as intended!
-
-
-
-
+The gates are 0.75 meter increments from the sensor, allowing you to "tune" each 0.75 meter section until your sensor works as intended!
+
+| Gate | Distance (m / ft) | Default move threshold | Default still threshold |
+|---|---|---|---|
+| 0 | 0 m / 0' | 50 | 0 |
+| 1 | 0 - 0.75 m / 0' - 2.46' | 50 | 0 |
+| 2 | 0.75 - 1.5 m / 2.46' - 4.92' | 40 | 40 |
+| 3 | 1.5 - 2.25 m / 4.92' - 7.38' | 40 | 40 |
+| 4 | 2.25 - 3 m / 7.38' - 9.84' | 40 | 40 |
+| 5 | 3 - 3.75 m / 9.84' - 12.30' | 40 | 40 |
+| 6 | 3.75 - 4.5 m / 12.30' - 14.76' | 30 | 15 |
+| 7 | 4.5 - 5.25 m / 14.76' - 17.22' | 30 | 15 |
+| 8 | 5.25 - 6 m / 17.22' - 19.69' | 30 | 15 |
+
+
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.
diff --git a/docs/products/msr2/setup/zones-hlk.md b/docs/products/msr2/setup/zones-hlk.md
index 205c11c8a7..3e10291d1a 100755
--- a/docs/products/msr2/setup/zones-hlk.md
+++ b/docs/products/msr2/setup/zones-hlk.md
@@ -1,10 +1,12 @@
---
-title: MSR-2 HLKRadarTool app Zone Configuration
+title: MSR-2 HLKRadarTool app zone configuration
description: Tutorial for MSR-2 HLKRadarTool app Zone Configuration.
---
-# How To Tune MSR-2 Using HLKRadarTool
+# How to tune MSR-2 using HLKRadarTool
-## **Auto-Calibration**
+## **Auto-calibration**
+
+You'll connect the HLKRadarTool app to your sensor, measure your room's background noise, and pick one of the auto-calibration settings.
1\. Download the HLKRadarTool app.
@@ -18,47 +20,49 @@ description: Tutorial for MSR-2 HLKRadarTool app Zone Configuration.
The default password to connect to the HLKRadarTool is "HiLink".
-1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your MSR-2 and scroll down until you see LD2410 Bluetooth.
+2\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your MSR-2 and scroll down until you see LD2410 Bluetooth.
[](https://my.home-assistant.io/redirect/integration/?domain=esphome)
-2\. Open the app and select your device
+3\. Open the app and select your device
-3\. Turn on Engineering Mode
+4\. Turn on Engineering Mode
-4\. Select More and then select Parameter settings
+5\. Select More and then select Parameter settings
-5\. Select Detect background noise
+6\. 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\. 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.
+8\. Select Back to navigate to the Parameter settings. Then select one of the auto-calibration buttons.
-**Average** - Sets the gate sensitivity to the average move and still energy
+**Average**: Sets the gate sensitivity to the average move and still energy
-**Maximum** - Sets the gate sensitivity to the maximum 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.
+**Intelligent**: Sets the gate sensitivity equal to or just above the maximum move and still energy.
****
-## Manual Calibration
+## Manual calibration
+
+You'll set the motion and static sensitivity values yourself in the app.
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 f876bd6a41..9733474148 100755
--- a/docs/products/msr2/troubleshooting/msr2-boot-mode.md
+++ b/docs/products/msr2/troubleshooting/msr2-boot-mode.md
@@ -1,14 +1,16 @@
---
-title: Putting The MSR-2 In Boot Mode
+title: Putting the MSR-2 in boot mode
description: Step by step guide for putting The MSR-2 In Boot Mode.
---
-# Putting The MSR-2 In Boot Mode
+# Putting the MSR-2 in boot mode
!!! info "This will cover how to put the MSR-2 into boot mode."
This is needed to force the device into boot mode to reflash the firmware.
-## Method 1: Boot Button Only
+## Method 1: Boot button only
+
+You'll hold the boot button while you plug in the USB-C cable.
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,9 +20,11 @@ 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
+
+You'll use the boot and reset buttons together while the device is plugged into your computer.
-1\. Unplug the device and locate the boot and reset buttons as shown in the image above.
+1\. Unplug the device and locate the boot button (the right opening, shown in the image above) and the reset button (the left opening, shown in the image below).
2\. Plug it into your computer.
diff --git a/docs/products/msr2/troubleshooting/msr2-code.md b/docs/products/msr2/troubleshooting/msr2-code.md
index 34debc9944..e136751cb5 100755
--- a/docs/products/msr2/troubleshooting/msr2-code.md
+++ b/docs/products/msr2/troubleshooting/msr2-code.md
@@ -1,8 +1,8 @@
---
-title: Factory Re-Flash MSR-2
+title: Factory re-flash MSR-2
description: Step by step guide for re-flashing the MSR-2 back to factory firmware.
---
-# Factory Re-Flash MSR-2
+# Factory re-flash MSR-2
!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below."
@@ -18,23 +18,23 @@ If your device has already been connected to Home Assistant please Apollo MSR-2 Installer.
-3\. Click the big "Connect" button.
+4\. Click the big "Connect" button.
-3\. Select the open com port then click Connect.
+5\. Select the open com port then click Connect.
-4\. Click "Install MSR-2".
+6\. Click "Install MSR-2".
-5\. Click "INSTALL".
+7\. Click "INSTALL".
-6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
+8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
@@ -42,4 +42,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and set up your sensor as a new device!
\ No newline at end of file
+9\. 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/msr2/troubleshooting/msr2-reset-wi-fi-credentials.md b/docs/products/msr2/troubleshooting/msr2-reset-wi-fi-credentials.md
index b620b40871..ac5dd3331c 100755
--- a/docs/products/msr2/troubleshooting/msr2-reset-wi-fi-credentials.md
+++ b/docs/products/msr2/troubleshooting/msr2-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials
+title: Reset Wi-Fi credentials
description: Step by step guide for resetting the Wi-Fi Credentials on your MSR-2.
---
-# Reset Wi-Fi Credentials on your MSR-2
+# Reset Wi-Fi credentials on your MSR-2
+
+You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot.
1\. Plug the device into power.
diff --git a/docs/products/msr2/troubleshooting/msr2-teardown.md b/docs/products/msr2/troubleshooting/msr2-teardown.md
index 8c3339679d..577207c4d6 100755
--- a/docs/products/msr2/troubleshooting/msr2-teardown.md
+++ b/docs/products/msr2/troubleshooting/msr2-teardown.md
@@ -1,7 +1,7 @@
---
-title: MSR-2 Teardown
+title: MSR-2 teardown
description: Step by step guide for tearing down your MSR-2 to replace parts, clean it, swap cases, etc.
---
-# Teardown and Reassembly Of MSR-2
+# Teardown and reassembly of MSR-2
\ No newline at end of file
diff --git a/docs/products/mtr1/additional-info/bluetooth-proxy.md b/docs/products/mtr1/additional-info/bluetooth-proxy.md
index 22ad1974da..f535a7db9a 100644
--- a/docs/products/mtr1/additional-info/bluetooth-proxy.md
+++ b/docs/products/mtr1/additional-info/bluetooth-proxy.md
@@ -1,8 +1,8 @@
---
-title: MTR-1 Bluetooth Proxy
+title: MTR-1 Bluetooth proxy
description: Tutorial for how to turn your MTR-1 into a BLE proxy!
---
-# MTR-1 Bluetooth Proxy
+# MTR-1 Bluetooth proxy
--8<-- "_snippets/bluetooth-proxy/intro.md"
diff --git a/docs/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md b/docs/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
index 5ec6b68b9e..f66c505aae 100755
--- a/docs/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-90-degree-usb-c-to-mtr-1.md
@@ -1,9 +1,11 @@
---
-title: adding 90 degree USB-C to MTR-1
+title: Adding 90 degree USB-C to MTR-1
description: Step by step tutorial for adding 90 degree USB-C to MTR-1.
---
# Adding 90 degree USB-C to MTR-1
+You'll attach this addon to your sensor and plug it into an outlet.
+
1\. Gather the MTR-1, 90 degree addon, and optional top facing USB-C Plug.
diff --git a/docs/products/mtr1/addons/adding-articulating-stand-to-mtr-1.md b/docs/products/mtr1/addons/adding-articulating-stand-to-mtr-1.md
index f153061cf4..0a2d7339f6 100755
--- a/docs/products/mtr1/addons/adding-articulating-stand-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-articulating-stand-to-mtr-1.md
@@ -1,8 +1,10 @@
---
-title: adding Articulating Stand to MTR-1
+title: Adding articulating stand to MTR-1
description: Step by step tutorial for adding the Articulating Stand addon to the MTR-1.
---
-# Adding Articulating Stand To MTR-1
+# Adding articulating stand to MTR-1
+
+You'll swap the back of your sensor for the articulating stand backplate, then seat the stand's ball in its mount.
1\. Unplug your MTR-1 from power and remove the stand if attached.
diff --git a/docs/products/mtr1/addons/adding-co2-to-mtr-1.md b/docs/products/mtr1/addons/adding-co2-to-mtr-1.md
index bff119f181..be0ab31e93 100755
--- a/docs/products/mtr1/addons/adding-co2-to-mtr-1.md
+++ b/docs/products/mtr1/addons/adding-co2-to-mtr-1.md
@@ -1,9 +1,11 @@
---
-title: adding CO2 to MTR-1
+title: Adding CO2 to MTR-1
description: Step by step tutorial for adding the SCD40 CO2 sensor to the MTR-1.
---
-# Adding CO2 To MTR-1
+# Adding CO2 to MTR-1
+
+You'll slide your sensor out of its case, fit the SCD40 module onto its mezzanine connector, and put the case back together.
1\. Unplug your MTR-1 from power and remove the stand if attached.
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 9bf63fb5d7..45e35600af 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
@@ -1,8 +1,10 @@
---
-title: adding GPIO Header Addon to MTR-1
+title: Adding GPIO header addon to MTR-1
description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1.
---
-# Adding GPIO Header To MTR-1
+# Adding GPIO header to MTR-1
+
+You'll seat the GPIO Header addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it.
1\. Unplug your MTR-1 from power and remove the stand if attached.
@@ -20,11 +22,11 @@ description: Step by step tutorial for adding the GPIO Header Addon to the MTR-1
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!
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 36246b478b..237266c8c3 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
@@ -1,8 +1,10 @@
---
-title: adding Rear Male USB to MTR-1
+title: Adding rear male USB to MTR-1
description: Step by step tutorial for adding the Rear Male USB addon to the MTR-1.
---
-# Adding Rear male USB-C To MTR-1
+# Adding rear male USB-C to MTR-1
+
+You'll seat the Rear Male USB-C addon on the mezzanine connector on the back of your sensor, then fit the new back that came with it.
1\. Unplug your MTR-1 from power and remove the stand if attached.
diff --git a/docs/products/mtr1/examples/crookedtoe-mtr1.md b/docs/products/mtr1/examples/crookedtoe-mtr1.md
index a081e7ce44..31965faaff 100755
--- a/docs/products/mtr1/examples/crookedtoe-mtr1.md
+++ b/docs/products/mtr1/examples/crookedtoe-mtr1.md
@@ -1,7 +1,7 @@
---
-title: MTR-1 Corner Mount
+title: MTR-1 corner mount
description: MTR-1 Corner Mount STL file
---
-# MTR-1 Corner Mount STL by user CrookedToe
+# MTR-1 corner mount STL by user CrookedToe
## [https://www.printables.com/model/941493-mtr-1-inside-corner-mount](https://www.printables.com/model/941493-mtr-1-inside-corner-mount)
\ 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 c42e0d61e9..6d39d13d15 100755
--- a/docs/products/mtr1/examples/mtr1-alarmo.md
+++ b/docs/products/mtr1/examples/mtr1-alarmo.md
@@ -2,7 +2,7 @@
title: MTR-1 Alarmo setup
description: MTR-1 Alarmo setup
---
-# MTR-1 + Alarmo Home Security Install
+# MTR-1 + Alarmo home security install
My grandmother wanted a security system that would alert her when there was movement in her home after she had gone to bed. So, I set up three of our Apollo Automation mmWave sensors. These devices, plus the Alarmo integration, quickly allowed me to install a fully local, private, cloud-free, and no monthly subscription security system. She can arm/disarm it with one button on her Home Assistant dashboard, and it makes her feel much safer. This guide assumes you already have a motion/presence sensor installed on HA.
@@ -27,6 +27,8 @@ Restart Home Assistant once both are installed, then add the Alarmo integration
+*Shown with MSR-1 sensors; add your MTR-1 target entities the same way.*
+
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.)
@@ -39,10 +41,14 @@ Restart Home Assistant once both are installed, then add the Alarmo integration
+*Shown with AIR-1 and MSR-1 lights; pick your MTR-1 RGB light the same way.*
+
7\. Under Action select Turn On and now your sensors' RGB lights will turn on when the alarm is triggered.
+*Shown with AIR-1 and MSR-1 lights; the MTR-1 steps are the same.*
+
8\. And that's it, seriously... Now you can enjoy a free and local security system.
We hope this was helpful and please let us know if there are any questions!
\ No newline at end of file
diff --git a/docs/products/mtr1/faq.md b/docs/products/mtr1/faq.md
index bf1f8ce34c..fa8cb97ac1 100755
--- a/docs/products/mtr1/faq.md
+++ b/docs/products/mtr1/faq.md
@@ -16,7 +16,7 @@ description: Frequently asked questions about the MTR-1 mmWave sensor.
4\. **What is the maximum detection range of the mmWave radar?**
-* The mmWave radar sensor in the MTR-1 has a maximum detection range of 6 meters (about 19.6 feet), making it ideal for monitoring large rooms or spaces.
+* The mmWave radar sensor in the MTR-1 has a maximum detection range of 6 meters (about 19.7 feet), making it ideal for monitoring large rooms or spaces.
5\. **Can the MTR-1 be used to track the exact location of people in a room?**
@@ -56,7 +56,7 @@ description: Frequently asked questions about the MTR-1 mmWave sensor.
14\. **Does the MTR-1 work with other smart home platforms?**
-* The MTR-1 is designed to work seamlessly with Home Assistant via ESPHome. While it could potentially be integrated into other smart home platforms through custom configurations, its primary use case is for Home Assistant.
+* The MTR-1 is designed to work with Home Assistant via ESPHome. While it could potentially be integrated into other smart home platforms through custom configurations, its primary use case is for Home Assistant.
15\. **How does the temperature and pressure sensor work?**
@@ -84,7 +84,7 @@ description: Frequently asked questions about the MTR-1 mmWave sensor.
21\. **Can I use multiple MTR-1 sensors in my smart home setup?**
-* Yes, you can integrate multiple MTR-1 sensors into your Home Assistant system. Each will show up as a separate entity, allowing you to monitor multiple rooms or areas in your home simultaneously.
+* Yes, you can integrate multiple MTR-1 sensors into your Home Assistant system. Each one shows up as its own device with its own set of entities, so you can monitor multiple rooms or areas in your home at the same time.
22\. **What’s the difference between the MTR-1 and MSR-2?**
@@ -120,7 +120,7 @@ description: Frequently asked questions about the MTR-1 mmWave sensor.
30\. **How long does it take to set up the MTR-1?**
-* Setup is quick and easy. Most users report being able to configure and integrate the MTR-1 into their Home Assistant setup within 10-15 minutes.
+* Setup is quick. Most users report being able to configure and integrate the MTR-1 into their Home Assistant setup within 10-15 minutes.
31\. **What’s in the box?**
diff --git a/docs/products/mtr1/mtr1-reviews.md b/docs/products/mtr1/mtr1-reviews.md
index 8b8a119fac..da8c4609b0 100755
--- a/docs/products/mtr1/mtr1-reviews.md
+++ b/docs/products/mtr1/mtr1-reviews.md
@@ -1,14 +1,14 @@
---
-title: MTR1 Reviews
+title: MTR1 reviews
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)
+# [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 51290b8977..c8805b1ed7 100755
--- a/docs/products/mtr1/setup/general-tips.md
+++ b/docs/products/mtr1/setup/general-tips.md
@@ -1,14 +1,14 @@
---
-title: MTR-1 General Tips
+title: MTR-1 general tips
description: Multiple helpful images for mounting, lux/rgb, and zone visualization.
---
-# General Tips
+# General tips
-## **MTR-1 PCB with Sensors**
+## **MTR-1 PCB with sensors**
-## **Light Sensor (LTR-390UV)**
+## **Light sensor (LTR-390UV)**
@@ -20,23 +20,23 @@ The onboard RGB LED will trigger the light sensor. Be cognizant of this when mak
-## **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/sensor-definitions.md b/docs/products/mtr1/setup/sensor-definitions.md
index c4919b46f1..250b6c1343 100755
--- a/docs/products/mtr1/setup/sensor-definitions.md
+++ b/docs/products/mtr1/setup/sensor-definitions.md
@@ -1,8 +1,8 @@
---
-title: MTR-1 Sensor Definitions
+title: MTR-1 sensor definitions
description: These are all of the entities exposed by the MTR-1 to automate on!
---
-# Sensor Definitions
+# Sensor definitions
Once added to Home Assistant you can configure different settings for your MTR-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them.
@@ -60,8 +60,8 @@ Once added to Home Assistant you can configure different settings for your MTR-1
| **Multi Target Tracking** | from module | Turns multi-target tracking on or off. Initial state is read from the LD2450 at boot. |
| **Timeout** | 5 s | How long presence stays detected after the target is lost. See the ESPHome LD2450 docs. |
| **Zone Type** | Disabled | Zone detection mode: `Disabled`, `Detection` (only detect targets inside the zone), or `Filter` (exclude the zone from detection). |
- | **Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-3000 left to 3000 right). |
- | **Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 6000). |
+ | **Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-4860 left to 4860 right). |
+ | **Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 7560). |
| **DPS310 Pressure Offset** | 0.0 hPa | Calibration offset for the DPS310 pressure reading. Disabled by default. |
| **DPS310 Temperature Offset** | — | Calibration offset for the DPS310 temperature reading. |
| **SCD40 Temperature Offset** | — | Calibration offset for the SCD40 temperature reading. Disabled by default. |
diff --git a/docs/products/mtr1/setup/zones-ha.md b/docs/products/mtr1/setup/zones-ha.md
index 2a9d8de209..32c5767793 100755
--- a/docs/products/mtr1/setup/zones-ha.md
+++ b/docs/products/mtr1/setup/zones-ha.md
@@ -1,87 +1,113 @@
---
-title: MTR-1 Home Assistant Zone Configuration
-description: Tutorial for MTR-1 Home Assistant Zone Configuration.
+title: MTR-1 Home Assistant zone configuration
+description: Set up the three radar zones on your MTR-1 in Home Assistant by entering X and Y coordinates, using a Plotly card that shows the radar's live targets.
---
-# How To Tune The MTR-1 Using Home Assistant
+# How to tune the MTR-1 using Home Assistant
!!! tip "Prefer a guided dashboard?"
The Apollo mmWave integration gives your Apollo MTR-1 its own dashboard tab with a zone map where you draw zones over the radar's live targets, with no Plotly card or YAML to set up. The [Apollo mmWave dashboard guide](/products/mtr1/setup/apollo-mmwave-dashboard.md#draw-zones-on-the-r-pro-1-and-mtr-1) walks you through it as a guided alternative to the manual steps below.
-Below are steps to 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 MTR-1.
+This guide shows you how to set up your MTR-1's three zones by entering the X and Y coordinates for each one. First you add a card to your dashboard that shows the radar's live targets, then you use it to work out the coordinates for each zone, in millimeters. You can enter the values in Home Assistant, as shown below, or directly on the device's web page by visiting its IP address or hostname.local.
+
+Tuning with the [HLK Radartool app](/products/mtr1/setup/zones-hlk.md) is much easier, and it's the method we suggest for setting up your MTR-1.
+
+## Add the target card to your dashboard
+
+Start by adding a Plotly card that draws the radar's coverage area, your three zones, and the targets the radar sees.
1\. Install [HACS](https://hacs.xyz/docs/use/).
2\. Download [Plotly](https://github.com/dbuezas/lovelace-plotly-graph-card "Click here to install Plotly!") inside HACS.
-3\. Enter your device’s full name and optionally customize the names of the three zones using the tool below. Then click **Generate YAML** and **Copy YAML.**If you're unsure of your device name, go to the ESPHome Integrations page, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_r\_mtr\_1\_c64a28", with six random characters at the end. +3\. In the tool below, enter your device's full name and, if you like, rename the three zones. Then click **Generate YAML** and **Copy YAML**. + +Not sure of your device name? Go to the ESPHome Integrations page (**Settings → Devices & services → ESPHome**), select your device, and look for the full name. Unless you've renamed it, it looks something like `apollo_mtr_1_c64a28`, ending in six random characters. -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. +4\. Open a dashboard and click the pencil icon to edit it. Click one of the large **+** signs, type "manual", and select the **Manual** card.  -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! +*Shown with an R PRO-1 card; the MTR-1 steps are the same.* + +5\. Delete any text in the card, paste the YAML you copied in step 3, and click **Save**.  -6\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page") +Your dashboard now has a card like the one above, showing the radar's coverage area and your three zones. + +## Open your MTR-1's device page + +The target sensors and zone settings are on your MTR-1's page in the ESPHome integration. -7\. Click device as shown in the image below +1\. Head to the [ESPHome Integrations page](http://homeassistant.local:8123/config/integrations/integration/esphome "Click me to go to the ESPHome integrations page") (**Settings → Devices & services → ESPHome**). + +2\. Click your 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. +## Switch the target sensors to millimeters (imperial units only) -!!! tip "Suggested settings" +!!! note "Metric users can skip this section" - * Multi Target Tracking toggled on helps it detect up to three targets better. - * Zone Type allows you to select Disabled, Detection, or Filter. - * Disabled: Disable zone area detection. - * Detection: Only detects targets in the specified zone. - * Filter: Excludes a zone from detection. + If your Home Assistant uses the metric system, go straight to [Enter your zones](#enter-your-zones). -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. +If you use the imperial system, your Target 1-3 X and Y sensors report in inches (in). For the targets to show up correctly on the card, change all three X and all three Y target sensors to millimeters (mm). - +1\. In the **Sensors** section, find the Target 1-3 X and Y sensors and select one of them. -!!! tip "Helpful Hints to understand zones better!" + - * X1 must always be less than X2, and Y1 must always be less than Y2. +2\. Select the Settings cog in the top right. - * The Y axis is easier since it's never negative. + - +3\. Change the unit of measurement to **mm** and select **Update**. - * The X axis is where you can get tripped up, especially when both values are negative: -3456 is less than -2345. - * The Plotly chart will still render the rectangles even if the X1/X2 and Y1/Y2 values are reversed. - * The zones cannot overlap. + -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. +4\. Repeat steps 1 to 3 for each of the other target sensors, so all three X and all three Y sensors are updated. Your X and Y targets now look like this. - + -11\. Select the Settings cog in the top right. +5\. Check your Plotly card. Your targets now appear on it. - + -12\. Change the unit of measurement to mm and select Update. +Your card now shows live targets, so you're ready to draw zones around them. - +## Enter your zones -13\. Your X and Y Targets will now look like this. +Now use the live targets on the card to find the coordinates for each zone, and enter them on your MTR-1's device page. - +1\. Scroll down to the **Configuration** section, where you see the empty boxes for the X and Y coordinates of zones 1-3. -14\. Now you should see targets on the card. +!!! tip "Suggested settings" - + * Turn on **Multi Target Tracking** to help the MTR-1 detect up to three targets better. + * **Zone Type** lets you select **Disabled**, **Detection**, or **Filter**: + * **Disabled**: disables zone area detection. + * **Detection**: only detects targets in the specified zone. + * **Filter**: excludes the zone from detection. + +2\. Walk, sit, or stand in the area where you want a detection or non-detection zone, and watch where your target appears on the card. Then enter the Zone 1-3 X and Y values to draw zones around the targets you want to detect or filter out. X values go from -4860 mm to 4860 mm, and Y values go from 0 mm to 7560 mm. + + + +!!! tip "Helpful hints for understanding zones" + + * X1 must always be less than X2, and Y1 must always be less than Y2. + * The Y axis is simpler, since it's never negative. + * The X axis is where you can get tripped up, especially when both values are negative: -3456 is less than -2345. + * The Plotly chart still draws the rectangles even if the X1/X2 and Y1/Y2 values are reversed, so check the order yourself. + * Zones can't overlap. -15\. Now we can make zones around the targets where you want to Detect presence or filter them out. +Your zones now show on the card, and your MTR-1 uses them to detect or filter out targets. -!!! tip tip "Tip for zone configuration resetting" +!!! tip "Zones reset after a restart?" - 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 \ No newline at end of file + If your zone configurations aren't saved when you restart the device, try turning on **LD2450 Bluetooth** for a few seconds and then turning it off again. You can also try turning on **Multi Target Tracking**. This should wake up the mmWave module and retrieve your saved zones. diff --git a/docs/products/mtr1/setup/zones-hlk.md b/docs/products/mtr1/setup/zones-hlk.md index ac3b0a5ea3..244e21753f 100755 --- a/docs/products/mtr1/setup/zones-hlk.md +++ b/docs/products/mtr1/setup/zones-hlk.md @@ -1,10 +1,10 @@ --- -title: MTR-1 HLKRadarTool app Zone Configuration +title: MTR-1 HLKRadarTool app zone configuration 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. " @@ -20,6 +20,8 @@ The Click here to download +With the app installed, you'll turn on the radar's Bluetooth, connect to it from the HLKRadarTool app, and set up your zones. + 1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your MTR-1 and scroll down until you see LD2450 Bluetooth. [](https://my.home-assistant.io/redirect/integration/?domain=esphome) @@ -38,13 +40,13 @@ The **Disabled**: Disable zone area detection
**Detection**: Only detects targets in the specified zone
**Filter**: Excludes a zone from detection + You can use any of these three choices to control your MTR-1 differently. The most common option is **Area Detection**, which lets you set up three areas and track three targets within them.
**Close detection** (Disabled in Home Assistant): zone detection is off
**Area Detection** (Detection): only detects targets inside your zones
**Area Filtering** (Filter): ignores targets inside your zones - 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! + Close detection lets you use the sensor as a basic presence sensor, and Area Filtering lets you filter out an area and detect everything else, which is useful to avoid a fan!  @@ -66,7 +68,9 @@ The If you're unsure of your device name, go to **Settings → Devices & services → ESPHome**, select your device, and look for the full name. Unless you’ve renamed it, it will likely be something like "apollo\_mtr\_1\_c64a28", with six random characters at the end. @@ -82,6 +86,8 @@ The uploading the firmware document. -## Method 2: Boot and Reset Buttons +## Method 2: Boot and reset buttons + +You'll use the boot and reset buttons together while the device is plugged into your computer. -1\. Unplug the device and locate the boot and reset buttons as shown in the image above. +1\. Unplug the device and locate the boot button (the right opening, shown in the image above) and the reset button (the left opening, shown in the image below). 2\. Plug it into your computer. diff --git a/docs/products/mtr1/troubleshooting/mtr1-code.md b/docs/products/mtr1/troubleshooting/mtr1-code.md index 9cd37c913d..d48267b2e1 100755 --- a/docs/products/mtr1/troubleshooting/mtr1-code.md +++ b/docs/products/mtr1/troubleshooting/mtr1-code.md @@ -1,8 +1,8 @@ --- -title: Factory Re-Flash MTR-1 +title: Factory re-flash MTR-1 description: Step by step guide for re-flashing the MTR-1 back to factory firmware. --- -# Factory Re-Flash MTR-1 +# Factory re-flash MTR-1 !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." @@ -10,6 +10,8 @@ description: Step by step guide for re-flashing the MTR-1 back to factory firmwa If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. +Follow these steps to put your device in boot mode and install the factory firmware. + 1\. Position the MTR-1 as shown in the image below and locate the small opening to press the boot button (the right button).  @@ -18,23 +20,23 @@ If your device has already been connected to Home Assistant please Apollo MTR-1 Installer. -3\. Click the big "Connect" button. +4\. Click the big "Connect" button.  -3\. Select the open com port then click Connect. +5\. Select the open com port then click Connect.  -4\. Click "Install MTR-1". +6\. Click "Install MTR-1".  -5\. Click "INSTALL". +7\. Click "INSTALL".  -6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +8\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.  @@ -42,4 +44,4 @@ If your device has already been connected to Home Assistant please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file +9\. 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/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md b/docs/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md index b036cc0c82..261ec882bb 100755 --- a/docs/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md +++ b/docs/products/mtr1/troubleshooting/mtr1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials -description: Step by step guide for resetting the Wi-Fi Credentials on your AIR-1. +title: Reset Wi-Fi credentials +description: Step by step guide for resetting the Wi-Fi credentials on your MTR-1. --- -# Reset Wi-Fi Credentials +# Reset Wi-Fi credentials + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the device into power diff --git a/docs/products/mtr1/troubleshooting/mtr1-teardown.md b/docs/products/mtr1/troubleshooting/mtr1-teardown.md index e87310943b..6271f54d4d 100755 --- a/docs/products/mtr1/troubleshooting/mtr1-teardown.md +++ b/docs/products/mtr1/troubleshooting/mtr1-teardown.md @@ -1,8 +1,8 @@ --- -title: MTR-1 Teardown +title: MTR-1 teardown description: Step by step guide for tearing down your MTR-1 to replace parts, clean it, swap cases, etc. --- -# Teardown and Reassembly of the MTR-1 +# Teardown and reassembly of the MTR-1 diff --git a/docs/products/new-product-template/addons/productname-addon.md b/docs/products/new-product-template/addons/productname-addon.md index 64de2646de..f43b6fd5e3 100755 --- a/docs/products/new-product-template/addons/productname-addon.md +++ b/docs/products/new-product-template/addons/productname-addon.md @@ -1,8 +1,8 @@ --- -title: Attaching Inlet and Outlet tubes to the PUMP-1 +title: Attaching inlet and outlet tubes to the PUMP-1 description: Tutorial for attaching both the Inlet and the Outlet tubes for the PUMP-1 --- -# Attaching Inlet and Outlet tubes to the PUMP-1 +# Attaching inlet and outlet tubes to the PUMP-1 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/new-product-template/examples/example.md b/docs/products/new-product-template/examples/example.md index 621a1c2b4e..94413f7e2d 100755 --- a/docs/products/new-product-template/examples/example.md +++ b/docs/products/new-product-template/examples/example.md @@ -1,5 +1,5 @@ --- -title: Example Title +title: Example title description: Example Description --- # Examples diff --git a/docs/products/new-product-template/faq.md b/docs/products/new-product-template/faq.md index 2f6bd766a0..b3682b47ba 100755 --- a/docs/products/new-product-template/faq.md +++ b/docs/products/new-product-template/faq.md @@ -28,7 +28,7 @@ description: Frequently asked questions about the PUMP-1 Fluid Pump Sensor 7\. **Can I use the PUMP-1 to automate watering for plants?** -* Absolutely! It’s designed to integrate seamlessly with our PLT-1 plant sensor for automated watering. +* Absolutely! It’s designed to integrate with our PLT-1 plant sensor for automated watering. 8\. **Can the pump detect when to stop watering automatically?** @@ -40,7 +40,7 @@ description: Frequently asked questions about the PUMP-1 Fluid Pump Sensor 10\. **How large is the PUMP-1?** -* The pump measures 3.4in x 1.3in x 1.8in (86.4mm x 33mm x 45.7mm), making it compact and easy to install. +* The pump measures 3.4in x 1.3in x 1.8in (86.4mm x 33mm x 45.7mm), making it compact. 11\. **How do I control the pump?** diff --git a/docs/products/new-product-template/introduction.md b/docs/products/new-product-template/introduction.md index 465778d522..cf8e6bff99 100755 --- a/docs/products/new-product-template/introduction.md +++ b/docs/products/new-product-template/introduction.md @@ -6,10 +6,10 @@ description: Documentation for PUMP-1, including setup, usage, and best practice  -The Apollo PUMP-1 is a versatile, compact, and food-safe fluid pump designed to integrate seamlessly with our PLT-1 plant sensor to automate your watering needs. It features two ports for fluid sensors that detect water presence, allowing the pump to automatically stop when watering is complete or if your water bottle runs empty, protecting your system from damage. +The Apollo PUMP-1 is a versatile, compact, and food-safe fluid pump designed to integrate with our PLT-1 plant sensor to automate your watering needs. It features two ports for fluid sensors that detect water presence, allowing the pump to automatically stop when watering is complete or if your water bottle runs empty, protecting your system from damage. Perfect for smart home gardeners, the PUMP-1 takes the hassle out of plant care by delivering precise, controlled watering automatically. -Beyond plants, the PUMP-1 is ideal for a variety of other uses such as filling fish tanks, robot vacuum mop tanks, pet bowls, coffee pots, and more. Its reliable performance, food-safe materials, and easy integration make it a perfect addition to any home automation setup. +Beyond plants, the PUMP-1 is ideal for a variety of other uses such as filling fish tanks, robot vacuum mop tanks, pet bowls, coffee pots, and more. Its reliable performance, food-safe materials, and smart home integration make it a perfect addition to any home automation setup. Experience effortless and safe fluid control with the Apollo PUMP-1. Smart, simple, and adaptable. \ No newline at end of file diff --git a/docs/products/new-product-template/productname-reviews.md b/docs/products/new-product-template/productname-reviews.md index ce6bac0859..7d9ce6f292 100755 --- a/docs/products/new-product-template/productname-reviews.md +++ b/docs/products/new-product-template/productname-reviews.md @@ -1,5 +1,5 @@ --- -title: PUMP-1 Reviews +title: PUMP-1 reviews description: YouTuber and other Influencer reviews and feedback about the PUMP-1 sensor from Apollo Automation. --- -# WAITING FOR REVIEWS \ No newline at end of file +# Waiting for reviews \ No newline at end of file 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 57e68a472a..693ecd3fe9 100755 --- a/docs/products/new-product-template/setup/productname-general-tips.md +++ b/docs/products/new-product-template/setup/productname-general-tips.md @@ -1,15 +1,13 @@ --- -title: PUMP-1 General Tips -description: >- - Multiple helpful images for mounting, lux/rgb, and gate and zone - visualization. +title: PRODUCTNAME general tips +description: General tips for using the PRODUCTNAME. --- -# General Tips +# 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 +There is a disabled entity by default called **Pump Control** which will 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/setup/productname-sensor-definitions.md b/docs/products/new-product-template/setup/productname-sensor-definitions.md index 141f99ec07..8ed1cef6e6 100755 --- a/docs/products/new-product-template/setup/productname-sensor-definitions.md +++ b/docs/products/new-product-template/setup/productname-sensor-definitions.md @@ -1,8 +1,8 @@ --- -title: PUMP-1 Sensor Definitions +title: PUMP-1 sensor definitions description: These are all of the entities exposed by the PUMP-1 to automate on! --- -# Sensor Definitions +# Sensor definitions This serves as a list of all sensor definitions to help understand what each entity does for your new PUMP-1! 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 f46c35b72f..8a6315552a 100755 --- a/docs/products/new-product-template/troubleshooting/productname-boot-mode.md +++ b/docs/products/new-product-template/troubleshooting/productname-boot-mode.md @@ -1,20 +1,22 @@ --- -title: Putting The PUMP-1 In Boot Mode +title: Putting the PUMP-1 in boot mode description: Step by step guide for putting The PUMP-1 In Boot Mode. --- -# Putting The PUMP-1 In Boot Mode +# Putting the PUMP-1 in boot mode !!! info "This will cover how to put the PUMP-1 into 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 + +You'll hold the boot button while you plug in the USB-C cable. !!! danger "Empty the water reservoir and make sure no water is present in the tubes" - Make sure that there is no water which is able to damage the device. This is a precautionary measure just to be safe! + Make sure that there is no water which is able to damage the device. This is a precautionary measure to be safe! -1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button—it’s the button on the right. +1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button. It’s the button on the right. 2\. Plug in a USB cable that supports power and data into your computer. @@ -26,7 +28,9 @@ 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 + +You'll use the boot and reset buttons together while the device is plugged into your computer. 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-reflash.md b/docs/products/new-product-template/troubleshooting/productname-reflash.md index 351a27f644..7008258e70 100755 --- a/docs/products/new-product-template/troubleshooting/productname-reflash.md +++ b/docs/products/new-product-template/troubleshooting/productname-reflash.md @@ -1,18 +1,18 @@ --- -title: Reflashing The PUMP-1. +title: Reflashing the PUMP-1. description: Step by step guide for reflashing The PUMP-1. --- -# Reflashing The PUMP-1 +# Reflashing the PUMP-1 !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser. -1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button—it’s the button on the right. +1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button. It’s the button on the right. !!! danger "Empty the water reservoir and make sure no water is present in the tubes" - Make sure that there is no water which is able to damage the device. This is a precautionary measure just to be safe! + Make sure that there is no water which is able to damage the device. This is a precautionary measure to be safe! 2\. Plug in a USB cable that supports power and data into your computer. @@ -28,7 +28,7 @@ description: Step by step guide for reflashing The PUMP-1.  -7\.. Click Install PUMP-1. +6\. Click Install PUMP-1.  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 ec352e0fbf..d4a514c716 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 @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials +title: Reset Wi-Fi credentials description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP-1. --- -# Reset Wi-Fi Credentials on your PUMP-1 +# Reset Wi-Fi credentials on your PUMP-1 + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the PUMP-1 into power. diff --git a/docs/products/new-product-template/troubleshooting/productname-teardown.md b/docs/products/new-product-template/troubleshooting/productname-teardown.md index d4f0bfc131..d34c8e683a 100755 --- a/docs/products/new-product-template/troubleshooting/productname-teardown.md +++ b/docs/products/new-product-template/troubleshooting/productname-teardown.md @@ -1,13 +1,15 @@ --- -title: PUMP-1 Teardown +title: PUMP-1 teardown description: >- Step by step guide for tearing down your PUMP-1 to replace parts, clean it, swap cases, etc. --- -# Teardown and Reassembly Of PUMP-1 +# Teardown and reassembly of PUMP-1 ## Disassembly +You'll unplug the pump, remove its lid, and detach the sensor connectors and tubes. + !!! danger "Drain all liquid from the PUMP-1 before disassembling!" Ensure the PUMP-1 is fully drained of liquid before removing any tubes. Failure to do so may result in damage to the unit. @@ -20,7 +22,7 @@ description: >-  -3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling - this makes removal much easier. +3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling. This makes removal much easier.  diff --git a/docs/products/plt1/additional-info/bluetooth-proxy.md b/docs/products/plt1/additional-info/bluetooth-proxy.md index cb7b7236a4..5683118dae 100644 --- a/docs/products/plt1/additional-info/bluetooth-proxy.md +++ b/docs/products/plt1/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: PLT-1 Bluetooth Proxy +title: PLT-1 Bluetooth proxy description: Tutorial for how to turn your PLT-1 into a BLE proxy! --- -# PLT-1 Bluetooth Proxy +# PLT-1 Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" diff --git a/docs/products/plt1/examples/blueprint.md b/docs/products/plt1/examples/blueprint.md index e7c7289dd3..9f2e2dac14 100644 --- a/docs/products/plt1/examples/blueprint.md +++ b/docs/products/plt1/examples/blueprint.md @@ -1,12 +1,14 @@ --- -title: PLT-1 Plant Sensor Alerts Blueprint +title: PLT-1 plant sensor alerts blueprint description: >- Example of how to use the PLT-1 Plant Sensor Alerts Blueprint in Home Assistant to receive notifications when your plant needs attention! --- -# Blueprint Setup +# Blueprint setup -## Automatic Import +## Automatic import + +You'll import the blueprint with the button below, then set it up to send push notifications when your plant needs attention. 1\. Click the Import Blueprint button below and then click **Open link**. @@ -14,19 +16,13 @@ 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. - - +3\. In your blueprints list, click **Apollo Automation PLT-1 Blueprint** to start a new automation from it. Click **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!" +!!! success "Each sensor group is disabled by default. Enable only what matters!" Soil Moisture alerts are enabled out of the box. Expand any sensor group, toggle it on, and set your preferred min/max thresholds. Expand **Repeat Alerts** to control how often you are reminded while a condition lasts. @@ -37,7 +33,9 @@ description: >- 7\. Click **Save**. Your blueprint is now live and will send push notifications whenever your plant needs attention! -## Manual Import +## Manual import + +You can also import the blueprint by pasting its address into Home Assistant yourself. 1\. Head to the automations page (**Settings → Automations & scenes**) and click on **Blueprints** in the top right then select **Import Blueprint**. @@ -51,17 +49,11 @@ description: >- https://raw.githubusercontent.com/ApolloAutomation/Blueprints/refs/heads/main/PLT-1/PLT-1.yaml ``` - - -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. - - +3\. In your blueprints list, click **Apollo Automation PLT-1 Blueprint** to start a new automation from it. Click **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!" +!!! success "Each sensor group is disabled by default. Enable only what matters!" Soil Moisture alerts are enabled out of the box. Expand any sensor group, toggle it on, and set your preferred min/max thresholds. Expand **Repeat Alerts** to control how often you are reminded while a condition lasts. diff --git a/docs/products/plt1/examples/flower-card.md b/docs/products/plt1/examples/flower-card.md index 20cb7185a3..6492a6ab87 100755 --- a/docs/products/plt1/examples/flower-card.md +++ b/docs/products/plt1/examples/flower-card.md @@ -1,30 +1,55 @@ --- title: PLT-1 Flower Card -description: This suggests using the Flower Card inside Home Assistant for your device! +description: Show your plant sensor's readings as bars on a Flower Card in Home Assistant, using the Plant integration, optional OpenPlantBook data, and the Flower Card from HACS. --- +# Flower Card + +A Flower Card shows your plant's readings on your Home Assistant dashboard, with a bar for each one, such as moisture, temperature, light, and humidity. +  -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. Install it through HACS with the button below. +To set one up, you install up to three things through HACS, then add the card to a dashboard. Work through the sections below in order: + +1. Install the Plant integration. +2. Install the OpenPlantBook integration (optional). +3. Install the Flower Card. +4. Add the card to your dashboard. + +## Install the Plant integration + +The Home Assistant Plant integration lets you set up your plants in the Home Assistant UI. You can manage all of their configuration there or with automations and scripts. + +If you're a registered OpenPlantBook user, the Plant integration can automatically fetch data from it. Registration is free. + +Install the Plant integration through HACS with the button below. [](https://my.home-assistant.io/redirect/hacs_repository/?owner=Olen&repository=homeassistant-plant&category=integration) -Open Plant Book Integration
This integration allows fetching plants information from and uploading plant sensors' data to OpenPlantBook. It creates a few service calls in Home Assistant to interact with OpenPlantbook API which are: +## Install the OpenPlantBook integration (optional) + +The OpenPlantBook integration fetches plant information from OpenPlantBook and uploads your plant sensors' data to it. It creates a few service calls in Home Assistant for working with the OpenPlantBook API: * Search plant * Get plant details * Upload plants sensors data -This is used as a base for the sister-integration [https://github.com/Olen/homeassistant-plant](https://github.com/Olen/homeassistant-plant) which utilizes this API to add threshold values for such as moisture, temperature, conductivity etc. based on the plant species. Install Open Plant Book through HACS with the button below. +The [Plant integration](https://github.com/Olen/homeassistant-plant) uses this data to add threshold values, such as moisture, temperature, and conductivity, based on your plant's species. + +Install OpenPlantBook through HACS with the button below. [](https://my.home-assistant.io/redirect/hacs_repository/?owner=Olen&repository=home-assistant-openplantbook&category=integration) -Flower Card GitHub +## Install the Flower Card -Install the card through HACS with the button below: +The Flower Card is the dashboard card that shows your plant. You can read more about it on the Flower Card GitHub page. + +Install the card through HACS with the button below. [](https://my.home-assistant.io/redirect/hacs_repository/?owner=Olen&repository=lovelace-flower-card&category=plugin) -Flower Card Code +## Add the card to your dashboard + +Edit your dashboard, add a **Manual** card, and replace its contents with the Flower Card code below. Then swap in your own entities: replace `plant.my_plant` with the plant you set up in the Plant integration, and `sensor.demo_battery` with your own battery sensor. ```yaml type: custom:flower-card @@ -35,4 +60,6 @@ show_bars: - moisture - temperature battery_sensor: sensor.demo_battery -``` \ No newline at end of file +``` + +Save the card, and your plant's readings appear as bars, like the example at the top of this page. diff --git a/docs/products/plt1/faq.md b/docs/products/plt1/faq.md index 929c578323..7af769a6c8 100755 --- a/docs/products/plt1/faq.md +++ b/docs/products/plt1/faq.md @@ -60,7 +60,7 @@ description: PLT-1 FAQ. 15\. **What makes the PLT-1 better than other plant sensors?** -* The PLT-1B features a durable capacitive soil moisture sensor, real-time data reporting, and tracks various environmental factors—all in one compact device that integrates seamlessly with Home Assistant. +* The PLT-1B features a durable capacitive soil moisture sensor, real-time data reporting, and tracks various environmental factors, all in one compact device that integrates with Home Assistant. 16\. **Is the PLT-1 compatible with other smart home platforms?** @@ -74,12 +74,12 @@ description: PLT-1 FAQ. * Yes, once connected to Home Assistant, you can access your sensor data remotely through your Home Assistant dashboard, provided your setup allows for remote access. -20\. **Can I use multiple PLT-1 sensors in one Home Assistant setup?** +19\. **Can I use multiple PLT-1 sensors in one Home Assistant setup?** * Yes, you can add multiple PLT-1B sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces. -21\. **Optional Probe Addons:** +20\. **Optional Probe Addons:** -* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. +* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. \ No newline at end of file +* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. \ No newline at end of file diff --git a/docs/products/plt1/general-tips.md b/docs/products/plt1/general-tips.md index 27a51d468b..9bc4be743e 100755 --- a/docs/products/plt1/general-tips.md +++ b/docs/products/plt1/general-tips.md @@ -1,8 +1,8 @@ --- -title: PLT-1 General Tips +title: PLT-1 general tips description: Helpful tips to get the most use out of your sensor. --- -# General Tips +# General tips ## LTR390 UV diff --git a/docs/products/plt1/introduction.md b/docs/products/plt1/introduction.md index e738230ff4..0766116193 100755 --- a/docs/products/plt1/introduction.md +++ b/docs/products/plt1/introduction.md @@ -1,5 +1,5 @@ --- -title: PLT-1 Introduction +title: PLT-1 introduction description: PLT-1 Introduction. --- @@ -8,8 +8,8 @@ The PLT-1 is equipped with a capacitive soil moisture sensor, providing enhanced **Optional Probe Addons:** -* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. +* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. +* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. !!! danger "Do not leave your sensor outside or let it get wet!" diff --git a/docs/products/plt1/reviews.md b/docs/products/plt1/reviews.md index b07eb2d6ba..3e20bcabfb 100755 --- a/docs/products/plt1/reviews.md +++ b/docs/products/plt1/reviews.md @@ -1,29 +1,29 @@ --- -title: PLT-1 Reviews +title: PLT-1 reviews 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) +# [Simon Says Home Assistant PLT-1 review](https://youtu.be/hocliw98_Gk?si=8TMFLD7xiYah1RmJ) -## [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/setup/plt1-sensor-definitions.md b/docs/products/plt1/setup/plt1-sensor-definitions.md index e6849db139..516a2d8967 100755 --- a/docs/products/plt1/setup/plt1-sensor-definitions.md +++ b/docs/products/plt1/setup/plt1-sensor-definitions.md @@ -1,8 +1,8 @@ --- -title: PLT-1 Sensor Definitions +title: PLT-1 sensor definitions description: Full list of definitions for the PLT-1 and its various sensors. --- -# Sensor Definitions +# Sensor definitions Once added to Home Assistant you can configure different settings for your PLT-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. diff --git a/docs/products/plt1/setup/prevent-sleep.md b/docs/products/plt1/setup/prevent-sleep.md index 5e32fcb21e..868f282213 100755 --- a/docs/products/plt1/setup/prevent-sleep.md +++ b/docs/products/plt1/setup/prevent-sleep.md @@ -10,6 +10,8 @@ description: Tutorial for how to enable/disable prevent sleep. 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. +You'll set how long your sensor sleeps, then turn off **Prevent Sleep** so it can start sleeping. + 1\. Head to the ESPHome Integrations page. 2\. Click on the name "1 device" below your Apollo device's name. diff --git a/docs/products/plt1/troubleshooting/plt1-boot-mode.md b/docs/products/plt1/troubleshooting/plt1-boot-mode.md index 7cfc9fc9fa..fe4d2c51ad 100755 --- a/docs/products/plt1/troubleshooting/plt1-boot-mode.md +++ b/docs/products/plt1/troubleshooting/plt1-boot-mode.md @@ -1,26 +1,30 @@ --- -title: Putting The PLT-1 In Boot Mode +title: Putting the PLT-1 in boot mode description: Step by step guide for putting The PLT-1 In Boot Mode. --- -# Putting The PLT-1 In Boot Mode +# Putting the PLT-1 in boot mode !!! info "This will cover how to put the PLT-1 into 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 + +You can put your device into boot mode with only the boot button and a USB-C cable. 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. +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 PLT-1 then let go of the button. 3\. Continue with uploading the firmware document. -## Method 2: Boot and Reset Buttons +## Method 2: Boot and reset buttons + +You can also put your device into boot mode by pressing the reset button while you hold the boot button. -1\. Unplug the device and locate the boot and reset buttons as shown in the image above. +1\. Unplug the device and locate the boot button (on the side, shown in the image above) and the reset button (near the USB-C port, shown in the image below). 2\. Plug it into your computer. diff --git a/docs/products/plt1/troubleshooting/plt1-code.md b/docs/products/plt1/troubleshooting/plt1-code.md index adb9a5ef36..ff6dea55af 100755 --- a/docs/products/plt1/troubleshooting/plt1-code.md +++ b/docs/products/plt1/troubleshooting/plt1-code.md @@ -1,8 +1,8 @@ --- -title: Factory Re-Flash PLT-1 +title: Factory re-flash PLT-1 description: Step by step guide for re-flashing the PLT-1 back to factory firmware. --- -# Factory Re-Flash PLT-1 +# Factory re-flash PLT-1 !!! 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." @@ -10,6 +10,8 @@ description: Step by step guide for re-flashing the PLT-1 back to factory firmwa If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. +Follow these steps to put your device in boot mode and install the factory firmware. + 1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable.  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 8c99f3cf1b..d23cf0eb28 100755 --- a/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md +++ b/docs/products/plt1/troubleshooting/plt1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials +title: Reset Wi-Fi credentials description: Step by step guide for resetting the Wi-Fi Credentials on your PLT-1. --- -# Reset Wi-Fi Credentials on your PLT-1 +# Reset Wi-Fi credentials on your PLT-1 + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the device into power. @@ -12,4 +14,4 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PLT- 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. -4\. Connect to the hotspot titled "Apollo PLT-1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file +4\. Connect to the hotspot titled "Apollo PLT1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file diff --git a/docs/products/plt1/troubleshooting/plt1-teardown.md b/docs/products/plt1/troubleshooting/plt1-teardown.md index 24a00a49b3..1984843aeb 100755 --- a/docs/products/plt1/troubleshooting/plt1-teardown.md +++ b/docs/products/plt1/troubleshooting/plt1-teardown.md @@ -1,5 +1,5 @@ --- -title: PLT-1 Teardown +title: PLT-1 teardown description: Step by step guide for tearing down your PLT-1 to replace parts, clean it, swap cases, etc. --- \ No newline at end of file diff --git a/docs/products/plt1b/additional-info/bluetooth-proxy.md b/docs/products/plt1b/additional-info/bluetooth-proxy.md index b6ca1ed82d..4c35385914 100644 --- a/docs/products/plt1b/additional-info/bluetooth-proxy.md +++ b/docs/products/plt1b/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: PLT-1B Bluetooth Proxy +title: PLT-1B Bluetooth proxy description: Tutorial for how to turn your PLT-1B into a BLE proxy! --- -# PLT-1B Bluetooth Proxy +# PLT-1B Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" diff --git a/docs/products/plt1b/additional-info/insert-battery.md b/docs/products/plt1b/additional-info/insert-battery.md index c31af6ef72..00bb5495b9 100644 --- a/docs/products/plt1b/additional-info/insert-battery.md +++ b/docs/products/plt1b/additional-info/insert-battery.md @@ -1,13 +1,15 @@ --- -title: How to Insert Battery on PLT-1B +title: How to insert battery on PLT-1B description: How to Insert Battery on PLT-1B. --- -# How to Insert the Battery +# How to insert the battery !!! info "18650 battery and charger required!" The PLT-1B does *NOT* include a battery nor a charging circuit. You will need to supply your own flat-top, unprotected 18650 Li-ion cell, and a separate 18650 charger. Recommended cell: Samsung 30Q 18650 3000mAh. +Follow these steps to open the case, insert the battery, and close it again. + 1\. Gently press your thumb on the case above the stake and the lid should pop off.  diff --git a/docs/products/plt1b/faq.md b/docs/products/plt1b/faq.md index 69a73cfcf2..b7b5e1f466 100755 --- a/docs/products/plt1b/faq.md +++ b/docs/products/plt1b/faq.md @@ -73,7 +73,7 @@ description: PLT-1B FAQ. 16\. **What makes the PLT-1B better than other plant sensors?** -* The PLT-1B features a durable capacitive soil moisture sensor, real-time data reporting, and tracks various environmental factors—all in one compact device that integrates seamlessly with Home Assistant. +* The PLT-1B features a durable capacitive soil moisture sensor, real-time data reporting, and tracks various environmental factors, all in one compact device that integrates with Home Assistant. 17\. **Is the PLT-1B compatible with other smart home platforms?** @@ -97,5 +97,5 @@ description: PLT-1B FAQ. 22\. **Optional Probe Addons:** -* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. \ No newline at end of file +* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. +* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. \ No newline at end of file diff --git a/docs/products/plt1b/general-tips.md b/docs/products/plt1b/general-tips.md index 7e460a7683..2363172f9a 100755 --- a/docs/products/plt1b/general-tips.md +++ b/docs/products/plt1b/general-tips.md @@ -1,8 +1,8 @@ --- -title: PLT-1B General Tips +title: PLT-1B general tips description: Helpful tips to get the most use out of your sensor. --- -# General Tips +# General tips ## LTR390 UV diff --git a/docs/products/plt1b/introduction.md b/docs/products/plt1b/introduction.md index e6e0241296..8a4e2e252c 100755 --- a/docs/products/plt1b/introduction.md +++ b/docs/products/plt1b/introduction.md @@ -1,5 +1,5 @@ --- -title: PLT-1B Introduction +title: PLT-1B introduction description: PLT-1B Introduction. --- @@ -8,9 +8,9 @@ The PLT-1B (18650 battery) is equipped with a capacitive soil moisture sensor, p **Optional Probe Addons:** -* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. +* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. +* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. !!! danger "Do not leave your sensor outside or let it get wet!" - The PLT-1 should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your PLT-1 if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file + The PLT-1B should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your PLT-1B if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file diff --git a/docs/products/plt1b/setup/plt1b-sensor-definitions.md b/docs/products/plt1b/setup/plt1b-sensor-definitions.md index c79a00d10b..eb2d3c21da 100755 --- a/docs/products/plt1b/setup/plt1b-sensor-definitions.md +++ b/docs/products/plt1b/setup/plt1b-sensor-definitions.md @@ -1,8 +1,8 @@ --- -title: PLT-1B Sensor Definitions +title: PLT-1B sensor definitions description: Full list of definitions for the PLT-1B and its various sensors. --- -# Sensor Definitions +# Sensor definitions Once added to Home Assistant you can configure different settings for your PLT-1B. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. @@ -12,7 +12,7 @@ Once added to Home Assistant you can configure different settings for your PLT-1 The PLT-1B runs on an 18650 battery. By default **Prevent Sleep** is on, so it stays awake and reports continuously at these intervals, which drains the battery. Turn **Prevent Sleep** off to let it deep-sleep between readings for the **Sleep Duration** (12h) and conserve the cell: it wakes for about 90 seconds, reports its readings, then sleeps again. The **Default Update** column is how often each sensor refreshes while it is awake. - To update firmware on a sleeping device, just click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand. + To update firmware on a sleeping device, click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand. === "Controls" diff --git a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md index 90fd3d95a6..755eb88f45 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md +++ b/docs/products/plt1b/troubleshooting/plt1b-boot-mode.md @@ -1,8 +1,8 @@ --- -title: Putting The PLT-1B In Boot Mode +title: Putting the PLT-1B in boot mode description: Step by step guide for putting The PLT-1B In Boot Mode. --- -# Putting The PLT-1B In Boot Mode +# Putting the PLT-1B in boot mode !!! info "This will cover how to put the PLT-1B into boot mode." @@ -10,7 +10,9 @@ description: Step by step guide for putting The PLT-1B In Boot Mode.  -## Method 1: Boot Button Only +## Method 1: Boot button only + +You can put your device into boot mode with only the boot button and a pin. 1\. Position the PLT-1B as shown in the image below and locate the small opening to press the boot button. @@ -22,7 +24,9 @@ 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 + +You can also put your device into boot mode by pressing the reset button while you hold the boot button. 1\. Plug in the device diff --git a/docs/products/plt1b/troubleshooting/plt1b-code.md b/docs/products/plt1b/troubleshooting/plt1b-code.md index d2a751e2b1..c02fb672ac 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-code.md +++ b/docs/products/plt1b/troubleshooting/plt1b-code.md @@ -1,77 +1,50 @@ --- -title: Factory Re-Flash PLT-1B -description: Step by step guide for re-flashing the PLT-1B back to factory firmware. +title: Factory re-flash PLT-1B +description: Re-flash your PLT-1B with its factory firmware from a Chromium-based browser when the device stops responding. --- -# 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." +If your Apollo PLT-1B becomes unresponsive and you've exhausted the other troubleshooting methods, you can re-flash the factory firmware. You'll put the PLT-1B in boot mode, flash it from the Apollo installer in your browser, and then set it up as a new device. - This needs to be done in Chrome, Edge, or another Chromium based browser. +!!! note "Before you start" -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. + * Do the re-flash in Chrome, Edge, or another Chromium-based browser. + * If your device has already been connected to Home Assistant, remove it from the ESPHome integration and the ESPHome Device Builder before continuing. -1. Plug your sensor into your computer with a quality USB-C cable that supports data transfer -2. Navigate to our installer page and click connect [\*\* Install Page \*\*](https://apolloautomation.github.io/PLT-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. +!!! warning "Remove the battery" -[](/assets/comselection.png) + The re-flash won't work properly if the battery is still supplying power to the PLT-1B. Remove the battery before you start, or as soon as you run into issues. -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/plt1b/troubleshooting/plt1b-boot-mode/) for putting the sensor in boot mode and then retry step 3. +1\. Put your PLT-1B in boot mode: hold down the boot button, then plug in the USB cable. -4\. Choose to install the new firmware + -[](/assets/image-1698806750134.png) +2\. Open the Apollo PLT-1B Installer. -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. - -[](/assets/image-1698806082666.png) - -!!! warning "Power cycle your device before doing anything else!" - - Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! - -6\. Please proceed to the getting started guide and set up your sensor as a new device! - -## 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." - - This needs to be done in Chrome, Edge, or another Chromium based browser. - -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. - -1\. 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 - -!!! failure "Remove the battery!" - - This will not work properly if the battery is still supplying power to the TEMP-1B. Please remove the battery if you are having issues! - -3\. Click the big "Connect" button. +3\. Under **Battery Firmware**, click the big **Connect** button.  -4\. Select the open com port then click Connect. +4\. In the browser pop-up, select the open COM port (the PLT-1B's serial port, shown as USB JTAG/serial debug unit in the example below), then click **Connect**.  -5\. Click "Install ApolloAutomation.PLT-1B". +5\. Click **Install ApolloAutomation.PLT-1B**.  -6\. Click "INSTALL". +6\. Click **INSTALL**.  -7\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +7\. When you see **Installation complete!**, you're finished. Click **Next**, then close the browser window.  -!!! warning "Power cycle your device before doing anything else!" +Your PLT-1B now has the factory firmware again. + +!!! warning "Power cycle your device before doing anything else" - Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! + Your PLT-1B is still in boot mode. Remove its power, then power it back on so it starts in normal mode. -8\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file +8\. Follow the getting started guide to set up your sensor as a new device. diff --git a/docs/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md b/docs/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md index 854c0360e7..24a9783781 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md +++ b/docs/products/plt1b/troubleshooting/plt1b-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials +title: Reset Wi-Fi credentials description: Step by step guide for resetting the Wi-Fi Credentials on your PLT-1B. --- -# Reset Wi-Fi Credentials on your PLT-1B +# Reset Wi-Fi credentials on your PLT-1B + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the device into power. @@ -14,4 +16,4 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your PLT- 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. -4\. Connect to the hotspot titled "Apollo PLT-1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file +4\. Connect to the hotspot titled "Apollo PLT1B Hotspot" and enter your new Wi-Fi details! \ No newline at end of file diff --git a/docs/products/plt1b/troubleshooting/plt1b-teardown.md b/docs/products/plt1b/troubleshooting/plt1b-teardown.md index a54af8a6e7..2418e06a8b 100755 --- a/docs/products/plt1b/troubleshooting/plt1b-teardown.md +++ b/docs/products/plt1b/troubleshooting/plt1b-teardown.md @@ -1,5 +1,5 @@ --- -title: PLT-1 Teardown +title: PLT-1B teardown description: Step by step guide for tearing down your PLT-1B to replace parts, clean it, swap cases, etc. --- \ No newline at end of file diff --git a/docs/products/pump1/additional-info/bluetooth-proxy.md b/docs/products/pump1/additional-info/bluetooth-proxy.md index c5a46fae11..fe4a0d1b3d 100644 --- a/docs/products/pump1/additional-info/bluetooth-proxy.md +++ b/docs/products/pump1/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: PUMP-1 Bluetooth Proxy +title: PUMP-1 Bluetooth proxy description: Tutorial for how to turn your PUMP-1 into a BLE proxy! --- -# PUMP-1 Bluetooth Proxy +# PUMP-1 Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" diff --git a/docs/products/pump1/addons/attaching-bottle-to-pump-1.md b/docs/products/pump1/addons/attaching-bottle-to-pump-1.md index 1ce8b01d2d..0c72302e8d 100755 --- a/docs/products/pump1/addons/attaching-bottle-to-pump-1.md +++ b/docs/products/pump1/addons/attaching-bottle-to-pump-1.md @@ -4,6 +4,8 @@ description: Tutorial for Attaching the bottle to the PUMP-1 --- # Attaching the bottle to the PUMP-1 +You'll fit the input fluid level sensor into the base, then slide the water bottle into it. + 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. !!! tip "Make sure to orient your fluid level sensor correctly as shown in the gif below" 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 1e383e9806..87aa577563 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 @@ -1,10 +1,10 @@ --- -title: Attaching Fluid Level Sensors to the PUMP-1 +title: Attaching fluid level sensors to the PUMP-1 description: Tutorial for Attaching The Input and Output Fluid Level Sensors to the PUMP-1 --- -# Attaching Fluid Level Sensors to the PUMP-1 +# 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. @@ -30,6 +30,6 @@ description: Tutorial for Attaching The Input and Output Fluid Level Sensors to They are intended for external placement only. -2\. Attach the fluid output sensor to the **outside** of the water reservoir of your choice. Common examples include Keurig water tanks, fish tanks, or similar containers. This sensor detects whether the water level is **above or below** a specific threshold, providing a reliable indication of fluid presence at that height. You can secure the sensor using **double-sided tape**, a **Command™ strip**, or even a **small dab of hot glue** - whichever method works best for your setup. Just ensure the sensor remains firmly in place and maintains good contact with the surface. +2\. Attach the fluid output sensor to the **outside** of the water reservoir of your choice. Common examples include Keurig water tanks, fish tanks, or similar containers. This sensor detects whether the water level is **above or below** a specific threshold, providing a reliable indication of fluid presence at that height. You can secure the sensor using **double-sided tape**, a **Command™ strip**, or even a **small dab of hot glue**, whichever method works best for your setup. Ensure the sensor remains firmly in place and maintains good contact with the surface.  \ No newline at end of file diff --git a/docs/products/pump1/addons/attaching-tubes-to-pump-1.md b/docs/products/pump1/addons/attaching-tubes-to-pump-1.md index 64de2646de..f43b6fd5e3 100755 --- a/docs/products/pump1/addons/attaching-tubes-to-pump-1.md +++ b/docs/products/pump1/addons/attaching-tubes-to-pump-1.md @@ -1,8 +1,8 @@ --- -title: Attaching Inlet and Outlet tubes to the PUMP-1 +title: Attaching inlet and outlet tubes to the PUMP-1 description: Tutorial for attaching both the Inlet and the Outlet tubes for the PUMP-1 --- -# Attaching Inlet and Outlet tubes to the PUMP-1 +# Attaching inlet and outlet tubes to the PUMP-1 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/pump1/faq.md b/docs/products/pump1/faq.md index 4f504ab6d7..7218a428a5 100755 --- a/docs/products/pump1/faq.md +++ b/docs/products/pump1/faq.md @@ -48,7 +48,7 @@ description: Frequently asked questions about the PUMP-1 Fluid Pump Sensor 12\. **How large is the PUMP-1?** -* The pump measures 3.4in x 1.3in x 1.8in (86.4mm x 33mm x 45.7mm), making it compact and easy to install. +* The pump measures 3.4in x 1.3in x 1.8in (86.4mm x 33mm x 45.7mm), making it compact. 13\. **How do I control the pump?** diff --git a/docs/products/pump1/introduction.md b/docs/products/pump1/introduction.md index 536bb9517b..ad5c2728aa 100755 --- a/docs/products/pump1/introduction.md +++ b/docs/products/pump1/introduction.md @@ -4,10 +4,10 @@ description: Documentation for PUMP-1, including setup, usage, and best practice --- -The Apollo PUMP-1 is a versatile, compact, and food-safe fluid pump designed to integrate seamlessly with our PLT-1 plant sensor to automate your watering needs. It features two ports for non-contact fluid sensors that detect water through the wall of your bottle or reservoir, allowing the pump to automatically stop when watering is complete or if your water bottle runs empty, protecting your system from damage. +The Apollo PUMP-1 is a versatile, compact, and food-safe fluid pump designed to integrate with our PLT-1 plant sensor to automate your watering needs. It features two ports for non-contact fluid sensors that detect water through the wall of your bottle or reservoir, allowing the pump to automatically stop when watering is complete or if your water bottle runs empty, protecting your system from damage. Perfect for smart home gardeners, the PUMP-1 takes the hassle out of plant care by delivering precise, controlled watering automatically. -Beyond plants, the PUMP-1 is ideal for a variety of other uses such as filling fish tanks, robot vacuum mop tanks, pet bowls, coffee pots, and more. Its reliable performance, food-safe materials, and easy integration make it a perfect addition to any home automation setup. +Beyond plants, the PUMP-1 is ideal for a variety of other uses such as filling fish tanks, robot vacuum mop tanks, pet bowls, coffee pots, and more. Its reliable performance, food-safe materials, and smart home integration make it a perfect addition to any home automation setup. Experience effortless and safe fluid control with the Apollo PUMP-1. Smart, simple, and adaptable. \ No newline at end of file diff --git a/docs/products/pump1/setup/pump1-general-tips.md b/docs/products/pump1/setup/pump1-general-tips.md index 2b2f457593..38b538151a 100755 --- a/docs/products/pump1/setup/pump1-general-tips.md +++ b/docs/products/pump1/setup/pump1-general-tips.md @@ -1,25 +1,23 @@ --- -title: PUMP-1 General Tips -description: >- - Multiple helpful images for mounting, lux/rgb, and gate and zone - visualization. +title: PUMP-1 general tips +description: Tips for placing the PUMP-1 fluid sensor, controlling the pump, and preventing siphoning. --- -# General Tips +# 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. +There is a disabled entity by default called **Pump Control** which will 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. Depending on your application, this may not be a concern. If it is, there are many helpful resources online that explain ways to reduce or prevent this effect. -To clarify, this is not the pump actively siphoning from the source reservoir. It is simply water remaining in the outlet tubing flowing downward due to gravity when the discharge end is lower than the source. \ No newline at end of file +To clarify, this is not the pump actively siphoning from the source reservoir. It is water remaining in the outlet tubing flowing downward due to gravity when the discharge end is lower than the source. \ No newline at end of file diff --git a/docs/products/pump1/setup/pump1-sensor-definitions.md b/docs/products/pump1/setup/pump1-sensor-definitions.md index ecd749f9af..5a865f2f0a 100755 --- a/docs/products/pump1/setup/pump1-sensor-definitions.md +++ b/docs/products/pump1/setup/pump1-sensor-definitions.md @@ -1,8 +1,8 @@ --- -title: PUMP-1 Sensor Definitions +title: PUMP-1 sensor definitions description: These are all of the entities exposed by the PUMP-1 to automate on! --- -# Sensor Definitions +# Sensor definitions Once added to Home Assistant you can configure different settings for your PUMP-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. diff --git a/docs/products/pump1/troubleshooting/pump1-boot-mode.md b/docs/products/pump1/troubleshooting/pump1-boot-mode.md index f46c35b72f..8a6315552a 100755 --- a/docs/products/pump1/troubleshooting/pump1-boot-mode.md +++ b/docs/products/pump1/troubleshooting/pump1-boot-mode.md @@ -1,20 +1,22 @@ --- -title: Putting The PUMP-1 In Boot Mode +title: Putting the PUMP-1 in boot mode description: Step by step guide for putting The PUMP-1 In Boot Mode. --- -# Putting The PUMP-1 In Boot Mode +# Putting the PUMP-1 in boot mode !!! info "This will cover how to put the PUMP-1 into 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 + +You'll hold the boot button while you plug in the USB-C cable. !!! danger "Empty the water reservoir and make sure no water is present in the tubes" - Make sure that there is no water which is able to damage the device. This is a precautionary measure just to be safe! + Make sure that there is no water which is able to damage the device. This is a precautionary measure to be safe! -1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button—it’s the button on the right. +1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button. It’s the button on the right. 2\. Plug in a USB cable that supports power and data into your computer. @@ -26,7 +28,9 @@ 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 + +You'll use the boot and reset buttons together while the device is plugged into your computer. 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-reflash.md b/docs/products/pump1/troubleshooting/pump1-reflash.md index 351a27f644..7008258e70 100755 --- a/docs/products/pump1/troubleshooting/pump1-reflash.md +++ b/docs/products/pump1/troubleshooting/pump1-reflash.md @@ -1,18 +1,18 @@ --- -title: Reflashing The PUMP-1. +title: Reflashing the PUMP-1. description: Step by step guide for reflashing The PUMP-1. --- -# Reflashing The PUMP-1 +# Reflashing the PUMP-1 !!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser. -1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button—it’s the button on the right. +1\. Disconnect your PUMP-1 from power. With the device facing you, locate the boot button. It’s the button on the right. !!! danger "Empty the water reservoir and make sure no water is present in the tubes" - Make sure that there is no water which is able to damage the device. This is a precautionary measure just to be safe! + Make sure that there is no water which is able to damage the device. This is a precautionary measure to be safe! 2\. Plug in a USB cable that supports power and data into your computer. @@ -28,7 +28,7 @@ description: Step by step guide for reflashing The PUMP-1.  -7\.. Click Install PUMP-1. +6\. Click Install PUMP-1.  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 ec352e0fbf..d4a514c716 100755 --- a/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md +++ b/docs/products/pump1/troubleshooting/pump1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials +title: Reset Wi-Fi credentials description: Step by step guide for resetting the Wi-Fi Credentials on your PUMP-1. --- -# Reset Wi-Fi Credentials on your PUMP-1 +# Reset Wi-Fi credentials on your PUMP-1 + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the PUMP-1 into power. diff --git a/docs/products/pump1/troubleshooting/pump1-teardown.md b/docs/products/pump1/troubleshooting/pump1-teardown.md index d4f0bfc131..d34c8e683a 100755 --- a/docs/products/pump1/troubleshooting/pump1-teardown.md +++ b/docs/products/pump1/troubleshooting/pump1-teardown.md @@ -1,13 +1,15 @@ --- -title: PUMP-1 Teardown +title: PUMP-1 teardown description: >- Step by step guide for tearing down your PUMP-1 to replace parts, clean it, swap cases, etc. --- -# Teardown and Reassembly Of PUMP-1 +# Teardown and reassembly of PUMP-1 ## Disassembly +You'll unplug the pump, remove its lid, and detach the sensor connectors and tubes. + !!! danger "Drain all liquid from the PUMP-1 before disassembling!" Ensure the PUMP-1 is fully drained of liquid before removing any tubes. Failure to do so may result in damage to the unit. @@ -20,7 +22,7 @@ description: >-  -3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling - this makes removal much easier. +3\. Detach both the inlet and outlet tubes by pinching near the connection point and twisting gently while pulling. This makes removal much easier.  diff --git a/docs/products/rpro1/additional-info/bluetooth-proxy.md b/docs/products/rpro1/additional-info/bluetooth-proxy.md index 9055986fbb..e9fa734ab0 100644 --- a/docs/products/rpro1/additional-info/bluetooth-proxy.md +++ b/docs/products/rpro1/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: R PRO-1 Bluetooth Proxy +title: R PRO-1 Bluetooth proxy description: Tutorial for how to turn your R PRO-1 into a BLE proxy! --- -# R PRO-1 Bluetooth Proxy +# R PRO-1 Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" 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 a187dfd83a..a07eb59af0 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 @@ -16,12 +16,12 @@ description: Tutorial on adding the LD2412 mmWave sensor to your R PRO-1 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.  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 0b8bca63e1..3c6912ba3e 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 @@ -2,7 +2,9 @@ title: Add the SCD40 CO2 sensor to your R PRO-1 description: Tutorial on adding the SCD40 CO2 sensor to your R PRO-1. --- -# Adding CO2 To R PRO-1 +# Adding CO2 to R PRO-1 + +You'll open your sensor, fit the SCD40 CO2 module onto its board, and close the case back up. 1\. Unplug your R PRO-1 from power and remove the back. 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 86f84335ca..e8feb51f59 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 @@ -1,47 +1,65 @@ --- title: Add the gang box mounts to your R PRO-1 -description: Tutorial on adding the gang box mounts to your R PRO-1. +description: Fit the two gang box mounts onto your R PRO-1's board, then install it in a 1-gang box on your wall behind a blank faceplate. --- -# Adding Gang Box Mounts To R PRO-1 +# Add the gang box mounts to your R PRO-1 -## Attaching Mounts +The gang box mounts let your Apollo R PRO-1 sit inside a 1-gang box on your wall, behind a blank faceplate. First you fit the two mounts onto the R PRO-1's board, then you install it in the box. + +!!! note "Before you start" + + You need: + + * The two gang box mount pieces: one labeled "TOP" and one bottom mount. + * A 1-gang box that's already attached to your wall. + * A blank faceplate and its screws. + +## Attach the mounts + +Fit both mounts onto the board so the R PRO-1 is ready to go into the gang box. 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. +2\. Gently lift the board (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. +3\. Take the two gang box mount pieces and find the one labeled "TOP". The other piece is the bottom mount. -!!! danger "Before continuing and sliding the mounts on, please verify you have the pieces oriented as shown in the images below." +!!! danger "Check the orientation before you slide the mounts on" - If the mounts are not put on properly the R PRO-1 could be damaged! + Make sure each mount is oriented exactly as shown in the images below. If the mounts aren't put on properly, the R PRO-1 could be damaged. -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 mount labeled "TOP" onto the top edge of the board, as shown below. Make sure its orientation is identical to the image.  -4\. Gently push the top mount into the pcb as shown below. Make sure the orientation is identical to the image below! +5\. Gently push the bottom mount onto the bottom edge of the board, below the LD2412, as shown below. Make sure its orientation is identical to the image.  -5\. The end result should look identical to the image below. You are now ready to install it inside of a 1 gang box. +6\. Compare your board with the image below. It should look identical.  -## Install in 1-Gang Box +Both mounts are on, and your R PRO-1 is ready to install inside a 1-gang box. + +## Install in a 1-gang box -1\. Line up the holes in your 1-gang box (yours will be attached to the wall already). +Now set the R PRO-1 into the box on your wall and cover it with the blank faceplate. + +1\. Set the R PRO-1 into your 1-gang box (yours will be attached to the wall already) and line up the holes in its mounts with the holes in the box.  -2\. Place screws through the blank faceplate and gently place over the R PRO-1 mounting holes. +2\. Put the screws through the blank faceplate and gently place it over the R PRO-1's 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! +3\. Screw in the screws slowly so you don't break the mounts or the blank faceplate. + + - \ No newline at end of file +Your R PRO-1 is now installed in the 1-gang box and should look like the image above. 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 ff52b3bcc8..4fdd19c561 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 @@ -2,13 +2,15 @@ title: Add the ceiling mounts to your R PRO-1 description: Tutorial on installing the ceiling mount addon for the R PRO-1. --- -# Install Ceiling Mount for R PRO-1 +# Install ceiling mount for R PRO-1 Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. We have images showing how to assemble the mount below. -## Attaching Mounts +## Attaching mounts + +You'll take the PCB out of its case and push both ceiling mount pieces onto it. 1\. Unplug your R PRO-1 from power and remove the back. @@ -26,23 +28,25 @@ Watch our step by step video on installing the R PRO-1 using the Ceiling Mount. If the mounts are not put on properly the R PRO-1 could be damaged! -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 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\. 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. +6\. 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 +## 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 + +Now you'll plug in your sensor and slide it into the installed Ceiling Mount. 1\. Remove the cover to expose the inside of the installed Ceiling Mount. diff --git a/docs/products/rpro1/calibrating-co2.md b/docs/products/rpro1/calibrating-co2.md index 8e17a07862..8adfc28bf2 100755 --- a/docs/products/rpro1/calibrating-co2.md +++ b/docs/products/rpro1/calibrating-co2.md @@ -1,8 +1,8 @@ --- -title: CO2 Calibration Tutorial (quick) +title: CO2 calibration tutorial (quick) description: Step by step guide for re-calibrating your SCD40 CO2 sensor --- -# CO2 Calibration - The Quick method - Desktop Only not mobile +# CO2 calibration - the quick method - desktop only not mobile !!! info "Your R PRO-1 calibrates itself" @@ -10,7 +10,7 @@ description: Step by step guide for re-calibrating your SCD40 CO2 sensor !!! tip "Calibrate manually every 1 to 2 years when auto calibration is off" - 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. + 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. This article will guide you through a simple calibration of your CO2 sensor for any Apollo Automation device! @@ -18,14 +18,20 @@ This article will guide you through a simple calibration of your CO2  -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. +*Shown with an AIR-1; set your R PRO-1 outdoors the same way.* + +2\. Go to your Home Assistant dashboard and press the letter "e". In the entity filter that pops up, type "Calibrate SCD40" and select your R PRO-1's entry (for example **Apollo R_PRO-1 353fd4 Calibrate SCD40 To 420ppm**). !!! tip "Hint" If you cannot get this menu to pop up, click somewhere on the Home Assistant dashboard then press your "e" key. - + + +*Shown for an AIR-1; your R PRO-1 lists the same Calibrate SCD40 To 420ppm button.* 3\. Click on the button that says "PRESS" and then you are done. - \ No newline at end of file + + +*Shown for an AIR-1; the R PRO-1 button dialog looks the same.* \ No newline at end of file diff --git a/docs/products/rpro1/faq.md b/docs/products/rpro1/faq.md index 899c6f9580..823848da06 100755 --- a/docs/products/rpro1/faq.md +++ b/docs/products/rpro1/faq.md @@ -12,7 +12,7 @@ description: Frequently asked questions about the R PRO-1 PoE mmWave sensor. 3\. **What is the maximum detection range of the mmWave radar?** -* The HLK-LD2450 mmWave radar sensor has a maximum detection range of about 6 meters (19.6 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring. +* The HLK-LD2450 mmWave radar sensor has a maximum detection range of about 6 meters (19.7 feet) with multi-target tracking capabilities, making it ideal for room-wide monitoring. * The optional HLK-LD2412 mmWave radar sensor has a maximum detection range of about 9 meters (29.5 feet) with single tracking capabilities and ability to tune moving and still energy which is perfect for still targets like sleeping in a bed, laying on a couch, etc. 4\. **Can the R PRO-1 detect multiple people?** @@ -61,7 +61,7 @@ description: Frequently asked questions about the R PRO-1 PoE mmWave sensor. 14\. **What kind of power supply is required for the R PRO-1?** -* The R PRO-1 is powered via Ethernet (802.3 compliant) or USB-C and can be plugged into a standard wall outlet using a 5V 2A or bigger power supply. +* The R PRO-1 is powered via PoE (802.3af compliant) or USB-C and can be plugged into a standard wall outlet using a 5V 2A or bigger power supply. 15\. **Can I customize the R PRO-1 functionality?** @@ -89,7 +89,7 @@ description: Frequently asked questions about the R PRO-1 PoE mmWave sensor. 21\. **What makes the R PRO-1 stand out from other motion sensors?** -* The R PRO-1 is the only dual mmWave sensor with PoE and ability to integrate with multiple smart home platforms seamlessly. It combines the MSR-2's ability to detect still detection perfectly and the MTR-1's ability to detect up to three targets in three zones! +* The R PRO-1 is the only dual mmWave sensor with PoE and ability to integrate with multiple smart home platforms. It combines the MSR-2's ability to detect still detection perfectly and the MTR-1's ability to detect up to three targets in three zones! 22\. **What is the warranty for the R PRO-1?** diff --git a/docs/products/rpro1/introduction.md b/docs/products/rpro1/introduction.md index b6b72255ef..b98eb6d846 100755 --- a/docs/products/rpro1/introduction.md +++ b/docs/products/rpro1/introduction.md @@ -10,4 +10,4 @@ description: Documentation for R PRO-1, including setup, usage, and best practic The Apollo Automation R PRO-1 PoE mmWave Multisensor (LD2450 and additional LD2412 add-on option) is our most advanced presence sensor. Designed for power, precision, and reliability, the R PRO-1 is a compact PoE mmWave sensor built for high-accuracy motion detection and environmental monitoring in smart homes and commercial buildings. -This versatile sensor supports PoE (802.3af compliant) and USB-C power, and includes built-in Wi-Fi and Bluetooth connectivity, enabling flexible installation and seamless smart home integration. Its small form factor combined with PoE or USB-C power options makes the R PRO-1 ideal for quick deployments in a wall or ceiling. \ No newline at end of file +This versatile sensor supports PoE (802.3af compliant) and USB-C power, and includes built-in Wi-Fi and Bluetooth connectivity, enabling flexible installation and smart home integration. Its small form factor combined with PoE or USB-C power options makes the R PRO-1 ideal for quick deployments in a wall or ceiling. \ No newline at end of file diff --git a/docs/products/rpro1/rpro1-reviews.md b/docs/products/rpro1/rpro1-reviews.md index 9d6dbba611..d2d88530f5 100755 --- a/docs/products/rpro1/rpro1-reviews.md +++ b/docs/products/rpro1/rpro1-reviews.md @@ -1,13 +1,13 @@ --- -title: R PRO-1 Reviews +title: R PRO-1 reviews description: YouTuber reviews and feedback about the R PRO-1 sensor from Apollo Automation. --- -# Simon Says Home Assistant R PRO-1 Review +# 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 05f240fbfa..d4f6a4a0ad 100755 --- a/docs/products/rpro1/setup/rpro1-general-tips.md +++ b/docs/products/rpro1/setup/rpro1-general-tips.md @@ -1,10 +1,10 @@ --- -title: R PRO-1 General Tips +title: R PRO-1 general tips description: Multiple helpful images for mounting, lux/rgb, and gate and zone visualization. --- -# General Tips +# 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. @@ -30,8 +30,8 @@ The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the **The multi-target LD2450:** - * The horizontal FOV angle is -60 to 60 degrees - 120 degrees total. - * The vertical FOV angle is -35 to 35 degrees - 70 degrees total. + * The horizontal FOV angle is -60 to 60 degrees (120 degrees total). + * The vertical FOV angle is -35 to 35 degrees (70 degrees total). * Zones are X and Y coordinate zones and are user-configurable. **Helpful hints for LD2450 Zones:** @@ -44,10 +44,10 @@ The R PRO-1 should be mounted 2.6-3 meters (8-10 feet) high when mounted on the **The single-target LD2412:** - * The horizontal FOV angle is -75 to 75 degrees - 150 degrees total. - * The vertical FOV angle is -35 to 35 degrees - 70 degrees total. + * The horizontal FOV angle is -75 to 75 degrees (150 degrees total). + * 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-sensor-definitions.md b/docs/products/rpro1/setup/rpro1-sensor-definitions.md index b322aa5727..4164f609c1 100755 --- a/docs/products/rpro1/setup/rpro1-sensor-definitions.md +++ b/docs/products/rpro1/setup/rpro1-sensor-definitions.md @@ -1,8 +1,8 @@ --- -title: R PRO-1 Sensor Definitions +title: R PRO-1 sensor definitions description: These are all of the entities exposed by the R PRO-1 to automate on! --- -# Sensor Definitions +# Sensor definitions Once added to Home Assistant you can configure different settings for your R PRO-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. @@ -111,8 +111,8 @@ The R PRO-1 pairs two radars: an **LD2450** that tracks the position of up to th | **LD2450 Multi Target Tracking** | from module | Turns multi-target tracking on or off. Initial state is read from the LD2450 at boot. Disabled by default. | | **LD2450 Timeout** | — | Seconds the LD2450 presence stays detected after the target is lost. | | **LD2450 Zone Type** | Disabled | Zone detection mode: `Disabled`, `Detection` (only detect targets inside the zone), or `Filter` (exclude the zone from detection). | - | **LD2450 Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-3000 left to 3000 right). | - | **LD2450 Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 6000). | + | **LD2450 Zone-1 / Zone-2 / Zone-3 X1, X2** | — | Start and end X coordinates of the zone in mm (-4860 left to 4860 right). | + | **LD2450 Zone-1 / Zone-2 / Zone-3 Y1, Y2** | — | Start and end Y coordinates of the zone in mm (0 to 7560). | | **LD2450 Factory Reset** | — | Resets the LD2450 radar module to its factory settings. | | **LD2450 Baud rate** | from module | Serial baud rate the LD2450 uses to talk to the R PRO-1 (default 256000). Disabled by default; no need to change. | diff --git a/docs/products/rpro1/setup/rpro1-switch-firmware.md b/docs/products/rpro1/setup/rpro1-switch-firmware.md index fe4eda823d..7b9078f3e6 100755 --- a/docs/products/rpro1/setup/rpro1-switch-firmware.md +++ b/docs/products/rpro1/setup/rpro1-switch-firmware.md @@ -1,10 +1,10 @@ --- -title: R PRO-1 Switch Firmware +title: R PRO-1 switch firmware description: >- Step by step guide to switching between Wi-Fi and Ethernet firmware on R PRO-1. --- -# Firmware Switching Guide +# Firmware switching guide !!! tip "R PRO-1 ships with Wi-Fi firmware because some people might not have ethernet or PoE." @@ -12,24 +12,28 @@ description: >- ## Switch to Ethernet +Follow these steps to switch your R PRO-1 from the Wi-Fi firmware to the Ethernet firmware. + 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. +4\. Wait a few minutes. This will download the new firmware file from our GitHub repo and then install the image. 5\. Your device is now on the Ethernet firmware and is ready to configure! ## Switch to Wi-Fi +Follow these steps to switch your R PRO-1 from the Ethernet firmware back to the Wi-Fi firmware. + 1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on "1 device" below your Apollo R PRO-1.  @@ -42,6 +46,6 @@ description: >-  -4\. Wait a few minutes - this will download the new firmware file from our GitHub repo and then install the image. +4\. Wait a few minutes. This will download the new firmware file from our GitHub repo and then install the image. [Head to the getting started docs to get your sensor integrated with Home Assistant!](https://wiki.apolloautomation.com/products/general/setup/getting-started-rpro1/#connecting-through-hotspot){ .md-button .md-button--primary } \ No newline at end of file diff --git a/docs/products/rpro1/setup/zones-ha-new.md b/docs/products/rpro1/setup/zones-ha-new.md index ecb7d33ad0..1cd0249dcc 100755 --- a/docs/products/rpro1/setup/zones-ha-new.md +++ b/docs/products/rpro1/setup/zones-ha-new.md @@ -1,45 +1,45 @@ --- -title: MSR-2 Home Assistant Zone Configuration -description: Tutorial for R PRO-1 Home Assistant Zone Configuration. +title: R PRO-1 Home Assistant zone configuration +description: Enter X and Y coordinates for the R PRO-1's LD2450 zones directly in Home Assistant, then tune the optional LD2412. --- -# How To Tune The R PRO-1 Using Home Assistant +# How to tune the R PRO-1 using Home Assistant -!!! info "Your R PRO-1 has two unique mmWave sensors that both need to be tuned!" +!!! info "Your R PRO-1 has two mmWave sensors that both need to be tuned" - The R PRO-1 comes with an LD2450 mmWave sensor and an optional secondary LD2412 mmWave sensor. + The Apollo R PRO-1 comes with an LD2450 mmWave sensor and an optional secondary LD2412 mmWave sensor. - The LD2450 allows for up to three targets tracked in up to three zones but can have issues with "still detection". + The LD2450 tracks up to three targets in up to three zones, but can have issues with "still detection". - 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. + The optional LD2412 mmWave sensor gives you 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. +You can enter the X and Y coordinates for each LD2450 zone manually in Home Assistant, or directly on the device's web page by visiting its IP address or hostname.local. The steps below set up your zones in Home Assistant. -1\. Navigate to the ESPHome integration by going to settings -> ESPHome integration -> click on the name of your new device! +!!! tip "Prefer a phone app?" -2\. Scroll down until you see "LD2450 Zone Type" and choose "Detection" from the drop-down menu. + It's much easier to tune using the [HLK Radartool App](zones-hlk.md), and we suggest using that to set up your LD2450 instead. + +1\. Go to **Settings → Devices & services**, open the ESPHome integration, and click the name of your new device. + +2\. Scroll down until you see **LD2450 Zone Type** and choose **Detection** from the drop-down menu.  -3\. Begin entering in the X and Y coordinates for each zone. +3\. Enter the X and Y coordinates for each zone.  -!!! null "Helpful Hints to understand LD2450 zones better!" +!!! tip "Helpful hints for understanding LD2450 zones" * X1 must always be less than X2, and Y1 must always be less than Y2. - * The Y axis is easier since it's never negative. + * The Y axis is simpler, since it's never negative. * The X axis is where you can get tripped up, especially when both values are negative: -3456 is less than -2345. - * The Plotly chart will still render the rectangles even if the X1/X2 and Y1/Y2 values are reversed. - * The zones cannot overlap. - - - - + * If you use the Plotly chart from the [main R PRO-1 zone page](zones-ha.md), it still draws the rectangles even if the X1/X2 and Y1/Y2 values are reversed, so check the order yourself. + * Zones can't overlap. - +Your LD2450 now detects targets in the zones you entered. -## LD2412 Configuration +## LD2412 configuration - \ No newline at end of file +To tune the optional LD2412, follow the [LD2412 Configuration](zones-ha.md#ld2412-configuration) steps on the main R PRO-1 Home Assistant zone page. diff --git a/docs/products/rpro1/setup/zones-ha.md b/docs/products/rpro1/setup/zones-ha.md index 65a18f335e..b05d08cd7f 100755 --- a/docs/products/rpro1/setup/zones-ha.md +++ b/docs/products/rpro1/setup/zones-ha.md @@ -1,8 +1,8 @@ --- -title: R PRO-1 Home Assistant Zone Configuration +title: R PRO-1 Home Assistant zone configuration description: Tutorial for R PRO-1 Home Assistant Zone Configuration. --- -# How To Tune The R PRO-1 Using Home Assistant +# How to tune the R PRO-1 using Home Assistant !!! info "Your R PRO-1 has two unique mmWave sensors that both need to be tuned!" @@ -18,7 +18,9 @@ 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 + +Follow these steps to add a Plotly card that shows your LD2450 targets, then set up your zones in Home Assistant. 1\. Install [HACS](https://hacs.xyz/docs/use/). @@ -36,7 +38,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir  -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! +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 like the card below!  @@ -58,7 +60,7 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir * Detection: Only detects targets in the specified zone. * Filter: Excludes a zone from detection. -9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -7000 mm to 7000 mm, and the Y values are 0 mm to 7000 mm. +9\. Now we can input our Zone 1-3 X and Y values to make our zones. Using the visual card from above, we can walk, sit, or stand in the area where we want to create a detection or non-detection zone. Input values for X are -4860 mm to 4860 mm, and the Y values are 0 mm to 7560 mm.  @@ -96,11 +98,13 @@ Manually enter in the X and Y coordinates for each zone in Home Assistant or dir 15\. Now we can make zones around the targets where you want to Detect presence or filter them out. -!!! tip tip "Tip for zone configuration resetting" +!!! tip "Tip for zone configuration resetting" + + 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 toggling on **LD2450 Multi Target Tracking**. This should wake up the mmWave module and retrieve your saved zones - 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 +Follow these steps to switch the LD2412 to Engineering mode and tune its gates in Home Assistant. 1\. Go to **Settings → Devices & services → ESPHome** and click **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 44b48c7625..731060ba78 100755 --- a/docs/products/rpro1/setup/zones-hlk.md +++ b/docs/products/rpro1/setup/zones-hlk.md @@ -1,12 +1,12 @@ --- -title: R PRO-1 HLKRadarTool app Zone Configuration +title: R PRO-1 HLKRadarTool app zone configuration description: Tutorial for R PRO-1 HLKRadarTool app Zone Configuration. --- -# How To Tune mmWave Using HLKRadarTool +# How to tune mmWave using HLKRadarTool -## LD2450 Configuration +## LD2450 configuration !!! note "Ensure that the LD2450 firmware version is V2.02.23090617 or later for proper integration functionality. " @@ -22,12 +22,16 @@ The Click here to download +Follow these steps to turn on the LD2450's Bluetooth and set up its zones in the HLKRadarTool app. + 1\. Head to the **ESPHome** integration page (**Settings → Devices & services → ESPHome**) then select your R PRO-1 and scroll down until you see LD2450 Bluetooth. [](https://my.home-assistant.io/redirect/integration/?domain=esphome)  +*Shown on an MTR-1; the R PRO-1 has the same LD2450 Bluetooth switch.* + 2\. Open the HLKRadarTool App and select your device. !!! success "You need to be close to your device!" @@ -40,13 +44,13 @@ The **Disabled**: Disable 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. + 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 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! + Disabled allows you to 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!  @@ -62,7 +66,9 @@ The uploading the firmware document. -## Method 2: Boot and Reset Buttons +## Method 2: Boot and reset buttons + +You'll open the case, then use the boot and reset buttons together to put the device into boot mode. 1\. Unplug your R PRO-1 from power and remove the back. diff --git a/docs/products/rpro1/troubleshooting/rpro1-code.md b/docs/products/rpro1/troubleshooting/rpro1-code.md index 345657a708..5e75181716 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-code.md +++ b/docs/products/rpro1/troubleshooting/rpro1-code.md @@ -1,43 +1,52 @@ --- -title: Factory Re-Flash R PRO-1 -description: Step by step guide for re-flashing the R PRO-1 back to factory firmware. +title: Factory re-flash R PRO-1 +description: Re-flash your R PRO-1 with its factory firmware from a Chromium-based browser when the device stops responding. --- -# Factory Re-Flash R PRO-1 +# Factory re-flash R PRO-1 -!!! info "If your device becomes unresponsive and you've exhausted the other troubleshooting methods you can reflash the factory firmware by following the steps below." +If your Apollo R PRO-1 becomes unresponsive and you've exhausted the other troubleshooting methods, you can re-flash the factory firmware by following the steps below. You'll put the R PRO-1 in boot mode, flash it from the Apollo installer in your browser, and then set it up as a new device. - This factory re-flash needs to be done in Chrome, Edge, or another Chromium based browser. +!!! note "Before you start" -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. + * Do this factory re-flash in Chrome, Edge, or another Chromium-based browser. + * If your device has already been connected to Home Assistant, remove it from the ESPHome integration and the ESPHome Device Builder before continuing. -1\. Locate the boot button 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. +1\. Put your R PRO-1 in boot mode. The boot button is on the bottom right of the board, so first unplug the R PRO-1, remove the back, and take the board out of the case. The boot mode guide shows each part.  -3\. Navigate to our installer page and click connect under Apollo R PRO-1 Installer. +With the board out of the case: -3\. Click the big "Connect" button. +- Push and hold the boot button. +- While still holding the button down, plug a USB-C cable into the USB-C port of your R PRO-1. +- Let go of the button. + +2\. Open the Apollo R PRO-1 Installer. + +3\. Click the big **Connect** button.  -3\. Select the open com port then click Connect. +4\. In the browser pop-up, select the open COM port (the R PRO-1's serial port, shown as USB JTAG/serial debug unit in the example below), then click **Connect**.  -4\. Click "Install R PRO-1". +5\. Click **Install R PRO-1**.  -5\. Click "INSTALL". +6\. Click **INSTALL**.  -6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +7\. When you see **Installation complete!**, you're finished. Click **Next**, then close the browser window.  -!!! warning "Power cycle your device before doing anything else!" +Your R PRO-1 now has the factory firmware again. + +!!! warning "Power cycle your device before doing anything else" - Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! + Your R PRO-1 is still in boot mode. Unplug it, then plug it back in so it starts in normal mode. -7\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file +8\. Follow the getting started guide to set up your R PRO-1 as a new device. 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 ac8bc78031..86884cb332 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md +++ b/docs/products/rpro1/troubleshooting/rpro1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials +title: Reset Wi-Fi credentials description: Step by step guide for resetting the Wi-Fi Credentials on your R PRO-1. --- -# Reset Wi-Fi Credentials on your R PRO-1 +# Reset Wi-Fi credentials on your R PRO-1 + +You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot. 1\. Plug the device into power. diff --git a/docs/products/rpro1/troubleshooting/rpro1-teardown.md b/docs/products/rpro1/troubleshooting/rpro1-teardown.md index a70d5b9c04..ccba18d0ac 100755 --- a/docs/products/rpro1/troubleshooting/rpro1-teardown.md +++ b/docs/products/rpro1/troubleshooting/rpro1-teardown.md @@ -1,11 +1,13 @@ --- -title: R PRO-1 Teardown +title: R PRO-1 teardown description: Step by step guide for tearing down your R PRO-1 to replace parts, clean it, swap cases, etc. --- -# Teardown and Reassembly Of R PRO-1 +# Teardown and reassembly of R PRO-1 ## Disassembly: +You'll remove the back, take the PCB out of the case, and remove both mmWave sensors. + 1\. Unplug your R PRO-1 from power and remove the back.  @@ -24,6 +26,8 @@ description: Step by step guide for tearing down your R PRO-1 to replace parts, ## Reassembly +To put everything back together, you'll reinstall both mmWave sensors, place the PCB back in the case, and snap the lid on. + 1\. Place the LD2450 on the 8 pin header.  diff --git a/docs/products/temp1/additional-info/bluetooth-proxy.md b/docs/products/temp1/additional-info/bluetooth-proxy.md index bc5bdbdbf1..96cebbb60c 100644 --- a/docs/products/temp1/additional-info/bluetooth-proxy.md +++ b/docs/products/temp1/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: TEMP-1 Bluetooth Proxy +title: TEMP-1 Bluetooth proxy description: Tutorial for how to turn your TEMP-1 into a BLE proxy! --- -# TEMP-1 Bluetooth Proxy +# TEMP-1 Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" diff --git a/docs/products/temp1/addons/food-probe.md b/docs/products/temp1/addons/food-probe.md index ca4313eb08..42e94f8e5c 100755 --- a/docs/products/temp1/addons/food-probe.md +++ b/docs/products/temp1/addons/food-probe.md @@ -1,20 +1,20 @@ --- -title: TEMP-1 Food Probe Guide +title: TEMP-1 food probe guide description: Step by step guide for installing and using the optional Food Probe with the TEMP-1. --- -# TEMP-1 Food Probe +# TEMP-1 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. +1\. To use your food probe, 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 +2\. Once inserted, press the reset button or power cycle your TEMP-1 so it detects the probe (see the tip below), then continue to step 3. !!! tip "If you have it plugged into power you need to push the reset button." diff --git a/docs/products/temp1/addons/magnetic-mount.md b/docs/products/temp1/addons/magnetic-mount.md index 495caee00c..f550149994 100755 --- a/docs/products/temp1/addons/magnetic-mount.md +++ b/docs/products/temp1/addons/magnetic-mount.md @@ -1,8 +1,8 @@ --- -title: TEMP-1 Magnetic Mount Guide +title: TEMP-1 magnetic mount guide description: Step by step guide for installing and using the optional Magnetic Mount with the TEMP-1. --- -# TEMP-1 Magnetic Mount +# TEMP-1 magnetic mount 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. diff --git a/docs/products/temp1/addons/multiple-probes.md b/docs/products/temp1/addons/multiple-probes.md index d5af079fea..a095240bda 100755 --- a/docs/products/temp1/addons/multiple-probes.md +++ b/docs/products/temp1/addons/multiple-probes.md @@ -1,8 +1,8 @@ --- -title: TEMP-1 Multi-Probe Splitter Guide +title: TEMP-1 multi-probe splitter guide description: Step by step guide for installing and using the TEMP-1 Multi-Probe Splitter addon. --- -# TEMP-1 Multi-Probe Splitter Guide +# TEMP-1 multi-probe splitter guide The TEMP-1 comes with an optional [3.5mm Multi-Probe Splitter](https://apolloautomation.com/products/temp-1-multi-probe-splitter) which can be used to monitor a fridge, freezer, fish tank, pool, hot tub, etc with up to 4 probes. @@ -20,7 +20,7 @@ The TEMP-1 comes with an optional [3.5mm Multi-Probe Splitter](https://apolloaut !!! success "Power on your TEMP-1 after plugging in all of your probes!" - The TEMP-1 will look for the probes at boot and mark them failed if you power on and plug in the probes after. Simply power cycle your device and they should show up! + The TEMP-1 will look for the probes at boot and mark them failed if you power on and plug in the probes after. Power cycle your device and they should show up! 3\. Go to the device page of your TEMP-1 in Home Assistant and confirm the Temperature Probe is selected from the dropdown. diff --git a/docs/products/temp1/addons/temp-probe.md b/docs/products/temp1/addons/temp-probe.md index 86fe512fce..c10850046e 100755 --- a/docs/products/temp1/addons/temp-probe.md +++ b/docs/products/temp1/addons/temp-probe.md @@ -1,12 +1,12 @@ --- -title: TEMP-1 Temp Probe Guide +title: TEMP-1 temp probe guide description: Step by step guide for installing and using the optional Temp Probe with the TEMP-1. --- -# TEMP-1 Temp Probe +# TEMP-1 temp probe The TEMP-1 comes with an optional temp probe which can be used to monitor a fridge, freezer, fish tank, pool, hot tub, etc. It includes a protected cable but the TEMP-1 itself needs to stay in a cool environment. -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. +1\. To use your temp probe, take it out of the package and insert it into the 3.5mm port on your TEMP-1.  @@ -30,7 +30,7 @@ The TEMP-1 comes with an optional temp probe which can be used to monitor a frid  -## Probe Pinout +## 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. diff --git a/docs/products/temp1/examples/hot-water-recirculation.md b/docs/products/temp1/examples/hot-water-recirculation.md index 75877d0683..2845d31e8e 100644 --- a/docs/products/temp1/examples/hot-water-recirculation.md +++ b/docs/products/temp1/examples/hot-water-recirculation.md @@ -1,8 +1,8 @@ --- -title: Hot Water Recirculation with TEMP-1 +title: Hot water recirculation with TEMP-1 description: How a community member uses an Apollo TEMP-1 to drive a hot water recirculation loop, blending an instant mini tank with the main house heater and wasting no water down the drain. --- -# Hot Water Recirculation with TEMP-1 +# Hot water recirculation with TEMP-1 !!! info "Contributed by Donovan" @@ -124,7 +124,7 @@ Donovan's whole system is one blueprint. Import it, pick your entities, set your | Input | What to pick | | --- | --- | -| **Start trigger** | The press that starts a cycle, like your Aqara button's single click. Pick it from the trigger editor just like any automation. You can add more than one (see the tip below). | +| **Start trigger** | The press that starts a cycle, like your Aqara button's single click. Pick it from the trigger editor like any automation. You can add more than one (see the tip below). | | **Circulator pump plug** | The smart plug powering the pump. | | **Circulator pump power** | That plug's power (W) sensor, how the system knows the pump has finished. | | **3-way valve plug** | The smart plug powering the valve. | diff --git a/docs/products/temp1/examples/temp1-alert-example.md b/docs/products/temp1/examples/temp1-alert-example.md index 4ba26ab69f..3fcd53c157 100755 --- a/docs/products/temp1/examples/temp1-alert-example.md +++ b/docs/products/temp1/examples/temp1-alert-example.md @@ -1,10 +1,8 @@ --- -title: TEMP-1 Alert Outside Temp Range Example +title: TEMP-1 alert outside temp range example description: Step by step guide for alerting outside the set range with the TEMP-1. --- -# TEMP-1 Alert Outside Temp Range Example - -###### +# TEMP-1 alert outside temp range example This will guide you through how to set up the built in alarm using the temperature probe in your freezer! diff --git a/docs/products/temp1/examples/temp1-automation-examples.md b/docs/products/temp1/examples/temp1-automation-examples.md index d5be2e43d8..b671e7bdc0 100755 --- a/docs/products/temp1/examples/temp1-automation-examples.md +++ b/docs/products/temp1/examples/temp1-automation-examples.md @@ -1,52 +1,60 @@ --- -title: TEMP-1 Automation Examples -description: Multiple automation examples with the TEMP-1. +title: TEMP-1 automation examples +description: Three Home Assistant automations for your TEMP-1, from a freezer temperature alert and a food probe alert to a dashboard button that monitors chicken while it cooks. --- -# Automation Examples using a TEMP-1 +# Automation examples using a TEMP-1 -## Freezer Temperature Probe Example +These three examples show you how to put your Apollo TEMP-1 to work in Home Assistant: get an alert when your freezer warms up, know when your food reaches temperature, and run a whole chicken-cooking routine from one dashboard button. -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. +## Freezer temperature probe example -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. +This example walks you through setting up an automation in Home Assistant with the temperature probe in your freezer. At the end, you'll have an automation that sends your phone a notification when the freezer goes above the temperature you set. -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. +!!! danger "Only the probe goes in the freezer" + + Only the temperature probe and its wire can withstand the temperatures in a fridge, freezer, and similar places. Keep your TEMP-1 itself in a cool, dry place. + +1\. Place the temperature probe in your freezer and wait for it to settle around 0°F (-18°C). + +2\. Once it has settled, look at the probe's history graph in Home Assistant (shown below) and decide on good values for both the maximum and minimum temperatures. In this example, the mini freezer seems to max out at 30°F, so the maximum goes slightly above that range. However, most freezers should not reach above 0°F, so you'll likely need a lower value than this example. The minimums in this example 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. +3\. Convert your values to Celsius, because **Max Probe Temp** and **Min Probe Temp** are set in Celsius, then enter them. This example uses a **Max Probe Temp** of 2°C and a **Min Probe Temp** of -30°C. Yours will likely be different, especially your **Max Probe Temp**. These settings control the TEMP-1's built-in buzzer alarm.  -4\. The automation is now ready to be created - +Next, create the automation that sends the notification to your phone. -5\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. +4\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. [](https://my.home-assistant.io/redirect/automations/) -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. +5\. Click **Add trigger → Entity → Numeric state** and search for your TEMP-1 temperature probe, such as "temp-1 temperature probe". In the box labeled **Above**, type the maximum temperature you decided on in step 2. Prefer YAML? Skip ahead to the [freezer automation YAML](#freezer-automation-yaml).  -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. +6\. Click **Add action**, type "iPhone", and select your phone. If you don't see your phone, or you have an Android phone, type "notify" instead and scroll down until you find your phone in the list.  -!!! tip "If you still do not see your device as shown in step 7 read this!" +!!! tip "Still don't see your phone?" - You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready! + You need the Home Assistant mobile app installed on your phone for this step to work. If you don't have it, try another notification instead of your phone, such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready! -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!". +7\. Type your message. If you want a title too, check the box for the title and type it in. This example's message is "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and its title is "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! +8\. Click **Save** in the bottom right, then give the automation a name and, optionally, a description and a category.  ---- +You're done. Your phone now gets a notification whenever the freezer probe goes above your maximum temperature. + +### Freezer automation YAML -10\. YAML for Advanced Users +If you'd rather work in YAML, here's the finished automation. Use your own entity ID and phone in place of the ones shown. ```yaml alias: Freezer Over Max Temp Automation @@ -54,7 +62,8 @@ description: Warning for the freezer when it reaches the max temperature. triggers: - trigger: numeric_state entity_id: - - number.apollo_temp_1_max_probe_temp + - sensor.apollo_temp_1_temperature_probe + # in the unit Home Assistant shows for the probe (°F here); use your own entity ID above: 30 conditions: [] actions: @@ -68,43 +77,49 @@ actions: mode: single ``` -## Food Probe Example +## Food probe example + +This example walks you through setting up an automation in Home Assistant with the food probe while chicken (or anything else) cooks to 165°F (73.9°C). At the end, you'll have an automation that sends your phone a notification when your food reaches that temperature. -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. +!!! danger "Only the probe goes on the grill" -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. + Only the food probe and the wire can withstand temperatures on a grill, in the oven, and similar places. Keep your TEMP-1 itself in a cool, dry place. + +1\. Set your **Max Probe Temp** to 73.9°C. **Max Probe Temp** is always set in Celsius, even if you use °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. +2\. Place the food probe inside your food once it's on the grill. 3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. [](https://my.home-assistant.io/redirect/automations/) -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 → Entity → Numeric state** and search for your TEMP-1 food probe, such as "temp-1 food probe". In the box labeled **Above**, type the temperature you want for your food. This example uses 165°F (73.9°C), the temperature it's safe to cook chicken to. Prefer YAML? Skip ahead to the [food probe automation YAML](#food-probe-automation-yaml).  -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**, type "iPhone", and select your phone. If you don't see your phone, or you have an Android phone, type "notify" instead and scroll down until you find your phone in the list.  -!!! tip "If you still do not see your device as shown in step 7 read this!" +!!! tip "Still don't see your phone?" - You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready! + You need the Home Assistant mobile app installed on your phone for this step to work. If you don't have it, try another notification instead of your phone, such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready! -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!". +6\. Type your message. If you want a title too, check the box for the title and type it in. This example's message is "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and its title is "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! +7\. Click **Save** in the bottom right, then give the automation a name and, optionally, a description and a category.  ---- +You're done. Your phone now gets a notification when your food reaches the temperature you set. + +### Food probe automation YAML -8\. YAML for Advanced Users +If you'd rather work in YAML, here's the finished automation. Use your own entity ID and phone in place of the ones shown. ```yaml alias: Food Over Max Temp Automation @@ -112,7 +127,8 @@ description: Warning for the food when it reaches the max temperature. triggers: - trigger: numeric_state entity_id: - - number.apollo_temp_1_max_probe_temp + - sensor.apollo_temp_1_food_probe + # in the unit Home Assistant shows for the probe (°F here); use your own entity ID above: 165 conditions: [] actions: @@ -125,11 +141,21 @@ actions: mode: single ``` -## Cook Chicken Example +## Cook chicken example + +This example walks you through adding a "Chicken Monitor" button to your dashboard and an automation that runs when you press it. The automation: + +- Turns the RGB LED green while it's running. +- Messages your phone when it starts, when the temperature is reached, and when it finishes. +- Turns the RGB LED off at the end. -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! +Thanks to Discord user RalphP for this! -1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper. +The automation has three triggers, each with its own trigger ID, and one **Choose** action with an option for each trigger ID. You'll build it in that order. + +### Create the button + +1\. Create a new toggle helper called "Chicken Monitor". For step-by-step directions on creating a toggle helper, see this guide.  @@ -137,118 +163,134 @@ This will guide you through adding a button to your dashboard called "Chicken Mo  +### Create the automation and its triggers + +Next, you'll create the automation and add its three triggers, each with its own trigger ID. + 3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. [](https://my.home-assistant.io/redirect/automations/) -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. +4\. Click **Add trigger → Entity → State** and search for "Chicken Monitor". In the box labeled **To**, select **On**.  -5\. Create a Trigger ID for this called "Chicken Monitor On". +5\. Create a trigger ID for this trigger 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". +6\. Click **Add trigger → Entity → State** and search for "Chicken Monitor". In the box labeled **To**, select **Off**. Create a trigger ID for this trigger 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. +7\. Click **Add trigger → Entity → Numeric state** and search for your TEMP-1 food probe entity, such as "temp-1 food probe". In the box labeled **Above**, type the temperature you want for your food. This example uses 160°F (71.1°C), because the chicken will rest and reach 165°F once it's removed from the oven or grill.  -8\. Create a Trigger ID for this called "Temp Reached". +8\. Create a trigger ID for this trigger called "Temp Reached".  -9\. Click Add Action and search "choose" then select it. +### Option 1: Monitoring starts + +Option 1 runs when you turn Chicken Monitor on. It turns the LED green and tells your phone that monitoring has started. + +9\. Click **Add action**, search "choose", and select it.  -10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by. +10\. Under Option 1, select **Add condition**, search "trigger id", and select **Triggered by**.  -11\. Check off the option "Button Pressed" that we created in step 5 above. +11\. Check **Chicken Monitor On**, the trigger ID you created in step 5. - + -12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on. +12\. Still under Option 1 in the Choose action, click **Add action**, search "light", and select **Light: Turn on**.  -13\. Click choose entity then search for your device such as "Temp-1 RGB Light". +13\. Click **Choose entity** and 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. +14\. Click **Advanced options**, check the box for **Color name**, then select a color from the drop-down, 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. +15\. Still under Option 1 in the Choose action, click **Add action**, search "mobile", and select your phone in the list.  -16\. Write in a custom title and or message- the message is required but the title is not. +16\. Write a custom title and 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: +17\. Check your work. When you're done with this part, Option 1 looks like this:  -18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by. +### Option 2: Temperature reached + +Option 2 runs when the food probe reaches your temperature. It blinks the LED until you turn Chicken Monitor off, and messages your phone. + +18\. Click **Add option** at the bottom. Under Option 2, select **Add condition**, search "trigger id", and select **Triggered by**.  -19\. Check off the option "Temp Reached" that we created in step 7 above. +19\. Check **Temp Reached**, the trigger ID you created in step 8.  -20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown. +20\. Still under Option 2 in the Choose action, click **Add action**, search "repeat", and select **Until** in the drop-down.  -21\. Under Until Conditions, select "Add condition" then search "state". +21\. Under **Until** conditions, select **Add condition** and search "state".  -22\. Type in Chicken Monitor and select it, then click "Off" in the dropdown for the state of the sensor. +22\. Type "Chicken Monitor" and select it, then select **Off** in the drop-down 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. +23\. Click **Add action** under the **Until** condition you just created. 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 the rgb led for your device +24\. Search "light toggle" in the search bar, then select **Choose entity** and select 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. +25\. Go down to **Add action** under Option 2, search "mobile", and select your phone, as you did 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 set up. +26\. (Optional) Add another action here to speak out loud on your smart speakers, such as HomePods. Click **Add action** and search "TTS". This requires you to have Piper and a few other things already set up.  -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. +### Option 3: Monitoring stops + +Option 3 runs when you turn Chicken Monitor off. It turns the LED off and tells your phone that monitoring has stopped. + +27\. Click **Add option** (this is now Option 3). Select **Add condition**, search "triggered by", and choose the "Chicken Monitor Off" trigger ID you 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. +28\. Still under Option 3 in the Choose action, click **Add action**, search "light", and select **Light: Turn off**.  -29\. Click choose entity then search for your device such as "Temp-1 RGB Light". +29\. Click **Choose entity** and 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. +30\. Click **Add action**, search "mobile" as you did above, and select your 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 +31\. Click **Save** in the bottom right, then give the automation a name and save it.  -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 +You now have one automation that ties together the button you created in the dashboard and alerts you when your chicken is almost done, with a phone notification, a blinking green LED, and an optional TTS notification on your smart speakers. Thanks again to Discord user RalphP for this example! diff --git a/docs/products/temp1/examples/use-cases.md b/docs/products/temp1/examples/use-cases.md index 7b18d919a7..af6a78994d 100755 --- a/docs/products/temp1/examples/use-cases.md +++ b/docs/products/temp1/examples/use-cases.md @@ -1,8 +1,8 @@ --- -title: TEMP-1 Use Cases +title: TEMP-1 use cases description: List of use cases for the TEMP-1. --- -# Use Cases for the TEMP-1 +# Use cases for the TEMP-1 1\. Monitoring fridge / freezer: There are settings to set the maximum temperature the sensor should reach. It can alert through the onboard buzzer if it rises above that temperature. The cable on the probe is flat to not interfere with fridge seals. diff --git a/docs/products/temp1/faq.md b/docs/products/temp1/faq.md index 68444d9faf..f47c847409 100755 --- a/docs/products/temp1/faq.md +++ b/docs/products/temp1/faq.md @@ -12,11 +12,11 @@ description: Frequently asked questions about the TEMP-1 temperature sensor. * 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. * 20cm (~8in) Waterproof Flat Cable (DS18B20) -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. -* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 204°C (400°F). Perfect for grilling, baking, and food prep (not dishwasher safe). +* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC): Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe). 3\. **Is the TEMP-1 weatherproof? Can I use it outdoors?** -* The TEMP-1 is primarily designed for indoor use, but components like the waterproof soil probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection. +* The TEMP-1 is primarily designed for indoor use, but components like the waterproof temperature probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection. 4\. **How does the TEMP-1 connect to Home Assistant?** @@ -24,7 +24,7 @@ description: Frequently asked questions about the TEMP-1 temperature sensor. 5\. **How often does the TEMP-1 send sensor data?** -* The TEMP-1’s reporting frequency is adjustable in ESPHome but most things default to 60 seconds. You can set it for frequent updates or extend intervals to conserve battery life. +* The TEMP-1’s reporting frequency is adjustable in ESPHome but most things default to 60 seconds. You can set it for more frequent updates or longer intervals. 6\. **Can I customize the TEMP-1 functionality?** @@ -32,7 +32,7 @@ description: Frequently asked questions about the TEMP-1 temperature sensor. 7\. **What are the RGB LED and piezo buzzer used for?** -* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure. +* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like the probe temperature going outside the Min/Max Probe Temp range you set (with Alarm Outside Temp Range turned on). 8\. **Is the TEMP-1 compatible with other smart home platforms?** @@ -52,7 +52,7 @@ description: Frequently asked questions about the TEMP-1 temperature sensor. 12\. **Can I use multiple TEMP-1 sensors in one Home Assistant setup?** -* Yes, you can add multiple TEMP-1 sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces. +* Yes, you can add multiple TEMP-1 sensors, each appearing as a separate device, for comprehensive monitoring across multiple fridges, freezers, or spaces. 13\. **Can I use an extender to make the TEMP-1 temp probe cable longer?** diff --git a/docs/products/temp1/introduction.md b/docs/products/temp1/introduction.md index e36426caa6..804035cf9c 100755 --- a/docs/products/temp1/introduction.md +++ b/docs/products/temp1/introduction.md @@ -4,13 +4,13 @@ description: Documentation for TEMP-1, including setup, usage, and best practice --- -The TEMP-1 can be used with an optional temperature probe which comes in two lengths or a food safe grill probe. The TEMP-1 itself can be used with an optional magnetic mount to mount it to a fridge, grill, or other surface while taking measurements. It also features an AHT20-F air temperature and humidity sensor, which includes dust protection, an RGB LED, a piezo buzzer, and an optional DS18b20 waterproof soil temperature probe (20 cm / 7.8 inches). +The TEMP-1 can be used with an optional temperature probe which comes in two lengths or a food safe grill probe. The TEMP-1 itself can be used with an optional magnetic mount to mount it to a fridge, grill, or other surface while taking measurements. It also features an AHT20-F air temperature and humidity sensor, which includes dust protection, an RGB LED, and a piezo buzzer. **Optional Probe Addons:** -* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. -* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. -* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe). +* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc. +* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. +* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC): Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe). diff --git a/docs/products/temp1/reviews.md b/docs/products/temp1/reviews.md index 7c448be335..5cbbe5bb48 100755 --- a/docs/products/temp1/reviews.md +++ b/docs/products/temp1/reviews.md @@ -1,5 +1,5 @@ --- -title: TEMP-1 Reviews +title: TEMP-1 reviews 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/products/temp1/setup/prevent-sleep.md b/docs/products/temp1/setup/prevent-sleep.md index b33bba6ae1..73cf3a4811 100755 --- a/docs/products/temp1/setup/prevent-sleep.md +++ b/docs/products/temp1/setup/prevent-sleep.md @@ -1,5 +1,5 @@ --- -title: TEMP-1 Prevent Sleep Guide +title: TEMP-1 Prevent Sleep guide description: Guide for setting up and using the prevent sleep toggle with the TEMP-1. --- # Prevent Sleep @@ -10,6 +10,8 @@ description: Guide for setting up and using the prevent sleep toggle with the TE 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. +You'll set how long your sensor sleeps, then turn off **Prevent Sleep** so it can start sleeping. + 1\. Head to the ESPHome Integrations page. 2\. Click on the name "1 device" below your Apollo device's name. @@ -32,4 +34,4 @@ description: Guide for setting up and using the prevent sleep toggle with the TE !!! danger "Do not leave your sensor outside or let it get wet!" - The TEMP-1B should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your TEMP-1B if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file + The TEMP-1 should not be left outside for long periods of time or allowed to get wet. You will need to use another case around your TEMP-1 if there will be high moisture content in the air or if it is expected to rain. \ No newline at end of file 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 a60353e957..73a6fa57c9 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 @@ -1,8 +1,8 @@ --- -title: How To Change The Temperature Probe Update Interval +title: How to change the temperature probe update interval description: Change how often the TEMP-1 temperature probe reports by overriding its YAML in the ESPHome Builder. --- -# How To Change The Temperature Probe Update Interval +# How to change the temperature probe update interval By default the TEMP-1 reports its **Temperature Probe** every 60 seconds. You can make it report faster, such as every 10 seconds, by overriding the sensor's YAML in the ESPHome Builder. This is useful for smoother graphs or quicker reactions when you are watching a fridge, freezer, fish tank, or hot tub. @@ -20,7 +20,7 @@ By default the TEMP-1 reports its **Temperature Probe** every 60 seconds. You ca !!! tip "Start on a fresh line with no spaces in front" - The `sensor:` line has to start at the very beginning of a new line. If you press Enter from the end of the `wifi_password` line, the editor indents your cursor one space, which makes the YAML invalid. The easy fix is to press Enter twice, then Backspace once. That drops you to a fresh line with no leading space. + The `sensor:` line has to start at the very beginning of a new line. If you press Enter from the end of the `wifi_password` line, the editor indents your cursor one space, which makes the YAML invalid. The fix is to press Enter twice, then Backspace once. That drops you to a fresh line with no leading space. ```yaml sensor: diff --git a/docs/products/temp1/setup/temp1-general-tips.md b/docs/products/temp1/setup/temp1-general-tips.md index bb9c9b180a..d2a19f6c99 100755 --- a/docs/products/temp1/setup/temp1-general-tips.md +++ b/docs/products/temp1/setup/temp1-general-tips.md @@ -1,17 +1,17 @@ --- -title: TEMP-1 General Tips +title: TEMP-1 general tips description: >- General tips for the TEMP-1 device and suggestions for improving the usability of the temp and food probe sensor. --- -# TEMP-1 General Tips +# TEMP-1 general tips 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). +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 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 +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/setup/temp1-sensor-definitions.md b/docs/products/temp1/setup/temp1-sensor-definitions.md index bc4282cc2a..f677a2ab75 100755 --- a/docs/products/temp1/setup/temp1-sensor-definitions.md +++ b/docs/products/temp1/setup/temp1-sensor-definitions.md @@ -1,8 +1,8 @@ --- -title: TEMP-1 Sensor Definitions +title: TEMP-1 sensor definitions description: Full list of definitions for the TEMP-1 and its various sensors. --- -# Sensor Definitions +# Sensor definitions Once added to Home Assistant you can configure different settings for your TEMP-1. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them. @@ -10,7 +10,7 @@ Once added to Home Assistant you can configure different settings for your TEMP- The **Default Update** column is how often each sensor refreshes while the TEMP-1 is awake. By default **Prevent Sleep** is on, so the device stays awake and reports continuously at these intervals. Turn **Prevent Sleep** off to let the TEMP-1 deep-sleep between readings for more accurate onboard AHT20 temperature and humidity (the ESP chip's heat skews them while it is awake); it then wakes for about 90 seconds, reports, and sleeps for the **Sleep Duration**. - To update firmware on a sleeping device, just click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand. + To update firmware on a sleeping device, click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand. === "Controls" diff --git a/docs/products/temp1/troubleshooting/temp1-boot-mode.md b/docs/products/temp1/troubleshooting/temp1-boot-mode.md index 1beb60a6ab..1cc706b7ed 100755 --- a/docs/products/temp1/troubleshooting/temp1-boot-mode.md +++ b/docs/products/temp1/troubleshooting/temp1-boot-mode.md @@ -1,14 +1,16 @@ --- -title: Putting The TEMP-1 In Boot Mode +title: Putting the TEMP-1 in boot mode description: Step by step guide for putting The TEMP-1 In Boot Mode. --- -# Putting The TEMP-1 In Boot Mode +# Putting the TEMP-1 in boot mode !!! info "This will cover how to put the TEMP-1 into 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 + +You can put your device into boot mode with only the boot button and a paperclip. 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 +26,9 @@ 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 + +You can also open the case and use the boot and reset buttons together to put your device into boot mode. 1\. Unplug the device and remove the case as shown in the images above diff --git a/docs/products/temp1/troubleshooting/temp1-code.md b/docs/products/temp1/troubleshooting/temp1-code.md index 697647bb7d..c146df6365 100755 --- a/docs/products/temp1/troubleshooting/temp1-code.md +++ b/docs/products/temp1/troubleshooting/temp1-code.md @@ -1,45 +1,50 @@ --- -title: Factory Re-Flash TEMP-1 -description: Step by step guide for re-flashing the TEMP-1 back to factory firmware. +title: Factory re-flash TEMP-1 +description: Step-by-step guide to re-flashing the TEMP-1 back to its factory firmware from Chrome, Edge, or another Chromium-based browser. --- -# Factory Re-Flash TEMP-1 +# Factory re-flash TEMP-1 -!!! 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." +If your Apollo TEMP-1 becomes unresponsive and you've exhausted the other troubleshooting methods, you can reflash the factory firmware by following this guide. - This needs to be done in Chrome, Edge, or another Chromium based browser. +!!! note "Before you start" -If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing. + - Use Chrome, Edge, or another Chromium-based browser. The installer needs one of them. + - If your TEMP-1 has already been connected to Home Assistant, remove it from the ESPHome integration and the ESPHome Device Builder before continuing. -1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable. +Follow these steps to put your TEMP-1 in boot mode, flash the factory firmware from the installer page, and set it up again. -2\. Navigate to our installer page and click connect under Battery Firmware [Apollo TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/). +1\. Put your TEMP-1 in boot mode: hold down the boot button, then plug in the USB cable. -3\. Click "Connect" under the Non Battery Firmware option since you are using a TEMP-1. +2\. Open the [Apollo TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/) page. -!!! tip "Use R2 version unless instructed to use R1 by support!" - - R2 is what all of our devices use except a very small batch of TEMP-1 and TEMP-1B +3\. Under the **Non Battery Firmware** option, click **Connect** for Revision 2 (R2). Non Battery Firmware is the right choice because you're using a TEMP-1.  -3\. Select the open com port then click Connect. +!!! tip "Use R2 unless support tells you to use R1" + + R2 is what all of our devices use, except a very small batch of TEMP-1 and TEMP-1B boards. Support will tell you if yours needs R1. + +4\. In the browser's serial port pop-up, select the open COM port (**USB JTAG/serial debug unit** in the screenshot below), then click **Connect**.  -4\. Click "Install ApolloAutomation.TEMP-1". +5\. Click **Install ApolloAutomation.TEMP-1**.  -5\. Click "INSTALL". +6\. Click **INSTALL**.  -6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window. +7\. When the installer shows **Installation complete!**, the flash is finished. Click **Next**, then close the browser window.  -!!! warning "Power cycle your device before doing anything else!" +!!! warning "Power cycle your TEMP-1 before doing anything else" + + Your TEMP-1 is still in boot mode. Remove its power by unplugging the USB cable, then plug it back in so it starts in normal mode. - Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode! +8\. Go to the getting started guide and set up your TEMP-1 as a new device. -7\. Please proceed to the getting started guide and set up your sensor as a new device! \ No newline at end of file +Once it's set up, your TEMP-1 is back on its factory firmware and ready to use. diff --git a/docs/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md b/docs/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md index e1daa08dc7..587239660b 100755 --- a/docs/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md +++ b/docs/products/temp1/troubleshooting/temp1-reset-wi-fi-credentials.md @@ -1,8 +1,10 @@ --- -title: Reset Wi-Fi Credentials +title: Reset Wi-Fi credentials description: Step by step guide for resetting the Wi-Fi Credentials on your TEMP-1. --- -# Reset Wi-Fi Credentials on your TEMP-1 +# Reset Wi-Fi credentials on your TEMP-1 + +You can clear the Wi-Fi details saved on your device and connect it to a new Wi-Fi network through its hotspot. 1\. Plug the device into power. @@ -14,4 +16,4 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your TEMP 3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again. -4\. Connect to the hotspot titled "Apollo TEMP-1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file +4\. Connect to the hotspot titled "Apollo TEMP1 Hotspot" and enter your new Wi-Fi details! \ No newline at end of file diff --git a/docs/products/temp1/troubleshooting/temp1-teardown.md b/docs/products/temp1/troubleshooting/temp1-teardown.md index 87c9ef74ec..dd15e41cd4 100755 --- a/docs/products/temp1/troubleshooting/temp1-teardown.md +++ b/docs/products/temp1/troubleshooting/temp1-teardown.md @@ -1,8 +1,10 @@ --- -title: TEMP-1 Teardown +title: TEMP-1 teardown description: Step by step guide for tearing down your TEMP-1 to replace parts, clean it, swap cases, etc. --- -# Teardown Of TEMP-1 +# Teardown of TEMP-1 + +Follow these steps to take your sensor apart and put it back together. 1\. Gently pry open the case lid as shown in the image below. diff --git a/docs/products/temp1b/additional-info/bluetooth-proxy.md b/docs/products/temp1b/additional-info/bluetooth-proxy.md index 3033b07849..eb0c5875a1 100644 --- a/docs/products/temp1b/additional-info/bluetooth-proxy.md +++ b/docs/products/temp1b/additional-info/bluetooth-proxy.md @@ -1,8 +1,8 @@ --- -title: TEMP-1B Bluetooth Proxy +title: TEMP-1B Bluetooth proxy description: Tutorial for how to turn your TEMP-1B into a BLE proxy! --- -# TEMP-1B Bluetooth Proxy +# TEMP-1B Bluetooth proxy --8<-- "_snippets/bluetooth-proxy/intro.md" diff --git a/docs/products/temp1b/addons/food-probe.md b/docs/products/temp1b/addons/food-probe.md index 5fcd894c74..423a80e788 100755 --- a/docs/products/temp1b/addons/food-probe.md +++ b/docs/products/temp1b/addons/food-probe.md @@ -1,14 +1,14 @@ --- -title: TEMP-1B Food Probe Guide +title: TEMP-1B food probe guide description: Step by step guide for installing and using the optional Food Probe with the TEMP-1B. --- -# TEMP-1B Food Probe +# TEMP-1B food probe -The TEMP-1B 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. +The TEMP-1B 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-1B 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-1B. +1\. To use your food probe, take it out of the package and insert it into the 3.5mm port on your TEMP-1B.  diff --git a/docs/products/temp1b/addons/magnetic-mount.md b/docs/products/temp1b/addons/magnetic-mount.md index 6f86ddb939..b14daf41ab 100755 --- a/docs/products/temp1b/addons/magnetic-mount.md +++ b/docs/products/temp1b/addons/magnetic-mount.md @@ -1,8 +1,8 @@ --- -title: TEMP-1B Magnetic Mount Guide +title: TEMP-1B magnetic mount guide description: Step by step guide for installing and using the optional Magnetic Mount with the TEMP-1B. --- -# TEMP-1B Magnetic Mount +# TEMP-1B magnetic mount The TEMP-1B comes with an optional magnetic mount which can be used to secure the TEMP-1B to your fridge or grill as shown below. diff --git a/docs/products/temp1b/addons/temp-probe.md b/docs/products/temp1b/addons/temp-probe.md index e3ee26dc20..28ce7883b2 100755 --- a/docs/products/temp1b/addons/temp-probe.md +++ b/docs/products/temp1b/addons/temp-probe.md @@ -1,12 +1,12 @@ --- -title: TEMP-1B Temp Probe Guide +title: TEMP-1B temp probe guide description: Step by step guide for installing and using the optional Temp Probe with the TEMP-1B. --- -# TEMP-1B Temp Probe +# TEMP-1B temp probe -The TEMP-1B comes with an optional temp probe which can be used to monitor a fridge, freezer, fish tank, pool, hot tub, etc. It includes a protected cable but the TEMP-1 itself needs to stay in a cool environment. +The TEMP-1B comes with an optional temp probe which can be used to monitor a fridge, freezer, fish tank, pool, hot tub, etc. It includes a protected cable but the TEMP-1B itself needs to stay in a cool environment. -1\. To use your temp probe simply take it out of the package and insert it into the 3.5mm port on your TEMP-1B. +1\. To use your temp probe, take it out of the package and insert it into the 3.5mm port on your TEMP-1B.  @@ -16,7 +16,7 @@ The TEMP-1B comes with an optional temp probe which can be used to monitor a fri !!! tip "If you are using it with a battery you need to push the reset button." - The TEMP-1B looks for the temp probe when it boots and if it is not there then the sensor is marked as failed and will not work properly in Home Assistant. You need to click the reset button if you have a battery in it or power cycle your TEMP-1B to make it reliably use the new food temperature probe. + The TEMP-1B looks for the temp probe when it boots and if it is not there then the sensor is marked as failed and will not work properly in Home Assistant. You need to click the reset button if you have a battery in it or power cycle your TEMP-1B to make it reliably use the new temperature probe. @@ -36,7 +36,7 @@ The TEMP-1B comes with an optional temp probe which can be used to monitor a fri  -## Probe Pinout +## 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. diff --git a/docs/products/temp1b/examples/hot-water-recirculation.md b/docs/products/temp1b/examples/hot-water-recirculation.md index c3bde4fde5..6356ff0513 100644 --- a/docs/products/temp1b/examples/hot-water-recirculation.md +++ b/docs/products/temp1b/examples/hot-water-recirculation.md @@ -1,8 +1,8 @@ --- -title: Hot Water Recirculation with TEMP-1 +title: Hot water recirculation with TEMP-1 description: How a community member uses an Apollo TEMP-1 to drive a hot water recirculation loop, blending an instant mini tank with the main house heater and wasting no water down the drain. --- -# Hot Water Recirculation with TEMP-1 +# Hot water recirculation with TEMP-1 !!! warning "Running this on a TEMP-1B" diff --git a/docs/products/temp1b/examples/temp1b-alert-example.md b/docs/products/temp1b/examples/temp1b-alert-example.md index 5ec624d45f..605ce087bf 100755 --- a/docs/products/temp1b/examples/temp1b-alert-example.md +++ b/docs/products/temp1b/examples/temp1b-alert-example.md @@ -1,10 +1,8 @@ --- -title: TEMP-1B Alert Outside Temp Range Example +title: TEMP-1B alert outside temp range example description: Step by step guide for alerting outside the set range with the TEMP-1B. --- -# TEMP-1B Alert Outside Temp Range Example - -###### +# TEMP-1B alert outside temp range example This will guide you through how to set up the built in alarm using the temperature probe in your freezer! @@ -14,6 +12,8 @@ This will guide you through how to set up the built in alarm using the temperatu  +*Shown on a TEMP-1; the TEMP-1B graph looks the same.* + 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.  diff --git a/docs/products/temp1b/examples/temp1b-automation-examples.md b/docs/products/temp1b/examples/temp1b-automation-examples.md index f9641ccf78..7381cade92 100755 --- a/docs/products/temp1b/examples/temp1b-automation-examples.md +++ b/docs/products/temp1b/examples/temp1b-automation-examples.md @@ -1,52 +1,78 @@ --- -title: TEMP-1B Automation Examples -description: Multiple automation examples with the TEMP-1B. +title: Automation examples using a TEMP-1B +description: Three Home Assistant automations for the TEMP-1B, from a freezer alert to a chicken monitor that blinks the RGB LED and messages your phone when your food is almost done. --- -# Automation Examples using a TEMP-1B +# Automation examples using a TEMP-1B -## Freezer Temperature Probe Example +Difficulty: Level 2 -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. +
🌱 New here? Try these first:
+
+
-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.
+Your Apollo TEMP-1B's probes can drive Home Assistant automations. This page walks you through three of them: a freezer alert, a food probe alert, and a chicken monitor you start and stop from your dashboard.
-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.
+## Freezer temperature probe example
+
+Set up a Home Assistant automation that uses the temperature probe in your freezer. At the end, you'll have an automation that sends your phone a notification when the probe goes above your maximum temperature.
+
+1\. Place the temperature probe into your freezer, then wait for its reading to settle around 0°F (-18°C).
+
+!!! danger "Only the probe goes in the freezer"
+
+ Keep your TEMP-1B itself in a cool, dry place. Only the temp probe and its wire can withstand the temperatures in a fridge, freezer, and similar places.
+
+2\. Once the reading settles, look at the graph and pick a good value for both the maximum and the minimum temperature. In this example, the mini freezer seems to max out at 30°F, so the maximum goes slightly above that. However, most freezers should not reach above 0°F, so you'll likely need a lower maximum than this one. The minimums here 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.
+*Shown on a TEMP-1; the TEMP-1B graph looks the same.*
+
+3\. Convert your maximum and minimum from °F to °C, then enter them in **Max Probe Temp** and **Min Probe Temp**. Both settings are measured in Celsius. This example uses a max probe temp of 2°C and a min probe temp of -30°C. Your values will likely be different, especially your max probe temp.
-4\. The automation is now ready to be created -
+With your thresholds set, the automation is now ready to be created.
-5\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**.
+4\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**.
[](https://my.home-assistant.io/redirect/automations/)
-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.
+5\. Click **Add Trigger**, then **Entity**, then **Numeric state**, and search for your TEMP-1B temperature probe, such as "temp-1b temperature probe". In the box labeled **Above**, type the maximum temperature you picked in step 2. Enter the value in the unit your Home Assistant shows (°F in this example). Advanced users can skip to the YAML at the end of this section.
-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.
+*Shown on a TEMP-1; pick your TEMP-1B entity instead.*
+
+6\. Click **Add Action**, type "iPhone", and select your phone. If you don't see your phone, or you have an Android phone, type "notify" instead and scroll down until you find your phone in the list.
-!!! tip "If you still do not see your device as shown in step 7 read this!"
+!!! tip "Still don't see your phone?"
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
+ You need the Home Assistant mobile app installed on your phone for this step to work. If you don't have it, use another kind of notification instead, such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
-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!".
+7\. Type in your message. If you want a title too, check the box for title and type it in. This example uses the message "The temperature probe on your TEMP-1B reached its max temperature and your freezer might be having issues." and the title "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!
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+8\. Click **Save** in the bottom right, then give the automation a name and, optionally, a description and a category.
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+You're done! Your phone now gets a notification whenever the freezer probe goes above your maximum.
+
---
-10\. YAML for Advanced Users
+**YAML for advanced users**
```yaml
alias: Freezer Over Max Temp Automation
@@ -54,7 +80,7 @@ description: Warning for the freezer when it reaches the max temperature.
triggers:
- trigger: numeric_state
entity_id:
- - number.apollo_temp_1b_max_probe_temp
+ - sensor.apollo_temp_1b_temperature_probe
above: 30
conditions: []
actions:
@@ -68,43 +94,53 @@ 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.
+Set up a Home Assistant automation that uses the food probe while you cook chicken (or anything else) to 165°F (73.9°C). At the end, you'll have an automation that sends your phone a notification when your food reaches that temperature.
-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.
+1\. Set your **Max Probe Temp** to 73.9°C. Max Probe Temp must be entered in Celsius, even if you use °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.
+2\. Once your food is on the grill, place the food probe inside it.
+
+!!! danger "Only the food probe goes on the grill"
+
+ Keep your TEMP-1B itself in a cool, dry place. Only the [food probe and its wire](../../addons/food-probe/) can withstand temperatures on a grill, in the oven, and similar places.
3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**.
[](https://my.home-assistant.io/redirect/automations/)
-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 food probe". In the box labeled **Above**, type the temperature you want for your food. This example uses 165°F (73.9°C), the temperature it's safe to cook chicken to. Enter the value in the unit your Home Assistant shows (°F in this example). Advanced users can skip to the YAML at the end of this section.
-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.
+*Shown on a TEMP-1; pick your TEMP-1B entity instead.*
+
+5\. Click **Add Action**, type "iPhone", and select your phone. If you don't see your phone, or you have an Android phone, type "notify" instead and scroll down until you find your phone in the list.
-!!! tip "If you still do not see your device as shown in step 7 read this!"
+!!! tip "Still don't see your phone?"
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
+ You need the Home Assistant mobile app installed on your phone for this step to work. If you don't have it, use another kind of notification instead, such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
-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!".
+6\. Type in your message. If you want a title too, check the box for title and type it in. This example uses the message "The temperature probe on your TEMP-1B reached its max temperature and your food is ready." and the title "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!
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+7\. Click **Save** in the bottom right, then give the automation a name and, optionally, a description and a category.
+You're done! Your phone now gets a notification when your food reaches its target temperature.
+
---
-8\. YAML for Advanced Users
+**YAML for advanced users**
```yaml
alias: Food Over Max Temp Automation
@@ -112,7 +148,7 @@ description: Warning for the food when it reaches the max temperature.
triggers:
- trigger: numeric_state
entity_id:
- - number.apollo_temp_1b_max_probe_temp
+ - sensor.apollo_temp_1b_food_probe
above: 165
conditions: []
actions:
@@ -125,11 +161,19 @@ 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!
+This example adds a button called "Chicken Monitor" to your dashboard, plus an automation that runs when you press it. While it runs, the RGB LED turns green. Your phone gets a message when monitoring starts, when the temperature is reached, and when monitoring finishes, and then the RGB LED turns off. Thanks to Discord user RalphP for this!
-1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper.
+The automation has three triggers, each with its own trigger ID, and one **Choose** action with an option for each trigger ID:
+
+* **Option 1 (Chicken Monitor On):** turns the RGB LED green and messages your phone.
+* **Option 2 (Temp Reached):** toggles the RGB LED until Chicken Monitor is turned off, messages your phone, and optionally speaks on your smart speakers.
+* **Option 3 (Chicken Monitor Off):** turns the RGB LED off and messages your phone.
+
+First, create the button.
+
+1\. Create a new toggle helper called "Chicken Monitor". For step-by-step directions, see creating a toggle helper.
@@ -137,118 +181,142 @@ This will guide you through adding a button to your dashboard called "Chicken Mo
+Next, create the automation and its three triggers.
+
3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**.
[](https://my.home-assistant.io/redirect/automations/)
-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.
+4\. Click **Add Trigger**, then **Entity**, then **State**, and search for "Chicken Monitor". In the box labeled **To**, select **On**.
-5\. Create a Trigger ID for this called "Chicken Monitor On".
+5\. Create a Trigger ID for this trigger 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".
+6\. Click **Add Trigger**, then **Entity**, then **State**, and search for "Chicken Monitor". In the box labeled **To**, select **Off**. Create a Trigger ID for this trigger 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.
+7\. Click **Add Trigger**, then **Entity**, then **Numeric state**, and search for your TEMP-1B food probe entity, such as "temp-1b food probe". In the box labeled **Above**, type the temperature you want for your food. This example uses 160°F (71.1°C), because the chicken will rest and reach 165°F once removed from the oven or grill.
-8\. Create a Trigger ID for this called "Temp Reached".
+*Shown on a TEMP-1; pick your TEMP-1B food probe instead.*
+
+8\. Create a Trigger ID for this trigger called "Temp Reached".
-9\. Click Add Action and search "choose" then select it.
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+Now add the **Choose** action. Option 1 runs when you turn Chicken Monitor on.
+
+9\. Click **Add Action**, search "choose", and select it.
-10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by.
+10\. Under **Option 1**, select **Add Condition**, search "trigger id", and select **Triggered by**.
-11\. Check off the option "Button Pressed" that we created in step 5 above.
+11\. Check **Chicken Monitor On**, the trigger ID you created in step 5.
-12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on.
+*The screenshot shows a trigger ID called Button Pressed. In your automation, check Chicken Monitor On.*
+
+12\. While still under **Option 1** in the Choose action, click **Add Action**, search "light", and select **Light: Turn on**.
-13\. Click choose entity then search for your device such as "Temp-1 RGB Light".
+13\. Click **Choose entity** and search for your device, such as "TEMP-1B 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.
+*Shown on a TEMP-1; pick your TEMP-1B RGB Light instead.*
+
+14\. Click **Advanced Options**, check the box for **Color name**, and 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.
+15\. While still under **Option 1** in the Choose action, click **Add Action**, search "mobile", and select your phone in the list.
-16\. Write in a custom title and/or message- the message is required but the title is not.
+16\. Write a custom title and 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:
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+17\. Check your work. When you're done with this part, Option 1 looks like this:
-18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by.
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+Option 2 runs when the food probe reaches your target temperature.
+
+18\. Click **Add Option** at the bottom. Under **Option 2**, select **Add Condition**, search "trigger id", and select **Triggered by**.
-19\. Check off the option "Temp Reached" that we created in step 7 above.
+19\. Check **Temp Reached**, the trigger ID you created in step 8.
-20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown.
+20\. While still under **Option 2** in the Choose action, click **Add Action**, search "repeat", and select **Until** in the dropdown.
-21\. Under Until Conditions, select "Add condition" then search "state".
+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.
+22\. Type in "Chicken Monitor" and select it, then select **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.
+23\. Click the **Add Action** button under the until condition you created. 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 the rgb led for your device
+24\. Search "light toggle" in the search bar, then select **Choose entity** and select 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.
+25\. Go down to **Add Action** under **Option 2**, search "mobile", and select your phone as you did 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 set up.
+26\. Optionally, add another action here that speaks 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.
-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.
+Option 3 runs when you turn Chicken Monitor off.
-28\. While still under Option 3 in the choose action: Click Add Action and search "light" then select Light: Turn off.
+27\. Click **Add Option** (this is now **Option 3**). Select **Add Condition**, search "triggered by", and then choose the "Chicken Monitor Off" trigger ID you created in step 6.
+
+28\. While still under **Option 3** in the Choose action, click **Add Action**, search "light", and select **Light: Turn off**.
-29\. Click choose entity then search for your device such as "Temp-1 RGB Light".
+29\. Click **Choose entity** and search for your device, such as "TEMP-1B 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.
+*Shown on a TEMP-1; pick your TEMP-1B RGB Light instead.*
+
+30\. Click **Add Action**, search "mobile" as you did above, and select your phone. Give it a message and, optionally, a title, as shown below.
-31\. Click save in the bottom right then give it a name and save
+31\. Click **Save** in the bottom right, then give the automation 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
+*Shown on a TEMP-1; the TEMP-1B steps are the same.*
+
+You now have one automation that ties together the button you created on your dashboard and alerts you when your chicken is almost done, with a phone notification, a blinking green LED, and an optional TTS notification on your smart speakers. Thanks again to Discord user RalphP for this example!
diff --git a/docs/products/temp1b/examples/use-cases.md b/docs/products/temp1b/examples/use-cases.md
index 8e5bc512c6..d0743cbf08 100755
--- a/docs/products/temp1b/examples/use-cases.md
+++ b/docs/products/temp1b/examples/use-cases.md
@@ -1,8 +1,8 @@
---
-title: TEMP-1B Use Cases
+title: TEMP-1B use cases
description: List of use cases for the TEMP-1B.
---
-# Use Cases for the TEMP-1B
+# Use cases for the TEMP-1B
1\. Monitoring fridge / freezer: There are settings to set the maximum temperature the sensor should reach. It can alert through the onboard buzzer if it rises above that temperature. The cable on the probe is flat to not interfere with fridge seals.
diff --git a/docs/products/temp1b/faq.md b/docs/products/temp1b/faq.md
index 9f6d9b39da..af903b3abf 100755
--- a/docs/products/temp1b/faq.md
+++ b/docs/products/temp1b/faq.md
@@ -22,13 +22,13 @@ description: Frequently asked questions about the TEMP-1B temperature sensor.
5\. **What are the Optional Probe Addons?**
-* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
-* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
-* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 204°C (400°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
+* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
+* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
+* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC): Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
6\. **Is the TEMP-1B weatherproof? Can I use it outdoors?**
-* The TEMP-1B is primarily designed for indoor use, but components like the waterproof soil probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection.
+* The TEMP-1B is primarily designed for indoor use, but the waterproof DS18B20 temperature probes are suited for harsh conditions. The main body is not rated for outdoor use without additional protection.
7\. **How does the TEMP-1B connect to Home Assistant?**
@@ -44,7 +44,7 @@ description: Frequently asked questions about the TEMP-1B temperature sensor.
10\. **What are the RGB LED and piezo buzzer used for?**
-* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure.
+* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like a probe temperature going above or below the range you set.
11\. **Is the TEMP-1B compatible with other smart home platforms?**
@@ -60,11 +60,11 @@ description: Frequently asked questions about the TEMP-1B temperature sensor.
14\. **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 1 amp or less (5W). They both have all of the same components for measuring soil moisture, air temp/humidity, lux/uv, etc.
+* The TEMP-1B runs on a 16340 battery (or USB-C) and is slightly larger, while the non-battery TEMP-1 is compact and requires USB-C power at 5 volts using 1 amp or less (5W). They both have the same AHT20 air temperature/humidity sensor, RGB LED, piezo buzzer, and 3.5mm probe port.
15\. **Can I use multiple TEMP-1B sensors in one Home Assistant setup?**
-* Yes, you can add multiple TEMP-1B sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces.
+* Yes, you can add multiple TEMP-1B sensors, each appearing as a separate device, for comprehensive monitoring across multiple fridges, freezers, rooms, or other spaces.
16\. **Can I use an extender to make the TEMP-1 temp probe cable longer?**
diff --git a/docs/products/temp1b/introduction.md b/docs/products/temp1b/introduction.md
index d6e7804a7f..7dadc569af 100755
--- a/docs/products/temp1b/introduction.md
+++ b/docs/products/temp1b/introduction.md
@@ -4,13 +4,13 @@ description: Documentation for TEMP-1B, including setup, usage, and best practic
---
-The TEMP-1B (16340 battery) can be used with an optional temperature probe which comes in two lengths or a food safe grill probe. The TEMP-1B itself can be used with an optional magnetic mount to mount it to a fridge, grill, or other surface while taking measurements. It also features an AHT20-F air temperature and humidity sensor, which includes dust protection, an RGB LED, a piezo buzzer, and an optional DS18b20 waterproof soil temperature probe (20 cm / 7.8 inches).
+The TEMP-1B (16340 battery) can be used with an optional temperature probe which comes in two lengths or a food safe grill probe. The TEMP-1B itself can be used with an optional magnetic mount to mount it to a fridge, grill, or other surface while taking measurements. It also features an AHT20-F air temperature and humidity sensor, which includes dust protection, an RGB LED, and a piezo buzzer.
**Optional Probe Addons:**
-* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
-* 20cm (~8in) Waterproof Flat Cable (DS18B20) – -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
-* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC) – Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
+* 1\.5m (~5ft) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy. Ideal for fridges, freezers, fish tanks etc.
+* 20cm (~8in) Waterproof Flat Cable (DS18B20): -55°C to 85°C (-67°F to 185°F), ±0.5°C accuracy.
+* 1m (~3ft) Stainless Steel Food-Safe Probe (NTC): Max 350°C (662°F). Perfect for grilling, baking, and food prep (not dishwasher safe).
!!! danger "Do not leave your sensor outside or let it get wet!"
diff --git a/docs/products/temp1b/reviews.md b/docs/products/temp1b/reviews.md
index 0d5b9bfbfe..82fd55e6cd 100755
--- a/docs/products/temp1b/reviews.md
+++ b/docs/products/temp1b/reviews.md
@@ -1,5 +1,5 @@
---
-title: TEMP-1B Reviews
+title: TEMP-1B reviews
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/products/temp1b/setup/insert-battery.md b/docs/products/temp1b/setup/insert-battery.md
index c9fe61ad18..d1b3ed958c 100755
--- a/docs/products/temp1b/setup/insert-battery.md
+++ b/docs/products/temp1b/setup/insert-battery.md
@@ -1,13 +1,15 @@
---
-title: How to Insert Battery on TEMP-1B
+title: How to insert battery on TEMP-1B
description: How to Insert Battery on TEMP-1B.
---
-# How to Insert the Battery
+# How to insert the battery
!!! info "16340 AKA RC-CR123A and charger required!"
The TEMP-1B is a very neat sensor but it does *NOT* include a battery nor a charging circuit. You will have to buy your own rechargeable RC-CR123A aka 16340 battery and also a separate 16340 charger such as a Nitecore 2 or 4bay model.
+You'll open the case, insert the battery with the positive terminal facing the + sign, and close the lid again.
+
1\. Gently pry open the case lid as shown in the image below.
diff --git a/docs/products/temp1b/setup/temp1b-sensor-definitions.md b/docs/products/temp1b/setup/temp1b-sensor-definitions.md
index 90ac3bb671..26832924ca 100755
--- a/docs/products/temp1b/setup/temp1b-sensor-definitions.md
+++ b/docs/products/temp1b/setup/temp1b-sensor-definitions.md
@@ -1,8 +1,8 @@
---
-title: TEMP-1B Sensor Definitions
+title: TEMP-1B sensor definitions
description: Full list of definitions for the TEMP-1B and its various sensors.
---
-# Sensor Definitions
+# Sensor definitions
Once added to Home Assistant you can configure different settings for your TEMP-1B. Use the tabs below to see what each entity does, grouped the same way Home Assistant displays them.
@@ -10,7 +10,7 @@ Once added to Home Assistant you can configure different settings for your TEMP-
The **Default Update** column is how often each entity refreshes while the TEMP-1B is awake. The TEMP-1B runs on a battery, and by default **Prevent Sleep** is on, so it stays awake and reports continuously at these intervals (which drains the battery). Turn **Prevent Sleep** off to let it deep-sleep between readings and conserve the battery: it wakes, reports, then sleeps for the **Sleep Duration** before waking again.
- To update firmware on a sleeping device, just click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand.
+ To update firmware on a sleeping device, click **Update** on the **Firmware Update** entity and it installs the next time the device wakes (the firmware keeps itself awake until the update finishes, so you don't need to do anything else). The optional [OTA helper](https://wiki.apolloautomation.com/products/general/battery-sensors/awake-ha-helper/) is a separate toggle that overrides **Prevent Sleep** to keep a device awake on demand.
=== "Controls"
diff --git a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md
index df52384215..2a1f773bcb 100755
--- a/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md
+++ b/docs/products/temp1b/troubleshooting/temp1b-boot-mode.md
@@ -1,14 +1,16 @@
---
-title: Putting The TEMP-1B In Boot Mode
+title: Putting the TEMP-1B in boot mode
description: Step by step guide for putting The TEMP-1B In Boot Mode.
---
-# Putting The TEMP-1B In Boot Mode
+# Putting the TEMP-1B in boot mode
!!! info "This will cover how to put the TEMP-1B into 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
+
+You'll hold the boot button while you plug in the USB-C cable.
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 +26,9 @@ 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
+
+You'll open the case and use the boot and reset buttons together while the device is plugged into your computer.
1\. Unplug the device and remove the case as shown in the images above
diff --git a/docs/products/temp1b/troubleshooting/temp1b-code.md b/docs/products/temp1b/troubleshooting/temp1b-code.md
index a288e8f80d..c830b7fd7a 100755
--- a/docs/products/temp1b/troubleshooting/temp1b-code.md
+++ b/docs/products/temp1b/troubleshooting/temp1b-code.md
@@ -1,8 +1,8 @@
---
-title: Factory Re-Flash TEMP-1B
+title: Factory re-flash TEMP-1B
description: Step by step guide for re-flashing the TEMP-1B back to factory firmware.
---
-# Factory Re-Flash TEMP-1B
+# Factory re-flash TEMP-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."
@@ -10,6 +10,8 @@ description: Step by step guide for re-flashing the TEMP-1B back to factory firm
If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing.
+Follow these steps to put your device in boot mode and install the factory firmware.
+
1\. 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 TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/)
diff --git a/docs/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md b/docs/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
index 88557bd060..146eb170b7 100755
--- a/docs/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
+++ b/docs/products/temp1b/troubleshooting/temp1b-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials
+title: Reset Wi-Fi credentials
description: Step by step guide for resetting the Wi-Fi Credentials on your TEMP-1B.
---
-# Reset Wi-Fi Credentials on your TEMP-1B
+# Reset Wi-Fi credentials on your TEMP-1B
+
+You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot.
1\. Plug the device into power.
@@ -12,4 +14,4 @@ description: Step by step guide for resetting the Wi-Fi Credentials on your TEMP
3\. The Wi-Fi credentials should be reset and it will broadcast its hotspot again.
-4\. Connect to the hotspot titled "Apollo TEMP-1 Hotspot" and enter your new Wi-Fi details!
\ No newline at end of file
+4\. Connect to the hotspot titled "Apollo TEMP1B Hotspot" and enter your new Wi-Fi details!
\ No newline at end of file
diff --git a/docs/products/temp1b/troubleshooting/temp1b-teardown.md b/docs/products/temp1b/troubleshooting/temp1b-teardown.md
index dfa62222be..34c2e67828 100755
--- a/docs/products/temp1b/troubleshooting/temp1b-teardown.md
+++ b/docs/products/temp1b/troubleshooting/temp1b-teardown.md
@@ -1,8 +1,10 @@
---
-title: TEMP-1B Teardown
+title: TEMP-1B teardown
description: Step by step guide for tearing down your TEMP-1B to replace parts, clean it, swap cases, etc.
---
-# Teardown Of TEMP-1B
+# Teardown of TEMP-1B
+
+You'll pry open the case lid and take the board out, so you can replace parts, clean it, or swap cases.
1\. Gently pry open the case lid as shown in the image below.
diff --git a/docs/products/temppro1/addons/temp-humidity-probe.md b/docs/products/temppro1/addons/temp-humidity-probe.md
index bd1ef75e83..1aba2db85d 100755
--- a/docs/products/temppro1/addons/temp-humidity-probe.md
+++ b/docs/products/temppro1/addons/temp-humidity-probe.md
@@ -1,14 +1,14 @@
---
-title: TEMP Pro-1 Temp and Humidity Probe Guide
+title: TEMP Pro-1 temp and humidity probe guide
description: >-
Step by step guide for installing and using the optional Temp and Humidity
Probe with the TEMP Pro-1.
---
-# TEMP Pro-1 Temp and Humidity Probe (SHT20)
+# TEMP Pro-1 temp and humidity probe (SHT20)
The TEMP Pro-1 comes with an optional temp and humidity probe which can be used to monitor an attic, fridge, freezer, fish tank, pool, hot tub, etc. It includes a protected cable but the TEMP Pro-1 itself needs to stay in a cool environment.
-1\. To use your temp and humidity probe simply take it out of the package and insert it into the right 3.5mm port on your TEMP Pro-1.
+1\. To use your temp and humidity probe, take it out of the package and insert it into the right 3.5mm port on your TEMP Pro-1.
diff --git a/docs/products/temppro1/addons/temp-probe.md b/docs/products/temppro1/addons/temp-probe.md
index bbd56b0a2e..5bde7a3868 100755
--- a/docs/products/temppro1/addons/temp-probe.md
+++ b/docs/products/temppro1/addons/temp-probe.md
@@ -1,14 +1,14 @@
---
-title: TEMP Pro-1 Temp Probe Guide
+title: TEMP Pro-1 temp probe guide
description: >-
Step by step guide for installing and using the optional Temp Probe with the
TEMP Pro-1.
---
-# TEMP Pro-1 Temp Probe
+# TEMP Pro-1 temp probe
The TEMP Pro-1 comes with an optional temp probe which can be used to monitor a fridge, freezer, fish tank, pool, hot tub, etc. It includes a protected cable but the TEMP Pro-1 itself needs to stay in a cool environment.
-1\. To use your temp probe simply take it out of the package and insert it into the left 3.5mm port on your TEMP Pro-1.
+1\. To use your temp probe, take it out of the package and insert it into the left 3.5mm port on your TEMP Pro-1.
diff --git a/docs/products/temppro1/examples/temp1-alert-example.md b/docs/products/temppro1/examples/temp1-alert-example.md
index 4c3e4b4b8d..640d7cdb08 100755
--- a/docs/products/temppro1/examples/temp1-alert-example.md
+++ b/docs/products/temppro1/examples/temp1-alert-example.md
@@ -1,23 +1,29 @@
---
-title: TEMP-1 Alert Outside Temp Range Example
-description: Step by step guide for alerting outside the set range with the TEMP-1.
+title: TEMP-1 alert outside temp range example
+description: Step-by-step guide to setting up the TEMP-1's built-in alarm so its buzzer sounds when the probe temperature goes outside the range you set.
---
-# TEMP-1 Alert Outside Temp Range Example
+# TEMP-1 alert outside temp range example
-######
+Difficulty: Level 1
-This will guide you through how to set up the built in alarm using the temperature probe in your freezer!
+!!! note "Written for the TEMP-1"
-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.
+ This example was written for the Apollo TEMP-1, and its steps and screenshots show a TEMP-1. The [TEMP Pro-1 sensor definitions](../../setup/temp-pro-1-sensor-definitions/) list the same **Max Probe Temp**, **Min Probe Temp**, and **Alarm Outside Temp Range** settings, so you can follow along with your TEMP Pro-1.
-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.
+Set up the built-in alarm so your TEMP-1 sounds its buzzer when the temperature probe in your freezer reads outside the range you choose. You'll pick a range from the probe's readings, enter it on the device, and turn the alarm on.
+
+1\. Place the temperature probe into your freezer, then wait for its reading to settle around 0°F (-18°C). Only the probe goes in the freezer, not the entire TEMP-1.
+
+2\. Once the reading settles, look at the graph and pick a good value for both the maximum and the minimum temperature. In this example, the mini freezer seems to max out at 30°F, so the maximum goes slightly above that. However, most freezers should not reach above 0°F, so you'll likely need a lower maximum than this one. The minimums here 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 2C and a min probe temp of -30C. Reminder, yours will likely be different values, especially your max probe temp.
+3\. Convert your maximum and minimum from °F to °C, then enter them in **Max Probe Temp** and **Min Probe Temp**. Both settings are measured in Celsius. This example uses a max probe temp of 2°C and a min probe temp of -30°C. Your values will likely be different, especially your max probe temp.
-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
+4\. Turn on the **Alarm Outside Temp Range** toggle. Your TEMP-1 now plays an audible alert with its buzzer when the temperature thresholds are reached: if the temperature goes under the min or over the max, the alarm goes off.
+
+
-
\ No newline at end of file
+Your freezer alarm is set. The next time the probe reads outside your range, the TEMP-1 lets you know with its buzzer.
diff --git a/docs/products/temppro1/examples/temp1-automation-examples.md b/docs/products/temppro1/examples/temp1-automation-examples.md
index 938327c916..f3660e7e42 100755
--- a/docs/products/temppro1/examples/temp1-automation-examples.md
+++ b/docs/products/temppro1/examples/temp1-automation-examples.md
@@ -1,50 +1,72 @@
---
-title: TEMP-1 Automation Examples
-description: Multiple automation examples with the TEMP-1.
+title: Automation examples using a TEMP-1
+description: Three Home Assistant automations for the TEMP-1, from a freezer alert to a chicken monitor that blinks the RGB LED and messages your phone when your food is almost done.
---
-# Automation Examples using a TEMP-1
+# Automation examples using a TEMP-1
-## Freezer Temperature Probe Example
+Difficulty: Level 2
-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.
+
+ TEMP-1B Alert Outside Temp Range Example
+ Difficulty: Level 1
+
+🌱 New here? Try these first:
+
+
-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.
+!!! note "Written for the TEMP-1"
-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.
+ This page was written for the Apollo TEMP-1. Every step, screenshot, and YAML example uses a TEMP-1 and its entity names. Before you follow along with a TEMP Pro-1, check the [TEMP Pro-1 sensor definitions](../../setup/temp-pro-1-sensor-definitions/) to see which of these sensors and settings your TEMP Pro-1 has.
+
+Your TEMP-1's probes can drive Home Assistant automations. This page walks you through three of them: a freezer alert, a food probe alert, and a chicken monitor you start and stop from your dashboard.
+
+## Freezer temperature probe example
+
+Set up a Home Assistant automation that uses the temperature probe in your freezer. At the end, you'll have an automation that sends your phone a notification when the probe goes above your maximum temperature.
+
+1\. Place the temperature probe into your freezer, then wait for its reading to settle around 0°F (-18°C).
+
+!!! danger "Only the probe goes in the freezer"
+
+ Keep your TEMP-1 itself in a cool, dry place. Only the temp probe and its wire can withstand the temperatures in a fridge, freezer, and similar places.
+
+2\. Once the reading settles, look at the graph and pick a good value for both the maximum and the minimum temperature. In this example, the mini freezer seems to max out at 30°F, so the maximum goes slightly above that. However, most freezers should not reach above 0°F, so you'll likely need a lower maximum than this one. The minimums here 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.
+3\. Convert your maximum and minimum from °F to °C, then enter them in **Max Probe Temp** and **Min Probe Temp**. Both settings are measured in Celsius. This example uses a max probe temp of 2°C and a min probe temp of -30°C. Your values will likely be different, especially your max probe temp.
-4\. The automation is now ready to be created -
+With your thresholds set, the automation is now ready to be created.
-5\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there!
+4\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. Shortcut: go straight to a new automation (works if you reach Home Assistant at homeassistant.local).
-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.
+5\. Click **Add Trigger**, then **Entity**, then **Numeric state**, and search for your TEMP-1 probe sensor, such as "temp-1 temperature probe". In the box labeled **Above**, type the maximum temperature you picked in step 2. Advanced users can skip to the YAML at the end of this section.
-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.
+6\. Click **Add Action**, type "iPhone", and select your phone. If you don't see your phone, or you have an Android phone, type "notify" instead and scroll down until you find your phone in the list.
-!!! tip "If you still do not see your device as shown in step 7 read this!"
+!!! tip "Still don't see your phone?"
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
+ You need the Home Assistant mobile app installed on your phone for this step to work. If you don't have it, use another kind of notification instead, such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
-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!".
+7\. Type in your message. If you want a title too, check the box for title and type it in. This example uses the message "The temperature probe on your TEMP-1 reached its max temperature and your freezer might be having issues." and the title "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!
+8\. Click **Save** in the bottom right, then give the automation a name and, optionally, a description and a category.
+You're done! Your phone now gets a notification whenever the freezer probe goes above your maximum.
+
---
-10\. YAML for Advanced Users
+**YAML for advanced users**
```yaml
alias: Freezer Over Max Temp Automation
@@ -52,7 +74,8 @@ description: Warning for the freezer when it reaches the max temperature.
triggers:
- trigger: numeric_state
entity_id:
- - number.apollo_temp_1_max_probe_temp
+ - sensor.apollo_temp_1_temperature_probe
+ # in the unit Home Assistant shows for the probe (°F here); use your own entity ID
above: 30
conditions: []
actions:
@@ -66,41 +89,47 @@ 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.
+Set up a Home Assistant automation that uses the food probe while you cook chicken (or anything else) to 165°F (73.9°C). At the end, you'll have an automation that sends your phone a notification when your food reaches that temperature.
-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.
+1\. Set your **Max Probe Temp** to 73.9°C. Max Probe Temp is always set in Celsius, even if you use °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.
+2\. Once your food is on the grill, place the food probe inside it.
+
+!!! danger "Only the food probe goes on the grill"
+
+ Keep your TEMP-1 itself in a cool, dry place. Only the food probe and its wire can withstand temperatures on a grill, in the oven, and similar places.
-3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left. Click here to go straight there!
+3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. Shortcut: go straight to a new automation (works if you reach Home Assistant at homeassistant.local).
-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 food probe sensor, such as "temp-1 food probe". In the box labeled **Above**, type the temperature you want for your food. This example uses 165°F (73.9°C), the temperature it's safe to cook chicken to. Advanced users can skip to the YAML at the end of this section.
-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**, type "iPhone", and select your phone. If you don't see your phone, or you have an Android phone, type "notify" instead and scroll down until you find your phone in the list.
-!!! tip "If you still do not see your device as shown in step 7 read this!"
+!!! tip "Still don't see your phone?"
- You need the Home Assistant mobile app installed on your phone for this step to work! If you do not have it, try another notification instead of using your phone such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
+ You need the Home Assistant mobile app installed on your phone for this step to work. If you don't have it, use another kind of notification instead, such as a TTS notification on your speakers. This could be a fun way to announce that dinner is ready!
-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!".
+6\. Type in your message. If you want a title too, check the box for title and type it in. This example uses the message "The temperature probe on your TEMP-1 reached its max temperature and your food is ready." and the title "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!
+7\. Click **Save** in the bottom right, then give the automation a name and, optionally, a description and a category.
+You're done! Your phone now gets a notification when your food reaches its target temperature.
+
---
-8\. YAML for Advanced Users
+**YAML for advanced users**
```yaml
alias: Food Over Max Temp Automation
@@ -108,7 +137,8 @@ description: Warning for the food when it reaches the max temperature.
triggers:
- trigger: numeric_state
entity_id:
- - number.apollo_temp_1_max_probe_temp
+ - sensor.apollo_temp_1_food_probe
+ # in the unit Home Assistant shows for the probe (°F here); use your own entity ID
above: 165
conditions: []
actions:
@@ -121,11 +151,19 @@ actions:
mode: single
```
-## Cook Chicken Example
+## Cook chicken example
+
+This example adds a button called "Chicken Monitor" to your dashboard, plus an automation that runs when you press it. While it runs, the RGB LED turns green. Your phone gets a message when monitoring starts, when the temperature is reached, and when monitoring finishes, and then the RGB LED turns off. Thanks to Discord user RalphP for this!
+
+The automation has three triggers, each with its own trigger ID, and one **Choose** action with an option for each trigger ID:
-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!
+* **Option 1 (Chicken Monitor On):** turns the RGB LED green and messages your phone.
+* **Option 2 (Temp Reached):** toggles the RGB LED until Chicken Monitor is turned off, messages your phone, and optionally speaks on your smart speakers.
+* **Option 3 (Chicken Monitor Off):** turns the RGB LED off and messages your phone.
-1\. Create a new toggle helper called "Chicken Monitor". Please click here for step by step directions on creating a toggle helper.
+First, create the button.
+
+1\. Create a new toggle helper called "Chicken Monitor". For step-by-step directions, see creating a toggle helper.
@@ -133,116 +171,122 @@ This will guide you through adding a button to your dashboard called "Chicken Mo
-3\. Click Settings -> Automations & scenes -> click Create Automation in the bottom left then "create new automation". Click here to go straight there!
+Next, create the automation and its three triggers.
+
+3\. Go to **Settings → Automations & scenes**, click **+ Create automation** in the bottom right, then **Create new automation**. Shortcut: go straight to a new automation (works if you reach Home Assistant at homeassistant.local).
-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.
+4\. Click **Add Trigger**, then **Entity**, then **State**, and search for "Chicken Monitor". In the box labeled **To**, select **On**.
-5\. Create a Trigger ID for this called "Chicken Monitor On".
+5\. Create a Trigger ID for this trigger 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".
+6\. Click **Add Trigger**, then **Entity**, then **State**, and search for "Chicken Monitor". In the box labeled **To**, select **Off**. Create a Trigger ID for this trigger 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.
+7\. Click **Add Trigger**, then **Entity**, then **Numeric state**, and search for your TEMP-1 food probe entity, such as "temp-1 food probe". In the box labeled **Above**, type the temperature you want for your food. This example uses 160°F (71.1°C), because the chicken will rest and reach 165°F once removed from the oven or grill.
-8\. Create a Trigger ID for this called "Temp Reached".
+8\. Create a Trigger ID for this trigger called "Temp Reached".
-9\. Click Add Action and search "choose" then select it.
+Now add the **Choose** action. Option 1 runs when you turn Chicken Monitor on.
+
+9\. Click **Add Action**, search "choose", and select it.
-10\. Under option 1 select "Add Condition" then search "trigger id" and select Triggered by.
+10\. Under **Option 1**, select **Add Condition**, search "trigger id", and select **Triggered by**.
-11\. Check off the option "Button Pressed" that we created in step 5 above.
-
-
+11\. Check **Chicken Monitor On**, the trigger ID you created in step 5.
-12\. While still under Option 1 in the choose action: Click Add Action and search "light" then select Light: Turn on.
+12\. While still under **Option 1** in the Choose action, click **Add Action**, search "light", and select **Light: Turn on**.
-13\. Click choose entity then search for your device such as "Temp-1 RGB Light".
+13\. Click **Choose entity** and 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.
+14\. Click **Advanced Options**, check the box for **Color name**, and 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.
+15\. While still under **Option 1** in the Choose action, click **Add Action**, search "mobile", and select your phone in the list.
-16\. Write in a custom title and/or message- the message is required but the title is not.
+16\. Write a custom title and 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:
+17\. Check your work. When you're done with this part, Option 1 looks like this:
-18\. Click "Add Option" at the bottom then under option 2 select "Add Condition" then search "trigger id" and select Triggered by.
+Option 2 runs when the food probe reaches your target temperature.
+
+18\. Click **Add Option** at the bottom. Under **Option 2**, select **Add Condition**, search "trigger id", and select **Triggered by**.
-19\. Check off the option "Temp Reached" that we created in step 7 above.
+19\. Check **Temp Reached**, the trigger ID you created in step 8.
-20\. While still under Option 2 in the choose action: Click Add Action and search "repeat" then select "Until" in the dropdown.
+20\. While still under **Option 2** in the Choose action, click **Add Action**, search "repeat", and select **Until** in the dropdown.
-21\. Under Until Conditions, select "Add condition" then search "state".
+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.
+22\. Type in "Chicken Monitor" and select it, then select **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.
+23\. Click the **Add Action** button under the until condition you created. 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 the rgb led for your device
+24\. Search "light toggle" in the search bar, then select **Choose entity** and select 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.
+25\. Go down to **Add Action** under **Option 2**, search "mobile", and select your phone as you did 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 set up.
+26\. Optionally, add another action here that speaks 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.
-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.
+Option 3 runs when you turn Chicken Monitor off.
+
+27\. Click **Add Option** (this is now **Option 3**). Select **Add Condition**, search "triggered by", and then choose the "Chicken Monitor Off" trigger ID you 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.
+28\. While still under **Option 3** in the Choose action, click **Add Action**, search "light", and select **Light: Turn off**.
-29\. Click choose entity then search for your device such as "Temp-1 RGB Light".
+29\. Click **Choose entity** and 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.
+30\. Click **Add Action**, search "mobile" as you did above, and select your phone. Give it a message and, optionally, a title, as shown below.
-31\. Click save in the bottom right then give it a name and save
+31\. Click **Save** in the bottom right, then give the automation 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
+You now have one automation that ties together the button you created on your dashboard and alerts you when your chicken is almost done, with a phone notification, a blinking green LED, and an optional TTS notification on your smart speakers. Thanks again to Discord user RalphP for this example!
diff --git a/docs/products/temppro1/examples/use-cases.md b/docs/products/temppro1/examples/use-cases.md
index c94a328a34..ed7e90d571 100755
--- a/docs/products/temppro1/examples/use-cases.md
+++ b/docs/products/temppro1/examples/use-cases.md
@@ -1,11 +1,11 @@
---
-title: TEMP Pro-1 Use Cases
+title: TEMP Pro-1 use cases
description: List of use cases for the TEMP Pro-1.
---
-# Use Cases for the TEMP Pro-1
+# Use cases for the TEMP Pro-1
1\. Monitoring fridge / freezer: There are settings to set the maximum temperature the sensor should reach. It can alert through the onboard buzzer if it rises above that temperature. The cable on the probe is flat which should not interfere with fridge seals.
2\. Monitoring fish tank, hot tub ( if covered ), pool ( if covered or in sealed box ) with the waterproof probe.
-3\. Monitoring an attic by putting the TEMP Pro-1 in a waterproof enclosure or just poking a hole to feed a temp probe into an attic or other environment not suitable for the TEMP Pro-1 PCB itself.
\ No newline at end of file
+3\. Monitoring an attic by putting the TEMP Pro-1 in a waterproof enclosure or poking a hole to feed a temp probe into an attic or other environment not suitable for the TEMP Pro-1 PCB itself.
\ No newline at end of file
diff --git a/docs/products/temppro1/faq.md b/docs/products/temppro1/faq.md
index f92cae7501..0740171ac7 100755
--- a/docs/products/temppro1/faq.md
+++ b/docs/products/temppro1/faq.md
@@ -19,38 +19,38 @@ description: Frequently asked questions about the TEMP Pro-1 temperature sensor.
* You can add the GPIO header and SCD40 CO2 sensor with the two mezzanine ports. It also includes a Sensirion port for a SEN55 and SEN6x, a QWIIC port and a DfRobot port.
-3\. **Is the TEMP Pro-1 weatherproof? Can I use it outdoors?**
+4\. **Is the TEMP Pro-1 weatherproof? Can I use it outdoors?**
* The TEMP Pro-1 is primarily designed for indoor use, but components like the waterproof temp probe are suited for harsh conditions. The main body is not rated for outdoor use without additional protection.
-4\. **How does the TEMP Pro-1 connect to Home Assistant?**
+5\. **How does the TEMP Pro-1 connect to Home Assistant?**
* The TEMP Pro-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 Pro-1 send sensor data?**
+6\. **How often does the TEMP Pro-1 send sensor data?**
* The TEMP Pro-1 reporting frequency is adjustable in ESPHome but most things default to 60 seconds.
-6\. **Can I customize the TEMP Pro-1 functionality?**
+7\. **Can I customize the TEMP Pro-1 functionality?**
-* Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the TEMP Pro-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 Pro-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?**
+8\. **What are the RGB LED and piezo buzzer used for?**
-* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like low moisture levels or high UV exposure.
+* The RGB LED provides visual alerts, while the piezo buzzer offers audio notifications for events like the temperature or humidity going outside the Min/Max range you set (turn on Alarm Outside Temp Range or Alarm Outside Humidity Range).
-8\. **Is the TEMP Pro-1 compatible with other smart home platforms?**
+9\. **Is the TEMP Pro-1 compatible with other smart home platforms?**
* While designed for Home Assistant via ESPHome, it may be compatible with other platforms using the ESPHome API or MQTT.
-9\. **Do I need coding knowledge to use the TEMP Pro-1?**
+10\. **Do I need coding knowledge to use the TEMP Pro-1?**
* Basic knowledge of Home Assistant and ESPHome is helpful, but most users can utilize it out of the box. For advanced customization, YAML knowledge is recommended.
-10\. **Can I access data from the TEMP Pro-1 remotely?**
+11\. **Can I access data from the TEMP Pro-1 remotely?**
* Yes, you can access sensor data remotely via the Home Assistant dashboard if your setup is configured for remote access.
-11\. **Can I use multiple TEMP Pro-1 sensors in one Home Assistant setup?**
+12\. **Can I use multiple TEMP Pro-1 sensors in one Home Assistant setup?**
-* Yes, you can add multiple TEMP Pro-1 sensors, each appearing as a separate device, for comprehensive monitoring across multiple plants or spaces.
\ No newline at end of file
+* Yes, you can add multiple TEMP Pro-1 sensors, each appearing as a separate device, for comprehensive monitoring across multiple rooms, fridges, or spaces.
\ No newline at end of file
diff --git a/docs/products/temppro1/reviews.md b/docs/products/temppro1/reviews.md
index 0a84601755..30e877bf37 100755
--- a/docs/products/temppro1/reviews.md
+++ b/docs/products/temppro1/reviews.md
@@ -1,5 +1,5 @@
---
-title: TEMP Pro-1 Reviews
+title: TEMP Pro-1 reviews
description: YouTuber reviews and feedback about the TEMP Pro-1 sensor from Apollo Automation.
---
diff --git a/docs/products/temppro1/setup/temp-pro-1-sensor-definitions.md b/docs/products/temppro1/setup/temp-pro-1-sensor-definitions.md
index f93d5191db..8d5029a1cf 100755
--- a/docs/products/temppro1/setup/temp-pro-1-sensor-definitions.md
+++ b/docs/products/temppro1/setup/temp-pro-1-sensor-definitions.md
@@ -1,10 +1,10 @@
---
-title: TEMP Pro-1 Sensor Definitions
+title: TEMP Pro-1 sensor definitions
description: >-
Full list of definitions for the TEMP Pro-1 and its various sensors and
available ports.
---
-# TEMP Pro-1 Sensor Definitions
+# TEMP Pro-1 sensor definitions
Once added to Home Assistant you can configure different settings for your sensor. Below is what each setting does.
@@ -22,7 +22,7 @@ Once added to Home Assistant you can configure different settings for your senso
**RGB Light**
- * One RGB Neopixel LED. Click on the light bulb or color wheel to change the color. Click on the toggle to turn on or off.
+ * Four RGB LEDs. Click on the light bulb or color wheel to change the color. Click on the toggle to turn on or off.
???+ info "Sensors"
@@ -34,10 +34,6 @@ Once added to Home Assistant you can configure different settings for your senso
* Measures and reports the current temperature of the board.
- **Food Probe**
-
- * The stainless steel food-safe probe is designed for accurate temperature monitoring during grilling, baking, and other food-related activities. Its durable, non-corrosive construction ensures safe and reliable use for cooking, providing real-time temperature readings to help achieve perfect results.
-
**Temperature Probe**
* The temperature sensor probe, offered in both long and short options, is ideal for monitoring fridge/freezer temperatures and aquatic environments like fish tanks, hot tubs, and covered pools. Its flat cable prevents interference with fridge seals, and it includes a customizable temperature threshold with an onboard buzzer to alert when the limit is exceeded.
@@ -46,24 +42,20 @@ Once added to Home Assistant you can configure different settings for your senso
**Board Humidity Offset**
- * Offset for Board Humidity - values between 0-100%
+ * Offset for Board Humidity: values between 0-100%
**Board Temperature Offset**
- * Offset for Board Temperature - values in Celsius.
+ * Offset for Board Temperature: values in Celsius.
**ESP Reboot**
- * Button to press which reboots your TEMP-1.
+ * Button to press which reboots your TEMP Pro-1.
**Firmware Update**
* Indicates whether an update is available or if you are Up-to-date.
- **Food Probe Offset**
-
- * Offset for the Food Probe's temperature readings. Measured in Celsius.
-
**Max Probe Temp**
* Max Temperature threshold used for the *Alarm Outside Temp Range* toggle.
@@ -79,7 +71,7 @@ Once added to Home Assistant you can configure different settings for your senso
**Prevent Sleep**
- * Prevents the TEMP-1 from going to sleep. When sleeping, your TEMP-1 will NOT respond to Home Assistant it is effectively off until it wakes up again.
+ * Prevents the TEMP Pro-1 from going to sleep. When sleeping, your TEMP Pro-1 will NOT respond to Home Assistant it is effectively off until it wakes up again.
* Click on the toggle to turn on or off. Defaults to ON.
**Probe Temp Difference Threshold**
diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md
index ec6f4c6b30..f369a42d02 100755
--- a/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md
+++ b/docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md
@@ -1,14 +1,16 @@
---
-title: Putting The TEMP Pro-1 In Boot Mode
+title: Putting the TEMP Pro-1 in boot mode
description: Step by step guide for putting The TEMP Pro-1 In Boot Mode.
---
-# Putting The TEMP Pro-1 In Boot Mode
+# Putting the TEMP Pro-1 in boot mode
!!! info "This will cover how to put the TEMP Pro-1 into 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
+
+You'll remove the lid, then hold the boot button while you plug in the USB-C cable.
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.
@@ -20,9 +22,11 @@ description: Step by step guide for putting The TEMP Pro-1 In Boot Mode.
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.
-3\. Continue with [uploading the firmware document](https://wiki.apolloautomation.com/products/temppro1/troubleshooting/temp-pro1-code/).
+4\. 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
+You'll open the case and use the boot and reset buttons together while the device is plugged into your computer.
1\. Unplug the device and remove the case as shown in the images above
diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-code.md b/docs/products/temppro1/troubleshooting/temp-pro1-code.md
index ba2e70174e..27d3f4ae31 100755
--- a/docs/products/temppro1/troubleshooting/temp-pro1-code.md
+++ b/docs/products/temppro1/troubleshooting/temp-pro1-code.md
@@ -1,41 +1,43 @@
---
-title: Factory Re-Flash TEMP Pro-1
-description: Step by step guide for re-flashing the TEMP Pro-1 back to factory firmware.
+title: Factory re-flash TEMP Pro-1
+description: Step-by-step guide to re-flashing the TEMP Pro-1 back to its factory firmware from Chrome, Edge, or another Chromium-based browser.
---
-# Factory Re-Flash TEMP Pro-1
+# Factory re-flash TEMP Pro-1
-!!! 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."
+If your Apollo TEMP Pro-1 becomes unresponsive and you've exhausted the other troubleshooting methods, you can reflash the factory firmware by following this guide.
- This needs to be done in Chrome, Edge, or another Chromium based browser.
+!!! note "Before you start"
-If your device has already been connected to Home Assistant please remove it from the ESPHome integration and the ESPHome Device Builder before continuing.
+ - Use Chrome, Edge, or another Chromium-based browser. The installer needs one of them.
+ - If your TEMP Pro-1 has already been connected to Home Assistant, remove it from the ESPHome integration and the ESPHome Device Builder before continuing.
-1\. Put your device in boot mode by holding down the boot button and then plugging in the USB cable.
+Follow these steps to put your TEMP Pro-1 in boot mode, flash the factory firmware from the installer page, and set it up again.
-2\. Navigate to our installer page and click connect under Battery Firmware [Apollo TEMP-1 Installer](https://apolloautomation.github.io/TEMP-1/).
+1\. Put your TEMP Pro-1 in boot mode: hold down the boot button, then plug in the USB cable.
-3\. Click "Connect" under the Non Battery Firmware option since you are using a TEMP-1.
+2\. Open the [Apollo TEMP Pro-1 Installer](https://apolloautomation.github.io/TEMP_PRO-1/) page.
-
+3\. Pick the firmware that matches how your TEMP Pro-1 connects:
-3\. Select the open com port then click Connect.
+* **Wi-Fi:** click **Connect** under **Wifi Firmware**.
+* **Ethernet (PoE):** click **Connect** under **Ethernet Firmware**.
-
-
-4\. Click "Install ApolloAutomation.TEMP-1".
+4\. In the browser's serial port pop-up, select the open COM port (**USB JTAG/serial debug unit** in the screenshot below), then click **Connect**.
-
+
-5\. Click "INSTALL".
+5\. Click **Install ApolloAutomation.TEMP_PRO-1-W**. If you picked Ethernet Firmware, click **Install ApolloAutomation.TEMP_PRO-1-ETH** instead.
-
+6\. Click **INSTALL**.
-6\. Once you see "Installation complete!" you are finished. Click Next then close out of the browser window.
+7\. When the installer shows **Installation complete!**, the flash is finished. Click **Next**, then close the browser window.
-!!! warning "Power cycle your device before doing anything else!"
+!!! warning "Power cycle your TEMP Pro-1 before doing anything else"
+
+ Your TEMP Pro-1 is still in boot mode. Remove all power from it, then reconnect the power so it starts in normal mode.
- Your device is still in boot mode and needs to be power cycled aka power removed to make it boot in a normal mode!
+8\. Go to the getting started guide and set up your TEMP Pro-1 as a new device.
-7\. Please proceed to the getting started guide and set up your sensor as a new device!
\ No newline at end of file
+Once it's set up, your TEMP Pro-1 is back on its factory firmware and ready to use.
diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-reset-wi-fi-credentials.md b/docs/products/temppro1/troubleshooting/temp-pro1-reset-wi-fi-credentials.md
index b262d491ef..3c02c55890 100755
--- a/docs/products/temppro1/troubleshooting/temp-pro1-reset-wi-fi-credentials.md
+++ b/docs/products/temppro1/troubleshooting/temp-pro1-reset-wi-fi-credentials.md
@@ -1,8 +1,10 @@
---
-title: Reset Wi-Fi Credentials
+title: Reset Wi-Fi credentials
description: Step by step guide for resetting the Wi-Fi Credentials on your TEMP Pro-1.
---
-# Reset Wi-Fi Credentials on your TEMP Pro-1
+# Reset Wi-Fi credentials on your TEMP Pro-1
+
+You'll reset the device's Wi-Fi credentials, then connect it to your new Wi-Fi network through its hotspot.
1\. Plug the device into power.
diff --git a/docs/products/temppro1/troubleshooting/temp-pro1-teardown.md b/docs/products/temppro1/troubleshooting/temp-pro1-teardown.md
index 86a5972d7f..4fb329686e 100755
--- a/docs/products/temppro1/troubleshooting/temp-pro1-teardown.md
+++ b/docs/products/temppro1/troubleshooting/temp-pro1-teardown.md
@@ -1,13 +1,15 @@
---
-title: TEMP Pro-1 Teardown
+title: Teardown of TEMP Pro-1
description: >-
- Step by step guide for tearing down your TEMP-1 to replace parts, clean it,
- swap cases, etc.
+ How to open your TEMP Pro-1 by prying off the case lid, for example to
+ replace parts, clean it, or swap cases.
---
-# Teardown Of TEMP Pro-1
+# Teardown of TEMP Pro-1
-1\. Gently pry open the case lid as shown in the image below.
+Removing the case lid gives you access to the board inside your Apollo TEMP Pro-1, for example to replace parts, clean it, or swap cases.
+
+1\. Position the TEMP Pro-1 with the USB-C port facing you. Gently pry up the case lid at the small slit above the USB-C port, as shown in the image below.
-2\. The teardown is complete!
\ No newline at end of file
+With the lid off, the teardown is complete. Opening the case is also the first step of [putting the TEMP Pro-1 in boot mode](../temp-pro1-boot-mode/).
diff --git a/mkdocs.yml b/mkdocs.yml
index 6b4d5424f2..f44d334395 100755
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -91,6 +91,15 @@ plugins:
- meta
- redirects:
redirect_maps:
+ # Wiki cleanup round 2: orphan Homey copies of Home Assistant pages and the old contact page
+ 'products/general/mmwave-presence-sensor-comparison.md': 'products/general/comparisons.md'
+ 'homey/products/general/mmwave-presence-sensor-comparison.md': 'homey/products/general/comparisons.md'
+ 'homey/products/msr2/examples/using-msr-2-buzzer.md': 'homey/products/msr2/introduction.md'
+ 'homey/products/mtr1/examples/using-mtr-1-buzzer.md': 'homey/products/mtr1/introduction.md'
+ 'homey/products/mtr1/examples/mtr-1-home-assistant-dashboard-examples.md': 'homey/products/mtr1/introduction.md'
+ 'homey/products/air1/calibrating-and-updating/air-1-temp-calibration.md': 'homey/products/air1/introduction.md'
+ 'homey/products/msr2/calibrating-co2.md': 'homey/products/general/calibrating-and-updating/co2-calibration.md'
+ 'contact.md': 'products/general/contact-us/contact-us-support.md'
# MSR-1 update-frequency stub removed; only content was a dead link
# to the retired wiki.apolloautomation.cloud
'products/msr1/setup/how-to-change-the-update-frequency-of-sensors.md': 'products/general/setup/change-the-update-frequency-of-sensors.md'
@@ -699,8 +708,8 @@ nav:
- Addons:
- BTN-1 Addon: homey/products/btn1/addons/btn1-addon.md
- Examples:
- - Blueprint: homey/products/btn1/examples/blueprint.md
- - Example Automation: homey/products/btn1/examples/example-automation.md
+ - Turn a Light On and Off: homey/products/btn1/examples/example-automation.md
+ - Use All Four Buttons: homey/products/btn1/examples/blueprint.md
- 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
@@ -810,7 +819,7 @@ nav:
- 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
+ - Built-in Web Page: 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:
@@ -825,8 +834,6 @@ nav:
- Outlet Mount: homey/products/msr2/addons/msr2-outlet-mount.md
- Examples:
- 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:
- Factory Re-Flash MSR-2: homey/products/msr2/troubleshooting/msr2-code.md
- MSR-2 Boot Mode: homey/products/msr2/troubleshooting/msr2-boot-mode.md
@@ -850,7 +857,6 @@ nav:
- GPIO Addon: homey/products/mtr1/addons/adding-gpio-header-to-mtr-1.md
- Male Rear USB-C: homey/products/mtr1/addons/adding-rear-male-usb-to-mtr-1.md
- Examples:
- - MTR-1 Alarmo: homey/products/mtr1/examples/mtr1-alarmo.md
- MTR-1 Corner Mount: homey/products/mtr1/examples/crookedtoe-mtr1.md
- Troubleshooting:
- Factory Re-Flash MTR-1: homey/products/mtr1/troubleshooting/mtr1-code.md
@@ -889,8 +895,6 @@ 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
- - Examples:
- - Flower Card: homey/products/plt1/examples/flower-card.md
- Troubleshooting:
- Factory Re-Flash PLT-1: homey/products/plt1/troubleshooting/plt1-code.md
- PLT-1 Boot Mode: homey/products/plt1/troubleshooting/plt1-boot-mode.md
@@ -909,8 +913,6 @@ nav:
- 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
- - Examples:
- - Flower Card: homey/products/plt1b/examples/flower-card.md
- Troubleshooting:
- Factory Re-Flash PLT-1B: homey/products/plt1b/troubleshooting/plt1b-code.md
- PLT-1B Boot Mode: homey/products/plt1b/troubleshooting/plt1b-boot-mode.md
+ TEMP-1 alert outside temp range example
+ Difficulty: Level 1
+
+