From 5bef606f2ab8974dcdf525e0339d910a03396fe7 Mon Sep 17 00:00:00 2001 From: Maxim Prokhorov Date: Fri, 1 Nov 2019 23:13:51 +0300 Subject: [PATCH] ha: delay discovery until next loop - stack-like discovery struct to store pending mqtt topic and message - use separate json objects for sensor and switch data (different solution for the #1957) --- code/espurna/config/prototypes.h | 1 + code/espurna/homeassistant.ino | 164 ++++++++++++++++++++++++------- 2 files changed, 131 insertions(+), 34 deletions(-) diff --git a/code/espurna/config/prototypes.h b/code/espurna/config/prototypes.h index 3faf1945..27f7f7c1 100644 --- a/code/espurna/config/prototypes.h +++ b/code/espurna/config/prototypes.h @@ -196,6 +196,7 @@ void i2c_read_buffer(uint8_t address, uint8_t * buffer, size_t len); #endif using mqtt_callback_f = std::function; +using mqtt_msg_t = std::pair; void mqttRegister(mqtt_callback_f callback); diff --git a/code/espurna/homeassistant.ino b/code/espurna/homeassistant.ino index 49798791..436abea2 100644 --- a/code/espurna/homeassistant.ino +++ b/code/espurna/homeassistant.ino @@ -8,10 +8,12 @@ Copyright (C) 2017-2019 by Xose Pérez #if HOMEASSISTANT_SUPPORT +#include +#include #include -bool _haEnabled = false; -bool _haSendFlag = false; +bool _ha_enabled = false; +bool _ha_send_flag = false; // ----------------------------------------------------------------------------- // UTILS @@ -52,6 +54,10 @@ const String switchType("light"); const String switchType("switch"); #endif +// ----------------------------------------------------------------------------- +// Shared context object to store entity and entity registry data +// ----------------------------------------------------------------------------- + struct ha_config_t { static const size_t DEFAULT_BUFFER_SIZE = 2048; @@ -84,6 +90,87 @@ struct ha_config_t { const String version; }; +// ----------------------------------------------------------------------------- +// MQTT discovery +// ----------------------------------------------------------------------------- + +struct ha_discovery_t { + + constexpr static const unsigned long SEND_TIMEOUT = 1000; + + ha_discovery_t() { + #if SENSOR_SUPPORT + _messages.reserve(magnitudeCount() + relayCount()); + #else + _messages.reserve(relayCount()); + #endif + } + + // TODO: is this expected behaviour? + void add(String& topic, String& message) { + _messages.emplace_back(std::move(topic), std::move(message)); + } + + // We don't particulary care about the order since names have indexes? + // If we ever do, use iterators to reference elems and pop the String contents instead + mqtt_msg_t& next() { + return _messages.back(); + } + + void pop() { + _messages.pop_back(); + } + + const bool empty() const { + return !_messages.size(); + } + + void prepareSwitches(ha_config_t& config); + #if SENSOR_SUPPORT + void prepareMagnitudes(ha_config_t& config); + #endif + + Ticker timer; + std::vector _messages; + +}; + +std::unique_ptr _ha_discovery = nullptr; + +void _haSendDiscovery() { + + if (!_ha_discovery) return; + + if (_ha_discovery->empty()) { + return; + } + + const unsigned long ts = millis(); + do { + if (_ha_discovery->empty()) break; + + auto& message = _ha_discovery->next(); + if (!mqttSendRaw(message.first.c_str(), message.second.c_str())) { + break; + } + _ha_discovery->pop(); + // XXX: should not reach this timeout, most common case is the break above + } while (millis() - ts < ha_discovery_t::SEND_TIMEOUT); + + mqttSendStatus(); + + if (_ha_discovery->empty()) { + _ha_discovery = nullptr; + } else { + // 2.3.0: Ticker callback arguments are not preserved and once_ms_scheduled is missing + // We need to use global discovery object to reschedule it + // Otherwise, this would've been shared_ptr from _haSend + _ha_discovery->timer.once_ms(ha_discovery_t::SEND_TIMEOUT, []() { + schedule_function(_haSendDiscovery); + }); + } + +} // ----------------------------------------------------------------------------- // SENSORS @@ -99,7 +186,10 @@ void _haSendMagnitude(unsigned char i, JsonObject& config) { config["unit_of_measurement"] = magnitudeUnits(type); } -void _haSendMagnitudes(ha_config_t& config) { +void ha_discovery_t::prepareMagnitudes(ha_config_t& config) { + + // Note: because none of the keys are erased, use a separate object to avoid accidentally sending switch data + JsonObject& root = config.jsonBuffer.createObject(); for (unsigned char i=0; i(); + + // Prepare all of the messages and send them in the scheduled function later + _ha_discovery->prepareSwitches(config); #if SENSOR_SUPPORT - _haSendMagnitudes(config); + _ha_discovery->prepareMagnitudes(config); #endif - _haSendFlag = false; + _ha_send_flag = false; + schedule_function(_haSendDiscovery); } void _haConfigure() { - bool enabled = getSetting("haEnabled", HOMEASSISTANT_ENABLED).toInt() == 1; - _haSendFlag = (enabled != _haEnabled); - _haEnabled = enabled; + const bool enabled = getSetting("haEnabled", HOMEASSISTANT_ENABLED).toInt() == 1; + _ha_send_flag = (enabled != _ha_enabled); + _ha_enabled = enabled; _haSend(); } @@ -430,7 +526,7 @@ void haSetup() { // On MQTT connect check if we have something to send mqttRegister([](unsigned int type, const char * topic, const char * payload) { if (type == MQTT_CONNECT_EVENT) _haSend(); - if (type == MQTT_DISCONNECT_EVENT) _haSendFlag = false; + if (type == MQTT_DISCONNECT_EVENT) _ha_send_flag = false; }); // Main callbacks