ESPHome  2022.6.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tuya::TuyaSelect Class Reference

#include <tuya_select.h>

Inheritance diagram for esphome::tuya::TuyaSelect:
esphome::select::Select esphome::Component esphome::EntityBase

Public Member Functions

void setup () override
 
void dump_config () override
 
void set_tuya_parent (Tuya *parent)
 
void set_optimistic (bool optimistic)
 
void set_select_id (uint8_t select_id)
 
void set_select_mappings (std::vector< uint8_t > mappings)
 
- Public Member Functions inherited from esphome::select::Select
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
 EntityBase ()
 
 EntityBase (std::string name)
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const std::string & get_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)
 
const std::string & get_icon () const
 
void set_icon (const std::string &name)
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

void control (const std::string &value) override
 
- 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 Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

Tuyaparent_
 
bool optimistic_ = false
 
uint8_t select_id_
 
std::vector< uint8_t > mappings_
 
- Protected Attributes inherited from esphome::select::Select
CallbackManager< void(std::string, size_t)> state_callback_
 
bool has_state_ {false}
 
- Protected Attributes inherited from esphome::EntityBase
std::string name_
 
std::string object_id_
 
std::string icon_
 
uint32_t object_id_hash_
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ = nullptr
 

Additional Inherited Members

- Data Fields inherited from esphome::select::Select
std::string state
 
SelectTraits traits
 

Detailed Description

Definition at line 10 of file tuya_select.h.

Member Function Documentation

◆ control()

void esphome::tuya::TuyaSelect::control ( const std::string &  value)
overrideprotectedvirtual

Implements esphome::select::Select.

Definition at line 26 of file tuya_select.cpp.

◆ dump_config()

void esphome::tuya::TuyaSelect::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 41 of file tuya_select.cpp.

◆ set_optimistic()

void esphome::tuya::TuyaSelect::set_optimistic ( bool  optimistic)
inline

Definition at line 16 of file tuya_select.h.

◆ set_select_id()

void esphome::tuya::TuyaSelect::set_select_id ( uint8_t  select_id)
inline

Definition at line 17 of file tuya_select.h.

◆ set_select_mappings()

void esphome::tuya::TuyaSelect::set_select_mappings ( std::vector< uint8_t >  mappings)
inline

Definition at line 18 of file tuya_select.h.

◆ set_tuya_parent()

void esphome::tuya::TuyaSelect::set_tuya_parent ( Tuya parent)
inline

Definition at line 15 of file tuya_select.h.

◆ setup()

void esphome::tuya::TuyaSelect::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file tuya_select.cpp.

Field Documentation

◆ mappings_

std::vector<uint8_t> esphome::tuya::TuyaSelect::mappings_
protected

Definition at line 26 of file tuya_select.h.

◆ optimistic_

bool esphome::tuya::TuyaSelect::optimistic_ = false
protected

Definition at line 24 of file tuya_select.h.

◆ parent_

Tuya* esphome::tuya::TuyaSelect::parent_
protected

Definition at line 23 of file tuya_select.h.

◆ select_id_

uint8_t esphome::tuya::TuyaSelect::select_id_
protected

Definition at line 25 of file tuya_select.h.


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