-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,20 @@ | ||
# AirMonitor | ||
A python program that sends emails when the AQI has passed a specified threshold | ||
A python program that sends emails when the AQI has passed a specified threshold. | ||
|
||
Tested with an sds011 sensor on a raspberry pi zero w. | ||
|
||
More information on the sensor can be found here: https://aqicn.org/sensor/sds011/ | ||
|
||
**Dependencies** | ||
- Python | ||
- python-aqi (install via pip) | ||
- pyserial (install via pip) | ||
|
||
**Usage** | ||
1. Plug the air monitor in a usb port | ||
2. Confirm that the usb device in the airMonitor.py is correct, and change if needed. | ||
3. Configure email settings. (emailPassword, emailSender, smtpServer, emailPort, emailReceiver) | ||
4. Configure other settings as needed. (emailTimeout, aqiThreshold) | ||
5. Install dependencies `pip install python-aqi pyserial` | ||
6. Mark the program as executable `chmod +x airMonitor.py`. (Note: skip this step on windows) | ||
7. Run airMonitor.py `./airMonitor.py`. (Note: on windows run `python airMonitor.py`) |