Home IO Control
ESPHome add-on for IO-Homecontrol devices
Loading...
Searching...
No Matches
esphome::home_io_control::IOHomePairingResultTextSensor Class Reference
Architecture Layers » ESPHome Integration Layer » Runtime Entities

Diagnostic text sensor that publishes PairingTelemetry::result_sensor_string() after every pairing attempt. More...

#include <platform_hub_controls.h>

Inheritance diagram for esphome::home_io_control::IOHomePairingResultTextSensor:
Collaboration diagram for esphome::home_io_control::IOHomePairingResultTextSensor:

Public Member Functions

void setup () override
 Register the pairing-result callback.
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::HubBoundEntity
void set_parent (IOHomeControlComponent *parent)
 Set the parent controller component.

Protected Member Functions

void on_pairing_result_ ()
 Publish the latest pairing telemetry result string.

Additional Inherited Members

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

Detailed Description

Diagnostic text sensor that publishes PairingTelemetry::result_sensor_string() after every pairing attempt.

The published string is the frozen v1;... format documented on PairingTelemetry::result_sensor_string() — the Phase 2 automated-rig read-back contract. Nothing is published before the first pairing attempt of this boot.

Definition at line 152 of file platform_hub_controls.h.

Member Function Documentation

◆ dump_config()

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

Dump text-sensor configuration to the log.

Definition at line 48 of file platform_hub_controls.cpp.

◆ get_setup_priority()

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

Get setup priority so the parent hub is available first.

Returns
setup_priority::DATA.

Definition at line 162 of file platform_hub_controls.h.

◆ on_pairing_result_()

void esphome::home_io_control::IOHomePairingResultTextSensor::on_pairing_result_ ( )
protected

Publish the latest pairing telemetry result string.

Definition at line 55 of file platform_hub_controls.cpp.

◆ setup()

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

Register the pairing-result callback.

Definition at line 41 of file platform_hub_controls.cpp.

Here is the call graph for this function:
The documentation for this class was generated from the following files: