Merge pull request #35 from ApolloAutomation/dev

docs/products/air1/faq.md

@@ -0,0 +1,133 @@
+1\. What sensors are included in the AIR-1?
+
+•	The AIR-1 includes sensors for PM1, PM2.5, PM4, PM10 (particulate matter), VOC (volatile organic compounds), NOx (nitrogen oxides), temperature, and humidity. Optional sensors include CO2 and barometric pressure.
+
+2\. What does the AIR-1 measure?
+
+•	The AIR-1 measures a variety of air quality metrics, including particulate matter (dust, pollen, etc.), VOCs, NOx, temperature, and humidity. The optional CO2 sensor can track carbon dioxide levels, and the pressure sensor helps provide more accurate CO2 readings.
+
+3\. How do I connect the AIR-1 to Home Assistant?
+
+•	The AIR-1 connects to Home Assistant through ESPHome using WiFi. Once connected, you can view sensor data, configure the device, and create automations directly from Home Assistant.
+
+4\. Does the AIR-1 require cloud connectivity or a subscription?
+
+•	No, the AIR-1 is fully local and does not require any cloud services or subscriptions. All data is processed and stored locally via your Home Assistant setup, ensuring privacy and control over your data.
+
+5\. What are common use cases for the AIR-1?
+
+•	The AIR-1 is ideal for monitoring indoor air quality, such as tracking dust levels in woodworking shops, ensuring optimal air quality during sleep, or automating air purifiers when certain thresholds are met. The CO2 sensor is particularly useful for identifying high CO2 levels, which can affect sleep and concentration.
+
+6\. How do I set up automations with the AIR-1?
+
+•	Using Home Assistant, you can set up automations based on the AIR-1’s sensor readings. For example, you can automate an HVAC fan to run when CO2 levels are high, or trigger notifications when particulate matter reaches unhealthy levels.
+
+7\. How does the optional CO2 sensor work?
+
+•	The optional CO2 sensor (SCD-40) measures carbon dioxide levels and helps you understand when CO2 concentrations in a room become too high, which can cause fatigue, drowsiness, and poor air quality. It’s particularly useful in offices, bedrooms, and other enclosed spaces.
+
+8\. What is particulate matter (PM) and why is it important?
+
+•	Particulate matter (PM) refers to tiny particles in the air that can be harmful when inhaled. The AIR-1 measures various sizes of particulate matter (PM1, PM2.5, PM4, PM10), helping you track dust, pollen, and other particles that affect air quality. It’s especially useful for people with allergies or respiratory conditions.
+
+9\. What is VOC and why should I monitor it?
+
+•	VOCs (volatile organic compounds) are chemicals that can be emitted from everyday items like cleaning products, paints, and furniture. Prolonged exposure to high levels of VOCs can affect indoor air quality and health. The AIR-1’s VOC sensor helps you monitor these levels and take action when necessary, such as increasing ventilation.
+
+10\. What is NOx and why is it measured?
+
+•	NOx (nitrogen oxides) are harmful gases that contribute to air pollution and can affect respiratory health. The AIR-1 measures NOx levels, allowing you to keep track of indoor air quality and make adjustments if necessary.
+
+11\. How accurate are the air quality readings from the AIR-1?
+
+•	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, VOCs, and NOx. However, keep in mind that the ESP32-C3 generates some heat, which may require you to apply a temperature offset for the most accurate readings.
+
+12\. 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?
+
+•	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?
+
+•	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?
+
+•	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?
+
+•	The AIR-1 is powered via a USB-C connection. It can be plugged into any standard wall outlet using a 5V adapter, and the USB-C port allows for easy powering without additional adapters.
+
+17\. How does the pressure sensor help with CO2 readings?
+
+•	The barometric pressure sensor (DPS310) enhances the accuracy of CO2 readings by compensating for changes in altitude and atmospheric pressure, ensuring more reliable measurements of CO2 levels in different environments.
+
+18\. What can I do with the Bluetooth tracker on the AIR-1?
+
+•	The built-in Bluetooth tracker can be used to track Bluetooth devices in your home, such as phones, tablets, or Bluetooth beacons. This allows for automations based on device proximity, like turning on lights when your phone is nearby or triggering alerts when a device leaves the area.
+
+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.
+
+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 LED and piezo buzzer. Additionally, we provide open-source CAD drawings and code for further customization.
+
+21\. How frequently does the AIR-1 report data?
+
+•	The reporting frequency for each sensor is adjustable via ESPHome. You can choose to have data reported as frequently as every second, or adjust intervals to save power and reduce data traffic.
+
+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.
+
+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.
+
+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 LED, piezo buzzer, and open-source nature makes it highly customizable.
+
+25\. What are the optional add-ons for the AIR-1?
+
+•	The AIR-1 offers two optional add-ons: a CO2 sensor (SCD40) and a barometric pressure sensor (DPS310). These can be added to enhance air quality monitoring and improve the accuracy of CO2 readings.
+
+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.
+
+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.
+
+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.
+
+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.
+
+30\. How long does it take to set up the AIR-1?
+
+•	Setup typically takes around 10-15 minutes. Once powered and connected to WiFi, it can be configured quickly through ESPHome and Home Assistant.
+
+31\. What is the temperature offset needed due to heat from the ESP32-C3?
+
+•	The ESP32-C3 generates some heat, which may slightly affect temperature readings. We recommend applying a temperature offset between 2°C to 6°C, depending on your environment, to get more accurate temperature data.
+
+32\. 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.
+
+33\. 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.
+
+ 

