ESPHome  2024.3.1
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::select::Select Class Referenceabstract

Base-class for all selects. More...

#include <select.h>

Inheritance diagram for esphome::select::Select:
esphome::EntityBase esphome::copy::CopySelect esphome::ld2410::BaudRateSelect esphome::ld2410::DistanceResolutionSelect esphome::ld2410::LightOutControlSelect esphome::ld2420::LD2420Select esphome::modbus_controller::ModbusSelect esphome::seeed_mr24hpc1::ExistenceBoundarySelect esphome::seeed_mr24hpc1::MotionBoundarySelect esphome::seeed_mr24hpc1::SceneModeSelect esphome::seeed_mr24hpc1::UnmanTimeSelect esphome::template_::TemplateSelect esphome::tuya::TuyaSelect

Public Member Functions

void publish_state (const std::string &state)
 
bool has_state () const
 Return whether this select component has gotten a full state yet. More...
 
SelectCall make_call ()
 Instantiate a SelectCall object to modify this select component's state. More...
 
bool has_option (const std::string &option) const
 Return whether this select component contains the provided option. More...
 
bool has_index (size_t index) const
 Return whether this select component contains the provided index offset. More...
 
size_t size () const
 Return the number of options in this select component. More...
 
optional< size_t > index_of (const std::string &option) const
 Find the (optional) index offset of the provided option value. More...
 
optional< size_t > active_index () const
 Return the (optional) index offset of the currently active option. More...
 
optional< std::string > at (size_t index) const
 Return the (optional) option value at the provided index offset. More...
 
void add_on_state_callback (std::function< void(std::string, size_t)> &&callback)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 

Data Fields

std::string state
 
SelectTraits traits
 

Protected Member Functions

virtual void control (const std::string &value)=0
 Set the value of the select, this is a virtual method that each select integration must implement. More...
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 

Protected Attributes

CallbackManager< void(std::string, size_t)> state_callback_
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 

Detailed Description

Base-class for all selects.

A select can use publish_state to send out a new value.

Definition at line 31 of file select.h.

Member Function Documentation

◆ active_index()

optional< size_t > esphome::select::Select::active_index ( ) const

Return the (optional) index offset of the currently active option.

Definition at line 44 of file select.cpp.

◆ add_on_state_callback()

void esphome::select::Select::add_on_state_callback ( std::function< void(std::string, size_t)> &&  callback)

Definition at line 22 of file select.cpp.

◆ at()

optional< std::string > esphome::select::Select::at ( size_t  index) const

Return the (optional) option value at the provided index offset.

Definition at line 52 of file select.cpp.

◆ control()

virtual void esphome::select::Select::control ( const std::string &  value)
protectedpure virtual

◆ has_index()

bool esphome::select::Select::has_index ( size_t  index) const

Return whether this select component contains the provided index offset.

Definition at line 28 of file select.cpp.

◆ has_option()

bool esphome::select::Select::has_option ( const std::string &  option) const

Return whether this select component contains the provided option.

Definition at line 26 of file select.cpp.

◆ has_state()

bool esphome::select::Select::has_state ( ) const
inline

Return whether this select component has gotten a full state yet.

Definition at line 39 of file select.h.

◆ index_of()

optional< size_t > esphome::select::Select::index_of ( const std::string &  option) const

Find the (optional) index offset of the provided option value.

Definition at line 35 of file select.cpp.

◆ make_call()

SelectCall esphome::select::Select::make_call ( )
inline

Instantiate a SelectCall object to modify this select component's state.

Definition at line 42 of file select.h.

◆ publish_state()

void esphome::select::Select::publish_state ( const std::string &  state)

Definition at line 9 of file select.cpp.

◆ size()

size_t esphome::select::Select::size ( ) const

Return the number of options in this select component.

Definition at line 30 of file select.cpp.

Field Documentation

◆ has_state_

bool esphome::select::Select::has_state_ {false}
protected

Definition at line 76 of file select.h.

◆ state

std::string esphome::select::Select::state

Definition at line 33 of file select.h.

◆ state_callback_

CallbackManager<void(std::string, size_t)> esphome::select::Select::state_callback_
protected

Definition at line 75 of file select.h.

◆ traits

SelectTraits esphome::select::Select::traits

Definition at line 34 of file select.h.


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