Skip to content

Commit 8fb321b

Browse files
authored
Merge pull request #47 from pimoroni/helgibbons-tweak-readme
Add BME688 details to readme
2 parents 7afe2ef + ba955f2 commit 8fb321b

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
# BME680
1+
# BME68x
22

33
[![Build Status](https://travis-ci.org/pimoroni/bme680-python.svg?branch=master)](https://travis-ci.org/pimoroni/bme680-python)
44
[![Coverage Status](https://coveralls.io/repos/github/pimoroni/bme680-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/bme680-python?branch=master)
55
[![PyPi Package](https://img.shields.io/pypi/v/bme680.svg)](https://pypi.python.org/pypi/bme680)
66
[![Python Versions](https://img.shields.io/pypi/pyversions/bme680.svg)](https://pypi.python.org/pypi/bme680)
77

8-
https://shop.pimoroni.com/products/bme680
8+
BME68x is a series of state-of-the-art environmental sensors that let you measure temperature, pressure, humidity and indoor air quality.
99

10-
The state-of-the-art BME680 breakout lets you measure temperature, pressure, humidity, and indoor air quality.
10+
This library is designed to work with the following products:
11+
12+
* BME680 Breakout - https://shop.pimoroni.com/products/bme680
13+
* BME688 4-in-1 Air Quality Breakout - https://shop.pimoroni.com/products/bme688-breakout
1114

1215
## Installing
1316

1417
### Full install (recommended):
1518

16-
We've created an easy installation script that will install all pre-requisites and get your BME680
19+
We've created an easy installation script that will install all pre-requisites and get your BME68x
1720
up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal
1821
on your Raspberry Pi desktop, as illustrated below:
1922

@@ -48,7 +51,7 @@ sudo python3 setup.py install
4851
```
4952
(or `sudo python setup.py install` whichever your primary Python environment may be)
5053

51-
In all cases you will have to enable the i2c bus.
54+
In all cases you will have to have I2C enabled (`sudo raspi-config`, under 'Interfacing Options').
5255

5356
## Documentation & Support
5457

0 commit comments

Comments
 (0)