esphome-api-client 0.5.0
Modern C++17 client for the ESPHome native API (plaintext + Noise)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
esphome::api::RadioFrequencyEntity Class Reference

Handle to a RadioFrequency entity. More...

#include <entity_handles.hpp>

Inheritance diagram for esphome::api::RadioFrequencyEntity:
Inheritance graph
[legend]
Collaboration diagram for esphome::api::RadioFrequencyEntity:
Collaboration graph
[legend]

Public Member Functions

std::optional< RadioFrequencyInfoinfo () const
 
std::uint32_t capabilities () const
 
std::uint32_t frequency_min () const
 
std::uint32_t frequency_max () const
 
std::uint32_t supported_modulations () const
 
- Public Member Functions inherited from esphome::api::TypedEntity< RadioFrequencyEntity >
std::string icon () const
 
bool disabled_by_default () const
 
EntityCategory entity_category () const
 
std::uint32_t device_id () const
 
 Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
 
- Public Member Functions inherited from esphome::api::Entity
 Entity (Client &client, const std::uint32_t key, std::string object_id, std::string name)
 
std::uint32_t key () const noexcept
 
const std::string & object_id () const noexcept
 
const std::string & name () const noexcept
 

Static Public Member Functions

static constexpr EntityType type ()
 

Additional Inherited Members

- Protected Attributes inherited from esphome::api::Entity
Clientclient_
 
std::uint32_t key_
 
std::string object_id_
 
std::string name_
 

Detailed Description

Handle to a RadioFrequency entity.

Member Function Documentation

◆ capabilities()

std::uint32_t esphome::api::RadioFrequencyEntity::capabilities ( ) const
inline

◆ frequency_max()

std::uint32_t esphome::api::RadioFrequencyEntity::frequency_max ( ) const
inline

◆ frequency_min()

std::uint32_t esphome::api::RadioFrequencyEntity::frequency_min ( ) const
inline

◆ info()

std::optional< RadioFrequencyInfo > esphome::api::RadioFrequencyEntity::info ( ) const
inline

◆ supported_modulations()

std::uint32_t esphome::api::RadioFrequencyEntity::supported_modulations ( ) const
inline

◆ type()

static constexpr EntityType esphome::api::RadioFrequencyEntity::type ( )
inlinestaticconstexpr

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