gazpar2haws 0.1.1__tar.gz → 0.1.3__tar.gz

gazpar2haws-0.1.3/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+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.3] - 2025-01-03
+
+### Changed
+[#11](https://github.com/ssenart/gazpar2haws/issues/11): Upgrade PyGazpar version to 1.2.6.
+
+## [0.1.2] - 2024-12-30
+
+### Added
+[#2](https://github.com/ssenart/gazpar2haws/issues/2): DockerHub deployment.
+
+### Fixed
+[#9](https://github.com/ssenart/gazpar2haws/issues/9): Incorrect timezone info creates duplicate import.
+
+[#6](https://github.com/ssenart/gazpar2haws/issues/6): The last meter value may be imported multiple times and cause the today value being wrong.
+
+[#3](https://github.com/ssenart/gazpar2haws/issues/3): reset=false makes the meter import to restart from zero.
+
+## [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-0.1.1 → gazpar2haws-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazpar2haws
-Version: 0.1.1
+Version: 0.1.3
 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
@@ -9,7 +9,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: pygazpar (==1.2.5)
+Requires-Dist: pygazpar (>=1.2.6,<2.0.0)
 Requires-Dist: pytest-asyncio (>=0.25.0,<0.26.0)
 Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: websockets (>=14.1,<15.0)
@@ -58,6 +58,68 @@ $ pip install gazpar2haws
 
 ```
 
+### 3. Using Dockerfile
+
+The following steps permit to build the Docker image based on the local source files.
+
+1. Clone the repo locally:
+```sh
+$ cd /path/to/my_install_folder/
+
+$ git clone https://github.com/ssenart/gazpar2haws.git
+```
+2. Edit the docker-compose.yaml file by setting the environment variables corresponding to your GrDF account and Home Assistant setup:
+
+```yaml
+    environment:
+      - GRDF_USERNAME=<GrDF account username>
+      - GRDF_PASSWORD=<GrDF account password>
+      - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
+      - HOMEASSISTANT_HOST=<Home Assistant instance host name>
+      - HOMEASSISTANT_PORT=<Home Assistant instance port number>
+      - HOMEASSISTANT_TOKEN=<Home Assistant access token>
+```
+3. Build the image:
+```sh
+$ docker compose -f docker/docker-compose.yaml build
+```
+4. Run the container:
+```sh
+$ docker compose -f docker/docker-compose.yaml up -d
+```
+
+### 4. Using Docker Hub
+
+The following steps permits to run a container from an existing image available in the Docker Hub repository.
+
+1. Copy and save the following docker-compose.yaml file:
+
+```yaml
+services:
+  gazpar2haws:
+    image: ssenart/gazpar2haws:latest  
+    container_name: gazpar2haws
+    restart: unless-stopped
+    network_mode: bridge
+    user: "1000:1000"    
+    volumes:
+      - ./gazpar2haws/config:/app/config
+      - ./gazpar2haws/log:/app/log
+    environment:
+      - GRDF_USERNAME=<GrDF account username>
+      - GRDF_PASSWORD=<GrDF account password>
+      - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
+      - HOMEASSISTANT_HOST=<Home Assistant instance host name>
+      - HOMEASSISTANT_TOKEN=<Home Assistant access token>
+```
+
+Edit the environment variable section according to your setup.
+
+2. Run the container:
+```sh
+$ docker compose up -d
+```
+
 ## Usage
 
 ### Command line
@@ -136,6 +198,57 @@ They may be created using the following templates:
 
 ```
 
+### Environment variable for Docker
+
+In a Docker environment, the configurations files are instantiated by replacing the environment variables below in the template files:
+
+| Environment variable | Description | Required | Default value |
+|---|---|---|---|
+| GRDF_USERNAME  |  GrDF account user name  | Yes | - |
+| GRDF_PASSWORD  |  GrDF account password (avoid using special characters) | Yes | - |
+| GRDF_PCE_IDENTIFIER  | GrDF meter PCE identifier  | Yes | - |
+| GRDF_SCAN_INTERVAL  | Period in minutes to refresh meter data (0 means one single refresh and stop) | No | 480 (8 hours) |
+| GRDF_LAST_DAYS | Number of days of history data to retrieve  | No | 1095 (3 years) |
+| HOMEASSISTANT_HOST  | Home Assistant instance host name  | Yes | - |
+| HOMEASSISTANT_PORT  | Home Assistant instance port number  | No | 8123 |
+| HOMEASSISTANT_TOKEN  | Home Assistant access token  | Yes | - |
+
+You can setup them directly in a docker-compose.yaml file (environment section) or from a Docker command line (-e option).
+
+## Publish a new image on Docker Hub
+
+1. List all local images
+
+```sh
+$ docker image ls
+```
+
+2. Build a new local image
+
+```sh
+$ docker compose -f docker/docker-compose.yaml build
+```
+
+3. Tag the new built image with the version number
+
+```sh
+$ docker image tag ssenart/gazpar2haws:latest ssenart/gazpar2haws:0.1.2
+```
+
+4. Login in Docker Hub
+
+```sh
+$ docker login
+```
+
+5. Push all the tagged local images to Docker Hub
+
+```sh
+$ docker push --all-tags ssenart/gazpar2haws
+```
+
+All the gazpar2haws images are available [here](https://hub.docker.com/repository/docker/ssenart/gazpar2haws/general).
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 

gazpar2haws-0.1.3/README.md

@@ -0,0 +1,247 @@
+# gazpar2haws
+Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface.
+
+It is compatible with Home Assistant Energy Dashboard and permits to upload the history and keep it updated with the latest readings.
+
+## Installation
+
+Gazpar2HAWS can be installed on any host as a standalone program.
+
+### 1. Using source files
+
+The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
+
+```sh
+$ cd /path/to/my_install_folder/
+
+$ git clone https://github.com/ssenart/gazpar2haws.git
+
+$ cd gazpar2haws
+
+$ poetry install
+
+$ poetry shell
+
+```
+
+### 2. Using PIP package
+
+```sh
+$ cd /path/to/my_install_folder/
+
+$ mkdir gazpar2haws
+
+$ cd gazpar2haws
+
+$ python -m venv .venv
+
+$ source .venv/bin/activate
+
+$ pip install gazpar2haws
+
+```
+
+### 3. Using Dockerfile
+
+The following steps permit to build the Docker image based on the local source files.
+
+1. Clone the repo locally:
+```sh
+$ cd /path/to/my_install_folder/
+
+$ git clone https://github.com/ssenart/gazpar2haws.git
+```
+2. Edit the docker-compose.yaml file by setting the environment variables corresponding to your GrDF account and Home Assistant setup:
+
+```yaml
+    environment:
+      - GRDF_USERNAME=<GrDF account username>
+      - GRDF_PASSWORD=<GrDF account password>
+      - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
+      - HOMEASSISTANT_HOST=<Home Assistant instance host name>
+      - HOMEASSISTANT_PORT=<Home Assistant instance port number>
+      - HOMEASSISTANT_TOKEN=<Home Assistant access token>
+```
+3. Build the image:
+```sh
+$ docker compose -f docker/docker-compose.yaml build
+```
+4. Run the container:
+```sh
+$ docker compose -f docker/docker-compose.yaml up -d
+```
+
+### 4. Using Docker Hub
+
+The following steps permits to run a container from an existing image available in the Docker Hub repository.
+
+1. Copy and save the following docker-compose.yaml file:
+
+```yaml
+services:
+  gazpar2haws:
+    image: ssenart/gazpar2haws:latest  
+    container_name: gazpar2haws
+    restart: unless-stopped
+    network_mode: bridge
+    user: "1000:1000"    
+    volumes:
+      - ./gazpar2haws/config:/app/config
+      - ./gazpar2haws/log:/app/log
+    environment:
+      - GRDF_USERNAME=<GrDF account username>
+      - GRDF_PASSWORD=<GrDF account password>
+      - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
+      - HOMEASSISTANT_HOST=<Home Assistant instance host name>
+      - HOMEASSISTANT_TOKEN=<Home Assistant access token>
+```
+
+Edit the environment variable section according to your setup.
+
+2. Run the container:
+```sh
+$ docker compose up -d
+```
+
+## Usage
+
+### Command line
+
+```sh
+$ python -m gazpar2haws --config /path/to/configuration.yaml --secrets /path/to/secrets.yaml
+```
+
+### Configuration file
+
+The default configuration file is below.
+
+```yaml
+logging:
+  file: log/gazpar2haws.log
+  console: true
+  level: debug
+  format: '%(asctime)s %(levelname)s [%(name)s] %(message)s'
+
+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 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"
+    timezone: Europe/Paris
+    last_days: 365 # Number of days of data to retrieve
+    reset: false # If true, the data will be reset before the first data retrieval
+
+homeassistant:
+  host: "!secret homeassistant.host"
+  port: "!secret homeassistant.port"
+  token: "!secret homeassistant.token"
+```
+
+The default secret file:
+
+```yaml
+grdf.username: ${GRDF_USERNAME}
+grdf.password: ${GRDF_PASSWORD}
+grdf.pce_identifier: ${GRDF_PCE_IDENTIFIER}
+
+homeassistant.host: ${HA_HOST}
+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 
+
+```
+
+### Environment variable for Docker
+
+In a Docker environment, the configurations files are instantiated by replacing the environment variables below in the template files:
+
+| Environment variable | Description | Required | Default value |
+|---|---|---|---|
+| GRDF_USERNAME  |  GrDF account user name  | Yes | - |
+| GRDF_PASSWORD  |  GrDF account password (avoid using special characters) | Yes | - |
+| GRDF_PCE_IDENTIFIER  | GrDF meter PCE identifier  | Yes | - |
+| GRDF_SCAN_INTERVAL  | Period in minutes to refresh meter data (0 means one single refresh and stop) | No | 480 (8 hours) |
+| GRDF_LAST_DAYS | Number of days of history data to retrieve  | No | 1095 (3 years) |
+| HOMEASSISTANT_HOST  | Home Assistant instance host name  | Yes | - |
+| HOMEASSISTANT_PORT  | Home Assistant instance port number  | No | 8123 |
+| HOMEASSISTANT_TOKEN  | Home Assistant access token  | Yes | - |
+
+You can setup them directly in a docker-compose.yaml file (environment section) or from a Docker command line (-e option).
+
+## Publish a new image on Docker Hub
+
+1. List all local images
+
+```sh
+$ docker image ls
+```
+
+2. Build a new local image
+
+```sh
+$ docker compose -f docker/docker-compose.yaml build
+```
+
+3. Tag the new built image with the version number
+
+```sh
+$ docker image tag ssenart/gazpar2haws:latest ssenart/gazpar2haws:0.1.2
+```
+
+4. Login in Docker Hub
+
+```sh
+$ docker login
+```
+
+5. Push all the tagged local images to Docker Hub
+
+```sh
+$ docker push --all-tags ssenart/gazpar2haws
+```
+
+All the gazpar2haws images are available [here](https://hub.docker.com/repository/docker/ssenart/gazpar2haws/general).
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)
+
+## Project status
+Gazpar2HAWS has been initiated for integration with [Home Assistant](https://www.home-assistant.io/) energy dashboard.
+
+
+

{gazpar2haws-0.1.1 → gazpar2haws-0.1.3}/gazpar2haws/gazpar.py

@@ -64,25 +64,33 @@ class Gazpar:
             raise Exception(errorMessage)
 
         if exists_statistic_id:
-            # Get last statistics from GrDF
+            # Get the last statistic from Home Assistant
             try:
-                last_statistics = await self._homeassistant.get_last_statistic(entity_id)
+                last_statistic = 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)
                 raise Exception(errorMessage)
 
             # Extract the end date of the last statistics from the unix timestamp
-            last_date = datetime.fromtimestamp(last_statistics.get("end") / 1000)
+            last_date = datetime.fromtimestamp(last_statistic.get("start") / 1000, tz=pytz.timezone(self._timezone))
 
             # Compute the number of days since the last statistics
-            last_days = (datetime.now() - last_date).days
+            last_days = (datetime.now(tz=pytz.timezone(self._timezone)) - last_date).days
+
+            # Get the last meter value
+            last_value = last_statistic.get("sum")
         else:
             # If the sensor does not exist in Home Assistant, fetch the last days defined in the configuration
             last_days = self._last_days
 
             # Compute the corresponding last_date
-            last_date = datetime.now() - timedelta(days=last_days)
+            last_date = datetime.now(tz=pytz.timezone(self._timezone)) - timedelta(days=last_days)
+
+            # If no statistic, the last value is initialized to zero
+            last_value = 0
+
+        Logger.debug(f"Last date: {last_date}, last days: {last_days}, last value: {last_value}")
 
         # Initialize PyGazpar client
         client = pygazpar.Client(pygazpar.JsonWebDataSource(username=self._username, password=self._password))
@@ -100,18 +108,19 @@ class Gazpar:
         # Compute and fill statistics.
         daily = data.get(pygazpar.Frequency.DAILY.value)
         statistics = []
-        total = 0
+        total = last_value
         for reading in daily:
             # Parse date format DD/MM/YYYY into datetime.
             date = datetime.strptime(reading[pygazpar.PropertyName.TIME_PERIOD.value], "%d/%m/%Y")
 
-            # Skip all readings before the last statistic date.
-            if date.date() < last_date.date():
-                continue
-
             # Set the timezone
             date = timezone.localize(date)
 
+            # Skip all readings before the last statistic date.
+            if date <= last_date:
+                Logger.debug(f"Skip date: {date} <= {last_date}")
+                continue
+
             # Compute the total volume and energy
             total += reading[property_name]
 

{gazpar2haws-0.1.1 → gazpar2haws-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gazpar2haws"
-version = "0.1.1"
+version = "0.1.3"
 description = "Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface"
 authors = ["Stéphane Senart"]
 license = "MIT"
@@ -9,7 +9,7 @@ include = ["CHANGELOG.md"]
 
 [tool.poetry.dependencies]
 python = "^3.12"
-pygazpar = "==1.2.5"
+pygazpar = "^1.2.6"
 websockets = "^14.1"
 pytest-asyncio = "^0.25.0"
 pyyaml = "^6.0.2"

gazpar2haws-0.1.1/CHANGELOG.md

@@ -1,15 +0,0 @@
-# Changelog
-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.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-0.1.1/README.md

@@ -1,134 +0,0 @@
-# gazpar2haws
-Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface.
-
-It is compatible with Home Assistant Energy Dashboard and permits to upload the history and keep it updated with the latest readings.
-
-## Installation
-
-Gazpar2HAWS can be installed on any host as a standalone program.
-
-### 1. Using source files
-
-The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
-
-```sh
-$ cd /path/to/my_install_folder/
-
-$ git clone https://github.com/ssenart/gazpar2haws.git
-
-$ cd gazpar2haws
-
-$ poetry install
-
-$ poetry shell
-
-```
-
-### 2. Using PIP package
-
-```sh
-$ cd /path/to/my_install_folder/
-
-$ mkdir gazpar2haws
-
-$ cd gazpar2haws
-
-$ python -m venv .venv
-
-$ source .venv/bin/activate
-
-$ pip install gazpar2haws
-
-```
-
-## Usage
-
-### Command line
-
-```sh
-$ python -m gazpar2haws --config /path/to/configuration.yaml --secrets /path/to/secrets.yaml
-```
-
-### Configuration file
-
-The default configuration file is below.
-
-```yaml
-logging:
-  file: log/gazpar2haws.log
-  console: true
-  level: debug
-  format: '%(asctime)s %(levelname)s [%(name)s] %(message)s'
-
-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 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"
-    timezone: Europe/Paris
-    last_days: 365 # Number of days of data to retrieve
-    reset: false # If true, the data will be reset before the first data retrieval
-
-homeassistant:
-  host: "!secret homeassistant.host"
-  port: "!secret homeassistant.port"
-  token: "!secret homeassistant.token"
-```
-
-The default secret file:
-
-```yaml
-grdf.username: ${GRDF_USERNAME}
-grdf.password: ${GRDF_PASSWORD}
-grdf.pce_identifier: ${GRDF_PCE_IDENTIFIER}
-
-homeassistant.host: ${HA_HOST}
-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.
-
-Please make sure to update tests as appropriate.
-
-## License
-[MIT](https://choosealicense.com/licenses/mit/)
-
-## Project status
-Gazpar2HAWS has been initiated for integration with [Home Assistant](https://www.home-assistant.io/) energy dashboard.
-
-
-