Add support for WPE-I (brine/water, no DHW)

address #363

Panel verified against a WPE-I 08 HK 230 Premium: the WPE-I speaks the
same WPM protocol as the WPL models (temperatures, setpoints, heat
curves, energy counters, VERDICHTER_STARTS and efficiency all match the
panel exactly), so the variant builds on wxx_base.yaml and WPE_I joins
the existing property groups.

Properties it shares with other models live in common sections instead
of being repeated:
- WAERMEERTRAG_2WE_HEIZ_SUM_KWH/MWH move to the common block, they are
  served by every family
- WP_WASSERVOLUMENSTROM, REGELABWEICHUNG and LAUFZEIT_VD_HEIZEN move to
  a shared WPE_I/WPL_17 section
- LAUFZEIT_NHZ1, NHZ2 and NHZ1_2 move to a shared WPE_I/WPL_17/WPL_23
  section

What is specific to the WPE-I:
- no integrated DHW, so it includes wxx_base.yaml rather than
  wpl_base.yaml
- 0x02e2 is the water volume flow as on the WPL17, not the WPL13
  WAERMEPUMPEN_STATUS word (raw 280/285 = 28.0/28.5 l/min next to
  VOLUMENSTROM = 27.7 l/min). The WPE-I reports its own status on 0x4eda
  (bit 4 = passive cooling active, verified by switching the pump to
  standby and watching the valve follow) and the plant status arrives as
  a broadcast towards the room unit, so both words are exposed as raw
  sensors and only the verified bits become binary sensors.
- runtime counters, panel exact: LAUFZEIT_VD_HEIZEN 6327 h and
  LAUFZEIT_NHZ1/NHZ2/NHZ1_2 0/0/4 h. LAUFZEIT_VD_KUEHLEN answers 0x8000
  because the WPE-I only cools passively, so it is not exposed.
- MINTEMP/MAXTEMP (HK2) and REGELABWEICHUNG are clamped to their valid
  range with ignore_out_of_range, so the marker words the WPM sends for
  "AUS" (0x9000) and "not available" (0x8000) leave the entity
  unavailable instead of publishing an impossible value

Unlike WPL_13 builds, WPE_I does not shift the Betriebsart raw value by
8 bits: the WPE-I sends PROGRAMMSCHALTER (0x4f1b) as a low byte (raw
0x02 = Programm, verified while the panel showed PROGRAMMBETRIEB).

Author: adrai

components/wp_core/mapper.cpp

