ESPHome  2024.11.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tuya::Tuya Class Reference

#include <tuya.h>

Inheritance diagram for esphome::tuya::Tuya:
esphome::Component esphome::uart::UARTDevice

Public Member Functions

float get_setup_priority () const override
 
void setup () override
 
void loop () override
 
void dump_config () override
 
void register_listener (uint8_t datapoint_id, const std::function< void(TuyaDatapoint)> &func)
 
void set_raw_datapoint_value (uint8_t datapoint_id, const std::vector< uint8_t > &value)
 
void set_boolean_datapoint_value (uint8_t datapoint_id, bool value)
 
void set_integer_datapoint_value (uint8_t datapoint_id, uint32_t value)
 
void set_status_pin (InternalGPIOPin *status_pin)
 
void set_string_datapoint_value (uint8_t datapoint_id, const std::string &value)
 
void set_enum_datapoint_value (uint8_t datapoint_id, uint8_t value)
 
void set_bitmask_datapoint_value (uint8_t datapoint_id, uint32_t value, uint8_t length)
 
void force_set_raw_datapoint_value (uint8_t datapoint_id, const std::vector< uint8_t > &value)
 
void force_set_boolean_datapoint_value (uint8_t datapoint_id, bool value)
 
void force_set_integer_datapoint_value (uint8_t datapoint_id, uint32_t value)
 
void force_set_string_datapoint_value (uint8_t datapoint_id, const std::string &value)
 
void force_set_enum_datapoint_value (uint8_t datapoint_id, uint8_t value)
 
void force_set_bitmask_datapoint_value (uint8_t datapoint_id, uint32_t value, uint8_t length)
 
TuyaInitState get_init_state ()
 
void set_time_id (time::RealTimeClock *time_id)
 
void add_ignore_mcu_update_on_datapoints (uint8_t ignore_mcu_update_on_datapoints)
 
void add_on_initialized_callback (std::function< void()> callback)
 
- Public Member Functions inherited from esphome::Component
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 () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
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...
 
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 

Protected Member Functions

void handle_char_ (uint8_t c)
 
void handle_datapoints_ (const uint8_t *buffer, size_t len)
 
optional< TuyaDatapointget_datapoint_ (uint8_t datapoint_id)
 
bool validate_message_ ()
 
void handle_command_ (uint8_t command, uint8_t version, const uint8_t *buffer, size_t len)
 
void send_raw_command_ (TuyaCommand command)
 
void process_command_queue_ ()
 
void send_command_ (const TuyaCommand &command)
 
void send_empty_command_ (TuyaCommandType command)
 
void set_numeric_datapoint_value_ (uint8_t datapoint_id, TuyaDatapointType datapoint_type, uint32_t value, uint8_t length, bool forced)
 
void set_string_datapoint_value_ (uint8_t datapoint_id, const std::string &value, bool forced)
 
void set_raw_datapoint_value_ (uint8_t datapoint_id, const std::vector< uint8_t > &value, bool forced)
 
void send_datapoint_command_ (uint8_t datapoint_id, TuyaDatapointType datapoint_type, std::vector< uint8_t > data)
 
void set_status_pin_ ()
 
void send_wifi_status_ ()
 
uint8_t get_wifi_status_code_ ()
 
uint8_t get_wifi_rssi_ ()
 
void send_local_time_ ()
 
- 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(uint8_t)> &&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(uint8_t)> &&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

time::RealTimeClocktime_id_ {nullptr}
 
bool time_sync_callback_registered_ {false}
 
TuyaInitState init_state_ = TuyaInitState::INIT_HEARTBEAT
 
bool init_failed_ {false}
 
int init_retries_ {0}
 
uint8_t protocol_version_ = -1
 
InternalGPIOPinstatus_pin_ {nullptr}
 
int status_pin_reported_ = -1
 
int reset_pin_reported_ = -1
 
uint32_t last_command_timestamp_ = 0
 
uint32_t last_rx_char_timestamp_ = 0
 
std::string product_ = ""
 
std::vector< TuyaDatapointListenerlisteners_
 
std::vector< TuyaDatapointdatapoints_
 
std::vector< uint8_t > rx_message_
 
std::vector< uint8_t > ignore_mcu_update_on_datapoints_ {}
 
std::vector< TuyaCommandcommand_queue_
 
optional< TuyaCommandTypeexpected_response_ {}
 
uint8_t wifi_status_ = -1
 
CallbackManager< void()> initialized_callback_ {}
 
- 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}
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 88 of file tuya.h.

Member Function Documentation

◆ add_ignore_mcu_update_on_datapoints()

void esphome::tuya::Tuya::add_ignore_mcu_update_on_datapoints ( uint8_t  ignore_mcu_update_on_datapoints)
inline

Definition at line 112 of file tuya.h.

◆ add_on_initialized_callback()

void esphome::tuya::Tuya::add_on_initialized_callback ( std::function< void()>  callback)
inline

Definition at line 115 of file tuya.h.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 40 of file tuya.cpp.

◆ force_set_bitmask_datapoint_value()

void esphome::tuya::Tuya::force_set_bitmask_datapoint_value ( uint8_t  datapoint_id,
uint32_t  value,
uint8_t  length 
)

