From 883fb041d7a83cee39357b437d5d1d8c26b6baba Mon Sep 17 00:00:00 2001 From: Theo Arends Date: Mon, 23 Apr 2018 16:59:04 +0200 Subject: [PATCH] Add firmware info and Credits --- README.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 105 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f7b285e56..b5e83f708 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,9 @@ If you like **Sonoff-Tasmota**, give it a star, or fork it and contribute! Current version is **5.12.0m** - See [sonoff/_releasenotes.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_releasenotes.ino) for change information. ### Quick install - Download one of the released binaries from https://github.com/arendst/Sonoff-Tasmota/releases and flash it to your hardware as documented in the wiki. ### Important User Compilation Information - If you want to compile Sonoff-Tasmota yourself keep in mind the following: - Only Flash Mode **DOUT** is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. See [Wiki](https://github.com/arendst/Sonoff-Tasmota/wiki/Theo's-Tasmota-Tips) for background information. @@ -28,7 +26,6 @@ If you want to compile Sonoff-Tasmota yourself keep in mind the following: - To make compile time changes to Sonoff-Tasmota it can use the ``user_config_override.h`` file. It assures keeping your settings when you download and compile a new version. To use ``user_config.override.h`` you will have to make a copy of the provided ``user_config.override_sample.h`` file and add your setting overrides. To enable the override file you will need to use a compile define as documented in the ``user_config_override_sample.h`` file. ### Version Information - - Sonoff-Tasmota provides all (Sonoff) modules in one file and starts with module Sonoff Basic. - Once uploaded select module using the configuration webpage or the commands ```Modules``` and ```Module```. - After reboot select config menu again or use commands ```GPIOs``` and ```GPIO``` to change GPIO with desired sensor. @@ -71,8 +68,72 @@ The following devices are supported: - [Luani HVIO board](https://luani.de/projekte/esp8266-hvio/) - Wemos D1 mini, NodeMcu and Ledunia -### Contribute +### Firmware release information +Different firmware images are released based on Features and Sensors selection guided by code and memory usage. +- The Minimal version allows intermediate OTA uploads to support larger versions and does NOT change any persistent parameter. +- The Classic version allows single OTA uploads as did the previous Sonoff-Tasmota versions. + +| Typical file size | sonoff | classic | minimal | knx | allsensors | +|--------------------------------|--------|---------|---------|------|------------| +| ESP/Arduino lib v2.3.0 | 526k | 488k | 427k | 535k | 549k | +| ESP/Arduino lib v2.4.0 | 531k | 496k | 435k | 540k | 552k | +| ESP/Arduino lib v2.4.1 | 533k | 498k | 436k | 542k | 554k | + +| Feature | sonoff | classic | minimal | knx | allsensors | +|--------------------------------|--------|---------|---------|-----|------------| +| MY_LANGUAGE en-GB | x | x | x | x | x | +| MQTT_LIBRARY_TYPE PUBSUBCLIENT | x | x | x | x | x | +| USE_DOMOTICZ | x | x | - | x | x | +| USE_HOME_ASSISTANT | x | x | - | x | x | +| USE_MQTT_TLS | - | - | - | - | - | +| USE_KNX | - | - | - | x | - | +| USE_WEBSERVER | x | x | x | x | x | +| USE_EMULATION | x | x | - | - | x | +| USE_DISCOVERY | x | x | - | x | x | +| WEBSERVER_ADVERTISE | x | x | - | x | x | +| MQTT_HOST_DISCOVERY | x | x | - | x | x | +| USE_TIMERS | x | - | - | x | x | +| USE_TIMERS_WEB | x | - | - | x | x | +| USE_SUNRISE | x | - | - | x | x | +| USE_RULES | x | - | - | x | x | + +| Sensor | sonoff | classic | minimal | knx | allsensors | +|--------------------------------|--------|---------|---------|-----|------------| +| USE_ADC_VCC | x | x | x | x | x | +| USE_DS18B20 | x | x | - | x | - | +| USE_DS18x20 | - | - | - | - | x | +| USE_DS18x20_LEGACY | - | - | - | - | - | +| USE_I2C | x | x | - | x | x | +| USE_SHT | x | x | - | x | x | +| USE_SHT3X | x | x | - | x | x | +| USE_HTU | x | x | - | x | x | +| USE_BMP | x | x | - | x | x | +| USE_BME680 | - | - | - | - | x | +| USE_SGP30 | x | - | - | x | x | +| USE_BH1750 | x | x | - | x | x | +| USE_VEML6070 | - | - | - | - | x | +| USE_TSL2561 | - | - | - | - | x | +| USE_ADS1115 | - | - | - | - | x | +| USE_ADS1115_I2CDEV | - | - | - | - | - | +| USE_INA219 | - | - | - | - | x | +| USE_MGS | - | - | - | - | x | +| USE_SPI | - | - | - | - | - | +| USE_MHZ19 | x | x | - | x | x | +| USE_SENSEAIR | x | x | - | x | x | +| USE_PMS5003 | x | x | - | x | x | +| USE_NOVA_SDS | x | - | - | x | x | +| USE_PZEM004T | x | x | - | x | x | +| USE_SERIAL_BRIDGE | x | - | - | x | x | +| USE_IR_REMOTE | x | x | - | x | x | +| USE_IR_HVAC | - | - | - | - | x | +| USE_IR_RECEIVE | x | - | - | x | x | +| USE_WS2812 | x | x | - | x | x | +| USE_WS2812_DMA | - | - | - | - | - | +| USE_ARILUX_RF | x | x | - | x | x | +| USE_SR04 | x | - | - | x | x | + +### Contribute You can contribute to Sonoff-Tasmota by - providing Pull Requests (Features, Proof of Concepts, Language files or Fixes) - testing new released features and report issues @@ -80,6 +141,46 @@ You can contribute to Sonoff-Tasmota by [![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://paypal.me/tasmota) +### Credits +Libraries used with Sonoff-Tasmota are: +- [ESP8266 core for Arduino](https://github.com/esp8266/Arduino) +- [Adafruit BME680](https://github.com/adafruit/Adafruit_BME680) +- [Adafruit Sensor](https://github.com/adafruit/Adafruit_Sensor) +- [Adafruit SGP30](https://github.com/adafruit/Adafruit_SGP30) +- [ArduinoJson](https://arduinojson.org/) +- [Esp8266MqttClient](https://github.com/tuanpmt/ESP8266MQTTClient) +- [esp-knx-ip](https://github.com/envy/esp-knx-ip) +- [esp-mqtt-arduino](https://github.com/i-n-g-o/esp-mqtt-arduino) +- [I2Cdevlib](https://github.com/jrowberg/i2cdevlib) +- [IRremoteEsp8266](https://github.com/markszabo/IRremoteESP8266) +- [JobaTsl2561](https://github.com/joba-1/Joba_Tsl2561) +- [MultiChannelGasSensor](http://wiki.seeedstudio.com/Grove-Multichannel_Gas_Sensor/) +- [NeoPixelBus](https://github.com/Makuna/NeoPixelBus) +- [OneWire](https://github.com/PaulStoffregen/OneWire) +- [PubSubClient](https://github.com/knolleary/pubsubclient) + +People helping to keep the show on the road: +- David Lang for providing initial issue resolution and code optimizations +- Heiko Krupp for his IRSend, HTU21, SI70xx and Wemo/Hue emulation drivers +- Wiktor Schmidt for Travis CI implementation +- Thom Dietrich for PlatformIO optimizations +- Marinus van den Broek for his EspEasy based inspiration +- Pete Ba for more user friendly energy monitor calibration +- Lobradov providing compile optimization tips +- Flexiti for his initial timer implementation +- reloxx13 for his [SonWeb](https://github.com/reloxx13/SonWEB) management tool +- Joachim Banzhaf for his TSL2561 library and driver +- Gijs Noorlander for his MHZ19 and SenseAir drivers +- Emontnemery for his HomeAssistant Discovery concept and many code tuning tips +- Aidan Mountford for his HSB support +- Daniel Ztolnai for his inspiring Serial Bridge implementation +- Gerhard Mutz for his SGP30 and Sunrise/Sunset driver +- Nuno Ferreira for his HC-SR04 driver +- Adrian Scillato for his (security)fixes and implementing and maintaining KNX +- Raymond Mouthaan for managing Wemos Wiki information +- Norbert Richter, Frogmore42 and Jason2866 for providing many issue answers +- Many more providing Tips, Pocs or PRs + ### License This program is licensed under GPL-3.0