#include <remote_transmitter.h>

Inheritance diagram for esphome::remote_transmitter::RemoteTransmitterComponent:

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)

Trigger *	get_transmit_trigger () const

Trigger *	get_complete_trigger () const

Public Member Functions inherited from esphome::remote_base::RemoteTransmitterBase
	RemoteTransmitterBase (InternalGPIOPin *pin)

TransmitCall	transmit ()

template<typename Protocol >
void	transmit (const typename 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
virtual void	loop ()
	This method will be called repeatedly.

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=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

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	send_internal (uint32_t send_times, uint32_t send_wait) override

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

void	configure_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
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

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
uint32_t	target_time_

uint32_t	current_carrier_frequency_ {38000}

bool	initialized_ {false}

std::vector< rmt_symbol_word_t >	rmt_temp_

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_

Trigger *	transmit_trigger_ {new Trigger<>()}

Trigger *	complete_trigger_ {new 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
InternalGPIOPin *	pin_

Protected Attributes inherited from esphome::Component
const LogString *	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-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

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

Protected Attributes inherited from esphome::remote_base::RemoteRMTChannel
RemoteComponentBase *	remote_base_

uint32_t	clock_resolution_ {1000000}

uint32_t	rmt_symbols_

Detailed Description

Definition at line 15 of file remote_transmitter.h.

Constructor & Destructor Documentation

◆ RemoteTransmitterComponent()

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

inlineexplicit

Definition at line 23 of file remote_transmitter.h.

Member Function Documentation

◆ 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 59 of file remote_transmitter_esp32.cpp.

◆ digital_write()

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

Definition at line 82 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.

◆ get_complete_trigger()

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

inline

Definition at line 41 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 29 of file remote_transmitter.h.

◆ get_transmit_trigger()

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

inline

Definition at line 40 of file remote_transmitter.h.

◆ mark_()

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

protected

Definition at line 53 of file remote_transmitter.cpp.

◆ send_internal()

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

overrideprotectedvirtual

Implements esphome::remote_base::RemoteTransmitterBase.

Definition at line 84 of file remote_transmitter.cpp.

◆ set_carrier_duty_percent()

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

inline

Definition at line 31 of file remote_transmitter.h.

◆ set_eot_level()

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

inline

Definition at line 37 of file remote_transmitter.h.

◆ set_with_dma()

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

inline

Definition at line 36 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 76 of file remote_transmitter.cpp.

Field Documentation

◆ carrier_duty_percent_

uint8_t esphome::remote_transmitter::RemoteTransmitterComponent::carrier_duty_percent_

protected

Definition at line 70 of file remote_transmitter.h.

◆ channel_

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

protected

Definition at line 64 of file remote_transmitter.h.

◆ complete_trigger_

Trigger* esphome::remote_transmitter::RemoteTransmitterComponent::complete_trigger_ {new Trigger<>()}

protected

Definition at line 73 of file remote_transmitter.h.

◆ current_carrier_frequency_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::current_carrier_frequency_ {38000}

protected

Definition at line 59 of file remote_transmitter.h.

◆ encoder_

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

protected

Definition at line 65 of file remote_transmitter.h.

◆ eot_level_

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

protected

Definition at line 63 of file remote_transmitter.h.

◆ error_code_

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

protected

Definition at line 66 of file remote_transmitter.h.

◆ error_string_

std::string esphome::remote_transmitter::RemoteTransmitterComponent::error_string_ {""}

protected

Definition at line 67 of file remote_transmitter.h.

◆ initialized_

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

protected

Definition at line 60 of file remote_transmitter.h.

◆ inverted_

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

protected

Definition at line 68 of file remote_transmitter.h.

◆ rmt_temp_

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

protected

Definition at line 61 of file remote_transmitter.h.

◆ target_time_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::target_time_

protected

Definition at line 53 of file remote_transmitter.h.

◆ transmit_trigger_

Trigger* esphome::remote_transmitter::RemoteTransmitterComponent::transmit_trigger_ {new Trigger<>()}

protected

Definition at line 72 of file remote_transmitter.h.

◆ with_dma_

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

protected

Definition at line 62 of file remote_transmitter.h.

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

esphome/components/remote_transmitter/remote_transmitter.h
esphome/components/remote_transmitter/remote_transmitter.cpp
esphome/components/remote_transmitter/remote_transmitter_esp32.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RemoteTransmitterComponent()

Member Function Documentation

◆ await_target_time_()

◆ calculate_on_off_time_()

◆ configure_rmt_()

◆ digital_write()

◆ dump_config()

◆ get_complete_trigger()

◆ get_setup_priority()

◆ get_transmit_trigger()

◆ mark_()

◆ send_internal()

◆ set_carrier_duty_percent()

◆ set_eot_level()

◆ set_with_dma()

◆ setup()

◆ space_()

Field Documentation

◆ carrier_duty_percent_

◆ channel_

◆ complete_trigger_

◆ current_carrier_frequency_

◆ encoder_

◆ eot_level_

◆ error_code_

◆ error_string_

◆ initialized_

◆ inverted_

◆ rmt_temp_

◆ target_time_

◆ transmit_trigger_

◆ with_dma_