ESPHome  2021.9.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tuya::TuyaClimate Class Reference

#include <tuya_climate.h>

Inheritance diagram for esphome::tuya::TuyaClimate:
esphome::climate::Climate esphome::Component esphome::Nameable

Public Member Functions

void setup () override
 
void dump_config () override
 
void set_supports_heat (bool supports_heat)
 
void set_supports_cool (bool supports_cool)
 
void set_switch_id (uint8_t switch_id)
 
void set_active_state_id (uint8_t state_id)
 
void set_active_state_heating_value (uint8_t value)
 
void set_active_state_cooling_value (uint8_t value)
 
void set_target_temperature_id (uint8_t target_temperature_id)
 
void set_current_temperature_id (uint8_t current_temperature_id)
 
void set_current_temperature_multiplier (float temperature_multiplier)
 
void set_target_temperature_multiplier (float temperature_multiplier)
 
void set_tuya_parent (Tuya *parent)
 
- Public Member Functions inherited from esphome::climate::Climate
 Climate ()
 Construct a climate device with empty name (will be set later). More...
 
 Climate (const std::string &name)
 Construct a climate device with a name. More...
 
 ESPDEPRECATED ("away is deprecated, use preset instead", "v1.20") bool away
 Whether the climate device is in away mode. More...
 
void add_on_state_callback (std::function< void()> &&callback)
 Add a callback for the climate device state, each time the state of the climate device is updated (using publish_state), this callback will be called. More...
 
ClimateCall make_call ()
 Make a climate device control call, this is used to control the climate device, see the ClimateCall description for more info. More...
 
void publish_state ()
 Publish the state of the climate device, to be called from integrations. More...
 
ClimateTraits get_traits ()
 Get the traits of this climate device with all overrides applied. More...
 
void set_visual_min_temperature_override (float visual_min_temperature_override)
 
void set_visual_max_temperature_override (float visual_max_temperature_override)
 
void set_visual_temperature_step_override (float visual_temperature_step_override)
 
