Skip to content

Commit 2c2e3c3

Browse files
author
jas
committed
Add AQI (Air Quality Index) documentation for pmsx003 and enhance hm3301
- Added AQI documentation to pmsx003 sensor - Enhanced hm3301 AQI documentation with detailed scales and examples - Documented both AQI (US EPA) and CAQI (European) calculation standards - Added health implication tables for both standards - Included configuration examples with filtering options
1 parent 5d943bb commit 2c2e3c3

File tree

2 files changed

+98
-7
lines changed

2 files changed

+98
-7
lines changed

‎content/components/sensor/hm3301.md‎

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,39 @@ sensor:
4949
- **calculation_type** (**Required**): One of: `AQI` or `CAQI`.
5050
- All other options from [Sensor](/components/sensor).
5151

52-
## Air Quality Sensor
52+
## Air Quality Index
5353

54-
There is a sensor which calculates quality of air based on PM 2.5 and PM 10.0 values.
55-
There are two implementations:
54+
The AQI (Air Quality Index) sensor calculates an air quality index value based on the PM2.5 and PM10 particulate matter concentrations. This provides a single number that indicates overall air quality and associated health concerns.
5655

57-
- AQI: USA air quality standard
58-
- CAQI: Europe air quality standard
56+
Two calculation standards are supported:
57+
58+
- **AQI** (US EPA Air Quality Index): The standard used in the United States, Canada, and parts of Asia. Scale of 0-500+.
59+
- **CAQI** (Common Air Quality Index): The European standard. Scale of 0-400.
60+
61+
Both calculation types take the PM2.5 and PM10 values and return the higher (more conservative) of the two calculated index values.
62+
63+
### AQI Scale (US EPA)
64+
65+
| Index | Level | Health Implications |
66+
|-------|-------|---------------------|
67+
| 0-50 | Good | Air quality is satisfactory |
68+
| 51-100 | Moderate | Acceptable; some pollutants may be a concern for sensitive individuals |
69+
| 101-150 | Unhealthy for Sensitive Groups | Members of sensitive groups may experience health effects |
70+
| 151-200 | Unhealthy | Everyone may begin to experience health effects |
71+
| 201-300 | Very Unhealthy | Health alert: everyone may experience more serious health effects |
72+
| 301-500 | Hazardous | Health warnings of emergency conditions |
73+
74+
### CAQI Scale (European)
75+
76+
| Index | Level | Health Implications |
77+
|-------|-------|---------------------|
78+
| 0-25 | Very Low | Air quality is excellent |
79+
| 26-50 | Low | Air quality is good |
80+
| 51-75 | Medium | Air quality is fair |
81+
| 76-100 | High | Air quality is poor |
82+
| 101-400 | Very High | Air quality is very poor |
83+
84+
### Configuration Example
5985

6086
```yaml
6187
sensor:
@@ -65,8 +91,13 @@ sensor:
6591
pm_10_0:
6692
name: "PM10.0"
6793
aqi:
68-
name: "AQI"
69-
calculation_type: "CAQI"
94+
name: "Air Quality Index"
95+
calculation_type: "CAQI" # or "AQI" for US EPA standard
96+
# Optional: Apply filters for smoother values
97+
filters:
98+
- sliding_window_moving_average:
99+
window_size: 10
100+
send_every: 1
70101
```
71102

72103
## See Also

‎content/components/sensor/pmsx003.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ sensor:
4141
name: "Particulate Matter <2.5µm Concentration"
4242
pm_10_0:
4343
name: "Particulate Matter <10.0µm Concentration"
44+
aqi:
45+
name: "Air Quality Index"
46+
calculation_type: "AQI"
4447
```
4548
4649
## Configuration variables
@@ -90,12 +93,69 @@ sensor:
9093
- **formaldehyde** (*Optional*): Use the formaldehyde (HCHO) concentration in µg per cubic meter for the `PMS5003S` and `PMS5003ST` type sensors.
9194
All options from [Sensor](/components/sensor).
9295

96+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured. See [Air Quality Index](#air-quality-index) below.
97+
98+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
99+
- All other options from [Sensor](/components/sensor).
100+
93101
- **update_interval** (*Optional*): Amount of time to wait between generating measurements. If this is longer than 30
94102
seconds, and if `tx_pin` is set in the UART configuration, the fan will be spun down between measurements. Default to `0s` (forward data as it's coming in from the sensor).
95103

96104
- **uart_id** (*Optional*, [ID](/guides/configuration-types#id)): Manually specify the ID of the [UART Component](/components/uart) if you want
97105
to use multiple UART buses.
98106

107+
## Air Quality Index
108+
109+
The AQI (Air Quality Index) sensor calculates an air quality index value based on the PM2.5 and PM10 particulate matter concentrations. This provides a single number that indicates overall air quality and associated health concerns.
110+
111+
Two calculation standards are supported:
112+
113+
- **AQI** (US EPA Air Quality Index): The standard used in the United States, Canada, and parts of Asia. Scale of 0-500+.
114+
- **CAQI** (Common Air Quality Index): The European standard. Scale of 0-400.
115+
116+
Both calculation types take the PM2.5 and PM10 values and return the higher (more conservative) of the two calculated index values.
117+
118+
### AQI Scale (US EPA)
119+
120+
| Index | Level | Health Implications |
121+
|-------|-------|---------------------|
122+
| 0-50 | Good | Air quality is satisfactory |
123+
| 51-100 | Moderate | Acceptable; some pollutants may be a concern for sensitive individuals |
124+
| 101-150 | Unhealthy for Sensitive Groups | Members of sensitive groups may experience health effects |
125+
| 151-200 | Unhealthy | Everyone may begin to experience health effects |
126+
| 201-300 | Very Unhealthy | Health alert: everyone may experience more serious health effects |
127+
| 301-500 | Hazardous | Health warnings of emergency conditions |
128+
129+
### CAQI Scale (European)
130+
131+
| Index | Level | Health Implications |
132+
|-------|-------|---------------------|
133+
| 0-25 | Very Low | Air quality is excellent |
134+
| 26-50 | Low | Air quality is good |
135+
| 51-75 | Medium | Air quality is fair |
136+
| 76-100 | High | Air quality is poor |
137+
| 101-400 | Very High | Air quality is very poor |
138+
139+
### Configuration Example
140+
141+
```yaml
142+
sensor:
143+
- platform: pmsx003
144+
type: PMSX003
145+
pm_2_5:
146+
name: "PM2.5"
147+
pm_10_0:
148+
name: "PM10"
149+
aqi:
150+
name: "Air Quality Index"
151+
calculation_type: "AQI" # or "CAQI" for European standard
152+
# Optional: Apply filters for smoother values
153+
filters:
154+
- sliding_window_moving_average:
155+
window_size: 15
156+
send_every: 1
157+
```
158+
99159
## See Also
100160

101161
- {{< docref "/components/sensor/sds011" >}}

0 commit comments

Comments
 (0)