v3.32

Author: pvtom

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2024 Thomas Heiny, Wolfsburg, Germany
+Copyright (c) 2022-2025 Thomas Heiny, Wolfsburg, Germany
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -160,7 +160,7 @@ or to show the help page
 If everything works properly, you will see something like this:
 
 ```
-rscp2mqtt [3.31]
+rscp2mqtt [3.32]
 E3DC system >192.168.178.111:5033< user: >your E3DC user<
 MQTT broker >localhost:1883< qos = >0< retain = >✗< tls >✗< client id >✗< prefix >e3dc<
 Requesting PVI ✓ | PM (0) | DCB ✓ (1 battery string) | Wallbox ✗ | Interval 2 | Autorefresh ✓ | Raw data ✗ | Logging OFF

RELEASE.md

@@ -1,5 +1,10 @@
 ## Release Notes
 
+### Release v3.32 (02.02.2025)
+
+Features:
+- Issue #9, #96: External PM Energy Data
+
 ### Release v3.31 (26.10.2024)
 
 Bug fixes:

RscpMqttMain.cpp

@@ -22,7 +22,7 @@
 #include <regex>
 #include <mutex>
 
-#define RSCP2MQTT_VERSION       "3.31"
+#define RSCP2MQTT_VERSION       "3.32"
 
 #define AES_KEY_SIZE            32
 #define AES_BLOCK_SIZE          32
@@ -609,13 +609,16 @@ void storeSetupItem(uint32_t container, uint32_t tag, int index, int value) {
 void setupItem(std::vector<RSCP_MQTT::cache_t> & v, char *topic_in, char* payload) {
     char topic[TOPIC_SIZE];
     char value[15];
-    char date[9];
-    char date_in[9];
+    char date[10];
+    char date_in[10];
     time_t rawtime;
     time(&rawtime);
     struct tm *l = localtime(&rawtime);
 
-    sprintf(date, "%.4d%.2d%.2d", l->tm_year + 1900, l->tm_mon + 1, l->tm_mday);
+    if (snprintf(date, sizeof(date), "%.4d%.2d%.2d", l->tm_year + 1900, l->tm_mon + 1, l->tm_mday) >= sizeof(date)) {
+        logMessage(cfg.logfile, (char *)__FILE__, __LINE__, (char *)"setupItem: Buffer overflow\n");
+        return;
+    }
 
     if (sscanf(payload, "%9[^:]:%14[^:]", date_in, value) == 2) {
         if (strcmp(date, date_in)) return;
@@ -926,6 +929,18 @@ void addPrefix(std::vector<RSCP_MQTT::cache_t> & v, char *prefix) {
     return;
 }
 
+// Issue #9
+void correctExternalPM(std::vector<RSCP_MQTT::cache_t> & v, int pm, char *unit, int divisor) {
+    for (std::vector<RSCP_MQTT::cache_t>::iterator it = v.begin(); it != v.end(); ++it) {
+        if (((pm == 0) && (it->tag == TAG_DB_PM_0_POWER)) || ((pm == 1) && (it->tag == TAG_DB_PM_1_POWER))) {
+            if (unit && (!strcmp(unit, UNIT_KWH) || !strcmp(unit, UNIT_WH))) strcpy(it->unit, unit);
+            if ((divisor == 1) || (divisor == 1000)) it->divisor = divisor;
+            if (cfg.verbose) logMessage(cfg.logfile, (char *)__FILE__, __LINE__, (char *)"correctExternalPM pm %d unit >%s< divisor %d topic >%s<\n", pm, it->unit, it->divisor, it->topic);
+        }
+    }
+    return;
+}
+
 int handleImmediately(RscpProtocol *protocol, SRscpValue *response, uint32_t container, int year, int month, int day) {
 #ifdef INFLUXDB
     char buffer[CURL_BUFFER_SIZE];
@@ -2131,7 +2146,10 @@ void handleRaw(RscpProtocol *protocol, SRscpValue *response, uint32_t *cache, in
     if (response->dataType == RSCP::eTypeError) return;
 
     if (!l && (response->dataType != RSCP::eTypeContainer)) {
-        snprintf(topic, TOPIC_SIZE, "raw/%s", tagName(RSCP_TAGS::RscpTagsOverview, response->tag));
+        if (snprintf(topic, TOPIC_SIZE, "raw/%s", tagName(RSCP_TAGS::RscpTagsOverview, response->tag)) >= TOPIC_SIZE) {
+            logMessage(cfg.logfile, (char *)__FILE__, __LINE__, (char *)"handleRaw: Buffer overflow\n");
+            return;
+        }
         if (!cfg.raw_topic_regex || std::regex_match(topic, std::regex(cfg.raw_topic_regex))) publishRaw(protocol, response, topic);
         return;
     }
@@ -3152,6 +3170,19 @@ int main(int argc, char *argv[]) {
                 cfg.raw_mode = true;
             else if (strcasecmp(key, "RAW_TOPIC_REGEX") == 0)
                 cfg.raw_topic_regex = strdup(value);
+// Issue #9 
+            else if (strcasecmp(key, "CORRECT_PM_0_UNIT") == 0) {
+                correctExternalPM(RSCP_MQTT::RscpMqttCache, 0, value, 0);
+            }
+            else if (strcasecmp(key, "CORRECT_PM_0_DIVISOR") == 0) {
+                correctExternalPM(RSCP_MQTT::RscpMqttCache, 0, NULL, atoi(value));
+            }
+            else if (strcasecmp(key, "CORRECT_PM_1_UNIT") == 0) {
+                correctExternalPM(RSCP_MQTT::RscpMqttCache, 1, value, 0);
+            }
+            else if (strcasecmp(key, "CORRECT_PM_1_DIVISOR") == 0) {
+                correctExternalPM(RSCP_MQTT::RscpMqttCache, 1, NULL, atoi(value));
+            }
             else if (strncasecmp(key, "ADD_NEW_REQUEST", strlen("ADD_NEW_REQUEST")) == 0) {
                 int order = 0;
                 int index = -1;

RscpMqttMapping.h

@@ -282,6 +282,21 @@ cache_t cache[] = {
     { TAG_SE_EP_RESERVE, TAG_SE_PARAM_EP_RESERVE_MAX_W, 0, "reserve/max", "", F_FLOAT_2, UNIT_WH, 1, 0, false, false, false },
     { TAG_SE_EP_RESERVE, TAG_SE_PARAM_LAST_SOC, 0, "reserve/last_soc", "", F_FLOAT_1, UNIT_PERCENT, 1, 0, false, false, false },
     // CONTAINER TAG_DB_HISTORY_DATA_...
+    // Issue #9
+    { TAG_DB_HISTORY_DATA_DAY, TAG_DB_PM_0_POWER, 0, "pm_0/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_DAY, TAG_DB_PM_1_POWER, 0, "pm_1/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_DAY, TAG_DB_PM_0_POWER, 1, "yesterday/pm_0/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_DAY, TAG_DB_PM_1_POWER, 1, "yesterday/pm_1/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_WEEK, TAG_DB_PM_0_POWER, 0, "week/pm_0/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_WEEK, TAG_DB_PM_1_POWER, 0, "week/pm_1/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_MONTH, TAG_DB_PM_0_POWER, 0, "month/pm_0/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_MONTH, TAG_DB_PM_1_POWER, 0, "month/pm_1/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_YEAR, TAG_DB_PM_0_POWER, 0, "year/pm_0/energy", "", F_FLOAT_0, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_YEAR, TAG_DB_PM_1_POWER, 0, "year/pm_1/energy", "", F_FLOAT_0, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_DAY, TAG_DB_PM_0_POWER, 1, "day/%d/%d/%d/pm_0/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_DAY, TAG_DB_PM_1_POWER, 1, "day/%d/%d/%d/pm_1/energy", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_YEAR, TAG_DB_PM_0_POWER, 1, "history/%d/pm_0/energy", "", F_FLOAT_0, UNIT_KWH, 1000, 0, false, false, false },
+    { TAG_DB_HISTORY_DATA_YEAR, TAG_DB_PM_1_POWER, 1, "history/%d/pm_1/energy", "", F_FLOAT_0, UNIT_KWH, 1000, 0, false, false, false },
     // TODAY
     { TAG_DB_HISTORY_DATA_DAY, TAG_DB_BAT_POWER_IN, 0, "battery/energy/charge", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },
     { TAG_DB_HISTORY_DATA_DAY, TAG_DB_BAT_POWER_OUT, 0, "battery/energy/discharge", "", F_FLOAT_2, UNIT_KWH, 1000, 0, false, false, false },

TOPICS.md

@@ -127,6 +127,8 @@ All topics are listed with the default prefix "e3dc".
 | Historical Data Grid In Energy "Einspeisung" ** | e3dc/day/<year#>/<month#>/<day#>/grid/energy/in | [kWh] |
 | Historical Data Grid Out Energy "Netzbezug" ** | e3dc/day/<year#>/<month#>/<day#>/grid/energy/out | [kWh] |
 | Historical Data Home Energy ** | e3dc/day/<year#>/<month#>/<day#>/home/energy | [kWh] | 
+| Historical Data External PM 0 Energy ** | e3dc/day/<year#>/<month#>/<day#>/pm_0/energy | [kWh] |
+| Historical Data External PM 1 Energy ** | e3dc/day/<year#>/<month#>/<day#>/pm_1/energy | [kWh] |
 | Historical Data SOC ** | e3dc/day/<year#>/<month#>/<day#>/battery/rsoc | [%] |
 | Historical Data Solar Energy ** | e3dc/day/<year#>/<month#>/<day#>/solar/energy | [kWh] |
 | Home Energy | e3dc/home/energy (today) | [kWh] |
@@ -137,6 +139,8 @@ All topics are listed with the default prefix "e3dc".
 | Month Grid In Energy "Einspeisung" | e3dc/month/grid/energy/in | [kWh] |
 | Month Grid Out Energy "Netzbezug" | e3dc/month/grid/energy/out | [kWh] |
 | Month Home Energy | e3dc/month/home/energy | [kWh] |
+| Month External PM 0 Energy | e3dc/month/pm_0/energy | [kWh] | 
+| Month External PM 1 Energy | e3dc/month/pm_1/energy | [kWh] |
 | Month Solar Energy | e3dc/month/solar/energy | [kWh] |
 | PM Active Phase L1 *** | e3dc/pm/active_phases/L1 | (true/false) |
 | PM Active Phase L2 *** | e3dc/pm/active_phases/L2 | (true/false) |
@@ -145,6 +149,8 @@ All topics are listed with the default prefix "e3dc".
 | PM Energy L1 *** | e3dc/pm/energy/L1 | [kWh] |
 | PM Energy L2 *** | e3dc/pm/energy/L2 | [kWh] |
 | PM Energy L3 *** | e3dc/pm/energy/L3 | [kWh] |
+| PM Energy External 0 *** | e3dc/pm_0/energy | [kWh] |
+| PM Energy External 1 ***| e3dc/pm_1/energy | [kWh] |
 | PM Power *** | e3dc/pm/power | [W] |
 | PM Power L1 *** | e3dc/pm/power/L1 | [W] |
 | PM Power L2 *** | e3dc/pm/power/L2 | [W] |
@@ -258,6 +264,8 @@ All topics are listed with the default prefix "e3dc".
 | Week Battery Energy Charge | e3dc/week/battery/energy/charge | [kWh] |
 | Week Consumed Production | e3dc/week/consumed | [%] |
 | Week Energy Discharge | e3dc/week/battery/energy/discharge | [kWh] |
+| Week External PM 0 Energy | e3dc/week/pm_0/energy | [kWh] |
+| Week External PM 1 Energy | e3dc/week/pm_1/energy | [kWh] |
 | Week Grid In Energy "Einspeisung" | e3dc/week/grid/energy/in | [kWh] |
 | Week Grid Out Energy "Netzbezug" | e3dc/week/grid/energy/out | [kWh] |
 | Week Home Energy | e3dc/week/home/energy | [kWh] |
@@ -266,12 +274,16 @@ All topics are listed with the default prefix "e3dc".
 | Year Battery Energy Charge | e3dc/year/battery/energy/charge | [kWh] |
 | Year Consumed Production | e3dc/year/consumed | [%] |
 | Year Energy Discharge | e3dc/year/battery/energy/discharge | [kWh] |
+| Year External PM 0 Energy | e3dc/year/pm_0/energy | [kWh] |
+| Year External PM 1 Energy | e3dc/year/pm_1/energy | [kWh] |
 | Year Grid In Energy "Einspeisung" | e3dc/year/grid/energy/in | [kWh] |
 | Year Grid Out Energy "Netzbezug" | e3dc/year/grid/energy/out | [kWh] |
 | Year History Autarky | e3dc/history/<year#>/autarky | [%] |
 | Year History Battery Energy Charge | e3dc/history/<year#>/battery/energy/charge | [kWh] |
 | Year History Consumed Production | e3dc/history/<year#>/consumed | [%] |
 | Year History Energy Discharge | e3dc/history/<year#>/battery/energy/discharge | [kWh] |
+| Year History External PM 0 Energy | e3dc/history/<year#>/pm_0/energy | [kWh] |
+| Year History External PM 1 Energy | e3dc/history/<year#>/pm_1/energy | [kWh] |
 | Year History Grid In Energy "Einspeisung" | e3dc/history/<year#>/grid/energy/in | [kWh] |
 | Year History Grid Out Energy "Netzbezug" | e3dc/history/<year#>/grid/energy/out | [kWh] |
 | Year History Home Energy | e3dc/history/<year#>/home/energy | [kWh] |
@@ -283,6 +295,8 @@ All topics are listed with the default prefix "e3dc".
 | Yesterday Battery SOC | e3dc/yesterday/battery/rsoc | [%] |
 | Yesterday Consumed Production | e3dc/yesterday/consumed | [%] |
 | Yesterday Energy Discharge | e3dc/yesterday/battery/energy/discharge | [kWh] |
+| Yesterday External PM 0 Energy | e3dc/yesterday/pm_0/energy | [kWh] |
+| Yesterday External PM 1 Energy | e3dc/yesterday/pm_1/energy | [kWh] |
 | Yesterday Grid In Energy "Einspeisung" | e3dc/yesterday/grid/energy/in | [kWh] |
 | Yesterday Grid Out Energy "Netzbezug" | e3dc/yesterday/grid/energy/out | [kWh] |
 | Yesterday Home Energy | e3dc/yesterday/home/energy | [kWh] |
@@ -291,6 +305,7 @@ All topics are listed with the default prefix "e3dc".
 *) If your system has more than one battery string (e.g. S10 Pro), you have to configure the parameter BATTERY_STRINGS accordingly. Battery topics that belong to a battery string are extended by the number of the battery string. Battery modules (DCB topics) are numbered consecutively.
 
 Energy topics are collected for today, yesterday and the current week, month, year and historical years if configured.
+
 **) Historical data for a specific day can be queried by publishing "e3dc/set/request/day".
 
 ***) If more than one power meter exists (PM_INDEX configured multiple times), topics are extended by the number of the power meter

config.template

@@ -70,6 +70,13 @@ PM_EXTERN=false
 PM_INDEX=0
 PM_REQUESTS=true
 
+#-Addon Power Meter
+#--correct unit (Wh or kWh) or divisor (1 or 1000) if the values do not fit
+CORRECT_PM_0_UNIT=Wh
+CORRECT_PM_0_DIVISOR=1
+CORRECT_PM_1_UNIT=kWh
+CORRECT_PM_1_DIVISOR=1000
+
 #-Photovoltaic Inverter
 PVI_REQUESTS=true
 #--Number of PVI strings/trackers (disables the auto detection)