Home IO Control
ESPHome add-on for IO-Homecontrol devices
Loading...
Searching...
No Matches
esphome::home_io_control::IOHomeCoverVentButton Class Reference

Button entity that sends the ventilation position command. More...

#include <platform_cover_vent_button.h>

Inheritance diagram for esphome::home_io_control::IOHomeCoverVentButton:
Collaboration diagram for esphome::home_io_control::IOHomeCoverVentButton:

Public Member Functions

void set_parent (IOHomeControlComponent *parent)
 Set the parent controller component.
void set_device_id (const std::string &id)
 Set the device ID controlled by this button.
void setup () override
 Initialize the generated button.
void dump_config () override
 Dump button configuration to the log.
float get_setup_priority () const override
 Get setup priority so the parent hub is available first.

Protected Member Functions

void press_action () override
 Handle a Home Assistant button press by queueing a ventilation command.

Protected Attributes

IOHomeControlComponentparent_ {nullptr}
std::string device_id_

Detailed Description

Button entity that sends the ventilation position command.

Generated automatically by the Python codegen for cover entities whose io_device_type is a window or ventilation device. Pressing this button in Home Assistant sends CoverCommand::VENT via the authenticated exchange.

Definition at line 26 of file platform_cover_vent_button.h.

Member Function Documentation

◆ dump_config()

void esphome::home_io_control::IOHomeCoverVentButton::dump_config ( )
override

Dump button configuration to the log.

Definition at line 29 of file platform_cover_vent_button.cpp.

◆ get_setup_priority()

float esphome::home_io_control::IOHomeCoverVentButton::get_setup_priority ( ) const
inlinenodiscardoverride

Get setup priority so the parent hub is available first.

Returns
setup_priority::DATA.

Definition at line 44 of file platform_cover_vent_button.h.

◆ press_action()

void esphome::home_io_control::IOHomeCoverVentButton::press_action ( )
overrideprotected

Handle a Home Assistant button press by queueing a ventilation command.

Definition at line 14 of file platform_cover_vent_button.cpp.

◆ set_device_id()

void esphome::home_io_control::IOHomeCoverVentButton::set_device_id ( const std::string & id)
inline

Set the device ID controlled by this button.

Parameters
idHexadecimal node ID string (e.g. "123ABC").

Definition at line 34 of file platform_cover_vent_button.h.

◆ set_parent()

void esphome::home_io_control::IOHomeCoverVentButton::set_parent ( IOHomeControlComponent * parent)
inline

Set the parent controller component.

Parameters
parentPointer to the IOHomeControlComponent instance.

Definition at line 30 of file platform_cover_vent_button.h.

◆ setup()

void esphome::home_io_control::IOHomeCoverVentButton::setup ( )
inlineoverride

Initialize the generated button.

Definition at line 37 of file platform_cover_vent_button.h.

Member Data Documentation

◆ device_id_

std::string esphome::home_io_control::IOHomeCoverVentButton::device_id_
protected

Definition at line 51 of file platform_cover_vent_button.h.

◆ parent_

IOHomeControlComponent* esphome::home_io_control::IOHomeCoverVentButton::parent_ {nullptr}
protected

Definition at line 50 of file platform_cover_vent_button.h.


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