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

Binary sensor that reports whether the window currently limits its own opening for rain. More...

#include <platform_cover_controls.h>

Inheritance diagram for esphome::home_io_control::IOHomeRainBinarySensor:
Collaboration diagram for esphome::home_io_control::IOHomeRainBinarySensor:

Public Member Functions

void setup () override
 Subscribe to the device's updates and publish what is already known.
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.

Protected Member Functions

void publish_rain_state_ (RainSensorState state)
 Publish a rain state: true for RAIN, false for DRY, no state for UNKNOWN.
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.

Additional Inherited Members

Protected Attributes inherited from esphome::home_io_control::DeviceBoundCompanion
IOHomeControlComponent * parent_ {nullptr}
std::string device_id_

Detailed Description

Binary sensor that reports whether the window currently limits its own opening for rain.

ON when the device's minimum limitation read at least the rain threshold, OFF when it read below it. Only generated when the cover declares rain_sensor_poll_interval:, which is also what schedules the poll that feeds it. It has no state until the first answered poll, and loses it again after several unanswered polls: "off" always means a device said so. Independent of the Active Issue sensor, which reports what the last move or a clamped command implied.

Definition at line 99 of file platform_cover_controls.h.

Member Function Documentation

◆ dump_config()

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

Dump sensor configuration to the log.

Definition at line 82 of file platform_cover_controls.cpp.

◆ get_setup_priority()

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

Get setup priority so the parent hub is available first.

Returns
setup_priority::DATA.

Definition at line 109 of file platform_cover_controls.h.

◆ publish_rain_state_()

void esphome::home_io_control::IOHomeRainBinarySensor::publish_rain_state_ ( RainSensorState state)
protected

Publish a rain state: true for RAIN, false for DRY, no state for UNKNOWN.

Definition at line 67 of file platform_cover_controls.cpp.

◆ setup()

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

Subscribe to the device's updates and publish what is already known.

Definition at line 63 of file platform_cover_controls.cpp.

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