library/README.rst

   1 Enviro+
   2 =======
   3
   4 Designed for environmental monitoring, Enviro+ lets you measure air
   5 quality (pollutant gases and particulates), temperature, pressure,
   6 humidity, light, and noise level. Learn more -
   7 https://shop.pimoroni.com/products/enviro-plus
   8
   9 |Build Status| |Coverage Status| |PyPi Package| |Python Versions|
  10
  11 Installing
  12 ==========
  13
  14 You're best using the "One-line" install method if you want all of the
  15 UART serial configuration for the PMS5003 particulate matter sensor to
  16 run automatically.
  17
  18 One-line (Installs from GitHub)
  19 -------------------------------
  20
  21 ::
  22
  23     curl -sSL https://get.pimoroni.com/enviroplus | bash
  24
  25 **Note** report issues with one-line installer here:
  26 https://github.com/pimoroni/get
  27
  28 Or... Install and configure dependencies from GitHub:
  29 -----------------------------------------------------
  30
  31 -  ``git clone https://github.com/pimoroni/enviroplus-python``
  32 -  ``cd enviroplus-python``
  33 -  ``sudo ./install.sh``
  34
  35 **Note** Raspbian Lite users may first need to install git:
  36 ``sudo apt install git``
  37
  38 Or... Install from PyPi and configure manually:
  39 -----------------------------------------------
  40
  41 -  Run ``sudo pip install enviroplus``
  42
  43 **Note** this wont perform any of the required configuration changes on
  44 your Pi, you may additionally need to:
  45
  46 -  Enable i2c: ``raspi-config nonint do_i2c 0``
  47 -  Enable SPI: ``raspi-config nonint do_spi 0``
  48
  49 And if you're using a PMS5003 sensor you will need to:
  50
  51 -  Enable serial:
  52    ``raspi-config nonint set_config_var enable_uart 1 /boot/config.txt``
  53 -  Disable serial terminal: ``sudo raspi-config nonint do_serial 1``
  54 -  Add ``dtoverlay=pi3-miniuart-bt`` to your ``/boot/config.txt``
  55
  56 And install additional dependencies:
  57
  58 ::
  59
  60     sudo apt install python-numpy python-smbus python-pil python-setuptools
  61
  62 Help & Support
  63 --------------
  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
  68
  69 .. |Build Status| image:: https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master
  70    :target: https://travis-ci.com/pimoroni/enviroplus-python
  71 .. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master
  72    :target: https://coveralls.io/github/pimoroni/enviroplus-python?branch=master
  73 .. |PyPi Package| image:: https://img.shields.io/pypi/v/enviroplus.svg
  74    :target: https://pypi.python.org/pypi/enviroplus
  75 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/enviroplus.svg
  76    :target: https://pypi.python.org/pypi/enviroplus
  77
  78 0.0.3
  79 -----
  80
  81 * Fix "self.noise_floor" bug in get_noise_profile
  82
  83 0.0.2
  84 -----
  85
  86 * Add support for extra ADC channel in Gas
  87 * Handle breaking change in new ltr559 library
  88 * Add Noise functionality
  89
  90 0.0.1
  91 -----
  92
  93 * Initial Release