ota_backend_esp8266.h

Go to the documentation of this file.

#pragma once
#ifdef USE_ESP8266
#include "ota_backend.h"
 
#include "esphome/components/md5/md5.h"
#include "esphome/core/defines.h"
 
#include <memory>
 
namespace esphome::ota {
 
class ESP8266OTABackend : public OTABackend {
 public:
  OTAResponseTypes begin(size_t image_size) override;
  void set_update_md5(const char *md5) override;
  OTAResponseTypes write(uint8_t *data, size_t len) override;
  OTAResponseTypes end() override;
  void abort() override;
  // Compression supported in all ESP8266 Arduino versions ESPHome supports (>= 2.7.0)
  bool supports_compression() override { return true; }
 
 protected:
  bool erase_sector_if_needed_();
 
  bool flash_write_();
 
  bool write_buffer_();
 
  bool write_buffer_final_();
 
  bool verify_end_();
 
  uint8_t get_flash_chip_mode_();
 
  std::unique_ptr<uint8_t[]> buffer_;
  size_t buffer_size_{0};
  size_t buffer_len_{0};
 
  uint32_t start_address_{0};
  uint32_t current_address_{0};
  size_t image_size_{0};
 
  md5::MD5Digest md5_{};
  uint8_t expected_md5_[16];  // Fixed-size buffer for 128-bit (16-byte) MD5 digest
  bool md5_set_{false};
};
 
}  // namespace esphome::ota
#endif  // USE_ESP8266