From a5afc3d227ba1825d080dfee54c20c6f54bfba9e Mon Sep 17 00:00:00 2001 From: arendst Date: Tue, 5 Dec 2017 17:42:54 +0100 Subject: [PATCH 01/10] Provide SoftwareSerial without iram usage --- lib/EspSoftwareSerialNoIram-3.3.1/README.md | 11 + .../SoftwareSerialNoIram.cpp | 248 ++++++++++++++++++ .../SoftwareSerialNoIram.h | 88 +++++++ .../examples/swsertest/swsertest.ino | 27 ++ .../keywords.txt | 31 +++ .../library.json | 15 ++ .../library.properties | 9 + 7 files changed, 429 insertions(+) create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/README.md create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.cpp create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.h create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/examples/swsertest/swsertest.ino create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/keywords.txt create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/library.json create mode 100644 lib/EspSoftwareSerialNoIram-3.3.1/library.properties diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/README.md b/lib/EspSoftwareSerialNoIram-3.3.1/README.md new file mode 100644 index 000000000..43c4ef4a6 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/README.md @@ -0,0 +1,11 @@ +# EspSoftwareSerial + +Implementation of the Arduino software serial library for the ESP8266 + +Same functionality as the corresponding AVR library but several instances can be active at the same time. +Speed up to 115200 baud is supported. The constructor also has an optional input buffer size. + +Please note that due to the fact that the ESP always have other activities ongoing, there will be some inexactness in interrupt +timings. This may lead to bit errors when having heavy data traffic in high baud rates. + + diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.cpp b/lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.cpp new file mode 100644 index 000000000..7bcecc713 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.cpp @@ -0,0 +1,248 @@ +/* + +SoftwareSerialNoIram.cpp - Implementation of the Arduino software serial for ESP8266. +Copyright (c) 2015-2016 Peter Lerup. All rights reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library 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 +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#define TASMOTA_NO_ICACHE_RAM // To solve compile errors due to lack off iram + +#include + +// The Arduino standard GPIO routines are not enough, +// must use some from the Espressif SDK as well +extern "C" { +#include "gpio.h" +} + +#include + +#define MAX_PIN 15 + +// As the Arduino attachInterrupt has no parameter, lists of objects +// and callbacks corresponding to each possible GPIO pins have to be defined +SoftwareSerialNoIram *ObjList[MAX_PIN+1]; + +#ifdef TASMOTA_NO_ICACHE_RAM +void sws_isr_0() { ObjList[0]->rxRead(); }; +void sws_isr_1() { ObjList[1]->rxRead(); }; +void sws_isr_2() { ObjList[2]->rxRead(); }; +void sws_isr_3() { ObjList[3]->rxRead(); }; +void sws_isr_4() { ObjList[4]->rxRead(); }; +void sws_isr_5() { ObjList[5]->rxRead(); }; +// Pin 6 to 11 can not be used +void sws_isr_12() { ObjList[12]->rxRead(); }; +void sws_isr_13() { ObjList[13]->rxRead(); }; +void sws_isr_14() { ObjList[14]->rxRead(); }; +void sws_isr_15() { ObjList[15]->rxRead(); }; +#else +void ICACHE_RAM_ATTR sws_isr_0() { ObjList[0]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_1() { ObjList[1]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_2() { ObjList[2]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_3() { ObjList[3]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_4() { ObjList[4]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_5() { ObjList[5]->rxRead(); }; +// Pin 6 to 11 can not be used +void ICACHE_RAM_ATTR sws_isr_12() { ObjList[12]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_13() { ObjList[13]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_14() { ObjList[14]->rxRead(); }; +void ICACHE_RAM_ATTR sws_isr_15() { ObjList[15]->rxRead(); }; +#endif + +static void (*ISRList[MAX_PIN+1])() = { + sws_isr_0, + sws_isr_1, + sws_isr_2, + sws_isr_3, + sws_isr_4, + sws_isr_5, + NULL, + NULL, + NULL, + NULL, + NULL, + NULL, + sws_isr_12, + sws_isr_13, + sws_isr_14, + sws_isr_15 +}; + +SoftwareSerialNoIram::SoftwareSerialNoIram(int receivePin, int transmitPin, bool inverse_logic, unsigned int buffSize) { + m_rxValid = m_txValid = m_txEnableValid = false; + m_buffer = NULL; + m_invert = inverse_logic; + m_overflow = false; + m_rxEnabled = false; + if (isValidGPIOpin(receivePin)) { + m_rxPin = receivePin; + m_buffSize = buffSize; + m_buffer = (uint8_t*)malloc(m_buffSize); + if (m_buffer != NULL) { + m_rxValid = true; + m_inPos = m_outPos = 0; + pinMode(m_rxPin, INPUT); + ObjList[m_rxPin] = this; + enableRx(true); + } + } + if (isValidGPIOpin(transmitPin) || transmitPin == 16) { + m_txValid = true; + m_txPin = transmitPin; + pinMode(m_txPin, OUTPUT); + digitalWrite(m_txPin, !m_invert); + } + // Default speed + begin(9600); +} + +SoftwareSerialNoIram::~SoftwareSerialNoIram() { + enableRx(false); + if (m_rxValid) + ObjList[m_rxPin] = NULL; + if (m_buffer) + free(m_buffer); +} + +bool SoftwareSerialNoIram::isValidGPIOpin(int pin) { + return (pin >= 0 && pin <= 5) || (pin >= 12 && pin <= MAX_PIN); +} + +void SoftwareSerialNoIram::begin(long speed) { + // Use getCycleCount() loop to get as exact timing as possible + m_bitTime = ESP.getCpuFreqMHz()*1000000/speed; + m_highSpeed = speed > 9600; + + if (!m_rxEnabled) + enableRx(true); +} + +long SoftwareSerialNoIram::baudRate() { + return ESP.getCpuFreqMHz()*1000000/m_bitTime; +} + +void SoftwareSerialNoIram::setTransmitEnablePin(int transmitEnablePin) { + if (isValidGPIOpin(transmitEnablePin)) { + m_txEnableValid = true; + m_txEnablePin = transmitEnablePin; + pinMode(m_txEnablePin, OUTPUT); + digitalWrite(m_txEnablePin, LOW); + } else { + m_txEnableValid = false; + } +} + +void SoftwareSerialNoIram::enableRx(bool on) { + if (m_rxValid) { + if (on) + attachInterrupt(m_rxPin, ISRList[m_rxPin], m_invert ? RISING : FALLING); + else + detachInterrupt(m_rxPin); + m_rxEnabled = on; + } +} + +int SoftwareSerialNoIram::read() { + if (!m_rxValid || (m_inPos == m_outPos)) return -1; + uint8_t ch = m_buffer[m_outPos]; + m_outPos = (m_outPos+1) % m_buffSize; + return ch; +} + +int SoftwareSerialNoIram::available() { + if (!m_rxValid) return 0; + int avail = m_inPos - m_outPos; + if (avail < 0) avail += m_buffSize; + return avail; +} + +#define WAIT { while (ESP.getCycleCount()-start < wait) if (!m_highSpeed) optimistic_yield(1); wait += m_bitTime; } + +size_t SoftwareSerialNoIram::write(uint8_t b) { + if (!m_txValid) return 0; + + if (m_invert) b = ~b; + if (m_highSpeed) + // Disable interrupts in order to get a clean transmit + cli(); + if (m_txEnableValid) digitalWrite(m_txEnablePin, HIGH); + unsigned long wait = m_bitTime; + digitalWrite(m_txPin, HIGH); + unsigned long start = ESP.getCycleCount(); + // Start bit; + digitalWrite(m_txPin, LOW); + WAIT; + for (int i = 0; i < 8; i++) { + digitalWrite(m_txPin, (b & 1) ? HIGH : LOW); + WAIT; + b >>= 1; + } + // Stop bit + digitalWrite(m_txPin, HIGH); + WAIT; + if (m_txEnableValid) digitalWrite(m_txEnablePin, LOW); + if (m_highSpeed) + sei(); + return 1; +} + +void SoftwareSerialNoIram::flush() { + m_inPos = m_outPos = 0; +} + +bool SoftwareSerialNoIram::overflow() { + bool res = m_overflow; + m_overflow = false; + return res; +} + +int SoftwareSerialNoIram::peek() { + if (!m_rxValid || (m_inPos == m_outPos)) return -1; + return m_buffer[m_outPos]; +} + +#ifdef TASMOTA_NO_ICACHE_RAM +void SoftwareSerialNoIram::rxRead() { +#else +void ICACHE_RAM_ATTR SoftwareSerialNoIram::rxRead() { +#endif + // Advance the starting point for the samples but compensate for the + // initial delay which occurs before the interrupt is delivered + unsigned long wait = m_bitTime + m_bitTime/3 - 500; + unsigned long start = ESP.getCycleCount(); + uint8_t rec = 0; + for (int i = 0; i < 8; i++) { + WAIT; + rec >>= 1; + if (digitalRead(m_rxPin)) + rec |= 0x80; + } + if (m_invert) rec = ~rec; + // Stop bit + WAIT; + // Store the received value in the buffer unless we have an overflow + int next = (m_inPos+1) % m_buffSize; + if (next != m_outPos) { + m_buffer[m_inPos] = rec; + m_inPos = next; + } else { + m_overflow = true; + } + // Must clear this bit in the interrupt register, + // it gets set even when interrupts are disabled + GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, 1 << m_rxPin); +} diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.h b/lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.h new file mode 100644 index 000000000..4cec3b3b9 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/SoftwareSerialNoIram.h @@ -0,0 +1,88 @@ +/* +SoftwareSerialNoIram.h + +SoftwareSerialNoIram.cpp - Implementation of the Arduino software serial for ESP8266 without iram usage. +Copyright (c) 2015-2016 Peter Lerup. All rights reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library 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 +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef SoftwareSerialNoIram_h +#define SoftwareSerialNoIram_h + +#include +#include + + +// This class is compatible with the corresponding AVR one, +// the constructor however has an optional rx buffer size. +// Speed up to 115200 can be used. + + +class SoftwareSerialNoIram : public Stream +{ +public: + SoftwareSerialNoIram(int receivePin, int transmitPin, bool inverse_logic = false, unsigned int buffSize = 64); + ~SoftwareSerialNoIram(); + + void begin(long speed); + long baudRate(); + void setTransmitEnablePin(int transmitEnablePin); + + bool overflow(); + int peek(); + + virtual size_t write(uint8_t byte); + virtual int read(); + virtual int available(); + virtual void flush(); + operator bool() {return m_rxValid || m_txValid;} + + // Disable or enable interrupts on the rx pin + void enableRx(bool on); + + void rxRead(); + + // AVR compatibility methods + bool listen() { enableRx(true); return true; } + void end() { stopListening(); } + bool isListening() { return m_rxEnabled; } + bool stopListening() { enableRx(false); return true; } + + using Print::write; + +private: + bool isValidGPIOpin(int pin); + + // Member variables + int m_rxPin, m_txPin, m_txEnablePin; + bool m_rxValid, m_rxEnabled; + bool m_txValid, m_txEnableValid; + bool m_invert; + bool m_overflow; + unsigned long m_bitTime; + bool m_highSpeed; + unsigned int m_inPos, m_outPos; + int m_buffSize; + uint8_t *m_buffer; + +}; + +// If only one tx or rx wanted then use this as parameter for the unused pin +#define SW_SERIAL_UNUSED_PIN -1 + + +#endif diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/examples/swsertest/swsertest.ino b/lib/EspSoftwareSerialNoIram-3.3.1/examples/swsertest/swsertest.ino new file mode 100644 index 000000000..b3ae69711 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/examples/swsertest/swsertest.ino @@ -0,0 +1,27 @@ + +#include + +SoftwareSerial swSer(14, 12, false, 256); + +void setup() { + Serial.begin(115200); + swSer.begin(115200); + + Serial.println("\nSoftware serial test started"); + + for (char ch = ' '; ch <= 'z'; ch++) { + swSer.write(ch); + } + swSer.println(""); + +} + +void loop() { + while (swSer.available() > 0) { + Serial.write(swSer.read()); + } + while (Serial.available() > 0) { + swSer.write(Serial.read()); + } + +} diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/keywords.txt b/lib/EspSoftwareSerialNoIram-3.3.1/keywords.txt new file mode 100644 index 000000000..9f595c0e2 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/keywords.txt @@ -0,0 +1,31 @@ +####################################### +# Syntax Coloring Map for SoftwareSerialNoIram +# (esp8266) +####################################### + +####################################### +# Datatypes (KEYWORD1) +####################################### + +SoftwareSerialNoIram KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +begin KEYWORD2 +read KEYWORD2 +write KEYWORD2 +available KEYWORD2 +flush KEYWORD2 +overflow KEYWORD2 +peek KEYWORD2 +listen KEYWORD2 +end KEYWORD2 +isListening KEYWORD2 +stopListening KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### + diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/library.json b/lib/EspSoftwareSerialNoIram-3.3.1/library.json new file mode 100644 index 000000000..861d394a0 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/library.json @@ -0,0 +1,15 @@ +{ + "name": "EspSoftwareSerialNoIram", + "version": "3.3.1", + "keywords": [ + "serial", "io", "softwareserialnoiram" + ], + "description": "Implementation of the Arduino software serial for ESP8266 without iram usage.", + "repository": + { + "type": "git", + "url": "https://github.com/plerup/espsoftwareserial" + }, + "frameworks": "arduino", + "platforms": "espressif8266" +} diff --git a/lib/EspSoftwareSerialNoIram-3.3.1/library.properties b/lib/EspSoftwareSerialNoIram-3.3.1/library.properties new file mode 100644 index 000000000..b934964c1 --- /dev/null +++ b/lib/EspSoftwareSerialNoIram-3.3.1/library.properties @@ -0,0 +1,9 @@ +name=SoftwareSerialNoIram +version=1.0 +author=Peter Lerup +maintainer=Peter Lerup +sentence=Implementation of the Arduino software serial for ESP8266 without iram usage. +paragraph= +category=Signal Input/Output +url= +architectures=esp8266 From 53c5728349f464c6f328f1ff92b4c88b73714be9 Mon Sep 17 00:00:00 2001 From: arendst Date: Tue, 5 Dec 2017 17:46:26 +0100 Subject: [PATCH 02/10] Add experimental SoftwareSerial MH-Z19(B) support Add experimental support for sensor MH-Z19(B) using SoftwareSerial to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) --- sonoff/_releasenotes.ino | 1 + sonoff/user_config.h | 19 +- sonoff/xsns_15_mhz_softserial.ino | 276 ++++++++++++++++++++++++++++++ 3 files changed, 287 insertions(+), 9 deletions(-) create mode 100644 sonoff/xsns_15_mhz_softserial.ino diff --git a/sonoff/_releasenotes.ino b/sonoff/_releasenotes.ino index 76899d43a..d8da377d7 100644 --- a/sonoff/_releasenotes.ino +++ b/sonoff/_releasenotes.ino @@ -1,6 +1,7 @@ /* 5.10.0a * Add (experimental) support for sensor SHT3x * Add (experimental) support for sensor MH-Z19(B) to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) + * Add (experimental) support for sensor MH-Z19(B) using SoftwareSerial to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) * Add support for iTead SI7021 temperature and humidity sensor by consolidating DHT22 into AM2301 and using former DHT22 as SI7021 (#735) * Fix BME280 calculation (#1051) * Change ADS1115 default voltage range from +/-2V to +/-6V (#1289) diff --git a/sonoff/user_config.h b/sonoff/user_config.h index 33f4345f7..4ea4bb232 100644 --- a/sonoff/user_config.h +++ b/sonoff/user_config.h @@ -164,31 +164,32 @@ #define USE_ADC_VCC // Display Vcc in Power status. Disable for use as Analog input on selected devices // WARNING: Select none for default one DS18B20 sensor or enable one of the following two options for multiple sensors -//#define USE_DS18x20 // Optional for more than one DS18x20 sensors with id sort, single scan and read retry (+1.3k code) -//#define USE_DS18x20_LEGACY // Optional for more than one DS18x20 sensors with dynamic scan using library OneWire (+1.5k code) +//#define USE_DS18x20 // Optional for more than one DS18x20 sensors with id sort, single scan and read retry (+1k3 code) +//#define USE_DS18x20_LEGACY // Optional for more than one DS18x20 sensors with dynamic scan using library OneWire (+1k5 code) -#define USE_I2C // I2C using library wire (+10k code, 0.2k mem) - Disable by // +#define USE_I2C // I2C using library wire (+10k code, 0k2 mem) - Disable by // #define USE_SHT // Add I2C emulating code for SHT1X sensor // #define USE_SHT3X // Add I2C code for SHT3x sensor #define USE_HTU // Add I2C code for HTU21/SI7013/SI7020/SI7021 sensor #define USE_BMP // Add I2C code for BMP/BME280 sensor #define USE_BH1750 // Add I2C code for BH1750 sensor -// #define USE_VEML6070 // Add I2C code for VEML6070 sensor (+0.5k code) -// #define USE_ADS1115 // Add I2C code for ADS1115 16 bit A/D converter based on Adafruit ADS1x15 library (library not needed) (+0.7k code) +// #define USE_VEML6070 // Add I2C code for VEML6070 sensor (+0k5 code) +// #define USE_ADS1115 // Add I2C code for ADS1115 16 bit A/D converter based on Adafruit ADS1x15 library (library not needed) (+0k7 code) // #define USE_ADS1115_I2CDEV // Add I2C code for ADS1115 16 bit A/D converter using library i2cdevlib-Core and i2cdevlib-ADS1115 (+2k code) // #define USE_INA219 // Add I2C code for INA219 Low voltage and current sensor (+1k code) -#define USE_IR_REMOTE // Send IR remote commands using library IRremoteESP8266 and ArduinoJson (+4k code, 0.3k mem) +#define USE_IR_REMOTE // Send IR remote commands using library IRremoteESP8266 and ArduinoJson (+4k code, 0k3 mem) // #define USE_IR_HVAC // Support for HVAC system using IR (+2k code) - #define USE_IR_RECEIVE // Support for IR receiver (+5.5k code) + #define USE_IR_RECEIVE // Support for IR receiver (+5k5 code) #define USE_WS2812 // WS2812 Led string using library NeoPixelBus (+5k code, +1k mem) - Disable by // #define USE_WS2812_CTYPE 1 // WS2812 Color type (0 - RGB, 1 - GRB, 2 - RGBW, 3 - GRBW) // #define USE_WS2812_DMA // DMA supports only GPIO03 (= Serial RXD) (+1k mem). When USE_WS2812_DMA is enabled expect Exceptions on Pow -//#define USE_MHZ19 // Add support for MH-Z19 CO2 sensor using hardware serial interface at 9600 bps +//#define USE_MHZ19 // Add support for MH-Z19 CO2 sensor using hardware serial interface at 9600 bps (+1k1 code) +//#define USE_MHZ19_SOFT_SERIAL // Add support for MH-Z19 CO2 sensor using iram free software serial interface at 9600 bps (+2k3 code) -#define USE_ARILUX_RF // Add support for Arilux RF remote controller (+0.8k code) +#define USE_ARILUX_RF // Add support for Arilux RF remote controller (+0k8 code) /*********************************************************************************************\ * Compile a minimal version if upgrade memory gets tight ONLY TO BE USED FOR UPGRADE STEP 1! diff --git a/sonoff/xsns_15_mhz_softserial.ino b/sonoff/xsns_15_mhz_softserial.ino new file mode 100644 index 000000000..fe928a16f --- /dev/null +++ b/sonoff/xsns_15_mhz_softserial.ino @@ -0,0 +1,276 @@ +/* + xsns_15_mhz.ino - MH-Z19 CO2 sensor support for Sonoff-Tasmota + + Copyright (C) 2017 Theo Arends + + 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 . +*/ + +#ifdef USE_MHZ19_SOFT_SERIAL +/*********************************************************************************************\ + * MH-Z19 - CO2 sensor + * + * Based on EspEasy plugin P049 by Dmitry (rel22 ___ inbox.ru) + ********************************************************************************************** + * Filter usage + * + * Select filter usage on low stability readings +\*********************************************************************************************/ + +#include +SoftwareSerialNoIram *SoftSerial; + +enum Mhz19FilterOptions {MHZ19_FILTER_OFF, MHZ19_FILTER_OFF_ALLSAMPLES, MHZ19_FILTER_FAST, MHZ19_FILTER_MEDIUM, MHZ19_FILTER_SLOW}; + +#define MHZ19_FILTER_OPTION MHZ19_FILTER_FAST + +/*********************************************************************************************\ + * Source: http://www.winsen-sensor.com/d/files/infrared-gas-sensor/mh-z19b-co2-ver1_0.pdf + * + * Automatic Baseline Correction (ABC logic function) + * + * ABC logic function refers to that sensor itself do zero point judgment and automatic calibration procedure + * intelligently after a continuous operation period. The automatic calibration cycle is every 24 hours after powered on. + * + * The zero point of automatic calibration is 400ppm. + * + * This function is usually suitable for indoor air quality monitor such as offices, schools and homes, + * not suitable for greenhouse, farm and refrigeratory where this function should be off. + * + * Please do zero calibration timely, such as manual or commend calibration. +\*********************************************************************************************/ + +#define MHZ19_ABC_ENABLE 1 // Automatic Baseline Correction (0 = off, 1 = on (default)) + +/*********************************************************************************************/ + +#define MHZ19_BAUDRATE 9600 +#define MHZ19_READ_TIMEOUT 600 // Must be way less than 1000 + +const char kMhz19Types[] PROGMEM = "MHZ19|MHZ19B"; + +const byte mhz19_cmnd_read_ppm[9] = {0xFF, 0x01, 0x86, 0x00, 0x00, 0x00, 0x00, 0x00, 0x79}; +const byte mhz19_cmnd_abc_enable[9] = {0xFF, 0x01, 0x79, 0xA0, 0x00, 0x00, 0x00, 0x00, 0xE6}; +const byte mhz19_cmnd_abc_disable[9] = {0xFF, 0x01, 0x79, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86}; + +uint8_t mhz19_type = 0; +uint16_t mhz19_last_ppm = 0; +uint8_t mhz19_filter = MHZ19_FILTER_OPTION; +byte mhz19_response[9]; +bool mhz19_abc_enable = MHZ19_ABC_ENABLE; +bool mhz19_abc_must_apply = false; +char mhz19_types[7]; + +bool Mhz19CheckAndApplyFilter(uint16_t ppm, uint8_t s) +{ + if (1 == s) { + return false; // S==1 => "A" version sensor bootup, do not use values. + } + if (mhz19_last_ppm < 400 || mhz19_last_ppm > 5000) { + // Prevent unrealistic values during start-up with filtering enabled. + // Just assume the entered value is correct. + mhz19_last_ppm = ppm; + return true; + } + int32_t difference = ppm - mhz19_last_ppm; + if (s > 0 && s < 64 && mhz19_filter != MHZ19_FILTER_OFF) { + // Not the "B" version of the sensor, S value is used. + // S==0 => "B" version, else "A" version + // The S value is an indication of the stability of the reading. + // S == 64 represents a stable reading and any lower value indicates (unusual) fast change. + // Now we increase the delay filter for low values of S and increase response time when the + // value is more stable. + // This will make the reading useful in more turbulent environments, + // where the sensor would report more rapid change of measured values. + difference = difference * s; + difference /= 64; + } + switch (mhz19_filter) { + case MHZ19_FILTER_OFF: { + if (s != 0 && s != 64) { + return false; + } + break; + } + // #Samples to reach >= 75% of step response + case MHZ19_FILTER_OFF_ALLSAMPLES: + break; // No Delay + case MHZ19_FILTER_FAST: + difference /= 2; + break; // Delay: 2 samples + case MHZ19_FILTER_MEDIUM: + difference /= 4; + break; // Delay: 5 samples + case MHZ19_FILTER_SLOW: + difference /= 8; + break; // Delay: 11 samples + } + mhz19_last_ppm = static_cast(mhz19_last_ppm + difference); + return true; +} + +bool Mhz19Read(uint16_t &p, float &t) +{ + bool status = false; + + p = 0; + t = NAN; + + if (mhz19_type) + { + SoftSerial->flush(); + if (SoftSerial->write(mhz19_cmnd_read_ppm, 9) != 9) { + return false; // Unable to send 9 bytes + } + memset(mhz19_response, 0, sizeof(mhz19_response)); + uint32_t start = millis(); + uint8_t counter = 0; + while (((millis() - start) < MHZ19_READ_TIMEOUT) && (counter < 9)) { + if (SoftSerial->available() > 0) { + mhz19_response[counter++] = SoftSerial->read(); + } else { + delay(10); + } + } + if (counter < 9){ + return false; // Timeout while trying to read + } + + byte crc = 0; + for (uint8_t i = 1; i < 8; i++) { + crc += mhz19_response[i]; + } + crc = 255 - crc; + crc++; + +/* + // Test data + mhz19_response[0] = 0xFF; + mhz19_response[1] = 0x86; + mhz19_response[2] = 0x12; + mhz19_response[3] = 0x86; + mhz19_response[4] = 64; +// mhz19_response[5] = 32; + mhz19_response[8] = crc; +*/ + + if (0xFF == mhz19_response[0] && 0x86 == mhz19_response[1] && mhz19_response[8] == crc) { + uint16_t u = (mhz19_response[6] << 8) | mhz19_response[7]; + if (15000 == u) { // During (and only ever at) sensor boot, 'u' is reported as 15000 + if (!mhz19_abc_enable) { + // After bootup of the sensor the ABC will be enabled. + // Thus only actively disable after bootup. + mhz19_abc_must_apply = true; + } + } else { + uint16_t ppm = (mhz19_response[2] << 8) | mhz19_response[3]; + t = ConvertTemp((float)mhz19_response[4] - 40); + uint8_t s = mhz19_response[5]; + if (s) { + mhz19_type = 1; + } else { + mhz19_type = 2; + } + if (Mhz19CheckAndApplyFilter(ppm, s)) { + p = mhz19_last_ppm; + + if (0 == s || 64 == s) { // Reading is stable. + if (mhz19_abc_must_apply) { + mhz19_abc_must_apply = false; + if (mhz19_abc_enable) { + SoftSerial->write(mhz19_cmnd_abc_enable, 9); // Sent sensor ABC Enable + } else { + SoftSerial->write(mhz19_cmnd_abc_disable, 9); // Sent sensor ABC Disable + } + } + } + + status = true; + } + } + } + } + return status; +} + +void Mhz19Init() +{ + SoftSerial = new SoftwareSerialNoIram(pin[GPIO_MHZ_RXD], pin[GPIO_MHZ_TXD]); + SoftSerial->begin(9600); + + mhz19_type = 1; +} + +#ifdef USE_WEBSERVER +const char HTTP_SNS_CO2[] PROGMEM = + "%s{s}%s " D_CO2 "{m}%d " D_UNIT_PPM "{e}"; // {s} = , {m} = , {e} = +#endif // USE_WEBSERVER + +void Mhz19Show(boolean json) +{ + uint16_t co2; + float t; + + if (Mhz19Read(co2, t)) { + char temperature[10]; + dtostrfd(t, Settings.flag2.temperature_resolution, temperature); + GetTextIndexed(mhz19_types, sizeof(mhz19_types), mhz19_type -1, kMhz19Types); + + if (json) { + snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s,\"%s\":{\"" D_CO2 "\":%d,\"" D_TEMPERATURE "\":%s}"), mqtt_data, mhz19_types, co2, temperature); +#ifdef USE_DOMOTICZ + DomoticzSensor(DZ_COUNT, co2); +#endif // USE_DOMOTICZ +#ifdef USE_WEBSERVER + } else { + snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_SNS_CO2, mqtt_data, mhz19_types, co2); + snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_SNS_TEMP, mqtt_data, mhz19_types, temperature, TempUnit()); +#endif // USE_WEBSERVER + } + } +} + +/*********************************************************************************************\ + * Interface +\*********************************************************************************************/ + +#define XSNS_15 + +boolean Xsns15(byte function) +{ + boolean result = false; + + if ((pin[GPIO_MHZ_RXD] < 99) && (pin[GPIO_MHZ_TXD] < 99)) { + switch (function) { + case FUNC_XSNS_INIT: + Mhz19Init(); + break; + case FUNC_XSNS_PREP: +// Mhz19Prep(); + break; + case FUNC_XSNS_JSON_APPEND: + Mhz19Show(1); + break; +#ifdef USE_WEBSERVER + case FUNC_XSNS_WEB: + Mhz19Show(0); +// Mhz19Prep(); + break; +#endif // USE_WEBSERVER + } + } + return result; +} + +#endif // USE_MHZ19_SOFT_SERIAL From cad8164882cb08ff7a0d83bc73d18f8c3ade21e6 Mon Sep 17 00:00:00 2001 From: arendst Date: Wed, 6 Dec 2017 13:59:33 +0100 Subject: [PATCH 03/10] Add sht3x_v2 for testing Possibly fix loss of sht3x sensor (#1314) --- sonoff/user_config.h | 11 +-- sonoff/xsns_14_sht3x_v2.ino | 144 ++++++++++++++++++++++++++++++++++++ 2 files changed, 150 insertions(+), 5 deletions(-) create mode 100644 sonoff/xsns_14_sht3x_v2.ino diff --git a/sonoff/user_config.h b/sonoff/user_config.h index 4ea4bb232..5a35fcfd0 100644 --- a/sonoff/user_config.h +++ b/sonoff/user_config.h @@ -168,11 +168,12 @@ //#define USE_DS18x20_LEGACY // Optional for more than one DS18x20 sensors with dynamic scan using library OneWire (+1k5 code) #define USE_I2C // I2C using library wire (+10k code, 0k2 mem) - Disable by // - #define USE_SHT // Add I2C emulating code for SHT1X sensor -// #define USE_SHT3X // Add I2C code for SHT3x sensor - #define USE_HTU // Add I2C code for HTU21/SI7013/SI7020/SI7021 sensor - #define USE_BMP // Add I2C code for BMP/BME280 sensor - #define USE_BH1750 // Add I2C code for BH1750 sensor + #define USE_SHT // Add I2C emulating code for SHT1X sensor (+1k4 code) +// #define USE_SHT3X // Add I2C code for SHT3x sensor based on Adafruit (+0k7 code) +// #define USE_SHT3X_V2 // Add I2C code for SHT3x sensor based on EspEasy (+0k7 code) + #define USE_HTU // Add I2C code for HTU21/SI7013/SI7020/SI7021 sensor (+1k5 code) + #define USE_BMP // Add I2C code for BMP/BME280 sensor (+4k code) + #define USE_BH1750 // Add I2C code for BH1750 sensor (+0k5 code) // #define USE_VEML6070 // Add I2C code for VEML6070 sensor (+0k5 code) // #define USE_ADS1115 // Add I2C code for ADS1115 16 bit A/D converter based on Adafruit ADS1x15 library (library not needed) (+0k7 code) // #define USE_ADS1115_I2CDEV // Add I2C code for ADS1115 16 bit A/D converter using library i2cdevlib-Core and i2cdevlib-ADS1115 (+2k code) diff --git a/sonoff/xsns_14_sht3x_v2.ino b/sonoff/xsns_14_sht3x_v2.ino new file mode 100644 index 000000000..b048c0c0f --- /dev/null +++ b/sonoff/xsns_14_sht3x_v2.ino @@ -0,0 +1,144 @@ +/* + xsns_14_sht3x.ino - SHT3X temperature and humidity sensor support for Sonoff-Tasmota + + Copyright (C) 2017 Theo Arends + + 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 . +*/ + +#ifdef USE_I2C +#ifdef USE_SHT3X_V2 +/*********************************************************************************************\ + * SHT3X - Temperature and Humidy + * + * Required library: none but based on EspEasy plugin 68 + * + * I2C Address: 0x44 or 0x45 +\*********************************************************************************************/ + +#define SHT3X_ADDR_GND 0x44 // address pin low (GND) +#define SHT3X_ADDR_VDD 0x45 // address pin high (VDD) + +uint8_t sht3x_type = 0; +uint8_t sht3x_address; +uint8_t sht3x_addresses[] = { SHT3X_ADDR_GND, SHT3X_ADDR_VDD }; + +bool Sht3xInit() +{ + if (sht3x_type) { + return I2cWrite8(sht3x_address, 0x20, 0x32); // Periodic 0.5mps and repeatability high + } + return false; +} + +bool Sht3xRead(float &t, float &h) +{ + unsigned int data[6]; + + t = NAN; + h = NAN; + + I2cWrite8(sht3x_address, 0xE0, 0x00); // Fetch data + Wire.requestFrom(sht3x_address, (uint8_t)6); + if (Wire.available() != 6) { + return false; + } + // Read 6 bytes of data + // cTemp msb, cTemp lsb, cTemp crc, humidity msb, humidity lsb, humidity crc + for (uint8_t i = 0; i < 6; i++) { + data[i] = Wire.read(); + } + t = ConvertTemp((float)((((data[0] << 8) | data[1]) * 175) / 65535.0) - 45); + h = (float)((((data[3] << 8) | data[4]) * 100) / 65535.0); + return (!isnan(t) && !isnan(h)); +} + +/********************************************************************************************/ + +void Sht3xDetect() +{ + if (sht3x_type) { + return; + } + + sht3x_type = 1; + for (byte i = 0; i < sizeof(sht3x_addresses); i++) { + sht3x_address = sht3x_addresses[i]; + if (Sht3xInit()) { + snprintf_P(log_data, sizeof(log_data), S_LOG_I2C_FOUND_AT, "SHT3X", sht3x_address); + AddLog(LOG_LEVEL_DEBUG); + return; + } + } + sht3x_type = 0; +} + +void Sht3xShow(boolean json) +{ + if (sht3x_type) { + float t; + float h; + if (Sht3xRead(t, h)) { + char temperature[10]; + char humidity[10]; + dtostrfd(t, Settings.flag2.temperature_resolution, temperature); + dtostrfd(h, Settings.flag2.humidity_resolution, humidity); + + if (json) { + snprintf_P(mqtt_data, sizeof(mqtt_data), JSON_SNS_TEMPHUM, mqtt_data, "SHT3X", temperature, humidity); +#ifdef USE_DOMOTICZ + DomoticzTempHumSensor(temperature, humidity); +#endif // USE_DOMOTICZ +#ifdef USE_WEBSERVER + } else { + snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_SNS_TEMP, mqtt_data, "SHT3X", temperature, TempUnit()); + snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_SNS_HUM, mqtt_data, "SHT3X", humidity); +#endif // USE_WEBSERVER + } + } + } +} + +/*********************************************************************************************\ + * Interface +\*********************************************************************************************/ + +#define XSNS_14 + +boolean Xsns14(byte function) +{ + boolean result = false; + + if (i2c_flg) { + switch (function) { + case FUNC_XSNS_INIT: + Sht3xDetect(); + break; +// case FUNC_XSNS_PREP: +// break; + case FUNC_XSNS_JSON_APPEND: + Sht3xShow(1); + break; +#ifdef USE_WEBSERVER + case FUNC_XSNS_WEB: + Sht3xShow(0); + break; +#endif // USE_WEBSERVER + } + } + return result; +} + +#endif // USE_SHT3X_V2 +#endif // USE_I2C \ No newline at end of file From 7c79131bfe1c3946d5c03cf506cf9380e4b5bd52 Mon Sep 17 00:00:00 2001 From: arendst Date: Wed, 6 Dec 2017 14:04:58 +0100 Subject: [PATCH 04/10] Add support for TSL2561 (#661, #1311) Add support for TSL2561 (#661, #1311) --- .../.github/ISSUE_TEMPLATE.md | 46 +++ .../.github/PULL_REQUEST_TEMPLATE.md | 26 ++ lib/TSL2561-Arduino-Library/README.txt | 7 + lib/TSL2561-Arduino-Library/TSL2561.cpp | 301 ++++++++++++++++++ lib/TSL2561-Arduino-Library/TSL2561.h | 184 +++++++++++ .../examples/tsl2561/tsl2561.ino | 63 ++++ .../library.properties | 9 + sonoff/user_config.h | 1 + sonoff/xsns_16_tsl2561.ino | 113 +++++++ 9 files changed, 750 insertions(+) create mode 100644 lib/TSL2561-Arduino-Library/.github/ISSUE_TEMPLATE.md create mode 100644 lib/TSL2561-Arduino-Library/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 lib/TSL2561-Arduino-Library/README.txt create mode 100644 lib/TSL2561-Arduino-Library/TSL2561.cpp create mode 100644 lib/TSL2561-Arduino-Library/TSL2561.h create mode 100644 lib/TSL2561-Arduino-Library/examples/tsl2561/tsl2561.ino create mode 100644 lib/TSL2561-Arduino-Library/library.properties create mode 100644 sonoff/xsns_16_tsl2561.ino diff --git a/lib/TSL2561-Arduino-Library/.github/ISSUE_TEMPLATE.md b/lib/TSL2561-Arduino-Library/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..f0e26146f --- /dev/null +++ b/lib/TSL2561-Arduino-Library/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,46 @@ +Thank you for opening an issue on an Adafruit Arduino library repository. To +improve the speed of resolution please review the following guidelines and +common troubleshooting steps below before creating the issue: + +- **Do not use GitHub issues for troubleshooting projects and issues.** Instead use + the forums at http://forums.adafruit.com to ask questions and troubleshoot why + something isn't working as expected. In many cases the problem is a common issue + that you will more quickly receive help from the forum community. GitHub issues + are meant for known defects in the code. If you don't know if there is a defect + in the code then start with troubleshooting on the forum first. + +- **If following a tutorial or guide be sure you didn't miss a step.** Carefully + check all of the steps and commands to run have been followed. Consult the + forum if you're unsure or have questions about steps in a guide/tutorial. + +- **For Arduino projects check these very common issues to ensure they don't apply**: + + - For uploading sketches or communicating with the board make sure you're using + a **USB data cable** and **not** a **USB charge-only cable**. It is sometimes + very hard to tell the difference between a data and charge cable! Try using the + cable with other devices or swapping to another cable to confirm it is not + the problem. + + - **Be sure you are supplying adequate power to the board.** Check the specs of + your board and plug in an external power supply. In many cases just + plugging a board into your computer is not enough to power it and other + peripherals. + + - **Double check all soldering joints and connections.** Flakey connections + cause many mysterious problems. See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints. + + - **Ensure you are using an official Arduino or Adafruit board.** We can't + guarantee a clone board will have the same functionality and work as expected + with this code and don't support them. + +If you're sure this issue is a defect in the code and checked the steps above +please fill in the following fields to provide enough troubleshooting information. +You may delete the guideline and text above to just leave the following details: + +- Arduino board: **INSERT ARDUINO BOARD NAME/TYPE HERE** + +- Arduino IDE version (found in Arduino -> About Arduino menu): **INSERT ARDUINO + VERSION HERE** + +- List the steps to reproduce the problem below (if possible attach a sketch or + copy the sketch code in too): **LIST REPRO STEPS BELOW** diff --git a/lib/TSL2561-Arduino-Library/.github/PULL_REQUEST_TEMPLATE.md b/lib/TSL2561-Arduino-Library/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..7b641eb86 --- /dev/null +++ b/lib/TSL2561-Arduino-Library/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +Thank you for creating a pull request to contribute to Adafruit's GitHub code! +Before you open the request please review the following guidelines and tips to +help it be more easily integrated: + +- **Describe the scope of your change--i.e. what the change does and what parts + of the code were modified.** This will help us understand any risks of integrating + the code. + +- **Describe any known limitations with your change.** For example if the change + doesn't apply to a supported platform of the library please mention it. + +- **Please run any tests or examples that can exercise your modified code.** We + strive to not break users of the code and running tests/examples helps with this + process. + +Thank you again for contributing! We will try to test and integrate the change +as soon as we can, but be aware we have many GitHub repositories to manage and +can't immediately respond to every request. There is no need to bump or check in +on a pull request (it will clutter the discussion of the request). + +Also don't be worried if the request is closed or not integrated--sometimes the +priorities of Adafruit's GitHub code (education, ease of use) might not match the +priorities of the pull request. Don't fret, the open source community thrives on +forks and GitHub makes it easy to keep your changes in a forked repo. + +After reviewing the guidelines above you can delete this text from the pull request. diff --git a/lib/TSL2561-Arduino-Library/README.txt b/lib/TSL2561-Arduino-Library/README.txt new file mode 100644 index 000000000..f59baf9e8 --- /dev/null +++ b/lib/TSL2561-Arduino-Library/README.txt @@ -0,0 +1,7 @@ +This is an Arduino library for the TSL2561 digital luminosity (light) sensors. + +Pick one up at http://www.adafruit.com/products/439 + +To download. click the DOWNLOADS button in the top right corner, rename the uncompressed folder TSL2561. Check that the TSL2561 folder contains TSL2561.cpp and TSL2561.h + +Place the TSL2561 library folder your /libraries/ folder. You may need to create the libraries subfolder if its your first library. Restart the IDE. \ No newline at end of file diff --git a/lib/TSL2561-Arduino-Library/TSL2561.cpp b/lib/TSL2561-Arduino-Library/TSL2561.cpp new file mode 100644 index 000000000..b033aad0a --- /dev/null +++ b/lib/TSL2561-Arduino-Library/TSL2561.cpp @@ -0,0 +1,301 @@ +/**************************************************************************/ +/*! + @file tsl2561.c + @author K. Townsend (microBuilder.eu / adafruit.com) + + @section LICENSE + + Software License Agreement (BSD License) + + Copyright (c) 2010, microBuilder SARL, Adafruit Industries + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Neither the name of the copyright holders nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ +/**************************************************************************/ + +#if defined ( ESP8266 ) + #include +#else + #include + #include +#endif +#include + +#include "TSL2561.h" + +TSL2561::TSL2561(uint8_t addr) { + _addr = addr; + _initialized = false; + _integration = TSL2561_INTEGRATIONTIME_13MS; + _gain = TSL2561_GAIN_16X; + + // we cant do wire initialization till later, because we havent loaded Wire yet +} + +boolean TSL2561::begin(void) { + Wire.begin(); + + // Initialise I2C + Wire.beginTransmission(_addr); +#if ARDUINO >= 100 + Wire.write(TSL2561_REGISTER_ID); +#else + Wire.send(TSL2561_REGISTER_ID); +#endif + Wire.endTransmission(); + Wire.requestFrom(_addr, 1); +#if ARDUINO >= 100 + int x = Wire.read(); +#else + int x = Wire.receive(); +#endif + //Serial.print("0x"); Serial.println(x, HEX); + if (x & 0x0A ) { + //Serial.println("Found TSL2561"); + } else { + return false; + } + _initialized = true; + + // Set default integration time and gain + setTiming(_integration); + setGain(_gain); + // Note: by default, the device is in power down mode on bootup + disable(); + + return true; +} + +void TSL2561::enable(void) +{ + if (!_initialized) begin(); + + // Enable the device by setting the control bit to 0x03 + write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_CONTROL, TSL2561_CONTROL_POWERON); +} + +void TSL2561::disable(void) +{ + if (!_initialized) begin(); + + // Disable the device by setting the control bit to 0x03 + write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_CONTROL, TSL2561_CONTROL_POWEROFF); +} + + +void TSL2561::setGain(tsl2561Gain_t gain) { + if (!_initialized) begin(); + + enable(); + _gain = gain; + write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_TIMING, _integration | _gain); + disable(); +} + +void TSL2561::setTiming(tsl2561IntegrationTime_t integration) +{ + if (!_initialized) begin(); + + enable(); + _integration = integration; + write8(TSL2561_COMMAND_BIT | TSL2561_REGISTER_TIMING, _integration | _gain); + disable(); +} + +uint32_t TSL2561::calculateLux(uint16_t ch0, uint16_t ch1) +{ + unsigned long chScale; + unsigned long channel1; + unsigned long channel0; + + switch (_integration) + { + case TSL2561_INTEGRATIONTIME_13MS: + chScale = TSL2561_LUX_CHSCALE_TINT0; + break; + case TSL2561_INTEGRATIONTIME_101MS: + chScale = TSL2561_LUX_CHSCALE_TINT1; + break; + default: // No scaling ... integration time = 402ms + chScale = (1 << TSL2561_LUX_CHSCALE); + break; + } + + // Scale for gain (1x or 16x) + if (!_gain) chScale = chScale << 4; + + // scale the channel values + channel0 = (ch0 * chScale) >> TSL2561_LUX_CHSCALE; + channel1 = (ch1 * chScale) >> TSL2561_LUX_CHSCALE; + + // find the ratio of the channel values (Channel1/Channel0) + unsigned long ratio1 = 0; + if (channel0 != 0) ratio1 = (channel1 << (TSL2561_LUX_RATIOSCALE+1)) / channel0; + + // round the ratio value + unsigned long ratio = (ratio1 + 1) >> 1; + + unsigned int b, m; + +#ifdef TSL2561_PACKAGE_CS + if ((ratio >= 0) && (ratio <= TSL2561_LUX_K1C)) + {b=TSL2561_LUX_B1C; m=TSL2561_LUX_M1C;} + else if (ratio <= TSL2561_LUX_K2C) + {b=TSL2561_LUX_B2C; m=TSL2561_LUX_M2C;} + else if (ratio <= TSL2561_LUX_K3C) + {b=TSL2561_LUX_B3C; m=TSL2561_LUX_M3C;} + else if (ratio <= TSL2561_LUX_K4C) + {b=TSL2561_LUX_B4C; m=TSL2561_LUX_M4C;} + else if (ratio <= TSL2561_LUX_K5C) + {b=TSL2561_LUX_B5C; m=TSL2561_LUX_M5C;} + else if (ratio <= TSL2561_LUX_K6C) + {b=TSL2561_LUX_B6C; m=TSL2561_LUX_M6C;} + else if (ratio <= TSL2561_LUX_K7C) + {b=TSL2561_LUX_B7C; m=TSL2561_LUX_M7C;} + else if (ratio > TSL2561_LUX_K8C) + {b=TSL2561_LUX_B8C; m=TSL2561_LUX_M8C;} +#else + if ((ratio >= 0) && (ratio <= TSL2561_LUX_K1T)) + {b=TSL2561_LUX_B1T; m=TSL2561_LUX_M1T;} + else if (ratio <= TSL2561_LUX_K2T) + {b=TSL2561_LUX_B2T; m=TSL2561_LUX_M2T;} + else if (ratio <= TSL2561_LUX_K3T) + {b=TSL2561_LUX_B3T; m=TSL2561_LUX_M3T;} + else if (ratio <= TSL2561_LUX_K4T) + {b=TSL2561_LUX_B4T; m=TSL2561_LUX_M4T;} + else if (ratio <= TSL2561_LUX_K5T) + {b=TSL2561_LUX_B5T; m=TSL2561_LUX_M5T;} + else if (ratio <= TSL2561_LUX_K6T) + {b=TSL2561_LUX_B6T; m=TSL2561_LUX_M6T;} + else if (ratio <= TSL2561_LUX_K7T) + {b=TSL2561_LUX_B7T; m=TSL2561_LUX_M7T;} + else if (ratio > TSL2561_LUX_K8T) + {b=TSL2561_LUX_B8T; m=TSL2561_LUX_M8T;} +#endif + + unsigned long temp; + temp = ((channel0 * b) - (channel1 * m)); + + // do not allow negative lux value + if (temp < 0) temp = 0; + + // round lsb (2^(LUX_SCALE-1)) + temp += (1 << (TSL2561_LUX_LUXSCALE-1)); + + // strip off fractional portion + uint32_t lux = temp >> TSL2561_LUX_LUXSCALE; + + // Signal I2C had no errors + return lux; +} + +uint32_t TSL2561::getFullLuminosity (void) +{ + if (!_initialized) begin(); + + // Enable the device by setting the control bit to 0x03 + enable(); + + // Wait x ms for ADC to complete + switch (_integration) + { + case TSL2561_INTEGRATIONTIME_13MS: + delay(14); + break; + case TSL2561_INTEGRATIONTIME_101MS: + delay(102); + break; + default: + delay(403); + break; + } + + uint32_t x; + x = read16(TSL2561_COMMAND_BIT | TSL2561_WORD_BIT | TSL2561_REGISTER_CHAN1_LOW); + x <<= 16; + x |= read16(TSL2561_COMMAND_BIT | TSL2561_WORD_BIT | TSL2561_REGISTER_CHAN0_LOW); + + disable(); + + return x; +} +uint16_t TSL2561::getLuminosity (uint8_t channel) { + + uint32_t x = getFullLuminosity(); + + if (channel == 0) { + // Reads two byte value from channel 0 (visible + infrared) + return (x & 0xFFFF); + } else if (channel == 1) { + // Reads two byte value from channel 1 (infrared) + return (x >> 16); + } else if (channel == 2) { + // Reads all and subtracts out just the visible! + return ( (x & 0xFFFF) - (x >> 16)); + } + + // unknown channel! + return 0; +} + + +uint16_t TSL2561::read16(uint8_t reg) +{ + uint16_t x; uint16_t t; + + Wire.beginTransmission(_addr); +#if ARDUINO >= 100 + Wire.write(reg); +#else + Wire.send(reg); +#endif + Wire.endTransmission(); + + Wire.requestFrom(_addr, 2); +#if ARDUINO >= 100 + t = Wire.read(); + x = Wire.read(); +#else + t = Wire.receive(); + x = Wire.receive(); +#endif + x <<= 8; + x |= t; + return x; +} + + + +void TSL2561::write8 (uint8_t reg, uint8_t value) +{ + Wire.beginTransmission(_addr); +#if ARDUINO >= 100 + Wire.write(reg); + Wire.write(value); +#else + Wire.send(reg); + Wire.send(value); +#endif + Wire.endTransmission(); +} diff --git a/lib/TSL2561-Arduino-Library/TSL2561.h b/lib/TSL2561-Arduino-Library/TSL2561.h new file mode 100644 index 000000000..2750f2b13 --- /dev/null +++ b/lib/TSL2561-Arduino-Library/TSL2561.h @@ -0,0 +1,184 @@ + +/**************************************************************************/ +/*! + @file tsl2561.h + @author K. Townsend (microBuilder.eu) + + @section LICENSE + + Software License Agreement (BSD License) + + Copyright (c) 2010, microBuilder SARL + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + 3. Neither the name of the copyright holders nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ +/**************************************************************************/ + +#ifndef _TSL2561_H_ +#define _TSL2561_H_ + +#if ARDUINO >= 100 + #include +#else + #include +#endif +#include + +#define TSL2561_VISIBLE 2 // channel 0 - channel 1 +#define TSL2561_INFRARED 1 // channel 1 +#define TSL2561_FULLSPECTRUM 0 // channel 0 + +// 3 i2c address options! +#define TSL2561_ADDR_LOW 0x29 +#define TSL2561_ADDR_FLOAT 0x39 +#define TSL2561_ADDR_HIGH 0x49 + +// Lux calculations differ slightly for CS package +//#define TSL2561_PACKAGE_CS +#define TSL2561_PACKAGE_T_FN_CL + +#define TSL2561_READBIT (0x01) + +#define TSL2561_COMMAND_BIT (0x80) // Must be 1 +#define TSL2561_CLEAR_BIT (0x40) // Clears any pending interrupt (write 1 to clear) +#define TSL2561_WORD_BIT (0x20) // 1 = read/write word (rather than byte) +#define TSL2561_BLOCK_BIT (0x10) // 1 = using block read/write + +#define TSL2561_CONTROL_POWERON (0x03) +#define TSL2561_CONTROL_POWEROFF (0x00) + +#define TSL2561_LUX_LUXSCALE (14) // Scale by 2^14 +#define TSL2561_LUX_RATIOSCALE (9) // Scale ratio by 2^9 +#define TSL2561_LUX_CHSCALE (10) // Scale channel values by 2^10 +#define TSL2561_LUX_CHSCALE_TINT0 (0x7517) // 322/11 * 2^TSL2561_LUX_CHSCALE +#define TSL2561_LUX_CHSCALE_TINT1 (0x0FE7) // 322/81 * 2^TSL2561_LUX_CHSCALE + +// T, FN and CL package values +#define TSL2561_LUX_K1T (0x0040) // 0.125 * 2^RATIO_SCALE +#define TSL2561_LUX_B1T (0x01f2) // 0.0304 * 2^LUX_SCALE +#define TSL2561_LUX_M1T (0x01be) // 0.0272 * 2^LUX_SCALE +#define TSL2561_LUX_K2T (0x0080) // 0.250 * 2^RATIO_SCALE +#define TSL2561_LUX_B2T (0x0214) // 0.0325 * 2^LUX_SCALE +#define TSL2561_LUX_M2T (0x02d1) // 0.0440 * 2^LUX_SCALE +#define TSL2561_LUX_K3T (0x00c0) // 0.375 * 2^RATIO_SCALE +#define TSL2561_LUX_B3T (0x023f) // 0.0351 * 2^LUX_SCALE +#define TSL2561_LUX_M3T (0x037b) // 0.0544 * 2^LUX_SCALE +#define TSL2561_LUX_K4T (0x0100) // 0.50 * 2^RATIO_SCALE +#define TSL2561_LUX_B4T (0x0270) // 0.0381 * 2^LUX_SCALE +#define TSL2561_LUX_M4T (0x03fe) // 0.0624 * 2^LUX_SCALE +#define TSL2561_LUX_K5T (0x0138) // 0.61 * 2^RATIO_SCALE +#define TSL2561_LUX_B5T (0x016f) // 0.0224 * 2^LUX_SCALE +#define TSL2561_LUX_M5T (0x01fc) // 0.0310 * 2^LUX_SCALE +#define TSL2561_LUX_K6T (0x019a) // 0.80 * 2^RATIO_SCALE +#define TSL2561_LUX_B6T (0x00d2) // 0.0128 * 2^LUX_SCALE +#define TSL2561_LUX_M6T (0x00fb) // 0.0153 * 2^LUX_SCALE +#define TSL2561_LUX_K7T (0x029a) // 1.3 * 2^RATIO_SCALE +#define TSL2561_LUX_B7T (0x0018) // 0.00146 * 2^LUX_SCALE +#define TSL2561_LUX_M7T (0x0012) // 0.00112 * 2^LUX_SCALE +#define TSL2561_LUX_K8T (0x029a) // 1.3 * 2^RATIO_SCALE +#define TSL2561_LUX_B8T (0x0000) // 0.000 * 2^LUX_SCALE +#define TSL2561_LUX_M8T (0x0000) // 0.000 * 2^LUX_SCALE + +// CS package values +#define TSL2561_LUX_K1C (0x0043) // 0.130 * 2^RATIO_SCALE +#define TSL2561_LUX_B1C (0x0204) // 0.0315 * 2^LUX_SCALE +#define TSL2561_LUX_M1C (0x01ad) // 0.0262 * 2^LUX_SCALE +#define TSL2561_LUX_K2C (0x0085) // 0.260 * 2^RATIO_SCALE +#define TSL2561_LUX_B2C (0x0228) // 0.0337 * 2^LUX_SCALE +#define TSL2561_LUX_M2C (0x02c1) // 0.0430 * 2^LUX_SCALE +#define TSL2561_LUX_K3C (0x00c8) // 0.390 * 2^RATIO_SCALE +#define TSL2561_LUX_B3C (0x0253) // 0.0363 * 2^LUX_SCALE +#define TSL2561_LUX_M3C (0x0363) // 0.0529 * 2^LUX_SCALE +#define TSL2561_LUX_K4C (0x010a) // 0.520 * 2^RATIO_SCALE +#define TSL2561_LUX_B4C (0x0282) // 0.0392 * 2^LUX_SCALE +#define TSL2561_LUX_M4C (0x03df) // 0.0605 * 2^LUX_SCALE +#define TSL2561_LUX_K5C (0x014d) // 0.65 * 2^RATIO_SCALE +#define TSL2561_LUX_B5C (0x0177) // 0.0229 * 2^LUX_SCALE +#define TSL2561_LUX_M5C (0x01dd) // 0.0291 * 2^LUX_SCALE +#define TSL2561_LUX_K6C (0x019a) // 0.80 * 2^RATIO_SCALE +#define TSL2561_LUX_B6C (0x0101) // 0.0157 * 2^LUX_SCALE +#define TSL2561_LUX_M6C (0x0127) // 0.0180 * 2^LUX_SCALE +#define TSL2561_LUX_K7C (0x029a) // 1.3 * 2^RATIO_SCALE +#define TSL2561_LUX_B7C (0x0037) // 0.00338 * 2^LUX_SCALE +#define TSL2561_LUX_M7C (0x002b) // 0.00260 * 2^LUX_SCALE +#define TSL2561_LUX_K8C (0x029a) // 1.3 * 2^RATIO_SCALE +#define TSL2561_LUX_B8C (0x0000) // 0.000 * 2^LUX_SCALE +#define TSL2561_LUX_M8C (0x0000) // 0.000 * 2^LUX_SCALE + +enum +{ + TSL2561_REGISTER_CONTROL = 0x00, + TSL2561_REGISTER_TIMING = 0x01, + TSL2561_REGISTER_THRESHHOLDL_LOW = 0x02, + TSL2561_REGISTER_THRESHHOLDL_HIGH = 0x03, + TSL2561_REGISTER_THRESHHOLDH_LOW = 0x04, + TSL2561_REGISTER_THRESHHOLDH_HIGH = 0x05, + TSL2561_REGISTER_INTERRUPT = 0x06, + TSL2561_REGISTER_CRC = 0x08, + TSL2561_REGISTER_ID = 0x0A, + TSL2561_REGISTER_CHAN0_LOW = 0x0C, + TSL2561_REGISTER_CHAN0_HIGH = 0x0D, + TSL2561_REGISTER_CHAN1_LOW = 0x0E, + TSL2561_REGISTER_CHAN1_HIGH = 0x0F +}; + +typedef enum +{ + TSL2561_INTEGRATIONTIME_13MS = 0x00, // 13.7ms + TSL2561_INTEGRATIONTIME_101MS = 0x01, // 101ms + TSL2561_INTEGRATIONTIME_402MS = 0x02 // 402ms +} +tsl2561IntegrationTime_t; + +typedef enum +{ + TSL2561_GAIN_0X = 0x00, // No gain + TSL2561_GAIN_16X = 0x10, // 16x gain +} +tsl2561Gain_t; + + +class TSL2561 { + public: + TSL2561(uint8_t addr); + boolean begin(void); + void enable(void); + void disable(void); + void write8(uint8_t r, uint8_t v); + uint16_t read16(uint8_t reg); + + uint32_t calculateLux(uint16_t ch0, uint16_t ch1); + void setTiming(tsl2561IntegrationTime_t integration); + void setGain(tsl2561Gain_t gain); + uint16_t getLuminosity (uint8_t channel); + uint32_t getFullLuminosity (); + + private: + int8_t _addr; + tsl2561IntegrationTime_t _integration; + tsl2561Gain_t _gain; + + boolean _initialized; +}; +#endif diff --git a/lib/TSL2561-Arduino-Library/examples/tsl2561/tsl2561.ino b/lib/TSL2561-Arduino-Library/examples/tsl2561/tsl2561.ino new file mode 100644 index 000000000..775223071 --- /dev/null +++ b/lib/TSL2561-Arduino-Library/examples/tsl2561/tsl2561.ino @@ -0,0 +1,63 @@ +#include +#include "TSL2561.h" + +// Example for demonstrating the TSL2561 library - public domain! + +// connect SCL to analog 5 +// connect SDA to analog 4 +// connect VDD to 3.3V DC +// connect GROUND to common ground +// ADDR can be connected to ground, or vdd or left floating to change the i2c address + +// The address will be different depending on whether you let +// the ADDR pin float (addr 0x39), or tie it to ground or vcc. In those cases +// use TSL2561_ADDR_LOW (0x29) or TSL2561_ADDR_HIGH (0x49) respectively +TSL2561 tsl(TSL2561_ADDR_FLOAT); + +void setup(void) { + Serial.begin(9600); + + if (tsl.begin()) { + Serial.println("Found sensor"); + } else { + Serial.println("No sensor?"); + while (1); + } + + // You can change the gain on the fly, to adapt to brighter/dimmer light situations + //tsl.setGain(TSL2561_GAIN_0X); // set no gain (for bright situtations) + tsl.setGain(TSL2561_GAIN_16X); // set 16x gain (for dim situations) + + // Changing the integration time gives you a longer time over which to sense light + // longer timelines are slower, but are good in very low light situtations! + tsl.setTiming(TSL2561_INTEGRATIONTIME_13MS); // shortest integration time (bright light) + //tsl.setTiming(TSL2561_INTEGRATIONTIME_101MS); // medium integration time (medium light) + //tsl.setTiming(TSL2561_INTEGRATIONTIME_402MS); // longest integration time (dim light) + + // Now we're ready to get readings! +} + +void loop(void) { + // Simple data read example. Just read the infrared, fullspecrtrum diode + // or 'visible' (difference between the two) channels. + // This can take 13-402 milliseconds! Uncomment whichever of the following you want to read + uint16_t x = tsl.getLuminosity(TSL2561_VISIBLE); + //uint16_t x = tsl.getLuminosity(TSL2561_FULLSPECTRUM); + //uint16_t x = tsl.getLuminosity(TSL2561_INFRARED); + + Serial.println(x, DEC); + + // More advanced data read example. Read 32 bits with top 16 bits IR, bottom 16 bits full spectrum + // That way you can do whatever math and comparisons you want! + uint32_t lum = tsl.getFullLuminosity(); + uint16_t ir, full; + ir = lum >> 16; + full = lum & 0xFFFF; + Serial.print("IR: "); Serial.print(ir); Serial.print("\t\t"); + Serial.print("Full: "); Serial.print(full); Serial.print("\t"); + Serial.print("Visible: "); Serial.print(full - ir); Serial.print("\t"); + + Serial.print("Lux: "); Serial.println(tsl.calculateLux(full, ir)); + + delay(100); +} diff --git a/lib/TSL2561-Arduino-Library/library.properties b/lib/TSL2561-Arduino-Library/library.properties new file mode 100644 index 000000000..06d22f721 --- /dev/null +++ b/lib/TSL2561-Arduino-Library/library.properties @@ -0,0 +1,9 @@ +name=TSL2561 Arduino Library +version=1.0.0 +author=Adafruit +maintainer=Adafruit +sentence=Arduino library for using the TSL2561 Luminosity sensor +paragraph=Arduino library for using the TSL2561 Luminosity sensor +category=Sensors +url=https://github.com/adafruit/TSL2561-Arduino-Library +architectures=* diff --git a/sonoff/user_config.h b/sonoff/user_config.h index 5a35fcfd0..5c4edab7b 100644 --- a/sonoff/user_config.h +++ b/sonoff/user_config.h @@ -175,6 +175,7 @@ #define USE_BMP // Add I2C code for BMP/BME280 sensor (+4k code) #define USE_BH1750 // Add I2C code for BH1750 sensor (+0k5 code) // #define USE_VEML6070 // Add I2C code for VEML6070 sensor (+0k5 code) +// #define USE_TSL2561 // Add I2C code for TSL2561 sensor using library Adafruit TSL2561 Arduino (+1k2 code) // #define USE_ADS1115 // Add I2C code for ADS1115 16 bit A/D converter based on Adafruit ADS1x15 library (library not needed) (+0k7 code) // #define USE_ADS1115_I2CDEV // Add I2C code for ADS1115 16 bit A/D converter using library i2cdevlib-Core and i2cdevlib-ADS1115 (+2k code) // #define USE_INA219 // Add I2C code for INA219 Low voltage and current sensor (+1k code) diff --git a/sonoff/xsns_16_tsl2561.ino b/sonoff/xsns_16_tsl2561.ino new file mode 100644 index 000000000..24c9468fd --- /dev/null +++ b/sonoff/xsns_16_tsl2561.ino @@ -0,0 +1,113 @@ +/* + xsns_16_tsl2561.ino - TSL2561 light sensor support for Sonoff-Tasmota + + Copyright (C) 2017 Theo Arends + + 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 . +*/ + +#ifdef USE_I2C +#ifdef USE_TSL2561 +/*********************************************************************************************\ + * TSL2561 - Light Intensity + * + * I2C Addresses: 0x29 (low), 0x39 (float) or 0x49 (high) + * + * Using library https://github.com/adafruit/TSL2561-Arduino-Library +\*********************************************************************************************/ + +#include + +uint8_t tsl2561_address; +uint8_t tsl2561_addresses[] = { TSL2561_ADDR_LOW, TSL2561_ADDR_FLOAT, TSL2561_ADDR_HIGH }; +uint8_t tsl2561_type = 0; + +//TSL2561 tsl(TSL2561_ADDR_FLOAT); +TSL2561 *tsl; + +void Tsl2561Detect() +{ + if (tsl2561_type) { + return; + } + + for (byte i = 0; i < sizeof(tsl2561_addresses); i++) { + tsl2561_address = tsl2561_addresses[i]; + tsl = new TSL2561(tsl2561_address); + if (tsl->begin()) { + tsl->setGain(TSL2561_GAIN_16X); + tsl->setTiming(TSL2561_INTEGRATIONTIME_101MS); + tsl2561_type = 1; + snprintf_P(log_data, sizeof(log_data), S_LOG_I2C_FOUND_AT, "TSL2561", tsl2561_address); + AddLog(LOG_LEVEL_DEBUG); + break; + } + } +} + +#ifdef USE_WEBSERVER +const char HTTP_SNS_TSL2561[] PROGMEM = + "%s{s}TSL2561 " D_ILLUMINANCE "{m}%d " D_UNIT_LUX "{e}"; // {s} = , {m} = , {e} = +#endif // USE_WEBSERVER + +void Tsl2561Show(boolean json) +{ + if (tsl2561_type) { + uint16_t illuminance = tsl->getLuminosity(TSL2561_VISIBLE); + + if (json) { + snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s,\"TSL2561\":{\"" D_ILLUMINANCE "\":%d}"), mqtt_data, illuminance); +#ifdef USE_DOMOTICZ + DomoticzSensor(DZ_ILLUMINANCE, illuminance); +#endif // USE_DOMOTICZ +#ifdef USE_WEBSERVER + } else { + snprintf_P(mqtt_data, sizeof(mqtt_data), HTTP_SNS_TSL2561, mqtt_data, illuminance); +#endif // USE_WEBSERVER + } + } +} + +/*********************************************************************************************\ + * Interface +\*********************************************************************************************/ + +#define XSNS_16 + +boolean Xsns16(byte function) +{ + boolean result = false; + + if (i2c_flg) { + switch (function) { +// case FUNC_XSNS_INIT: +// break; + case FUNC_XSNS_PREP: + Tsl2561Detect(); + break; + case FUNC_XSNS_JSON_APPEND: + Tsl2561Show(1); + break; +#ifdef USE_WEBSERVER + case FUNC_XSNS_WEB: + Tsl2561Show(0); + break; +#endif // USE_WEBSERVER + } + } + return result; +} + +#endif // USE_TSL2561 +#endif // USE_I2C From c04fcd0dcfa5db8ab388b1fcc9c4607576c2933f Mon Sep 17 00:00:00 2001 From: arendst Date: Wed, 6 Dec 2017 17:14:41 +0100 Subject: [PATCH 05/10] Add support for BME680 5.10.0a * Add (experimental) support for sensor SHT3x * Add support for sensor MH-Z19(B) using serial interface to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) * Add (experimental) support for sensor MH-Z19(B) using SoftwareSerial to be enabled with define USE_MHZ19 in user_config.h (#561, #1248) * Add support for iTead SI7021 temperature and humidity sensor by consolidating DHT22 into AM2301 and using former DHT22 as SI7021 (#735) * Fix BME280 calculation (#1051) * Add support for BME680 using adafruit libraries (#1212) * Change ADS1115 default voltage range from +/-2V to +/-6V (#1289) * Add multipress support and more user configurable options to Sonoff Dual R2 (#1291) * Fix Sonoff Bridge missed learned key if learned data contains 0x55 (End of Transmission) flag (#1095, #1294) * Add support for TSL2561 using adafruit library (#661, #1311) * Add alternative support for SHT3x (#1314) --- lib/Adafruit_BME680-1.0.5/.gitignore | 1 + lib/Adafruit_BME680-1.0.5/Adafruit_BME680.cpp | 605 ++++ lib/Adafruit_BME680-1.0.5/Adafruit_BME680.h | 107 + lib/Adafruit_BME680-1.0.5/Doxyfile | 2492 +++++++++++++++++ lib/Adafruit_BME680-1.0.5/README.md | 12 + lib/Adafruit_BME680-1.0.5/bme680.c | 1150 ++++++++ lib/Adafruit_BME680-1.0.5/bme680.h | 225 ++ lib/Adafruit_BME680-1.0.5/bme680_defs.h | 512 ++++ .../docs/_adafruit___b_m_e680_8h_source.html | 91 + lib/Adafruit_BME680-1.0.5/docs/annotated.html | 78 + lib/Adafruit_BME680-1.0.5/docs/bc_s.png | Bin 0 -> 676 bytes lib/Adafruit_BME680-1.0.5/docs/bdwn.png | Bin 0 -> 147 bytes lib/Adafruit_BME680-1.0.5/docs/bme680_8c.html | 157 ++ lib/Adafruit_BME680-1.0.5/docs/bme680_8h.html | 129 + .../docs/bme680_8h_source.html | 87 + .../docs/bme680__defs_8h.html | 1160 ++++++++ .../docs/bme680__defs_8h_source.html | 135 + .../class_adafruit___b_m_e680-members.html | 94 + .../docs/class_adafruit___b_m_e680.html | 537 ++++ lib/Adafruit_BME680-1.0.5/docs/classes.html | 82 + lib/Adafruit_BME680-1.0.5/docs/closed.png | Bin 0 -> 132 bytes lib/Adafruit_BME680-1.0.5/docs/doc.png | Bin 0 -> 746 bytes lib/Adafruit_BME680-1.0.5/docs/doxygen.css | 1596 +++++++++++ lib/Adafruit_BME680-1.0.5/docs/doxygen.png | Bin 0 -> 3779 bytes lib/Adafruit_BME680-1.0.5/docs/dynsections.js | 97 + lib/Adafruit_BME680-1.0.5/docs/files.html | 78 + .../docs/folderclosed.png | Bin 0 -> 616 bytes lib/Adafruit_BME680-1.0.5/docs/folderopen.png | Bin 0 -> 597 bytes lib/Adafruit_BME680-1.0.5/docs/functions.html | 122 + .../docs/functions_func.html | 110 + .../docs/functions_vars.html | 83 + lib/Adafruit_BME680-1.0.5/docs/globals.html | 188 ++ .../docs/globals_defs.html | 172 ++ .../docs/globals_enum.html | 74 + .../docs/globals_eval.html | 77 + .../docs/globals_func.html | 115 + .../docs/globals_type.html | 74 + .../docs/globals_vars.html | 77 + .../docs/group___b_m_e680.html | 73 + lib/Adafruit_BME680-1.0.5/docs/index.html | 73 + lib/Adafruit_BME680-1.0.5/docs/jquery.js | 87 + .../docs/md__r_e_a_d_m_e.html | 80 + lib/Adafruit_BME680-1.0.5/docs/menu.js | 26 + lib/Adafruit_BME680-1.0.5/docs/menudata.js | 12 + lib/Adafruit_BME680-1.0.5/docs/modules.html | 78 + lib/Adafruit_BME680-1.0.5/docs/nav_f.png | Bin 0 -> 153 bytes lib/Adafruit_BME680-1.0.5/docs/nav_g.png | Bin 0 -> 95 bytes lib/Adafruit_BME680-1.0.5/docs/nav_h.png | Bin 0 -> 98 bytes lib/Adafruit_BME680-1.0.5/docs/open.png | Bin 0 -> 123 bytes lib/Adafruit_BME680-1.0.5/docs/pages.html | 78 + .../docs/search/all_0.html | 26 + .../docs/search/all_0.js | 4 + .../docs/search/all_1.html | 26 + .../docs/search/all_1.js | 4 + .../docs/search/all_10.html | 26 + .../docs/search/all_10.js | 4 + .../docs/search/all_2.html | 26 + .../docs/search/all_2.js | 4 + .../docs/search/all_3.html | 26 + .../docs/search/all_3.js | 4 + .../docs/search/all_4.html | 26 + .../docs/search/all_4.js | 5 + .../docs/search/all_5.html | 26 + .../docs/search/all_5.js | 9 + .../docs/search/all_6.html | 26 + .../docs/search/all_6.js | 8 + .../docs/search/all_7.html | 26 + .../docs/search/all_7.js | 4 + .../docs/search/all_8.html | 26 + .../docs/search/all_8.js | 5 + .../docs/search/all_9.html | 26 + .../docs/search/all_9.js | 5 + .../docs/search/all_a.html | 26 + .../docs/search/all_a.js | 6 + .../docs/search/all_b.html | 26 + .../docs/search/all_b.js | 28 + .../docs/search/all_c.html | 26 + .../docs/search/all_c.js | 10 + .../docs/search/all_d.html | 26 + .../docs/search/all_d.js | 8 + .../docs/search/all_e.html | 26 + .../docs/search/all_e.js | 6 + .../docs/search/all_f.html | 26 + .../docs/search/all_f.js | 4 + .../docs/search/classes_0.html | 26 + .../docs/search/classes_0.js | 4 + .../docs/search/classes_1.html | 26 + .../docs/search/classes_1.js | 8 + .../docs/search/close.png | Bin 0 -> 273 bytes .../docs/search/defines_0.html | 26 + .../docs/search/defines_0.js | 36 + .../docs/search/enums_0.html | 26 + .../docs/search/enums_0.js | 4 + .../docs/search/enumvalues_0.html | 26 + .../docs/search/enumvalues_0.js | 5 + .../docs/search/files_0.html | 26 + .../docs/search/files_0.js | 4 + .../docs/search/functions_0.html | 26 + .../docs/search/functions_0.js | 4 + .../docs/search/functions_1.html | 26 + .../docs/search/functions_1.js | 4 + .../docs/search/functions_2.html | 26 + .../docs/search/functions_2.js | 4 + .../docs/search/functions_3.html | 26 + .../docs/search/functions_3.js | 8 + .../docs/search/functions_4.html | 26 + .../docs/search/functions_4.js | 8 + .../docs/search/groups_0.html | 26 + .../docs/search/groups_0.js | 4 + .../docs/search/mag_sel.png | Bin 0 -> 563 bytes .../docs/search/nomatches.html | 12 + .../docs/search/pages_0.html | 26 + .../docs/search/pages_0.js | 4 + .../docs/search/search.css | 271 ++ .../docs/search/search.js | 791 ++++++ .../docs/search/search_l.png | Bin 0 -> 604 bytes .../docs/search/search_m.png | Bin 0 -> 158 bytes .../docs/search/search_r.png | Bin 0 -> 612 bytes .../docs/search/searchdata.js | 27 + .../docs/search/typedefs_0.html | 26 + .../docs/search/typedefs_0.js | 4 + .../docs/search/variables_0.html | 26 + .../docs/search/variables_0.js | 4 + .../docs/search/variables_1.html | 26 + .../docs/search/variables_1.js | 4 + .../docs/search/variables_2.html | 26 + .../docs/search/variables_2.js | 4 + .../docs/search/variables_3.html | 26 + .../docs/search/variables_3.js | 4 + .../docs/search/variables_4.html | 26 + .../docs/search/variables_4.js | 6 + .../docs/search/variables_5.html | 26 + .../docs/search/variables_5.js | 7 + .../docs/search/variables_6.html | 26 + .../docs/search/variables_6.js | 5 + .../docs/search/variables_7.html | 26 + .../docs/search/variables_7.js | 5 + .../docs/search/variables_8.html | 26 + .../docs/search/variables_8.js | 5 + .../docs/search/variables_9.html | 26 + .../docs/search/variables_9.js | 6 + .../docs/search/variables_a.html | 26 + .../docs/search/variables_a.js | 28 + .../docs/search/variables_b.html | 26 + .../docs/search/variables_b.js | 8 + .../docs/search/variables_c.html | 26 + .../docs/search/variables_c.js | 4 + .../docs/search/variables_d.html | 26 + .../docs/search/variables_d.js | 6 + .../docs/search/variables_e.html | 26 + .../docs/search/variables_e.js | 4 + .../docs/search/variables_f.html | 26 + .../docs/search/variables_f.js | 4 + lib/Adafruit_BME680-1.0.5/docs/splitbar.png | Bin 0 -> 314 bytes .../structbme680__calib__data-members.html | 103 + .../docs/structbme680__calib__data.html | 550 ++++ .../docs/structbme680__dev-members.html | 91 + .../docs/structbme680__dev.html | 346 +++ .../structbme680__field__data-members.html | 83 + .../docs/structbme680__field__data.html | 210 ++ .../docs/structbme680__gas__sett-members.html | 81 + .../docs/structbme680__gas__sett.html | 176 ++ .../docs/structbme680__tph__sett-members.html | 80 + .../docs/structbme680__tph__sett.html | 159 ++ lib/Adafruit_BME680-1.0.5/docs/sync_off.png | Bin 0 -> 853 bytes lib/Adafruit_BME680-1.0.5/docs/sync_on.png | Bin 0 -> 845 bytes lib/Adafruit_BME680-1.0.5/docs/tab_a.png | Bin 0 -> 142 bytes lib/Adafruit_BME680-1.0.5/docs/tab_b.png | Bin 0 -> 169 bytes lib/Adafruit_BME680-1.0.5/docs/tab_h.png | Bin 0 -> 177 bytes lib/Adafruit_BME680-1.0.5/docs/tab_s.png | Bin 0 -> 184 bytes lib/Adafruit_BME680-1.0.5/docs/tabs.css | 1 + .../examples/bme680oled/bme680oled.ino | 88 + .../examples/bme680test/bme680test.ino | 79 + lib/Adafruit_BME680-1.0.5/library.properties | 9 + .../Adafruit_Sensor.h | 154 + lib/Adafruit_Sensor-1.0.2.02/README.md | 221 ++ .../library.properties | 9 + sonoff/_releasenotes.ino | 5 +- sonoff/user_config.h | 5 +- sonoff/xsns_09_bmp.ino | 185 +- sonoff/xsns_10_bh1750.ino | 8 +- sonoff/xsns_11_veml6070.ino | 20 +- sonoff/xsns_12_ads1115.ino | 6 +- sonoff/xsns_12_ads1115_i2cdev.ino | 6 +- sonoff/xsns_13_ina219.ino | 6 +- 185 files changed, 16232 insertions(+), 119 deletions(-) create mode 100644 lib/Adafruit_BME680-1.0.5/.gitignore create mode 100644 lib/Adafruit_BME680-1.0.5/Adafruit_BME680.cpp create mode 100644 lib/Adafruit_BME680-1.0.5/Adafruit_BME680.h create mode 100644 lib/Adafruit_BME680-1.0.5/Doxyfile create mode 100644 lib/Adafruit_BME680-1.0.5/README.md create mode 100644 lib/Adafruit_BME680-1.0.5/bme680.c create mode 100644 lib/Adafruit_BME680-1.0.5/bme680.h create mode 100644 lib/Adafruit_BME680-1.0.5/bme680_defs.h create mode 100644 lib/Adafruit_BME680-1.0.5/docs/_adafruit___b_m_e680_8h_source.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/annotated.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bc_s.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bdwn.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bme680_8c.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bme680_8h.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bme680_8h_source.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bme680__defs_8h.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/bme680__defs_8h_source.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/class_adafruit___b_m_e680-members.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/class_adafruit___b_m_e680.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/classes.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/closed.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/doc.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/doxygen.css create mode 100644 lib/Adafruit_BME680-1.0.5/docs/doxygen.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/dynsections.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/files.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/folderclosed.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/folderopen.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/functions.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/functions_func.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/functions_vars.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals_defs.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals_enum.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals_eval.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals_func.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals_type.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/globals_vars.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/group___b_m_e680.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/index.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/jquery.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/md__r_e_a_d_m_e.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/menu.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/menudata.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/modules.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/nav_f.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/nav_g.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/nav_h.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/open.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/pages.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_1.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_1.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_10.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_10.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_2.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_2.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_3.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_3.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_4.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_4.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_5.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_5.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_6.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_6.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_7.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_7.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_8.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_8.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_9.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_9.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_a.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_a.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_b.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_b.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_c.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_c.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_d.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_d.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_e.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_e.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_f.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/all_f.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/classes_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/classes_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/classes_1.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/classes_1.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/close.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/defines_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/defines_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/enums_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/enums_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/enumvalues_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/enumvalues_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/files_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/files_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_1.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_1.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_2.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_2.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_3.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_3.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_4.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/functions_4.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/groups_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/groups_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/mag_sel.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/nomatches.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/pages_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/pages_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/search.css create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/search.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/search_l.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/search_m.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/search_r.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/searchdata.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/typedefs_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/typedefs_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_0.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_0.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_1.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_1.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_2.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_2.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_3.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_3.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_4.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_4.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_5.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_5.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_6.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_6.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_7.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_7.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_8.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_8.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_9.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_9.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_a.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_a.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_b.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_b.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_c.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_c.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_d.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_d.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_e.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_e.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_f.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/search/variables_f.js create mode 100644 lib/Adafruit_BME680-1.0.5/docs/splitbar.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__calib__data-members.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__calib__data.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__dev-members.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__dev.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__field__data-members.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__field__data.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__gas__sett-members.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__gas__sett.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__tph__sett-members.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/structbme680__tph__sett.html create mode 100644 lib/Adafruit_BME680-1.0.5/docs/sync_off.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/sync_on.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/tab_a.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/tab_b.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/tab_h.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/tab_s.png create mode 100644 lib/Adafruit_BME680-1.0.5/docs/tabs.css create mode 100644 lib/Adafruit_BME680-1.0.5/examples/bme680oled/bme680oled.ino create mode 100644 lib/Adafruit_BME680-1.0.5/examples/bme680test/bme680test.ino create mode 100644 lib/Adafruit_BME680-1.0.5/library.properties create mode 100644 lib/Adafruit_Sensor-1.0.2.02/Adafruit_Sensor.h create mode 100644 lib/Adafruit_Sensor-1.0.2.02/README.md create mode 100644 lib/Adafruit_Sensor-1.0.2.02/library.properties diff --git a/lib/Adafruit_BME680-1.0.5/.gitignore b/lib/Adafruit_BME680-1.0.5/.gitignore new file mode 100644 index 000000000..b25c15b81 --- /dev/null +++ b/lib/Adafruit_BME680-1.0.5/.gitignore @@ -0,0 +1 @@ +*~ diff --git a/lib/Adafruit_BME680-1.0.5/Adafruit_BME680.cpp b/lib/Adafruit_BME680-1.0.5/Adafruit_BME680.cpp new file mode 100644 index 000000000..089065994 --- /dev/null +++ b/lib/Adafruit_BME680-1.0.5/Adafruit_BME680.cpp @@ -0,0 +1,605 @@ +/*************************************************************************** + This is a library for the BME680 humidity, temperature & pressure sensor + + Designed specifically to work with the Adafruit BME680 Breakout + ----> http://www.adafruit.com/products/2650 + + These sensors use I2C or SPI to communicate, 2 or 4 pins are required + to interface. + + Adafruit invests time and resources providing this open source code, + please support Adafruit andopen-source hardware by purchasing products + from Adafruit! + + Written by Limor Fried & Kevin Townsend for Adafruit Industries. + BSD license, all text above must be included in any redistribution + ***************************************************************************/ +#include "Arduino.h" +#include "Adafruit_BME680.h" + +//#define BME680_DEBUG + +// must be global in order to work with underlying library +int8_t _BME680_SoftwareSPI_MOSI, _BME680_SoftwareSPI_MISO, _BME680_SoftwareSPI_SCK; + +// Our hardware interface functions +static int8_t i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len); +static int8_t i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len); +static int8_t spi_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len); +static int8_t spi_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len); +static uint8_t spi_transfer(uint8_t x); +static void delay_msec(uint32_t ms); + +/*************************************************************************** + PUBLIC FUNCTIONS + ***************************************************************************/ + +/**************************************************************************/ +/*! + @brief Instantiates sensor with Hardware SPI or I2C. + @param cspin SPI chip select. If not passed in, I2C will be used +*/ +/**************************************************************************/ +Adafruit_BME680::Adafruit_BME680(int8_t cspin) + : _cs(cspin) +{ + _BME680_SoftwareSPI_MOSI = -1; + _BME680_SoftwareSPI_MISO = -1; + _BME680_SoftwareSPI_SCK = -1; + _filterEnabled = _tempEnabled = _humEnabled = _presEnabled = _gasEnabled = false; +} + + +/**************************************************************************/ +/*! + @brief Instantiates sensor with Software (bit-bang) SPI. + @param cspin SPI chip select + @param mosipin SPI MOSI (Data from microcontroller to sensor) + @param misopin SPI MISO (Data to microcontroller from sensor) + @param sckpin SPI Clock +*/ +/**************************************************************************/ +Adafruit_BME680::Adafruit_BME680(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin) + : _cs(cspin) +{ + _BME680_SoftwareSPI_MOSI = mosipin; + _BME680_SoftwareSPI_MISO = misopin; + _BME680_SoftwareSPI_SCK = sckpin; + _filterEnabled = _tempEnabled = _humEnabled = _presEnabled = _gasEnabled = false; +} + + + +/**************************************************************************/ +/*! + @brief Initializes the sensor + + Hardware ss initialized, verifies it is in the I2C or SPI bus, then reads + calibration data in preparation for sensor reads. + + @param addr Optional parameter for the I2C address of BME680. Default is 0x77 + @return True on sensor initialization success. False on failure. +*/ +/**************************************************************************/ +bool Adafruit_BME680::begin(uint8_t addr) { + _i2caddr = addr; + + if (_cs == -1) { + // i2c + Wire.begin(); + + gas_sensor.dev_id = addr; + gas_sensor.intf = BME680_I2C_INTF; + gas_sensor.read = &i2c_read; + gas_sensor.write = &i2c_write; + } else { + digitalWrite(_cs, HIGH); + pinMode(_cs, OUTPUT); + + if (_BME680_SoftwareSPI_SCK == -1) { + // hardware SPI + SPI.begin(); + } else { + // software SPI + pinMode(_BME680_SoftwareSPI_SCK, OUTPUT); + pinMode(_BME680_SoftwareSPI_MOSI, OUTPUT); + pinMode(_BME680_SoftwareSPI_MISO, INPUT); + } + + gas_sensor.dev_id = _cs; + gas_sensor.intf = BME680_SPI_INTF; + gas_sensor.read = &spi_read; + gas_sensor.write = &spi_write; + } + + gas_sensor.delay_ms = delay_msec; + + int8_t rslt = BME680_OK; + rslt = bme680_init(&gas_sensor); +#ifdef BME680_DEBUG + Serial.print("Result: "); Serial.println(rslt); +#endif + + if (rslt != BME680_OK) + return false; + +#ifdef BME680_DEBUG + Serial.print("T1 = "); Serial.println(gas_sensor.calib.par_t1); + Serial.print("T2 = "); Serial.println(gas_sensor.calib.par_t2); + Serial.print("T3 = "); Serial.println(gas_sensor.calib.par_t3); + Serial.print("P1 = "); Serial.println(gas_sensor.calib.par_p1); + Serial.print("P2 = "); Serial.println(gas_sensor.calib.par_p2); + Serial.print("P3 = "); Serial.println(gas_sensor.calib.par_p3); + Serial.print("P4 = "); Serial.println(gas_sensor.calib.par_p4); + Serial.print("P5 = "); Serial.println(gas_sensor.calib.par_p5); + Serial.print("P6 = "); Serial.println(gas_sensor.calib.par_p6); + Serial.print("P7 = "); Serial.println(gas_sensor.calib.par_p7); + Serial.print("P8 = "); Serial.println(gas_sensor.calib.par_p8); + Serial.print("P9 = "); Serial.println(gas_sensor.calib.par_p9); + Serial.print("P10 = "); Serial.println(gas_sensor.calib.par_p10); + Serial.print("H1 = "); Serial.println(gas_sensor.calib.par_h1); + Serial.print("H2 = "); Serial.println(gas_sensor.calib.par_h2); + Serial.print("H3 = "); Serial.println(gas_sensor.calib.par_h3); + Serial.print("H4 = "); Serial.println(gas_sensor.calib.par_h4); + Serial.print("H5 = "); Serial.println(gas_sensor.calib.par_h5); + Serial.print("H6 = "); Serial.println(gas_sensor.calib.par_h6); + Serial.print("H7 = "); Serial.println(gas_sensor.calib.par_h7); + Serial.print("G1 = "); Serial.println(gas_sensor.calib.par_gh1); + Serial.print("G2 = "); Serial.println(gas_sensor.calib.par_gh2); + Serial.print("G3 = "); Serial.println(gas_sensor.calib.par_gh3); + Serial.print("G1 = "); Serial.println(gas_sensor.calib.par_gh1); + Serial.print("G2 = "); Serial.println(gas_sensor.calib.par_gh2); + Serial.print("G3 = "); Serial.println(gas_sensor.calib.par_gh3); + Serial.print("Heat Range = "); Serial.println(gas_sensor.calib.res_heat_range); + Serial.print("Heat Val = "); Serial.println(gas_sensor.calib.res_heat_val); + Serial.print("SW Error = "); Serial.println(gas_sensor.calib.range_sw_err); +#endif + + setTemperatureOversampling(BME680_OS_8X); + setHumidityOversampling(BME680_OS_2X); + setPressureOversampling(BME680_OS_4X); + setIIRFilterSize(BME680_FILTER_SIZE_3); + setGasHeater(320, 150); // 320*C for 150 ms + + // don't do anything till we request a reading + gas_sensor.power_mode = BME680_FORCED_MODE; + + return true; +} + + + +/**************************************************************************/ +/*! + @brief Performs a reading and returns the ambient temperature. + @return Temperature in degrees Centigrade +*/ +/**************************************************************************/ +float Adafruit_BME680::readTemperature(void) { + performReading(); + return temperature; +} + + +/**************************************************************************/ +/*! + @brief Performs a reading and returns the barometric pressure. + @return Barometic pressure in Pascals +*/ +/**************************************************************************/ +float Adafruit_BME680::readPressure(void) { + performReading(); + return pressure; +} + + +/**************************************************************************/ +/*! + @brief Performs a reading and returns the relative humidity. + @return Relative humidity as floating point +*/ +/**************************************************************************/ +float Adafruit_BME680::readHumidity(void) { + performReading(); + return humidity; +} + +/**************************************************************************/ +/*! + @brief Calculates the resistance of the MOX gas sensor. + @return Resistance in Ohms +*/ +/**************************************************************************/ +uint32_t Adafruit_BME680::readGas(void) { + performReading(); + return gas_resistance; +} + + +/**************************************************************************/ +/*! + @brief Calculates the altitude (in meters). + + Reads the current atmostpheric pressure (in hPa) from the sensor and calculates + via the provided sea-level pressure (in hPa). + + @param seaLevel Sea-level pressure in hPa + @return Altitude in meters +*/ +/**************************************************************************/ +float Adafruit_BME680::readAltitude(float seaLevel) +{ + // Equation taken from BMP180 datasheet (page 16): + // http://www.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf + + // Note that using the equation from wikipedia can give bad results + // at high altitude. See this thread for more information: + // http://forums.adafruit.com/viewtopic.php?f=22&t=58064 + + float atmospheric = readPressure() / 100.0F; + return 44330.0 * (1.0 - pow(atmospheric / seaLevel, 0.1903)); +} + +/**************************************************************************/ +/*! + @brief Performs a full reading of all 4 sensors in the BME680. + + Assigns the internal Adafruit_BME680#temperature, Adafruit_BME680#pressure, Adafruit_BME680#humidity + and Adafruit_BME680#gas_resistance member variables + + @return True on success, False on failure +*/ +/**************************************************************************/ +bool Adafruit_BME680::performReading(void) { + uint8_t set_required_settings = 0; + struct bme680_field_data data; + int8_t rslt; + + /* Select the power mode */ + /* Must be set before writing the sensor configuration */ + gas_sensor.power_mode = BME680_FORCED_MODE; + + /* Set the required sensor settings needed */ + if (_tempEnabled) + set_required_settings |= BME680_OST_SEL; + if (_humEnabled) + set_required_settings |= BME680_OSH_SEL; + if (_presEnabled) + set_required_settings |= BME680_OSP_SEL; + if (_filterEnabled) + set_required_settings |= BME680_FILTER_SEL; + if (_gasEnabled) + set_required_settings |= BME680_GAS_SENSOR_SEL; + + /* Set the desired sensor configuration */ + //Serial.println("Setting sensor settings"); + rslt = bme680_set_sensor_settings(set_required_settings, &gas_sensor); + if (rslt != BME680_OK) + return false; + + /* Set the power mode */ + //Serial.println("Setting power mode"); + rslt = bme680_set_sensor_mode(&gas_sensor); + if (rslt != BME680_OK) + return false; + + /* Get the total measurement duration so as to sleep or wait till the + * measurement is complete */ + uint16_t meas_period; + bme680_get_profile_dur(&meas_period, &gas_sensor); + //Serial.print("Waiting (ms) "); Serial.println(meas_period); + delay(meas_period * 2); /* Delay till the measurement is ready */ + + //Serial.print("t_fine = "); Serial.println(gas_sensor.calib.t_fine); + + //Serial.println("Getting sensor data"); + rslt = bme680_get_sensor_data(&data, &gas_sensor); + if (rslt != BME680_OK) + return false; + + if (_tempEnabled) { + //Serial.print("Temp: "); Serial.println(data.temperature / 100.0, 2); + temperature = data.temperature / 100.0; + } else { + temperature = NAN; + } + + if (_humEnabled) { + //Serial.print("Hum: "); Serial.println(data.humidity / 1000.0, 2); + humidity = data.humidity / 1000.0; + } else { + humidity = NAN; + } + + if (_presEnabled) { + //Serial.print("Pres: "); Serial.println(data.pressure / 100.0, 2); + pressure = data.pressure; + } else { + pressure = NAN; + } + + /* Avoid using measurements from an unstable heating setup */ + if (_gasEnabled) { + if (data.status & BME680_HEAT_STAB_MSK) { + //Serial.print("Gas resistance: "); Serial.println(data.gas_resistance); + gas_resistance = data.gas_resistance; + } else { + gas_resistance = 0; + //Serial.println("Gas reading unstable!"); + } + } + + return true; +} + +/**************************************************************************/ +/*! + @brief Enable and configure gas reading + heater + @param heaterTemp Desired temperature in degrees Centigrade + @param heaterTime Time to keep heater on in milliseconds + @return True on success, False on failure +*/ +/**************************************************************************/ +bool Adafruit_BME680::setGasHeater(uint16_t heaterTemp, uint16_t heaterTime) { + gas_sensor.gas_sett.heatr_temp = heaterTemp; + gas_sensor.gas_sett.heatr_dur = heaterTime; + + if ( (heaterTemp == 0) || (heaterTime == 0) ) { + // disabled! + gas_sensor.gas_sett.run_gas = BME680_DISABLE_GAS_MEAS; + _gasEnabled = false; + } else { + gas_sensor.gas_sett.run_gas = BME680_ENABLE_GAS_MEAS; + _gasEnabled = true; + } + return true; +} + + +/**************************************************************************/ +/*! + @brief Setter for Temperature oversampling + @param oversample Oversampling setting, can be BME680_OS_NONE (turn off Temperature reading), + BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X + @return True on success, False on failure +*/ +/**************************************************************************/ + +bool Adafruit_BME680::setTemperatureOversampling(uint8_t oversample) { + if (oversample > BME680_OS_16X) return false; + + gas_sensor.tph_sett.os_temp = oversample; + + if (oversample == BME680_OS_NONE) + _tempEnabled = false; + else + _tempEnabled = true; + + return true; +} + + +/**************************************************************************/ +/*! + @brief Setter for Humidity oversampling + @param oversample Oversampling setting, can be BME680_OS_NONE (turn off Humidity reading), + BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X + @return True on success, False on failure +*/ +/**************************************************************************/ + +bool Adafruit_BME680::setHumidityOversampling(uint8_t oversample) { + if (oversample > BME680_OS_16X) return false; + + gas_sensor.tph_sett.os_hum = oversample; + + if (oversample == BME680_OS_NONE) + _humEnabled = false; + else + _humEnabled = true; + + return true; +} + + +/**************************************************************************/ +/*! + @brief Setter for Pressure oversampling + @param oversample Oversampling setting, can be BME680_OS_NONE (turn off Pressure reading), + BME680_OS_1X, BME680_OS_2X, BME680_OS_4X, BME680_OS_8X or BME680_OS_16X + @return True on success, False on failure +*/ +/**************************************************************************/ +bool Adafruit_BME680::setPressureOversampling(uint8_t oversample) { + if (oversample > BME680_OS_16X) return false; + + gas_sensor.tph_sett.os_pres = oversample; + + if (oversample == BME680_OS_NONE) + _presEnabled = false; + else + _presEnabled = true; + + return true; +} + +/**************************************************************************/ +/*! + @brief Setter for IIR filter. + @param filtersize Size of the filter (in samples). Can be BME680_FILTER_SIZE_0 (no filtering), BME680_FILTER_SIZE_1, BME680_FILTER_SIZE_3, BME680_FILTER_SIZE_7, BME680_FILTER_SIZE_15, BME680_FILTER_SIZE_31, BME680_FILTER_SIZE_63, BME680_FILTER_SIZE_127 + @return True on success, False on failure + +*/ +/**************************************************************************/ +bool Adafruit_BME680::setIIRFilterSize(uint8_t filtersize) { + if (filtersize > BME680_FILTER_SIZE_127) return false; + + gas_sensor.tph_sett.filter = filtersize; + + if (filtersize == BME680_FILTER_SIZE_0) + _filterEnabled = false; + else + _filterEnabled = true; + + return true; +} + +/**************************************************************************/ +/*! + @brief Reads 8 bit values over I2C +*/ +/**************************************************************************/ +int8_t i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) { +#ifdef BME680_DEBUG + Serial.print("\tI2C $"); Serial.print(reg_addr, HEX); Serial.print(" => "); +#endif + + Wire.beginTransmission((uint8_t)dev_id); + Wire.write((uint8_t)reg_addr); + Wire.endTransmission(); + if (len != Wire.requestFrom((uint8_t)dev_id, (byte)len)) { +#ifdef BME680_DEBUG + Serial.print("Failed to read "); Serial.print(len); Serial.print(" bytes from "); Serial.println(dev_id, HEX); +#endif + return 1; + } + while (len--) { + *reg_data = (uint8_t)Wire.read(); +#ifdef BME680_DEBUG + Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", "); +#endif + reg_data++; + } +#ifdef BME680_DEBUG + Serial.println(""); +#endif + return 0; +} + +/**************************************************************************/ +/*! + @brief Writes 8 bit values over I2C +*/ +/**************************************************************************/ +int8_t i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) { +#ifdef BME680_DEBUG + Serial.print("\tI2C $"); Serial.print(reg_addr, HEX); Serial.print(" <= "); +#endif + Wire.beginTransmission((uint8_t)dev_id); + Wire.write((uint8_t)reg_addr); + while (len--) { + Wire.write(*reg_data); +#ifdef BME680_DEBUG + Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", "); +#endif + reg_data++; + } + Wire.endTransmission(); +#ifdef BME680_DEBUG + Serial.println(""); +#endif + return 0; +} + + + +/**************************************************************************/ +/*! + @brief Reads 8 bit values over SPI +*/ +/**************************************************************************/ +static int8_t spi_read(uint8_t cspin, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) { +#ifdef BME680_DEBUG + Serial.print("\tSPI $"); Serial.print(reg_addr, HEX); Serial.print(" => "); +#endif + + digitalWrite(cspin, LOW); + + // If hardware SPI we should use transactions! + if (_BME680_SoftwareSPI_SCK == -1) { + SPI.beginTransaction(SPISettings(BME680_DEFAULT_SPIFREQ, MSBFIRST, SPI_MODE0)); + } + + spi_transfer(reg_addr); + + while (len--) { + *reg_data = spi_transfer(0x00); +#ifdef BME680_DEBUG + Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", "); +#endif + reg_data++; + } + + if (_BME680_SoftwareSPI_SCK == -1) { + SPI.endTransaction(); + } + + digitalWrite(cspin, HIGH); + +#ifdef BME680_DEBUG + Serial.println(""); +#endif + return 0; +} + +/**************************************************************************/ +/*! + @brief Writes 8 bit values over SPI +*/ +/**************************************************************************/ +static int8_t spi_write(uint8_t cspin, uint8_t reg_addr, uint8_t *reg_data, uint16_t len) { +#ifdef BME680_DEBUG + Serial.print("\tSPI $"); Serial.print(reg_addr, HEX); Serial.print(" <= "); +#endif + + digitalWrite(cspin, LOW); + + // If hardware SPI we should use transactions! + if (_BME680_SoftwareSPI_SCK == -1) { + SPI.beginTransaction(SPISettings(BME680_DEFAULT_SPIFREQ, MSBFIRST, SPI_MODE0)); + } + + spi_transfer(reg_addr); + while (len--) { + spi_transfer(*reg_data); +#ifdef BME680_DEBUG + Serial.print("0x"); Serial.print(*reg_data, HEX); Serial.print(", "); +#endif + reg_data++; + } + + if (_BME680_SoftwareSPI_SCK == -1) { + SPI.endTransaction(); + } + + digitalWrite(cspin, HIGH); + +#ifdef BME680_DEBUG + Serial.println(""); +#endif + return 0; +} + + +static uint8_t spi_transfer(uint8_t x) { + if (_BME680_SoftwareSPI_SCK == -1) + return SPI.transfer(x); + + // software spi + //Serial.println("Software SPI"); + uint8_t reply = 0; + for (int i=7; i>=0; i--) { + reply <<= 1; + digitalWrite(_BME680_SoftwareSPI_SCK, LOW); + digitalWrite(_BME680_SoftwareSPI_MOSI, x & (1< http://www.adafruit.com/products/XXXX + + These sensors use I2C or SPI to communicate, 2 or 4 pins are required + to interface. + + Adafruit invests time and resources providing this open source code, + please support Adafruit andopen-source hardware by purchasing products + from Adafruit! + + Written by Limor Fried & Kevin Townsend for Adafruit Industries. + BSD license, all text above must be included in any redistribution + ***************************************************************************/ +#ifndef __BME680_H__ +#define __BME680_H__ + +#if (ARDUINO >= 100) + #include "Arduino.h" +#else + #include "WProgram.h" +#endif +#include +#include +#include +#include +#include "bme680.h" + + +/*========================================================================= + I2C ADDRESS/BITS + -----------------------------------------------------------------------*/ +#define BME680_DEFAULT_ADDRESS (0x77) +/*=========================================================================*/ +#define BME680_DEFAULT_SPIFREQ (1000000) + + + +/* +class Adafruit_BME680_Unified : public Adafruit_Sensor +{ +public: + Adafruit_BME680_Unified(int32_t sensorID = -1); + + bool begin(uint8_t addr = BME680_ADDRESS); + void getTemperature(float *temp); + void getPressure(float *pressure); + float pressureToAltitude(float seaLevel, float atmospheric, float temp); + float seaLevelForAltitude(float altitude, float atmospheric, float temp); + void getEvent(sensors_event_t*); + void getSensor(sensor_t*); + + private: + uint8_t _i2c_addr; + int32_t _sensorID; +}; + +*/ + +/** Adafruit_BME680 Class for both I2C and SPI usage. + * Wraps the Bosch library for Arduino usage + */ + +class Adafruit_BME680 +{ + public: + Adafruit_BME680(int8_t cspin = -1); + Adafruit_BME680(int8_t cspin, int8_t mosipin, int8_t misopin, int8_t sckpin); + + bool begin(uint8_t addr = BME680_DEFAULT_ADDRESS); + float readTemperature(void); + float readPressure(void); + float readHumidity(void); + uint32_t readGas(void); + float readAltitude(float seaLevel); + + bool setTemperatureOversampling(uint8_t os); + bool setPressureOversampling(uint8_t os); + bool setHumidityOversampling(uint8_t os); + bool setIIRFilterSize(uint8_t fs); + bool setGasHeater(uint16_t heaterTemp, uint16_t heaterTime); + + bool performReading(void); + + /// Temperature (Celsius) assigned after calling performReading() + float temperature; + /// Pressure (Pascals) assigned after calling performReading() + float pressure; + /// Humidity (RH %) assigned after calling performReading() + float humidity; + /// Gas resistor (ohms) assigned after calling performReading() + float gas_resistance; + private: + + bool _filterEnabled, _tempEnabled, _humEnabled, _presEnabled, _gasEnabled; + uint8_t _i2caddr; + int32_t _sensorID; + int8_t _cs; + + uint8_t spixfer(uint8_t x); + + struct bme680_dev gas_sensor; +}; + +#endif diff --git a/lib/Adafruit_BME680-1.0.5/Doxyfile b/lib/Adafruit_BME680-1.0.5/Doxyfile new file mode 100644 index 000000000..f21c9d41d --- /dev/null +++ b/lib/Adafruit_BME680-1.0.5/Doxyfile @@ -0,0 +1,2492 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Adafruit BME680 Library" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = bme680.c bme680.h bme680_defs.h + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = docs + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /