esphome::home_io_control::IOHomeScanPairedDevicesButton Class Reference

Button entity that runs the scan_paired_devices roll-call when pressed. More...

#include <platform_hub_controls.h>

Inheritance diagram for esphome::home_io_control::IOHomeScanPairedDevicesButton:

Collaboration diagram for esphome::home_io_control::IOHomeScanPairedDevicesButton:

Public Member Functions
void	dump_config () override
Public Member Functions inherited from esphome::home_io_control::HubBoundEntity
void	set_parent (IOHomeControlComponent *parent)
	Set the parent controller component.

Protected Member Functions
void	press_action () override
	When pressed, run the roll-call — see IOHomeControlComponent::trigger_scan_paired_devices() for the busy-guard rationale.

Additional Inherited Members
Protected Attributes inherited from esphome::home_io_control::HubBoundEntity
IOHomeControlComponent *	parent_ {nullptr}

Detailed Description

Button entity that runs the scan_paired_devices roll-call when pressed.

The same operation as the native API action of that name, which is unchanged and still registered — this is an additional trigger path, not a replacement. It exists because the roll-call is the fastest bring-up route for the common case of a user who already holds a system key extracted from a hub that has paired all its devices: every device that trusts the key answers with a ready-to-paste YAML snippet, with no pairing handshake at all. Reaching that through Developer Tools was a speed bump on a one-shot step.

Output stays where the action puts it: the multi-line log and the esphome.home_io_control_action_result event. Deliberately no companion result sensor — unlike the pairing button's "Last Pairing Result", the roll-call report is a multi-device document, not a state.

Created only when home_io_control.scan_paired_devices_button: true (see __init__.py's _create_scan_paired_devices_button()), unlike IOHomeDiscoverButton which is an unconditional button: platform entry — see the file header for why hub entities come from the hub block.

Definition at line 135 of file platform_hub_controls.h.

Member Function Documentation

dump_config()

void esphome::home_io_control::IOHomeScanPairedDevicesButton::dump_config ( )

inlineoverride

Definition at line 137 of file platform_hub_controls.h.

press_action()

void esphome::home_io_control::IOHomeScanPairedDevicesButton::press_action ( )

inlineoverrideprotected

When pressed, run the roll-call — see IOHomeControlComponent::trigger_scan_paired_devices() for the busy-guard rationale.

Definition at line 142 of file platform_hub_controls.h.

---

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

• components/home_io_control/platform_hub_controls.h