Skip to content

Commit

Permalink
Merge pull request #396 from ApolloAutomation/dev
Browse files Browse the repository at this point in the history
  • Loading branch information
@cloudcannon
cloudcannon[bot] authored Feb 25, 2025
2 parents dfb2159 + 7670c4a commit 97ba726
Show file tree
Hide file tree
Showing 2 changed files with 97 additions and 103 deletions.
Binary file added docs/products/air1/setup/assets/air-1-device-page-pic-1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
200 changes: 97 additions & 103 deletions docs/products/air1/setup/sensor-definitions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,157 +4,151 @@ Once added to Home Assistant you can configure different settings for your senso

### Controls

* **RGB Light**
* 3 RGB Neopixels. Click on the light bulb to change the color. Click on the toggle to turn on or off
* **Calibrate SCD40**
* Refer to the [CO2 calibration guide](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/). Place your sensor outside and click this button to calibrate the CO2 levels
**Calibrate SCD40 to 420ppm** **CO<sub>2</sub>**

* A control option to <a href="https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/" target="_blank" rel="noopener">calibrate the SCD40 CO₂ sensor</a> to <a href="https://climate.nasa.gov/vital-signs/carbon-dioxide/?intent=121" target="_blank" rel="noopener">outdoor baseline levels.</a>

**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**
* Measurement from MiCS-4514 gas sensor
* **Carbon Monoxide**
* Measurement from MiCS-4514 gas sensor
* **CO2**
* True CO2 reading from the SCD40. This will be Unknown if you do not have the CO2 module. This can be calibrated following this guide but does come precalibrated: [Here](https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/)
* **DPS310 Pressure**
* Atmospheric pressure, used to better calibrate the SCD40 CO2 module
* **DPS310 Temperature**
* A worse measurement of temperature. This is more susceptible to internal heat buildup. Please use the SEN55 temperature
* **ESP Temperature**
* This is the temperature of the internal ESP chip. Think of it like your measured CPU temp on your PC
* **Ethanol**
* Measurement from MiCS-4514 gas sensor
* **Hydrogen**
* Measurement from MiCS-4514 gas sensor
* **Methane**
* Measurement from MiCS-4514 gas sensor
* **Nitrogen Dioxide**
* Measurement from MiCS-4514 gas sensor
* **PM &lt; 10 µM**
* Measurement of particulates **smaller** than 10 µM
* **PM &lt; 1 µM**
* Measurement of particulates **smaller** than 1 µM
* **PM &lt; 2.5 µM**
* Measurement of particulates **smaller** than 2.5 µM
* **PM &lt; 4 µM**
* Measurement of particulates **smaller** than 4 µM
* **SEN55 Humidity**
* Humidity measurement from SEN55, will be most accurate
* **SEN55 NOX**
* Measurement of nitrogen oxides from the SEN55
* **SEN55 Temperature**
* Measurement of temperature from the SEN55, will be most accurate
* **SEN55 VOC**
* <a href="https://sensirion.com/media/documents/02232963/6294E043/Info_Note_VOC_Index.pdf" target="_blank" rel="noreferrer nofollow noopener">VOC index from the SEN55</a>.
* **VOC Quality** -This uses the <a href="https://sensirion.com/media/documents/ACD82D45/6294DFC0/Info_Note_Integration_VOC_NOx_Sensor.pdf" target="_blank" rel="noreferrer nofollow noopener">VOC index and a scale to output an easier to use variable </a>

0-79: **Improved** -&gt; 80-149: **Normal** -&gt; 150-249: **Abnormal** -&gt; 250-399: **Very abnormal** -&gt; 400+: **Extremely abnormal**

* **PM 0.3 To 1 µm**
* Disabled by default but can be enabled in HA. Shows particulate count that are from 0.3 to 1.0 µm
* **PM 1 To 2.5 µm**
* Disabled by default but can be enabled in HA. Shows particulate count that are from 1 to 2.5 µm
* **PM 2.5 To 4 µm**
* Disabled by default but can be enabled in HA. Shows particulate count that are from 2.5 to 4.0 µm
* **PM 4 To 10 µm**
* Disabled by default but can be enabled in HA. Shows particulate count that are from 4.0 to 10.0 µm
**Ammonia (NH₃)**

