ESPHome 2026.10.0-dev
Loading...
Searching...
No Matches
esphome::remote_transmitter::RemoteTransmitterComponent Class Referencefinal

#include <remote_transmitter.h>

Inheritance diagram for esphome::remote_transmitter::RemoteTransmitterComponent:
esphome::remote_base::RemoteTransmitterBase esphome::Component esphome::remote_base::RemoteRMTChannel esphome::remote_base::RemoteComponentBase

Public Member Functions

 RemoteTransmitterComponent (InternalGPIOPin *pin)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_carrier_duty_percent (uint8_t carrier_duty_percent)
 
void digital_write (bool value)
 
void set_with_dma (bool with_dma)
 
void set_eot_level (bool eot_level)
 
void set_non_blocking (bool non_blocking)
 
void loop () override
 
void advance_envelope_isr ()
 
Triggerget_transmit_trigger ()
 
Triggerget_complete_trigger ()
 
- Public Member Functions inherited from esphome::remote_base::RemoteTransmitterBase
 RemoteTransmitterBase (InternalGPIOPin *pin)
 
TransmitCall transmit ()
 
template<typename Protocol >
void transmit (const Protocol::ProtocolData &data, uint32_t send_times=1, uint32_t send_wait=0)
 
- Public Member Functions inherited from esphome::remote_base::RemoteComponentBase
 RemoteComponentBase (InternalGPIOPin *pin)
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
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.
 
bool is_idle () const
 Check if this component is idle.
 
void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const LogString *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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const char *name, uint32_t length=5000)
 Set warning status flag and automatically clear it after a timeout.
 
void status_momentary_error (const char *name, uint32_t length=5000)
 Set error status flag and automatically clear it after a timeout.
 
bool has_overridden_loop () const
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 
- 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)
 

Static Public Member Functions

static void advance_active_isr ()
 

Protected Member Functions

void send_internal (uint32_t send_times, uint32_t send_wait) override
 
void await_target_time_ ()
 
void calculate_on_off_time_ (uint32_t carrier_frequency, uint32_t *on_time_period, uint32_t *off_time_period)
 
void mark_ (uint32_t on_time, uint32_t off_time, uint32_t usec)
 
void space_ (uint32_t usec)
 
void start_isr_item_ (size_t index)
 
void arm_envelope_timer_ (uint32_t duration_us)
 
void abort_stalled_chain_ ()
 
void deliver_completion_ ()
 
void wait_until_idle_ ()
 
void arm_chain_ (uint32_t send_times, uint32_t send_wait)
 
bool envelope_ready_ () const
 
void prepare_carrier_ (uint32_t carrier_frequency)
 
void write_envelope_level_ (bool mark)
 
void arm_one_shot_ (uint32_t duration_us)
 
void stop_envelope_timer_ ()
 
void write_pwm_t1_ (uint32_t t1_counts)
 
void configure_rmt_ ()
 
void wait_for_rmt_ ()
 
- Protected Member Functions inherited from esphome::remote_base::RemoteTransmitterBase
void send_ (uint32_t send_times, uint32_t send_wait)
 
void send_single_ ()
 
- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
virtual void call_setup ()
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
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 id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
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 id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
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.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 
- 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

uint32_t target_time_ {0}
 
uint32_t current_carrier_frequency_ {0}
 
void * pwm_ {nullptr}
 
std::vector< int32_t > isr_data_
 
volatile size_t isr_index_ {0}
 
volatile uint32_t isr_repeats_left_ {0}
 
uint32_t isr_send_wait_ {0}
 
volatile uint32_t isr_wait_remaining_ {0}
 
volatile bool isr_in_gap_ {false}
 
volatile bool transmitting_ {false}
 
bool non_blocking_ {false}
 
bool complete_pending_ {false}
 
bool stall_aborted_ {false}
 
float isr_mark_duty_ {0.0f}
 
float isr_space_duty_ {0.0f}
 
uint32_t isr_mark_t1_ {0}
 
uint32_t isr_space_t1_ {0}
 
uint32_t isr_period_t4_ {684}
 
int8_t pwm_channel_ {-1}
 
RemoteTransmitterComponentStore store_ {}
 
std::vector< rmt_symbol_half_trmt_temp_
 
std::vector< rmt_symbol_word_t > rmt_temp_
 
bool initialized_ {false}
 
bool with_dma_ {false}
 
bool eot_level_ {false}
 
