esphome::home_io_control::IOHomeRecoverOneWayKeySwitch Class Reference

Hub-level switch entity: ON arms the 1W key-recovery listener, OFF disarms it immediately. More...

#include <platform_hub_controls.h>

Inheritance diagram for esphome::home_io_control::IOHomeRecoverOneWayKeySwitch:

Collaboration diagram for esphome::home_io_control::IOHomeRecoverOneWayKeySwitch:

Protected Member Functions
void	arm (bool state) override
	Arm or disarm this switch's listener on the hub.
void	subscribe_armed (std::function< void(bool)> callback) override
	Subscribe callback to the hub's armed-state changes for this listener.
void	dump_config () override
	Dump configuration to the log.
Protected Member Functions inherited from esphome::home_io_control::HubArmingSwitch
void	write_state (bool state) final
	Forward the toggle to the hub and publish the state.

Additional Inherited Members
Public Member Functions inherited from esphome::home_io_control::HubArmingSwitch
void	setup () final
	Register the armed-state callback so this entity mirrors the hub's own disarm events.
float	get_setup_priority () const final
	Get setup priority so the parent hub is available first.
Public Member Functions inherited from esphome::home_io_control::HubBoundEntity
void	set_parent (IOHomeControlComponent *parent)
	Set the parent controller component.
Protected Attributes inherited from esphome::home_io_control::HubBoundEntity
IOHomeControlComponent *	parent_ {nullptr}

Detailed Description

Hub-level switch entity: ON arms the 1W key-recovery listener, OFF disarms it immediately.

Publishes its own state changes when the hub disarms itself (after a key is recovered, or on auto-off timeout), not just on a user-initiated toggle.

The one-way sibling of IOHomeAcceptForeignPairingSwitch: same hub-level, non-device-bound shape, created dynamically from home_io_control.recover_oneway_key: true. See oneway_key_adoption.cpp for what arming actually does.

The two features are deliberately independent: 2W key extraction impersonates an unpaired device so a foreign hub pairs to us, while this one only listens for a key a 1W device broadcasts of its own accord. Arming one never arms the other.

Definition at line 95 of file platform_hub_controls.h.

Member Function Documentation

arm()

void esphome::home_io_control::IOHomeRecoverOneWayKeySwitch::arm ( bool state )

inlineoverrideprotectedvirtual

Arm or disarm this switch's listener on the hub.

Implements esphome::home_io_control::HubArmingSwitch.

Definition at line 97 of file platform_hub_controls.h.

dump_config()

void esphome::home_io_control::IOHomeRecoverOneWayKeySwitch::dump_config ( )

overrideprotected

Dump configuration to the log.

Definition at line 35 of file platform_hub_controls.cpp.

subscribe_armed()

void esphome::home_io_control::IOHomeRecoverOneWayKeySwitch::subscribe_armed ( std::function< void(bool)> callback )

inlineoverrideprotectedvirtual

Subscribe callback to the hub's armed-state changes for this listener.

Implements esphome::home_io_control::HubArmingSwitch.

Definition at line 98 of file platform_hub_controls.h.

---

The documentation for this class was generated from the following files:

• components/home_io_control/platform_hub_controls.h
• components/home_io_control/platform_hub_controls.cpp