Adafruit PMSA003I Air Quality Breakout
Created by Kattni Rembor
https://learn.adafruit.com/pmsa003i
Last updated on 2021-11-15 08:06:05 PM EST
©Adafruit Industries Page 1 of 18
Table of Contents
Overview
Pinouts
• Power Pins
• I2C Logic Pins
• Other Pins
Arduino
• I2C Wiring
• Library Installation
• Load Example
• Example Code
Arduino Docs
Python & CircuitPython
• CircuitPython Microcontroller Wiring
• Python Computer Wiring
• CircuitPython Installation of PM25 Library
• Python Installation of PM25 Library
• CircuitPython & Python Usage
3
6
6
7
7
7
7
8
9
9
11
11
11
12
13
14
14
Python Docs
Downloads
• Files
• Schematic
• Fab Print
16
16
16
17
18
©Adafruit Industries Page 2 of 18
Overview
Breathe easy, knowing that you can track and sense the quality of the air around you
with thisAdafruit PMSA003I Air Quality Breakout. This sensor is great for monitoring
air quality, in a compact plug-in format.
Best of all, unlike almost all other sensors we've seen that are UART interface, this
one has an I2C interface, which makes it a great match for single board Linux
computers like Raspberry Pi, or even plain Arduino UNO's that normally would use
software serial.
©Adafruit Industries Page 3 of 18
If you're an I2C fan (who isn't?), we've included two of our handy dandy SparkFun
Qwiic(https://adafru.it/Fpw)compatibleSTEMMA QT(https://adafru.it/Ft4)connectors
for the I2C busso you don't even need to solder! Plug and play with other 'QT boards
and sensors to add quick air quality sensing.
This sensor uses laser scattering to radiate suspending particles in the air, then
collects scattering light to obtain the curve of scattering light change with time. The
microprocessor calculates equivalent particle diameter and the number of particles
with different diameters per unit volume.
The I2C data stream updates once per second, you'll get:
PM1.0, PM2.5 and PM10.0 concentration in both standard & environmental units
•
Particulate matter per 0.1L air, categorized into 0.3um, 0.5um, 1.0um, 2.5um,
•
5.0um and 10um size bins
As well as checksum, in binary format.
Each order comes with one fully assembled sensor module breakout, including some
header if you'd like to solder it to a breadboard. The breakout board has a 5V mini
boost circuit so you can power it from 3.3V and 5V and the motor fan inside the
sensor will run just fine
Lastly, it wouldn't be an Adafruit breakout if it didn't come withlibraries for Arduino(h
ttps://adafru.it/Mb5) and CircuitPython & Python(https://adafru.it/Mb6)that will read
and checksum data, and print it out in human-readable format.
©Adafruit Industries Page 4 of 18
©Adafruit Industries Page 5 of 18
Pinouts
Power Pins
Vin - this is the power pin. Since the sensor chip uses 3 VDC, we have included
•
a voltage regulator on board that will take 3-5VDC and safely convert it down.
To power the board, give it the same power as the logic level of your
microcontroller - e.g. for a 5V microcontroller like Arduino, use 5V
3Vo - this is the 3.3V output from the voltage regulator, you can grab up to
•
100mA from this if you like
GND - common ground for power and logic
•
©Adafruit Industries Page 6 of 18
I2C Logic Pins
SCL - I2C clock pin, connect to your microcontroller I2C clock line. On the
•
breakouts, this pin is level shifted so you can use 3-5V logic. There's a 10K
pullup on this pin.
SDA - I2C data pin, connect to your microcontroller I2C data line.
•
On the breakouts, this pin is level shifted so you can use 3-5V logic. There's a 10
•
K pullup on this pin.
STEMMA QT(https://adafru.it/Ft4)- These connectors allow you to make I2C
•
connections to dev boards with STEMMA QT connectors or to other things
withvarious associated accessories(https://adafru.it/Ft6).
Other Pins
RST - Module signal reset. Reset low.
•
SET - Set pin. High when working status, low level is sleeping mode.
•
Arduino
Using the PMSA300I with Arduino is a simple matter of wiring up it to your Arduino-
compatible microcontroller, installing the Adafruit PM25AQI(https://adafru.it/Mej)
library we've written, and running the provided example code.
I2C Wiring
Wiring the PMSA300I is made simple by using the I2C interface either via the
STEMMA QT connector or a solderless breadboard.
©Adafruit Industries Page 7 of 18
ConnectPMSA300I VCC (red wire)
•
toArduino 5Vif you are running a
5V board Arduino (Uno, etc.).If your
board is 3V, connect to that instead.
Connect PMSA300I GND (black
•
wire) toArduino GND
Connect PMSA300I SCL (yellow
•
wire) toArduino SCL
Connect PMSA300I SDA (blue wire)
•
toArduino SDA
Library Installation
You can install the Adafruit PM25AQI(https://adafru.it/Mej) library for Arduino using
the Library Manager in the Arduino IDE.
Click theManage Libraries ... menu item, search for Adafruit PM25 AQI,and select
theAdafruit PM25 AQI library:
©Adafruit Industries Page 8 of 18
Follow the same process for the Adafruit BusIOlibrary.
Load Example
Open upFile -> Examples -> Adafruit PM25 AQI Sensor -> PM25_test
After opening the demo file, upload to your Arduino wired up to the sensor. Once you
upload the code, you will see the air quality data being printed when you open the
Serial Monitor (Tools->Serial Monitor) at 115200 baud, similar to this:
Example Code
/* Test sketch for Adafruit PM2.5 sensor with UART or I2C */
#include "Adafruit_PM25AQI.h"
// If your PM2.5 is UART only, for UNO and others (without hardware serial)
// we must use software serial...
// pin #2 is IN from sensor (TX pin on sensor), leave pin #3 disconnected
// comment these two lines if using hardware serial
//#include <SoftwareSerial.h>
//SoftwareSerial pmSerial(2, 3);
Adafruit_PM25AQI aqi = Adafruit_PM25AQI();
©Adafruit Industries Page 9 of 18
void setup() {
// Wait for serial monitor to open
Serial.begin(115200);
while (!Serial) delay(10);
Serial.println("Adafruit PMSA003I Air Quality Sensor");
// Wait one second for sensor to boot up!
delay(1000);
// If using serial, initialize it and set baudrate before starting!
// Uncomment one of the following
//Serial1.begin(9600);
//pmSerial.begin(9600);
// There are 3 options for connectivity!
if (! aqi.begin_I2C()) { // connect to the sensor over I2C
//if (! aqi.begin_UART(&Serial1)) { // connect to the sensor over hardware serial
//if (! aqi.begin_UART(&pmSerial)) { // connect to the sensor over software
serial
Serial.println("Could not find PM 2.5 sensor!");
while (1) delay(10);
}
Serial.println("PM25 found!");
}
void loop() {
PM25_AQI_Data data;
if (! aqi.read(&data)) {
Serial.println("Could not read from AQI");
delay(500); // try again in a bit!
return;
}
Serial.println("AQI reading success");
Serial.println();
Serial.println(F("---------------------------------------"));
Serial.println(F("Concentration Units (standard)"));
Serial.println(F("---------------------------------------"));
Serial.print(F("PM 1.0: ")); Serial.print(data.pm10_standard);
Serial.print(F("\t\tPM 2.5: ")); Serial.print(data.pm25_standard);
Serial.print(F("\t\tPM 10: ")); Serial.println(data.pm100_standard);
Serial.println(F("Concentration Units (environmental)"));
Serial.println(F("---------------------------------------"));
Serial.print(F("PM 1.0: ")); Serial.print(data.pm10_env);
Serial.print(F("\t\tPM 2.5: ")); Serial.print(data.pm25_env);
Serial.print(F("\t\tPM 10: ")); Serial.println(data.pm100_env);
Serial.println(F("---------------------------------------"));
Serial.print(F("Particles > 0.3um / 0.1L air:"));
Serial.println(data.particles_03um);
Serial.print(F("Particles > 0.5um / 0.1L air:"));
Serial.println(data.particles_05um);
Serial.print(F("Particles > 1.0um / 0.1L air:"));
Serial.println(data.particles_10um);
Serial.print(F("Particles > 2.5um / 0.1L air:"));
Serial.println(data.particles_25um);
Serial.print(F("Particles > 5.0um / 0.1L air:"));
Serial.println(data.particles_50um);
Serial.print(F("Particles > 10 um / 0.1L air:"));
Serial.println(data.particles_100um);
Serial.println(F("---------------------------------------"));
delay(1000);
}
©Adafruit Industries Page 10 of 18
Arduino Docs
Arduino Docs(https://adafru.it/MdQ)
Python & CircuitPython
It's easy to use the PMSA300I and the Adafruit CircuitPython PM25(https://adafru.it/
Mek) module. This library allows you to easily write Python code that reads particle
concentrations, and particle diameter and the number of particles with different
diameters per unit volume.
You can use this sensor with any CircuitPython microcontroller board or with a
computer that has GPIO and Python thanks to Adafruit_Blinka, our CircuitPython-for-
Python compatibility library(https://adafru.it/BSN).
CircuitPython Microcontroller Wiring
Wire up a PMSA300I to your board exactly as shown below. Here's an example of
wiring a Feather M4 to the sensor with I2C using STEMMA QT and a solderless
breadboard.
©Adafruit Industries Page 11 of 18
Board 3V to PMSA300I VIN (red
•
wire)
Board GND toPMSA300I GND
•
(black wire)
Board SCL toPMSA300I SCL
•
(yellow wire)
Board SDA toPMSA300I SDA (blue
•
wire)
Python Computer Wiring
Since there's dozens of Linux computers/boards you can use, we will show wiring for
Raspberry Pi. For other platforms, please visit the guide for CircuitPython on Linux to
see whether your platform is supported(https://adafru.it/BSN).
Here's the Raspberry Pi wired to the sensor with I2C using STEMMA QT and a
solderless breadboard.
©Adafruit Industries Page 12 of 18
Pi 3V toPMSA300I VIN (red wire)
•
Pi GND toPMSA300I GND (black
•
wire)
Pi SCL toPMSA300I SCL (yellow
•
wire)
Pi SDA toPMSA300I SDA (blue
•
wire)
CircuitPython Installation of PM25 Library
You'll need to install the Adafruit CircuitPython PM25(https://adafru.it/Mek) library on
your CircuitPython board.
First make sure you are running thelatest version of Adafruit CircuitPython(https://
adafru.it/Amd)for your board.
Next you'll need to install the necessary librariesto use the hardware--carefully follow
the steps to find and install these libraries fromAdafruit's CircuitPython library bundle
(https://adafru.it/ENC).
Our CircuitPython starter guide has a great page on how to install libraries from the
bundle(https://adafru.it/ABU).
Load the the following libraries into the lib folder on your CIRCUITPY drive:
adafruit_pm25
•
adafruit_bus_device
•
©Adafruit Industries Page 13 of 18
Before continuing make sure your board's lib folder or root filesystem has the adafrui
t_pm25.mpy file and adafruit_bus_device foldercopied over.
Nextconnect to the board's serial console(https://adafru.it/Bec)so you are ready to
see the example output.
Python Installation of PM25 Library
You'll need to install the Adafruit_Blinka(https://adafru.it/BJX) library that provides the
CircuitPython support in Python. This may also require enabling I2C on your platform
and verifying you are running Python 3.
Since each platform is a little different, and Linux changes often, please visit the
CircuitPython on Linux guide to get your computer ready(https://adafru.it/BSN)!
Once that's done, from your command line run the following command:
pip3 install adafruit-circuitpython-pm25
If your default Python is version 3 you may need to run 'pip' instead. Just make sure
you aren't trying to use CircuitPython on Python 2.x, it isn't supported!
CircuitPython & Python Usage
To demonstrate the usage of the PMSA300I, we'll use a complete code example to
read the particle data.
Save the following code to your CIRCUITPY drive as code.py:
# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
# SPDX-License-Identifier: MIT
"""
Example sketch to connect to PM2.5 sensor with either I2C or UART.
"""
# pylint: disable=unused-import
import time
import board
import busio
from digitalio import DigitalInOut, Direction, Pull
from adafruit_pm25.i2c import PM25_I2C
reset_pin = None
# If you have a GPIO, its not a bad idea to connect it to the RESET pin
# reset_pin = DigitalInOut(board.G0)
©Adafruit Industries Page 14 of 18
# reset_pin.direction = Direction.OUTPUT
# reset_pin.value = False
# For use with a computer running Windows:
# import serial
# uart = serial.Serial("COM30", baudrate=9600, timeout=1)
# For use with microcontroller board:
# (Connect the sensor TX pin to the board/computer RX pin)
# uart = busio.UART(board.TX, board.RX, baudrate=9600)
# For use with Raspberry Pi/Linux:
# import serial
# uart = serial.Serial("/dev/ttyS0", baudrate=9600, timeout=0.25)
# For use with USB-to-serial cable:
# import serial
# uart = serial.Serial("/dev/ttyUSB0", baudrate=9600, timeout=0.25)
# Connect to a PM2.5 sensor over UART
# from adafruit_pm25.uart import PM25_UART
# pm25 = PM25_UART(uart, reset_pin)
# Create library object, use 'slow' 100KHz frequency!
i2c = busio.I2C(board.SCL, board.SDA, frequency=100000)
# Connect to a PM2.5 sensor over I2C
pm25 = PM25_I2C(i2c, reset_pin)
print("Found PM2.5 sensor, reading data...")
while True:
time.sleep(1)
try:
aqdata = pm25.read()
# print(aqdata)
except RuntimeError:
print("Unable to read from sensor, retrying...")
continue
print()
print("Concentration Units (standard)")
print("---------------------------------------")
print(
"PM 1.0: %d\tPM2.5: %d\tPM10: %d"
% (aqdata["pm10 standard"], aqdata["pm25 standard"], aqdata["pm100
standard"])
)
print("Concentration Units (environmental)")
print("---------------------------------------")
print(
"PM 1.0: %d\tPM2.5: %d\tPM10: %d"
% (aqdata["pm10 env"], aqdata["pm25 env"], aqdata["pm100 env"])
)
print("---------------------------------------")
print("Particles > 0.3um / 0.1L air:", aqdata["particles 03um"])
print("Particles > 0.5um / 0.1L air:", aqdata["particles 05um"])
print("Particles > 1.0um / 0.1L air:", aqdata["particles 10um"])
print("Particles > 2.5um / 0.1L air:", aqdata["particles 25um"])
print("Particles > 5.0um / 0.1L air:", aqdata["particles 50um"])
print("Particles > 10 um / 0.1L air:", aqdata["particles 100um"])
print("---------------------------------------")
If you haven't already, connect to the serial console to see the example output.
©Adafruit Industries Page 15 of 18
That's all there is to reading air quality data from the PSMA300I!
Python Docs
Python Docs(https://adafru.it/MdP)
Downloads
Files
PMSA003I datasheet(https://adafru.it/Mb2)
•
EagleCAD files on GitHub(https://adafru.it/Mb3)
•
3D Models on GitHub(https://adafru.it/ODr)
•
Fritzing object in Adafruit Fritzing Library(https://adafru.it/Mb4)
•
©Adafruit Industries Page 16 of 18
Schematic
©Adafruit Industries Page 17 of 18
Fab Print
©Adafruit Industries Page 18 of 18
Loading...