ESPHome  2024.12.2
Public Member Functions | Data Fields | Protected Attributes
esphome::opentherm::OpenthermOutput Class Reference

#include <output.h>

Inheritance diagram for esphome::opentherm::OpenthermOutput:
esphome::output::FloatOutput esphome::Component esphome::opentherm::OpenthermInput esphome::output::BinaryOutput

Public Member Functions

void set_id (const char *id)
 
void write_state (float state) override
 
bool has_state ()
 
void set_min_value (float min_value) override
 
void set_max_value (float max_value) override
 
float get_min_value ()
 
float get_max_value ()
 
- Public Member Functions inherited from esphome::output::FloatOutput
void set_max_power (float max_power)
 Set the maximum power output of this component. More...
 
void set_min_power (float min_power)
 Set the minimum power output of this component. More...
 
void set_zero_means_zero (bool zero_means_zero)
 Sets this output to ignore min_power for a 0 state. More...
 
void set_level (float state)
 Set the level of this float output, this is called from the front-end. More...
 
virtual void update_frequency (float frequency)
 Set the frequency of the output for PWM outputs. More...
 
float get_max_power () const
 Get the maximum power output. More...
 
float get_min_power () const
 Get the minimum power output. More...
 
- Public Member Functions inherited from esphome::output::BinaryOutput
void set_inverted (bool inverted)
 Set the inversion state of this binary output. More...
 
void set_power_supply (power_supply::PowerSupply *power_supply)
 Use this to connect up a power supply to this output. More...
 
virtual void set_state (bool state)
 Enable or disable this binary output. More...
 
virtual void turn_on ()
 Enable this binary output. More...
 
virtual void turn_off ()
 Disable this binary output. More...
 
bool is_inverted () const
 Return whether this binary output is inverted. More...
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::opentherm::OpenthermInput
virtual void set_auto_min_value (bool auto_min_value)
 
virtual void set_auto_max_value (bool auto_max_value)
 

Data Fields

float state
 
- Data Fields inherited from esphome::opentherm::OpenthermInput
bool auto_min_value
 
bool auto_max_value
 

Protected Attributes

bool has_state_ = false
 
const char * id_ = nullptr
 
float min_value_
 
float max_value_
 
- Protected Attributes inherited from esphome::output::FloatOutput
float max_power_ {1.0f}
 
float min_power_ {0.0f}
 
bool zero_means_zero_
 
- Protected Attributes inherited from esphome::output::BinaryOutput
bool inverted_ {false}
 
power_supply::PowerSupplyRequester power_ {}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::output::FloatOutput
void write_state (bool state) override
 Implement BinarySensor's write_enabled; this should never be called. More...
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Detailed Description

Definition at line 10 of file output.h.

Member Function Documentation

◆ get_max_value()

float esphome::opentherm::OpenthermOutput::get_max_value ( )
inline

Definition at line 29 of file output.h.

◆ get_min_value()

float esphome::opentherm::OpenthermOutput::get_min_value ( )
inline

Definition at line 28 of file output.h.

◆ has_state()

bool esphome::opentherm::OpenthermOutput::has_state ( )
inline

Definition at line 24 of file output.h.

◆ set_id()

void esphome::opentherm::OpenthermOutput::set_id ( const char *  id)
inline

Definition at line 20 of file output.h.

◆ set_max_value()

void esphome::opentherm::OpenthermOutput::set_max_value ( float  max_value)
inlineoverridevirtual

Implements esphome::opentherm::OpenthermInput.

Definition at line 27 of file output.h.

◆ set_min_value()

void esphome::opentherm::OpenthermOutput::set_min_value ( float  min_value)
inlineoverridevirtual

Implements esphome::opentherm::OpenthermInput.

Definition at line 26 of file output.h.

◆ write_state()

void esphome::opentherm::OpenthermOutput::write_state ( float  state)
overridevirtual

Implements esphome::output::FloatOutput.

Definition at line 9 of file output.cpp.

Field Documentation

◆ has_state_

bool esphome::opentherm::OpenthermOutput::has_state_ = false
protected

Definition at line 12 of file output.h.

◆ id_

const char* esphome::opentherm::OpenthermOutput::id_ = nullptr
protected

Definition at line 13 of file output.h.

◆ max_value_

float esphome::opentherm::OpenthermOutput::max_value_
protected

Definition at line 15 of file output.h.

◆ min_value_

float esphome::opentherm::OpenthermOutput::min_value_
protected

Definition at line 15 of file output.h.

◆ state

float esphome::opentherm::OpenthermOutput::state

Definition at line 18 of file output.h.


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