From 854ec9277fb4e2b94d85bcf52c1c1a1c4fa3df86 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Fri, 29 May 2026 15:19:54 -0500 Subject: [PATCH] docs: clarify DPS310 availability on AIR-1, MTR-1, MSR-2 (#896) A small subset of these devices shipped without the DPS310 sensor because the part was discontinued by the manufacturer. Customers seeing the DPS310 entities reporting "unknown" in Home Assistant have been confused, so this expands and aligns the existing availability notes. Changes: - Add a new FAQ entry on each of AIR-1, MTR-1, MSR-2 that directly addresses "DPS310 shows unknown - is my device broken?" - Add the availability note to MTR-1's DPS310 Temperature Offset and MSR-2's DPS Temperature Offset config entries (was missing; AIR-1 already had it on its Pressure Offset). - Add a DPS310 Pressure sensor entry to AIR-1 sensor-definitions (firmware exposes it but the wiki didn't document it). - Convert the Homey AIR-1 and Homey MSR-2 sensor-definitions pages from stale full duplicates to --8<-- snippet wrappers of the main files, matching the MTR-1 Homey pattern. This also picks up the DPS310 availability notes on the Homey side automatically and fixes a wrong "psi" unit on the stale Homey AIR-1 copy. --- .../products/air1/setup/sensor-definitions.md | 161 +-------- .../msr2/setup/msr2-sensor-definitions.md | 326 +----------------- docs/products/air1/faq.md | 44 +-- .../products/air1/setup/sensor-definitions.md | 4 + docs/products/msr2/faq.md | 24 +- .../msr2/setup/msr2-sensor-definitions.md | 2 +- docs/products/mtr1/faq.md | 34 +- .../products/mtr1/setup/sensor-definitions.md | 2 +- 8 files changed, 65 insertions(+), 532 deletions(-) diff --git a/docs/homey/products/air1/setup/sensor-definitions.md b/docs/homey/products/air1/setup/sensor-definitions.md index 9fc044c66b..45964ea551 100755 --- a/docs/homey/products/air1/setup/sensor-definitions.md +++ b/docs/homey/products/air1/setup/sensor-definitions.md @@ -1,160 +1 @@ - -Once added to Home Assistant you can configure different settings for your sensor. Below is what each setting does. - -### Controls - -**Calibrate SCD40 to 420ppm** **CO2** - -* A control option to calibrate the SCD40 CO₂ sensor to outdoor baseline levels. - -**Clean SEN55** - -* This control allows you to clean the SEN55 sensor, likely clearing any temporary issues or re-calibrating. - -**RGB Light** - -* Three RGB Neopixel LEDs. Click on the light bulb or color wheel to change the color. Click on the toggle to turn on or off. - -### Sensors - -**Ammonia (NH₃)** - -* Measures the concentration of ammonia in the air, which can come from agricultural emissions, cleaning products, or industrial processes. -* **Baseline 0 ppm**. - -**Carbon Monoxide (CO)** - -* Detects the concentration of carbon monoxide, a dangerous, odorless gas typically produced by combustion. -* **Baseline is 4.16ppm not 0 ppm**. - -**(Carbon Dioxide (CO₂)** - -* Tracks CO₂ levels in parts per million (ppm), which can indicate poor ventilation and impact overall air quality and cognitive performance. True NDIR CO2 reading from the SCD40. This will be Unknown if you do not have the CO2 module. You can re-calibrate the SCD40 CO₂ sensor to outdoor baseline levels. - -**DPS310 Pressure** - -* Measures air pressure in psi (pounds per square inch), providing insights into atmospheric changes and enhancing the accuracy of CO₂ readings. - -**Ethanol (C₂H₅OH)** - -* Detects ethanol vapors, commonly found in cleaning agents, sanitizers, or alcohol-based products. -* **Baseline is 0 ppm**. - -**Hydrogen (H₂)** - -* Monitors the concentration of hydrogen gas, which can indicate leaks or industrial processes. -* **Baseline is 0 ppm**. - -**Methane (CH₄)** - -* Detects methane concentrations, which can indicate natural gas leaks or emissions from agricultural activities. -* **Detects measurements of greater than 1000ppm**(Methane CH4 ) -* **Baseline is 0 ppm**. - -**Nitrogen Dioxide (NO₂)** - -* Measures the levels of nitrogen dioxide, a harmful gas often produced by vehicle emissions and industrial processes. -* **Baseline is 0.16ppm not 0 ppm**. - -**PM <10µm Weight Concentration** - -* Tracks particulate matter smaller than 10 micrometers (PM10), which includes dust, pollen, and mold. - -**PM <1µm Weight Concentration** - -* Monitors the concentration of ultra-fine particles smaller than 1 micrometer, often present in smoke or exhaust. - -**PM <2.5µm Weight Concentration** - -* Measures particles smaller than 2.5 micrometers (PM2.5), which are generated by combustion and industrial activities. - -**PM <4µm Weight Concentration** - -* Detects particulate matter smaller than 4 micrometers. - -**SEN55 Temperature** - -* Tracks ambient air temperature to help assess comfort levels and environmental conditions. - -**SEN55 Humidity** - -* Measures relative humidity in the air, which impacts comfort and the overall environment. - -**SEN55 NOX Index** - -* Monitors nitrogen oxides (NOX index), harmful gases produced by burning fossil fuels and industrial processes. - -**SEN55 VOC Index** - -Detects volatile organic compounds (VOC Index), which are emitted from paints, cleaning products, and industrial chemicals. VOC index from the SEN55. - -**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** - -**PM 0.3 To 1 µm** - -* Monitors particles in the range of 0.3 to 1 micrometer. Disabled by default. - -**PM 1 To 2.5 µm** - -* Tracks particles between 1 and 2.5 micrometers. Disabled by default. - -**PM 2.5 To 4 µm** - -* Measures particulate matter between 2.5 and 4 micrometers. Disabled by default. - -**PM 4 To 10 µm** - -* Detects particles between 4 and 10 micrometers. Disabled by default. - -### Configuration - -* **ESP Reboot** - * Performs a restart of the sensor -* **SEN55 Temperature Offset** - * Allows you to calibrate the SEN55 temperature. Please refer to our [calibration guide](https://wiki.apolloautomation.com/products/general/temp-hum-calibration/ "MSR-1 Temperature & Humidity Offsets"). -* **SEN55 Humidity Offset** - * Allows you to calibrate the SEN55 humidity. Please refer to our [calibration guide](https://wiki.apolloautomation.com/products/general/temp-hum-calibration/ "MSR-1 Temperature & Humidity Offsets"). - -![AIR-1 Sensor Data.jpg](/assets/air-1-device-page-pic-1.png) - -#### Configuration: - -**ESP Reboot** - -* A button to restart the ESP32 microcontroller running the AIR-1 sensor, helpful for troubleshooting or refreshing connections. - -**Prevent Sleep** - -* Ability to put AIR-1 to sleep to get better temperature and humidity measurements. - -**SEN55 Humidity Offset** - -* Allows you to adjust the humidity readings for calibration purposes. - -**SEN55 Temperature Offset** - -* Lets you calibrate the temperature sensor by adjusting the offset in degrees Celsius. - -#### Diagnostic: - -**ESP Temperature** - -* Displays the internal temperature of the ESP32 microcontroller (112.6°F shown), which is often higher than ambient due to the processor’s activity. - -**Firmware Update** - -* Shows the status of firmware updates (currently unavailable). - -**Online** - -* Shows the connection status of the device (Connected). - -**RSSI** - -* Displays the signal strength of the Wi-Fi connection (-61 dBm shown), which can impact the sensor’s performance if too weak. - -**Uptime** - -* How long the device has been online without rebooting. \ No newline at end of file +--8<-- "products/air1/setup/sensor-definitions.md:5:" diff --git a/docs/homey/products/msr2/setup/msr2-sensor-definitions.md b/docs/homey/products/msr2/setup/msr2-sensor-definitions.md index 9ea513ad35..f119e01fbe 100755 --- a/docs/homey/products/msr2/setup/msr2-sensor-definitions.md +++ b/docs/homey/products/msr2/setup/msr2-sensor-definitions.md @@ -1,325 +1 @@ -# Sensor Definitions - -Once added to Home Assistant you can configure different settings for your sensor. Below is what each setting does. - -???+ info "Controls" - - **RGB Light** - - * One RGB Neopixel LED. Click on the light bulb or color wheel to change the color. Click on the toggle to turn on or off. - - **Calibrate SCD40 to 420ppm** - - * A control option to calibrate the SCD40 CO₂ sensor to outdoor baseline levels. - -???+ info "Sensors" - - **CO2** - - * True CO2 reading from the SCD40. This will be Unknown if you do not have the CO2 module. SDC40 can be calibrated following this guide. - - **ESP Temperature** - - * This is the temperature of the internal microcontroller. Think of it like your measured CPU temp on your PC. - - **DPS310 Pressure** - - * Measures the air pressure in the environment. - - **DPS310 Temperature** - - * Measures the ambient air temperature using the DPS310 sensor. - - **LTR390 Light** - - * Light level measured in lux by LTR390. - - **LTR390 UV Index** - - * UV index measured by LTR390. - - **Radar Detection Distance** - - * The last detected distance by the radar. This will stay at the last known value so sometimes can be misleading. - - **Radar Move Energy** - - * The amount of movement measured by the LD2410B. Faster movements have higher percentage. - - **Radar Moving Target** - - * Does the radar have a moving target it is tracking. - - **Radar Still Distance** - - * The last measured distance of a still target. It will hold the last value so sometimes can be misleading. - - **Radar Still Energy** - - * The energy of the current still target. - - **Radar Still Target** - - * Does the radar have a still target. - - **Radar Target** - - * Does the radar have a still or moving target. Good for triggering automation. - - **Radar Zone 1 Occupancy** - - * This is a configurable zone. Think of zones like distances from the radar unit. Zone 1 might be from 0 cm to 100 cm from the sensor. This is telling you if there is someone in that zone. The zones can be defined in the configuration section with “Radar End Zone 1” - - **Radar Zone 2 Occupancy** - - * This is a configurable zone. Think of zones like distances from the radar unit. Zone 2 might be from 100 cm to 200 cm from the sensor. This is telling you if there is someone in that zone. The zones can be defined in the configuration section with “Radar End Zone 2” - - **Radar Zone 3 Occupancy** - - * This is a configurable zone. Think of zones like distances from the radar unit. Zone 3 might be from 200 cm to 300 cm from the sensor. This is telling you if there is someone in that zone. The zones can be defined in the configuration section with “Radar End Zone 3” - -???+ info "Configuration" - - **ESP Reboot** - - * Performs a restart of the sensor - - **Factory Reset Radar** - - * Sets the radar's move thresholds back to their original values from the manufacturer - - **g0-g8 Move & Still Threshold** - - * Please refer to the radar tuning guide: [Here](https://wiki.apolloautomation.com/products/msr2/setup/zones-ha/) - - **ld2410 Bluetooth** - - * This allows you to turn on the LD2410's Bluetooth. This allows you to connect to the HLK Radar phone app [used for tuning](https://wiki.apolloautomation.com/products/msr2/setup/zones-hlk/). - - **Radar Zone 1 Start** - - * This sets the starting distance for Zone 1 in cm. This is the distance from the sensor to the start of Zone 1 - - **DPS Temperature Offset** - - * Offsets the heat from the ESP chip for a more accurate temperature. - - **ESP Reboot** - - * A control to reboot the ESP32 system. - - **Factory Reset Radar** - - * Resets the radar to its factory settings. - - **Firmware Update** - - * Shows whether a firmware update is available. - - ??? info "Radar End Zones" - - **Radar End Zone 1** - - * This defines “Zone 1” of the radar. It is a distance from the sensor that specifies what “Zone 1” is. It connects to the “Radar Zone 1 Occupancy” sensor. So if this number is set to “100” that means from 0 to 100 centimeters from the sensor is zone 1. - - **Radar End Zone 2** - - * This defines “Zone 2” of the radar. It is a distance from the sensor that specifies what “Zone 2” is. It connects to the “Radar Zone 2 Occupancy” sensor. So if this number is set to “200” that means from zone 2 end distance to 200 centimeters from the sensor is zone 2. - - **Radar End Zone 3** - - * It is a distance from the sensor that specifies what “Zone 3” is. It connects to the “Radar Zone 3 Occupancy” sensor. So if this number is set to “300” that means from zone 2 end distance to 300 centimeters from the sensor is zone 3. - - **Radar Engineering Mode** - - * Used to enable g0-g8 threshold sliders for mmWave tuning. - - **Radar Timeout** - - * Configures the timeout for the radar in seconds. - - **Startup Light Blink** - - A toggle to enable or disable the blinking of the RGB LED during MSR-2 initial boot. - - ???+ info "Radar Gate Distance Tuning and Timeout" - - ???+ example "Radar Max Move Distance" - - * Maximum distance gate for movement detection. Value between 2 and 8 inclusive - * Useful in a bathroom or other scenario where you want to avoid detection after a certain gate number (distance). - * Useful for triggering on "radar target" instead of triggering on zone 1/2/3 occupancy instead. - - ???+ example "Radar Max Still Distance " - - * Maximum distance gate for still detection. Value between 2 and 8 inclusive. Defaults to 8. - * Useful in a bathroom or other scenario where you want to avoid detection after a certain gate number (distance). - * Useful for triggering on "radar target" instead of triggering on zone 1/2/3 occupancy instead. - - ???+ info "Radar Timeout" - - The time in seconds that the radar's presence will stay high after the target is lost. - -??? success "Radar Sensors" - - **Radar Detection Distance** - - * Shows the distance to the detected target, measured in cm. - - **Radar Move Energy** - - * Displays the energy of movement detected by the radar, represented as a percentage. - - **Radar Moving Distance** - - * Displays the distance of a moving target, measured in cm. - - **Radar Moving Target** - - * Detects whether a moving target is present. - - **Radar Still Distance** - - * Displays the distance of a still target, measured in cm. - - **Radar Still Energy** - - * Displays the energy detected from still objects. - - **Radar Still Target** - - * Detects whether a still target is present. - - **Radar Target** - - * Overall detection of a target by the radar. - - **Radar Zone 1 Occupancy** - - * Indicates whether Zone 1 is occupied or clear. - - **Radar Zone 2 Occupancy** - - * Indicates whether Zone 2 is occupied or clear. - - **Radar Zone 3 Occupancy** - - * Indicates whether Zone 3 is occupied or clear. - -??? info "Radar Gate Configuration" - - !!! warning "Keeping these enabled permanently is bad" - - Please toggle ld2410 Bluetooth on, configure your sensor, then turn ld2410 Bluetooth back off. Otherwise, your Wi-Fi and database could become overwhelmed with excessive traffic. - - **g0 Move Threshold** - - * Configures the movement sensitivity threshold for gate 0. - - **g0 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 0. - - **g1 Move Threshold** - - * Configures the movement sensitivity threshold for gate 1. - - **g1 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 1. - - **g2 Move Threshold** - - * Configures the movement sensitivity threshold for gate 2. - - **g2 Still Threshold** - - * Configures the stillness sensitivity threshold for for gate 2. - - **g3 Move Threshold** - - * Configures the movement sensitivity threshold for gate 3. - - **g3 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 3. - - **g4 Move Threshold** - - * Configures the movement sensitivity threshold for gate 4. - - **g4 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 4. - - **g5 Move Threshold** - - * Configures the movement sensitivity threshold for gate 5. - - **g5 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 5. - - **g6 Move Threshold** - - * Configures the movement sensitivity threshold for gate 6. - - **g6 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 6. - - **g7 Move Threshold** - - * Configures the movement sensitivity threshold for gate 7. - - **g7 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 7. - - **g8 Move Threshold** - - * Configures the movement sensitivity threshold for gate 8. - - **g8 Still Threshold** - - * Configures the stillness sensitivity threshold for gate 8. - -??? info "Diagnostic" - - **ESP Temperature** - - * Displays the current temperature of the ESP32 chip. - - **g0 move energy to g8 move energy** - - * Displays the move energy levels for gates g0 through g8 - - **g0 move energy to g8 still energy** - - * Displays the still energy levels for gates g0 through g8 - - **Online** - - * Shows the connection status. - - **Query Params** - - * Button to query parameters for debugging or advanced configurations. - - **Radar Firmware Version** - - * Displays the current firmware version for the radar. - - **Restart Radar** - - * Button to restart the radar sensor. - - **RSSI** - - * Displays the Wi-Fi signal strength. - - **Uptime** - - * Shows the time since last reboot. - -[Join our Discord if you need more help! :simple-discord:](https://link.apolloautomation.com/discord){ .md-button } \ No newline at end of file +--8<-- "products/msr2/setup/msr2-sensor-definitions.md:5:" diff --git a/docs/products/air1/faq.md b/docs/products/air1/faq.md index 3af205fb0f..6395b83f54 100755 --- a/docs/products/air1/faq.md +++ b/docs/products/air1/faq.md @@ -47,82 +47,86 @@ description: Frequently asked questions about the AIR-1 environmental sensor, in * The AIR-1 uses a high-quality SEN55 sensor with a 10-year lifespan, designed for continuous use. Its readings are highly accurate for particulate matter, VOC Index, and NOx Index. However, keep in mind that the ESP32-C3 generates some heat, which may require you to apply a temperature and humidity offset. -12\. **How can I use the RGB LED for notifications?** +12\. **My DPS310 Pressure or DPS310 Temperature shows as "unknown" in Home Assistant. Is something wrong?** + +* 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. + +13\. **How can I use the RGB LED for notifications?** * The RGB LED on the AIR-1 can be customized to show different colors for different events. For example, you can set it to flash red when air quality is poor, green on trash night, or blue when CO2 levels are safe. You can configure these notifications through Home Assistant. -13\. **How do I update the firmware on the AIR-1?** +14\. **How do I update the firmware on the AIR-1?** * Firmware updates can be done over-the-air (OTA) using ESPHome. You will receive notifications when new firmware is available, and you can install updates directly through Home Assistant. -14\. **How do I calibrate the CO2 sensor?** +15\. **How do I calibrate the CO2 sensor?** * The CO2 sensor comes pre-calibrated, so you don’t need to perform any manual calibration. However, you can recalibrate the sensor through ESPHome if needed. -15\. **Does the AIR-1 work outdoors?** +16\. **Does the AIR-1 work outdoors?** * The AIR-1 is primarily designed for indoor use. It could be used outdoors in a sheltered environment, but it is not weatherproof. If you need outdoor air quality monitoring, ensure the device is protected from the elements. -16\. **What is the power source for the AIR-1?** +17\. **What is the power source for the AIR-1?** * The AIR-1 is powered via a USB-C connection. It can be plugged into any standard wall outlet using a 5V adapter. -17\. **My AIR-1 CO2 sensors are having a sawtooth pattern, is there any explanation?** +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! -18\. **Can I integrate multiple AIR-1 sensors in my smart home?** +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. -19\. **How customizable is the AIR-1?** +20\. **How customizable is the AIR-1?** * The AIR-1 is fully customizable via ESPHome. You can adjust sensor settings, create automations, modify reporting intervals, and even customize the RGB LEDs. Additionally, we provide open-source CAD drawings and code for further customization. -20\. **How frequently does the AIR-1 report data?** +21\. **How frequently does the AIR-1 report data?** * The reporting frequency for each sensor is adjustable via ESPHome but most default to 60 seconds. You can choose to have data reported as frequently as every second, or adjust intervals to save power and reduce data traffic. -21\. **Does the AIR-1 require specific software?** +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. -22\. **Is the AIR-1 compatible with other smart home platforms?** +23\. **Is the AIR-1 compatible with other smart home platforms?** * While the AIR-1 is optimized for Home Assistant and ESPHome, you may be able to integrate it into other smart home platforms using custom configurations or MQTT, but Home Assistant remains the primary platform. -23\. **What's the difference between the AIR-1 and other air quality sensors?** +24\. **What's the difference between the AIR-1 and other air quality sensors?** * The AIR-1 is unique because it offers local control with no cloud or subscription required. It also provides a wide range of sensor data (PM, VOC, NOx, CO2, temperature, humidity) in a compact, affordable package. The addition of the RGB LEDs and open-source nature makes it highly customizable. -24\. **What are the optional add-ons for the AIR-1?** +25\. **What are the optional add-ons for the AIR-1?** * The AIR-1 offers two optional add-ons: a SCD40 CO2 sensor and the MiCS gas sensor. These can be added to enhance air quality monitoring with very accurate CO2 measurements and the ability to detect multiple gases with the MiCS gas sensor. -25\. **What's in the box?** +26\. **What's in the box?** * The AIR-1 comes with the fully assembled board and case, a USB-C power cable, and access to all our documentation, open-source code, and CAD models. You'll also receive a sticker of Apollo, our mascot. -26\. **How do I install the AIR-1?** +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. -27\. **What is the warranty on the AIR-1?** +28\. **What is the warranty on the AIR-1?** * The AIR-1 comes with a one-year warranty. If you encounter any issues, we provide support via email, Discord, and our community channels to ensure you're satisfied with the product. -28\. **Can the AIR-1 be used to monitor 3D printer fumes?** +29\. **Can the AIR-1 be used to monitor 3D printer fumes?** * Yes, the AIR-1 can monitor air quality around 3D printers, especially particulate matter (PM) and VOCs emitted during the printing process. It can trigger alerts or automations when levels become unhealthy. -29\. **How long does it take to set up the AIR-1?** +30\. **How long does it take to set up the AIR-1?** * Setup typically takes around 5-10 minutes. Once powered and connected to WiFi, it can be configured quickly through ESPHome and Home Assistant. -30\. **How secure is the AIR-1?** +31\. **How secure is the AIR-1?** * The AIR-1 operates entirely on your local network and does not send data to the cloud. All information is processed and stored locally, ensuring the security and privacy of your home automation setup. -31\. **Can I use the AIR-1 for safety monitoring (e.g., CO2 or gas leaks)?** +32\. **Can I use the AIR-1 for safety monitoring (e.g., CO2 or gas leaks)?** * The AIR-1's CO2 and gas sensors are intended for air quality monitoring but **DO NOT MEET** the safety standards for CO2 or gas leak detection as defined by the NBIC, NFPA, or IFC. For safety purposes, dedicated gas or CO2 monitors should be used. \ No newline at end of file diff --git a/docs/products/air1/setup/sensor-definitions.md b/docs/products/air1/setup/sensor-definitions.md index 1cfd34a22e..02943924e7 100755 --- a/docs/products/air1/setup/sensor-definitions.md +++ b/docs/products/air1/setup/sensor-definitions.md @@ -36,6 +36,10 @@ Once added to Home Assistant you can configure different settings for your senso * Tracks CO₂ levels in parts per million (ppm), which can indicate poor ventilation and impact overall air quality and cognitive performance. True NDIR CO2 reading from the SCD40. This will be Unknown if you do not have the CO2 module. You can re-calibrate the SCD40 CO₂ sensor to outdoor baseline levels. +**DPS310 Pressure** + +* Measures the air pressure in the environment. Note: A small subset of devices do not include a DPS310 sensor. If this sensor is unknown, your device may be one of these units. + **Ethanol (C₂H₅OH)** * Detects ethanol vapors, commonly found in cleaning agents, sanitizers, or alcohol-based products. diff --git a/docs/products/msr2/faq.md b/docs/products/msr2/faq.md index 46fb69cc1d..67483e64b2 100755 --- a/docs/products/msr2/faq.md +++ b/docs/products/msr2/faq.md @@ -62,42 +62,46 @@ description: Frequently asked questions about the MSR-2 mmWave sensor. * The DPS310 sensor provides precise readings of air temperature and pressure, which are especially useful when combined with the optional CO2 sensor to improve air quality monitoring. Keep in mind the heat generated by the ESP32 may require a temperature offset adjustment in the configuration. -16\. **What kind of power supply is required for the MSR-2?** +16\. **My DPS310 Pressure or DPS310 Temperature shows as "unknown" in Home Assistant. Is something wrong?** + +* 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. + +17\. **What kind of power supply is required for the MSR-2?** * The MSR-2 is powered via USB-C and can be plugged into a standard wall outlet using a 5V adapter. -17\. **Can I customize the MSR-2 functionality?** +18\. **Can I customize the MSR-2 functionality?** * Absolutely! With ESPHome, users can modify firmware, settings, and even print custom cases for the MSR-2. Our YAML is on Github and our .STEP and .STL CAD files are available for community use. -18\. **How often does the MSR-2 report sensor data?** +19\. **How often does the MSR-2 report sensor data?** * The reporting frequency can be customized through the ESPHome YAML configuration. You can set it to report data as frequently as every second or reduce the frequency to save energy or bandwidth. -19\. **Is the MSR-2 compatible with other smart home platforms?** +20\. **Is the MSR-2 compatible with other smart home platforms?** * The MSR-2 is specifically designed for Home Assistant via ESPHome. While it could be compatible with other platforms through custom integrations, its primary functionality is optimized for Home Assistant. -20\. **Can I use multiple MSR-2 sensors in my Home Assistant setup?** +21\. **Can I use multiple MSR-2 sensors in my Home Assistant setup?** * Yes, you can have multiple MSR-2 sensors connected to the same Home Assistant instance. Each device will show up as a separate entity, allowing you to monitor and automate different rooms or areas in your home. -21\. **What accessories are available for the MSR-2?** +22\. **What accessories are available for the MSR-2?** * The MSR-2 has an additional expansion slot for future accessories. Currently, accessories such as a USB-C wall plug mount and a ball mount for flexible positioning are available. We are also working on new expansion boards for future updates. -22\. **Is the MSR-2 secure?** +23\. **Is the MSR-2 secure?** * The MSR-2 communicates over your local network using ESPHome, which provides a secure, local connection without the need for cloud services. No data is sent to external servers, ensuring privacy. -23\. **How do I install and configure the MSR-2?** +24\. **How do I install and configure the MSR-2?** * Installation is straightforward, with the MSR-2 powered via USB-C and connecting to Home Assistant through WiFi. Configuration is done in ESPHome, where you can set sensor parameters, adjust automations, and more. We provide detailed documentation and support through our Discord community and GitHub. -24\. **What makes the MSR-2 stand out from other motion sensors?** +25\. **What makes the MSR-2 stand out from other motion sensors?** * The MSR-2 stands out due to its mmWave radar’s ability to detect still motion (like someone sitting still) and its capability to track multiple targets and zones. Additionally, its compact size, multi-sensor integration (motion, LUX, UV, CO2, temperature, pressure), and the open-source nature of the product make it highly versatile and customizable. -25\. **What is the warranty for the MSR-2?** +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 diff --git a/docs/products/msr2/setup/msr2-sensor-definitions.md b/docs/products/msr2/setup/msr2-sensor-definitions.md index ca0b11c548..1ca0a09a2e 100755 --- a/docs/products/msr2/setup/msr2-sensor-definitions.md +++ b/docs/products/msr2/setup/msr2-sensor-definitions.md @@ -110,7 +110,7 @@ Once added to Home Assistant you can configure different settings for your senso **DPS Temperature Offset** - * Offsets the heat from the ESP chip for a more accurate temperature. + * Offsets the heat from the ESP chip for a more accurate temperature. Note: A small subset of devices do not include a DPS310 sensor. If this option is unknown, your device may be one of these units. **ESP Reboot** diff --git a/docs/products/mtr1/faq.md b/docs/products/mtr1/faq.md index aa9e5b07e4..60408fe6d5 100755 --- a/docs/products/mtr1/faq.md +++ b/docs/products/mtr1/faq.md @@ -62,62 +62,66 @@ description: Frequently asked questions about the MTR-1 mmWave sensor. * The temperature and pressure sensor provides accurate measurements for air temperature and barometric pressure. This data can be used in automations, such as controlling heating/cooling systems or monitoring environmental conditions. -16\. **How is the MTR-1 powered?** +16\. **My DPS310 Pressure or DPS310 Temperature shows as "unknown" in Home Assistant. Is something wrong?** + +* 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. + +17\. **How is the MTR-1 powered?** * The MTR-1 is powered through a USB-C connection and can be plugged into a standard wall outlet using a 5V adapter. -17\. **What is the purpose of the RGB LED and piezo buzzer?** +18\. **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. -18\. **Can I customize the MTR-1’s features?** +19\. **Can I customize the MTR-1’s features?** * Yes, the MTR-1 is fully customizable through ESPHome. You can modify sensor settings, change reporting intervals, and create custom automations based on the sensor readings. -19\. **What is the reporting frequency of the MTR-1’s sensors?** +20\. **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. -20\. **Can I use multiple MTR-1 sensors in my smart home setup?** +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. -21\. **What’s the difference between the MTR-1 and MSR-2?** +22\. **What’s the difference between the MTR-1 and MSR-2?** * The MTR-1 features multi-target radar tracking, allowing it to detect multiple people in a room and track their positions. The MSR-2, on the other hand, is designed more for single-target detection and has a slightly different sensor set, though both sensors offer robust environmental monitoring capabilities. -22\. **What accessories are available for the MTR-1?** +23\. **What accessories are available for the MTR-1?** * Accessories for the MTR-1 include mounting brackets, stands, and a variety of expansion options, like additional sensor modules. These allow for greater flexibility in where and how you use the sensor. -23\. **What are the primary advantages of the MTR-1 over other motion sensors?** +24\. **What are the primary advantages of the MTR-1 over other motion sensors?** * The MTR-1’s mmWave radar is significantly more advanced than traditional PIR (Passive Infrared) motion sensors. It can detect subtle movements, track multiple targets, and monitor precise locations within a room, making it ideal for sophisticated home automations. Its additional sensors (LUX, UV, temperature, pressure, optional CO2) also provide greater environmental awareness. -24\. **How do I install the MTR-1?** +25\. **How do I install the MTR-1?** * Installation is simple. The MTR-1 is powered via USB-C and connects to your WiFi. From there, you configure it through ESPHome and integrate it into your Home Assistant setup. Detailed instructions are available on our documentation wiki, and we offer support via our Discord community. -25\. **How secure is the MTR-1?** +26\. **How secure is the MTR-1?** * The MTR-1 operates entirely on your local network, using ESPHome, which means no data is sent to external servers. This ensures that your home automation data remains private and secure. -26\. **Does the MTR-1 require cloud connectivity?** +27\. **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. -27\. **How do I update the firmware on the MTR-1?** +28\. **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. -28\. **What is the warranty on the MTR-1?** +29\. **What is the warranty on the MTR-1?** * The MTR-1 comes with a one-year warranty. If you encounter any issues, we provide comprehensive support via email, Discord, or our website to ensure you’re fully satisfied with the product. -29\. **How long does it take to set up the MTR-1?** +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. -30\. **What’s in the box?** +31\. **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 diff --git a/docs/products/mtr1/setup/sensor-definitions.md b/docs/products/mtr1/setup/sensor-definitions.md index 990ebf7c7c..0a9a4297c4 100755 --- a/docs/products/mtr1/setup/sensor-definitions.md +++ b/docs/products/mtr1/setup/sensor-definitions.md @@ -176,7 +176,7 @@ description: These are all of the entities exposed by the MTR-1 to automate on! **DPS310 Temperature Offset** - * Offset value of the DPS310 Temperature. + * Offset value of the DPS310 Temperature. Note: A small subset of devices do not include a DPS310 sensor. If this option is unknown, your device may be one of these units. **ESP Reboot**