Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Sensirion SPS30 documentation #4817

Open
wants to merge 4 commits into
base: current
Choose a base branch
from
Open

Improve Sensirion SPS30 documentation #4817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b27f0b9
Correct wrong SPS30 wiring diagram
SaturnusDJ Apr 12, 2025
57e12e6
Correct wrong SPS30 wiring text
SaturnusDJ Apr 12, 2025
f6fbc64
Extend SPS30 manual fan clean text
SaturnusDJ Apr 12, 2025
cf816d9
Extend SPS30 wiring text
SaturnusDJ Apr 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified components/sensor/images/sps30-wiring.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 23 additions & 6 deletions components/sensor/sps30.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,19 @@ Configuration variables:
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.

Wiring:
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>`__)
To force the sensor into I²C mode, the SEL pin (Interface Select pin no.5) should be shorted to ground (pin no.4)
To force the sensor into I²C mode, the SEL pin (Interface Select, pin no.4) should be shorted to ground (pin no.5)

.. figure:: images/sps30-wiring.png
:align: center
:width: 50.0%

For better stability, the SDA and SCL lines require suitable pull-up resistors.
For better stability, the SDA and SCL lines require suitable pull-up resistors. Sensirion shows 10 kΩ resistors between VDD (5V, pin no.1) and SDA (pin no.2) and SCL (pin no.3) in the manual.

Automatic Cleaning:
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.
Expand All @@ -126,8 +126,8 @@ Disabling of automatic-cleaning or setting a manual interval is not supported at

.. _sps30_start_autoclean_fan_action:

``sps30.start_fan_autoclean`` Action
------------------------------------
Manual Cleaning
---------------

This :ref:`action <config-action>` manually starts fan-cleaning.

Expand All @@ -137,6 +137,23 @@ This :ref:`action <config-action>` manually starts fan-cleaning.
then:
- sps30.start_fan_autoclean: my_sps30

To be able to trigger the fan cleaning feature from Home Assistant, add a button as shown below, and trigger it with a (periodic) automation.

.. code-block:: yaml

button:
- platform: template
name: "SPS30 fan clean"
on_press:
then:
- sps30.start_fan_autoclean: my_sps30

sensor:
- platform: sps30
id: "my_sps30"
...

Sensirion recommends cleaning at least once per week.

See Also
--------
Expand Down
Loading