12#ifdef USE_CAPTIVE_PORTAL
19static const char *
const TAG =
"tuya";
20static const int COMMAND_DELAY = 10;
21static const int RECEIVE_TIMEOUT = 300;
22static const int MAX_RETRIES = 5;
41 ESP_LOGCONFIG(TAG,
"Tuya:");
44 ESP_LOGCONFIG(TAG,
" Initialization failed. Current init_state: %u",
static_cast<uint8_t
>(this->
init_state_));
46 ESP_LOGCONFIG(TAG,
" Configuration will be reported when setup is complete. Current init_state: %u",
49 ESP_LOGCONFIG(TAG,
" If no further output is received, confirm that this is a supported Tuya device.");
54 ESP_LOGCONFIG(TAG,
" Datapoint %u: raw (value: %s)", info.id,
format_hex_pretty(info.value_raw).c_str());
56 ESP_LOGCONFIG(TAG,
" Datapoint %u: switch (value: %s)", info.id, ONOFF(info.value_bool));
58 ESP_LOGCONFIG(TAG,
" Datapoint %u: int value (value: %d)", info.id, info.value_int);
60 ESP_LOGCONFIG(TAG,
" Datapoint %u: string value (value: %s)", info.id, info.value_string.c_str());
62 ESP_LOGCONFIG(TAG,
" Datapoint %u: enum (value: %d)", info.id, info.value_enum);
64 ESP_LOGCONFIG(TAG,
" Datapoint %u: bitmask (value: %" PRIx32
")", info.id, info.value_bitmask);
66 ESP_LOGCONFIG(TAG,
" Datapoint %u: unknown", info.id);
70 ESP_LOGCONFIG(TAG,
" GPIO Configuration: status: pin %d, reset: pin %d", this->
status_pin_reported_,
74 ESP_LOGCONFIG(TAG,
" Product: '%s'", this->
product_.c_str());
80 uint8_t new_byte = data[at];
84 return new_byte == 0x55;
87 return new_byte == 0xAA;
91 uint8_t version = data[2];
95 uint8_t command = data[3];
106 uint16_t
length = (uint16_t(data[4]) << 8) | (uint16_t(data[5]));
113 uint8_t rx_checksum = new_byte;
114 uint8_t calc_checksum = 0;
115 for (uint32_t i = 0; i < 6 +
length; i++)
116 calc_checksum += data[i];
118 if (rx_checksum != calc_checksum) {
119 ESP_LOGW(TAG,
"Tuya Received invalid message checksum %02X!=%02X", rx_checksum, calc_checksum);
124 const uint8_t *message_data = data + 6;
125 ESP_LOGV(TAG,
"Received Tuya: CMD=0x%02X VERSION=%u DATA=[%s] INIT_STATE=%u", command, version,
151 switch (command_type) {
153 ESP_LOGV(TAG,
"MCU Heartbeat (0x%02X)", buffer[0]);
155 if (buffer[0] == 0) {
156 ESP_LOGI(TAG,
"MCU restarted");
167 for (
size_t i = 0; i <
len; i++) {
168 if (!std::isprint(buffer[i])) {
174 this->
product_ = std::string(
reinterpret_cast<const char *
>(buffer),
len);
176 this->
product_ = R
"({"p":"INVALID"})";
201 ESP_LOGW(TAG,
"Supplied status_pin does not equals the reported pin %i. TuyaMcu will work in limited mode.",
206 ESP_LOGV(TAG,
"Configured WIFI_STATE periodic send");
220 const bool is_select = (
len >= 1);
227 uint8_t first = 0x00;
228 const char *mode_str =
"EZ";
229 if (is_select && buffer[0] == 0x01) {
245 ESP_LOGI(TAG,
"%s received (%s), replied with WIFI_STATE confirming connection established",
246 is_select ?
"WIFI_SELECT" :
"WIFI_RESET", mode_str);
287 ESP_LOGW(TAG,
"LOCAL_TIME_QUERY is not handled because time is not configured");
293 ESP_LOGW(TAG,
"Vacuum map upload requested, responding that it is not enabled.");
300 ESP_LOGV(TAG,
"Network status requested, reported as %i", wifi_status);
304 uint8_t subcommand = buffer[0];
309 .payload = std::vector<uint8_t>{
311 ESP_LOGV(TAG,
"Reset status notification enabled");
315 ESP_LOGE(TAG,
"EXTENDED_SERVICES::MODULE_RESET is not handled");
319 ESP_LOGE(TAG,
"EXTENDED_SERVICES::UPDATE_IN_PROGRESS is not handled");
323 ESP_LOGE(TAG,
"Invalid extended services subcommand (0x%02X) received", subcommand);
328 ESP_LOGE(TAG,
"Invalid command (0x%02X) received", command);
335 datapoint.
id = buffer[0];
337 datapoint.value_uint = 0;
339 size_t data_size = (buffer[2] << 8) + buffer[3];
340 const uint8_t *data = buffer + 4;
341 size_t data_len =
len - 4;
342 if (data_size > data_len) {
343 ESP_LOGW(TAG,
"Datapoint %u is truncated and cannot be parsed (%zu > %zu)", datapoint.id, data_size, data_len);
347 datapoint.len = data_size;
349 switch (datapoint.type) {
351 datapoint.value_raw = std::vector<uint8_t>(data, data + data_size);
352 ESP_LOGD(TAG,
"Datapoint %u update to %s", datapoint.id,
format_hex_pretty(datapoint.value_raw).c_str());
355 if (data_size != 1) {
356 ESP_LOGW(TAG,
"Datapoint %u has bad boolean len %zu", datapoint.id, data_size);
359 datapoint.value_bool = data[0];
360 ESP_LOGD(TAG,
"Datapoint %u update to %s", datapoint.id, ONOFF(datapoint.value_bool));
363 if (data_size != 4) {
364 ESP_LOGW(TAG,
"Datapoint %u has bad integer len %zu", datapoint.id, data_size);
367 datapoint.value_uint =
encode_uint32(data[0], data[1], data[2], data[3]);
368 ESP_LOGD(TAG,
"Datapoint %u update to %d", datapoint.id, datapoint.value_int);
371 datapoint.value_string = std::string(
reinterpret_cast<const char *
>(data), data_size);
372 ESP_LOGD(TAG,
"Datapoint %u update to %s", datapoint.id, datapoint.value_string.c_str());
375 if (data_size != 1) {
376 ESP_LOGW(TAG,
"Datapoint %u has bad enum len %zu", datapoint.id, data_size);
379 datapoint.value_enum = data[0];
380 ESP_LOGD(TAG,
"Datapoint %u update to %d", datapoint.id, datapoint.value_enum);
388 datapoint.value_bitmask =
encode_uint32(0, 0, data[0], data[1]);
391 datapoint.value_bitmask =
encode_uint32(data[0], data[1], data[2], data[3]);
394 ESP_LOGW(TAG,
"Datapoint %u has bad bitmask len %zu", datapoint.id, data_size);
397 ESP_LOGD(TAG,
"Datapoint %u update to %#08" PRIX32, datapoint.id, datapoint.value_bitmask);
400 ESP_LOGW(TAG,
"Datapoint %u has unknown type %#02hhX", datapoint.id,
static_cast<uint8_t
>(datapoint.type));
404 len -= data_size + 4;
405 buffer = data + data_size;
410 if (datapoint.id == i) {
411 ESP_LOGV(TAG,
"Datapoint %u found in ignore_mcu_update_on_datapoints list, dropping MCU update", datapoint.id);
422 if (other.id == datapoint.id) {
428 this->datapoints_.push_back(datapoint);
433 if (listener.datapoint_id == datapoint.id)
434 listener.on_datapoint(datapoint);
440 uint8_t len_hi = (uint8_t) (command.
payload.size() >> 8);
441 uint8_t len_lo = (uint8_t) (command.
payload.size() & 0xFF);
445 switch (command.
cmd) {
463 ESP_LOGV(TAG,
"Sending Tuya: CMD=0x%02X VERSION=%u DATA=[%s] INIT_STATE=%u",
static_cast<uint8_t
>(command.
cmd),
466 this->
write_array({0x55, 0xAA, version, (uint8_t) command.
cmd, len_hi, len_lo});
470 uint8_t
checksum = 0x55 + 0xAA + (uint8_t) command.
cmd + len_hi + len_lo;
471 for (
auto &data : command.
payload)
489 ESP_LOGE(TAG,
"Initialization failed at init_state %u",
static_cast<uint8_t
>(this->
init_state_));
499 if (delay > COMMAND_DELAY && !this->
command_queue_.empty() && this->rx_message_.empty() &&
500 !this->expected_response_.has_value()) {
532#ifdef USE_CAPTIVE_PORTAL
558 ESP_LOGD(TAG,
"Sending WiFi Status");
565 std::vector<uint8_t> payload;
576 if (day_of_week == 0) {
579 ESP_LOGD(TAG,
"Sending local time");
583 ESP_LOGW(TAG,
"Sending missing local time");
584 payload = std::vector<uint8_t>{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
640 if (datapoint.id == datapoint_id)
647 uint8_t
length,
bool forced) {
648 ESP_LOGD(TAG,
"Setting datapoint %u to %" PRIu32, datapoint_id, value);
651 ESP_LOGW(TAG,
"Setting unknown datapoint %u", datapoint_id);
652 }
else if (datapoint->type != datapoint_type) {
653 ESP_LOGE(TAG,
"Attempt to set datapoint %u with incorrect type", datapoint_id);
655 }
else if (!forced && datapoint->value_uint == value) {
656 ESP_LOGV(TAG,
"Not sending unchanged value");
660 std::vector<uint8_t> data;
663 data.push_back(value >> 24);
664 data.push_back(value >> 16);
666 data.push_back(value >> 8);
668 data.push_back(value >> 0);
671 ESP_LOGE(TAG,
"Unexpected datapoint length %u",
length);
678 ESP_LOGD(TAG,
"Setting datapoint %u to %s", datapoint_id,
format_hex_pretty(value).c_str());
681 ESP_LOGW(TAG,
"Setting unknown datapoint %u", datapoint_id);
683 ESP_LOGE(TAG,
"Attempt to set datapoint %u with incorrect type", datapoint_id);
685 }
else if (!forced && datapoint->value_raw == value) {
686 ESP_LOGV(TAG,
"Not sending unchanged value");
693 ESP_LOGD(TAG,
"Setting datapoint %u to %s", datapoint_id, value.c_str());
696 ESP_LOGW(TAG,
"Setting unknown datapoint %u", datapoint_id);
698 ESP_LOGE(TAG,
"Attempt to set datapoint %u with incorrect type", datapoint_id);
700 }
else if (!forced && datapoint->value_string == value) {
701 ESP_LOGV(TAG,
"Not sending unchanged value");
704 std::vector<uint8_t> data;
705 for (
char const &c : value) {
712 std::vector<uint8_t> buffer;
713 buffer.push_back(datapoint_id);
714 buffer.push_back(
static_cast<uint8_t
>(datapoint_type));
715 buffer.push_back(data.size() >> 8);
716 buffer.push_back(data.size() >> 0);
717 buffer.insert(buffer.end(), data.begin(), data.end());
724 .datapoint_id = datapoint_id,
725 .on_datapoint = func,
731 if (datapoint.id == datapoint_id)
void set_interval(const std::string &name, uint32_t interval, std::function< void()> &&f)
Set an interval function with a unique name.
void set_timeout(const std::string &name, uint32_t timeout, std::function< void()> &&f)
Set a timeout function with a unique name.
virtual void digital_write(bool value)=0
virtual uint8_t get_pin() const =0
void add_on_time_sync_callback(std::function< void()> &&callback)
ESPTime now()
Get the time in the currently defined timezone.
void send_datapoint_command_(uint8_t datapoint_id, TuyaDatapointType datapoint_type, std::vector< uint8_t > data)
void set_string_datapoint_value(uint8_t datapoint_id, const std::string &value)
optional< TuyaDatapoint > get_datapoint_(uint8_t datapoint_id)
void send_empty_command_(TuyaCommandType command)
uint8_t get_wifi_status_code_()
void dump_config() override
time::RealTimeClock * time_id_
CallbackManager< void()> initialized_callback_
void set_boolean_datapoint_value(uint8_t datapoint_id, bool value)
TuyaInitState init_state_
void set_raw_datapoint_value_(uint8_t datapoint_id, const std::vector< uint8_t > &value, bool forced)
InternalGPIOPin * status_pin_
void force_set_raw_datapoint_value(uint8_t datapoint_id, const std::vector< uint8_t > &value)
uint8_t protocol_version_
void set_string_datapoint_value_(uint8_t datapoint_id, const std::string &value, bool forced)
void force_set_integer_datapoint_value(uint8_t datapoint_id, uint32_t value)
uint32_t last_rx_char_timestamp_
void process_command_queue_()
uint32_t last_command_timestamp_
std::vector< TuyaDatapointListener > listeners_
std::vector< TuyaCommand > command_queue_
std::vector< TuyaDatapoint > datapoints_
std::vector< uint8_t > ignore_mcu_update_on_datapoints_
std::vector< uint8_t > rx_message_
void handle_command_(uint8_t command, uint8_t version, const uint8_t *buffer, size_t len)
void set_enum_datapoint_value(uint8_t datapoint_id, uint8_t value)
void set_numeric_datapoint_value_(uint8_t datapoint_id, TuyaDatapointType datapoint_type, uint32_t value, uint8_t length, bool forced)
TuyaInitState get_init_state()
void register_listener(uint8_t datapoint_id, const std::function< void(TuyaDatapoint)> &func)
void handle_char_(uint8_t c)
void force_set_bitmask_datapoint_value(uint8_t datapoint_id, uint32_t value, uint8_t length)
void handle_datapoints_(const uint8_t *buffer, size_t len)
void send_command_(const TuyaCommand &command)
void force_set_boolean_datapoint_value(uint8_t datapoint_id, bool value)
void set_raw_datapoint_value(uint8_t datapoint_id, const std::vector< uint8_t > &value)
optional< TuyaCommandType > expected_response_
void send_raw_command_(TuyaCommand command)
void force_set_enum_datapoint_value(uint8_t datapoint_id, uint8_t value)
void force_set_string_datapoint_value(uint8_t datapoint_id, const std::string &value)
bool time_sync_callback_registered_
void set_bitmask_datapoint_value(uint8_t datapoint_id, uint32_t value, uint8_t length)
void set_integer_datapoint_value(uint8_t datapoint_id, uint32_t value)
bool read_byte(uint8_t *data)
void write_byte(uint8_t data)
void write_array(const uint8_t *data, size_t len)
CaptivePortal * global_captive_portal
bool is_connected()
Return whether the node is connected to the network (through wifi, eth, ...)
TuyaExtendedServicesCommandType
WiFiComponent * global_wifi_component
Providing packet encoding functions for exchanging data with a remote host.
bool remote_is_connected()
Return whether the node has any form of "remote" connection via the API or to an MQTT broker.
std::string format_hex_pretty(const uint8_t *data, size_t length, char separator, bool show_length)
Format a byte array in pretty-printed, human-readable hex format.
constexpr uint32_t encode_uint32(uint8_t byte1, uint8_t byte2, uint8_t byte3, uint8_t byte4)
Encode a 32-bit value given four bytes in most to least significant byte order.
void IRAM_ATTR HOT delay(uint32_t ms)
uint32_t IRAM_ATTR HOT millis()
A more user-friendly version of struct tm from time.h.
uint8_t minute
minutes after the hour [0-59]
uint8_t second
seconds after the minute [0-60]
uint8_t hour
hours since midnight [0-23]
bool is_valid() const
Check if this ESPTime is valid (all fields in range and year is greater than 2018)
uint8_t day_of_month
day of the month [1-31]
uint8_t month
month; january=1 [1-12]
uint8_t day_of_week
day of the week; sunday=1 [1-7]
std::vector< uint8_t > payload