#include <appliance_base.h>

Inheritance diagram for esphome::midea::ApplianceBase< T >:

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().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

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.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Attributes
T	base_

UARTStream	stream_

IrTransmitter	transmitter_

Protected Attributes inherited from esphome::Component
const char *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free)

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

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.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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.

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.

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name.

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

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

Implemented in esphome::midea::ac::AirConditioner.

◆ 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:

esphome/components/midea/appliance_base.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ApplianceBase()

Member Function Documentation

◆ can_proceed()

◆ get_setup_priority()

◆ loop()

◆ on_status_change()

◆ set_autoconf()

◆ set_beeper_feedback()

◆ set_period()

◆ set_request_attempts()

◆ set_response_timeout()

◆ set_transmitter()

◆ set_uart_parent()

◆ setup()

Field Documentation

◆ base_

◆ stream_

◆ transmitter_