ESPHome  2021.10.2
Public Member Functions | Protected Attributes
esphome::midea::ApplianceBase< T > Class Template Referenceabstract

#include <appliance_base.h>

Inheritance diagram for esphome::midea::ApplianceBase< T >:
esphome::Component esphome::uart::UARTDevice esphome::climate::Climate esphome::EntityBase

Public Member Functions

 ApplianceBase ()
 
bool can_proceed () override
 
float get_setup_priority () const override
 
void setup () override
 
void loop () override
 
void set_period (uint32_t ms)
 
void set_response_timeout (uint32_t ms)
 
void set_request_attempts (uint32_t attempts)
 
void set_beeper_feedback (bool state)
 
void set_autoconf (bool value)
 
void set_supported_modes (const std::set< ClimateMode > &modes)
 
void set_supported_swing_modes (const std::set< ClimateSwingMode > &modes)
 
void set_supported_presets (const std::set< ClimatePreset > &presets)
 
void set_custom_presets (const std::set< std::string > &presets)
 
void set_custom_fan_modes (const std::set< std::string > &modes)
 
virtual void on_status_change ()=0
 
void set_transmitter (remote_transmitter::RemoteTransmitterComponent *transmitter)
 
void transmit_ir (remote_base::MideaData &data)
 
int available () override
 
int read () override
 
int peek () override
 
void flush () override
 
size_t write (uint8_t data) override
 
- Public Member Functions inherited from esphome::Component
virtual void dump_config ()
 
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 ()
 
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...
 
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 
- 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)
 

Protected Attributes

base_
 
std::set< ClimateMode > supported_modes_ {}
 
std::set< ClimateSwingMode > supported_swing_modes_ {}
 
std::set< ClimatePreset > supported_presets_ {}
 
std::set< std::string > supported_custom_presets_ {}
 
std::set< std::string > supported_custom_fan_modes_ {}
 
remote_transmitter::RemoteTransmitterComponenttransmitter_ {nullptr}
 
- 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
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {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}
 

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...
 
- 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 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...
 
virtual ClimateTraits traits ()=0
 Get the default traits of this climate device. More...
 
virtual void control (const ClimateCall &call)=0
 Control the climate device, this is a virtual method that each climate integration must implement. 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_ ()
 

Detailed Description

template<typename T>
class esphome::midea::ApplianceBase< T >

Definition at line 26 of file appliance_base.h.

Constructor & Destructor Documentation

◆ ApplianceBase()

template<typename T>
esphome::midea::ApplianceBase< T >::ApplianceBase ( )
inline

Definition at line 31 of file appliance_base.h.

Member Function Documentation

◆ available()

template<typename T>
int esphome::midea::ApplianceBase< T >::available ( )
inlineoverride

Definition at line 68 of file appliance_base.h.

◆ can_proceed()

template<typename T>
bool esphome::midea::ApplianceBase< T >::can_proceed ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 39 of file appliance_base.h.

◆ flush()

template<typename T>
void esphome::midea::ApplianceBase< T >::flush ( )
inlineoverride

Definition at line 71 of file appliance_base.h.

◆ get_setup_priority()

template<typename T>
float esphome::midea::ApplianceBase< T >::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file appliance_base.h.

◆ loop()

template<typename T>
void esphome::midea::ApplianceBase< T >::loop ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file appliance_base.h.

◆ on_status_change()

template<typename T>
virtual void esphome::midea::ApplianceBase< T >::on_status_change ( )
pure virtual

◆ peek()

template<typename T>
int esphome::midea::ApplianceBase< T >::peek ( )
inlineoverride

Definition at line 70 of file appliance_base.h.

◆ read()

template<typename T>
int esphome::midea::ApplianceBase< T >::read ( )
inlineoverride

Definition at line 69 of file appliance_base.h.

◆ set_autoconf()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_autoconf ( bool  value)
inline

Definition at line 49 of file appliance_base.h.

◆ set_beeper_feedback()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_beeper_feedback ( bool  state)
inline

Definition at line 48 of file appliance_base.h.

◆ set_custom_fan_modes()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_custom_fan_modes ( const std::set< std::string > &  modes)
inline

Definition at line 54 of file appliance_base.h.

◆ set_custom_presets()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_custom_presets ( const std::set< std::string > &  presets)
inline

Definition at line 53 of file appliance_base.h.

◆ set_period()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_period ( uint32_t  ms)
inline

Definition at line 45 of file appliance_base.h.

◆ set_request_attempts()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_request_attempts ( uint32_t  attempts)
inline

Definition at line 47 of file appliance_base.h.

◆ set_response_timeout()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_response_timeout ( uint32_t  ms)
inline

Definition at line 46 of file appliance_base.h.

◆ set_supported_modes()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_supported_modes ( const std::set< ClimateMode > &  modes)
inline

Definition at line 50 of file appliance_base.h.

◆ set_supported_presets()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_supported_presets ( const std::set< ClimatePreset > &  presets)
inline

Definition at line 52 of file appliance_base.h.

◆ set_supported_swing_modes()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_supported_swing_modes ( const std::set< ClimateSwingMode > &  modes)
inline

Definition at line 51 of file appliance_base.h.

◆ set_transmitter()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_transmitter ( remote_transmitter::RemoteTransmitterComponent transmitter)
inline

Definition at line 57 of file appliance_base.h.

◆ setup()

template<typename T>
void esphome::midea::ApplianceBase< T >::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 43 of file appliance_base.h.

◆ transmit_ir()

template<typename T>
void esphome::midea::ApplianceBase< T >::transmit_ir ( remote_base::MideaData data)
inline

Definition at line 60 of file appliance_base.h.

◆ write()

template<typename T>
size_t esphome::midea::ApplianceBase< T >::write ( uint8_t  data)
inlineoverride

Definition at line 72 of file appliance_base.h.

Field Documentation

◆ base_

template<typename T>
T esphome::midea::ApplianceBase< T >::base_
protected

Definition at line 75 of file appliance_base.h.

◆ supported_custom_fan_modes_

template<typename T>
std::set<std::string> esphome::midea::ApplianceBase< T >::supported_custom_fan_modes_ {}
protected

Definition at line 80 of file appliance_base.h.

◆ supported_custom_presets_

template<typename T>
std::set<std::string> esphome::midea::ApplianceBase< T >::supported_custom_presets_ {}
protected

Definition at line 79 of file appliance_base.h.

◆ supported_modes_

template<typename T>
std::set<ClimateMode> esphome::midea::ApplianceBase< T >::supported_modes_ {}
protected

Definition at line 76 of file appliance_base.h.

◆ supported_presets_

template<typename T>
std::set<ClimatePreset> esphome::midea::ApplianceBase< T >::supported_presets_ {}
protected

Definition at line 78 of file appliance_base.h.

◆ supported_swing_modes_

template<typename T>
std::set<ClimateSwingMode> esphome::midea::ApplianceBase< T >::supported_swing_modes_ {}
protected

Definition at line 77 of file appliance_base.h.

◆ transmitter_

template<typename T>
remote_transmitter::RemoteTransmitterComponent* esphome::midea::ApplianceBase< T >::transmitter_ {nullptr}
protected

Definition at line 82 of file appliance_base.h.


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