esphome::home_io_control::IOHomeExchangeFailuresSensor Class Reference

Diagnostic sensor that publishes a device's cumulative count of outbound exchanges that timed out (no valid response) — see detail::record_exchange_timeout() in hub_internal.h. More...

#include <platform_exchange_failures_sensor.h>

Inheritance diagram for esphome::home_io_control::IOHomeExchangeFailuresSensor:

Collaboration diagram for esphome::home_io_control::IOHomeExchangeFailuresSensor:

Public Member Functions
void	setup () override
	Register the device-update subscription and publish the initial cached state.
void	dump_config () override
	Dump 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
IOHomeControlComponent *	parent_ {nullptr}
std::string	device_id_

Detailed Description

Diagnostic sensor that publishes a device's cumulative count of outbound exchanges that timed out (no valid response) — see detail::record_exchange_timeout() in hub_internal.h.

Unlike the RSSI and Last Contact sensors, zero is a meaningful value here (no failures yet), so this publishes on setup unconditionally.

Definition at line 21 of file platform_exchange_failures_sensor.h.

Member Function Documentation

dump_config()

void esphome::home_io_control::IOHomeExchangeFailuresSensor::dump_config ( )

override

Dump sensor configuration to the log.

Definition at line 19 of file platform_exchange_failures_sensor.cpp.

get_setup_priority()

float esphome::home_io_control::IOHomeExchangeFailuresSensor::get_setup_priority ( ) const

inlinenodiscardoverride

Get setup priority so the parent hub is available first.

Returns

setup_priority::DATA.

Definition at line 31 of file platform_exchange_failures_sensor.h.

setup()

void esphome::home_io_control::IOHomeExchangeFailuresSensor::setup ( )

override

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

Definition at line 14 of file platform_exchange_failures_sensor.cpp.

Here is the call graph for this function:

---

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

• components/home_io_control/platform_exchange_failures_sensor.h
• components/home_io_control/platform_exchange_failures_sensor.cpp