Skip to content

Commit 97ba726

Browse files
authoredFeb 25, 2025··
Merge pull request #396 from ApolloAutomation/dev
2 parents dfb2159 + 7670c4a commit 97ba726

File tree

2 files changed

+97
-103
lines changed

2 files changed

+97
-103
lines changed
 
Loading

‎docs/products/air1/setup/sensor-definitions.md

+97-103
Original file line numberDiff line numberDiff line change
@@ -4,157 +4,151 @@ Once added to Home Assistant you can configure different settings for your senso
44

55
### Controls
66

7-
* **RGB Light**
8-
* 3 RGB Neopixels. Click on the light bulb to change the color. Click on the toggle to turn on or off
9-
* **Calibrate SCD40**
10-
* 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
7+
**Calibrate SCD40 to 420ppm** **CO<sub>2</sub>**
8+
9+
* 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>
10+
11+
**Clean SEN55**
12+
13+
* This control allows you to clean the SEN55 sensor, likely clearing any temporary issues or re-calibrating.
14+
15+
**RGB Light**
16+
17+
* 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.
1118

1219
### Sensors
1320

14-
* **Ammonia**
15-
* Measurement from MiCS-4514 gas sensor
16-
* **Carbon Monoxide**
17-
* Measurement from MiCS-4514 gas sensor
18-
* **CO2**
19-
* 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/)
20-
* **DPS310 Pressure**
21-
* Atmospheric pressure, used to better calibrate the SCD40 CO2 module
22-
* **DPS310 Temperature**
23-
* A worse measurement of temperature. This is more susceptible to internal heat buildup. Please use the SEN55 temperature
24-
* **ESP Temperature**
25-
* This is the temperature of the internal ESP chip. Think of it like your measured CPU temp on your PC
26-
* **Ethanol**
27-
* Measurement from MiCS-4514 gas sensor
28-
* **Hydrogen**
29-
* Measurement from MiCS-4514 gas sensor
30-
* **Methane**
31-
* Measurement from MiCS-4514 gas sensor
32-
* **Nitrogen Dioxide**
33-
* Measurement from MiCS-4514 gas sensor
34-
* **PM &lt; 10 µM**
35-
* Measurement of particulates **smaller** than 10 µM
36-
* **PM &lt; 1 µM**
37-
* Measurement of particulates **smaller** than 1 µM
38-
* **PM &lt; 2.5 µM**
39-
* Measurement of particulates **smaller** than 2.5 µM
40-
* **PM &lt; 4 µM**
41-
* Measurement of particulates **smaller** than 4 µM
42-
* **SEN55 Humidity**
43-
* Humidity measurement from SEN55, will be most accurate
44-
* **SEN55 NOX**
45-
* Measurement of nitrogen oxides from the SEN55
46-
* **SEN55 Temperature**
47-
* Measurement of temperature from the SEN55, will be most accurate
48-
* **SEN55 VOC**
49-
* <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>.
50-
* **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>
51-
52-
0-79: **Improved** -&gt; 80-149: **Normal** -&gt; 150-249: **Abnormal** -&gt; 250-399: **Very abnormal** -&gt; 400+: **Extremely abnormal**
53-
54-
* **PM 0.3 To 1 µm**
55-
* Disabled by default but can be enabled in HA. Shows particulate count that are from 0.3 to 1.0 µm
56-
* **PM 1 To 2.5 µm**
57-
* Disabled by default but can be enabled in HA. Shows particulate count that are from 1 to 2.5 µm
58-
* **PM 2.5 To 4 µm**
59-
* Disabled by default but can be enabled in HA. Shows particulate count that are from 2.5 to 4.0 µm
60-
* **PM 4 To 10 µm**
61-
* Disabled by default but can be enabled in HA. Shows particulate count that are from 4.0 to 10.0 µm
21+
**Ammonia (NH₃)**
6222

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

65-
* **ESP Reboot**
66-
* Performs a restart of the sensor
67-
* **SEN55 Temperature Offset**
68-
* 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").
69-
* **SEN55 Humidity Offset**
70-
* 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").
71-
* Startup Light Blink
72-
* Controls if the led blinks after power on when trying to connect to Home Assistant.
25+
**Carbon Monoxide (CO)**
26+
27+
* Detects the concentration of carbon monoxide, a dangerous, odorless gas typically produced by combustion.
28+
29+
**(Carbon Dioxide (CO₂)**
30+
31+
* 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>
7332

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

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

78-
#### Controls:
37+
**Ethanol (C₂H₅OH)**
7938

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

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

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

86-
#### Sensors:
45+
**Methane (CH₄)**
8746

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

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

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

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

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

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

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

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

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

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

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

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

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

114-
• PM 1 To 2.5 µm: Tracks particles between 1 and 2.5 micrometers.
73+
**SEN55 Humidity**
11574

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

118-
• PM 4 To 10 µm: Detects particles between 4 and 10 micrometers.
77+
**SEN55 NOX**
11978

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

122-
SEN55 NOX: Monitors nitrogen oxides (NOX), harmful gases produced by burning fossil fuels and industrial processes.
81+
**SEN55 VOC**
12382

124-
• SEN55 Temperature: Tracks ambient air temperature to help assess comfort levels and environmental conditions.
83+
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>.
12584

126-
• SEN55 VOC: Detects volatile organic compounds (VOCs), which are emitted from paints, cleaning products, and industrial chemicals.
85+
**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>
12786

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

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

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

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

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

138-
• SEN55 NOX: Detects nitrogen oxides, harmful gases often produced by combustion and vehicle emissions. The reading is 1.
97+
**PM 2.5 To 4 µm**
98+
99+
* Measures particulate matter between 2.5 and 4 micrometers. Disabled by default.
100+
101+
**PM 4 To 10 µm**
102+
103+
* Detects particles between 4 and 10 micrometers. Disabled by default.
104+
105+
### Configuration
106+
107+
* **ESP Reboot**
108+
* Performs a restart of the sensor
109+
* **SEN55 Temperature Offset**
110+
* 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").
111+
* **SEN55 Humidity Offset**
112+
* 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").
113+
114+
![AIR-1 Sensor Data.jpg](assets/air-1-device-page-pic-1.png)
139115

140116
#### Configuration:
141117

142-
ESP Reboot: A button to restart the ESP32 microcontroller running the AIR-1 sensor, helpful for troubleshooting or refreshing connections.
118+
**ESP Reboot**
143119

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

146-
• SEN55 Humidity Offset: Allows you to adjust the humidity readings for calibration purposes.
122+
**Prevent Sleep**
147123

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

150-
• Startup Light Blink: An option to enable or disable a startup blink from the RGB LED when the sensor powers on.
126+
**SEN55 Humidity Offset**
127+
128+
* Allows you to adjust the humidity readings for calibration purposes.
129+
130+
**SEN55 Temperature Offset**
131+
132+
* Lets you calibrate the temperature sensor by adjusting the offset in degrees Celsius.
151133

152134
#### Diagnostic:
153135

154-
• 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.
136+
**ESP Temperature**
137+
138+
* Displays the internal temperature of the ESP32 microcontroller (112.6°F shown), which is often higher than ambient due to the processor’s activity.
139+
140+
**Firmware Update**
141+
142+
* Shows the status of firmware updates (currently unavailable).
143+
144+
**Online**
145+
146+
* Shows the connection status of the device (Connected).
147+
148+
**RSSI**
155149

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

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

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

0 commit comments

Comments
 (0)
Please sign in to comment.