Fix noise_floor bug

[EVA-2020-02-2.git] / library / README.rst

diff --git a/library/README.rst b/library/README.rst
index 72c7ff4af0a5907454b90fa52ed5448978673662..bd74b9d4095b0f24cd20a7d8521cd833c0daa07f 100644 (file)
--- a/library/README.rst
+++ b/library/README.rst
@@ -1,21 +1,71 @@
-Enviro pHAT Plus
-================
+Enviro+
+=======
+
+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

 
 |Build Status| |Coverage Status| |PyPi Package| |Python Versions|
 
 Installing
 ==========
 
 
 |Build Status| |Coverage Status| |PyPi Package| |Python Versions|
 
 Installing
 ==========
 

-Stable library from PyPi:
+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.
+
+One-line (Installs from GitHub)
+-------------------------------
+
+::

 
 

--  Just run ``sudo pip install enviroplus``
+    curl -sSL https://get.pimoroni.com/enviroplus | bash

 
 

-Latest/development library from GitHub:
+**Note** report issues with one-line installer here:
+https://github.com/pimoroni/get
+
+Or... Install and configure dependencies from GitHub:
+-----------------------------------------------------

 
 -  ``git clone https://github.com/pimoroni/enviroplus-python``
 -  ``cd enviroplus-python``
 -  ``sudo ./install.sh``
 
 
 -  ``git clone https://github.com/pimoroni/enviroplus-python``
 -  ``cd enviroplus-python``
 -  ``sudo ./install.sh``
 

+**Note** Raspbian Lite users may first need to install git:
+``sudo apt install git``
+
+Or... Install from PyPi and configure manually:
+-----------------------------------------------
+
+-  Run ``sudo pip install enviroplus``
+
+**Note** this wont perform any of the required configuration changes on
+your Pi, you may additionally need to:
+
+-  Enable i2c: ``raspi-config nonint do_i2c 0``
+-  Enable SPI: ``raspi-config nonint do_spi 0``
+
+And if you're using a PMS5003 sensor you will need to:
+
+-  Enable serial:
+   ``raspi-config nonint set_config_var enable_uart 1 /boot/config.txt``
+-  Disable serial terminal: ``sudo raspi-config nonint do_serial 1``
+-  Add ``dtoverlay=pi3-miniuart-bt`` to your ``/boot/config.txt``
+
+And install additional dependencies:
+
+::
+
+    sudo apt install python-numpy python-smbus python-pil python-setuptools
+
+Help & Support
+--------------
+
+-  GPIO Pinout - https://pinout.xyz/pinout/enviro\_plus
+-  Support forums - http://forums.pimoroni.com/c/support
+-  Discord - https://discord.gg/hr93ByC
+

 .. |Build Status| image:: https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master
    :target: https://travis-ci.com/pimoroni/enviroplus-python
 .. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master
 .. |Build Status| image:: https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master
    :target: https://travis-ci.com/pimoroni/enviroplus-python
 .. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master


@@ -24,3 +74,20 @@ Latest/development library from GitHub:
    :target: https://pypi.python.org/pypi/enviroplus
 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/enviroplus.svg
    :target: https://pypi.python.org/pypi/enviroplus
    :target: https://pypi.python.org/pypi/enviroplus
 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/enviroplus.svg
    :target: https://pypi.python.org/pypi/enviroplus

+
+0.0.3
+-----
+
+* Fix "self.noise_floor" bug in get_noise_profile
+
+0.0.2
+-----
+
+* Add support for extra ADC channel in Gas
+* Handle breaking change in new ltr559 library
+* Add Noise functionality
+
+0.0.1
+-----
+
+* Initial Release