diff --git a/lib/BME280/BME280.cpp b/lib/BME280/BME280.cpp new file mode 100644 index 0000000..501abff --- /dev/null +++ b/lib/BME280/BME280.cpp @@ -0,0 +1,230 @@ +/* +BME280.cpp +This code records data from the BME280 sensor and provides an API. +This file is part of the Arduino BME280 library. +Copyright (C) 2016 Tyler Glenn + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Written: Dec 30 2015. +Last Updated: Jan 1 2016. - Happy New year! + +This header must be included in any derived code or copies of the code. + +Based on the data sheet provided by Bosch for the Bme280 environmental sensor, +calibration code based on algorithms providedBosch, some unit conversations courtesy +of www.endmemo.com, altitude equation courtesy of NOAA, and dew point equation +courtesy of Brian McNoldy at http://andrew.rsmas.miami.edu. + */ + + +/* ==== Includes ==== */ +#include +#include "BME280.h" +/* ==== END Includes ==== */ + +/* ==== Methods ==== */ + +float BME280::CalculateTemperature(int32_t raw, int32_t& t_fine, bool celsius) +{ + // Code based on calibration algorthim provided by Bosch. + int32_t var1, var2, final; + uint16_t dig_T1 = (dig[1] << 8) | dig[0]; + int16_t dig_T2 = (dig[3] << 8) | dig[2]; + int16_t dig_T3 = (dig[5] << 8) | dig[4]; + var1 = ((((raw >> 3) - ((int32_t)dig_T1 << 1))) * ((int32_t)dig_T2)) >> 11; + var2 = (((((raw >> 4) - ((int32_t)dig_T1)) * ((raw >> 4) - ((int32_t)dig_T1))) >> 12) * ((int32_t)dig_T3)) >> 14; + t_fine = var1 + var2; + final = (t_fine * 5 + 128) >> 8; + return celsius ? final/100.0 : final/100.0*9.0/5.0 + 32.0; +} + +float BME280::CalculateHumidity(int32_t raw, int32_t t_fine){ + // Code based on calibration algorthim provided by Bosch. + int32_t var1; + int8_t dig_H1 = dig[24]; + int16_t dig_H2 = (dig[26] << 8) | dig[25]; + int8_t dig_H3 = dig[27]; + int16_t dig_H4 = (dig[28] << 4) | (0x0F & dig[29]); + int16_t dig_H5 = (dig[30] << 4) | ((dig[29] >> 4) & 0x0F); + int8_t dig_H6 = dig[31]; + + var1 = (t_fine - ((int32_t)76800)); + var1 = (((((raw << 14) - (((int32_t)dig_H4) << 20) - (((int32_t)dig_H5) * var1)) + + ((int32_t)16384)) >> 15) * (((((((var1 * ((int32_t)dig_H6)) >> 10) * (((var1 * + ((int32_t)dig_H3)) >> 11) + ((int32_t)32768))) >> 10) + ((int32_t)2097152)) * + ((int32_t)dig_H2) + 8192) >> 14)); + var1 = (var1 - (((((var1 >> 15) * (var1 >> 15)) >> 7) * ((int32_t)dig_H1)) >> 4)); + var1 = (var1 < 0 ? 0 : var1); + var1 = (var1 > 419430400 ? 419430400 : var1); + return ((uint32_t)(var1 >> 12))/1024.0; +} + +float BME280::CalculatePressure(int32_t raw, int32_t t_fine, uint8_t unit){ + // Code based on calibration algorthim provided by Bosch. + int64_t var1, var2, pressure; + float final; + + uint16_t dig_P1 = (dig[7] << 8) | dig[6]; + int16_t dig_P2 = (dig[9] << 8) | dig[8]; + int16_t dig_P3 = (dig[11] << 8) | dig[10]; + int16_t dig_P4 = (dig[13] << 8) | dig[12]; + int16_t dig_P5 = (dig[15] << 8) | dig[14]; + int16_t dig_P6 = (dig[17] << 8) | dig[16]; + int16_t dig_P7 = (dig[19] << 8) | dig[18]; + int16_t dig_P8 = (dig[21] << 8) | dig[20]; + int16_t dig_P9 = (dig[23] << 8) | dig[22]; + + var1 = (int64_t)t_fine - 128000; + var2 = var1 * var1 * (int64_t)dig_P6; + var2 = var2 + ((var1 * (int64_t)dig_P5) << 17); + var2 = var2 + (((int64_t)dig_P4) << 35); + var1 = ((var1 * var1 * (int64_t)dig_P3) >> 8) + ((var1 * (int64_t)dig_P2) << 12); + var1 = (((((int64_t)1) << 47) + var1)) * ((int64_t)dig_P1) >> 33; + if (var1 == 0) { return NAN; } // Don't divide by zero. + pressure = 1048576 - raw; + pressure = (((pressure << 31) - var2) * 3125)/var1; + var1 = (((int64_t)dig_P9) * (pressure >> 13) * (pressure >> 13)) >> 25; + var2 = (((int64_t)dig_P8) * pressure) >> 19; + pressure = ((pressure + var1 + var2) >> 8) + (((int64_t)dig_P7) << 4); + + final = ((uint32_t)pressure)/256.0; + + // Conversion units courtesy of www.endmemo.com. + switch(unit){ + case 0x1: /* hPa */ + final /= 100.0; + break; + case 0x2: /* inHg */ + final /= 3386.3752577878; /* final pa * 1inHg/3386.3752577878Pa */ + break; + case 0x3: /* atm */ + final /= 101324.99766353; /* final pa * 1 atm/101324.99766353Pa */ + break; + case 0x4: /* bar */ + final /= 100*1000; /* final pa * 1 bar/100kPa */ + break; + case 0x5: /* torr */ + final /= 133.32236534674; /* final pa * 1 torr/133.32236534674Pa */ + break; + case 0x6: /* N/m^2 */ + break; /* 1Pa / N/m^2 */ + case 0x7: /* psi */ + final /= 6894.744825494; /* final pa * 1psi/6894.744825494Pa */ + break; + default: /* Pa (case: 0) */ + break; + } + return final; +} + +BME280::BME280(uint8_t tosr, uint8_t hosr, uint8_t posr, uint8_t mode, uint8_t st, uint8_t filter, + bool spiEnable): + tempOversamplingRate(tosr), humidityOversamplingRate(hosr), + pressureOversamplingRate(posr), mode(mode), standbyTime(st), filter(filter), + spiEnable(spiEnable) +{ + // ctrl_hum register. (ctrl_hum[2:0] = Humidity oversampling rate.) + controlHumidity = humidityOversamplingRate; + // ctrl_meas register. (ctrl_meas[7:5] = temperature oversampling rate, ctrl_meas[4:2] = pressure oversampling rate, ctrl_meas[1:0] = mode.) + controlMeasure = (tempOversamplingRate << 5) | (pressureOversamplingRate << 2) | mode; + // config register. (config[7:5] = standby time, config[4:2] = filter, ctrl_meas[0] = spi enable.) + config = (standbyTime << 5) | (filter << 2) | spiEnable; +} + +void BME280::setMode(uint8_t mode){ + controlMeasure = controlMeasure | mode; + WriteRegister(CTRL_MEAS_ADDR, controlMeasure); +} + +float BME280::temp(bool celsius){ + int32_t data[8]; + int32_t t_fine; + if(!ReadData(data)){ return NAN; } + uint32_t rawTemp = (data[3] << 12) | (data[4] << 4) | (data[5] >> 4); + return CalculateTemperature(rawTemp, t_fine, celsius); +} + +float BME280::press(uint8_t unit){ + int32_t data[8]; + int32_t t_fine; + if(!ReadData(data)){ return NAN; } + uint32_t rawTemp = (data[3] << 12) | (data[4] << 4) | (data[5] >> 4); + uint32_t rawPressure = (data[0] << 12) | (data[1] << 4) | (data[2] >> 4); + CalculateTemperature(rawTemp, t_fine); + return CalculatePressure(rawPressure, t_fine, unit); +} + +float BME280::hum(){ + int32_t data[8]; + int32_t t_fine; + if(!ReadData(data)){ return NAN; } + uint32_t rawTemp = (data[3] << 12) | (data[4] << 4) | (data[5] >> 4); + uint32_t rawHumidity = (data[6] << 8) | data[7]; + CalculateTemperature(rawTemp, t_fine); + return CalculateHumidity(rawHumidity, t_fine); +} + +void BME280::read(float& pressure, float& temp, float& humidity, bool metric, uint8_t p_unit){ + int32_t data[8]; + int32_t t_fine; + if(!ReadData(data)){ + pressure = temp = humidity = NAN; + return; + } + uint32_t rawPressure = (data[0] << 12) | (data[1] << 4) | (data[2] >> 4); + uint32_t rawTemp = (data[3] << 12) | (data[4] << 4) | (data[5] >> 4); + uint32_t rawHumidity = (data[6] << 8) | data[7]; + temp = CalculateTemperature(rawTemp, t_fine, metric); + pressure = CalculatePressure(rawPressure, t_fine, p_unit); + humidity = CalculateHumidity(rawHumidity, t_fine); +} + +float BME280::alt(bool metric, float seaLevelPressure){ + float temp, hum, pres; + read(pres, temp, hum, metric); + return alt(pres, metric, seaLevelPressure); +} + +float BME280::alt(float pressure, bool metric, float seaLevelPressure){ + // Equations courtesy of NOAA; + float altitude = NAN; + if (!isnan(pressure) && !isnan(seaLevelPressure)){ + altitude = 1000.0 * ( seaLevelPressure - pressure ) / 3386.3752577878; + } + return metric ? altitude * 0.3048 : altitude; +} + +float BME280::dew(bool metric){ + float temp, hum, pres; + read(pres, temp, hum, metric); + return dew(temp, hum, metric); +} + +float BME280::dew(float temp, float hum, bool metric){ + // Equations courtesy of Brian McNoldy from http://andrew.rsmas.miami.edu; + float dewPoint = NAN; + if (metric && !isnan(temp) && !isnan(hum)){ + dewPoint = 243.04 * (log(hum/100.0) + ((17.625 * temp)/(243.04 + temp))) + /(17.625 - log(hum/100.0) - ((17.625 * temp)/(243.04 + temp))); + }else if (!isnan(temp) && !isnan(hum)){ + float ctemp = (temp - 32.0) * 5.0/9.0; + dewPoint = 243.04 * (log(hum/100.0) + ((17.625 * ctemp)/(243.04 + ctemp))) + /(17.625 - log(hum/100.0) - ((17.625 * ctemp)/(243.04 + ctemp))); + dewPoint = dewPoint * 9.0/5.0 + 32.0; + } + return dewPoint; +} + +/* ==== END Methods ==== */ diff --git a/lib/BME280/BME280.h b/lib/BME280/BME280.h new file mode 100644 index 0000000..a1ccff2 --- /dev/null +++ b/lib/BME280/BME280.h @@ -0,0 +1,116 @@ +/* +BME280.h +This code records data from the BME280 sensor and provides an API. +This file is part of the Arduino BME280 library. +Copyright (C) 2016 Tyler Glenn + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Written: Dec 30 2015. +Last Updated: Jan 1 2016. - Happy New year! +This code is licensed under the GNU LGPL and is open for ditrbution +and copying in accordance with the license. +This header must be included in any derived code or copies of the code. + +Based on the data sheet provided by Bosch for the Bme280 environmental sensor. + */ +#ifndef TG_BME_280_H +#define TG_BME_280_H + +/* ==== Includes ==== */ +#include "Arduino.h" +/* ==== END Includes ==== */ + +/* ==== Defines ==== */ +#define CTRL_HUM_ADDR 0xF2 +#define CTRL_MEAS_ADDR 0xF4 +#define CONFIG_ADDR 0xF5 +#define PRESS_ADDR 0xF7 +#define TEMP_ADDR 0xFA +#define HUM_ADDR 0xFD +#define TEMP_DIG_ADDR 0x88 +#define PRESS_DIG_ADDR 0x8E +#define HUM_DIG_ADDR1 0xA1 +#define HUM_DIG_ADDR2 0xE1 +/* ==== END Defines ==== */ + + +class BME280{ +protected: + uint8_t tempOversamplingRate, humidityOversamplingRate, pressureOversamplingRate; // B000 = Skipped, B001 = x1, B010 = x2, B011 = x4, B100 = x8, B101/other = x16 + uint8_t mode; // Sleep = B00, Normal = B01 and B10, Forced = B11 + uint8_t standbyTime; // B000 = 0.5ms, B001 = 62.5ms, B010 = 125ms, B011 = 250ms, B100 = 250ms, B101 = 1000ms, B110 = 10ms, B111 = 20ms + uint8_t filter; // B000 = off, B001 = 2, B010 = 4, B011 = 8, B100/other = 16 + uint8_t controlHumidity; // ctrl_hum register. (ctrl_hum[2:0] = Humidity oversampling rate.) + uint8_t controlMeasure; // ctrl_meas register. (ctrl_meas[7:5] = temperature oversampling rate, ctrl_meas[4:2] = pressure oversampling rate, ctrl_meas[1:0] = mode.) + uint8_t config; // config register. (config[7:5] = standby time, config[4:2] = filter, ctrl_meas[0] = spi enable.) + uint8_t dig[32]; + bool spiEnable; + + + /* ==== Write values to BME280 registers. ==== */ + virtual void WriteRegister(uint8_t addr, uint8_t data)=0; + + /* ==== Read the the trim data from the BME280, return true if successful. ==== */ + virtual bool ReadTrim()=0; + + /* ==== Read the raw data from the BME280 into an array and return true if successful. ==== */ + virtual bool ReadData(int32_t data[8])=0; + + /* ==== Calculate the temperature from the BME280 raw data and BME280 trim, return a float. ==== */ + float CalculateTemperature(int32_t raw, int32_t& t_fine, bool celsius = true); + + /* ==== Calculate the humidity from the BME280 raw data and BME280 trim, return a float. ==== */ + float CalculateHumidity(int32_t raw, int32_t t_fine); + + /* ==== Calculate the pressure from the BME280 raw data and BME280 trim, return a float. ==== */ + float CalculatePressure(int32_t raw, int32_t t_fine, uint8_t unit = 0x0); // unit: B000/other = Pa, B001 = hPa, B010 = inHg, B011 = atm, B100 = bar, B101 = torr, B110 = N/m^2, B111 = psi + +public: + /* ==== Constructor used to create the class. All parameters have default values. ==== */ + BME280(uint8_t tosr = 0x1, uint8_t hosr = 0x1, uint8_t posr = 0x1, uint8_t mode = 0x3, + uint8_t st = 0x5, uint8_t filter = 0x0, bool spiEnable = false); // Oversampling = 1, mode = normal, standby time = 1000ms, filter = none. + + /* ==== Method used at start up to initialize the class. ==== */ + virtual bool begin()=0; + + void setMode(uint8_t mode); + + /* ==== Read the temperature from the BME280 and return a float. ==== */ + float temp(bool celsius = true); + + /* ==== Read the pressure from the BME280 and return a float with the specified unit. ==== */ + float press(uint8_t unit = 0x0); // unit: B000 = Pa, B001 = hPa, B010 = Hg, B011 = atm, B100 = bar, B101 = torr, B110 = N/m^2, B111 = psi + + /* ==== Read the humidity from the BME280 and return a percentage as a float. ==== */ + float hum(); + + /* ==== Read the data from the BME280 with the specified units. ==== */ + void read(float& pressure, float& temp, float& humidity, bool metric = true, uint8_t p_unit = 0x0); + + + /* ==== Read the data from the BME280 with the specified units and then calculate the altitude. ==== */ + float alt(bool metric = true, float seaLevelPressure = 101325); + + /* ==== Calculate the altitude based on the pressure with the specified units. ==== */ + float alt(float pressure, bool metric = true, float seaLevelPressure = 101325); // Pressure given in Pa. + + /* ==== Read BME280 data and calculate the dew point with the specified units. ==== */ + float dew(bool metric = true); + + /* ==== Calculate the dew point based on the temperature and humidity with the specified units. ==== */ + float dew(float temp, float hum, bool metric = true); + +}; +#endif // TG_BME_280_H diff --git a/lib/BME280/BME280I2C.cpp b/lib/BME280/BME280I2C.cpp new file mode 100644 index 0000000..004ce98 --- /dev/null +++ b/lib/BME280/BME280I2C.cpp @@ -0,0 +1,142 @@ +/* +BME280I2CI2C.cpp +This code records data from the BME280I2C sensor and provides an API. +This file is part of the Arduino BME280I2C library. +Copyright (C) 2016 Tyler Glenn + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Written: Dec 30 2015. +Last Updated: Jan 1 2016. - Happy New year! + +This header must be included in any derived code or copies of the code. + +Based on the data sheet provided by Bosch for the BME280I2C environmental sensor, +calibration code based on algorithms providedBosch, some unit conversations courtesy +of www.endmemo.com, altitude equation courtesy of NOAA, and dew point equation +courtesy of Brian McNoldy at http://andrew.rsmas.miami.edu. + */ + + +/* ==== Includes ==== */ +#include +#include "BME280I2C.h" +/* ==== END Includes ==== */ + +/* ==== Methods ==== */ + +bool BME280I2C::Initialize() { + WriteRegister(CTRL_HUM_ADDR, controlHumidity); + WriteRegister(CTRL_MEAS_ADDR, controlMeasure); + WriteRegister(CONFIG_ADDR, config); + return ReadTrim(); +} + + +void BME280I2C::WriteRegister(uint8_t addr, uint8_t data) +{ + Wire.beginTransmission(bme_280_addr); + Wire.write(addr); + Wire.write(data); + Wire.endTransmission(); +} + +bool BME280I2C::ReadTrim() +{ + uint8_t ord(0); + + // Temp. Dig + Wire.beginTransmission(bme_280_addr); + Wire.write(TEMP_DIG_ADDR); + Wire.endTransmission(); + + Wire.requestFrom(bme_280_addr, (uint8_t)6); + while(Wire.available()){ + dig[ord++] = Wire.read(); + } + + // Pressure Dig + Wire.beginTransmission(bme_280_addr); + Wire.write(PRESS_DIG_ADDR); + Wire.endTransmission(); + + Wire.requestFrom(bme_280_addr, (uint8_t)18); + while(Wire.available()){ + dig[ord++] = Wire.read(); + } + + // Humidity Dig 1 + Wire.beginTransmission(bme_280_addr); + Wire.write(HUM_DIG_ADDR1); + Wire.endTransmission(); + + Wire.requestFrom(bme_280_addr, (uint8_t)1); + while(Wire.available()){ + dig[ord++] = Wire.read(); + } + + // Humidity Dig 2 + Wire.beginTransmission(bme_280_addr); + Wire.write(HUM_DIG_ADDR2); + Wire.endTransmission(); + + Wire.requestFrom(bme_280_addr, (uint8_t)7); + while(Wire.available()){ + dig[ord++] = Wire.read(); + } + return ord == 32; +} + +bool BME280I2C::ReadData(int32_t data[8]){ + uint8_t ord = 0; + + // Registers are in order. So we can start at the pressure register and read 8 bytes. + Wire.beginTransmission(bme_280_addr); + Wire.write(PRESS_ADDR); + Wire.endTransmission(); + + Wire.requestFrom(bme_280_addr, (uint8_t)8); + while(Wire.available()){ + data[ord++] = Wire.read(); + } + return ord == 8; +} + + +BME280I2C::BME280I2C(uint8_t tosr, uint8_t hosr, uint8_t posr, uint8_t mode, uint8_t st, uint8_t filter, + bool spiEnable, uint8_t bme_280_addr): + BME280(tosr, hosr, posr, mode, st, filter, spiEnable), bme_280_addr(bme_280_addr) +{ + // ctrl_hum register. (ctrl_hum[2:0] = Humidity oversampling rate.) + controlHumidity = humidityOversamplingRate; + // ctrl_meas register. (ctrl_meas[7:5] = temperature oversampling rate, ctrl_meas[4:2] = pressure oversampling rate, ctrl_meas[1:0] = mode.) + controlMeasure = (tempOversamplingRate << 5) | (pressureOversamplingRate << 2) | mode; + // config register. (config[7:5] = standby time, config[4:2] = filter, ctrl_meas[0] = spi enable.) + config = (standbyTime << 5) | (filter << 2) | spiEnable; +} + +#if defined(ARDUINO_ARCH_ESP8266) +bool BME280I2C::begin(int SDA, int SCL) { + // allow config of pins + Wire.begin(SDA,SCL); + return Initialize(); +} +#endif + +bool BME280I2C::begin(){ + Wire.begin(); + return Initialize(); +} + +/* ==== END Methods ==== */ diff --git a/lib/BME280/BME280I2C.h b/lib/BME280/BME280I2C.h new file mode 100644 index 0000000..b63305a --- /dev/null +++ b/lib/BME280/BME280I2C.h @@ -0,0 +1,69 @@ +/* +BME280I2C.h +This code records data from the BME280 sensor and provides an API. +This file is part of the Arduino BME280 library. +Copyright (C) 2016 Tyler Glenn + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Written: Sep 19 2016. +Last Updated: Sep 19 2016. - Happy Fall! <5 +This code is licensed under the GNU LGPL and is open for ditrbution +and copying in accordance with the license. +This header must be included in any derived code or copies of the code. + +Based on the data sheet provided by Bosch for the Bme280 environmental sensor. + */ +#ifndef TG_BME_280_I2C_H +#define TG_BME_280_I2C_H + +/* ==== Includes ==== */ +#include "BME280.h" +/* ==== END Includes ==== */ + +/* ==== Defines ==== */ + +/* ==== END Defines ==== */ + + +class BME280I2C: public BME280{ + uint8_t bme_280_addr; + + /* ==== Write configuration to BME280, return true if successful. ==== */ + bool Initialize(); + + /* ==== Write values to BME280 registers. ==== */ + virtual void WriteRegister(uint8_t addr, uint8_t data); + + /* ==== Read the the trim data from the BME280, return true if successful. ==== */ + virtual bool ReadTrim(); + + /* ==== Read the raw data from the BME280 into an array and return true if successful. ==== */ + virtual bool ReadData(int32_t data[8]); + +public: + /* ==== Constructor used to create the class. All parameters have default values. ==== */ + BME280I2C(uint8_t tosr = 0x1, uint8_t hosr = 0x1, uint8_t posr = 0x1, uint8_t mode = 0x3, + uint8_t st = 0x5, uint8_t filter = 0x0, bool spiEnable = false, + uint8_t bme_280_addr = 0x76); // Oversampling = 1, mode = normal, standby time = 1000ms, filter = none. + + /* ==== Method used at start up to initialize the class. Starts the I2C interface. ==== */ + virtual bool begin(); +#if defined(ARDUINO_ARCH_ESP8266) + /* ==== On esp8266 it is possible to define I2C pins ==== */ + bool begin(int SDA, int SCL); +#endif + +}; +#endif // TG_BME_280_I2C_H diff --git a/lib/BME280/LICENSE b/lib/BME280/LICENSE new file mode 100644 index 0000000..733c072 --- /dev/null +++ b/lib/BME280/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/lib/BME280/README.md b/lib/BME280/README.md new file mode 100644 index 0000000..5e7b5f8 --- /dev/null +++ b/lib/BME280/README.md @@ -0,0 +1,225 @@ + + + +# BME280 +Provides an Arduino library for reading and interpreting Bosch BME280 data. + +## Table of Contents + +* [BME280](#bme280) +* [Table of Contents](#table_of_contents) +* [Summary](#summary) +* [Installation](#installation) +* [Usage](#usage) +* [Methods](#methods) + + * [BME280(uint8_t tosr = 0x1, uint8_t hosr = 0x1, uint8_t posr = 0x1, uint8_t mode = 0x3, uint8_t st = 0x5, uint8_t filter = 0x0, bool spiEnable = false, uint8_t bme_280_addr = 0x76)](#methods) + * [bool begin()](#methods) + * [void setMode(uint8_t mode)](#methods) + * [float temp(bool celsius = true)](#methods) + * [float pres(uint8_t unit = 0x0)](#methods) + * [float hum()](#methods) + * [void data(float& pressure, float& temp, float& humidity, bool metric = true, uint8_t p_unit = 0x0)](#methods) + * [float alt(bool metric = true, float seaLevelPressure = 101325)](#methods) + * [float alt(float pressure, bool metric = true, float seaLevelPressure = 101325)](#methods) + * [float dew(bool metric = true)](#methods) + * [float dew(float temp, float hum, bool metric = true)](#methods) +* [Contributing](#contributing) +* [History](#history) +* [Credits](#credits) +* [License](#license) + + + +## Summary + +Reads temperature, humidity, and pressure. Calculates altitude and dew point. Provides functions for english and metric. Also reads pressure in Pa, hPa, inHg, atm, bar, torr, N/m^2 and psi. + +## Installation + +To use this library download the zip file, uncompress it to a folder named BME280. Move the folder to {Arduino Path}/libraries. + +## Usage + +Include the library at the top of your Arduino script. `#include ` +Create a global or local variable. `BME280 bme` +In your start up call `bme.begin()`. +Read the temperature, humidity, pressure, altitude and/or dew point. + +`float pres, temp, hum` +`bme.data(pres, temp, hum)` + +or + +`temp = bme.temp()` +`hum = bme.hum()` +`pres = bme.pres()` + +`float altitude, dewPoint` +`altitude = bme.alt()` +`dewPoint = bme.dew()` + +Use `setMode(0x01)` to trigger a new measurement in forced mode. NOTE: It takes ~8ms to measure all values (temp, humidity & pressure) when using x1 oversampling (see datasheet 11.1). Thus a delay of >8ms should be used after triggering a measurement and before reading data to ensure that read values are the latest ones. + +## Methods + + +#### BME280(uint8_t tosr = 0x1, uint8_t hosr = 0x1, uint8_t posr = 0x1, uint8_t mode = 0x3, uint8_t st = 0x5, uint8_t filter = 0x0, bool spiEnable = false, uint8_t bme_280_addr = 0x76) + + Constructor used to create the class. All parameters have default values. + Return: None + + * Temperature Oversampling Rate (tosr): uint8_t, default = 0x1 + values: B000 = Skipped, B001 = x1, B010 = x2, B011 = x4, B100 = x8, B101/other = x16 + + * Humidity Oversampling Rate (hosr): uint8_t, default = 0x1 + values: B000 = Skipped, B001 = x1, B010 = x2, B011 = x4, B100 = x8, B101/other = x16 + + * Pressure Oversampling Rate (posr): uint8_t, default = 0x1 + values: B000 = Skipped, B001 = x1, B010 = x2, B011 = x4, B100 = x8, B101/other = x16 + + * Mode: uint8_t, default = Normal + values: Sleep = B00, Forced = B01 and B10, Normal = B11 + + * Standby Time (st): uint8_t, default = 1000ms + values: B000 = 0.5ms, B001 = 62.5ms, B010 = 125ms, B011 = 250ms, B100 = 250ms, B101 = 1000ms, B110 = 10ms, B111 = 20ms + + * Filter: uint8_t, default = None + values: B000 = off, B001 = 2, B010 = 4, B011 = 8, B100/other = 16 + + * SPI Enable: bool, default = false + values: true = enable, false = disable + + * BME280 Address: uint8_t, default = 0x76 + values: any uint8_t + + + + +#### bool begin() + + Method used at start up to initialize the class. Starts the I2C interface. + Return: bool, true = success, false = failure (no device found) + +#### void setMode(uint8_t mode) + + Method to set the sensor mode. Sleep = B00, Forced = B01 and B10, Normal = B11. Set to B01 to trigger a new measurement when using forced mode. + +#### float temp(bool celsius = true) + + Read the temperature from the BME280 and return a float. + Return: float = temperature + + * Celsius: bool, default = true + values: true = return temperature in degrees Celsius, false = return + temperature in degrees Fahrenheit + + +#### float pres(uint8_t unit = 0x0) + + Read the pressure from the BME280 and return a float with the specified unit. + Return: float = pressure + + * Unit: uint8_t, default = 0x0 + values: B000 = Pa, B001 = hPa, B010 = Hg, B011 = atm, B100 = bar, + B101 = torr, B110 = N/m^2, B111 = psi + +#### float hum() + + Read the humidity from the BME280 and return a percentage as a float. + Return: float = percent relative humidity + +#### void data(float& pressure, float& temp, float& humidity, bool metric = true, uint8_t p_unit = 0x0) + + Read the data from the BME280 with the specified units. + Return: None, however, pressure, temp and humidity are changed. + + * Pressure: float, reference + values: reference to storage float for pressure + + * Temperature: float, reference + values: reference to storage float for temperature + + * Humidity: float, reference + values: reference to storage float for humidity + + * Metric: bool, default = true + values: true = meters, false = feet + + * Pressure Unit: uint8_t, default = 0x0 + values: B000 = Pa, B001 = hPa, B010 = Hg, B011 = atm, B100 = bar, + B101 = torr, B110 = N/m^2, B111 = psi + +#### float alt(bool metric = true, float seaLevelPressure = 101325) + + Read the data from the BME280 with the specified units and then calculate the altitude. + Return: float = altitude + + * Metric: bool, default = true + values: true = meters, false = feet + + * Sea Level Pressure: float, unit = Pa, default = 101325 + values: any float + + +#### float alt(float pressure, bool metric = true, float seaLevelPressure = 101325) + + Calculate the altitude based on the pressure with the specified units. + Return: float = altitude + + * Pressure: float, unit = Pa + values: any float + + * Metric: bool, default = true + values: true = meters, false = feet + + * Sea Level Pressure: float, unit = Pa, default = 101325 + values: any float + +#### float dew(bool metric = true) + + Read BME280 data and calculate the dew point with the specified units. + Return: float = dew point + + * Metric: bool, default = true + values: true = return temperature in degrees Celsius, false = return + temperature in degrees Fahrenheit + +#### float dew(float temp, float hum, bool metric = true) + + Calculate the dew point based on the temperature and humidity with the specified units. + Return: float = dew point + + * Temperature: float, unit = Celsius if metric is true, Fahrenheit if metric is false + values: any float + + * Humidity: float, unit = % relative humidity + values: any float + + * Metric: bool, default = true + values: true = return degrees Celsius, false = return degrees Fahrenheit + +## Contributing + +1. Fork the project. +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request. + +## History + +Jan 1, 2016 - Version 1.0.0 released. +Sep 19, 2016 - Version 2.0.0 released (support for I2C and SPI). + +## Credits + +Written by Tyler Glenn, 2016. + +Special thanks to Mike Glenn for editing and reviewing the code. + +## License + +GNU GPL, see License.txt + + diff --git a/lib/BME280/examples/BME280_Modes/BME280_Modes.ino b/lib/BME280/examples/BME280_Modes/BME280_Modes.ino new file mode 100644 index 0000000..a344fcd --- /dev/null +++ b/lib/BME280/examples/BME280_Modes/BME280_Modes.ino @@ -0,0 +1,123 @@ +/* +BME280I2C Modes.ino +This code shows how to use predefined recommended settings from Bosch for +the BME280I2C environmental sensor. +This file is an example file, part of the Arduino BME280I2C library. +Copyright (C) 2016 Tyler Glenn + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Written: Dec 30 2015. +Last Updated: Jan 1 2016. + */ + +/* ==== Includes ==== */ +#include +#include // Needed for legacy versions of Arduino. +/* ==== END Includes ==== */ + +/* ==== Defines ==== */ +#define SERIAL_BAUD 115200 +/* ==== END Defines ==== */ + +/* ==== Global Variables ==== */ +BME280I2C bme; // Default : forced mode, standby time = 1000 ms + // pressure ×1, temperature ×1, humidity ×1, filter off + +/* Based on Bosch BME280I2C environmental sensor data sheet. */ + +//BME280I2C bme; // Weather Monitoring : forced mode, 1 sample/minute + // pressure ×1, temperature ×1, humidity ×1, filter off + // Current Consumption = 0.16 μA + // RMS Noise = 3.3 Pa/30 cm, 0.07 %RH + // Data Output Rate 1/60 Hz + +//BME280I2C bme(0, 1, 1); // Humidity Sensing : forced mode, 1 sample/second + // pressure ×0, temperature ×1, humidity ×1, filter off + // Current Consumption = 2.9 μA + // RMS Noise = 0.07 %RH + // Data Output Rate = 1 Hz + +//BME280I2C bme(5, 2, 1, 1, 0, 4); // Indoor Navigation : normal mode, standby time = 0.5ms + // pressure ×16, temperature ×2, humidity ×1, filter = x16 + // Current Consumption = 633 μA + // RMS Noise = 0.2 Pa/1.7 cm + // Data Output Rate = 25Hz + // Filter Bandwidth = 0.53 Hz + // Response Time (75%) = 0.9 s + + +//BME280I2C bme(3, 1, 0, 1, 0, 4); // Gaming : normal mode, standby time = 0.5ms + // pressure ×4, temperature ×1, humidity ×0, filter = x16 + // Current Consumption = 581 μA + // RMS Noise = 0.3 Pa/2.5 cm + // Data Output Rate = 83 Hz + // Filter Bandwidth = 1.75 Hz + // Response Time (75%) = 0.3 s + +bool metric = false; +/* ==== END Global Variables ==== */ + +/* ==== Prototypes ==== */ +/* === Print a message to stream with the temp, humidity and pressure. === */ +void printBME280Data(Stream * client); +/* === Print a message to stream with the altitude, dew point and. === */ +void printBME280CalculatedData(Stream* client); +/* ==== END Prototypes ==== */ + +void setup() { + Serial.begin(SERIAL_BAUD); + while(!Serial) {} // Wait + while(!bme.begin()){ + Serial.println("Could not find BME280I2C sensor!"); + delay(1000); + } +} + +void loop() { + printBME280Data(&Serial); + printBME280CalculatedData(&Serial); + delay(500); +} +void printBME280Data(Stream* client){ + float temp(NAN), hum(NAN), pres(NAN); + uint8_t pressureUnit(3); // unit: B000 = Pa, B001 = hPa, B010 = Hg, B011 = atm, B100 = bar, B101 = torr, B110 = N/m^2, B111 = psi + bme.ReadData(pres, temp, hum, pressureUnit, metric); // Parameters: (float& pressure, float& temp, float& humidity, bool hPa = true, bool celsius = false) + /* Alternatives to ReadData(): + float ReadTemperature(bool celsius = false); + float ReadPressure(uint8_t unit = 0); + float ReadHumidity(); + + Keep in mind the temperature is used for humidity and + pressure calculations. So it is more effcient to read + temperature, humidity and pressure all together. + */ + client->print("Temp: "); + client->print(temp); + client->print("°"+ String(metric ? 'C' :'F')); + client->print("\t\tHumidity: "); + client->print(hum); + client->print("% RH"); + client->print("\t\tPressure: "); + client->print(pres); + client->print(" atm"); +} +void printBME280CalculatedData(Stream* client){ + float altitude = bme.CalculateAltitude(metric); + client->print("\t\tAltitude: "); + client->print(altitude); + client->print((metric ? "m" : "ft")); + client->println(); + +} diff --git a/lib/BME280/examples/BME_280_I2C_Test/BME_280_I2C_Test.ino b/lib/BME280/examples/BME_280_I2C_Test/BME_280_I2C_Test.ino new file mode 100644 index 0000000..5bf48b4 --- /dev/null +++ b/lib/BME280/examples/BME_280_I2C_Test/BME_280_I2C_Test.ino @@ -0,0 +1,111 @@ +/* +BME280 I2C Test.ino +This code shows how to record data from the BME280 environmental sensor +using I2C interface. This file is an example file, part of the Arduino +BME280 library. +Copyright (C) 2016 Tyler Glenn + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +Written: Dec 30 2015. +Last Updated: Sep 19 2016. + +Connecting the BME280 Sensor: +Sensor -> Board +----------------------------- +Vin (Voltage In) -> 3.3V +Gnd (Ground) -> Gnd +SDA (Serial Data) -> A4 on Uno/Pro-Mini, 20 on Mega2560/Due, 2 Leonardo/Pro-Micro +SCK (Serial Clock) -> A5 on Uno/Pro-Mini, 21 on Mega2560/Due, 3 Leonardo/Pro-Micro + + */ + +/* ==== Includes ==== */ +#include +#include // Needed for legacy versions of Arduino. +/* ==== END Includes ==== */ + +/* ==== Defines ==== */ +#define SERIAL_BAUD 115200 +/* ==== END Defines ==== */ + +/* ==== Global Variables ==== */ +BME280I2C bme; // Default : forced mode, standby time = 1000 ms + // Oversampling = pressure ×1, temperature ×1, humidity ×1, filter off, +bool metric = false; +/* ==== END Global Variables ==== */ + + +/* ==== Prototypes ==== */ +/* === Print a message to stream with the temp, humidity and pressure. === */ +void printBME280Data(Stream * client); +/* === Print a message to stream with the altitude, and dew point. === */ +void printBME280CalculatedData(Stream* client); +/* ==== END Prototypes ==== */ + +/* ==== Setup ==== */ +void setup() { + Serial.begin(SERIAL_BAUD); + while(!Serial) {} // Wait + while(!bme.begin()){ + Serial.println("Could not find BME280 sensor!"); + delay(1000); + } +} +/* ==== END Setup ==== */ + +/* ==== Loop ==== */ +void loop() { + printBME280Data(&Serial); + printBME280CalculatedData(&Serial); + delay(500); +} +/* ==== End Loop ==== */ + +/* ==== Functions ==== */ +void printBME280Data(Stream* client){ + float temp(NAN), hum(NAN), pres(NAN); + uint8_t pressureUnit(3); // unit: B000 = Pa, B001 = hPa, B010 = Hg, B011 = atm, B100 = bar, B101 = torr, B110 = N/m^2, B111 = psi + bme.read(pres, temp, hum, metric, pressureUnit); // Parameters: (float& pressure, float& temp, float& humidity, bool celsius = false, uint8_t pressureUnit = 0x0) + /* Alternatives to ReadData(): + float temp(bool celsius = false); + float pres(uint8_t unit = 0); + float hum(); + + Keep in mind the temperature is used for humidity and + pressure calculations. So it is more effcient to read + temperature, humidity and pressure all together. + */ + client->print("Temp: "); + client->print(temp); + client->print("°"+ String(metric ? 'C' :'F')); + client->print("\t\tHumidity: "); + client->print(hum); + client->print("% RH"); + client->print("\t\tPressure: "); + client->print(pres); + client->print(" atm"); +} +void printBME280CalculatedData(Stream* client){ + float altitude = bme.alt(metric); + float dewPoint = bme.dew(metric); + client->print("\t\tAltitude: "); + client->print(altitude); + client->print((metric ? "m" : "ft")); + client->print("\t\tDew point: "); + client->print(dewPoint); + client->println("°"+ String(metric ? 'C' :'F')); + +} +/* ==== END Functions ==== */ diff --git a/lib/BME280/keywords.txt b/lib/BME280/keywords.txt new file mode 100644 index 0000000..1a49671 --- /dev/null +++ b/lib/BME280/keywords.txt @@ -0,0 +1,8 @@ +BME280 KEYWORD1 +begin KEYWORD2 +temp KEYWORD2 +pres KEYWORD2 +hum KEYWORD2 +data KEYWORD2 +alt KEYWORD2 +dew KEYWORD2 diff --git a/lib/BME280/library.properties b/lib/BME280/library.properties new file mode 100644 index 0000000..b025f33 --- /dev/null +++ b/lib/BME280/library.properties @@ -0,0 +1,9 @@ +name=BME280 +version=2.0.01 +author=Tyler Glenn +maintainer=Tyler Glenn +sentence=Provides a library for reading and interpreting Bosch BME280 environmental sensor data over I2C. +paragraph=Reads temperature, humidity, and pressure. Calculates altitude and dew point. Provides functions for english and metric. Also reads pressure in Pa, hPa, inHg, atm, bar, torr, N/m^2 and psi. +category=Sensors +url=https://www.github.com/finitespace/BME280 +architectures=* diff --git a/mobile-sensebox.ino b/mobile-sensebox.ino index 7ef7ff9..e0197a9 100644 --- a/mobile-sensebox.ino +++ b/mobile-sensebox.ino @@ -1,4 +1,5 @@ #include "lib/TinyGPS++/TinyGPS++.h" +#include "lib/BME280/BME280I2C.h" #include "config.h" #include "gps.h" #include "wifi.h" @@ -15,6 +16,8 @@ TelnetPrint telnet = TelnetPrint(); OsemApi api = OsemApi(); Gps gps = Gps(); +BME280I2C bme(1, 1, 1, 3, 5, 0, false, 0x77); + unsigned long cycleStart; WifiState wifiState; // global, as both measure and upload need the state TinyGPSLocation location; @@ -30,7 +33,8 @@ bool storeMeasurement(float lat, float lng, float value, const char* timeStamp, } void measure(WifiState& wifiState, TinyGPSLocation& loc) { - char dateString[20]; + char dateString[22]; + float temperature, humid, pressure; // measure WiFi wifiState = wifi.scan(WIFI_SSID); @@ -46,11 +50,16 @@ void measure(WifiState& wifiState, TinyGPSLocation& loc) { loc = gps.getLocation(); gps.getISODate(dateString); + bme.read(pressure, temperature, humid, 1, true); + // print state DEBUG_OUT << "homeAvailable: " << wifiState.homeAvailable << EOL; DEBUG_OUT << "numAPs: " << wifiState.numAccessPoints << EOL; DEBUG_OUT << "numNetworks: " << wifiState.numNetworks << EOL; DEBUG_OUT << "numUnencrypted: " << wifiState.numUnencrypted << EOL; + DEBUG_OUT << "temperature: " << temperature << EOL; + DEBUG_OUT << "pressure: " << pressure << EOL; + DEBUG_OUT.print("lat: "); DEBUG_OUT.print(loc.lat(), 8); DEBUG_OUT.print(" lng: "); @@ -69,6 +78,12 @@ void measure(WifiState& wifiState, TinyGPSLocation& loc) { if (!storeMeasurement(loc.lat(), loc.lng(), wifiState.numUnencrypted, dateString, ID_SENSOR_WIFI_OPEN)) DEBUG_OUT << "measurement (wifi open) store failed!" << EOL; + if (!storeMeasurement(loc.lat(), loc.lng(), temperature, dateString, ID_SENSOR_TEMP)) + DEBUG_OUT << "measurement (temperature) store failed!" << EOL; + + if (!storeMeasurement(loc.lat(), loc.lng(), pressure, dateString, ID_SENSOR_PRESSURE)) + DEBUG_OUT << "measurement (pressure) store failed!" << EOL; + DEBUG_OUT << EOL; } @@ -142,7 +157,7 @@ void adaptiveDelay(unsigned long ms, TinyGPSLocation& lastLoc, unsigned long off /* MAIN ENTRY POINTS */ void setup() { - pinMode(BUILTIN_LED, OUTPUT); // status indicator LED: on = no GPS fix + pinMode(BUILTIN_LED, OUTPUT); // status indicator LED: on = no GPS fix digitalWrite(BUILTIN_LED, LOW); pinMode(PIN_MEASURE_MODE, INPUT_PULLUP); // switch for measurements (pull it down to disable) pinMode(PIN_UPLOAD_MODE, INPUT_PULLUP); // switch for API uploads (pull it down to disable) @@ -152,6 +167,11 @@ void setup() { wifi.begin(WIFI_SSID, WIFI_PASS); DEBUG_OUT.begin(115200); + while(!bme.begin(D14, D15)){ + adaptiveDelay(1000, location); + DEBUG_OUT.println("Could not find BME280I2C sensor!"); + } + // wait until we got a first fix from GPS, and thus an initial time // exception: measure mode is disabled (for quick upload only) if (digitalRead(PIN_MEASURE_MODE) == HIGH) {