gazpar2haws 0.3.0b44__py3-none-any.whl → 0.3.2__py3-none-any.whl

gazpar2haws/gazpar.py

@@ -76,10 +76,18 @@ class Gazpar:
     def name(self):
         return self._name
 
+    # ----------------------------------
+    def as_of_date(self):
+        return date.today() if self._as_of_date is None else self._as_of_date
+
     # ----------------------------------
     # Publish Gaspar data to Home Assistant WS
     async def publish(self):  # pylint: disable=too-many-branches, too-many-statements
 
+        # As of date
+        as_of_date = self.as_of_date()
+        Logger.debug(f"As of date: {as_of_date}")
+
         # Volume, energy and cost sensor names.
         volume_sensor_name = f"sensor.{self._name}_volume"
         energy_sensor_name = f"sensor.{self._name}_energy"
@@ -100,9 +108,7 @@ class Gazpar:
         last_date_and_value_by_sensor[cost_sensor_name] = await self.find_last_date_and_value(cost_sensor_name)
 
         # Compute the start date as the minimum of the last dates plus one day
-        start_date = min(
-            min(v[0] for v in last_date_and_value_by_sensor.values()) + timedelta(days=1), self._as_of_date
-        )
+        start_date = min(min(v[0] for v in last_date_and_value_by_sensor.values()) + timedelta(days=1), as_of_date)
 
         # Get all start dates
         energy_start_date = last_date_and_value_by_sensor[energy_sensor_name][0] + timedelta(days=1)
@@ -115,7 +121,7 @@ class Gazpar:
         Logger.debug(f"Cost start date: {cost_start_date}")
 
         # Fetch the data from GrDF and publish it to Home Assistant
-        daily_history = self.fetch_daily_gazpar_history(start_date, self._as_of_date)
+        daily_history = self.fetch_daily_gazpar_history(start_date, as_of_date)
 
         # The end date is the last date of the daily history
         if daily_history is None or len(daily_history) == 0:
@@ -319,6 +325,9 @@ class Gazpar:
     # Find last date, value of the entity.
     async def find_last_date_and_value(self, entity_id: str) -> tuple[date, float]:
 
+        # As of date
+        as_of_date = self.as_of_date()
+
         # Check the existence of the sensor in Home Assistant
         try:
             exists_statistic_id = await self._homeassistant.exists_statistic_id(entity_id, "sum")
@@ -331,10 +340,12 @@ class Gazpar:
         if exists_statistic_id:
             # Get the last statistic from Home Assistant
             try:
-                as_of_date = datetime.combine(self._as_of_date, datetime.min.time())
-                as_of_date = pytz.timezone(self._timezone).localize(as_of_date)
+                as_of_datetime = datetime.combine(as_of_date, datetime.min.time())
+                as_of_datetime = pytz.timezone(self._timezone).localize(as_of_datetime)
 
