2019-12-04 12:34:14 +01:00
SPS30 Particulate Matter Sensor
===============================
.. seo ::
:description: Instructions for setting up SPS30 PM1.0, PM2.5, PM4, PM10 Particulate Matter sensors
:image: sps30.jpg
2021-05-19 22:17:39 +02:00
The `` sps30 `` sensor platform allows you to use your Sensirion SPS30
(`datasheet <https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9.6_Particulate_Matter/Datasheets/Sensirion_PM_Sensors_Datasheet_SPS30.pdf> `__ ) sensors with ESPHome.
2019-12-04 12:34:14 +01:00
The :ref: `I²C Bus <i2c>` is required to be set up in your configuration for this sensor to work.
This sensor supports both UART and I²C communication. However, at the moment only I²C communication is implemented.
.. _Sparkfun: https://www.sparkfun.com/products/15103
.. figure :: images/sensirion-pm.png
:align: center
:width: 50.0%
.. code-block :: yaml
# Example configuration entry
sensor:
- platform: sps30
pm_1_0:
name: "Workshop PM <1µm Weight concentration"
id: "workshop_PM_1_0"
pm_2_5:
name: "Workshop PM <2.5µm Weight concentration"
id: "workshop_PM_2_5"
pm_4_0:
name: "Workshop PM <4µm Weight concentration"
id: "workshop_PM_4_0"
pm_10_0:
name: "Workshop PM <10µm Weight concentration"
id: "workshop_PM_10_0"
pmc_0_5:
name: "Workshop PM <0.5µm Number concentration"
id: "workshop_PMC_0_5"
pmc_1_0:
name: "Workshop PM <1µm Number concentration"
id: "workshop_PMC_1_0"
pmc_2_5:
name: "Workshop PM <2.5µm Number concentration"
id: "workshop_PMC_2_5"
pmc_4_0:
name: "Workshop PM <4µm Number concentration"
id: "workshop_PMC_4_0"
pmc_10_0:
name: "Workshop PM <10µm Number concentration"
id: "workshop_PMC_10_0"
address: 0x69
update_interval: 10s
Configuration variables:
------------------------
- **pm_1_0** (*Optional* ): The information for the **Weight Concentration** sensor for fine particles up to 1μm. Readings in µg/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pm_2_5** (*Optional* ): The information for the **Weight Concentration** sensor for fine particles up to 2.5μm. Readings in µg/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pm_4_0** (*Optional* ): The information for the **Weight Concentration** sensor for coarse particles up to 4μm. Readings in µg/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pm_10_0** (*Optional* ): The information for the **Weight Concentration** sensor for coarse particles up to 10μm. Readings in µg/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pmc_0_5** (*Optional* ): The information for the **Number Concentration** sensor for ultrafine particles up to 0.5μm. Readings in particles/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pmc_1_0** (*Optional* ): The information for the **Number Concentration** sensor for fine particles up to 1μm. Readings in particles/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pmc_2_5** (*Optional* ): The information for the **Number Concentration** sensor for fine particles up to 2.5μm. Readings in particles/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pmc_4_0** (*Optional* ): The information for the **Number Concentration** sensor for coarse particles up to 4μm. Readings in particles/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
- **pmc_10_0** (*Optional* ): The information for the **Number Concentration** sensor for coarse particles up to 10μm. Readings in particles/m³.
- **name** (**Required** , string): The name for this sensor.
- **id** (*Optional* , :ref: `config-id` ): Set the ID of this sensor for use in lambdas.
- All other options from :ref: `Sensor <config-sensor>` .
2020-11-09 02:22:55 +01:00
- **address** (*Optional* , int): Manually specify the I²C address of the sensor.
2019-12-04 12:34:14 +01:00
Defaults to `` 0x69 `` .
- **update_interval** (*Optional* , :ref: `config-time` ): The interval to check the
sensor. Defaults to `` 60s `` .
Wiring:
-------
The sensor has a 5 pin JST ZHR type connector, with a 1.5mm pitch. (`Matching connector housing <https://octopart.com/zhr-5-jst-279203> `__ , `datasheet <http://www.farnell.com/datasheets/1393424.pdf> `__ )
2021-01-24 10:20:03 +01:00
To force the sensor into I²C mode, the SEL pin (Interface Select pin no.5) should be shorted to ground (pin no.4)
2019-12-04 12:34:14 +01:00
.. figure :: images/sps30-wiring.png
:align: center
:width: 50.0%
For better stability, the SDA and SCL lines require suitable pull-up resistors.
Automatic Cleaning:
-------------------
The SPS30 sensor has an automatic fan-cleaning which will accelerate the built-in fan to maximum speed for 10 seconds in order to blow out the dust accumulated inside the fan.
The default automatic-cleaning interval is 168 hours (1 week) of uninterrupted use. Switching off the sensor resets this time counter.
Disabling of automatic-cleaning or setting a manual interval is not supported at the moment.
See Also
--------
- :ref: `sensor-filters`
- :doc: `sds011`
- :doc: `pmsx003`
- :doc: `ccs811`
- :doc: `sgp30`
- :apiref: `sps30/sps30.h`
- :ghedit: `Edit`