rmt_channel_handle_t channel_ {NULL}
 
rmt_encoder_handle_t encoder_ {NULL}
 
esp_err_t error_code_ {ESP_OK}
 
std::string error_string_
 
bool inverted_ {false}
 
uint8_t carrier_duty_percent_ {50}
 
Trigger transmit_trigger_
 
Trigger complete_trigger_
 
- Protected Attributes inherited from esphome::remote_base::RemoteTransmitterBase
RemoteTransmitData temp_
 Use same vector for all transmits, avoids many allocations.
 
- Protected Attributes inherited from esphome::remote_base::RemoteComponentBase
InternalGPIOPinpin_
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 
- Protected Attributes inherited from esphome::remote_base::RemoteRMTChannel
RemoteComponentBaseremote_base_
 
uint32_t clock_resolution_ {1000000}
 
uint32_t rmt_symbols_
 

Detailed Description

Definition at line 44 of file remote_transmitter.h.

Constructor & Destructor Documentation

◆ RemoteTransmitterComponent()

esphome::remote_transmitter::RemoteTransmitterComponent::RemoteTransmitterComponent ( InternalGPIOPin * pin)
inlineexplicit

Definition at line 52 of file remote_transmitter.h.

Member Function Documentation

◆ abort_stalled_chain_()

void esphome::remote_transmitter::RemoteTransmitterComponent::abort_stalled_chain_ ( )
protected

Definition at line 96 of file remote_transmitter_libretiny_isr.cpp.

◆ advance_active_isr()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::advance_active_isr ( )
static

Definition at line 32 of file remote_transmitter_libretiny_isr.cpp.

◆ advance_envelope_isr()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::advance_envelope_isr ( )

Definition at line 54 of file remote_transmitter_libretiny_isr.cpp.

◆ arm_chain_()

void esphome::remote_transmitter::RemoteTransmitterComponent::arm_chain_ ( uint32_t send_times,
uint32_t send_wait )
protected

Definition at line 139 of file remote_transmitter_libretiny_isr.cpp.

◆ arm_envelope_timer_()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::arm_envelope_timer_ ( uint32_t duration_us)
protected

Definition at line 39 of file remote_transmitter_libretiny_isr.cpp.

◆ arm_one_shot_()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::arm_one_shot_ ( uint32_t duration_us)
protected

Definition at line 164 of file remote_transmitter_bk72xx.cpp.

◆ await_target_time_()

void esphome::remote_transmitter::RemoteTransmitterComponent::await_target_time_ ( )
protected

Definition at line 38 of file remote_transmitter.cpp.

◆ calculate_on_off_time_()

void esphome::remote_transmitter::RemoteTransmitterComponent::calculate_on_off_time_ ( uint32_t carrier_frequency,
uint32_t * on_time_period,
uint32_t * off_time_period )
protected

Definition at line 25 of file remote_transmitter.cpp.

◆ configure_rmt_()

void esphome::remote_transmitter::RemoteTransmitterComponent::configure_rmt_ ( )
protected

Definition at line 111 of file remote_transmitter_rmt.cpp.

◆ deliver_completion_()

void esphome::remote_transmitter::RemoteTransmitterComponent::deliver_completion_ ( )
protected

Definition at line 109 of file remote_transmitter_libretiny_isr.cpp.

◆ digital_write()

void esphome::remote_transmitter::RemoteTransmitterComponent::digital_write ( bool value)

Definition at line 79 of file remote_transmitter.cpp.

◆ dump_config()

void esphome::remote_transmitter::RemoteTransmitterComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file remote_transmitter.cpp.

◆ envelope_ready_()

bool esphome::remote_transmitter::RemoteTransmitterComponent::envelope_ready_ ( ) const
protected

Definition at line 138 of file remote_transmitter_bk72xx.cpp.

◆ get_complete_trigger()

Trigger * esphome::remote_transmitter::RemoteTransmitterComponent::get_complete_trigger ( )
inline

Definition at line 81 of file remote_transmitter.h.

◆ get_setup_priority()

float esphome::remote_transmitter::RemoteTransmitterComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 58 of file remote_transmitter.h.

◆ get_transmit_trigger()

Trigger * esphome::remote_transmitter::RemoteTransmitterComponent::get_transmit_trigger ( )
inline

Definition at line 80 of file remote_transmitter.h.

◆ loop()

