platform_lr1121_bootloader_rewrite_switch.h

Go to the documentation of this file.

#pragma once
 
/// @file platform_lr1121_bootloader_rewrite_switch.h
/// @brief Hub-level arming switch for the LR1121 bootloader-rewrite (three-stage) sequence.
/// @ingroup hioc_platforms
///
/// Like IOHomeAcceptForeignPairingSwitch and IOHomeLr1121FirmwareUpdateButton, this entity is
/// hub-level, not device-bound. It is created dynamically from the presence of
/// `home_io_control.lr1121_firmware_update.bootloader:` (see `__init__.py`'s
/// `_create_lr1121_bootloader_update()`), bound directly to the hub instance being built.
///
/// This is a *permission*, not the two-press "armed" confirmation used elsewhere in this
/// component (`lr1121_flash_confirmation_armed_`) -- see ADR 0021 for why an arming switch
/// (visible in Home Assistant, so "is this armed?" is answerable by looking) was chosen over
/// another invisible two-press window for the one operation in this component with no undo. It
/// can only convert a cached `BootloaderUpgradePath::AVAILABLE` verdict into "run the three-stage
/// sequence"; it never affects any other verdict or guard (see
/// IOHomeControlComponent::set_bootloader_rewrite_allowed()).
 
// IOHOME_LR1121_BOOTLOADER_UPDATE is only visible after something pulls in esphome/core/defines.h
// (via hub_core.h's own #include "esphome/core/hal.h") — these #includes must run before the
// #ifdef check, not after (see radio_lr1121_firmware_updater.h for the fuller explanation of why
// this ordering matters and how it stayed invisible in host unit tests).
#include "esphome/components/switch/switch.h"
#include "hub_core.h"
 
#ifdef IOHOME_LR1121_BOOTLOADER_UPDATE
 
namespace esphome {
namespace home_io_control {
 
/// @brief Hub-level switch entity: ON permits the next flash-button press to run the three-stage
/// bootloader-rewrite sequence (when the cached verdict is AVAILABLE); OFF (the default, and the
/// restore-on-boot state -- `ALWAYS_OFF`) refuses it. No auto-off timer: see ADR 0021 for why the
/// window is already self-limiting.
/// @ingroup hioc_platforms
class IOHomeLr1121BootloaderRewriteSwitch : public switch_::Switch, public Component {
 public:
  /// @brief Set the parent controller component.
  /// @param parent Pointer to the IOHomeControlComponent instance.
  void set_parent(IOHomeControlComponent *parent) { this->parent_ = parent; }
 
  /// @brief Publish the initial OFF state.
  ///
  /// Unlike IOHomeAcceptForeignPairingSwitch, this switch has no auto-off timer, so the hub never
  /// changes the permission on its own and there is no state to push back -- but an entity that
  /// has never published reads as *unknown* in Home Assistant, and a safety control whose whole
  /// justification is "is this armed? answerable by looking" (ADR 0021) must not render blank.
  /// Publishing false also makes the configured ALWAYS_OFF restore behaviour observable rather
  /// than merely implied. Publishing does not call write_state(), so this never touches the hub.
  void setup() override;
 
  /// @brief Dump configuration to the log.
  void dump_config() override;
 
  /// @brief Get setup priority so the parent hub is available first.
  /// @return setup_priority::DATA.
  [[nodiscard]] float get_setup_priority() const override { return setup_priority::DATA; }
 
 protected:
  /// @brief Forward the toggle to the hub as a permission -- see
  /// IOHomeControlComponent::set_bootloader_rewrite_allowed().
  /// @param state Desired switch state.
  void write_state(bool state) override;
 
  IOHomeControlComponent *parent_{nullptr};
};
 
}  // namespace home_io_control
}  // namespace esphome
 
#endif  // IOHOME_LR1121_BOOTLOADER_UPDATE