Merge pull request #1 from esp8266/master

pull master

Author: me-no-dev

README.md

@@ -50,6 +50,7 @@ Documentation for latest development version:
 - [Reference](doc/reference.md)
 - [Supported boards](doc/boards.md)
 - [Change log](doc/changes.md)
+- [OTA Update](doc/ota_updates.md)
 
 ### Issues and support ###
 

doc/ota_updates.md

@@ -0,0 +1,162 @@
+---
+title: OTA Update
+---
+
+## Table of Contents
+ * [Basic Requirements](#basic-requirements)
+ * [Arduino IDE](#arduino-ide)
+ * [HTTP Server](#http-server)
+ * [Stream Interface](#stream-interface)
+ 
+## Basic Requirements
+
+- Flash chip size is 2x the size of the sketch
+ 
+## Arduino IDE
+
+TODO describe Arduino IDE OTA process
+
+#### Requirements
+ - The ESP and the Computer must be connected to the Same network.
+
+
+## HTTP Server
+
+the ```ESPhttpUpdate``` class can check for updates and download a binary file form a HTTP web server.
+It is possible to download updates from every IP or domain address on the Network or Internet.
+
+
+#### Requirements
+ - web server
+
+
+#### Arduino code
+
+##### simple updater
+
+the Simple Updater downloads the File every time the function is called.
+
+```cpp
+ESPhttpUpdate.update("192.168.0.2", 80, "/arduino.bin");
+```
+
+##### advanced updater
+
+Its possible to point to a script at the server.
+If a version String is delivered to the Function this String will be send to the server.
+A Server side Update check is now possible.
+
+the Server can return a binary file for update (Header 200)
+or it return header 304 to notify the ESP that no Update is needed.
+
+```cpp
+t_httpUpdate_return ret = ESPhttpUpdate.update("192.168.0.2", 80, "/esp/update/arduino.php", "optional current version string here");
+switch(ret) {
+	case HTTP_UPDATE_FAILED:
+		Serial.println("[update] Update failed.");
+		break;
+	case HTTP_UPDATE_NO_UPDATES:
+		Serial.println("[update] Update no Update.");
+		break;
+	case HTTP_UPDATE_OK:
+		Serial.println("[update] Update ok."); // may not called we reboot the ESP 
+		break;
+}
+```
+
+#### Server request handling
+
+##### simple updater
+
+for the simple Updater the Server only needs to deliver the binary file for update.
+
+##### advanced updater
+
+for advanced update management a Script needs to run at the Server side, for example a PHP script.
+at every Update request the the ESP sends some informations in the Header to the Server
+
+example Header data:
+```
+	[HTTP_USER_AGENT] => ESP8266-http-Update
+    [HTTP_X_ESP8266_STA_MAC] => 18:FE:AA:AA:AA:AA
+    [HTTP_X_ESP8266_AP_MAC] => 1A:FE:AA:AA:AA:AA
+    [HTTP_X_ESP8266_FREE_SPACE] => 671744
+    [HTTP_X_ESP8266_SKETCH_SIZE] => 373940
+    [HTTP_X_ESP8266_CHIP_SIZE] => 524288
+    [HTTP_X_ESP8266_SDK_VERSION] => 1.3.0
+    [HTTP_X_ESP8266_VERSION] => DOOR-7-g14f53a19
+```
+
+with this information the script now can check if a update is needed.
+It is also possible to deliver different binary´s based on the MAC address for example.
+
+script example:
+```php
+<?PHP
+
+header('Content-type: text/plain; charset=utf8', true);
+
+function check_header($name, $value = false) {
+	if(!isset($_SERVER[$name])) {
+		return false;
+	}
+	if($value && $_SERVER[$name] != $value) {
+		return false;
+	}
+	return true;
+}
+
+function sendFile($path) {
+	header($_SERVER["SERVER_PROTOCOL"].' 200 OK', true, 200);
+	header('Content-Type: application/octet-stream', true);
+	header('Content-Disposition: attachment; filename='.basename($path));
+	header('Content-Length: '.filesize($path), true);
+	readfile($path);
+}
+
+if(!check_header('HTTP_USER_AGENT', 'ESP8266-http-Update')) {
+	header($_SERVER["SERVER_PROTOCOL"].' 403 Forbidden', true, 403);
+	echo "only for ESP8266 updater!\n";
+	exit();
+} 
+
+if(
+	!check_header('HTTP_X_ESP8266_STA_MAC') || 
+	!check_header('HTTP_X_ESP8266_AP_MAC') ||
+	!check_header('HTTP_X_ESP8266_FREE_SPACE') ||
+	!check_header('HTTP_X_ESP8266_SKETCH_SIZE') ||
+	!check_header('HTTP_X_ESP8266_CHIP_SIZE') ||
+	!check_header('HTTP_X_ESP8266_SDK_VERSION') ||
+	!check_header('HTTP_X_ESP8266_VERSION')
+) {
+	header($_SERVER["SERVER_PROTOCOL"].' 403 Forbidden', true, 403);
+	echo "only for ESP8266 updater! (header)\n";
+	exit();
+}
+
+$db = array(
+	"18:FE:AA:AA:AA:AA" => "DOOR-7-g14f53a19",
+	"18:FE:AA:AA:AA:BB" => "TEMP-1.0.0"
+);
+
+if(isset($db[$_SERVER['HTTP_X_ESP8266_STA_MAC']])) {
+	if($db[$_SERVER['HTTP_X_ESP8266_STA_MAC']] != $_SERVER['HTTP_X_ESP8266_VERSION']) ) {
+		sendFile("./bin/".$db[$_SERVER['HTTP_X_ESP8266_STA_MAC']]."bin");
+	} else {
+		header($_SERVER["SERVER_PROTOCOL"].' 304 Not Modified', true, 304);
+	}
+}
+
+header($_SERVER["SERVER_PROTOCOL"].' 500 no version for ESP MAC', true, 500);
+
+```
+
+
+## Stream Interface
+
+TODO describe Stream Interface update proccess
+
+```cpp
+	ESP.updateSketch(client, length);
+```
+ 

libraries/ArduinoOTA/ArduinoOTA.cpp

@@ -51,6 +51,13 @@ void ArduinoOTA::setup() {
 }
 
 void ArduinoOTA::handle() {
+    
+  if (!*_udp_ota) {
+    _udp_ota->begin(_port); 
+        if (_serial_debug) {
+            Serial.println("OTA restarted"); 
+        }
+  }
 
   if (!_udp_ota->parsePacket()) return;
 

libraries/EEPROM/library.properties

@@ -4,5 +4,6 @@ author=Ivan Grokhotkov
 maintainer=Ivan Grokhotkov <[email protected]>
 sentence=Enables reading and writing data to the permanent FLASH storage, up to 4kb.
 paragraph=
+category=Data Storage
 url=http://arduino.cc/en/Reference/EEPROM
 architectures=esp8266

libraries/ESP8266WiFi/src/ESP8266WiFi.cpp

@@ -472,7 +472,7 @@ int8_t ESP8266WiFiClass::scanComplete() {
         return ESP8266WiFiClass::_scanCount;
     }
 
-    return WIFI_SCAN_FAILD;
+    return WIFI_SCAN_FAILED;
 }
 
 void ESP8266WiFiClass::scanDelete()
@@ -527,7 +527,7 @@ int8_t ESP8266WiFiClass::scanNetworks(bool async)
         esp_yield();
         return ESP8266WiFiClass::_scanCount;
     } else {
-        return WIFI_SCAN_FAILD;
+        return WIFI_SCAN_FAILED;
     }
 
 }
@@ -702,12 +702,12 @@ void wifi_wps_status_cb(wps_cb_status status)
     switch (status) {
         case WPS_CB_ST_SUCCESS:
             if(!wifi_wps_disable()) {
-                  DEBUGV("wps disable faild\n");
+                  DEBUGV("wps disable failed\n");
             }
             wifi_station_connect();
             break;
         case WPS_CB_ST_FAILED:
-            DEBUGV("wps FAILD\n");
+            DEBUGV("wps FAILED\n");
             break;
         case WPS_CB_ST_TIMEOUT:
             DEBUGV("wps TIMEOUT\n");
@@ -738,23 +738,23 @@ bool ESP8266WiFiClass::beginWPSConfig(void) {
     DEBUGV("wps begin\n");
 
     if(!wifi_wps_disable()) {
-        DEBUGV("wps disable faild\n");
+        DEBUGV("wps disable failed\n");
         return false;
     }
 
     // so far only WPS_TYPE_PBC is supported (SDK 1.2.0)
     if(!wifi_wps_enable(WPS_TYPE_PBC)) {
-        DEBUGV("wps enable faild\n");
+        DEBUGV("wps enable failed\n");
         return false;
     }
 
     if(!wifi_set_wps_cb((wps_st_cb_t) &wifi_wps_status_cb)) {
-        DEBUGV("wps cb faild\n");
+        DEBUGV("wps cb failed\n");
         return false;
     }
 
     if(!wifi_wps_start()) {
-        DEBUGV("wps start faild\n");
+        DEBUGV("wps start failed\n");
         return false;
     }
 

libraries/ESP8266WiFi/src/ESP8266WiFi.h

@@ -33,7 +33,7 @@ extern "C" {
 #include "WiFiServer.h"
 
 #define WIFI_SCAN_RUNNING   (-1)
-#define WIFI_SCAN_FAILD     (-2)
+#define WIFI_SCAN_FAILED     (-2)
 
 enum WiFiMode { WIFI_OFF = 0, WIFI_STA = 1, WIFI_AP = 2, WIFI_AP_STA = 3 };
 

libraries/ESP8266WiFi/src/ESP8266WiFiMulti.cpp

@@ -133,13 +133,13 @@ wl_status_t ESP8266WiFiMulti::run(void) {
                         DEBUG_WIFI_MULTI("[WIFI] Channel: %d\n", WiFi.channel());
                         break;
                     case WL_NO_SSID_AVAIL:
-                        DEBUG_WIFI_MULTI("[WIFI] Connecting Faild AP not found.\n");
+                        DEBUG_WIFI_MULTI("[WIFI] Connecting Failed AP not found.\n");
                         break;
                     case WL_CONNECT_FAILED:
-                        DEBUG_WIFI_MULTI("[WIFI] Connecting Faild.\n");
+                        DEBUG_WIFI_MULTI("[WIFI] Connecting Failed.\n");
                         break;
                     default:
-                        DEBUG_WIFI_MULTI("[WIFI] Connecting Faild (%d).\n", status);
+                        DEBUG_WIFI_MULTI("[WIFI] Connecting Failed (%d).\n", status);
                         break;
                 }
             } else {

libraries/ESP8266httpUpdate/library.properties

@@ -4,5 +4,6 @@ author=Markus Sattler
 maintainer=Markus Sattler
 sentence=Http Update for ESP8266
 paragraph=
+category=Data Processing
 url=https://github.com/Links2004/Arduino/tree/esp8266/hardware/esp8266com/esp8266/libraries/ESP8266httpUpdate
 architectures=esp8266

libraries/ESP8266httpUpdate/src/ESP8266httpUpdate.cpp

@@ -35,12 +35,12 @@ ESP8266HTTPUpdate::~ESP8266HTTPUpdate(void) {
 
 t_httpUpdate_return ESP8266HTTPUpdate::update(const char * host, uint16_t port, const char * url, const char * current_version) {
 
-    t_httpUpdate_return ret = HTTP_UPDATE_FAILD;
+    t_httpUpdate_return ret = HTTP_UPDATE_FAILED;
     WiFiClient tcp;
     DEBUG_HTTP_UPDATE("[httpUpdate] connected to %s:%u %s .... ", host, port, url);
 
     if(!tcp.connect(host, port)) {
-        DEBUG_HTTP_UPDATE("faild.\n");
+        DEBUG_HTTP_UPDATE("failed.\n");
         return ret;
     }
     DEBUG_HTTP_UPDATE("ok.\n");
@@ -125,7 +125,7 @@ t_httpUpdate_return ESP8266HTTPUpdate::update(const char * host, uint16_t port,
         case 200:  ///< OK (Start Update)
             if(len > 0) {
                 if(len > ESP.getFreeSketchSpace()) {
-                    ret = HTTP_UPDATE_FAILD;
+                    ret = HTTP_UPDATE_FAILED;
                     DEBUG_HTTP_UPDATE("[httpUpdate] FreeSketchSpace to low (%d) needed: %d\n", ESP.getFreeSketchSpace(), len);
                 } else {
 
@@ -140,13 +140,13 @@ t_httpUpdate_return ESP8266HTTPUpdate::update(const char * host, uint16_t port,
                         tcp.stop();
                         ESP.restart();
                     } else {
-                        ret = HTTP_UPDATE_FAILD;
+                        ret = HTTP_UPDATE_FAILED;
                         DEBUG_HTTP_UPDATE("[httpUpdate] Update failed\n");
                     }
                 }
             } else {
-                ret = HTTP_UPDATE_FAILD;
-                DEBUG_HTTP_UPDATE("[httpUpdate]Content-Length is 0?!\n");
+                ret = HTTP_UPDATE_FAILED;
+                DEBUG_HTTP_UPDATE("[httpUpdate] Content-Length is 0?!\n");
             }
             break;
         case 304:
@@ -157,7 +157,7 @@ t_httpUpdate_return ESP8266HTTPUpdate::update(const char * host, uint16_t port,
             ///< Forbidden
             // todo handle login
         default:
-            ret = HTTP_UPDATE_FAILD;
+            ret = HTTP_UPDATE_FAILED;
             DEBUG_HTTP_UPDATE("[httpUpdate] Code is (%d)\n", code);
             break;
     }

libraries/ESP8266httpUpdate/src/ESP8266httpUpdate.h

@@ -38,7 +38,7 @@
 #endif
 
 typedef enum {
-    HTTP_UPDATE_FAILD,
+    HTTP_UPDATE_FAILED,
     HTTP_UPDATE_NO_UPDATES,
     HTTP_UPDATE_OK
 } t_httpUpdate_return;

libraries/Ethernet/README.adoc

@@ -0,0 +1,26 @@
+= Ethernet Library for Arduino =
+
+With the Arduino Ethernet Shield, this library allows an Arduino board to connect to the internet.
+
+For more information about this library please visit us at
+http://www.arduino.cc/en/Reference/Ethernet
+
+modified to run on the ESP8266
+
+== License ==
+
+Copyright (c) 2010 Arduino LLC. All right reserved.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA