mirror of
https://github.com/esphome/esphome.git
synced 2025-10-02 01:52:21 +01:00
ac0d921413
* Socket refactor and SSL * esp-idf temp * Fixes * Echo component and noise * Add noise API transport support * Updates * ESP-IDF * Complete * Fixes * Fixes * Versions update * New i2c APIs * Complete i2c refactor * SPI migration * Revert ESP Preferences migration, too complex for now * OTA support * Remove echo again * Remove ssl again * GPIOFlags updates * Rename esphal and ICACHE_RAM_ATTR * Make ESP32 arduino compilable again * Fix GPIO flags * Complete pin registry refactor and fixes * Fixes to make test1 compile * Remove sdkconfig file * Ignore sdkconfig file * Fixes in reviewing * Make test2 compile * Make test4 compile * Make test5 compile * Run clang-format * Fix lint errors * Use esp-idf APIs instead of btStart * Another round of fixes * Start implementing ESP8266 * Make test3 compile * Guard esp8266 code * Lint * Reformat * Fixes * Fixes v2 * more fixes * ESP-IDF tidy target * Convert ARDUINO_ARCH_ESPxx * Update WiFiSignalSensor * Update time ifdefs * OTA needs millis from hal * RestartSwitch needs delay from hal * ESP-IDF Uart * Fix OTA blank password * Allow setting sdkconfig * Fix idf partitions and allow setting sdkconfig from yaml * Re-add read/write compat APIs and fix esp8266 uart * Fix esp8266 store log strings in flash * Fix ESP32 arduino preferences not initialized * Update ifdefs * Change how sdkconfig change is detected * Add checks to ci-custom and fix them * Run clang-format * Add esp-idf clang-tidy target and fix errors * Fixes from clang-tidy idf round 2 * Fixes from compiling tests with esp-idf * Run clang-format * Switch test5.yaml to esp-idf * Implement ESP8266 Preferences * Lint * Re-do PIO package version selection a bit * Fix arduinoespressif32 package version * Fix unit tests * Lint * Lint fixes * Fix readv/writev not defined * Fix graphing component * Re-add all old options from core/config.py Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
99 lines
2.8 KiB
C++
99 lines
2.8 KiB
C++
#pragma once
|
|
|
|
#include "esphome/components/socket/socket.h"
|
|
#include "esphome/core/component.h"
|
|
#include "esphome/core/preferences.h"
|
|
#include "esphome/core/helpers.h"
|
|
#include "esphome/core/defines.h"
|
|
|
|
namespace esphome {
|
|
namespace ota {
|
|
|
|
enum OTAResponseTypes {
|
|
OTA_RESPONSE_OK = 0,
|
|
OTA_RESPONSE_REQUEST_AUTH = 1,
|
|
|
|
OTA_RESPONSE_HEADER_OK = 64,
|
|
OTA_RESPONSE_AUTH_OK = 65,
|
|
OTA_RESPONSE_UPDATE_PREPARE_OK = 66,
|
|
OTA_RESPONSE_BIN_MD5_OK = 67,
|
|
OTA_RESPONSE_RECEIVE_OK = 68,
|
|
OTA_RESPONSE_UPDATE_END_OK = 69,
|
|
|
|
OTA_RESPONSE_ERROR_MAGIC = 128,
|
|
OTA_RESPONSE_ERROR_UPDATE_PREPARE = 129,
|
|
OTA_RESPONSE_ERROR_AUTH_INVALID = 130,
|
|
OTA_RESPONSE_ERROR_WRITING_FLASH = 131,
|
|
OTA_RESPONSE_ERROR_UPDATE_END = 132,
|
|
OTA_RESPONSE_ERROR_INVALID_BOOTSTRAPPING = 133,
|
|
OTA_RESPONSE_ERROR_WRONG_CURRENT_FLASH_CONFIG = 134,
|
|
OTA_RESPONSE_ERROR_WRONG_NEW_FLASH_CONFIG = 135,
|
|
OTA_RESPONSE_ERROR_ESP8266_NOT_ENOUGH_SPACE = 136,
|
|
OTA_RESPONSE_ERROR_ESP32_NOT_ENOUGH_SPACE = 137,
|
|
OTA_RESPONSE_ERROR_NO_UPDATE_PARTITION = 138,
|
|
OTA_RESPONSE_ERROR_UNKNOWN = 255,
|
|
};
|
|
|
|
enum OTAState { OTA_COMPLETED = 0, OTA_STARTED, OTA_IN_PROGRESS, OTA_ERROR };
|
|
|
|
/// OTAComponent provides a simple way to integrate Over-the-Air updates into your app using ArduinoOTA.
|
|
class OTAComponent : public Component {
|
|
public:
|
|
#ifdef USE_OTA_PASSWORD
|
|
void set_auth_password(const std::string &password) { password_ = password; }
|
|
#endif // USE_OTA_PASSWORD
|
|
|
|
/// Manually set the port OTA should listen on.
|
|
void set_port(uint16_t port);
|
|
|
|
bool should_enter_safe_mode(uint8_t num_attempts, uint32_t enable_time);
|
|
|
|
#ifdef USE_OTA_STATE_CALLBACK
|
|
void add_on_state_callback(std::function<void(OTAState, float, uint8_t)> &&callback);
|
|
#endif
|
|
|
|
// ========== INTERNAL METHODS ==========
|
|
// (In most use cases you won't need these)
|
|
void setup() override;
|
|
void dump_config() override;
|
|
float get_setup_priority() const override;
|
|
void loop() override;
|
|
|
|
uint16_t get_port() const;
|
|
|
|
void clean_rtc();
|
|
|
|
void on_safe_shutdown() override;
|
|
|
|
protected:
|
|
void write_rtc_(uint32_t val);
|
|
uint32_t read_rtc_();
|
|
|
|
void handle_();
|
|
bool readall_(uint8_t *buf, size_t len);
|
|
bool writeall_(const uint8_t *buf, size_t len);
|
|
|
|
#ifdef USE_OTA_PASSWORD
|
|
std::string password_;
|
|
#endif // USE_OTA_PASSWORD
|
|
|
|
uint16_t port_;
|
|
|
|
std::unique_ptr<socket::Socket> server_;
|
|
std::unique_ptr<socket::Socket> client_;
|
|
|
|
bool has_safe_mode_{false}; ///< stores whether safe mode can be enabled.
|
|
uint32_t safe_mode_start_time_; ///< stores when safe mode was enabled.
|
|
uint32_t safe_mode_enable_time_{60000}; ///< The time safe mode should be on for.
|
|
uint32_t safe_mode_rtc_value_;
|
|
uint8_t safe_mode_num_attempts_;
|
|
ESPPreferenceObject rtc_;
|
|
|
|
#ifdef USE_OTA_STATE_CALLBACK
|
|
CallbackManager<void(OTAState, float, uint8_t)> state_callback_{};
|
|
#endif
|
|
};
|
|
|
|
} // namespace ota
|
|
} // namespace esphome
|