adapted documentation to new attribute

tspopp · Aug 17, 2024 · 932948d · 932948d
1 parent a89d77d
commit 932948d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 10 deletions.
diff --git a/MQTT.md b/MQTT.md
@@ -87,16 +87,17 @@ Using the prefix, the `$root` topic is created, which is `$prefix/aquamqtt/` and
 
 ### Energy Message
 
-| Value                         | MQTT Topic                           | Format | Unit | Other Information                                                                                          |
-|-------------------------------|--------------------------------------|--------|------|------------------------------------------------------------------------------------------------------------|
-| Total Heatpump Hours          | `$root/energy/totalHeatpumpHours`    | uint32 | h    | retained                                                                                                   |
-| Total Heating Element Hours   | `$root/energy/totalHeatingElemHours` | uint32 | h    | retained                                                                                                   |
-| Total Hours                   | `$root/energy/totalHours`            | uint32 | h    | retained                                                                                                   |
-| Total Energy                  | `$root/energy/totalEnergyWh`         | uint64 | Wh   |                                                                                                            |
+| Value                         | MQTT Topic                           | Format | Unit | Other Information                                                                                  |
+|-------------------------------|--------------------------------------|--------|------|----------------------------------------------------------------------------------------------------|
+| Total Heatpump Hours          | `$root/energy/totalHeatpumpHours`    | uint32 | h    | retained                                                                                           |
+| Total Heating Element Hours   | `$root/energy/totalHeatingElemHours` | uint32 | h    | retained                                                                                           |
+| Total Hours                   | `$root/energy/totalHours`            | uint32 | h    | retained                                                                                           |
+| Total Energy                  | `$root/energy/totalEnergyWh`         | uint64 | Wh   |                                                                                                    |
+| Total Water Consumption       | `$root/energy/waterConsumption`      | uint16 | l    | Note: Expected to wrap-around at UINT16_MAX                                                        |
 | Current Power Heatpump        | `$root/energy/powerHeatpump`         | uint16 | W    | Note: It is possible to define an additional custom mqtt topic for this attribute within `Configuration.h` |
 | Current Power Heating Element | `$root/energy/powerHeatingElem`      | uint16 | W    | Note: It is possible to define an additional custom mqtt topic for this attribute within `Configuration.h` |
-| Current Power Total           | `$root/energy/powerTotal`            | uint16 | W    |                                                                                                            |
-| Raw Message (Debug Mode Only) | `$root/energy/debug`                 | string |      |                                                                                                            |
+| Current Power Total           | `$root/energy/powerTotal`            | uint16 | W    |                                                                                                    |
+| Raw Message (Debug Mode Only) | `$root/energy/debug`                 | string |      |                                                                                                    |
 
 ### Error Messages
 

diff --git a/PROTOCOL.md b/PROTOCOL.md
@@ -488,8 +488,7 @@ Findings...
 | 5           | 0                   | ?                                       | -                 |
 | 6           | 0                   | ?                                       | -                 |
 | 7 - 8       | 221 1               | Power Consumption Total (Both)          | -                 |
-| 9           | 54                  | ?                                       | -                 |
-| 10          | 215                 | ?                                       | -                 |
+| 9 - 10      | 54 215              | Total Water Consumption (l)             | [Ticket](https://github.com/tspopp/AquaMQTT/issues/30)            |
 | 11 - 14     | 231 9 0 0           | Total Operation Hours (Heatpump)        | -                 |
 | 15 - 18     | 24 0 0 0            | Total Operation Hours (Heating Element) | -                 |
 | 19 - 22     | 231 9 0 0           | Total Operation Hours (Both)            | -                 |

diff --git a/aquamqtt.yaml b/aquamqtt.yaml
@@ -224,6 +224,17 @@ mqtt:
         manufacturer: tspopp
         name: AquaMQTT 
         model: V1
+    - name: "Total Water Consumption"
+      state_topic: "aquamqtt/energy/waterConsumption"
+      unit_of_measurement: "l"
+      state_class: total_increasing
+      unique_id: atlantic_state_total_water_consumption
+      icon: mdi:water-pump
+      device:
+        identifiers: AquaMQTT
+        manufacturer: tspopp
+        name: AquaMQTT
+        model: V1
     - name: "Total Heating Element Hours"
       state_topic: "aquamqtt/energy/totalHeatingElemHours"
       unit_of_measurement: "h"