X-Git-Url: https://zdv2.bktei.com/gitweb/EVA-2020-02-2.git/blobdiff_plain/a862bb9473fbe8ec4a3b62d1e9b6f7a967b337ee..699a70ff4e39eb4d2fd56a4499a5fd938db7f265:/README.md?ds=inline diff --git a/README.md b/README.md index adb7dbe..4bce5f5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# Enviro+ pHAT +# 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](https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/enviroplus-python) [![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=master) @@ -7,7 +10,12 @@ # Installing -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. +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. + +**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._ + +![Enviro Plus pHAT](./Enviro-Plus-pHAT.jpg) +![Enviro Mini pHAT](./Enviro-mini-pHAT.jpg) ## One-line (Installs from GitHub) @@ -43,5 +51,20 @@ And if you're using a PMS5003 sensor you will need to: And install additional dependencies: ``` -sudo apt install python-numpy python-smbus +sudo apt install python-numpy python-smbus python-pil python-setuptools ``` + +## Alternate Software & User Projects + +* enviro monitor - https://github.com/roscoe81/enviro-monitor +* mqtt-all - https://github.com/robmarkcole/rpi-enviro-mqtt - now upstream: [see examples/mqtt-all.py](examples/mqtt-all.py) +* 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 +* enviroplus_exporter - https://github.com/tijmenvandenbrink/enviroplus_exporter - Prometheus exporter (with added support for Luftdaten and InfluxDB Cloud) +* homekit-enviroplus - https://github.com/sighmon/homekit-enviroplus - An Apple HomeKit accessory for the Pimoroni Enviro+ +* go-enviroplus - https://github.com/rubiojr/go-enviroplus - Go modules to read Enviro+ sensors + +## Help & Support + +* GPIO Pinout - https://pinout.xyz/pinout/enviro_plus +* Support forums - http://forums.pimoroni.com/c/support +* Discord - https://discord.gg/hr93ByC