ESPHome  2023.3.1
tuya.h
Go to the documentation of this file.
1 #pragma once
2 
4 #include "esphome/core/defines.h"
5 #include "esphome/core/helpers.h"
7 
8 #ifdef USE_TIME
10 #endif
11 
12 #include <vector>
13 
14 namespace esphome {
15 namespace tuya {
16 
17 enum class TuyaDatapointType : uint8_t {
18  RAW = 0x00, // variable length
19  BOOLEAN = 0x01, // 1 byte (0/1)
20  INTEGER = 0x02, // 4 byte
21  STRING = 0x03, // variable length
22  ENUM = 0x04, // 1 byte
23  BITMASK = 0x05, // 1/2/4 bytes
24 };
25 
26 struct TuyaDatapoint {
27  uint8_t id;
29  size_t len;
30  union {
31  bool value_bool;
32  int value_int;
33  uint32_t value_uint;
34  uint8_t value_enum;
35  uint32_t value_bitmask;
36  };
37  std::string value_string;
38  std::vector<uint8_t> value_raw;
39 };
40 
42  uint8_t datapoint_id;
43  std::function<void(TuyaDatapoint)> on_datapoint;
44 };
45 
46 enum class TuyaCommandType : uint8_t {
47  HEARTBEAT = 0x00,
48  PRODUCT_QUERY = 0x01,
49  CONF_QUERY = 0x02,
50  WIFI_STATE = 0x03,
51  WIFI_RESET = 0x04,
52  WIFI_SELECT = 0x05,
53  DATAPOINT_DELIVER = 0x06,
54  DATAPOINT_REPORT = 0x07,
55  DATAPOINT_QUERY = 0x08,
56  WIFI_TEST = 0x0E,
57  LOCAL_TIME_QUERY = 0x1C,
58  WIFI_RSSI = 0x24,
59  VACUUM_MAP_UPLOAD = 0x28,
60  GET_NETWORK_STATUS = 0x2B,
61 };
62 
63 enum class TuyaInitState : uint8_t {
64  INIT_HEARTBEAT = 0x00,
66  INIT_CONF,
67  INIT_WIFI,
69  INIT_DONE,
70 };
71 
72 struct TuyaCommand {
74  std::vector<uint8_t> payload;
75 };
76 
77 class Tuya : public Component, public uart::UARTDevice {
78  public:
79  float get_setup_priority() const override { return setup_priority::LATE; }
80  void setup() override;
81  void loop() override;
82  void dump_config() override;
83  void register_listener(uint8_t datapoint_id, const std::function<void(TuyaDatapoint)> &func);
84  void set_raw_datapoint_value(uint8_t datapoint_id, const std::vector<uint8_t> &value);
85  void set_boolean_datapoint_value(uint8_t datapoint_id, bool value);
86  void set_integer_datapoint_value(uint8_t datapoint_id, uint32_t value);
87  void set_status_pin(InternalGPIOPin *status_pin) { this->status_pin_ = status_pin; }
88  void set_string_datapoint_value(uint8_t datapoint_id, const std::string &value);
89  void set_enum_datapoint_value(uint8_t datapoint_id, uint8_t value);
90  void set_bitmask_datapoint_value(uint8_t datapoint_id, uint32_t value, uint8_t length);
91  void force_set_raw_datapoint_value(uint8_t datapoint_id, const std::vector<uint8_t> &value);
92  void force_set_boolean_datapoint_value(uint8_t datapoint_id, bool value);
93  void force_set_integer_datapoint_value(uint8_t datapoint_id, uint32_t value);
94  void force_set_string_datapoint_value(uint8_t datapoint_id, const std::string &value);
95  void force_set_enum_datapoint_value(uint8_t datapoint_id, uint8_t value);
96  void force_set_bitmask_datapoint_value(uint8_t datapoint_id, uint32_t value, uint8_t length);
97  TuyaInitState get_init_state();
98 #ifdef USE_TIME
99  void set_time_id(time::RealTimeClock *time_id) { this->time_id_ = time_id; }
100 #endif
101  void add_ignore_mcu_update_on_datapoints(uint8_t ignore_mcu_update_on_datapoints) {
102  this->ignore_mcu_update_on_datapoints_.push_back(ignore_mcu_update_on_datapoints);
103  }
104  void add_on_initialized_callback(std::function<void()> callback) {
105  this->initialized_callback_.add(std::move(callback));
106  }
107 
108  protected:
109  void handle_char_(uint8_t c);
110  void handle_datapoints_(const uint8_t *buffer, size_t len);
111  optional<TuyaDatapoint> get_datapoint_(uint8_t datapoint_id);
112  bool validate_message_();
113 
114  void handle_command_(uint8_t command, uint8_t version, const uint8_t *buffer, size_t len);
115  void send_raw_command_(TuyaCommand command);
116  void process_command_queue_();
117  void send_command_(const TuyaCommand &command);
118  void send_empty_command_(TuyaCommandType command);
119  void set_numeric_datapoint_value_(uint8_t datapoint_id, TuyaDatapointType datapoint_type, uint32_t value,
120  uint8_t length, bool forced);
121  void set_string_datapoint_value_(uint8_t datapoint_id, const std::string &value, bool forced);
122  void set_raw_datapoint_value_(uint8_t datapoint_id, const std::vector<uint8_t> &value, bool forced);
123  void send_datapoint_command_(uint8_t datapoint_id, TuyaDatapointType datapoint_type, std::vector<uint8_t> data);
124  void set_status_pin_();
125  void send_wifi_status_();
126  uint8_t get_wifi_status_code_();
127  uint8_t get_wifi_rssi_();
128 
129 #ifdef USE_TIME
130  void send_local_time_();
132 #endif
134  bool init_failed_{false};
135  int init_retries_{0};
136  uint8_t protocol_version_ = -1;
138  int status_pin_reported_ = -1;
139  int reset_pin_reported_ = -1;
140  uint32_t last_command_timestamp_ = 0;
141  uint32_t last_rx_char_timestamp_ = 0;
142  std::string product_ = "";
143  std::vector<TuyaDatapointListener> listeners_;
144  std::vector<TuyaDatapoint> datapoints_;
145  std::vector<uint8_t> rx_message_;
146  std::vector<uint8_t> ignore_mcu_update_on_datapoints_{};
147  std::vector<TuyaCommand> command_queue_;
148  optional<TuyaCommandType> expected_response_{};
149  uint8_t wifi_status_ = -1;
150  CallbackManager<void()> initialized_callback_{};
151 };
152 
153 } // namespace tuya
154 } // namespace esphome
void setup()
void loop()
TuyaDatapointType type
Definition: tuya.h:28
TuyaCommandType
Definition: tuya.h:46
float get_setup_priority() const override
Definition: tuya.h:79
The RealTimeClock class exposes common timekeeping functions via the device&#39;s local real-time clock...
const float LATE
For components that should be initialized at the very end of the setup process.
Definition: component.cpp:27
void set_time_id(time::RealTimeClock *time_id)
Definition: tuya.h:99
TuyaDatapointType
Definition: tuya.h:17
std::vector< TuyaDatapointListener > listeners_
Definition: tuya.h:143
void add_on_initialized_callback(std::function< void()> callback)
Definition: tuya.h:104
std::vector< TuyaDatapoint > datapoints_
Definition: tuya.h:144
std::vector< uint8_t > rx_message_
Definition: tuya.h:145
TuyaCommandType cmd
Definition: tuya.h:73
std::string value_string
Definition: tuya.h:37
std::function< void(TuyaDatapoint)> on_datapoint
Definition: tuya.h:43
std::vector< uint8_t > payload
Definition: tuya.h:74
void set_status_pin(InternalGPIOPin *status_pin)
Definition: tuya.h:87
std::string size_t len
Definition: helpers.h:286
Definition: a4988.cpp:4
std::vector< TuyaCommand > command_queue_
Definition: tuya.h:147
TuyaInitState
Definition: tuya.h:63
std::vector< uint8_t > value_raw
Definition: tuya.h:38
void add_ignore_mcu_update_on_datapoints(uint8_t ignore_mcu_update_on_datapoints)
Definition: tuya.h:101