ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::remote_transmitter::RemoteTransmitterComponent Class Reference

#include <remote_transmitter.h>

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

Public Member Functions

 RemoteTransmitterComponent (InternalGPIOPin *pin, uint8_t mem_block_num=1)
 
 RemoteTransmitterComponent (InternalGPIOPin *pin, rmt_channel_t channel, uint8_t mem_block_num=1)
 
 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)
 
Triggerget_transmit_trigger () const
 
Triggerget_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)
 

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 Attributes

uint32_t target_time_
 
uint32_t current_carrier_frequency_ {38000}
 
bool initialized_ {false}
 
std::vector< rmt_item32_t > rmt_temp_
 
esp_err_t error_code_ {ESP_OK}
 
std::string error_string_ {""}
 
bool inverted_ {false}
 
uint8_t carrier_duty_percent_
 
Triggertransmit_trigger_ {new Trigger<>()}
 
Triggercomplete_trigger_ {new Trigger<>()}
 
- Protected Attributes inherited from esphome::remote_base::RemoteTransmitterBase
RemoteTransmitData temp_
 Use same vector for all transmits, avoids many allocations. More...
 
- Protected Attributes inherited from esphome::remote_base::RemoteComponentBase
InternalGPIOPinpin_
 

Detailed Description

Definition at line 11 of file remote_transmitter.h.

Constructor & Destructor Documentation

◆ RemoteTransmitterComponent() [1/3]

esphome::remote_transmitter::RemoteTransmitterComponent::RemoteTransmitterComponent ( InternalGPIOPin pin,
uint8_t  mem_block_num = 1 
)
inline

Definition at line 20 of file remote_transmitter.h.

◆ RemoteTransmitterComponent() [2/3]

esphome::remote_transmitter::RemoteTransmitterComponent::RemoteTransmitterComponent ( InternalGPIOPin pin,
rmt_channel_t  channel,
uint8_t  mem_block_num = 1 
)
inline

Definition at line 23 of file remote_transmitter.h.

◆ RemoteTransmitterComponent() [3/3]

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

Definition at line 26 of file remote_transmitter.h.

Member Function Documentation

◆ await_target_time_()

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

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

◆ configure_rmt_()

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

Definition at line 31 of file remote_transmitter_esp32.cpp.

◆ dump_config()

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

Definition at line 14 of file remote_transmitter_esp32.cpp.

◆ get_complete_trigger()

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

Definition at line 37 of file remote_transmitter.h.

◆ get_setup_priority()

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

Definition at line 32 of file remote_transmitter.h.

◆ get_transmit_trigger()

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

Definition at line 36 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 45 of file remote_transmitter_esp8266.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 34 of file remote_transmitter.h.

◆ setup()

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

Definition at line 12 of file remote_transmitter_esp32.cpp.

◆ space_()

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

Definition at line 68 of file remote_transmitter_esp8266.cpp.

Field Documentation

◆ carrier_duty_percent_

uint8_t esphome::remote_transmitter::RemoteTransmitterComponent::carrier_duty_percent_
protected

Definition at line 62 of file remote_transmitter.h.

◆ complete_trigger_

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

Definition at line 65 of file remote_transmitter.h.

◆ current_carrier_frequency_

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

Definition at line 55 of file remote_transmitter.h.

◆ error_code_

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

Definition at line 58 of file remote_transmitter.h.

◆ error_string_

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

Definition at line 59 of file remote_transmitter.h.

◆ initialized_

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

Definition at line 56 of file remote_transmitter.h.

◆ inverted_

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

Definition at line 60 of file remote_transmitter.h.

◆ rmt_temp_

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

Definition at line 57 of file remote_transmitter.h.

◆ target_time_

uint32_t esphome::remote_transmitter::RemoteTransmitterComponent::target_time_
protected

Definition at line 49 of file remote_transmitter.h.

◆ transmit_trigger_

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

Definition at line 64 of file remote_transmitter.h.


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