Skip to content

adafruit/Adafruit_CircuitPython_PM25

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython library for PM2.5 Air Quality Sensors

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-pm25

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-pm25

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-pm25

Usage Example

For example usage, see examples/pm25_simpletest.py

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.