Merge branch 'dev'

.gitignore

@@ -12,3 +12,5 @@ credentials.h
 node_modules
 code/utils
 custom.h
+.python
+.env

CHANGELOG.md

@@ -3,6 +3,31 @@
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.11.4] 2018-01-09
+### Fixed
+- Fix bug in RF Bridge when RF code contains the stop byte. Check overflow (#357)
+- Fixed typos in code and wiki (Thanks to Ryan Jarvis)
+- Fix bug in magnitude topic and units (#355)
+
+### Added
+- Small core build to allow two-step flashing method for big binaries
+- Thingspeak support (#371, disabled by default)
+- Color synchronization between lights using MQTT (#362)
+- Support for Arilux AL-LC02 (#347)
+- Support for Tarpuna Shield for Wemos D1
+- Build option to disable password checking (#373)
+- Option to report sensor address via MQTT (#377, I2C address, GPIO, Dallas address,...)
+- Added binary size to memanalyzer script
+- Option to specify custom client ID for MQTT connection (#368)
+- Cross-platform ESPurna OTA Manager implemented in python (untested)
+- Terminal command to get or set digital GPIO
+
+### Changed
+- Using 2.3.0 for prebuilt binaries
+- Fix delay in DHT sensor
+- Allow MQTT keep alive value of up to 3600s
+- Changed Sonoff 4CH Pro definitions to support built-in interlock mode (#333)
+
 ## [1.11.3] 2018-01-02
 ### Fixed
 - Fix uninitialized PWM channels bug (#356)

README.md

@@ -4,7 +4,7 @@ ESPurna ("spark" in Catalan) is a custom firmware for ESP8266 based smart switch
 It was originally developed with the **[IteadStudio Sonoff](https://www.itead.cc/sonoff-wifi-wireless-switch.html)** in mind but now it supports a growing number of ESP8266-based boards.
 It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries.
 
-> **Current Release Version is 1.11.3**, read the [changelog](https://bitbucket.org/xoseperez/espurna/src/master/CHANGELOG.md).
+> **Current Release Version is 1.11.4**, read the [changelog](https://bitbucket.org/xoseperez/espurna/src/master/CHANGELOG.md).
 
 > **NOTICE**: Default flash layout changed in 1.8.3, as an unpredicted consequence devices will not be able to persist/retrieve configuration if flashed with 1.8.3 via **OTA** from **PlatformIO**. Please check issue #187.
 
@@ -37,6 +37,7 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
     * Enable/disable pulse mode
     * Change LED notification mode
     * Remote reset the board
+    * Fully configurable in webUI (broker, user, password, QoS, keep alive time, retain flag, client ID)
 * **Alexa** integration using the [FauxmoESP Library](https://bitbucket.org/xoseperez/fauxmoesp)
 * [**Google Assistant**](http://tinkerman.cat/using-google-assistant-control-your-esp8266-devices/) integration using IFTTT and Webhooks (Google Home, Allo)
 * [**Domoticz**](https://domoticz.com/) integration via MQTT
@@ -45,13 +46,14 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
     * Support for lights (color, brightness, on/off state)
     * Supports MQTT auto-discover feature (both switches and lights)
 * [**InfluxDB**](https://www.influxdata.com/) integration via HTTP API
+* [**Thingspeak**](https://thingspeak.com/) integration via HTTP API (HTTPS available for custom builds)
 * Support for different **sensors**
     * Environment
-        * **DHT11 / DHT22 / DHT21 / AM2301 / Itead's SI7021** (supports celsius & fahrenheit reporting)
+        * **DHT11 / DHT22 / DHT21 / AM2301 / Itead's SI7021**
         * **BMP280** and **BME280** temperature, humidity (BME280) and pressure sensor by Bosch
         * **SI7021** temperature and humidity sensor
         * **SHT3X** temperature and humidity sensor over I2C (Wemos shield)
-        * **Dallas OneWire sensors** like the DS18B20 (supports celsius & fahrenheit reporting)
+        * **Dallas OneWire sensors** like the DS18B20
         * **MHZ19** CO2 sensor
         * **PMSX003** dust sensor
         * **BH1750** luminosity sensor
@@ -62,13 +64,15 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
         * **V9261F** power monitor chip
     * Raw analog and digital sensors
     * Simple pulse counter
+    * All temperature sensors support Fahrenheit and Celsius
 * 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)
     * RGB and HSV color codes supported
     * Manage channels individually
     * Temperature color supported (in mired and kelvin) via MQTT / REST API
     * Flicker-free PWM management
     * Soft color transitions
+    * Color synchronization between light using MQTT
 * Fast asynchronous **HTTP Server**
     * Configurable port
     * Basic authentication
@@ -151,11 +155,11 @@ Here is the list of supported hardware. For more information please refer to the
 |![EXS Wifi Relay v3.1](images/devices/exs-wifi-relay-v31.jpg)|||
 |**EXS Wifi Relay v3.1**|||
 
-**Other supported boards:** Itead Sonoff LED, Itead Sonoff Dual R2, Huacanxing H802, WiOn 50055, ManCaveMade ESP-Live, InterMitTech QuinLED 2.6, Arilux AL-LC01, Arilux AL-LC06, Arilux AL-LC11, Arilux E27 light bulb, Xenon SM-PW702U, Authometion LYT8266, YJZK 2-gang switch.
+**Other supported boards:** Itead Sonoff LED, Itead Sonoff Dual R2, Huacanxing H802, WiOn 50055, ManCaveMade ESP-Live, InterMitTech QuinLED 2.6, Arilux AL-LC01, Arilux AL-LC02, Arilux AL-LC06, Arilux AL-LC11, Arilux E27 light bulb, Xenon SM-PW702U, Authometion LYT8266, YJZK 2-gang switch.
 
 ## License
 
-Copyright (C) 2016-2017 by Xose Pérez (@xoseperez)
+Copyright (C) 2016-2018 by Xose Pérez (@xoseperez)
 
 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

code/build.sh

@@ -45,7 +45,7 @@ echo "Building firmware images..."
 mkdir -p firmware/espurna-$version
 for environment in $environments; do
     echo "* espurna-$version-$environment.bin"
-    platformio run -s -e $environment || exit
+    platformio run --silent --environment $environment || exit
     mv .pioenvs/$environment/firmware.bin firmware/espurna-$version/espurna-$version-$environment.bin
 done
 echo "--------------------------------------------------------------"

code/espurna/alexa.ino

@@ -2,7 +2,7 @@
 
 ALEXA MODULE
 
-Copyright (C) 2016-2017 by Xose Pérez <xose dot perez at gmail dot com>
+Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
 */
 

code/espurna/api.ino

@@ -2,7 +2,7 @@
 
 API MODULE
 
-Copyright (C) 2016-2017 by Xose Pérez <xose dot perez at gmail dot com>
+Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
 */
 

code/espurna/button.ino

@@ -2,7 +2,7 @@
 
 BUTTON MODULE
 
-Copyright (C) 2016-2017 by Xose Pérez <xose dot perez at gmail dot com>
+Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
 
 */
 
@@ -80,7 +80,7 @@ uint8_t mapEvent(uint8_t event, uint8_t count, uint16_t length) {
 
 void buttonEvent(unsigned int id, unsigned char event) {
 
-    DEBUG_MSG_P(PSTR("[BUTTON] Pressed #%d, event: %d\n"), id, event);
+    DEBUG_MSG_P(PSTR("[BUTTON] Button #%d event %d\n"), id, event);
     if (event == 0) return;
 
     #if MQTT_SUPPORT

code/espurna/config/arduino.h

@@ -57,6 +57,8 @@
 //#define GENERIC_8CH
 //#define ARILUX_AL_LC01
 //#define ARILUX_AL_LC11
+//#define ARILUX_AL_LC02
+//#define WEMOS_D1_TARPUNA_SHIELD
 
 //--------------------------------------------------------------------------------
 // Features (values below are non-default values)
@@ -69,7 +71,7 @@
 //#define DOMOTICZ_SUPPORT       0
 //#define HOMEASSISTANT_SUPPORT  0
 //#define I2C_SUPPORT            1
-//#define INFLUXDB_SUPPORT       0
+//#define INFLUXDB_SUPPORT       1
 //#define IR_SUPPORT             1
 //#define LLMNR_SUPPORT          1  // Only with Arduino Core 2.4.0
 //#define MDNS_SUPPORT           0
@@ -82,6 +84,7 @@
 //#define SSDP_SUPPORT           1
 //#define TELNET_SUPPORT         0
 //#define TERMINAL_SUPPORT       0
+//#define THINGSPEAK_SUPPORT     0
 //#define WEB_SUPPORT            0
 
 //--------------------------------------------------------------------------------

code/espurna/config/general.h

@@ -7,13 +7,29 @@
 // GENERAL
 //------------------------------------------------------------------------------
 
+#define DEVICE_NAME             MANUFACTURER "_" DEVICE     // Concatenate both to get a unique device name
 #define ADMIN_PASS              "fibonacci" // Default password (WEB, OTA, WIFI)
-#define DEVICE_NAME             MANUFACTURER "_" DEVICE // Concatenate both to get a unique device name
+#define USE_PASSWORD            1           // Insecurity caution! Disabling this will disable password querying completely.
 #define LOOP_DELAY_TIME         10          // Delay for this millis in the main loop [0-250]
 
 #define ARRAYINIT(type, name, ...) \
     type name[] = {__VA_ARGS__};
 
+//------------------------------------------------------------------------------
+// ESPURNA CORE
+//------------------------------------------------------------------------------
+
+#ifdef ESPURNA_CORE
+    #define ALEXA_SUPPORT          0
+    #define DOMOTICZ_SUPPORT       0
+    #define HOMEASSISTANT_SUPPORT  0
+    #define MQTT_SUPPORT           0
+    #define NTP_SUPPORT            0
+    #define WEB_SUPPORT            0
+    #define SENSOR_SUPPORT         0
+    #define I2C_SUPPORT            0
+#endif
+
 //------------------------------------------------------------------------------
 // TELNET
 //------------------------------------------------------------------------------
@@ -74,7 +90,6 @@
 //------------------------------------------------------------------------------
 
 // General debug options and macros
-#define DEBUG_FORMAT_MAX_LENGTH 80
 #define DEBUG_SUPPORT           DEBUG_SERIAL_SUPPORT || DEBUG_UDP_SUPPORT || DEBUG_TELNET_SUPPORT
 
 #if DEBUG_SUPPORT
@@ -179,10 +194,21 @@ PROGMEM const char* const custom_reset_string[] = {
 // BUTTON
 //------------------------------------------------------------------------------
 
+#ifndef BUTTON_DEBOUNCE_DELAY
 #define BUTTON_DEBOUNCE_DELAY       50          // Debounce delay (ms)
+#endif
+
+#ifndef BUTTON_DBLCLICK_DELAY
 #define BUTTON_DBLCLICK_DELAY       500         // Time in ms to wait for a second (or third...) click
+#endif
+
+#ifndef BUTTON_LNGCLICK_DELAY
 #define BUTTON_LNGCLICK_DELAY       1000        // Time in ms holding the button down to get a long click
+#endif
+
+#ifndef BUTTON_LNGLNGCLICK_DELAY
 #define BUTTON_LNGLNGCLICK_DELAY    10000       // Time in ms holding the button down to get a long-long click
+#endif
 
 #define BUTTON_EVENT_NONE           0
 #define BUTTON_EVENT_PRESSED        1
@@ -208,7 +234,7 @@ PROGMEM const char* const custom_reset_string[] = {
 #define RELAY_BOOT_OFF          0
 #define RELAY_BOOT_ON           1
 #define RELAY_BOOT_SAME         2
-#define RELAY_BOOT_TOOGLE       3
+#define RELAY_BOOT_TOGGLE       3
 
 #define RELAY_TYPE_NORMAL       0
 #define RELAY_TYPE_INVERSE      1
@@ -305,7 +331,7 @@ PROGMEM const char* const custom_reset_string[] = {
 #endif
 
 // This is not working at the moment!!
-// Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core staging version.
+// Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0
 #define WEB_SSL_ENABLED         0           // Use HTTPS web interface
 
 #define WEB_MODE_NORMAL         0
@@ -404,7 +430,7 @@ PROGMEM const char* const custom_reset_string[] = {
 // MQTT OVER SSL
 // Using MQTT over SSL works pretty well but generates problems with the web interface.
 // It could be a good idea to use it in conjuntion with WEB_SUPPORT=0.
-// Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core staging version.
+// Requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0.
 //
 // You can use it with MQTT_USE_ASYNC=1 (AsyncMqttClient library)
 // but you might experience hiccups on the web interface, so my recommendation is:
@@ -588,6 +614,11 @@ PROGMEM const char* const custom_reset_string[] = {
 #define HOMEASSISTANT_SUPPORT   MQTT_SUPPORT    // Build with home assistant support (if MQTT, 1.64Kb)
 #endif
 
+#if HOMEASSISTANT_SUPPORT
+#undef MQTT_SUPPORT
+#define MQTT_SUPPORT            1               // If Home Assistant enabled enable MQTT
+#endif
+
 #define HOMEASSISTANT_ENABLED   0               // Integration not enabled by default
 #define HOMEASSISTANT_PREFIX    "homeassistant" // Default MQTT prefix
 
@@ -606,6 +637,41 @@ PROGMEM const char* const custom_reset_string[] = {
 #define INFLUXDB_USERNAME       ""              // Default username
 #define INFLUXDB_PASSWORD       ""              // Default password
 
+// -----------------------------------------------------------------------------
+// THINGSPEAK
+// -----------------------------------------------------------------------------
+
+#ifndef THINGSPEAK_SUPPORT
+#define THINGSPEAK_SUPPORT      1               // Enable Thingspeak support by default (2.56Kb)
+#endif
+
+#define THINGSPEAK_ENABLED      0               // Thingspeak disabled by default
+#define THINGSPEAK_APIKEY       ""              // Default API KEY
+
+#define THINGSPEAK_USE_ASYNC    1               // Use AsyncClient instead of WiFiClientSecure
+
+// THINGSPEAK OVER SSL
+// Using THINGSPEAK over SSL works well but generates problems with the web interface,
+// so you should compile it with WEB_SUPPORT to 0.
+// When THINGSPEAK_USE_ASYNC is 1, requires ASYNC_TCP_SSL_ENABLED to 1 and ESP8266 Arduino Core 2.4.0.
+#define THINGSPEAK_USE_SSL      0               // Use secure connection
+#define THINGSPEAK_FINGERPRINT  "78 60 18 44 81 35 BF DF 77 84 D4 0A 22 0D 9B 4E 6C DC 57 2C"
+
+#define THINGSPEAK_HOST         "api.thingspeak.com"
+#if THINGSPEAK_USE_SSL
+#define THINGSPEAK_PORT         443
+#else
+#define THINGSPEAK_PORT         80
+#endif
+#define THINGSPEAK_URL          "/update"
+#define THINGSPEAK_MIN_INTERVAL 15000           // Minimum interval between POSTs (in millis)
+
+#ifndef ASYNC_TCP_SSL_ENABLED
+#if THINGSPEAK_USE_SSL && THINGSPEAK_USE_ASYNC
+#undef THINGSPEAK_SUPPORT                       // Thingspeak in ASYNC mode requires ASYNC_TCP_SSL_ENABLED
+#endif
+#endif
+
 // -----------------------------------------------------------------------------
 // NTP
 // -----------------------------------------------------------------------------