cn
/
python-bme680
mirror of https://github.com/cmur2/python-bme680.git
1
0
Fork 0
Code Releases Activity

Add fork description to README

This commit is contained in:
cn 2018-12-07 12:03:35 +01:00
parent 6442510ab0
commit 5a4709992e
1 changed files with 7 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,45 +1,20 @@
# BME680 # BME680
[![Build Status](https://travis-ci.org/pimoroni/bme680-python.svg?branch=master)](https://travis-ci.org/pimoroni/bme680-python) [![Build Status](https://travis-ci.org/cmur2/python-bme680.svg?branch=master)](https://travis-ci.org/cmur2/python-bme680)
[![Coverage Status](https://coveralls.io/repos/github/pimoroni/bme680-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/bme680-python?branch=master)
[![PyPi Package](https://img.shields.io/pypi/v/bme680.svg)](https://pypi.python.org/pypi/bme680)
[![Python Versions](https://img.shields.io/pypi/pyversions/bme680.svg)](https://pypi.python.org/pypi/bme680)
https://shop.pimoroni.com/products/bme680 https://shop.pimoroni.com/products/bme680
The state-of-the-art BME680 breakout lets you measure temperature, pressure, humidity, and indoor air quality. The state-of-the-art BME680 breakout lets you measure temperature, pressure, humidity, and indoor air quality.
## Installing ## About this Fork
### Full install (recommended): In general this fork tries to improve some details of the [original pimoroni/bme680-python repo](https://github.com/pimoroni/bme680-python):
We've created an easy installation script that will install all pre-requisites and get your BME680 - use standard unit for pressure measurement (Pascal instead Hectopascal, user can convert if he likes)
up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal - floating point precision for measurement compensations (user has all precision available to choose *based on measurement settings and datasheet* how much is trustable)
on your Raspberry Pi desktop, as illustrated below: - no redundant tweaking of measurement settings after soft reset
![Finding the terminal](http://get.pimoroni.com/resources/github-repo-terminal.png) ## Development
In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:
```bash
curl https://get.pimoroni.com/bme680 | bash
```
### Manual install:
#### Library install for Python 3:
```bash
sudo pip3 install bme680
```
#### Library install for Python 2:
```bash
sudo pip2 install bme680
```
### Development:
If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, `cd` to the library directory, and run: If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, `cd` to the library directory, and run:
@ -53,4 +28,3 @@ In all cases you will have to enable the i2c bus.
## Documentation & Support ## Documentation & Support
* Guides and tutorials - https://learn.pimoroni.com/bme680 * Guides and tutorials - https://learn.pimoroni.com/bme680
* Get help - http://forums.pimoroni.com/c/support