gazpar2haws 0.1.5__py3-none-any.whl → 0.1.6__py3-none-any.whl

CHANGELOG.md

@@ -5,6 +5,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.6] - 2025-01-05
+
+### Added
+
+[#4](https://github.com/ssenart/gazpar2haws/issues/4): Deploy gazpar2haws as an HA add-on.
+
 ## [0.1.5] - 2025-01-04
 
 ### Added

{gazpar2haws-0.1.5.dist-info → gazpar2haws-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gazpar2haws
-Version: 0.1.5
+Version: 0.1.6
 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
@@ -16,32 +16,62 @@ Requires-Dist: websockets (>=14.1,<15.0)
 Description-Content-Type: text/markdown
 
 # 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.
 
+It is a complement to the other available projects:
+
+- [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar): HA integration that publishes a Gazpar entity with the corresponding meter value.
+- [gazpar2mqtt](https://github.com/ssenart/gazpar2mqtt): [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar) alternative but using MQTT events (it reduce coupling with HA).
+- [lovelace-gazpar-card](https://github.com/ssenart/lovelace-gazpar-card): HA dashboard card compatible with [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar) and [gazpar2mqtt](https://github.com/ssenart/gazpar2mqtt).
+
 ## Installation
 
-Gazpar2HAWS can be installed on any host as a standalone program.
+Gazpar2HAWS can be installed in many ways.
 
-### 1. Using source files
+### 1. Home Assistant Add-on.
 
-The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
+In the **Add-on store**, click **⋮ → Repositories**, fill in **`https://github.com/ssenart/gazpar2haws`** and click **Add → Close** or click the **Add repository** button below, click **Add → Close** (You might need to enter the **internal IP address** of your Home Assistant instance first).  
 
-```sh
-$ cd /path/to/my_install_folder/
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fssenart%2Fgazpar2haws)
 
-$ git clone https://github.com/ssenart/gazpar2haws.git
+For usage and configuration, read the documentation [here](addons/gazpar2haws/DOCS.md).
 
-$ cd gazpar2haws
+### 2. Using Docker Hub
 
-$ poetry install
+The following steps permits to run a container from an existing image available in the Docker Hub repository.
 
-$ poetry shell
+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
 ```
 
-### 2. Using PIP package
+### 3. Using PIP package
 
 ```sh
 $ cd /path/to/my_install_folder/
@@ -58,7 +88,7 @@ $ pip install gazpar2haws
 
 ```
 
-### 3. Using Dockerfile
+### 4. Using Dockerfile
 
 The following steps permit to build the Docker image based on the local source files.
 
@@ -88,36 +118,21 @@ $ docker compose -f docker/docker-compose.yaml build
 $ docker compose -f docker/docker-compose.yaml up -d
 ```
 
-### 4. Using Docker Hub
+### 5. Using source files
 
-The following steps permits to run a container from an existing image available in the Docker Hub repository.
+The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
 
-1. Copy and save the following docker-compose.yaml file:
+```sh
+$ cd /path/to/my_install_folder/
 
-```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>
-```
+$ git clone https://github.com/ssenart/gazpar2haws.git
 
-Edit the environment variable section according to your setup.
+$ cd gazpar2haws
+
+$ poetry install
+
+$ poetry shell
 
-2. Run the container:
-```sh
-$ docker compose up -d
 ```
 
 ## Usage
@@ -172,31 +187,7 @@ 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 
-
-```
+`${name}` is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
 
 ### Environment variable for Docker
 
@@ -250,14 +241,17 @@ $ 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.
+
+Pull requests are welcome. For any change proposal, 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.5.dist-info → gazpar2haws-0.1.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-CHANGELOG.md,sha256=lnwuNSmV_7Cl0gMld0QEs8mc8OXISpGmFo1KKtVes1I,1418
+CHANGELOG.md,sha256=bc9Nxzz0Nc5IIMBEYJSFSi6rVwRVOLHGZqfXx31TrpQ,1552
 gazpar2haws/__init__.py,sha256=yzol8uZSBI7pIRGUmYJ6-vRBwkM4MI3IGf5cQpNsaFw,57
 gazpar2haws/__main__.py,sha256=g8xk0x_kprBHKHLzgf9y9EY2_gKC9V3k4z0n-EDTd-I,3253
 gazpar2haws/bridge.py,sha256=plcXR8y6lH84OSHuUOogNcbM7uua24inoF9SSERKGHo,3539
@@ -6,7 +6,7 @@ gazpar2haws/config_utils.py,sha256=D0lu-3KY-vLEyD2vDN05UABkMnpMJjqw1RuDJVrkGFs,2
 gazpar2haws/gazpar.py,sha256=8yrMzs9HfMSgq3HPeJs64SHWb5RWm7ZL3tgfzhlwHFQ,5754
 gazpar2haws/haws.py,sha256=H0Qa01Qtsn3QdnGqIGkXE-Ympf7MSXkbFwAbzaMAodM,6895
 gazpar2haws/version.py,sha256=ebdTNl4h0hNKmN3Gbs592VJsYbMmrkB47WyZMJevaQo,86
-gazpar2haws-0.1.5.dist-info/LICENSE,sha256=G6JttcnlwcRHYzIcDflSGOVrHTtaP3BEegM2lH00xHw,1094
-gazpar2haws-0.1.5.dist-info/METADATA,sha256=nB95-7v4CFg0Msn9g4RW-LW4Y66IvhvA3AVWeTb2kp0,7366
-gazpar2haws-0.1.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-gazpar2haws-0.1.5.dist-info/RECORD,,
+gazpar2haws-0.1.6.dist-info/LICENSE,sha256=G6JttcnlwcRHYzIcDflSGOVrHTtaP3BEegM2lH00xHw,1094
+gazpar2haws-0.1.6.dist-info/METADATA,sha256=itBwqzOInCVIK4AwfFGHg88aq5FLeXW_lhUGbWMmObY,8275
+gazpar2haws-0.1.6.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+gazpar2haws-0.1.6.dist-info/RECORD,,