Import statistics

This HA integration allows to import long term statistics from a file like csv or tsv.

This integration just offers a service

Installation

HACS

The preferred way is to use HACS:

Add this repository as custom repository under HACS
Add import_statistics: to your configuration .yaml (if it is possible to do this in the UI in some way without directly editing the yaml file, please let me know)
Restart home assistant

Manual installation

Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
If you do not have a custom_components directory (folder) there, you need to create it.
In the custom_components directory (folder) create a new folder called homeassistant-statistics.
Download all the files from the custom_components/homeassistant-statistics/ directory (folder) in this repository.
Place the files you downloaded in the new directory (folder) you created.
Add import_statistics: to your configuration .yaml (if it is possible to do this in the UI in some way without directly editing the yaml file, please let me know)
Restart Home Assistant

Usage

This integration offers the service import_from_file to import statistics from a file.

As this integration uses database-independent methods of the recorder to do the import, it does not depend on the used database - it should work for all databases supported by HA.

First, create your file. The structure is different for statistics with min/max/mean and counter statistics with state/sum.

Here you can find example files for both.

The examples are hopefully self-explaining, just some additional information:

You can either import min/max/mean or counters, but you cannot mix them in one file
You can import the same or changed data as often as you like, there will not be duplicate data (as existing values will just be overwritten). So, you can use this integration to add values or to correct existing values
You can use different settings for the delimiter (default is tab (tsv))
For floats, the decimal separator can be '.' or ','
You should be able to find your timezone here, or check the python documentation (pytz). Keep in mind that the times are local times of the HA server.
The timestamp (column start) must be of the format "%d.%m.%Y %H:%M" (e.g. "17.03.2024 02:00")
If you do not import values for every hour, you will get gaps in the graphs (depending on the used card and its settings)
The minutes of the timestamp must be zero. This is due to the long-term statistics, which only store hourly values.
You can import:
- Either statistics for existing sensors (internal statistics). These sensors have a '.' in its name, e.g. sensor.sun_solar_azimuth
  - If you try to import such a sensor which does not exist, you will see this sensor under developer tools / statistics, with an error. You can fix the error there, whereas fix means, remove it from database again
- Or statistics for not existing sensors (external statistics). These sensors have a ':' in its name, e.g. sensor:not_existing_sun_solar_azimuth
min/max/mean are pretty straight forward, whereas counters are more complex. To understand what sumand state means, you can e.g. check this
- You can set sum to 0, if state is enough for you. Or use the same value for sum and state. Or only import sum.
- You have to align the imported values with the first current value in your database, otherwise there will be a spike, as the difference between e.g. to energy values at 00:00 and 01:00 is the used energy for the hour starting at 00:00

Then, copy your file to your HA configuration (where you find configuration.yaml).

Then, go to Developer tools / Services, and select the service import_statistics: import_from_file.

Fill out the settings in the UI:

or use the yaml syntax:

service: import_statistics.import_from_file
data:
  timezone_identifier: Europe/Vienna
  delimiter: \t
  decimal: false
  filename: counterdata.tsv

Last, call the service. You will get feedback directly in the GUI.

The importing is an async operation. Depending on the size of the import, it can take some time until the import is finished, even though you already get an OK as feedback in the GUI

If importing does not work, and you do not get an error directly in the GUI, but there is an error in the home assistant logs, then this is a bug (this happens if the integration misses some checks, which lead to import errors later). Please create an issue.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

klausj1 / homeassistant-statistics