gazpar2haws 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2024-12-08
+## [0.1.1] - 2024-12-22
+
+### Added
+
+[#1](https://github.com/ssenart/gazpar2haws/issues/1): Publish energy indicator in kWh.
+
+## [0.1.0] - 2024-12-21
 
 First version of the project.

gazpar2haws/gazpar.py

@@ -34,18 +34,30 @@ class Gazpar:
     # Publish Gaspar data to Home Assistant WS
     async def publish(self):
 
+        # Volume and energy sensor names.
+        volume_sensor_name = f"sensor.{self._name}_volume"
+        energy_sensor_name = f"sensor.{self._name}_energy"
+
         # Eventually reset the sensor in Home Assistant
         if self._reset:
             try:
-                await self._homeassistant.clear_statistics([f"sensor.{self._name}"])
+                await self._homeassistant.clear_statistics([volume_sensor_name, energy_sensor_name])
             except Exception:
                 errorMessage = f"Error while resetting the sensor in Home Assistant: {traceback.format_exc()}"
                 Logger.warning(errorMessage)
                 raise Exception(errorMessage)
 
+        # Publish volume sensor
+        await self._publish_entity(volume_sensor_name, pygazpar.PropertyName.VOLUME.value, "m³")
+        await self._publish_entity(energy_sensor_name, pygazpar.PropertyName.ENERGY.value, "kWh")
+
+    # ----------------------------------
+    # Publish a sensor to Home Assistant
+    async def _publish_entity(self, entity_id: str, property_name: str, unit_of_measurement: str):
+
         # Check the existence of the sensor in Home Assistant
         try:
-            exists_statistic_id = await self._homeassistant.exists_statistic_id(f"sensor.{self._name}", "sum")
+            exists_statistic_id = await self._homeassistant.exists_statistic_id(entity_id, "sum")
         except Exception:
             errorMessage = f"Error while checking the existence of the sensor in Home Assistant: {traceback.format_exc()}"
             Logger.warning(errorMessage)
@@ -54,7 +66,7 @@ class Gazpar:
         if exists_statistic_id:
             # Get last statistics from GrDF
             try:
-                last_statistics = await self._homeassistant.get_last_statistic(f"sensor.{self._name}")
+                last_statistics = await self._homeassistant.get_last_statistic(entity_id)
             except Exception:
                 errorMessage = f"Error while fetching last statistics from Home Assistant: {traceback.format_exc()}"
                 Logger.warning(errorMessage)
@@ -85,9 +97,10 @@ class Gazpar:
         # Timezone
         timezone = pytz.timezone(self._timezone)
 
-        # Fill statistics.
+        # Compute and fill statistics.
         daily = data.get(pygazpar.Frequency.DAILY.value)
         statistics = []
+        total = 0
         for reading in daily:
             # Parse date format DD/MM/YYYY into datetime.
             date = datetime.strptime(reading[pygazpar.PropertyName.TIME_PERIOD.value], "%d/%m/%Y")
@@ -99,15 +112,18 @@ class Gazpar:
             # Set the timezone
             date = timezone.localize(date)
 
+            # Compute the total volume and energy
+            total += reading[property_name]
+
             statistics.append({
                 "start": date.isoformat(),
-                "state": reading[pygazpar.PropertyName.END_INDEX.value],
-                "sum": reading[pygazpar.PropertyName.END_INDEX.value]
+                "state": total,
+                "sum": total
             })
 
         # Publish statistics to Home Assistant
         try:
-            await self._homeassistant.import_statistics(f"sensor.{self._name}", "recorder", "gazpar2haws", "m³", statistics)
+            await self._homeassistant.import_statistics(entity_id, "recorder", "gazpar2haws", unit_of_measurement, statistics)
         except Exception:
             errorMessage = f"Error while importing statistics to Home Assistant: {traceback.format_exc()}"
             Logger.warning(errorMessage)

gazpar2haws/haws.py

@@ -73,7 +73,7 @@ class HomeAssistantWS:
 
         response_data = json.loads(response)
 
-        Logger.debug(f"Received response: {response_data}")
+        Logger.debug("Received response")
 
         if response_data.get("type") != "result":
             raise Exception(f"Invalid response message: {response_data}")

{gazpar2haws-0.1.0.dist-info → gazpar2haws-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazpar2haws
-Version: 0.1.0
+Version: 0.1.1
 Summary: Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface
 License: MIT
 Author: Stéphane Senart
@@ -80,7 +80,7 @@ logging:
 grdf:
   scan_interval: 0 # Number of minutes between each data retrieval (0 means no scan: a single data retrieval at startup, then stops).
   devices:
-  - name: gazpar2haws
+  - name: gazpar2haws # Name of the device in home assistant. It will be used as the entity_ids: sensor.${name}_volume and sensor.${name}_energy.
     username: "!secret grdf.username"
     password: "!secret grdf.password"
     pce_identifier: "!secret grdf.pce_identifier"
@@ -106,6 +106,36 @@ homeassistant.port: ${HA_PORT}
 homeassistant.token: ${HA_TOKEN}
 ```
 
+The history is uploaded on the entities with names:
+- sensor.${name}_volume: Volume history in m³.
+- sensor.${name}_energy: Energy history in kWh.
+
+${name} is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
+
+Those two entities have to already exist in Home Assistant.
+
+They may be created using the following templates:
+
+```yaml
+
+  - name: gazpar2haws_volume
+    unit_of_measurement: 'm³'
+    availability: true
+    state: 0
+    icon: mdi:fire    
+    device_class: gas
+    state_class: total_increasing    
+
+  - name: gazpar2haws_energy
+    unit_of_measurement: 'kWh'
+    availability: true
+    state: 0     
+    icon: mdi:fire
+    device_class: energy
+    state_class: total_increasing 
+
+```
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 

gazpar2haws-0.1.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+CHANGELOG.md,sha256=2Xv5NYFt0BQy7NAAQPDHKb4OTsPaz5qF_2UDK5VP4a8,447
+gazpar2haws/__init__.py,sha256=yzol8uZSBI7pIRGUmYJ6-vRBwkM4MI3IGf5cQpNsaFw,57
+gazpar2haws/__main__.py,sha256=g8xk0x_kprBHKHLzgf9y9EY2_gKC9V3k4z0n-EDTd-I,3253
+gazpar2haws/bridge.py,sha256=TiPmvRBxzgwOKKmWNXMOaP0pLg-Wls_SmiwHczNEM_4,3466
+gazpar2haws/config_utils.py,sha256=D0lu-3KY-vLEyD2vDN05UABkMnpMJjqw1RuDJVrkGFs,2123
+gazpar2haws/gazpar.py,sha256=mC2yDvb22sGjA4c3Gj0sPXEyLKnSNi6WGbVG2HOkD-A,5285
+gazpar2haws/haws.py,sha256=SiVM5QTANMmUq66IAsFn68jwej-Rdpqg6dIqTeTadmw,6765
+gazpar2haws/version.py,sha256=ebdTNl4h0hNKmN3Gbs592VJsYbMmrkB47WyZMJevaQo,86
+gazpar2haws-0.1.1.dist-info/LICENSE,sha256=G6JttcnlwcRHYzIcDflSGOVrHTtaP3BEegM2lH00xHw,1094
+gazpar2haws-0.1.1.dist-info/METADATA,sha256=QcSwzAfhXOngs180kR2n4FAoA6RcvCIETBR2uDRUXVY,3965
+gazpar2haws-0.1.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+gazpar2haws-0.1.1.dist-info/RECORD,,

gazpar2haws-0.1.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-CHANGELOG.md,sha256=8JDG8V_DLBTwnVlZErwlK9PNI-xiwpU6vaqSKavYvKw,316
-gazpar2haws/__init__.py,sha256=yzol8uZSBI7pIRGUmYJ6-vRBwkM4MI3IGf5cQpNsaFw,57
-gazpar2haws/__main__.py,sha256=g8xk0x_kprBHKHLzgf9y9EY2_gKC9V3k4z0n-EDTd-I,3253
-gazpar2haws/bridge.py,sha256=TiPmvRBxzgwOKKmWNXMOaP0pLg-Wls_SmiwHczNEM_4,3466
-gazpar2haws/config_utils.py,sha256=D0lu-3KY-vLEyD2vDN05UABkMnpMJjqw1RuDJVrkGFs,2123
-gazpar2haws/gazpar.py,sha256=4bEp0JDrLAFxbADSoRH76UD3OC8ls5GBhUcoBQ9WQxw,4663
-gazpar2haws/haws.py,sha256=EXs5Tdla4u2BVtupCCLITyvdL_W288LrCxrTzskWSRY,6783
-gazpar2haws/version.py,sha256=ebdTNl4h0hNKmN3Gbs592VJsYbMmrkB47WyZMJevaQo,86
-gazpar2haws-0.1.0.dist-info/LICENSE,sha256=G6JttcnlwcRHYzIcDflSGOVrHTtaP3BEegM2lH00xHw,1094
-gazpar2haws-0.1.0.dist-info/METADATA,sha256=H6EGtnQczzLQKLDwdPtAd2TwAzzVIi82AURA36Khwns,3099
-gazpar2haws-0.1.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-gazpar2haws-0.1.0.dist-info/RECORD,,