ESPHome  2022.11.3
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

Public Member Functions

 ApplianceBase ()
 
void set_transmitter (RemoteTransmitterBase *transmitter)
 
void set_uart_parent (uart::UARTComponent *parent)
 
void set_period (uint32_t ms)
 
void set_response_timeout (uint32_t ms)
 
void set_request_attempts (uint32_t attempts)
 
void setup () override
 
void loop () override
 
float get_setup_priority () const override
 
bool can_proceed () override
 
void set_beeper_feedback (bool state)
 
void set_autoconf (bool value)
 
virtual void on_status_change ()=0
 
- 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...
 

Protected Attributes

base_
 
UARTStream stream_
 
IrTransmitter transmitter_
 
- 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::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()> &&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()> &&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

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

Definition at line 53 of file appliance_base.h.

Constructor & Destructor Documentation

◆ ApplianceBase()

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

Definition at line 58 of file appliance_base.h.

Member Function Documentation

◆ can_proceed()

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

Reimplemented from esphome::Component.

Definition at line 83 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 82 of file appliance_base.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 81 of file appliance_base.h.

◆ on_status_change()

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

◆ set_autoconf()

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

Definition at line 88 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 87 of file appliance_base.h.

◆ set_period()

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

Definition at line 74 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 76 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 75 of file appliance_base.h.

◆ set_transmitter()

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

Definition at line 68 of file appliance_base.h.

◆ set_uart_parent()

template<typename T>
void esphome::midea::ApplianceBase< T >::set_uart_parent ( uart::UARTComponent parent)
inline

Definition at line 73 of file appliance_base.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 80 of file appliance_base.h.

Field Documentation

◆ base_

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

Definition at line 92 of file appliance_base.h.

◆ stream_

template<typename T>
UARTStream esphome::midea::ApplianceBase< T >::stream_
protected

Definition at line 93 of file appliance_base.h.

◆ transmitter_

template<typename T>
IrTransmitter esphome::midea::ApplianceBase< T >::transmitter_
protected

Definition at line 95 of file appliance_base.h.


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