gazpar2haws 0.2.0a20__py3-none-any.whl → 0.2.0b1__py3-none-any.whl
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.
- gazpar2haws/__main__.py +104 -91
- gazpar2haws/bridge.py +9 -4
- gazpar2haws/config_utils.py +58 -56
- gazpar2haws/gazpar.py +229 -139
- gazpar2haws/haws.py +85 -32
- gazpar2haws/version.py +1 -1
- {gazpar2haws-0.2.0a20.dist-info → gazpar2haws-0.2.0b1.dist-info}/METADATA +1 -1
- gazpar2haws-0.2.0b1.dist-info/RECORD +11 -0
- gazpar2haws-0.2.0a20.dist-info/RECORD +0 -11
- {gazpar2haws-0.2.0a20.dist-info → gazpar2haws-0.2.0b1.dist-info}/LICENSE +0 -0
- {gazpar2haws-0.2.0a20.dist-info → gazpar2haws-0.2.0b1.dist-info}/WHEEL +0 -0
gazpar2haws/__main__.py
CHANGED
@@ -1,91 +1,104 @@
|
|
1
|
-
import
|
2
|
-
import
|
3
|
-
import logging
|
4
|
-
import traceback
|
5
|
-
|
6
|
-
from gazpar2haws import __version__
|
7
|
-
from gazpar2haws.bridge import Bridge
|
8
|
-
|
9
|
-
Logger = logging.getLogger(__name__)
|
10
|
-
|
11
|
-
|
12
|
-
# ----------------------------------
|
13
|
-
async def main():
|
14
|
-
"""Main function"""
|
15
|
-
parser = argparse.ArgumentParser(
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
parser.add_argument(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
config.
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
1
|
+
import argparse
|
2
|
+
import asyncio
|
3
|
+
import logging
|
4
|
+
import traceback
|
5
|
+
|
6
|
+
from gazpar2haws import __version__, config_utils
|
7
|
+
from gazpar2haws.bridge import Bridge
|
8
|
+
|
9
|
+
Logger = logging.getLogger(__name__)
|
10
|
+
|
11
|
+
|
12
|
+
# ----------------------------------
|
13
|
+
async def main():
|
14
|
+
"""Main function"""
|
15
|
+
parser = argparse.ArgumentParser(
|
16
|
+
prog="gazpar2haws",
|
17
|
+
description="Gateway that reads data history from the GrDF (French gas provider) meter and send it to Home Assistant using WebSocket interface.",
|
18
|
+
)
|
19
|
+
parser.add_argument(
|
20
|
+
"-v", "--version", action="version", version="Gazpar2HAWS version"
|
21
|
+
)
|
22
|
+
parser.add_argument(
|
23
|
+
"-c",
|
24
|
+
"--config",
|
25
|
+
required=False,
|
26
|
+
default="config/configuration.yaml",
|
27
|
+
help="Path to the configuration file",
|
28
|
+
)
|
29
|
+
parser.add_argument(
|
30
|
+
"-s",
|
31
|
+
"--secrets",
|
32
|
+
required=False,
|
33
|
+
default="config/secrets.yaml",
|
34
|
+
help="Path to the secret file",
|
35
|
+
)
|
36
|
+
|
37
|
+
args = parser.parse_args()
|
38
|
+
|
39
|
+
try:
|
40
|
+
# Load configuration files
|
41
|
+
config = config_utils.ConfigLoader(args.config, args.secrets)
|
42
|
+
config.load_secrets()
|
43
|
+
config.load_config()
|
44
|
+
|
45
|
+
print(f"Gazpar2HAWS version: {__version__}")
|
46
|
+
|
47
|
+
# Set up logging
|
48
|
+
logging_file = config.get("logging.file")
|
49
|
+
logging_console = bool(config.get("logging.console"))
|
50
|
+
logging_level = config.get("logging.level")
|
51
|
+
logging_format = config.get("logging.format")
|
52
|
+
|
53
|
+
# Convert logging level to integer
|
54
|
+
if logging_level.upper() == "DEBUG":
|
55
|
+
level = logging.DEBUG
|
56
|
+
elif logging_level.upper() == "INFO":
|
57
|
+
level = logging.INFO
|
58
|
+
elif logging_level.upper() == "WARNING":
|
59
|
+
level = logging.WARNING
|
60
|
+
elif logging_level.upper() == "ERROR":
|
61
|
+
level = logging.ERROR
|
62
|
+
elif logging_level.upper() == "CRITICAL":
|
63
|
+
level = logging.CRITICAL
|
64
|
+
else:
|
65
|
+
level = logging.INFO
|
66
|
+
|
67
|
+
logging.basicConfig(filename=logging_file, level=level, format=logging_format)
|
68
|
+
|
69
|
+
if logging_console:
|
70
|
+
# Add a console handler manually
|
71
|
+
console_handler = logging.StreamHandler()
|
72
|
+
console_handler.setLevel(level) # Set logging level for the console
|
73
|
+
console_handler.setFormatter(
|
74
|
+
logging.Formatter(logging_format)
|
75
|
+
) # Customize console format
|
76
|
+
|
77
|
+
# Get the root logger and add the console handler
|
78
|
+
logging.getLogger().addHandler(console_handler)
|
79
|
+
|
80
|
+
Logger.info(f"Starting Gazpar2HAWS version {__version__}")
|
81
|
+
|
82
|
+
# Log configuration
|
83
|
+
Logger.info(f"Configuration:\n{config.dumps()}")
|
84
|
+
|
85
|
+
# Start the bridge
|
86
|
+
bridge = Bridge(config)
|
87
|
+
await bridge.run()
|
88
|
+
|
89
|
+
Logger.info("Gazpar2HAWS stopped.")
|
90
|
+
|
91
|
+
return 0
|
92
|
+
|
93
|
+
except Exception: # pylint: disable=broad-except
|
94
|
+
errorMessage = (
|
95
|
+
f"An error occured while running Gazpar2HAWS: {traceback.format_exc()}"
|
96
|
+
)
|
97
|
+
Logger.error(errorMessage)
|
98
|
+
print(errorMessage)
|
99
|
+
return 1
|
100
|
+
|
101
|
+
|
102
|
+
# ----------------------------------
|
103
|
+
if __name__ == "__main__":
|
104
|
+
asyncio.run(main())
|
gazpar2haws/bridge.py
CHANGED
@@ -1,6 +1,7 @@
|
|
1
|
+
import asyncio
|
1
2
|
import logging
|
2
3
|
import signal
|
3
|
-
|
4
|
+
|
4
5
|
from gazpar2haws import config_utils
|
5
6
|
from gazpar2haws.gazpar import Gazpar
|
6
7
|
from gazpar2haws.haws import HomeAssistantWS
|
@@ -40,7 +41,7 @@ class Bridge:
|
|
40
41
|
|
41
42
|
# ----------------------------------
|
42
43
|
# Graceful shutdown function
|
43
|
-
def handle_signal(self, signum,
|
44
|
+
def handle_signal(self, signum, _):
|
44
45
|
print(f"Signal {signum} received. Shutting down gracefully...")
|
45
46
|
Logger.info(f"Signal {signum} received. Shutting down gracefully...")
|
46
47
|
self._running = False
|
@@ -63,7 +64,9 @@ class Bridge:
|
|
63
64
|
for gazpar in self._gazpar:
|
64
65
|
Logger.info(f"Publishing data for device '{gazpar.name()}'...")
|
65
66
|
await gazpar.publish()
|
66
|
-
Logger.info(
|
67
|
+
Logger.info(
|
68
|
+
f"Device '{gazpar.name()}' data published to Home Assistant WS."
|
69
|
+
)
|
67
70
|
|
68
71
|
Logger.info("Gazpar data published to Home Assistant WS.")
|
69
72
|
|
@@ -71,7 +74,9 @@ class Bridge:
|
|
71
74
|
await self._homeassistant.disconnect()
|
72
75
|
|
73
76
|
# Wait before next scan
|
74
|
-
Logger.info(
|
77
|
+
Logger.info(
|
78
|
+
f"Waiting {self._grdf_scan_interval} minutes before next scan..."
|
79
|
+
)
|
75
80
|
|
76
81
|
# Check if the scan interval is 0 and leave the loop.
|
77
82
|
if self._grdf_scan_interval == 0:
|
gazpar2haws/config_utils.py
CHANGED
@@ -1,56 +1,58 @@
|
|
1
|
-
import
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
self.
|
9
|
-
self.
|
10
|
-
self.
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
self.
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
return
|
54
|
-
|
55
|
-
|
56
|
-
|
1
|
+
import os
|
2
|
+
|
3
|
+
import yaml
|
4
|
+
|
5
|
+
|
6
|
+
class ConfigLoader:
|
7
|
+
def __init__(self, config_file="config.yaml", secrets_file="secrets.yaml"):
|
8
|
+
self.config_file = config_file
|
9
|
+
self.secrets_file = secrets_file
|
10
|
+
self.config = {}
|
11
|
+
self.secrets = {}
|
12
|
+
self.raw_config = None
|
13
|
+
|
14
|
+
def load_secrets(self):
|
15
|
+
"""Load the secrets file."""
|
16
|
+
if os.path.exists(self.secrets_file):
|
17
|
+
with open(self.secrets_file, "r", encoding="utf-8") as file:
|
18
|
+
self.secrets = yaml.safe_load(file)
|
19
|
+
else:
|
20
|
+
raise FileNotFoundError(f"Secrets file '{self.secrets_file}' not found.")
|
21
|
+
|
22
|
+
def load_config(self):
|
23
|
+
"""Load the main configuration file and resolve secrets."""
|
24
|
+
if os.path.exists(self.config_file):
|
25
|
+
with open(self.config_file, "r", encoding="utf-8") as file:
|
26
|
+
self.raw_config = yaml.safe_load(file)
|
27
|
+
self.config = self._resolve_secrets(self.raw_config)
|
28
|
+
else:
|
29
|
+
raise FileNotFoundError(
|
30
|
+
f"Configuration file '{self.config_file}' not found."
|
31
|
+
)
|
32
|
+
|
33
|
+
def _resolve_secrets(self, data):
|
34
|
+
"""Recursively resolve `!secret` keys in the configuration."""
|
35
|
+
if isinstance(data, dict):
|
36
|
+
return {key: self._resolve_secrets(value) for key, value in data.items()}
|
37
|
+
if isinstance(data, list):
|
38
|
+
return [self._resolve_secrets(item) for item in data]
|
39
|
+
if isinstance(data, str) and data.startswith("!secret"):
|
40
|
+
secret_key = data.split(" ", 1)[1]
|
41
|
+
if secret_key in self.secrets:
|
42
|
+
return self.secrets[secret_key]
|
43
|
+
raise KeyError(f"Secret key '{secret_key}' not found in secrets file.")
|
44
|
+
return data
|
45
|
+
|
46
|
+
def get(self, key, default=None):
|
47
|
+
"""Get a configuration value."""
|
48
|
+
keys = key.split(".")
|
49
|
+
value = self.config
|
50
|
+
try:
|
51
|
+
for k in keys:
|
52
|
+
value = value[k]
|
53
|
+
return value
|
54
|
+
except (KeyError, TypeError):
|
55
|
+
return default
|
56
|
+
|
57
|
+
def dumps(self) -> str:
|
58
|
+
return yaml.dump(self.raw_config)
|
gazpar2haws/gazpar.py
CHANGED
@@ -1,139 +1,229 @@
|
|
1
|
-
import
|
2
|
-
import traceback
|
3
|
-
import
|
4
|
-
import
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
self.
|
24
|
-
self.
|
25
|
-
self.
|
26
|
-
self.
|
27
|
-
self.
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
date
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
1
|
+
import logging
|
2
|
+
import traceback
|
3
|
+
from datetime import datetime, timedelta
|
4
|
+
from typing import Any
|
5
|
+
|
6
|
+
import pygazpar # type: ignore
|
7
|
+
import pytz
|
8
|
+
|
9
|
+
from gazpar2haws.haws import HomeAssistantWS, HomeAssistantWSException
|
10
|
+
|
11
|
+
Logger = logging.getLogger(__name__)
|
12
|
+
|
13
|
+
|
14
|
+
# ----------------------------------
|
15
|
+
class Gazpar:
|
16
|
+
|
17
|
+
# ----------------------------------
|
18
|
+
def __init__(self, config: dict[str, Any], homeassistant: HomeAssistantWS):
|
19
|
+
|
20
|
+
self._homeassistant = homeassistant
|
21
|
+
|
22
|
+
# GrDF configuration
|
23
|
+
self._name = config.get("name")
|
24
|
+
self._data_source = config.get("data_source")
|
25
|
+
self._username = config.get("username")
|
26
|
+
self._password = config.get("password")
|
27
|
+
self._pce_identifier = str(config.get("pce_identifier"))
|
28
|
+
self._tmp_dir = config.get("tmp_dir")
|
29
|
+
self._last_days = int(str(config.get("last_days")))
|
30
|
+
self._timezone = str(config.get("timezone"))
|
31
|
+
self._reset = bool(config.get("reset"))
|
32
|
+
|
33
|
+
# As of date: YYYY-MM-DD
|
34
|
+
as_of_date = config.get("as_of_date")
|
35
|
+
if self._data_source is not None and str(self._data_source).lower() == "test":
|
36
|
+
self._as_of_date = (
|
37
|
+
datetime.now(tz=pytz.timezone(self._timezone))
|
38
|
+
if as_of_date is None
|
39
|
+
else datetime.strptime(as_of_date, "%Y-%m-%d")
|
40
|
+
)
|
41
|
+
else:
|
42
|
+
self._as_of_date = datetime.now(tz=pytz.timezone(self._timezone))
|
43
|
+
|
44
|
+
# Set the timezone
|
45
|
+
timezone = pytz.timezone(self._timezone)
|
46
|
+
self._as_of_date = timezone.localize(self._as_of_date)
|
47
|
+
|
48
|
+
# ----------------------------------
|
49
|
+
def name(self):
|
50
|
+
return self._name
|
51
|
+
|
52
|
+
# ----------------------------------
|
53
|
+
# Publish Gaspar data to Home Assistant WS
|
54
|
+
async def publish(self):
|
55
|
+
|
56
|
+
# Volume and energy sensor names.
|
57
|
+
volume_sensor_name = f"sensor.{self._name}_volume"
|
58
|
+
energy_sensor_name = f"sensor.{self._name}_energy"
|
59
|
+
|
60
|
+
# Eventually reset the sensor in Home Assistant
|
61
|
+
if self._reset:
|
62
|
+
try:
|
63
|
+
await self._homeassistant.clear_statistics(
|
64
|
+
[volume_sensor_name, energy_sensor_name]
|
65
|
+
)
|
66
|
+
except Exception:
|
67
|
+
Logger.warning(
|
68
|
+
f"Error while resetting the sensor in Home Assistant: {traceback.format_exc()}"
|
69
|
+
)
|
70
|
+
raise
|
71
|
+
|
72
|
+
# Publish volume sensor
|
73
|
+
await self._publish_entity(
|
74
|
+
volume_sensor_name, pygazpar.PropertyName.VOLUME.value, "m³"
|
75
|
+
)
|
76
|
+
await self._publish_entity(
|
77
|
+
energy_sensor_name, pygazpar.PropertyName.ENERGY.value, "kWh"
|
78
|
+
)
|
79
|
+
|
80
|
+
# ----------------------------------
|
81
|
+
# Publish a sensor to Home Assistant
|
82
|
+
async def _publish_entity(
|
83
|
+
self, entity_id: str, property_name: str, unit_of_measurement: str
|
84
|
+
):
|
85
|
+
|
86
|
+
# Find last date, days and value of the entity.
|
87
|
+
last_date, last_days, last_value = await self._find_last_date_days_value(
|
88
|
+
entity_id
|
89
|
+
)
|
90
|
+
|
91
|
+
# Instantiate the right data source.
|
92
|
+
data_source = self._create_data_source()
|
93
|
+
|
94
|
+
# Initialize PyGazpar client
|
95
|
+
client = pygazpar.Client(data_source)
|
96
|
+
|
97
|
+
try:
|
98
|
+
data = client.loadSince(
|
99
|
+
pceIdentifier=self._pce_identifier,
|
100
|
+
lastNDays=last_days,
|
101
|
+
frequencies=[pygazpar.Frequency.DAILY],
|
102
|
+
)
|
103
|
+
except Exception: # pylint: disable=broad-except
|
104
|
+
Logger.warning(
|
105
|
+
f"Error while fetching data from GrDF: {traceback.format_exc()}"
|
106
|
+
)
|
107
|
+
data = {}
|
108
|
+
|
109
|
+
# Timezone
|
110
|
+
timezone = pytz.timezone(self._timezone)
|
111
|
+
|
112
|
+
# Compute and fill statistics.
|
113
|
+
daily = data.get(pygazpar.Frequency.DAILY.value)
|
114
|
+
statistics = []
|
115
|
+
total = last_value
|
116
|
+
for reading in daily:
|
117
|
+
# Parse date format DD/MM/YYYY into datetime.
|
118
|
+
date = datetime.strptime(
|
119
|
+
reading[pygazpar.PropertyName.TIME_PERIOD.value], "%d/%m/%Y"
|
120
|
+
)
|
121
|
+
|
122
|
+
# Set the timezone
|
123
|
+
date = timezone.localize(date)
|
124
|
+
|
125
|
+
# Skip all readings before the last statistic date.
|
126
|
+
if date <= last_date:
|
127
|
+
Logger.debug(f"Skip date: {date} <= {last_date}")
|
128
|
+
continue
|
129
|
+
|
130
|
+
# Compute the total volume and energy
|
131
|
+
total += reading[property_name]
|
132
|
+
|
133
|
+
statistics.append({"start": date.isoformat(), "state": total, "sum": total})
|
134
|
+
|
135
|
+
# Publish statistics to Home Assistant
|
136
|
+
try:
|
137
|
+
await self._homeassistant.import_statistics(
|
138
|
+
entity_id, "recorder", "gazpar2haws", unit_of_measurement, statistics
|
139
|
+
)
|
140
|
+
except Exception:
|
141
|
+
Logger.warning(
|
142
|
+
f"Error while importing statistics to Home Assistant: {traceback.format_exc()}"
|
143
|
+
)
|
144
|
+
raise
|
145
|
+
|
146
|
+
# ----------------------------------
|
147
|
+
# Create the data source.
|
148
|
+
def _create_data_source(self) -> pygazpar.datasource.IDataSource:
|
149
|
+
|
150
|
+
if self._data_source is not None:
|
151
|
+
if str(self._data_source).lower() == "test":
|
152
|
+
return pygazpar.TestDataSource()
|
153
|
+
|
154
|
+
if str(self._data_source).lower() == "excel":
|
155
|
+
return pygazpar.ExcelWebDataSource(
|
156
|
+
username=self._username,
|
157
|
+
password=self._password,
|
158
|
+
tmpDirectory=self._tmp_dir,
|
159
|
+
)
|
160
|
+
|
161
|
+
return pygazpar.JsonWebDataSource(
|
162
|
+
username=self._username, password=self._password
|
163
|
+
)
|
164
|
+
|
165
|
+
# ----------------------------------
|
166
|
+
# Find last date, days and value of the entity.
|
167
|
+
async def _find_last_date_days_value(
|
168
|
+
self, entity_id: str
|
169
|
+
) -> tuple[datetime, int, float]:
|
170
|
+
|
171
|
+
# Check the existence of the sensor in Home Assistant
|
172
|
+
try:
|
173
|
+
exists_statistic_id = await self._homeassistant.exists_statistic_id(
|
174
|
+
entity_id, "sum"
|
175
|
+
)
|
176
|
+
except Exception:
|
177
|
+
Logger.warning(
|
178
|
+
f"Error while checking the existence of the sensor in Home Assistant: {traceback.format_exc()}"
|
179
|
+
)
|
180
|
+
raise
|
181
|
+
|
182
|
+
if exists_statistic_id:
|
183
|
+
# Get the last statistic from Home Assistant
|
184
|
+
try:
|
185
|
+
last_statistic = await self._homeassistant.get_last_statistic(
|
186
|
+
entity_id, self._as_of_date, self._last_days
|
187
|
+
)
|
188
|
+
except HomeAssistantWSException:
|
189
|
+
Logger.warning(
|
190
|
+
f"Error while fetching last statistics from Home Assistant: {traceback.format_exc()}"
|
191
|
+
)
|
192
|
+
|
193
|
+
if last_statistic:
|
194
|
+
# Extract the end date of the last statistics from the unix timestamp
|
195
|
+
last_date = datetime.fromtimestamp(
|
196
|
+
int(str(last_statistic.get("start"))) / 1000,
|
197
|
+
tz=pytz.timezone(self._timezone),
|
198
|
+
)
|
199
|
+
|
200
|
+
# Compute the number of days since the last statistics
|
201
|
+
last_days = (self._as_of_date - last_date).days
|
202
|
+
|
203
|
+
# Get the last meter value
|
204
|
+
last_value = float(str(last_statistic.get("sum")))
|
205
|
+
|
206
|
+
Logger.debug(
|
207
|
+
f"Last date: {last_date}, last days: {last_days}, last value: {last_value}"
|
208
|
+
)
|
209
|
+
|
210
|
+
return last_date, last_days, last_value
|
211
|
+
|
212
|
+
Logger.debug(f"No statistics found for the existing sensor {entity_id}.")
|
213
|
+
else:
|
214
|
+
Logger.debug(f"Sensor {entity_id} does not exist in Home Assistant.")
|
215
|
+
|
216
|
+
# If the sensor does not exist in Home Assistant, fetch the last days defined in the configuration
|
217
|
+
last_days = self._last_days
|
218
|
+
|
219
|
+
# Compute the corresponding last_date
|
220
|
+
last_date = self._as_of_date - timedelta(days=last_days)
|
221
|
+
|
222
|
+
# If no statistic, the last value is initialized to zero
|
223
|
+
last_value = 0
|
224
|
+
|
225
|
+
Logger.debug(
|
226
|
+
f"Last date: {last_date}, last days: {last_days}, last value: {last_value}"
|
227
|
+
)
|
228
|
+
|
229
|
+
return last_date, last_days, last_value
|
gazpar2haws/haws.py
CHANGED
@@ -1,13 +1,20 @@
|
|
1
|
-
import websockets
|
2
1
|
import json
|
3
|
-
from datetime import datetime, timedelta
|
4
2
|
import logging
|
3
|
+
from datetime import datetime, timedelta
|
4
|
+
|
5
|
+
import websockets
|
5
6
|
|
6
7
|
Logger = logging.getLogger(__name__)
|
7
8
|
|
8
9
|
|
10
|
+
# ----------------------------------
|
11
|
+
class HomeAssistantWSException(Exception):
|
12
|
+
pass
|
13
|
+
|
14
|
+
|
9
15
|
# ----------------------------------
|
10
16
|
class HomeAssistantWS:
|
17
|
+
# ----------------------------------
|
11
18
|
def __init__(self, host: str, port: str, endpoint: str, token: str):
|
12
19
|
self._host = host
|
13
20
|
self._port = port
|
@@ -24,7 +31,9 @@ class HomeAssistantWS:
|
|
24
31
|
ws_url = f"ws://{self._host}:{self._port}{self._endpoint}"
|
25
32
|
|
26
33
|
# Connect to the websocket
|
27
|
-
self._websocket = await websockets.connect(
|
34
|
+
self._websocket = await websockets.connect(
|
35
|
+
ws_url, additional_headers={"Authorization": f"Bearer {self._token}"}
|
36
|
+
)
|
28
37
|
|
29
38
|
# When a client connects to the server, the server sends out auth_required.
|
30
39
|
connect_response = await self._websocket.recv()
|
@@ -33,7 +42,7 @@ class HomeAssistantWS:
|
|
33
42
|
if connect_response_data.get("type") != "auth_required":
|
34
43
|
message = f"Authentication failed: auth_required not received {connect_response_data.get('messsage')}"
|
35
44
|
Logger.warning(message)
|
36
|
-
raise
|
45
|
+
raise HomeAssistantWSException(message)
|
37
46
|
|
38
47
|
# The first message from the client should be an auth message. You can authorize with an access token.
|
39
48
|
auth_message = {"type": "auth", "access_token": self._token}
|
@@ -46,7 +55,7 @@ class HomeAssistantWS:
|
|
46
55
|
if auth_response_data.get("type") == "auth_invalid":
|
47
56
|
message = f"Authentication failed: {auth_response_data.get('messsage')}"
|
48
57
|
Logger.warning(message)
|
49
|
-
raise
|
58
|
+
raise HomeAssistantWSException(message)
|
50
59
|
|
51
60
|
Logger.debug("Connected to Home Assistant")
|
52
61
|
|
@@ -60,10 +69,13 @@ class HomeAssistantWS:
|
|
60
69
|
Logger.debug("Disconnected from Home Assistant")
|
61
70
|
|
62
71
|
# ----------------------------------
|
63
|
-
async def send_message(self, message: dict) -> dict:
|
72
|
+
async def send_message(self, message: dict) -> dict | list[dict]:
|
64
73
|
|
65
74
|
Logger.debug("Sending a message...")
|
66
75
|
|
76
|
+
if self._websocket is None:
|
77
|
+
raise HomeAssistantWSException("Not connected to Home Assistant")
|
78
|
+
|
67
79
|
message["id"] = self._message_id
|
68
80
|
|
69
81
|
self._message_id += 1
|
@@ -77,40 +89,50 @@ class HomeAssistantWS:
|
|
77
89
|
Logger.debug("Received response")
|
78
90
|
|
79
91
|
if response_data.get("type") != "result":
|
80
|
-
raise
|
92
|
+
raise HomeAssistantWSException(f"Invalid response message: {response_data}")
|
81
93
|
|
82
94
|
if not response_data.get("success"):
|
83
|
-
raise
|
95
|
+
raise HomeAssistantWSException(
|
96
|
+
f"Request failed: {response_data.get('error')}"
|
97
|
+
)
|
84
98
|
|
85
99
|
return response_data.get("result")
|
86
100
|
|
87
101
|
# ----------------------------------
|
88
|
-
async def list_statistic_ids(self, statistic_type: str = None) -> list[
|
102
|
+
async def list_statistic_ids(self, statistic_type: str | None = None) -> list[dict]:
|
89
103
|
|
90
104
|
Logger.debug("Listing statistics IDs...")
|
91
105
|
|
92
106
|
# List statistics IDs message
|
93
|
-
list_statistic_ids_message = {
|
94
|
-
"type": "recorder/list_statistic_ids"
|
95
|
-
}
|
107
|
+
list_statistic_ids_message = {"type": "recorder/list_statistic_ids"}
|
96
108
|
|
97
109
|
if statistic_type is not None:
|
98
110
|
list_statistic_ids_message["statistic_type"] = statistic_type
|
99
111
|
|
100
112
|
response = await self.send_message(list_statistic_ids_message)
|
101
113
|
|
114
|
+
# Check response instance type
|
115
|
+
if not isinstance(response, list):
|
116
|
+
raise HomeAssistantWSException(
|
117
|
+
f"Invalid list_statistic_ids response type: got {type(response)} instead of list[dict]"
|
118
|
+
)
|
119
|
+
|
102
120
|
Logger.debug(f"Listed statistics IDs: {len(response)} ids")
|
103
121
|
|
104
122
|
return response
|
105
123
|
|
106
124
|
# ----------------------------------
|
107
|
-
async def exists_statistic_id(
|
125
|
+
async def exists_statistic_id(
|
126
|
+
self, entity_id: str, statistic_type: str | None = None
|
127
|
+
) -> bool:
|
108
128
|
|
109
129
|
Logger.debug(f"Checking if {entity_id} exists...")
|
110
130
|
|
111
131
|
statistic_ids = await self.list_statistic_ids(statistic_type)
|
112
132
|
|
113
|
-
entity_ids = [
|
133
|
+
entity_ids = [
|
134
|
+
statistic_id.get("statistic_id") for statistic_id in statistic_ids
|
135
|
+
]
|
114
136
|
|
115
137
|
exists_statistic = entity_id in entity_ids
|
116
138
|
|
@@ -119,9 +141,13 @@ class HomeAssistantWS:
|
|
119
141
|
return exists_statistic
|
120
142
|
|
121
143
|
# ----------------------------------
|
122
|
-
async def statistics_during_period(
|
144
|
+
async def statistics_during_period(
|
145
|
+
self, entity_ids: list[str], start_time: datetime, end_time: datetime
|
146
|
+
) -> dict:
|
123
147
|
|
124
|
-
Logger.debug(
|
148
|
+
Logger.debug(
|
149
|
+
f"Getting {entity_ids} statistics during period from {start_time} to {end_time}..."
|
150
|
+
)
|
125
151
|
|
126
152
|
# Subscribe to statistics
|
127
153
|
statistics_message = {
|
@@ -129,30 +155,55 @@ class HomeAssistantWS:
|
|
129
155
|
"start_time": start_time.isoformat(),
|
130
156
|
"end_time": end_time.isoformat(),
|
131
157
|
"statistic_ids": entity_ids,
|
132
|
-
"period": "day"
|
158
|
+
"period": "day",
|
133
159
|
}
|
134
160
|
|
135
161
|
response = await self.send_message(statistics_message)
|
136
162
|
|
137
|
-
|
163
|
+
# Check response instance type
|
164
|
+
if not isinstance(response, dict):
|
165
|
+
raise HomeAssistantWSException(
|
166
|
+
f"Invalid statistics_during_period response type: got {type(response)} instead of dict"
|
167
|
+
)
|
168
|
+
|
169
|
+
Logger.debug(
|
170
|
+
f"Received {entity_ids} statistics during period from {start_time} to {end_time}"
|
171
|
+
)
|
138
172
|
|
139
173
|
return response
|
140
174
|
|
141
175
|
# ----------------------------------
|
142
|
-
async def get_last_statistic(
|
176
|
+
async def get_last_statistic(
|
177
|
+
self, entity_id: str, as_of_date: datetime, depth_days: int
|
178
|
+
) -> dict:
|
143
179
|
|
144
180
|
Logger.debug(f"Getting last statistic for {entity_id}...")
|
145
181
|
|
146
|
-
statistics = await self.statistics_during_period(
|
182
|
+
statistics = await self.statistics_during_period(
|
183
|
+
[entity_id], as_of_date - timedelta(days=depth_days), as_of_date
|
184
|
+
)
|
185
|
+
|
186
|
+
if not statistics:
|
187
|
+
Logger.warning(f"No statistics found for {entity_id}.")
|
188
|
+
return {}
|
147
189
|
|
148
190
|
Logger.debug(f"Last statistic for {entity_id}: {statistics[entity_id][-1]}")
|
149
191
|
|
150
192
|
return statistics[entity_id][-1]
|
151
193
|
|
152
194
|
# ----------------------------------
|
153
|
-
async def import_statistics(
|
154
|
-
|
155
|
-
|
195
|
+
async def import_statistics(
|
196
|
+
self,
|
197
|
+
entity_id: str,
|
198
|
+
source: str,
|
199
|
+
name: str,
|
200
|
+
unit_of_measurement: str,
|
201
|
+
statistics: list[dict],
|
202
|
+
):
|
203
|
+
|
204
|
+
Logger.debug(
|
205
|
+
f"Importing {len(statistics)} statistics for {entity_id} from {source}..."
|
206
|
+
)
|
156
207
|
|
157
208
|
if len(statistics) == 0:
|
158
209
|
Logger.debug("No statistics to import")
|
@@ -162,19 +213,21 @@ class HomeAssistantWS:
|
|
162
213
|
import_statistics_message = {
|
163
214
|
"type": "recorder/import_statistics",
|
164
215
|
"metadata": {
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
216
|
+
"has_mean": False,
|
217
|
+
"has_sum": True,
|
218
|
+
"statistic_id": entity_id,
|
219
|
+
"source": source,
|
220
|
+
"name": name,
|
221
|
+
"unit_of_measurement": unit_of_measurement,
|
171
222
|
},
|
172
|
-
"stats": statistics
|
223
|
+
"stats": statistics,
|
173
224
|
}
|
174
225
|
|
175
226
|
await self.send_message(import_statistics_message)
|
176
227
|
|
177
|
-
Logger.debug(
|
228
|
+
Logger.debug(
|
229
|
+
f"Imported {len(statistics)} statistics for {entity_id} from {source}"
|
230
|
+
)
|
178
231
|
|
179
232
|
# ----------------------------------
|
180
233
|
async def clear_statistics(self, entity_ids: list[str]):
|
@@ -184,7 +237,7 @@ class HomeAssistantWS:
|
|
184
237
|
# Clear statistics message
|
185
238
|
clear_statistics_message = {
|
186
239
|
"type": "recorder/clear_statistics",
|
187
|
-
"statistic_ids": entity_ids
|
240
|
+
"statistic_ids": entity_ids,
|
188
241
|
}
|
189
242
|
|
190
243
|
await self.send_message(clear_statistics_message)
|
gazpar2haws/version.py
CHANGED
@@ -0,0 +1,11 @@
|
|
1
|
+
gazpar2haws/__init__.py,sha256=3MCDQdGGmT3FQMKaAB3mBJq7L75T_bJSdpDRjE-pado,58
|
2
|
+
gazpar2haws/__main__.py,sha256=KdhkowqJP6L8WTF9FNpTy4ZzDf1OPARm6mVtMclxGFk,3265
|
3
|
+
gazpar2haws/bridge.py,sha256=s8ENqugNhxTJMAOJzRwVt1YidwxzbPfwdWKx7TLQN7w,3625
|
4
|
+
gazpar2haws/config_utils.py,sha256=89ClKudFGxiT_EnzqRhfEvYVm9SeWq6U2xhNjvm3hhs,2161
|
5
|
+
gazpar2haws/gazpar.py,sha256=6FyKUKtvn9zlpHbyaUvEYs6uUK7Bnx8LDGB9Nbs_E58,8327
|
6
|
+
gazpar2haws/haws.py,sha256=H--UWGECYq9JYlbU6IHLO2btaRXInwoVRZnHIXSA1ts,8169
|
7
|
+
gazpar2haws/version.py,sha256=9Iq5Jm63Ev7QquCjhDqa9_KAgHdKl9FJHynq8M6JNrY,83
|
8
|
+
gazpar2haws-0.2.0b1.dist-info/LICENSE,sha256=ajApZPyhVx8AU9wN7DXeRGhoWFqY2ylBZUa5GRhTmok,1073
|
9
|
+
gazpar2haws-0.2.0b1.dist-info/METADATA,sha256=-TB33G3v3eu9r1Uv33ffcP-zBRMpBQBIY3nezSwYFV4,9452
|
10
|
+
gazpar2haws-0.2.0b1.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
|
11
|
+
gazpar2haws-0.2.0b1.dist-info/RECORD,,
|
@@ -1,11 +0,0 @@
|
|
1
|
-
gazpar2haws/__init__.py,sha256=3MCDQdGGmT3FQMKaAB3mBJq7L75T_bJSdpDRjE-pado,58
|
2
|
-
gazpar2haws/__main__.py,sha256=EMWGYVVfKEJySSvn8fmNfzFZWVjsPefUFyt4gTC506w,3162
|
3
|
-
gazpar2haws/bridge.py,sha256=plcXR8y6lH84OSHuUOogNcbM7uua24inoF9SSERKGHo,3539
|
4
|
-
gazpar2haws/config_utils.py,sha256=Q_-07kAIqvjjHG27tHLLnyaTAZcFVdt1iRzksz2wy1k,2067
|
5
|
-
gazpar2haws/gazpar.py,sha256=jXpOtqWW6fv6BQmVLoA0G7B93HjztY7MemvGnszBXPU,5615
|
6
|
-
gazpar2haws/haws.py,sha256=H0Qa01Qtsn3QdnGqIGkXE-Ympf7MSXkbFwAbzaMAodM,6895
|
7
|
-
gazpar2haws/version.py,sha256=tJINl5RAPtGkwDz8nWdcM1emyqLY2N2XfgsBHuofz5U,83
|
8
|
-
gazpar2haws-0.2.0a20.dist-info/LICENSE,sha256=ajApZPyhVx8AU9wN7DXeRGhoWFqY2ylBZUa5GRhTmok,1073
|
9
|
-
gazpar2haws-0.2.0a20.dist-info/METADATA,sha256=WsuiUmV_gYflm_ILcy4pIsuGWBn0rsPOWEb9UxVAIe0,9453
|
10
|
-
gazpar2haws-0.2.0a20.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
|
11
|
-
gazpar2haws-0.2.0a20.dist-info/RECORD,,
|
File without changes
|
File without changes
|