Update Changelog and README
58
CHANGELOG.md
@@ -3,6 +3,64 @@
|
||||
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
||||
and this project adheres to [Semantic Versioning](http://semver.org/).
|
||||
|
||||
## [1.13.0] 2018-06-22
|
||||
### Fixed
|
||||
- Fixed PZEM004T compilation issues, working when using hardware serial ([#837](https://github.com/xoseperez/espurna/issues/837))
|
||||
- Fixed per channel state on/off for lights ([#830](https://github.com/xoseperez/espurna/issues/830))
|
||||
- Fixed overflow in CSE7766 energy calculation ([#856](https://github.com/xoseperez/espurna/issues/856))
|
||||
- Fixed On MQTT disconnect in web UI ([#845](https://github.com/xoseperez/espurna/issues/845))
|
||||
- Check valid hostnames ([#874](https://github.com/xoseperez/espurna/issues/874), [#879](https://github.com/xoseperez/espurna/issues/879))
|
||||
- Fix Sonoff POW R2 configuration
|
||||
- Fixed InfluxDB sensor by id ([#882](https://github.com/xoseperez/espurna/issues/882))
|
||||
- Fix build when disabling WEB_SUPPORT ([#923](https://github.com/xoseperez/espurna/issues/923))
|
||||
- Fix calibration error in EmonSensor ([#876](https://github.com/xoseperez/espurna/issues/876))
|
||||
- Fix telnet and web debug responsiveness ([#896](https://github.com/xoseperez/espurna/issues/896))
|
||||
- Use double quotes in JSON for non-numeric values ([#929](https://github.com/xoseperez/espurna/issues/929))
|
||||
- Support connections over HTTPS via proxy ([#937](https://github.com/xoseperez/espurna/issues/937))
|
||||
|
||||
### Added
|
||||
- EEPROM sector rotation using EEPROM_Rotate library
|
||||
- Code filtering when building web UI images
|
||||
- Added pulsing a relay via MQTT and REST API ([#896](https://github.com/xoseperez/espurna/issues/896), [#902](https://github.com/xoseperez/espurna/issues/902))
|
||||
- Support for WPS (not available in pre-built binaries)
|
||||
- Support for Smart Config (not available in pre-built binaries)
|
||||
- Support for CCT lights (thanks to @Skaronator)
|
||||
- Allow RELAYx_DELAY_ON/OFF also for none GPIO relay types (thanks to @zafrirron)
|
||||
- Added relay status to Domoticz on MQTT connection ([#872](https://github.com/xoseperez/espurna/issues/872))
|
||||
- Added configurable UART-to-MQTT terminator
|
||||
- Added telnet link to web UI
|
||||
- Reload terminal command to force all modules to reload settings from config ([#816](https://github.com/xoseperez/espurna/issues/816))
|
||||
- Added security headers to each HTTP response (thanks to @ITNerdBox)
|
||||
- Customized GET terminal command (thanks to @mcspr)
|
||||
- More RC codes supported on TX for RF Bridge (thanks to @wildwiz)
|
||||
- Support for BL0937 power monitoring chip with unmodified HLW8012 library ([#737](https://github.com/xoseperez/espurna/issues/737))
|
||||
- Enable CORS
|
||||
- Support for Allnet ESP8266 UP Relay (thanks to @bajo)
|
||||
- Support for Tonbux Mosquito Killer (thanks to @gn0st1c)
|
||||
- Support for Neo Coolcam NAS-WR01W WiFi Smart Power Plug
|
||||
- Support for TYWE3S-based Estink WiFi Power Strip (thanks to @sandman, [#852](https://github.com/xoseperez/espurna/issues/852))
|
||||
- Support for Pilotak ESP DIN V1
|
||||
- Support for DIY Geiger counter (thanks to @Trickx)
|
||||
- Support for HomeCube / Blitzwolf BW-SHP2
|
||||
* Support for Vanzavanzu Smart Wifi Plug Mini
|
||||
- Support for Bruno Horta's OnOfre board
|
||||
|
||||
### Changed
|
||||
- Updated PlatformIO to use Core 3.5.3
|
||||
- Updated to JustWifi 2.0
|
||||
- CSS optimizations ([#870](https://github.com/xoseperez/espurna/issues/870), [#871](https://github.com/xoseperez/espurna/issues/871))
|
||||
- Several changes in OTA Manager
|
||||
- Better memory layout info
|
||||
- MQTT keep alive time increased to 300s
|
||||
- Using ticket-based authentication for WS
|
||||
- Refactor module and sensor listings ([#896](https://github.com/xoseperez/espurna/issues/896))
|
||||
- Using alternative math methods to save ~8Kb with lights
|
||||
- Simpligying mired/kelvin methods
|
||||
- Changed web UI checkboxes with pure CSS versions
|
||||
|
||||
### Deprecated
|
||||
- {identifier} place-holder in MQTT base topic
|
||||
|
||||
## [1.12.6] 2018-05-02
|
||||
### Fixed
|
||||
- Check NTP_SUPPORT for sensors (thanks to @mcspr)
|
||||
|
||||
82
README.md
@@ -4,12 +4,12 @@ ESPurna ("spark" in Catalan) is a custom firmware for ESP8285/ESP8266 based smar
|
||||
It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries.
|
||||
|
||||
[](CHANGELOG.md)
|
||||
[](https://github.com/xoseperez/espurna/tree/sensors/)
|
||||
[](https://travis-ci.org/xoseperez/espurna)
|
||||
[](https://www.codacy.com/app/xoseperez/espurna/dashboard)
|
||||
[](https://github.com/xoseperez/espurna/tree/sensors/)
|
||||
[](https://travis-ci.org/xoseperez/espurna)
|
||||
[](https://www.codacy.com/app/xoseperez/espurna/dashboard)
|
||||
[](https://github.com/xoseperez/espurna/tree/dev/)
|
||||
[](https://travis-ci.org/xoseperez/espurna)
|
||||
[](https://www.codacy.com/app/xoseperez/espurna/dashboard)
|
||||
[](https://github.com/xoseperez/espurna/tree/dev/)
|
||||
[](https://travis-ci.org/xoseperez/espurna)
|
||||
[](https://www.codacy.com/app/xoseperez/espurna/dashboard)
|
||||
[](LICENSE)
|
||||
<br />
|
||||
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=xose%2eperez%40gmail%2ecom&lc=US&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest)
|
||||
@@ -33,6 +33,7 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
|
||||
* Scans for strongest network if more than one defined (also available in web UI)
|
||||
* Handles correctly multiple AP with the same SSID
|
||||
* Defaults to AP mode (also available after double clicking the main button)
|
||||
* Support for **WPS** and **Smart Config** (not available in default builds)
|
||||
* Network visibility
|
||||
* Supports mDNS (service reporting and metadata) both server mode and client mode (.local name resolution)
|
||||
* Supports NetBIOS, LLMNR and Netbios (when built with Arduino Core >= 2.4.0) and SSDP (experimental)
|
||||
@@ -71,6 +72,7 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
|
||||
* Environment
|
||||
* **DHT11 / DHT22 / DHT21 / AM2301 / Itead's SI7021**
|
||||
* **BMP280** and **BME280** temperature, humidity (BME280) and pressure sensor by Bosch
|
||||
* **TMP35** and **TMP36** analog temperature sensors
|
||||
* **SI7021** temperature and humidity sensor
|
||||
* **SHT3X** temperature and humidity sensor over I2C (Wemos shield)
|
||||
* **AM2320** temperature and humidity sensor over I2C
|
||||
@@ -80,17 +82,21 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
|
||||
* **PMSX003/PMS5003T/ST** dust sensors
|
||||
* **BH1750** luminosity sensor
|
||||
* **GUVAS12SD** UV sensor
|
||||
* **GEIGER COUNTER** by RH Electronics
|
||||
* Power monitoring
|
||||
* **HLW8012** using the [HLW8012 Library](https://bitbucket.org/xoseperez/hlw8012) (Sonoff POW)
|
||||
* Non-invasive **current sensor** using **internal ADC** or **ADC121** or **ADS1115**
|
||||
* **ECH1560** power monitor chip
|
||||
* **CSE7766** and **CSE7759B** power monitor chips
|
||||
* **HJL-01** and **BL0937** power monitor chips
|
||||
* Non-invasive **current sensor** using **internal ADC** or **ADC712** or **ADC121** or **ADS1115**
|
||||
* **V9261F** power monitor chip
|
||||
* **PZEM0004T** power monitor board
|
||||
* Raw analog and digital sensors
|
||||
* Simple pulse counter
|
||||
* Support for (almost) any UART based sensor via the **UART-to-MQTT module**
|
||||
* Support for different units (Fahrenheit or Celsius, Watts or Kilowatts, Joules or kWh)
|
||||
* Support for LED lights
|
||||
* MY92XX-based light bulbs and PWM LED strips (dimmers) up to 5 channels (RGB, cold white and warm white, for instance)
|
||||
* Support for CCT lights
|
||||
* RGB and HSV color codes supported
|
||||
* Manage channels individually
|
||||
* Temperature color supported (in [mired](https://en.wikipedia.org/wiki/Mired) and [kelvin](https://en.wikipedia.org/wiki/Color_temperature)) via MQTT / REST API
|
||||
@@ -100,7 +106,7 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
|
||||
* Option to have separate switches for each channel
|
||||
* Support for simple 433MHz RF receivers
|
||||
* Support for UART-to-MQTT bidirectional bridge
|
||||
* Fast asynchronous **HTTP Server**
|
||||
* Fast asynchronous **HTTP Server** and cool **Web User Interface**
|
||||
* Configurable port
|
||||
* Basic authentication
|
||||
* Web-based configuration
|
||||
@@ -111,7 +117,7 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
|
||||
* Upgrade firmware from the web interface
|
||||
* Works great behind a [secured reverse proxy](http://tinkerman.cat/secure-remote-access-to-your-iot-devices/)
|
||||
* **REST API** (enable/disable from web interface)
|
||||
* GET and PUT relay status
|
||||
* GET and PUT relay status (including pulses)
|
||||
* Change light color (for supported hardware)
|
||||
* GET sensor data (power, current, voltage, temperature and humidity) depending on the available hardware
|
||||
* Works great behind a secured reverse proxy
|
||||
@@ -140,6 +146,7 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
|
||||
* Long click (>1 second) to reboot device (only main button)
|
||||
* Extra long click (>10 seconds) to go back to factory settings (only main button)
|
||||
* Specific definitions for touch button devices (ESPurna Switch, Sonoff Touch & T1)
|
||||
* Configuration stored in different sectors to prevent data loosing and corruption
|
||||
|
||||
## Notices
|
||||
|
||||
@@ -204,53 +211,56 @@ Here is the list of supported hardware. For more information please refer to the
|
||||
|---|---|---|
|
||||
||||
|
||||
|**Tinkerman ESPurna H**|||
|
||||
||||
|
||||
|**Itead Sonoff RF Bridge**|||
|
||||
||||
|
||||
|**Itead Sonoff Basic**|**Itead Sonoff RF**|**Itead Sonoff Dual/Dual R2**|
|
||||
||||
|
||||
|**Itead Sonoff POW**|**Itead Sonoff TH10/TH16**|**Electrodragon WiFi IOT**|
|
||||
||||
|
||||
|**Itead Sonoff 4CH**|**Itead Sonoff 4CH Pro**|**OpenEnergyMonitor WiFi MQTT Relay / Thermostat**|
|
||||
||||
|
||||
|**Itead S20**|**WorkChoice EcoPlug**|**Power meters based on V9261F and ECH1560**|
|
||||
||||
|
||||
|**Itead Sonoff RF Bridge**|**Itead Sonoff RF**|**Itead Sonoff 4CH**|
|
||||
||||
|
||||
|**Itead Sonoff 4CH Pro**|||
|
||||
||||
|
||||
|**Itead Sonoff S31**|**Blitzwolf BW-SHP2<br />(also by HomeCube, Coosa, Goosund)**|**Power meters based on V9261F**|
|
||||
||||
|
||||
|**Itead Sonoff POW**|**Itead Sonoff POW R2**|**Vanzavanzu Smart WiFi Plug Mini**|
|
||||
||||
|
||||
|**Itead Sonoff Basic**|**Itead Sonoff Dual/Dual R2**|**Itead Sonoff TH10/TH16**|
|
||||
||||
|
||||
|**Electrodragon WiFi IOT**|**OpenEnergyMonitor WiFi MQTT Relay / Thermostat**||
|
||||
||||
|
||||
|**Itead S20**|**WorkChoice EcoPlug**|**Neo Coolcam WiFi**|
|
||||
||||
|
||||
|**Schuko Wifi Plug**|**KMC 70011**|**Xenon SM-PW702U**|
|
||||
||||
|
||||
|**Maxcio W-US002S**|**HEYGO HY02**|**YiDian XS-SSA05**|
|
||||
||||
|
||||
|**WiOn 50055**|**LINGAN SWA1**|**Tonbux PowerStrip02**
|
||||
||||
|
||||
|**WiOn 50055**|**LINGAN SWA1**||
|
||||
||||
|
||||
|**Tonbux PowerStrip02**|**Fornorm Power Strip**|**Zhilde ZLD-EU55-W**|
|
||||
||||
|
||||
|**Itead Sonoff Touch**|**Itead Sonoff T1**|**YJZK 2-gang switch**|
|
||||
||||
|
||||
|**Itead Slampher**|||
|
||||
||||
|
||||
|**Itead Sonoff B1**|**AI-Thinker Wifi Light / Noduino OpenLight**|**Authometion LYT8266**|
|
||||
||||
|
||||
|**Arilux E27**|**Itead Sonoff LED**|**Itead BN-SZ01**|
|
||||
||||
|
||||
|**Itead Slampher**|**Arilux E27**|**Itead Sonoff B1**|
|
||||
||||
|
||||
|**AI-Thinker Wifi Light / Noduino OpenLight**|**Authometion LYT8266**||
|
||||
||||
|
||||
|**Itead Sonoff LED**|**Itead BN-SZ01**|**InterMitTech QuinLED 2.6**|
|
||||
||||
|
||||
|**Arilux AL-LC01 (RGB)**|**Arilux AL-LC02 (RGBW)**|**Arilux AL-LC06 (RGBWWCW)**|
|
||||
||||
|
||||
|**Arilux AL-LC11 (RGBWWW) & RF**|**MagicHome LED Controller (1.0/2.x)**|**Huacanxing H801/802**|
|
||||
|||
|
||||
|**InterMitTech QuinLED 2.6**||
|
||||
||||
|
||||
|**Itead Sonoff SV**|**Itead 1CH Inching**|**Itead Motor Clockwise/Anticlockwise**|
|
||||
||||
|
||||
|**Jan Goedeke Wifi Relay (NO/NC)**|**Jorge García Wifi + Relays Board Kit**|**EXS Wifi Relay v3.1**|
|
||||
||||
|
||||
|**ManCaveMade ESP-Live**|**Wemos D1 Mini Relay Shield**|**Witty Cloud**|
|
||||
||||
|
||||
|**IKE ESPike**|**STM_RELAY**|**Arniex Swifitch**|
|
||||
||||
|
||||
|**IKE ESPike**|**Pilotak ESP DIN|**Arniex Swifitch**|
|
||||
||||
|
||||
|**Heltec Touch Relay**|**Generic Relay v4.0**|**Generic RGBLed v1.0**|
|
||||
||||
|
||||
|**Generic DHT11 v1.0**|**Generic DS18B20 v1.0**|**Bruno Horta's OnOfre**|
|
||||
||||
|
||||
|**Allnet ESP8266-UP-Relay**|**RH Electronics Geiger Counter**|**Luani HVIO**|
|
||||
||||
|
||||
|**Tonbux Mosquito Killer**|||
|
||||
|
||||
**Other supported boards:**
|
||||
IteadStudio Sonoff S31, IteadStudio Sonoff POW R2, Zhilde ZLD-EU55-W, Luani HVIO
|
||||
|**Tonbux Mosquito Killer**||||
|
||||
|
||||
**Other supported boards (beta):**
|
||||
KMC 4 Outlet, Gosund WS1, Smart Dual Plug, MakerFocus Intelligent Module LM33 for Lamps
|
||||
|
||||
BIN
images/devices/allnet-esp8266-up-relay.jpg
Normal file
|
After Width: | Height: | Size: 89 KiB |
BIN
images/devices/blitzwolf-bw-shp2.jpg
Normal file
|
After Width: | Height: | Size: 15 KiB |
BIN
images/devices/fornorm-power-strip.jpg
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
images/devices/generic-geiger-diy.png
Normal file
|
After Width: | Height: | Size: 148 KiB |
BIN
images/devices/itead-sonoff-pow-r2.jpg
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
images/devices/itead-sonoff-s31.jpg
Normal file
|
After Width: | Height: | Size: 13 KiB |
BIN
images/devices/luani-hvio.jpg
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
images/devices/neo-coolcam-wifi.jpg
Normal file
|
After Width: | Height: | Size: 13 KiB |
BIN
images/devices/pilotak-esp-din.jpg
Normal file
|
After Width: | Height: | Size: 77 KiB |
BIN
images/devices/vanzavanzu-smart-wifi-plug-mini.jpg
Normal file
|
After Width: | Height: | Size: 13 KiB |
BIN
images/devices/zhilde-zld-eu55-w.jpg
Normal file
|
After Width: | Height: | Size: 13 KiB |