Definition at line 609 of file tuya.cpp.

◆ force_set_boolean_datapoint_value()

void esphome::tuya::Tuya::force_set_boolean_datapoint_value ( uint8_t  datapoint_id,
bool  value 
)

Definition at line 593 of file tuya.cpp.

◆ force_set_enum_datapoint_value()

void esphome::tuya::Tuya::force_set_enum_datapoint_value ( uint8_t  datapoint_id,
uint8_t  value 
)

Definition at line 605 of file tuya.cpp.

◆ force_set_integer_datapoint_value()

void esphome::tuya::Tuya::force_set_integer_datapoint_value ( uint8_t  datapoint_id,
uint32_t  value 
)

Definition at line 597 of file tuya.cpp.

◆ force_set_raw_datapoint_value()

void esphome::tuya::Tuya::force_set_raw_datapoint_value ( uint8_t  datapoint_id,
const std::vector< uint8_t > &  value 
)

Definition at line 589 of file tuya.cpp.

◆ force_set_string_datapoint_value()

void esphome::tuya::Tuya::force_set_string_datapoint_value ( uint8_t  datapoint_id,
const std::string &  value 
)

Definition at line 601 of file tuya.cpp.

◆ get_datapoint_()

optional< TuyaDatapoint > esphome::tuya::Tuya::get_datapoint_ ( uint8_t  datapoint_id)
protected

Definition at line 613 of file tuya.cpp.

◆ get_init_state()

TuyaInitState esphome::tuya::Tuya::get_init_state ( )

Definition at line 711 of file tuya.cpp.

◆ get_setup_priority()

float esphome::tuya::Tuya::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 90 of file tuya.h.

◆ get_wifi_rssi_()

uint8_t esphome::tuya::Tuya::get_wifi_rssi_ ( )
protected

Definition at line 517 of file tuya.cpp.

◆ get_wifi_status_code_()

uint8_t esphome::tuya::Tuya::get_wifi_status_code_ ( )
protected

Definition at line 496 of file tuya.cpp.

◆ handle_char_()

void esphome::tuya::Tuya::handle_char_ ( uint8_t  c)
protected

Definition at line 133 of file tuya.cpp.

◆ handle_command_()

void esphome::tuya::Tuya::handle_command_ ( uint8_t  command,
uint8_t  version,
const uint8_t *  buffer,
size_t  len 
)
protected

Definition at line 142 of file tuya.cpp.

◆ handle_datapoints_()

void esphome::tuya::Tuya::handle_datapoints_ ( const uint8_t *  buffer,
size_t  len 
)
protected

Definition at line 307 of file tuya.cpp.

◆ loop()

void esphome::tuya::Tuya::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 31 of file tuya.cpp.

◆ process_command_queue_()

void esphome::tuya::Tuya::process_command_queue_ ( )
protected

Definition at line 451 of file tuya.cpp.

◆ register_listener()

void esphome::tuya::Tuya::register_listener ( uint8_t  datapoint_id,
const std::function< void(TuyaDatapoint)> &  func 
)

Definition at line 697 of file tuya.cpp.

◆ send_command_()

void esphome::tuya::Tuya::send_command_ ( const TuyaCommand command)
protected

Definition at line 482 of file tuya.cpp.

◆ send_datapoint_command_()

void esphome::tuya::Tuya::send_datapoint_command_ ( uint8_t  datapoint_id,
TuyaDatapointType  datapoint_type,
std::vector< uint8_t >  data 
)
protected

Definition at line 686 of file tuya.cpp.

◆ send_empty_command_()

void esphome::tuya::Tuya::send_empty_command_ ( TuyaCommandType  command)
protected

Definition at line 487 of file tuya.cpp.

◆ send_local_time_()

void esphome::tuya::Tuya::send_local_time_ ( )
protected

Definition at line 539 of file tuya.cpp.

◆ send_raw_command_()

void esphome::tuya::Tuya::send_raw_command_ ( TuyaCommand  command)
protected

Definition at line 414 of file tuya.cpp.

◆ send_wifi_status_()

void esphome::tuya::Tuya::send_wifi_status_ ( )
protected

Definition at line 526 of file tuya.cpp.

◆ set_bitmask_datapoint_value()

void esphome::tuya::Tuya::set_bitmask_datapoint_value ( uint8_t  datapoint_id,
uint32_t  value,
uint8_t  length 
)

Definition at line 585 of file tuya.cpp.

◆ set_boolean_datapoint_value()

void esphome::tuya::Tuya::set_boolean_datapoint_value ( uint8_t  datapoint_id,
bool  value 
)

Definition at line 569 of file tuya.cpp.

◆ set_enum_datapoint_value()

void esphome::tuya::Tuya::set_enum_datapoint_value ( uint8_t  datapoint_id,
uint8_t  value 
)

Definition at line 581 of file tuya.cpp.

◆ set_integer_datapoint_value()

void esphome::tuya::Tuya::set_integer_datapoint_value ( uint8_t  datapoint_id,
uint32_t  value 
)

Definition at line 573 of file tuya.cpp.

