esphome::radio_frequency::RadioFrequencyTraits Class Reference

RadioFrequencyTraits - Describes the capabilities of a radio frequency implementation. More...

#include <radio_frequency.h>

Public Member Functions
bool	get_supports_transmitter () const
void	set_supports_transmitter (bool supports)
bool	get_supports_receiver () const
void	set_supports_receiver (bool supports)
uint32_t	get_frequency_min_hz () const
	Hardware-supported tunable frequency range in Hz.
void	set_frequency_min_hz (uint32_t freq)
uint32_t	get_frequency_max_hz () const
void	set_frequency_max_hz (uint32_t freq)
void	set_fixed_frequency_hz (uint32_t freq)
	Convenience setter for fixed-frequency hardware (sets min == max).
uint32_t	get_supported_modulations () const
	Bitmask of supported RadioFrequencyModulation values (bit N = modulation value N supported).
void	set_supported_modulations (uint32_t mask)
void	add_supported_modulation (RadioFrequencyModulation mod)

Protected Attributes
uint32_t	frequency_min_hz_ {0}
uint32_t	frequency_max_hz_ {0}
uint32_t	supported_modulations_ {0}
bool	supports_transmitter_ {false}
bool	supports_receiver_ {false}

Detailed Description

RadioFrequencyTraits - Describes the capabilities of a radio frequency implementation.

Definition at line 109 of file radio_frequency.h.

Member Function Documentation

add_supported_modulation()

void esphome::radio_frequency::RadioFrequencyTraits::add_supported_modulation ( RadioFrequencyModulation mod )

inline

Definition at line 135 of file radio_frequency.h.

get_frequency_max_hz()

uint32_t esphome::radio_frequency::RadioFrequencyTraits::get_frequency_max_hz ( ) const

inline

Definition at line 123 of file radio_frequency.h.

get_frequency_min_hz()

uint32_t esphome::radio_frequency::RadioFrequencyTraits::get_frequency_min_hz ( ) const

inline

Hardware-supported tunable frequency range in Hz.

If min == max (and both non-zero): fixed-frequency hardware. If both 0: range unspecified.

Definition at line 120 of file radio_frequency.h.

get_supported_modulations()

uint32_t esphome::radio_frequency::RadioFrequencyTraits::get_supported_modulations ( ) const

inline

Bitmask of supported RadioFrequencyModulation values (bit N = modulation value N supported).

Definition at line 133 of file radio_frequency.h.

get_supports_receiver()

bool esphome::radio_frequency::RadioFrequencyTraits::get_supports_receiver ( ) const

inline

Definition at line 114 of file radio_frequency.h.

get_supports_transmitter()

bool esphome::radio_frequency::RadioFrequencyTraits::get_supports_transmitter ( ) const

inline

Definition at line 111 of file radio_frequency.h.

set_fixed_frequency_hz()

void esphome::radio_frequency::RadioFrequencyTraits::set_fixed_frequency_hz ( uint32_t freq )

inline

Convenience setter for fixed-frequency hardware (sets min == max).

Definition at line 127 of file radio_frequency.h.

set_frequency_max_hz()

void esphome::radio_frequency::RadioFrequencyTraits::set_frequency_max_hz ( uint32_t freq )

inline

Definition at line 124 of file radio_frequency.h.

set_frequency_min_hz()

void esphome::radio_frequency::RadioFrequencyTraits::set_frequency_min_hz ( uint32_t freq )

inline

Definition at line 121 of file radio_frequency.h.

set_supported_modulations()

void esphome::radio_frequency::RadioFrequencyTraits::set_supported_modulations ( uint32_t mask )

inline

Definition at line 134 of file radio_frequency.h.

set_supports_receiver()

void esphome::radio_frequency::RadioFrequencyTraits::set_supports_receiver ( bool supports )

inline

Definition at line 115 of file radio_frequency.h.

set_supports_transmitter()

void esphome::radio_frequency::RadioFrequencyTraits::set_supports_transmitter ( bool supports )

inline

Definition at line 112 of file radio_frequency.h.

Field Documentation

frequency_max_hz_

uint32_t esphome::radio_frequency::RadioFrequencyTraits::frequency_max_hz_ {0}

protected

Definition at line 141 of file radio_frequency.h.

frequency_min_hz_

uint32_t esphome::radio_frequency::RadioFrequencyTraits::frequency_min_hz_ {0}

protected

Definition at line 140 of file radio_frequency.h.

supported_modulations_

uint32_t esphome::radio_frequency::RadioFrequencyTraits::supported_modulations_ {0}

protected

Definition at line 142 of file radio_frequency.h.

supports_receiver_

bool esphome::radio_frequency::RadioFrequencyTraits::supports_receiver_ {false}

protected

Definition at line 144 of file radio_frequency.h.

supports_transmitter_

bool esphome::radio_frequency::RadioFrequencyTraits::supports_transmitter_ {false}

protected

Definition at line 143 of file radio_frequency.h.

---

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

• esphome/components/radio_frequency/radio_frequency.h