README.md

   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 [![Build Status](https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/enviroplus-python)
   6 [![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=master)
   7 [![PyPi Package](https://img.shields.io/pypi/v/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
   8 [![Python Versions](https://img.shields.io/pypi/pyversions/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
   9
  10 # Installing
  11
  12 You're best using the git clone / install.sh method if you want all of the UART serial configuration for the PMS5003 particulate matter sensor to run automatically.
  13
  14 ## One-line (Installs from GitHub)
  15
  16 ```
  17 curl -sSL https://get.pimoroni.com/enviroplus | bash
  18 ```
  19
  20 **Note** report issues with one-line installer here: https://github.com/pimoroni/get
  21
  22 ## Or... Install and configure dependencies from GitHub:
  23
  24 * `git clone https://github.com/pimoroni/enviroplus-python`
  25 * `cd enviroplus-python`
  26 * `sudo ./install.sh`
  27
  28 **Note** Raspbian Lite users may first need to install git: `sudo apt install git`
  29
  30 ## Or... Install from PyPi and configure manually:
  31
  32 * Run `sudo pip install enviroplus`
  33
  34 **Note** this wont perform any of the required configuration changes on your Pi, you may additionally need to:
  35
  36 * Enable i2c: `raspi-config nonint do_i2c 0`
  37 * Enable SPI: `raspi-config nonint do_spi 0`
  38
  39 And if you're using a PMS5003 sensor you will need to:
  40
  41 * Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt`
  42 * Disable serial terminal: `sudo raspi-config nonint do_serial 1`
  43 * Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`
  44
  45 And install additional dependencies:
  46
  47 ```
  48 sudo apt install python-numpy python-smbus
  49 ```
  50
  51 ## Help & Support
  52
  53 * GPIO Pinout - https://pinout.xyz/pinout/enviro_plus
  54 * Support forums - http://forums.pimoroni.com/c/support
  55 * Discord - https://discord.gg/hr93ByC