- Public Member Functions inherited from esphome::Nameable
 Nameable ()
 
 Nameable (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_object_id ()
 Get the sanitized name of this nameable as an ID. Caching it internally. More...
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 Check if this object is declared to be disabled by default. More...
 
void set_disabled_by_default (bool disabled_by_default)
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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...
 

Protected Member Functions

void control (const climate::ClimateCall &call) override
 Override control to change settings of the climate device. More...
 
climate::ClimateTraits traits () override
 Return the traits of this controller. More...
 
void compute_state_ ()
 Re-compute the state of this climate controller. More...
 
void switch_to_action_ (climate::ClimateAction action)
 Switch the climate device to the given climate mode. More...
 
- Protected Member Functions inherited from esphome::climate::Climate
bool set_fan_mode_ (ClimateFanMode mode)
 Set fan mode. Reset custom fan mode. Return true if fan mode has been changed. More...
 
bool set_custom_fan_mode_ (const std::string &mode)
 Set custom fan mode. Reset primary fan mode. Return true if fan mode has been changed. More...
 
bool set_preset_ (ClimatePreset preset)
 Set preset. Reset custom preset. Return true if preset has been changed. More...
 
bool set_custom_preset_ (const std::string &preset)
 Set custom preset. Reset primary preset. Return true if preset has been changed. More...
 
optional< ClimateDeviceRestoreStaterestore_state_ ()
 Restore the state of the climate device, call this from your setup() method. More...
 
void save_state_ ()
 Internal method to save the state of the climate device to recover memory. More...
 
uint32_t hash_base () override
 
void dump_traits_ (const char *tag)
 
- Protected Member Functions inherited from esphome::Nameable
void calc_object_id_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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...
 

Protected Attributes

Tuyaparent_
 
bool supports_heat_
 
bool supports_cool_
 
optional< uint8_t > switch_id_ {}
 
optional< uint8_t > active_state_id_ {}
 
optional< uint8_t > active_state_heating_value_ {}
 
optional< uint8_t > active_state_cooling_value_ {}
 
optional< uint8_t > target_temperature_id_ {}
 
optional< uint8_t > current_temperature_id_ {}
 
float current_temperature_multiplier_ {1.0f}
 
float target_temperature_multiplier_ {1.0f}
 
float hysteresis_ {1.0f}
 
uint8_t active_state_
 
- Protected Attributes inherited from esphome::climate::Climate
friend ClimateCall
 
CallbackManager< void()> state_callback_ {}
 
ESPPreferenceObject rtc_
 
optional< float > visual_min_temperature_override_ {}
 
optional< float > visual_max_temperature_override_ {}
 
optional< float > visual_temperature_step_override_ {}
 
- Protected Attributes inherited from esphome::Nameable
std::string name_
 
std::string object_id_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
- 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

- Data Fields inherited from esphome::climate::Climate
ClimateMode mode {CLIMATE_MODE_OFF}
 The active mode of the climate device. More...
 
ClimateAction action {CLIMATE_ACTION_OFF}
 The active state of the climate device. More...
 
float current_temperature {NAN}
 The current temperature of the climate device, as reported from the integration. More...
 
union {
   float   target_temperature
 The target temperature of the climate device. More...
 
   struct {
      float   target_temperature_low
 The minimum target temperature of the climate device, for climate devices with split target temperature. More...
 
      float   target_temperature_high
 The maximum target temperature of the climate device, for climate devices with split target temperature. More...
 
   } 
 
}; 
 
optional< ClimateFanModefan_mode
 The active fan mode of the climate device. More...
 
ClimateSwingMode swing_mode
 The active swing mode of the climate device. More...
 
optional< std::string > custom_fan_mode
 The active custom fan mode of the climate device. More...
 
optional< ClimatePresetpreset
 The active preset of the climate device. More...
 
optional< std::string > custom_preset
 The active custom preset mode of the climate device. More...
 

Detailed Description

Definition at line 10 of file tuya_climate.h.

Member Function Documentation

◆ compute_state_()

void esphome::tuya::TuyaClimate::compute_state_ ( )
protected

Re-compute the state of this climate controller.

Definition at line 91 of file tuya_climate.cpp.

◆ control()

void esphome::tuya::TuyaClimate::control ( const climate::ClimateCall call)
overrideprotectedvirtual

Override control to change settings of the climate device.

Implements esphome::climate::Climate.

Definition at line 53 of file tuya_climate.cpp.

◆ dump_config()

void esphome::tuya::TuyaClimate::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 79 of file tuya_climate.cpp.

◆ set_active_state_cooling_value()

void esphome::tuya::TuyaClimate::set_active_state_cooling_value ( uint8_t  value)
inline

Definition at line 19 of file tuya_climate.h.

◆ set_active_state_heating_value()

void esphome::tuya::TuyaClimate::set_active_state_heating_value ( uint8_t  value)
inline

Definition at line 18 of file tuya_climate.h.

◆ set_active_state_id()

void esphome::tuya::TuyaClimate::set_active_state_id ( uint8_t  state_id)
inline

Definition at line 17 of file tuya_climate.h.

◆ set_current_temperature_id()

void esphome::tuya::TuyaClimate::set_current_temperature_id ( uint8_t  current_temperature_id)
inline

Definition at line 23 of file tuya_climate.h.

◆ set_current_temperature_multiplier()

void esphome::tuya::TuyaClimate::set_current_temperature_multiplier ( float  temperature_multiplier)
inline

Definition at line 26 of file tuya_climate.h.

◆ set_supports_cool()

void esphome::tuya::TuyaClimate::set_supports_cool ( bool  supports_cool)
inline

Definition at line 15 of file tuya_climate.h.

◆ set_supports_heat()

void esphome::tuya::TuyaClimate::set_supports_heat ( bool  supports_heat)
inline

Definition at line 14 of file tuya_climate.h.

◆ set_switch_id()

void esphome::tuya::TuyaClimate::set_switch_id ( uint8_t  switch_id)
inline

Definition at line 16 of file tuya_climate.h.

◆ set_target_temperature_id()

void esphome::tuya::TuyaClimate::set_target_temperature_id ( uint8_t  target_temperature_id)
inline

Definition at line 20 of file tuya_climate.h.

◆ set_target_temperature_multiplier()

void esphome::tuya::TuyaClimate::set_target_temperature_multiplier ( float  temperature_multiplier)
inline

Definition at line 29 of file tuya_climate.h.

◆ set_tuya_parent()

void esphome::tuya::TuyaClimate::set_tuya_parent ( Tuya parent)
inline

Definition at line 33 of file tuya_climate.h.

◆ setup()

void esphome::tuya::TuyaClimate::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file tuya_climate.cpp.

◆ switch_to_action_()

void esphome::tuya::TuyaClimate::switch_to_action_ ( climate::ClimateAction  action)
protected

Switch the climate device to the given climate mode.

Definition at line 127 of file tuya_climate.cpp.

◆ traits()

climate::ClimateTraits esphome::tuya::TuyaClimate::traits ( )
overrideprotectedvirtual

Return the traits of this controller.

Implements esphome::climate::Climate.

Definition at line 68 of file tuya_climate.cpp.

Field Documentation

◆ active_state_

uint8_t esphome::tuya::TuyaClimate::active_state_
protected

Definition at line 59 of file tuya_climate.h.

◆ active_state_cooling_value_

optional<uint8_t> esphome::tuya::TuyaClimate::active_state_cooling_value_ {}
protected

Definition at line 53 of file tuya_climate.h.

◆ active_state_heating_value_

optional<uint8_t> esphome::tuya::TuyaClimate::active_state_heating_value_ {}
protected

Definition at line 52 of file tuya_climate.h.

◆ active_state_id_

optional<uint8_t> esphome::tuya::TuyaClimate::active_state_id_ {}
protected

Definition at line 51 of file tuya_climate.h.

◆ current_temperature_id_

optional<uint8_t> esphome::tuya::TuyaClimate::current_temperature_id_ {}
protected

Definition at line 55 of file tuya_climate.h.

◆ current_temperature_multiplier_

float esphome::tuya::TuyaClimate::current_temperature_multiplier_ {1.0f}
protected

Definition at line 56 of file tuya_climate.h.

◆ hysteresis_

float esphome::tuya::TuyaClimate::hysteresis_ {1.0f}
protected

Definition at line 58 of file tuya_climate.h.

◆ parent_

Tuya* esphome::tuya::TuyaClimate::parent_
protected

Definition at line 47 of file tuya_climate.h.

◆ supports_cool_

bool esphome::tuya::TuyaClimate::supports_cool_
protected

Definition at line 49 of file tuya_climate.h.

◆ supports_heat_

bool esphome::tuya::TuyaClimate::supports_heat_
protected

Definition at line 48 of file tuya_climate.h.

◆ switch_id_

optional<uint8_t> esphome::tuya::TuyaClimate::switch_id_ {}
protected

Definition at line 50 of file tuya_climate.h.

◆ target_temperature_id_

optional<uint8_t> esphome::tuya::TuyaClimate::target_temperature_id_ {}
protected

Definition at line 54 of file tuya_climate.h.

◆ target_temperature_multiplier_

float esphome::tuya::TuyaClimate::target_temperature_multiplier_ {1.0f}
protected

Definition at line 57 of file tuya_climate.h.


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