esphome::radio_frequency::RadioFrequencyCall Class Reference

RadioFrequencyCall - Builder pattern for transmitting radio frequency signals. More...

#include <radio_frequency.h>

Inheritance diagram for esphome::radio_frequency::RadioFrequencyCall:

Public Member Functions
	RadioFrequencyCall (RadioFrequency *parent)
RadioFrequencyCall &	set_frequency (uint32_t frequency_hz)
	Set the carrier frequency in Hz (e.g. 433920000 for 433.92 MHz)
RadioFrequencyCall &	set_modulation (RadioFrequencyModulation modulation)
	Set the modulation type (defaults to OOK)
const optional< uint32_t > &	get_frequency () const
	Get the frequency in Hz.
RadioFrequencyModulation	get_modulation () const
	Get the modulation type.
Public Member Functions inherited from esphome::ir_rf_base::IrRfCall< RadioFrequencyCall, RadioFrequency >
RadioFrequencyCall &	set_raw_timings (const std::vector< int32_t > &timings)
	Set the raw timings from a vector (positive = mark, negative = space)
RadioFrequencyCall &	set_raw_timings_base64url (const std::string &base64url)
	Set the raw timings from base64url-encoded little-endian int32 data.
RadioFrequencyCall &	set_raw_timings_packed (const uint8_t *data, uint16_t length, uint16_t count)
	Set the raw timings from packed protobuf sint32 data (zigzag + varint encoded)
RadioFrequencyCall &	set_repeat_count (uint32_t count)
	Set the number of times to repeat transmission (1 = transmit once, 2 = transmit twice, etc.)
RadioFrequencyCall &	set_api_connection (api::APIConnection *conn)
	Reply to this API client once the frame has left the transmitter (API 1.18+)
bool	perform ()
	Perform the transmission; returns true if a frame was handed to the transmitter.
Public Member Functions inherited from esphome::ir_rf_base::IrRfCallData
const std::vector< int32_t > &	get_raw_timings () const
	Get the raw timings (only valid if set via set_raw_timings)
bool	has_raw_timings () const
	Check if raw timings have been set (any format)
bool	is_packed () const
	Check if using packed data format.
bool	is_base64url () const
	Check if using base64url data format.
const std::string &	get_base64url_data () const
	Get the base64url data string.
const uint8_t *	get_packed_data () const
	Get packed data (only valid if set via set_raw_timings_packed)
uint16_t	get_packed_length () const
uint16_t	get_packed_count () const
uint32_t	get_repeat_count () const
	Get the repeat count.
bool	wants_api_reply () const
	True for a frame an API client is waiting on.

Protected Attributes
optional< uint32_t >	frequency_hz_ {}
RadioFrequencyModulation	modulation_ {RADIO_FREQUENCY_MODULATION_OOK}
Protected Attributes inherited from esphome::ir_rf_base::IrRfCall< RadioFrequencyCall, RadioFrequency >
RadioFrequency *	parent_
Protected Attributes inherited from esphome::ir_rf_base::IrRfCallData
uint32_t	repeat_count_ {1}
api::APIConnection *	api_connection_ {nullptr}
const std::vector< int32_t > *	raw_timings_ {nullptr}
const std::string *	base64url_ptr_ {nullptr}
const uint8_t *	packed_data_ {nullptr}
uint16_t	packed_length_ {0}
uint16_t	packed_count_ {0}

Additional Inherited Members
Protected Member Functions inherited from esphome::ir_rf_base::IrRfCall< RadioFrequencyCall, RadioFrequency >
RadioFrequencyCall &	self_ ()

Detailed Description

RadioFrequencyCall - Builder pattern for transmitting radio frequency signals.

Definition at line 23 of file radio_frequency.h.

Constructor & Destructor Documentation

RadioFrequencyCall()

esphome::radio_frequency::RadioFrequencyCall::RadioFrequencyCall ( RadioFrequency * parent )

inlineexplicit

Definition at line 25 of file radio_frequency.h.

Member Function Documentation

get_frequency()

const optional< uint32_t > & esphome::radio_frequency::RadioFrequencyCall::get_frequency ( ) const

inline

Get the frequency in Hz.

Definition at line 38 of file radio_frequency.h.

get_modulation()

RadioFrequencyModulation esphome::radio_frequency::RadioFrequencyCall::get_modulation ( ) const

inline

Get the modulation type.

Definition at line 40 of file radio_frequency.h.

set_frequency()

RadioFrequencyCall & esphome::radio_frequency::RadioFrequencyCall::set_frequency ( uint32_t frequency_hz )

inline

Set the carrier frequency in Hz (e.g. 433920000 for 433.92 MHz)

Definition at line 28 of file radio_frequency.h.

set_modulation()

RadioFrequencyCall & esphome::radio_frequency::RadioFrequencyCall::set_modulation ( RadioFrequencyModulation modulation )

inline

Set the modulation type (defaults to OOK)

Definition at line 33 of file radio_frequency.h.

Field Documentation

frequency_hz_

optional<uint32_t> esphome::radio_frequency::RadioFrequencyCall::frequency_hz_ {}

protected

Definition at line 43 of file radio_frequency.h.

modulation_

RadioFrequencyModulation esphome::radio_frequency::RadioFrequencyCall::modulation_ {RADIO_FREQUENCY_MODULATION_OOK}

protected

Definition at line 44 of file radio_frequency.h.

---

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

• esphome/components/radio_frequency/radio_frequency.h