Weather Sensors SWI2C Library

This library is designed for TMP007, OPT3001, and BME280 sensors using software I2C and integer-only calculations. The library only supports polling mode (interrupts are not supported).

It was specifically designed for the SENSORS BoosterPack, but it can be used as a software I2C interface for individual configurations of any of these sensors.

Usage

See the example sketch included with the library.

Install the SWI2C library in addition to this library.
Include this library in your sketch:
```
#include "Weather_Sensors_SWI2C.h"
```

Instantiate objects for the sensors that you are using:

TMP007_SWI2C  myTMP007(sda_pin, scl_pin, TMP007_7bit_I2C_address);
OPT3001_SWI2C myOPT3001(sda_pin, scl_pin, OPT3001_7bit_I2C_address);
BME280_SWI2C  myBME280(sda_pin, scl_pin, BME280_7bit_I2C_address);

Initialize the sensor objects that you created:

myTMP007.begin();
myOPT3001.begin();
myBME280.begin();

Read the measurements from the sensors. Note that every time that want to get a new sensor reading, you need to call the readSensor() method for that sensor.
```
myTMP007.readSensor();
myOPT3001.readSensor();
myBME280.readSensor();
```
Access the sensor values read from the last readSensor() call. Each sensor has different accessor methods as described below.

Accessing the Sensor Data

TMP007

myTMP007.getIntTempC();  // Returns int representing internal (die) temperature in units of 0.1 degrees Celsius
myTMP007.getIntTempF();  // Returns int representing internal (die) temperature in units of 0.1 degrees Fahrenheit
myTMP007.getExtTempC();  // Returns int representing external (object) temperature in units of 0.1 degrees Celsius
myTMP007.getExtTempF();  // Returns int representing external (object) temperature in units of 0.1 degrees Fahrenheit

OPT3001

myOPT3001.getLux();  // Returns unsigned long representing light intensity in lux.

BME280

myBME280.getTempC();  // Returns int representing temperature in units of 0.01 degrees Celsius
myBME280.getTempF();  // Returns int representing temperature in units of 0.1 degrees Fahrenheit
myBME280.getRH();  // Returns int representing relative humidity in units of 0.1 %RH
myBME280.getPressurePa();  // Returns uint32_t representing barometric pressure in units of pascals (Pa)
myBME280.getPressureInHg();  // Returns uint16_t representing barometric pressure in units of 0.01 inches of mercury (inHg)

Implementation Details

This library was inspired by Rei Vilo's Weather Sensors Library. My library is implemented using software I2C and uses integer-only math. In addition, my library configures the sensors somewhat differently.

The BME280 object uses code based on Section 4.2.3 Compensation Forumulas from the BME280 datasheet.

All sensors support the readDeviceID() method, which is a factory programmed value that can be used to confirm you are communicating with the correct device:

myTMP007.readDeviceID();  // Should return the 16-bit value 0x0078
myOPT3001.readDeviceID(); // Should return the 16-bit value 0x3001
myBME280.readDeviceID();  // Should return the 8-bit value 0x60

All sensors also support the getSWI2CObject() method. This returns a pointer to the underlying SWI2C object and its available public methods. This could be useful for debugging and other specialized situations.

The constructors have default values for the I2C_Address. If your device is configured with its address select pins tied to ground, you can call the constructor without the I2C_Address and just include the sda_pin and scl_pin parameters. The default 7-bit I2C addresses are:

TMP007: 0x40
OPT3001: 0x44
BME280: 0x76

The library provides unit conversions of Celsius to Fahrenheit and pascals to inches of mercury. Other unit conversions are left as an exercise for the user.

The library only supports a single hardcoded configuration for each device. This configuration works well for a battery-powered weather sensor which takes infrequent sensor measurements (e.g., once a minute). Note that in some cases, the device's low-power mode is not configured. This is because the devices draw so little current (microamps), that the added complexity of supporting low power modes is not worth the power savings. The current device configurations are:

TMP007: Two samples per measurement, low power mode
OPT3001: Automatic full scale mode, 100 ms conversion time, continuous conversion mode
BME280: 1000 ms standby, IIR filter off, pressure sampling x1, temperature sampling x1, humidity sampling x1, normal mode

For applications which require more frequent (i.e., on the order of once per second) or more accurate measurements, different configuration values may be needed and will require changes to the library. See the device datasheets for configuration options.

External Libraries That Need To Be Installed

SWI2C - Software I2C library

References

TMP007 datasheet
OPT3001 datasheet
BME280 datasheet
- This library uses code adapted from the datasheet section 4.2.3 for the sensor compensation calculations.
- Bosch Sensortec also publishes driver code with similar calculations on GitHub

License

The software and other files in this repository (with the exception listed below) are released under what is commonly called the MIT License. See the file LICENSE.txt in this repository.

The implementation of BME280_SWI2C::readSensor() in Weather_Sensors_SWI2C.cpp is adapted from sample code provided by Bosch Sensortec. The library specifically adapted code from the BME280 datasheet section 4.2.3, which does not list licensing information beyond saying "the code below can be applied at the user's risk." However, similar code is published by Bosch Sensortec on GitHub under the BSD-3-Clause license.

Andy4495/Weather_Sensors_SWI2C