◆ set_numeric_datapoint_value_()

void esphome::tuya::Tuya::set_numeric_datapoint_value_ ( uint8_t  datapoint_id,
TuyaDatapointType  datapoint_type,
uint32_t  value,
uint8_t  length,
bool  forced 
)
protected

Definition at line 621 of file tuya.cpp.

◆ set_raw_datapoint_value()

void esphome::tuya::Tuya::set_raw_datapoint_value ( uint8_t  datapoint_id,
const std::vector< uint8_t > &  value 
)

Definition at line 565 of file tuya.cpp.

◆ set_raw_datapoint_value_()

void esphome::tuya::Tuya::set_raw_datapoint_value_ ( uint8_t  datapoint_id,
const std::vector< uint8_t > &  value,
bool  forced 
)
protected

Definition at line 652 of file tuya.cpp.

◆ set_status_pin()

void esphome::tuya::Tuya::set_status_pin ( InternalGPIOPin status_pin)
inline

Definition at line 98 of file tuya.h.

◆ set_status_pin_()

void esphome::tuya::Tuya::set_status_pin_ ( )
protected

Definition at line 491 of file tuya.cpp.

◆ set_string_datapoint_value()

void esphome::tuya::Tuya::set_string_datapoint_value ( uint8_t  datapoint_id,
const std::string &  value 
)

Definition at line 577 of file tuya.cpp.

◆ set_string_datapoint_value_()

void esphome::tuya::Tuya::set_string_datapoint_value_ ( uint8_t  datapoint_id,
const std::string &  value,
bool  forced 
)
protected

Definition at line 667 of file tuya.cpp.

◆ set_time_id()

void esphome::tuya::Tuya::set_time_id ( time::RealTimeClock time_id)
inline

Definition at line 110 of file tuya.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 24 of file tuya.cpp.

◆ validate_message_()

bool esphome::tuya::Tuya::validate_message_ ( )
protected

Definition at line 77 of file tuya.cpp.

Field Documentation

◆ command_queue_

std::vector<TuyaCommand> esphome::tuya::Tuya::command_queue_
protected

Definition at line 159 of file tuya.h.

◆ datapoints_

std::vector<TuyaDatapoint> esphome::tuya::Tuya::datapoints_
protected

Definition at line 156 of file tuya.h.

◆ expected_response_

optional<TuyaCommandType> esphome::tuya::Tuya::expected_response_ {}
protected

Definition at line 160 of file tuya.h.

◆ ignore_mcu_update_on_datapoints_

std::vector<uint8_t> esphome::tuya::Tuya::ignore_mcu_update_on_datapoints_ {}
protected

Definition at line 158 of file tuya.h.

◆ init_failed_

bool esphome::tuya::Tuya::init_failed_ {false}
protected

Definition at line 146 of file tuya.h.

◆ init_retries_

int esphome::tuya::Tuya::init_retries_ {0}
protected

Definition at line 147 of file tuya.h.

◆ init_state_

TuyaInitState esphome::tuya::Tuya::init_state_ = TuyaInitState::INIT_HEARTBEAT
protected

Definition at line 145 of file tuya.h.

◆ initialized_callback_

CallbackManager<void()> esphome::tuya::Tuya::initialized_callback_ {}
protected

Definition at line 162 of file tuya.h.

◆ last_command_timestamp_

uint32_t esphome::tuya::Tuya::last_command_timestamp_ = 0
protected

Definition at line 152 of file tuya.h.

◆ last_rx_char_timestamp_

uint32_t esphome::tuya::Tuya::last_rx_char_timestamp_ = 0
protected

Definition at line 153 of file tuya.h.

◆ listeners_

std::vector<TuyaDatapointListener> esphome::tuya::Tuya::listeners_
protected

Definition at line 155 of file tuya.h.

◆ product_

std::string esphome::tuya::Tuya::product_ = ""
protected

Definition at line 154 of file tuya.h.

◆ protocol_version_

uint8_t esphome::tuya::Tuya::protocol_version_ = -1
protected

Definition at line 148 of file tuya.h.

◆ reset_pin_reported_

int esphome::tuya::Tuya::reset_pin_reported_ = -1
protected

Definition at line 151 of file tuya.h.

◆ rx_message_

std::vector<uint8_t> esphome::tuya::Tuya::rx_message_
protected

Definition at line 157 of file tuya.h.

◆ status_pin_

InternalGPIOPin* esphome::tuya::Tuya::status_pin_ {nullptr}
protected

Definition at line 149 of file tuya.h.

◆ status_pin_reported_

int esphome::tuya::Tuya::status_pin_reported_ = -1
protected

Definition at line 150 of file tuya.h.

◆ time_id_

time::RealTimeClock* esphome::tuya::Tuya::time_id_ {nullptr}
protected

Definition at line 142 of file tuya.h.

◆ time_sync_callback_registered_

bool esphome::tuya::Tuya::time_sync_callback_registered_ {false}
protected

Definition at line 143 of file tuya.h.

◆ wifi_status_

uint8_t esphome::tuya::Tuya::wifi_status_ = -1
protected

Definition at line 161 of file tuya.h.


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