Merge branch 'master' into bug-esp8266#3795

Author: tablatronix

.travis.yml

@@ -3,8 +3,18 @@ language: bash
 os: linux
 dist: trusty
 
-env:
-  - BUILD_TYPE=build
+matrix:
+  include:
+    - env:
+      - BUILD_TYPE=build
+    - env:
+      - BUILD_TYPE=platformio
+    - env:
+      - BUILD_TYPE=docs
+    - env:
+      - BUILD_TYPE=package
+    - env:
+      - BUILD_TYPE=host_tests
 
 install:
   - pip install --user -r doc/requirements.txt
@@ -25,6 +35,7 @@ deploy:
   on:
     repo: esp8266/Arduino
     tags: true
+    condition: "$BUILD_TYPE = package"
 
 notifications:
   email:

README.md

@@ -28,7 +28,7 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package
 #### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/)
 Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index.json`
 
-Documentation: [http://esp8266.github.io/Arduino/versions/2.3.0/](http://esp8266.github.io/Arduino/versions/2.3.0/)
+Documentation: [https://arduino-esp8266.readthedocs.io/en/2.4.0/](https://arduino-esp8266.readthedocs.io/en/2.4.0/)
 
 ### Using git version
 [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
@@ -51,19 +51,19 @@ python get.py
 
 ### Using PlatformIO
 
-[PlatformIO](http://platformio.org) is an open source ecosystem for IoT
+[PlatformIO](http://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT
 development with cross platform build system, library manager and full support
 for Espressif (ESP8266) development. It works on the popular host OS: macOS, Windows,
 Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard).
 
-- [What is PlatformIO?](http://docs.platformio.org/page/what-is-platformio.html)
-- [PlatformIO IDE](http://platformio.org/platformio-ide)
-- Quick Start with [PlatformIO IDE](http://docs.platformio.org/page/ide/atom.html#quick-start) or [PlatformIO Core](http://docs.platformio.org/page/core.html)
-- [Advanced usage](http://docs.platformio.org/page/platforms/espressif.html) -
-  custom settings, uploading to SPIFFS, Over-the-Air (OTA) or using stage version
-- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/page/ide.html) -
-  Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM and Visual Studio
-- [Project Examples](http://docs.platformio.org/page/platforms/espressif.html#examples)
+- [What is PlatformIO?](http://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp8266)
+- [PlatformIO IDE](http://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp8266)
+- [PlatformIO Core](http://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp8266) (command line tool)
+- [Advanced usage](http://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266) -
+  custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version
+- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp8266) -
+  Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
+- [Project Examples](http://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266#examples)
 
 ### Building with make
 
@@ -96,7 +96,7 @@ Please provide as much context as possible:
 
 For minor fixes of code and documentation, please go ahead and submit a pull request.
 
-Check out the list of issues which are easy to fix — [easy issues for 2.4.0](https://github.com/esp8266/Arduino/issues?q=is%3Aopen+is%3Aissue+milestone%3A2.4.0+label%3A%22level%3A+easy%22). Working on them is a great way to move the project forward.
+Check out the list of issues which are easy to fix — [easy issues for 2.5.0](https://github.com/esp8266/Arduino/issues?q=is%3Aopen+is%3Aissue+milestone%3A2.5.0+label%3A%22level%3A+easy%22). Working on them is a great way to move the project forward.
 
 Larger changes (rewriting parts of existing code from scratch, adding new functions to the core, adding new libraries) should generally be discussed by opening an issue first.
 

boards.txt

@@ -85,9 +85,13 @@ extern "C" {
 #define EXTERNAL 0
 
 //timer dividers
-#define TIM_DIV1 	0 //80MHz (80 ticks/us - 104857.588 us max)
-#define TIM_DIV16	1 //5MHz (5 ticks/us - 1677721.4 us max)
-#define TIM_DIV265	3 //312.5Khz (1 tick = 3.2us - 26843542.4 us max)
+enum TIM_DIV_ENUM {
+  TIM_DIV1 = 0,   //80MHz (80 ticks/us - 104857.588 us max)
+  TIM_DIV16 = 1,  //5MHz (5 ticks/us - 1677721.4 us max)
+  TIM_DIV256 = 3 //312.5Khz (1 tick = 3.2us - 26843542.4 us max)
+};
+
+
 //timer int_types
 #define TIM_EDGE	0
 #define TIM_LEVEL	1
@@ -236,7 +240,17 @@ void optimistic_yield(uint32_t interval_us);
 } // extern "C"
 #endif
 
+
+//for compatibility, below 4 lines to be removed in release 3.0.0
 #ifdef __cplusplus
+extern "C"
+#endif
+const int TIM_DIV265 __attribute__((deprecated, weak)) = TIM_DIV256;
+
+
+
+#ifdef __cplusplus
+
 #include <algorithm>
 #include "pgmspace.h"
 
@@ -283,3 +297,9 @@ extern "C" void configTime(long timezone, int daylightOffset_sec,
 #include "pins_arduino.h"
 
 #endif
+
+#ifdef DEBUG_ESP_OOM
+// reinclude *alloc redefinition because of <cstdlib> undefining them
+// this is mandatory for allowing OOM *alloc definitions in .ino files
+#include "umm_malloc/umm_malloc_cfg.h"
+#endif

cores/esp8266/Arduino.h

@@ -107,13 +107,22 @@ void EspClass::wdtFeed(void)
 
 extern "C" void esp_yield();
 
-void EspClass::deepSleep(uint32_t time_us, WakeMode mode)
+void EspClass::deepSleep(uint64_t time_us, WakeMode mode)
 {
     system_deep_sleep_set_option(static_cast<int>(mode));
     system_deep_sleep(time_us);
     esp_yield();
 }
 
+//this calculation was taken verbatim from the SDK api reference for SDK 2.1.0.
+//Note: system_rtc_clock_cali_proc() returns a uint32_t, even though system_deep_sleep() takes a uint64_t.
+uint64_t EspClass::deepSleepMax()
+{
+  //cali*(2^31-1)/(2^12)
+  return (uint64_t)system_rtc_clock_cali_proc()*(0x80000000-1)/(0x1000);
+
+}
+
 bool EspClass::rtcUserMemoryRead(uint32_t offset, uint32_t *data, size_t size)
 {
     if (size + offset > 512) {
@@ -396,7 +405,6 @@ struct rst_info * EspClass::getResetInfoPtr(void) {
 }
 
 bool EspClass::eraseConfig(void) {
-    bool ret = true;
     const size_t cfgSize = 0x4000;
     size_t cfgAddr = ESP.getFlashChipSize() - cfgSize;
 

cores/esp8266/Esp.cpp

@@ -92,7 +92,8 @@ class EspClass {
         void wdtDisable();
         void wdtFeed();
 
-        void deepSleep(uint32_t time_us, RFMode mode = RF_DEFAULT);
+        void deepSleep(uint64_t time_us, RFMode mode = RF_DEFAULT);
+        uint64_t deepSleepMax();
 
         bool rtcUserMemoryRead(uint32_t offset, uint32_t *data, size_t size);
         bool rtcUserMemoryWrite(uint32_t offset, uint32_t *data, size_t size);

cores/esp8266/Esp.h

@@ -180,5 +180,10 @@ HardwareSerial::operator bool() const
 }
 
 
+#if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL)
 HardwareSerial Serial(UART0);
+#endif
+#if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SERIAL1)
 HardwareSerial Serial1(UART1);
+#endif
+

cores/esp8266/HardwareSerial.cpp

@@ -89,6 +89,8 @@ class Print {
         size_t println(double, int = 2);
         size_t println(const Printable&);
         size_t println(void);
+
+        virtual void flush() { /* Empty implementation for backward compatibility */ }
 };
 
 #endif

cores/esp8266/Print.h

@@ -65,12 +65,12 @@ bool schedule_function(std::function<void(void)> fn)
 
 void run_scheduled_functions()
 {
-    while (sFirst) {
-        scheduled_fn_t* item = sFirst;
-        sFirst = item->mNext;
-        if (sFirst == NULL) {
-            sLast = NULL;
-        }
+	scheduled_fn_t* rFirst = sFirst;
+	sFirst = NULL;
+	sLast  = NULL;
+    while (rFirst) {
+        scheduled_fn_t* item = rFirst;
+        rFirst = item->mNext;
         item->mFunc();
         item->mFunc = std::function<void(void)>();
         recycle_fn(item);

cores/esp8266/Schedule.cpp

@@ -47,7 +47,6 @@ class Stream: public Print {
         virtual int available() = 0;
         virtual int read() = 0;
         virtual int peek() = 0;
-        virtual void flush() = 0;
 
         Stream() {
             _timeout = 1000;