gazpar2haws 0.1.5__tar.gz → 0.1.7__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/CHANGELOG.md +12 -0
  2. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/PKG-INFO +57 -63
  3. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/README.md +56 -62
  4. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/pyproject.toml +1 -1
  5. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/LICENSE +0 -0
  6. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/__init__.py +0 -0
  7. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/__main__.py +0 -0
  8. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/bridge.py +0 -0
  9. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/config_utils.py +0 -0
  10. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/gazpar.py +0 -0
  11. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/haws.py +0 -0
  12. {gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/gazpar2haws/version.py +0 -0
{gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/CHANGELOG.md RENAMED
@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [0.1.7] - 2025-01-05
9
+
10
+ ### Fixed
11
+
12
+ [#18](https://github.com/ssenart/gazpar2haws/issues/18): Regression on DockerHub deployment.
13
+
14
+ ## [0.1.6] - 2025-01-05
15
+
16
+ ### Added
17
+
18
+ [#4](https://github.com/ssenart/gazpar2haws/issues/4): Deploy gazpar2haws as an HA add-on.
19
+
8
20
  ## [0.1.5] - 2025-01-04
9
21
 
10
22
  ### Added
{gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: gazpar2haws
3
- Version: 0.1.5
3
+ Version: 0.1.7
4
4
  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
5
5
  License: MIT
6
6
  Author: Stéphane Senart
@@ -16,32 +16,62 @@ Requires-Dist: websockets (>=14.1,<15.0)
16
16
  Description-Content-Type: text/markdown
17
17
 
18
18
  # gazpar2haws
19
+
19
20
  Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface.
20
21
 
21
22
  It is compatible with Home Assistant Energy Dashboard and permits to upload the history and keep it updated with the latest readings.
22
23
 
24
+ It is a complement to the other available projects:
25
+
26
+ - [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar): HA integration that publishes a Gazpar entity with the corresponding meter value.
27
+ - [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).
28
+ - [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).
29
+
23
30
  ## Installation
24
31
 
25
- Gazpar2HAWS can be installed on any host as a standalone program.
32
+ Gazpar2HAWS can be installed in many ways.
26
33
 
27
- ### 1. Using source files
34
+ ### 1. Home Assistant Add-on
28
35
 
29
- The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
36
+ 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).
30
37
 
31
- ```sh
32
- $ cd /path/to/my_install_folder/
38
+ [![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)
33
39
 
34
- $ git clone https://github.com/ssenart/gazpar2haws.git
40
+ For usage and configuration, read the documentation [here](addons/gazpar2haws/DOCS.md).
35
41
 
36
- $ cd gazpar2haws
42
+ ### 2. Using Docker Hub
37
43
 
38
- $ poetry install
44
+ The following steps permits to run a container from an existing image available in the Docker Hub repository.
39
45
 
40
- $ poetry shell
46
+ 1. Copy and save the following docker-compose.yaml file:
47
+
48
+ ```yaml
49
+ services:
50
+ gazpar2haws:
51
+ image: ssenart/gazpar2haws:latest
52
+ container_name: gazpar2haws
53
+ restart: unless-stopped
54
+ network_mode: bridge
55
+ user: "1000:1000"
56
+ volumes:
57
+ - ./gazpar2haws/config:/app/config
58
+ - ./gazpar2haws/log:/app/log
59
+ environment:
60
+ - GRDF_USERNAME=<GrDF account username>
61
+ - GRDF_PASSWORD=<GrDF account password>
62
+ - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
63
+ - HOMEASSISTANT_HOST=<Home Assistant instance host name>
64
+ - HOMEASSISTANT_TOKEN=<Home Assistant access token>
65
+ ```
66
+
67
+ Edit the environment variable section according to your setup.
41
68
 
69
+ 2. Run the container:
70
+ ```sh
71
+ $ docker compose up -d
42
72
  ```
43
73
 
44
- ### 2. Using PIP package
74
+ ### 3. Using PIP package
45
75
 
46
76
  ```sh
47
77
  $ cd /path/to/my_install_folder/
@@ -58,7 +88,7 @@ $ pip install gazpar2haws
58
88
 
59
89
  ```
60
90
 
61
- ### 3. Using Dockerfile
91
+ ### 4. Using Dockerfile
62
92
 
63
93
  The following steps permit to build the Docker image based on the local source files.
64
94
 
@@ -88,36 +118,21 @@ $ docker compose -f docker/docker-compose.yaml build
88
118
  $ docker compose -f docker/docker-compose.yaml up -d
89
119
  ```
90
120
 
91
- ### 4. Using Docker Hub
121
+ ### 5. Using source files
92
122
 
93
- The following steps permits to run a container from an existing image available in the Docker Hub repository.
123
+ The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
94
124
 
95
- 1. Copy and save the following docker-compose.yaml file:
125
+ ```sh
126
+ $ cd /path/to/my_install_folder/
96
127
 
97
- ```yaml
98
- services:
99
- gazpar2haws:
100
- image: ssenart/gazpar2haws:latest
101
- container_name: gazpar2haws
102
- restart: unless-stopped
103
- network_mode: bridge
104
- user: "1000:1000"
105
- volumes:
106
- - ./gazpar2haws/config:/app/config
107
- - ./gazpar2haws/log:/app/log
108
- environment:
109
- - GRDF_USERNAME=<GrDF account username>
110
- - GRDF_PASSWORD=<GrDF account password>
111
- - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
112
- - HOMEASSISTANT_HOST=<Home Assistant instance host name>
113
- - HOMEASSISTANT_TOKEN=<Home Assistant access token>
114
- ```
128
+ $ git clone https://github.com/ssenart/gazpar2haws.git
115
129
 
116
- Edit the environment variable section according to your setup.
130
+ $ cd gazpar2haws
131
+
132
+ $ poetry install
133
+
134
+ $ poetry shell
117
135
 
118
- 2. Run the container:
119
- ```sh
120
- $ docker compose up -d
121
136
  ```
122
137
 
123
138
  ## Usage
@@ -172,31 +187,7 @@ The history is uploaded on the entities with names:
172
187
  - sensor.${name}_volume: Volume history in m³.
173
188
  - sensor.${name}_energy: Energy history in kWh.
174
189
 
175
- ${name} is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
176
-
177
- Those two entities have to already exist in Home Assistant.
178
-
179
- They may be created using the following templates:
180
-
181
- ```yaml
182
-
183
- - name: gazpar2haws_volume
184
- unit_of_measurement: 'm³'
185
- availability: true
186
- state: 0
187
- icon: mdi:fire
188
- device_class: gas
189
- state_class: total_increasing
190
-
191
- - name: gazpar2haws_energy
192
- unit_of_measurement: 'kWh'
193
- availability: true
194
- state: 0
195
- icon: mdi:fire
196
- device_class: energy
197
- state_class: total_increasing
198
-
199
- ```
190
+ `${name}` is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
200
191
 
201
192
  ### Environment variable for Docker
202
193
 
@@ -250,14 +241,17 @@ $ docker push --all-tags ssenart/gazpar2haws
250
241
  All the gazpar2haws images are available [here](https://hub.docker.com/repository/docker/ssenart/gazpar2haws/general).
251
242
 
252
243
  ## Contributing
253
- Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
244
+
245
+ Pull requests are welcome. For any change proposal, please open an issue first to discuss what you would like to change.
254
246
 
255
247
  Please make sure to update tests as appropriate.
256
248
 
257
249
  ## License
250
+
258
251
  [MIT](https://choosealicense.com/licenses/mit/)
259
252
 
260
253
  ## Project status
254
+
261
255
  Gazpar2HAWS has been initiated for integration with [Home Assistant](https://www.home-assistant.io/) energy dashboard.
262
256
 
263
257
 
{gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/README.md RENAMED
@@ -1,30 +1,60 @@
1
1
  # gazpar2haws
2
+
2
3
  Gazpar2HAWS is a gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface.
3
4
 
4
5
  It is compatible with Home Assistant Energy Dashboard and permits to upload the history and keep it updated with the latest readings.
5
6
 
7
+ It is a complement to the other available projects:
8
+
9
+ - [home-assistant-gazpar](https://github.com/ssenart/home-assistant-gazpar): HA integration that publishes a Gazpar entity with the corresponding meter value.
10
+ - [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).
11
+ - [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).
12
+
6
13
  ## Installation
7
14
 
8
- Gazpar2HAWS can be installed on any host as a standalone program.
15
+ Gazpar2HAWS can be installed in many ways.
9
16
 
10
- ### 1. Using source files
17
+ ### 1. Home Assistant Add-on
11
18
 
12
- The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
19
+ 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).
13
20
 
14
- ```sh
15
- $ cd /path/to/my_install_folder/
21
+ [![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)
16
22
 
17
- $ git clone https://github.com/ssenart/gazpar2haws.git
23
+ For usage and configuration, read the documentation [here](addons/gazpar2haws/DOCS.md).
18
24
 
19
- $ cd gazpar2haws
25
+ ### 2. Using Docker Hub
20
26
 
21
- $ poetry install
27
+ The following steps permits to run a container from an existing image available in the Docker Hub repository.
22
28
 
23
- $ poetry shell
29
+ 1. Copy and save the following docker-compose.yaml file:
30
+
31
+ ```yaml
32
+ services:
33
+ gazpar2haws:
34
+ image: ssenart/gazpar2haws:latest
35
+ container_name: gazpar2haws
36
+ restart: unless-stopped
37
+ network_mode: bridge
38
+ user: "1000:1000"
39
+ volumes:
40
+ - ./gazpar2haws/config:/app/config
41
+ - ./gazpar2haws/log:/app/log
42
+ environment:
43
+ - GRDF_USERNAME=<GrDF account username>
44
+ - GRDF_PASSWORD=<GrDF account password>
45
+ - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
46
+ - HOMEASSISTANT_HOST=<Home Assistant instance host name>
47
+ - HOMEASSISTANT_TOKEN=<Home Assistant access token>
48
+ ```
49
+
50
+ Edit the environment variable section according to your setup.
24
51
 
52
+ 2. Run the container:
53
+ ```sh
54
+ $ docker compose up -d
25
55
  ```
26
56
 
27
- ### 2. Using PIP package
57
+ ### 3. Using PIP package
28
58
 
29
59
  ```sh
30
60
  $ cd /path/to/my_install_folder/
@@ -41,7 +71,7 @@ $ pip install gazpar2haws
41
71
 
42
72
  ```
43
73
 
44
- ### 3. Using Dockerfile
74
+ ### 4. Using Dockerfile
45
75
 
46
76
  The following steps permit to build the Docker image based on the local source files.
47
77
 
@@ -71,36 +101,21 @@ $ docker compose -f docker/docker-compose.yaml build
71
101
  $ docker compose -f docker/docker-compose.yaml up -d
72
102
  ```
73
103
 
74
- ### 4. Using Docker Hub
104
+ ### 5. Using source files
75
105
 
76
- The following steps permits to run a container from an existing image available in the Docker Hub repository.
106
+ The project requires [Poetry](https://python-poetry.org/) tool for dependency and package management.
77
107
 
78
- 1. Copy and save the following docker-compose.yaml file:
108
+ ```sh
109
+ $ cd /path/to/my_install_folder/
79
110
 
80
- ```yaml
81
- services:
82
- gazpar2haws:
83
- image: ssenart/gazpar2haws:latest
84
- container_name: gazpar2haws
85
- restart: unless-stopped
86
- network_mode: bridge
87
- user: "1000:1000"
88
- volumes:
89
- - ./gazpar2haws/config:/app/config
90
- - ./gazpar2haws/log:/app/log
91
- environment:
92
- - GRDF_USERNAME=<GrDF account username>
93
- - GRDF_PASSWORD=<GrDF account password>
94
- - GRDF_PCE_IDENTIFIER=<GrDF PCE meter identifier>
95
- - HOMEASSISTANT_HOST=<Home Assistant instance host name>
96
- - HOMEASSISTANT_TOKEN=<Home Assistant access token>
97
- ```
111
+ $ git clone https://github.com/ssenart/gazpar2haws.git
98
112
 
99
- Edit the environment variable section according to your setup.
113
+ $ cd gazpar2haws
114
+
115
+ $ poetry install
116
+
117
+ $ poetry shell
100
118
 
101
- 2. Run the container:
102
- ```sh
103
- $ docker compose up -d
104
119
  ```
105
120
 
106
121
  ## Usage
@@ -155,31 +170,7 @@ The history is uploaded on the entities with names:
155
170
  - sensor.${name}_volume: Volume history in m³.
156
171
  - sensor.${name}_energy: Energy history in kWh.
157
172
 
158
- ${name} is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
159
-
160
- Those two entities have to already exist in Home Assistant.
161
-
162
- They may be created using the following templates:
163
-
164
- ```yaml
165
-
166
- - name: gazpar2haws_volume
167
- unit_of_measurement: 'm³'
168
- availability: true
169
- state: 0
170
- icon: mdi:fire
171
- device_class: gas
172
- state_class: total_increasing
173
-
174
- - name: gazpar2haws_energy
175
- unit_of_measurement: 'kWh'
176
- availability: true
177
- state: 0
178
- icon: mdi:fire
179
- device_class: energy
180
- state_class: total_increasing
181
-
182
- ```
173
+ `${name}` is 'gazpar2haws' defined in the above configuration file. It can be replaced by any other name.
183
174
 
184
175
  ### Environment variable for Docker
185
176
 
@@ -233,14 +224,17 @@ $ docker push --all-tags ssenart/gazpar2haws
233
224
  All the gazpar2haws images are available [here](https://hub.docker.com/repository/docker/ssenart/gazpar2haws/general).
234
225
 
235
226
  ## Contributing
236
- Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
227
+
228
+ Pull requests are welcome. For any change proposal, please open an issue first to discuss what you would like to change.
237
229
 
238
230
  Please make sure to update tests as appropriate.
239
231
 
240
232
  ## License
233
+
241
234
  [MIT](https://choosealicense.com/licenses/mit/)
242
235
 
243
236
  ## Project status
237
+
244
238
  Gazpar2HAWS has been initiated for integration with [Home Assistant](https://www.home-assistant.io/) energy dashboard.
245
239
 
246
240
 
{gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "gazpar2haws"
3
- version = "0.1.5"
3
+ version = "0.1.7"
4
4
  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"
5
5
  authors = ["Stéphane Senart"]
6
6
  license = "MIT"
{gazpar2haws-0.1.5 → gazpar2haws-0.1.7}/LICENSE RENAMED
File without changes