ESPHome  2021.10.2
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::whirlpool::WhirlpoolClimate Class Reference

#include <whirlpool.h>

Inheritance diagram for esphome::whirlpool::WhirlpoolClimate:
esphome::climate_ir::ClimateIR esphome::climate::Climate esphome::Component esphome::remote_base::RemoteReceiverListener esphome::EntityBase

Public Member Functions

 WhirlpoolClimate ()
 
void setup () override
 
void control (const climate::ClimateCall &call) override
 Override control to change settings of the climate device. More...
 
void set_model (Model model)
 
- Public Member Functions inherited from esphome::climate_ir::ClimateIR
 ClimateIR (float minimum_temperature, float maximum_temperature, float temperature_step=1.0f, bool supports_dry=false, bool supports_fan_only=false, std::set< climate::ClimateFanMode > fan_modes={}, std::set< climate::ClimateSwingMode > swing_modes={})
 
void dump_config () override
 
void set_transmitter (remote_transmitter::RemoteTransmitterComponent *transmitter)
 
void set_supports_cool (bool supports_cool)
 
void set_supports_heat (bool supports_heat)
 
void set_sensor (sensor::Sensor *sensor)
 
- 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::EntityBase
 EntityBase ()
 
 EntityBase (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_object_id ()
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
const std::string & get_icon () const
 
void set_icon (const std::string &name)
 
- 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...
 

Data Fields

bool powered_on_assumed
 
- 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...
 

Protected Member Functions

void transmit_state () override
 Transmit via IR the state of this climate controller. More...
 
bool on_receive (remote_base::RemoteReceiveData data) override
 Handle received IR Buffer. More...
 
float temperature_min_ ()
 
float temperature_max_ ()
 
- Protected Member Functions inherited from esphome::climate_ir::ClimateIR
climate::ClimateTraits traits () override
 Return the traits of this controller. 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::EntityBase
void calc_object_id_ ()
 
- 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_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

bool send_swing_cmd_ {false}
 
Model model_
 
- Protected Attributes inherited from esphome::climate_ir::ClimateIR
float minimum_temperature_
 
float maximum_temperature_
 
float temperature_step_
 
bool supports_cool_ {true}
 
bool supports_heat_ {true}
 
bool supports_dry_ {false}
 
bool supports_fan_only_ {false}
 
std::set< climate::ClimateFanModefan_modes_ = {}
 
std::set< climate::ClimateSwingModeswing_modes_ = {}
 
remote_transmitter::RemoteTransmitterComponenttransmitter_
 
sensor::Sensorsensor_ {nullptr}
 
- 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::EntityBase
std::string name_
 
std::string object_id_
 
std::string icon_
 
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
 

Detailed Description

Definition at line 20 of file whirlpool.h.

Constructor & Destructor Documentation

◆ WhirlpoolClimate()

esphome::whirlpool::WhirlpoolClimate::WhirlpoolClimate ( )
inline

Definition at line 22 of file whirlpool.h.

Member Function Documentation

◆ control()

void esphome::whirlpool::WhirlpoolClimate::control ( const climate::ClimateCall call)
inlineoverridevirtual

Override control to change settings of the climate device.

Reimplemented from esphome::climate_ir::ClimateIR.

Definition at line 35 of file whirlpool.h.

◆ on_receive()

bool esphome::whirlpool::WhirlpoolClimate::on_receive ( remote_base::RemoteReceiveData  data)
overrideprotectedvirtual

Handle received IR Buffer.

Reimplemented from esphome::climate_ir::ClimateIR.

Definition at line 151 of file whirlpool.cpp.

◆ set_model()

void esphome::whirlpool::WhirlpoolClimate::set_model ( Model  model)
inline

Definition at line 40 of file whirlpool.h.

◆ setup()

void esphome::whirlpool::WhirlpoolClimate::setup ( )
inlineoverridevirtual

Reimplemented from esphome::climate_ir::ClimateIR.

Definition at line 28 of file whirlpool.h.

◆ temperature_max_()

float esphome::whirlpool::WhirlpoolClimate::temperature_max_ ( )
inlineprotected

Definition at line 57 of file whirlpool.h.

◆ temperature_min_()

float esphome::whirlpool::WhirlpoolClimate::temperature_min_ ( )
inlineprotected

Definition at line 54 of file whirlpool.h.

◆ transmit_state()

void esphome::whirlpool::WhirlpoolClimate::transmit_state ( )
overrideprotectedvirtual

Transmit via IR the state of this climate controller.

Implements esphome::climate_ir::ClimateIR.

Definition at line 35 of file whirlpool.cpp.

Field Documentation

◆ model_

Model esphome::whirlpool::WhirlpoolClimate::model_
protected

Definition at line 52 of file whirlpool.h.

◆ powered_on_assumed

bool esphome::whirlpool::WhirlpoolClimate::powered_on_assumed

Definition at line 43 of file whirlpool.h.

◆ send_swing_cmd_

bool esphome::whirlpool::WhirlpoolClimate::send_swing_cmd_ {false}
protected

Definition at line 51 of file whirlpool.h.


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