void esphome::remote_transmitter::RemoteTransmitterComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 204 of file remote_transmitter_libretiny_isr.cpp.

◆ mark_()

void esphome::remote_transmitter::RemoteTransmitterComponent::mark_ ( uint32_t on_time,
uint32_t off_time,
uint32_t usec )
protected

Definition at line 50 of file remote_transmitter.cpp.

◆ prepare_carrier_()

void esphome::remote_transmitter::RemoteTransmitterComponent::prepare_carrier_ ( uint32_t carrier_frequency)
protected

Definition at line 142 of file remote_transmitter_bk72xx.cpp.

◆ send_internal()

void esphome::remote_transmitter::RemoteTransmitterComponent::send_internal ( uint32_t send_times,
uint32_t send_wait )
overrideprotectedvirtual

◆ set_carrier_duty_percent()

void esphome::remote_transmitter::RemoteTransmitterComponent::set_carrier_duty_percent ( uint8_t carrier_duty_percent)
inline

Definition at line 60 of file remote_transmitter.h.

◆ set_eot_level()

void esphome::remote_transmitter::RemoteTransmitterComponent::set_eot_level ( bool eot_level)
inline

Definition at line 66 of file remote_transmitter.h.

◆ set_non_blocking()

void esphome::remote_transmitter::RemoteTransmitterComponent::set_non_blocking ( bool non_blocking)
inline

Definition at line 70 of file remote_transmitter.h.

◆ set_with_dma()

void esphome::remote_transmitter::RemoteTransmitterComponent::set_with_dma ( bool with_dma)
inline

Definition at line 65 of file remote_transmitter.h.

◆ setup()

void esphome::remote_transmitter::RemoteTransmitterComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file remote_transmitter.cpp.

◆ space_()

void esphome::remote_transmitter::RemoteTransmitterComponent::space_ ( uint32_t usec)
protected

Definition at line 73 of file remote_transmitter.cpp.

◆ start_isr_item_()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::start_isr_item_ ( size_t index)
protected

Definition at line 48 of file remote_transmitter_libretiny_isr.cpp.

◆ stop_envelope_timer_()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::stop_envelope_timer_ ( )
protected

Definition at line 173 of file remote_transmitter_bk72xx.cpp.

◆ wait_for_rmt_()

void esphome::remote_transmitter::RemoteTransmitterComponent::wait_for_rmt_ ( )
protected

Definition at line 209 of file remote_transmitter_rmt.cpp.

◆ wait_until_idle_()

void esphome::remote_transmitter::RemoteTransmitterComponent::wait_until_idle_ ( )
protected

Definition at line 118 of file remote_transmitter_libretiny_isr.cpp.

◆ write_envelope_level_()

void IRAM_ATTR esphome::remote_transmitter::RemoteTransmitterComponent::write_envelope_level_ ( bool mark)
protected

Definition at line 158 of file remote_transmitter_bk72xx.cpp.

◆ write_pwm_t1_()

void esphome::remote_transmitter::RemoteTransmitterComponent::write_pwm_t1_ ( uint32_t t1_counts)
protected

Definition at line 116 of file remote_transmitter_bk72xx.cpp.

Field Documentation

◆ carrier_duty_percent_

uint8_t esphome::remote_transmitter::RemoteTransmitterComponent::carrier_duty_percent_ {50}
protected

Definition at line 164 of file remote_transmitter.h.

◆ channel_

rmt_channel_handle_t esphome::remote_transmitter::RemoteTransmitterComponent::channel_ {NULL}
protected

Definition at line 157 of file remote_transmitter.h.

◆ complete_pending_

bool esphome::remote_transmitter::RemoteTransmitterComponent::complete_pending_ {false}
protected

Definition at line 128 of file remote_transmitter.h.

◆ complete_trigger_

Trigger esphome::remote_transmitter::RemoteTransmitterComponent::complete_trigger_
protected

Definition at line 167 of file remote_transmitter.h.

◆ current_carrier_frequency_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::current_carrier_frequency_ {0}
protected

Definition at line 102 of file remote_transmitter.h.

◆ encoder_

rmt_encoder_handle_t esphome::remote_transmitter::RemoteTransmitterComponent::encoder_ {NULL}
protected

Definition at line 158 of file remote_transmitter.h.

◆ eot_level_

bool esphome::remote_transmitter::RemoteTransmitterComponent::eot_level_ {false}
protected

Definition at line 156 of file remote_transmitter.h.

