From c448ece6807522c799652b841f4acfacfc8848ef Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Sun, 13 Oct 2024 23:04:28 +0200 Subject: [PATCH] Update the Homeasistant Discovery topics (#3332) Update the Homeassistant Discovery topics --- Changelog.md | 26 ++++++++++++++++++- .../jomjol_flowcontroll/ClassFlowMQTT.cpp | 4 +-- code/components/jomjol_mqtt/server_mqtt.cpp | 18 ++++++++++--- 3 files changed, 42 insertions(+), 6 deletions(-) diff --git a/Changelog.md b/Changelog.md index 84aaf6a7c..150001c6a 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,3 +1,27 @@ +## [16.0.0-RC5] - 2024-10-xx + +For a full list of changes see [Full list of changes](https://github.com/jomjol/AI-on-the-edge-device/compare/v15.7.0...v16.0.0-RC1) + +#### Known issues +Please check the [issues](https://github.com/jomjol/AI-on-the-edge-device/issues) and +[discussions](https://github.com/jomjol/AI-on-the-edge-device/discussions) before reporting a new issue. + +#### Core Changes +Only changes since RC4 are listed: +- Updated the Homeassistant Discovery topics (#3332): + - `raw` has now set the `State Class` to `measurement`. Before it was always set to `""`. + - `value` has now only set the `State Class` to `total_increasing` if the parameter `Allow Negative Rates` is **not** set. Else it uses `measurement` since the rate could also be negative. Before it was always set to `total_increasing`. + - The `rate_per_time_unit` topic of an **Energy** meter needs a `Device Class`=`power`. For `gas` and `water` it should be `volume_flow_rate`. Before it was always set to `""`. + + **:warning: Please check your Homeassistant instance to make sure it is handled correctly!** + +#### Bug Fixes +Only changes since RC3 are listed: + - None + + + + ## [16.0.0-RC4] - 2024-10-06 For a full list of changes see [Full list of changes](https://github.com/jomjol/AI-on-the-edge-device/compare/v15.7.0...v16.0.0-RC1) @@ -7,7 +31,7 @@ Please check the [issues](https://github.com/jomjol/AI-on-the-edge-device/issues [discussions](https://github.com/jomjol/AI-on-the-edge-device/discussions) before reporting a new issue. #### Core Changes -Only changes since RC2 are listed: +Only changes since RC3 are listed: - Update esp32-camera submodule to `v2.0.13` (#3316) - Added contributor list (#3317) - Added files for demo mode (#3315) diff --git a/code/components/jomjol_flowcontroll/ClassFlowMQTT.cpp b/code/components/jomjol_flowcontroll/ClassFlowMQTT.cpp index d798d3eba..83b8ba1d8 100644 --- a/code/components/jomjol_flowcontroll/ClassFlowMQTT.cpp +++ b/code/components/jomjol_flowcontroll/ClassFlowMQTT.cpp @@ -151,7 +151,7 @@ bool ClassFlowMQTT::ReadParameter(FILE* pfile, string& aktparamgraph) mqttServer_setMeterType("water", "L", "h", "L/h"); } else if (toUpper(splitted[1]) == "WATER_FT3") { - mqttServer_setMeterType("water", "ft³", "m", "ft³/m"); // Minutes + mqttServer_setMeterType("water", "ft³", "m", "ft³/m"); // m = Minutes } else if (toUpper(splitted[1]) == "WATER_GAL") { mqttServer_setMeterType("water", "gal", "h", "gal/h"); @@ -160,7 +160,7 @@ bool ClassFlowMQTT::ReadParameter(FILE* pfile, string& aktparamgraph) mqttServer_setMeterType("gas", "m³", "h", "m³/h"); } else if (toUpper(splitted[1]) == "GAS_FT3") { - mqttServer_setMeterType("gas", "ft³", "m", "ft³/m"); // Minutes + mqttServer_setMeterType("gas", "ft³", "m", "ft³/m"); // m = Minutes } else if (toUpper(splitted[1]) == "ENERGY_WH") { mqttServer_setMeterType("energy", "Wh", "h", "W"); diff --git a/code/components/jomjol_mqtt/server_mqtt.cpp b/code/components/jomjol_mqtt/server_mqtt.cpp index fd675a139..33c823f66 100644 --- a/code/components/jomjol_mqtt/server_mqtt.cpp +++ b/code/components/jomjol_mqtt/server_mqtt.cpp @@ -184,13 +184,25 @@ bool MQTThomeassistantDiscovery(int qos) { group = ""; } + /* If "Allow neg. rate" is true, use "measurement" instead of "total_increasing" for the State Class, see https://github.com/jomjol/AI-on-the-edge-device/issues/3331 */ + std::string value_state_class = "total_increasing"; + if ((*NUMBERS)[i]->AllowNegativeRates) { + value_state_class = "measurement"; + } + + /* Energy meters need a different Device Class, see https://github.com/jomjol/AI-on-the-edge-device/issues/3333 */ + std::string rate_device_class = "volume_flow_rate"; + if (meterType == "energy") { + rate_device_class = "power"; + } + // Group | Field | User Friendly Name | Icon | Unit | Device Class | State Class | Entity Category - allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "value", "Value", "gauge", valueUnit, meterType, "total_increasing", "", qos); - allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "raw", "Raw Value", "raw", "", "", "", "diagnostic", qos); + allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "value", "Value", "gauge", valueUnit, meterType, value_state_class, "", qos); // State Class = "total_increasing" if .AllowNegativeRates = false, else use "measurement" + allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "raw", "Raw Value", "raw", valueUnit, meterType, "measurement", "diagnostic", qos); allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "error", "Error", "alert-circle-outline", "", "", "", "diagnostic", qos); /* Not announcing "rate" as it is better to use rate_per_time_unit resp. rate_per_digitization_round */ // allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "rate", "Rate (Unit/Minute)", "swap-vertical", "", "", "", ""); // Legacy, always Unit per Minute - allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "rate_per_time_unit", "Rate (" + rateUnit + ")", "swap-vertical", rateUnit, "", "measurement", "", qos); + allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "rate_per_time_unit", "Rate (" + rateUnit + ")", "swap-vertical", rateUnit, rate_device_class, "measurement", "", qos); allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "rate_per_digitization_round", "Change since last Digitization round", "arrow-expand-vertical", valueUnit, "", "measurement", "", qos); // correctly the Unit is Unit/Interval! allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "timestamp", "Timestamp", "clock-time-eight-outline", "", "timestamp", "", "diagnostic", qos); allSendsSuccessed |= sendHomeAssistantDiscoveryTopic(group, "json", "JSON", "code-json", "", "", "", "diagnostic", qos);