PMS5003 Particulate Sensor

Installing

Note The code in this repository supports both the Enviro+ and Enviro Mini boards. The Enviro Mini board does not have the Gas sensor or the breakout for the PM sensor.

:warning: This library now supports Python 3 only, Python 2 is EOL - https://www.python.org/doc/sunset-python-2/

Install and configure dependencies from GitHub:

• git clone https://github.com/pimoroni/pms5003-python
• cd pms5003-python
• ./install.sh

Note Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:

source ~/.virtualenvs/pimoroni/bin/activate

Note Raspbian/Raspberry Pi OS Lite users may first need to install git: sudo apt install git

Or... Install from PyPi and configure manually:

• python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni
• Run python3 -m pip install pms5003

Note this will not perform any of the required configuration changes on your Pi, you may additionally need to:

Bookworm

• Enable serial: raspi-config nonint do_serial_hw 0
• Disable serial terminal: raspi-config nonint do_serial_cons 1
• Add dtoverlay=pi3-miniuart-bt to your /boot/config.txt

Bullseye

• Enable serial: raspi-config nonint set_config_var enable_uart 1 /boot/config.txt
• Disable serial terminal: sudo raspi-config nonint do_serial 1
• Add dtoverlay=pi3-miniuart-bt to your /boot/config.txt

In both cases the last line will switch Bluetooth over to miniUART, see https://www.raspberrypi.org/documentation/configuration/uart.md for more details.

1.0.1

• Remove platform detection and default to Pi-compatible pins
• Support passing in LineRequest and offset for custom pins (supported in gpiodevice>=0.0.4)

1.0.0

• Repackage to hatch/pyproject.toml
• Port to gpiod/gpiodevice (away from RPi.GPIO)

0.0.5

• BugFix: Read start-of-frame a byte at a time to avoid misalignment issues, potential fix for #2, #3 and #4
• Enhancement: Clarified error message when length packet cannot be read
• Enhancement: Clarified error message when start of frame cannot be read
• Enhancement: Added new error message where raw data length is less than expected (frame length)

0.0.4

• Packaging improvements/bugfix from boilerplate

0.0.3

• Added pyserial dependency

0.0.2

• Added reset function

0.0.1

• Initial Release