mirror of
https://github.com/1technophile/OpenMQTTGateway.git
synced 2026-02-20 08:42:09 +01:00
If enabled in user_config.h this will trigger the OMG to update it's firmware from the link
provided in the MQTT message.
Example message:
{\"version\":\"test\",\"password\":\"OMGPASSWORD\",\"url\":\"https://github.com/1technophile/OpenMQTTGateway/releases/download/v0.9.6/esp32dev-ble-cont-firmware.bin\"}
If the firmware version in the message is not the same as the current OMG version the device will self update using the link in the url of the message.
113 lines
3.5 KiB
C++
113 lines
3.5 KiB
C++
/**
|
|
*
|
|
* @file HTTPUpdate.h based on ESP8266HTTPUpdate.h
|
|
* @date 16.10.2018
|
|
* @author Markus Sattler
|
|
*
|
|
* Copyright (c) 2015 Markus Sattler. All rights reserved.
|
|
* This file is part of the ESP32 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
|
|
*
|
|
*/
|
|
#ifdef ESP32
|
|
# ifndef ___zzHTTP_UPDATE_H___
|
|
# define ___zzHTTP_UPDATE_H___
|
|
|
|
# include <Arduino.h>
|
|
# include <HTTPClient.h>
|
|
# include <Update.h>
|
|
# include <WiFi.h>
|
|
# include <WiFiClient.h>
|
|
# include <WiFiUdp.h>
|
|
|
|
/// note we use HTTP client errors too so we start at 100
|
|
# define HTTP_UE_TOO_LESS_SPACE (-100)
|
|
# define HTTP_UE_SERVER_NOT_REPORT_SIZE (-101)
|
|
# define HTTP_UE_SERVER_FILE_NOT_FOUND (-102)
|
|
# define HTTP_UE_SERVER_FORBIDDEN (-103)
|
|
# define HTTP_UE_SERVER_WRONG_HTTP_CODE (-104)
|
|
# define HTTP_UE_SERVER_FAULTY_MD5 (-105)
|
|
# define HTTP_UE_BIN_VERIFY_HEADER_FAILED (-106)
|
|
# define HTTP_UE_BIN_FOR_WRONG_FLASH (-107)
|
|
# define HTTP_UE_NO_PARTITION (-108)
|
|
|
|
enum HTTPUpdateResult {
|
|
HTTP_UPDATE_FAILED,
|
|
HTTP_UPDATE_NO_UPDATES,
|
|
HTTP_UPDATE_OK
|
|
};
|
|
|
|
typedef HTTPUpdateResult t_httpUpdate_return; // backward compatibility
|
|
|
|
class HTTPUpdate {
|
|
public:
|
|
HTTPUpdate(void);
|
|
HTTPUpdate(int httpClientTimeout);
|
|
~HTTPUpdate(void);
|
|
|
|
void rebootOnUpdate(bool reboot) {
|
|
_rebootOnUpdate = reboot;
|
|
}
|
|
|
|
/**
|
|
* set redirect follow mode. See `followRedirects_t` enum for avaliable modes.
|
|
* @param follow
|
|
*/
|
|
void setFollowRedirects(followRedirects_t follow) {
|
|
_followRedirects = follow;
|
|
}
|
|
|
|
void setLedPin(int ledPin = -1, uint8_t ledOn = HIGH) {
|
|
_ledPin = ledPin;
|
|
_ledOn = ledOn;
|
|
}
|
|
|
|
t_httpUpdate_return update(WiFiClient& client, const String& url, const String& currentVersion = "");
|
|
|
|
t_httpUpdate_return update(WiFiClient& client, const String& host, uint16_t port, const String& uri = "/",
|
|
const String& currentVersion = "");
|
|
|
|
t_httpUpdate_return updateSpiffs(WiFiClient& client, const String& url, const String& currentVersion = "");
|
|
|
|
t_httpUpdate_return update(HTTPClient& httpClient,
|
|
const String& currentVersion = "");
|
|
|
|
t_httpUpdate_return updateSpiffs(HTTPClient& httpClient, const String& currentVersion = "");
|
|
|
|
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, String md5, int command = U_FLASH);
|
|
|
|
int _lastError;
|
|
bool _rebootOnUpdate = true;
|
|
|
|
private:
|
|
int _httpClientTimeout;
|
|
followRedirects_t _followRedirects;
|
|
|
|
int _ledPin;
|
|
uint8_t _ledOn;
|
|
};
|
|
|
|
# if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_HTTPUPDATE)
|
|
extern HTTPUpdate httpUpdate;
|
|
# endif
|
|
|
|
# endif /* ___HTTP_UPDATE_H___ */
|
|
#endif |