RfProxy - Radio Frequency platform implementation using remote_transmitter/receiver as backend. More...

#include <ir_rf_proxy.h>

Inheritance diagram for esphome::ir_rf_proxy::RfProxy:

Public Member Functions
	RfProxy ()=default

void	setup () override

void	dump_config () override

void	set_transmitter (remote_base::RemoteTransmitterBase *transmitter)
	Set the remote transmitter component.

void	set_receiver (remote_base::RemoteReceiverBase *receiver)
	Set the remote receiver component.

void	set_frequency_hz (uint32_t freq_hz)
	Set the fixed carrier frequency in Hz (metadata: advertised via traits, does not tune hardware)

Public Member Functions inherited from esphome::radio_frequency::RadioFrequency
	RadioFrequency ()=default

float	get_setup_priority () const override

RadioFrequencyTraits &	get_traits ()
	Get the traits for this radio frequency implementation.

const RadioFrequencyTraits &	get_traits () const

RadioFrequencyCall	make_call ()
	Create a call object for transmitting.

uint32_t	get_capability_flags () const
	Get capability flags for this radio frequency instance.

bool	on_receive (remote_base::RemoteReceiveData data) override
	Called when RF data is received (from RemoteReceiverListener)

template<typename F >
void	add_on_receive_callback (F &&callback)
	Add a callback to invoke when RF data is received.

template<typename F >
void	add_on_control_callback (F &&callback)
	Add a callback to invoke when a transmit call is made on this entity.

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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::EntityBase
const StringRef &	get_name () const

bool	has_own_name () const

uint32_t	get_object_id_hash () const

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

bool	is_internal () const

	ESPDEPRECATED ("set_internal() is undefined behavior at runtime — components and Home Assistant are NOT " "notified. Use the 'internal:' YAML key instead. Will be removed in 2027.3.0.", "2026.3.0") void set_internal(bool internal)

bool	is_disabled_by_default () const

EntityCategory	get_entity_category () const

const char *	get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const

template<typename T = int>
StringRef	get_device_class_ref () const

template<typename T = int>
std::string	get_device_class () const

	ESPDEPRECATED ("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_device_class_ref() const

ESPDEPRECATED("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std StringRef	get_unit_of_measurement_ref () const

ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.9.0", "2026.3.0") std const char *	get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const
	Get the unit of measurement as std::string (deprecated, prefer get_unit_of_measurement_ref())

template<typename T = int>
StringRef	get_icon_ref () const

template<typename T = int>
std::string	get_icon () const

	ESPDEPRECATED ("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_icon_ref() const

ESPDEPRECATED("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std uint32_t	get_device_id () const

Device *	get_device () const

bool	has_state () const

void	set_has_state (bool state)

	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

Public Member Functions inherited from esphome::remote_base::RemoteReceiverListener

Protected Member Functions
void	control (const radio_frequency::RadioFrequencyCall &call) override

Protected Member Functions inherited from esphome::radio_frequency::RadioFrequency
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::EntityBase
friend	void::setup ()

friend	void::original_setup ()

void	configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
	Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.

void	set_device_ (Device *device)

ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helper for make_entity_preference() to avoid code bloat.

void	calc_object_id_ ()

Protected Attributes
remote_base::RemoteTransmitterBase *	transmitter_ {nullptr}

remote_base::RemoteReceiverBase *	receiver_ {nullptr}

Protected Attributes inherited from esphome::radio_frequency::RadioFrequency
RadioFrequencyTraits	traits_

LazyCallbackManager< void(remote_base::RemoteReceiveData)>	receive_callback_

LazyCallbackManager< void(const RadioFrequencyCall &)>	control_callback_

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::EntityBase
StringRef	name_

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

uint8_t	device_class_idx_ {}

uint8_t	uom_idx_ {}

uint8_t	icon_idx_ {}

Detailed Description

RfProxy - Radio Frequency platform implementation using remote_transmitter/receiver as backend.

Driver-agnostic: integration with specific RF front-end chips (CC1101, RFM69, etc.) is done in YAML by wiring their actions to remote_transmitter's on_transmit/on_complete triggers and to this entity's on_control trigger (see radio_frequency component docs).

Definition at line 50 of file ir_rf_proxy.h.

Constructor & Destructor Documentation

◆ RfProxy()

esphome::ir_rf_proxy::RfProxy::RfProxy ( )

default

Member Function Documentation

◆ control()

void esphome::ir_rf_proxy::RfProxy::control ( const radio_frequency::RadioFrequencyCall & call )

overrideprotectedvirtual

Implements esphome::radio_frequency::RadioFrequency.

Definition at line 125 of file ir_rf_proxy.cpp.

◆ dump_config()

void esphome::ir_rf_proxy::RfProxy::dump_config ( )

overridevirtual

Reimplemented from esphome::radio_frequency::RadioFrequency.

Definition at line 106 of file ir_rf_proxy.cpp.

◆ set_frequency_hz()

void esphome::ir_rf_proxy::RfProxy::set_frequency_hz ( uint32_t freq_hz )

inline

Set the fixed carrier frequency in Hz (metadata: advertised via traits, does not tune hardware)

Definition at line 63 of file ir_rf_proxy.h.

◆ set_receiver()

void esphome::ir_rf_proxy::RfProxy::set_receiver ( remote_base::RemoteReceiverBase * receiver )

inline

Set the remote receiver component.

Definition at line 60 of file ir_rf_proxy.h.

◆ set_transmitter()

void esphome::ir_rf_proxy::RfProxy::set_transmitter ( remote_base::RemoteTransmitterBase * transmitter )

inline

Set the remote transmitter component.

Definition at line 58 of file ir_rf_proxy.h.

◆ setup()

void esphome::ir_rf_proxy::RfProxy::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 94 of file ir_rf_proxy.cpp.

Field Documentation

◆ receiver_

remote_base::RemoteReceiverBase* esphome::ir_rf_proxy::RfProxy::receiver_ {nullptr}

protected

Definition at line 69 of file ir_rf_proxy.h.

◆ transmitter_

remote_base::RemoteTransmitterBase* esphome::ir_rf_proxy::RfProxy::transmitter_ {nullptr}

protected

Definition at line 68 of file ir_rf_proxy.h.

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

esphome/components/ir_rf_proxy/ir_rf_proxy.h
esphome/components/ir_rf_proxy/ir_rf_proxy.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RfProxy()

Member Function Documentation

◆ control()

◆ dump_config()

◆ set_frequency_hz()

◆ set_receiver()

◆ set_transmitter()

◆ setup()

Field Documentation

◆ receiver_

◆ transmitter_