@@ -85,7 +85,7 @@ Mapper::Mapper() {
 #if defined(TTF_07_C)
     betriebsartMap = {{0x0000, "Notbetrieb"}, {0x0100, "Bereitschaft"}, {0x0200, "Programm"},
                       {0x0300, "Komfort"},    {0x0400, "Eco"},          {0x0500, "Warmwasser"}};
-#elif defined(WPL_13) || defined(WPL_17) || defined(WPL_23)
+#elif defined(WPL_13) || defined(WPL_17) || defined(WPL_23) || defined(WPE_I)
     betriebsartMap = {{0x00, "Notbetrieb"}, {0x01, "Bereitschaft"}, {0x02, "Programm"},
                       {0x03, "Komfort"},    {0x04, "Eco"},          {0x05, "Warmwasser"}};
 #else

components/wp_core/property.h

@@ -95,6 +95,8 @@ struct Property : public oe32trta::detail::Property {
     PROPERTY(WAERMEERTRAG_HEIZ_TAG_KWH, 0x092f, Type::et_double_val);
     PROPERTY(WAERMEERTRAG_HEIZ_SUM_KWH, 0x0930);
     PROPERTY(WAERMEERTRAG_HEIZ_SUM_MWH, 0x0931, Type::et_double_val);
+    PROPERTY(WAERMEERTRAG_2WE_HEIZ_SUM_KWH, 0x0928);
+    PROPERTY(WAERMEERTRAG_2WE_HEIZ_SUM_MWH, 0x0929, Type::et_double_val);
 
 // =======================================================================
 // 2. THZ & TTF SHARED PROPERTIES
@@ -173,8 +175,6 @@ struct Property : public oe32trta::detail::Property {
     PROPERTY(DRUCK_NIEDERDRUCK, 0x07a7, Type::et_cent_val);
     PROPERTY(WAERMEERTRAG_2WE_WW_SUM_KWH, 0x0924);
     PROPERTY(WAERMEERTRAG_2WE_WW_SUM_MWH, 0x0925, Type::et_double_val);
-    PROPERTY(WAERMEERTRAG_2WE_HEIZ_SUM_KWH, 0x0928);
-    PROPERTY(WAERMEERTRAG_2WE_HEIZ_SUM_MWH, 0x0929, Type::et_double_val);
     PROPERTY(HEIZ_KUEHL_LEISTUNG, 0xc0ee, Type::et_cent_val);
     PROPERTY(ABLUFTFEUCHTE, 0xc0ef);
     PROPERTY(VERDICHTER_STARTS, 0xc0f4);
@@ -271,7 +271,7 @@ struct Property : public oe32trta::detail::Property {
 // =======================================================================
 // 7. WPL VARIANTS
 // =======================================================================
-#if defined(WPL_13) || defined(WPL_17) || defined(WPL_23)
+#if defined(WPL_13) || defined(WPL_17) || defined(WPL_23) || defined(WPE_I)
     PROPERTY(RUECKLAUFTEMP, 0x0016, Type::et_dec_val);
     PROPERTY(MAXRUECKLAUFTEMP, 0x0028, Type::et_dec_val);
     PROPERTY(PUFFERISTTEMPERATUR, 0x0078, Type::et_dec_val);
@@ -341,16 +341,28 @@ struct Property : public oe32trta::detail::Property {
     PROPERTY(FROSTSCHUTZ, 0xfe07, Type::et_dec_val);
 #endif
 
-#if defined(WPL_13) || defined(WPL_17)
+#if defined(WPL_13) || defined(WPL_17) || defined(WPE_I)
     PROPERTY(VERDICHTER_STARTS_K, 0x4ef0);
     PROPERTY(VERDICHTER_STARTS, 0x4ef1);
     PROPERTY(ZEITINTERVALL, 0x4f4d, Type::et_dec_val);
 #endif
 
-#if defined(WPL_17) || defined(WPL_23)
+#if defined(WPE_I) || defined(WPL_17)
+    // 0x02e2 carries the water volume flow on these models, unlike the WPL13
+    // where the same index is the WAERMEPUMPEN_STATUS word (on the WPE-I it was
+    // observed as raw 280/285 = 28.0/28.5 l/min next to VOLUMENSTROM 0x4f47)
+    PROPERTY(WP_WASSERVOLUMENSTROM, 0x02e2, Type::et_dec_val);
+    PROPERTY(REGELABWEICHUNG, 0x033d, Type::et_dec_val);
+    PROPERTY(LAUFZEIT_VD_HEIZEN, 0x4efb);
+#endif
+
+#if defined(WPE_I) || defined(WPL_17) || defined(WPL_23)
     PROPERTY(LAUFZEIT_NHZ1, 0x0259);
     PROPERTY(LAUFZEIT_NHZ2, 0x025a);
     PROPERTY(LAUFZEIT_NHZ1_2, 0x0805);
+#endif
+
+#if defined(WPL_17) || defined(WPL_23)
     PROPERTY(STARTS_ABTAUEN, 0x0806);
     PROPERTY(ZEIT_ABTAUEN, 0x0807);
 #endif
@@ -359,16 +371,22 @@ struct Property : public oe32trta::detail::Property {
     PROPERTY(WAERMEPUMPEN_STATUS, 0x02e2);
 #endif
 
+#if defined(WPE_I)
+    // the WPE-I's Waermepumpen-Status word (broadcast by Kessel, 0x8000 while
+    // in standby). Panel verified bits: 4 = passive cooling active, two of
+    // {2, 13} = Kuehlbetrieb mode / Netzversorgung Inverter.
+    PROPERTY(WAERMEPUMPEN_STATUS, 0x4eda);
+    PROPERTY(EVU_SPERRE_AKTIV, 0x0074);
+#endif
+
 #if defined(WPL_17)
     PROPERTY(MAXIMALE_VORLAUFTEMP_WW, 0x0181, Type::et_dec_val);
-    PROPERTY(WP_WASSERVOLUMENSTROM, 0x02e2, Type::et_dec_val);
     PROPERTY(BIVALENZTEMPERATUR_WW, 0x01ad, Type::et_dec_val);
     PROPERTY(EINSATZGRENZE_HZG, 0x01ae, Type::et_dec_val);
     PROPERTY(EINSATZGRENZE_WW, 0x01af, Type::et_dec_val);
     PROPERTY(AUSSENTEMPERATUR_EINST, 0x01bf, Type::et_dec_val);
     PROPERTY(FESTWERTBETRIEB, 0x01c0, Type::et_dec_val);
     PROPERTY(WW_LERNFUNKTION, 0x027e);
-    PROPERTY(REGELABWEICHUNG, 0x033d, Type::et_dec_val);
     PROPERTY(GRENZE_KUEHLEN, 0x03dc, Type::et_dec_val);
     PROPERTY(VORLAUFANTEIL_HEIZKREIS, 0x049d);
     PROPERTY(SENSORABGLEICH_VORLAUF_WP, 0x0658, Type::et_dec_val);
@@ -422,7 +440,6 @@ struct Property : public oe32trta::detail::Property {
     PROPERTY(INBETRIEBNAHME_NOTBETRIEB, 0x4ef5);
     PROPERTY(WW_SOLLTEMPERATUR, 0x4ef9, Type::et_dec_val);
     PROPERTY(EINGESCHALTETE_STUFEN, 0x4efa);
-    PROPERTY(LAUFZEIT_VD_HEIZEN, 0x4efb);
     PROPERTY(LAUFZEIT_VD_KUEHLEN, 0x4efc);
     PROPERTY(LAUFZEIT_VD_WW, 0x4efd);
     PROPERTY(KUEHLART, 0x4f05);

esp32-standalone.yaml

@@ -130,6 +130,7 @@ packages:
       - "yaml/thz504.yaml"
 #      - "yaml/thz5_5_eco.yaml"
 #      - "yaml/ttf07.yaml"
+#      - "yaml/wpe-i.yaml"
 #      - "yaml/wpl13.yaml"
 #      - "yaml/wpl17.yaml"
 #      - "yaml/wpl23.yaml"

yaml/wpe-i.yaml

@@ -0,0 +1,118 @@
+#########################################
+#                                       #
+#   ESPHome                             #
+#                                       #
+#########################################
+# Stiebel Eltron WPE-I ... H(K) (brine/water, no integrated DHW).
+# Panel-verified on a WPE-I 08 HK 230 Premium. Shares the WPL13 property
+# set except: no Warmwasser energy counters, adds runtime counters, and
+# 0x02e2 is WP_WASSERVOLUMENSTROM (as on WPL17), NOT the WPL13 status
+# word — the WPL13 status-bit binaries are omitted until the WPE-I's
+# real status property is identified.
+esphome:
+  platformio_options:
+    build_flags:
+      - "-DWPE_I"
+  on_boot:
+    - priority: -50
+      then:
+        - lambda: |-
+            // Wärmepumpen-Status word 0x4eda: only panel-verified bits are decoded.
+            // The raw word is exposed as a sensor so the remaining bits can be
+            // identified from recorded history when the pump changes state.
+            CallbackHandler::instance().addCallback(std::make_pair(CanNode::Kessel,Property::kWAERMEPUMPEN_STATUS),[](const SimpleVariant& value){
+              const auto word{static_cast<std::uint16_t>(value)};
+              id(WP_STATUS_RAW).publish_state(word);
+              if (word != 0x8000U) {  // 0x8000 = standby (Bereitschaft)
+                const std::bitset<16U> status_bits{word};
+                id(PASSIVKUEHLUNG_AKTIV).publish_state(status_bits.test(4U));
+              }
+            });
+            // Anlagen-Status word 0x4ecd is broadcast by the pump towards the
+            // room unit and arrives carrying HK2's sender id.
+            CallbackHandler::instance().addCallback(std::make_pair(CanNode::HK2,Property::kBETRIEBS_STATUS),[](const SimpleVariant& value){
+              const auto word{static_cast<std::uint16_t>(value)};
+              const std::bitset<16U> status_bits{word};
+              id(ANLAGE_STATUS_RAW).publish_state(word);
+              id(HEIZKREISPUMPE_2).publish_state(status_bits.test(2U));
+            });
+            // EVU-Sperre-aktiv flag 0x0074, broadcast periodically (Manager id)
+            CallbackHandler::instance().addCallback(std::make_pair(CanNode::Manager,Property::kEVU_SPERRE_AKTIV),[](const SimpleVariant& value){
+              id(EVU_SPERRE_AKTIV).publish_state(static_cast<std::uint16_t>(value) == 1U);
+            });
+    - priority: -100
+      then:
+        - lambda: |-
+            queueRequest(CanNode::Kessel, Property::kWAERMEPUMPEN_STATUS);
+
+#########################################
+#                                       #
+#   Status raw words (diagnostic)       #
+#                                       #
+#########################################
+sensor:
+  - platform: template
+    name: WP_STATUS_RAW
+    id: WP_STATUS_RAW
+    icon: "mdi:numeric"
+    accuracy_decimals: 0
+    update_interval: never
+  - platform: template
+    name: ANLAGE_STATUS_RAW
+    id: ANLAGE_STATUS_RAW
+    icon: "mdi:numeric"
+    accuracy_decimals: 0
+    update_interval: never
+
+  # The WPM answers a setting that is switched off with a marker word instead
+  # of a value (0x9000 shows as "AUS" on the panel, 0x8000 while a value is not
+  # available), which decodes to an impossible temperature. Clamping to the
+  # valid range with ignore_out_of_range drops those readings, so the entity
+  # stays unavailable instead of publishing e.g. -2867.2 °C.
+  - id: !extend MINTEMP
+    filters:
+      - clamp: { min_value: -60.0, max_value: 100.0, ignore_out_of_range: true }
+  - id: !extend MAXTEMP
+    filters:
+      - clamp: { min_value: -60.0, max_value: 100.0, ignore_out_of_range: true }
+  - id: !extend REGELABWEICHUNG
+    filters:
+      - clamp: { min_value: -50.0, max_value: 50.0, ignore_out_of_range: true }
+
+#########################################
+#                                       #
+#   Global variables                    #
+#                                       #
+#########################################
+globals:
+  - id: heat_pump_variant
+    type: std::string
+    initial_value: '"WPE-I"'
+
+#########################################
+#                                       #
+#   Packages                            #
+#                                       #
+#########################################
+
+packages:
+  WXX_BASE:                             !include { file: wxx_base.yaml }
+
+  # 0x02e2 fluctuates with the circulation flow (raw 280/285 = 28.0/28.5 l/min,
+  # consistent with VOLUMENSTROM 0x4f47) — same meaning as on the WPL17
+  WP_WASSERVOLUMENSTROM:                !include { file: templates/wp_generic.yaml, vars: { property: "WP_WASSERVOLUMENSTROM", unit: "l/min", icon: "mdi:water", accuracy_decimals: "1", target: "Heizmodul" }}
+
+  # runtime counters (panel: Info -> Wärmepumpe -> Laufzeit)
+  LAUFZEIT_VD_HEIZEN:                   !include { file: templates/wp_generic.yaml, vars: { property: "LAUFZEIT_VD_HEIZEN", unit: "h", target: "Heizmodul" }}
+  LAUFZEIT_NHZ1:                        !include { file: templates/wp_generic.yaml, vars: { property: "LAUFZEIT_NHZ1", unit: "h", target: "Heizmodul" }}
+  LAUFZEIT_NHZ2:                        !include { file: templates/wp_generic.yaml, vars: { property: "LAUFZEIT_NHZ2", unit: "h", target: "Heizmodul" }}
+  LAUFZEIT_NHZ1_2:                      !include { file: templates/wp_generic.yaml, vars: { property: "LAUFZEIT_NHZ1_2", unit: "h", target: "Heizmodul" }}
+
+  # status binaries decoded from the WPE-I's own status words (panel-verified bits only)
+  PASSIVKUEHLUNG_AKTIV:                 !include { file: templates/wp_binary.yaml, vars: { name: "PASSIVKUEHLUNG_AKTIV" }}
+  HEIZKREISPUMPE_2:                     !include { file: templates/wp_binary.yaml, vars: { name: "HEIZKREISPUMPE_2" }}
+  EVU_SPERRE_AKTIV:                     !include { file: templates/wp_binary.yaml, vars: { name: "EVU_SPERRE_AKTIV" }}
+
+  # further panel-verified values
+  REGELABWEICHUNG:                      !include { file: templates/wp_generic.yaml, vars: { property: "REGELABWEICHUNG", unit: "K", accuracy_decimals: "1", target: "Manager" }}
+  WAERMEERTRAG_2WE_HEIZ_SUMME_MWH:      !include { file: templates/wp_generic_combined.yaml, vars: { sensor_name: "WAERMEERTRAG_2WE_HEIZ_SUMME_MWH" , scaled_property: "WAERMEERTRAG_2WE_HEIZ_SUM_KWH" , property: "WAERMEERTRAG_2WE_HEIZ_SUM_MWH" , unit: "MWh", accuracy_decimals: "3", icon: "mdi:fire" , target: "Heizmodul", state_class: "total_increasing" }}