/** * * @file ESP8266HTTPUpdate.cpp * @date 21.06.2015 * @author Markus Sattler * * Copyright (c) 2015 Markus Sattler. All rights reserved. * This file is part of the ESP8266 Http Updater. * * 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 * */ #include "ESP8266httpUpdate.h" #include extern "C" uint32_t _SPIFFS_start; extern "C" uint32_t _SPIFFS_end; ESP8266HTTPUpdate::ESP8266HTTPUpdate(void) { } ESP8266HTTPUpdate::~ESP8266HTTPUpdate(void) { } /** * * @param url const char * * @param current_version const char * * @param httpsFingerprint const char * * @return t_httpUpdate_return */ t_httpUpdate_return ESP8266HTTPUpdate::update(const char * url, const char * current_version, const char * httpsFingerprint, bool reboot) { HTTPClient http; http.begin(url, httpsFingerprint); return handleUpdate(&http, current_version, reboot, false); } /** * * @param url const char * * @param current_version const char * * @param httpsFingerprint const char * * @return t_httpUpdate_return */ t_httpUpdate_return ESP8266HTTPUpdate::updateSpiffs(const char * url, const char * current_version, const char * httpsFingerprint, bool reboot) { HTTPClient http; http.begin(url, httpsFingerprint); return handleUpdate(&http, current_version, reboot, true); } /** * * @param host const char * * @param port uint16_t * @param url const char * * @param current_version const char * * @param httpsFingerprint const char * * @return */ t_httpUpdate_return ESP8266HTTPUpdate::update(const char * host, uint16_t port, const char * url, const char * current_version, bool https, const char * httpsFingerprint, bool reboot) { HTTPClient http; http.begin(host, port, url, https, httpsFingerprint); return handleUpdate(&http, current_version, reboot, false); } t_httpUpdate_return ESP8266HTTPUpdate::update(String host, uint16_t port, String url, String current_version, bool https, String httpsFingerprint, bool reboot) { HTTPClient http; http.begin(host, port, url, https, httpsFingerprint); return handleUpdate(&http, current_version.c_str(), reboot, false); } /** * return error code as int * @return int error code */ int ESP8266HTTPUpdate::getLastError(void){ return lastError; } /** * return error code as String * @return String error */ String ESP8266HTTPUpdate::getLastErrorString(void) { if(lastError == 0) { return String(); // no error } // error from Update class if(lastError > 0) { StreamString error; Update.printError(error); error.trim(); // remove line ending return "Update error: " + error; } // error from http client if(lastError > -100) { return "HTTP error: " + HTTPClient::errorToString(lastError); } switch(lastError) { case HTTP_UE_TOO_LESS_SPACE: return String("To less space"); case HTTP_UE_SERVER_NOT_REPORT_SIZE: return String("Server not Report Size"); case HTTP_UE_SERVER_FILE_NOT_FOUND: return String("File not Found (404)"); case HTTP_UE_SERVER_FORBIDDEN: return String("Forbidden (403)"); case HTTP_UE_SERVER_WRONG_HTTP_CODE: return String("Wrong HTTP code"); } return String(); } /** * * @param http HTTPClient * * @param current_version const char * * @return t_httpUpdate_return */ t_httpUpdate_return ESP8266HTTPUpdate::handleUpdate(HTTPClient * http, const char * current_version, bool reboot, bool spiffs) { t_httpUpdate_return ret = HTTP_UPDATE_FAILED; http->setUserAgent("ESP8266-http-Update"); http->addHeader("x-ESP8266-STA-MAC", WiFi.macAddress()); http->addHeader("x-ESP8266-AP-MAC", WiFi.softAPmacAddress()); http->addHeader("x-ESP8266-free-space", String(ESP.getFreeSketchSpace())); http->addHeader("x-ESP8266-sketch-size", String(ESP.getSketchSize())); http->addHeader("x-ESP8266-chip-size", String(ESP.getFlashChipRealSize())); http->addHeader("x-ESP8266-sdk-version", ESP.getSdkVersion()); if(spiffs) { http->addHeader("x-ESP8266-mode", "spiffs"); } else { http->addHeader("x-ESP8266-mode", "sketch"); } if(current_version && current_version[0] != 0x00) { http->addHeader("x-ESP8266-version", current_version); } const char * headerkeys[] = { "x-MD5" }; size_t headerkeyssize = sizeof(headerkeys) / sizeof(char*); // track these headers http->collectHeaders(headerkeys, headerkeyssize); int code = http->GET(); int len = http->getSize(); if(code <= 0) { DEBUG_HTTP_UPDATE("[httpUpdate] HTTP error: %s\n", http->errorToString(code).c_str()); lastError = code; http->end(); return HTTP_UPDATE_FAILED; } DEBUG_HTTP_UPDATE("[httpUpdate] Header read fin.\n"); DEBUG_HTTP_UPDATE("[httpUpdate] Server header:\n"); DEBUG_HTTP_UPDATE("[httpUpdate] - code: %d\n", code); DEBUG_HTTP_UPDATE("[httpUpdate] - len: %d\n", len); if(http->hasHeader("x-MD5")) { DEBUG_HTTP_UPDATE("[httpUpdate] - MD5: %s\n", http->header("x-MD5").c_str()); } DEBUG_HTTP_UPDATE("[httpUpdate] ESP8266 info:\n"); DEBUG_HTTP_UPDATE("[httpUpdate] - free Space: %d\n", ESP.getFreeSketchSpace()); DEBUG_HTTP_UPDATE("[httpUpdate] - current Sketch Size: %d\n", ESP.getSketchSize()); if(current_version && current_version[0] != 0x00) { DEBUG_HTTP_UPDATE("[httpUpdate] - current version: %s\n", current_version); } switch(code) { case HTTP_CODE_OK: ///< OK (Start Update) if(len > 0) { bool startUpdate = true; if(spiffs) { size_t spiffsSize = ((size_t) &_SPIFFS_end - (size_t) &_SPIFFS_start); if(len > (int) spiffsSize) { DEBUG_HTTP_UPDATE("[httpUpdate] spiffsSize to low (%d) needed: %d\n", spiffsSize, len); startUpdate = false; } } else { if(len > (int) ESP.getFreeSketchSpace()) { DEBUG_HTTP_UPDATE("[httpUpdate] FreeSketchSpace to low (%d) needed: %d\n", ESP.getFreeSketchSpace(), len); startUpdate = false; } } if(!startUpdate) { lastError = HTTP_UE_TOO_LESS_SPACE; ret = HTTP_UPDATE_FAILED; } else { WiFiClient * tcp = http->getStreamPtr(); WiFiUDP::stopAll(); WiFiClient::stopAllExcept(tcp); delay(100); int command; if(spiffs) { command = U_SPIFFS; DEBUG_HTTP_UPDATE("[httpUpdate] runUpdate spiffs...\n"); } else { command = U_FLASH; DEBUG_HTTP_UPDATE("[httpUpdate] runUpdate flash...\n"); } if(runUpdate(*tcp, len, http->header("x-MD5"), command)) { ret = HTTP_UPDATE_OK; DEBUG_HTTP_UPDATE("[httpUpdate] Update ok\n"); http->end(); if(reboot) { ESP.restart(); } } else { ret = HTTP_UPDATE_FAILED; DEBUG_HTTP_UPDATE("[httpUpdate] Update failed\n"); } } } else { lastError = HTTP_UE_SERVER_NOT_REPORT_SIZE; ret = HTTP_UPDATE_FAILED; DEBUG_HTTP_UPDATE("[httpUpdate] Content-Length is 0 or not set by Server?!\n"); } break; case HTTP_CODE_NOT_MODIFIED: ///< Not Modified (No updates) ret = HTTP_UPDATE_NO_UPDATES; break; case HTTP_CODE_NOT_FOUND: lastError = HTTP_UE_SERVER_FILE_NOT_FOUND; ret = HTTP_UPDATE_FAILED; break; case HTTP_CODE_FORBIDDEN: lastError = HTTP_UE_SERVER_FORBIDDEN; ret = HTTP_UPDATE_FAILED; break; default: lastError = HTTP_UE_SERVER_WRONG_HTTP_CODE; ret = HTTP_UPDATE_FAILED; DEBUG_HTTP_UPDATE("[httpUpdate] HTTP Code is (%d)\n", code); //http->writeToStream(&Serial1); break; } http->end(); return ret; } /** * write Update to flash * @param in Stream& * @param size uint32_t * @param md5 String * @return true if Update ok */ bool ESP8266HTTPUpdate::runUpdate(Stream& in, uint32_t size, String md5, int command) { StreamString error; if(!Update.begin(size, command)) { lastError = Update.getError(); Update.printError(error); error.trim(); // remove line ending DEBUG_HTTP_UPDATE("[httpUpdate] Update.begin failed! (%s)\n", error.c_str()); return false; } if(md5.length()) { Update.setMD5(md5.c_str()); } if(Update.writeStream(in) != size) { lastError = Update.getError(); Update.printError(error); error.trim(); // remove line ending DEBUG_HTTP_UPDATE("[httpUpdate] Update.writeStream failed! (%s)\n", error.c_str()); return false; } if(!Update.end()) { lastError = Update.getError(); Update.printError(error); error.trim(); // remove line ending DEBUG_HTTP_UPDATE("[httpUpdate] Update.end failed! (%s)\n", error.c_str()); return false; } return true; } ESP8266HTTPUpdate ESPhttpUpdate;