mirror of
https://github.com/esp8266/Arduino.git
synced 2025-07-23 08:45:22 +03:00
800794de37
Replaces abandoned #1817 and #2694 Add optional std::function callback (so it supports lambdas and normal functions) via ::onStart, ::onEnd, ::onProgress, and ::onError methods. Update example with their use. From @baruch's original pull request: The callback is called when the upgrade actually starts rather than just the initial query so that the user can know that it will not take longer and can also prepare for the upgrade by shutting down other works. From @karlp's original pull request: Incomplete: I've not updated any documentation yet. If this style looks good, I'll happily go and update the documentation (likewise for the examples)
174 lines
6.9 KiB
C++
174 lines
6.9 KiB
C++
/**
|
|
*
|
|
* @file ESP8266HTTPUpdate.h
|
|
* @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
|
|
*
|
|
*/
|
|
|
|
#ifndef ESP8266HTTPUPDATE_H_
|
|
#define ESP8266HTTPUPDATE_H_
|
|
|
|
#include <Arduino.h>
|
|
#include <ESP8266WiFi.h>
|
|
#include <WiFiClient.h>
|
|
#include <WiFiUdp.h>
|
|
#include <ESP8266HTTPClient.h>
|
|
|
|
#ifndef HTTPUPDATE_1_2_COMPATIBLE
|
|
#define HTTPUPDATE_1_2_COMPATIBLE HTTPCLIENT_1_1_COMPATIBLE
|
|
#endif
|
|
|
|
#ifdef DEBUG_ESP_HTTP_UPDATE
|
|
#ifdef DEBUG_ESP_PORT
|
|
#define DEBUG_HTTP_UPDATE(fmt, ...) DEBUG_ESP_PORT.printf_P( (PGM_P)PSTR(fmt), ## __VA_ARGS__ )
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef DEBUG_HTTP_UPDATE
|
|
#define DEBUG_HTTP_UPDATE(...) do { (void)0; } while(0)
|
|
#endif
|
|
|
|
/// note we use HTTP client errors too so we start at 100
|
|
//TODO - in v3.0.0 make this an enum
|
|
constexpr int HTTP_UE_TOO_LESS_SPACE = (-100);
|
|
constexpr int HTTP_UE_SERVER_NOT_REPORT_SIZE = (-101);
|
|
constexpr int HTTP_UE_SERVER_FILE_NOT_FOUND = (-102);
|
|
constexpr int HTTP_UE_SERVER_FORBIDDEN = (-103);
|
|
constexpr int HTTP_UE_SERVER_WRONG_HTTP_CODE = (-104);
|
|
constexpr int HTTP_UE_SERVER_FAULTY_MD5 = (-105);
|
|
constexpr int HTTP_UE_BIN_VERIFY_HEADER_FAILED = (-106);
|
|
constexpr int HTTP_UE_BIN_FOR_WRONG_FLASH = (-107);
|
|
|
|
enum HTTPUpdateResult {
|
|
HTTP_UPDATE_FAILED,
|
|
HTTP_UPDATE_NO_UPDATES,
|
|
HTTP_UPDATE_OK
|
|
};
|
|
|
|
typedef HTTPUpdateResult t_httpUpdate_return; // backward compatibility
|
|
|
|
using HTTPUpdateStartCB = std::function<void()>;
|
|
using HTTPUpdateEndCB = std::function<void()>;
|
|
using HTTPUpdateErrorCB = std::function<void(int)>;
|
|
using HTTPUpdateProgressCB = std::function<void(int, int)>;
|
|
|
|
class ESP8266HTTPUpdate
|
|
{
|
|
public:
|
|
ESP8266HTTPUpdate(void);
|
|
ESP8266HTTPUpdate(int httpClientTimeout);
|
|
~ESP8266HTTPUpdate(void);
|
|
|
|
void rebootOnUpdate(bool reboot)
|
|
{
|
|
_rebootOnUpdate = reboot;
|
|
}
|
|
|
|
void followRedirects(bool follow)
|
|
{
|
|
_followRedirects = follow;
|
|
}
|
|
|
|
void setLedPin(int ledPin = -1, uint8_t ledOn = HIGH)
|
|
{
|
|
_ledPin = ledPin;
|
|
_ledOn = ledOn;
|
|
}
|
|
|
|
#if HTTPUPDATE_1_2_COMPATIBLE
|
|
// This function is deprecated, use rebootOnUpdate and the next one instead
|
|
t_httpUpdate_return update(const String& url, const String& currentVersion,
|
|
const String& httpsFingerprint, bool reboot) __attribute__((deprecated));
|
|
t_httpUpdate_return update(const String& url, const String& currentVersion = "") __attribute__((deprecated));
|
|
t_httpUpdate_return update(const String& url, const String& currentVersion,
|
|
const String& httpsFingerprint) __attribute__((deprecated));
|
|
t_httpUpdate_return update(const String& url, const String& currentVersion,
|
|
const uint8_t httpsFingerprint[20]) __attribute__((deprecated)); // BearSSL
|
|
#endif
|
|
t_httpUpdate_return update(WiFiClient& client, const String& url, const String& currentVersion = "");
|
|
|
|
#if HTTPUPDATE_1_2_COMPATIBLE
|
|
// This function is deprecated, use one of the overloads below along with rebootOnUpdate
|
|
t_httpUpdate_return update(const String& host, uint16_t port, const String& uri, const String& currentVersion,
|
|
bool https, const String& httpsFingerprint, bool reboot) __attribute__((deprecated));
|
|
|
|
t_httpUpdate_return update(const String& host, uint16_t port, const String& uri = "/",
|
|
const String& currentVersion = "") __attribute__((deprecated));
|
|
t_httpUpdate_return update(const String& host, uint16_t port, const String& url,
|
|
const String& currentVersion, const String& httpsFingerprint) __attribute__((deprecated));
|
|
t_httpUpdate_return update(const String& host, uint16_t port, const String& url,
|
|
const String& currentVersion, const uint8_t httpsFingerprint[20]) __attribute__((deprecated)); // BearSSL
|
|
#endif
|
|
t_httpUpdate_return update(WiFiClient& client, const String& host, uint16_t port, const String& uri = "/",
|
|
const String& currentVersion = "");
|
|
|
|
#if HTTPUPDATE_1_2_COMPATIBLE
|
|
// This function is deprecated, use rebootOnUpdate and the next one instead
|
|
t_httpUpdate_return updateSpiffs(const String& url, const String& currentVersion,
|
|
const String& httpsFingerprint, bool reboot) __attribute__((deprecated));
|
|
t_httpUpdate_return updateSpiffs(const String& url, const String& currentVersion = "") __attribute__((deprecated));
|
|
t_httpUpdate_return updateSpiffs(const String& url, const String& currentVersion, const String& httpsFingerprint) __attribute__((deprecated));
|
|
t_httpUpdate_return updateSpiffs(const String& url, const String& currentVersion, const uint8_t httpsFingerprint[20]) __attribute__((deprecated)); // BearSSL
|
|
#endif
|
|
t_httpUpdate_return updateSpiffs(WiFiClient& client, const String& url, const String& currentVersion = "");
|
|
|
|
// Notification callbacks
|
|
void onStart(HTTPUpdateStartCB cbOnStart) { _cbStart = cbOnStart; }
|
|
void onEnd(HTTPUpdateEndCB cbOnEnd) { _cbEnd = cbOnEnd; }
|
|
void onError(HTTPUpdateErrorCB cbOnError) { _cbError = cbOnError; }
|
|
void onProgress(HTTPUpdateProgressCB cbOnProgress) { _cbProgress = cbOnProgress; }
|
|
|
|
int getLastError(void);
|
|
String getLastErrorString(void);
|
|
|
|
protected:
|
|
t_httpUpdate_return handleUpdate(HTTPClient& http, const String& currentVersion, bool spiffs = false);
|
|
bool runUpdate(Stream& in, uint32_t size, const String& md5, int command = U_FLASH);
|
|
|
|
// Set the error and potentially use a CB to notify the application
|
|
void _setLastError(int err) {
|
|
_lastError = err;
|
|
if (_cbError) {
|
|
_cbError(err);
|
|
}
|
|
}
|
|
int _lastError;
|
|
bool _rebootOnUpdate = true;
|
|
private:
|
|
int _httpClientTimeout;
|
|
bool _followRedirects;
|
|
|
|
// Callbacks
|
|
HTTPUpdateStartCB _cbStart;
|
|
HTTPUpdateEndCB _cbEnd;
|
|
HTTPUpdateErrorCB _cbError;
|
|
HTTPUpdateProgressCB _cbProgress;
|
|
|
|
int _ledPin;
|
|
uint8_t _ledOn;
|
|
};
|
|
|
|
#if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_HTTPUPDATE)
|
|
extern ESP8266HTTPUpdate ESPhttpUpdate;
|
|
#endif
|
|
|
|
#endif /* ESP8266HTTPUPDATE_H_ */
|