diff --git a/README.md b/README.md index 7f103c0..3711f75 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ -BME680 + Rust [![Build Status](https://travis-ci.org/marcelbuesing/bme680-hal.svg?branch=master)](https://travis-ci.org/marcelbuesing/bme680-hal) +BME680 + Rust [![Build Status](https://travis-ci.org/marcelbuesing/bme680.svg?branch=master)](https://travis-ci.org/marcelbuesing/bme680) ============= This repository contains a pure Rust implementation for the [BME680](https://www.bosch-sensortec.com/bst/products/all_products/bme680) environmental sensor. The library can be used to read the gas, pressure, humidity and temperature sensors via I²C. The library uses the [embedded-hal](https://github.com/japaric/embedded-hal) library to abstract reading and writing via I²C. In the examples you can find a demo how to use the library in Linux using the [linux-embedded-hal](https://github.com/japaric/linux-embedded-hal) implementation. + +# Example getting started Linux + +Determine the I2C device path + +``` +pi@raspberrypi:~ $ i2cdetect -y -l +i2c-1 i2c bcm2835 I2C adapter I2C adapter +``` + +Determine I2C-Address of sensor, `0x76` is the primary address, `0x77` is the secondary address. +If in doubt use determine the address via the following command: + +``` +pi@raspberrypi:~ $ i2cdetect -y 1 + 0 1 2 3 4 5 6 7 8 9 a b c d e f +00: -- -- -- -- -- -- -- -- -- -- -- -- -- +10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +70: -- -- -- -- -- -- 76 +```