◆ error_code_

esp_err_t esphome::remote_transmitter::RemoteTransmitterComponent::error_code_ {ESP_OK}
protected

Definition at line 159 of file remote_transmitter.h.

◆ error_string_

std::string esphome::remote_transmitter::RemoteTransmitterComponent::error_string_
protected

Definition at line 160 of file remote_transmitter.h.

◆ initialized_

bool esphome::remote_transmitter::RemoteTransmitterComponent::initialized_ {false}
protected

Definition at line 154 of file remote_transmitter.h.

◆ inverted_

bool esphome::remote_transmitter::RemoteTransmitterComponent::inverted_ {false}
protected

Definition at line 161 of file remote_transmitter.h.

◆ isr_data_

std::vector<int32_t> esphome::remote_transmitter::RemoteTransmitterComponent::isr_data_
protected

Definition at line 120 of file remote_transmitter.h.

◆ isr_in_gap_

volatile bool esphome::remote_transmitter::RemoteTransmitterComponent::isr_in_gap_ {false}
protected

Definition at line 125 of file remote_transmitter.h.

◆ isr_index_

volatile size_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_index_ {0}
protected

Definition at line 121 of file remote_transmitter.h.

◆ isr_mark_duty_

float esphome::remote_transmitter::RemoteTransmitterComponent::isr_mark_duty_ {0.0f}
protected

Definition at line 132 of file remote_transmitter.h.

◆ isr_mark_t1_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_mark_t1_ {0}
protected

Definition at line 137 of file remote_transmitter.h.

◆ isr_period_t4_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_period_t4_ {684}
protected

Definition at line 139 of file remote_transmitter.h.

◆ isr_repeats_left_

volatile uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_repeats_left_ {0}
protected

Definition at line 122 of file remote_transmitter.h.

◆ isr_send_wait_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_send_wait_ {0}
protected

Definition at line 123 of file remote_transmitter.h.

◆ isr_space_duty_

float esphome::remote_transmitter::RemoteTransmitterComponent::isr_space_duty_ {0.0f}
protected

Definition at line 133 of file remote_transmitter.h.

◆ isr_space_t1_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_space_t1_ {0}
protected

Definition at line 138 of file remote_transmitter.h.

◆ isr_wait_remaining_

volatile uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::isr_wait_remaining_ {0}
protected

Definition at line 124 of file remote_transmitter.h.

◆ non_blocking_

bool esphome::remote_transmitter::RemoteTransmitterComponent::non_blocking_ {false}
protected

Definition at line 127 of file remote_transmitter.h.

◆ pwm_

void* esphome::remote_transmitter::RemoteTransmitterComponent::pwm_ {nullptr}
protected

Definition at line 103 of file remote_transmitter.h.

◆ pwm_channel_

int8_t esphome::remote_transmitter::RemoteTransmitterComponent::pwm_channel_ {-1}
protected

Definition at line 140 of file remote_transmitter.h.

◆ rmt_temp_ [1/2]

std::vector<rmt_symbol_half_t> esphome::remote_transmitter::RemoteTransmitterComponent::rmt_temp_
protected

Definition at line 149 of file remote_transmitter.h.

◆ rmt_temp_ [2/2]

std::vector<rmt_symbol_word_t> esphome::remote_transmitter::RemoteTransmitterComponent::rmt_temp_
protected

Definition at line 151 of file remote_transmitter.h.

◆ stall_aborted_

bool esphome::remote_transmitter::RemoteTransmitterComponent::stall_aborted_ {false}
protected

Definition at line 129 of file remote_transmitter.h.

◆ store_

RemoteTransmitterComponentStore esphome::remote_transmitter::RemoteTransmitterComponent::store_ {}
protected

Definition at line 148 of file remote_transmitter.h.

◆ target_time_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::target_time_ {0}
protected

Definition at line 89 of file remote_transmitter.h.

◆ transmit_trigger_

Trigger esphome::remote_transmitter::RemoteTransmitterComponent::transmit_trigger_
protected

Definition at line 166 of file remote_transmitter.h.

◆ transmitting_

volatile bool esphome::remote_transmitter::RemoteTransmitterComponent::transmitting_ {false}
protected

Definition at line 126 of file remote_transmitter.h.

◆ with_dma_

bool esphome::remote_transmitter::RemoteTransmitterComponent::with_dma_ {false}
protected

Definition at line 155 of file remote_transmitter.h.


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