Skip to content

Commit db2270a

Browse files
author
jas
committed
docs: Add AQI sensor documentation for all PM sensors
Add Air Quality Index (AQI) sensor support documentation for: - SDS011 - SPS30 - PMSA003I - PM2005/PM2105 - SEN5X - SM300D2 - GCJA5 The AQI sensor calculates air quality index values based on PM2.5 and PM10 concentrations using either US EPA AQI or European CAQI standards.
1 parent 2c2e3c3 commit db2270a

File tree

7 files changed

+56
-0
lines changed

7 files changed

+56
-0
lines changed

content/components/sensor/gcja5.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ sensor:
3030
name: "Particulate Matter <2.5µm Concentration"
3131
pm_10_0:
3232
name: "Particulate Matter <10.0µm Concentration"
33+
aqi:
34+
name: "Air Quality Index"
35+
calculation_type: "AQI"
3336
```
3437
3538
## Configuration variables
@@ -61,6 +64,11 @@ sensor:
6164
- **pmc_10_0** (*Optional*): Count of particles with diameter > 10 um in 0.1 L of air (#/0.1L).
6265
All options from [Sensor](/components/sensor).
6366
67+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
68+
69+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
70+
- All other options from [Sensor](/components/sensor).
71+
6472
## See Also
6573

6674
- {{< docref "/components/sensor/gcja5" >}}

content/components/sensor/pm2005.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ sensor:
2424
name: "PM2.5"
2525
pm_10_0:
2626
name: "PM10.0"
27+
aqi:
28+
name: "Air Quality Index"
29+
calculation_type: "AQI"
2730
```
2831
2932
## Configuration variables
@@ -44,6 +47,11 @@ sensor:
4447

4548
- All options from [Sensor](/components/sensor).
4649

50+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
51+
52+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
53+
- All other options from [Sensor](/components/sensor).
54+
4755
## See Also
4856

4957
- [Sensor Filters](/components/sensor#sensor-filters)

content/components/sensor/pmsa003i.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ sensor:
3838
name: "PMC >5µm"
3939
pmc_10_0:
4040
name: "PMC >10µm"
41+
aqi:
42+
name: "Air Quality Index"
43+
calculation_type: "CAQI"
4144
```
4245
4346
## Configuration variables
@@ -69,6 +72,11 @@ sensor:
6972
- **pmc_10_0** (*Optional*): Count of particles with diameter > 10 um in 0.1 L of air (#/0.1L).
7073
All options from [Sensor](/components/sensor).
7174
75+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
76+
77+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
78+
- All other options from [Sensor](/components/sensor).
79+
7280
- **standard_units** (*Optional*, boolean): `True` to use standard units or `False` to use environmental units. Defaults to `True`.
7381
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.
7482
Defaults to `0x12`.

content/components/sensor/sds011.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ sensor:
3030
name: "Particulate Matter <2.5µm Concentration"
3131
pm_10_0:
3232
name: "Particulate Matter <10.0µm Concentration"
33+
aqi:
34+
name: "Air Quality Index"
35+
calculation_type: "AQI"
3336
update_interval: 5min
3437
```
3538
@@ -51,6 +54,11 @@ Note that `update_interval` may not be set to `never`.
5154
- **pm_10_0** (*Optional*): Use the concentration of particulates of size less than 10.0µm in µg per cubic meter.
5255
All options from [Sensor](/components/sensor).
5356

57+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
58+
59+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
60+
- All other options from [Sensor](/components/sensor).
61+
5462
- **update_interval** (*Optional*, [Time](/guides/configuration-types#time)): The interval to check the sensor in minutes.
5563
This affects the working period of the SDS011 sensor. Defaults to `0min`.
5664

content/components/sensor/sen5x.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ sensor:
3232
name: PM <4µm Weight concentration
3333
pm_10_0:
3434
name: PM <10µm Weight concentration
35+
aqi:
36+
name: Air Quality Index
37+
calculation_type: "CAQI"
3538
temperature:
3639
name: Temperature
3740
humidity:
@@ -64,6 +67,11 @@ sensor:
6467
6568
- All options from [Sensor](/components/sensor).
6669
70+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
71+
72+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
73+
- All other options from [Sensor](/components/sensor).
74+
6775
- **auto_cleaning_interval** (*Optional*): Reads/Writes the interval in seconds of the periodic fan-cleaning.
6876

6977
- **temperature** (*Optional*): Temperature.Note only available with Sen54 or Sen55. The sensor will be ignored on

content/components/sensor/sm300d2.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ sensor:
4545
name: "SM300D2 PM2.5 Value"
4646
pm_10_0:
4747
name: "SM300D2 PM10 Value"
48+
aqi:
49+
name: "SM300D2 Air Quality Index"
50+
calculation_type: "AQI"
4851
temperature:
4952
name: "SM300D2 Temperature Value"
5053
humidity:
@@ -74,6 +77,11 @@ sensor:
7477
7578
- All options from [Sensor](/components/sensor).
7679
80+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
81+
82+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
83+
- All other options from [Sensor](/components/sensor).
84+
7785
- **temperature** (**Required**): The information for the temperature sensor. Readings in degrees celsius (°C).
7886

7987
- All options from [Sensor](/components/sensor).

content/components/sensor/sps30.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ sensor:
4848
pm_size:
4949
name: "Typical Particle size"
5050
id: "pm_size"
51+
aqi:
52+
name: "Air Quality Index"
53+
calculation_type: "AQI"
5154
address: 0x69
5255
update_interval: 10s
5356
```
@@ -94,6 +97,11 @@ sensor:
9497
9598
- All options from [Sensor](/components/sensor).
9699
100+
- **aqi** (*Optional*): Air Quality Index sensor. Requires both `pm_2_5` and `pm_10_0` sensors to be configured.
101+
102+
- **calculation_type** (**Required**): The AQI calculation standard to use. One of: `AQI` (US EPA) or `CAQI` (European).
103+
- All other options from [Sensor](/components/sensor).
104+
97105
- **auto_cleaning_interval** (*Optional*): The interval in seconds of the periodic fan-cleaning.
98106

99107
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.

0 commit comments

Comments
 (0)