ota_upload_server.h

Go to the documentation of this file.

#pragma once
 
#include <Arduino.h>
#include <WebServer.h>
 
enum class OtaUploadState {
  kDisabled,  
  kArmed,     
  kUploading, 
  kSucceeded, 
  kFailed,    
  kTimedOut,  
};
 
class OtaUploadServer {
 public:
  OtaUploadServer();
 
  void begin(const char* firmwareName,
             const char* firmwareVersion,
             const char* firmwareIdentityTag,
             const char* firmwareVersionTag);
 
  void update(uint32_t nowMs);
 
  bool enable(uint32_t nowMs, Stream& out);
 
  void cancel(Stream& out);
 
  void printStatus(Stream& out) const;
 
  bool active() const;
 
  OtaUploadState state() const;
 
  const char* statusLabel() const;
 
  const char* lastMessage() const;
 
 private:
  static constexpr uint32_t kUploadWindowMs = 5UL * 60UL * 1000UL;
  static constexpr uint16_t kHttpPort = 80;
  static constexpr size_t kMessageBufferSize = 96;
  static constexpr size_t kIdentityBufferSize = 32;
 
  void configureRoutes();
  void stopServer(OtaUploadState finalState, const char* message);
  void failUpload(const char* message);
  bool validateUploadedImage();
  void handleRoot();
  void handleUpdateForm();
  void handleUpdateFinished();
  void handleUploadChunk();
  const char* stateLabel() const;
 
  WebServer server_;
  const char* firmwareName_;
  const char* firmwareVersion_;
  const char* firmwareIdentityTag_;
  const char* firmwareVersionTag_;
  OtaUploadState state_;
  bool initialized_;
  bool serverRunning_;
  bool uploadStarted_;
  bool uploadFinished_;
  bool rebootPending_;
  bool updateWriteError_;
  uint32_t enabledAtMs_;
  size_t maxImageSize_;
  size_t expectedSize_;
  size_t writtenSize_;
  char currentVersion_[kIdentityBufferSize];
  char lastMessage_[kMessageBufferSize];
};