### Configuration
* Measures the concentration of ammonia in the air, which can come from agricultural emissions, cleaning products, or industrial processes.

* **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 &amp; 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 &amp; Humidity Offsets").
* Startup Light Blink
* Controls if the led blinks after power on when trying to connect to Home Assistant.
**Carbon Monoxide (CO)**

* Detects the concentration of carbon monoxide, a dangerous, odorless gas typically produced by combustion.

**(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 CO<sub>2</sub> reading from the SCD40. This will be Unknown if you do not have the CO<sub>2</sub> module. You can <a href="https://wiki.apolloautomation.com/products/general/calibrating-and-updating/co2-calibration/" target="_blank" rel="noopener">re-calibrate the SCD40 CO₂ sensor</a> to <a href="https://climate.nasa.gov/vital-signs/carbon-dioxide/?intent=121" target="_blank" rel="noopener">outdoor baseline levels.</a>

![AIR-1 Sensor Data.jpg](../assets/air-1-sensor-data.jpg)
**DPS310 Pressure**

### Detailed Sensor Definitions
* Measures air pressure in psi (pounds per square inch), providing insights into atmospheric changes and enhancing the accuracy of CO₂ readings.

#### Controls:
**Ethanol (C₂H₅OH)**

• Calibrate SCD40 to 420ppm: A control option to calibrate the SCD40 CO₂ sensor to a specific concentration, typically outdoor levels.
* Detects ethanol vapors, commonly found in cleaning agents, sanitizers, or alcohol-based products.

• Clean SEN55: This control allows you to clean the SEN55 sensor, likely clearing any temporary issues or re-calibrating.
**Hydrogen (H₂)**

• RGB Light: Control to toggle the RGB LED light on or off, which can be used for visual notifications.
* Monitors the concentration of hydrogen gas, which can indicate leaks or industrial processes.

#### Sensors:
**Methane (CH₄)**

• Ammonia (NH₃): Measures the concentration of ammonia in the air, which can come from agricultural emissions, cleaning products, or industrial processes.
* Detects methane concentrations, which can indicate natural gas leaks or emissions from agricultural activities.

• Carbon Monoxide (CO): Detects the concentration of carbon monoxide, a dangerous, odorless gas typically produced by combustion.
**Nitrogen Dioxide (NO₂)**

• CO₂ (Carbon Dioxide): Tracks CO₂ levels in parts per million (ppm), which can indicate poor ventilation and impact overall air quality and cognitive performance.
* Measures the levels of nitrogen dioxide, a harmful gas often produced by vehicle emissions and industrial processes.

• DPS310 Pressure: Measures air pressure in psi (pounds per square inch), providing insights into atmospheric changes and enhancing the accuracy of CO₂ readings.
**PM &lt;10µm Weight Concentration**

• Ethanol (C₂H₅OH): Detects ethanol vapors, commonly found in cleaning agents, sanitizers, or alcohol-based products.
* Tracks particulate matter smaller than 10 micrometers (PM10), which includes dust, pollen, and mold.

• Hydrogen (H₂): Monitors the concentration of hydrogen gas, which can indicate leaks or industrial processes.
**PM &lt;1µm Weight Concentration**

• Methane (CH₄): Detects methane concentrations, which can indicate natural gas leaks or emissions from agricultural activities.
* Monitors the concentration of ultra-fine particles smaller than 1 micrometer, often present in smoke or exhaust.

• Nitrogen Dioxide (NO₂): Measures the levels of nitrogen dioxide, a harmful gas often produced by vehicle emissions and industrial processes.
**PM &lt;2.5µm Weight Concentration**

• PM &lt;10µm Weight Concentration: Tracks particulate matter smaller than 10 micrometers (PM10), which includes dust, pollen, and mold.
* Measures particles smaller than 2.5 micrometers (PM2.5), which are generated by combustion and industrial activities.

• PM &lt;1µm Weight Concentration: Monitors the concentration of ultra-fine particles smaller than 1 micrometer, often present in smoke or exhaust.
**PM &lt;4µm Weight Concentration**

• PM &lt;2.5µm Weight Concentration: Measures particles smaller than 2.5 micrometers (PM2.5), which are generated by combustion and industrial activities.
* Detects particulate matter smaller than 4 micrometers.

• PM &lt;4µm Weight Concentration: Detects particulate matter smaller than 4 micrometers.
**SEN55 Temperature**

• PM 0.3 To 1 µm: Monitors particles in the range of 0.3 to 1 micrometer.
* Tracks ambient air temperature to help assess comfort levels and environmental conditions.

• PM 1 To 2.5 µm: Tracks particles between 1 and 2.5 micrometers.
**SEN55 Humidity**

• PM 2.5 To 4 µm: Measures particulate matter between 2.5 and 4 micrometers.
* Measures relative humidity in the air, which impacts comfort and the overall environment.

• PM 4 To 10 µm: Detects particles between 4 and 10 micrometers.
**SEN55 NOX**

• SEN55 Humidity: Measures relative humidity in the air, which impacts comfort and the overall environment.
* Monitors nitrogen oxides (NOX), harmful gases produced by burning fossil fuels and industrial processes.

• SEN55 NOX: Monitors nitrogen oxides (NOX), harmful gases produced by burning fossil fuels and industrial processes.
**SEN55 VOC**

• SEN55 Temperature: Tracks ambient air temperature to help assess comfort levels and environmental conditions.
Detects volatile organic compounds (VOC Index), which are emitted from paints, cleaning products, and industrial chemicals. <a href="https://sensirion.com/media/documents/02232963/6294E043/Info_Note_VOC_Index.pdf" target="_blank" rel="noreferrer nofollow noopener">VOC index from the SEN55</a>.

• SEN55 VOC: Detects volatile organic compounds (VOCs), which are emitted from paints, cleaning products, and industrial chemicals.
**VOC Quality** -This uses the <a href="https://sensirion.com/media/documents/ACD82D45/6294DFC0/Info_Note_Integration_VOC_NOx_Sensor.pdf" target="_blank" rel="noreferrer nofollow noopener">VOC index and a scale to output an easier to use variable</a>

• VOC Quality: Provides an assessment of air quality based on the concentration of VOCs, ranging from normal to abnormal.
0-79: **Improved** -&gt; 80-149: **Normal** -&gt; 150-249: **Abnormal** -&gt; 250-399: **Very abnormal** -&gt; 400+: **Extremely abnormal**

• SEN55 Temperature: Measures ambient air temperature (73.9°F shown), used to assess the thermal conditions in the environment.
**PM 0.3 To 1 µm**

• SEN55 VOC: Detects volatile organic compounds (VOCs), which are often found in cleaning products, paints, and other household chemicals. The value is 191 ppm.
* Monitors particles in the range of 0.3 to 1 micrometer. Disabled by default.

• VOC Quality: Assesses overall air quality based on VOC levels. In this case, it is marked as “Abnormal.”
**PM 1 To 2.5 µm**

• SEN55 Humidity: Measures the relative humidity of the environment (30.9% shown), which affects comfort and air quality.
* Tracks particles between 1 and 2.5 micrometers. Disabled by default.

• SEN55 NOX: Detects nitrogen oxides, harmful gases often produced by combustion and vehicle emissions. The reading is 1.
**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 &amp; 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 &amp; 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.
**ESP Reboot**

• Firmware Update: Shows the status of firmware updates (currently unavailable).
* A button to restart the ESP32 microcontroller running the AIR-1 sensor, helpful for troubleshooting or refreshing connections.

• SEN55 Humidity Offset: Allows you to adjust the humidity readings for calibration purposes.
**Prevent Sleep**

• SEN55 Temperature Offset: Lets you calibrate the temperature sensor by adjusting the offset in degrees Celsius.
* Ability to put AIR-1 to sleep to get better temperature and humidity measurements.

• Startup Light Blink: An option to enable or disable a startup blink from the RGB LED when the sensor powers on.
**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.
**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**

• Online: Shows the connection status of the device (Connected).
* Displays the signal strength of the Wi-Fi connection (-61 dBm shown), which can impact the sensor’s performance if too weak.

• RSSI: Displays the signal strength of the Wi-Fi connection (-61 dBm shown), which can impact the sensor’s performance if too weak.
**Uptime**

• Uptime: Shows how long the device has been online without rebooting (258:25:54 shown, meaning it has been up for over 258 hours).
* How long the device has been online without rebooting.

0 comments on commit 97ba726

Please sign in to comment.