ESPHome 2025.7.2
Loading...
Searching...
No Matches
esphome::remote_receiver::RemoteReceiverComponent Class Reference

#include <remote_receiver.h>

Inheritance diagram for esphome::remote_receiver::RemoteReceiverComponent:
esphome::remote_base::RemoteReceiverBase esphome::Component esphome::remote_base::RemoteRMTChannel esphome::remote_base::RemoteComponentBase

Public Member Functions

 RemoteReceiverComponent (InternalGPIOPin *pin)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
void set_filter_symbols (uint32_t filter_symbols)
 
void set_receive_symbols (uint32_t receive_symbols)
 
void set_with_dma (bool with_dma)
 
void set_buffer_size (uint32_t buffer_size)
 
void set_filter_us (uint32_t filter_us)
 
void set_idle_us (uint32_t idle_us)
 
- Public Member Functions inherited from esphome::remote_base::RemoteReceiverBase
 RemoteReceiverBase (InternalGPIOPin *pin)
 
void register_listener (RemoteReceiverListener *listener)
 
void register_dumper (RemoteReceiverDumperBase *dumper)
 
void set_tolerance (uint32_t tolerance, ToleranceMode tolerance_mode)
 
- Public Member Functions inherited from esphome::remote_base::RemoteComponentBase
 RemoteComponentBase (InternalGPIOPin *pin)
 
- Public Member Functions inherited from esphome::Component
virtual float get_setup_priority () const
 priority of setup().
 
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
 
virtual bool can_proceed ()
 
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)
 
- Public Member Functions inherited from esphome::remote_base::RemoteRMTChannel
void set_clock_resolution (uint32_t clock_resolution)
 
void set_rmt_symbols (uint32_t rmt_symbols)
 

Protected Member Functions

void decode_rmt_ (rmt_symbol_word_t *item, size_t item_count)
 
- Protected Member Functions inherited from esphome::remote_base::RemoteReceiverBase
void call_listeners_ ()
 
void call_dumpers_ ()
 
void call_listeners_dumpers_ ()
 
- 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.
 
- Protected Member Functions inherited from esphome::remote_base::RemoteRMTChannel
uint32_t from_microseconds_ (uint32_t us)
 
uint32_t to_microseconds_ (uint32_t ticks)
 

Protected Attributes

rmt_channel_handle_t channel_ {NULL}
 
uint32_t filter_symbols_ {0}
 
uint32_t receive_symbols_ {0}
 
bool with_dma_ {false}
 
esp_err_t error_code_ {ESP_OK}
 
std::string error_string_ {""}
 
RemoteReceiverComponentStore store_
 
HighFrequencyLoopRequester high_freq_
 
uint32_t buffer_size_ {}
 
uint32_t filter_us_ {10}
 
uint32_t idle_us_ {10000}
 
- Protected Attributes inherited from esphome::remote_base::RemoteReceiverBase
std::vector< RemoteReceiverListener * > listeners_
 
std::vector< RemoteReceiverDumperBase * > dumpers_
 
std::vector< RemoteReceiverDumperBase * > secondary_dumpers_
 
RawTimings temp_
 
uint32_t tolerance_ {25}
 
ToleranceMode tolerance_mode_ {TOLERANCE_MODE_PERCENTAGE}
 
- Protected Attributes inherited from esphome::remote_base::RemoteComponentBase
InternalGPIOPinpin_
 
- 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.
 
- Protected Attributes inherited from esphome::remote_base::RemoteRMTChannel
RemoteComponentBaseremote_base_
 
uint32_t clock_resolution_ {1000000}
 
uint32_t rmt_symbols_
 

Detailed Description

Definition at line 49 of file remote_receiver.h.

Constructor & Destructor Documentation

◆ RemoteReceiverComponent()

esphome::remote_receiver::RemoteReceiverComponent::RemoteReceiverComponent ( InternalGPIOPin * pin)
inline

