python-bme680/README.md

32 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2017-10-17 17:02:29 +02:00
# BME680
2021-01-08 11:17:15 +01:00
![ci](https://github.com/cmur2/python-bme680/workflows/ci/badge.svg?branch=master)
2018-08-28 21:41:16 +02:00
2017-10-18 11:55:25 +02:00
https://shop.pimoroni.com/products/bme680
2017-10-18 11:54:46 +02:00
The state-of-the-art BME680 breakout lets you measure temperature, pressure, humidity, and indoor air quality.
2018-12-07 12:03:35 +01:00
## About this Fork
2017-10-18 11:54:46 +02:00
2018-12-07 12:03:35 +01:00
In general this fork tries to improve some details of the [original pimoroni/bme680-python repo](https://github.com/pimoroni/bme680-python):
2017-10-19 13:30:27 +02:00
2018-12-07 12:03:35 +01:00
- use standard unit for pressure measurement (Pascal instead Hectopascal, user can convert if he likes)
- floating point precision for measurement compensations (user has all precision available to choose *based on measurement settings and datasheet* how much is trustable)
- no redundant tweaking of measurement settings after soft reset
2017-10-19 13:30:27 +02:00
2018-12-07 12:03:35 +01:00
## Development
2017-10-18 11:54:46 +02:00
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:
```bash
sudo python3 setup.py install
```
(or `sudo python setup.py install` whichever your primary Python environment may be)
In all cases you will have to enable the i2c bus.
## Documentation & Support
2019-11-08 12:53:07 +01:00
* Guides and tutorials - https://learn.pimoroni.com/bme680-breakout
2017-10-18 11:54:46 +02:00
* Get help - http://forums.pimoroni.com/c/support