-
-
-
- """
- with (pathlib.Path(__file__).parent / "monthly_report_template.html").open(encoding="utf-8") as template_file:
- html_template = template_file.read()
-
- return jinja2.Template(html_template).render(
- month=_get_previous_month_name(),
- energy_now=f"{self._config.items.energy_sum.value:.1f}",
- energy_last_month=f"{energy_sum_month:.1f}",
- habapp_version=habapp_rules.__version__.__version__,
- chart="{{ chart }}" # this is needed to not replace the chart from the mail-template
- )
-
- def _cb_send_energy(self) -> None:
- """Send the mail with the energy consumption of the last month"""
- self._instance_logger.debug("Send energy consumption was triggered.")
- # get values
- now = datetime.datetime.now()
- last_month = now - dateutil.relativedelta.relativedelta(months=1)
-
- energy_sum_month = self._config.items.energy_sum.value - self._get_historic_value(self._config.items.energy_sum, last_month)
- for share in self._config.parameter.known_energy_shares:
- share.monthly_power = share.energy_item.value - self._get_historic_value(share.energy_item, last_month)
-
- energy_unknown = energy_sum_month - sum(share.monthly_power for share in self._config.parameter.known_energy_shares)
-
- with tempfile.TemporaryDirectory() as temp_dir_name:
- # create plot
- labels = [share.chart_name for share in self._config.parameter.known_energy_shares] + ["Rest"]
- values = [share.monthly_power for share in self._config.parameter.known_energy_shares] + [energy_unknown]
- chart_path = pathlib.Path(temp_dir_name) / "chart.png"
- habapp_rules.energy.donut_chart.create_chart(labels, values, chart_path)
-
- # get html
- html = self._create_html(energy_sum_month)
-
- # send mail
- self._mail.send_message(self._config.parameter.recipients, html, f"Stromverbrauch {_get_previous_month_name()}", images={"chart": str(chart_path)})
-
- self.run.at(next_trigger_time := _get_next_trigger(), self._cb_send_energy)
- self._instance_logger.info(f"Successfully sent energy consumption mail to {self._config.parameter.recipients}. Scheduled the next trigger time to {next_trigger_time.isoformat()}")
+ """Rule for sending the monthly energy consumption.
+
+ # Config
+ config = habapp_rules.energy.config.monthly_report.MonthlyReportConfig(
+ items=habapp_rules.energy.config.monthly_report.MonthlyReportItems(
+ energy_sum="Total Energy"
+ ),
+ parameter=habapp_rules.energy.config.monthly_report.MonthlyReportParameter(
+ known_energy_shares=[
+ habapp_rules.energy.config.monthly_report.EnergyShare("Dishwasher_Energy", "Dishwasher"),
+ habapp_rules.energy.config.monthly_report.EnergyShare("Light", "Light")
+ ],
+ config_mail=multi_notifier.connectors.connector_mail.MailConfig(
+ user="sender@test.de",
+ password="fancy_password",
+ smtp_host="smtp.test.de",
+ smtp_port=587
+ ),
+ recipients=["test@test.de"],
+ )
+ )
+
+ # Rule init
+ habapp_rules.energy.monthly_report.MonthlyReport("Total_Energy", known_energy_share, "Group_RRD4J", config_mail, "test@test.de")
+ """
+
+ def __init__(self, config: habapp_rules.energy.config.monthly_report.MonthlyReportConfig) -> None:
+ """Initialize the rule.
+
+ Args:
+ config: config for the monthly energy report rule
+
+ Raises:
+ habapp_rules.core.exceptions.HabAppRulesConfigurationError: if config is not valid
+ """
+ self._config = config
+ HABApp.Rule.__init__(self)
+ self._instance_logger = habapp_rules.core.logger.InstanceLogger(LOGGER, config.items.energy_sum.name)
+ self._mail = multi_notifier.connectors.connector_mail.Mail(config.parameter.config_mail)
+
+ self._mail = multi_notifier.connectors.connector_mail.Mail(config.parameter.config_mail)
+
+ if config.parameter.persistence_group_name is not None:
+ # check if all energy items are in the given persistence group
+ items_to_check = [config.items.energy_sum] + [share.energy_item for share in config.parameter.known_energy_shares]
+ not_in_persistence_group = [item.name for item in items_to_check if config.parameter.persistence_group_name not in item.groups]
+ if not_in_persistence_group:
+ msg = f"The following OpenHAB items are not in the persistence group '{config.parameter.persistence_group_name}': {not_in_persistence_group}"
+ raise habapp_rules.core.exceptions.HabAppRulesConfigurationError(msg)
+
+ self.run.at(self.run.trigger.time("00:00:00").only_on(self.run.filter.days(1)), self._cb_send_energy)
+
+ if config.parameter.debug:
+ self._instance_logger.warning("Debug mode is active!")
+ self.run.soon(self._cb_send_energy)
+ self._instance_logger.info(f"Successfully initiated monthly consumption rule for {config.items.energy_sum.name}.")
+
+ def _get_historic_value(self, item: HABApp.openhab.items.NumberItem, start_time: datetime.datetime) -> float:
+ """Get historic value of given Number item.
+
+ Args:
+ item: item instance
+ start_time: start time to search for the interested value
+
+ Returns:
+ historic value of the item
+ """
+ historic = item.get_persistence_data(start_time=start_time, end_time=start_time + datetime.timedelta(hours=1)).data
+ if not historic:
+ self._instance_logger.warning(f"Could not get value of item '{item.name}' of time = {start_time}")
+ return 0
+
+ return next(iter(historic.values()))
+
+ def _create_html(self, energy_sum_month: float) -> str:
+ """Create html which will be sent by the mail.
+
+ The template was created by https://app.bootstrapemail.com/editor/documents with the following input:
+
+
+
+
+
+
+
+
-
-
-
-
-
- Strom Verbrauch
-von Februar
--
-
- Aktueller Zählerstand: 7000 kWh.
-Hier die Details:
-
-
-
Generated with habapp_rules version = 20.0.3
-
+
+
+
+
+ Args:
+ energy_sum_month: sum value for the current month
+
+ Returns:
+ html with replaced values
+ """
+ with (pathlib.Path(__file__).parent / "monthly_report_template.html").open(encoding="utf-8") as template_file:
+ html_template = template_file.read()
+
+ return jinja2.Template(html_template).render(
+ month=_get_previous_month_name(),
+ energy_now=f"{self._config.items.energy_sum.value:.1f}",
+ energy_last_month=f"{energy_sum_month:.1f}",
+ habapp_version=habapp_rules.__version__,
+ chart="{{ chart }}", # this is needed to not replace the chart from the mail-template
+ )
+
+ def _cb_send_energy(self) -> None:
+ """Send the mail with the energy consumption of the last month."""
+ self._instance_logger.debug("Send energy consumption was triggered.")
+ # get values
+ now = datetime.datetime.now(tz=TIMEZONE)
+ last_month = now - dateutil.relativedelta.relativedelta(months=1)
+
+ energy_sum_month = self._config.items.energy_sum.value - self._get_historic_value(self._config.items.energy_sum, last_month)
+ for share in self._config.parameter.known_energy_shares:
+ share.monthly_power = share.energy_item.value - self._get_historic_value(share.energy_item, last_month)
+
+ energy_unknown = energy_sum_month - sum(share.monthly_power for share in self._config.parameter.known_energy_shares)
+
+ with tempfile.TemporaryDirectory() as temp_dir_name:
+ # create plot
+ labels = [share.chart_name for share in self._config.parameter.known_energy_shares] + ["Rest"]
+ values = [share.monthly_power for share in self._config.parameter.known_energy_shares] + [energy_unknown]
+ chart_path = pathlib.Path(temp_dir_name) / "chart.png"
+ habapp_rules.energy.donut_chart.create_chart(labels, values, chart_path)
+
+ # get html
+ html = self._create_html(energy_sum_month)
+
+ # send mail
+ self._mail.send_message(self._config.parameter.recipients, html, f"Stromverbrauch {_get_previous_month_name()}", images={"chart": str(chart_path)})
+
+ self._instance_logger.info(f"Successfully sent energy consumption mail to {self._config.parameter.recipients}.")
diff --git a/habapp_rules/sensors/astro.py b/habapp_rules/sensors/astro.py
index 83106eb..713c689 100644
--- a/habapp_rules/sensors/astro.py
+++ b/habapp_rules/sensors/astro.py
@@ -1,4 +1,5 @@
"""Rules for astro actions."""
+
import abc
import logging
@@ -11,108 +12,114 @@
class _SetNightDayBase(HABApp.Rule):
- """Base class for set night / day."""
+ """Base class for set night / day."""
- def __init__(self, item_target: HABApp.openhab.items.SwitchItem, item_elevation: HABApp.openhab.items.NumberItem, elevation_threshold: float) -> None:
- """Init Rule.
+ def __init__(self, item_target: HABApp.openhab.items.SwitchItem, item_elevation: HABApp.openhab.items.NumberItem, elevation_threshold: float) -> None:
+ """Init Rule.
- :param item_target: OpenHab item which should be set depending on the sun elevation value
- :param item_elevation: OpenHAB item of sun elevation (NumberItem)
- :param elevation_threshold: Threshold value for elevation.
- """
- HABApp.Rule.__init__(self)
+ Args:
+ item_target: OpenHab item which should be set depending on the sun elevation value
+ item_elevation: OpenHAB item of sun elevation (NumberItem)
+ elevation_threshold: Threshold value for elevation.
+ """
+ HABApp.Rule.__init__(self)
- self._item_target = item_target
- self._item_elevation = item_elevation
- self._elevation_threshold = elevation_threshold
+ self._item_target = item_target
+ self._item_elevation = item_elevation
+ self._elevation_threshold = elevation_threshold
- self._item_elevation.listen_event(self._set_night, HABApp.openhab.events.ItemStateChangedEventFilter())
+ self._item_elevation.listen_event(self._set_night, HABApp.openhab.events.ItemStateChangedEventFilter())
- self.run.soon(self._set_night)
+ self.run.soon(self._set_night)
- def _set_night(self, _: HABApp.openhab.events.ItemStateChangedEvent | None = None) -> None:
- """Callback which sets the state to the night item."""
- if self._item_elevation.value is None:
- return
- habapp_rules.core.helper.send_if_different(self._item_target, self._get_target_value())
+ def _set_night(self, _: HABApp.openhab.events.ItemStateChangedEvent | None = None) -> None:
+ """Callback which sets the state to the night item."""
+ if self._item_elevation.value is None:
+ return
+ habapp_rules.core.helper.send_if_different(self._item_target, self._get_target_value())
- @abc.abstractmethod
- def _get_target_value(self) -> str:
- """Get target value which should be set.
+ @abc.abstractmethod
+ def _get_target_value(self) -> str:
+ """Get target value which should be set.
- :return: target value (ON / OFF)
- """
+ Returns:
+ target value (ON / OFF)
+ """
class SetDay(_SetNightDayBase):
- """Rule to set / unset day item at dusk / dawn.
+ """Rule to set / unset day item at dusk / dawn.
- # Items:
- Switch day "Day"
- Number elevation "Sun elevation [%s]"
+
+
+
+
+
+ Strom Verbrauch
+von Februar
++
+
+ Aktueller Zählerstand: 7000 kWh.
+Hier die Details:
+
+
+
Generated with habapp_rules version = 20.0.3
+