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

Diagnostic text sensor that publishes the symbolic name of a device's most recent CMD_ERROR_RESP result code (e.g. More...

#include <platform_active_issue_text_sensor.h>

Inheritance diagram for esphome::home_io_control::IOHomeActiveIssueTextSensor:
Collaboration diagram for esphome::home_io_control::IOHomeActiveIssueTextSensor:

Public Member Functions

void setup () override
 Register the device-update subscription and publish the initial cached state.
void dump_config () override
 Dump text-sensor configuration to the log.
float get_setup_priority () const override
 Get setup priority so the parent hub is available first.
Public Member Functions inherited from esphome::home_io_control::DeviceBoundCompanion
void set_parent (IOHomeControlComponent *parent)
 Set the parent controller component.
void set_device_id (const std::string &id)
 Set the device ID whose state this companion sensor exposes.

Additional Inherited Members

Protected Member Functions inherited from esphome::home_io_control::DeviceBoundCompanion
void register_companion_binding_ (const std::function< void(const IoDevice &)> &publish)
 Shared setup() body: subscribe to this device's updates and publish the initial state.
Protected Attributes inherited from esphome::home_io_control::DeviceBoundCompanion
IOHomeControlComponentparent_ {nullptr}
std::string device_id_

Detailed Description

Diagnostic text sensor that publishes the symbolic name of a device's most recent CMD_ERROR_RESP result code (e.g.

"LIMITATION_BY_RAIN"), letting a "nothing happened" command self-explain instead of only showing up in the log. Shared by every device-bound platform (cover, light, switch, lock) via platform_common.py's companion-sensor codegen.

Not a per-operation outcome — it does not get set on every command, only on an explicit CMD_ERROR_RESP. Publishes an empty string until the first one is seen, and again after any subsequent successful status/command reply clears it (see detail::clear_command_result()), so a non-empty value always means "this is still going on" rather than "this is what happened last."

Definition at line 25 of file platform_active_issue_text_sensor.h.

Member Function Documentation

◆ dump_config()

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

Dump text-sensor configuration to the log.

Definition at line 22 of file platform_active_issue_text_sensor.cpp.

◆ get_setup_priority()

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

Get setup priority so the parent hub is available first.

Returns
setup_priority::DATA.

Definition at line 35 of file platform_active_issue_text_sensor.h.

◆ setup()

void esphome::home_io_control::IOHomeActiveIssueTextSensor::setup ( )
override

Register the device-update subscription and publish the initial cached state.

Definition at line 15 of file platform_active_issue_text_sensor.cpp.

Here is the call graph for this function:

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