Definition at line 58 of file remote_receiver.h.

Member Function Documentation

◆ decode_rmt_()

void esphome::remote_receiver::RemoteReceiverComponent::decode_rmt_ ( rmt_symbol_word_t * item,
size_t item_count )
protected

Definition at line 155 of file remote_receiver_esp32.cpp.

◆ dump_config()

void esphome::remote_receiver::RemoteReceiverComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 107 of file remote_receiver_esp32.cpp.

◆ loop()

void esphome::remote_receiver::RemoteReceiverComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file remote_receiver_esp32.cpp.

◆ set_buffer_size()

void esphome::remote_receiver::RemoteReceiverComponent::set_buffer_size ( uint32_t buffer_size)
inline

Definition at line 68 of file remote_receiver.h.

◆ set_filter_symbols()

void esphome::remote_receiver::RemoteReceiverComponent::set_filter_symbols ( uint32_t filter_symbols)
inline

Definition at line 64 of file remote_receiver.h.

◆ set_filter_us()

void esphome::remote_receiver::RemoteReceiverComponent::set_filter_us ( uint32_t filter_us)
inline

Definition at line 69 of file remote_receiver.h.

◆ set_idle_us()

void esphome::remote_receiver::RemoteReceiverComponent::set_idle_us ( uint32_t idle_us)
inline

Definition at line 70 of file remote_receiver.h.

◆ set_receive_symbols()

void esphome::remote_receiver::RemoteReceiverComponent::set_receive_symbols ( uint32_t receive_symbols)
inline

Definition at line 65 of file remote_receiver.h.

◆ set_with_dma()

void esphome::remote_receiver::RemoteReceiverComponent::set_with_dma ( bool with_dma)
inline

Definition at line 66 of file remote_receiver.h.

◆ setup()

void esphome::remote_receiver::RemoteReceiverComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 40 of file remote_receiver_esp32.cpp.

Field Documentation

◆ buffer_size_

uint32_t esphome::remote_receiver::RemoteReceiverComponent::buffer_size_ {}
protected

Definition at line 88 of file remote_receiver.h.

◆ channel_

rmt_channel_handle_t esphome::remote_receiver::RemoteReceiverComponent::channel_ {NULL}
protected

Definition at line 75 of file remote_receiver.h.

◆ error_code_

esp_err_t esphome::remote_receiver::RemoteReceiverComponent::error_code_ {ESP_OK}
protected

Definition at line 79 of file remote_receiver.h.

◆ error_string_

std::string esphome::remote_receiver::RemoteReceiverComponent::error_string_ {""}
protected

Definition at line 80 of file remote_receiver.h.

◆ filter_symbols_

uint32_t esphome::remote_receiver::RemoteReceiverComponent::filter_symbols_ {0}
protected

Definition at line 76 of file remote_receiver.h.

◆ filter_us_

uint32_t esphome::remote_receiver::RemoteReceiverComponent::filter_us_ {10}
protected

Definition at line 89 of file remote_receiver.h.

◆ high_freq_

HighFrequencyLoopRequester esphome::remote_receiver::RemoteReceiverComponent::high_freq_
protected

Definition at line 85 of file remote_receiver.h.

◆ idle_us_

uint32_t esphome::remote_receiver::RemoteReceiverComponent::idle_us_ {10000}
protected

Definition at line 90 of file remote_receiver.h.

◆ receive_symbols_

uint32_t esphome::remote_receiver::RemoteReceiverComponent::receive_symbols_ {0}
protected

Definition at line 77 of file remote_receiver.h.

◆ store_

RemoteReceiverComponentStore esphome::remote_receiver::RemoteReceiverComponent::store_
protected

Definition at line 84 of file remote_receiver.h.

◆ with_dma_

bool esphome::remote_receiver::RemoteReceiverComponent::with_dma_ {false}
protected

Definition at line 78 of file remote_receiver.h.


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