-                last_statistic = await self._homeassistant.get_last_statistic(entity_id, as_of_date, self._last_days)
+                last_statistic = await self._homeassistant.get_last_statistic(
+                    entity_id, as_of_datetime, self._last_days
+                )
             except HomeAssistantWSException:
                 Logger.warning(
                     f"Error while fetching last statistics of the entity '{entity_id}' from Home Assistant: {traceback.format_exc()}"
@@ -359,7 +370,7 @@ class Gazpar:
             Logger.debug(f"Entity '{entity_id}' does not exist in Home Assistant.")
 
         # Compute the corresponding last_date
-        last_date = self._as_of_date - timedelta(days=self._last_days)
+        last_date = as_of_date - timedelta(days=self._last_days)
 
         # If no statistic, the last value is initialized to zero
         last_value = 0

gazpar2haws/model.py

@@ -54,7 +54,7 @@ class Device(BaseModel):
     name: str
     data_source: str = "json"
     tmp_dir: DirectoryPath = DirectoryPath("/tmp")
-    as_of_date: date = date.today()
+    as_of_date: Optional[date] = None
     username: Optional[EmailStr] = None
     password: Optional[SecretStr] = None
     pce_identifier: Optional[SecretStr] = None

{gazpar2haws-0.3.0b44.dist-info → gazpar2haws-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gazpar2haws
-Version: 0.3.0b44
+Version: 0.3.2
 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 License
          
@@ -31,7 +31,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: pydantic-extra-types (>=2.10.2,<3.0.0)
 Requires-Dist: pydantic[email] (>=2.10.6,<3.0.0)
-Requires-Dist: pygazpar (>=1.3.0b4)
+Requires-Dist: pygazpar (>=1.3.0)
 Requires-Dist: pyyaml (>=6.0.2)
 Requires-Dist: websockets (>=14.1)
 Description-Content-Type: text/markdown
@@ -491,6 +491,56 @@ In a Docker environment, the configurations files are instantiated by replacing
 
 You can setup them directly in a docker-compose.yaml file (environment section) or from a Docker command line (-e option).
 
+## FAQ
+
+- *Is it an official GrDF application ?*
+
+  No, absolutely not. It was made by reverse engineering GrDF website without any guarantee of long-term operation. Indeed, any modification made to their website risks breaking it.
+
+- *I'm confused. What are the differences between [PyGazpar](https://github.com/ssenart/PyGazpar), [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar), [lovelace-gazpar-card](https://github.com/ssenart/lovelace-gazpar-card), [Gazpar2MQTT](https://github.com/ssenart/gazpar2mqtt), [Gazpar2HAWS](https://github.com/ssenart/gazpar2haws) ?*
+
+    - [PyGazpar](https://github.com/ssenart/PyGazpar) is the low-level Python library used to query GrDF data. It was written for use by other Python programs.
+    - [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar) is the first program using PyGazpar. This is a Home Assistant integration which makes it possible to provide an energy sensor. Coupled with the Recorder integration, it is capable of building a history (called statistics in HA) and displaying it using the Energy Dashboard. It is also compatible with the [lovelace-gazpar-card](https://github.com/ssenart/lovelace-gazpar-card).
+    - [lovelace-gazpar-card](https://github.com/ssenart/lovelace-gazpar-card) is a HA card which nicely displays historical data in the form of tables or bar graphs. It is also compatible with [Gazpar2MQTT](https://github.com/ssenart/gazpar2mqtt).
+    - [Gazpar2MQTT](https://github.com/ssenart/gazpar2mqtt) offers exactly the same functionality as [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar) but runs outside of HA as a standalone application, in a Docker container or in an HA add-on.
+    - [Gazpar2HAWS](https://github.com/ssenart/gazpar2haws) replaces the use of home-assistant-gazpar/Gazpar2MQTT with the HA Recorder integration to create a data history (for Energy dashboard integration). The disadvantage of the latter solution is the non-alignment of the actual reading date and its publication date. Reading values ​​are made available for 2 to 5 days (and sometimes longer). [Gazpar2HAWS](https://github.com/ssenart/gazpar2haws) timestamps the reading value exactly to the observation dates without any offset. In addition, [Gazpar2HAWS](https://github.com/ssenart/gazpar2haws) is able to reconstruct the complete history of your data up to 3 years in the past, which is very practical in the event of data loss. Finally, it provides ways to calculate and publish energy costs.
+
+- *My PCE ID has a leading zero (e.g. "0123456789") and the application fails with an error indicating that the PCE number is unknown. I can see in the log file that it uses "123456789" without the leading zero. What happened ?*
+
+  The cause is in your configuration file (grdf.devices[].pce_identifier) ​​where you configured your PCE identifier and you did not quote it. Your PCE number is then interpreted as a number instead of a string.
+
+## Troubleshooting
+
+Sometimes, for any reason, the application does not work as expected. No entities is created in HA, some error messages are displayed, nothing happens...
+
+In this situation, the most valuable tool for troubleshooting what is happening is the log file.
+
+Take a look at it, try to find a clue that might help solve the problem. Sorry, the log file can sometimes appear cryptic.
+
+If your configuration is correct, you may have spotted a bug.
+
+In this case, capture a Github issue [here](https://github.com/ssenart/gazpar2haws/issues) with the following information:
+1. What kind of setup do you use ? Standalone application, Docker container or HA addon.
+2. Is this a first installation or a version upgrade ? If upgrading version, what was the previous version and did it work well ?
+3. Describe as precisely as possible what is happening.
+4. Provide the complete log file (from start to finish) and make sure to erase all your secrets from it.
+
+The first log lines should be similar to:
+```log
+2025-02-17 02:01:17,626 INFO [__main__] Starting Gazpar2HAWS version 0.3.0
+2025-02-17 02:01:17,627 INFO [__main__] Running on Python version: 3.12.9 (main, Feb  7 2025, 01:03:02) [GCC 12.2.0]
+```
+
+The normal last lines of the log should be:
+```log
+2025-02-17 10:02:42,162 INFO [gazpar2haws.gazpar] No volume data to publish
+2025-02-17 10:02:42,162 INFO [gazpar2haws.gazpar] No energy data to publish
+2025-02-17 10:02:42,162 INFO [gazpar2haws.gazpar] No cost data to publish
+2025-02-17 10:02:42,162 INFO [gazpar2haws.bridge] Device 'gazpar2haws' data published to Home Assistant WS.
+2025-02-17 10:02:42,162 INFO [gazpar2haws.bridge] Gazpar data published to Home Assistant WS.
+2025-02-17 10:02:42,166 INFO [gazpar2haws.bridge] Waiting 480 minutes before next scan...
+```
+
 ## Publish a new image on Docker Hub
 
 1. List all local images

{gazpar2haws-0.3.0b44.dist-info → gazpar2haws-0.3.2.dist-info}/RECORD

@@ -4,12 +4,12 @@ gazpar2haws/bridge.py,sha256=VEl22xt2Szgk_FVrxSvZNxp3T5Q2JXc9ulfrunHHkmo,3685
 gazpar2haws/config_utils.py,sha256=yT2G-naMA2Vst6bQdm1bD2oVsPTU3Q_RuukCs-dZ6Ak,2280
 gazpar2haws/configuration.py,sha256=24q8FUBMS1vpqU6RYAv5Au179HbiBk1CZIEMiBGuXq0,722
 gazpar2haws/date_array.py,sha256=q3xTX-KS2KOtFSB042OJVerZFtS-Jw9Iin5RHKnobPs,10108
-gazpar2haws/gazpar.py,sha256=iI1-Mzc1m92jO4sQyYCITux8KJc40lWXlCPw7vum3Lk,14249
+gazpar2haws/gazpar.py,sha256=XcfT_U4QiHmg0P9pO4boueDLr52UXR2GBKdRmhu8BQw,14586
 gazpar2haws/haws.py,sha256=1ELdompdACNf5XkpjCN6Bdiw7stPfzar3x8OjoBmhxQ,7969
-gazpar2haws/model.py,sha256=rn6gP8z5OVCQO3BZsExD68BaOExumiCv36wuPyOvS5M,7103
+gazpar2haws/model.py,sha256=RnKmWVLkzLsS_-r60CjXgzRfzoj_GopBAYBEuZjDT_I,7105
 gazpar2haws/pricer.py,sha256=7xlLlPU6pXQcOnyaeoR_UEQOwuPwUG_V17FvPgSxzmM,22434
 gazpar2haws/version.py,sha256=9Iq5Jm63Ev7QquCjhDqa9_KAgHdKl9FJHynq8M6JNrY,83
-gazpar2haws-0.3.0b44.dist-info/LICENSE,sha256=ajApZPyhVx8AU9wN7DXeRGhoWFqY2ylBZUa5GRhTmok,1073
-gazpar2haws-0.3.0b44.dist-info/METADATA,sha256=yJmu1iVIFNIRaQFrpgyEMNxo0vsAfEAhg0VdQ4PAnuc,17410
-gazpar2haws-0.3.0b44.dist-info/WHEEL,sha256=7dDg4QLnNKTvwIDR9Ac8jJaAmBC_owJrckbC0jjThyA,88
-gazpar2haws-0.3.0b44.dist-info/RECORD,,
+gazpar2haws-0.3.2.dist-info/LICENSE,sha256=ajApZPyhVx8AU9wN7DXeRGhoWFqY2ylBZUa5GRhTmok,1073
+gazpar2haws-0.3.2.dist-info/METADATA,sha256=Zj_3TuzFM1BCAegCkBg8KL4hZUD2R62hhMjaCQF1yP8,22170
+gazpar2haws-0.3.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+gazpar2haws-0.3.2.dist-info/RECORD,,

{gazpar2haws-0.3.0b44.dist-info → gazpar2haws-0.3.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.0
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any