Skip to content

Commit

Permalink
Update README for 0.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Gadgetoid committed Mar 13, 2020
1 parent 6d6d3dd commit f8d8834
Showing 1 changed file with 71 additions and 13 deletions.
84 changes: 71 additions & 13 deletions library/README.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,87 @@
Enviro+ pHAT
============
Enviro+
=======

`Build Status <https://travis-ci.com/pimoroni/enviroplus-python>`__
`Coverage
Status <https://coveralls.io/github/pimoroni/enviroplus-python?branch=master>`__
`PyPi Package <https://pypi.python.org/pypi/enviroplus>`__ `Python
Versions <https://pypi.python.org/pypi/enviroplus>`__
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
==========

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

(**Note** that you’re best using the git clone / install.sh method below
if you want all of the UART serial configuration for the PMS5003
particulate matter sensor to run automatically)
**Note** report issues with one-line installer here:
https://github.com/pimoroni/get

Latest/development library from GitHub:
Or... Install and configure dependencies from GitHub:
-----------------------------------------------------

- ``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
:target: https://coveralls.io/github/pimoroni/enviroplus-python?branch=master
.. |PyPi Package| image:: https://img.shields.io/pypi/v/enviroplus.svg
: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.2
-----

* Add support for extra ADC channel in Gas
* Handle breaking change in new ltr559 library
* Add Noise functionality

0.0.1
-----

Expand Down

0 comments on commit f8d8834

Please sign in to comment.