Update README install instructions
[EVA-2020-02-2.git] / README.md
... / ...
CommitLineData
1# Enviro+ pHAT
2
3[![Build Status](https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master)](https://travis-ci.com/pimoroni/enviroplus-python)
4[![Coverage Status](https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/enviroplus-python?branch=master)
5[![PyPi Package](https://img.shields.io/pypi/v/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
6[![Python Versions](https://img.shields.io/pypi/pyversions/enviroplus.svg)](https://pypi.python.org/pypi/enviroplus)
7
8# Installing
9
10You'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.
11
12## One-line (Installs from GitHub)
13
14```
15curl -sSL https://get.pimoroni.com/enviroplus | bash
16```
17
18**Note** report issues with one-line installer here: https://github.com/pimoroni/get
19
20## Or... Install and configure dependencies from GitHub:
21
22* `git clone https://github.com/pimoroni/enviroplus-python`
23* `cd enviroplus-python`
24* `sudo ./install.sh`
25
26**Note** Raspbian Lite users may first need to install git: `sudo apt install git`
27
28## Or... Install from PyPi and configure manually:
29
30* Run `sudo pip install enviroplus`
31
32**Note** this wont perform any of the required configuration changes on your Pi, you may additionally need to:
33
34* Enable i2c: `raspi-config nonint do_i2c 0`
35* Enable SPI: `raspi-config nonint do_spi 0`
36
37And if you're using a PMS5003 sensor you will need to:
38
39* Enable serial: `raspi-config nonint set_config_var enable_uart 1 /boot/config.txt`
40* Disable serial terminal: `sudo raspi-config nonint do_serial 1`
41* Add `dtoverlay=pi3-miniuart-bt` to your `/boot/config.txt`
42
43And install additional dependencies:
44
45```
46sudo apt install python-numpy python-smbus
47```