Merge branch 'master' into my_changes_on_2.1.0-rc1

Author: joostjager

README.md

@@ -11,7 +11,7 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and
   - [Using git version](#using-git-version-)
   - [Using stable version with PlatformIO](#using-stable-version-with-platformio)
 - [Documentation](#documentation)
-- [Issues and support](#issues-and-support) 
+- [Issues and support](#issues-and-support)
 - [Contributing](#contributing)  
 - [License and credits](#license-and-credits)   
 
@@ -25,7 +25,7 @@ Starting with 1.6.4, Arduino allows installation of third-party platform package
 - Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation).
 
 The best place to ask questions related to this core is ESP8266 community forum: http://www.esp8266.com/arduino.
-If you find this ESP8266 board manager useful, please consider supporting it with a donation. The ESP8266 Community Forum and IGRR have made this wonderful port available.
+If you find this forum or the ESP8266 Boards Manager package useful, please consider supporting it with a donation.
 [![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66)
 
 #### Available versions
@@ -38,11 +38,11 @@ Documentation: [http://esp8266.github.io/Arduino/versions/2.0.0/](http://esp8266
 ##### Staging version ![](http://arduino.esp8266.com/staging/badge.svg)
 Boards manager link: `http://arduino.esp8266.com/staging/package_esp8266com_index.json`
 
-Documentation: [http://esp8266.github.io/Arduino/versions/2.0.0-rc2/](http://esp8266.github.io/Arduino/versions/2.0.0-rc2/)
+Documentation: [http://esp8266.github.io/Arduino/versions/2.1.0-rc1/](http://esp8266.github.io/Arduino/versions/2.1.0-rc1/)
 
 ### Using git version [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
 
-- Install Arduino 1.6.5
+- Install Arduino 1.6.7
 - Go to Arduino directory
 - Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)
 ```bash

boards.txt

@@ -177,18 +177,20 @@ generic.menu.Debug.Serial.build.debug_port=-DDEBUG_ESP_PORT=Serial
 generic.menu.Debug.Serial1=Serial1
 generic.menu.Debug.Serial1.build.debug_port=-DDEBUG_ESP_PORT=Serial1
 
-generic.menu.DebugLevel.None=None
-generic.menu.DebugLevel.None.build.debug_level=
-generic.menu.DebugLevel.Core=Core
-generic.menu.DebugLevel.Core.build.debug_level=-DDEBUG_ESP_CORE
-generic.menu.DebugLevel.SSL=Core + SSL
-generic.menu.DebugLevel.SSL.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_SSL
-generic.menu.DebugLevel.WiFic=Core + WiFi
-generic.menu.DebugLevel.WiFic.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_WIFI
-generic.menu.DebugLevel.WiFi=WiFi
-generic.menu.DebugLevel.WiFi.build.debug_level=-DDEBUG_ESP_WIFI
+generic.menu.DebugLevel.None____=None
+generic.menu.DebugLevel.None____.build.debug_level=
+generic.menu.DebugLevel.Core____=Core
+generic.menu.DebugLevel.Core____.build.debug_level=-DDEBUG_ESP_CORE
+generic.menu.DebugLevel.SSL_____=Core + SSL
+generic.menu.DebugLevel.SSL_____.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_SSL
+generic.menu.DebugLevel.WiFic___=Core + WiFi
+generic.menu.DebugLevel.WiFic___.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_WIFI
+generic.menu.DebugLevel.WiFi____=WiFi
+generic.menu.DebugLevel.WiFi____.build.debug_level=-DDEBUG_ESP_WIFI
 generic.menu.DebugLevel.HTTPClient=HTTPClient
 generic.menu.DebugLevel.HTTPClient.build.debug_level=-DDEBUG_ESP_HTTP_CLIENT
+generic.menu.DebugLevel.HTTPClient2=HTTPClient + SSL
+generic.menu.DebugLevel.HTTPClient2.build.debug_level=-DDEBUG_ESP_HTTP_CLIENT -DDEBUG_ESP_SSL
 generic.menu.DebugLevel.HTTPUpdate=HTTPUpdate
 generic.menu.DebugLevel.HTTPUpdate.build.debug_level=-DDEBUG_ESP_HTTP_UPDATE
 generic.menu.DebugLevel.HTTPUpdate2=HTTPClient + HTTPUpdate
@@ -199,12 +201,12 @@ generic.menu.DebugLevel.HTTPServer=HTTPServer
 generic.menu.DebugLevel.HTTPServer.build.debug_level=-DDEBUG_ESP_HTTP_SERVER
 generic.menu.DebugLevel.UPDATER=Updater
 generic.menu.DebugLevel.UPDATER.build.debug_level=-DDEBUG_ESP_UPDATER
-generic.menu.DebugLevel.OTA=OTA
-generic.menu.DebugLevel.OTA.build.debug_level=-DDEBUG_ESP_OTA
-generic.menu.DebugLevel.OTA2=OTA + Updater
-generic.menu.DebugLevel.OTA2.build.debug_level=-DDEBUG_ESP_OTA -DDEBUG_ESP_UPDATER
-generic.menu.DebugLevel.all=All
-generic.menu.DebugLevel.all.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_SSL -DDEBUG_ESP_WIFI -DDEBUG_ESP_HTTP_CLIENT -DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_SERVER -DDEBUG_ESP_UPDATER -DDEBUG_ESP_OTA
+generic.menu.DebugLevel.OTA_____=OTA
+generic.menu.DebugLevel.OTA_____.build.debug_level=-DDEBUG_ESP_OTA
+generic.menu.DebugLevel.OTA2____=OTA + Updater
+generic.menu.DebugLevel.OTA2____.build.debug_level=-DDEBUG_ESP_OTA -DDEBUG_ESP_UPDATER
+generic.menu.DebugLevel.all_____=All
+generic.menu.DebugLevel.all_____.build.debug_level=-DDEBUG_ESP_CORE -DDEBUG_ESP_SSL -DDEBUG_ESP_WIFI -DDEBUG_ESP_HTTP_CLIENT -DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_SERVER -DDEBUG_ESP_UPDATER -DDEBUG_ESP_OTA
 
 # disabled because espressif's bootloader refuses to write above 4M
 # generic.menu.FlashSize.8M=8M (7M SPIFFS)
@@ -944,8 +946,20 @@ wifinfo.build.variant=wifinfo
 wifinfo.build.flash_mode=qio
 wifinfo.build.board=ESP8266_ESP12
 wifinfo.build.spiffs_pagesize=256
-wifinfo.build.debug_port=
-wifinfo.build.debug_level=
+wifinfo.build.debug_port=Serial1
+wifinfo.build.debug_level=Wifinfo
+
+wifinfo.menu.Debug.Disabled=Disabled
+wifinfo.menu.Debug.Disabled.build.debug_port=
+wifinfo.menu.Debug.Serial=Serial
+wifinfo.menu.Debug.Serial.build.debug_port=-DDEBUG_ESP_PORT=Serial
+wifinfo.menu.Debug.Serial1=Serial1
+wifinfo.menu.Debug.Serial1.build.debug_port=-DDEBUG_ESP_PORT=Serial1
+
+wifinfo.menu.DebugLevel.None=None
+wifinfo.menu.DebugLevel.None.build.debug_level=
+wifinfo.menu.DebugLevel.Wifinfo=Wifinfo
+wifinfo.menu.DebugLevel.Wifinfo.build.debug_level=-DDEBUG_ESP_WIFINFO
 
 #wifinfo.menu.ESPModule.ESP07512=ESP07 (1M/512K SPIFFS)
 #wifinfo.menu.ESPModule.ESP07512.build.board=ESP8266_ESP07

cores/esp8266/FS.h

@@ -59,7 +59,9 @@ class File : public Stream
     int read() override;
     int peek() override;
     void flush() override;
-
+    size_t readBytes(char *buffer, size_t length)  override {
+        return read((uint8_t*)buffer, length);
+    }
     size_t read(uint8_t* buf, size_t size);
     bool seek(uint32_t pos, SeekMode mode);
     size_t position() const;

cores/esp8266/MD5Builder.cpp

@@ -23,6 +23,46 @@ void MD5Builder::addHexString(const char * data){
   free(tmp);
 }
 
+bool MD5Builder::addStream(Stream & stream, const size_t total_len) {
+    const int buf_size = 512;
+    int bytesleft = total_len;
+    uint8_t * buf = (uint8_t*) malloc(buf_size);
+    if(buf) {
+        while((stream.available() > -1) && (bytesleft > 0)) {
+
+            // get available data size
+            int sizeAvailable = stream.available();
+            if(sizeAvailable) {
+                int readBytes = sizeAvailable;
+
+                // read only the asked bytes
+                if(readBytes > bytesleft) {
+                    readBytes = bytesleft ;
+                }
+
+                // not read more the buffer can handle
+                if(readBytes > buf_size) {
+                    readBytes = buf_size;
+                }
+
+                // read data  
+                int bytesread = stream.readBytes(buf, readBytes);
+                bytesleft -= bytesread;
+                if(bytesread > 0) {
+                    MD5Update(&_ctx, buf, bytesread);
+                }
+            }
+            // time for network streams
+            delay(0);
+        }
+        // not free null ptr
+        free(buf);
+        return (bytesleft == 0);
+    } else {
+        return false;
+    }
+}
+
 void MD5Builder::calculate(void){
   MD5Final(_buf, &_ctx);
 }

cores/esp8266/MD5Builder.h

@@ -37,6 +37,7 @@ class MD5Builder {
     void addHexString(const char * data);
     void addHexString(char * data){ addHexString((const char*)data); }
     void addHexString(String data){ addHexString(data.c_str()); }
+    bool addStream(Stream & stream, const size_t total_len);
     void calculate(void);
     void getBytes(uint8_t * output);
     void getChars(char * output);

cores/esp8266/Stream.h

@@ -87,8 +87,8 @@ class Stream: public Print {
 
         float parseFloat();               // float version of parseInt
 
-        size_t readBytes(char *buffer, size_t length); // read chars from stream into buffer
-        size_t readBytes(uint8_t *buffer, size_t length) {
+        virtual size_t readBytes(char *buffer, size_t length); // read chars from stream into buffer
+        virtual size_t readBytes(uint8_t *buffer, size_t length) {
             return readBytes((char *) buffer, length);
         }
         // terminates if length characters have been read or timeout (see setTimeout)

cores/esp8266/core_esp8266_wiring_pwm.c

@@ -103,7 +103,7 @@ void ICACHE_RAM_ATTR pwm_timer_isr(){
 		current_step = 0;
 		stepcount = 0;
 		if(pwm_mask == 0) return;
-		T1L = (pwm_steps[current_step+1] * pwm_multiplier);
+		T1L = (pwm_steps[current_step] * pwm_multiplier);
 		TEIE |= TEIE1;
 		if(pwm_mask & 0xFFFF) GPOS = pwm_mask & 0xFFFF;
 		if(pwm_mask & 0x10000) GP16O = 1;

doc/Troubleshooting/debug_level.png

@@ -0,0 +1,102 @@
+---
+title: Debugging
+---
+
+## Table of Contents
+  * [Introduction](#introduction)
+    * [Requirements](#requirements)
+    * [Usage](#Usage)
+  * [Informations](#Informations)
+    * [For Developers](#for-developers)
+
+## Introduction
+
+Since 2.1.0-rc1 the core includes a Debugging feature that is controllable over the IDE menu.
+
+The new menu points manage the real-time Debug messages.
+
+### Requirements
+
+For usage of the debugging a Serial connection is required (Serial or Serial1).
+
+The Serial Interface need to be initialized in the ```setup()```.
+
+Set the Serial baud rate as high as possible for your Hardware setup.
+
+Minimum sketch to use debugging:
+```cpp
+void setup() {
+    Serial.begin(115200);
+}
+
+void loop() {
+}
+```
+
+### Usage
+
+1. Select the Serial interface for the Debugging messages:
+![Debug-Port](debug_port.png)
+
+2. Select which type / level you want debug messages for:
+![Debug-Level](debug_level.png)
+
+3. Check if the Serial interface is initialized in ```setup()``` (see [Requirements](#requirements))
+
+4. Flash sketch
+
+5. Check the Serial Output
+
+
+
+## Informations
+
+It work with every sketch that enables the Serial interface that is selected as debug port.
+
+The Serial interface can still be used normal in the Sketch.
+
+The debug output is additional and will not disable any interface from usage in the sketch.
+
+### For Developers 
+
+For the debug handling uses defines.
+
+The defined are set by command line.
+
+#### Debug Port 
+
+The port has the define ```DEBUG_ESP_PORT``` possible value:
+ - Disabled: 	define not existing
+ - Serial: 		Serial 
+ - Serial1: 	Serial1
+ 
+#### Debug Level 
+
+All defines for the different levels starts with ```DEBUG_ESP_```
+
+a full list can be found here in the [boards.txt](https://github.com/esp8266/Arduino/blob/master/boards.txt#L180)
+
+#### Example for own debug messages
+
+The debug messages will be only shown when the Debug Port in the IDE menu is set.
+
+```cpp
+#ifdef DEBUG_ESP_PORT
+#define DEBUG_MSG(...) DEBUG_ESP_PORT.printf( __VA_ARGS__ )
+#else
+#define DEBUG_MSG(...) 
+#endif
+
+void setup() {
+    Serial.begin(115200);
+	
+	delay(3000);
+	DEBUG_MSG("bootup...\n");
+}
+
+void loop() {
+	DEBUG_MSG("loop %d\n", millis());
+	delay(1000);
+}
+```
+