| 1 | # Enviro+ |
| 2 | |
| 3 | Designed for environmental monitoring, Enviro+ lets you measure air quality (pollutant gases and particulates), temperature, pressure, humidity, light, and noise level. Learn more - https://shop.pimoroni.com/products/enviro-plus |
| 4 | |
| 5 | |
| 6 | [![Build Status](https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/enviroplus-python) |
| 7 | [![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=master) |
| 8 | [![PyPi Package](https://img.shields.io/pypi/v/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus) |
| 9 | [![Python Versions](https://img.shields.io/pypi/pyversions/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus) |
| 10 | |
| 11 | # Installing |
| 12 | |
| 13 | You're best using the "One-line" install method if you want all of the UART serial configuration for the PMS5003 particulate matter sensor to run automatically. |
| 14 | |
| 15 | **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._ |
| 16 | |
| 17 | ![Enviro Plus pHAT](./Enviro-Plus-pHAT.jpg) |
| 18 | ![Enviro Mini pHAT](./Enviro-mini-pHAT.jpg) |
| 19 | |
| 20 | ## One-line (Installs from GitHub) |
| 21 | |
| 22 | ``` |
| 23 | curl -sSL https://get.pimoroni.com/enviroplus | bash |
| 24 | ``` |
| 25 | |
| 26 | **Note** report issues with one-line installer here: https://github.com/pimoroni/get |
| 27 | |
| 28 | ## Or... Install and configure dependencies from GitHub: |
| 29 | |
| 30 | * `git clone https://github.com/pimoroni/enviroplus-python` |
| 31 | * `cd enviroplus-python` |
| 32 | * `sudo ./install.sh` |
| 33 | |
| 34 | **Note** Raspbian Lite users may first need to install git: `sudo apt install git` |
| 35 | |
| 36 | ## Or... Install from PyPi and configure manually: |
| 37 | |
| 38 | * Run `sudo pip install enviroplus` |
| 39 | |
| 40 | **Note** this wont perform any of the required configuration changes on your Pi, you may additionally need to: |
| 41 | |
| 42 | * Enable i2c: `raspi-config nonint do_i2c 0` |
| 43 | * Enable SPI: `raspi-config nonint do_spi 0` |
| 44 | |
| 45 | And if you're using a PMS5003 sensor you will need to: |
| 46 | |
| 47 | * Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt` |
| 48 | * Disable serial terminal: `sudo raspi-config nonint do_serial 1` |
| 49 | * Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt` |
| 50 | |
| 51 | And install additional dependencies: |
| 52 | |
| 53 | ``` |
| 54 | sudo apt install python-numpy python-smbus python-pil python-setuptools |
| 55 | ``` |
| 56 | |
| 57 | ## Alternate Software & User Projects |
| 58 | |
| 59 | * enviro monitor - https://github.com/roscoe81/enviro-monitor |
| 60 | * mqtt-all - https://github.com/robmarkcole/rpi-enviro-mqtt - now upstream: [see examples/mqtt-all.py](examples/mqtt-all.py) |
| 61 | * adafruit_io.py - https://github.com/dedSyn4ps3/enviroplus-python/blob/master/examples/adafruit_io.py - uses Adafruit Blinka and BME280 libraries to publish to Adafruit IO |
| 62 | |
| 63 | ## Help & Support |
| 64 | |
| 65 | * GPIO Pinout - https://pinout.xyz/pinout/enviro_plus |
| 66 | * Support forums - http://forums.pimoroni.com/c/support |
| 67 | * Discord - https://discord.gg/hr93ByC |