emhass 0.12.4__py3-none-any.whl → 0.12.5__py3-none-any.whl

emhass/retrieve_hass.py

@@ -1,670 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-import copy
-import datetime
-import json
-import logging
-import os
-import pathlib
-from typing import Optional
-
-import numpy as np
-import pandas as pd
-from requests import get, post
-
-from emhass.utils import set_df_index_freq
-
-
-class RetrieveHass:
-    r"""
-    Retrieve data from Home Assistant using the restful API.
-    
-    This class allows the user to retrieve data from a Home Assistant instance \
-    using the provided restful API (https://developers.home-assistant.io/docs/api/rest/)
-    
-    This class methods are:
-        
-    - get_data: to retrieve the actual data from hass
-    
-    - prepare_data: to apply some data treatment in preparation for the optimization task
-    
-    - post_data: Post passed data to hass
-    
-    """
-
-    def __init__(
-        self,
-        hass_url: str,
-        long_lived_token: str,
-        freq: pd.Timedelta,
-        time_zone: datetime.timezone,
-        params: str,
-        emhass_conf: dict,
-        logger: logging.Logger,
-        get_data_from_file: Optional[bool] = False,
-    ) -> None:
-        """
-        Define constructor for RetrieveHass class.
-
-        :param hass_url: The URL of the Home Assistant instance
-        :type hass_url: str
-        :param long_lived_token: The long lived token retrieved from the configuration pane
-        :type long_lived_token: str
-        :param freq: The frequency of the data DateTimeIndexes
-        :type freq: pd.TimeDelta
-        :param time_zone: The time zone
-        :type time_zone: datetime.timezone
-        :param params: Configuration parameters passed from data/options.json
-        :type params: str
-        :param emhass_conf: Dictionary containing the needed emhass paths
-        :type emhass_conf: dict
-        :param logger: The passed logger object
-        :type logger: logging object
-        :param get_data_from_file: Select if data should be retrieved from a
-        previously saved pickle useful for testing or directly from connection to
-        hass database
-        :type get_data_from_file: bool, optional
-
-        """
-        self.hass_url = hass_url
-        self.long_lived_token = long_lived_token
-        self.freq = freq
-        self.time_zone = time_zone
-        if (params == None) or (params == "null"):
-            self.params = {}
-        elif type(params) is dict:
-            self.params = params
-        else:
-            self.params = json.loads(params)
-        self.emhass_conf = emhass_conf
-        self.logger = logger
-        self.get_data_from_file = get_data_from_file
-        self.var_list = []
-
-    def get_ha_config(self):
-        """
-        Extract some configuration data from HA.
-
-        """
-        headers = {
-            "Authorization": "Bearer " + self.long_lived_token,
-            "content-type": "application/json",
-        }
-        if self.hass_url == "http://supervisor/core/api":
-            url = self.hass_url + "/config"
-        else:
-            url = self.hass_url + "api/config"
-
-        try:
-            response_config = get(url, headers=headers)
-        except Exception:
-            self.logger.error("Unable to access Home Assistance instance, check URL")
-            self.logger.error("If using addon, try setting url and token to 'empty'")
-            return False
-
-        try:
-            self.ha_config = response_config.json()
-        except Exception:
-            self.logger.error("EMHASS was unable to obtain configuration data from HA")
-            return False
-
-    def get_data(
-        self,
-        days_list: pd.date_range,
-        var_list: list,
-        minimal_response: Optional[bool] = False,
-        significant_changes_only: Optional[bool] = False,
-        test_url: Optional[str] = "empty",
-    ) -> None:
-        r"""
-        Retrieve the actual data from hass.
-        
-        :param days_list: A list of days to retrieve. The ISO format should be used \
-            and the timezone is UTC. The frequency of the data_range should be freq='D'
-        :type days_list: pandas.date_range
-        :param var_list: The list of variables to retrive from hass. These should \
-            be the exact name of the sensor in Home Assistant. \
-            For example: ['sensor.home_load', 'sensor.home_pv']
-        :type var_list: list
-        :param minimal_response: Retrieve a minimal response using the hass \
-            restful API, defaults to False
-        :type minimal_response: bool, optional
-        :param significant_changes_only: Retrieve significant changes only \
-            using the hass restful API, defaults to False
-        :type significant_changes_only: bool, optional
-        :return: The DataFrame populated with the retrieved data from hass
-        :rtype: pandas.DataFrame
-        
-        .. warning:: The minimal_response and significant_changes_only options \
-            are experimental
-        """
-        self.logger.info("Retrieve hass get data method initiated...")
-        headers = {
-            "Authorization": "Bearer " + self.long_lived_token,
-            "content-type": "application/json",
-        }
-        # Looping on each day from days list
-        self.df_final = pd.DataFrame()
-        x = 0  # iterate based on days
-        for day in days_list:
-            for i, var in enumerate(var_list):
-                if test_url == "empty":
-                    if (
-                        self.hass_url == "http://supervisor/core/api"
-                    ):  # If we are using the supervisor API
-                        url = (
-                            self.hass_url
-                            + "/history/period/"
-                            + day.isoformat()
-                            + "?filter_entity_id="
-                            + var
-                        )
-                    else:  # Otherwise the Home Assistant Core API it is
-                        url = (
-                            self.hass_url
-                            + "api/history/period/"
-                            + day.isoformat()
-                            + "?filter_entity_id="
-                            + var
-                        )
-                    if minimal_response:  # A support for minimal response
-                        url = url + "?minimal_response"
-                    if significant_changes_only:  # And for signicant changes only (check the HASS restful API for more info)
-                        url = url + "?significant_changes_only"
-                else:
-                    url = test_url
-                try:
-                    response = get(url, headers=headers)
-                except Exception:
-                    self.logger.error(
-                        "Unable to access Home Assistance instance, check URL"
-                    )
-                    self.logger.error(
-                        "If using addon, try setting url and token to 'empty'"
-                    )
-                    return False
-                else:
-                    if response.status_code == 401:
-                        self.logger.error(
-                            "Unable to access Home Assistance instance, TOKEN/KEY"
-                        )
-                        self.logger.error(
-                            "If using addon, try setting url and token to 'empty'"
-                        )
-                        return False
-                    if response.status_code > 299:
-                        return f"Request Get Error: {response.status_code}"
-                """import bz2 # Uncomment to save a serialized data for tests
-                import _pickle as cPickle
-                with bz2.BZ2File("data/test_response_get_data_get_method.pbz2", "w") as f: 
-                    cPickle.dump(response, f)"""
-                try:  # Sometimes when there are connection problems we need to catch empty retrieved json
-                    data = response.json()[0]
-                except IndexError:
-                    if x == 0:
-                        self.logger.error(
-                            "The retrieved JSON is empty, A sensor:"
-                            + var
-                            + " may have 0 days of history, passed sensor may not be correct, or days to retrieve is set too heigh"
-                        )
-                    else:
-                        self.logger.error(
-                            "The retrieved JSON is empty for day:"
-                            + str(day)
-                            + ", days_to_retrieve may be larger than the recorded history of sensor:"
-                            + var
-                            + " (check your recorder settings)"
-                        )
-                    return False
-                df_raw = pd.DataFrame.from_dict(data)
-                # self.logger.info(str(df_raw))
-                if len(df_raw) == 0:
-                    if x == 0:
-                        self.logger.error(
-                            "The retrieved Dataframe is empty, A sensor:"
-                            + var
-                            + " may have 0 days of history or passed sensor may not be correct"
-                        )
-                    else:
-                        self.logger.error(
-                            "Retrieved empty Dataframe for day:"
-                            + str(day)
-                            + ", days_to_retrieve may be larger than the recorded history of sensor:"
-                            + var
-                            + " (check your recorder settings)"
-                        )
-                    return False
-                # self.logger.info(self.freq.seconds)
-                if (
-                    len(df_raw) < ((60 / (self.freq.seconds / 60)) * 24)
-                    and x != len(days_list) - 1
-                ):  # check if there is enough Dataframes for passed frequency per day (not inc current day)
-                    self.logger.debug(
-                        "sensor:"
-                        + var
-                        + " retrieved Dataframe count: "
-                        + str(len(df_raw))
-                        + ", on day: "
-                        + str(day)
-                        + ". This is less than freq value passed: "
-                        + str(self.freq)
-                    )
-                if i == 0:  # Defining the DataFrame container
-                    from_date = pd.to_datetime(
-                        df_raw["last_changed"], format="ISO8601"
-                    ).min()
-                    to_date = pd.to_datetime(
-                        df_raw["last_changed"], format="ISO8601"
-                    ).max()
-                    ts = pd.to_datetime(
-                        pd.date_range(start=from_date, end=to_date, freq=self.freq),
-                        format="%Y-%d-%m %H:%M",
-                    ).round(self.freq, ambiguous="infer", nonexistent="shift_forward")
-                    df_day = pd.DataFrame(index=ts)
-                # Caution with undefined string data: unknown, unavailable, etc.
-                df_tp = (
-                    df_raw.copy()[["state"]]
-                    .replace(["unknown", "unavailable", ""], np.nan)
-                    .astype(float)
-                    .rename(columns={"state": var})
-                )
-                # Setting index, resampling and concatenation
-                df_tp.set_index(
-                    pd.to_datetime(df_raw["last_changed"], format="ISO8601"),
-                    inplace=True,
-                )
-                df_tp = df_tp.resample(self.freq).mean()
-                df_day = pd.concat([df_day, df_tp], axis=1)
-            self.df_final = pd.concat([self.df_final, df_day], axis=0)
-            x += 1
-        self.df_final = set_df_index_freq(self.df_final)
-        if self.df_final.index.freq != self.freq:
-            self.logger.error(
-                "The inferred freq:"
-                + str(self.df_final.index.freq)
-                + " from data is not equal to the defined freq in passed:"
-                + str(self.freq)
-            )
-            return False
-        self.var_list = var_list
-        return True
-
-    def prepare_data(
-        self,
-        var_load: str,
-        load_negative: Optional[bool] = False,
-        set_zero_min: Optional[bool] = True,
-        var_replace_zero: Optional[list] = None,
-        var_interp: Optional[list] = None,
-    ) -> None:
-        r"""
-        Apply some data treatment in preparation for the optimization task.
-        
-        :param var_load: The name of the variable for the household load consumption.
-        :type var_load: str
-        :param load_negative: Set to True if the retrived load variable is \
-            negative by convention, defaults to False
-        :type load_negative: bool, optional
-        :param set_zero_min: A special treatment for a minimum value saturation \
-            to zero. Values below zero are replaced by nans, defaults to True
-        :type set_zero_min: bool, optional
-        :param var_replace_zero: A list of retrived variables that we would want \
-            to replace nans with zeros, defaults to None
-        :type var_replace_zero: list, optional
-        :param var_interp: A list of retrived variables that we would want to \
-            interpolate nan values using linear interpolation, defaults to None
-        :type var_interp: list, optional
-        :return: The DataFrame populated with the retrieved data from hass and \
-            after the data treatment
-        :rtype: pandas.DataFrame
-        
-        """
-        try:
-            if load_negative:  # Apply the correct sign to load power
-                self.df_final[var_load + "_positive"] = -self.df_final[var_load]
-            else:
-                self.df_final[var_load + "_positive"] = self.df_final[var_load]
-            self.df_final.drop([var_load], inplace=True, axis=1)
-        except KeyError:
-            self.logger.error(
-                "Variable "
-                + var_load
-                + " was not found. This is typically because no data could be retrieved from Home Assistant"
-            )
-            return False
-        except ValueError:
-            self.logger.error(
-                "sensor.power_photovoltaics and sensor.power_load_no_var_loads should not be the same"
-            )
-            return False
-        # Confirm var_replace_zero & var_interp contain only sensors contained in var_list
-        if isinstance(var_replace_zero, list) and all(
-            item in var_replace_zero for item in self.var_list
-        ):
-            pass
-        else:
-            var_replace_zero = []
-        if isinstance(var_interp, list) and all(
-            item in var_interp for item in self.var_list
-        ):
-            pass
-        else:
-            var_interp = []
-        # Apply minimum values
-        if set_zero_min:
-            self.df_final.clip(lower=0.0, inplace=True, axis=1)
-            self.df_final.replace(to_replace=0.0, value=np.nan, inplace=True)
-        new_var_replace_zero = []
-        new_var_interp = []
-        # Just changing the names of variables to contain the fact that they are considered positive
-        if var_replace_zero is not None:
-            for string in var_replace_zero:
-                new_string = string.replace(var_load, var_load + "_positive")
-                new_var_replace_zero.append(new_string)
-        else:
-            self.logger.warning(
-                "Unable to find all the sensors in sensor_replace_zero parameter"
-            )
-            self.logger.warning(
-                "Confirm sure all sensors in sensor_replace_zero are sensor_power_photovoltaics and/or ensor_power_load_no_var_loads "
-            )
-            new_var_replace_zero = None
-        if var_interp is not None:
-            for string in var_interp:
-                new_string = string.replace(var_load, var_load + "_positive")
-                new_var_interp.append(new_string)
-        else:
-            new_var_interp = None
-            self.logger.warning(
-                "Unable to find all the sensors in sensor_linear_interp parameter"
-            )
-            self.logger.warning(
-                "Confirm all sensors in sensor_linear_interp are sensor_power_photovoltaics and/or ensor_power_load_no_var_loads "
-            )
-        # Treating NaN replacement: either by zeros or by linear interpolation
-        if new_var_replace_zero is not None:
-            self.df_final[new_var_replace_zero] = self.df_final[
-                new_var_replace_zero
-            ].fillna(0.0)
-        if new_var_interp is not None:
-            self.df_final[new_var_interp] = self.df_final[new_var_interp].interpolate(
-                method="linear", axis=0, limit=None
-            )
-            self.df_final[new_var_interp] = self.df_final[new_var_interp].fillna(0.0)
-        # Setting the correct time zone on DF index
-        if self.time_zone is not None:
-            self.df_final.index = self.df_final.index.tz_convert(self.time_zone)
-        # Drop datetimeindex duplicates on final DF
-        self.df_final = self.df_final[~self.df_final.index.duplicated(keep="first")]
-        return True
-
-    @staticmethod
-    def get_attr_data_dict(
-        data_df: pd.DataFrame,
-        idx: int,
-        entity_id: str,
-        unit_of_measurement: str,
-        friendly_name: str,
-        list_name: str,
-        state: float,
-    ) -> dict:
-        list_df = copy.deepcopy(data_df).loc[data_df.index[idx] :].reset_index()
-        list_df.columns = ["timestamps", entity_id]
-        ts_list = [str(i) for i in list_df["timestamps"].tolist()]
-        vals_list = [str(np.round(i, 2)) for i in list_df[entity_id].tolist()]
-        forecast_list = []
-        for i, ts in enumerate(ts_list):
-            datum = {}
-            datum["date"] = ts
-            datum[entity_id.split("sensor.")[1]] = vals_list[i]
-            forecast_list.append(datum)
-        data = {
-            "state": "{:.2f}".format(state),
-            "attributes": {
-                "unit_of_measurement": unit_of_measurement,
-                "friendly_name": friendly_name,
-                list_name: forecast_list,
-            },
-        }
-        return data
-
-    def post_data(
-        self,
-        data_df: pd.DataFrame,
-        idx: int,
-        entity_id: str,
-        unit_of_measurement: str,
-        friendly_name: str,
-        type_var: str,
-        from_mlforecaster: Optional[bool] = False,
-        publish_prefix: Optional[str] = "",
-        save_entities: Optional[bool] = False,
-        logger_levels: Optional[str] = "info",
-        dont_post: Optional[bool] = False,
-    ) -> None:
-        r"""
-        Post passed data to hass.
-        
-        :param data_df: The DataFrame containing the data that will be posted \
-            to hass. This should be a one columns DF or a series.
-        :type data_df: pd.DataFrame
-        :param idx: The int index of the location of the data within the passed \
-            DataFrame. We will post just one value at a time.
-        :type idx: int
-        :param entity_id: The unique entity_id of the sensor in hass.
-        :type entity_id: str
-        :param unit_of_measurement: The units of the sensor.
-        :type unit_of_measurement: str
-        :param friendly_name: The friendly name that will be used in the hass frontend.
-        :type friendly_name: str
-        :param type_var: A variable to indicate the type of variable: power, SOC, etc.
-        :type type_var: str
-        :param publish_prefix: A common prefix for all published data entity_id.
-        :type publish_prefix: str, optional
-        :param save_entities: if entity data should be saved in data_path/entities
-        :type save_entities: bool, optional
-        :param logger_levels: set logger level, info or debug, to output  
-        :type logger_levels: str, optional
-        :param dont_post: dont post to HA
-        :type dont_post: bool, optional
-
-        """
-        # Add a possible prefix to the entity ID
-        entity_id = entity_id.replace("sensor.", "sensor." + publish_prefix)
-        # Set the URL
-        if (
-            self.hass_url == "http://supervisor/core/api"
-        ):  # If we are using the supervisor API
-            url = self.hass_url + "/states/" + entity_id
-        else:  # Otherwise the Home Assistant Core API it is
-            url = self.hass_url + "api/states/" + entity_id
-        headers = {
-            "Authorization": "Bearer " + self.long_lived_token,
-            "content-type": "application/json",
-        }
-        # Preparing the data dict to be published
-        if type_var == "cost_fun":
-            if isinstance(data_df.iloc[0], pd.Series):  # if Series extract
-                data_df = data_df.iloc[:, 0]
-            state = np.round(data_df.sum(), 2)
-        elif type_var == "unit_load_cost" or type_var == "unit_prod_price":
-            state = np.round(data_df.loc[data_df.index[idx]], 4)
-        elif type_var == "optim_status":
-            state = data_df.loc[data_df.index[idx]]
-        elif type_var == "mlregressor":
-            state = data_df[idx]
-        else:
-            state = np.round(data_df.loc[data_df.index[idx]], 2)
-        if type_var == "power":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "forecasts",
-                state,
-            )
-        elif type_var == "deferrable":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "deferrables_schedule",
-                state,
-            )
-        elif type_var == "temperature":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "predicted_temperatures",
-                state,
-            )
-        elif type_var == "batt":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "battery_scheduled_power",
-                state,
-            )
-        elif type_var == "SOC":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "battery_scheduled_soc",
-                state,
-            )
-        elif type_var == "unit_load_cost":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "unit_load_cost_forecasts",
-                state,
-            )
-        elif type_var == "unit_prod_price":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "unit_prod_price_forecasts",
-                state,
-            )
-        elif type_var == "mlforecaster":
-            data = RetrieveHass.get_attr_data_dict(
-                data_df,
-                idx,
-                entity_id,
-                unit_of_measurement,
-                friendly_name,
-                "scheduled_forecast",
-                state,
-            )
-        elif type_var == "optim_status":
-            data = {
-                "state": state,
-                "attributes": {
-                    "unit_of_measurement": unit_of_measurement,
-                    "friendly_name": friendly_name,
-                },
-            }
-        elif type_var == "mlregressor":
-            data = {
-                "state": state,
-                "attributes": {
-                    "unit_of_measurement": unit_of_measurement,
-                    "friendly_name": friendly_name,
-                },
-            }
-        else:
-            data = {
-                "state": "{:.2f}".format(state),
-                "attributes": {
-                    "unit_of_measurement": unit_of_measurement,
-                    "friendly_name": friendly_name,
-                },
-            }
-        # Actually post the data
-        if self.get_data_from_file or dont_post:
-
-            class response:
-                pass
-
-            response.status_code = 200
-            response.ok = True
-        else:
-            response = post(url, headers=headers, data=json.dumps(data))
-
-        # Treating the response status and posting them on the logger
-        if response.ok:
-            if logger_levels == "DEBUG":
-                self.logger.debug(
-                    "Successfully posted to " + entity_id + " = " + str(state)
-                )
-            else:
-                self.logger.info(
-                    "Successfully posted to " + entity_id + " = " + str(state)
-                )
-
-            # If save entities is set, save entity data to /data_path/entities
-            if save_entities:
-                entities_path = self.emhass_conf["data_path"] / "entities"
-
-                # Clarify folder exists
-                pathlib.Path(entities_path).mkdir(parents=True, exist_ok=True)
-
-                # Save entity data to json file
-                result = data_df.to_json(
-                    index="timestamp", orient="index", date_unit="s", date_format="iso"
-                )
-                parsed = json.loads(result)
-                with open(entities_path / (entity_id + ".json"), "w") as file:
-                    json.dump(parsed, file, indent=4)
-
-                # Save the required metadata to json file
-                if os.path.isfile(entities_path / "metadata.json"):
-                    with open(entities_path / "metadata.json", "r") as file:
-                        metadata = json.load(file)
-                else:
-                    metadata = {}
-                with open(entities_path / "metadata.json", "w") as file:
-                    # Save entity metadata, key = entity_id
-                    metadata[entity_id] = {
-                        "name": data_df.name,
-                        "unit_of_measurement": unit_of_measurement,
-                        "friendly_name": friendly_name,
-                        "type_var": type_var,
-                        "optimization_time_step": int(self.freq.seconds / 60),
-                    }
-
-                    # Find lowest frequency to set for continual loop freq
-                    if metadata.get("lowest_time_step", None) == None or metadata[
-                        "lowest_time_step"
-                    ] > int(self.freq.seconds / 60):
-                        metadata["lowest_time_step"] = int(self.freq.seconds / 60)
-                    json.dump(metadata, file, indent=4)
-
-                    self.logger.debug("Saved " + entity_id + " to json file")
-
-        else:
-            self.logger.warning(
-                "The status code for received curl command response is: "
-                + str(response.status_code)
-            )
-        return response, data