Merge pull request #470 from dontsovcmc/mqtt_ha_spec

MQTT: честный статус, автообнаружение HA по спецификации

Author: dontsovcmc

ESP8266/plan/tests_plan.md

@@ -359,6 +359,10 @@ jobs:
 - `test_ha` — допустимые пары `device_class` + `unit_of_measurement`. HA молча
   выбрасывает сущность с недопустимой парой: сенсор не появляется, ошибка
   видна только в логе самого HA (#356)
+- `test_discovery` — когда переотправлять автообнаружение HA и какие сущности
+  нужны входу. Отпечаток обязан меняться от каждого поля, из которого собраны
+  конфиги: иначе смена пропадёт до нажатия кнопки. Ненужные сущности входа
+  прошивка удаляет, поэтому ошибка в списке стирает из HA живую сущность
 - `test_idle` — режим "выходить на связь только при расходе" (#361):
   обнаружение расхода, решение включать ли Wi-Fi, отметка "устройство живо"
   раз в трое суток и интервал, который уезжает на сервер вместо периода

ESP8266/src/core/discovery.cpp

@@ -0,0 +1,58 @@
+#include "discovery.h"
+#include "types.h"
+
+namespace
+{
+    // FNV-1a, 32 бита
+    const uint32_t FNV_OFFSET = 2166136261u;
+    const uint32_t FNV_PRIME = 16777619u;
+
+    uint32_t mix_byte(uint32_t hash, uint8_t byte)
+    {
+        return (hash ^ byte) * FNV_PRIME;
+    }
+
+    // С завершающим нулём: иначе "ab"+"c" и "a"+"bc" дали бы одно и то же
+    uint32_t mix_string(uint32_t hash, const char *s)
+    {
+        if (s != nullptr)
+        {
+            for (; *s; ++s)
+                hash = mix_byte(hash, (uint8_t)*s);
+        }
+        return mix_byte(hash, 0);
+    }
+}
+
+uint32_t discovery_signature(const DiscoveryState &state)
+{
+    uint32_t hash = FNV_OFFSET;
+
+    hash = mix_string(hash, state.firmware);
+    hash = mix_byte(hash, state.attiny_version);
+    hash = mix_byte(hash, state.model);
+    hash = mix_byte(hash, state.counter_type0);
+    hash = mix_byte(hash, state.counter_type1);
+    hash = mix_byte(hash, state.counter_name0);
+    hash = mix_byte(hash, state.counter_name1);
+    hash = mix_string(hash, state.topic);
+    hash = mix_string(hash, state.discovery_topic);
+
+    return hash == 0 ? 1 : hash;
+}
+
+bool channel_entity_wanted(uint8_t counter_type, ChannelEntity entity)
+{
+    switch (entity)
+    {
+    case ChannelEntity::INPUT_TYPE:
+        // Иначе включить выключенный вход из HA было бы нечем
+        return true;
+    case ChannelEntity::RETIRED:
+        return false;
+    case ChannelEntity::WET:
+        return counter_type == CounterType::LEAKAGE || counter_type == CounterType::LEAKAGE_NC;
+    default:
+        return counts_impulses(counter_type);
+    }
+}

ESP8266/src/core/discovery.h

@@ -0,0 +1,53 @@
+#ifndef _WATERIUS_CORE_DISCOVERY_h
+#define _WATERIUS_CORE_DISCOVERY_h
+
+/*
+Автообнаружение Home Assistant: когда его публиковать и из чего оно состоит.
+
+Устройство спит и не слышит `homeassistant/status`, поэтому переслать конфиги
+по просьбе HA не может. Вместо этого оно помнит отпечаток опубликованного и
+публикует заново, как только отпечаток разошёлся с текущим состоянием.
+
+Часть чистого ядра src/core: без Arduino.h.
+*/
+
+#include <stdint.h>
+
+// То, от чего зависит содержимое конфигов
+struct DiscoveryState
+{
+    const char *firmware;       // FIRMWARE_VERSION: набор сущностей и sw_version
+    uint8_t attiny_version;     // тоже в sw_version
+    uint8_t model;
+    uint8_t counter_type0;
+    uint8_t counter_type1;
+    uint8_t counter_name0;
+    uint8_t counter_name1;
+    const char *topic;          // stat_t и cmd_t сущностей
+    const char *discovery_topic;
+};
+
+// Ноль не возвращает никогда: им в настройках помечено «ничего не опубликовано»
+uint32_t discovery_signature(const DiscoveryState &state);
+
+// Группы сущностей входа
+enum class ChannelEntity : uint8_t
+{
+    INPUT_TYPE,     // ctype
+    WET,            // alarm_wet
+    READINGS,       // chN: sensor и number
+    SERIAL_NUMBER,
+    FACTOR,
+    RESOURCE,       // cname
+    ALARM_CONFIG,   // av, ar, ah, as
+    ALARM_STATE,    // alarm_flow, alarm_leak, alarm_stop
+    RETIRED,        // af, al: были в сборках dev 2.0.47, у брокеров могли остаться
+};
+
+/*
+Нужна ли сущность входу такого типа. Ненужную прошивка не пропускает, а
+удаляет у брокера: иначе после смены типа она осталась бы в HA навсегда.
+*/
+bool channel_entity_wanted(uint8_t counter_type, ChannelEntity entity);
+
+#endif

ESP8266/src/core/types.h

@@ -579,11 +579,18 @@ struct Settings
     */
     uint8_t alarm_confirm = CONFIRM_ANY;
 
+    /*
+    Отпечаток опубликованного автообнаружения (core/discovery.h). Ноль -
+    ничего не опубликовано: так поле приезжает у прошитых устройств, и первый
+    же сеанс после обновления переотправит конфиги.
+    */
+    uint32_t discovery_signature = 0;
+
     /*
     Зарезервируем кучу места, чтобы не писать конвертер конфигураций.
     Будет актуально для On-the-Air обновлений
     */
-    uint8_t reserved9[31] = {0};
+    uint8_t reserved9[27] = {0};
 
 }; // 960 байт
 

ESP8266/src/ha/publish.cpp

@@ -1,156 +1,47 @@
 #include "publish.h"
 #include "Logging.h"
-#include "setup.h"
 #include <PubSubClient.h>
-#include <ArduinoJson.h>
-
-extern Settings sett;
 
 /**
- * @brief Публикация топика в MQTT в различных режимах
+ * @brief Публикация топика в MQTT
  *
- * @param mqtt_client клиент MQTT
- * @param topic строка с топиком
- * @param payload содержимое топика
- * @param mode режим публикации, режим по умолчанию PUBLISH_MODE_BIG
- */
-void publish(PubSubClient &mqtt_client, const String &topic, const String &payload, const int mode)
-{
-    switch (mode)
-    {
-    case PUBLISH_MODE_SIMPLE:
-        publish_simple(mqtt_client, topic, payload);
-        break;
-    case PUBLISH_MODE_CHUNKED:
-        publish_chunked(mqtt_client, topic, payload);
-        break;
-    case PUBLISH_MODE_BIG:
-    default:
-        publish_big(mqtt_client, topic, payload);
-    }
-}
-
-/**
- * @brief Публикация топика в MQTT по частям,
- * используется в случае если очень много информации
+ * Без промежуточного буфера: сообщение может быть больше буфера клиента.
+ * QoS 0, поэтому «опубликовано» значит «записано в сокет целиком» -
+ * подтверждения от брокера нет. endPublish у PubSubClient 2.8 всегда
+ * возвращает 1, судить о результате по нему нельзя.
  *
  * @param mqtt_client клиент MQTT
  * @param topic строка с топиком
  * @param payload содержимое топика
+ * @param retain флаг retain
+ * @return true сообщение ушло в сокет целиком
  */
-void publish_chunked(PubSubClient &mqtt_client, 
-                     const String &topic, 
-                     const String &payload, 
-                     const unsigned int chunk_size)
+bool publish(PubSubClient &mqtt_client, const String &topic, const String &payload, bool retain)
 {
     LOG_INFO(F("Free memory: ") << ESP.getFreeHeap());
     LOG_INFO(F("MQTT: Publish Topic: ") << topic);
     LOG_INFO(F("MQTT: Payload Size: ") << payload.length());
     LOG_DEBUG(F("MQTT: Payload: ") << payload);
+    LOG_INFO(F("MQTT: Retain: ") << retain);
 
-    unsigned int len = payload.length();
-    const uint8_t *buf = (const uint8_t *)payload.c_str();
-
-    if (mqtt_client.beginPublish(topic.c_str(), len, (bool)sett.mqtt_retain))
+    const unsigned int len = payload.length();
+    if (!mqtt_client.beginPublish(topic.c_str(), len, retain))
     {
-        while (len > 0)
-        {
-            if (len >= chunk_size)
-            {
-                mqtt_client.write(buf, chunk_size);
-                buf += chunk_size;
-                len -= chunk_size;
-                LOG_INFO(F("MQTT: Sended chunk size: ") << chunk_size);
-            }
-            else
-            {
-                mqtt_client.write(buf, len);
-                LOG_INFO(F("MQTT: Sended chunk size: ") << len);
-                break;
-            }
-        }
-        if (mqtt_client.endPublish())
-        {
-            LOG_INFO(F("MQTT: Published succesfully"));
-        }
-        else
-        {
-            LOG_ERROR(F("MQTT: Publish failed"));
-        }
+        LOG_ERROR(F("MQTT: Publish failed: no connection"));
+        return false;
     }
-    else
-    {
-        LOG_ERROR(F("MQTT: Client not connected."));
-    }
-}
-
-/**
- * @brief Публикация топика в MQTT (основной метод)
- * не использует промежуточных буферов,
- * сообщение может иметь размер больше 250 байт
- *
- * @param mqtt_client клиент MQTT
- * @param topic строка с топиком
- * @param payload содержимое топика
- */
-void publish_big(PubSubClient &mqtt_client, 
-                 const String &topic, 
-                 const String &payload)
-{
-    LOG_INFO(F("Free memory: ") << ESP.getFreeHeap());
-    LOG_INFO(F("MQTT: Publish Topic: ") << topic);
-    LOG_INFO(F("MQTT: Payload Size: ") << payload.length());
-    LOG_DEBUG(F("MQTT: Payload: ") << payload);
 
-    unsigned int len = payload.length();
-    LOG_INFO(F("MQTT: Retain: ") << sett.mqtt_retain);
-    if (mqtt_client.beginPublish(topic.c_str(), len, (bool)sett.mqtt_retain))
-    {
-        if (mqtt_client.print(payload.c_str()) == len)
-        {
-            LOG_INFO(F("MQTT: Published succesfully"));
-        }
-        else
-        {
-            LOG_ERROR(F("MQTT: Publish failed"));
-        }
+    const bool sent = mqtt_client.print(payload.c_str()) == len;
+    mqtt_client.endPublish();
 
-        mqtt_client.endPublish();
-    }
-    else
+    if (!sent)
     {
-        LOG_ERROR(F("MQTT: Client not connected."));
+        LOG_ERROR(F("MQTT: Publish failed"));
+        return false;
     }
-}
-/**
- * @brief Публикация топика в MQTT если сообщение меньше 250 символов
- *
- * @param mqtt_client клиент MQTT
- * @param topic строка с топиком
- * @param payload содержимое топика
- */
-void publish_simple(PubSubClient &mqtt_client, const String &topic, const String &payload)
-{
-    LOG_INFO(F("Free memory: ") << ESP.getFreeHeap());
-    LOG_INFO(F("MQTT: Publish Topic: ") << topic);
-    LOG_INFO(F("MQTT: Payload Size: ") << payload.length());
-    LOG_DEBUG(F("MQTT: Payload: ") << payload);
 
-    if (mqtt_client.connected())
-    {
-        if (mqtt_client.publish(topic.c_str(), payload.c_str(), (bool)sett.mqtt_retain))
-        {
-            LOG_INFO(F("MQTT: Published succesfully"));
-        }
-        else
-        {
-            LOG_ERROR(F("MQTT: Publish failed"));
-        }
-    }
-    else
-    {
-        LOG_ERROR(F("MQTT: Client not connected."));
-    }
+    LOG_INFO(F("MQTT: Published succesfully"));
+    return true;
 }
 
 /**
@@ -162,13 +53,16 @@ void publish_simple(PubSubClient &mqtt_client, const String &topic, const String
  *
  * @param mqtt_client клиент MQTT
  * @param topic строка с топиком
+ * @return true пустое сообщение ушло
  */
-void clear_retained(PubSubClient &mqtt_client, const String &topic)
+bool clear_retained(PubSubClient &mqtt_client, const String &topic)
 {
     LOG_INFO(F("MQTT: Remove retain message: ") << topic);
 
     if (!mqtt_client.publish(topic.c_str(), "", true))
     {
         LOG_ERROR(F("MQTT: Publish failed"));
+        return false;
     }
+    return true;
 }

ESP8266/src/ha/publish.h

@@ -11,18 +11,8 @@
 #define HA_PUBLISH_H_
 
 #include <PubSubClient.h>
-#include <ArduinoJson.h>
 
-#define MQTT_CHUNK_SIZE 128
-#define PUBLISH_MODE_BIG 0
-#define PUBLISH_MODE_CHUNKED 1
-#define PUBLISH_MODE_SIMPLE 2
-#define DEFAULT_PUBLISH_MODE PUBLISH_MODE_BIG
-
-extern void publish(PubSubClient &mqtt_client, const String &topic, const String &payload, const int mode = DEFAULT_PUBLISH_MODE);
-extern void publish_big(PubSubClient &mqtt_client, const String &topic, const String &payload);
-extern void publish_simple(PubSubClient &mqtt_client, const String &topic, const String &payload);
-extern void publish_chunked(PubSubClient &mqtt_client, const String &topic, const String &payload, const unsigned int chunk_size=MQTT_CHUNK_SIZE);
-extern void clear_retained(PubSubClient &mqtt_client, const String &topic);
+extern bool publish(PubSubClient &mqtt_client, const String &topic, const String &payload, bool retain);
+extern bool clear_retained(PubSubClient &mqtt_client, const String &topic);
 
 #endif