docs/products/msr1/faq.md

@@ -0,0 +1,129 @@
+1\. What sensors are included in the MSR-1?
+
+•	The MSR-1 includes a mmWave radar sensor (HLK-ld2410b), a LUX and UV sensor (LTR-390UV), and a temperature, humidity, and pressure sensor (BME280). It also has an optional CO2 sensor (SCD40), RGB LED, and piezo buzzer.
+
+2\. What does the mmWave radar sensor do?
+
+•	The mmWave radar sensor detects motion, even subtle movements. It can be used for automation tasks like turning on lights when someone enters a room or keeping them on while someone is sitting still. It’s also effective for detecting presence in spaces like beds or workstations.
+
+3\. How does the MSR-1 connect to Home Assistant?
+
+•	The MSR-1 connects to Home Assistant through ESPHome using WiFi. Once connected, you can configure automations, monitor sensor data, and customize settings from Home Assistant.
+
+4\. Does the MSR-1 require any cloud service or subscription?
+
+•	No, the MSR-1 is fully local and does not rely on cloud services or subscriptions. It operates entirely within your Home Assistant setup, ensuring privacy and data security.
+
+5\. What are the use cases for the MSR-1?
+
+•	The MSR-1 is versatile and can be used for various home automation tasks, such as detecting when someone enters a room to turn on lights, monitoring CO2 levels, measuring sunlight (UV) to optimize plant care, or providing notifications using the RGB LED or piezo buzzer.
+
+6\. What does the optional CO2 sensor measure?
+
+•	The optional CO2 sensor (SCD40) tracks carbon dioxide levels, which can affect air quality and personal comfort. High CO2 levels can cause drowsiness, poor sleep, and brain fog. The sensor can notify you when it’s time to open a window or increase ventilation.
+
+7\. How does the RGB LED work?
+
+•	The RGB LED on the MSR-1 can be used for visual notifications. For example, it can turn red when CO2 levels are high, green for trash night, or blue when the mail arrives. These alerts can be fully customized using Home Assistant.
+
+8\. Can the piezo buzzer be customized?
+
+•	Yes, the piezo buzzer can be programmed to emit different beep patterns based on events. For instance, you can set it to beep when the front door opens, when the CO2 levels rise, or even play a fun tune for a party.
+
+9\. What is the purpose of the LUX and UV sensors?
+
+•	The LUX and UV sensors (LTR-390UV) help monitor light levels and UV exposure. You can use these sensors to control indoor lighting based on natural light conditions or to track the amount of sunlight in a specific area, such as near plants.
+
+10\. How accurate are the temperature and humidity readings?
+
+•	The MSR-1 uses the BME280 sensor for temperature, humidity, and pressure. It provides accurate readings, but keep in mind that the ESP32-C3 processor generates some heat, which may require a temperature offset for the most precise measurements.
+
+11\. What does the pressure sensor do?
+
+•	The pressure sensor enhances the accuracy of CO2 readings by accounting for changes in atmospheric pressure. This helps provide more reliable air quality data.
+
+12\. How do I install the MSR-1?
+
+•	Installation is straightforward. The MSR-1 is powered via a USB-C cable connected to a standard power adapter. Once powered on, it can be configured through Home Assistant using ESPHome.
+
+13\. Can I customize the MSR-1?
+
+•	Yes, the MSR-1 is fully customizable. We provide open-source code and CAD files for you to modify and enhance. You can create automations, adjust sensor settings, and modify reporting intervals based on your needs.
+
+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.
+
+15\. Can the mmWave sensor detect through walls?
+
+•	Yes, mmWave sensors can detect movement through walls, depending on the material and thickness. This means you may need to fine-tune the sensor’s settings to prevent false positives or adjust its placement to avoid unwanted detections.
+
+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.
+
+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.
+
+18\. What is the reporting interval for the MSR-1 sensors?
+
+•	The reporting interval is adjustable via ESPHome. You can configure the sensors to report data as frequently as every second or set longer intervals depending on your specific needs.
+
+19\. Can I use the MSR-1 outdoors?
+
+•	The MSR-1 is designed for indoor use. While it could be used outdoors in a sheltered environment, it is not weatherproof. If you plan to use it outdoors, make sure to protect it from the elements.
+
+20\. What is the maximum number of targets for the mmWave sensor?
+
+•	The mmWave sensor on the MSR-1 is designed to detect a single target at a time. It is excellent for recognizing motion within a specific area, such as a room, and keeping track of when someone is present.
+
+21\. What is the Exposed GPIO feature on the MSR-1?
+
+•	The Exposed GPIO feature provides access to the GPIO pins, 3v, 5v, and I2C on the back of the MSR-1 board. This allows you to expand its capabilities by adding external sensors or other components. For example, you could add an external temperature sensor or other I2C devices.
+
+22\. How do I update the firmware on the MSR-1?
+
+•	Firmware updates are done over-the-air (OTA) using ESPHome. You can update the firmware directly through Home Assistant when new versions are available.
+
+23\. Does the MSR-1 support Bluetooth tracking?
+
+•	Yes, the MSR-1 has Bluetooth tracking capabilities through the ESP32-C3 chip. You can track Bluetooth devices such as phones, tablets, or beacons. This allows for automations based on proximity, such as turning on lights when you walk into a room with your phone.
+
+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.
+
+25\. How can I use the MSR-1 for light control?
+
+•	The MSR-1’s LUX sensor can be used to control indoor lighting. For example, you can set up automations to only turn on lights when motion is detected and the room is dark. The UV sensor can also help you track sunlight exposure, which is useful for managing indoor plant care.
+
+26\. Does the MSR-1 work with other smart home platforms besides Home Assistant?
+
+•	The MSR-1 is designed to work with Home Assistant through ESPHome. While it may be possible to integrate it with other platforms using MQTT or custom configurations, Home Assistant remains the primary platform for full functionality.
+
+27\. What are some creative automation ideas using the MSR-1?
+
+•	The MSR-1 offers endless automation possibilities. You can:
+
+•	Use the mmWave sensor to automate lights based on motion and presence.
+
+•	Use the RGB LED to indicate specific events (e.g., trash night or mail delivery).
+
+•	Trigger the piezo buzzer for notifications, such as when CO2 levels are too high or when a door opens.
+
+•	Use the LUX sensor to control lights based on sunlight levels.
+
+28\. What’s included in the MSR-1 package?
+
+•	The MSR-1 package includes the assembled board, case, and links to our documentation, open-source code, and CAD models. You’ll also get an Apollo Automation sticker as a little bonus.
+
+29\. What’s the difference between the MSR-1 and MSR-2?
+
+•	The MSR-2 is an incremental update based on user feedback. It includes a compact design, improved sensor accuracy (such as a DPS310 pressure sensor), and an additional expansion slot for future accessories. The MSR-1 remains supported, but the MSR-2 is the recommended choice for new users.
+
+30\. How do I get support for the MSR-1?
+
+•	You can get support through our Discord community, where you can ask questions and share your experiences with other users and the Apollo Automation team. We also provide extensive documentation on our GitHub and wiki pages.
+
+